SoRayPickAction(3IV)NAMESoRayPickAction (SoRayAct) - intersects objects with a ray cast into
scene
INHERITS FROM
SoAction > SoPickAction > SoRayPickActionSYNOPSIS
#include <Inventor_c/actions/SoRayPickAction.h>
typedef SoRayPickAction SoRayAct
Functions from class SoRayPickAction:
SoRayPickAction * SoRayActCreate(const SbViewportRegion
*viewportRegion)
void SoRayActSetPt(SoRayAct *this, const SbVec2s
*viewportPoint)
void SoRayActSetNormPt(SoRayAct *this, const
SbVec2f *normPoint)
void SoRayActSetRadius(SoRayAct *this, float
radiusInPixels)
void SoRayActSetRay(SoRayAct *this, const SbVec3f
*start, const SbVec3f *direction, float
nearDistance = -1.0, float farDistance =
-1.0)
void SoRayActSetPickAll(SoRayAct *this, SbBool
flag)
SbBool SoRayActIsPickAll(const SoRayAct *this)
const SoPickedPointList * SoRayActGetPickPtList(const SoRayAct *this)
SoPickedPoint * SoRayActGetPickPt(const SoRayAct *this, int
index = 0)
Functions from class SoPickAction:
void SoRayActSetVPReg(SoRayAct *this, const
SbViewportRegion *newRegion)
const SbViewportRegion * SoRayActGetVPReg(const SoRayAct *this)
Functions from class SoAction:
void SoRayActApply(SoRayAct *this, SoNode *node)
void SoRayActApplyPath(SoRayAct *this, SoPath *path)
void SoRayActApplyPathList(SoRayAct *this, const
SoPathList *pathList, SbBool obeysRules = FALSE)
SoType SoRayActGetClassTypeId()
SoType SoRayActGetTypeId(SoRayAct *this)
SbBool SoRayActIsOfType(SoRayAct *this, SoType type)
void SoRayActInvalidateState(SoRayAct *this)
Page 1SoRayPickAction(3IV)DESCRIPTION
This class performs picking by casting a ray into a scene and performing
intersection tests with each object. The ray is extended to be a cone or
cylinder, depending on the camera type, for intersection with points and
lines. Each intersection is returned as an SoPickedPoint instance.
The picking ray can be specified as either a ray from the camera location
through a particular viewport pixel, or as a world-space ray. In the
former case, a valid camera must be encountered during traversal of the
graph to determine the location of the ray in world space.
Callers can cause the action to compute all intersections along the ray
(sorted closest to farthest) by setting the pickAll flag to TRUE. By
default, the action computes only the closest intersection. In either
case, the intersections are returned in an SoPickedPointList. Each
intersection can be examined by accessing the appropriate SoPickedPoint
in the list. The SoPickedPoint class provides methods to get the
intersection point, normal, and other info.
FUNCTIONSSoRayPickAction * SoRayActCreate(const SbViewportRegion
*viewportRegion)
Constructor takes viewport region to use for picking. Even though
the picking operation may not involve a window per se, some nodes
need this information to determine their size and placement.
void SoRayActSetPt(SoRayAct *this, const 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.
void SoRayActSetNormPt(SoRayAct *this, const
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 SoRayActSetRadius(SoRayAct *this, float
radiusInPixels)
Set the radius (in pixels) around the point. This is used when
testing the ray against lines and points. By default, the radius is
5 pixels. For perspective cameras, the ray is extended to be a cone
when testing against lines and points. For orthographic cameras, the
ray is extended to be a cylinder. The radius has no effect for
shapes of other types.
void SoRayActSetRay(SoRayAct *this, const SbVec3f
*start, const SbVec3f *direction, float
nearDistance = -1.0, float farDistance =
-1.0)
Sets a world-space ray along which to pick. The ray is defined as a
world space starting point and direction vector. The direction
Page 2SoRayPickAction(3IV)
vector will be normalized automatically. The last two arguments are
the parametric distances between which intersections along the ray
must occur. The distances are measured as if the direction vector is
unit length; e.g., if nearDistance is 2.0, the intersection must
occur past (start + 2*(length of the direction vector)) units along
the ray. These distances can be used to achieve near and far plane
clipping. A negative distance (such as the default values) means
disable clipping to that plane.
void SoRayActSetPickAll(SoRayAct *this, SbBool
flag)
SbBool SoRayActIsPickAll(const SoRayAct *this)
Sets/returns whether the action will return all objects intersected
or just the closest one.
const SoPickedPointList * SoRayActGetPickPtList(const SoRayAct *this)
Returns list of picked points.
SoPickedPoint * SoRayActGetPickPt(const SoRayAct *this, int
index = 0)
Returns the indexed picked point from the list.
SEE ALSO
SoPickedPoint, SoPickedPointList
Page 3
