PMI::Polygon Class Reference

#include <HUtilityPMI.h>

Public Member Functions

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
 
Polygon const & operator= (Polygon const &that)
 
 Polygon (Polygon const &that)
 
void Set (Polygon const &that)
 
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 polygon used for leader symbols (arrow head).

Member Function Documentation

◆ GetPointCount()

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

◆ GetPoints() [1/2]

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

Gets the points for this Polygon.

Parameters
out_countthe number of points in this Polygon. Returned to the user.
out_pointsthe array of points for this Polygon. 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::Polygon::GetPoints ( unsigned int &  out_count,
float  out_points[] 
) const

Gets the points for this Polygon.

Parameters
out_countthe number of points in this Polygon. Returned to the user.
out_pointsthe array of points for this Polygon. 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::Polygon::GetRGBColor ( RGBColor out_color) const

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

◆ GetRGBColor() [2/2]

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

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

◆ SetPoints() [1/2]

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

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

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

◆ SetPoints() [2/2]

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

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

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

◆ SetRGBColor() [1/2]

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

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

◆ SetRGBColor() [2/2]

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

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


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