Click or drag to resize
SoMarkerSet Class

Extension of PointSet that draws a small bitmap (symbol) at each 3D location.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
Syntax
public class SoMarkerSet : SoPointSet

The SoMarkerSet type exposes the following members.

Constructors
  NameDescription
Public methodSoMarkerSet

Constructor.

Top
Methods
  NameDescription
Public methodStatic memberAddMarker(Int32, SoMarker)

Add a new marker with index markerIndex using an existing marker definition.

Public methodStatic memberAddMarker(Int32, SbVec2s, Byte)
Calls AddMarker(markerIndex, size, bytes, true, true).
Public methodStatic memberAddMarker(Int32, SbVec2s, Byte, Boolean)
Calls AddMarker(markerIndex, size, bytes, isLSBFirst, true).
Public methodStatic memberAddMarker(Int32, SbVec2s, Byte, UInt32)
Calls AddMarker(markerIndex, size, bytes, orderedRGBA, true, true).
Public methodStatic memberAddMarker(Int32, SbVec2s, Byte, Boolean, Boolean)

Add a new marker with index markerIndex .

Public methodStatic memberAddMarker(Int32, SbVec2s, Byte, UInt32, Boolean)
Calls AddMarker(markerIndex, size, bytes, orderedRGBA, isLSBFirst, true).
Public methodStatic memberAddMarker(Int32, SbVec2s, Byte, UInt32, Boolean, Boolean)

Add a new colored marker with index markerIndex .

Public methodAffectsState

Overrides default method on OIV.Inventor.Nodes.SoNode.

(Inherited from SoShape.)
Public methodBeginShape(SoAction, SoShapeTriangleShapes)
Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr).
(Inherited from SoShape.)
Public methodBeginShape(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.

(Inherited from SoShape.)
Public methodCallback

Implements primitive generation for all shapes.

(Inherited from SoShape.)
Public methodComputeBBox(SoAction, SbBox3f, SbVec3f)

This handles AABB bounding box computation for all shapes derived from this class.

(Overrides SoPointSetComputeBBox(SoAction, SbBox3f, SbVec3f).)
Public methodComputeBBox(SoAction, SbXfBox3d, SbVec3d)

This handles OOBB bounding box computation for all shapes derived from this class.

(Inherited from SoNonIndexedShape.)
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
(Inherited from SoNode.)
Public methodEnableNotify

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

(Inherited from SoFieldContainer.)
Public methodEndShape

end shape previously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail).

(Inherited from SoShape.)
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

Implements OIV.Inventor.Actions.SoGetBoundingBoxAction action Redefined this to tell open caches that they contain points.

(Inherited from SoPointSet.)
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 methodStatic memberGetMarker(Int32)

Retrieve the definition of the marker with index markerIndex .

Public methodStatic memberGetMarker(Int32, SbVec2s, SbNativeArrayByte, Boolean)

Retrieve the description of the marker with index markerIndex .

Public methodStatic memberGetMarker(Int32, SbVec2s, SbNativeArrayByte, SbNativeArrayUInt32, Boolean)

Retrieve the description of the colored marker with index markerIndex .

Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNormalCache

Returns the current normal cache, or NULL if there is none.

(Inherited from SoVertexShape.)
Public methodStatic memberGetNumDefinedMarkers

Return the number of defined markers.

Public methodGetPrimitiveCount (Overrides SoPointSetGetPrimitiveCount(SoGetPrimitiveCountAction).)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetShapeType

Gets the current shape Full Scene Antialiasing type.

(Inherited from SoShape.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetTangentCache

Returns the current tangent cache, or NULL if there is none.

(Inherited from SoVertexShape.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender (Overrides SoPointSetGLRender(SoGLRenderAction).)
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

Used by BoundingBoxAction to know if bounding box computation should be ignored or not.

(Inherited from SoShape.)
Public methodStatic memberIsMarkerBitSet
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 flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick

Implements picking along a ray by intersecting the ray with each primitive generated by subclass.

(Inherited from SoShape.)
Public methodStatic memberRemoveMarker

Remove the marker with index markerIndex .

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

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetShapeType

set the antialiasing type for this shape.

(Inherited from SoShape.)
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 methodShapeVertex

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).

(Inherited from SoShape.)
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 SoVertexShape.)
Top
Properties
  NameDescription
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoShape.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymarkerGlobalScale

Specifies a global scale factor applied to all markers.

Public propertymarkerIndex

Specifies the marker index (type of marker) for each marker.

Public propertymarkerScale

Specifies the scale factor applied to each marker.

Public propertynumPoints

Number of points.

(Inherited from SoPointSet.)
Public propertystartIndex

Index of first coordinate of shape.

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

vertex property node.

(Inherited from SoVertexShape.)
Top
Remarks

This 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. OIV.Inventor.Nodes.SoMarkerSet uses the coordinates in order, starting with the coordinate at startIndex. The number of coordinates to use (the number of markers in the set) is specified by the numPoints field. The default value of this field is -1, which means to use all the coordinates, so it may not be necessary to explicitly set this field.

You specify the marker to be drawn at each point using the field OIV.Inventor.Nodes.SoMarkerSet.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.SoMarkerSet.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.SoMarkerSet.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.SoMarkerSet.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 points (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.

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.

Shape Antialiasing type is OIV.Inventor.Nodes.SoShape.ShapeTypes.POINTS.

Note that OIV.Inventor.Nodes.SoMarkerSet does not cast a shadow (OIV.Inventor.Nodes.SoShadowGroup).

The following markers are defined by default:

FILE FORMAT/DEFAULT

MarkerSet {
OIV.Inventor.Nodes.SoMarkerSet.markerIndex0
OIV.Inventor.Nodes.SoMarkerSet.markerScale1
OIV.Inventor.Nodes.SoMarkerSet.markerGlobalScale1
vertexPropertyNULL
startIndex0
numPoints-1
}

ACTION BEHAVIOR

OIV.Inventor.Actions.SoGLRenderAction Draws markers based on the current coordinates.

OIV.Inventor.Actions.SoGetPrimitiveCountAction Increments the image count by 1 for each marker in the marker set.

See Also