SoBumpMapCoordinate(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44
💖 ok so bestie, this is SoBumpMapCoordinate(3), straight out of the Coin manual. this is part 1 of 2, so don't go anywhere, we're not done ✨

🌸 NAME 🌸

SoBumpMapCoordinate — a whole entire node whose one job is providing bump map coordinates to shape nodes. it's giving supportive bestie holding your iced coffee while you fix your eyeliner 🫶

🎀 SYNOPSIS 🎀

#include <Inventor/nodes/SoBumpMapCoordinate.h>

and yeah, lowkey it inherits from SoNode, so it came with the whole node family package 💅

💜 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=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)
  • SbUniqueId 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 — hands back TRUE if the type of this object is either of the same type or inherited from type.
  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. (yes it does the boring-but-essential setup, iconic behavior honestly)

💜 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static void initClasses (void)
  • static SbUniqueId 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • 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)

🍓 Public Attributes 🍓

  • SoMFVec2f point

🌸 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)
  • 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
  • virtual SoNotRec createNotRec (void)

💖 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, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

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

🌟 Detailed Description 🌟

ok so SoBumpMapCoordinate is literally the node that provides bump map coordinates to shape nodes. that's the whole vibe. no cap 💅

when traversal bumps into nodes of this type, the coordinates it's holding get put on the state stack, where shape nodes can come collect them later 🌸

those bump map coordinates let you specify explicit coordinates for a bump map. and the SoBumpMap node is the one you use to specify a bump map for shape nodes. they're a little duo, they work together 🫶

⚠️ heads up bestie: an SoBumpMapCoordinate node will replace the bump map coordinates that are already present in the state (if there are any). it's not merging, it's replacing. periodt.

also, another thing: since the indexed shape nodes don't have a bumpMapCoordIndex field, the textureCoordIndex field is what gets used for selecting bump map coordinate indices. you can set the bump map coordinate binding with the SoTextureCoordinateBinding node. so bump map coordinates must have the same binding as the texture coordinates for texture unit 0. no exceptions, that's just the rule 🔥

and if you supply no bump map coordinates for a shape at all? then the texture coordinates for texture unit 0 get used instead. convenient honestly ✨

💾 FILE FORMAT/DEFAULTS 💾

BumpMapCoordinate {
    point [  ]
}

🕰️ Since 🕰️

Coin 2.2

🔧 Constructor & Destructor Documentation 🔧

🌟 SoBumpMapCoordinate::SoBumpMapCoordinate (void )

Constructor. it makes one of these. that's it, that's the job 💖

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

Destructor. it cleans up after itself. she's responsible like that 🎀

✨ Member Function Documentation ✨

SoType SoBumpMapCoordinate::getClassTypeId(void) [static]

Bestie, this is the lil static lookup that hands you the SoType object for this class. That's it, that's the whole job — you ask it "who are you, class-wise?" and it tells you. 💅

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

This one gives you the type ID of an object that comes from a class inheriting SoBase. What's it for? Runtime type checking and "downward" casting, periodt. So like, when you're at runtime and you gotta figure out what something actually is before you cast it down the inheritance tree — this is the function you call. 🌈

Implements SoBase.

const SoFieldData ** SoBumpMapCoordinate::getFieldDataPtr(void) [static], [protected]

Okay so, real talk: this API member is considered internal to the library, because it's not likely to be of interest to the application programmer. So if you're just writing an app, this is a "nothing to see here" moment. 🙈

What it returns: the SoFieldData class which holds information about fields in this node. That's the lore. ✨

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

Hands you back a pointer to the class-wide field data storage object for this instance. And heads up — if there are no fields present, it returns NULL. So check before you dereference, babe. 😭

Reimplemented from SoFieldContainer.

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

This function performs the typical operation of a node for any action. Any action. It's giving "one method to vibe with them all." 👑

Reimplemented from SoNode.

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

This is the action method for the SoGLRenderAction, and it gets called during rendering traversals. If a node influences the rendering state in any way, or wants to throw geometry primitives at OpenGL — this is the method it overrides. The main character of the render pipeline, fr fr. 🔥

Reimplemented from SoNode.

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. Sneaky? No. Useful? Absolutely. 🦋

Reimplemented from SoNode.

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

Action method for SoPickAction — and it does the common processing for SoPickAction action instances. Nothing extra, just the shared legwork so every pick action isn't out here duplicating itself. 💖

Reimplemented from SoNode.

🎀 Member Data Documentation 🎀

SoMFVec2f SoBumpMapCoordinate::point

A set of 2D points. And ngl, it contains no points by default — so it starts out empty, and it's on you to fill it. Go off, bestie. ✨

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. (Not a human, just a very hardworking doc generator doing its little thing. Respect.) 🫶

And that's the whole page, babe — we did it. 💜 This gorgeousness is Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it lives at SoBumpMapCoordinate(3). Stan a well-documented node. Slay, bye! 💅🎀✨

📦 where this page comes from