OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::PlaneBoundedVolume Class Reference

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

#include <OgrePlaneBoundedVolume.h>

+ Collaboration diagram for Ogre::PlaneBoundedVolume:

Public Types

typedef vector< Plane >::type PlaneList
 

Public Member Functions

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

Public Attributes

Plane::Side outside
 
PlaneList planes
 Publicly accessible plane list, you can modify this direct. More...
 

Detailed Description

Represents a convex volume bounded by planes.

Definition at line 49 of file OgrePlaneBoundedVolume.h.

Member Typedef Documentation

Definition at line 52 of file OgrePlaneBoundedVolume.h.

Constructor & Destructor Documentation

Ogre::PlaneBoundedVolume::PlaneBoundedVolume ( )
inline

Definition at line 57 of file OgrePlaneBoundedVolume.h.

Ogre::PlaneBoundedVolume::PlaneBoundedVolume ( Plane::Side  theOutside)
inline

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

Definition at line 59 of file OgrePlaneBoundedVolume.h.

Member Function Documentation

bool Ogre::PlaneBoundedVolume::intersects ( const AxisAlignedBox box) const
inline

Intersection test with AABB.

Remarks
May return false positives but will never miss an intersection.

Definition at line 65 of file OgrePlaneBoundedVolume.h.

References Ogre::AxisAlignedBox::getCenter(), Ogre::AxisAlignedBox::getHalfSize(), Ogre::Plane::getSide(), Ogre::AxisAlignedBox::isInfinite(), and Ogre::AxisAlignedBox::isNull().

bool Ogre::PlaneBoundedVolume::intersects ( const Sphere sphere) const
inline

Intersection test with Sphere.

Remarks
May return false positives but will never miss an intersection.

Definition at line 96 of file OgrePlaneBoundedVolume.h.

References Ogre::Sphere::getCenter(), Ogre::Plane::getDistance(), Ogre::Sphere::getRadius(), and Ogre::Plane::NEGATIVE_SIDE.

std::pair<bool, Real> Ogre::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.

Definition at line 121 of file OgrePlaneBoundedVolume.h.

References Ogre::Math::intersects(), and Ogre::Plane::POSITIVE_SIDE.

Member Data Documentation

Plane::Side Ogre::PlaneBoundedVolume::outside

Definition at line 55 of file OgrePlaneBoundedVolume.h.

Referenced by Ogre::Ray::intersects().

PlaneList Ogre::PlaneBoundedVolume::planes

Publicly accessible plane list, you can modify this direct.

Definition at line 54 of file OgrePlaneBoundedVolume.h.

Referenced by Ogre::Ray::intersects().


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