Jet  v1.3.3
Public Member Functions | Public Attributes | List of all members
jet::Frame Struct Referencefinal

Representation of an animation frame. More...

#include <jet/animation.h>

Public Member Functions

 Frame ()
 Constructs Frame instance with 1/60 seconds time interval. More...
 
 Frame (int newIndex, double newTimeIntervalInSeconds)
 Constructs Frame instance with given time interval. More...
 
double timeInSeconds () const
 Returns the elapsed time in seconds. More...
 
void advance ()
 Advances single frame. More...
 
void advance (int delta)
 
Frameoperator++ ()
 Advances single frame (prefix). More...
 
Frame operator++ (int)
 Advances single frame (postfix). More...
 

Public Attributes

int index = 0
 Frame index. More...
 
double timeIntervalInSeconds = 1.0 / 60.0
 Time interval in seconds between two adjacent frames. More...
 

Detailed Description

Representation of an animation frame.

This struct holds current animation frame index and frame interval in seconds.

Constructor & Destructor Documentation

◆ Frame() [1/2]

jet::Frame::Frame ( )

Constructs Frame instance with 1/60 seconds time interval.

◆ Frame() [2/2]

jet::Frame::Frame ( int  newIndex,
double  newTimeIntervalInSeconds 
)

Constructs Frame instance with given time interval.

Member Function Documentation

◆ advance() [1/2]

void jet::Frame::advance ( )

Advances single frame.

◆ advance() [2/2]

void jet::Frame::advance ( int  delta)

Advances multiple frames.

Parameters
deltaNumber of frames to advance.

◆ operator++() [1/2]

Frame& jet::Frame::operator++ ( )

Advances single frame (prefix).

◆ operator++() [2/2]

Frame jet::Frame::operator++ ( int  )

Advances single frame (postfix).

◆ timeInSeconds()

double jet::Frame::timeInSeconds ( ) const

Returns the elapsed time in seconds.

Member Data Documentation

◆ index

int jet::Frame::index = 0

Frame index.

◆ timeIntervalInSeconds

double jet::Frame::timeIntervalInSeconds = 1.0 / 60.0

Time interval in seconds between two adjacent frames.


The documentation for this struct was generated from the following file: