PolygonShape Class Reference

#include <PolygonShape.hpp>

Inheritance diagram for PolygonShape:

Public Member Functions
bool	align () const
int	numSides () const
double	radius () const
Public Member Functions inherited from CenterShape
double	x () const
double	y () const
Public Member Functions inherited from ShapeItem
virtual void	paint ()
Public Member Functions inherited from Item
	Item (const Item &)=delete
virtual	~Item ()
void	addChild (Item *child)
const vector< Item * > &	children () const
virtual void	clearItemListProperty (const PropertyDef *property)
void	destroyChild (Item *child)
virtual bool	getBoolProperty (const PropertyDef *property) const
virtual vector< double >	getDoubleListProperty (const PropertyDef *property) const
virtual double	getDoubleProperty (const PropertyDef *property) const
virtual string	getEnumProperty (const PropertyDef *property) const
virtual int	getIntProperty (const PropertyDef *property) const
virtual vector< Item * >	getItemListProperty (const PropertyDef *property) const
virtual Item *	getItemProperty (const PropertyDef *property) const
virtual string	getStringProperty (const PropertyDef *property) const
int	getUtilityProperty (string name) const
virtual void	insertIntoItemListProperty (const PropertyDef *property, int index, Item *item)
Item &	operator= (const Item &)=delete
Item *	parent () const
virtual void	removeFromItemListProperty (const PropertyDef *property, int index)
virtual void	setBoolProperty (const PropertyDef *property, bool value)
virtual void	setDoubleListProperty (const PropertyDef *property, vector< double > value)
virtual void	setDoubleProperty (const PropertyDef *property, double value)
virtual void	setEnumProperty (const PropertyDef *property, string value)
virtual void	setIntProperty (const PropertyDef *property, int value)
virtual void	setItemProperty (const PropertyDef *property, Item *item)
virtual void	setStringProperty (const PropertyDef *property, string value)
void	setUtilityProperty (string name, int value)
virtual string	type () const

Protected Member Functions
	PolygonShape ()
void	paintSelf () override
Protected Member Functions inherited from CenterShape
	CenterShape ()
Protected Member Functions inherited from Shape
	Shape ()
Protected Member Functions inherited from ShapeItem
	ShapeItem ()
virtual void	drawLine (double x1, double y1, double x2, double y2)
virtual void	paintSelf ()
virtual void	popState ()
virtual void	pushState ()
virtual void	setColor (double r, double g, double b)
virtual void	setWidth (double w)
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType = CenterShape
using	ItemType = PolygonShape

Private Attributes
bool	_align
int	_numSides
double	_radius

Friends
class	ItemRegistry

Detailed Description

The PolygonShape class represents a regular polygon that draws its $N\le 3$ sides. The class inherits from the CenterShape class. All corner points lie at the same radius $r>0$ from the center of the shape. One of the corner points lies on the horizontal or vertical line through the center depending on the value of the align property.

Constructor & Destructor Documentation

PolygonShape()

PolygonShape::PolygonShape ( )

inlineprotected

Default constructor for concrete Item subclass PolygonShape : "a regular polygon" .

Member Function Documentation

align()

PolygonShape::align ( ) const

inline

This function returns the value of the discoverable Boolean property align : "align the first corner with the vertical line through the center" .

The default value for this property is given by the conditional value expression "false" .

numSides()

PolygonShape::numSides ( ) const

inline

This function returns the value of the discoverable integer property numSides : "the number of sides (or corners)" .

The minimum value for this property is "3" .

The maximum value for this property is "99" .

paintSelf()

void PolygonShape::paintSelf ( )

overrideprotectedvirtual

This function paints the appropriate marks for the regular polygon shape by calling the drawLine() function for each side.

Reimplemented from ShapeItem.

radius()

PolygonShape::radius ( ) const

inline

This function returns the value of the discoverable double property radius : "the radius, i.e. the distance from each corner to the center" .

This property represents a physical quantity of type "length" .

The minimum value for this property is "0 m" .

The maximum value for this property is "1 m" .

---

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

• PolygonShape.hpp