PMI::Polyline Class Reference

#include <HUtilityPMI.h>

Public Member Functions

void GetLinePattern (char out_pattern[1024]) const
 
unsigned int GetPointCount () const
 
void GetPoints (unsigned int &out_count, Point out_points[]) const
 
void GetPoints (unsigned int &out_count, float out_points[]) const
 
void GetRGBColor (RGBColor &out_color) const
 
void GetRGBColor (float &out_r, float &out_g, float &out_b) const
 
Polyline const & operator= (Polyline const &that)
 
 Polyline (Polyline const &that)
 
void Set (Polyline const &that)
 
void SetLinePattern (char const in_pattern[1024])
 
void SetPoints (unsigned int in_count, Point const in_points[])
 
void SetPoints (unsigned int in_count, float const in_points[])
 
void SetRGBColor (RGBColor const &in_color)
 
void SetRGBColor (float const in_r, float const in_g, float const in_b)
 

Detailed Description

This class represents a polyline used for Frames and leader lines.

Member Function Documentation

◆ GetLinePattern()

void PMI::Polyline::GetLinePattern ( char  out_pattern[1024]) const

Gets the line pattern for this Polyline. Returned to the user.

◆ GetPointCount()

unsigned int PMI::Polyline::GetPointCount ( ) const
Returns
the number of points in this polyline

◆ GetPoints() [1/2]

void PMI::Polyline::GetPoints ( unsigned int &  out_count,
Point  out_points[] 
) const

Gets the points for this Polyline.

Parameters
out_countthe number of points in this Polyline. Returned to the user.
out_pointsthe array of points for this Polyline. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.

◆ GetPoints() [2/2]

void PMI::Polyline::GetPoints ( unsigned int &  out_count,
float  out_points[] 
) const

Gets the points for this Polyline.

Parameters
out_countthe number of points in this Polyline. Returned to the user.
out_pointsthe array of points for this Polyline. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.

◆ GetRGBColor() [1/2]

void PMI::Polyline::GetRGBColor ( RGBColor out_color) const

Gets the color for this Polyline. Returned to the user.

◆ GetRGBColor() [2/2]

void PMI::Polyline::GetRGBColor ( float &  out_r,
float &  out_g,
float &  out_b 
) const

Gets the color for this Polyline. Returned to the user.

◆ SetLinePattern()

void PMI::Polyline::SetLinePattern ( char const  in_pattern[1024])

Sets the line pattern for this Polyline. This will replace an existing line pattern.

◆ SetPoints() [1/2]

void PMI::Polyline::SetPoints ( unsigned int  in_count,
Point const  in_points[] 
)

Sets the points for this Polyline. These will replace any existing points.

Parameters
in_countthe number of points in the array
in_pointsthe array of points for this Polyline

◆ SetPoints() [2/2]

void PMI::Polyline::SetPoints ( unsigned int  in_count,
float const  in_points[] 
)

Sets the points for this Polyline. These will replace any existing points.

Parameters
in_countthe number of points in the array
in_pointsthe array of points for this Polyline

◆ SetRGBColor() [1/2]

void PMI::Polyline::SetRGBColor ( RGBColor const &  in_color)

Sets the color for this Polyline. This will replace an existing color.

◆ SetRGBColor() [2/2]

void PMI::Polyline::SetRGBColor ( float const  in_r,
float const  in_g,
float const  in_b 
)

Sets the color for this Polyline. This will replace an existing color.


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