Animations Members
collapse_all
expand_all
collapse_allexpand_alldropdowndropdownHovercopycodecopycodeHighlight

collapse_all Collapse AllExpand All     dropdown Code: All Code: Multiple Code: C# Code: Visual Basic Code: Visual C++     dropdown Members: Show All Members: Filtered Members: Filtered Members: Filtered

[TCheckBoxFormControlObj]C#

[TCheckBoxFormControlObj]Visual Basic

[TCheckBoxFormControlObj]
Visual C++

[TCheckBoxFormControlObj]Include Protected Members

[TCheckBoxFormControlObj]
Include Inherited Members
DPSF API Documentation
Animations Members

gradient

The Animations type exposes the following members.

collapse_allConstructors

 

Name

Description

pubmethod

Animations

Initializes a new instance of the Animations class

collapse_allMethods

 

Name

Description

pubmethod

AnimationIDIsValid

Returns true if the given Animation ID is valid (i.e. An Animation with the same ID exists).

pubmethod

CopyFrom

Copies the given Animations data into this Animation

pubmethod

CreateAnimation(List<(Of <<'(Int32>)>>), Single, Int32)

Creates a new Animation and returns the Animation's unique ID.

NOTE: Returns -1 if an invalid Picture ID was specified in the PictureRotationOrder.

NOTE: Be sure to Create the Pictures before creating the Animation.

pubmethod

CreateAnimation(array<Int32>[]()[][], Single, Int32)

Creates a new Animation and returns the Animation's unique ID.

NOTE: Returns -1 if an invalid Picture ID was specified in the PictureRotationOrder.

NOTE: Be sure to Create the Pictures before creating the Animation.

pubmethod

CreatePicture

Creates a Picture that can be used in a Animation, and returns its unique ID. A Picture can be used multiple times in an Animation.

pubmethod

CreatePicturesFromTileSet

Automatically creates the specified Total Number Of Pictures. All pictures are assumed to have the same width and height, as specified in the First Picture rectangle. Also, the First Picture is assumed to be at the top-left corner of the Tileset.

Pictures are created in left-to-right, top-to-bottom order. The ID of the first Picture created is returned, with each new Picture created incrementing the ID value, so the last Picture created will have an ID of (returned ID + (Total Number Of Pictures - 1)).

pubmethod

Equals

Determines whether the specified Object is equal to the current Object.

(Inherited from Object.)

protmethod

Finalize

Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

(Inherited from Object.)

pubmethod

GetAnimationsNumberOfTimesToPlay

Returns the Number of times the given Animation ID is set to Play. Zero means the Animation will repeat forever.

NOTE: If the given Animation ID is invalid, -1 is returned.

pubmethod

GetAnimationsPictureRotationTime

Returns how much Time (in seconds) should elapse before switching frames in the Animation.

NOTE: Returns zero if the specified Animation ID is not valid.

pubmethod

GetHashCode

Serves as a hash function for a particular type.

(Inherited from Object.)

pubmethod

GetPicturesTextureCoordinates

Returns the Rectangle representing the Texture Coordinates of the specified Picture.

pubmethod

GetType

Gets the Type of the current instance.

(Inherited from Object.)

protmethod

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

pubmethod

PictureIDIsValid

Returns true if the given Picture ID is valid (i.e. A Picture with the same ID exists).

pubmethod

SetAnimationsNumberOfTimesToPlay

Sets the Number of times the given Animation ID should Play (it replays when the end of the Animation is reached). Specify a value of zero to have the Animation repeat forever.

NOTE: If the given Animation ID is invalid, no changes are made.

pubmethod

SetAnimationsPictureRotationTime

Sets how much Time should elapse before switching frames in the Animation

pubmethod

SetCurrentAnimationAndPositionInAnimation

Sets the Current Animation being used, as well as what index in the Animation's Picture Rotation Order the Animation should start at.

NOTE: If the specified Animiation to use is not valid, the Current Animation will not be changed, and if the specified Picture Rotation Order Index is not valid, the Animation will start from the beginning of the Animation.

pubmethod

TimeRequiredToPlayAnimation

Returns the amount of Time required to play the specified Animation.

NOTE: If an invalid AnimationID is specified, zero is returned.

pubmethod

ToString

Returns a String that represents the current Object.

(Inherited from Object.)

pubmethod

Update

Updates the Animation according to how much time has elapsed

collapse_allProperties

 

Name

Description

pubproperty

CurrentAnimationID

Get / Set the Current Animation being used. The Animation is started at its beginning.

NOTE: If an invalid Animiation ID is given when Setting, the Animation will not be changed.

NOTE: If an Animation has not beeng set yet when Getting, -1 is returned.

pubproperty

CurrentAnimationIsDonePlaying

Get if the Current Animation is Done Playing or not (i.e. Its Number Of Times Played is greater than or equal to its Number Of Times To Play). Returns true even if no Animation has been set to Play yet.

pubproperty

CurrentAnimationsNumberOfTimesPlayed

Get / Set the Number of times the Current Animation has Played already.

NOTE: If no Animation has been set yet, Get returns -1, and Set doesn't change anything.

pubproperty

CurrentAnimationsNumberOfTimesToPlay

Get / Set the Number of times the Current Animation should Play (it replays when the end of the Animation is reached). Specify a value of zero to have the Animation repeat forever.

NOTE: If no Animation has been set yet, no changes are made when Setting, and -1 is returned when Getting.

pubproperty

CurrentAnimationsPictureRotationOrderIndex

Get / Set the Current Index in the Current Animation's Picture Rotation Order.

NOTE: If no Animation has been set yet, Get returns -1, and Set doesn't change anything (as well as if the specified Index is invalid).

pubproperty

CurrentAnimationsPictureRotationTime

Get / Set how much Time should elapsed before switching frames in the Current Animation.

NOTE: If no Animation has been set yet, zero will be returned.

pubproperty

CurrentPicturesTextureCoordinates

Get the Rectangle representing the Texture Coordinates of the Picture in the Animation that should be displayed at this point in time

pubproperty

Paused

Get / Set if the Animation should be Paused or not. If Paused, the Animation will not be Updated.

pubproperty

TimeRequiredToPlayCurrentAnimation

Gets the amount of Time (in seconds) required to play the Current Animation.

NOTE: If no Animation has been played yet, zero is returned.

pubproperty

TimeRequiredToPlayTheRestOfTheCurrentAnimation

Gets the amount of Time (in seconds) required to play the remainder of the Current Animation.

NOTE: If no Animation has been played yet, zero is returned.

collapse_allSee Also

Animations Class

DPSF Namespace

footer

Send comments on this topic to
Dan@DansKingdom.com