GenericEntity

Functions

	GenericEntity
	GenericEntity
	~GenericEntity
void	Set
GenericEntity const &	operator=
Type	GetType
unsigned int	GetStringCount
void	GetStrings
void	SetStrings
void	SetDisplayParallelToScreen
bool	IsDisplayParallelToScreen

Detailed Description

class GenericEntity : public PMI::Entity

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

Public Functions

GenericEntity(HC_KEY segment_key = (-1L))

Constructs a GenericEntity object. It requires specifying the segment key where the GenericEntity will insert associated geometry.

GenericEntity(GenericEntity const &that)

virtual ~GenericEntity()

void Set(GenericEntity const &that)

GenericEntity const &operator=(GenericEntity const &that)

inline virtual Type GetType() const

Returns

the PMI::Type for this entity. Overridden by subclasses.

unsigned int GetStringCount() const

Returns

the number of strings for this GenericEntity

void GetStrings(unsigned int &out_count, String out_strings[], TextAttributes out_text_attributes[]) 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 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 SetDisplayParallelToScreen(bool const in_parallel = true)

Sets the display behavior for this GenericEntity.

Parameters

in_parallel – option value

bool IsDisplayParallelToScreen() const

Gets the display behavior for this GenericEntity.

Returns

option value