dtk_render.hpp

Go to the documentation of this file.

#ifndef __UTIL_DTK_RENDER_HPP__
#define __UTIL_DTK_RENDER_HPP__
#include "def/define.h"
#include "util/BaseTypes/dtk_metadata.hpp"
#include "util/BaseTypes/dtk_object.hpp"
#include "util/BaseTypes/dtk_rgb.hpp"
#include "util/BaseTypes/dtk_string.hpp"
#include "util/dtk_picture.hpp"
#include "util/error_dtk.hpp"
#include "util/util_ptr_dtk.hpp"
#include "util/util_stl_dtk.hpp"
#include <memory>
 
class Dtk_TextureInfos ;
class Dtk_LightMap ;
class Dtk_RenderInfos ;
 
typedef Dtk_SmartPtr<Dtk_TextureInfos>          Dtk_TextureInfosPtr;
typedef Dtk_SmartPtr<Dtk_LightMap>              Dtk_LightMapPtr;
typedef Dtk_SmartPtr<Dtk_RenderInfos>           Dtk_RenderInfosPtr;
 
 
/////////////////////////////////////////////////////////////////////////////
//! \ingroup DtkAPIGroup
//! \class Dtk_RenderInfos 
//! \brief This is the Dtk_RenderInfos Class.\n
//! The Dtk_RenderInfosPtr object is used to store any informations about rendering
//! It contains lighting information and texture information.\n
//! \SmartPtr{Dtk_RenderInfosPtr}
class Dtk_TextureInfos : public Dtk_Object
{
public:
    enum TextureMappingTypeEnum
    {
        StoredUVMapping = 0,
        PlanarMapping = 1,
        CylinderMapping = 2,
        SphericalMapping = 3,
        CubicalMapping = 4,
          SkyPlanarMapping = 5,
          SkyCylinderMapping = 6,
          SkySphericalMapping = 7,
          SkyCubicalMapping = 8,
          UVBRepMapping       = 9,
          BuildingMapping = 10
    };
 
protected:
    enum { _typeID = DTK_TYPE_TEXTURE }; 
    struct Dtk_Handle;
    std::unique_ptr<Dtk_Handle> _Private;
 
     //! \sa Create( Dtk_TextureInfos const& )
    Dtk_TextureInfos(const Dtk_TextureInfos& );
     Dtk_TextureInfos( Dtk_TextureInfos&& ) DTK_NOEXCEPT;
    //! \sa Dtk_TextureInfos
    Dtk_TextureInfos(const TextureMappingTypeEnum& inType);
 
    //! \BaseDestructor 
    virtual ~Dtk_TextureInfos();
    friend class Dtk_SmartPtr<Dtk_TextureInfos>;
 
     inline virtual Dtk_Object* Clone() { return new Dtk_TextureInfos(*this); }
 
public:
    //! \brief Create a Dtk_TextureInfosPtr.
    //! \param  inType : Mapping type:
    //! Mapping type can be : 
    //! - StoredUVMapping : Using Dtk_Mesh UV texture coordinates, 
    //! - PlanarMapping / CylinderMapping / SphericalMapping / CubicalMapping : Applying standard mapping
    //! Coordinate (0, 0) represents top left corner of image.
    //! \return the constructed Dtk_TextureInfosPtr.
    static Dtk_TextureInfosPtr Create( const TextureMappingTypeEnum& inType );
 
     //! \CreateCopy{in}
    static Dtk_TextureInfosPtr Create( const Dtk_TextureInfos& in );
 
    //! \DtkDynamicType
    inline Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId)
    { 
        if (inId == _typeID) return 1; 
        return Dtk_Object::DtkDynamicType(inId); 
    }
 
    //! \DtkDynamicCast
    static Dtk_TextureInfos* DtkDynamicCast(Dtk_Object *s)
    { 
        if (s->DtkDynamicType(_typeID)) return static_cast<Dtk_TextureInfos*>(s); 
        return NULL; 
    } 
 
    //! \brief Returns U scale factor
    Dtk_Double64 GetUScale() const;
    
    //! \brief Returns V scale factor
    Dtk_Double64 GetVScale() const;
 
    //! \brief Returns U offset
    Dtk_Double64 GetUOffset() const;
    
    //! \brief Returns V offset
    Dtk_Double64 GetVOffset() const;
 
    //! \brief Returns image size
    Dtk_Double64 GetImageSize() const;
 
    //! \brief Returns rotate angle
    Dtk_Double64 GetRotateAngle() const;
 
    //! \brief Returns if U flipped
    Dtk_bool IsUFlipped() const;
    
    //! \brief Returns if V flipped
    Dtk_bool IsVFlipped() const;
 
    //! \brief Returns if texture is U repeat
    Dtk_bool IsURepeat() const;
 
    //! \brief Returns if texture is V repeat
    Dtk_bool IsVRepeat() const;
 
    //! \brief Return image path
    Dtk_string GetImagePath() const;
 
    //! \brief Returns Dtk_picture
    Dtk_picture *GetTextureImage() const;
 
    //! \brief Returns mapping type
    TextureMappingTypeEnum GetMappingType() const;
 
    //! \brief Returns texture transfo
    Dtk_transfoPtr GetTransfo() const;
 
    //! \brief Sets image U and V scale
    void SetScale(Dtk_Double64 inUScale,Dtk_Double64 inVScale);
    
    //! \brief Sets image U and V offset
    void SetOffset(Dtk_Double64 inUOffset,Dtk_Double64 inVOffset);
    
    //! \brief Sets image U and V flip
    void SetFlipFlag(Dtk_bool inUFlip,Dtk_bool inVFlip);
    
    //! \brief Sets image U and V flip
    void SetRepeat(Dtk_bool inURepeat, Dtk_bool inVRepeat);
 
    //! \brief Sets image size
    void SetImageSize(Dtk_Double64 inSize);
 
    //! \brief Sets image rotate angle
    void SetRotateAngle(Dtk_Double64 inAlpha);
    
    //! \brief Sets image file path
    void SetImagePath(Dtk_string inImagePath);
    
    //! \brief Sets Dtk_picture
    void SetTextureImage(Dtk_picture *inImage);
 
    //! \brief Sets image transfo
    void SetTransfo(Dtk_transfoPtr inTransfo);
};
/////////////////////////////////////////////////////////////////////////////
 
 
class Dtk_LightMap : public Dtk_Object
{
protected:
    enum { _typeID = DTK_TYPE_LIGHT }; 
    struct Dtk_Handle;
    std::unique_ptr<Dtk_Handle> _Private;
 
     //! \sa Create( Dtk_LightMap const& )
    Dtk_LightMap(const Dtk_LightMap& );
     Dtk_LightMap( Dtk_LightMap&& ) DTK_NOEXCEPT;
    //! \sa Create Dtk_LightMap
    Dtk_LightMap();
    
    Dtk_LightMap(Dtk_RGB inAmbient,Dtk_RGB inDiffuse, Dtk_RGB inSpecular);
    
    //! \BaseDestructor 
    virtual ~Dtk_LightMap();
    friend class Dtk_SmartPtr<Dtk_LightMap>;
 
     inline virtual Dtk_Object* Clone() { return new Dtk_LightMap(*this); }
 
 
public:
    //! \brief Create a Dtk_LightMapPtr.
    //! \param Ambient RGB color
    //! \param Diffuse RGB color
    //! \param Specular RGB color
    //! \return the constructed Dtk_LightMapPtr.
    static Dtk_LightMapPtr Create(Dtk_RGB inAmbiant,Dtk_RGB inDiffuse, Dtk_RGB inSpecular);
 
     //! \CreateCopy{in}
    static Dtk_LightMapPtr Create( Dtk_LightMap const& in );
 
 
    //! \DtkDynamicType
    inline Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId)
    { 
        if (inId == _typeID) return 1; 
        return Dtk_Object::DtkDynamicType(inId); 
    }
 
    //! \DtkDynamicCast
    static Dtk_LightMap* DtkDynamicCast(Dtk_Object *s)
    { 
        if (s->DtkDynamicType(_typeID)) return static_cast<Dtk_LightMap*>(s); 
        return NULL; 
    } 
 
    //! \brief Returns the ambient light emitted from the surface
    Dtk_RGB GetAmbientColor()const;  
    
    //! \brief Returns the ambient ratio
     //! \remark : Default ratio is 1.0
    Dtk_Double64 GetAmbientRatio()const;
    
    //! \brief Returns the ambient light diffusely reflected from the surface of this object
    Dtk_RGB GetDiffuseColor()const;
    
    //! \brief Returns the diffuse ratio
     //! \remark : Default ratio is 1.0 
    Dtk_Double64 GetDiffuseRatio()const;
 
    //! \brief Returns the ambient light specularly reflected from the surface of this object
    Dtk_RGB GetSpecularColor()const;
    
    //! \brief Returns the specular ratio 
     //! \remark : Default ratio is 1.0
    Dtk_Double64 GetSpecularRatio()const;
 
 
    //! \brief Returns the color and amount of a perfect mirror reflection
    Dtk_RGB GetReflectiveColor()const;
    
    //! \brief Returns the reflective ratio 
     //! \remark : Default ratio is 1.0
    Dtk_Double64 GetReflectiveRatio()const;
    
    //! \brief Returns the color and amount of perfectly refracted light
    Dtk_RGB GetTransparentColor()const;
    
    //! \brief Returns the transparent ratio 
     //! \remark : Default ratio is 0.0
    Dtk_Double64 GetTransparentRatio()const;
    
    //! \brief Returns the color and amount of light emitted from the surface of this object
    Dtk_RGB GetEmissiveColor()const;
    
     //! \brief Returns the emissive ratio 
     //! \remark : Default ratio is 1.0
     Dtk_Double64 GetEmissiveRatio()const;
 
     //! \brief Returns the Shininess ratio 
     Dtk_Double64 GetShininessRatio()const;
 
     //! \brief Set the Shininess ratio (0.0 - 1.0)
     void SetShininessRatio(Dtk_Double64 inShininess);
 
    //! \brief Adds the color and amount of a perfect mirror reflection
    void AddReflectiveColor(const Dtk_RGB &inColor);
    
    //! \brief Adds the color and amount of perfectly refracted light
    void AddTransparentColor(const Dtk_RGB &inColor);
 
     //! \brief Sets the ratio of transparency (0.0 : opaque, 1.0 : transparent)
     void SetTransparentRatio( Dtk_Double64 inRatio );
    
    //! \brief Adds the light emitted from the surface of this object
    void AddEmissiveColor(const Dtk_RGB &inColor);
 
};
/////////////////////////////////////////////////////////////////////////////
 
 
 
class Dtk_RenderInfos : public Dtk_Object
{
public:
     enum RenderMappingShaderTypeEnum
     {
          Unknown = 0,
          Default = 1,
          ArchitecturalAndDesign = 2,
          PolishedMetal = 3,
          SatinatedMetal = 4,
          BrushedMetal = 5,
          ClearGlass = 6,
          ColoredGlass = 7,
          FrostedGlass = 8,
          PolishedPlastic = 9,
          SoftPlastic = 10,
          Translucent = 11,
          MetallicPaint = 12,
          CarPaint = 13,
          SubsurfaceScattering = 14,
          Diffuse = 15
     };
protected:
    enum { _typeID = DTK_TYPE_RENDER }; 
    struct Dtk_Handle;
    std::unique_ptr<Dtk_Handle> _Private;
 
     //! \sa Create( Dtk_RenderInfos const& )
    Dtk_RenderInfos(const Dtk_RenderInfos& );
     Dtk_RenderInfos( Dtk_RenderInfos&& ) DTK_NOEXCEPT;
    //! \sa CreateDtk_LightMap
    Dtk_RenderInfos(const Dtk_string &inName,const Dtk_LightMapPtr &inLigths,const Dtk_TextureInfosPtr &inTexture);
 
    //! \BaseDestructor 
    virtual ~Dtk_RenderInfos();
    friend class Dtk_SmartPtr<Dtk_RenderInfos>;
 
     inline virtual Dtk_Object* Clone() { return new Dtk_RenderInfos(*this); }
 
 
public:
    //! \brief Creates a Dtk_RenderInfosPtr.
    //! \param[in] inName name.
    //! \return the constructed Dtk_RenderInfosPtr.
    static Dtk_RenderInfosPtr Create(const Dtk_string &inName);
    
    //! \brief Creates a Dtk_RenderInfosPtr.
    //! \param[in] inName name.
    //! \param[in] inLights light map.
    //! \param[in] inTexture texture.
    //! \return the constructed Dtk_RenderInfosPtr.
    static Dtk_RenderInfosPtr Create(const Dtk_string &inName,const Dtk_LightMapPtr &inLights,const Dtk_TextureInfosPtr &inTexture);
 
     //! \CreateCopy{in}
    static Dtk_RenderInfosPtr Create( Dtk_RenderInfos const& in );
 
 
 
    //! \DtkDynamicType
    inline Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId)
    { 
        if (inId == _typeID) return 1; 
        return Dtk_Object::DtkDynamicType(inId); 
    }
 
    //! \DtkDynamicCast
    static Dtk_RenderInfos* DtkDynamicCast(Dtk_Object *s)
    { 
        if (s->DtkDynamicType(_typeID)) return static_cast<Dtk_RenderInfos*>(s); 
        return NULL; 
    } 
 
    //! \brief Returns the texture name.
    Dtk_string GetName() const; 
 
     //! \brief Returns shader type.
     RenderMappingShaderTypeEnum GetShaderType()const;
    
    //! \brief Sets the render name.
    void SetName(const Dtk_string& inName);
 
     //! \brief Sets the render light map.
     void SetLightMap(const Dtk_LightMapPtr &inLights);
    
    //! \brief Sets the render texture information.
    void SetTexture(const Dtk_TextureInfosPtr &inTexture);
    
    //! \brief Returns the render light map.
    Dtk_LightMapPtr GetLightMap() const;
 
    //! \brief Returns the render texture.
    Dtk_TextureInfosPtr GetTexture() const;
 
    //! \brief Sets the render file path.
     void SetRenderFilePath(const Dtk_string& inFilePath);
     
    //! \brief Returns the render file path.
    Dtk_string GetRenderFilePath() const;
 
     //! \brief Adds the shader type.
     void AddShaderType( const RenderMappingShaderTypeEnum & inShaderType );
 
};
 
 
class Dtk_PhysicalMaterialInfos : public Dtk_Object
{
public:
 
     enum MaterialSymetryType
     {
          UnknownType = 0,
          Isotropic = 1,
          IsotropeTrans = 2,
          Orthotrope = 3
     };
 
protected:
     enum { _typeID = DTK_TYPE_MATERIAL_INFOS };
     struct Dtk_Handle;
     std::unique_ptr<Dtk_Handle> _Private;
 
     //! \sa Create( const Dtk_PhysicalMaterialInfos& )
     Dtk_PhysicalMaterialInfos(const Dtk_PhysicalMaterialInfos& );
 
     //! \sa Create Dtk_PhysicalMaterialInfos
     Dtk_PhysicalMaterialInfos( Dtk_string inName, MaterialSymetryType inType);
     Dtk_PhysicalMaterialInfos( Dtk_PhysicalMaterialInfos&& ) DTK_NOEXCEPT;
     //! \BaseDestructor 
     virtual ~Dtk_PhysicalMaterialInfos();
     friend class Dtk_SmartPtr<Dtk_PhysicalMaterialInfos>;
 
     inline virtual Dtk_Object* Clone() { return new Dtk_PhysicalMaterialInfos(*this); }
 
public:
 
     //! \brief Creates a Dtk_MaterialInfosPtr.
     //! \param[in] inName the desired name for the material.
     //! \param[in] inType the desired type for the material.
     //! \return the constructed Dtk_MaterialInfosPtr.
     static Dtk_PhysicalMaterialInfosPtr Create( Dtk_string inName, MaterialSymetryType inType);
 
     //! \CreateCopy{in}
     static Dtk_PhysicalMaterialInfosPtr Create( const Dtk_PhysicalMaterialInfos& in );
 
 
     //! \DtkDynamicType
     inline Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId)
     {
          if (inId == _typeID) return 1;
          return Dtk_Object::DtkDynamicType(inId);
     }
 
     //! \DtkDynamicCast
     static Dtk_PhysicalMaterialInfos* DtkDynamicCast(Dtk_Object *s)
     {
          if (s->DtkDynamicType(_typeID)) return static_cast<Dtk_PhysicalMaterialInfos*>(s);
          return NULL;
     }
 
     //! \brief Returns the material name.
     //! \return the material name as a Dtk_string.
     Dtk_string GetName() const;
 
     //! \brief Sets the material name.
     //! \param[in] inName : the desired name.
     //! \return dtkNoError.
     Dtk_ErrorStatus SetName( Dtk_string inName );
 
     //! \brief Returns the material type as a Dtk_string.
     //! \return the material type as a Dtk_string.
     Dtk_string GetTypeAsString() const;
 
     //! \brief Returns the material type.
     //! \return the material type.
     MaterialSymetryType GetType() const;
 
     //! \brief Sets the material type
     //! \param[in] inType : the desired type.
     //! \return dtkNoError.
     Dtk_ErrorStatus SetType( MaterialSymetryType inType );
 
     //! \brief Returns the material density
     //! \param[out] outValue : the density value.
     //! \param[out] outUnits : the density unit as a Dtk_string.
     //! \return dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.
     Dtk_ErrorStatus GetDensity(Dtk_Double64 &outValue, Dtk_string &outUnits) const;
 
     //! \brief Sets the material density.
     //! \param[in] inValue : the desired density value.
     //! \param[in] inUnits : the desired density unit as a Dtk_string.
     //! \return dtkNoError.
     Dtk_ErrorStatus SetDensity(Dtk_Double64 inValue, Dtk_string inUnits);
 
     //! \brief Returns the material thermal expansion.
     //! \param[out] outValue : the thermal expansion value.
     //! \param[out] outUnits : the thermal expansion unit as a Dtk_string.
     //! \return dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.
     Dtk_ErrorStatus GetThermalExpansion(Dtk_Double64 &outValue, Dtk_string &outUnits) const;
 
     //! \brief Sets the material thermal expansion.
     //! \param[in] inValue : the desired thermal expansion value.
     //! \param[in] inUnits : the desired thermal expansion unit as a Dtk_string.
     //! \return dtkNoError.
     Dtk_ErrorStatus SetThermalExpansion(Dtk_Double64 inValue, Dtk_string inUnits);
 
     //! \brief Returns the material thermal conductivity.
     //! \param[out] outValue : the thermal conductivity value.
     //! \param[out] outUnits : the thermal conductivity unit as a Dtk_string.
     //! \return dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.
     Dtk_ErrorStatus GetThermalConductivity(Dtk_Double64 &outValue, Dtk_string &outUnits) const;
 
     //! \brief Sets the material thermal conductivity.
     //! \param[in] inValue : the desired thermal conductivity value.
     //! \param[in] inUnits : the desired thermal conductivity unit as a Dtk_string.
     //! \return dtkNoError.
     Dtk_ErrorStatus SetThermalConductivity(Dtk_Double64 inValue, Dtk_string inUnits);
 
 
     //! \brief Returns the material yield strength.
     //! \param[out] outValue : the yield strength value.
     //! \param[out] outUnits : the yield strength unit as a Dtk_string.
     //! \return dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.
     Dtk_ErrorStatus GetYieldStrength(Dtk_Double64 &outValue, Dtk_string &outUnits) const;
 
     //! \brief Sets the material yield strength.
     //! \param[in] inValue : the desired yield strength value.
     //! \param[in] inUnits : the desired yield strength unit as a Dtk_string.
     //! \return dtkNoError.
     Dtk_ErrorStatus SetYieldStrength(Dtk_Double64 inValue, Dtk_string inUnits);
 
     //! \brief Returns the material specific heat.
     //! \param[out] outValue : the specific heat value.
     //! \param[out] outUnits : the specific heat unit as a Dtk_string.
     //! \return dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.
     Dtk_ErrorStatus GetSpecificHeat(Dtk_Double64 &outValue, Dtk_string &outUnits) const;
 
     //! \brief Sets the material specific heat.
     //! \param[in] inValue : the desired specific heat value.
     //! \param[in] inUnits : the desired specific heat unit as a Dtk_string.
     //! \return dtkNoError.
     Dtk_ErrorStatus SetSpecificHeat(Dtk_Double64 inValue, Dtk_string inUnits);
 
     //! \brief Returns the material tensile strength.
     //! \param[out] outValue : the tensile strength value.
     //! \param[out] outUnits : the tensile strength unit as a Dtk_string.
     //! \return dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.
     Dtk_ErrorStatus GetTensileStrength(Dtk_Double64 &outValue, Dtk_string &outUnits) const;
 
     //! \brief Sets the material tensile strength.
     //! \param[in] inValue : the desired specific heat value.
     //! \param[in] inUnits : the desired specific heat unit as a Dtk_string.
     //! \return dtkNoError.
     Dtk_ErrorStatus SetTensileStrength(Dtk_Double64 inValue, Dtk_string inUnits);
 
 
     //! \brief Returns the material young modulus.
     //! \param[out] outYoungModulus : the young modulus values.
     //! \param[out] outUnits : the tensile strength unit as a Dtk_string.
     //! \return dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.
     Dtk_ErrorStatus GetYoungModulus(Dtk_Double64 outYoungModulus[3], Dtk_string &outUnits ) const;
 
     //! \brief Sets the material young modulus.
     //! \param[in] inYoungModulus : the desired young modulus values.
     //! \param[in] inUnits : the desired young modulus unit as a Dtk_string.
     //! \return dtkNoError.
     Dtk_ErrorStatus SetYoungModulus(Dtk_Double64 inYoungModulus[3], Dtk_string inUnits );
 
     //! \brief Returns the material shear modulus
     //! \param[out] outShearModulus : the shear modulus values.
     //! \param[out] outUnits : the shear modulus unit as a Dtk_string.
     //! \return dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.
     Dtk_ErrorStatus GetShearModulus(Dtk_Double64 outShearModulus[3], Dtk_string &outUnits) const;
 
     //! \brief Sets the material shear modulus.
     //! \param[in] inShearModulus : the desired shear modulus values.
     //! \param[in] inUnits : the desired shear modulus unit as a Dtk_string.
     //! \return dtkNoError.
     Dtk_ErrorStatus SetShearModulus(Dtk_Double64 inShearModulus[3], Dtk_string inUnits);
 
     //! \brief Returns the material poisson ratio.
     //! \param[out] outShearModulus : the poisson ratio values.
     //! \return dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.
     Dtk_ErrorStatus GetPoissonRatio(Dtk_Double64 outPoissonRatio[3]) const;
 
     //! \brief Sets the material poisson ratio.
     //! \param[in] inPoissonRatio : the desired poisson ratio values.
     //! \return dtkNoError.
     Dtk_ErrorStatus SetPoissonRatio(Dtk_Double64 inPoissonRatio[3]);
 
     //! \brief Returns the material hardening ratio.
     //! \param[out] ouHardeningRatio : the hardening ratio values.
     //! \return dtkErrorNotProcessed if not applicable, dtkNoError if value is correctly returned.
     Dtk_ErrorStatus GetHardeningRatio(Dtk_Double64 ouHardeningRatio[3]) const;
 
     //! \brief Sets the material hardening ratio.
     //! \param[in] inHardeningRatio : the desired hardening ratio values.
     //! \return dtkNoError.
     Dtk_ErrorStatus SetHardeningRatio(Dtk_Double64 inHardeningRatio[3]);
 
     //! \brief Sets the material custom data.
     //! \param[in] inCustomData : the custom data as Dtk_tab<Dtk_MetaDataPtr>.
     //! \return dtkNoError.
     Dtk_ErrorStatus SetCustomData( Dtk_tab<Dtk_MetaDataPtr> inCustomData );
 
     //! \brief Returns the material custom data.
     //! \return the custom data as Dtk_tab<Dtk_MetaDataPtr>.
     Dtk_tab<Dtk_MetaDataPtr> const & GetCustomData() const;
 
};
 
 
#endif