SoTexture3(3)

💖 NAME 💖

okay so bestie, you've stumbled onto SoTexture3(3) from the Library Functions Manual, and honestly? she's a whole mood. ✨

SoTexture3 is literally the class that maps a 3D texture onto geometry. that's the whole job. no cap. 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoTexture3.h>

she inherits from SoNode, periodt. 🫶

🎀 Public Types

enum Model { MODULATE = SoTextureImageElement::MODULATE, DECAL = SoTextureImageElement::DECAL, BLEND = SoTextureImageElement::BLEND }
enum Wrap { REPEAT = SoTextureImageElement::REPEAT, CLAMP = SoTextureImageElement::CLAMP }

🦋 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 — hands you her SoType, iykyk.
• SoTexture3 (void) — the constructor, she's born ✨.
• virtual void doAction (SoAction *action) — does the action thing.
• virtual void GLRender (SoGLRenderAction *action) — GL render moment.
• virtual void callback (SoCallbackAction *action) — callback behavior.

🌈 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 pick (SoPickAction *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)
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 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

SoMFString filenames
SoSFImage3 images
SoSFEnum wrapR
SoSFEnum wrapS
SoSFEnum wrapT
SoSFEnum model
SoSFColor blendColor

🔒 Protected Member Functions

virtual const SoFieldData * getFieldData (void) const
virtual ~SoTexture3 ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual void notify (SoNotList *list)
int getReadStatus (void)
void setReadStatus (int s)

🌈 Protected Member Functions inherited from SoNode

SoNode (void)
virtual ~SoNode ()

💖 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 here's the tea, bestie: the SoTexture3 class is used to map a 3D texture onto geometry. 💅

Shape nodes chillin' within the scope of SoTexture3 nodes in the scenegraph (meaning below the same SoSeparator and to the righthand side of the SoTexture3) will have the texture applied according to each shape type's individual characteristics. go read the docs for the various shape types (SoFaceSet, SoCube, SoSphere, etc etc) if you want the specifics on how textures get applied. also, an SoTexture3 node will override any previously encountered SoTexture2 nodes, and vice versa. mixing SoTexture3 and SoTextureCoordinate2 (or the other way around) is legal, but the third texture coordinate component will be ignored (set to 0.0). 🫶

heads up bestie: be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. 💀

FILE FORMAT/DEFAULTS:

Texture3 {
    filenames ""
    images 0 0 0 0
    wrapR REPEAT
    wrapS REPEAT
    wrapT REPEAT
    model MODULATE
    blendColor 0 0 0
    enableCompressedTexture FALSE
}

Since:

• Coin 2.0
• TGS Inventor 2.6

---

🎀 Member Enumeration Documentation 🎀

enum SoTexture3::Model

Texture mapping model. slay.

Enumerator:

• MODULATE — Texture image is modulated with polygon.
• DECAL — Texture image overwrites polygon color.
• BLEND — Blend image using blendColor.

enum SoTexture3::Wrap

Enum used to specify wrapping strategy. the vibe check for coordinates.

Enumerator:

• REPEAT — Repeat texture when coordinate is not between 0 and 1.
• CLAMP — Clamp coordinate between 0 and 1.

---

💖 Constructor & Destructor Documentation 💖

SoTexture3::SoTexture3 (void )

Constructor. she's here, she's ready. ✨

References BLEND, blendColor, CLAMP, DECAL, filenames, images, model, MODULATE, REPEAT, SoTexture3(), wrapR, wrapS, and wrapT.

Referenced by getFieldData(), and SoTexture3().

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

Destructor. she's logging off. 😭

---

part 1 of 2, bestie — more coming, don't go anywhere 💅

✨ MEMBER FUNCTION DOCUMENTATION ✨

SoType SoTexture3::getTypeId (void ) const [virtual]

Okay so bestie, this one returns the type identification of an object derived from a class inheriting SoBase. It's giving run-time type checking and "downward" casting energy. 💅

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

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. 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 information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

---

const SoFieldData * SoTexture3::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.

References SoTexture3().

---

void SoTexture3::doAction (SoAction * action) [virtual]

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

Reimplemented from SoNode.

References SoAction::getState(), images, SoNode::isOverride(), model, and wrapT.

Referenced by callback().

---

void SoTexture3::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.

Reimplemented from SoNode.

References SoAction::getState(), images, SoNode::isOverride(), model, SoDebugError::postWarning(), wrapR, wrapS, and wrapT.

---

void SoTexture3::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.

References doAction().

---

SbBool SoTexture3::readInstance (SoInput * in, unsigned short flags) [protected], [virtual]

This method is mainly intended for internal use during file import operations.

It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. The import process should be robust and handle corrupted input streams by returning FALSE.

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

Reimplemented from SoNode.

References filenames, SoNode::readInstance(), and setReadStatus().

---

void SoTexture3::notify (SoNotList * l) [protected], [virtual]

Notifies all auditors for this instance when changes are made.

Reimplemented from SoNode.

References filenames, SoNotList::getLastField(), images, SoNode::notify(), wrapR, wrapS, and wrapT.

---

int SoTexture3::getReadStatus (void ) [protected]

Returns read status. 1 for success, 0 for failure.

---

void SoTexture3::setReadStatus (int s) [protected]

Sets read status.

See also getReadStatus()

Referenced by readInstance().

---

💖 MEMBER DATA DOCUMENTATION 💖

SoMFString SoTexture3::filenames

Texture filename(s). Specify either this or use SoTexture3::images, not both. The depth of the volume is specifies by the number of filenames specified. All images must have the same dimensions and number of components.

NB! A field sensor is attached to this field internally and reloads all images when this field changes. You must therefore be careful when setting this field and either use startEditing()/finishEditing() or set all values with one function call; setValues().

Referenced by notify(), readInstance(), and SoTexture3().

---

SoSFImage3 SoTexture3::images

Inline image data.

Referenced by doAction(), GLRender(), notify(), and SoTexture3().

---

SoSFEnum SoTexture3::wrapR

Wrapping strategy for the R coordinate (depth).

Referenced by GLRender(), notify(), and SoTexture3().

---

SoSFEnum SoTexture3::wrapS

Wrapping strategy for the S coordinate.

Referenced by GLRender(), notify(), and SoTexture3().

---

SoSFEnum SoTexture3::wrapT

Wrapping strategy for the T coordinate.

Referenced by doAction(), GLRender(), notify(), and SoTexture3().

---

SoSFEnum SoTexture3::model

Texture model.

Referenced by doAction(), GLRender(), and SoTexture3().

---

SoSFColor SoTexture3::blendColor

Blend color. Used when SoTexture3::model is SoTexture3::BLEND.

Referenced by SoTexture3().

---

🦋 AUTHOR 🦋

Generated automatically by Doxygen for Coin from the source code.

---

That's a wrap, bestie! This iconic manual page came from Coin, Version 2.5.0, and it's the SoTexture3(3) page. Slay! 💅✨