Developer Documentation
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
VSI::ElementInOut Class Referenceabstract

#include <Plugin-VSI/scene/elementInOut.hh>

Inheritance diagram for VSI::ElementInOut:
VSI::ElementInput VSI::ElementOutput

Public Types

enum  Type { TypeInput , TypeOutput }
 Type. More...
 

Public Member Functions

 ElementInOut (InOut *_io, SceneElement *_parent)
 Constructor. More...
 
virtual ~ElementInOut ()
 Destructor. More...
 
virtual Type type () const =0
 Type. More...
 
ConnectionPoint * connectionPointItem () const
 Connection point widget. More...
 
Text * typeTextItem () const
 Type text widget. More...
 
Text * descriptionTextItem () const
 Short description widget. More...
 
QList< Connection * > connections () const
 Connections. More...
 
virtual void addConnection (Connection *_conn)
 Add the connection. More...
 
virtual void removeConnection (Connection *_conn)
 Remove the Connection. More...
 
bool validConnection (ElementInOut *_e)
 Can this input/output be connected to _e. More...
 
InOut * inOut () const
 InOut context object. More...
 
SceneElement * element ()
 Scene element. More...
 

Private Member Functions

 ElementInOut (const ElementInOut &_orig)
 Private copy constructor to avoid accidental copy. More...
 

Private Attributes

InOut * io_
 
SceneElement * element_
 
ConnectionPoint * conn_
 
Text * typeText_
 
Text * descText_
 
QList< Connection * > connections_
 

Detailed Description

Base class for inputs and outputs of scene elements. It provides the visible widgets and handles connections

Definition at line 69 of file elementInOut.hh.

Member Enumeration Documentation

◆ Type

enum VSI::ElementInOut::Type

Type.

Definition at line 74 of file elementInOut.hh.

Constructor & Destructor Documentation

◆ ElementInOut() [1/2]

VSI::ElementInOut::ElementInOut ( InOut *  _io,
SceneElement *  _parent 
)

Constructor.

Definition at line 68 of file elementInOut.cc.

◆ ~ElementInOut()

VSI::ElementInOut::~ElementInOut ( )
virtual

Destructor.

Definition at line 108 of file elementInOut.cc.

◆ ElementInOut() [2/2]

VSI::ElementInOut::ElementInOut ( const ElementInOut &  _orig)
private

Private copy constructor to avoid accidental copy.

Definition at line 95 of file elementInOut.cc.

Member Function Documentation

◆ addConnection()

void VSI::ElementInOut::addConnection ( Connection *  _conn)
virtual

Add the connection.

Reimplemented in VSI::ElementInput, and VSI::ElementOutput.

Definition at line 156 of file elementInOut.cc.

◆ connectionPointItem()

ConnectionPoint * VSI::ElementInOut::connectionPointItem ( ) const
inline

Connection point widget.

Definition at line 89 of file elementInOut.hh.

◆ connections()

QList< Connection * > VSI::ElementInOut::connections ( ) const
inline

Connections.

Definition at line 98 of file elementInOut.hh.

◆ descriptionTextItem()

Text * VSI::ElementInOut::descriptionTextItem ( ) const
inline

Short description widget.

Definition at line 95 of file elementInOut.hh.

◆ element()

SceneElement * VSI::ElementInOut::element ( )
inline

Scene element.

Definition at line 113 of file elementInOut.hh.

◆ inOut()

InOut * VSI::ElementInOut::inOut ( ) const
inline

InOut context object.

Definition at line 110 of file elementInOut.hh.

◆ removeConnection()

void VSI::ElementInOut::removeConnection ( Connection *  _conn)
virtual

Remove the Connection.

Reimplemented in VSI::ElementInput, and VSI::ElementOutput.

Definition at line 164 of file elementInOut.cc.

◆ type()

virtual Type VSI::ElementInOut::type ( ) const
pure virtual

Type.

Implemented in VSI::ElementInput, and VSI::ElementOutput.

◆ typeTextItem()

Text * VSI::ElementInOut::typeTextItem ( ) const
inline

Type text widget.

Definition at line 92 of file elementInOut.hh.

◆ validConnection()

bool VSI::ElementInOut::validConnection ( ElementInOut *  _e)

Can this input/output be connected to _e.

Definition at line 121 of file elementInOut.cc.

Member Data Documentation

◆ conn_

ConnectionPoint* VSI::ElementInOut::conn_
private

Definition at line 123 of file elementInOut.hh.

◆ connections_

QList<Connection *> VSI::ElementInOut::connections_
private

Definition at line 127 of file elementInOut.hh.

◆ descText_

Text* VSI::ElementInOut::descText_
private

Definition at line 125 of file elementInOut.hh.

◆ element_

SceneElement* VSI::ElementInOut::element_
private

Definition at line 121 of file elementInOut.hh.

◆ io_

InOut* VSI::ElementInOut::io_
private

Definition at line 120 of file elementInOut.hh.

◆ typeText_

Text* VSI::ElementInOut::typeText_
private

Definition at line 124 of file elementInOut.hh.

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