(Preview feature) [Medical] Shape node to display a text box in window coordinates. More...
#include <Medical/nodes/TextBox.h>
Public Types | |
enum | AlignmentH { LEFT = SoTextProperty::LEFT , CENTER = SoTextProperty::CENTER , RIGHT = SoTextProperty::RIGHT } |
Horizontal alignment values. More... | |
enum | AlignmentV { TOP = SoTextProperty::TOP , MIDDLE = SoTextProperty::HALF , BOTTOM = SoTextProperty::BOTTOM } |
Vertical alignment values. More... | |
Public Types inherited from SoSeparator | |
enum | CacheEnabled { OFF , ON , AUTO } |
Possible values for caching. More... | |
enum | FastEditing { DISABLE = 0x01 , KEEP_ZBUFFER = 0x02 , CLEAR_ZBUFFER = 0x03 } |
Fast editing policy enumeration values. More... | |
Public Member Functions | |
virtual SoType | getTypeId () const |
Returns the type identifier for this specific instance. | |
void | setLine (const SbString &text, int line=0) |
Set the contents of the specified line of text (convenience method). | |
const SbString & | getLine (int line) |
Get the contents of the specified line of text. | |
void | addLine (const SbString &text) |
Add a line of text at the bottom of the box. | |
void | deleteLines (int startLine, int numToDelete=1) |
Delete one or more lines of text. | |
void | deleteAll () |
Delete all lines of text. | |
int | getNumLines () const |
Get number of lines of text currently in the box. | |
SoFont * | getFontNode () |
Get the internal font node (allows to modify font parameters directly). | |
SoText2 * | getTextNode () |
Get the internal text node (allows to modify line spacing directly). | |
TextBox () | |
Constructor. | |
Public Member Functions inherited from SoAnnotation | |
SoAnnotation () | |
Creates an annotation node with default settings. | |
Public Member Functions inherited from SoSeparator | |
SoSeparator () | |
Creates a separator node with default settings. | |
SoSeparator (int nChildren) | |
Constructor that takes approximate number of children. | |
Public Member Functions inherited from SoGroup | |
SoGroup () | |
Creates an empty group node. | |
SoGroup (int nChildren) | |
Constructor that takes approximate number of children. | |
virtual void | addChild (SoNode *child) |
Adds a child as last one in group. | |
virtual void | insertChild (SoNode *child, int newChildIndex) |
Adds a child so that it becomes the one with the given index. | |
virtual SoNode * | getChild (int index) const |
Returns pointer the child node with the given index. | |
virtual int | findChild (const SoNode *child) const |
Finds index of given child within group. | |
virtual int | getNumChildren () const |
Returns number of children. | |
virtual void | removeChild (int index) |
Removes child with given index from group. | |
virtual void | removeChild (SoNode *child) |
Removes first instance of given child from group. | |
virtual void | removeAllChildren () |
Removes all children from group. | |
virtual void | replaceChild (int index, SoNode *newChild) |
Replaces child with given index with new child. | |
virtual void | replaceChild (SoNode *oldChild, SoNode *newChild) |
Replaces first instance of given child with new child. | |
Public Member Functions inherited from SoNode | |
virtual void | setOverride (const SbBool state) |
Turns the override flag on or off. | |
virtual SbBool | isOverride () const |
Returns the state of the override flag. | |
virtual SoNode * | copy (SbBool copyConnections=FALSE) const |
Creates and returns an exact copy of the node. | |
virtual void | touch () |
Marks an instance as modified, simulating a change to it. | |
Public Member Functions inherited from SoFieldContainer | |
void | setToDefaults () |
Sets all fields in this object to their default values. | |
SbBool | hasDefaultValues () const |
Returns TRUE if all of the object's fields have their default values. | |
SbBool | fieldsAreEqual (const SoFieldContainer *fc) const |
Returns TRUE if this object's fields are exactly equal to fc's fields. | |
void | copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE) |
Copies the contents of fc's fields into this object's fields. | |
SoNONUNICODE SbBool | set (const char *fieldDataString) |
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. | |
SbBool | set (const SbString &fieldDataString) |
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. | |
void | get (SbString &fieldDataString) |
Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
virtual int | getFields (SoFieldList &list) const |
Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
virtual int | getAllFields (SoFieldList &list) const |
Returns a list of fields, including the eventIn's and eventOut's. | |
virtual SoField * | getField (const SbName &fieldName) const |
Returns a the field of this object whose name is fieldName. | |
virtual SoField * | getEventIn (const SbName &fieldName) const |
Returns a the eventIn with the given name. | |
virtual SoField * | getEventOut (const SbName &fieldName) const |
Returns the eventOut with the given name. | |
SbBool | getFieldName (const SoField *field, SbName &fieldName) const |
Returns the name of the given field in the fieldName argument. | |
SbBool | enableNotify (SbBool flag) |
Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). | |
SbBool | isNotifyEnabled () const |
Notification is the process of telling interested objects that this object has changed. | |
virtual void | setUserData (void *data) |
Sets application data. | |
void * | getUserData (void) const |
Gets user application data. | |
Public Member Functions inherited from SoBase | |
virtual SbName | getName () const |
Returns the name of an instance. | |
virtual void | setName (const SbName &name) |
Sets the name of an instance. | |
void | setSynchronizable (const bool b) |
Sets this to be a ScaleViz synchronizable object. | |
bool | isSynchronizable () const |
Gets the ScaleViz synchronizable state of this object. | |
Public Member Functions inherited from SoRefCounter | |
void | ref () const |
Adds a reference to an instance. | |
void | unref () const |
Removes a reference from an instance. | |
void | unrefNoDelete () const |
unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero. | |
int | getRefCount () const |
Returns current reference count. | |
void | lock () const |
lock this instance. | |
void | unlock () const |
unlock this instance. | |
Public Member Functions inherited from SoTypedObject | |
SbBool | isOfType (const SoType &type) const |
Returns TRUE if this object is of the type specified in type or is derived from that type. | |
template<typename TypedObjectClass > | |
SbBool | isOfType () const |
Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class. | |
Static Public Member Functions | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
static void | initClass () |
Initialize the class. | |
static void | exitClass () |
Finish using the class. | |
Static Public Member Functions inherited from SoAnnotation | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Static Public Member Functions inherited from SoSeparator | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Static Public Member Functions inherited from SoGroup | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Static Public Member Functions inherited from SoNode | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
static SoNode * | getByName (const SbName &name) |
A node's name can be set using SoBase::setName(). | |
static int | getByName (const SbName &name, SoNodeList &list) |
A node's name can be set using SoBase::setName(). | |
Static Public Member Functions inherited from SoFieldContainer | |
static SoType | getClassTypeId () |
Returns the type of this class. | |
Static Public Member Functions inherited from SoBase | |
static SoType | getClassTypeId () |
Returns type identifier for this class. | |
Static Public Member Functions inherited from SoTypedObject | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Public Attributes | |
SoSFVec3f | position |
Position of the text box in normalized screen coordinates (-1 to 1). | |
SoSFEnum | alignmentH |
Horizontal alignment of the text box (default is LEFT). | |
SoSFEnum | alignmentV |
Vertical alignment of the text box (default is TOP). | |
SoSFEnum | textAlignH |
Horizontal alignment of the text inside the box (default is LEFT). | |
SoSFString | fontName |
Specify the font name (default is "Arial:Bold"). | |
SoSFFloat | fontSize |
Specify the font size in pixels (default is 15). | |
SoSFBool | border |
Enable drawing a border around the text box (default is FALSE). | |
SoSFColor | borderColor |
Border color (default is 1,1,1). | |
Public Attributes inherited from SoSeparator | |
SoSFEnum | boundingBoxCaching |
Whether to cache during bounding box traversal. | |
SoSFEnum | renderCulling |
Whether to cull during rendering traversal. | |
SoSFEnum | pickCulling |
Whether to cull during picking traversal. | |
SoSFEnum | fastEditing |
Specifies the fast edit mode of the separator node. | |
SoSFInt32 | renderUnitId |
Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator. | |
SoDEPRECATED SoSFEnum | renderCaching |
Whether to cache during rendering traversal. | |
Public Attributes inherited from SoGroup | |
SoSFBool | boundingBoxIgnoring |
Whether to ignore this node during bounding box traversal. | |
Additional Inherited Members | |
Related Symbols inherited from SoSeparator | |
#define | SO_RENDERUNITID_NONE (-1) |
Don't traverse any children. | |
#define | SO_RENDERUNITID_INHERIT (-2) |
Inherit value from state. | |
#define | SO_RENDERUNITID_ALL (-3) |
Traverse all children. | |
(Preview feature) [Medical] Shape node to display a text box in window coordinates.
This 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.
position | 0 0 0 |
alignmentH | LEFT |
alignmentV | TOP |
textAlignH | LEFT |
fontName | Arial:Bold |
fontSize | 15 |
border | FALSE |
borderColor | 1 1 1 |
enum TextBox::AlignmentH |
enum TextBox::AlignmentV |
TextBox::TextBox | ( | ) |
Constructor.
void TextBox::addLine | ( | const SbString & | text | ) |
Add a line of text at the bottom of the box.
void TextBox::deleteAll | ( | ) |
Delete all lines of text.
void TextBox::deleteLines | ( | int | startLine, |
int | numToDelete = 1 |
||
) |
Delete one or more lines of text.
'startLine' is the first line to delete.
'numToDelete' is the number of lines to delete. Default (1) is to delete one line. -1 means delete all lines starting with 'startLine'.
|
static |
Finish using the class.
|
static |
Returns the type identifier for this class.
SoFont * TextBox::getFontNode | ( | ) |
Get the internal font node (allows to modify font parameters directly).
const SbString & TextBox::getLine | ( | int | line | ) |
Get the contents of the specified line of text.
int TextBox::getNumLines | ( | ) | const |
Get number of lines of text currently in the box.
SoText2 * TextBox::getTextNode | ( | ) |
Get the internal text node (allows to modify line spacing directly).
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoAnnotation.
Reimplemented in DicomInfo.
|
static |
Initialize the class.
void TextBox::setLine | ( | const SbString & | text, |
int | line = 0 |
||
) |
Set the contents of the specified line of text (convenience method).
SoSFEnum TextBox::alignmentH |
SoSFEnum TextBox::alignmentV |
SoSFBool TextBox::border |
SoSFColor TextBox::borderColor |
SoSFString TextBox::fontName |
Specify the font name (default is "Arial:Bold").
See SoFont::name for details.
SoSFFloat TextBox::fontSize |
SoSFVec3f TextBox::position |
SoSFEnum TextBox::textAlignH |