Description
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.
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.
Overload List
Signatures

Return Value

Description

ProximityZone.InRange(ProximityZone rangeDefinitionProximityZone)

Variable

This method tests the intersection of two ProximityZones. Supported combinations are Ellipsoid/Ellipsoid, Ellispoid/Sphere, Sphere/Sphere, and Box/Box. Other combinations will yield run time errors.
Returns a value of 0 if the two volumes do not intersect, and returns a value of 1 if there is intersection.
Since the evaluation is instantaneous, care must be taken to adjust the propagator step size such that events of interest aren't skipped over.

ProximityZone.InRange(Spacecraft targetSpacecraft)

Variable

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.

See also
ProximityZone Object
Coverage and Contact Analysis Guide
ProximityZones Guide
