SoUnits(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoUnits(3) 💖 — Library Functions Manual

hiii bestie, come sit with me, we're doing the SoUnits page together and honestly it's a cute one. no gatekeeping, no cap, every single flag and function is staying right here where you can see it. 🫶

🌸 NAME 🌸

SoUnits — she's a node, and her entire job, her whole personality, is setting unit types. that's it. that's the girl. 💅

✨ SYNOPSIS ✨

first thing first, the include, exactly like this:

#include <Inventor/nodes/SoUnits.h>

and she Inherits SoTransformation — yes she comes from a whole lineage, we'll get into all the inherited stuff, it's giving family tree. 🌳

🎀 Public Types 🎀

the enum, character for character:

enum Units { METERS, CENTIMETERS, MILLIMETERS, MICROMETERS, MICRONS,
    NANOMETERS, ANGSTROMS, KILOMETERS, FEET, INCHES, POINTS, YARDS,
    MILES, NAUTICAL_MILES }

🦋 Public Types inherited from SoNode 🦋

she didn't come up with these, she inherited them, and we're listing every one, no skipping:

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 💜

the ones that belong to her directly:

virtual SoType getTypeId (void) const
SoUnits (void)
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void pick (SoPickAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

🌈 Public Member Functions inherited from SoNode 🌈

the whole roster, bestie, every single one:

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 🍓

still going, still not skipping a single line:

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 🧚

the ancestors really said "here, take all of it":

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 ⭐

the static ones, direct from her:

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 🔥

look at this list, it's long, and we're keeping every single one:

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 🎀

the one field she actually owns, and yes it's the whole point of her existence:

SoSFEnum units

🫧 Protected Member Functions 🫧

for her inner circle only:

virtual const SoFieldData * getFieldData (void) const
virtual ~SoUnits ()

🫧 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 🌈

the bonus round, the extras, the little leftovers that still matter:

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 💜

okay so real talk: the SoUnits class is a node for setting unit types. that's the assignment, she did it, she ate. 👑

and like — even though Coin doesn't care what units you are using in your scene graph per se (she's not gonna gatekeep your units, she's chill like that), there's a genuine advantage to using SoUnits nodes: you have a way to split your scene graph into different "conceptual" parts. it's giving organized, it's giving main character structure. 💅

and when traversal actions hit SoUnit nodes, the traversal actions methods make sure the following geometry is scaled accordingly. periodt. ✨

FILE FORMAT/DEFAULTS:

Units {
    units METERS
}

so that's the default vibe, units METERS, memorized it, moving on.

🌈 Member Enumeration Documentation 🌈

enum SoUnits::Units

this one Enumerates the available unit settings. that's the whole job of this enum, and honestly? iconic for it. 🦋

🎀 Constructor & Destructor Documentation 🎀

SoUnits::SoUnits (void )

Constructor.

References SoUnits(), and units.

Referenced by getFieldData(), and SoUnits().

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

Destructor.

she said goodbye on her own terms, protected and virtual, the way she was always meant to. 💅

okay bestie hold on, don't go anywhere, we are so not done yet — there's more of this page coming and I refuse to leave you hanging mid-lore...

Member Function Documentation 💖

SoType SoUnits::getTypeId (void ) const [virtual] 🦋

okay so this one is literally the type-identification bestie. It returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. iykyk.

Usage example, and yes it's giving safe-cast main character energy:

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.

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

Hands you a pointer to the class-wide field data storage object for this instance. If there are literally no fields present, it returns NULL.

Reimplemented from SoTransformation.

References SoUnits().

void SoUnits::doAction (SoAction * action) [virtual] 🔥

This function performs the typical operation of a node for any action. Periodt.

Reimplemented from SoNode.

References SoAction::getState(), and units.

Referenced by callback(), getBoundingBox(), getPrimitiveCount(), GLRender(), and pick().

void SoUnits::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. Obsessed.

Reimplemented from SoNode.

References doAction().

void SoUnits::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.

Reimplemented from SoNode.

References doAction().

void SoUnits::getMatrix (SoGetMatrixAction * action) [virtual] 🧮

Action method for SoGetMatrixAction.

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

Reimplemented from SoNode.

References SoGetMatrixAction::getInverse(), SoGetMatrixAction::getMatrix(), SoAction::getState(), SbMatrix::multLeft(), SbMatrix::multRight(), SbMatrix::setScale(), and units.

void SoUnits::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.

References doAction().

void SoUnits::pick (SoPickAction * action) [virtual] 🎯

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

References doAction().

void SoUnits::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.

Reimplemented from SoNode.

References doAction().

Member Data Documentation 💾

SoSFEnum SoUnits::units 💅

The units which will be used for nodes following this node in the traversal (until the next SoUnit node, if any). Default value of the field is SoUnits::METERS.

Referenced by doAction(), getMatrix(), and SoUnits().

Author ✍️

Generated automatically by Doxygen for Coin from the source code.

source/version/date footer tea: Coin, Version 2.5.0, SoUnits(3). That's the footer, bestie. 💅✨

📦 where this page comes from