#include <CH_Tweener.h>

Public Member Functions
	CH_Tweener ()

	~CH_Tweener ()

	UT_NON_COPYABLE (CH_Tweener)

void	setChannels (UT_Array< CH_ChannelSelections > &&channels)

void	setChannels (const CH_ChannelList &channels)

void	setChannelsFromScopedChannels ()

void	clear ()

void	tween (CH_TweenMode mode, fpreal val, bool first=false, bool last=false)

int	getNumModes ()

void	setLeftBlendTime (fpreal t)
	Set the eval times used by the blend to frame mode. More...

void	setRightBlendTime (fpreal t)

void	setBlendTimes (fpreal left, fpreal right)

void	getBlendTimes (fpreal &left, fpreal &right) const

UT_StringHolder	getModeName (CH_TweenMode mode) const

UT_StringHolder	getModeAbbreviation (CH_TweenMode mode) const

UT_StringHolder	getModeToken (CH_TweenMode mode) const

CH_TweenMode	getMode (const UT_StringHolder &token) const

bool	getOvershootSupported (CH_TweenMode mode) const

bool	getRequiresFullChannelUndo (CH_TweenMode mode) const

CH_TweenToolType	getToolType (CH_TweenMode mode) const

Detailed Description

Definition at line 58 of file CH_Tweener.h.

Constructor & Destructor Documentation

CH_Tweener::CH_Tweener ( )

CH_Tweener::~CH_Tweener ( )

void CH_Tweener::clear ( )

void CH_Tweener::getBlendTimes	(	fpreal &	left,
		fpreal &	right
	)		const

inline

Definition at line 105 of file CH_Tweener.h.

CH_TweenMode CH_Tweener::getMode ( const UT_StringHolder & token ) const

Given the mode token, return the CH_TweenMode enum value. If there is no such mode, returns CH_TweenMode::Count

UT_StringHolder CH_Tweener::getModeAbbreviation ( CH_TweenMode mode ) const

UT_StringHolder CH_Tweener::getModeName ( CH_TweenMode mode ) const

Returns the name of the tween mode in a format suitable to display. eg CH_TweenMode::BlendToNeighbor -> "Blend To Neighbor"

UT_StringHolder CH_Tweener::getModeToken ( CH_TweenMode mode ) const

Returns a simple, all lowercase token unique to each tween mode Used by the playbar to generate unique UI_Value names for each tween Mode.

int CH_Tweener::getNumModes ( )

inline

Definition at line 94 of file CH_Tweener.h.

bool CH_Tweener::getOvershootSupported ( CH_TweenMode mode ) const

bool CH_Tweener::getRequiresFullChannelUndo ( CH_TweenMode mode ) const

CH_TweenToolType CH_Tweener::getToolType ( CH_TweenMode mode ) const

void CH_Tweener::setBlendTimes	(	fpreal	left,
		fpreal	right
	)

inline

Definition at line 99 of file CH_Tweener.h.

void CH_Tweener::setChannels ( UT_Array< CH_ChannelSelections > && channels )

void CH_Tweener::setChannels ( const CH_ChannelList & channels )

void CH_Tweener::setChannelsFromScopedChannels ( )

void CH_Tweener::setLeftBlendTime ( fpreal t )

inline

Set the eval times used by the blend to frame mode.

Definition at line 97 of file CH_Tweener.h.

void CH_Tweener::setRightBlendTime ( fpreal t )

inline

Definition at line 98 of file CH_Tweener.h.

Perform a tween on all channels currently added to the Tweener

Parameters

first	Starts a new tween, creating a new undo block and caching any relevant data for the given tween mode. For instance, blending tween modes need to cache the current values of the keys.
last	Finishes a tween, closing undo blocks. This MUST be called when finishing a tween

CH_Tweener::UT_NON_COPYABLE ( CH_Tweener )

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