#include <propertytrack.h>

Inheritance diagram for inviwo::animation::PropertyTrack< Prop, Key, Seq >:

Public Member Functions
	PropertyTrack (ProcessorNetwork *network)
	PropertyTrack (Prop *property)
	PropertyTrack (Prop property, ProcessorNetwork network)
virtual	~PropertyTrack ()
virtual PropertyTrack *	clone () const override
virtual std::string_view	getClassIdentifier () const override
virtual AnimationTimeState	operator() (Seconds from, Seconds to, AnimationState state) const override
virtual const Prop *	getProperty () const override
virtual Prop *	getProperty () override
virtual void	setProperty (Property *property) override
virtual void	serialize (Serializer &s) const override
virtual void	deserialize (Deserializer &d) override
virtual Key *	addKeyFrameUsingPropertyValue (const Property *property, Seconds time, std::unique_ptr< Interpolation > interpolation=nullptr) override
virtual Key *	addKeyFrameUsingPropertyValue (Seconds time, std::unique_ptr< Interpolation > interpolation=nullptr) override
virtual Seq *	addSequenceUsingPropertyValue (Seconds time, std::unique_ptr< Interpolation > interpolation=nullptr) override
virtual Track *	toTrack () override
void	setPropertyFromKeyframe (Property dstProperty, const Keyframe keyframe) const override
	Helper function to set a property from a keyframe.
void	setKeyframeFromProperty (const Property srcProperty, Keyframe keyframe) override
	Helper function to update the value if a keyframe from a property (other than the property owned by the track).
virtual std::unique_ptr< Key >	createKeyframe (Seconds time) const override
Public Member Functions inherited from inviwo::animation::BaseTrack< Seq >
	BaseTrack (const std::string &name, size_t priority=0)
virtual bool	isEnabled () const override
virtual void	setEnabled (bool enabled) override
virtual const std::string &	getName () const override
virtual void	setName (const std::string &name) override
virtual size_t	getPriority () const override
virtual void	setPriority (size_t priority) override
virtual Seconds	getFirstTime () const override
virtual Seconds	getLastTime () const override
virtual std::optional< Seconds >	getPrevTime (Seconds at) const final
virtual std::optional< Seconds >	getNextTime (Seconds at) const final
virtual std::vector< Seconds >	getAllTimes () const override
virtual size_t	size () const override
virtual bool	empty () const override
virtual Seq &	operator[] (size_t i) override
virtual const Seq &	operator[] (size_t i) const override
virtual const Seq &	getFirst () const override
virtual Seq &	getFirst () override
virtual const Seq &	getLast () const override
virtual Seq &	getLast () override
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
virtual key_type *	add (Seconds time, bool asNewSequence) override
virtual Seq *	add (std::unique_ptr< KeyframeSequence > sequence) override
virtual Seq *	add (std::unique_ptr< Seq > sequence)
virtual std::unique_ptr< KeyframeSequence >	remove (size_t i) override
virtual std::unique_ptr< Keyframe >	remove (Keyframe *key) override
virtual std::unique_ptr< KeyframeSequence >	remove (KeyframeSequence *seq) override
Public Member Functions inherited from inviwo::animation::Track
virtual	~Track ()=default
Public Member Functions inherited from inviwo::Observable< TrackObserver >
Observable< TrackObserver > &	operator= (const Observable< TrackObserver > &other)
void	addObserver (TrackObserver *observer)
void	removeObserver (TrackObserver *observer)
bool	isObservedBy (TrackObserver *observer) const
virtual void	startBlockingNotifications () override final
virtual void	stopBlockingNotifications () override final
Public Member Functions inherited from inviwo::animation::KeyframeSequenceObserver
virtual void	onKeyframeAdded (Keyframe , KeyframeSequence )
virtual void	onKeyframeRemoved (Keyframe , KeyframeSequence )
virtual void	onKeyframeSequenceSelectionChanged (KeyframeSequence *)
Public Member Functions inherited from inviwo::Observer
	Observer (const Observer &other)
	Observer (Observer &&other)
Observer &	operator= (Observer &&other)
Observer &	operator= (const Observer &other)
virtual	~Observer ()
void	removeObservation (ObservableInterface *observable)
void	removeObservations ()

Static Public Member Functions
static constexpr std::string_view	classIdentifier ()

Protected Member Functions
	PropertyTrack (const PropertyTrack &other)=default
	PropertyTrack (PropertyTrack &&other)=default
std::unique_ptr< Key >	createKeyframe (const Prop *property, Seconds time) const
std::unique_ptr< Seq >	createKeyframeSequence (std::vector< std::unique_ptr< Key > > keys, std::unique_ptr< Interpolation > interpolation) const
Protected Member Functions inherited from inviwo::animation::BaseTrack< Seq >
	BaseTrack (const BaseTrack &other)
	BaseTrack (BaseTrack &&other)=default
BaseTrack &	operator= (const BaseTrack &)
BaseTrack &	operator= (BaseTrack &&other)=default
virtual void	onKeyframeSequenceMoved (KeyframeSequence *seq) override
key_type *	addToClosestSequence (std::unique_ptr< key_type > key)
Protected Member Functions inherited from inviwo::animation::TrackObservable
void	notifyKeyframeSequenceAdded (Track t, KeyframeSequence s)
void	notifyKeyframeSequenceRemoved (Track t, KeyframeSequence s)
void	notifyFirstMoved (Track *t)
void	notifyLastMoved (Track *t)
void	notifyEnabledChanged (Track *t)
void	notifyNameChanged (Track *t)
void	notifyPriorityChanged (Track *t)
Protected Member Functions inherited from inviwo::Observable< TrackObserver >
void	forEachObserver (C callback)
Protected Member Functions inherited from inviwo::ObservableInterface
virtual void	addObserver (Observer *observer)=0
virtual void	removeObserver (Observer *observer)=0
void	addObservationHelper (Observer *observer)
void	removeObservationHelper (Observer *observer)
Protected Member Functions inherited from inviwo::Observer
void	addObservation (ObservableInterface *observable)

Additional Inherited Members
Public Types inherited from inviwo::animation::BaseTrack< Seq >
using	seq_type = Seq
using	key_type = typename Seq::key_type
using	value_type = typename Seq::value_type
using	iterator = util::IndirectIterator<typename std::vector<std::unique_ptr<Seq>>::iterator>
using	const_iterator
Protected Attributes inherited from inviwo::Observer
std::unordered_set< ObservableInterface * >	observables_

Detailed Description

template<typename Prop, typename Key, typename Seq = KeyframeSequenceTyped<Key>>
class inviwo::animation::PropertyTrack< Prop, Key, Seq >

Implementation of BasePropertyTrack and TrackTyped based on templates parameter types for Property, KeyFrame and KeyframeSequence. Exposes functions for adding a KeyFrame and KeyFrameSequence using the current values of the Property.

See also: Track; KeyframeSequenceTyped; Property

Constructor & Destructor Documentation

◆ ~PropertyTrack()

template<typename Prop, typename Key, typename Seq>

inviwo::animation::PropertyTrack< Prop, Key, Seq >::~PropertyTrack ( )

virtualdefault

Remove all keyframe sequences and call TrackObserver::notifyKeyframeSequenceRemoved

Member Function Documentation

◆ addKeyFrameUsingPropertyValue() [1/2]

template<typename Prop, typename Key, typename Seq>

Key * inviwo::animation::PropertyTrack< Prop, Key, Seq >::addKeyFrameUsingPropertyValue	(	const Property *	property,
		Seconds	time,
		std::unique_ptr< Interpolation >	interpolation = nullptr )

overridevirtual

Implements inviwo::animation::BasePropertyTrack.

◆ addKeyFrameUsingPropertyValue() [2/2]

template<typename Prop, typename Key, typename Seq>

Key * inviwo::animation::PropertyTrack< Prop, Key, Seq >::addKeyFrameUsingPropertyValue	(	Seconds	time,
		std::unique_ptr< Interpolation >	interpolation = nullptr )

overridevirtual

Implements inviwo::animation::BasePropertyTrack.

◆ addSequenceUsingPropertyValue()

template<typename Prop, typename Key, typename Seq>

Seq * inviwo::animation::PropertyTrack< Prop, Key, Seq >::addSequenceUsingPropertyValue	(	Seconds	time,
		std::unique_ptr< Interpolation >	interpolation = nullptr )

overridevirtual

Implements inviwo::animation::BasePropertyTrack.

◆ clone()

template<typename Prop, typename Key, typename Seq>

PropertyTrack< Prop, Key, Seq > * inviwo::animation::PropertyTrack< Prop, Key, Seq >::clone ( ) const

overridevirtual

Create a deep copy of the Track including references to its possibly underlying Property.

Implements inviwo::animation::Track.

◆ createKeyframe()

template<typename Prop, typename Key, typename Seq>

std::unique_ptr< Key > inviwo::animation::PropertyTrack< Prop, Key, Seq >::createKeyframe ( Seconds time ) const

inlineoverridevirtual

Reimplemented from inviwo::animation::BaseTrack< Seq >.

◆ deserialize()

template<typename Prop, typename Key, typename Seq>

void inviwo::animation::PropertyTrack< Prop, Key, Seq >::deserialize ( Deserializer & d )

overridevirtual

Reimplemented from inviwo::animation::BaseTrack< Seq >.

◆ getClassIdentifier()

template<typename Prop, typename Key, typename Seq>

std::string_view inviwo::animation::PropertyTrack< Prop, Key, Seq >::getClassIdentifier ( ) const

overridevirtual

Implements inviwo::animation::Track.

◆ getProperty() [1/2]

template<typename Prop, typename Key, typename Seq>

const Prop * inviwo::animation::PropertyTrack< Prop, Key, Seq >::getProperty ( ) const

overridevirtual

Implements inviwo::animation::BasePropertyTrack.

◆ getProperty() [2/2]

template<typename Prop, typename Key, typename Seq>

Prop * inviwo::animation::PropertyTrack< Prop, Key, Seq >::getProperty ( )

overridevirtual

Implements inviwo::animation::BasePropertyTrack.

◆ operator()()

template<typename Prop, typename Key, typename Seq>

AnimationTimeState inviwo::animation::PropertyTrack< Prop, Key, Seq >::operator()	(	Seconds	from,
		Seconds	to,
		AnimationState	state ) const

overridevirtual

Implements inviwo::animation::Track.

◆ serialize()

template<typename Prop, typename Key, typename Seq>

void inviwo::animation::PropertyTrack< Prop, Key, Seq >::serialize ( Serializer & s ) const

overridevirtual

Reimplemented from inviwo::animation::BaseTrack< Seq >.

◆ setKeyframeFromProperty()

template<typename Prop, typename Key, typename Seq = KeyframeSequenceTyped<Key>>

void inviwo::animation::PropertyTrack< Prop, Key, Seq >::setKeyframeFromProperty	(	const Property *	srcProperty,
		Keyframe *	keyframe )

inlineoverridevirtual

Helper function to update the value if a keyframe from a property (other than the property owned by the track).

Called from inviwo::animation::KeyframeEditorWidget when the value of the keyframe is updated through the widget

Parameters

srcProperty	The property to set from
keyframe	The keyframe to set

Implements inviwo::animation::BasePropertyTrack.

◆ setProperty()

template<typename Prop, typename Key, typename Seq>

void inviwo::animation::PropertyTrack< Prop, Key, Seq >::setProperty ( Property * property )

overridevirtual

Implements inviwo::animation::BasePropertyTrack.

◆ setPropertyFromKeyframe()

template<typename Prop, typename Key, typename Seq = KeyframeSequenceTyped<Key>>

void inviwo::animation::PropertyTrack< Prop, Key, Seq >::setPropertyFromKeyframe	(	Property *	dstProperty,
		const Keyframe *	keyframe ) const

inlineoverridevirtual

Helper function to set a property from a keyframe.

Called from inviwo::animation::KeyframeEditorWidget when creating the widget

Parameters

dstProperty	The property to set
keyframe	The keyframe to set from

Implements inviwo::animation::BasePropertyTrack.

◆ toTrack()

template<typename Prop, typename Key, typename Seq>

Track * inviwo::animation::PropertyTrack< Prop, Key, Seq >::toTrack ( )

overridevirtual

Implements inviwo::animation::BasePropertyTrack.

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

propertytrack.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~PropertyTrack()

Member Function Documentation

◆ addKeyFrameUsingPropertyValue() [1/2]

◆ addKeyFrameUsingPropertyValue() [2/2]

◆ addSequenceUsingPropertyValue()

◆ clone()

◆ createKeyframe()

◆ deserialize()

◆ getClassIdentifier()

◆ getProperty() [1/2]

◆ getProperty() [2/2]

◆ operator()()

◆ serialize()

◆ setKeyframeFromProperty()

◆ setProperty()

◆ setPropertyFromKeyframe()

◆ toTrack()