PlateModel.AddBoxOfPlates(String, Array, Array) Method

Top 

Description

Adds six plates to the Spacecraft in a cube or rectangular prism shape. The box is defined by x, y, and z dimensions in the Spacecraft body coordinate system, and centered at centerPosition. The plates will be automatically named using boxName as the prefix, and the face orientation as the suffix.

 

You must set the Spacecraft's ForceModel.SRPForceGeometry to "PlateModel" for this to have an effect.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Method Signature

PlateModel.AddBoxOfPlates(

String boxName,


Array dimensions,


Array centerPosition)

 

 

Arguments

boxName


Description:

The prefix used when naming the plates which make up the box.

 

 

dimensions


Description:

The x, y, and z dimensions of the box in the Spacecraft's BCS.

Required Size:

3

 

 

centerPosition


Description:

The position of the center of the box in the Spacecraft's BCS.

Required Size:

3

 

 

 

Return Value

Type:

Array of number (size = 6)

 

 

Returns the indices of the added plates within the PlateModel.Plates array

 

Syntax

myArray1 = myPlateModel1.AddBoxOfPlates(myString1, myArray2, myArray3);

 

 

See also

PlateModel Object

PlateModel.AddBoxOfPlates