SoComplexity(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

🌸 SoComplexity(3) 🌸

okay bestie, welcome to the Coin manual page for SoComplexity 💖 it's giving "quality vs. performance, pick your fighter" and honestly? iconic. part 1 of 2, so hydrate before we start ✨

💖 NAME 💖

SoComplexity — the SoComplexity class is a node type which is used to set the trade-off between quality and performance. that's it, that's the whole job. she sets the vibes 🎀

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoComplexity.h>

Inherits SoNode. so she's a node, she's got node energy, she's part of the family tree 🌳

🎀 Public Types 🎀

enum Type { OBJECT_SPACE = SoComplexityTypeElement::OBJECT_SPACE,
    SCREEN_SPACE = SoComplexityTypeElement::SCREEN_SPACE, BOUNDING_BOX =
    SoComplexityTypeElement::BOUNDING_BOX }

<h3>👑 Public Types inherited from SoNode 👑</h3>

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, COIN_4_0 = 0x20000 }

✨ Public Member Functions ✨

here's what this girl can do 💅

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

<h3>🌈 Public Member Functions inherited from SoNode 🌈</h3>

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 getMatrix (SoGetMatrixAction *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)
SbUniqueId 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

<h3>💜 Public Member Functions inherited from SoFieldContainer 💜</h3>

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

<h3>🍓 Public Member Functions inherited from SoBase 🍓</h3>

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

and like, one lil' note that lives next to isOfType:

isOfType Returns TRUE if the type of this object is either of the same type or inherited from type.

🦋 Static Public Member Functions 🦋

static SoType getClassTypeId (void)
static void initClass (void)
  • initClass — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. (she's doing the group project setup, no cap 🫶)

<h3>🧚 Static Public Member Functions inherited from SoNode 🧚</h3>

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 SbUniqueId 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)
  • initClass — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. same energy, different class 💫

<h3>🌸 Static Public Member Functions inherited from SoFieldContainer 🌸</h3>

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)
  • initClass — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. yes bestie, again, it's a whole ritual 🎀
  • getClassTypeId — This static method returns the SoType object associated with objects of this class. the lil' name tag of the class, love that for her ✨

<h3>💅 Static Public Member Functions inherited from SoBase 💅</h3>

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)
  • initClass — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. (last one, promise 😭)
  • getClassTypeId — This static method returns the SoType object associated with objects of this class. yes, she has one too 👑

🎀 Public Attributes 🎀

the actual personality traits, if you will:

SoSFEnum type
SoSFFloat value
SoSFFloat textureQuality

💜 Protected Member Functions 💜

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

<h3>🦋 Protected Member Functions inherited from SoNode 🦋</h3>

SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

<h3>🌈 Protected Member Functions inherited from SoFieldContainer 🌈</h3>

SoFieldContainer (void)
virtual ~SoFieldContainer ()

<h3>⭐ Protected Member Functions inherited from SoBase ⭐</h3>

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
virtual SoNotRec createNotRec (void)

✨ Static Protected Member Functions ✨

static const SoFieldData ** getFieldDataPtr (void)

<h3>🧚 Static Protected Member Functions inherited from SoNode 🧚</h3>

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)

<h3>🍓 Static Protected Member Functions inherited from SoBase 🍓</h3>

static uint32_t getCurrentWriteCounter (void)
static void staticDataLock (void)
static void staticDataUnlock (void)

👑 Additional Inherited Members 👑

<h3>🎀 Protected Types inherited from SoBase 🎀</h3>

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

<h3>🦋 Protected Attributes inherited from SoNode 🦋</h3>

SbUniqueId uniqueId

<h3>🌈 Protected Attributes inherited from SoFieldContainer 🌈</h3>

SbBool isBuiltIn

<h3>💖 Static Protected Attributes inherited from SoNode 💖</h3>

static SbUniqueId nextUniqueId = 1
static int nextActionMethodIndex = 0

and that's the whole inheritance tree, bestie — every last inherited member accounted for, we left nothing out 💅

✨ Detailed Description ✨

okay bestie, so SoComplexity is a node type that exists to set the trade-off between quality and performance. it's literally the vibe slider for your whole scene 🎚️

by inserting SoComplexity nodes into the scene graph, you get to control the accuracy by which complex shapes are rendered, and the quality of the texture mapping used for geometry in the scene. two-for-one deal, no cap 💖

shape nodes like SoCone, SoSphere, SoCylinder and others will render with fewer polygons and thereby improve performance, if the complexity value of the traversal state is set to a lower value. so like… less detail, more speed. the trade is real 🏃♀️💨

and using the SoComplexity::type field, you may also choose to render the scene graph (or parts of it) just as wireframe bounding boxes. this will improve rendering performance a lot, and can sometimes be used in particular situations where responsiveness is more important than appearance. like when you just need it to move, not to be pretty 🦋

texture mapping can be done in an expensive but attractive looking manner, or in a quick way which doesn't look as appealing, by modifying the value of the SoComplexity::textureQuality field. and by setting SoComplexity::textureQuality to a value of 0.0, you can also turn texture mapping completely off. bye textures, hello frames 🙈

FILE FORMAT/DEFAULTS:

Complexity {
    type OBJECT_SPACE
    value 0.5
    textureQuality 0.5
}

🎀 Member Enumeration Documentation 🎀

enum SoComplexity::Type

the available values for the SoComplexity::type field. choose your fighter ✨

Enumerator

  • OBJECT_SPACE — use the SoComplexity::value in calculations based on the geometry's size in world space 3D. classic, grounded, real-world energy 🌍
  • SCREEN_SPACE — use the SoComplexity::value in calculations based on the geometry's size when projected onto the rendering area. this is often a good way to make sure that objects are rendered with as low complexity as possible while still retaining their appearance for the user. like, smart lazy. iconic 👑
  • BOUNDING_BOX — render further geometry in the scene graph as bounding boxes only, for super fast rendering. zoom zoom 💀

💅 Constructor & Destructor Documentation 💅

  • SoComplexity::SoComplexity(void) — constructor. it's giving new beginning 🌸
  • SoComplexity::~SoComplexity() [protected], [virtual] — destructor. it's giving closure 💜

🌈 Member Function Documentation 🌈

  • SoType SoComplexity::getClassTypeId(void) [static] — this static method returns the SoType object associated with objects of this class. it's the class's little name tag 🏷️
  • SoType SoComplexity::getTypeId(void) const [virtual] — returns the type identification of an object derived from a class inheriting SoBase. this is used for runtime type checking and "downward" casting. Implements SoBase.
  • const SoFieldData ** SoComplexity::getFieldDataPtr(void) [static], [protected] — this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. returns the SoFieldData class which holds information about fields in this node. ngl this one's for the library's eyes only 👀
  • const SoFieldData * SoComplexity::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 SoFieldContainer.
  • void SoComplexity::doAction(SoAction * action) [virtual] — this function performs the typical operation of a node for any action. the all-rounder fr fr. Reimplemented from SoNode.
  • void SoComplexity::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. Reimplemented from SoNode.
  • void SoComplexity::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 calculate their bounding box also override this method to change the relevant state variables. Reimplemented from SoNode. 📦
  • void SoComplexity::GLRender(SoGLRenderAction * action) [virtual] — action method for the SoGLRenderAction. this is called during rendering traversals. nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method. Reimplemented from SoNode. throwing primitives at OpenGL is such a mood 🔥
  • void SoComplexity::pick(SoPickAction * action) [virtual] — action method for SoPickAction. does common processing for SoPickAction action instances. Reimplemented from SoNode.
  • void SoComplexity::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 calculate their primitive count also override this method to change the relevant state variables. Reimplemented from SoNode.

⭐ Member Data Documentation ⭐

  • SoSFEnum SoComplexity::type — set rendering type. default value is SoComplexity::OBJECT_SPACE.
  • SoSFFloat SoComplexity::value — complexity value, valid settings range from 0.0 (worst appearance, best performance) to 1.0 (optimal appearance, lowest rendering speed). default value for the field is 0.5.
note that without any SoComplexity nodes in the scene graph, geometry will render as if there was a SoComplexity node present with SoComplexity::value set to 1.0. so the default default is ✨max quality✨, iykyk 😭
  • SoSFFloat SoComplexity::textureQuality — sets the quality value for texture mapping. valid range is from 0.0 (texture mapping off, rendering will be much faster for most platforms) to 1.0 (best quality, rendering might be slow).

the same value for this field on different platforms can yield varying results, depending on the quality of the underlying rendering hardware. so like, your mileage may literally vary bestie 🫶

note that this field influences the behavior of the SoTexture2 node, not the shape nodes. there is an important consequence of this that the application programmer need to know about: you need to insert your SoComplexity node(s) before the SoTexture2 node(s) in the scene graph for them to have any influence on the textured shapes. order matters, periodt 💅

🧚 Author 🧚

generated automatically by Doxygen for Coin from the source code. it literally wrote itself, main character energy ✨

and that's the whole page, bestie!! 🎀 this was SoComplexity(3) from Coin, version 4.0.10, dated Thu Jun 25 2026 00:00:00. go forth and complexity-slide responsibly, love u, bye 💖🦋🌸

📦 where this page comes from