Package autodesk_toxik :: Module precompmodule :: Class PrecompModule

Class PrecompModule

object --+
         |
        PrecompModule

Precomp module wrapper.

Instance Methods

invokePrecompFunction(self, funcName, *args, **kwargs)
Invokes a global function in the precomp module.

__init__(self, precompFilePathOrModule)
Constructor from a precomp file or precomp python module.

str

getAppId(self)
A precomp module error safe way to get the application id (name + version).

str

getAppName(self)
Returns: Application name in unicode.

str

getAppVersionStr(self)
Returns: Application version string in unicode.

int

getAppMajorVersion(self)
Returns: Application major version number as an integer.

int

getAppMinorVersion(self)
Returns: Application minor version number as an integer.

int

getPrecompModuleMajorVersion(self)
Returns: Precomp module major version number as an integer.

int

getPrecompModuleMinorVersion(self)
Returns: Precomp module minor version number as an integer.

str

getDestinationFolder(self)
Returns: A unicode path, absolute or relative to the Composite project, to a folder where all compositions must be created/updated.

Scene

getScene(self)
Returns: A Scene instance representing the 3D scene in this precomp module.

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

Properties
Inherited from `object`: `__class__`

Method Details

invokePrecompFunction(self, funcName, *args, **kwargs)

Invokes a global function in the precomp module.

Decorators:

@reportPrecompError

init(self, precompFilePathOrModule)
(Constructor)

Constructor from a precomp file or precomp python module.

Parameters:

precompFilePathOrModule (str or precomp module) - precomp file path or precomp python module.

Overrides: object.__init__

getAppId(self)

A precomp module error safe way to get the application id (name + version).

Returns: str: The application id. If an error occured, the string "unknown application" is returned.

getAppName(self)

Returns: str: Application name in unicode.

getAppVersionStr(self)

Returns: str: Application version string in unicode.

getAppMajorVersion(self)

Returns: int: Application major version number as an integer.

getAppMinorVersion(self)

Returns: int: Application minor version number as an integer.

getPrecompModuleMajorVersion(self)

Returns: int: Precomp module major version number as an integer.

getPrecompModuleMinorVersion(self)

Returns: int: Precomp module minor version number as an integer.

getDestinationFolder(self)

Returns: str: A unicode path, absolute or relative to the Composite project, to a folder where all compositions must be created/updated.

getScene(self)

Returns: Scene: A Scene instance representing the 3D scene in this precomp module.

Class PrecompModule

invokePrecompFunction(self, funcName, *args, **kwargs)

__init__(self, precompFilePathOrModule) (Constructor)

getAppId(self)

getAppName(self)

getAppVersionStr(self)

getAppMajorVersion(self)

getAppMinorVersion(self)

getPrecompModuleMajorVersion(self)

getPrecompModuleMinorVersion(self)

getDestinationFolder(self)

getScene(self)

init(self, precompFilePathOrModule)
(Constructor)