object.h

Go to the documentation of this file.

/*
        Scalable Building Simulator - Generic Object Class
        The Skyscraper Project - Version 2.0
        Copyright (C)2004-2024 Ryan Thoryk
        https://www.skyscrapersim.net
        https://sourceforge.net/projects/skyscraper/
        Contact - ryan@skyscrapersim.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 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 _SBS_OBJECT_H
#define _SBS_OBJECT_H
 
namespace SBS {
 
class Object;
 
//ObjectBase is used for lightweight objects, and core of Object
class SBSIMPEXP ObjectBase
{
        friend class Object;
 
public:
        ObjectBase(Object *parent);
        virtual ~ObjectBase() {};
        Object* GetParent();
        SBS* GetRoot();
        void SetName(const std::string &name);
        const std::string& GetName();
        std::string GetNameBase();
        virtual void Report(const std::string &message);
        virtual bool ReportError(const std::string &message);
 
protected:
        SBS *sbs; //engine root
 
private:
        Object *Parent; //parent object
        std::string Name; //object name
};
 
class SBSIMPEXP Object : public ObjectBase
{
public:
 
        std::string command; //command line used to create object, if applicable
        std::string command_processed; //processed command used to create object
        std::string context; //script context object was created in
        int linenum; //script line number where object was created
        std::string includefile; //include file name
        bool parent_deleting; //true if object's parent is deleting object
 
        //functions
        Object(Object *parent);
        virtual ~Object();
        void SetValues(const std::string &type, const std::string &name, bool is_permanent, bool is_movable = true);
        bool IsPermanent();
        bool IsMovable();
        const std::string& GetType();
        int GetNumber();
        void AddChild(Object *object);
        Object* GetChild(int index);
        int GetChildrenCount();
        void RemoveChild(Object *object);
        SceneNode* GetSceneNode();
        void ShowBoundingBox(bool value);
        virtual void Move(const Vector3 &vector, Real speed = 1.0, bool force = false);
        virtual void Move(Real X, Real Y, Real Z, Real speed = 1.0, bool force = false);
        virtual void SetPosition(const Vector3 &position, bool relative = false, bool force = false);
        virtual void SetPosition(Real X, Real Y, Real Z, bool relative = false, bool force = false);
        virtual void SetPositionY(Real value, bool force = false);
        virtual Vector3 GetPosition(bool relative = false);
        virtual void Rotate(const Vector3 &vector, Real speed = 1.0);
        virtual void Rotate(Real X, Real Y, Real Z, Real speed = 1.0);
        virtual void SetRotation(const Vector3 &rotation);
        virtual void SetRotation(Real X, Real Y, Real Z);
        virtual Vector3 GetRotation();
        Quaternion GetOrientation(bool relative = false);
        void SetOrientation(const Quaternion &q, bool relative = false);
        virtual void OnMove(bool parent) {} //called when object is moved
        virtual void OnRotate(bool parent) {} //called when object is rotated
        virtual void OnClick(Vector3 &position, bool shift, bool ctrl, bool alt, bool right) {} //called when object is clicked on
        virtual void OnUnclick(bool right) {} //called when mouse is held and released on object
        virtual void OnHit() {} //called when user hits/collides with object
        void NotifyMove(bool parent = false);
        void NotifyRotate(bool parent = false);
        virtual void ResetState() {} //resets the internal state of an object
        void ChangeParent(Object *new_parent);
        bool IsGlobal();
        void Init(bool children = true); //pre-runloop (first-run) object initialization
        virtual void OnInit() {} //called when object is initialized
        virtual void Loop() {} //object runloop
        void RegisterLoop(Object *object);
        void UnregisterLoop(Object *object);
        virtual void Enabled(bool value) {}
        virtual bool IsEnabled() { return true; }
        std::string GetNameBase();
 
        template <typename T> bool IsType()
        {
                //check if an object is of the given type
                return (dynamic_cast<T*>(this) > 0);
        }
 
        template <typename T> T* ConvertTo()
        {
                //convert object to the given type, if possible.  Returns 0 on failure
                return dynamic_cast<T*>(this);
        }
 
protected:
        void EnableLoop(bool value);
        void LoopChildren();
        bool SelfDestruct();
 
private:
        void NotifyChildren(bool move, bool rotate);
        void InitChildren();
 
        bool Permanent; //is object permanent?
        std::string Type; //object type
        int Number; //object identifier
        std::vector<Object*> children; //object's children
        SceneNode *node; //node in scene graph
        bool values_set;
        bool initialized;
        std::vector<Object*> runloops; //child object active runloops
        bool loop_enabled;
};
 
}
 
#endif