AtomicNET : AtomicEngine Namespace

Input Class

%Input subsystem. Converts operating system window messages to input state and events.

Syntax

public class Input : AObject

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from AObject.

Public Constructors

Input ()
Documentation for this section has not yet been entered.
Construct.

Public Fields

nativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)

Public Properties

[read-only]
Category string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
Minimized bool . Documentation for this section has not yet been entered.
[read-only]
MouseGrabbed bool . Documentation for this section has not yet been entered.
[read-only]
MouseLocked bool . Documentation for this section has not yet been entered.
[read-only]
MouseMode MouseMode . Documentation for this section has not yet been entered.
[read-only]
MouseMove IntVector2 . Documentation for this section has not yet been entered.
[read-only]
MouseMoveWheel int . Documentation for this section has not yet been entered.
[read-only]
MouseMoveX int . Documentation for this section has not yet been entered.
[read-only]
MouseMoveY int . Documentation for this section has not yet been entered.
MousePosition IntVector2 . Documentation for this section has not yet been entered.
[read-only]
MouseVisible bool . Documentation for this section has not yet been entered.
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
NumJoysticks uint . Documentation for this section has not yet been entered.
[read-only]
NumTouches uint . Documentation for this section has not yet been entered.
[read-only]
Qualifiers int . Documentation for this section has not yet been entered.
[read-only]
ScreenKeyboardSupport bool . Documentation for this section has not yet been entered.
ScreenKeyboardVisible bool . Documentation for this section has not yet been entered.
ToggleFullscreen bool . Documentation for this section has not yet been entered.
TouchEmulation bool . Documentation for this section has not yet been entered.
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
TypeNameStatic string . Documentation for this section has not yet been entered. (Inherited from AObject.)

Public Methods

AddRef ()
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
AddRefSilent ()
Increment reference count. Do not call any lifetime book keeping (Inherited from RefCounted.)
BindButton (UIButton, int)
Binds UIButton element to the given button
CenterMousePosition ()
Center the mouse position.
static
csb_Atomic_Input_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
GetCategory () : string
Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. (Inherited from AObject.)
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetJoystickByIndex (uint) : JoystickState
Return joystick state by index, or null if does not exist. 0 = first connected joystick.
GetJoystickByName (string) : JoystickState
Return joystick state by name, or null if does not exist.
GetJoystickRumble (uint) : bool
Documentation for this section has not yet been entered.
GetKeyDown (int) : bool
Check if a key is held down.
GetKeyFromName (string) : int
Return keycode from key name.
GetKeyFromScancode (int) : int
Return keycode from scancode.
GetKeyName (int) : string
Return name of key from keycode.
GetKeyPress (int) : bool
Check if a key has been pressed on this frame.
GetMouseButtonDown (int) : bool
Check if a mouse button is held down.
GetMouseButtonPress (int) : bool
Check if a mouse button has been pressed on this frame.
GetMouseMode () : MouseMode
Return the mouse mode.
GetMouseMove () : IntVector2
Return mouse movement since last frame.
GetMouseMoveWheel () : int
Return mouse wheel movement since last frame.
GetMouseMoveX () : int
Return horizontal mouse movement since last frame.
GetMouseMoveY () : int
Return vertical mouse movement since last frame.
GetMousePosition () : IntVector2
Return mouse position within window. Should only be used with a visible mouse cursor.
GetNumJoysticks () : uint
Return number of connected joysticks.
GetNumTouches () : uint
Return number of active finger touches.
GetQualifierDown (int) : bool
Check if a qualifier key is held down.
GetQualifierPress (int) : bool
Check if a qualifier key has been pressed on this frame.
GetQualifiers () : int
Return the currently held down qualifiers.
GetScancodeDown (int) : bool
Check if a key is held down by scancode.
GetScancodeFromKey (int) : int
Return scancode from keycode.
GetScancodeFromName (string) : int
Return scancode from key name.
GetScancodeName (int) : string
Return name of key from scancode.
GetScancodePress (int) : bool
Check if a key has been pressed on this frame by scancode.
GetScreenKeyboardSupport () : bool
Return whether on-screen keyboard is supported.
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
GetToggleFullscreen () : bool
Return whether fullscreen toggle is enabled.
GetTouchDelta (uint) : IntVector2
Documentation for this section has not yet been entered.
GetTouchEmulation () : bool
Return whether touch emulation is enabled.
GetTouchID (uint) : int
Documentation for this section has not yet been entered.
GetTouchLastPosition (uint) : IntVector2
Documentation for this section has not yet been entered.
GetTouchPosition (uint) : IntVector2
Documentation for this section has not yet been entered.
GetTouchPressure (uint) : float
Documentation for this section has not yet been entered.
GetTouchWidget (uint) : UIWidget
Documentation for this section has not yet been entered.
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
HasEventHandlers () : bool
Return whether has subscribed to any event. (Inherited from AObject.)
HasFocus () : bool
Return whether application window has input focus.
HasSubscribedToEvent (StringHash) : bool
Return whether has subscribed to an event without specific sender. (Inherited from AObject.)
HasSubscribedToEvent (AObject, StringHash) : bool
Return whether has subscribed to a specific sender's event. (Inherited from AObject.)
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
IsMinimized () : bool
Return whether application window is minimized.
IsMouseGrabbed () : bool
Return whether the mouse is currently being grabbed by an operation.
IsMouseLocked () : bool
Return whether the mouse is locked to the window
IsMouseVisible () : bool
Return whether the operating system mouse cursor is visible.
override
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from AObject.)
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
IsScreenKeyboardVisible () : bool
Return whether on-screen keyboard is being shown.
JoystickRumble (uint, float, uint)
return if rumble is supported on game controller
JoystickSimulateMouseButton (int)
moves the on screen cursor
JoystickSimulateMouseMove (int, int)
produce rumble
LoadGestures (Deserializer) : uint
Load touch gestures from a file. Return number of loaded gestures, or 0 on failure.
RecordGesture () : bool
Begin recording a touch gesture. Return true if successful. The E_GESTURERECORDED event (which contains the ID for the new gesture) will be sent when recording finishes.
Refs () : int
Return reference count. (Inherited from RefCounted.)
ReleaseRef ()
Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
RemoveAllGestures ()
Remove all in-memory gestures.
RemoveGesture (uint) : bool
Remove an in-memory gesture by ID. Return true if was found.
ResetMouseGrabbed ()
Reset the mouse grabbed to the last unsuppressed SetMouseGrabbed call
ResetMouseMode ()
Reset the last mouse mode that wasn't suppressed in SetMouseMode
ResetMouseVisible ()
Reset last mouse visibility that was not suppressed in SetMouseVisible.
SaveGesture (Serializer, uint) : bool
Save a specific in-memory touch gesture to a file. Return true if successful.
SaveGestures (Serializer) : bool
Save all in-memory touch gestures. Return true if successful.
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetMouseGrabbed (bool, bool)
Set whether the mouse is currently being grabbed by an operation.
SetMouseMode (MouseMode, bool)
SetMousePosition (IntVector2)
Set the mouse cursor position.
SetMouseVisible (bool, bool)
Set whether the operating system mouse cursor is visible. When not visible (default), is kept centered to prevent leaving the window. Mouse visibility event can be suppressed-- this also recalls any unsuppressed SetMouseVisible which can be returned by ResetMouseVisible().
SetScreenKeyboardVisible (bool)
Show or hide on-screen keyboard on platforms that support it. When shown, keypresses from it are delivered as key events.
SetToggleFullscreen (bool)
Set whether ALT-ENTER fullscreen toggle is enabled.
SetTouchEmulation (bool)
Set touch emulation by mouse. Only available on desktop platforms. When enabled, actual mouse events are no longer sent and the mouse cursor is forced visible.
SimulateButtonDown (int)
Documentation for this section has not yet been entered.
SimulateButtonUp (int)
Documentation for this section has not yet been entered.
SubscribeToEvent (string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (AObject, NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromAllEvents ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (StringHash)
Unsubscribe from an event. (Inherited from AObject.)
UnsubscribeFromEvent (uint)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (AObject, StringHash)
Unsubscribe from a specific sender's event. (Inherited from AObject.)
UnsubscribeFromEvent<T> ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEventReceiver (AObject)
Unsubscribe from event for specific receiver (where the event handler isn't necessarily in the subscribed object) (Inherited from AObject.)
UnsubscribeFromEvents (AObject)
Unsubscribe from a specific sender's events. (Inherited from AObject.)
Update ()
Poll for window messages. Called by HandleBeginFrame().
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

Input Constructor

Documentation for this section has not yet been entered.

Syntax

public Input ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Input Constructor

Construct.

Syntax

public Input (IntPtr native)

Parameters

native
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

BindButton Method

Binds UIButton element to the given button

Syntax

public void BindButton (UIButton touchButton, int button)

Parameters

touchButton
Documentation for this section has not yet been entered.
button
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

CenterMousePosition Method

Center the mouse position.

Syntax

public void CenterMousePosition ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

csb_Atomic_Input_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_Input_GetClassIDStatic ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetJoystickByIndex Method

Return joystick state by index, or null if does not exist. 0 = first connected joystick.

Syntax

public JoystickState GetJoystickByIndex (uint index)

Parameters

index
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetJoystickByName Method

Return joystick state by name, or null if does not exist.

Syntax

public JoystickState GetJoystickByName (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetJoystickRumble Method

Documentation for this section has not yet been entered.

Syntax

public bool GetJoystickRumble (uint id)

Parameters

id
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetKeyDown Method

Check if a key is held down.

Syntax

public bool GetKeyDown (int key)

Parameters

key
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetKeyFromName Method

Return keycode from key name.

Syntax

public int GetKeyFromName (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetKeyFromScancode Method

Return keycode from scancode.

Syntax

public int GetKeyFromScancode (int scancode)

Parameters

scancode
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetKeyName Method

Return name of key from keycode.

Syntax

public string GetKeyName (int key)

Parameters

key
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetKeyPress Method

Check if a key has been pressed on this frame.

Syntax

public bool GetKeyPress (int key)

Parameters

key
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetMouseButtonDown Method

Check if a mouse button is held down.

Syntax

public bool GetMouseButtonDown (int button)

Parameters

button
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetMouseButtonPress Method

Check if a mouse button has been pressed on this frame.

Syntax

public bool GetMouseButtonPress (int button)

Parameters

button
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetMouseMode Method

Return the mouse mode.

Syntax

public MouseMode GetMouseMode ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetMouseMove Method

Return mouse movement since last frame.

Syntax

public IntVector2 GetMouseMove ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetMouseMoveWheel Method

Return mouse wheel movement since last frame.

Syntax

public int GetMouseMoveWheel ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetMouseMoveX Method

Return horizontal mouse movement since last frame.

Syntax

public int GetMouseMoveX ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetMouseMoveY Method

Return vertical mouse movement since last frame.

Syntax

public int GetMouseMoveY ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetMousePosition Method

Return mouse position within window. Should only be used with a visible mouse cursor.

Syntax

public IntVector2 GetMousePosition ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetNumJoysticks Method

Return number of connected joysticks.

Syntax

public uint GetNumJoysticks ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetNumTouches Method

Return number of active finger touches.

Syntax

public uint GetNumTouches ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetQualifierDown Method

Check if a qualifier key is held down.

Syntax

public bool GetQualifierDown (int qualifier)

Parameters

qualifier
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetQualifierPress Method

Check if a qualifier key has been pressed on this frame.

Syntax

public bool GetQualifierPress (int qualifier)

Parameters

qualifier
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetQualifiers Method

Return the currently held down qualifiers.

Syntax

public int GetQualifiers ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetScancodeDown Method

Check if a key is held down by scancode.

Syntax

public bool GetScancodeDown (int scancode)

Parameters

scancode
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetScancodeFromKey Method

Return scancode from keycode.

Syntax

public int GetScancodeFromKey (int key)

Parameters

key
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetScancodeFromName Method

Return scancode from key name.

Syntax

public int GetScancodeFromName (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetScancodeName Method

Return name of key from scancode.

Syntax

public string GetScancodeName (int scancode)

Parameters

scancode
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetScancodePress Method

Check if a key has been pressed on this frame by scancode.

Syntax

public bool GetScancodePress (int scancode)

Parameters

scancode
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetScreenKeyboardSupport Method

Return whether on-screen keyboard is supported.

Syntax

public bool GetScreenKeyboardSupport ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetToggleFullscreen Method

Return whether fullscreen toggle is enabled.

Syntax

public bool GetToggleFullscreen ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTouchDelta Method

Documentation for this section has not yet been entered.

Syntax

public IntVector2 GetTouchDelta (uint index)

Parameters

index
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTouchEmulation Method

Return whether touch emulation is enabled.

Syntax

public bool GetTouchEmulation ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTouchID Method

Documentation for this section has not yet been entered.

Syntax

public int GetTouchID (uint index)

Parameters

index
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTouchLastPosition Method

Documentation for this section has not yet been entered.

Syntax

public IntVector2 GetTouchLastPosition (uint index)

Parameters

index
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTouchPosition Method

Documentation for this section has not yet been entered.

Syntax

public IntVector2 GetTouchPosition (uint index)

Parameters

index
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTouchPressure Method

Documentation for this section has not yet been entered.

Syntax

public float GetTouchPressure (uint index)

Parameters

index
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTouchWidget Method

Documentation for this section has not yet been entered.

Syntax

public UIWidget GetTouchWidget (uint index)

Parameters

index
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

HasFocus Method

Return whether application window has input focus.

Syntax

public bool HasFocus ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsMinimized Method

Return whether application window is minimized.

Syntax

public bool IsMinimized ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsMouseGrabbed Method

Return whether the mouse is currently being grabbed by an operation.

Syntax

public bool IsMouseGrabbed ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsMouseLocked Method

Return whether the mouse is locked to the window

Syntax

public bool IsMouseLocked ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsMouseVisible Method

Return whether the operating system mouse cursor is visible.

Syntax

public bool IsMouseVisible ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsScreenKeyboardVisible Method

Return whether on-screen keyboard is being shown.

Syntax

public bool IsScreenKeyboardVisible ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

JoystickRumble Method

return if rumble is supported on game controller

Syntax

public void JoystickRumble (uint id, float strength, uint length)

Parameters

id
Documentation for this section has not yet been entered.
strength
Documentation for this section has not yet been entered.
length
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

JoystickSimulateMouseButton Method

moves the on screen cursor

Syntax

public void JoystickSimulateMouseButton (int button)

Parameters

button
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

JoystickSimulateMouseMove Method

produce rumble

Syntax

public void JoystickSimulateMouseMove (int xpos, int ypos)

Parameters

xpos
Documentation for this section has not yet been entered.
ypos
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

LoadGestures Method

Load touch gestures from a file. Return number of loaded gestures, or 0 on failure.

Syntax

public uint LoadGestures (Deserializer source)

Parameters

source
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Minimized Property

Documentation for this section has not yet been entered.

Syntax

public bool Minimized { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

MouseGrabbed Property

Documentation for this section has not yet been entered.

Syntax

public bool MouseGrabbed { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

MouseLocked Property

Documentation for this section has not yet been entered.

Syntax

public bool MouseLocked { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

MouseMode Property

Documentation for this section has not yet been entered.

Syntax

public MouseMode MouseMode { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

MouseMove Property

Documentation for this section has not yet been entered.

Syntax

public IntVector2 MouseMove { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

MouseMoveWheel Property

Documentation for this section has not yet been entered.

Syntax

public int MouseMoveWheel { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

MouseMoveX Property

Documentation for this section has not yet been entered.

Syntax

public int MouseMoveX { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

MouseMoveY Property

Documentation for this section has not yet been entered.

Syntax

public int MouseMoveY { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

MousePosition Property

Documentation for this section has not yet been entered.

Syntax

public IntVector2 MousePosition { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

MouseVisible Property

Documentation for this section has not yet been entered.

Syntax

public bool MouseVisible { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

NumJoysticks Property

Documentation for this section has not yet been entered.

Syntax

public uint NumJoysticks { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

NumTouches Property

Documentation for this section has not yet been entered.

Syntax

public uint NumTouches { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Qualifiers Property

Documentation for this section has not yet been entered.

Syntax

public int Qualifiers { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

RecordGesture Method

Begin recording a touch gesture. Return true if successful. The E_GESTURERECORDED event (which contains the ID for the new gesture) will be sent when recording finishes.

Syntax

public bool RecordGesture ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

RemoveAllGestures Method

Remove all in-memory gestures.

Syntax

public void RemoveAllGestures ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

RemoveGesture Method

Remove an in-memory gesture by ID. Return true if was found.

Syntax

public bool RemoveGesture (uint gestureID)

Parameters

gestureID
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ResetMouseGrabbed Method

Reset the mouse grabbed to the last unsuppressed SetMouseGrabbed call

Syntax

public void ResetMouseGrabbed ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ResetMouseMode Method

Reset the last mouse mode that wasn't suppressed in SetMouseMode

Syntax

public void ResetMouseMode ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ResetMouseVisible Method

Reset last mouse visibility that was not suppressed in SetMouseVisible.

Syntax

public void ResetMouseVisible ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SaveGesture Method

Save a specific in-memory touch gesture to a file. Return true if successful.

Syntax

public bool SaveGesture (Serializer dest, uint gestureID)

Parameters

dest
Documentation for this section has not yet been entered.
gestureID
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SaveGestures Method

Save all in-memory touch gestures. Return true if successful.

Syntax

public bool SaveGestures (Serializer dest)

Parameters

dest
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ScreenKeyboardSupport Property

Documentation for this section has not yet been entered.

Syntax

public bool ScreenKeyboardSupport { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ScreenKeyboardVisible Property

Documentation for this section has not yet been entered.

Syntax

public bool ScreenKeyboardVisible { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetMouseGrabbed Method

Set whether the mouse is currently being grabbed by an operation.

Syntax

public void SetMouseGrabbed (bool grab, bool suppressEvent)

Parameters

grab
Documentation for this section has not yet been entered.
suppressEvent
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetMouseMode Method

Syntax

public void SetMouseMode (MouseMode mode, bool suppressEvent)

Parameters

mode
Documentation for this section has not yet been entered.
suppressEvent
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetMousePosition Method

Set the mouse cursor position.

Syntax

public void SetMousePosition (IntVector2 position)

Parameters

position
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetMouseVisible Method

Set whether the operating system mouse cursor is visible. When not visible (default), is kept centered to prevent leaving the window. Mouse visibility event can be suppressed-- this also recalls any unsuppressed SetMouseVisible which can be returned by ResetMouseVisible().

Syntax

public void SetMouseVisible (bool enable, bool suppressEvent)

Parameters

enable
Documentation for this section has not yet been entered.
suppressEvent
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetScreenKeyboardVisible Method

Show or hide on-screen keyboard on platforms that support it. When shown, keypresses from it are delivered as key events.

Syntax

public void SetScreenKeyboardVisible (bool enable)

Parameters

enable
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetToggleFullscreen Method

Set whether ALT-ENTER fullscreen toggle is enabled.

Syntax

public void SetToggleFullscreen (bool enable)

Parameters

enable
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetTouchEmulation Method

Set touch emulation by mouse. Only available on desktop platforms. When enabled, actual mouse events are no longer sent and the mouse cursor is forced visible.

Syntax

public void SetTouchEmulation (bool enable)

Parameters

enable
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SimulateButtonDown Method

Documentation for this section has not yet been entered.

Syntax

public void SimulateButtonDown (int button)

Parameters

button
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SimulateButtonUp Method

Documentation for this section has not yet been entered.

Syntax

public void SimulateButtonUp (int button)

Parameters

button
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ToggleFullscreen Property

Documentation for this section has not yet been entered.

Syntax

public bool ToggleFullscreen { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

TouchEmulation Property

Documentation for this section has not yet been entered.

Syntax

public bool TouchEmulation { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Update Method

Poll for window messages. Called by HandleBeginFrame().

Syntax

public void Update ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0