Coin Logo http://www.sim.no
http://www.coin3d.org

Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions

SoPickStyle Class Reference

The SoPickStyle class is a node for setting up how to do picking.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>

Inheritance diagram for SoPickStyle:
SoNode SoFieldContainer SoBase

List of all members.

Public Types

enum  Style { SHAPE = SoPickStyleElement::SHAPE, BOUNDING_BOX = SoPickStyleElement::BOUNDING_BOX, UNPICKABLE = SoPickStyleElement::UNPICKABLE }

Public Member Functions

 SoPickStyle (void)
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void pick (SoPickAction *action)

Static Public Member Functions

static void initClass (void)

Public Attributes

SoSFEnum style

Protected Member Functions

virtual ~SoPickStyle ()

Detailed Description

The SoPickStyle class is a node for setting up how to do picking.

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:

    PickStyle {
        style SHAPE
    }
See also:
SoRayPickAction

Member Enumeration Documentation

Enumeration of the available picking strategies.

Enumerator:
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.


Constructor & Destructor Documentation

SoPickStyle::SoPickStyle ( void  )

Constructor.

References BOUNDING_BOX, SHAPE, style, and UNPICKABLE.

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

Destructor.


Member Function Documentation

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(), 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().


Member Data Documentation

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().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:17 for Coin by Doxygen. 1.7.3