rcsc::Sector2D Class Reference

2D sector region(OUGI-GATA) class More...

#include <sector_2d.h>

Inheritance diagram for rcsc::Sector2D:

Public Member Functions
	Sector2D (const Vector2D &c, const double &min_r, const double &max_r, const AngleDeg &start, const AngleDeg &end)
	constructor with all variables
const Sector2D &	assign (const Vector2D &c, const double &min_r, const double &max_r, const AngleDeg &start, const AngleDeg &end)
	assign new value
const Vector2D &	center () const
	get the center point
const double &	radiusMin () const
	get the small side radius
const double &	radiusMax () const
	get the big side radius
const AngleDeg &	angleLeftStart () const
	get the left start angle
const AngleDeg &	angleRightEnd () const
	get the right end angle
virtual double	area () const
	calculate the area of this region
virtual bool	contains (const Vector2D &point) const
	check if point is within this region
double	getCircumferenceMin () const
	get smaller side circumference(ENSYUU NO NAGASA)
double	getCircumferenceMax () const
	get bigger side circumference(ENSYUU NO NAGASA)
Public Member Functions inherited from rcsc::Region2D
virtual	~Region2D ()
	virtual destructor.

Additional Inherited Members
Protected Member Functions inherited from rcsc::Region2D
	Region2D ()
	accessible only from derived classes

Detailed Description

2D sector region(OUGI-GATA) class

Constructor & Destructor Documentation

Sector2D()

rcsc::Sector2D::Sector2D	(	const Vector2D &	c,
		const double &	min_r,
		const double &	max_r,
		const AngleDeg &	start,
		const AngleDeg &	end )

constructor with all variables

Parameters

c	center point
min_r	smaller radius
max_r	bigger radius
start	start angle(turn clockwise)
end	end angle(turn clockwise)

Member Function Documentation

angleLeftStart()

const AngleDeg & rcsc::Sector2D::angleLeftStart ( ) const

inline

get the left start angle

Returns

const reference to the member variable

angleRightEnd()

const AngleDeg & rcsc::Sector2D::angleRightEnd ( ) const

inline

get the right end angle

Returns

const reference to the member variable

area()

double rcsc::Sector2D::area ( ) const

virtual

calculate the area of this region

Returns

the value of area

Implements rcsc::Region2D.

assign()

const Sector2D & rcsc::Sector2D::assign	(	const Vector2D &	c,
		const double &	min_r,
		const double &	max_r,
		const AngleDeg &	start,
		const AngleDeg &	end )

assign new value

Parameters

c	center point
min_r	smaller radius
max_r	bigger radius
start	start angle(turn clockwise)
end	end angle(turn clockwise)

center()

const Vector2D & rcsc::Sector2D::center ( ) const

inline

get the center point

Returns

const reference to the member variable

contains()

virtual bool rcsc::Sector2D::contains ( const Vector2D & point ) const

inlinevirtual

check if point is within this region

Parameters

point

considered point

Returns

true or false

Implements rcsc::Region2D.

getCircumferenceMax()

double rcsc::Sector2D::getCircumferenceMax ( ) const

inline

get bigger side circumference(ENSYUU NO NAGASA)

Returns

the length of circumference

getCircumferenceMin()

double rcsc::Sector2D::getCircumferenceMin ( ) const

inline

get smaller side circumference(ENSYUU NO NAGASA)

Returns

the length of circumference

radiusMax()

const double & rcsc::Sector2D::radiusMax ( ) const

inline

get the big side radius

Returns

const reference to the member variable

radiusMin()

const double & rcsc::Sector2D::radiusMin ( ) const

inline

get the small side radius

Returns

const reference to the member variable

---

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

• ui/geom/sector_2d.h
• ui/geom/sector_2d.cpp