arkit_plugin 0.5.1

Flutter Android iOS

Flutter Plugin for ARKit - Apple's augmented reality (AR) development platform for iOS mobile devices.

arkit_flutter_plugin #

Codemagic build status flutter awesome pub package

Note: ARKit is only supported by mobile devices with A9 or later processors (iPhone 6s/7/SE/8/X, iPad 2017/Pro) on iOS 11 and newer. For some features iOS 12 is required.

Usage #

Depend on it #

Follow the installation instructions from Dart Packages site.

Update Info.plist #

The plugin use native view from ARKit, which is not yet supported by default. To make it work add the following code to Info.plist:


ARKit uses the device camera, so do not forget to provide the NSCameraUsageDescription. You may specify it in Info.plist like that:

    <string>Describe why your app needs AR here.</string>

Write the app #

The simplest code example:

import 'package:flutter/material.dart';
import 'package:arkit_plugin/arkit_plugin.dart';
import 'package:vector_math/vector_math_64.dart';

void main() => runApp(MaterialApp(home: MyApp()));

class MyApp extends StatefulWidget {
  _MyAppState createState() => _MyAppState();

class _MyAppState extends State<MyApp> {
  ARKitController arkitController;

  void dispose() {

  Widget build(BuildContext context) => Scaffold(
      appBar: AppBar(title: const Text('ARKit in Flutter')),
      body: ARKitSceneView(onARKitViewCreated: onARKitViewCreated));

  void onARKitViewCreated(ARKitController arkitController) {
    this.arkitController = arkitController;
    final node = ARKitNode(
        geometry: ARKitSphere(radius: 0.1), position: Vector3(0, 0, -0.5));



Examples #

I would highly recommend to review the sample from the Example folder. You may find a couple of samples in the Example folder of the plugin. Some samples rely on this Earth image

Hello WorldThe simplest scene with different geometries.codetwitter
EarthSphere with an image texture and rotation animation.codetwitter
TapSphere which handles tap event.codetwitter
Plane DetectionDetects horizontal plane.codetwitter
Distance trackingDetects horizontal plane and track distance on it.codetwitter
MeasureMeasures distancescodetwitter
PhysicsA sphere and a plane with dynamic and static physicscodetwitter
Image DetectionDetects Earth photo and puts a 3D object near it.codetwitter
Network Image DetectionDetects Mars photo and puts a 3D object near it.code
Custom LightHello World scene with a custom light spot.code
Light EstimationEstimates and applies the light around you.codetwitter
Custom ObjectPlace custom object on plane.codetwitter
OcclusionSpheres which are not visible after horizontal and vertical planes.codetwitter
ManipulationCustom objects with pinch and rotation events.codetwitter
Face TrackingFace mask sample.codetwitter
Panorama360 photo.codetwitter
Custom AnimationCustom object animation. Port of
Widget ProjectionFlutter widgets in ARcodetwitter

If you prefer video here is a playlist with "AR in Flutter" videos: AR in Flutter videos

UX advice #

You might want to check the device capabilities before establishing an AR session. Review the Check Support sample for the implementation details.

Before you go to AppStore #

The plugin supports TrueDepth API. In case you didn't use it, your app will be rejected by Apple. Hence you need to remove any TrueDepth functionality by modifying your Podfile file

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      ... # Here are some configurations automatically generated by flutter

      config.build_settings['OTHER_SWIFT_FLAGS'] = '-DDISABLE_TRUEDEPTH_API'

Contributing #

If you find a bug or would like to request a new feature, just open an issue. Your contributions are always welcome!

pub points

Flutter Plugin for ARKit - Apple's augmented reality (AR) development platform for iOS mobile devices.

Repository (GitHub)
View/report issues


API reference





flutter, json_annotation, meta, vector_math


Packages that depend on arkit_plugin