TInputInterface Class Reference

#include <TInputInterface.h>

Inheritance diagram for TInputInterface:

Classes
class	InputEvent

Public Types
enum	EVENT_TYPE {   EVENT_TYPE_GONE_DOWN , EVENT_TYPE_GONE_UP , EVENT_TYPE_REPEAT , EVENT_TYPE_VIRTUAL ,   EVENT_TYPE_MOVED }
using	EventEmitter = TEmitter<TInputInterface, TInputInterface::InputEvent>
Public Types inherited from TObject
enum	{ IsTObject = TTRUE }

Public Member Functions
	TDECLARE_CLASS (TInputInterface, TObject)
	TInputInterface ()
	~TInputInterface ()
virtual TBOOL	Initialise ()=0
virtual TBOOL	Deinitialise ()=0
virtual TBOOL	AcquireAll ()
virtual TBOOL	UnacquireAll ()
virtual TBOOL	FlushAll ()
virtual void	SetExclusiveMode (TBOOL a_bIsExclusive)
virtual TBOOL	GetExclusiveMode () const
virtual TINT	ProcessEvents (TFLOAT a_fDeltaTime)
virtual void	StopAllRepeats ()
void	AddDevice (TInputDevice *device)
void	RemoveDevice (TInputDevice *device)
void	ReleaseAllDevices ()
TInputDevice *	GetDeviceByIndex (TClass *a_pClass, TUINT a_uiIndex)
EventEmitter &	GetInputEventEmitter ()
template<class C>
C *	GetDeviceByIndex (TUINT a_uiIndex=0)
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 TSingleton< TInputInterface >
	TSingleton (const TSingleton &)=delete
	TSingleton (const TSingleton &&)=delete
TSingleton &	operator= (const TSingleton &)=delete
TSingleton &	operator= (const TSingleton &&)=delete

Additional Inherited Members
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 Member Functions inherited from TSingleton< TInputInterface >
static TFORCEINLINE TInputInterface *	CreateSingleton (Args &&... args)
static TFORCEINLINE D *	CreateSingleton (Args &&... args)
static TFORCEINLINE void	DestroySingleton ()
static TFORCEINLINE TInputInterface *	GetSingletonSafe ()
static TFORCEINLINE TBOOL	IsSingletonCreated ()
static TFORCEINLINE TInputInterface *	GetSingleton ()
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 inherited from TSingleton< TInputInterface >
TFORCEINLINE	TSingleton ()
TFORCEINLINE	~TSingleton ()
Static Protected Attributes inherited from TSingleton< TInputInterface >
static TInputInterface *	ms_pSingleton

Detailed Description

Definition at line 20 of file TInputInterface.h.

Member Typedef Documentation

EventEmitter

using TInputInterface::EventEmitter = TEmitter<TInputInterface, TInputInterface::InputEvent>

Definition at line 74 of file TInputInterface.h.

Member Enumeration Documentation

EVENT_TYPE

enum TInputInterface::EVENT_TYPE

Enumerator
EVENT_TYPE_GONE_DOWN
EVENT_TYPE_GONE_UP
EVENT_TYPE_REPEAT
EVENT_TYPE_VIRTUAL
EVENT_TYPE_MOVED

Definition at line 27 of file TInputInterface.h.

    {
        EVENT_TYPE_GONE_DOWN,
        EVENT_TYPE_GONE_UP,
        EVENT_TYPE_REPEAT,
        EVENT_TYPE_VIRTUAL,
        EVENT_TYPE_MOVED
    };

Constructor & Destructor Documentation

TInputInterface()

TInputInterface::TInputInterface

(

)

Definition at line 159 of file TInputInterface.cpp.

    : m_InputEventEmitter( this )
{
    m_bIsExclusiveMode = TFALSE;
}

~TInputInterface()

TInputInterface::~TInputInterface

(

)

Definition at line 166 of file TInputInterface.cpp.

{
}

Member Function Documentation

AcquireAll()

TBOOL TInputInterface::AcquireAll ( )

virtual

Definition at line 63 of file TInputInterface.cpp.

{
    TBOOL bResult = TTRUE;
 
    for ( auto it = m_DeviceList.Begin(); it != m_DeviceList.End(); ++it )
    {
        bResult &= it->Acquire();
    }
 
    return bResult;
}

AddDevice()

void TInputInterface::AddDevice

(

TInputDevice *

device

)

Definition at line 43 of file TInputInterface.cpp.

{
    if ( device != TNULL )
    {
        m_DeviceList.InsertTail( device );
        device->SetInputInterface( this );
    }
}

Deinitialise()

virtual TBOOL TInputInterface::Deinitialise ( )

pure virtual

Implemented in TInputDXInterface.

FlushAll()

TBOOL TInputInterface::FlushAll ( )

virtual

Definition at line 89 of file TInputInterface.cpp.

{
    TBOOL bResult = TTRUE;
 
    for ( auto it = m_DeviceList.Begin(); it != m_DeviceList.End(); ++it )
    {
        bResult &= it->Flush();
    }
 
    return bResult;
}

GetDeviceByIndex() [1/2]

TInputDevice * TInputInterface::GetDeviceByIndex	(	TClass *	a_pClass,
		TUINT	a_uiIndex )

Definition at line 17 of file TInputInterface.cpp.

{
    if ( m_DeviceList.Count() == 0 )
    {
        return TNULL;
    }
 
    for ( auto it = m_DeviceList.Begin(); it != m_DeviceList.End(); ++it )
    {
        if ( it->GetClass()->IsA( a_pClass ) )
        {
            if ( a_uiIndex == 0 )
            {
                return it;
            }
            else
            {
                a_uiIndex -= 1;
            }
        }
    }
 
    return TNULL;
}

GetDeviceByIndex() [2/2]

template<class C>

C * TInputInterface::GetDeviceByIndex ( TUINT a_uiIndex = 0 )

inline

Definition at line 100 of file TInputInterface.h.

    {
        C* pDevice = TSTATICCAST( C, GetDeviceByIndex( &TGetClass( C ), a_uiIndex ) );
        TASSERT( pDevice == TNULL || pDevice->GetClass()->IsA( &TGetClass( C ) ) );
        return pDevice;
    }

GetExclusiveMode()

TBOOL TInputInterface::GetExclusiveMode ( ) const

virtual

Definition at line 108 of file TInputInterface.cpp.

{
    return m_bIsExclusiveMode;
}

GetInputEventEmitter()

EventEmitter & TInputInterface::GetInputEventEmitter ( )

inline

Definition at line 97 of file TInputInterface.h.

{ return m_InputEventEmitter; }

Initialise()

virtual TBOOL TInputInterface::Initialise ( )

pure virtual

Implemented in TInputDXInterface.

ProcessEvents()

TINT TInputInterface::ProcessEvents ( TFLOAT a_fDeltaTime )

virtual

Definition at line 114 of file TInputInterface.cpp.

{
    TINT iNumProcessed = 0;
 
    for ( auto it = m_DeviceList.Begin(); it != m_DeviceList.End(); ++it )
    {
        if ( it->IsAcquired() )
        {
            it->Update( a_fDeltaTime );
        }
    }
 
    for ( auto it = m_DeviceList.Begin(); it != m_DeviceList.End(); ++it )
    {
        if ( it->IsAcquired() )
        {
            iNumProcessed += it->ProcessEvents( m_InputEventEmitter, a_fDeltaTime );
        }
    }
 
    return iNumProcessed;
}

ReleaseAllDevices()

void TInputInterface::ReleaseAllDevices

(

)

Definition at line 147 of file TInputInterface.cpp.

{
    for ( auto it = m_DeviceList.Begin(); it != m_DeviceList.End(); ++it )
    {
        it->Unacquire();
        it->Release();
        it->Remove();
        delete it.Get();
    }
}

RemoveDevice()

void TInputInterface::RemoveDevice

(

TInputDevice *

device

)

Definition at line 53 of file TInputInterface.cpp.

{
    if ( device != TNULL )
    {
        m_DeviceList.Remove( device );
        device->SetInputInterface( TNULL );
    }
}

SetExclusiveMode()

void TInputInterface::SetExclusiveMode ( TBOOL a_bIsExclusive )

virtual

Reimplemented in TInputDXInterface.

Definition at line 102 of file TInputInterface.cpp.

{
    m_bIsExclusiveMode = a_bIsExclusive;
}

StopAllRepeats()

void TInputInterface::StopAllRepeats ( )

virtual

Definition at line 138 of file TInputInterface.cpp.

{
    for ( auto it = m_DeviceList.Begin(); it != m_DeviceList.End(); ++it )
    {
        it->StopAllRepeats();
    }
}

TDECLARE_CLASS()

TInputInterface::TDECLARE_CLASS	(	TInputInterface	,
		TObject	)

UnacquireAll()

TBOOL TInputInterface::UnacquireAll ( )

virtual

Definition at line 76 of file TInputInterface.cpp.

{
    TBOOL bResult = TTRUE;
 
    for ( auto it = m_DeviceList.Begin(); it != m_DeviceList.End(); ++it )
    {
        bResult &= it->Unacquire();
    }
 
    return bResult;
}

---

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/TInputInterface.cpp