ProximityZone Object

Name

Description

Active

Determines whether the ProximityZone is active.

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.

DeclaredName

The name of the object as declared.

DisplayName

The name displayed for this object in output windows such as views, plots, and reports.

MaximumRangeShape

The shape of the surface defining the boundary of the ProximityZone.

MaxRangeAttitudeFrame

The coordinate frame in which the ProximityZone is described.

MaxRangeRotationSequence

The order in which the Euler axis rotations are applied. The rotations are defined by the MaxRangeAttitudeAngle1, MaxRangeAttitudeAngle2, MaxRangeAttitudeAngle3 properties.

ObjectId

The unique identifier for the object.

ObjectType

The type of the object.

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.

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.

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.

ShellType

Determines how the ProximityZone zone is rendered in a Mission View.

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.

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.

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 "MJ2000".

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 MJ2000 Earth Equator coordinates.