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

Specialized frustum shaped culling volume that has culling planes created from portals. More...

#include <OgrePCZFrustum.h>

+ Collaboration diagram for Ogre::PCZFrustum:

Public Types

enum  Visibility { NONE, PARTIAL, FULL }
 

Public Member Functions

 PCZFrustum ()
 Standard constructor. More...
 
 ~PCZFrustum ()
 Standard destructor. More...
 
int addPortalCullingPlanes (PortalBase *portal)
 Calculate culling planes from portal and Frustum origin and add to list of culling planes. More...
 
ProjectionType getProjectionType () const
 Get the projection type of this PCZFrustum. More...
 
PCPlanegetUnusedCullingPlane (void)
 Get an unused PCPlane from the CullingPlane Reservoir. More...
 
PCZFrustum::Visibility getVisibility (const AxisAlignedBox &bound)
 
bool isFullyVisible (const AxisAlignedBox &bound) const
 
bool isFullyVisible (const Sphere &bound) const
 
bool isFullyVisible (const PortalBase *portal) const
 
bool isVisible (const AxisAlignedBox &bound) const
 
bool isVisible (const Sphere &bound) const
 
bool isVisible (const PortalBase *portal) const
 
void removeAllCullingPlanes (void)
 Remove all culling planes. More...
 
void removePortalCullingPlanes (PortalBase *portal)
 Remove culling planes created from the given portal. More...
 
void setOrigin (const Vector3 &newOrigin)
 Set the origin value. More...
 
void setOriginPlane (const Vector3 &rkNormal, const Vector3 &rkPoint)
 Set the origin plane. More...
 
void setProjectionType (ProjectionType projType)
 Set the projection type of this PCZFrustum. More...
 
void setUseOriginPlane (bool yesno)
 Tell the frustum whether or not to use the originplane. More...
 

Protected Attributes

PCPlaneList mActiveCullingPlanes
 
PCPlaneList mCullingPlaneReservoir
 
Vector3 mOrigin
 
Plane mOriginPlane
 
ProjectionType mProjType
 
bool mUseOriginPlane
 

Detailed Description

Specialized frustum shaped culling volume that has culling planes created from portals.

Definition at line 69 of file OgrePCZFrustum.h.

Member Enumeration Documentation

Enumerator
NONE 
PARTIAL 
FULL 

Definition at line 73 of file OgrePCZFrustum.h.

Constructor & Destructor Documentation

Ogre::PCZFrustum::PCZFrustum ( )

Standard constructor.

Ogre::PCZFrustum::~PCZFrustum ( )

Standard destructor.

Member Function Documentation

int Ogre::PCZFrustum::addPortalCullingPlanes ( PortalBase portal)

Calculate culling planes from portal and Frustum origin and add to list of culling planes.

ProjectionType Ogre::PCZFrustum::getProjectionType ( ) const
inline

Get the projection type of this PCZFrustum.

Definition at line 120 of file OgrePCZFrustum.h.

PCPlane* Ogre::PCZFrustum::getUnusedCullingPlane ( void  )

Get an unused PCPlane from the CullingPlane Reservoir.

PCZFrustum::Visibility Ogre::PCZFrustum::getVisibility ( const AxisAlignedBox bound)
bool Ogre::PCZFrustum::isFullyVisible ( const AxisAlignedBox bound) const
bool Ogre::PCZFrustum::isFullyVisible ( const Sphere bound) const
bool Ogre::PCZFrustum::isFullyVisible ( const PortalBase portal) const
bool Ogre::PCZFrustum::isVisible ( const AxisAlignedBox bound) const
bool Ogre::PCZFrustum::isVisible ( const Sphere bound) const
bool Ogre::PCZFrustum::isVisible ( const PortalBase portal) const
void Ogre::PCZFrustum::removeAllCullingPlanes ( void  )

Remove all culling planes.

void Ogre::PCZFrustum::removePortalCullingPlanes ( PortalBase portal)

Remove culling planes created from the given portal.

void Ogre::PCZFrustum::setOrigin ( const Vector3 newOrigin)
inline

Set the origin value.

Definition at line 108 of file OgrePCZFrustum.h.

void Ogre::PCZFrustum::setOriginPlane ( const Vector3 rkNormal,
const Vector3 rkPoint 
)

Set the origin plane.

void Ogre::PCZFrustum::setProjectionType ( ProjectionType  projType)
inline

Set the projection type of this PCZFrustum.

Definition at line 117 of file OgrePCZFrustum.h.

void Ogre::PCZFrustum::setUseOriginPlane ( bool  yesno)
inline

Tell the frustum whether or not to use the originplane.

Definition at line 112 of file OgrePCZFrustum.h.

Member Data Documentation

PCPlaneList Ogre::PCZFrustum::mActiveCullingPlanes
protected

Definition at line 127 of file OgrePCZFrustum.h.

PCPlaneList Ogre::PCZFrustum::mCullingPlaneReservoir
protected

Definition at line 128 of file OgrePCZFrustum.h.

Vector3 Ogre::PCZFrustum::mOrigin
protected

Definition at line 124 of file OgrePCZFrustum.h.

Plane Ogre::PCZFrustum::mOriginPlane
protected

Definition at line 125 of file OgrePCZFrustum.h.

ProjectionType Ogre::PCZFrustum::mProjType
protected

Definition at line 129 of file OgrePCZFrustum.h.

bool Ogre::PCZFrustum::mUseOriginPlane
protected

Definition at line 126 of file OgrePCZFrustum.h.


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