Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Asset viewers and animation previews #494

Merged
merged 3 commits into from
Feb 27, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions content/en/user-manual/assets/animation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@ position: 4

An Animation asset is used to play a single animation on a 3D model. Animations are imported by uploading 3D scenes (such as FBX files) which contain animation data. The animation data is extracted from the uploaded file by the [asset pipeline][asset_pipeline] and a [Target Asset][target_asset] is created to use in game.

## Animation Preview

The inspector has a viewer that can be used to preview the animation with any Template or Model asset. This is useful if you have a single animation that can be applied to different character rigs.

![Asset Inspector Preview][inspector-preview-gif]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know we've discussed this before, but I'm thinking we should enforce the use of number-based references. This inspector-preview-gif string, for example, appears twice in the document, which is not much different (in terms of characters) to just embedding the link directly.

One other thing that is maybe less obvious, is that these references appear in the Transifex interface. Some translators might be attempted to translate the reference - not so with a number.

So right now, we have a seemingly worsening divergence between the use of numbers and strings....so I think we should just universally switch back to numbers. Not in this PR, but in a follow up somewhere down the line.

Copy link
Collaborator Author

@yaustar yaustar Feb 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a third option, how do you feel about inlining links instead of references? I generally find that I'm more error prone with number based references when editing a lot of these docs hence switching to text based.

But if we inline (it's not often that we use the same link twice), that saves a lot of back of forth going to the end of the document when trying to write these docs

Copy link
Contributor

@willeastcott willeastcott Feb 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like inlining links because it pollutes paragraphs that make life difficult especially for translators in Transifex.

In academic papers, for example, references are generally done with superscript numbers. To me, they feel much more natural.

The block of reference links in the document footer can just be totally ignored by translators, which is kinda nice.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I keep this in mind with future PRs and switch back to numbered references


There is also a viewer in the [Anim State Graph Editor][anim-state-graph-editor] when you select a state in the graph. It will show all Entities in the scene using the graph where you can select one to preview.
yaustar marked this conversation as resolved.
Show resolved Hide resolved

![Anim State Graph Preview][anim-state-graph-preview-gif]


## Animation Import Settings

<div class="alert alert-info">
Expand All @@ -22,7 +33,7 @@ They can be found in the Project Settings under Asset Tasks.

Only available for GLB export format. When importing an animation, the generated asset name can either be set from the 'Take Name' in the animation file, or use the animation filename instead.

This is useful with assets that are brought/taken from a store such as [Mixamo][1] where all the take names are 'mixamo.com' and using the filename as the asset name is clearer.
This is useful with assets that are brought/taken from a store such as [Mixamo][mixamo] where all the take names are 'mixamo.com' and using the filename as the asset name is clearer.

### Sample rate

Expand All @@ -45,6 +56,7 @@ If enabling this option, it is recommended that Sample Rate is disabled and Curv
[asset_pipeline]: /user-manual/glossary#asset-pipeline
[target_asset]: /user-manual/glossary#target-asset
[animation_import_settings]: /images/user-manual/assets/animation/animation-import-settings.png

[1]: https://www.mixamo.com/

[mixamo]: https://www.mixamo.com/
[anim-state-graph-editor]: /user-manual/animation/anim-state-graph-assets/
[inspector-preview-gif]: /images/user-manual/assets/animation/inspector-preview.gif
[anim-state-graph-preview-gif]: /images/user-manual/assets/animation/anim-state-graph-preview.gif
42 changes: 42 additions & 0 deletions content/en/user-manual/assets/viewers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Asset Viewers
layout: usermanual-page.hbs
position: 19
---

Some of the assets have viewer tools that can help inspect them more closely. Assets that can be viewed in these will have the option to 'Open in Viewer' in the inspector and context menu.

![Open in Viewer option][open-in-viewer-option]

Clicking on either of these options will open the viewer with the asset in a new tab.

## Model Viewer

![Model Viewer Preview][model-viewer-preview]

(Model: Copyright 2021 Wayfair LLC. [CC BY 4.0][cc-40] International)

The [open source Model Viewer][model-viewer-github] is available for the following asset types:

- Model (Source) that are GLBs
- Model
- Container
- Animation

The Model Viewer is useful for inspecting the model node hierarchy, morph targets and debugging animation issues.

## Texture Tool

![Texture Tool Preview][texture-tool-preview]

The [open source Texture Tool][texture-tool-github] is available for the following asset types:

- Texture
- Texture Atlas

[open-in-viewer-option]: /images/user-manual/assets/viewers/open-in-viewer-option.jpg
[model-viewer-preview]: /images/user-manual/assets/viewers/model-viewer-preview.jpg
[model-viewer-github]: https://github.com/playcanvas/model-viewer
[texture-tool-preview]: /images/user-manual/assets/viewers/texture-tool-preview.jpg
[texture-tool-github]: https://github.com/playcanvas/texture-tool
[cc-40]: https://creativecommons.org/licenses/by/4.0/
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.