Double2DParam

Inherits DoubleParam

Inherited by: Double3DParam

Synopsis

See DoubleParam for more information on this class.

Functions

  • def setUsePointInteract<NatronEngine.Double2DParam.setUsePointInteract() (enabled)

  • def setCanAutoFoldDimensions<NatronEngine.Double2DParam.setCanAutoFoldDimensions() (enabled)

  • def get ()

  • def get (frame)

  • def set (x, y)

  • def set (x, y, frame)

Member functions description

NatronEngine.Double2DParam.setUsePointInteract(enabled)
Parameters

enabled – bool

When called, the parameter will have its own overlay interact on the viewer as a point that the user can select and drag.

../../../_images/positionInteract.png
NatronEngine.Double2DParam.setCanAutoFoldDimensions(enabled)
Parameters

enabled – bool

Sets whether all dimensions should be presented as a single value/slider whenever they are equal.

NatronEngine.Double2DParam.get()
Return type

Double2DTuple

Returns a Double2DTuple with the [x,y] values for this parameter at the current timeline’s time.

NatronEngine.Double2DParam.get(frame)
Parameters

frame – float

Return type

Double2DTuple

Returns a Double2DTuple with the [x,y] values for this parameter at the given frame.

NatronEngine.Double2DParam.set(x, y, frame)
Parameters

  • x – float

  • y – float

  • frame – float

Same as set(x,frame) but for 2-dimensional doubles.

NatronEngine.Double2DParam.set(x, y)
Parameters

  • x – float

  • y – float

Same as set(x) but for 2-dimensional doubles.