diff --git a/docs/_images/field-editor-widget.png b/docs/_images/field-editor-widget.png index 0812df2..18cf468 100644 Binary files a/docs/_images/field-editor-widget.png and b/docs/_images/field-editor-widget.png differ diff --git a/docs/_images/graphics-editor-widget.png b/docs/_images/graphics-editor-widget.png index cca6e39..6370626 100644 Binary files a/docs/_images/graphics-editor-widget.png and b/docs/_images/graphics-editor-widget.png differ diff --git a/docs/_images/material-editor-rename.png b/docs/_images/material-editor-rename.png new file mode 100644 index 0000000..a37d4b9 Binary files /dev/null and b/docs/_images/material-editor-rename.png differ diff --git a/docs/_images/material-editor-select-color.png b/docs/_images/material-editor-select-color.png new file mode 100644 index 0000000..a2136bf Binary files /dev/null and b/docs/_images/material-editor-select-color.png differ diff --git a/docs/_images/region-editor-widget.png b/docs/_images/region-editor-widget.png index 8aa087c..2264910 100644 Binary files a/docs/_images/region-editor-widget.png and b/docs/_images/region-editor-widget.png differ diff --git a/docs/_images/scene-editor-widget.png b/docs/_images/scene-editor-widget.png index d2179b0..6a60a7e 100644 Binary files a/docs/_images/scene-editor-widget.png and b/docs/_images/scene-editor-widget.png differ diff --git a/docs/conf.py b/docs/conf.py index fab5233..f1cd82f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,7 @@ # Configuration file for the Sphinx documentation builder. +import sphinx_rtd_theme + # -- Project information project = 'CMLibs Widgets' @@ -29,7 +31,8 @@ # -- Options for HTML output -html_theme = 'nature' +html_theme = "sphinx_rtd_theme" +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # -- Options for EPUB output epub_show_urls = 'footnote' diff --git a/docs/fieldeditorwidget.rst b/docs/fieldeditorwidget.rst index 7bb2ccc..ec22ad9 100644 --- a/docs/fieldeditorwidget.rst +++ b/docs/fieldeditorwidget.rst @@ -1,37 +1,52 @@ +.. _Field-Editor-Widget: + +=================== Field Editor Widget =================== The **Field Editor Widget** is a control to add, remove, and modify fields in a region. +Fields are functions mapping locations in a model to values (real, mesh location, string etc.). + +While interpolated finite element type fields and group fields (defining subdomains) are read from model files, all other field types can be created with this editor by selecting the function (math or other operator) and its arguments (the existing fields and other parameters it is a function of). + .. _fig-cmlibs-widgets-field-editor-widget: .. figure:: _images/field-editor-widget.png :alt: Field editor widget. + :width: 75% Field editor widget. Field list ---------- -Above the field list, there's a region chooser. -The field list shows all defined fields in the selected region. -Below the field list, two buttons allow you to add new field or delete selected field. +Above the field list, there's a region chooser. + +The field list shows all defined fields in the selected region. Double clicking on a field allows it to be renamed, provided the new name is not already in use. + +Below the field list, two buttons allow you to add new field or delete the selected field. + +Clicking on Add brings up a control for selecting the type/function of the new field, and once selected the controls for setting is required source fields and arguments are shown. + +Clicking on Delete marks a field as unmanaged but won't necessarily remove it if it's still in use. Settings editor --------------- The settings editor is where each field is set up. + It contains a number of controls. -* Field type chooser: This drop-down menu shows the field type of the current field. It’s disabled for existing fields and enabled when creating a new field. -* Managed checkbox: This checkbox allows you to set if the field is managed. -* Is Coordinate checkbox: This checkbox allows you to set if the field is a coordinate. -* Coordinate system type: This drop-down menu shows the coordinate system type of the current field. +* Field type: This shows the field type of the current field. +* Managed checkbox: This checkbox allows you to set if the field is managed. An unmanaged field is automatically destroyed when unused by other fields, graphics or other objects. +* Is Coordinate checkbox: This checkbox allows you to set if the field is a coordinate. This is only supported by finite element fields. +* Coordinate system type and focus: This drop-down menu allows selection of the coordinate system type of the current field, which affects how it is drawn by graphics; polar coordinates systems such as cylindrical and spherical are converted to rectangular cartesian coordinates for display, using a temporary *coordinate transformation* field. The focus is a positive real value scaling prolate and oblate spheroidal coordinate systems only. * Focus: This text box shows the focus number. -* Name: This text box is only displayed when creating a new field, and allows you to identify the name of the field. -* Number of source fields: This text box shows the number of source fields needed for the current type of field. -* Source field: This drop-down menu allows you to select an existing field as a source field for a new field, only enabled when creating a new field. -* Component indexes: This text box shows and allows you to change the component indexes of the selected field. +* Parameters. This lists source fields, real values, component numbers etc. which must be set before the new field is created. +* Name: This text box is only displayed when creating a new field, and allows you to set the name of the new field. + +The *Create* button must be clicked to complete creation of a new field. API --- diff --git a/docs/graphicseditorwidget.rst b/docs/graphicseditorwidget.rst index b7d27b9..a28a064 100644 --- a/docs/graphicseditorwidget.rst +++ b/docs/graphicseditorwidget.rst @@ -1,50 +1,153 @@ +.. _Graphics-Editor-Widget: + +====================== Graphics Editor Widget ====================== -The **Graphics Editor Widget** is a control to add, remove, and modify the graphics of a scene. +The **Graphics Editor Widget** is where each graphical setting can be edited. +When a graphical setting is selected from the list, all of its editable properties appear in this area. +The range of editable properties will vary depending on the type of graphics currently selected. .. _fig-cmlibs-widgets-graphics-editor-widget: .. figure:: _images/graphics-editor-widget.png :alt: Graphics editor widget. + :width: 75% Graphics editor widget. -Settings editor ---------------- +This widget is normally used within the Scene Editor Widget. The content changes depending on the type of graphics selected in graphic list on Scene Editor Widget. + +.. _curl: http://www.math.umn.edu/~nykamp/m2374/readings/divcurl/ + +General description of graphics +------------------------------- + +Graphics are the building blocks used to create any visualization displayed in the :ref:`sceneviewer widget `. +They are created, edited, re-ordered and deleted from within the :ref:`scene editor widget `, or via the Zinc API. Most graphics have the following settings in common: + +* Domain: The model domain ``point/nodes/datapoints/mesh1d/mesh2d/mesh3d`` which graphics are built from. Some graphics types support multiple domain types. Special domain ``mesh highest dimension`` uses the highest dimension mesh present in the region. + +* Subgroup: Optional group or field returning non-zero/true to limit graphics display to. + +* Coordinate field: This setting has a drop-down menu showing a list of fields that can be selected as the coordinate field for the selected graphic. This is usually a geometric coordinate field from the model, but any field with up to 3 real components is usable and can be quite powerful: for example, using the principal strain field (over elements points) plots a strain space diagram. + +* Coordinate System: This setting can be used to render the graphic according to a range of different coordinate systems. This is useful for creating "static" overlays of data on visualizations. + +* Boundary mode: This drop-down menu allows you to select a boundary, and automatically only render glyphs on the select boundary of a mesh. Options allow display on boundary or interior of mesh or subgroup. + +* Select mode: This drop-down menu allows you to select different selection behaviours for the graphic: + + * select_on - The default setting; graphics are able to be selected and selected items are highlighted by rendering in the *default_selected* material. + * no_select - No selection or highlighting of the graphic. + * draw_selected - only selected items are drawn, in the *default_selected* material. + * draw_unselected - only unselected items are drawn. + +* Wireframe: This checkbox, if checked shows surface graphics as a wireframe mesh, otherwise shaded surfaces are shown. + +* Material: This drop-down menu allows you to select which material should be used to render the graphic. Materials are defined and edited in the :ref:`material editor Widget `. + +* Selected material: This drop-down menu allows you to set which material will be used to render parts of the graphic which are selected. + +* Data: This setting has a drop-down menu, allowing you to select which field will be mapped on to the graphic. This enables you to colour the graphic according to the values of some field, for example. The check box also activates the *spectrum* drop-down menu. + +* Spectrum: This drop-down menu is used to select which spectrum is to be used to colour the graphical element according to the field selected in the *data* setting. Spectrums are edited in the :ref:`spectrum editor widget `. + +* Tessellation: Tessellation settings are used to set the number of polygons or line segments used to approximate curves in the object. Higher tessellations give greater image quality at the expense of rendering time. + +* Tessellation field: This setting has a drop-down menu showing a list of fields that can be selected as the tessellation field for the selected graphic. This approximates element curves with the native resolution of this field multiplied by the resolution from the Tessellation. + +* Line width: This value sets the width of line graphics in pixels including line glyphs. + +* Point size: This value sets the size of point glyphs in pixels. + +.. _types-of-graphics: + +The types of graphics +--------------------- + +* **point** + + Points are created in one of 4 sub-types which also sets the associated *Domain*: + + * **point** - Show a single point in the scene. Assumes coordinate 0, 0, 0 if no coordinate field is specified. + + * **node points** - Visualize each node point, usually representing vertexes on a mesh. + + * **data points** - Visualize the second set of points, usually representing point data separate from the model. + + * **element points** - Visualize points sampled across elements of 1 to 3 dimensions. + + Points graphics have additional **Point attributes** specifying: + + * The *Glyph* used to visualize the point, a selectable graphic e.g. point, sphere, cube, arrows etc. + * The *Base size* of the glyph prior to scaling. + * The *Scale field* orienting and scaling the glyph. + * The *Scaling* values multiplying the scale field. + * The *Signed scale field* multiplying the scale but allowing e.g. inward/outward arrows with repeat mode mirror. + * The *Glyph offset* allows the glyph origin to be offset relative to the scaled axes at the point. + * The *Repeat mode* allows multiple glyphs to be rendered to make custom glyphs by mirroring or laying out on 2 or 3 axes. + * The *Label field* specifies a field whose values are written beside the point. Use special field cmiss_number to show node/datapoint/element numbers. + * The *Label text* allows fixed text strings to be written prior to the label field, with up to 3 strings for different glyph repeat modes. + * The *Label text offset* allows the label origin to be offset relative to the scaled axes at the point. + * The *Font* allows different fonts to be chosen for the labels, where supported. + + Points on mesh domains have additional **Sampling attributes**: + + * *Sampling mode* controls number and location of sampled points in terms of tessellation: + * *cell centres* specifies points at centres of tessellation 'cells'. + * *cell corners* specifies points at corners of tessellation 'cells'. + * *cell poisson* randomly generates points in the tessellation 'cells' according to the Density field sampled at the centre along with the volume/surface area/length. + * *set location* uses a single set element location. + * *gaussian quadrature* specifies points at standard Gaussian quadrature locations for the element shape and tessellation, currently limited to be up to 4 points in each direction. + * *Sample location* specifies a single comma-separated element 'xi' coordinates, used with sampling mode *set location*. + * *Density field* specifies a field giving the density for use with sampling mode *cell* poisson. + +* **lines** + + Lines are used to visualize 1D elements, or the edges of 2D or 3D elements. They may be drawn as simple unshaded lines of fixed width, or rendered as surfaces with extruded shapes. + + Lines have the following **Line attributes**: + + * *Shape*: This drop down menu allows you to select the profile of the line: line, ribbon, circle extrusion or square extrusion, with the following only applying to non-line shapes: + * *Base size*: This base lateral size of the cross section of the line shape, formatted as number*number. + * *Scale field*: Optional field to scale lateral size of the cross section of the line shape. + * *Scaling*: Real-valued multiplier on scale field, formatted as number*number. + +* **contours** + + Contours show surfaces (with Domain ``mesh3d``) or lines (with Domain ``mesh2d``) at which the selected Scalar field has the chosen fixed values ("iso-values"), alternatively known as iso-surfaces and iso-lines. + + Contours have the following **Contour attributes**: + + * The *Scalar field* specifies the single-valued real field whose iso-values are to be rendered. + * The *Range number*, if checked allows the number of isovalues to be specified across a range. If not checked a list of fixed values is specified. + * The *Isovalues* contains a comma-separated list of iso-values to use, either 2 representing the minimum and maximum if a range is used (and values are sampled regularly between them) or a variable list of a range is not used. + +* **surfaces** + + Surfaces are used to visualize 2D elements or the faces of 3D elements. -The settings editor is where each graphic is set up. -It contains a number of controls. + Surfaces have no additional settings. -* Subgroup: This drop down menu allows you to select the subgroup of current graphic. -* Coordinates: This drop down menu allows you to select the coordinate of current graphic. -* Coord System: This drop down menu allows you to select the coordinate system of current graphic. -* Boundary Mode: This drop down menu allows you to select the boundary mode of current graphic. -* Face: This drop down menu allows you to select the face of current graphic. -* Wireframe: This checkbox allows you to set if the graphic is displayed in a skeletal three-dimensional model in which only lines and vertices are represented. -* Material: This drop down menu allows you to select material for current graphic. -* Data field: This drop down menu allows you to select data field for current graphic. -* Spectrum: This drop down menu allows you to select spectrum for current graphic. -* Tessellation: This drop down menu allows you to select tessellation for current graphic. +* **streamlines** -If the graphic is a line: + Streamlines visualize the path a point follows if it tracks along a vector field over the domain, for example, the velocity in a fluid flow solution. -* Shape: This drop down menu allows you to select shape for current line graphic. -* Base size: This text box allows you to set the base size for line graphic, format as number*number. -* Scale field: This drop down menu allows you to select scale field for current line graphic. -* Scaling: This text box allows you to set the scaling for line graphic, format as number*number. + Streamlines use both **Line attributes** and **Sampling attributes** defined earlier. -If the graphic is a point: + Streamlines have the following **Streamline attributes**: -* Glyph: This drop down menu allows you to select glyph for current point graphic. -* Base size: This text box allows you to set the base size for point graphic, format as number*number*number. -* Scale field: This drop down menu allows you to select scale field for current point graphic. -* Scaling: This text box allows you to set the scaling for point graphic, format as number*number*number. -* Label field: This drop down menu allows you to select label field for current point graphic. -* Sampling mode: This drop down menu allows you to select sampling mode for current point graphic. + * The *Vector field* specifies the field to track along, either a 3, 6 or 9 component vector fields for a 3 dimensional mesh. Streamlines align along their length according to the first vector of a vector field, and across their "width" (eg the width of the *ribbon* or *extruded square* line shape) to the second vector. For single vector (3 component) vector fields, the width direction of the shape rotates according to the curl of the vector field. Tip: Using a fibre field allows muscle fibre orientations to be viewed with ribbon or extruded square shape. + * *Track length* specifies the distance the streamline is tracked along before finishing. + * *Track direction* specifies forward or reverse tracking. + * *Colour data* allows special colouring modes: + * *field* uses the regular *Data field* sampled along its length, at the centre of the shape. + * *magnitude* gives the magnitude of the vector in the primary direction. + * *travel time* integrates the time/distance along the streamline to each point. API --- .. autoclass:: cmlibs.widgets.graphicseditorwidget.GraphicsEditorWidget - :members: + :members: \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 1665978..72fcbb7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,12 +1,13 @@ CMLibs Widgets ============== -The **CMLibs Widgets** is a collection of PySide6 widgets to interface between a user interface and the Zinc library. +The **CMLibs Widgets** is a collection of PySide6 (Qt) widgets for building user interfaces for editing and interacting with models and visualizations defined using the CMLibs Zinc library. Widgets ------- .. toctree:: + :maxdepth: 1 fieldeditorwidget graphicseditorwidget @@ -14,6 +15,7 @@ Widgets modelsourceseditorwidget regioneditorwidget sceneeditorwidget + sceneviewereditorwidget sceneviewerwidget spectrumeditorwidget tessellationwidget diff --git a/docs/materialeditorwidget.rst b/docs/materialeditorwidget.rst index 0301b2d..b24ea44 100644 --- a/docs/materialeditorwidget.rst +++ b/docs/materialeditorwidget.rst @@ -1,31 +1,63 @@ +.. _Material-Editor-Widget: + +====================== Material Editor Widget ====================== -The **Material Editor Widget** is a control to add, remove, and modify materials. +The **material editor widget** enables interactive creation and editing of graphical materials which are used to control the colour and shading of graphics in 3-D visualizations. .. _fig-cmlibs-widgets-material-editor-widget: .. figure:: _images/material-editor-widget.png :alt: Material editor widget. + :width: 75% Material editor widget. Material list ------------- -The material list displays all currently defined materials; it will always contain the default material if no other materials are defined. -The two buttons at the top of the window allow you to create or delete materials. +Along the top of the material editor window are two buttons; create and delete. You can create a new material, or delete an existing material using these buttons. + +Below these buttons is the list of currently defined materials. +These will contain the default materials, as well as any defined in any comfile that has been run. + +You can rename the material by double-clicking on it. + +.. figure:: _images/material-editor-rename.png + :alt: Material editor rename material. + :width: 50% + + Rename material. + +Controls +-------- + +Below the material list is a panel containing four colour select buttons. These control the ambient, diffuse, emitted and specular colours. + +* Ambient - The ambient colour is the "unlit" colour, or the colour of parts of the object that are in shadow. +* Diffuse - This is the overall colour of the material, the colour that the lit parts of the object will appear. +* Emitted - The emitted colour is the "glow" of a material; this colour will appear in both the lit and unlit parts of the material. +* Specular - This is the colour of the shine that appears on the material. This shine appears as a glossy highlight. + +.. figure:: _images/material-editor-select-color.png + :alt: Material editor select colour. + :width: 50% + + Select colour. + +When you click the Select Colour button, a colour dialog will pop up, and you can select a colour in several ways. The background of these four buttons indicates the colour you choose. -Settings editor ---------------- +Below the colour editors are further attributes controlling the rendering: -Below the material list are controls that allow you to set some general properties of the selected material. -Ambient Color, Diffuse Color, Emission Color, and Specular Color. -You can also adjust the alpha and shininess of the material by entering a number between 0 and 1 or dragging the sliders. +* *Alpha* sets the opacity, from 0.0 (transparent) to 1.0 (opaque) with corresponding variable translucency in between. Use of alpha \< 1.0 may require use of Sceneviewer Transparency modes ``slow`` or ``order independent`` for best results. +* *Shininess* sets the "tightness" or size of the specular highlights of a material, a value from 0.0 to 1.0. Generally, the higher the shininess, the smaller and harder-edged are the highlights. Use requires a non-black specular colour. +* *Texture* specifies up to 4 image fields from a region to be attached to the material for texture mapping and other special effects. Note at this time facilities for loading images and shaders which use these have not been exposed. Preview panel ------------- +Below the surface editor is a panel that shows a preview of the currently edited material applied to a sphere. This panel displays a sphere, shaded with the selected material. API diff --git a/docs/modelsourceseditorwidget.rst b/docs/modelsourceseditorwidget.rst index 333a7a2..3e775b4 100644 --- a/docs/modelsourceseditorwidget.rst +++ b/docs/modelsourceseditorwidget.rst @@ -1,3 +1,6 @@ +.. _Model-Sources-Editor-Widget: + +=========================== Model Sources Editor Widget =========================== @@ -7,6 +10,7 @@ The **Model Sources Editor Widget** is a control to add and remove source files. .. figure:: _images/model-sources-editor-widget.png :alt: Model sources editor widget. + :width: 75% Model sources editor widget. diff --git a/docs/regioneditorwidget.rst b/docs/regioneditorwidget.rst index b53a022..868967b 100644 --- a/docs/regioneditorwidget.rst +++ b/docs/regioneditorwidget.rst @@ -1,3 +1,6 @@ +.. _Region-Editor-Widget: + +==================== Region Editor Widget ==================== @@ -7,6 +10,7 @@ The **Region Editor Widget** is a control to add, remove, and modify the region .. figure:: _images/region-editor-widget.png :alt: Region editor widget. + :width: 75% Region editor widget. diff --git a/docs/sceneeditorwidget.rst b/docs/sceneeditorwidget.rst index 739593f..64ffd0b 100644 --- a/docs/sceneeditorwidget.rst +++ b/docs/sceneeditorwidget.rst @@ -1,3 +1,6 @@ +.. _Scene-Editor-Widget: + +=================== Scene Editor Widget =================== @@ -7,17 +10,28 @@ The **Scene Editor Widget** is a control to add, remove, and modify the graphics .. figure:: _images/scene-editor-widget.png :alt: Scene editor widget. + :width: 75% Scene editor widget. Graphics list ------------- +Along the top of the scene editor window is a region selector that allows you to select the region of current scene. + +Below the selector is the list of currently defined graphics. The graphics list displays all the defined graphics in the current scene, each with a checkbox in front of it. This checkbox allows you to set whether to display this graphic. -Above the chart list is a region selector that allows you to select the region of current scene. -Below the list of graphics, there is a drop-down menu that allows you to add a new graphic. -There is also a button that allows you to delete the selected graph. +This graphics list can also be reordered via drag and drop. Graphics at the top have higher display priority. +Earlier graphics are rendered first, which can affect translucency results in some modes. +The graphics in the list are labeled by the graphics type followed by the domain and optionally the subgroup. The domain and subgroup can be changed in the graphics editor below. + +Below the list of graphics, there is a drop-down menu that allows addition of new graphics of specified type (with convenient *points* sub-types *point, node points, data points* and *elements points* which also set the domain), and a button to *Delete* the currently selected graphics. + +Graphics editor +--------------- +Below the graphics list is the graphics editor where settings for each graphics can be edited. +The range of settings displayed varies depending on the :ref:`type of graphics ` currently selected and sometimes also the *Domain type*. API --- diff --git a/docs/sceneviewereditorwidget.rst b/docs/sceneviewereditorwidget.rst new file mode 100644 index 0000000..35b3525 --- /dev/null +++ b/docs/sceneviewereditorwidget.rst @@ -0,0 +1,7 @@ +.. _Sceneviewer-Editor-Widget: + +========================= +Sceneviewer Editor Widget +========================= + +The **Sceneviewer Editor Widget** is a widget for editing a displayed OpenGL based scene. diff --git a/docs/sceneviewerwidget.rst b/docs/sceneviewerwidget.rst index 56b4e4b..91a3f82 100644 --- a/docs/sceneviewerwidget.rst +++ b/docs/sceneviewerwidget.rst @@ -1,4 +1,25 @@ -Sceneviewer Editor Widget -========================= +.. _Sceneviewer-Widget: -The **Sceneviewer Editor Widget** is a widget for displaying an OpenGL based scene. +================== +Sceneviewer Widget +================== + +The **Sceneviewer Widget** is a widget for displaying an OpenGL based scene. + +Instructions +------------ + +The **Sceneviewer Widget** offers an interactive 3D visualization for scenes. +Rotating, panning and zooming the view is done by holding down a mouse button and dragging as in the following table: + +======================= ============== +Mouse Button Transformation +======================= ============== +Left Tumble/Rotate +----------------------- -------------- +Middle or Shift+Left Pan/Translate +----------------------- -------------- +Right or Ctrl+Left(Mac) Fly Zoom +----------------------- -------------- +Shift+Right Camera Zoom +======================= ============== diff --git a/docs/spectrumeditorwidget.rst b/docs/spectrumeditorwidget.rst index dcbb182..f196fb4 100644 --- a/docs/spectrumeditorwidget.rst +++ b/docs/spectrumeditorwidget.rst @@ -1,21 +1,25 @@ +.. _Spectrum-Editor-Widget: + +====================== Spectrum Editor Widget ====================== -The **Spectrum Editor Widget** is a control to add, remove, and edit spectra. +The **Spectrum Editor Widget** is a control to add, remove, and edit spectrums. .. _fig-cmlibs-widgets-spectrum-editor-widget: .. figure:: _images/spectrum-editor-widget.png :alt: Spectrum editor widget. + :width: 75% Spectrum editor widget. Spectrum list ------------- -The spectrum list shows all the currently defined spectra; it will always contain the default spectrum if no others have been defined. -Three buttons at the top of the window allow you to create, delete, or rename spectra. -Just below the list of spectra are some controls that allow you to set some of the general properties of the selected spectrum. +The spectrum list shows all the currently defined spectrums; it will always contain the default spectrum if no others have been defined. +Three buttons at the top of the window allow you to create, delete, or rename spectrums. +Just below the list of spectrums are some controls that allow you to set some of the general properties of the selected spectrum. The autorange button automatically sets the minimum and maximum values of the selected spectrum, according to the smallest and largest values it has been applied to in the scene editor. For example, if the default spectrum has been used to colour a temperature field in the default scene, and that field has values ranging from 0 to 100 degrees Celsius, pressing the autorange button will set the minimum and maximum values (in the Spectrum range settings - see below) of the selected spectrum to 0 and 100 respectively. @@ -31,7 +35,7 @@ Preview panel This panel shows a horizontal bar, coloured using the selected spectrum. The bar also shows the range that the spectrum is currently set to, using a series of numbered labels. Clicking in the preview panel changes the number of these labels from 4 to 10 to 2, then cycles through these values. -Currently the preview panel can not display multi-component spectra. +Currently the preview panel can not display multi-component spectrums. Settings editor --------------- @@ -39,12 +43,12 @@ Settings editor The settings editor is where each spectrum is set up. It contains a number of controls. -* Spectrum component list: The top of this list has four buttons; Add, Delete, Up, and Down. Below these buttons is a list of the components that make up the selected spectrum. Spectra in cmgui can be made up of multiple components; these can be added, deleted or re-ordered using this list. Using these "sub-spectra" you are able to create spectra that have different colour ranges for different parts of the data range they cover, or spectra that have different colour ranges for different dimensions. +* Spectrum component list: The top of this list has four buttons; Add, Delete, Up, and Down. Below these buttons is a list of the components that make up the selected spectrum. spectrums in cmgui can be made up of multiple components; these can be added, deleted or re-ordered using this list. Using these "sub-spectrums" you are able to create spectrums that have different colour ranges for different parts of the data range they cover, or spectrums that have different colour ranges for different dimensions. * Data component: This text box allows you to enter which data component of a multi-component field the spectrum will colour according to. * Spectrum range: This set of controls is used to set up the range of values the spectrum covers. The Min. and Max. text boxes allow you to enter values for the minimum and maximum values of the spectrum. There are also four check boxes that allow you to change the behaviour of a spectrum at its start and end points. -* Colour: This drop-down menu provides a selection of pre-set colour settings that can be applied to the currently selected spectrum component. Although many of the colour ranges are fairly self-explanatory, a number of them have special features which are useful for creating specialized spectra. The contour bands and step colour settings have further settings associated with them. +* Colour: This drop-down menu provides a selection of pre-set colour settings that can be applied to the currently selected spectrum component. Although many of the colour ranges are fairly self-explanatory, a number of them have special features which are useful for creating specialized spectrums. The contour bands and step colour settings have further settings associated with them. * Rainbow: This is a standard rainbow colour range. -* Red: This is a red to black colour range. It is applied as a single "channel" of red to the spectrum; this can be used to add to other spectrum components to make multi-component spectra. +* Red: This is a red to black colour range. It is applied as a single "channel" of red to the spectrum; this can be used to add to other spectrum components to make multi-component spectrums. * Green: This is a single channel green to black colour range. * Blue: This is a single channel blue to black colour range. * White to blue: This is a white to blue colour range. @@ -53,7 +57,7 @@ It contains a number of controls. * Alpha: This is a single channel transparent to opaque spectrum. * Contour bands: This colour option creates a series of evenly spaced black bands that can be further edited to get the correct number, width and spacing desired. * Step: This is a colour range which has a sharp transition from saturated red to saturated green. -* Type: This drop down menu allows you to choose between linear and log scale spectra. The Reverse check box allows you to swap the direction of the spectrum. If a log scale is selected as the type, the Exaggeration settings become available. +* Type: This drop down menu allows you to choose between linear and log scale spectrums. The Reverse check box allows you to swap the direction of the spectrum. If a log scale is selected as the type, the Exaggeration settings become available. * Exaggeration: This text box allows you to specify how strongly the spectrum is exaggerated. * Left/Right: These radio buttons allow you to choose the direction of the exaggeration. * Normalised colour range: These two text boxes allow you to specify the portion of the colour range that is displayed across the chosen range of values for the spectrum component. The default values of 0 and 1 display the entire colour range, and other values allow you to choose where in the colour range the spectrum component begins and ends. For example, 0.5 and 1 would display only the upper half of the colour range; 0 and 0.5 would display only the lower half; 0.25 and 0.75 would display the middle section of the colour range. diff --git a/docs/tessellationwidget.rst b/docs/tessellationwidget.rst index 60c50f0..6034ff2 100644 --- a/docs/tessellationwidget.rst +++ b/docs/tessellationwidget.rst @@ -1,3 +1,6 @@ +.. _Tessellation-Editor-Widget: + +========================== Tessellation Editor Widget ========================== diff --git a/docs/timeeditorwidget.rst b/docs/timeeditorwidget.rst index 68e7b90..4e860bc 100644 --- a/docs/timeeditorwidget.rst +++ b/docs/timeeditorwidget.rst @@ -1,3 +1,6 @@ +.. _Time-Editor-Widget: + +================== Time Editor Widget ================== diff --git a/docs/viewwidget.rst b/docs/viewwidget.rst index 8a9d89d..00edf69 100644 --- a/docs/viewwidget.rst +++ b/docs/viewwidget.rst @@ -1,3 +1,6 @@ +.. _View-Widget: + +=========== View Widget ===========