Click or drag to resize
SoHaloHighlightRenderAction Class

A halo highlight style.

Inheritance Hierarchy

Namespace: OIV.Inventor.Actions
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.9.2.0 (10.9.2.0)
Syntax
public class SoHaloHighlightRenderAction : SoHighlightRenderAction

The SoHaloHighlightRenderAction type exposes the following members.

Constructors
  NameDescription
Public methodSoHaloHighlightRenderAction
Initializes a new instance of the SoHaloHighlightRenderAction class
Public methodSoHaloHighlightRenderAction(SbViewportRegion)
Initializes a new instance of the SoHaloHighlightRenderAction class
Top
Methods
  NameDescription
Public methodAbortNow
(Inherited from SoGLRenderAction.)
Public methodApply(SoNode)

This renders the passed scene graph, and also renders highlighted selected objects as specified by the first OIV.Inventor.Nodes.SoSelection node found in the scene graph.

(Inherited from SoHighlightRenderAction.)
Public methodApply(SoPath)

Initiates an action on the graph defined by a path.

(Inherited from SoGLRenderAction.)
Public methodApply(SoPathList)
Calls Apply(pathList, false).
(Inherited from SoGLRenderAction.)
Public methodApply(SoPathList, Boolean)

Initiates an action on the graph defined by a list of paths.

(Inherited from SoGLRenderAction.)
Public methodClearApplyResult

When applied, an action may reference nodes or create objects (e.g.

(Inherited from SoHighlightRenderAction.)
Public methodEnableDepthPeeling3D

Use 3D texturing instead of 2D for the fixed functionality emulation in depth peeling.

(Inherited from SoGLRenderAction.)
Public methodStatic memberEnableElement
Public methodEnableElements

(Overrides SoHighlightRenderActionEnableElements.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodForwardTraversal(SoNode)

Traverse a node that is not part of the current scenegraph.

(Inherited from SoAction.)
Public methodForwardTraversal(SoPath)

Traverse a path that is not part of the current scenegraph.

(Inherited from SoAction.)
Public methodGetCache (Inherited from SoGLRenderAction.)
Public methodGetCacheContext

Returns the OpenGL cache context id for this action.

(Inherited from SoGLRenderAction.)
Public methodGetContinueActionInBranchFlag

This function indicates if the action must stop in the current branch.

(Inherited from SoAction.)
Public methodGetCurPass
(Inherited from SoGLRenderAction.)
Public methodGetCurPath

Returns the path accumulated during traversal, i.e., the chain of nodes from the root of the traversed graph to the current node being traversed.

(Inherited from SoAction.)
Public methodGetDecimationPercentage

Gets decimation percentage, the value should be a number between 0.0 and 1.0.

(Inherited from SoGLRenderAction.)
Public methodGetDecimationType

Gets decimation type.

(Inherited from SoGLRenderAction.)
Public methodGetDelayedObjDepthWrite

Returns whether delayed transparent objects update the depth buffer.

(Inherited from SoGLRenderAction.)
Public methodGetDepthPeelingPass

Get the current pass of depth peeling, -1 if not doing depth peeling.

(Inherited from SoGLRenderAction.)
Public methodGetDistribMode

Returns the distribution mode of this action across a cluster (ScaleViz-Cluster only).

(Inherited from SoAction.)
Public methodGetFastEditSavePolicy

Returns fast editing save policy used when rendering.

(Inherited from SoGLRenderAction.)
Public methodGetFrameCounter

Returns the current frame counter.

(Inherited from SoGLRenderAction.)
Public methodGetHaloColor
Public methodGetHaloSmoothFactor
Public methodGetHaloWidth
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetInvalidateCacheMode

Returns the current cache invalidation mode.

(Inherited from SoGLRenderAction.)
Public methodGetLogicalViewportRegion

Returns current logical viewport region.

(Inherited from SoGLRenderAction.)
Public methodGetNodeAppliedTo

Returns the node the action is being applied to.

(Inherited from SoAction.)
Public methodGetNumPasses

Gets number of rendering passes for multipass rendering.

(Inherited from SoGLRenderAction.)
Public methodGetOriginalPathListAppliedTo

Returns the original path list the action is being applied to.

(Inherited from SoAction.)
Public methodGetPathAppliedTo

Returns the path the action is being applied to.

(Inherited from SoAction.)
Public methodGetPathCode

Returns path code based on where current node (the node at the end of the current path) lies with respect to the path(s) the action is being applied to.

(Inherited from SoAction.)
Public methodGetPathListAppliedTo

Returns the path list the action is being applied to.

(Inherited from SoAction.)
Public methodGetPipeId

Gets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.

(Inherited from SoAction.)
Public methodGetRenderingIsRemote

Returns true if remote rendering is being done.

(Inherited from SoGLRenderAction.)
Public methodGetSceneManager

Return the OIV.Inventor.SoSceneManager associated with this action.

(Inherited from SoAction.)
Public methodGetSortedLayersNumPasses

Returns the number of rendering passes used when transparency type is OIV.Inventor.Actions.SoGLRenderAction.TransparencyTypes.SORTED_PIXEL.

(Inherited from SoGLRenderAction.)
Public methodGetState

Gets the state from the action.

(Inherited from SoAction.)
Public methodGetTransparencyType

Returns transparency quality level to use when rendering.

(Inherited from SoGLRenderAction.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUpdateArea

Returns the current update area.

(Inherited from SoGLRenderAction.)
Public methodGetViewportRegion

Returns viewport region to use for rendering.

(Inherited from SoGLRenderAction.)
Public methodGetWhatAppliedTo

Returns code indicating what action is being applied to.

(Inherited from SoAction.)
Public methodHandleTransparency
Calls HandleTransparency(false, false).
(Inherited from SoGLRenderAction.)
Public methodHandleTransparency(Boolean)
Calls HandleTransparency(isTransparent, false).
(Inherited from SoGLRenderAction.)
Public methodHandleTransparency(Boolean, Boolean)
(Inherited from SoGLRenderAction.)
Public methodHasTerminated

Returns true if the traversal has reached a termination condition.

(Inherited from SoAction.)
Public methodInvalidateState

Invalidate the state, forcing it to be recreated at the next apply.

(Inherited from SoGLRenderAction.)
Public methodIsAlphaTest

Returns whether the OpenGL alpha test is enabled for rendering.

(Inherited from SoGLRenderAction.)
Public methodIsBeingApplied

Returns true if this action is currently being applied.

(Inherited from SoAction.)
Public methodIsDoingDepthPeeling

Return true if depth peeling is active.

(Inherited from SoGLRenderAction.)
Public methodIsHaloAlwaysVisible
Public methodIsLastPathListAppliedTo

Returns true if the current list is the last one from the original.

(Inherited from SoAction.)
Public methodIsPassUpdate

Returns a flag indicating whether intermediate results are displayed after each antialiasing pass for progressive improvement.

(Inherited from SoGLRenderAction.)
Public methodIsSmoothing

Returns smoothing flag.

(Inherited from SoGLRenderAction.)
Public methodIsUsingAlternateRep

Returns true if current action is using alternate representations.

(Inherited from SoAction.)
Public methodIsVisible

Returns whether highlights will be rendered or not.

(Inherited from SoHighlightRenderAction.)
Public methodPostDelayedTraversal

Method called by SoMultiPassManager after delayed pass traversals.

(Inherited from SoGLRenderAction.)
Public methodPreDelayedTraversal

Method called by SoMultiPassManager before delayed pass traversals.

(Inherited from SoGLRenderAction.)
Public methodResetContinueActionInBranchFlag

This function resets the continue action flag.

(Inherited from SoAction.)
Public methodResetFrameCounter
Calls ResetFrameCounter(System.UInt32(0)).
(Inherited from SoGLRenderAction.)
Public methodResetFrameCounter(UInt32)

Reset the frame counter.

(Inherited from SoGLRenderAction.)
Public methodSetAlphaTest

Enable or disable the OpenGL alpha test for rendering.

(Inherited from SoGLRenderAction.)
Public methodSetCache

Sets the main cache to use with this render action.

(Inherited from SoGLRenderAction.)
Public methodSetCacheContext

Sets the OpenGL cache context.

(Inherited from SoGLRenderAction.)
Public methodSetDecimationValue(SoDecimationTypeElementTypes)
Calls SetDecimationValue(type, 1.0).
(Inherited from SoGLRenderAction.)
Public methodSetDecimationValue(SoDecimationTypeElementTypes, Single)

Sets decimation percentage, the value should be a number between 0.0 and 1.0 Useful for reducing the number of triangles rendered in the scene.

(Inherited from SoGLRenderAction.)
Public methodSetDelayedObjDepthWrite

Control whether delayed transparent objects update the depth buffer.

(Inherited from SoGLRenderAction.)
Public methodSetFastEditSavePolicy(SoGLRenderActionFastEditSavePolicies)
Calls SetFastEditSavePolicy(policy, false).
(Inherited from SoGLRenderAction.)
Public methodSetFastEditSavePolicy(SoGLRenderActionFastEditSavePolicies, Boolean)

Sets fast editing save policy to use when rendering.

(Inherited from SoGLRenderAction.)
Public methodSetHaloAlwaysVisible

Defines whether or not the halo can be seen through objects that are placed in front of selected shapes.

Public methodSetHaloColor

Defines the color of the highlight.

Public methodSetHaloSmoothFactor

Defines the amount of alpha attenuation of the halo contour.

Public methodSetHaloWidth

Defines the width of the halo in pixels.

Public methodSetInvalidateCacheMode

Enables or disables the invalidation of render caches.

(Inherited from SoGLRenderAction.)
Public methodSetLogicalViewportRegion

Sets current logical viewport region to use for rendering.

(Inherited from SoGLRenderAction.)
Public methodSetNumPasses

Sets number of rendering passes for multipass antialiasing.

(Inherited from SoGLRenderAction.)
Public methodSetPassUpdate

Sets a flag indicating whether intermediate results are displayed after each antialiasing pass for progressive improvement (default is false).

(Inherited from SoGLRenderAction.)
Public methodSetPipeId

Sets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.

(Inherited from SoAction.)
Public methodSetRenderingIsRemote

Sets whether or not "remote" rendering is done.

(Inherited from SoGLRenderAction.)
Public methodSetSceneManager

Set the scene manager associated with this action (if any ).

(Inherited from SoAction.)
Public methodSetSmoothing

Sets smoothing flag.

(Inherited from SoGLRenderAction.)
Public methodSetSortedLayersNumPasses

Sets the number of rendering passes used when transparency type is OIV.Inventor.Actions.SoGLRenderAction.TransparencyTypes.SORTED_PIXEL.

(Inherited from SoGLRenderAction.)
Public methodSetTransparencyType

Sets global transparency algorithm to use when rendering.

(Inherited from SoGLRenderAction.)
Public methodSetUpdateArea

Sets the current update area, which is the rectangular area of the viewport region that will actually be rendered into.

(Inherited from SoGLRenderAction.)
Public methodSetUpState

initialize the action state.

(Inherited from SoGLRenderAction.)
Public methodSetViewportRegion

Changes viewport region to use for rendering.

(Inherited from SoGLRenderAction.)
Public methodSetVisible

This provides a convenient mechanism for turning highlights off or on.

(Inherited from SoHighlightRenderAction.)
Public methodShouldAutoCache

Called by nodes to say that they should/shouldn't be auto-cached (pass true if should, false if shouldn't, don't call this method at all if the node doesn't care):

(Inherited from SoGLRenderAction.)
Public methodStopActionInBranch

This function stops the action in the current Scene Graph branch.

(Inherited from SoAction.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTraverse

Does traversal of a graph rooted by a node.

(Inherited from SoAction.)
Public methodUseAlternateRep

Tell the action to use alternate representations during traversal when available.

(Inherited from SoAction.)
Top
Properties
  NameDescription
Public propertyAbortCallback

Sets callback to call during rendering to test for an abort condition.

(Inherited from SoGLRenderAction.)
Public propertyPassCallback

Sets a callback function to invoke between passes when antialiasing.

(Inherited from SoGLRenderAction.)
Top
Remarks

OIV.Inventor.Actions.SoHaloHighlightRenderAction is a render action which renders the specified scene graph, then renders a "halo" highlight around each selected object. See the images below for examples of this highlight technique. Halo highlighting works with all kinds of shapes including VolumeViz and MeshVizXLM. However, if a selected object does not write to the depth buffer for any reason, it will not be highlighted.

Selected objects are specified by the first selection node (OIV.Inventor.Nodes.SoSelection or OIV.Inventor.Nodes.SoExtSelection) 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 OIV.Inventor.Actions.SoGLRenderAction in the OIV.Inventor.SoSceneManager class using the setGLRenderAction() method. The viewer classes provide a convenience setGLRenderAction() method that calls OIV.Inventor.SoSceneManager (see e.g. OIV.Inventor.Win.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.

Here is an example of an OIV.Inventor.Nodes.SoAlgebraicCone highlighted with an OIV.Inventor.Actions.SoHaloHighlightRenderAction:

Here are parameters that can be adjusted:

NOTES

  • The rendering of the halo uses the depth buffer of the selected shapes as its boundary.

  • Increasing the halo width value decreases performance.

  • When multiple objects are selected, they are highlighted as one unique shape, i.e. the halo is done on the union of their depth buffer. This is illustrated on the following image:
    2 selected objects are highlighted as one

    EXAMPLE

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

    SoSelection selectionNode = new SoSelection();
    . . .
    SoWinExaminerViewer viewer = new SoWinExaminerViewer();
    viewer.SetSceneGraph( selectionNode );
    
    viewer.SetGLRenderAction( new SoHaloHighlightRenderAction() );
    
    viewer.RedrawOnSelectionChange( selectionNode );

See Also