SoTextureC...nvironment(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoTextureCoordinateEnvironment(3) 💖

okay bestie, welcome to the Library Functions Manual 💅 this one's the manual page for SoTextureCoordinateEnvironment and it is lowkey iconic — grab a boba, we're mapping textures onto a whole sphere around your scene 🌸

✨ NAME ✨

SoTextureCoordinateEnvironment — the class that generates texture coordinates by projecting onto a surrounding texture 🦋

no cap, that's literally its whole job. it takes your texture and wraps it around everything below it in the scenegraph like a little bubble 🌈

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoTextureCoordinateEnvironment.h>

it Inherits SoTextureCoordinateFunction — so yeah, all that family energy is inherited too 👑

🫶 Public Member Functions

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

👑 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)
  • ~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
}

🛡️ 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 SoTextureCoordinateEnvironment generates texture coordinates by projecting onto a surrounding texture 🫶

the texture specifying the enviroment will be mapped around the scenegraph below this node using a sphere. the texture will be mapped onto the scenegraph taking camera position into account. this will lead to an object <emphasis>reflecting its enviroment</emphasis> ✨ — like it's wearing the whole world as a lil outfit, periodt 💅

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 }

🌈 FILE FORMAT/DEFAULTS 🌈

TextureCoordinateEnvironment {
}

yep, that's it. no fields, no nothing. she's empty on purpose and she ate 🍽️

🛠️ Constructor & Destructor Documentation 🛠️

SoTextureCoordinateEnvironment::SoTextureCoordinateEnvironment (void )

Constructor. 🌱 makes a brand new one for you, bestie.

References SoTextureCoordinateEnvironment().

Referenced by getFieldData(), and SoTextureCoordinateEnvironment().

SoTextureCoordinateEnvironment::~SoTextureCoordinateEnvironment ()

[protected], [virtual]

Destructor. 🪦 cleans up after herself, as she should.

✨ Member Function Documentation ✨

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

Okay bestie, this one hands you back the type ID of any object that descends from a class inheriting SoBase. It's giving runtime type checking and "downward" casting vibes. 💅

Usage example, no cap:

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 all you 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 info 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]

This one returns a pointer to the class-wide field data storage object for this instance. If no fields are present, it returns NULL. Simple as that. 🎀

Reimplemented from SoTextureCoordinateFunction.

References SoTextureCoordinateEnvironment().

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

This function performs the typical operation of a node for any action. It's the main character of node operations, fr fr. 👑

Reimplemented from SoNode.

References SoAction::getState().

Referenced by callback(), GLRender(), and pick().

void SoTextureCoordinateEnvironment::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction. This gets called during rendering traversals. Nodes that influence the rendering state in any way, or who want to throw geometry primitives at OpenGL, override this method. It's giving OpenGL glow-up. 🌈

Reimplemented from SoNode.

References doAction(), and SoAction::getState().

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

Action method for SoPickAction. Does the common processing for SoPickAction action instances. Lowkey essential for picking stuff. 🎯

Reimplemented from SoNode.

References doAction().

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. It's giving "I'm just here to help you snoop on the scene graph". 🙈

Reimplemented from SoNode.

References doAction().

📝 Author

Generated automatically by Doxygen for Coin from the source code.

And that's a wrap! This page came from Coin, Version 2.5.0, and it's the SoTextureC...nvironment(3) manpage. Stay iconic, bestie. 💖

📦 where this page comes from