A processor generally performs operation on input data and outputs the new result. More...

#include <processor.h>

Inheritance diagram for inviwo::Processor:

Public Member Functions
	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

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

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

virtual void	doIfNotReady ()

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 void	propagateEvent (Event event, Outport source) 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

Protected Member Functions
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 Attributes
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

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

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

Detailed Description

A processor generally performs operation on input data and outputs the new result.

It can hold arbitrary number of inports and outports, as well as properties which can be used to customize the processors behavior.

A typical flow for processing Processor 1 is shown below.

*     ┌─────────────┐
*     │             │
*     │ Processor 2 │
*     │ ┌─┐         │◀────────────────────────────────────────── Outport 2
*     └─┴┬┴─────────┘
*        └────────────────┐
*                       ┌┬▼┬──────────┐ ◀─────────────────────── Inport 1
*                       │└─┘          │
*                       │ Processor 1 │
*                       │┌─┐          │ ◀─────────────────────── Outport 1
*                       └┴┬┴──────────┘
*                         └────────────────┐
*                                        ┌┬▼┬──────────┐ ◀────── Inport 0
*                                        │└─┘          │
*                                        │ Processor 0 │
*                                        │┌─┐          │ ◀────── Outport 0
*                                        └┴─┴──────────┘
*
*       Evaluator         Processor 1         Inport 1           Outport 2
*           │                  │                  │                  │
*           │                  │                  │                  │
*           │                  │                  │                  │
*           ├─────!isValid?────▶                  │                  │
*           ◀────────No────────┤                  │                  │
*           │                  │                  │                  │
*           │                  │                  │                  │
*           │                  │                  │                  │
*           ├────isReady?──────▶                  │                  │
*           │                  ├─────isValid?─────▶                  │
*           │                  │                  ├────isValid?──────▶
*           │                  │                  │                  ├─────┐
*           │                  │                  │                  │  data?
*           │                  │                  │                  │  valid?
*           │                  │                  │                  ◀─Yes─┘
*           │                  │                  ◀──────Yes─────────┤
*           │                  ◀───────Yes────────┤                  │
*           ◀──────Yes─────────┤                  │                  │
*           │                  │                  │                  │
*           │                  │                  │                  │
*           │    Inv. Level    │                  │                  │
*           ├─────────>────────▶                  │                  │
*           │   INV.RESOURCES  │                  │                  │
*           │                  │                  │                  │
*           ◀───────Yes────────┤                  │                  │
*           │                  │                  │                  │
*           │                  │                  │                  │
*           │                  │                  │                  │
*           ├──Init. Resources ▶                  │                  │
*           ◀───────Done───────┤                  │                  │
*           │                  │                  │                  │
*           │                  │                  │                  │
*           │                  │                  │                  │
*           ├────GetInports────▶                  │                  │
*           │                  ├──callOnChange────▶                  │
*           │                  ◀──────Done────────┤                  │
*           ◀───────Done───────┤                  │                  │
*           │                  │                  │                  │
*           │                  │                  │                  │
*           │                  │                  │                  │
*           ├────Process───────▶                  │                  │
*           │                  ├─────GetData──────▶                  │
*           │                  │                  ├────GetData───────▶
*           │                  │                  ◀──────data────────┤
*           │                  ◀───────data───────┤                  │
*           │                  │                  │                  │
*           │                  │                  ▼                  ▼
*           │                  │
*           │                  │              Outport 1
*           │                  │                  │
*           │                  ├─────SetData──────▶
*           │                  ◀───────Done───────┤
*           ◀───────Done───────┤                  │
*           │                  │                  ▼
*           │                  │
*           │                  │              Inport 1
*           ├─────SetValid─────▶    SetChanged    │
*           │                  ├─────(false)──────▶
*           │                  ◀───────Done───────┤
*           │                  │                  │
*           │                  │                  ▼
*           │                  │
*           │                  │              Outport 1          Inport 0
*           │                  │                  │                  │
*           │                  ├───SetValid───────▶                  │
*           │                  │                  ├─────SetValid─────▶
*           │                  │                  │                  ├──────┐
*           │                  │                  │                  │ SetChanged
*           │                  │                  │                  │   (true)
*           │                  │                  │                  ◀──────┘
*           │                  │                  ◀──────Done────────┤
*           │                  ◀─────Done─────────┤                  │
*           ◀───────Done───────┤                  │                  │
*           ▼                  ▼                  ▼                  ▼
*
*

Constructor & Destructor Documentation

◆ Processor()

inviwo::Processor::Processor	(	const std::string &	identifier = `""`,
		const std::string &	displayName = `""`
	)

Processor constructor, takes two optional arguments.

Parameters

identifier	Should only contain alpha numeric characters, "-", "_" and " ".
displayName	Name of processor, arbitrary string. If the parameters are not set, the processor factory will initiate the identifier and displayName with the ProcessorInfo displayName.

Member Function Documentation

◆ addInteractionHandler()

void inviwo::Processor::addInteractionHandler ( InteractionHandler * interactionHandler )

Adds the interaction handler such that it receives events propagated to the processor. Will not add the interaction handler if it has been added before.

Note: The processor will not take ownership of the interaction handler.

See also: InteractionHandler

Parameters

interactionHandler Interaction handler to be added.

◆ addPort() [1/3]

template<typename T , typename std::enable_if_t< std::is_base_of< Outport, T >::value, int > >

T & inviwo::Processor::addPort	(	std::unique_ptr< T >	port,
		const std::string &	portGroup = `"default"`
	)

Add port to processor and pass ownership to processor.

Note: Port group is a concept for event propagation. Currently only used for ResizeEvents, which only propagate from outports to inports in the same port group

Parameters

port	to add
portGroup	name of group to propagate events through (defaults to "default")

◆ addPort() [2/3]

template<typename T , typename std::enable_if_t< std::is_base_of< Outport, T >::value, int > = 0>

T& inviwo::Processor::addPort	(	std::unique_ptr< T >	port,
		const std::string &	portGroup = `"default"`
	)

Add port to processor and pass ownership to processor.

Note: Port group is a concept for event propagation. Currently only used for ResizeEvents, which only propagate from outports to inports in the same port group

Parameters

port	to add
portGroup	name of group to propagate events through (defaults to "default")

◆ addPort() [3/3]

template<typename T >

T & inviwo::Processor::addPort	(	T &	port,
		const std::string &	portGroup = `"default"`
	)

Add port to processor.

Note: Port group is a concept for event propagation. Currently only used for ResizeEvents, which only propagate from outports to inports in the same port group

Parameters

port	to add
portGroup	name of group to propagate events through (defaults to "default")

◆ addPortToGroup()

void inviwo::Processor::addPortToGroup	(	Port *	port,
		const std::string &	portGroup
	)

protected

Overwrites current port group, if any.

Note: Port group will be overwritten by addPort.

See also: addPort

◆ allInportsAreReady()

bool inviwo::Processor::allInportsAreReady ( ) const

The default function for checking whether all inports are ready. Will return true if all non optional inports are ready.

◆ doIfNotReady()

virtual void inviwo::Processor::doIfNotReady ( )

inlinevirtual

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

See also: ProcessorNetworkEvaluator

Reimplemented in inviwo::CanvasProcessor.

◆ getPortGroup()

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

Concept for event propagation. Currently only used for ResizeEvents, which only propagate from outports to inports in the same port group

◆ initializeResources()

virtual void inviwo::Processor::initializeResources ( )

inlinevirtual

InitializeResources is called whenever a property with InvalidationLevel::InvalidResources is changes.

Reimplemented in inviwo::ImageOverlayGL, inviwo::ImageMixer, inviwo::VolumeSliceGL, inviwo::PythonScriptProcessor, inviwo::CameraWidget, inviwo::HeightFieldProcessor, inviwo::MeshRenderProcessorGL, inviwo::SphereRenderer, inviwo::LineRenderer, inviwo::StreamParticles, inviwo::SplitImage, inviwo::VolumeRaycaster, inviwo::AxisAlignedCutPlane, inviwo::CropWidget, inviwo::CubeRenderer, inviwo::VolumeBinary, inviwo::SSAO, inviwo::LightingRaycaster, inviwo::Background, inviwo::MultichannelRaycaster, inviwo::VolumeGradientProcessor, inviwo::ISORaycaster, inviwo::ImageResample, inviwo::VolumeLowPass, inviwo::FXAA, inviwo::Tonemapping, inviwo::Jacobian2D, inviwo::ABufferGeometryGLProcessor, inviwo::VolumeSequenceToDataFrame, inviwo::ImageGLProcessor, inviwo::TubeRendering, inviwo::TMIP, inviwo::VectorFieldGenerator2D, inviwo::VectorFieldGenerator3D, inviwo::VectorFieldGenerator4D, and inviwo::VolumeShader.

◆ invalidate()

void inviwo::Processor::invalidate	(	InvalidationLevel	invalidationLevel,
		Property *	modifiedProperty = `nullptr`
	)

overridevirtual

Triggers invalidation. Perform only full reimplementation of this function, meaning never call Proccessor::invalidate() in your reimplemented invalidation function. The general scheme is that the processor will invalidate is self and it's outports the outports will in turn invalidate their connected inports, which will invalidate their processors. Hence all processors that depend on this one in the network will be invalidated.

Reimplemented from inviwo::PropertyOwner.

Reimplemented in inviwo::LayerDistanceTransformRAM, inviwo::DistanceTransformRAM, inviwo::SurfaceExtraction, inviwo::VolumeSubsample, and inviwo::VolumeLaplacianProcessor.

◆ isReady()

bool inviwo::Processor::isReady ( ) const

Returns whether the processor is ready to be processed. By default this will call allInportsAreReady. This behavior can be customized by setting the isReady_ update functor.

See also: StateCoordinator; allInportsAreReady

◆ isSink()

bool inviwo::Processor::isSink ( ) const

Returns whether the processor is a sink. I.e. whether it pulls data from the network. By default a processor is a sink if it has no outports. This behavior can be customized by setting the isSink_ update functor. For a processor to be evaluated there have to be a sink among its descendants.

See also: StateCoordinator

◆ isSource()

bool inviwo::Processor::isSource ( ) const

Returns whether the processor is a source. I.e. whether it brings data into the network. By default a processor is a source if it has no inports. This behavior can be customized by setting the isSource_ update functor.

See also: StateCoordinator

◆ process()

virtual void inviwo::Processor::process ( )

inlinevirtual

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 in inviwo::PointLightSourceProcessor, inviwo::ImageOverlayGL, inviwo::VolumeSliceGL, inviwo::WebBrowserProcessor, inviwo::CompositeProcessor, inviwo::ImageMixer, inviwo::PythonScriptProcessor, inviwo::DataSource< DataType, PortType >, inviwo::DataSource< DataFrame, DataOutport< DataFrame > >, inviwo::DataSource< Mesh, MeshOutport >, inviwo::NoiseProcessor, inviwo::CameraWidget, inviwo::ImageLayoutGL, inviwo::LayerDistanceTransformRAM, inviwo::HeightFieldProcessor, inviwo::DistanceTransformRAM, inviwo::HeightFieldMapper, inviwo::WorldTransform< T >, inviwo::MeshRenderProcessorGL, inviwo::IntegralLineVectorToMesh, inviwo::hdf5::HDF5ToVolume, inviwo::VolumeRaycaster, inviwo::glui::GLUIProcessor, inviwo::plot::ParallelCoordinates, inviwo::MeshCreator, inviwo::VolumeSequenceSingleTimestepSamplerProcessor, inviwo::SphereRenderer, inviwo::plot::ColorScaleLegend, inviwo::StreamParticles, inviwo::TextOverlayGL, inviwo::LineRenderer, inviwo::SimpleRaycaster, inviwo::BasisTransform< T >, inviwo::VolumeCombiner, inviwo::GLUITestProcessor, inviwo::MeshClipping, inviwo::MeshPicking, inviwo::plot::VolumeAxis, inviwo::AxisAlignedCutPlane, inviwo::ImageStackVolumeSource, inviwo::VolumeSequenceSource, inviwo::DrawLines, inviwo::DrawPoints, inviwo::LightingRaycaster, inviwo::CropWidget, inviwo::SurfaceExtraction, inviwo::CubeRenderer, inviwo::ISORaycaster, inviwo::CompositeSink< InportType, OutportType >, inviwo::CompositeSource< InportType, OutportType >, inviwo::SSAO, inviwo::SplitImage, inviwo::plot::ImagePlotProcessor, inviwo::LightVolumeGL, inviwo::EigenNormalize, inviwo::Background, inviwo::MultichannelRaycaster, inviwo::BufferToMeshProcessor, inviwo::PixelToBufferProcessor, inviwo::SpotLightSourceProcessor, inviwo::TFSelector, inviwo::VolumeSlice, inviwo::PresentationProcessor, inviwo::PointRenderer, inviwo::Fog, inviwo::ImageChannelCombine, inviwo::ImageLowPass, inviwo::plot::PersistenceDiagramPlotProcessor, inviwo::DiffuseLightSourceProcessor, inviwo::DirectionalLightSourceProcessor, inviwo::plot::ScatterPlotMatrixProcessor, inviwo::NumpyMandelbrot, inviwo::InputSelector< Inport, Outport >, inviwo::OrientationIndicator, inviwo::VolumeToDataFrame, inviwo::HdrBloom, inviwo::CubeProxyGeometry, inviwo::ImageSourceSeries, inviwo::MeshMapping, inviwo::VolumeSource, inviwo::VolumeSubsample, inviwo::EntryExitPoints, inviwo::VolumeSubset, inviwo::ImageScaling, inviwo::ImageToDataFrame, inviwo::FXAA, inviwo::PixelValue, inviwo::GeometryEntryExitPoints, inviwo::EigenMix, inviwo::hdf5::PathSelection, inviwo::ImageSource, inviwo::VolumeCreator, inviwo::plot::DataFrameColumnToColorVector, inviwo::FirstIvwProcessor, inviwo::ImageLayer, inviwo::ABufferGeometryGLProcessor, inviwo::VolumeInformation, inviwo::DataFrameExporter, inviwo::VolumeSequenceToDataFrame, inviwo::ConvexHull2DProcessor, inviwo::ImageContourProcessor, inviwo::VolumeBoundingBox, inviwo::ExampleProgressBar, inviwo::hdf5::Source, inviwo::plot::AxisRenderProcessor, inviwo::RandomSphereGenerator, inviwo::VolumeLaplacianProcessor, inviwo::VolumeSequenceToSpatial4DSampler, inviwo::plot::ScatterPlotProcessor, inviwo::StereoCameraSyncer, inviwo::CSVSource, inviwo::ExampleProcessor, inviwo::NumPyVolume, inviwo::CameraFrustum, inviwo::ImageSnapshot, inviwo::SingleVoxel, inviwo::VolumeToSpatialSampler, inviwo::ImageCompositeProcessorGL, inviwo::ImageGLProcessor, inviwo::RedGreenProcessor, inviwo::VolumeGLProcessor, inviwo::BrushingAndLinkingProcessor, inviwo::ImageToSpatialSampler, inviwo::NumPyMeshCreateTest, inviwo::PathLinesDeprecated, inviwo::CanvasProcessor, inviwo::VolumeCurlCPUProcessor, inviwo::VolumeGradientCPUProcessor, inviwo::SyntheticDataFrame, inviwo::StreamRibbonsDeprecated, inviwo::ImageInformation, inviwo::MeshConverterProcessor, inviwo::MeshInformation, inviwo::SeedPointGenerator, inviwo::DataExport< DataType, PortType >, inviwo::TubeRendering, inviwo::VectorFieldGenerator2D, inviwo::VectorFieldGenerator3D, inviwo::DataExport< Volume, VolumeInport >, inviwo::DataExport< Mesh, MeshInport >, inviwo::DataExport< Layer, ImageInport >, inviwo::TrianglesToWireframe, inviwo::VectorElementSelectorProcessor< T, OutportType >, inviwo::HedgeHog2D, inviwo::VectorElementSelectorProcessor< Volume >, inviwo::VectorElementSelectorProcessor< Image, ImageOutport >, inviwo::VectorElementSelectorProcessor< Mesh, MeshOutport >, inviwo::IntegralLineTracerProcessor< Tracer >, inviwo::TMIP, inviwo::SeedPointsFromMask, inviwo::NoiseVolumeProcessor, inviwo::RandomMeshGenerator, inviwo::SeedPointGenerator2D, inviwo::LorenzSystem, inviwo::Mesh2DRenderProcessorGL, inviwo::DepthDarkening, inviwo::RBFVectorFieldGenerator2D, inviwo::VectorFieldGenerator4D, inviwo::RBFVectorFieldGenerator3D, inviwo::LIC2D, inviwo::TestMatrix, inviwo::SeedsFromMaskSequence, inviwo::Vector2DCurl, inviwo::Vector2DDivergence, inviwo::Vector2DMagnitude, inviwo::EigenMatrixToImage, inviwo::Seed3Dto4D, inviwo::VolumeDivergenceCPUProcessor, inviwo::DiscardShortLines, and inviwo::StreamLinesDeprecated.

◆ removeInteractionHandler()

void inviwo::Processor::removeInteractionHandler ( InteractionHandler * interactionHandler )

Remove the interaction handler such that events are not propagated. The interaction handler will not be deleted by the processor.

Parameters

interactionHandler Interaction handler to be removed.

◆ removePortFromGroups()

void inviwo::Processor::removePortFromGroups ( Port * port )

protected

Removes port from its group, even if it is the default one.

See also: addPort

◆ setDisplayName()

void inviwo::Processor::setDisplayName ( const std::string & displayName )

Name of processor, arbitrary string. By default initialized to the ProcessorInfo displayName. This name will be shown on various graphical representations.

◆ setIdentifier()

void inviwo::Processor::setIdentifier ( const std::string & identifier )

Sets the identifier of the Processor. Processor identifiers should only contain alpha numeric characters, "-", "_" and " ". If there already exist a processor with that identifier or if the identifier is invalid an Exception will be thrown. By default initialized to the ProcessorInfo displayName. When adding the processor to a network the network will use util::findUniqueIdentifier to modify the identifier if it is already used in the network.

See also: ProcessorNetwork; util::findUniqueIdentifier

◆ setValid()

void inviwo::Processor::setValid ( )

overridevirtual

Called by the network after Processor::process has been called. This will set the following to valid

The processor
All properties
All outports and their connected inports. It will also set its inports "changed" to false.

Reimplemented from inviwo::PropertyOwner.

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

processor.h
processor.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Processor()

Member Function Documentation

◆ addInteractionHandler()

◆ addPort() [1/3]

◆ addPort() [2/3]

◆ addPort() [3/3]

◆ addPortToGroup()

◆ allInportsAreReady()

◆ doIfNotReady()

◆ getPortGroup()

◆ initializeResources()

◆ invalidate()

◆ isReady()

◆ isSink()

◆ isSource()

◆ process()

◆ removeInteractionHandler()

◆ removePortFromGroups()

◆ setDisplayName()

◆ setIdentifier()

◆ setValid()