ColorParam¶
Inherits AnimatedParam
Synopsis¶
A color parameter is a RGB[A] value that can be animated throughout the time. See detailed description…
Functions¶
- def
get() - def
get(frame) - def
getDefaultValue([dimension=0]) - def
getDisplayMaximum(dimension) - def
getDisplayMinimum(dimension) - def
getMaximum([dimension=0]) - def
getMinimum([dimension=0]) - def
getValue([dimension=0]) - def
getValueAtTime(time[, dimension=0]) - def
restoreDefaultValue([dimension=0]) - def
set(r, g, b, a) - def
set(r, g, b, a, frame) - def
setDefaultValue(value[, dimension=0]) - def
setDisplayMaximum(maximum[, dimension=0]) - def
setDisplayMinimum(minimum[, dimension=0]) - def
setMaximum(maximum[, dimension=0]) - def
setMinimum(minimum[, dimension=0]) - def
setValue(value[, dimension=0]) - def
setValueAtTime(value, time[, dimension=0])
Detailed Description¶
A color parameter can either be of dimension 3 (RGB) or dimension 4 (RGBA). The user interface for this parameter looks like this:
This parameter type is very similar to a Double3DParam except that it can have 4 dimensions and has some more controls.
Member functions description¶
-
NatronEngine.ColorParam.get(frame)¶ Parameters: frame – floatReturn type: ColorTuple
Returns a ColorTuple of the color held by the parameter at the given frame.
-
NatronEngine.ColorParam.get() Return type: ColorTuple
Returns a ColorTuple of the color held by the parameter at the current timeline’s time.
-
NatronEngine.ColorParam.getDefaultValue([dimension=0])¶ Parameters: dimension – intReturn type: float
Returns the default value for this parameter at the given dimension.
-
NatronEngine.ColorParam.getDisplayMaximum(dimension)¶ Parameters: dimension – intReturn type: float
Returns the display maximum for this parameter at the given dimension. The display maximum is the maximum value visible on the slider, internally the value can exceed this range.
-
NatronEngine.ColorParam.getDisplayMinimum(dimension)¶ Parameters: dimension – intReturn type: float
Returns the display minimum for this parameter at the given dimension. The display minimum is the minimum value visible on the slider, internally the value can exceed this range.
-
NatronEngine.ColorParam.getMaximum([dimension=0])¶ Parameters: dimension – intReturn type: float
Returns the maximum for this parameter at the given dimension. The maximum value cannot be exceeded and any higher value will be clamped to this value.
-
NatronEngine.ColorParam.getMinimum([dimension=0])¶ Parameters: dimension – intReturn type: float
Returns the minimum for this parameter at the given dimension. The minimum value cannot be exceeded and any lower value will be clamped to this value.
-
NatronEngine.ColorParam.getValue([dimension=0])¶ Parameters: dimension – intReturn type: float
Returns the value of this parameter at the given dimension at the current timeline’s time.
-
NatronEngine.ColorParam.getValueAtTime(time[, dimension=0])¶ Parameters: - time –
float - dimension –
int
Return type: float- time –
Returns the value of this parameter at the given dimension at the given time.
-
NatronEngine.ColorParam.restoreDefaultValue([dimension=0])¶ Parameters: dimension – int
Removes all animation and expression set on this parameter and set the value to be the default value.
-
NatronEngine.ColorParam.set(r, g, b, a, frame)¶ Parameters: - r –
float - g –
float - b –
float - a –
float - frame –
float
- r –
Set a keyframe on each of the 4 animations curves at [r,g,b,a] for the given frame. If this parameter is 3-dimensional, the a value is ignored.
-
NatronEngine.ColorParam.set(r, g, b, a) Parameters: - r –
float - g –
float - b –
float - a –
float
- r –
Set the value of this parameter to be [r,*g*,*b*,*a*].
If this parameter is animated (see getIsAnimated(dimension)
then this function will automatically add a keyframe at the timeline’s current time.
-
NatronEngine.ColorParam.setDefaultValue(value[, dimension=0])¶ Parameters: - value –
float - dimension –
int
- value –
Set the default value of this parameter at the given dimension to be value.
-
NatronEngine.ColorParam.setDisplayMaximum(maximum[, dimension=0])¶ Parameters: - maximum –
float - dimension –
int
- maximum –
Set the display maximum of the parameter to be maximum for the given dimension.
See getDisplayMaximum
-
NatronEngine.ColorParam.setDisplayMinimum(minimum[, dimension=0])¶ Parameters: - minimum –
float - dimension –
int
- minimum –
Set the display minimum of the parameter to be minmum for the given dimension.
See getDisplayMinimum
-
NatronEngine.ColorParam.setMaximum(maximum[, dimension=0])¶ Parameters: - maximum –
float - dimension –
int
- maximum –
Set the maximum of the parameter to be maximum for the given dimension.
See getMaximum
-
NatronEngine.ColorParam.setMinimum(minimum[, dimension=0])¶ Parameters: - minimum –
float - dimension –
int
- minimum –
Set the minimum of the parameter to be minimum for the given dimension.
See getMinimum
-
NatronEngine.ColorParam.setValue(value[, dimension=0])¶ Parameters: - value –
float - dimension –
int
- value –
Set the value of this parameter at the given dimension to be value.
If this parameter is animated (see getIsAnimated(dimension)
then this function will automatically add a keyframe at the timeline’s current time.
-
NatronEngine.ColorParam.setValueAtTime(value, time[, dimension=0])¶ Parameters: - value –
float - time –
int - dimension –
int
- value –
Set a keyframe on each of the animation curve at the given dimension. The keyframe will be at the given time with the given value.