LHAnimation Reference

Inherits from
  • Ref
LHAnimation.h

Overview

The animation object that is used to transform one or multiple nodes during a period of time.

Instance Methods

name

- (std::string)name
Discussion

The name of the animation.

Declared In
LHAnimation.h

isActive

- (bool)isActive
Discussion

Wheter or not this animation is active. The one that is currently played.

Declared In
LHAnimation.h

setActive

- (void)setActive
Parameters
active

A bool value specifying the active state of the animation.

Discussion

Set this animation as the active one.

Declared In
LHAnimation.h

totalTime

- (float)totalTime
Discussion

The time it takes for the animation to finish a loop.

Declared In
LHAnimation.h

currentFrame

- (float)currentFrame
Discussion

Current frame of the animation. As defines in LevelHelper 2 editor.

Declared In
LHAnimation.h

setCurrentFrame

- (void)setCurrentFrame
Parameters
value

The frame number where the animation should jump to.

Discussion

Move the animation to a frame.

Declared In
LHAnimation.h

setAnimating

- (void)setAnimating
Parameters
animating

A BOOL value that will set the animation as playing or paused.

Discussion

Set the animations as playing or paused.

Declared In
LHAnimation.h

animating

- (bool)animating
Discussion

Wheter or not the animation is currently playing.

Declared In
LHAnimation.h

restart

- (void)restart
Discussion

Restarts the animation. Will set the time to 0 and reset all repetitions.

Declared In
LHAnimation.h

repetitions

- (int)repetitions
Discussion

The number of times this animation will loop. A 0 repetitions meens it will loop undefinately.

Declared In
LHAnimation.h

node

- (LHNodeAnimationProtocol *)node
Discussion

The node on which this animation is assigned.

Declared In
LHAnimation.h

updateTimeWithDelta

- (void)updateTimeWithDelta
Parameters
delta

A value that will be appended to the current animation time.

Discussion

Force the animation to go forward in time by adding the delta value to the current animation time.

Declared In
LHAnimation.h
Last updated: 2015-2-12

Back to top

Copyright © VLADU BOGDAN DANIEL PFA.