Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Attributes | List of all members
vl::Frustum Class Reference

A set of planes defining a frustum used for culling purposes (frustum culling). More...

#include <Frustum.hpp>

+ Inheritance diagram for vl::Frustum:

Public Member Functions

std::vector< Plane > & planes ()
 
const std::vector< Plane > & planes () const
 
void setPlane (unsigned i, const Plane &plane)
 
const Planeplane (unsigned i) const
 
bool cull (const Sphere &sphere) const
 
bool cull (const AABB &aabb) const
 
bool cull (const std::vector< fvec3 > &points) const
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Protected Attributes

std::vector< PlanemPlanes
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 

Detailed Description

A set of planes defining a frustum used for culling purposes (frustum culling).

See also
Camera, Viewport

Definition at line 49 of file Frustum.hpp.

Member Function Documentation

◆ cull() [1/3]

bool vl::Frustum::cull ( const Sphere sphere) const
inline

◆ cull() [2/3]

bool vl::Frustum::cull ( const AABB aabb) const
inline

Definition at line 73 of file Frustum.hpp.

References vl::AABB::isNull(), vl::Plane::isOutside(), plane(), and planes().

◆ cull() [3/3]

bool vl::Frustum::cull ( const std::vector< fvec3 > &  points) const
inline

Definition at line 85 of file Frustum.hpp.

References vl::Plane::distance(), plane(), and planes().

◆ plane()

const Plane& vl::Frustum::plane ( unsigned  i) const
inline

Definition at line 58 of file Frustum.hpp.

References mPlanes, and VL_CHECK.

Referenced by vl::Camera::adjustView(), cull(), and setPlane().

◆ planes() [1/2]

std::vector<Plane>& vl::Frustum::planes ( )
inline

◆ planes() [2/2]

const std::vector<Plane>& vl::Frustum::planes ( ) const
inline

Definition at line 55 of file Frustum.hpp.

References mPlanes.

◆ setPlane()

void vl::Frustum::setPlane ( unsigned  i,
const Plane plane 
)
inline

Definition at line 57 of file Frustum.hpp.

References mPlanes, plane(), and VL_CHECK.

Referenced by vl::SceneManagerPortals::visitSector().

Member Data Documentation

◆ mPlanes

std::vector<Plane> vl::Frustum::mPlanes
protected

Definition at line 100 of file Frustum.hpp.

Referenced by plane(), planes(), and setPlane().


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