|
| 1 | +<div style="border: solid 1px #999; border-radius:12px; background-color:#EEE; padding: 8px; padding-left:14px; color: #555; font-size:14px;"><b>Draft:</b> The content on this page is complete, but it has not been reviewed yet.</div> |
| 2 | +# Blackboard |
| 3 | + |
| 4 | +The Blackboard panel is an utility panel in the [Visual Effect Graph Window](VisualEffectGraphWindow.md) that enables managing local and exposed **properties**. |
| 5 | + |
| 6 | +Properties you define in blackboard are global variables that can be used throughout the graph in order to factorize usage of the same values. For example a bounding box property can be set once and used for many particle systems. Properties can be defined, ordered and categorized in a blackboard window. |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | +You can use properties as **local constants** or **exposed**. Exposed properties are visible on the [Visual Effect Component](VisualEffectComponent.md) and can be accessed via the C# API. |
| 11 | + |
| 12 | +Exposed Properties display a green dot left to their label while local constants do not display this dot. |
| 13 | + |
| 14 | +## Properties in Blackboard |
| 15 | + |
| 16 | +You can open the Blackboard panel using the **Blackboard** button located in the right side of the Visual Effect Graph window's toolbar. |
| 17 | + |
| 18 | +### How to Create Properties |
| 19 | + |
| 20 | +You can create properties by clicking the + button located in the top-right corner of the blackboard, then select a property type in the menu. |
| 21 | + |
| 22 | +You can also convert an inline operator to a property by right-clicking the node and selecting either: |
| 23 | + |
| 24 | +- Convert to Property if you want to create a local variable |
| 25 | +- Convert to Exposed Property if you want to create an exposed property |
| 26 | + |
| 27 | +> Regardless of the option you choose, you can edit the Exposed flag at a later time. |
| 28 | +
|
| 29 | +### How to Edit Properties |
| 30 | + |
| 31 | +Properties can be edited in the blackboard by clicking the folding arrow left to them. It expands the following property options: |
| 32 | + |
| 33 | +* Exposed : Whether the property is exposed and visible to the Visual Effect Inspector. |
| 34 | +* Value : The default Property value. |
| 35 | +* Tooltip : A tooltip string that appears when hovering the property in the Visual Effect Inspector. |
| 36 | + |
| 37 | +> Some property types display additional options, for instance a Range option for float properties. |
| 38 | +
|
| 39 | +### How to Arrange Properties |
| 40 | + |
| 41 | +- You can **rename** a property by right-clicking it, then select rename from the context menu. You can also start renaming by double clicking the property name. You can then type the name in the editable field and validate by pressing enter or clicking somewhere else. |
| 42 | +- You can **drag and drop** properties in the blackboard panel to reorder them. |
| 43 | +- You can **delete** a property by right-clicking it, then select delete from the context menu, or select the property and use the **Delete** key (Cmd + Delete key on macOS). |
| 44 | + |
| 45 | +### Property Categories |
| 46 | + |
| 47 | +Categories enable sorting properties in groups, so they appear in a more tidy way: |
| 48 | + |
| 49 | +- You can **create** a category by clicking the + button located in the top-right corner of the blackboard, then select **Category**. |
| 50 | +- You can **rename** a category by right-clicking its title, then select rename from the context menu. You can also start renaming by double clicking the category title. You can then type the name in the editable field and validate by pressing enter or clicking somewhere else. |
| 51 | +- You can **delete** a category by right-clicking its title, then select delete from the context menu, or select the category and use the **Delete** key. Deleting a category will also delete all the properties contained in it. |
| 52 | +- You can drag and drop a category to **reorder** them by dragging its header. |
| 53 | +- You can **drag and drop properties** from a category to another, or at the top of the window if you want this property to not be part of a category. |
| 54 | + |
| 55 | +## Property Nodes |
| 56 | + |
| 57 | +Property nodes have a slightly different visual than standard nodes : They display the Property Name and an optional green dot if the property is exposed. |
| 58 | + |
| 59 | +They can be expanded to use a sub-member of the property value. |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | +## Exposed Properties in Inspector |
| 64 | + |
| 65 | +Exposed properties become visible on a [Visual Effect Inspector](VisualEffectComponent.md), in the Properties area, if their Exposed flag is checked in the blackboard. They appear in the same order and categories as they are defined in the blackboard. |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | +### Overriding Property Values |
| 70 | + |
| 71 | +You can override a property value from its default by ticking the checkbox in the left part of the inspector. |
| 72 | + |
| 73 | +- Once overridden, the value can be changed for this instance. |
| 74 | +- You can revert back to the default value by toggling off the override checkbox. |
| 75 | + |
| 76 | +### Editing Properties using Gizmos |
| 77 | + |
| 78 | +Some advanced property types can be edited using gizmos. In order to enable Gizmo editing, click the **Show Property Gizmos** button to enable advanced editing, then click the Edit button next to every compatible property in order to use its editing gizmo. |
| 79 | + |
0 commit comments