FxBIMMaterial.h

Go to the documentation of this file.

//
// (C) Copyright 2020-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "FxBIM.h"
#include "FxBIMDatabase.h"
 
#include <StringArray.h>
#include <DbMaterial.h>
 
class CFxBIMMaterialImpl;
class CFxMaterialLayerSetImpl;
 
class CFxBIMMaterial;
typedef OdSmartPtr< CFxBIMMaterial > CFxBIMMaterialPtr;
 
class FXBIM_COMMON_CODE_API CFxBIMMaterial : public OdDbMaterial
{
    friend class CFxBIMMaterialImpl;
public:
    ODDB_DECLARE_MEMBERS( CFxBIMMaterial );
 
    virtual ~CFxBIMMaterial();
 
    virtual bool IsEqual( CFxBIMMaterialPtr p ) const;
    virtual bool IsSame( CFxBIMMaterialPtr p ) const;
 
    virtual OdString Name() const;
    virtual OdResult SetName( const OdString& name );
 
    virtual const OdString& MappedName() const;
    virtual void SetMappedName( const OdString& mappedName );
 
    enum class MaterialType
    {
        eBasic,
        eLayer
    };
 
    virtual MaterialType GetMaterialType();
 
    // HATCH
 
    static OdStringArray PatternList( OdDb::MeasurementValue measurement );
 
    enum class PatternType
    {
        eHatch,
        eCustom
    };
 
    virtual PatternType CutPatternType() const;
    virtual void SetCutPatternType( PatternType type );
 
    virtual const OdString& CutPatternName() const;
    virtual void SetCutPatternName( const OdString& patternName );
 
    virtual double CutPatternScale() const;
    virtual void SetCutPatternScale( double patternScale );
 
    virtual bool CutPatternScaleWithViewPort() const;
    virtual void SetCutPatternScaleWithViewPort( bool ScaleWithViewport );
 
    virtual double CutPatternRotation() const;
    virtual void SetCutPatternRotation( double angle );
 
    virtual bool CutPatternRotationRelativeToElementBaseline() const;
    virtual void SetCutPatternRotationRelativeToElementBaseline( bool RotationRelativeToElementBaseline );
 
    virtual OdDb::LineWeight CutPatternLineweight() const;
    virtual void SetCutPatternLineweight( OdDb::LineWeight lineweight );
 
    virtual OdCmColor CutPatternColor() const;
    virtual void SetCutPatternColor( OdCmColor color );
 
    virtual PatternType SurfacePatternType() const;
    virtual void SetSurfacePatternType( PatternType type );
 
    virtual const OdString& SurfacePatternName() const;
    virtual void SetSurfacePatternName( const OdString& patternName );
 
    virtual double SurfacePatternScale() const;
    virtual void SetSurfacePatternScale( double patternScale );
 
    virtual bool SurfacePatternScaleWithViewPort() const;
    virtual void SetSurfacePatternScaleWithViewPort( bool ScaleWithViewport );
 
    virtual double SurfacePatternRotation() const;
    virtual void SetSurfacePatternRotation( double angle );
 
    virtual bool SurfacePatternRotationRelativeToElementBaseline() const;
    virtual void SetSurfacePatternRotationRelativeToElementBaseline( bool RotationRelativeToElementBaseline );
 
    virtual OdDb::LineWeight SurfacePatternLineweight() const;
    virtual void SetSurfacePatternLineweight( OdDb::LineWeight lineweight );
 
    virtual OdCmColor SurfacePatternColor() const;
    virtual void SetSurfacePatternColor( OdCmColor color );
 
    // BOUNDARY
 
    virtual bool CutBoundaryUnify() const;
    virtual void SetCutBoundaryUnify( bool unify );
 
    virtual OdDb::LineWeight CutBoundaryLineweight() const;
    virtual void SetCutBoundaryLineweight( OdDb::LineWeight lineweight );
 
    virtual OdCmColor CutBoundaryColor() const;
    virtual void SetCutBoundaryColor( OdCmColor color );
 
    virtual bool SurfaceBoundaryUnify() const;
    virtual void SetSurfaceBoundaryUnify( bool unify );
 
    virtual OdDb::LineWeight SurfaceBoundaryLineweight() const;
    virtual void SetSurfaceBoundaryLineweight( OdDb::LineWeight lineweight );
 
    virtual OdCmColor SurfaceBoundaryColor() const;
    virtual void SetSurfaceBoundaryColor( OdCmColor color );
 
    // SHADING
 
    virtual OdCmColor CutColor() const;
    virtual void SetCutColor( OdCmColor color );
 
    virtual double CutTransparency() const;
    virtual void SetCutTransparency( double transparencyPercentage );
 
    virtual OdCmColor SurfaceColor() const;
    virtual void SetSurfaceColor( OdCmColor color );
 
    virtual double SurfaceTransparency() const;
    virtual void SetSurfaceTransparency( double transparencyPercentage );
 
    // STRUCTURAL
 
    virtual int Priority() const;
    virtual void SetPriority( const int iPriority );
 
    virtual bool IsCore() const;
    virtual void SetCore( const bool bIsCore );
 
public:
    OdResult dwgInFields( OdDbDwgFiler* pFiler ) override;
    void dwgOutFields( OdDbDwgFiler* pFiler ) const override;
 
    OdResult dxfInFields( OdDbDxfFiler* pFiler ) override;
    void dxfOutFields( OdDbDxfFiler* pFiler ) const override;
 
    void copyFrom( const OdRxObject* pSource ) override;
 
protected:
    CFxBIMMaterial();
};
 
//-------------------------------------------------------------------------------------------------------------------------------------------------------------
 
class FXBIM_API CFxBIMMaterialReactor : virtual public CFxBIMObject
{
public:
    virtual ~CFxBIMMaterialReactor() {};
 
    virtual void Appended( CFxBIMMaterial* pM, bool appended, CFxBIMDatabaseReference* pDbRef ) {};
    virtual void Edited( CFxBIMMaterial* pM, CFxBIMDatabaseReference* pDbRef ) {};
};
 
 
//==========================================================================================================================
//==========================================================================================================================
//======================================                           =========================================================
//======================================           Enums           =========================================================
//======================================                           =========================================================
//==========================================================================================================================
//==========================================================================================================================
 
enum class FXBIM_API CFxDirectionSenseEnum { ePositive, eNegative, eUnset, eInvalid };
enum class FXBIM_API CFxLayerSetDirectionEnum { eAxis1, eAxis2, eAxis3, eUnset, eInvalid };
 
//==========================================================================================================================
//==========================================================================================================================
//========================================                       ===========================================================
//========================================  CFxMaterialLayerSet  ===========================================================
//========================================                       ===========================================================
//==========================================================================================================================
//==========================================================================================================================
struct FXBIM_COMMON_CODE_API CFxMaterialLayersInfo;
 
class FXBIM_COMMON_CODE_API CFxMaterialLayerSet : public CFxBIMMaterial
{
    friend class CFxMaterialLayerSetImpl;
 
public:
    ODDB_DECLARE_MEMBERS( CFxMaterialLayerSet );
 
    virtual ~CFxMaterialLayerSet();
 
    bool IsEqual( CFxBIMMaterialPtr p ) const override;
    bool IsSame( CFxBIMMaterialPtr p ) const override;
 
    /*
    Following functions are not needed to be overriden for now:
        OdResult dwgInFields( OdDbDwgFiler* pFiler ) override;
        void dwgOutFields( OdDbDwgFiler* pFiler ) const override;
        OdResult dxfInFields( OdDbDxfFiler* pFiler ) override;
        void dxfOutFields( OdDbDxfFiler* pFiler ) const override;*/
 
    void copyFrom( const OdRxObject* pSource ) override;
 
    CFxMaterialLayersInfo LayersInfo() const;
    void SetLayersInfo( const CFxMaterialLayersInfo& layersInfo );
 
protected:
    CFxMaterialLayerSet();
};
 
typedef OdSmartPtr< CFxMaterialLayerSet > CFxMaterialLayerSetPtr;
 
struct FXBIM_API CFxBIMMaterialLayerSetInfo
{
    OdString m_strName;
    CFxDirectionSenseEnum m_DirectionSense = CFxDirectionSenseEnum::eInvalid;
    CFxLayerSetDirectionEnum m_LayerSetDirection = CFxLayerSetDirectionEnum::eInvalid;
 
    //TODO: If material count is more than 9 then this approch of using std::map may 
    // not work as material name sequence will not be correct
    std::map< OdString, std::pair< OdString, double > > mapLayersInfo;
};