BooleanParam¶
Inherits AnimatedParam
Synopsis¶
A parameter that contains a boolean value. See detailed description below
Functions¶
- def
get() - def
get(frame) - def
getDefaultValue() - def
getValue() - def
getValueAtTime(time) - def
restoreDefaultValue() - def
set(x) - def
set(x, frame) - def
setDefaultValue(value) - def
setValue(value) - def
setValueAtTime(value, time)
Detailed Description¶
A BooleanParam looks like a checkbox in the user interface.
Member functions description¶
-
NatronEngine.BooleanParam.get()¶ Return type: bool
Returns the value of the parameter at the current timeline’s time.
-
NatronEngine.BooleanParam.get(frame) Parameters: frame – floatReturn type: bool
Returns the value of the parameter at the given frame. This value may be interpolated given the interpolation of the underlying animation curve.
-
NatronEngine.BooleanParam.getDefaultValue()¶ Return type: bool
Returns the default value for this parameter.
-
NatronEngine.BooleanParam.getValue()¶ Return type: bool
Same as get()
-
NatronEngine.BooleanParam.getValueAtTime(time)¶ Parameters: time – floatReturn type: bool
Same as get(frame)
-
NatronEngine.BooleanParam.restoreDefaultValue()¶
Removes all animation and expression set on this parameter and set the value to be the default value.
-
NatronEngine.BooleanParam.set(x)¶ Parameters: x – bool
Set the value of this parameter to be x. If this parameter is animated (see getIsAnimated(dimension)
then this function will automatically add a keyframe at the timeline’s current time.
-
NatronEngine.BooleanParam.set(x, frame) Parameters: - x –
bool - frame –
float
- x –
Set a new keyframe on the parameter with the value x at the given frame.
-
NatronEngine.BooleanParam.setDefaultValue(value)¶ Parameters: value – bool
Set the default value for this parameter.
-
NatronEngine.BooleanParam.setValue(value)¶ Parameters: value – bool
Same as set(value)
-
NatronEngine.BooleanParam.setValueAtTime(value, time)¶ Parameters: - value –
bool - time –
float
- value –
Same as set(value,time)