|
Open Inventor Release 2024.2.1
|
|
| |
|
Open Inventor Release 2024.2.1
|
|
|
| |
Annotation group node. More...
#include <Inventor/nodes/SoAnnotation.h>
Inheritance diagram for SoAnnotation:Public Member Functions | |
| virtual SoType | getTypeId () const |
| Returns the type identifier for this specific instance. | |
| 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 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. | |
Additional Inherited Members | |
| 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 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. | |
| 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. | |
Annotation group node.
This group node delays rendering its children until all other nodes have been traversed, turning off depth buffer comparisons first. The result is that the shapes under the annotation node are rendered on top of the rest of the scene. This node is derived from SoSeparator, so it saves and restores traversal state for all actions.
Rendering order:
Objects under an SoAnnotation node are rendered after "delayed" transparent objects. See SoGLRenderAction for more information about rendering order. Note that if more than one annotation node is present in a graph, the order in which they are traversed determines the stacking order - later nodes are rendered on top of earlier ones.
Note: Because depth buffer comparisons are disabled, complex 3D objects may not be rendered correctly when used under annotation nodes.
Picking:
Also note that the annotation node does nothing special when picking along a ray. That is, it does not modify the sorting order of intersected objects based on which ones are under annotation nodes. If your application uses annotation nodes and you want to ensure that objects under them are picked "in front of" other objects, you can tell the pick action that you want to pick all objects along the ray and then scan through the paths in the resulting picked point instances to see if any of them passes through an annotation node. Your program can then decide what to do in such a case.
| boundingBoxCaching | AUTO |
| renderCulling | AUTO |
| pickCulling | AUTO |
| fastEditing | FALSE |
SoCallbackAction, SoGetBoundingBoxAction, SoGetMatrixAction, SoRayPickAction, SoSearchAction
Same as SoSeparator
Definition at line 130 of file SoAnnotation.h.
| SoAnnotation::SoAnnotation | ( | ) |
Creates an annotation node with default settings.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoSeparator.
Reimplemented in DicomInfo, Gnomon, SliceOrientationMarkers, SliceScaleBar, and TextBox.
1.9.8 