.TH "SoPickAction" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoPickAction \- The \fBSoPickAction\fP class is the base class for picking actions\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/actions/SoPickAction\&.h>\fP
.PP
Inherits \fBSoAction\fP\&.
.PP
Inherited by \fBSoRayPickAction\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetViewportRegion\fP (\fBconst\fP \fBSbViewportRegion\fP &\fBnewregion\fP)"
.br
.ti -1c
.RI "\fBconst\fP \fBSbViewportRegion\fP & \fBgetViewportRegion\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBenableCulling\fP (\fBconst\fP SbBool \fBflag\fP)"
.br
.ti -1c
.RI "SbBool \fBisCullingEnabled\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoAction\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fB~SoAction\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBisOfType\fP (\fBSoType\fP type) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBapply\fP (\fBSoNode\fP *root)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBapply\fP (\fBSoPath\fP *path)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBapply\fP (\fBconst\fP \fBSoPathList\fP &\fBpathlist\fP, SbBool \fBobeysrules\fP=FALSE)"
.br
.ti -1c
.RI "\fBvoid\fP \fBapply\fP (\fBSoAction\fP *\fBbeingApplied\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBinvalidateState\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBAppliedCode\fP \fBgetWhatAppliedTo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetNodeAppliedTo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoPath\fP * \fBgetPathAppliedTo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSoPathList\fP * \fBgetPathListAppliedTo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSoPathList\fP * \fBgetOriginalPathListAppliedTo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBisLastPathListAppliedTo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBPathCode\fP \fBgetPathCode\fP (int &\fBnumindices\fP, \fBconst\fP int *&indices)"
.br
.ti -1c
.RI "\fBvoid\fP \fBtraverse\fP (\fBSoNode\fP *\fBconst\fP node)"
.br
.ti -1c
.RI "SbBool \fBhasTerminated\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSoPath\fP * \fBgetCurPath\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoState\fP * \fBgetState\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBPathCode\fP \fBgetCurPathCode\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNode\fP * \fBgetCurPathTail\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBusePathCode\fP (int &\fBnumindices\fP, \fBconst\fP int *&indices)"
.br
.ti -1c
.RI "\fBvoid\fP \fBpushCurPath\fP (\fBconst\fP int \fBchildindex\fP, \fBSoNode\fP *node=\fBNULL\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBpopCurPath\fP (\fBconst\fP \fBPathCode\fP \fBprevpathcode\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBpushCurPath\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBpopPushCurPath\fP (\fBconst\fP int \fBchildindex\fP, \fBSoNode\fP *node=\fBNULL\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBpopCurPath\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBswitchToPathTraversal\fP (\fBSoPath\fP *path)"
.br
.ti -1c
.RI "\fBvoid\fP \fBswitchToNodeTraversal\fP (\fBSoNode\fP *node)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaddMethod\fP (\fBconst\fP \fBSoType\fP type, SoActionMethod method)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBenableElement\fP (\fBconst\fP \fBSoType\fP type, \fBconst\fP int \fBstackindex\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoAction\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClasses\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBnullAction\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBconst\fP \fBSoEnabledElementsList\fP & \fBgetEnabledElements\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoPickAction\fP (\fBconst\fP \fBSbViewportRegion\fP &viewportregion)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoPickAction\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBbeginTraversal\fP (\fBSoNode\fP *node)"
.br
.in -1c

Protected Member Functions inherited from \fBSoAction\fP
.in +1c
.ti -1c
.RI "\fBSoAction\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBendTraversal\fP (\fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetTerminated\fP (\fBconst\fP SbBool \fBflag\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBshouldCompactPathList\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoEnabledElementsList\fP * \fBgetClassEnabledElements\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoActionMethodList\fP * \fBgetClassActionMethods\fP (\fBvoid\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoAction\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoEnabledElementsList\fP * \fBgetClassEnabledElements\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoActionMethodList\fP * \fBgetClassActionMethods\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBSbViewportRegion\fP \fBvpRegion\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoAction\fP
.in +1c
.ti -1c
.RI "\fBSoState\fP * \fBstate\fP"
.br
.ti -1c
.RI "\fBSoActionMethodList\fP * \fBtraversalMethods\fP"
.br
.in -1c
.SS "Additional Inherited Members"


Public Types inherited from \fBSoAction\fP
.in +1c
.ti -1c
.RI "enum \fBAppliedCode\fP { \fBNODE\fP = 0, \fBPATH\fP = 1, \fBPATH_LIST\fP = 2 }"
.br
.ti -1c
.RI "enum \fBPathCode\fP { \fBNO_PATH\fP = 0, \fBIN_PATH\fP = 1, \fBBELOW_PATH\fP = 2, \fBOFF_PATH\fP = 3 }"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoPickAction\fP 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, \fBSoSelection\fP nodes, etc all make use of the functionality provided by the pick actions for selecting and manipulating scene geometry in various ways\&.
.PP
This class is not supposed to be used directly by the application programmer, as it is more a placeholder for the common interface of picking operations\&. It does not contain any actual code for doing scene graph picks\&.
.PP
Coin provides a fully functional picking action for the application programmer to use through the \fBSoRayPickAction\fP class (which inherits the \fBSoPickAction\fP class)\&.
.PP
\fBSee also\fP
.RS 4
\fBSoSelection\fP 
.RE
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoPickAction::SoPickAction (\fBconst\fP \fBSbViewportRegion\fP & viewportregion)\fC [protected]\fP"
Constructor\&. 
.SS "SoPickAction::~SoPickAction (\fBvoid\fP)\fC [protected]\fP, \fC [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoPickAction::getTypeId (\fBvoid\fP) const\fC [virtual]\fP"
Returns the type identification of an object derived from a class inheriting \fBSoAction\fP\&. This is used for runtime type checking and 'downward' casting\&. 
.br
 
.PP
Implements \fBSoAction\fP\&.
.PP
Reimplemented in \fBSoRayPickAction\fP\&.
.SS "\fBSoType\fP SoPickAction::getClassTypeId (\fBvoid\fP)\fC [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBvoid\fP SoPickAction::addMethod (\fBconst\fP \fBSoType\fP type, SoActionMethod method)\fC [static]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 
.SS "\fBvoid\fP SoPickAction::enableElement (\fBconst\fP \fBSoType\fP type, \fBconst\fP int stackindex)\fC [static]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 
.SS "\fBconst\fP \fBSoEnabledElementsList\fP & SoPickAction::getEnabledElements (\fBvoid\fP) const\fC [protected]\fP, \fC [virtual]\fP"
Returns list of enabled elements\&. 
.br
 
.PP
Reimplemented from \fBSoAction\fP\&.
.PP
Reimplemented in \fBSoRayPickAction\fP\&.
.SS "\fBSoEnabledElementsList\fP * SoPickAction::getClassEnabledElements (\fBvoid\fP)\fC [static]\fP, \fC [protected]\fP"
Returns list of enabled elements for this class\&. The enabledElements and methods variables are protected in the original OIV API\&. This is not such a good idea, since exposed static class member variables is a major grievance with regard to Win32 DLLs\&. This function is an extension for Coin, and it is not available in the original SGI Open Inventor \fBv2\&.1\fP API\&.
.br
 
.br
 
.SS "\fBSoActionMethodList\fP * SoPickAction::getClassActionMethods (\fBvoid\fP)\fC [static]\fP, \fC [protected]\fP"
Returns list of action methods for this class\&. The enabledElements and methods variables are protected in the original OIV API\&. This is not such a good idea, since exposed static class member variables is a major grievance with regard to Win32 DLLs\&. This function is an extension for Coin, and it is not available in the original SGI Open Inventor \fBv2\&.1\fP API\&.
.br
 
.br
 
.SS "\fBvoid\fP SoPickAction::initClass (\fBvoid\fP)\fC [static]\fP"
Initializes the runtime type system for this class, and sets up the enabled elements and action method list\&.   
.SS "\fBvoid\fP SoPickAction::setViewportRegion (\fBconst\fP \fBSbViewportRegion\fP & newregion)"
Set a new viewport region to replace the one passed in with the constructor\&. 
.SS "\fBconst\fP \fBSbViewportRegion\fP & SoPickAction::getViewportRegion (\fBvoid\fP) const"
Returns the viewport region used by the action\&. 
.SS "\fBvoid\fP SoPickAction::enableCulling (\fBconst\fP SbBool flag)"
Don't calculate bounding boxes and try to do culling when picking\&.
.PP
This can provide a speed-up in cases where the default setting of \fCon\fP would be inefficient\&. 
.SS "SbBool SoPickAction::isCullingEnabled (\fBvoid\fP) const"
Returns the current state of the culling flag\&. 
.SS "\fBvoid\fP SoPickAction::beginTraversal (\fBSoNode\fP * node)\fC [protected]\fP, \fC [virtual]\fP"
This virtual method is called from \fBSoAction::apply()\fP, and is the entry point for the actual scene graph traversal\&.
.PP
It can be overridden to initialize the action at traversal start, for specific initializations in the action subclasses inheriting \fBSoAction\fP\&.
.PP
Default method just calls \fBtraverse()\fP, which any overridden implementation of the method must do too (or call \fBSoAction::beginTraversal()\fP) to trigger the scene graph traversal\&. 
.PP
Reimplemented from \fBSoAction\fP\&.
.PP
Reimplemented in \fBSoRayPickAction\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "\fBSbViewportRegion\fP SoPickAction::vpRegion\fC [protected]\fP"
The viewport region used by pick actions\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.