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 | List of all members
vl::Sector::VisibilityCallback Class Referenceabstract

A callback object called each time a Sector becomes visible through a Portal. More...

#include <SceneManagerPortals.hpp>

+ Inheritance diagram for vl::Sector::VisibilityCallback:

Public Member Functions

virtual void operator() (const Camera *cam, SceneManagerPortals *psm, Sector *s, Portal *p)=0
 Callback. More...
 
- 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...
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Detailed Description

A callback object called each time a Sector becomes visible through a Portal.

Note: a callback can be called multiple times with the same Sector argument if a Sector is discovered multiple times through different portals. Using callbacks can be very useful to perform special actions upon sector discovery, like enabling/disabling animations, enabling/disabling a ActorKdTree scene manager or a Terrain scene manager to render the external environment etc.

Definition at line 119 of file SceneManagerPortals.hpp.

Member Function Documentation

◆ operator()()

virtual void vl::Sector::VisibilityCallback::operator() ( const Camera cam,
SceneManagerPortals psm,
Sector s,
Portal p 
)
pure virtual

Callback.

Note: a callback can be called multiple times with the same Sector argument if a Sector is discovered multiple times through different portals.

Parameters
camThe current Camera.
psmThe SceneManagerPortals that generated the callback.
sThe Sector that has become visible.
pThe Portal used to enter the Sector. It is set to NULL if s is the starting Sector (the Sector in which the camera is).

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