#include <CurveEdInterface.h>

Public Member Functions
virtual int32	GetNumKeys () const

virtual int32	GetNumSubCurves () const

virtual FColor	GetSubCurveButtonColor (int32 SubCurveIndex, bool bIsSubCurveHidden) const

virtual float	GetKeyIn (int32 KeyIndex)

virtual float	GetKeyOut (int32 SubIndex, int32 KeyIndex)

virtual FColor	GetKeyColor (int32 SubIndex, int32 KeyIndex, const FColor &CurveColor)

virtual float	EvalSub (int32 SubIndex, float InVal)

virtual EInterpCurveMode	GetKeyInterpMode (int32 KeyIndex) const

virtual void	GetTangents (int32 SubIndex, int32 KeyIndex, float &ArriveTangent, float &LeaveTangent) const

virtual void	GetInRange (float &MinIn, float &MaxIn) const

virtual void	GetOutRange (float &MinOut, float &MaxOut) const

virtual int32	CreateNewKey (float KeyIn)

virtual void	DeleteKey (int32 KeyIndex)

virtual int32	SetKeyIn (int32 KeyIndex, float NewInVal)

virtual void	SetKeyOut (int32 SubIndex, int32 KeyIndex, float NewOutVal)

virtual void	SetKeyInterpMode (int32 KeyIndex, EInterpCurveMode NewMode)

virtual void	SetTangents (int32 SubIndex, int32 KeyIndex, float ArriveTangent, float LeaveTangent)

Detailed Description

Interface that allows the CurveEditor to edit this type of object.

Definition at line 10 of file CurveEdInterface.h.

Member Function Documentation

◆ CreateNewKey()

virtual int32 FCurveEdInterface::CreateNewKey ( float KeyIn )

inlinevirtual

Add a new key to the curve with the specified input. Its initial value is set using EvalSub at that location. Returns the index of the new key.

Definition at line 74 of file CurveEdInterface.h.

◆ DeleteKey()

virtual void FCurveEdInterface::DeleteKey ( int32 KeyIndex )

inlinevirtual

Remove the specified key from the curve. KeyIndex must be within range ie >=0 and < NumKeys.

Definition at line 80 of file CurveEdInterface.h.

◆ EvalSub()

virtual float FCurveEdInterface::EvalSub	(	int32	SubIndex,
		float	InVal )

inlinevirtual

Evaluate a subcurve at an arbitary point. Outside the keyframe range, curves are assumed to continue their end values.

Definition at line 49 of file CurveEdInterface.h.

◆ GetInRange()

virtual void FCurveEdInterface::GetInRange	(	float &	MinIn,
		float &	MaxIn ) const

inlinevirtual

Get input range of keys. Outside this region curve continues constantly the start/end values.

Definition at line 65 of file CurveEdInterface.h.

◆ GetKeyColor()

virtual FColor FCurveEdInterface::GetKeyColor	(	int32	SubIndex,
		int32	KeyIndex,
		const FColor &	CurveColor )

inlinevirtual

Provides the color for the given key at the given sub-curve.

Parameters

	SubIndex	The index of the sub-curve
	KeyIndex	The index of the key in the sub-curve
[in]	CurveColor	The color of the curve

Returns: The color that is associated the given key at the given sub-curve

Definition at line 46 of file CurveEdInterface.h.

◆ GetKeyIn()

virtual float FCurveEdInterface::GetKeyIn ( int32 KeyIndex )

inlinevirtual

Get the input value for the Key with the specified index. KeyIndex must be within range ie >=0 and < NumKeys.

Definition at line 29 of file CurveEdInterface.h.

◆ GetKeyInterpMode()

virtual EInterpCurveMode FCurveEdInterface::GetKeyInterpMode ( int32 KeyIndex ) const

inlinevirtual

Get the interpolation mode of the specified keyframe. This can be CIM_Constant, CIM_Linear or CIM_Curve. KeyIndex must be within range ie >=0 and < NumKeys.

Definition at line 55 of file CurveEdInterface.h.

◆ GetKeyOut()

virtual float FCurveEdInterface::GetKeyOut	(	int32	SubIndex,
		int32	KeyIndex )

inlinevirtual

Get the output value for the key with the specified index on the specified sub-curve. SubIndex must be within range ie >=0 and < NumSubCurves. KeyIndex must be within range ie >=0 and < NumKeys.

Definition at line 36 of file CurveEdInterface.h.

◆ GetNumKeys()

virtual int32 FCurveEdInterface::GetNumKeys ( ) const

inlinevirtual

Get number of keyframes in curve.

Definition at line 14 of file CurveEdInterface.h.

◆ GetNumSubCurves()

virtual int32 FCurveEdInterface::GetNumSubCurves ( ) const

inlinevirtual

Get number of 'sub curves' in this Curve. For example, a vector curve will have 3 sub-curves, for X, Y and Z.

Definition at line 17 of file CurveEdInterface.h.

◆ GetOutRange()

virtual void FCurveEdInterface::GetOutRange	(	float &	MinOut,
		float &	MaxOut ) const

inlinevirtual

Get overall range of output values.

Definition at line 68 of file CurveEdInterface.h.

◆ GetSubCurveButtonColor()

virtual FColor FCurveEdInterface::GetSubCurveButtonColor	(	int32	SubCurveIndex,
		bool	bIsSubCurveHidden ) const

inlinevirtual

Provides the color for the sub-curve button that is present on the curve tab.

Parameters

SubCurveIndex	The index of the sub-curve. Cannot be negative nor greater or equal to the number of sub-curves.
bIsSubCurveHidden	Is the curve hidden?

Returns: The color associated to the given sub-curve index.

Definition at line 26 of file CurveEdInterface.h.

Here is the call graph for this function:

◆ GetTangents()

virtual void FCurveEdInterface::GetTangents	(	int32	SubIndex,
		int32	KeyIndex,
		float &	ArriveTangent,
		float &	LeaveTangent ) const

inlinevirtual

Get the incoming and outgoing tangent for the given subcurve and key. SubIndex must be within range ie >=0 and < NumSubCurves. KeyIndex must be within range ie >=0 and < NumKeys.

Definition at line 62 of file CurveEdInterface.h.

◆ SetKeyIn()

virtual int32 FCurveEdInterface::SetKeyIn	(	int32	KeyIndex,
		float	NewInVal )

inlinevirtual

Set the input value of the specified Key. This may change the index of the key, so the new index of the key is retured. KeyIndex must be within range ie >=0 and < NumKeys.

Definition at line 86 of file CurveEdInterface.h.

◆ SetKeyInterpMode()

virtual void FCurveEdInterface::SetKeyInterpMode	(	int32	KeyIndex,
		EInterpCurveMode	NewMode )

inlinevirtual

Set the method to use for interpolating between the give keyframe and the next one. KeyIndex must be within range ie >=0 and < NumKeys.

Definition at line 99 of file CurveEdInterface.h.

◆ SetKeyOut()

virtual void FCurveEdInterface::SetKeyOut	(	int32	SubIndex,
		int32	KeyIndex,
		float	NewOutVal )

inlinevirtual

Set the output values of the specified key. SubIndex must be within range ie >=0 and < NumSubCurves. KeyIndex must be within range ie >=0 and < NumKeys.

Definition at line 93 of file CurveEdInterface.h.

◆ SetTangents()

virtual void FCurveEdInterface::SetTangents	(	int32	SubIndex,
		int32	KeyIndex,
		float	ArriveTangent,
		float	LeaveTangent )

inlinevirtual

Set the incoming and outgoing tangent for the given subcurve and key. SubIndex must be within range ie >=0 and < NumSubCurves. KeyIndex must be within range ie >=0 and < NumKeys.

Definition at line 107 of file CurveEdInterface.h.

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

C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Math/CurveEdInterface.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateNewKey()

◆ DeleteKey()

◆ EvalSub()

◆ GetInRange()

◆ GetKeyColor()

◆ GetKeyIn()

◆ GetKeyInterpMode()

◆ GetKeyOut()

◆ GetNumKeys()

◆ GetNumSubCurves()

◆ GetOutRange()

◆ GetSubCurveButtonColor()

◆ GetTangents()

◆ SetKeyIn()

◆ SetKeyInterpMode()

◆ SetKeyOut()

◆ SetTangents()