Camera Namespace Reference

Typedefs
typedef enum Camera::COMPASS_DIRECTION	COMPASS_DIRECTION
typedef enum Camera::CAMERA_PITCH	CAMERA_PITCH

Enumerations
enum	COMPASS_DIRECTION { NORTH = 0 , EAST = 90 , SOUTH = 180 , WEST = 270 }
enum	CAMERA_PITCH { LOWEST = 128 , MIDDLE = 191 , HIGHEST = 383 }

Functions
std::int32_t	GetX ()
std::int32_t	GetY ()
std::int32_t	GetZ ()
std::int32_t	GetYaw ()
double	GetAngle ()
std::int32_t	GetPitch ()
double	GetZoom ()
bool	RotateTo (std::int32_t Angle, std::int32_t Tolerance=10)
	Rotates the camera to the passed angle/degree. More...
bool	RotateTo (COMPASS_DIRECTION Direction, std::int32_t Tolerance=10)
	Rotates the camera to the passed direction (Camera::NORTH/EAST/SOUTH/WEST) More...
bool	RotateTo (const Tile &T, std::int32_t Angle=0, std::int32_t Tolerance=10)
	Rotates the camera to the passed tile, with an optional desired Angle. More...
bool	RotateTo (const Tile &T, COMPASS_DIRECTION Direction=NORTH, std::int32_t Tolerance=10)
	Rotates the camera to the passed tile, with an optional desired direction. More...
bool	SetPitch (std::int32_t Pitch)
	Sets the pitch of the camera. More...
bool	SetPitch (CAMERA_PITCH Pitch)
	Sets the pitch of the camera. More...

Typedef Documentation

CAMERA_PITCH

typedef enum Camera::CAMERA_PITCH Camera::CAMERA_PITCH

COMPASS_DIRECTION

typedef enum Camera::COMPASS_DIRECTION Camera::COMPASS_DIRECTION

Enumeration Type Documentation

CAMERA_PITCH

enum Camera::CAMERA_PITCH

Enumerator
LOWEST
MIDDLE
HIGHEST

Definition at line 17 of file Camera.hpp.

COMPASS_DIRECTION

enum Camera::COMPASS_DIRECTION

Enumerator
NORTH
EAST
SOUTH
WEST

Definition at line 9 of file Camera.hpp.

Function Documentation

GetAngle()

double Camera::GetAngle

(

)

GetPitch()

std::int32_t Camera::GetPitch

(

)

GetX()

std::int32_t Camera::GetX

(

)

GetY()

std::int32_t Camera::GetY

(

)

GetYaw()

std::int32_t Camera::GetYaw

(

)

GetZ()

std::int32_t Camera::GetZ

(

)

GetZoom()

double Camera::GetZoom

(

)

RotateTo() [1/4]

bool Camera::RotateTo	(	COMPASS_DIRECTION	Direction,
		std::int32_t	Tolerance = 10
	)

Rotates the camera to the passed direction (Camera::NORTH/EAST/SOUTH/WEST)

Parameters

Direction	Camera::NORTH / EAST / SOUTH / WEST
Tolerance	angle tolerance used to determine if it no longer needs to keep rotating (+/-)

Returns

true if it rotates within (+/-) 10 of the passed direction

RotateTo() [2/4]

bool Camera::RotateTo	(	const Tile &	T,
		COMPASS_DIRECTION	Direction = NORTH,
		std::int32_t	Tolerance = 10
	)

Rotates the camera to the passed tile, with an optional desired direction.

Parameters

T	tile to rotate to
Tolerance	angle tolerance used to determine if it no longer needs to keep rotating (+/-)
Direction	optional desired angle of where the tile should be in relation to the player (NORTH/EAST/SOUTH/WEST), defaulted to North

Returns

true if it rotates within (+/-) 10 of the passed tile and direction

RotateTo() [3/4]

bool Camera::RotateTo	(	const Tile &	T,
		std::int32_t	Angle = 0,
		std::int32_t	Tolerance = 10
	)

Rotates the camera to the passed tile, with an optional desired Angle.

Parameters

T	tile to rotate to
Angle	optional desired angle of where the tile should be in relation to the player, defaulted to 0 or North
Tolerance	angle tolerance used to determine if it no longer needs to keep rotating (+/-)

Returns

true if it rotates within (+/-) 10 of the passed tile and angle

RotateTo() [4/4]

bool Camera::RotateTo	(	std::int32_t	Angle,
		std::int32_t	Tolerance = 10
	)

Rotates the camera to the passed angle/degree.

Parameters

Angle	or degree
Tolerance	angle tolerance used to determine if it no longer needs to keep rotating (+/-)

Returns

true if it rotates within (+/-) 10 of the passed angle

SetPitch() [1/2]

bool Camera::SetPitch

(

CAMERA_PITCH

Pitch

)

Sets the pitch of the camera.

Parameters

Pitch

desired pitch (Camera::LOWEST/MIDDLE/HIGHEST)

Returns

true if the camera sets the pitch (+/-) 10 of the passed pitch

SetPitch() [2/2]

bool Camera::SetPitch

(

std::int32_t

Pitch

)

Sets the pitch of the camera.

Parameters

Pitch

desired pitch

Returns

true if the camera sets the pitch (+/-) 10 of the passed pitch