PixelLightAPI  .
Public Member Functions
PLRenderer::AnimationFrameInfo Class Reference

Animation frame information. More...

#include <AnimationFrameInfo.h>

List of all members.

Public Member Functions

 AnimationFrameInfo ()
 Constructor.
 ~AnimationFrameInfo ()
 Destructor.
float GetSpeed () const
 Returns the speed of an animation frame.
void SetSpeed (float fSpeed=1.0f)
 Sets the animation frame speed.
AnimationFrameInfooperator= (const AnimationFrameInfo &cSource)
 Copy operator.
bool operator== (const AnimationFrameInfo &cSource) const
 Compare operator.

Detailed Description

Animation frame information.


Constructor & Destructor Documentation

Constructor.

Destructor.


Member Function Documentation

float PLRenderer::AnimationFrameInfo::GetSpeed ( ) const [inline]

Returns the speed of an animation frame.

Returns:
Animation frame speed
Note:
  • If speed is 0 the frame will be skipped
  • If speed is less 0 there's no frame interpolation
void PLRenderer::AnimationFrameInfo::SetSpeed ( float  fSpeed = 1.0f) [inline]

Sets the animation frame speed.

Parameters:
[in]fSpeedAnimation frame speed
See also:
AnimationFrameInfo & PLRenderer::AnimationFrameInfo::operator= ( const AnimationFrameInfo cSource) [inline]

Copy operator.

Parameters:
[in]cSourceSource to copy from
Returns:
Reference to this class instance
bool PLRenderer::AnimationFrameInfo::operator== ( const AnimationFrameInfo cSource) const [inline]

Compare operator.

Parameters:
[in]cSourceSource to compare with
Returns:
'true' if the two animation frame information are equal, else 'false'

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


PixelLight PixelLight 0.9.10-R1
Copyright (C) 2002-2011 by The PixelLight Team
Last modified Fri Dec 23 2011 15:51:22
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported