Class UUxtBoundingBoxManipulatorComponent

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

Inheritance
System::Object
UActorComponent
UUxtBoundingBoxManipulatorComponent
Namespace:
Assembly: .dll
Syntax
public: class UUxtBoundingBoxManipulatorComponent

Constructors

| Improve this Doc View Source

UUxtBoundingBoxManipulatorComponent()

Declaration
public: UUxtBoundingBoxManipulatorComponent()

Fields

| Improve this Doc View Source

OnManipulationEnded

Event raised when a manipulation is ended.

Declaration
public: FUxtBoundingBoxManipulationEndedDelegate OnManipulationEnded
Field Value
Type Description
FUxtBoundingBoxManipulationEndedDelegate
| Improve this Doc View Source

OnManipulationStarted

Event raised when a manipulation is started.

Declaration
public: FUxtBoundingBoxManipulationStartedDelegate OnManipulationStarted
Field Value
Type Description
FUxtBoundingBoxManipulationStartedDelegate

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

ComputeModifiedBounds(const FUxtBoundingBoxAffordanceInfo &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 FUxtBoundingBoxAffordanceInfo &Affordance, const FUxtGrabPointerData &GrabPointer, FBox &OutBounds, FQuat &OutDeltaRotation) const
Parameters
Type Name Description
const FUxtBoundingBoxAffordanceInfo & Affordance
const FUxtGrabPointerData & GrabPointer
FBox & OutBounds
FQuat & OutDeltaRotation
| 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 FUxtBoundingBoxAffordanceInfo &Affordance)

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

Declaration
protected: FUxtGrabPointerData * FindGrabPointer(const FUxtBoundingBoxAffordanceInfo &Affordance)
Parameters
Type Name Description
const FUxtBoundingBoxAffordanceInfo & Affordance
Returns
Type Description
FUxtGrabPointerData *
| Improve this Doc View Source

GetAffordanceKindActorClass(EUxtBoundingBoxAffordanceKind Kind)

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

Declaration
public: TSubclassOf<class AActor> GetAffordanceKindActorClass(EUxtBoundingBoxAffordanceKind Kind) const
Parameters
Type Name Description
EUxtBoundingBoxAffordanceKind Kind
Returns
Type Description
TSubclassOf<class AActor>
| Improve this Doc View Source

GetBounds()

Declaration
public: const FBox & GetBounds() const
Returns
Type Description
const FBox &
| Improve this Doc View Source

GetCenterAffordanceClass()

Declaration
public: TSubclassOf<class AActor> GetCenterAffordanceClass() const
Returns
Type Description
TSubclassOf<class AActor>
| Improve this Doc View Source

GetCornerAffordanceClass()

Declaration
public: TSubclassOf<class AActor> GetCornerAffordanceClass() const
Returns
Type Description
TSubclassOf<class AActor>
| Improve this Doc View Source

GetCustomAffordances()

Declaration
public: const TArray<FUxtBoundingBoxAffordanceInfo> & GetCustomAffordances() const
Returns
Type Description
const TArray<FUxtBoundingBoxAffordanceInfo> &
| Improve this Doc View Source

GetEdgeAffordanceClass()

Declaration
public: TSubclassOf<class AActor> GetEdgeAffordanceClass() const
Returns
Type Description
TSubclassOf<class AActor>
| Improve this Doc View Source

GetFaceAffordanceClass()

Declaration
public: TSubclassOf<class AActor> GetFaceAffordanceClass() const
Returns
Type Description
TSubclassOf<class AActor>
| Improve this Doc View Source

GetInitBoundsFromActor()

Declaration
public: bool GetInitBoundsFromActor() const
Returns
Type Description
bool
| Improve this Doc View Source

GetPreset()

Declaration
public: EUxtBoundingBoxManipulatorPreset GetPreset() const
Returns
Type Description
EUxtBoundingBoxManipulatorPreset
| 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

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<FUxtBoundingBoxAffordanceInfo> & GetUsedAffordances() const
Returns
Type Description
const TArray<FUxtBoundingBoxAffordanceInfo> &
| Improve this Doc View Source

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
| Improve this Doc View Source

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
| Improve this Doc View Source

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
| 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

TryActivateGrabPointer(const FUxtBoundingBoxAffordanceInfo &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 FUxtBoundingBoxAffordanceInfo &Affordance, const FUxtGrabPointerData &GrabPointer)
Parameters
Type Name Description
const FUxtBoundingBoxAffordanceInfo & Affordance
const FUxtGrabPointerData & GrabPointer
Returns
Type Description
bool
| Improve this Doc View Source

TryReleaseGrabPointer(const FUxtBoundingBoxAffordanceInfo &Affordance)

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

Declaration
protected: bool TryReleaseGrabPointer(const FUxtBoundingBoxAffordanceInfo &Affordance)
Parameters
Type Name Description
const FUxtBoundingBoxAffordanceInfo & Affordance
Returns
Type Description
bool
| Improve this Doc View Source

UpdateAffordanceTransforms()

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

Declaration
protected: void UpdateAffordanceTransforms()
| Improve this Doc View Source

UseCustomAffordances()

Declaration
public: bool UseCustomAffordances() const
Returns
Type Description
bool