Cg Programming/Unity/Hermite Curves

This tutorial discusses Hermite curves (more exactly: cubic Hermite curves) and Catmull-Rom splines in Unity. The latter are a special kind of cubic Hermite splines. No shader programming is required since all the code is implemented in C#.

A Hermite spline that interpolates smoothly between pairs of control points.

Some splines (for example the quadratic Bézier spline discussed in Section “Bézier Curves”) don't go through all control points, i.e. they don't interpolate between them. Hermite splines, on the other hand, can be defined such that they go through all control points. This is a useful feature in many applications, e.g. in animation where it is often important to set specific values for particular key frames and let tools smoothly interpolate further values for inbetweens.

Two Hermite curves. The first curve goes from p0 to p1 with tangent m0 at p0 and tangent m1 at p1.

Hermite Curves edit

A single cubic Hermite curve   for   from 0 to 1 is defined by a start point   with tangent   and an end point   with tangent  :

 

The curve starts (for  ) at   in direction of   and then changes course to direction   and reaches   for  . As the figure illustrates, two Hermite curves can be smoothly attached to each other by choosing the same tangent vector for the corresponding end points.

Curve Script edit

To implement such a curve in Unity, we can use the Unity component LineRenderer. Apart from setting some parameters, one should set the number of sample points on the curve with the function SetVertexCount. Then the sample points have to be computed and set with the function SetPosition. This is can be implemented this way:

float t;
Vector3 position;

for(int i = 0; i < numberOfPoints; i++)
{
	t = i / (numberOfPoints - 1.0f);
	position = (2.0f * t * t * t - 3.0f * t * t + 1.0f) * p0 
		+ (t * t * t - 2.0f * t * t + t) * m0 
		+ (-2.0f * t * t * t + 3.0f * t * t) * p1 
		+ (t * t * t - t * t) * m1;
	lineRenderer.SetPosition(i, position);
}

Here we use an index i from 0 to numberOfPoints-1 to count the sample points. From this index i a parameter t from 0 to 1 is computed. The next line computes  , which is then set with the function SetPosition.

The rest of the code just sets up the LineRenderer component and defines public variables that can be used to define the control points and some rendering features of the curve.

using UnityEngine;

[ExecuteInEditMode, RequireComponent(typeof(LineRenderer))]
public class Hermite_Curve : MonoBehaviour 
{
	public GameObject start, startTangentPoint, end, endTangentPoint;

	public Color color = Color.white;
	public float width = 0.2f;
	public int numberOfPoints = 20;
	LineRenderer lineRenderer;
	
	void Start () 
	{
		lineRenderer = GetComponent<LineRenderer>();
		lineRenderer.useWorldSpace = true;
		lineRenderer.material = new Material(
			Shader.Find("Legacy Shaders/Particles/Additive"));
	}
	
	void Update () 
	{
		// check parameters and components
   		if (null == lineRenderer || null == start || null == startTangentPoint 
			|| null == end || null == endTangentPoint)
   		{
      			return; // no points specified
   		} 

		// update line renderer
		lineRenderer.startColor = color;
		lineRenderer.endColor = color;
   		lineRenderer.startWidth = width;
		lineRenderer.endWidth = width;
		if (numberOfPoints > 0)
   		{
      			lineRenderer.positionCount = numberOfPoints;
   		}

		// set points of Hermite curve
		Vector3 p0 = start.transform.position;
		Vector3 p1 = end.transform.position;
		Vector3 m0 = startTangentPoint.transform.position - start.transform.position;
		Vector3 m1 = endTangentPoint.transform.position - end.transform.position;
		float t;
		Vector3 position;

		for(int i = 0; i < numberOfPoints; i++)
		{
			t = i / (numberOfPoints - 1.0f);
      			position = (2.0f * t * t * t - 3.0f * t * t + 1.0f) * p0 
				+ (t * t * t - 2.0f * t * t + t) * m0 
				+ (-2.0f * t * t * t + 3.0f * t * t) * p1 
				+ (t * t * t - t * t) * m1;
      			lineRenderer.SetPosition(i, position);
		}
	}
}

To use this script create a C# Script in the Project Window and name it Hermite_Curve, double-click it, copy & paste the code above, save it, create a new empty game object (in the main menu: GameObject > Create Empty) and attach the script (drag the script from the Project Window over the empty game object in the Hierarchy Window).

Then create four more empty game objects (or any other game objects) with different(!) positions that will serve as control points. Select the game object with the script and drag the other game objects into the slots Start, StartTangentPoint (for the end point of a tangent starting in the start point), End, and EndTangentPoint in the Inspector. This should render a Hermite curve from the game object specified as “Start” to the game object specified as “End”.

 
Computation of tangents in Catmull-Rom splines.

Catmull-Rom Splines edit

A cubic Hermite spline consists of a continuous, smooth sequence of cubic Hermite curves. In order to guarantee smoothness, the tangent at the end point of one Hermite curve is the same as the tangent of the start point of the next Hermite curve. In some cases, users provide these tangents (one for each control point), in other cases, however, appropriate tangents have to be computed.

One specific way of computing a tangent vector   for the k-th control point   is this:

 

and   for the first point and   for the last point. The resulting cubic Hermite spline is called Catmull-Rom spline.

Spline Script edit

The following script implements this idea. For the j-th segment, it computes   as the j-th control point  ,   is set to  ,   is set to   (unless it is the tangent of the first control point, in which case it is set to  ) and   is set to   (unless it is the tangent of the last control point, then it is set to  ).

p0 = controlPoints[j].transform.position;
p1 = controlPoints[j + 1].transform.position;

if (j > 0) 
{
	m0 = 0.5f * (controlPoints[j + 1].transform.position 
		- controlPoints[j - 1].transform.position);
}
else
{
	m0 = controlPoints[j + 1].transform.position 
		- controlPoints[j].transform.position;
}
if (j < controlPoints.Count - 2)
{
	m1 = 0.5f * (controlPoints[j + 2].transform.position 
		- controlPoints[j].transform.position);
}
else
{
	m1 = controlPoints[j + 1].transform.position 
		- controlPoints[j].transform.position;
}

Each individual segment is then just computed as a cubic Hermite curve. The only adjustment is that all but the last segment should not reach  . If they did, the first sample position of the next segment would be at the same position which would be visible in the rendering. The complete script is:

using System.Collections.Generic;
using UnityEngine;

[ExecuteInEditMode, RequireComponent(typeof(LineRenderer))]
public class Hermite_Spline : MonoBehaviour 
{
	public List<GameObject> controlPoints = new List<GameObject>();
	public Color color = Color.white;
	public float width = 0.2f;
	public int numberOfPoints = 20;
	LineRenderer lineRenderer;	

	void Start () 
	{
		lineRenderer = GetComponent<LineRenderer>();
		lineRenderer.useWorldSpace = true;
		lineRenderer.material = new Material(
			Shader.Find("Legacy Shaders/Particles/Additive"));	
	}
	
	void Update () 
	{
		if (null == lineRenderer || controlPoints == null 
			|| controlPoints.Count < 2)
   		{
      			return; // not enough points specified
   		}

		// update line renderer
		lineRenderer.startColor = color;
		lineRenderer.endColor = color;
   		lineRenderer.startWidth = width;
		lineRenderer.endWidth = width;
		if (numberOfPoints < 2)
   		{
      			numberOfPoints = 2;
   		}
		lineRenderer.positionCount = numberOfPoints * (controlPoints.Count - 1);

		// loop over segments of spline
		Vector3 p0, p1, m0, m1;

		for(int j = 0; j < controlPoints.Count - 1; j++)
		{
			// check control points
			if (controlPoints[j] == null || 
				controlPoints[j + 1] == null ||
				(j > 0 && controlPoints[j - 1] == null) ||
				(j < controlPoints.Count - 2 && controlPoints[j + 2] == null))
			{
				return;  
			}
			// determine control points of segment
			p0 = controlPoints[j].transform.position;
			p1 = controlPoints[j + 1].transform.position;
			
			if (j > 0) 
			{
				m0 = 0.5f * (controlPoints[j + 1].transform.position 
				- controlPoints[j - 1].transform.position);
			}
			else
			{
				m0 = controlPoints[j + 1].transform.position 
					- controlPoints[j].transform.position;
			}
			if (j < controlPoints.Count - 2)
			{
				m1 = 0.5f * (controlPoints[j + 2].transform.position 
					- controlPoints[j].transform.position);
			}
			else
			{
				m1 = controlPoints[j + 1].transform.position 
					- controlPoints[j].transform.position;
			}

			// set points of Hermite curve
			Vector3 position;
			float t;
			float pointStep = 1.0f / numberOfPoints;

			if (j == controlPoints.Count - 2)
			{
				pointStep = 1.0f / (numberOfPoints - 1.0f);
				// last point of last segment should reach p1
			}  
			for(int i = 0; i < numberOfPoints; i++) 
			{
				t = i * pointStep;
				position = (2.0f * t * t * t - 3.0f * t * t + 1.0f) * p0 
					+ (t * t * t - 2.0f * t * t + t) * m0 
					+ (-2.0f * t * t * t + 3.0f * t * t) * p1 
					+ (t * t * t - t * t) * m1;
				lineRenderer.SetPosition(i + j * numberOfPoints, 
					position);
			}
		}
	}
}

The script should be called Hermite_Spline and works in the same way as the script for Hermite curves except that the user can specify an arbitrary number of control points and doesn't have to specify tangent points.

Summary edit

In this tutorial, we have looked at:

  • the definition of cubic Hermite curves and Catmull-Rom splines
  • implementations of cubic Hermite curves and Catmull-Rom splines with Unity's LineRenderer component.

Further reading edit

If you want to know more

  • about Hermite splines, the Wikipedia article on “cubic Hermite spline” provides a good starting point.
  • about Unity's LineRenderer, you should read Unity's documentation of the class LineRenderer.

< Cg Programming/Unity

Unless stated otherwise, all example source code on this page is granted to the public domain.