This repository has been archived by the owner on Apr 3, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
648 additions
and
85 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Amazon Sumerian Augmented Reality Tools<a name="assets-artools"></a> | ||
|
||
Sumerian provides a template, assets, and sample project that you can use to develop augmented reality \(AR\) applications for iOS devices\. | ||
|
||
The **Augmented Reality** scene template is available in the dashboard\. Use it as a starting point for your augmented reality scene\. | ||
|
||
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/templates-ar.png) | ||
|
||
The scene includes the following resources\. | ||
|
||
+ **AR Camera** – the main camera, with a script that maps it to the device's camera\. | ||
|
||
+ **AR Camera Control** – a script that uses the Sumerian engine [AR System](https://docs.sumerian.amazonaws.com/engine/latest/docs/ArSystem.html) to access the device's augmented reality API\. You can view this script in the text editor\. | ||
|
||
+ **ARAnchor** – an empty entity that is used by the augmented reality app to anchor objects in the scene to the real world\. | ||
|
||
You can construct an augmented reality scene from this template by adding models and making them children of the **ARAnchor** entity\. Publish the scene, and then use the sample AR Kit project to build an app that uses it\. | ||
|
||
The sample project, [amazon\-sumerian\-arkit\-starter\-app](https://github.com/aws-samples/amazon-sumerian-arkit-starter-app), is an XCode project with a Swift app that loads a scene created with the augmented reality template\. Replace the [scene URL in the view controller](https://github.com/aws-samples/amazon-sumerian-arkit-starter-app/blob/master/SumerianARKitStarter/ViewController.swift#L20) with the URL of your published scene, build the app, and then run it on a compatible iOS device to see it in action\. | ||
|
||
See [Augmented Reality Using Sumerian and ARKit](https://docs.sumerian.amazonaws.com/tutorials/create/intermediate/augmented-reality-using-sumerian-arkit/) for a tutorial that uses these assets\. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Amazon Sumerian Hosts<a name="assets-hosts"></a> | ||
|
||
A host is a asset provided by Sumerian that has built in animation, speech, and behavior for interacting with users\. Use hosts to engage users in conversation and convey information\. | ||
|
||
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/hosts.png) | ||
|
||
**To add a host to your scene** | ||
|
||
1. Open a scene in the Sumerian editor\. | ||
|
||
1. Choose **Import assets**\. | ||
|
||
1. Choose a host\. | ||
|
||
+ **Cristine** | ||
|
||
+ **Preston** | ||
|
||
1. Choose **Add**\. | ||
|
||
1. Drag the host entity from the assets panel onto the canvas\. | ||
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assets-host.png) | ||
|
||
All of the host's meshes, materials, animations, and scripts are bundled into a single entity with three configurable components\. | ||
|
||
+ **Transform** – the host's location relative to the scene or its parent entity\. | ||
|
||
+ **Host** – animation and behavior settings\. | ||
|
||
+ **Speech** – text\-to\-speech with Amazon Polly\. | ||
|
||
Hosts' models and animations are locked and cannot be modified or extended\. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Amazon Sumerian Scene Templates<a name="assets-templates"></a> | ||
|
||
Sumerian provides scene templates that you can use as a starting point for your scene\. Templates contain models and other assets that may not be available in other locations\. You can export assets from templates to save them to your project for use wtih other scenes\. | ||
|
||
**Sumerian Scene Templates** | ||
|
||
+ **Augmented Reality** – Template for creating augmented reality scenes with a companion sample app\. See for more information\. | ||
|
||
+ **Campfire Particle Flythru** – A wooded exterior scene with rocks, bushes, logs and grass\. This template is used in the [particle system tutorial](https://docs.sumerian.amazonaws.com/tutorials/create/beginner/campfire-particles/)\. | ||
|
||
+ **Cargo Ship** – An exterior scene with a cargo ship and water\. | ||
|
||
+ **Cristine** and **Preston** – Empty scenes with Sumerian hosts\. These templates are used in the [speech tutorial](https://docs.sumerian.amazonaws.com/tutorials/create/beginner/host-speech-component/)\. | ||
|
||
+ **Default Lighting** – An empty scene with a skysphere and three directional lights\. This template is used in the [interface tutorial](https://docs.sumerian.amazonaws.com/tutorials/create/getting-started/sumerian-interface/)\. | ||
|
||
+ **Starter Spaces** – An interior scene with doors, windows, carpet, and walls\. | ||
|
||
+ **Training Room** – An interior scene with conference room equipment\. | ||
|
||
+ **View Room** – An interior scene with home theater equipment\. This template is used in the [Sumerian basics tutorial](https://docs.sumerian.amazonaws.com/tutorials/create/getting-started/sumerian-basics-tv-room/)\. | ||
|
||
+ **Warehouse** – An interior scene with warehouse equipment\. | ||
|
||
Choose any of these templates in the dashboard to create a draft scene\. | ||
|
||
Many of these scenes have models and other assets that are not available in the Sumerian library\. These are either included in the default asset pack, or contained in separate asset packs for each model\. You can export these assets to your project to use them in other scenes\. | ||
|
||
**To export assets from a template** | ||
|
||
1. Create a scene from the template\. | ||
|
||
1. Locate the assets that you want to use in the assets panel\. | ||
|
||
1. If the assets are in the default pack, create a new pack and move them into it\. | ||
|
||
1. Highlight a pack and click the asset library icon\(![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/assets-icons-assetlib.png)\) to export it\. | ||
|
||
For more information, see \. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Amazon Sumerian Virtual Reality Tools<a name="assets-vrtools"></a> | ||
|
||
Sumerian provides a pack of VR\-related assets to make it easy to enable VR in your scene\. The asset pack includes a VR camera that lets the user enter VR mode, and VR controllers for interacting with the environment\. | ||
|
||
**Supported Hardware** | ||
|
||
+ Oculus Rift | ||
|
||
+ HTC Vive | ||
|
||
**To enable VR in your scene** | ||
|
||
1. Open a scene in the Sumerian editor\. | ||
|
||
1. Choose **Import assets**\. | ||
|
||
1. Choose **CoreVR** and then choose **Add**\. | ||
|
||
1. When the asset pack finishes loading, drag the **VRCameraRig** entity onto the canvas to add it to your scene\. | ||
|
||
1. Choose the **VRCameraRig** entity\. | ||
|
||
1. Choose the **VRCameraRig** component\. | ||
|
||
1. Check the **Current VR camera rig** option to enable the rig\. | ||
|
||
When a user enters VR mode with a headset and controllers attached, the HMD camera tracks the headset, and the VR controllers track the controllers in 3D space\. The VR camera rig manages the other entities and enables the VR mode button in the scene\. | ||
|
||
Only the controllers of the type attached are rendered in the scene, so you can leave all of the included entities attached to support both types\. You can also replace the included controller models with your own\. | ||
|
||
See [Getting Started with VR](https://docs.sumerian.amazonaws.com/tutorials/create/beginner/getting-started-vr/) for a tutorial that uses these assets\. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Using the Tools in the Amazon Sumerian Editor<a name="editor-tools"></a> | ||
|
||
The Amazon Sumerian editor provides three tool panels for working with complex assets and components\. The text editor provides an interface for authoring scripts, JSON documents, and speech files\. The timeline editor animates entities between keyframes, and the state machine editor lets you visually construct and connect state machine behaviors and actions\. | ||
|
||
## Text Editor<a name="editor-tools-texteditor"></a> | ||
|
||
The text editor lets you view and modify all text assets in the scene, including scripts, JSON documents, and speech files\. | ||
|
||
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/tools-texteditor.png) | ||
|
||
To use the text editor, choose **Tools**, **Text Editor**, or press the J key\. | ||
|
||
The **Documents** panel lists the text assets in your seen\. Click on one to open it in a tab\. To rename an asset, highlight it and click the pencil icon\. | ||
|
||
When you open a script, the **External Resources** panel appears\. You can use this panel to import libraries that your script depends on from the Internet\. See for more information\. | ||
|
||
## State Machine Editor<a name="editor-tools-statemachine"></a> | ||
|
||
The state machine editor provides a visual representation of the actions and behaviors attached to a state machine component\. | ||
|
||
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/tools-statemachine.png) | ||
|
||
To use the state machine editor, click the pencil icon next to a behavior in the assets panel or on a state machine component\. | ||
|
||
The state machine editor shows a box for each behavior, each with a stack of actions listed in the order that they execute\. When an action transitions to another behavior, an arrow connects the action to the target behavior\. Click on an action and drag the cursor to a behavior to create a transition between the two\. | ||
|
||
## Timeline<a name="editor-tools-timeline"></a> | ||
|
||
Use timelines to move, rotate, or change the scale of entities over time\. You can set the start and end values of these properties, and add keyframes to control the speed or direction of the animation along the way\. The timeline can also emit custom events, which can be consumed from a state machine or script\. | ||
|
||
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/tools-timeline.png) | ||
|
||
For more information, see \. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,23 @@ | ||
# The Amazon Sumerian Timeline Component<a name="entities-timeline"></a> | ||
|
||
The timeline component animates properties of an entity over time, such as the transform\. | ||
Use timelines to move, rotate, or change the scale of entities over time\. You can set the start and end values of these properties, and add keyframes to control the speed or direction of the animation along the way\. The timeline can also emit custom events, which can be consumed from a state machine or script\. | ||
|
||
When you add the timeline component to an entity, you'll get a component panel with just one button\. Choose the *Toggle timeline* button to open the timeline\. | ||
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/sumerian/latest/userguide/images/tools-timeline.png) | ||
|
||
To add an entity to your timeline, drag it from the Hierarchy view to the drop area at the left bottom in the timeline\. The entity will appear to the left in the timeline\. View the entity properties available for animation by clicking on it\. Each property is called a *Channel*\. | ||
To create a timeline, choose **Create entity**, **Timeline**\. You can also add the timeline component to an existing entity, but don't add it to the entity that you want to animate\. The timeline can only control entities other than the one to which it is attached\. | ||
|
||
Note that you can *not* add the owner entity to the timeline\. | ||
**Properties** | ||
|
||
To change a property value over time, you add *Keyframes* to a *Channel*\. A Keyframe has a position on the timeline, a value and an easing function\. As time go by, the property value will be set to the value given by the keyframes, interpolated by the easing functions\. | ||
+ **Duration** – the length of the timeline, in seconds\. | ||
|
||
The timeline has a start and an end\. You can set the duration of the timeline and toggle looping in the right bottom corner\. | ||
+ **Loop** – enable to repeat the timeline animation in a loop\. | ||
|
||
Event channels are used to emit SystemBus events at given points in time\. Choose *Add Event Channel* to add a channel for an event\. You will be prompted for an event name to use\. | ||
+ **Auto start** – if you want to trigger the timeline with a state machine or script, disable this option to prevent the timeline from starting automatically in playback mode\. | ||
|
||
To fetch these events, you can use `SystemBus.addListener` in a Script or use the *Listen Action* in the State Machine\. Make sure to listen for the same event name that you specified when adding the channel\. | ||
To open the timeline editor, choose **Toggle timeline** in the timeline component, or choose **Timeline** from the tools menu\. | ||
|
||
To add entities to the timline, drag them from the entities panel onto the timeline editor\. Each *channel* in the editor controls one property of the transform, such as the X translation, or the Z scale\. Click on the clock icon next to a property to enable the channel and add the first keyframe\. | ||
|
||
Add more keyframes to a channel by choosing a time and changing the property's value\. During playback, the entity will animate between the transform values at each keyframe\. By default, changing a property's value automatically creates a keyframe\. You can disable this by clicking on the key icon next to the **Drop entity here** field\. | ||
|
||
Add **Event channels** to the timeline to emit custom events onto the system bus\. The name of the channel is the name of the event that Sumerian emits at each keyframe on the event channel\. Consume this event from a script with [SystemBus\.addListener](https://docs.sumerian.amazonaws.com/engine/latest/docs/Bus.html), or from a state machine with the **Listen Action**\. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.