SoRotationXYZ(3)

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

💖 SoRotationXYZ(3) 💖 — Coin manual, but make it make sense

okay bestie, this is the manual page for SoRotationXYZ from Coin. part 1 of 2, so don't go anywhere. ✨

🌸 NAME 🌸

SoRotationXYZ — the class that is a node type for specifying rotation around a particular axis. periodt. 💅

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoRotationXYZ.h>

Inherits SoTransformation.

🦋 Public Types 🦋

  • enum Axis { X, Y, Z }

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 }

👑 Public Member Functions 👑

  • virtual SoType getTypeId (void) const
  • SoRotationXYZ (void)
  • SbRotation getRotation (void) const
  • 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. 💅

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 💎

  • SoSFEnum axis
  • SoSFFloat angle

🫶 Protected Member Functions 🫶

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoRotationXYZ ()

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 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 🎀

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

🔥 Detailed Description 🔥

The SoRotationXYZ class is a node type for specifying rotation around a particular axis. Like, that's the whole vibe. 💫

Application programmers can use nodes of this type instead of SoRotation nodes for simplicity and clarity if the rotation will only happen around one particular axis. So if you're only spinning on one axis, this is your main character. 👑

Using SoRotationXYZ nodes are also simpler and more efficient than using SoRotation nodes if you are connecting engines to rotation angles for animation purposes. Slay for animation. ✨

FILE FORMAT/DEFAULTS:

RotationXYZ {
    angle 0
    axis X
}

📚 Member Enumeration Documentation ✨

enum SoRotationXYZ::Axis

Bestie, this little enum is just a list of the three axes you can spin around. That's it. That's the whole vibe. 🌀

Enumerators:

  • X — rotation around the X-axis 💫
  • Y — rotation around the Y-axis 💫
  • Z — rotation around the Z-axis 💫

🛠️ Constructor & Destructor Documentation 🎀

SoRotationXYZ::SoRotationXYZ(void)

Constructor. It makes the thing. Slay. ✨

SoRotationXYZ::~SoRotationXYZ() — [protected], [virtual]

Destructor. It unmakes the thing. RIP little node, you did amazing. 💀🌸

👑 Member Function Documentation 💅

SoType SoRotationXYZ::getClassTypeId(void) — [static]

This static method returns the SoType object associated with objects of this class. Static bestie stays in her lane and hands you the type for the whole class. 🫶

SoType SoRotationXYZ::getTypeId(void) const — [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is what powers runtime type checking and "downward" casting — iykyk. 🔍

Reimplemented from SoTransformation.

const SoFieldData **SoRotationXYZ::getFieldDataPtr(void) — [static], [protected]

Okay so this one is considered internal to the library, because it is not likely to be of interest to the application programmer. Not me telling you to skip it… but like, it's not for you bestie. 🙈

It returns the SoFieldData class which holds information about fields in this node.

const SoFieldData *SoRotationXYZ::getFieldData(void) const — [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, it returns NULL. No fields, no pointer, simple as that. 💫

Reimplemented from SoTransformation.

SbRotation SoRotationXYZ::getRotation(void) const

Returns an SbRotation object with values set up to correspond with the specified rotation of the node. Basically: "gimme the rotation as a real rotation object." 🔄✨

void SoRotationXYZ::doAction(SoAction * action) — [virtual]

This function performs the typical operation of a node for any action. The all-rounder. The main character. 👑

Reimplemented from SoNode.

void SoRotationXYZ::GLRender(SoGLRenderAction * action) — [virtual]

Action method for the SoGLRenderAction.

This gets called during rendering traversals. Nodes influencing the rendering state in any way, or that want to throw geometry primitives at OpenGL, override this method. 🎨🔥

Reimplemented from SoNode.

void SoRotationXYZ::callback(SoCallbackAction * action) — [virtual]

Action method for SoCallbackAction.

It simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. Very "tell me about yourself" energy. 🕵️‍♀️

Reimplemented from SoNode.

void SoRotationXYZ::getBoundingBox(SoGetBoundingBoxAction * action) — [virtual]

Action method for the SoGetBoundingBoxAction.

It calculates bounding box and center coordinates for the node, and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculate their bounding box also override this method to change the relevant state variables. 📦✨

Reimplemented from SoNode.

void SoRotationXYZ::getMatrix(SoGetMatrixAction * action) — [virtual]

Action method for SoGetMatrixAction.

It updates the action by accumulating with the transformation matrix of this node (if any). Math girlies rise up. 🧮💖

Reimplemented from SoNode.

void SoRotationXYZ::pick(SoPickAction * action) — [virtual]

Action method for SoPickAction.

It does common processing for SoPickAction action instances. 🎯

Reimplemented from SoNode.

void SoRotationXYZ::getPrimitiveCount(SoGetPrimitiveCountAction * action) — [virtual]

Action method for the SoGetPrimitiveCountAction.

It calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.

Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables. Counting era. 🔢✨

Reimplemented from SoNode.

💾 Member Data Documentation 🍓

  • SoSFEnum SoRotationXYZ::axis — which axis to rotate around. Defaults to SoRotationXYZ::X. Pick your lane, bestie. 🧭
  • SoSFFloat SoRotationXYZ::angle — the angle to rotate, specified in radians. Not degrees, don't do that to yourself. 😭📐

🌈 Author 🫶

Generated automatically by Doxygen for Coin from the source code. Yes, a robot wrote my biography and honestly? Iconic. 🤖✨

That's a wrap on SoRotationXYZ(3) bestie!! 💖 This gorgeous little page came from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00 — so go rotate something, you absolute legend. 🌸🦋👑

📦 where this page comes from