DetailingsymbolStyleHelper.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/DetailingSymbol/detailingsymbolcore.r.h>
#include    <DgnPlatform/DetailingSymbol/detailingsymbol.h>

DGNPLATFORM_TYPEDEFS (DetailingSymbolStylePropMask)
DGNPLATFORM_TYPEDEFS (IDetailingSymbolStyleValidator)

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

//=======================================================================================
//=======================================================================================

typedef RefCountedPtr<DetailingSymbolStylePropMask>     DetailingSymbolStylePropMaskPtr;

typedef std::vector<IDetailingSymbolStyleValidator*>    VectorOfIDetailingSymbolStyleValidator;

//=======================================================================================
//=======================================================================================
enum class DetailSymbolStyleCellNameProperty
    {
    Invalid                         = 0,
    DetailCallout_MainTerminator,
    DrawingBoundary_MainTerminator,
    DrawingBoundary_Title,
    ElevationCallout_MainWing,
    InteriorElevationCallout_MainTerminator,
    InteriorElevationCallout_MainWing,
    PlanCallout_MainTerminator,
    PlanCallout_MainWing,
    PlanCallout_TailTerminator,
    PlanCallout_TailWing,
    SectionCallout_MainTerminator,
    SectionCallout_MainWing,
    SectionCallout_TailTerminator,
    SectionCallout_TailWing,
    TitleText_Title,
    ElevationCallout_MainTerminator
    };

//=======================================================================================
//=======================================================================================
enum class DetailSymbolStyleLineStyleProperty
    {
    Invalid                         = 0,
    DetailCallout_Leader,
    DetailCallout_MainTerminator,
    DrawingBoundary_MainTerminator,
    DrawingBoundary_Title,
    InteriorElevationCallout_MainTerminator,
    InteriorElevationCallout_MainWing,
    PlanCallout_Leader,
    PlanCallout_MainTerminator,
    PlanCallout_MainWing,
    ElevationCallout_MainTerminator,
    DetailCallout_DetailArea,
    ElevationCallout_MainWing,
    PlanCallout_TailTerminator,
    PlanCallout_TailWing,
    SectionCallout_Leader,
    SectionCallout_MainTerminator,
    SectionCallout_MainWing,
    SectionCallout_TailTerminator,
    SectionCallout_TailWing,
    TitleText_Title
    };

//=======================================================================================
//=======================================================================================
enum class DetailSymbolStyleColorProperty
    {
    Invalid                         = 0,
    DetailCallout_DetailArea,
    DetailCallout_Leader,
    DetailCallout_MainTerminator,
    DrawingBoundary_MainTerminator,
    DrawingBoundary_Title,
    ElevationCallout_MainTerminator,
    ElevationCallout_MainWing,
    InteriorElevationCallout_MainWing,
    PlanCallout_Leader,
    PlanCallout_MainTerminator,
    PlanCallout_MainWing,
    InteriorElevationCallout_MainTerminator,
    PlanCallout_TailWing,
    SectionCallout_Leader,
    PlanCallout_TailTerminator,
    SectionCallout_MainTerminator,
    SectionCallout_TailTerminator,
    SectionCallout_MainWing,
    SectionCallout_TailWing,
    TitleText_Title
    };

//=======================================================================================
//=======================================================================================
enum class DetailSymbolStyleLevelProperty
    {
    Invalid                         = 0,
    DetailCallout,
    DrawingBoundary,
    ElevationCallout,
    InteriorElevationCallout,
    PlanCallout,
    SectionCallout,
    TitleText
    };

//=======================================================================================
//=======================================================================================
enum class DetailSymbolStyleWeightProperty
    {
    Invalid                         = 0,
    DetailCallout_DetailArea,
    DetailCallout_Leader,
    DetailCallout_MainTerminator,
    DrawingBoundary_MainTerminator,
    DrawingBoundary_Title,
    ElevationCallout_MainTerminator,
    ElevationCallout_MainWing,
    InteriorElevationCallout_MainTerminator,
    InteriorElevationCallout_MainWing,
    PlanCallout_Leader,
    PlanCallout_MainTerminator,
    PlanCallout_MainWing,
    PlanCallout_TailTerminator,
    PlanCallout_TailWing,
    SectionCallout_Leader,
    SectionCallout_MainTerminator,
    SectionCallout_MainWing,
    SectionCallout_TailTerminator,
    SectionCallout_TailWing,
    TitleText_Title
    };

//=======================================================================================
//=======================================================================================
struct DetailingsymbolStyleHelper
{

    DGNPLATFORM_EXPORT static bool                              ApplySettings (IDetailingSymbol* def, ECN::IECInstanceCR propertyTree, DgnModelRefP modelRef);

    DGNPLATFORM_EXPORT static StatusInt                         SetElementColor (ECN::IECInstanceR dssInstance, WCharCP structAccessor, UInt32 elementColor, DgnFileR dgnFile);

    DGNPLATFORM_EXPORT static StatusInt                         AddDefaultDetailingStyleProperties (ECN::IECInstanceR dssInstance, DgnFileR dgnFile, LevelId levelId, int weight, UInt32 color, Int32 lineStyleId);

    DGNPLATFORM_EXPORT static StatusInt                         SetColorProperty (ECN::IECInstanceR dssInstance, DetailSymbolStyleColorProperty prop, UInt32 color, DgnFileR dgnFile);

    DGNPLATFORM_EXPORT static StatusInt                         SetLineStyleProperty (ECN::IECInstanceR dssInstance, DetailSymbolStyleLineStyleProperty prop, Int32 lineStyleId, DgnFileR dgnFile);

    DGNPLATFORM_EXPORT static StatusInt                         SetLevelProperty (ECN::IECInstanceR dssInstance, DetailSymbolStyleLevelProperty prop, LevelId levelId, DgnFileR dgnFile);

    DGNPLATFORM_EXPORT static StatusInt                         SetWeightProperty (ECN::IECInstanceR dssInstance, DetailSymbolStyleWeightProperty prop, int weight);

    DGNPLATFORM_EXPORT static StatusInt                         SetCellNameProperty (ECN::IECInstanceR dssInstance, DetailSymbolStyleCellNameProperty prop, WCharCP cellName);

    DGNPLATFORM_EXPORT static StatusInt                         SetAdditionalDrawingBoundaryProperties (ECN::IECInstanceR dssInstance, DrawingBoundaryBubbleSideType bubbleSide, double underLineLength, double underLineMargin, DrawingBoundaryUnderlineType ultype, DrawingBoundaryDisplayStatus displayAnnotation, DrawingBoundaryDisplayStatus displayBoundary);

    DGNPLATFORM_EXPORT static StatusInt                         GetColorProperty (UInt32& color, ECN::IECInstanceR dssInstance, DetailSymbolStyleColorProperty prop, DgnFileR dgnFile);

    DGNPLATFORM_EXPORT static StatusInt                         GetLineStyleProperty (Int32& lineStyleId, ECN::IECInstanceR dssInstance, DetailSymbolStyleLineStyleProperty prop, DgnFileR dgnFile);

    DGNPLATFORM_EXPORT static StatusInt                         GetLevelProperty (LevelId& levelId, ECN::IECInstanceR dssInstance, DetailSymbolStyleLevelProperty prop, DgnFileR dgnFile);

    DGNPLATFORM_EXPORT static StatusInt                         GetWeightProperty (int& weight, ECN::IECInstanceR dssInstance, DetailSymbolStyleWeightProperty prop);

    DGNPLATFORM_EXPORT static StatusInt                         GetCellNameProperty (WStringR cellName, ECN::IECInstanceR dssInstance, DetailSymbolStyleCellNameProperty prop);

    DGNPLATFORM_EXPORT static StatusInt                         GetAdditionalDrawingBoundaryProperties (DrawingBoundaryBubbleSideType& bubbleSide, double& underLineLength, double& underLineMargin, DrawingBoundaryUnderlineType& ultype, DrawingBoundaryDisplayStatus& displayAnnotation, DrawingBoundaryDisplayStatus& displayBoundary, ECN::IECInstanceR dssInstance);

    DGNPLATFORM_EXPORT static StatusInt                         GetDrawingBoundaryBubbleSideType (DrawingBoundaryBubbleSideType& bubbleSide, ECN::IECInstanceR dssInstance);

    DGNPLATFORM_EXPORT static StatusInt                         GetDrawingBoundaryUnderlineType (DrawingBoundaryUnderlineType& ultype, ECN::IECInstanceR dssInstance);

    DGNPLATFORM_EXPORT static StatusInt                         GetDrawingBoundaryUnderlineLength (double& underLineLength, ECN::IECInstanceR dssInstance);

    DGNPLATFORM_EXPORT static StatusInt                         GetDrawingBoundaryUnderlineMargin (double& underLineMargin, ECN::IECInstanceR dssInstance);

    DGNPLATFORM_EXPORT static StatusInt                         GetDrawingBoundaryDisplayAnnotation (DrawingBoundaryDisplayStatus& displayAnnotation, ECN::IECInstanceR dssInstance);

    DGNPLATFORM_EXPORT static StatusInt                         GetDrawingBoundaryDisplayBoundary (DrawingBoundaryDisplayStatus& displayBoundary, ECN::IECInstanceR dssInstance);

    DGNPLATFORM_EXPORT static StatusInt                         SetDrawingBoundaryBubbleSideType (ECN::IECInstanceR dssInstance, DrawingBoundaryBubbleSideType bubbleSide);

    DGNPLATFORM_EXPORT static StatusInt                         SetDrawingBoundaryUnderlineType (ECN::IECInstanceR dssInstance, DrawingBoundaryUnderlineType ultype);

    DGNPLATFORM_EXPORT static StatusInt                         SetDrawingBoundaryUnderlineLength (ECN::IECInstanceR dssInstance, double underLineLength);

    DGNPLATFORM_EXPORT static StatusInt                         SetDrawingBoundaryUnderlineMargin (ECN::IECInstanceR dssInstance, double underLineMargin);

    DGNPLATFORM_EXPORT static StatusInt                         SetDrawingBoundaryDisplayAnnotation (ECN::IECInstanceR dssInstance, DrawingBoundaryDisplayStatus displayAnnotation);

    DGNPLATFORM_EXPORT static StatusInt                         SetDrawingBoundaryDisplayBoundary (ECN::IECInstanceR dssInstance, DrawingBoundaryDisplayStatus displayBoundary);
};



END_BENTLEY_DGNPLATFORM_NAMESPACE