Class SoBoxHighlightRenderAction
- java.lang.Object
-
- com.openinventor.inventor.Inventor
-
- com.openinventor.inventor.actions.SoAction
-
- com.openinventor.inventor.actions.SoGLRenderAction
-
- com.openinventor.inventor.actions.SoHighlightRenderAction
-
- com.openinventor.inventor.actions.SoBoxHighlightRenderAction
-
public class SoBoxHighlightRenderAction extends SoHighlightRenderAction
A box highlight style.SoBoxHighlightRenderAction
is a render action which renders the specified scene graph, then renders wireframe boxes surrounding each selected object. If anSoGetBoundingBoxAction
applied to a selected object produces an empty bounding box, no highlight is rendered for that object.Selected objects are specified by the first selection node (
SoSelection
orSoExtSelection
) node in the scene to which this action is applied. If there is no selection node in the scene graph, then no objects will be highlighted.The application must explicitly tell Open Inventor to use a highlight render action in place of the default
SoGLRenderAction
in theSoSceneManager
class using the setGLRenderAction() method. The viewer classes provide a convenience setGLRenderAction() method that callsSoSceneManager
(see e.g.SoWinRenderArea
).For convenience, the viewer classes also provide the redrawOnSelectionChange() method. This method attaches a sensor to the specified selection node and automatically schedules a redraw if the set of selected objects is modified.
Other highlight effects are available including "halo" highlighting.
EXAMPLE Here is an example of how a box highlight can be specified for a particular selection node and viewer:
// Viewer ViewerExaminer viewer = new ViewerExaminer(); // Set the highlight render action final RenderArea area = viewer.getRenderArea(); area.setGLRenderAction( new SoBoxHighlightRenderAction() ); // Scene graph SoSelection selectionNode = new SoSelection(); // Request automatic redraw when selection changes selectionNode.addChangeCallback(new SoSelectionClassCB() { public void invoke(SoSelection s) { area.scheduleRedraw(); } }); . . . viewer.setSceneGraph( selectionNode ); - See Also:
SoLineHighlightRenderAction
,SoColorHighlightRenderAction
,SoHaloHighlightRenderAction
,SoHighlightRenderAction
,SoGLRenderAction
,SoSelection
,SoWinRenderArea
-
-
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.Inventor
VERBOSE_LEVEL, ZeroHandle
-
-
Constructor Summary
Constructors Constructor Description SoBoxHighlightRenderAction()
Constructor.SoBoxHighlightRenderAction(SbViewportRegion viewportRegion)
Constructor which takes the normalSoGLRenderAction
parameters.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.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.-
Methods inherited from class com.openinventor.inventor.actions.SoHighlightRenderAction
isVisible, setVisible
-
Methods inherited from class com.openinventor.inventor.actions.SoGLRenderAction
abortNow, enableDepthPeeling3D, generateCacheContext, getCache, getCacheContext, getCurPass, getDecimationPercentage, getDecimationType, getDelayedObjDepthWrite, getDepthPeelingPass, getFastEditSavePolicy, getFrameCounter, getInvalidateCacheMode, getLogicalViewportRegion, getNumPasses, getRenderingIsRemote, getSortedLayersNumPasses, getTransparencyType, getUpdateArea, getViewportRegion, handleTransparency, handleTransparency, handleTransparency, isAlphaTest, isDoingDepthPeeling, isPassUpdate, isSmoothing, isSortedLayersSupported, isSortedLayersSupported, isUsedCacheContext, resetFrameCounter, resetFrameCounter, setAlphaTest, setCache, setCacheContext, setDecimationValue, setDecimationValue, setDelayedObjDepthWrite, setFastEditSavePolicy, setFastEditSavePolicy, setInvalidateCacheMode, setLogicalViewportRegion, setNumPasses, setPassCallback, setPassCallback, setPassUpdate, setRenderingIsRemote, setSmoothing, setSortedLayersNumPasses, setTransparencyType, setUpdateArea, setViewportRegion, shouldAutoCache
-
Methods inherited from class com.openinventor.inventor.actions.SoAction
apply, apply, clearApplyResult, forwardTraversal, forwardTraversal, getContinueActionInBranchFlag, getCurPath, getDistribMode, getNodeAppliedTo, getOriginalPathListAppliedTo, getPathAppliedTo, getPathCode, getPathListAppliedTo, getPipeId, getSceneManager, getState, getWhatAppliedTo, hasTerminated, invalidateState, isBeingApplied, isLastPathListAppliedTo, isUsingAlternateRep, nullAction, postDelayedTraversal, preDelayedTraversal, resetContinueActionInBranchFlag, setPipeId, setSceneManager, setUpState, stopActionInBranch, traverse, useAlternateRep
-
Methods inherited from class com.openinventor.inventor.Inventor
dispose, getNativeResourceHandle
-
-
-
-
Constructor Detail
-
SoBoxHighlightRenderAction
public SoBoxHighlightRenderAction(SbViewportRegion viewportRegion)
Constructor which takes the normalSoGLRenderAction
parameters.
-
SoBoxHighlightRenderAction
public SoBoxHighlightRenderAction()
Constructor.
-
-
Method Detail
-
getLineWidth
public float getLineWidth()
Gets the line width of the highlight.
-
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.
-
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.
-
enableElement
public static void enableElement(java.lang.Class<? extends Inventor> t, int stkIndex)
-
getLinePattern
public short getLinePattern()
Gets the line pattern of the highlight.
-
getColor
public SbColor getColor()
Gets the color 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. SeeSoDrawStyle
for a description. Application is responsible for forcing a redraw of the scene to see the effects of this change.
-
-