| TextBox Class |
Shape node to display a text box in window coordinates.
Preview Feature: this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoGroup
OIV.Inventor.NodesSoSeparator
OIV.Inventor.NodesSoAnnotation
OIV.Medical.NodesTextBox
OIV.Medical.NodesDicomInfo
Namespace: OIV.Medical.Nodes
Assembly: OIV.Medical (in OIV.Medical.dll) Version: 2023.1.3.0.Release.5fd1c1ad27c99c06f73891d4218ee7122fbde35a
SyntaxThe TextBox type exposes the following members.
ConstructorsMethods| Name | Description | |
|---|---|---|
 | AddChild | Adds a child as last one in group. |
| AddLine |
Add a line of text at the bottom of the box.
|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoSeparator.) |
| ClearCacheList | (Inherited from SoSeparator.) |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| DeleteAll |
Delete all lines of text
|
| DeleteLines |
Delete one or more lines of text. Default is to delete one line.
-1 means delete all lines starting with 'startline'
|
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Inherited from SoSeparator.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| FindChild | Finds index of given child within group. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | (Inherited from SoSeparator.) |
| GetChild | Returns pointer the child node with the given index. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetFontNode |
Get the internal font node (allows to modify font parameters directly)
|
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetLine |
Get the contents of the specified line of text.
|
| GetMatrix | (Inherited from SoSeparator.) |
| GetName | Returns the name of an instance. |
| GetNumChildren | Returns number of children. |
| GetNumLines |
Get number of lines of text currently in the box
|
| GetPrimitiveCount | (Inherited from SoSeparator.) |
| GetRenderEngineMode |
This override is mandatory to specify the custom node's render
engine mode. If not overridden, a warning message will be displayed.
(Overrides SoNodeGetRenderEngineMode.) |
| GetRenderUnitID | (Inherited from SoAnnotation.) |
| GetStringName | (Inherited from SoBase.) |
| GetTextNode |
Get internal text node (allows to modify the spacing directly)
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Inherited from SoAnnotation.) |
| GLRenderBelowPath | (Inherited from SoAnnotation.) |
| GLRenderInPath | (Inherited from SoAnnotation.) |
| GLRenderOffPath | (Inherited from SoAnnotation.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoSeparator.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| InsertChild | Adds a child so that it becomes the one with the given index. |
| IsBoundingBoxIgnoring | Used by BoundingBoxAction to known if bounding box computation should be ignored or not. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Inherited from SoGroup.) |
| RayPick | (Inherited from SoSeparator.) |
| RemoveAllChildren | Removes all children from group. |
| RemoveChild(Int32) | Removes child with given index from group. |
| RemoveChild(SoNode) | Removes first instance of given child from group. |
| ReplaceChild(Int32, SoNode) | Replaces child with given index with new child. |
| ReplaceChild(SoNode, SoNode) | Replaces first instance of given child with new child. |
| Search | (Inherited from SoSeparator.) |
| Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
| SetLine |
Set the contents of the specified line of text (convenience method).
|
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Inherited from SoGroup.) |
Fields| Name | Description | |
|---|---|---|
 | alignmentH |
Horizontal alignment of the text box (default is LEFT).
|
| alignmentV |
Vertical alignment of the text box (default is TOP).
|
| border |
Enable drawing a border around the text box (default is FALSE).
|
| borderColor |
Border color (default is 1,1,1).
|
| fontName |
Specify the font name (default is "Arial:Bold"). See SoFont.name for details
|
| fontSize |
Specify the font size in pixels (default is 15).
|
| position |
Position of the text box in normalized screen coordinates (-1 to 1).
Default is 0,0,0.
|
| textAlignH |
Horizontal alignment of the text inside the box (default is LEFT).
|
Properties| Name | Description | |
|---|---|---|
 | boundingBoxCaching | (Inherited from SoSeparator.) |
| boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. |
| fastEditing | Specifies the fast edit mode of the separator node. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| pickCulling | Whether to cull during picking traversal. |
| renderCaching | Obsolete. Whether to cache during rendering traversal. |
| renderCulling | Whether to cull during rendering traversal. |
| renderUnitId | Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThis node displays a text box at a fixed location in the viewer window.
The position is specified in normalized device coordinates -1 to 1. Horizontal alignmentH and vertical alignmentV can be specified. For example position -0.98, -0.98, 0 with TOP/LEFT alignment (the default) puts a text box in the upper left corner of the window. The text box automatically expands or shrinks when lines of text are added to or deleted from the box. Positioning a text box in the lower left corner creates a sort of 'console' output overlaying the scene. Note that the alignment options control the positioning of the text box. The text can be left, center or right justified inside the box using the textAlignH field.
In order to have convenient default values for the font properties, by default the font properties are 'not' inherited from the scene graph. By default the text is rendered using an SoText2 node with font name 'Arial:Bold', font size 15 and line spacing 1.1. The application can modify the fontName and fontSize fields or modify text properties directly using the GetFontNode() and GetTextNode() methods.
Lighting and picking are disabled. A border can be drawn around the box. Text will be rendered on top of whatever is rendered in the main scene graph. The application can modify the text strings directly, but this class also provides some convenience methods that are very useful. For example, the AddLine() method appends a new string to the end of the list.
The bounding box of this node is ignored, i.e. it does not contribute to an SoGetBoundingBoxAction traversal and it does not affect a ViewAll() call on the camera or viewer.
Note:
If you are using one of the Open Inventor viewer classes (e.g. SoWinExaminerViewer). You must explicitly create a camera node (e.g. SoPerspectiveCamera) and add it to the scene graph. The viewer will not automatically create a camera, because it will find the camera in this node's internal scene graph.
FILE FORMAT/DEFAULT
TextBox {
| position | 0 0 0 |
| alignmentH | LEFT |
| alignmentV | TOP |
| textAlignH | LEFT |
| fontName | Arial:Bold |
| fontSize | 15 |
| border | FALSE |
| borderColor | 1 1 1 |
See Also