Package autodesk_toxik :: Module admin :: Class Project

Class Project

 object --+        
          |        
Boost.Python.instance --+    
              |    
  Administrable --+
                  |
                 Project

The Project class provides additional methods to access its preferences.

Instance Methods

addRenderAction(...)
Adds a render action.

str

getCompVersionNameTemplate(...)
Returns: The string containing tokens used to name new versions.

str

getCtlModulePath(...)
Returns: The search path (str) used by the CTL interpreter to import a module.

str

getProjectHomeFolderPath(...)
Returns: Returns the Project Home Folder value from the preferences.

bool

getRenderActionCleanFolderEnabled(...)
Gets the value of the "Clean Render Folder" flag for the specified render action.

str

getRenderActionCommand(...)
Returns: The command for a background render under the specified render action.

[str]

getRenderActions(...)
Returns: The list of render actions (str) defined in the project.

str

getRenderFileFormat(...)
Returns: The default file format (str) for new compositions.

str

getRenderFileFormatOptions(...)
Returns: The default file format options (in the form of an XML string) for new compositoins.

str

getRenderFileName(...)
Returns: The default rendered file name pattern (str) for new compositions.

str

getRenderFolder(...)
Returns: The root destination directory for image files.

bool

getRenderWiretapEnabled(...)
Returns: Boolean indicating whether export to wiretap is enabled for new compositions.

getRenderWiretapPath(...)
Gets the default wiretap path rendered files are exported to for new compositions.

bool

hasRenderAction(...)
Returns: True if the given render action exists in the project.

removeRenderAction(...)
Removes a render action.

renameRenderAction(...)
Renames a render action.

setCompVersionNameTemplate(...)
Sets a string containing tokens used to name new versions.

setCtlModulePath(...)
Sets the search path used by the CTL interpreter to import a module.

setProjectHomeFolderPath(...)
Sets the Project Home Folder.

setRenderActionCleanFolderEnabled(...)
Sets the "Clean Render Folder" flag of the specified render action.

setRenderActionCommand(...)
Sets the command for a background render under the specified render action.

setRenderFileFormat(...)
Sets the default file format that is set into new compositions.

setRenderFileFormatOptions(...)
Sets the default file format options (in the form of an XML string) for new compositions.

setRenderFileName(...)
Sets the default rendered file name pattern for new compositions

setRenderFolder(...)
Sets the folder that is normally used for the root of all renders.

setRenderWiretapEnabled(...)
Sets whether export to wiretap is enabled by default for new compositions.

setRenderWiretapPath(...)
Sets the default wiretap path to export the rendered files to for new compositions

Inherited from Administrable: __init__, __reduce__, getDescription, getFolder, getFullName, getGroups, getName, getPath, getSetting, getSettings, save, setAsCurrent, setDescription, setSetting

Inherited from Boost.Python.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

addRenderAction(...)

Adds a render action. The given render action name must not already exist in the project.

Parameters:

renderAction (str)

getCompVersionNameTemplate(...)

Returns: str: The string containing tokens used to name new versions.

getCtlModulePath(...)

Returns: str: The search path (str) used by the CTL interpreter to import a module.

getProjectHomeFolderPath(...)

Returns: str: Returns the Project Home Folder value from the preferences. It is used as a default location for some operation like creating a composition given a path that is not absolute. When the Project Home Folder is not defined (i.e. was not set with setProjectHomeFolderPath() )

getRenderActionCleanFolderEnabled(...)

Gets the value of the "Clean Render Folder" flag for the specified render action.

Parameters:

renderAction (str) - Name of the render action to query.

Returns: bool

Boolean indicating whether the render folder gets cleaned or not.

getRenderActionCommand(...)

Parameters:

renderAction (str)

Returns: str

The command for a background render under the specified render action.

getRenderActions(...)

Returns: [str]: The list of render actions (str) defined in the project.

getRenderFileFormat(...)

Returns: str: The default file format (str) for new compositions.

getRenderFileFormatOptions(...)

Returns: str: The default file format options (in the form of an XML string) for new compositoins.

getRenderFileName(...)

Returns: str: The default rendered file name pattern (str) for new compositions.

getRenderFolder(...)

Returns: str: The root destination directory for image files.

getRenderWiretapEnabled(...)

Returns: bool: Boolean indicating whether export to wiretap is enabled for new compositions.

hasRenderAction(...)

Parameters:

renderAction (str)

Returns: bool

True if the given render action exists in the project.

removeRenderAction(...)

Removes a render action.

Parameters:

renderAction (str)

renameRenderAction(...)

Renames a render action.

Parameters:

oldName (str)
newName (str)

setCompVersionNameTemplate(...)

Sets a string containing tokens used to name new versions.

Parameters:

versionNameTemplate (str)

setCtlModulePath(...)

Sets the search path used by the CTL interpreter to import a module.

Parameters:

path (str)

setProjectHomeFolderPath(...)

Sets the Project Home Folder.

Parameters:

path (str)

See Also: getProjectHomeFolderPath

setRenderActionCleanFolderEnabled(...)

Sets the "Clean Render Folder" flag of the specified render action.

Parameters:

cleanRenderFolderEnabled (bool) - Boolean indicating whether to clean the render folder or not.
renderAction (str) - Name of the render action to edit.

setRenderActionCommand(...)

Sets the command for a background render under the specified render action.

Parameters:

cmd (str) - Render command.
renderAction (str)

setRenderFileFormat(...)

Sets the default file format that is set into new compositions.

Parameters:

fileFormat (str)

setRenderFileFormatOptions(...)

Sets the default file format options (in the form of an XML string) for new compositions.

Parameters:

fileFormatOptions (str)

setRenderFileName(...)

Sets the default rendered file name pattern for new compositions

Parameters:

fileName (str)

setRenderFolder(...)

Sets the folder that is normally used for the root of all renders.

Parameters:

destFolder (str) - Destination directory.

setRenderWiretapEnabled(...)

Sets whether export to wiretap is enabled by default for new compositions.

Parameters:

enabled (bool)

setRenderWiretapPath(...)

Sets the default wiretap path to export the rendered files to for new compositions

Parameters:

path (str)