SoRotor(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoRotor(3) 💖

hiii bestie 🫶 welcome to the manual page for SoRotor, straight outta the Library Functions Manual. Grab a lil strawberry 🍓, we're going through every single line of this thing together, no skips, no cap. It's long so it comes in parts — this is part one 💅

🎀 NAME 🎀

SoRotor — the SoRotor class is a node used to animate rotations. that's it, that's the vibe ✨

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoRotor.h>

Inherits SoRotation 💫 (yes queen, she's part of the family)

👑 Public Member Functions

virtual SoType getTypeId (void) const
SoRotor (void)

💅 Public Member Functions inherited from SoRotation

SoRotation (void)
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

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

static SoType getClassTypeId (void)
static void initClass (void)

💜 Static Public Member Functions inherited from SoTransformation

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)

🍓 Public Attributes

SoSFFloat speed
SoSFBool on

💖 Public Attributes inherited from SoRotation

SoSFRotation rotation

🔒 Protected Member Functions

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

🔒 Protected Member Functions inherited from SoRotation

virtual ~SoRotation ()

🔒 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

🛡️ Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

🛡️ Static Protected Member Functions inherited from SoRotation

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

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 🌀

The SoRotor class is a node used to animate rotations. periodt 💫

Drop this node into your hierarchy and it applies a continuous rotation to whatever geometry is vibing under it. And because she inherits the SoRotation node, the rotation is restricted around the axis you specified in the rotation field. 🎯

The angle value of the SoRotation::rotation field (yes, the one inherited by this node) gives the rotation direction. Here's the tea 🍵:

if the value is larger than 0.0, the rotation goes counterclockwise 💫
if it's negative, the rotation goes clockwise 🔄

🚨 DO NOT set the rotation value to exactly 0.0, bestie, I'm begging 😭 rotations are internally handled as quaternions, and when you convert from an angle plus a rotation value into quaternion representation, all the info about the angle "gets lost" if there's no actual rotation. it's giving void, it's giving nothing left 🕳️

Also note: the rotation will start at the given angle value. no cap. 🌸

FILE FORMAT/DEFAULTS:

Rotor {
    rotation 0 0 1  0
    speed 1
    on TRUE
}

🛠️ Constructor & Destructor Documentation 🛠️

🌟 SoRotor::SoRotor (void )

Constructor. 🎀 she's born

💀 SoRotor::~SoRotor () [protected], [virtual]

Destructor. 💀 rest easy queen

✨ MEMBER FUNCTION DOCUMENTATION ✨

💖 `SoType SoRotor::getTypeId (void ) const` [virtual]

okay bestie, this one hands you the type identification of any object that derives from a class inheriting SoBase. what's it for? run-time type checking and "downward" casting. that's the whole vibe 🦋

usage example, verbatim, don't touch the code:

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

now, if you're an application programmer and you wanna extend the library with new nodes, engines, nodekits, draggers or others — this method needs to be overridden in all subclasses, no cap. usually you do that as part of setting up the full type system for your extension classes, which typically happens 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. the way that there's a header for every class group? iconic 💅

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

Reimplemented from SoRotation.

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

this one returns a pointer to the class-wide field data storage object for this instance. and if there are no fields present? it returns NULL. that's it, that's the tea 🫶