/*===============================================================================
Copyright (c) 2015-2016,2018 PTC Inc. All Rights Reserved.

Copyright (c) 2010-2014 Qualcomm Connected Experiences, Inc. All Rights Reserved.

Vuforia is a trademark of PTC Inc., registered in the United States and other 
countries.

\file
    VirtualButton.h

\brief
    Header file for VirtualButton class.
===============================================================================*/

#ifndef _VUFORIA_VIRTUALBUTTON_H_
#define _VUFORIA_VIRTUALBUTTON_H_

// Include files
#include <Vuforia/NonCopyable.h>
#include <Vuforia/Vectors.h>

namespace Vuforia
{

// Forward declarations
class Area;

/// A virtual button on a Trackable.
/**
 *  Methods to modify a VirtualButton must not be called while the
 *  corresponding DataSet is active. The DataSet must be deactivated
 *  before reconfiguring a VirtualButton.
 */
class VUFORIA_API VirtualButton : private NonCopyable
{
public:

    /// Sensitivity of press detection.
    enum SENSITIVITY {
        HIGH,           ///< Fast detection
        MEDIUM,         ///< Balanced between fast and robust
        LOW             ///< Robust detection
    };

    /// Defines a new area for the button area in meters. The coordinate system is local to the ImageTarget.
    /**
     *  This method must not be called while the corresponding DataSet is
     *  active or it will return false.
     */
    virtual bool setArea(const Area& area) = 0;

    /// Returns the currently set Area.
    virtual const Area& getArea() const = 0;
    
    /// Sets the sensitivity of the virtual button.
    /**
     *  Sensitivity allows deciding between fast and robust button press
     *  measurements. This method must not be called while the corresponding
     *  DataSet is active or it will return false.
     */
    virtual bool setSensitivity(SENSITIVITY sensitivity) = 0;

    /// Enables or disables a virtual button.
    /**
     * This method must not be called while the corresponding DataSet is
     * active or it will return false.
     */
    virtual bool setEnabled(bool enabled) = 0;

    /// Returns true if the virtual button is active (updates while tracking).
    virtual bool isEnabled() const = 0;

    /// Returns the name of the button as ASCII string.
    virtual const char* getName() const = 0;

    /// Returns a unique id for this virtual button.
    virtual int getID() const = 0;

protected:

    virtual ~VirtualButton() {}
};

} // namespace Vuforia

#endif //_VUFORIA_VIRTUALBUTTON_H_