SoTextureUnit(3)

📦 version 3.1.3, in fedora 43, fedora 44

SoTextureUnit(3) ✨ — straight out of the Library Functions Manual, and bestie, we are about to get so cozy with texture units 💖

✨ NAME ✨

SoTextureUnit — okay so, the SoTextureUnit class is a node for setting the active texture unit. That's the whole vibe. It's the node that goes "hey, THIS unit is the one we're working with now" and everyone after it just listens. 👑

🎀 SYNOPSIS 🎀

#include <Inventor/nodes/SoTextureUnit.h>

It inherits from SoNode. Family tree matters, we respect lineage here. 🫶

💖 Public Types

  • enum MappingMethod { BUMP_MAPPING, IMAGE_MAPPING } — the two mapping moods this node can be in.

Public Types inherited from SoNode:

  • enum NodeType { ... } — and here's the full roster, every single one, no skips:
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

  • virtual SoType getTypeId (void) const — hands you the type id, as one does.
  • SoTextureUnit (void) — the constructor, your entry point ✨
  • virtual void doAction (SoAction *action) — the general action handler.
  • virtual void callback (SoCallbackAction *action) — does the callback action thing.
  • virtual void GLRender (SoGLRenderAction *action) — the actual render moment. main character energy fr.
  • virtual void pick (SoPickAction *action) — handles picking.

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 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=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) — the class type id, static edition.
  • static void initClass (void) — sets the class up. run it, love it.
  • static uint32_t getMaxTextureUnit (void) — tells you the max texture unit. iconic for knowing your limits tbh.

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

  • SoSFInt32 unit — which texture unit we're repping.
  • SoSFEnum mappingMethod — which mapping method is in play.

💜 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const — hands over the field data.
  • virtual ~SoTextureUnit () — the destructor. protected, so it's a lil exclusive 💅

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) — pointer to the field data pointer. very meta of it.

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 here's the tea 🫖 — the SoTextureUnit class is a node for setting the active texture unit.

The way this works, and it's lowkey elegant: when an SoTextureUnit node gets inserted into the scene graph, everything that comes after it gets pointed at the texture unit you set in the unit field. And when we say everything, we mean all of these texture nodes:

  • SoTexture2
  • SoTextureCoordinate2
  • SoTextureCoordinate3
  • SoTexture2Transform
  • SoTexture3Transform
  • SoTextureCoordinateEnvironment
  • SoTextureCoordinatePlane
  • SoComplexity

So all of those will affect the texture unit that unit is set to. It's giving "line leader sets the vibe and the whole class follows" ✨

Also, if you want an actual usage example for this node, go peek at the SoGuiExample module. Real examples, not vibes only.

FILE FORMAT/DEFAULTS:

TextureUnit {
    unit 0
    mappingMethod IMAGE_MAPPING
}

Since 🌈

Coin 2.2

💖 Member Enumeration Documentation 💖

enum SoTextureUnit::MappingMethod

The Enumerator list, bestie, and there's exactly two:

  • BUMP_MAPPING — Bump mapping is used. bumpy. textured differently. you get it.
  • IMAGE_MAPPING — Normal image mapping is used. the classic, the default, the moment.

🎀 Constructor & Destructor Documentation 🎀

SoTextureUnit::SoTextureUnit (void )

Constructor. ✨ it constructs. that's the job.

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

Destructor. protected and virtual, so it's doing the most in the most understated way 💅

💖 MEMBER FUNCTION DOCUMENTATION 💖

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

okay so bestie, this method right here? it's the type-identification queen. it returns the type identification of an object derived from a class inheriting SoBase. and like, that's what you use for run-time type checking and "downward" casting. iykyk.

usage example, periodt:

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

now for all my application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. lowkey that's just how it is. 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 info on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

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

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

Reimplemented from SoFieldContainer.

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

this function performs the typical operation of a node for any action. slay.

Reimplemented from SoNode.

🎀 void SoTextureUnit::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. no cap.

Reimplemented from SoNode.

🌈 void SoTextureUnit::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. iconic.

Reimplemented from SoNode.

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

action method for SoPickAction. does common processing for SoPickAction action instances. simple as that.

Reimplemented from SoNode.

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

returns the maximum number of texture units for the current GL context. but bestie, listen: do not call this method if you don't have a current active GL context. you should also know that your OpenGL driver supports multi-texturing. like, fr fr, check that first.

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 yeah, that's the tea.

🌸 MEMBER DATA DOCUMENTATION 🌸

💜 SoSFInt32 SoTextureUnit::unit 💜

the texture unit which will be used for texture nodes following this node in the traversal. default value of the field is 0. periodt.

🍓 SoSFEnum SoTextureUnit::mappingMethod 🍓

the mapping method for this unit. default is IMAGE_MAPPING.

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, don't come for me, it's just not there yet.

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page, bestie! this was Coin Version 3.1.3, SoTextureUnit(3). stay iconic, keep slaying those texture units, and remember: no cap, just code. 💖✨🦋

📦 where this page comes from