Viewport Class Reference
#include <viewport.h>
Detailed Description
The viewport on the map.Displays the current map and handles mouse input and the popup menu.
TODO: This class is planned to be extended to allow floating widgets on top of it such as NPC messages, which are positioned using map pixel coordinates.
Definition at line 51 of file viewport.h.
Public Member Functions | |
| Viewport () | |
| Constructor. | |
| ~Viewport () | |
| Destructor. | |
| void | setMap (Map *map) |
| Sets the map displayed by the viewport. | |
| void | draw (gcn::Graphics *graphics) |
| Draws the viewport. | |
| void | logic () |
| Implements player to keep following mouse. | |
| void | toggleDebugPath () |
| Toggles whether the path debug graphics are shown. | |
| void | mousePressed (gcn::MouseEvent &event) |
| Handles mouse press on map. | |
| void | mouseDragged (gcn::MouseEvent &event) |
| Handles mouse move on map. | |
| void | mouseReleased (gcn::MouseEvent &event) |
| Handles mouse button release on map. | |
| void | mouseMoved (gcn::MouseEvent &event) |
| Handles mouse move on map. | |
| void | showPopup (int x, int y, Item *item) |
| Shows a popup for an item. | |
| void | closePopupMenu () |
| Closes the popup menu. | |
| void | optionChanged (const std::string &name) |
| A relevant config option changed. | |
| int | getCameraX () const |
| Returns camera x offset in pixels. | |
| int | getCameraY () const |
| Returns camera y offset in pixels. | |
| int | getMouseX () const |
| Returns mouse x in pixels. | |
| int | getMouseY () const |
| Returns mouse y in pixels. | |
| void | scrollBy (float x, float y) |
| Changes viewpoint by relative pixel coordinates. | |
Private Member Functions | |
| void | drawDebugPath (Graphics *graphics) |
| Finds a path from the player to the mouse, and draws it. | |
| void | drawPath (Graphics *graphics, const Path &path) |
| Draws the given path. | |
Private Attributes | |
| Map * | mMap |
| The current map. | |
| int | mScrollRadius |
| int | mScrollLaziness |
| int | mScrollCenterOffsetX |
| int | mScrollCenterOffsetY |
| int | mMouseX |
| Current mouse position in pixels. | |
| int | mMouseY |
| Current mouse position in pixels. | |
| float | mPixelViewX |
| Current viewpoint in pixels. | |
| float | mPixelViewY |
| Current viewpoint in pixels. | |
| int | mTileViewX |
| Current viewpoint in tiles. | |
| int | mTileViewY |
| Current viewpoint in tiles. | |
| bool | mShowDebugPath |
| Show a path from player to pointer. | |
| bool | mVisibleNames |
| Show target names. | |
| bool | mPlayerFollowMouse |
| int | mWalkTime |
| PopupMenu * | mPopupMenu |
| Popup menu. | |
| Being * | mSelectedBeing |
| Current selected being. | |
Constructor & Destructor Documentation
| Viewport::Viewport | ( | ) |
| Viewport::~Viewport | ( | ) |
Member Function Documentation
| void Viewport::setMap | ( | Map * | map | ) |
| void Viewport::draw | ( | gcn::Graphics * | graphics | ) |
| void Viewport::logic | ( | ) |
Implements player to keep following mouse.
Reimplemented from WindowContainer.
Definition at line 232 of file viewport.cpp.
| void Viewport::toggleDebugPath | ( | ) | [inline] |
| void Viewport::mousePressed | ( | gcn::MouseEvent & | event | ) |
| void Viewport::mouseDragged | ( | gcn::MouseEvent & | event | ) |
| void Viewport::mouseReleased | ( | gcn::MouseEvent & | event | ) |
| void Viewport::mouseMoved | ( | gcn::MouseEvent & | event | ) |
| void Viewport::showPopup | ( | int | x, | |
| int | y, | |||
| Item * | item | |||
| ) |
Shows a popup for an item.
TODO Find some way to get rid of Item here
Definition at line 444 of file viewport.cpp.
| void Viewport::closePopupMenu | ( | ) |
Closes the popup menu.
Needed for when the player dies or switching maps.
Definition at line 449 of file viewport.cpp.
| void Viewport::optionChanged | ( | const std::string & | name | ) | [virtual] |
A relevant config option changed.
Implements ConfigListener.
Definition at line 454 of file viewport.cpp.
| int Viewport::getCameraX | ( | ) | const [inline] |
| int Viewport::getCameraY | ( | ) | const [inline] |
| int Viewport::getMouseX | ( | ) | const [inline] |
| int Viewport::getMouseY | ( | ) | const [inline] |
| void Viewport::scrollBy | ( | float | x, | |
| float | y | |||
| ) | [inline] |
| void Viewport::drawDebugPath | ( | Graphics * | graphics | ) | [private] |
Finds a path from the player to the mouse, and draws it.
This is for debug purposes.
Definition at line 258 of file viewport.cpp.
Member Data Documentation
Map* Viewport::mMap [private] |
int Viewport::mScrollRadius [private] |
Definition at line 161 of file viewport.h.
int Viewport::mScrollLaziness [private] |
Definition at line 162 of file viewport.h.
int Viewport::mScrollCenterOffsetX [private] |
Definition at line 163 of file viewport.h.
int Viewport::mScrollCenterOffsetY [private] |
Definition at line 164 of file viewport.h.
int Viewport::mMouseX [private] |
int Viewport::mMouseY [private] |
float Viewport::mPixelViewX [private] |
float Viewport::mPixelViewY [private] |
int Viewport::mTileViewX [private] |
int Viewport::mTileViewY [private] |
bool Viewport::mShowDebugPath [private] |
bool Viewport::mVisibleNames [private] |
bool Viewport::mPlayerFollowMouse [private] |
Definition at line 174 of file viewport.h.
int Viewport::mWalkTime [private] |
Definition at line 178 of file viewport.h.
PopupMenu* Viewport::mPopupMenu [private] |
Being* Viewport::mSelectedBeing [private] |
The documentation for this class was generated from the following files:
- tmw/src/gui/viewport.h
- tmw/src/gui/viewport.cpp
