Properties

A property is a global variable in a component. Properties are contained in the root node of a component. Any visible properties of a selected component in the 3D world will be displayed in the Properties panel.

Contents HideContents Show

Types
Common Properties

Types

Name	Description
Boolean	True or False value that can be expressed using a 1 or 0.
Button	Button control used for triggering an action.
Distribution	Pseudo-random real number generated by an expression that defines a distribution. normal([stream], u, s) Normal distribution for mean value u and standard deviation s with an optional stream for seeding a random value to generator. exponential([stream], lambda) Exponential distribution where mean value is 1/lambda and variance is 1/lambda^2 with an optional stream for seeding a random value to generator. gamma([stream], k, theta) Gamma distribution with shape k and scale theta with an optional stream for seeding a random value to generator. lognormal([stream], u, s) Log normal distribution for mean value u and standard deviation s with an optional stream for seeding a random value to generator. triangular([stream], min, mode, max) Triangular distribution for given min, mode and max values with an optional stream for seeding a random value to generator. uniform([stream], a, b) Uniform distribution in range a <= x < b with an optional stream for seeding a random value to generator. weibull([stream], k, lambda) Weibull distribution with shape k and scale lambda with an optional stream for seeding a random value to generator.
Expression	Calculated value of a given expression.
Integer	Integer value.
Matrix	4x4 matrix with position (Tx, Ty, Tz) and orientation (Rx, Ry, Rz) values.
Real	Real number value.
Simulation Node	Reference to a node in 3D world.
Simulation Node List	List of references to nodes in 3D world.
String	String of characters.
Uri	URI for referencing a file or resource.
Vector	Vector with direction (X, Y, Z) values that determine its magnitude.

Common Properties

All properties at the component level are objects that have their own set of properties for defining how to access the property and read/write its value.

Name	Description
Name	Defines the name of the property. A property's name can be used to assign the property to a tab in the Properties panel. The syntax is [TabName]::[PropertyName]. If the tab does not exist, a new tab will be generated and shown as long as the tab itself is assigned visible properties; otherwise the tab will be hidden. By default, properties are assigned to a Default tab, which is clearly marked when there are two or tabs displayed in the Properties panel.
Visible	Turns on/off the display of the property in the Properties panel.
On value change	Triggers an event and set of actions when the property's value is changed. Rebuild Rebuilds a component's geometry and re-evaluate expressions. Generally, you only need to enable Rebuild if the property is used with features or expressions in a node. Otherwise, Rebuild is an unnecessary action. Update simulation Update the 3D world (simulation root node) to show the current state of the component based on the property's value. Generally, you need Update simulation to configure a joint or update changes made to a component during a simulation.
Allow editing when	Defines the rules for setting the property's value. Disconnected Allows you to edit the property when the component is not connected to any other component. Connected Allows you to edit the property when the component is connected to any other component. Simulating Allows you to edit the property during a simulation.
Value	Defines the value of the property.