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

Animated marker added to Symbology #8568

Merged
merged 7 commits into from
Oct 27, 2023
Merged
Changes from 1 commit
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
33 changes: 33 additions & 0 deletions docs/user_manual/style_library/symbol_selector.rst
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@ Appropriate for point geometry features, marker symbols have several
* :guilabel:`Anchor point`: defining the quadrant point on the symbol to settle
as placement origin. This is the point the :guilabel:`Offset` is applied on.

* **Animated marker** (see :ref:`animated_marker`)
* **Ellipse marker**: a simple marker symbol layer, with customizable width and
height
* **Filled marker**: similar to the simple marker symbol layer, except that it
Expand Down Expand Up @@ -820,6 +821,38 @@ The magnitude of field can be scaled up or down to an appropriate size for
viewing the field.


.. _animated_marker:
DelazJ marked this conversation as resolved.
Show resolved Hide resolved

Animated marker
...............

Animated marker symbol type allows you to use animated markers, which can be
GIFs, WebP, or MNG animations, to represent points on your map. You
DelazJ marked this conversation as resolved.
Show resolved Hide resolved
can specify marker ``file``, ``size``, ``angle``, and ``frame rate``.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
can specify marker ``file``, ``size``, ``angle``, and ``frame rate``.
You can specify:
* :guilabel:`File` path,
* :guilabel:`Frame rate`: number of steps that are shown per second,
indicating how fast the animation is played
* :guilabel:`Size` in any :ref:`supported unit <supported_units>`,
* :guilabel:`Opacity`,
* :guilabel:`Rotation`,
* :guilabel:`Offset` in :guilabel:`x` and :guilabel:`y` directions from the marker position
* :guilabel:`Anchor point`

The description in issue report is generally an indication and can't be simply taken as is without checking the current GUI (and sometimes playing with the feature). It happens that there are more details or things have changed in the meantime.


There are two ways in which animated symbols are handled:
DelazJ marked this conversation as resolved.
Show resolved Hide resolved

* **Animated marker in a standard map**

When your map is not configured as an animation (i.e. it's a standard QGIS
DelazJ marked this conversation as resolved.
Show resolved Hide resolved
project without animations), the frame for the animated markers will be
determined solely by the current timestamp. Animated markers will activate
when the corresponding layer is in temporal mode and a temporal animation is
running.
DelazJ marked this conversation as resolved.
Show resolved Hide resolved

* **Animated marker when used with temporal controller in animation mode**

When your map is configured as an animation (usually when using the temporal
controller), the animated markers will sync with the animation's timeline.
DelazJ marked this conversation as resolved.
Show resolved Hide resolved
This means that animated markers will pause when the animation is paused,
progress with the animation, and so forth. The map will also be redrawn
according to the frame rate established for temporal animation. This mode
is also applied when exporting an animation using the temporal controller.
It's also the mode used when a plugin (e.g. QGIS Animation Workbench)
specifically sets the frame rate and current frame for the marker animation.

DelazJ marked this conversation as resolved.
Show resolved Hide resolved


.. Substitutions definitions - AVOID EDITING PAST THIS LINE
This will be automatically updated by the find_set_subst.py script.
If you need to create a new substitution manually,
Expand Down