Class ARMobilePlatform

The AR mobile base service class.

Inheritance

object

IdentifiableObject

DependencyObject

AttachableObject

Service

XRPlatform

ARMobilePlatform

Implements

IDependencyObject

IGetNativePointers

Inherited Members

XRPlatform.screenContextManager

XRPlatform.AssetsService

XRPlatform.eyeProperties

XRPlatform.headGaze

XRPlatform.eyeGaze

XRPlatform.trackingState

XRPlatform.mirrorDisplay

XRPlatform.msaaSampleCount

XRPlatform.AvailablePointerKeys

XRPlatform.MSAASampleCount

XRPlatform.MirrorDisplay

XRPlatform.NearClipDistance

XRPlatform.FarClipDistance

XRPlatform.MirrorHMDTexture

XRPlatform.HeadGaze

XRPlatform.EyeGaze

XRPlatform.IsEyeGazeValid

XRPlatform.TrackingState

XRPlatform.SpatialAnchorStore

XRPlatform.SpatialInputManager

XRPlatform.RenderableModels

XRPlatform.RenderMirrorTexture

XRPlatform.Passthrough

XRPlatform.CreateSpatialMappingObserver()

XRPlatform.Update()

XRPlatform.RequestEyeGazePermission()

XRPlatform.GetNativePointer(string, out IntPtr)

XRPlatform.InternalUpdate()

XRPlatform.UpdateCameras()

XRPlatform.MirrorDisplayUpdated()

XRPlatform.RefreshMSAA()

Service.OnLoaded()

Service.OnAttached()

Service.OnActivated()

Service.Start()

Service.OnDeactivated()

Service.OnDestroy()

AttachableObject.AttachableStateChanged

AttachableObject.IsEnabled

AttachableObject.State

AttachableObject.IsLoaded

AttachableObject.IsAttached

AttachableObject.IsActivated

AttachableObject.IsStarted

AttachableObject.IsDestroyed

AttachableObject.ShouldBeActivated

AttachableObject.Destroy()

AttachableObject.DependencyBroken()

DependencyObject.Dependencies

DependencyObject.OnDependencyRemoved

IdentifiableObject.Id

IdentifiableObject.IdHasChanged(Guid)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Evergine.ARMobile

Assembly: Evergine.ARMobile.dll

Syntax

public abstract class ARMobilePlatform : XRPlatform, IDependencyObject, IGetNativePointers

Constructors

ARMobilePlatform()

Initializes a new instance of the ARMobilePlatform class.

Declaration

protected ARMobilePlatform()

Fields

cameraProjection

Backing field for CameraProjection property.

Declaration

protected Matrix4x4 cameraProjection

Field Value

Type	Description
Matrix4x4

cameraTransform

Backing field for CameraTransform property.

Declaration

protected Matrix4x4 cameraTransform

Field Value

Type	Description
Matrix4x4

featurePoints

Backing field for FeaturePoints property.

Declaration

protected ARMobileFeaturePoints featurePoints

Field Value

Type	Description
ARMobileFeaturePoints

imagesDataSetProvider

Image DataSet provider.

Declaration

[BindService(true)]
protected DataSetProvider imagesDataSetProvider

Field Value

Type	Description
DataSetProvider

initializationTCS

Initialization task completion source.

Declaration

protected TaskCompletionSource<bool> initializationTCS

Field Value

Type	Description
TaskCompletionSource<bool>

isSupported

Backing field for IsSupported property.

Declaration

protected bool isSupported

Field Value

Type	Description
bool

lightEstimation

Backing field for LightEstimation property.

Declaration

protected ARMobileLightEstimation lightEstimation

Field Value

Type	Description
ARMobileLightEstimation

trackables

Backing field for TrackableItems property.

Declaration

protected ARMobileTrackables trackables

Field Value

Type	Description
ARMobileTrackables

Properties

ActiveCamera

Gets or sets the active camera.

Declaration

public Camera3D ActiveCamera { get; set; }

Property Value

Type	Description
Camera3D

CameraProjection

Gets the camera projection matrix.

Declaration

public Matrix4x4 CameraProjection { get; }

Property Value

Type	Description
Matrix4x4

CameraTransform

Gets the camera transform matrix.

Declaration

public Matrix4x4 CameraTransform { get; }

Property Value

Type	Description
Matrix4x4

Display

Gets the display provided by this XR device.

Declaration

public override Display Display { get; }

Property Value

Type	Description
Display

Overrides

XRPlatform.Display

EnableFaceTracking

Gets or sets a value indicating whether face tracking is enabled.

Declaration

public bool EnableFaceTracking { get; set; }

Property Value

Type	Description
bool

EnableImagesDetection

Gets or sets a value indicating whether image detection is enabled.

Declaration

public bool EnableImagesDetection { get; set; }

Property Value

Type	Description
bool

EyeCount

Gets the number of eyes needed by this device to draw.

Declaration

public override int EyeCount { get; }

Property Value

Type	Description
int

Overrides

XRPlatform.EyeCount

FeaturePoints

Gets the feature points based on a captured video frame in an AR session.

Declaration

public override XRFeaturePoints FeaturePoints { get; }

Property Value

Type	Description
XRFeaturePoints

Overrides

XRPlatform.FeaturePoints

FeaturePointsEnable

Gets or sets a value indicating whether the point cloud is available.

Declaration

public bool FeaturePointsEnable { get; set; }

Property Value

Type	Description
bool

ImagesDataSetFilePath

Gets or sets images data set file path.

Declaration

public string ImagesDataSetFilePath { get; set; }

Property Value

Type	Description
string

InputTracking

Gets the input tracking.

Declaration

public override XRInputTracking InputTracking { get; }

Property Value

Type	Description
XRInputTracking

Overrides

XRPlatform.InputTracking

IsSupported

Gets a value indicating whether the AR is supported.

Declaration

public bool IsSupported { get; }

Property Value

Type	Description
bool

LightEstimation

Gets the estimated scene lighting information based on a captured video frame in an AR session.

Declaration

public override XRLightEstimation LightEstimation { get; }

Property Value

Type	Description
XRLightEstimation

Overrides

XRPlatform.LightEstimation

LightEstimationMode

Gets or sets a value indicating whether the light estimation is available.

Declaration

public XRLightEstimation.Modes LightEstimationMode { get; set; }

Property Value

Type	Description
XRLightEstimation.Modes

PlaneDetection

Gets or sets how flat surfaces are detected in captured images.

Declaration

public XRPlaneDetectionType PlaneDetection { get; set; }

Property Value

Type	Description
XRPlaneDetectionType

TrackPosition

Gets or sets a value indicating whether the position tracking is enabled. On ARCore position tracking cannot be disabled.

Declaration

public bool TrackPosition { get; set; }

Property Value

Type	Description
bool

TrackableItems

Gets the trackables based on a captured video frame in an AR session.

Declaration

public override XRTrackableItems TrackableItems { get; }

Property Value

Type	Description
XRTrackableItems

Overrides

XRPlatform.TrackableItems

WorldAlignment

Gets or sets the world alignment mode that indicates how a scene coordinate system is constructed based on real-world device motion. On ARCore only Gravity mode is supported.

Declaration

public WorldAlignment WorldAlignment { get; set; }

Property Value

Type	Description
WorldAlignment

Methods

HitTest(Vector2, out ARMobileHitTestResult[])

Makes a hit tests over real world and retrieves results.

Declaration

public abstract bool HitTest(Vector2 screenPosition, out ARMobileHitTestResult[] results)

Parameters

Type	Name	Description
Vector2	screenPosition	Screen position (using screen dimensions).
ARMobileHitTestResult[]	results	Hit test results.

Returns

Type	Description
bool	True if at least one result was found; false otherwise.

OnDetach()

Invoked when the object is detached.

Declaration

protected override void OnDetach()

Overrides

Service.OnDetach()

RefreshConfiguration()

Refreshes AR session configuration.

Declaration

protected abstract void RefreshConfiguration()

Reset()

Resets AR session.

Declaration

protected abstract void Reset()

StartTrackingAsync(StartOptions)

Starts AR tracking.

Declaration

public abstract Task<bool> StartTrackingAsync(StartOptions startOptions)

Parameters

Type	Name	Description
StartOptions	startOptions	Start options StartOptions.

Returns

Type	Description
Task<bool>	True if trackings successfully started; false otherwise.

Implements

IDependencyObject

IGetNativePointers

Extension Methods

ReflectionHelper.GetMemberAssembly(object)

ReflectionHelper.GetTypeName(object)