Base class for all interaction nodekit classes. More...

#include <Inventor/nodekits/SoInteractionKit.h>

Inheritance diagram for SoInteractionKit:

Public Types
enum	CacheEnabled { OFF , ON , AUTO }
	Possible values for caching. More...

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

virtual const SoNodekitCatalog *	getNodekitCatalog () const
	Returns the SoNodekitCatalog for this instance.

virtual SbBool	setPartAsPath (const SbName &partName, SoPath *surrogatePath)
	Sets any public part in the interaction kit as a "surrogate" path instead.

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

Public Member Functions inherited from SoBaseKit
	SoBaseKit ()
	Constructor.

virtual SoNode *	getPart (const SbName &partName, SbBool makeIfNeeded)
	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

template<typename PartType >
PartType *	getPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE.

template<typename PartType >
PartType *	checkPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE.

SbString	getPartString (const SoBase *part)
	Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part.

virtual SoNodeKitPath *	createPathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL)
	Returns a path that begins at this nodekit and ends at partName.

virtual SbBool	setPart (const SbName &partName, SoNode *newPart)
	Inserts the given node (not a copy) as the new part specified by partName.

SoNONUNICODE SbBool	set (char *nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.

SbBool	set (const SbString &nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.

SoNONUNICODE SbBool	set (const char partNameString, const char parameterString)
	This function allows field values of parts (nodes) to be set.

SbBool	set (const SbString &partNameString, const SbString &parameterString)
	This function allows field values of parts (nodes) to be set.

Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.

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

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

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.

Public Member Functions inherited from SoGetView
	SoGetView ()
	Default constructor.

virtual	~SoGetView ()

virtual SbBool	getViewportIsEnabled () const
	Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise.

virtual const SbVec2f	getViewportOrigin () const
	Returns SbViewportRegion origin.

virtual const SbVec2f	getViewportSize () const
	Returns SbViewportRegion size.

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

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

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

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for the class SoBaseKit.

static void	setSearchingChildren (SbBool newVal)
	Sets if nodekit children are searched during SoSearchAction traversal.

static SbBool	isSearchingChildren ()
	Returns TRUE if nodekit children are searched during SoSearchAction traversal.

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	boundingBoxCaching
	Set bounding box caching mode.

SoSFEnum	renderCulling
	Set render culling mode.

SoSFEnum	pickCulling
	Set pick caching mode.

Deprecated

SoDEPRECATED SoSFEnum	renderCaching
	Set render caching mode.

Public Attributes inherited from SoBaseKit
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Detailed Description

Base class for all interaction nodekit classes.

This is the base class for all classes of interaction nodekits. Currently, the only subclass is SoDragger, which reacts to click-drag-release events from the mouse.

This node has three fields corresponding to those of an SoSeparator: They are boundingBoxCaching, renderCulling, and pickCulling. They behave the same here as they do for an SoSeparator

The setPartAsPath() method provides support for creating "stand-in" objects for parts in the interaction kit. The "stand-in", or "surrogate" part, is a path to an object that lies somewhere else in the scene graph. This could be used, for example, with an SoTranslate1Dragger to allow the user to click on some geometry and directly drag it (without displaying any separate dragger geometry). This technique is used, for example, in SoOrthoSliceDragger.

FILE FORMAT/DEFAULT

boundingBoxCaching	AUTO
renderCulling	AUTO
pickCulling	AUTO
callbackList	NULL

CATALOG PARTS

Part Name	Part Type	Default Type	NULL Default
callbackList	NodeKitListPart	–	yes

Extra Information for List Parts from Above Table

Part Name	Container Type	Possible Types
callbackList	Separator	Callback, EventCallback

Member Enumeration Documentation

◆ CacheEnabled

enum SoInteractionKit::CacheEnabled

Possible values for caching.

Enumerator
OFF	Never build or use a cache.
ON	Always try to build a cache.
AUTO	Automatic caching.

Definition at line 192 of file SoInteractionKit.h.

Member Function Documentation

◆ affectsState()

virtual SbBool SoInteractionKit::affectsState ( ) const

virtual

Returns TRUE if a node has an effect on the state during traversal.

The default method returns TRUE. Node classes (such as SoSeparator) that isolate their effects from the rest of the graph override this method to return FALSE.

Reimplemented from SoNode.

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * SoInteractionKit::getClassNodekitCatalog ( )

static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType SoInteractionKit::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getNodekitCatalog()

virtual const SoNodekitCatalog * SoInteractionKit::getNodekitCatalog ( ) const

virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from SoBaseKit.

Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragger, SoDragPointDragger, SoEllipsoidDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger, and SoOrthoSliceDragger.

◆ getTypeId()

virtual SoType SoInteractionKit::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoBaseKit.

Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragger, SoDragPointDragger, SoEllipsoidDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger, Magnifier, and SoOrthoSliceDragger.

◆ setPartAsPath()

virtual SbBool SoInteractionKit::setPartAsPath	(	const SbName &	partName,
		SoPath *	surrogatePath
	)

virtual

Sets any public part in the interaction kit as a "surrogate" path instead.

The object at the end of the path serves as a stand-in when a pick occurs, and can thus initiate interaction.

Instead of the usual setPart(), which replaces partName with a new node, this will remove the node being used for partName from the scene and remember the surrogatePath you give it. Later, any pick on surrogatePath will be regarded as a pick on partName.

For example, set the XRotator part of an SoTrackballDragger to be the path to an object in the scene. The rest of the trackball will look the same, but the XRotator stripe will disappear. However, click the mouse on the object at the end of surrogatePath and the ball will start to drag in rotation around its X axis.

Note that this is different from setting the part to be the node at the end of the path. When you set the part as a node, a second instance will be drawn in the local space of the interaction kit. When you set it as a path, the object itself is used, not a copy.

The partName may be any part name that follows the nodekit syntax for parts, such as childList[0].shape or rotator.rotatorActive. (See the getPart() method in the SoBaseKit reference page for a complete description.)

NOTE: No information about the surrogatePath is written to a file.

Member Data Documentation

◆ boundingBoxCaching

SoSFEnum SoInteractionKit::boundingBoxCaching

Set bounding box caching mode.

Use enum CacheEnabled. Default is ON. Setting this value to AUTO is equivalent to ON - automatic culling is not implemented.

Definition at line 222 of file SoInteractionKit.h.

◆ pickCulling

SoSFEnum SoInteractionKit::pickCulling

Set pick caching mode.

Use enum CacheEnabled. Default is AUTO.

Definition at line 233 of file SoInteractionKit.h.

◆ renderCaching

SoDEPRECATED SoSFEnum SoInteractionKit::renderCaching

Set render caching mode.

Use enum CacheEnabled. Default is AUTO.

Definition at line 214 of file SoInteractionKit.h.

◆ renderCulling

SoSFEnum SoInteractionKit::renderCulling

Set render culling mode.

Use enum CacheEnabled. Default is OFF. Setting this value to AUTO is equivalent to ON - automatic culling is not implemented.

Definition at line 228 of file SoInteractionKit.h.

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

Inventor/nodekits/SoInteractionKit.h

Open Inventor Release 2024.1.0

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

FILE FORMAT/DEFAULT

CATALOG PARTS

SEE ALSO

Member Enumeration Documentation

◆ CacheEnabled

Member Function Documentation

◆ affectsState()

◆ getClassNodekitCatalog()

◆ getClassTypeId()

◆ getNodekitCatalog()

◆ getTypeId()

◆ setPartAsPath()

Member Data Documentation

◆ boundingBoxCaching

◆ pickCulling

◆ renderCaching

◆ renderCulling