Handler.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

// Class has virtual function, but destructor is not virtual
#pragma warning (disable:4265)

#include "DgnPlatform.h"
#include "DgnCore.h"

DGNPLATFORM_TYPEDEFS        (ISubTypeHandlerQuery)
DGNPLATFORM_CLASS_TYPEDEFS  (Handler);

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct TransformInfo
{
private:
    Transform               m_trans;
    UInt32                  m_options;
    AnnotationScaleAction   m_annotationScaleAction;

    bool                    m_haveMirrorPlane;
    RotMatrix               m_mirrorPlane;
    double                  m_annotationScale;

public:
    DGNPLATFORM_EXPORT TransformInfo ();

    DGNPLATFORM_EXPORT explicit TransformInfo (TransformCR t);

    TransformCP GetTransform () const {return &m_trans;}

    TransformR GetTransformR () {return m_trans;}

    RotMatrixCP GetMirrorPlane () const {return m_haveMirrorPlane ? &m_mirrorPlane : NULL;}

    void SetMirrorPlane (RotMatrixCR mirrorPlane) {m_mirrorPlane = mirrorPlane, m_haveMirrorPlane = true;}

    void SetOptions (UInt32 options) {m_options = options;}

    UInt32 GetOptions () const {return m_options;}

    void SetAnnotationScaleAction (AnnotationScaleAction action) {m_annotationScaleAction = action;}

    AnnotationScaleAction GetAnnotationScaleAction () const {return m_annotationScaleAction;}

    void SetAnnotationScale (double annotationScale) {m_annotationScale = annotationScale;}

    double GetAnnotationScale () const {return m_annotationScale;}
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
enum class ExposeChildrenReason
{
    Query    = 200, 
    Edit     = 300, 
};


#define ELEMENTHANDLER_DECLARE_MEMBERS(__classname__,__exporter__) \
    public:    __exporter__ static __classname__& GetInstance();

#ifndef DOCUMENTATION_GENERATOR
#define ELEMENTHANDLER_EXTENSION_DECLARE_MEMBERS(__classname__,__exporter__) \
    private: __exporter__ static Token& z_Get##__classname__##Token();\
    public: static Bentley::BentleyStatus RegisterExtension  (HandlerR handler, __classname__& obj) {return obj.RegisterExt(handler,z_Get##__classname__##Token());}\
            static Bentley::BentleyStatus DropExtension      (HandlerR handler) {return DropExt(handler,z_Get##__classname__##Token());}\
            static __classname__* Cast              (HandlerR handler) {return (__classname__*) CastExt (handler,z_Get##__classname__##Token());}
#endif

#define ELEMENTHANDLER_EXTENSION_DEFINE_MEMBERS(__classname__) \
    Handler::Extension::Token& __classname__::z_Get##__classname__##Token(){static Handler::Extension::Token* s_token=0; if (0==s_token) s_token = NewToken(); return *s_token;}

/*=================================================================================**//*+===============+===============+===============+===============+===============+======*/


struct  ITransactionHandler;
struct  IDependencyHandler;
struct  IGeoCoordinateReprojectionHelper;
struct  IEnumerateAvailableHandlers;



/*=================================================================================**/
enum class SupportOperation
{
    Selection             = 0, // Can be part of selection set
    CellGroup             = 1, // Can be added to orphan cell group
    CellUnGroup           = 2, // Can be un-grouped...i.e. is orphan cell group
    TransientManipulators = 3, // Can support manipulators with transient elements
    CacheCutGraphics      = 4, // Should cache cut graphics (only called if notRenderable) Shared cell instances need to cache their own cuts.
    LineStyle             = 5, // Element type supports line styles
    CustomHilite          = 6, // Element handler wants to control it's hilited presentation, DrawContext won't setup override symbology.
};

/*=================================================================================**/
class EXPORT_VTABLE_ATTRIBUTE Handler : NonCopyableClass
{
public:

    /*=================================================================================**/
    struct Extension
    {
        friend class Handler;
        struct Token
        {
            friend struct Extension;
            private: Token () {}
        };

    //@cond DONTINCLUDEINDOC
    protected:
        BentleyStatus RegisterExt (Handler& handler, Token& extensionToken) {return handler.AddExtension(extensionToken, *this);}
        static BentleyStatus DropExt (Handler& handler, Token& extensionToken) {return handler.DropExtension(extensionToken);}
        static Extension* CastExt (Handler& handler, Token& extensionToken) {return handler.FindExtension(extensionToken);}
        static Token* NewToken () {return new Token();}
    //@endcond DONTINCLUDEINDOC
    };

private:
    DGNPLATFORM_EXPORT BentleyStatus AddExtension (Extension::Token&, Extension&);
    DGNPLATFORM_EXPORT BentleyStatus DropExtension (Extension::Token&);
    DGNPLATFORM_EXPORT Extension* FindExtension (Extension::Token&);

    struct ExtensionEntry;

    Handler*            m_superClass;
    ExtensionEntry*     m_extensions;
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

//@cond DONTINCLUDEINDOC
static Handler& z_GetHandlerInstance ();
DGNPLATFORM_EXPORT static Handler& GetInstance () {return z_GetHandlerInstance();}
//@endcond DONTINCLUDEINDOC



DGNPLATFORM_EXPORT DisplayHandlerP GetDisplayHandler ();

DGNPLATFORM_EXPORT ITransactionHandlerP GetITransactionHandler ();

DGNPLATFORM_EXPORT IDependencyHandlerP GetIDependencyHandler ();




DGNPLATFORM_EXPORT StatusInt ApplyTransform (EditElementHandleR element, TransformInfoCR transform);


DGNPLATFORM_EXPORT StatusInt FenceStretch (EditElementHandleR element, TransformInfoCR transform, FenceParamsP fp, FenceStretchFlags options);


DGNPLATFORM_EXPORT StatusInt FenceClip (ElementAgendaP inside, ElementAgendaP outside, ElementHandleCR element, FenceParamsP fp, FenceClipFlags options);

DGNPLATFORM_EXPORT void ConvertTo3d (EditElementHandleR eeh, double elevation);

DGNPLATFORM_EXPORT void ConvertTo2d (EditElementHandleR eeh, TransformCR flattenTrans, DVec3dCR flattenDir);


DGNPLATFORM_EXPORT void GetDescription (ElementHandleCR el, WStringR string, UInt32 desiredLength);

DGNPLATFORM_EXPORT void GetTypeName (WStringR string, UInt32 desiredLength);




DGNPLATFORM_EXPORT void QueryProperties (ElementHandleCR eh, PropertyContextR context);

DGNPLATFORM_EXPORT void EditProperties (EditElementHandleR eeh, PropertyContextR context);



DGNPLATFORM_EXPORT bool ExposeChildren (ElementHandleCR el, ExposeChildrenReason reason);


}; // Handler



END_BENTLEY_DGNPLATFORM_NAMESPACE