com.openinventor.scaleviz.actions

Class ScRayPickAction

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.actions.SoAction

com.openinventor.inventor.actions.SoPickAction

com.openinventor.inventor.actions.SoRayPickAction

com.openinventor.scaleviz.actions.ScRayPickAction

public class ScRayPickAction
extends SoRayPickAction

Defines a distributed ray pick action. 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:

SoRayPickAction

Nested Class Summary

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

SoRayPickAction.PickingModes

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.SoRayPickAction

DEFAULT, POINT_PICKING

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

Method Summary

Modifier and Type	Method and Description
static void	enableElement(java.lang.Class<? extends Inventor> t, int stkIndex)
SbVec3f	getppNormal() Returns the picked point normal.
SoPath	getppPath() Returns the picked point path.
SbVec3f	getppPoint() Returns the picked point.
boolean	isValidPp() Returns 0 if nothing has been picked.
void	setNormalizedPoint(SbVec2f normPoint) Sets the viewport point in normalized coordinates, which range from (0,0) at the lower left to (1,1) at the upper right.
void	setPoint(SbVec2f viewportPoint) Float version of setPoint().
void	setPoint(SbVec2s viewportPoint) Sets the viewport-space point through which the ray passes, starting at the camera's viewpoint.
void	setRay(float fovy, SbVec3f rayStart, SbVec3f rayDirection) Calls setRay(fovy, rayStart, rayDirection, (float)-1, (float)-1).
void	setRay(float fovy, SbVec3f rayStart, SbVec3f rayDirection, float nearDistance) Calls setRay(fovy, rayStart, rayDirection, nearDistance, (float)-1).
void	setRay(float fovy, SbVec3f rayStart, SbVec3f rayDirection, float nearDistance, float farDistance) 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.
void	setRay(SbVec3f rayStart, SbVec3f rayDirection) Calls setRay(rayStart, rayDirection, (float)-1, (float)-1).
void	setRay(SbVec3f rayStart, SbVec3f rayDirection, float nearDistance) Calls setRay(rayStart, rayDirection, nearDistance, (float)-1).
void	setRay(SbVec3f rayStart, SbVec3f rayDirection, float nearDistance, float farDistance) Sets a world-space ray along which to pick.

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

addIntersection, clearPickedPointList, computeWorldSpaceRay, enableConicPickVolume, enableNormalsGeneration, enableRadiusForTriangles, enableTexCoordsGeneration, enableTriangleCulling, getLine, getNormalizedPoint, getPickedPoint, getPickedPoint, getPickedPointList, getPickedPointsListLength, getPickingMode, getPoint, getPointFloat, getRadius, getStereoMode, getUnsortedPickedPoint, getViewVolume, hasWorldSpaceRay, intersect, intersect, intersect, intersect, intersect, intersect, isBetweenPlanes, isConicPickVolume, isNormalsGenerationEnabled, isPickAll, isRadiusEnableForTriangles, isTexCoordsGenerationEnabled, isTriangleCulling, setObjectSpace, setObjectSpace, setPickAll, setPickingMode, setRadius, setStereoMode

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

enableCulling, getViewportRegion, isCullingEnabled, setViewportRegion

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, postDelayedTraversal, preDelayedTraversal, resetContinueActionInBranchFlag, setPipeId, setSceneManager, setUpState, 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

Method Detail

setRay

public void setRay(SbVec3f rayStart,
                   SbVec3f rayDirection)

Calls setRay(rayStart, rayDirection, (float)-1, (float)-1).

Overrides:

setRay in class SoRayPickAction

setRay

public void setRay(float fovy,
                   SbVec3f rayStart,
                   SbVec3f rayDirection)

Calls setRay(fovy, rayStart, rayDirection, (float)-1, (float)-1).

Overrides:

setRay in class SoRayPickAction

setRay

public void setRay(SbVec3f rayStart,
                   SbVec3f rayDirection,
                   float nearDistance)

Calls setRay(rayStart, rayDirection, nearDistance, (float)-1).

Overrides:

setRay in class SoRayPickAction

setRay

public void setRay(float fovy,
                   SbVec3f rayStart,
                   SbVec3f rayDirection,
                   float nearDistance)

Calls setRay(fovy, rayStart, rayDirection, nearDistance, (float)-1).

Overrides:

setRay in class SoRayPickAction

getppNormal

public SbVec3f getppNormal()

Returns the picked point normal.

setRay

public void setRay(float fovy,
                   SbVec3f rayStart,
                   SbVec3f rayDirection,
                   float nearDistance,
                   float farDistance)

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. Alternatively, you can use the setRay method above and then specify the view angle using the environment variable OIV_SET_RAY_PRECISION. See SoPreferences.

Overrides:

setRay in class SoRayPickAction

setPoint

public void setPoint(SbVec2s viewportPoint)

Sets the viewport-space point through which the ray passes, starting at the camera's viewpoint. Viewport coordinates range from (0,0) at the lower left to (width-1,height-1) at the upper right.

NOTE: You can use this method or the setNormalizedPoint / setRay methods. Whichever method you call last is the one that takes effect.

Overrides:

setPoint in class SoRayPickAction

setNormalizedPoint

public void setNormalizedPoint(SbVec2f normPoint)

Sets the viewport point in normalized coordinates, which range from (0,0) at the lower left to (1,1) at the upper right. NOTE: You can use this method or the setPoint / setRay methods. Whichever method you call last is the one that takes effect.

Overrides:

setNormalizedPoint in class SoRayPickAction

setPoint

public void setPoint(SbVec2f viewportPoint)

Float version of setPoint(). It can be used when a desktop is magnified on a wall of screens when using ScaleViz in correlation with a tracker device calibrated for this wall.

Overrides:

setPoint in class SoRayPickAction

isValidPp

public boolean isValidPp()

Returns 0 if nothing has been picked. Otherwise, returns 1.

enableElement

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

getppPath

public SoPath getppPath()

Returns the picked point path.

getppPoint

public SbVec3f getppPoint()

Returns the picked point.

setRay

public void setRay(SbVec3f rayStart,
                   SbVec3f rayDirection,
                   float nearDistance,
                   float farDistance)

Sets a world-space ray along which to pick. The ray is defined as a world space starting point and direction vector. The direction vector will be normalized automatically. The last two arguments specify optional near and far plane clipping during the pick operation. These values are distances from the start point along the direction vector, similar to nearDistance and farDistance in SoCamera. A negative distance (such as the default values) means disable clipping to that plane.

NOTE: You can use this method or the setPoint / setNormalizedPoint methods. Whichever method you call last is the one that takes effect.

Overrides:

setRay in class SoRayPickAction