Base class for all node kits. More...

#include <Inventor/nodekits/SoBaseKit.h>

Inheritance diagram for SoBaseKit:

Public Member Functions
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.

Static Public Member Functions
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.

Protected Member Functions
	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
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
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.

Friends
class	SoNodekitCatalogEntry

class	SoNodekitParts

class	SoV1BaseKit

Additional Inherited Members
Public Types inherited from SoNode
enum	Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }

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

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 from which all nodekit nodes are derived. Nodekits provide a convenient mechanism for creating groups of scene graph nodes with some larger meaning. When you create a shape node such as an indexed face set, for example, you almost always precede it with a coordinate node. You may also want to add a transform node or specify properties with material, drawing style, material binding, etc. Instead of creating each of these nodes individually and then arranging them into a subgraph, you can use a nodekit of the appropriate type (in this case, SoShapeKit).

Each class of nodekit has a nodekit catalog (SoNodekitCatalog) that describes the nodes in the subgraph, referred to as parts. The catalog has an entry for each part, with information such as the partName, partType, and nullByDefault (if FALSE the constructor creates it). The catalog also describes the arrangement of parts in the subgraph. (Other information is described below; a complete description is in the SoNodekitCatalog reference page.)

If we regard the scene graph arrangement as a branching tree, then the top node (root) of the arrangement is always the nodekit itself. The leaf nodes are those at the bottom (containing no children). Some leaves of the tree are defined in the catalog to be public parts, while other leaves are private. All non-leaf parts are considered internal to the nodekit structure and are marked private. Public parts are accessible; they may be requested, changed, or set by the programmer with member functions such as getPart(). Private parts are not accessible, so methods such as getPart() will have no effect on them. For example, if you call getPart() to retrieve a private part, NULL will be returned even when the part exists.

Every nodekit reference page has a Parts section describing the function of each public part it adds to those inherited from its parent class. Also, a Catalog Parts section has tables of often-needed information from the catalog (part type, etc.). These tables include all public parts, both new and inherited. Only the public parts of a nodekit are described in the reference pages. Nodekits take care of the rest for you; they automatically arrange the subgraph, creating and deleting the private parts when necessary. (The SoNodekitCatalog reference page has methods for finding out the part names and arrangement of all parts, both public and private.)

The nodekit catalog is a template shared by all instances of a class. They use the shared catalog as a guide when creating parts (i.e., constructing actual nodes), but each instance stores its own parts separately. Moreover, nodekits are not SoGroup nodes, and parts are added as hidden children; you can only access parts with the methods of SoBaseKit and its derived classes.

Any public part may be retrieved with getPart(), installed with setPart(), or removed by giving a NULL argument to setPart(). Paths from the nodekit down to a part can be created by createPathToPart().

By default, parts are not created until the user requests or sets them. This keeps the subgraph uncluttered and efficient for traversal. Additionally, removing a part (setting it to NULL) has the extra effect of removing any internal parts that are no longer needed.

Since nodekits hide their children, any SoPath containing nodekits will end at the topmost nodekit. However, since nodekits may be nested within other nodekits, you may wish to cast an (SoPath *) into an (SoNodeKitPath *). The methods of SoNodeKitPath allow you to view all nodekits that lie on the path (see the reference page for SoNodeKitPath).

Public parts in the nodekit catalog fall into three categories:

[1] regular nodes

[2] nodekits, or nested nodekits (which may nest recursively). Any node which is public in a nested nodekit is accessible to the higher level nodekit(s) that contains it. The description of getPart() below shows how to refer to nested parts by name (e.g., "appearance.material"). This works for any nodekit method that takes a part name for an argument.

[3] lists, or list parts. These parts group together children (list elements) of a particular type or types. As with nested nodekits, you can refer to individual elements using notation described in getPart() (e.g., "childList[0]", or if the list elements are in turn nodekits, "childList[2].transform").

When the catalog denotes that a part is a list, the part itself is always a node of type SoNodeKitListPart. The catalog specifies a set of permissible listItemTypes and a listContainerType for that part. It gives this information to the SoNodeKitListPart when it creates it. From then on, the list part will enforce type checking. So even if you retrieve the SoNodeKitListPart with getPart(), you will not be able to add illegal children. (See the SoNodeKitListPart reference page for more information). As an example, the callbackList part of SoBaseKit has an SoSeparator container and allows only SoCallback and SoEventCallback nodes in the list. Children may be added, retrieved, and removed from an SoNodeKitListPart node using methods that parallel those of SoGroup. However, type-checking is strictly enforced.

Note that, although all public parts are leaves in the nodekit catalog, you are free to add children to them (assuming that they are groups, nodekits, or list parts). A part's status as a leaf in the catalog just means that the nodekit will not manage the part's children. For example, SoWrapperKit has a part called contents with a part type of SoSeparator. You can put whatever you want underneath the separator, as long as contents itself is an SoSeparator.

Thus, a nodekit only controls a section of the scene graph. Above and below that section, anything goes.

However, when nodekits are nested, they effectively create a larger ‘known’ section of the scene graph. For example, the appearance part of the SoSeparatorKit is a leaf node in the SoSeparatorKit catalog. But appearance is in turn an SoAppearanceKit, containing parts such as material and drawStyle. The two nodekits combine to make an even larger template, which the SoSeparatorKit can examine by looking at the catalogs for both classes. So an SoSeparatorKit can successfully return a part named "material"; first it finds (or creates) the appearance part, then it gets the material by calling getPart() on the appearance.

When the catalog defines the listItemTypes of a list part to be nodekits, the name-able space expands further. For example, SoSeparatorKit has a part childList which permits only SoSeparatorKits, so each list element can be further searched. Hence the name "childList[0].childList[1].childList[2].material" is perfectly legal.

Action Behavior

: SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction, SoHandleEventAction
Behaves like an SoGroup. Traverses each child in order.

: SoRayPickAction
Traverses each child in order. Then, for any pick containing the kit on its path, makes an SoNodeKitDetail as follows: Sets the "detailNodeKit" (retrievable with SoNodeKitDetail::getNodeKit()) to be a pointer to itself. Sets the "detailPart" (retrievable with SoNodeKitDetail::getPart()) to be a pointer to the kit's leaf-most part that lies on the pickPath. Sets the "detailPartName" (retrievable with SoNodeKitDetail::getPartName()) to be the partName of that part, as found in the catalog. Does not descend into nested nodekits. Each nodekit along the path is the "detailPart" in its parent's detail. However, if the pick path goes through a list part, a pointer to the child is used for the "detailPart", and "detailPartName" is of the form "listName[i]".

: SoGetMatrixAction
Behaves like an SoGroup. Does nothing unless the kit is in the middle of the path chain the action is being applied to. If so, the children up to and including the next node in the chain are traversed.

: SoSearchAction
First, searches itself like an SoNode. Then, checks the value of isSearchingChildren(). If TRUE, traverses the children in order. If FALSE, returns.

: SoWriteAction
Begins by writing out regular fields, then writes out the parts. A nodekit does not write out its parts the way an SoGroup writes out its children. Instead, it writes each part as an SoSFNode field. First the partName is written, then the node being used for that part. To keep the files terse, nodekits write out as few parts as possible. However, nodekits always write a part if another instance or a path is writing it. If this is not the case, parts are left out according to the following rules: [1] NULL parts only write if the catalog states they are created by default. [2] Empty SoGroup and SoSeparator nodes do not write. [3] Non-leaf parts only write if they have non-default field values. [4] List parts only write if they have children or if the container node has non-default field values. [5] Nested nodekit parts only write if they need to write one or more parts, or if they have non-default field values.

Parts

: callbackList
This is the only part that the base class SoBaseKit creates. It is a public part that is inherited by all nodekits. It provides an easy way to add callbacks for a nodekit to use during action traversal (e.g. SoHandleEventAction). It is a list part and may contain numerous SoCallback and/or SoEventCallback nodes.

See Also

: SoAppearanceKit, SoCameraKit, SoLightKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit

Definition at line 262 of file SoBaseKit.h.

Constructor & Destructor Documentation

◆ SoBaseKit()

SoBaseKit::SoBaseKit ( )

◆ ~SoBaseKit()

virtual SoBaseKit::~SoBaseKit ( )

protectedvirtual

Member Function Documentation

◆ addToCopyDict()

virtual SoNode * SoBaseKit::addToCopyDict ( ) const

protectedvirtual

Reimplemented from SoNode.

◆ addWriteReference()

virtual void SoBaseKit::addWriteReference	(	SoOutput *	out,
		bool	isFromField = `FALSE`
	)

virtual

Reimplemented from SoFieldContainer.

◆ callback()

virtual void SoBaseKit::callback ( SoCallbackAction * action )

virtual

Reimplemented from SoNode.

◆ catalogError()

void SoBaseKit::catalogError ( )

protected

◆ copyContents()

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

protectedvirtual

Reimplemented from SoNode.

Reimplemented in SoRotateCylindricalDragger, SoRotateSphericalDragger, and SoInteractionKit.

◆ countMyFields()

void SoBaseKit::countMyFields ( SoOutput * out )

protected

It sometimes treats fields for parts of the nodekit in a special way. Under normal circumstances, they write like other fields. The special case is when a part-field has a non-NULL value, but has also been set to default, indicating that we would rather not write it. If the part is a regular node, we give it a field-connection style write ref. So it only writes if some other instance of the node forces a write. If the part is a nodekit, then we additionally write ref the fields of the nodekit, using this same method. Later, in the WRITE stage, the kit-part will be written if at least one of its fields or ancestor parts has shouldWrite() ==TRUE. This way, if a nodekit part or any of its ancestors has non-NULL fields, it will later be forced to write, even though it has been set to default. Example: Parent draggers attempt not to write out child draggers. But the parentDragger must at least traverse the childDragger to see if any of the part geometry has been changed from its default. Such changes must be written to file.

◆ createDefaultParts()

virtual void SoBaseKit::createDefaultParts ( )

protectedvirtual

◆ createNodekitPartsList()

void SoBaseKit::createNodekitPartsList ( )

protected

◆ createPathToAnyPart()

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

protectedvirtual

Reimplemented in SoInteractionKit.

◆ createPathToPart()

virtual SoNodeKitPath * SoBaseKit::createPathToPart	(	const SbName &	partName,
		bool	makeIfNeeded,
		const SoPath *	pathToExtend = `NULL`
	)

virtual

Searching for the part is the same as in getPart(). NULL is returned if partName cannot be found,
or if makeIfNeeded is FALSE and the part is not yet built. If the the part is retrieved and the argument pathToExtend is NULL, the path returned begins at this and ends at partName. If pathToExtend is not NULL, the path created is a copy of pathToExtend with entries appended all the way down to partName. It is okay for pathToExtend to go beyond the nodekit; extra nodes will be popped off the tail before continuing from this down to partName.

◆ doAction()

virtual void SoBaseKit::doAction ( SoAction * action )

virtual

The default implementation does nothing.

Reimplemented from SoNode.

◆ forceChildDrivenWriteRefs()

bool SoBaseKit::forceChildDrivenWriteRefs ( SoOutput * out )

[a] call shouldWrite(). If TRUE, trivial return. [b] If the kit thinks it shouldn't write, it first does a recursive call to its children. If any children must write, then so must the kit. [c] If kit has changed its mind because of [b], then add a writeRef.

[d] If kit should not write, it will delete the fieldDataForWriting, since there will no writing pass applied to take care of this.

◆ getAnyPart()

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

protectedvirtual

These are virtual so subclasses may do extra things when certain parts are requested.

Reimplemented in SoInteractionKit.

◆ getBoundingBox()

virtual void SoBaseKit::getBoundingBox ( SoGetBoundingBoxAction * action )

virtual

Reimplemented from SoNode.

Reimplemented in SoCenterballDragger, and SoDragger.

◆ getChildren()

virtual SoChildList * SoBaseKit::getChildren ( ) const

virtual

Reimplemented from SoNode.

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * SoBaseKit::getClassNodekitCatalog ( )

inlinestatic

Definition at line 276 of file SoBaseKit.h.

◆ getClassNodekitCatalogPtr()

static const SoNodekitCatalog ** SoBaseKit::getClassNodekitCatalogPtr ( )

inlinestaticprotected

Definition at line 289 of file SoBaseKit.h.

◆ getContainerNode()

SoGroup * SoBaseKit::getContainerNode	(	const SbName &	listName,
		bool	makeIfNeeded = `TRUE`
	)

protected

◆ getMatrix()

virtual void SoBaseKit::getMatrix ( SoGetMatrixAction * action )

virtual

Reimplemented from SoNode.

Reimplemented in SoCenterballDragger.

◆ getNodekitCatalog()

virtual const SoNodekitCatalog * SoBaseKit::getNodekitCatalog ( ) const

virtual

While each instance of a given class creates its own distinct set of parts (which are actual nodes), all instances share the same catalog (which describes the parts but contains no actual node pointers).

◆ getNodekitPartsList()

const SoNodekitParts * SoBaseKit::getNodekitPartsList ( ) const

inlineprotected

Definition at line 497 of file SoBaseKit.h.

◆ getPart()

virtual SoNode * SoBaseKit::getPart	(	const SbName &	partName,
		bool	makeIfNeeded
	)

virtual

Returns a pointer to the part if a match is found, the part is public, and the part has already been built. If no match is found, or if the part is private, NULL is returned. If partName is in the catalog (or that of one of its nested nodekit parts), but the part has not been built yet, the argument makeIfNeeded determines the course of action. When makeIfNeeded is FALSE, NULL is returned; when makeIfNeeded is TRUE, getPart() will create the part (as well as any necessary intermediary parts), put it in the correct place, and return a pointer to the newly created part.

Elements of list parts and parts within nested nodekits can all be retrieved with getPart() The full syntax for legal partName arguments is given below.

Part name BNF notation:

partName = singleName | compoundName

compoundName = singleName | compoundName.singleName

singleName = singlePartName | singleListElementName

singlePartName = the name of any single part in the catalog (including those that are lists or nodekits), or in the recursively nested catalogs of any of its parts.

singleListElementName = singleListName[index]

singleListName = the name of any single list-type part in the catalog, or in the recursively nested catalogs of any of its parts.

index = integer

Examples of valid part names are:

"transform", "appearance.material", "childList[2].drawStyle", "foot", "bird.leftLeg.foot", "octopus.leg[4].suctionCup[2].material"

◆ getPartString()

SbString SoBaseKit::getPartString ( const SoBase * part )

If so, returns a string describing the part name; otherwise, returns an empty string ("").

◆ GLRender()

virtual void SoBaseKit::GLRender ( SoGLRenderAction * action )

virtual

Reimplemented from SoNode.

Reimplemented in SoTabPlaneDragger.

◆ handleEvent()

virtual void SoBaseKit::handleEvent ( SoHandleEventAction * action )

virtual

Reimplemented from SoNode.

Reimplemented in SoDragger.

◆ initClass()

static void SoBaseKit::initClass ( )

static

◆ isSearchingChildren()

static bool SoBaseKit::isSearchingChildren ( )

inlinestatic

By default, they are not.

Definition at line 408 of file SoBaseKit.h.

◆ printDiagram()

void SoBaseKit::printDiagram ( )

◆ printSubDiagram()

void SoBaseKit::printSubDiagram	(	const SbName &	rootName,
		int	level
	)

◆ printTable()

void SoBaseKit::printTable ( )

◆ rayPick()

virtual void SoBaseKit::rayPick ( SoRayPickAction * action )

virtual

Reimplemented from SoNode.

◆ readInstance()

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

protectedvirtual

Reimplemented from SoFieldContainer.

Reimplemented in SoInteractionKit.

◆ search()

virtual void SoBaseKit::search ( SoSearchAction * action )

virtual

Reimplemented from SoNode.

◆ set() [1/2]

bool SoBaseKit::set ( char * nameValuePairListString )

set routine returns FALSE if it cannot find the parameter to set

◆ set() [2/2]

bool SoBaseKit::set	(	char *	partNameString,
		char *	parameterString
	)

◆ setAnyPart()

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

protectedvirtual

Reimplemented in SoInteractionKit.

◆ setDefaultOnNonWritingFields()

virtual void SoBaseKit::setDefaultOnNonWritingFields ( )

protectedvirtual

It calls setDefault() on those fields we do not wish to write out. setDefault does not change the field value, but it sets a flag indicating that the field should not get written by this node. Fields that we do not write are [a] parts that are NULL and are defined in the catalog to be NULL by default. [b] non-leaf parts for which isNodeFieldValuesImportant() is FALSE. [c] leaf parts that are empty groups, empty separators, [d] leaf parts that are empty lists (but they must have group or separator container nodes.

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

◆ setPart()

virtual bool SoBaseKit::setPart	(	const SbName &	partName,
		SoNode *	from
	)

virtual

See getPart() for the syntax of partName. This method adds any extra nodes needed to fit the part into the nodekit's catalog. For example, if you call:

mySepKit->setPart("childList[0]", myNewChild);

the kit may need to create the part childList before it can install myNewChild. Run-time type checking verifies that the node type of newPart matches the type called for by partName. For example, if partName was a material for an SoSeparatorKit, but newPart was an SoTransform node, then the node would not be installed, and FALSE would be returned.

If newPart is NULL, then the node specified by partName is removed. If this renders any private parts useless (as occurs when you remove the last child of an SoGroup node), they will also be removed. Hence nodekits do not retain unnecessary nodes.

TRUE is returned on success, and FALSE upon error.

◆ setSearchingChildren()

static void SoBaseKit::setSearchingChildren ( bool newVal )

static

By default, they are not.

◆ setUpConnections()

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

protectedvirtual

Called by: start/end of SoBaseKit::readInstance and on new copy by: start/end of SoBaseKit::copyContents. Classes that redefine must call setUpConnections(TRUE,TRUE) at end of constructor to add their own connections to the ones already connected by the base classes. The doItAlways flag can force the method to do the work. But if (doItAlways == FALSE && onOff == connectionsSetUp), then the method will return immediately without doing anything. Returns the state of the node when this was called.

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

◆ SO_KIT_CATALOG_ENTRY_HEADER()

SoBaseKit::SO_KIT_CATALOG_ENTRY_HEADER ( callbackList )

protected

◆ typeCheck()

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

static

◆ write()

virtual void SoBaseKit::write ( SoWriteAction * action )

virtual

Reimplemented from SoNode.

Friends And Related Symbol Documentation

◆ SoNodekitCatalogEntry

friend class SoNodekitCatalogEntry

friend

Definition at line 443 of file SoBaseKit.h.

◆ SoNodekitParts

friend class SoNodekitParts

friend

Definition at line 444 of file SoBaseKit.h.

◆ SoV1BaseKit

friend class SoV1BaseKit

friend

Definition at line 445 of file SoBaseKit.h.

Member Data Documentation

◆ children

SoChildList* SoBaseKit::children

protected

Definition at line 460 of file SoBaseKit.h.

◆ connectionsSetUp

bool SoBaseKit::connectionsSetUp

protected

Definition at line 514 of file SoBaseKit.h.

◆ nodekitPartsList

SoNodekitParts* SoBaseKit::nodekitPartsList

protected

Definition at line 488 of file SoBaseKit.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/SoBaseKit.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoBaseKit()

◆ ~SoBaseKit()

Member Function Documentation

◆ addToCopyDict()

◆ addWriteReference()

◆ callback()

◆ catalogError()

◆ copyContents()

◆ countMyFields()

◆ createDefaultParts()

◆ createNodekitPartsList()

◆ createPathToAnyPart()

◆ createPathToPart()

◆ doAction()

◆ forceChildDrivenWriteRefs()

◆ getAnyPart()

◆ getBoundingBox()

◆ getChildren()

◆ getClassNodekitCatalog()

◆ getClassNodekitCatalogPtr()

◆ getContainerNode()

◆ getMatrix()

◆ getNodekitCatalog()

◆ getNodekitPartsList()

◆ getPart()

◆ getPartString()

◆ GLRender()

◆ handleEvent()

◆ initClass()

◆ isSearchingChildren()

◆ printDiagram()

◆ printSubDiagram()

◆ printTable()

◆ rayPick()

◆ readInstance()

◆ search()

◆ set() [1/2]

◆ set() [2/2]

◆ setAnyPart()

◆ setDefaultOnNonWritingFields()

◆ setPart()

◆ setSearchingChildren()

◆ setUpConnections()

◆ SO_KIT_CATALOG_ENTRY_HEADER()

◆ typeCheck()

◆ write()

Friends And Related Symbol Documentation

◆ SoNodekitCatalogEntry

◆ SoNodekitParts

◆ SoV1BaseKit

Member Data Documentation

◆ children

◆ connectionsSetUp

◆ nodekitPartsList