SoBumpMap(3)

📦 version 2.5.0, in fedora 43, fedora 44

💅 SoBumpMap(3) — Library Functions Manual 💅

✨ Part 1 of 2, bestie. Part 2 is coming, so don't go anywhere. 💖

💖 NAME 💖

SoBumpMap — the class that maps a bump map onto subsequent shapes. It's giving "I'm about to make everything after me look bumpy and textured" energy. No cap.

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoBumpMap.h>

Inherits SoNode.

🫶 Public Types 🫶

enum Wrap { REPEAT = SoTextureImageElement::REPEAT, CLAMP = SoTextureImageElement::CLAMP }

🌸 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
    }

💅 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=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 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)
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 SbBool readImage (const SbString &fname, int &w, int &h, int &nc, unsigned char *&bytes)

⭐ 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 👑

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)
~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 🫶

🌟 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 SoBumpMap does exactly what the name says: it maps a bump map onto every shape that comes after it. It's giving "I'm about to make your surfaces look textured" energy. 💅

SoBumpMap has support for two types of maps. If the image is a three component (RGB) image, it gets treated as a normal map. In that case, the red image component equals the X normal component, green equals Y, and blue is Z. There's a nice introduction about bump mapping and normal maps at http://www.paulsprojects.net/tutorials/simplebump/simplebump.html — go look, bestie.

If the image is a grayscale image, it gets treated as a height map, and it's automatically converted to a normal map. So you don't have to do it yourself. Slay.

For bump mapping to work with extension nodes for Coin, the SoShape::generatePrimitives() method must be correctly implemented for the shape. This is needed since 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. So if you're rolling your own extension shape, that's on you, bestie.

Bump mapping in Coin requires OpenGL 1.3, or the following 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 run-time system doesn't meet these requirements, Coin will post a warning and the bump map will simply be ignored. So like, no crash, but also no bumps. Sad. 😭

GL_ARB_vertex_program and GL_ARB_fragment_program are required to get specular lighting on the bumps. If these extensions are not available, the bumps will be rendered with diffuse lighting only. So you still get something, just not the 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).

📁 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. Basically: what happens at the edges, bestie?

Enumerator

REPEAT — Repeat bump map when coordinate is not between 0 and 1. It's giving infinite pattern energy.
CLAMP — Clamp coordinate between 0 and 1. No repeating, just vibes.

💅 Constructor & Destructor Documentation 💅

✨ `SoBumpMap::SoBumpMap` (void) ✨

okay so this is the Constructor, bestie. it builds the thing. iconic behavior honestly.

🔗 References: CLAMP, filename, image, REPEAT, SoBumpMap(), wrapS, and wrapT
👀 Referenced by: getFieldData(), and SoBumpMap()

🌸 `SoBumpMap::~SoBumpMap` () [protected], [virtual] 🌸

the Destructor, aka the goodbye moment 🥺. it frees up internal resources used to store texture image data. so like, it cleans up after itself. very responsible of it, no notes.

🦋 Member Function Documentation 🦋

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

this one returns the type identification of an object derived from a class inheriting SoBase. it's what makes run-time type checking and "downward" casting possible. lowkey the backbone of the whole type system fr fr.

Usage example, straight up, no edits:

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
  }
}

so for application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: bestie, 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. the macros are doing the heavy lifting, we're just living in their world 💅

for more info on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

🎀 `const SoFieldData * SoBumpMap::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 vibe. short and efficient, we respect it.

♻️ Reimplemented from SoFieldContainer
🔗 References: SoBumpMap()

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

This function performs the typical operation of a node for any action. the generalist. the main character. it does the thing for whatever action comes knocking 💫

♻️ Reimplemented from SoNode
🔗 References: SoAction::getState(), and image
👀 Referenced by: rayPick()

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

Action method for the SoGLRenderAction. this one 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. so yeah, this is where the pixels get their moment ✨

♻️ Reimplemented from SoNode
🔗 References: SoGLRenderAction::getCacheContext(), SoAction::getState(), image, SoDebugError::postWarning(), wrapS, and wrapT

🫶 `void SoBumpMap::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. very "let me just peek at the scene graph real quick" energy, and honestly? valid.

Reimplemented from SoNode.

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

Action method for SoRayPickAction. it checks the ray specification of the action and tests for intersection with the data of the node. and heads up — nodes influencing relevant state variables for how picking is done also overrides this method. iykyk.

♻️ Reimplemented from SoNode
🔗 References: doAction()

💀 `SbBool SoBumpMap::readImage` (`const SbString & fname`, `int & w`, `int & h`, `int & nc`, `unsigned char *& bytes`) [static] 💀

okay bestie sit down for this one. it is not implemented. it was added to the API by mistake. and it will be removed in Coin 3. so like… do not use it. do not pass go. do not collect $200. it's giving "oops" 🙈

🧚 `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 / persistant 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. and here's the important part: the import process should be robust and handle corrupted input streams by returning FALSE. so like, no crashing out, just a polite no thank you 🎀

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

♻️ Reimplemented from SoNode
🔗 References: filename, SoReadError::post(), and SoNode::readInstance()

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

Notifies all auditors for this instance when changes are made. the group chat ping of the Coin world — everyone who needs to know, knows 📣

♻️ Reimplemented from SoNode
🔗 References: filename, SoNotList::getLastField(), image, and SoNode::notify()

⭐ 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. (yes it references itself, she's self-aware, we love a meta queen 💅)

👀 Referenced by: notify(), readInstance(), and SoBumpMap()

🌸 `SoSFImage SoBumpMap::image` 🌸

Inline image data. Defaults to contain an empty bump map. so it starts empty and it's just vibing until you give it something.

👀 Referenced by: doAction(), GLRender(), notify(), and SoBumpMap()

✨ `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.

👀 Referenced by: GLRender(), and SoBumpMap()

✨ `SoSFEnum SoBumpMap::wrapT` ✨

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