DetailingSymbol.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/SectionClip.h>
#include    <DgnPlatform/ViewElementHandlerSubTypes.h>
#include    <DgnPlatform/TextBlock/TextAPICommon.h>
#include    <DgnPlatform/DetailingSymbol/detailingsymbolcore.r.h>

DGNPLATFORM_TYPEDEFS (BaseDetailingPropInfo)
DGNPLATFORM_TYPEDEFS (BoundedPlane);
DGNPLATFORM_TYPEDEFS (IDetailingSymbol)
DGNPLATFORM_TYPEDEFS (IDetailingSymbolFactory)
DGNPLATFORM_TYPEDEFS (VolumeDef)
DGNPLATFORM_TYPEDEFS (VolumeDefCollection);
DGNPLATFORM_TYPEDEFS (IClipElementProvider)
DGNPLATFORM_TYPEDEFS (IHasClipElementProvider)
DGNPLATFORM_TYPEDEFS (SectionCalloutDef)
DGNPLATFORM_TYPEDEFS (DetailCalloutDef)
DGNPLATFORM_TYPEDEFS (DetailCallout3DViewDef)
DGNPLATFORM_TYPEDEFS (ElevationCalloutDef)
DGNPLATFORM_TYPEDEFS (InteriorElevationCalloutDef)
DGNPLATFORM_TYPEDEFS (PlanCalloutDef)
DGNPLATFORM_TYPEDEFS (TitleTextDef)
DGNPLATFORM_TYPEDEFS (DrawingBoundaryDef)
DGNPLATFORM_TYPEDEFS (IDrawingTraverseOptions)
DGNPLATFORM_TYPEDEFS (IViewClipObject)
DGNPLATFORM_TYPEDEFS (DetailingSymbolStyle)

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

//=======================================================================================
//=======================================================================================

/*=================================================================================**/
struct BoundedPlane
    {
    DPoint3d        m_origin;       
    RotMatrix       m_matrix;       
    DRange2d        m_range;        
    
    DGNPLATFORM_EXPORT   BoundedPlane ();
    
    }; // BoundedPlane


//=======================================================================================
//=======================================================================================
enum class BaseDetailingProp
    {
    Invalid                                          = 0,
    Level_LEVEL                                      = 1,
    };

struct IDetailingSymbol;

/*=================================================================================**/
struct BaseDetailingPropInfo
{
protected:
    
    IDetailingSymbol*                            m_def;     
    int                                          m_prop;    

    DGNPLATFORM_EXPORT virtual StatusInt         _GetCellName (WStringR cellName) const;
    
    DGNPLATFORM_EXPORT virtual void              _SetCellName (WCharCP cellName);

    DGNPLATFORM_EXPORT virtual StatusInt         _GetColor (UInt32* color) const;

    DGNPLATFORM_EXPORT virtual void              _SetColor (UInt32 color);

    DGNPLATFORM_EXPORT virtual StatusInt         _GetWeight (UInt32* weight) const;

    DGNPLATFORM_EXPORT virtual void              _SetWeight (UInt32 weight);

    DGNPLATFORM_EXPORT virtual StatusInt         _GetLineStyle (Int32* lineStyle) const;

    DGNPLATFORM_EXPORT virtual void              _SetLineStyle (Int32 lineStyle);

    DGNPLATFORM_EXPORT virtual StatusInt         _GetBool (bool* flag) const;

    DGNPLATFORM_EXPORT virtual void              _SetBool (bool flag);

    DGNPLATFORM_EXPORT virtual StatusInt         _GetLevel (DgnPlatform::LevelId* level) const;

    DGNPLATFORM_EXPORT virtual void              _SetLevel (DgnPlatform::LevelId level);

    DGNPLATFORM_EXPORT virtual StatusInt         _GetDouble (double* val) const;

    DGNPLATFORM_EXPORT virtual void              _SetDouble (double val);

    DGNPLATFORM_EXPORT virtual StatusInt         _GetInteger (int* val) const;

    DGNPLATFORM_EXPORT virtual void              _SetInteger (int val);

    DGNPLATFORM_EXPORT virtual int               _GetPropID () const;

    DGNPLATFORM_EXPORT virtual void              _SetPropID (int prop);

public:
    DGNPLATFORM_EXPORT StatusInt                GetCellName (WStringR cellName) const;

    DGNPLATFORM_EXPORT void                     SetCellName (WCharCP cellName);

    DGNPLATFORM_EXPORT StatusInt                GetColor (UInt32 * color) const;
    
    DGNPLATFORM_EXPORT void                     SetColor (UInt32 color);
    
    DGNPLATFORM_EXPORT StatusInt                GetWeight (UInt32 * weight) const;
    
    DGNPLATFORM_EXPORT void                     SetWeight (UInt32 weight);
    
    DGNPLATFORM_EXPORT StatusInt                GetLineStyle (Int32 * lineStyle) const;
    
    DGNPLATFORM_EXPORT void                     SetLineStyle (Int32 lineStyle);
    
    DGNPLATFORM_EXPORT StatusInt                GetBool (bool * flag) const;
    
    DGNPLATFORM_EXPORT void                     SetBool (bool flag);
    
    DGNPLATFORM_EXPORT StatusInt                GetLevel (DgnPlatform::LevelId * level) const;
    
    DGNPLATFORM_EXPORT void                     SetLevel (DgnPlatform::LevelId level);
    
    DGNPLATFORM_EXPORT StatusInt                GetDouble (double* val) const;
    
    DGNPLATFORM_EXPORT void                     SetDouble (double val);
    
    DGNPLATFORM_EXPORT StatusInt                GetInteger (int* val) const;
    
    DGNPLATFORM_EXPORT void                     SetInteger (int val);

    DGNPLATFORM_EXPORT void                     SetPropID (int id);

    DGNPLATFORM_EXPORT int                      GetPropID () const;

    DGNPLATFORM_EXPORT                          BaseDetailingPropInfo (IDetailingSymbol* def, int prop);

}; // BaseDetailingPropInfo


/*=================================================================================**/
struct IDetailingSymbol : virtual RefCountedBase
{
public:
    DGNPLATFORM_EXPORT DgnModelRefP                         GetModelRef () const;
    
    DGNPLATFORM_EXPORT void                                 SetModelRef (DgnModelRefP model);

    DGNPLATFORM_EXPORT StatusInt                            GetCellName (WStringR cellName, BaseDetailingPropInfoCR prop) const;

    DGNPLATFORM_EXPORT void                                 SetCellName (BaseDetailingPropInfoCR prop, WCharCP cellName);

    DGNPLATFORM_EXPORT StatusInt                            GetColorProp (UInt32* color, BaseDetailingPropInfoCR prop) const;
    
    DGNPLATFORM_EXPORT void                                 SetColorProp (BaseDetailingPropInfoCR prop, UInt32 color);
    
    DGNPLATFORM_EXPORT StatusInt                            GetWeightProp (UInt32* weight, BaseDetailingPropInfoCR prop) const;
    
    DGNPLATFORM_EXPORT void                                 SetWeightProp (BaseDetailingPropInfoCR prop, UInt32 weight);
        
    DGNPLATFORM_EXPORT StatusInt                            GetLineStyleProp (Int32* lineStyle, BaseDetailingPropInfoCR prop) const;
    
    DGNPLATFORM_EXPORT void                                 SetLineStyleProp (BaseDetailingPropInfoCR prop, Int32 lineStyle);
        
    DGNPLATFORM_EXPORT StatusInt                            GetBoolProp (bool* flag, BaseDetailingPropInfoCR prop) const;
    
    DGNPLATFORM_EXPORT void                                 SetBoolProp (BaseDetailingPropInfoCR prop, bool flag);
        
    DGNPLATFORM_EXPORT StatusInt                            GetLevelProp (DgnPlatform::LevelId* level, BaseDetailingPropInfoCR prop) const;
    
    DGNPLATFORM_EXPORT void                                 SetLevelProp (BaseDetailingPropInfoCR prop, DgnPlatform::LevelId level);
        
    DGNPLATFORM_EXPORT StatusInt                            GetIntegerProp (int* val, BaseDetailingPropInfoCR prop) const;
    
    DGNPLATFORM_EXPORT void                                 SetIntegerProp (BaseDetailingPropInfoCR prop, int val);
        
    DGNPLATFORM_EXPORT StatusInt                            GetDoubleProp (double* val, BaseDetailingPropInfoCR prop) const;
    
    DGNPLATFORM_EXPORT void                                 SetDoubleProp (BaseDetailingPropInfoCR prop, double val); 

    DGNPLATFORM_EXPORT double                               GetStandardCellRadius () const;

    DGNPLATFORM_EXPORT size_t                               GetNumPoints () const;                                               // Includes origin

    DGNPLATFORM_EXPORT StatusInt                            GetPoints (DPoint3dVector&  pts, size_t iFromPoint, size_t numPoints) const;    // Includes origin

    DGNPLATFORM_EXPORT StatusInt                            InsertPoints (DPoint3dCP pts, size_t iPoint, size_t numPoints);          // Includes origin. -1 to insert at the end

    DGNPLATFORM_EXPORT StatusInt                            ReplacePoints (DPoint3dCP pts, size_t iPoint, size_t numPoints);         // Includes origin

    DGNPLATFORM_EXPORT void                                 ClearPoints ();

    DGNPLATFORM_EXPORT StatusInt                            GetUniquePoint (DPoint3dP  pt, size_t* iActualPoint, size_t iPoint, bool getPreviousIfDisconnect) const;// Includes origin. If iPoint points to a disconnect point, returns the previous or next good one.
    

    DGNPLATFORM_EXPORT RotMatrixCR                         GetRotationAndScale () const;
    
    DGNPLATFORM_EXPORT void                                 GetRotation (RotMatrixR) const;
    
    DGNPLATFORM_EXPORT void                                 GetScale (DVec3dR) const;
    
    DGNPLATFORM_EXPORT void                                 SetRotation (RotMatrixCR);
    
    DGNPLATFORM_EXPORT void                                 SetScale (DVec3dCR);
    
    DGNPLATFORM_EXPORT void                                 SetRotationAndScale (RotMatrixCR);
    
    DGNPLATFORM_EXPORT void                                 GetViewMatrix (RotMatrixR  matrix) const;
    
    DGNPLATFORM_EXPORT void                                 SetViewMatrix (RotMatrixCR  matrix);
    
    DGNPLATFORM_EXPORT StatusInt                            SetUseAnnotationScale (bool);
    
    DGNPLATFORM_EXPORT StatusInt                            SetAnnotationScale (double);

    DGNPLATFORM_EXPORT StatusInt                            UpdateAnnotationScale (ChangeAnnotationScaleP changeContextIn);
    
    DGNPLATFORM_EXPORT void                                 ApplyScale (double);

    DGNPLATFORM_EXPORT StatusInt                            ApplyStyle (DetailingSymbolStyleCR style);

    DGNPLATFORM_EXPORT StatusInt                            ApplyModelAnnotationScale ();

    DGNPLATFORM_EXPORT Handler*                             GetHandler () const;

    DGNPLATFORM_EXPORT StatusInt                            ToElement (EditElementHandleR newSymbol, ElementHandleCP oldSymbol);

    DGNPLATFORM_EXPORT StatusInt                            FromElement (ElementHandleCR sourceElmHandle);

    DGNPLATFORM_EXPORT void                                 Reset ();

    DGNPLATFORM_EXPORT DetailingSymbolType                  GetSymbolType () const;

}; // IDetailingSymbol

//=======================================================================================
//=======================================================================================
typedef RefCountedPtr<IDetailingSymbol>                     IDetailingSymbolPtr;

/*=================================================================================**/
struct IDetailingSymbolFactory : public RefCountedBase
{

public:

    DGNPLATFORM_EXPORT IDetailingSymbolPtr                     Create (ElementHandleCR el) const;

    DGNPLATFORM_EXPORT IDetailingSymbolPtr                     Create (bool is3d) const;

    DGNPLATFORM_EXPORT bool                                    IsSymbolTypeEqual (DetailingSymbolType type, bool is3d) const;

}; // IDetailingSymbolFactory

//=======================================================================================
//=======================================================================================
typedef RefCountedPtr<IDetailingSymbolFactory>   IDetailingSymbolFactoryPtr;


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

public:
    DGNPLATFORM_EXPORT                                              VolumeDef ();

    DGNPLATFORM_EXPORT bool                                         HasGenerateView (ElementHandleCR symbolElementHandle) const;

    DGNPLATFORM_EXPORT StatusInt                                    GetView (EditElementHandleR viewOutEEH) const;
    
    DGNPLATFORM_EXPORT unsigned int                                 GetCropMask () const;

    DGNPLATFORM_EXPORT void                                        SetCropMask (unsigned int cropMask);

    DGNPLATFORM_EXPORT double                                      GetTopHeight () const;

    DGNPLATFORM_EXPORT void                                        SetTopHeight (double height);
    
    DGNPLATFORM_EXPORT double                                      GetBottomHeight () const;
    
    DGNPLATFORM_EXPORT void                                        SetBottomHeight (double height);
    
    DGNPLATFORM_EXPORT double                                      GetMinWidth () const;
    
    DGNPLATFORM_EXPORT double                                      GetMaxWidth () const;
    
    DGNPLATFORM_EXPORT void                                        SetMinWidth (double minWidth);
    
    DGNPLATFORM_EXPORT void                                        SetMaxWidth (double maxWidth);

    DGNPLATFORM_EXPORT double                                      GetFrontDepth () const;
    
    DGNPLATFORM_EXPORT void                                        SetFrontDepth (double depth);

    DGNPLATFORM_EXPORT double                                      GetBackDepth () const;

    DGNPLATFORM_EXPORT void                                        SetBackDepth (double depth);
    
    DGNPLATFORM_EXPORT double                                      GetParametricOrigin () const;
    
    DGNPLATFORM_EXPORT void                                        SetParametricOrigin (double d);
    
    DGNPLATFORM_EXPORT double                                      GetRotation () const;
    
    DGNPLATFORM_EXPORT void                                        SetRotation (double d);

    DGNPLATFORM_EXPORT double                                      GetPointCloudTolerance() const;

    DGNPLATFORM_EXPORT void                                        SetPointCloudTolerance(double d);

    DGNPLATFORM_EXPORT bool                                        GetPointCloudProjectPoints() const;

    DGNPLATFORM_EXPORT void                                        SetPointCloudProjectPoints(bool d);

}; // VolumeDef

/*=================================================================================**/
struct VolumeDefCollection : public bvector<VolumeDefP>
    {


    }; // VolumeDefCollection

/*=================================================================================**/
struct IClipElementProvider : public RefCounted <IRefCounted>
    {
public:

    DGNPLATFORM_EXPORT StatusInt                    ToClipElement (EditElementHandleR clipEl, ElementHandleCP templateEH, size_t volumeIndex, DgnModelRefP clipModelRef, double zOffsetForClip) const;

    DGNPLATFORM_EXPORT StatusInt                    FromClipElement (ElementHandleCR clipEl, size_t volumeIndex, double zOffsetForClip, bool initViewMatrix, BoundedPlaneCP boundaryToGenerateIn);

    }; // IClipElementProvider

//=======================================================================================
//=======================================================================================
typedef RefCountedPtr<IClipElementProvider>         IClipElementProviderPtr;


/*=================================================================================**/
struct IHasClipElementProvider
    {
public: 

    DGNPLATFORM_EXPORT IClipElementProviderPtr              GetClipElementProvider ();

    }; // IHasClipElementProvider

/*=================================================================================**/
struct  IVolumeDefContainer
    {
public:
    DGNPLATFORM_EXPORT  VolumeDefP           AddVolumeDef ();

    DGNPLATFORM_EXPORT VolumeDefCollectionR  GetVolumeDefCollectionR ();

    DGNPLATFORM_EXPORT VolumeDefCollectionCR GetVolumeDefCollection () const;
    
    DGNPLATFORM_EXPORT VolumeDefP            GetVolumeDefAtIndex (size_t index);
    
    DGNPLATFORM_EXPORT size_t                GetNumberOfVolumeDefs ();
    
    DGNPLATFORM_EXPORT StatusInt             DeleteVolumeDefAtIndex (size_t index);
    }; // IVolumeDefContainer

/*=================================================================================**/
struct IPreserveUp
    {
    public:
    DGNPLATFORM_EXPORT void                         SetPreserveUp (bool);

    DGNPLATFORM_EXPORT bool                         GetPreserveUp () const;
    }; //IPreserveUp

/*=================================================================================**/
struct IFlipDirection
    {
    public:
    DGNPLATFORM_EXPORT bool                         GetFlipDirection () const;

    DGNPLATFORM_EXPORT void                         SetFlipDirection (bool flip);
    };//IFlipDirection

/*=================================================================================**/
struct ICreateGapProvider
    {
    };

struct SectionCalloutDef;

//=======================================================================================
//=======================================================================================
typedef RefCountedPtr<SectionCalloutDef>                    SectionCalloutDefPtr;

/*=================================================================================**/
struct SectionCalloutDef : IDetailingSymbol, IPreserveUp, IFlipDirection, IVolumeDefContainer
{
public:

    static DGNPLATFORM_EXPORT SectionCalloutDefPtr  Create (); 

    }; // SectionCalloutDef
struct DetailCalloutDef;

//=======================================================================================
//=======================================================================================
typedef RefCountedPtr<DetailCalloutDef>                    DetailCalloutDefPtr;

/*=================================================================================**/
struct DetailCalloutDef : IDetailingSymbol, IHasClipElementProvider
{


public:
    DGNPLATFORM_EXPORT void                         SetTopHeight (double topHeight);

    DGNPLATFORM_EXPORT double                       GetTopHeight () const;

    DGNPLATFORM_EXPORT void                         SetBottomHeight (double bottomHeight);

    DGNPLATFORM_EXPORT double                       GetBottomHeight () const;
    
    DGNPLATFORM_EXPORT bool                         GetHasAreaElement () const;
    
    DGNPLATFORM_EXPORT void                         SetAreaElement (ElementHandleCP areaEH);
    
    DGNPLATFORM_EXPORT void                         GetOrigin (DPoint3dR originOut) const;
    
    DGNPLATFORM_EXPORT void                         GetEnd (DPoint3dR endOut) const;
    
    static DGNPLATFORM_EXPORT DetailCalloutDefPtr   Create (); 
};
struct DetailCallout3DViewDef;

//=======================================================================================
//=======================================================================================
typedef RefCountedPtr<DetailCallout3DViewDef>                    DetailCallout3DViewDefPtr;

/*=================================================================================**/
struct DetailCallout3DViewDef : public DetailCalloutDef 
{
private:
    virtual void MakeClassAbstract() = 0;
public:

public:
    
    DGNPLATFORM_EXPORT double                               GetHeight () const;
    
    DGNPLATFORM_EXPORT void                                 SetHeight (double height);
    
    DGNPLATFORM_EXPORT double                               GetWidth () const;
    
    DGNPLATFORM_EXPORT void                                 SetWidth (double width);
    
    DGNPLATFORM_EXPORT double                               GetFrontDepth () const;
    
    DGNPLATFORM_EXPORT void                                 SetFrontDepth (double frontDepth);
    
    DGNPLATFORM_EXPORT double                               GetBackDepth () const;
    
    DGNPLATFORM_EXPORT void                                 SetBackDepth (double backDepth);
    
    DGNPLATFORM_EXPORT bool                                 GetCropMask (ClipVolumeCropProp  cropProp) const;
    
    DGNPLATFORM_EXPORT void                                 SetCropMask (ClipVolumeCropProp  cropProp, bool val);

    DGNPLATFORM_EXPORT double                                      GetPointCloudTolerance() const;

    DGNPLATFORM_EXPORT void                                        SetPointCloudTolerance(double d);

    DGNPLATFORM_EXPORT bool                                        GetPointCloudProjectPoints() const;

    DGNPLATFORM_EXPORT void                                        SetPointCloudProjectPoints(bool d);
    
    static DGNPLATFORM_EXPORT DetailCallout3DViewDefPtr     Create (); 

}; // DetailCallout3DViewDef

struct ElevationCalloutDef;

//=======================================================================================
//=======================================================================================
typedef RefCountedPtr<ElevationCalloutDef>                    ElevationCalloutDefPtr;

/*=================================================================================**/
struct ElevationCalloutDef : IDetailingSymbol, IPreserveUp, IVolumeDefContainer
{

public:

    static DGNPLATFORM_EXPORT ElevationCalloutDefPtr    Create (); 

}; // ElevationCalloutDef

struct InteriorElevationCalloutDef;

//=======================================================================================
//=======================================================================================
typedef RefCountedPtr<InteriorElevationCalloutDef>                    InteriorElevationCalloutDefPtr;

/*=================================================================================**/
struct InteriorElevationCalloutDef : ElevationCalloutDef
{
public:

    static DGNPLATFORM_EXPORT InteriorElevationCalloutDefPtr    Create (); 

}; // InteriorElevationCalloutDef
struct PlanCalloutDef;

//=======================================================================================
//=======================================================================================
typedef RefCountedPtr<PlanCalloutDef>                    PlanCalloutDefPtr;

/*=================================================================================**/
struct PlanCalloutDef : IDetailingSymbol, public IHasClipElementProvider, IFlipDirection, IVolumeDefContainer
{
public:

    static DGNPLATFORM_EXPORT PlanCalloutDefPtr         Create (); 

    };//PlanCalloutDef
struct TitleTextDef;

//=======================================================================================
//=======================================================================================
typedef RefCountedPtr<TitleTextDef>                    TitleTextDefPtr;

/*=================================================================================**/
struct TitleTextDef : IDetailingSymbol
{
public:

    static DGNPLATFORM_EXPORT TitleTextDefPtr     Create();

};

struct DrawingBoundaryDef;

//=======================================================================================
//=======================================================================================
enum class DrawingBoundaryUnderlineType
    {
    ByText  =   0,     
    ByDrawing,         
    FixedLength,       
    NoLine,            
    } ;

//=======================================================================================
//=======================================================================================
enum class DrawingBoundaryBubbleSideType
    {
    Left                 = 0,    
    Right,                       
    };

//=======================================================================================
//=======================================================================================
enum class DrawingBoundaryDisplayStatus
{
Hidden                 = 0,    
Visible,                       
};

//=======================================================================================
//=======================================================================================
typedef RefCountedPtr<DrawingBoundaryDef>                    DrawingBoundaryDefPtr;

/*=================================================================================**/
struct DrawingBoundaryDef : IDetailingSymbol
{
public:

    DGNPLATFORM_EXPORT bool                     GetBubbleOnLeft () const;

    DGNPLATFORM_EXPORT void                     SetBubbleOnLeft (bool bubbleOnLeft);

    DGNPLATFORM_EXPORT ElementRefP              GetAttachmentElement () const;

    DGNPLATFORM_EXPORT DgnAttachmentP           GetAttachment () const;
    
    DGNPLATFORM_EXPORT void                     SetDetailScale (double detailScale, bool updateBoundary);
    
    DGNPLATFORM_EXPORT double                   GetDetailScale () const;
    
    DGNPLATFORM_EXPORT void                     UpdatePropertiesFromReference (bool updateBoundary);
    
    DGNPLATFORM_EXPORT void                     UpdateDetailScaleForDummyDrawingBoundary ();

    DGNPLATFORM_EXPORT void                     GetBoundedPlane (BoundedPlaneR plane) const;

    DGNPLATFORM_EXPORT static DrawingBoundaryDefPtr Create (); 

    DGNPLATFORM_EXPORT void                     GetRange (DRange3dR range) const;
    
    DGNPLATFORM_EXPORT void                     SetUnderlineLength (double length);
    
    DGNPLATFORM_EXPORT double                   GetUnderlineLength () const;
    
    DGNPLATFORM_EXPORT DrawingBoundaryUnderlineType GetUnderlineType ()  const;

    DGNPLATFORM_EXPORT void                      SetBoundaryElement (ElementHandleCP el);

    DGNPLATFORM_EXPORT bool                      CanGenerateBoundaryElement ();

    DGNPLATFORM_EXPORT CurveVectorPtr            GetBoundaryCurveVector ();
}; // DrawingBoundaryDef
/*=================================================================================**/
struct          IDrawingTraverseOptions : public RefCountedBase
{
protected:

    virtual DgnModelRefP                        _GetModel () const = 0;

public:
    DGNPLATFORM_EXPORT DgnModelRefP             GetModel () const;

}; // IDrawingTraverseOptions

//=======================================================================================
//=======================================================================================
typedef RefCountedPtr<IDrawingTraverseOptions> IDrawingTraverseOptionsPtr;

/*=================================================================================**/
struct     IDrawingTraverseHandler
{
    DGNPLATFORM_EXPORT virtual IDrawingTraverseOptionsPtr          GetDrawingTraverseOptions () = 0;

    DGNPLATFORM_EXPORT virtual bool                                HandleDrawingTraverse (ElementHandleCR drawingEH) = 0;

    DGNPLATFORM_EXPORT virtual ~IDrawingTraverseHandler() {}

}; // IDrawingElementTraverseHandler
/*=================================================================================**/
struct DrawingManager
    {

public:

    static DGNPLATFORM_EXPORT bool                   FindDrawingByName(EditElementHandleR drawingEH, WStringCR name, bool partialMatch, IDrawingTraverseOptions& options);

    static DGNPLATFORM_EXPORT bool                   FindDrawingByIdentifier(EditElementHandleR drawingEH, WStringCR identifier, bool partialMatch, IDrawingTraverseOptions& options);

    static DGNPLATFORM_EXPORT StatusInt              GetDrawingName(WStringR name, ElementHandleCR drawingEH);
    
    static DGNPLATFORM_EXPORT StatusInt              GetDrawingIdentifier(WStringR identifier, ElementHandleCR drawingEH);

    static DGNPLATFORM_EXPORT StatusInt              GenerateUniqueDrawingIdentifier(WStringR identifierOut, WStringCR proposedIdentifier, DgnModelP model);

    static DGNPLATFORM_EXPORT StatusInt              GenerateUniqueDrawingName(WStringR nameOut, WStringCR proposedName, WStringCR namePrefix, DgnModelP model);

    static DGNPLATFORM_EXPORT StatusInt              GenerateUniqueDrawingName(WStringR nameOut, WStringCR proposedName, WStringCR namePrefix, DgnAttachmentCP ref);

    static DGNPLATFORM_EXPORT bool                   IsExistingIdentifier(WStringCR idStr, DgnModelP model);

    static DGNPLATFORM_EXPORT bool                   IsExistingName(WStringCR nameStr, DgnModelP model);

    static DGNPLATFORM_EXPORT IDrawingTraverseOptionsPtr  CreateTraverseOptions(DgnModelRefP modelToTraverse);

    static DGNPLATFORM_EXPORT bool                   TraverseElements(IDrawingTraverseHandler& handler);

    static DGNPLATFORM_EXPORT bool                   TraverseElementsInModel(IDrawingTraverseHandler& handler, DgnModelRefP model);

    static DGNPLATFORM_EXPORT bool                   IsDrawing(ElementHandleCR eh);

    static DGNPLATFORM_EXPORT StatusInt              GetDrawingBoundaryElementFromAttachment(EditElementHandleR drawingTitleElem, DgnAttachmentCR ref);

    static DGNPLATFORM_EXPORT DrawingBoundaryDefPtr     GetDrawingBoundaryFromAttachment(DgnAttachmentCR ref);

    static DGNPLATFORM_EXPORT bool                   HasDrawingBoundary(DgnAttachmentCR ref);

    static DGNPLATFORM_EXPORT StatusInt              ComputeBoundaryFromAttachment(DPoint3dR boundaryOrigin, DPoint3dR boundarySize, RotMatrixCR matrix, DgnAttachmentCR attachment);
    
    static DGNPLATFORM_EXPORT void                   ComputeMasterRefScaleFromAnnotationScale (double& masterScale, double& refScale, double const& refDetailScale, double& parentAnnotationScale);
    
    static    DGNPLATFORM_EXPORT void                   ComputeMasterRefScaleFromDetailScale (double& masterScale, double& refScale, double const& detailScale, double& parentAnnotationScale);
    
    static    DGNPLATFORM_EXPORT double                 ComputeEffectiveDetailScaleFactor (DgnModelRefP modelRef);

    }; // DrawingManager

//=======================================================================================
//=======================================================================================
typedef bvector<IDetailingSymbolFactory*>         VectorOfIDetailingSymbolFactories;

//=======================================================================================
//=======================================================================================
enum class CalloutVerticalExtent
    {
    FromView                 = 0,     
    FromModel                = 1,     
    UserDefined              = 2,     
    };

/*=================================================================================**/
struct DetailingSymbolManager
{
public:

    static    DGNPLATFORM_EXPORT bool                   IsValidDetailingSymbol (ElementHandleCR symbol);
    
    static    DGNPLATFORM_EXPORT IDetailingSymbolPtr    CreateDetailingSymbol (ElementHandleCR symbolEH);
    
    static    DGNPLATFORM_EXPORT IDetailingSymbolPtr    CreateDetailingSymbol (DetailingSymbolType type, bool is3d);
    
    static    DGNPLATFORM_EXPORT bool                   FindCellInLibs (WCharCP cellName);

    static    DGNPLATFORM_EXPORT StatusInt              ExtractNamedViewElement (EditElementHandleR viewEEH, DgnAttachmentCP ref);

    static    DGNPLATFORM_EXPORT StatusInt              GetIntersectingReferenceByRange (DgnAttachmentCP& viewModelRefOut, DgnAttachmentCP& intersectingModelRef, DgnModelRefCR modelRef, DRange3d& calloutRange);
    
    static    DGNPLATFORM_EXPORT StatusInt              GetIntersectingReferenceByDirection (DgnAttachmentCP& viewModelRefOut, DgnAttachmentCP& intersectingModelRef, DgnModelRefCR modelRef, DPoint3dCR origin, DVec3dCR direction);
    
    static    DGNPLATFORM_EXPORT StatusInt              ComputeCalloutClipExtentsFromModel (DRange3d& range, double* zOffsetForClipInViewModelUORs, RotMatrix const& rotationOnSheet, DgnModelRefCR drawingModelRef, bool ignoreClip = false);
    
    static    DGNPLATFORM_EXPORT StatusInt              ComputeCalloutClipBoundaryFromReference (IDetailingSymbol* def, double* zOffsetForClipInViewModelUORs,  CalloutVerticalExtent extentType, double viewBoundaryHeightInViewModelMU, DgnModelRefCR designModelRef, DgnModelRefCR activeModelRef, ViewportCP selectedViewPort);
    
    static    DGNPLATFORM_EXPORT StatusInt              ComputeHeightFromModelForDetail (IDetailingSymbol* def, double* zOffsetForClipInViewModelUORsOut, CalloutVerticalExtent extentType, double viewBoundaryHeightInViewModelMU, DgnModelRefCR designModelRef, DgnModelRefCR activeModelRef, ViewportCP selectedViewPort);
    
    static    DGNPLATFORM_EXPORT StatusInt              ComputeModelHeightForDetail (IDetailingSymbol* def, double* zOffsetForClipInViewModelUORsOut, CalloutVerticalExtent extentType, double viewBoundaryHeightInViewModelMU, DgnModelRefCR calloutModel, DgnModelRefCR activeModelRef, ViewportCP selectedViewPort);

    static    DGNPLATFORM_EXPORT void                   AddPartIdOnFields (EditElementHandleR symbolEEH);

    static    DGNPLATFORM_EXPORT StatusInt              GetZOffsetOfCallout (IDetailingSymbol* def, double* zOffsetForClipInViewModelUORs, DgnModelRefCP designModelRef);

    static    DGNPLATFORM_EXPORT StatusInt              CalculateElementRange (ElementHandleCR eh, DRange3dR range, TransformCP transform);
    
    static    DGNPLATFORM_EXPORT double                 GetClipPlaneOffset (ElementHandleCR clipEH, DgnModelRefP viewModelRef);

}; // DetailingSymbolManager

/*=================================================================================**/
struct CalloutBuilder
    {
public:
    static    DGNPLATFORM_EXPORT StatusInt                 CreateFromNamedView (EditElementHandleR calloutEEH, IDetailingSymbolPtr& def, ElementHandleCR namedViewEH, DgnModelR calloutModelRef, DgnAttachmentCP refFromNamedViewRootToCallout, BoundedPlaneCP calloutPlane, RotMatrixCP viewMatrix);

    static    DGNPLATFORM_EXPORT DetailingSymbolType       GetDetailingSymbolTypeFromNamedView (ElementHandleCR namedViewEH);

    }; // CalloutBuilder


/*=================================================================================**/
struct DrawingBoundaryBoundaryElementGenerator
    {
    public:
        DGNPLATFORM_EXPORT EditElementHandleP GernerateDrawingBoundaryBoundaryElement (EditElementHandleCR drawingtitleElement);
    };


END_BENTLEY_DGNPLATFORM_NAMESPACE