DimensionStyle.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 "ElementHandle.h"
#include "Tools/BitMask.h"
#include "DimensionStyleProps.r.h"
#include <RmgrTools/Tools/msstrlst.h>

DGNPLATFORM_TYPEDEFS (DimensionStyle)
DGNPLATFORM_TYPEDEFS (DimStylePropMask)
DGNPLATFORM_TYPEDEFS (DimStyleIterator)


#include "DgnPlatform/DgnTextStyle.h"

#define DIMSTYLE_COMPAREOPTS_Default            (0)
#define DIMSTYLE_COMPAREOPTS_IgnoreUnusedDiffs  (0x0001 << 1)

#define DIMSTYLE_COMPAREOPTS_UserInterface      DIMSTYLE_COMPAREOPTS_IgnoreUnusedDiffs

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

struct DimensionHandler;
struct DimStyleEntryHandler;
struct DimStyleTableHandler;
struct NoteCellHeaderHandler;
typedef RefCountedPtr<DimensionStyle>   DimensionStylePtr;
typedef RefCountedPtr<DimStylePropMask> DimStylePropMaskPtr;
typedef RefCountedPtr<DimStyleIterator> DimStyleIteratorPtr;


/*=================================================================================**/
struct     IDimStyleTransactionListener
{
    virtual void   _OnDimStyleChange (DimensionStyleCP before, DimensionStyleCP after, StyleEventType type, StyleEventSource source) = 0;
};

/*=================================================================================**/
struct     DimStyleEvents : IDimStyleTransactionListener
{
};

/*=================================================================================**/
CLRPUBLIC struct DimensionStyle : RefCountedBase
{
    friend class  CDimensionStyle;  //  VBA use ToDgnDimStyle
    friend struct DimStyleIterator;
    friend struct DimensionHandler;
    friend struct DimStyleEntryHandler;
    friend struct DimStyleTableHandler;
    friend struct NoteCellHeaderHandler;
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    typedef DimStylePropMaskPtr PropertyMaskPtr;

    DGNPLATFORM_EXPORT static DimensionStylePtr      Create (WCharCP name, DgnFileR file);

    DGNPLATFORM_EXPORT static DimensionStylePtr      GetByName (WCharCP name, DgnFileR file);

    DGNPLATFORM_EXPORT static DimensionStylePtr      GetByID (ElementId elemID, DgnFileR file);

    DGNPLATFORM_EXPORT static DimensionStylePtr      GetSettings (DgnFileR file);

    DGNPLATFORM_EXPORT static BentleyStatus          ReplaceSettings (DimensionStyleR settings, DgnFileR file);

    DGNPLATFORM_EXPORT static bvector<DimensionStylePtr>    BuildList (DgnFileR file);

    DGNPLATFORM_EXPORT BentleyStatus         Add (DgnFileP file = NULL);

    DGNPLATFORM_EXPORT BentleyStatus         Replace (WCharCP oldName = NULL, DgnFileP file = NULL);

    DGNPLATFORM_EXPORT static BentleyStatus  Delete (WCharCP name, DgnFileR file);

    DGNPLATFORM_EXPORT bool                  HasDependants() const;

    DGNPLATFORM_EXPORT static BentleyStatus RemapDependents (WCharCP destStyle, WCharCP sourceStyle, DgnFileR file);

    DGNPLATFORM_EXPORT StatusInt             GetUnitsProp (UnitDefinitionP master, UnitDefinitionP sub, DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt             SetUnitsProp (UnitDefinitionCR master, UnitDefinitionCR sub, DimStyleProp iProp);

    DGNPLATFORM_EXPORT WStringCR             GetName () const;

    DGNPLATFORM_EXPORT ElementId             GetID () const;

    DGNPLATFORM_EXPORT DgnFileP              GetFile () const;

    DGNPLATFORM_EXPORT UInt32                GetTextStyleId () const;

    DGNPLATFORM_EXPORT DimensionStylePtr     Copy () const;

    DGNPLATFORM_EXPORT void                  CopyValues (DimensionStyleCR source);

    DGNPLATFORM_EXPORT BentleyStatus         SetName (WCharCP newName);

    DGNPLATFORM_EXPORT DimStylePropMaskPtr   Compare (DimensionStyleCR otherStyle, UInt32 compareOpts = DIMSTYLE_COMPAREOPTS_Default) const;

    DGNPLATFORM_EXPORT StatusInt             ConvertToFile (DgnFileR file);

    DGNPLATFORM_EXPORT double GetUorScale (DgnModelR destModel) const;

    DGNPLATFORM_EXPORT StatusInt     GetAccuracyProp     (byte&              valueOut,   DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     GetBooleanProp      (bool&              valueOut,   DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     GetCharProp         (UShort&            valueOut,   DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     GetDoubleProp       (double&            valueOut,   DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     GetDistanceProp     (double&            valueOut,   DimStyleProp iProp, DgnModelP dgnModel) const;

    DGNPLATFORM_EXPORT StatusInt     GetIntegerProp      (int&               valueOut,   DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     GetLevelProp        (LevelId&           valueOut,   DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     GetStringProp       (WStringR           valueOut,   DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     GetFontProp         (UInt32&            valueOut,   DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     GetColorProp        (UInt32&            valueOut,   DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     GetWeightProp       (UInt32&            valueOut,   DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     GetLineStyleProp    (Int32&             valueOut,   DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     GetOneUnitProp      (UnitDefinitionR    valueOut,   DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     GetTextStyleProp    (DgnTextStylePtr&   valueOut,   DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     GetTemplateFlagProp (UShort&    valueOut, DimensionType dimensionType, DimStyleProp iProp) const;

    DGNPLATFORM_EXPORT StatusInt     SetAccuracyProp     (byte               valueIn,    DimStyleProp iProp);

    DGNPLATFORM_EXPORT StatusInt     SetBooleanProp      (bool               valueIn,    DimStyleProp iProp);

    DGNPLATFORM_EXPORT StatusInt     SetCharProp         (UShort             valueIn,    DimStyleProp iProp);

    DGNPLATFORM_EXPORT StatusInt     SetDoubleProp       (double             valueIn,    DimStyleProp iProp);

    DGNPLATFORM_EXPORT StatusInt     SetDistanceProp     (double             valueIn,    DimStyleProp iProp, DgnModelP dgnModel);

    DGNPLATFORM_EXPORT StatusInt     SetIntegerProp      (int                valueIn,    DimStyleProp iProp);

    DGNPLATFORM_EXPORT StatusInt     SetLevelProp        (LevelId            valueIn,    DimStyleProp iProp);

    DGNPLATFORM_EXPORT StatusInt     SetStringProp       (WCharCP            valueIn,    DimStyleProp iProp);

    DGNPLATFORM_EXPORT StatusInt     SetFontProp         (UInt32             valueIn,    DimStyleProp iProp);

    DGNPLATFORM_EXPORT StatusInt     SetColorProp        (UInt32             valueIn,    DimStyleProp iProp);

    DGNPLATFORM_EXPORT StatusInt     SetWeightProp       (UInt32             valueIn,    DimStyleProp iProp);

    DGNPLATFORM_EXPORT StatusInt     SetLineStyleProp    (Int32              valueIn,    DimStyleProp iProp);

    DGNPLATFORM_EXPORT StatusInt     SetOneUnitProp      (UnitDefinitionCR   valueIn,    DimStyleProp iProp);

    DGNPLATFORM_EXPORT StatusInt     SetTextStyleProp    (DgnTextStyleCR     valueIn,    DimStyleProp iProp);

    DGNPLATFORM_EXPORT StatusInt     SetTemplateFlagProp (UShort     valueIn,  DimensionType dimensionType, DimStyleProp iProp);

    MSCORE_EXPORT static DimensionStylePtr      GetActive ();

    MSCORE_EXPORT static BentleyStatus          SetActive (DimensionStyleR dimStyle);

    MSCORE_EXPORT static DimensionStylePtr      GetByName (WCharCP name, StyleIteratorMode mode);

    MSCORE_EXPORT static bvector<DimensionStylePtr> BuildList (StyleIteratorMode mode);

    MSCORE_EXPORT static void                   AddListener (DimStyleEvents& handler);

    MSCORE_EXPORT static void                   DropListener (DimStyleEvents& handler);

};

struct DimStyleCollection;
/*=================================================================================**/
struct DimStyleIterator : std::iterator<std::forward_iterator_tag, DimensionStyleP const>
{
private:
    friend struct DimStyleCollection;
    DgnPlatform::ChildElemIter  m_elemIter;
    mutable DimensionStylePtr   m_current;
    
    DimStyleIterator (DgnFileP file);

    bool ElemIterIsNamedStyle ();

public:
    DGNPLATFORM_EXPORT DimStyleIterator ();                                                     
    DGNPLATFORM_EXPORT DimStyleIterator&        operator ++();                                  
    DGNPLATFORM_EXPORT DimensionStyleP const&   operator *() const;                             
    DGNPLATFORM_EXPORT bool                     operator == (DimStyleIterator const &) const;   
    DGNPLATFORM_EXPORT bool                     operator != (DimStyleIterator const &) const;   
    DGNPLATFORM_EXPORT bool                     IsValid () const;                               
};

/*=================================================================================**/
struct DimStyleCollection
{
private:
    RefCountedPtr<DgnFile> m_dgnFile;

public:
    
    DGNPLATFORM_EXPORT DimStyleCollection (DgnFileR file);
    
    typedef DimStyleIterator const_iterator;
    typedef const_iterator iterator;    

    DGNPLATFORM_EXPORT DimStyleIterator begin () const;

    DGNPLATFORM_EXPORT DimStyleIterator end () const;
};

/*=================================================================================**/
CLRPUBLIC struct DimStylePropMask : RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public: 
    DGNPLATFORM_EXPORT static  DimStylePropMaskPtr CreatePropMask ();

    DGNPLATFORM_EXPORT void      From (DimStylePropMaskCR);

    DGNPLATFORM_EXPORT bool      AnyBitSet () const;

    DGNPLATFORM_EXPORT void      ClearAllBits ();

    DGNPLATFORM_EXPORT StatusInt SetPropertyBit (DimStyleProp dimStyleProp, bool bitValue);

    DGNPLATFORM_EXPORT StatusInt SetTemplateBit (DimStyleProp dimStyleProp, bool bitValue, DimensionType dimensionType);

    DGNPLATFORM_EXPORT bool      GetPropertyBit (DimStyleProp dimStyleProp) const;

    DGNPLATFORM_EXPORT bool      GetTemplateBit (DimStyleProp dimStyleProp, DimensionType dimensionType) const;

}; // DimensionStylePropMask


END_BENTLEY_DGNPLATFORM_NAMESPACE