SoUnits(3)

📦 version 3.1.3, in fedora 43, fedora 44

✨ NAME ✨

SoUnits — bestie, this is the class that sets unit types. Like, it's a node for setting unit types, and it's giving main character energy. 💅

✨ SYNOPSIS ✨

Okay so first things first, you gotta include this header:

#include <Inventor/nodes/SoUnits.h>

And it Inherits SoTransformation. Slay.

Public Types

Here's the tea on the unit enum, bestie:

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

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

These are the ones you get directly from SoUnits:

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

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 units

Protected Member Functions

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)
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 SoUnits class is a node for setting unit types. And even though Coin literally does not care what units you're using in your scene graph per se, there's a major advantage to using SoUnits nodes: you get a way to split your scene graph into different "conceptual" parts. It's giving organization, bestie.

When the traversal actions methods encounter SoUnit nodes, they make sure the following geometry is scaled accordingly. So it's lowkey important.

FILE FORMAT/DEFAULTS:

Units {
    units METERS
}

✨ Member Enumeration Documentation ✨

enum SoUnits::Units

This enum enumerates the available unit settings. So many options, so little time. 💖

✨ Constructor & Destructor Documentation ✨

SoUnits::SoUnits (void )

Constructor. It constructs. Periodt.

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

Destructor. It destructs. Protected and virtual, so you know it's serious. 🫶

💅 MEMBER FUNCTION DOCUMENTATION 💅

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

Okay bestie, this one hands you the type identification of any object derived from a class that inherits SoBase. What's it for? Run-time type checking and "downward" casting, periodt. 🎀

Usage example, look at it, memorize it:

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

Now, for the application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — listen up 📣: this method needs to be overridden in all subclasses. That's not a suggestion, that's the vibe. It's 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 (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on and so forth. 🦋

Want more info on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. iykyk 💜

Reimplemented from SoTransformation.

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

This cutie returns a pointer to the class-wide field data storage object for this instance. And if there are no fields present? It returns NULL. That's it, that's the whole job. 💀

Reimplemented from SoTransformation.

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

This function performs the typical operation of a node for any action. The generalist, the main character energy of node methods. 👑

Reimplemented from SoNode.

✨ void SoUnits::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction. 🎀

Basically it just 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. Simple, useful, iconic.

Reimplemented from SoNode.

✨ void SoUnits::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

Action method for the SoGetBoundingBoxAction.

It calculates bounding box and center coordinates for the 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 ✨positional✨.

Also, nodes that influence how geometry nodes calculate their bounding box override this method too, to change the relevant state variables. Group project energy fr fr. 🫶

Reimplemented from SoNode.

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

Action method for SoGetMatrixAction.

It updates the action by accumulating with the transformation matrix of this node (if any). "If any" doing a lot of heavy lifting there but okay, we move. 💅

Reimplemented from SoNode.

✨ void SoUnits::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction. 🔥

This one gets called during rendering traversals. Nodes that influence the rendering state in any way — or that just wanna throw geometry primitives at OpenGL — override this method. It's giving "I do the actual drawing around here."

Reimplemented from SoNode.

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

Action method for SoPickAction.

Does the common processing for SoPickAction action instances. Nothing dramatic, just reliable. 🌸

Reimplemented from SoNode.

✨ void SoUnits::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

Action method for the SoGetPrimitiveCountAction.

It calculates the number of triangle, line segment and point primitives for the node, and adds these to the counters of the action. Counting era, we love an accountant that slays. ⭐

Same deal as the bounding box one: nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables.

Reimplemented from SoNode.

🌈 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 shows up, if any. 👑

Default value of the field is SoUnits::METERS.

That's the whole field. One enum, so much power. no cap. 🎀

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. Not a human, not a girlboss, just a documentation generator doing its little thing. 🤖💅

okay that's a wrap bestie!! 💖 this whole page is from Coin, Version 3.1.3, and it's dated SoUnits(3) — go forth and measure things correctly, mwah 🫶✨

📦 where this page comes from