OMH::ImportHandler Class Reference

Detailed Description

Object handler responsible for importing video, images and audio to the project.

The Import Handler can be used to import different media into the project. The media is imported and converted based on the settings provided to the importer.

A target object specifies where to import contents into the project (e.g. OMC::Element, OMC::Scene or OMC::Node ).

Available Import Settings are as follows:

• ImportAudioSettings: Import audio clips to the scene.
  Audio Example

  from ToonBoom import harmony
  scene = harmony.session().project.scene
  import_handler = harmony.session().project.import_handler
  insertion_frame = 5
  audio_settings = harmony.ImportAudioSettings(insertion_frame)
  import_handler(r"C:/myPath/myAudio.wav", scene, audio_settings, "MyLayer")

  
  
• Import3DObjectSettings: Import a 3D object to the scene.
  3D Object Example

  from ToonBoom import harmony
  target = harmony.session().project.scene
  import_handler = harmony.session().project.import_handler
  insertion_frame = 5
  convert_to_fbx = True
  object3d_settings = harmony.Import3DObjectSettings(insertion_frame, convert_to_fbx)
  import_handler(r"C:/myPath/my3DObj.obj", target, object3d_settings, "MyLayer")

  
  
• ImportVectorSettings: Import Vector image to the scene.
  Vectorized Image Example

  from ToonBoom import harmony
  target = harmony.session().project.scene
  import_handler = harmony.session().project.import_handler
  insertion_frame = 5
  vector_settings = harmony.ImportVectorSettings(insertion_frame)
  import_handler(r"C:/myPath/myVectorObj.tvg", target, vector_settings, "MyLayer")

  
  
• ImportRasterSettings: Import an image to the scene.
  Image Example

  from ToonBoom import harmony
  target = harmony.session().project.scene
  import_handler = harmony.session().project.import_handler
  insertion_frame = 5
  image_settings = harmony.ImportRasterSettings(insertion_frame)
  import_handler(r"C:/myPath/myImage.png", target, image_settings, "MyLayer")

  
  
• ImportRasterSettings: Import and vectorize a raster image to the scene.
  Image Example

  from ToonBoom import harmony
  target = harmony.session().project.scene
  import_handler = harmony.session().project.import_handler
  insertion_frame = 5
  vectorization_type = "VECTORIZE"
  colour_space = "sRGB"
  alignment_type = "CENTER_FIT"
  transparency_type = "PREMULTIPLY_STRAIGHT"
  vectorization_options = "Grey"
  image_settings = harmony.ImportRasterSettings(insertion_frame, vectorization_type, colour_space, alignment_type, transparency_type, vectorization_options )
  import_handler(r"C:/myPath/myImage.png", target, image_settings, "MyLayer")

  
  
• ImportMovieSettings: Import a movie to the scene.
  Movie Example

  from ToonBoom import harmony
  target = harmony.session().project.scene
  import_handler = harmony.session().project.import_handler
  insertion_frame = 5
  import_sound = True
  vectorization_type = "KEEP_ORIGINAL"
  colour_space = "sRGB"
  alignment_type = "CENTER_FIT"
  transparency_type = "PREMULTIPLY_STRAIGHT"
  vectorization_options = "Grey"
  movie_settings = harmony.ImportMovieSettings(insertion_frame, import_sound, vectorization_type, colour_space, alignment_type, transparency_type, vectorization_options)
  import_handler(r"C:/myPath/myMovie.mp4", target, movie_settings, "MyLayer")

  
  
• ImportPhotoshopImageSettings: Import a photoshop file to the scene.
  Import Photoshop File Example

  from ToonBoom import harmony
  target = harmony.session().project.scene
  import_handler = harmony.session().project.import_handler
  insertion_frame = 5
  layering_option = "SINGLE_LAYER"
  vectorization_type = "KEEP_ORIGINAL"
  colour_space = "sRGB"
  alignment_type = "CENTER_FIT"
  transparency_type = "PREMULTIPLY_STRAIGHT"
  vectorization_options = "Grey"
  photoshop_settings = harmony.ImportPhotoshopImageSettings(insertion_frame, layering_option, vectorization_type, colour_space, alignment_type, transparency_type, vectorization_options)
  import_handler(r"C:/myPath/myFile.psd", target, photoshop_settings, "MyLayer")

  
  

Public Member Functions
QVariant	operator() (const QString &fullFileName, OMC::Scene target, OMH::ImportSettingsBase importSettings, QString layerName=QString())
	Imports the given file to the target object, respecting the given settings. More...
QVariant	import_photoshop_image (const QString &fullFileName, OMC::Scene target, OMH::ImportPhotoshopImageSettings settings, QString layerName=QString()) const
	Import the contents of a photoshop (psd/psb) file, depending on the input settings object. More...
QVariant	import_vectorized_image (const QString &fullFileName, OMC::Scene target, OMH::ImportVectorSettings settings, QString layerName=QString())
	Import a vectorized Toon Boom image file (tvg), depending on the input settings object. More...
QVariant	import_image (const QString &fullFileName, OMC::Scene target, OMH::ImportRasterSettings settings, QString layerName=QString())
	Import an image file, depending on the input settings object. More...
QVariant	import_movie (const QString &fullFileName, OMC::Scene target, OMH::ImportMovieSettings settings, QString layerName=QString())
	Import a video file, and each frame as a drawing, depending on the input settings object. More...
QVariant	import3DObject (const QString &fullFileName, OMC::Scene target, OMH::Import3DObjectSettings settings, QString layerName=QString())
	Import a 3d object file, depending on the input settings object. More...
QVariant	import_audio (const QString &fullFileName, OMC::Scene target, OMH::ImportAudioSettings settings, QString layerName=QString())
	Import an audio file, depending on the input settings object. The target argument must be the scene. More...

Member Function Documentation

import3DObject()

QVariant OMH::ImportHandler::import3DObject	(	const QString &	fullFileName,
		OMC::Scene	target,
		OMH::Import3DObjectSettings	settings,
		QString	layerName = QString()
	)

Import a 3d object file, depending on the input settings object.

import_audio()

QVariant OMH::ImportHandler::import_audio	(	const QString &	fullFileName,
		OMC::Scene	target,
		OMH::ImportAudioSettings	settings,
		QString	layerName = QString()
	)

Import an audio file, depending on the input settings object. The target argument must be the scene.

import_image()

QVariant OMH::ImportHandler::import_image	(	const QString &	fullFileName,
		OMC::Scene	target,
		OMH::ImportRasterSettings	settings,
		QString	layerName = QString()
	)

Import an image file, depending on the input settings object.

import_movie()

QVariant OMH::ImportHandler::import_movie	(	const QString &	fullFileName,
		OMC::Scene	target,
		OMH::ImportMovieSettings	settings,
		QString	layerName = QString()
	)

Import a video file, and each frame as a drawing, depending on the input settings object.

import_photoshop_image()

QVariant OMH::ImportHandler::import_photoshop_image	(	const QString &	fullFileName,
		OMC::Scene	target,
		OMH::ImportPhotoshopImageSettings	settings,
		QString	layerName = QString()
	)		const

Import the contents of a photoshop (psd/psb) file, depending on the input settings object.

import_vectorized_image()

QVariant OMH::ImportHandler::import_vectorized_image	(	const QString &	fullFileName,
		OMC::Scene	target,
		OMH::ImportVectorSettings	settings,
		QString	layerName = QString()
	)

Import a vectorized Toon Boom image file (tvg), depending on the input settings object.

operator()()

QVariant OMH::ImportHandler::operator()	(	const QString &	fullFileName,
		OMC::Scene	target,
		OMH::ImportSettingsBase	importSettings,
		QString	layerName = QString()
	)

Imports the given file to the target object, respecting the given settings.

Throws error if unsuccessful, returns a map of the created objects when successful. The returned objects can be of the following categories, "columns", "nodes", "elements" and "drawings".

Parameters

fullFileName	The complete file path to the import file, including its extension.
target	The OMC object on which to import to (e.g. OMC::Element or OMC::Scene).
importSettings	The import settings object, which will specify how to import the file.
layerName	(optional) The xSheet column name of an existing (or to be created) layer, on which to import the file content into. (By default, the layer name will be the movie file name.)

Example on how to import a movie:

from ToonBoom import harmony
target = harmony.session().project.elements[0] # Attempt targeting an element
if target == None:
  target = harmony.session().project.scene # Targeting the scene instead
import_handler = harmony.session().project.import_handler
insertion_frame = 5
import_sound = True
vectorization_type = "KEEP_ORIGINAL"
colour_space = "sRGB"
alignment_type = "CENTER_FIT"
transparency_type = "PREMULTIPLY_STRAIGHT"
vectorization_options = "Grey"
movie_settings = harmony.ImportMovieSettings(insertion_frame, import_sound, vectorization_type, colour_space, alignment_type, transparency_type, vectorization_options)
import_handler(r"C:/myPath/myMovie.mp4", target, movie_settings, "MyLayer")

Example on how to import an audio file:

from ToonBoom import harmony
scene = harmony.session().project.scene
import_handler = harmony.session().project.import_handler
insertion_frame = 5
audio_settings = harmony.ImportAudioSettings(insertion_frame)
import_handler(r"C:/myPath/myAudio.wav", scene, audio_settings, "MyAudioLayer")

Inheritance diagram for OMH::ImportHandler:

Collaboration diagram for OMH::ImportHandler: