Class VirtualButton.Pointer

Namespace

Stride.Input

Assembly

Stride.Input.dll

Mouse virtual button.

public class VirtualButton.Pointer : VirtualButton, IVirtualButton

Inheritance

object

VirtualButton

VirtualButton.Pointer

Implements

IVirtualButton

Inherited Members

VirtualButton.Id

VirtualButton.Name

VirtualButton.ShortName

VirtualButton.Type

VirtualButton.IsPositiveAndNegative

VirtualButton.Index

VirtualButton.ToString()

VirtualButton.Registered

VirtualButton.Find(string)

VirtualButton.Find(int)

Constructors

Pointer(string, int, int, bool)

protected Pointer(string name, int id, int pointerId, bool isPositiveAndNegative)

Parameters

name string

id int

pointerId int

isPositiveAndNegative bool

Fields

DeltaX

The X component of the Pointer Delta.

public static readonly VirtualButton.Pointer DeltaX

Field Value

VirtualButton.Pointer

DeltaY

The Y component of the Pointer Delta.

public static readonly VirtualButton.Pointer DeltaY

Field Value

VirtualButton.Pointer

PointerId

The pad index.

public readonly int PointerId

Field Value

int

PositionX

The X component of the Pointer Position.

public static readonly VirtualButton.Pointer PositionX

Field Value

VirtualButton.Pointer

PositionY

The Y component of the Pointer Position.

public static readonly VirtualButton.Pointer PositionY

Field Value

VirtualButton.Pointer

State

The current state of pointers.

public static readonly VirtualButton.Pointer State

Field Value

VirtualButton.Pointer

Methods

BuildButtonName()

protected override string BuildButtonName()

Returns

string

GetValue(InputManager)

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

public override float GetValue(InputManager manager)

Parameters

manager InputManager

The manager.

Returns

float

System.Single.

IsDown(InputManager)

Indicate if the button is currently down

public override bool IsDown(InputManager manager)

Parameters

manager InputManager

The input manager

Returns

bool

IsPressed(InputManager)

Indicate if the button has been pressed since the last frame

public override bool IsPressed(InputManager manager)

Parameters

manager InputManager

The input manager

Returns

bool

IsReleased(InputManager)

Indicate if the button has been released since the last frame

public override bool IsReleased(InputManager manager)

Parameters

manager InputManager

The input manager

Returns

bool

WithId(int)

Return a pointer button for the given point Id.

public VirtualButton.Pointer WithId(int pointerId)

Parameters

pointerId int

the Id of the pointer

Returns

VirtualButton.Pointer

An pointer button for the given pointer Id.