pqVCRController is the QObject that encapsulates the VCR control functionality. More...

#include <pqVCRController.h>

Inherits QObject.

Public Slots
virtual void	setAnimationScene (pqAnimationScene *)
	Set the animation scene. More...

virtual void	onTimeRangesChanged ()
	Called when timeranges change. More...


virtual void	onFirstFrame ()
	Connect these signals to appropriate VCR buttons. More...

virtual void	onPreviousFrame ()
	Connect these signals to appropriate VCR buttons. More...

virtual void	onNextFrame ()
	Connect these signals to appropriate VCR buttons. More...

virtual void	onLastFrame ()
	Connect these signals to appropriate VCR buttons. More...

virtual void	onPlay ()
	Connect these signals to appropriate VCR buttons. More...

virtual void	onReverse ()
	Connect these signals to appropriate VCR buttons. More...

virtual void	onPause ()
	Connect these signals to appropriate VCR buttons. More...

virtual void	onLoop (bool checked)
	Connect these signals to appropriate VCR buttons. More...

Signals
void	timestepChanged ()
	Emitted for each tick. More...

void	playing (bool, bool)
	Emitted as `playing(true, reversed)` when playback begins and `playing(false, reversed)` when playback ends. More...

void	enabled (bool)
	Fired when the enable state of the VCR control changes and each time setAnimationScene() is called. More...

void	loop (bool)
	Emitted to update the check state of the loop. More...

void	timeRanges (double, double)
	Emitted when the time ranges is updated. More...

Public Member Functions
	pqVCRController (QObject *parent=nullptr)

	~pqVCRController () override

pqAnimationScene *	getAnimationScene () const
	Get the animation scene currently used in the VCR control. More...

Protected Slots
void	onTick ()

void	onLoopPropertyChanged ()

void	onBeginPlay (vtkObject caller, unsigned long, void , void *reversed)

void	onEndPlay (vtkObject caller, unsigned long, void , void *reversed)

Detailed Description

pqVCRController is the QObject that encapsulates the VCR control functionality.

It provides a slot to set the scene that this object is using for animation. Typically, one would connect this slot to a pqAnimationManager like object which keeps track of the active animation scene.

Definition at line 22 of file pqVCRController.h.

Constructor & Destructor Documentation

◆ pqVCRController()

pqVCRController::pqVCRController ( QObject * parent = nullptr )

◆ ~pqVCRController()

pqVCRController::~pqVCRController ( )

override

Member Function Documentation

◆ getAnimationScene()

pqAnimationScene* pqVCRController::getAnimationScene ( ) const

Get the animation scene currently used in the VCR control.

◆ timestepChanged

void pqVCRController::timestepChanged ( )

signal

Emitted for each tick.

◆ playing

void pqVCRController::playing	(	bool	,
		bool
	)

signal

Emitted as playing(true, reversed) when playback begins and playing(false, reversed) when playback ends.

The value of reversed argument is true if playback was requested in backward direction

◆ enabled

void pqVCRController::enabled ( bool )

signal

Fired when the enable state of the VCR control changes and each time setAnimationScene() is called.

If called when a valid scene, enabled(true) is fired, else enabled(false).

◆ loop

void pqVCRController::loop ( bool )

signal

Emitted to update the check state of the loop.

◆ timeRanges

void pqVCRController::timeRanges	(	double	,
		double
	)

signal

Emitted when the time ranges is updated.

◆ setAnimationScene

virtual void pqVCRController::setAnimationScene ( pqAnimationScene * )

virtualslot

Set the animation scene.

If null, the VCR control is disabled (emits enabled(false)).

◆ onTimeRangesChanged

virtual void pqVCRController::onTimeRangesChanged ( )

virtualslot

Called when timeranges change.

(emits timeRanges(first, last))