com.openinventor.inventor.nodes

Class SoVertexProperty

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodes.SoVertexProperty

All Implemented Interfaces:

SafeDisposable

public class SoVertexProperty
extends SoNode

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:

VertexProperty {

vertex	[ ]
normal	[ ]
texCoord	[ ]
texCoord3	[ ]
orderedRGBA	[ ]
materialBinding	OVERALL
normalBinding	PER_VERTEX_INDEXED
forceSending	false

}

Action behavior:

SoGLRenderAction, SoCallbackAction, SoPickAction
When traversed in a scene graph, sets coordinates, normals, texture coordinates, diffuse colors, transparency, normal 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 materialBinding has no effect if there are no packed colors. Sets: SoCoordinateElement, SoNormalElement, SoNormalBindingElement, SoLazyElementSoMaterialBindingElement, SoTextureCoordinateElement

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoVertexProperty.Bindings Binding.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFBool	forceSending Forces the texture coordinates to be sent to OpenGL even if no texture is bound.
SoSFEnum<SoVertexProperty.Bindings>	materialBinding Material binding.
SoMFVec3f	normal Normal vector(s).
SoSFEnum<SoVertexProperty.Bindings>	normalBinding Normal binding.
SoMFUInt32	orderedRGBA Packed color(s), including transparencies.
static int	OVERALL Deprecated. Use SoVertexProperty.Bindings.OVERALL instead.
static int	PER_FACE Deprecated. Use SoVertexProperty.Bindings.PER_FACE instead.
static int	PER_FACE_INDEXED Deprecated. Use SoVertexProperty.Bindings.PER_FACE_INDEXED instead.
static int	PER_PART Deprecated. Use SoVertexProperty.Bindings.PER_PART instead.
static int	PER_PART_INDEXED Deprecated. Use SoVertexProperty.Bindings.PER_PART_INDEXED instead.
static int	PER_VERTEX Deprecated. Use SoVertexProperty.Bindings.PER_VERTEX instead.
static int	PER_VERTEX_INDEXED Deprecated. Use SoVertexProperty.Bindings.PER_VERTEX_INDEXED instead.
SoMFVec2f	texCoord 2D texture coordinate(s).
SoMFVec3f	texCoord3 3D texture coordinate(s).
SoMFVec3f	vertex Vertex coordinate(s).

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVertexProperty() Creates an SoVertexProperty node with default settings.

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OVERALL

@Deprecated
public static final int OVERALL

Deprecated. Use SoVertexProperty.Bindings.OVERALL instead.

PER_PART

@Deprecated
public static final int PER_PART

Deprecated. Use SoVertexProperty.Bindings.PER_PART instead.

PER_PART_INDEXED

@Deprecated
public static final int PER_PART_INDEXED

Deprecated. Use SoVertexProperty.Bindings.PER_PART_INDEXED instead.

PER_FACE

@Deprecated
public static final int PER_FACE

Deprecated. Use SoVertexProperty.Bindings.PER_FACE instead.

PER_FACE_INDEXED

@Deprecated
public static final int PER_FACE_INDEXED

Deprecated. Use SoVertexProperty.Bindings.PER_FACE_INDEXED instead.

PER_VERTEX

@Deprecated
public static final int PER_VERTEX

Deprecated. Use SoVertexProperty.Bindings.PER_VERTEX instead.

PER_VERTEX_INDEXED

@Deprecated
public static final int PER_VERTEX_INDEXED

Deprecated. Use SoVertexProperty.Bindings.PER_VERTEX_INDEXED instead.

vertex

public final SoMFVec3f vertex

Vertex coordinate(s).

texCoord

public final SoMFVec2f texCoord

2D texture coordinate(s).

texCoord3

public final SoMFVec3f texCoord3

3D texture coordinate(s).

forceSending

public final SoSFBool forceSending

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

normal

public final SoMFVec3f normal

Normal vector(s).

normalBinding

public final SoSFEnum<SoVertexProperty.Bindings> normalBinding

Normal binding. . Default is PER_VERTEX_INDEXED.

orderedRGBA

public final SoMFUInt32 orderedRGBA

Packed color(s), including transparencies.

materialBinding

public final SoSFEnum<SoVertexProperty.Bindings> materialBinding

Material binding. . Default is OVERALL.

Constructor Detail

SoVertexProperty

public SoVertexProperty()

Creates an SoVertexProperty node with default settings.