SoTextureUnit(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoTextureUnit(3) — Library Functions Manual 💖

okay bestie, gather round, because this is the SoTextureUnit(3) page from the Library Functions Manual and it is lowkey iconic. it's a Coin 3D thing, it's giving scene-graph royalty, and you're gonna understand every single bit of it. no cap. ✨

🎀 NAME 🎀

SoTextureUnit — the SoTextureUnit class is a node for setting the active texture unit. that's the whole job, and it does it gorgeously. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoTextureUnit.h>

it inherits from SoNode, so it's part of the whole node family tree. 🦋

🫶 Public Types

enum MappingMethod { BUMP_MAPPING, IMAGE_MAPPING }

🫶 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
    }

💜 Public Member Functions

  • virtual SoType getTypeId (void) const
  • SoTextureUnit (void)
  • virtual void doAction (SoAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void pick (SoPickAction *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=0) const
  • virtual SbBool affectsState (void) const
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *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 getPrimitiveCount (SoGetPrimitiveCountAction *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=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 uint32_t getMaxTextureUnit (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

  • SoSFInt32 unit
  • SoSFEnum mappingMethod

🌈 Protected Member Functions

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

🌈 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 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 = 0
    • static int nextActionMethodIndex = 0

✨ Detailed Description ✨

okay so, the SoTextureUnit class is a node for setting the active texture unit. that's literally its whole personality and it's serving. 💅

here's the tea: when an SoTextureUnit node is inserted into the scene graph, all subsequent texture nodes (SoTexture2, SoTextureCoordinate2, SoTextureCoordinate3, SoTexture2Transform, SoTexture3Transform, SoTextureCoordinateEnvironment, and SoTextureCoordinatePlane) will affect the texture unit set in the unit field. so it's like a little vibe-setter — everything downstream of it answers to it. main character energy, fr fr. 👑

also, peep the SoGuiExample CVS module for a usage example for this node. go look, bestie. 🔍

FILE FORMAT/DEFAULTS:

TextureUnit {
    unit 0
    mappingMethod IMAGE_MAPPING
}

Since

Coin 2.2

🔥 Member Enumeration Documentation 🔥

enum SoTextureUnit::MappingMethod

the enumerators, let's go:

  • BUMP_MAPPING — bump mapping is used. 🫧
  • IMAGE_MAPPING — normal image mapping is used. 🖼️

💀 Constructor & Destructor Documentation 💀

SoTextureUnit::SoTextureUnit (void )

constructor. ✨

References BUMP_MAPPING, IMAGE_MAPPING, mappingMethod, SoTextureUnit(), and unit. Referenced by getFieldData(), and SoTextureUnit().

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

destructor. 😭 it's protected, so don't come for it unless you're family.

💖 Member Function Documentation 💖

Ok bestie, this is the part where we meet the actual functions. Grab a snack. 🍓

SoType SoTextureUnit::getTypeId (void ) const [virtual] 🌈

Returns the type identification of an object derived from a class inheriting SoBase. This is what does the run-time type checking and the "downward" casting — iykyk.

Usage example:

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
  }
}

So if you're an application programmer and you wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. No skipping it, bestie. 🫶 Usually you do that as part of setting up the whole type system for your extension classes, and the way you typically pull that off is with the pre-defined macros you get from, 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 down the line. ✨

Want more on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. That's where the lore lives. 📚

Implements SoBase.

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

Hands you back a pointer to the class-wide field data storage object for this instance. And if there are literally no fields present? It returns NULL. That's it, that's the whole vibe. 💅

Reimplemented from SoFieldContainer.

References SoTextureUnit().

void SoTextureUnit::doAction (SoAction * action) [virtual] 🦋

This one performs the typical operation of a node for any action. Just the standard behaviour, doing its thing. ⭐

Reimplemented from SoNode.

References SoAction::getState().

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

void SoTextureUnit::callback (SoCallbackAction * action) [virtual] 🌸

Action method for SoCallbackAction.

It simply updates the state according to how the node behaves for the render action — that way the application programmer can use SoCallbackAction to extract information about the scene graph. Sneaky but legit. 🙈

Reimplemented from SoNode.

References doAction().

void SoTextureUnit::GLRender (SoGLRenderAction * action) [virtual] 🔥

Action method for the SoGLRenderAction.

This one gets called during rendering traversals. So like — any node that influences the rendering state in any way whatsoever, or that wants to throw geometry primitives at OpenGL, overrides this method. That's the assignment, bestie. 👑

Reimplemented from SoNode.

References doAction(), SoAction::getState(), SoDebugError::postWarning(), and unit.

void SoTextureUnit::pick (SoPickAction * action) [virtual] 💜

Action method for SoPickAction.

Does the common processing for SoPickAction action instances. Nothing dramatic, just doing its little job. 🎀

Reimplemented from SoNode.

References doAction().

uint32_t SoTextureUnit::getMaxTextureUnit (void ) [static] 🌈

Returns the maximum number of texture units for the current GL context. 🫶

⚠️ Do not call this method if you don't have a current active GL context. And you should also already know that your OpenGL driver supports multi-texturing before you go poking at this. Not a vibe check you wanna fail, fr fr. 💀

This function exists only to be compatible with TGS Inventor. If you're using Coin, it's better to use cc_glglue_max_texture_units() instead (it's declared in Inventor/C/glue/gl.h). Consider that the upgrade. ✨

🌟 Member Data Documentation 🌟

SoSFInt32 SoTextureUnit::unit 👑

The texture unit which will be used for texture nodes following this node in the traversal. The default value of the field is 0. Main character behaviour, honestly. 💅

Referenced by GLRender(), and SoTextureUnit().

SoSFEnum SoTextureUnit::mappingMethod 🦋

The mapping method for this unit. Default is IMAGE_MAPPING.

🚨 Heads up bestie: this field is not currently supported in Coin. It's included to support TGS' API. They might support the field in the future. That's the whole tea. ☕

Referenced by SoTextureUnit().

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. Not me, not you — the robots did it. 🤖✨

And that's a wrap on SoTextureUnit(3), bestie! This was pulled straight from Coin, Version 2.5.0, with whatever date Doxygen stamped on it in the footer. Go forth and multi-texture responsibly. 🎀💖✨🫶

📦 where this page comes from