Skip to content

Commit

Permalink
point dataset_bounds docs to annotations (#1186)
Browse files Browse the repository at this point in the history
* point dataset_bounds docs to annotations
  • Loading branch information
nicolemarsaglia authored Aug 18, 2023
1 parent 36f45c5 commit c9e613c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions src/docs/sphinx/Actions/Examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ Resulting image:

.. image:: examples/tout_render_3d_points_const_radius100.png

.. _screen_annotations_off:

An example of rendering with no screen annotations.
----------------------------------------------------

Expand Down Expand Up @@ -80,6 +82,8 @@ Resulting image:

.. image:: examples/tout_vector_component100.png

.. _world_annotations_off:

An example of rendering with no world annotations.
---------------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion src/docs/sphinx/Actions/Scenes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@ parameters:
- ``fg_color`` : an array of three floating point values that controls the foreground color. The foreground color is used to color annotations and mesh plot lines.
- ``annotations`` : controls if annotations are rendered or not. Valid values are ``"true"`` and ``"false"``.
- ``render_bg`` : controls if the background is rendered or not. If no background is rendered, the background will appear transparent. Valid values are ``"true"`` and ``"false"``.
- ``dataset_bounds`` : controls the dimensions of the rendered bounding box around the dataset. This will overwrite the default bounding box based on the dataset's dimensions. A valid value is an array of six floats ([xMin,xMax,yMin,yMax,zMin,zMax]) that define dimensions larger than the default.
- ``dataset_bounds`` : controls the dimensions of the rendered bounding box around the dataset. This will overwrite the default bounding box based on the dataset's dimensions. A valid value is an array of six floats ([xMin,xMax,yMin,yMax,zMin,zMax]) that define dimensions larger than the default. Note: this does not control annotations. To turn off dataset annotations, see :ref:`world_annotations_off`. To turn off screen annotations, see :ref:`screen_annotations_off`.
- ``color_bar_position`` : controls the position of 1 or more color bars. A valid value for positioning a single color bar is an array of four floats ([xMin,xMax,yMin,yMax]). A valid value for positioning N color bars is an array of 4*N floats ([xMin1_0,xMax1_0,yMin1_0,yMax1_0,...,xMin_n,xMax_n,yMin_n,yMax_n]). This repositioning is performed in Screen Space, so valid minimum and maximum values are limited to the range [-1,1] (i.e. the origin (0,0) is in the center of the image, (-1,-1) is the bottom-left corner, and (1,1) is the top-right corner). Note: Ascent does not check for correctness of user positioned color bars.


Expand Down

0 comments on commit c9e613c

Please sign in to comment.