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

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
#define     HandlerId_DisplayFilter   22809 

/*=================================================================================**/
enum    DisplayFilterHandler_MinorId
    {
    DisplayFilterHandlerMinorId_Base          = 0,
    DisplayFilterHandlerMinorId_ViewXFlag     = 1,        // Uses base handler - but reserve this minorId for use as XAttributeId...
    DisplayFilterHandlerMinorId_ViewXInteger  = 2,        // Uses base handler - but reserve this minorId for use as XAttributeId...

    };  //  DisplayFilterHandler_SubTypes

enum DisplayFilterOpCode
    {
    DisplayFilterOpCode_And                     = 1,
    DisplayFilterOpCode_Or                      = 2,
    DisplayFilterOpCode_Not                     = 3,
    DisplayFilterOpCode_Parameter               = 4,
    DisplayFilterOpCode_ViewFlag                = 5,
    DisplayFilterOpCode_ViewXFlag               = 6,
    DisplayFilterOpCode_ViewSize                = 7,
    DisplayFilterOpCode_Level                   = 8,
    DisplayFilterOpCode_ViewAxisAngle           = 9,
    DisplayFilterOpCode_ViewXInteger            = 10,
    DisplayFilterOpCode_PresentationFormId      = 12,
    DisplayFilterOpCode_PresentationFormFlag    = 13,
    DisplayFilterOpCode_ViewContextFlag         = 14,

    DisplayFilterOpCode_MAX,
    };


//=======================================================================================
//=======================================================================================
struct  DisplayFilterHandlerId : public HandlerId
    {
    DisplayFilterHandlerId () : HandlerId(INVALID_ID, 0) { };
    DisplayFilterHandlerId (DisplayFilterHandler_MinorId minorId) : HandlerId ((UInt16) HandlerId_DisplayFilter, (UInt16) minorId) {}
    };


/*=================================================================================**/
struct DisplayFilterHandler 
    {
protected:
    virtual             bool        _DoConditionalDraw (ViewContextR viewContext, ElementHandleCP element, void const* data, size_t dataSize) const = 0;
    virtual             StatusInt   _OnTransform (TransformInfoCR transform, void* pData, size_t dataSize) const { return SUCCESS;  }
    virtual             bool        _IsEqual (void const* data, void const* rhsData, size_t dataSize, double distanceTolerance) const {return 0 == memcmp (data, rhsData, dataSize);}
    virtual             WString     _GetDumpString (void const* data, size_t dataSize, DgnModelP) const { return WString ("DisplayFilterHandler"); }

    virtual             void        _DoClone (void* data, size_t dataSize, ElementCopyContextR context) const { BeAssert(false && "this function is deprecated"); }
    virtual             void        _ProcessProperties(void* data, size_t dataSize, PropertyContextR context) const { }

public:
    DGNPLATFORM_EXPORT      bool        DoConditionalDraw (ViewContextR viewContext, ElementHandleCP element, void const* data, size_t dataSize) const;
    DGNPLATFORM_EXPORT      StatusInt   OnTransform (TransformInfoCR transform, void* pData, size_t dataSize) const;
    DGNPLATFORM_EXPORT      bool        IsEqual (void const* data, void const* rhsData, size_t dataSize, double distanceTolerance);
    DGNPLATFORM_EXPORT      WString     GetDumpString (void const* data, size_t dataSize, DgnModelP dgnModel) const;  
    DGNPLATFORM_EXPORT      void        ProcessProperties(void* data, size_t dataSize, PropertyContextR context) const;

    };  // DisplayFilterHandler

typedef bmap <DisplayFilterHandlerId, DisplayFilterHandlerP>        T_DisplayFilterHandlerMap;
typedef bmap <DisplayFilterOpCode, DisplayFilterHandlerP>           T_DisplayFilterOperatorHandlerMap;

/*=================================================================================**/
struct DisplayFilterHandlerManager
    {
private:
    T_DisplayFilterHandlerMap               m_handlerMap;
    T_DisplayFilterOperatorHandlerMap       m_operatorHandlerMap;

public:

    /*---------------------------------------------------------------------------------**/
    DGNPLATFORM_EXPORT static DisplayFilterHandlerManagerR     GetManager();

    /*---------------------------------------------------------------------------------**/
    DGNPLATFORM_EXPORT void                         RegisterHandler (DisplayFilterHandlerId id,  DisplayFilterHandlerR handler);
    DGNPLATFORM_EXPORT DisplayFilterHandlerP        GetHandler (DisplayFilterHandlerId id); 


    DGNPLATFORM_EXPORT void                         RegisterOperatorHandler (DisplayFilterOpCode opCode,  DisplayFilterHandlerR handler);
    DGNPLATFORM_EXPORT DisplayFilterHandlerP        GetOperatorHandler (DisplayFilterOpCode id); 


    };  // DisplayFilterHandlerManager                               


/*=================================================================================**/
struct DisplayFilterKey : RefCountedBase
    {
private:
    typedef bvector<struct DisplayFilterState*> T_States;

    T_States            m_states;

public:
    DGNPLATFORM_EXPORT    static  DisplayFilterKeyPtr   Create () { return new DisplayFilterKey(); }
    DGNPLATFORM_EXPORT            ~DisplayFilterKey();
    DGNPLATFORM_EXPORT    bool    Matches (ViewContextR viewContext, ElementHandleCP element) const;
    DGNPLATFORM_EXPORT    void    PushState (DisplayFilterHandlerId filterId, void const* data, size_t dataSize, bool state);
    bool    IsEmpty() { return m_states.empty(); }
    bool    Clear ()  { m_states.clear(); }
    bool operator < (DisplayFilterKey const& rhs); 

    };  //  DisplayFilterKey


END_BENTLEY_DGNPLATFORM_NAMESPACE