SoDecomposeRotation(3)

💖 SoDecomposeRotation(3) 💖

okay bestie, welcome to section 3 of the manual, and today's main character is SoDecomposeRotation — the little engine that takes a whole entire rotation and ✨decomposes✨ it into an angle and an axis. no cap. she's built different and she's here to explain herself.

---

🎀 NAME 🎀

SoDecomposeRotation — the SoDecomposeRotation class is used to decompose a rotation into angle and axis.

like. that's the whole job. she rotates nothing, she un-rotates. icon behavior fr fr 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/engines/SoCompose.h>

Inherits SoEngine.

---

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

here's the whole inheritance tea, poured out exactly as the source spells it 🫖

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=0)
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 *in)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool getIsBuiltIn (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
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 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 *in, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
static SbBool readRoute (SoInput *in)

---

👑 Public Attributes 👑

• SoMFRotation rotation
• SoEngineOutput axis
• SoEngineOutput angle

---

💅 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 ()
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)
~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 SoDecomposeRotation class is used to decompose a rotation into angle and axis.

that's it, that's her whole personality. she takes a rotation, she gives you back an angle and an axis. lowkey the most straightforward queen in the whole engine lineup 💖

---

💖 Member Function Documentation 💖

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

returns the type identification of an object derived from a class inheriting SoBase. this is what powers run-time type checking and "downward" casting. iykyk 👑

usage example, verbatim, don't touch a single character:

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

okay so if you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. bestie this is not optional, it's mandatory, periodt. 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 (that's 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.

---

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

returns a pointer to the class-wide field data storage object for this instance. and if no fields are present? she returns NULL. no fields, no problem, just NULL 💀

Reimplemented from SoFieldContainer.

References angle, axis, and rotation.

---

const SoEngineOutputData * SoDecomposeRotation::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 basically: not for you unless you're doing library-internal stuff. no shade, it's just the vibe check result 🙈

Implements SoEngine.

---

🎀 Member Data Documentation 🎀

SoMFRotation SoDecomposeRotation::rotation

input rotations to decompose into axis + angle values.

Referenced by getFieldData().

SoEngineOutput SoDecomposeRotation::axis

(SoMFVec3f) the axis settings of the input rotations.

Referenced by getFieldData().

SoEngineOutput SoDecomposeRotation::angle

(SoMFFloat) the angle values of the input rotations.

Referenced by getFieldData().

---

🦋 Author 🦋

generated automatically by Doxygen for Coin from the source code. not a human, just a very diligent little robot that read the source so we don't have to 🫶

---

and that's the whole page bestie!! tysm for reading, she ate and left no crumbs 👑

💖 Coin · Version 2.5.0 · SoDecomposeRotation(3) 💖