updates documentation and deletes unneccesary files

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.4.2
+
+* Updates documentation
+* Deletes unnecessary files
+
 ## 0.4.1
 
 * Adds External Model Management Example: A firebase database is used to store a list of 3D models (name, preview image, URI of the file location in a github repo). These models can be scrolled through and selected from in the example and can then be placed into the scene, uploaded through the Google Cloud Anchor API and downloaded on any other device with the app installed. The downloading user does not need to have the model "pre-installed", it is downloaded on the first occasion.

lib/datatypes/hittest_result_types.dart

@@ -1,3 +1,4 @@
+/// Determines which types of hit results the plugin supports
 enum ARHitTestResultType {
   undefined,
   plane,

lib/managers/ar_anchor_manager.dart

@@ -7,7 +7,7 @@ typedef AnchorUploadedHandler = void Function(ARAnchor arAnchor);
 typedef AnchorDownloadedHandler = ARAnchor Function(
     Map<String, dynamic> serializedAnchor);
 
-/// Manages the session configuration, parameters and events of an [ARView]
+/// Handles all anchor-related functionality of an [ARView], including configuration and usage of collaborative sessions
 class ARAnchorManager {
   /// Platform channel used for communication from and to [ARAnchorManager]
   late MethodChannel _channel;
@@ -32,6 +32,7 @@ class ARAnchorManager {
     }
   }
 
+  /// Activates collaborative AR mode (using Google Cloud Anchors)
   initGoogleCloudAnchorMode() async {
     _channel.invokeMethod<bool>('initGoogleCloudAnchorMode', {});
   }
@@ -107,6 +108,7 @@ class ARAnchorManager {
     }
   }
 
+  /// Try to download anchor with the given ID from the Google Cloud Anchor API and add it to the scene
   Future<bool?> downloadAnchor(String cloudanchorid) async {
     print("TRYING TO DOWNLOAD ANCHOR WITH ID " + cloudanchorid);
     _channel

lib/managers/ar_object_manager.dart

@@ -5,14 +5,15 @@ import 'package:flutter/services.dart';
 // Type definitions to enforce a consistent use of the API
 typedef NodeTapResultHandler = void Function(List<String> nodes);
 
-/// Manages the all actions related to 3D objects (=Nodes) of an [ARView]
+/// Manages the all node-related actions of an [ARView]
 class ARObjectManager {
   /// Platform channel used for communication from and to [ARObjectManager]
   late MethodChannel _channel;
 
   /// Debugging status flag. If true, all platform calls are printed. Defaults to false.
   final bool debug;
 
+  /// Callback function that is invoked when the platform detects a tap on a node
   NodeTapResultHandler? onNodeTap;
 
   ARObjectManager(int id, {this.debug = false}) {
@@ -51,6 +52,7 @@ class ARObjectManager {
     return Future.value();
   }
 
+  /// Sets up the AR Object Manager
   onInitialize() {
     _channel.invokeMethod<void>('init', {});
   }

lib/models/ar_anchor.dart

@@ -4,7 +4,7 @@ import 'package:ar_flutter_plugin/utils/json_converters.dart';
 import 'package:vector_math/vector_math_64.dart';
 import 'package:flutter/widgets.dart';
 
-/// Object specifying a position and rotation in the AR environment
+/// Object attached to a tracked physical entity of the AR environment (can be initialized with a world transformation)
 abstract class ARAnchor {
   ARAnchor({
     required this.type,
@@ -19,6 +19,7 @@ abstract class ARAnchor {
   /// Will be autogenerated if not defined.
   final String name;
 
+  /// Constructs an [ARAnchor] from a serialized anchor object
   factory ARAnchor.fromJson(Map<String, dynamic> arguments) {
     final type = arguments['type'];
     switch (type) {
@@ -31,6 +32,7 @@ abstract class ARAnchor {
   /// Defines the anchor’s rotation, translation and scale in world coordinates.
   final Matrix4 transformation;
 
+  /// Serializes an [ARAnchor]
   Map<String, dynamic> toJson();
 }
 
@@ -64,6 +66,7 @@ class ARPlaneAnchor extends ARAnchor {
   Map<String, dynamic> toJson() => aRPlaneAnchorToJson(this);
 }
 
+/// Constructs an [ARPlaneAnchor] from a serialized PlaneAnchor object
 ARPlaneAnchor aRPlaneAnchorFromJson(Map<String, dynamic> json) {
   return ARPlaneAnchor(
     transformation:
@@ -78,6 +81,7 @@ ARPlaneAnchor aRPlaneAnchorFromJson(Map<String, dynamic> json) {
   );
 }
 
+/// Serializes an [ARPlaneAnchor]
 Map<String, dynamic> aRPlaneAnchorToJson(ARPlaneAnchor instance) {
   return <String, dynamic>{
     'type': instance.type.index,

lib/models/ar_hittest_result.dart

@@ -5,7 +5,7 @@ import 'package:ar_flutter_plugin/utils/json_converters.dart';
 import 'package:json_annotation/json_annotation.dart';
 import 'package:vector_math/vector_math_64.dart';
 
-/// A result of an intersection found during a hit-test.
+/// A result (type, distance from the camera, world transformation) of an intersection found during a hit-test.
 class ARHitTestResult {
   ARHitTestResult(
     this.type,
@@ -23,12 +23,15 @@ class ARHitTestResult {
   /// relative to the world.
   final Matrix4 worldTransform;
 
+  /// Instantiates am [ARHitTestResult] from a serialized ARHitTestResult
   static ARHitTestResult fromJson(Map<String, dynamic> json) =>
       _$ARHitTestResultFromJson(json);
 
+  /// Serializes the [ARHitTestResult]
   Map<String, dynamic> toJson() => _$ARHitTestResultToJson(this);
 }
 
+/// Instantiates am [ARHitTestResult] from a serialized ARHitTestResult
 ARHitTestResult _$ARHitTestResultFromJson(Map<String, dynamic> json) {
   return ARHitTestResult(
     const ARHitTestResultTypeConverter().fromJson(json['type'] as int),
@@ -37,6 +40,7 @@ ARHitTestResult _$ARHitTestResultFromJson(Map<String, dynamic> json) {
   );
 }
 
+/// Serializes the [ARHitTestResult]
 Map<String, dynamic> _$ARHitTestResultToJson(ARHitTestResult instance) {
   final val = <String, dynamic>{};
 
@@ -54,10 +58,12 @@ Map<String, dynamic> _$ARHitTestResultToJson(ARHitTestResult instance) {
   return val;
 }
 
+/// Helper class to convert the type of an [ARHitTestResult] from its integer representation to the [ARHitTestResultType] and vice versa
 class ARHitTestResultTypeConverter
     implements JsonConverter<ARHitTestResultType, int> {
   const ARHitTestResultTypeConverter();
 
+  /// Converts the type of an [ARHitTestResult] from its integer representation to the [ARHitTestResultType]
   @override
   ARHitTestResultType fromJson(int json) {
     switch (json) {
@@ -70,6 +76,7 @@ class ARHitTestResultTypeConverter
     }
   }
 
+  /// Converts the type of an [ARHitTestResult] from its [ARHitTestResultType] to an integer representation
   @override
   int toJson(ARHitTestResultType object) {
     switch (object) {

lib/models/ar_node.dart

@@ -111,8 +111,7 @@ class ARNode {
   }
 }
 
-// Helper functions
-
+/// Helper function to create a Matrix4 from either a given matrix or from position, scale and rotation relative to the origin
 Matrix4 createTransformMatrix(Matrix4? origin, Vector3? position,
     Vector3? scale, Vector4? rotation, Vector3? eulerAngles) {
   final transform = origin ?? Matrix4.identity();

lib/widgets/ar_view.dart

@@ -32,6 +32,7 @@ abstract class PlatformARView {
       @required ARViewCreatedCallback arViewCreatedCallback,
       @required PlaneDetectionConfig planeDetectionConfig});
 
+  /// Callback function that is executed once the view is established
   void onPlatformViewCreated(int id);
 }