Class UUxtBoundsControlComponent

Manages a set of affordances that can be manipulated for changing the actor transform.

Inheritance

System::Object

UActorComponent

UUxtBoundsControlComponent

Namespace:

Assembly: .dll

Syntax

public: class UUxtBoundsControlComponent

Constructors

UUxtBoundsControlComponent()

Declaration

public: UUxtBoundsControlComponent()

Fields

OnManipulationEnded

Event raised when a manipulation is ended.

Declaration

public: FUxtBoundsControlManipulationEndedDelegate OnManipulationEnded

Field Value

Type	Description
FUxtBoundsControlManipulationEndedDelegate

OnManipulationStarted

Event raised when a manipulation is started.

Declaration

public: FUxtBoundsControlManipulationStartedDelegate OnManipulationStarted

Field Value

Type	Description
FUxtBoundsControlManipulationStartedDelegate

Methods

BeginPlay()

Declaration

protected: virtual void BeginPlay() override

ComputeBoundsFromComponents()

Compute the bounding box based on the components of the bounding box actor.

Declaration

public: void ComputeBoundsFromComponents()

ComputeModifiedBounds(const FUxtBoundsControlAffordanceInfo &Affordance, const FUxtGrabPointerData &GrabPointer, FBox &OutBounds, FQuat &OutDeltaRotation)

Compute new bounding box and rotation based on the currently active grab pointers.

Declaration

protected: void ComputeModifiedBounds(const FUxtBoundsControlAffordanceInfo &Affordance, const FUxtGrabPointerData &GrabPointer, FBox &OutBounds, FQuat &OutDeltaRotation) const

Parameters

Type	Name	Description
const FUxtBoundsControlAffordanceInfo &	Affordance
const FUxtGrabPointerData &	GrabPointer
FBox &	OutBounds
FQuat &	OutDeltaRotation

EndPlay(const EEndPlayReason::Type EndPlayReason)

Declaration

protected: virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override

Parameters

Type	Name	Description
const EEndPlayReason::Type	EndPlayReason

FindGrabPointer(const FUxtBoundsControlAffordanceInfo &Affordance)

Look up the grab pointer data for an affordance. Returns null if the affordance is not currently grabbed.

Declaration

protected: FUxtGrabPointerData * FindGrabPointer(const FUxtBoundsControlAffordanceInfo &Affordance)

Parameters

Type	Name	Description
const FUxtBoundsControlAffordanceInfo &	Affordance

Returns

Type	Description
FUxtGrabPointerData *

GetActorAffordanceMap()

Get the map between the affordance actors and their information.

Declaration

public: const TMap<AActor *, const FUxtBoundsControlAffordanceInfo *> & GetActorAffordanceMap()

Returns

Type	Description
const TMap<AActor *, const FUxtBoundsControlAffordanceInfo *> &

GetAffordanceKindActorClass(EUxtBoundsControlAffordanceKind Kind)

Actor class that will be instantiated for the given kind of affordance.

Declaration

public: TSubclassOf<class AActor> GetAffordanceKindActorClass(EUxtBoundsControlAffordanceKind Kind) const

Parameters

Type	Name	Description
EUxtBoundsControlAffordanceKind	Kind

Returns

Type	Description
TSubclassOf<class AActor>

GetBounds()

Declaration

public: const FBox & GetBounds() const

Returns

Type	Description
const FBox &

GetCenterAffordanceClass()

Declaration

public: TSubclassOf<class AActor> GetCenterAffordanceClass() const

Returns

Type	Description
TSubclassOf<class AActor>

GetCornerAffordanceClass()

Declaration

public: TSubclassOf<class AActor> GetCornerAffordanceClass() const

Returns

Type	Description
TSubclassOf<class AActor>

GetCustomAffordances()

Declaration

public: const TArray<FUxtBoundsControlAffordanceInfo> & GetCustomAffordances() const

Returns

Type	Description
const TArray<FUxtBoundsControlAffordanceInfo> &

GetEdgeAffordanceClass()

Declaration

public: TSubclassOf<class AActor> GetEdgeAffordanceClass() const

Returns

Type	Description
TSubclassOf<class AActor>

GetFaceAffordanceClass()

Declaration

public: TSubclassOf<class AActor> GetFaceAffordanceClass() const

Returns

Type	Description
TSubclassOf<class AActor>

GetInitBoundsFromActor()

Declaration

public: bool GetInitBoundsFromActor() const

Returns

Type	Description
bool

GetPreset()

Declaration

public: EUxtBoundsControlPreset GetPreset() const

Returns

Type	Description
EUxtBoundsControlPreset

GetRelativeBoxTransform(const FBox &Box, const FBox &RelativeTo, FTransform &OutTransform)

Compute the relative translation and scale between two boxes. Returns false if relative scale can not be computed.

Declaration

protected: static bool GetRelativeBoxTransform(const FBox &Box, const FBox &RelativeTo, FTransform &OutTransform)

Parameters

Type	Name	Description
const FBox &	Box
const FBox &	RelativeTo
FTransform &	OutTransform

Returns

Type	Description
bool

GetUsedAffordances()

Get the list of affordances that will be used for the bounding box. This can be a based on a preset or a custom set of affordances.

Declaration

public: const TArray<FUxtBoundsControlAffordanceInfo> & GetUsedAffordances() const

Returns

Type	Description
const TArray<FUxtBoundsControlAffordanceInfo> &

OnPointerBeginGrab(UUxtGrabTargetComponent *Grabbable, FUxtGrabPointerData GrabPointer)

Callback when an affordance is being grabbed.

Declaration

protected: void OnPointerBeginGrab(UUxtGrabTargetComponent *Grabbable, FUxtGrabPointerData GrabPointer)

Parameters

Type	Name	Description
UUxtGrabTargetComponent *	Grabbable
FUxtGrabPointerData	GrabPointer

OnPointerEndGrab(UUxtGrabTargetComponent *Grabbable, FUxtGrabPointerData GrabPointer)

Callback when an affordance is being released.

Declaration

protected: void OnPointerEndGrab(UUxtGrabTargetComponent *Grabbable, FUxtGrabPointerData GrabPointer)

Parameters

Type	Name	Description
UUxtGrabTargetComponent *	Grabbable
FUxtGrabPointerData	GrabPointer

OnPointerUpdateGrab(UUxtGrabTargetComponent *Grabbable, FUxtGrabPointerData GrabPointer)

Callback when an affordance is being grabbed.

Declaration

protected: void OnPointerUpdateGrab(UUxtGrabTargetComponent *Grabbable, FUxtGrabPointerData GrabPointer)

Parameters

Type	Name	Description
UUxtGrabTargetComponent *	Grabbable
FUxtGrabPointerData	GrabPointer

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

TryActivateGrabPointer(const FUxtBoundsControlAffordanceInfo &Affordance, const FUxtGrabPointerData &GrabPointer)

Try to activate the given grab pointer on the bounding box. Returns true when the grab activation was successful and the pointer will update the bounding box.

Declaration

protected: bool TryActivateGrabPointer(const FUxtBoundsControlAffordanceInfo &Affordance, const FUxtGrabPointerData &GrabPointer)

Parameters

Type	Name	Description
const FUxtBoundsControlAffordanceInfo &	Affordance
const FUxtGrabPointerData &	GrabPointer

Returns

Type	Description
bool

TryReleaseGrabPointer(const FUxtBoundsControlAffordanceInfo &Affordance)

Release the grab pointer. Returns true if the pointer was grabbing and has been released.

Declaration

protected: bool TryReleaseGrabPointer(const FUxtBoundsControlAffordanceInfo &Affordance)

Parameters

Type	Name	Description
const FUxtBoundsControlAffordanceInfo &	Affordance

Returns

Type	Description
bool

UpdateAffordanceTransforms()

Update the world transforms of affordance actors to match the current bounding box.

Declaration

protected: void UpdateAffordanceTransforms()

UseCustomAffordances()

Declaration

public: bool UseCustomAffordances() const

Returns

Type	Description
bool