com.openinventor.inventor.actions

Class SoBoxHighlightRenderAction

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.actions.SoAction

com.openinventor.inventor.actions.SoGLRenderAction

com.openinventor.inventor.actions.SoBoxHighlightRenderAction

public class SoBoxHighlightRenderAction
extends SoGLRenderAction

A selection highlight style. SoBoxHighlightRenderAction is a render action which renders the specified scene graph, then renders wireframe boxes surrounding each selected object. Selected objects are specified by the first SoSelection node in the scene to which this action is applied. If an SoGetBoundingBoxAction applied to a selected object produces an empty bounding box, no highlight is rendered for that object. A highlight render action can be passed to the setGLRenderAction() method of render area and viewer classes to have an effect on scene graphs.

EXAMPLE

Here is an example of how a box highlight can be specified for a particular selection node and viewer:

 // Scene graph
 SoSelection selectionNode  = new SoSelection();
 . . .
 // Viewer
 SwSimpleViewer viewer = new SwSimpleViewer();
 viewer.setSceneGraph( selectionNode );
 
 // Set the highlight render action
 SwRenderArea area = viewer.getArea();
 area.setGLRenderAction( new SoBoxHighlightRenderAction() );
 
 // Request automatic redraw when selection changes
 area.redrawOnSelectionChange( selectionNode );

See also:

SoLineHighlightRenderAction, 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
SoBoxHighlightRenderAction() Constructor.
SoBoxHighlightRenderAction(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.
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	setVisible(boolean b) This provides a convenient mechanism for turning highlights off or 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

SoBoxHighlightRenderAction

public SoBoxHighlightRenderAction(SbViewportRegion viewportRegion)

Constructor which takes the normal SoGLRenderAction parameters.

SoBoxHighlightRenderAction

public SoBoxHighlightRenderAction()

Constructor.

Method Detail

setLineWidth

public void setLineWidth(float width)

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

setColor

public void setColor(SbColor c)

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

getLineWidth

public float getLineWidth()

Gets the line width of the highlight.

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 a description. Application is responsible for forcing a redraw of the scene to see the effects of this change.

getColor

public SbColor getColor()

Gets the color of the highlight.

setVisible

public void setVisible(boolean b)

This provides a convenient mechanism for turning highlights off or 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.

getLinePattern

public short getLinePattern()

Gets the line pattern of the highlight.

isVisible

public boolean isVisible()

Returns whether highlights will be rendered or not.

enableElement

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