More public API cleanup and new features

A few doxygen doc modifications. Adjusted platformer demo logic a little more. Most if not all object type id's are now constructed on first call. Tilemap scene layer can now store properties.
gamaral · Mar 25, 2012 · 450fdfd · 450fdfd
1 parent c0d6eb3
commit 450fdfd
Show file tree

Hide file tree

Showing 67 changed files with 693 additions and 633 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -581,7 +581,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = src/
+INPUT                  = include/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

diff --git a/demos/platformer/assets/platformer.tmx b/demos/platformer/assets/platformer.tmx
@@ -13,7 +13,7 @@
  </layer>
  <layer name="clouds" width="80" height="20" opacity="0.75">
   <properties>
-   <property name="scale" value="2"/>
+   <property name="scale" value="2" />
   </properties>
   <data encoding="base64" compression="zlib">
    eJztV0kSwzAI43tt+oEu+f83wiUXz5CIWNjQVjPcXLFIuM4iIg/5DTw1XhpvjY/G2sF107gTuHaeRWJ1GJUHxa5FC2+dXk2vzoHpHQ+i5+GFxc/yF8qDnpulmxesOlGe7HPJdl9VQ6S+M7TJ7gdPfb3aWLmOasi+7xH1WfOwckXpUhWjPYPmY8yZ/c6ohLM5Iz1XfWe0vUXUE93zTE+2vVXEKE9+492BwNM3482C5GOdYf7OgsefDC8jHKwzV/P/URveHYm4O3s5M/3vnu1IxE71cmb8vtoAMlBm9A==

diff --git a/demos/platformer/inputcomponent.cpp b/demos/platformer/inputcomponent.cpp
@@ -147,14 +147,16 @@ InputComponent::update(float d)
 		}
 		else m_movement->acceleration()[0] = 0;
 
-		/* only jump if on platform */
-		if (m_jump && m_boost_fuel > 0) {
-			m_boost_fuel -= d;
-			m_movement->velocity()[1] += JUMP_MAX * (d / BOOST_MAX);
-		}
-		else if (m_jump && m_collider->onPlatform()) {
-			m_movement->velocity()[1] = JUMP_MAX;
-			m_boost_fuel = BOOST_MAX;
+		/* jumping */
+		if (m_jump) {
+			if (m_boost_fuel > 0) {
+				m_boost_fuel -= d;
+				m_movement->velocity()[1] += JUMP_MAX * (d / BOOST_MAX);
+			}
+			else if (m_collider->onPlatform() && m_movement->velocity()[1] < 1) {
+				m_movement->velocity()[1] = JUMP_MAX;
+				m_boost_fuel = BOOST_MAX;
+			}
 		}
 	}
 }
@@ -179,7 +181,7 @@ InputComponent::handleEvent(const Event::IEvent &e)
 		else m_direction_stack.remove(ICDRight);
 	}
 	else if (l_kevent.key() == Event::KEY_SPACE) {
-		m_jump = (l_kevent.action() == Event::KeyPressed && m_collider->onPlatform() ? true : false);
+		m_jump = (l_kevent.action() == Event::KeyPressed ? true : false);
 	}
 	else if (l_kevent.key() == Event::KEY_SHIFT_L) {
 		m_max_speed += l_kevent.action() == Event::KeyPressed ? 200 : -200;

diff --git a/demos/platformer/playerentity.cpp b/demos/platformer/playerentity.cpp
@@ -81,16 +81,16 @@ PlayerEntity::update(float d)
 		m_animation_component->pushFrame("stand-left",  107, 4);
 		m_animation_component->pushFrame("walk-left", 108, 1);
 		m_animation_component->pushFrame("walk-left", 109, 1);
-		m_animation_component->rate("walk-left", 16);
+		m_animation_component->setFrameRate("walk-left", 16);
 		m_animation_component->pushFrame("jump-left", 108, 1);
-		m_animation_component->rate("jump-left", 1);
+		m_animation_component->setFrameRate("jump-left", 1);
 		m_animation_component->pushFrame("stand-right", 102, 12);
 		m_animation_component->pushFrame("stand-right", 103, 4);
 		m_animation_component->pushFrame("walk-right", 104, 1);
 		m_animation_component->pushFrame("walk-right", 105, 1);
-		m_animation_component->rate("walk-right", 16);
+		m_animation_component->setFrameRate("walk-right", 16);
 		m_animation_component->pushFrame("jump-right", 105, 1);
-		m_animation_component->rate("jump-right", 1);
+		m_animation_component->setFrameRate("jump-right", 1);
 		pushComponent(m_animation_component.staticCast<Game::IComponent>());
 
 		/* movement component */

diff --git a/demos/tilemap/playerentity.cpp b/demos/tilemap/playerentity.cpp
@@ -75,22 +75,22 @@ PlayerEntity::update(float d)
 		m_animation_component->pushFrame("stand-down", 73, 4);
 		m_animation_component->pushFrame("walk-down", 74, 4);
 		m_animation_component->pushFrame("walk-down", 75, 4);
-		m_animation_component->rate("walk-down", 16);
+		m_animation_component->setFrameRate("walk-down", 16);
 		m_animation_component->pushFrame("stand-left",  76, 12);
 		m_animation_component->pushFrame("stand-left",  77, 4);
 		m_animation_component->pushFrame("walk-left", 78, 4);
 		m_animation_component->pushFrame("walk-left", 79, 4);
-		m_animation_component->rate("walk-left", 16);
+		m_animation_component->setFrameRate("walk-left", 16);
 		m_animation_component->pushFrame("stand-right", 72, 12);
 		m_animation_component->pushFrame("stand-right", 73, 4);
 		m_animation_component->pushFrame("walk-right", 74, 4);
 		m_animation_component->pushFrame("walk-right", 75, 4);
-		m_animation_component->rate("walk-right", 16);
+		m_animation_component->setFrameRate("walk-right", 16);
 		m_animation_component->pushFrame("stand-up",  76, 12);
 		m_animation_component->pushFrame("stand-up",  77, 4);
 		m_animation_component->pushFrame("walk-up", 80, 4);
 		m_animation_component->pushFrame("walk-up", 81, 4);
-		m_animation_component->rate("walk-up", 16);
+		m_animation_component->setFrameRate("walk-up", 16);
 		pushComponent(m_animation_component.staticCast<Game::IComponent>());
 
 		/* input component */

diff --git a/include/core/base64.h b/include/core/base64.h
@@ -44,9 +44,10 @@ MARSHMALLOW_NAMESPACE_BEGIN
 
 namespace Core
 {
+	/*! @brief Core Base64 Interface */
 	namespace Base64
 	{
-		/*! @brief Base64 decoder
+		/*! @brief Core Base64 decoder
 		 *  @param in In buffer
 		 *  @param in_size In buffer size
 		 *  @param out Out buffer pointer

diff --git a/include/core/bufferio.h b/include/core/bufferio.h
@@ -48,7 +48,7 @@ namespace Core
 	template <class T> class Shared;
 	template <class T> class Weak;
 
-	/*! @brief Buffer IO Interface */
+	/*! @brief Core Buffer IO Interface */
 	class MARSHMALLOW_CORE_EXPORT
 	BufferIO : public IDataIO
 	{

diff --git a/include/core/fileio.h b/include/core/fileio.h
@@ -50,7 +50,7 @@ namespace Core
 	template <class T> class Shared;
 	template <class T> class Weak;
 
-	/*! @brief File IO Interface */
+	/*! @brief Core File IO Interface */
 	class MARSHMALLOW_CORE_EXPORT
 	FileIO : public IDataIO
 	{

diff --git a/include/core/global.h b/include/core/global.h
@@ -37,11 +37,11 @@
 #ifndef MARSHMALLOW_CORE_GLOBAL_H
 #define MARSHMALLOW_CORE_GLOBAL_H 1
 
-#define MARSHMALLOW_VERSION          0x00010002
+#define MARSHMALLOW_VERSION          0x00010003
 #define MARSHMALLOW_VERSION_MAJOR    0x00
 #define MARSHMALLOW_VERSION_MINOR    0x01
 #define MARSHMALLOW_VERSION_BUILD    0x00
-#define MARSHMALLOW_VERSION_REVISION 0x02
+#define MARSHMALLOW_VERSION_REVISION 0x03
 
 #define VIRTUAL
 #define NO_ASSIGN_COPY(x) NO_ASSIGN(x); NO_COPY(x)

diff --git a/include/core/hash.h b/include/core/hash.h
@@ -44,7 +44,7 @@ MARSHMALLOW_NAMESPACE_BEGIN
 
 namespace Core
 {
-	/*! @brief Hash Class */
+	/*! @brief Core Hash Class */
 	class MARSHMALLOW_CORE_EXPORT
 	Hash
 	{

diff --git a/include/core/iasset.h b/include/core/iasset.h
@@ -51,7 +51,7 @@ namespace Core
 	template <class T> class Shared;
 	template <class T> class Weak;
 
-	/*! @brief Assets Asset Interface */
+	/*! @brief Core Assets Asset Interface */
 	struct IAsset
 	{
 		virtual ~IAsset(void) {};

diff --git a/include/core/idataio.h b/include/core/idataio.h
@@ -61,7 +61,7 @@ namespace Core
 		DIOEnd
 	};
 
-	/*! @brief Data IO Interface */
+	/*! @brief Core Data IO Interface */
 	struct IDataIO
 	{
 		virtual ~IDataIO(void) {};

diff --git a/include/core/irenderable.h b/include/core/irenderable.h
@@ -47,7 +47,7 @@ namespace Core
 	template <class T> class Shared;
 	template <class T> class Weak;
 
-	/*! @brief Renderable Interface */
+	/*! @brief Core Renderable Interface */
 	struct IRenderable
 	{
 		virtual ~IRenderable(void) {};

diff --git a/include/core/iserializable.h b/include/core/iserializable.h
@@ -51,7 +51,7 @@ namespace Core
 	template <class T> class Shared;
 	template <class T> class Weak;
 
-	/*! @brief Serializable Interface */
+	/*! @brief Core Serializable Interface */
 	struct ISerializable
 	{
 		virtual ~ISerializable(void) {};

diff --git a/include/core/iupdateable.h b/include/core/iupdateable.h
@@ -47,7 +47,7 @@ namespace Core
 	template <class T> class Shared;
 	template <class T> class Weak;
 
-	/*! @brief Updateable Interface */
+	/*! @brief Core Updateable Interface */
 	struct IUpdateable
 	{
 		virtual ~IUpdateable(void) {};

diff --git a/include/core/platform.h b/include/core/platform.h
@@ -50,7 +50,7 @@ struct TimeData;
 
 namespace Core
 {
-	/*! @brief Platform specific class */
+	/*! @brief Core Platform Interface */
 	namespace Platform
 	{
 		/*!

diff --git a/include/core/shared.h b/include/core/shared.h
@@ -49,15 +49,16 @@ namespace Core
 {
 	template <class T> class Weak;
 
-	/*! @brief Shared Data Struct */
+	//! @cond
 	struct MARSHMALLOW_CORE_EXPORT
 	SharedData {
 	    void *ptr;
 	    int16_t refs;
 	    int16_t wrefs;
 	};
+	//! @endcond
 
-	/*! @brief Shared Class */
+	/*! @brief Shared Pointer Class */
 	template <class T>
 	class Shared
 	{

diff --git a/include/core/strhash.h b/include/core/strhash.h
@@ -45,7 +45,7 @@ MARSHMALLOW_NAMESPACE_BEGIN
 
 namespace Core
 {
-	/*! @brief Event StrHash Class */
+	/*! @brief Core StrHash Class */
 	class MARSHMALLOW_CORE_EXPORT
 	StrHash : public Hash
 	{

diff --git a/include/core/weak.h b/include/core/weak.h
@@ -51,7 +51,7 @@ namespace Core
 
 	struct SharedData;
 
-	/*! @brief Weak Class */
+	/*! @brief Weak Pointer Class */
 	template <class T>
 	class Weak
 	{

diff --git a/include/core/zlib.h b/include/core/zlib.h
@@ -44,6 +44,7 @@ MARSHMALLOW_NAMESPACE_BEGIN
 
 namespace Core
 {
+	/*! @brief Core Zlib Interface */
 	namespace Zlib
 	{
 		/*! @brief Zlib inflate

diff --git a/include/event/debugeventlistener.h b/include/event/debugeventlistener.h
@@ -46,7 +46,7 @@ MARSHMALLOW_NAMESPACE_BEGIN
 
 namespace Event
 {
-	/*! @brief Debug Event Listener */
+	/*! @brief Event Debug Listener */
 	class MARSHMALLOW_EVENT_EXPORT
 	DebugEventListener : public IEventListener
 	{

diff --git a/include/event/eventbase.h b/include/event/eventbase.h
@@ -45,6 +45,7 @@ MARSHMALLOW_NAMESPACE_BEGIN
 
 namespace Event
 {
+	/*! @brief Event Priority */
 	enum EventPriority
 	{
 		LowestPriority  = 0,

diff --git a/include/event/keyboardevent.h b/include/event/keyboardevent.h
@@ -43,12 +43,14 @@ MARSHMALLOW_NAMESPACE_BEGIN
 
 namespace Event
 {
+	/*! @brief Keyboard Key Actions */
 	enum KBActions
 	{
 		KeyReleased     = 0,
 		KeyPressed      = 1
 	};
 
+	/*! @brief Keyboard Keys */
 	enum KBKeys
 	{
 		KEY_NONE          = 0,
@@ -181,7 +183,7 @@ namespace Event
 		KEY_LAST
 	};
 
-	/*! @brief Keyboard Event Class */
+	/*! @brief Event Keyboard Class */
 	class MARSHMALLOW_EVENT_EXPORT
 	KeyboardEvent : public EventBase
 	{
@@ -206,10 +208,6 @@ namespace Event
 	public: /* static */
 
 		static const Core::Type & Type(void);
-
-	private: /* static */
-
-		static const Core::Type sType;
 	};
 }
 

diff --git a/include/event/proxyeventlistener.h b/include/event/proxyeventlistener.h
@@ -43,7 +43,7 @@ MARSHMALLOW_NAMESPACE_BEGIN
 
 namespace Event
 {
-	/*! @brief Proxy Event Listener Class */
+	/*! @brief Event Proxy Listener Class */
 	class MARSHMALLOW_EVENT_EXPORT
 	ProxyEventListener : public IEventListener
 	{

diff --git a/include/event/quitevent.h b/include/event/quitevent.h
@@ -43,7 +43,7 @@ MARSHMALLOW_NAMESPACE_BEGIN
 
 namespace Event
 {
-	/*! @brief Quit Event Class */
+	/*! @brief Event Quit Class */
 	class MARSHMALLOW_EVENT_EXPORT
 	QuitEvent : public EventBase
 	{
@@ -66,10 +66,6 @@ namespace Event
 	public: /* static */
 
 		static const Core::Type & Type(void);
-
-	private: /* static */
-
-		static const Core::Type sType;
 	};
 }
 

diff --git a/include/event/renderevent.h b/include/event/renderevent.h
@@ -43,7 +43,7 @@ MARSHMALLOW_NAMESPACE_BEGIN
 
 namespace Event
 {
-	/*! @brief Render Event Class */
+	/*! @brief Event Render Class */
 	class MARSHMALLOW_EVENT_EXPORT
 	RenderEvent : public EventBase
 	{
@@ -61,10 +61,6 @@ namespace Event
 	public: /* static */
 
 		static const Core::Type & Type(void);
-
-	private: /* static */
-
-		static const Core::Type sType;
 	};
 }
 

diff --git a/include/event/updateevent.h b/include/event/updateevent.h
@@ -43,7 +43,7 @@ MARSHMALLOW_NAMESPACE_BEGIN
 
 namespace Event
 {
-	/*! @brief Update Event Class */
+	/*! @brief Event Update Class */
 	class MARSHMALLOW_EVENT_EXPORT
 	UpdateEvent : public EventBase
 	{
@@ -66,10 +66,6 @@ namespace Event
 	public: /* static */
 
 		static const Core::Type & Type(void);
-
-	private: /* static */
-
-		static const Core::Type sType;
 	};
 }
 

diff --git a/include/extra/tmxloader.h b/include/extra/tmxloader.h
@@ -73,17 +73,10 @@ namespace Extra
 		TMXLoader(Game::IScene &scene);
 		virtual ~TMXLoader(void);
 
-		bool load(const char *file);
 		bool isLoaded(void) const;
+		bool load(const char *file);
 
 		const Game::SharedSceneLayerList & layers(void) const;
-
-	private:
-
-		bool processLayer(XMLElement &element);
-		bool processMap(XMLElement &element);
-		bool processObjectGroup(XMLElement &element);
-		bool processTileset(XMLElement &element);
 	};
 	typedef Core::Shared<TMXLoader> SharedTMXLoader;
 	typedef Core::Weak<TMXLoader> WeakTMXLoader;