ufe 5.3
Universal Front End is a DCC-agnostic component that will allow a DCC to browse and edit data in multiple data models
|
Factory base class for connection interface. More...
#include <connectionHandler.h>
Public Types | |
typedef std::shared_ptr< ConnectionHandler > | Ptr |
Public Member Functions | |
ConnectionHandler () | |
Constructor. More... | |
ConnectionHandler (const ConnectionHandler &)=default | |
Default copy constructor. More... | |
virtual | ~ConnectionHandler () |
Destructor. More... | |
virtual Connections::Ptr | sourceConnections (const SceneItem::Ptr &item) const =0 |
Get the source Connections on the given SceneItem. More... | |
Connection::Ptr | connect (const AttributeInfo &srcInfo, const AttributeInfo &dstInfo) const |
Connection::Ptr | connect (const Attribute::Ptr &srcAttr, const Attribute::Ptr &dstAttr) const |
void | disconnect (const AttributeInfo &srcInfo, const AttributeInfo &dstInfo) const |
void | disconnect (const Attribute::Ptr &srcAttr, const Attribute::Ptr &dstAttr) const |
virtual std::shared_ptr< ConnectionResultUndoableCommand > | createConnectionCmd (const Attribute::Ptr &srcAttr, const Attribute::Ptr &dstAttr) const =0 |
virtual std::shared_ptr< UndoableCommand > | deleteConnectionCmd (const Attribute::Ptr &srcAttr, const Attribute::Ptr &dstAttr) const =0 |
Factory base class for connection interface.
This base class defines an interface that runtimes must implement to manage source connections i.e. list, create and delete.
Definition at line 39 of file connectionHandler.h.
typedef std::shared_ptr<ConnectionHandler> Ufe::ConnectionHandler::Ptr |
Definition at line 42 of file connectionHandler.h.
Ufe::ConnectionHandler::ConnectionHandler | ( | ) |
Constructor.
|
default |
Default copy constructor.
|
virtual |
Destructor.
Connection::Ptr Ufe::ConnectionHandler::connect | ( | const Attribute::Ptr & | srcAttr, |
const Attribute::Ptr & | dstAttr | ||
) | const |
srcAttr | source attribute to be connected. |
dstAttr | destination attribute to be connected. |
Connection::Ptr Ufe::ConnectionHandler::connect | ( | const AttributeInfo & | srcInfo, |
const AttributeInfo & | dstInfo | ||
) | const |
Connects a source attribute to a destination attribute.
srcInfo | source attribute (from AttributeInfo) to be connected. |
dstInfo | destination attribute (from AttributeInfo) to be connected. |
|
pure virtual |
Get the command to connect two attributes. The returned command is not executed.
srcAttr | source attribute to be connected. |
dstAttr | destination attribute to be connected. |
|
pure virtual |
Get the command to disconnect two attributes. The returned command is not executed.
srcAttr | source attribute to be disconnected. |
dstAttr | destination attribute to be disconnected. |
void Ufe::ConnectionHandler::disconnect | ( | const Attribute::Ptr & | srcAttr, |
const Attribute::Ptr & | dstAttr | ||
) | const |
srcAttr | source attribute to be disconnected. |
dstAttr | destination attribute to be disconnected. |
void Ufe::ConnectionHandler::disconnect | ( | const AttributeInfo & | srcInfo, |
const AttributeInfo & | dstInfo | ||
) | const |
Disconnects a source attribute from a destination attribute.
srcInfo | source attribute (from AttributeInfo) to be disconnected. |
dstInfo | destination attribute (from AttributeInfo) to be disconnected. |
|
pure virtual |
Get the source Connections on the given SceneItem.
item | SceneItem to use to retrieve its source Connections. |