Table of Contents

Class ARSessionFactory

Namespace
easyar
Assembly
EasyAR.Sense.dll

ARSession factory.

public class ARSessionFactory
Inheritance
ARSessionFactory

Methods

AddFrameFilter<Filter>(GameObject, Resources)

Adds a frame filter to ARSession. When adding a dense spatial map, the corresponding resources must be passed in.

public static GameObject AddFrameFilter<Filter>(GameObject sessionObj, ARSessionFactory.Resources resources = null) where Filter : FrameFilter

Parameters

sessionObj
resources

Type Parameters

Filter

AddFrameSource<Source>(GameObject, bool)

Adds a frame source to ARSession.

public static GameObject AddFrameSource<Source>(GameObject sessionObj, bool addToFirst = false) where Source : FrameSource

Parameters

sessionObj
addToFirst

Type Parameters

Source

AddOriginChild(GameObject)

Adds XROriginChildController to the ARSession origin.

public static GameObject AddOriginChild(GameObject origin)

Parameters

origin

CreateController<Controller>(Resources)

Creates a controller. When creating a sparse spatial map, the corresponding resources must be passed in.

public static GameObject CreateController<Controller>(ARSessionFactory.Resources resources = null) where Controller : TargetController

Parameters

resources

Type Parameters

Controller

CreateOrigin()

Creates the ARSession origin when a Unity XR framework such as AR Foundation is not used.

public static GameObject CreateOrigin()

CreateSession()

Creates an empty ARSession.

public static GameObject CreateSession()

CreateSession(ARSessionPreset, Resources)

Creates ARSession. When it includes a dense spatial map, the corresponding resources must be passed in.

public static GameObject CreateSession(ARSessionFactory.ARSessionPreset preset, ARSessionFactory.Resources resources = null)

Parameters

preset
resources

CreateVideoRecorder()

Creates a video recorder.

public static GameObject CreateVideoRecorder()

DefaultName(Type)

Default name of the component.

public static string DefaultName(Type type)

Parameters

type

DefaultName<Component>()

Default name of the component.

public static string DefaultName<Component>()

Type Parameters

Component

IsSession(GameObject)

Whether it is an ARSession.

public static bool IsSession(GameObject sessionObj)

Parameters

sessionObj

SetupFrameFilters(List<GameObject>, ARSessionPreset)

Configures the frame filter to meet preset requirements.

public static void SetupFrameFilters(List<GameObject> filters, ARSessionFactory.ARSessionPreset preset)

Parameters

filters
preset

SetupImageTracker(GameObject, ARSessionPreset)

Configures the image tracker to meet preset requirements.

public static void SetupImageTracker(GameObject filter, ARSessionFactory.ARSessionPreset preset)

Parameters

filter
preset

SetupMegaTracker(GameObject, ARSessionPreset)

Configures the Mega tracker to meet preset requirements.

public static void SetupMegaTracker(GameObject filter, ARSessionFactory.ARSessionPreset preset)

Parameters

filter
preset

SetupObjectTracker(GameObject, ARSessionPreset)

Configures the object tracker to meet preset requirements.

public static void SetupObjectTracker(GameObject filter, ARSessionFactory.ARSessionPreset preset)

Parameters

filter
preset

SortFrameSource(GameObject, FrameSourceSortMethod)

Sorts the frame sources under the ARSession object.

public static void SortFrameSource(GameObject sessionObj, ARSessionFactory.FrameSourceSortMethod method)

Parameters

sessionObj
method