DisplayRules.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"
#include "Bentley/RefCounted.h"

#include <ECObjects/ECObjects.h>
#include <ECObjects/ECValue.h>
#include <ECObjects/ECExpressions.h>
#include <DgnPlatform/DgnModelRef.h>
#include <DgnPlatform/DgnCore.h>
#include <DgnPlatform/ElementHandle.h>
#include <DgnPlatform/DisplayRuleActions.h>

#include <Bentley/bvector.h>
#include <Bentley/WString.h>

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

typedef bvector<DisplayRulePtr>         DisplayRulePtrVector;

typedef bvector<DisplayRuleSetPtr>      DisplayRuleSetPtrVector;

typedef bvector<DisplayRuleSetCP>       DisplayRuleSetCPVector;


//=======================================================================================
//=======================================================================================
struct DisplayRule : public RefCountedBase
    {
    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT static DisplayRulePtr Create (WStringCR condition, bool stopIfTrue, DgnFileR dgnFile);

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT bool                 Equals (DisplayRuleCR displayRule) const;

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT bool                 IsEnabled () const;

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT void                 SetIsEnabled(bool enabled);

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT bool                 StopIfTrue () const;

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT void                 SetStopIfTrue (bool stopIfTrue);

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT WStringCR            GetCondition () const;

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT void                 SetCondition (WStringCR condition);

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT WStringCR            GetConditionDescription () const;

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT void                 SetConditionDescription (WStringCR conditionDescription);

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT DisplayRuleActionPtrVector& GetActions ();

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT DisplayRulePtr       Clone (DgnFileR dgnFile) const;

    }; // DisplayRule


//=======================================================================================
//=======================================================================================
struct DisplayRuleSet : public RefCountedBase
    {
    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT static DisplayRuleSetPtr Create (WStringCR name, DgnFileR dgnFile);

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT bool                 Equals (DisplayRuleSetCR displayRuleSet) const;

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT WStringCR            GetName () const;

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT void                 SetName (WStringCR name);

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT DgnFileR             GetDgnFileR () const;

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT DisplayRulePtrVector& GetDisplayRules ();

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT DisplayRulePtrVector const & GetDisplayRulesC () const;

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT DisplayRuleSetPtr    Clone (DgnFileR dgnFile) const;

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT bool                 IsUsedByDisplayStyle (DisplayStyleCR displayStyle) const;

    }; // DisplayRuleSet


END_BENTLEY_DGNPLATFORM_NAMESPACE