shape.Box

Create closed box centered at origin

Since R2023b

Description

The shape.Box lets you create a box with metal and dielectric material properties centered at the origin. Use this box along with the other shapes and the geometric operations to create a shape for the custom antenna.

Creation

Syntax

box = shape.Box

box = shape.Box(Name=Value)

Description

box = shape.Box creates a closed box centered at the origin.

box = shape.Box(Name=Value) sets additional Properties using one or more name-value arguments. Name is the property name and Value is the corresponding value. You can specify several name-value arguments in any order as Name1=Value1, ..., NameN=ValueN. Properties that you do not specify retain their default values.

Properties

Name — Box name

"mybox" (default) | string

Box name, specified as a string.

Example: "Box1"

Data Types: string

Center — Box center point

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

Box center point, specified as a three-element vector of Cartesian coordinates in meters.

Example: [1 1 1]

Data Types: double

Length — Length of box

1 (default) | positive scalar

Length of the box along the x-axis, specified as a scalar in meters.

Example: 2

Data Types: double

Width — Width of box

2 (default) | positive scalar

Width of the box along the y-axis, specified as a scalar in meters.

Example: 4

Data Types: double

Height — Height of box

2 (default) | positive scalar

Height of the box along the z-axis, specified as a scalar in meters.

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

Dielectric — Dielectric material of shape

"Air" (default) | string

Dielectric material of the shape, specified as a dielectric name string from the Dielectric Catalog.

Example: "Teflon"

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

add	Boolean unite operation on two shapes
subtract	Boolean subtraction operation on two shapes
intersect	Intersection of shape1 and shape2
plus	Join two shapes
minus	Carve a shape from other shape
and	Boolean intersection operation on two shapes
show	Display antenna, array structures, shapes, or platform
mesh	Mesh properties of metal, dielectric antenna, or array structure
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
translate	Move shape to new location
scale	Change size of shape by fixed factor
showFaces	Show face numbers of box
deleteFaces	Delete specified faces of box
imprintShape	Imprint 2-D shape on another shape
createHole	Create a 2-D hole on custom shape
extrude	Extrude 2-D shape on another shape
removeFaces	Interactively select and remove 3-D shape faces
addSubstrate	Add dielectric substrate to metal shape

Examples

Join Box and Custom 3-D Shape

Create and join a box and a custom 3-D shape.

b = shape.Box;
c = shape.Custom3D; 
s = plus(b,c)

s = 
  Custom3D with properties:

            Name: 'custom3D'
        Vertices: [23x3 double]
           Metal: 'PEC'
      Dielectric: 'Air'
           Color: 'Individual'
    Transparency: 'Individual'
       EdgeColor: 'Individual'

Alternatively, you can directly join shapes using the '+' operator.

b + c;

Version History

Introduced in R2023b