Class CinemachinePathBase
This is a deprecated component. Use SplineContainer instead.
Inherited Members
Namespace: Unity.Cinemachine
Assembly: solution.dll
Syntax
[Obsolete("CinemachinePathBase has been deprecated. Use SplineContainer instead")]
public abstract class CinemachinePathBase : MonoBehaviour
Fields
Name | Description |
---|---|
m_Appearance | The settings that control how the path will appear in the editor scene view. |
m_Resolution | Path samples per waypoint |
Properties
Name | Description |
---|---|
Distance |
When calculating the distance cache, sample the path this many times between points |
Looped | True if the path ends are joined to form a continuous loop |
Max |
The maximum value for the path position |
Min |
The minimum value for the path position |
Path |
Get the length of the path in distance units. If the distance cache is not valid, then calling this will trigger a potentially costly regeneration of the path distance cache |
Methods
Name | Description |
---|---|
Distance |
See whether the distance cache is valid. If it's not valid, then any call to GetPathLength() or ToNativePathUnits() will trigger a potentially costly regeneration of the path distance cache |
Evaluate |
Get the orientation the curve at a point along the path. |
Evaluate |
Get a local-space position of a point along the path |
Evaluate |
Get the tangent of the curve at a point along the path. |
Evaluate |
Get the orientation the curve at a point along the path. |
Evaluate |
Get the orientation the curve at a point along the path. |
Evaluate |
Get a worldspace position of a point along the path |
Evaluate |
Get a worldspace position of a point along the path |
Evaluate |
Get the tangent of the curve at a point along the path. |
Evaluate |
Get the tangent of the curve at a point along the path. |
Find |
Find the closest point on the path to a given worldspace target point. |
From |
Convert a path position from native path units to the desired units. If the distance cache is not valid, then calling this will trigger a potentially costly regeneration of the path distance cache |
Invalidate |
Call this if the path changes in such a way as to affect distances or other cached path elements |
Max |
Get the maximum value, for the given unit type |
Min |
Get the minimum value, for the given unit type |
On |
Adds enable toggle to the inspector |
Standardize |
Standardize a distance along the path based on the path length. If the distance cache is not valid, then calling this will trigger a potentially costly regeneration of the path distance cache |
Standardize |
Get a standardized path position, taking spins into account if looped |
Standardize |
Standardize the unit, so that it lies between MinUmit and MaxUnit |
To |
Get the path position to native path units. If the distance cache is not valid, then calling this will trigger a potentially costly regeneration of the path distance cache |