PowerUI.CameraPool Class Reference

Detailed Description

Managed automatically. You don't need to do anything with this class. When cameras are placed on the main UI, the UI must be broken up and rendered by multiple cameras. This class represents the set of cameras. It's created on first demand, and used from UI.MainCameraPool.

Public Member Functions
	CameraPool ()
	Creates a new pool with default values. More...
bool	CheckCameraRequired ()
	Called on a pool if a camera was requested. This call occurs when something on the main UI is being rendered ontop of an inline camera. More...
void	Reset ()
	Resets the pool. Called before a main UI layout occurs. More...
void	Destroy ()
	Destroys everything in this set. More...
void	ClearPool ()
	Clears the inactive pool. More...
UICamera	GetPooledCamera ()
	Gets a camera from the inactive pool. Null if the pool is empty. More...
void	AddCamera (UICamera camera)
	Adds the given active camera to the main linked list for processing. More...

Public Attributes
bool	DidLayout
	True if layout was called on this camera pool. More...
int	CameraDepth
	The current depth the camera's are being set at. More...
UICamera	LastCamera
	Linked list. The last active camera in the pool. More...
UICamera	FirstCamera
	Linked list. The first active camera in the pool. More...
bool	CameraRequested
	True if this renderman must create a new camera on demand. More...
UICamera	LastPoolCamera
	Linked list. The last inactive camera in the pool. More...
UICamera	FirstPoolCamera
	Linked list. The first inactive camera in the pool. More...

Properties
int	AllocatedDepth [get]
	Allocates a camera depth. More...

Constructor & Destructor Documentation

PowerUI.CameraPool.CameraPool ( )

inline

Creates a new pool with default values.

Member Function Documentation

void PowerUI.CameraPool.AddCamera ( UICamera  camera)

inline

Adds the given active camera to the main linked list for processing.

bool PowerUI.CameraPool.CheckCameraRequired ( )

inline

Called on a pool if a camera was requested. This call occurs when something on the main UI is being rendered ontop of an inline camera.

void PowerUI.CameraPool.ClearPool ( )

inline

Clears the inactive pool.

void PowerUI.CameraPool.Destroy ( )

inline

Destroys everything in this set.

UICamera PowerUI.CameraPool.GetPooledCamera ( )

inline

Gets a camera from the inactive pool. Null if the pool is empty.

void PowerUI.CameraPool.Reset ( )

inline

Resets the pool. Called before a main UI layout occurs.

Member Data Documentation

int PowerUI.CameraPool.CameraDepth

The current depth the camera's are being set at.

bool PowerUI.CameraPool.CameraRequested

True if this renderman must create a new camera on demand.

bool PowerUI.CameraPool.DidLayout

True if layout was called on this camera pool.

UICamera PowerUI.CameraPool.FirstCamera

Linked list. The first active camera in the pool.

UICamera PowerUI.CameraPool.FirstPoolCamera

Linked list. The first inactive camera in the pool.

UICamera PowerUI.CameraPool.LastCamera

Linked list. The last active camera in the pool.

UICamera PowerUI.CameraPool.LastPoolCamera

Linked list. The last inactive camera in the pool.

Property Documentation

int PowerUI.CameraPool.AllocatedDepth

get

Allocates a camera depth.