Angel
A 2D Game Prototyping Engine
Public Member Functions
FullScreenActor Class Reference

An Actor which takes up the whole drawing space. More...

#include <FullScreenActor.h>

+ Inheritance diagram for FullScreenActor:

List of all members.

Public Member Functions

 FullScreenActor ()
void SetLock (bool locked)
const bool IsLocked ()
virtual void ReceiveMessage (Message *message)
virtual const String GetClassName ()

Detailed Description

A FullScreenActor will resize itself whenever the size of the drawing space changes. This makes it useful for backdrops, curtains, splash screens, etc.

Definition at line 39 of file FullScreenActor.h.


Constructor & Destructor Documentation

FullScreenActor::FullScreenActor ( )

The constructor subscribes the Actor to CameraChange messages and does the initial orientation to the camera.

Definition at line 36 of file FullScreenActor.cpp.


Member Function Documentation

void FullScreenActor::SetLock ( bool  locked)

You can lock a FullScreenActor to keep it from tracking the changes to the drawing area or camera. When you unlock it, it will snap back to taking up the whole screen.

Parameters:
lockedwhether or not the FullScreenActor should continue to track camera changes

Definition at line 43 of file FullScreenActor.cpp.

const bool FullScreenActor::IsLocked ( )

To check on the lock status.

Returns:
whether or not this FullScreenActor is currently tracking the camera

Definition at line 52 of file FullScreenActor.cpp.

void FullScreenActor::ReceiveMessage ( Message message) [virtual]

An implementation of the MessageListener interface, which listens for CameraChange messages and responds appropriately.

See also:
MessageListener
Parameters:
messageThe message getting delivered.

Reimplemented from Actor.

Definition at line 57 of file FullScreenActor.cpp.

virtual const String FullScreenActor::GetClassName ( ) [inline, virtual]

Used by the SetName function to create a basename for this class. Overridden from Actor::GetClassName.

Returns:
The string "FullScreenActor"

Reimplemented from Actor.

Definition at line 80 of file FullScreenActor.h.


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