renderable.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef GRAPHICS_RENDERABLE_H
#define GRAPHICS_RENDERABLE_H

#include <boost/noncopyable.hpp>

#include "glm/mat4x4.hpp"

#include "src/common/ustring.h"

#include "src/common/ustring.h"

#include "src/graphics/types.h"
#include "src/graphics/queueable.h"

namespace Graphics {

class Renderable : boost::noncopyable, public Queueable {
public:
    Renderable(RenderableType type);
    ~Renderable();

    bool operator<(const Queueable &q) const;

    virtual void calculateDistance() = 0;

    virtual void advanceTime(float dt);

    virtual void render(RenderPass pass) = 0;

    virtual void renderImmediate(const glm::mat4 &UNUSED(parentTransform)) {}

    virtual void queueRender(const glm::mat4 &UNUSED(parentTransform)) {}

    double getDistance() const;

    uint32 getID() const;

    bool isClickable() const;
    void setClickable(bool clickable);

    const Common::UString &getTag() const;
    void setTag(const Common::UString &tag);

    bool isVisible() const; 

    virtual void show(); 
    virtual void hide(); 

    virtual bool isIn(float x, float y) const;
    virtual bool isIn(float x, float y, float z) const;
    virtual bool isIn(float x1, float y1, float z1, float x2, float y2, float z2) const;

protected:
    QueueType _queueExists;
    QueueType _queueVisible;

    uint32 _id;

    bool _clickable;
    Common::UString _tag;

    double _distance; 

    void resort();

    void lockFrame();
    void unlockFrame();

    void lockFrameIfVisible();
    void unlockFrameIfVisible();
};

} // End of namespace Graphics

#endif // GRAPHICS_RENDERABLE_H