SoConcatenate Class Reference

Joins separate fields into a single multiple-value field. More...

#include <Inventor/engines/SoConcatenate.h>

Inheritance diagram for SoConcatenate:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoConcatenate (SoType mfInputType)
	Constructor.
Public Member Functions inherited from SoEngine
virtual int	getOutputs (SoEngineOutputList &list) const
	Returns a list of outputs in this engine.
SoEngineOutput *	getOutput (const SbName &outputName) const
	Returns a reference to the engine output with the given name.
SbBool	getOutputName (const SoEngineOutput *output, SbName &outputName) const
	Returns (in outputName) the name of the engine output (output).
SoEngine *	copy () const
	Creates and returns an exact copy of the engine.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoEngine
static SoType	getClassTypeId ()
	Returns the type identifier for the SoEngine class.
static SoEngine *	getByName (const SbName &name)
	Looks up engine(s) by name.
static int	getByName (const SbName &name, SoEngineList &list)
	Looks up engine(s) by name.
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoMField *	input [10]
	Array of Input.
SoEngineOutput *	output
	Output.

Detailed Description

Joins separate fields into a single multiple-value field.

This engine joins up to 10 separate fields of a type into a single multiple-valued field of the same type. The type of the input fields can be any subclass of SoMField The type is specified when an instance of the class is created. For example, SoConcatenate( SoMFFloat::getClassTypeId() ) creates an engine that concatenates floating-point values.

The input field is a 10-element array, where each element can be connected to single- or multiple-valued fields. All the values in the input are concatenated together to form one multiple-value field. For example, if input[0] contains 10 values and input[1] contains 3 values, the output will contain 13 values.

Note that by default input does not contain any values, and no value is output from the engine. Note also that, unlike the output of most engines, output is a pointer.

FILE FORMAT/DEFAULT

Concatenate {

type	<inputType>
input0	[]
input1	[]
input2	[]
input3	[]
input4	[]
input5	[]
input6	[]
input7	[]
input8	[]
input9	[]

}

SEE ALSO

SoEngineOutput, SoGate, SoSelectOne

Definition at line 116 of file SoConcatenate.h.

Constructor & Destructor Documentation

SoConcatenate()

SoConcatenate::SoConcatenate

(

SoType

mfInputType

)

Constructor.

The argument specifies the type of values to concatenate.

Member Function Documentation

getClassTypeId()

static SoType SoConcatenate::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoConcatenate::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

Member Data Documentation

input

SoMField* SoConcatenate::input[10]

Array of Input.

Connect them like this: concatenate->input[0]->connectFrom(...) The names of these inputs is input0 ... input9. The default value for these fields is no values.

Definition at line 133 of file SoConcatenate.h.

output

SoEngineOutput* SoConcatenate::output

Output.

Is of the same type as the inputs (note that it is a pointer, unlike most engine outputs).

Definition at line 139 of file SoConcatenate.h.

---

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

• Inventor/engines/SoConcatenate.h