GiMapperItem.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, 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 Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
// Mapper item.
 
#ifndef __ODGIMAPPERITEM_H__
#define __ODGIMAPPERITEM_H__
 
#include "GiExport.h"
#include "GiMaterial.h"
#include "GiMaterialTraitsData.h"
#include "GiGeometry.h"
 
#include "Ge/GePoint2d.h"
#include "Ge/GePoint3d.h"
#include "Ge/GeMatrix3d.h"
#include "Ge/GeExtents3d.h"
 
#include "RxObject.h"
 
#include "TD_PackPush.h"
 
class ODGI_EXPORT OdGiMapperItemEntry : public OdRxObject
{
  public:
    struct MapInputTriangle {
      OdGePoint3d inPt[3]; // Mapping xyz
    };
    struct MapOutputCoords {
      OdGePoint2d outCoord[3]; // Mapped uv
    };
  public:
    ODRX_DECLARE_MEMBERS(OdGiMapperItemEntry);
 
    virtual const OdGiMapper &mapper() const = 0;
    virtual void setMapper(const OdGiMapper &pMapper, const OdGiMapper &pInheritMapper) = 0;
    virtual void setMapper(const OdGiMapper &pMapper, const OdGiMapper &pInheritMapper, const OdGeMatrix3d &tm) = 0;
    virtual void setMapper(const OdGiMapper &pMaterialMapper) = 0;
    virtual void setMapper(const OdGiMapper &pMaterialMapper, const OdGeMatrix3d &tm) = 0;
 
    virtual const OdGeMatrix3d &inputTransform() const = 0;
    virtual void setInputTransform(const OdGeMatrix3d &tm) = 0;
 
    virtual const OdGeMatrix3d &deviceTransform() const = 0;
    virtual void setDeviceTransform(const OdGeMatrix3d &dtm) = 0;
 
    virtual const OdGeMatrix3d &modelTransform() const = 0;
    virtual void setModelTransform(const OdGeMatrix3d &mtm) = 0;
 
    virtual const OdGeMatrix3d &objectTransform() const = 0;
    virtual void setObjectTransform(const OdGeMatrix3d &otm) = 0;
 
    virtual const OdGeMatrix3d &outputTransform() const = 0;
    virtual void setOutputTransform(const OdGeMatrix3d &tm) = 0;
 
    virtual void recomputeTransformations() = 0;
 
    virtual void mapCoords(const MapInputTriangle &trg, MapOutputCoords &uv) const = 0;
    virtual void mapCoords(const OdGePoint3d *trg, OdGePoint2d *uv) const = 0;
    virtual void mapCoords(const double *trg, double *uv) const = 0;
    virtual void mapCoords(const MapInputTriangle &trg, const OdGeVector3d &normal, MapOutputCoords &uv) const = 0;
    virtual void mapCoords(const OdGePoint3d *trg, const OdGeVector3d &normal, OdGePoint2d *uv) const = 0;
    virtual void mapCoords(const double *trg, const double *normal, double *uv) const = 0;
 
    // Shell mapping extensions for 3.4
 
    enum MappingIteratorType
    {
      kShellMapIt = 0, // Shell-style iterator
      kTriListMapIt, // Triangles list { { 0, 1, 2 }, { 1, 2, 3 } }
      kPolyIt // Simple list of indices (probably shell/mesh face, polygon or unstructured data)
      // kTriListMapIt makes subdividing of vertices without indices on triangles. Set kShellMapIt or
      // kPolyIt if input data doesn't stored as triangles list.
    };
 
    virtual void mapCoords(OdUInt32 nVerts, const OdGePoint3d *pVerts, OdGePoint2d *pUV,
                           OdUInt32 nList = 0, const OdInt32 *pIds = NULL, MappingIteratorType mapIt = kTriListMapIt,
                           const OdGeVector3d *pNormal = NULL, const OdGeVector3d *pFaceNormals = NULL,
                           const OdGeVector3d *pVertNormals = NULL, OdGiOrientationType oType = kOdGiNoOrientation) = 0;
 
    // Predefined coordinates extensions
 
    virtual void mapPredefinedCoords(const OdGePoint3d *pInUVW, OdGePoint2d *pOutUV, OdUInt32 nPoints) const = 0;
 
    //
 
    virtual bool isEntityMapper() const = 0;
    virtual bool isObjectMatrixNeed() const = 0;
    virtual bool isModelMatrixNeed() const = 0;
    virtual bool isDependsFromObjectMatrix() const = 0;
    virtual bool isVertexTransformRequired() const = 0;
 
    virtual void setVertexTransform(OdInt32 nCount, const OdGePoint3d *pPoints) = 0;
    virtual void setVertexTransform(const OdGeExtents3d &exts) = 0;
    virtual void setObjectTransform(OdInt32 nCount, const OdGePoint3d *pPoints) = 0;
    virtual void setObjectTransform(const OdGeExtents3d &exts) = 0;
};
 
typedef OdSmartPtr<OdGiMapperItemEntry> OdGiMapperItemEntryPtr;
 
class ODGI_EXPORT OdGiMapperItem : public OdRxObject
{
  public:
    ODRX_DECLARE_MEMBERS(OdGiMapperItem);
 
    virtual void setDiffuseMapper(const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setDiffuseMapper(const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual void setDiffuseMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setDiffuseMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual OdGiMapperItemEntryPtr diffuseMapper() const = 0;
    virtual OdGiMapperItemEntryPtr diffuseMapper() = 0;
 
    virtual void setMapper(const OdGiMaterialTraitsData &traitsData, const OdDbStub *pMaterial = NULL) = 0;
    virtual void setMapper(const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm, const OdDbStub *pMaterial = NULL) = 0;
    virtual void setMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdDbStub *pMaterial = NULL) = 0;
    virtual void setMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm, const OdDbStub *pMaterial = NULL) = 0;
 
    virtual void setModelTransform(const OdGeMatrix3d &mtm, bool recomputeTransforms = true) = 0;
 
    virtual void setObjectTransform(const OdGeMatrix3d &otm, bool recomputeTransforms = true) = 0;
    virtual void setObjectTransform(OdInt32 nCount, const OdGePoint3d *pPoints, bool recomputeTransforms = true) = 0;
    virtual void setObjectTransform(const OdGeExtents3d &exts, bool recomputeTransforms = true) = 0;
 
    virtual void setDeviceTransform(const OdGeMatrix3d &dtm, bool recomputeTransforms = true) = 0;
 
    virtual bool isLastProcValid(const OdDbStub *pMaterial) = 0;
    virtual bool isLastProcValid(const OdDbStub *pMaterial, const OdGeMatrix3d &tm) = 0;
    virtual bool isLastProcValid(const OdGiMapper *pMapper, const OdDbStub *pMaterial) = 0;
    virtual bool isLastProcValid(const OdGiMapper *pMapper, const OdDbStub *pMaterial, const OdGeMatrix3d &tm) = 0;
    virtual bool isLastProcValid(const OdGeMatrix3d &tm) = 0;
 
    virtual bool isEntityMapper() const = 0;
    virtual bool isObjectMatrixNeed() const = 0;
    virtual bool isModelMatrixNeed() const = 0;
    virtual bool isDependsFromObjectMatrix() const = 0;
    virtual bool isVertexTransformRequired() const = 0;
 
    virtual void setVertexTransform(OdInt32 nCount, const OdGePoint3d *pPoints) = 0;
    virtual void setVertexTransform(const OdGeExtents3d &exts) = 0;
 
    virtual void setInputTransform(const OdGeMatrix3d &tm, bool bVertexDependantOnly = true) = 0;
};
 
typedef OdSmartPtr<OdGiMapperItem> OdGiMapperItemPtr;
 
class ODGI_EXPORT OdGiMapperRenderItem : public OdGiMapperItem
{
  public:
    ODRX_DECLARE_MEMBERS(OdGiMapperRenderItem);
 
    virtual void setDiffuseMapper(const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setDiffuseMapper(const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual void setDiffuseMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setDiffuseMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual OdGiMapperItemEntryPtr diffuseMapper() const = 0;
    virtual OdGiMapperItemEntryPtr diffuseMapper() = 0;
 
    virtual void setSpecularMapper(const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setSpecularMapper(const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual void setSpecularMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setSpecularMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual OdGiMapperItemEntryPtr specularMapper() const = 0;
    virtual OdGiMapperItemEntryPtr specularMapper() = 0;
 
    virtual void setReflectionMapper(const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setReflectionMapper(const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual void setReflectionMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setReflectionMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual OdGiMapperItemEntryPtr reflectionMapper() const = 0;
    virtual OdGiMapperItemEntryPtr reflectionMapper() = 0;
 
    virtual void setOpacityMapper(const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setOpacityMapper(const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual void setOpacityMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setOpacityMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual OdGiMapperItemEntryPtr opacityMapper() const = 0;
    virtual OdGiMapperItemEntryPtr opacityMapper() = 0;
 
    virtual void setBumpMapper(const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setBumpMapper(const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual void setBumpMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setBumpMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual OdGiMapperItemEntryPtr bumpMapper() const = 0;
    virtual OdGiMapperItemEntryPtr bumpMapper() = 0;
 
    virtual void setRefractionMapper(const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setRefractionMapper(const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual void setRefractionMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setRefractionMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual OdGiMapperItemEntryPtr refractionMapper() const = 0;
    virtual OdGiMapperItemEntryPtr refractionMapper() = 0;
 
    virtual void setNormalMapMapper(const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setNormalMapMapper(const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual void setNormalMapMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setNormalMapMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual OdGiMapperItemEntryPtr normalMapMapper() const = 0;
    virtual OdGiMapperItemEntryPtr normalMapMapper() = 0;
 
    virtual void setEmissionMapper(const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setEmissionMapper(const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual void setEmissionMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData) = 0;
    virtual void setEmissionMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm) = 0;
    virtual OdGiMapperItemEntryPtr emissionMapper() const = 0;
    virtual OdGiMapperItemEntryPtr emissionMapper() = 0;
 
    virtual void setMapper(const OdGiMaterialTraitsData &traitsData, const OdDbStub *pMaterial = NULL) = 0;
    virtual void setMapper(const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdDbStub *pMaterial = NULL) = 0;
 
    virtual void setModelTransform(const OdGeMatrix3d &mtm, bool recomputeTransforms = true) = 0;
 
    virtual void setObjectTransform(const OdGeMatrix3d &otm, bool recomputeTransforms = true) = 0;
    virtual void setObjectTransform(OdInt32 nCount, const OdGePoint3d *pPoints, bool recomputeTransforms = true) = 0;
    virtual void setObjectTransform(const OdGeExtents3d &exts, bool recomputeTransforms = true) = 0;
 
    virtual void setDeviceTransform(const OdGeMatrix3d &dtm, bool recomputeTransforms = true) = 0;
 
    virtual bool isLastProcValid(const OdDbStub *pMaterial) = 0;
    virtual bool isLastProcValid(const OdDbStub *pMaterial, const OdGeMatrix3d &tm) = 0;
    virtual bool isLastProcValid(const OdGiMapper *pMapper, const OdDbStub *pMaterial) = 0;
    virtual bool isLastProcValid(const OdGiMapper *pMapper, const OdDbStub *pMaterial, const OdGeMatrix3d &tm) = 0;
    virtual bool isLastProcValid(const OdGeMatrix3d &tm) = 0;
 
    virtual bool isEntityMapper() const = 0;
    virtual bool isObjectMatrixNeed() const = 0;
    virtual bool isModelMatrixNeed() const = 0;
    virtual bool isDependsFromObjectMatrix() const = 0;
    virtual bool isVertexTransformRequired() const = 0;
 
    virtual void setVertexTransform(OdInt32 nCount, const OdGePoint3d *pPoints) = 0;
    virtual void setVertexTransform(const OdGeExtents3d &exts) = 0;
 
    virtual void setInputTransform(const OdGeMatrix3d &tm, bool bVertexDependantOnly = true) = 0;
};
 
typedef OdSmartPtr<OdGiMapperRenderItem> OdGiMapperRenderItemPtr;
 
#include "TD_PackPop.h"
 
#endif // __ODGIMAPPERITEM_H__