SVGDocument

Maximum Y value of the axis aligned bounding box (from corner and size)

Imagine travelling in a straight line cutting through the shape. The convexity is the maximum number of times your will enter the shape. For square and circle, this is 1. For a convex shape with a hole, it is 2. For a shape with a single concave part, such as a banana, it is also 2.

The bottom left corner. In association with size determines the axis aligned bounding box.

A list of the 4 corners which make up the axis aligned bounding box. (from corner and size).

Most Shape2d have exactly one path within paths, this is a convenience method which returns that path.

Minimum Y value of the axis aligned bounding box (from corner and size)

Minimum x value of the axis aligned bounding box (from corner and size)

The middle of the axis aligned bounding box (from corner and size). This may differ from the middle according to paths's points. For example, consider a circle with a chunk cut out of it :

The 2D points which define the lines around the shape. This is a list of Path2d because a shape can have holes (so there's one path for the exterior, and one path for each hole). Also, a shape can be a compound of more than one exterior shape. e.g. If we have 2 circles (like a 'colon' symbol) we can define it using a single Shape2d with two paths.

Maximum x value of the axis aligned bounding box (from corner and size)

A map of the shapes, keyed on the object's ID. To set the object's id from Inkscape use the "Object Properties" dialog (Shift+Ctrl+O).

The size of the axis aligned bounding box. Note, the bounding box may grow larger than you imagine. For example, if you rotate a shape, and then rotate it back again, the bounding box will have grown.

A map of feather code snippets keyed on the object's ID. The code snippets will contain calls to PolygonBuilder. Note, snippets are ONLY available for SVG paths. Other objects such as rect, circle, ellipse, polygon, polyline are NOT converted into code snippets.

Uses corner and size to center the object to (0,0,0)

Moves the center of this shape to xy.

Uses corner and size to center the object about the X axis only.

Uses corner and size to center the object about the Y axis only.

Creates a single complex Polygon from the two shapes. This only differs from hole because hole reverses the order of the other shape's points.

If this Shape is a Shape2dDependent

Wherever this and other overlap there is a void. The rest of this shape remains unchanged. other does not appear in the result.

An operator which is the same as intersection.

Checks that this shape's paths are ordered correctly. All paths are tests to see how many of the other paths contain it. If the answer is odd, it is assumed to be a hole, and the order of the points is made clockwise. If the answer is even, then the order of the points is made anticlockwise.

Extrude a 2D shape upwards (in the Z direction) to form a 3D shape (an extrusion).

Extrude this 2D shape along a 3D path.

Extrude this 2D shape around the edge of another Shape2d (aroundShape).

Mirror along the line X=Y. i.e. the X and Y values are switched over.

Creates a single complex Polygon from the two shapes. This only differs from and by reversing the order of the other shape's points.

Combines this shape and the other shape, such that only the places that the two shapes overlap are present in the result.

Labels a shape, so that we can collect all the important labelled shapes, and ignore the others.

Does not change the shape, only the axis aligned bounding box defined by corner and size. This will alter how methods such as toOrigin and 'tileX' in the 'layout' extension.

An operator which is the same as difference.

Uses OpedSCAD's built-in offset module to grow/shrink this 2d shape.

Uses OpedSCAD's built-in offset module to grow/shrink this 2d shape.

An operator which is the same as union.

Finds the index into the firstPath's points list of the corner nearest to the given point. This assumes paths is defined, and contains a single list (i.e. is a simple polygon, with no holes).

Finds the index into the firstPath's points list of the corner nearest to (x, y). This assumes paths is defined, and contains a single list (i.e. is a simple polygon, with no holes).

Shows as transparent in OpenSCAD's preview mode, but is NOT included in the final rendered version, and therefore will NOT be printed.

Similar to Shape2d.difference (or the minus operator), but the cavity remains as a 1st class object, which will remain as a cavity after using two or more shapes via the and method.

Adds additional points, so that the difference between adjacent points is no more than res. This is useful with some transforms.

Adds additional points, so that the difference between adjacent points is no more than res. This is useful with some transforms.

Adds additional points, so that the difference between adjacent points is no more than res. This is useful with some transforms.

Create a solid of revolution. Take this object, stand it up, so that it is on the plane Y=0, and then spin it around the Z axis.

Create a solid of revolution. Take this object, stand it up, so that it is on the plane Y=0, and then spin it angle degrees around the Z axis.

Similar to roundCorner, but rounds all corners.

Creates a new shape, rounding a single corner. This assumes paths is defined, and contains a single list (i.e. is a simple polygon, with no holes).

Similar to roundCorner, but rounds any number of corners.

Applies an arbitrary transformation. This is equivalent to OpenSCAD's 'multmatrix'. Identical to transform, but as this is a times operator can be used like to :

Convert a FooCAD Shape2d into jts Geometry.

This is here only for completeness, at time of writing, this wasn't being used.

Uses corner to move the object to the origin.

Uses corner to move the object so that it's X value is 0 (i.e. it is touching the Y axis).

Uses corner to move the object so that it's Y value is 0 (i.e. it is touching the X axis). This is the same as frontToOrigin unless this shape has been scaled by a negative amount! See also backToOrigin.

Converts to a Polygon using this shapes paths data. Useful for debugging, and in some instances, the generated scad file will be smaller (but even more inscrutable).

Applies an arbitrary transformation. This is equivalent to OpenSCAD's 'multmatrix'. Beware that using negative scales can change the order of the points. Which will leave the shape mal-formed.

Some operations, such as transform require the paths data. This isn't available for Union2d, Difference2d and Intersection2d, so it may seem impossible to transform a union, difference or intersection. We can though. If we pull the component parts out of the union/difference/intersection, apply the transformation to those shapes, and then recombine the results, everything works out fine.

Combines two shapes together to form a single Shape2d.