implemented-connections

GroupConnection

class pipeLion.connections.groupConnection.GroupConnection(parent=None, children=None)

GroupConnection will treat generated paths differently, but won’t do anything with the output of their parent-assets

connectToSoftware()

this method needs to be reimplemented for every derivate if AbstractConnection. It should return an object, which is able to connect to the software, this derivate is representing and sending over commands and receiving responses.

Returns:method should return an object, which is already connected to the software. and which can be used for communication with the third party application Return type:variant

disconnectFromSoftware(connection)

this method should disconnect a given connection-object from a third-party application. Method has to be reimplemented for new derivates of AbstractConnection

Parameters:connection (variant) – connection object, which is currently connected to a third party application. type depends on the type returned by the connectToSoftware instancemethod Returns:integer indicating wether the disconnection was successful or not (0 or 1) Return type:integer

fillClose()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be closed

please use the addCloseCmd to append to the list.

fillOpen()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be opened

please use the addOpenCmd to append to the list.

fillRelease()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be released

please use the addReleaseCmd to append to the list.

fillSave()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be saved

please use the addSaveCmd to append to the list.

fillSetup()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be setup

please use the addSetupCmd to append to the list.

fillUpdate()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be updated

please use the addUpdateCmd to append to the list.

sendCommand(connection, command)

Parameters:

• connection (variant) – the object, which is returned by connectToSoftware
• command (string) – the command which should be send to the server

Returns:

integer indicating wether the disconnection was successful or not (0 or 1)

Return type:

integer

MayaToMayaConnection

class pipeLion.connections.mayaToMayaConnection.MayaToMayaConnection(parent=None, children=None)

MayaToMayaConnection is derived from AbstractConnection and defines the way an Assets hands over its data to another asset edited in Maya

connectToSoftware()

this method needs to be reimplemented for every derivate if AbstractConnection. It should return an object, which is able to connect to the software, this derivate is representing and sending over commands and receiving responses.

Returns:method should return an object, which is already connected to the software. and which can be used for communication with the third party application Return type:variant

disconnectFromSoftware(connection)

this method should disconnect a given connection-object from a third-party application. Method has to be reimplemented for new derivates of AbstractConnection

Parameters:connection (variant) – connection object, which is currently connected to a third party application. type depends on the type returned by the connectToSoftware instancemethod Returns:integer indicating wether the disconnection was successful or not (0 or 1) Return type:integer

fillClose()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be closed

please use the addCloseCmd to append to the list.

fillOpen()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be opened

please use the addOpenCmd to append to the list.

fillRelease()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be released

please use the addReleaseCmd to append to the list.

fillSave()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be saved

please use the addSaveCmd to append to the list.

fillSetup()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be setup

please use the addSetupCmd to append to the list.

fillUpdate()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be updated

please use the addUpdateCmd to append to the list.

sendCommand(connection, command)

Parameters:

• connection (variant) – the object, which is returned by connectToSoftware
• command (string) – the command which should be send to the server

Returns:

integer indicating wether the disconnection was successful or not (0 or 1)

Return type:

integer

ProjectConnection

class pipeLion.connections.projectConnection.ProjectConnection(parent=None, children=None)

ProjectConnection is derived from GroupConnection and is therefore special as it is the topmost connection in the tree

fillClose()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be closed

please use the addCloseCmd to append to the list.

fillOpen()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be opened

please use the addOpenCmd to append to the list.

fillRelease()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be released

please use the addReleaseCmd to append to the list.

fillSave()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be saved

please use the addSaveCmd to append to the list.

fillSetup()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be setup

please use the addSetupCmd to append to the list.

fillUpdate()

method has to be reimplemented to generate a list of commands which should be executed in case a scene should be updated

please use the addUpdateCmd to append to the list.