IonCamera Class Reference

Camera wrapper base class for making custom cameras. More...

#include <IonCamera.h>

Inherits Align16.

Inherited by Camera2D, and GodCam.

Detailed Description

Camera wrapper base class for making custom cameras.

The IonCamera is a base class that allows user access to Camera functions and the ability to Update the camera every frame. This class is used to implement custom cameras.

Public Member Functions
virtual void	Update ()=0
	Function which is called every update frame. More...
Camera *	GetCamera ()
	Function which gives access to the Camera pointer. More...
void	setPerspective (const float FieldOfView_Degs, const float AspectRatio, const float NearDist, const float FarDist)
	Wrapped Camera class function. More...
void	setOrthographic (const float xMin, const float xMax, const float yMin, const float yMax, const float zMin, const float zMax)
	Wrapped Camera class function. More...
void	setViewport (const int inX, const int inY, const int width, const int height)
	Wrapped Camera class function. More...
void	setOrientAndPosition (const Vect &Up_vect, const Vect &inLookAt_pt, const Vect &pos_pt)
	Wrapped Camera class function. More...
void	updateCamera (void)
	Wrapped Camera class function. More...
Matrix &	getViewMatrix ()
	Wrapped Camera class function. More...
Matrix &	getProjMatrix ()
	Wrapped Camera class function. More...
Camera::Type	getType () const
	Wrapped Camera class function. More...
void	getPos (Vect &outPos) const
	Wrapped Camera class function. More...
void	getDir (Vect &outDir) const
	Wrapped Camera class function. More...
void	getUp (Vect &outUp) const
	Wrapped Camera class function. More...
void	getLookAt (Vect &outLookAt) const
	Wrapped Camera class function. More...
void	getRight (Vect &outRight) const
	Wrapped Camera class function. More...
int	getScreenWidth () const
	Wrapped Camera class function. More...
int	getScreenHeight () const
	Wrapped Camera class function. More...
void	getFieldOfView (float &Value) const
	Wrapped Camera class function. More...
void	setFieldOfView (const float Value)
	Wrapped Camera class function. More...

Protected Attributes
Camera *	pCamera

Member Function Documentation

Camera* IonCamera::GetCamera

(

)

Function which gives access to the Camera pointer.

This function returns the pointer to the Camera object within this class.

void IonCamera::getDir

(

Vect &

outDir

)

const

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

void IonCamera::getFieldOfView

(

float &

Value

)

const

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

void IonCamera::getLookAt

(

Vect &

outLookAt

)

const

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

void IonCamera::getPos

(

Vect &

outPos

)

const

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

Matrix& IonCamera::getProjMatrix

(

)

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

void IonCamera::getRight

(

Vect &

outRight

)

const

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

int IonCamera::getScreenHeight

(

)

const

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

int IonCamera::getScreenWidth

(

)

const

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

Camera::Type IonCamera::getType

(

)

const

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

void IonCamera::getUp

(

Vect &

outUp

)

const

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

Matrix& IonCamera::getViewMatrix

(

)

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

void IonCamera::setFieldOfView

(

const float

Value

)

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

void IonCamera::setOrientAndPosition	(	const Vect &	Up_vect,
		const Vect &	inLookAt_pt,
		const Vect &	pos_pt
	)

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

void IonCamera::setOrthographic	(	const float	xMin,
		const float	xMax,
		const float	yMin,
		const float	yMax,
		const float	zMin,
		const float	zMax
	)

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

void IonCamera::setPerspective	(	const float	FieldOfView_Degs,
		const float	AspectRatio,
		const float	NearDist,
		const float	FarDist
	)

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

void IonCamera::setViewport	(	const int	inX,
		const int	inY,
		const int	width,
		const int	height
	)

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

virtual void IonCamera::Update ( )

pure virtual

Function which is called every update frame.

This is a pure virtual function to be overriden by the user. The Update() function will be called by the SceneManager every update frame via its CameraManager. This allows for updating the camera's position, rotation, etc every frame.

void IonCamera::updateCamera

(

void

)

Wrapped Camera class function.

This function is a simple passthrough to be called on pCamera. All the wrapped functions allow access to the Camera class functions of the same name.

Member Data Documentation

Camera* IonCamera::pCamera

protected

Pointer to the Camera object for this class