NAME

       SoHeightMapToNormalMap -

       Engine for computing a normal map from a height map.

SYNOPSIS

       #include <Inventor/engines/SoHeightMapToNormalMap.h>

       Inherits SoTexture2Convert.

   Public Types
       enum NormalMapFormat { INT8 }

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase.
           This is used for run-time type checking and 'downward' casting.
       virtual const SoFieldData * getFieldData (void) const
       virtual const SoEngineOutputData * getOutputData (void) const
       SoHeightMapToNormalMap (void)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void * createInstance (void)
       static void initClass (void)
       static void convert (const unsigned char *srcptr, SbVec2s size, int nc, SbImage &dst_out)

   Public Attributes
       SoSFEnum format

   Protected Member Functions
       virtual void inputChanged (SoField *which)
       virtual void evaluate (void)

   Static Protected Member Functions
       static const SoFieldData ** getInputDataPtr (void)
       static const SoEngineOutputData ** getOutputDataPtr (void)

   Additional Inherited Members

Detailed Description

       Engine for computing a normal map from a height map.

       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

   SoType SoHeightMapToNormalMap::getTypeId (void) const [virtual]
       Returns the type identification of an object derived from a class inheriting SoBase. This
       is used for run-time type checking and 'downward' casting. Usage example:

       void foo(SoNode * node)
       {
         if (node->getTypeId() == SoFile::getClassTypeId()) {
           SoFile * filenode = (SoFile *)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. 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.

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

       Reimplemented from SoTexture2Convert.

   const SoFieldData * SoHeightMapToNormalMap::getFieldData (void) const [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no
       fields are present, returns NULL.

       Reimplemented from SoTexture2Convert.

   const SoEngineOutputData * SoHeightMapToNormalMap::getOutputData (void) const [virtual]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

       Reimplemented from SoTexture2Convert.

   void SoHeightMapToNormalMap::initClass (void) [static]
       Class initializer.

   void SoHeightMapToNormalMap::convert (const unsigned char *srcptr, SbVec2ssize, intnc, 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.

   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

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

Author

       Generated automatically by Doxygen for Coin from the source code.