1. Epic GamesDeveloper
  3. UXRDeviceVisualizationComponent

UXRDeviceVisualizationComponent

API > API/Plugins > API/Plugins/XRBase

   
Name UXRDeviceVisualizationComponent
Type class
Header File /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h
Include Path #include "XRDeviceVisualizationComponent.h"

Syntax

UCLASS (MinimalAPI, Blueprintable, Meta=(BlueprintSpawnableComponent), ClassGroup=MotionController)  
class UXRDeviceVisualizationComponent : public UStaticMeshComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UXRDeviceVisualizationComponent ( const FObjectInitializer& ObjectInitializer
)

   XRDeviceVisualizationComponent.h  

Enums

Public

Name Remarks
EModelLoadStatus  

Constants

Name Type Remarks Include Path
CustomModelSourceId FName   XRDeviceVisualizationComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsRenderingActive bool Set by the parent MotionController once tracking kicks in. XRDeviceVisualizationComponent.h  
bIsVisualizationActive bool Whether the visualization offered by this component is being used. XRDeviceVisualizationComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetIsVisualizationActive
  • Category="Visualization"
CustomDisplayMesh TObjectPtr< UStaticMesh > A mesh override that'll be displayed attached to this MotionController. XRDeviceVisualizationComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetCustomDisplayMesh
  • Category="Visualization"
DisplayDeviceId FXRDeviceId   XRDeviceVisualizationComponent.h  
DisplayMeshMaterialOverrides TArray< TObjectPtr< UMaterialInterface > > Material overrides for the specified display mesh. XRDeviceVisualizationComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Visualization"
DisplayModelLoadState EModelLoadStatus   XRDeviceVisualizationComponent.h  
DisplayModelSource FName Determines the source of the desired model. XRDeviceVisualizationComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetDisplayModelSource
  • Category="Visualization"
MotionSource FName   XRDeviceVisualizationComponent.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bInteractionProfilePresent bool   XRDeviceVisualizationComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanDeviceBeDisplayed()

 Whether this component can be displayed, depending on whether the parent MotionController has activated its rendering. XRDeviceVisualizationComponent.h  

UMotionControllerComponent * FindParentMotionController()

   XRDeviceVisualizationComponent.h  

void OnCloseVREditor()

   XRDeviceVisualizationComponent.h  

void OnDisplayModelLoaded ( UPrimitiveComponent* DisplayComponent
)

 Callback for asynchronous display model loads (to set materials, etc.) XRDeviceVisualizationComponent.h  

void OnRegister()

   XRDeviceVisualizationComponent.h  

void OnUnregister()

   XRDeviceVisualizationComponent.h  

void RefreshMesh()

   XRDeviceVisualizationComponent.h  

void SetCustomDisplayMesh ( UStaticMesh* NewDisplayMesh
)

   XRDeviceVisualizationComponent.h
  • BlueprintSetter

void SetDisplayModelSource ( const FName NewDisplayModelSource
)

   XRDeviceVisualizationComponent.h
  • BlueprintSetter

void SetIsRenderingActive ( bool bRenderingIsActive
)

   XRDeviceVisualizationComponent.h
  • BlueprintSetter
  • Category="MotionController"

void SetIsVisualizationActive ( bool bNewVisualizationState
)

   XRDeviceVisualizationComponent.h
  • BlueprintSetter

void SetMaterials ( int32 MatCount
)

   XRDeviceVisualizationComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page