SoBumpMap(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

🌸 NAME 🌸

SoBumpMap — bestie, this is SoBumpMap(3) from Coin 🪙, and it's the class you use to map a bump map onto whatever shapes come after it. That's it, that's the whole vibe. 💅

🎀 SYNOPSIS 🎀

#include <Inventor/nodes/SoBumpMap.h>

Inherits SoNode.

💖 Public Types 💖

  • enum Wrap — { REPEAT = SoMultiTextureImageElement::REPEAT, CLAMP = SoMultiTextureImageElement::CLAMP }

✨ Public Types inherited from SoNode ✨

  • enum NodeType — the whole roster, no cap:
{ 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 }

🌟 Public Member Functions 🌟

  • virtual SoType getTypeId (void) const
  • SoBumpMap (void)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void rayPick (SoRayPickAction *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 pick (SoPickAction *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)
  • 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 — returns TRUE if the type of this object is either of the same type or inherited from type. So like… "are you one of us or descended from us" energy, fr fr.
  • 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. Iconic housekeeping 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. Lowkey the ID card of the whole class, bestie.
  • 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 👑

  • SoSFString filename
  • SoSFImage image
  • SoSFEnum wrapS
  • SoSFEnum wrapT

🌸 Protected Member Functions 🌸

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoBumpMap ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void notify (SoNotList *list)

🎀 Protected Member Functions inherited from SoNode 🎀

  • SoNode (void)
  • virtual ~SoNode ()

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

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

okay so bestie, here's the tea: the SoBumpMap class is what you use to map a bump map onto all the shapes that come after it. like, it's the setup, the shapes are the payoff. 💅

It's got your back with two flavors of map, and which one you get depends entirely on your image:

  • If your image is a three component (RGB) image, it gets treated as a normal map. The red image component equals the X normal component, green equals Y, and blue is Z. ✨ And if you want a nice intro about bump mapping and normal maps, there's this: http://www.paulsprojects.net/tutorials/simplebump/simplebump.html
  • If your image is a grayscale image, it gets treated as a height map and is automatically converted to a normal map. no extra work from you, we love that. 🎀

Now for the fine print that's actually important. For bump mapping to work with extension nodes for Coin, the SoShape::generatePrimitives() method must be correctly implemented for the shape. why? because tangent space coordinates need to be calculated for each vertex in the shape. All shape nodes which are a standard part of Coin meet this criteria. 🫶

Heads up: bump mapping in Coin requires OpenGL 1.3, or these OpenGL extensions: GL_ARB_multitexture, GL_ARB_texture_cube_map, GL_ARB_texture_env_combine and GL_ARB_texture_env_dot3 (or the corresponding EXT extensions). If the runtime system doesn't meet these requirements, Coin will post a warning and the bump map will simply be ignored. 😭

And if you want that ✨ sparkle ✨ on your bumps: GL_ARB_vertex_program and GL_ARB_fragment_program is required to get specular lighting on the bumps. If these extensions are not available, the bumps will be rendered with diffuse lighting only. ngl, still cute, just less shiny.

Bump mapped objects will be rendered with multiple rendering passes. One extra pass per light source for diffuse only bumps, and two extra passes per light source for diffuse and specular bumps. You can turn off specular lighting on the bumps by setting specularColor to (0.0, 0.0, 0.0). turning it off, turning it on, main character energy either way. 👑

📄 FILE FORMAT/DEFAULTS: 📄

BumpMap {
    filename ""
    image 0 0 0

    wrapS REPEAT
    wrapT REPEAT
}

⭐ Since ⭐

Coin 2.2

🌈 Member Enumeration Documentation 🌈

🎀 enum SoBumpMap::Wrap 🎀

Enumeration of wrapping strategies which can be used when the bump map doesn't cover the full extent of the geometry. (yes, it really said that, and yes, it's as real as it sounds.)

Enumerator

  • REPEAT — Repeat bump map when coordinate is not between 0 and 1.
  • CLAMP — Clamp coordinate between 0 and 1.

🧚 Constructor & Destructor Documentation 🧚

💜 SoBumpMap::SoBumpMap (void )

Constructor. the origin story. 🌱

💜 SoBumpMap::~SoBumpMap () [protected], [virtual]

Destructor. Frees up internal resources used to store texture image data. she's cleaning up after herself, we stan. 🧹✨

🔥 Member Function Documentation 🔥

💖 SoType SoBumpMap::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class.

💖 SoType SoBumpMap::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Implements SoBase.

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

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Returns the SoFieldData class which holds information about fields in this node.

💖 const SoFieldData * SoBumpMap::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 SoFieldContainer.

💖 void SoBumpMap::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

💖 void SoBumpMap::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method.

Reimplemented from SoNode.

💖 void SoBumpMap::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.

Reimplemented from SoNode.

💖 void SoBumpMap::rayPick (SoRayPickAction * action) [virtual]

Action method for SoRayPickAction.

Checks the ray specification of the action and tests for intersection with the data of the node.

Nodes influencing relevant state variables for how picking is done also override this method.

Reimplemented from SoNode.

💖 SbBool SoBumpMap::readInstance (SoInput * in, unsigned short flags) [protected], [virtual]

This method is mainly intended for internal use during file import operations.

It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistent representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went OK or not. The import process should be robust and handle corrupted input streams by returning FALSE.

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

Reimplemented from SoNode.

💖 void SoBumpMap::notify (SoNotList * l) [protected], [virtual]

Notifies all auditors for this instance when changes are made.

Reimplemented from SoNode.

🌸 Member Data Documentation 🌸

🦋 SoSFString SoBumpMap::filename

Bump map (or normal map) filename, referring to a file on disk in a supported image bitmap format. See SoBumpMap::filename for more information.

🦋 SoSFImage SoBumpMap::image

Inline image data. Defaults to contain an empty bump map. (an empty bump map is giving "we'll fill this in later", fr fr.)

🦋 SoSFEnum SoBumpMap::wrapS

Wrapping strategy for the S coordinate when the bump map is narrower than the object to map onto.

Default value is SoBumpMap::REPEAT.

🦋 SoSFEnum SoBumpMap::wrapT

Wrapping strategy for the T coordinate when the bump map is shorter than the object to map onto.

Default value is SoBumpMap::REPEAT.

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

and that's a wrap bestie 🫶 this lil page is from Coin, version 4.0.10, dated Thu Jun 25 2026 00:00:00 — SoBumpMap(3), periodt. 💅💖✨

📦 where this page comes from