omegalib  13.1
Public Types | Public Member Functions | Public Attributes | List of all members
omicron::PlaneBoundedVolume Class Reference

Represents a convex volume bounded by planes. More...

#include <PlaneBoundedVolume.h>

Public Types

typedef std::vector< Plane > PlaneList
 

Public Member Functions

 PlaneBoundedVolume ()
 
 PlaneBoundedVolume (PlaneSide theOutside)
 Constructor, determines which side is deemed to be 'outside'. More...
 
bool intersects (const AlignedBox3 &box) const
 Intersection test with AABB. More...
 
bool intersects (const Sphere &sphere) const
 Intersection test with Sphere. More...
 
std::pair< bool, real > intersects (const Ray &ray)
 Intersection test with a Ray. More...
 

Public Attributes

PlaneList planes
 Publicly accessible plane list, you can modify this direct. More...
 
PlaneSide outside
 

Detailed Description

Represents a convex volume bounded by planes.

Member Typedef Documentation

typedef std::vector<Plane > omicron::PlaneBoundedVolume::PlaneList

Constructor & Destructor Documentation

omicron::PlaneBoundedVolume::PlaneBoundedVolume ( )
inline
omicron::PlaneBoundedVolume::PlaneBoundedVolume ( PlaneSide  theOutside)
inline

Constructor, determines which side is deemed to be 'outside'.

Member Function Documentation

bool omicron::PlaneBoundedVolume::intersects ( const AlignedBox3 &  box) const
inline

Intersection test with AABB.

Remarks
May return false positives but will never miss an intersection.
bool omicron::PlaneBoundedVolume::intersects ( const Sphere &  sphere) const
inline

Intersection test with Sphere.

Remarks
May return false positives but will never miss an intersection.
std::pair<bool, real> omicron::PlaneBoundedVolume::intersects ( const Ray &  ray)
inline

Intersection test with a Ray.

Returns
std::pair of hit (bool) and distance
Remarks
May return false positives but will never miss an intersection.

Member Data Documentation

PlaneSide omicron::PlaneBoundedVolume::outside
PlaneList omicron::PlaneBoundedVolume::planes

Publicly accessible plane list, you can modify this direct.

The documentation for this class was generated from the following file: