SoProtoInstance Class Reference

The SoProtoInstance class handles PROTO instances. More...

#include <Inventor/misc/SoProtoInstance.h>

Inheritance diagram for SoProtoInstance:

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...
	SoProtoInstance (SoProto *proto, const SoFieldData *deffielddata)
void	setRootNode (SoNode *root)
SoNode *	getRootNode (void)
SoProto *	getProtoDefinition (void) const
SbName	getProtoName (void) const
virtual void	write (SoWriteAction *action)
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	doAction (SoAction *action)
virtual void	GLRender (SoGLRenderAction *action)
virtual void	GLRenderBelowPath (SoGLRenderAction *action)
virtual void	GLRenderInPath (SoGLRenderAction *action)
virtual void	GLRenderOffPath (SoGLRenderAction *action)
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	audioRender (SoAudioRenderAction *action)
virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void	grabEventsSetup (void)
virtual void	grabEventsCleanup (void)
virtual void	startNotify (void)
virtual void	notify (SoNotList *l)
SbUniqueId	getNodeId (void) const
virtual SoChildList *	getChildren (void) const
virtual void	writeInstance (SoOutput *out)
virtual SoNode *	addToCopyDict (void) const
virtual void	copyContents (const SoFieldContainer *from, SbBool copyconnections)
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)
virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
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 void	initClass (void)
static SoProtoInstance *	findProtoInstance (const SoNode *rootnode)
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)

Protected Member Functions
virtual const SoFieldData *	getFieldData (void) const
virtual	~SoProtoInstance ()
virtual SbBool	readInstance (SoInput *in, unsigned short flags)
virtual const char *	getFileFormatName (void) const
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 SoNotRec	createNotRec (void)

Additional Inherited Members
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 }
Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
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 inherited from SoNode
SbUniqueId	uniqueId
Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn
Static Protected Attributes inherited from SoNode
static SbUniqueId	nextUniqueId = 1
static int	nextActionMethodIndex = 0

Detailed Description

The SoProtoInstance class handles PROTO instances.

See also

SoProto

Constructor & Destructor Documentation

SoProtoInstance()

SoProtoInstance::SoProtoInstance	(	SoProto *	proto,
		const SoFieldData *	deffielddata
	)

Constructor.

~SoProtoInstance()

SoProtoInstance::~SoProtoInstance ( )

protectedvirtual

Destructor.

Member Function Documentation

getTypeId()

SoType SoProtoInstance::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.

Implements SoBase.

getFieldData()

const SoFieldData * SoProtoInstance::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 SoFieldContainer.

findProtoInstance()

SoProtoInstance * SoProtoInstance::findProtoInstance ( const SoNode *  rootnode )

static

Given root node rootnode, return the PROTO instance, or NULL if rootnode is not a PROTO instance root node.

setRootNode()

void SoProtoInstance::setRootNode

(

SoNode *

root

)

Sets the root node for this instance.

getRootNode()

SoNode * SoProtoInstance::getRootNode

(

void

)

Returns the instance root node.

getProtoDefinition()

SoProto * SoProtoInstance::getProtoDefinition

(

void

)

const

Returns the PROTO definition for this instance.

getProtoName()

SbName SoProtoInstance::getProtoName

(

void

)

const

Returns the PROTO defintion name.

write()

void SoProtoInstance::write ( SoWriteAction *  action )

virtual

Action method for SoWriteAction.

Writes out a node object, and any connected nodes, engines etc, if necessary.

Reimplemented from SoNode.

readInstance()

SbBool SoProtoInstance::readInstance ( SoInput *  in, unsigned short  flags  )

protectedvirtual

This method is mainly intended for internal use during file import operations.

It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. The import process should be robust and handle corrupted input streams by returning FALSE.

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

Reimplemented from SoNode.

getFileFormatName()

const char * SoProtoInstance::getFileFormatName ( void  ) const

protectedvirtual

Returns the class name this object should be written under. Default string returned is the name of the class from the type system.

User extensions nodes and engines override this method to return the name of the extension (instead of "UnknownNode" or "UnknownEngine").

Reimplemented from SoBase.

---

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

• SoProtoInstance.h
• SoProtoInstance.cpp