DisplayStyleManager.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 "ElementHandle.h"

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

#include <RmgrTools\Tools\rscdefs.r.h>


BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE



typedef RefCountedPtr<DisplayStyle> DisplayStylePtr;

typedef bvector<DisplayStyleCP> DisplayStyleCPVector;



//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
enum class DisplayStyleImportStatus
    {
    InvalidSourceIndex,        
    NotRemapped,               
    RemappedToExistingStyle,   
    RemappedToNewStyle         
    
    }; // DisplayStyleImportStatus

/*=================================================================================**/
enum class DisplayStyleBuiltInUsage
    {
    View       = 0,    
    ClipVolume = 1     
    
    }; // DisplayStyleBuiltInUsage

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
enum class DisplayStyleApplyValidity
    {
    CanBeApplied,         
    NonWireframeForSheet, 
    ShadowedOn2DModel,    
    NotValidForHandler,   
    
    }; // DisplayStyleApplyValidity

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
enum class DisplayStyleSource
    {
    File,            
    HardCodedDefault 
    
    }; // DisplayStyleSource

/*=================================================================================**/
enum SpecialDisplayStyleIndex ENUM_UNDERLYING_TYPE(int)
    {
    SpecialDisplayStyleIndex_None           = -1,   
    SpecialDisplayStyleIndex_FromParent     = -2    
    
    }; // SpecialDisplayStyleIndex

/*=================================================================================**/
enum class EnvironmentDisplay
    {
    Color        = 0,
    Luxology     = 1,
    };


//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct DisplayStyleFlags
    {
    public: unsigned    m_displayMode               :6;     
    public: unsigned    m_displayVisibleEdges       :1;     
    public: unsigned    m_displayHiddenEdges        :1;     
    public: unsigned    m_hiddenEdgeLineStyle       :3;     
    public: unsigned    m_displayShadows            :1;     
    public: unsigned    m_legacyDrawOrder           :1;     
    public: unsigned    m_overrideBackgroundColor   :1;     
    public: unsigned    m_applyEdgeStyleToLines     :1;     
    public: unsigned    m_ignoreGeometryMaps        :1;     
    public: unsigned    m_ignoreImageMaps           :1;     
    public: unsigned    m_hideInPickers             :1;     
    public: unsigned    m_invisibleToCamera         :1;     
    public: unsigned    m_displayGroundPlane        :1;     

    unsigned            m_unused                    :12;

    public: DGNPLATFORM_EXPORT  DisplayStyleFlags   ();
    public: DGNPLATFORM_EXPORT  ~DisplayStyleFlags  ();

    public: DGNPLATFORM_EXPORT bool Equals (DisplayStyleFlagsCR rhs) const;

    inline void SetDisplayMode (MSRenderMode value) {m_displayMode = static_cast<UInt32>(value);}

    }; // DisplayStyleFlags

/*=================================================================================**/
struct ViewDisplayOverrides
    {

    struct  OverrideFlags
        {
        public: unsigned    m_visibleEdgeColor    :1;   
        public: unsigned    m_visibleEdgeWeight   :1;   
        public: unsigned    m_useTransparency     :1;   
        public: unsigned    m_elementColor        :1;   
        public: unsigned    m_lineStyle           :1;   
        public: unsigned    m_lineWeight          :1;   
        public: unsigned    m_material            :1;   
        public: unsigned    m_visibleEdgeStyle    :1;   
        public: unsigned    m_hiddenEdgeStyle     :1;   
        public: unsigned    m_hiddenEdgeWeightZero:1;   
        public: unsigned    m_hLineTransparency   :1;   
        public: unsigned    m_hLineMaterialColors :1;   
        public: unsigned    m_smoothIgnoreLights  :1;   
        public: unsigned    m_useDisplayHandler   :1;   
        public: unsigned    m_unused             :18;
        };

    public: OverrideFlags   m_flags;
    public: UInt32          m_visibleEdgeColor;         
    public: UInt32          m_visibleEdgeWeight;        
    public: UInt32          m_hiddenEdgeWeight;         
    public: double          m_transparency;             
    public: UInt32          m_elementColor;             
    public: UInt32          m_lineStyle;                
    public: UInt32          m_lineWeight;               
    public: ElementId       m_material;                 
    public: UInt32          m_backgroundColor;          

    public: double          m_hLineTransparencyThreshold;
         
    enum
        {
        HiddenEdgeWeight_SameAsVisible = 0xffff
        };

public:                   
    DGNPLATFORM_EXPORT  ViewDisplayOverrides    ();
    DGNPLATFORM_EXPORT  ~ViewDisplayOverrides   ();

    DGNPLATFORM_EXPORT void                            SetDisplayStyleHandlerP (struct DisplayStyleHandler const* handler);

    DGNPLATFORM_EXPORT void                             SetDisplayStyleHandlerSettingsPtr (RefCountedPtr<struct DisplayStyleHandlerSettings> settings); 

    /*---------------------------------------------------------------------------------**/
    DGNPLATFORM_EXPORT void                             ResolveDisplayStyleHandler () const;
   
    DGNPLATFORM_EXPORT void                             SetDisplayStyleHandlerById (XAttributeHandlerId id);
    
    DGNPLATFORM_EXPORT DisplayStyleHandler const*       GetDisplayStyleHandlerCP() const;
    
    DGNPLATFORM_EXPORT  XAttributeHandlerId             GetDisplayStyleHandlerId () const;
    
    DGNPLATFORM_EXPORT DisplayStyleHandlerSettingsPtr GetDisplayStyleHandlerSettingsPtr () const;

    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT ViewDisplayOverrides Clone (DgnFileR sourceDgnFile, DgnFileR destinationDgnFile) const;
    
    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT bool Equals (ViewDisplayOverridesCR rhs) const;
    
    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT bool Equals (ViewDisplayOverridesCR rhs, DgnFileR sourceDgnFile, DgnFileR rhsDgnFile) const;
    
    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT bool AreFlagsEqual (ViewDisplayOverridesCR rhs) const;
    
    /*---------------------------------------------------------------------------------**/
    public: DGNPLATFORM_EXPORT void ExtractMaterialPaletteAndName (WStringR paletteName, WStringR materialName, DgnFileR dgnFile) const;


    /*---------------------------------------------------------------------------------**/
    public:   bool HiddenEdgeWeightSameAsVisible () const { return HiddenEdgeWeight_SameAsVisible == m_hiddenEdgeWeight; }
    }; // ViewDisplayOverrides

/*=================================================================================**/
CLRPUBLIC struct DisplayStyleGroundPlane
    {
    friend struct           DisplayStyle;

private:
    RgbFactor               m_color;
    double                  m_height;       // stored in meters
    double                  m_transparency;
    bool                    m_showGroundFromBelow;

public:
    DGNPLATFORM_EXPORT DisplayStyleGroundPlane ();

    DGNPLATFORM_EXPORT   void                Clone (DisplayStyleGroundPlane const& rhs);

    DGNPLATFORM_EXPORT   bool                Equals (DisplayStyleGroundPlane const& rhs) const;
    
    DGNPLATFORM_EXPORT   RgbFactor const&    GetGroundColor () const;

    DGNPLATFORM_EXPORT   void                SetGroundColor (RgbFactor const& color);

    DGNPLATFORM_EXPORT   double              GetHeight () const;

    DGNPLATFORM_EXPORT   void                SetHeight (double height);
    
    DGNPLATFORM_EXPORT   double              GetTransparency () const;

    DGNPLATFORM_EXPORT   void                SetTransparency (double transparency);

    DGNPLATFORM_EXPORT   bool                ShowGroundFromBelow () const;

    DGNPLATFORM_EXPORT   void                SetShowGroundFromBelow (bool showGroundFromBelow);

    };

typedef DisplayStyleGroundPlane*                        DisplayStyleGroundPlaneP;
typedef DisplayStyleGroundPlane const*                  DisplayStyleGroundPlaneCP;
typedef DisplayStyleGroundPlane&                        DisplayStyleGroundPlaneR;
typedef DisplayStyleGroundPlane const&                  DisplayStyleGroundPlaneCR;

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
CLRPUBLIC struct DisplayStyle : public RefCountedBase
    {
private:
    virtual void MakeClassAbstract() = 0;
public:

    public: DGNPLATFORM_EXPORT static DisplayStylePtr Create (DgnFileR dgnFile, WCharCP name);

    public: DGNPLATFORM_EXPORT DisplayStylePtr Clone () const;
    
    public: DGNPLATFORM_EXPORT DisplayStylePtr Clone (DgnFileR destinationDgnFile) const;
    
    public: DGNPLATFORM_EXPORT DisplayStylePtr Clone (DgnFileR destinationDgnFile, WCharCP newName) const;
    
    public: DGNPLATFORM_EXPORT bool Equals (DisplayStyleCR rhs) const;
    
    public: DGNPLATFORM_EXPORT bool Equals (DisplayStyleCR rhs, bool testSettingsOnly) const;
    
    public: DGNPLATFORM_EXPORT DgnFileR GetFileR () const;
    
    public: DGNPLATFORM_EXPORT bool IsInFile (DgnFileR dgnFile) const;
    
    public: DGNPLATFORM_EXPORT int GetIndex () const;
    
    public: DGNPLATFORM_EXPORT WStringCR GetName () const;
    
    public: DGNPLATFORM_EXPORT MSRenderMode GetDisplayMode () const;
    
    public: DGNPLATFORM_EXPORT void SetDisplayMode (MSRenderMode newDisplayMode);
    
    public: DGNPLATFORM_EXPORT bool IsFromFile () const;
    
    public: DGNPLATFORM_EXPORT bool IsFromHardCodedDefault () const;
    
    public: DGNPLATFORM_EXPORT DisplayStyleFlagsCR GetFlags () const;
    
    public: DGNPLATFORM_EXPORT DisplayStyleFlagsR GetFlagsR ();
    
    public: DGNPLATFORM_EXPORT void SetFlags (DisplayStyleFlagsCR newFlags);
    
    public: DGNPLATFORM_EXPORT ViewDisplayOverridesCR GetOverrides () const;
    
    public: DGNPLATFORM_EXPORT ViewDisplayOverridesR GetOverridesR ();
    
    public: DGNPLATFORM_EXPORT void SetOverrides (ViewDisplayOverridesCR newOverrides, DgnFileR sourceDgnFile);
    
    public: MSCORE_EXPORT WString GetIconName () const;
    
    public: DGNPLATFORM_EXPORT bool IsUsableForViews () const;
    
    public: DGNPLATFORM_EXPORT void SetIsUsableForViews (bool isValid);
    
    public: DGNPLATFORM_EXPORT bool IsUsableForClipVolumes () const;
    
    public: DGNPLATFORM_EXPORT void SetIsUsableForClipVolumes (bool isValid);
    
    public: DGNPLATFORM_EXPORT bool MatchesViewInfoData (ViewInfoCR viewInfo) const;
    
    public: DGNPLATFORM_EXPORT bool IsValidForViewport (ViewportCR viewport) const;
    
    public: DGNPLATFORM_EXPORT bool IsValidForViewport (ViewportCR viewport, DisplayStyleApplyValidity* applyValidity) const;
    
    public: DGNPLATFORM_EXPORT void CopySettingsTo (ViewInfoR viewInfo, DgnFileR destinationDgnFile) const;
    
    public: DGNPLATFORM_EXPORT WStringCR GetEnvironmentName () const;

    public: DGNPLATFORM_EXPORT void      SetEnvironmentName (WCharCP environmentName);

    public: DGNPLATFORM_EXPORT EnvironmentDisplay GetEnvironmentTypeDisplayed () const;

    public: DGNPLATFORM_EXPORT void      SetEnvironmentTypeDisplayed (EnvironmentDisplay typeDisplayed);

    public: DGNPLATFORM_EXPORT DisplayStyleGroundPlaneCR  GetGroundPlane () const;

    public: DGNPLATFORM_EXPORT DisplayStyleGroundPlaneP   GetGroundPlaneP ();

    //\ param[in] the object of DgnFileR 
    public: DGNPLATFORM_EXPORT StatusInt EnsureDisplayStyleHandler (DgnFileR) const;
    
    }; // DisplayStyle

//=======================================================================================
// When creating a list of display styles, some styles may not be provided due to their options or configuration. These flags allow you to customize which styles are provided.
// @bsiclass                                                     Bentley Systems
//=======================================================================================
enum DisplayStyleListOptions
    {
    DISPLAY_STYLE_LIST_OPTIONS_IncludeHiddenForPickers  = 1 << 0,   
    
    DISPLAY_STYLE_LIST_OPTIONS_Default                  = 0,        
    DISPLAY_STYLE_LIST_OPTIONS_IncludeAll               = 0xffff    
    
    }; // DisplayStyleListOptions

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct DisplayStyleList : DisplayStyleCPVector
    {

    public: MSCORE_EXPORT static DisplayStyleList CreateFullList (DisplayStyleListOptions);
    
    public: MSCORE_EXPORT static DisplayStyleList CreateFullList (DgnFileR dgnFile, DisplayStyleListOptions);
    
    public: DGNPLATFORM_EXPORT static DisplayStyleList CreateForFile (DgnFileR dgnFile, DisplayStyleListOptions);
    
    public: MSCORE_EXPORT static DisplayStyleList CreateForDgnLibs (DisplayStyleListOptions);

    public: DGNPLATFORM_EXPORT bool ContainsDisplayStyle (WCharCP styleName) const;
    
    public: DGNPLATFORM_EXPORT DisplayStyleCP FindDisplayStyleByName (WCharCP styleName) const;
    
    }; // DisplayStyleList


//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct DisplayStyleManager
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
    
    public: DGNPLATFORM_EXPORT static DisplayStyleCP GetDisplayStyleForViewInfo (ViewInfoCR viewInfo);
    
    public: DGNPLATFORM_EXPORT static DisplayStyleCP GetDisplayStyleByIndex (DisplayStyleList::size_type index, DgnFileR dgnFile);
    
    public: MSCORE_EXPORT static DisplayStyleCP FindDisplayStyleByName (WCharCP styleName, DgnFileP dgnFile);
    
    public: MSCORE_EXPORT static int GetIndexForDisplayStyle (WCharCP styleName, DgnFileP dgnFile);
    
    public: DGNPLATFORM_EXPORT static DisplayStyleCP EnsureDisplayStyleIsInFile (DisplayStyleCR displayStyle, DgnFileR destinationDgnFile);
    
    public: DGNPLATFORM_EXPORT static DisplayStyleCP WriteDisplayStyleToFile (DisplayStyleCR displayStyle, DgnFileR destinationDgnFile);
    
    public: DGNPLATFORM_EXPORT static DisplayStyleCP CopyDisplayStyleToFile (WCharCP styleName, DgnFileR sourceDgnFile, DgnFileR destinationDgnFile);
    
    public: DGNPLATFORM_EXPORT static void RemoveDisplayStyleFromFile (WCharCP styleName, DgnFileR dgnFile);
    
    public: DGNPLATFORM_EXPORT static void RenameDisplayStyleInFile (WCharCP originalName, WCharCP newName, DgnFileR dgnFile);
    
    public: MSCORE_EXPORT static bool DoesDisplayStyleExistInDgnLibs (WCharCP styleName);
    
    public: DGNPLATFORM_EXPORT static bool DoesDisplayStyleExistInFile (WCharCP styleName, DgnFileR dgnFile);
    
    public: DGNPLATFORM_EXPORT static DisplayStyleImportStatus ImportDisplayStyle (DgnFileR sourceDgnFile, DgnFileR destinationDgnFile, int sourceIndex, int& destinationIndex);

    public: DGNPLATFORM_EXPORT static BentleyStatus ApplyDisplayStyleToView (DisplayStyleCR, ViewInfoR);

    }; //DisplayStyleManager


END_BENTLEY_DGNPLATFORM_NAMESPACE