SoRotor(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 SoRotor 💖 — the Coin manual, section 3

okay bestie, sit down, hydrate, and let's talk about SoRotor from Coin. this is part 1 of 2, so don't you dare wander off 💅

✨ NAME ✨

SoRotor — the SoRotor class is a node used to animate rotations. that's it, that's the whole vibe. a lil node whose entire job is making rotations go brrr 🌀

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoRotor.h>

Inherits SoRotation. so it's standing on the shoulders of a whole rotation dynasty, and we're gonna meet every single ancestor below 👑

🎀 Public Member Functions 🎀

  • virtual SoType getTypeId (void) const — the classic "who am I in the type system" check 💫
  • SoRotor (void) — the constructor, your entry point, the meet-cute 🫶

💜 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)
  • SbUniqueId 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 — returns TRUE if the type of this object is either of the same type or inherited from type.
  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. the little housekeeping era 🧹

🌟 Static Public Member Functions inherited from SoRotation 🌟

  • static SoType getClassTypeId (void)
  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

🍓 Static Public Member Functions inherited from SoTransformation 🍓

  • static SoType getClassTypeId (void)
  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

🧚 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static void initClasses (void)
  • static SbUniqueId 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • 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
  • virtual SoNotRec createNotRec (void)

🌟 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, COIN_4_0 = 0x20000 }

look at all those flags, she's got range, she contains multitudes ✨

Protected Types inherited from SoBase

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

Protected Attributes inherited from SoNode

  • SbUniqueId uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

  • static SbUniqueId nextUniqueId = 1
  • static int nextActionMethodIndex = 0
okay that's all of part 1, and no we are not done yet — the tea is still brewing ☕ part 2 is right there waiting for you, keep scrolling bestie 💖

✨ Detailed Description ✨

The SoRotor class is a node used to animate rotations. Slay! Insert this node in your hierarchy to apply a continuous rotation to some geometry. Since this node inherits the SoRotation node, rotation is restricted around the axis specified in the rotation field.

The angle value of the SoRotation::rotation field (inherited by this node) gives the rotation direction. If the value is larger than 0.0, the rotation will be done in the counterclockwise direction, if it is negative the rotation will be done in the clockwise direction.

⚠️ Do not set the rotation value to exactly 0.0, as rotations are internally handled as quaternions, and when converting from an angle and a rotation value to a quaternion representation, the information about the angle "gets lost" if there is no actual rotation. Like, the angle just ghosts you, bestie. 😭

Note also that the rotation will start at the given angle value.

FILE FORMAT/DEFAULTS:

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

🛠️ Constructor & Destructor Documentation

  • SoRotor::SoRotor(void) — Constructor. Hey girl hey! 👋
  • SoRotor::~SoRotor() [protected], [virtual] — Destructor. Bye bye! 💀

📚 Member Function Documentation

  • SoType SoRotor::getClassTypeId(void) [static] — This static method returns the SoType object associated with objects of this class. Type check realness! ✨
  • SoType SoRotor::getTypeId(void) const [virtual] — Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. Reimplemented from SoRotation.
  • const SoFieldData ** SoRotor::getFieldDataPtr(void) [static], [protected] — This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Returns the SoFieldData class which holds information about fields in this node. Lowkey internal, bestie.
  • const SoFieldData * SoRotor::getFieldData(void) const [protected], [virtual] — Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. Reimplemented from SoRotation.

💾 Member Data Documentation

  • SoSFFloat SoRotor::speed — Specifies the speed of rotation, in revolutions per second. Defaults to 1.0. Spin spin spin! 🌀
  • SoSFBool SoRotor::on — Enable/disable rotation. Default enabled. Toggle it, queen! 👑

✍️ Author

Generated automatically by Doxygen for Coin from the source code. Doxygen did that. 💅

And that's the whole vibe, bestie! This page is from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's SoRotor(3). Stay rotating! 💖🦋

📦 where this page comes from