Ogre::PlaneBoundedVolume Class Reference
Core » Math

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

`#include <OgrePlaneBoundedVolume.h>`

## 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, Real > | intersects (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

## PlaneList

typedef vector<Plane>::type Ogre::PlaneBoundedVolume::PlaneList

Definition at line 52 of file OgrePlaneBoundedVolume.h.

## Constructor & Destructor Documentation

## PlaneBoundedVolume() [1/2]

Ogre::PlaneBoundedVolume::PlaneBoundedVolume | ( |  | ) |

Definition at line 57 of file OgrePlaneBoundedVolume.h.

## PlaneBoundedVolume() [2/2]

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

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

Definition at line 59 of file OgrePlaneBoundedVolume.h.

## Member Function Documentation

## intersects() [1/3]

bool Ogre::PlaneBoundedVolume::intersects | ( | const AxisAlignedBox & | box | ) | const

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().

## intersects() [2/3]

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

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

## intersects() [3/3]

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

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

## Member Data Documentation

## outside

Plane::Side Ogre::PlaneBoundedVolume::outside

Definition at line 55 of file OgrePlaneBoundedVolume.h.

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

## planes

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:

- OgrePlaneBoundedVolume.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.