|
Open Inventor Release 2023.2.3
|
|
| |
|
Open Inventor Release 2023.2.3
|
|
|
| |
Simple 3D text shape node.
More...
#include <Inventor/nodes/SoAsciiText.h>
Inheritance diagram for SoAsciiText:Public Types | |
| enum | Justification { LEFT = 0x01 , CENTER = 0x03 , RIGHT = 0x02 , INHERITED = 0x04 } |
| Public Types inherited from SoShape | |
| enum | ShapeType { POINTS , LINES , POLYGONS , TEXT } |
| Basic type for antialiased rendering for this shape (Do not consider the SoDrawStyle property currently in the state). More... | |
Public Member Functions | |
| virtual SoType | getTypeId () const |
| Returns the type identifier for this specific instance. | |
| SoAsciiText () | |
| Creates an ascii text node with default settings. | |
| Public Member Functions inherited from SoShape | |
| virtual SbBool | affectsState () const |
| Overrides default method on SoNode. | |
| ShapeType | getShapeType () |
| Gets the current shape Full Scene Antialiasing type. | |
| 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 Public Member Functions inherited from SoShape | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static SbBool | isPrimitiveRestartAvailable (SoState *state=NULL) |
| Returns TRUE if the primitive restart feature is available. | |
| 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 | |
| SoMFString | string |
| The text string(s) to display. | |
| SoSFFloat | spacing |
| Defines the distance (in the negative y direction) between the base points of successive strings, measured with respect to the current font height. | |
| SoSFEnum | justification |
| Indicates placement and alignment of strings. | |
| SoMFFloat | width |
| Defines the width of each text string. | |
| Public Attributes inherited from SoShape | |
| SoSFBool | boundingBoxIgnoring |
| Whether to ignore this node during bounding box traversal. | |
Simple 3D text shape node.
This node defines one or more strings of 3D text. In contrast with SoText2, 3D text can be rotated, scaled, lighted, and textured, just like all other 3D shapes. In contrast with SoText3, this 3D Ascii text cannot be extruded.
The text origin is at (0,0,0) after applying the current transformation. The scale of the text is affected by the size field of the current SoFont as well as the current transformation.
SoAsciiText uses the current material when rendering. Textures are applied to ascii text as follows. On the front face of the text, the texture origin is at the base point of the first string; the base point is at the lower left for justification LEFT, at the lower right for RIGHT, and at the lower center for CENTER. The texture is scaled equally in both S and T dimensions, with the font height representing 1 unit. S increases to the right on the front face.
Shape Antialiasing type is SoShape::TEXT.
| string | "" |
| spacing | 1 |
| justification | LEFT |
| width | 0 |
SoRayPickAction
Performs a pick on the text. The string index and character position are available from the SoTextDetail.
SoGetBoundingBoxAction
Computes the bounding box that encloses the text.
SoCallbackAction
If any triangle callbacks are registered with the action, they will be invoked for each successive triangle used to approximate the text geometry.
SoFont, SoFontStyle, SoText2, SoText3, SoTextDetail, SoFullSceneAntialiasing
Definition at line 127 of file SoAsciiText.h.
| Enumerator | |
|---|---|
| LEFT | Left edges of all strings are aligned. |
| CENTER | Centers of all strings are aligned. |
| RIGHT | Right edges of all strings are aligned. |
| INHERITED | The text justification is inherited from the current SoTextProperty::alignmentH value. |
Definition at line 132 of file SoAsciiText.h.
| SoAsciiText::SoAsciiText | ( | ) |
Creates an ascii text node with default settings.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoShape.
| SoSFEnum SoAsciiText::justification |
Indicates placement and alignment of strings.
With LEFT justification, the left edge of the first line is at the (transformed) origin, and all left edges are aligned. RIGHT justification is similar. CENTER justification places the center of the first string at the (transformed) origin, with the centers of all remaining strings aligned under it. Use enum Justification. Default is LEFT.
Definition at line 174 of file SoAsciiText.h.
| SoSFFloat SoAsciiText::spacing |
Defines the distance (in the negative y direction) between the base points of successive strings, measured with respect to the current font height.
A value of 1 indicates single spacing, a value of 2 indicates double spacing, and so on. Default is 1.
Definition at line 164 of file SoAsciiText.h.
| SoMFString SoAsciiText::string |
The text string(s) to display.
Each string will appear on its own line.
Definition at line 156 of file SoAsciiText.h.
| SoMFFloat SoAsciiText::width |
Defines the width of each text string.
Each string will be scaled so that it spans this many units. Default is 0.
Definition at line 181 of file SoAsciiText.h.
1.9.8 