The SoProto class handles PROTO definitions. More...

#include <Inventor/misc/SoProto.h>

Inheritance diagram for SoProto:

Public Member Functions
	SoProto (const SbBool externproto=FALSE)

void	addISReference (SoNode *container, const SbName &fieldname, const SbName &interfacename)

void	addReference (const SbName &name, SoBase *base)

void	addRoute (const SbName &fromnode, const SbName &fromfield, const SbName &tonode, const SbName &tofield)

SoProtoInstance *	createProtoInstance (void)

SbName	findISReference (const SoFieldContainer *container, const SbName &fieldname)

SoBase *	findReference (const SbName &name) const

SbName	getProtoName (void) const

virtual SoType	getTypeId (void) const
	Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

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

void	removeReference (const SbName &name)

virtual void	write (SoWriteAction *action)

Public Member Functions inherited from SoNode
virtual SoNode *	addToCopyDict (void) const

virtual SbBool	affectsState (void) const

virtual void	audioRender (SoAudioRenderAction *action)

virtual void	callback (SoCallbackAction *action)

virtual SoNode *	copy (SbBool copyconnections=FALSE) const

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

virtual SoFieldContainer *	copyThroughConnection (void) const

virtual void	doAction (SoAction *action)

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual SoChildList *	getChildren (void) const

virtual void	getMatrix (SoGetMatrixAction *action)

SbUniqueId	getNodeId (void) const

NodeType	getNodeType (void) const

virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)

virtual void	GLRender (SoGLRenderAction *action)

virtual void	GLRenderBelowPath (SoGLRenderAction *action)

virtual void	GLRenderInPath (SoGLRenderAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

virtual void	grabEventsCleanup (void)

virtual void	grabEventsSetup (void)

virtual void	handleEvent (SoHandleEventAction *action)

SbBool	isOverride (void) const

virtual void	notify (SoNotList *l)

virtual void	pick (SoPickAction *action)

virtual void	rayPick (SoRayPickAction *action)

virtual void	search (SoSearchAction *action)

void	setNodeType (const NodeType type)

void	setOverride (const SbBool state)

virtual void	startNotify (void)

virtual void	writeInstance (SoOutput *out)

Public Member Functions inherited from SoFieldContainer
virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

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

SbBool	enableNotify (const SbBool flag)

SbBool	fieldsAreEqual (const SoFieldContainer *container) const

void	get (SbString &fielddata)

void	get (SbString &fielddata, SoOutput *out)

virtual int	getAllFields (SoFieldList &l) const

virtual SoField *	getEventIn (const SbName &name) const

virtual SoField *	getEventOut (const SbName &name) const

virtual SoField *	getField (const SbName &name) const

virtual const SoFieldData *	getFieldData (void) const

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

virtual int	getFields (SoFieldList &l) const

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

SbBool	getIsBuiltIn (void) const

void *	getUserData (void) const

SbBool	hasDefaultValues (void) const

SbBool	isNotifyEnabled (void) const

SbBool	set (const char *const fielddata)

SbBool	set (const char fielddata, SoInput input)

void	setToDefaults (void)

void	setUserData (void *userdata) const

virtual SbBool	validateNewFieldValue (SoField field, void newval)

Public Member Functions inherited from SoBase
void	addAuditor (void *const auditor, const SoNotRec::Type type)

void	assertAlive (void) const

const SoAuditorList &	getAuditors (void) const

virtual SbName	getName (void) const

int32_t	getRefCount (void) const

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

void	ref (void) const

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

virtual void	setName (const SbName &newname)

SbBool	shouldWrite (void)

void	touch (void)

void	unref (void) const

void	unrefNoDelete (void) const

Static Public Member Functions
static SoProto *	findProto (const SbName &name)

static SoType	getClassTypeId (void)

static void	initClass (void)

static void	setFetchExternProtoCallback (SoFetchExternProtoCB cb, void closure)

Static Public Member Functions inherited from SoNode
static void	audioRenderS (SoAction action, SoNode node)

static void	callbackS (SoAction action, SoNode node)

static int	getActionMethodIndex (const SoType type)

static void	getBoundingBoxS (SoAction action, SoNode node)

static SoNode *	getByName (const SbName &name)

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

static SoType	getClassTypeId (void)

static uint32_t	getCompatibilityTypes (const SoType &nodetype)

static void	getMatrixS (SoAction action, SoNode node)

static SbUniqueId	getNextNodeId (void)

static void	getPrimitiveCountS (SoAction action, SoNode node)

static void	GLRenderS (SoAction action, SoNode node)

static void	handleEventS (SoAction action, SoNode node)

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

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 Public Member Functions inherited from SoFieldContainer
static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)

static void	cleanupClass (void)

static void	copyDone (void)

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

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

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

Static Public Member Functions inherited from SoBase
static void	addName (SoBase const base, const char const name)

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

static void	decrementCurrentWriteCounter (void)

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

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

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

static SbBool	getTraceRefs (void)

static void	incrementCurrentWriteCounter (void)

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 SbBool	read (SoInput input, SoBase &base, SoType expectedtype)

static SbBool	readRoute (SoInput *input)

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

static void	setInstancePrefix (const SbString &c)

static void	setTraceRefs (SbBool trace)

Protected Member Functions
virtual	~SoProto ()

virtual void	destroy (void)

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 SoNotRec	createNotRec (void)

virtual const char *	getFileFormatName (void) const

SbBool	hasMultipleWriteRefs (void) const

void	writeFooter (SoOutput *out) const

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

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 int	getNextActionMethodIndex (void)

static void	incNextActionMethodIndex (void)

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

static void	setNextActionMethodIndex (int index)

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 int	nextActionMethodIndex = 0

static SbUniqueId	nextUniqueId = 1

Detailed Description

The SoProto class handles PROTO definitions.

SoProto and SoProtoInstance are mostly internal classes. They're designed to read and handle VRML97 PROTOs. However, it's possible to define your PROTOs in C++. You must define your PROTO in a char array, and read that char array using SoInput::setBuffer() and SoDB::readAllVRML(). Example:

char myproto[] =
"#VRML V2.0 utf8\n"
"PROTO ColorCube [\n"
"  field SFColor color 1 1 1\n"
"  field SFVec3f size 1 1 1\n"
"]\n"
"{\n"
"  Shape {\n"
"    appearance Appearance {\n"
"      material Material {\n"
"        diffuseColor IS color\n"
"      }\n"
"    }\n"
"    geometry Box { size IS size }\n"
"  }\n"
"}\n"
"ColorCube { color 1 0 0 size 2 1 1 }\n";
 
SoInput in;
in.setBuffer(myproto, strlen(myproto));
SoVRMLGroup * protoroot = SoDB::readAllVRML(&in);

Now you can create new instances of the ColorCube PROTO using SoProto::findProto() and SoProto::createProtoInstance(). If you want to insert PROTO instances into your scene graph, you should insert the node returned from SoProtoInstance::getRootNode().

See http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.8 for more information about PROTOs in VRML97.

Constructor & Destructor Documentation

◆ SoProto()

SoProto::SoProto ( const SbBool externproto = FALSE )

Constructor.

◆ ~SoProto()

SoProto::~SoProto ( )

protectedvirtual

Destructor.

Member Function Documentation

◆ addISReference()

void SoProto::addISReference	(	SoNode *	container,
		const SbName &	fieldname,
		const SbName &	interfacename )

Adds an IS reference for this PROTO definition.

◆ addReference()

void SoProto::addReference	(	const SbName &	name,
		SoBase *	base )

Adds a reference for this PROTO definition.

◆ addRoute()

void SoProto::addRoute	(	const SbName &	fromnode,
		const SbName &	fromfield,
		const SbName &	tonode,
		const SbName &	tofield )

Adds a ROUTE for this PROTO definition.

◆ createProtoInstance()

SoProtoInstance * SoProto::createProtoInstance ( void )

Creates an instance of the PROTO.

◆ destroy()

void SoProto::destroy ( void )

protectedvirtual

Cleans up all hanging references to and from this instance, and then commits suicide.

Called automatically when the reference count goes to zero.

Reimplemented from SoBase.

◆ findISReference()

SbName SoProto::findISReference	(	const SoFieldContainer *	container,
		const SbName &	fieldname )

If container is a PROTO definition node with an IS interface field named fieldname, return the interface name, otherwise return an empty SbName.

◆ findProto()

SoProto * SoProto::findProto ( const SbName & name )

static

Returns the PROTO definition named name or NULL if not found.

◆ findReference()

SoBase * SoProto::findReference ( const SbName & name ) const

Finds a reference for this PROTO definition.

◆ getProtoName()

SbName SoProto::getProtoName ( void ) const

Returns the PROTO name.

◆ getTypeId()

SoType SoProto::getTypeId ( void ) const

virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime 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 predefined 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 top level superclasses for the various class groups.

Implements SoBase.

◆ readInstance()

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

virtual

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

◆ removeReference()

void SoProto::removeReference ( const SbName & name )

Removes a reference for this PROTO definition.

◆ write()

void SoProto::write ( SoWriteAction * action )

virtual

Action method for SoWriteAction.

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

Reimplemented from SoNode.

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

SoProto.h
SoProto.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoProto()

◆ ~SoProto()

Member Function Documentation

◆ addISReference()

◆ addReference()

◆ addRoute()

◆ createProtoInstance()

◆ destroy()

◆ findISReference()

◆ findProto()

◆ findReference()

◆ getProtoName()

◆ getTypeId()

◆ readInstance()

◆ removeReference()

◆ write()