SoVertexProperty Class Reference
[Properties]

Vertex property node. More...

#include <Inventor/nodes/SoVertexProperty.h>

Inheritance diagram for SoVertexProperty:
SoNode SoFieldContainer SoBase SoRefCounter SoTypedObject

List of all members.

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 Member Functions

virtual SoType getTypeId () const
 SoVertexProperty ()
virtual void setOverride (const SbBool state)
virtual SbBool isOverride () const

Static Public Member Functions

static SoType getClassTypeId ()

Public Attributes

SoMFVec3f vertex
SoMFVec2f texCoord
SoMFVec3f texCoord3
SoSFBool forceSending
SoMFVec3f normal
SoSFEnum normalBinding
SoMFUInt32 orderedRGBA
SoSFEnum materialBinding

Detailed Description

Vertex property node.

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.

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. 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 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. If you want, for example, to force transparency to 0 (making all geometry opaque), use an SoTransparencyType node with the type field set to NO_TRANSPARENCY.

Transparency:

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 default transparency algorithm is SCREEN_DOOR. To get a nice appearance for transparent objects you must change this to another value, for example, BLEND or DELAYED_BLEND, using the setTransparencyType method in the Viewer class or using an SoTransparencyType node. 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. The materialBinding field can take as value any of the material bindings supported by Open Inventor.

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. The value of the normalBinding field can be any of the normal bindings supported by Open Inventor.

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

SEE ALSO

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

See related examples:

MedicalGetDataPolyLine, SegY2D, GetDataPolyLine


Member Enumeration Documentation

Binding.

Enumerator:
OVERALL 

Whole object has same material/normal.

PER_PART 

One material/normal for each part of object.

PER_PART_INDEXED 

One material/normal for each part, indexed.

PER_FACE 

One material/normal for each face of object.

PER_FACE_INDEXED 

One material/normal for each face, indexed.

PER_VERTEX 

One material/normal for each vertex of object.

PER_VERTEX_INDEXED 

One material/normal for each vertex, indexed.


Constructor & Destructor Documentation

SoVertexProperty::SoVertexProperty (  ) 

Creates an SoVertexProperty node with default settings.


Member Function Documentation

static SoType SoVertexProperty::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoNode.

virtual SoType SoVertexProperty::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

virtual SbBool SoVertexProperty::isOverride (  )  const [inline, virtual]

Returns the state of the override field.

Reimplemented from SoNode.

virtual void SoVertexProperty::setOverride ( const SbBool  state  )  [inline, virtual]

Set the state of the override field.

see SoNode::setOverride doc.

Reimplemented from SoNode.


Member Data Documentation

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

Material binding.

Use enum Binding. Default is OVERALL.

Normal vector(s).

Normal binding.

Use enum Binding. Default is PER_VERTEX_INDEXED.

Packed color(s), including transparencies.

2D texture coordinate(s).

3D texture coordinate(s).

Vertex coordinate(s).


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

Open Inventor Toolkit reference manual, generated on 18 Jul 2022
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/