API reference
API reference
Select your platform
No SDKs available
No versions available

AMRUKTrackable Class

Extends AActor
Represents a trackable object in the Mixed Reality Utility Kit. A trackable is a type of object that can be detected and tracked by the runtime, such as keyboards and QR codes. Unlike scene anchors, trackables can move dynamically and may become temporarily untracked if they cannot be seen by the device.
Trackables are instantiated and managed by UMRUKSubsystem. When a new trackable is detected, the subsystem creates an AMRUKTrackable actor and invokes the OnTrackableAdded event.

Constructors

AMRUKTrackable ( ObjectInitializer )
Signature
AMRUKTrackable::AMRUKTrackable(const FObjectInitializer &ObjectInitializer)
Parameters
ObjectInitializer: const FObjectInitializer &

Fields

IsTracked : bool
Whether this trackable is currently being tracked. A trackable may become temporarily untracked if it cannot be seen by the device.
Signature
bool AMRUKTrackable::IsTracked
MarkerPayloadBytes : TArray< uint8 >
The marker's payload as raw bytes. If this trackable is a marker (e.g., a QR Code), this property contains the raw payload bytes. Otherwise, the array is empty.
Signature
TArray<uint8> AMRUKTrackable::MarkerPayloadBytes
MarkerPayloadString : FString
The marker's payload as a string. If this trackable is a marker (e.g., a QR Code) and its payload can be interpreted as a string, this property contains the decoded string. Otherwise, it is empty.
Signature
FString AMRUKTrackable::MarkerPayloadString
The type of payload the trackable carries.
Signature
EMRUKMarkerPayloadType AMRUKTrackable::PayloadType
PlaneBoundary2D : TArray< FVector2D >
If the trackable has a plane attached to it, this represents the boundary of it in local coordinate space.
Signature
TArray<FVector2D> AMRUKTrackable::PlaneBoundary2D
PlaneBounds : FBox2D
If the trackable has a plane attached to it, this represents the bounds of that plane in local coordinate space.
Signature
FBox2D AMRUKTrackable::PlaneBounds
TrackableType : EMRUKTrackableType
The type of this trackable (e.g., Keyboard, QRCode)
Signature
EMRUKTrackableType AMRUKTrackable::TrackableType
VolumeBounds : FBox
If the trackable has a volume attached to it, this represents the bounds of that volume in local coordinate space.
Signature
FBox AMRUKTrackable::VolumeBounds

Member Functions

UpdateProperties ( Transform , Type , bIsTracked , Plane , Boundary2D , Volume , MarkerPayloadType , PayloadString , PayloadBytes )
Signature
void AMRUKTrackable::UpdateProperties(const FTransform &Transform, EMRUKTrackableType Type, bool bIsTracked, const FBox2d &Plane, TArray< FVector2D > Boundary2D, const FBox3d &Volume, EMRUKMarkerPayloadType MarkerPayloadType, FString PayloadString, TArray< uint8 > PayloadBytes)
Parameters
Transform: const FTransform &
bIsTracked: bool
Plane: const FBox2d &
Boundary2D: TArray< FVector2D >
Volume: const FBox3d &
MarkerPayloadType: EMRUKMarkerPayloadType
PayloadString: FString
PayloadBytes: TArray< uint8 >
Returns
void