mln::win::octagon2d Struct Reference
[2D windows]

Octagon window defined on the 2D square grid. More...

#include <octagon2d.hh>

Inherits classical_window_base< dpoint2d, octagon2d >.

List of all members.

Public Member Functions
unsigned	area () const
	Give the area.
unsigned	length () const
	Give the octagon length, that is, its width.
	octagon2d (unsigned length)
	Constructor.

---

Detailed Description

Octagon window defined on the 2D square grid.

An octagon2d is centered and symmetric.

The length L of the octagon is such as L = 6 * l + 1 where l >= 0.

For instance:

     *     o o o
     *   o o o o o
     * o o o o o o o
     * o o o x o o o
     * o o o o o o o
     *   o o o o o
     *     o o o
     * 

is defined with L = 7 (l = 1).

---

Constructor & Destructor Documentation

mln::win::octagon2d::octagon2d

(

unsigned

length

)

[inline]

Constructor.

Parameters:

[in]

length

Length, of the octagon.

Precondition:

length is such as length = 6*x + 1 where x >= 0.

---

Member Function Documentation

unsigned mln::win::octagon2d::area

(

)

const [inline]

Give the area.

unsigned mln::win::octagon2d::length

(

)

const [inline]

Give the octagon length, that is, its width.