Main Content

shape.Box

Create closed box centered at origin

Since R2023b

expand all in page

    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.

    example

    Properties

    expand all

    Box name, specified as a string.

    Example: "Box1"

    Data Types: string

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

    Example: [1 1 1]

    Data Types: double

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

    Example: 2

    Data Types: double

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

    Example: 4

    Data Types: double

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

    Example: 4

    Data Types: double

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

    Example: "Copper"

    Data Types: string

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

    Example: "Teflon"

    Data Types: string

    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 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

    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

    addBoolean unite operation on two shapes
    subtractBoolean subtraction operation on two shapes
    intersectIntersection of shape1 and shape2
    plusJoin two shapes
    minusCarve a shape from other shape
    andBoolean intersection operation on two shapes
    showDisplay antenna, array structures, shapes, or platform
    meshMesh properties of metal, dielectric antenna, or array structure
    rotateRotate shape about axis by angle
    rotateXRotate shape about x-axis by angle
    rotateYRotate shape about y-axis by angle
    rotateZRotate shape about z-axis by angle
    translateMove shape to new location
    scaleChange size of shape by fixed factor
    showFacesShow face numbers of box
    deleteFacesDelete specified faces of box
    imprintShapeImprint 2-D shape on another shape
    createHoleCreate a 2-D hole on custom shape
    extrudeExtrude 2-D shape on another shape
    removeFacesInteractively select and remove 3-D shape faces
    addSubstrateAdd dielectric substrate to metal shape

    Examples

    collapse all

    Open Live Script

    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;

    Figure contains an axes object. The axes object with xlabel x (m), ylabel y (m) contains 3 objects of type patch.

    Version History

    Introduced in R2023b

    See Also

    Functions

    Objects