Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::BrushingAndLinkingOutport Class Reference

#include <brushingandlinkingports.h>

Inheritance diagram for inviwo::BrushingAndLinkingOutport:

Public Types

using type = void

Public Member Functions

 BrushingAndLinkingOutport (std::string_view identifier, Document help={})
BrushingAndLinkingManagergetManager ()
const BrushingAndLinkingManagergetManager () const
virtual void invalidate (InvalidationLevel invalidationLevel) override
const std::vector< BrushingTargetsInvalidationLevel > & getInvalidationLevels () const
void setInvalidationLevels (std::vector< BrushingTargetsInvalidationLevel > invalidationLevels)
virtual void serialize (Serializer &s) const override
virtual void deserialize (Deserializer &d) override
virtual void setValid () override
virtual bool hasData () const override
virtual void clear () override
virtual glm::uvec3 getColorCode () const override
virtual Document getInfo () const override
virtual std::string_view getClassIdentifier () const override
Public Member Functions inherited from inviwo::Outport
virtual bool isConnected () const override
virtual bool isReady () const override
virtual InvalidationLevel getInvalidationLevel () const
virtual void propagateEvent (Event *event, Inport *source)
bool isConnectedTo (const Inport *port) const
const std::vector< Inport * > & getConnectedInports () const
const BaseCallBack * onConnect (std::function< void()> lambda)
const BaseCallBack * onDisconnect (std::function< void()> lambda)
void removeOnConnect (const BaseCallBack *callback)
void removeOnDisconnect (const BaseCallBack *callback)
Public Member Functions inherited from inviwo::Port
 Port (const Port &)=delete
Portoperator= (const Port &)=delete
 Port (Port &&)=delete
Portoperator= (Port &&)=delete
const std::string & getIdentifier () const
void setIdentifier (const std::string &name)
ProcessorgetProcessor () const
std::string getPath () const
 Get the port path i.e. <processor identifier>.<port identifier>
void getPath (std::pmr::string &out) const
const DocumentgetHelp () const
DocumentgetHelp ()
PortsetHelp (Document help)

Additional Inherited Members

Protected Member Functions inherited from inviwo::Outport
 Outport (std::string_view identifier, Document help)
virtual void connectTo (Inport *port)
virtual void disconnectFrom (Inport *port)
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::Outport
static Document getDefaultPortInfo (const Outport *port, std::string_view portname)
Protected Attributes inherited from inviwo::Outport
StateCoordinator< bool > isReady_
InvalidationLevel invalidationLevel_
std::vector< Inport * > connectedInports_
CallBackList onConnectCallback_
CallBackList onDisconnectCallback_
Protected Attributes inherited from inviwo::Port
std::string identifier_
Processorprocessor_
Document help_

Detailed Description

Enables selection/filtering/highlighting between processors. The BrushingAndLinkingOutport can be connected to several BrushingAndLinkingInports in order to share information.

See also
BrushingAndLinkingManager

Member Function Documentation

◆ clear()

virtual void inviwo::BrushingAndLinkingOutport::clear ( )
inlineoverridevirtual

Clear the outport of any data

Implements inviwo::Outport.

◆ deserialize()

virtual void inviwo::BrushingAndLinkingOutport::deserialize ( Deserializer & d)
overridevirtual

Reimplemented from inviwo::Port.

◆ getClassIdentifier()

virtual std::string_view inviwo::BrushingAndLinkingOutport::getClassIdentifier ( ) const
overridevirtual

Implements inviwo::Port.

◆ getColorCode()

virtual glm::uvec3 inviwo::BrushingAndLinkingOutport::getColorCode ( ) const
inlineoverridevirtual

Returns the RGB color code used to colorize all ports of this type. This color code is for instance used in the NetworkEditor. To distinguish different port types through their color, this method should be overloaded in derived classes.

Implements inviwo::Port.

◆ getInfo()

virtual Document inviwo::BrushingAndLinkingOutport::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.

Implements inviwo::Port.

◆ getInvalidationLevels()

const std::vector< BrushingTargetsInvalidationLevel > & inviwo::BrushingAndLinkingOutport::getInvalidationLevels ( ) const

Returns the types of targets and actions causing the owning processor to invalidate.

◆ hasData()

virtual bool inviwo::BrushingAndLinkingOutport::hasData ( ) const
inlineoverridevirtual

Query if the outport has any data

Implements inviwo::Outport.

◆ invalidate()

virtual void inviwo::BrushingAndLinkingOutport::invalidate ( InvalidationLevel invalidationLevel)
overridevirtual

Overrides the provided invalidationLevel with that of the BrushingAngLinkingManager. Will invalidate its connected inports if any of the BrushingModifications overlap with the modified brushing targets and actions provided by getInvalidationLevels

Parameters
invalidationLevelunused!
Note
Port is set to valid after its processor successfully finished processing.

Reimplemented from inviwo::Outport.

◆ serialize()

virtual void inviwo::BrushingAndLinkingOutport::serialize ( Serializer & s) const
overridevirtual

Reimplemented from inviwo::Port.

◆ setInvalidationLevels()

void inviwo::BrushingAndLinkingOutport::setInvalidationLevels ( std::vector< BrushingTargetsInvalidationLevel > invalidationLevels)

Set the types of brushing targets and actions that should invalidate the owning processor. Enables processors to only handle certain types of filter/selection/highlight actions.

◆ setValid()

virtual void inviwo::BrushingAndLinkingOutport::setValid ( )
overridevirtual

Called by Processor::setValid, will call setValid its connected inports.

Reimplemented from inviwo::Outport.


The documentation for this class was generated from the following file:
  • brushingandlinkingports.h