MouseHoldTrigger Class

Delta Engine Documentation

Fires once when the mouse button is pressed and the mouse has not moved for some time. View code on GitHub

Inheritance Hierarchy

System Object
  DeltaEngine.Entities Entity
    DeltaEngine.Commands Trigger
      DeltaEngine.Commands InputTrigger
        DeltaEngine.Input MouseHoldTrigger

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

Syntax

C++

Copy to Clipboard Print

public class MouseHoldTrigger : InputTrigger, 
	MovementTrigger, MouseTrigger

public class MouseHoldTrigger : InputTrigger, 
	MovementTrigger, MouseTrigger

Public Class MouseHoldTrigger 
	Inherits InputTrigger 
	Implements MovementTrigger, MouseTrigger

Public Class MouseHoldTrigger 
	Inherits InputTrigger 
	Implements MovementTrigger, MouseTrigger

public ref class MouseHoldTrigger : public InputTrigger, 
	MovementTrigger, MouseTrigger

public ref class MouseHoldTrigger : public InputTrigger, 
	MovementTrigger, MouseTrigger

type MouseHoldTrigger =  
    class 
        inherit InputTrigger 
        interface MovementTrigger 
        interface MouseTrigger 
    end

type MouseHoldTrigger =  
    class 
        inherit InputTrigger 
        interface MovementTrigger 
        interface MouseTrigger 
    end

The MouseHoldTrigger type exposes the following members.

Constructors

	Name	Description
	MouseHoldTrigger(Dictionary String, String )	Initializes a new instance of the MouseHoldTrigger class
	MouseHoldTrigger(Rectangle, Single, MouseButton)	Initializes a new instance of the MouseHoldTrigger class

Top

Methods

	Name	Description
	Add T	(Inherited from Entity.)
	AddTag	View code on GitHub (Inherited from Entity.)
	ClearTags	View code on GitHub (Inherited from Entity.)
	Contains T	(Inherited from Entity.)
	ContainsBehavior T	(Inherited from Entity.)
	ContainsTag	View code on GitHub (Inherited from Entity.)
	Deactivate	(Inherited from Entity.)
	Dispose	View code on GitHub (Inherited from Entity.)
	Get T	Gets a specific component, derived classes can return faster cached values (e.g. Entity2D) View code on GitHub (Inherited from Entity.)
	GetActiveBehaviors	(Inherited from Entity.)
	GetComponentsForSaving	(Inherited from Entity.)
	GetOrDefault T	(Inherited from Entity.)
	GetTags	View code on GitHub (Inherited from Entity.)
	HandleWithMouse
	Invoke	View code on GitHub (Inherited from Trigger.)
	IsHovering	View code on GitHub
	Remove T	(Inherited from Entity.)
	RemoveTag	View code on GitHub (Inherited from Entity.)
	Set	View code on GitHub (Inherited from Entity.)
	SetComponents	(Inherited from Entity.)
	Start T	(Inherited from Entity.)
	StartInputDevice	(Overrides InputTrigger StartInputDevice .)
	Stop T	(Inherited from Entity.)
	ToString	View code on GitHub (Inherited from Entity.)
	Update	View code on GitHub (Inherited from Trigger.)

Top

Fields

	Name	Description
	components	(Inherited from Entity.)
	Invoked	(Inherited from Trigger.)

Top

Properties

	Name	Description
	Button	View code on GitHub
	HoldArea	View code on GitHub
	HoldTime	View code on GitHub
	IsActive	View code on GitHub (Inherited from Entity.)
	IsPauseable	View code on GitHub (Inherited from Trigger.)
	Movement
	NumberOfComponents	View code on GitHub (Inherited from Entity.)
	UpdatePriority	View code on GitHub (Inherited from Entity.)
	WasInvokedThisTick	(Inherited from Trigger.)

Top

Remarks

Tests: DeltaEngine.Input.Tests.MouseHoldTriggerTests

Examples

7 unit tests call DeltaEngine.Input.MouseHoldTrigger

Copy to Clipboard Print

[Test]
public void HoldLeftClickOnRectangle()
{
    var drawArea = new Rectangle(0.25f, 0.25f, 0.5f, 0.25f);
    new FilledRect(drawArea, Color.Blue);
    var trigger = new MouseHoldTrigger(drawArea);
    var counter = 0;
    var text = new FontText(Font.Default, "", drawArea.Move(new Vector2D(0.0f, 0.25f)));
    new Command(() => text.Text = "MouseHold Triggered " + ++counter + " times.").Add(trigger);
}

[Test]
public void HoldLeftClickOnRectangle()
{
    var drawArea = new Rectangle(0.25f, 0.25f, 0.5f, 0.25f);
    new FilledRect(drawArea, Color.Blue);
    var trigger = new MouseHoldTrigger(drawArea);
    var counter = 0;
    var text = new FontText(Font.Default, "", drawArea.Move(new Vector2D(0.0f, 0.25f)));
    new Command(() => text.Text = "MouseHold Triggered " + ++counter + " times.").Add(trigger);
}

Copy to Clipboard Print

[Test, CloseAfterFirstFrame]
public void Create()
{
    var trigger = new MouseHoldTrigger(Rectangle.One, 0.5f, MouseButton.Right);
    Assert.AreEqual(Rectangle.One, trigger.HoldArea);
    Assert.AreEqual(0.5f, trigger.HoldTime);
    Assert.AreEqual(MouseButton.Right, trigger.Button);
}

[Test, CloseAfterFirstFrame]
public void Create()
{
    var trigger = new MouseHoldTrigger(Rectangle.One, 0.5f, MouseButton.Right);
    Assert.AreEqual(Rectangle.One, trigger.HoldArea);
    Assert.AreEqual(0.5f, trigger.HoldTime);
    Assert.AreEqual(MouseButton.Right, trigger.Button);
}

Copy to Clipboard Print

    [Test, CloseAfterFirstFrame]
    public void CreateFromAttributes()
    {
        var trigger = new MouseHoldTrigger(new Dictionary<string, string>
            {
                { "HoldArea", "1 2 3 4" },
                { "HoldTime", "5.5" },
                { "Button", "Right" }
            });
        Assert.AreEqual(new Rectangle(1, 2, 3, 4), trigger.HoldArea);
        Assert.AreEqual(5.5f, trigger.HoldTime);
        Assert.AreEqual(MouseButton.Right, trigger.Button);
        Assert.Throws<MouseHoldTrigger.CannotCreateMouseHoldTriggerWithoutHoldArea>(
            () => new MouseHoldTrigger(new Dictionary<string, string>()));
    }

    [Test, CloseAfterFirstFrame]
    public void HoldMouseOutsideHoldArea()
    {
        if (mouse == null)
            return; //ncrunch: no coverage
        Vector2D mousePosition = -Vector2D.One;
        new Command(position => { mousePosition = position; }).Add(
            new MouseHoldTrigger(Rectangle.HalfCentered));
        SetMouseState(State.Pressing, Vector2D.Zero);
        SetMouseState(State.Pressed, Vector2D.Zero);
        AdvanceTimeAndUpdateEntities(1.05f);
        Assert.AreEqual(-Vector2D.One, mousePosition);
    }

    private void SetMouseState(State state, Vector2D position)
    {
        if (mouse == null)
            return; //ncrunch: no coverage
        mouse.SetNativePosition(position);
        mouse.SetButtonState(MouseButton.Left, state);
        AdvanceTimeAndUpdateEntities();
    }

    [Test, CloseAfterFirstFrame]
    public void HoldMouseHovering()
    {
        var drawArea = new Rectangle(0.25f, 0.25f, 0.5f, 0.25f);
        var rect = new FilledRect(drawArea, Color.Blue);
        var trigger = new MouseHoldTrigger(drawArea);
        trigger.Invoked += () => rect.Color = Color.Red;
        trigger.Movement = new Vector2D(0.3f, 0.3f);
        Assert.IsFalse(trigger.IsHovering());
        AdvanceTimeAndUpdateEntities(1.05f);
        Assert.IsFalse(trigger.IsHovering());
    }

    [Test, CloseAfterFirstFrame]
    public void MoveMouseInsideHoldArea()
    {
        if (mouse == null)
            return; //ncrunch: no coverage
        Vector2D mousePosition = -Vector2D.One;
        new Command(position => { mousePosition = position; }).Add(
            new MouseHoldTrigger(Rectangle.HalfCentered));
        SetMouseState(State.Pressing, Vector2D.Half);
        SetMouseState(State.Pressed, Vector2D.Half);
        AdvanceTimeAndUpdateEntities(0.5f);
        SetMouseState(State.Pressed, new Vector2D(0.6f, 0.6f));
        AdvanceTimeAndUpdateEntities(0.5f);
        Assert.AreEqual(Vector2D.Half, mousePosition);
    }

    //ncrunch: no coverage start
    [Test, CloseAfterFirstFrame, Category("Slow")]
    public void HoldMouseInsideHoldArea()
    {
        if (mouse == null)
            return; //ncrunch: no coverage
        Vector2D mousePosition = -Vector2D.One;
        new Command(position => { mousePosition = position; }).Add(
            new MouseHoldTrigger(Rectangle.HalfCentered));
        SetMouseState(State.Pressing, Vector2D.Half);
        SetMouseState(State.Pressed, Vector2D.Half);
        AdvanceTimeAndUpdateEntities(1.05f);
        Assert.AreEqual(Vector2D.Half, mousePosition);
    }
}

    [Test, CloseAfterFirstFrame]
    public void CreateFromAttributes()
    {
        var trigger = new MouseHoldTrigger(new Dictionary<string, string>
            {
                { "HoldArea", "1 2 3 4" },
                { "HoldTime", "5.5" },
                { "Button", "Right" }
            });
        Assert.AreEqual(new Rectangle(1, 2, 3, 4), trigger.HoldArea);
        Assert.AreEqual(5.5f, trigger.HoldTime);
        Assert.AreEqual(MouseButton.Right, trigger.Button);
        Assert.Throws<MouseHoldTrigger.CannotCreateMouseHoldTriggerWithoutHoldArea>(
            () => new MouseHoldTrigger(new Dictionary<string, string>()));
    }

    [Test, CloseAfterFirstFrame]
    public void HoldMouseOutsideHoldArea()
    {
        if (mouse == null)
            return; //ncrunch: no coverage
        Vector2D mousePosition = -Vector2D.One;
        new Command(position => { mousePosition = position; }).Add(
            new MouseHoldTrigger(Rectangle.HalfCentered));
        SetMouseState(State.Pressing, Vector2D.Zero);
        SetMouseState(State.Pressed, Vector2D.Zero);
        AdvanceTimeAndUpdateEntities(1.05f);
        Assert.AreEqual(-Vector2D.One, mousePosition);
    }

    private void SetMouseState(State state, Vector2D position)
    {
        if (mouse == null)
            return; //ncrunch: no coverage
        mouse.SetNativePosition(position);
        mouse.SetButtonState(MouseButton.Left, state);
        AdvanceTimeAndUpdateEntities();
    }

    [Test, CloseAfterFirstFrame]
    public void HoldMouseHovering()
    {
        var drawArea = new Rectangle(0.25f, 0.25f, 0.5f, 0.25f);
        var rect = new FilledRect(drawArea, Color.Blue);
        var trigger = new MouseHoldTrigger(drawArea);
        trigger.Invoked += () => rect.Color = Color.Red;
        trigger.Movement = new Vector2D(0.3f, 0.3f);
        Assert.IsFalse(trigger.IsHovering());
        AdvanceTimeAndUpdateEntities(1.05f);
        Assert.IsFalse(trigger.IsHovering());
    }

    [Test, CloseAfterFirstFrame]
    public void MoveMouseInsideHoldArea()
    {
        if (mouse == null)
            return; //ncrunch: no coverage
        Vector2D mousePosition = -Vector2D.One;
        new Command(position => { mousePosition = position; }).Add(
            new MouseHoldTrigger(Rectangle.HalfCentered));
        SetMouseState(State.Pressing, Vector2D.Half);
        SetMouseState(State.Pressed, Vector2D.Half);
        AdvanceTimeAndUpdateEntities(0.5f);
        SetMouseState(State.Pressed, new Vector2D(0.6f, 0.6f));
        AdvanceTimeAndUpdateEntities(0.5f);
        Assert.AreEqual(Vector2D.Half, mousePosition);
    }

    //ncrunch: no coverage start
    [Test, CloseAfterFirstFrame, Category("Slow")]
    public void HoldMouseInsideHoldArea()
    {
        if (mouse == null)
            return; //ncrunch: no coverage
        Vector2D mousePosition = -Vector2D.One;
        new Command(position => { mousePosition = position; }).Add(
            new MouseHoldTrigger(Rectangle.HalfCentered));
        SetMouseState(State.Pressing, Vector2D.Half);
        SetMouseState(State.Pressed, Vector2D.Half);
        AdvanceTimeAndUpdateEntities(1.05f);
        Assert.AreEqual(Vector2D.Half, mousePosition);
    }
}