Struct FUxtAffordanceConfig
Affordances are grabbable actors placed on the bounding box which enable interaction.
Namespace:
Assembly: .dll
Syntax
public: struct FUxtAffordanceConfig
Fields
| Improve this Doc View SourceAction
Action to perform when the affordance is grabbed.
Declaration
public: EUxtAffordanceAction Action= EUxtAffordanceAction::Resize
Field Value
| Type | Description |
|---|---|
| EUxtAffordanceAction |
bUniformAction
Apply action in all directions uniformly. If true transform is changed equally along every unconstrained axis.
Declaration
public: bool bUniformAction= true
Field Value
| Type | Description |
|---|---|
| bool |
Placement
Preset type of the affordance.
Declaration
public: EUxtAffordancePlacement Placement= EUxtAffordancePlacement::Center
Field Value
| Type | Description |
|---|---|
| EUxtAffordancePlacement |
Methods
| Improve this Doc View SourceGetAffordanceKind()
Kind of actor class to use. The matching actor class from the bounding box component will be used.
Declaration
public: EUxtAffordanceKind GetAffordanceKind() const
Returns
| Type | Description |
|---|---|
| EUxtAffordanceKind |
GetBoundsLocation()
Location of the affordance in normalized bounding box space (-1..1).
Declaration
public: FVector GetBoundsLocation() const
Returns
| Type | Description |
|---|---|
| FVector |
GetBoundsRotation()
Rotation of the affordance in bounding box space.
Declaration
public: FRotator GetBoundsRotation() const
Returns
| Type | Description |
|---|---|
| FRotator |
GetConstraintMatrix(int32 LockedAxes)
Constraint matrix defining possible movement directions or rotation axes. Drag vectors during interaction are multiplied with this matrix. If UniformAction is true the action will apply on all axes equally. LockedAxes flags place additional constraints on local axes.
Declaration
public: FMatrix GetConstraintMatrix(int32 LockedAxes) const
Parameters
| Type | Name | Description |
|---|---|---|
| int32 | LockedAxes |
Returns
| Type | Description |
|---|---|
| FMatrix |
GetWorldLocationAndRotation(const FBox &Bounds, const FTransform &RootTransform, FVector &OutLocation, FQuat &OutRotation)
Location and rotation of the affordance in world space, based on the root transform. Root transform scale is not included in the result.
Declaration
public: void GetWorldLocationAndRotation(const FBox &Bounds, const FTransform &RootTransform, FVector &OutLocation, FQuat &OutRotation) const
Parameters
| Type | Name | Description |
|---|---|---|
| const FBox & | Bounds | |
| const FTransform & | RootTransform | |
| FVector & | OutLocation | |
| FQuat & | OutRotation |