Skip to content

Commit 04d1f21

Browse files
Apply suggestions from code review
Co-authored-by: Luisa Felix Salles <[email protected]>
1 parent f6a5c53 commit 04d1f21

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

doc/source/user_guide/tutorials/animate/animate_time.rst

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To animate data across time you need to get the data stored in a |FieldsContaine
3333
Get the result files
3434
--------------------
3535

36-
First download a result file such as one available with the |Examples| module.
36+
First, import a result file such as one available with the |Examples| module.
3737
For more information about how to import your own result file in DPF check
3838
the :ref:`ref_tutorials_import_data` tutorial section.
3939

@@ -97,13 +97,13 @@ or on a static mesh (animate the color map only).
9797

9898
The default behavior of the |animate| method consists in:
9999

100-
- Showing the norm of the data if multiple components are available;
100+
- Showing the norm of the data components;
101101
- Showing data at the top layer for shells;
102102
- Showing the deformed mesh when animating displacements;
103103
- Showing the static mesh for other types of results;
104104
- Using a constant and uniform scale factor of 1.0 when deforming the mesh.
105105

106-
You can animate any result on a deformed geometry by also providing displacements in the `deform_by` parameter.
106+
You can animate any result on a deformed geometry by providing displacement results in the `deform_by` parameter.
107107

108108
The geometry can be deformed by a |Result| object, an |Operator| (It must evaluate to a |FieldsContainer|
109109
of same length as the one being animated) or a |FieldsContainer| (also of same length as the one being animated).
@@ -210,8 +210,11 @@ Change the scale factor
210210

211211
You can change the scale factor using:
212212

213-
a) A single number for a uniform constant scaling.
213+
- A single number for a uniform constant scaling;
214+
- A list of numbers for a varying scaling (same length as the number of frames).
214215

216+
Uniform constant scaling
217+
^^^^^^^^^^^^^^^^
215218
.. jupyter-execute::
216219
:hide-output:
217220

@@ -231,7 +234,8 @@ a) A single number for a uniform constant scaling.
231234
:scale: 45 %
232235
:align: center
233236

234-
b) A list of numbers for a varying scaling (same length as the number of frames).
237+
Varying scaling
238+
^^^^^^^^^^
235239

236240
.. jupyter-execute::
237241
:hide-output:
@@ -255,8 +259,13 @@ b) A list of numbers for a varying scaling (same length as the number of frames)
255259
Save the animation
256260
------------------
257261

258-
You can save the animation using the ``save_as`` argument with a target file path with the desired format as extension.
259-
Accepted extensions are ``.gif``, ``.avi`` or ``.mp4`` (see |open_movie|).
262+
You can save the animation using the ``save_as`` argument with a target file path with the desired format as the extension key.
263+
Accepted extensions are:
264+
- ``.gif``;
265+
- ``.avi``;
266+
- ``.mp4``
267+
268+
For more information see |open_movie|.
260269

261270
.. jupyter-execute::
262271
:hide-output:
@@ -270,12 +279,18 @@ Control the camera
270279

271280
Control the camera with the ``cpos`` argument.
272281

273-
A camera position is a combination of position, focal point (the target), and upwards vector,
274-
resulting in a list of format:
282+
A camera position is a combination of:
283+
- A position;
284+
- A focal point (the target);
285+
- A upwards vector.
286+
287+
It results in a list of format:
275288

276289
.. code-block:: python
277290
278-
[[pos_x, pos_y, pos_z], [fp_x, fp_y, fp_z], [up_x, up_y, up_z]]
291+
camera_position= [[pos_x, pos_y, pos_z], # position
292+
[fp_x, fp_y, fp_z], # focal point
293+
[up_x, up_y, up_z]] # upwards vector
279294
280295
The |animate| method accepts a single camera position or a list of camera positions for each frame.
281296

0 commit comments

Comments
 (0)