VirtualButton.Pointer Class
Namespace: Stride.InputAssembly: Stride.Input.dll
Mouse virtual button.
Derived from VirtualButton.Pointer:
public class Pointer : VirtualButton, IVirtualButton
| Name | Description | |
|---|---|---|
| Constructors | ||
| Pointer(String, Int32, Int32, Boolean) | ||
| Fields | ||
| DeltaX | The X component of the Pointer Delta. |
|
| DeltaY | The Y component of the Pointer Delta. |
|
| PointerId | The pad index. |
|
| PositionX | The X component of the Pointer Position. |
|
| PositionY | The Y component of the Pointer Position. |
|
| State | The current state of pointers. |
|
| Methods | ||
| BuildButtonName() | ||
| GetValue(InputManager) | ||
| IsDown(InputManager) | ||
| IsPressed(InputManager) | ||
| IsReleased(InputManager) | ||
| WithId(Int32) | Return a pointer button for the given point Id. |
|
Constructors
Pointer(String, Int32, Int32, Boolean)
protected Pointer(string name, int id, int pointerId, bool isPositiveAndNegative)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | |
| System.Int32 | id | |
| System.Int32 | pointerId | |
| System.Boolean | isPositiveAndNegative |
Fields
DeltaX
The X component of the Pointer Delta.
public static readonly VirtualButton.Pointer DeltaX
Field Value
| Type | Description |
|---|---|
| VirtualButton.Pointer |
DeltaY
The Y component of the Pointer Delta.
public static readonly VirtualButton.Pointer DeltaY
Field Value
| Type | Description |
|---|---|
| VirtualButton.Pointer |
PointerId
The pad index.
public readonly int PointerId
Field Value
| Type | Description |
|---|---|
| System.Int32 |
PositionX
The X component of the Pointer Position.
public static readonly VirtualButton.Pointer PositionX
Field Value
| Type | Description |
|---|---|
| VirtualButton.Pointer |
PositionY
The Y component of the Pointer Position.
public static readonly VirtualButton.Pointer PositionY
Field Value
| Type | Description |
|---|---|
| VirtualButton.Pointer |
State
The current state of pointers.
public static readonly VirtualButton.Pointer State
Field Value
| Type | Description |
|---|---|
| VirtualButton.Pointer |
Methods
BuildButtonName()
protected override string BuildButtonName()
Returns
| Type | Description |
|---|---|
| System.String |
Overrides
GetValue(InputManager)
public override float GetValue(InputManager manager)
Parameters
| Type | Name | Description |
|---|---|---|
| InputManager | manager |
Returns
| Type | Description |
|---|---|
| System.Single |
Overrides
IsDown(InputManager)
public override bool IsDown(InputManager manager)
Parameters
| Type | Name | Description |
|---|---|---|
| InputManager | manager |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
IsPressed(InputManager)
public override bool IsPressed(InputManager manager)
Parameters
| Type | Name | Description |
|---|---|---|
| InputManager | manager |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
IsReleased(InputManager)
public override bool IsReleased(InputManager manager)
Parameters
| Type | Name | Description |
|---|---|---|
| InputManager | manager |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
WithId(Int32)
Return a pointer button for the given point Id.
public VirtualButton.Pointer WithId(int pointerId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | pointerId | the Id of the pointer |
Returns
| Type | Description |
|---|---|
| VirtualButton.Pointer | An pointer button for the given pointer Id. |