1. Home
  2. Documentation
  3. API
  4. CameraMovementManager Class Reference

CameraMovementManager Class Reference

#include <CameraMovementManager.h>

Inheritance diagram for CameraMovementManager:
ListenerObject

# Public Member Functions

void constructor ()
 Class' constructor.
override bool onEvent (ListenerObject eventFirer, uint16 eventCode)
void reset ()
 Reset the manager's state.
void setFocusActor (Actor focusActor)
Actor getFocusActor ()
void setFocusActorPositionDisplacement (const Vector3D *focusActorPositionDisplacement)
const Vector3D * getFocusActorPositionDisplacement ()
Vector3D getLastCameraDisplacement ()
virtual Vector3D focus (Camera camera)

# Protected Attributes

Vector3D focusActorPositionDisplacement
Actor focusActor
 Actor to focus on the camera.
const Vector3D * focusActorPosition
 Cache of the focus actor's position pointer.
const Rotation * focusActorRotation
 Cache of the focus actor's rotation pointer.

# Additional Inherited Members

- Private Member Functions inherited from ListenerObject
void constructor ()
 Class' constructor.
void destructor ()
 Class' destructor.
void addEventListener (ListenerObject listener, uint16 eventCode)
void removeEventListener (ListenerObject listener, uint16 eventCode)
void removeEventListeners (uint16 eventCode)
void removeAllEventListeners ()
 Remove all listener objects.
bool hasActiveEventListeners ()
void fireEvent (uint16 eventCode)
void sendMessageTo (ListenerObject receiver, uint32 message, uint32 delay, uint32 randomDelay)
void sendMessageToSelf (uint32 message, uint32 delay, uint32 randomDelay)
void discardAllMessages ()
 Discard all messages, both to be sent and to be received.
void discardMessages (uint32 message)
virtual bool handleMessage (Telegram telegram)
- Private Attributes inherited from ListenerObject
VirtualList events
 List of registered events.
int8 eventFirings
 Counter that keeps track of the number of fired events to prevent race conditions in nested firings.

# Detailed Description

Class CameraMovementManager

Inherits from ListenerObject

Manages camera's movement effects, like shaking, etc.

Definition at line 35 of file CameraMovementManager.h.

# Member Function Documentation

# constructor()

void CameraMovementManager::constructor ( )

Class' constructor.

Definition at line 33 of file CameraMovementManager.c.

# focus()

Vector3D CameraMovementManager::focus ( Camera camera)
virtual

Focus the camera on the focus actor if any.

Parameters
cameraCamera to focus

Definition at line 129 of file CameraMovementManager.c.

# getFocusActor()

Actor CameraMovementManager::getFocusActor ( )

Retrieve the actor that the camera is following.

Returns
focusActor: Actor being followed

Definition at line 102 of file CameraMovementManager.c.

# getFocusActorPositionDisplacement()

const Vector3D * CameraMovementManager::getFocusActorPositionDisplacement ( )

Retrieve the displacement that is added to the camera's position relative to the focus actor's position.

Returns
Displacement vector

Definition at line 122 of file CameraMovementManager.c.

# getLastCameraDisplacement()

Vector3D CameraMovementManager::getLastCameraDisplacement ( )

Retrieve the camera's change of position in the last game cycle

Returns
Camera's change of position in the last game cycle

# onEvent()

bool CameraMovementManager::onEvent ( ListenerObject eventFirer,
uint16 eventCode )
virtual

Process an event that the instance is listen for.

Parameters
eventFirerListenerObject that signals the event
eventCodeCode of the firing event
Returns
False if the listener has to be removed; true to keep it

Reimplemented from ListenerObject.

Definition at line 51 of file CameraMovementManager.c.

# reset()

void CameraMovementManager::reset ( )

Reset the manager's state.

Definition at line 71 of file CameraMovementManager.c.

# setFocusActor()

void CameraMovementManager::setFocusActor ( Actor focusActor)

Register the actor that the camera must follow.

Parameters
focusActorActor to follow

Definition at line 80 of file CameraMovementManager.c.

# setFocusActorPositionDisplacement()

void CameraMovementManager::setFocusActorPositionDisplacement ( const Vector3D * focusActorPositionDisplacement)

Register a displacement to be added to the camera's position relative to the focus actor's position.

Parameters
focusActorPositionDisplacementDisplacement vector

Definition at line 109 of file CameraMovementManager.c.

# Member Data Documentation

# focusActor

Actor CameraMovementManager::focusActor
protected

Actor to focus on the camera.

Definition at line 44 of file CameraMovementManager.h.

# focusActorPosition

const Vector3D* CameraMovementManager::focusActorPosition
protected

Cache of the focus actor's position pointer.

Definition at line 47 of file CameraMovementManager.h.

# focusActorPositionDisplacement

Vector3D CameraMovementManager::focusActorPositionDisplacement
protected

Displacement to the focus actor's position to focus the camera on

Definition at line 41 of file CameraMovementManager.h.

# focusActorRotation

const Rotation* CameraMovementManager::focusActorRotation
protected

Cache of the focus actor's rotation pointer.

Definition at line 50 of file CameraMovementManager.h.


The documentation for this class was generated from the following files: