Package nukescripts :: Module flipbooking
[hide private]
[frames] | no frames]

Module flipbooking

source code

Classes [hide private]
  FlipbookApplication
An interface, for so far as Python supports it.
  FlipbookFactory
  FlipbookLUTPathRegistry
A registery of all LUT files against LUTs for each specific flipbook.
Functions [hide private]
 
register(flipbookApplication)
Register a flipbook.
source code
 
registerLUTPath(flipbookApplication, lut, path)
Register a LUT for a specific flipbook.
source code
 
getLUTPath(flipbookAppliction, lut)
Returns a path to a LUT file for the given flipbook.
source code
Variables [hide private]
  gFlipbookFactory = FlipbookFactory()
  gFlipbookLUTPathRegistry = FlipbookLUTPathRegistry()
  __package__ = 'nukescripts'
Function Details [hide private]

register(flipbookApplication)

source code 

Register a flipbook. Convenience function that simple calls register() on the FlipbookFactory.

registerLUTPath(flipbookApplication, lut, path)

source code 

Register a LUT for a specific flipbook. The path should refer to a file that contains the LUT for the given flipbook identified by the name in flipbookApplication. It is up to the flipbook subimplementation to actually use this file and the format may vary.

Parameters:
  • flipbook - The unique name of the flipbook
  • lut - The unique name for the LUT, e.g. 'sRGB' and 'rec709'
  • path - Location of the flipbook specific file.

getLUTPath(flipbookAppliction, lut)

source code 

Returns a path to a LUT file for the given flipbook. The contents of the file will be different for each flipbook application. Please see the relevant documentation for the specific flipbook applications.

Parameters:
  • flipbook - The unique name of the flipbook
  • lut - The unique name for the LUT, e.g. 'sRGB' and 'rec709'