CinemachinePathBase.GetPathDistanceFromPosition Method

Cinemachine

previous page next page

CinemachinePathBaseGetPathDistanceFromPosition Method

Get the path position (in path units) corresponding to this distance along the path. If the distance cache is not valid, then calling this will trigger a potentially costly regeneration of the path distance cache

Namespace:  Cinemachine
Assembly:  Cinemachine (in Cinemachine.dll) Version: 2.0.0.0 (2.0.0.0)
Syntax
Copy
public float GetPathDistanceFromPosition(
	float pos
)
function GetPathDistanceFromPosition(pos);

Parameters

pos
Type: SystemSingle

[Missing <param name="pos"/> documentation for "M:Cinemachine.CinemachinePathBase.GetPathDistanceFromPosition(System.Single)"]

Return Value

Type: Single
The length of the path in distance units, when sampled at this rate
See Also
previous page start next page