SoSeparatorKit Class Reference

Separator nodekit class. More...

#include <Inventor/nodekits/SoSeparatorKit.h>

Inheritance diagram for SoSeparatorKit:

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 }

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 culling mode. Default is AUTO.
SoFieldSensor *	fieldSensor
	This sensor will watch the topSeparator part.
SoSeparator *	oldTopSep
	SoSeparatorKit ()
	Constructor.
virtual bool	affectsState () const
	Overrides default method on SoNode.
static void	initClass ()
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)
virtual	~SoSeparatorKit ()
static void	fieldSensorCB (void *, SoSensor *)

Additional Inherited Members
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.
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

A nodekit that is used for creating nodekit hierarchies. SoSeparatorKit contains a transform part, a childList part, and a few others in its catalog. The transform part (an SoTransform node) affects all of the children in the childList. Each of these children must be an SoSeparatorKit or from a class that is derived from SoSeparatorKit (e.g., SoShapeKit and SoWrapperKit). Since all members of the childList are in turn SoSeparatorKits, and each contains a transform, these nested lists allow you to create a hierarchy of motion, in which each transform affects an entire subgraph of nodekits.

The other parts added to the catalog for the SoSeparatorKit are pickStyle, appearance, units and texture2Transform.
Furthermore, since SoSeparator is derived from SoBaseKit, it inherits the callbackList part. This is a list of SoCallback and/or SoEventCallback nodes which enable the SoSeparatorKit to perform special callbacks whenever an action is applied to it.

By creating the pickStyle part, a user can alter the pick style for the entire nodekit hierarchy. The appearance part is an SoAppearanceKit nodekit. Note that all parts contained in the SoAppearanceKit catalog can be accessed as if they were part of the SoSeparatorKit. For example:

myMtl = mySepKit->getPart("material",TRUE)

and

mySepKit->setPart("material",myMtl)

See SoBaseKit for further explanation.

Parts

pickStyle
An SoPickStyle property node that can be used to set the picking style of its children. This part is NULL by default, but is created automatically if necessary.

appearance
An SoAppearanceKit nodekit which can be used to set the appearance properties of its children. This part is NULL by default, but is created automatically if necessary.

units
An SoUnits node which can be used to set the types of units, (e.g., feet), of its children. This part is NULL by default, but is created automatically if necessary.

transform
An SoTransform node which can be used to set the overall position, orientation, and scale of its children. This part is NULL by default, but is created automatically if necessary.

texture2Transform
An SoTexture2Transform node which can be used to apply a transformation to any textures used by its children. This part is NULL by default, but is created automatically if necessary.

childList
This part contains the children nodekits of this SoSeparatorKit. This part is a list part and can have multiple children. This part is NULL by default, but is created automatically when the first child is added to the childList. Also, when asked to build a member of the childList, the separatorKit will build an SoShapeKit by default. So if the childList part is NULL, and you call: getPart("childList[0]", TRUE), the separator kit will create the childList and add an SoShapeKit as the new element in the list.

See Also

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

Definition at line 133 of file SoSeparatorKit.h.

Member Enumeration Documentation

CacheEnabled

enum SoSeparatorKit::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 149 of file SoSeparatorKit.h.

Constructor & Destructor Documentation

SoSeparatorKit()

SoSeparatorKit::SoSeparatorKit

(

)

~SoSeparatorKit()

virtual SoSeparatorKit::~SoSeparatorKit ( )

protectedvirtual

Member Function Documentation

affectsState()

virtual bool SoSeparatorKit::affectsState ( ) const

virtual

Reimplemented from SoNode.

connectSeparatorFields()

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

protected

fieldSensorCB()

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

staticprotected

initClass()

static void SoSeparatorKit::initClass ( )

static

setDefaultOnNonWritingFields()

virtual void SoSeparatorKit::setDefaultOnNonWritingFields ( )

protectedvirtual

Calls setDefault(TRUE) on the topSeparator. Note that this may be overriden later by basekit if, for example, topSeparator lies on a path that is being written out.

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit.

setUpConnections()

virtual bool SoSeparatorKit::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.

Member Data Documentation

boundingBoxCaching

SoSFEnum SoSeparatorKit::boundingBoxCaching

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

Definition at line 164 of file SoSeparatorKit.h.

fieldSensor

SoFieldSensor* SoSeparatorKit::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 SoSeparatorKit 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 209 of file SoSeparatorKit.h.

oldTopSep

SoSeparator* SoSeparatorKit::oldTopSep

protected

Definition at line 211 of file SoSeparatorKit.h.

pickCulling

SoSFEnum SoSeparatorKit::pickCulling

Definition at line 172 of file SoSeparatorKit.h.

renderCaching

SoSFEnum SoSeparatorKit::renderCaching

Definition at line 159 of file SoSeparatorKit.h.

renderCulling

SoSFEnum SoSeparatorKit::renderCulling

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

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