ParticleSystem.IAnimatableObject.GetAnimatedProperties Method

ParticleSystemIAnimatableObjectGetAnimatedProperties Method

Gets either the properties which are currently animated, or all properties which can be animated. (See remarks.)

Namespace: DigitalRune.Particles
Assembly: DigitalRune.Particles (in DigitalRune.Particles.dll) Version: 1.4.0.0 (1.4.1.14427)

Syntax

C++

Copy

IEnumerable<IAnimatableProperty> IAnimatableObject.GetAnimatedProperties()

Private Function GetAnimatedProperties As IEnumerable(Of IAnimatableProperty)
	Implements IAnimatableObject.GetAnimatedProperties

private:
virtual IEnumerable<IAnimatableProperty^>^ GetAnimatedProperties() sealed = IAnimatableObject::GetAnimatedProperties

private abstract GetAnimatedProperties : unit -> IEnumerable<IAnimatableProperty> 
private override GetAnimatedProperties : unit -> IEnumerable<IAnimatableProperty>

Return Value

Type: IEnumerableIAnimatableProperty
The properties which are currently animated, or the all properties which can be animated. (See remarks.)

Implements

IAnimatableObjectGetAnimatedProperties

Remarks

This method is required by the animation system to stop all animations running on this object. The type that implements this method can either:

Variant #1: Return only the properties which are currently being animated.
Variant #2: Return all properties which can be animated - independent of whether they are currently being animated or not.

The first implementation (Variant #1) is preferred by the animation system, but in some cases it is not easily possible to determine which properties are currently being animated. In this case the IAnimatableObject may simple return all properties (Variant #2).

Reference

ParticleSystem Class

DigitalRune.Particles Namespace