CurveKey(TParam, TPoint) Class

CurveKeyTParam, TPoint Class

Defines a curve key (control point) of a piecewise curve.

Inheritance Hierarchy

SystemObject
  DigitalRune.Mathematics.InterpolationCurveKeyTParam, TPoint
    DigitalRune.Mathematics.InterpolationCurveKey2F
    DigitalRune.Mathematics.InterpolationPathKey2F
    DigitalRune.Mathematics.InterpolationPathKey3F

Namespace: DigitalRune.Mathematics.Interpolation
Assembly: DigitalRune.Mathematics (in DigitalRune.Mathematics.dll) Version: 1.14.0.0 (1.14.0.14427)

Syntax

C++

Copy

[SerializableAttribute]
public abstract class CurveKey<TParam, TPoint>

<SerializableAttribute>
Public MustInherit Class CurveKey(Of TParam, TPoint)

[SerializableAttribute]
generic<typename TParam, typename TPoint>
public ref class CurveKey abstract

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type CurveKey<'TParam, 'TPoint> =  class end

Type Parameters

TParam: The type of the curve parameter (usually Single or Double).
TPoint: The type of the curve points (such as Vector2F, Vector3F, etc.).

The CurveKeyTParam, TPoint type exposes the following members.

Constructors

	Name	Description
	CurveKeyTParam, TPoint	Initializes a new instance of the CurveKeyTParam, TPoint class

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetParameter	Gets the parameter.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetParameter	Sets the parameter.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	Interpolation	Gets or sets the type of interpolation (the spline type) used for the current curve segment between this key and the next key.
	Parameter	Gets or sets a value that defines where this curve key is positioned on the curve.
	Point	Gets or sets the curve point for this curve key.
	TangentIn	Gets or sets the incoming tangent or the control point before this curve key.
	TangentOut	Gets or sets the outgoing tangent or the control point after this curve key.

Top

Remarks

A "piecewise curve", also known as "spline", is a curve with arbitrary length that is defined by concatenating multiple curve segments.

The PiecewiseCurveTParam, TPoint, TCurveKey is a collection of curve keys (CurveKeyTParam, TPoint). Each curve key is a control point that defines a point on the curve. The points between curve keys are created by spline interpolation of the curve keys.

The curve keys are also called "key frames" if the path represents an animation curve, or "waypoints" if the path represents a 2-dimensional or 3-dimensional path.

Curve keys in a PiecewiseCurveTParam, TPoint, TCurveKey must not be .

The methods in this interface assume that the curve keys are sorted ascending by the curve parameter (see Parameter). If this is not the case, you can call Sort to sort keys.

Reference

DigitalRune.Mathematics.Interpolation Namespace