Files
Plugin/Source/SenseGloveCore/Public/SGCore/SGAnatomy.h
T

114 lines
3.4 KiB
C++

/**
* @file
*
* @author Mamadou Babaei <mamadou@senseglove.com>
*
* @section LICENSE
*
* (The MIT License)
*
* Copyright (c) 2020 - 2022 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
*
* Hard-Coded Database that is used in calibration and in solving.
* Values herein are used to limit outputs within 'natural' ranges.
*/
#pragma once
#include "Containers/Array.h"
#include "HAL/Platform.h"
#include "Math/Vector.h"
#include "SGAnatomy.generated.h"
/**
* "Database" of anatomical values, such as joint limits.
*/
USTRUCT()
struct SENSEGLOVECORE_API FSGAnatomy
{
GENERATED_BODY()
public:
/**
* Total sum of all finger flexion that would be considered "total flexion".
*/
static float GetTotalFingerFlexion();
/**
* Total sum of all finger flexion that would be considered "total extension".
*/
static float GetTotalFingerExtension();
/**
* Total sum of all thumb flexion that would be considered "total flexion".
*/
static float GetTotalThumbFlexion();
/**
* Total sum of all thumb flexion that would be considered "total extension".
*/
static float GetTotalThumbExtension();
/**
* Retrieve one of the limits of a finger joint's movement.
*/
static float GetFingerJointLimit(bool bRightHanded, int32 Joint, int32 Movement, bool bMax);
/**
* Retrieve one of the limits of a thumb joint's movement.
*/
static float GetThumbJointLimit(bool bRightHanded, int32 Joint, int32 Movement, bool bMax);
/**
* Convert a total finger flexion in radians into a 0..1 representation.
*/
static float NormalizeFingerFlexion(float FlexionInRadians);
/**
* Convert a total thumb flexion in radians into a 0..1 representation.
*/
static float NormalizeThumbFlexion(float FlexionInRadians);
/**
* Get Hand Angles that would make a Default (Idle) Pose.
*/
static TArray<TArray<FVector>> GetDefaultHandAngles(bool bRightHanded);
/**
* Get Hand Angles that would make a flat hand.
*/
static TArray<TArray<FVector>> GetFlatHandAngles(bool bRightHanded);
/**
* Get hand angles that would make a thumbs up.
*/
static TArray<TArray<FVector>> GetThumbsUpHandAngles(bool bRightHanded);
/**
* Get Hand Angles that would make a fist.
*/
static TArray<TArray<FVector>> GetFistHandAngles(bool bRightHanded);
};