Class CurveKey
Represents a point in a multi-point curve.
Inheritance
Namespace: VRageMath
Assembly: VRage.Math.dll
Syntax
public class CurveKey : Object, IEquatable<CurveKey>, IComparable<CurveKey>Constructors
CurveKey()
Declaration
public CurveKey()CurveKey(Single, Single)
Initializes a new instance of CurveKey.
Declaration
public CurveKey(float position, float value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | position | Position in the curve. |
| System.Single | value | Value of the control point. |
CurveKey(Single, Single, Single, Single)
Initializes a new instance of CurveKey.
Declaration
public CurveKey(float position, float value, float tangentIn, float tangentOut)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | position | Position in the curve. |
| System.Single | value | Value of the control point. |
| System.Single | tangentIn | Tangent approaching point from the previous point in the curve. |
| System.Single | tangentOut | Tangent leaving point toward next point in the curve. |
CurveKey(Single, Single, Single, Single, CurveContinuity)
Initializes a new instance of CurveKey.
Declaration
public CurveKey(float position, float value, float tangentIn, float tangentOut, CurveContinuity continuity)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | position | Position in the curve. |
| System.Single | value | Value of the control point. |
| System.Single | tangentIn | Tangent approaching point from the previous point in the curve. |
| System.Single | tangentOut | Tangent leaving point toward next point in the curve. |
| CurveContinuity | continuity | Enum indicating whether the curve is discrete or continuous. |
Properties
Continuity
Describes whether the segment between this point and the next point in the curve is discrete or continuous.
Declaration
public CurveContinuity Continuity { get; set; }Property Value
| Type | Description |
|---|---|
| CurveContinuity |
Position
Position of the CurveKey in the curve.
Declaration
public float Position { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
TangentIn
Describes the tangent when approaching this point from the previous point in the curve.
Declaration
public float TangentIn { get; set; }Property Value
| Type | Description |
|---|---|
| System.Single |
TangentOut
Describes the tangent when leaving this point to the next point in the curve.
Declaration
public float TangentOut { get; set; }Property Value
| Type | Description |
|---|---|
| System.Single |
Value
Describes the value of this point.
Declaration
public float Value { get; set; }Property Value
| Type | Description |
|---|---|
| System.Single |
Methods
Clone()
Creates a copy of the CurveKey.
Declaration
public CurveKey Clone()Returns
| Type | Description |
|---|---|
| CurveKey |
CompareTo(CurveKey)
Compares this instance to another CurveKey and returns an indication of their relative values.
Declaration
public int CompareTo(CurveKey other)Parameters
| Type | Name | Description |
|---|---|---|
| CurveKey | other | CurveKey to compare to. |
Returns
| Type | Description |
|---|---|
| System.Int32 |
Equals(Object)
Returns a value that indicates whether the current instance is equal to a specified object.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | Object with which to make the comparison. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Equals(CurveKey)
Determines whether the specified Object is equal to the CurveKey.
Declaration
public bool Equals(CurveKey other)Parameters
| Type | Name | Description |
|---|---|---|
| CurveKey | other | The Object to compare with the current CurveKey. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
GetHashCode()
Returns the hash code for this instance.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 |
Operators
Equality(CurveKey, CurveKey)
Determines whether two CurveKey instances are equal.
Declaration
public static bool operator ==(CurveKey a, CurveKey b)Parameters
| Type | Name | Description |
|---|---|---|
| CurveKey | a | CurveKey on the left of the equal sign. |
| CurveKey | b | CurveKey on the right of the equal sign. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Inequality(CurveKey, CurveKey)
Determines whether two CurveKey instances are not equal.
Declaration
public static bool operator !=(CurveKey a, CurveKey b)Parameters
| Type | Name | Description |
|---|---|---|
| CurveKey | a | CurveKey on the left of the equal sign. |
| CurveKey | b | CurveKey on the right of the equal sign. |
Returns
| Type | Description |
|---|---|
| System.Boolean |