SoTransformation(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoTransformation 💖

okay bestie, buckle UP, because this is SoTransformation(3) from the Library Functions Manual and it is, and I say this with my whole chest, the blueprint for every glow-up your geometry is ever gonna get. 🦋

✨ NAME ✨

SoTransformation — the abstract base class for transformation nodes. it's giving "parent of the whole transformation family," and honestly? mother. 👑

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoTransformation.h>

Inherits SoNode. 💫

Inherited by SoAntiSquish, SoGeoLocation, SoMatrixTransform, SoResetTransform, SoRotation, SoRotationXYZ, SoScale, SoSurroundScale, SoTransform, SoTranslation, and SoUnits. (yes, that's a whole squad. they all got it from her. 🫶)

🎀 Public Member Functions 🎀

  • virtual SoType getTypeId (void) const — the one and only member she adds herself. the rest? inherited. we love a humble icon.

💜 Public Member Functions inherited from SoNode 💜

  • 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 doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • uint32_t 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 💜

  • 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 💜

  • 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)
  • 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 SoType getClassTypeId (void)
  • static void initClass (void)

⭐ 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)
  • static void initClasses (void)
  • static uint32_t 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)
  • static SoType getClassTypeId (void)
  • 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)
  • static SoType getClassTypeId (void)
  • 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)

🔒 Protected Member Functions 🔒

  • virtual const SoFieldData * getFieldData (void) const
  • SoTransformation (void) — the constructor, but she's protected. exclusive. 💅
  • virtual ~SoTransformation () — the destructor, also protected, also virtual.

🔒 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

🧚 Static Protected Member Functions 🧚

  • 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, no cap:

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 }

Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Protected Attributes inherited from SoNode

  • uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1
  • static int nextActionMethodIndex = 0

👑 Detailed Description 👑

so, SoTransformation is the abstract base class for transformation nodes. that's the whole vibe of the class, fr fr.

When you wanna position and orient your geometry inside the 3D world space, you reach for the various node types made for transformations. Every single one of them inherits from SoTransformation. 🎀

⚠️ okay important: transformations will be accumulated through the scene graph, unless you use them under SoSeparator nodes — because that's where the transformation matrix stack gets pushed and popped. that's the whole trick, bestie.

here's a short example showing exactly how that principle works:

#Inventor V2.1 ascii

Separator {
   BaseColor { rgb 1 0 0 }
   Cone { }

   Translation { translation 3 0 0 }

   Separator {
      Rotation { rotation 1 0 0  1.57 }
      BaseColor { rgb 0 1 0 }
      Cone { }
   } # SoSeparator restores transformation matrix here

   Translation { translation 3 0 0 }

   Rotation { rotation 1 0 0  1.57 }
   BaseColor { rgb 0 0 1 }
   Cone { }

   Translation { translation 3 0 0 }

   # Last SoRotation was not within SoSeparator, so this next
   # SoRotation will accumulate with the previous.
   Rotation { rotation 1 0 0  1.57 }
   BaseColor { rgb 1 1 0 }
   Cone { }
}

Which results in the following scene: (the picture lives on the original page, go peek at it 👀)

🛠️ Constructor & Destructor Documentation 🛠️

🍓 SoTransformation::SoTransformation (void ) [protected]

Constructor. she exists, but only her children get to call her like that. 💅

🍓 SoTransformation::~SoTransformation () [protected], [virtual]

Destructor. virtual, protected, iconic, no notes. ✨

✨ Member Function Documentation ✨

Okay bestie, this is where the magic happens. Two functions, both absolutely carrying their weight. 💅

💖 SoType SoTransformation::getTypeId (void ) const [virtual] 💖

This one? It's the type-ID bestie. getTypeId() returns the type identification of an object derived from a class that inherits SoBase. It's used for run-time type checking and "downward" casting. No cap. ✨

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

If you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or others, listen up: this method needs to be overridden in all subclasses. Usually you do that as part of setting up the full type system for extension classes, and that's typically accomplished with 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 info on writing Coin extensions, check the class documentation of the toplevel superclasses for the various class groups. iykyk. 📚

Implements SoBase.

Reimplemented in: SoAntiSquish, SoCenterballManip, SoGeoLocation, SoHandleBoxManip, SoJackManip, SoMatrixTransform, SoPendulum, SoResetTransform, SoRotation, SoRotationXYZ, SoRotor, SoScale, SoShuttle, SoSurroundScale, SoTabBoxManip, SoTrackballManip, SoTransform, SoTransformBoxManip, SoTransformerManip, SoTransformManip, SoTranslation, and SoUnits.

🎀 const SoFieldData * SoTransformation::getFieldData (void ) const [protected], [virtual] 🎀

This one hands you a pointer to the class-wide field data storage object for this instance. If there are no fields present, it returns NULL. Simple, iconic, done. 💖

Reimplemented from SoFieldContainer.

Reimplemented in: SoAntiSquish, SoCenterballManip, SoGeoLocation, SoHandleBoxManip, SoJackManip, SoMatrixTransform, SoPendulum, SoResetTransform, SoRotation, SoRotationXYZ, SoRotor, SoScale, SoShuttle, SoSurroundScale, SoTabBoxManip, SoTrackballManip, SoTransform, SoTransformBoxManip, SoTransformerManip, SoTransformManip, SoTranslation, and SoUnits.

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. Doxygen really said "I'll handle the docs, you go slay." 💅

Coin, version 3.1.3 — SoTransformation(3), auto-generated from the source code. The date? Bestie, it's giving Doxygen timestamp energy, but the footer's version is 3.1.3 and the source is Coin. Periodt. 🫶💖

📦 where this page comes from