| SoIndexedMarkerSet Class |
Extension of IndexedPointSet that draws a small bitmap (symbol) at each 3D location.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoShape
OIV.Inventor.NodesSoVertexShape
OIV.Inventor.NodesSoIndexedShape
OIV.Inventor.NodesSoIndexedPointSet
OIV.Inventor.NodesSoIndexedMarkerSet
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoIndexedMarkerSet type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoIndexedMarkerSet | Constructor. |
Methods| Name | Description | |
|---|---|---|
 | AddMarker(Int32, SoMarker) | Add a new marker with index markerIndex using an existing marker definition. |
| AddMarker(Int32, SbVec2s, Byte) | Calls AddMarker(markerIndex, size, bytes, true, true). |
| AddMarker(Int32, SbVec2s, Byte, Boolean) | Calls AddMarker(markerIndex, size, bytes, isLSBFirst, true). |
| AddMarker(Int32, SbVec2s, Byte, UInt32) | Calls AddMarker(markerIndex, size, bytes, orderedRGBA, true, true). |
| AddMarker(Int32, SbVec2s, Byte, Boolean, Boolean) | Add a new marker with index markerIndex . |
| AddMarker(Int32, SbVec2s, Byte, UInt32, Boolean) | Calls AddMarker(markerIndex, size, bytes, orderedRGBA, isLSBFirst, true). |
| AddMarker(Int32, SbVec2s, Byte, UInt32, Boolean, Boolean) | Add a new colored marker with index markerIndex . |
| AffectsState | Overrides default method on OIV.Inventor.Nodes.SoNode. |
| BeginShape(SoAction, SoShapeTriangleShapes) | Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr). (Inherited from SoShape.) |
| BeginShape(SoAction, SoShapeTriangleShapes, SoFaceDetail) | These methods can be used by subclasses to generate triangles more easily when those triangles are part of a larger structure, such as a triangle strip, triangle fan, or triangulated polygon, according to the TriangleShape enumerated type. |
| Callback | Implements primitive generation for all shapes. |
| ComputeBBox(SoAction, SbBox3f, SbVec3f) | This handles AABB bounding box computation for all shapes derived from this class. |
| ComputeBBox(SoAction, SbXfBox3d, SbVec3d) | This handles OOBB bounding box computation for all shapes derived from this class. |
| 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 | (Inherited from SoNode.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| EndShape | end shape previously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). |
| 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 | Implements getBoundingBox actions to tell open caches that they contain lines. |
| 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.) |
| GetMarker(Int32) | Retrieve the definition of the marker with index markerIndex . |
| GetMarker(Int32, SbVec2s, SbNativeArrayByte, Boolean) | Retrieve the description of the marker with index markerIndex . |
| GetMarker(Int32, SbVec2s, SbNativeArrayByte, SbNativeArrayUInt32, Boolean) | Retrieve the description of the colored marker with index markerIndex . |
| GetMatrix | (Inherited from SoNode.) |
| GetName | Returns the name of an instance. |
| GetNormalCache | Returns the current normal cache, or NULL if there is none. |
| GetNumDefinedMarkers | Return the number of defined markers. |
| GetPrimitiveCount | Implements OIV.Inventor.Actions.SoGetPrimitiveCountAction action. |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetShapeType | Gets the current shape Full Scene Antialiasing type. |
| GetStringName | (Inherited from SoBase.) |
| GetTangentCache | Returns the current tangent cache, or NULL if there is none. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | Implements OIV.Inventor.Actions.SoGLRenderAction actions. |
| 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 | Used by BoundingBoxAction to know if bounding box computation should be ignored or not. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Inherited from SoNode.) |
| RayPick | This handles pointPicking mode. |
| RemoveMarker | Remove the marker with index markerIndex . |
| 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 | Turns the override flag on or off. |
| SetShapeType | set the antialiasing type for this shape. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ShapeVertex | add a primitive vertex to the shape prevously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). |
| 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 SoVertexShape.) |
Properties| Name | Description | |
|---|---|---|
 | boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. |
| coordIndex | The indices of the coordinates that the shape uses as its vertices. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| markerGlobalScale | Specifies a global scale factor applied to all markers. |
| markerIndex | Specifies the marker index (type of marker) for each marker. |
| markerScale | Specifies the scale factor applied to each marker. |
| materialIndex | The indices of the materials that are used for the shape. |
| normalIndex | The indices of the normals that are used for the shape. |
| tangentIndex | The indices of the tangents that are used for the shape. |
| textureCoordIndex | The indices of the texture coordinates that are used for the shape. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
| vertexProperty | vertex property node. |
RemarksThis class draws a marker (small image) at each of a set of points located at the coordinates specified by the vertexProperty field (from OIV.Inventor.Nodes.SoVertexShape) or the current inherited 3D coordinates. For best performance, the vertexProperty field is recommended. The coordinate of each marker is specified by the coordIndex field which indexes into the list of coordinates. The number of markers is the number of values in the coordIndex field.
You specify the marker to be drawn at each point using the field OIV.Inventor.Nodes.SoIndexedMarkerSet.markerIndex, which indexes into the global list of marker definitions. There is a set of pre-defined markers already in the global list. You can add your own marker definitions to this list using the OIV.Inventor.Nodes.SoIndexedMarkerSet.AddMarker(System.Int32, OIV.Inventor.SbVec2s, System.Byte[], System.Boolean, System.Boolean) functions. Marker definitions in the global list can be used by any OIV.Inventor.Nodes.SoMarkerSet or OIV.Inventor.Nodes.SoIndexedMarkerSet node. You can specify fewer index values than the number of markers to be drawn (the number of coordinates). In this case the node will cycle through the provided index values as many times as necessary. If all the markers in the set will use the same definition it is only necessary to set the first value in markerIndex.
You can specify a scale factor (> 0) for each marker using the field OIV.Inventor.Nodes.SoIndexedMarkerSet.markerScale. You can specify fewer scale values than the number of markers to be drawn, but in this case the "missing" values are assumed to be 1. You can also specify a scale factor to be applied to every marker in the set using the field OIV.Inventor.Nodes.SoIndexedMarkerSet.markerGlobalScale. This scale factor is applied in addition to the individual scale factor (if any).
A marker is an image defined by a bitmap and optional color values. If no color values are given then image pixels corresponding to "1" bits are drawn using the current material color (see OIV.Inventor.Nodes.SoMaterial) and pixels corresponding to "0" bits are not drawn (whatever is behind the marker shows through). If color values are given then each pixel in the image is assigned an RGBA value.
The coordinates of the markers are transformed by the current cumulative transformation.
Lighting is not applied to markers (i.e., they are rendered with light model BASE_COLOR) unless the application explicitly sets normal vectors using OIV.Inventor.Nodes.SoVertexProperty or OIV.Inventor.Nodes.SoNormal.
Automatic simplification (by skipping points) is controlled by the OIV.Inventor.Nodes.SoComplexity field value. Only values < 0.5 have any effect.
Note that custom markers defined with addMarker are not automatically saved in the Open Inventor file when an OIV.Inventor.Actions.SoWriteAction is applied to the scene graph (and therefore are not defined if the scene graph is reloaded). To save marker definitions in an Open Inventor file use the OIV.Inventor.Nodes.SoMarker node.
Depending on the current material and normal binding values, the materials and normals for the vertices may be accessed in order or indexed. If they are indexed, the materialIndex and normalIndex fields are used. Treatment of the current material and normal binding is as follows: PER_PART, PER_FACE, and PER_VERTEX bindings bind one material or normal to each point. The default material binding is OVERALL. The default normal binding is PER_VERTEX.
Limitations:
Since Open Inventor 9.3, markers are rendered using a high performance shader implementation by default. However the shader implementation requires support for the OpenGL geometry shader (GL_ARB_geometry_shader4) and texture array (GL_EXT_texture_array) features (or the equivalent extensions). If necessary markers will still be rendered, but using the previous drawPixels() implementation which is slower.
OIV.Inventor.Nodes.SoIndexedMarkerSet does not cast or receive shadows (see OIV.Inventor.Nodes.SoShadowGroup).
Shape Antialiasing type is OIV.Inventor.Nodes.SoShape.ShapeTypes.POINTS.
The following markers are defined by default:
FILE FORMAT/DEFAULT
IndexedMarkerSet {
| OIV.Inventor.Nodes.SoIndexedMarkerSet.markerIndex | 0 |
| OIV.Inventor.Nodes.SoIndexedMarkerSet.markerScale | 1 |
| OIV.Inventor.Nodes.SoIndexedMarkerSet.markerGlobalScale | 1 |
| vertexProperty | NULL |
| coordIndex | 0 |
| materialIndex | -1 |
| normalIndex | -1 |
ACTION BEHAVIOR
OIV.Inventor.Actions.SoGLRenderAction Draws bitmaps based on the current coordinates.
OIV.Inventor.Actions.SoGetPrimitiveCountAction Increments the image count by 1 for each marker in the marker set.
See Also