Class Animation

The Animation Class is capable of storing and handling different types of Channels.

Inheritance

System.Object

Animation

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Fusee.Xirkit

Assembly: Fusee.Xirkit.dll

Syntax

public class Animation

Constructors

Animation(Int32)

Initializes a new instance of the Animation class.

Declaration

public Animation(int animMode = 0)

Parameters

Type	Name	Description
System.Int32	animMode	The parameter sets the AnimationMode

Properties

AnimationMode

Gets and sets the animation mode.

Declaration

public int AnimationMode { get; set; }

Property Value

Type	Description
System.Int32	The animation mode.

ChannelBaseList

Gets the channel base list.

Declaration

public List<ChannelBase> ChannelBaseList { get; }

Property Value

Type	Description
System.Collections.Generic.List<ChannelBase>

Methods

AddAnimation<TValue>(Channel<TValue>, Object, String)

Adds the Channel to this Animation and adds it to the _animHandler.

Declaration

public void AddAnimation<TValue>(Channel<TValue> channel, object channelObject, string field)

Parameters

Type	Name	Description
Channel<TValue>	channel	The channel that will be added.
System.Object	channelObject	The Object that will be wired with the channel.
System.String	field	The full name of the Field or Property of the Object that will be handled by this Animation.

Type Parameters

Name	Description
TValue	The Type of the channel.

AddChannel(ChannelBase)

Adds a channel to this Animation. This channel will be handled by this Animation.

Declaration

public void AddChannel(ChannelBase baseChannel)

Parameters

Type	Name	Description
ChannelBase	baseChannel	The base channel that will be handled by this Animation.

Animate(Single)

Animates all channels. The time is set by the user.

Declaration

public void Animate(float time)

Parameters

Type	Name	Description
System.Single	time	The time that the user set's.

DeleteAnimation(Int32)

Deletes the animation and removes the Nodes from the AnimHandler

Declaration

public void DeleteAnimation(int pos)

Parameters

Type	Name	Description
System.Int32	pos	The position.

RemoveChannel(Int32)

Removes a channel from the _channelList.

Declaration

public void RemoveChannel(int channelPosition)

Parameters

Type	Name	Description
System.Int32	channelPosition	The position of the channel that has to be removed.

SetTick(Single)

Sets the time in all channels.

Declaration

public void SetTick(float time)

Parameters

Type	Name	Description
System.Single	time	The time that will be set.