Skip to content

Class QAccelPlot::DataTransition::Run

ClassList > QAccelPlot > DataTransition > Run

One animation of a transition on one host element. More...

  • #include <DataTransition.hpp>

Public Functions

Type Name
Run () = default
Constructs an idle run.
Run (const Run &) = delete
bool active () const
Returns true while the transition advances this run.
void cancel ()
Ends the run and discards its data.
bool finish (std::vector< double > & outData, int & outPointCount)
Ends the run and moves its target data into outData and__outPointCount .
Run & operator= (const Run &) = delete
bool pending () const
Returns true while the run holds target data thatfinish() has not taken.
const std::vector< double > & targetData () const
Returns the target data. Valid while pending() istrue .
int targetPointCount () const
Returns the number of points in targetData() .
~Run ()
Destroys the run, ending it on its transition.

Detailed Description

Holds the data the host animates from and to. A run is active while the transition advances it, and pending until the host takes the target data with finish(). A run ended by DataTransition::cancel() or by destroying the transition stays pending, so the host can still show the target data. Destroying a run ends it.

Public Functions Documentation

function Run

Constructs an idle run.

QAccelPlot::DataTransition::Run::Run () = default


function Run

QAccelPlot::DataTransition::Run::Run (
    const Run &
) = delete

function active

Returns true while the transition advances this run.

bool QAccelPlot::DataTransition::Run::active () const


function cancel

Ends the run and discards its data.

void QAccelPlot::DataTransition::Run::cancel () 


function finish

Ends the run and moves its target data into outData and__outPointCount .

bool QAccelPlot::DataTransition::Run::finish (
    std::vector< double > & outData,
    int & outPointCount
) 

Returns:

false, leaving the outputs unchanged, when the run is not pending.


function operator=

Run & QAccelPlot::DataTransition::Run::operator= (
    const Run &
) = delete

function pending

Returns true while the run holds target data thatfinish() has not taken.

bool QAccelPlot::DataTransition::Run::pending () const


function targetData

Returns the target data. Valid while pending() istrue .

const std::vector< double > & QAccelPlot::DataTransition::Run::targetData () const


function targetPointCount

Returns the number of points in targetData() .

int QAccelPlot::DataTransition::Run::targetPointCount () const


function ~Run

Destroys the run, ending it on its transition.

QAccelPlot::DataTransition::Run::~Run () 



The documentation for this class was generated from the following file QAccelPlot/src/QAccelPlot/transitions/DataTransition.hpp