CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iFrustumView Struct Reference
[Visibility]

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

#include <fview.h>

Inheritance diagram for iFrustumView:

iBase csFrustumView List of all members.

Public Methods

virtual csFrustumContextGetFrustumContext () const=0
 Get the current frustum context. More...

virtual void CreateFrustumContext ()=0
 Create a new frustum context. More...

virtual csFrustumContextCopyFrustumContext ()=0
 Create a copy of the current frustum context and return it. More...

virtual void SetFrustumContext (csFrustumContext *ctxt)=0
 This function is similar to CreateFrustumContext() but it sets the given frustum context instead. More...

virtual void RestoreFrustumContext (csFrustumContext *original)=0
 Restore a frustum context. More...

virtual void SetObjectFunction (csFrustumViewObjectFunc *func)=0
 Set the object function. More...

virtual void CallObjectFunction (iMeshWrapper *mesh, bool vis)=0
 Call the object function. More...

virtual float GetRadius () const=0
 Get the radius. More...

virtual float GetSquaredRadius () const=0
 Get the squared radius. More...

virtual bool ThingShadowsEnabled ()=0
 Return true if shadowing for things is enabled. More...

virtual bool CheckShadowMask (unsigned int mask)=0
 Check if a mask corresponds with the shadow mask. More...

virtual bool CheckProcessMask (unsigned int mask)=0
 Check if a mask corresponds with the process mask. More...

virtual void StartNewShadowBlock ()=0
 Start new shadow list for this frustum. More...

virtual void SetUserdata (iFrustumViewUserdata *data)=0
 Set or clear userdata. More...

virtual iFrustumViewUserdataGetUserdata ()=0
 Get userdata. More...

virtual csPtr< iShadowBlockCreateShadowBlock ()=0
 Create a new empty shadow block. More...


Detailed Description

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

Definition at line 143 of file fview.h.


Member Function Documentation

virtual void iFrustumView::CallObjectFunction iMeshWrapper   mesh,
bool    vis
[pure virtual]
 

Call the object function.

Implemented in csFrustumView.

virtual bool iFrustumView::CheckProcessMask unsigned int    mask [pure virtual]
 

Check if a mask corresponds with the process mask.

Implemented in csFrustumView.

virtual bool iFrustumView::CheckShadowMask unsigned int    mask [pure virtual]
 

Check if a mask corresponds with the shadow mask.

Implemented in csFrustumView.

virtual csFrustumContext* iFrustumView::CopyFrustumContext   [pure virtual]
 

Create a copy of the current frustum context and return it.

This can be used to later put it back. Use SetFrustumContext() for this.

Implemented in csFrustumView.

virtual void iFrustumView::CreateFrustumContext   [pure virtual]
 

Create a new frustum context.

This is typically used when going through a portal. Note that you should remember the old frustum context if you want to restore it later. The frustum context will get all the values from the current context (with SCF references properly incremented).

Implemented in csFrustumView.

virtual csPtr<iShadowBlock> iFrustumView::CreateShadowBlock   [pure virtual]
 

Create a new empty shadow block.

Implemented in csFrustumView.

virtual csFrustumContext* iFrustumView::GetFrustumContext   const [pure virtual]
 

Get the current frustum context.

Implemented in csFrustumView.

virtual float iFrustumView::GetRadius   const [pure virtual]
 

Get the radius.

Implemented in csFrustumView.

virtual float iFrustumView::GetSquaredRadius   const [pure virtual]
 

Get the squared radius.

Implemented in csFrustumView.

virtual iFrustumViewUserdata* iFrustumView::GetUserdata   [pure virtual]
 

Get userdata.

Implemented in csFrustumView.

virtual void iFrustumView::RestoreFrustumContext csFrustumContext   original [pure virtual]
 

Restore a frustum context.

Use this to restore a previously overwritten frustum context. This function will take care of properly cleaning up the current frustum context.

Implemented in csFrustumView.

virtual void iFrustumView::SetFrustumContext csFrustumContext   ctxt [pure virtual]
 

This function is similar to CreateFrustumContext() but it sets the given frustum context instead.

Also restore with RestoreFrustumContext().

Implemented in csFrustumView.

virtual void iFrustumView::SetObjectFunction csFrustumViewObjectFunc *    func [pure virtual]
 

Set the object function.

Implemented in csFrustumView.

virtual void iFrustumView::SetUserdata iFrustumViewUserdata   data [pure virtual]
 

Set or clear userdata.

Implemented in csFrustumView.

virtual void iFrustumView::StartNewShadowBlock   [pure virtual]
 

Start new shadow list for this frustum.

Implemented in csFrustumView.

virtual bool iFrustumView::ThingShadowsEnabled   [pure virtual]
 

Return true if shadowing for things is enabled.

Implemented in csFrustumView.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14