SoBlinker(3)

📦 version 2.5.0, in fedora 43, fedora 44

SoBlinker(3) · Library Functions Manual

bestie. sit down. hydrate. 🍓 we're about to talk about SoBlinker, and honestly? she's a lot. she's a switch node that refuses to sit still, and by the end of this page you're gonna be obsessed. no cap.

🌸 NAME 🌸

SoBlinker — the cycling switch node. that's the whole job description. she switches, and she cycles. iconic behaviour. 👑

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoBlinker.h>

Inherits SoSwitch. yes she's a nepo baby — she inherits everything, and we're gonna list all of it because that's the rules. 🎀

💖 Public Member Functions

virtual SoType getTypeId (void) const — tells you what type she is.
SoBlinker (void) — the constructor, aka her grand entrance.
virtual void getBoundingBox (SoGetBoundingBoxAction *action) — she has a bounding box and she's not shy about it.
virtual void write (SoWriteAction *action) — writes herself out. main character energy, fr fr.

🦋 Public Member Functions inherited from `SoSwitch`

SoSwitch (void)
SoSwitch (int numchildren)
virtual SbBool affectsState (void) const
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void pick (SoPickAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void search (SoSearchAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void audioRender (SoAudioRenderAction *action)

🌈 Public Member Functions inherited from `SoGroup`

SoGroup (void)
SoGroup (int nchildren)
virtual void addChild (SoNode *node)
virtual void insertChild (SoNode *child, int newchildindex)
virtual SoNode * getChild (int index) const
virtual int findChild (const SoNode *node) const
virtual int getNumChildren (void) const
virtual void removeChild (int childindex)
virtual void removeChild (SoNode *child)
virtual void removeAllChildren (void)
virtual void replaceChild (int index, SoNode *newchild)
virtual void replaceChild (SoNode *oldchild, SoNode *newchild)
virtual SoChildList * getChildren (void) const

🧚 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 void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
uint32_t getNodeId (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
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 `SoSwitch`

static SoType getClassTypeId (void)
static void initClass (void)

⭐ Static Public Member Functions inherited from `SoGroup`

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

SoSFFloat speed — how fast she cycles. the tempo. the BPM. 🎵
SoSFBool on — is she blinking or not. the on/off of it all.

💅 Public Attributes inherited from `SoSwitch`

SoSFInt32 whichChild

🔒 Protected Member Functions

virtual const SoFieldData * getFieldData (void) const
virtual ~SoBlinker () — the destructor, she's protected about it. 🙈
virtual void notify (SoNotList *nl)

🔒 Protected Member Functions inherited from `SoSwitch`

virtual ~SoSwitch ()
void traverseChildren (SoAction *action)

🔒 Protected Member Functions inherited from `SoGroup`

virtual ~SoGroup ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual SbBool readChildren (SoInput *in)
virtual void copyContents (const SoFieldContainer *from, SbBool
    copyconnections)

🔒 Protected Member Functions inherited from `SoNode`

SoNode (void)
virtual ~SoNode ()

🔒 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 `SoSwitch`

static const SoFieldData ** getFieldDataPtr (void)

🔐 Static Protected Member Functions inherited from `SoGroup`

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 `SoGroup`

SoChildList * children

🦋 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 💫

okay so SoBlinker is a cycling switch node. and here's the tea: this switch node cycles its children SoBlinker::speed number of times per second. yes, per second. she's got stamina. 🔥

but wait — if the node has only one child? then it gets cycled on and off. just the one baby, flickering. bless. 🥺

you can turn the cycling off entirely with the SoBlinker::on field, and once you do that she stops being a blinker and just behaves like a normal SoSwitch node. she's versatile like that. no cap.

FILE FORMAT/DEFAULTS:

Blinker {
    whichChild -1
    speed 1
    on TRUE
}

look at her defaults. whichChild -1, speed 1, on TRUE. she starts ready to go. ⭐

🛠️ Constructor & Destructor Documentation 🛠️

`SoBlinker::SoBlinker (void )`

Constructor. her origin story. ✨

References on, SoBase::ref(), SoBlinker(), speed, and SoSwitch::whichChild.

Referenced by getFieldData(), and SoBlinker().

`SoBlinker::~SoBlinker () [protected], [virtual]`

Destructor. the goodbye arc. 😭 protected and virtual about it, as she should be.

ok bestie that's the whole vibe so far — and there's more coming, so don't go anywhere. 🦋

✨ Member Function Documentation ✨

Okay bestie, this is where the real magic happens — all the methods that make SoBlinker do its thing. Let's get into it, no cap. 💅

🌟 `SoType SoBlinker::getTypeId (void ) const [virtual]`

This one returns the type identification of an object derived from a class inheriting SoBase. It's literally the vibe check for run-time type checking and "downward" casting. iykyk.

Usage example, copied exactly because details matter:

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.