CinemachinePath Class

Cinemachine

previous page next page

Cinemachine

CinemachinePath Class

Defines a world-space path, consisting of an array of waypoints, each of which has position, tangent, and roll settings. Bezier interpolation is performed between the waypoints, to get a smooth and continuous path.

Inheritance Hierarchy

SystemObject  Object
    Component
      Behaviour
        MonoBehaviour
          CinemachineCinemachinePathBase
            CinemachineCinemachinePath

Namespace: Cinemachine
Assembly: Cinemachine (in Cinemachine.dll) Version: 2.0.0.0 (2.0.0.0)

Syntax

JavaScript

Copy

[DocumentationSortingAttribute(18f, DocumentationSortingAttributeLevel.UserRef)]
[AddComponentMenu("Cinemachine/CinemachinePath")]
[SaveDuringPlayAttribute]
public class CinemachinePath : CinemachinePathBase

Cinemachine.CinemachinePath = function();

Type.createClass(
	'Cinemachine.CinemachinePath',
	Cinemachine.CinemachinePathBase);

The CinemachinePath type exposes the following members.

Constructors

	Name	Description
	CinemachinePath

Top

Properties

	Name	Description
	DistanceCacheSampleStepsPerSegment	When calculating the distance cache, sample the path this many times between points (Overrides CinemachinePathBaseDistanceCacheSampleStepsPerSegment.)
	Looped	True if the path ends are joined to form a continuous loop (Overrides CinemachinePathBaseLooped.)
	MaxPos	The maximum value for the path position (Overrides CinemachinePathBaseMaxPos.)
	MinPos	The minimum value for the path position (Overrides CinemachinePathBaseMinPos.)
	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 (Inherited from CinemachinePathBase.)

Top

Methods

	Name	Description
	DistanceCacheIsValid	See whether the distance cache is valid. If it's not valid, then any call to GetPathLength() or GetPathPositionFromDistance() will trigger a potentially costly regeneration of the path distance cache (Inherited from CinemachinePathBase.)
	EvaluateOrientation	Get the orientation the curve at a point along the path. (Overrides CinemachinePathBaseEvaluateOrientation(Single).)
	EvaluateOrientationAtUnit	Get the orientation the curve at a point along the path. (Inherited from CinemachinePathBase.)
	EvaluatePosition	Get a worldspace position of a point along the path (Overrides CinemachinePathBaseEvaluatePosition(Single).)
	EvaluatePositionAtUnit	Get a worldspace position of a point along the path (Inherited from CinemachinePathBase.)
	EvaluateTangent	Get the tangent of the curve at a point along the path. (Overrides CinemachinePathBaseEvaluateTangent(Single).)
	EvaluateTangentAtUnit	Get the tangent of the curve at a point along the path. (Inherited from CinemachinePathBase.)
	FindClosestPoint	Find the closest point on the path to a given worldspace target point. (Inherited from CinemachinePathBase.)
	GetPathDistanceFromPosition	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 (Inherited from CinemachinePathBase.)
	GetPathPositionFromDistance	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 (Inherited from CinemachinePathBase.)
	InvalidateDistanceCache	Call this if the path changes in such a way as to affect distances or other cached path elements (Inherited from CinemachinePathBase.)
	MaxUnit	Get the maximum value, for the given unity type (Inherited from CinemachinePathBase.)
	MinUnit	Get the minimum value, for the given unity type (Inherited from CinemachinePathBase.)
	NormalizePathDistance	Normalize 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 (Inherited from CinemachinePathBase.)
	NormalizePos	Get a normalized path position, taking spins into account if looped (Inherited from CinemachinePathBase.)
	NormalizeUnit	Normalize the unit, so that it lies between MinUmit and MaxUnit (Inherited from CinemachinePathBase.)

Top

Fields

	Name	Description
	m_Appearance	The settings that control how the path will appear in the editor scene view. (Inherited from CinemachinePathBase.)
	m_Looped	If checked, then the path ends are joined to form a continuous loop
	m_Resolution	Path samples per waypoint (Inherited from CinemachinePathBase.)
	m_Waypoints	The waypoints that define the path. They will be interpolated using a bezier curve

Top

Reference

Cinemachine Namespace

Visit the Cinemachine Forum

https://unity3d.com/legal/terms-of-service

previous page start next page