Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    MouseSimulated Class

    Namespace: Stride.Input
    Assembly: Stride.Input.dll
    System.Object → PointerDeviceBase → MouseDeviceBase → MouseSimulated
    Derived from MouseSimulated:

    public class MouseSimulated : MouseDeviceBase, IMouseDevice, IPointerDevice, IInputDevice
    Name Description
    Constructors
    MouseSimulated(InputSourceSimulated)
    Properties
    Id
    IsPositionLocked
    MouseState
    Name
    PointerState
    Source
    Methods
    LockPosition(Boolean)
    SetPosition(Vector2)
    SimulateMouseDown(MouseButton)
    SimulateMouseUp(MouseButton)
    SimulateMouseWheel(Single)
    SimulatePointer(PointerEventType, Vector2, Int32)
    UnlockPosition()
    Update(List<InputEvent>)
    | Improve this Doc View Source

    Constructors


    MouseSimulated(InputSourceSimulated)

    public MouseSimulated(InputSourceSimulated source)
    Parameters
    Type Name Description
    InputSourceSimulated source
    | Improve this Doc View Source

    Properties


    Id

    public override Guid Id { get; }
    Property Value
    Type Description
    System.Guid
    Overrides
    PointerDeviceBase.Id

    IsPositionLocked

    public override bool IsPositionLocked { get; }
    Property Value
    Type Description
    System.Boolean
    Overrides
    MouseDeviceBase.IsPositionLocked

    MouseState

    public MouseDeviceState MouseState { get; }
    Property Value
    Type Description
    MouseDeviceState

    Name

    public override string Name { get; }
    Property Value
    Type Description
    System.String
    Overrides
    PointerDeviceBase.Name

    PointerState

    public PointerDeviceState PointerState { get; }
    Property Value
    Type Description
    PointerDeviceState

    Source

    public override IInputSource Source { get; }
    Property Value
    Type Description
    IInputSource
    Overrides
    PointerDeviceBase.Source
    | Improve this Doc View Source

    Methods


    LockPosition(Boolean)

    public override void LockPosition(bool forceCenter = false)
    Parameters
    Type Name Description
    System.Boolean forceCenter
    Overrides
    MouseDeviceBase.LockPosition(Boolean)

    SetPosition(Vector2)

    public override void SetPosition(Vector2 position)
    Parameters
    Type Name Description
    Vector2 position
    Overrides
    MouseDeviceBase.SetPosition(Vector2)

    SimulateMouseDown(MouseButton)

    public void SimulateMouseDown(MouseButton button)
    Parameters
    Type Name Description
    MouseButton button

    SimulateMouseUp(MouseButton)

    public void SimulateMouseUp(MouseButton button)
    Parameters
    Type Name Description
    MouseButton button

    SimulateMouseWheel(Single)

    public void SimulateMouseWheel(float wheelDelta)
    Parameters
    Type Name Description
    System.Single wheelDelta

    SimulatePointer(PointerEventType, Vector2, Int32)

    public void SimulatePointer(PointerEventType pointerEventType, Vector2 position, int id = 0)
    Parameters
    Type Name Description
    PointerEventType pointerEventType
    Vector2 position
    System.Int32 id

    UnlockPosition()

    public override void UnlockPosition()
    Overrides
    MouseDeviceBase.UnlockPosition()

    Update(List<InputEvent>)

    public override void Update(List<InputEvent> inputEvents)
    Parameters
    Type Name Description
    System.Collections.Generic.List<InputEvent> inputEvents
    Overrides
    MouseDeviceBase.Update(List<InputEvent>)

    Inherited Members

    MouseDeviceBase.PressedButtons
    MouseDeviceBase.ReleasedButtons
    MouseDeviceBase.DownButtons
    MouseDeviceBase.Position
    MouseDeviceBase.Delta
    PointerDeviceBase.SurfaceSize
    PointerDeviceBase.SurfaceAspectRatio
    PointerDeviceBase.PressedPointers
    PointerDeviceBase.ReleasedPointers
    PointerDeviceBase.DownPointers
    PointerDeviceBase.SurfaceSizeChanged
    PointerDeviceBase.Priority
    PointerDeviceBase.SetSurfaceSize(Vector2)
    PointerDeviceBase.Normalize(Vector2)

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    MouseDeviceExtensions.IsButtonPressed(IMouseDevice, MouseButton)
    MouseDeviceExtensions.IsButtonReleased(IMouseDevice, MouseButton)
    MouseDeviceExtensions.IsButtonDown(IMouseDevice, MouseButton)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

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