Picking style node. More...

#include <Inventor/nodes/SoPickStyle.h>

Inheritance diagram for SoPickStyle:

Public Types
enum	Style { SHAPE = SoPickStyleElement::SHAPE , BOUNDING_BOX = SoPickStyleElement::BOUNDING_BOX , UNPICKABLE = SoPickStyleElement::UNPICKABLE }
	Picking style. More...

enum	Method { AUTO = SoPickMethodElement::AUTO , GPU = SoPickMethodElement::GPU , CPU = SoPickMethodElement::CPU }
	Picking method. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	SoPickStyle ()
	Creates a pick style node with default settings.

virtual void	setOverride (const SbBool state)
	Set the state of the override field.

virtual SbBool	isOverride () const
	Returns the state of the override field.

Public Member Functions inherited from SoNode
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.

bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.

Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.

void	unref () const
	Removes a reference from an instance.

void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.

int	getRefCount () const
	Returns current reference count.

void	lock () const
	lock this instance.

void	unlock () const
	unlock this instance.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().

static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFEnum	style
	Picking style.

SoSFEnum	method
	Specifies the method used to pick shapes.

Detailed Description

Picking style node.

This node determines how subsequent geometry nodes in the scene graph are to be picked, as indicated by the style and method fields.

Note that this is the only way to change the pick behavior of shapes; drawing style, complexity, and other rendering-related properties have no effect on picking.

FILE FORMAT/DEFAULT

style	SHAPE
method	AUTO

ACTION BEHAVIOR

Member Enumeration Documentation

◆ Method

enum SoPickStyle::Method

Picking method.

Specifying a method does not change the result of picking, but may affect performance. Some shapes like SoPointSet and MoMeshSkin implement a fast GPU Picking technique that may be faster than CPU picking (depending on the use case). When Method is AUTO, Open Inventor will automatically determine which picking method to use. However, you can force use of the CPU or GPU picking techniques. Please refer to SoRayPickAction documentation for more details about GPU Picking.

Enumerator

AUTO

Select the best method to use when picking a shape.

GPU

Always use GPU accelerated picking if the shape supports it.

The documentation of the SoPickAction describes the shapes that support GPU picking and some required conditions.

CPU

Always use CPU picking even if the shape supports another picking method.

Definition at line 129 of file SoPickStyle.h.

◆ Style

enum SoPickStyle::Style

Picking style.

Enumerator
SHAPE	Points on the surfaces of shapes may be picked.
BOUNDING_BOX	Points on the surfaces of 3D bounding boxes of shapes may be picked.
UNPICKABLE	Subsequent objects are ignored by pick traversal.

Definition at line 100 of file SoPickStyle.h.

Constructor & Destructor Documentation

◆ SoPickStyle()

SoPickStyle::SoPickStyle ( )

Creates a pick style node with default settings.

Member Function Documentation

◆ getClassTypeId()

static SoType SoPickStyle::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoPickStyle::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

◆ isOverride()

virtual SbBool SoPickStyle::isOverride ( ) const

inlinevirtual

Returns the state of the override field.

Reimplemented from SoNode.

Definition at line 167 of file SoPickStyle.h.

◆ setOverride()

virtual void SoPickStyle::setOverride ( const SbBool state )

inlinevirtual

Set the state of the override field.

see SoNode::setOverride doc.

Reimplemented from SoNode.

Definition at line 161 of file SoPickStyle.h.

Member Data Documentation

◆ method

SoSFEnum SoPickStyle::method

Specifies the method used to pick shapes.

Use enum Method. Default is AUTO.

Definition at line 150 of file SoPickStyle.h.

◆ style

SoSFEnum SoPickStyle::style

Picking style.

Use enum Style. Default is SHAPE.

Definition at line 119 of file SoPickStyle.h.

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

Inventor/nodes/SoPickStyle.h

Open Inventor Release 2024.2.0

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

SEE ALSO

Member Enumeration Documentation

◆ Method

◆ Style

Constructor & Destructor Documentation

◆ SoPickStyle()

Member Function Documentation

◆ getClassTypeId()

◆ getTypeId()

◆ isOverride()

◆ setOverride()

Member Data Documentation

◆ method

◆ style