PMI::Entity Class Reference
#include <HUtilityPMI.h>
List of all members.
Detailed Description
This class is the base class for all the various
PMI entity types. It contains functions common to all the
PMI entities.
Constructor & Destructor Documentation
PMI::Entity::Entity |
( |
HC_KEY |
segment_key = INVALID_KEY |
) |
|
Constructs an Entity object. It requires specifying the segment key where the Entity will insert associated geometry.
Member Function Documentation
void PMI::Entity::GetDrawing |
( |
Drawing & |
out_drawing |
) |
const |
Gets the Drawing associated with this Entity. Returned to the user.
void PMI::Entity::GetFrame |
( |
Frame & |
out_frame |
) |
const |
Gets the Frame associated with this Entity. Returned to the user.
unsigned int PMI::Entity::GetLeaderLineCount |
( |
|
) |
const |
- Returns:
- the number of leaders lines for this Entity
void PMI::Entity::GetLeaderLines |
( |
unsigned int & |
out_count, |
|
|
Polyline |
out_leader_lines[] | |
|
) |
| | const |
Gets the leader lines for this Entity.
- Parameters:
-
| out_count | the number of leader lines for this Entity. Returned to the user. |
| out_points | the array of leader lines for this Entity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array. |
unsigned int PMI::Entity::GetLeaderSymbolCount |
( |
|
) |
const |
- Returns:
- the number of leaders symbols for this Entity
void PMI::Entity::GetLeaderSymbols |
( |
unsigned int & |
out_count, |
|
|
Polygon |
out_leader_symbols[] | |
|
) |
| | const |
Gets the leader symbols for this Entity.
- Parameters:
-
| out_count | the number of leader symbols for this Entity. Returned to the user. |
| out_points | the array of leader symbols for this Entity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array. |
HC_KEY PMI::Entity::GetSegmentKey |
( |
|
) |
const |
- Returns:
- the segment key where the Entity inserts associated geometry
virtual Type PMI::Entity::GetType |
( |
|
) |
const [inline, virtual] |
bool PMI::Entity::IsDisplayParallelToScreen |
( |
|
) |
const |
void PMI::Entity::SetDisplayParallelToScreen |
( |
bool const |
in_parallel = true |
) |
|
Set the option parallel to screen. The pmi is display parallel to screen and is not impacted by any rotation
Reimplemented in PMI::GenericEntity.
void PMI::Entity::SetDrawing |
( |
Drawing const & |
in_drawing |
) |
|
void PMI::Entity::SetFrame |
( |
Frame const & |
in_frame |
) |
|
Sets the Frame associated with this Entity. This will replace an existing Frame.
void PMI::Entity::SetLeaderLines |
( |
unsigned int |
in_count, |
|
|
Polyline const |
in_leader_lines[] | |
|
) |
| | |
Sets the leader lines for this Entity. These will replace any existing leader lines.
- Parameters:
-
| in_count | the number of leader lines in the array |
| in_polylines | the array of leader lines for this Entity |
void PMI::Entity::SetLeaderSymbols |
( |
unsigned int |
in_count, |
|
|
Polygon const |
in_leader_symbols[] | |
|
) |
| | |
Sets the leader symbols for this Entity. These will replace any existing leader symbols.
- Parameters:
-
| in_count | the number of leader symbols in the array |
| in_polygons | the array of leader symbols for this Entity |
The documentation for this class was generated from the following file: