#include <HUtilityPMI.h>
Public Member Functions | |
unsigned int | GetStringCount () const |
void | GetStrings (unsigned int &out_count, String out_strings[], TextAttributes out_text_attributes[]) const |
virtual Type | GetType () const |
NoteEntity (HC_KEY segment_key=INVALID_KEY) | |
NoteEntity (NoteEntity const &that) | |
NoteEntity const & | operator= (NoteEntity const &that) |
void | Set (NoteEntity const &that) |
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_ |
This class represents a single or multi-line block of text.
PMI::NoteEntity::NoteEntity | ( | HC_KEY | segment_key = INVALID_KEY | ) |
Constructs a NoteEntity object. It requires specifying the segment key where the NoteEntity will insert associated geometry.
unsigned int PMI::NoteEntity::GetStringCount | ( | ) | const |
void PMI::NoteEntity::GetStrings | ( | unsigned int & | out_count, |
String | out_strings[], | ||
TextAttributes | out_text_attributes[] | ||
) | const |
Gets the strings for this NoteEntity.
out_count | the number of strings for this NoteEntity. Returned to the user. |
out_strings | the array of strings for this NoteEntity. 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 NoteEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array. |
|
inlinevirtual |
Reimplemented from PMI::Entity.
void PMI::NoteEntity::SetStrings | ( | unsigned int | in_count, |
String const | in_strings[], | ||
TextAttributes const | in_text_attributes[] | ||
) |
Sets the strings for this NoteEntity. These will replace any existing strings.
in_count | the number of strings in the array |
in_strings | the array of strings for this NoteEntity |
in_text_attributes | the array of TextAttributes for the strings for this NoteEntity |