SilverLining
Public Types | Public Member Functions | List of all members
SilverLining::Frustum Class Reference

A simple class that just collects six planes together and calls it a frustum. More...

#include <Frustum.h>

Inheritance diagram for SilverLining::Frustum:
Inheritance graph
[legend]
Collaboration diagram for SilverLining::Frustum:
Collaboration graph
[legend]

Public Types

enum  Planes
 Identifiers for each of the six planes that make up the viewing frustum. More...
 

Public Member Functions

 Frustum ()
 Default constructor.
 
 ~Frustum ()
 Destructor; does nothing.
 
void SILVERLINING_API SetPlane (int planeNum, const Plane &plane)
 Assigns a plane to one of the enumerated planes of the frustum.
 
const Plane &SILVERLINING_API GetPlane (int planeNum) const
 Retrieves a specific Plane of the frustum.
 
void SILVERLINING_API EnableFarClipCulling (bool bEnable)
 Enables culling against the far clip plane from this frustum (enabled by default.)
 

Detailed Description

A simple class that just collects six planes together and calls it a frustum.

Member Enumeration Documentation

◆ Planes

Identifiers for each of the six planes that make up the viewing frustum.

Constructor & Destructor Documentation

◆ Frustum()

SilverLining::Frustum::Frustum ( )
inline

Default constructor.

◆ ~Frustum()

SilverLining::Frustum::~Frustum ( )
inline

Destructor; does nothing.

Member Function Documentation

◆ GetPlane()

const Plane &SILVERLINING_API SilverLining::Frustum::GetPlane ( int  planeNum) const
inline

Retrieves a specific Plane of the frustum.

Parameters
planeNumA member of the Planes enumeration, specifying if you wish to retrieve the near, left, right, top, bottom, or back frustum plane.
Returns
A const reference to the Plane object requested.

◆ SetPlane()

void SILVERLINING_API SilverLining::Frustum::SetPlane ( int  planeNum,
const Plane plane 
)
inline

Assigns a plane to one of the enumerated planes of the frustum.

Parameters
planeNumA member of the Planes enumeration, specifying if this plane represents the near, left, right, top, bottom, or back frustum plane.
planeA Plane object representing the Frustum plane specified.

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