This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
qckpck2018:qckhud [2019/01/16 00:46] – [Variables] lightwolf | qckpck2018:qckhud [2019/06/03 13:03] (current) – lightwolf | ||
---|---|---|---|
Line 13: | Line 13: | ||
===== qckHuD Master Plugin ===== | ===== qckHuD Master Plugin ===== | ||
- | |||
Opening the master plugin displays a user interface to edit the overlays for the current scene. This user interface can be resized freely. | Opening the master plugin displays a user interface to edit the overlays for the current scene. This user interface can be resized freely. | ||
+ | {{ : | ||
+ | |||
+ | < | ||
==== Presets ==== | ==== Presets ==== | ||
+ | |||
+ | This uses the same presets system as our other plugins: [[exrtrader2018: | ||
==== About ==== | ==== About ==== | ||
==== List of Overlays ==== | ==== List of Overlays ==== | ||
Line 53: | Line 57: | ||
=== Overlay === | === Overlay === | ||
- | This is the text displayed as an overlay. You may include any of the available | + | This is the text displayed as an overlay. You may include any of the available |
=== Hide if not used === | === Hide if not used === | ||
Line 61: | Line 65: | ||
=== Append Variable... === | === Append Variable... === | ||
- | This appends | + | This appends |
+ | |||
+ | === Append Item... === | ||
+ | |||
+ | This appends the selected item name as a variable limiter. See [[# | ||
==== Overlay Properties (right hand side) ==== | ==== Overlay Properties (right hand side) ==== | ||
+ | |||
+ | These controls allow you to edit the individual attributes of every overlay. | ||
+ | |||
=== Enabled === | === Enabled === | ||
+ | |||
+ | This enables or disables the current overlay completely, including children. | ||
+ | |||
=== Loop Multiselection === | === Loop Multiselection === | ||
+ | |||
+ | If multiple items are selected, this overlay - as well as all children - will be displayed for every selected item. | ||
+ | |||
=== Use Parent Style === | === Use Parent Style === | ||
+ | |||
+ | This option is only available if the overlay is a child. It will inherit all of the following options from the parent overlay item. | ||
+ | |||
=== Viewport Visibility === | === Viewport Visibility === | ||
+ | |||
+ | This defines when this overlay is visible in a viewport. | ||
+ | |||
+ | * **Always Visible** The overlay is always visible | ||
+ | * **Active Viewport only** The overlay is only visible in the viewport you're interacting with. This is triggered by the first mouse interaction in a viewport. | ||
+ | * **Inactive Viewport Only** The overly is only visible in a viewport you're //not// interacting with. Essentially the opposite of the previous option. | ||
+ | * **Never Visible** This effectively disables the overlay | ||
+ | |||
=== Viewport Type === | === Viewport Type === | ||
+ | |||
+ | This defines which kind of viewport the overlay will be visible at. | ||
+ | |||
=== Overlay Position === | === Overlay Position === | ||
+ | |||
+ | Overlays can be positioned along the sides of viewports or the centre. | ||
+ | |||
=== Colour === | === Colour === | ||
+ | |||
+ | This defines the colour of the overlay text. | ||
+ | |||
=== Opacity === | === Opacity === | ||
+ | |||
+ | This defines the opacity of the text. | ||
==== Background ==== | ==== Background ==== | ||
+ | |||
+ | The following controls allow you to enable a background for each of the 9 possible overlay positions. You can also change the colour as well as the opacity. | ||
+ | |||
=== Position === | === Position === | ||
+ | |||
+ | This selects the background position to edit. | ||
+ | |||
=== Enable === | === Enable === | ||
+ | |||
+ | En- / disables the background for the current position. | ||
+ | |||
=== Colour === | === Colour === | ||
+ | |||
+ | Defines the colour for the background. | ||
+ | |||
=== Opacity === | === Opacity === | ||
+ | |||
+ | Defines the opacity for the background. | ||
===== Variables ===== | ===== Variables ===== | ||
- | | **Scene** || | + | Variables need to be enclosed in % within the overlay, i.e. |
+ | | ||
+ | |||
+ | Variables related to specific items can be limited to a specific item as opposed to the current selection. | ||
+ | This is done by adding the item name in front of the variable, designated by a $, i.e. | ||
+ | $my_Camera%camera.zoom% | ||
+ | |||
+ | If you actually want the characters % or $ to show up in an overlay, just type them twice. %% shows a single %, $$ a single $. | ||
+ | |||
+ | <tabbox Scene> | ||
|scene.fps| Frames per second of the current scene| | |scene.fps| Frames per second of the current scene| | ||
|scene.time| Time of the current frame in the scene in seconds| | |scene.time| Time of the current frame in the scene in seconds| | ||
Line 94: | Line 157: | ||
|scene.num_polygons|| | |scene.num_polygons|| | ||
|scene.render_camera|| | |scene.render_camera|| | ||
- | |**Item**|| | + | < |
|item.name|| | |item.name|| | ||
|item.position|Position of the item in local coordinates. Append .x/.y/.z to display individual components| | |item.position|Position of the item in local coordinates. Append .x/.y/.z to display individual components| | ||
|item.rotation|Rotation of the item in local degrees. Append .h/.p/.b to display individual components| | |item.rotation|Rotation of the item in local degrees. Append .h/.p/.b to display individual components| | ||
- | |item.scaling|| | + | |item.scaling|Scale of the item in local coordinates. Append .x/.y/.z to display individual components| |
- | |item.world_position|| | + | |item.world_position|World position of the item in local coordinates. Append .x/.y/.z to display individual components| |
|item.position_controller|| | |item.position_controller|| | ||
|item.rotation_controller|| | |item.rotation_controller|| | ||
Line 108: | Line 171: | ||
|item.goal|| | |item.goal|| | ||
|item.breadcrumbs|The complete hierarchy of items to the selected item| | |item.breadcrumbs|The complete hierarchy of items to the selected item| | ||
- | |**Object**|| | + | < |
|object.filename|| | |object.filename|| | ||
|object.num_points|| | |object.num_points|| | ||
|object.num_polygons|| | |object.num_polygons|| | ||
- | |**Light**|| | + | < |
|light.intensity|| | |light.intensity|| | ||
|light.type|| | |light.type|| | ||
|light.quality|| | |light.quality|| | ||
|light.flags|| | |light.flags|| | ||
- | |**Camera**|| | + | < |
|camera.zoom|| | |camera.zoom|| | ||
|camera.focal_length|| | |camera.focal_length|| | ||
Line 123: | Line 187: | ||
|camera.f-stop|| | |camera.f-stop|| | ||
|camera.resolution|| | |camera.resolution|| | ||
- | |**Bone**|| | + | |
+ | < | ||
|bone.strength|| | |bone.strength|| | ||
|bone.twist|| | |bone.twist|| | ||
Line 133: | Line 198: | ||
|bone.limits|Minimum and Maximum rotation limits. Append .h/.p/.b to display individual components| | |bone.limits|Minimum and Maximum rotation limits. Append .h/.p/.b to display individual components| | ||
+ | </ | ||
+ | |||
+ | If you think that any variables are missing to display the information you need, please get in touch with us and we’ll see if we can add them. |