Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
SoAnnoText3 Class Reference
Inventor » Nodes » Shapes

VSG extension Annotation text node. More...

#include <Inventor/nodes/SoAnnoText3.h>

+ Inheritance diagram for SoAnnoText3:

Public Types

enum  Justification {
  LEFT = 0x01 ,
  CENTER = 0x03 ,
  RIGHT = 0x02 ,
  INHERITED = 0x04
}
 Justification types. More...
 
- 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.
 
 SoAnnoText3 ()
 Constructor.
 
- 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.
 
SoSFNode alternateRep
 This field optionally holds an SoText3 node that will be written out in place of this SoAnnoText3 node when saved to a .iv file.
 
- Public Attributes inherited from SoShape
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Detailed Description

VSG extension Annotation text node.

SoAnnoText3 has some features of SoText3 and also some of SoText2.

For example, in the RENDER2D_PRINT_RASTER mode the text is rendered using SoText2, but the font size (see SoFont) is interpreted in the current 3D units like SoText3. As a result, the text is always screen aligned, but the size changes depending on distance from the camera. Text in this mode cannot be rotated.

The current annotation property (SoAnnoText3Property) determines the mode. The default is RENDER3D_PRINT_VECTOR (render like SoText3).

If scaling is applied (e.g. SoTransform) and the mode is RENDER2D_PRINT_RASTER, then the scale factor actually applied to the text is the minimum scale factor of the three axes (x, y, z).

Limitations:

  • If a stroke font is used (see SoFont), the text is rendered with lines rather than faces. Line attributes apply instead of polygon attributes. Text is not extruded.
  • When using one of the xxx_PRINT_RASTER options (see SoAnnoText3Property), the export limitations of SoText2 apply. See that class for more information.

Shape Antialiasing type is SoShape::TEXT.

FILE FORMAT/DEFAULT

    AnnoText3 {
    string ""
    spacing 1.0
    justification LEFT
    alternateRep NULL
    }

ACTION BEHAVIOR

    SoGLRenderAction
    Draws text based on the current font, profiles, transformation, drawing style, material, texture, complexity, and so on.

    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
    For non-stroke fonts,if any triangle callbacks are registered with the action, they will be invoked for each successive triangle used to approximate the text geometry.

    For stroke fonts, if any line segment callbacks are registered with the action, they will be invoked for each successive line segment used to approximate the text geometry.

SEE ALSO

SoAnnoText3Property, SoText2, SoText3, SoFullSceneAntialiasing

Definition at line 109 of file SoAnnoText3.h.

Member Enumeration Documentation

◆ Justification

enum SoAnnoText3::Justification

Justification types.

Enumerator
LEFT 

Left justification.

CENTER 

Center justification.

RIGHT 

Right justification.

INHERITED 

The text justification is inherited from the current SoTextProperty::alignmentH value.

Definition at line 116 of file SoAnnoText3.h.

Constructor & Destructor Documentation

◆ SoAnnoText3()

SoAnnoText3::SoAnnoText3 ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoAnnoText3::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoAnnoText3::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoShape.

Member Data Documentation

◆ alternateRep

SoSFNode SoAnnoText3::alternateRep

This field optionally holds an SoText3 node that will be written out in place of this SoAnnoText3 node when saved to a .iv file.

Definition at line 164 of file SoAnnoText3.h.

◆ justification

SoSFEnum SoAnnoText3::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 158 of file SoAnnoText3.h.

◆ spacing

SoSFFloat SoAnnoText3::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 148 of file SoAnnoText3.h.

◆ string

SoMFString SoAnnoText3::string

The text string(s) to display.

Each string will appear on its own line.

Definition at line 140 of file SoAnnoText3.h.

The documentation for this class was generated from the following file: