IEyeTrackerModule Class Reference

#include <IEyeTrackerModule.h>

Inheritance diagram for IEyeTrackerModule:

Classes
struct	FCompareModulePriority

Public Member Functions
virtual FString	GetModuleKeyName () const =0
float	GetModulePriority () const
virtual void	StartupModule () override
virtual bool	IsEyeTrackerConnected () const =0
virtual TSharedPtr< class IEyeTracker, ESPMode::ThreadSafe >	CreateEyeTracker ()=0
Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()
virtual void	PreUnloadCallback ()
virtual void	PostLoadCallback ()
virtual void	ShutdownModule ()
virtual bool	SupportsDynamicReloading ()
virtual bool	SupportsAutomaticShutdown ()
virtual bool	IsGameModule () const

Static Public Member Functions
static EYETRACKER_API FName	GetModularFeatureName ()
static IEyeTrackerModule &	Get ()
static bool	IsAvailable ()

Detailed Description

The public interface of the EyeTracker module

Member Function Documentation

CreateEyeTracker()

virtual TSharedPtr< class IEyeTracker, ESPMode::ThreadSafe > IEyeTrackerModule::CreateEyeTracker ( )

pure virtual

Attempts to create a new head tracking device interface

Returns

Interface to the new head tracking device, if we were able to successfully create one

Get()

static IEyeTrackerModule & IEyeTrackerModule::Get ( )

inlinestatic

Singleton-like access to IEyeTrackerModule

Returns

Returns reference to the highest priority IEyeTrackerModule module

GetModularFeatureName()

FName IEyeTrackerModule::GetModularFeatureName ( )

static

Returns modular feature name for this module

GetModuleKeyName()

virtual FString IEyeTrackerModule::GetModuleKeyName ( ) const

pure virtual

GetModulePriority()

float IEyeTrackerModule::GetModulePriority ( ) const

inline

Returns the priority of this module from INI file configuration

IsAvailable()

static bool IEyeTrackerModule::IsAvailable ( )

inlinestatic

Checks to see if there exists a module registered as an EyeTracker. It is only valid to call Get() if IsAvailable() returns true.

Returns

True if there exists a module registered as an HMD.

IsEyeTrackerConnected()

virtual bool IEyeTrackerModule::IsEyeTrackerConnected ( ) const

pure virtual

StartupModule()

virtual void IEyeTrackerModule::StartupModule ( )

inlineoverridevirtual

Register module as an EyeTracker on startup.

Reimplemented from IModuleInterface.

---

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

• Engine/Source/Runtime/EyeTracker/Public/IEyeTrackerModule.h
• Engine/Source/Runtime/EyeTracker/Private/EyeTrackerModule.cpp