GenericEntity

class PMI::GenericEntity

This class represents a generic PMI entity, i.e., any entity not represented by any other PMI entity.

Inherits from: PMI::Entity

Methods

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.

PMI::GenericEntity::GenericEntity(GenericEntity const &that)
virtual PMI::GenericEntity::~GenericEntity()

virtual

void PMI::GenericEntity::Set(GenericEntity const &that)
GenericEntity const &PMI::GenericEntity::operator=(GenericEntity const &that)
virtual Type PMI::GenericEntity::GetType() const

const virtual

Returns

the PMI::Type for this entity. Overridden by subclasses.
unsigned int PMI::GenericEntity::GetStringCount() const

const

Returns

the number of strings for this GenericEntity
void PMI::GenericEntity::GetStrings(unsigned int &out_count, String out_strings[], TextAttributes out_text_attributes[]) const

const

Gets the strings for this GenericEntity.

Parameters

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.

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.

Parameters

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

void PMI::GenericEntity::SetDisplayParallelToScreen(bool const in_parallel = true)

Sets the display behavior for this GenericEntity.

Parameters

in_parallel: option value
bool PMI::GenericEntity::IsDisplayParallelToScreen() const

const

Gets the display behavior for this GenericEntity.

Returns

option value