com.openinventor.inventor.actions

Class SoLineHighlightRenderAction

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.actions.SoAction

com.openinventor.inventor.actions.SoGLRenderAction

com.openinventor.inventor.actions.SoLineHighlightRenderAction

public class SoLineHighlightRenderAction
extends SoGLRenderAction

Selection highlight style. SoLineHighlightRenderAction is a render action which renders the specified scene graph, then renders each selected object again in wireframe. Selected objects are specified by the first SoSelection node in the scene to which this action is applied. If there is no renderable geometry in a selected object, no highlight is rendered for that object. A highlight render action can be passed to the setGLRenderAction() method of SoWinRenderArea to have an effect on scene graphs.

EXAMPLE

Here is an example of how a line highlight can be specified for a particular selection node and render area.

SoWinRenderArea *myRenderArea;

SoSelection *mySelection;

// Set the highlight render action

myRenderArea->setGLRenderAction(

new SoLineHighlightRenderAction());

// Automatic redraw on selection changes

myRenderArea->redrawOnSelectionChange(mySelection);

See also:

SoBoxHighlightRenderAction, SoGLRenderAction, SoSelection, SoWinRenderArea, SoDrawStyle, SoInteraction

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.actions.SoGLRenderAction

SoGLRenderAction.AbortCodes, SoGLRenderAction.AutoCacheModes, SoGLRenderAction.FastEditSavePolicies, SoGLRenderAction.InvalidateCacheModes, SoGLRenderAction.TransparencyTypes

Nested classes/interfaces inherited from class com.openinventor.inventor.actions.SoAction

SoAction.AppliedCodes, SoAction.DistribModes, SoAction.PathCodes, SoAction.PathIndices

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

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.actions.SoGLRenderAction

ABORT, ADD, ALWAYS, BLEND, CONTINUE, DELAY, DELAYED_ADD, DELAYED_BLEND, DELAYED_SORTED_LAYERS_BLEND, DELAYED_SORTED_PIXELS_BLEND, DISABLE, DO_AUTO_CACHE, DONT_AUTO_CACHE, EACH_FRAME, NO_TRANSPARENCY, OFF, ONCE, PRUNE, SCREEN_DOOR, SORTED_LAYERS_BLEND, SORTED_OBJECT_ADD, SORTED_OBJECT_BLEND, SORTED_OBJECT_TRIANGLES_ADD, SORTED_OBJECT_TRIANGLES_BLEND, SORTED_PIXELS_BLEND, SORTED_TRIANGLES_ADD, SORTED_TRIANGLES_BLEND, WHEN_NEEDED

Fields inherited from class com.openinventor.inventor.actions.SoAction

ALL, BELOW_PATH, CLUSTER_ONLY, IN_PATH, LOCAL_ONLY, NO_PATH, NODE, OFF_PATH, PATH, PATH_LIST

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoLineHighlightRenderAction() Constructor.
SoLineHighlightRenderAction(SbViewportRegion viewportRegion) Constructor which takes the normal SoGLRenderAction parameters.

Method Summary

Modifier and Type	Method and Description
static void	enableElement(java.lang.Class<? extends Inventor> t, int stkIndex)
SbColor	getColor() Gets the color of the highlight.
short	getLinePattern() Gets the line pattern of the highlight.
float	getLineWidth() Gets the line width of the highlight.
float	getPointSize() Gets the point size of the highlight.
boolean	isVisible() Returns whether highlights will be rendered or not.
void	setColor(SbColor c) Sets the color of the highlight.
void	setLinePattern(short pattern) Sets the line pattern of the highlight.
void	setLineWidth(float width) Sets the line width of the highlight.
void	setPointSize(float size) Sets the size of points (diameter in pixels) rendered by the highlight.
void	setVisible(boolean b) This provides a convenient mechanism for turning highlights off or back on.

Methods inherited from class com.openinventor.inventor.actions.SoGLRenderAction

abortNow, enableDepthPeeling3D, generateCacheContext, getCacheContext, getCurPass, getDecimationPercentage, getDecimationType, getDelayedObjDepthWrite, getDepthPeelingPass, getFastEditSavePolicy, getFrameCounter, getInvalidateCacheMode, getLogicalViewportRegion, getNumPasses, getRenderingIsRemote, getSortedLayersNumPasses, getSortedTrianglesNumCaches, getSortedTrianglesSortFrequency, getSynchronizer, getTransparencyType, getUpdateArea, getViewportRegion, handleTransparency, handleTransparency, handleTransparency, howToRenderScene, isAlphaTest, isDoingDepthPeeling, isPassUpdate, isSmoothing, isSortedLayersSupported, isSortedLayersSupported, isUsedCacheContext, postDelayedTraversal, preDelayedTraversal, resetFrameCounter, resetFrameCounter, setAlphaTest, setCacheContext, setDecimationValue, setDecimationValue, setDelayedObjDepthWrite, setFastEditSavePolicy, setFastEditSavePolicy, setInvalidateCacheMode, setLogicalViewportRegion, setNumPasses, setPassCallback, setPassCallback, setPassUpdate, setRenderingIsRemote, setSmoothing, setSortedLayersNumPasses, setSortedTrianglesNumCaches, setSortedTrianglesSortFrequency, setTransparencyType, setUpdateArea, setUpState, setViewportRegion, shouldAutoCache, updateTranspList

Methods inherited from class com.openinventor.inventor.actions.SoAction

apply, apply, clearApplyResult, forwardTraversal, getContinueActionInBranchFlag, getCurPath, getNodeAppliedTo, getOriginalPathListAppliedTo, getPathAppliedTo, getPathCode, getPathListAppliedTo, getPipeId, getSceneManager, getState, getWhatAppliedTo, hasTerminated, invalidateState, isBeingApplied, isLastPathListAppliedTo, isUsingAlternateRep, nullAction, resetContinueActionInBranchFlag, setPipeId, setSceneManager, stopActionInBranch, traverse, useAlternateRep

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Constructor Detail

SoLineHighlightRenderAction

public SoLineHighlightRenderAction()

Constructor.

SoLineHighlightRenderAction

public SoLineHighlightRenderAction(SbViewportRegion viewportRegion)

Constructor which takes the normal SoGLRenderAction parameters.

Method Detail

getLinePattern

public short getLinePattern()

Gets the line pattern of the highlight.

setLineWidth

public void setLineWidth(float width)

Sets the line width of the highlight. Default is 3. The application is responsible for forcing a redraw of the scene to see the effects of this change.

setVisible

public void setVisible(boolean b)

This provides a convenient mechanism for turning highlights off or back on. When false is passed, subsequent calls to apply() render the scene graph without rendering highlights. The application is responsible for forcing a redraw of the scene after changing this state. The default visibility is on.

isVisible

public boolean isVisible()

Returns whether highlights will be rendered or not.

getColor

public SbColor getColor()

Gets the color of the highlight.

setColor

public void setColor(SbColor c)

Sets the color of the highlight. Default is red (1,0,0). The application is responsible for forcing a redraw of the scene to see the effects of this change.

setLinePattern

public void setLinePattern(short pattern)

Sets the line pattern of the highlight. Default is solid, 0xffff. The pattern of bits in the passed variable specifies the pattern of the line. See SoDrawStyle for more information. The application is responsible for forcing a redraw of the scene to see the effects of this change.

enableElement

public static void enableElement(java.lang.Class<? extends Inventor> t,
                                 int stkIndex)

getPointSize

public float getPointSize()

Gets the point size of the highlight.

getLineWidth

public float getLineWidth()

Gets the line width of the highlight.

setPointSize

public void setPointSize(float size)

Sets the size of points (diameter in pixels) rendered by the highlight. Default is 1. Value must be greater than zero. Only applies to point primitives, e.g. SoPointSet.