Show / Hide Table of Contents

    FUxtAffordanceConfig

    Affordances are grabbable actors placed on the bounding box which enable interaction.

    struct FUxtAffordanceConfig;
    

    Header

    #include <UxtBoundsControlConfig.h>

    Public Functions

    Name
    FVector GetBoundsLocation() const
    FRotator GetBoundsRotation() const
    EUxtAffordanceKind GetAffordanceKind() const
    EUxtAffordanceAction GetAction() const
    void GetWorldLocationAndRotation(const FBox & Bounds, const FTransform & RootTransform, FVector & OutLocation, FQuat & OutRotation) const

    Public Attributes

    Name
    EUxtAffordancePlacement Placement
    FVector Rotation

    Public Functions Documentation

    function GetBoundsLocation

    FVector GetBoundsLocation() const
    

    Location of the affordance in normalized bounding box space (-1..1).

    function GetBoundsRotation

    FRotator GetBoundsRotation() const
    

    Rotation of the affordance in bounding box space.

    function GetAffordanceKind

    EUxtAffordanceKind GetAffordanceKind() const
    

    Kind of actor class to use. The matching actor class from the bounding box component will be used.

    function GetAction

    EUxtAffordanceAction GetAction() const
    

    Action that this affordance will perform when grabbed

    function GetWorldLocationAndRotation

    void GetWorldLocationAndRotation(
        const FBox & Bounds,
        const FTransform & RootTransform,
        FVector & OutLocation,
        FQuat & OutRotation
    ) const
    

    Location and rotation of the affordance in world space, based on the root transform. Root transform scale is not included in the result.

    Public Attributes Documentation

    variable Placement

    EUxtAffordancePlacement FUxtAffordanceConfig::Placement
    EUxtAffordancePlacement Placement = EUxtAffordancePlacement::Center;
    

    Preset type of the affordance.

    variable Rotation

    FVector FUxtAffordanceConfig::Rotation
    FVector Rotation = FVector::ZeroVector;
    

    The Euler orientation of the affordance.


    Updated on 2 November 2021 at 11:40:26 Coordinated Universal Time

    • Improve this Doc
    Back to top Generated by DocFX