SoTextureC...nvironment(3)

📦 version 3.1.3, in fedora 43, fedora 44

okay so bestie, welcome to the manual page for SoTextureC...nvironment(3), from the Library Functions Manual. Yeah the title's got that lil' ellipsis glow-up because it's long — the real one is the class we're about to meet. Sit down, hydrate, we're doing environment mapping today 💅

🎀 NAME 🎀

SoTextureCoordinateEnvironment — the class that generates texture coordinates by projecting onto a surrounding texture. It's giving "wrap the whole world around my object," fr fr. 🦋

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoTextureCoordinateEnvironment.h>

Inherits SoTextureCoordinateFunction. So it's part of the texture-coordinate-function family tree, and it carries everything that family inherits too. Periodt.

💖 Public Member Functions 💖

The stuff that's actually yours, bestie:

  • virtual SoType getTypeId (void) const
  • SoTextureCoordinateEnvironment (void)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void callback (SoCallbackAction *action)

🌸 Public Member Functions inherited from SoTextureCoordinateFunction 🌸

  • SoTextureCoordinateFunction (void)

🌈 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)
  • static void initClass (void)

🌟 Static Public Member Functions inherited from SoTextureCoordinateFunction 🌟

  • 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 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)

🫶 Protected Member Functions 🫶

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoTextureCoordinateEnvironment ()

💜 Protected Member Functions inherited from SoTextureCoordinateFunction 💜

  • virtual ~SoTextureCoordinateFunction ()

💜 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)

⭐ Static Protected Member Functions inherited from SoTextureCoordinateFunction ⭐

  • 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 💅

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

🌸 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 💖

So here's the tea ☕. SoTextureCoordinateEnvironment generates texture coordinates by projecting onto a surrounding texture. That's the whole vibe.

The texture specifying the enviroment will be mapped around the scenegraph below this node using a sphere. And the texture gets mapped onto the scenegraph taking camera position into account. Which means — plot twist — you end up with an object that's reflecting its enviroment. Main character behavior honestly. 🔥

Here's a scenegraph example showing how enviroment mapping can be applied to an object:

 #Inventor V2.1 ascii

Separator {

 Texture2 { filename "ocean.jpg" # the enviroment, in this case ocean }
TextureCoordinateEnvironment {}

 Cube {} # the enviromentally mapped object }

(yes bestie, that's ocean.jpg doing the heavy lifting, and the Cube is the enviromentally mapped object — the comments said it, not me 🫶)

🌸 FILE FORMAT/DEFAULTS 🌸

TextureCoordinateEnvironment {
}

Empty braces, zero drama, exactly as written. No cap. ✨

✨ CONSTRUCTOR & DESTRUCTOR DOCUMENTATION ✨

💜 SoTextureCoordinateEnvironment::SoTextureCoordinateEnvironment (void ) 💜

Constructor. It's born. 🎀

💜 SoTextureCoordinateEnvironment::~SoTextureCoordinateEnvironment () 💜

[protected], [virtual]

Destructor. It's the goodbye, and it's protected + virtual, so mind your inheritance business.

✨ Member Function Documentation ✨

okay bestie, let's get into the ~functions~ 💅 these are the methods that make this node do its thing. no cap.

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

returns the type identification of an object derived from a class inheriting SoBase. this is used for run-time type checking and "downward" casting. periodt.

usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)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.

reimplemented from SoTextureCoordinateFunction.

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

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

this function performs the typical operation of a node for any action. like, it does the thing. ✨

reimplemented from SoNode.

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

void SoTextureCoordinateEnvironment::pick (SoPickAction * action) [virtual]

action method for SoPickAction. does common processing for SoPickAction action instances. lowkey essential. 🎀

reimplemented from SoNode.

void SoTextureCoordinateEnvironment::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. iykyk 💜

reimplemented from SoNode.

👑 Author 👑

generated automatically by Doxygen for Coin from the source code. so yeah, a robot wrote this, not me. I'm just the messenger bestie. 🤖💖

that's the whole vibe! this page is from Coin version 3.1.3, the SoTextureC...nvironment(3) manpage. stay iconic, slay the day, and don't forget to cast safely! 💅✨🦋

📦 where this page comes from