\hypertarget{a00452}{
\section{mln::win::octagon2d Struct Reference}
\label{d1/d0b/a00452}\index{mln::win::octagon2d@{mln::win::octagon2d}}
}


Octagon window defined on the 2D square grid.  




{\ttfamily \#include $<$octagon2d.hh$>$}



Inherits classical\_\-window\_\-base$<$ dpoint2d, octagon2d $>$.

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
unsigned \hyperlink{a00452_a990df0e2b97c3e9dcce899df94164088}{area} () const 
\begin{DoxyCompactList}\small\item\em Give the area. \item\end{DoxyCompactList}\item 
unsigned \hyperlink{a00452_a98fcfba4364a3c0f64f0b7587e7472e1}{length} () const 
\begin{DoxyCompactList}\small\item\em Give the octagon length, that is, its width. \item\end{DoxyCompactList}\item 
\hyperlink{a00452_a138ac8d53b130f995b7b1487291ebe93}{octagon2d} (unsigned length)
\begin{DoxyCompactList}\small\item\em Constructor. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Octagon window defined on the 2D square grid. An \hyperlink{a00452}{octagon2d} is centered and symmetric.

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

For instance: \par
 \begin{DoxyVerb}
     *     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
     * \end{DoxyVerb}
 is defined with L = 7 (l = 1). 

Definition at line 67 of file octagon2d.hh.



\subsection{Constructor \& Destructor Documentation}
\hypertarget{a00452_a138ac8d53b130f995b7b1487291ebe93}{
\index{mln::win::octagon2d@{mln::win::octagon2d}!octagon2d@{octagon2d}}
\index{octagon2d@{octagon2d}!mln::win::octagon2d@{mln::win::octagon2d}}
\subsubsection[{octagon2d}]{\setlength{\rightskip}{0pt plus 5cm}mln::win::octagon2d::octagon2d (
\begin{DoxyParamCaption}
\item[{unsigned}]{ length}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d1/d0b/a00452_a138ac8d53b130f995b7b1487291ebe93}


Constructor. 


\begin{DoxyParams}{Parameters}
\item[\mbox{\tt[in]} {\em length}]Length, of the octagon.\end{DoxyParams}
\begin{DoxyPrecond}{Precondition}
{\ttfamily length} is such as length = 6$\ast$x + 1 where x $>$= 0. 
\end{DoxyPrecond}


Definition at line 101 of file octagon2d.hh.



\subsection{Member Function Documentation}
\hypertarget{a00452_a990df0e2b97c3e9dcce899df94164088}{
\index{mln::win::octagon2d@{mln::win::octagon2d}!area@{area}}
\index{area@{area}!mln::win::octagon2d@{mln::win::octagon2d}}
\subsubsection[{area}]{\setlength{\rightskip}{0pt plus 5cm}unsigned mln::win::octagon2d::area (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d1/d0b/a00452_a990df0e2b97c3e9dcce899df94164088}


Give the area. 



Definition at line 157 of file octagon2d.hh.

\hypertarget{a00452_a98fcfba4364a3c0f64f0b7587e7472e1}{
\index{mln::win::octagon2d@{mln::win::octagon2d}!length@{length}}
\index{length@{length}!mln::win::octagon2d@{mln::win::octagon2d}}
\subsubsection[{length}]{\setlength{\rightskip}{0pt plus 5cm}unsigned mln::win::octagon2d::length (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{d1/d0b/a00452_a98fcfba4364a3c0f64f0b7587e7472e1}


Give the octagon length, that is, its width. 



Definition at line 145 of file octagon2d.hh.

