vtool.data

Class Summary

DataManager()	Manages data types
DataFolder(name, filepath)	A folder with a json file for tracking data
DataFile(name, directory)
Data([name])
FileData([name])
ScriptData([name])
ScriptManifestData([name])
ScriptPythonData([name])
ScriptMelData([name])
CustomData([name])
MayaCustomData([name])
ControlCvData([name])	maya.control_cvs Exports/Imports cv positions on controls.
ControlColorData([name])
SkinWeightData([name])	maya.skin_weights Export skin cluster weights on selected geo.
LoadWeightFileThread()	This constructor should always be called with keyword arguments.
ReadWeightFileThread(influence_dict, ...)	This constructor should always be called with keyword arguments.
BlendshapeWeightData([name])
DeformerWeightData([name])	maya.deform_weights Export/Import weights of clusters and wire deformers.
MayaShadersData([name])	maya.shaders Export/Import shaders.
AnimationData([name])	maya.animation Export/Import all the keyframes in a scene with their connection info.
ControlAnimationData([name])	maya.control_animation Only import/export keframes on controls.
AtomData([name])	Not in use.
PoseData([name])	maya.pose Export/Import pose correctives.
MayaAttributeData([name])	maya.attributes Export attribute data on selected nodes.
MayaControlAttributeData([name])
MayaControlRotateOrderData([name])
MayaFileData([name])
MayaBinaryFileData([name])
MayaAsciiFileData([name])
MayaShotgunFileData([name])

Function Summary

read_ldr_file(filepath)
read_lxfml_file(filepath)

class DataManager

Manages data types

get_available_types()

get_type_instance(data_type)

class DataFolder(name, filepath)

A folder with a json file for tracking data

get_data_type()

set_data_type(data_type)

get_sub_folder(name=None)

get_current_sub_folder()

set_sub_folder(name)

set_sub_folder_to_default()

get_folder_data_instance()

This gets the data instance for this data. Data instance is the class that works on the data in this directory.

rename(new_name)

delete()

class DataFile(name, directory)

version_file(comment)

add_child(filepath)

delete()

rename(new_name)

class Data(name=None)

set_name(name)

is_type_match(data_type)

get_type()

class FileData(name=None)

set_directory(directory)

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

set_temp_sub_folder(folder_name)

set_sub_folder(folder_name)

create()

rename(new_name)

get_type()

is_type_match(data_type)

set_name(name)

class ScriptData(name=None)

save(lines, comment=None)

set_lines(lines)

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class ScriptManifestData(name=None)

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

save(lines, comment=None)

set_directory(directory)

set_lines(lines)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class ScriptPythonData(name=None)

open()

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

save(lines, comment=None)

set_directory(directory)

set_lines(lines)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class ScriptMelData(name=None)

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

save(lines, comment=None)

set_directory(directory)

set_lines(lines)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class CustomData(name=None)

import_data()

export_data()

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class MayaCustomData(name=None)

create()

export_data()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

import_data()

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class ControlCvData(name=None)

maya.control_cvs Exports/Imports cv positions on controls. All control cvs will be exported regardless of selection. All control cvs will be imported regardless of selection.

import_data(filename=None, selection=[])

export_data(comment, selection=[])

get_curves(filename=None)

remove_curve(curve_name, filename=None)

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class ControlColorData(name=None)

get_file()

This will get the data file taking into account the currently set sub folder

export_data(comment, selection=[])

import_data(filename=None, selection=[])

remove_curve(curve_name, filename=None)

get_curves(filename=None)

create()

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class SkinWeightData(name=None)

maya.skin_weights Export skin cluster weights on selected geo. Import available skin cluster weights for geo, or only the weights on selected geo.

set_blend_weights(bool_value)

set_version_up(bool_value)

set_single_file(bool_value)

import_skin_weights(directory, mesh)

import_data(filepath=None, selection=[])

export_data(comment, selection=[], single_file=False, version_up=True, blend_weights=True)

get_skin_meshes()

remove_mesh(mesh)

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class LoadWeightFileThread

This constructor should always be called with keyword arguments. Arguments are:

group should be None; reserved for future extension when a ThreadGroup class is implemented.

target is the callable object to be invoked by the run() method. Defaults to None, meaning nothing is called.

name is the thread name. By default, a unique name is constructed of the form “Thread-N” where N is a small decimal number.

args is the argument tuple for the target invocation. Defaults to ().

kwargs is a dictionary of keyword arguments for the target invocation. Defaults to {}.

If a subclass overrides the constructor, it must make sure to invoke the base class constructor (Thread.__init__()) before doing anything else to the thread.

run(influence_index, skin, weights, path)

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

property daemon

A boolean value indicating whether this thread is a daemon thread.

This must be set before start() is called, otherwise RuntimeError is raised. Its initial value is inherited from the creating thread; the main thread is not a daemon thread and therefore all threads created in the main thread default to daemon = False.

The entire Python program exits when only daemon threads are left.

getName()

property ident

Thread identifier of this thread or None if it has not been started.

This is a nonzero integer. See the get_ident() function. Thread identifiers may be recycled when a thread exits and another thread is created. The identifier is available even after the thread has exited.

isAlive()

Return whether the thread is alive.

This method is deprecated, use is_alive() instead.

isDaemon()

is_alive()

Return whether the thread is alive.

This method returns True just before the run() method starts until just after the run() method terminates. The module function enumerate() returns a list of all alive threads.

join(timeout=None)

Wait until the thread terminates.

This blocks the calling thread until the thread whose join() method is called terminates – either normally or through an unhandled exception or until the optional timeout occurs.

When the timeout argument is present and not None, it should be a floating point number specifying a timeout for the operation in seconds (or fractions thereof). As join() always returns None, you must call is_alive() after join() to decide whether a timeout happened – if the thread is still alive, the join() call timed out.

When the timeout argument is not present or None, the operation will block until the thread terminates.

A thread can be join()ed many times.

join() raises a RuntimeError if an attempt is made to join the current thread as that would cause a deadlock. It is also an error to join() a thread before it has been started and attempts to do so raises the same exception.

property name

A string used for identification purposes only.

It has no semantics. Multiple threads may be given the same name. The initial name is set by the constructor.

setDaemon(daemonic)

setName(name)

start()

Start the thread’s activity.

It must be called at most once per thread object. It arranges for the object’s run() method to be invoked in a separate thread of control.

This method will raise a RuntimeError if called more than once on the same thread object.

class ReadWeightFileThread(influence_dict, folder_path, influence)

This constructor should always be called with keyword arguments. Arguments are:

group should be None; reserved for future extension when a ThreadGroup class is implemented.

target is the callable object to be invoked by the run() method. Defaults to None, meaning nothing is called.

name is the thread name. By default, a unique name is constructed of the form “Thread-N” where N is a small decimal number.

args is the argument tuple for the target invocation. Defaults to ().

kwargs is a dictionary of keyword arguments for the target invocation. Defaults to {}.

If a subclass overrides the constructor, it must make sure to invoke the base class constructor (Thread.__init__()) before doing anything else to the thread.

run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

property daemon

A boolean value indicating whether this thread is a daemon thread.

This must be set before start() is called, otherwise RuntimeError is raised. Its initial value is inherited from the creating thread; the main thread is not a daemon thread and therefore all threads created in the main thread default to daemon = False.

The entire Python program exits when only daemon threads are left.

getName()

property ident

Thread identifier of this thread or None if it has not been started.

This is a nonzero integer. See the get_ident() function. Thread identifiers may be recycled when a thread exits and another thread is created. The identifier is available even after the thread has exited.

isAlive()

Return whether the thread is alive.

This method is deprecated, use is_alive() instead.

isDaemon()

is_alive()

Return whether the thread is alive.

This method returns True just before the run() method starts until just after the run() method terminates. The module function enumerate() returns a list of all alive threads.

join(timeout=None)

Wait until the thread terminates.

This blocks the calling thread until the thread whose join() method is called terminates – either normally or through an unhandled exception or until the optional timeout occurs.

When the timeout argument is present and not None, it should be a floating point number specifying a timeout for the operation in seconds (or fractions thereof). As join() always returns None, you must call is_alive() after join() to decide whether a timeout happened – if the thread is still alive, the join() call timed out.

When the timeout argument is not present or None, the operation will block until the thread terminates.

A thread can be join()ed many times.

join() raises a RuntimeError if an attempt is made to join the current thread as that would cause a deadlock. It is also an error to join() a thread before it has been started and attempts to do so raises the same exception.

property name

A string used for identification purposes only.

It has no semantics. Multiple threads may be given the same name. The initial name is set by the constructor.

setDaemon(daemonic)

setName(name)

start()

Start the thread’s activity.

It must be called at most once per thread object. It arranges for the object’s run() method to be invoked in a separate thread of control.

This method will raise a RuntimeError if called more than once on the same thread object.

class BlendshapeWeightData(name=None)

export_data(comment=None, selection=[])

import_data()

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class DeformerWeightData(name=None)

maya.deform_weights Export/Import weights of clusters and wire deformers. Will not work if cluster or wire deformer is affecting more than one piece of geo.

export_data(comment=None, selection=[])

import_data(filepath=None)

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class MayaShadersData(name=None)

maya.shaders Export/Import shaders. This only works for maya shaders. Eg. Blinn, Lambert, etc.

maya_ascii = 'mayaAscii'

import_data(filepath=None, selection=[])

export_data(comment, selection=[])

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class AnimationData(name=None)

maya.animation Export/Import all the keyframes in a scene with their connection info. Will export/import blendWeighted as well.

get_file()

This will get the data file taking into account the currently set sub folder

set_namespace(namespace_str)

export_data(comment, selection=[])

import_data(filepath=None)

create()

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class ControlAnimationData(name=None)

maya.control_animation Only import/export keframes on controls. Good for saving out poses.

create()

export_data(comment, selection=[])

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

import_data(filepath=None)

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_namespace(namespace_str)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class AtomData(name=None)

Not in use.

export_data(comment)

import_data()

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class PoseData(name=None)

maya.pose Export/Import pose correctives.

maya_binary = 'mayaBinary'

maya_ascii = 'mayaAscii'

export_data(comment)

import_data(namespace='')

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class MayaAttributeData(name=None)

maya.attributes Export attribute data on selected nodes. Import attribute data on all nodes exported, unless something is selected.

import_data(filepath=None, selection=[])

This will import all nodes saved to the data folder. You may need to delete folders of nodes you no longer want to import.

export_data(comment, selection=[])

This will export only the currently selected nodes.

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class MayaControlAttributeData(name=None)

create()

export_data(comment, selection=[])

This will export only the currently selected nodes.

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

import_data(filepath=None, selection=[])

This will import all nodes saved to the data folder. You may need to delete folders of nodes you no longer want to import.

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class MayaControlRotateOrderData(name=None)

create()

export_data(comment, selection=[])

This will export only the currently selected nodes.

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

import_data(filepath=None, selection=[])

This will import all nodes saved to the data folder. You may need to delete folders of nodes you no longer want to import.

is_type_match(data_type)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class MayaFileData(name=None)

maya_binary = 'mayaBinary'

maya_ascii = 'mayaAscii'

check_after_save = True

import_data(filepath=None)

open(filepath=None)

save(comment)

export_data(comment, selection=None)

maya_reference_data(filepath=None)

set_directory(directory)

create()

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

rename(new_name)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class MayaBinaryFileData(name=None)

check_after_save = True

create()

export_data(comment, selection=None)

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

import_data(filepath=None)

is_type_match(data_type)

maya_ascii = 'mayaAscii'

maya_binary = 'mayaBinary'

maya_reference_data(filepath=None)

open(filepath=None)

rename(new_name)

save(comment)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class MayaAsciiFileData(name=None)

check_after_save = True

create()

export_data(comment, selection=None)

get_file()

This will get the data file taking into account the currently set sub folder

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

import_data(filepath=None)

is_type_match(data_type)

maya_ascii = 'mayaAscii'

maya_binary = 'mayaBinary'

maya_reference_data(filepath=None)

open(filepath=None)

rename(new_name)

save(comment)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

class MayaShotgunFileData(name=None)

get_file()

This will get the data file taking into account the currently set sub folder

write_state(project, asset_type, asset, step, task, custom, asset_is_name)

read_state()

reference()

open()

import_data(filepath=None)

save()

get_projects()

get_assets(project, asset_type=None)

get_asset_steps()

get_asset_tasks(project, asset_step, asset_type, asset_name)

has_api()

check_after_save = True

create()

export_data(comment, selection=None)

get_file_direct(sub_folder=None)

This will get the data file and optionally the sub folder if a name is given.

get_folder()

get_sub_folder()

get_type()

is_type_match(data_type)

maya_ascii = 'mayaAscii'

maya_binary = 'mayaBinary'

maya_reference_data(filepath=None)

rename(new_name)

set_directory(directory)

set_name(name)

set_sub_folder(folder_name)

set_temp_sub_folder(folder_name)

read_ldr_file(filepath)

read_lxfml_file(filepath)