engine/component.h

Go to the documentation of this file.

/******************************************************************************
 * This file is part of the Gluon Development Platform
 * Copyright (c) 2010 Arjen Hiemstra <ahiemstra@heimr.nl>
 * Copyright (C) 2010 Dan Leinir Turthra Jensen <admin@leinir.dk>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef GLUON_ENGINE_COMPONENT_H
#define GLUON_ENGINE_COMPONENT_H

#include "gluon_engine_export.h"
#include "core/gluonobject.h"

#include <QtCore/QSharedData>
#include <QtPlugin>

namespace GluonEngine
{
    class GameObject;
    class ComponentPrivate;

    class GLUON_ENGINE_EXPORT Component : public GluonCore::GluonObject
    {
            Q_OBJECT
            Q_PROPERTY( QString description READ description WRITE setDescription )
            Q_PROPERTY( bool enabled READ enabled WRITE setEnabled )
            // gameObject is deliberately not a Q_PROPERTY - it is not supposed to be exposed in the editor other than through drag-and-drop

        public:
            Q_INVOKABLE Component( QObject* parent = 0 );
            Component( const Component& other, QObject* parent = 0 );
            ~Component();

            virtual QString category() const;

            virtual QVariant toVariant( GluonObject* wrapThis );

            virtual void initialize() {}
            virtual void start() {};
            virtual void update( int elapsedMilliseconds );
            virtual void draw( int timeLapse = 0 );

            virtual void stop() {};

            virtual void cleanup() {}

            QString description() const;
            void setDescription( const QString& newDescription );

            bool enabled() const;
            void setEnabled( bool newEnabled );

            GameObject* gameObject();
            void setGameObject( GameObject* newGameObject );

            void sanitize();

            virtual QString stringFromProperty( const QString& propertyName, const QString& indentChars ) const;

        private:
            ComponentPrivate* const d;
    };
}

Q_DECLARE_INTERFACE( GluonEngine::Component, "com.gluon.Component/1.0" )
Q_DECLARE_METATYPE( GluonEngine::Component )
Q_DECLARE_METATYPE( GluonEngine::Component* )

#endif  // GLUON_COMPONENT_H

---