ProximityZone Object

Description

A ProximityZone is a volume attached to a Spacecraft for the purpose of determining or visualizing the proximity of other Spacecraft or points.

Inheritance Hierarchy: Object->ProximityZone

Available In Editions:

Engineer

Mission

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.

Name	Description	Attributes
Active	Determines whether the ProximityZone is active.	Type: Variable Access: Read/Write
Color	The color of the rendered proximity zone when visualized in a Mission View. The color can be overridden for an individual view using the ViewWindow.SetObjectColor() method.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
MaximumRangeShape	The shape of the surface defining the boundary of the ProximityZone.	Type: Variable Access: Read/Write
MaxRangeAttitudeFrame	The coordinate frame in which the ProximityZone is described.	Type: Variable Access: Read/Write
MaxRangeRotationSequence	The order in which the Euler axis rotations are applied. The rotations are defined by the MaxRangeAttitudeAngle1, MaxRangeAttitudeAngle2, MaxRangeAttitudeAngle3 properties.	Type: Array Access: Read/Write
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
Opacity	The opacity of the ProximityZone when visualized in a Mission View. The opacity can be overridden for an individual view using ViewWindow.SetObjectOpacity() method.	Type: Variable Access: Read/Write
Orientation	The set of rotation angles in the Euler Angles Set. The rotation is referenced from the attitude frame specified by the MaxRangeAttitudeFrame property. The order in which the rotations are applied is specified by the MaxRangeRotationSequence property. These rotations define the alignment of the ProximityZone.	Type: Array Access: Read/Write Units: deg
Position	The vector representing the center of the ProximityZone relative to the Spacecraft to which it is attached. The attitude of these components are given by MaxRangeAttitudeFrame. The offset is applied before the rotation specified by MaxRangeAttitudeAngle.	Type: Array Access: Read/Write Units: km
ShellType	Determines how the ProximityZone zone is rendered in a Mission View.	Type: Variable Access: Read/Write
Size	The vector representing the maximum range of the ProximityZone from its center. Only the x-component is used when a spherical zone shape is selected.	Type: Array Access: Read/Write Units: km
TickScale	The distance between tick marks on the axes attached to the ProximityZone. These axes are only shown if the ViewWindow.SetShowAxis method has been used to set the visibility of the axes to true (1) for the ProximityZone of interest. The axes can also be turned on or off through the Output Properties tab.	Type: Variable Access: Read/Write Units: km

Name	Description
ClearSavedStates	Clears previous saved states for this object.
EvaluateIntersection	Determines whether the ProximityZone volume intersects with the volume of the passed ProximityZone. Sphere/Sphere, Ellipsoid/Ellipsoid, Ellispoid/Sphere, and Box/Box intersections are supported, but Ellipsoid/Box and Sphere/Box intersections are not.
FixedVectorToObject	Returns an Array containing the components of the vector originating at the location of the prefix object and terminating at the location of the argument object, in the body fixed coordinate frame of the prefix object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
InRange	Returns a value of 0 when the specified object is outside the specified ProximityZone(s) on the calling Spacecraft, and returns a value of 1 if the object is within the boundary of one or more ProximityZones. FreeFlyer uses a definitive analytical solution to evaluate this event. Since the evaluation is instantaneous, care must be taken to adjust the propagator step size such that events of interest aren't skipped over.
Intersects	This method provides a sequential listing of events related to the intersection of two objects, where one object moves to at least partially intersect another object. The objects can be a Spacecraft and a ProximityZone or a ProximityZone and a ProximityZone. The start times, end times, ranges at start and end, and duration of the intersection are returned. FreeFlyer uses a definitive analytical solution to evaluate this method.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
ResetMethodStates	Resets any method states associated with the calling object.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
SetOrientation	Sets the orientation of the reference object using the specified CoordinateSystem object. Note, the AttitudeRefFrame property of the Vehicle must be set to "ICRF".
VectorToObject	Returns an Array containing the components of the vector originating at the location of the prefix object and terminating at the location of the argument object, in the ICRF.

Name

Description

Attributes

MaximumRangeX

The maximum range of the ProximityZone from center along the X-axis.

This property has been Deprecated. Please use Size instead.

Type: Variable

Access: Read/Write

Units: km

MaximumRangeY

The maximum range of the ProximityZone from center along the Y-axis. This property is not used when a spherical zone shape is selected.

This property has been Deprecated. Please use Size instead.

Type: Variable

Access: Read/Write

Units: km

MaximumRangeZ

The maximum range of the ProximityZone from center along the Z-axis. This property is not used when a spherical zone shape is selected.

This property has been Deprecated. Please use Size instead.

Type: Variable

Access: Read/Write

Units: km

MaxRangeAttitudeAngle1

The first rotation Angle in the Euler Angles Set. The rotation is referenced from the attitude frame specified by the MaxRangeAttitudeFrame property. The order in which the rotations are applied is specified by the MaxRangeRotationSequence property. These rotations define the alignment of the ProximityZone.

This property has been Deprecated. Please use Orientation instead.

Type: Variable

Access: Read/Write

Units: deg

MaxRangeAttitudeAngle2

The second rotation Angle in the Euler Angles Set. The rotation is referenced from the attitude frame specified by the MaxRangeAttitudeFrame property. The order in which the rotations are applied is specified by the MaxRangeRotationSequence property. These rotations define the alignment of the ProximityZone.

This property has been Deprecated. Please use Orientation instead.

Type: Variable

Access: Read/Write

Units: deg

MaxRangeAttitudeAngle3

The third rotation Angle in the Euler Angles Set. The rotation is referenced from the attitude frame specified by the MaxRangeAttitudeFrame property. The order in which the rotations are applied is specified by the MaxRangeRotationSequence property. These rotations define the alignment of the ProximityZone.

This property has been Deprecated. Please use Orientation instead.

Type: Variable

Access: Read/Write

Units: deg

The X-component of the center of the ProximityZone relative to the Spacecraft to which it is attached. The attitude of these components are given by MaxRangeAttitudeFrame. The offset is applied before the rotation specified by MaxRangeAttitudeAngle.

This property has been Deprecated. Please use Position instead.

Type: Variable

Access: Read/Write

Units: km

The Y-component of the center of the ProximityZone relative to the Spacecraft to which it is attached. The attitude of these components are given by MaxRangeAttitudeFrame. The offset is applied before the rotation specified by MaxRangeAttitudeAngle.

This property has been Deprecated. Please use Position instead.

Type: Variable

Access: Read/Write

Units: km

The Z-component of the center of the ProximityZone relative to the Spacecraft to which it is attached. The attitude of these components are given by MaxRangeAttitudeFrame. The offset is applied before the rotation specified by MaxRangeAttitudeAngle.

This property has been Deprecated. Please use Position instead.

Type: Variable

Access: Read/Write

Units: km