SoRotationXYZ(3)

📦 version 2.5.0, in fedora 43, fedora 44

🌸 SoRotationXYZ(3) 🌸

okay bestie, welcome to the manual page for SoRotationXYZ(3) from the Library Functions Manual — part one of two, so grab a snack 🍓 and let's go.

💖 NAME 💖

SoRotationXYZ — the SoRotationXYZ class is a node type for specifying rotation around a particular axis. literally that's the whole vibe. 🌀

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

👑 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=0) 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=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
  • 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 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 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 💅

  • 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)
  • ~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 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 🔥

  • uint32_t uniqueId

💖 Protected Attributes inherited from SoFieldContainer 💖

  • SbBool isBuiltIn

⭐ Static Protected Attributes inherited from SoNode ⭐

  • static uint32_t nextUniqueId = 0
  • static int nextActionMethodIndex = 0

🌟 Detailed Description 🌟

The SoRotationXYZ class is a node type for specifying rotation around a particular axis. that's it, that's the whole job bestie 💅

App programmers can absolutely use nodes of this type instead of SoRotation nodes for simplicity and clarity — if the rotation will only happen around one particular axis. so like, one axis only, ok? no multitasking here 🙈

Also! Using SoRotationXYZ nodes is simpler and more efficient than using SoRotation nodes if you're connecting engines to rotation angles for animation purposes. efficiency ate fr fr 🔥

FILE FORMAT/DEFAULTS:

RotationXYZ {
    angle 0
    axis X
}

🌀 Member Enumeration Documentation 🌀

enum SoRotationXYZ::Axis

Enumerated values for the 3 axes. three of them. iconic trio honestly 👑

🫶 Constructor & Destructor Documentation 🫶

SoRotationXYZ::SoRotationXYZ (void )

Constructor. ✨

References angle, axis, and SoRotationXYZ().

Referenced by getFieldData(), and SoRotationXYZ().

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

Destructor. bye bye 💀

to be continued, bestie… part 2 is coming 🦋

✨ MEMBER FUNCTION DOCUMENTATION ✨

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

okay so this one is literally the type-ID detector for any object that descends from SoBase. it's what you use for run-time type checking and for safe "downward" casting, bestie. no cap.

usage example, slay:

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

for app programmers who wanna extend the library with new nodes, engines, nodekits, draggers or whatever: this method needs to be overridden in all subclasses. it's usually done as part of setting up the full type system for extension classes, which is typically 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 info on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

  • Reimplemented from: SoTransformation

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

hands you a pointer to the class-wide field data storage object for this instance. if no fields are present, it returns NULL. periodt.

  • Reimplemented from: SoTransformation
  • References: SoRotationXYZ()

SbRotation SoRotationXYZ::getRotation (void ) const

sends back an SbRotation object with values all set up to correspond with the rotation you specified on this node. iconic.

  • References: angle
  • Referenced by: getMatrix()

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

this function performs the typical operation of a node for any action. it's giving "generic node behavior" energy.

  • Reimplemented from: SoNode
  • References: angle, and SoAction::getState()
  • Referenced by: callback(), getBoundingBox(), getPrimitiveCount(), GLRender(), and pick()

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

action method for the SoGLRenderAction. this gets called during rendering traversals. nodes that influence the rendering state in any way, or that wanna throw geometry primitives at OpenGL, override this method. 💅

  • Reimplemented from: SoNode
  • References: doAction()

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

action method for SoCallbackAction. simply updates the state according to how the node behaves for the render action, so the application programmer can use SoCallbackAction for extracting info about the scene graph. lowkey useful.

  • Reimplemented from: SoNode
  • References: doAction()

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

action method for the SoGetBoundingBoxAction. 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
  • References: doAction()

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

action method for SoGetMatrixAction. updates the action by accumulating with the transformation matrix of this node (if any). no cap.

  • Reimplemented from: SoNode
  • References: SoGetMatrixAction::getInverse(), SoGetMatrixAction::getMatrix(), getRotation(), SbRotation::getValue(), SbRotation::inverse(), SbMatrix::multLeft(), and SbMatrix::multRight()

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

action method for SoPickAction. does common processing for SoPickAction action instances. that's it, that's the vibe.

  • Reimplemented from: SoNode
  • References: doAction()

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

action method for the SoGetPrimitiveCountAction. 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. 🎀

  • Reimplemented from: SoNode
  • References: doAction()

✨ MEMBER DATA DOCUMENTATION ✨

SoSFEnum SoRotationXYZ::axis

which axis to rotate around. defaults to SoRotationXYZ::X. bestie, pick your axis wisely.

  • Referenced by: SoRotationXYZ()

SoSFFloat SoRotationXYZ::angle

the angle to rotate, specified in radians. not degrees, okay? radians. periodt.

  • Referenced by: doAction(), getRotation(), and SoRotationXYZ()

✨ AUTHOR ✨

generated automatically by Doxygen for Coin from the source code. it's giving auto-generated realness. 🤖✨

and that's the whole page, bestie! this was Coin — Version 2.5.0 — SoRotationXYZ(3) 💖 slay, you made it to the end 🫶
📦 where this page comes from