ScrollView Class Reference

#include <ScrollView.h>

Inheritance diagram for ScrollView:

Window MapView

List of all members.


Public Types

enum  SCROLL_STATE { SCROLL_STATE_UP = 0x0001, SCROLL_STATE_DOWN = 0x0002, SCROLL_STATE_LEFT = 0x0004, SCROLL_STATE_RIGHT = 0x0008 }
 Enumeration of valid scroll states. More...

Public Member Functions

 ScrollView ()
 (*** add brief description here ***)
virtual ~ScrollView ()
 (*** add brief description here ***)
virtual void FrameResized (int w, int h)
 (*** add brief description here ***)
void Scroll (int dx, int dy)
 (*** add brief description here ***)
void Warp (int x, int y)
 (*** add brief description here ***)
virtual void Draw (Rect rect)
 (*** add brief description here ***)
Rect GetViewport ()
 (*** add brief description here ***)
void Refresh ()
 (*** add brief description here ***)
void SetVelocity (float vel)
 (*** add brief description here ***)
void SetAcceleration (float acc)
 (*** add brief description here ***)
virtual void OnTimer (float dt)
 (*** add brief description here ***)
Point GetCenter ()
 (*** add brief description here ***)
void SetCenter (Point point)
 (*** add brief description here ***)
void SetCorner (Point point)
 (*** add brief description here ***)
void SetState (int state)
 (*** add brief description here ***)
void ClearState (int state)
 (*** add brief description here ***)

Protected Member Functions

virtual void DrawImage (Rect rect, Surface *surface, int x, int y)=0
 (*** add brief description here ***)
virtual void ViewportChanged ()=0
 (*** add brief description here ***)
void UpdateRect (Rect &rect, bool clip=true)
 (*** add brief description here ***)
virtual int GetImageWidth ()=0
 (*** add brief description here ***)
virtual int GetImageHeight ()=0
 (*** add brief description here ***)
void UpdateVScroll (float dt)
 (*** add brief description here ***)
void UpdateHScroll (float dt)
 (*** add brief description here ***)

Private Attributes

Surfacem_buffer
 (*** add brief description here ***)
Rect m_viewport
 (*** add brief description here ***)
float m_vx
 (*** add brief description here ***)
float m_vy
 (*** add brief description here ***)
float m_xmin
 (*** add brief description here ***)
float m_xmax
 (*** add brief description here ***)
float m_ymin
 (*** add brief description here ***)
float m_ymax
 (*** add brief description here ***)
float m_pixel_vel
 (*** add brief description here ***)
float m_pixel_acc
 (*** add brief description here ***)
int m_oldx
 (*** add brief description here ***)
int m_oldy
 (*** add brief description here ***)
int m_state
 (*** add brief description here ***)
float m_px
 (*** add brief description here ***)
float m_py
 (*** add brief description here ***)

Detailed Description

(*** add brief description here ***)
Full Description
(*** add full description here ***)

Member Enumeration Documentation

Enumeration of valid scroll states.

Enumerator:
SCROLL_STATE_UP  Scroll up.
SCROLL_STATE_DOWN  Scroll down.
SCROLL_STATE_LEFT  Scroll left.
SCROLL_STATE_RIGHT  Scroll right.


Constructor & Destructor Documentation

ScrollView (  ) 

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

~ScrollView (  )  [virtual]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)


Member Function Documentation

void FrameResized ( int  w,
int  h 
) [virtual]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

Reimplemented from Window.

void Scroll ( int  dx,
int  dy 
)

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

void Warp ( int  x,
int  y 
)

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

void Draw ( Rect  rect  )  [virtual]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

Reimplemented from Window.

Rect GetViewport (  )  [inline]

(*** add brief description here ***)

void Refresh (  ) 

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

void SetVelocity ( float  vel  )  [inline]

(*** add brief description here ***)

void SetAcceleration ( float  acc  )  [inline]

(*** add brief description here ***)

void OnTimer ( float  dt  )  [virtual]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

Reimplemented from Window.

Point GetCenter (  ) 

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

void SetCenter ( Point  point  ) 

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

void SetCorner ( Point  point  ) 

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

void SetState ( int  state  )  [inline]

(*** add brief description here ***)

void ClearState ( int  state  )  [inline]

(*** add brief description here ***)

virtual void DrawImage ( Rect  rect,
Surface surface,
int  x,
int  y 
) [protected, pure virtual]

(*** add brief description here ***)

Implemented in MapView.

virtual void ViewportChanged (  )  [protected, pure virtual]

(*** add brief description here ***)

Implemented in MapView.

void UpdateRect ( Rect rect,
bool  clip = true 
) [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

virtual int GetImageWidth (  )  [protected, pure virtual]

(*** add brief description here ***)

Implemented in MapView.

virtual int GetImageHeight (  )  [protected, pure virtual]

(*** add brief description here ***)

Implemented in MapView.

void UpdateVScroll ( float  dt  )  [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)

void UpdateHScroll ( float  dt  )  [protected]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)


Member Data Documentation

Surface* m_buffer [private]

(*** add brief description here ***)

Rect m_viewport [private]

(*** add brief description here ***)

float m_vx [private]

(*** add brief description here ***)

float m_vy [private]

(*** add brief description here ***)

float m_xmin [private]

(*** add brief description here ***)

float m_xmax [private]

(*** add brief description here ***)

float m_ymin [private]

(*** add brief description here ***)

float m_ymax [private]

(*** add brief description here ***)

float m_pixel_vel [private]

(*** add brief description here ***)

float m_pixel_acc [private]

(*** add brief description here ***)

int m_oldx [private]

(*** add brief description here ***)

int m_oldy [private]

(*** add brief description here ***)

int m_state [private]

(*** add brief description here ***)

float m_px [private]

(*** add brief description here ***)

float m_py [private]

(*** add brief description here ***)


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