Entity
-
class
PMI::Entity This class is the base class for all the various PMI entity types. It contains functions common to all the PMI entities.
Index
Methods
Entity()Entity()GetDrawing()GetFrame()GetLeaderLineCount()GetLeaderLines()GetLeaderSymbolCount()GetLeaderSymbols()GetSegmentKey()GetType()IsDisplayParallelToScreen()operator=()Set()SetDisplayParallelToScreen()SetDrawing()SetFrame()SetLeaderLines()SetLeaderSymbols()~Entity()
Variables
Methods
-
PMI::Entity::Entity(HC_KEY segment_key = INVALID_KEY) Constructs an
Entityobject. It requires specifying the segment key where theEntitywill insert associated geometry.
-
virtual Type
PMI::Entity::GetType() const const virtual
Returns
the PMI::Type for this entity. Overridden by subclasses.
-
HC_KEY
PMI::Entity::GetSegmentKey() const const
Returns
the segment key where theEntityinserts associated geometry
-
void
PMI::Entity::GetFrame(Frame &out_frame) const const
Gets the
Frameassociated with thisEntity. Returned to the user.
-
void
PMI::Entity::SetFrame(Frame const &in_frame) Sets the
Frameassociated with thisEntity. This will replace an existingFrame.
-
unsigned int
PMI::Entity::GetLeaderLineCount() const const
Returns
the number of leaders lines for thisEntity
-
void
PMI::Entity::GetLeaderLines(unsigned int &out_count, Polyline out_leader_lines[]) const const
Gets the leader lines for this
Entity.Parameters
-
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
-
unsigned int
PMI::Entity::GetLeaderSymbolCount() const const
Returns
the number of leaders symbols for thisEntity
-
void
PMI::Entity::GetLeaderSymbols(unsigned int &out_count, Polygon out_leader_symbols[]) const const
Gets the leader symbols for this
Entity.Parameters
-
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
-
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
-
void
PMI::Entity::GetDrawing(Drawing &out_drawing) const const
Gets the
Drawingassociated with thisEntity. Returned to the user.
-
void
PMI::Entity::SetDrawing(Drawing const &in_drawing) Sets the
Drawingassociated with thisEntity. This will replace an existingDrawing.
Variables