SoPickAction(3)

NAME
SoPickAction - The SoPickAction class is the base class for picking actions.

The basis for all interaction features that Coin provides for the application programmer is the pick actions. Draggers, manipulators, SoSelection nodes, etc all make use of the functionality provided by the pick actions for selecting and manipulating scene geometry in various ways.

SYNOPSIS

#include <Inventor/actions/SoPickAction.h>

Inherits SoAction.

Inherited by SoRayPickAction.

  Public Member Functions
virtual SoType getTypeId (void) const
void setViewportRegion (const SbViewportRegion &newregion)
const SbViewportRegion & getViewportRegion (void)
void enableCulling (const SbBool flag)
SbBool isCullingEnabled (void) const

  Static Public Member Functions
static SoType getClassTypeId (void)
static void addMethod (const SoType type, SoActionMethod method)
static void enableElement (const SoType type, const int stackindex)
static void initClass (void)

  Protected Member Functions
virtual const SoEnabledElementsList & getEnabledElements (void) const
SoPickAction (const SbViewportRegion &viewportregion)
virtual ~SoPickAction (void)
virtual void beginTraversal (SoNode *node)

  Static Protected Member Functions
static SoEnabledElementsList * getClassEnabledElements (void)
static SoActionMethodList * getClassActionMethods (void)

  Protected Attributes
SbViewportRegion vpRegion

  Additional Inherited Members

Detailed Description

The SoPickAction class is the base class for picking actions.

The basis for all interaction features that Coin provides for the application programmer is the pick actions. Draggers, manipulators, SoSelection nodes, etc all make use of the functionality provided by the pick actions for selecting and manipulating scene geometry in various ways. This class is not supposed to be used directly by the application programmer, as it is more a place-holder for the common interface of picking operations. It does not contain any actual code for doing scenegraph picks.

Coin provides a fully functional picking action for the application programmer to use through the SoRayPickAction class (which inherits the SoPickAction class).

See also:
    SoSelection

Constructor & Destructor Documentation

  SoPickAction::SoPickAction (const SbViewportRegion & viewportregion) [protected]
Constructor.

  SoPickAction::~SoPickAction (void) [protected], [virtual]
Destructor.

Member Function Documentation

  SoType SoPickAction::getTypeId (void) const [virtual]
Returns the type identification of an action derived from a class inheriting SoAction. This is used for run-time type checking and 'downward' casting.

Usage example:

void bar(SoAction * action)
{
  if (action->getTypeId() == SoGLRenderAction::getClassTypeId()) {
    // safe downward cast, know the type
    SoGLRenderAction * glrender = (SoGLRenderAction *)action;
  }
  return; // ignore if not renderaction
}

For application programmers wanting to extend the library with new actions: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through Inventor/nodes/SoSubAction.h: SO_ACTION_SOURCE, SO_ACTION_INIT_CLASS and SO_ACTION_CONSTRUCTOR.

For more information on writing Coin extensions, see the SoAction class documentation.

Returns the actual type id of an object derived from a class inheriting SoAction. Needs to be overridden in all subclasses.

Implements SoAction.

Reimplemented in SoRayPickAction.

  void SoPickAction::addMethod (const SoType type, SoActionMethod method) [static]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

  void SoPickAction::enableElement (const SoType type, const int stackindex) [static]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

  const SoEnabledElementsList & SoPickAction::getEnabledElements (void) const [protected], [virtual]
Returns a list of the elements used by action instances of this class upon traversal operations.

Reimplemented from SoAction.

Reimplemented in SoRayPickAction.

  void SoPickAction::setViewportRegion (const SbViewportRegion & newregion)
Set a new viewport region to replace the one passed in with the constructor.

  const SbViewportRegion & SoPickAction::getViewportRegion (void)
Returns the viewport region used by the action.

  void SoPickAction::enableCulling (const SbBool flag)
Don't calculate bounding boxes and try to do culling when picking.

This can provide a speed-up in cases where the default setting of on would be inefficient.

  SbBool SoPickAction::isCullingEnabled (void) const
Returns the current state of the culling flag.

  void SoPickAction::beginTraversal (SoNode * node) [protected], [virtual]
This virtual method is called from SoAction::apply(), and is the entry point for the actual scenegraph traversal.

It can be overridden to initialize the action at traversal start, for specific initializations in the action subclasses inheriting SoAction.

Default method just calls traverse(), which any overridden implementation of the method must do too (or call SoAction::beginTraversal()) to trigger the scenegraph traversal.

Reimplemented from SoAction.

Reimplemented in SoRayPickAction.

Member Data Documentation

  SbViewportRegion SoPickAction::vpRegion [protected]
The viewport region used by pick actions.

Author

Generated automatically by Doxygen for Coin from the source code.