SoTexture2(3)

📦

version 4.0.10 · 4 versions

4.0.10 · fedora 43, fedora 44 (latest)
4.0.10 · epel 9
4.0.3 · fedora 43
4.0.7 · fedora 44

💖 SoTexture2 💖

Coin · the SoTexture2(3) manual page, part 1 of 3 ✨

🌸 NAME 🌸

SoTexture2 — bestie, this is the class that maps a 2D texture onto every single piece of geometry that comes after it in the scene graph. No cap. 💅

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoTexture2.h>

Inherits SoTexture.

🎀 Public Types 🎀

enum Model — the vibe of how your texture mixes with whatever's underneath it:

enum Model { MODULATE = SoMultiTextureImageElement::MODULATE, DECAL =
    SoMultiTextureImageElement::DECAL, BLEND =
    SoMultiTextureImageElement::BLEND, REPLACE =
    SoMultiTextureImageElement::REPLACE }

enum Wrap — what happens when your texture coordinates run off the edge, iykyk:

enum Wrap { REPEAT = SoMultiTextureImageElement::REPEAT, CLAMP =
    SoMultiTextureImageElement::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,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

👑 Public Member Functions 👑

virtual SoType getTypeId (void) const
SoTexture2 (void)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void rayPick (SoRayPickAction *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 getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *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)
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 — hands you back TRUE if this object's type is either exactly 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 all the initialization for the data that every instance of this class shares, like handing over everything the Coin type system needs. Slay. ✨
static SbBool readImage (const SbString &fname, int &w, int &h, int &nc, unsigned char *&bytes)

🧚 Static Public Member Functions inherited from `SoTexture`

static SoType getClassTypeId (void)
static void initClass (void) — sets up all the initialization for the data that every instance of this class shares, like handing over everything the Coin type system needs. ✨
static void cleanupClass (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 all the initialization for the data that every instance of this class shares, like handing over everything the Coin type system needs. ✨
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 all the initialization for the data that every instance of this class shares, like handing over everything the Coin type system needs. ✨
static SoType getClassTypeId (void) — this static method gives you back the SoType object that's 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 all the initialization for the data that every instance of this class shares, like handing over everything the Coin type system needs. ✨
static SoType getClassTypeId (void) — this static method gives you back the SoType object that's 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 💅

SoSFString filename
SoSFImage image
SoSFEnum wrapS
SoSFEnum wrapT
SoSFEnum model
SoSFColor blendColor
SoSFBool enableCompressedTexture

🦋 Protected Member Functions 🦋

virtual const SoFieldData * getFieldData (void) const
virtual ~SoTexture2 ()
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)
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 `SoTexture`

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

okay that's the whole synopsis situation, bestie — literally every type, function, attribute and inherited glow-up, all accounted for. 💯

…and this was only part 1 of 3. don't go anywhere. 💅

✨ Detailed Description ✨

okay so bestie, here's the whole vibe of SoTexture2 💖 — this class is literally the way you slap a 2D texture onto geometry that comes after it in the scene graph. main character energy fr.

Shape nodes within the scope of SoTexture2 nodes in the scene graph — and by that I mean below the same SoSeparator and to the right hand side of the SoTexture2 — will get the texture applied according to each shape type's individual characteristics. 💅 Every shape does its own little thing. So go peek at the docs for the various shape types (SoFaceSet, SoCube, SoSphere, etc.) for the specifics of how textures actually get applied. No cap.

For a simple usage example, check the class documentation for SoSFImage. 🎀

😭 the classic texture-duplication L

One common flaw with so many programs that support exporting VRML or Inventor files is that the same texture file gets exported several times, but as different nodes. And bestie, that is not the vibe — it causes excessive texture memory usage and slow rendering. 💀

Below is an example program that fixes this by replacing all instances of the same texture with a pointer to the first node:

#include <Inventor/actions/SoSearchAction.h>
#include <Inventor/actions/SoWriteAction.h>
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/nodes/SoTexture2.h>
#include <Inventor/SoDB.h>
#include <Inventor/SoInput.h>
#include <Inventor/SoOutput.h>

int main(int argc, char ** argv)
{
  if (argc < 2) return -1;
  SoDB::init();

  SoInput in;
  if (!in.openFile(argv[1])) return -1;

  SoSeparator * root = SoDB::readAll(&in);
  if (!root) return -1;
  root->ref();

  SoSearchAction sa;
  sa.setType(SoTexture2::getClassTypeId());
  sa.setInterest(SoSearchAction::ALL);
  sa.setSearchingAll(TRUE);
  sa.apply(root);
  SoPathList & pl = sa.getPaths();
  SbDict namedict;

  for (int i = 0; i < pl.getLength(); i++) {
    SoFullPath * p = (SoFullPath*) pl[i];
    if (p->getTail()->isOfType(SoTexture2::getClassTypeId())) {
      SoTexture2 * tex = (SoTexture2*) p->getTail();
      if (tex->filename.getValue().getLength()) {
        SbName name = tex->filename.getValue().getString();
        unsigned long key = (unsigned long) ((void*) name.getString());
        void * tmp;
        if (!namedict.find(key, tmp)) {
          // new texture. just insert into list
          (void) namedict.enter(key, tex);
        }
        else if (tmp != (void*) tex) { // replace with node found in dict
          SoGroup * parent = (SoGroup*) p->getNodeFromTail(1);
          int idx = p->getIndexFromTail(0);
          parent->replaceChild(idx, (SoNode*) tmp);
        }
      }
    }
  }
  sa.reset();

  // output fixed scene to stdout
  SoOutput out;
  SoWriteAction wa(&out);
  wa.apply(root);
  root->unref();
}

🫶 embedding textures INTO the file (iykyk)

When you're working with Inventor files, you often wanna embed external texture image files into the Inventor files themselves. Here's a minimal, standalone example showing how you pull that off — by calling SoField::touch() on the SoTexture2::image fields before scene graph export:

#include <Inventor/SoDB.h>
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/nodes/SoTexture2.h>
#include <Inventor/actions/SoSearchAction.h>
#include <Inventor/actions/SoWriteAction.h>

int
main(void)
{
  if (argc == 1) {
    fprintf(stderr,"Usage: %s <infile> > outfile.iv\n", argv[0]);
    return -1;
  }
  SoDB::init();

  // open the file (don't use stdin) to enable Coin to search for textures
  // relative to the input file.
  SoInput in;
  if (!in.openFile(argv[1])) {
    return -1;
  }
  SoSeparator * root = SoDB::readAll(&in);
  if (!root) { exit(1); }

  root->ref();

  SoSearchAction searchaction;
  searchaction.setType(SoTexture2::getClassTypeId());
  searchaction.setSearchingAll(TRUE);
  searchaction.setInterest(SoSearchAction::ALL);

  searchaction.apply(root);

  const SoPathList & pl = searchaction.getPaths();
  for (int i=0; i < pl.getLength(); i++) {
    SoFullPath * fp = (SoFullPath *)pl[i];
    SoTexture2 * tex = (SoTexture2 *)fp->getTail();
    assert(tex->getTypeId() == SoTexture2::getClassTypeId());
    tex->image.touch();
  }

  SoWriteAction wa;
  wa.apply(root);

  root->unref();

  return 0;
}

Run the example by piping the iv-file you want to do texture embedding on from stdin, like this bestie:

$ ./test < input.iv

🌸 FILE FORMAT/DEFAULTS 🌸

Texture2 {
    filename ""
    image 0 0 0
    wrapS REPEAT
    wrapT REPEAT
    model MODULATE
    blendColor 0 0 0
    enableCompressedTexture FALSE
}

🧚 Member Enumeration Documentation 🧚

`enum SoTexture2::Model`

Texture mapping model — this is what decides how we "merge" the texture map with the object it's mapped onto. 💫

Enumerator

MODULATE — Texture color is multiplied by the polygon color. The result will be Phong shaded (if light model is PHONG). slay.
DECAL — Texture image overwrites polygon shading. Textured pixels will not be Phong shaded. Heads up though: has undefined behaviour for grayscale and grayscale-alpha textures. ⚠️
BLEND — This model is normally used with monochrome textures (i.e. textures with one or two components). The first component, the intensity, is then used to blend between the shaded color of the polygon and the SoTexture2::blendColor.
REPLACE — Texture image overwrites polygon shading. Textured pixels will not be Phong shaded. Supports grayscale and grayscale alpha textures. This feature requires OpenGL 1.1. MODULATE will be used if OpenGL version < 1.1 is detected.

okay so important lore: using this texture model will make your Inventor files incompatible with older versions of Coin and Inventor. You need Coin >= 2.2 or TGS Inventor 4.0 to load Inventor files that use the REPLACE texture model. 😭

Since

Coin 2.2
TGS Inventor 4.0

`enum SoTexture2::Wrap`

Enumeration of wrapping strategies which can be used when the texture map doesn't cover the full extent of the geometry. 🎀

Enumerator

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

💜 Constructor & Destructor Documentation 💜

`SoTexture2::SoTexture2 (void )`

Constructor. 🎀

`SoTexture2::~SoTexture2 ()` — [protected], [virtual]

Destructor. Frees up internal resources used to store texture image data. 🧹✨

👑 Member Function Documentation 👑

`SoType SoTexture2::getClassTypeId (void )` — [static]

This static method returns the SoType object associated with objects of this class.

`SoType SoTexture2::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. 💅