rigiddebris.h

Go to the documentation of this file.

// © Copyright 2010 - 2014 BlackTopp Studios Inc.
/* This file is part of The Mezzanine Engine.

    The Mezzanine Engine 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.

    The Mezzanine Engine 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 The Mezzanine Engine.  If not, see <http://www.gnu.org/licenses/>.
*/
/* The original authors have included a copy of the license specified above in the
   'Docs' folder. See 'gpl.txt'
*/
/* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
   Build professional software and charge for their product.

   However there are some practical restrictions, so if your project involves
   any of the following you should contact us and we will try to work something
   out:
    - DRM or Copy Protection of any kind(except Copyrights)
    - Software Patents You Do Not Wish to Freely License
    - Any Kind of Linking to Non-GPL licensed Works
    - Are Currently In Violation of Another Copyright Holder's GPL License
    - If You want to change our code and not add a few hundred MB of stuff to
        your distribution

   These and other limitations could cause serious legal problems if you ignore
   them, so it is best to simply contact us or the Free Software Foundation, if
   you have any questions.

   Joseph Toppi - toppij@gmail.com
   John Blackwood - makoenergy02@gmail.com
*/
#ifndef _rigiddebris_h
#define _rigiddebris_h

/// @file
/// @brief This file contains the declaration for the debris class that does not deform.

#include "debris.h"

namespace Mezzanine
{
    namespace Graphics
    {
        class EntityProxy;
    }
    namespace Physics
    {
        class RigidProxy;
    }
    ///////////////////////////////////////////////////////////////////////////////
    /// @brief A non-deformable debris.
    /// @details
    ///////////////////////////////////////
    class MEZZ_LIB RigidDebris : public Debris
    {
    protected:
        /// @internal
        /// @brief A pointer to the graphics representation of this debris.
        Graphics::EntityProxy* EntProx;
        /// @internal
        /// @brief A pointer to the physics representation of this debris.
        Physics::RigidProxy* RigProx;

        /// @internal
        /// @brief Common construction method for RigidDebris.
        /// @param Mass The mass of the debris object.
        virtual void CreateRigidDebris(const Real Mass);
        /// @internal
        /// @brief Destruction method for RigidDebris.
        virtual void DestroyRigidDebris();
    public:
        /// @brief Blank constructor.
        /// @param TheWorld A pointer to the world this object belongs to.
        RigidDebris(World* TheWorld);
        /// @brief Class constructor.
        /// @param Name The name to be given to this object.
        /// @param Mass The mass of the debris object.
        /// @param TheWorld A pointer to the world this object belongs to.
        RigidDebris(const String& Name, const Real Mass, World* TheWorld);
        /// @brief XML constructor.
        /// @param SelfRoot An XML::Node containing the data to populate this class with.
        /// @param TheWorld A pointer to the world this object belongs to.
        RigidDebris(const XML::Node& SelfRoot, World* TheWorld);
        /// @brief Class destructor.
        virtual ~RigidDebris();

        ///////////////////////////////////////////////////////////////////////////////
        // Utility and Configuration

        /// @copydoc Mezzanine::WorldObject::GetType() const
        virtual WorldObjectType GetType() const;

        /// @brief Gets a pointer to the graphics portion of this debris.
        /// @return Returns a pointer to the Entity proxy representing the graphics portion of this debris.
        virtual Graphics::EntityProxy* GetEntityProxy() const;
        /// @brief Gets a pointer to the physics portion of this debris.
        /// @return Returns a pointer to the Rigid proxy representing the physics portion of this debris.
        virtual Physics::RigidProxy* GetRigidProxy() const;

        /// @copydoc Mezzanine::WorldObject::IsInWorld() const
        virtual Boolean IsInWorld() const;

        /// @copydoc Mezzanine::WorldObject::IsStatic() const
        virtual Boolean IsStatic() const;
        /// @copydoc Mezzanine::WorldObject::IsKinematic() const
        virtual Boolean IsKinematic() const;

        /// @copydoc Mezzanine::WorldObject::GetProxies(ProxyContainer&)
        virtual void GetProxies(ProxyContainer& Proxies);
        /// @copydoc Mezzanine::WorldObject::GetProxies(const UInt32, ProxyContainer&)
        virtual void GetProxies(const UInt32 Types, ProxyContainer& Proxies);

        ///////////////////////////////////////////////////////////////////////////////
        // Working with the World

        /// @copydoc Mezzanine::WorldObject::AddToWorld()
        virtual void AddToWorld();
        /// @copydoc Mezzanine::WorldObject::RemoveFromWorld()
        virtual void RemoveFromWorld();

        ///////////////////////////////////////////////////////////////////////////////
        // Transform Methods

        /// @copydoc TransformableObject::SetLocation(const Vector3&)
        virtual void SetLocation(const Vector3& Loc);
        /// @copydoc TransformableObject::SetLocation(const Real, const Real, const Real)
        virtual void SetLocation(const Real X, const Real Y, const Real Z);
        /// @copydoc TransformableObject::GetLocation() const
        virtual Vector3 GetLocation() const;
        /// @copydoc TransformableObject::SetOrientation(const Quaternion&)
        virtual void SetOrientation(const Quaternion& Ori);
        /// @copydoc TransformableObject::SetOrientation(const Real, const Real, const Real, const Real)
        virtual void SetOrientation(const Real X, const Real Y, const Real Z, const Real W);
        /// @copydoc TransformableObject::GetOrientation() const
        virtual Quaternion GetOrientation() const;
        /// @copydoc TransformableObject::SetScale(const Vector3&)
        virtual void SetScale(const Vector3& Sc);
        /// @copydoc TransformableObject::SetScale(const Real, const Real, const Real)
        virtual void SetScale(const Real X, const Real Y, const Real Z);
        /// @copydoc TransformableObject::GetScale() const
        virtual Vector3 GetScale() const;

        /// @copydoc TransformableObject::Translate(const Vector3&)
        virtual void Translate(const Vector3& Trans);
        /// @copydoc TransformableObject::Translate(const Real, const Real, const Real)
        virtual void Translate(const Real X, const Real Y, const Real Z);
        /// @copydoc TransformableObject::Yaw(const Real)
        virtual void Yaw(const Real Angle);
        /// @copydoc TransformableObject::Pitch(const Real)
        virtual void Pitch(const Real Angle);
        /// @copydoc TransformableObject::Roll(const Real)
        virtual void Roll(const Real Angle);
        /// @copydoc TransformableObject::Rotate(const Vector3&, const Real)
        virtual void Rotate(const Vector3& Axis, const Real Angle);
        /// @copydoc TransformableObject::Rotate(const Quaternion&)
        virtual void Rotate(const Quaternion& Rotation);
        /// @copydoc TransformableObject::Scale(const Vector3&)
        virtual void Scale(const Vector3& Scale);
        /// @copydoc TransformableObject::Scale(const Real, const Real, const Real)
        virtual void Scale(const Real X, const Real Y, const Real Z);

        ///////////////////////////////////////////////////////////////////////////////
        // Serialization

        /// @copydoc Mezzanine::WorldObject::ProtoSerializeProperties(XML::Node&) const
        virtual void ProtoSerializeProperties(XML::Node& SelfRoot) const;
        /// @copydoc Mezzanine::WorldObject::ProtoSerializeProxies(XML::Node&) const
        virtual void ProtoSerializeProxies(XML::Node& SelfRoot) const;

        /// @copydoc Mezzanine::WorldObject::ProtoDeSerializeProperties(const XML::Node&)
        virtual void ProtoDeSerializeProperties(const XML::Node& SelfRoot);
        /// @copydoc Mezzanine::WorldObject::ProtoDeSerializeProxies(const XML::Node&)
        virtual void ProtoDeSerializeProxies(const XML::Node& SelfRoot);

        /// @copydoc Mezzanine::WorldObject::GetDerivedSerializableName() const
        virtual String GetDerivedSerializableName() const;
        /// @copydoc Mezzanine::WorldObject::GetSerializableName()
        static String GetSerializableName();

        ///////////////////////////////////////////////////////////////////////////////
        // Internal Methods

        /// @copydoc Mezzanine::WorldObject::_Update()
        virtual void _Update();
        /// @copydoc Mezzanine::WorldObject::_NotifyProxyDestroyed(WorldProxy*)
        virtual void _NotifyProxyDestroyed(WorldProxy* ToBeDestroyed);
    };//RigidDebris

    ///////////////////////////////////////////////////////////////////////////////
    /// @brief A base factory type for the creation of non-deformable Debris objects.
    /// @details
    ///////////////////////////////////////
    class MEZZ_LIB RigidDebrisFactory : public DebrisFactory
    {
    public:
        /// @brief Class constructor.
        RigidDebrisFactory();
        /// @brief Class destructor.
        virtual ~RigidDebrisFactory();

        /// @copydoc DebrisFactory::GetTypeName() const
        virtual String GetTypeName() const;

        /// @brief Creates a RigidDebris object.
        /// @param Name The name to be given to this object.
        /// @param Mass The mass of the debris object.
        /// @param TheWorld A pointer to the world this object belongs to.
        virtual RigidDebris* CreateRigidDebris(const String& Name, const Real Mass, World* TheWorld);
        /// @brief Creates a RigidDebris object.
        /// @param XMLNode The node of the xml document to construct from.
        /// @param TheWorld A pointer to the world this object belongs to.
        virtual RigidDebris* CreateRigidDebris(const XML::Node& XMLNode, World* TheWorld);

        /// @copydoc DebrisFactory::CreateDebris(const String&, World*, const NameValuePairMap&)
        virtual Debris* CreateDebris(const String& Name, World* TheWorld, const NameValuePairMap& Params);
        /// @copydoc DebrisFactory::CreateDebris(const XML::Node&, World*)
        virtual Debris* CreateDebris(const XML::Node& XMLNode, World* TheWorld);
        /// @copydoc DebrisFactory::DestroyDebris(Debris* ToBeDestroyed)
        virtual void DestroyDebris(Debris* ToBeDestroyed);
    };//RigidDebrisFactory
}//Mezzanine

#endif