Using 2D Paths

Path2DParam represents a single Cubic Bezier curve in Autograph. A GeomGroup2DParam contains a list of Path2DParam. For each path, a boolean operation can be specified with the Geom2DParam.booleanOperation parameter.

You can retrieve the final composite geometry (also applying any modifier on it) by calling Geom2DParam.getGeometry().

Accessing the GeomGroup2D Param

The GeomGroup2DParam are usually found on the Shape:Stroke and Shape:Fill&Feather generators.

It can be accessed as any other Param:

stroke=Autograph.Effect('Autograph.StrokeShapeGenerator')
geomGroup=stroke.param('geometry')

Creating new Path2DParam

You can create a new Path2DParam and insert it in a GeomGroup2DParam

stroke=Autograph.Effect('Autograph.StrokeShapeGenerator')
geomGroup=stroke.param('geometry')

path=Autograph.Path2DParam()
path.setDisplayName('My Path')
geomGroup.addParam(path)

Editing Control points

A Path2DParam internally stores 2 cubic bezier curves: One for the main contour and one for the feather contour. When you add control points, the feather control points are simultaneously added to the path.

Each point added to the list actually adds 3 control points: The Left bezier control point, followed by the Central point (the curve passes by this point), followed by the Right control point.

The following figure explains how control points are connected

# Create a rectangle
path.insertControlPoint(-1, 0., 0.)
path.insertControlPoint(-1, 0., 100.)
path.insertControlPoint(-1, 100., 100.)
path.insertControlPoint(-1, 100., 0.)
path.closed = True

If the Path2DParam.closed attribute is set to True, the path will be closed.

For convenience, the GeomGroup2DParam.setToPath() function can take a Path2D and create automatically the corresponding Path2DParam . This is easier to do than manually creating the Path2DParam and setting control points.

Example

project=Autograph.app.getActiveProject()

# Create a new comp
comp=project.createComposition()

# Create a layer
layer=Autograph.Layer2D()
comp.addLayer(layer)

# Create a path
path=Autograph.Path2D()
path.addEllipse([0.,0.], 200., 200.)

# Create a Stroke generator
stroke=Autograph.Effect('Autograph.StrokeShapeGenerator')

# Set the GeomGroup2DParam geometry to the path we created
stroke.param('geometry').setToPath(path)

# Set the Stroke as generator of the source of the layer
layer.source.setGeneratorEffect(stroke)