Describes a virtual button (a key from a keyboard, a mouse button, an axis of a joystick...etc.). More...

Inheritance diagram for SiliconStudio.Paradox.Input.VirtualButton:

Classes
class	GamePad
	GamePad virtual button. More...

class	Keyboard
	Keyboard virtual button. More...

class	Mouse
	Mouse virtual button. More...

Public Member Functions
override string	ToString ()

abstract float	GetValue (InputManagerBase manager)
	Gets the value associated with this virtual button from an input manager. More...

Static Public Member Functions
static IVirtualButton	operator+ (IVirtualButton left, VirtualButton right)
	Implements the + operator to combine to VirtualButton. More...

static implicit	operator VirtualButtonGroup (VirtualButton button)
	Performs an implicit conversion from VirtualButton to VirtualButtonAnd. More...

static VirtualButton	Find (string name)
	Finds a virtual button by the specified name. More...

static VirtualButton	Find (int id)
	Finds a virtual button by the specified id. More...

Public Attributes
readonly int	Id
	Unique Id for a particular button Type. More...

readonly string	Name
	Name of this button. More...

readonly VirtualButtonType	Type
	Type of this button. More...

readonly bool	IsPositiveAndNegative
	A boolean indicating whether this button supports positive and negative value. More...

Properties
static IReadOnlyCollection < VirtualButton >	Registered `[get]`
	Gets all registered VirtualButton. More...

Detailed Description

Describes a virtual button (a key from a keyboard, a mouse button, an axis of a joystick...etc.).

Definition at line 15 of file VirtualButton.cs.

Member Function Documentation

static VirtualButton SiliconStudio.Paradox.Input.VirtualButton.Find ( string name )

static

Finds a virtual button by the specified name.

Parameters

name The name.

Returns: An instance of VirtualButton or null if no match.

Definition at line 107 of file VirtualButton.cs.

static VirtualButton SiliconStudio.Paradox.Input.VirtualButton.Find ( int id )

static

Finds a virtual button by the specified id.

Parameters

id The id.

Returns: An instance of VirtualButton or null if no match.

Definition at line 120 of file VirtualButton.cs.

abstract float SiliconStudio.Paradox.Input.VirtualButton.GetValue ( InputManagerBase manager )

pure virtual

Gets the value associated with this virtual button from an input manager.

Parameters

manager The manager.

Returns: System.Single.

Implements SiliconStudio.Paradox.Input.IVirtualButton.

Implemented in SiliconStudio.Paradox.Input.VirtualButton.Keyboard, SiliconStudio.Paradox.Input.VirtualButton.GamePad, and SiliconStudio.Paradox.Input.VirtualButton.Mouse.

static implicit SiliconStudio.Paradox.Input.VirtualButton.operator VirtualButtonGroup ( VirtualButton button )

static

Performs an implicit conversion from VirtualButton to VirtualButtonAnd.

Parameters

button The virtual button.

Returns: The result of the conversion.

Definition at line 84 of file VirtualButton.cs.

static IVirtualButton SiliconStudio.Paradox.Input.VirtualButton.operator+	(	IVirtualButton	left,
		VirtualButton	right
	)

static

Implements the + operator to combine to VirtualButton.

Parameters

left	The left virtual button.
right	The right virtual button.

Returns: A set containting the two virtual buttons.

Definition at line 69 of file VirtualButton.cs.

override string SiliconStudio.Paradox.Input.VirtualButton.ToString ( )

Definition at line 58 of file VirtualButton.cs.

Member Data Documentation

readonly int SiliconStudio.Paradox.Input.VirtualButton.Id

Unique Id for a particular button Type.

Definition at line 41 of file VirtualButton.cs.

readonly bool SiliconStudio.Paradox.Input.VirtualButton.IsPositiveAndNegative

A boolean indicating whether this button supports positive and negative value.

Definition at line 56 of file VirtualButton.cs.

readonly string SiliconStudio.Paradox.Input.VirtualButton.Name

Name of this button.

Definition at line 46 of file VirtualButton.cs.

readonly VirtualButtonType SiliconStudio.Paradox.Input.VirtualButton.Type

Type of this button.

Definition at line 51 of file VirtualButton.cs.

Property Documentation

IReadOnlyCollection<VirtualButton> SiliconStudio.Paradox.Input.VirtualButton.Registered

staticget

Gets all registered VirtualButton.

The registered virtual buttons.

Definition at line 94 of file VirtualButton.cs.

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

D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/engine/SiliconStudio.Paradox.Input/VirtualButton.cs

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation