VirtualButtonTwoWay.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
namespace SiliconStudio.Paradox.Input
{
    /// <summary>
    /// Describes a <see cref="IVirtualButton"/> using the sum of a negative and positive button.
    /// </summary>
    /// <remarks>
    /// This virtual button is for example useful to bind a key to a negative value (key 'left') 
    /// and another key to a positive value (key 'right') thus simulating an axis button.
    /// The result of this virtual 
    /// <code>Result = PositiveButton.GetValue - NegativeButton.GetValue;</code>
    /// </remarks>
    public class VirtualButtonTwoWay : IVirtualButton
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="VirtualButtonTwoWay" /> class.
        /// </summary>
        public VirtualButtonTwoWay() : this(new VirtualButtonGroup(), new VirtualButtonGroup())
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="VirtualButtonTwoWay" /> class.
        /// </summary>
        /// <param name="negativeButton">The negative button.</param>
        /// <param name="positiveButton">The positive button.</param>
        public VirtualButtonTwoWay(IVirtualButton negativeButton, IVirtualButton positiveButton)
        {
            NegativeButton = negativeButton;
            PositiveButton = positiveButton;
        }

        /// <summary>
        /// Gets or sets the negative button that will generate a 'negative' value if it is pressed.
        /// </summary>
        /// <value>The negative button.</value>
        public IVirtualButton NegativeButton { get; set; }

        /// <summary>
        /// Gets or sets the positive button that will generate a 'positive' value if it is pressed.
        /// </summary>
        /// <value>The positive button.</value>
        public IVirtualButton PositiveButton { get; set; }

        public virtual float GetValue(InputManagerBase manager)
        {
            float negativeValue = ((NegativeButton != null) ? NegativeButton.GetValue(manager) : 0.0f);
            float positiveValue = (PositiveButton != null) ? PositiveButton.GetValue(manager) : 0.0f;
            return positiveValue - negativeValue;
        }

        public override string ToString()
        {
            return string.Format("<{0} , {1}>", NegativeButton, PositiveButton);
        }
    }
}