SoTextureUnit(3)

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

💖 NAME 💖

SoTextureUnit(3) — okay bestie, the SoTextureUnit class is a node for setting the active texture unit. That's the whole point, no cap. 💅

✨ SYNOPSIS ✨

First, you include this header:

#include <Inventor/nodes/SoTextureUnit.h>

It inherits SoNode. Family tree, periodt.

🎀 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,
           COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

🌸 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)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *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 getPrimitiveCount (SoGetPrimitiveCountAction *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

🦋 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 — Returns TRUE if the type of this object is either of the same type or inherited from type.
  • 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • 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)

💜 Static Public Member Functions inherited from SoFieldContainer

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

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

🌸 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

  • SbUniqueId uniqueId

💅 Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

💅 Static Protected Attributes inherited from SoNode

  • static SbUniqueId nextUniqueId = 1
  • static int nextActionMethodIndex = 0

💖 Detailed Description 💖

The SoTextureUnit class is a node for setting the active texture unit. That's the main character energy right there.

When an SoTextureUnit node is inserted into the scene graph, all subsequent texture nodes (SoTexture2, SoTextureCoordinate2, SoTextureCoordinate3, SoTexture2Transform, SoTexture3Transform, SoTextureCoordinateEnvironment, SoTextureCoordinatePlane and SoComplexity) will affect the texture unit set in the unit field. So yeah, it's giving control freak but in a slay way.

See the SoGuiExample module for an usage example for this node.

FILE FORMAT/DEFAULTS:

TextureUnit {
    unit 0
    mappingMethod IMAGE_MAPPING
}

Since:

  • Coin 2.2

✨ Member Enumeration Documentation ✨

enum SoTextureUnit::MappingMethod

Enumerator:

  • BUMP_MAPPING — Bump mapping is used.
  • IMAGE_MAPPING — Normal image mapping is used.

🎀 Constructor & Destructor Documentation 🎀

SoTextureUnit::SoTextureUnit (void )

Constructor. Obviously, bestie.

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

Destructor. Cleanup era.

💖 Member Function Documentation 💖

okay bestie, this is the part where we meet all the lil functions this node has. every single one. no skipping, we're doing the whole roster 💅

SoType SoTextureUnit::getClassTypeId(void) ✨ [static]

SoType SoTextureUnit::getClassTypeId(void)

This static method hands you back the SoType object that's associated with objects of this class. like, the class-wide ID card. static, so you call it on the class itself, no instance needed 🫶

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

SoType SoTextureUnit::getTypeId(void) const

Returns the type identification of an object derived from a class that inherits SoBase. This is the whole runtime type checking thing, and also how you do "downward" casting. iykyk 👑

Implements SoBase.

const SoFieldData ** SoTextureUnit::getFieldDataPtr(void) 🔒 [static], [protected]

const SoFieldData ** SoTextureUnit::getFieldDataPtr(void)

ngl this one is internal to the library — the docs literally say it's "not likely to be of interest to the application programmer." so like… not for you, bestie 🙈 but it's here, so:

Returns the SoFieldData class which holds information about fields in this node.

protected + internal, so don't go poking at this unless you're deep in the library guts 💀

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

const SoFieldData * SoTextureUnit::getFieldData(void) const

Gives you a pointer to the class-wide field data storage object for this instance. and if there are no fields present at all? it returns NULL. that's it, that's the whole vibe.

Reimplemented from SoFieldContainer.

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

void SoTextureUnit::doAction(SoAction * action)

This function performs the typical operation of a node for any action. any action. all the actions. it's giving versatility ✨

Reimplemented from SoNode.

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

void SoTextureUnit::callback(SoCallbackAction * action)

Action method for SoCallbackAction.

It just updates the state according to how the node behaves for the render action — so the application programmer can use SoCallbackAction to extract information about the scene graph. cute, useful, lowkey iconic 💜

Reimplemented from SoNode.

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

void SoTextureUnit::GLRender(SoGLRenderAction * action)

Action method for the SoGLRenderAction.

This one gets called during rendering traversals. Any node that influences the rendering state in any way, or wants to throw geometry primitives at OpenGL, overrides this method. throwing primitives at OpenGL, honestly main character energy 👑

Reimplemented from SoNode.

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

void SoTextureUnit::pick(SoPickAction * action)

Action method for SoPickAction.

Does the common processing for SoPickAction action instances. short and sweet fr fr 💅

Reimplemented from SoNode.

void SoTextureUnit::getBoundingBox(SoGetBoundingBoxAction * action) 🧚 [virtual]

void SoTextureUnit::getBoundingBox(SoGetBoundingBoxAction * action)

Action method for the SoGetBoundingBoxAction.

It calculates the bounding box and center coordinates for the node, and then modifies the values of the action so it encompasses the bounding box for this node, and shifts the center point for the scene more towards the one for this node. math but make it ✨geometry✨

Nodes that influence how geometry nodes calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoNode.

void SoTextureUnit::getMatrix(SoGetMatrixAction * action) 💫 [virtual]

void SoTextureUnit::getMatrix(SoGetMatrixAction * action)

Action method for SoGetMatrixAction.

Updates the action by accumulating with the transformation matrix of this node (if any). key words: if any 🫶

Reimplemented from SoNode.

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

uint32_t SoTextureUnit::getMaxTextureUnit(void)

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

okay IMPORTANT bestie, read this twice: Do not call this method if you don't have a current active GL context. also you should know that your OpenGL driver supports multi-texturing. don't skip the prerequisites, that's how you get chaos 😭

This function is provided only to be compatible with TGS Inventor. It's better to use cc_glglue_max_texture_units() if you're using Coin (declared in Inventor/C/glue/gl.h). so like, it works, but it's the legacy option, we're being honest here 💀

🌟 Member Data Documentation 🌟

the actual data, the fields, the substance 💖

  • SoSFInt32 SoTextureUnit::unit — the texture unit that'll be used for texture nodes following this node in the traversal. Default value of the field is 0. zero, the classic, the default default ✨
  • SoSFEnum SoTextureUnit::mappingMethod — the mapping method for this unit. Default is IMAGE_MAPPING.
heads up: this field is not currently supported in Coin. It's included to support TGS' API. We might support the field in the future. so like… it exists, it's there, it's just vibing and not doing anything yet 🙈

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. so technically the author is a robot and the source code, but we love them for it 🫶

and that's the whole page, bestie, you made it to the end 💅✨ this was Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it lives in section SoTextureUnit(3) of the manual. go forth and texture-unit responsibly 🌸🦋💖

📦 where this page comes from