Package nukescripts :: Package pyQtExamples :: Module flipbookingExample :: Class ExampleRVFlipbook

Class ExampleRVFlipbook

                     object --+    
                              |    
flipbooking.FlipbookApplication --+
                                  |
                                 ExampleRVFlipbook

This is an example implementation of how to deal with implementing a flipbook application other than FrameCycler for Nuke. This script needs to be modified in several places before it can work, so please read all of the notes marked with TODO and modify them where necessary.

Instance Methods

[hide private]

__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

name(self)
Return the name of the flipbook.

source code

path(self)
Return the executable path required to run a flipbook.

source code

cacheDir(self)
Return the preferred directory for rendering.

source code

run(self, filename, frameRanges, views, options)
Execute the flipbook on a path.

source code

capabilities(self)
Return the capabilities of the flipbook application.

source code

Inherited from flipbooking.FlipbookApplication: dialogKnobChanged, dialogKnobs

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

name(self)

source code

Return the name of the flipbook.

Returns:: String
Overrides: flipbooking.FlipbookApplication.name: (inherited documentation)

path(self)

source code

Return the executable path required to run a flipbook.

Returns:: String
Overrides: flipbooking.FlipbookApplication.path: (inherited documentation)

cacheDir(self)

source code

Return the preferred directory for rendering.

Returns:: String
Overrides: flipbooking.FlipbookApplication.cacheDir: (inherited documentation)

run(self, filename, frameRanges, views, options)

source code

Execute the flipbook on a path.

Parameters:

path - The path to run the flipbook on. This will be similar to /path/to/foo%03d.exr
frameRanges - A FrameRanges object representing the range that should be flipbooked. Note that in 6.2v1-2 this was a FrameRange object.
views - A list of strings comprising of the views to flipbook. Willnot be more than the maximum supported by the flipbook.
options - A dictionary of options to use. This may contain the keys pixelAspect, roi, dimensions, audio and lut. These contain a float, a dict with bounding box dimensions, a dict with width and height, a path to audio file and a string indicating the LUT conversion to apply.

Returns:

None

Overrides: flipbooking.FlipbookApplication.run

(inherited documentation)

capabilities(self)

source code

Return the capabilities of the flipbook application. Currently used are: proxyScale: bool, whether the flipbook supports proxies crop: bool, whether the flipbook supports crops canPreLaunch: bool, whether the flipbook can display a frames that are still being rendered by Nuke. maximumViews: int, the number of views supported by this flipbook, should be 1 or higher. fileTypes: list, the extensions of the file types supported by this format. Must all be lowercase, e.g ["exr", "jpg", ...]

Returns:: dict with the capabilities above.
Overrides: flipbooking.FlipbookApplication.capabilities: (inherited documentation)

Class ExampleRVFlipbook

__init__(self) (Constructor)

name(self)

path(self)

cacheDir(self)

run(self, filename, frameRanges, views, options)

capabilities(self)

init(self)
(Constructor)