public class SoMarkerSet extends SoPointSet
vertexProperty
field (from SoVertexShape
) or the current inherited 3D coordinates. For best performance, the vertexProperty
field is recommended. 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 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 addMarker
functions. Marker definitions in the global list can be used by any SoMarkerSet
or 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 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 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 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 SoVertexProperty
or SoNormal
.
Automatic simplification (by skipping points) is controlled by the 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 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 SoMarker
node.
Limitations:
Shape Antialiasing type is SoShape.POINTS
.
Note that SoMarkerSet
does not cast a shadow (SoShadowGroup
).
The following markers are defined by default:
File format/default:
MarkerSet {
}Action behavior:
SoGLRenderAction
Draws markers based on the current coordinates.
SoGetPrimitiveCountAction
Increments the image count by 1 for each marker in the marker set.
See also:
SoCoordinate3
, SoFullSceneAntialiasing
, SoIndexedMarkerSet
, SoMarker
, SoPointSet
, SoVertexProperty
Modifier and Type | Class and Description |
---|---|
static class |
SoMarkerSet.MarkerTypes
Marker type.
|
SoShape.ShapeTypes
SoNode.RenderModes
Inventor.ConstructorCommand
Modifier and Type | Field and Description |
---|---|
SoSFFloat |
markerGlobalScale
Specifies a global scale factor applied to all markers.
|
SoMFInt32 |
markerIndex
Specifies the marker index (type of marker) for each marker.
|
SoMFFloat |
markerScale
Specifies the scale factor applied to each marker.
|
numPoints
startIndex
vertexProperty
boundingBoxIgnoring
VERBOSE_LEVEL, ZeroHandle
Constructor and Description |
---|
SoMarkerSet()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static void |
addMarker(int markerIndex,
SbVec2s size,
byte[] bytes)
Calls addMarker(markerIndex, size, bytes, true, true).
|
static void |
addMarker(int markerIndex,
SbVec2s size,
byte[] bytes,
boolean isLSBFirst)
Calls addMarker(markerIndex, size, bytes, isLSBFirst, true).
|
static void |
addMarker(int markerIndex,
SbVec2s size,
byte[] bytes,
boolean isLSBFirst,
boolean isUpToDown)
Add a new marker with index markerIndex .
|
static void |
addMarker(int markerIndex,
SbVec2s size,
byte[] bytes,
int[] orderedRGBA)
Calls addMarker(markerIndex, size, bytes, orderedRGBA, true, true).
|
static void |
addMarker(int markerIndex,
SbVec2s size,
byte[] bytes,
int[] orderedRGBA,
boolean isLSBFirst)
Calls addMarker(markerIndex, size, bytes, orderedRGBA, isLSBFirst, true).
|
static void |
addMarker(int markerIndex,
SbVec2s size,
byte[] bytes,
int[] orderedRGBA,
boolean isLSBFirst,
boolean isUpToDown)
Add a new colored marker with index markerIndex .
|
static void |
addMarker(int markerIndex,
SoMarker marker)
Add a new marker with index markerIndex using an existing marker definition.
|
static SoMarker |
getMarker(int markerIndex)
Retrieve the definition of the marker with index markerIndex .
|
static int |
getNumDefinedMarkers()
Return the number of defined markers.
|
static boolean |
removeMarker(int markerIndex)
Remove the marker with index markerIndex .
|
getNormalCache, getTangentCache
getShapeType, isPrimitiveRestartAvailable, isPrimitiveRestartAvailable
affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderEngineMode, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write
copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults
dispose, getName, isDisposable, isSynchronizable, setName, setSynchronizable
getNativeResourceHandle
public final SoMFInt32 markerIndex
MarkerType
. 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. For example, if all the markers in the set will use the same definition it is only necessary to set the first value in markerIndex.
Note: This is an integer valued field. When writing an application you can use enum values to set the field. However in a .iv file you can
only use integer values.
For example, you cannot write:
You must write:MarkerSet { markerIndex DIAMOND_FILLED_9_9 }
MarkerSet { markerIndex 82 }
public final SoMFFloat markerScale
markerGlobalScale
.
Supported only when using shader implementation (this is the default).
public final SoSFFloat markerGlobalScale
markerScale
field.
Supported only when using shader implementation (this is the default).
public static void addMarker(int markerIndex, SbVec2s size, byte[] bytes, int[] orderedRGBA)
public static void addMarker(int markerIndex, SbVec2s size, byte[] bytes, boolean isLSBFirst)
public static void addMarker(int markerIndex, SbVec2s size, byte[] bytes)
public static void addMarker(int markerIndex, SbVec2s size, byte[] bytes, int[] orderedRGBA, boolean isLSBFirst)
public static void addMarker(int markerIndex, SbVec2s size, byte[] bytes, boolean isLSBFirst, boolean isUpToDown)
isLSBFirst : If true, bits are ordered within a byte from least significant to most significant; otherwise the first bit in each byte is the most significant one.
isUpToDown : If true, marker bitmap is described from top to bottom (bytes[0] is the left top corner of the bitmap), otherwise from bottom to top (bytes[0] is the bottom left corner).
public static int getNumDefinedMarkers()
public static void addMarker(int markerIndex, SbVec2s size, byte[] bytes, int[] orderedRGBA, boolean isLSBFirst, boolean isUpToDown)
isLSBFirst : If true, bits are ordered within a byte from least significant to most significant; otherwise the first bit in each byte is the most significant one. 8 isUpToDown : If true, marker bitmap and color array are described from top to bottom (bytes[0] is the left top corner of the bitmap), otherwise from bottom to top (bytes[0] is the bottom left corner).
public static SoMarker getMarker(int markerIndex)
public static boolean removeMarker(int markerIndex)
public static void addMarker(int markerIndex, SoMarker marker)
Generated on July 31, 2019, Copyright © Thermo Fisher Scientific. All rights reserved. http://www.openinventor.com