Public Member Functions | Protected Attributes

Camera Class Reference

#include <Camera.h>

Inheritance diagram for Camera:
IsoCamera

List of all members.

Public Member Functions

 Camera (int viewportW, int viewportH, int worldspaceW, int worldspaceH, int tileW, int tileH, int tileMaxH)
 Camera ()
virtual ~Camera ()
void set (int x, int y)
void move (int x, int y)
void attach (Entity *entity)
void detach ()
int getCornerTileX () const
virtual int getCornerTileY () const
int getNumXTileLoops () const
virtual int getNumYTileLoops () const
int getScrollOffsetX () const
int getScrollOffsetY () const
int getViewportWidth () const
int getViewportHeight () const
int getViewportX () const
int getViewportY () const

Protected Attributes

int mViewportX
int mViewportY
int mViewportW
int mViewportH
int mScrollSpaceW
int mScrollSpaceH
int mTileCoordX
int mTileCoordY
int mNumXTileLoops
int mNumYTileLoops
int mScrollOffsetX
int mScrollOffsetY
int mTileWidth
int mTileHeight
int mTileTallestHeight

Detailed Description

Todo:
Properly document me.
Note:
The Camera object is intended for use solely within the context of a Map object.

Constructor & Destructor Documentation

Camera::Camera ( int  viewportW,
int  viewportH,
int  worldspaceW,
int  worldspaceH,
int  tileW,
int  tileH,
int  tileMaxH 
)
Camera::Camera (  ) 
virtual Camera::~Camera (  )  [inline, virtual]

Member Function Documentation

void Camera::attach ( Entity entity  ) 

Attach Camera to an Entity.

void Camera::detach (  ) 

Detach Camera from an Entity.

int Camera::getCornerTileX (  )  const

Returns the X-Coordiante of the tile at the upper left corner of the viewport.

int Camera::getCornerTileY (  )  const [virtual]

Returns the Y-Coordiante of the tile at the upper left corner of the viewport.

int Camera::getNumXTileLoops (  )  const

Returns the number of tiles needed to be drawn along the X-Coordinate to fill a viewport.

int Camera::getNumYTileLoops (  )  const [virtual]

Returns the number of tiles needed to be drawn along the Y-Coordinate to fill a viewport.

Reimplemented in IsoCamera.

int Camera::getScrollOffsetX (  )  const

Returns the scroller X-Offset.

int Camera::getScrollOffsetY (  )  const

Returns the scroller Y-Offset.

int Camera::getViewportHeight (  )  const
int Camera::getViewportWidth (  )  const
int Camera::getViewportX (  )  const
int Camera::getViewportY (  )  const
void Camera::move ( int  x,
int  y 
)

Move Camera position by X, Y.

void Camera::set ( int  x,
int  y 
)

Sets Camera position to fine coordinate X, Y.


Member Data Documentation

int Camera::mNumXTileLoops [protected]
int Camera::mNumYTileLoops [protected]

Number of tiles required to fill t Viewport.

int Camera::mScrollOffsetX [protected]
int Camera::mScrollOffsetY [protected]

Scroller offsets used for tile placement, visual aids and mousemap calculations.

int Camera::mScrollSpaceH [protected]

Maximum values that the Viewport's X/Y Coordinates can have.

int Camera::mScrollSpaceW [protected]
int Camera::mTileCoordX [protected]
int Camera::mTileCoordY [protected]

Tile coordinates for the tile at the upper left corner of the Viewport.

int Camera::mTileHeight [protected]

Tile dimensions.

int Camera::mTileTallestHeight [protected]

Tallest tile height.

int Camera::mTileWidth [protected]
int Camera::mViewportH [protected]

Width/Height of the Viewport.

int Camera::mViewportW [protected]
int Camera::mViewportX [protected]
int Camera::mViewportY [protected]

X/Y Coordinate of the Viewport within Worldspace.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines