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 Types inherited from SoNode
enum	Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }

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

virtual bool	affectsState () const
	Override the default behavior of SoNode.

Public Member Functions inherited from SoBaseKit
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	Returns the SoNodekitCatalog for this instance of SoBaseKit.

	SoBaseKit ()
	Constructor.

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

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, bool makeIfNeeded, const SoPath *pathToExtend=NULL)
	Returns a path that begins at this nodekit and ends at `partName`.

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

bool	set (char *nameValuePairListString)
	SETTING FIELDS OF PARTS.

bool	set (char partNameString, char parameterString)

virtual void	doAction (SoAction *action)
	This method performs the "typical" operation of a node for any action.

virtual void	callback (SoCallbackAction *action)
	These functions implement all actions for nodekits.

virtual void	GLRender (SoGLRenderAction *action)
	These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	rayPick (SoRayPickAction *action)

virtual void	search (SoSearchAction *action)

virtual void	write (SoWriteAction *action)

virtual SoChildList *	getChildren () const
	Returns pointer to children.

void	printDiagram ()

void	printSubDiagram (const SbName &rootName, int level)

void	printTable ()

virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Overrides the default method to use countMyFields() instead of the regular SoFieldData writing mechanism.

bool	forceChildDrivenWriteRefs (SoOutput *out)
	This returns TRUE if the nodekit intends to write out.

Public Member Functions inherited from SoNode
void	setOverride (bool state)
	Turns override flag on or off.

bool	isOverride () const
	Returns the state of the override flag.

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

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

virtual void	doAction (SoAction *action)
	This method performs the "typical" operation of a node for any action.

virtual void	GLRender (SoGLRenderAction *action)
	These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.

virtual void	callback (SoCallbackAction *action)

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	pick (SoPickAction *action)

virtual void	rayPick (SoRayPickAction *action)

virtual void	search (SoSearchAction *action)

virtual void	write (SoWriteAction *action)

virtual void	GLRenderBelowPath (SoGLRenderAction *action)
	These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes.

virtual void	GLRenderInPath (SoGLRenderAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

virtual void	grabEventsSetup ()
	These virtual functions are called when a node gains or loses status as "grabber" of events (see HandleEventAction::setGrabber()).

virtual void	grabEventsCleanup ()

virtual void	startNotify ()
	Initiates notification from an instance.

virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.

SbNodeIdType	getNodeId () const
	Returns the unique id for a node.

virtual SoChildList *	getChildren () const
	Returns pointer to children, or NULL if none.

virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used for either stage of writing.)

virtual SoNode *	addToCopyDict () const
	Recursively adds this node and all nodes under it to the copy dictionary.

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance.

virtual SoFieldContainer *	copyThroughConnection () const
	Copies an instance that is encountered through a field connection.

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

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

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

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

bool	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 Inventor file format.

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

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

virtual SoField *	getField (const SbName &fieldName) const
	Returns a pointer to the field with the given name.

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

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

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

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

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

virtual void	notify (SoNotList *)
	Propagates modification notification through an instance.

virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.

virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used only for last stage of writing)

bool	getIsBuiltIn () const
	Returns whether or not instance is considered 'built-in' to the library.

virtual const SoFieldData *	getFieldData () const
	Returns an SoFieldData structure for the node.

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance.

virtual SoFieldContainer *	copyThroughConnection () const
	During a copy operation, this copies an instance that is encountered through a field connection.

void	addManagedSensor (SoSensor *sensor)
	Adds a sensor which is managed by the field container.

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

void	unref () const

void	unrefNoDelete () const

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

virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance.

bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in `type` or is derived from that type.

virtual SbName	getName () const
	Returns the name of an instance.

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

virtual void	startNotify ()
	Initiates notification from an instance.

virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.

void	addAuditor (void *auditor, SoNotRec::Type type)
	Adds/removes an auditor to/from list.

void	removeAuditor (void *auditor, SoNotRec::Type type)

const SoAuditorList &	getAuditors ()
	Returns auditor list– used by SoField and SoEngineOutput to trace forward connections.

int	getRefCount () const
	Returns current reference count.

virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.

bool	shouldWrite ()
	Returns TRUE if the instance should be written, based on the write-reference info already accumulated.

Fields
SoSFEnum	renderCaching
	Set render caching mode. Default is `AUTO`.

SoSFEnum	boundingBoxCaching
	Set bounding box caching mode.

SoSFEnum	renderCulling
	Set render culling mode.

SoSFEnum	pickCulling
	Set pick caching mode. Default is `AUTO`.

SoFieldSensor *	fieldSensor
	This sensor will watch the topSeparator part.

SoSeparator *	oldTopSep

virtual bool	setPartAsDefault (const SbName &partName, SoNode *newNode, bool onlyIfAlready=TRUE)
	Sets the part, then sets the field for that part to default using partField.setDefault(TRUE).

virtual bool	setPartAsDefault (const SbName &partName, const SbName &newNodeName, bool onlyIfAlready=TRUE)

bool	isPathSurrogateInMySubgraph (const SoPath *pathToCheck)
	Is the 'inPath' valid as a surrogate path anywhere in this node's subgraph? Examines the surrogate paths of all InteractionKits from this node down.

bool	isPathSurrogateInMySubgraph (const SoPath pathToCheck, SoPath &pathToOwner, SbName &surrogateNameInOwner, SoPath *&surrogatePathInOwner, bool fillArgs=TRUE)

static void	setSwitchValue (SoNode *n, int newVal)

static void	initClass ()
	initialize the class

	SoInteractionKit ()

	~SoInteractionKit ()

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given instance into this instance This copies the surrogatePartPathList and the surrogatePartNameList.

virtual SoNode *	getAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE)
	These are overloaded to set the surrogate path to NULL after completing their work.

virtual SoNodeKitPath *	createPathToAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE, const SoPath *pathToExtend=NULL)

virtual bool	setAnyPart (const SbName &partName, SoNode *from, bool anyPart=TRUE)

virtual bool	setAnyPartAsPath (const SbName &partName, SoPath *surrogatePath, bool leafCheck=FALSE, bool publicCheck=FALSE)
	This allows you to set any part in the nodekit as a surrogate path.

virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads in from file.

virtual bool	setAnyPartAsDefault (const SbName &partName, SoNode *newNode, bool anyPart=TRUE, bool onlyIfAlready=TRUE)
	Protected versions of these methods that allow you to set non-leaf and/or private parts.

virtual bool	setAnyPartAsDefault (const SbName &partName, const SbName &newNodeName, bool anyPart=TRUE, bool onlyIfAlready=TRUE)

bool	setAnySurrogatePath (const SbName &inName, SoPath *inPath, bool leafCheck=FALSE, bool publicCheck=FALSE)

virtual bool	setUpConnections (bool onOff, bool doItAlways=FALSE)
	detach/attach any sensors, callbacks, and/or field connections.

virtual void	setDefaultOnNonWritingFields ()
	Called by the SoBaseKit::write() method.

void	connectSeparatorFields (SoSeparator *dest, bool onOff)

static void	readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize)
	read from buffer

static void	fieldSensorCB (void , SoSensor )

Additional Inherited Members
Static Public Member Functions inherited from SoBaseKit
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for the class SoBaseKit.

static bool	isSearchingChildren ()
	Sets and queries if nodekit children are searched during SoSearchAction traversal.

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

static void	initClass ()

static SoNode *	typeCheck (const SbName &partName, const SoType &partType, SoNode *node)

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

static SoNode *	getByName (const SbName &name)
	Returns the last node given the specified name.

static int	getByName (const SbName &name, SoNodeList &list)
	Returns the number of nodes with the given name, and adds to `list` pointers to those nodes.

static void	initClass ()
	Initializes base node class.

static void	initClasses ()
	Initialize ALL Inventor node classes.

static SbNodeIdType	getNextNodeId ()
	Returns the next available unique id.

static int	getActionMethodIndex (SoType t)
	Returns the index of this node in the action/method table, given its type.

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

static void	initClass ()
	Setup type information.

static void	initCopyDict ()
	During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used.

static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)
	Adds an instance to the dictionary.

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
	If a copy of the given instance is in the dictionary, this returns it.

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, bool copyConnections)
	If a copy of the given instance is not in the dictionary, this returns NULL.

static void	copyDone ()
	Cleans up the dictionary when done.

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

static void	initClass ()
	Setup type information.

static void	incrementCurrentWriteCounter ()
	Increments the current write counter at the start of a write operation.

static void	decrementCurrentWriteCounter ()
	Decrements the current write counter after a write operation, in some rare cases.

static void	addName (SoBase , const char )
	Internal methods used to maintain the global name dictionary.

static void	removeName (SoBase , const char )

static SoBase *	getNamedBase (const SbName &, SoType)
	Helper routines used to get stuff out of nameDict.

static int	getNamedBases (const SbName &, SoBaseList &, SoType)

static bool	read (SoInput in, SoBase &base, SoType expectedType)
	Reads one instance of some subclass of SoBase.

static void	setInstancePrefix (const SbString &c)
	This defaults to "+" and is used when naming nodes that are DEF's and USE'd.

Static Public Attributes inherited from SoBase
static bool	traceRefs
	Turns on/off reference count tracing (for debugging)

Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
	This set of enums is used when reading and writing the base. More...

Protected Member Functions inherited from SoBaseKit
	SO_KIT_CATALOG_ENTRY_HEADER (callbackList)
	Define fields for the new parts of the kit...

virtual SoNode *	addToCopyDict () const
	Redefines this to add this node and all part nodes to the dictionary.

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given nodekit into this instance.

SoGroup *	getContainerNode (const SbName &listName, bool makeIfNeeded=TRUE)
	Returns the containerNode within the SoNodeKitListPart given by listName.

virtual SoNode *	getAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE)
	like their public versions, but are allowed access to non-leaf and private parts.

virtual SoNodeKitPath *	createPathToAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE, const SoPath *pathToExtend=NULL)

virtual bool	setAnyPart (const SbName &partName, SoNode *from, bool anyPart=TRUE)

void	createNodekitPartsList ()
	called during construction to create parts list

virtual void	createDefaultParts ()
	called during construction to create any parts that are created by default (such as the cube in the SoCubeKit)

const SoNodekitParts *	getNodekitPartsList () const
	Return the node's partsList.

void	catalogError ()
	Prints an Error when there's trouble building a catalog.

virtual bool	setUpConnections (bool onOff, bool doItAlways=FALSE)
	detach/attach any sensors, callbacks, and/or field connections.

virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads in from file. Takes care of setting parts and stuff.

virtual void	setDefaultOnNonWritingFields ()
	This is called during countMyFields() method.

void	countMyFields (SoOutput *out)
	This is called during addWriteReference() to write the fields.

virtual	~SoBaseKit ()

Protected Member Functions inherited from SoNode
	SoNode ()
	Constructor, destructor.

virtual	~SoNode ()

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer ()

	~SoFieldContainer ()

virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error.

Protected Member Functions inherited from SoBase
	SoBase ()
	Constructor is protected - this is an abstract class.

virtual	~SoBase ()
	Virtual destructor so that subclasses are deleted properly.

virtual void	destroy ()
	Actually deletes an instance.

bool	hasMultipleWriteRefs () const
	Returns TRUE if the instance has multiple write references.

bool	writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
	Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput.

void	writeFooter (SoOutput *out) const

virtual const char *	getFileFormatName () const
	Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned)

virtual bool	readInstance (SoInput *in, unsigned short flags)=0
	Reads stuff into instance of subclass.

Static Protected Member Functions inherited from SoBaseKit
static const SoNodekitCatalog **	getClassNodekitCatalogPtr ()
	...end of contents of SO_KIT_HEADER

Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr ()
	This is used by the field-inheritence mechanism, hidden in the SoSubNode macros.

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter ()
	Returns current write counter.

Protected Attributes inherited from SoBaseKit
SoChildList *	children

SoNodekitParts *	nodekitPartsList
	parts list.

bool	connectionsSetUp

Protected Attributes inherited from SoNode
SbNodeIdType	uniqueId
	Unique id for this node.

Protected Attributes inherited from SoFieldContainer
bool	isBuiltIn
	Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information.

Static Protected Attributes inherited from SoNode
static SbNodeIdType	nextUniqueId
	Next available unique id.

static int	nextActionMethodIndex
	Next index into the action method table.

Detailed Description

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 four fields corresponding to those of an SoSeparator: They are renderCaching , 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.

See Also

Definition at line 96 of file SoInteractionKit.h.

Member Enumeration Documentation

◆ CacheEnabled

enum SoInteractionKit::CacheEnabled

Enumerator
OFF	Never build or use a cache.
ON	Always try to build a cache.
AUTO	Decide based on some heuristic.

Definition at line 141 of file SoInteractionKit.h.

Constructor & Destructor Documentation

◆ SoInteractionKit()

SoInteractionKit::SoInteractionKit ( )

protected

◆ ~SoInteractionKit()

SoInteractionKit::~SoInteractionKit ( )

protected

Member Function Documentation

◆ affectsState()

virtual bool SoInteractionKit::affectsState ( ) const

virtual

Reimplemented from SoNode.

◆ connectSeparatorFields()

void SoInteractionKit::connectSeparatorFields	(	SoSeparator *	dest,
		bool	onOff
	)

protected

◆ copyContents()

virtual void SoInteractionKit::copyContents	(	const SoFieldContainer *	fromFC,
		bool	copyConnections
	)

protectedvirtual

Reimplemented from SoBaseKit.

Reimplemented in SoRotateCylindricalDragger, and SoRotateSphericalDragger.

◆ createPathToAnyPart()

virtual SoNodeKitPath * SoInteractionKit::createPathToAnyPart	(	const SbName &	partName,
		bool	makeIfNeeded,
		bool	leafCheck = `FALSE`,
		bool	publicCheck = `FALSE`,
		const SoPath *	pathToExtend = `NULL`
	)

protectedvirtual

Reimplemented from SoBaseKit.

◆ fieldSensorCB()

static void SoInteractionKit::fieldSensorCB	(	void *	,
		SoSensor *
	)

staticprotected

◆ getAnyPart()

virtual SoNode * SoInteractionKit::getAnyPart	(	const SbName &	partName,
		bool	makeIfNeeded,
		bool	leafCheck = `FALSE`,
		bool	publicCheck = `FALSE`
	)

protectedvirtual

Reimplemented from SoBaseKit.

◆ initClass()

static void SoInteractionKit::initClass ( )

static

◆ isPathSurrogateInMySubgraph() [1/2]

bool SoInteractionKit::isPathSurrogateInMySubgraph ( const SoPath * pathToCheck )

The first time a surrogate path is found that is contained within 'inPath', then TRUE is returned. The second version also returns information about the surrogate, only if (fillArgs == TRUE).

◆ isPathSurrogateInMySubgraph() [2/2]

bool SoInteractionKit::isPathSurrogateInMySubgraph	(	const SoPath *	pathToCheck,
		SoPath *&	pathToOwner,
		SbName &	surrogateNameInOwner,
		SoPath *&	surrogatePathInOwner,
		bool	fillArgs = `TRUE`
	)

◆ readDefaultParts()

static void SoInteractionKit::readDefaultParts	(	const char *	fileName,
		const char	defaultBuffer[],
		int	defBufSize
	)

staticprotected

Parameters

fileName	file to read
defaultBuffer	if no file,

◆ readInstance()

virtual bool SoInteractionKit::readInstance	(	SoInput *	in,
		unsigned short	flags
	)

protectedvirtual

Takes care of checking values in the topSeparator fields and the field of this node.

Reimplemented from SoBaseKit.

◆ setAnyPart()

virtual bool SoInteractionKit::setAnyPart	(	const SbName &	partName,
		SoNode *	from,
		bool	anyPart = `TRUE`
	)

protectedvirtual

Reimplemented from SoBaseKit.

◆ setAnyPartAsDefault() [1/2]

virtual bool SoInteractionKit::setAnyPartAsDefault	(	const SbName &	partName,
		const SbName &	newNodeName,
		bool	anyPart = `TRUE`,
		bool	onlyIfAlready = `TRUE`
	)

protectedvirtual

◆ setAnyPartAsDefault() [2/2]

virtual bool SoInteractionKit::setAnyPartAsDefault	(	const SbName &	partName,
		SoNode *	newNode,
		bool	anyPart = `TRUE`,
		bool	onlyIfAlready = `TRUE`
	)

protectedvirtual

◆ setAnyPartAsPath()

virtual bool SoInteractionKit::setAnyPartAsPath	(	const SbName &	partName,
		SoPath *	surrogatePath,
		bool	leafCheck = `FALSE`,
		bool	publicCheck = `FALSE`
	)

protectedvirtual

Note: The node corresponding to 'partName' will become empty. If 'partName' is not a leaf, the subgraph below it will disappear.

◆ setAnySurrogatePath()

bool SoInteractionKit::setAnySurrogatePath	(	const SbName &	inName,
		SoPath *	inPath,
		bool	leafCheck = `FALSE`,
		bool	publicCheck = `FALSE`
	)

protected

◆ setDefaultOnNonWritingFields()

virtual void SoInteractionKit::setDefaultOnNonWritingFields ( )

protectedvirtual

InteractionKits don't want to write fields if they have default vals.

Calls setDefault(TRUE) on caching fields if default and not connected.

Calls setDefault(TRUE) on the topSeparator. Calls setDefault(TRUE) on the geomSeparator.

Calls setDefault(TRUE) on any non-leaf part of type exactly == SoSwitch. Subclasses can override this if they like, since the function is virtual. But interactionKits use non-leaf switches to turn parts on and off, and this does not need to be written to file.

Lastly, calls same method on SoBaseKit.

NOTE: Parts which are set to default may still wind up writing to file if, for example, they lie on a path.

Reimplemented from SoBaseKit.

Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, and SoTransformerDragger.

◆ setPartAsDefault() [1/2]

virtual bool SoInteractionKit::setPartAsDefault	(	const SbName &	partName,
		const SbName &	newNodeName,
		bool	onlyIfAlready = `TRUE`
	)

virtual

◆ setPartAsDefault() [2/2]

virtual bool SoInteractionKit::setPartAsDefault	(	const SbName &	partName,
		SoNode *	newNode,
		bool	onlyIfAlready = `TRUE`
	)

virtual

Hence 'newNode' becomes the new default value, and the part only writes if [a] the part is set to a different node. [b] values are changes in the fields of newNode. [c] any child below newNode changes.

If the flag 'onlyIfAlready' is TRUE, then this will only change values of parts that are already in a default state.

Returns FALSE on failure, TRUE otherwise. First version sets the part to the given node. Second version looks up resourceName in the global dictionary and sets the part with the node found.

◆ setPartAsPath()

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

virtual

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

◆ setSwitchValue()

static void SoInteractionKit::setSwitchValue	(	SoNode *	n,
		int	newVal
	)

static

◆ setUpConnections()

virtual bool SoInteractionKit::setUpConnections	(	bool	onOff,
		bool	doItAlways = `FALSE`
	)

protectedvirtual

Called by: start/end of SoBaseKit::readInstance and on new copy by: start/end of SoBaseKit::copy. Classes that redefine must call setUpConnections(TRUE,TRUE) at end of constructor. Returns the state of the node when this was called.

Reimplemented from SoBaseKit.

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

Member Data Documentation

◆ boundingBoxCaching

SoSFEnum SoInteractionKit::boundingBoxCaching

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

Definition at line 156 of file SoInteractionKit.h.

◆ fieldSensor

SoFieldSensor* SoInteractionKit::fieldSensor

protected

If the part changes to a new node, then the fields of the old part will be disconnected and the fields of the new part will be connected. Connections are made from/to the renderCaching, boundingBoxCaching, renderCulling and pickCulling fields. This way, the SoInteractionKit can be treated from the outside just like a regular SoSeparator node. Setting the fields will affect caching and culling, even though the topSeparator takes care of it. oldTopSep keeps track of the part for comparison.

Definition at line 294 of file SoInteractionKit.h.

◆ oldTopSep

SoSeparator* SoInteractionKit::oldTopSep

protected

Definition at line 296 of file SoInteractionKit.h.

◆ pickCulling

SoSFEnum SoInteractionKit::pickCulling

Definition at line 164 of file SoInteractionKit.h.

◆ renderCaching

SoSFEnum SoInteractionKit::renderCaching

Definition at line 151 of file SoInteractionKit.h.

◆ renderCulling

SoSFEnum SoInteractionKit::renderCulling

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

Definition at line 161 of file SoInteractionKit.h.

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

C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/nodekits/SoInteractionKit.h

Public Types

Public Member Functions

Fields

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CacheEnabled

Constructor & Destructor Documentation

◆ SoInteractionKit()

◆ ~SoInteractionKit()

Member Function Documentation

◆ affectsState()

◆ connectSeparatorFields()

◆ copyContents()

◆ createPathToAnyPart()

◆ fieldSensorCB()

◆ getAnyPart()

◆ initClass()

◆ isPathSurrogateInMySubgraph() [1/2]

◆ isPathSurrogateInMySubgraph() [2/2]

◆ readDefaultParts()

◆ readInstance()

◆ setAnyPart()

◆ setAnyPartAsDefault() [1/2]

◆ setAnyPartAsDefault() [2/2]

◆ setAnyPartAsPath()

◆ setAnySurrogatePath()

◆ setDefaultOnNonWritingFields()

◆ setPartAsDefault() [1/2]

◆ setPartAsDefault() [2/2]

◆ setPartAsPath()

◆ setSwitchValue()

◆ setUpConnections()

Member Data Documentation

◆ boundingBoxCaching

◆ fieldSensor

◆ oldTopSep

◆ pickCulling

◆ renderCaching

◆ renderCulling