6.94. sibl_gui.components.addons.loaderScript.loaderScript

loaderScript.py

Platform:
Windows, Linux, Mac Os X.
Description:
This module defines the LoaderScript Component Interface class.

Others:

6.94.1. Module Attributes

sibl_gui.components.addons.loaderScript.loaderScript.LOGGER
sibl_gui.components.addons.loaderScript.loaderScript.COMPONENT_FILE

6.94.2. Classes

class sibl_gui.components.addons.loaderScript.loaderScript.LoaderScript(parent=None, name=None, *args, **kwargs)[source]

Bases: manager.qwidgetComponent.QWidgetComponent

This class is the sibl_gui.components.addons.loaderScript.loaderScript Component Interface class.
It provides the glue between the Ibl Sets, the Templates and the 3d package.

A typical operation is the following:

  • Retrieve both Ibl Set and Template files.
  • Parse Ibl Set and Template files.
  • Retrieve override keys defined by the user and / or another Component.
  • Generate the Loader Script.
  • Write the Loader Script.
  • Establish a connection with the 3d package and trigger the Loader Script execution.
Parameters:
  • parent – Object parent. ( QObject )
  • name – Component name. ( String )
  • *args – Arguments. ( * )
  • **kwargs – Keywords arguments. ( ** )
dockArea[source]

This method is the property for self.__dockArea attribute.

Returns:self.__dockArea. ( Integer )
engine[source]

This method is the property for self.__engine attribute.

Returns:self.__engine. ( QObject )
iblSetsOutliner[source]

This method is the property for self.__iblSetsOutliner attribute.

Returns:self.__iblSetsOutliner. ( QWidget )
templatesOutliner[source]

This method is the property for self.__templatesOutliner attribute.

Returns:self.__templatesOutliner. ( QWidget )
tcpClientUi[source]

This method is the property for self.__tcpClientUi attribute.

Returns:self.__tcpClientUi. ( QWidget )
ioDirectory[source]

This method is the property for self.__ioDirectory attribute.

Returns:self.__ioDirectory. ( String )
bindingIdentifierPattern[source]

This method is the property for self.__bindingIdentifierPattern attribute.

Returns:self.__bindingIdentifierPattern. ( String )
templateScriptSection[source]

This method is the property for self.__templateScriptSection attribute.

Returns:self.__templateScriptSection. ( String )
templateIblSetAttributesSection[source]

This method is the property for self.__templateIblSetAttributesSection attribute.

Returns:self.__templateIblSetAttributesSection. ( String )
templateRemoteConnectionSection[source]

This method is the property for self.__templateRemoteConnectionSection attribute.

Returns:self.__templateRemoteConnectionSection. ( String )
overrideKeys[source]

This method is the property for self.__overrideKeys attribute.

Returns:self.__overrideKeys. ( Dictionary )
defaultStringSeparator[source]

This method is the property for self.__defaultStringSeparator attribute.

Returns:self.__defaultStringSeparator. ( String )
unnamedLightName[source]

This method is the property for self.__unnamedLightName attribute.

Returns:self.__unnamedLightName. ( String )
activate(engine)[source]

This method activates the Component.

Parameters:engine – Engine to attach the Component to. ( QObject )
Returns:Method success. ( Boolean )
deactivate()[source]

This method deactivates the Component.

Returns:Method success. ( Boolean )
initializeUi()[source]

This method initializes the Component ui.

Returns:Method success. ( Boolean )
uninitializeUi()[source]

This method uninitializes the Component ui.

Returns:Method success. ( Boolean )
addWidget()[source]

This method adds the Component Widget to the engine.

Returns:Method success. ( Boolean )
removeWidget()[source]

This method removes the Component Widget from the engine.

Returns:Method success. ( Boolean )
outputLoaderScriptUi()[source]

This method outputs the Loader Script.

Returns:Method success. ( Boolean )
Note :This method may require user interaction.
sendLoaderScriptToSoftwareUi()[source]

This method sends the Loader Script to associated 3d package.

Returns:Method success. ( Boolean )
Note :This method may require user interaction.
outputLoaderScript(template, iblSet)[source]

This method outputs the Loader Script.

Parameters:
  • template – Template. ( Template )
  • iblSet – Ibl Set. ( IblSet )
Returns:

Loader Script file. ( String )

sendLoaderScriptToSoftware(template, loaderScriptPath)[source]

This method sends the Loader Script to associated 3d package.

Parameters:
  • template – Template. ( Template )
  • loaderScriptPath – Loader Script path. ( String )
Returns:

Method success. ( Boolean )

getDefaultOverrideKeys()[source]

This method gets default override keys.

Returns:Override keys. ( Dictionary )
getLoaderScript(template, iblSet, overrideKeys)[source]

This method builds a Loader Script.

Parameters:
  • template – Template path. ( String )
  • iblSet – Ibl Set path. ( String )
  • overrideKeys – Override keys. ( Dictionary )
Returns:

Loader Script. ( List )