Click or drag to resize
ScRayPickAction Class

Defines a distributed ray pick action.

Inheritance Hierarchy

Namespace: OIV.ScaleViz.Actions
Assembly: OIV.ScaleViz (in OIV.ScaleViz.dll) Version: 9.9.13.0 (9.9.13.0)
Syntax
public class ScRayPickAction : SoRayPickAction

The ScRayPickAction type exposes the following members.

Methods
  NameDescription
Public methodAddIntersection

Adds an SoPickedPoint instance representing the given object space point to the current list and returns it.

(Inherited from SoRayPickAction.)
Public methodApply(SoNode)

Applies action to the graph rooted by a node.

(Overrides SoActionApply(SoNode).)
Public methodApply(SoPath)

Initiates an action on the graph defined by a path.

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

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

(Inherited from SoAction.)
Public methodClearApplyResult

Clears the picked point list.

(Inherited from SoRayPickAction.)
Public methodClearPickedPointList Obsolete.

Clears the picked point list.

(Inherited from SoRayPickAction.)
Public methodComputeWorldSpaceRay
(Inherited from SoRayPickAction.)
Public methodEnableConicPickVolume

Controls the pick volume shape for picking with setRay().

(Inherited from SoRayPickAction.)
Public methodEnableCulling
(Inherited from SoPickAction.)
Public methodStatic memberEnableElement
Public methodEnableElements

(Overrides SoRayPickActionEnableElements.)
Public methodEnableNormalsGeneration

Enables generation of normal vectors for picked points.

(Inherited from SoRayPickAction.)
Public methodEnableRadiusForTriangles

Enable radius for triangle-based shape.

(Inherited from SoRayPickAction.)
Public methodEnableTexCoordsGeneration

Enables generation of texture coordinates for picked points.

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

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

(Inherited from SoAction.)
Public methodGetContinueActionInBranchFlag

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

(Inherited from SoAction.)
Public methodGetCurPath
(Inherited from SoAction.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetLine
(Inherited from SoRayPickAction.)
Public methodGetNodeAppliedTo
(Inherited from SoAction.)
Public methodGetNormalizedPoint

Gets the viewport point in normalized coordinates 0..1.

(Inherited from SoRayPickAction.)
Public methodGetOriginalPathListAppliedTo
(Inherited from SoAction.)
Public methodGetPathAppliedTo
(Inherited from SoAction.)
Public methodGetPathCode(SbNativeArrayInt32)

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 methodGetPathCode(SbNativeInt32Array) Obsolete.

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
(Inherited from SoAction.)
Public methodGetPickedPoint
Calls GetPickedPoint(System.Int32(0)).
(Inherited from SoRayPickAction.)
Public methodGetPickedPoint(Int32)

Returns the indexed picked point from the list.

(Inherited from SoRayPickAction.)
Public methodGetPickedPointList

Returns list of picked points.

(Inherited from SoRayPickAction.)
Public methodGetPickedPointsListLength
(Inherited from SoRayPickAction.)
Public methodGetPickingMode

Returns the PickingMode used for the ray pick action.

(Inherited from SoRayPickAction.)
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 methodGetPoint

Gets the viewport point in pixels (returns the last value passed to setPoint).

(Inherited from SoRayPickAction.)
Public methodGetPointFloat

Float version of getPoint().

(Inherited from SoRayPickAction.)
Public methodGetppNormal

Returns the picked point normal.

Public methodGetppPath

Returns the picked point path.

Public methodGetppPoint

Returns the picked point.

Public methodGetRadius

Gets the radius (in pixels) around the point.

(Inherited from SoRayPickAction.)
Public methodGetSceneManager

Return the SoSceneManager associated with this action.

(Inherited from SoAction.)
Public methodGetState
(Inherited from SoAction.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUnsortedPickedPoint
(Inherited from SoRayPickAction.)
Public methodGetViewportRegion

Returns current viewport region to use for action.

(Inherited from SoPickAction.)
Public methodGetViewVolume
(Inherited from SoRayPickAction.)
Public methodGetWhatAppliedTo
(Inherited from SoAction.)
Public methodHasTerminated
(Inherited from SoAction.)
Public methodHasWorldSpaceRay
(Inherited from SoRayPickAction.)
Public methodInitSetRayData(SbVec3f, SbVec3f, Single) Obsolete.
Calls InitSetRayData(start, direction, fovy, 1.0f, -1.0f, -1.0f).
(Inherited from SoRayPickAction.)
Public methodInitSetRayData(SbVec3f, SbVec3f, Single, Single) Obsolete.
Calls InitSetRayData(start, direction, fovy, aspectRatio, -1.0f, -1.0f).
(Inherited from SoRayPickAction.)
Public methodInitSetRayData(SbVec3f, SbVec3f, Single, Single, Single) Obsolete.
Calls InitSetRayData(start, direction, fovy, aspectRatio, nearDistance, -1.0f).
(Inherited from SoRayPickAction.)
Public methodIntersect(SbBox3f)
Calls Intersect(box, true).
(Inherited from SoRayPickAction.)
Public methodIntersect(SbVec3f)
(Inherited from SoRayPickAction.)
Public methodIntersect(SbXfBox3f)
Calls Intersect(box, true).
(Inherited from SoRayPickAction.)
Public methodIntersect(SbBox3f, Boolean)

Bounding box: just return whether the ray intersects it.

(Inherited from SoRayPickAction.)
Public methodIntersect(SbXfBox3f, Boolean)

Bounding box: just return whether the ray intersects it.

(Inherited from SoRayPickAction.)
Public methodIntersect(SbVec3f, SbVec3f, SbVec3f)
(Inherited from SoRayPickAction.)
Public methodIntersect(SbVec3f, SbVec3f, SbVec3f, SbVec3f, SbVec3f, Boolean)
(Inherited from SoRayPickAction.)
Public methodInvalidateState

Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied.

(Inherited from SoAction.)
Public methodIsBeingApplied

Returns true if this action is currently being applied.

(Inherited from SoAction.)
Public methodIsBetweenPlanes
(Inherited from SoRayPickAction.)
Public methodIsConicPickVolume

Returns true if the picking volume is a conic shape (not a frustum).

(Inherited from SoRayPickAction.)
Public methodIsCullingEnabled
(Inherited from SoPickAction.)
Public methodIsLastPathListAppliedTo
(Inherited from SoAction.)
Public methodIsNormalsGenerationEnabled

Returns whether generation of normal vectors is enabled for picked points.

(Inherited from SoRayPickAction.)
Public methodIsPickAll

Returns whether the action will return all objects intersected or just the closest one.

(Inherited from SoRayPickAction.)
Public methodIsRadiusEnableForTriangles

Returns whether the pick radius specified by setRadius is taken into account for picking on triangle-based shapes.

(Inherited from SoRayPickAction.)
Public methodIsTexCoordsGenerationEnabled

Returns whether texture coordinate generation is enabled for picked points.

(Inherited from SoRayPickAction.)
Public methodIsUsingAlternateRep

Returns true if current action is using alternate representations.

(Inherited from SoAction.)
Public methodIsValidPp

Returns 0 if nothing has been picked.

Public methodPostDelayedTraversal

Method called by SoMultiPassManager after delayed pass traversals.

(Inherited from SoAction.)
Public methodPreDelayedTraversal

Method called by SoMultiPassManager before delayed pass traversals.

(Inherited from SoAction.)
Public methodResetContinueActionInBranchFlag

This function resets the continue action flag.

(Inherited from SoAction.)
Public methodSetNormalizedPoint

Sets the viewport point in normalized coordinates, which range from (0,0) at the lower left to (1,1) at the upper right.

Public methodSetObjectSpace
(Inherited from SoRayPickAction.)
Public methodSetObjectSpace(SbMatrix)
(Inherited from SoRayPickAction.)
Public methodSetPickAll

Sets whether the action will return all objects intersected or just the closest one.

(Inherited from SoRayPickAction.)
Public methodSetPickingMode

Sets the picking mode.

(Inherited from SoRayPickAction.)
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 methodSetPoint(SbVec2f)

Float version of setPoint().

Public methodSetPoint(SbVec2s)

Sets the viewport-space point through which the ray passes, starting at the camera's viewpoint.

Public methodSetRadius

Sets the radius around the point.

(Inherited from SoRayPickAction.)
Public methodSetRay(SbVec3f, SbVec3f)
Calls SetRay(rayStart, rayDirection, -1, -1).
Public methodSetRay(Single, SbVec3f, SbVec3f)
Calls SetRay(fovy, rayStart, rayDirection, -1, -1).
Public methodSetRay(SbVec3f, SbVec3f, Single)
Calls SetRay(rayStart, rayDirection, nearDistance, -1).
Public methodSetRay(Single, SbVec3f, SbVec3f, Single)
Calls SetRay(fovy, rayStart, rayDirection, nearDistance, -1).
Public methodSetRay(SbVec3f, SbVec3f, Single, Single)

Sets a world-space ray along which to pick.

Public methodSetRay(Single, SbVec3f, SbVec3f, Single, Single)

Sets a world-space ray along which to pick in the the same way as function defined above, but allows you to set a view angle value.

Public methodSetRayCommonProperties(SbVec3f, SbVec3f, Single) Obsolete.
Calls SetRayCommonProperties(start, direction, fovy, 1.0f, -1.0f, -1.0f).
(Inherited from SoRayPickAction.)
Public methodSetRayCommonProperties(SbVec3f, SbVec3f, Single, Single) Obsolete.
Calls SetRayCommonProperties(start, direction, fovy, aspectRatio, -1.0f, -1.0f).
(Inherited from SoRayPickAction.)
Public methodSetRayCommonProperties(SbVec3f, SbVec3f, Single, Single, Single) Obsolete.
Calls SetRayCommonProperties(start, direction, fovy, aspectRatio, nearDistance, -1.0f).
(Inherited from SoRayPickAction.)
Public methodSetSceneManager

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

(Inherited from SoAction.)
Public methodSetUpState
(Inherited from SoAction.)
Public methodSetViewportRegion

Sets current viewport region to use for action.

(Inherited from SoPickAction.)
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
(Inherited from SoAction.)
Public methodUseAlternateRep

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

(Inherited from SoAction.)
Top
Remarks

The ScRayPickAction class provides a simple way to distribute an SoRayPickAction across a cluster.

Several distribution modes are available:

  • LOCAL_ONLY: action is only applied by the application.

  • CLUSTER_ONLY: action is only applied by the OIRUs.

  • ALL: both application and OIRUs apply the given action.

When OIRUs are involved (i.e., in CLUSTER_ONLY and ALL modes), they apply the action on their own part of the scene graph. The application gets back the result via the callback defined by the user.

This class can be used in all compositing modes (flat, tile, depth, and local compositing).

See Also