IEyeTrackerModule.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Modules/ModuleInterface.h"
#include "Misc/ConfigCacheIni.h"
#include "Features/IModularFeatures.h"
#include "Features/IModularFeature.h"
 
class IEyeTrackerModule : public IModuleInterface, public IModularFeature
{
public:
    static EYETRACKER_API FName GetModularFeatureName();
 
    virtual FString GetModuleKeyName() const = 0;
 
    // #todo jcf: need to work out prioritization and selection scheme
    // e.g. it doesn't ever really make sense to choose a desktop eye tracker if in VR mode?
    float GetModulePriority() const
    {
        float ModulePriority = 0.f;
        FString KeyName = GetModuleKeyName();
        GConfig->GetFloat(TEXT("EyeTrackerPluginPriority"), (!KeyName.IsEmpty() ? *KeyName : TEXT("Default")), ModulePriority, GEngineIni);
        return ModulePriority;
    }
 
    struct FCompareModulePriority
    {
        bool operator()(IEyeTrackerModule& A, IEyeTrackerModule& B) const
        {
            return A.GetModulePriority() > B.GetModulePriority();
        }
    };
 
    static inline IEyeTrackerModule& Get()
    {
        TArray<IEyeTrackerModule*> ETModules = IModularFeatures::Get().GetModularFeatureImplementations<IEyeTrackerModule>(GetModularFeatureName());
        ETModules.Sort(FCompareModulePriority());
        return *ETModules[0];
    }
 
    static inline bool IsAvailable()
    {
        return IModularFeatures::Get().IsModularFeatureAvailable(GetModularFeatureName());
    }
 
    virtual void StartupModule() override
    {
        IModularFeatures::Get().RegisterModularFeature(GetModularFeatureName(), this);
    }
 
    virtual bool IsEyeTrackerConnected() const = 0;
 
    virtual TSharedPtr< class IEyeTracker, ESPMode::ThreadSafe > CreateEyeTracker() = 0;
};