The SoSeparatorKit class provides a typical set of nodes to influence a shape subgraph. More...

#include <Inventor/nodekits/SoSeparatorKit.h>

Inheritance diagram for SoSeparatorKit:

Public Types
enum	CacheEnabled { OFF, ON, AUTO }

Public Types inherited from SoNode
enum	NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

Public Member Functions
virtual SoType	getTypeId (void) const
	Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. More...

virtual const SoNodekitCatalog *	getNodekitCatalog (void) const

	SoSeparatorKit (void)

Public Member Functions inherited from SoBaseKit
	SoBaseKit (void)

virtual SoNode *	getPart (const SbName &partname, SbBool makeifneeded)

SbString	getPartString (const SoBase *part)

virtual SoNodeKitPath *	createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL)

virtual SbBool	setPart (const SbName &partname, SoNode *from)

SbBool	set (const char *namevaluepairliststring)

SbBool	set (const char partnamestring, const char parameterstring)

virtual void	doAction (SoAction *action)

virtual void	callback (SoCallbackAction *action)

virtual void	GLRender (SoGLRenderAction *action)

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 void	getPrimitiveCount (SoGetPrimitiveCountAction *action)

virtual SoChildList *	getChildren (void) const

void	printDiagram (void)

void	printSubDiagram (const SbName &rootname, int level)

void	printTable (void)

virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

SbBool	forceChildDrivenWriteRefs (SoOutput *out)

Public Member Functions inherited from SoNode
void	setOverride (const SbBool state)

SbBool	isOverride (void) const

void	setNodeType (const NodeType type)

NodeType	getNodeType (void) const

virtual SoNode *	copy (SbBool copyconnections=FALSE) const

virtual SbBool	affectsState (void) const

virtual void	GLRenderBelowPath (SoGLRenderAction *action)

virtual void	GLRenderInPath (SoGLRenderAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

virtual void	pick (SoPickAction *action)

virtual void	audioRender (SoAudioRenderAction *action)

virtual void	grabEventsSetup (void)

virtual void	grabEventsCleanup (void)

virtual void	startNotify (void)

virtual void	notify (SoNotList *l)

SbUniqueId	getNodeId (void) const

virtual void	writeInstance (SoOutput *out)

virtual SoFieldContainer *	copyThroughConnection (void) const

Public Member Functions inherited from SoFieldContainer
void	setToDefaults (void)

SbBool	hasDefaultValues (void) const

SbBool	fieldsAreEqual (const SoFieldContainer *container) const

void	copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)

SbBool	set (const char *const fielddata)

void	get (SbString &fielddata)

virtual int	getFields (SoFieldList &l) const

virtual int	getAllFields (SoFieldList &l) const

virtual SoField *	getField (const SbName &name) const

virtual SoField *	getEventIn (const SbName &name) const

virtual SoField *	getEventOut (const SbName &name) const

SbBool	getFieldName (const SoField *const field, SbName &name) const

SbBool	enableNotify (const SbBool flag)

SbBool	isNotifyEnabled (void) const

SbBool	set (const char fielddata, SoInput input)

void	get (SbString &fielddata, SoOutput *out)

virtual SbBool	validateNewFieldValue (SoField field, void newval)

SbBool	getIsBuiltIn (void) const

virtual void	getFieldsMemorySize (size_t &managed, size_t &unmanaged) const

void	setUserData (void *userdata) const

void *	getUserData (void) const

Public Member Functions inherited from SoBase
void	ref (void) const

void	unref (void) const

void	unrefNoDelete (void) const

int32_t	getRefCount (void) const

void	touch (void)

SbBool	isOfType (SoType type) const
	Returns `TRUE` if the type of this object is either of the same type or inherited from type. More...

virtual SbName	getName (void) const

virtual void	setName (const SbName &newname)

void	addAuditor (void *const auditor, const SoNotRec::Type type)

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

const SoAuditorList &	getAuditors (void) const

SbBool	shouldWrite (void)

void	assertAlive (void) const

Static Public Member Functions
static SoType	getClassTypeId (void)

static const SoNodekitCatalog *	getClassNodekitCatalog (void)

static void	initClass (void)

Static Public Member Functions inherited from SoBaseKit
static SoType	getClassTypeId (void)

static void	initClass (void)

static const SoNodekitCatalog *	getClassNodekitCatalog (void)

static SbBool	isSearchingChildren (void)

static void	setSearchingChildren (const SbBool newval)

Static Public Member Functions inherited from SoNode
static uint32_t	getCompatibilityTypes (const SoType &nodetype)

static SoType	getClassTypeId (void)

static SoNode *	getByName (const SbName &name)

static int	getByName (const SbName &name, SoNodeList &l)

static void	initClass (void)

static void	initClasses (void)

static SbUniqueId	getNextNodeId (void)

static int	getActionMethodIndex (const SoType type)

static void	getBoundingBoxS (SoAction action, SoNode node)

static void	GLRenderS (SoAction action, SoNode node)

static void	callbackS (SoAction action, SoNode node)

static void	getMatrixS (SoAction action, SoNode node)

static void	handleEventS (SoAction action, SoNode node)

static void	pickS (SoAction action, SoNode node)

static void	rayPickS (SoAction action, SoNode node)

static void	searchS (SoAction action, SoNode node)

static void	writeS (SoAction action, SoNode node)

static void	audioRenderS (SoAction action, SoNode node)

static void	getPrimitiveCountS (SoAction action, SoNode node)

Static Public Member Functions inherited from SoFieldContainer
static void	initClass (void)

static SoType	getClassTypeId (void)

static void	cleanupClass (void)

static void	initCopyDict (void)

static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, const SbBool copyconnections)

static void	copyDone (void)

Static Public Member Functions inherited from SoBase
static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static void	addName (SoBase const base, const char const name)

static void	removeName (SoBase const base, const char const name)

static void	incrementCurrentWriteCounter (void)

static void	decrementCurrentWriteCounter (void)

static SoBase *	getNamedBase (const SbName &name, SoType type)

static int	getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)

static SbBool	read (SoInput input, SoBase &base, SoType expectedtype)

static void	setInstancePrefix (const SbString &c)

static void	setTraceRefs (SbBool trace)

static SbBool	getTraceRefs (void)

static SbBool	connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)

static SbBool	readRoute (SoInput *input)

Public Attributes
SoSFEnum	renderCaching

SoSFEnum	boundingBoxCaching

SoSFEnum	renderCulling

SoSFEnum	pickCulling

Protected Member Functions
virtual const SoFieldData *	getFieldData (void) const

virtual	~SoSeparatorKit ()

virtual void	setDefaultOnNonWritingFields (void)

virtual SbBool	setUpConnections (SbBool onoff, SbBool doitalways=FALSE)

Protected Member Functions inherited from SoBaseKit
virtual	~SoBaseKit ()

virtual SoNode *	addToCopyDict (void) const

virtual void	copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)

SoGroup *	getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE)

virtual SoNode *	getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)

virtual SoNodeKitPath *	createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL)

virtual SbBool	setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE)

void	createNodekitPartsList (void)

void	createFieldList (void)

virtual void	createDefaultParts (void)

const SoNodekitParts *	getNodekitPartsList (void) const

const SbList< SoSFNode * > &	getCatalogInstances (void) const

void	catalogError (void)

virtual SbBool	readInstance (SoInput *in, unsigned short flags)

void	countMyFields (SoOutput *out)

virtual SbBool	setPart (const int partNum, SoNode *node)

Protected Member Functions inherited from SoNode
	SoNode (void)

virtual	~SoNode ()

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer (void)

virtual	~SoFieldContainer ()

Protected Member Functions inherited from SoBase
	SoBase (void)

virtual	~SoBase ()

virtual void	destroy (void)

SbBool	hasMultipleWriteRefs (void) const

SbBool	writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const

void	writeFooter (SoOutput *out) const

virtual const char *	getFileFormatName (void) const

virtual SoNotRec	createNotRec (void)

Static Protected Member Functions
static const SoFieldData **	getFieldDataPtr (void)

static const SoNodekitCatalog **	getClassNodekitCatalogPtr (void)

Static Protected Member Functions inherited from SoBaseKit
static const SoFieldData **	getFieldDataPtr (void)

static const SoNodekitCatalog **	getClassNodekitCatalogPtr (void)

Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr (void)

static void	setNextActionMethodIndex (int index)

static int	getNextActionMethodIndex (void)

static void	incNextActionMethodIndex (void)

static void	setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)

static void	staticDataLock (void)

static void	staticDataUnlock (void)

Protected Attributes
SoSFNode	appearance

SoSFNode	childList

SoSFNode	pickStyle

SoSFNode	texture2Transform

SoSFNode	topSeparator

SoSFNode	transform

SoSFNode	units

Protected Attributes inherited from SoBaseKit
SoSFNode	callbackList

SoChildList *	children

SbBool	connectionsSetUp

Protected Attributes inherited from SoNode
SbUniqueId	uniqueId

Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

Additional Inherited Members
Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Static Protected Attributes inherited from SoNode
static SbUniqueId	nextUniqueId = 1

static int	nextActionMethodIndex = 0

Detailed Description

The SoSeparatorKit class provides a typical set of nodes to influence a shape subgraph.

Node kit structure (new entries versus parent class marked with arrow prefix):

CLASS SoSeparatorKit
-->"this"
      "callbackList"
-->   "topSeparator"
-->      "pickStyle"
-->      "appearance"
-->      "units"
-->      "transform"
-->      "texture2Transform"
-->      "childList"

(See SoBaseKit::printDiagram() for information about the output formatting.)

Detailed information on catalog parts:

CLASS SoSeparatorKit
PVT   "this",  SoSeparatorKit  --- 
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ] 
PVT   "topSeparator",  SoSeparator  --- 
      "pickStyle",  SoPickStyle  --- 
      "appearance",  SoAppearanceKit  --- 
      "units",  SoUnits  --- 
      "transform",  SoTransform  --- 
      "texture2Transform",  SoTexture2Transform  --- 
      "childList",  SoNodeKitListPart [ SoShapeKit, SoSeparatorKit ]

(See SoBaseKit::printTable() for information about the output formatting.)

Member Enumeration Documentation

◆ CacheEnabled

enum SoSeparatorKit::CacheEnabled

Contains the same values with the same semantics as in the enum with the same name in SoSeparator. See documentation of SoSeparator::CacheEnabled.

Constructor & Destructor Documentation

◆ SoSeparatorKit()

SoSeparatorKit::SoSeparatorKit ( void )

Constructor.

◆ ~SoSeparatorKit()

SoSeparatorKit::~SoSeparatorKit ( )

protectedvirtual

Destructor.

Member Function Documentation

◆ getTypeId()

SoType SoSeparatorKit::getTypeId ( void ) const

virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit, and SoWrapperKit.

◆ getFieldData()

const SoFieldData * SoSeparatorKit::getFieldData ( void ) const

protectedvirtual

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit, and SoWrapperKit.

◆ getNodekitCatalog()

const SoNodekitCatalog * SoSeparatorKit::getNodekitCatalog ( void ) const

virtual

Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit, and SoWrapperKit.

◆ initClass()

void SoSeparatorKit::initClass ( void )

static

Does initialization common for all objects of the SoSeparatorKit class. This includes setting up the type system, among other things.

◆ setDefaultOnNonWritingFields()

void SoSeparatorKit::setDefaultOnNonWritingFields ( void )

protectedvirtual

(Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers. If you indeed are writing extensions, see the information in the SoBaseKit class documentation.)

This is a virtual method, and the code in it should call SoField::setDefault() with argument TRUE on part fields that should not be written upon scenegraph export operations.

This is typically done when:

field value is NULL and part is NULL by default
it is a leaf SoGroup or SoSeparator node with no children
it is a leaf listpart with no children and an SoGroup or SoSeparator container
it is a non-leaf part and it's of SoGroup type and all fields are at their default values

Subclasses should usually override this to do additional settings for new member fields. From the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method.

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit.

◆ setUpConnections()

SbBool SoSeparatorKit::setUpConnections	(	SbBool	onoff,
		SbBool	doitalways = `FALSE`
	)

protectedvirtual

Sets up all internal connections for instances of this class.

(This method will usually not be of interest to the application programmer, unless you want to extend the library with new custom nodekits or dragger classes. If so, see the SoBaseKit class documentation.)

Reimplemented from SoBaseKit.

Member Data Documentation

◆ renderCaching

SoSFEnum SoSeparatorKit::renderCaching

See documentation for SoSeparator::renderCaching.

◆ boundingBoxCaching

SoSFEnum SoSeparatorKit::boundingBoxCaching

See documentation for SoSeparator::boundingBoxCaching.

◆ renderCulling

SoSFEnum SoSeparatorKit::renderCulling

See documentation for SoSeparator::renderCulling.

◆ pickCulling

SoSFEnum SoSeparatorKit::pickCulling

See documentation for SoSeparator::pickCulling.

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

SoSeparatorKit.h
SoSeparatorKit.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CacheEnabled

Constructor & Destructor Documentation

◆ SoSeparatorKit()

◆ ~SoSeparatorKit()

Member Function Documentation

◆ getTypeId()

◆ getFieldData()

◆ getNodekitCatalog()

◆ initClass()

◆ setDefaultOnNonWritingFields()

◆ setUpConnections()

Member Data Documentation

◆ renderCaching

◆ boundingBoxCaching

◆ renderCulling

◆ pickCulling