com.openinventor.inventor.nodes

Class SoMarkerSet

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodes.SoShape

com.openinventor.inventor.nodes.SoVertexShape

com.openinventor.inventor.nodes.SoNonIndexedShape

com.openinventor.inventor.nodes.SoPointSet

com.openinventor.inventor.nodes.SoMarkerSet

All Implemented Interfaces:

SafeDisposable

public class SoMarkerSet
extends SoPointSet

Extension of PointSet that draws a small bitmap (symbol) at each 3D location. This class draws a marker (small image) at each of a set of points located at the coordinates specified by the 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.25 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:

• 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.
• SoMarkerSet does not cast or receive shadows (see SoShadowGroup).

Shape Antialiasing type is SoShape.POINTS.

The following markers are defined by default:

File format/default:

MarkerSet {

markerIndex	0
markerScale	1
markerGlobalScale	1
vertexProperty	NULL
startIndex	0
numPoints	-1

}

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoMarkerSet.MarkerTypes Marker type.

Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoShape

SoShape.ShapeTypes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	BACKSLASH_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.BACKSLASH_5_5 instead.
static int	BACKSLASH_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.BACKSLASH_7_7 instead.
static int	BACKSLASH_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.BACKSLASH_9_9 instead.
static int	BAR_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.BAR_5_5 instead.
static int	BAR_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.BAR_7_7 instead.
static int	BAR_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.BAR_9_9 instead.
static int	CAUTION_FILLED_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.CAUTION_FILLED_5_5 instead.
static int	CAUTION_FILLED_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.CAUTION_FILLED_7_7 instead.
static int	CAUTION_FILLED_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.CAUTION_FILLED_9_9 instead.
static int	CAUTION_LINE_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.CAUTION_LINE_5_5 instead.
static int	CAUTION_LINE_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.CAUTION_LINE_7_7 instead.
static int	CAUTION_LINE_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.CAUTION_LINE_9_9 instead.
static int	CIRCLE_FILLED_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.CIRCLE_FILLED_5_5 instead.
static int	CIRCLE_FILLED_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.CIRCLE_FILLED_7_7 instead.
static int	CIRCLE_FILLED_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.CIRCLE_FILLED_9_9 instead.
static int	CIRCLE_LINE_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.CIRCLE_LINE_5_5 instead.
static int	CIRCLE_LINE_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.CIRCLE_LINE_7_7 instead.
static int	CIRCLE_LINE_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.CIRCLE_LINE_9_9 instead.
static int	CROSS_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.CROSS_5_5 instead.
static int	CROSS_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.CROSS_7_7 instead.
static int	CROSS_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.CROSS_9_9 instead.
static int	DIAMOND_FILLED_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.DIAMOND_FILLED_5_5 instead.
static int	DIAMOND_FILLED_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.DIAMOND_FILLED_7_7 instead.
static int	DIAMOND_FILLED_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.DIAMOND_FILLED_9_9 instead.
static int	DIAMOND_LINE_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.DIAMOND_LINE_5_5 instead.
static int	DIAMOND_LINE_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.DIAMOND_LINE_7_7 instead.
static int	DIAMOND_LINE_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.DIAMOND_LINE_9_9 instead.
static int	HOURGLASS_FILLED_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.HOURGLASS_FILLED_5_5 instead.
static int	HOURGLASS_FILLED_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.HOURGLASS_FILLED_7_7 instead.
static int	HOURGLASS_FILLED_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.HOURGLASS_FILLED_9_9 instead.
static int	HOURGLASS_LINE_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.HOURGLASS_LINE_5_5 instead.
static int	HOURGLASS_LINE_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.HOURGLASS_LINE_7_7 instead.
static int	HOURGLASS_LINE_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.HOURGLASS_LINE_9_9 instead.
static int	LIGHTNING_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.LIGHTNING_5_5 instead.
static int	LIGHTNING_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.LIGHTNING_7_7 instead.
static int	LIGHTNING_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.LIGHTNING_9_9 instead.
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.
static int	MINUS_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.MINUS_5_5 instead.
static int	MINUS_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.MINUS_7_7 instead.
static int	MINUS_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.MINUS_9_9 instead.
static int	PINE_TREE_FILLED_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.PINE_TREE_FILLED_5_5 instead.
static int	PINE_TREE_FILLED_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.PINE_TREE_FILLED_7_7 instead.
static int	PINE_TREE_FILLED_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.PINE_TREE_FILLED_9_9 instead.
static int	PINE_TREE_LINE_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.PINE_TREE_LINE_5_5 instead.
static int	PINE_TREE_LINE_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.PINE_TREE_LINE_7_7 instead.
static int	PINE_TREE_LINE_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.PINE_TREE_LINE_9_9 instead.
static int	PLUS_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.PLUS_5_5 instead.
static int	PLUS_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.PLUS_7_7 instead.
static int	PLUS_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.PLUS_9_9 instead.
static int	RHOMBUS_FILLED_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.RHOMBUS_FILLED_5_5 instead.
static int	RHOMBUS_FILLED_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.RHOMBUS_FILLED_7_7 instead.
static int	RHOMBUS_FILLED_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.RHOMBUS_FILLED_9_9 instead.
static int	RHOMBUS_LINE_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.RHOMBUS_LINE_5_5 instead.
static int	RHOMBUS_LINE_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.RHOMBUS_LINE_7_7 instead.
static int	RHOMBUS_LINE_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.RHOMBUS_LINE_9_9 instead.
static int	SATELLITE_FILLED_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.SATELLITE_FILLED_5_5 instead.
static int	SATELLITE_FILLED_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.SATELLITE_FILLED_7_7 instead.
static int	SATELLITE_FILLED_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.SATELLITE_FILLED_9_9 instead.
static int	SATELLITE_LINE_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.SATELLITE_LINE_5_5 instead.
static int	SATELLITE_LINE_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.SATELLITE_LINE_7_7 instead.
static int	SATELLITE_LINE_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.SATELLITE_LINE_9_9 instead.
static int	SHIP_FILLED_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.SHIP_FILLED_5_5 instead.
static int	SHIP_FILLED_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.SHIP_FILLED_7_7 instead.
static int	SHIP_FILLED_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.SHIP_FILLED_9_9 instead.
static int	SHIP_LINE_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.SHIP_LINE_5_5 instead.
static int	SHIP_LINE_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.SHIP_LINE_7_7 instead.
static int	SHIP_LINE_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.SHIP_LINE_9_9 instead.
static int	SLASH_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.SLASH_5_5 instead.
static int	SLASH_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.SLASH_7_7 instead.
static int	SLASH_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.SLASH_9_9 instead.
static int	SQUARE_FILLED_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.SQUARE_FILLED_5_5 instead.
static int	SQUARE_FILLED_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.SQUARE_FILLED_7_7 instead.
static int	SQUARE_FILLED_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.SQUARE_FILLED_9_9 instead.
static int	SQUARE_LINE_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.SQUARE_LINE_5_5 instead.
static int	SQUARE_LINE_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.SQUARE_LINE_7_7 instead.
static int	SQUARE_LINE_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.SQUARE_LINE_9_9 instead.
static int	STAR_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.STAR_5_5 instead.
static int	STAR_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.STAR_7_7 instead.
static int	STAR_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.STAR_9_9 instead.
static int	TRIANGLE_FILLED_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.TRIANGLE_FILLED_5_5 instead.
static int	TRIANGLE_FILLED_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.TRIANGLE_FILLED_7_7 instead.
static int	TRIANGLE_FILLED_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.TRIANGLE_FILLED_9_9 instead.
static int	TRIANGLE_LINE_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.TRIANGLE_LINE_5_5 instead.
static int	TRIANGLE_LINE_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.TRIANGLE_LINE_7_7 instead.
static int	TRIANGLE_LINE_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.TRIANGLE_LINE_9_9 instead.
static int	WELL_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.WELL_5_5 instead.
static int	WELL_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.WELL_7_7 instead.
static int	WELL_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.WELL_9_9 instead.
static int	Y_5_5 Deprecated. Use SoMarkerSet.MarkerTypes.Y_5_5 instead.
static int	Y_7_7 Deprecated. Use SoMarkerSet.MarkerTypes.Y_7_7 instead.
static int	Y_9_9 Deprecated. Use SoMarkerSet.MarkerTypes.Y_9_9 instead.

Fields inherited from class com.openinventor.inventor.nodes.SoPointSet

numPoints

Fields inherited from class com.openinventor.inventor.nodes.SoNonIndexedShape

startIndex

Fields inherited from class com.openinventor.inventor.nodes.SoVertexShape

vertexProperty

Fields inherited from class com.openinventor.inventor.nodes.SoShape

boundingBoxIgnoring, LINES, POINTS, POLYGONS, TEXT

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoMarkerSet() Constructor.

Method Summary

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 .

Methods inherited from class com.openinventor.inventor.nodes.SoVertexShape

getNormalCache

Methods inherited from class com.openinventor.inventor.nodes.SoShape

getShapeType, isPrimitiveRestartAvailable, isPrimitiveRestartAvailable

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CROSS_5_5

@Deprecated
public static final int CROSS_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.CROSS_5_5 instead.

PLUS_5_5

@Deprecated
public static final int PLUS_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.PLUS_5_5 instead.

MINUS_5_5

@Deprecated
public static final int MINUS_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.MINUS_5_5 instead.

SLASH_5_5

@Deprecated
public static final int SLASH_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.SLASH_5_5 instead.

BACKSLASH_5_5

@Deprecated
public static final int BACKSLASH_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.BACKSLASH_5_5 instead.

BAR_5_5

@Deprecated
public static final int BAR_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.BAR_5_5 instead.

STAR_5_5

@Deprecated
public static final int STAR_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.STAR_5_5 instead.

Y_5_5

@Deprecated
public static final int Y_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.Y_5_5 instead.

LIGHTNING_5_5

@Deprecated
public static final int LIGHTNING_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.LIGHTNING_5_5 instead.

WELL_5_5

@Deprecated
public static final int WELL_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.WELL_5_5 instead.

CIRCLE_LINE_5_5

@Deprecated
public static final int CIRCLE_LINE_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.CIRCLE_LINE_5_5 instead.

SQUARE_LINE_5_5

@Deprecated
public static final int SQUARE_LINE_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.SQUARE_LINE_5_5 instead.

DIAMOND_LINE_5_5

@Deprecated
public static final int DIAMOND_LINE_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.DIAMOND_LINE_5_5 instead.

TRIANGLE_LINE_5_5

@Deprecated
public static final int TRIANGLE_LINE_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.TRIANGLE_LINE_5_5 instead.

RHOMBUS_LINE_5_5

@Deprecated
public static final int RHOMBUS_LINE_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.RHOMBUS_LINE_5_5 instead.

HOURGLASS_LINE_5_5

@Deprecated
public static final int HOURGLASS_LINE_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.HOURGLASS_LINE_5_5 instead.

SATELLITE_LINE_5_5

@Deprecated
public static final int SATELLITE_LINE_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.SATELLITE_LINE_5_5 instead.

PINE_TREE_LINE_5_5

@Deprecated
public static final int PINE_TREE_LINE_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.PINE_TREE_LINE_5_5 instead.

CAUTION_LINE_5_5

@Deprecated
public static final int CAUTION_LINE_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.CAUTION_LINE_5_5 instead.

SHIP_LINE_5_5

@Deprecated
public static final int SHIP_LINE_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.SHIP_LINE_5_5 instead.

CIRCLE_FILLED_5_5

@Deprecated
public static final int CIRCLE_FILLED_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.CIRCLE_FILLED_5_5 instead.

SQUARE_FILLED_5_5

@Deprecated
public static final int SQUARE_FILLED_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.SQUARE_FILLED_5_5 instead.

DIAMOND_FILLED_5_5

@Deprecated
public static final int DIAMOND_FILLED_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.DIAMOND_FILLED_5_5 instead.

TRIANGLE_FILLED_5_5

@Deprecated
public static final int TRIANGLE_FILLED_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.TRIANGLE_FILLED_5_5 instead.

RHOMBUS_FILLED_5_5

@Deprecated
public static final int RHOMBUS_FILLED_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.RHOMBUS_FILLED_5_5 instead.

HOURGLASS_FILLED_5_5

@Deprecated
public static final int HOURGLASS_FILLED_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.HOURGLASS_FILLED_5_5 instead.

SATELLITE_FILLED_5_5

@Deprecated
public static final int SATELLITE_FILLED_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.SATELLITE_FILLED_5_5 instead.

PINE_TREE_FILLED_5_5

@Deprecated
public static final int PINE_TREE_FILLED_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.PINE_TREE_FILLED_5_5 instead.

CAUTION_FILLED_5_5

@Deprecated
public static final int CAUTION_FILLED_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.CAUTION_FILLED_5_5 instead.

SHIP_FILLED_5_5

@Deprecated
public static final int SHIP_FILLED_5_5

Deprecated. Use SoMarkerSet.MarkerTypes.SHIP_FILLED_5_5 instead.

CROSS_7_7

@Deprecated
public static final int CROSS_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.CROSS_7_7 instead.

PLUS_7_7

@Deprecated
public static final int PLUS_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.PLUS_7_7 instead.

MINUS_7_7

@Deprecated
public static final int MINUS_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.MINUS_7_7 instead.

SLASH_7_7

@Deprecated
public static final int SLASH_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.SLASH_7_7 instead.

BACKSLASH_7_7

@Deprecated
public static final int BACKSLASH_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.BACKSLASH_7_7 instead.

BAR_7_7

@Deprecated
public static final int BAR_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.BAR_7_7 instead.

STAR_7_7

@Deprecated
public static final int STAR_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.STAR_7_7 instead.

Y_7_7

@Deprecated
public static final int Y_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.Y_7_7 instead.

LIGHTNING_7_7

@Deprecated
public static final int LIGHTNING_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.LIGHTNING_7_7 instead.

WELL_7_7

@Deprecated
public static final int WELL_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.WELL_7_7 instead.

CIRCLE_LINE_7_7

@Deprecated
public static final int CIRCLE_LINE_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.CIRCLE_LINE_7_7 instead.

SQUARE_LINE_7_7

@Deprecated
public static final int SQUARE_LINE_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.SQUARE_LINE_7_7 instead.

DIAMOND_LINE_7_7

@Deprecated
public static final int DIAMOND_LINE_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.DIAMOND_LINE_7_7 instead.

TRIANGLE_LINE_7_7

@Deprecated
public static final int TRIANGLE_LINE_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.TRIANGLE_LINE_7_7 instead.

RHOMBUS_LINE_7_7

@Deprecated
public static final int RHOMBUS_LINE_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.RHOMBUS_LINE_7_7 instead.

HOURGLASS_LINE_7_7

@Deprecated
public static final int HOURGLASS_LINE_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.HOURGLASS_LINE_7_7 instead.

SATELLITE_LINE_7_7

@Deprecated
public static final int SATELLITE_LINE_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.SATELLITE_LINE_7_7 instead.

PINE_TREE_LINE_7_7

@Deprecated
public static final int PINE_TREE_LINE_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.PINE_TREE_LINE_7_7 instead.

CAUTION_LINE_7_7

@Deprecated
public static final int CAUTION_LINE_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.CAUTION_LINE_7_7 instead.

SHIP_LINE_7_7

@Deprecated
public static final int SHIP_LINE_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.SHIP_LINE_7_7 instead.

CIRCLE_FILLED_7_7

@Deprecated
public static final int CIRCLE_FILLED_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.CIRCLE_FILLED_7_7 instead.

SQUARE_FILLED_7_7

@Deprecated
public static final int SQUARE_FILLED_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.SQUARE_FILLED_7_7 instead.

DIAMOND_FILLED_7_7

@Deprecated
public static final int DIAMOND_FILLED_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.DIAMOND_FILLED_7_7 instead.

TRIANGLE_FILLED_7_7

@Deprecated
public static final int TRIANGLE_FILLED_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.TRIANGLE_FILLED_7_7 instead.

RHOMBUS_FILLED_7_7

@Deprecated
public static final int RHOMBUS_FILLED_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.RHOMBUS_FILLED_7_7 instead.

HOURGLASS_FILLED_7_7

@Deprecated
public static final int HOURGLASS_FILLED_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.HOURGLASS_FILLED_7_7 instead.

SATELLITE_FILLED_7_7

@Deprecated
public static final int SATELLITE_FILLED_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.SATELLITE_FILLED_7_7 instead.

PINE_TREE_FILLED_7_7

@Deprecated
public static final int PINE_TREE_FILLED_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.PINE_TREE_FILLED_7_7 instead.

CAUTION_FILLED_7_7

@Deprecated
public static final int CAUTION_FILLED_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.CAUTION_FILLED_7_7 instead.

SHIP_FILLED_7_7

@Deprecated
public static final int SHIP_FILLED_7_7

Deprecated. Use SoMarkerSet.MarkerTypes.SHIP_FILLED_7_7 instead.

CROSS_9_9

@Deprecated
public static final int CROSS_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.CROSS_9_9 instead.

PLUS_9_9

@Deprecated
public static final int PLUS_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.PLUS_9_9 instead.

MINUS_9_9

@Deprecated
public static final int MINUS_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.MINUS_9_9 instead.

SLASH_9_9

@Deprecated
public static final int SLASH_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.SLASH_9_9 instead.

BACKSLASH_9_9

@Deprecated
public static final int BACKSLASH_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.BACKSLASH_9_9 instead.

BAR_9_9

@Deprecated
public static final int BAR_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.BAR_9_9 instead.

STAR_9_9

@Deprecated
public static final int STAR_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.STAR_9_9 instead.

Y_9_9

@Deprecated
public static final int Y_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.Y_9_9 instead.

LIGHTNING_9_9

@Deprecated
public static final int LIGHTNING_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.LIGHTNING_9_9 instead.

WELL_9_9

@Deprecated
public static final int WELL_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.WELL_9_9 instead.

CIRCLE_LINE_9_9

@Deprecated
public static final int CIRCLE_LINE_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.CIRCLE_LINE_9_9 instead.

SQUARE_LINE_9_9

@Deprecated
public static final int SQUARE_LINE_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.SQUARE_LINE_9_9 instead.

DIAMOND_LINE_9_9

@Deprecated
public static final int DIAMOND_LINE_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.DIAMOND_LINE_9_9 instead.

TRIANGLE_LINE_9_9

@Deprecated
public static final int TRIANGLE_LINE_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.TRIANGLE_LINE_9_9 instead.

RHOMBUS_LINE_9_9

@Deprecated
public static final int RHOMBUS_LINE_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.RHOMBUS_LINE_9_9 instead.

HOURGLASS_LINE_9_9

@Deprecated
public static final int HOURGLASS_LINE_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.HOURGLASS_LINE_9_9 instead.

SATELLITE_LINE_9_9

@Deprecated
public static final int SATELLITE_LINE_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.SATELLITE_LINE_9_9 instead.

PINE_TREE_LINE_9_9

@Deprecated
public static final int PINE_TREE_LINE_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.PINE_TREE_LINE_9_9 instead.

CAUTION_LINE_9_9

@Deprecated
public static final int CAUTION_LINE_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.CAUTION_LINE_9_9 instead.

SHIP_LINE_9_9

@Deprecated
public static final int SHIP_LINE_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.SHIP_LINE_9_9 instead.

CIRCLE_FILLED_9_9

@Deprecated
public static final int CIRCLE_FILLED_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.CIRCLE_FILLED_9_9 instead.

SQUARE_FILLED_9_9

@Deprecated
public static final int SQUARE_FILLED_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.SQUARE_FILLED_9_9 instead.

DIAMOND_FILLED_9_9

@Deprecated
public static final int DIAMOND_FILLED_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.DIAMOND_FILLED_9_9 instead.

TRIANGLE_FILLED_9_9

@Deprecated
public static final int TRIANGLE_FILLED_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.TRIANGLE_FILLED_9_9 instead.

RHOMBUS_FILLED_9_9

@Deprecated
public static final int RHOMBUS_FILLED_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.RHOMBUS_FILLED_9_9 instead.

HOURGLASS_FILLED_9_9

@Deprecated
public static final int HOURGLASS_FILLED_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.HOURGLASS_FILLED_9_9 instead.

SATELLITE_FILLED_9_9

@Deprecated
public static final int SATELLITE_FILLED_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.SATELLITE_FILLED_9_9 instead.

PINE_TREE_FILLED_9_9

@Deprecated
public static final int PINE_TREE_FILLED_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.PINE_TREE_FILLED_9_9 instead.

CAUTION_FILLED_9_9

@Deprecated
public static final int CAUTION_FILLED_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.CAUTION_FILLED_9_9 instead.

SHIP_FILLED_9_9

@Deprecated
public static final int SHIP_FILLED_9_9

Deprecated. Use SoMarkerSet.MarkerTypes.SHIP_FILLED_9_9 instead.

markerIndex

public final SoMFInt32 markerIndex

Specifies the marker index (type of marker) for each marker. Default is 0. Predefined markers are in enum 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:

 MarkerSet {
   markerIndex DIAMOND_FILLED_9_9
 }

You must write:

 MarkerSet {
   markerIndex 82
 }

markerScale

public final SoMFFloat markerScale

Specifies the scale factor applied to each marker. Default is 1. You can specify fewer scale values than the number of markers to be drawn. In this case the "missing" values are looped from the first scale value each necessary time. You can also specify a scale factor to be applied to every marker in the set using the field markerGlobalScale.

Supported only when using shader implementation (this is the default).

Since:

Open Inventor 9.3

markerGlobalScale

public final SoSFFloat markerGlobalScale

Specifies a global scale factor applied to all markers. Default is 1. This scale factor is applied in addition to the individual scale factors (if any) specified in the markerScale field.

Supported only when using shader implementation (this is the default).

Since:

Open Inventor 9.3

Constructor Detail

SoMarkerSet

public SoMarkerSet()

Constructor.

Method Detail

addMarker

public static void addMarker(int markerIndex,
                             SbVec2s size,
                             byte[] bytes,
                             boolean isLSBFirst)

Calls addMarker(markerIndex, size, bytes, isLSBFirst, true).

addMarker

public static void addMarker(int markerIndex,
                             SbVec2s size,
                             byte[] bytes)

Calls addMarker(markerIndex, size, bytes, true, true).

addMarker

public static void addMarker(int markerIndex,
                             SbVec2s size,
                             byte[] bytes,
                             int[] orderedRGBA,
                             boolean isLSBFirst)

Calls addMarker(markerIndex, size, bytes, orderedRGBA, isLSBFirst, true).

addMarker

public static void addMarker(int markerIndex,
                             SbVec2s size,
                             byte[] bytes,
                             int[] orderedRGBA)

Calls addMarker(markerIndex, size, bytes, orderedRGBA, true, true).

getNumDefinedMarkers

public static int getNumDefinedMarkers()

Return the number of defined markers.

removeMarker

public static boolean removeMarker(int markerIndex)

Remove the marker with index markerIndex . Returns true if the marker was successfully removed, false otherwise.

getMarker

public static SoMarker getMarker(int markerIndex)

Retrieve the definition of the marker with index markerIndex . Returns NULL if the marker does not exist.

addMarker

public static void addMarker(int markerIndex,
                             SbVec2s size,
                             byte[] bytes,
                             boolean isLSBFirst,
                             boolean isUpToDown)

Add a new marker with index markerIndex . If the marker exists, it is replaced. size is the size of the marker in pixels. bytes is the marker bitmap. The bitmap is arranged row by row from left to right and top to bottom (according to the parameter isUpToDown ). Each byte in the bitmap corresponds to eight pixels. Open Inventor makes a copy of the bitmap.

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

addMarker

public static void addMarker(int markerIndex,
                             SbVec2s size,
                             byte[] bytes,
                             int[] orderedRGBA,
                             boolean isLSBFirst,
                             boolean isUpToDown)

Add a new colored marker with index markerIndex . If the marker exists, it is replaced. size is the size of the marker in pixels. bytes is the marker bitmap. orderedRGBA is an array of per-pixel color values to apply to the marker. The bitmap is arranged row by row from left to right and top to bottom (according to the parameter isUpToDown ). Each byte in the bitmap corresponds to eight pixels. Each value in orderedRGBA corresponds to one pixel. Open Inventor makes a copy of the bitmap and color values.

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

addMarker

public static void addMarker(int markerIndex,
                             SoMarker marker)

Add a new marker with index markerIndex using an existing marker definition. If the marker exists, it is replaced.