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 : MonoBehaviourFields
| 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 |
|---|---|
| DistanceCacheSampleStepsPerSegment | 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 |
| MaxPos | The maximum value for the path position |
| MinPos | The minimum value for the path position |
| PathLength | 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 |
|---|---|
| DistanceCacheIsValid() | 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 |
| EvaluateLocalOrientation(float) | Get the orientation the curve at a point along the path. |
| EvaluateLocalPosition(float) | Get a local-space position of a point along the path |
| EvaluateLocalTangent(float) | Get the tangent of the curve at a point along the path. |
| EvaluateOrientation(float) | Get the orientation the curve at a point along the path. |
| EvaluateOrientationAtUnit(float, PositionUnits) | Get the orientation the curve at a point along the path. |
| EvaluatePosition(float) | Get a worldspace position of a point along the path |
| EvaluatePositionAtUnit(float, PositionUnits) | Get a worldspace position of a point along the path |
| EvaluateTangent(float) | Get the tangent of the curve at a point along the path. |
| EvaluateTangentAtUnit(float, PositionUnits) | Get the tangent of the curve at a point along the path. |
| FindClosestPoint(Vector3, int, int, int) | Find the closest point on the path to a given worldspace target point. |
| FromPathNativeUnits(float, PositionUnits) | 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 |
| InvalidateDistanceCache() | Call this if the path changes in such a way as to affect distances or other cached path elements |
| MaxUnit(PositionUnits) | Get the maximum value, for the given unit type |
| MinUnit(PositionUnits) | Get the minimum value, for the given unit type |
| OnEnable() | Adds enable toggle to the inspector |
| StandardizePathDistance(float) | 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 |
| StandardizePos(float) | Get a standardized path position, taking spins into account if looped |
| StandardizeUnit(float, PositionUnits) | Standardize the unit, so that it lies between MinUmit and MaxUnit |
| ToNativePathUnits(float, PositionUnits) | 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 |