SoBumpMapTransform(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoBumpMapTransform(3) 💖

omg hi bestie! welcome to the manual page for SoBumpMapTransform(3) from the Library Functions Manual. this is literally the whole vibe for this class, and we're gonna go through it together. periodt. 💅

✨ NAME ✨

SoBumpMapTransform — the class that's used to define 2D bump map transformations. no cap.

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoBumpMapTransform.h>

Inherits SoNode. (iconic.)

💅 Public Member Functions 💅

here's the main character energy of this class's own 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 🌸

the whole squad of inherited functions 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 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 💜

more inherited cuties 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 🦋

and the OGs 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 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 🌈

these are the fields you can play with:

  • 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)
  • ~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 }

💜 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 the SoBumpMapTransform class is used to define 2D bump map transformations. that's the whole point.

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? all can be done. slay.

the default settings of this node's fields equals a "nulltransform", ie no transformation. so if you don't touch anything, nothing moves. periodt.

FILE FORMAT/DEFAULTS:

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

Since

Coin 2.2

💅 Constructor & Destructor Documentation 💅

✨ SoBumpMapTransform::SoBumpMapTransform (void ) ✨

Constructor. (omg it's literally the constructor.)

References center, rotation, scaleFactor, SoBumpMapTransform(), and translation.

Referenced by getFieldData(), and SoBumpMapTransform().

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

Destructor. (protected and virtual, bestie. handle with care.)

💖 Member Function Documentation 💖

Okay bestie, this is where the methods live, and they are lowkey iconic. Let's go one by one, no cap.

🦋 getTypeId — the type-checking main character 🦋

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

This one returns the type identification of an object derived from a class inheriting SoBase. It's for run-time type checking and "downward" casting, periodt.

Usage example, and yes it's giving exactly this:

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

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. That's typically done as part of setting up the full type system for extension classes, and it's 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.

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

  • Implements SoBase.

✨ getFieldData — the field data plug ✨

const SoFieldData * SoBumpMapTransform::getFieldData (void ) const

Tags: [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.
  • References SoBumpMapTransform().

💅 doAction — the all-action handler 💅

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

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

  • Reimplemented from SoNode.
  • References SoAction::getState().
  • Referenced by callback(), GLRender(), and pick().

🎀 callback — the callback action bestie 🎀

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.
  • References doAction().

🔥 GLRender — the OpenGL render vibe 🔥

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 who wants to throw geometry primitives at OpenGL overrides this method.

  • Reimplemented from SoNode.
  • References doAction().

🌈 getMatrix — the matrix accumulator 🌈

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.

👑 pick — the pick action processor 👑

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

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

  • Reimplemented from SoNode.
  • References doAction().

🌸 Member Data Documentation 🌸

These are the data members, and they are literally the lewk of this node.

🍓 translation 🍓

SoSFVec2f SoBumpMapTransform::translation

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

  • Referenced by SoBumpMapTransform().

🧚 rotation 🧚

SoSFFloat SoBumpMapTransform::rotation

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

  • Referenced by SoBumpMapTransform().

💜 scaleFactor 💜

SoSFVec2f SoBumpMapTransform::scaleFactor

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

  • Referenced by SoBumpMapTransform().

🫶 center 🫶

SoSFVec2f SoBumpMapTransform::center

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

  • Referenced by SoBumpMapTransform().

⭐ Author ⭐

Generated automatically by Doxygen for Coin from the source code.

Okay bestie, that's the whole page. It's from Coin Version 2.5.0, page SoBumpMapTransform(3), and Doxygen auto-generated it for Coin straight from the source code. No date on the footer, but the vibe is immaculate. 💖

📦 where this page comes from