-
Notifications
You must be signed in to change notification settings - Fork 42
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
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,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/ |
Binary file added
BIN
+1000 KB
public/images/user-manual/assets/animation/anim-state-graph-preview.gif
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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