DgnModelRef.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include "DgnPlatform.h"
#include "DgnFileIO/BentleyDgn.h"

DGNPLATFORM_TYPEDEFS (DgnAttachmentArray)
DGNPLATFORM_TYPEDEFS (ReachableModelRefOptions)
DGNPLATFORM_TYPEDEFS (ReachableElementOptions)
DGNPLATFORM_TYPEDEFS (ReachableModelRefCollection)
DGNPLATFORM_TYPEDEFS (ReachableElementCollection)
DGNPLATFORM_TYPEDEFS (ModelRefRangeTree)

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

struct ReachableModelRefCollection;
struct ReachableElementCollection;

typedef RefCountedPtr<ReachableModelRefOptions>     ReachableModelRefOptionsPtr;
typedef RefCountedPtr<ReachableElementOptions>      ReachableElementOptionsPtr;

enum class DgnModelRefType
{
    Root        = 1,    
    PrimaryRef  = 2,    
    Proxy       = 4,
    NonModel    = 7,    
    Transient   = 8,
};

//=======================================================================================
//=======================================================================================
struct DgnAttachmentArray
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    typedef bvector<DgnAttachmentP>::const_iterator const_iterator;
    typedef const_iterator iterator;                    
    DGNPLATFORM_EXPORT const_iterator   begin () const;     
    DGNPLATFORM_EXPORT const_iterator   end () const;       
    DGNPLATFORM_EXPORT size_t           size () const;      
    DGNPLATFORM_EXPORT DgnAttachmentP   at (size_t) const;  
};

//=======================================================================================
//=======================================================================================
struct UpdateSequenceList : bvector<ElementId>
    {
    };

//=======================================================================================
//=======================================================================================
struct DgnModelRefList : bvector<DgnModelRefP>
    {
    DgnModelRefP FindByModelId (ModelId);
    void ToDocumentList (DgnDocumentListR list);
    bool IsFound (DgnModelRefP modelRef) const {return std::find (begin(), end(), modelRef) != end();}
    };

//=======================================================================================
//=======================================================================================
struct DgnAttachmentBuilder
{
private:
    DgnAttachmentP  m_ref;
public:
    DgnAttachmentBuilder () {m_ref=NULL;}
    DGNPLATFORM_EXPORT DgnAttachmentBuilder (DgnAttachmentBuilder&);
    DGNPLATFORM_EXPORT DgnAttachmentBuilder& operator=(DgnAttachmentBuilder&);
    DGNPLATFORM_EXPORT ~DgnAttachmentBuilder ();
    DGNPLATFORM_EXPORT DgnAttachmentP  operator->() const;
    DgnAttachmentCP GetDgnAttachmentCP() {return m_ref;}
    DgnAttachmentP GetDgnAttachmentP() {return m_ref;}
    DGNPLATFORM_EXPORT DgnAttachmentR AddToParent();
};

//=======================================================================================
//=======================================================================================
struct DgnAttachmentLoadOptions
    {
    bool                m_loadCaches;           
    bool                m_topLevelModel;        
    bool                m_loadUndisplayed;      
    bool                m_loadRasterRefs;       
    bool                m_oneLevelDeep;         
    bool                m_redundancyCheck;      
    bool                m_applyOverrides;       
    bool                m_showProgressMeter;    
    DgnModelSections    m_sectionsToFill;       
    LimitRefLoading     m_limitLoading;         
    int                 m_maxDepth;             

    DGNPLATFORM_EXPORT DgnAttachmentLoadOptions (bool loadCaches=true, bool loadUndisplayed=false, bool loadRasterRefs=true);

    void SetLoadUndisplayed (bool val) {m_loadUndisplayed = val;}
    void SetOneLevelOnly (bool val) {m_oneLevelDeep = val;}
    void SetRedundancyCheck (bool val) {m_redundancyCheck = val;}
    void SetApplyOverrides (bool val) {m_applyOverrides = val;}
    void SetSectionsToFill (DgnModelSections val) {m_sectionsToFill = val;}
    void SetMaxDepth (int maxDepth) {m_maxDepth = maxDepth;}
    void SetShowProgressMeter (bool val) {m_showProgressMeter = val;}
    void SetLimitRefLoading (LimitRefLoading val) {m_limitLoading = val;}
    };


//=======================================================================================
//=======================================================================================
CLRPUBLIC struct DgnModelRef
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT StatusInt CreateDgnAttachment (DgnAttachmentP& attachment, DgnDocumentMonikerR moniker, WCharCP modelName, bool loadCache = true);


    DGNPLATFORM_EXPORT StatusInt DeleteDgnAttachment (DgnAttachmentP& attachment);

    DGNPLATFORM_EXPORT DgnAttachmentArrayP GetDgnAttachmentsP () const;

    DGNPLATFORM_EXPORT DgnAttachmentArrayCP GetDgnAttachmentsCP () const;

    DGNPLATFORM_EXPORT ReachableModelRefCollection GetReachableModelRefs(ReachableModelRefOptionsP=NULL);

    DGNPLATFORM_EXPORT ReachableElementCollection GetReachableElements (ReachableElementOptionsP=NULL);

    DGNPLATFORM_EXPORT DgnAttachmentP FindDgnAttachmentByElementId (ElementId attachmentID);

    DGNPLATFORM_EXPORT StatusInt ReadAndLoadDgnAttachments (DgnAttachmentLoadOptions const&);

    DGNPLATFORM_EXPORT DgnModelRefP GetParentModelRefP () const;

    DGNPLATFORM_EXPORT DgnModelP GetDgnModelP () const;

    DGNPLATFORM_EXPORT DgnFileP GetDgnFileP () const;

    DGNPLATFORM_EXPORT ModelInfoCP GetModelInfoCP () const;

    DGNPLATFORM_EXPORT bool IsDgnAttachment () const;

    DGNPLATFORM_EXPORT bool IsDirectDgnAttachment() const;

    DGNPLATFORM_EXPORT bool IsNestedDgnAttachment() const;

    DGNPLATFORM_EXPORT bool IsDwgStyleAttachment() const;

    DGNPLATFORM_EXPORT bool IsDefault () const;

    DGNPLATFORM_EXPORT DgnModelRefType GetModelRefType () const;

    DGNPLATFORM_EXPORT DgnModelCP AsDgnModelCP () const;

    DgnModelP AsDgnModelP() {return const_cast<DgnModelP>(AsDgnModelCP());}

    DGNPLATFORM_EXPORT DgnAttachmentCP AsDgnAttachmentCP () const;

    DgnAttachmentP AsDgnAttachmentP () {return const_cast<DgnAttachmentP>(AsDgnAttachmentCP());}

    DGNPLATFORM_EXPORT LevelCacheR GetLevelCacheR ();

    DGNPLATFORM_EXPORT LevelCacheCR GetLevelCache () const;

    DGNPLATFORM_EXPORT FileLevelCacheP GetFileLevelCacheP ();

    DGNPLATFORM_EXPORT FileLevelCacheCP GetFileLevelCacheCP () const;

    DGNPLATFORM_EXPORT bool Is3d () const;

    DGNPLATFORM_EXPORT bool TreatAs3d () const;

    DGNPLATFORM_EXPORT DgnFileP        GetSymbologySourceDgnFileP() const;

};

END_BENTLEY_DGNPLATFORM_NAMESPACE