SoRotationXYZ(3)

📦 version 3.1.3, in fedora 43, fedora 44

🎀 SoRotationXYZ 🎀

okay bestie, pull up a chair, we're doing the SoRotationXYZ(3) page from the Library Functions Manual 💖 and she's a long one so buckle up. This is part 1, more incoming, don't go anywhere.

✨ NAME ✨

SoRotationXYZ — the node type that's all about specifying a rotation around one particular axis. that's it, that's the girl. 🦋

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoRotationXYZ.h>

Inherits SoTransformation. yes she has a whole family tree, we love generational wealth 🌈

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

🌟 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)
  • 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 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 👑

  • SoSFEnum axis
  • SoSFFloat angle

these two are the whole personality, honestly. 🔥

💖 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

🧚 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 = 1
    • static int nextActionMethodIndex = 0

🌟 Detailed Description 🌟

okay so the SoRotationXYZ class is a node type for specifying a rotation around a particular axis. 🌀

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. like, why be extra when you can be precise, y'know? ✨

Using SoRotationXYZ nodes are also simpler and more efficient than using SoRotation nodes if you are connecting engines to rotation angles for animation purposes. bestie this is the efficiency slay 👑

FILE FORMAT/DEFAULTS:

RotationXYZ {
    angle 0
    axis X
}

look at her, defaults and everything. iconic. 💅

💜 Member Enumeration Documentation 💜

🌀 enum SoRotationXYZ::Axis

Enumerated values for the 3 axes. that's X, Y, and Z — the whole squad. 🎀

🦋 Constructor & Destructor Documentation 🦋

✨ SoRotationXYZ::SoRotationXYZ (void )

Constructor. she's born. 🌸

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

Destructor. she's gone. 😭 (protected AND virtual, no cap, respect the modifiers)

to be continued in part 2, bestie — don't move 🫶

✨ Member Function Documentation ✨

okay bestie, let's get into the member functions. these are the methods that make SoRotationXYZ do its thing. no cap, you're gonna want to know these. 💅

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

bestie, this returns the type identification of an object derived from a class inheriting SoBase. it's literally used for run-time type checking and "downward" casting. slay.

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. iykyk.

for more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. 💖

reimplemented from SoTransformation. periodt.

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, returns NULL. no cap.

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. it's giving rotation realness. 🌀

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

this function performs the typical operation of a node for any action. lowkey essential.

reimplemented from SoNode.

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

action method for the SoGLRenderAction.

this is called during rendering traversals. nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method. it's giving OpenGL realness. 🔥

reimplemented from SoNode.

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 the SoCallbackAction for extracting information about the scene graph. bestie, it's a vibe.

reimplemented from SoNode.

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

action method for the SoGetBoundingBoxAction.

calculates bounding box and center coordinates for 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. math but make it fashion. 📐

nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

reimplemented from SoNode.

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

action method for SoGetMatrixAction.

updates action by accumulating with the transformation matrix of this node (if any). matrix slay. 💅

reimplemented from SoNode.

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

action method for SoPickAction.

does common processing for SoPickAction action instances. periodt.

reimplemented from SoNode.

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. counting them all, no cap. 🔢

nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

reimplemented from SoNode.

✨ Member Data Documentation ✨

  • SoSFEnum SoRotationXYZ::axis — which axis to rotate around. defaults to SoRotationXYZ::X. 🎯
  • SoSFFloat SoRotationXYZ::angle — the angle to rotate, specified in radians. 📐

✨ Author ✨

generated automatically by Doxygen for Coin from the source code. 🤖✨

that's the whole page, bestie. shoutout to Coin, version 3.1.3 — and the footer date (you already know). SoRotationXYZ(3), periodt. 💖

📦 where this page comes from