MouseMovementTrigger ClassDelta Engine Documentation
Tracks any mouse movement, useful to update cursor positions or check hover states. View code on GitHub
Inheritance Hierarchy

System Object
  DeltaEngine.Entities Entity
    DeltaEngine.Commands Trigger
      DeltaEngine.Commands InputTrigger
        DeltaEngine.Commands DragTrigger
          DeltaEngine.Input MouseMovementTrigger

Namespace: DeltaEngine.Input
Assembly: DeltaEngine.Input (in DeltaEngine.Input.dll) Version: 1.1.1.0 (1.1.1)
Syntax

public class MouseMovementTrigger : DragTrigger, 
	MouseTrigger

The MouseMovementTrigger type exposes the following members.

Constructors

  NameDescription
Public methodMouseMovementTrigger 
Initializes a new instance of the MouseMovementTrigger class
Public methodMouseMovementTrigger(Dictionary String, String )
Initializes a new instance of the MouseMovementTrigger class
Top
Methods

  NameDescription
Public methodAdd T  (Inherited from Entity.)
Public methodAddTag (Inherited from Entity.)
Public methodClearTags (Inherited from Entity.)
Public methodContains T  (Inherited from Entity.)
Public methodContainsBehavior T  (Inherited from Entity.)
Public methodContainsTag (Inherited from Entity.)
Protected methodDeactivate (Inherited from Entity.)
Public methodDispose (Inherited from Entity.)
Public methodGet T 
Gets a specific component, derived classes can return faster cached values (e.g. Entity2D) View code on GitHub
(Inherited from Entity.)
Protected methodGetActiveBehaviors (Inherited from Entity.)
Protected methodGetComponentsForSaving (Inherited from Entity.)
Public methodGetOrDefault T  (Inherited from Entity.)
Public methodGetTags (Inherited from Entity.)
Public methodHandleWithMouse
Public methodInvoke (Inherited from Trigger.)
Protected methodIsDragDirectionCorrect (Inherited from DragTrigger.)
Public methodRemove T  (Inherited from Entity.)
Public methodRemoveTag (Inherited from Entity.)
Public methodSet (Inherited from Entity.)
Public methodSetComponents (Inherited from Entity.)
Public methodStart T  (Inherited from Entity.)
Protected methodStartInputDevice (Overrides InputTrigger StartInputDevice .)
Public methodStop T  (Inherited from Entity.)
Public methodToString (Inherited from Entity.)
Public methodUpdate (Inherited from Trigger.)
Top
Fields

  NameDescription
Protected fieldcomponents (Inherited from Entity.)
Public fieldInvoked (Inherited from Trigger.)
Top
Properties

  NameDescription
Public propertyDirection (Inherited from DragTrigger.)
Public propertyDoneDragging (Inherited from DragTrigger.)
Public propertyIsActive (Inherited from Entity.)
Public propertyIsPauseable (Inherited from Trigger.)
Public propertyMovement (Inherited from DragTrigger.)
Public propertyNumberOfComponents (Inherited from Entity.)
Public propertyStartPosition (Inherited from DragTrigger.)
Public propertyUpdatePriority (Inherited from Entity.)
Public propertyWasInvokedThisTick (Inherited from Trigger.)
Top
Remarks

Tests: DeltaEngine.Input.Tests.MouseMovementTriggerTests
Examples

4 unit tests call DeltaEngine.Input.MouseMovementTrigger
[Test]
public void MoveMouseToUpdatePositionOfCircle()
{
    var ellipse = new Ellipse(new Rectangle(-0.1f, -0.1f, 0.1f, 0.1f), Color.Red);
    new Command(pos => ellipse.Center = pos).Add(new MouseMovementTrigger());
}
[Test, CloseAfterFirstFrame]
public void UpdatePosition()
{
    Vector2D position = Vector2D.Zero;
    new Command(pos => position = pos).Add(new MouseMovementTrigger());
    Assert.AreEqual(Vector2D.Zero, position);
    var mockMouse = Resolve<Mouse>() as MockMouse;
    if (mockMouse == null)
        return; //ncrunch: no coverage
    mockMouse.SetNativePosition(new Vector2D(0.4f, 0.6f));
    AdvanceTimeAndUpdateEntities();
    Assert.AreEqual(new Vector2D(0.4f, 0.6f), position);
}
[Test, CloseAfterFirstFrame]
public void Create()
{
    var trigger = new MouseMovementTrigger();
    Assert.AreEqual(Vector2D.Zero, trigger.Movement);
    Assert.IsFalse(trigger.IsPauseable);
}
See Also