Vector.IntersectionTimes(ProximityZone, Variable) 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 isInfiniteVector option specifies whether the vector magnitude is infinite or not. The start times, end times, 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 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,
	Variable isInfiniteVector)

Arguments

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

isInfiniteVector

Description:

Determines whether the intersection calculations use the vector's magnitude or assume an infinite vector.

Valid Values:

Value	Label
0	false
1	true

Return Value

Type:

string

Returns a sequential listing of events related to the intersection of two objects.

The FF_Preferences.IntervalEventReportingBehavior property controls whether the start and end of propagation are reported as events. 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. If the intersection extends past the end of the propagation span, FreeFlyer labels the end of propagation as the end of the intersection.

Syntax

myString1 = myVector1.IntersectionTimes(myProximityZone1, myVariable1);