shape.Circle

Create circle centered at origin on xy-plane

Since R2023b

Description

The shape.Circle lets you create a circle with metal material properties on the xy-plane, centered at the origin. Use this circle along with the other shapes and the geometric operations to create a shape for the custom antenna.

Creation

Syntax

circ = shape.Circle

circ = shape.Circle(PropertyName=Value)

Description

circ = shape.Circle creates a circle centered at the origin and on the xy-plane.

circ = shape.Circle(PropertyName=Value) sets properties using one or more name-value arguments. PropertyName is the property name and Value is the corresponding value. You can specify several name-value arguments in any order as PropertyName1=Value1, ..., PropertyNameN=ValueN. Properties that you do not specify retain their default values.

For example, circ = shape.Circle(Radius=4) creates a circle with a radius of 4 m and default values for other properties.

Properties

Name — Circle name

"mycircle" (default) | string

Circle name, specified as a string.

Example: "Circle1"

Data Types: string

Center — Circle center point

[0 0] (default) | two-element real vector

Circle center point, specified as a two-element vector of Cartesian coordinates in meters.

Example: [1 1]

Data Types: double

Radius — Radius of circle

1 (default) | positive scalar

Radius of the circle, specified as a scalar in meters.

Example: 2

Data Types: double

NumPoints — Number of discretization points

30 (default) | positive scalar

Number of discretization points along the circumference, specified as a scalar.

Example: 4

Data Types: double

Metal — Metal material of shape

"PEC" (default) | string

Metal material of the shape, specified as a metal name string from the Metal Catalog.

Example: "Copper"

Data Types: string

Color — Color of shape

"y" (default) | character scalar | "Individual" | three-element real vector of RGB triplet

Color of shape, specified as either a character for color short name or a three-element real vector of RGB triplets. The default shape color is yellow. See the Types of Color Values supported by this property. When you unite two shapes of different colors, use "Individual" value to retain the colors of the original shapes in the resultant shape.

Example: "r"

Example: [0 0.447 0.741]

Data Types: double | string | char

Transparency — Transparency of shape

1 (default) | positive scalar within (0,1)

Transparency of shape, specified as a scalar in the (0,1) range, where 0 corresponds to full transparency while 1 corresponds to full opaqueness.

Example: 0.75

Data Types: double

EdgeColor — Color of shape edges

"k" (default) | character scalar | "Individual" | three-element real vector of RGB triplet

Color of shape edges, specified as either a character for color short name or a three-element real vector of RGB triplets. The default edge color is black. See the Types of Color Values supported by this property. When you unite two shapes of different edge colors, use "Individual" value to retain the edge colors of the original shapes in the resultant shape.

Example: "b"

Example: [0.4940 0.1840 0.5560]

Data Types: double | string | char

Object Functions

Boolean Operation

add	Perform Boolean unite operation on two shapes
and	Perform Boolean intersection operation on two shapes
area	Calculate area of 2-D shapes in square meters
intersect	Generate and plot intersection of two shapes
minus	Carve a shape from other shape
plus	Join two shapes
subtract	Perform Boolean subtraction operation on two shapes

Modification

createHole	Create a 2-D hole on custom shape
extrude	Extrude 2-D shape on another shape
extrudeLinear	Linearly extrude 2-D shape along specified direction
extrudeRotate	Extrude 2-D shape by angle about z-axis
imprintShape	Imprint 2-D shape on another shape
removeSlivers	Remove sliver outliers from shape boundary

Rotation and Scaling

rotate	Rotate shape about axis by angle
rotateX	Rotate shape about x-axis by angle
rotateY	Rotate shape about y-axis by angle
rotateZ	Rotate shape about z-axis by angle
scale	Change size of shape by fixed factor
translate	Move shape to new location

Meshing and Visualization

getShapeVertices	Find shape vertices
mesh	Generate and view mesh for antennas, arrays, and custom shapes
plot	Plot boundary of 2-D shape
show	Display antenna, array structures, shapes, or platform

Examples

Cut Hole in Circle

Create a circle of radius 1 m. Make a circular hole of radius 10 cm at the center and view the resultant shape.

c = shape.Circle;
h = shape.Circle(Radius=0.1);
s = c - h;
show(s)

Mesh the shape with a maximum edge length of 20 cm.

mesh(s,MaxEdgeLength=2e-1)

Version History

Introduced in R2023b