Configuration¶

The two most important components of this package are the AR Placement Guide* and the Placeable Generator. Both need to be on the same GameObject as the XR Origin. It is best to check the sample scene for a working example.

These two components contain most of the settings. In general your hierachy should look something like this:

If you are not using the sample scene as a starting point, you will have to add the AR Placement Guide and the Placeable Generator to the XR Origin GameObject. As well as AR Kit Coaching Overlay to the AR Session GameObject (though this is optional as it is an iOS only feature).

Placeable Generator¶

Using your own model/prefab¶

By replacing the Prefab on the Placeable Generator in the inspector you can use your own prefab. Just drag in your model and everything should work out of the box. The transform inside the prefab will be preserved. Use the scale setting to change the initial scale of the object. It can still be resized during run-time using gestures.

This prefab should ideally only have a single MeshRenderer and a MeshFilter attached to it.

If your model is floating too high or is inside the ground, try to adjust the "Pivot Location" setting to match the pivot point position of your model.

A collider will also be added automatically. If you are unsure how to create a prefab, see the section below. If you are looking for an example prefab check out the sample one.

Creating a prefab¶

If you have a model that you want to use, you can create a prefab from it. First import your model into Unity. Then select it in the Hierarchy and drag it into the Project window. This will create a prefab from the model. This prefab can then be used in the Placeable Generator. Just select the XR Origin GameObject and drag the prefab into the Prefab field.

More info on creating prefabs.

Advanced parameters¶

Min Scale¶

The smallest possible scale for the placeable when using the pinch gesture. If the scale is less than or equal to this value, all instructions to reduce the scale of the placeable will be ignored.

Transition speed¶

The speed at which the placeable transitions between surfaces of different heights.

Higher numbers result in shorter transition times.

Transition Threshold¶

The minimum distance for a transition to be triggered. If the distance to the target position is less than this value, the movement will be instantaneous.

Increase this value if the placeable lags behind when dragged with a finger gesture.

Higher values result in fewer transitions.

Pivot type¶

The y-location of the pivot point in your custom model.

Options are centre and bottom, default is centre.

AR Placement Guide¶

Enable scaling¶

Enable scaling of the placeable using a pinch gesture.

Enable rotation¶

Enable rotation of the placeable by rotating the first 2 fingers that touch the screen around each other.

Advanced parameters¶

Debug Mode¶

Enables additional logging and visual debugging tools.

Rotation Speed¶

Sets the multiplier for translating finger rotation into placeable rotation.

AR Plane Prefab¶

The visual representation for planes recognised by the AR system. Uses the default preset if not set.