Public Member Functions

sp::scene::ViewFrustum Class Reference

#include <spViewFrustum.hpp>

Inheritance diagram for sp::scene::ViewFrustum:
sp::scene::ConvexPolyhedron< f32, VIEWFRUSTUM_PLANE_COUNT >

List of all members.

Public Member Functions

 ViewFrustum ()
 ViewFrustum (const dim::matrix4f &Matrix)
 ViewFrustum (const ViewFrustum &Other)
virtual ~ViewFrustum ()
void setFrustum (const dim::matrix4f &Matrix)
 Transforms the whole frustum by the specified 4x4 matrix.
void setFrustum (const dim::matrix4f &ViewMatrix, const dim::matrix4f &ProjectionMatrix)
 Transforms the whole frustum by the given view- and projection matrices.
dim::vector3df getLeftUp () const
 Returns a 3D point along the left-up frustum edge.
dim::vector3df getLeftDown () const
 Returns a 3D point along the left-down frustum edge.
dim::vector3df getRightUp () const
 Returns a 3D point along the right-up frustum edge.
dim::vector3df getRightDown () const
 Returns a 3D point along the right-down frustum edge.
const dim::plane3df & getPlane (const EViewFrustumPlanes Type) const
 Returns a constant reference of the specified frustum plane.
dim::plane3df & getPlane (const EViewFrustumPlanes Type)
 Returns a reference of the specified frustum plane.

Detailed Description

View frustum for Camera objects. Each Camera object has one view frustum which defines the whole area which is visible for the user with all its near- and far clippings planes etc. The view frustum can be used for "Frustum Culling" optimization where each object which is outside the view frustum will not be rendered. This safes a lot of time because the renderer does not need to pass each triangle of the mesh when it's anyway completly invisible.

See also:
Node::setBoundingType, Node::setBoundingBox, Node::setBoundingSphere

Constructor & Destructor Documentation

sp::scene::ViewFrustum::ViewFrustum (  ) 
sp::scene::ViewFrustum::ViewFrustum ( const dim::matrix4f &  Matrix  ) 
sp::scene::ViewFrustum::ViewFrustum ( const ViewFrustum &  Other  ) 
sp::scene::ViewFrustum::~ViewFrustum (  )  [virtual]

Member Function Documentation

dim::vector3df sp::scene::ViewFrustum::getLeftDown (  )  const

Returns a 3D point along the left-down frustum edge.

dim::vector3df sp::scene::ViewFrustum::getLeftUp (  )  const

Returns a 3D point along the left-up frustum edge.

dim::plane3df& sp::scene::ViewFrustum::getPlane ( const EViewFrustumPlanes  Type  )  [inline]

Returns a reference of the specified frustum plane.

const dim::plane3df& sp::scene::ViewFrustum::getPlane ( const EViewFrustumPlanes  Type  )  const [inline]

Returns a constant reference of the specified frustum plane.

dim::vector3df sp::scene::ViewFrustum::getRightDown (  )  const

Returns a 3D point along the right-down frustum edge.

dim::vector3df sp::scene::ViewFrustum::getRightUp (  )  const

Returns a 3D point along the right-up frustum edge.

void sp::scene::ViewFrustum::setFrustum ( const dim::matrix4f &  Matrix  ) 

Transforms the whole frustum by the specified 4x4 matrix.

void sp::scene::ViewFrustum::setFrustum ( const dim::matrix4f &  ViewMatrix,
const dim::matrix4f &  ProjectionMatrix 
)

Transforms the whole frustum by the given view- and projection matrices.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Apr 4 2013 23:22:56 for SoftPixel Engine by  doxygen 1.7.1