Polyline

Detailed Description

class Polyline

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

Public Functions

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

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

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

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

void SetRGBColor(RGBColor const &in_color)

Sets the color for this Polyline. 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 Polyline. This will replace an existing color.

void GetLinePattern(char out_pattern[1024]) const

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

void SetLinePattern(char const in_pattern[1024])

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

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

Gets the points for this Polyline.

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

Gets the points for this Polyline.

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

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

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

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

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