Polygon

Functions

Polygon
Polygon
~Polygon
void Set
Polygon const & operator=
void GetRGBColor
void GetRGBColor
void SetRGBColor
void SetRGBColor
unsigned int GetPointCount
void GetPoints
void GetPoints
void SetPoints
void SetPoints

Detailed Description

class Polygon

This class represents a polygon used for leader symbols (arrow head).

Public Functions

Polygon()
Polygon(Polygon const &that)
~Polygon()
void Set(Polygon const &that)
Polygon const &operator=(Polygon const &that)
void GetRGBColor(RGBColor &out_color) const

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

void GetRGBColor(float &out_r, float &out_g, float &out_b) const

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

void SetRGBColor(RGBColor const &in_color)

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

void 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.

unsigned int GetPointCount() const
Returns:the number of points in this Polygon
void GetPoints(unsigned int &out_count, Point out_points[]) const

Gets the points for this Polygon.

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

Gets the points for this Polygon.

Parameters:
  • out_count – the number of points in this Polygon. Returned to the user.
  • out_points – the 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.
void SetPoints(unsigned int in_count, Point const in_points[])

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

Parameters:
  • in_count – the number of points in the array
  • in_points – the array of points for this Polygon
void SetPoints(unsigned int in_count, float const in_points[])

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

Parameters:
  • in_count – the number of points in the array
  • in_points – the array of points for this Polygon