DgnAttachment.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"

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

enum class DgnAttachmentLocateStatus
    {
    LocateOn                      = 0,        
    LocateOff                     = 1,        
    ParentLocateOff               = 2,        
    NoLocateRights                = 3,        
    ParentNoLocateRights          = 4,        
    };

enum class ProxyCacheStatus
    {
    NotCached             = 0,        
    UpToDate              = 1,        
    ModelChanged          = 2,        
    ViewChanged           = 3,        
    NotUsedInView         = 4,        
    AttachmentChanged     = 5,        
    ObsoleteVersion       = 6,        
    NotDisplayedInView    = 7,        
    MissingReferences     = 8,        
    Disconnected          = 9,
    ReferenceNotFound     = 10,
    ReferenceLoadDisabled = 11,
    ObsoleteValidityHash  = 12,
    };

struct  RefDisplayFlags
    {
    UInt32      symbologySet:1;                 
    UInt32      hiliteBoundary:1;               
    UInt32      displayHilitedManip:1;          
    UInt32      displayHilitedSelected:1;       
    UInt32      dontUpdateChildren:1;           
    UInt32      redundant:1;                    
    UInt32      missingModel:1;                 
    UInt32      rightNotGranted:1;              
    UInt32      namedGroupFound:1;              
    UInt32      revisionNotAvailable:1;         
    UInt32      resolvedHistoryTag:1;           
    UInt32      revisionFromParent:1;           
    UInt32      findModelByID:1;                
    UInt32      missingGeoCoordApp:1;           
    UInt32      missingGeoCoordSys:1;           
    UInt32      isCircular:1;                   
    UInt32      calculatedTransformUsed:1;      
    UInt32      namedGroupProcessingComplete:1; 
    UInt32      hiddenLineCaching:2;            
    UInt32      proxyCacheSynchOption:2;
    UInt32      dontAddRefClip:1;
    UInt32      unused:9;
    };



//=======================================================================================
//=======================================================================================
struct          DgnAttachmentAppData
    {
    virtual ~DgnAttachmentAppData () {}

    struct Key : AppDataKey {};

    virtual void _OnCleanup         (DgnAttachmentR host) = 0;

    virtual bool _OnCacheRelease    (DgnAttachmentR host) {return false;}

    virtual void _OnRewrite (DgnAttachmentR host) { }
    };

/*=================================================================================**/
struct   DgnAttachment : DgnModelRef
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

    enum ScaleMode
        {
        SCALE_MODE_TrueScale,         
        SCALE_MODE_StorageUnits,      
        SCALE_MODE_Direct,            
        };


    DGNPLATFORM_EXPORT StatusInt        WriteToModel (bool loadRasterRefs = false, bool treatAsNew = false);

    DGNPLATFORM_EXPORT StatusInt        Rewrite (bool writeSettings, bool writeLevelDisplaySettings);

    DGNPLATFORM_EXPORT ElementId        GetElementId () const;



    DGNPLATFORM_EXPORT StatusInt        AddAppData (DgnAttachmentAppData::Key const& key, DgnAttachmentAppData* appData);

    DGNPLATFORM_EXPORT StatusInt        DropAppData (DgnAttachmentAppData::Key const& key);

    DGNPLATFORM_EXPORT DgnAttachmentAppData* FindAppData (DgnAttachmentAppData::Key const& key) const;



    DGNPLATFORM_EXPORT DgnModelRefCR    GetParent () const;

    DGNPLATFORM_EXPORT DgnModelRefR     GetParentR ();

    DGNPLATFORM_EXPORT DgnAttachmentCP  GetParentDgnAttachmentCP() const;

    DGNPLATFORM_EXPORT DgnAttachmentP   GetParentDgnAttachmentP();

    DGNPLATFORM_EXPORT DgnAttachmentCR  GetBaseDgnAttachment () const;

    DGNPLATFORM_EXPORT DgnAttachmentR   GetBaseDgnAttachmentR ();




    DGNPLATFORM_EXPORT WString          GetAttachFileName () const;

    DGNPLATFORM_EXPORT WString          GetAttachFullFileSpec (bool dontFindIfPreviouslyNotFound = true) const;

    DGNPLATFORM_EXPORT WCharCP          GetAttachModelName () const;

    DGNPLATFORM_EXPORT bool             IsMissingFile () const;

    DGNPLATFORM_EXPORT bool             IsMissingModel () const;

    DGNPLATFORM_EXPORT bool             IsRightNotGranted() const;

    DGNPLATFORM_EXPORT bool             IsRevisionNotAvailable() const;

    DGNPLATFORM_EXPORT bool             IsMissingGeoCoordApp() const;

    DGNPLATFORM_EXPORT bool             IsMissingGeoCoordSys() const;

    DGNPLATFORM_EXPORT DgnDocumentMonikerPtr GetAttachMoniker () const;

    DGNPLATFORM_EXPORT void             SetAttachMoniker (DgnDocumentMonikerR);



    DGNPLATFORM_EXPORT void             GetTransformToParent (TransformR, bool scaleZfor2dRef) const;

    DGNPLATFORM_EXPORT void             SetRotMatrix (RotMatrixCR);

    DGNPLATFORM_EXPORT RotMatrixCR      GetRotMatrix () const;

    DGNPLATFORM_EXPORT void             SetMasterOrigin (DPoint3dCR);

    DGNPLATFORM_EXPORT void             GetMasterOrigin (DPoint3dR origin) const;

    DGNPLATFORM_EXPORT void             SetRefOrigin (DPoint3dCR);

    DGNPLATFORM_EXPORT DPoint3dCR       GetRefOrigin () const;

    DGNPLATFORM_EXPORT void             SetScaleMode (ScaleMode);

    DGNPLATFORM_EXPORT ScaleMode        GetScaleMode () const;

    DGNPLATFORM_EXPORT void             SetStoredScale (double);

    DGNPLATFORM_EXPORT double           GetStoredScale () const;

    DGNPLATFORM_EXPORT double           GetDisplayScale () const;


    DGNPLATFORM_EXPORT bool             IsLocateLocked () const;

    DGNPLATFORM_EXPORT void             SetLocateLock (bool);

    DGNPLATFORM_EXPORT DgnAttachmentLocateStatus GetLocateStatus () const;

    DGNPLATFORM_EXPORT bool             IsSnapLocked () const;

    DGNPLATFORM_EXPORT void             SetSnapLock (bool);

    DGNPLATFORM_EXPORT void             SetIsDisplayed (bool state, bool loadIfNecessary=true, bool processAffected=true);

    DGNPLATFORM_EXPORT bool             IsDisplayed () const;

    DGNPLATFORM_EXPORT void             SetDgnAttachmentLevel (LevelId levelId);

    DGNPLATFORM_EXPORT LevelId          GetDgnAttachmentLevel () const;

    DGNPLATFORM_EXPORT bool             DoesLevelControlDisplay () const;

    DGNPLATFORM_EXPORT void             SetLevelControlsDisplay (bool);

    DGNPLATFORM_EXPORT bool             IsApplicationLocked () const;

    DGNPLATFORM_EXPORT void             SetApplicationLocked (bool);

    DGNPLATFORM_EXPORT void             SetNestDepth (UInt16 d);

    DGNPLATFORM_EXPORT UShort           GetNestDepth () const;

    DGNPLATFORM_EXPORT void             SetTransparency (double value);

    DGNPLATFORM_EXPORT bool             GetDoNotDisplayAsNested () const;

    DGNPLATFORM_EXPORT void             SetDoNotDisplayAsNested (bool);

    DGNPLATFORM_EXPORT bool             IsInSS () const;

    DGNPLATFORM_EXPORT bool             IsHighlighted (bool checkParents = true) const;


    DGNPLATFORM_EXPORT bool             IsClipped () const;

    DGNPLATFORM_EXPORT void             GetClipBoundaries (ClipVectorPtr& clip, ViewportP vp, bool relativeToImmediateParent, bool onlyMasksIfClipElement) const;

    DGNPLATFORM_EXPORT ElementId        GetClipElementId () const;

    DGNPLATFORM_EXPORT StatusInt        SetClipElementId (ElementId clipElement);

    DGNPLATFORM_EXPORT void             ClearClipElementId ();

    DGNPLATFORM_EXPORT UInt32           GetClipPointCount () const;

    DGNPLATFORM_EXPORT void             GetClipPoints (bvector<DPoint2d>& clipPoints) const;

    DGNPLATFORM_EXPORT StatusInt        SetClipPoints (DPoint2dCP points, UInt32 numPoints);

    DGNPLATFORM_EXPORT StatusInt        SetClipBoundFromViewPoints (DPoint2dCP points, UInt32 numPoints, RotMatrixCR viewRotMatrix, DPoint3dR viewOrigin, double viewActiveZ, bool discardClipMasks);

    DGNPLATFORM_EXPORT StatusInt        AppendClipVoidPoints (DPoint2dP points, UInt32 numPoints, RotMatrixCR viewRotMatrix);

    DGNPLATFORM_EXPORT bool             HasBackClip () const;

    DGNPLATFORM_EXPORT bool             HasFrontClip () const;

    DGNPLATFORM_EXPORT double           GetFrontClipDepth () const;

    DGNPLATFORM_EXPORT StatusInt        SetFrontClipDepth (double depth);

    DGNPLATFORM_EXPORT double           GetBackClipDepth () const;

    DGNPLATFORM_EXPORT StatusInt        SetBackClipDepth (double depth);

    DGNPLATFORM_EXPORT RotMatrixCR      GetClipRotMatrix () const;

    DGNPLATFORM_EXPORT void             SetClipRotMatrix (RotMatrixCR rotation);

    DGNPLATFORM_EXPORT bool             IsRotateClipping () const;

    DGNPLATFORM_EXPORT void             SetRotateClipping (bool yesNo);


    DGNPLATFORM_EXPORT StatusInt        SetLogicalName (WCharCP);

    DGNPLATFORM_EXPORT WCharCP          GetLogicalName () const;

    DGNPLATFORM_EXPORT void             SetUniqueLogical ();

    DGNPLATFORM_EXPORT void             SetAttachDescription (WCharCP);

    DGNPLATFORM_EXPORT WCharCP          GetAttachDescription () const;

    struct ApplyViewClipOptions
        {
      private:
        friend struct  DgnAttachment;
        bool    m_clipBoundary;
        bool    m_applyFrontBackClip;
        bool    m_keepMask;

      public:
        ApplyViewClipOptions () : m_clipBoundary(true), m_applyFrontBackClip(true), m_keepMask(true) {;}

        void SetClipBoundary (bool b) {m_clipBoundary=b;}               
        void SetApplyFrontBackClip (bool b) {m_applyFrontBackClip=b;}   
        void SetKeepMask (bool b) {m_keepMask=b;}                      
        };


    DGNPLATFORM_EXPORT StatusInt        ApplyNamedView (WCharCP viewName, double userScale, double acsScale = 1.0, ApplyViewClipOptions const& clipOptions = ApplyViewClipOptions(), bool getModelFromView = true, StandardView auxRotation = StandardView::NotStandard);

    DGNPLATFORM_EXPORT StatusInt        ApplyStandardView (StandardView stdview, double userScale, double acsScale = 1.0);

    DGNPLATFORM_EXPORT NamedViewPtr     GetNamedView () const;

    DGNPLATFORM_EXPORT void             SetSynchWithNamedView (ReferenceSynchOption);

    DGNPLATFORM_EXPORT ReferenceSynchOption GetSynchWithNamedView () const;


};


END_BENTLEY_DGNPLATFORM_NAMESPACE