Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/google-ar/sceneform-android-sdk
Sceneform SDK for Android
https://github.com/google-ar/sceneform-android-sdk
3d-graphics android arcore java
Last synced: 11 days ago
JSON representation
Sceneform SDK for Android
- Host: GitHub
- URL: https://github.com/google-ar/sceneform-android-sdk
- Owner: google-ar
- License: apache-2.0
- Archived: true
- Created: 2018-05-08T02:35:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-28T00:37:02.000Z (over 4 years ago)
- Last Synced: 2024-08-02T07:06:43.026Z (3 months ago)
- Topics: 3d-graphics, android, arcore, java
- Language: Java
- Homepage: https://developers.google.com/sceneform/develop/
- Size: 55.9 MB
- Stars: 1,225
- Watchers: 95
- Forks: 604
- Open Issues: 565
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Status: Archived
This repository has been archived and is no longer maintained.![status: inactive](https://img.shields.io/badge/status-inactive-red.svg)
Sceneform SDK for Android
=========================
Copyright (c) 2018 Google Inc. All rights reserved.Sceneform is a 3D framework with a physically based renderer that's optimized
for mobile devices and that makes it easy for you to build augmented reality
apps 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 Sceneform
allowing you to extend Sceneform's features and capabilities. As part of the
1.16.0 release, support for `SFA` and `SFB` assets was removed in favor of
adding `glTF` supportYou can continue to use Sceneform 1.15.0 (or earlier). There is no requirement
that you migrate to Sceneform 1.16.0.Do not use Sceneform 1.17.0 as that release will not work correctly. (Sceneform
1.17.1 can be used, but is otherwise identical to Sceneform 1.15.0.)
Sceneform SDK
Description
Sceneform SDK
versions 1.0.0 - 1.15.0
- Closed source
- Included in your project as an external Gradle dependency
-
FBX
andOBJ
files can be converted to
Sceneform'sSFA
andSFB
Sceneform
formats
Sceneform SDK
version 1.16.0
- Open source
- Built alongside an application as a Gradle module
-
Supports glTF instead of
SFA
andSFB
Sceneform formats
Sceneform SDK
version 1.17.0
Do not use
Sceneform SDK
version 1.17.1
Identical to version 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 your
app:
1. Download `sceneform-android-sdk-1.16.0.zip` from the Sceneform SDK
[releases](https://github.com/google-ar/sceneform-android-sdk/releases/tag/v1.16.0)
page.
2. Extract the `sceneformsrc` and `sceneformux` directories into your project's
top-level directory. The resulting directory structure should be similar to
the 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 the
[Sceneform sample](https://github.com/google-ar/sceneform-android-sdk/tree/master/samples/gltf/app).
## Archived Sceneform 1.15.0 content
Documentation for the Sceneform SDK for Android 1.15.0 is available from
https://developers.google.com/sceneform.
* [Getting started](https://developers.google.com/sceneform/develop/getting-started)
* [API reference](https://developers.google.com/sceneform/reference)
* [Samples](https://github.com/google-ar/sceneform-android-sdk/tree/v1.15.0/samples)
## Release notes
The SDK release notes are available on the
[releases](https://github.com/google-ar/sceneform-android-sdk/releases) page.
## License
Please see the
[LICENSE](https://github.com/google-ar/sceneform-android-sdk/blob/master/LICENSE)
file.
## Brand Guidelines
The Sceneform trademark is a trademark of Google, and is not subject to the
copyright or patent license grants contained in the Apache 2.0-licensed
Sceneform repositories on GitHub. Any uses of the Sceneform trademark other than
those 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 its
technology under open source licenses while making sure that the "Sceneform"
brand is protected as a meaningful source identifier in a way that's consistent
with trademark law. By adhering to these guidelines, you help to promote the
freedom to use and develop high-quality Sceneform technology.
### Acceptable uses
Because we are open-sourcing the Sceneform technology, you may use the Sceneform
trademark to refer to the project without prior written permission. Examples of
these approved references include the following:
* To refer to the Sceneform project itself;
* To refer to unmodified source code or other files shared by the Sceneform
repositories on GitHub;
* To accurately identify that your design or implementation is based on, is for
use 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 would
cause confusion as to Google's sponsorship, affiliation, or endorsement.
* Don't use the Sceneform name, or a confusingly similar term, as part of your
company name, product name, domain name, or social media profile.
* Other than as permitted by these guidelines, the Sceneform name should not be
combined with other trademarks, terms, or source identifiers.
* Don't remove, distort or alter the Sceneform name. That includes modifying the
Sceneform name, for example, through hyphenation, combination, or
abbreviation. Do not shorten, abbreviate, or create acronyms out of the
Sceneform name.
* Don't display the Sceneform name using any different stylization, color, or
font 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 the
[Google APIs Terms of Service](https://developers.google.com/terms/) governs
your use thereof.
## User privacy requirements
You must disclose the use of Google Play Services for AR (ARCore) and how it
collects and processes data, prominently in your application, easily accessible
to users. You can do this by adding the following text on your main menu or
notice screen: "This application runs on
[Google Play Services for AR](https://play.google.com/store/apps/details?id=com.google.ar.core)
(ARCore), which is provided by Google LLC and governed by the
[Google Privacy Policy](https://policies.google.com/privacy)".