User Tools

Site Tools


Property

Properties A Property is a widget that controls how an element moves, looks, reacts, corresponds, etc., within the scene. Properties, typically controlled and accessed in the Parameters (WIP) pane, are displayed as sliders, drop-down menus, On/Off buttons, etc. Some properties have Clamped, Mappable, and/or Must Map attributes.

For scripting API documentation, see DzProperty.

Default Property Types

Inheritance

Each property represents different values. Some properties inherit values from other “parent” properties. In this case each descendant of a property type can perform what the parent property can as well as traits of its own. For example, the Skeleton Property inherits values from the parent Node Property and also has the ability to select only a skeleton.

Property Anatomy

Although property types display unique functions, each property displays the following anatomy features.

Header The Header of a property displays the label of the property as well as icons that provide options for customizing how the property functions.

Label

The Label of a property displays a name that typically describes the purpose of the property. For example, a property that translates the x axis may be labeled X Translate.

State Icons

The State Icons are widgets that, once clicked, toggle another action. These icon actions include:

Icons

  • Link - toggles the option to link one property to another
  • Lock - toggles the lock state of the selected property; also located in the Settings Menu
  • Favorite - toggles the “favorite” state of the selected property; once toggled, the selected property appears in the Favorites Filter; also located in the Settings Menu

Settings Icon

The Settings Icon toggles a menu that displays setting options. Some of these options, such as Favorites and Lock, are also State Icon widgets.

Settings Menu

When the Settings Menu is clicked, the following options are displayed in the menu: Settings Menu

  • Parameter Settings - once selected, causes a separate parameter_settings dialog to appear; this new dialog displays options for customizing how the property appears, functions, works with other properties, etc.
  • Favorites - performs the same action as selecting the Favorite toggle
    • Add to Favorites - adds the property to the Favorites list
    • Remove from Favorites - removes the property from the Favorites list
  • Lock - performs the same action as selecting the Lock toggle
    • Lock - locks the state of the property
    • Unlock - unlocks the state of the property
  • Hidden - causes the property to be hidden from the pane
    • Hide - hides the property from the pane
    • Unhide - unhides the property from the pane
  • Reset - resets the property to the default state

Body

Body The Body of a property displays the specific functions and attributes of the property, such as drop-down menus, color selectors, toggle handles, etc. The property type determines how the body appears and functions. For instance, a Float Property typically displays a slider bar with a handle within the body, whereas a Bool Property typically displays On/Off toggle buttons.

Coloring

The default Coloring of some individual properties have markings to indicate the axis they manipulate, if they manipulate an axis, or black for various other properties. At times, properties can have all the same coloring within a property group to mark them as manipulating the same body portion or for same purpose, such as properties that manipulate the shape of the abdomen or properties that transform the surfaces of the eye.

Note that properties can have any coloring a user has applied to them, varying in all colors. For instance, a user may apply the same color to properties that exist in the same property group to visually distinguish them from other property groups.

Some property coloring indicates how “full” a property is. For example, when a slider (float) property is increased or decrease, one side of the property may darken while the other side lightens to visual display an increase or decrease in values.

The default coloring for axes are:

  • green - Y axis
  • red - X axis
  • blue - Z axis

Icon

Icon The Icon is an optional feature that displays an image that signifies the function of the property. For example, a property that specifically transforms the body size may have an “body” icon to set it apart from other shaping properties in a pane.