How To: draw_text, follow_path and liveview #184
Merged
Conversation
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
Wikunia
changed the title
Codecov Report
@@ Coverage Diff @@
## v0.2 #184 +/- ##
==========================================
+ Coverage 96.84% 96.88% +0.03%
==========================================
Files 8 8
Lines 666 803 +137
==========================================
+ Hits 645 778 +133
- Misses 21 25 +4
Continue to review full report at Codecov.
|
TheCedarPrince
requested changes
Sep 18, 2020
docs/src/howto.md
Outdated
Comment on lines
126
to
127
| A `text` can appear as every other object with `appear(:fade)` and `appear(:scale)` but it also has a special [`appear`](@ref) functionality called | ||
| `:draw_text`. |
There was a problem hiding this comment.
Maybe:
"A text can appear as any other object with appear(:fade) and appear(:scale). However, it also has a special appear functionality called :draw_text."
docs/src/howto.md
Outdated
|
|
||
| to let the text `"Hello World!"` appear from left to right in an animated way. | ||
|
|
||
| ## How can I let an object move along a path? |
There was a problem hiding this comment.
"How can I let an object move along a path?" -> "How Can I Have an Object Follow a Path?"
There was a problem hiding this comment.
in how to all headers are like "How can I let an object move along a path?" atm
There was a problem hiding this comment.
Oh gotcha - it's just that using the word "let" here sounds awkward in English. Perhaps "How can I have an object follow a path?"
docs/src/howto.md
Outdated
|
|
||
| ## How can I let an object move along a path? | ||
|
|
||
| In this case we need to create a list of points (a path) that the object can follow. |
There was a problem hiding this comment.
"In this case we need to create a list of points (a path) that the object can follow." -> "We need to create path by providing a list of points that the object can follow."
docs/src/howto.md
Outdated
| ## How can I let an object move along a path? | ||
|
|
||
| In this case we need to create a list of points (a path) that the object can follow. | ||
| This can be simple object like a `star` or just a list of points. |
There was a problem hiding this comment.
"This can be simple object like a star or just a list of points. " -> "The path can be a provided object path such as star or list of points."
Perhaps link to these object paths too?
There was a problem hiding this comment.
What do you mean by linking to it?
docs/src/howto.md
Outdated
| in this case a star is following the path of a bigger star. | ||
| > **NOTE:** the star inside [`follow_path`](@ref) should have the `action=:none` which is the default for most Luxor functions. | ||
|
|
||
| Unfortunately the above currently only works for some Luxor functions like `ngon` and `star` but not for `circle` and `rect` as they return `true` instead of the points. |
There was a problem hiding this comment.
Perhaps you could make this a note or warning as well?
docs/src/howto.md
Outdated
| ]; pathname="follow_path.gif") | ||
| ``` | ||
|
|
||
| I admit that this is not the nicest syntax so we might choose to return the points by overriding some Luxor functions in the future. |
There was a problem hiding this comment.
I'd remove this or turn it into a note.
docs/src/howto.md
Outdated
|
|
||
| I admit that this is not the nicest syntax so we might choose to return the points by overriding some Luxor functions in the future. | ||
|
|
||
| Another possibility is to specify a vector of points like in this example: |
There was a problem hiding this comment.
" like in this example" -> "like this"
|
I either fixed the thing or comment on your review. Feel free to resolve those I fixed correctly and comment or approve regarding the others. |
TheCedarPrince
approved these changes
Sep 22, 2020
docs/src/howto.md
Outdated
|
|
||
| to let the text `"Hello World!"` appear from left to right in an animated way. | ||
|
|
||
| ## How can I let an object move along a path? |
There was a problem hiding this comment.
Oh gotcha - it's just that using the word "let" here sounds awkward in English. Perhaps "How can I have an object follow a path?"
TheCedarPrince
added a commit
that referenced
this pull request
Sep 25, 2020
* Wik feature progressmeter (#137) * Merged the latest master into v0.2 * Using ProgressMeter * VideoIO to render mp4 without saving temp frames (#138) * first version of VideoIO with mp4 * fixing links in documentation (#144) (#145) * fixing links in documentation (#144) * first version of HowTo (#142) * Using Animations.jl (#125) * first version of Animations.jl * don't allow v2.5 of Luxor because of transposing (#149) * Wik documentation howto (#148) * made review changes for HowTo * docstrings for structs (#150) * Forgot to push sethue to Animations.jl (#153) * allow sethue in Animations.jl * allow 2.5.1 of Luxor * added extra line for an example of `sethue` * merge master in v0.2 * Format file for the repository * Removing old contributing file * Added info on dependencies and JuliaFormatter * Revert "merge master in v0.2" This reverts commit a853a0f. * Revert files to a853a0f * Tutorial animations (#157) * Animation tutorial * Wik feature morphing v2 (#154) * ability to morph with fill. * [WIP] Live Preview (#119) * Starting proof of concept on live preview * Reverted Javis.jl to previous formatting * Began work on proof of concept * Beginning of the javis image viewer * Continued work on trying to preview images * Barebones example of GTK image viewer * get_javis_frame function * Added compat for images and updated authors * Proof of concept javis viewer signal emission * Temporary fix for Image compat * Added buttons and todos * Added functionality for buttons * Fixed up Project TOML for compat with Images * Fixed merge conflict logic bug * Got proof of concept of live viewer working * Beginning clean up of javis image viewer * Added ColorTypes and color conversion for frames * Added ColorTypes dependency * Cleaned up and adding documentation strings * Exported get_javis_frame function * Prepped javis viewer for full integration into Javis * Added Gtk and GtkReactive deps * Added liveview kwarg * Finished prototype of javis viewer * Updated boundaries for deps * Clarified docstrings * Added arrow key navigation through frames * Updated boundaries per Ole suggestion * Fixed up formatting for CI * Made live rendering faster * Added loop around functionality * Adjusted boundaries of deps * Increased speed of image preview display * Functionalized repeated code snippets * Bug in javis viewer - identification attempt * Made javis viewer work completely * Reversion to a6fa540 * Made short circuit eval of live viewer * Documented javis viewer thoroughly * Added docstring * Qualified usage of LightXML.value func * Qualified textbox usage * Formatting... 👀 * test with xvfb on ubuntu * without --project * try with project=. * different idea using DISPLAY * fix Documentation CI * Added documentation for get_javis_frame * Reduced code reuse * Added some clarifications * Removed export of get_javis_frame * Changed returns for testing * Added GtkReactive to Project * Tests for javis_viewer * Formatting again * Final test case for increment/decrement tests * Formatting test file * Final clean up to javis viewer Co-authored-by: Ole Kröger <[email protected]> * removed possibility to set the fontsize inside the latex function (#180) * removed possibility to set the fontsize inside the latex function * ability to animate text (#162) * ability to animate text * Let us follow a path (#163) * Let us follow a path * push preview (#182) * Update Change Log (#183) * Added info about live viewer and javis frame * Added info about drawing text * Improved Action Error Msg (#185) * Added error msg about defining Video first * Added unit test and cleaned up code * How To: draw_text, follow_path and liveview (#184) * added draw_text, follow_path and liveview in HowTo * return 1.0 in interpolation for single frame (#188) * [Bugfix] scaling to 0 (#191) * don't ever scale to 0 :D * [Bugfix] Follow path starting after first frame (#192) * bugfix for follow_path if not on first frame * Drafted showcase table for README * Images for drafted showcase * Formatted tables for showcase * Wik examples follow path (#198) * first version of an examples folder: drawing a car * convert frame only once (#199) * no need to convert to ARGB32 * refactoring (#194) * refactoring * merge fix renaming * resolved typos * Added back headers for table * Update for Tutorial 5 (#200) * Remove any files stored in test/images (#195) * Remove any files stored in test/images * Removed file check and created it as a unit test * Unit test for test/images dir to check for additional files * Added formatting * Began update of tutorial 5 * Updated gifs * Fixed gifs * Added additional explanation on SubAction * Merged unit with v0.2 * Added example of drawing a path * Resized gif to 350 x 350 * fixed tutorial links in readme * Changed compat entries to allow more (#202) * changed compat entries to allow more * changelog ready for merge * Tutorial overhaul (#201) * explaining Action and Scaling and fixing some others * removed some "The" * emoji fixes and some other small things * Corrected grammar and some light editing * Fixed some grammar issues Co-authored-by: Jacob Zelko <[email protected]> * Added Examples Page (#203) * Added examples page link * Added bezier path gif * Drafted first table for examples * Rendered examples properly * Added explanation for example * Fixed reference Co-authored-by: Jacob Zelko <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Checklist
A documentation PR 😄
Link to relevant issue(s)
Close #169
How did you address these issues with this PR? What methods did you use?
I have addressed three questions: