SoBumpMapTransform(3)

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

💖 SoBumpMapTransform 💖

okay bestie, welcome to the manual page for SoBumpMapTransform(3) from Coin. yes it's the Coin library, yes it's the 3D-graphics one, and yes this node is literally the moment your 2D bump maps get to move around. we're doing part 1 of 2, so buckle up, hydrate, and let's go ✨

🌸 NAME 🌸

SoBumpMapTransform — the class that defines 2D bump map transformations. it's giving "make my bump map do a little dance" and honestly? iconic. 💅

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoBumpMapTransform.h>

Inherits SoNode.

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const
  • SoBumpMapTransform (void)
  • virtual void doAction (SoAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void getMatrix (SoGetMatrixAction *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 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 — Returns 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. the classic glow-up ritual ✨

🌟 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 🍓

  • SoSFVec2f translation
  • SoSFFloat rotation
  • SoSFVec2f scaleFactor
  • SoSFVec2f center

🧚 Protected Member Functions 🧚

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoBumpMapTransform ()

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

so. the SoBumpMapTransform class is used to define 2D bump map transformations. that's the whole vibe. 💖

bump maps applied to shapes in the scene can be transformed by "prefixing" in the state with instances of this node type. translations, rotations and scaling in 2D can all be done — every single one of them, no cap. ✨

the default settings of this node's fields equal a "nulltransform", i.e. no transformation. so if you just drop it in and change nothing, it does absolutely nothing. respectfully. it's giving "I'm just here for the vibes." 🙈

FILE FORMAT/DEFAULTS:

BumpMapTransform {
    translation 0 0
    rotation 0
    scaleFactor 1 1
    center 0 0
}

Since

Coin 2.2 — a true elder of the Coin 2.x era 👑

🎀 Constructor & Destructor Documentation 🎀

SoBumpMapTransform::SoBumpMapTransform (void )

Constructor. it makes the thing. that's it, that's the whole job, and it ate. 💅

SoBumpMapTransform::~SoBumpMapTransform () [protected], [virtual]

Destructor. it cleans up the thing. protected, virtual, very "don't touch me unless you're family" energy. 🫶

okay bestie we're not done yet — this was just part 1 of 2, so keep scrolling, the rest is right there 🌸🦋

💅 Member Function Documentation 💅

Ok bestie, this is the part where we meet all the functions this class is serving. Every single one. No skips, no shortcuts, we're going the whole way through the list. Grab a snack. 🍓

⭐ SoType SoBumpMapTransform::getClassTypeId (void ) [static]

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

That's it. That's the whole thing. It's the ✨class✨ ID, not the instance ID — static, so you don't even need an object to ask for it. Iconic behavior honestly.

🦋 SoType SoBumpMapTransform::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.

So when you've got a pointer that's like "hmm, what even are you?", this is how you find out. It's the vibe check of the object system, fr fr.

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

Okay so this API member is considered internal to the library, because it's not likely to be of interest to the application programmer. So like… if you're writing an app, this is not your moment. 💀

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

🌸 const SoFieldData * SoBumpMapTransform::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.

Note that NULL situation — no fields means you get nothing back, not a sad little empty object. Adjust your expectations accordingly, bestie.

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

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

Reimplemented from SoNode.

It's the general-purpose "do the thing" — the main character of the action pipeline, lowkey.

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

So if you're out here just reading the scene graph and not drawing anything, this is the door you knock on. 🫶

✨ void SoBumpMapTransform::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.

"Throw geometry primitives at OpenGL" is genuinely such an aggressive way to describe rendering and I'm obsessed with it. 😭

🌈 void SoBumpMapTransform::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoNode.

That "(if any)" is doing a lot of heavy lifting there. Sometimes there's a matrix, sometimes there isn't, and we simply respect the mystery. 🙈

🧚 void SoBumpMapTransform::pick (SoPickAction * action) [virtual]

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

Picking! Like when you click on something in the scene and it goes "oh, me?" Yeah. This is that.

👑 Member Data Documentation 👑

Now for the actual data — the fields, the values, the defaults. This is the part you screenshot and keep in your notes app. No cap. 💜

💫 SoSFVec2f SoBumpMapTransform::translation

Texture coordinate translation. Default value is [0, 0].

🌀 SoSFFloat SoBumpMapTransform::rotation

Texture coordinate rotation (around Z-axis, s is X-axis and t is Y-axis). Defaults to an identity rotation (i.e. zero rotation).

So the axes are: s = X, t = Y, and the spin happens around Z. Default is identity, which is fancy-speak for "it's not rotating, bestie, it's just sitting there being normal." ⭐

🦄 SoSFVec2f SoBumpMapTransform::scaleFactor

Texture coordinate scale factors. Default value is [1, 1].

A [1, 1] default means everything is exactly the size it already is. Balanced. Grounded. Mentally stable scale factor energy. 🌸

🍓 SoSFVec2f SoBumpMapTransform::center

Center for scale and rotation. Default value is [0, 0].

This is the lil anchor point that scaling and rotation pivot around, and by default it's just the origin. Simple. Clean. Periodt. 💅

🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code.

Like, not a human author — a robot did this. Respect the robot. 🤖💖

And that's the whole page, bestie!! Version 4.0.10, dated Thu Jun 25 2026 00:00:00 — shoutout to SoBumpMapTransform(3) for being the moment. Read the manpage, love the manpage, go touch some texture coordinates. Byeeee 🫶✨🎀
📦 where this page comes from