subtract

Perform Boolean subtraction operation on two shapes

Syntax

subtract(shape1,shape2)

subtract(shape1,shape2,RetainShape=0)

c = subtract(shape1,shape2)

c = subtract(shape1,shape2,RetainShape=0)

Description

subtract(shape1,shape2) carves out the intersecting region of the shape2 and shape1 from shape1 using the subtract operation and plots the resultant shape retaining the enclosed region of shape2 within shape1. Adjust the Transparency property of the shapes to view the retained individual shape portion in the resultant shape. Alternatively, you can also use the '-' operator to carve out a shape from other shape (shape1 - shape2).

subtract(shape1,shape2,RetainShape=0) carves out the intersecting region of the shape2 and shape1 from shape1 and plots the resultant shape while merging both shapes.

c = subtract(shape1,shape2) carves out the intersecting region of the shape2 and shape1 from shape1 using the subtract operation retaining the enclosed region of shape2 within shape1 and returns a polygon object for resultant 2-D shape or a custom 3-D object for resultant 3-D shape. Adjust the Transparency property of the shapes to view the retained individual shape portion in the resultant shape. Alternatively, you can also use the '-' operator to perform the subtraction operation (c = shape1 - shape2).

c = subtract(shape1,shape2,RetainShape=0) carves out the intersecting region of the shape2 and shape1 from shape1 while merging both the shapes and returns a custom 3-D object for the resultant 3-D shape.

Examples

Create Notched Rectangle

Create a rectangle with a length of 0.15 m, and a width of 0.15 m.

r  = antenna.Rectangle(Length=0.15,Width=0.15);

Create a second rectangle with a length of 0.05 m, and a width of 0.05 m. Set the center of the second rectangle at half the length of the first rectangle r.

n = antenna.Rectangle(Center=[0.075,0],Length=0.05,Width=0.05);

Create and view a notched rectangle by subtracting n from r.

rn  = r-n;
show(rn)

Calculate the area of the notched rectangle.

area(rn)

ans = 
0.0212

Create Hollow Square Nut Shape

This example shows how to create a hollow square nut shape by carving out a sphere from a box shape.

Create and view a spherical shape.

a = shape.Sphere(Color=[0.9290 0.6940 0.1250]);
show(a)

Create and view a box shape.

b = shape.Box(Color=[0.9290 0.6940 0.1250]);
show(b)

Carve out the sphere from the box and view the resultant shape.

subtract(b,a);

Input Arguments

shape1,shape2 — Shapes to perform subtract operation

shape object

Shapes to perform subtract operation, specified as objects from the following list:

• 2-D shapes without material properties:

  • antenna.Circle

  • antenna.Ellipse

  • antenna.Polygon

  • antenna.Rectangle

  • antenna.Triangle

• 2-D and 3-D shapes with material properties:

  • shape.Circle

  • shape.Ellipse

  • shape.Rectangle

  • shape.Polygon

  • shape.Box

  • shape.OpenBox

  • shape.Cylinder

  • shape.OpenCylinder

  • shape.Sphere

  • shape.Custom3D

Example: subtract(antenna.Rectangle,antenna.Circle)

Example: subtract(shape.Box,shape.Sphere)

Output Arguments

c — Resultant 2D or 3D shape

antenna.Polygon | shape.Polygon | shape.Custom3D

Resultant 2D or 3D shape after carving out shape2 from shape1, returned as one of the following shape objects:

• antenna.Polygon

• shape.Polygon

• shape.Custom3D

Example: antenna.Polygon

Example: shape.Polygon

Example: shape.Custom3D

Version History

Introduced in R2017a