PlateModel.AddBoxOfPlates(String, Array, Array, Variable, Variable) 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. Each plate will be configured to use cr_specular and cr_diffuse.

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

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

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

Method Signature

PlateModel.AddBoxOfPlates(	String boxName,
	Array dimensions,
	Array centerPosition,
	Variable cr_specular,
	Variable cr_diffuse)

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

cr_specular
Description:	The coefficient of Specular Reflectivity for each of the plates in this box.
Valid Range:	0 ≤ cr_specular ≤ 1

cr_diffuse
Description:	The coefficient of Diffuse Reflectivity for each of the plates in this box.
Valid Range:	0 ≤ cr_diffuse ≤ 1

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, myVariable1, myVariable2);