Public Member Functions

mln::win::cuboid3d Struct Reference
[3D windows]

Cuboid defined on the 3-D square grid. More...

#include <cuboid3d.hh>

Inherits classical_window_base< dpoint3d, cuboid3d >.

List of all members.

Public Member Functions

 cuboid3d (unsigned depth, unsigned height, unsigned width)
 Constructor.
unsigned volume () const
 Return the volume of the cuboid.

unsigned depth () const
 Accessors.
unsigned height () const
 Return the height of the cuboid.
unsigned width () const
 Return the width of the cuboid.

Detailed Description

Cuboid defined on the 3-D square grid.

A cuboid3d is a 3-D window with cuboid (also known as rectangular prism or rectangular parallelepiped) shape. It is centered and symmetric.

For instance:

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

is defined with depth = 3, height = 5 and width = 7.

Reference: http://en.wikipedia.org/wiki/Cuboid

Definition at line 80 of file cuboid3d.hh.


Constructor & Destructor Documentation

mln::win::cuboid3d::cuboid3d ( unsigned  depth,
unsigned  height,
unsigned  width 
) [inline]

Constructor.

Parameters:
[in] depth The depth of the cuboid3d.
[in] height The height of the cuboid3d.
[in] width The width of the cuboid3d.
Precondition:
Argument depth, height and width must be odd.

Definition at line 125 of file cuboid3d.hh.


Member Function Documentation

unsigned mln::win::cuboid3d::depth (  )  const [inline]

Accessors.

Return the depth of the cuboid.

Definition at line 146 of file cuboid3d.hh.

unsigned mln::win::cuboid3d::height (  )  const [inline]

Return the height of the cuboid.

Definition at line 153 of file cuboid3d.hh.

unsigned mln::win::cuboid3d::volume (  )  const [inline]

Return the volume of the cuboid.

Definition at line 167 of file cuboid3d.hh.

unsigned mln::win::cuboid3d::width (  )  const [inline]

Return the width of the cuboid.

Definition at line 160 of file cuboid3d.hh.