PixelpartAnimatedPropertyFloat3 Class Reference

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

Public Member Functions
	PixelpartAnimatedPropertyFloat3 (IntPtr internalPropertyPtr)
	Construct PixelpartAnimatedPropertyFloat3.
Vector3	At (float position)
	Return the (interpolated) value of the animation property at time position .
void	AddKeyframe (float position, Vector3 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, Vector3 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.
Vector3	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 .

Properties
PixelpartInterpolationType	KeyframeInterpolation [get, set]
	Interpolation applied to the animation curve.
int	KeyframeCount [get]
	Number of keyframes.

Detailed Description

Vector3 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

PixelpartAnimatedPropertyFloat3()

PixelpartAnimatedPropertyFloat3

(

IntPtr

internalPropertyPtr

)

Construct PixelpartAnimatedPropertyFloat3.

Parameters

internalPropertyPtr

Internal property pointer

Member Function Documentation

AddKeyframe()

void AddKeyframe	(	float	position,
		Vector3	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

At()

Vector3 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

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()

Vector3 GetKeyframeValue

(

int

index

)

Return the value of the keyframe with the given index.

Parameters

index

Keyframe index

Returns

Keyframe value

RemoveKeyframe()

void RemoveKeyframe

(

int

index

)

Remove the keyframe with the given index from the animation.

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,
		Vector3	value )

Change the value of the keyframe with the given index.

Parameters

index	Keyframe index
value	New value

---

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

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