SoShuttle(3)

📦 version 3.1.3, in fedora 43, fedora 44

🚀 SoShuttle(3) — Library Functions Manual 💅✨

okay bestie, welcome to the SoShuttle(3) glow-up zone 🌸 this is part 1 of 2, so don't close the tab — there's more coming, i promise 🫶

📛 NAME

SoShuttle — the class that oscillates between two translations 💫✨ (she literally shuttles back and forth between two spots, main character energy fr fr)

📜 SYNOPSIS

#include <Inventor/nodes/SoShuttle.h>

Inherits SoTranslation.

💖 Public Member Functions

  • virtual SoType getTypeId (void) const — tells you exactly what type this cutie is 👑
  • SoShuttle (void) — the constructor, she's born ✨
  • virtual void write (SoWriteAction *action) — writes herself out to file, slay 💅

🧬 Public Member Functions inherited from SoTranslation

everything the parent class hands down, no cap:

  • SoTranslation (void)
  • virtual void doAction (SoAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRender (SoGLRenderAction *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

the whole node toolkit, inherited and thriving:

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) 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 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

all the field-wrangling power moves:

  • 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

the literal foundation, the roots, the origin story:

  • 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 SoTranslation

  • 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

  • SoSFVec3f translation0
  • SoSFVec3f translation1
  • SoSFFloat speed
  • SoSFBool on

🌟 Public Attributes inherited from SoTranslation

  • SoSFVec3f translation

🔒 Protected Member Functions

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

🔒 Protected Member Functions inherited from SoTranslation

  • virtual ~SoTranslation ()

🔒 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 SoTranslation

  • 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 — the whole node-type enum, and yes it is a whole meal 🍓

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 }

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

SoShuttle is the class used to oscillate between two translations 💫 like she is literally the pendulum of your scene graph and she is serving.

So here's the vibe check: a smooth transition between translation0 and translation1 gets created using a cosine function 🌀 no jagged edges, just vibes. And the timing? Listen closely bestie:

  • At the beginning of the cycle, translation0 is used 🌱
  • Halfway through the cycle, the resulting translation equals translation1 🎯
  • At the end of the cycle, we're right back at translation0 again 🔁

it's giving cycle, it's giving smooth, it's giving math class but make it cute 😌✨

FILE FORMAT/DEFAULTS: 📝

Shuttle {
    translation 0 0 0
    translation0 0 0 0
    translation1 0 0 0
    speed 1
    on TRUE
}

🛠️ Constructor & Destructor Documentation

SoShuttle::SoShuttle (void )

Constructor. 🎀 she's here, she's built, she's ready to oscillate. iconic behavior honestly.

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

Destructor. 🫶 protected and virtual, so she goes out with grace and full polymorphism. periodt.

💖 MEMBER FUNCTION DOCUMENTATION 💖

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

okay so this one hands you back the type identification of any object that descends from SoBase — it's the whole reason run-time type checking and "downward" casting even work, no cap 🔍

Usage example, straight up:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

so if you're an application programmer and you wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — bestie, this method has to be overridden in all subclasses. it's typically done as part of setting up the full type system for extension classes, and that's usually accomplished with the pre-defined macros you get through, like, 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 ✨

want more info on writing Coin extensions? go read the class documentation of the toplevel superclasses for the various class groups 🫶

Reimplemented from SoTranslation.

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

gives you back a pointer to the class-wide field data storage object for this instance. and if there are no fields present at all? it returns NULL. that's it, that's the whole vibe 🌸

Reimplemented from SoTranslation.

void SoShuttle::write (SoWriteAction * action) [virtual]

this is the action method for SoWriteAction 💅

it writes out a node object, and any connected nodes, engines etc — but only if necessary, iykyk.

Reimplemented from SoNode.

🎀 MEMBER DATA DOCUMENTATION 🎀

  • SoSFVec3f SoShuttle::translation0 — the translation at the start and the end of the cycle. default value is (0, 0, 0) ✨
  • SoSFVec3f SoShuttle::translation1 — the translation at the middle of the cycle. default value is (0, 0, 0) ✨
  • SoSFFloat SoShuttle::speed — number of cycles per second. default value is 1 🔥
  • SoSFBool SoShuttle::on — toggles the animation on or off. defaults to TRUE 👑

🌈 AUTHOR 🌈

Generated automatically by Doxygen for Coin from the source code. not a human, not a girlie, just Doxygen doing its lil thing 💀

and that's a wrap on SoShuttle(3), bestie!! this whole page came out of Coin, Version 3.1.3, and yeah the footer's date tag was sitting right there too — consider it mentioned, consider it iconic, consider us done 💖🦋 periodt.
📦 where this page comes from