Inheritance diagram for inviwo::CanvasProcessor:

Public Member Functions
	CanvasProcessor (InviwoApplication *app)

virtual void	process () override

virtual void	doIfNotReady () override

void	setCanvasSize (size2_t)

size2_t	getCanvasSize () const

bool	getUseCustomDimensions () const

size2_t	getCustomDimensions () const

void	saveImageLayer ()

void	saveImageLayer (std::string filePath, const FileExtension &extension=FileExtension())

const Layer *	getVisibleLayer () const

std::shared_ptr< const Image >	getImage () const

virtual void	setProcessorWidget (std::unique_ptr< ProcessorWidget > processorWidget) override

virtual void	propagateEvent (Event event, Outport source) override

bool	isContextMenuAllowed () const

void	setEvaluateWhenHidden (bool option)

Public Member Functions inherited from inviwo::Processor
	Processor (const std::string &identifier="", const std::string &displayName="")

virtual const ProcessorInfo	getProcessorInfo () const =0

std::string	getClassIdentifier () const

std::string	getCategory () const

CodeState	getCodeState () const

Tags	getTags () const

void	setIdentifier (const std::string &identifier)

const std::string &	getIdentifier () const

void	setDisplayName (const std::string &displayName)

const std::string &	getDisplayName () const

virtual std::vector< std::string >	getPath () const override

ProcessorWidget *	getProcessorWidget () const

bool	hasProcessorWidget () const

virtual void	setNetwork (ProcessorNetwork *network)

ProcessorNetwork *	getNetwork () const

virtual void	initializeResources ()

Port *	getPort (const std::string &identifier) const

Inport *	getInport (const std::string &identifier) const

Outport *	getOutport (const std::string &identifier) const

const std::vector< Inport * > &	getInports () const

const std::vector< Outport * > &	getOutports () const

const std::string &	getPortGroup (Port *port) const

std::vector< std::string >	getPortGroups () const

const std::vector< Port * > &	getPortsInGroup (const std::string &portGroup) const

const std::vector< Port * > &	getPortsInSameGroup (Port *port) const

bool	allInportsConnected () const

bool	allInportsAreReady () const

bool	isSource () const

bool	isSink () const

bool	isReady () const

virtual void	setValid () override

virtual void	invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty=nullptr) override

void	addInteractionHandler (InteractionHandler *interactionHandler)

void	removeInteractionHandler (InteractionHandler *interactionHandler)

bool	hasInteractionHandler () const

const std::vector< InteractionHandler * > &	getInteractionHandlers () const

virtual void	invokeEvent (Event *event) override

virtual Processor *	getProcessor () override

virtual const Processor *	getProcessor () const override

virtual void	serialize (Serializer &s) const override

virtual void	deserialize (Deserializer &d) override

template<typename T , typename std::enable_if_t< std::is_base_of< Inport, T >::value, int > = 0>
T &	addPort (std::unique_ptr< T > port, const std::string &portGroup="default")

template<typename T , typename std::enable_if_t< std::is_base_of< Outport, T >::value, int > = 0>
T &	addPort (std::unique_ptr< T > port, const std::string &portGroup="default")

template<typename T >
T &	addPort (T &port, const std::string &portGroup="default")

Port *	removePort (const std::string &identifier)

Inport *	removePort (Inport *port)

Outport *	removePort (Outport *port)

Public Member Functions inherited from inviwo::PropertyOwner
virtual	~PropertyOwner ()
	Removes all properties and notifies its observers of the removal.

virtual void	addProperty (Property *property, bool owner=true)

virtual void	addProperty (Property &property)

template<typename... Ts>
void	addProperties (Ts &... properties)

virtual void	insertProperty (size_t index, Property *property, bool owner=true)
	insert property `property` at position `index` If `index` is not valid, the property is appended. More...

virtual void	insertProperty (size_t index, Property &property)
	insert property `property` at position `index` If `index` is not valid, the property is appended. More...

virtual Property *	removeProperty (const std::string &identifier)

virtual Property *	removeProperty (Property *property)

virtual Property *	removeProperty (Property &property)

virtual Property *	removeProperty (size_t index)
	remove property referred to by `index` More...

const std::vector< Property * > &	getProperties () const

const std::vector< CompositeProperty * > &	getCompositeProperties () const

std::vector< Property * >	getPropertiesRecursive () const

Property *	getPropertyByIdentifier (const std::string &identifier, bool recursiveSearch=false) const

Property *	getPropertyByPath (const std::vector< std::string > &path) const

template<class T >
std::vector< T * >	getPropertiesByType (bool recursiveSearch=false) const

size_t	size () const

Property *	operator[] (size_t)

const Property *	operator[] (size_t) const

iterator	begin ()

iterator	end ()

const_iterator	cbegin () const

const_iterator	cend () const

virtual bool	isValid () const

InvalidationLevel	getInvalidationLevel () const

void	setAllPropertiesCurrentStateAsDefault ()

void	resetAllPoperties ()

virtual InviwoApplication *	getInviwoApplication ()

Public Member Functions inherited from inviwo::PropertyOwnerObservable
void	notifyObserversWillAddProperty (Property *property, size_t index)

void	notifyObserversDidAddProperty (Property *property, size_t index)

void	notifyObserversWillRemoveProperty (Property *property, size_t index)

void	notifyObserversDidRemoveProperty (Property *property, size_t index)

Public Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
	Observable (const Observable< PropertyOwnerObserver > &other)

	Observable (Observable< PropertyOwnerObserver > &&other)

Observable< PropertyOwnerObserver > &	operator= (const Observable< PropertyOwnerObserver > &other)

Observable< PropertyOwnerObserver > &	operator= (Observable< PropertyOwnerObserver > &&other)

void	addObserver (PropertyOwnerObserver *observer)

void	removeObserver (PropertyOwnerObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Public Member Functions inherited from inviwo::MetaDataOwner
	MetaDataOwner (const MetaDataOwner &rhs)=default

MetaDataOwner &	operator= (const MetaDataOwner &rhs)=default

void	copyMetaDataFrom (const MetaDataOwner &src)

void	copyMetaDataTo (MetaDataOwner &dst)

template<typename T >
T *	createMetaData (const std::string &key)

template<typename T , typename U >
void	setMetaData (const std::string &key, U value)

template<typename T >
bool	unsetMetaData (const std::string &key)
	unset, i.e. remove the metadata entry matching the given key and type More...

template<typename T , typename U >
U	getMetaData (const std::string &key, U val) const

template<typename T >
T *	getMetaData (const std::string &key)

template<typename T >
const T *	getMetaData (const std::string &key) const

MetaDataMap *	getMetaDataMap ()

const MetaDataMap *	getMetaDataMap () const

template<typename T >
bool	hasMetaData (const std::string &key) const

Public Member Functions inherited from inviwo::Observable< ProcessorObserver >
	Observable (const Observable< ProcessorObserver > &other)

	Observable (Observable< ProcessorObserver > &&other)

Observable< ProcessorObserver > &	operator= (const Observable< ProcessorObserver > &other)

Observable< ProcessorObserver > &	operator= (Observable< ProcessorObserver > &&other)

void	addObserver (ProcessorObserver *observer)

void	removeObserver (ProcessorObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

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 ()

Public Attributes
ImageInport	inport_

CompositeProperty	inputSize_

IntSize2Property	dimensions_

BoolProperty	enableCustomInputDimensions_

IntSize2Property	customInputDimensions_

BoolProperty	keepAspectRatio_

FloatProperty	aspectRatioScaling_

IntVec2Property	position_

TemplateOptionProperty< LayerType >	visibleLayer_

IntProperty	colorLayer_

TemplateOptionProperty< FileExtension >	imageTypeExt_

DirectoryProperty	saveLayerDirectory_

ButtonProperty	saveLayerButton_

ButtonProperty	saveLayerToFileButton_

BoolProperty	fullScreen_

EventProperty	fullScreenEvent_

EventProperty	saveLayerEvent_

BoolProperty	allowContextMenu_

Protected Member Functions
virtual void	onProcessorWidgetPositionChange (ProcessorWidgetMetaData *) override

virtual void	onProcessorWidgetDimensionChange (ProcessorWidgetMetaData *) override

virtual void	onProcessorWidgetVisibilityChange (ProcessorWidgetMetaData *) override

Canvas *	getCanvas () const

Protected Member Functions inherited from inviwo::Processor
void	addPortToGroup (Port *port, const std::string &portGroup)

void	removePortFromGroups (Port *port)

Protected Member Functions inherited from inviwo::PropertyOwner
	PropertyOwner (const PropertyOwner &rhs)

PropertyOwner &	operator= (const PropertyOwner &that)=delete

Protected Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
void	forEachObserver (C callback)

Protected Member Functions inherited from inviwo::ObservableInterface
void	addObservationHelper (Observer *observer)

void	removeObservationHelper (Observer *observer)

Protected Member Functions inherited from inviwo::ProcessorObservable
void	notifyObserversAboutPropertyChange (Property *p)

void	notifyObserversInvalidationBegin (Processor *p)

void	notifyObserversInvalidationEnd (Processor *p)

void	notifyObserversIdentifierChanged (Processor *p, const std::string &oldIdentifier)

void	notifyObserversDisplayNameChanged (Processor *p, const std::string &oldDisplayName)

void	notifyObserversProcessorPortAdded (Processor p, Port port)

void	notifyObserversProcessorPortRemoved (Processor p, Port port)

void	notifyObserversAboutToProcess (Processor *p)

void	notifyObserversFinishedProcess (Processor *p)

void	notifyObserversSourceChange (Processor *p)

void	notifyObserversSinkChange (Processor *p)

void	notifyObserversReadyChange (Processor *p)

Protected Member Functions inherited from inviwo::Observable< ProcessorObserver >
void	forEachObserver (C callback)

Protected Member Functions inherited from inviwo::Observer
void	addObservation (ObservableInterface *observable)

Additional Inherited Members
Public Types inherited from inviwo::PropertyOwner
using	iterator = std::vector< Property * >::iterator

using	const_iterator = std::vector< Property * >::const_iterator

Protected Types inherited from inviwo::Observer
using	ObservableSet = std::unordered_set< ObservableInterface * >

Protected Attributes inherited from inviwo::Processor
std::unique_ptr< ProcessorWidget >	processorWidget_

StateCoordinator< bool >	isReady_

StateCoordinator< bool >	isSink_

StateCoordinator< bool >	isSource_

Protected Attributes inherited from inviwo::PropertyOwner
std::vector< Property * >	properties_

std::vector< EventProperty * >	eventProperties_

std::vector< CompositeProperty * >	compositeProperties_

std::vector< std::unique_ptr< Property > >	ownedProperties_

Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap	metaData_

Protected Attributes inherited from inviwo::ProcessorObservable
friend	ProcessorNetworkEvaluator

friend	Property

Protected Attributes inherited from inviwo::Observer
ObservableSet	observables_

Member Function Documentation

◆ doIfNotReady()

void inviwo::CanvasProcessor::doIfNotReady ( )

overridevirtual

This function is called by the ProcessorNetworkEvaluator when the network is evaluated and the processor is neither ready or valid.

See also: ProcessorNetworkEvaluator

Reimplemented from inviwo::Processor.

◆ process()

void inviwo::CanvasProcessor::process ( )

overridevirtual

Deriving classes should override this function to do the main work of the processor. This function is called by the ProcessorNetworkEvaluator when the network is evaluated and the processor is invalid, i.e. some of its inports or properties has been modified, and is ready i.e. all non optional inports have valid data.

See also: ProcessorNetworkEvaluator; Inport; Property

Reimplemented from inviwo::Processor.

◆ setEvaluateWhenHidden()

void inviwo::CanvasProcessor::setEvaluateWhenHidden ( bool option )

By default the processor will only evaluate when its canvas is visible. By setting setEvaluateWhenHidden to true, it will be evaluated regardless.

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

canvasprocessor.h
canvasprocessor.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ doIfNotReady()

◆ process()

◆ setEvaluateWhenHidden()