Open Inventor Reference
|
Decomposes 3D vectors into floating-point values. More...
#include <Inventor/engines/SoCompose.h>
Public Attributes | |
Inputs | |
SoMFVec3f | vector |
Vector to be decomposed. | |
Outputs | |
SoEngineOutput | x |
First component of the vector. | |
SoEngineOutput | y |
Second component of the vector. | |
SoEngineOutput | z |
Third component of the vector. | |
Additional Inherited Members | |
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 pointer to the engine output with the given name. | |
bool | 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. | |
void | evaluateWrapper () |
wrapper for the user's evaluate() engine | |
virtual void | notify (SoNotList *list) |
Propagates modification notification through an instance. | |
virtual const SoEngineOutputData * | getOutputData () const =0 |
Info on outputs: | |
virtual void | writeInstance (SoOutput *out) |
Writes instance to SoOutput. (Used only for last stage of writing) | |
virtual SoFieldContainer * | copyThroughConnection () const |
Copies an instance that is encountered through a field connection. | |
bool | shouldCopy () const |
Recursive procedure that determines if this engine should be copied during a copy operation, or just referenced as is. | |
bool | isNotifying () const |
A very annoying double notification occurs with engines that enable their outputs during inputChanged; this flag prevents that: | |
Public Member Functions inherited from SoFieldContainer | |
void | setToDefaults () |
Sets all fields in this object to their default values. | |
bool | hasDefaultValues () const |
Returns TRUE if all of the object's fields have their default values. | |
bool | fieldsAreEqual (const SoFieldContainer *fc) const |
Returns TRUE if this object's fields are exactly equal to fc's fields. | |
void | copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE) |
Copies the contents of fc's fields into this object's fields. | |
bool | 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 Inventor file format. | |
void | get (SbString &fieldDataString) |
Returns the values of the fields of this object in the Inventor ASCII file format in the given string. | |
virtual int | getFields (SoFieldList &list) const |
Appends pointers to all of this object's fields to resultList, and returns the number of fields appended. | |
virtual SoField * | getField (const SbName &fieldName) const |
Returns a pointer to the field with the given name. | |
bool | getFieldName (const SoField *field, SbName &fieldName) const |
Returns the name of the given field in the fieldName argument. | |
bool | enableNotify (bool flag) |
Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). | |
bool | isNotifyEnabled () const |
Notification is the process of telling interested objects that this object has changed. | |
bool | set (const char *fieldDataString, SoInput *dictIn) |
Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format. | |
void | get (SbString &fieldDataString, SoOutput *dictOut) |
Returns the values of the fields of this object in the Inventor ASCII file format in the given string. | |
virtual void | notify (SoNotList *) |
Propagates modification notification through an instance. | |
virtual void | addWriteReference (SoOutput *out, bool isFromField=FALSE) |
Adds a reference to the instance when writing. | |
virtual void | writeInstance (SoOutput *out) |
Writes instance to SoOutput. (Used only for last stage of writing) | |
bool | getIsBuiltIn () const |
Returns whether or not instance is considered 'built-in' to the library. | |
virtual const SoFieldData * | getFieldData () const |
Returns an SoFieldData structure for the node. | |
virtual void | copyContents (const SoFieldContainer *fromFC, bool copyConnections) |
Copies the contents of the given node into this instance. | |
virtual SoFieldContainer * | copyThroughConnection () const |
During a copy operation, this copies an instance that is encountered through a field connection. | |
void | addManagedSensor (SoSensor *sensor) |
Adds a sensor which is managed by the field container. | |
Public Member Functions inherited from SoBase | |
void | ref () const |
Adds and removes a reference to an instance. | |
void | unref () const |
void | unrefNoDelete () const |
void | touch () |
Marks an instance as modified, simulating a change to it. | |
virtual SoType | getTypeId () const =0 |
Returns the type identifier for a specific instance. | |
bool | isOfType (SoType type) const |
Returns TRUE if this object is of the type specified in type or is derived from that type. | |
virtual SbName | getName () const |
Returns the name of an instance. | |
virtual void | setName (const SbName &name) |
Sets the name of an instance. | |
virtual void | startNotify () |
Initiates notification from an instance. | |
virtual void | notify (SoNotList *list) |
Propagates modification notification through an instance. | |
void | addAuditor (void *auditor, SoNotRec::Type type) |
Adds/removes an auditor to/from list. | |
void | removeAuditor (void *auditor, SoNotRec::Type type) |
const SoAuditorList & | getAuditors () |
Returns auditor list– used by SoField and SoEngineOutput to trace forward connections. | |
int | getRefCount () const |
Returns current reference count. | |
virtual void | addWriteReference (SoOutput *out, bool isFromField=FALSE) |
Adds a reference to the instance when writing. | |
bool | shouldWrite () |
Returns TRUE if the instance should be written, based on the write-reference info already accumulated. | |
Static Public Member Functions inherited from SoEngine | |
static SoType | getClassTypeId () |
Returns the type identifier for the SoEngine class. | |
static SoEngine * | getByName (const SbName &name) |
Look up engine(s) by name. | |
static int | getByName (const SbName &name, SoEngineList &list) |
Look up engine(s) by name. | |
static void | initClass () |
Initializes base engine class. | |
static void | initClasses () |
Initialize ALL Inventor engine classes. | |
Static Public Member Functions inherited from SoFieldContainer | |
static SoType | getClassTypeId () |
Returns the type of this class. | |
static void | initClass () |
Setup type information. | |
static void | initCopyDict () |
During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used. | |
static void | addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) |
Adds an instance to the dictionary. | |
static SoFieldContainer * | checkCopy (const SoFieldContainer *orig) |
If a copy of the given instance is in the dictionary, this returns it. | |
static SoFieldContainer * | findCopy (const SoFieldContainer *orig, bool copyConnections) |
If a copy of the given instance is not in the dictionary, this returns NULL. | |
static void | copyDone () |
Cleans up the dictionary when done. | |
Static Public Member Functions inherited from SoBase | |
static SoType | getClassTypeId () |
Returns type identifier for this class. | |
static void | initClass () |
Setup type information. | |
static void | incrementCurrentWriteCounter () |
Increments the current write counter at the start of a write operation. | |
static void | decrementCurrentWriteCounter () |
Decrements the current write counter after a write operation, in some rare cases. | |
static void | addName (SoBase *, const char *) |
Internal methods used to maintain the global name dictionary. | |
static void | removeName (SoBase *, const char *) |
static SoBase * | getNamedBase (const SbName &, SoType) |
Helper routines used to get stuff out of nameDict. | |
static int | getNamedBases (const SbName &, SoBaseList &, SoType) |
static bool | read (SoInput *in, SoBase *&base, SoType expectedType) |
Reads one instance of some subclass of SoBase. | |
static void | setInstancePrefix (const SbString &c) |
This defaults to "+" and is used when naming nodes that are DEF's and USE'd. | |
Static Public Attributes inherited from SoBase | |
static bool | traceRefs |
Turns on/off reference count tracing (for debugging) | |
Protected Types inherited from SoBase | |
enum | BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 } |
This set of enums is used when reading and writing the base. More... | |
Protected Member Functions inherited from SoEngine | |
virtual void | evaluate ()=0 |
User-written evaluation engine. | |
SoEngine () | |
Constructor, destructor. | |
~SoEngine () | |
virtual bool | readInstance (SoInput *in, unsigned short flags) |
Reads stuff into instance. Returns FALSE on error. | |
virtual void | inputChanged (SoField *whichField) |
This is called whenever the value of an input is changed. | |
void | writeOutputTypes (SoOutput *out) |
Write output type information for engines that are not built-in. | |
Protected Member Functions inherited from SoFieldContainer | |
SoFieldContainer () | |
~SoFieldContainer () | |
virtual bool | readInstance (SoInput *in, unsigned short flags) |
Reads stuff into instance. Returns FALSE on error. | |
Protected Member Functions inherited from SoBase | |
SoBase () | |
Constructor is protected - this is an abstract class. | |
virtual | ~SoBase () |
Virtual destructor so that subclasses are deleted properly. | |
virtual void | destroy () |
Actually deletes an instance. | |
bool | hasMultipleWriteRefs () const |
Returns TRUE if the instance has multiple write references. | |
bool | writeHeader (SoOutput *out, bool isGroup, bool isEngine) const |
Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput. | |
void | writeFooter (SoOutput *out) const |
virtual const char * | getFileFormatName () const |
Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned) | |
virtual bool | readInstance (SoInput *in, unsigned short flags)=0 |
Reads stuff into instance of subclass. | |
Static Protected Member Functions inherited from SoEngine | |
static const SoFieldData ** | getInputDataPtr () |
This is used by the input&output inheritence mechanism, hidden in the SoSubEngine macros. | |
static const SoEngineOutputData ** | getOutputDataPtr () |
Static Protected Member Functions inherited from SoBase | |
static uint32_t | getCurrentWriteCounter () |
Returns current write counter. | |
Protected Attributes inherited from SoFieldContainer | |
bool | isBuiltIn |
Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information. | |
This engine takes as input a 3D vector, and decomposes it into three single floating-point values.
The input can have multiple values, allowing the engine to decompose several vectors in parallel.
Definition at line 344 of file SoCompose.h.
SoMFVec3f SoDecomposeVec3f::vector |
Definition at line 351 of file SoCompose.h.
SoEngineOutput SoDecomposeVec3f::x |
Definition at line 359 of file SoCompose.h.
SoEngineOutput SoDecomposeVec3f::y |
Definition at line 362 of file SoCompose.h.
SoEngineOutput SoDecomposeVec3f::z |
Definition at line 365 of file SoCompose.h.