FxBIMSection.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 "FxBIMProject.h"
 
#include <StringArray.h>
#include <DbEntity.h>
#include <Ge/GePlane.h>
#include <Ge/GeExtents2d.h>
 
#include <vector>
#include <list>
 
class CFxBIMSection;
typedef OdSmartPtr< CFxBIMSection > CFxBIMSectionPtr;
 
class CFxUIDialog;
 
class FXBIM_API CFxBIMSection : public OdDbEntity
{
public:
    ODDB_DECLARE_MEMBERS( CFxBIMSection );
 
    virtual ~CFxBIMSection();
 
    virtual const OdString& Name() const;
    virtual void SetName( const OdString& name );
    virtual const OdGePlane& Plane() const;
    virtual void SetPlane( const OdGePlane& plane );
    virtual const std::vector< OdGePoint2d >& Points() const;
    virtual void SetPoints( const std::vector< OdGePoint2d >& points );
    virtual double Depth() const;
    virtual void SetDepth( double depth );
 
    void SetDetailViewParentSection( OdDbObjectId idDetailParentSection );
    OdDbObjectId GetDetailViewParentSection() const;
 
    void SetDetailViewFrameHandle( OdDbHandle hDetailViewFrame );
    OdDbHandle GetDetailViewFrameHandle() const;
 
    void SetDetailViewLeaderHandle( OdDbHandle hDetailViewLeader );
    OdDbHandle GetDetailViewLeaderHandle() const;
 
    void SetDetailViewCalloutHandle( OdDbHandle hDetailViewCallout );
    OdDbHandle GetDetailViewCalloutHandle() const;
 
    void SetDetailViewLeaderPoints( const std::list< OdGePoint3d >& listDetailViewLeaderPoints );
    const std::list< OdGePoint3d >& GetDetailViewLeaderPoints() const;
 
    void SetDetailViewCalloutCenter( OdGePoint3d pointDetailViewCalloutCenter );
    OdGePoint3d GetDetailViewCalloutCenter() const;
 
    void SetDetailViewCalloutRadius( double dDetailViewCalloutRadius );
    double GetDetailViewCalloutRadius() const;
 
    void SetDetailViewCalloutBottomLabel( OdString strDetailViewCalloutBottomLabel );
    OdString GetDetailViewCalloutBottomLabel() const;
 
    void SetDetailViewCalloutTransformation( const OdGeMatrix3d& mTr );
    const OdGeMatrix3d& GetDetailViewCalloutTransformation() const;
 
    OdString GetDetailViewScaleStr() const;
 
    void SetBuilding( const OdString& strBuilding );
    OdString GetBuilding() const;
 
    enum SectionType
    {
        Plan,
        Section,
        Detail,
        Elevation,
        //InteriorElevation, //TODO:
    };
 
    virtual SectionType Type() const;
    virtual void SetType( CFxBIMSection::SectionType type );
 
    virtual const OdString& Filter() const;
    virtual void SetFilter( const OdString& filter );
 
    virtual void AddEntRef( const OdDbObjectId& eRefId );
    virtual void AddEntRefs( const OdDbEntityPtrArray& arrEntRefs );
    virtual void RemoveFromEntRefs();
 
    enum Flags
    {
        eInvalid = 0x1,
        eDrawBox = 0x2,
        eDrawSymbol = 0x4,
        eUnused0 = 0x8,
        eUnused1 = 0x10,
    };
 
    virtual int Flags() const;
    virtual void SetFlags( int flags );
 
    virtual const std::vector< OdDbObjectId >& Layers() const;
    virtual void SetLayers( const std::vector< OdDbObjectId >& layers );
 
    void HideDrawBox( const bool& bHide );

    virtual void AddLayer(const OdDbObjectId &layer);

    virtual void RemoveLayer(const OdDbObjectId &layer);
 
    bool IsPlan() const;
 
public:
    OdResult dwgInFields( OdDbDwgFiler* pFiler ) override;
    void dwgOutFields( OdDbDwgFiler* pFiler ) const override;
 
    OdResult dxfInFields( OdDbDxfFiler* pFiler ) override;
    void dxfOutFields( OdDbDxfFiler* pFiler ) const override;
 
    OdUInt32 subSetAttributes( OdGiDrawableTraits* traits ) const override;
    bool subWorldDraw( OdGiWorldDraw* wd ) const override;
    void subViewportDraw( OdGiViewportDraw* vd ) const override;
 
    OdResult subGetGeomExtents( OdGeExtents3d& extents ) const override;
 
    void subGripStatus( const OdDb::GripStat status ) override;
 
    OdResult subGetOsnapPoints(
        OdDb::OsnapMode osnapMode,
        OdGsMarker gsSelectionMark,
        const OdGePoint3d& pickPoint,
        const OdGePoint3d& lastPoint,
        const OdGeMatrix3d& xWorldToEye,
        OdGePoint3dArray& snapPoints ) const override;
 
    OdResult subGetOsnapPoints(
        OdDb::OsnapMode osnapMode,
        OdGsMarker gsSelectionMark,
        const OdGePoint3d& pickPoint,
        const OdGePoint3d& lastPoint,
        const OdGeMatrix3d& xWorldToEye,
        OdGePoint3dArray& snapPoints,
        const OdGeMatrix3d& insertionMat ) const override;
 
    bool subIsContentSnappable() const override;
 
    OdResult subGetGripPoints( OdGePoint3dArray& gripPoints ) const override;
    OdResult subMoveGripPointsAt( const OdIntArray& indices, const OdGeVector3d& offset ) override;
    OdResult subGetGripPoints(
        OdDbGripDataPtrArray& grips,
        const double curViewUnitSize,
        const int gripSize,
        const OdGeVector3d& curViewDir,
        const int bitFlags ) const override;
    OdResult subMoveGripPointsAt(
        const OdDbVoidPtrArray& grips,
        const OdGeVector3d& offset,
        int bitFlags ) override;
    OdResult subGetStretchPoints( OdGePoint3dArray& stretchPoints ) const override;
    OdResult subMoveStretchPointsAt(
        const OdIntArray& indices,
        const OdGeVector3d& offset ) override;
 
    OdResult subErase( bool erasing ) override;
    OdDbObjectPtr subWblockClone( OdDbIdMapping& ownerIdMap, OdDbObject*, bool bPrimary ) const override;
    OdDbObjectPtr subDeepClone( OdDbIdMapping& ownerIdMap, OdDbObject*, bool bPrimary ) const override;
 
protected:
    CFxBIMSection();
};
 
namespace FxBIM
{
    FXBIM_API CFxBIMSectionPtr GetBIMDrawingSection( OdDbDatabasePtr pBIMDrawingDb, OdDb::OpenMode mode );
    FXBIM_API CFxBIMSectionPtr GetBIMSection( OdDbDatabasePtr pDb, OdDbHandle hSection, OdDb::OpenMode mode );
    [[deprecated( "Use version without 'mode' parameter" )]]
    FXBIM_API OdDbDatabasePtr OpenBIMSectionDrawingDatabase( CFxBIMSectionPtr pSection, OdDb::OpenMode mode );
    FXBIM_API OdDbDatabasePtr OpenBIMSectionDrawingDatabase( CFxBIMSectionPtr pSection );
 
    FXBIM_API void SetBIMNavigatorControllerSectionReactor( CFxBIMObjectPtr pSectionReactor );
 
    struct CFxSectionCreateManager
    {
        virtual void Create( OdDbObjectId idSection ) = 0;
    };
 
    using CFxSectionCreateManagerPtr = std::shared_ptr< CFxSectionCreateManager >;
 
    FXBIM_API void SetBIMSectionCreateManager( CFxSectionCreateManagerPtr pSectionCreateManager );
 
    struct CFxSectionParameterProvider
    {
        virtual Error GetSectionTypeParameter( CFxBIMSection::SectionType& type ) { return( Error::eFail ); }
        virtual OdDbEntityPtrArray GetSelectionSet() { return {}; }
        virtual Error GetSectionType( CFxBIMSection::SectionType& type, CFxBIMProject::BimStatusFlags eBimStatusFlag ) = 0;
        virtual OdGePlane CalcWorkingPlane() = 0;
        virtual Error GetDetailViewParameters( OdGePoint3d& pointFrame1
                                             , OdGePoint3d& pointFrame2
                                             , std::list< OdGePoint3d >& listLeaderPoints
                                             , double& dCalloutRadius
                                             , OdGeMatrix3d& mTransformation
                                             , OdString& scaleName
                                             , OdString& strDefaultDetailViewName
                                             , bool& bRequestSectionName ) = 0;
 
        virtual Error CreateSection( CFxBIMSectionPtr& pBimSection
                                   , OdDbDatabasePtr pDb
                                   , const OdGePlane& ucs
                                   , const OdDbEntityPtrArray& wrappers
                                   , CFxBIMSection::SectionType type ) = 0;
 
        virtual Error CheckValidity( CFxBIMProject::BimStatusFlags BimStatus ) = 0;
 
        virtual Error GetSectionName( OdString& sectionName
                                    , CFxBIMSection::SectionType& type
                                    , OdDbObjectId& idLayerSection
                                    , OdDbDatabasePtr pDb ) = 0;
 
        virtual void AddDetailViewEntitiesToDb( OdDbDatabasePtr pDb, CFxBIMSectionPtr pDetailSection ) = 0;
 
        virtual void OnSectionCreated( CFxBIMSectionPtr pBimSection ) {}
    };
 
    FXBIM_API Error CreateSection( OdDbDatabasePtr pDbCurrent,
                                   CFxSectionParameterProvider& ProviderImpl,
                                   CFxUIDialog* pDialog = nullptr );
 
} // namespace FxBIM
 
class CFxBIMSectionView;
 
#include "FxBIMDrawing.h"
 
class FXBIM_API CFxBIMSectionReactor : virtual public CFxBIMObject
{
public:
    virtual ~CFxBIMSectionReactor() = default;
 
    virtual void Created( CFxBIMSection* p ) {}
    virtual void Removed( CFxBIMSection* p, bool removed ) {}
 
    virtual void Renamed( CFxBIMSection* p, const OdString& oldName, bool undo ) {}
 
    virtual void ViewCreated( const CFxBIMDrawing::ViewRef& viewRef, OdDbDatabase* pDb ) {}
    virtual void ViewCopied( const CFxBIMDrawing::ViewRef& viewRef, const OdString& viewHandle, const OdString& viewNumber, const OdDbObjectId& idXref, OdDbDatabase* pDb ) {}
    virtual void ViewRemoved( const CFxBIMDrawing::ViewRef& viewRef, bool removed, OdDbDatabase* pDb ) {}
    virtual void ViewRenamed( CFxBIMSectionView* p, OdString const& sOldNumber, OdString const& sOldName, bool undo ) {}
 
    virtual void Regenerated( CFxBIMSection* p, OdDbDatabase* pDbDest, const std::vector< OdDbObjectId >& oldSE, const std::vector< OdDbObjectId >& newSE ) {}
 
    virtual void ModifiedGraphics( CFxBIMSection* p ) {}
    virtual void ModifiedType( CFxBIMSection* p ) {}
    virtual void ModifiedFilter( CFxBIMSection* p ) {}
};