Public API Reference

                 

---

csFrustumView Class Reference

This structure represents all information needed for the frustum visibility calculator. More...

#include <lview.h>

Inheritance diagram for csFrustumView:

List of all members.

Public Methods
	csFrustumView ()
	Constructor. More...
virtual	~csFrustumView ()
	Destroy the object. More...
virtual csFrustumContext *	GetFrustumContext () const
	Get the current frustum context. More...
virtual void	CreateFrustumContext ()
	Create a new frustum context. More...
virtual csFrustumContext *	CopyFrustumContext ()
	Create a copy. More...
virtual void	SetFrustumContext (csFrustumContext *ctxt)
	Set the frustum context. More...
virtual void	RestoreFrustumContext (csFrustumContext *original)
	Restore a frustum context. More...
virtual void	StartNewShadowBlock ()
	Start new shadow list for this frustum. More...
virtual void	SetObjectFunction (csFrustumViewObjectFunc *func)
	Set the function that is called for every object. More...
virtual void	CallObjectFunction (iMeshWrapper *mesh, bool vis)
	Call the object function. More...
void	SetRadius (float rad)
	Set the maximum radius to use for visiting objects. More...
virtual float	GetRadius () const
	Get the radius. More...
virtual float	GetSquaredRadius () const
	Get the squared radius. More...
void	EnableThingShadows (bool e)
	Enable shadowing for things (off by default). @SUSPECT!!! More...
virtual bool	ThingShadowsEnabled ()
	Return true if shadowing for things is enabled. More...
void	SetShadowMask (unsigned int mask, unsigned int value)
	Set shadow mask. More...
void	SetProcessMask (unsigned int mask, unsigned int value)
	Set process mask. More...
virtual bool	CheckShadowMask (unsigned int mask)
	Check if a mask corresponds with the shadow mask. More...
virtual bool	CheckProcessMask (unsigned int mask)
	Check if a mask corresponds with the process mask. More...
virtual void	SetUserdata (iFrustumViewUserdata *data)
	Set or clear userdata. More...
virtual iFrustumViewUserdata *	GetUserdata ()
	Get userdata. More...
virtual csPtr< iShadowBlock >	CreateShadowBlock ()
	Create a new empty shadow block. More...

---

Detailed Description

This structure represents all information needed for the frustum visibility calculator.

Definition at line 426 of file lview.h.

---

Constructor & Destructor Documentation

csFrustumView::csFrustumView (    )

Constructor.

virtual csFrustumView::~csFrustumView (    )  [virtual]

Destroy the object.

---

Member Function Documentation

virtual void csFrustumView::CallObjectFunction (  iMeshWrapper *    mesh, bool    vis )  [inline, virtual]

Call the object function. Implements iFrustumView. Definition at line 486 of file lview.h.

virtual bool csFrustumView::CheckProcessMask (  unsigned int    mask )  [inline, virtual]

Check if a mask corresponds with the process mask. Implements iFrustumView. Definition at line 522 of file lview.h.

virtual bool csFrustumView::CheckShadowMask (  unsigned int    mask )  [inline, virtual]

Check if a mask corresponds with the shadow mask. Implements iFrustumView. Definition at line 517 of file lview.h.

virtual csFrustumContext* csFrustumView::CopyFrustumContext (    )  [virtual]

Create a copy. Implements iFrustumView.

virtual void csFrustumView::CreateFrustumContext (    )  [virtual]

Create a new frustum context. Implements iFrustumView.

virtual csPtr<iShadowBlock> csFrustumView::CreateShadowBlock (    )  [inline, virtual]

Create a new empty shadow block. Implements iFrustumView. Definition at line 537 of file lview.h.

void csFrustumView::EnableThingShadows (  bool    e )  [inline]

Enable shadowing for things (off by default). @SUSPECT!!! @ Definition at line 501 of file lview.h.

virtual csFrustumContext* csFrustumView::GetFrustumContext (    )  const [inline, virtual]

Get the current frustum context. Implements iFrustumView. Definition at line 467 of file lview.h.

virtual float csFrustumView::GetRadius (    )  const [inline, virtual]

Get the radius. Implements iFrustumView. Definition at line 497 of file lview.h.

virtual float csFrustumView::GetSquaredRadius (    )  const [inline, virtual]

Get the squared radius. Implements iFrustumView. Definition at line 499 of file lview.h.

virtual iFrustumViewUserdata* csFrustumView::GetUserdata (    )  [inline, virtual]

Get userdata. Implements iFrustumView. Definition at line 533 of file lview.h.

virtual void csFrustumView::RestoreFrustumContext (  csFrustumContext *    original )  [virtual]

Restore a frustum context. Implements iFrustumView.

virtual void csFrustumView::SetFrustumContext (  csFrustumContext *    ctxt )  [virtual]

Set the frustum context. Implements iFrustumView.

virtual void csFrustumView::SetObjectFunction (  csFrustumViewObjectFunc *    func )  [inline, virtual]

Set the function that is called for every object. Implements iFrustumView. Definition at line 481 of file lview.h.

void csFrustumView::SetProcessMask (  unsigned int    mask, unsigned int    value )  [inline]

Set process mask. Definition at line 511 of file lview.h.

void csFrustumView::SetRadius (  float    rad )  [inline]

Set the maximum radius to use for visiting objects. Definition at line 491 of file lview.h.

void csFrustumView::SetShadowMask (  unsigned int    mask, unsigned int    value )  [inline]

Set shadow mask. Definition at line 505 of file lview.h.

virtual void csFrustumView::SetUserdata (  iFrustumViewUserdata *    data )  [inline, virtual]

Set or clear userdata. Implements iFrustumView. Definition at line 528 of file lview.h.

virtual void csFrustumView::StartNewShadowBlock (    )  [virtual]

Start new shadow list for this frustum. Implements iFrustumView.

virtual bool csFrustumView::ThingShadowsEnabled (    )  [inline, virtual]

Return true if shadowing for things is enabled. Implements iFrustumView. Definition at line 503 of file lview.h.

---

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

• lview.h

---