Path3F Class

Path3F Class

Represents a 3-dimensional path that is defined by piecewise interpolation of key points (single-precision).

Inheritance Hierarchy

SystemObject
  System.Collections.ObjectModelCollectionPathKey3F
    DigitalRune.Mathematics.InterpolationPiecewiseCurveSingle, Vector3F, PathKey3F
      DigitalRune.Mathematics.InterpolationPiecewiseCurveFVector3F, PathKey3F
        DigitalRune.Mathematics.InterpolationPath3F

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 Path3F : PiecewiseCurveF<Vector3F, PathKey3F>, 
	IXmlSerializable

<SerializableAttribute>
Public Class Path3F
	Inherits PiecewiseCurveF(Of Vector3F, PathKey3F)
	Implements IXmlSerializable

[SerializableAttribute]
public ref class Path3F : public PiecewiseCurveF<Vector3F, PathKey3F^>, 
	IXmlSerializable

[<SerializableAttribute>]
type Path3F =  
    class
        inherit PiecewiseCurveF<Vector3F, PathKey3F>
        interface IXmlSerializable
    end

The Path3F type exposes the following members.

Constructors

	Name	Description
	Path3F	Initializes a new instance of the Path3F class

Top

Methods

	Name	Description
	Add	Adds an object to the end of the CollectionT. (Inherited from CollectionPathKey3F.)
	Clear	Removes all elements from the CollectionT. (Inherited from CollectionPathKey3F.)
	ClearItems	Removes all elements from the CollectionT. (Inherited from CollectionPathKey3F.)
	Contains	Determines whether an element is in the CollectionT. (Inherited from CollectionPathKey3F.)
	CopyTo	Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionPathKey3F.)
	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.)
	Flatten	Computes the points of a sequence of line segments which approximate the curve. (Overrides PiecewiseCurveTParam, TPoint, TCurveKeyFlatten(ICollectionTPoint, Int32, TParam).)
	GetEnumerator	Returns an enumerator that iterates through the curve keys of the PiecewiseCurveFTPoint, TCurveKey. (Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetKeyIndex	Gets the index of the curve key before or at the given parameter value. (Inherited from PiecewiseCurveFTPoint, TCurveKey.)
	GetLength	Computes the approximated length of the curve for the parameter interval [start, end]. (Overrides PiecewiseCurveTParam, TPoint, TCurveKeyGetLength(TParam, TParam, Int32, TParam).)
	GetParameterFromLength	Gets the curve parameter for the given curve length (for length-parameterized splines).
	GetPoint	Computes a point on the curve. (Overrides PiecewiseCurveTParam, TPoint, TCurveKeyGetPoint(TParam).)
	GetTangent	Computes the tangent for a point on the curve. (Overrides PiecewiseCurveTParam, TPoint, TCurveKeyGetTangent(TParam).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Searches for the specified object and returns the zero-based index of the first occurrence within the entire CollectionT. (Inherited from CollectionPathKey3F.)
	Insert	Inserts an element into the CollectionT at the specified index. (Inherited from CollectionPathKey3F.)
	InsertItem	Inserts an element into the CollectionT at the specified index. (Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
	IsInMirroredOscillation	Determines whether the given parameter corresponds to a mirrored oscillation loop. (Inherited from PiecewiseCurveFTPoint, TCurveKey.)
	LoopParameter	Handles pre- and post-looping by changing the given parameter so that it lies on the curve. (Inherited from PiecewiseCurveFTPoint, TCurveKey.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ParameterizeByLength	Parameterizes the path by its length.
	ReadXml	Generates an object from its XML representation. (Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
	Remove	Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionPathKey3F.)
	RemoveAt	Removes the element at the specified index of the CollectionT. (Inherited from CollectionPathKey3F.)
	RemoveItem	Removes the element at the specified index of the CollectionT. (Inherited from CollectionPathKey3F.)
	SetItem	Replaces the element at the specified index. (Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
	Sort	Sorts the curve keys in the collection by their parameter (see Parameter). (Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WriteXml	Converts an object into its XML representation. (Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)

Top

Properties

	Name	Description
	Count	Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionPathKey3F.)
	Item	Gets or sets the element at the specified index. (Inherited from CollectionPathKey3F.)
	Items	Gets a IListT wrapper around the CollectionT. (Inherited from CollectionPathKey3F.)
	PostLoop	Gets or sets a value that defines how the curve looks after the last curve key. (Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
	PreLoop	Gets or sets a value that defines how the curve looks before the first path key. (Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)
	SmoothEnds	Gets or sets a value indicating whether the curve ends are smoothed. (Inherited from PiecewiseCurveTParam, TPoint, TCurveKey.)

Top

Explicit Interface Implementations

	Name	Description
	IXmlSerializableGetSchema	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.
	IXmlSerializableReadXml	Generates an object from its XML representation.
	IXmlSerializableWriteXml	Converts an object into its XML representation.
	IListAdd	Adds an item to the IList. (Inherited from CollectionPathKey3F.)
	IListContains	Determines whether the IList contains a specific value. (Inherited from CollectionPathKey3F.)
	ICollectionCopyTo	Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from CollectionPathKey3F.)
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection. (Inherited from CollectionPathKey3F.)
	IListIndexOf	Determines the index of a specific item in the IList. (Inherited from CollectionPathKey3F.)
	IListInsert	Inserts an item into the IList at the specified index. (Inherited from CollectionPathKey3F.)
	IListIsFixedSize	Gets a value indicating whether the IList has a fixed size. (Inherited from CollectionPathKey3F.)
	ICollectionTIsReadOnly	Gets a value indicating whether the ICollectionT is read-only. (Inherited from CollectionPathKey3F.)
	IListIsReadOnly	Gets a value indicating whether the IList is read-only. (Inherited from CollectionPathKey3F.)
	ICollectionIsSynchronized	Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from CollectionPathKey3F.)
	IListItem	Gets or sets the element at the specified index. (Inherited from CollectionPathKey3F.)
	IListRemove	Removes the first occurrence of a specific object from the IList. (Inherited from CollectionPathKey3F.)
	ICollectionSyncRoot	Gets an object that can be used to synchronize access to the ICollection. (Inherited from CollectionPathKey3F.)

Top

Remarks

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

Path Keys: The path keys (PathKey3F) 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