1. Epic GamesDeveloper
  3. AXRCreativeAvatar

AXRCreativeAvatar

API > API/Plugins > API/Plugins/XRCreative

Inheritance Hierarchy

References

   
Module XRCreative
Header /Engine/Plugins/Experimental/XRCreativeFramework/Source/XRCreative/Public/XRCreativeAvatar.h
Include #include "XRCreativeAvatar.h"

Syntax

UCLASS ()  
class AXRCreativeAvatar : public APawn

Variables

  Type Name Description
Protected variable TSharedPtr< FActiveHapticFeedbackEffect > ActiveHapticEffect_Left Currently playing haptic effects for both the left and right hand
Protected variable TSharedPtr< FActiveHapticFeedbackEffect > ActiveHapticEffect_Right  
Protected variable bool bIsInputRegistered  
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UMotionControllerComponent > LeftController  
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UMotionControllerComponent > LeftControllerAim  
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< USkeletalMeshComponent > LeftControllerModel  
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UXRCreativePointerComponent > LeftControllerPointer  
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< UWidgetComponent > MenuWidget  
Protected variable FDelegateHandle OnSessionShutdownHandle Delegate handle for a the callback when a session shuts down
Protected variable FDelegateHandle OnSessionStartupHandle Delegate handle for a the callback when a session starts up
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UMotionControllerComponent > RightController  
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UMotionControllerComponent > RightControllerAim  
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< USkeletalMeshComponent > RightControllerModel  
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UXRCreativePointerComponent > RightControllerPointer  
Protected variable UProperty Category BlueprintReadOnly TArray< TObjectPtr< UXRCreativeTool > > Tools  
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UXRCreativeITFComponent > ToolsComponent  
Protected variable UProperty Category BlueprintReadOnly TObjectPtr< UXRCreativeToolset > Toolset  
Protected variable TWeakPtr< IConcertClientSession > WeakSession Weak pointer to the client session with which to send events. May be null or stale.
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UWidgetInteractionComponent > WidgetInteraction  

Constructors

  Type Name Description
Public function  

AXRCreativeAvatar ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void Adds an explicitly provided Input Mapping Context to the input system.
Public function UFunction BlueprintCallable, Category, Meta, BlueprintImplementableEvent void Called when In-Editor VR mode is started. In-Editor equivalent to Begin Play.
Public function UFunction BlueprintCallable, Category void  
Public function void  
Protected function Const IEnhancedInputSubsystemInterface * Gets the input interface for the currently active input method.
Public function Const UFunction BlueprintCallable, Category FTransform  
Public function Const UFunction BlueprintCallable, Category FTransform  
Public function Const bool

GetLaserForHand ( EControllerHand InHand,
FVector& OutLaserStart,
FVector& OutLaserEnd
)

  
Public function Const const TArray< TObjectPtr< UXRCreativeTool > > &  
Public function Const const UXRCreativeToolset *  
Protected function void  
Protected function void  
Protected function AActor *

InternalSpawnTransientActor ( TSubclassOf< AActor > ActorClass,
const FString& ActorName,
TOptional< TFunctionRef< void(AActor*)> > DeferredConstructionCallback
)

 Includes special handling to not dirty editor worlds.
Protected function void  
Protected function void  
Public function UFunction BlueprintCallable, Category ALevelSequenceActor *

OpenLevelSequence ( ULevelSequence* LevelSequence
)

  
Public function Virtual UFunction BlueprintCallable, Category void

PlayHapticEffect ( UHapticFeedbackEffect_Base* HapticEffect,
const int ControllerID,
const EControllerHand Hand,
float Scale,
bool bLoop
)

 Play haptic feedback asset on a given hand - only left and right supported
Protected function void

ProcessHaptics ( const float DeltaTime
)

  
Protected function void Utility functions for registering and unregistering our input component with the correct input system.
Public function UFunction BlueprintCallable, Category void Registers the given object with the Avatar's Input Component This allows dynamic input bindings such as input events in blueprints to work correctly Note: Ensure you call UnregisterObjectForInput when you are finished with the object otherwise input events will still fire until GC actually destroys the object
Public function UFunction BlueprintCallable, Category void Removes an explicitly provided Input Mapping Context to the input system.
Public function UFunction BlueprintCallable, Category void

SetComponentTickInEditor ( UActorComponent* Component,
bool bShouldTickInEditor
)

  
Public function UFunction BlueprintCallable, Category AActor *

SpawnTransientActor ( TSubclassOf< AActor > ActorClass,
const FString& ActorName
)

 Includes special handling to not dirty editor worlds.
Public function AActor *

SpawnTransientActor ( TSubclassOf< AActor > ActorClass,
const FString& ActorName,
TFunctionRef< void(AActor*)> DeferredConstructionCallback
)

  
Public function UFunction BlueprintCallable, Category void

StopHapticEffect ( EControllerHand Hand,
const int ControllerID
)

 Instantly stop a haptic feedback for a given hand - only left and right supported
Protected function void  
Public function UFunction BlueprintCallable, Category void Unregisters the given object with the Avatar's Input Component

Overridden from AActor

  Type Name Description
Public function Virtual void Overridable native event for when play begins for this actor.
Public function Virtual Const bool Does this actor have a locally controlled owner responsible for replication? (APlayerController typically)
Public function Virtual void

OnConstruction ( const FTransform& InTransform
)

 Called when an instance of this class is placed (in editor) or spawned.
Public function Virtual void

Tick ( float InDeltaSeconds
)

 Function called every frame on this Actor.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page