A simple world object without a large structure ideal for representing loose small objects. More...

#include <debris.h>

Inheritance diagram for Mezzanine::Debris:

Collaboration diagram for Mezzanine::Debris:

Public Member Functions
	Debris (World *TheWorld)
	Blank constructor. More...

	Debris (const String &Name, World *TheWorld)
	Class constructor. More...

virtual	~Debris ()
	Class destructor.

virtual String	GetDerivedSerializableName () const
	Gets the most derived serializable name of this WorldObject. More...

virtual void	ProtoDeSerializeProperties (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the properties of this object with it. More...

virtual void	ProtoSerializeProperties (XML::Node &SelfRoot) const
	Convert the properties of this class to an XML::Node ready for serialization. More...

Public Member Functions inherited from Mezzanine::WorldObject
	WorldObject (World *TheWorld)
	Blank constructor. More...

	WorldObject (const String &Name, World *TheWorld)
	Class constructor. More...

virtual	~WorldObject ()
	Class destructor.

virtual void	_NotifyCollisionState (Physics::Collision *Col, const Physics::CollisionState State)
	Notifies this World Object of a collision that is occuring with it. More...

virtual void	_NotifyProxyDestroyed (WorldProxy *ToBeDestroyed)=0
	Notifies that a proxy belonging to this WorldObject is being forcibly destroyed, and it needs to update. More...

virtual void	_Update ()=0
	Utility function for altering or checking the World Object every frame. More...

virtual void	AddToWorld ()=0
	Adds the object to the World.

virtual const String &	GetName () const
	Gets the name of this object. More...

virtual void	GetProxies (ProxyContainer &Proxies)=0
	Populates a container with all of the WorldProxies being used by this WorldObject. More...

virtual void	GetProxies (const UInt32 Types, ProxyContainer &Proxies)=0
	Populates a container with all the WorldProxies being used by this WorldObject specified in a provided mask. More...

virtual Mezzanine::WorldObjectType	GetType () const =0
	Gets the type of the object instance. More...

virtual World *	GetWorld () const
	Gets the world this object currently belongs to. More...

virtual Boole	IsInWorld () const =0
	Gets whether or not this object is currently in the world. More...

virtual Boole	IsKinematic () const =0
	Checks of the object is kinematic. More...

virtual Boole	IsStatic () const =0
	Checks of the object is static. More...

virtual void	ProtoDeSerialize (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite this object with it. More...

virtual void	ProtoDeSerializeProxies (const XML::Node &SelfRoot)=0
	Take the data stored in an XML Node and overwrite the proxies of this object with it. More...

virtual void	ProtoSerialize (XML::Node &ParentNode) const
	Convert this class to an XML::Node ready for serialization. More...

virtual void	ProtoSerializeProxies (XML::Node &SelfRoot) const =0
	Convert the proxies of this class to an XML::Node ready for serialization. More...

virtual void	RemoveFromWorld ()=0
	Removes the object from the World.

Public Member Functions inherited from Mezzanine::TransformableObject
virtual	~TransformableObject ()
	Class Destructor.

virtual Vector3	ConvertGlobalToLocal (const Vector3 &Location) const
	Converts a point in global space to the same point in local space. More...

virtual Quaternion	ConvertGlobalToLocal (const Quaternion &Orientation) const
	Converts a rotation in global space to the same rotation in local space. More...

virtual Vector3	ConvertLocalToGlobal (const Vector3 &Location) const
	Converts a point in local space to the same point in global space. More...

virtual Quaternion	ConvertLocalToGlobal (const Quaternion &Orientation) const
	Converts a rotation in local space to the same rotation in global space. More...

virtual Vector3	GetLocation () const =0
	Gets this objects current location. More...

virtual Quaternion	GetOrientation () const =0
	Gets this objects current orientation. More...

virtual Vector3	GetScale () const =0
	Gets the scaling currently being applied to this object. More...

virtual void	Pitch (const Real Angle)=0
	Rotate the object around the X axis. More...

virtual void	Roll (const Real Angle)=0
	Rotate the object around the Z axis. More...

virtual void	Rotate (const Vector3 &Axis, const Real Angle)=0
	Rotates the object from it's existing rotation. More...

virtual void	Rotate (const Quaternion &Rotation)=0
	Rotates the object from it's existing rotation. More...

virtual void	Scale (const Vector3 &Scale)=0
	Scales the object from it's current size. More...

virtual void	Scale (const Real X, const Real Y, const Real Z)=0
	Scales the object from it's current size. More...

virtual void	SetLocation (const Vector3 &Loc)=0
	Sets the location of this object in parent space. More...

virtual void	SetLocation (const Real X, const Real Y, const Real Z)=0
	Sets the location of this object in parent space via Reals. More...

virtual void	SetOrientation (const Quaternion &Ori)=0
	Sets the orientation of this object in parent space. More...

virtual void	SetOrientation (const Real X, const Real Y, const Real Z, const Real W)=0
	Sets the orientation of this object in parent space via Reals. More...

virtual void	SetScale (const Vector3 &Sc)=0
	Sets the scaling to be applied to this object. More...

virtual void	SetScale (const Real X, const Real Y, const Real Z)=0
	Sets the scaling to be applied to this object via Reals. More...

virtual void	Translate (const Vector3 &Trans)=0
	Moves this object from it's current location. More...

virtual void	Translate (const Real X, const Real Y, const Real Z)=0
	Moves this object from it's current location. More...

virtual void	Yaw (const Real Angle)=0
	Rotate the object around the Y axis. More...

Static Public Member Functions
static String	GetSerializableName ()
	Get the name of the the XML tag the proxy class will leave behind as its instances are serialized. More...

Static Public Member Functions inherited from Mezzanine::WorldObject
static String	GetSerializableName ()
	Get the name of the the XML tag the proxy class will leave behind as its instances are serialized. More...

Additional Inherited Members
Public Types inherited from Mezzanine::WorldObject
typedef std::set< Physics::Collision * >	CollisionContainer
	Basic container type for the current collisions applied to this object.

typedef CollisionContainer::iterator	CollisionIterator
	Iterator type for the current collisions applied to this object.

typedef CollisionContainer::const_iterator	ConstCollisionIterator
	Const Iterator type for the current collisions applied to this object.

typedef ProxyContainer::const_iterator	ConstProxyIterator
	Const Iterator type for WorldProxy instances stored by this class.

typedef std::vector< WorldProxy * >	ProxyContainer
	Basic container type for WorldProxy storage by this class.

typedef ProxyContainer::iterator	ProxyIterator
	Iterator type for WorldProxy instances stored by this class.

Protected Attributes inherited from Mezzanine::WorldObject
CollisionContainer	CurrentCollisions
	This member stores all existing collision events referencing this object. More...

String	ObjectName
	The name of the object. More...

World *	ParentWorld
	This is the world this object belongs to and will be inserted in/removed from. More...

Detailed Description

A simple world object without a large structure ideal for representing loose small objects.

Definition at line 54 of file debris.h.

Constructor & Destructor Documentation

Mezzanine::Debris::Debris ( World * TheWorld )

Blank constructor.

Parameters

TheWorld A pointer to the world this object belongs to.

Definition at line 50 of file debris.cpp.

Mezzanine::Debris::Debris	(	const String &	Name,
		World *	TheWorld
	)

Class constructor.

Parameters

Name	The name to be given to this object.
TheWorld	A pointer to the world this object belongs to.

Definition at line 54 of file debris.cpp.

Member Function Documentation

String Mezzanine::Debris::GetDerivedSerializableName ( ) const

virtual

Gets the most derived serializable name of this WorldObject.

Note: When creating a new WorldObject class verify this method has a valid return for it in order for serialization to work properly.

Returns: Returns the name of the XML tag from the most derived class of "this".

Reimplemented from Mezzanine::WorldObject.

Reimplemented in Mezzanine::RigidDebris, and Mezzanine::SoftDebris.

Definition at line 80 of file debris.cpp.

String Mezzanine::Debris::GetSerializableName ( )

static

Get the name of the the XML tag the proxy class will leave behind as its instances are serialized.

Returns: A string containing the name of this class.

Definition at line 83 of file debris.cpp.

void Mezzanine::Debris::ProtoDeSerializeProperties ( const XML::Node & SelfRoot )

virtual

Take the data stored in an XML Node and overwrite the properties of this object with it.

Parameters

SelfRoot An XML::Node containing the data to populate this class with.

Reimplemented from Mezzanine::WorldObject.

Reimplemented in Mezzanine::RigidDebris, and Mezzanine::SoftDebris.

Definition at line 75 of file debris.cpp.

void Mezzanine::Debris::ProtoSerializeProperties ( XML::Node & SelfRoot ) const

virtual

Convert the properties of this class to an XML::Node ready for serialization.

Parameters

SelfRoot The root node containing all the serialized data for this instance.

Reimplemented from Mezzanine::WorldObject.

Reimplemented in Mezzanine::RigidDebris, and Mezzanine::SoftDebris.

Definition at line 70 of file debris.cpp.

The documentation for this class was generated from the following files:

/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/debris.h
/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/debris.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation