LIBRCSC Docs
Documentation for HELIOS's BASE LIBRCSC library for RoboCup 2D Simulation League.
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Protected Member Functions | List of all members
rcsc::Region2D Class Referenceabstract

abstract 2D region class More...

#include <region_2d.h>

Inheritance diagram for rcsc::Region2D:
Inheritance graph
[legend]

Public Member Functions

virtual ~Region2D ()
 virtual destructor.
 
virtual double area () const =0
 get the area of this region More...
 
virtual bool contains (const Vector2D &point) const =0
 check if this region contains 'point'. More...
 

Protected Member Functions

 Region2D ()
 accessible only from derived classes
 

Detailed Description

abstract 2D region class

Member Function Documentation

◆ area()

virtual double rcsc::Region2D::area ( ) const
pure virtual

get the area of this region

Returns
value of the area

Implemented in rcsc::Circle2D, rcsc::UnitedRegion2D, rcsc::IntersectedRegion2D, rcsc::Polygon2D, rcsc::Rect2D, rcsc::Sector2D, and rcsc::Triangle2D.

◆ contains()

virtual bool rcsc::Region2D::contains ( const Vector2D point) const
pure virtual

check if this region contains 'point'.

Parameters
pointconsiderd point
Returns
true or false

Implemented in rcsc::Polygon2D, rcsc::Circle2D, rcsc::UnitedRegion2D, rcsc::IntersectedRegion2D, rcsc::Rect2D, rcsc::Sector2D, and rcsc::Triangle2D.


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