`animio.ui`¶

Module containing the user interface implementation of the AnimIO library

Functions¶

animio.ui.noneToList(res)¶

Returns:	list instead of None

Classes¶

Epydoc: animio.ui.AnimIOLayout

class animio.ui.AnimIOLayout(*args, **kwargs)¶

Bases: mrv.maya.ui.TabLayout

Represents a layout for exporting and importing animation

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

add(child, set_self_active=False, revert_to_previous_parent=True)¶

Add the given child UI item to our list of children

Parameters:	set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True
Returns:	the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

childByName(childname)¶

Raises KeyError:
Returns:	stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent\|subparent\|mychild” )
	if a child with that name does not exist

children()¶

Returns:	children of this layout

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

clearChildren()¶: Clear our child arrays to quickly forget about our children

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)¶: Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_cc¶: Event suitable to deal with user interface callback

e_changeCommand¶: Event suitable to deal with user interface callback

e_dcc¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_doubleClickCommand¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_preSelectCommand¶: Event suitable to deal with user interface callback

e_psc¶: Event suitable to deal with user interface callback

e_sc¶: Event suitable to deal with user interface callback

e_selectCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x2b08e713c2a8>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(sequence) -> unicode

Return a string which is the concatenation of the strings in the sequence. The separator between elements is S.

listChildren(predicate=<function <lambda> at 0x6d3ac08>)¶

Returns:	list with our child instances
Parameter:	predicate – function returning True for each child to include in result, allows to easily filter children
Note:	it’s a copy, so you can freely act on the list
Note:	children will be returned in the order in which they have been added

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_ca¶

Returns:	children of this layout

p_childArray¶

Returns:	children of this layout

p_childResizable¶

p_cr¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_en¶

p_enable¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_h¶

p_height¶

p_horizontalScrollBarThickness¶

p_hst¶

p_i¶

p_image¶

p_imageVisible¶

p_imh¶

p_imw¶

p_innerMarginHeight¶

p_innerMarginWidth¶

p_io¶

p_isObscured¶

p_iv¶

p_m¶

p_manage¶

p_mcw¶

p_minChildWidth¶

p_moveTab¶

p_mt¶

p_nch¶

p_npm¶

p_numberOfChildren¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_scr¶

p_scrollable¶

p_selectTab¶

p_selectTabIndex¶

p_st¶

p_sti¶

p_tabLabel¶

p_tabLabelIndex¶

p_tabsVisible¶

p_tl¶

p_tli¶

p_tv¶

p_useTemplate¶

p_ut¶

p_verticalScrollBarThickness¶

p_vis¶

p_visible¶

p_vst¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

removeChild(child)¶

Remove the given child from our list

Returns:	True if the child was found and has been removed, False otherwise

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (tail, sep, head)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setActive()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

setParentActive()¶

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:	self
Note:	can safely be called several times

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶: Deregister our scene callbacks

update(*args)¶: Update to represent the latest state of the scene

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: animio.ui.AnimIO_UI

class animio.ui.AnimIO_UI(*args, **kwargs)¶

Bases: mrv.maya.ui.Window

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

add(child, set_self_active=False, revert_to_previous_parent=True)¶

Add the given child UI item to our list of children

Parameters:	set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True
Returns:	the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

childByName(childname)¶

Raises KeyError:
Returns:	stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent\|subparent\|mychild” )
	if a child with that name does not exist

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

clearChildren()¶: Clear our child arrays to quickly forget about our children

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)¶: Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_minimizeCommand¶: Event suitable to deal with user interface callback

e_mnc¶: Event suitable to deal with user interface callback

e_rc¶: Event suitable to deal with user interface callback

e_restoreCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isFrontWindow()¶

Returns:	True if we are the front window

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x2b08e713c2a8>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(sequence) -> unicode

Return a string which is the concatenation of the strings in the sequence. The separator between elements is S.

listChildren(predicate=<function <lambda> at 0x6d3ac08>)¶

Returns:	list with our child instances
Parameter:	predicate – function returning True for each child to include in result, allows to easily filter children
Note:	it’s a copy, so you can freely act on the list
Note:	children will be returned in the order in which they have been added

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

menuArray()¶

Returns:	Menu instances attached to this window

numberOfMenus()¶

Returns:	number of menus in the menu array

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_docTag¶

p_doctTag¶

p_dt¶

p_dtg¶

p_en¶

p_enable¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_h¶

p_height¶

p_i¶

p_iconName¶

p_iconify¶

p_io¶

p_isObscured¶

p_leftEdge¶

p_m¶

p_mainWindow¶

p_manage¶

p_maximizeButton¶

p_mbv¶

p_menuBarVisible¶

p_minimizeButton¶

p_mnb¶

p_mw¶

p_mxb¶

p_nm¶

Returns:	number of menus in the menu array

p_npm¶

p_numberOfMenus¶

Returns:	number of menus in the menu array

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_resizeToFitChildren¶

p_rt¶

p_s¶

p_sizeable¶

p_t¶

p_tb¶

p_tbm¶

p_te¶

p_title¶

p_titleBar¶

p_titleBarMenu¶

p_tl¶

p_tlb¶

p_tlc¶

p_toolbox¶

p_topEdge¶

p_topLeftCorner¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_wh¶

p_width¶

p_widthHeightin¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

removeChild(child)¶

Remove the given child from our list

Returns:	True if the child was found and has been removed, False otherwise

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (tail, sep, head)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setActive()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

setMenuIndex(menu, index)¶

Set the menu index of the specified menu

Parameters:	menu – name of child menu to set index – new index at which the menu should appear

shortName()¶

Returns:	shortname of the ui ( name without pipes )

show()¶: Show Window :return: self

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: animio.ui.ExportLayout

class animio.ui.ExportLayout(*args, **kwargs)¶

Bases: mrv.maya.ui.FormLayout

Layout encapsulating all export functionality

class FormConstraint¶

Bases: object

defines the way a child is constrained, possibly to other children

Todo:	proper constraint system, but could be complicated to make it really easy to use

classmethod ExportLayout.activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

ExportLayout.add(child, set_self_active=False, revert_to_previous_parent=True)¶

Add the given child UI item to our list of children

Parameters:	set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True
Returns:	the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod ExportLayout.addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

ExportLayout.annotation()¶: :return : the annotation string

ExportLayout.basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

ExportLayout.capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

ExportLayout.center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

ExportLayout.childByName(childname)¶

Raises KeyError:
Returns:	stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent\|subparent\|mychild” )
	if a child with that name does not exist

ExportLayout.children()¶

Returns:	children of this layout

ExportLayout.childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

ExportLayout.clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

ExportLayout.clearChildren()¶: Clear our child arrays to quickly forget about our children

ExportLayout.count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

ExportLayout.decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

ExportLayout.delete()¶: Delete this UI - the wrapper instance must not be used after this call

ExportLayout.deleteChild(child)¶: Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

ExportLayout.dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

ExportLayout.e_dgc¶: Event suitable to deal with user interface callback

ExportLayout.e_dpc¶: Event suitable to deal with user interface callback

ExportLayout.e_dragCallback¶: Event suitable to deal with user interface callback

ExportLayout.e_dropCallback¶: Event suitable to deal with user interface callback

ExportLayout.encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

ExportLayout.endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

ExportLayout.exists()¶

Returns:	True if this instance still exists in maya

ExportLayout.expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

ExportLayout.find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

ExportLayout.format¶: S.format(*args, **kwargs) -> unicode

ExportLayout.fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

ExportLayout.index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

ExportLayout.isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

ExportLayout.isRoot()¶

Returns:	True if this path is the root of the DAG

ExportLayout.isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

ExportLayout.isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

ExportLayout.isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

ExportLayout.isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

ExportLayout.isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

ExportLayout.islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

ExportLayout.isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

ExportLayout.isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

ExportLayout.istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

ExportLayout.isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

ExportLayout.iterParents(predicate=<function <lambda> at 0x2b08e713c2a8>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

ExportLayout.join¶

S.join(sequence) -> unicode

Return a string which is the concatenation of the strings in the sequence. The separator between elements is S.

ExportLayout.listChildren(predicate=<function <lambda> at 0x6d3ac08>)¶

Returns:	list with our child instances
Parameter:	predicate – function returning True for each child to include in result, allows to easily filter children
Note:	it’s a copy, so you can freely act on the list
Note:	children will be returned in the order in which they have been added

classmethod ExportLayout.listEventNames()¶

Returns:	list of event ids that exist on our class

ExportLayout.ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

ExportLayout.lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

ExportLayout.lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

ExportLayout.p_ann¶: :return : the annotation string

ExportLayout.p_annotation¶: :return : the annotation string

ExportLayout.p_backgroundColor¶

ExportLayout.p_bgc¶

ExportLayout.p_ca¶

Returns:	children of this layout

ExportLayout.p_childArray¶

Returns:	children of this layout

ExportLayout.p_defineTemplate¶

ExportLayout.p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

ExportLayout.p_doctTag¶

ExportLayout.p_dt¶

ExportLayout.p_dtg¶

ExportLayout.p_en¶

ExportLayout.p_enable¶

ExportLayout.p_ex¶

Returns:	True if this instance still exists in maya

ExportLayout.p_exists¶

Returns:	True if this instance still exists in maya

ExportLayout.p_h¶

ExportLayout.p_height¶

ExportLayout.p_io¶

ExportLayout.p_isObscured¶

ExportLayout.p_m¶

ExportLayout.p_manage¶

ExportLayout.p_nch¶

ExportLayout.p_npm¶

ExportLayout.p_numberOfChildren¶

ExportLayout.p_numberOfPopupMenus¶

ExportLayout.p_pma¶

Returns:	popup menus attached to this control

ExportLayout.p_po¶

ExportLayout.p_popupMenuArray¶

Returns:	popup menus attached to this control

ExportLayout.p_preventOverride¶

ExportLayout.p_useTemplate¶

ExportLayout.p_ut¶

ExportLayout.p_vis¶

ExportLayout.p_visible¶

ExportLayout.p_w¶

ExportLayout.p_width¶

ExportLayout.parent()¶

Returns:	parent instance of this ui element

ExportLayout.parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

ExportLayout.partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

ExportLayout.popupMenuArray()¶

Returns:	popup menus attached to this control

ExportLayout.removeChild(child)¶

Remove the given child from our list

Returns:	True if the child was found and has been removed, False otherwise

ExportLayout.replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

ExportLayout.rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

ExportLayout.rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

ExportLayout.rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

ExportLayout.root()¶

Returns:	the root of the DAG - it has no further parents

ExportLayout.rpartition¶

S.rpartition(sep) -> (tail, sep, head)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

ExportLayout.rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

ExportLayout.rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

ExportLayout.sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

ExportLayout.setActive()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

ExportLayout.setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

ExportLayout.setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

ExportLayout.setFocus()¶: Set the global keyboard focus to this control

ExportLayout.setParentActive()¶

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:	self
Note:	can safely be called several times

ExportLayout.setup(**kwargs)¶

Apply the given setup to the form layout, specified using kwargs

Parameter:	kwargs – arguments you would set use to setup the form layout

ExportLayout.shortName()¶

Returns:	shortname of the ui ( name without pipes )

ExportLayout.split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

ExportLayout.splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

ExportLayout.startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

ExportLayout.strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

ExportLayout.supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

ExportLayout.swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

ExportLayout.title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

ExportLayout.translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

ExportLayout.type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

ExportLayout.uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

ExportLayout.update()¶: Refresh our elements to represent the current scene state

ExportLayout.upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

ExportLayout.zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: animio.ui.FloatRangeField

class animio.ui.FloatRangeField(*args, **kwargs)¶

Bases: mrv.maya.ui.RowLayout

Implements a queryable range of integers :note: it uses text fields allowing them to be empty

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

add(child, set_self_active=False, revert_to_previous_parent=True)¶

Add the given child UI item to our list of children

Parameters:	set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True
Returns:	the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

childByName(childname)¶

Raises KeyError:
Returns:	stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent\|subparent\|mychild” )
	if a child with that name does not exist

children()¶

Returns:	children of this layout

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clear()¶: Don’t display any value, clear out the existing ones

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

clearChildren()¶: Clear our child arrays to quickly forget about our children

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

deleteChild(child)¶: Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_dgc¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

get()¶

Raises ValueError:
Returns:	Tuple(floatStartRance, floatEndRange)
	if one of the ranges is invalid

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x2b08e713c2a8>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(sequence) -> unicode

Return a string which is the concatenation of the strings in the sequence. The separator between elements is S.

listChildren(predicate=<function <lambda> at 0x6d3ac08>)¶

Returns:	list with our child instances
Parameter:	predicate – function returning True for each child to include in result, allows to easily filter children
Note:	it’s a copy, so you can freely act on the list
Note:	children will be returned in the order in which they have been added

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_ad1¶

p_ad2¶

p_ad3¶

p_ad4¶

p_ad5¶

p_ad6¶

p_adj¶

p_adjustableColumn¶

p_adjustableColumn1¶

p_adjustableColumn2¶

p_adjustableColumn3¶

p_adjustableColumn4¶

p_adjustableColumn5¶

p_adjustableColumn6¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_backgroundColor¶

p_bgc¶

p_ca¶

Returns:	children of this layout

p_cal¶

p_cat¶

p_childArray¶

Returns:	children of this layout

p_cl1¶

p_cl2¶

p_cl3¶

p_cl4¶

p_cl5¶

p_cl6¶

p_co1¶

p_co2¶

p_co3¶

p_co4¶

p_co5¶

p_co6¶

p_columnAlign¶

p_columnAlign1¶

p_columnAlign2¶

p_columnAlign3¶

p_columnAlign4¶

p_columnAlign5¶

p_columnAlign6¶

p_columnAttach¶

p_columnAttach1¶

p_columnAttach2¶

p_columnAttach3¶

p_columnAttach4¶

p_columnAttach5¶

p_columnAttach6¶

p_columnOffset1¶

p_columnOffset2¶

p_columnOffset3¶

p_columnOffset4¶

p_columnOffset5¶

p_columnOffset6¶

p_columnWidth¶

p_columnWidth1¶

p_columnWidth2¶

p_columnWidth3¶

p_columnWidth4¶

p_columnWidth5¶

p_columnWidth6¶

p_ct1¶

p_ct2¶

p_ct3¶

p_ct4¶

p_ct5¶

p_ct6¶

p_cw¶

p_cw1¶

p_cw2¶

p_cw3¶

p_cw4¶

p_cw5¶

p_cw6¶

p_defineTemplate¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_en¶

p_enable¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_m¶

p_manage¶

p_nc¶

p_nch¶

p_npm¶

p_numberOfChildren¶

p_numberOfColumns¶

p_numberOfPopupMenus¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_rat¶

p_rowAttach¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

removeChild(child)¶

Remove the given child from our list

Returns:	True if the child was found and has been removed, False otherwise

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (tail, sep, head)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

set(start, end)¶: Set the range of this element :param start: start of the range as float :param end: end of the range as float)

setActive()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setEnabled(state)¶

setFocus()¶: Set the global keyboard focus to this control

setParentActive()¶

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:	self
Note:	can safely be called several times

shortName()¶

Returns:	shortname of the ui ( name without pipes )

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: animio.ui.ImportLayout

class animio.ui.ImportLayout(**kwargs)¶

Bases: mrv.maya.ui.FormLayout

Layout encapsulating all import functionality

class FormConstraint¶

Bases: object

defines the way a child is constrained, possibly to other children

Todo:	proper constraint system, but could be complicated to make it really easy to use

classmethod ImportLayout.activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

ImportLayout.add(child, set_self_active=False, revert_to_previous_parent=True)¶

Add the given child UI item to our list of children

Parameters:	set_self_active – if True, we explicitly make ourselves the current parent for newly created UI elements revert_to_previous_parent – if True, the previous parent will be restored once we are done, if False we keep the parent - only effective if set_self_active is True
Returns:	the newly added child, allowing contructs like button = layout.addChild( Button( ) )

classmethod ImportLayout.addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

ImportLayout.annotation()¶: :return : the annotation string

ImportLayout.basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

ImportLayout.capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

ImportLayout.center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

ImportLayout.childByName(childname)¶

Raises KeyError:
Returns:	stored child instance, specified either as short name ( without pipes ) or fully qualified ( i.e. mychild or parent\|subparent\|mychild” )
	if a child with that name does not exist

ImportLayout.children()¶

Returns:	children of this layout

ImportLayout.childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

ImportLayout.clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

ImportLayout.clearChildren()¶: Clear our child arrays to quickly forget about our children

ImportLayout.count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

ImportLayout.decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

ImportLayout.delete()¶: Delete this UI - the wrapper instance must not be used after this call

ImportLayout.deleteChild(child)¶: Delete the given child ui physically so it will not be shown anymore after removing it from our list of children

ImportLayout.dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

ImportLayout.e_dgc¶: Event suitable to deal with user interface callback

ImportLayout.e_dpc¶: Event suitable to deal with user interface callback

ImportLayout.e_dragCallback¶: Event suitable to deal with user interface callback

ImportLayout.e_dropCallback¶: Event suitable to deal with user interface callback

ImportLayout.encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

ImportLayout.endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

ImportLayout.exists()¶

Returns:	True if this instance still exists in maya

ImportLayout.expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

ImportLayout.find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

ImportLayout.format¶: S.format(*args, **kwargs) -> unicode

ImportLayout.fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

ImportLayout.index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

ImportLayout.isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

ImportLayout.isRoot()¶

Returns:	True if this path is the root of the DAG

ImportLayout.isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

ImportLayout.isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

ImportLayout.isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

ImportLayout.isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

ImportLayout.isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

ImportLayout.islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

ImportLayout.isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

ImportLayout.isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

ImportLayout.istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

ImportLayout.isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

ImportLayout.iterParents(predicate=<function <lambda> at 0x2b08e713c2a8>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

ImportLayout.join¶

S.join(sequence) -> unicode

Return a string which is the concatenation of the strings in the sequence. The separator between elements is S.

ImportLayout.listChildren(predicate=<function <lambda> at 0x6d3ac08>)¶

Returns:	list with our child instances
Parameter:	predicate – function returning True for each child to include in result, allows to easily filter children
Note:	it’s a copy, so you can freely act on the list
Note:	children will be returned in the order in which they have been added

classmethod ImportLayout.listEventNames()¶

Returns:	list of event ids that exist on our class

ImportLayout.ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

ImportLayout.lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

ImportLayout.lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

ImportLayout.p_ann¶: :return : the annotation string

ImportLayout.p_annotation¶: :return : the annotation string

ImportLayout.p_backgroundColor¶

ImportLayout.p_bgc¶

ImportLayout.p_ca¶

Returns:	children of this layout

ImportLayout.p_childArray¶

Returns:	children of this layout

ImportLayout.p_defineTemplate¶

ImportLayout.p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

ImportLayout.p_doctTag¶

ImportLayout.p_dt¶

ImportLayout.p_dtg¶

ImportLayout.p_en¶

ImportLayout.p_enable¶

ImportLayout.p_ex¶

Returns:	True if this instance still exists in maya

ImportLayout.p_exists¶

Returns:	True if this instance still exists in maya

ImportLayout.p_h¶

ImportLayout.p_height¶

ImportLayout.p_io¶

ImportLayout.p_isObscured¶

ImportLayout.p_m¶

ImportLayout.p_manage¶

ImportLayout.p_nch¶

ImportLayout.p_npm¶

ImportLayout.p_numberOfChildren¶

ImportLayout.p_numberOfPopupMenus¶

ImportLayout.p_pma¶

Returns:	popup menus attached to this control

ImportLayout.p_po¶

ImportLayout.p_popupMenuArray¶

Returns:	popup menus attached to this control

ImportLayout.p_preventOverride¶

ImportLayout.p_useTemplate¶

ImportLayout.p_ut¶

ImportLayout.p_vis¶

ImportLayout.p_visible¶

ImportLayout.p_w¶

ImportLayout.p_width¶

ImportLayout.parent()¶

Returns:	parent instance of this ui element

ImportLayout.parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

ImportLayout.partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

ImportLayout.popupMenuArray()¶

Returns:	popup menus attached to this control

ImportLayout.removeChild(child)¶

Remove the given child from our list

Returns:	True if the child was found and has been removed, False otherwise

ImportLayout.replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

ImportLayout.rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

ImportLayout.rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

ImportLayout.rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

ImportLayout.root()¶

Returns:	the root of the DAG - it has no further parents

ImportLayout.rpartition¶

S.rpartition(sep) -> (tail, sep, head)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

ImportLayout.rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

ImportLayout.rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

ImportLayout.sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

ImportLayout.setActive()¶

Set this container active, such that newly created items will be children of this layout

Returns:	self
Note:	always use the addChild function to add the children !

ImportLayout.setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

ImportLayout.setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

ImportLayout.setFocus()¶: Set the global keyboard focus to this control

ImportLayout.setParentActive()¶

Set the parent ( layout ) of this layout active - newly created items will be children of the parent layout

Returns:	self
Note:	can safely be called several times

ImportLayout.setup(**kwargs)¶

Apply the given setup to the form layout, specified using kwargs

Parameter:	kwargs – arguments you would set use to setup the form layout

ImportLayout.shortName()¶

Returns:	shortname of the ui ( name without pipes )

ImportLayout.split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

ImportLayout.splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

ImportLayout.startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

ImportLayout.strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

ImportLayout.supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

ImportLayout.swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

ImportLayout.title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

ImportLayout.translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

ImportLayout.type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

ImportLayout.uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

ImportLayout.upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

ImportLayout.zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: animio.ui

class animio.ui.Namespace¶

Bases: unicode, mrv.interface.iDagItem

Represents a Maya namespace Namespaces follow the given nameing conventions:

Paths starting with a column are absolute

:absolute:path

Path separator is ‘:’

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(predicate=<function <lambda> at 0x4409320>)¶

Returns:	list of child namespaces
Parameter:	predicate – return True to include x in result

childrenDeep(order=1, predicate=<function <lambda> at 0x2b08e713c0c8>)¶

Returns:	list of all children of path, [ child1 , child2 ]
Parameters:	order – order enumeration predicate – returns true if x may be returned
Note:	the child objects returned are supposed to be valid paths, not just relative paths

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

classmethod create(*args, **kwargs)¶: This is the long version of the method as it is slightly faster than simply using the StartUndo helper

classmethod current()¶

Returns:	the currently set absolute namespace

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

defaultIncrFunc(b, i)¶: %s%02i

delete(move_to_namespace=':', autocreate=True)¶

Delete this namespace and move it’s obejcts to the given move_to_namespace

Raises RuntimeError:
Parameters:	move_to_namespace – if None, the namespace to be deleted must be empty If Namespace, objects in this namespace will be moved there prior to namespace deletion move_to_namespace must exist autocreate – if True, move_to_namespace will be created if it does not exist yet
Note:	can handle sub-namespaces properly

Todo:	Implement undo !

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this namespace exists

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

classmethod findUnique(basename, incrementFunc=<function <lambda> at 0x4404cf8>)¶

Find a unique namespace based on basename which does not yet exist in the scene and can be created.

Parameters:	basename – basename of the namespace, like “:mynamespace” or “mynamespace:subspace” incrementFunc – func( basename, index ), returns a unique name generated from the basename and the index representing the current iteration
Returns:	unique namespace that is guaranteed not to exist below the current namespace

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isAbsolute()¶

Returns:	True if this namespace is an absolut one, defining a namespace from the root namespace like “:foo:bar

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterNodes(*args, **kwargs)¶

Return an iterator on all objects in the namespace

Parameters:

args – MFn.kType filter types to be used to pre-filter the nodes in the namespace. This can greatly improve performance !
kwargs –
given to iterDagNodes or iterDgNodes, which includes the option to provide a predicate function. Additionally, the following ones may be defined:
- asNode:
  
  if true, default True, Nodes will be yielded. If False, you will receive MDagPaths or MObjects depending on the ‘dag’ kwarg
- dag:
  
  if True, default False, only dag nodes will be returned, otherwise you will receive dag nodes and dg nodes. Instance information will be lost on the way though.
- depth:
  
  if 0, default 0, only objects in this namespace will be returned
  if -1, all subnamespaces will be included as well, the depth is unlimited
  
  if 0<depth<x include all objects up to the ‘depth’ subnamespace

Note:

this method is quite similar to FileReference.iterNodes, but has a different feature set and needs this code here for maximum performance

iterParents(predicate=<function <lambda> at 0x2b08e713c2a8>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(sequence) -> unicode

Return a string which is the concatenation of the strings in the sequence. The separator between elements is S.

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

moveNodes(targetNamespace, force=True, autocreate=True)¶

Move objects from this to the targetNamespace

Parameters:	force – if True, namespace clashes will be resolved by renaming, if false possible clashes would result in an error autocreate – if True, targetNamespace will be created if it does not exist yet
Todo:	Implement undo !

parent()¶

Returns:	parent namespace of this instance

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

relativeTo(basenamespace)¶

returns this namespace relative to the given basenamespace

Raises ValueError:
Parameter:	basenamespace – the namespace to which the returned one should be relative too
	If this or basenamespace is not absolute or if no relative namespace exists
Returns:	relative namespace

rename(newName)¶

Rename this namespace to newName - the original namespace will cease to exist

Note:	if the namespace already exists, the existing one will be returned with all objects from this one added accordingly
Parameter:	newName – the absolute name of the new namespace
Returns:	Namespace with the new name
Todo:	Implement undo !

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (tail, sep, head)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

setCurrent(*args, **kwargs)¶: This is the long version of the method as it is slightly faster than simply using the StartUndo helper

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

classmethod splitNamespace(objectname)¶

Cut the namespace from the given name and return a tuple( namespacename, objectname )

Note:	method assumes that the namespace starts at the beginning of the object

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

substitute(find_in, replacement)¶

Returns:	string with our namespace properly substituted with replacement such that the result is a properly formatted object name ( with or without namespace depending of the value of replacement ) As this method is based on string replacement, self might as well match sub-namespaces if it is relative
Note:	if replacement is an empty string, it will effectively cut the matched namespace off the object name
Note:	handles replacement of subnamespaces correctly as well
Note:	as it operates on strings, the actual namespaces do not need to exist

classmethod substituteNamespace(thisns, find_in, replacement)¶: Same as substitute, but signature might feel more natural

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

toRelative()¶

Returns:	a relative version of self, thus it does not start with a colon
Note:	the root namespace cannot be relative - if this is of interest for you, you have to check for it. This method gracefully ignores that fact to make it more convenient to use as one does not have to be afraid of exceptions

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: animio.ui.NodeSelector

class animio.ui.NodeSelector(*args, **kwargs)¶

Bases: mrv.maya.ui.TextScrollList

Element allowing the user to select nodes. Either selected ones, or by namespace. The interface provides methods to retrieve that information

Note:	requires update once the scene changes - the parent is responsible for this

classmethod activeParent()¶

Raises RuntimeError:
Returns:	NameUI of the currently set parent
	if no active parent was set

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

annotation()¶: :return : the annotation string

basename()¶

Returns:	basename of this path, ‘/hello/world’ -> ‘world’

capitalize¶

S.capitalize() -> unicode

Return a capitalized version of S, i.e. make the first character have upper case.

center¶

S.center(width[, fillchar]) -> unicode

Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

children(**kwargs)¶

Returns:	all intermediate child instances
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

childrenDeep(**kwargs)¶

Returns:	all child instances recursively
Note:	the order of children is lexically ordered at this time
Note:	this implementation is slow and should be overridden by more specialized subclasses

clearAllEvents()¶

Remove all event receivers for all events registered in this instance.

Note:	This usually doesn’t need to be called directly, but might be useful in conjunction with other system that do not release your strongly bound instance

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

decode¶

S.decode([encoding[,errors]]) -> string or unicode

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registerd with codecs.register_error that is able to handle UnicodeDecodeErrors.

delete()¶: Delete this UI - the wrapper instance must not be used after this call

dimension()¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

e_dcc¶: Event suitable to deal with user interface callback

e_deleteKeyCommand¶: Event suitable to deal with user interface callback

e_dgc¶: Event suitable to deal with user interface callback

e_dkc¶: Event suitable to deal with user interface callback

e_doubleClickCommand¶: Event suitable to deal with user interface callback

e_dpc¶: Event suitable to deal with user interface callback

e_dragCallback¶: Event suitable to deal with user interface callback

e_dropCallback¶: Event suitable to deal with user interface callback

e_sc¶: Event suitable to deal with user interface callback

e_selectCommand¶: Event suitable to deal with user interface callback

encode¶

S.encode([encoding[,errors]]) -> string or unicode

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

Returns:	True if this instance still exists in maya

expandtabs¶

S.expandtabs([tabsize]) -> unicode

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdecimal¶

S.isdecimal() -> bool

Return True if there are only decimal characters in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

isnumeric¶

S.isnumeric() -> bool

Return True if there are only numeric characters in S, False otherwise.

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x2b08e713c2a8>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

iter_nodes(*args, **kwargs)¶

Returns:	iterator yielding all selected nodes ( if set by the user ) as well as all nodes in all selected namespaces
Parameters:	args – passed to `Namespace.iterNodes` *kwargs – passed to `Namespace.iterNodes`
Note:	args and *kwargs are passed to `iterSelectionList` as good

as applicable

join¶

S.join(sequence) -> unicode

Return a string which is the concatenation of the strings in the sequence. The separator between elements is S.

classmethod listEventNames()¶

Returns:	list of event ids that exist on our class

ljust¶

S.ljust(width[, fillchar]) -> int

Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> unicode

Return a copy of the string S converted to lowercase.

lstrip¶

S.lstrip([chars]) -> unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

p_a¶

p_aas¶

p_ai¶

p_allItems¶

p_allowAutomaticSelection¶

p_allowMultiSelection¶

p_ams¶

p_ann¶: :return : the annotation string

p_annotation¶: :return : the annotation string

p_ap¶

p_append¶

p_appendPosition¶

p_backgroundColor¶

p_bgc¶

p_da¶

p_defineTemplate¶

p_deselectAll¶

p_deselectIndexedItem¶

p_deselectItem¶

p_di¶

p_dii¶

p_dimension¶

Returns:	(x,y) tuple of x and y dimensions of the UI element

p_doctTag¶

p_dt¶

p_dtg¶

p_en¶

p_enable¶

p_ex¶

Returns:	True if this instance still exists in maya

p_exists¶

Returns:	True if this instance still exists in maya

p_fn¶

p_font¶

p_h¶

p_height¶

p_io¶

p_isObscured¶

p_m¶

p_manage¶

p_ni¶

p_npm¶

p_nr¶

p_nsi¶

p_numberOfItems¶

p_numberOfPopupMenus¶

p_numberOfRows¶

p_numberOfSelectedItems¶

p_pma¶

Returns:	popup menus attached to this control

p_po¶

p_popupMenuArray¶

Returns:	popup menus attached to this control

p_preventOverride¶

p_raremoveItem¶

p_removeAll¶

p_removeIndexedItem¶

p_ri¶

p_rii¶

p_selectIndexedItem¶

p_selectItem¶

p_shi¶

p_showIndexedItem¶

p_si¶

p_sii¶

p_useTemplate¶

p_ut¶

p_vis¶

p_visible¶

p_w¶

p_width¶

parent()¶

Returns:	parent instance of this ui element

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

popupMenuArray()¶

Returns:	popup menus attached to this control

replace¶

S.replace (old, new[, count]) -> unicode

Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> unicode

Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (tail, sep, head)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

select_namespaces(iter_ns)¶: Select the given namespaces on our list if they exist. :param iter_ns: iterable yielding namespace objects - they must be absolute :return: self

selected_namespaces()¶

Returns:	list(Namespace, ...) list of Namespace objects which have

been selected

sender()¶

Raises ValueError:
Returns:	instance which sent the event you are currently processing
	if no event is currently in progress

setAnnotation(ann)¶: Set the UI element’s annotation :note: not all named UI elements can have their annotation set

setDimension(dimension)¶: Set the UI elements dimension :param dimension: (x,y) : tuple holding desired x and y dimension

setFocus()¶: Set the global keyboard focus to this control

set_show_selected(state)¶: If state is True, we will allow the user to pick ‘selected nodes’ :return: self

set_uses_selection(state)¶: Sets this element to return selected nodes when queried in ‘iter_nodes’ if state is True :note: only works if set_show_selected was called with a True value :return: self

shortName()¶

Returns:	shortname of the ui ( name without pipes )

show_seleted()¶

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip¶

S.strip([chars]) -> unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> unicode

Return a copy of S with uppercase characters converted to lowercase and vice versa.

title¶

S.title() -> unicode

Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

translate¶

S.translate(table) -> unicode

Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

type()¶

Returns:	the python class able to create this class
Note:	The return value is NOT the type string, but a class

uiDeleted()¶

If overridden in subclass, it will be called once the UI gets deleted within maya ( i.e. the user closed the window )eee The base implementation assures that all event-receivers that are bound to your events will be freed, allowing them to possibly be destroyed as well.

Use this callback to register yourself from all your event senders, then call the base class method.

Note:	This is not related to the __del__ method of your object. Its worth noting that your instance will be strongly bound to a maya event, hence your instance will exist as long as your user interface element exists within maya.

update()¶: Call to force the element to update according to the contents of the scene

upper¶

S.upper() -> unicode

Return a copy of S converted to uppercase.

uses_selection()¶

Returns:	True if the user wants to handle selected nodes

zfill¶

S.zfill(width) -> unicode

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: animio.ui

class animio.ui.Path¶

Bases: str, mrv.interface.iDagItem

Represents a filesystem path.

For documentation on individual methods, consult their counterparts in os.path.

abspath()¶

access(mode)¶

Return true if current user has access to this path.

mode - One of the constants os.F_OK, os.R_OK, os.W_OK, os.X_OK

classmethod addSep(item, sep)¶

Returns:	item with separator added to it ( just once )
Note:	operates best on strings
Parameters:	item – item to add separator to sep – the separator

atime()¶

basename(p)¶: Returns the final component of a pathname

bytes()¶: Open this file, read all bytes, return them as a string.

capitalize¶

S.capitalize() -> string

Return a copy of the string S with only its first character capitalized.

center¶

S.center(width[, fillchar]) -> string

Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

children(predicate=<function <lambda> at 0x2b08e713ab18>, pattern=None)¶

Returns:	child paths as retrieved by queryiing the file system.
Note:	files cannot have children, and willl return an empty array accordingly
Parameters:	predicate – return p if predicate( p ) returns True pattern – list only elements that match the given simple pattern i.e. .

childrenDeep(order=1, predicate=<function <lambda> at 0x2b08e713c0c8>)¶

Returns:	list of all children of path, [ child1 , child2 ]
Parameters:	order – order enumeration predicate – returns true if x may be returned
Note:	the child objects returned are supposed to be valid paths, not just relative paths

chmod(mode)¶

Change file mode

Returns:	self

chown(uid, gid)¶

Change file ownership

Returns:	self

chroot()¶

Change the root directory path

Returns:	self

containsvars()¶

Returns:	True if this path contains environment variables

copy(dest)¶

Copy data and source bits to dest

Returns:	Path to dest

copy2(dest)¶

Shutil.copy2 self to dest

Returns:	Path to dest

copyfile(dest)¶

Copy self to dest

Returns:	Path to dest

copymode(dest)¶

Copy our mode to dest

Returns:	Path to dest

copystat(dest)¶

Copy our stats to dest

Returns:	Path to dest

copytree(dest, **kwargs)¶

Deep copy this file or directory to destination

Parameter:	kwargs – passed to shutil.copytree
Returns:	Path to dest

count¶

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

ctime()¶

decode¶

S.decode([encoding[,errors]]) -> object

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registered with codecs.register_error that is able to handle UnicodeDecodeErrors.

digest(hashobject)¶

Calculate the hash for this file using the given hashobject. It must support the ‘update’ and ‘digest’ methods.

Note:	This reads through the entire file.

dirname()¶

dirs(pattern=None)¶

D.dirs() -> List of this directory’s subdirectories.

The elements of the list are path objects. This does not walk recursively into subdirectories (but see path.walkdirs).

With the optional pattern argument, this only lists directories whose names match the given pattern. For example, d.dirs(“build-*”).

drive()¶: The drive specifier, for example ‘C:’. This is always empty on systems that don’t use drive specifiers.

encode¶

S.encode([encoding[,errors]]) -> object

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that is able to handle UnicodeEncodeErrors.

endswith¶

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()¶

expand()¶

Clean up a filename by calling expandvars() and expanduser()

This is commonly everything needed to clean up a filename read from a configuration file, for example.

If you are not interested in trailing slashes, you should call normpath() on the resulting Path as well.

expand_or_raise()¶

Raises ValueError:
Returns:	Copy of self with all variables expanded ( using expand )
	If we could not expand all environment variables as their values where missing in the environment

expandtabs¶

S.expandtabs([tabsize]) -> string

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

expanduser()¶

expandvars()¶

ext()¶: The file extension, for example ‘.py’.

files(pattern=None)¶

D.files() -> List of the files in this directory.

The elements of the list are path objects. This does not walk into subdirectories (see path.walkfiles).

With the optional pattern argument, this only lists files whose names match the given pattern. For example, d.files(“*.pyc”).

find¶

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

fnmatch(pattern)¶

Return True if self.basename() matches the given pattern.

pattern - A filename pattern with wildcards,: for example “*.py”.

format¶: S.format(*args, **kwargs) -> unicode

fullChildName(childname)¶: Add the given name to the string version of our instance :return: string with childname added like name _sep childname

classmethod getcwd()¶

Returns:	the current working directory as a path object.

glob(pattern)¶

Return a list of path objects that match the pattern.

pattern - a path relative to this directory, with wildcards.

For example, path(‘/users’).glob(‘/bin/‘) returns a list of all the files users have in their bin directories.

index¶

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)¶

Returns:	True if self is a part of other, and thus can be found in other
Note:	operates on strings only

isRoot()¶

Returns:	True if this path is the root of the DAG

isRootOf(other)¶

Returns:	True other starts with self
Note:	operates on strings
Note:	we assume other has the same type as self, thus the same separator

isWritable()¶

Returns:	true if the file can be written to

isabs(s)¶: Test whether a path is absolute

isalnum¶

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha¶

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdigit¶

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isdir()¶

isfile()¶

islink()¶

islower¶

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

ismount()¶

isspace¶

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle¶

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. uppercase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper¶

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x2b08e713c2a8>)¶

Returns:	generator retrieving all parents up to the root
Parameter:	predicate – returns True for all x that you want to be returned

join¶

S.join(sequence) -> string

Return a string which is the concatenation of the strings in the sequence. The separator between elements is S.

joinpath(*args)¶: Join two or more path components, adding a separator character (os.sep) if needed. Returns a new path object.

lexists()¶

lines(encoding=None, errors='strict', retain=True)¶

Open this file, read all lines, return them in a list.

Optional arguments:

encoding: The Unicode encoding (or character set) of

the file. The default is None, meaning the content of the file is read as 8-bit characters and returned as a list of (non-Unicode) str objects.
errors: How to handle Unicode errors; see help(str.decode)

for the options. Default is ‘strict’
retain: If true, retain newline characters; but all newline

character combinations (“r”, “n”, “rn”) are translated to “n”. If false, newline characters are stripped off. Default is True.

This uses “U” mode in Python 2.3 and later.

link(newpath)¶

Create a hard link at ‘newpath’, pointing to this file.

Returns:	Path to newpath

listdir(pattern=None)¶

return list of items in this directory.

Use D.files() or D.dirs() instead if you want a listing of just files or just subdirectories.

The elements of the list are path objects.

With the optional ‘pattern’ argument, this only lists items whose names match the given pattern.

ljust¶

S.ljust(width[, fillchar]) -> string

Return S left-justified in a string of length width. Padding is done using the specified fill character (default is a space).

lower¶

S.lower() -> string

Return a copy of the string S converted to lowercase.

lstat()¶: Like path.stat(), but do not follow symbolic links.

lstrip¶

S.lstrip([chars]) -> string or unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

makedirs(mode=511)¶

Smarter makedir, see os.makedirs

Returns:	self

mkdir(mode=511)¶

Make this directory, fail if it already exists

Returns:	self

move(dest)¶

Move self to dest

Returns:	Path to dest

mtime()¶

namebase()¶

The same as path.basename(), but with one file extension stripped off.

For example, path(‘/home/guido/python.tar.gz’).name == ‘python.tar.gz’, but path(‘/home/guido/python.tar.gz’).namebase == ‘python.tar’

normcase()¶

normpath()¶

open(*args, **kwargs)¶: Open this file. Return a file object.

owner()¶

Return the name of the owner of this file or directory.

This follows symbolic links.

On Windows, this returns a name of the form ur’DOMAINUser Name’. On Windows, a group can own a file or directory.

parent()¶

Returns:	the parent directory of this Path or None if this is the root

parentDeep()¶

Returns:	all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition¶

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

pathconf(name)¶: see os.pathconf

readlink()¶

Return the path to which this symbolic link points.

The result may be an absolute or a relative path.

readlinkabs()¶

Return the path to which this symbolic link points.

The result is always an absolute path.

realpath()¶

relpath()¶: Return this path as a relative path, originating from the current working directory.

relpathfrom(dest)¶: Return a relative path from dest to self

relpathto(dest)¶

Return a relative path from self to dest.

If there is no relative path from self to dest, for example if they reside on different drives in Windows, then this returns dest.abspath().

remove()¶

Remove this file

Returns:	self

removedirs()¶

see os.removedirs

Returns:	self

rename(new)¶

os.rename

Returns:	Path to new file

renames(new)¶

os.renames, super rename

Returns:	Path to new file

replace¶

S.replace (old, new[, count]) -> string

Return a copy of string S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind¶

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex¶

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust¶

S.rjust(width[, fillchar]) -> string

Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space)

rmdir()¶

Remove this empty directory

Returns:	self

rmtree(**kwargs)¶

Remove self recursively

Parameter:	kwargs – passed to shutil.rmtree
Returns:	self

root()¶

Returns:	the root of the DAG - it has no further parents

rpartition¶

S.rpartition(sep) -> (tail, sep, head)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit¶

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in the string S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator.

rstrip¶

S.rstrip([chars]) -> string or unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

samefile(other)¶

setutime(times)¶

Set the access and modified times of this file.

Returns:	self

size()¶

split¶

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in the string S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitall()¶

Return a list of the path components in this path.

The first item in the list will be a path. Its value will be either os.curdir, os.pardir, empty, or the root directory of this path (for example, ‘/’ or ‘C:’). The other items in the list will be strings.

path.path.joinpath(*result) will yield the original path.

splitdrive()¶

p.splitdrive() -> Return (p.drive, <the rest of p>).

Split the drive specifier from this path. If there is no drive specifier, p.drive is empty, so the return value is simply (path(‘’), p). This is always the case on Unix.

splitext()¶

p.splitext() -> Return (p.stripext(), p.ext).

Split the filename extension from this path and return the two parts. Either part may be empty.

The extension is everything from ‘.’ to the end of the last path segment. This has the property that if (a, b) == p.splitext(), then a + b == p.

splitlines¶

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

splitpath()¶: p.splitpath() -> Return (p.parent(), p.basename()).

startswith¶

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

stat()¶: Perform a stat() system call on this path.

statvfs()¶: Perform a statvfs() system call on this path.

strip¶

S.strip([chars]) -> string or unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

stripext()¶

p.stripext() -> Remove one file extension from the path.

For example, path(‘/home/guido/python.tar.gz’).stripext() returns path(‘/home/guido/python.tar’).

supports(interface_type)¶

Returns:	True if this instance supports the interface of the given type
Parameter:	interface_type – Type of the interface you require this instance to support
Note:	Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase¶

S.swapcase() -> string

Return a copy of the string S with uppercase characters converted to lowercase and vice versa.

symlink(newlink)¶

Create a symbolic link at ‘newlink’, pointing here.

Returns:	Path to newlink

text(encoding=None, errors='strict')¶

Open this file, read it in, return the content as a string.

This uses “U” mode in Python 2.3 and later, so “rn” and “r” are automatically translated to ‘n’.

Optional arguments:

encoding - The Unicode encoding (or character set) of the file. If present, the content of the file is decoded and returned as a unicode object; otherwise it is returned as an 8-bit str.
errors - How to handle Unicode errors; see help(str.decode) for the options. Default is ‘strict’.

title¶

S.title() -> string

Return a titlecased version of S, i.e. words start with uppercase characters, all remaining cased characters have lowercase.

tonative()¶

Convert the path separator to the type required by the current operating system - on windows / becomes and on linux becomes /

Returns:	native version of self

touch(flags=65, mode=438)¶

Set the access/modified times of this file to the current time. Create the file if it does not exist.

Returns:	self

translate¶

S.translate(table [,deletechars]) -> string

Return a copy of the string S, where all characters occurring in the optional argument deletechars are removed, and the remaining characters have been mapped through the given translation table, which must be a string of length 256.

unlink()¶

unlink this file

Returns:	self

upper¶

S.upper() -> string

Return a copy of the string S converted to uppercase.

walk(pattern=None, errors='strict', predicate=<function <lambda> at 0x2b08e713dcf8>)¶

create iterator over files and subdirs, recursively.

The iterator yields path objects naming each child item of this directory and its descendants.

It performs a depth-first traversal of the directory tree. Each directory is returned just before all its children.

Parameters:	pattern – fnmatch compatible pattern or None errors – controls behavior when an error occurs. The default is ‘strict’, which causes an exception. The other allowed values are ‘warn’, which reports the error via log.warn(), and ‘ignore’. predicate – returns True for each Path p to be yielded by iterator

walkdirs(pattern=None, errors='strict', predicate=<function <lambda> at 0x2b08e713dde8>)¶: D.walkdirs() -> iterator over subdirs, recursively. see walk for a parameter description

walkfiles(pattern=None, errors='strict', predicate=<function <lambda> at 0x2b08e713ded8>)¶: D.walkfiles() -> iterator over files in D, recursively. see walk for a parameter description

write_bytes(bytes, append=False)¶

Open this file and write the given bytes to it.

Default behavior is to overwrite any existing file. Call p.write_bytes(bytes, append=True) to append instead. :return: self

write_lines(lines, encoding=None, errors='strict', linesep='n', append=False)¶

Write the given lines of text to this file.

By default this overwrites any existing file at this path.

This puts a platform-specific newline sequence on every line. See ‘linesep’ below.

lines - A list of strings.

encoding - A Unicode encoding to use. This applies only if: ‘lines’ contains any Unicode strings.
errors - How to handle errors in Unicode encoding. This: also applies only to Unicode strings.
linesep - The desired line-ending. This line-ending is: applied to every line. If a line already has any standard line ending, that will be stripped off and this will be used instead. The default is os.linesep, which is platform-dependent (‘rn’ on Windows, ‘n’ on Unix, etc.) Specify None to write the lines as-is, like file.writelines().

Use the keyword argument append=True to append lines to the file. The default is to overwrite the file. Warning: When you use this with Unicode data, if the encoding of the existing data in the file is different from the encoding you specify with the encoding= parameter, the result is mixed-encoding data, which can really confuse someone trying to read the file later.

Returns:	self

write_text(text, encoding=None, errors='strict', linesep='n', append=False)¶

Write the given text to this file.

The default behavior is to overwrite any existing file; to append instead, use the ‘append=True’ keyword argument.

There are two differences between path.write_text() and path.write_bytes(): newline handling and Unicode handling. See below.

Parameters:

text - str/unicode - The text to be written.
encoding - str - The Unicode encoding that will be used.

This is ignored if ‘text’ isn’t a Unicode string.
errors - str - How to handle Unicode encoding errors.

Default is ‘strict’. See help(unicode.encode) for the options. This is ignored if ‘text’ isn’t a Unicode string.
linesep - keyword argument - str/unicode - The sequence of

characters to be used to mark end-of-line. The default is os.linesep. You can also specify None; this means to leave all newlines as they are in ‘text’.
append - keyword argument - bool - Specifies what to do if

the file already exists (True: append to the end of it; False: overwrite it.) The default is False.

Newline handling:

write_text() converts all standard end-of-line sequences

(“n”, “r”, and “rn”) to your platforms default end-of-line sequence (see os.linesep; on Windows, for example, the end-of-line marker is “rn”).
If you don’t like your platform’s default, you can override it

using the “linesep=” keyword argument. If you specifically want write_text() to preserve the newlines as-is, use “linesep=None”.
This applies to Unicode text the same as to 8-bit text, except

there are additional standard Unicode end-of-line sequences, check the code to see them.
(This is slightly different from when you open a file for

writing with fopen(filename, “w”) in C or file(filename, “w”) in Python.)

Unicode:

If “text” isn’t Unicode, then apart from newline handling, the bytes are written verbatim to the file. The “encoding” and ‘errors’ arguments are not used and must be omitted.

If ‘text’ is Unicode, it is first converted to bytes using the specified ‘encoding’ (or the default encoding if ‘encoding’ isn’t specified). The ‘errors’ argument applies only to this conversion.

Returns:	self

zfill¶

S.zfill(width) -> string

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: animio.ui

class animio.ui.chain¶

Bases: object

chain(*iterables) –> chain object

Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

static from_iterable()¶

chain.from_iterable(iterable) –> chain object

Alternate chain() contructor taking a single iterable argument that evaluates lazily.

next¶: x.next() -> the next value, or raise StopIteration

`animio.ui`¶

Functions¶

Classes¶

Table Of Contents

Previous topic

This Page

Navigation

animio.ui¶

Functions¶

Classes¶

Table Of Contents

Previous topic

This Page

Quick search

Navigation

`animio.ui`¶