area.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2004-2006 by Reality Rift Studios                       *
 *   http://www.realityrift.com  -  mattias@realityrift.com                *
 *                                                                         *
 *   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 2 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, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef neo_gui_area_h
#define neo_gui_area_h

#include "../core/platform.h"

#if NEO_ENABLE_GUI

#include "../render/texture.h"
#include "../render/primitive.h"
#include "../render/color.h"
#include "gui.h"
#include "object.h"
#include "font.h"

namespace neo {
namespace gui {

class Area : public Object, public render::ParameterBinderNode
{
    public:


                                                            Area( unsigned int id = 0, const std::string& name = "", Object* p_parent = 0 );

    virtual                                                ~Area();


    void                                                    setLayout( const Point& numTiles = Point(), const Point& sizeTile = Point(), Tiling tiling = TILE, Orientation orientation = TOPLEFT, bool scroll = false );


    void                                                    setTileCoordinates( const math::Vector3& origin = math::Vector3( 0, 0, 0 ), const math::Vector3& size = math::Vector3( 1.0f, 1.0f, 1.0f ) );

    inline const Point&                                     getNumTiles() const;
    
    inline const Point&                                     getSizeTile() const;
    
    inline Tiling                                           getTiling() const;
    
    inline Orientation                                      getOrientation() const;

    inline const math::Vector3&                             getTileUVWOrigin() const;

    inline const math::Vector3&                             getTileUVWSize() const;


    virtual void                                            setTechnique( const render::TechniquePtr& p_tech );


    inline const render::TechniquePtr&                      getTechnique() const;


    virtual void                                            setColor( const render::Color& color );


    inline const render::Color&                             getColor() const;


    inline bool                                             isScrolling() const;
    
    virtual void                                            render();
    virtual Area*                                           clone() const;

    virtual void                                            getParameters( core::Array< render::Parameter* >* p_params );

    protected:

    virtual void                                            doBind( const core::HashString& name, render::ParameterData* p_data, bool local );
    virtual void                                            doUnbind( const core::HashString& name, bool local );

    virtual void                                            onMove();
    virtual void                                            onResize();
    virtual void                                            onVirtualChange();
    virtual void                                            onDepthChange();
    
    virtual void                                            onLayout();

#if NEO_ENABLE_SCRIPTING
    virtual void                                            getEvents( core::Array< std::string >* p_events );
#endif
    
    virtual void                                            recalc();

    void                                                    invalidate();
    

    void                                                    copyTo( Area& obj, bool cloneChildren = true ) const;
    
    render::Primitive                                       _primitive;
    
    math::Matrix4                                           _transform;
    
    private:
        
    Tiling                                                  _tiling;
    
    Orientation                                             _orientation;
    
    Point                                                   _numTiles;

    Point                                                   _sizeTile;

    math::Vector3                                           _originUVW;

    math::Vector3                                           _sizeUVW;

    render::Color                                           _color;

    bool                                                    _scroll;
    
    render::ParameterCompiledBindings                       _bindingsCompiled;
};

#include "area.inl"

}
}

#endif

#endif

---