InputEventMouseMotion

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.InputEventMouseMotion
Namespace	Electron2D
Kind	class
Category	Input

Overview

Represents a mouse movement event.

Syntax

public class Electron2D.InputEventMouseMotion : Electron2D.InputEventMouse

Remarks

Platform relative motion fills Electron2D.InputEventMouseMotion.Relative and Electron2D.InputEventMouseMotion.ScreenRelative. Velocity values remain zero until frame timing is connected to the input pump.

Instances are mutable and are not synchronized; use them from the input dispatch thread that owns the event.

Thread Safety

Instances of this type are not synchronized. Access them from the thread that owns the object unless the member documentation states otherwise.

Since

This class is available since Electron2D 0.1.0 Preview.

Members

Member	Kind	Summary
PenInverted	Property	Gets or sets whether the eraser end of a stylus pen is active.
Pressure	Property	Gets or sets the pen pressure from 0.0 to 1.0.
Relative	Property	Gets or sets the mouse position relative to the previous mouse position.
ScreenRelative	Property	Gets or sets the unscaled mouse position relative to the previous mouse position.
ScreenVelocity	Property	Gets or sets the unscaled mouse velocity in pixels per second.
Tilt	Property	Gets or sets the pen tilt.
Velocity	Property	Gets or sets the mouse velocity in pixels per second.
Electron2D.InputEventMouseMotion()	Constructor	Initializes a new instance of the InputEventMouseMotion type.

Member Details

PenInverted

Kind: Property

public System.Boolean PenInverted { get; set; }

Summary

Gets or sets whether the eraser end of a stylus pen is active.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current pen inverted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseMotion

Pressure

Kind: Property

public System.Single Pressure { get; set; }

Summary

Gets or sets the pen pressure from 0.0 to 1.0.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current pressure value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseMotion

Relative

Kind: Property

public Electron2D.Vector2 Relative { get; set; }

Summary

Gets or sets the mouse position relative to the previous mouse position.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current relative value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseMotion

ScreenRelative

Kind: Property

public Electron2D.Vector2 ScreenRelative { get; set; }

Summary

Gets or sets the unscaled mouse position relative to the previous mouse position.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current screen relative value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseMotion

ScreenVelocity

Kind: Property

public Electron2D.Vector2 ScreenVelocity { get; set; }

Summary

Gets or sets the unscaled mouse velocity in pixels per second.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current screen velocity value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseMotion

Tilt

Kind: Property

public Electron2D.Vector2 Tilt { get; set; }

Summary

Gets or sets the pen tilt.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current tilt value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseMotion

Velocity

Kind: Property

public Electron2D.Vector2 Velocity { get; set; }

Summary

Gets or sets the mouse velocity in pixels per second.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current velocity value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseMotion

Electron2D.InputEventMouseMotion()

Kind: Constructor

public Electron2D.InputEventMouseMotion()

Summary

Initializes a new instance of the InputEventMouseMotion type.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseMotion