/*
* Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
*
* All rights reserved.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3.0 only,
* as published by the Free Software Foundation.
*
* This program 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
* version 3.0 for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* version 3.0 along with this program. If not, see
* <https://www.gnu.org/licenses/>.
*/
#ifdef OBJFWHID_LOCAL_INCLUDES
# import "OFObject.h"
# import "OFString.h"
#else
# if defined(__has_feature) && __has_feature(modules)
@import ObjFW;
# else
# import <ObjFW/OFObject.h>
# import <ObjFW/OFString.h>
# endif
#endif
OF_ASSUME_NONNULL_BEGIN
@class HIDGameControllerAxis;
@class HIDGameControllerButton;
@class OFArray OF_GENERIC(ObjectType);
@class OFDictionary OF_GENERIC(KeyType, ObjectType);
@class OFNumber;
/**
* @brief A class for reading state from a game controller.
*/
@interface HIDGameController: OFObject
#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nonatomic)
OFArray <HIDGameController *> *controllers;
#endif
/**
* @brief The name of the controller.
*/
@property (readonly, nonatomic, copy) OFString *name;
/**
* @brief The vendor ID of the controller or `nil` if unavailable.
*/
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFNumber *vendorID;
/**
* @brief The product ID of the controller or `nil` if unavailable.
*/
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFNumber *productID;
/**
* @brief A map of all button names to their @ref HIDGameControllerButton.
*/
@property (readonly, nonatomic)
OFDictionary OF_GENERIC(OFString *, HIDGameControllerButton *) *buttons;
/**
* @brief A map of all axis names to their @ref HIDGameControllerAxis.
*/
@property (readonly, nonatomic)
OFDictionary OF_GENERIC(OFString *, HIDGameControllerAxis *) *axes;
/**
* @brief Returns the available controllers.
*
* @return The available controllers
*/
+ (OFArray OF_GENERIC(HIDGameController *) *)controllers;
/**
* @brief Retrieves the current state from the game controller.
*
* The state returned by @ref HIDGameController's methods does not change until
* this method is called.
*
* @throw OFReadFailedException The controller's state could not be read
*/
- (void)retrieveState;
@end
OF_ASSUME_NONNULL_END