DetailingSymbolHandlers.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 <ECObjects/ECObjectsAPI.h>
#include "DetailingSymbol.h"

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

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

/*=================================================================================**/
struct     INamedViewCreateHelper : public RefCounted <IRefCounted>
{
protected:
virtual WString                             _GetViewNamePrefix () = 0;

virtual WString                             _GetViewType () = 0;

virtual bool                                _GetViewBaseName(WStringR baseName) { return false; }

public:
 DGNPLATFORM_EXPORT WString                  GetViewNamePrefix ();

 DGNPLATFORM_EXPORT WString                  GetViewType ();

 DGNPLATFORM_EXPORT bool                    GetViewBaseName (WStringR baseName);

};

//=======================================================================================
//=======================================================================================
typedef RefCountedPtr<INamedViewCreateHelper>        INamedViewCreateHelperPtr;

/*=================================================================================**/
struct          DetailingSymbolBaseHandler :    Type2Handler,
                                                ITextEdit,
                                                IDependencyHandler,
                                                IAnnotationHandler

{
    DEFINE_T_SUPER(Type2Handler)

protected:

virtual IDependencyHandler*                 _GetIDependencyHandler ()  override = 0;

virtual void                                _OnRootsChanged (ElementHandleR dependent, bvector<RootChange> const& rootsChanged, bvector<XAttributeHandle> const&  xAttrsAffected) override = 0;
protected:
virtual void                                _GetImageName (WStringR name) = 0;
}; // DetailingSymbolBaseHandler

//=======================================================================================
//=======================================================================================
enum class CalloutViewRelationCriteria
    {
    Generated,      
    Associated,     
    Both,           
    
    }; // CalloutViewRelationCriteria

//=======================================================================================
//=======================================================================================
enum class UpdateCalloutStatus
    {
    Success     = 0,
    Error       = 1,
    NoChange    = 2,

    }; // UpdateCalloutStatus

/*=================================================================================**/
struct          CalloutBaseHandler : DetailingSymbolBaseHandler, INamedViewCreateHelper
{
    DEFINE_T_SUPER(DetailingSymbolBaseHandler)

protected:
virtual StatusInt                          _OnPreprocessCopy (EditElementHandleR symbolEH, ElementCopyContextP ccP) override;

virtual void                               _OnRootsChanged (ElementHandleR dependent, bvector<RootChange> const& rootsChanged, bvector<XAttributeHandle> const&  xAttrsAffected) override;

virtual void                               _Draw (ElementHandleCR thisElm, ViewContextR context) override;

virtual void                               _OnAdded (ElementHandleP element) override;

virtual void                               _GetDescription (ElementHandleCR el, WString& descr, UInt32 desiredLength) override;
public:

 DGNPLATFORM_EXPORT static bool              IsCalloutDependantOnAttachment (ElementHandleCR calloutEH);

 DGNPLATFORM_EXPORT static DgnAttachmentCP   GetDgnAttachment (ElementHandleCR calloutEH);

 DGNPLATFORM_EXPORT static StatusInt         GetGeneratedViewName (WStringR viewName, ElementHandleCR calloutEH, int index = 0);

 DGNPLATFORM_EXPORT static StatusInt         CopyGeneratedView (EditElementHandleR viewEEH, EditElementHandleR calloutEEH);

 DGNPLATFORM_EXPORT static StatusInt         CopyAllGeneratedViews (EditElementHandleR calloutEEH);

 DGNPLATFORM_EXPORT static bool              IsGeneratedView (ElementHandleCR calloutEH, ElementHandleCR viewEH);

 DGNPLATFORM_EXPORT static bool              IsAssociatedView (ElementHandleCR calloutEH, ElementHandleCR viewEH);

 DGNPLATFORM_EXPORT static int               GetNumViews (ElementHandleCR calloutEH, CalloutViewRelationCriteria relation);

 DGNPLATFORM_EXPORT static StatusInt         GetView (EditElementHandleP viewEEH, ElementHandleCR calloutEH, size_t index, CalloutViewRelationCriteria relation, bool makeNamedViewModelReadWrite);

 DGNPLATFORM_EXPORT static bool              GetViewNamedGroupFromCallout (NamedGroupPtr* group, ElementHandleCR calloutEH);

}; // CalloutBaseHandler
/*=================================================================================**/
struct          SectionCalloutHandler : CalloutBaseHandler
{
    DEFINE_T_SUPER(CalloutBaseHandler)
    ELEMENTHANDLER_DECLARE_MEMBERS(SectionCalloutHandler, DGNPLATFORM_EXPORT)
}; // SectionCalloutHandler
/*=================================================================================**/
struct          ElevationCalloutHandler : CalloutBaseHandler
{
    DEFINE_T_SUPER(CalloutBaseHandler)
    ELEMENTHANDLER_DECLARE_MEMBERS(ElevationCalloutHandler, DGNPLATFORM_EXPORT)
}; // ElevationCalloutHandler
/*=================================================================================**/
struct    InteriorElevationCalloutHandler : ElevationCalloutHandler
{
        DEFINE_T_SUPER(ElevationCalloutHandler)
                ELEMENTHANDLER_DECLARE_MEMBERS(InteriorElevationCalloutHandler, DGNPLATFORM_EXPORT)


}; // InteriorElevationCalloutHandler
/*=================================================================================**/
struct    PlanCalloutHandler : CalloutBaseHandler
{
    DEFINE_T_SUPER(CalloutBaseHandler)
    ELEMENTHANDLER_DECLARE_MEMBERS(PlanCalloutHandler, DGNPLATFORM_EXPORT)
}; // 
/*=================================================================================**/
struct          DetailCalloutHandler : CalloutBaseHandler
{
    DEFINE_T_SUPER(CalloutBaseHandler)
    ELEMENTHANDLER_DECLARE_MEMBERS(DetailCalloutHandler, DGNPLATFORM_EXPORT)
};
/*=================================================================================**/
struct          DetailCallout3DViewHandler : DetailCalloutHandler
{
    DEFINE_T_SUPER(DetailCalloutHandler)
    ELEMENTHANDLER_DECLARE_MEMBERS(DetailCallout3DViewHandler, DGNPLATFORM_EXPORT)

}; // DetailCallout3DViewHandler
/*=================================================================================**/
struct          DrawingBoundaryHandler : DetailingSymbolBaseHandler
{
    DEFINE_T_SUPER(DetailingSymbolBaseHandler)
    ELEMENTHANDLER_DECLARE_MEMBERS(DrawingBoundaryHandler, DGNPLATFORM_EXPORT)
}; // DrawingBoundaryHandler
/*=================================================================================**/
struct          TitleTextHandler : DetailingSymbolBaseHandler
{
    DEFINE_T_SUPER(DetailingSymbolBaseHandler)
    ELEMENTHANDLER_DECLARE_MEMBERS(TitleTextHandler, DGNPLATFORM_EXPORT)
}; // TitleTextHandler
/*=================================================================================**/
struct DrawingBoundaryBuilder
{
public:
 DGNPLATFORM_EXPORT                          DrawingBoundaryBuilder (WStringCR name, DgnAttachmentCP attachment, DgnModelP rootModel);

 DGNPLATFORM_EXPORT                          DrawingBoundaryBuilder(WStringCR name, DgnAttachmentCP attachment, DgnModelP rootModel, WStringCR viewType);

 DGNPLATFORM_EXPORT                          DrawingBoundaryBuilder (WStringCR name, WStringCR type, DPoint3dCP titleOrigin, ElementHandleCR boundaryEH, DgnModelP rootModel);

 DGNPLATFORM_EXPORT                          DrawingBoundaryBuilder (WStringCR name, WStringCR type, DPoint3dCP titleOrigin, DPoint3dCR origin, DPoint3dCR size, DgnModelP rootModel);

 DGNPLATFORM_EXPORT void                     SetBubbleOnLeft (bool flag) {m_bubbleOnLeft = flag;}

DGNPLATFORM_EXPORT void                      SetDetailScale(double scale);


 DGNPLATFORM_EXPORT StatusInt                CreateAndWrite ();

}; // DrawingBoundaryBuilder


END_BENTLEY_DGNPLATFORM_NAMESPACE