Group node with restricted children. More...

#include <Inventor/nodekits/SoNodeKitListPart.h>

Inheritance diagram for SoNodeKitListPart:

Public Member Functions
	SoNodeKitListPart ()
	Constructor.

SoType	getContainerType () const
	Gets and sets the type of node used as the container.

void	setContainerType (SoType newContainerType)
	Gets and sets the type of node used as the container.

const SoTypeList &	getChildTypes () const
	Returns the permitted child node types.

void	addChildType (SoType typeToAdd)
	Permits the node type `typeToAdd` as a child.

bool	isTypePermitted (SoType typeToCheck) const
	Returns whether a node of type `typeToCheck` may be added as a child.

bool	isChildPermitted (const SoNode *child) const
	Returns whether the node `child` may be added to this list.

void	containerSet (const char *fieldDataString)
	Sends a string to the set() method on the container node.

void	lockTypes ()
	This function permanently locks the permitted child types and the container type permanently.

bool	isTypeLocked () const
	Returns whether the permitted child types and the container type are locked (i.e.

void	addChild (SoNode *child)
	These are the functions used to edit the children.

void	insertChild (SoNode *child, int childIndex)
	These are the functions used to edit the children.

SoNode *	getChild (int index) const
	These are the functions used to edit the children.

int	findChild (SoNode *child) const
	These are the functions used to edit the children.

int	getNumChildren () const
	These are the functions used to edit the children.

void	removeChild (int index)
	These are the functions used to edit the children.

void	removeChild (SoNode *child)
	These are the functions used to edit the children.

void	replaceChild (int index, SoNode *newChild)
	These are the functions used to edit the children.

void	replaceChild (SoNode oldChild, SoNode newChild)
	These are the functions used to edit the children.

virtual bool	affectsState () const
	Depending on the type of the container, this may or may not affect the state.

virtual void	doAction (SoAction *action)
	These functions implement all actions for nodekits.

virtual void	callback (SoCallbackAction *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	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	pick (SoPickAction *action)

virtual void	search (SoSearchAction *action)

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

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 void	initClass ()

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
SoGroup *	getContainerNode ()

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

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

virtual	~SoNodeKitListPart ()

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.

Protected Attributes
SoChildList *	children

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	SoBaseKit

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

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 node class is very similar to SoGroup with the exception that it specifies restrictions on the type of children that it allows. It is used by nodekits to restrict child types within list parts (see the reference page for SoBaseKit).

By default, any kind of child may be added. Methods of this class allow you to restrict the type of allowable children, and to lock down the types so that this type list may no longer be altered.

Inside the SoNodeKitListPart is a container node, which in turn contains the children. The container node is a hidden child, and the type of node used may be set with setContainerType(). In this way, you can make the nodekitlist behave like a group, a separator, or any other subclass of group. The container is not accessible so that the nodekitlist may retain control over what kinds of children are added.

See Also

: SoBaseKit, SoNodeKit, SoNodeKitDetail, SoNodeKitPath, SoNodekitCatalog, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit

Definition at line 121 of file SoNodeKitListPart.h.

Constructor & Destructor Documentation

◆ SoNodeKitListPart()

SoNodeKitListPart::SoNodeKitListPart ( )

◆ ~SoNodeKitListPart()

virtual SoNodeKitListPart::~SoNodeKitListPart ( )

protectedvirtual

Member Function Documentation

◆ addChild()

void SoNodeKitListPart::addChild ( SoNode * child )

They parallel those of SoGroup, except that they always check the child types against those which are permissible. See SoGroup for details.

◆ addChildType()

void SoNodeKitListPart::addChildType ( SoType typeToAdd )

The first time the addChildType() method is called, the default of SoNode is overridden and only the new typeToAdd is permitted. In subsequent calls to addChildType(), the typeToAdd is added to the existing types.

◆ affectsState()

virtual bool SoNodeKitListPart::affectsState ( ) const

virtual

Reimplemented from SoNode.

◆ callback()

virtual void SoNodeKitListPart::callback ( SoCallbackAction * action )

virtual

Reimplemented from SoNode.

◆ containerSet()

void SoNodeKitListPart::containerSet ( const char * fieldDataString )

This is how you can set the value of a switch node if the container node is an SoSwitch, for example.

◆ copyContents()

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

protectedvirtual

Reimplemented from SoNode.

◆ doAction()

virtual void SoNodeKitListPart::doAction ( SoAction * action )

virtual

Reimplemented from SoNode.

◆ findChild()

int SoNodeKitListPart::findChild ( SoNode * child ) const

They parallel those of SoGroup, except that they always check the child types against those which are permissible. See SoGroup for details.

◆ getBoundingBox()

virtual void SoNodeKitListPart::getBoundingBox ( SoGetBoundingBoxAction * action )

virtual

Reimplemented from SoNode.

◆ getChild()

SoNode * SoNodeKitListPart::getChild ( int index ) const

They parallel those of SoGroup, except that they always check the child types against those which are permissible. See SoGroup for details.

◆ getChildren()

virtual SoChildList * SoNodeKitListPart::getChildren ( ) const

virtual

Reimplemented from SoNode.

◆ getChildTypes()

const SoTypeList & SoNodeKitListPart::getChildTypes ( ) const

By default, any type of node is permitted, so the list contains one entry of type SoNode.

◆ getContainerNode()

SoGroup * SoNodeKitListPart::getContainerNode ( )

protected

◆ getContainerType()

SoType SoNodeKitListPart::getContainerType ( ) const

◆ getMatrix()

virtual void SoNodeKitListPart::getMatrix ( SoGetMatrixAction * action )

virtual

Reimplemented from SoNode.

◆ getNumChildren()

int SoNodeKitListPart::getNumChildren ( ) const

They parallel those of SoGroup, except that they always check the child types against those which are permissible. See SoGroup for details.

◆ GLRender()

virtual void SoNodeKitListPart::GLRender ( SoGLRenderAction * action )

virtual

Reimplemented from SoNode.

◆ handleEvent()

virtual void SoNodeKitListPart::handleEvent ( SoHandleEventAction * action )

virtual

Reimplemented from SoNode.

◆ initClass()

static void SoNodeKitListPart::initClass ( )

static

◆ insertChild()

void SoNodeKitListPart::insertChild	(	SoNode *	child,
		int	childIndex
	)

They parallel those of SoGroup, except that they always check the child types against those which are permissible. See SoGroup for details.

◆ isChildPermitted()

bool SoNodeKitListPart::isChildPermitted ( const SoNode * child ) const

This will return TRUE if the type of child is one of the permissible child types.

◆ isTypeLocked()

bool SoNodeKitListPart::isTypeLocked ( ) const

inline

cannot be changed). See lockTypes()

Definition at line 175 of file SoNodeKitListPart.h.

◆ isTypePermitted()

bool SoNodeKitListPart::isTypePermitted ( SoType typeToCheck ) const

◆ lockTypes()

void SoNodeKitListPart::lockTypes ( )

Calls to setContainerType() and addChildType() will have no effect after this function is called.

◆ pick()

virtual void SoNodeKitListPart::pick ( SoPickAction * action )

virtual

Reimplemented from SoNode.

◆ readInstance()

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

protectedvirtual

Reimplemented from SoFieldContainer.

◆ removeChild() [1/2]

void SoNodeKitListPart::removeChild ( int index )

They parallel those of SoGroup, except that they always check the child types against those which are permissible. See SoGroup for details.

◆ removeChild() [2/2]

void SoNodeKitListPart::removeChild ( SoNode * child )

inline

They parallel those of SoGroup, except that they always check the child types against those which are permissible. See SoGroup for details.

Definition at line 211 of file SoNodeKitListPart.h.

◆ replaceChild() [1/2]

void SoNodeKitListPart::replaceChild	(	int	index,
		SoNode *	newChild
	)

They parallel those of SoGroup, except that they always check the child types against those which are permissible. See SoGroup for details.

◆ replaceChild() [2/2]

void SoNodeKitListPart::replaceChild	(	SoNode *	oldChild,
		SoNode *	newChild
	)

inline

They parallel those of SoGroup, except that they always check the child types against those which are permissible. See SoGroup for details.

Definition at line 222 of file SoNodeKitListPart.h.

◆ search()

virtual void SoNodeKitListPart::search ( SoSearchAction * action )

virtual

Reimplemented from SoNode.

◆ setContainerType()

void SoNodeKitListPart::setContainerType ( SoType newContainerType )

Friends And Related Symbol Documentation

◆ SoBaseKit

friend class SoBaseKit

friend

Definition at line 273 of file SoNodeKitListPart.h.

Member Data Documentation

◆ children

SoChildList* SoNodeKitListPart::children

protected

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoNodeKitListPart()

◆ ~SoNodeKitListPart()

Member Function Documentation

◆ addChild()

◆ addChildType()

◆ affectsState()

◆ callback()

◆ containerSet()

◆ copyContents()

◆ doAction()

◆ findChild()

◆ getBoundingBox()

◆ getChild()

◆ getChildren()

◆ getChildTypes()

◆ getContainerNode()

◆ getContainerType()

◆ getMatrix()

◆ getNumChildren()

◆ GLRender()

◆ handleEvent()

◆ initClass()

◆ insertChild()

◆ isChildPermitted()

◆ isTypeLocked()

◆ isTypePermitted()

◆ lockTypes()

◆ pick()

◆ readInstance()

◆ removeChild() [1/2]

◆ removeChild() [2/2]

◆ replaceChild() [1/2]

◆ replaceChild() [2/2]

◆ search()

◆ setContainerType()

Friends And Related Symbol Documentation

◆ SoBaseKit

Member Data Documentation

◆ children