PowerUI.UICamera Class Reference

Detailed Description

When cameras are placed on the main UI, the UI must be broken up and rendered by multiple cameras. This class represents one of those cameras in a stack.

Public Member Functions
	UICamera (Renderman renderer)
	Creates a new UI Camera which will be rendered with the given renderer. More...
void	SetDepth (int depth)
	Sets the depth of the camera. This affects its height and also where it renders on the screen (before/ after others). More...
void	SetCameraDistance (float distance)
	Sets the distance of the camera, essentially defining the amount of z-index available. More...
void	SetFieldOfView (float fov)
	Sets the field of view of the UI camera. More...
void	Destroy ()
	Permanently destroys this UI camera. More...

Public Attributes
Renderman	Renderer
	The renderer that will render this camera. More...
Camera	SourceCamera
	The camera itself. More...
UICamera	CameraAfter
	Cameras are stored as a linked list. This is the camera after this one. More...
float	CameraDistance
	How far the camera is. Essentially defines the amount of z-index space. More...
UICamera	CameraBefore
	Cameras are stored as a linked list. This is the camera before this one. More...
GameObject	Gameobject
	The parent gameobject. More...
GameObject	CameraObject
	The cameras gameobject. More...

Constructor & Destructor Documentation

PowerUI.UICamera.UICamera ( Renderman  renderer)

inline

Creates a new UI Camera which will be rendered with the given renderer.

Parameters

renderer

The renderer that will render this camera.

Member Function Documentation

void PowerUI.UICamera.Destroy ( )

inline

Permanently destroys this UI camera.

void PowerUI.UICamera.SetCameraDistance ( float  distance)

inline

Sets the distance of the camera, essentially defining the amount of z-index available.

Parameters

distance

The distance of the camera from the origin along the z axis in world units.

void PowerUI.UICamera.SetDepth ( int  depth)

inline

Sets the depth of the camera. This affects its height and also where it renders on the screen (before/ after others).

void PowerUI.UICamera.SetFieldOfView ( float  fov)

inline

Sets the field of view of the UI camera.

Parameters

fov	The field of view, in degrees.

Member Data Documentation

UICamera PowerUI.UICamera.CameraAfter

Cameras are stored as a linked list. This is the camera after this one.

UICamera PowerUI.UICamera.CameraBefore

Cameras are stored as a linked list. This is the camera before this one.

float PowerUI.UICamera.CameraDistance

How far the camera is. Essentially defines the amount of z-index space.

GameObject PowerUI.UICamera.CameraObject

The cameras gameobject.

GameObject PowerUI.UICamera.Gameobject

The parent gameobject.

Renderman PowerUI.UICamera.Renderer

The renderer that will render this camera.

Camera PowerUI.UICamera.SourceCamera

The camera itself.