6.101. sibl_gui.components.addons.loaderScript.loaderScript

loaderScript.py

Platform:
Windows, Linux, Mac Os X.
Description:
Defines the LoaderScript Component Interface class.

Others:

6.101.1. Module Attributes

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

6.101.2. Classes

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

Bases: manager.qwidgetComponent.QWidgetComponent

Defines 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.

Initializes the class.

Parameters:
  • parent (QObject) – Object parent.
  • name (unicode) – Component name.
  • *args (*) – Arguments.
  • **kwargs (**) – Keywords arguments.
dockArea[source]

Property for self.__dockArea attribute.

Returns:self.__dockArea.
Return type:int
engine[source]

Property for self.__engine attribute.

Returns:self.__engine.
Return type:QObject
iblSetsOutliner[source]

Property for self.__iblSetsOutliner attribute.

Returns:self.__iblSetsOutliner.
Return type:QWidget
templatesOutliner[source]

Property for self.__templatesOutliner attribute.

Returns:self.__templatesOutliner.
Return type:QWidget
tcpClientUi[source]

Property for self.__tcpClientUi attribute.

Returns:self.__tcpClientUi.
Return type:QWidget
ioDirectory[source]

Property for self.__ioDirectory attribute.

Returns:self.__ioDirectory.
Return type:unicode
bindingIdentifierPattern[source]

Property for self.__bindingIdentifierPattern attribute.

Returns:self.__bindingIdentifierPattern.
Return type:unicode
templateScriptSection[source]

Property for self.__templateScriptSection attribute.

Returns:self.__templateScriptSection.
Return type:unicode
templateIblSetAttributesSection[source]

Property for self.__templateIblSetAttributesSection attribute.

Returns:self.__templateIblSetAttributesSection.
Return type:unicode
templateRemoteConnectionSection[source]

Property for self.__templateRemoteConnectionSection attribute.

Returns:self.__templateRemoteConnectionSection.
Return type:unicode
overrideKeys[source]

Property for self.__overrideKeys attribute.

Returns:self.__overrideKeys.
Return type:dict
defaultStringSeparator[source]

Property for self.__defaultStringSeparator attribute.

Returns:self.__defaultStringSeparator.
Return type:unicode
unnamedLightName[source]

Property for self.__unnamedLightName attribute.

Returns:self.__unnamedLightName.
Return type:unicode
activate(engine)[source]

Activates the Component.

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

Deactivates the Component.

Returns:Method success.
Return type:bool
initializeUi()[source]

Initializes the Component ui.

Returns:Method success.
Return type:bool
uninitializeUi()[source]

Uninitializes the Component ui.

Returns:Method success.
Return type:bool
addWidget()[source]

Adds the Component Widget to the engine.

Returns:Method success.
Return type:bool
removeWidget()[source]

Removes the Component Widget from the engine.

Returns:Method success.
Return type:bool
outputLoaderScriptUi()[source]

Outputs the Loader Script.

Returns:Method success.
Return type:bool
Note:May require user interaction.
sendLoaderScriptToSoftwareUi()[source]

Sends the Loader Script to associated 3d package.

Returns:Method success.
Return type:bool
Note:May require user interaction.
outputLoaderScript(template, iblSet)[source]

Outputs the Loader Script.

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

Loader Script file.

Return type:

unicode

sendLoaderScriptToSoftware(template, loaderScriptPath)[source]

Sends the Loader Script to associated 3d package.

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

Method success.

Return type:

bool

getDefaultOverrideKeys()[source]

Gets default override keys.

Returns:Override keys.
Return type:dict
getLoaderScript(template, iblSet, overrideKeys)[source]

Builds a Loader Script.

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

Loader Script.

Return type:

list