Space Engineers
Public Member Functions | Properties | List of all members
VRageMath.Curve Class Reference

Stores an arbitrary collection of 2D CurveKey points, and provides methods for evaluating features of the curve they define. More...

Public Member Functions

Curve Clone ()
 Creates a copy of the Curve. More...
 
void ComputeTangent (int keyIndex, CurveTangent tangentType)
 Computes both the TangentIn and the TangentOut for a CurveKey specified by its index. More...
 
void ComputeTangent (int keyIndex, CurveTangent tangentInType, CurveTangent tangentOutType)
 Computes a specified type of TangentIn and a specified type of TangentOut for a given CurveKey. More...
 
void ComputeTangents (CurveTangent tangentType)
 Computes all tangents for all CurveKeys in this Curve, using a specified tangent type for both TangentIn and TangentOut. More...
 
void ComputeTangents (CurveTangent tangentInType, CurveTangent tangentOutType)
 Computes all tangents for all CurveKeys in this Curve, using different tangent types for TangentOut and TangentIn. More...
 
float Evaluate (float position)
 Finds the value at a position on the Curve. More...
 

Properties

CurveLoopType PreLoop [get, set]
 Specifies how to handle weighting values that are less than the first control point in the curve. More...
 
CurveLoopType PostLoop [get, set]
 Specifies how to handle weighting values that are greater than the last control point in the curve. More...
 
CurveKeyCollection Keys [get]
 The points that make up the curve. More...
 
bool IsConstant [get]
 Gets a value indicating whether the curve is constant. More...
 

Detailed Description

Stores an arbitrary collection of 2D CurveKey points, and provides methods for evaluating features of the curve they define.

Definition at line 9 of file Curve.cs.

Member Function Documentation

Curve VRageMath.Curve.Clone ( )
inline

Creates a copy of the Curve.

Definition at line 70 of file Curve.cs.

void VRageMath.Curve.ComputeTangent ( int  keyIndex,
CurveTangent  tangentType 
)
inline

Computes both the TangentIn and the TangentOut for a CurveKey specified by its index.

Parameters
keyIndexThe index of the CurveKey for which to compute tangents (in the Keys collection of the Curve).
tangentTypeThe type of tangents to compute (one of the types specified in the CurveTangent enumeration).

Definition at line 84 of file Curve.cs.

void VRageMath.Curve.ComputeTangent ( int  keyIndex,
CurveTangent  tangentInType,
CurveTangent  tangentOutType 
)
inline

Computes a specified type of TangentIn and a specified type of TangentOut for a given CurveKey.

Parameters
keyIndexThe index of the CurveKey for which to compute tangents (in the Keys collection of the Curve).
tangentInTypeThe type of TangentIn to compute (one of the types specified in the CurveTangent enumeration).
tangentOutTypeThe type of TangentOut to compute (one of the types specified in the CurveTangent enumeration).

Definition at line 93 of file Curve.cs.

void VRageMath.Curve.ComputeTangents ( CurveTangent  tangentType)
inline

Computes all tangents for all CurveKeys in this Curve, using a specified tangent type for both TangentIn and TangentOut.

Parameters
tangentTypeThe type of TangentOut and TangentIn to compute (one of the types specified in the CurveTangent enumeration).

Definition at line 143 of file Curve.cs.

void VRageMath.Curve.ComputeTangents ( CurveTangent  tangentInType,
CurveTangent  tangentOutType 
)
inline

Computes all tangents for all CurveKeys in this Curve, using different tangent types for TangentOut and TangentIn.

Parameters
tangentInTypeThe type of TangentIn to compute (one of the types specified in the CurveTangent enumeration).
tangentOutTypeThe type of TangentOut to compute (one of the types specified in the CurveTangent enumeration).

Definition at line 152 of file Curve.cs.

float VRageMath.Curve.Evaluate ( float  position)
inline

Finds the value at a position on the Curve.

Parameters
positionThe position on the Curve.

Definition at line 162 of file Curve.cs.

Property Documentation

bool VRageMath.Curve.IsConstant
get

Gets a value indicating whether the curve is constant.

Definition at line 60 of file Curve.cs.

CurveKeyCollection VRageMath.Curve.Keys
get

The points that make up the curve.

Definition at line 49 of file Curve.cs.

CurveLoopType VRageMath.Curve.PostLoop
getset

Specifies how to handle weighting values that are greater than the last control point in the curve.

Definition at line 34 of file Curve.cs.

CurveLoopType VRageMath.Curve.PreLoop
getset

Specifies how to handle weighting values that are less than the first control point in the curve.

Definition at line 19 of file Curve.cs.


The documentation for this class was generated from the following file: