characterDefenitionUI

=== Author: Assaf Ben Zur ===

This tool was created to assist users in creating humanIK character definitions.

Also, in conjunction with Block, create an animation puppet for predifined skeleton templates.

Use pre-existing prests, as well as create your own presets, to characterize any skeleton in seconds.

Many workflows and scenrios are covered within this tool, please refer to Mansur-Rig's You-Tube channel for a full video guide demonstratig all of them.

Classes

MnsCharacterDefenitionUI [Class]

Main UI Class

Constructor:	MnsCharacterDefenitionUI(parent(str) ; [default: mnsUIUtils.get_maya_window()])
Inherits from:	form_class, base_class
Class Members:	presetsDir charDefPresets charDefData blockNameSpace targetNameSpace
Methods:	addRowToTable [method] clearCell [method] clearRow [method] connectSignals [method] createHIKSlotsMenu [method] drawData [method] editMenu [method] exportPreset [method] filterView [method] gatherCharDefData [method] getNamespaceBasedOnMode [method] importFromFile [method] importPreset [method] initPresets [method] initView [method] initializeUI [method] linkHikMenuAction [method] loadHikSlotToSelectedCells [method] loadNameSpace [method] loadSelectedToCell [method] loadWindow [method] removeRowFromTable [method] resetUI [method] setNameBoxStateBasedOnMode [method] updateNameSpaceVars [method] updateSceneSelectionBasedOnUIState [method] valueEdit [method]

MnsCharacterDefenitionUI methods

addRowToTable [MnsCharacterDefenitionUI class method]

Add a new empty row trigger.

Constructor:	addRowToTable(self)
Return:	None
Arguments:	self
Optional Arguments:

clearCell [MnsCharacterDefenitionUI class method]

Clear cell trigger.

Constructor:	clearCell(self, position)
Return:	None
Arguments:	self position
Optional Arguments:

clearRow [MnsCharacterDefenitionUI class method]

Delete Row trigger.

Constructor:	clearRow(self)
Return:	None
Arguments:	self
Optional Arguments:

connectSignals [MnsCharacterDefenitionUI class method]

Connect all UI signals

Constructor:	connectSignals(self)
Return:	None
Arguments:	self
Optional Arguments:

createHIKSlotsMenu [MnsCharacterDefenitionUI class method]

Create the predifined HIK context menu structure.

Constructor:	createHIKSlotsMenu(self, rootMenuItem, position)
Return:	None
Arguments:	self rootMenuItem position
Optional Arguments:

drawData [MnsCharacterDefenitionUI class method]

Draw gathered data into the UI.

Constructor:	drawData(self)
Return:	None
Arguments:	self
Optional Arguments:

editMenu [MnsCharacterDefenitionUI class method]

Right-Click/Context Menu open trigger.

Create a menu based on the right click position and column, and connect all actions to their related triggers.

Constructor:	editMenu(self, position)
Return:	None
Arguments:	self position
Optional Arguments:

exportPreset [MnsCharacterDefenitionUI class method]

Export preset to file trigger.

Constructor:	exportPreset(self)
Return:	None
Arguments:	self
Optional Arguments:

filterView [MnsCharacterDefenitionUI class method]

Search trigger. Filter the main treeWidget list based on the input filter text.

Constructor:	filterView(self)
Return:	None
Arguments:	self
Optional Arguments:

gatherCharDefData [MnsCharacterDefenitionUI class method]

Gather character definition data from UI into a python dict.

Constructor:	gatherCharDefData(self)
Return:	None
Arguments:	self
Optional Arguments:

getNamespaceBasedOnMode [MnsCharacterDefenitionUI class method]

Get relevant namespace inpit based on mode.

mode 0 = Block name-space

mode 1 = Target name-space.

Constructor:	getNamespaceBasedOnMode(self, mode = 0)
Return:	None
Arguments:	self mode(int) ; [default: 0]
Optional Arguments:

importFromFile [MnsCharacterDefenitionUI class method]

Import preset from file trigger.

Constructor:	importFromFile(self)
Return:	None
Arguments:	self
Optional Arguments:

importPreset [MnsCharacterDefenitionUI class method]

Import preset trigger.

Constructor:	importPreset(self, **kwargs)
Return:	None
Arguments:	self **kwargs
Optional Arguments:

initPresets [MnsCharacterDefenitionUI class method]

Initialize existing Mansur-Rig presets that are delivered with the product and update the UI list.

Constructor:	initPresets(self)
Return:	None
Arguments:	self
Optional Arguments:

initView [MnsCharacterDefenitionUI class method]

Initialize UI default display state.

Constructor:	initView(self)
Return:	None
Arguments:	self
Optional Arguments:

initializeUI [MnsCharacterDefenitionUI class method]

Initialize UI Data.

Constructor:	initializeUI(self)
Return:	None
Arguments:	self
Optional Arguments:

linkHikMenuAction [MnsCharacterDefenitionUI class method]

Procedural menu items action linking to action.

Constructor:	linkHikMenuAction(self, menuItem, position)
Return:	None
Arguments:	self menuItem position
Optional Arguments:

loadHikSlotToSelectedCells [MnsCharacterDefenitionUI class method]

Load selected HIK slot into selected cell trigger.

Constructor:	loadHikSlotToSelectedCells(self, text, position)
Return:	None
Arguments:	self text position
Optional Arguments:

loadNameSpace [MnsCharacterDefenitionUI class method]

Load selected namespace trigger.

Constructor:	loadNameSpace(self)
Return:	None
Arguments:	self
Optional Arguments:

loadSelectedToCell [MnsCharacterDefenitionUI class method]

Load scene selection to cell trigger.

Constructor:	loadSelectedToCell(self, position)
Return:	None
Arguments:	self position
Optional Arguments:

loadWindow [MnsCharacterDefenitionUI class method]

Main UI load

Constructor:	loadWindow(self)
Return:	None
Arguments:	self
Optional Arguments:

removeRowFromTable [MnsCharacterDefenitionUI class method]

Remove Row trigger.

Constructor:	removeRowFromTable(self)
Return:	None
Arguments:	self
Optional Arguments:

resetUI [MnsCharacterDefenitionUI class method]

Reset the UI to default state.

Constructor:	resetUI(self)
Return:	None
Arguments:	self
Optional Arguments:

setNameBoxStateBasedOnMode [MnsCharacterDefenitionUI class method]

set the character name line-edit state base on the current UI state.

Constructor:	setNameBoxStateBasedOnMode(self)
Return:	None
Arguments:	self
Optional Arguments:

updateNameSpaceVars [MnsCharacterDefenitionUI class method]

Update the class member variables for both namespaces.

Constructor:	updateNameSpaceVars(self)
Return:	None
Arguments:	self
Optional Arguments:

updateSceneSelectionBasedOnUIState [MnsCharacterDefenitionUI class method]

Update the current Maya scene selection based on the selected items in the UI.

In case the "update selection" checkbox isn't checked, this will not execute and selection will not be updated.

Constructor:	updateSceneSelectionBasedOnUIState(self)
Return:	None
Arguments:	self
Optional Arguments:

valueEdit [MnsCharacterDefenitionUI class method]

TreeWidget Edit trigger

Constructor:	valueEdit(self, item, column)
Return:	None
Arguments:	self item column
Optional Arguments:

Defenitions

loadCharacterDefenitionUI

Load the Charecter Definition UI from globals, avoid UI duplication.

Constructor:	loadCharacterDefenitionUI()
Return:	None
Arguments:
Keyword Arguments: