Box

Example

app = cf.GetApplication()
project = app:NewProject()

corner = cf.Point(0,0,0)
Rectangle1 = project.Geometry:AddRectangle(corner, 1, 1)

    -- Retrieve the 'BoundingBox' of the rectangle

boundingBox = Rectangle1.Faces["Face1"].BoundingBox

    -- Access the 'Width' of the rectangle's 'BoundingBox'

width = boundingBox.Width

    -- Access the corner of the 'BoundingBox' furthest from the origin

boundingBoxCorner = boundingBox.Corner2

Usage locations

The Box object can be accessed from the following locations:

• Properties
  • CableConnectorCollection collection has property BoundingBox.
  • CableInstanceCollection collection has property BoundingBox.
  • CablePathCollection collection has property BoundingBox.
  • MeshCollection collection has property BoundingBox.
  • GeometryCollection collection has property BoundingBox.
  • GeometryGroup collection has property BoundingBox.
  • SolutionConfigurationCollection collection has property BoundingBox.
  • SourceCollection collection has property BoundingBox.
  • ProtectedModels collection has property BoundingBox.
  • Model object has property BoundingBox.
  • AbstractAntennaArray object has property BoundingBox.
  • CylindricalAntennaArray object has property BoundingBox.
  • LinearPlanarArray object has property BoundingBox.
  • CustomAntennaArray object has property BoundingBox.
  • CableConnector object has property BoundingBox.
  • CableHarness object has property BoundingBox.
  • CableInstance object has property BoundingBox.
  • CablePath object has property BoundingBox.
  • CablePathTerminal object has property BoundingBox.
  • Cables object has property BoundingBox.
  • AbstractMeshEdge object has property BoundingBox.
  • AbstractMeshTriangleFace object has property BoundingBox.
  • MeshCurvilinearTriangleFace object has property BoundingBox.
  • MeshTriangleFace object has property BoundingBox.
  • MeshCurvilinearWire object has property BoundingBox.
  • MeshCurvilinearSegmentWire object has property BoundingBox.
  • MeshWire object has property BoundingBox.
  • MeshSegmentWire object has property BoundingBox.
  • MeshCylinder object has property BoundingBox.
  • MeshPlate object has property BoundingBox.
  • MeshRegion object has property BoundingBox.
  • MeshTetrahedronRegion object has property BoundingBox.
  • MeshRefinementRule object has property BoundingBox.
  • AdaptiveRefinement object has property BoundingBox.
  • PointRefinement object has property BoundingBox.
  • PolylineRefinement object has property BoundingBox.
  • Mesh object has property BoundingBox.
  • Geometry object has property BoundingBox.
  • AnalyticalCurve object has property BoundingBox.
  • BezierCurve object has property BoundingBox.
  • Cone object has property BoundingBox.
  • ConstrainedSurface object has property BoundingBox.
  • Cuboid object has property BoundingBox.
  • Cylinder object has property BoundingBox.
  • Ellipse object has property BoundingBox.
  • EllipticArc object has property BoundingBox.
  • FittedSpline object has property BoundingBox.
  • Flare object has property BoundingBox.
  • Helix object has property BoundingBox.
  • HyperbolicArc object has property BoundingBox.
  • ImprintPoints object has property BoundingBox.
  • Intersect object has property BoundingBox.
  • Loft object has property BoundingBox.
  • PathSweep object has property BoundingBox.
  • ProjectGeometry object has property BoundingBox.
  • RepairAndSewFaces object has property BoundingBox.
  • RepairPart object has property BoundingBox.
  • Spin object has property BoundingBox.
  • Split object has property BoundingBox.
  • Stitch object has property BoundingBox.
  • Subtract object has property BoundingBox.
  • Sweep object has property BoundingBox.
  • Union object has property BoundingBox.
  • Simplify object has property BoundingBox.
  • Line object has property BoundingBox.
  • NurbsSurface object has property BoundingBox.
  • ParabolicArc object has property BoundingBox.
  • Paraboloid object has property BoundingBox.
  • Polygon object has property BoundingBox.
  • Polyline object has property BoundingBox.
  • Primitive object has property BoundingBox.
  • Rectangle object has property BoundingBox.
  • Sphere object has property BoundingBox.
  • AbstractSurfaceCurve object has property BoundingBox.
  • SurfaceBezierCurve object has property BoundingBox.
  • SurfaceLine object has property BoundingBox.
  • SurfaceRegularLines object has property BoundingBox.
  • Edge object has property BoundingBox.
  • Face object has property BoundingBox.
  • Region object has property BoundingBox.
  • WorkSurface object has property BoundingBox.
  • FDTDBoundaryConditions object has property BoundingBox.
  • Port object has property BoundingBox.
  • CablePort object has property BoundingBox.
  • EdgeMeshPort object has property BoundingBox.
  • EdgePort object has property BoundingBox.
  • AbstractFEMLinePort object has property BoundingBox.
  • FEMLineMeshPort object has property BoundingBox.
  • FEMLinePort object has property BoundingBox.
  • FEMModalMeshPort object has property BoundingBox.
  • FEMModalPort object has property BoundingBox.
  • AbstractMeshPort object has property BoundingBox.
  • MicrostripMeshPort object has property BoundingBox.
  • WireMeshPort object has property BoundingBox.
  • MicrostripPort object has property BoundingBox.
  • WaveguideMeshPort object has property BoundingBox.
  • WaveguidePort object has property BoundingBox.
  • WirePort object has property BoundingBox.
  • StandardConfiguration object has property BoundingBox.
  • CurrentSource object has property BoundingBox.
  • FEMModalSource object has property BoundingBox.
  • VoltageSource object has property BoundingBox.
  • WaveguideSource object has property BoundingBox.
  • AbstractIdealSource object has property BoundingBox.
  • AbstractPointSource object has property BoundingBox.
  • ElectricDipole object has property BoundingBox.
  • MagneticDipole object has property BoundingBox.
  • ImpressedCurrent object has property BoundingBox.
  • FarFieldSource object has property BoundingBox.
  • NearFieldSource object has property BoundingBox.
  • PCBSource object has property BoundingBox.
  • SolutionCoefficientSource object has property BoundingBox.
  • SphericalModeSource object has property BoundingBox.
  • PlaneWave object has property BoundingBox.
  • BaseFieldReceivingAntenna object has property BoundingBox.
  • FarFieldReceivingAntenna object has property BoundingBox.
  • NearFieldReceivingAntenna object has property BoundingBox.
  • SphericalModeReceivingAntenna object has property BoundingBox.
  • Load object has property BoundingBox.
  • NearField object has property BoundingBox.
  • SolutionSettings object has property BoundingBox.
  • ModelContents object has property BoundingBox.
  • ModelDefinitions object has property BoundingBox.
  • ProtectedModel object has property BoundingBox.
• Static functions

Property List

Centre

The centre of the box. (Read only Point)

Corner1

The corner of the box closest to the origin. (Read only Point)

Corner2

The second corner of the box farthest from the origin. (Read only Point)

Depth

The depth of the box (how long it is along the Y axis). (Read only number)

Height

The Height of the box (how long it is along the Z axis). (Read only number)

Type

The object type string. (Read only string)

Width

The width of the box (how long it is along the X axis). (Read only number)

Property Details

Centre

The centre of the box.

Type

Point

Access

Read only

Corner1

The corner of the box closest to the origin.

Type

Point

Access

Read only

Corner2

The second corner of the box farthest from the origin.

Type

Point

Access

Read only

Depth

The depth of the box (how long it is along the Y axis).

Type

number

Access

Read only

Height

The Height of the box (how long it is along the Z axis).

Type

number

Access

Read only

Type

The object type string.

Type

string

Access

Read only

Width

The width of the box (how long it is along the X axis).

Type

number

Access

Read only