Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
mln::win::cube3d Struct Reference

Cube window defined on the 3D grid. More...

#include <cube3d.hh>

Inherits mln::internal::classical_window_base< dpoint3d, cube3d >.

Public Member Functions

 cube3d (unsigned length)
 Constructor.
 
unsigned length () const
 Give the cube length, that is, its height.
 

Detailed Description

Cube window defined on the 3D grid.

An cube3d is centered and symmetric; so its height (length) is odd.

For instance:

    *   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
    * 

is defined with length = 3.

Definition at line 69 of file cube3d.hh.

Constructor & Destructor Documentation

mln::win::cube3d::cube3d ( unsigned  length)
inline

Constructor.

Parameters
[in]lengthLength, thus height, of the cube3d.
Precondition
length is odd.

Definition at line 99 of file cube3d.hh.

Member Function Documentation

unsigned mln::win::cube3d::length ( ) const
inline

Give the cube length, that is, its height.

Definition at line 113 of file cube3d.hh.