#include <HUtilityPMI.h>

Public Member Functions

 Entity (HC_KEY segment_key=INVALID_KEY)
 
 Entity (Entity const &that)
 
void GetDrawing (Drawing &out_drawing) const
 
void GetFrame (Frame &out_frame) const
 
unsigned int GetLeaderLineCount () const
 
void GetLeaderLines (unsigned int &out_count, Polyline out_leader_lines[]) const
 
unsigned int GetLeaderSymbolCount () const
 
void GetLeaderSymbols (unsigned int &out_count, Polygon out_leader_symbols[]) const
 
HC_KEY GetSegmentKey () const
 
virtual Type GetType () const
 
bool IsDisplayParallelToScreen () const
 
Entity const & operator= (Entity const &that)
 
void Set (Entity const &that)
 
void SetDisplayParallelToScreen (bool const in_parallel=true)
 
void SetDrawing (Drawing const &in_drawing)
 
void SetFrame (Frame const &in_frame)
 
void SetLeaderLines (unsigned int in_count, Polyline const in_leader_lines[])
 
void SetLeaderSymbols (unsigned int in_count, Polygon const in_leader_symbols[])
 

Protected Attributes

PMII::PrivateImpl * impl_
 

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

◆ Entity()

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

◆ GetDrawing()

void PMI::Entity::GetDrawing ( Drawing out_drawing) const

Gets the Drawing associated with this Entity. Returned to the user.

◆ GetFrame()

void PMI::Entity::GetFrame ( Frame out_frame) const

Gets the Frame associated with this Entity. Returned to the user.

◆ GetLeaderLineCount()

unsigned int PMI::Entity::GetLeaderLineCount ( ) const
Returns
the number of leaders lines for this Entity

◆ GetLeaderLines()

void PMI::Entity::GetLeaderLines ( unsigned int &  out_count,
Polyline  out_leader_lines[] 
) const

Gets the leader lines for this Entity.

Parameters
out_countthe number of leader lines for this Entity. Returned to the user.
out_pointsthe 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.

◆ GetLeaderSymbolCount()

unsigned int PMI::Entity::GetLeaderSymbolCount ( ) const
Returns
the number of leaders symbols for this Entity

◆ GetLeaderSymbols()

void PMI::Entity::GetLeaderSymbols ( unsigned int &  out_count,
Polygon  out_leader_symbols[] 
) const

Gets the leader symbols for this Entity.

Parameters
out_countthe number of leader symbols for this Entity. Returned to the user.
out_pointsthe 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.

◆ GetSegmentKey()

HC_KEY PMI::Entity::GetSegmentKey ( ) const
Returns
the segment key where the Entity inserts associated geometry

◆ GetType()

virtual Type PMI::Entity::GetType ( ) const
inlinevirtual
Returns
the PMI::Type for this entity. Overridden by subclasses.

Reimplemented in PMI::RoughnessEntity, PMI::NoteEntity, PMI::GenericEntity, PMI::FeatureControlFrameEntity, PMI::DimensionEntity, and PMI::DatumEntity.

◆ IsDisplayParallelToScreen()

bool PMI::Entity::IsDisplayParallelToScreen ( ) const

Get the option parallel to screen value.

◆ SetDisplayParallelToScreen()

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

◆ SetDrawing()

void PMI::Entity::SetDrawing ( Drawing const &  in_drawing)

Sets the Drawing associated with this Entity. This will replace an existing Drawing.

◆ SetFrame()

void PMI::Entity::SetFrame ( Frame const &  in_frame)

Sets the Frame associated with this Entity. This will replace an existing Frame.

◆ SetLeaderLines()

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_countthe number of leader lines in the array
in_polylinesthe array of leader lines for this Entity

◆ SetLeaderSymbols()

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_countthe number of leader symbols in the array
in_polygonsthe array of leader symbols for this Entity

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