SoBumpMapTransform(3)

📦 version 3.1.3, in fedora 43, fedora 44

okay so bestie, you've stumbled onto the SoBumpMapTransform(3) page from the Library Functions Manual, and honestly? it's a good one. it's the node that tells Coin how to slide, spin and squish your 2D bump maps around, and it is so much less scary than the synopsis wall below makes it look. let's get into it 💖

✨ NAME ✨

SoBumpMapTransform — the class that defines 2D bump map transformations. that's it, that's the job 🫶

🦋 SYNOPSIS 🦋

first things first, the include, no cap:

#include <Inventor/nodes/SoBumpMapTransform.h>

it Inherits SoNode. yes bestie, it's a node, it lives in the scene graph like the rest of the family 🌸

💅 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)
  • 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=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
  • 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 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)
  • 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 *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

these four are the whole personality of the node, fr fr:

  • 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

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

💀 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 = 1
  • static int nextActionMethodIndex = 0

🎀 Detailed Description 🎀

okay so the whole point of SoBumpMapTransform is defining 2D bump map transformations. that's the vibe. ✨

bump maps that get applied to shapes in the scene can be transformed by "prefixing" in the state with instances of this node type. and like — translations, rotations and scaling in 2D are all on the menu. you can do all three. iconic 💅

and here's the chill part: the default settings of this node's fields equal a "nulltransform", ie no transformation. so if you just drop one in and touch nothing, nothing moves. she's lowkey just standing there being a vibe 🦋

FILE FORMAT/DEFAULTS:

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

⭐ Since

Coin 2.2 — yes she's been around, she's a legacy queen 👑

💖 Constructor & Destructor Documentation 💖

🫶 SoBumpMapTransform::SoBumpMapTransform (void )

Constructor. that's the glow-up moment, she exists now 🌸

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

Destructor. protected and virtual, as she deserves. 💜

okay bestie that's the class shape, the fields, and the birth/death of the node — but we are so not done. the next part has the rest, don't wander off 💅✨

💖 Member Function Documentation 💖

🌈 SoType SoBumpMapTransform::getTypeId(void) const [virtual]

okay bestie, this one is the vibe check for your objects 💅 It hands you back the type identification of any object derived from a class that inherits SoBase, and it's what powers run-time type checking plus those "downward" casts. iykyk.

Usage example, no cap:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

Now, if you're an application programmer who wants to extend the library with brand-new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. like, all of them, fr fr. You typically do it as part of setting up the full type system for your extension classes, and that's usually accomplished with the pre-defined macros you can grab from, for instance, Inventor/nodes/SoSubNode.h (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes), and so on 🎀

want more tea on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. slay.

Implements SoBase.

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

Gives you back a pointer to the class-wide field data storage object for this instance ✨ And if there are no fields present at all? It returns NULL. That's it, that's the whole thing 💜

Reimplemented from SoFieldContainer.

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

This function performs the typical operation of a node for any action. any action, bestie, it's giving main character energy 👑

Reimplemented from SoNode.

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

Reimplemented from SoNode.

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

Action method for the SoGLRenderAction.

This one gets called during rendering traversals 🎬 Nodes that influence the rendering state in any way — or that just want to throw geometry primitives at OpenGL — override this method. periodt.

Reimplemented from SoNode.

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

Action method for SoGetMatrixAction.

It updates action by accumulating with the transformation matrix of this node (if any) 🧚

Reimplemented from SoNode.

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

Action method for SoPickAction.

Does the common processing for SoPickAction action instances. standard queen behaviour 💖

Reimplemented from SoNode.

🍓 Member Data Documentation 🍓

🎀 SoSFVec2f SoBumpMapTransform::translation

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

🌈 SoSFFloat SoBumpMapTransform::rotation

Texture coordinate rotation (around the z-axis, where s is the x-axis and t is the y-axis, bestie) 🔄 Defaults to an identity rotation, ie zero rotation.

✨ SoSFVec2f SoBumpMapTransform::scaleFactor

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

💜 SoSFVec2f SoBumpMapTransform::center

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

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. so yes, a robot wrote this, and it still ate 💀

and that's a wrap on part 2, bestie!! 🫶 this whole page is from Coin, Version 3.1.3, and it's SoBumpMapTransform(3) — go forth and transform those texture coordinates, you absolute icon 🌟💖
📦 where this page comes from