ScrollView.h

Go to the documentation of this file.

//**********************************************************************
//
//  REGCOM: Regimental Command
//  Copyright (C) 2008 Randi J. Relander
//    <rjrelander@users.sourceforge.net>
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 3
//  of the License, or (at your option) any later version.
//  
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//  
//  You should have received a copy of the GNU General Public
//  License along with this program.  If not, see 
//  <http://www.gnu.org/licenses/>.
//  
//**********************************************************************

#ifndef REGCOM_GUI_SCROLLVIEW_H
#define REGCOM_GUI_SCROLLVIEW_H

// PROJECT INCLUDES
#include "regcom/gui/Window.h"
#include "regcom/gui/Rect.h"

// NAMESPACES
namespace regcom {
namespace gui {

// FORWARD REFERENCES
class Surface;
class Point;

//  CLASS: ScrollView
class ScrollView : public Window
{
public:

    // PUBLIC METHODS

    ScrollView();

    virtual ~ScrollView();

    virtual void FrameResized(int w, int h);

    void Scroll(int dx, int dy);

    void Warp(int x, int y);
    
    virtual void Draw(Rect rect);

    Rect GetViewport() { return m_viewport; }

    void Refresh();

    void SetVelocity(float vel) { m_pixel_vel = vel; }

    void SetAcceleration(float acc) { m_pixel_acc = acc; }

    virtual void OnTimer(float dt);

    Point GetCenter();

    void SetCenter(Point point);

    void SetCorner(Point point);

    void SetState(int state) { m_state |= state; }

    void ClearState(int state) { m_state &= ~state; }

    enum SCROLL_STATE
    {
        SCROLL_STATE_UP            = 0x0001,    
        SCROLL_STATE_DOWN        = 0x0002,    
        SCROLL_STATE_LEFT        = 0x0004,    
        SCROLL_STATE_RIGHT        = 0x0008    
    };

protected:

    // PROTECTED METHODS

    virtual void DrawImage(
        Rect rect, Surface* surface, int x, int y) = 0;

    virtual void ViewportChanged() = 0;
    
    void UpdateRect(Rect& rect, bool clip = true);

    virtual int GetImageWidth() = 0;

    virtual int GetImageHeight() = 0;

    void UpdateVScroll(float dt);

    void UpdateHScroll(float dt);

private:

    // MEMBER VARIABLES

    Surface* m_buffer;

    Rect m_viewport;

    float m_vx;

    float m_vy;

    float m_xmin;

    float m_xmax;

    float m_ymin;

    float m_ymax;

    float m_pixel_vel;    // pixels/sec

    float m_pixel_acc;    // pixels/sec/sec

    int m_oldx;

    int m_oldy;

    int m_state;

    float m_px;

    float m_py;
};

} // namespace gui
} // namespace regcom

#endif

Navigation

Home Page
Screen Shots
Developers
Documentation

Doxygen

Namespace List
Class List
Class Hierarchy
File List
Todo List

Links

SDL Library
License
SourceForge Project
Forums
Download

Regimental Command
Copyright © 2008
Randi J. Relander