소스 검색

comment some code

mikymod 12 년 전
부모
커밋
3eb495b786
5개의 변경된 파일15개의 추가작업 그리고 12개의 파일을 삭제
  1. 1 0
      engine/Device.h
  2. 4 4
      engine/os/OsEventBuffer.h
  3. 9 5
      engine/os/OsEvents.h
  4. 0 1
      engine/os/android/AndroidOS.cpp
  5. 1 2
      engine/os/android/java/CrownTouch.java

+ 1 - 0
engine/Device.h

@@ -133,6 +133,7 @@ public:
 
 	ConsoleServer*			console_server();
 
+	// FixMe: Should be implemented throush OsEventBuffer and a renderer event
 	inline void				init_renderer() { m_renderer_init_request = true; }
 
 private:

+ 4 - 4
engine/os/OsEventBuffer.h

@@ -38,11 +38,11 @@ OTHER DEALINGS IN THE SOFTWARE.
 namespace crown
 {
 
-/**
-	Buffer of variable-lenght events.
 
-	[type1][size1][struct1][type2][size2][struct2]...
-*/
+///	__OsEventBuffer__ is a global buffer used for storing events.
+///	Each subsystem can read its relative events and modifies its behaviour consequently.
+///
+/// [type #0][size #0][data #0] ... [type #n][size #n][data #n]
 class OsEventBuffer
 {
 

+ 9 - 5
engine/os/OsEvents.h

@@ -31,7 +31,7 @@ OTHER DEALINGS IN THE SOFTWARE.
 namespace crown
 {
 
-//-----------------------------------------------------------------------------
+/// __OsEventType__ represents an event fired by the OS
 enum OsEventType
 {
 	OSET_NONE				= 0,
@@ -50,7 +50,8 @@ enum OsEventType
 	OSET_ACCELEROMETER		= 9
 };
 
-//-----------------------------------------------------------------------------
+/// __OsMouseEvent__ represents an event fired by mouse.
+/// It is processed by InputManager.
 struct OsMouseEvent
 {
 	uint32_t button;
@@ -58,14 +59,16 @@ struct OsMouseEvent
 	uint32_t y;
 };
 
-//-----------------------------------------------------------------------------
+/// __OsKeyboardEvent__ represents an event fired by keyboard.
+/// it is processed by InputManager.
 struct OsKeyboardEvent
 {
 	uint32_t key;
 	uint32_t modifier;
 };
 
-//-----------------------------------------------------------------------------
+/// __OsTouchEvent__ represents an event fired by touch screen.
+/// It is processed by InputManager.
 struct OsTouchEvent
 {
 	uint32_t pointer_id;
@@ -73,7 +76,8 @@ struct OsTouchEvent
 	uint32_t y;
 };
 
-//-----------------------------------------------------------------------------
+/// __OsAccelerometerEvent__ represents an event fired by accelerometer.
+/// It is processed by InputManager.
 struct OsAccelerometerEvent
 {
 	float x;

+ 0 - 1
engine/os/android/AndroidOS.cpp

@@ -308,7 +308,6 @@ void execute_process(const char* args[])
 	}
 }
 
-
 } // namespace os
 
 //-----------------------------------------------------------------------------

+ 1 - 2
engine/os/android/java/CrownTouch.java

@@ -35,10 +35,9 @@ import android.view.MotionEvent;
 * CrownTouch manages touch and gesture events passing them to Crown Engine
 */
 
-//TODO: gestures doesn't work...fix them
 public class CrownTouch
 {
-	private boolean 				isListening;
+	private boolean isListening;
 
 //-----------------------------------------------------------------------------------
 	public CrownTouch(Context context)