SoTransform(3)

📦

version 4.0.10 · 4 versions

4.0.10 · fedora 43, fedora 44 (latest)
4.0.10 · epel 9
4.0.3 · fedora 43
4.0.7 · fedora 44

🦋 SoTransform(3) — the Coin manual, bestie edition 🦋

okay so. this is the manpage for SoTransform, from Coin. she is the all-purpose transformation node type — like the little black dress of the scene graph, she does everything 💅 and we're doing this in two parts, so don't wander off.

💖 NAME 💖

SoTransform — the "all-purpose" transformation node type.

that's the actual description and honestly? accurate. she ate.

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoTransform.h>

Inherits SoTransformation.

Inherited by SoTransformManip.

🌸 Public Member Functions 🌸

the stuff she does herself, no middleman, no cap:

virtual SoType getTypeId (void) const
SoTransform (void)
void pointAt (const SbVec3f &frompoint, const SbVec3f &topoint)
void getScaleSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
void getRotationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
void getTranslationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
void multLeft (const SbMatrix &mat)
void multRight (const SbMatrix &mat)
void combineLeft (SoTransformation *nodeonright)
void combineRight (SoTransformation *nodeonleft)
void setMatrix (const SbMatrix &mat)
void recenter (const SbVec3f &newcenter)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void pick (SoPickAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

🎀 Public Member Functions inherited from `SoNode` 🎀

everything she gets handed down from SoNode, iconic behavior:

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 SbBool affectsState (void) const
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
SbUniqueId getNodeId (void) const
virtual SoChildList * getChildren (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
virtual SoFieldContainer * copyThroughConnection (void) const

🧚 Public Member Functions inherited from `SoFieldContainer` 🧚

the field-management side of the family tree:

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)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
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` 💜

the O.G. base class energy:

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 — tells you TRUE if the type of this object is either the same type as type, or inherited from type.
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 besties, shared by everybody, no instance needed:

static SoType getClassTypeId (void)
static void initClass (void) — sets up the initialization for data that's common to all instances of this class, like submitting the necessary info to the Coin type system.

🌈 Static Public Member Functions inherited from `SoTransformation` 🌈

static SoType getClassTypeId (void)
static void initClass (void) — again: handles the setup for the data shared by every instance of this class, which includes handing the needed info over to the Coin type system.

🔥 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) — yep, same deal: sets up initialization for the data common to all instances of this class, like submitting the necessary information to the Coin type system.
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) — the usual: initializes the data shared by all instances of this class, including submitting the required information to the Coin type system.
static SoType getClassTypeId (void) — this static method hands you back the SoType object that's associated with objects of this class.
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) — you guessed it: 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) — 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 👑

these are the fields you actually set, the whole reason she's famous:

SoSFVec3f translation
SoSFRotation rotation
SoSFVec3f scaleFactor
SoSFRotation scaleOrientation
SoSFVec3f center

🙈 Protected Member Functions 🙈

for her and her subclasses only, sorry bestie:

virtual const SoFieldData * getFieldData (void) const
virtual ~SoTransform ()

💀 Protected Member Functions inherited from `SoTransformation` 💀

SoTransformation (void)
virtual ~SoTransformation ()

🌸 Protected Member Functions inherited from `SoNode` 🌸

SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

🎀 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
virtual SoNotRec createNotRec (void)

⭐ Static Protected Member Functions ⭐

static const SoFieldData ** getFieldDataPtr (void)

🧚 Static Protected Member Functions inherited from `SoTransformation` 🧚

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` 💖

the big enum of node-type flags, copy it exactly bestie, every single one matters:

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 `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 ✨

Okay so bestie, <pink>SoTransform</pink> is like the all-purpose transformation node type. 💅

Like <pink>SoMatrixTransform</pink>, nodes of this type give the application programmer maximum flexibility when specifying geometry transformations in a scene graph. But if you want to set and keep the various components of the transformation matrix in separate entities, this node type is preferable, though. 🎀

The order of operations is: first scaling is done, then rotation, then translation. Periodt. 🔥

FILE FORMAT/DEFAULTS:

       Transform {
           translation 0 0 0
           rotation 0 0 1  0
           scaleFactor 1 1 1
           scaleOrientation 0 0 1  0
           center 0 0 0
       }

✨ Constructor & Destructor Documentation ✨

`SoTransform::SoTransform (void )`

Constructor. Just a constructor, bestie. 💖

`SoTransform::~SoTransform () [protected], [virtual]`

Destructor. It's protected and virtual. 👑

✨ Member Function Documentation ✨

`SoType SoTransform::getClassTypeId (void ) [static]`

This static method returns the <cyan>SoType</cyan> object associated with objects of this class. ✨

`SoType SoTransform::getTypeId (void ) const [virtual]`

Returns the type identification of an object derived from a class inheriting <cyan>SoBase</cyan>. This is used for runtime type checking and "downward" casting. 🦋

Reimplemented from <purple>SoTransformation</purple>.

Reimplemented in <pink>SoCenterballManip</pink>, <pink>SoHandleBoxManip</pink>, <pink>SoJackManip</pink>, <pink>SoTabBoxManip</pink>, <pink>SoTrackballManip</pink>, <pink>SoTransformBoxManip</pink>, <pink>SoTransformerManip</pink>, and <pink>SoTransformManip</pink>.

`const SoFieldData ** SoTransform::getFieldDataPtr (void ) [static], [protected]`

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

Returns the <cyan>SoFieldData</cyan> class which holds information about fields in this node. 🎀

`const SoFieldData * SoTransform::getFieldData (void ) const [protected], [virtual]`

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

Reimplemented from <purple>SoTransformation</purple>.

`void SoTransform::pointAt (const SbVec3f & frompoint, const SbVec3f & topoint)`

Sets the transformation to translate to frompoint, with a rotation so that the (0,0,-1) vector is rotated into the vector from frompoint to topoint. 📍

`void SoTransform::getScaleSpaceMatrix (SbMatrix & mat, SbMatrix & inv) const`

Calculates the matrices to/from scale space. 💅

`void SoTransform::getRotationSpaceMatrix (SbMatrix & mat, SbMatrix & inv) const`

Calculates the matrices to/from rotation space. 🔄

`void SoTransform::getTranslationSpaceMatrix (SbMatrix & mat, SbMatrix & inv) const`

Calculates the matrices to/from translation space. 🚀

`void SoTransform::multLeft (const SbMatrix & mat)`

Premultiplies this transformation by mat. ✨

`void SoTransform::multRight (const SbMatrix & mat)`

Postmultiplies this transformation by mat. ✨

`void SoTransform::combineLeft (SoTransformation * nodeonright)`

Premultiplies this transformation by the transformation in nodeonright. 💖

`void SoTransform::combineRight (SoTransformation * nodeonleft)`

Postmultiplies this transformation by the transformation in nodeonleft. 💖

`void SoTransform::setMatrix (const SbMatrix & mat)`

Sets the fields to create a transformation equal to mat. 🎯