Inviwo  0.9.10.1
Inviwo documentation
inviwo::BaseImageInport< N > Class Template Reference

#include <imageport.h>

+ Inheritance diagram for inviwo::BaseImageInport< N >:

Public Member Functions

 BaseImageInport (std::string identifier, bool outportDeterminesSize=false)
 
virtual std::string getClassIdentifier () const override
 
virtual std::shared_ptr< const ImagegetData () const override
 
virtual std::vector< std::shared_ptr< const Image > > getVectorData () const override
 
virtual std::vector< std::pair< Outport *, std::shared_ptr< const Image > > > getSourceVectorData () const override
 
virtual bool isOutportDeterminingSize () const override
 
virtual void setOutportDeterminesSize (bool outportDeterminesSize) override
 
void passOnDataToOutport (ImageOutport *outport) const
 
virtual Document getInfo () const override
 
- Public Member Functions inherited from inviwo::DataInport< Image, N >
 DataInport (std::string identifier)
 
virtual uvec3 getColorCode () const override
 
virtual size_t getMaxNumberOfConnections () const override
 
virtual bool canConnectTo (const Port *port) const override
 
virtual void connectTo (Outport *port) override
 
virtual bool isConnected () const override
 
bool hasData () const
 
- Public Member Functions inherited from inviwo::Inport
virtual bool isReady () const override
 
void setOptional (bool optional)
 
bool isOptional () const
 
virtual bool isChanged () const
 
virtual void disconnectFrom (Outport *outport)
 
virtual bool isConnectedTo (const Outport *outport) const
 
virtual OutportgetConnectedOutport () const
 
virtual const std::vector< Outport * > & getConnectedOutports () const
 
virtual size_t getNumberOfConnections () const
 
virtual std::vector< const Outport * > getChangedOutports () const
 
virtual void propagateEvent (Event *event, Outport *target=nullptr)
 
template<typename T >
const BaseCallBack * onChange (T *o, void(T::*m)())
 
const BaseCallBack * onChange (std::function< void()> lambda)
 
template<typename T >
const BaseCallBack * onInvalid (T *o, void(T::*m)())
 
const BaseCallBack * onInvalid (std::function< void()> lambda)
 
const BaseCallBack * onConnect (std::function< void()> lambda)
 
const BaseCallBack * onDisconnect (std::function< void()> lambda)
 
void removeOnChange (const BaseCallBack *callback)
 
template<typename T >
void removeOnChange (T *o)
 
void removeOnInvalid (const BaseCallBack *callback)
 
template<typename T >
void removeOnInvalid (T *o)
 
void removeOnConnect (const BaseCallBack *callback)
 
void removeOnDisconnect (const BaseCallBack *callback)
 
- Public Member Functions inherited from inviwo::Port
std::string getIdentifier () const
 
void setIdentifier (const std::string &name)
 
ProcessorgetProcessor () const
 
virtual void serialize (Serializer &s) const override
 
virtual void deserialize (Deserializer &d) override
 
- Public Member Functions inherited from inviwo::InportIterable< T, Flat >
 InportIterable (std::vector< Outport * > *connections)
 
const_iterator begin () const
 
const_iterator end () const
 

Additional Inherited Members

- Public Types inherited from inviwo::DataInport< Image, N >
using type = Image
 
- Protected Member Functions inherited from inviwo::Inport
 Inport (std::string identifier="")
 
virtual void invalidate (InvalidationLevel invalidationLevel)
 
virtual void setValid (const Outport *source)
 
void readyUpdate ()
 
virtual void setChanged (bool changed=true, const Outport *source=nullptr)
 
void callOnChangeIfChanged () const
 
- Protected Member Functions inherited from inviwo::Port
 Port (std::string identifier="")
 
void setProcessor (Processor *processor)
 
- Protected Attributes inherited from inviwo::Inport
StateCoordinator< bool > isReady_
 
StateCoordinator< bool > isOptional_
 
std::vector< Outport * > connectedOutports_
 
- Protected Attributes inherited from inviwo::Port
std::string identifier_
 
Processorprocessor_
 

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

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