SoComposeRotation(3)

💖 NAME 💖

okay so we're doing SoComposeRotation(3) today bestie — that's the manual page name, and the manual itself is the Library Functions Manual. ✨

SoComposeRotation — the class that's literally built to compose rotations out of an angle and an axis. it's giving "rotation factory" and honestly? iconic. 💅

---

🌸 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

these are the ones you get handed down for free, no cap, exactly as listed:

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

• SoMFVec3f axis
• SoMFFloat angle
• SoEngineOutput rotation

🦋 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 SoComposeRotation class is used to compose rotations from angle and axis. that's the whole gig, and she does it flawlessly. 💅

Simple usage example:

#Inventor V2.1 ascii

Separator {
   Transform {
      rotation =
      ComposeRotation { axis 0 1 0  angle =
         ElapsedTime { }.timeOut
      }.rotation
   }
   Cube { }
}

---

🧚 Member Function Documentation 🧚

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. run-time type checking bestie, that's the vibe.

Usage example:

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

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. 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 (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 * SoComposeRotation::getFieldData (void ) const [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. (no fields? returns NULL. that's the rule, don't shoot the messenger 🫶)

Reimplemented from SoFieldContainer.

const SoEngineOutputData * SoComposeRotation::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. iykyk, it's an internal thing, not your problem fr fr.

Implements SoEngine.

---

🍓 Member Data Documentation 🍓

SoMFVec3f SoComposeRotation::axis

Set of axis vectors for the output rotations. Default value is (0.0f, 0.0f, 1.0f). yeah, she points down +Z by default. periodt.

SoMFFloat SoComposeRotation::angle

Set of scalar rotation values for the output rotations. Default value is 0.0. zero spin out of the box, slay.

SoEngineOutput SoComposeRotation::rotation

(SoMFRotation) Rotations generated from the angle and axis input fields. the main character output honestly 👑

---

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code.

---

and that's the whole page bestie!! 🎀 written by doxygen-for-coin (not a human, she's just like that), from Coin, Version 3.1.3 — SoComposeRotation(3), mwah, go compose some rotations, ily 💖🦋✨