MouseButtonTrigger Class

Delta Engine Documentation

Allows mouse button presses to be tracked. View code on GitHub

Inheritance Hierarchy

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

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 MouseButtonTrigger : InputTrigger, 
	MovementTrigger, MouseTrigger

public class MouseButtonTrigger : InputTrigger, 
	MovementTrigger, MouseTrigger

Public Class MouseButtonTrigger 
	Inherits InputTrigger 
	Implements MovementTrigger, MouseTrigger

Public Class MouseButtonTrigger 
	Inherits InputTrigger 
	Implements MovementTrigger, MouseTrigger

public ref class MouseButtonTrigger : public InputTrigger, 
	MovementTrigger, MouseTrigger

public ref class MouseButtonTrigger : public InputTrigger, 
	MovementTrigger, MouseTrigger

type MouseButtonTrigger =  
    class 
        inherit InputTrigger 
        interface MovementTrigger 
        interface MouseTrigger 
    end

type MouseButtonTrigger =  
    class 
        inherit InputTrigger 
        interface MovementTrigger 
        interface MouseTrigger 
    end

The MouseButtonTrigger type exposes the following members.

Constructors

	Name	Description
	MouseButtonTrigger(Dictionary String, String )	Initializes a new instance of the MouseButtonTrigger class
	MouseButtonTrigger(State)	Initializes a new instance of the MouseButtonTrigger class
	MouseButtonTrigger(MouseButton, State)	Initializes a new instance of the MouseButtonTrigger 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.)
	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
	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.)
	State	View code on GitHub
	UpdatePriority	View code on GitHub (Inherited from Entity.)
	WasInvokedThisTick	(Inherited from Trigger.)

Top

Remarks

Tests: DeltaEngine.Input.Tests.MouseButtonTriggerTests

Examples

5 unit tests call DeltaEngine.Input.MouseButtonTrigger

Copy to Clipboard Print

[Test]
public void PressLeftMouseButtonToCloseWindow()
{
    new FontText(Font.Default, "Press Left Mouse Button to close window", Rectangle.One);
    new Command(() => Resolve<Window>().CloseAfterFrame()).Add(new MouseButtonTrigger());
}

[Test]
public void PressLeftMouseButtonToCloseWindow()
{
    new FontText(Font.Default, "Press Left Mouse Button to close window", Rectangle.One);
    new Command(() => Resolve<Window>().CloseAfterFrame()).Add(new MouseButtonTrigger());
}

Copy to Clipboard Print

[Test]
public void ClickAndHoldToShowRedEllipseAtMousePosition()
{
    var ellipse = new Ellipse(new Rectangle(-0.1f, -0.1f, 0.1f, 0.1f), Color.Red);
    new Command(position => ellipse.Center = position).Add(new MouseButtonTrigger(State.Pressed));
}

[Test]
public void ClickAndHoldToShowRedEllipseAtMousePosition()
{
    var ellipse = new Ellipse(new Rectangle(-0.1f, -0.1f, 0.1f, 0.1f), Color.Red);
    new Command(position => ellipse.Center = position).Add(new MouseButtonTrigger(State.Pressed));
}

Copy to Clipboard Print

[Test, CloseAfterFirstFrame]
public void Create()
{
    var trigger = new MouseButtonTrigger(MouseButton.Right, State.Pressed);
    Assert.AreEqual(MouseButton.Right, trigger.Button);
    Assert.AreEqual(State.Pressed, trigger.State);
    Assert.AreEqual(MouseButton.Left, new MouseButtonTrigger().Button);
    Assert.AreEqual(State.Pressing, new MouseButtonTrigger().State);
    Assert.AreEqual(MouseButton.Left, new MouseButtonTrigger(State.Pressed).Button);
    Assert.AreEqual(State.Pressed, new MouseButtonTrigger(State.Pressed).State);
}

[Test, CloseAfterFirstFrame]
public void Create()
{
    var trigger = new MouseButtonTrigger(MouseButton.Right, State.Pressed);
    Assert.AreEqual(MouseButton.Right, trigger.Button);
    Assert.AreEqual(State.Pressed, trigger.State);
    Assert.AreEqual(MouseButton.Left, new MouseButtonTrigger().Button);
    Assert.AreEqual(State.Pressing, new MouseButtonTrigger().State);
    Assert.AreEqual(MouseButton.Left, new MouseButtonTrigger(State.Pressed).Button);
    Assert.AreEqual(State.Pressed, new MouseButtonTrigger(State.Pressed).State);
}