SoTextureC...lectionMap(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

✨ SoTextureCoordinateReflectionMap(3) ✨

Library Functions Manual β€” yes bestie, we are in the manual, and we are thriving πŸ’…

okay so real talk, this page is SoTextureC...lectionMap(3) (the terminal just truncates her gorgeous long name, her full government name is SoTextureCoordinateReflectionMap and she EARNED it πŸ‘‘). She lives in the Library Functions Manual. Let's get into it.


🌸 NAME 🌸

SoTextureCoordinateReflectionMap β€” the class that generates 3D reflection texture coordinates. that's it. that's her whole job and she ate πŸ’–


πŸŽ€ SYNOPSIS πŸŽ€

first things first, you gotta pull her in:

#include <Inventor/nodes/SoTextureCoordinateReflectionMap.h>

She inherits from SoTextureCoordinateFunction. so like, she's part of the family, the lineage is giving legacy 🧬

πŸ’– Public Member Functions πŸ’–

these are the ones you can actually call, no cap:

virtual SoType getTypeId (void) const
SoTextureCoordinateReflectionMap (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 🌈

she got these from her parent, iconic inheritance moment:

SoTextureCoordinateFunction (void)

πŸ¦‹ Public Member Functions inherited from SoNode πŸ¦‹

the whole extended family tree, fr fr:

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 πŸ’œ

more inherited goodies, she's stacked:

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 πŸ“

the origin story, the founding mother:

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 ⭐

no instance required bestie, these are the class-level girlies:

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 πŸ’«

look at this list, she's literally so rich in statics:

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 πŸ”’

for the inner circle only, not for random callers:

virtual const SoFieldData * getFieldData (void) const
virtual ~SoTextureCoordinateReflectionMap ()

πŸ” 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 πŸ‘‘

these are the extras she carries around like little accessories πŸ’…

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 πŸ¦‹

okay so the vibe: the SoTextureCoordinateReflectionMap class generates 3D reflection texture coordinates. that's the whole lore.

This node is usually used along with a SoCubeMapTexture node... 🫧

FIXME: more doc. β€” yeah bestie the docs are lowkey unfinished here, that's literally what it says, we don't make the rules πŸ™ˆ

πŸ“œ FILE FORMAT/DEFAULTS: πŸ“œ

TextureCoordinateReflectionMap {
}

look at her, absolutely nothing inside, minimalist queen, giving less-is-more ✨


πŸ’€ Constructor & Destructor Documentation πŸ’€

🌸 SoTextureCoordinateReflectionMap::SoTextureCoordinateReflectionMap (void ) 🌸

Constructor. she's born πŸ’–

🌷 SoTextureCoordinateReflectionMap::~SoTextureCoordinateReflectionMap () 🌷

[protected] [virtual]

Destructor. she's gone πŸ’€ but respectfully.


πŸ’– Member Function Documentation πŸ’–

✨ SoType SoTextureCoordinateReflectionMap::getTypeId (void ) const [virtual] ✨

Okay bestie, this one hands you back the type identification of any object that inherits from SoBase. It's the whole reason run-time type checking works, and it's what makes "downward" casting possible. iykyk

Usage example, copy it exactly like this:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

Now for the application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else β€” listen up πŸ’… this method has to be overridden in all subclasses. No skipping it. Normally you do that as part of setting up the full type system for your extension classes, and honestly that's usually just handled by the pre-defined macros you get through, for instance, Inventor/nodes/SoSubNode.h (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. 🌈

Want the full tea on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. πŸ“š

Reimplemented from SoTextureCoordinateFunction.

πŸ¦‹ const SoFieldData * SoTextureCoordinateReflectionMap::getFieldData (void ) const [protected], [virtual] πŸ¦‹

This one gives you back a pointer to the class-wide field data storage object for this instance. And if there are no fields present at all? It returns NULL. That's it, that's the whole vibe. πŸ™ˆ

Reimplemented from SoTextureCoordinateFunction.

πŸŽ€ void SoTextureCoordinateReflectionMap::doAction (SoAction * action) [virtual] πŸŽ€

This function performs the typical operation of a node for any action. Universal queen behaviour, fr fr. πŸ‘‘

Reimplemented from SoNode.

🌸 void SoTextureCoordinateReflectionMap::GLRender (SoGLRenderAction * action) [virtual] 🌸

Action method for the SoGLRenderAction. the main character

So here's the deal: this gets called during rendering traversals. Any node that influences the rendering state in any way, or that wants to throw geometry primitives at OpenGL, overrides this method. Periodt. πŸ”₯

Reimplemented from SoNode.

πŸ’œ void SoTextureCoordinateReflectionMap::pick (SoPickAction * action) [virtual] πŸ’œ

Action method for SoPickAction.

It does the common processing for SoPickAction action instances. Lowkey essential, highkey underrated. ✨

Reimplemented from SoNode.

πŸ“ void SoTextureCoordinateReflectionMap::callback (SoCallbackAction * action) [virtual] πŸ“

Action method for SoCallbackAction.

It simply updates the state according to how the node behaves for the render action, so that you, the application programmer, can use the SoCallbackAction for extracting information about the scene graph. Not me handing you scene graph lore for free πŸ˜­πŸ’–

Reimplemented from SoNode.

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for Coin from the source code. Doxygen really said "I got this" and did it all by itself, iconic behaviour honestly. πŸŽ€


And that's a wrap on part 2, bestie! This lil' page came to you from Coin, Version 3.1.3, and yes the source is the source code itself, generated automatically and looking cute. Go forth and reflect those texture coordinates, you absolute legend πŸ¦‹πŸ’…βœ¨

πŸ“¦ where this page comes from