SoHeightMapToNormalMap(3)

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

✨ NAME ✨

SoHeightMapToNormalMap — Engine for computing a normal map from a height map. This is the SoHeightMapToNormalMap(3) page from Coin, bestie. 💖

🎀 SYNOPSIS 🎀

#include <Inventor/engines/SoHeightMapToNormalMap.h>

Inherits SoTexture2Convert.

🌸 Public Types 🌸

  • enum NormalMapFormat { INT8 }

💅 Public Member Functions 💅

  • virtual SoType getTypeId (void) const
  • virtual const SoFieldData * getFieldData (void) const
  • virtual const SoEngineOutputData * getOutputData (void) const
  • SoHeightMapToNormalMap (void)

🦋 Public Member Functions inherited from SoEngine 🦋

  • void evaluateWrapper (void)
  • virtual int getOutputs (SoEngineOutputList &l) const
  • SoEngineOutput * getOutput (const SbName &outputname) const
  • SbBool getOutputName (const SoEngineOutput *output, SbName &outputname) const
  • SbBool isNotifying (void) const
  • virtual void notify (SoNotList *nl)
  • SoEngine * copy (void) const
  • virtual SoFieldContainer * copyThroughConnection (void) const
  • SbBool shouldCopy (void) const
  • virtual void writeInstance (SoOutput *out)

🌈 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 copyContents (const SoFieldContainer *from, SbBool copyconnections)
  • 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. (Like, it's giving "am I this or a descendant?" energy. 💅)
  • virtual SbName getName (void) const
  • virtual void setName (const SbName &newname)
  • virtual void startNotify (void)
  • 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 * createInstance (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.
  • static void convert (const unsigned char *srcptr, SbVec2s size, int nc, SbImage &dst_out)

🌟 Static Public Member Functions inherited from SoTexture2Convert 🌟

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

🫶 Static Public Member Functions inherited from SoEngine 🫶

  • 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 SoType getClassTypeId (void)
    • This static method returns the SoType object associated with objects of this class.
  • static SoEngine * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoEngineList &el)

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

  • SoSFEnum format

🌈 Public Attributes inherited from SoTexture2Convert 🌈

  • SoSFImage sourceImage
  • SoEngineOutput image

💀 Protected Member Functions 💀

  • virtual void inputChanged (SoField *which)
  • virtual void evaluate (void)

💜 Protected Member Functions inherited from SoEngine 💜

  • SoEngine (void)
  • virtual ~SoEngine (void)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • void writeOutputTypes (SoOutput *out)

🎀 Protected Member Functions inherited from SoFieldContainer 🎀

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

🌸 Protected Member Functions inherited from SoBase 🌸

  • SoBase (void)
  • virtual ~SoBase ()
  • 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 ** getInputDataPtr (void)
  • static const SoEngineOutputData ** getOutputDataPtr (void)

🦋 Static Protected Member Functions inherited from SoTexture2Convert 🦋

  • static const SoFieldData ** getInputDataPtr (void)
  • static const SoEngineOutputData ** getOutputDataPtr (void)

💖 Static Protected Member Functions inherited from SoEngine 💖

  • static const SoFieldData ** getInputDataPtr (void)
  • static const SoEngineOutputData ** getOutputDataPtr (void)

🌟 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 SoFieldContainer 💜

  • SbBool isBuiltIn

💖 Detailed Description 💖

Engine for computing a normal map from a height map. Periodt.

This engine will create a normal map texture from a height map texture. You can use it in an Inventor file like this:

Texture2 {
  image = HeightMapToNormalMap {
    sourceImage = Texture2 { filename "HeightMap.jpg" } . image
  } . image
}

Be aware that the field connections will remain active, so both Texture2 nodes and the HeightMapToNormalMap engine will be kept resident in memory (unless you intervene manually and detach the engine) even though only the "outer" Texture2 node is needed. This can give quite a big memory use overhead. 😭

Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since

  • Coin 3.0

💅 Member Enumeration Documentation 💅

enum SoHeightMapToNormalMap::NormalMapFormat

Enumeration of available normal map formats.

Enumerator

  • INT8 — Encode the normals as a 3 component byte texture. This is the only option for now, as long as float textures are not conveniently supported in Coin.

🎀 Constructor & Destructor Documentation 🎀

SoHeightMapToNormalMap::SoHeightMapToNormalMap (void )

Constructor.

💅 Member Function Documentation 💅

okay bestie, this is the part where we meet the actual functions — the little guys who do the work. every single one is here, no skips, no shortcuts. 🫶

🌸 SoType SoHeightMapToNormalMap::getClassTypeId (void ) — [static]

This static method returns the SoType object associated with objects of this class. that's it, that's the whole job, and she does it flawlessly. 💖

🌈 SoType SoHeightMapToNormalMap::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.

Reimplemented from SoTexture2Convert.

✨ const SoFieldData ** SoHeightMapToNormalMap::getInputDataPtr (void ) — [static], [protected]

Returns the SoFieldData class which holds information about inputs in this engine. lowkey the input lore-keeper. 📥

🎀 const SoEngineOutputData ** SoHeightMapToNormalMap::getOutputDataPtr (void ) — [static], [protected]

Returns the SoEngineOutputData class which holds information about the outputs in this engine. her sister but for outputs, periodt. 📤

🦋 const SoFieldData * SoHeightMapToNormalMap::getFieldData (void ) const — [virtual]

Returns the SoFieldData class which holds information about inputs in this engine.

Reimplemented from SoTexture2Convert.

💜 const SoEngineOutputData * SoHeightMapToNormalMap::getOutputData (void ) const — [virtual]

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

Reimplemented from SoTexture2Convert.

👑 void * SoHeightMapToNormalMap::createInstance (void ) — [static]

Creates a new instance of the class type corresponding to the SoType object. brand new baby object, freshly spawned, main character energy from day one. 🌟

🔥 void SoHeightMapToNormalMap::convert (const unsigned char * srcptr, SbVec2s size, int nc, SbImage & dst_out) — [static]

Static function for computing a normal map from a height map. This function can be used directly without any engine instantiation.

not me telling you that you can just call this one straight up — no engine, no instantiation, no ceremony. she's ready when you are. 😭💖

💀 void SoHeightMapToNormalMap::inputChanged (SoField * which) — [protected], [virtual]

Called when an input is changed. The default method does nothing, but subclasses may override this method to do The Right Thing when a specific field is changed.

Reimplemented from SoEngine.

🧚 void SoHeightMapToNormalMap::evaluate (void ) — [protected], [virtual]

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

Implements SoEngine.

🍓 Member Data Documentation 🍓

🌸 SoSFEnum SoHeightMapToNormalMap::format

This setting decides what kind of normal map is generated. For now, only the INT8 format is available, and it is the default value.

so like… it's INT8 or nothing, bestie. the menu has one item and honestly? it ate. 💅✨

⭐ Author ⭐

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page, we made it 🎉 this lil beauty is from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's filed under SoHeightMapToNormalMap(3). go forth and normal-map, you absolute icon 💖🌈🦋

📦 where this page comes from