Skip to content

Attribute Editor#

The Attribute Editor is the central widget allowing you to edit items. It handles selection of multiple items and has been designed to give you the ability to massively edit attributes of an entire set of items of different classes.

Attribute editor displaying the attributes of a Locator

Attribute editor displaying the attributes of a Locator

(1) Item Comment (2) Expression Display Mode (3) Attribute Color Display Mode (4) Add Custom Attribute (5) Attribute Group Display Menu (6) Item Name (7) Attribute Group Visibility Buttons (8) Attribute Field Sizer (9) Attribute Display Filter (10) Attribute Label (11) Attribute Value Field (12) Attribute Group

  • Attributes are defined by a label (name) (10) and a field value (11). The field value display depends on the attribute type. For example, in the screenshot above the attribute Rotate is of type Angle.

  • Attributes are also logically sorted into horizontal tabs called attribute groups (12) which can be collapsed or expanded by simply clicking on the horizontal tab (12). Their collapsed/expanded and visibility states can also be managed using (5) and (7) respectively.

For more information about attributes, please refer to Editing Items. For information about how the different types of attributes are displayed and edited in the Attribute Editor please refer to Attribute Types. For more information about managing the display of attribute groups please refer to Attribute Groups.

Attribute Groups#

Attributes are always organized into logical hierarchical groups arranged into horizontal tabs which can be collapsed, expanded, hidden or filtered.

Attribute Groups Toolbar#

Located at the top of the Attribute Editor, you will find buttons (7) displaying the names of the root attribute groups of the selected items.

Attribute editor displaying the attributes of a Locator

Attribute editor displaying the attributes of a Locator

(A) Left remaining groups (B) Visible group (C) Hidden group (D) Right remaining groups

When root groups can't be displayed in the attribute groups toolbar, indicators appear displaying the number of remaining groups on the left (A) and right (D) on either side. Use Alt + drag to slide left or right to navigate in the attribute groups toolbar.

Hiding/Displaying Attribute Groups#

To toggle the visibility of an attribute group, simply click on the attribute group button in the toolbar. This will toggle the visibility of the attribute group and its children in the Attribute Editor. By using Ctrl+Left Button you can hide the visibility of all other groups keeping exclusively the selected one visible.

Solo Mode#

The Attribute Editor offers a solo mode which is very handy to quickly inspect the content of an attribute group and its children.

To enter the solo mode, simply Middle Button on an attribute group. When an attribute group is soloed, all its children are visible and expanded while other groups are hidden.

Display group soloed. Note that soloed groups are highlighted in orange.

Display group soloed Note that soloed groups are highlighted in orange

To leave the Solo Mode, simply Middle Button again on the soloed attribute group or change the current item selection of the Attribute Editor.

Collapsing/Expanding Attribute Groups#

Collapsing/expanding attribute groups is simply performed by clicking on the attribute group tab (12). However, it is possible to control collapse/expanded state of all groups using the Collapse/Expand button (5)

Action Description
Reset to Default Reset to the default visibility collapsed/expanded states of the attribute groups.
Expand All Expand all attribute groups displayed in the Attribute Editor.
Expand Modified Only expand attribute groups that have modified attributes.
Collapse All Expand all attribute groups displayed in the Attribute Editor.
Collapse Modified Only collapse attribute groups that have modified attributes.

Filtering Attribute Display#

It is possible to filter the display of attributes using the search field (9) of the Attribute Editor. This is really helpful, when you are looking for specific attributes especially in case of multi-selection since the amount of attributes and attributes group can become really big.

To search for a specific attribute just enter the attribute name in the search field in lower-case. The Attribute Editor automatically filters its display when you type.

Filtering Attribute Groups#

To filter the display for specific attribute category just type the category name with the first character in upper-case.

For example typing, Kine will display all categories that have Kine in their names. To search for multiple categories or attributes, or a combination of categories and attributes just separate the different keywords with spaces.

For example typing: Kine display Render will display Kinematic, Kinematic Advanced, Rendering categories and all attributes having the word display in their names.

Attribute Groups Modified States#

Attribute groups conveniently display a visual hint when one of their attributes is modified by displaying a little square on the right side of the tab.

  • a green square is displayed when at least one of the attribute of the attribute group is driven by an override (using a override node in Clarisse BUiLDER).
  • a blue square is displayed when at least one of the attribute of the attribute group of a referenced item is overridden.
  • a white square is displayed when at least one of the attribute of the attribute group is modified (has a value that is different from the default one)

We can quickly see here that one of the Kinematics attribute is overriden

We can quickly see here that one of the Kinematics attribute is overriden

Attribute Modifiers#

Attributes can have modifiers driving their value. There are multiple types of attribute modifiers in Clarisse. For more information please refer to Attribute Modifiers

Icon Description
Shading Variable Binds a shading variable to the attribute. click on the button and type your shading variable. To stop the attribute being driven by the shading variable while keeping the shading variable click again on the button. Press Ctrl+Left Button to unbind the shading variable. For more information please refer to Shading Variables
Texture Binds a texture. To bind a texture click on the button and then select/or create the texture to be bound. To remove the binding press Ctrl+Left Button on the button or click and select no texture. For more information please refer to Material Editor and Texture Operators
Jump Jumps and select the texture bound to the attribute
Expression Binds an expression. click on the button and type your expression. To remove the expression press Ctrl+Left Button or Right Button on the attribute label (10) and select Remove Expression. To stop the attribute being driven by the expression while keeping the expression click again on the button. For more information please refer to Using with Expressions
FCurve Set an animation key at the current time. Press Ctrl+Left Button to unbind the F-curve.

Animating Attributes#

click on FCurve to set a keyframe. This will set a new keyframe at the current application time with the current attribute value. click on the same button to remove the current keyframe.

You can also set the keyframe from the menu by selecting Set Keyframe. To completely remove the function curve (F-curve), Right Button on the attribute label and choose Remove F-Curve or press Ctrl+Left Button on the curve/key icon to remove the F-curve.

Instead of animating the F-curve using the Attribute Editor, you can use the Graph Editor which is the widget dedicated to animation in Clarisse. For more information please refer to Graph Editor

Expression Display Mode#

When an attribute value is bound to an expression, the Attribute Editor can either display the expression script (default) or the resulting value of the expression. Using button (3) you can switch between this 2 modes. For more information please refer to Expression Display Modes.

Renaming items#

You can rename items using the Attribute Editor by entering a new name in the name field (9).

Commenting items#

It is possible to comment selected items using the Attribute Editor. To comment the selection, click on the bubble icon (1) located on the upper-left of the Attribute Editor.

A window will pop-up allowing you to input your comments. When an item is commented the bubble icon is displayed in orange. Just click on the button to either edit or view the comment.

Items Comments can also be displayed in the Browser as well as the Explorer. However, they are hidden by default. Please refer to the Browser and Explorer documentation for more information on how to display comments.

Resizing Attributes#

It is possible to resize the attribute field value for convenience. Just drag the mini-sizer (8) to resize all attribute fields.

Rotation Order is clipped

Rotation Order is clipped

After resizing, Rotation Order is now visible

Rotation Order is now visible after resizing

Attribute Color Display#

Attributes of type color have 2 representations. A compact one which display color horizontally and an expanded one displaying colors vertically.

When color attributes are displayed using the compact representation (default), it is not possible to edit/add expressions to the attribute. You first need to set the display to expanded by clicking on (4).

Compact display (top) vs expanded (bottom)

Compact display top vs expanded bottom

Once the expression has been set to the attribute or edited, it's possible to set the display back to the compact representation. This doesn't remove expression bindings.

Copying/Pasting Attributes#

It is possible to copy/paste attribute values along with their animations/expressions:

  • To copy an attribute Right Button on the attribute label (10) and choose Copy.
  • To paste, simply Right Button on the destination attribute label and select Paste. Alternatively, you can use Paste Only... to paste only the values, expressions, animations, textures... on the destination attribute.

Localizing/Unlocalizing Attributes#

It is possible to localize attributes of instances. Unlocalized attributes are always italicized whereas localized ones are displayed in bold. For more information about instances please refer to Instancing Items.

Translate is unlocalized while Rotate is localized

Translate is unlocalized while Rotate is localized

To localize an attribute Right Button on the attribute label (10) and choose Localize. To unlocalize an attribute, Right Button and select Unlocalize.

Note

Modifying an unlocalized attribute actually modifies the source attribute.

Resetting Attributes#

It is possible to reset attributes using the Attribute Editor when they are modified. Right Button on the attribute label (10) and choose Reset Attribute.

Resetting the attribute changes the attribute value to the original value of the attribute before it was modified. If the attribute is an instance then localized, then if it is localized the attribute gets unlocalized so that it becomes driven by its source. On the other hand, if the attribute is unlocalized, it resets the attribute of the source.

Note

Modified attributes have their attribute label highlighted.

It is also possible to reset all the attributes within attribute groups by right-clicking on an attribute group horizontal tab. When selecting Reset, all the attributes in the group are reset.

However, selecting Reset Recursively resets all attributes of the group including the ones of children groups.

Removing Overrides#

To remove an override on an attribute, Right Button on the attribute label (10) and choose Revert Attribute. This will revert the attribute value to the original value of the reference before the override.

Note

Overridden attributes have their attribute label underlined and displayed in blue.

Disabling/Enabling Attributes#

To disable an attribute Right Button on the attribute label and choose Disable. To enable a disabled attribute choose Enable.

Translate is disabled

Translate is disabled

Muting local attribute value#

Right-click on the attribute label (8) and choose Mute Local Value or Un-mute Local Value to un-mute it.

Locking/Unlocking Attributes#

To lock an attribute, Right Button on the attribute label (10) and select Lock in the pop-up menu.

All Display attributes have been locked

All Display attributes are locked

To unlock the attribute, select Unlock in the pop-up menu.

Per value locks#

To lock an attribute value, Right Button on the attribute field value you wish to lock and select Lock Value in the pop-up menu.

Translate Y is locked

Translate Y is locked

To unlock a locked attribute value, Right Button and choose Unlock Value.

Custom Attributes#

It is possible to add or remove custom attributes using the Attribute Editor.

Adding custom attributes#

To add a custom attribute click on (2) or Right Button in a empty area of the Attribute Editor and selecting Create. A dedicated window to create custom attributes will popup.

Note

Adding custom attributes works on a multiple selection.

Custom Attribute Editor Window

Custom Attribute Editor Window

Name#

The name defines the name of the custom attribute in (A). Remember that attribute names have limitations. For more information about these limitations please refer to Attribute Name.

Group#

The group defines the attribute group of the custom attribute in (B).

Type#

The type defines the type and the unit of the attribute from the list (C) of available types presets which are pretty self-explanatory. For example, Distance represents a numeric attribute type formatted to display a distance using the unit type set in the application.

Container#

Define the type of the attribute container using (D). An attribute can either be a single value, an array of value on which you need to specify the size in (E) or a list.

Preset#

It is possible to add named presets for attributes of type Long using (F). A preset is the association of a value with a name. They are very useful since the Attribute Editor displays the list of strings which is a lot more friendly than a list of obscure values. The declaration of presets follow this simple syntax:

value1|name1;value2|name2;....;value_n|name_n

For example:

0|Low;4|Medium;5|High;10|Very High;16|Super Extreme

Resulting Preset displayed in the Attribute Editor

Resulting Preset displayed in the Attribute Editor

Texturable#

Set (G) if the custom attribute accepts textures.

Animatable#

Set (H) if the custom attribute can be animated.

Shading Variable#

Set (I) if the custom attribute accepts shading variables.

Numeric Range#

Defines optional lower (min) and upper (max) bounds (J) for the attribute values. When users type values beyond the number range, the attribute value is automatically clamped to the corresponding bound. This only works on numeric attribute types.

UI Range#

Defines optional lower (min) and upper (max) bounds (K)(L) for the attribute values when users are editing the attribute values through the mini-slider in the Attribute Editor. This is useful for example if you want to restrict the mini-sliders to cover the range [0-1], while still letting the user type values beyond this range. This only works on numeric attribute types.

Warnings#

(M) Display potential syntax errors when defining custom attributes.

Removing custom attributes#

To remove a custom attribute Right Button on the custom attribute name and choose Custom Attributes > Remove. Removing custom attributes works on a multiple selection.

Note

It is possible to remove all custom attributes by choosing Custom Attributes > Remove All

Editing custom attributes#

To edit the definition of a custom attribute Right Button on the custom attribute name and choose Custom Attributes > Edit.

Attribute Types#

There are different kinds of attributes. Each one is represented by a specific display field, for example, an attribute of type Color will be represented by a color field.

Action#

The attribute of type action is one of the simplest type of attributes. It is displayed as a button and performs a specific action when pressed by the user.

Fit to bounding box defined by the Texture Spatial

Fit to bounding box defined by the Texture Spatial

Color#

An attribute of type color defines either a Luminance (L), Luminance + Alpha (LA), Red + Green + Blue (RGB), Red + Green + Blue + Alpha (RGBA).

To edit the color:

  • click on the color pot to display the Color Picker.
  • click drag on the color channel and drag left or right to decrease or increase the value.
  • Middle Button drag on any channels and drag to decrease or increase the value of all channels at the same time.
  • double-click on any channels to be able to type in the value.

Instead of being displayed in a horizontal compact form, color attributes can be expanded to be displayed vertically. For more information go to Attribute Color Display

Compact display (top) vs expanded (bottom)

Compact display top vs expanded bottom

Numeric#

An attribute of type numeric can define a distance, an angle, a percentage, a resolution in pixels... anything that requires numbers. To edit their value:

  • Simply drag the mini-slider left of the value field.
  • Directly type the value in the text field.

Tip

By holding Ctrl while dragging the mini-slider, you edit all attribute values at the same time.

Numeric fields support for basic math operations following this syntax. += , -=, *=, /=

Operation Syntax Example
+ += += 50 adds 50 to the attribute value
- -= -= 50 subtracts 50 to the attribute value
* *= *= 50 multiplies current attribute value by 50
/ /= /= 50 divides current attribute value by 50

Tip

When editing a number by dragging the mini-slider, the increment value is directly related to the type of value and its range. However, the slider increment scale can be fine-tuned by highlighting the relevant digit in the number field. The default increment is restored when after dragging. Pressing Esc during dragging resets the value to its initial value (the one before the edit).

Boolean#

An attribute of type boolean defines if a value is yes/true or no/false. To set the value, simply click on the check-box.

String#

An attribute of type string simply defines a string. To set the value click on the text field and type your value.

Tag#

An attribute of type tag is a string which supports auto-complete. Auto-complete candidates are resolved from a global collection of tags. For example, Image Buffers defines image buffers tags so that when you type the name of an Image Buffer in the Attribute Editor the auto-complete candidates are filtered to image buffer names.

Tags

To set a tag, just type in the name in the text field and press Enter. If a suitable candidate is proposed in the auto-complete list, just click on the right candidate.

You can also use Up and Down arrow key to navigate in the list of candidates.

Pressing Enter selects the candidate. Alternatively, you can directly click on the magnifying glass icon to choose the tag from the list of available tags.

Filename#

An attribute of type filename defines a file path. This type of attribute supports the use of environment variables. To manage environment variables please refer to the Global Variable section.

Note

Clarisse automatically tracks for updates on files referenced by filename attributes. If an external modification occurs on any of the referenced files, the user will get notified. To get more information on file updates, please refer to the Resource View section.

To edit the filename:

  • click on the folder icon and use the File Browser to choose your file.
  • Directly type the filename in the text field

It is possible to manage all filenames using the Path Manager widget which supports batch replace and pattern matching.

Script#

An attribute of type script defines a script in a scripting language supported by the application. Script attributes have a rather sophisticated user interface which offers basic text editor features and syntax highlight.

To edit a script attribute click on the ... button

Attribute Editor Script Window

Script Editor

(1) Script Editor (2) Import Selection (3) Synchronize Selection

When using the attribute script editor, you can update the script by pressing the Apply button.

Pressing the Ok button will update and close the editor while Cancel will close the editor without updating the script.

Note that using the attribute script editor, you will benefit from syntax highlight and name completion. For the latter, hit Ctrl+Space to display the list of functions and constants matching the starting characters. If no starting characters are provided, Ctrl+Space will display the whole list of available functions and constants.

Since the attribute script editor is a simplified version of the Script Editor, please refer to Script Editor for more information.

Import Selection#

Synchronize the script editor with the content of the currently selected item.

Synchronize Selection#

Select the currently edited item in the global application selection.

Gradient#

An attribute of type gradient defines a gradient that can be either a Luminance (L), or a Luminance + Alpha (LA), Red + Green + Blue (RGB), Red + Green + Blue + Alpha (RGBA).

RGBA Gradient

RGBA Gradient

(1) Gradient (2) Key Color (3) Key Delete (4) Start Range (5) End Range (6) Key Interpolation (7) Pre-behavior (8) Post-behavior (9) Autofit Keys (10) Fit Selection (11) Key Value (12) Key Color

Inserting Keys#

To insert a new key click on the gradient (1). When inserting a new key, the color is set from the gradient.

Editing Keys#

To set key color, double-click (2) to set the color. You can also change the color by modifying the color attribute. The value of the key can be set using (11). To change the interpolation type of the key use (6).

Selecting Keys#

To select a key click on (2). You can select multiple keys by holding Ctrl.

Multiple Key selected

Multiple Key selected

Note

When multiple keys are selected editing key values using (11) acts as a global offset of all keys.

Deleting Keys#

To delete one or multiple keys click on (3).

Setting Start/End Range#

You can set the start and end range of the gradient by modifying respectively (4) and (5). Alternatively you can use (9) to autofit the range to all keys while (10) fits the range to the selected ones.

Setting Pre/Post Behavior#

Using the two pulldowns (7) and (8), you can control how the gradient behaves outside the range defined by its first and last key.

Curve#

An attribute of type curve defines curves that can be simple curves or curves defining a Luminance (L), or Luminance + Alpha (LA), Red + Green + Blue (RGB), Red + Green + Blue + Alpha (RGBA).

Curve attribute

Curve attribute

(1) Curve Editor (2) Key deletion (3) Toggle lock on all curves (4) Lock/Unlock Curve (5) Key interpolation Type (6) Pre/Post Behavior (7) Fit Curves (8) Fit Selected Keys (9) Link Curves

To pan the view use either hold Alt+Left Button, Alt+Middle Button,Space+Left Button or ++space+middle++space+ and drag.

To zoom in/out the view use either Alt+Right Button or ++space+right-button. Drag-left to zoom out and Drag-right to zoom in.

It is possible to fit the view to the curves by clicking on Fit Curves (7) or fit the view on selected key by using Fit Selected Keys (8).

Inserting Keys#

To insert a new key, Middle Button on the curve.

Editing Keys#

You can select keys by clicking on them. You can also click-drag to draw a rectangle selection to select one or multiple keys or click on keys while holding Shift or Ctrl.

To move keys, simple click-drag on a key to move the selection or use the Input/Output fields. Changing the key interpolation type is done using the pulldown Key Type (5). To remove keys click on (2).

Note

Default the key interpolation type can be changed in the Preferences Panel. Go to Edit > Preferences... or press Ctrl+K. Then choose the default key interpolation type using the Default Key Interpolation Type option found in the Animation section.

Editing Curves#

To insert a new key, Middle Button on the curve.

Setting Pre/Post Behavior#

Using the two pulldowns (6), you can control how the curves behave outside the range defined by their keys.

Linking/Unlinking Curves#

By default, curves are linked together so that when you create and move keys on all curves at the same time. It is possible to change this behavior by clicking on the Link button (9). When curves are unlinked, each curve is independent.

Locking/Unlocking Curves#

It is possible to lock curves to prevent any further editing. To lock/unlock all curves, click on (3). To lock/unlock individual curves click on (4).

Preset#

An attribute of type preset is a predefined list of named values. To select one of the predefined values, simply click on the preset pulldown and choose the value in the popup menu.

Reference#

An attribute of type reference, connects the attribute to an item of the project/build. This kind of attribute is used for many things such as parenting, assigning materials, specifying groups...

An attribute of type reference to set the parent

Reference

(1) Connection Toggle (2) Jump in connection (3) Connected Item

To connect an item:

  • Drag and drop the item to (3)
  • click on (3). Clarisse will then open a Browser where you can select or even create the item to connect to.

You can remove the connection by holding Ctrl+Left Button. It is also possible to toggle on and off a connection to an item without explicitly disconnecting it by clicking on (1).

Reference List#

An attribute of type reference list is an list of references.

Reference List

Reference List

(1) Reference List Menu (2) List of referenced Items (3) Connection Toggle (4) Jump to Connection

Reference list menu#

To reference list menu allows you to add items by pressing Add... as well as an Edit menu to manage the list and selection.

Action Description
Select All Select all items in the list
Deselect All Clear the selection
Invert Selection Invert the selection
Remove Selection Remove the selected items from the list (equivalent to pressing Delete)
Remove All Remove all items from the list

Adding Items#

To add items to the reference list just drag and drop them into the list or press Add... to browse and select the items you wish to add.

Selecting Items#

To select a list item just click on it. Selected items are highlighted. To select multiple items:

  • To select a range of list items, click on the item at one end of the range, then hold down the Shift key while clicking on the item at the other end of the range.
  • To append a list item in the selection, click on the list item while pressing Ctrl. You can also use Ctrl to toggle in and out items from the selection.

Note

When you select items in a reference list, items are not selected in the application. To select items in the application selection click on (4).

Toggling Item Connections#

You can toggle on and off connections as if items were not in the list. To disable connections press (3). Press again (3) to enable the connections.

Tip

You can click and drag to toggle item connections.

Removing Items#

Press Del to remove selected items from the list.

Note

When you remove items from a reference list, items are not deleted! Only the connection is.

Reordering Items#

You can reorder single or multiple items in the list using click and drag. Just release the mouse button to finalize the reorder.

Object List#

Object lists are very similar to reference lists with the exception that you don't connect items. Instead how managing connection to items, you create embedded objects which are displayed in the list. To add a new item, press Add... button and choose the object you want to create.

To remove a selected object, press Del. However, unlike in Reference Lists removing an item from the object list actually deletes it. For more information please refer to the Reference List section.

Table#

Table are 2D arrays for which a value is a composite of multiple attributes that can be of different types unlike attribute arrays which are a 1D array of values of the same type. For example, a table can represent an array of humans where each element are defined by 3 attributes:

  1. first_name of type string
  2. age of type long
  3. height of type distance

A good example of Table can be seen in Scatterers where the attribute Geometries is a table of reference (geometry), long (id), percentage (probability), reference (collision_object). This attribute are always displayed are as a spreadsheet in the Attribute Editor.

Geometries attribute of the Scatterer

Geometries attribute of the Scatterer

Non Standard#

Non standard attribute are attributes that defines their custom widget (user interface) in the Attribute Editor. These type of attributes are uncommon since in most cases, standard attributes are used. Please refer to the documentation of such item for more information.