AR Base API

ARMOD API Unit

Description

AR MOD API unit will be to create a AR MOD API for creator to accessing the AR-MOD SDK features.

Parameters

Connection
Description
Input Trigger
Start invoke this unit logic
Output Trigger
Logical execution ends will perform the next operation
Project Name
Your AR-Experience name
API
Help creator to accessing the AR-MOD SDK features

AR Algorithm Life Unit

Description

Controll and addition AR algorithm, It will allow multiple algorithms to be mixed.

Parameters

Connection
Description
Input Trigger
Start invoke this unit logic
Output Trigger
Logical execution ends will perform the next operation
API
Help creator to accessing the AR-MOD SDK features
Data
The AR life controller data.

Check AR Availability Unit

Description

Check whether the current device supports ARKit or ARCore

Parameters

Connection
Description
Input Trigger
Start invoke this unit logic
Output Trigger
Logical execution ends will perform the next operation
API
Help creator to accessing the AR-MOD SDK features
True
This device is support AR-MOD
False
This device is not support AR-MOD

Check Feature Availability Unit

Description

Check AR features are support on current device

Parameters

Connection
Description
Input Trigger
Start invoke this unit logic
Output Trigger
Logical execution ends will perform the next operation
API
Help creator to accessing the AR-MOD SDK features
Feature Name
AR Feature's name
True
This device is support this feature
False
This device is not support feature

ARRaycast

Description

Cast a ray from a point in screen space against trackables, i.e., detected features such as planes.
Parameters
Param
Type
Description
_api
API
AR-MOD SDK API
_screenPoint
Vector3
The point, in device screen pixels, from which to cast.
_trackableType
TrackableTypeEnum
The types of trackables to cast against.
_callback
Action<Pose>
Contents are replaced with the raycast results, if successful.

MakeContentAppearAt Unit

This does not move the content; instead, it moves and orients the ARCamera. such that the content appears to be at the raycast hit position.

Description

Makes content appear to have orientation rotation relative to the Camera.

Parameters

Param
Type
Description
_api
API
AR-MOD SDK API
_content
Transform
Your content gameObject's transform
_position
Vector3
Your content position
_rotation
Quaternion
Your content rotation

Exit AR Unit

Description

Exit the AR-MOD

Parameters

Connection
Description
Input Trigger
Start invoke this unit logic
API
Help creator to accessing the AR-MOD SDK features

Resize AR World Unit

Description

Resize current AR-Experience world scale at runtime.AR World Scale scales the size of the current AR experience scene according to the size value set by the developer to get a better visual effect and experience.
Connection
Description
Input Trigger
Start invoke this unit logic
Output Trigger
Logical execution ends will perform the next operation
API
Help creator to accessing the AR-MOD SDK features
The size value of the AR experience scene world at runtime. Unity 1 unit is equal to 1 meter in the real world. Default scale size is 1.

Set Focus Algorithm State Unit

Description

Turn on and off the Focus algorithm
Connection
Description
Input Trigger
Start invoke this unit logic
Out Trigger
Logical execution ends will perform the next operation
API
Help creator to accessing the AR-MOD SDK features
Active
True:Turn on,False:Turn off

Stick Object Unit

Description

Place the virtual object into the world
Param
Type
Description
_anchorNotification
Data sent to the anchor manager

Try Acquire AR Occlusion Frame Unit

Description

Get current AR Occlusion Frame
Need add AROcclusion feature and Device support

Return

AR Occlusion Texture

Parameters

Connection
Description
Input Trigger
Start invoke this unit logic
Out Trigger
Logical execution ends will perform the next operation
API
Help creator to accessing the AR-MOD SDK features
Data
The Try acquire AR Occlusion Frame data

Try Acquire Current Frame Unit

Description

Get current AR frame
It maybe null, plz attention

Return

AR Frame's texture

Parameters

Connection
Description
Input Trigger
Start invoke this unit logic
Out Trigger
Logical execution ends will perform the next operation
API
Help creator to accessing the AR-MOD SDK features
Data
The Try acquire AR Frame data

Try Acquire Light Estimate Unit

Description

Get light estimate value
It maybe null, plz attention

Return

Unity Light component

Parameters

Connection
Description
Input Trigger
Start invoke this unit logic
Out Trigger
Logical execution ends will perform the next operation
API
Help creator to accessing the AR-MOD SDK features
Data
The Try acquire light estimate

ARRaycast

Description

Also known as hit testing, ray casting allows you to determine where a ray (defined by an origin and direction) intersects with a trackable. The current ray cast interface only tests against planes and points in the point cloud. The ray cast interface is similar to the one in the Unity Physics module, but since AR trackables don't necessarily have a presence in the physics world, AR MOD provides a separate interface.

Parameters

Connection
Description
Input Trigger
Start invoke this unit logic
Out Trigger
Logical execution ends will perform the next operation
API
Help creator to accessing the AR-MOD SDK features
EventName
Called after raycast hit
Trackable Type
Which type will be raycast hit

Make Content Appear At

Description

Makes content appear to have orientation rotation relative to the Camera.

Parameters

Connection
Description
Input Trigger
Start invoke this unit logic
Out Trigger
Logical execution ends will perform the next operation
API
Help creator to accessing the AR-MOD SDK features
Position
AR Raycast hit position
Rotation
AR Raycast hit rotation
Content Transform
Where the camera will move

Last modified 12d ago