Circle Class Reference

#include <circle.h>

Inheritance diagram for Circle:
Collaboration diagram for Circle:

Public Member Functions

 Circle (int r, int x, int y)
 
 Circle (int r, Point c)
 
virtual std::string getType () const
 
virtual double getArea () const
 
- Public Member Functions inherited from Shape
 Shape (int x, int y)
 
 Shape (Point c)
 
Point getCenter () const
 
void setCenter (Point c)
 

Additional Inherited Members

- Protected Attributes inherited from Shape
Point center
 

Detailed Description

A class that represents a circle on a 2D plane. Its only member is its radius and it inherits all of its functionality from the Shape class.

Author
Brent Nash

Constructor & Destructor Documentation

◆ Circle() [1/2]

Circle::Circle ( int  r,
int  x,
int  y 
)

Overloaded constructor that takes in a radius and an (x,y) coordinate.

Parameters
rThe radius of the circle (must be greater than 0)
xThe X coordinate of the circle's center point in 2D space
yThe Y coordinate of the circle's center point in 2D space

◆ Circle() [2/2]

Circle::Circle ( int  r,
Point  c 
)

Overloaded constructor that takes in a radius and a center Point.

Parameters
rThe radius of the circle (must be greater than 0)
cThe center point of the circle in 2D space

Member Function Documentation

◆ getArea()

double Circle::getArea ( ) const
virtual

Virtual function overridden from Shape. Returns the area of the circle as PI*radius*radius.

Precondition
The radius must be set to a valid number.
Postcondition
Does not change the object
Returns
The area of the circle as a floating point number.

Implements Shape.

◆ getType()

string Circle::getType ( ) const
virtual

Virtual function overridden from Shape. Returns a string indicating what type of shape this object is.

Precondition
None
Postcondition
Does not change the object
Returns
The string "Circle"

Implements Shape.


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