nuke.splinewarp.Shape

class nuke.splinewarp.Shape

Bases: _curveknob.Element

A Roto or SplineWarp shape, which may be animated.

Shapes are represented as a sequence of ShapeControlPoint objects, which group together a ‘center’ control point along with tangent locations and feather offsets. Python’s built-in len() function can be used to get the number of shape control points; and array-style access can be used to get individual shape control points (e.g. shape[0] returns the first shape control point, shape[-1] returns the last shape control point, etc.). You can create a new shape as follows:

>>>import _curveknob >>>rotoNode = nuke.toNode(‘RotoPaint1’) >>>curveKnob = rotoNode[‘curves’] >>>emptyShape = _curveknob.Shape( curveKnob ) >>>twoPointShape = _curveknob.Shape( curveKnob, *((0,0), (10,10)) ) >>> # perform operations on the shape(s).

NOTE: this object was designed to work for Roto shapes, which have feather: curves. Please report any problems with this type to support@thefoundry.co.uk

Methods

`append`	Add a new control point to the shape.
`clone`
`evaluate`	Bake out a curve for the outline of this shape at the specified time.
`getAttributes`	Gets the collection of attributes for this shape.
`getFlag`	Check whether a particular flag is set or not.
`getTransform`	Gets the transform for this shape.
`getVisible`	Get the value of the visible attribute at a particular time.
`insert`	Insert a new control point in the shape before the given index.
`remove`	Remove the control point at the given index.
`serialise`	Returns a string representation of the given element.
`setFlag`	Set a particular flag.
`setVisible`	Set the value of the visible attribute at a particular time.

Attributes

`locked`	Whether this element is locked.
`name`	The name for this element.

append(shapeControlPoint) → None: Add a new control point to the shape. The shapeControlPoint parameter must be either an instance of the ShapeControlPoint class, or something we can convert to a ShapeControlPoint. This includes a sequence of 2, 3 or 4 floats; a CVec2, CVec3 or CVec4 object; or an AnimControlPoint object.

clone() → elementCreate clone of element

evaluate(curveNum, time, viewName='default') → CubicCurve

Bake out a curve for the outline of this shape at the specified time.

Note that the feather curve is represented as an offset from the main curve. If you want to get the screen position of a point along the feather curve, you’ll need to add it to the corresponding position on the main curve. For example:

>>> frameNum = 10.0
>>> t = 0.5
>>> rotoknob = nuke.toNode('RotoPaint1')['curves']
>>> shape = rotoknob.toElement('Bezier1')
>>> mainCurve = shape.evaluate(0, frameNum)
>>> featherCurve = shape.evaluate(1, frameNum)
>>> pointOnMainCurve = mainCurve.getPoint(t)
>>> featherOffset = featherCurve.getPoint(t)
>>> pointOnFeatherCurve = pointOnMainCurve + featherOffset

Parameters

curveNum – 0 for the main curve, 1 for the feather curve.
time – The (floating point) frame number to bake the curve from.
viewName – Optional parameter specifying which view to bake the curve from. If omitted, the default view will be used.

getAttributes() → AnimAttributes: Gets the collection of attributes for this shape.

getFlag(flag) → bool: Check whether a particular flag is set or not. The flag parameter should be one of the constants from the FlagType class. The return value will be True if the flag is set, False if it isn’t.

getTransform() → AnimCTransform: Gets the transform for this shape.

getVisible(time) → bool: Get the value of the visible attribute at a particular time.

insert(index, shapeControlPoint) → None: Insert a new control point in the shape before the given index. The shapeControlPoint parameter must be either an instance of the ShapeControlPoint class, or something we can convert to a ShapeControlPoint. This includes a sequence of 2, 3 or 4 floats; a CVec2, CVec3 or CVec4 object; or an AnimControlPoint object.

locked: Whether this element is locked.

name: The name for this element.

remove(index) → None: Remove the control point at the given index. This removes any associated tangent and feather point data as well. If the index is out of bounds, an IndexError will be raised.

serialise() → string: Returns a string representation of the given element.

setFlag(flag, value) → None: Set a particular flag. The flag parameter specifies which flag to set and should be one of the constants from the FlagType class. The value parameter is a boolean value; True will set the flag, False will clear it.

setVisible(time, value) → None: Set the value of the visible attribute at a particular time. value must be a bool.