inviwo::animation::WorkspaceAnimations Class Reference

Responsible for animations saved in the workspace and ensuring that there always is at least one main Animation. More...

#include <modules/animation/workspaceanimations.h>

Inheritance diagram for inviwo::animation::WorkspaceAnimations:

Public Types
using	const_iterator
using	iterator
using	OnChangedDispatcher = Dispatcher<void(size_t, Animation&)>

Public Member Functions
Animation &	add (Animation anim)
Animation &	add (std::string_view name)
iterator	begin ()
const_iterator	begin () const
void	clear ()
iterator	end ()
const_iterator	end () const
void	erase (const_iterator position)
void	erase (size_t index)
iterator	find (const Animation *anim)
const_iterator	find (const Animation *anim) const
Animation &	get (size_t index)
std::vector< Animation * >	get (std::string_view name)
MainAnimation &	getMainAnimation ()
const MainAnimation &	getMainAnimation () const
Animation &	insert (const_iterator position, std::string_view name)
Animation &	insert (size_t index, std::string_view name)
WorkspaceAnimations &	operator= (const WorkspaceAnimations &)=delete
WorkspaceAnimations &	operator= (WorkspaceAnimations &&)=delete
Animation &	operator[] (size_t i)
const Animation &	operator[] (size_t i) const
void	setMainAnimation (Animation &anim)
	Set specified Animation to be the MainAnimation. A copy of the Animation will be added in case the it has not been added before. The AnimationController in MainAnimation will notify its observers of the animation change.
size_t	size () const
	WorkspaceAnimations (const WorkspaceAnimations &)=delete
	WorkspaceAnimations (InviwoApplication *app, AnimationManager &manager, AnimationModule &module)
	WorkspaceAnimations (WorkspaceAnimations &&)=delete
Public Member Functions inherited from inviwo::animation::AnimationControllerObserver
virtual void	onStateChanged (AnimationController *, AnimationState, AnimationState)
virtual void	onTimeChanged (AnimationController *, Seconds, Seconds)
Public Member Functions inherited from inviwo::Observer
	Observer (const Observer &other)
	Observer (Observer &&other)
Observer &	operator= (const Observer &other)
Observer &	operator= (Observer &&other)
void	removeObservation (ObservableInterface *observable)
void	removeObservations ()
virtual	~Observer ()
Public Member Functions inherited from inviwo::animation::AnimationObserver
virtual void	onFirstMoved ()
virtual void	onLastMoved ()
Public Member Functions inherited from inviwo::animation::TrackObserver
virtual void	onFirstMoved (Track *)
virtual void	onLastMoved (Track *)

Public Attributes
OnChangedDispatcher	onChanged_

Additional Inherited Members
Protected Member Functions inherited from inviwo::Observer
void	addObservation (ObservableInterface *observable)
Protected Attributes inherited from inviwo::Observer
std::unordered_set< ObservableInterface * >	observables_

Detailed Description

Responsible for animations saved in the workspace and ensuring that there always is at least one main Animation.

One of its animations is set to be the MainAnimation. The Animation used by MainAnimation must be set through WorkspaceAnimations.

WorkspaceAnimations is responsible for clearing, saving, and loading animations when the workspace is cleared, saved, or loaded. It will also call notifyObserversProcessorNetworkChanged whenever its animations change to enable undo/redo.

Member Typedef Documentation

const_iterator

using inviwo::animation::WorkspaceAnimations::const_iterator

Initial value:

 
        util::IndirectIterator<typename std::vector<std::unique_ptr<Animation>>::const_iterator>

iterator

using inviwo::animation::WorkspaceAnimations::iterator

Initial value:

 
        util::IndirectIterator<typename std::vector<std::unique_ptr<Animation>>::iterator>

OnChangedDispatcher

using inviwo::animation::WorkspaceAnimations::OnChangedDispatcher = Dispatcher<void(size_t, Animation&)>

Called when an Animation is added or removed. In case of removal: The supplied Animation will be removed from WorkspaceAnimation before this function is called, but it will not be deleted until after this call.

Parameters

Index	of changed Animation (as it was before removal)
Reference	to the added/removed Animation.

Member Function Documentation

add()

Animation & inviwo::animation::WorkspaceAnimations::add

(

std::string_view

name

)

Add an empty Animation with specified name.

clear()

void inviwo::animation::WorkspaceAnimations::clear

(

)

Removes all animations leaving an empty Animation, which is set to be the MainAnimation. The size() will be 1 after clearing.

erase()

void inviwo::animation::WorkspaceAnimations::erase

(

size_t

index

)

Removes the animation and adjusts the main animation to the next available index if needed. An empty animation will be added if all animations are erased.

get()

std::vector< Animation * > inviwo::animation::WorkspaceAnimations::get

(

std::string_view

name

)

Returns

all animations matching name

---

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

• modules/animation/include/modules/animation/workspaceanimations.h