OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::PCPlane Class Reference

Portal Culling Plane. More...

#include <OgrePCPlane.h>

+ Inheritance diagram for Ogre::PCPlane:

Public Member Functions

 PCPlane ()
 Standard constructor. More...
 
 PCPlane (const Plane &plane)
 Alternative constructor. More...
 
 PCPlane (const Vector3 &rkNormal, const Vector3 &rkPoint)
 Alternative constructor. More...
 
 PCPlane (const Vector3 &rkPoint0, const Vector3 &rkPoint1, const Vector3 &rkPoint2)
 Alternative constructor. More...
 
 ~PCPlane ()
 Standard destructor. More...
 
PortalBasegetPortal ()
 Returns the Portal that was used to create this plane. More...
 
void setFromOgrePlane (Plane &ogrePlane)
 Copy from an Ogre Plane. More...
 
void setPortal (PortalBase *o)
 Sets the Portal that was used to create this plane. More...
 
- Public Member Functions inherited from Ogre::Plane
 Plane ()
 Default constructor - sets everything to 0. More...
 
 Plane (const Vector3 &p0, const Vector3 &p1, const Vector3 &p2)
 
 Plane (const Vector3 &rkNormal, const Vector3 &rkPoint)
 
 Plane (const Vector3 &rkNormal, Real fConstant)
 Construct a plane through a normal, and a distance to move the plane along the normal. More...
 
 Plane (const Vector4 &v)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
 Plane (Real a, Real b, Real c, Real _d)
 Construct a plane using the 4 constants directly. More...
 
Real getDistance (const Vector3 &rkPoint) const
 This is a pseudodistance. More...
 
Side getSide (const AxisAlignedBox &box) const
 Returns the side where the alignedBox is. More...
 
Side getSide (const Vector3 &centre, const Vector3 &halfSize) const
 Returns which side of the plane that the given box lies on. More...
 
Side getSide (const Vector3 &rkPoint) const
 
Real normalise (void)
 Normalises the plane. More...
 
bool operator!= (const Plane &rhs) const
 
Plane operator- () const
 Get flipped plane, with same location but reverted orientation. More...
 
bool operator== (const Plane &rhs) const
 Comparison operator. More...
 
Vector3 projectVector (const Vector3 &v) const
 Project a vector onto the plane. More...
 
void redefine (const Vector3 &p0, const Vector3 &p1, const Vector3 &p2)
 Redefine this plane based on 3 points. More...
 
void redefine (const Vector3 &rkNormal, const Vector3 &rkPoint)
 Redefine this plane based on a normal and a point. More...
 

Additional Inherited Members

- Public Types inherited from Ogre::Plane
enum  Side { NO_SIDE, POSITIVE_SIDE, NEGATIVE_SIDE, BOTH_SIDE }
 The "positive side" of the plane is the half space to which the plane normal points. More...
 
- Public Attributes inherited from Ogre::Plane
Real d
 
Vector3 normal
 

Detailed Description

Portal Culling Plane.

Specialized Plane that is customized for working with the PCZSceneManager. Each Plane has a pointer to the Portal which was used to create it Portal Culling Planes are created from one side of a portal and the origin of a camera.

Constructor & Destructor Documentation

◆ PCPlane() [1/4]

Ogre::PCPlane::PCPlane ( )

Standard constructor.

◆ PCPlane() [2/4]

Ogre::PCPlane::PCPlane ( const Plane plane)

Alternative constructor.

◆ PCPlane() [3/4]

Ogre::PCPlane::PCPlane ( const Vector3 rkNormal,
const Vector3 rkPoint 
)

Alternative constructor.

◆ PCPlane() [4/4]

Ogre::PCPlane::PCPlane ( const Vector3 rkPoint0,
const Vector3 rkPoint1,
const Vector3 rkPoint2 
)

Alternative constructor.

◆ ~PCPlane()

Ogre::PCPlane::~PCPlane ( )

Standard destructor.

Member Function Documentation

◆ setFromOgrePlane()

void Ogre::PCPlane::setFromOgrePlane ( Plane ogrePlane)

Copy from an Ogre Plane.

◆ getPortal()

PortalBase* Ogre::PCPlane::getPortal ( )
inline

Returns the Portal that was used to create this plane.

◆ setPortal()

void Ogre::PCPlane::setPortal ( PortalBase o)
inline

Sets the Portal that was used to create this plane.


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