DetailingsymbolStyleHelper.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------------------+
2 |
3 | Supplied under applicable software license agreement.
4 |
5 | Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
6 |
7 +---------------------------------------------------------------------------------------*/
8 #pragma once
11 
12 DGNPLATFORM_TYPEDEFS (DetailingSymbolStylePropMask)
13 DGNPLATFORM_TYPEDEFS (IDetailingSymbolStyleValidator)
14 
16 
17 //=======================================================================================
20 //=======================================================================================
21 
22 typedef RefCountedPtr<DetailingSymbolStylePropMask> DetailingSymbolStylePropMaskPtr;
23 
24 typedef std::vector<IDetailingSymbolStyleValidator*> VectorOfIDetailingSymbolStyleValidator;
25 
26 //=======================================================================================
30 //=======================================================================================
32  {
33  Invalid = 0,
50  };
51 
52 //=======================================================================================
54 //=======================================================================================
56  {
57  Invalid = 0,
78  };
79 
80 //=======================================================================================
82 //=======================================================================================
84  {
85  Invalid = 0,
106  };
107 
108 //=======================================================================================
110 //=======================================================================================
112  {
113  Invalid = 0,
118  PlanCallout,
120  TitleText
121  };
122 
123 //=======================================================================================
125 //=======================================================================================
127  {
128  Invalid = 0,
149  };
150 
151 //=======================================================================================
157 //=======================================================================================
159 {
160 
166  DGNPLATFORM_EXPORT static bool ApplySettings (IDetailingSymbol* def, ECN::IECInstanceCR propertyTree, DgnModelRefP modelRef);
167 
174  DGNPLATFORM_EXPORT static StatusInt SetElementColor (ECN::IECInstanceR dssInstance, WCharCP structAccessor, UInt32 elementColor, DgnFileR dgnFile);
175 
184  DGNPLATFORM_EXPORT static StatusInt AddDefaultDetailingStyleProperties (ECN::IECInstanceR dssInstance, DgnFileR dgnFile, LevelId levelId, int weight, UInt32 color, Int32 lineStyleId);
185 
192  DGNPLATFORM_EXPORT static StatusInt SetColorProperty (ECN::IECInstanceR dssInstance, DetailSymbolStyleColorProperty prop, UInt32 color, DgnFileR dgnFile);
193 
200  DGNPLATFORM_EXPORT static StatusInt SetLineStyleProperty (ECN::IECInstanceR dssInstance, DetailSymbolStyleLineStyleProperty prop, Int32 lineStyleId, DgnFileR dgnFile);
201 
208  DGNPLATFORM_EXPORT static StatusInt SetLevelProperty (ECN::IECInstanceR dssInstance, DetailSymbolStyleLevelProperty prop, LevelId levelId, DgnFileR dgnFile);
209 
215  DGNPLATFORM_EXPORT static StatusInt SetWeightProperty (ECN::IECInstanceR dssInstance, DetailSymbolStyleWeightProperty prop, int weight);
216 
222  DGNPLATFORM_EXPORT static StatusInt SetCellNameProperty (ECN::IECInstanceR dssInstance, DetailSymbolStyleCellNameProperty prop, WCharCP cellName);
223 
233  DGNPLATFORM_EXPORT static StatusInt SetAdditionalDrawingBoundaryProperties (ECN::IECInstanceR dssInstance, DrawingBoundaryBubbleSideType bubbleSide, double underLineLength, double underLineMargin, DrawingBoundaryUnderlineType ultype, DrawingBoundaryDisplayStatus displayAnnotation, DrawingBoundaryDisplayStatus displayBoundary);
234 
241  DGNPLATFORM_EXPORT static StatusInt GetColorProperty (UInt32& color, ECN::IECInstanceR dssInstance, DetailSymbolStyleColorProperty prop, DgnFileR dgnFile);
242 
249  DGNPLATFORM_EXPORT static StatusInt GetLineStyleProperty (Int32& lineStyleId, ECN::IECInstanceR dssInstance, DetailSymbolStyleLineStyleProperty prop, DgnFileR dgnFile);
250 
257  DGNPLATFORM_EXPORT static StatusInt GetLevelProperty (LevelId& levelId, ECN::IECInstanceR dssInstance, DetailSymbolStyleLevelProperty prop, DgnFileR dgnFile);
258 
264  DGNPLATFORM_EXPORT static StatusInt GetWeightProperty (int& weight, ECN::IECInstanceR dssInstance, DetailSymbolStyleWeightProperty prop);
265 
271  DGNPLATFORM_EXPORT static StatusInt GetCellNameProperty (WStringR cellName, ECN::IECInstanceR dssInstance, DetailSymbolStyleCellNameProperty prop);
272 
282  DGNPLATFORM_EXPORT static StatusInt GetAdditionalDrawingBoundaryProperties (DrawingBoundaryBubbleSideType& bubbleSide, double& underLineLength, double& underLineMargin, DrawingBoundaryUnderlineType& ultype, DrawingBoundaryDisplayStatus& displayAnnotation, DrawingBoundaryDisplayStatus& displayBoundary, ECN::IECInstanceR dssInstance);
283 
286  DGNPLATFORM_EXPORT static StatusInt GetDrawingBoundaryBubbleSideType (DrawingBoundaryBubbleSideType& bubbleSide, ECN::IECInstanceR dssInstance);
287 
290  DGNPLATFORM_EXPORT static StatusInt GetDrawingBoundaryUnderlineType (DrawingBoundaryUnderlineType& ultype, ECN::IECInstanceR dssInstance);
291 
294  DGNPLATFORM_EXPORT static StatusInt GetDrawingBoundaryUnderlineLength (double& underLineLength, ECN::IECInstanceR dssInstance);
295 
298  DGNPLATFORM_EXPORT static StatusInt GetDrawingBoundaryUnderlineMargin (double& underLineMargin, ECN::IECInstanceR dssInstance);
299 
302  DGNPLATFORM_EXPORT static StatusInt GetDrawingBoundaryDisplayAnnotation (DrawingBoundaryDisplayStatus& displayAnnotation, ECN::IECInstanceR dssInstance);
303 
306  DGNPLATFORM_EXPORT static StatusInt GetDrawingBoundaryDisplayBoundary (DrawingBoundaryDisplayStatus& displayBoundary, ECN::IECInstanceR dssInstance);
307 
310  DGNPLATFORM_EXPORT static StatusInt SetDrawingBoundaryBubbleSideType (ECN::IECInstanceR dssInstance, DrawingBoundaryBubbleSideType bubbleSide);
311 
314  DGNPLATFORM_EXPORT static StatusInt SetDrawingBoundaryUnderlineType (ECN::IECInstanceR dssInstance, DrawingBoundaryUnderlineType ultype);
315 
318  DGNPLATFORM_EXPORT static StatusInt SetDrawingBoundaryUnderlineLength (ECN::IECInstanceR dssInstance, double underLineLength);
319 
322  DGNPLATFORM_EXPORT static StatusInt SetDrawingBoundaryUnderlineMargin (ECN::IECInstanceR dssInstance, double underLineMargin);
323 
326  DGNPLATFORM_EXPORT static StatusInt SetDrawingBoundaryDisplayAnnotation (ECN::IECInstanceR dssInstance, DrawingBoundaryDisplayStatus displayAnnotation);
327 
330  DGNPLATFORM_EXPORT static StatusInt SetDrawingBoundaryDisplayBoundary (ECN::IECInstanceR dssInstance, DrawingBoundaryDisplayStatus displayBoundary);
331 };
332 
333 
335 
DetailSymbolStyleWeightProperty
Possible options to assign weight property of the the detailing symbol style of the given detailing s...
Definition: DetailingsymbolStyleHelper.h:126
#define END_BENTLEY_DGNPLATFORM_NAMESPACE
Definition: DgnPlatformBaseType.r.h:69
DetailSymbolStyleLevelProperty
Possible level property assigned to the detailing symbol style of the given detailing symbol...
Definition: DetailingsymbolStyleHelper.h:111
UInt32 LevelId
Definition: DgnPlatformBaseType.r.h:85
DetailingSymbolStyleHelper is a class to help apply style settings to a Detailing Symbol...
Definition: DetailingsymbolStyleHelper.h:158
DrawingBoundaryUnderlineType
Options to control the extent of underline of drawing title.
Definition: DetailingSymbol.h:1059
DetailSymbolStyleLineStyleProperty
Possible options to assign level property of the detailing symbol style for the given type of detaili...
Definition: DetailingsymbolStyleHelper.h:55
DrawingBoundaryBubbleSideType
Options to control whether drawing title's bubble (terminator cell) is displayed on the left hand sid...
Definition: DetailingSymbol.h:1070
#define DGNPLATFORM_EXPORT
Definition: DgnPlatform/ExportMacros.h:58
A DgnFile is an in-memory representation of a physical file, regardless of its format.
Definition: DgnFile.h:308
wchar_t const * WCharCP
Definition: Bentley.h:224
uint32_t UInt32
Definition: Bentley.r.h:128
DetailSymbolStyleColorProperty
Possible options to assign color property of the the detailing symbol style for the given detailing s...
Definition: DetailingsymbolStyleHelper.h:83
A DgnModelRef provides access to a model in a Bentley::DgnPlatform::DgnFile.
Definition: DgnModelRef.h:172
int32_t Int32
Definition: Bentley.r.h:119
#define DGNPLATFORM_TYPEDEFS(_name_)
Definition: DgnPlatform.h:73
A shared pointer template for reference-counted objects.
Definition: RefCounted.h:119
IECInstance const & IECInstanceCR
Definition: ECObjects.h:67
DetailSymbolStyleCellNameProperty
Possible property types of the detailing symbol cell which contains the placeholder fields that are e...
Definition: DetailingsymbolStyleHelper.h:31
#define BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
Definition: DgnPlatformBaseType.r.h:68
int StatusInt
Definition: Bentley.h:222
std::vector< IDetailingSymbolStyleValidator * > VectorOfIDetailingSymbolStyleValidator
Definition: DetailingsymbolStyleHelper.h:24
Base class for the various detailing symbol types.
Definition: DetailingSymbol.h:275
An IECInstance represents an instance of an ECClass.
Definition: ECInstance.h:115
DrawingBoundaryDisplayStatus
Options to control whether drawing title's settings like boundary and annotation should be visible or...
Definition: DetailingSymbol.h:1079
A string class that has many of the same capabilities as std::string, plus additional functions such ...
Definition: WString.h:51

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.