Class SplineAutoDolly.NearestPointToTarget

ISplineAutoDolly implementation that finds the point on th spline closest to the target. Note that this is a simple stateless algorithm, and is not appropriate for all spline shapes. For example, if the spline is forming an arc and the target is inside the arc, then the closest point can be noisy or undefined. Consider for example a spline that is perfectly circular with the target at the center. Where is the closest point?

Inheritance

object

SplineAutoDolly.NearestPointToTarget

Implements

SplineAutoDolly.ISplineAutoDolly

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Cinemachine

Assembly: Unity.Cinemachine.dll

Syntax

[Serializable]
public class SplineAutoDolly.NearestPointToTarget : SplineAutoDolly.ISplineAutoDolly

Fields

PositionOffset

Offset, in current position units, from the closest point on the spline to the follow target.

Declaration

[Tooltip("Offset, in current position units, from the closest point on the spline to the follow target")]
public float PositionOffset

Field Value

Type	Description
float

SearchIteration

The nearest point is calculated by finding the nearest point on the entire length of the spline using SearchResolution 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. For more information, see SplineUtility.GetNearestPoint.

Declaration

[Tooltip("The nearest point is calculated by finding the nearest point on the entire length of the spline using SearchResolution 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 (2) is sufficient.")]
public int SearchIteration

Field Value

Type	Description
int

SearchResolution

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. In most cases, the default resolution is appropriate. Use with SearchIteration to fine-tune point accuracy. For more information, see SplineUtility.GetNearestPoint.

Declaration

[Tooltip("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.  In most cases, the default value (4) is appropriate. Use with SearchIteration to fine-tune point accuracy.")]
public int SearchResolution

Field Value

Type	Description
int

Implements

SplineAutoDolly.ISplineAutoDolly