Shape Type Methods¶
Form Inspection and Analysis¶
| Method | Description | 
|---|---|
| isEmpty() | Checks if the shape is empty. | 
| boundBox() | Returns the bounding box of the shape. | 
Topological Elements¶
| Method | Description | 
|---|---|
| vertices() | Returns a list of vertices of the shape. | 
| edges() | Returns a list of edges of the shape. | 
| nearFace() | Returns the nearest face of the shape. | 
| nearEdge() | Returns the nearest edge of the shape. | 
| nearVertex() | Returns the nearest vertex of the shape. | 
Style representations¶
| Method | Description | 
|---|---|
| fill() | Returns the filled shape. | 
| wire() | Returns the wireframe shape. | 
Shape Creation and Modification¶
| Method | Description | 
|---|---|
| extrude() | Extrudes the shape in 3D along a given direction. | 
| extrudeX() | Extrudes the shape along the X-axis. | 
| extrudeY() | Extrudes the shape along the Y-axis. | 
| extrudeZ() | Extrudes the shape along the Z-axis. | 
| unify() | Unifies the shape by merging its parts into one. | 
Boolean operations¶
| Method | Description | 
|---|---|
| unite() | Joins two shapes. | 
| intersect() | Finds the intersection of two shapes. | 
| difference() | Calculates the difference between two shapes (A - B). | 
| diff() | Alias for difference(). | 
Movement and Translation¶
| Method | Description | 
|---|---|
| translate() | Translates the shape by a given vector. | 
| translateX() | Translates the shape along the X-axis. | 
| translateY() | Translates the shape along the Y-axis. | 
| translateZ() | Translates the shape along the Z-axis. | 
| move() | Returns a new shape, moved by a given vector. | 
| moveX() | Returns a new shape, moved along the X-axis. | 
| moveY() | Returns a new shape, moved along the Y-axis. | 
| moveZ() | Returns a new shape, moved along the Z-axis. | 
Rotation¶
| Method | Description | 
|---|---|
| rotate() | Rotates the shape around an arbitrary axis. | 
| rotateX() | Rotates the shape around the X-axis. | 
| rotateY() | Rotates the shape around the Y-axis. | 
| rotateZ() | Rotates the shape around the Z-axis. | 
Reflection¶
| Method | Description | 
|---|---|
| mirrorO() | Reflects the shape about the origin (0, 0). | 
| mirrorX() | Reflects the shape about the X-axis. | 
| mirrorY() | Reflects the shape about the Y-axis. | 
| mirrorZ() | Reflects the shape about the Z-axis. | 
| mirrorXY() | Reflects the shape about the XY plane. | 
| mirrorYZ() | Reflects the shape about the YZ plane. | 
| mirrorXZ() | Reflects the shape about the XZ plane. | 
Scaling¶
| Method | Description | 
|---|---|
| scale() | Scales the shape with respect to the origin (0, 0). | 
| scaleX() | Scales the shape along the X-axis. | 
| scaleY() | Scales the shape along the Y-axis. | 
| scaleZ() | Scales the shape along the Z-axis. | 
| scaleXY() | Scales the shape in the XY plane. | 
| scaleYZ() | Scales the shape in the YZ plane. | 
| scaleXZ() | Scales the shape in the XZ plane. | 
| scaleXYZ() | Scales the shape uniformly along all axes. | 
Geometric Parameters¶
| Method | Description | 
|---|---|
| center() | Returns the center point of the shape. | 
| length() | Returns the length of the shape. | 
| area() | Returns the area of the shape. | 
| volume() | Returns the volume of the shape. | 
| firstParameter() | Returns the first parameter value of the shape. | 
| lastParameter() | Returns the last parameter value of the shape. | 
| pointAt() | Returns a point on the shape. | 
| interpolate() | Interpolates the shape. | 
| distance() | Returns the distance to the shape. | 
| extrema() | Returns the extremum values between the two shapes. | 
Export¶
| Method | Description | 
|---|---|
| toFileSTEP() | Saves the shape in a STEP file format. |