- Changelog
- Migration Notes
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
Version 4.0.6 - 2018-10-09
Added
- SDK is now compatible with XCode 10
Version 4.0.3 - 2018-09-04
Added
- JWT decoding library
- Yards as Unit
- Display VirtualObject dimensions while manipulating
Changed
- replace AFNetworking with Alamofire
Version 3.1.19- 2018-09-26
Fixed
- 3D Model loading forever when referencing a large number of assets
Version 3.1.18- 2018-09-04
Added
- Dimensions display when manipulating objects
- New API point on AGTAugmentPlayer3DContent to get the list of unplaced models
- 3D model synchronization status is now accessible from the SDK
Fixed
- Small or far objects can be easily picked now
- Models are placed where the user taps in Place
- Material thumbnail size is now limited to 256 x 256
- Camera perspective issues in Place
- The view of a Place adapts according to the device screen size and orientation
- Focus square is displayed as soon as features are detected by ARKit
- A model can be placed even if it hasn’t been full loaded yet.
- Create missing place directory
Changed
- Renamed
addProductToAugmentPlayer:downloadProgress:operationCompletionWithModelIdentifier
toaddProductToAugmentPlayer:downloadProgress:completion
Version 2.1.14- 2018-09-26
Fixed
- 3D Model loading forever when referencing a large number of assets
Version 2.1.1
Changed
- Updated general SDK core
Version 2.0.4
Removed
[AGTProduct unfoundProduct]
case has been replaced withnil
for simplicity
Version 2.0.3
Fixed
- Fix hidden target when model is not displayed yet
- Fixed a gesture conflict between pan and tap
- Fixed models being outside their bounding box
Version 2.0.2
Added
- New interaction callback for adding, rotating and moving a model
AGTAugmentPlayerModelGestureDelegate
Changed
AGTViewDelegate
is now deprecated and will be removed in a few versions
Version 2.0.1
Changed
- Add missing podspec dependency
Version 2.0.0
Added
- ARKit tracking strategy to all compatible devices
- Gyroscope and universal tracker automatic fallback for non-ARKit capable devices
- Tracking events callback
Removed
[AGTProduct unfoundProduct]
case has been replaced withnil
for simplicity
Migration Notes
Migrating from v3.X to v4.X
A few changes to the interface happened on 4.0 release:
Class prefix
All code base gas been migrated to Swift, and to follow current conventions,
AGT
prefix has been removed from all classes. AGTAugmentSDK
is now AugmentSDK
,
AGTAugmentPlayer
is now AugmentPlayer
, and so on. AGTView
has also been renamed
AugmentPlayerView
.
NB. Classes and protocols are exported to Objective-C with AGT
to avoid name
collisions.
AugmentPlayer
lifecycle
Previously, your augmentSDK
instance would instantiate one player for the whole
life duration of your app. This is no more, and it is now your responsibility to
create a player by calling augmentSDK.augmentPlayer()
and to retain the player
instance while you need it. This largely improve overall memory consumption.
Note that resume()
and pause()
are not returning an error anymore but throws instead.
For Objective-C, please note that resume:
and pause:
are not returning an error
anymore but take a pointer to an error instead, just like any Cocoa API.
AugmentSDK
shorthands
Methods addModel3D
and addProduct
from AugmentSDK
have been changed to reflect
previously mentioned AugmentPlayer
changes. You now have to pass your own player
to those methods.
WARNING: those methods do not return anything anymore.
Networking
AGTTaskContainer
has been removed completely, addModel3D
and addProduct
are not cancellable anymore. Although, since AugmentPlayer
can now be deleted,
all related networking tasks will automatically be cancelled on deletion.
Migrating from v2.X to v3.X
Migration requires minor changes to SDK user’s codebase: callback parameter operationCompletionWithModelIdentifier
has been renamed to completion
. addProductToAugmentPlayer:downloadProgress:operationCompletionWithModelIdentifier
is now addProductToAugmentPlayer:downloadProgress:completion
.
Native libraries have been removed, reducing framework size and allowing us to enable bitcode.
Migrating to v1.X to v2.0
Migration is seamless, you just have to update AugmentPlayerSDK pod version.
Note: Triggered animations and animation scenarios are not activated while using ARKit system. No animation is played in this mode. Triggered animations and animation scenarios are still activated when using gyroscope and tracker strategies.