ProximityZone.Intersects(ProximityZone, Array, Array, Array) Method

Top

Description

This method provides a sequential listing of events related to the intersection of the calling ProximityZone and proximityZoneToIntersect, where one object moves to at least partially intersect another object. Sphere/Sphere, Ellipsoid/Ellipsoid, Ellipsoid/Sphere, and Box/Box intersections are supported, but Ellipsoid/Box and Sphere/Box intersections are not. 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.

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.

Note: This is an interval method. See the Interval Methods page for more information.

Note: This method has a state. See the Methods and Properties with State page for more information.

Method Signature

ProximityZone.Intersects(	ProximityZone proximityZoneToIntersect,
	Array EventTime,
	Array EventType,
	Array EventRange)

Arguments

proximityZoneToIntersect
Description:	The ProximityZone used to determine intersection with the calling ProximityZone.

EventTime

Description:

The time that the event occurred.

The FF_Preferences.IntervalEventReportingBehavior property controls whether the start of propagation is reported as an event. By default, if the intersection starts before the beginning of the propagation span, FreeFlyer will label the start of the propagation as the start of the intersection.

EventType
Description:	The type of the event that occurred. Event Type == 1 is beginning of intersection. Event Type == 2 is end of intersection.

EventRange
Description:	The range between the two Objects' centers at the epoch when the event occurred.

Return Value

Type:

number

Returns the number of elements filled into the EventTime, EventType, EventTime, and EventRange arrays.

Syntax

myVariable1 = myProximityZone1.Intersects(myProximityZone2, myArray1, myArray2, myArray3);