UT_Playback Class Reference

#include <UT_Playback.h>

Public Types
enum	UT_PlaybackMode {   REVERSE, STOPPED, FORWARD, SCRUB,   RESET, FLIPBOOKING }
enum	RealtimeBehaviour { RealtimeBehaviour::MAINTAIN_PLAYBACK_SPEED = 0, RealtimeBehaviour::PLAY_EVERY_FRAME }

Public Member Functions
	UT_Playback ()
void	setPlaybackMode (UT_PlaybackMode mode)
UT_PlaybackMode	getPlaybackMode () const
void	setContinuousCook (bool continuous)
bool	isContinuousCook () const
int	getStopCount () const
void	setRealtimeMode (bool mode)
bool	getRealtimeMode () const
void	setPlaybackRange (fpreal start, fpreal end)
void	getPlaybackRange (fpreal &start, fpreal &end) const
bool	isPlaybackReset ()
bool	isPlaying () const
bool	isScrubbing () const
void	setCurrentFrame (fpreal frame)
fpreal	getCurrentFrame ()
void	resetAbsoluteFrame ()
unsigned long	getAbsoluteFrame ()
void	stopPlayback ()
void	setStopCallback (void(*cb)(void *), void *data)
void	setInterceptMode (int mode)
int	getInterceptMode () const
void	setLastFrameTime (fpreal time_sec)
fpreal	getLastFrameTime () const
void	setSamplesPerSec (fpreal samples_sec)
fpreal	getSamplesPerSec () const
void	addPlayCallback (UT_PlayCallback cb, void *cbdata)
void	removePlayCallback (UT_PlayCallback cb, void *cbdata)
void	addPlayAdvanceCB (UT_PlayAdvanceCB, void *cbdata)
void	removePlayAdvanceCB (UT_PlayAdvanceCB, void *cbdata)
bool	canAdvancePlay ()
int	addFlipbookCallbacks (UT_Function< void()> started_cb=nullptr, UT_Function< void()> finished_cb=nullptr)
void	removeFlipbookCallbacks (int id)
	Remove flipbook callbacks by the respective id. More...
void	registerContinuousCookNode (int nodeid)
void	unregisterContinuousCookNode (int nodeid)
void	getContinuousCookNodes (UT_IntArray &nodeids) const
void	setRealtimeBehaviour (const RealtimeBehaviour behaviour)
RealtimeBehaviour	getRealtimeBehaviour () const

Static Public Member Functions
static UT_Playback *	getPlayback ()

Detailed Description

Definition at line 40 of file UT_Playback.h.

Member Enumeration Documentation

enum UT_Playback::RealtimeBehaviour

strong

Enumerator
MAINTAIN_PLAYBACK_SPEED
PLAY_EVERY_FRAME

Definition at line 56 of file UT_Playback.h.

enum UT_Playback::UT_PlaybackMode

Enumerator
REVERSE
STOPPED
FORWARD
SCRUB
RESET
FLIPBOOKING

Definition at line 46 of file UT_Playback.h.

Constructor & Destructor Documentation

UT_Playback::UT_Playback

(

)

Member Function Documentation

int UT_Playback::addFlipbookCallbacks	(	UT_Function< void()>	started_cb = nullptr,
		UT_Function< void()>	finished_cb = nullptr
	)

Register callbacks for when flipbooks are started and/or finished, returning the callback id.

void UT_Playback::addPlayAdvanceCB	(	UT_PlayAdvanceCB	,
		void *	cbdata
	)

void UT_Playback::addPlayCallback	(	UT_PlayCallback	cb,
		void *	cbdata
	)

bool UT_Playback::canAdvancePlay

(

)

unsigned long UT_Playback::getAbsoluteFrame ( )

inline

Definition at line 95 of file UT_Playback.h.

void UT_Playback::getContinuousCookNodes

(

UT_IntArray &

nodeids

)

const

fpreal UT_Playback::getCurrentFrame ( )

inline

Definition at line 92 of file UT_Playback.h.

int UT_Playback::getInterceptMode ( ) const

inline

Definition at line 102 of file UT_Playback.h.

fpreal UT_Playback::getLastFrameTime ( ) const

inline

Definition at line 106 of file UT_Playback.h.

static UT_Playback* UT_Playback::getPlayback ( )

static

UT_PlaybackMode UT_Playback::getPlaybackMode ( ) const

inline

Definition at line 64 of file UT_Playback.h.

void UT_Playback::getPlaybackRange ( fpreal &  start, fpreal &  end  ) const

inline

Definition at line 83 of file UT_Playback.h.

RealtimeBehaviour UT_Playback::getRealtimeBehaviour ( ) const

inline

Definition at line 138 of file UT_Playback.h.

bool UT_Playback::getRealtimeMode ( ) const

inline

Definition at line 77 of file UT_Playback.h.

fpreal UT_Playback::getSamplesPerSec ( ) const

inline

Definition at line 110 of file UT_Playback.h.

int UT_Playback::getStopCount ( ) const

inline

Definition at line 71 of file UT_Playback.h.

bool UT_Playback::isContinuousCook ( ) const

inline

Definition at line 68 of file UT_Playback.h.

bool UT_Playback::isPlaybackReset

(

)

bool UT_Playback::isPlaying ( ) const

inline

Definition at line 87 of file UT_Playback.h.

bool UT_Playback::isScrubbing ( ) const

inline

Definition at line 89 of file UT_Playback.h.

void UT_Playback::registerContinuousCookNode

(

int

nodeid

)

Register nodes as continuous playback nodes, these will have their continuouscook_tick incremented on continuouscook frames

void UT_Playback::removeFlipbookCallbacks

(

int

id

)

Remove flipbook callbacks by the respective id.

void UT_Playback::removePlayAdvanceCB	(	UT_PlayAdvanceCB	,
		void *	cbdata
	)

void UT_Playback::removePlayCallback	(	UT_PlayCallback	cb,
		void *	cbdata
	)

void UT_Playback::resetAbsoluteFrame

(

)

void UT_Playback::setContinuousCook

(

bool

continuous

)

void UT_Playback::setCurrentFrame

(

fpreal

frame

)

void UT_Playback::setInterceptMode ( int  mode )

inline

Definition at line 101 of file UT_Playback.h.

void UT_Playback::setLastFrameTime ( fpreal  time_sec )

inline

Definition at line 104 of file UT_Playback.h.

void UT_Playback::setPlaybackMode

(

UT_PlaybackMode

mode

)

void UT_Playback::setPlaybackRange ( fpreal  start, fpreal  end  )

inline

Definition at line 80 of file UT_Playback.h.

void UT_Playback::setRealtimeBehaviour ( const RealtimeBehaviour  behaviour )

inline

Definition at line 136 of file UT_Playback.h.

void UT_Playback::setRealtimeMode ( bool  mode )

inline

Definition at line 74 of file UT_Playback.h.

void UT_Playback::setSamplesPerSec ( fpreal  samples_sec )

inline

Definition at line 108 of file UT_Playback.h.

void UT_Playback::setStopCallback	(	void(*)(void *)	cb,
		void *	data
	)

void UT_Playback::stopPlayback

(

)

void UT_Playback::unregisterContinuousCookNode

(

int

nodeid

)

---

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

• UT/UT_Playback.h