Vector.IntersectionTimes(ProximityZone, TimeSpanArray, Array) Method

Top 

Description

This method provides a sequential listing of events related to the intersection of the calling Vector and proximityZoneToIntersect, where one object moves to at least partially intersect another object. The start times and end times of the intersection are returned. FreeFlyer uses a definitive analytical solution to evaluate this method.

 

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.

 

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

Vector.IntersectionTimes(

ProximityZone proximityZoneToIntersect,


TimeSpanArray EventTime,


Array EventType)

 

 

Arguments

proximityZoneToIntersect


Description:

The ProximityZone used to determine intersection with the calling Vector.

 

 

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.

 

 

 

Return Value

Type:

number

 

 

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

 

Syntax

myVariable1 = myVector1.IntersectionTimes(myProximityZone1, myTimeSpanArray1, myArray1);

 

 

Example 1

 

 

See also

Vector Object

Vector.IntersectionTimes

Coverage and Contact Analysis Guide

Vectors and Coordinate Systems Guide

Matrix, Array, and Variable Math Guide