SoDecomposeMatrix(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoDecomposeMatrix 💖

okay bestie, welcome to SoDecomposeMatrix(3) from the Library Functions Manual 🎀 this is the page for the class that takes a matrix apart into its cute little simple transformations, and honestly? it's giving "quiet kid in class who is secretly a genius." let's get into it. ✨

🌸 NAME 🌸

SoDecomposeMatrix — the SoDecomposeMatrix class is used to decompose a matrix into simple transformations. no cap, that's the entire job description and she does it flawlessly. 💅

🦋 SYNOPSIS 🦋

#include <Inventor/engines/SoCompose.h>

Inherits SoEngine. so yeah, it's an engine — it lives in the engine ecosystem, does its little math moment, and sends outputs out into the world. 🌈

👑 Public Member Functions

  • virtual SoType getTypeId (void) const
  • virtual const SoFieldData * getFieldData (void) const
  • virtual const SoEngineOutputData * getOutputData (void) const

🧚 Public Member Functions inherited from SoEngine

  • void evaluateWrapper (void)
  • virtual int getOutputs (SoEngineOutputList &l) const
  • SoEngineOutput * getOutput (const SbName &outputname) const
  • SbBool getOutputName (const SoEngineOutput *output, SbName &outputname) const
  • SbBool isNotifying (void) const
  • virtual void notify (SoNotList *nl)
  • SoEngine * copy (void) const
  • virtual SoFieldContainer * copyThroughConnection (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 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 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 SoAuditorList & getAuditors (void) const
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

⭐ Static Public Member Functions

  • static SoType getClassTypeId (void)
  • static void * createInstance (void)
  • static void initClass ()

🧚 Static Public Member Functions inherited from SoEngine

  • static void initClass (void)
  • static void initClasses (void)
  • static SoType getClassTypeId (void)
  • static SoEngine * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoEngineList &el)

🧚 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)

🍓 Public Attributes

  • SoMFMatrix matrix
  • SoMFVec3f center
  • SoEngineOutput translation
  • SoEngineOutput rotation
  • SoEngineOutput scaleFactor
  • SoEngineOutput scaleOrientation

🎀 Static Protected Member Functions

  • static const SoFieldData ** getInputDataPtr (void)
  • static const SoEngineOutputData ** getOutputDataPtr (void)

🧚 Static Protected Member Functions inherited from SoEngine

  • static const SoFieldData ** getInputDataPtr (void)
  • static const SoEngineOutputData ** getOutputDataPtr (void)

🧚 Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (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 SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void inputChanged (SoField *which)
  • void writeOutputTypes (SoOutput *out)

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

Protected Member Functions inherited from SoBase

  • SoBase (void)
  • virtual ~SoBase ()
  • SbBool hasMultipleWriteRefs (void) const
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
  • void writeFooter (SoOutput *out) const
  • virtual const char * getFileFormatName (void) const

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

✨ Detailed Description ✨

The SoDecomposeMatrix class is used to decompose a matrix into simple transformations. that's it, that's her whole personality and we love her for it. 🫶

💅 Member Function Documentation 💅

SoType SoDecomposeMatrix::getTypeId (void ) const [virtual]

Hands you back the type identification of any object derived from a class that inherits SoBase. what's it for? run-time type checking and "downward" casting, bestie. 🦋

Usage example, straight from the source:

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

now for the application programmers who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else: this method needs to be overridden in all subclasses. that's not optional, that's the vibe check. 🙈 you typically do it 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.

want more info on writing Coin extensions? go read the class documentation of the toplevel superclasses for the various class groups. 👑

Implements SoBase.

const SoFieldData * SoDecomposeMatrix::getFieldData (void ) const [virtual]

Returns a pointer to the class-wide field data storage object for this instance. and if there are no fields present? it returns NULL. simple as. ⭐

Reimplemented from SoFieldContainer.

const SoEngineOutputData * SoDecomposeMatrix::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.

so like. it's here. it exists. it's not for you, bestie, and that's fine. 💖

Implements SoEngine.

🌈 Member Data Documentation 🌈

SoMFMatrix SoDecomposeMatrix::matrix

Set of transformation matrices to decompose into their translation/rotation/scale parts. this is the input main character. 👑

SoMFVec3f SoDecomposeMatrix::center

Center points of transform matrices. the little home base of every transform. 🎀

SoEngineOutput SoDecomposeMatrix::translation

(SoMFVec3f) Translation parts of input matrices. where everything slid off to. ✨

SoEngineOutput SoDecomposeMatrix::rotation

(SoMFRotation) Rotation parts of input matrices. the spin, the twirl, the drama. 💫

SoEngineOutput SoDecomposeMatrix::scaleFactor

(SoMFVec3f) Scale vectors of input matrices. how big, how small, how much. 🦋

SoEngineOutput SoDecomposeMatrix::scaleOrientation

(SoMFRotation) Scale orientation values of the input matrices. the direction the scaling is doing its scaling in. 🌸

🫶 Author 🫶

Generated automatically by Doxygen for Coin from the source code. so like, no human author to credit here, it's a robot that wrote it and honestly it ate. 🤖💅

aaaand that's the whole page, bestie!! thank you for coming to my TED talk, this was Coin, Version 3.1.3, and SoDecomposeMatrix(3) is officially understood. go decompose something iconic. 💖✨🎀

📦 where this page comes from