Click or drag to resize
SoVertexProperty Class

Vertex property node.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.0.0 (2024.2.0)
Syntax
public class SoVertexProperty : SoNode

The SoVertexProperty type exposes the following members.

Constructors
  NameDescription
Public methodSoVertexProperty

Creates an OIV.Inventor.Nodes.SoVertexProperty node with default settings.

Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored.

(Inherited from SoNode.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override field.

(Overrides SoNodeIsOverride.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodIsTransparent
Public methodPick
Public methodRayPick
(Inherited from SoNode.)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

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.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Set the state of the override field.

(Overrides SoNodeSetOverride(Boolean).)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertyforceSending

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

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymaterialBinding

Material binding.

Public propertynormal

Normal vector(s).

Public propertynormalBinding

Normal binding.

Public propertyorderedRGBA

Packed color(s), including transparencies.

Public propertytangent

Tangent vector(s).

Public propertytangentBinding

Tangent binding.

Public propertytexCoord

2D texture coordinate(s).

Public propertytexCoord3

3D texture coordinate(s).

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Public propertyvertex

Vertex coordinate(s).

Top
Remarks

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 OIV.Inventor.Nodes.SoVertexShape.

An OIV.Inventor.Nodes.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 OIV.Inventor.Nodes.SoVertexProperty node is the most efficient way of specifying vertex-based shapes. Use of the directly referenced OIV.Inventor.Nodes.SoVertexProperty node results in significantly faster scene rendering than scene graph inheritance of vertex properties, provided all required vertex properties are specified in the OIV.Inventor.Nodes.SoVertexProperty node.

Because the class OIV.Inventor.Nodes.SoVertexProperty is derived from OIV.Inventor.Nodes.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 OIV.Inventor.Nodes.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 OIV.Inventor.Nodes.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 OIV.Inventor.Nodes.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:

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 OIV.Inventor.Nodes.SoVertexProperty.SetOverride(System.Boolean) was called on an OIV.Inventor.Nodes.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 OIV.Inventor.Nodes.SoMaterial node are used instead of the values in the OIV.Inventor.Nodes.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 OIV.Inventor.Actions.SoGLRenderAction for a discussion of transparency algorithms and rendering order.

Material binding:

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

Normal binding:

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

Tangent binding:

The OIV.Inventor.Nodes.SoVertexProperty.tangentBinding field of a directly referenced OIV.Inventor.Nodes.SoVertexProperty node has no effect unless there is a nonempty OIV.Inventor.Nodes.SoVertexProperty.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

OIV.Inventor.Actions.SoGLRenderAction, OIV.Inventor.Actions.SoCallbackAction, OIV.Inventor.Actions.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: OIV.Inventor.Elements.SoCoordinateElement, OIV.Inventor.Elements.SoNormalElement, OIV.Inventor.Elements.SoNormalBindingElement, OIV.Inventor.Elements.SoMaterialElementOIV.Inventor.Elements.SoMaterialBindingElement, OIV.Inventor.Elements.SoTextureCoordinateElement, OIV.Inventor.Elements.SoTangentElement, OIV.Inventor.Elements.SoTangentBindingElement

OIV.Inventor.Actions.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: OIV.Inventor.Elements.SoCoordinateElement

See Also