OMH::ExportGifSettings Class Reference

Detailed Description

The GIF export options.

Example:

from ToonBoom import harmony
scene = harmony.session().project.scene
export_handler = harmony.session().project.export_handler
gif_settings = harmony.ExportGifSettings( r"C:/myPath/", 'TheGif', 1, 25, 960, 540, 1, True )
export_handler(scene,gif_settings)

Public Member Functions
	ExportGifSettings (QString i_file_path="", QString i_file_name="", int i_start_frame=1, int i_end_frame=-1, int i_width=-1, int i_height=-1, int i_dith=0, bool i_loop=false)
	The default constructor, with all parameters optional. More...

Public Attributes
QString	file_name
	The file name of the generated animated GIF. More...
int	width
	The horizontal pixel resolution. The width resolution of the scene by default. More...
int	height
	The vertical pixel resolution. The height resolution of the scene by default. More...
int	dith
	The dithering to use. None by default. Dithering Value None 0 Diffusion 1 Pattern 2
bool	loop
	Set the animation to loop. false by default. More...
QString	file_path
	The complete file path to the generated file. More...
int	start_frame
	The first frame to be exported. 1 by default. More...
int	end_frame
	The last frame to be exported. The last frame of the scene by default. More...

Constructor & Destructor Documentation

ExportGifSettings()

OMH::ExportGifSettings::ExportGifSettings	(	QString	i_file_path = "",
		QString	i_file_name = "",
		int	i_start_frame = 1,
		int	i_end_frame = -1,
		int	i_width = -1,
		int	i_height = -1,
		int	i_dith = 0,
		bool	i_loop = false
	)

The default constructor, with all parameters optional.

Member Data Documentation

end_frame

int OMH::ExportSettingsBase::end_frame

inherited

The last frame to be exported. The last frame of the scene by default.

file_name

QString OMH::ExportGifSettings::file_name

The file name of the generated animated GIF.

file_path

QString OMH::ExportSettingsBase::file_path

inherited

The complete file path to the generated file.

height

int OMH::ExportGifSettings::height

The vertical pixel resolution. The height resolution of the scene by default.

loop

bool OMH::ExportGifSettings::loop

Set the animation to loop. false by default.

start_frame

int OMH::ExportSettingsBase::start_frame

inherited

The first frame to be exported. 1 by default.

width

int OMH::ExportGifSettings::width

The horizontal pixel resolution. The width resolution of the scene by default.

Inheritance diagram for OMH::ExportGifSettings:

Collaboration diagram for OMH::ExportGifSettings: