Public Types | Public Member Functions | Public Attributes
Ogre::PlaneBoundedVolume Class Reference

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

#include <OgrePlaneBoundedVolume.h>

List of all members.

Public Types

typedef vector< Plane >::type PlaneList

Public Member Functions

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

Public Attributes

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

Detailed Description

Represents a convex volume bounded by planes.

Definition at line 48 of file OgrePlaneBoundedVolume.h.


Member Typedef Documentation

Definition at line 51 of file OgrePlaneBoundedVolume.h.


Constructor & Destructor Documentation

Definition at line 56 of file OgrePlaneBoundedVolume.h.

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

Definition at line 58 of file OgrePlaneBoundedVolume.h.


Member Function Documentation

Intersection test with AABB.

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

Definition at line 64 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

Intersection test with Sphere.

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

Definition at line 95 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)

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 120 of file OgrePlaneBoundedVolume.h.

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


Member Data Documentation

Definition at line 54 of file OgrePlaneBoundedVolume.h.

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

Publicly accessible plane list, you can modify this direct.

Definition at line 53 of file OgrePlaneBoundedVolume.h.

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


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

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:34