PixelpartAnimatedPropertyFloat Class Reference

float property animated with keyframes and affected by effect inputs. More...

Public Member Functions
	PixelpartAnimatedPropertyFloat (IntPtr internalPropertyPtr)
	Construct PixelpartAnimatedPropertyFloat.
float	At (float position)
	Return the (interpolated) value of the animation property at time position .
void	AddKeyframe (float position, float value)
	Add a keyframe at time position with value value .
void	RemoveKeyframe (int index)
	Remove the keyframe with the given index from the animation.
void	SetKeyframeValue (int index, float value)
	Change the value of the keyframe with the given index.
void	SetKeyframePosition (int index, float position)
	Move the time of the keyframe with the given index to position .
void	ClearKeyframes ()
	Remove all keyframes from the animation.
float	GetKeyframeValue (int index)
	Return the value of the keyframe with the given index.
int	GetKeyframeIndex (float position, float epsilon)
	Return the index of the keyframe closest to time position .
void	EnableAdaptiveCache ()
	Enable an adaptive cache, which resizes itself automatically if the number of keyframes increases or decreases a lot.
void	EnableFixedCache (int size)
	Enable a fixed cache with the given size, which only stores up to size different value.
float	Get (float position)
	Return the (interpolated) value of the animation property at time position . Deprecated, use At.
void	AddPoint (float position, float value)
	Add a keyframe at time position with value value . Deprecated, use AddKeyframe.
void	RemovePoint (int index)
	Remove the keyframe with the given index from the animation. Deprecated, use RemoveKeyframe.
void	SetPoint (int index, float value)
	Change the value of the keyframe with the given index. Deprecated, use SetKeyframeValue.
void	SetPointPosition (int index, float position)
	Move the time of the keyframe with the given index to position . Deprecated, use SetKeyframePosition.
void	Clear ()
	Remove all keyframes from the animation. Deprecated, use ClearKeyframes.
float	GetPoint (int index)
	Return the value of the keyframe with the given index. Deprecated, use GetKeyframeValue.
int	GetPointIndex (float position, float epsilon)
	Return the index of the keyframe closest to time position . Deprecated, use GetKeyframeIndex.

Properties
InterpolationType	KeyframeInterpolation [get, set]
	Interpolation applied to the animation curve.
int	KeyframeCount [get]
	Number of keyframes.
InterpolationType	Interpolation [get]
	Interpolation applied to the animation curve. Deprecated, use KeyframeInterpolation.
int	NumPoints [get]
	Number of keyframes. Deprecated, use KeyframeCount.
bool	ContainsPoints [get]
	Whether the animation property contains any keyframes. Deprecated, use KeyframeCount.

Detailed Description

float property animated with keyframes and affected by effect inputs.

Scene objects of an effect like particle emitters and force fields have properties that change over time and are affected by effect inputs. Such properties are represented by one of the PixelpartAnimatedProperty classes, depending on the type of the property.

Constructor & Destructor Documentation

PixelpartAnimatedPropertyFloat()

PixelpartAnimatedPropertyFloat

(

IntPtr

internalPropertyPtr

)

Construct PixelpartAnimatedPropertyFloat.

Parameters

internalPropertyPtr

Internal property pointer

Member Function Documentation

AddKeyframe()

void AddKeyframe	(	float	position,
		float	value )

Add a keyframe at time position with value value .

Parameters

position	Time between 0 and 1
value	Value of the property at the given time

AddPoint()

void AddPoint	(	float	position,
		float	value )

Add a keyframe at time position with value value . Deprecated, use AddKeyframe.

Parameters

position	Time between 0 and 1
value	Value of the property at the given time

At()

float At

(

float

position

)

Return the (interpolated) value of the animation property at time position .

Parameters

position

Time between 0 and 1

Returns

Value of the property

EnableFixedCache()

void EnableFixedCache

(

int

size

)

Enable a fixed cache with the given size, which only stores up to size different value.

Parameters

size	Cache size

Get()

float Get

(

float

position

)

Return the (interpolated) value of the animation property at time position . Deprecated, use At.

Parameters

position

Time between 0 and 1

Returns

Value of the property

GetKeyframeIndex()

int GetKeyframeIndex	(	float	position,
		float	epsilon )

Return the index of the keyframe closest to time position .

Parameters

position	Time between 0 and 1
epsilon	Maximum differerence in time to consider to keyframes at the same time

Returns

Keyframe index

GetKeyframeValue()

float GetKeyframeValue

(

int

index

)

Return the value of the keyframe with the given index.

Parameters

index

Keyframe index

Returns

Keyframe value

GetPoint()

float GetPoint

(

int

index

)

Return the value of the keyframe with the given index. Deprecated, use GetKeyframeValue.

Parameters

index

Keyframe index

Returns

Keyframe value

GetPointIndex()

int GetPointIndex	(	float	position,
		float	epsilon )

Return the index of the keyframe closest to time position . Deprecated, use GetKeyframeIndex.

Parameters

position	Time between 0 and 1
epsilon	Maximum differerence in time to consider to keyframes at the same time

Returns

Keyframe index

RemoveKeyframe()

void RemoveKeyframe

(

int

index

)

Remove the keyframe with the given index from the animation.

Parameters

index

Index to remove

RemovePoint()

void RemovePoint

(

int

index

)

Remove the keyframe with the given index from the animation. Deprecated, use RemoveKeyframe.

Parameters

index

Index to remove

SetKeyframePosition()

void SetKeyframePosition	(	int	index,
		float	position )

Move the time of the keyframe with the given index to position .

Parameters

index	Keyframe index
position	New time between 0 and 1

SetKeyframeValue()

void SetKeyframeValue	(	int	index,
		float	value )

Change the value of the keyframe with the given index.

Parameters

index	Keyframe index
value	New value

SetPoint()

void SetPoint	(	int	index,
		float	value )

Change the value of the keyframe with the given index. Deprecated, use SetKeyframeValue.

Parameters

index	Keyframe index
value	New value

SetPointPosition()

void SetPointPosition	(	int	index,
		float	position )

Move the time of the keyframe with the given index to position . Deprecated, use SetKeyframePosition.

Parameters

index	Keyframe index
position	New time between 0 and 1

---

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

• net.pixelpart.core/Runtime/Scripts/Property/PixelpartAnimatedPropertyFloat.cs