CrystalSpace

Public API Reference

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

iVisibilityObject Struct Reference
[Visibility]

An object that wants to know if it is visible or not for some visibility culler needs to implement this interface. More...

#include <viscull.h>

Inheritance diagram for iVisibilityObject:

iBase List of all members.

Public Methods

virtual iMovableGetMovable () const=0
 Get the reference to the movable from this object. More...

virtual iMeshWrapperGetMeshWrapper () const=0
 Get the reference to the mesh wrapper from this object. More...

virtual void SetVisibilityNumber (uint32 visnr)=0
 Set the visibility number for this object. More...

virtual uint32 GetVisibilityNumber () const=0
 Get the visibility number. More...

virtual iObjectModelGetObjectModel ()=0
 Get the object model corresponding with this object. More...

virtual csFlagsGetCullerFlags ()=0
 Get flags for this object. More...


Detailed Description

An object that wants to know if it is visible or not for some visibility culler needs to implement this interface.

Definition at line 214 of file viscull.h.


Member Function Documentation

virtual csFlags& iVisibilityObject::GetCullerFlags   [pure virtual]
 

Get flags for this object.

This is a combination of zero or more of the following flags. See the documentation with these flags for more info:

virtual iMeshWrapper* iVisibilityObject::GetMeshWrapper   const [pure virtual]
 

Get the reference to the mesh wrapper from this object.

virtual iMovable* iVisibilityObject::GetMovable   const [pure virtual]
 

Get the reference to the movable from this object.

virtual iObjectModel* iVisibilityObject::GetObjectModel   [pure virtual]
 

Get the object model corresponding with this object.

virtual uint32 iVisibilityObject::GetVisibilityNumber   const [pure virtual]
 

Get the visibility number.

You can compare this with iVisibilityCuller->GetCurrentVisibilityNumber(). If equal then this object is visible.

virtual void iVisibilityObject::SetVisibilityNumber uint32    visnr [pure virtual]
 

Set the visibility number for this object.

A visibility culler will set the visibility number of an object equal to the current visibility culler number if the object is visible.


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