Click or drag to resize
DigitalRunePath2F Class
Represents a 2-dimensional path that is defined by piecewise interpolation of key points (single-precision).
Inheritance Hierarchy
SystemObject
  System.Collections.ObjectModelCollectionPathKey2F
    DigitalRune.Mathematics.InterpolationPiecewiseCurveSingle, Vector2F, PathKey2F
      DigitalRune.Mathematics.InterpolationPiecewiseCurveFVector2F, PathKey2F
        DigitalRune.Mathematics.InterpolationPath2F

Namespace: DigitalRune.Mathematics.Interpolation
Assembly: DigitalRune.Mathematics (in DigitalRune.Mathematics.dll) Version: 1.14.0.0 (1.14.0.14427)
Syntax
[SerializableAttribute]
public class Path2F : PiecewiseCurveF<Vector2F, PathKey2F>, 
	IXmlSerializable

The Path2F type exposes the following members.

Constructors
  NameDescription
Public methodPath2F
Initializes a new instance of the Path2F class
Top
Methods
  NameDescription
Public methodAdd (Inherited from CollectionPathKey2F.)
Public methodClear (Inherited from CollectionPathKey2F.)
Protected methodClearItems (Inherited from CollectionPathKey2F.)
Public methodContains (Inherited from CollectionPathKey2F.)
Public methodCopyTo (Inherited from CollectionPathKey2F.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFlatten
Computes the points of a sequence of line segments which approximate the curve.
(Overrides PiecewiseCurveTParam, TPoint, TCurveKeyFlatten(ICollectionTPoint, Int32, TParam).)
Public methodGetEnumerator (Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetKeyIndex
Gets the index of the curve key before or at the given parameter value.
(Inherited from PiecewiseCurveFTPoint, TCurveKey.)
Public methodGetLength
Computes the approximated length of the curve for the parameter interval [start, end].
(Overrides PiecewiseCurveTParam, TPoint, TCurveKeyGetLength(TParam, TParam, Int32, TParam).)
Public methodGetParameterFromLength
Gets the curve parameter for the given curve length (for length-parameterized splines).
Public methodGetPoint
Computes a point on the curve.
(Overrides PiecewiseCurveTParam, TPoint, TCurveKeyGetPoint(TParam).)
Public methodGetTangent
Computes the tangent for a point on the curve.
(Overrides PiecewiseCurveTParam, TPoint, TCurveKeyGetTangent(TParam).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf (Inherited from CollectionPathKey2F.)
Public methodInsert (Inherited from CollectionPathKey2F.)
Protected methodInsertItem (Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
Public methodIsInMirroredOscillation
Determines whether the given parameter corresponds to a mirrored oscillation loop.
(Inherited from PiecewiseCurveFTPoint, TCurveKey.)
Public methodLoopParameter
Handles pre- and post-looping by changing the given parameter so that it lies on the curve.
(Inherited from PiecewiseCurveFTPoint, TCurveKey.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodParameterizeByLength
Parameterizes the path by its length.
Protected methodReadXml
Generates an object from its XML representation.
(Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
Public methodRemove (Inherited from CollectionPathKey2F.)
Public methodRemoveAt (Inherited from CollectionPathKey2F.)
Protected methodRemoveItem (Inherited from CollectionPathKey2F.)
Protected methodSetItem
Replaces the element at the specified index.
(Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
Public methodSort
Sorts the curve keys in the collection by their parameter (see Parameter).
(Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodWriteXml
Converts an object into its XML representation.
(Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
Top
Properties
  NameDescription
Public propertyCount (Inherited from CollectionPathKey2F.)
Public propertyItem
Gets or sets the element at the specified index.
(Inherited from CollectionPathKey2F.)
Protected propertyItems (Inherited from CollectionPathKey2F.)
Public propertyPostLoop
Gets or sets a value that defines how the curve looks after the last curve key.
(Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
Public propertyPreLoop
Gets or sets a value that defines how the curve looks before the first path key.
(Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
Public propertySmoothEnds
Gets or sets a value indicating whether the curve ends are smoothed.
(Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIXmlSerializableGetSchema
This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return from this method, and instead, if specifying a custom schema is required, apply the XmlSchemaProviderAttribute to the class.
Explicit interface implementationPrivate methodIXmlSerializableReadXml
Generates an object from its XML representation.
Explicit interface implementationPrivate methodIXmlSerializableWriteXml
Converts an object into its XML representation.
Explicit interface implementationPrivate methodIListAdd
Adds an item to the IList.
(Inherited from CollectionPathKey2F.)
Explicit interface implementationPrivate methodIListContains
Determines whether the IList contains a specific value.
(Inherited from CollectionPathKey2F.)
Explicit interface implementationPrivate methodICollectionCopyTo
Copies the elements of the ICollection to an Array, starting at a particular Array index.
(Inherited from CollectionPathKey2F.)
Explicit interface implementationPrivate methodIEnumerableGetEnumerator
Returns an enumerator that iterates through a collection.
(Inherited from CollectionPathKey2F.)
Explicit interface implementationPrivate methodIListIndexOf
Determines the index of a specific item in the IList.
(Inherited from CollectionPathKey2F.)
Explicit interface implementationPrivate methodIListInsert
Inserts an item into the IList at the specified index.
(Inherited from CollectionPathKey2F.)
Explicit interface implementationPrivate propertyIListIsFixedSize
Gets a value indicating whether the IList has a fixed size.
(Inherited from CollectionPathKey2F.)
Explicit interface implementationPrivate propertyICollectionTIsReadOnly (Inherited from CollectionPathKey2F.)
Explicit interface implementationPrivate propertyIListIsReadOnly
Gets a value indicating whether the IList is read-only.
(Inherited from CollectionPathKey2F.)
Explicit interface implementationPrivate propertyICollectionIsSynchronized
Gets a value indicating whether access to the ICollection is synchronized (thread safe).
(Inherited from CollectionPathKey2F.)
Explicit interface implementationPrivate propertyIListItem
Gets or sets the element at the specified index.
(Inherited from CollectionPathKey2F.)
Explicit interface implementationPrivate methodIListRemove
Removes the first occurrence of a specific object from the IList.
(Inherited from CollectionPathKey2F.)
Explicit interface implementationPrivate propertyICollectionSyncRoot
Gets an object that can be used to synchronize access to the ICollection.
(Inherited from CollectionPathKey2F.)
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.

See Also