#include <inviwo/core/ports/imageport.h>

Inheritance diagram for inviwo::BaseImageInport< N >:

Public Member Functions
	BaseImageInport (std::string_view identifier, bool outportDeterminesSize)
	BaseImageInport (std::string_view identifier, Document help={}, OutportDeterminesSize value=OutportDeterminesSize::No)
virtual std::string_view	getClassIdentifier () const override
virtual std::shared_ptr< const Image >	getData () const override
virtual Document	getInfo () const override
virtual std::vector< std::pair< Outport *, std::shared_ptr< const Image > > >	getSourceVectorData () const override
virtual std::vector< std::shared_ptr< const Image > >	getVectorData () const override
bool	hasData () const override
virtual bool	isOutportDeterminingSize () const override
void	passOnDataToOutport (ImageOutport *outport) const
virtual void	setOutportDeterminesSize (bool outportDeterminesSize) override
void	setOutportDeterminesSize (OutportDeterminesSize outportDeterminesSize)
Public Member Functions inherited from inviwo::DataInport< Image, 1 >
virtual bool	canConnectTo (const Port *port) const override
virtual void	connectTo (Outport *port) override
	DataInport (std::string_view identifier, Document help={})
virtual uvec3	getColorCode () const override
virtual size_t	getMaxNumberOfConnections () const override
virtual bool	isConnected () const override
Public Member Functions inherited from inviwo::Inport
virtual void	disconnectFrom (Outport *outport)
virtual const std::vector< const Outport * > &	getChangedOutports () const
virtual Outport *	getConnectedOutport () const
virtual const std::vector< Outport * > &	getConnectedOutports () const
virtual size_t	getNumberOfConnections () const
virtual bool	isChanged () const
virtual bool	isConnectedTo (const Outport *outport) const
bool	isOptional () const
virtual bool	isReady () const override
const BaseCallBack *	onChange (std::function< void()> lambda)
std::shared_ptr< std::function< void()> >	onChangeScoped (std::function< void()> lambda)
const BaseCallBack *	onConnect (std::function< void()> lambda)
std::shared_ptr< std::function< void()> >	onConnectScoped (std::function< void()> lambda)
std::shared_ptr< std::function< void(Outport *)> >	onConnectScoped (std::function< void(Outport *)> lambda)
const BaseCallBack *	onDisconnect (std::function< void()> lambda)
std::shared_ptr< std::function< void()> >	onDisconnectScoped (std::function< void()> lambda)
std::shared_ptr< std::function< void(Outport *)> >	onDisconnectScoped (std::function< void(Outport *)> lambda)
const BaseCallBack *	onInvalid (std::function< void()> lambda)
std::shared_ptr< std::function< void()> >	onInvalidScoped (std::function< void()> lambda)
virtual void	propagateEvent (Event event, Outport target=nullptr)
void	readyUpdate ()
void	removeOnChange (const BaseCallBack *callback)
void	removeOnConnect (const BaseCallBack *callback)
void	removeOnDisconnect (const BaseCallBack *callback)
void	removeOnInvalid (const BaseCallBack *callback)
void	setIsReadyUpdater (std::function< bool()> updater)
void	setOptional (bool optional)
Public Member Functions inherited from inviwo::Port
virtual void	deserialize (Deserializer &d) override
Document &	getHelp ()
const Document &	getHelp () const
const std::string &	getIdentifier () const
std::string	getPath () const
	Get the port path i.e. <processor identifier>.<port identifier>.
void	getPath (std::pmr::string &out) const
Processor *	getProcessor () const
Port &	operator= (const Port &)=delete
Port &	operator= (Port &&)=delete
	Port (const Port &)=delete
	Port (Port &&)=delete
virtual void	serialize (Serializer &s) const override
Port &	setHelp (Document help)
void	setIdentifier (const std::string &name)
Public Member Functions inherited from inviwo::InportIterable< DataInport< Image, N, false >, Image, false >
const_iterator	begin () const
util::iter_range< const_iterator_changed >	changedAndData () const
const_iterator	end () const
util::iter_range< const_iterator_port >	outportAndData () const

Additional Inherited Members
Public Types inherited from inviwo::DataInport< Image, 1 >
using	type
using	value_type
Static Public Attributes inherited from inviwo::DataInport< Image, 1 >
static constexpr bool	flattenData
static constexpr size_t	maxConnections
Protected Member Functions inherited from inviwo::Inport
void	callOnChangeIfChanged () const
bool	circularConnection (const Port *port) const
	Inport (std::string_view identifier, Document help)
virtual void	invalidate (InvalidationLevel invalidationLevel)
virtual void	setChanged (bool changed=true, const Outport *source=nullptr)
virtual void	setValid (const Outport *source)
Protected Member Functions inherited from inviwo::Port
	Port (std::string_view identifier, Document help)
void	setProcessor (Processor *processor)
Static Protected Member Functions inherited from inviwo::Inport
static Document	getDefaultPortInfo (const Inport *port, std::string_view portname)
Protected Attributes inherited from inviwo::Inport
std::vector< Outport * >	connectedOutports_
StateCoordinator< bool >	isOptional_
StateCoordinator< bool >	isReady_
Protected Attributes inherited from inviwo::Port
Document	help_
std::string	identifier_
Processor *	processor_

Detailed Description

template<size_t N = 1>
class inviwo::BaseImageInport< N >

BaseImageInport extends DataInport<Image> with extra functionality for handing ResizeEvents. The following table explains the behaviors:

*                                                 ImageOutport
*                                           isHandlingResizeEvents()
*
*                               True (default)                          False
*                    ┌──────────────────────────────────┬──────────────────────────────────┐
*                    │ Outport::Size = max(Inports      │ Outport::Size = Outport::size    │
*                    │ requested sizes)                 │ (no resize of data)              │
*                    │ (resize the data in the outport  │                                  │
*             False  │ if needed)                       │                                  │
*           (default)│                                  │                                  │
*                    │ Inport::Size = Inport requested  │ Inport::Size = Inport requested  │
*                    │ size                             │ size                             │
*  ImageInport       │ (return a resized copy if        │ (return a resized copy if        │
*                    │ needed)                          │ needed)                          │
*   isOutport-       │                                  │                                  │
*  Determining-      ├──────────────────────────────────┼──────────────────────────────────┤
*     Size()         │ Outport::Size = max(all inports  │ Outport::Size = Outport::Size    │
*                    │ requested sizes)                 │ (no resize of data)              │
*                    │ (resize the data in the outport  │                                  │
*              True  │ if needed)                       │                                  │
*                    │                                  │                                  │
*                    │ Inport::Size = Outport::size     │ Inport::Size = Outport::size     │
*                    │ (no copy)                        │ (no copy)                        │
*                    │                                  │                                  │
*                    │                                  │                                  │
*                    └──────────────────────────────────┴──────────────────────────────────┘
*

See also: ImageOutport; ResizeEvent

Member Function Documentation

◆ getClassIdentifier()

template<size_t N>

std::string_view inviwo::BaseImageInport< N >::getClassIdentifier ( ) const

overridevirtual

Reimplemented from inviwo::DataInport< Image, 1 >.

◆ getData()

template<size_t N>

std::shared_ptr< const Image > inviwo::BaseImageInport< N >::getData ( ) const

overridevirtual

Reimplemented from inviwo::DataInport< Image, 1 >.

◆ getInfo()

template<size_t N>

Document inviwo::BaseImageInport< N >::getInfo ( ) const

overridevirtual

This function should describe the state of the port and the data it holds. Derived ports should extend this function and add information about their state. The port help is usually included in this information. The description is usually shown as a tooltip in the GUI.

Reimplemented from inviwo::DataInport< Image, 1 >.

◆ getSourceVectorData()

template<size_t N>

std::vector< std::pair< Outport *, std::shared_ptr< const Image > > > inviwo::BaseImageInport< N >::getSourceVectorData ( ) const

overridevirtual

Reimplemented from inviwo::DataInport< Image, 1 >.

◆ getVectorData()

template<size_t N>

std::vector< std::shared_ptr< const Image > > inviwo::BaseImageInport< N >::getVectorData ( ) const

overridevirtual

Reimplemented from inviwo::DataInport< Image, 1 >.

◆ hasData()

template<size_t N>

bool inviwo::BaseImageInport< N >::hasData ( ) const

overridevirtual

Reimplemented from inviwo::DataInport< Image, 1 >.

◆ isOutportDeterminingSize()

template<size_t N>

bool inviwo::BaseImageInport< N >::isOutportDeterminingSize ( ) const

overridevirtual

Implements inviwo::ImagePortBase.

◆ setOutportDeterminesSize()

template<size_t N>

void inviwo::BaseImageInport< N >::setOutportDeterminesSize ( bool outportDeterminesSize )

overridevirtual

Implements inviwo::ImagePortBase.

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

include/inviwo/core/ports/imageport.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getClassIdentifier()

◆ getData()

◆ getInfo()

◆ getSourceVectorData()

◆ getVectorData()

◆ hasData()

◆ isOutportDeterminingSize()

◆ setOutportDeterminesSize()