Navigation
API > API/Plugins > API/Plugins/XRBase
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UActorComponent
- USceneComponent
- UPrimitiveComponent
- UMeshComponent
- UStaticMeshComponent
- UXRDeviceVisualizationComponent
References
| Module | XRBase |
| Header | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRDeviceVisualizationComponent.h |
| Include | #include "XRDeviceVisualizationComponent.h" |
Syntax
UCLASS&40;Blueprintable, Meta&61;&40;BlueprintSpawnableComponent&41;, ClassGroup&61;MotionController&41;
class UXRDeviceVisualizationComponent : public UStaticMeshComponent
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bIsRenderingActive | Set by the parent MotionController once tracking kicks in. | |
| bool | bIsVisualizationActive | Whether the visualization offered by this component is being used. | |
| TObjectPtr< UStaticMesh > | CustomDisplayMesh | A mesh override that'll be displayed attached to this MotionController. | |
| FXRDeviceId | DisplayDeviceId | ||
| TArray< TObjectPtr< UMaterialInterface > > | DisplayMeshMaterialOverrides | Material overrides for the specified display mesh. | |
| EModelLoadStatus | DisplayModelLoadState | ||
| FName | DisplayModelSource | Determines the source of the desired model. | |
| FName | MotionSource | ||
| int32 | PreEditMaterialCount |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UXRDeviceVisualizationComponent
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | Whether this component can be displayed, depending on whether the parent MotionController has activated its rendering. | ||
| UMotionControllerComponent * | |||
| void | OnDisplayModelLoaded
(
UPrimitiveComponent* DisplayComponent |
Callback for asynchronous display model loads (to set materials, etc.) | |
| void | RefreshMesh () |
||
| void | SetCustomDisplayMesh
(
UStaticMesh* NewDisplayMesh |
||
| void | SetDisplayModelSource
(
const FName NewDisplayModelSource |
||
| void | SetIsRenderingActive
(
bool bRenderingIsActive |
||
| void | SetIsVisualizationActive
(
bool bNewVisualizationState |
||
| void | SetMaterials
(
int32 MatCount |
Overridden from UActorComponent
| Type | Name | Description | |
|---|---|---|---|
| void | BeginPlay () |
Used to detach physics objects before simulation begins. | |
| void | OnUnregister () |
Called when a component is unregistered. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PreEditChange
(
FProperty* PropertyAboutToChange |
This is called when a property is about to be modified externally |
Enums
| Type | Name | Description | |
|---|---|---|---|
| EModelLoadStatus |
Constants
| Name | Description |
|---|---|
| CustomModelSourceId |