Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    VirtualButton.Mouse Class

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

    Mouse virtual button.

    System.Object → VirtualButton → VirtualButton.Mouse
    Derived from VirtualButton.Mouse:

    public class Mouse : VirtualButton, IVirtualButton
    Name Description
    Constructors
    Mouse(String, Int32, Boolean)
    Fields
    DeltaX

    Equivalent to X Axis delta of MousePosition.

    DeltaY

    Equivalent to Y Axis delta of MousePosition.

    Extended1

    Equivalent to Extended1.

    Extended2

    Equivalent to Extended2.

    Left

    Equivalent to Left.

    Middle

    Equivalent to Middle.

    PositionX

    Equivalent to X Axis of MousePosition.

    PositionY

    Equivalent to Y Axis of MousePosition.

    Right

    Equivalent to Right.

    Methods
    GetValue(InputManager)
    IsDown(InputManager)
    IsPressed(InputManager)
    IsReleased(InputManager)
    | Improve this Doc View Source

    Constructors


    Mouse(String, Int32, Boolean)

    protected Mouse(string name, int id, bool isPositiveAndNegative)
    Parameters
    Type Name Description
    System.String name
    System.Int32 id
    System.Boolean isPositiveAndNegative
    | Improve this Doc View Source

    Fields


    DeltaX

    Equivalent to X Axis delta of MousePosition.

    public static readonly VirtualButton.Mouse DeltaX
    Field Value
    Type Description
    VirtualButton.Mouse

    DeltaY

    Equivalent to Y Axis delta of MousePosition.

    public static readonly VirtualButton.Mouse DeltaY
    Field Value
    Type Description
    VirtualButton.Mouse

    Extended1

    Equivalent to Extended1.

    public static readonly VirtualButton.Mouse Extended1
    Field Value
    Type Description
    VirtualButton.Mouse

    Extended2

    Equivalent to Extended2.

    public static readonly VirtualButton.Mouse Extended2
    Field Value
    Type Description
    VirtualButton.Mouse

    Left

    Equivalent to Left.

    public static readonly VirtualButton.Mouse Left
    Field Value
    Type Description
    VirtualButton.Mouse

    Middle

    Equivalent to Middle.

    public static readonly VirtualButton.Mouse Middle
    Field Value
    Type Description
    VirtualButton.Mouse

    PositionX

    Equivalent to X Axis of MousePosition.

    public static readonly VirtualButton.Mouse PositionX
    Field Value
    Type Description
    VirtualButton.Mouse

    PositionY

    Equivalent to Y Axis of MousePosition.

    public static readonly VirtualButton.Mouse PositionY
    Field Value
    Type Description
    VirtualButton.Mouse

    Right

    Equivalent to Right.

    public static readonly VirtualButton.Mouse Right
    Field Value
    Type Description
    VirtualButton.Mouse
    | Improve this Doc View Source

    Methods


    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)

    Inherited Members

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

    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