NavVolumeSide Class Reference

#include <NavVolumeSide.h>

List of all members.

Public Types
typedef SurfaceOrientation::GlobalFace	GlobalFace
typedef SurfaceOrientation::Side	Side
typedef ReferenceCountingPointer < NavSurface >	SurfacePointer
Public Member Functions
GlobalFace	globalFace () const
NavSurface &	mutableSurface () const
	NavVolumeSide (SurfacePointer surf, GlobalFace gSide, Side sSide)
	NavVolumeSide (NavSurface *surf, GlobalFace gSide, Side sSide)
const NavSurface &	surface () const
Side	surfaceSide () const
Private Attributes
GlobalFace	theGlobalFace
SurfacePointer	theSurface
Side	theSurfaceSide

---

Detailed Description

Class for delimiding surface of a NavVolume. The additional information with respect to NavSurface that is needed to define
a) which side of the Surface the volume is (enumerator Surface::Side)
b) which face of the volume this surface represents (enumerator GlobalFace). Only 6 possible values for volume face are defined.

Definition at line 15 of file NavVolumeSide.h.

---

Member Typedef Documentation

typedef SurfaceOrientation::GlobalFace NavVolumeSide::GlobalFace

Definition at line 17 of file NavVolumeSide.h.

typedef SurfaceOrientation::Side NavVolumeSide::Side

Definition at line 18 of file NavVolumeSide.h.

typedef ReferenceCountingPointer<NavSurface> NavVolumeSide::SurfacePointer

Definition at line 20 of file NavVolumeSide.h.

---

Constructor & Destructor Documentation

NavVolumeSide::NavVolumeSide	(	NavSurface *	surf,
		GlobalFace	gSide,
		Side	sSide
	)		[inline]

Definition at line 22 of file NavVolumeSide.h.

                                                                 : 
    theSurface( surf),  theGlobalFace( gSide), theSurfaceSide( sSide) {}

NavVolumeSide::NavVolumeSide	(	SurfacePointer	surf,
		GlobalFace	gSide,
		Side	sSide
	)		[inline]

Definition at line 25 of file NavVolumeSide.h.

                                                                    : 
    theSurface( surf),  theGlobalFace( gSide), theSurfaceSide( sSide) {}

---

Member Function Documentation

GlobalFace NavVolumeSide::globalFace

(

)

const [inline]

Definition at line 32 of file NavVolumeSide.h.

References theGlobalFace.

{ return theGlobalFace;}

NavSurface& NavVolumeSide::mutableSurface

(

)

const [inline]

Definition at line 28 of file NavVolumeSide.h.

References theSurface.

{return *theSurface;}

const NavSurface& NavVolumeSide::surface

(

)

const [inline]

Definition at line 30 of file NavVolumeSide.h.

References theSurface.

{return *theSurface;}

Side NavVolumeSide::surfaceSide

(

)

const [inline]

Definition at line 34 of file NavVolumeSide.h.

References theSurfaceSide.

{return theSurfaceSide;}

---

Member Data Documentation

GlobalFace NavVolumeSide::theGlobalFace [private]

Definition at line 39 of file NavVolumeSide.h.

Referenced by globalFace().

SurfacePointer NavVolumeSide::theSurface [private]

Definition at line 38 of file NavVolumeSide.h.

Referenced by mutableSurface(), and surface().

Side NavVolumeSide::theSurfaceSide [private]

Definition at line 40 of file NavVolumeSide.h.

Referenced by surfaceSide().