![]() |
http://www.sim.no http://www.coin3d.org |
By default, all geometry in a scene is available for picking. Upon writing applications with interaction possibilities, this is often not what you want. To exclude parts of the scene graph from pick actions, use the SoPickStyle::UNPICKABLE. More...
#include <Inventor/nodes/SoPickStyle.h>
Public Types | |
enum | Style { SHAPE = SoPickStyleElement::SHAPE, BOUNDING_BOX = SoPickStyleElement::BOUNDING_BOX, UNPICKABLE = SoPickStyleElement::UNPICKABLE } |
Public Member Functions | |
virtual SoType | getTypeId (void) const |
SoPickStyle (void) | |
virtual void | doAction (SoAction *action) |
virtual void | callback (SoCallbackAction *action) |
virtual void | pick (SoPickAction *action) |
Static Public Member Functions | |
static SoType | getClassTypeId (void) |
static void | initClass (void) |
Public Attributes | |
SoSFEnum | style |
Protected Member Functions | |
virtual const SoFieldData * | getFieldData (void) const |
virtual | ~SoPickStyle () |
Static Protected Member Functions | |
static const SoFieldData ** | getFieldDataPtr (void) |
By default, all geometry in a scene is available for picking. Upon writing applications with interaction possibilities, this is often not what you want. To exclude parts of the scene graph from pick actions, use the SoPickStyle::UNPICKABLE.
You can also optimize pick operations by using the SoPickStyle::BOUNDING_BOX pickstyle.
FILE FORMAT/DEFAULTS:
enum SoPickStyle::Style |
Enumeration of the available picking strategies.
SHAPE | Do "exact" picks, finding the correct intersection point(s), etc. |
BOUNDING_BOX | Only compare pick intersection with the bounding boxes of shapes. This is usually much faster than SoPickStyle::SHAPE. |
UNPICKABLE | The geometry following this node in the scene will not be available for picking. |
SoPickStyle::SoPickStyle | ( | void | ) |
Constructor.
References BOUNDING_BOX, SHAPE, style, and UNPICKABLE.
SoPickStyle::~SoPickStyle | ( | ) | [protected, virtual] |
Destructor.
SoType SoPickStyle::getClassTypeId | ( | void | ) | [static] |
SoType SoPickStyle::getTypeId | ( | void | ) | const [virtual] |
Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.
Usage example:
void foo(SoNode * node) { if (node->getTypeId() == SoFile::getClassTypeId()) { SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type } else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) { SoGroup * group = (SoGroup *)node; // safe downward cast, knows the type } }
For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: 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 for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.
For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.
Implements SoBase.
const SoFieldData ** SoPickStyle::getFieldDataPtr | ( | void | ) | [static, protected] |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Reimplemented from SoNode.
const SoFieldData * SoPickStyle::getFieldData | ( | void | ) | const [protected, virtual] |
Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL
.
Reimplemented from SoFieldContainer.
void SoPickStyle::initClass | ( | void | ) | [static] |
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
Reimplemented from SoNode.
void SoPickStyle::doAction | ( | SoAction * | action | ) | [virtual] |
This function performs the typical operation of a node for any action.
Reimplemented from SoNode.
References SoOverrideElement::getPickStyleOverride(), SoAction::getState(), SoSFEnum::getValue(), SoField::isIgnored(), SoNode::isOverride(), SoFieldContainer::set(), SoOverrideElement::setPickStyleOverride(), and style.
Referenced by callback(), and pick().
void SoPickStyle::callback | ( | SoCallbackAction * | action | ) | [virtual] |
Action method for SoCallbackAction.
Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.
Reimplemented from SoNode.
References doAction().
void SoPickStyle::pick | ( | SoPickAction * | action | ) | [virtual] |
Action method for SoPickAction.
Does common processing for SoPickAction action instances.
Reimplemented from SoNode.
References doAction().
Which strategy to use for the picking actions for subsequent shapes in the scene graph. Default value is SoPickStyle::SHAPE.
Referenced by doAction(), and SoPickStyle().
Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.
Generated on Mon Feb 23 16:33:56 2009 for Coin by Doxygen. 1.5.8