Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

PMI::GenericEntity Class Reference

#include <HUtilityPMI.h>

List of all members.

Public Member Functions

 GenericEntity (HC_KEY segment_key=INVALID_KEY)
 GenericEntity (GenericEntity const &that)
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[])

Detailed Description

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


Constructor & Destructor Documentation

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.


Member Function Documentation

unsigned int PMI::GenericEntity::GetStringCount ( ) 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

Gets the strings for this GenericEntity.

Parameters:
out_countthe number of strings for this GenericEntity. Returned to the user.
out_stringsthe 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_attributesthe 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]
Returns:
the PMI::Type for this entity. Overridden by subclasses.

Reimplemented from PMI::Entity.

bool PMI::GenericEntity::IsDisplayParallelToScreen ( ) const

Gets the display behavior for this GenericEntity.

Returns:
option value

Reimplemented from PMI::Entity.

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

Sets the display behavior for this GenericEntity.

Parameters:
in_paralleloption 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.

Parameters:
in_countthe number of strings in the array
in_stringsthe array of strings for this GenericEntity
in_text_attributesthe array of TextAttributes for the strings for this GenericEntity

The documentation for this class was generated from the following file: