| SoVertexProperty Class |
Vertex property node.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoVertexProperty
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.2.0 (10.16.2.0)
SyntaxThe SoVertexProperty type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoVertexProperty | Creates an OIV.Inventor.Nodes.SoVertexProperty node with default settings. |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Overrides SoNodeCallback(SoCallbackAction).) |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Overrides SoNodeDoAction(SoAction).) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | (Overrides SoNodeGetBoundingBox(SoGetBoundingBoxAction).) |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Inherited from SoNode.) |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | (Overrides SoNodeGetPrimitiveCount(SoGetPrimitiveCountAction).) |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Overrides SoNodeGLRender(SoGLRenderAction).) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoNode.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsBoundingBoxIgnoring | 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. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override field. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| IsTransparent | |
| Pick | (Overrides SoNodePick(SoPickAction).) |
| RayPick | (Inherited from SoNode.) |
| Search | (Inherited from SoNode.) |
| Set | 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. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Set the state of the override field. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Inherited from SoNode.) |
Properties| Name | Description | |
|---|---|---|
 | forceSending | Forces the texture coordinates to be sent to the GPU even if no texture is bound. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| materialBinding | Material binding. |
| normal | Normal vector(s). |
| normalBinding | Normal binding. |
| orderedRGBA | Packed color(s), including transparencies. |
| tangent | Tangent vector(s). |
| tangentBinding | Tangent binding. |
| texCoord | 2D texture coordinate(s). |
| texCoord3 | 3D texture coordinate(s). |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
| vertex | Vertex coordinate(s). |
RemarksThis 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:
The OIV.Inventor.Nodes.SoVertexProperty.vertex field contains 3D coordinates, as in the point field of an OIV.Inventor.Nodes.SoCoordinate3 node.
The OIV.Inventor.Nodes.SoVertexProperty.normal field contains normal vectors, as in the vector field of the OIV.Inventor.Nodes.SoNormal node. Normal vectors are used (for example) to compute the effect of lighting on the shape when lighting is enabled.
The OIV.Inventor.Nodes.SoVertexProperty.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 OIV.Inventor.Nodes.SoLineSet and OIV.Inventor.Nodes.SoIndexedLineSet for more details.
The OIV.Inventor.Nodes.SoVertexProperty.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 OIV.Inventor.Nodes.SoMaterial colors and can be sent directly to the GPU. A packed color value can be queried from an OIV.Inventor.SbColor or OIV.Inventor.SbColorRGBA object using the getPackedValue() method. The packed colors are equivalent to an OIV.Inventor.Nodes.SoPackedColor node, and provide values for both diffuse color and transparency.
The OIV.Inventor.Nodes.SoVertexProperty.texCoord and OIV.Inventor.Nodes.SoVertexProperty.texCoord3 fields contain texture coordinates, as in the point field of the OIV.Inventor.Nodes.SoTextureCoordinate2 and OIV.Inventor.Nodes.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 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