Open Inventor Reference
SoVertexProperty Class Reference

Vertex property node. More...

#include <Inventor/nodes/SoVertexProperty.h>

Inheritance diagram for SoVertexProperty:
SoNode SoFieldContainer SoBase

Public Types

enum  Binding {
  OVERALL = SoMaterialBindingElement::OVERALL , PER_PART = SoMaterialBindingElement::PER_PART , PER_PART_INDEXED = SoMaterialBindingElement::PER_PART_INDEXED , PER_FACE = SoMaterialBindingElement::PER_FACE ,
  PER_FACE_INDEXED = SoMaterialBindingElement::PER_FACE_INDEXED , PER_VERTEX = SoMaterialBindingElement::PER_VERTEX , PER_VERTEX_INDEXED = SoMaterialBindingElement::PER_VERTEX_INDEXED
}
 
- Public Types inherited from SoNode
enum  Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }
 

Public Member Functions

 SoVertexProperty ()
 When traversed in a scene graph, sets coordinates, normals, texture coordinates, diffuse colors, transparency, normal binding and material binding in current traversal state. More...
 
virtual void doAction (SoAction *action)
 This method performs the "typical" operation of a node for any action. More...
 
virtual void GLRender (SoGLRenderAction *action)
 These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing. More...
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 
virtual void callback (SoCallbackAction *action)
 
virtual void pick (SoPickAction *action)
 
void putVBOsIntoState (SoState *state)
 puts the VBOs into the SoGLVBOElement (MeVis ONLY) More...
 
- Public Member Functions inherited from SoNode
void setOverride (bool state)
 Turns override flag on or off. More...
 
bool isOverride () const
 Returns the state of the override flag. More...
 
SoNodecopy (bool copyConnections=FALSE) const
 Creates and returns an exact copy of the node. More...
 
virtual bool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal. More...
 
virtual void getMatrix (SoGetMatrixAction *action)
 
virtual void handleEvent (SoHandleEventAction *action)
 
virtual void rayPick (SoRayPickAction *action)
 
virtual void search (SoSearchAction *action)
 
virtual void write (SoWriteAction *action)
 
virtual void GLRenderBelowPath (SoGLRenderAction *action)
 These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes. More...
 
virtual void GLRenderInPath (SoGLRenderAction *action)
 
virtual void GLRenderOffPath (SoGLRenderAction *action)
 
virtual void grabEventsSetup ()
 These virtual functions are called when a node gains or loses status as "grabber" of events (see HandleEventAction::setGrabber()). More...
 
virtual void grabEventsCleanup ()
 
virtual void startNotify ()
 Initiates notification from an instance. More...
 
virtual void notify (SoNotList *list)
 Propagates modification notification through an instance. More...
 
SbNodeIdType getNodeId () const
 Returns the unique id for a node. More...
 
virtual SoChildListgetChildren () const
 Returns pointer to children, or NULL if none. More...
 
virtual void writeInstance (SoOutput *out)
 Writes instance to SoOutput. (Used for either stage of writing.) More...
 
virtual SoNodeaddToCopyDict () const
 Recursively adds this node and all nodes under it to the copy dictionary. More...
 
virtual void copyContents (const SoFieldContainer *fromFC, bool copyConnections)
 Copies the contents of the given node into this instance. More...
 
virtual SoFieldContainercopyThroughConnection () const
 Copies an instance that is encountered through a field connection. More...
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values. More...
 
bool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values. More...
 
bool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields. More...
 
void copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields. More...
 
bool 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 Inventor file format. More...
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...
 
virtual int getFields (SoFieldList &list) const
 Appends pointers to all of this object's fields to resultList, and returns the number of fields appended. More...
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a pointer to the field with the given name. More...
 
bool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument. More...
 
bool enableNotify (bool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). More...
 
bool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed. More...
 
bool set (const char *fieldDataString, SoInput *dictIn)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format. More...
 
void get (SbString &fieldDataString, SoOutput *dictOut)
 Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...
 
virtual void addWriteReference (SoOutput *out, bool isFromField=FALSE)
 Adds a reference to the instance when writing. More...
 
bool getIsBuiltIn () const
 Returns whether or not instance is considered 'built-in' to the library. More...
 
virtual const SoFieldDatagetFieldData () const
 Returns an SoFieldData structure for the node. More...
 
void addManagedSensor (SoSensor *sensor)
 Adds a sensor which is managed by the field container. More...
 
- Public Member Functions inherited from SoBase
void ref () const
 Adds and removes a reference to an instance. More...
 
void unref () const
 
void unrefNoDelete () const
 
void touch ()
 Marks an instance as modified, simulating a change to it. More...
 
virtual SoType getTypeId () const =0
 Returns the type identifier for a specific instance. More...
 
bool isOfType (SoType type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type. More...
 
virtual SbName getName () const
 Returns the name of an instance. More...
 
virtual void setName (const SbName &name)
 Sets the name of an instance. More...
 
void addAuditor (void *auditor, SoNotRec::Type type)
 Adds/removes an auditor to/from list. More...
 
void removeAuditor (void *auditor, SoNotRec::Type type)
 
const SoAuditorListgetAuditors ()
 Returns auditor list– used by SoField and SoEngineOutput to trace forward connections. More...
 
int getRefCount () const
 Returns current reference count. More...
 
bool shouldWrite ()
 Returns TRUE if the instance should be written, based on the write-reference info already accumulated. More...
 

Static Public Member Functions

static void initClass ()
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns type identifier for the SoNode class. More...
 
static SoNodegetByName (const SbName &name)
 Returns the last node given the specified name. More...
 
static int getByName (const SbName &name, SoNodeList &list)
 Returns the number of nodes with the given name, and adds to list pointers to those nodes. More...
 
static void initClass ()
 Initializes base node class. More...
 
static void initClasses ()
 Initialize ALL Inventor node classes. More...
 
static SbNodeIdType getNextNodeId ()
 Returns the next available unique id. More...
 
static int getActionMethodIndex (SoType t)
 Returns the index of this node in the action/method table, given its type. More...
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class. More...
 
static void initClass ()
 Setup type information. More...
 
static void initCopyDict ()
 During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used. More...
 
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 Adds an instance to the dictionary. More...
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 If a copy of the given instance is in the dictionary, this returns it. More...
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, bool copyConnections)
 If a copy of the given instance is not in the dictionary, this returns NULL. More...
 
static void copyDone ()
 Cleans up the dictionary when done. More...
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class. More...
 
static void initClass ()
 Setup type information. More...
 
static void incrementCurrentWriteCounter ()
 Increments the current write counter at the start of a write operation. More...
 
static void decrementCurrentWriteCounter ()
 Decrements the current write counter after a write operation, in some rare cases. More...
 
static void addName (SoBase *, const char *)
 Internal methods used to maintain the global name dictionary. More...
 
static void removeName (SoBase *, const char *)
 
static SoBasegetNamedBase (const SbName &, SoType)
 Helper routines used to get stuff out of nameDict. More...
 
static int getNamedBases (const SbName &, SoBaseList &, SoType)
 
static bool read (SoInput *in, SoBase *&base, SoType expectedType)
 Reads one instance of some subclass of SoBase. More...
 
static void setInstancePrefix (const SbString &c)
 This defaults to "+" and is used when naming nodes that are DEF's and USE'd. More...
 

Public Attributes

SoMFVec3f vertex
 Fields: More...
 
SoMFVec2f texCoord
 Texture coordinate(s) More...
 
SoMFVec3f normal
 Normal vector(s) More...
 
SoSFEnum normalBinding
 Ignored unless normal field set. More...
 
SoMFUInt32 orderedRGBA
 Diffuse+transparency. More...
 
SoSFEnum materialBinding
 Ignored unless orderedRGBA field set. More...
 

Protected Member Functions

virtual ~SoVertexProperty ()
 
- Protected Member Functions inherited from SoNode
 SoNode ()
 Constructor, destructor. More...
 
virtual ~SoNode ()
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer ()
 
 ~SoFieldContainer ()
 
virtual bool readInstance (SoInput *in, unsigned short flags)
 Reads stuff into instance. Returns FALSE on error. More...
 
- Protected Member Functions inherited from SoBase
 SoBase ()
 Constructor is protected - this is an abstract class. More...
 
virtual ~SoBase ()
 Virtual destructor so that subclasses are deleted properly. More...
 
virtual void destroy ()
 Actually deletes an instance. More...
 
bool hasMultipleWriteRefs () const
 Returns TRUE if the instance has multiple write references. More...
 
bool writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
 Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput. More...
 
void writeFooter (SoOutput *out) const
 
virtual const char * getFileFormatName () const
 Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned) More...
 

Protected Attributes

SoVBO_vertexVBO
 
SoVBO_colorVBO
 
SoVBO_normalVBO
 
SoVBO_texCoordVBO
 
- Protected Attributes inherited from SoNode
SbNodeIdType uniqueId
 Unique id for this node. More...
 
- Protected Attributes inherited from SoFieldContainer
bool isBuiltIn
 Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information. More...
 

Additional Inherited Members

- Static Public Attributes inherited from SoBase
static bool traceRefs
 Turns on/off reference count tracing (for debugging) More...
 
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
 This set of enums is used when reading and writing the base. More...
 
- Static Protected Member Functions inherited from SoNode
static const SoFieldData ** getFieldDataPtr ()
 This is used by the field-inheritence mechanism, hidden in the SoSubNode macros. More...
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter ()
 Returns current write counter. More...
 
- Static Protected Attributes inherited from SoNode
static SbNodeIdType nextUniqueId
 Next available unique id. More...
 
static int nextActionMethodIndex
 Next index into the action method table. More...
 

Detailed Description

This property node may be used to efficiently specify coordinates, normals, texture coordinates, colors, transparency values, material binding and normal binding for vertex-based shapes, i.e., shapes of class SoVertexShape. An SoVertexProperty node can be used as a child of a group node in a scene graph, in which case the properties it specifies are inherited by subsequent shape nodes in the graph. It can also be directly referenced as the VertexProperty SoSFField of a vertex-based shape, bypassing scene graph inheritance.

When directly referenced by a VertexProperty SoSFField of a vertex-based shape, the SoVertexProperty node is the most efficient way of specifying vertex-based shapes. Use of the directly referenced SoVertexProperty node results in significantly faster scene rendering than scene graph inheritance of vertex properties, provided all required vertex properties are specified in the SoVertexProperty node.

Because the class SoVertexProperty is derived from SoNode, a vertex property node can be inserted as a child node in a scene graph. When inserted as a node in a scene graph, the SoVertexProperty node is traversed as any other property node and the properties it specifies are inherited by subsequent shape nodes in the scene graph. It specifies the current material and normal bindings, and can be used to specify the current 3D coordinates, the current normals, the current texture coordinates, the current diffuse colors, and the current transparencies.

All multiple-valued fields in the SoVertexProperty node are optional.
If a field is not present (i.e. if it has 0 values), then shapes that require the missing information are required to obtain it from the current traversal state. However, users are cautioned that, for optimal performance, the vertex property node should be referenced as the VertexProperty field of an SoVertexShape, and should specify in its fields all values required to render that shape.

The various fields in a vertex property node can be used in place of corresponding fields in other property nodes, as follows: The vertex field contains 3D coordinates, as in the point field of an SoCoordinate3 node. The normal field contains normal vectors, as in the vector field of the SoNormal node. The orderedRGBA field contains packed colors in the hexadecimal format 0xrrggbbaa, where rr is the red value (between 00 and 0xFF hex) gg is the green value (between 00 and 0xFF hex) bb is the blue value (between 00 and 0xFF hex) aa is the alpha value (between 00 = transparent and 0xFF = opaque). The packed colors are equivalent to an SoPackedColor node, and provide values for both diffuse color and transparency. The texCoord field replaces the point field of the SoTextureCoordinate2 node.

If the transparency type is SoGLRenderAction::SCREEN_DOOR, only the first transparency value will be used. With other transparency types, multiple transparencies will be used.

The materialBinding field replaces the value field of the SoMaterialBinding node. The materialBinding field in a directly referenced SoVertexProperty node has no effect unless there is a nonempty orderedRGBA field, in which case the material binding specifies the assignment of diffuse colors and alpha values to the shape. The materialBinding field can take as value any of the material bindings supported by Inventor.

The normalBinding field replaces the value field of the SoNormalBinding node. The normalBinding field of a directly referenced SoVertexProperty node has no effect unless there is a nonempty normal field, in which case the normal binding specifies the assignment of normal vectors to the shape. The value of the normalBinding field can be any of the normal bindings supported by Inventor.

File Format/Default
VertexProperty {
vertex [ ]
normal [ ]
}
SoSFEnum materialBinding
Ignored unless orderedRGBA field set.
SoMFVec3f normal
Normal vector(s)
SoSFEnum normalBinding
Ignored unless normal field set.
SoMFUInt32 orderedRGBA
Diffuse+transparency.
SoMFVec3f vertex
Fields:
SoMFVec2f texCoord
Texture coordinate(s)
Action Behavior
SoGetBoundingBoxAction
When traversed in a scene graph, sets coordinates in current traversal state. If not traversed, has no effect on current traversal state associated with action.
See Also
SoIndexedTriangleSet SoIndexedTriangleStripSet SoIndexedFaceSet SoIndexedLineSet SoTriangleStripSet SoLineSet SoFaceSet SoPointSet SoQuadMesh SoVertexShape SoIndexedShape SoNonindexedShape

Definition at line 194 of file SoVertexProperty.h.

Member Enumeration Documentation

◆ Binding

Enumerator
OVERALL 
PER_PART 
PER_PART_INDEXED 
PER_FACE 
PER_FACE_INDEXED 
PER_VERTEX 
PER_VERTEX_INDEXED 

Definition at line 208 of file SoVertexProperty.h.

Constructor & Destructor Documentation

◆ SoVertexProperty()

SoVertexProperty::SoVertexProperty ( )

If not traversed, has no effect on current traversal state associated with action. The normalBinding field has no effect if there are no normals. The materialBinding has no effect if there are no packed colors.

◆ ~SoVertexProperty()

virtual SoVertexProperty::~SoVertexProperty ( )
protectedvirtual

Member Function Documentation

◆ callback()

virtual void SoVertexProperty::callback ( SoCallbackAction action)
virtual

Reimplemented from SoNode.

◆ doAction()

virtual void SoVertexProperty::doAction ( SoAction action)
virtual

The default implementation does nothing.

Reimplemented from SoNode.

◆ getBoundingBox()

virtual void SoVertexProperty::getBoundingBox ( SoGetBoundingBoxAction action)
virtual

Reimplemented from SoNode.

◆ GLRender()

virtual void SoVertexProperty::GLRender ( SoGLRenderAction action)
virtual

Reimplemented from SoNode.

◆ initClass()

static void SoVertexProperty::initClass ( )
static

◆ pick()

virtual void SoVertexProperty::pick ( SoPickAction action)
virtual

Reimplemented from SoNode.

◆ putVBOsIntoState()

void SoVertexProperty::putVBOsIntoState ( SoState state)

Member Data Documentation

◆ _colorVBO

SoVBO* SoVertexProperty::_colorVBO
protected

Definition at line 243 of file SoVertexProperty.h.

◆ _normalVBO

SoVBO* SoVertexProperty::_normalVBO
protected

Definition at line 244 of file SoVertexProperty.h.

◆ _texCoordVBO

SoVBO* SoVertexProperty::_texCoordVBO
protected

Definition at line 245 of file SoVertexProperty.h.

◆ _vertexVBO

SoVBO* SoVertexProperty::_vertexVBO
protected

Definition at line 242 of file SoVertexProperty.h.

◆ materialBinding

SoSFEnum SoVertexProperty::materialBinding

Definition at line 206 of file SoVertexProperty.h.

◆ normal

SoMFVec3f SoVertexProperty::normal

Definition at line 203 of file SoVertexProperty.h.

◆ normalBinding

SoSFEnum SoVertexProperty::normalBinding

Definition at line 204 of file SoVertexProperty.h.

◆ orderedRGBA

SoMFUInt32 SoVertexProperty::orderedRGBA

Definition at line 205 of file SoVertexProperty.h.

◆ texCoord

SoMFVec2f SoVertexProperty::texCoord

Definition at line 202 of file SoVertexProperty.h.

◆ vertex

SoMFVec3f SoVertexProperty::vertex

Coordinate point(s)

Definition at line 201 of file SoVertexProperty.h.


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