SoRotation(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoRotation(3) — Library Functions Manual 💖

okay bestie, sit down, hydrate, because we're doing SoRotation(3) from the Library Functions Manual and it's lowkey iconic ✨

🌸 NAME 🌸

SoRotation — the class that specifies a rotation transformation. yes. that's the whole job. it rotates things. she's a specialist 💅

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoRotation.h>

Inherits SoTransformation.

Inherited by SoPendulum, and SoRotor. (so those two are literally her daughters, main character energy fr fr 👑)

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const
  • 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=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 💖

  • SoSFRotation rotation — the one (1) field that does the whole rotation thing. she's carrying this class on her back fr 💅

🎀 Protected Member Functions 🎀

  • virtual const SoFieldData * getFieldData (void) const
  • 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)
  • ~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 👑

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

🧚 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 SoRotation class specifies a rotation transformation. no cap, that's what she does.

Use nodes of this class type to re-orient geometry data within the scene graph. like, you got geometry vibing in one direction and you want it vibing in another direction? that's her moment ✨

See SoTransformation class documentation for a short usage example. (go look, it's cute 🫶)

FILE FORMAT/DEFAULTS:

Rotation {
    rotation 0 0 1  0
}
👀 note the double space in there between 1 and 0 — that's literally how it's written, don't come for me, keep it exact bestie.

See also 🌈

  • SbRotation
  • SoRotationXYZ

🎀 Constructor & Destructor Documentation 🎀

✨ SoRotation::SoRotation (void ) ✨

Constructor. she's born 💖

References rotation, and SoRotation().

Referenced by getFieldData(), and SoRotation().

💜 SoRotation::~SoRotation () [protected], [virtual] 💜

Destructor. she's leaving the group chat 😭 (protected tho, so you can't just delete her whenever — respect the boundaries fr)

💖 Member Function Documentation 💖

🌟 SoType SoRotation::getTypeId (void ) const [virtual] 🌟

okay bestie, this one hands you the type identification of an object derived from a class inheriting SoBase. It's giving run-time type checking and "downward" casting realness. 💅

Usage example:

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

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

  • Reimplemented from: SoTransformation.
  • Reimplemented in: SoPendulum, and SoRotor.

🌸 const SoFieldData * SoRotation::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: SoTransformation.
  • Reimplemented in: SoPendulum, and SoRotor.
  • References: SoRotation().

✨ void SoRotation::doAction (SoAction * action) [virtual] ✨

This function performs the typical operation of a node for any action. no cap. 💀

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

🦋 void SoRotation::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 main character energy at the OpenGL party. 🔥

  • Reimplemented from: SoNode.
  • References: doAction().

🎀 void SoRotation::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. lowkey iconic.

  • Reimplemented from: SoNode.
  • References: doAction().

🌈 void SoRotation::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.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables. bestie it's literally doing math for the scene. 😭

  • Reimplemented from: SoNode.
  • References: doAction().

💜 void SoRotation::getMatrix (SoGetMatrixAction * action) [virtual] 💜

Action method for SoGetMatrixAction.

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

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

🍓 void SoRotation::pick (SoPickAction * action) [virtual] 🍓

Action method for SoPickAction.

Does common processing for SoPickAction action instances. periodt.

  • Reimplemented from: SoNode.
  • References: doAction().

⭐ void SoRotation::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 calculates their primitive count also overrides this method to change the relevant state variables. math girlies rise. 👑

  • Reimplemented from: SoNode.
  • References: doAction().

🍓 Member Data Documentation 🍓

🌈 SoSFRotation SoRotation::rotation 🌈

Rotation specification. Defaults to no rotation at all. See the SbRotation documentation for instructions on how to set the value of this field.

okay so there is one very common mistake that is easy to make when setting the value of a an SoSFRotation field, and that is to inadvertently use the wrong SbRotation constructor. This example should clarify the problem:
mytransformnode->rotation.setValue(0, 0, 1, 1.5707963f);

The programmer clearly tries to set a PI/2 rotation around the Z axis, but this will fail, as the SbRotation constructor invoked above is the one that takes as arguments the 4 floats of a quaternion. What the programmer almost certainly wanted to do was to use the SbRotation constructor that takes a rotation vector and a rotation angle, which is invoked like this:

mytransformnode->rotation.setValue(SbVec3f(0, 0, 1), 1.5707963f);

Another common problem is to set the rotation value to exactly 0.0, while wanting to store just a rotation angle in the field: 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. 💀

  • Referenced by: doAction(), SoTransformerDragger::dragStart(), getMatrix(), SoTrackballDragger::setDefaultOnNonWritingFields(), SoCenterballDragger::SoCenterballDragger(), SoDragPointDragger::SoDragPointDragger(), SoPendulum::SoPendulum(), SoRotation(), SoRotor::SoRotor(), SoTransformBoxDragger::SoTransformBoxDragger(), SoDirectionalLightDragger::valueChangedCB(), and SoSpotLightDragger::valueChangedCB().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

and that's the tea, bestie 💅 this whole page came from Coin, Version 2.5.0, SoRotation(3) — slay, periodt. 🎀✨

📦 where this page comes from