public/0.12.xpublic/0.8.xpublic/0.9.xpublic/0.10.x
  • Features
  • API Documentation
  • API Documentation
  • UUxtFunctionLibrary

    Show / Hide Table of Contents
    • AUxtBasePressableButtonActor
    • AUxtHandInteractionActor
    • AUxtInputSimulationActor
    • AUxtPinchSliderActor
    • AUxtPressableButtonActor
    • AUxtPressableCheckButtonActor
    • AUxtPressableRadioButtonActor
    • AUxtPressableSwitchButtonActor
    • AUxtPressableToggleButtonActor
    • AUxtTextRenderActor
    • FScrollingCollectionProperties
    • FUxtAffordanceConfig
    • FUxtAffordanceInstance
    • FUxtButtonAudioBrush
    • FUxtButtonBrush
    • FUxtButtonVisualsBrush
    • FUxtFontCharacter
    • FUxtGrabPointerData
    • FUxtGrabPointerFocus
    • FUxtHandProximityMeshData
    • FUxtIconBrush
    • FUxtIconBrushCustomization
    • FUxtInputAnimationUtils
    • FUxtInputSimulationHandState
    • FUxtInteractionUtils
    • FUXToolsEditorModule
    • FUXToolsModule
    • FUXToolsShadersModule
    • FUXToolsWMRModule
    • FUxtPointerFocus
    • FUxtPointerFocusSearchResult
    • FUxtPokePointerFocus
    • FUxtPressableButtonComponentVisualizer
    • FUxtRuntimeSettingsButtonSet
    • FUxtTextBrush
    • FUxtTooltipSpawnerComponentVisualizer
    • FUxtWmrHandTracker
    • IUxtCollectionObject
    • IUxtFarHandler
    • IUxtFarTarget
    • IUxtGrabHandler
    • IUxtGrabTarget
    • IUxtHandTracker
    • IUxtPokeHandler
    • IUxtPokeTarget
    • UUxtBaseObjectCollection
    • UUxtBoundsControlComponent
    • UUxtBoundsControlConfig
    • UUxtCollectionObject
    • UUxtFaceUserConstraint
    • UUxtFarBeamComponent
    • UUxtFarCursorComponent
    • UUxtFarHandler
    • UUxtFarPointerComponent
    • UUxtFarTarget
    • UUxtFingerCursorComponent
    • UUxtFixedDistanceConstraint
    • UUxtFixedRotationToUserConstraint
    • UUxtFixedRotationToWorldConstraint
    • UUxtFollowComponent
    • UUxtFunctionLibrary
    • UUxtGrabHandler
    • UUxtGrabPointerDataFunctionLibrary
    • UUxtGrabTarget
    • UUxtGrabTargetComponent
    • UUxtHandConstraintComponent
    • UUxtHandTrackingFunctionLibrary
    • UUxtIconBrushEditorUtilityWidget
    • UUxtInputSimulationHeadMovementComponent
    • UUxtInputSimulationLocalPlayerSubsystem
    • UUxtInputSimulationState
    • UUxtInputSubsystem
    • UUxtInternalFunctionLibrary
    • UUxtMaintainApparentSizeConstraint
    • UUxtManipulatorComponentBase
    • UUxtMathUtilsFunctionLibrary
    • UUxtMinMaxScaleConstraint
    • UUxtMoveAxisConstraint
    • UUxtNearPointerComponent
    • UUxtPalmUpConstraintComponent
    • UUxtPinchSliderComponent
    • UUxtPointerComponent
    • UUxtPokeHandler
    • UUxtPokeTarget
    • UUxtPressableButtonComponent
    • UUxtRotationAxisConstraint
    • UUxtRuntimeSettings
    • UUxtTapToPlaceComponent
    • UUxtTextRenderComponent
    • UUxtToggleGroupComponent
    • UUxtTouchableVolumeComponent
    • UUxtTouchBasedHandTrackerComponent
    • UUxtTouchBasedHandTrackerSubsystem
    • UUxtTransformConstraint
    • UUxtUIElementComponent
    • UUxtWidgetComponent
    • UxtAffordanceInteractionCache
    • UxtConstraintManager
    • UxtManipulationMoveLogic
    • UXTools
    • UXToolsEditor
    • UXToolsInputSimulation
    • UXToolsRuntimeSettings
    • UXToolsShaders
    • UXToolsWMR
    • UxtTwoHandManipulationRotateLogic
    • UxtTwoHandManipulationScaleLogic

    Class UUxtFunctionLibrary

    Library of utility functions for UX Tools.

    Inheritance
    System::Object
    UBlueprintFunctionLibrary
    UUxtFunctionLibrary
    Namespace:
    Assembly: .dll
    Syntax
    public: class UUxtFunctionLibrary

    Fields

    | Improve this Doc View Source

    bUseTestData

    When true, the methods in this class will use test data. Intended for tests and internal usage only.

    Declaration
    public: static bool bUseTestData= false
    Field Value
    Type Description
    bool
    | Improve this Doc View Source

    TestHeadPose

    When bUseTestData is true, GetHeadPose will return this transform.

    Declaration
    public: static FTransform TestHeadPose= FTransform::Identity
    Field Value
    Type Description
    FTransform

    Methods

    | Improve this Doc View Source

    GetHeadPose(UObject *WorldContextObject)

    Returns the world space position and orientation of the head.

    Declaration
    public: static FTransform GetHeadPose(UObject *WorldContextObject)
    Parameters
    Type Name Description
    UObject * WorldContextObject
    Returns
    Type Description
    FTransform
    | Improve this Doc View Source

    GetSceneComponentFromReference(const FComponentReference &ComponentRef, AActor *Owner)

    Returns the scene component the passed component reference is pointing to if there is any - else will return nullptr.

    Replicates FComponentReference::GetComponent() functionality, except it does not use FProperty to detect components. This allows it to detect components not contained in a blueprint.

    Declaration
    public: static USceneComponent * GetSceneComponentFromReference(const FComponentReference &ComponentRef, AActor *Owner)
    Parameters
    Type Name Description
    const FComponentReference & ComponentRef
    AActor * Owner
    Returns
    Type Description
    USceneComponent *
    | Improve this Doc View Source

    IsInEditor()

    Returns true if we are running in editor (not game mode or VR preview).

    Declaration
    public: static bool IsInEditor()
    Returns
    Type Description
    bool
    • Improve this Doc
    • View Source
    In This Article
    • Fields
      • bUseTestData
      • TestHeadPose
    • Methods
      • GetHeadPose(UObject *WorldContextObject)
      • GetSceneComponentFromReference(const FComponentReference &ComponentRef, AActor *Owner)
      • IsInEditor()
    Back to top Generated by DocFX