Files
Plugin/Source/SenseGloveSettings/Public/SGSettings/SGTrackingSettings.h
T

109 lines
4.1 KiB
C++

/**
* @file
*
* @author Mamadou Babaei <mamadou@senseglove.com>
*
* @section LICENSE
*
* (The MIT License)
*
* Copyright (c) 2020 - 2024 SenseGlove
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* @section DESCRIPTION
*
*
*/
#pragma once
#include "HAL/Platform.h"
#include "UObject/ObjectMacros.h"
#include "SGSettings/SGGloveTrackingSettings.h"
#include "SGSettings/SGHandTrackingSettings.h"
#include "SGSettings/SGHMDTrackingSettings.h"
#include "SGSettings/SGWristTrackingSettings.h"
#include "SGTrackingSettings.generated.h"
/**
* Implements the settings for the SenseGlove Tracking module.
*
* The tracking settings are primarily used by the SenseGlove Tracking module and are divided into various subsections,
* each focusing on a specific aspect of tracking. These subsections, along with the other settings directly provided by
* this section, provide comprehensive control over the tracking functionalities.
*/
USTRUCT(BlueprintType)
struct SENSEGLOVESETTINGS_API FSGTrackingSettings
{
GENERATED_USTRUCT_BODY()
public:
/**
* Determines whether to fallback to hand-tracking, or not, when no SenseGlove device is detected:
*
* - If disabled, only a real glove will be tracked.
* - If enabled, the plugin will fall back to hand-tracking when it's available and supported by the HMD device.
*
* Note: disabling this option hides the hand-tracking settings section, while enabling it makes the hand-tracking
* settings visible.
*/
UPROPERTY(Config, EditDefaultsOnly, Category="Tracking")
bool bFallbackToHandTrackingIfNoGloveDetected;
/**
* Provides the tracking settings related to SenseGlove devices.
*/
UPROPERTY(Config, EditDefaultsOnly, Category="Tracking")
FSGGloveTrackingSettings GloveTrackingSettings;
/**
* The settings in this section only affects the hand-tracking functionality when it's enabled and available. When
* enabled the bare hands can be used instead of SenseGlove devices to interact within the VR simulation, of course
* without the haptics feedback provided by the SenseGlove devices.
*/
UPROPERTY(Config, EditDefaultsOnly, Category="Tracking",
meta=(EditCondition="bFallbackToHandTrackingIfNoGloveDetected", EditConditionHides))
FSGHandTrackingSettings HandTrackingSettings;
/**
* Provides the tracking settings related to head-mounted displays (HDMs) and their auto-detection functionality.
*/
UPROPERTY(Config, EditDefaultsOnly, Category="Tracking")
FSGHMDTrackingSettings HMDTrackingSettings;
/**
* Provides the tracking settings applicable to wrist-tracking hardware.
*/
UPROPERTY(Config, EditDefaultsOnly, Category="Tracking")
FSGWristTrackingSettings WristTrackingSettings;
public:
FSGTrackingSettings();
FSGTrackingSettings(
bool bInFallbackToHandTrackingIfNoGloveDetected,
const FSGGloveTrackingSettings& InGloveTrackingSettings,
const FSGHandTrackingSettings& InHandTrackingSettings,
const FSGHMDTrackingSettings& InHmdTrackingSettings,
const FSGWristTrackingSettings& InWristTrackingSettings);
};