UUxtTransformConstraint

Base class for all constraints

Usage: Derive from this component and implement ApplyConstraint and GetConstraintType. Custom constraints will automatically be picked up by a UxtConstraintManager on the same actor

class UUxtTransformConstraint;

Header

#include <Interactions/Constraints/UxtTransformConstraint.h>

Inheritance

Inherits from UActorComponent

Inherited by UUxtFaceUserConstraint, UUxtFixedDistanceConstraint, UUxtFixedRotationToUserConstraint, UUxtFixedRotationToWorldConstraint, UUxtMaintainApparentSizeConstraint, UUxtMoveAxisConstraint, UUxtRotationAxisConstraint

Public Functions

	Name
virtual EUxtTransformMode	GetConstraintType() const
virtual void	ApplyConstraint(FTransform & Transform) const
virtual void virtual void	Initialize(const FTransform & WorldPose)

Public Attributes

	Name
int32	HandType
int32	InteractionMode

Protected Attributes

	Name
FTransform	WorldPoseOnManipulationStart

Public Functions Documentation

function GetConstraintType

virtual EUxtTransformMode GetConstraintType() const

Reimplemented by: UUxtFaceUserConstraint::GetConstraintType, UUxtFixedRotationToWorldConstraint::GetConstraintType, UUxtMoveAxisConstraint::GetConstraintType, UUxtRotationAxisConstraint::GetConstraintType, UUxtFixedDistanceConstraint::GetConstraintType, UUxtFixedRotationToUserConstraint::GetConstraintType, UUxtMaintainApparentSizeConstraint::GetConstraintType

Enabled manipulation modes.

function ApplyConstraint

virtual void ApplyConstraint(
    FTransform & Transform
) const

Reimplemented by: UUxtFaceUserConstraint::ApplyConstraint, UUxtFixedRotationToWorldConstraint::ApplyConstraint, UUxtMoveAxisConstraint::ApplyConstraint, UUxtRotationAxisConstraint::ApplyConstraint, UUxtFixedDistanceConstraint::ApplyConstraint, UUxtFixedRotationToUserConstraint::ApplyConstraint, UUxtMaintainApparentSizeConstraint::ApplyConstraint

Applies constraints to transforms during manipulation

function Initialize

virtual void virtual void Initialize(
    const FTransform & WorldPose
)

Reimplemented by: UUxtFixedDistanceConstraint::Initialize, UUxtFixedRotationToUserConstraint::Initialize, UUxtMaintainApparentSizeConstraint::Initialize

Intended to be called on manipulation started

Public Attributes Documentation

variable HandType

int32 HandType = static_cast<int32>(EUxtGrabMode::OneHanded | EUxtGrabMode::TwoHanded);

Whether this constraint applies to one hand manipulation, two hand manipulation or both.

variable InteractionMode

int32 InteractionMode = static_cast<int32>(EUxtInteractionMode::Near | EUxtInteractionMode::Far);

Whether this constraint applies to near manipulation, far manipulation or both.

Protected Attributes Documentation

variable WorldPoseOnManipulationStart

FTransform WorldPoseOnManipulationStart;

---

Updated on 19 August 2021 at 17:42:52 Coordinated Universal Time