Gateware Libraries  R6.5A
Beta Build
GW::SYSTEM::GController Class Referenceabstract

A multi-threaded controller input library. More...

#include <GController.h>

Inheritance diagram for GW::SYSTEM::GController:
Collaboration diagram for GW::SYSTEM::GController:

Public Member Functions

virtual GReturn GetState (int _controllerIndex, int _inputCode, float &_outState)=0
 Used to poll the current state of a button or axis on a controller.
 
virtual GReturn IsConnected (int _controllerIndex, bool &_outIsConnected)=0
 Used to check if a controller is connected at a specified index.
 
virtual GReturn GetMaxIndex (int &_outMax)=0
 Outputs the max index of the array of controllers.
 
virtual GReturn GetNumConnected (int &_outConnectedCount)=0
 Outputs the number of controllers connected.
 
virtual GReturn SetDeadZone (GControllerDeadzoneTypes _type, float _deadzonePercentage)=0
 Set how the stick deadzones should be calculated.
 
virtual GReturn StartVibration (float _pan, float _duration, float _strength, unsigned int _controllerIndex)=0
 Start vibration in selected controller.
 
virtual GReturn IsVibrating (unsigned int _controllerIndex, bool &_outIsVibrating)=0
 Used to check if a controller is currently vibrating.
 
virtual GReturn StopVirbration (unsigned int _controllerIndex)=0
 Used to stop a controller from vibrating.
 
virtual GReturn StopAllVirbrations ()=0
 Stops all currently vibrating controllers.
 
- Public Member Functions inherited from GW::CORE::GBroadcasting
virtual GReturn RegisterListener (GListener *_addListener, unsigned long long _eventMask)=0
 Any listener added to this class must receive all events unless otherwise specified by the _eventMask (optional). More...
 
virtual GReturn DeregisterListener (GListener *_removeListener)=0
 A successfully deregistered listener will no longer receive events and have its reference count decremented by one. More...
 
- Public Member Functions inherited from GW::CORE::GInterface
virtual GReturn GetCount (unsigned int &_outCount)=0
 Return the total number of active references to this object. More...
 
virtual GReturn IncrementCount ()=0
 Increase the total number of active references to this object. More...
 
virtual GReturn DecrementCount ()=0
 Decrease the total number of active references to this object. More...
 
virtual GReturn RequestInterface (const GUUIID &_interfaceID, void **_outputInterface)=0
 Requests an interface that may or may not be supported by this object. More...
 

Detailed Description

A multi-threaded controller input library.

This library can be used to poll the current state of connected controllers. The controllers are assigned indices in a array for the lifetime that they are connected. It also provides events for controller connections and disconnections, which a GListener can be writen to receive.


The documentation for this class was generated from the following file: