User Tools

Site Tools


channel_bool

Description

Defines properties of a boolean-valued channel. Only determinate true and false values are supported. Indeterminate boolean states (tri-states) are not supported.

Parent Objects

Extends

Properties

Name Description Default Required
min An int representing the minimum value for the parameter, or for each component of a vector-valued channel. 0.0 no
max An int representing the maximum value for the parameter, or for each component of a vector-valued channel. 1.0 no
clamped A boolean value representing whether or not min and max are enforced. false no
step_size An int representing the step size, or paging size, to use for this parameter when presenting UI to the user. Effectively a scaling value. Value applies to all components of a vector-valued channel. 1.0 no
value A boolean value representing the default value for the parameter. false no
current_value A boolean value representing the current value for the parameter. false no
mappable A boolean value representing whether or not the channel is mappable. false no

Details

The current_value attribute is overridden anytime an animation is associated with the channel.

Example

{
	"id" : "Multiply Specular Through Opacity",
	"type" : "bool",
	"name" : "Multiply Specular Through Opacity",
	"label" : "Multiply Specular Through Opacity",
	"value" : true
}