Class UUxtHandConstraintComponent

Component that calculates a goal based on hand tracking and moves the owning actor.

Several zones around the hand supported: radial and ulnar for the thumb side and its opposite, as well as above and below the hand. The goal position is computed by casting a ray in the direction of the zone at a bounding box around the hand joints.

The constraint can be oriented on either the hand rotation alone or facing the player.

Inheritance

System::Object

UActorComponent

UUxtHandConstraintComponent

Namespace:

Assembly: .dll

Syntax

public: class UUxtHandConstraintComponent

Constructors

UUxtHandConstraintComponent()

Declaration

public: UUxtHandConstraintComponent()

Fields

bMoveOwningActor

Actor transform is moved towards the goal if true. Disable this to only compute the goal without changing the actor transform.

Declaration

public: bool bMoveOwningActor= true

Field Value

Type	Description
bool

GoalMargin

Margin between the hand bounding box and the goal location.

Declaration

public: float GoalMargin= 0.0f

Field Value

Type	Description
float

Hand

Hand to use for the constraint. If set to 'Any Hand' the first tracked hand will be used, until tracking is lost.

Declaration

public: EControllerHand Hand= EControllerHand::AnyHand

Field Value

Type	Description
EControllerHand

LocationLerpTime

Interpolation time for smoothed translation. Set to zero to disable smoothing.

Declaration

public: float LocationLerpTime= 0.05f

Field Value

Type	Description
float

OffsetMode

Determines how the offset vector is computed.

Declaration

public: EUxtHandConstraintOffsetMode OffsetMode= EUxtHandConstraintOffsetMode::LookAtCamera

Field Value

Type	Description
EUxtHandConstraintOffsetMode

OnBeginTracking

Event raised when the constraint begins tracking a hand.

Declaration

public: FUxtHandConstraintBeginTrackingDelegate OnBeginTracking

Field Value

Type	Description
FUxtHandConstraintBeginTrackingDelegate

OnConstraintActivated

Event raised when the constraint becomes active, as indicated by the bIsConstraintActive property.

Declaration

public: FUxtHandConstraintActivatedDelegate OnConstraintActivated

Field Value

Type	Description
FUxtHandConstraintActivatedDelegate

OnConstraintDeactivated

Event raised when the constraint becomes inactive, as indicated by the bIsConstraintActive property.

Declaration

public: FUxtHandConstraintDeactivatedDelegate OnConstraintDeactivated

Field Value

Type	Description
FUxtHandConstraintDeactivatedDelegate

OnEndTracking

Event raised when the constraint ends tracking a hand.

Declaration

public: FUxtHandConstraintEndTrackingDelegate OnEndTracking

Field Value

Type	Description
FUxtHandConstraintEndTrackingDelegate

RotationLerpTime

Interpolation time for smoothed rotation. Set to zero to disable smoothing.

Declaration

public: float RotationLerpTime= 0.05f

Field Value

Type	Description
float

RotationMode

Determines how the goal rotation is computed.

Declaration

public: EUxtHandConstraintRotationMode RotationMode= EUxtHandConstraintRotationMode::LookAtCamera

Field Value

Type	Description
EUxtHandConstraintRotationMode

Zone

Safe zone that determines the target location of the constraint relative to the hand.

Declaration

public: EUxtHandConstraintZone Zone= EUxtHandConstraintZone::UlnarSide

Field Value

Type	Description
EUxtHandConstraintZone

Methods

BeginPlay()

Declaration

protected: virtual void BeginPlay() override

GetGoalLocation()

Declaration

public: const FVector & GetGoalLocation() const

Returns

Type	Description
const FVector &

GetGoalRotation()

Declaration

public: const FQuat & GetGoalRotation() const

Returns

Type	Description
const FQuat &

GetHandBounds()

Declaration

public: const FBox & GetHandBounds() const

Returns

Type	Description
const FBox &

GetTrackedHand()

Declaration

public: EControllerHand GetTrackedHand() const

Returns

Type	Description
EControllerHand

IsConstraintActive()

Declaration

public: bool IsConstraintActive() const

Returns

Type	Description
bool

IsHandUsableForConstraint(EControllerHand NewHand)

Returns true if the given hand is eligible for the constraint. If the hand is rejected the constraint will be deactivated.

Declaration

public: virtual bool IsHandUsableForConstraint(EControllerHand NewHand)

Parameters

Type	Name	Description
EControllerHand	NewHand

Returns

Type	Description
bool

TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction)

Declaration

protected: virtual void TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override

Parameters

Type	Name	Description
float	DeltaTime
ELevelTick	TickType
FActorComponentTickFunction *	ThisTickFunction