PMI::DimensionEntity Class Reference
#include <HUtilityPMI.h>
Public Member Functions | |
DimensionEntity (HC_KEY segment_key=INVALID_KEY) | |
DimensionEntity (DimensionEntity const &that) | |
Dimension::SubType | GetDimensionSubType () const |
Dimension::Type | GetDimensionType () const |
unsigned int | GetStringCount () const |
void | GetStrings (unsigned int &out_count, String out_strings[], TextAttributes out_text_attributes[]) const |
virtual Type | GetType () const |
DimensionEntity const & | operator= (DimensionEntity const &that) |
void | Set (DimensionEntity const &that) |
void | SetDimensionSubType (Dimension::SubType const in_sub_type) |
void | SetDimensionType (Dimension::Type const in_type) |
void | SetStrings (unsigned int in_count, String const in_strings[], TextAttributes const in_text_attributes[]) |
![]() | |
Entity (HC_KEY segment_key=INVALID_KEY) | |
Entity (Entity const &that) | |
void | GetDrawing (Drawing &out_drawing) const |
void | GetFrame (Frame &out_frame) const |
unsigned int | GetLeaderLineCount () const |
void | GetLeaderLines (unsigned int &out_count, Polyline out_leader_lines[]) const |
unsigned int | GetLeaderSymbolCount () const |
void | GetLeaderSymbols (unsigned int &out_count, Polygon out_leader_symbols[]) const |
HC_KEY | GetSegmentKey () const |
bool | IsDisplayParallelToScreen () const |
Entity const & | operator= (Entity const &that) |
void | Set (Entity const &that) |
void | SetDisplayParallelToScreen (bool const in_parallel=true) |
void | SetDrawing (Drawing const &in_drawing) |
void | SetFrame (Frame const &in_frame) |
void | SetLeaderLines (unsigned int in_count, Polyline const in_leader_lines[]) |
void | SetLeaderSymbols (unsigned int in_count, Polygon const in_leader_symbols[]) |
Additional Inherited Members | |
![]() | |
PMII::PrivateImpl * | impl_ |
Detailed Description
This class represents basic, reference or tolerance dimension.
Constructor & Destructor Documentation
◆ DimensionEntity()
PMI::DimensionEntity::DimensionEntity | ( | HC_KEY | segment_key = INVALID_KEY | ) |
Constructs a DimensionEntity object. It requires specifying the segment key where the DimensionEntity will insert associated geometry.
Member Function Documentation
◆ GetDimensionSubType()
Dimension::SubType PMI::DimensionEntity::GetDimensionSubType | ( | ) | const |
- Returns
- the dimension subtype of this DimensionEntity
◆ GetDimensionType()
Dimension::Type PMI::DimensionEntity::GetDimensionType | ( | ) | const |
- Returns
- the dimension type of this DimensionEntity
◆ GetStringCount()
unsigned int PMI::DimensionEntity::GetStringCount | ( | ) | const |
- Returns
- the number of strings for this DimensionEntity
◆ GetStrings()
void PMI::DimensionEntity::GetStrings | ( | unsigned int & | out_count, |
String | out_strings[], | ||
TextAttributes | out_text_attributes[] | ||
) | const |
Gets the strings for this DimensionEntity.
- Parameters
-
out_count the number of strings for this DimensionEntity. Returned to the user. out_strings the array of strings for this DimensionEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array. out_text_attributes the array of TextAttributes for the strings for this DimensionEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.
◆ GetType()
|
inlinevirtual |
- Returns
- the PMI::Type for this entity. Overridden by subclasses.
Reimplemented from PMI::Entity.
◆ SetDimensionSubType()
void PMI::DimensionEntity::SetDimensionSubType | ( | Dimension::SubType const | in_sub_type | ) |
Sets the dimension subtype of this DimensionEntity. This will replace an existing dimension subtype.
◆ SetDimensionType()
void PMI::DimensionEntity::SetDimensionType | ( | Dimension::Type const | in_type | ) |
Sets the dimension type of this DimensionEntity. This will replace an existing dimension type.
◆ SetStrings()
void PMI::DimensionEntity::SetStrings | ( | unsigned int | in_count, |
String const | in_strings[], | ||
TextAttributes const | in_text_attributes[] | ||
) |
Sets the strings for this DimensionEntity. These will replace any existing strings.
- Parameters
-
in_count the number of strings in the array in_strings the array of strings for this DimensionEntity in_text_attributes the array of TextAttributes for the strings for this DimensionEntity
The documentation for this class was generated from the following file: