Open Inventor Reference
SoPickAction Class Reference

Abstract base class for picking objects in a scene. More...

#include <Inventor/actions/SoPickAction.h>

Inheritance diagram for SoPickAction:
SoAction SoRayPickAction

List of all members.

Public Member Functions

void setViewportRegion (const SbViewportRegion &newRegion)
 Sets current viewport region to use for action.
const SbViewportRegiongetViewportRegion () const
 Returns current viewport region to use for action.
void enableCulling (SbBool flag)
 Setting this flag to FALSE disables any pick culling that might take place (as in SoSeparators).
SbBool isCullingEnabled () const

Static Public Member Functions

static void initClass ()

Protected Member Functions

 SoPickAction (const SbViewportRegion &viewportRegion)
 Constructor takes viewport region.
virtual ~SoPickAction ()
 Destructor.
virtual void beginTraversal (SoNode *node)
 Initiates action on graph.

Protected Attributes

SbViewportRegion vpRegion
 Current viewport region.

Detailed Description

This is an abstract base class for all picking actions. Currently, the only supported subclass is the SoRayPickAction.

See Also
SoRayPickAction

Definition at line 77 of file SoPickAction.h.


Constructor & Destructor Documentation

SoPickAction::SoPickAction ( const SbViewportRegion viewportRegion) [protected]

See comments for the setViewportRegion() method.

virtual SoPickAction::~SoPickAction ( ) [protected, virtual]

Member Function Documentation

virtual void SoPickAction::beginTraversal ( SoNode node) [protected, virtual]

Reimplemented from SoAction.

Reimplemented in SoRayPickAction.

void SoPickAction::enableCulling ( SbBool  flag) [inline]

This can be used for nodes (such as SoArray and SoMultipleCopy) that traverse their children multiple times in different locations, thereby avoiding computing bounding boxes each time. (This problem is very severe when each bounding box traversal also traverses the children N times.) The default setting is TRUE.

Definition at line 99 of file SoPickAction.h.

const SbViewportRegion& SoPickAction::getViewportRegion ( ) const [inline]

Definition at line 89 of file SoPickAction.h.

static void SoPickAction::initClass ( ) [static]

Reimplemented from SoAction.

Reimplemented in SoRayPickAction.

SbBool SoPickAction::isCullingEnabled ( ) const [inline]

Definition at line 100 of file SoPickAction.h.

void SoPickAction::setViewportRegion ( const SbViewportRegion newRegion)

Even though the picking operation may not involve a window per se, some nodes need this information to determine their size and placement.


Member Data Documentation

Definition at line 106 of file SoPickAction.h.


The documentation for this class was generated from the following file: