diff --git a/com.unity.cinemachine/Documentation~/CinemachineSplineDollyLookAtTargets.md b/com.unity.cinemachine/Documentation~/CinemachineSplineDollyLookAtTargets.md index de91b0eae..6f1990222 100644 --- a/com.unity.cinemachine/Documentation~/CinemachineSplineDollyLookAtTargets.md +++ b/com.unity.cinemachine/Documentation~/CinemachineSplineDollyLookAtTargets.md @@ -1,5 +1,7 @@ # Cinemachine Spline Dolly LookAt Targets +![Spline Dolly LookAt Targets Inspector](images/SplineDollyLookAtTargetsInspector.png) + This CinemachineCamera __Rotation Control__ behaviour lets you assign LookAt targets to points on a spline, so that as the camera arrives at the position on the spline, it looks at the specified place. It's useful for creating curated dolly shots with specified aim targets along the way. This behaviour eliminates the need to provide rotation animations for the camera that are synchronized with the spline position animation. LookAt points are anchored to specific spline positions, and because they specify a LookAt target point, the appropriate rotation angles get computed dynamically. As a result, the rotation animation is more robust and less likely to break if the spline is modified. @@ -18,7 +20,7 @@ When the LookAtDataOnSpline is selected in the inspector, a Scene View tool is p | Property | Field | Description | | --- | --- | --- | | __Index Unit__ | | Defines how to interpret the _Index_ field for each data point. _Knot_ is the recommended value because it remains robust if the spline points change. | -| __Targets__ | | The list of LookAt target on the spline. As the camera approaches these positions on the spline, the camera will look at the corresponding targets. | +| __Data Points__ | | The list of LookAt target on the spline. As the camera approaches these positions on the spline, the camera will look at the corresponding targets. | | | _Index_ | The position on the Spline where the camera should look at the supplied point. The value is interpreted according to the _Index Unit_ setting. | | | _Look At_ | The target object to look at. It may be None, in which case the Offset will specify a point in world space. | | | _Offset_ | The offset (in local coords) from the LookAt target's origin. If LookAt target is None, this will specify a world-space point. | diff --git a/com.unity.cinemachine/Documentation~/CinemachineSplineRoll.md b/com.unity.cinemachine/Documentation~/CinemachineSplineRoll.md index cd3543c03..7b599f12d 100644 --- a/com.unity.cinemachine/Documentation~/CinemachineSplineRoll.md +++ b/com.unity.cinemachine/Documentation~/CinemachineSplineRoll.md @@ -1,6 +1,16 @@ # Cinemachine Spline Roll +![Spline Roll Inspector](images/CinemachineSplineRollInspector.png) + This behavior adds Roll to a Spline. Roll is the rotation about the spline's tangent. Add data points to set the roll at specific points along the spline. Roll will be interpolated between those points. This behavior will also draw a railroad-track Gizmo in the Scene view, to help visualize the roll. -If you add this behavior to the Spline itself, then any [Cm Camera](CinemachineCamera.md) or [Cinemachine Spline Cart](CinemachineSplineCart.md) that follows the path will respect the roll. If instead you add this behavior to the CinemachineCamera itself, then the roll will be visible only to that CinemachineCamera. +If you add this behavior to the Spline itself, then any [Cinemachine Camera](CinemachineCamera.md) or [Cinemachine Spline Cart](CinemachineSplineCart.md) that follows the path will respect the roll. If instead you add this behavior to the CinemachineCamera itself, then the roll will be visible only to that CinemachineCamera. + +### Properties +| Property | Field | Description | +| --- | --- | --- | +| __Index Unit__ | | Defines how to interpret the _Index_ field for each data point. _Knot_ is the recommended value because it remains robust if the spline points change. | +| __Data Points__ | | The list of Roll points on the spline. At these postions on the spline, it will take on the specified roll value. | +| | _Index_ | The position on the Spline where it should assume the specified roll. The value is interpreted according to the _Index Unit_ setting. | +| | _Roll_ | The roll value for the spline. This is specified in degrees, and the axis of rotation is the spline tangent at that point. | diff --git a/com.unity.cinemachine/Documentation~/images/CinemachineSplineRollInspector.png b/com.unity.cinemachine/Documentation~/images/CinemachineSplineRollInspector.png new file mode 100644 index 000000000..4288510f8 Binary files /dev/null and b/com.unity.cinemachine/Documentation~/images/CinemachineSplineRollInspector.png differ diff --git a/com.unity.cinemachine/Documentation~/images/SplineDollyLookAtTargetsInspector.png b/com.unity.cinemachine/Documentation~/images/SplineDollyLookAtTargetsInspector.png new file mode 100644 index 000000000..dd6dbad8f Binary files /dev/null and b/com.unity.cinemachine/Documentation~/images/SplineDollyLookAtTargetsInspector.png differ