Module precompmodule
Defines a wrapper around a precomp module: the PrecompModule class.
A precomp module is a .precomp file or any python module that
implements a specific interface used by the Composite precomp import
script to fetch information about render passes, layers and camera views
from any 3D application.
The Composite precomp import script in fact talks to the wrapper which
takes care of various things:
-
Abstracts whether the precomp information is fetched from an actual
python module or a precomp file.
-
Properly reports errors found in the underlying precomp module.
-
Transparently handles various versions of the precomp module
interface.
-
Converts some precomp module data into Composite specific data (for
example: blend mode values).
-
Documents the expected precomp module interface.
|
|
InvalidPrecompModule
Exception thrown by the PrecompModule wrapper when the given
precomp module doesn't honor the expected interface.
|
|
|
PrecompModuleError
Exception thrown by the PrecompModule wrapper class when an
exception is raised from the actual precomp module.
|
|
|
PrecompModule
Precomp module wrapper.
|
|
|
PrecompObject
Precomp module object wrapper.
|
|
|
Scene
Class representing a 3D scene.
|
|
|
RenderCamera
Class representing a render camera.
|
|
|
RenderLayer
Class representing a render layer, i.e.
|
|
|
RenderPass
Class representing a render pass, i.e.
|
|
|
|
tuple
|
getSignatureAndDoc(frame,
self,
className=None,
funcName=None,
removeSelfArg=False)
Returns:
A tuple with the function/method signature and docstring
of the given frame. |
|
|
|
Decorator that catches any exception and raises a PrecompModuleError exception instead.
- Parameters:
|
getSignatureAndDoc(frame,
self,
className=None,
funcName=None,
removeSelfArg=False)
|
|
- Parameters:
frame (frame object)self - The instance that holds the frame.className (str) - Can be used to override 'self.__class__.__name__' and it can be
set to an empty string to signify no class.funcName (str) - Can be used to override the function name of the given frame.removeSelfArg (bool) - Indicates whether the first arguments should be put in the
returned signature. - Returns:
tuple
- A
tuple with the function/method signature and
docstring of the given frame.
|