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

| Improve this Doc View Source

~UUxtBoundsControlComponent()

Declaration

public: ~UUxtBoundsControlComponent()

| Improve this Doc View Source

UUxtBoundsControlComponent()

Declaration

public: UUxtBoundsControlComponent()

| Improve this Doc View Source

UUxtBoundsControlComponent(FVTableHelper &Helper)

Declaration

public: UUxtBoundsControlComponent(FVTableHelper &Helper)

Parameters

Type	Name	Description
FVTableHelper &	Helper

Fields

| Improve this Doc View Source

AffordanceTransitionDuration

Duration of animated affordance transitions.

Declaration

public: float AffordanceTransitionDuration= 0.25f

Field Value

Type	Description
float

| Improve this Doc View Source

AffordanceVisibilityDistance

Hand distance at which affordances become visible.

Declaration

public: float AffordanceVisibilityDistance= 10.f

Field Value

Type	Description
float

| Improve this Doc View Source

CenterAffordanceMesh

Mesh used for a center affordance.

Declaration

public: UStaticMesh * CenterAffordanceMesh

Field Value

Type	Description
UStaticMesh *

| Improve this Doc View Source

CollisionBox

Collision box that prevents pointer rays from passing through bounds control's box.

Declaration

public: UBoxComponent * CollisionBox

Field Value

Type	Description
UBoxComponent *

| Improve this Doc View Source

CollisionProfile

The collision profile used by CollisionBox.

Declaration

public: FName CollisionProfile= TEXT("UI")

Field Value

Type	Description
FName

| Improve this Doc View Source

Config

Configuration of the bounds control affordances.

Declaration

public: UUxtBoundsControlConfig * Config

Field Value

Type	Description
UUxtBoundsControlConfig *

| Improve this Doc View Source

CornerAffordanceMesh

Mesh used for a corner affordances.

Declaration

public: UStaticMesh * CornerAffordanceMesh

Field Value

Type	Description
UStaticMesh *

| Improve this Doc View Source

EdgeAffordanceMesh

Mesh used for a edge affordances.

Declaration

public: UStaticMesh * EdgeAffordanceMesh

Field Value

Type	Description
UStaticMesh *

| Improve this Doc View Source

FaceAffordanceMesh

Mesh used for a face affordances.

Declaration

public: UStaticMesh * FaceAffordanceMesh

Field Value

Type	Description
UStaticMesh *

| Improve this Doc View Source

OnManipulationEnded

Event raised when a manipulation is ended.

Declaration

public: FUxtBoundsControlManipulationEndedDelegate OnManipulationEnded

Field Value

Type	Description
FUxtBoundsControlManipulationEndedDelegate

| Improve this Doc View Source

OnManipulationStarted

Event raised when a manipulation is started.

Declaration

public: FUxtBoundsControlManipulationStartedDelegate OnManipulationStarted

Field Value

Type	Description
FUxtBoundsControlManipulationStartedDelegate

Methods

| Improve this Doc View Source

BeginPlay()

Declaration

protected: virtual void BeginPlay() override

| Improve this Doc View Source

ComputeBoundsFromComponents()

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

Declaration

public: void ComputeBoundsFromComponents()

| Improve this Doc View Source

CreateAffordances()

Create the BoundsControlActor and all affordances described in the config.

Declaration

protected: void CreateAffordances()

| Improve this Doc View Source

DestroyAffordances()

Destroy the BoundsControlActor and affordance instances.

Declaration

protected: void DestroyAffordances()

| Improve this Doc View Source

EndPlay(const EEndPlayReason::Type EndPlayReason)

Declaration

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

Parameters

Type	Name	Description
const EEndPlayReason::Type	EndPlayReason

| Improve this Doc View Source

FindGrabPointer(const FUxtAffordanceInstance *AffordanceInstance)

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

Declaration

protected: const FUxtGrabPointerData * FindGrabPointer(const FUxtAffordanceInstance *AffordanceInstance)

Parameters

Type	Name	Description
const FUxtAffordanceInstance *	AffordanceInstance

Returns

Type	Description
const FUxtGrabPointerData *

| Improve this Doc View Source

GetAffordanceKindMesh(EUxtAffordanceKind Kind)

Mesh for the given kind of affordance.

Declaration

public: UStaticMesh * GetAffordanceKindMesh(EUxtAffordanceKind Kind) const

Parameters

Type	Name	Description
EUxtAffordanceKind	Kind

Returns

Type	Description
UStaticMesh *

| Improve this Doc View Source

GetBounds()

Declaration

public: const FBox & GetBounds() const

Returns

Type	Description
const FBox &

| Improve this Doc View Source

GetBoundsControlActor()

Declaration

public: AActor * GetBoundsControlActor() const

Returns

Type	Description
AActor *

| Improve this Doc View Source

GetInitBoundsFromActor()

Declaration

public: bool GetInitBoundsFromActor() const

Returns

Type	Description
bool

| Improve this Doc View Source

GetPrimitiveAffordanceMap()

Get the map between the affordance actors and their information.

Declaration

public: const TMap<UPrimitiveComponent *, FUxtAffordanceInstance> & GetPrimitiveAffordanceMap()

Returns

Type	Description
const TMap<UPrimitiveComponent *, FUxtAffordanceInstance> &

| Improve this Doc View Source

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

| Improve this Doc View Source

IsAffordanceGrabbed(const FUxtAffordanceInstance *Affordance)

Returns true if the affordance instance is currently bing grabbed.

Declaration

protected: bool IsAffordanceGrabbed(const FUxtAffordanceInstance *Affordance) const

Parameters

Type	Name	Description
const FUxtAffordanceInstance *	Affordance

Returns

Type	Description
bool

| Improve this Doc View Source

OnActorTransformUpdate(USceneComponent *UpdatedComponent, EUpdateTransformFlags UpdateTransformFlags, ETeleportType Teleport)

Callback when the parent actor is moved.

Declaration

protected: void OnActorTransformUpdate(USceneComponent *UpdatedComponent, EUpdateTransformFlags UpdateTransformFlags, ETeleportType Teleport)

Parameters

Type	Name	Description
USceneComponent *	UpdatedComponent
EUpdateTransformFlags	UpdateTransformFlags
ETeleportType	Teleport

| Improve this Doc View Source

OnAffordanceBeginGrab(UUxtGrabTargetComponent *Grabbable, FUxtGrabPointerData GrabPointer)

Callback when an affordance is being grabbed.

Declaration

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

Parameters

Type	Name	Description
UUxtGrabTargetComponent *	Grabbable
FUxtGrabPointerData	GrabPointer

| Improve this Doc View Source

OnAffordanceEndGrab(UUxtGrabTargetComponent *Grabbable, FUxtGrabPointerData GrabPointer)

Callback when an affordance is being released.

Declaration

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

Parameters

Type	Name	Description
UUxtGrabTargetComponent *	Grabbable
FUxtGrabPointerData	GrabPointer

| Improve this Doc View Source

OnAffordanceEnterFarFocus(UUxtGrabTargetComponent Grabbable, UUxtFarPointerComponent Pointer)

Callback when an affordance is entering focus.

Declaration

protected: void OnAffordanceEnterFarFocus(UUxtGrabTargetComponent *Grabbable, UUxtFarPointerComponent *Pointer)

Parameters

Type	Name	Description
UUxtGrabTargetComponent *	Grabbable
UUxtFarPointerComponent *	Pointer

| Improve this Doc View Source

OnAffordanceEnterGrabFocus(UUxtGrabTargetComponent Grabbable, UUxtNearPointerComponent Pointer)

Callback when an affordance is entering focus.

Declaration

protected: void OnAffordanceEnterGrabFocus(UUxtGrabTargetComponent *Grabbable, UUxtNearPointerComponent *Pointer)

Parameters

Type	Name	Description
UUxtGrabTargetComponent *	Grabbable
UUxtNearPointerComponent *	Pointer

| Improve this Doc View Source

OnAffordanceExitFarFocus(UUxtGrabTargetComponent Grabbable, UUxtFarPointerComponent Pointer)

Callback when an affordance is exiting focus.

Declaration

protected: void OnAffordanceExitFarFocus(UUxtGrabTargetComponent *Grabbable, UUxtFarPointerComponent *Pointer)

Parameters

Type	Name	Description
UUxtGrabTargetComponent *	Grabbable
UUxtFarPointerComponent *	Pointer

| Improve this Doc View Source

OnAffordanceExitGrabFocus(UUxtGrabTargetComponent Grabbable, UUxtNearPointerComponent Pointer)

Callback when an affordance is exiting focus.

Declaration

protected: void OnAffordanceExitGrabFocus(UUxtGrabTargetComponent *Grabbable, UUxtNearPointerComponent *Pointer)

Parameters

Type	Name	Description
UUxtGrabTargetComponent *	Grabbable
UUxtNearPointerComponent *	Pointer

| Improve this Doc View Source

OnAffordanceUpdateGrab(UUxtGrabTargetComponent *Grabbable, FUxtGrabPointerData GrabPointer)

Callback when an affordance is being grabbed.

Declaration

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

Parameters

Type	Name	Description
UUxtGrabTargetComponent *	Grabbable
FUxtGrabPointerData	GrabPointer

| Improve this Doc View Source

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

| Improve this Doc View Source

TransformTarget(const FUxtAffordanceConfig &Affordance, const FUxtGrabPointerData &GrabPointer)

Modify the target based on the current affordance interaction

Declaration

protected: void TransformTarget(const FUxtAffordanceConfig &Affordance, const FUxtGrabPointerData &GrabPointer) const

Parameters

Type	Name	Description
const FUxtAffordanceConfig &	Affordance
const FUxtGrabPointerData &	GrabPointer

| Improve this Doc View Source

UpdateAffordanceAnimation(float DeltaTime)

Update animated properties such as affordance highlights.

Declaration

protected: void UpdateAffordanceAnimation(float DeltaTime)

Parameters

Type	Name	Description
float	DeltaTime

| Improve this Doc View Source

UpdateAffordanceTransforms()

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

Declaration

protected: void UpdateAffordanceTransforms()