[AE Engine logo] Public API Reference
Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

aeCamera Class Reference

This is a single camera object that can be added to the engine. More...

#include <camera.h>

List of all members.

Public Member Functions

 aeCamera (const char *cName)
 Create a new camera.

char * getName () const
 Get the camera's name.

void setPosition (const aeVector3 &pos)
 Set the camera's position in world.

void setPosition (float x, float y, float z)
 Set the camera's position in world.

void move (const aeVector3 &pos)
 Move the camera by offset in camera space.

void move (float x, float y, float z)
 Move the camera by offset in camera space.

void moveWorld (const aeVector3 &pos)
 Move the camera by offset in world space.

void moveWorld (float x, float y, float z)
 Move the camera by offset in world space.

void setOrientation (const aeVector3 &o)
 Set the camera's orientation (where it is looking at).

void setOrientation (float x, float y, float z)
 Set the camera's orientation (where it is looking at).

aeVector3 getPosition () const
 Get the (world) position of the camera.

aeVector3 getOrientation () const
 Get the orientation of the camera (where it is looking at).

void rotate (const aeVector3 &v, float degrees)
 Rotate the camera around arbitrary axis.


Private Attributes

char * camName
 The camera's name.

aeVector3 camPos
 The camera's (world) position.

aeVector3 camOrientation
 The camera's orientation (where it is looking at).


Detailed Description

This is a single camera object that can be added to the engine.

Use aeEngine::addCamera() to add the camera.

See also:
aeEngine::addCamera().

Definition at line 38 of file camera.h.


Constructor & Destructor Documentation

aeCamera::aeCamera const char *    cName
 

Create a new camera.

Parameters:
camName The camera's name.


Member Function Documentation

char* aeCamera::getName   const [inline]
 

Get the camera's name.

Returns:
The camera's name.

Definition at line 62 of file camera.h.

aeVector3 aeCamera::getOrientation   const [inline]
 

Get the orientation of the camera (where it is looking at).

Returns:
The camera's orientation vector.

Definition at line 140 of file camera.h.

aeVector3 aeCamera::getPosition   const [inline]
 

Get the (world) position of the camera.

Returns:
The camera's (world) position.

Definition at line 133 of file camera.h.

void aeCamera::move float    x,
float    y,
float    z
 

Move the camera by offset in camera space.

Parameters:
x X offset to move the cam in camera space.
y Y offset to move the cam in camera space.
z Z offset to move the cam in camera space.

void aeCamera::move const aeVector3   pos
 

Move the camera by offset in camera space.

Parameters:
pos Vector offset to move the cam in camera space.

void aeCamera::moveWorld float    x,
float    y,
float    z
 

Move the camera by offset in world space.

Parameters:
x X offset to move the camera in world space.
y Y offset to move the camera in world space.
z Z offset to move the camera in world space.

void aeCamera::moveWorld const aeVector3   pos
 

Move the camera by offset in world space.

Parameters:
pos Vector offset to move the camera in world space.

void aeCamera::rotate const aeVector3   v,
float    degrees
 

Rotate the camera around arbitrary axis.

Parameters:
v Axis to rotate around.
degrees Degrees to rotate.

void aeCamera::setOrientation float    x,
float    y,
float    z
 

Set the camera's orientation (where it is looking at).

Parameters:
x X coord of the camera's new orientation.
y Y coord of the camera's new orientation.
z Z coord of the camera's new orientation.

void aeCamera::setOrientation const aeVector3   o
 

Set the camera's orientation (where it is looking at).

Parameters:
o The camera's orientation vector.

void aeCamera::setPosition float    x,
float    y,
float    z
 

Set the camera's position in world.

Parameters:
x The desired camera position X coord.
y The desired camera position Y coord.
z The desired camera position Z coord.

void aeCamera::setPosition const aeVector3   pos
 

Set the camera's position in world.

Parameters:
pos The desired camera's position.


The documentation for this class was generated from the following file:
AE Engine Public API Reference
Generated on Wed Apr 9 09:43:40 2003 by Doxygen.