SoTextureCubeMap(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

💖 SoTextureCubeMap — the Coin manual, but make it make sense 💖

hiii bestie, welcome to SoTextureCubeMap(3), aka the Coin page for the node that slaps a whole cube map onto whatever shapes come after it. yes, all six faces, yes it's iconic. grab a snack, this one's a two-parter 🍓✨

🌸 NAME 🌸

SoTextureCubeMap — the SoTextureCubeMap class maps a cube map onto all the shape nodes that come after it in the scene. like, every face gets a face. periodt.

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoTextureCubeMap.h>

it inherits from SoTexture, so it's already got the whole texture-girl family tree going on 🫶

🎀 Public Types 🎀

enum Model { MODULATE = SoMultiTextureImageElement::MODULATE, DECAL = SoMultiTextureImageElement::DECAL, BLEND = SoMultiTextureImageElement::BLEND, REPLACE = SoMultiTextureImageElement::REPLACE } — the blend-mode menu, lowkey the main character of how your texture mixes with the shape's colour.
enum Wrap { REPEAT = SoMultiTextureImageElement::REPEAT, CLAMP = SoMultiTextureImageElement::CLAMP } — what happens when your texture coords run off the edge. tile it (REPEAT) or stretch the edge forever (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 }

a whole museum of node-flavour bit flags, inherited from the parent class. not us inventing them, they came with the family 💅

🔥 Public Member Functions 🔥

virtual SoType getTypeId (void) const — the "who am I" call that hands back this object's type.
SoTextureCubeMap (void) — the constructor, aka the birth of your cube-map node.
virtual void doAction (SoAction *action) — routes an action to the right place.
virtual void GLRender (SoGLRenderAction *action) — the actual render moment, it's giving main character energy.
virtual void callback (SoCallbackAction *action) — the callback-action handler.
virtual void rayPick (SoRayPickAction *action) — ray-picking handler, so your cursor can vibe with it.

💜 Public Member Functions inherited from `SoNode` 💜

void setOverride (const SbBool state) — flip override mode on/off.
SbBool isOverride (void) const — are we in override mode or not.
void setNodeType (const NodeType type) — set the node type.
NodeType getNodeType (void) const — read the node type back.
virtual SoNode * copy (SbBool copyconnections=FALSE) const — clone the node, with an option to drag the connections along.
virtual SbBool affectsState (void) const — does this node touch the traversal state.
virtual void GLRenderBelowPath (SoGLRenderAction *action) — render pass for below-path.
virtual void GLRenderInPath (SoGLRenderAction *action) — render pass for in-path.
virtual void GLRenderOffPath (SoGLRenderAction *action) — render pass for off-path.
virtual void getBoundingBox (SoGetBoundingBoxAction *action) — bounding-box handler.
virtual void getMatrix (SoGetMatrixAction *action) — matrix handler.
virtual void handleEvent (SoHandleEventAction *action) — event handler.
virtual void pick (SoPickAction *action) — pick handler.
virtual void search (SoSearchAction *action) — search handler.
virtual void write (SoWriteAction *action) — write handler.
virtual void audioRender (SoAudioRenderAction *action) — audio render handler.
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — primitive-count handler.
virtual void grabEventsSetup (void) — set up event grabbing.
virtual void grabEventsCleanup (void) — tear down event grabbing.
virtual void startNotify (void) — kick off notification.
SbUniqueId getNodeId (void) const — grab the node's unique id.
virtual SoChildList * getChildren (void) const — get the child list.
virtual void writeInstance (SoOutput *out) — write this instance out.
virtual SoNode * addToCopyDict (void) const — add this node to the copy dictionary.
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — copy the field contents over.
virtual SoFieldContainer * copyThroughConnection (void) const — copy through a connection.

💜 Public Member Functions inherited from `SoFieldContainer` 💜

void setToDefaults (void) — reset every field back to defaults.
SbBool hasDefaultValues (void) const — are all the fields still default.
SbBool fieldsAreEqual (const SoFieldContainer *container) const — do our fields match another container's.
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — copy field values from another container.
SbBool set (const char *const fielddata) — set fields from a string.
void get (SbString &fielddata) — read fields out into a string.
virtual int getFields (SoFieldList &l) const — grab the fields into a list.
virtual int getAllFields (SoFieldList &l) const — grab literally all the fields into a list.
virtual SoField * getField (const SbName &name) const — find a field by name.
virtual SoField * getEventIn (const SbName &name) const — find an event-in by name.
virtual SoField * getEventOut (const SbName &name) const — find an event-out by name.
SbBool getFieldName (const SoField *const field, SbName &name) const — reverse-lookup a field's name.
SbBool enableNotify (const SbBool flag) — toggle notifications.
SbBool isNotifyEnabled (void) const — is notification on.
SbBool set (const char *fielddata, SoInput *input) — set fields from string data with an input context.
void get (SbString &fielddata, SoOutput *out) — read fields out with an output context.
virtual SbBool validateNewFieldValue (SoField *field, void *newval) — sanity-check a new value for a field.
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — register a write reference.
SbBool getIsBuiltIn (void) const — is this thing built in.
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — report how much memory the fields are eating, managed vs unmanaged.
void setUserData (void *userdata) const — stash your own user data pointer.
void * getUserData (void) const — get your user data pointer back out.

💜 Public Member Functions inherited from `SoBase` 💜

void ref (void) const — bump the reference count.
void unref (void) const — drop the reference count.
void unrefNoDelete (void) const — drop the count but don't delete.
int32_t getRefCount (void) const — how many refs are we holding.
void touch (void) — touch it, tell everyone it changed.
SbBool isOfType (SoType type) const — hands back TRUE if this object's type is either the same as type or inherits from it. bestie it's the "are you one of us" check 🫶
virtual SbName getName (void) const — get the name.
virtual void setName (const SbName &newname) — set the name.
void addAuditor (void *const auditor, const SoNotRec::Type type) — add an auditor of a given type.
void removeAuditor (void *const auditor, const SoNotRec::Type type) — remove an auditor of a given type.
const SoAuditorList & getAuditors (void) const — get the whole auditor list.
SbBool shouldWrite (void) — should this be written out.
void assertAlive (void) const — assert that this object is still alive.

⭐ Static Public Member Functions ⭐

static SoType getClassTypeId (void) — the class-level type id, static girlies only.
static void initClass (void) — sets up the initialization for data that every instance of this class shares, like handing the Coin type system all the info it needs. do this once, thank me later 💅
static SbBool readImage (const SbString &fname, int &w, int &h, int &nc, unsigned char *&bytes) — read an image in from fname and fill in width, height, number of channels and the raw bytes.

⭐ Static Public Member Functions inherited from `SoTexture` ⭐

static SoType getClassTypeId (void) — same idea, class type id.
static void initClass (void) — sets up the initialization for data that every instance of this class shares, like handing the Coin type system all the info it needs.
static void cleanupClass (void) — the tidy-up counterpart to initClass.

⭐ Static Public Member Functions inherited from `SoNode` ⭐

static uint32_t getCompatibilityTypes (const SoType &nodetype) — the compatibility bitmask for a given node type.
static SoType getClassTypeId (void) — class type id again.
static SoNode * getByName (const SbName &name) — look a node up by name.
static int getByName (const SbName &name, SoNodeList &l) — look nodes up by name into a list.
static void initClass (void) — sets up the initialization for data that every instance of this class shares, like handing the Coin type system all the info it needs.
static void initClasses (void) — plural version, initializes the classes.
static SbUniqueId getNextNodeId (void) — hand out the next unique node id.
static int getActionMethodIndex (const SoType type) — the action method index for a type.
static void getBoundingBoxS (SoAction *action, SoNode *node) — static bounding-box trampoline.
static void GLRenderS (SoAction *action, SoNode *node) — static GL render trampoline.
static void callbackS (SoAction *action, SoNode *node) — static callback trampoline.
static void getMatrixS (SoAction *action, SoNode *node) — static matrix trampoline.
static void handleEventS (SoAction *action, SoNode *node) — static event trampoline.
static void pickS (SoAction *action, SoNode *node) — static pick trampoline.
static void rayPickS (SoAction *action, SoNode *node) — static ray-pick trampoline.
static void searchS (SoAction *action, SoNode *node) — static search trampoline.
static void writeS (SoAction *action, SoNode *node) — static write trampoline.
static void audioRenderS (SoAction *action, SoNode *node) — static audio render trampoline.
static void getPrimitiveCountS (SoAction *action, SoNode *node) — static primitive-count trampoline.

⭐ Static Public Member Functions inherited from `SoFieldContainer` ⭐

static void initClass (void) — sets up the initialization for data that every instance of this class shares, like handing the Coin type system all the info it needs.
static SoType getClassTypeId (void) — this static method hands you back the SoType object that's associated with objects of this class.
static void cleanupClass (void) — tidy up time.
static void initCopyDict (void) — set up the copy dictionary.
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — register an original → copy pair.
static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — check the copy dictionary for an original.
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — find the copy, with a connections flag.
static void copyDone (void) — we're done copying, wrap it up.

⭐ Static Public Member Functions inherited from `SoBase` ⭐

static void initClass (void) — sets up the initialization for data that every instance of this class shares, like handing the Coin type system all the info it needs.
static SoType getClassTypeId (void) — this static method hands you back the SoType object that's associated with objects of this class.
static void addName (SoBase *const base, const char *const name) — attach a name to a base.
static void removeName (SoBase *const base, const char *const name) — take a name off a base.
static void incrementCurrentWriteCounter (void) — bump the write counter.
static void decrementCurrentWriteCounter (void) — drop the write counter.
static SoBase * getNamedBase (const SbName &name, SoType type) — grab a named base of a type.
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — grab named bases into a list.
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — read a base in.
static void setInstancePrefix (const SbString &c) — set the instance prefix string.
static void setTraceRefs (SbBool trace) — turn ref tracing on/off.
static SbBool getTraceRefs (void) — is ref tracing on.
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wire up a route between two fields.
static SbBool readRoute (SoInput *input) — read a route in.

👑 Public Attributes 👑

SoMFString filenames — the multi-string list of filenames for the cube map.
SoSFImage imagePosX — the image for the positive X face.
SoSFImage imageNegX — the image for the negative X face.
SoSFImage imagePosY — the image for the positive Y face.
SoSFImage imageNegY — the image for the negative Y face.
SoSFImage imagePosZ — the image for the positive Z face.
SoSFImage imageNegZ — the image for the negative Z face.
SoSFEnum wrapS — the wrap mode along S.
SoSFEnum wrapT — the wrap mode along T.
SoSFEnum model — the blend model.
SoSFColor blendColor — the colour used for blending.

six whole image fields for six whole faces, plus wrap, model and blend colour. it's giving full-coverage ✨

🌈 Protected Member Functions 🌈

virtual const SoFieldData * getFieldData (void) const — grab this class's field data.
virtual ~SoTextureCubeMap () — the destructor.
virtual SbBool readInstance (SoInput *in, unsigned short flags) — read an instance in from input.
virtual void notify (SoNotList *list) — the notification handler.
int getReadStatus (void) — read the read-status.
void setReadStatus (int s) — set the read-status.

🌈 Protected Member Functions inherited from `SoNode` 🌈

SoNode (void) — node constructor.
virtual ~SoNode () — node destructor.

🌈 Protected Member Functions inherited from `SoFieldContainer` 🌈

SoFieldContainer (void) — field container constructor.
virtual ~SoFieldContainer () — field container destructor.

🌈 Protected Member Functions inherited from `SoBase` 🌈

SoBase (void) — base constructor.
virtual ~SoBase () — base destructor.
virtual void destroy (void) — the destroy routine.
SbBool hasMultipleWriteRefs (void) const — does it have multiple write refs.
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — write out a header.
void writeFooter (SoOutput *out) const — write out a footer.
virtual const char * getFileFormatName (void) const — the file format name.
virtual SoNotRec createNotRec (void) — create a notification record.

🦋 Static Protected Member Functions 🦋

static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer.

🦋 Static Protected Member Functions inherited from `SoTexture` 🦋

static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer.

🦋 Static Protected Member Functions inherited from `SoNode` 🦋

static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer.
static void setNextActionMethodIndex (int index) — set the next action method index.
static int getNextActionMethodIndex (void) — get the next action method index.
static void incNextActionMethodIndex (void) — bump the next action method index.
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — set compatibility types for a node type.

🦋 Static Protected Member Functions inherited from `SoBase` 🦋

static uint32_t getCurrentWriteCounter (void) — read the current write counter.
static void staticDataLock (void) — lock the static data.
static void staticDataUnlock (void) — unlock the static data.

💀 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 bestie that's the whole synopsis spread, every last inherited member accounted for, nothing skipped, no cap 🧚

there's more coming in part 2 — so don't go anywhere, the DESCRIPTION and the rest of the lore is literally right there 👀💖

💖 DESCRIPTION 💖

ok so bestie, SoTextureCubeMap is the node that wraps a cube map around every shape node that comes after it. cube map = six images, one per face of a cube, and your geometry gets to wear all six like a full fit. 🧊✨

Who actually gets the lewk? Every shape node that's within the scope of your SoTextureCubeMap nodes in the scene graph — which means it's below the same SoSeparator and to the right hand side of the SoTextureCubeMap. Those shapes get the texture applied according to each shape type's own individual characteristics. every shape type wears it differently, iykyk.

Want the actual specifics of how the texture lands on each kind of shape? go read the docs of the shape types themselves — SoFaceSet, SoCube, SoSphere, etc. They spill all the tea. 💅

FILE FORMAT/DEFAULTS:

TextureCubeMap {
    filenames [  ]
    imagePosX 0 0 0
    imageNegX 0 0 0
    imagePosY 0 0 0
    imageNegY 0 0 0
    imagePosZ 0 0 0
    imageNegZ 0 0 0
    wrapS REPEAT
    wrapT REPEAT
    model MODULATE
    blendColor 0 0 0
}

Since: Coin 3.0 — yeah she's a Coin original, not an SGI hand-me-down. 👑

🧬 MEMBER ENUMERATION 🧬

enum SoTextureCubeMap::Model

This is the texture mapping model — it decides how the texture map gets "merged" with the object it's mapped onto. like, how do we blend these two worlds bestie. 🌈

MODULATE — texture color gets multiplied by the polygon color. The result will be Phong shaded (if the light model is PHONG). classic, iconic, does what it says.
DECAL — texture image overwrites polygon shading. Textured pixels will not be Phong shaded. 🚨 heads up: has undefined behaviour for grayscale and grayscale-alpha textures. proceed with caution fr.
BLEND — 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 SoTextureCubeMap::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. (she adapts, she's flexible 💅)

⚠️ bestie listen — 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. no cap.

enum SoTextureCubeMap::Wrap

The wrapping strategies you can use when the texture map doesn't cover the full extent of the geometry. (i.e. when your texture is smaller than the thing it's hugging.) 🎀

REPEAT — repeat texture when coordinate is not between 0 and 1.
CLAMP — clamp coordinate between 0 and 1.

🎀 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🎀

`SoTextureCubeMap::SoTextureCubeMap (void )`

Constructor. hi bestie, she's born. ✨

`SoTextureCubeMap::~SoTextureCubeMap ()` [protected], [virtual]

Destructor. Frees up internal resources used to store texture image data. she cleans up after herself, we love a tidy queen. 🧹

✨ MEMBER FUNCTION DOCUMENTATION ✨

`SoType SoTextureCubeMap::getClassTypeId (void )` [static]

This static method returns the SoType object associated with objects of this class. your girl's official ID card. 🪪

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