The SoConcatenate class is used to concatenate several inputs into one output. More...

#include <Inventor/engines/SoConcatenate.h>

Inheritance diagram for SoConcatenate:

Public Types
enum	{ NUMINPUTS = 10 }

Public Member Functions
	SoConcatenate (SoType inputType)

virtual const SoFieldData *	getFieldData (void) const

virtual const SoEngineOutputData *	getOutputData (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.

Public Member Functions inherited from SoEngine
SoEngine *	copy (void) const

virtual SoFieldContainer *	copyThroughConnection (void) const

void	evaluateWrapper (void)

SoEngineOutput *	getOutput (const SbName &outputname) const

SbBool	getOutputName (const SoEngineOutput *output, SbName &outputname) const

virtual int	getOutputs (SoEngineOutputList &l) const

SbBool	isNotifying (void) const

virtual void	notify (SoNotList *nl)

SbBool	shouldCopy (void) const

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

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)

virtual void	startNotify (void)

void	touch (void)

void	unref (void) const

void	unrefNoDelete (void) const

Static Public Member Functions
static void *	createInstance (void)

static SoType	getClassTypeId (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 Public Member Functions inherited from SoEngine
static SoEngine *	getByName (const SbName &name)

static int	getByName (const SbName &name, SoEngineList &el)

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

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)

Public Attributes
SoMField *	input [NUMINPUTS]

SoEngineOutput *	output

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

static const SoEngineOutputData **	getOutputDataPtr (void)

Static Protected Member Functions inherited from SoEngine
static const SoFieldData **	getInputDataPtr (void)

static const SoEngineOutputData **	getOutputDataPtr (void)

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

static void	staticDataLock (void)

static void	staticDataUnlock (void)

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

Protected Member Functions inherited from SoEngine
	SoEngine (void)

virtual	~SoEngine (void)

virtual void	inputChanged (SoField *which)

void	writeOutputTypes (SoOutput *out)

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

Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

Detailed Description

The SoConcatenate class is used to concatenate several inputs into one output.

Takes all the values from the 10 input multivalue fields in turn and concatenates them into the multivalue output.

Note that this engine's output field deviates a little from the "standard" output mechanism of the majority of engine classes: the SoConcatenate::output is not a permanent SoEngineOutput instance, but a pointer to a SoEngineOutput instance. The reason for this is that it is necessary to allocate the output field dynamically to make it match what the SoConcatenate::input is connected to since the type of the SoConcatenate::output always should be the same as the type of the SoConcatenate::input.

The file format for this field is a bit special. Note the leading type specification, which is not necessary for most other field types:

Concatenate {
  type <multivaluefieldtype>
  [...fields...]
}

Constructor & Destructor Documentation

◆ SoConcatenate()

SoConcatenate::SoConcatenate ( SoType type )

Constructor. The type of the input/output is specified in type.

Member Function Documentation

◆ getFieldData()

virtual const SoFieldData * SoConcatenate::getFieldData ( void ) const

virtual

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

Reimplemented from SoFieldContainer.

◆ getOutputData()

virtual const SoEngineOutputData * SoConcatenate::getOutputData ( void ) const

virtual

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Implements SoEngine.

◆ getTypeId()

virtual SoType SoConcatenate::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.

Member Data Documentation

◆ input

SoMField * SoConcatenate::input[10]

The multivalue input fields which we will concatenate into the output.

◆ output

SoEngineOutput * SoConcatenate::output

(SoMField) This is the field output containing the concatenated values of all the input fields.

The type of the field will of course match the type of the input field.

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

SoConcatenate.h
SoConcatenate.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoConcatenate()

Member Function Documentation

◆ getFieldData()

◆ getOutputData()

◆ getTypeId()

Member Data Documentation

◆ input

◆ output