Represents a point in a multi-point curve. More...

Inheritance diagram for VRageMath.CurveKey:

Public Member Functions
	CurveKey (float position, float value)
	Initializes a new instance of CurveKey. More...

	CurveKey (float position, float value, float tangentIn, float tangentOut)
	Initializes a new instance of CurveKey. More...

	CurveKey (float position, float value, float tangentIn, float tangentOut, CurveContinuity continuity)
	Initializes a new instance of CurveKey. More...

CurveKey	Clone ()
	Creates a copy of the CurveKey. More...

bool	Equals (CurveKey other)
	Determines whether the specified Object is equal to the CurveKey. More...

override bool	Equals (object obj)
	Returns a value that indicates whether the current instance is equal to a specified object. More...

override int	GetHashCode ()
	Returns the hash code for this instance. More...

int	CompareTo (CurveKey other)
	Compares this instance to another CurveKey and returns an indication of their relative values. More...

Static Public Member Functions
static bool	operator== (CurveKey a, CurveKey b)
	Determines whether two CurveKey instances are equal. More...

static bool	operator!= (CurveKey a, CurveKey b)
	Determines whether two CurveKey instances are not equal. More...

Properties
float	Position `[get]`
	Position of the CurveKey in the curve. More...

float	Value `[get, set]`
	Describes the value of this point. More...

float	TangentIn `[get, set]`
	Describes the tangent when approaching this point from the previous point in the curve. More...

float	TangentOut `[get, set]`
	Describes the tangent when leaving this point to the next point in the curve. More...

CurveContinuity	Continuity `[get, set]`
	Describes whether the segment between this point and the next point in the curve is discrete or continuous. More...

Detailed Description

Represents a point in a multi-point curve.

Definition at line 11 of file CurveKey.cs.

Constructor & Destructor Documentation

VRageMath.CurveKey.CurveKey	(	float	position,
		float	value
	)

inline

Initializes a new instance of CurveKey.

Parameters

position	Position in the curve.
value	Value of the control point.

Definition at line 94 of file CurveKey.cs.

VRageMath.CurveKey.CurveKey	(	float	position,
		float	value,
		float	tangentIn,
		float	tangentOut
	)

inline

Initializes a new instance of CurveKey.

Parameters

position	Position in the curve.
value	Value of the control point.
tangentIn	Tangent approaching point from the previous point in the curve.
tangentOut	Tangent leaving point toward next point in the curve.

Definition at line 104 of file CurveKey.cs.

VRageMath.CurveKey.CurveKey	(	float	position,
		float	value,
		float	tangentIn,
		float	tangentOut,
		CurveContinuity	continuity
	)

inline

Initializes a new instance of CurveKey.

Parameters

position	Position in the curve.
value	Value of the control point.
tangentIn	Tangent approaching point from the previous point in the curve.
tangentOut	Tangent leaving point toward next point in the curve.
continuity	Enum indicating whether the curve is discrete or continuous.

Definition at line 116 of file CurveKey.cs.

Member Function Documentation

CurveKey VRageMath.CurveKey.Clone ( )

inline

Creates a copy of the CurveKey.

Definition at line 155 of file CurveKey.cs.

int VRageMath.CurveKey.CompareTo ( CurveKey other )

inline

Compares this instance to another CurveKey and returns an indication of their relative values.

Parameters

other CurveKey to compare to.

Definition at line 193 of file CurveKey.cs.

bool VRageMath.CurveKey.Equals ( CurveKey other )

inline

Determines whether the specified Object is equal to the CurveKey.

Parameters

other The Object to compare with the current CurveKey.

Definition at line 164 of file CurveKey.cs.

override bool VRageMath.CurveKey.Equals ( object obj )

inline

Returns a value that indicates whether the current instance is equal to a specified object.

Parameters

obj	Object with which to make the comparison.

Definition at line 176 of file CurveKey.cs.

override int VRageMath.CurveKey.GetHashCode ( )

inline

Returns the hash code for this instance.

Definition at line 184 of file CurveKey.cs.

static bool VRageMath.CurveKey.operator!=	(	CurveKey	a,
		CurveKey	b
	)

inlinestatic

Determines whether two CurveKey instances are not equal.

Parameters

a	CurveKey on the left of the equal sign.
b	CurveKey on the right of the equal sign.

Definition at line 145 of file CurveKey.cs.

static bool VRageMath.CurveKey.operator==	(	CurveKey	a,
		CurveKey	b
	)

inlinestatic

Determines whether two CurveKey instances are equal.

Parameters

a	CurveKey on the left of the equal sign.
b	CurveKey on the right of the equal sign.

Definition at line 129 of file CurveKey.cs.

Property Documentation

CurveContinuity VRageMath.CurveKey.Continuity

getset

Describes whether the segment between this point and the next point in the curve is discrete or continuous.

Definition at line 79 of file CurveKey.cs.

float VRageMath.CurveKey.Position

get

Position of the CurveKey in the curve.

Definition at line 23 of file CurveKey.cs.

float VRageMath.CurveKey.TangentIn

getset

Describes the tangent when approaching this point from the previous point in the curve.

Definition at line 49 of file CurveKey.cs.

float VRageMath.CurveKey.TangentOut

getset

Describes the tangent when leaving this point to the next point in the curve.

Definition at line 64 of file CurveKey.cs.

float VRageMath.CurveKey.Value

getset

Describes the value of this point.

Definition at line 34 of file CurveKey.cs.

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

Sources/VRage.Math/CurveKey.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation