DoubleParam

Inherited by: Double2DParam, Double3DParam

Synopsis

A double param can contain one or multiple floating point values. 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 (x)
def set (x, 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 double param can have 1 to 3 dimensions. (See Double2DParam and Double3DParam). Usually this is used to represent a single floating point value that may animate over time.

The user interface for them varies depending on the number of dimensions.

A 1-dimensional DoubleParam

A 2-dimensional Double2DParam

A 3-dimensional Double3DParam

Member functions description

NatronEngine.DoubleParam.get(frame)

Parameters: frame – float
Return type: float

Returns the value of this parameter at the given frame. If the animation curve has an animation (see getIsAnimated(dimension) then the value will be interpolated using the interpolation chosen by the user for the curve.

NatronEngine.DoubleParam.get()

Return type: float

Returns the value of this parameter at the given current timeline’s time.

NatronEngine.DoubleParam.getDefaultValue([dimension=0])

Parameters: dimension – int
Return type: float

Returns the default value for this parameter. dimension is meaningless for the DoubleParam class because it is 1-dimensional, but is useful for inherited classes Double2DParam and Double3DParam

NatronEngine.DoubleParam.getDisplayMaximum(dimension)

Parameters: dimension – int
Return type: double

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.DoubleParam.getDisplayMinimum(dimension)

Parameters: dimension – int
Return 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.DoubleParam.getMaximum([dimension=0])

Parameters: dimension – int
Return 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.DoubleParam.getMinimum([dimension=0])

Parameters: dimension – int
Return 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.DoubleParam.getValue([dimension=0])

Parameters: dimension – int
Return type: float

Returns the value of this parameter at the given dimension at the current timeline’s time.

NatronEngine.DoubleParam.getValueAtTime(time[, dimension=0])

Parameters

time – float
dimension – int

Return type

float

Returns the value of this parameter at the given dimension at the given time.

If the animation curve has an animation (see getIsAnimated(dimension) then the value will be interpolated using the interpolation chosen by the user for the curve.

NatronEngine.DoubleParam.restoreDefaultValue([dimension=0])

Parameters: dimension – int

Returns the value of this parameter at the given dimension at the given time.

NatronEngine.DoubleParam.set(x, frame)

Parameters

x – float
frame – float

Set a new keyframe on the parameter with the value x at the given frame.

NatronEngine.DoubleParam.set(x)

Parameters: x – float

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.DoubleParam.setDefaultValue(value[, dimension=0])

Parameters

value – float
dimension – int

Set the default value for this parameter at the given dimension.

NatronEngine.DoubleParam.setDisplayMaximum(maximum[, dimension=0])

Parameters

maximum – float
dimension – int

Set the display maximum of the parameter to be maximum for the given dimension. See getDisplayMaximum

NatronEngine.DoubleParam.setDisplayMinimum(minimum[, dimension=0])

Parameters

minimum – float
dimension – int

Set the display minimum of the parameter to be minmum for the given dimension. See getDisplayMinimum

NatronEngine.DoubleParam.setMaximum(maximum[, dimension=0])

Parameters

maximum – float
dimension – int

Set the maximum of the parameter to be maximum for the given dimension. See getMaximum

NatronEngine.DoubleParam.setMinimum(minimum[, dimension=0])

Parameters

minimum – float
dimension – int<PySide.QtCore.int<

Set the minimum of the parameter to be minimum for the given dimension. See getMinimum

NatronEngine.DoubleParam.setValue(value[, dimension=0])

Parameters

value – float
dimension – int

Same as set(value,dimension)

NatronEngine.DoubleParam.setValueAtTime(value, time[, dimension=0])

Parameters

value – float
time – float
dimension – int

Same as set(value,time,dimension)