SoBumpMapCoordinate(3)

💖 SoBumpMapCoordinate 💖

okay bestie, welcome to SoBumpMapCoordinate(3) — she lives in the Library Functions Manual and she is, and I say this with my whole chest, the bump map coordinate plug. 🦋

---

✨ NAME ✨

SoBumpMapCoordinate — the SoBumpMapCoordinate class is a node for providing bump map coordinates to shape nodes. no cap, that's literally her whole job 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoBumpMapCoordinate.h>

Inherits SoNode. yes she's a nepo baby, but like, a talented one. 👑

🌈 Public Member Functions

virtual SoType getTypeId (void) const
SoBumpMapCoordinate (void)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void pick (SoPickAction *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=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 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)

🌸 Public Attributes

SoMFVec2f point

the moment we've all been waiting for: point. she's the main character fr fr. 💅

💜 Protected Member Functions

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

🍓 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 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, the SoBumpMapCoordinate class is a node for providing bump map coordinates to shape nodes. that's the vibe. 🎀

when the traversal situation encounters nodes of this type, the coordinates it contains will be put on the state stack for later use by shape nodes. so like, she drops her coordinates off at the state stack and the shape nodes pick them up later. teamwork. 🫶

the bump map coordinates can be used to specify explicit coordinates for a bump map. and the SoBumpMap node is the one that specifies a bump map for the shape nodes — different node, different job, don't mix them up bestie. 💅

heads up: an SoBumpMapCoordinate node will replace the bump map coordinates already present in the state (if any). so if there were coords chillin' there before, they're gone. no survivors. 😭

also note — and this part is important, iykyk — since the indexed shape nodes have no bumpMapCoordIndex field, the textureCoordIndex field will be used for selecting bump map coordinate indices. you can set the bump map coordinate binding using the SoTextureCoordinateBinding node. bump map coordinates must therefore have the same binding as the texture coordinates for texture unit 0. yeah. that's the rule. periodt. ✨

if you supply no bump map coordinates for a shape, the texture coordinates for texture unit 0 will be used. default behaviour, she's giving generous. 💖

🌈 FILE FORMAT/DEFAULTS:

BumpMapCoordinate {
    point [  ]
}

🎀 Since

Coin 2.2 ⭐

---

💅 Constructor & Destructor Documentation 💅

🦋 SoBumpMapCoordinate::SoBumpMapCoordinate (void )

Constructor. she's born. 👑

References point, and SoBumpMapCoordinate().

Referenced by getFieldData(), and SoBumpMapCoordinate().

🧚 SoBumpMapCoordinate::~SoBumpMapCoordinate () [protected], [virtual]

Destructor. she's gotta go eventually, protected and virtual and everything. 💜

✨ Member Function Documentation ✨

💫 SoType SoBumpMapCoordinate::getTypeId (void ) const [virtual]

okay so this one hands you back the type identification of an object derived from a class inheriting SoBase. it's literally the whole reason run-time type checking and "downward" casting even work. no cap.

Usage example, bestie — copy it exactly:

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 application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. like, all of them, no skipping 💅. 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.

Implements SoBase.

🫶 const SoFieldData * SoBumpMapCoordinate::getFieldData (void ) const [protected], [virtual]

returns a pointer to the class-wide field data storage object for this instance. and if there are no fields present? it returns NULL. that's it, that's the whole function.

Reimplemented from SoFieldContainer.

References SoBumpMapCoordinate().

🌸 void SoBumpMapCoordinate::doAction (SoAction * action) [virtual]

this function performs the typical operation of a node for any action. yeah, any action. it's giving versatile queen.

Reimplemented from SoNode.

References SoAction::getState(), and point.

Referenced by callback(), and pick().

🔥 void SoBumpMapCoordinate::GLRender (SoGLRenderAction * action) [virtual]

action method for the SoGLRenderAction. this gets called during rendering traversals. nodes influencing the rendering state in any way, or who wants to throw geometry primitives at OpenGL, override this method. main character energy fr fr.

Reimplemented from SoNode.

References SoAction::getState(), and point.

🧚 void SoBumpMapCoordinate::callback (SoCallbackAction * action) [virtual]

action method for SoCallbackAction. it 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. lowkey so useful.

Reimplemented from SoNode.

References doAction().

💜 void SoBumpMapCoordinate::pick (SoPickAction * action) [virtual]

action method for SoPickAction. does common processing for SoPickAction action instances. that's the vibe.

Reimplemented from SoNode.

References doAction().

---

⭐ Member Data Documentation ⭐

🍓 SoMFVec2f SoBumpMapCoordinate::point

set of 2D points. contains no points by default. iconic, honestly.

Referenced by doAction(), GLRender(), and SoBumpMapCoordinate().

---

👑 Author 👑

generated automatically by Doxygen for Coin from the source code.

---

and that's a wrap bestie 💖 this page is from Coin, Version 2.5.0, and it's the SoBumpMapCoordinate(3) manual. go forth and bump those map coordinates, periodt ✨🦋