SoVertexProperty Class Reference

Vertex property node. More...

#include <Inventor/nodes/SoVertexProperty.h>

Inheritance diagram for SoVertexProperty:

Public Types
enum	Binding {   OVERALL = SbVertexAttributeBinding::OVERALL ,   PER_PART = SbVertexAttributeBinding::PER_PART ,   PER_PART_INDEXED = SbVertexAttributeBinding::PER_PART_INDEXED ,   PER_FACE = SbVertexAttributeBinding::PER_FACE ,   PER_FACE_INDEXED = SbVertexAttributeBinding::PER_FACE_INDEXED ,   PER_VERTEX = SbVertexAttributeBinding::PER_VERTEX ,   PER_VERTEX_INDEXED = SbVertexAttributeBinding::PER_VERTEX_INDEXED }
	Binding. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoVertexProperty ()
	Creates an SoVertexProperty node with default settings.
virtual void	setOverride (const SbBool state)
	Set the state of the override field.
virtual SbBool	isOverride () const
	Returns the state of the override field.
Public Member Functions inherited from SoNode
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
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 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
SoMFVec3f	vertex
	Vertex coordinate(s).
SoMFVec2f	texCoord
	2D texture coordinate(s).
SoMFVec3f	texCoord3
	3D texture coordinate(s).
SoSFBool	forceSending
	Forces the texture coordinates to be sent to the GPU even if no texture is bound.
SoMFVec3f	normal
	Normal vector(s).
SoMFVec3f	tangent
	Tangent vector(s).
SoSFEnum	normalBinding
	Normal binding.
SoSFEnum	tangentBinding
	Tangent binding.
SoMFUInt32	orderedRGBA
	Packed color(s), including transparencies.
SoSFEnum	materialBinding
	Material binding.

Detailed Description

Vertex property node.

This property node is be used to efficiently specify coordinates, normals, tangents, texture coordinates, colors, transparency values, material binding, normal and tangent binding for vertex-based shapes, i.e., shapes derived from 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 using the vertexProperty field of a vertex-based shape, bypassing scene graph inheritance. Direct referencing is the recommended practice.

When directly referenced by a VertexProperty field 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, normal and tangent bindings, and can be used to specify the current 3D coordinates, the current normals, the current tangents, 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, developers 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.

Fields:

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.
  Normal vectors are used (for example) to compute the effect of lighting on the shape when lighting is enabled.
  
  
• The tangent field contains tangent vectors.
  When not using any custom shader, tangents are used by line shapes to compute the effect of lighting on the shape when lighting is enabled. See SoLineSet and SoIndexedLineSet for more details.
  
  
• The orderedRGBA field contains packed color+transparency values.
  Colors are specified 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). Packed colors use less memory than SoMaterial colors and can be sent directly to the GPU. A packed color value can be queried from an SbColor or SbColorRGBA object using the getPackedValue() method. The packed colors are equivalent to an SoPackedColor node, and provide values for both diffuse color and transparency.
  
  
• The texCoord and texCoord3 fields contain texture coordinates, as in the point field of the SoTextureCoordinate2 and SoTextureCoordinate3 nodes.

If one of these nodes appears higher in the scene graph and setOverride(true) was called on that node, those values are used instead of the corresponding field of the vertex property node.
Note: Calling setIgnored(true) on the fields of this node has no effect on its behavior.

Color:

If setOverride() was called on an SoMaterial node higher in the scene graph and either the diffuseColor field or the transparency field is not ignored (setIgnored()), then the color and transparency values from the SoMaterial node are used instead of the values in the SoVertexProperty. It is not currently possible to override just the color or just the transparency.

Transparency:

The default transparency algorithm is NO_SORT. To get a nice appearance for transparent objects you must change this to another value, for example, OPAQUE_FIRST or SORTED_PIXEL, using the setTransparencyType method in the viewer or renderAction class. See SoGLRenderAction for a discussion of transparency algorithms and rendering order.

Material binding:

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.

Normal binding:

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.

Tangent binding:

The tangentBinding field of a directly referenced SoVertexProperty node has no effect unless there is a nonempty tangent field, in which case the tangent binding specifies the assignment of tangent vectors to the shape.

FILE FORMAT/DEFAULT

VertexProperty {

vertex	[ ]
normal	[ ]
tangent	[ ]
texCoord	[ ]
texCoord3	[ ]
orderedRGBA	[ ]
materialBinding	OVERALL
normalBinding	PER_VERTEX_INDEXED
tangentBinding	PER_VERTEX_INDEXED
forceSending	FALSE

}

ACTION BEHAVIOR

SoGLRenderAction, SoCallbackAction, SoPickAction
When traversed in a scene graph, sets coordinates, normals, tangents, texture coordinates, diffuse colors, transparency, normal binding, tangent binding and material binding in current traversal state. 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 tangentBinding field has no effect if there are no tangents. The materialBinding has no effect if there are no packed colors. Sets: SoCoordinateElement, SoNormalElement, SoNormalBindingElement, SoMaterialElement SoMaterialBindingElement, SoTextureCoordinateElement, SoTangentElement, SoTangentBindingElement

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. Sets: SoCoordinateElement

SEE ALSO

SoIndexedTriangleStripSet, SoIndexedFaceSet, SoIndexedLineSet, SoTriangleStripSet, SoLineSet, SoFaceSet, SoPointSet, SoQuadMesh, SoVertexShape, SoIndexedShape, SoNonIndexedShape

Definition at line 249 of file SoVertexProperty.h.

Member Enumeration Documentation

Binding

enum SoVertexProperty::Binding

Binding.

Note: The meaning of some binding values depends on the shape class. For example, PER_FACE and PER_PART are the same for some shapes.

Enumerator
OVERALL	Whole object has same material/normal/tangent.
PER_PART	One material/normal/tangent for each part of object.
PER_PART_INDEXED	One material/normal/tangent for each part, indexed.
PER_FACE	One material/normal/tangent for each face of object.
PER_FACE_INDEXED	One material/normal/tangent for each face, indexed.
PER_VERTEX	One material/normal/tangent for each vertex of object.
PER_VERTEX_INDEXED	One material/normal/tangent for each vertex, indexed.

Definition at line 311 of file SoVertexProperty.h.

Constructor & Destructor Documentation

SoVertexProperty()

SoVertexProperty::SoVertexProperty

(

)

Creates an SoVertexProperty node with default settings.

Member Function Documentation

getClassTypeId()

static SoType SoVertexProperty::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoVertexProperty::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

isOverride()

virtual SbBool SoVertexProperty::isOverride ( ) const

inlinevirtual

Returns the state of the override field.

Reimplemented from SoNode.

Definition at line 357 of file SoVertexProperty.h.

setOverride()

virtual void SoVertexProperty::setOverride ( const SbBool  state )

inlinevirtual

Set the state of the override field.

see SoNode::setOverride doc.

Reimplemented from SoNode.

Definition at line 351 of file SoVertexProperty.h.

Member Data Documentation

forceSending

SoSFBool SoVertexProperty::forceSending

Forces the texture coordinates to be sent to the GPU even if no texture is bound.

Definition at line 271 of file SoVertexProperty.h.

materialBinding

SoSFEnum SoVertexProperty::materialBinding

Material binding.

Use enum Binding. Default is OVERALL.

Definition at line 306 of file SoVertexProperty.h.

normal

SoMFVec3f SoVertexProperty::normal

Normal vector(s).

Default is empty.

Definition at line 276 of file SoVertexProperty.h.

normalBinding

SoSFEnum SoVertexProperty::normalBinding

Normal binding.

Use enum Binding. Default is PER_VERTEX_INDEXED.

Definition at line 288 of file SoVertexProperty.h.

orderedRGBA

SoMFUInt32 SoVertexProperty::orderedRGBA

Packed color(s), including transparencies.

Default is empty.

Definition at line 300 of file SoVertexProperty.h.

tangent

SoMFVec3f SoVertexProperty::tangent

Tangent vector(s).

Default is empty. NOTE: field available since Open Inventor 10.2

Definition at line 282 of file SoVertexProperty.h.

tangentBinding

SoSFEnum SoVertexProperty::tangentBinding

Tangent binding.

Use enum Binding. Default is PER_VERTEX_INDEXED. NOTE: field available since Open Inventor 10.2

Definition at line 295 of file SoVertexProperty.h.

texCoord

SoMFVec2f SoVertexProperty::texCoord

2D texture coordinate(s).

Default is empty.

Definition at line 262 of file SoVertexProperty.h.

texCoord3

SoMFVec3f SoVertexProperty::texCoord3

3D texture coordinate(s).

Default is empty.

Definition at line 266 of file SoVertexProperty.h.

vertex

SoMFVec3f SoVertexProperty::vertex

Vertex coordinate(s).

Default is empty.

Definition at line 258 of file SoVertexProperty.h.

---

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

• Inventor/nodes/SoVertexProperty.h