Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    VirtualButton.Pointer Class

    Namespace: Stride.Input
    Assembly: Stride.Input.dll

    Mouse virtual button.

    System.Object → VirtualButton → VirtualButton.Pointer
    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.

    | Improve this Doc View Source

    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
    | Improve this Doc View Source

    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
    | Improve this Doc View Source

    Methods


    BuildButtonName()

    protected override string BuildButtonName()
    Returns
    Type Description
    System.String
    Overrides
    VirtualButton.BuildButtonName()

    GetValue(InputManager)

    public override float GetValue(InputManager manager)
    Parameters
    Type Name Description
    InputManager manager
    Returns
    Type Description
    System.Single
    Overrides
    VirtualButton.GetValue(InputManager)

    IsDown(InputManager)

    public override bool IsDown(InputManager manager)
    Parameters
    Type Name Description
    InputManager manager
    Returns
    Type Description
    System.Boolean
    Overrides
    VirtualButton.IsDown(InputManager)

    IsPressed(InputManager)

    public override bool IsPressed(InputManager manager)
    Parameters
    Type Name Description
    InputManager manager
    Returns
    Type Description
    System.Boolean
    Overrides
    VirtualButton.IsPressed(InputManager)

    IsReleased(InputManager)

    public override bool IsReleased(InputManager manager)
    Parameters
    Type Name Description
    InputManager manager
    Returns
    Type Description
    System.Boolean
    Overrides
    VirtualButton.IsReleased(InputManager)

    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.


    Inherited Members

    VirtualButton.Id
    VirtualButton.Name
    VirtualButton.ShortName
    VirtualButton.Type
    VirtualButton.IsPositiveAndNegative
    VirtualButton.Index
    VirtualButton.ToString()
    VirtualButton.Registered
    VirtualButton.Find(String)
    VirtualButton.Find(Int32)

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation