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