Status: Archived

This repository has been archived and is no longer maintained.

Sceneform SDK for Android

Copyright (c) 2018 Google Inc. All rights reserved.

Sceneform is a 3D framework with a physically based renderer that's optimizedfor mobile devices and that makes it easy for you to build augmented realityapps without requiring OpenGL.

Choosing the right Sceneform SDK version for your project

As of ARCore release 1.16.0, Google open-sourced the implementation of Sceneformallowing you to extend Sceneform's features and capabilities. As part of the1.16.0 release, support for SFA and SFB assets was removed in favor ofadding glTF support

You can continue to use Sceneform 1.15.0 (or earlier). There is no requirementthat you migrate to Sceneform 1.16.0.

Do not use Sceneform 1.17.0 as that release will not work correctly. (Sceneform1.17.1 can be used, but is otherwise identical to Sceneform 1.15.0.)

Getting started with Sceneform 1.16.0

Use the following steps to include and build the Sceneform 1.16.0 SDK with yourapp:

1. Download sceneform-android-sdk-1.16.0.zip from the Sceneform SDKreleasespage.
2. Extract the sceneformsrc and sceneformux directories into your project'stop-level directory. The resulting directory structure should be similar tothe following:

project
+-- app
|   +-- build.gradle
|   +-- ...
+-- sceneformsrc
+-- sceneformux
+-- build.gradle
+-- settings.gradle
+-- ...

3. Modify your project's settings.gradle to include the Sceneform projects:

include ':app'

// Add these lines:
include ':sceneform'
project(':sceneform').projectDir=new File('sceneformsrc/sceneform')

include ':sceneformux'
project(':sceneformux').projectDir=new File('sceneformux/ux')

4. Finally, add a reference to the Sceneform SDK to your app's build.gradle:

dependencies {
    api project(":sceneformux")
}

To get started with the Sceneform SDK, check out theSceneform sample.

Archived Sceneform 1.15.0 content

Documentation for the Sceneform SDK for Android 1.15.0 is available fromhttps://developers.google.com/sceneform.

• Getting started
• API reference
• Samples

Release notes

The SDK release notes are available on thereleases page.

License

Please see theLICENSEfile.

Brand Guidelines

The Sceneform trademark is a trademark of Google, and is not subject to thecopyright or patent license grants contained in the Apache 2.0-licensedSceneform repositories on GitHub. Any uses of the Sceneform trademark other thanthose permitted in these guidelines must be approved by Google in advance.

Purpose of the Brand Guidelines

These guidelines exist to ensure that the Sceneform project can share itstechnology under open source licenses while making sure that the "Sceneform"brand is protected as a meaningful source identifier in a way that's consistentwith trademark law. By adhering to these guidelines, you help to promote thefreedom to use and develop high-quality Sceneform technology.

Acceptable uses

Because we are open-sourcing the Sceneform technology, you may use the Sceneformtrademark to refer to the project without prior written permission. Examples ofthese approved references include the following:

• To refer to the Sceneform project itself;
• To refer to unmodified source code or other files shared by the Sceneformrepositories on GitHub;
• To accurately identify that your design or implementation is based on, is foruse with, or is compatible with the Sceneform technology.

Examples:

• "[Your Product] for Sceneform."
• "[Your Product] is a fork of the Sceneform project."
• "[Your Product] is compatible with Sceneform."

Usage guidelines

• The Sceneform name may never be used or registered in a manner that wouldcause confusion as to Google's sponsorship, affiliation, or endorsement.
• Don't use the Sceneform name, or a confusingly similar term, as part of yourcompany name, product name, domain name, or social media profile.
• Other than as permitted by these guidelines, the Sceneform name should not becombined with other trademarks, terms, or source identifiers.
• Don't remove, distort or alter the Sceneform name. That includes modifying theSceneform name, for example, through hyphenation, combination, orabbreviation. Do not shorten, abbreviate, or create acronyms out of theSceneform name.
• Don't display the Sceneform name using any different stylization, color, orfont from the surrounding text.
• Don't use the term Sceneform as a verb, or use it in possessive form.

Terms & Conditions

By downloading the Sceneform SDK for Android, you agree that theGoogle APIs Terms of Service governsyour use thereof.

User privacy requirements

You must disclose the use of Google Play Services for AR (ARCore) and how itcollects and processes data, prominently in your application, easily accessibleto users. You can do this by adding the following text on your main menu ornotice screen: "This application runs onGoogle Play Services for AR(ARCore), which is provided by Google LLC and governed by theGoogle Privacy Policy".