The Zandalar project - Revision history

Timotei: /* Semantics Table */

2013-07-19T21:02:02Z

‎Semantics Table

Timotei: /* Proposed design */

2013-07-19T09:18:33Z

‎Proposed design

Timotei: /* Semantics Table */

2013-07-18T21:04:48Z

‎Semantics Table

Timotei: /* Proposed design */

2013-07-18T20:43:18Z

‎Proposed design

Timotei: /* Semantics Table */

2013-07-16T21:04:51Z

‎Semantics Table

Timotei: /* Semantics Table */

2013-07-16T16:43:56Z

‎Semantics Table

Timotei: Add semantic input events

2013-07-16T16:42:13Z

Add semantic input events

Timotei: Some reorganisation

2013-07-15T21:59:13Z

Some reorganisation

Timotei: /* Proposed design */

2013-07-15T10:44:00Z

‎Proposed design

Timotei: Add decision section for button press

2013-07-15T10:43:16Z

Add decision section for button press

@@ Line 103: / Line 103: @@
 injectMouseMove + injectMousePosition
 * PointerMove
-injectMouseButtonDown + injectMouseButtonUp
+injectMouseButtonDown
-* PointerActivate (PointerSource)
+* PointerHold (PointerSource)
 * SelectMultipleItems (SHIFT + click)
-* SelectCumulative (CTRL+CLICK)
+* SelectCumulative (CTRL + CLICK)
 injectMouseButtonClick
-* PointerActivate
+* PointerActivate (PointerSource)
 injectMouseButtonDoubleClick
 * SelectWord (double click)
 injectMouseButtonTripleClick
 * SelectAll (triple click)
 <strike>'''Question:''' Maybe we should create a standalone event type for pointer activation which also 'records' the number of activations? (for example in the case of double/triple click). The editbox uses double/triple click to select all text. Maybe let semantic action 'select all?'</strike>: YES
@@ Line 120: / Line 120: @@
 * Introduce the idea of 'PointerSource' which can be left/right/middle
 * Add separate values: LeftPointerActivation, RightPointerActivation, etc? (I'd go for this)</strike>: We go for 'PointerSource' enum in the Semantic Event payload.
 injectKeyDown + injectKeyUp

@@ Line 69: / Line 69: @@
 |-
 ! Input Event name !! Data !! Functions covered
 |-
 | SemanticInputEvent ||
 * Value: Enum/int (see below table)
-* Payload: float (for now)
+* Payload:
 ||
 * injectMouseButtonDown
@@ Line 103: / Line 101: @@
 The following table represents the semantic values (members of an ENUM) and the raw event(s) from which they are generated.
 injectMouseButtonDown + injectMouseButtonUp
-* PointerActivate
+* PointerActivate (PointerSource)
 * SelectMultipleItems (SHIFT + click)
 * SelectCumulative (CTRL+CLICK)
@@ Line 115: / Line 115: @@
 * PointerActivate
 * SelectAll (triple click)
-'''Question:''' Maybe we should create a standalone event type for pointer activation which also 'records' the number of activations? (for example in the case of double/triple click). The editbox uses double/triple click to select all text. Maybe let semantic action 'select all?'
+<strike>'''Question:''' Maybe we should create a standalone event type for pointer activation which also 'records' the number of activations? (for example in the case of double/triple click). The editbox uses double/triple click to select all text. Maybe let semantic action 'select all?'</strike>: YES
-'''Question2:''' What we do with the right/middle/extra mouse buttons (TabControl uses middle and nobutton buttons)?:
+<strike>'''Question2:''' What we do with the right/middle/extra mouse buttons (TabControl uses middle and nobutton buttons)?:
 * Introduce the idea of 'PointerSource' which can be left/right/middle
-* Add separate values: LeftPointerActivation, RightPointerActivation, etc? (I'd go for this)
+* Add separate values: LeftPointerActivation, RightPointerActivation, etc? (I'd go for this)</strike>: We go for 'PointerSource' enum in the Semantic Event payload.
 injectMouseButtonUp

@@ Line 138: / Line 138: @@
 * SelectAll (CTRL+A)
 * Back (escape)
 * Undo (CTRL+Z)
 * Redo (CTRL+Y)
@@ Line 148: / Line 143: @@
 * Copy (CTRL+C)
 * Paste (CTRL+V)
 == Decisions ==

@@ Line 79: / Line 79: @@
 | SemanticInputEvent ||
 * Value: Enum/int (see below table)
 ||
 * injectMouseButtonDown
@@ Line 87: / Line 88: @@
 * injectMouseButtonDoubleClick
 * injectMouseButtonTripleClick
 |-
 | TextInputEvent ||
@@ Line 93: / Line 95: @@
 * injectChar
 |-
 |}
@@ Line 141: / Line 138: @@
 * SelectAll (CTRL+A)
 * Back (escape)
 * Undo (CTRL+Z)

@@ Line 107: / Line 107: @@
 injectMouseButtonDown + injectMouseButtonUp
-* PointerActivation
+* PointerActivate
 * SelectMultipleItems (SHIFT + click)
 * SelectCumulative (CTRL+CLICK)
 injectMouseButtonClick
-* PointerActivation
+* PointerActivate
 injectMouseButtonDoubleClick
-* PointerActivation
+* PointerActivate
 * SelectWord (double click)
 injectMouseButtonTripleClick
-* PointerActivation
+* PointerActivate
 * SelectAll (triple click)
 '''Question:''' Maybe we should create a standalone event type for pointer activation which also 'records' the number of activations? (for example in the case of double/triple click). The editbox uses double/triple click to select all text. Maybe let semantic action 'select all?'
@@ Line 125: / Line 125: @@
 injectMouseButtonUp
-* PointerDeactivation
+* PointerDeactivate
 injectKeyDown + injectKeyUp
@@ Line 133: / Line 133: @@
 * SelectLeftCharacter (SHIFT + left arrow)
 * SelectRightCharacter (SHIFT + right arrow)
-* PreviousCharacter (left arrow)
+* GoToPreviousCharacter (left arrow)
-* PreviousWord (CTRL + left arrow)
+* GoToPreviousWord (CTRL + left arrow)
-* NextCharacter (right arrow)
+* GoToNextCharacter (right arrow)
-* NextWord (CTRL + right arrow)
+* GoToNextWord (CTRL + right arrow)
 * GoToStartOfLine (home)
 * GoToEndOfLine (end)

@@ Line 32: / Line 32: @@
 | Press the ENTER key (1) || Key Button press || injectKeyDown(Enter) || SemanticInputEvent(Confirm)
 |-
-| Release the ENTER key || Key Button release || injectKeyUp(Enter) || ReleasedButtonInputEvent(Confirm)
+| Release the ENTER key *** || Key Button release || injectKeyUp(Enter) || ReleasedButtonInputEvent(Confirm) **** (check the semantics table)
 |-
 | The button is clicked (Click event is triggered)|| N/A || N/A || N/A
@@ Line 78: / Line 78: @@
 |-
 | SemanticInputEvent ||
-* Value: Enum + int (see below table)
+* Value: Enum/int (see below table)
 ||
 * injectMouseButtonDown
@@ Line 104: / Line 104: @@
 === Semantics Table ===
-The following table represents the semantic values and the raw event(s) from which they are generated
+The following table represents the semantic values (members of an ENUM) and the raw event(s) from which they are generated.
 == Decisions ==
 === Combining keyboard, gamepad and mouse button pressed actions ===

@@ Line 14: / Line 14: @@
 ! Step description !! Raw input !! Input Injection !! InputEvent fed to CEGUI
 |-
-| Move the mouse over the button || Mouse movement || injectMouseMove/injectMousePosition || MovementInputEvent
+| Move the mouse over the button || Mouse movement || injectMouseMove/injectMousePosition || PointerMovementInputEvent
 |-
-| Press the LMB || Mouse button press || injectMouseButtonDown(LMB) || PressedButtonInputEvent(Mouse_LMB)
+| Press the LMB || Mouse button press || injectMouseButtonDown(LMB) || PointerActivationInputEvent
 |-
-| Release the LMB|| Mouse button release || injectMouseButtonUp(LMB) || ReleasedButtonInputEvent(Mouse_LMB)
+| Release the LMB|| Mouse button release || injectMouseButtonUp(LMB) || PointerDeactivationInputEvent
 |-
 | The button is clicked (Click event is triggered)|| N/A || N/A || N/A
@@ Line 30: / Line 30: @@
 | Focus the button || colspan = 3 | Uses the use case "''Focus a button using the keyboard/gamepad''"
 |-
-| Press the ENTER key (1) || Key Button press || injectKeyDown(Enter) || PressedButtonInputEvent(Keyb_Enter)
+| Press the ENTER key (1) || Key Button press || injectKeyDown(Enter) || SemanticInputEvent(Confirm)
 |-
-| Release the ENTER key || Key Button release || injectKeyUp(Enter) || ReleasedButtonInputEvent(Keyb_Enter)
+| Release the ENTER key || Key Button release || injectKeyUp(Enter) || ReleasedButtonInputEvent(Confirm)
 |-
 | The button is clicked (Click event is triggered)|| N/A || N/A || N/A
@@ Line 51: / Line 51: @@
 | Press a character key || Char press || injectChar(chr) || TextInputEvent(chr)
 |-
-| Press a non-character key || Key Button press || injectKeyDown(key) || PressedButtonInputEvent(Keyb_key)
+| Press backspace (delete last char) || Key Button press || injectKeyDown(key) || SemanticInputEvent(DeleteLastCharacter)
-|-
-| Release a non-character key || Key Button release || injectKeyUp(key) || ReleasedButtonInputEvent(Keyb_key
 |}
@@ Line 72: / Line 70: @@
 ! Input Event name !! Data !! Functions covered
 |-
-| MovementInputEvent ||
+| PointerMovementInputEvent ||
 * Position : Vector2
 * Delta : Vector2
@@ Line 79: / Line 77: @@
 * injectMousePosition
 |-
-| PressedButtonInputEvent@@@ ||
+| SemanticInputEvent ||
-* Button : Buttons Enum/integer or long for maximum flexibility
+* Value: Enum + int (see below table)
 ||
 * injectMouseButtonDown
 * injectKeyDown
 * injectMouseButtonUp
 * injectKeyUp
 * injectMouseButtonClick
 * injectMouseButtonDoubleClick
@@ Line 114: / Line 103: @@
 * injectMouseLeaves
-@@@ subject to the next section, Decisions.
+=== Semantics Table ===
 == Decisions ==
 === Combining keyboard, gamepad and mouse button pressed actions ===
-We have two ways of handling this.
+We have three ways of handling this.
 * Using two types of events (Pressed/ReleasedButtonInputEvent) AND SemanticInputEvent
 ** We have a "big" enum which contains all possible values for a keyboard, mouse and the gamepad
@@ Line 127: / Line 118: @@
 * Using just the raw types of event (Pressed/ReleasedInputEvent) WITHOUT SemanticInputEvent
 ** This would involve '''ignoring the explicit click calls''', and rather generate them inside the system.
 = GUI navigation =

@@ Line 91: / Line 91: @@
 * injectKeyUp
 |-
-| ActivatedInputEvent ||
+| ActivatedInputEvent@@@  ||
 * Count (1+) : int
 ||
@@ Line 112: / Line 112: @@
 Unmapped (yet) functions:
 * injectMouseLeaves
 = GUI navigation =