ARAssembly Class¶

Description¶

Assembly of AR components. It implements one typical assemble strategy for all EasyAR Sense components. Inherit this class and override some methods can make a more customized assembly.

                                          +-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .-- .--+
                                          |                                                                                                                  .
                                          .                                 +---------------------------------------------------------------+                |
                                          |                                 |                                                               |                .
                                          .                                 |                       + -> ObjectTracker - - - - +            |                |
                                          |                                 v                       '                          '            |                .
                                          .                        +--> i2FAdapter --> fbFrameFork - - > ImageTracker - - - +  '            |                |
                                          |                        |                                                        '  '            |                .
                                          v                        |                                                        v  v            |                |
FrameSource --> (FrameRecorder) --> iFrameThrottler --> iFrameFork --> i2OAdapter ------------------------------------> oFrameJoin --> oFrameFork --> oFrameBuffer ~~> o
                                                                   '                                                        ^  ^
                                                                   '                                                        '  '
                                                                   + - - - - - - - - - - - - - - - - - > SparseSpatialMap - +  '
                                                                   '                                                           '
                                                                   + - - - - - - - - - - - - - - - - - > SurfaceTracker - - - -+
                                                                   '
                                                                   + - - - - - - - - - - - - - - - - - > DenseSpatialMap ~ ~ > o
                                                                   '
                                                                   + - - - - - - - - - - - - - - - - - > CloudRecognizer ~ ~ > o

Enums¶

public enum ARAssembly.AssembleMode

Assemble mode.

Fields¶

Camera¶

C#: public Camera Camera

Camera in the virtual world in reflection of real world camera device, its projection matrix and transform will be set to reflect the real world camera.

It will be set to Camera .main when assembling if ARSession.AssembleMode == ARAssembly.AssembleMode.Auto .

CameraRoot¶

C#: public Transform CameraRoot

Transform of root node of all Camera s used for AR rendering.

It will be set to ARAssembly.Camera Transform when assembling if ARSession.AssembleMode == ARAssembly.AssembleMode.Auto .

RenderCameras¶

C#: public List< RenderCameraController > RenderCameras

RenderCameraController list.

It will be set to the list of RenderCameraController get from children of the ARSession GameObject when assembling if ARSession.AssembleMode == ARAssembly.AssembleMode.Auto .

FrameSource¶

C#: public FrameSource FrameSource

Frame source.

It will be set to FrameSource get from children of the ARSession GameObject when assembling if ARSession.AssembleMode == ARAssembly.AssembleMode.Auto .

FrameRecorder¶

C#: public FrameRecorder FrameRecorder

Frame recorder.

It will be set to FrameSource get from children of the ARSession GameObject when assembling if ARSession.AssembleMode == ARAssembly.AssembleMode.Auto .

FrameFilters¶

C#: public List< FrameFilter > FrameFilters

FrameFilter list.

It will be set to the list of FrameFilter get from children of the ARSession GameObject when assembling if ARSession.AssembleMode == ARAssembly.AssembleMode.Auto .

Properties¶

Ready¶

C#: public bool Ready { get; }

The assembly can be used.

RequireWorldCenter¶

C#: public bool RequireWorldCenter { get; }

If WorldRootController is required by the assembly.

OutputFrame¶

C#: public Optional< OutputFrame > OutputFrame { get; }

Output frame.

ExtraBufferCapacity¶

C#: public int ExtraBufferCapacity { get; set; }

Extra device buffer capacity. When you hold a OutputFrame/InputFrame or image from InputFrame for more than one render frame, you should increase this value by one.

Display¶

C#: public IDisplay Display { get; }

Internal use only. Display information used by the assembly.

Methods¶

Dispose¶

C#: public virtual void Dispose()

Dispose resources.

ResetBufferCapacity¶

C#: public void ResetBufferCapacity()

Reset buffer capacity.

GetBufferRequirement¶

C#: protected int GetBufferRequirement()

Get buffer requirement.

GetFrameFilterCount¶

C#: protected int GetFrameFilterCount()

Get FrameFilter number of certain type.