PMI::DatumEntity Class Reference
#include <HUtilityPMI.h>
Public Member Functions | |
DatumEntity (HC_KEY segment_key=INVALID_KEY) | |
DatumEntity (DatumEntity const &that) | |
Datum::Type | GetDatumType () const |
unsigned int | GetLabelCount () const |
void | GetLabels (unsigned int &out_count, String out_labels[], TextAttributes out_text_attributes[]) const |
virtual Type | GetType () const |
DatumEntity const & | operator= (DatumEntity const &that) |
void | Set (DatumEntity const &that) |
void | SetDatumType (Datum::Type const in_type) |
void | SetLabels (unsigned int in_count, String const in_labels[], 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 datum identifiers and datum targets.
Constructor & Destructor Documentation
◆ DatumEntity()
PMI::DatumEntity::DatumEntity | ( | HC_KEY | segment_key = INVALID_KEY | ) |
Constructs a DatumEntity object. It requires specifying the segment key where the DatumEntity will insert associated geometry.
Member Function Documentation
◆ GetDatumType()
Datum::Type PMI::DatumEntity::GetDatumType | ( | ) | const |
- Returns
- the datum type of this DatumEntity
◆ GetLabels()
void PMI::DatumEntity::GetLabels | ( | unsigned int & | out_count, |
String | out_labels[], | ||
TextAttributes | out_text_attributes[] | ||
) | const |
Gets the labels for this DatumEntity.
- Parameters
-
out_count the number of labels for this DatumEntity. Returned to the user. out_labels the array of labels for this DatumEntity. 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 labels for this DatumEntity. 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.
◆ SetDatumType()
void PMI::DatumEntity::SetDatumType | ( | Datum::Type const | in_type | ) |
Sets the datum type of this DatumEntity. This will replace an existing datum type.
◆ SetLabels()
void PMI::DatumEntity::SetLabels | ( | unsigned int | in_count, |
String const | in_labels[], | ||
TextAttributes const | in_text_attributes[] | ||
) |
Sets the labels for this DatumEntity. These will replace any existing labels.
- Parameters
-
in_count the number of labels in the array in_labels the array of labels for this DatumEntity in_text_attributes the array of TextAttributes for the labels for this DatumEntity
The documentation for this class was generated from the following file: