Method GetNearestPoint

GetNearestPoint<T>(T, Ray, out float3, out float, int, int)

Calculate the point on a spline nearest to a ray.

Declaration

public static float GetNearestPoint<T>(T spline, Ray ray, out float3 nearest, out float t, int resolution = 4, int iterations = 2) where T : ISpline

Parameters

Type	Name	Description
T	spline	The input spline to search for nearest point.
Ray	ray	The input ray to search against.
float3	nearest	The point on a spline nearest to the input ray. The accuracy of this value is affected by the resolution.
float	t	The normalized time value to the nearest point.
int	resolution	Affects how many segments to split a spline into when calculating the nearest point. Higher values mean smaller and more segments, which increases accuracy at the cost of processing time. The minimum resolution is defined by PickResolutionMin, and the maximum is defined by PickResolutionMax. In most cases, the default resolution is appropriate. Use with iterations to fine tune point accuracy.
int	iterations	The nearest point is calculated by finding the nearest point on the entire length of the spline using resolution to divide into equally spaced line segments. Successive iterations will then subdivide further the nearest segment, producing more accurate results. In most cases, the default value is sufficient, but if extreme accuracy is required this value can be increased to a maximum of PickResolutionMax.

Returns

Type	Description
float	The distance from ray to nearest point.

Type Parameters

Name	Description
T	A type implementing ISpline.

GetNearestPoint<T>(T, float3, out float3, out float, int, int)

Calculate the point on a spline nearest to a point.

Declaration

public static float GetNearestPoint<T>(T spline, float3 point, out float3 nearest, out float t, int resolution = 4, int iterations = 2) where T : ISpline

Parameters

Type	Name	Description
T	spline	The input spline to search for nearest point.
float3	point	The input point to compare.
float3	nearest	The point on a spline nearest to the input point. The accuracy of this value is affected by the resolution.
float	t	The normalized interpolation ratio corresponding to the nearest point.
int	resolution	Affects how many segments to split a spline into when calculating the nearest point. Higher values mean smaller and more segments, which increases accuracy at the cost of processing time. The minimum resolution is defined by PickResolutionMin, and the maximum is defined by PickResolutionMax. In most cases, the default resolution is appropriate. Use with iterations to fine tune point accuracy.
int	iterations	The nearest point is calculated by finding the nearest point on the entire length of the spline using resolution to divide into equally spaced line segments. Successive iterations will then subdivide further the nearest segment, producing more accurate results. In most cases, the default value is sufficient, but if extreme accuracy is required this value can be increased to a maximum of PickResolutionMax.

Returns

Type	Description
float	The distance from input point to nearest point on spline.

Type Parameters

Name	Description
T	A type implementing ISpline.