GiMaterialItem.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
// Material data entry for Gs material cache and textures processing.
 
#ifndef __ODGIMATERIALITEM_H__
#define __ODGIMATERIALITEM_H__
 
#include "GiExport.h"
#include "GiImage.h"
#include "GiMaterial.h"
#include "GiCommonDraw.h"
 
#include "RxObject.h"
 
#include "TD_PackPush.h"
 
class OdDbStub;

class ODGI_EXPORT OdGiMaterialTextureData : public OdRxObject
{
  public:
    // Simple variant type for external device information

    struct DevDataVariant
    {
      enum DevDataVariantType
      {
        DevDataVariantType_Void = 0,
        DevDataVariantType_Ptr,
        DevDataVariantType_RxObject
      };

      DevDataVariant() : m_ddvType(DevDataVariantType_Void), m_pVoid(NULL)
      {
      }
      
      DevDataVariant(void *ptr) : m_ddvType(DevDataVariantType_Ptr), m_pVoid(ptr)
      {
        if (m_pVoid == NULL)
          m_ddvType = DevDataVariantType_Void;
      }
      
      DevDataVariant(OdRxObjectPtr ptr) : m_ddvType(DevDataVariantType_RxObject), m_pVoid(NULL)
      {
        m_pRxObject = ptr;
      }

      DevDataVariantType type() const
      {
        return m_ddvType;
      }
      
      void *getPtr() const
      {
        return m_pVoid;
      }
      
      OdRxObjectPtr getRxObject() const
      {
        return m_pRxObject;
      }

      DevDataVariant &operator =(void *ptr)
      {
        return setPtr(ptr);
      }
      
      DevDataVariant &operator =(OdRxObjectPtr ptr)
      {
        return setRxObject(ptr);
      }

      DevDataVariant &setPtr(void *ptr)
      {
        clear();
        if (ptr != NULL)
        {
          m_ddvType = DevDataVariantType_Ptr;
          m_pVoid = ptr;
        }
        return *this;
      }
      
      DevDataVariant &setRxObject(OdRxObjectPtr ptr)
      {
        clear();
        m_ddvType = DevDataVariantType_RxObject;
        m_pRxObject = ptr;
        return *this;
      }

      void clear()
      {
        m_ddvType = DevDataVariantType_Void;
        m_pVoid = NULL;
        if (m_pRxObject.isNull())
          m_pRxObject.release();
      }
 
    protected:
      DevDataVariantType m_ddvType;
      void *m_pVoid;
      OdRxObjectPtr m_pRxObject;
    };
 
  public:
    ODRX_DECLARE_MEMBERS(OdGiMaterialTextureData);
    friend class OdGiModuleObject;
    
    virtual void textureDataUnlinked(bool bReason = false) { }

    virtual void setTextureData(OdGiMaterialTextureData::DevDataVariant pDeviceInfo, const OdGiImageBGRA32 &image) = 0;
    virtual void textureData(OdGiPixelBGRA32Array &data, OdUInt32 &width, OdUInt32 &height) const = 0;
    
    virtual bool haveData() const = 0;

    static OdSmartPtr<OdGiMaterialTextureData> createDefaultTextureDataImplementation();
    static OdRxClass *defaultTextureDataImplementationDesc();
 
  private:
    static void rxInitDefaultTextureDataImplementation();
    static void rxUninitDefaultTextureDataImplementation();
};

typedef OdSmartPtr<OdGiMaterialTextureData> OdGiMaterialTextureDataPtr;

class ODGI_EXPORT OdGiMaterialTextureLoadPE : public OdRxObject
{
  public:
    ODRX_DECLARE_MEMBERS(OdGiMaterialTextureLoadPE);

    OdGiMaterialTextureLoadPE();

    virtual void startTextureLoading(OdString &fileName, OdDbBaseDatabase* pDb) = 0;

    virtual void textureLoaded(const OdString &fileName, OdDbBaseDatabase* pDb) = 0;
    virtual void textureLoadingFailed(const OdString &fileName, OdDbBaseDatabase* pDb) = 0;
};

typedef OdSmartPtr<OdGiMaterialTextureLoadPE> OdGiMaterialTextureLoadPEPtr;
 
class OdGiMaterialTextureEntry;

class ODGI_EXPORT OdGiMaterialTextureLoaderExt : public OdRxObject
{
  public:
    ODRX_DECLARE_MEMBERS(OdGiMaterialTextureLoaderExt);

    virtual bool allowTextureLoading(OdGiMaterialTexturePtr pTexture) = 0;

    virtual OdGiMaterialTextureDataPtr loadTexture(OdGiMaterialTextureData::DevDataVariant pDeviceInfo, OdRxClass *pTexDataImpl, const OdGiContext &giCtx, OdGiMaterialTextureEntry *pEntry, OdGiMaterialTexturePtr pTexture) = 0;
};

typedef OdSmartPtr<OdGiMaterialTextureLoaderExt> OdGiMaterialTextureLoaderExtPtr;

class ODGI_EXPORT OdGiMaterialTextureManager : public OdRxObject
{
  public:
    ODRX_DECLARE_MEMBERS(OdGiMaterialTextureManager);

    enum ManageType
    {
      kFileTexturesOnly = 0, // @def
      kFileAndProceduralTextures, // not efficient for search
      kDisable // only loading from LoaderExt will be active
    };

    virtual void setManageType(ManageType type) = 0;
    virtual ManageType manageType() const = 0;

    virtual void setMaterialLoaderExt(OdGiMaterialTextureLoaderExt *pExt) = 0;
    virtual OdGiMaterialTextureLoaderExtPtr materialLoaderExt() const = 0;

    virtual OdGiMaterialTextureDataPtr searchTexture(const OdGiMaterialMap &matMap) = 0;
    virtual OdGiMaterialTextureDataPtr searchTexture(OdGiMaterialTexturePtr pTexture) = 0;
    virtual OdGiMaterialTextureDataPtr searchTexture(const OdString &fileName) = 0;

    virtual OdGiMaterialTextureDataPtr tryToLoad(OdGiMaterialTextureData::DevDataVariant pDeviceInfo, OdRxClass *pTexDataImpl, const OdGiContext &giCtx, OdGiMaterialTextureEntry *pEntry, const OdGiMaterialMap &matMap) = 0;
    virtual OdGiMaterialTextureDataPtr tryToLoad(OdGiMaterialTextureData::DevDataVariant pDeviceInfo, OdRxClass *pTexDataImpl, const OdGiContext &giCtx, OdGiMaterialTextureEntry *pEntry, OdGiMaterialTexturePtr pTexture) = 0;
    virtual OdGiMaterialTextureDataPtr tryToLoad(OdGiMaterialTextureData::DevDataVariant pDeviceInfo, OdRxClass *pTexDataImpl, const OdGiContext &giCtx, OdGiMaterialTextureEntry *pEntry, const OdString &fileName) = 0;

    virtual void linkTexture(const OdGiMaterialMap &matMap, OdGiMaterialTextureDataPtr pData) = 0;
    virtual void linkTexture(OdGiMaterialTexturePtr pTexture, OdGiMaterialTextureDataPtr pData) = 0;
    virtual void linkTexture(const OdString &fileName, OdGiMaterialTextureDataPtr pData) = 0;

    virtual bool isAvailable(const OdGiMaterialTextureData *pData) const = 0;

    virtual bool unlinkTexture(OdGiMaterialTextureData *pData) = 0;

    virtual void clear() = 0;

    virtual OdUInt32 numTextureEntries() const = 0;

    virtual OdGiMaterialTexturePtr textureEntryKey(OdUInt32 nIndex) const = 0;

    virtual OdGiMaterialTextureDataPtr textureEntryData(OdUInt32 nIndex) const = 0;
};

typedef OdSmartPtr<OdGiMaterialTextureManager> OdGiMaterialTextureManagerPtr;

class ODGI_EXPORT OdGiMaterialTextureEntry : public OdRxObject
{
  public:
    ODRX_DECLARE_MEMBERS(OdGiMaterialTextureEntry);

    virtual OdGiMaterialTextureDataPtr textureData() const = 0;
    virtual bool isTextureInitialized() const = 0;

    virtual OdUInt32 proceduralTextureWidth() const = 0;
    virtual void setProceduralTextureWidth(OdUInt32 width) = 0;
    virtual OdUInt32 proceduralTextureHeight() const = 0;
    virtual void setProceduralTextureHeight(OdUInt32 height) = 0;
    virtual void setProceduralTextureResolution(OdUInt32 width, OdUInt32 height) = 0;
    
    virtual double proceduralTextureQuality() const = 0;
    virtual void setProceduralTextureQuality(double coef) = 0;

    virtual bool setGiMaterialTexture(OdGiMaterialTextureData::DevDataVariant pDeviceInfo, OdRxClass *pTexDataImpl, const OdGiContext &giCtx, const OdGiMaterialMap &matMap, OdGiMaterialTextureManager *pManager = NULL) = 0;

    virtual bool setGiMaterialTexture(OdGiMaterialTextureData::DevDataVariant pDeviceInfo, OdRxClass *pTexDataImpl, const OdGiContext &giCtx, OdGiMaterialTexturePtr pTexture, OdGiMaterialTextureManager *pManager = NULL) = 0;
    // Load texture from raster file
    virtual bool setGiMaterialTexture(OdGiMaterialTextureData::DevDataVariant pDeviceInfo, OdRxClass *pTexDataImpl, const OdGiContext &giCtx, const OdString &fileName, OdGiMaterialTextureManager *pManager = NULL) = 0;
    virtual bool setGiMaterialTexture(OdGiMaterialTextureData::DevDataVariant pDeviceInfo, OdRxClass *pTexDataImpl, const OdGiContext &giCtx, double opacity, OdGiMaterialTextureManager *pManager = NULL) = 0;

    virtual void setTextureData(OdGiMaterialTextureData *pTextureData, OdGiMaterialTextureManager *pManager = NULL) = 0;
};

typedef OdSmartPtr<OdGiMaterialTextureEntry> OdGiMaterialTextureEntryPtr;

class ODGI_EXPORT OdGiMaterialItem : public OdRxObject
{
  public:
    ODRX_DECLARE_MEMBERS(OdGiMaterialItem);

    virtual OdGiMaterialTextureEntryPtr diffuseTexture() const = 0;
    virtual OdGiMaterialTextureEntryPtr diffuseTexture() = 0;
    virtual OdGiMaterialTextureEntryPtr createDiffuseTexture() = 0;
    virtual void removeDiffuseTexture() = 0;
    virtual bool haveDiffuseTexture() const = 0;

    virtual OdUInt32 checkTexturesEnabled(const char *pOrder = nullptr, bool bCheckAny = true) const = 0;
 
    // Container data

    virtual OdRxObjectPtr cachedData() const = 0;
    virtual void setCachedData(OdRxObjectPtr data) = 0;

    virtual const OdDbStub *materialId() const = 0;
    virtual void setMaterialId(const OdDbStub *matId = NULL) = 0;
    virtual bool isMaterialIdValid(const OdDbStub *matId) = 0;
};

typedef OdSmartPtr<OdGiMaterialItem> OdGiMaterialItemPtr;

class ODGI_EXPORT OdGiMaterialRenderItem : public OdGiMaterialItem
{
  public:
    ODRX_DECLARE_MEMBERS(OdGiMaterialRenderItem);

    virtual OdGiMaterialTextureEntryPtr specularTexture() const = 0;
    virtual OdGiMaterialTextureEntryPtr specularTexture() = 0;
    virtual OdGiMaterialTextureEntryPtr createSpecularTexture() = 0;
    virtual void removeSpecularTexture() = 0;
    virtual bool haveSpecularTexture() const = 0;

    virtual OdGiMaterialTextureEntryPtr reflectionTexture() const = 0;
    virtual OdGiMaterialTextureEntryPtr reflectionTexture() = 0;
    virtual OdGiMaterialTextureEntryPtr createReflectionTexture() = 0;
    virtual void removeReflectionTexture() = 0;
    virtual bool haveReflectionTexture() const = 0;

    virtual OdGiMaterialTextureEntryPtr opacityTexture() const = 0;
    virtual OdGiMaterialTextureEntryPtr opacityTexture() = 0;
    virtual OdGiMaterialTextureEntryPtr createOpacityTexture() = 0;
    virtual void removeOpacityTexture() = 0;
    virtual bool haveOpacityTexture() const = 0;

    virtual OdGiMaterialTextureEntryPtr bumpTexture() const = 0;
    virtual OdGiMaterialTextureEntryPtr bumpTexture() = 0;
    virtual OdGiMaterialTextureEntryPtr createBumpTexture() = 0;
    virtual void removeBumpTexture() = 0;
    virtual bool haveBumpTexture() const = 0;

    virtual OdGiMaterialTextureEntryPtr refractionTexture() const = 0;
    virtual OdGiMaterialTextureEntryPtr refractionTexture() = 0;
    virtual OdGiMaterialTextureEntryPtr createRefractionTexture() = 0;
    virtual void removeRefractionTexture() = 0;
    virtual bool haveRefractionTexture() const = 0;

    virtual OdGiMaterialTextureEntryPtr normalMapTexture() const = 0;
    virtual OdGiMaterialTextureEntryPtr normalMapTexture() = 0;
    virtual OdGiMaterialTextureEntryPtr createNormalMapTexture() = 0;
    virtual void removeNormalMapTexture() = 0;
    virtual bool haveNormalMapTexture() const = 0;

    virtual OdGiMaterialTextureEntryPtr emissionTexture() const = 0;
    virtual OdGiMaterialTextureEntryPtr emissionTexture() = 0;
    virtual OdGiMaterialTextureEntryPtr createEmissionTexture() = 0;
    virtual void removeEmissionTexture() = 0;
    virtual bool haveEmissionTexture() const = 0;

    virtual OdGiMaterialTextureEntryPtr roughnessTexture() const = 0;
    virtual OdGiMaterialTextureEntryPtr roughnessTexture() = 0;
    virtual OdGiMaterialTextureEntryPtr createRoughnessTexture() = 0;
    virtual void removeRoughnessTexture() = 0;
    virtual bool haveRoughnessTexture() const = 0;

    virtual OdGiMaterialTextureEntryPtr cutoutsTexture() const = 0;
    virtual OdGiMaterialTextureEntryPtr cutoutsTexture() = 0;
    virtual OdGiMaterialTextureEntryPtr createCutoutsTexture() = 0;
    virtual void removeCutoutsTexture() = 0;
    virtual bool haveCutoutsTexture() const = 0;

    virtual OdGiMaterialTextureEntryPtr environmentTexture() const = 0;
    virtual OdGiMaterialTextureEntryPtr environmentTexture() = 0;
    virtual OdGiMaterialTextureEntryPtr createEnvironmentTexture() = 0;
    virtual void removeEnvironmentTexture() = 0;
    virtual bool haveEnvironmentTexture() const = 0;
};

typedef OdSmartPtr<OdGiMaterialRenderItem> OdGiMaterialRenderItemPtr;
 
#include "TD_PackPop.h"
 
#endif // __ODGIMATERIALITEM_H__