Shape

From sfx
Jump to navigation Jump to search

The Shape object represents a Bézier, B-Spline, or X-Spline shape that can animate over time.

Base Class: StereoscopicObject

Shapes can be created with Shape(type, label=None).

Attributes[edit]

Name Description Added
blendMode the blend mode
blurType the blur type
closed True if the shape is closed
inverted True if the shape alpha should be inverted
path the path property (same as shape.property('path') or shape['path'])
range the shape's t-range as a tuple (start, end)
shapeType the shape type
capStyle the open shape end-cap style (Shape.FlatCap or Shape.RoundCap) 6.0
featherType the feathering type (read-only, Shape.LegacyFeather or Shape.PerPointFeather) 6.0
numPoints the number of control points 7.0
numSelectedPoints the number of selected control points 7.0
selectedPoints the list of selected point indexes (formerly a method) 7.0

Methods[edit]

Name Description Added
createPath() create and return a new empty path - set with setPath()
createPath(frame) create and return a new empty path and set a key at frame
evalPath(frame) interpolate and return a path at the desired frame
isPointSelected(index) return True if the control point index is selected
selectAllPoints(state=True) select (or deselect) all of the control points
selectPoint(index, state=True) select (or deselect) the control point at index
selectPoints(indexes, state=True) select (or deselect) the List of control point at indexes
setPath(path, frame) set the path as a keyframe at frame
convertToBezier() creates and returns a Bezier version of the current shape 6.0

Constants[edit]

Shape Type[edit]

Name Description
Bezier a Bézier shape
Bspline a B-Spline shape
Xspline an X-Spline shape