Coin Logo http://www.sim.no/
http://www.coin3d.org/

Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Protected Member Functions | List of all members
SoConcatenate Class Reference

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. More...

#include <Inventor/engines/SoConcatenate.h>

Inheritance diagram for SoConcatenate:
SoEngine SoFieldContainer SoBase

Public Types

enum  { NUMINPUTS = 10 }

Public Member Functions

virtual SoType getTypeId (void) const
virtual const SoFieldDatagetFieldData (void) const
virtual const SoEngineOutputDatagetOutputData (void) const
 SoConcatenate (SoType inputType)
- Public Member Functions inherited from SoEngine
void evaluateWrapper (void)
virtual int getOutputs (SoEngineOutputList &l) const
SoEngineOutputgetOutput (const SbName &outputname) const
SbBool getOutputName (const SoEngineOutput *output, SbName &outputname) const
SbBool isNotifying (void) const
virtual void notify (SoNotList *nl)
SoEnginecopy (void) const
virtual SoFieldContainercopyThroughConnection (void) const
SbBool shouldCopy (void) const
virtual void writeInstance (SoOutput *out)
- 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 SoFieldgetField (const SbName &name) const
virtual SoFieldgetEventIn (const SbName &name) const
virtual SoFieldgetEventOut (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 copyContents (const SoFieldContainer *from, SbBool copyconnections)
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
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
virtual void startNotify (void)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorListgetAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (void) const

Static Public Member Functions

static SoType getClassTypeId (void)
static void * createInstance (void)
static void initClass (void)
- Static Public Member Functions inherited from SoEngine
static void initClasses (void)
static SoEnginegetByName (const SbName &name)
static int getByName (const SbName &name, SoEngineList &el)
- Static Public Member Functions inherited from SoFieldContainer
static void cleanupClass (void)
static void initCopyDict (void)
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
static SoFieldContainerfindCopy (const SoFieldContainer *orig, const SbBool copyconnections)
static void copyDone (void)
- Static Public Member Functions inherited from SoBase
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 SoBasegetNamedBase (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

SoMFieldinput [NUMINPUTS]
SoEngineOutputoutput

Static Protected Member Functions

static const SoFieldData ** getInputDataPtr (void)
static const SoEngineOutputData ** getOutputDataPtr (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 evaluate (void)=0
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual void inputChanged (SoField *which)
void writeOutputTypes (SoOutput *out)
- 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 ( SoType  type)

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

Member Function Documentation

static SoType SoConcatenate::getClassTypeId ( void  )
static

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoEngine.

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

static const SoFieldData** SoConcatenate::getInputDataPtr ( void  )
staticprotected

Returns the SoFieldData class which holds information about inputs in this engine.

Reimplemented from SoEngine.

static const SoEngineOutputData** SoConcatenate::getOutputDataPtr ( void  )
staticprotected

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

Reimplemented from SoEngine.

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.

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.

void SoConcatenate::initClass ( void  )
static

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoEngine.

Member Data Documentation

SoMField * SoConcatenate::input[10]

The multivalue input fields which we will concatenate into the 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:

Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated on Mon Mar 17 2014 18:54:34 for Coin by Doxygen 1.8.1.2.