TInputDevice Class Reference

#include <TInputInterface.h>

Inheritance diagram for TInputDevice:

Classes
struct	DoodadProperties
struct	RepeatInfo

Public Types
using	EventEmitter = TInputInterface::EventEmitter
using	Doodad = TINT
Public Types inherited from TObject
enum	{ IsTObject = TTRUE }

Public Member Functions
	TDECLARE_CLASS (TInputDevice, TObject)
	TInputDevice ()
	~TInputDevice ()=default
virtual TBOOL	Acquire ()=0
virtual TBOOL	Unacquire ()=0
virtual void	Release ()=0
virtual void	Update (TFLOAT deltaTime)=0
virtual TBOOL	Flush ()
virtual TINT	ProcessEvents (EventEmitter &emitter, TFLOAT deltaTime)=0
virtual TINT	GetButtonCount () const =0
virtual TINT	GetAxisCount () const =0
virtual TBOOL	GetDoodadProperties (Doodad a_iDoodad, DoodadProperties &a_rProperties) const =0
virtual TBOOL	StartRepeat (Doodad a_iDoodad, TFLOAT a_fFirstRepeatTime, TFLOAT a_fRepeatTime)
virtual void	StopRepeat (Doodad a_iDoodad)
virtual void	StopAllRepeats ()
virtual TBOOL	IsForceFeedbackDevice ()
virtual const TCHAR *	GetButtonFromDoodad (Doodad a_iDoodad) const =0
virtual TBOOL	IsDown (Doodad a_iDoodad) const =0
virtual TINT	GetAxisInt (Doodad a_iDoodad, TINT axis) const =0
virtual TINT	GetAxisInt2 (Doodad a_iDoodad, TINT axis) const
virtual TFLOAT	GetAxisFloat (Doodad a_iDoodad, TINT axis) const =0
virtual TFLOAT	GetAxisFloat2 (Doodad a_iDoodad, TINT axis) const
virtual TBOOL	IsEnabled () const =0
virtual void	ThrowRepeatEvent (EventEmitter &emitter, RepeatInfo *repeatInfo, TFLOAT deltaTime)
TBOOL	IsAcquired () const
void	SetAcquired (TBOOL a_bAcquired)
TInputInterface *	GetInputInterface ()
void	SetInputInterface (TInputInterface *a_pInterface)
Public Member Functions inherited from TObject
virtual Toshi::TClass *	GetClass ()
virtual void	Delete ()
virtual	~TObject ()
TBOOL	IsExactly (TClass *a_pClass)
TBOOL	IsA (TClass *a_pClass)
Public Member Functions inherited from TNodeList< T >::TNode
constexpr	TNode ()
constexpr	TNode (const TNode &a_rcNode)
	TNode (TNode &&a_rNode)
T *	Next () const
T *	Prev () const
void	Remove ()
void	SetList (TNodeList *list)
TNodeList *	GetList () const
TBOOL	IsLinked () const

Static Public Member Functions
static TInputDevice **	GetRegisteredDevices ()
static TUINT	GetNumRegisteredDevices ()
Static Public Member Functions inherited from TObject
static Toshi::TObject *	CreateTObject ()
static Toshi::TObject *	CreateTObjectInPlace (void *a_pPtr)
static void	InitialiseClass ()
static void	DeinitialiseClass ()
static TFORCEINLINE TClass *	GetClassStatic ()

Static Public Attributes
static constexpr TINT	INPUT_DEVICE_MOUSE_BUTTONS = 3
static constexpr TINT	INPUT_DEVICE_MOUSE_WHEEL = 4
Static Public Attributes inherited from TObject
static constexpr Toshi::TClass *	PARENTCLASS = TNULL
static constinit Toshi::TClass	ms_oClass = Toshi::TClass( "TObject", TObject::CreateTObject, TObject::CreateTObjectInPlace, TObject::InitialiseClass, TObject::DeinitialiseClass, 0, 2, sizeof( TObject ), alignof( TObject ) )

Protected Member Functions
TINT	ProcessRepeats (EventEmitter &a_rEmitter, TFLOAT a_fDeltaTime)

Protected Attributes
TUINT	m_uiDeviceIndex
TArray< RepeatInfo >	m_Repeats
TArray< void * >	m_Array2
TBOOL	m_bUnknown
TBOOL	m_bIsAcquired
TInputInterface *	m_pInputInterface
Protected Attributes inherited from TNodeList< T >::TNode
friend	TNodeList
TNodeList *	m_pList
T *	m_pNext
T *	m_pPrev

Static Protected Attributes
static constexpr TUINT	MAX_DEVICE_COUNT = 14
static TInputDevice *	s_aDevices [MAX_DEVICE_COUNT]
static TUINT	s_uiDeviceCount

Detailed Description

Definition at line 114 of file TInputInterface.h.

Member Typedef Documentation

Doodad

using TInputDevice::Doodad = TINT

Definition at line 125 of file TInputInterface.h.

EventEmitter

using TInputDevice::EventEmitter = TInputInterface::EventEmitter

Definition at line 124 of file TInputInterface.h.

Constructor & Destructor Documentation

TInputDevice()

TInputDevice::TInputDevice

(

)

Definition at line 15 of file TInputDevice.cpp.

    : m_Repeats( 0, 16 ), m_Array2( 0, 16 )
{
    m_bUnknown        = TFALSE;
    m_bIsAcquired     = TFALSE;
    m_pInputInterface = TNULL;
}

~TInputDevice()

TInputDevice::~TInputDevice ( )

default

Member Function Documentation

Acquire()

virtual TBOOL TInputDevice::Acquire ( )

pure virtual

Implemented in TInputDXDeviceKeyboard, and TInputDXDeviceMouse.

Flush()

TBOOL TInputDevice::Flush ( )

virtual

Reimplemented in TInputDXDeviceKeyboard, and TInputDXDeviceMouse.

Definition at line 23 of file TInputDevice.cpp.

{
    return TTRUE;
}

GetAxisCount()

virtual TINT TInputDevice::GetAxisCount ( ) const

pure virtual

Implemented in TInputDeviceKeyboard, and TInputDXDeviceMouse.

GetAxisFloat()

virtual TFLOAT TInputDevice::GetAxisFloat ( Doodad a_iDoodad, TINT axis ) const

pure virtual

Implemented in TInputDeviceKeyboard, and TInputDXDeviceMouse.

GetAxisFloat2()

virtual TFLOAT TInputDevice::GetAxisFloat2 ( Doodad a_iDoodad, TINT axis ) const

inlinevirtual

Definition at line 162 of file TInputInterface.h.

{ return GetAxisFloat( a_iDoodad, axis ); }

GetAxisInt()

virtual TINT TInputDevice::GetAxisInt ( Doodad a_iDoodad, TINT axis ) const

pure virtual

Implemented in TInputDeviceKeyboard, and TInputDXDeviceMouse.

GetAxisInt2()

virtual TINT TInputDevice::GetAxisInt2 ( Doodad a_iDoodad, TINT axis ) const

inlinevirtual

Definition at line 160 of file TInputInterface.h.

{ return GetAxisInt( a_iDoodad, axis ); }

GetButtonCount()

virtual TINT TInputDevice::GetButtonCount ( ) const

pure virtual

Implemented in TInputDXDeviceKeyboard, and TInputDXDeviceMouse.

GetButtonFromDoodad()

virtual const TCHAR * TInputDevice::GetButtonFromDoodad ( Doodad a_iDoodad ) const

pure virtual

Implemented in TInputDeviceController, TInputDeviceKeyboard, and TInputDeviceMouse.

GetDoodadProperties()

virtual TBOOL TInputDevice::GetDoodadProperties ( Doodad a_iDoodad, DoodadProperties & a_rProperties ) const

pure virtual

Implemented in TInputDeviceController, TInputDeviceKeyboard, and TInputDeviceMouse.

GetInputInterface()

TInputInterface * TInputDevice::GetInputInterface ( )

inline

Definition at line 176 of file TInputInterface.h.

    {
        return m_pInputInterface;
    }

GetNumRegisteredDevices()

static TUINT TInputDevice::GetNumRegisteredDevices ( )

inlinestatic

Definition at line 195 of file TInputInterface.h.

    {
        return s_uiDeviceCount;
    }

GetRegisteredDevices()

static TInputDevice ** TInputDevice::GetRegisteredDevices ( )

inlinestatic

Definition at line 190 of file TInputInterface.h.

    {
        return s_aDevices;
    }

IsAcquired()

TBOOL TInputDevice::IsAcquired ( ) const

inline

Definition at line 166 of file TInputInterface.h.

    {
        return m_bIsAcquired;
    }

IsDown()

virtual TBOOL TInputDevice::IsDown ( Doodad a_iDoodad ) const

pure virtual

Implemented in TInputDeviceController, TInputDXDeviceKeyboard, and TInputDXDeviceMouse.

IsEnabled()

virtual TBOOL TInputDevice::IsEnabled ( ) const

pure virtual

Implemented in TInputDXDeviceKeyboard, and TInputDXDeviceMouse.

IsForceFeedbackDevice()

TBOOL TInputDevice::IsForceFeedbackDevice ( )

virtual

Definition at line 123 of file TInputDevice.cpp.

{
    return TFALSE;
}

ProcessEvents()

virtual TINT TInputDevice::ProcessEvents ( EventEmitter & emitter, TFLOAT deltaTime )

pure virtual

Implemented in TInputDXDeviceKeyboard, and TInputDXDeviceMouse.

ProcessRepeats()

TINT TInputDevice::ProcessRepeats ( EventEmitter & a_rEmitter, TFLOAT a_fDeltaTime )

protected

Definition at line 29 of file TInputDevice.cpp.

{
    TINT iNumProcessed = 0;
 
    for ( TINT i = 0; i < m_Repeats.Size(); i++ )
    {
        auto& rRepeat = m_Repeats[ i ];
 
        if ( IsDown( rRepeat.iDoodad ) )
        {
            rRepeat.fLeftTime -= a_fDeltaTime;
 
            if ( rRepeat.fLeftTime <= 0.0f )
            {
                rRepeat.fLeftTime = rRepeat.fRepeatTime;
                ThrowRepeatEvent( a_rEmitter, &rRepeat, a_fDeltaTime );
                iNumProcessed += 1;
            }
        }
        else
        {
            if ( m_Repeats.Size() > 1 )
            {
                auto& rLastRepeat   = m_Repeats[ m_Repeats.Size() - 1 ];
                rRepeat.iDoodad     = rLastRepeat.iDoodad;
                rRepeat.fLeftTime   = rLastRepeat.fLeftTime;
                rRepeat.fRepeatTime = rLastRepeat.fRepeatTime;
            }
 
            if ( 0 < m_Repeats.Size() )
            {
                m_Repeats.Pop();
            }
        }
    }
 
    return iNumProcessed;
}

Release()

virtual void TInputDevice::Release ( )

pure virtual

Implemented in TInputDXDeviceKeyboard, and TInputDXDeviceMouse.

SetAcquired()

void TInputDevice::SetAcquired ( TBOOL a_bAcquired )

inline

Definition at line 171 of file TInputInterface.h.

    {
        m_bIsAcquired = a_bAcquired;
    }

SetInputInterface()

void TInputDevice::SetInputInterface ( TInputInterface * a_pInterface )

inline

Definition at line 181 of file TInputInterface.h.

    {
        m_pInputInterface = a_pInterface;
    }

StartRepeat()

TBOOL TInputDevice::StartRepeat ( Doodad a_iDoodad, TFLOAT a_fFirstRepeatTime, TFLOAT a_fRepeatTime )

virtual

Definition at line 69 of file TInputDevice.cpp.

{
    for ( auto it = m_Repeats.Begin(); it.IsOver() == TFALSE; ++it )
    {
        if ( it->iDoodad == a_iDoodad )
        {
            it->fRepeatTime = a_fRepeatTime;
            return TTRUE;
        }
    }
 
    m_Repeats.Push( { .iDoodad     = a_iDoodad,
                      .fLeftTime   = a_fFirstRepeatTime,
                      .fRepeatTime = a_fRepeatTime } );
 
    return TTRUE;
}

StopAllRepeats()

void TInputDevice::StopAllRepeats ( )

virtual

Definition at line 118 of file TInputDevice.cpp.

{
    m_Repeats.Clear();
}

StopRepeat()

void TInputDevice::StopRepeat ( Doodad a_iDoodad )

virtual

Definition at line 88 of file TInputDevice.cpp.

{
    if ( m_Repeats.Size() != 0 )
    {
        auto it = m_Repeats.Begin();
 
        TINT iIndex = 0;
        while ( it->iDoodad != a_iDoodad )
        {
            ++it;
            ++iIndex;
            if ( it.IsOver() ) return;
        }
 
        if ( 1 < m_Repeats.Size() )
        {
            auto& rLastRepeat = m_Repeats[ m_Repeats.Size() - 1 ];
            it->iDoodad       = rLastRepeat.iDoodad;
            it->fLeftTime     = rLastRepeat.fLeftTime;
            it->fRepeatTime   = rLastRepeat.fRepeatTime;
        }
 
        if ( 0 < m_Repeats.Size() )
        {
            m_Repeats.Pop();
        }
    }
}

TDECLARE_CLASS()

TInputDevice::TDECLARE_CLASS	(	TInputDevice	,
		TObject	)

ThrowRepeatEvent()

void TInputDevice::ThrowRepeatEvent ( EventEmitter & emitter, RepeatInfo * repeatInfo, TFLOAT deltaTime )

virtual

Definition at line 129 of file TInputDevice.cpp.

{
    emitter.Throw(
        TInputInterface::InputEvent(
            this,
            repeatInfo->iDoodad,
            TInputInterface::EVENT_TYPE_REPEAT
        )
    );
}

Unacquire()

virtual TBOOL TInputDevice::Unacquire ( )

pure virtual

Implemented in TInputDXDeviceKeyboard, and TInputDXDeviceMouse.

Update()

virtual void TInputDevice::Update ( TFLOAT deltaTime )

pure virtual

Implemented in TInputDXDeviceKeyboard, and TInputDXDeviceMouse.

Member Data Documentation

INPUT_DEVICE_MOUSE_BUTTONS

TINT TInputDevice::INPUT_DEVICE_MOUSE_BUTTONS = 3

staticconstexpr

Definition at line 121 of file TInputInterface.h.

INPUT_DEVICE_MOUSE_WHEEL

TINT TInputDevice::INPUT_DEVICE_MOUSE_WHEEL = 4

staticconstexpr

Definition at line 122 of file TInputInterface.h.

m_Array2

TArray<void*> TInputDevice::m_Array2

protected

Definition at line 209 of file TInputInterface.h.

m_bIsAcquired

TBOOL TInputDevice::m_bIsAcquired

protected

Definition at line 211 of file TInputInterface.h.

m_bUnknown

TBOOL TInputDevice::m_bUnknown

protected

Definition at line 210 of file TInputInterface.h.

m_pInputInterface

TInputInterface* TInputDevice::m_pInputInterface

protected

Definition at line 212 of file TInputInterface.h.

m_Repeats

TArray<RepeatInfo> TInputDevice::m_Repeats

protected

Definition at line 208 of file TInputInterface.h.

m_uiDeviceIndex

TUINT TInputDevice::m_uiDeviceIndex

protected

Definition at line 207 of file TInputInterface.h.

MAX_DEVICE_COUNT

TUINT TInputDevice::MAX_DEVICE_COUNT = 14

staticconstexprprotected

Definition at line 201 of file TInputInterface.h.

s_aDevices

TInputDevice* TInputDevice::s_aDevices[MAX_DEVICE_COUNT]

inlinestaticprotected

Definition at line 203 of file TInputInterface.h.

s_uiDeviceCount

TUINT TInputDevice::s_uiDeviceCount

inlinestaticprotected

Definition at line 204 of file TInputInterface.h.

---

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

• D:/_dev/OpenBarnyard/Source/Toshi/Source/Input/TInputInterface.h
• D:/_dev/OpenBarnyard/Source/Toshi/Source/Input/TInputDevice.cpp