SoMultipleCopy Class Reference

The SoMultipleCopy class redraws it's children multiple times at different transformations. More...

#include <Inventor/nodes/SoMultipleCopy.h>

Inheritance diagram for SoMultipleCopy:

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...
	SoMultipleCopy (void)
virtual SbBool	affectsState (void) const
virtual void	doAction (SoAction *action)
virtual void	callback (SoCallbackAction *action)
virtual void	GLRender (SoGLRenderAction *action)
virtual void	pick (SoPickAction *action)
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
virtual void	handleEvent (SoHandleEventAction *action)
virtual void	getMatrix (SoGetMatrixAction *action)
virtual void	search (SoSearchAction *action)
virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void	audioRender (SoAudioRenderAction *action)
Public Member Functions inherited from SoGroup
	SoGroup (void)
	SoGroup (int nchildren)
virtual void	addChild (SoNode *node)
virtual void	insertChild (SoNode *child, int newchildindex)
virtual SoNode *	getChild (int index) const
virtual int	findChild (const SoNode *node) const
virtual int	getNumChildren (void) const
virtual void	removeChild (int childindex)
virtual void	removeChild (SoNode *child)
virtual void	removeAllChildren (void)
virtual void	replaceChild (int index, SoNode *newchild)
virtual void	replaceChild (SoNode *oldchild, SoNode *newchild)
virtual void	write (SoWriteAction *action)
virtual SoChildList *	getChildren (void) const
virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
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 void	GLRenderBelowPath (SoGLRenderAction *action)
virtual void	GLRenderInPath (SoGLRenderAction *action)
virtual void	GLRenderOffPath (SoGLRenderAction *action)
virtual void	rayPick (SoRayPickAction *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 SoNode *	addToCopyDict (void) const
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 void	initClass (void)
Static Public Member Functions inherited from SoGroup
static SoType	getClassTypeId (void)
static void	initClass (void)
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
SoMFMatrix	matrix

Protected Member Functions
virtual const SoFieldData *	getFieldData (void) const
virtual	~SoMultipleCopy ()
Protected Member Functions inherited from SoGroup
virtual	~SoGroup ()
virtual SbBool	readInstance (SoInput *in, unsigned short flags)
virtual SbBool	readChildren (SoInput *in)
virtual void	copyContents (const SoFieldContainer *from, SbBool copyconnections)
virtual SoNotRec	createNotRec (void)
void	setOperation (const SoNotRec::OperationType opType=SoNotRec::UNSPECIFIED, const SoNode *cc=NULL, const SoNode *pc=NULL, const int ci=-1)
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

Static Protected Member Functions
static const SoFieldData **	getFieldDataPtr (void)
Static Protected Member Functions inherited from SoGroup
static const SoFieldData **	getFieldDataPtr (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)

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 }
Protected Attributes inherited from SoGroup
SoChildList *	children
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 SoMultipleCopy class redraws it's children multiple times at different transformations.

The SoMultipleCopy group node duplicates it's children nodes / subgraphs without using additional memory resources.

It can do general transformations (translations, rotation and scaling) for it's children. Apart from transformations, the appearance of it's children will be identical.

FILE FORMAT/DEFAULTS:

MultipleCopy {
    matrix 1 0 0 0
    0 1 0 0
    0 0 1 0
    0 0 0 1
}

See also

SoArray

Constructor & Destructor Documentation

SoMultipleCopy()

SoMultipleCopy::SoMultipleCopy

(

void

)

Constructor.

~SoMultipleCopy()

SoMultipleCopy::~SoMultipleCopy ( )

protectedvirtual

Destructor.

Member Function Documentation

getTypeId()

SoType SoMultipleCopy::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 SoGroup.

getFieldData()

const SoFieldData * SoMultipleCopy::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 SoGroup.

affectsState()

SbBool SoMultipleCopy::affectsState ( void  ) const

virtual

Returns TRUE if the node could have any effect on the state during traversal.

If it returns FALSE, no data in the traversal-state will change from the pre-traversal state to the post-traversal state. The SoSeparator node will for instance return FALSE, as it pushes and pops the state before and after traversal of its children. All SoShape nodes will also return FALSE, as just pushing out geometry data to the rendering engine won't affect the actual rendering state.

The default method returns TRUE, on a "better safe than sorry" philosophy.

Reimplemented from SoNode.

doAction()

void SoMultipleCopy::doAction ( SoAction *  action )

virtual

This function performs the typical operation of a node for any action.

Reimplemented from SoGroup.

callback()

void SoMultipleCopy::callback ( SoCallbackAction *  action )

virtual

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoGroup.

GLRender()

void SoMultipleCopy::GLRender ( SoGLRenderAction *  action )

virtual

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoGroup.

pick()

void SoMultipleCopy::pick ( SoPickAction *  action )

virtual

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoGroup.

getBoundingBox()

void SoMultipleCopy::getBoundingBox ( SoGetBoundingBoxAction *  action )

virtual

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoGroup.

handleEvent()

void SoMultipleCopy::handleEvent ( SoHandleEventAction *  action )

virtual

Action method for SoHandleEventAction.

Inspects the event data from action, and processes it if it is something which this node should react to.

Nodes influencing relevant state variables for how event handling is done also overrides this method.

Reimplemented from SoGroup.

getMatrix()

void SoMultipleCopy::getMatrix ( SoGetMatrixAction *  action )

virtual

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoGroup.

search()

void SoMultipleCopy::search ( SoSearchAction *  action )

virtual

Action method for SoSearchAction.

Compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction – if any of the requested criteria is a miss, the search is not deemed successful for the node.

See also

SoSearchAction

Reimplemented from SoGroup.

getPrimitiveCount()

void SoMultipleCopy::getPrimitiveCount ( SoGetPrimitiveCountAction *  action )

virtual

Action method for the SoGetPrimitiveCountAction.

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoGroup.

audioRender()

void SoMultipleCopy::audioRender ( SoAudioRenderAction *  action )

virtual

Action method for SoAudioRenderAction.

Does common processing for SoAudioRenderAction action instances.

Reimplemented from SoGroup.

Member Data Documentation

matrix

SoMFMatrix SoMultipleCopy::matrix

A set of geometry transformation matrices.

The number of duplicated redraws of the child geometry will be the same as the number of matrices specified in this field. Ie, each duplication will be transformed according to a transformation matrix.

The default value of the field is to contain just a single identity matrix.

---

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

• SoMultipleCopy.h
• SoMultipleCopy.cpp