Device.h

Go to the documentation of this file.

/*********************************************************\
 *  File: Device.h                                       *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLINPUT_DEVICE_H__
#define __PLINPUT_DEVICE_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLInput/Input/Controller.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLInput {


//[-------------------------------------------------------]
//[ Forward declarations                                  ]
//[-------------------------------------------------------]
class DeviceImpl;


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Input device
*
*  @remarks
*    A device is a controller that represents a real input device rather than a virtual controller.
*/
class Device : public Controller {


    //[-------------------------------------------------------]
    //[ Class definition                                      ]
    //[-------------------------------------------------------]
    pl_class(PLINPUT_RTTI_EXPORT, Device, "PLInput", PLInput::Controller, "Real input device")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Friends                                               ]
    //[-------------------------------------------------------]
    friend class DeviceImpl;


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] sName
        *    Controller name
        *  @param[in] sDescription
        *    Controller description
        *  @param[in] pImpl
        *    System specific device implementation, can, but shouldn't be a null pointer
        */
        PLINPUT_API Device(const PLCore::String &sName, const PLCore::String &sDescription, DeviceImpl *pImpl);

        /**
        *  @brief
        *    Destructor
        */
        PLINPUT_API virtual ~Device();

        /**
        *  @brief
        *    Get device implementation
        *
        *  @return
        *    System specific device implementation, can be a null pointer
        */
        PLINPUT_API DeviceImpl *GetImpl() const;


    //[-------------------------------------------------------]
    //[ Protected data                                        ]
    //[-------------------------------------------------------]
    protected:
        DeviceImpl *m_pImpl;        /**< System specific device implementation, can be a null pointer */
        bool        m_bDeleteImpl;  /**< Destroy device implementation automatically? */


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLInput


#endif // __PLINPUT_DEVICE_H__