PathKey2F Class

PathKey2F Class

Defines a waypoint of a 2-dimensional path (singe-precision).

Inheritance Hierarchy

SystemObject
DigitalRune.Mathematics.InterpolationCurveKeySingle, Vector2F
DigitalRune.Mathematics.InterpolationPathKey2F

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 class PathKey2F : CurveKey<float, Vector2F>

<SerializableAttribute>
Public Class PathKey2F
	Inherits CurveKey(Of Single, Vector2F)

[SerializableAttribute]
public ref class PathKey2F : public CurveKey<float, Vector2F>

[<SerializableAttribute>]
type PathKey2F =  
    class
        inherit CurveKey<float32, Vector2F>
    end

The PathKey2F type exposes the following members.

Constructors

	Name	Description
	PathKey2F	Initializes a new instance of the PathKey2F 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. (Overrides CurveKeyTParam, TPointGetParameter.)
	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. (Overrides CurveKeyTParam, TPointSetParameter(TParam).)
	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. (Inherited from CurveKeyTParam, TPoint.)
	Parameter	Gets or sets a value that defines where this curve key is positioned on the curve. (Inherited from CurveKeyTParam, TPoint.)
	Point	Gets or sets the curve point for this curve key. (Inherited from CurveKeyTParam, TPoint.)
	TangentIn	Gets or sets the incoming tangent or the control point before this curve key. (Inherited from CurveKeyTParam, TPoint.)
	TangentOut	Gets or sets the outgoing tangent or the control point after this curve key. (Inherited from CurveKeyTParam, TPoint.)

Top

Remarks

A Path2F is a "piecewise curve". That means, the path is defined by key points (PathKey2F) that are interpolated using spline interpolation. See PiecewiseCurveFTPoint, TCurveKey for more information on piecewise curves.

Path Keys: The path keys (PathKey2F) define the control points of the path. Each path key defines a point on the curve Point. These points are interpolated using spline interpolation. Each path key defines the type of spline interpolation that is used from this path key to the next (see Interpolation). The path keys also contain additional information that might me required for interpolation such as: TangentIn, TangentOut.

Reference

DigitalRune.Mathematics.Interpolation Namespace