Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AugmentedReality > UARComponent

Light Theme

Dark Theme

UARComponent

ARComponent handles replication and visualization update for AR tracked geometries ARComponent is created in either multiplayer or local only environment

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UARComponent

	UAREnvironmentProbeComponent
	UARFaceComponent
	UARGeoAnchorComponent
	UARImageComponent
	UARMeshComponent
	UARObjectComponent
	UARPlaneComponent
	UARPointComponent
	UARPoseComponent
	UARQRCodeComponent

References

Module	AugmentedReality
Header	/Engine/Source/Runtime/AugmentedReality/Public/ARComponent.h
Include	#include "ARComponent.h"

Syntax

class UARComponent : public USceneComponent

Remarks

ARComponent handles replication and visualization update for AR tracked geometries ARComponent is created in either multiplayer or local only environment

To customize the visualization logic, override 'UpdateVisualization' in Blueprint or 'UpdateVisualization_Implementation' in C++

To customize the replication logic, disable 'bUseDefaultReplication' and implement your own replication logic when the ARComponent is updated (see how 'Update' is implemented in the sub classes)

A MRMeshComponent will be created if mesh visualization is enabled (see UARSessionConfig::bGenerateMeshDataFromTrackedGeometry) It can be accessed via 'GetMRMesh' or 'UARTrackedGeometry::GetUnderlyingMesh'

Variables

	Name	Description
bool	bFirstUpdate	If this component has ever been updated
bool	bInDebugMode
bool	bIsRemoved	If 'ReceiveRemove' has been called for this component
bool	bSavedWireframeMode
bool	bUseDefaultReplication	If the default replication logic should be used for this component
UMaterialInterf...	DefaultMeshMaterial	The default material to be used for the generated mesh component.
UMaterialInterf...	DefaultWireframeMeshMaterial	The default wireframe material to be used for the generated mesh component.
UMRMeshComponen...	MRMeshComponent
UARTrackedGeome...	MyTrackedGeometry	The tracked geometry used for updating this component, only set on "local" client
FGuid	NativeID
FMRMeshDelegate	OnMRMeshCreated
FMRMeshDelegate	OnMRMeshDestroyed
FLinearColor	SavedWireframeColor

Constructors

	Name	Description
	UARComponent()

Functions

	Name	Description
FLinearColor	GetDebugColor()
UMRMeshCompo...	GetMRMesh()
void	ManageMeshComponentForDebugMode ( bool bDebugModeEnabled, const FARSessionPayload& SessionPa... )
void	OnRep_Payload()
void	ReceiveRemove()	Event when native representation is removed, called on server and clients.
void	Remove ( UARTrackedGeometry* TrackedGeo... )
void	RemoveMeshComponent ( UARTrackedGeometry* TrackedGeo... )
void	SetNativeID ( FGuid NativeID )
void	Update ( UARTrackedGeometry* TrackedGeo... )
void	UpdateVisualization()

Overridden from UActorComponent

		Name	Description
	void	OnUnregister()	Called when a component is unregistered.

Typedefs

Name	Description
FMRMeshDelegate

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss