IntParam

Inherited by: Int2DParam, Int3DParam

Synopsis

An IntParam can contain one or multiple int 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

An int param can have 1 to 3 dimensions. (See Int2DParam and Int3DParam). Usually this is used to represent a single integer value that may animate over time.

The user interface for them varies depending on the number of dimensions. Screenshots are the same than for the :doc`DoubleParam` because the user interface is the same

A 1-dimensional IntParam

A 2-dimensional Int2DParam

A 3-dimensional Int3DParam

Member functions description

NatronEngine.IntParam.get(frame)

Parameters:: frame – float
Return type:: int

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.IntParam.get()

Return type:: int

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

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

Parameters:: dimension – int
Return type:: int

Returns the default value for this parameter. dimension is meaningless for the IntParam class because it is 1-dimensional, but is useful for inherited classes Int2DParam and Int3DParam

NatronEngine.IntParam.getDisplayMaximum(dimension)

Parameters:: dimension – int
Return type:: int

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

Parameters:: dimension – int
Return type:: int

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.IntParam.getMaximum([dimension=0])

Parameters:: dimension – int
Return type:: int

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.IntParam.getMinimum([dimension=0])

Parameters:: dimension – int
Return type:: int

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.IntParam.getValue([dimension=0])

Parameters:: dimension – int
Return type:: int

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

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

Parameters:

time – float
dimension – int

Return type:

int

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.IntParam.restoreDefaultValue([dimension=0])

Parameters:: dimension – int

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

NatronEngine.IntParam.set(x, frame)

Parameters:

x – int
frame – float

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

NatronEngine.IntParam.set(x)

Parameters:: x – int

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

Parameters:

value – int
dimension – int

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

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

Parameters:

maximum – int
dimension – int

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

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

Parameters:

minimum – int
dimension – int

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

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

Parameters:

maximum – int
dimension – int

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

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

Parameters:

minimum – int
dimension – int

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

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

Parameters:

value – int
dimension – int

Same as set(value,dimension)

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

Parameters:

value – int
time – float
dimension – int

Same as set(value,time,dimension)