Please enable JavaScript to view this site.

Clarisse 5.0 Reference Guide

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. In the screenshot about the attribute Rotate is of type Angle. They 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+click 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-click 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-click 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 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 Editing Items > Attribute Modifiers

Icon

Description

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+Click to unbind the shading variable. For more information please refer to Shading Variables

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+Click on the button or click and select no texture. For more information please refer to Material Editor and Texture Operators

Jumps and select the texture bound to the attribute

Binds an expression. Click on the button and type your expression. To remove the expression press Ctrl+Click or right-click 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 Working with Expressions

Set an animation key at the current time. Press Ctrl+Click to unbind the F-curve.

Animating Attributes

Click on 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-click on the attribute label and choose Remove F-Curve or press Ctrl+Click 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 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 displaying 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

Rotation Order is now visible after resizing

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 etc... To Copy an attribute right-click on the attribute label (10) and choose Copy. To paste, simply right-click 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-click on the attribute label (10) and choose Localize. To unlocalize an attribute, right-click 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-click 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-click 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-click 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-click on the attribute label (10) and select Lock in the pop-up menu.

 

All Display attributes are 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-click 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-click 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-click in a empty area of the Attribute Editor and selecting Create. A dedicated window will appear.

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 Editing Items > 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;....;valuen|namen

 

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-click 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-click on the custom attribute name and choose Custom Attributes > Edit.

 

Isotropix

Copyright (C) 2009-2022 Isotropix. All rights reserved.