UUxtManipulatorComponent

Manages constraints that can be applied by child components.

class UUxtManipulatorComponent;

Header

#include <Interactions/UxtManipulatorComponent.h>

Inheritance

Inherits from UActorComponent

Inherited by UUxtBoundsControlComponent, UUxtGrabTargetComponent

Public Functions

	Name
bool	GetAutoDetectConstraints() const
void	SetAutoDetectConstraints(bool bNewAutoDetectConstraints)
const TArray< FComponentReference > &	GetSelectedConstraints() const
void	AddConstraint(const FComponentReference & NewConstraint)
void	RemoveConstraint(const FComponentReference & NewConstraint)
bool	GetRelativeToInitialScale() const
void	SetRelativeToInitialScale(const bool Value)
float	GetMinScale() const
void	SetMinScale(const float Value)
float	GetMaxScale() const
void	SetMaxScale(const float Value)

Protected Functions

	Name
virtual void	BeginPlay() override
virtual void	TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction * ThisTickFunction) override
void	InitializeConstraints(USceneComponent * NewTargetComponent)
void	ApplyConstraints(FTransform & Transform, EUxtTransformMode TransformMode, bool bIsOneHanded, bool bIsNear) const

Public Functions Documentation

function GetAutoDetectConstraints

bool GetAutoDetectConstraints() const

Get if the component is automatically detecting constraints.

function SetAutoDetectConstraints

void SetAutoDetectConstraints(
    bool bNewAutoDetectConstraints
)

Set if the component should automatically detect constraints.

function GetSelectedConstraints

const TArray< FComponentReference > & GetSelectedConstraints() const

Get the list of currently selected constraints.

function AddConstraint

void AddConstraint(
    const FComponentReference & NewConstraint
)

Add a constraint to be applied when bAutoDetectConstraints is not set.

function RemoveConstraint

void RemoveConstraint(
    const FComponentReference & NewConstraint
)

Remove a constraint from being applied when bAutoDetectConstraints is not set.

function GetRelativeToInitialScale

inline bool GetRelativeToInitialScale() const

function SetRelativeToInitialScale

void SetRelativeToInitialScale(
    const bool Value
)

function GetMinScale

inline float GetMinScale() const

function SetMinScale

void SetMinScale(
    const float Value
)

function GetMaxScale

inline float GetMaxScale() const

function SetMaxScale

void SetMaxScale(
    const float Value
)

Protected Functions Documentation

function BeginPlay

virtual void BeginPlay() override

Reimplemented by: UUxtBoundsControlComponent::BeginPlay, UUxtGrabTargetComponent::BeginPlay, UUxtManipulatorComponentBase::BeginPlay

function TickComponent

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

Reimplemented by: UUxtBoundsControlComponent::TickComponent

function InitializeConstraints

void InitializeConstraints(
    USceneComponent * NewTargetComponent
)

Initialize the constraints with a target component to use for a reference transform.

function ApplyConstraints

void ApplyConstraints(
    FTransform & Transform,
    EUxtTransformMode TransformMode,
    bool bIsOneHanded,
    bool bIsNear
) const

Apply the constraints to the transform.

---

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