CFx SDK Documentation  2023 SP0
AECLayerKeyDefinition.h
Go to the documentation of this file.
1 // Copyright (C) 2002-2017, Open Design Alliance (the "Alliance").
3 // All rights reserved.
4 //
5 // This software and its documentation and related materials are owned by
6 // the Alliance. The software may only be incorporated into application
7 // programs owned by members of the Alliance, subject to a signed
8 // Membership Agreement and Supplemental Software License Agreement with the
9 // Alliance. The structure and organization of this software are the valuable
10 // trade secrets of the Alliance and its suppliers. The software is also
11 // protected by copyright law and international treaty provisions. Application
12 // programs incorporating this software must include the following statement
13 // with their copyright notices:
14 //
15 // This application incorporates Teigha(R) software pursuant to a license
16 // agreement with Open Design Alliance.
17 // Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance.
18 // All rights reserved.
19 //
20 // By use of this software, its documentation or related materials, you
21 // acknowledge and accept the above terms.
23 
24 #ifndef __AECLAYERKEYDEFINITION_H__
25 #define __AECLAYERKEYDEFINITION_H__
26 
27 #include "Subobjects/AECImpObj.h"
28 #include <CmColor.h>
29 
35 class AECBASE_API AECLayerKeyDefinition : public AECImpObj
36 {
38 
39  public:
43  const OdString& GetKey() const;
44 
48  void SetKey( const OdString& strKey );
49 
53  const OdString& GetLayerName() const;
54 
58  void SetLayerName( const OdString& strLayerName );
59 
63  const OdString& GetLkDescription() const;
64 
68  void SetLkDescription( const OdString& strDescription );
69 
73  const OdString& GetLineType() const;
74 
78  void SetLineType( const OdString& strLineType );
79 
83  const OdString& GetPlotStyle() const;
84 
88  void SetPlotStyle( const OdString& strPlotStyle );
89 
93  const OdCmColor& GetColor() const;
94 
98  void SetColor( const OdCmColor& cColor );
99 
104 
109 
113  bool IsPlotted() const;
114 
118  void SetIsPlotted( bool bPlotted );
119 
125 
130  const OdString& GetOverrideByIndex( OdUInt32 iIndex ) const;
131 
135  void AddOverride( const OdString& strOverride );
136 
140  void RemoveOverride( const OdString& strOverride );
141 
142  protected:
143  // The Name of the key for this Layer.
145 
146  // The name of the layer.
148 
149  // The description of the layer.
151 
152  // The type of the line of the entity from this layer.
154 
155  // The type of the plot of the layer.
157 
158  // The default color of the entity of this layer.
160 
161  // The weight of the line of the entity of this layer.
163 
164  // It shows if the entity of this layer should be plotted or not.
166 
167  // The names of the components, for which any overrides could be made.
168  std::vector<OdString> m_aPossibleOverrides;
169 
171  // Version 70
173 };
174 
177 
178 #endif // __AECLAYERKEYDEFINITION_H__
AECSubPtr< AECLayerKeyDefinition > AECLayerKeyDefinitionSubPtr
OdSmartPtr< AECLayerKeyDefinition > AECLayerKeyDefinitionPtr
#define AEC_DECLARE_MEMBERS(ClassName)
Definition: AECMacros.h:54
unsigned int OdUInt32
void SetColor(const OdCmColor &cColor)
void SetPlotStyle(const OdString &strPlotStyle)
OdDb::LineWeight m_iLineWeight
void SetLkDescription(const OdString &strDescription)
const OdString & GetOverrideByIndex(OdUInt32 iIndex) const
OdDb::LineWeight GetLineWeight() const
void SetLineWeight(OdDb::LineWeight eWeight)
void AddOverride(const OdString &strOverride)
void SetLayerName(const OdString &strLayerName)
const OdString & GetLineType() const
const OdString & GetLayerName() const
OdUInt32 GetOverrideCount() const
std::vector< OdString > m_aPossibleOverrides
const OdCmColor & GetColor() const
const OdString & GetKey() const
void RemoveOverride(const OdString &strOverride)
const OdString & GetPlotStyle() const
const OdString & GetLkDescription() const
bool IsPlotted() const
void SetKey(const OdString &strKey)
void SetLineType(const OdString &strLineType)
void SetIsPlotted(bool bPlotted)
LineWeight
Definition: OdaDefs.h:384