Time synchronized interpolation between values. More...

#include <VisualTimeline.h>

Public Member Functions
	VisualTimeline (bool aDebugMode=false)
	The constructor.
	~VisualTimeline ()
	The destructor.
	VisualTimeline (const VisualTimeline &other)
	Copy constructor.
VisualTimeline &	operator= (const VisualTimeline &other)
	Assignment operator.
void	setStartValue (double aStartValue)
	Sets the start value of the timeline.
void	setStopValue (double aStopValue)
	Sets the stop value of the timeline.
double	getMinValue (void) const
	Returns the minimum value of the timeline.
double	getMaxValue (void) const
	Returns the maximum value of the timeline.
double	getDistance (void) const
	Returns the distance of the start and stop values of the timeline.
void	setDurationInMilliseconds (uint32 numberOfMilliseconds)
	Sets the duration of the timeline.
uint32	getDurationInMilliseconds (void) const
	Returns the duration of the timeline.
void	setRepeatMode (RepeatMode aRepeatMode)
	Sets the repeat mode of the timeline.
RepeatMode	getRepeatMode (void) const
	Returns the current repeat mode of the timeline.
bool	setCurrentValue (double newCurrValue)
	Sets the current value of the timeline.
double	getCurrentValue (void) const
	Returns the current value of the timeline.
TimelineUpdateResult	update (void)
	Updates the current value of the timeline.
void	reset (void)
	Resets the timeline.
void	start (void)
	Starts the timeline.
void	stop (void)
	Stops the timeline.
void	resume (void)
	Resumes the timeline at the point in time where it was stopped the last time.
void	setInterpolationType (InterpolationType anInterpolationType)
	Sets the type of interpolation.
MovingDirection	getMovingDirection (void) const
	Returns the moving direction (running direction) of the timeline.
void	toggleMovingDirection (void)
	Toggles the current moving direction of the timeline.
void	setDebugMode (bool requestedDebugMode)
	Sets the debug mode.
Static Public Member Functions
static void	convertTimelineUpdateResultToString (const TimelineUpdateResult aResult, char *outString)
	Static helper function that converts a TimelineUpdateResult to the string.
Private Member Functions
void	copy (const VisualTimeline &other)
	Copy method for assignment operator and copy constructor.
Private Attributes
uint32	durationInMilliseconds
	The duration of the timeline in milliseconds.
double	minValue
	The minimum value.
double	maxValue
	The maximum value.
double	distance
	The calculated distance between start and stop value.
RepeatMode	repeatMode
	The repeat mode of the timeline.
VisualItemIdentifier *	durationIdentifier
	The internal identifier of the timeline.
MovingDirection	movingDirection
	The moving direction of the timeline.
VisualInterpolation *	visualInterpolation
	The interpolation model.
uint32	elapsedMilliseconds
	The elapsed milliseconds.
uint32	offsetMilliseconds
	Internally used offset in milliseconds.
double	currentValue
	The current value as it has been evaluated the last time.
bool	isStopped
	True if the timeline has been stopped, false otherwise.
bool	debugMode
	True if in debug mode, false otherwise.

Detailed Description

Time synchronized interpolation between values.

Calculates timed interpolated values.

Constructor & Destructor Documentation

VisualTimeline::VisualTimeline ( bool aDebugMode = false )

The constructor.

Parameters:

aDebugMode If true, the timeline is in debug mode.

VisualTimeline::~VisualTimeline ( )

The destructor.

VisualTimeline::VisualTimeline ( const VisualTimeline & other )

Copy constructor.

Parameters:

other Reference to another VisualTimeline.

Member Function Documentation

void VisualTimeline::convertTimelineUpdateResultToString	(	const TimelineUpdateResult	aResult,
		char *	outString
	)		`[static]`

Static helper function that converts a TimelineUpdateResult to the string.

Possibly useful for debugging or tracing purposes.

Parameters:

aResult	A timelineUpdateResult.
outString	The character string value of the TimelineUpdateResult enum value.

void VisualTimeline::copy ( const VisualTimeline & other ) [private]

Copy method for assignment operator and copy constructor.

Parameters:

other Another VisualTimeline.

double VisualTimeline::getCurrentValue ( void ) const

Returns the current value of the timeline.

Returns:: The current value of the timeline.

double VisualTimeline::getDistance ( void ) const

Returns the distance of the start and stop values of the timeline.

Returns:: The distance of the start and stop values of the timeline.

Remarks:: The distance is never a positive value.

uint32 VisualTimeline::getDurationInMilliseconds ( void ) const

Returns the duration of the timeline.

Returns:: The duration of the timeline.

double VisualTimeline::getMaxValue ( void ) const

Returns the maximum value of the timeline.

Returns:: The maximum value of the timeline.

double VisualTimeline::getMinValue ( void ) const

Returns the minimum value of the timeline.

Returns:: The minimum value of the timeline.

MovingDirection VisualTimeline::getMovingDirection ( void ) const

Returns the moving direction (running direction) of the timeline.

Returns:: The currently moving direction (running direction) of the timeline.

RepeatMode VisualTimeline::getRepeatMode ( void ) const

Returns the current repeat mode of the timeline.

Returns:: The current repeat mode of the timeline.

VisualTimeline & VisualTimeline::operator= ( const VisualTimeline & other )

Assignment operator.

Parameters:

other Reference to another VisualTimeline.

void VisualTimeline::reset ( void )

Resets the timeline.

The timeline starts anew at start.

void VisualTimeline::resume ( void )

Resumes the timeline at the point in time where it was stopped the last time.

bool VisualTimeline::setCurrentValue ( double newCurrValue )

Sets the current value of the timeline.

Parameters:

newCurrValue The value to which the timeline is supposed to jump.

Returns:: True if the new current value was outside of current min and max value range (and distance and duration were adjusted because of that).

Remarks:: The value of the timeline can be set from the outside (e.g. in case it is created new and should start with a established value).

void VisualTimeline::setDebugMode ( bool requestedDebugMode )

Sets the debug mode.

Parameters:

requestedDebugMode The debug mode. True turns debug mode on, false turns it off.

void VisualTimeline::setDurationInMilliseconds ( uint32 numberOfMilliseconds )

Sets the duration of the timeline.

Parameters:

numberOfMilliseconds The number of milliseconds the timeline spans.

void VisualTimeline::setInterpolationType ( InterpolationType anInterpolationType )

Sets the type of interpolation.

Parameters:

anInterpolationType The requested type of interpolation.

void VisualTimeline::setRepeatMode ( RepeatMode aRepeatMode )

Sets the repeat mode of the timeline.

Parameters:

aRepeatMode The requested repeat mode.

void VisualTimeline::setStartValue ( double aStartValue )

Sets the start value of the timeline.

Parameters:

aStartValue A start value.

void VisualTimeline::setStopValue ( double aStopValue )

Sets the stop value of the timeline.

Parameters:

aStopValue A stop value.

void VisualTimeline::start ( void )

Starts the timeline.

void VisualTimeline::stop ( void )

Stops the timeline.

void VisualTimeline::toggleMovingDirection ( void )

Toggles the current moving direction of the timeline.

TimelineUpdateResult VisualTimeline::update ( void )

Updates the current value of the timeline.

Returns:: The result of the update operation expressed as enum value.

Remarks:: Called on update of the animation.

Member Data Documentation

double VizKit::VisualTimeline::currentValue [private]

The current value as it has been evaluated the last time.

bool VizKit::VisualTimeline::debugMode [private]

True if in debug mode, false otherwise.

double VizKit::VisualTimeline::distance [private]

The calculated distance between start and stop value.

VisualItemIdentifier* VizKit::VisualTimeline::durationIdentifier [private]

The internal identifier of the timeline.

uint32 VizKit::VisualTimeline::durationInMilliseconds [private]

The duration of the timeline in milliseconds.

uint32 VizKit::VisualTimeline::elapsedMilliseconds [private]

The elapsed milliseconds.

bool VizKit::VisualTimeline::isStopped [private]

True if the timeline has been stopped, false otherwise.

double VizKit::VisualTimeline::maxValue [private]

The maximum value.

double VizKit::VisualTimeline::minValue [private]

The minimum value.

MovingDirection VizKit::VisualTimeline::movingDirection [private]

The moving direction of the timeline.

uint32 VizKit::VisualTimeline::offsetMilliseconds [private]

Internally used offset in milliseconds.

RepeatMode VizKit::VisualTimeline::repeatMode [private]

The repeat mode of the timeline.

VisualInterpolation* VizKit::VisualTimeline::visualInterpolation [private]

The interpolation model.

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

vizkit/source/Tools/Timing/VisualTimeline.h
vizkit/source/Tools/Timing/VisualTimeline.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation