<!--{{{-->
<link rel='alternate' type='application/rss+xml' title='RSS' href='index.xml'/>
<!--}}}-->
Background: #fff
Foreground: #000
PrimaryPale: #8cf
PrimaryLight: #18f
PrimaryMid: #04b
PrimaryDark: #014
SecondaryPale: #ffc
SecondaryLight: #fe8
SecondaryMid: #db4
SecondaryDark: #841
TertiaryPale: #eee
TertiaryLight: #ccc
TertiaryMid: #999
TertiaryDark: #666
Error: #f88
/*{{{*/
body {background:[[ColorPalette::Background]]; color:[[ColorPalette::Foreground]];}

a {color:[[ColorPalette::PrimaryMid]];}
a:hover {background-color:[[ColorPalette::PrimaryMid]]; color:[[ColorPalette::Background]];}
a img {border:0;}

h1,h2,h3,h4,h5,h6 {color:[[ColorPalette::SecondaryDark]]; background:transparent;}
h1 {border-bottom:2px solid [[ColorPalette::TertiaryLight]];}
h2,h3 {border-bottom:1px solid [[ColorPalette::TertiaryLight]];}

.button {color:[[ColorPalette::PrimaryDark]]; border:1px solid [[ColorPalette::Background]];}
.button:hover {color:[[ColorPalette::PrimaryDark]]; background:[[ColorPalette::SecondaryLight]]; border-color:[[ColorPalette::SecondaryMid]];}
.button:active {color:[[ColorPalette::Background]]; background:[[ColorPalette::SecondaryMid]]; border:1px solid [[ColorPalette::SecondaryDark]];}

.header {background:[[ColorPalette::PrimaryMid]];}
.headerShadow {color:[[ColorPalette::Foreground]];}
.headerShadow a {font-weight:normal; color:[[ColorPalette::Foreground]];}
.headerForeground {color:[[ColorPalette::Background]];}
.headerForeground a {font-weight:normal; color:[[ColorPalette::PrimaryPale]];}

.tabSelected{color:[[ColorPalette::PrimaryDark]];
background:[[ColorPalette::TertiaryPale]];
border-left:1px solid [[ColorPalette::TertiaryLight]];
border-top:1px solid [[ColorPalette::TertiaryLight]];
border-right:1px solid [[ColorPalette::TertiaryLight]];
}
.tabUnselected {color:[[ColorPalette::Background]]; background:[[ColorPalette::TertiaryMid]];}
.tabContents {color:[[ColorPalette::PrimaryDark]]; background:[[ColorPalette::TertiaryPale]]; border:1px solid [[ColorPalette::TertiaryLight]];}
.tabContents .button {border:0;}

#sidebar {}
#sidebarOptions input {border:1px solid [[ColorPalette::PrimaryMid]];}
#sidebarOptions .sliderPanel {background:[[ColorPalette::PrimaryPale]];}
#sidebarOptions .sliderPanel a {border:none;color:[[ColorPalette::PrimaryMid]];}
#sidebarOptions .sliderPanel a:hover {color:[[ColorPalette::Background]]; background:[[ColorPalette::PrimaryMid]];}
#sidebarOptions .sliderPanel a:active {color:[[ColorPalette::PrimaryMid]]; background:[[ColorPalette::Background]];}

.wizard {background:[[ColorPalette::PrimaryPale]]; border:1px solid [[ColorPalette::PrimaryMid]];}
.wizard h1 {color:[[ColorPalette::PrimaryDark]]; border:none;}
.wizard h2 {color:[[ColorPalette::Foreground]]; border:none;}
.wizardStep {background:[[ColorPalette::Background]]; color:[[ColorPalette::Foreground]];
border:1px solid [[ColorPalette::PrimaryMid]];}
.wizardStep.wizardStepDone {background:[[ColorPalette::TertiaryLight]];}
.wizardFooter {background:[[ColorPalette::PrimaryPale]];}
.wizardFooter .status {background:[[ColorPalette::PrimaryDark]]; color:[[ColorPalette::Background]];}
.wizard .button {color:[[ColorPalette::Foreground]]; background:[[ColorPalette::SecondaryLight]]; border: 1px solid;
border-color:[[ColorPalette::SecondaryPale]] [[ColorPalette::SecondaryDark]] [[ColorPalette::SecondaryDark]] [[ColorPalette::SecondaryPale]];}
.wizard .button:hover {color:[[ColorPalette::Foreground]]; background:[[ColorPalette::Background]];}
.wizard .button:active {color:[[ColorPalette::Background]]; background:[[ColorPalette::Foreground]]; border: 1px solid;
border-color:[[ColorPalette::PrimaryDark]] [[ColorPalette::PrimaryPale]] [[ColorPalette::PrimaryPale]] [[ColorPalette::PrimaryDark]];}

#messageArea {border:1px solid [[ColorPalette::SecondaryMid]]; background:[[ColorPalette::SecondaryLight]]; color:[[ColorPalette::Foreground]];}
#messageArea .button {color:[[ColorPalette::PrimaryMid]]; background:[[ColorPalette::SecondaryPale]]; border:none;}

.popupTiddler {background:[[ColorPalette::TertiaryPale]]; border:2px solid [[ColorPalette::TertiaryMid]];}

.popup {background:[[ColorPalette::TertiaryPale]]; color:[[ColorPalette::TertiaryDark]]; border-left:1px solid [[ColorPalette::TertiaryMid]]; border-top:1px solid [[ColorPalette::TertiaryMid]]; border-right:2px solid [[ColorPalette::TertiaryDark]]; border-bottom:2px solid [[ColorPalette::TertiaryDark]];}
.popup hr {color:[[ColorPalette::PrimaryDark]]; background:[[ColorPalette::PrimaryDark]]; border-bottom:1px;}
.popup li.disabled {color:[[ColorPalette::TertiaryMid]];}
.popup li a, .popup li a:visited {color:[[ColorPalette::Foreground]]; border: none;}
.popup li a:hover {background:[[ColorPalette::SecondaryLight]]; color:[[ColorPalette::Foreground]]; border: none;}
.popup li a:active {background:[[ColorPalette::SecondaryPale]]; color:[[ColorPalette::Foreground]]; border: none;}
.popupHighlight {background:[[ColorPalette::Background]]; color:[[ColorPalette::Foreground]];}
.listBreak div {border-bottom:1px solid [[ColorPalette::TertiaryDark]];}

.tiddler .defaultCommand {font-weight:bold;}

.shadow .title {color:[[ColorPalette::TertiaryDark]];}

.title {color:[[ColorPalette::SecondaryDark]];}
.subtitle {color:[[ColorPalette::TertiaryDark]];}

.toolbar {color:[[ColorPalette::PrimaryMid]];}
.toolbar a {color:[[ColorPalette::TertiaryLight]];}
.selected .toolbar a {color:[[ColorPalette::TertiaryMid]];}
.selected .toolbar a:hover {color:[[ColorPalette::Foreground]];}

.tagging, .tagged {border:1px solid [[ColorPalette::TertiaryPale]]; background-color:[[ColorPalette::TertiaryPale]];}
.selected .tagging, .selected .tagged {background-color:[[ColorPalette::TertiaryLight]]; border:1px solid [[ColorPalette::TertiaryMid]];}
.tagging .listTitle, .tagged .listTitle {color:[[ColorPalette::PrimaryDark]];}
.tagging .button, .tagged .button {border:none;}

.footer {color:[[ColorPalette::TertiaryLight]];}
.selected .footer {color:[[ColorPalette::TertiaryMid]];}

.sparkline {background:[[ColorPalette::PrimaryPale]]; border:0;}
.sparktick {background:[[ColorPalette::PrimaryDark]];}

.error, .errorButton {color:[[ColorPalette::Foreground]]; background:[[ColorPalette::Error]];}
.warning {color:[[ColorPalette::Foreground]]; background:[[ColorPalette::SecondaryPale]];}
.lowlight {background:[[ColorPalette::TertiaryLight]];}

.zoomer {background:none; color:[[ColorPalette::TertiaryMid]]; border:3px solid [[ColorPalette::TertiaryMid]];}

.imageLink, #displayArea .imageLink {background:transparent;}

.annotation {background:[[ColorPalette::SecondaryLight]]; color:[[ColorPalette::Foreground]]; border:2px solid [[ColorPalette::SecondaryMid]];}

.viewer .listTitle {list-style-type:none; margin-left:-2em;}
.viewer .button {border:1px solid [[ColorPalette::SecondaryMid]];}
.viewer blockquote {border-left:3px solid [[ColorPalette::TertiaryDark]];}

.viewer table, table.twtable {border:2px solid [[ColorPalette::TertiaryDark]];}
.viewer th, .viewer thead td, .twtable th, .twtable thead td {background:[[ColorPalette::SecondaryMid]]; border:1px solid [[ColorPalette::TertiaryDark]]; color:[[ColorPalette::Background]];}
.viewer td, .viewer tr, .twtable td, .twtable tr {border:1px solid [[ColorPalette::TertiaryDark]];}

.viewer pre {border:1px solid [[ColorPalette::SecondaryLight]]; background:[[ColorPalette::SecondaryPale]];}
.viewer code {color:[[ColorPalette::SecondaryDark]];}
.viewer hr {border:0; border-top:dashed 1px [[ColorPalette::TertiaryDark]]; color:[[ColorPalette::TertiaryDark]];}

.highlight, .marked {background:[[ColorPalette::SecondaryLight]];}

.editor input {border:1px solid [[ColorPalette::PrimaryMid]];}
.editor textarea {border:1px solid [[ColorPalette::PrimaryMid]]; width:100%;}
.editorFooter {color:[[ColorPalette::TertiaryMid]];}

#backstageArea {background:[[ColorPalette::Foreground]]; color:[[ColorPalette::TertiaryMid]];}
#backstageArea a {background:[[ColorPalette::Foreground]]; color:[[ColorPalette::Background]]; border:none;}
#backstageArea a:hover {background:[[ColorPalette::SecondaryLight]]; color:[[ColorPalette::Foreground]]; }
#backstageArea a.backstageSelTab {background:[[ColorPalette::Background]]; color:[[ColorPalette::Foreground]];}
#backstageButton a {background:none; color:[[ColorPalette::Background]]; border:none;}
#backstageButton a:hover {background:[[ColorPalette::Foreground]]; color:[[ColorPalette::Background]]; border:none;}
#backstagePanel {background:[[ColorPalette::Background]]; border-color: [[ColorPalette::Background]] [[ColorPalette::TertiaryDark]] [[ColorPalette::TertiaryDark]] [[ColorPalette::TertiaryDark]];}
.backstagePanelFooter .button {border:none; color:[[ColorPalette::Background]];}
.backstagePanelFooter .button:hover {color:[[ColorPalette::Foreground]];}
#backstageCloak {background:[[ColorPalette::Foreground]]; opacity:0.6; filter:'alpha(opacity:60)';}
/*}}}*/
/*{{{*/
* html .tiddler {height:1%;}

body {font-size:.75em; font-family:arial,helvetica; margin:0; padding:0;}

h1,h2,h3,h4,h5,h6 {font-weight:bold; text-decoration:none;}
h1,h2,h3 {padding-bottom:1px; margin-top:1.2em;margin-bottom:0.3em;}
h4,h5,h6 {margin-top:1em;}
h1 {font-size:1.35em;}
h2 {font-size:1.25em;}
h3 {font-size:1.1em;}
h4 {font-size:1em;}
h5 {font-size:.9em;}

hr {height:1px;}

a {text-decoration:none;}

dt {font-weight:bold;}

ol {list-style-type:decimal;}
ol ol {list-style-type:lower-alpha;}
ol ol ol {list-style-type:lower-roman;}
ol ol ol ol {list-style-type:decimal;}
ol ol ol ol ol {list-style-type:lower-alpha;}
ol ol ol ol ol ol {list-style-type:lower-roman;}
ol ol ol ol ol ol ol {list-style-type:decimal;}

.txtOptionInput {width:11em;}

#contentWrapper .chkOptionInput {border:0;}

.externalLink {text-decoration:underline;}

.indent {margin-left:3em;}
.outdent {margin-left:3em; text-indent:-3em;}
code.escaped {white-space:nowrap;}

.tiddlyLinkExisting {font-weight:bold;}
.tiddlyLinkNonExisting {font-style:italic;}

/* the 'a' is required for IE, otherwise it renders the whole tiddler in bold */
a.tiddlyLinkNonExisting.shadow {font-weight:bold;}

#mainMenu .tiddlyLinkExisting,
#mainMenu .tiddlyLinkNonExisting,
#sidebarTabs .tiddlyLinkNonExisting {font-weight:normal; font-style:normal;}
#sidebarTabs .tiddlyLinkExisting {font-weight:bold; font-style:normal;}

.header {position:relative;}
.header a:hover {background:transparent;}
.headerShadow {position:relative; padding:4.5em 0em 1em 1em; left:-1px; top:-1px;}
.headerForeground {position:absolute; padding:4.5em 0em 1em 1em; left:0px; top:0px;}

.siteTitle {font-size:3em;}
.siteSubtitle {font-size:1.2em;}

#mainMenu {position:absolute; left:0; width:10em; text-align:right; line-height:1.6em; padding:1.5em 0.5em 0.5em 0.5em; font-size:1.1em;}

#sidebar {position:absolute; right:3px; width:16em; font-size:.9em;}
#sidebarOptions {padding-top:0.3em;}
#sidebarOptions a {margin:0em 0.2em; padding:0.2em 0.3em; display:block;}
#sidebarOptions input {margin:0.4em 0.5em;}
#sidebarOptions .sliderPanel {margin-left:1em; padding:0.5em; font-size:.85em;}
#sidebarOptions .sliderPanel a {font-weight:bold; display:inline; padding:0;}
#sidebarOptions .sliderPanel input {margin:0 0 .3em 0;}
#sidebarTabs .tabContents {width:15em; overflow:hidden;}

.wizard {padding:0.1em 1em 0em 2em;}
.wizard h1 {font-size:2em; font-weight:bold; background:none; padding:0em 0em 0em 0em; margin:0.4em 0em 0.2em 0em;}
.wizard h2 {font-size:1.2em; font-weight:bold; background:none; padding:0em 0em 0em 0em; margin:0.4em 0em 0.2em 0em;}
.wizardStep {padding:1em 1em 1em 1em;}
.wizard .button {margin:0.5em 0em 0em 0em; font-size:1.2em;}
.wizardFooter {padding:0.8em 0.4em 0.8em 0em;}
.wizardFooter .status {padding:0em 0.4em 0em 0.4em; margin-left:1em;}
.wizard .button {padding:0.1em 0.2em 0.1em 0.2em;}

#messageArea {position:fixed; top:2em; right:0em; margin:0.5em; padding:0.5em; z-index:2000; _position:absolute;}
.messageToolbar {display:block; text-align:right; padding:0.2em 0.2em 0.2em 0.2em;}
#messageArea a {text-decoration:underline;}

.tiddlerPopupButton {padding:0.2em 0.2em 0.2em 0.2em;}
.popupTiddler {position: absolute; z-index:300; padding:1em 1em 1em 1em; margin:0;}

.popup {position:absolute; z-index:300; font-size:.9em; padding:0; list-style:none; margin:0;}
.popup .popupMessage {padding:0.4em;}
.popup hr {display:block; height:1px; width:auto; padding:0; margin:0.2em 0em;}
.popup li.disabled {padding:0.4em;}
.popup li a {display:block; padding:0.4em; font-weight:normal; cursor:pointer;}
.listBreak {font-size:1px; line-height:1px;}
.listBreak div {margin:2px 0;}

.tabset {padding:1em 0em 0em 0.5em;}
.tab {margin:0em 0em 0em 0.25em; padding:2px;}
.tabContents {padding:0.5em;}
.tabContents ul, .tabContents ol {margin:0; padding:0;}
.txtMainTab .tabContents li {list-style:none;}
.tabContents li.listLink { margin-left:.75em;}

#contentWrapper {display:block;}
#splashScreen {display:none;}

#displayArea {margin:1em 17em 0em 14em;}

.toolbar {text-align:right; font-size:.9em;}

.tiddler {padding:1em 1em 0em 1em;}

.missing .viewer,.missing .title {font-style:italic;}

.title {font-size:1.6em; font-weight:bold;}

.missing .subtitle {display:none;}
.subtitle {font-size:1.1em;}

.tiddler .button {padding:0.2em 0.4em;}

.tagging {margin:0.5em 0.5em 0.5em 0; float:left; display:none;}
.isTag .tagging {display:block;}
.tagged {margin:0.5em; float:right;}
.tagging, .tagged {font-size:0.9em; padding:0.25em;}
.tagging ul, .tagged ul {list-style:none; margin:0.25em; padding:0;}
.tagClear {clear:both;}

.footer {font-size:.9em;}
.footer li {display:inline;}

.annotation {padding:0.5em; margin:0.5em;}

* html .viewer pre {width:99%; padding:0 0 1em 0;}
.viewer {line-height:1.4em; padding-top:0.5em;}
.viewer .button {margin:0em 0.25em; padding:0em 0.25em;}
.viewer blockquote {line-height:1.5em; padding-left:0.8em;margin-left:2.5em;}
.viewer ul, .viewer ol {margin-left:0.5em; padding-left:1.5em;}

.viewer table, table.twtable {border-collapse:collapse; margin:0.8em 1.0em;}
.viewer th, .viewer td, .viewer tr,.viewer caption,.twtable th, .twtable td, .twtable tr,.twtable caption {padding:3px;}
table.listView {font-size:0.85em; margin:0.8em 1.0em;}
table.listView th, table.listView td, table.listView tr {padding:0px 3px 0px 3px;}

.viewer pre {padding:0.5em; margin-left:0.5em; font-size:1.2em; line-height:1.4em; overflow:auto;}
.viewer code {font-size:1.2em; line-height:1.4em;}

.editor {font-size:1.1em;}
.editor input, .editor textarea {display:block; width:100%; font:inherit;}
.editorFooter {padding:0.25em 0em; font-size:.9em;}
.editorFooter .button {padding-top:0px; padding-bottom:0px;}

.fieldsetFix {border:0; padding:0; margin:1px 0px 1px 0px;}

.sparkline {line-height:1em;}
.sparktick {outline:0;}

.zoomer {font-size:1.1em; position:absolute; overflow:hidden;}
.zoomer div {padding:1em;}

* html #backstage {width:99%;}
* html #backstageArea {width:99%;}
#backstageArea {display:none; position:relative; overflow: hidden; z-index:150; padding:0.3em 0.5em 0.3em 0.5em;}
#backstageToolbar {position:relative;}
#backstageArea a {font-weight:bold; margin-left:0.5em; padding:0.3em 0.5em 0.3em 0.5em;}
#backstageButton {display:none; position:absolute; z-index:175; top:0em; right:0em;}
#backstageButton a {padding:0.1em 0.4em 0.1em 0.4em; margin:0.1em 0.1em 0.1em 0.1em;}
#backstage {position:relative; width:100%; z-index:50;}
#backstagePanel {display:none; z-index:100; position:absolute; margin:0em 3em 0em 3em; padding:1em 1em 1em 1em;}
.backstagePanelFooter {padding-top:0.2em; float:right;}
.backstagePanelFooter a {padding:0.2em 0.4em 0.2em 0.4em;}
#backstageCloak {display:none; z-index:20; position:absolute; width:100%; height:100px;}

.whenBackstage {display:none;}
.backstageVisible .whenBackstage {display:block;}
/*}}}*/
/***
StyleSheet for use when a translation requires any css style changes.
This StyleSheet can be used directly by languages such as Chinese, Japanese and Korean which need larger font sizes.
***/
/*{{{*/
body {font-size:0.8em;}
#sidebarOptions {font-size:1.05em;}
#sidebarOptions a {font-style:normal;}
#sidebarOptions .sliderPanel {font-size:0.95em;}
.subtitle {font-size:0.8em;}
.viewer table.listView {font-size:0.95em;}
/*}}}*/
/*{{{*/
@media print {
#mainMenu, #sidebar, #messageArea, .toolbar, #backstageButton, #backstageArea {display: none ! important;}
#displayArea {margin: 1em 1em 0em 1em;}
/* Fixes a feature in Firefox 1.5.0.2 where print preview displays the noscript content */
noscript {display:none;}
}
/*}}}*/
<!--{{{-->
<div class='header' macro='gradient vert [[ColorPalette::PrimaryLight]] [[ColorPalette::PrimaryMid]]'>
<div class='headerShadow'>
<span class='siteTitle' refresh='content' tiddler='SiteTitle'></span>&nbsp;
<span class='siteSubtitle' refresh='content' tiddler='SiteSubtitle'></span>
</div>
<div class='headerForeground'>
<span class='siteTitle' refresh='content' tiddler='SiteTitle'></span>&nbsp;
<span class='siteSubtitle' refresh='content' tiddler='SiteSubtitle'></span>
</div>
</div>
<div id='mainMenu' refresh='content' tiddler='MainMenu'></div>
<div id='sidebar'>
<div id='sidebarOptions' refresh='content' tiddler='SideBarOptions'></div>
<div id='sidebarTabs' refresh='content' force='true' tiddler='SideBarTabs'></div>
</div>
<div id='displayArea'>
<div id='messageArea'></div>
<div id='tiddlerDisplay'></div>
</div>
<!--}}}-->
<!--{{{-->
<div class='toolbar' macro='toolbar [[ToolbarCommands::ViewToolbar]]'></div>
<div class='title' macro='view title'></div>
<div class='subtitle'><span macro='view modifier link'></span>, <span macro='view modified date'></span> (<span macro='message views.wikified.createdPrompt'></span> <span macro='view created date'></span>)</div>
<div class='tagging' macro='tagging'></div>
<div class='tagged' macro='tags'></div>
<div class='viewer' macro='view text wikified'></div>
<div class='tagClear'></div>
<!--}}}-->
<!--{{{-->
<div class='toolbar' macro='toolbar [[ToolbarCommands::EditToolbar]]'></div>
<div class='title' macro='view title'></div>
<div class='editor' macro='edit title'></div>
<div macro='annotations'></div>
<div class='editor' macro='edit text'></div>
<div class='editor' macro='edit tags'></div><div class='editorFooter'><span macro='message views.editor.tagPrompt'></span><span macro='tagChooser'></span></div>
<!--}}}-->
To get started with this blank TiddlyWiki, you'll need to modify the following tiddlers:
* SiteTitle & SiteSubtitle: The title and subtitle of the site, as shown above (after saving, they will also appear in the browser title bar)
* MainMenu: The menu (usually on the left)
* DefaultTiddlers: Contains the names of the tiddlers that you want to appear when the TiddlyWiki is opened
You'll also need to enter your username for signing your edits: <<option txtUserName>>
These InterfaceOptions for customising TiddlyWiki are saved in your browser

Your username for signing your edits. Write it as a WikiWord (eg JoeBloggs)

<<option txtUserName>>
<<option chkSaveBackups>> SaveBackups
<<option chkAutoSave>> AutoSave
<<option chkRegExpSearch>> RegExpSearch
<<option chkCaseSensitiveSearch>> CaseSensitiveSearch
<<option chkAnimate>> EnableAnimations

----
Also see AdvancedOptions
<<importTiddlers>>
''WHAT IS IT?''
*This page is all about how to do things in Maya using its scripting language "mel" (Maya Embedded Language). And in addition to that "elf" (mel's "Extended Layer Format"), for UI creation.
*This page mainly lists code samples, and "how-to's" with mel.  There are no "scripts" to 'download'.  The purpose of this page is to be a resource for creating mel procedures and scripts.
*More info on Maya can be found at the new Autodesk [[web site|http://usa.autodesk.com]] (yes, they bought Alias) or [[Highend3D.com|http://www.highend3d.com/maya/]].
*//This page used to be called ''"How to find stuff using mel"'' on other Wiki's://
**{{{www.openwiki.com}}} (which appears to be dead) & {{{warpcat.pbwiki.com}}} are some past sites.
''WHAT IT ISN'T:''
*Instructions on how to script\program. I'm presuming you already know a bit of that. But since there are plenty of examples listed, they may help.
''HISTORY:''
*This page started years ago as a personal web page with a bunch of random thoughts as I learned mel. So a lot of these notes are from the gamut of versions... 1.0 through currently, 8.5. You will see some pretty simple things listed, and some more complex things as well. I've thought about nixing the simple stuff, but for others that are learning, that would be counterproductive.
*I have posted it as a Wiki primarily because they're so easy to edit, I can add stuff very quickly while in development, from work, home, or off-site.  I'm currently using [[TiddlyWiki|http://tiddlywiki.com/]] due to the fact it's so easy to search (based on the Tags), and update (since I only have to work on one tiddler at a time, rather than the whole page).
''DISCLAIMER''
*I can't be blamed for anything misrepresented on this page! If it doesn't work, no finger-waving my direction.
*Since I work on a Windows system, the majority of the command line stuff I call out to is Win-centric. If you're using Lunix\Unix\OSX etc, I'm fairly confident those args won't work.... (replace with what is appropriate for your OS)
''CONTRIBUTE YOUR BRAIN:''
*If you'd like to add something to this page, please [[email me|WarpCat]] with your addition, and I'll add it in if appropriate, thanks!
*I give credit to those I get info from, whenever possible.
*If you want to be a full-time contributor/editor, that's an option too.  Let me know if you have interest.
''TAKE IT WITH YOU''
*Since this is a tiddlywiki, it's a 'self contained' wiki.  No servers required to run it, no other installs needed (other than a valid web browser).  Using the //right column// you can download this file (it's only one file), and run it off any other location (memory-stick, cd, hard drive, another web site, etc).  Of course it won't update if you do that, so keep checking back on a regular basis.
----
And if you like how this TiddlyWiki works, check out the home page:
*http://tiddlywiki.com/   -- download TiddlyWiki
*http://tiddlyspot.com/  -- Get your TiddlyWiki hosted online for free (what you're using right now)
----
[[wiki help]]
While reading a book on the [[Processing|http://www.processing.org/]] language, they had a different take on the standard Maya {{{for}}} loop.  A normal {{{for}}} loop has this format:
{{{
for (initialization; condition; change of condition){
statement;
statement;
...
}
}}}
So a simple example:
{{{
for($i=0;$i<5;$i++){ print($i + " ");
};
0 1 2 3 4
}}}
I learned that you can actually have //multiple// __initialization__ parameters, along with multiple __conditions__, and multiple __change of conditions__:
{{{
for($i=0,$j=5; $i<$j, $j<10;$i++, $j++){ print($i + " " + $j + "\n"); } 0 5 1 6 2 7 3 8 4 9 }}} I'm really not too sure what I'm going to do with this info yet, but... I think it's good to know! Talking with other programmers, their reply was "oh yeh, //many// other languages do that". So, I guess I've been left out of the.... //loop//. (so bad, but so good). Retrospective blog entry. mel wiki is created! ''Happy New Year!'' I added this new blog section. I figured out how to move the "mel wiki" icon to the SiteTitle (very exciting). I also added my first bit of Python tagging, and setup a main [[PYTHON]] category. Still stuck on Maya 7 though... Finally, made the 'Tags' tab always be visible in the right hand column, which should make it easier for users to navigate the site by default. Man, there is a pile of rain coming down here in the San Francisco area! Tiddlyspot.com is down for some reason, so all the latest updates are being made offline... Tiddlywiki is back up again... I wonder what was going on... Robots! Not directly related to mel, but I made my first couple of solar powered robots: The Symet [img[http://farm3.static.flickr.com/2232/2170294205_36506d0c98_m.jpg][http://www.flickr.com/photos/8064698@N03/sets/72157603647631805/]] The Hexpummer [img[http://farm3.static.flickr.com/2129/2174047884_2b66e455ea_m.jpg][http://www.flickr.com/photos/8064698@N03/sets/72157603656270159/]] Added a new helpful section, the [[Visual Guide of UI Controls]]. Will be updating it slowly over time, in alphabetical order. Lets the user see the type of UI control before they build it... so you can make your UI's much faster! Added the new [[All Subjects]] tiddler in the main menu (on the left) of the screen: It will show ALL the subjects (tiddlers) in the wiki. Now you can search through the categories, or just __one big page__ of subjects. I recently got turned onto ''Processing'' through the ''Make'' blogs: [img[http://processing.org/reference/environment/images/ide.gif]] *Processing: http://www.processing.org/ *Make: http://www.makezine.com/ (which you should read all the time, FYI) It's a cool (free) language that sort of 'wrappers up' Java. From their site: <<< "Processing is an open source programming language and environment for people who want to program images, animation, and interactions. It is used by students, artists, designers, researchers, and hobbyists for learning, prototyping, and production. It is created to teach fundamentals of computer programming within a visual context and to serve as a software sketchbook and professional production tool. Processing is developed by artists and designers as an alternative to proprietary software tools in the same domain." <<< ---- Here's some fantastic examples by [[Jared Tarbell|http://www.complexification.net/programmer.html]]. One of the coolest things: He also gives the ''Processing'' source code away for each of them. That is awesome. Share the knowledge! *http://www.complexification.net/gallery/ [img[http://www.complexification.net/timeline/WTsubstrate.jpg]] [img[http://www.complexification.net/timeline/WThappyPlaceWideB.jpg]] [img[http://www.complexification.net/timeline/WTintersectionMomentary.jpg]] [img[http://www.complexification.net/timeline/WTboxFittingImg.jpg]] (many more in the above link) I added a new category (on the left) called [[TROUBLESHOOTING]]. It will take some time to organize other stuff into it, but it's a start. Added a new section called [[Other Links]]. Thought I'd share some of the other web sites that I enjoy, that have some correlation to brains that enjoy Maya and mel. [[A month or so ago|2008 02 18]] I talked about [[Processing|http://www.processing.org]]. Since then I've started to learn it, and have been posting some of my first sketches on [[Flickr|http://www.flickr.com/photos/8064698@N03/collections/72157604136742471/]]. Enjoy. I've FINALLY gotten around to re-learning Python. In lite of that, I've made a new Python Wiki: http://pythonwiki.tiddlyspot.com/ While there is still Maya-centric Python stuff on this page, non-Maya related Python stuff I"ll start posting over there. I'm still a Python noob, so there's nothing too amazing over there yet. It's like how this wiki started yeaaaars ago.  Finally got around to updating to tiddlywiki v2.4. No one will really care but me. But it's the new hottness. I've finally made a blog to tie together my various wiki's and projects. It can be found here: http://warpcat.blogspot.com/ A buddy of mine has started his own mel tiddlywiki as he learns the languange. Everyone should! ;) http://brac.tiddlyspot.com/ I thought I'd try and experiment, and create a [[Guest Book|GuestBook]]. I really have no idea how many people use my wiki, how often it is viewed, etc. I do get an occasional email telling me how someone has used it, which gives me the warm-fuzzies. If you'd like to 'sign' the [[Guest Book|GuestBook]], go to that link, and follow the directions. Since his wiki isn't open for public editing (one of the reasons I set it up that way: I used to get spammed all the time when anyone could edit it), you'll need to //email [[me|WarpCat]] your guest book comment. That can be a departure from regular website guest book signing, so I could see a reluctance on the part of some users. As I said, this is an //experiment// ;-) I've done some retagging when it comes to Python subjects: I already have an upper-case '[[PYTHON]]' category on the left-column. Before, //all// subjects that were either about Python specifically, or others that had Python code in their examples received that tag. I've now made a 'lowercase' '[[python]]' tag as well to help differentiate: *Subjects that are //specifically related to Python features// will get the upper-case //category// tag. *Subjects that have example Python code in them (or call to the {{{python}}} //mel// command), but aren't 'about' Python specifically, will get the 'lowercase tag'. I think this will help make searching for //Python-specific// issues easier, and not clutter it with code simply written //in// Python. Since I'm forcing myself to learn the API (very slowly), I added an [[API]] category. I'm mainly learning the API via Python, since I don't know much of c++ at all. Added the [[INFO]] category. Haven't yet fully populated it, but it was missing: A place on subjects about querying information about things. Added the [[HARDWARE]] category. Currently only has one item. But it's a cool item. I'm not sure how I'd use it, but I think it deserves its own category ;) Good blog post here: http://around-the-corner.typepad.com/adn/2012/09/custom-shapes-in-the-maya-api-1.html Maya has a whole bunch of both c++ & Python API plugin \ scripted plugin example stuff online [[here|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/index.html?url=cpp_ref/examples.html,topicNumber=cpp_ref_examples_html]] (Maya 2013) There are edge-cases where certain API calls will want a c++ [[struct|http://www.cplusplus.com/doc/tutorial/structures/]] passed in. For example, the [[OpenMayaRender.MRenderView|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/index.html?url=cpp_ref/class_m_render_view.html]] class's {{{updatePixels}}} method expects a pointer to a [[RV_PIXELS|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/struct_r_v___p_i_x_e_l.html]] struct. How can you do this via the Python API? As it turns out (in this case at least) they've wrappered that struct for you: {{{ import maya.OpenMayaRender as omr rvp = omr.RV_PIXEL() }}} I'd be interested to know how many more there are? This post by Kristine Middlemiss breaks it down very nicely: *http://around-the-corner.typepad.com/adn/2012/07/setting-a-user-event-within-maya.html Transcribed from that post for prosperity: {{{ # Here's how you would register a new user event type called 'myEvent': import maya.OpenMaya as om om.MUserEventMessage.registerUserEvent('myEvent') # To have a function called 'myFunc' execute whenever the event occurs: def myFunc(data): print('Got a myEvent event!') callbackId = om.MUserEventMessage.addUserEventCallback('myEvent', myFunc) #To send a 'myEvent' event: om.MUserEventMessage.postUserEvent('myEvent') #To remove the callback function when done: om.MUserEventMessage.removeCallback(callbackId) }}} ---- Also see: *[[API: How can I author callbacks for Maya events?]] When making custom node types via scripted-plugins (or regular 'ol compiled plugins), they need a [[MTypeId|http://download.autodesk.com/us/maya/2011help/api/class_m_type_id.html]] set to a specific value, so that custom node types won't clash: {{{ import maya.OpenMaya as om kPluginNodeId = om.MTypeId(0x00113) }}} Autodesk divvies-out ranges of addresses to developers, but how do you get these addresses assigned? Via this web site: http://discussion.autodesk.com/cgi-bin/maya/MayaID.cgi ---- This blog post does a great job covering all aspects of these id's, how they're used, and how you can register for them: http://around-the-corner.typepad.com/adn/2012/09/maya-and-node-types.html  All of the api (~OpenMaya) work I do is via the Python bindings. And plugins authored that way don't need to be 'compiled', since they're considered 'scripted plugins'. Sometimes however I'll run into legacy plugins that need recompiled to the latest version of Maya, and Maya itself comes with many examples of c++ authored plugins that //do// need compiled (living here: {{{C:\Program Files\Autodesk\Maya20XX\devkit\plug-ins}}}). Talking with co-workers smarter than I on the subject, here are the steps we went through to compile a plugin: #Install [[Visual Studio|http://www.microsoft.com/visualstudio/en-us]]. ##I'm using Maya 2010 64-bit on Windows 7: I tried installing Visual Studio 2008, but I got compile errors. Switching to Visual Studio 2010 fixed that. ##When you first launch Visual Studio, configure it to 'C++'. #Launch Visual Studio and: File -> Open {{{C:\path\to\my\plugin\myPlugin.sln}}}. ##{{{.sln}}} are Visual Studio 'solution' files. #Select the 'Release' build configuration, from the drop-down in the 'standard toolbar'. #Press F7 to build the plug-in (Build -> Build Solution): Watch the magic happen in the Output window. #The newly compiled plugin is output to {{{C:\path\to\my\plugin\myPlugin.mll}}} And that's really all there is to it. ---- Questions: *Can you use [[Visual Studio Express|http://www.microsoft.com/express]]? **Looks like there is evidence [[on the web|http://www.creativecrash.com/tutorials/build-plugins-with-visual-c-express-edition]] that [[this is possible|http://www.daisukemaki.com/projects_maya_api_cplusplus.php]]. *Can you use other compliers other than Visual Studio? **I've read of Codeblocks, Xcode, and possibly even Eclipse working.  Starting with Maya 2012 Hotfix 1, enhancements were made to Python scripting with the new 'Maya Python API 2.0'. You can see some high-level notes [[here|http://usa.autodesk.com/adsk/servlet/ps/dl/item?siteID=123112&id=16935849&linkID=9242259 ]]. The docs for it don't seem to be online, but you can download a zip of them here: http://images.autodesk.com/adsk/files/maya-python-api-2-0-docs.zip The new api modules are found in the {{{maya.api}}} package. For example, here is the 'old way' to import {{{OpenMaya}}}: {{{ import maya.OpenMaya as om print type(om.MDagPath()) # <class 'maya.OpenMaya.MDagPath'> }}} And the new 'api' way: {{{ import maya.api.OpenMaya as om print type(om.MDagPath()) # <type 'OpenMaya.MDagPath'> }}} As you can see, the 'old way' typed instances as objects, but the new way types them as physical new types. I've also noticed that it looks like the api objects are no longer being wrapperd via ''swig'' objects: Calls to {{{someSwigObject.disown()}}} that worked in 2010 will fail on 2012 raising a nice exception: {{{ # AttributeError: 'PyCObject' object has no attribute 'disown' # }}} This isn't necessarily a result of API 2.0, but it does have a coincidence in timing.... It should be noted that as of this authoring the whole API hasn't been ported over: currently only a subset has: This seems questionable for usage... but I'm not too sure on the background of this project yet. Here are the list of advantages they post: *Array types are full Python sequences, including slice support. *Methods which take Maya array parameters will usually also take native Python sequences, such as arrays and tuples. *Exceptions are made in some case for performance reasons. *The outputs of methods are usually returned in their return values, not through their parameter lists. Exceptions are made in some cases for performance reasons. *Methods which return multiple values (e.g. ~MFnFluid.getResolution) return them as a tuple or list, eliminating the need for ~MScriptUtil. *Object attributes are preferred over rather than set/get methods. For example you can now write {{{array.sizeIncrement=64}}}. *There are more types of exceptions used when methods fail. Not everything is a ~RuntimeError, as was the case in the old API. *The new API is generally faster than the old. Up to three times faster in some cases. I recently ran into the problem of trying to query a 'double array' attr via the API. In the below example, I create a "doubleArray" attr via commands on a node, then try to query it via the API. {{{ import maya.cmds as mc import maya.OpenMaya as om node = 'pSphere1' attr = "doubleArrayTest" #--------------------------- # Via cmds, add the attr to our node: mc.addAttr(node, longName=attr, dataType='doubleArray') mc.setAttr('%s.%s'%(node,attr), (2, 3.14159, 2.782), type="doubleArray") print mc.getAttr('%s.%s'%(node,attr)) # [2.0, 3.14159, 2.782] print mc.getAttr("%s.%s"%(node,attr), type=True) # doubleArray #----------------------- # Now, in the API: selList = om.MSelectionList() selList.add(node) mObject = om.MObject() selList.getDependNode(0, mObject) plug = om.MFnDependencyNode(mObject).findPlug(attr) print plug.name() # pSphere1.doubleArrayTest # So, the API is getting confused: print plug.isArray() # False print plug.numElements() # // Error: Encountered exception: (kFailure): Data type is not valid here // indexArray = om.MIntArray() plug.getExistingArrayAttributeIndices(indexArray) # // Error: Encountered exception: (kFailure): Object does not exist // # Let's try something else: # Get val as an MObject (say whaaa?!) plugValObj = plug.asMObject() # Create a function to act on that object: fnDoubleArray = om.MFnDoubleArrayData(plugValObj) # Get just the array data: doubleArray = fnDoubleArray.array() print doubleArray #[2.0, 3.14159, 2.782] # Finally! }}} ---- Docs: *[[MFnDoubleArrayData|http://docs.autodesk.com/MAYAUL/2014/ENU/Maya-API-Documentation/index.html?url=cpp_ref/class_m_fn_double_array_data.html,topicNumber=cpp_ref_class_m_fn_double_array_data_html]] *[[MFnDependencyNode|http://docs.autodesk.com/MAYAUL/2014/ENU/Maya-API-Documentation/index.html?url=cpp_ref/class_m_fn_dependency_node.html,topicNumber=cpp_ref_class_m_fn_dependency_node_html]] *[[MPlug|http://docs.autodesk.com/MAYAUL/2014/ENU/Maya-API-Documentation/index.html?url=cpp_ref/class_m_plug.html,topicNumber=cpp_ref_class_m_plug_html]] ---- Also see: *[[API: Attribute Creation & Usage]] *[[API: How can I query and set an attribute?]] Starting with Maya 2011 they introduced a new API class [[MQtUtil|http://download.autodesk.com/global/docs/mayasdk2012/en_us/cpp_ref/class_m_qt_util.html]]. Notes from the docs: <<< The safest way to use the Qt API from within Maya is to create your own Qt window and populate it with your own controls. While it is possible to use the Qt API to modify existing Maya UI elements, such as those created using Maya commands from MEL or Python, such modifications are not supported by Autodesk and could lead to Maya becoming unstable or inoperable. In practice, you will likely find a number of modifications which appear safe, such as changing a control's text or reorganizing the items on a menu. However, Autodesk provides no guarantees that the underlying implementations of those UI elements won't change from one release of Maya to another, potentially in ways that may make formerly safe usage become unsafe. So if you choose to incorporate such actions into your plug-in be aware that you may have to modify your code in future versions of Maya. <<< Here is a very simple example using it: {{{ import maya.cmds as mc import maya.OpenMayaUI as omui # Create the window: class App(object): def __init__(self): self.name = "tempWin" if mc.window(self.name, exists=True): mc.deleteUI(self.name) self.window = mc.window(self.name, resizeToFitChildren=True) self.rootLayout = mc.columnLayout(adjustableColumn=True, columnAttach=('both', 5)) self.button = mc.button("awesomeButton", label="this is an awesome button") mc.showWindow() # Display window, capture an instance: app = App() butQtClasses = mc.objectTypeUI(app.button, superClasses=True) qwidget = omui.MQtUtil.findControl(app.button) print app.button, butQtClasses print qwidget, type(qwidget) }}} prints: {{{ tempWin|columnLayout6|awesomeButton [u'QPushButton', u'QAbstractButton', u'QWidget', u'QObject'] _b056e53200000000_p_QWidget <type 'PySwigObject'> }}} From here, you can see that the Qt widget has been wrapped in a Python 'swig' object. {{{ # Python code import maya.OpenMaya as om import maya.OpenMayaAnim as oma def getSkinCluster(shape): """ shape : string : name of shape node to query skincluster on return : MFnSkinCluster : MFnSkinCluster node assigned to the mesh, or None. """ # Create an MDagPath for our shape node: selList = om.MSelectionList() selList.add(shape) mDagPath = om.MDagPath() selList.getDagPath(0, mDagPath) # Make a dependency graph iterator, passing in our MDagPath as the root of the # system. Set the Direction to 'From source to destination' and Level to be # 'Visit each Plug at most once' mItDependencyGraph = om.MItDependencyGraph(mDagPath.node(), om.MItDependencyGraph.kDownstream, om.MItDependencyGraph.kPlugLevel) # Start walking through our shape node's dependency graph: while not mItDependencyGraph.isDone(): # Get an MObject for the current item in the graph: mObject = mItDependencyGraph.currentItem() # If the MObject can have a MFnSkinCluster function applied, then it must # be a skincluster: if mObject.hasFn(om.MFn.kSkinClusterFilter): # return the MFnSkinCluster object for our MObject: return oma.MFnSkinCluster(mObject) mItDependencyGraph.next() }}} {{{ shape = 'someNodesShape' sCluster = getSkinCluster(shape) # Print the name of the skincluster: print sCluster.name() # skinCluster14 }}} The above example is based on info I found in this thread: http://groups.google.com/group/python_inside_maya/browse_thread/thread/1b865f8c3c0c81c2 And did a re-write on.  ''~OpenMaya Python'': {{{ import maya.OpenMaya as om # Make a MSelectionList container object: selList = om.MSelectionList() # Fill our container object with the active selection: om.MGlobal.getActiveSelectionList(selList) # Make a list to gather the results: sel = [] # Fill the result list with strings of the selection: selList.getSelectionStrings(sel) print sel }}} Man, that is clunky! :-P Compared to: ''Python'': {{{ import maya.cmds as mc sel = mc.ls(selection=True) print sel }}} ''MEL'': {{{ string$sel[] = ls - selection;
print $sel; }}} When dealing with the API, all linear '//internal units//' are held in cm (unless overridden, but I've never seen this happen). But if you're passing that data to mel/Python commands, they expect the values to be in whatever '//ui unit//' has been set. By default, the ui unit is cm as well, but many studios will change this value to something else. In my case, it's currently inches... If these two values line up you won't notice any problems in your code. But if you author code that expects the ui units to be cm and they're not, chaos will ensue. In the below example, we grab the center-point of the bounding-box of a node, then convert that position into the current ui-units: {{{ import maya.OpenMaya as om node = 'pSphere1' # Get the MDagPath for a node: selList = om.MSelectionList() # MSelectionList selList.add(node) mDagPath = om.MDagPath() # MDagPath selList.getDagPath(0, mDagPath) # Find the centerpoint based on bounding box, this will be in cm: dagNodeFunc = om.MFnDagNode(mDagPath) # MFnDagNode boundingBox = dagNodeFunc.boundingBox() # MBoundingBox centerPoint = boundingBox.center() # MPoint #----------------------- # Now that we have some data, convert it from internal to ui units: # Convert from cm to current units: center = [] unitType = om.MDistance.uiUnit() # Get the current UI unit: for i in range(3): distance = om.MDistance(centerPoint[i]) # MDistance, as cm converted = distance.asUnits(unitType) # double, converted center.append(converted) print center }}} ---- Also see: *[[API: How can I find the working units?]] The below classes compare with the mel {{{currentUnit}}} command. The below classes have the ability to query both the //internal// units, and the //ui// units (except {{{MTime}}}). The internal units, while they can be changed, usually shouldn't be. Defaults for internal units are: *Linear : Centimeters *Angular : ? Mine comes up as {{{kInvalid}}}, which is odd. I'd expect it to be Radians though. *Time : Has no differentiation between internal\ui: There is only ui units. I think when Maya installs this is 24fps (film). UI units are the ones you can change via Maya's prefs, or via mel. !!!Linear: [[OpenMaya.MDistance|http://download.autodesk.com/us/maya/2010help/api/class_m_distance.html]] {{{ import maya.OpenMaya as om uiLinearUnit = om.MDistance.uiUnit() }}} This returns an int value that corresponds to the {{{Unit}}} enum on the {{{MDistance}}} class. Which corresponds to these constants: | 1 | kInches | | 2 | kFeet | | 3 | kYards | | 4 | kMiles | | 5 | kMillimeters | | 6 | kCentimeters | | 7 | kKilometers | | 8 | kMeters | !!!Angular: [[OpenMaya.MAngle|http://download.autodesk.com/us/maya/2010help/API/class_m_angle.html]] {{{ import maya.OpenMaya as om uiAngularUnit = om.MAngle.uiUnit() }}} This returns an int value that corresponds to the {{{Unit}}} enum on the {{{MAngle}}} class. Which corresponds to these constants: | 1 | kInvalid | | 2 | kRadians | | 3 | kDegrees | | 4 | kAngMinutes | | 5 | kAngSeconds | | 6 | kLast | !!!Time: [[OpenMaya.MTime|http://download.autodesk.com/us/maya/2010help/api/class_m_time.html]] {{{ import maya.OpenMaya as om uiTimeUnit = om.MTime.uiUnit() }}} This returns an int value that corresponds to the {{{Unit}}} enum on the {{{MTime}}} class. There are a lot of constant values, check the [[docs|http://download.autodesk.com/us/maya/2010help/api/class_m_time.html#ffadecde942c8f44b9ec1ce62aa9da51]] for the specifics. ---- Also see: *[[API: How can I convert from linear internal units to ui units?]]  Pulled a bunch of below from this post: http://nccastaff.bournemouth.ac.uk/jmacey/RobTheBloke/www/maya/MSelectionList2.html The below example has all the variable names set to their object types. I did this just to illustrate how the objects were returned and used, don't recommend it for regular coding sessions... The below example will loop over each object, and the components selected on that object. It will print the worlds-pace position of each point that is part of the component selection. {{{ # Python code import maya.OpenMaya as om # Make a MSelectionList container object: MSelectionList = om.MSelectionList() # Fill with selection, as MObjects om.MGlobal.getActiveSelectionList(MSelectionList) # Create an iterator to loop over our selection: MItSelectionList = om.MItSelectionList(MSelectionList) while not MItSelectionList.isDone(): # The mesh node: MDagPath = om.MDagPath() # The components, if any: MObject = om.MObject() # Define the path to our object and components. MItSelectionList.getDagPath(MDagPath, MObject) # Create a function set for this MDagPath. MDagPath.node() returns an MObject. MFnDependencyNode = om.MFnDependencyNode(MDagPath.node()) # We can now do work on the object if we want to. print MDagPath.fullPathName() # If we have components: if not MObject.isNull(): # Make an iterator for them: MItGeometry = om.MItGeometry(MDagPath, MObject) while not MItGeometry.isDone(): # Make a point object for the current loop: MPoint = MItGeometry.position(om.MSpace.kWorld) # And print its info: print "\t-vert index: %s -pos: %s %s %s"%(MItGeometry.index(), MPoint.x, MPoint.y, MPoint.z) MItGeometry.next() MItSelectionList.next() }}} (Referenced from 'Complete Maya Programming') Waaaay exciting! It should be noted that any time you use API calls outside of a plugin to modify the DG, you can't undo the operation. {{{ # Python code import maya.OpenMaya as om }}} {{{ # optionA: transFn = om.MFnTransform() transObj = transFn.create() name = transFn.name() }}} {{{ # optionB: transFn = om.MFnTransform() transObj = transFn.create() # Illustrating inheritance: dagFn = om.MFnDagNode(transObj) name = dagFn.name() }}} {{{ print name # transform1 }}} Class hierarchy: *{{{MFnBase}}} **{{{MFnDependencyNode}}} ***{{{MFnDagNode}}} ****{{{MFnTransform}}}  Notes, notes notes... window data via the API. ---- from {{{maya.OpenMayaUI}}}: *{{{M3dView}}} : Main class used to access window info. *{{{MDrawInfo}}} : used in the draw methods of {{{MPxSurfaceShapeUI}}} **{{{MSelectInfo}}} : used in {{{MPxSurfaceShapeUI::select}}} ---- from {{{maya.OpenMayaMPx}}} *{{{MPx3dModelView}}} : Creates {{{modelEditor}}}s. *{{{MPxModelEditorCommand}}} : Creates commands for {{{modelEditors}}}. *{{{MPxControlCommand}}} *{{{MPxUIControl}}} **{{{MPxUITableControl}}} *{{{MPxSurfaceShapeU}}} *{{{MPxGlBuffer}}} ---- Query the current camera for the active view, top left corner of viewport, and viewport width\height. Similar stuff to what you can do with the window mel command. {{{ import maya.OpenMayaUI as omui import maya.OpenMaya as om camPath = om.MDagPath() activeView = omui.M3dView.active3dView() activeView.getCamera(camPath) camName = camPath.fullPathName() # c++ pointer hoop-jumping: xUtil = om.MScriptUtil() xUtil.createFromInt(0) xPtr = xUtil.asIntPtr() yUtil = om.MScriptUtil() yUtil.createFromInt(0) yPtr = yUtil.asIntPtr() activeView.getScreenPosition(xPtr, yPtr) x = om.MScriptUtil.getInt(xPtr) y = om.MScriptUtil.getInt(yPtr) pw = activeView.portWidth() ph = activeView.portHeight() print camName, "- Top Left:", x, y," - width/height:", pw, ph # |persp|perspShape - Top Left: 405 45 - width/height: 701 1060 }}} Mel has the {{{polyColorPerVertex}}} command, that will change the color of one vertex at a time. This works fine you're doing it on less than 100 verts at a time. But on more than 1000, it really starts to slow down. Enter the API. The {{{MFnMesh}}} class has a {{{setVertexColors}}} method which allows you to set multiple colors at once. And it is //much// faster. Pseudo code to use it: {{{ import maya.OpenMaya as om # Build an empty vertex ID array: idArray = om.MIntArray() # Now fill it with the vert ID's on the object to color. # Could be some, or all of them. # Build an empty color array: colorArray = om.MColorArray() # Now fill it with the colors for each of the vert ID's # defined above. # Get a MDagPath for the object we're coloring: selList = om.MSelectionList() selList.add(myObject) mDagPath = om.MDagPath() selList.getDagPath(0, mDagPath) # Get a MFnMesh for our object: mFnMesh = om.MFnMesh(mDagPath) # Apply the colors: mFnMesh.setVertexColors(colorArray, idArray) }}} It should be noted that since you're using the API to modify the scene graph, there is no undo available. To get undo, you'd need to author this as a scripted plugin command. Several subjects below, here's what we have: #Overview of API ~Attribute-Related Concepts #Attribute Property Defaults #Overview of API attribute creation classes #Creation #Example Usage #Differences between 'compound' and 'array' #Understanding Array Indices (physical & logical) #Networked and non-networked plugs #Additional examples ---- ''Important note'': In Maya, the term 'attribute' can mean two different things based on where it's used: either the 'user side' or the 'programmer side': *On the user side, they interact with attributes on nodes, querying\setting their values, keyframing them, etc. The only point of entry is "the attribute". The attribute 'has a value', for example. The value and the attribute go hand in hand. *On the programmer side, an 'attribute' is: **Quoted from 'Complete Maya Programming': "...a template or blueprint for how a piece of data in the node should be //created//. The important distinction from the user's perspective is that the attribute doesn't actually hold any data. It simply provides a specification for the data. Given this specification, the actual data is created.". **Basically, it's a description for the type of data that can be stored, but that's only part of the equation (one of four main parts). The next section describes the four areas that are required for data storage\retrieval on a node in the API. !!!Overview of API ~Attribute-Related Concepts: *''Attributes'': **Attributes in the API define the name and type of data a node can store. **Attributes themselves don't store data, they define what type of data can be stored. **Analogies help: Picture a house as a representation of a node. Each attribute is represented as a gate around the house: Only if a package can 'fit through a certain gate' can it be allowed into the house. Each gate defines access to one type of 'package', but it itself doesn't store the package. **API attributes differ from user-interaction in Maya on a node. When in Maya you execute "{{{setAttr sphere02.translsateX 3;}}}" it feels like you've set the {{{translateX}}} attribute to the value of {{{3}}}. But behind the scenes, it's not being stored that way: The {{{translateX}}} attribute is simply the gate through which you've squeezed your numeric package. Where that value actually lives is discussed below. **They are represented as [[MObject|http://download.autodesk.com/us/maya/2010help/API/class_m_object.html]] objects, and created\manipulated (at time of creation) via [[MFnAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_attribute.html]] and descendant classes. *''Plugs'': **A plug is an instance of an attribute on a node. **They allow you to get and set data, make connections, lock attributes, etc. **Following the house analogy from above, a plug is like a gate-keeper: It can lock the gate, pass data from outside the gate to inside the gate (and vice-versa), and even connect gates between two different houses together. **They are represented as [[MPlug|http://download.autodesk.com/us/maya/2010help/API/class_m_plug.html]] and [[MPlugArray|http://download.autodesk.com/us/maya/2010help/API/class_m_plug_array.html]] objects. **They can be created & queried via [[MFnDependencyNode|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_dependency_node.html]] (& its descendants), queried via [[MAnimUtil|http://download.autodesk.com/us/maya/2010help/API/class_m_anim_util.html]], are passed as an argument to {{{MPxNode.compute()}}}, and additionally manipulated via [[MDgModifier|http://download.autodesk.com/us/maya/2010help/API/class_m_d_g_modifier.html]]. *''Data Handles'': **When a node is computing data (in its {{{compute()}}} method) and needs to access data in its data block, it gains that access through a 'data handle'. **Data handles allow you to query and set data living in a data block, as defined by a given attribute. **Data handles can't make connections between attributes or lock them (for example), they only query\set data. But because of this they can operate much faster than plugs. In addition, they can query a 'dirty' attribute without forcing a recompute of the DG which can allow for even greater optimization. **Following the analogy, a data handle is like a butler who can put data in storage (received from the plug), and take data out of storage, passing it to the plug. **They are represented as [[MDataHandle|http://download.autodesk.com/us/maya/2010help/API/class_m_data_handle.html]] and [[MArrayDataHandle|http://download.autodesk.com/us/maya/2010help/API/class_m_array_data_handle.html]] objects. They are created via [[MDataBlock|http://download.autodesk.com/us/maya/2010help/API/class_m_data_block.html]]s. *''Data Blocks'': **The data block is the location in the node where the attribute values are stored. **Whenever a new instance of a node is created, a new data block is created for it. **Using the house analogy, the data block is the store-room of the house where all the packages are stored. The butler can put stuff in and take it out. **They are represented as [[MDataBlock|http://download.autodesk.com/us/maya/2010help/API/class_m_data_block.html]] objects, and passed to the {{{MPxNode.compute()}}} method as an argument: That's the only way (I'm aware of) you can access them. Another way to visualize the analogy: | Plug | Attribute | Data Handle | Data Block | | Gate Keeper | The Gate | Butler | Storeroom | *Imagine that a node is a house. *The gate keeper (plug) can lock\unlock the gate, let packages (data) pass through the gate to the butler, magically connect this gate to the gate on another house (so that they share packages), or get packages from the butler. *The gate itself (attribute) limits what type of packages are allowed into the house (or what type of package is retrieved from it). If the package doesn't fit, an alarm (error) goes off. *Presuming the package fits through the gate, if the gatekeeper wants the package put in the house (or wants to get a packaged stored in the house), he needs to have the butler (data handle) do it for him. *All packages are kept in the storeroom of the home (data block), which the butler knows a quick path to. *Finally, the gate keeper can have direct access to the storeroom if he's tricky (but he's slower than the butler), and if you slip the butler a$20 (and you sneak in via {{{compute()}}}) you can access the storeroom directly.
So you could say:
*A package arrives at the home.  Since it fits through the gate, the gatekeeper passes it to the butler.  The butler than puts it in the storeroom.
----
----
----
!!!Attribute Property Defaults
When a new attribute is created, these are the default states of its various properties.  They are modifiable via [[MFnAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_attribute.html]] (attribute superclass).
*Readable.
*Writable.
*Connectable.
*Storable.
*Cached.
*Not arrays.
*Have indices that matter.
*Do not use an array builder.
*Not keyable.
*Not hidden.
*Not used as colors.
*Not indeterminant.
*Set to disconnect behavior kNothing.
!!!Overview of API attribute creation classes:
All of these inherit from [[MFnBase|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_base.html]]
*[[MFnAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_attribute.html]] : Used for changing the attribute defaults listed above (among others).
**[[MFnCompoundAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_compound_attribute.html]] : For the creation of 'compound' attributes:  Attributes that can store multiple different data types.
**[[MFnEnumAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_enum_attribute.html]]  :  For the creation of 'enum' attribute types.
**[[MFnGenericAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_generic_attribute.html]]  :  Creation of attrs that can accept specific data types as defined by [[MFnData|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_data.html]].  Similar but different from {{{MFnTypedAttribute}}}, see docs [[here|http://download.autodesk.com/global/docs/mayasdk2012/en_us/index.html?url=files/Technical_Notes_Generic_Attributes.htm,topicNumber=d28e16031]]
**[[MFnLightDataAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_light_data_attribute.html]] : For the creation of 'light data' attribute types.
**[[MFnMatrixAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_matrix_attribute.html]]  :  For the creation of 'matrix' attribute types.
**[[MFnMessageAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_message_attribute.html]]  :  For the creation of 'message' attribute types.
**[[MFnNumricAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_numeric_attribute.html]]  :  For all 'numric' attribute types as defined by [[MFnNumricData|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_numeric_data.html]].  These include boolean, byte, character, short 2short, 3short, int, 2int, 3int, long, 2long, 3long, float, 2float, 3float, double, 2double, 3double, 4double, and finally 'color' and 'point'.
**[[MFnTypedAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_typed_attribute.html]]  :  Creation of attrs that can accept specific data types as defined by [[MFnData|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_data.html]].  These include: numeric (based on [[MFnNumricData|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_numeric_data.html]]), plugin, pluginGeometry, string, matrix, stringArray, doubleArray, intArray, pointArray, vectorArray, componentList, mesh, lattice, nurbsCurve, nurbsSurface, sphere, dynArrayAttrs, dynSweptGeometry, subdSurface, nObject.
**[[MFnUnitAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_unit_attribute.html]]  :  For creation of attributes that store angle, distance, and time.
[img[http://download.autodesk.com/us/maya/2010help/API/class_m_fn_attribute__inherit__graph.gif]]
!!!Creation:
Placeholders for the node's attributes are initially added as a class-attribute for easy access later.  At this point, then can be filled with {{{MObject}}}s (since that's what they'll be ultimately), or just be filled with {{{None}}} since at this point they're not used.
{{{
import maya.OpenMaya as ompx
class Foo(ompx.MPxNode):
attr_someInput = om.MObject() # or None
attr_someOutput = om.MObject() # or None
}}}
They are actually created and added to the node inside the plugin's 'initializer' classmethod (or external function.  We'll use classmethod below).  For each attr, they go through one or more of these steps:
#Creation : An attribute is created.  You can imagine it just floating in space...
#Modification :  After creation, you configure how it should behave.
#Attach to node  :  Take it from floating in space, and actually attach it to a specific node.
#Defining affects relationship  :  Set if it affects any other attribute.  ''Special note'':  This step must occur after any affected attributes have already been attached to the node (via {{{MPxNode.addAttribute()}}}).
{{{
@classmethod
def nodeInitializer(cls):
# Create the function object that will create the attributes:
mfnNumericAttribute = om.MFnNumericAttribute()

# 1. Creation:
cls.attr_someInput = mfnNumericAttribute.create("someInput", "si", om.MFnNumericData.kFloat)
# 2. Modification:
mfnNumericAttribute.setChannelBox(True) # default is False
mfnNumericAttribute.setKeyable(True)  # default is False
# 3. Attach to node:
cls.addAttribute(cls.attr_someInput)

# 1. Creation:
cls.attr_someOutput = mfnNumericAttribute.create("someOutput", "so", om.MFnNumericData.kFloat)
# 2. Modification:
mfnNumericAttribute.setWritable(False) # Default is True.  This is an output, can't write to it.
mfnNumericAttribute.setStorable(False) # Default is True.  Do not save value with scene, since it's an output.
# 3. Attach to node:
cls.addAttribute(cls.attr_someOutput)

# 4. Affects relationships for "someInput" attr.  This needs to be executed after
#     the "someOutput" attr was added to the node.
cls.attributeAffects(cls.attr_someInput, cls.attr_someOutput)
# 4. Affects relationships for "someOutput":
# None, this is an output
}}}
----
Another attribute type to make is a numric type with children.  A transforms {{{.translate}}} attribute illustrates this:  There is a root 'translate' attribute you can set, connect to, etc.  But in addition, you can set\connect to its individual children as well:
{{{
translate : float 3
--> translateX : float
--> translateY : float
--> translateZ : float
}}}
How can you set this up in the API?  You first create each of the child attributes, and then, when creating the parent, you pass them as a creation argument.  Here's a simple example snippet:
{{{
@classmethod
def nodeInitializer(cls):
mfnNumericAttribute = om.MFnNumericAttribute()

# Create the children attrs:
cls.attr_transX = mfnNumericAttribute.create("translateX", "tx", om.MFnNumericData.kFloat)
cls.attr_transY = mfnNumericAttribute.create("translateY", "ty", om.MFnNumericData.kFloat)
cls.attr_transZ = mfnNumericAttribute.create("translateZ", "tz", om.MFnNumericData.kFloat)
# Now create the parent attr by passing in the children:
cls.attr_trans = mfnNumericAttribute.create("translate", "t", cls.attr_transX, cls.attr_transY, cls.attr_transZ)
mfnNumericAttribute.setChannelBox(True)
mfnNumericAttribute.setKeyable(True)
cls.addAttribute(cls.attr_trans)
}}}
Some things to note:
*The {{{MFnAttribute}}} docs say "This form of the create method allows the creation of compound attributes out of numeric attributes."    So, even though we build using a {{{MFnAttribute}}}, it ends up being {{{MFnCompoundAttribute}}}? (I've yet to figure out what's going on here).
**When making compound attrs, their children all need to be added to to the class via {{{cls.addAttribute()}}}. However, in the examples I've seen, when making 'child array attrs', they //don't// need to be added that way: only their parent does (like in the above example).
*You modify the parents parameters ({{{setChannelBox}}}, etc) not the children, since the children inherit the parameters.
*By passing in three {{{kFloat}}} children, it implies that the {{{someInput}}} attr is now a {{{k3float}}}.
If you didn't care about the child attributes, you could simply create the attribute this way:
{{{
@classmethod
def nodeInitializer(cls):
mfnNumericAttribute = om.MFnNumericAttribute()

cls.attr_trans = mfnNumericAttribute.create("translate", "t", om.MFnNumericData.k3Float)
mfnNumericAttribute.setChannelBox(True)
mfnNumericAttribute.setKeyable(True)
cls.addAttribute(cls.attr_trans)
}}}
So you can still manipulate {{{translate}}} as you're used to, but you no longer gain gain access to the children, like {{{translateX}}}.
!!!Example Usage:
The attrs are accessed inside the {{{compute()}}} method.  Take note of a few things:
#First there is a query if the given input plug is an instance of the attribute that needs computing.
#Next, a data handle based on that instanced attribute is generated pointing inside of the data block.
#Work is done on the data.
#Finally, another data handle is created pointing to the data defined by the instanced output attribute, the output data is updated, and the input plug is set to clean.
{{{
def compute(self, plug, dataBlock):
"""
This is an overridden method of the MPxNode class.  Does the "work" the node is to perform.

Parameters:
plug : MPlug : http://download.autodesk.com/us/maya/2010help/API/class_m_plug.html
dataBlock : MDataBlock : http://download.autodesk.com/us/maya/2010help/API/class_m_data_block.html
"""
# Check that the requested recompute is our output value
if (plug == Foo.attr_someOutput):
# Read the input values, returns a MDataHandle, which is  a smart pointer
# back into the MDataBlock (dataBlock)
# http://download.autodesk.com/us/maya/2010help/API/class_m_data_handle.html
dataHandle = dataBlock.inputValue(Foo.attr_someInput)

# Compute the output values.  In this case, it is a simple mult operation:
outVal = dataHandle.asFloat() * 10

# Get a handle to the output value and store the new value.
handle = dataBlock.outputValue(Foo.attr_someOutput)
handle.setFloat(outVal)

# From the docs:  Tells the dependency graph that the given attribute
# has been updated and is now clean. This should be called after the
# data in the plug has been recalculated from the inputs of the node.
dataBlock.setClean(plug)
else:
# c++ requires this return, it seems that the Python API doesn't
# based on my experiments.  Doesn't hurt to leave it though.
return om.MStatus.kUnknownParameter
}}}
!!!Differences between 'compound' and 'array'
*''compound'' is an *attribute type*, like float, string, double etc.  You can't have a "compound float" attribute in the same way you can't have a "string double".  But you can have a compound attr that has child string, double, and float attributes.  Compound attributes themselves store no values:  They are simply parents of other attribute types.
**Compound attributes are considered 'parents', while they contain 'child' attributes.
**The child of a compound attribute can be any other attribute type, including another compound attribute, which has children (which could be compound attributes, etc).  Examples of this are the mesh node's {{{colorPerVertex}}} compound attribute.  It has a child compound attribute {{{vertexColor}}}, which has a child compound attribute {{{vertexFaceColor}}}.
*''array'' (also known as 'multi' when being created via mel, I think...) is a *property of an attribute*, like being readable, writable, keyable, etc. In theory any attribute type can be made array, *including compound attrs*.
**An example of this is a mesh node's {{{uvSet}}} attr: It is a compound attr, but is //also an array//, which gets confusing fast when trying to access it and its children.
**Array attributes contain multiple 'element attributes', one for each index in the array.  These in turn can be any type, including compound, which in turn could also be array, etc.
**Array elements are not 'children attributes', since only compound attrs have official 'children'.  Array attributes are a single attr, that holds multiple values in a list.
!!!Understanding Array Indices (physical & logical)
Given an attribute that is also array, you can reference its elements two different ways, via the "physical indices" and the "logical indices".
*''Physical index'' : Range from 0 -> {{{numElements()}}}-1.  Given four plugs for elements A, B, C, and D, A is index 0, B1, C2, D3.  If plug B was deleted, now: A0, C1, D2:  As you can see, the physical index for a given plug can change based on creation and deletion.
*''Logical index'' : For a given element, this is an assigned\fixed\absolute index that will never change regardless of creation or deletion of other indices.  You can use the plugs {{{getExistingArrayAttributeIndices()}}} method to populate a {{{MIntArray}}} with the existing indices.
**Referring to an array element in MEL uses the logical index.  MEL can't get the physical index.
**Connections between attributes are based on their *logical indices*.  This is needed since the logical indices don't change (and you don't want connections to change after they've been made...).
You can query these indices via {{{MPlug}}}.  Below is some example code and results showing the differences between them.  When calling to {{{elementByLogicalIndex()}}}, if the given index doesn't yet exist (it is a 'sparse array'), it is created and populated with a default value for that attribute.
{{{
plg = myPlg.elementByLogicalIndex(2)
plg.setDouble(11)
plg = myPlg.elementByLogicalIndex(10)
plg.setDouble(27)
plg = myPlg.elementByLogicalIndex(0)
plg.setDouble(100)
}}}
This would be the result of the physical \ logical indices:
{{{
Physical 0 \ Logical 0  : 100
Physical 1 \ Logical 2  : 11
Physical 2 \ Logical 10 : 27
}}}
!!!Networked and non-networked plugs
I'll be honest, I really don't understand the ins and outs of these yet.  But some notes:
*''non-networked plug'' : user created plugs used to establish new connections to an attr, get or set a value on an attr.  When one of these is used, a networked version of the plug is created and added to the dependency node network. A non-networked plug contains an array of array indices that plot the path from the root plug to this plug.
*''networked plug'' : Dependency node plugs, can't be explicitely created: only referenced by users.  They also describe the 'tree' of plugs indicating connections made to the attributes of the node.
!!!Additional Examples
*[[API: Simple scripted plugin node]] : A working overview of a bunch of what the above covers.
*[[API: Find all child attributes under a compound attribute]]
*[[API: Find all attributes & plugs on a node]]
Just some early notes...  See a working example here:
[[API: Simple scripted plugin argument passing]]

Docs:
*[[MSyntax|http://download.autodesk.com/us/maya/2010help/API/class_m_syntax.html]]
*[[MArgParser|http://download.autodesk.com/us/maya/2010help/API/class_m_arg_parser.html]]
**[[MArgDatabase|http://download.autodesk.com/us/maya/2010help/API/class_m_arg_database.html]]
*[[MArgList|http://download.autodesk.com/us/maya/2010help/API/class_m_arg_list.html]]
----
A major issue I've ran into is the (apparent) lack of ability to pass array data into an argument.  A thread here discusses it pretty well:
http://forums.cgsociety.org/archive/index.php/t-701733.html
It appears that the main hack is to pass in a single string you can then later split into the array items of your choice, which is //terrible//...  From that form post: ''"MEL commands //don't// have the ability to accept a string array as a single flag argument."'', which seems to be true based on experimentation.
----
When authoring a scripted plugin command to accept arguments, you do this by by authoring a 'syntax' function that is passed to the {{{OpenMayaMPx.MFnPlugin.registerCommand()}}} method inside the {{{initializePlugin()}}} function.  The syntax function can look something like this:
{{{
import maya.OpenMaya as om
def newSyntax():
syntax = om.MSyntax()
# Start adding flags and whatnot here to pass your arguments to.
}}}
And the snippet for registering the command, which includes passing of the syntax ({{{cmdName}}} & {{{cmdCreator}}} being authored elsewhere):
{{{
import maya.OpenMayaMPx as ompx
def initializePlugin(mobject):
mfnPlugin = ompx.MFnPlugin(mobject)
mfnPlugin.registerCommand(cmdName, cmdCreator, newSyntax)
}}}
You can then capture the argument data in the {{{doIt()}}} method of the scripted plugin:
{{{
import maya.OpenMayaMPx as ompx
class MyCmd(ompx.MPxCommand):
def __init__(self):
ompx.MPxCommand.__init__(self)

def doIt(self, argList):
argData = om.MArgDatabase(newSyntax(), argList)
}}}
The {{{argList}}} parameter recieves an {{{MArgList}}} argument.  You can then pass this arg into a {{{MArgDatabase}}} object, which is a subclass of {{{MArgParser}}}, or start accessing data in the {{{MArgList}}} directly.
Scratch-pad as I become more familiar with the various API classes.  Also see:
[[API: class organization]]
----
Starting with Maya 2013, they offered a [[API Class Taxonomy|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/index.html?url=cpp_ref/_maya.html,topicNumber=cpp_ref__maya_html]] online, which is all classes arranged according to subject/concept.
----
This is mainly a place where I can note classes I've used, there are obviously more than what is listed here.
!M
Notes:
*Maya's base utility classes.
!!![[M3dView|http://download.autodesk.com/us/maya/2010help/API/class_m3d_view.html]]
"provides methods for working with 3D model views. 3D views are based on OpenGL drawing areas"
!!![[MAnimControl|http://download.autodesk.com/us/maya/2010help/API/class_m_anim_control.html]]
"Control over animation playback and values"
!!![[MAnimUtil|http://download.autodesk.com/us/maya/2010help/API/class_m_anim_util.html]]
"...a static class which provides methods which determine if an object is being animated, which attributes are animated for a given object and which animation curves are used to animate a given attribute."
*Methods include {{{isAnimated}}}, {{{findAnimatedPlugs}}}, {{{findAnimation}}}
!!![[MBoundingBox|http://download.autodesk.com/us/maya/2010help/API/class_m_bounding_box.html]]
"Implementation of a 3D bounding box"
!!![[MColor|http://download.autodesk.com/us/maya/2010help/API/class_m_color.html]]
"... used to store values of color attribute."
!!![[MDagPath|http://download.autodesk.com/us/maya/2010help/API/class_m_dag_path.html]]
"Provides methods for obtaining one or all Paths to a specified DAG Node..."
*{{{node()}}} : returns an {{{MObject}}}
*{{{fullPathName()}}} : Returns string of the full path to the node.
*{{{isInstanced()}}} : Returns True\False.
Use [[MFnDagNode|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_dag_node.html]] function set to operate on this type.
See:
*[[API: MObject and MDagPath]]
!!![[MDGModifier|http://download.autodesk.com/us/maya/2010help/API/class_m_d_g_modifier.html]]
"...is used to change the structure of the //dependency graph// (DG). This includes adding nodes, making new connections, and removing existing connections."
*Only usable in scripted plugins.  If you call to API commands and want to be able to undo them, you need execute those operations through this class.  See this example [[API: undoing commands]].
*Used for node creation, deletion, attribute connection, disconnection, attribute addition, attribute removal, node renaming, mel execution, etc.
>''[[MDagModifier|http://download.autodesk.com/us/maya/2010help/API/class_m_dag_modifier.html]]''
>Inherits from {{{MDGModifier}}}
>"...used to change the structure of the DAG (subset of the DG, focusing on transforms\shapes). This includes adding nodes, making new connections, and removing existing connections.
!!![[MDistance|http://download.autodesk.com/us/maya/2010help/API/class_m_distance.html]]
"... provides a fundamental type for the Maya API to hold and manipulate linear data. All API methods that require or return distance information do so through variables of this type."
*Great for converting from ui units to system units and vice-versa.
!!![[MEulerRotation|http://download.autodesk.com/us/maya/2010help/API/class_m_euler_rotation.html]]
"This class provides methods for working with euler angle rotations."
!!![[MFileIO|http://download.autodesk.com/us/maya/2010help/API/class_m_file_i_o.html]]
"Methods for opening, saving, importing, exporting, and referencing files."
Also gives query methods for many data items as well (like the scene name, for example).
*Closely mirrors functionality found in the mel {{{file}}} command.
!!![[MGLFunctionTable|http://download.autodesk.com/us/maya/2010help/API/class_m_g_l_function_table.html]]
"...is a utility class which provides wrappers for the basic functions in the OpenGL API"
*An instance of this class can be obtained from [[MHardwareRenderer.glFunctionTable()|  http://download.autodesk.com/us/maya/2010help/API/class_m_hardware_renderer.html]]
!!![[MGlobal|http://download.autodesk.com/us/maya/2010help/API/class_m_global.html]]
"Provide methods for selection, 3D-views, time, model manipulation and MEL commands."
Many, many usable methods in here.
*{{{deleteNode(MObject)}}} : Delete the given node.
*{{{executeCommand(...)}}} :  Has a variety of parameter signatures, executes a mel command.
*{{{getActiveSelectionList(MSelectionList)}}} : Fill a {{{MSelectionList}}} with what is currently selected ({{{MObject}}}s).
*{{{getFunctionSetList	(MObject, MStringArray)}}} : Get a list of strings representing the function sets that will accept this object
*{{{select(MObject)}}} : Put the given object on the active selection list.
*{{{select(MDagPath, MObject) : Put the given object ({{{MDagPath}}}) and components ({{{MObject}}}) on the active selection list.
*{{{selectByName(string)}}} : Puts objects that match the give name on the active selection list, can use regular expressions.
*{{{setOptionVarValue(string, int)}}} : Set an optionVar with an int value.  More similar commands for setting other data types.
*{{{sourceFile(string)}}} :  Sources a mel script.
*{{{viewFrame(double)}}} : Sets the current frame.
!!![[MImage|http://download.autodesk.com/us/maya/2010help/API/class_m_image.html]]
"...provides access to some of Maya's image manipulation functionality."
!!![[MImageFileInfo|http://download.autodesk.com/us/maya/2010help/API/class_m_image_file_info.html]]
"...used to describe the characteristics of an image file, such as dimensions, channel count, and pixel format."
!!![[MObject|http://download.autodesk.com/us/maya/2010help/API/class_m_object.html]]
"The generic class for accessing all Maya internal modelling, animation and rendering Objects, collectively referred to as Model Objects, through the API. This includes all Dependency Graph (DG) Nodes, of which Directed Acyclic Graph (DAG) Nodes are a subset."
*{{{isNull()}}} : Returns True\False on whether it is a valid {{{MObject}}} or not.
*{{{hasFn(MFn.kSomeConstant)}}} : Query to determine if the {{{MObject}}} is comaptible with a given Function Set.function.
Use [[MFnDependencyNode|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_dependency_node.html]] function set to operate on this type.
See:
*[[API: MObject and MDagPath]]
!!![[MMatrix|http://download.autodesk.com/us/maya/2010help/API/class_m_matrix.html]]
"A matrix math class for 4x4 matrices of doubles."
!!![[MPlug|http://download.autodesk.com/us/maya/2010help/API/class_m_plug.html]]
"A plug is a point on a dependency node where a particular attribute can be connected."
*Similar to the mel commands {{{connectionInfo}}}, {{{isConnected}}}, {{{getAttr}}}, {{{setAttr}}}
!!![[MPoint|http://download.autodesk.com/us/maya/2010help/API/class_m_point.html]]
"This class provides an implementation of a point. Numerous convienence operators are provided to help with the manipulation of points. This includes operators that work with the {{{MVector}}} and {{{MMatrix}}} classes."
!!![[MProgressWindow|http://download.autodesk.com/us/maya/2010help/API/class_m_progress_window.html]]
"...manages a window containing a status message, a graphical progress gauge, and optionally a "Hit ESC to Cancel" label for interruptable operations."
*This is like the mel {{{progressWindow}}} command.
!!![[MQuaternion|http://download.autodesk.com/us/maya/2010help/API/class_m_quaternion.html]]
"...provides methods for working with Quaternions"
!!![[MScriptUtil|http://download.autodesk.com/us/maya/2010help/API/class_m_script_util.html]]
"Utility class for working with pointers to basic types such as int, float and arrays of these types."
*Used heavily by Python scripting in the API to make it jive with c++ syntax.
*Some good notes [[HERE|http://www.chadvernon.com/blog/resources/maya-api-programming/mscriptutil/]].
!!![[MSelectionList|http://download.autodesk.com/us/maya/2010help/API/class_m_selection_list.html]]
"A list of {{{MObject}}}s."
*{{{add()}}} :  Accepts strings (using wildcards), {{{MObject}}}, {{{MDagPath}}}, and {{{MPlug}}}.
*{{{clear()}}} : Empty the selection list.
*{{{getDagPath(int, MDagPath, MObject)}}} :  For the given index, get the dag path {{{MDagPath}}} and component {{{MObject}}} (if present).
*{{{getDependNode(int, MObject)}}} : Get the {{{MObject}}} at the given index.
*{{{getPlug	(int, MPlug)}}} : Get the plug (attribute) at the given index).
*{{{getSelectionStrings(MStringArray)}}} : Gets the string representations of the items in the selection list.
*{{{getSelectionStrings(int, MStringArray)}}} :  Gets the string representations of the items in the selection list at the given index.
*{{{length()}}} Returns the length of the list.
!!![[MTime|http://download.autodesk.com/us/maya/2010help/API/class_m_time.html]]
"Set and retrieve animation time values in various unit systems."
!!![[MTransformationMatrix|http://download.autodesk.com/us/maya/2010help/API/class_m_transformation_matrix.html]]
"...allows the manipulation of the individual transformation components (eg scale, rotation, shear, etc) of a four by four transformation matrix."
!!![[MVector|http://download.autodesk.com/us/maya/2010help/API/class_m_vector.html]]
"A vector math class for vectors of doubles."

!~MFn
Notes:
*Wrappers to make accessing common object easier. 'Fn' = 'Function'. They wrapper "functionality". Any class with this prefix is a function set used to operate on {{{MObject}}}s of a particular type.
*All {{{MFn}}} classes (except for {{{MFn}}} itself) inherit from [[MFnBase|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_base.html]].  The below hierarchy illustrates the class inheritance tree.
*The //mel// command {{{nodeType}}}, via it's {{{apiType}}} flag can be used to query the {{{MFn}}} type of a DAG node, which can then be used to find what type of function set to use.
*Bit of craziness:  Since Maya stores the Python API in different packages (see [[API: class organization]]), it's possible that this inheritance can span multiple packages.  For example, this is the inheritance tree for {{{MFnSkinCluster}}}, which as you'll see inherits from two different packages; {{{OpenMaya}}} and {{{OpenMayaAnim}}}:
**{{{OpenMaya.MFnBase}}}  (superclass)
***{{{OpenMaya.MFnDependencyNode}}}
****{{{OpenMayaAnim.MFnGeometryFilter}}}
*****{{{OpenMayaAnim.MFnSkinCluster}}} (subclass)
!!![[MFn|http://download.autodesk.com/us/maya/2010help/API/class_m_fn.html]]
"{{{MFn}}} encapsulates all API Function Set type identifiers used for RTTI in the API."
Meaning, the {{{MFn}}} class holds the constants ({{{MFn.k*}}}) that can be tested against to determine what type function objects can be attached to an {{{MObject}}}.  Used with {{{MObject.hasFn()}}}
!!![[MFnBase|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_base.html]]
It has two useful methods:
*{{{setObject(MObject)}}} that allows for an {{{MObject}}} to be assigned to the function set after it was created.
*{{{object()}}}, which returns the {{{MObject}}} assigned to the function set.
----
>[[MFnAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_attribute.html]]
>"Dependency node attribute function set."
----
>[[MFnComponent|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_component.html]]
>"This is the base class for all function sets which deal with component objects.  Components are [[MObjects|API: MObject and MDagPath]] which hold index information for shapes.   Examples of these types are mesh vertices (single indexed), nurbs surface CVs (double indexed), and lattice points (triple indexed)."
----
>>[[MFnSingleIndexedComponent|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_single_indexed_component.html]]
>>[[MFnDoubleIndexedComponent |http://download.autodesk.com/us/maya/2010help/API/class_m_fn_double_indexed_component.html]]
>>[[MFnTripleIndexedComponent |http://download.autodesk.com/us/maya/2010help/API/class_m_fn_triple_indexed_component.html]]
----
>[[MFnDependencyNode|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_dependency_node.html]]
>"...allows the creation and manipulation of dependency graph nodes ({{{MObject}}}). Traversal of the dependency graph is possible using the getConnections method."
>* {{{MFnDependencyNode()}}} : Creation, no passed in object.
>* {{{MFnDependencyNode(MObject)}}} :  Creation, passing in an {{{MObject}}}.
>* {{{create(string)}}} : (has other signatures, but this one is easiest) : ''Creates a new dependency node with the given type''. The new node is placed into the dependency graph.
>* Many methods for node creation, getting connections, name setting, plug (attr) finding, attribute addition and removal, locking & unlocking, query if referenced, query parent namepace, query if name is unique, query if made via plug-in, and more...
----
>>[[MFnAnimCurve|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_anim_curve.html]]
>>"Create, query and edit Anim Curve Nodes and the keys internal to those Nodes."
>>*Many, many methods for interacting with animCurves.
----
>>[[MFnExpression|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_expression.html]]
>>"...used to create, edit, and query expression nodes"
----
>>[[MFnGeometryFilter|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_geometry_filter.html]]
>>"...the function set for geometry filters, the node that is the base class for deformers. Geometry filter nodes include ''clusters, ffds, nonlinears, user-defined deformers, sculpts, wires and blendShapes''. The purpose of the geometry filter is to connect to the geometry that is deformed. The geometry filter is independent of any algorithm that calculates the deformation."
----
>>>[[MFnSkinCluster|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_skin_cluster.html]]
>>>"...the function set for skinClusters"
----
>>[[MFnDagNode|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_dag_node.html]]
>>"Provides methods for attaching Function Sets to, querying, and adding children to DAG Nodes ({{{MDagPath}}}). Particularly useful when used in conjunction with the DAG Iterator class ({{{MItDag}}})."
>>* {{{MFnDagNode()}}} : Creation with no dag path.
>>* {{{MFnDagNode(MDagPath)}}} : Creation based on a dag path.
>>*Many methods for querying parents, querying children, duplication, node creation, parenting, unparenting, etc.
----
>>>[[MFnMesh|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_mesh.html]]
>>>"...provides access to polygonal meshes"
----
>>>[[MFnTransform|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_transform.html]]
>>>"... provides access to transformation DAG nodes called transforms."
>>>* Creation, transformation, value query, etc.
----
>>>>[[MFnIkHandle|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_ik_handle.html]]
>>>>"This is the function set for inverse kinematics (IK) handles. An ik handle specifies the joints in a skeleton that are effected by an attached ik solver."
----
>>>>[[MFnIkJoint|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_ik_joint.html]]
>>>>"...function set for joints."
----
>[[MFnData|http://download.autodesk.com/us/maya/2010help/api/class_m_fn_data.html]]
>* "... is the parent class for all dependency graph data function sets. Conceptually, data objects are what flow through the connections in the dependency graph.  Each node in the dependency graph has a data block associated with it. The data block holds the data objects for all of the node's attributes (see {{{MDataBlock}}}). The data block is only available during the compute method of a node. A data handle ({{{MDataHandle}}}) can be created to access a particular attribute's data inside of the data block."
----
>>[[MFnMatrixData|http://download.autodesk.com/us/maya/2010help/api/class_m_fn_matrix_data.html]]
>>*"...allows the creation and manipulation of {{{MMatrix}}} data objects for use in the dependency graph."
>>*This can be used //within user-created// nodes to access matrix data.

!~MIt
Notes:
*Used for iterating though data (for looping through things). 'It' = 'Iterator'. They wrapper "iteration". These classes are iterators and work on {{{MObject}}}s similar to the way a function set ({{{MFn}}} classes) does.
!!![[MItDag|http://download.autodesk.com/us/maya/2010help/API/class_m_it_dag.html]]
"Use the DAG iterator to traverse the DAG either depth first or breadth first, visiting each node and, if desired, retrieving the node (as an {{{MObject}}})."
See:
*[[API: OpenMaya.MItDag]]
!!![[MItDependencyGraph|http://download.autodesk.com/us/maya/2010help/API/class_m_it_dependency_graph.html]]
"Iterate over Dependency Graph (DG) Nodes or Plugs starting at a specified root Node or Plug."
See:
*[[API: OpenMaya.MItDependencyGraph]]
!!![[MItDependencyNodes|http://download.autodesk.com/us/maya/2010help/API/class_m_it_dependency_nodes.html]]
"Use the dependency node iterator to traverse all the nodes in Maya's Dependency Graph."
See:
*[[API: OpenMaya.MItDependencyNodes]]
!!![[MItGeometry|http://download.autodesk.com/us/maya/2010help/API/class_m_it_geometry.html]]
"... is the iterator class for geometry data, and can be used to loop over the ~CVs of NURBS, the points of subds & lattices, and the vertices of polygonal meshes."
*{{{MItGeometry(MDagPath, MObject)}}} : Create a new object, passing in the path to the active node ({{{MDagPath}}}) and an {{{MObject}}} of the components to iterate over.
*{{{index()}}} : Get the index of the current component.
*{{{position(OpenMaya.MSpace.kWorld)}}} : Get the position of the current component as a {{{MPoint}}}.
*{{{setPosition(MPoing)}}} : Set the position of the current point.
!!![[MitMeshEdge|http://download.autodesk.com/us/maya/2010help/API/class_m_it_mesh_edge.html]]
"...is the edge iterator for polygonal surfaces"
!!![[MItMeshFaceVertex|http://download.autodesk.com/us/maya/2010help/API/class_m_it_mesh_face_vertex.html]]
"...is the iterator for face vertices on polygonal surfaces."
!!![[MItMeshPolygon|http://download.autodesk.com/us/maya/2010help/API/class_m_it_mesh_polygon.html]]
"... is the iterator for polygonal surfaces (meshes)."
*Good for querying or setting all verts on a mesh at once (for example)
!!![[MItMeshVertex|http://download.autodesk.com/us/maya/2010help/API/class_m_it_mesh_vertex.html]]
"...is the iterator for polygonal vertices."
!!![[MItSelectionList|http://download.autodesk.com/us/maya/2010help/API/class_m_it_selection_list.html]]
"Iterate over the items in the selection list."
*{{{MItSelectionList(MSelectionList)}}} :  Creation, based on a pre-existing {{{MSelectionList}}}
*{{{getDagPath(MDagPath, MObject)}}} :  Get the path to the current object ({{{MDagPath}}}) and a {{{MObject}}} representing any selected components.
!!![[MItKeyframe|http://download.autodesk.com/us/maya/2010help/API/class_m_it_keyframe.html]]
"Iterate over the keyframes of a particular Anim Curve Node..."

!~MPx
Notes:
*Used for creating custom plugins. 'Px' = 'Proxy'. They are API classes designed for you to derive from and create your own object types.
!!![[MPxCommand|http://download.autodesk.com/us/maya/2010help/API/class_m_px_command.html]]
"This is the proxy class for creating MEL commands through the API."
!!![[MPxNode|http://download.autodesk.com/us/maya/2010help/API/class_m_px_node.html]]
"Base class for user defined dependency nodes."
If you've authored a custom scripted-plugin [[MPxNode|http://download.autodesk.com/us/maya/2010help/API/class_m_px_node.html]] (or a derived class, like [[MPxLocatorNode|http://download.autodesk.com/us/maya/2010help/API/class_m_px_locator_node.html]]), via ~OpenGL you can draw text to the screen that follows it.  Below is a code snippet showing parts of the class that you can use to implement this functionality.

I pulled the concepts of this from [[this example|http://download.autodesk.com/us/maya/2010help/API/foot_print_manip_8py-example.html]]

I should note that I've encountered a bug where the text seems to translate 1.5x greater than that of the node... and I have yet to find a solution :(
{{{
import maya.OpenMaya as om
import maya.OpenMayaUI as omui
import maya.OpenMayaMPx as ompx

class Foo(ompx.MPxLocatorNode):

def __init__(self):
"""
Superclass override.
"""
ompx.MPxLocatorNode.__init__(self)
# Save an empty MDagPath that will later be the path to our node.
self.mDagPath = om.MDagPath()

def draw(self, view, path, style, status):
"""
Superclass override, where the text drawing happens.
"""
view.beginGL()  # M3dView
view.drawText("TestText!", self.nodeTranslation(), omui.M3dView.kLeft)
view.endGL()

def nodeTranslation(self):
"""
Custom method that returns a MPoint object based on the worldspace
position of our locator node.
"""
# Get the dag path to this object:
om.MDagPath.getAPathTo(self.thisMObject(), self.mDagPath)
# Pop from the shape to the transform
self.mDagPath.pop()
# Find the translation of the node in worldspace:
transformFn = om.MFnTransform(self.mDagPath) # MFnTransform
vec = transformFn.getTranslation(om.MSpace.kWorld) # MVector
# Convert from internal units (cm) to whatever the UI is using:
return om.MPoint(om.MDistance.internalToUI(vec.x),
om.MDistance.internalToUI(vec.y),
om.MDistance.internalToUI(vec.z))
}}}
Docs:
*[[M3dView|http://download.autodesk.com/us/maya/2011help/API/class_m3d_view.html]]
*[[MFnTransform|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_transform.html]]
*[[MPxLocatorNode|http://download.autodesk.com/us/maya/2010help/API/class_m_px_locator_node.html]]
*[[MPxNode|http://download.autodesk.com/us/maya/2010help/API/class_m_px_node.html]]
*[[MDagPath|http://download.autodesk.com/us/maya/2010help/API/class_m_dag_path.html]]
*[[MDistance|http://download.autodesk.com/us/maya/2010help/API/class_m_distance.html]]
*[[MPoint|http://download.autodesk.com/us/maya/2011help/API/class_m_point.html]]
The below code is something I came up with to list all the attributes on a node via the API, the values stored in their plugs, and the API attribute type.  It seems //really// clunky, and maybe in six months I'll find some function that does this in two lines.  But it seems like the API makes you test against which function set the attribute belongs to, and then have to query for a very specific type of data.  After I authored this I cam across Bryan Ewerts post [[here|http://ewertb.soundlinker.com/api/api.029.php]], which uses a very similar system, so I'm guessing I'm on the right track.
Some notes:
*I had to wrap every query in a try\except clause, since some data would return None even though it was defined as a given type.
*I have yet to figure out how to query string data.  It just fails :(
*As noted below, the code ''fails to trace array attribute element plug data''.  It shows a weird {{{[-1]}}} for the index, and won't dig any deeper.  However, a link to a solution is provided at the end of this topic.
Some helper functions:
{{{
import maya.OpenMaya as om

def nameToMObject(name):
"""
return an MObject based on the provided string node name.
"""
selectionList = om.MSelectionList()
selectionList.add(name)
node = om.MObject()
selectionList.getDependNode( 0, node )
return node

def getAllPlugs(mObject):
"""
return a list of all the plugs for all the attributes on the given MObject.
"""
ret = []
depNodeFn = om.MFnDependencyNode(mObject)
attrCount = depNodeFn.attributeCount()
for i in range(attrCount):
attrObject = depNodeFn.attribute(i)
mPlug = depNodeFn.findPlug(attrObject)
ret.append(mPlug)
return ret
}}}
Main code:
{{{
objectName = 'pPlaneShape1'
mObject = nameToMObject(objectName)
plugs = getAllPlugs(mObject)

# Query\print values:
for plug in plugs:
attr = plug.attribute() # MObject for the coresponding attribute
val = []
#--------------------------------------------------------
# Now test to see what type of attr it is!

# Is it numeric?
if attr.hasFn(om.MFn.kNumericAttribute):
fnAttr = om.MFnNumericAttribute(attr)
unitType = fnAttr.unitType()
if unitType == om.MFnNumericData.kBoolean:
try:
val = plug.asBool()
except:
pass
elif unitType == om.MFnNumericData.kChar:
try:
val = plug.asChar()
except:
pass
elif unitType == om.MFnNumericData.kShort:
try:
val = plug.asShort()
except:
pass
elif unitType == om.MFnNumericData.k2Short:
for i in range(2):
try:
val.append(plug.child(i).asShort())
except:
pass
elif unitType == om.MFnNumericData.k3Short:
for i in range(3):
try:
val.append(plug.child(i).asShort())
except:
pass
elif unitType == om.MFnNumericData.kLong or unitType == om.MFnNumericData.kInt:
try:
val = plug.asInt()
except:
pass
elif unitType == om.MFnNumericData.k2Long or unitType == om.MFnNumericData.k2Int:
for i in range(2):
try:
val.append(plug.child(i).asInt())
except:
pass
elif unitType == om.MFnNumericData.k3Long or unitType == om.MFnNumericData.k3Int:
for i in range(3):
try:
val.append(plug.child(i).asInt())
except:
pass
elif unitType == om.MFnNumericData.kFloat:
try:
val = plug.asFloat()
except:
pass
elif unitType == om.MFnNumericData.k2Float:
for i in range(2):
try:
val.append(plug.child(i).asFloat())
except:
pass
elif unitType == om.MFnNumericData.k3Float:
for i in range(3):
try:
val.append(plug.child(i).asFloat())
except:
pass
elif unitType == om.MFnNumericData.kDouble:
try:
val = plug.asDouble()
except:
pass
elif unitType == om.MFnNumericData.k2Double:
for i in range(2):
try:
val.append(plug.child(i).asDouble())
except:
pass
elif unitType == om.MFnNumericData.k3Double:
for i in range(3):
try:
val.append(plug.child(i).asDouble())
except:
pass

# Is it 'typed'?
elif attr.hasFn(om.MFn.kTypedAttribute):
# These can be string attrs
attrType = om.MFnTypedAttribute(attr).attrType()
if attrType == om.MFnData.kString:
# NEITHER SOLUTION HERE IS WORKING!
#stringData = om.MFnStringData(plug.asMObject())
#val = stringData.string()
#val = plug.asString()  # This cause it to break! :(
val = "<string: can't query>"
elif attrType == om.MFnData.kMatrix:
try:
matrixData = om.MFnMatrixData(plug.asMObject())
matrix = matrixData.matrix()
val = [matrix(i,j) for i in range(4) for j in range(4)]
except:
pass

# Is it  angle, time, unit (distance), or enum?
elif attr.hasFn(om.MFn.kDoubleAngleAttribute):
mAngle = plug.asMAngle()
val = mAngle.value()
elif attr.hasFn(om.MFn.kTimeAttribute):
mTime = plug.asMTime()
val = mTime.value()
elif attr.hasFn(om.MFn.kUnitAttribute):
mDist = plug.asMDistance()
val = mDist.value()
elif attr.hasFn(om.MFn.kEnumAttribute):
val = plug.asInt()

# Could add more code for Generic, Light, & Message.  Compound is a type as
# well, but only holds other attrs (has no 'value'), and the previous code
# extracts all the child plugs from any compounds that exist.

if isinstance(val, list):
if not len(val):
val = None
print plug.name(), val, attr.apiTypeStr()
}}}
Prints a lot of stuff:
{{{
pPlaneShape1.message None kMessageAttribute
pPlaneShape1.caching False kNumericAttribute
pPlaneShape1.isHistoricallyInteresting None kNumericAttribute
pPlaneShape1.nodeState 0 kEnumAttribute
etc...
}}}
Furthermore, it won't print out the values for any //array attrs//.  For example, presuming you have a poly mesh and you've modified the UV's, you'd have multiple UV attrs being tweaked on.  But the above code will only print this:
{{{
pPlaneShape1.uvSet None kCompoundAttribute
pPlaneShape1.uvSet[-1].uvSetName <string: can't query> kTypedAttribute
pPlaneShape1.uvSet[-1].uvSetPoints [0.0, 0.0] kAttribute2Float
pPlaneShape1.uvSet[-1].uvSetPoints[-1].uvSetPointsU 0.0 kNumericAttribute
pPlaneShape1.uvSet[-1].uvSetPoints[-1].uvSetPointsV 0.0 kNumericAttribute
pPlaneShape1.uvSet[-1].uvSetTweakLocation None kTypedAttribute
}}}
Which I guess tells you that these are array attributes, but doesn't tell you how many of each there are, or the element plug values (other than the default vals listed).
I have a solution for compound\array attrs here: [[API: Find all child attributes under a compound attribute]]
After much trial and error, I've whipped up the below code to query all the child attributes under a given compound attribute, and print their names \ types.

This was complicated by a variety of factors:
#It took me a while to realize that compound attrs can also be array.  I hadn't quite grasped the differences between them:  Compound is a type, like float or string.  Array is a property of an attribute, like keyable, locked, hidden, etc.
#I was able to query compound children, but I wasn't understanding how to query an array of compound attrs children.  This was further messed up by the fact the {{{MPlug.getExistingArrayAttributeIndices()}}} method will return negative index values, which cause all sorts of problems.  Not sure why it does that, but skipping over them solves the problem.
#Understanding the differences between logical and physical index arrays.  In a nutshell, you want to use logical most of the time...
For more info on those topics, please see this subject: [[API: Attribute Creation & Usage]]

In our example we use a polygonal plane with four verts, called {{{pPlane1}}} (but make reference to its shape node, {{{pPlaneShape1}}}).
{{{
import maya.OpenMaya as om

# The node name, and attribute name, to query:
node = "pPlaneShape1"
attr = "uvSet"

# Get an MObject by string name:
selList = om.MSelectionList()
selList.add(node)
mObject = om.MObject()
selList.getDependNode(0, mObject)

# Attach a function set to the shape and get the plug to start querying:
mFnDependencyNode = om.MFnDependencyNode(mObject)
rootPlug = mFnDependencyNode.findPlug(attr)

# Get all child plugs for our root, presuming it is a compound attr, since they're
# the only type that have 'children':
plugs = [rootPlug]
for plug in plugs:
# If the type is compound, and it is also set to array:
if plug.isCompound() and plug.isArray():
# Find the logical indices of the array:
logicalIndices = om.MIntArray()
plug.getExistingArrayAttributeIndices(logicalIndices)
for i in range(logicalIndices.length()):
# getExistingArrayAttributeIndices() can return negative index values
# for some reason, so we need to be sure to *not* deal with those,
# since obviously bad things would happen....
if logicalIndices[i] >= 0:
# Now find the element plug of that index, which is a compound
# type attribute:
elementPlug = plug.elementByLogicalIndex(logicalIndices[i])
# And query the children of that compound attr:
for j in range(elementPlug.numChildren()):
plugs.append(elementPlug.child(j))
# If it is compound, but not array:
elif plug.isCompound():
# Just get the children of that compound attr:
for i in range(plug.numChildren()):
plugs.append(plug.child(i))

for plug in plugs:
attrObj = plug.attribute() # MObject
print plug.name(), attrObj.apiTypeStr()
}}}
Gives us this result:
{{{
pPlaneShape1.uvSet kCompoundAttribute
pPlaneShape1.uvSet[0].uvSetName kTypedAttribute
pPlaneShape1.uvSet[0].uvSetPoints kAttribute2Float
pPlaneShape1.uvSet[0].uvSetTweakLocation kTypedAttribute
pPlaneShape1.uvSet[0].uvSetPoints[0].uvSetPointsU kNumericAttribute
pPlaneShape1.uvSet[0].uvSetPoints[0].uvSetPointsV kNumericAttribute
pPlaneShape1.uvSet[0].uvSetPoints[1].uvSetPointsU kNumericAttribute
pPlaneShape1.uvSet[0].uvSetPoints[1].uvSetPointsV kNumericAttribute
pPlaneShape1.uvSet[0].uvSetPoints[2].uvSetPointsU kNumericAttribute
pPlaneShape1.uvSet[0].uvSetPoints[2].uvSetPointsV kNumericAttribute
pPlaneShape1.uvSet[0].uvSetPoints[3].uvSetPointsU kNumericAttribute
pPlaneShape1.uvSet[0].uvSetPoints[3].uvSetPointsV kNumericAttribute
}}}
It should be noted that not all attrs are so verbose.  For example, if you set this and re-run it:
{{{
attr = "pnts"
}}}
All it prints is:
{{{
pPlaneShape1.pnts kAttribute3Float
}}}
Even though we know there is more than one point in the plane.  If you grab all the verts and component level, manually move them with the translate manip, and re-run it, it prints:
{{{
pPlaneShape1.pnts kAttribute3Float
pPlaneShape1.pnts[0].pntx kFloatLinearAttribute
pPlaneShape1.pnts[0].pnty kFloatLinearAttribute
pPlaneShape1.pnts[0].pntz kFloatLinearAttribute
pPlaneShape1.pnts[1].pntx kFloatLinearAttribute
pPlaneShape1.pnts[1].pnty kFloatLinearAttribute
pPlaneShape1.pnts[1].pntz kFloatLinearAttribute
pPlaneShape1.pnts[2].pntx kFloatLinearAttribute
pPlaneShape1.pnts[2].pnty kFloatLinearAttribute
pPlaneShape1.pnts[2].pntz kFloatLinearAttribute
pPlaneShape1.pnts[3].pntx kFloatLinearAttribute
pPlaneShape1.pnts[3].pnty kFloatLinearAttribute
pPlaneShape1.pnts[3].pntz kFloatLinearAttribute
}}}
Which tells me that in some cases, the plugs don't exist until some type of user interaction.  Something even crazier I've found:  If instead of grabbing all the verts by hand and deleting them, if I instead run the command:
{{{
delete -constructionHistory;
}}}
On the mesh, the attrs will appear as well.  It must be triggering some kind of massive "you are dirty" flag on all the plugs so they suddenly show up.... or something....

I have yet to find a more elegant solution for this :(
----
Also see:
*[[API: Find all attributes & plugs on a node]]
*[[How can I get a list of all the child multi-attrs, of a given attr name?]] (using the command engine, rather than the API)
''API Code Snippet''

In this example, I set all variable names to be the type of object they are, to make it easier to understand how objects are returned and used.  I don't recommend doing this in regular code, just using it as an explanation tool
__Highlights:__
*Create {{{MItDag}}} 'DAG iterator object' to loop over all mesh.
*Create {{{MDagPath}}} 'DAG path object' for each mesh, giving access to it's path/name.
*Create {{{MFnMesh}}} 'polygonal surface function set' object, allowing for actions to be performed on the current {{{MDagPath}}} object.
{{{
# Print the name of all the mesh in the scene & their vert counts.

import maya.OpenMaya as om

# Make a MItDag iterator object, for mesh only:
MItDag = om.MItDag(om.MItDag.kDepthFirst, om.MFn.kMesh)

# Start looping over each mesh:
while not MItDag.isDone():

# Make a MDagPath object that will store the path of
# the mesh:
MDagPath = om.MDagPath()

# Set the MDagPath object to the path of the current mesh
# as defined by the current loop of the iterator:
MItDag.getPath(MDagPath)

# Create a new MFnMesh object, set to the current dag path.
# We can now do operations on that mesh via that object.
MFnMesh = om.MFnMesh(MDagPath)

# As an example, find the number of verts on the mesh
# from the MFnMesh object:
numVerts = MFnMesh.numVertices()

# get the name of our node from the MDagPath object:
name = MDagPath.fullPathName()

# Print results:
print name, numVerts

# Advance to the next mesh in our iterator:
MItDag.next()
}}}

Example via the ~OpenMaya Python API of finding the closest vertex on a polygonal mesh to a given transform.
I've not tried it, but it may be worth checking out a solution using [[MMeshIntersector|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_mesh_intersector.html]].  There is an example using it online [[here|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/index.html?url=cpp_ref/closest_point_cmd_8cpp-example.html,topicNumber=cpp_ref_closest_point_cmd_8cpp_example_html,hash=_a33]]
For fun, I made two different implementations.  They both do the same thing, just go about it different ways.
{{{
# This first code chunk is required for both examples:

# Python code
from operator import itemgetter
import maya.cmds as mc
import maya.OpenMaya as om

def getMDagPath(nodeName):
"""
Convenience function that returns a MDagPath for a given Maya DAG node.
"""
selList = om.MSelectionList()
selList.add(nodeName)
mDagPath = om.MDagPath()
selList.getDagPath(0, mDagPath)
return mDagPath
}}}
!!!Example A:
In this example, we fill a {{{MPointArray}}} with all the vert positions at once, then do our distance comparisons over that array, filling our final sorted dictionary with the distance results.
{{{
def closestVertToPoint_A(mesh, target):
"""
Parameters:
mesh : string : Polygonal mesh to query vert positions on.
target : string : Any transform to find the closest vertex to.

return : string : Name of the vertex closest to target.
"""
# Maya node definitions:-------------
# Get a MDagPath for our mesh:
node_mDagPath = getMDagPath(mesh)
# Get a MDagPath for our target:
target_mDagPath = getMDagPath(target)

# Target Stuff:-------------
# Get a MFnTransform for our target:
mFnTransform = om.MFnTransform(target_mDagPath)
# Get a MPoint for it's worldspace position:
transform_mPoint = mFnTransform.rotatePivot(om.MSpace.kWorld)

# Mesh stuff:-------------
# Get the MFnMesh:
mFnMesh = om.MFnMesh(node_mDagPath)
# Build a point array to hold our points:
mPointArray = om.MPointArray()
# Fill the array with points:
mFnMesh.getPoints(mPointArray)

# Find closest vert ID: -------------------------
# This is a dictionary, each key:value pair will be vertID:distance
distances = {}
for i in range(mPointArray.length()):
distances[i] = transform_mPoint.distanceTo(mPointArray[i])
# Sort our dictionary by values (the distances), not keys (the vert ID's).
# This turns the dictionary into a list, fyi.
closest = sorted(distances.items(), key=itemgetter(1))[0]

# Return it: ----------------------
# Create the vertex name from the ID:
vertName = '%s.vtx[%s]'%(mesh, closest[0])
return vertName
}}}
!!!Example B:
In this example, we iterate over each vertex querying it's position and doing the distance computation before adding the result to the final sorted dictionary.
{{{
def closestVertToPoint_B(mesh, target):
"""
Parameters:
mesh : string : Polygonal mesh to query vert positions on.
target : string : Any transform to find the closest vertex to.

return : string : Name of the vertex closest to target.
"""
# Maya node definitions:-------------
# Get a MDagPath for our mesh:
node_mDagPath = getMDagPath(mesh)
# Get a MDagPath for our target:
target_mDagPath = getMDagPath(target)

# Target Stuff:-------------
# Get a MFnTransform for our target:
mFnTransform = om.MFnTransform(target_mDagPath)
# Get a MPoint for it's worldspace position:
transform_mPoint = mFnTransform.rotatePivot(om.MSpace.kWorld)

# Mesh stuff:-------------
# This is a dictionary, each key:value pair will be vertID:distance
distances = {}
# Get the MItMeshVertex:
mItMeshVertex = om.MItMeshVertex(node_mDagPath)
while not mItMeshVertex.isDone():
# For the current vert, get it's position:
mPoint = mItMeshVertex.position(om.MSpace.kWorld)
# Find distance:
distance = transform_mPoint.distanceTo(mPoint)
# Get the current vert id:
vertId = mItMeshVertex.index()
distances[vertId] = distance
mItMeshVertex.next()

# Find closest vert ID: -------------------------
for i in range(mPointArray.length()):
distances[i] = transform_mPoint.distanceTo(mPointArray[i])
# Sort our dictionary by values (the distances), not keys (the vert ID's).
# This turns the dictionary into a list, fyi.
closest = sorted(distances.items(), key=itemgetter(1))[0]

# Return it: ----------------------
# Create the vertex name from the ID:
vertName = '%s.vtx[%s]'%(mesh, closest[0])
return vertName
}}}
!!!The results
Do it.  Run a timer to see which one is faster:
{{{
import time
# Polygonal mesh with verts to query:
mesh = 'pSphere1'
# Target we want to find the closest vert to:
target = 'locator1'

# Time A:
start_A = time.time()
closestPoint_A = closestVertToPoint_A(mesh, target)
end_A = time.time()
total_A = end_A - start_A

# Time B:
start_B = time.time()
closestPoint_B = closestVertToPoint_B(mesh, target)
end_B = time.time()
total_B = end_B - start_B

print "Total time for example A:", total_A
print "Total time for example B:", total_B
print "Closest vert:", closestPoint_A
mc.select(closestPoint_A)
}}}
I made a sphere with 100 subdivision (9902 verts), and these were the results:
{{{
Total time for example A: 0.031
Total time for example B: 0.047
Closest vert: pSphere1.vtx[4298]
}}}
So it looks like A is about 1.5x  faster than B.
{{{
import maya.OpenMaya as om

node = "pPlaneShape1"
attr = "uvSetPoints"

# Get an MObject by string name:
selList = om.MSelectionList()
selList.add(node)
mObject = om.MObject()
selList.getDependNode(0, mObject)

# Get a plug based on the attribute string name:
mFnDependencyNode = om.MFnDependencyNode(mObject)
plug = mFnDependencyNode.findPlug(attr)
print plug.name()
}}}
{{{
# pPlaneShape1.uvSet[-1].uvSetPoints
}}}
*http://download.autodesk.com/us/maya/2010help/API/class_m_plug.html
*http://download.autodesk.com/us/maya/2010help/API/class_m_fn_dependency_node.html
Docs for [[MNodeMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_node_message.html]]
There is the {{{scriptJob}}}'s {{{attributeChange}}} argument of course.  But if you wanted to do this via the api, the below code functions.  That being said, it seems to trigger far more often than it should:  In the below example, it should only trigger if the {{{translateX}}} attribute is modified... but it will trigger seemingly when any of the attrs are modified:  Even though the value of tx hasn't changed, Maya seems to list it as changed... maybe internally it's triggering off the dirty state of the node.
There are the {{{MNodeMessage::AttributeMessage}}} enums that are designed to limit what is evaluated, but I did a test, and none of them will trigger on an attribute //change//.
{{{
import maya.OpenMaya as om

# Get an MObject for our node:
node = 'pSphere1'
selList = om.MSelectionList()
selList.add(node)
mObject = om.MObject()
selList.getDependNode(0, mObject)

# Callback code:
def callback(msg, plug, otherPlug, *args):
if 'translateX' in plug.name():
print "Attribute Changed : ", msg
val = om.MDistance.internalToUI(plug.asDouble())
print "\tplug:", plug.name(), val
print "\totherPlug:", otherPlug.name()
print "\tClient Data:", args

# Create the callback:
cid = om.MNodeMessage.addAttributeChangedCallback(mObject, callback, "arbitraryClientData")

# Delete the callback later:
om.MMessage.removeCallback(cid)
}}}
----
Also see:
*[[API: How can I author callbacks for Maya events?]]
The most common way to do this is via mel [[scriptJobs|http://download.autodesk.com/us/maya/2011help/Commands/scriptJob.html]].  But via the {{{OpenMaya}}} API, you can access many 'Message' classes that provide a lot more functionality to areas that {{{scriptJob}}}'s don't provide.

It should be noted that if you keep executing the same callback creation code, they'll start to pile up.  You'll need to develop a system to track if they've been made, so as to not have a lot of extra duplicate callbacks running in the background.

In the below example, we add a callback function that will be executed just before a new scene is opened via a {{{OpenMaya.MSceneMessage}}} object.  As a simple hack, we track its existence with a global mel variable.
{{{
# Python code
import maya.mel as mm
import maya.OpenMaya as om

def callback(*args):
"""
Put your callback execution code in here.
"""
print "CALLBACK!"

def makeCallback():
"""
Creates the callback, doesn't allow dupes:
"""
# Pass mel variable to Python:
mm.eval("global int $gMyCallbackExists;") callbackExists = int(mm.eval("int$callbackExists = $gMyCallbackExists;")) if not callbackExists: om.MSceneMessage.addCallback(om.MSceneMessage.kBeforeNew, callback) mm.eval("global int$gMyCallbackExists = 1")
}}}
To create the callback:
{{{
makeCallback()
}}}
And when making a new scene from the main menu:
{{{
file -f -new;
CALLBACK!
// Result: untitled //
}}}
----
''@@It should be noted@@'' that the above system is a bit of an example-hack.  In practice, I've ran into problems with associating callbacks with a windows existence:  A memory leak can (possibly) form from closing a window that a callback is associated with, and not also unregistering the callback.  A common warning I'd get in the Output Window is:
{{{
swig/python detected a memory leak of type 'MCallbackId *', no destructor found.
}}}
And it would even crash Maya.  [[This thread|http://www.mail-archive.com/python_inside_maya@googlegroups.com/msg00200.html]] addresses some of these issues.
Here's some pseudo-code that will assist in the proper creation, and removal, of a callback:
{{{
# Below are methods\attributes on some instance of a class:

def makeCallback(self):
"""
Method that makes the callback.
"""
# self.callbackId is now of type MCallbackId, which appears to be a swig wrapper of a pointer
# to an unsigned integer.
self.callbackId = om.MSceneMessage.addCallback(om.MSceneMessage.kBeforeNew, callback)

def destroyCallback(self):
"""
Method called when callback should be destroyed.
"""
# Properly remove the callback:
om.MMessage.removeCallback(self.callbackId)
# Call a method on the swig object to 'disown' it, and remove the warning statement:
self.callbackId.disown()
}}}
----
Here is a general list I've come up with for the various classes, and what they can set callbacks for:
([[Maya 2011 API docs|http://download.autodesk.com/us/maya/2011help/API/classes.html]])
*[[MMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_message.html]]
**Listed first, this is the base class for all message callbacks (below).  Mainly used to remove a message callback, but has other helper methods.
*[[MAnimMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_anim_message.html]]
**Callbacks for animation messages:  animCuve edited, keyframe edited
*[[MCameraSetMessage|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-ocumentation/cpp_ref/class_m_camera_set_message.html]]
**Callbacks for {{{cameraSet}}} sepcific envent types:  Adding\removing camera layers, camera name changes.
*[[MCommandMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_command_message.html]]
**Callbacks triggering on //mel command// execution.
*[[MConditionMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_condition_message.html]]
**Callbacks for changes to specific //conditions//, same conditions found in the [[scriptJob|http://download.autodesk.com/us/maya/2010help/CommandsPython/scriptJob.html]] documentation.
*[[MContainerMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_container_message.html]]
**Callbacks that inform about changes to published attributes on container node types.
*[[MDagMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_dag_message.html]]
**Callbacks for dependency graph messages:  Parent added, removed.   Child added, removed, reordered. Instance added, removed.
*[[MDGMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_d_g_message.html]]
**Callbacks for dependency graph messages:  Time changed, node added, node removed, connection made or broken.
*[[MEventMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_event_message.html]]
**Callbacks for specific //events//, same events found in the [[scriptJob|http://download.autodesk.com/us/maya/2010help/CommandsPython/scriptJob.html]] documentation.
*[[MLockMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_lock_message.html]]
**Callbacks that control how Maya handles locks:  On object and attributes.
*[[MModelMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_model_message.html]]
**Callbacks for model related messages:  Before and after node duplicate, before dag node added (created), during dag node removed (deleted).
*[[MNodeMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_node_message.html]]
**Callbacks for dependency node messages of specific dependency nodes:  Attribute changed, added, or removed.  Plug dirty.  Before node deleted.  Attr keyable state change.
*[[MObjectSetMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_object_set_message.html]]
**Callbacks for object set messages received by specific sets.  Tracks if set members are modified.
*[[MPolyMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_poly_message.html]]
**Callbacks for poly component id modification messages:  Vertex, edge, or face component id's modified.
*[[MSceneMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_scene_message.html]]
**Callbacks for scene related messages:
**__Before & after__:  new file, file import, file open, file export, file save, file save-as, file reference, remove-reference, import reference, export reference, unload reference, software render, each software render frame. plugin loaded, plugin unloaded.
**After any operation that changes which files are loaded, when an interactive render is interrupted by the user, on interactive or batch startup after initialization, just before Maya exits.
*[[MTimerMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_timer_message.html]]
**Callbacks that are based on a fixed time interval.
*[[MUiMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_ui_message.html]]
**Callbacks to track the deletion of UI objects.  Window deletion, camera change, 3d view destroyed, 3d view about to render contents, 3d view about to display contents.
*[[MUserEventMessage|http://download.autodesk.com/us/maya/2011help/API/class_m_user_event_message.html]]
**Register user-defined event types, register callbacks with the user-defined event types, and to post user-defined messages.
**See example usage here: [[API : How can I author a user event?]]

----
There are a few other classes independent from the Message ones:
*[[MHwrCallback|http://download.autodesk.com/us/maya/2011help/API/class_m_hwr_callback.html]]
**Callbacks to gain access to Maya's Hardware Rendering device status. You can be notified of device creation, lost reset and deletion.
*[[MRenderCallback|http://download.autodesk.com/us/maya/2011help/API/class_m_render_callback.html]]
**Callbacks to gain access to Maya's rendering information during software rendering. You can modify Maya's shadow maps, RGB pixmap, and depth map to composite your own rendering effects into Maya's rendering.
*[[MCallbackIdArray|http://download.autodesk.com/us/maya/2011help/API/class_m_callback_id_array.html]]
**An array of {{{MCallbackId}}}.  These can be passed to {{{MMessage}}} instances.

----
And via {{{OpenMayaUI}}}:
*[[MEvent|http://download.autodesk.com/us/maya/2011help/API/class_m_event.html]]
**Used for querying system events such as mouse presses:  Mouse button press, release, hold, drag.  Delete/backspace key event. Complete key event.  Querying\setting event location.


Docs: [[MFnDependencyNode|http://download.autodesk.com/us/maya/2011help/API/class_m_fn_dependency_node.html]]
{{{
import maya.OpenMaya as om

depNodeFunc = om.MFnDependencyNode()
node = depNodeFunc.create("transform") # MObject
}}}
Or if you don't care about the actual {{{MFnDependencyNode}}} class object, you can skip its storage:
{{{
node = MFnDependencyNode().create("transform")
}}}
As you can see from the example, the {{{MFnDependencyNode}}} class can easily create a physical Maya node (in this case called 'transform1' in the Outliner) via its {{{create()}}} method, which is returned as a {{{MObject}}}.  Furthermore, {{{MFnDependencyNode}}} is the superclass of many other {{{MFn}}} classes, so the {{{create()}}} method can be called from them as well.  For example, this is the class inheritance tree for the {{{MFnSkinCluster}}} class:
*{{{OpenMaya.MFnBase}}} (superclass)
**{{{OpenMaya.MFnDependencyNode}}}
***{{{OpenMayaAnim.MFnGeometryFilter}}}
****{{{OpenMayaAnim.MFnSkinCluster}}} (subclass)
So let's build a {{{skinCluster}}} Maya node:
{{{
import maya.OpenMayaAnim as oma

skinClusterFn = oma.MFnSkinCluster()
# Call the create() method from the MFnDependencyNode superclass.  Could
# just as easily make any other node type with this call, not just a skinCluster:
skinCluster = skinClusterFn.create("skinCluster") # MObject
}}}
----
It should be noted that creating nodes this way bypasses the undo queue.  If you want to have this be undoable, you'll have to manage it through a scripted plugin, see: [[API: undoing commands]].  This makes use of [[OpenMaya.MDagModifier|http://download.autodesk.com/us/maya/2010help/API/class_m_dag_modifier.html]] and its superclass [[OpenMaya.MDGModifier|http://download.autodesk.com/us/maya/2010help/API/class_m_d_g_modifier.html]].
----
In addition to above, {{{OpenMaya.MGlobal.addToModel(MObject)}}} can also be used.  However, I'm not sure (yet) how to make an {{{MObject}}} representing a node that doesn't actually already exist in the DG.
When dealing with node names, Maya commands like {{{ls}}} return back the //string// representation of the nodes.  Things can get complicated really quick when there are duplicate names in the scene, or when nodes get renamed:  You can no longer accurately reference them by their string name.

{{{MDagPath}}} objects instead store a pointer to where the node lives in memory:  Other than deleting the node, this location won't change, even if the name does.  Because of this, duplicate node names and node renaming issues suddenly go away.

The below functions will convert a list of string names to {{{MDagPath}}} objects, and convert a list of {{{MDagPath}}} objects back to strings.
{{{
import maya.cmds as mc
import maya.OpenMaya as om

def MDP(names):
"""
Will filter out any non-DAG objects.

Parameters:
names : list : List of string names to convert to MDagPath objects.

Return : list : List of MDagpPath objects.
"""
dag = mc.ls(names, dagObjects=True)
mdp = []
selList = om.MSelectionList()
for name in dag:
selList.clear()
mDagPath = om.MDagPath()
selList.add(name)
selList.getDagPath(0, mDagPath)
mdp.append(mDagPath)
return mdp

def STR(mdp):
"""
Parameters :
mdp : list : List of MDagPath objects.

Return : list : List of the coresponding full path string names.
"""
return [item.fullPathName() for item in mdp]
}}}
Picking the {{{persp}}} camera and it's shape {{{perspShape}}}:
{{{
dpaths = MDP(mc.ls(selection=True))
print dpaths
strs = STR(dpaths)
print strs

[<maya.OpenMaya.MDagPath; proxy of <Swig Object of type 'MDagPath *' at 0x0000000023318510> >, <maya.OpenMaya.MDagPath; proxy of <Swig Object of type 'MDagPath *' at 0x0000000023318570> >]
[u'|persp', u'|persp|perspShape']
}}}
Presuming you need to call to //mel// someplace in your scripted plugin (rather than the Python version of the command), the {{{maya.OpenMaya.MGlobal.executeCommand()}}} method will do the trick:
{{{
# Python code:
import maya.OpenMaya as om
om.MGlobal.executeCommand("cylinder")
}}}
That's the most simple way to do it.  There are also solutions for capturing the results:
{{{
import maya.OpenMaya as om

cmdResult = om.MCommandResult()
theResult = []

melCmd = 'string $b[] = polySphere;' display, undo = True, True om.MGlobal.executeCommand(melCmd, cmdResult, display, undo) cmdResult.getResult(theResult) print theResult }}} When executed, this is printed in the Script Editor: {{{ string$b[] = polySphere;
// Result: pSphere1 polySphere1 //
[u'pSphere1', u'polySphere1']
}}}
*[[OpenMaya.MGlobal|http://download.autodesk.com/us/maya/2010help/API/class_m_global.html]]
*[[OpenMaya.MCommandResult|http://download.autodesk.com/us/maya/2010help/API/class_m_command_result.html]]

I wanted to find the centerpoint of a node using the API.  Below is one way to do it.  The only real wrinkle is that the API, as usual, returns the results as cm, and in my case, I'm working in inches (yuck).  So you have to do that conversion.

In a nutshell, I find the bounding box for the node, find the bounding box's center point, then convert that location into the proper linear units.
{{{
import maya.cmds as mc
import maya.OpenMaya as om

# Name of the node to query:
node = 'myFancyMesh'

# Get a MDagPath for our node:
selList = om.MSelectionList() # MSelectionList
selList.add(node)
mDagPath = om.MDagPath() # MDagPath
selList.getDagPath(0, mDagPath)

# Find the centerpoint:
dagNodeFunc = om.MFnDagNode(mDagPath) # MfnDagNode
boundingBox = dagNodeFunc.boundingBox() # MBoundingBox
centerPoint = boundingBox.center() # MPoint

# Convert from cm to current units:
center = []
unitType = om.MDistance.uiUnit()
for i in range(3):
distance = om.MDistance(centerPoint[i]) # MDistance, as cm
converted = distance.asUnits(unitType) # double, converted
center.append(converted)

print center
}}}
Little more work than the mel {{{listRelatives}}} command ;)
{{{
import maya.OpenMaya as om

# Presume dagPath is a MDagPath object
dagPathFunc = om.MFnDagNode(dagPath)
kids = []
for i in range(dagPathFunc.childCount()):
kids.append(dagPathFunc.child(i))

# kids is a list of MObjects, one for each child node.
}}}
Wow, so easy:
{{{
# Python code
import maya.OpenMaya as om
import maya.OpenMayaUI as omui

fileType = 'jpg'
imageFile = 'c:/temp/mayaScreen.%s'%fileType
mimage = om.MImage()
view = omui.M3dView.active3dView()
view.readColorBuffer(mimage, True)
mimage.writeToFile(imageFile, fileType)
}}}
From the {{{MImage}}} docs, these image formats are supported for output:
*iff, sgi, pic, tif, als, gif, rla, jpg
Docs:
*[[M3dView|http://download.autodesk.com/us/maya/2011help/API/class_m3d_view.html]]
*[[MImage|http://download.autodesk.com/us/maya/2011help/API/class_m_image.html]]
API to the rescue.  Amazingly easy.

Example module that will execute a function ({{{elapsedTimeFunc()}}}) based on a set amount of time in seconds in Maya.  Modify the contents of {{{elapsedTimeFunc()}}} (but not it's parameter signature) however you'd like.  The argument to {{{clientData}}} can be anything you want:  It could even be another function that is executed inside of {{{elapsedTimeFunc()}}}.
{{{
# timeCallback.py
import maya.OpenMaya as om

callbackId = None

def elapsedTimeFunc(elapsedTime, lastTime, clientData):
print "\nElaspsed time:", elapsedTime
print "Last Time:", lastTime
print "Client Data:", clientData

def makeTimeCallback(seconds, clientData):
global callbackId
callbackId = om.MTimerMessage.addTimerCallback(seconds, elapsedTimeFunc, clientData)

def removeTimerCallback():
global callbackId
if not callbackId:
return
om.MMessage.removeCallback(callbackId)
callbackId.disown()
callbackId = None
}}}
To execute it in another module:
{{{
import timeCallback
timeCallback.makeTimeCallback(5, "some data")
}}}
Then, every five seconds, it will print:
{{{
Elaspsed time: 0.00076920655556
Last Time: 4.1576094601e+21
Client Data: some data

Elaspsed time: 5.00000333786
Last Time: 0.00532985245809
Client Data: some data

Elaspsed time: 5.00000476837
Last Time: 0.00644026743248
Client Data: some data

etc...
}}}
Finally, to remove the callback cleanly:
{{{
import timeCallback
timeCallback.removeTimerCallback()
}}}
You could very easily make a auto-save tool based on a certain time interval.  Or do some really annoying stuff to your coworkers ;)
Example:  Create a physical Maya {{{skinCluster}}} node (returned as {{{MObject}}} in script), find it's {{{maxInfluence}}} attribute as an {{{MPlug}}}, and then set the plug value
{{{
import maya.OpenMaya as om
import maya.OpenMayaAnim as oma

influenceCount = 4
skinClusterFn = oma.MFnSkinCluster() # MFnSkinCluster
skinCluster = skinClusterFn.create("skinCluster") # MObject
plug = om.MFnDependencyNode(skinCluster).findPlug('maxInfluences') # MPlug
plug.setInt(influenceCount)
}}}
Docs:
*[[MFnDependencyNode|http://download.autodesk.com/us/maya/2011help/API/class_m_fn_dependency_node.html]]
*[[MPlug|http://download.autodesk.com/us/maya/2011help/API/class_m_plug.html]]
----
Also see:
*[[API : Querying Array Attributes]]
Based on the current selection, print a list of which function sets are available to those ~MObjects.

In this example, I set all variable names to be the type of object they are, to make it easier to understand how objects are returned and used. I don't recommend doing this in regular code, just using it as an explanation tool
{{{
# Python code
import maya.OpenMaya as om

# Make a MSelectionList container object:
MSelectionList = om.MSelectionList()
# Fill with selection, as MObjects
om.MGlobal.getActiveSelectionList(MSelectionList)
# Create an iterator to loop over our selection:
MItSelectionList = om.MItSelectionList(MSelectionList)

# Start looping over each node:
while not MItSelectionList.isDone():
# get the name of our node from the MItSelectionList object:
MDagPath = om.MDagPath()
MItSelectionList.getDagPath(MDagPath)
name = MDagPath.fullPathName()

# Define the current MObject being worked on:
MObject = om.MObject()
MItSelectionList.getDependNode(MObject)
# get Function Sets:
funcSets = []
om.MGlobal.getFunctionSetList(MObject, funcSets)

# Print results:
print "--Name:", name
print "\tfuncSets:", funcSets

# Advance to the next node in our iterator:
MItSelectionList.next()
}}}
Prints:
{{{
--Name: |side|sideShape
funcSets: [u'kBase', u'kNamedObject', u'kDependencyNode', u'kDagNode', u'kShape', u'kCamera']
--Name: |pSphere1|pSphereShape1
funcSets: [u'kBase', u'kNamedObject', u'kDependencyNode', u'kDagNode', u'kShape', u'kGeometric', u'kSurface', u'kMesh']
}}}

When you interactively execute //mel// code in the Script Editor, you'll see a result line print what you've done.  For example, if you execute this //mel// code in the Script Editor:
{{{
float $aa = 23; }}} You'll see it print this above: {{{ float$aa = 23;
// Result: 23 //
}}}
And if you execute this //Python// code in the script editor:
{{{
aa = 23
}}}
All you'll see above is the same line repeated, no {{{// Result:}}}.
This same issue is present when evaluating mel code via Python via {{{maya.mel.eval}}}, you //still// won't see the {{{// Result:}}} print line.

But what if you //really// wanted to?

While doing some random API code browsing I found a way to do it. And after looking at it some more, I realized it could be done a lot more simplistically, so now there are two versions below, 'new' and 'old'.  New just prints the results.  The old method tries to return the results as well.
!!!New Solution
{{{
import maya.OpenMaya as om

melCmd = 'string $stuffx = "asdf"' display, undo = True, True om.MGlobal.executeCommand(melCmd, display, undo) }}} When executed prints in the Script Editor: {{{ // Result: asdf // }}} ---- If you wanted to go one step further and capture the return in the process: {{{ import maya.OpenMaya as om cmdResult = om.MCommandResult() theResult = [] melCmd = 'string$b[] = polySphere;'
display, undo = True, True
om.MGlobal.executeCommand(melCmd, cmdResult, display, undo)
cmdResult.getResult(theResult)
print theResult
}}}
{{{
// Result: pSphere1 polySphere1 //
[u'pSphere1', u'polySphere1']
}}}
*[[OpenMaya.MGlobal|http://download.autodesk.com/us/maya/2010help/API/class_m_global.html]]
*[[OpenMaya.MCommandResult|http://download.autodesk.com/us/maya/2010help/API/class_m_command_result.html]]
!!!Old Solution
It's a bit lacking in some areas:  Won't print\return results from string, string arrays, matrix, and matrix arrays, but otherwise it works.  It will evaluate the passed in mel command, and then provide the standard {{{// Result:}}} line when complete, plus return (where available) the result.
{{{
import maya.OpenMaya as om

def executePrintMelResult(melCmd):
result = om.MCommandResult()
om.MGlobal.executeCommand(melCmd, result)
rType = result.resultType()

val = None

if rType == 1:
# kInt
util = om.MScriptUtil()
util.createFromInt(0)
pointer = util.asIntPtr()
result.getResult(pointer)
val = util.getInt(pointer)
print "// Result: %s //"%val

if rType == 2:
# kIntArray
intArray = om.MIntArray()
result.getResult(intArray)
val = []
for i in range(intArray.length()):
val.append(intArray[i])
print "// Result: %s //"%val

if rType == 3:
# kDouble
util = om.MScriptUtil()
util.createFromDouble(0.0)
pointer = util.asDoublePtr()
result.getResult(pointer)
val = util.getDouble(pointer)
print "// Result: %s //"%val

if rType == 4:
# kDoubleArray
doubleArray = om.MDoubleArray()
result.getResult(doubleArray)
val = []
for i in range(doubleArray.length()):
val.append(doubleArray[i])
print "// Result: %s //"%val

if rType == 5 or rType == 6:
# kString, kStringArray
# Not supported in Python :(
pass

if rType == 7:
# kVector
vector = om.MVector()
result.getResult(vector)
val = vector
print "// Result: <<%s %s %s>> //"%(val.x, val.y, val.z)

if rType == 8:
# kVectorArray
vectorA = om.MVectorArray()
result.getResult(vectorA)
val = vectorA
# Maya only prints the first item in the array:
print "// Result: <<%s %s %s>> //"%(val[0].x, val[0].y, val[0].z)

if rType == 9 or rType == 10:
# kMatrix or kMatrixArray
# Result gathring not supported by MCommandResult()
pass

return val
}}}
If you executed this:
{{{
melCmd = 'float $myVal = 5.5' result = executePrintMelResult(melCmd) }}} In the Script Editor you'll see it print: {{{ // Result: 5.5 // }}} YES! :-P Inside the {{{compute()}}} method of a {{{MPxNode}}} in a scripted plugin, I wanted a way to track down the {{{MObject}}} for the node at the other end of an incoming connection. Maybe there is a better way to do this, but the solution I came up with below. The code says : If the output attr needs to be computed, then track down the node feeding some (unrelated, in this case) input attr. {{{ import maya.OpenMaya as om import maya.OpenMayaMPx as ompx class MyNode(ompx.MPxNode): someOutAttr = om.MObject() someInAttr = om.MObject() def compute(self, plug, data): if plug == MyNode.someOutAttr: # Get an function set for this plugin node: thisNodeFn = om.MFnDependencyNode(self.thisMObject()) # Get an MPlug for the input attr: thisPlug = thisNodeFn.findPlug(MyNode.someInAttr) # Fill an array with MPlug inputs to this attr: plugArray = om.MPlugArray() thisPlug.connectedTo(plugArray, True, False) # Get the node (as a MObject) connected to the MPlug for the input object: inputNode = plugArray[0].node() # And print its name, for confirmation: mFnDependNode = om.MFnDependencyNode(inputNode) nodeName = mFnDependNode.name() print nodeName # The rest of the plugin code.... }}} ---- Also see: *[[API: Querying input and output attrs on nodes and deformers]] The API makes use of a [[MComputation|http://download.autodesk.com/us/maya/2010help/API/class_m_computation.html]] class that allows for the detection of user input (the {{{Esc}}} key), and will cancel it's operation when detected. Here's a really simple example of it in use: {{{ import maya.OpenMaya as om def someOperation(i): print i def doCompute(someFunc, loopRange): """ Parameters: someFunc : A callable function object, taking a single arg for the current loop number. loopRange : int : How many loops to perform. """ computation = om.MComputation() computation.beginComputation() for i in range(loopRange): someFunc(i) if computation.isInterruptRequested(): print "Operation cancled by user." break computation.endComputation() doCompute(someOperation, 10000) }}} After execution, if Maya is given focus and the user presses the {{{Esc}}} key, the computation will quit. This is similar to the behavior of the [[progressWindow|http://download.autodesk.com/us/maya/2010help/CommandsPython/progressWindow.html]] //command//, but without the gui, and executed via the API. If you're doing any work via the API, you need to know about these two objects. This is my own personal description: >{{{MObject}}} is a Lego-brick. {{{MDagPath}}} tells you about where that brick lives in the model and what bricks effect it. Online Docs: *[[MObject|http://download.autodesk.com/us/maya/2011help/API/class_m_object.html]] *[[MDagPath|http://download.autodesk.com/us/maya/2011help/API/class_m_dag_path.html]] !!!Difference between {{{MObject}}}s and {{{MDagPath}}}s: ''My personal notes:'' (when I say 'object', I'm referring to a Python class-based instance. When I say 'node', I'm referring to an actual node in Maya). *A {{{MObject}}} is an object that describes a specific instance of a node\attribute in Maya. In non-API related mel scripting, you define a node by it's //string name// in a variable. If the name of the node changes, your code will no longer be able to work on it since the variable name is old. If on the other hand you were working with the {{{MObject}}} for a node directly, the name is but one of many things that describe it: Change the name, and you code will still continue to work on the same node because it's looking directly at the object that describes the node, not just its name. *A {{{MDagPath}}} is an object that describes the path to where in the DAG hierarchy a {{{MObject}}} lives, presuming the {{{MObject}}} is a DAG node. An {{{MDagPath}}} is //not// 'the DAG //node//': It represents the path to the DAG //object//. Picture a bunch of balloons tied together in a huge bunch, with some balloons tied to other balloons in chains, while other balloons have no ropes and are floating around independent from the bunch: A {{{MObject}}} is any balloon (a DG node), and the balloons tied up represent DAG nodes (a subset of the DG). {{{MDagPath}}}s represent the ropes (hierarchy path) connecting a balloon all the way back to the base of the bunch. The non-connected balloons (A non-DAG node, like a {{{set}}} or material, for example) has no rope, so it couldn't have a {{{MDagPath}}} associated with it, since it isn't part of the DAG hierarchy. Another way to think about it: In Windows Explorer (Mac Finder, etc), all files have a path to them, showing where they live in the directory hierarchy. A {{{MObject}}} represents the file, and the {{{MDagPath}}} the path to the file. Basically, every node in Maya can be expressed as a {{{MObject}}}, but only those nodes in the DAG (nodes that can be parented) can have a {{{MDagPath}}} associated with them. ---- (From the {{{MFnDagNode}}} class [[reference|http://download.autodesk.com/us/maya/2011help/API/class_m_fn_dag_node.html]]) There are two ways to specify a DAG node in Maya. #The first is to use an {{{MObject}}} handle, which acts as a pointer to a specific node in the DAG. Given only an {{{MObject}}}, ''it is not possible to do world space operations on a DAG node because there may be more than one path through the DAG to any given node (due to instancing)''. In other words, it is not possible to identify a particular //instance// only given an {{{MObject}}}. #In many cases it is preferable to use a DAG path ({{{MDagPath}}}) to specify a //DAG// node (rather than a //DG// node. Remember, DAG nodes have parent\child hierarchies, DG nodes don't). ''A DAG path always refers to a specific instance of an object''. This makes it possible to perform unambiguous world space transformations. So a {{{MDagPath}}} can find the {{{MObject}}} associated with it, but not easily vice-versa, since if an {{{MObject}}} has been instanced, it can have multiple {{{MDagPath}}}s. ---- ''{{{MObject}}} description (from its docs):'' <<< ~MObject is the generic class for accessing all Maya internal modelling, animation and rendering Objects, collectively referred to as Model Objects, through the API. This includes ''all Dependency Graph (DG) Nodes, of which Directed Acyclic Graph (DAG) Nodes'' are a subset. Each instance of an ~MObject represents a specific ''Node'' or ''Attribute on a Node'' in the DG. Under the C++ class scheme ~MObjects simply have type ~MObject with no base or derived hierarchy. However, ~MObjects may be many different types of Model objects, from Attributes to transforms, including components of geometry such as Control Vertices (CV), faces, edges and vertices. This allows many different types of objects to be moved accessed through the API without undue concern on the part of plug-in developers for the type of object being manipulated. <<< ---- ''{{{MDagPath}}} description (from its docs):'' <<< A DAG path is a path from the world node to a particular object in the DAG. <<< ---- *{{{MObject}}} objects can be assigned to the [[MFnDependencyNode|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_dependency_node.html]] function set. **You can use {{{OpenMaya.MGlobal.getFunctionSetList(MObject)}}} to get a list (of strings) representing which function sets can be used on an {{{MObject}}}. *{{{MDagPath}}} objects can be assigned to the [[MFnDagNode|http://download.autodesk.com/us/maya/2011help/API/class_m_fn_dag_node.html]] function set (which inherits from the {{{MFnDependencyNode}}}). ---- !Get {{{MObject}}} & {{{MDagPath}}} by string name: There are a variety of ways to get {{{MObject}}}s and {{{MDagPath}}}s via the return of API calls. But if you need to generate one based on a given object name in Maya, here's how you can go about doing it: {{{ # Python code import maya.OpenMaya as om # Define our node by name. # Make sure to pass in the full path to avoid any name-clashing: node = 'group1|pCube1' # Create a selection list (they hold MObjects): selList = om.MSelectionList() # Add our node by-name to the sel list. If there is a name-clash, # this will raise a RuntimeError: selList.add(node) }}} Now that we have a populated {{{MSelectionList}}} you can extract data from it. Here we get an {{{MDagPath}}}: {{{ # Create an empty MDagPath object: mDagPath = om.MDagPath() # Extract the first item from our MSelectionList as an MDagPath: selList.getDagPath(0, mDagPath) }}} Here we get an {{{MObject}}}: {{{ # Create an empty MObject object: mObject = om.MObject() # Extract the first item from our MSelectionList as an MObject: selList.getDependNode(0, mObject) }}} !Get {{{MObject}}} from {{{MDagPath}}}: {{{ mObject = mDagPath.node() }}} !Get {{{MDagPath}}} from {{{MObject}}}: Let's go the other way now. A {{{MDagPath}}} can easily find it's {{{MObject}}} (shown above). But to go the other direction requires a bit more work. Continuing from the example above... {{{ dPath = None if om.MObject.hasFn(mObject, om.MFn.kDagNode): dPath = om.MDagPath() om.MDagPath.getAPathTo(mObject, dPath) }}} What's going on? We test to see if our {{{mObject}}} has the {{{kDagNode}}} function. If it does, that means that it //is/// a DAG node, thus has a path we can query. We then make an empty {{{MDagPath}}} object, and fill it with the path to the {{{MObject}}}. It should be noted that if the {{{MObject}}} is an instance, this method will return the first path found. You can use {{{MDagPath.getAllPathsTo()}}} to find all instances. !Get a nodes string name from a {{{MObject}}} or {{{MDagPath}}}: Going the other way again, once you have a {{{MObject}}} or {{{MDagPath}}}, how can you query the string name of the Maya node they wrapper? !!!{{{MObject}}}: Here we create a {{{MFnDependencyNode}}}, and can pull the name from that: {{{ mFnDependNode = om.MFnDependencyNode(mObject) nodeName = mFnDependNode.name() }}} !!!{{{MDagPath}}}: The {{{MDagPath}}} can access the name directly: {{{ nodeName = mDagPath.fullPathName() }}} You can also extract it from a {{{MFnDagNode}}} function set: {{{ mFnDagNode = om.MFnDagNode(mDagPath) nodeName = mFnDagNode.fullPathName() }}}  A really good blog post covers their creation and usage here: http://around-the-corner.typepad.com/adn/2012/10/maya-custom-manipulators-.html All are derived from {{{OpenMayaUI}}}: *[[MFnManip3D|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_fn_manip3_d.html]] (inherits from {{{OpenMaya.MFnTransform}}}). **[[MFnCircleSweepManip|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_fn_free_point_triad_manip.html]] **[[MFnCurveSegmentManip|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_fn_curve_segment_manip.html]] **[[MFnDirectionManip|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_fn_direction_manip.html]] **[[MFnDiscManip|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_fn_disc_manip.html]] **[[MFnDistanceManip|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_fn_distance_manip.html]] **[[MFnFreePointTriadManip|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_fn_free_point_triad_manip.html]] **[[MFnPointOnCurveManip|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_fn_point_on_curve_manip.html]] **[[MFnPointOnSurfaceManip|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_fn_point_on_surface_manip.html]] **[[MFnRotateManip|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_fn_rotate_manip.html]] **[[MFnScaleManip|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_fn_scale_manip.html]] **[[MFnStateManip|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_fn_state_manip.html]] **[[MFnToggleManip|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_fn_toggle_manip.html]] Derived from {{{OpenMayaMPx}}}: *[[MPxManipulatorNode|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_px_manipulator_node.html]] (inherits from {{{OpenMayaMPx.MPxNode}}}) The {{{OpenMayaRender}}} package via the the [[MHardwareRenderer|http://download.autodesk.com/us/maya/2011help/API/class_m_hardware_renderer.html]] class provides access to a [[MGLFunctionTable|http://download.autodesk.com/us/maya/2010help/api/class_m_g_l_function_table.html]] class. It is a "utility class which provides wrappers for the basic functions in the ~OpenGL API". As of Maya 2011, it supports up to ~OpenGL 2.0. ~OpenGL is on a more current version than Maya uses. Legacy docs to 2.1 can be found [[here|http://www.opengl.org/sdk/docs/man/]] These calls can be used (among many other places) in the {{{draw()}}} method of the [[MPxLocatorNode|http://download.autodesk.com/us/maya/2010help/api/class_m_px_locator_node.html]], see [[API: Simple scripted plugin locator node]]. Example: {{{ import maya.OpenMayaRender as omr renderer = omr.MHardwareRenderer.theRenderer() # returns MHardwareRenderer glFT = renderer.glFunctionTable() # returns MGLFunctionTable for d in sorted(dir(glFT)): print d }}} This will print a lot of stuff: {{{ ... glProgramParameters4dvNV glProgramParameters4fvNV glProgramString glPushAttrib glPushClientAttrib glPushMatrix glPushName glRasterPos2d glRasterPos2dv glRasterPos2f glRasterPos2fv ... }}} Should note there are no docs for the static (class) method {{{theRenderer()}}} in the {{{MHardwareRenderer}}} docs, weird. ---- ''In addition'', the {{{OpenMayaRender}}} module itself has many ~OpenGL related constants you can access. Which, like the above docs say, are prefixed with a '{{{M}}}'. So if you were looking for the ~OpenGL constant {{{GL_LIGHTING}}}, you would find its value in {{{ OpenMayaRender.MGL_LIGHTING }}} They can be used like so (from a scripted plugin example): {{{ glFT.glPushAttrib(omr.MGL_CURRENT_BIT) }}} Examples using [[OpenMaya.MItDag|http://download.autodesk.com/us/maya/2011help/API/class_m_it_dag.html]] The {{{MItDag}}} class will iterate over all nodes in the DAG (directed, acyclic graph), which is a subset of the DG (dependency graph). DAG nodes have a transform|shape relationship. The below example runs most of the methods on the class, exposing the values to be printed. {{{ import maya.OpenMaya as om def example_MItDag(): # This iterator can be filtered by node type as well, via MFn.k* types dagIterator = om.MItDag() # MItDag print "MItDag iteration info:" while not dagIterator.isDone(): #---------------------------------------------------- # Querying info specifically on the MItDag node: currentItem = dagIterator.currentItem() # MObject root = dagIterator.root() # MObject depth = dagIterator.depth() # int path = om.MDagPath() # MDagPath dagIterator.getPath(path) pathArray = om.MDagPathArray() # MDagPathArray dagIterator.getAllPaths(pathArray) fullPathName = dagIterator.fullPathName() # string partialPathName = dagIterator.partialPathName() # string isInstanced = dagIterator.isInstanced() # bool instances = 0 instanceCount = dagIterator.instanceCount(instances) # unsigned int willTransverseUnderWorld = dagIterator.willTraverseUnderWorld() # bool # Let's get the function sets for this item as well, which basically tell # us what this thing is: funcSets = [] om.MGlobal.getFunctionSetList(currentItem, funcSets) #---------------------------------------------------- # Print info: currentItemFunc = om.MFnDependencyNode(currentItem) rootFunc = om.MFnDependencyNode(root) pathFunc = om.MFnDagNode(path) print "\t", currentItemFunc.name(), " : Current Item (MFnDependencyNode.name())" print "\t\tRoot (MFnDependencyNode.name()):", rootFunc.name() print "\t\tDepth (int):", depth print "\t\tPath (MFnDagNode.fullPathName()):", pathFunc.fullPathName() print "\t\tPath Array Items (MDagPath.fullPathName()):" for i in range(pathArray.length()): arrayItem = pathArray[i] # MDagPath arrayItemFunc = om.MFnDagNode(arrayItem) print "\t\t\t", arrayItemFunc.fullPathName() print "\t\tFull Path Name (string):", fullPathName print "\t\tPartial Path Name (string):", partialPathName print "\t\tIs Instanced? (bool):", isInstanced print "\t\tInstances: (int):", instances print "\t\tWill Transverse Underworld? (bool):", willTransverseUnderWorld print "\t\t'Current Item' function sets (MGlobal.getFunctionSetList()):" for fset in funcSets: print "\t\t\t", fset dagIterator.next() }}} Running it prints: {{{ example_MItDag() MItDag iteration info: world : Current Item (MFnDependencyNode.name()) Root (MFnDependencyNode.name()): world Depth (int): 0 Path (MFnDagNode.fullPathName()): Path Array Items (MFnDagNode.fullPathName()): Full Path Name (string): Partial Path Name (string): Is Instanced? (bool): False Instances: (int): 0 Will Transverse Underworld? (bool): False Function Sets (MGlobal.getFunctionSetList()): kBase kNamedObject kDependencyNode kDagNode kWorld groundPlane_transform : Current Item (MFnDependencyNode.name()) Root (MFnDependencyNode.name()): world Depth (int): 1 Path (MFnDagNode.fullPathName()): |groundPlane_transform Path Array Items (MFnDagNode.fullPathName()): |groundPlane_transform Full Path Name (string): |groundPlane_transform Partial Path Name (string): groundPlane_transform Is Instanced? (bool): False Instances: (int): 0 Will Transverse Underworld? (bool): False Function Sets (MGlobal.getFunctionSetList()): kBase kNamedObject kDependencyNode kDagNode kTransform etc... }}}  Examples using [[OpenMaya.MItDependencyGraph|http://download.autodesk.com/us/maya/2010help/API/class_m_it_dependency_graph.html]] The {{{MItDependencyGraph}}} is used for transversing connections to a node. The below example will print every node connected to the incoming side of the given 'nodeName': {{{ import maya.OpenMaya as om def example_MItDependencyGraph(): # Convert a node name to a MObject, to pass to our MItDependencyGraph class: nodeName = 'myAwesomeNode' selList = om.MSelectionList() selList.add(nodeName) node = om.MObject() selList.getDependNode(0, node) # Iterate through all incoming connections to our node: dependGraphIter = om.MItDependencyGraph(node, om.MItDependencyGraph.kUpstream, om.MItDependencyGraph.kPlugLevel) print "%s: All Incoming Connected Nodes"%nodeName while not dependGraphIter.isDone(): currentItem = dependGraphIter.currentItem() # MObject currentItemFunc = om.MFnDependencyNode(currentItem) name = currentItemFunc.name() print "\t", name dependGraphIter.next() }}} Examples using [[OpenMaya.MItDependencyNodes|http://download.autodesk.com/us/maya/2010help/API/class_m_it_dependency_nodes.html]] The {{{MItDependencyNodes}}} class will iterate over all nodes in the DG (dependency graph), basically all nodes in the scene. The below example runs most of the methods on the class, exposing the values to be printed. {{{ import maya.OpenMaya as om def example_MItDependencyNodes(): # This list can be filtered by type as well, via MFn.k* types # Let's only look for 'partition' nodes: iterFilter = om.MFn.kPartition dependIterator = om.MItDependencyNodes(iterFilter) # MItDependencyNodes print "MItDependencyNodes iteration info:\n" while not dependIterator.isDone(): #---------------------------------------------------- # Querying info specifically on the MItDag node: # Really, this is all it has to query: thisNode = dependIterator.thisNode() # MObject # Let's get the function sets for this item as well, which basically tell # us what this thing is: funcSets = [] om.MGlobal.getFunctionSetList(thisNode, funcSets) #---------------------------------------------------- # Print info: thisNodeFunc = om.MFnDependencyNode(thisNode) print "\t", thisNodeFunc.name(), " : This Node (MObject.name())" print "\t\t'This Node' function sets (MGlobal.getFunctionSetList()):" for fset in funcSets: print "\t\t\t", fset dependIterator.next() }}} Running it prints: {{{ example_MItDependencyNodes() MItDependencyNodes iteration info: renderPartition : This Node (MObject.name()) 'This Node' function sets (MGlobal.getFunctionSetList()): kBase kNamedObject kDependencyNode kPartition characterPartition : This Node (MObject.name()) 'This Node' function sets (MGlobal.getFunctionSetList()): kBase kNamedObject kDependencyNode kPartition }}} Short version: As of Maya 2010, this is not doable. The {{{MSyntax}}} class doesn't support the passing in of array items, and the {{{makeFlagMultiUse}}} method requires you to pass in your args like: {{{ // mel myCmd -arg "a" -arg "b" -arg "c"; }}} rather than an actual array: {{{ // mel myCmd -arg {"a","b","c"}; }}} This is further compounded that (as of this authoring) it seems like Python has problems querying multi-use flags. You can't pass the same parameter name over and over in a Python function: {{{ # Invalid Python syntax: myCmd(arg="a", arg="b", arg="c") }}} So you have to pass in multi-flag data as a //list// (array): {{{ # Python myCmd(arg=["a","b","c"]) }}} But it doesn't seem to work in my own scripted plugins, and other blog posts confirm this :( However, standard Maya commands //do work// this way via Python, but I'm guessing it's because they're authored via c++, rather than Python. Even crazier is that if I execute my scripted plugin command via Python and it fails when querying the mult-use arguments, calling to it from mel (per the top example) //does// work. Buuuuugy. *[[MSyntax|http://download.autodesk.com/us/maya/2010help/API/class_m_syntax.html]] docs *[[Forum Posts|http://groups.google.com/group/python_inside_maya/search?group=python_inside_maya&q=MSyntax+array&qt_g=Search+this+group]] Another thread here discusses it pretty well: http://forums.cgsociety.org/archive/index.php/t-701733.html It appears that the main hack is to pass in a single string you can then later split into the array items of your choice, which is //terrible//... From that form post: ''"MEL commands //don't// have the ability to accept a string array as a single flag argument."'', which seems to be true based on experimentation. ---- !However The giant however: You can pass a list of object names (or a single name) as strings into a command, as the first argument. As it turns out, these names are arbitrary: They don't necessarily have to match any objects in the scene. Code snippets to set this up: {{{ # Inside your scripted plugin class... def doIt(self, argList): argData = om.MArgDatabase(self.syntax(), argList) strings = [] argData.getObjects(strings) if len(strings): print '\tPassed-in string arguments: "%s"'%'", "'.join(strings) # ..... @staticmethod def newSyntax(): syntax = om.MSyntax() syntax.setObjectType(om.MSyntax.kStringObjects) # ..... }}} {{{ # Then calling to the command via Python: myCmd(["stringA", "stringB"]) }}} {{{ // Via mel: myCmd "stringA" "stringB"; }}} As you can see, this allows you to pass an actual list in via Python. Trying to pass these values as a string array in mel causes an error. I have an example of this in action here: [[API: Simple scripted plugin argument passing]] When authoring custom nodes or deformers, you'll sometime want access to their built-in (default, Maya authored) attributes. For example, let's say you're making a deformer, and you want access to the {{{envelope}}} attribute inside the {{{deform()}}} method. How do you get access to that? Maya has provided a magical, semi-secret location for storing those attributes inside the {{{OpenMayaMPx.cvar}}} '{{{swigvarlink}}}' datatype. It appears to have {{{MObject}}} representations of all the standard attrs one would need to access. You extract them via the syntax "<Node Type>_<Attribute Name>". For example, if you wanted to access the '{{{.envelope}}}' attr on a given deformer, you'd access it via '{{{OpenMayaMPx.cvar.MPxDeformerNode_envelope}}}'. I've found two spots in the Maya docs that talk about them: <<< [[Example: Bounding Box Deformer|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/files/GUID-10CE99A6-2C32-49E1-85ED-2E2F6782CF23.htm]] "Built-in Deformer Node Attributes - By inheriting from {{{MPxDeformerNode}}}, your class will have access to the input and output mesh attributes, available via {{{OpenMayaMPx.cvar.MPxDeformerNode_inputGeom}}} and {{{OpenMayaMPx.cvar.MPxDeformerNode_outputGeom}}} respectively. These variables are generated by the SWIG tool during the C++ header file conversion to Python. By the same process, your deformer also has access to the built-in "envelope" attribute, available via {{{OpenMayaMPx.cvar.MPxDeformerNode_envelope}}}. This envelope attribute is used to specify the amount of influence your deformer has on the mesh." <<< <<< [[Using the Maya Python API|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/files/Maya_Python_API_Using_the_Maya_Python_API.htm]] ''Accessing static {{{MObjects}}} of an {{{MPx}}} class'' The proxy classes provide some standard information to a developer about the node that is being used. This includes attribute objects that are used to define the node. To access a static class {{{MObject}}} in the Maya Python API, similar code can be used: {{{ envelope = OpenMayaMPx.cvar.MPxDeformerNode_envelope }}} After making this call, the envelope will be an {{{MObject}}} for {{{MPxDeformerNode::envelope}}}. <<< If you wanted to print a list, you'd have to jump through some hoops since the {{{swigvarlink}}} object doesn't support slicing or index access... but you //can// print it (looks like a {{{tuple}}}): {{{ import maya.OpenMayaMPx as ompx items = [item.strip() for item in str(ompx.cvar)[1:-1].split(',')] for item in sorted(items): print item }}} {{{ MPxCameraSet_active MPxCameraSet_camera MPxCameraSet_cameraLayer MPxCameraSet_order ... }}} With a bit more work on the above code, you can get a list of the supported node types: {{{ MPxCameraSet MPxConstraint MPxDeformerNode MPxEmitterNode MPxFieldNode MPxFluidEmitterNode MPxHardwareShader MPxHwShaderNode MPxImagePlane MPxLocatorNode MPxManipulatorNode MPxNode MPxObjectSet MPxParticleAttributeMapperNode MPxSpringNode MPxSurfaceShape MPxTransform MPxTransformationMatrix }}} So given all that, here are some use cases: {{{ import maya.OpenMayaMPx as ompx }}} ---- Inside the {{{deform()}}} method of a {{{OpenMayaMPx.MPxDeformerNode}}}, you need to query the value of the (standard, built-in) {{{envelope}}} attribute: {{{ envelope_attr = ompx.cvar.MPxDeformerNode_envelope envelopeHandle = dataBlock.inputValue(envelope_attr) # MDataHandle envelopeValue = envelopeHandle.asFloat() }}} ---- In the {{{nodeInitializer()}}} function of a {{{OpenMayaMPx.MPxDeformerNode}}}, you need to setup an {{{attributeAffects}}} relationship between a custom '{{{deform}}}' attribute, and the (standard, built-in) {{{outputGeometry}}} attr on the node: {{{ outputGeom = ompx.cvar.MPxDeformerNode_outputGeom MyDeformer.attributeAffects(MyDeformer.attr_deform, outputGeom) }}} ---- Inside the {{{compute()}}} method of a {{{OpenMayaMPx.MPxNode}}}, you want to query the (standard, built-in) {{{caching}}} attr of the node: {{{ caching_attr = ompx.cvar.MPxNode_caching cachingHandle = dataBlock.inputValue(caching_attr) cachingValue = envelopeHandle.asBool() }}} ---- ---- Also see: *[[API: How can a custom node query a connected object in the compute method?]] This is an expansion on my [[API: Simple scripted plugin command]] example. It shows various ways to capture flag argument data as passed into a scripted-plugin based command. It also exposes an obnoxious Python bug... The below example scripted plugin will create a command called {{{argExample}}}. The command doesn't do anything other than print the arguments passed to the various flags on the command. Furthermore, you can pass object names to it as the first positional argument, and if it finds none, will instead try to operate on what you have selected. {{{ # spArgExampleCmd.py import maya.OpenMaya as om import maya.OpenMayaMPx as ompx # ----------------------------------- # Plugin code class ArgExample(ompx.MPxCommand): """ http://download.autodesk.com/us/maya/2010help/API/class_m_px_command.html """ # Name this command will use when executed via mel\Python: commandName = "argExample" # Setup our flags: flag_floatValue = '-fv'; flag_floatValueLong = '-floatValue' flag_stringValue = '-sv'; flag_stringValueLong = '-stringValue' flag_multiFloat = '-mf'; flag_multiFloatLong = '-multiFloat' flag_justFlag = '-jf'; flag_justFlagLong = '-justFlag' def __init__(self): """ Initalize our superclass: """ ompx.MPxCommand.__init__(self) def doIt(self, argList): """ Superclass override. Parameters : argList : MArgList : http://download.autodesk.com/us/maya/2010help/API/class_m_arg_list.html """ # Query what args, if any, were passed in via the MArgList. MArgDatabase # inherits from MArgParser: # http://download.autodesk.com/us/maya/2010help/API/class_m_arg_parser.html # http://download.autodesk.com/us/maya/2010help/API/class_m_arg_database.html print "%s executed:" % self.commandName argData = om.MArgDatabase(self.syntax(), argList) # See what objects, if any, were passed into the command. It should be # noted that these are actually just arbitrary string names: They don't # necessarily need to match an existing node-name in the Maya scene. objects = [] argData.getObjects(objects) if len(objects): print '\tPassed-in object arguments: "%s"'%'", "'.join(objects) # If no objects were passed in, see if any are selected: else: # If nothing was passed in, see if anything is selected: selList = om.MSelectionList() om.MGlobal.getActiveSelectionList(selList) if selList.length(): print "\t%s objects are selected to work on." % selList.length() # Query the flag argument values: if argData.isFlagSet(ArgExample.flag_floatValue): index = 0 # flags can have multiple multiple arg indices, this only has one floatValue = argData.flagArgumentDouble(ArgExample.flag_floatValue, index) print "\t-floatValue", floatValue if argData.isFlagSet(ArgExample.flag_stringValue): index = 0 floatValue = argData.flagArgumentString(ArgExample.flag_stringValue, index) print "\t-stringValue", floatValue if argData.isFlagSet(ArgExample.flag_multiFloat): multiFloatVals = [] flagUses = argData.numberOfFlagUses(ArgExample.flag_multiFloat) print "\t-multiFloat : Used %s time(s)" % flagUses for i in range(flagUses): # Create a list to grab a single item from another list. Strange but true. flagArgList = om.MArgList() argData.getFlagArgumentList(ArgExample.flag_multiFloat, i, flagArgList) if flagArgList.length(): multiFloatVals.append(flagArgList.asDouble(0)) if multiFloatVals: for val in multiFloatVals: print "\t\t", val else: print "\t\tSorry, it's a known bug you can't query mult-arg values via Python :-(" print "\t\tTry executing this came code via mel, it will work :-S" if argData.isFlagSet(ArgExample.flag_justFlag): print "\t-justFlag : Is set!" #--------------------------------------------------- # Command & syntax creation: # 'Creator Function' needs to return a pointer new instance of this type of class, # based on how the c++ code works. # As you can see, the OpenMayaMPx module has it's own functions (for which # I can find no online documentation). @classmethod def cmdCreator(cls): return ompx.asMPxPtr(cls()) @staticmethod def newSyntax(): """ Returns an MSyntax that can be passed to the MFnPlugin inside the initializePlugin funcition. This syntax is based around the custom flags that the command can accept. Important: Maya's notes state that this function must have a name other than 'syntax()'. """ # http://download.autodesk.com/us/maya/2010help/API/class_m_syntax.html syntax = om.MSyntax() # Tell the syntax to grab any object-names passed in to be accepted as # strings (either a single string, or as a list of strings) rather than # MObjects. This is always the first (but optional) argument of the # command. If needed, you could specify a minimum number of object names # to be passed in as well. syntax.setObjectType(om.MSyntax.kStringObjects) # There isn't a constant for float, so we use double: syntax.addFlag(ArgExample.flag_floatValue, ArgExample.flag_floatValueLong, om.MSyntax.kDouble) # Our string flag: syntax.addFlag(ArgExample.flag_stringValue, ArgExample.flag_stringValueLong, om.MSyntax.kString) # Multi-use float flag: syntax.addFlag(ArgExample.flag_multiFloat, ArgExample.flag_multiFloatLong, om.MSyntax.kDouble) syntax.makeFlagMultiUse(ArgExample.flag_multiFloat) # Just a flag, takes no arguments: syntax.addFlag(ArgExample.flag_justFlag, ArgExample.flag_justFlagLong) return syntax # ----------------------------------- # Plugin registration\degregistration block # initializePlugin & uninitializePlugin are *required functions* def initializePlugin(mobject): # create a MFnPlugin mfnPlugin = ompx.MFnPlugin(mobject, "Eric Pavey", "1.0") try: # Try to register our plug by passing in the kPluginCmdName, and the command creator: # we use the '.registerCommand()' method since we're trying to build a # command. Other plugin types use different registration functions. The # args do differ, check docs. mfnPlugin.registerCommand(ArgExample.commandName, ArgExample.cmdCreator, ArgExample.newSyntax) except(Exception): om.MGlobal.displayError("\nArgExample registration failed\n") def uninitializePlugin(mobject): # create a MFnPlugin mfnPlugin = ompx.MFnPlugin(mobject) try: # Try to deregister our plug by passing in the kPluginCmdName, and the command creator: mfnPlugin.deregisterCommand(ArgExample.commandName) except(Exception): om.MGlobal.displayError("\nArgExample deregistration failed\n") }}} After this is loaded in the plugin manager (see [[How can I load \ unload a Python scripted plugin?]]), you should be able to run the command. But you'll get different results if you execute it in mel, or Python: {{{ # Python code import maya.cmds as mc mc.argExample(["spam", "eggs"], floatValue=23, stringValue="chocolate", multiFloat=[6,2,3], justFlag=True) }}} {{{ argExample executed: Passed-in object arguments: "spam", "eggs" -floatValue 23.0 -stringValue chocolate -multiFloat : Used 3 time(s) Sorry, it's a known bug you can't query mult-arg values via Python :-( Try executing this came code via mel, it will work :-S -justFlag : Is set! }}} As you can see, Python can't seem to handle the mult-use flag :( But executing this in mel... {{{ // mel code argExample -floatValue 23 -stringValue "chocolate" -multiFloat 6 -multiFloat 2 -multiFloat 3 -justFlag "spam" "eggs"; }}} {{{ argExample executed: Passed-in object arguments: "spam", "eggs" -floatValue 23.0 -stringValue chocolate -multiFloat : Used 3 time(s) 6.0 2.0 3.0 -justFlag : Is set! }}} Lo and behold, the multi-use args show up! Buggy, buggy, buggy :( Example of authoring a simple scripted plugin //command//. It features value setting, querying, and undoing. This scripted plugin is authored slightly different from other 'simple scripted plugin' examples I've done: *The command name is a class attribute rather than a module constant. *The command creator and new syntax functions have been made class staticmethods, rather than being external functions. It behaves the exact same as other solutions, just a different way of doing it. Why would you want to do it this way, compared to the other alternatives I've presented? The main reason I've found is if you're authoring multiple scripted plugins //in the same module//: To help organize this special data, lumping it in with the class makes it easier to find and distinguish against the others. Here is another [[good, even more simple example|http://download.autodesk.com/us/maya/2011help/API/hello_world_cmd_8py-example.html]] from the Maya API docs. When it comes to creating a scripted plugin //command//, these are the major things required: * A class inheriting from {{{maya.OpenMayaMPx.MPxCommand}}}. **The name of this class is up to you, it is independent from the name of the node being created. The node name is actually defined in {{{initializePlugin()}}} **Must initialize the superclass in {{{__init__()}}} **Override the {{{doIt()}}} method to parse any given arguments, and setup states for undo\redo. **Override the {{{redoIt()}}} method that does the actual work of the command. **Override the {{{undo()}}} method to support undoing, which should reset the state before the command was executed. **Override the {{{isUndoable()}}} method to tell the command it actually //can// undo. *Author 'node creator' and 'new syntax' functions. The names are arbitrary, but {{{cmdCreator()}}} and {{{newSyntax()}}} are good ideas. These are both used by the {{{initializePlugin()}}} function. The syntax function creates a {{{MSyntax}}} object that parses all the incoming flags to the command. * Author {{{initializePlugin()}}} and {{{uninitializePlugin()}}} functions. Other than the overridden methods above, these are the only items in the code that need specific names. It should be noted that if you don't care about flags, or undoing, the only method you need to override is {{{doit()}}}, and you can skip making the syntax function. {{{ # spHelloWorldCmd.py import maya.OpenMaya as om import maya.OpenMayaMPx as ompx # ----------------------------------- # Plugin code class HelloWorldCommand(ompx.MPxCommand): """ This class will create a command that when executed, will print "Hello World" with a number next to it showing how many times the command has been executed. If you edit the command, you can pass in a new value, and if you query the command it will return the current value. http://download.autodesk.com/us/maya/2010help/API/class_m_px_command.html """ # Name this command will use when executed via mel\Python: commandName = "helloWorld" # This will store a value we can query, set, or print. value = 0 # Setup our flags: flag_value = '-v'; flag_valueLong = '-value' flag_help = "-h"; flag_helpLong = "-help" # Text displayed when the user queries its help: helpText = """ The helloWorld command does these things: * Running the command will print 'Hello World #' with the number of times it has been executed. * You can pass in a -value to set the current number. * If you -query it, it will return the current value. * Full undo/redo is supported. * And of course if you see this, you know it has -help...""" def __init__(self): """ Initalize our superclass: """ ompx.MPxCommand.__init__(self) # Is the command being queried or edited? self.isQuery = False self.isEdit = False def doIt(self, argList): """ Superclass override. This method is called from script when this command is called. It should set up any class data necessary for redo/undo, parse any given arguments, and then call redoIt. Parameters : argList : MArgList : http://download.autodesk.com/us/maya/2010help/API/class_m_arg_list.html """ # Query what args, if any, were passed in. MArgDatabase inherits from # MArgParser: # http://download.autodesk.com/us/maya/2010help/API/class_m_arg_parser.html # http://download.autodesk.com/us/maya/2010help/API/class_m_arg_database.html # The syntax being queried is the one that was passed to the MFnPlugin # inside the initializePlugin() funcition. argData = om.MArgDatabase(self.syntax(), argList) # Are we in query mode? self.isQuery = argData.isQuery() # Support undoing by storing the previous state of the command: self.prevVal = HelloWorldCommand.value # If the user is querying help, display it, and reutrn out of the command. if argData.isFlagSet(HelloWorldCommand.flag_help): self.setResult(HelloWorldCommand.helpText) return om.MStatus.kSuccess # If the user passes in a value, and we're not in query mode, set the value: if argData.isFlagSet(HelloWorldCommand.flag_value) and not self.isQuery: index = 0 # flags can have multiple multiple arg indices, this only has one HelloWorldCommand.value = argData.flagArgumentInt(HelloWorldCommand.flag_value, index) # so, we're obviously editing it... self.isEdit = True return self.redoIt() def redoIt(self): """ Superclass override: Any actual work the command should do is done in here. """ # If we're in query mode, return the value: if self.isQuery: self.setResult(HelloWorldCommand.value) # Otherwise, if the command hasn't already been edited, execute the # command code, which is in this case as simple update value and print. # It could obviously be much more robust. elif not self.isEdit: HelloWorldCommand.value += 1 print "Hello World #%s" % HelloWorldCommand.value def undoIt(self): """ Superclass override: Reset the state if undone. """ HelloWorldCommand.value = self.prevVal def isUndoable(self): """ Superclass override: Enable undoing. """ return True #--------------------------------------------------- # Command & syntax creation: # 'Creator Function' needs to return a pointer new instance of this type of class, # based on how the c++ code works. # As you can see, the OpenMayaMPx module has it's own functions (for which # I can find no online documentation). @classmethod def cmdCreator(cls): return ompx.asMPxPtr(cls()) @staticmethod def newSyntax(): """ Returns an MSyntax that can be passed to the MFnPlugin inside the initializePlugin funcition. This syntax is based around the custom flags that the command can accept. Important: Maya's notes state that this function must have a name other than 'syntax()'. """ # http://download.autodesk.com/us/maya/2010help/API/class_m_syntax.html syntax = om.MSyntax() syntax.addFlag(HelloWorldCommand.flag_value, HelloWorldCommand.flag_valueLong, om.MSyntax.kLong) syntax.addFlag(HelloWorldCommand.flag_help, HelloWorldCommand.flag_helpLong) # Allow this syntax to be both queryable, and editable: syntax.enableQuery(True) syntax.enableEdit(True) return syntax # ----------------------------------- # Plugin registration\degregistration block # initializePlugin & uninitializePlugin are *required functions* def initializePlugin(mobject): # create a MFnPlugin mfnPlugin = ompx.MFnPlugin(mobject, "Eric Pavey", "1.0") try: # Try to register our plug by passing in the kPluginCmdName, and the command creator: # we use the '.registerCommand()' method since we're trying to build a # command. Other plugin types use different registration functions. The # args do differ, check docs. mfnPlugin.registerCommand(HelloWorldCommand.commandName, HelloWorldCommand.cmdCreator, HelloWorldCommand.newSyntax) except(Exception): om.MGlobal.displayError("\nHelloWorldCommand registration failed\n") def uninitializePlugin(mobject): # create a MFnPlugin mfnPlugin = ompx.MFnPlugin(mobject) try: # Try to deregister our plug by passing in the kPluginCmdName, and the command creator: mfnPlugin.deregisterCommand(HelloWorldCommand.commandName) except(Exception): om.MGlobal.displayError("\nHelloWorldCommand deregistration failed\n") }}} After this is loaded in the plugin manager (see [[How can I load \ unload a Python scripted plugin?]]), you should be able to type in the script editor (works in mel too): {{{ import maya.cmds as mc mc.helloWorld() # Hello World #1 mc.helloWorld() # Hello World #2 }}} {{{ mc.helloWorld(value=23) v = mc.helloWorld(query=True) print v # 23 mc.helloWorld() # Hello World #24 }}} {{{ mc.helloWorld(help=True) # Result: The helloWorld command does these things: * Running the command will print 'Hello World #' with the number of times it has been executed. * You can pass in a -value to set the current number. * If you -query it, it will return the current value. * Full undo/redo is supported. * And of course if you see this, you know it has -help... # }}}  I wanted to build a bare-minimum framework for authoring a deformer node via a scripted plugin. Maya comes with a simple example [[here|http://download.autodesk.com/us/maya/2011help/API/y_twist_node_8py-example.html]], which I stripped down even more, added a bunch of notes, etc. Long after I authored this, found a good blog post on general API deformer stuff: [[Maya's Deformer Architecture|http://around-the-corner.typepad.com/adn/2012/09/maya-deformer-architecture.html]] When the deformer is applied to a node, it will randomly offset the node's points based on its {{{deform}}} attr. When it comes to creating a locator node, these are the major things required: * A class inheriting from {{{maya.OpenMayaMPx.MPxDeformerNode}}}. **It in turn inherits from {{{maya.OpenMayaMPx.MPxNode}}} **The name of this class is up to you, it is independent from the name of the node being created. The node name is actually defined in {{{initializePlugin()}}} **Must initialize the superclass in {{{__init__()}}} **Override the {{{deform()}}} method, put your point deformation code in there. *Author 'node creator' and 'node initializer' functions. The names are arbitrary, but {{{nodeCreator()}}} and {{{nodeInitializer()}}} are good ideas. These are both used by the {{{initializePlugin()}}} function. * Author {{{initializePlugin()}}} and {{{uninitializePlugin()}}} functions. Other than the overridden methods above, these are the only items in the code that need specific names. {{{ # spSimpleDeformer.py import random import maya.OpenMaya as om import maya.OpenMayaMPx as ompx #------------------ # Constants: # c++ uses 'k' to specify constants, Python usually uses all caps. # Using k here since we're dealing with Maya legacy, but ultimately it doesn't # matter. kPluginNodeType = "spSimpleDeformer" # This identifier should be provided by Autodesk, to make sure it will never # clash with any other node type. I just made this one up. # http://download.autodesk.com/us/maya/2011help/API/class_m_type_id.html kPluginNodeId = om.MTypeId(0x00113) class SimpleDeformer(ompx.MPxDeformerNode): """ Scripted deformer node creation http://download.autodesk.com/us/maya/2011help/API/class_m_px_deformer_node.html Inherits from: http://download.autodesk.com/us/maya/2011help/API/class_m_px_node.html """ # Define any input and output attrs at the class level. # These are MObject representations of the attributes on the physical # Maya node. They are just placeholder: They are replaced\populated by # nodeInitializer() # In fact, they could be None, but since ultimately they'll be MObjects, # just stick some dummy ones in there. attr_deform = om.MObject() def __init__(self): """ Make sure to initilaize the superclass. Not much else happens here. """ ompx.MPxDeformerNode.__init__(self) def deform(self, dataBlock, geomIter, matrix, multiIndex): """ Overridden method of MPxDeformerNode, where the deformation magic happens. Parameters: dataBlock : MDataBlock : The node's datablock. Provides storage for the data being received by or sent by the node. It is the data for the plugs and attributes of the node. http://download.autodesk.com/us/maya/2011help/API/class_m_data_block.html geomIter : MItGeometry : An iterator for the current geometry being deformed. http://download.autodesk.com/us/maya/2011help/API/class_m_it_geometry.html matrix : MMatrix : the geometry's world space transformation matrix. http://download.autodesk.com/us/maya/2011help/API/class_m_matrix.html multiIndex : unsigned int : The index corresponding to the requested output geometry. """ # Get the deform attribute value from the datablock: # http://download.autodesk.com/us/maya/2011help/API/class_m_data_handle.html deformHandle = dataBlock.inputValue(self.attr_deform) # MDataHandle deformValue = deformHandle.asDouble() # double # Get the Maya node's envelope attr value. The MPxDeformerNode has a # static ''envelope' attribute that can be queried to access this. # It appears that the envelope attribute on the Maya node is auto-created. # Furthermore, it seems the the OpenMayaMPx.cvar is a 'swigvarlink' # (whatever that is) that holds constants for use elsewhere in the API envelope_attr = ompx.cvar.MPxDeformerNode_envelope envelopeHandle = dataBlock.inputValue(envelope_attr) # MDataHandle envelopeValue = envelopeHandle.asFloat() # Iterate over the objects points to deform it: while geomIter.isDone() == False: # We use the index of each point as the seed to its random function # so that the noise won't change randomly as the 'deform' attr is # changed, or the node is moved through space. random.seed(geomIter.index()) # http://download.autodesk.com/us/maya/2011help/API/class_m_point.html point = geomIter.position() # MPoint # Do a simple random operation on each point: point.x = point.x + random.uniform(-deformValue, deformValue) * envelopeValue point.y = point.y + random.uniform(-deformValue, deformValue) * envelopeValue point.z = point.z + random.uniform(-deformValue, deformValue) * envelopeValue # Re-set the position of the item after it's been recalculated: geomIter.setPosition(point) geomIter.next() #--------------------------------------------------- # Node creation and initialization: # creator def nodeCreator(): return ompx.asMPxPtr(SimpleDeformer()) # initializer def nodeInitializer(): """ This function sets up all the input and output attributes on the node: What type of data they should expect, if they're inputs\outputs, keyable, connectable, default values, etc. Also defines the relationships between attrs using attributeAffects(): If an input changes, you should update the output. """ # Create the deform attribute: nAttr = om.MFnNumericAttribute() SimpleDeformer.attr_deform = nAttr.create("deform", "df", om.MFnNumericData.kDouble, 0.0) nAttr.setKeyable(True) # False by default # Add the attribute to the node: try: # MPxDeformerNode has a static 'outputGeom' attribute that needs to be # told to be affected when deformation occurs. This maps to the # 'outputGeometry' attribute on the Maya node. SimpleDeformer.addAttribute(SimpleDeformer.attr_deform) outputGeom = ompx.cvar.MPxDeformerNode_outputGeom # Make sure that when the user adjusts the attr, it affects the geometry. SimpleDeformer.attributeAffects(SimpleDeformer.attr_deform, outputGeom) except: om.MGlobal.displayError("Failed to create attributes of %s node\n", kPluginNodeType) #------------------------------------------------------ # Loading and unloading: # initialize the script plug-in def initializePlugin(mobject): mplugin = ompx.MFnPlugin(mobject) try: mplugin.registerNode(kPluginNodeType, kPluginNodeId, nodeCreator, nodeInitializer, ompx.MPxNode.kDeformerNode) except: om.MGlobal.displayError("Failed to register node: %s\n"%kPluginNodeType) # uninitialize the script plug-in def uninitializePlugin(mobject): mplugin = ompx.MFnPlugin(mobject) try: mplugin.deregisterNode(kPluginNodeId) except: om.MGlobal.displayError("Failed to unregister node: %s\n"%kPluginNodeType) }}} After this is loaded in the plugin manager (see [[How can I load \ unload a Python scripted plugin?]]), pick a node in your scene, then create the deformer: {{{ import maya.cmds as mc d = mc.deformer(type='spSimpleDeformer') # [u'spSimpleDeformer1'] }}} Since you're creating the node via the {{{deformer}}} command, you can easily capture the return value of your newly created node name. You can now modify the deformer node's {{{deform}}} attribute, and watch the magic happen. I wanted to build a bare-minimum framework for authoring a file translator via a scripted plugin. Maya comes with a simple example here: http://download.autodesk.com/us/maya/2011help/API/custom_node_file_translator_8py-example.html Which I modified and added notes to in the example below. Once this plugin is imported, you can export and import the new 'sft' data via the Maya UI, or a script, just like any other type. This example simply exports the names of all nodes in the scene (or selected items) to a custom text file. The importer will read the text file, and print the contents to the script editor. But obviously this is just a simple framework that can be expanded upon. When it comes to creating a file translator, these are the major things required: * A class inheriting from {{{maya.OpenMayaMPx.MPxFileTranslator}}}. **It in turn inherits from {{{maya.OpenMayaMPx.MPxMayaAsciiFilter}}} **The name of this class is up to you, it is independent from the name of the node being created. The node name is actually defined in {{{initializePlugin()}}} **Must initialize the superclass in {{{__init__()}}} **Depending on the functionality you desire, must override the methods {{{writer}}}, {{{reader}}}, {{{haveWriteMethod}}}, {{{haveReadMethod}}}, {{{filter}}}, {{{defaultExtension}}}, among others. *Author a 'creator' function \ class method (we do it as a class method here). The name is arbitrary, but {{{creator()}}} is a good ideas. It is used by the {{{initializePlugin()}}} function. * Author {{{initializePlugin()}}} and {{{uninitializePlugin()}}} functions. Other than the overridden methods above, these are the only items in the code that need specific names. {{{ # spSimpleFileTranslator.py import maya.OpenMaya as om import maya.OpenMayaMPx as ompx # ----------------------------------- # Plugin code class SimpleFileTranslator(ompx.MPxFileTranslator): """ This class will create a new file translator type that will write out a simple text file of all the nodes in the scene. When reading the save data, it will print the result. http://download.autodesk.com/us/maya/2010help/API/class_m_px_file_translator.html """ # Define the name of our file translator in Maya: name = "spSimpleFileTranslator" # Define the extension it will use. 'sft' = 'simple file translator' extension = 'sft' def __init__(self): """ Initalize our superclass: """ ompx.MPxFileTranslator.__init__(self) #---------------------------------------------------- # Overridden superclass methods: # There are more than this, but we only need to use these for this example. def writer(self, fileObject, optionString, accessMode): """ What is called to when writing a file. In our example, we write out a simple txt file containing all the node names in the scene. This code supports exporting the whole scene, or only what's selected. Parameters: fileObject : MFileObject : http://download.autodesk.com/us/maya/2010help/API/class_m_file_object.html optionsString : string (MString in c++) accessMode : MFileTranslator.FileAccessMode enumerator : Unknown mode (0), import into new scene (1), reference (2), import into current scene (3), save (4), export (5), export selected (6). http://download.autodesk.com/us/maya/2010help/API/class_m_px_file_translator.html#237971b037a8b0cbb697d61a01da4b5d """ fullName = fileObject.resolvedFullName() try: with open(fullName, "w") as f: # If the whole scene is being exported. The enum value is 5: if accessMode == ompx.MPxFileTranslator.kExportAccessMode: f.write("# Simple text file of all nodes in the scene.\r\n") mItDependNode = om.MItDependencyNodes() # http://download.autodesk.com/us/maya/2010help/API/class_m_it_dependency_nodes.html while not mItDependNode.isDone(): # Extract the MObject, and build a function set to query its name: # http://download.autodesk.com/us/maya/2010help/API/class_m_fn_dependency_node.html mFnDependNode = om.MFnDependencyNode(mItDependNode.thisNode()) nodeName = mFnDependNode.name() f.write('%s\r\n'%nodeName) mItDependNode.next() # If we're exporting selected. The enum value is 6: elif accessMode == ompx.MPxFileTranslator.kExportActiveAccessMode: f.write("# Simple text file of selected nodes at time of export.\r\n") selList = om.MSelectionList() om.MGlobal.getActiveSelectionList(selList) # http://download.autodesk.com/us/maya/2010help/API/class_m_it_selection_list.html mItSelectionList = om.MItSelectionList(selList) mObject = om.MObject() while not mItSelectionList.isDone(): mItSelectionList.getDependNode(mObject) mFnDependNode = om.MFnDependencyNode(mObject) nodeName = mFnDependNode.name() f.write('%s\r\n'%nodeName) mItSelectionList.next() else: raise Exception("Invalid accessMode argument: %s"%accessMode) except: om.MGlobal.displayError("Failed to write file information\n") raise def reader(self, fileObject, optionString, accessMode): """ What is called to when reading a file. In our case, it just parses a text file and prints the result in the Script Editor. Parameters: fileObject : MFileObject : http://download.autodesk.com/us/maya/2010help/API/class_m_file_object.html optionsString : string (MString in c++) accessMode : MFileTranslator.FileAccessMode enumerator : Unknown mode (0), import into new scene (1), reference (2), import into current scene (3), save (4), export (5), export selected (6). http://download.autodesk.com/us/maya/2010help/API/class_m_px_file_translator.html#237971b037a8b0cbb697d61a01da4b5d """ lines = [] try: fullName = fileObject.resolvedFullName() with open(fullName,"r") as f: lines = [item.strip() for item in f] except: om.MGlobal.displayError("Failed to read file information\n") raise print "\nContents of file:" for line in lines: print "\t", line om.MGlobal.displayInfo("Contents from file %s"%fullName) def haveWriteMethod(self): """ The default is False: Change to True if this can write a file. """ return True def haveReadMethod(self): """ The default is False: Change to True if this can read a file. """ return True def filter(self): """ Return the custom filter used for this file type. Default is "*.*" """ return "*.%s"%SimpleFileTranslator.extension def defaultExtension(self): """ Return the custom extension for this file type. Default is an empty string. """ return SimpleFileTranslator.extension #--------------------------------------------------- # Translator creation method: # 'Creator Function' needs to return a pointer new instance of this type of # class, based on how the c++ code works. # As you can see, the OpenMayaMPx module has it's own functions (for which # I can find no online documentation). @classmethod def creator(cls): return ompx.asMPxPtr(cls()) # ----------------------------------- # Plugin registration\degregistration block # initializePlugin & uninitializePlugin are *required functions* def initializePlugin(mobject): # create a MFnPlugin mfnPlugin = ompx.MFnPlugin(mobject, "Eric Pavey", "1.0") try: # Try to register our plug by passing in the commandName, and the # translatorCreator: we use the '.registerFileTranslator()' method since # we're trying to build a file translator. Other plugin types use # different registration functions. The args do differ, check docs. # http://download.autodesk.com/us/maya/2010help/API/class_m_fn_plugin.html mfnPlugin.registerFileTranslator(SimpleFileTranslator.name, None, SimpleFileTranslator.creator) except: om.MGlobal.displayError("SimpleFileTranslator registration failed") raise def uninitializePlugin(mobject): # create a MFnPlugin mfnPlugin = ompx.MFnPlugin(mobject) try: # Try to deregister our plug by passing in the kPluginCmdName, and the command creator: mfnPlugin.deregisterFileTranslator(SimpleFileTranslator.name) except: om.MGlobal.displayError("SimpleFileTranslator deregistration failed") raise }}} After this is loaded in the plugin manager (see [[How can I load \ unload a Python scripted plugin?]]), you can export and import the data either via the Maya UI (File->Export All, File->Export Selected, File->Import) and choose the new 'sft' file-type, or you can use these commands: {{{ import maya.cmds as mc # To export: mc.file("C:/temp/sftTest.sft", type="spSimpleFileTranslator", exportAll=True) # To import: mc.file("C:/temp/sftTest.sft", type="spSimpleFileTranslator", i=True) }}} I wanted to build a bare-minimum framework for authoring a locator node via a scripted plugin. Maya comes with a pretty simple example here: http://download.autodesk.com/us/maya/2011help/API/foot_print_node_8py-example.html Which I stripped down even more, added a bunch of notes, etc. The below example creates a new square-shaped node called '{{{spSimpleLocator}}}' with a single '{{{size}}}' custon attribute. It will be a semi-transparent green in shaded mode. There is a bug in the ~OpenGL code however: It will occlude wireframe display behind it. I don't know much about ~OpenGL code, hopefully can address in the future. When it comes to creating a locator node, these are the major things required: * A class inheriting from {{{maya.OpenMayaMPx.MPxLocatorNode}}}. **It in turn inherits from {{{maya.OpenMayaMPx.MPxNode}}} **The name of this class is up to you, it is independent from the name of the node being created. The node name is actually defined in {{{initializePlugin()}}} **Must initialize the superclass in {{{__init__()}}} **Optional: Override the {{{compute()}}} method to do any extra internal-node computation. Not needed for standard locator behavior. **Override the {{{draw()}}} method, put your ~OpenGL draw calls in there. **Override the {{{isBounded()}}} and {{{boundingBox()}}} methods. *Author 'node creator' and 'node initializer' functions. The names are arbitrary, but {{{nodeCreator()}}} and {{{nodeInitializer()}}} are good ideas. These are both used by the {{{initializePlugin()}}} function. * Author {{{initializePlugin()}}} and {{{uninitializePlugin()}}} functions. Other than the overridden methods above, these are the only items in the code that need specific names. {{{ # spSimpleLocator.py import maya.OpenMaya as om import maya.OpenMayaMPx as ompx import maya.OpenMayaRender as omr import maya.OpenMayaUI as omui #------------------ # Constants: # c++ uses 'k' to specify constants, Python usually uses all caps. # Using k here since we're dealing with Maya legacy, but ultimately it doesn't matter. kPluginNodeType = "spSimpleLocator" # This identifier should be provided by Autodesk, to make sure it will never # clash with any other node type. I just made this one up. # http://download.autodesk.com/us/maya/2011help/API/class_m_type_id.html kPluginNodeId = om.MTypeId(0x00112) #------------------ # globals # This static (class) method creates an instance of MHardwareRenderer. There is # no web documentation for the 'theRenderer()', weird. # http://download.autodesk.com/us/maya/2011help/API/class_m_hardware_renderer.html renderer = omr.MHardwareRenderer.theRenderer() # This creates an instance of MGLFunctionTable, giving us access to OpenGL calls. # http://download.autodesk.com/us/maya/2011help/API/class_m_g_l_function_table.html glFT = renderer.glFunctionTable() # Vert positions that define the shape of our locator. If these change, you'll # also need to update the boundingBox() method. locShape = ([-.5, .5, 0], [.5, .5, 0], [.5, -.5, 0], [-.5, -.5, 0], [-.5, .5, 0]) class SimpleLocator(ompx.MPxLocatorNode): """ Scripted locator node creation. http://download.autodesk.com/us/maya/2011help/API/class_m_px_locator_node.html Inherits from MPxNode: http://download.autodesk.com/us/maya/2011help/API/class_m_px_node.html """ # Define any input and output attrs at the class level. # These are MObject representations of the attributes on the physical # Maya node. They are just placeholder: They are replaced\populated by nodeInitializer() # In fact, they could be None, but since ultimately they'll be MObjects, # just stick some dummy ones in there. attr_size = om.MObject() def __init__(self): """ Make sure to initilaize the superclass. Not much else happens here. """ ompx.MPxLocatorNode.__init__(self) def compute(self, plug, dataBlock): """ Overridden method of the MPxNode superclass. Doesn't do much since we're not computing any internal values. But in theory, you could. """ return om.kUnknownParameter def draw(self, view, path, style, status): """ Overridden method of MPxLocatorNode. Allows the drawing of the locator via OpenGL. Parameters: view : M3dView, http://download.autodesk.com/us/maya/2011help/API/class_m3d_view.html, the 3D view that is being drawn into. path : MDagPath, http://download.autodesk.com/us/maya/2011help/API/class_m_dag_path.html, the path to the locator in the DAG. style : M3dView MDisplayStyle enum value, http://download.autodesk.com/us/maya/2011help/API/class_m3d_view.html. the style to draw the locator in. status : M3dView MDisplayStatus enum value, http://download.autodesk.com/us/maya/2011help/API/class_m3d_view.html, the selection status of the locator. """ thisNode = self.thisMObject() # superclass method, returns MObject plug = om.MPlug(thisNode, self.attr_size) # returns MPlug sizeVal = plug.asMDistance() # returns MDistance multiplier = sizeVal.asCentimeters() # returns double # Start the OpenGL drawing. Time to put your OpenGL hat on. view.beginGL() # If we're in any kind of shaded view, draw a 'filled-in' view of the locator: if style == omui.M3dView.kFlatShaded or style == omui.M3dView.kGouraudShaded: # To enable alpha blending on our locator faces, we need to set this GL state: # http://www.opengl.org/sdk/docs/man/xhtml/glEnable.xml glFT.glEnable(omr.MGL_BLEND) # Methods starting with 'gl' are direct calls to OpenGL. # Also, OpenMayaRender has many OpenGL related constants that begin # with capital 'M', that can be passed into the GL calls. # Both of these concepts are shown in this doc: # http://www.opengl.org/sdk/docs/man/xhtml/glPushAttrib.xml glFT.glPushAttrib(omr.MGL_CURRENT_BIT) # Setup the draw colors based on if the locator is the lead picked # object or not, or not picked at all. For the below examples they're # all the same value. if status == omui.M3dView.kLead: # If it is the first object picked. glFT.glColor4f(0, 1, 0, .5) if status == omui.M3dView.kActive: # If it's picked, but not lead. glFT.glColor4f(0, 1, 0, 0.5) # Here is another way to set colors based on Maya's color palette, # but you can't do alpha: #view.setDrawColor( 13, omui.M3dView.kActiveColors ) if status == omui.M3dView.kDormant: glFT.glColor4f(0, 1, 0, 0.5) #view.setDrawColor( 13, omui.M3dView.kDormantColors ) # Draw the physical triangles to fill in the shape: # http://www.opengl.org/sdk/docs/man/xhtml/glBegin.xml glFT.glBegin(omr.MGL_TRIANGLE_FAN ) for i in range(len(locShape)-1): glFT.glVertex3f(locShape[i][0]*multiplier, locShape[i][1]*multiplier, locShape[i][2]*multiplier) glFT.glEnd() # Turn off alpha blending: glFT.glDisable(omr.MGL_BLEND) glFT.glPopAttrib() # need to pop for each push. # Now start drawing the wireframe as well. I've yet to figure out what # defines the wireframe color in Maya, since the 'locator' color in the # prefs don't seem to apply to this custom node. glFT.glBegin(omr.MGL_LINES) for i in range(len(locShape)-1): glFT.glVertex3f( locShape[i][0]*multiplier, locShape[i][1]*multiplier, locShape[i][2]*multiplier ) glFT.glVertex3f( locShape[i+1][0]*multiplier, locShape[i+1][1]*multiplier, locShape[i+1][2]*multiplier ) glFT.glEnd() view.endGL() # End all OpenGL drawing. def isBounded(self): """ Overridden method of MPxLocatorNode. If return True, must supply an overridden boundingBox method to compute bounding box. """ return True def boundingBox(self): """ Overridden method of MPxLocatorNode. Must return a MBoundingBox object specifying the bounding box of this node. http://download.autodesk.com/us/maya/2011help/API/class_m_bounding_box.html """ thisNode = self.thisMObject() # MObject plug = om.MPlug(thisNode, self.attr_size) # MPlug sizeVal = plug.asMDistance() # MDistance multiplier = sizeVal.asCentimeters() # double # Two corners of our square shaped locator: corner1 = om.MPoint(-.5, .5, 0) corner2 = om.MPoint(.5, -.5, 0) corner1 = corner1 * multiplier corner2 = corner2 * multiplier bbox = om.MBoundingBox( corner1, corner2 ) # MBoundingBox return bbox #--------------------------------------------------- # Node creation and initialization: # creator def nodeCreator(): return ompx.asMPxPtr( SimpleLocator() ) # initializer def nodeInitializer(): """ This function sets up all the input and output attributes on the node: What type of data they should expect, if they're inputs\outputs, keyable, connectable, default values, etc. Also defines the relationships between attrs using attributeAffects(): If an input changes, you should update the output. """ # Create the 'size' attribute. This will end up overriding the locators # default 'localScale' attr. # http://download.autodesk.com/us/maya/2011help/API/class_m_fn_unit_attribute.html unitFn = om.MFnUnitAttribute() # Returns an MObject, assignes it to the class variable: SimpleLocator.attr_size = unitFn.create("size", "in", om.MFnUnitAttribute.kDistance) unitFn.setChannelBox(True) # default is False unitFn.setKeyable(True) # default is False unitFn.setDefault(1.0) SimpleLocator.addAttribute( SimpleLocator.attr_size ) #------------------------------------------------------ # Loading and unloading: # initialize the script plug-in def initializePlugin(mobject): mplugin = ompx.MFnPlugin(mobject) try: mplugin.registerNode(kPluginNodeType, kPluginNodeId, nodeCreator, nodeInitializer, ompx.MPxNode.kLocatorNode) except: om.MGlobal.displayError("Failed to register node: %s"%kPluginNodeType) # uninitialize the script plug-in def uninitializePlugin(mobject): mplugin = ompx.MFnPlugin(mobject) try: mplugin.deregisterNode(kPluginNodeId) except: om.MGlobal.displayError("Failed to deregister node: %s"%kPluginNodeType) }}} After this is loaded in the plugin manager (see [[How can I load \ unload a Python scripted plugin?]]), you should be able to create it and play with it: {{{ import maya.cmds as mc mc.createNode('spSimpleLocator') }}} I should note that after I authored this, I found another good resource on scripted plugin locator creation here: http://www.fevrierdorian.com/blog/post/2010/02/12/Creating-custom-locator-with-Maya-s-Python-API I wanted to build a bare-minimum framework for authoring nodes via a scripted plugin. Maya comes with a pretty simple example here: http://download.autodesk.com/us/maya/2011help/API/circle_node_8py-example.html Which I stripped down even more, added a bunch of notes, etc. The below example creates a new node called '{{{simpleNodeA}}}' that has two inputs. Internally, it simply adds those values together, which can then be captured from its single output attribute. When it comes to creating a node, these are the major things required: *A class inheriting from {{{maya.OpenMayaMPx.MPxNode}}}. **The name of this class is up to you, it is independent from the name of the node being created. The node name is actually defined in {{{initializePlugin()}}} **Must initialize the superclass in {{{__init__()}}}. **Must override the {{{compute()}}} method: This is where the node does it's work. *Author 'node creator' and 'node initializer' functions. The names are arbitrary, but {{{nodeCreator()}}} and {{{nodeInitializer()}}} are good ideas. These are both used by the {{{initializePlugin()}}} function. The 'node creator' does very little, while the 'node initializer' does a bunch of attribute setup (presuming your node has attributes). *Author {{{initializePlugin()}}} and {{{uninitializePlugin()}}} functions. Other than the overridden methods above, these are the only items in the code that need specific names. {{{ # spSimpleNode.py import maya.OpenMaya as om import maya.OpenMayaMPx as ompx #------------------------------------------------------------- # Constants # c++ uses 'k' to specify constants, Python usually uses all caps. # Using k here since we're dealing with Maya legacy, but ultimately it doesn't matter. # What the node-type will be called in Maya. kPluginNodeType = "simpleNodeA" # This identifier should be provided by Autodesk, to make sure it will never # clash with any other node type. I just made this one up. # http://download.autodesk.com/us/maya/2011help/API/class_m_type_id.html kPluginNodeId = om.MTypeId(0x00111) kVendor = "My Name or organization" kVersion = "1.0" #---------------------------------------------------------- # Plugin code: # Node definition class SimpleNode(ompx.MPxNode): """ Scripted plugin node creation. http://download.autodesk.com/us/maya/2011help/API/class_m_px_node.html """ # Define any input and output attrs at the class level. # These are MObject representations of the attributes on the physical # Maya node. They are just placeholder: They are replaced\populated by nodeInitializer() # In fact, they could be None, but since ultimately they'll be MObjects, # just stick some dummy ones in there. attr_inputA = om.MObject() attr_inputB = om.MObject() attr_output = om.MObject() def __init__(self): """ Make sure to initilaize the superclass. Not much else happens here. """ ompx.MPxNode.__init__(self) def compute(self, plug, dataBlock): """ This is an overridden method of the MPxNode class. Does the "work" the node is to perform. Parameters: plug : MPlug : http://download.autodesk.com/us/maya/2010help/API/class_m_plug.html dataBlock : MDataBlock : http://download.autodesk.com/us/maya/2010help/API/class_m_data_block.html """ # Check that the requested recompute is our output value if (plug == SimpleNode.attr_output): # Read the input values, returns a MDataHandle, which is a smart pointer # back into the MDataBlock (dataBlock) # http://download.autodesk.com/us/maya/2010help/API/class_m_data_handle.html dataHandleA = dataBlock.inputValue(SimpleNode.attr_inputA) dataHandleB = dataBlock.inputValue(SimpleNode.attr_inputB) # Compute the output values. In this case, it is a simple addition operation. outVal = dataHandleA.asFloat() + dataHandleB.asFloat() # Get a handle to the output value and store the new value. handle = dataBlock.outputValue(SimpleNode.attr_output) handle.setFloat(outVal) # From the docs: Tells the dependency graph that the given attribute # has been updated and is now clean. This should be called after the # data in the plug has been recalculated from the inputs of the node. dataBlock.setClean(plug) #else: # c++ requires this return, but it appears that the Python API doesn't: #return om.MStatus.kUnknownParameter #--------------------------------------------------- # Node creation and initialization: # Creator function. It should be noted that while historically this is an external # function, you could instead, inside the initializePlugin function, call to this # via a lambda. Meaning, instead of this line (below): # mfnPlugin.registerNode(kPluginNodeType, kPluginNodeId, nodeCreator, nodeInitializer) # You could do this: # mfnPlugin.registerNode(kPluginNodeType, kPluginNodeId, lambda:ompx.asMPxPtr(SimpleNode()), nodeInitializer) # And in the process completely remove the below function. def nodeCreator(): return ompx.asMPxPtr( SimpleNode() ) # initializer def nodeInitializer(): """ This function sets up all the input and output attributes on the node: What type of data they should expect, if they're inputs\outputs, keyable, connectable, default values, etc. Also defines the relationships between attrs using attributeAffects(): If an input changes, you should update the output. """ # http://download.autodesk.com/us/maya/2010help/API/class_m_fn_numeric_attribute.html mfnNumericAttribute = om.MFnNumericAttribute() # Setup the input attributes. This returns an MObject. SimpleNode.attr_inputA = mfnNumericAttribute.create("inputA", "ina", om.MFnNumericData.kFloat, 1.0) # The setStorable() method is inheirted from MFnAttribute mfnNumericAttribute.setChannelBox(True) # default is False mfnNumericAttribute.setKeyable(True) # default is False SimpleNode.attr_inputB = mfnNumericAttribute.create("inputB", "inb", om.MFnNumericData.kFloat, 10.0) mfnNumericAttribute.setChannelBox(True) # default is False mfnNumericAttribute.setKeyable(True) # default is False # Setup the output attributes SimpleNode.attr_output = mfnNumericAttribute.create("output", "o", om.MFnNumericData.kFloat, 0.0) mfnNumericAttribute.setWritable(False) # Default is True. This is an output, can't write to it. mfnNumericAttribute.setStorable(False) # Default is True. Do not save value with scene, since it's an output. # Now that we've made the attributes, add them to the node. # addAttribute() is a static method inherited from MPxNode. SimpleNode.addAttribute(SimpleNode.attr_inputA) SimpleNode.addAttribute(SimpleNode.attr_inputB) SimpleNode.addAttribute(SimpleNode.attr_output) # Set the attribute dependencies: This tells the system that when an input # is modified, the output needs to be recomputed. # attributeAffects() is a static method inherited from MPxNode. SimpleNode.attributeAffects(SimpleNode.attr_inputA, SimpleNode.attr_output) SimpleNode.attributeAffects(SimpleNode.attr_inputB, SimpleNode.attr_output) #------------------------------------------------------ # Loading and unloading: def initializePlugin(mobject): # Initialize the script plug-in # http://download.autodesk.com/us/maya/2011help/API/class_m_fn_plugin.html mfnPlugin = ompx.MFnPlugin(mobject, kVendor, kVersion) try: mfnPlugin.registerNode(kPluginNodeType, kPluginNodeId, nodeCreator, nodeInitializer) except: om.MGlobal.displayError("Failed to register node: %s" % kPluginNodeType) raise def uninitializePlugin(mobject): # Uninitialize the script plug-in mplugin = ompx.MFnPlugin(mobject) try: mplugin.deregisterNode(kPluginNodeId) except: om.MGlobal.displayError("Failed to deregister node: %s" % kPluginNodeType) raise }}} After this is loaded in the plugin manager (see [[How can I load \ unload a Python scripted plugin?]]), you should be able to create it, and connect it's output to something else. Below examples are in Python, but you can just as easily access this via mel. {{{ import maya.cmds as mc simpleNode = mc.createNode('simpleNodeA') null = mc.group(empty=True) mc.connectAttr('%s.output'%simpleNode, '%s.tx'%null) # Result: Connected simpleNodeA1.output to null1.translate.translateX. # }}} Optionally, you could do this: {{{ import maya.cmds as mc import spSimpleNode simpleNode = mc.createNode(spSimpleNode.kPluginNodeType) null = mc.group(empty=True) mc.connectAttr('%s.output'%simpleNode, '%s.tx'%null) # Result: Connected simpleNodeA1.output to null1.translate.translateX. # }}}  While Python comes with its own built-in types, sometimes you need to access a specific API type wrapper. This is not a rigid: What one considers a 'type' is up for consideration here, I just grabbed classes that fit the bill in my own head. All are part of {{{maya.OpenMaya}}} !!!Angle *[[MAngle|http://download.autodesk.com/us/maya/2010help/API/class_m_angle.html]] !!!Color *[[MColor|http://download.autodesk.com/us/maya/2010help/API/class_m_color.html]] *[[MColorArray|http://download.autodesk.com/us/maya/2010help/API/class_m_color_array.html]] !!!Dag Path: *[[MDagPath|http://download.autodesk.com/us/maya/2010help/API/class_m_dag_path.html]] *[[MDagPathArray|http://download.autodesk.com/us/maya/2010help/API/class_m_dag_path_array.html]] !!!Distance *[[MDistance|http://download.autodesk.com/us/maya/2010help/API/class_m_distance.html]] !!!Double *[[MDoubleArray|http://download.autodesk.com/us/maya/2010help/API/class_m_double_array.html]] !!!Euler Rotation *[[MEulerRotation|http://download.autodesk.com/us/maya/2010help/API/class_m_euler_rotation.html]] !!!Float *[[MFloatArray|http://download.autodesk.com/us/maya/2010help/API/class_m_float_array.html]] !!!Int *[[MIntArray|http://download.autodesk.com/us/maya/2010help/API/class_m_int_array.html]] !!!Point *[[MPoint|http://download.autodesk.com/us/maya/2010help/API/class_m_point.html]] *[[MFloatPoint|http://download.autodesk.com/us/maya/2010help/API/class_m_float_point.html]] *[[MPointArray|http://download.autodesk.com/us/maya/2010help/API/class_m_point_array.html]] *[[MFloatPointArray|http://download.autodesk.com/us/maya/2010help/API/class_m_float_point_array.html]] !!!Matrix *[[MMatrix|http://download.autodesk.com/us/maya/2010help/API/class_m_matrix.html]] *[[MFloatMatrix|http://download.autodesk.com/us/maya/2010help/API/class_m_float_matrix.html]] *[[MTransformationMatrix|http://download.autodesk.com/us/maya/2010help/API/class_m_transformation_matrix.html]] *[[MMatrixArray|http://download.autodesk.com/us/maya/2010help/API/class_m_matrix_array.html]] !!!Object: *[[MObject|http://download.autodesk.com/us/maya/2010help/API/class_m_object.html]] *[[MObjectArray|http://download.autodesk.com/us/maya/2010help/API/class_m_object_array.html]] !!!Plug *[[MPlug|http://download.autodesk.com/us/maya/2010help/API/class_m_plug.html]] *[[MPlugArray|http://download.autodesk.com/us/maya/2010help/API/class_m_plug_array.html]] !!!Pointers & References *See [[OpenMaya.MScriptUtil]] !!!Quaternion *[[MQuaternion|http://download.autodesk.com/us/maya/2010help/API/class_m_quaternion.html]] !!!String Note: These aren't available in the Python ~OpenMaya API *[[MString|http://download.autodesk.com/us/maya/2010help/API/class_m_string.html]] *[[MStringArray|http://download.autodesk.com/us/maya/2010help/API/class_m_string_array.html]] !!!Time *[[MTime|http://download.autodesk.com/us/maya/2010help/API/class_m_time.html]] *[[MTimeArray|http://download.autodesk.com/us/maya/2010help/API/class_m_time_array.html]] !!!Unsigned Int *[[MUintArray|http://download.autodesk.com/us/maya/2010help/API/class_m_uint_array.html]] *[[MUint64Array|http://download.autodesk.com/us/maya/2010help/API/class_m_uint64_array.html]] !!!Vector *[[MVector|http://download.autodesk.com/us/maya/2010help/API/class_m_vector.html]] *[[MFloatVector|http://download.autodesk.com/us/maya/2010help/API/class_m_float_vector.html]] *[[MVectorArray|http://download.autodesk.com/us/maya/2010help/API/class_m_vector_array.html]] *[[MFloatVectorArray|http://download.autodesk.com/us/maya/2010help/API/class_m_float_vector_array.html]]  Pseudo code: {{{ # Some scripted plugin... import maya.OpenMaya as om import maya.OpenMayaMPx as ompx class Test(ompx.MPxCommand): def doIt(self, args): defaultArg = 5.0 index = args.flagIndex("d", "default") if om.MArgList.kInvalidArgIndex != index: defaultArg = args.asDouble(index+1) # lots more code... }}} So what object type is {{{args}}}? The passed in args are turned into an object type of {{{OpenMaya.MArgList}}}, so you have direct access to all of its methods (simple example above querying for a flag). Docs: http://download.autodesk.com/us/maya/2009help/API/class_m_arg_list.html  Scratchpad of API stuff. A lot of this is just pulled directly from the Maya docs. And it should be noted this is entirely based on the @@//Python//@@ implementation of the API. No c++ stuff in here (other than helpful comparisons for learning the Python side of things). ---- I would be nice to link to this, but.... *"Maya Help -> Developer Resources -> API Guide -> ''Using the Maya Python API''" You need to import Python's ~OpenMaya module to get at most of the functionality. Import others to do other things: like {{{OpenMayaMPx}}} if you're going to author a scripted pluigin {{{ import maya.OpenMaya as om import maya.OpenMayaMPx as ompx }}} ---- Online Resources: *http://groups.google.com/group/python_inside_maya *[[This thread|http://groups.google.com/group/python_inside_maya/browse_thread/thread/9fa689ab6edf834a#]] in the 'python_inside_maya' Google groups. *http://www.comet-cartoons.com/3ddocs/mayaAPI/ *http://www.rtrowbridge.com/blog/category/maya-python-api/ *The {{{OpenMaya.MScriptUtil}}} is a common class the Python API programmer will need to use. Some examples here: **http://www.chadvernon.com/blog/resources/maya-api-programming/mscriptutil/ Good quality official documentation: *http://download.autodesk.com/us/maya/2009help/API/ *http://download.autodesk.com/us/maya/2010help/API/ *http://download.autodesk.com/us/maya/2011help/API/ *http://download.autodesk.com/global/docs/mayasdk2012/en_us/index.html *http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/index.html If you have an Autodesk support subscription, you can download their "__API and Game Dev__" podcasts and associated files here: *http://subscription.autodesk.com -> Training -> Autodesk Maya -> Maya Video Podcasts -> Scripting and the API This appears to be free, I have yet to actually look at it yet: *http://download.autodesk.com/media/adn/Maya_Intermediate_Webcast.zip ---- ''Differences between {{{c++}}} and {{{Python}}}'' (based on my ignorance of c++, take this with a grain of salt.) *Pointers: **See online reference for an overview: http://oreilly.com/catalog/pcp3/chapter/ch13.html *Namespaces: **c++ uses double colon {{{::}}} to define namespaces, Python uses single period '{{{.}}}': {{{ # c++: MGlobal::displayInfo() # Python: OpenMaya.MGlobal.displayInfo() }}} *Passing in args: **In the c++ docs, if you see something like this: {{{ MFnMesh ( const MObject & object, MStatus * ReturnStatus ) }}} **What do the arg symbols mean? **''{{{&}}}'' : The ampersand specify that the function is expecting an object to be passed in as a //reference//. The object can be modified, but not always. **''{{{*}}}'' : The asterisk specifies a //pointer to an object// (in c++ terms). This object //will be modified// by the function. Often times you need to use the {{{OpenMaya.MScriptUtil}}} class to create pointers to be passed in. **Some pseudo c++ code: {{{ MObject foo; MStatus result; MFnMesh(foo, result); if result.success(): do something involving foo maybe... }}} It should be noted that in the Python API, these two values can be considered the same thing for the most part: Pass by reference. ---- Constants / Enumerators: *Any name with a {{{k}}} in the front is a //constant//, or an //enumerator//. These could be considered variables with pre-defined values. *{{{k}}} is an old-school 'Hungarian-notation' way of specifying a constant value. Just a convention. *A listing can be found [[here|http://download.autodesk.com/us/maya/2009help/API/functions_eval_0x6b.html#index_k]]. Examples: {{{ MItDag.kDepthFirst MFn.kMesh }}} ---- Example of ~OpenMaya ''M'' Class at work: {{{ import maya.OpenMaya as om vector1 = om.MVector(0,1,0) vector2 = om.MVector(1,0,0) vector3 = om.MVector(0,0,2) newV = vector1 + vector2 + vector3 print "newVector %f, %f, %f " % (newV.x, newV.y, newV.z) # newVector 1.000000, 1.000000, 2.000000 }}} ---- Maya's API object hierarchy is handled a bit differently from a standard OOP approach of object inheritance: In standard OOP, objects hold both the data (attributes) and functions (methods). Conceptually, the Maya API has a split, with attributes (the data) living on one side of the fence and methods (functions) acting on that data on the other. These are referred to as {{{function sets}}}, and in OOP these classes are called {{{functors}}}. Using some {{{c++}}} pseudo-code: First, presume we have this object hierarchy, and function hierarchy (each is a class): {{{ Object (superclass) ---- FooObj (subclass) ---- GooObj (subclass) ObjFunc (superclass) ---- FooFunc (subclass) ---- GooFunc (subclass) }}} The {{{Object}}} objects contain data, plus member functions to access their data. The {{{ObjFunc}}} objects have corresponding member functions to access the {{{Object}}} data, but they themselves don't contain any of that data: The data is passed to them: {{{ FooObj fooData; FooFunc fooFn; fooFn.setObj(fooData); fooFn.doStuff(); }}} As you can see, you make an {{{FooObj}}} type object called {{{fooData}}} (which inherits from {{{Object}}}) , and a corresponding {{{FooFunc}}} object (inheriting from {{{ObjFunc}}}) called {{{fooFn}}}. You pass {{{objData}}} into {{{objFunc}}}, and then do something to it. {{{FooFunc}}} objects only work on {{{FooObj}}} objects, {{{GooFunc}}} objects only work on {{{GooObj}}} objects. It should be noted that while the function class define an interface for doing work on the data, it's the data classes that do the real work. Wacky! ''In Maya, you are only ever given access to an class called @@~MObject@@''. This is the "root" object type in Maya. Accessing all the hiden data in Maya is done through its {{{function set}}} hierarchy. In actuality, ~MObject is just a //handle// (or a pointer) to another object inside the Maya core. There is a root 'function' as well, which is @@''~MFnBase''@@.  This topic name is a bit abstract, but here's the idea: Via the {{{OpenMaya}}} API, various classes 'go together'. These are my notes to help show which ones connect to which. *[[OpenMaya.MItDag|http://download.autodesk.com/us/maya/2011help/API/class_m_it_dag.html]] : Use the DAG iterator to traverse the DAG either depth first or breadth first, visiting each node. **[[OpenMaya.MFnDagNode|http://download.autodesk.com/us/maya/2011help/API/class_m_fn_dag_node.html]] Generic function set which can be used on any dag node. *[[OpenMaya.MItDependencyGraph|http://download.autodesk.com/us/maya/2011help/API/class_m_it_dependency_graph.html]] : Iterate over Dependency Graph (DG) Nodes or Plugs starting at a specified root Node or Plug. **OpenMaya.MObject **OpenMaya.MPlug **OpenMaya.MObjectArray **OpenMaya.MPlugArray **OpenMaya.MDGModifier **OpenMaya.MFnAttribute *[[OpenMaya.MItDependencyNodes|http://download.autodesk.com/us/maya/2011help/API/class_m_it_dependency_nodes.html]] : Traverse all the nodes in Maya's Dependency Graph. **[[OpenMaya.MFnDependencyNode|http://download.autodesk.com/us/maya/2011help/API/class_m_fn_dependency_node.html]] : creation and manipulation of dependency graph nodes *[[OpenMaya.MSelectionList|http://download.autodesk.com/us/maya/2011help/API/class_m_selection_list.html]] **[[OpenMaya.MItSelectionList|http://download.autodesk.com/us/maya/2011help/API/class_m_it_selection_list.html]] Classes are organized into these main groups: {{{M}}}, {{{MFn}}}, {{{MIt}}}, & {{{MPx}}}. Also see: [[API: Commonly used classes]] *@@{{{M}}}@@ classes are Maya's base utility classes. ''M'' stands for "Model". Most, although not all, of these classes are “Wrappers”. Examples of this class are: **@@{{{MObject}}}@@ is the base class of all objects. They are operated on via {{{MFn}}} function sets, and {{{MIt}}} iterators. **@@{{{MPlug}}}@@ is the API interface for an attribute **@@{{{MSelectionList}}}@@ handles everything to do with selections **@@{{{MScriptUtil}}}@@ is key when doing API work from Python **@@{{{MGlobal}}}@@ has a lot of random goodies. (could be called "m-misc.") **many more... *@@{{{MFn}}}@@ classes ([[docs|http://download.autodesk.com/us/maya/2009help/API/group___m_fn.html]]) are wrappers to make accessing common object easier. 'Fn' = 'Function'. They wrapper "functionality". Any class with this prefix is a //''function set''// used to operate on {{{MObject}}}s of a particular type. All {{{MFn}}} classes (other than {{{MFn}}} itself) live as part of a class inheritance hierarchy, the root being {{{MFnBase}}}. This differentiates them from the other class types ({{{M}}}, {{{MIt}}}, {{{MPx}}}) which //don't// have a class inheritance hierarchy. Examples: **@@{{{MFnDagNode}}}@@ / @@{{{MFnDependencyNode}}}@@ give you access to the DG/DAG. **@@{{{MFnMesh}}}@@ makes mesh access easy. **@@{{{MFnLambertShader}}}@@ exposes lots of material goodness **many more... *@@{{{MIt}}}@@ (mit) classes are for iterating though data (for looping through things). 'It' = 'Iterator'. They wrapper "iteration". These classes are iterators and work on ~MObjects similar to the way a function set (~{{{MFn}}} classes) does. For example, {{{MItCurveCV}}} is used to operate on an individual NURBS curve CV (there is no ~MFnNurbsCurveCV), or, iteratively, on all the CV's of a curve. They work on ~MObjects similar to the way a function set does. Examples: **@@{{{MItDagNode}}}@@ iterates through the entire DAG (all nodes) **@@{{{MITMesh}}}@@ **@@{{{MItGeometry}}}@@ iterates through all aspects of a mesh. **many more... *@@{{{MPx}}}@@ classes are for creating custom plugins. 'Px' = 'Proxy'. See [[Authoring Scripted Plugins via Python]]. They are API classes designed for you to derive from and create your own object types. Examples: **@@{{{MPxCommand}}}@@ : Allows you to create custom //mel commands//. **@@{{{MPxFileTranslator}}}@@ : custom file import/export **@@{{{MPxNode}}}@@ : For making custom DG nodes. **@@{{{MPxContext}}}@@ : Custom context creation **@@{{{MPxLocatorNode}}}@@ : Custom locator type creation. **many more... All Maya classes are contained in different Python packages (which closely mirror the c++ ones). All the below classes in ''{{{bold}}}'' are children of the {{{maya}}} package (as in {{{maya.OpenMaya}}}). It should be noted that the organization of Maya's API ''docs'' and its Python ''packages'' //are not the same//. Below describes how the Python //packages// are organized. For example, Maya's {{{OpenMaya}}} //docs// will list that the {{{MPxBakeEngine}}} class is part of it, but in fact it isn't (it's part of {{{OpenMayaMPx}}}). I think the docs try to lump similar classes together, which is nice, but it makes it harder to find them in the API, IMO. *''{{{maya.OpenMaya}}}'' ([[docs|http://download.autodesk.com/us/maya/2009help/API/group___open_maya.html]]) **Contains {{{M}}}, {{{MFn}}}, & {{{MIt}}} classes. *''{{{maya.OpenMayaMPx}}}'' ([[docs|http://download.autodesk.com/us/maya/2009help/API/group___m_px.html]]) **Contains {{{MFn}}} & {{{MPx}}} classes. *''{{{maya.OpenMayaAnim}}}'' ([[docs|http://download.autodesk.com/us/maya/2009help/API/group___open_maya_anim.html]]) Animation related classes. **Contains {{{M}}}, {{{MFn}}}, & {{{MIt}}} classes. *''{{{maya.OpenMayaUI}}}'' ([[docs|http://download.autodesk.com/us/maya/2009help/API/group___open_maya_u_i.html]]) Clases for manipulating the UI. **Contains {{{M}}} & {{{MFn}}} classes. *''{{{maya.OpenMayaFX}}}'' ([[docs|http://download.autodesk.com/us/maya/2009help/API/group___open_maya_f_x.html]]) API modules for FX. **Contains {{{M}}} & {{{MFn}}} classes. *''{{{maya.OpenMayaRender}}}''([[docs|http://download.autodesk.com/us/maya/2009help/API/group___open_maya_render.html]]) API module for rendering. **Contains {{{M}}} & {{{MFn}}} classes. *''{{{maya.OpenMayaCloth}}}'' API for cloth systems **Contains {{{M}}} classes. I'm guessing those are closely tied to these .dll files: *{{{\Autodesk\Maya20XX\bin\}}} **{{{OpenMaya.dll}}} **{{{OpenMayaAnim.dll}}} **{{{OpenMayaFX.dll}}} **{{{OpenMayaRender.dll}}} **{{{OpenMayaUI.dll}}} Furthermore, the c++ header files they wrapper live here: {{{ \Autodesk\Maya20XX\include\maya\*.h }}} ---- If you want to see how the modules are organized, you can use the below code to have a view into some of the more popular ones. It will collect all the class types into lists (in addition to any constants in the module, and 'other' classes), and display them grouped together: {{{ import maya.OpenMaya as om import maya.OpenMayaMPx as ompx import maya.OpenMayaAnim as oma import maya.OpenMayaUI as omui import maya.OpenMayaFX as omfx for mod in [om, ompx, oma, omui, omfx]: M = [] MFn = [] MIt = [] MPx = [] others = [] constants = [] desc = ["M", "MFn", "MIt", "MPx", "others", "constants"] for item in sorted(dir(mod)): if item.startswith("MPx"): MPx.append(item) elif item.startswith("MFn"): MFn.append(item) elif item.startswith("MIt"): MIt.append(item) elif item.startswith("M"): if item[1].isupper() or item[1].isdigit(): M.append(item) else: others.append(item) elif item.startswith('k') and item[1].isupper(): constants.append(item) else: others.append(item) print "\n",mod for i,items in enumerate([M, MFn, MIt, MPx, others, constants]): print "\n\t----%s----"%desc[i] for m in sorted(items): print "\t\t", m }}} Prints (a //lot// of stuff. Truncated below): {{{ <module 'maya.OpenMaya' from 'c:\Program Files\Autodesk\Maya2010\Python\lib\site-packages\maya\OpenMaya.pyc'> ----M---- MAngle MAngle_internalToUI MAngle_internalUnit MAngle_setInternalUnit MAngle_setUIUnit MAngle_swigregister etc... ----MFn---- MFn MFnAmbientLight MFnAmbientLight_swigregister MFnAnisotropyShader MFnAnisotropyShader_swigregister etc... ----MIt---- MItCurveCV MItCurveCV_swigregister MItDag MItDag_swigregister MItDependencyGraph etc... ----MPx---- ----others---- NULL _OpenMaya __builtins__ __doc__ etc... ----constants---- kDefaultNodeType kEulerRotationEpsilon kMFnMeshInstanceUnspecified kMFnMeshPointTolerance kMFnMeshTolerance etc... etc... }}}  I give a more robust example of this in action here: [[API: undoing commands]] But to make it concise here: If you want a scripted plugin based on a [[MPxCommand|http://download.autodesk.com/us/maya/2010help/API/class_m_px_command.html]] to return some type of value, you need to do that via its {{{setResult}}} method. Code snippet below: {{{ import maya.OpenMayaMPx as ompx class Foo(ompx.MPxCommand): def __init__(self): ompx.MPxCommand.__init__(self) # A list later filled with data to return: self.returnList = [] def doIt(self, argList): # bunch of code, filling self.returnList... # then at the end, to set the return value: self.setResult(self.returnList) }}} I've found one downside to using Maya Python API calls that change the DG in scripts (rather than scripted plugins): It bypasses Maya's undo queue: I've tried wrappering the API code chunks in an [[undoQueue|How can I author an undo context manager?]], but it's had no effect. Why? Because Maya's command engine only undoes actual registered //commands//. What counts as a valid thing that //can// be undone? *A command (based on [[MPxCommand|http://download.autodesk.com/us/maya/2011help/API/class_m_px_command.html]]) authored via the Maya Python API as a scripted plugin (that supports undoing). *A command (based on [[MPxCommand|http://download.autodesk.com/us/maya/2011help/API/class_m_px_command.html]]) authored via c++ as a 'regular' plugin (that supports undoing). *Any standard Maya commands (whether executed via mel or Python). *A mel procedure \ script or Python function \ class \ module with calls to the above items. What can't be undone? *Piecemeal bits of Maya Python API code put in a function. A Maya Python API class isn't a //command//: It's a piece of code which can be used to //create a command// (or custom node, etc..). Maya undoes //whole registered commands//, not the parts and pieces which make those commands work. Which is explained in [[this note|http://download.autodesk.com/global/docs/mayasdk2012/en_us/index.html?url=files/Maya_Python_API_Differences_between_the_C_Maya_API_and_Maya_Python_API.htm,topicNumber=d28e15702]] in the Maya docs: >It is possible to mix Maya Python API calls along with Maya command calls in the same script. Undoing the operations of such a script will not be correct if the Maya Python API calls modify the model and do not properly support undo using the [[MPxCommand|http://download.autodesk.com/us/maya/2011help/API/class_m_px_command.html]] class. !!How to support undoing: ''If you want to undo API calls, you need to author them in a scripted plugin that supports undoing''. There is a general rule that "any API call that modifies the DG will need to be able to be undone". I've found two main techniques for doing this, I'll call them 'easy', and 'hard': *The easy method makes use of a {{{MDGModifier}}}, which more or less handles all the nasty undoing stuff for you by encapsulating all of the changes within it: You register the changes with the {{{MDGModifier}}} inside the {{{doIt()}}} method, but they aren't 'done' until the {{{redoIt()}}} method is called, or 'undone' when the {{{undoIt()}}} method is called. *But there are instances of API calls that modify the DG that don't seem to play nicely with the {{{MDGModifier}}} ^^([[MFnMesh.setVertexColors()|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_mesh.html#7394a3ef2fb9663c11018447270f1e33]] is an example of one that, while giving an arg to pass in a {{{MDGModifier}}}, seems to have no effect)^^. In that case you need to track the before & after states of the DG when the command executes and manually author code to set the state back when undone. This method is obviously, harder. Pseudo-code for each is listed here: ''Easy Method'', example using a {{{MDGModifier}}} to handle doing, and undoing. In this case we call to some fictitious mel {{{awesomeCommand}}} that will change the DG in some way. But you could have used any of the other methods on the {{{MDGModifier}}} to make changes as well. {{{ import maya.OpenMaya as om import maya.OpenMayaMPx as ompx class Eggs(ompx.MPxCommand): def __init__(self): ompx.MPxCommand.__init__(self) # Create the MDGModifier that will execute and undo our changes: self.dgMod = om.MDGModifier() def doIt(self): # This example registers a mel command to be # executed. It stores the change to be executed # later, by the dgMod.doIt() and dgMod.undoIt() methods. self.dgMod.commandToExecute("awesomeCommand") # Return the method that does the work: return self.redoIt() def redoIt(self): # Here the MDGModifier executes the command: return self.dgMod.doIt() def undoIt(self): # Here the MDGModifier 'undoes' the command: return self.dgMod.undoIt() def isUndoable(self): return True }}} ''Hard method'', example *not* using a {{{MDGModifier}}}. Extra custom methods are added to query and set the before\after states. {{{ import maya.OpenMayaMPx as ompx class Spam(ompx.MPxCommand): # Superclass overidden methods: def __init__(self): ompx.MPxCommand.__init__(self) def doIt(self): # Get the current (will be 'previous' when undone) state: self.prevValue = self.getCurrentState() # Define what the new state should be: self.newValue = self.getNewState() return self.redoIt() def redoIt(self): # Do work to apply the new state. self.action(self.newValue) def undoIt(self): # Do work to apply the previous state. self.action(self.prevValue) def isUndoable(self): return True # Custom methods, fill in with your own code. def getCurrentState(self): # Return the current\previous state of things pass def getNewState(self): # Return the new\updated state of things pass def action(self, state): # Do the work on the passed in state value, whether it's the previous # state, or the new state. pass }}} !!Practical Example The below example is a fully-functional "easy version" from above: We author a scripted plugin that creates a command that will find all nodes with duplicate names in the scene, and rename them to have unique names. And, you can undo the operation of course. Additionally (just for additional example) it does one other important thing: It ''returns a list of strings'' of the new names, using {{{OpenMayaMPx.MPxCommand.setResults}}}. The key magic is managing all changes to the DG through a [[MDgModifier|http://download.autodesk.com/us/maya/2010help/API/class_m_d_g_modifier.html]]. You're also required to implement and override the [[MPxCommand|http://download.autodesk.com/us/maya/2010help/API/class_m_px_command.html]] methods {{{undoIt()}}}, {{{redoIt()}}}, and {{{isUndoable()}}}. Also note the special return value from {{{doIt()}}}. {{{ # spRenameDupesCmd.py import re import maya.cmds as mc import maya.OpenMaya as om import maya.OpenMayaMPx as ompx # Define what our command's name is. Prefixing with 'k' is old-skool Hungarian-notation # convention for defining something as a constant. In Python this is usually done with # all caps, but this makes it more consistent with Maya c++ plugin code. kPluginCmdName= "renameDupes" # ----------------------------------- # Plugin code # We're building a *command* (rather than say, a DAG node), so we # instance the MPxCommand object: class RenameDupesCmd(ompx.MPxCommand): """ Rename all duplicate nodes in the scene. Return a list of the newly named nodes, and select them upon completion. """ # plugin initializer: def __init__(self): # initalize our superclass: ompx.MPxCommand.__init__(self) # The key to getting Maya to undo is to manage it all through the # MDGModifier class: self.dgMod = om.MDGModifier() # Keep track of the things we want to return: self.returnList = [] def doIt(self, argList): # Keep track of the nodes we rename, so they can be later picked: picker = [] # DG nodes always have unique names, since they're not parened. So we only need # to iterate over the DAG. dagIterator = om.MItDag() # MItDag while not dagIterator.isDone(): currentItem = dagIterator.currentItem() # MObject currentItemFunc = om.MFnDependencyNode(currentItem) # MFnDependencyNode # If the object doesn't have a unique name, and if it's not from a # referenced file, and if it's not 'locked', then rename it: if not currentItemFunc.hasUniqueName() \ and not currentItemFunc.isFromReferencedFile() \ and not currentItemFunc.isLocked(): # Generate a name for the node that is it's leaf name, with no numbers # on the end, with the addition of the hash char, which will cause the # new name to have an incremented number: fullname = dagIterator.fullPathName() leaf = fullname.split('|')[-1] endNum = re.findall('[0-9]+$', leaf)

# These calls to the dgMod only store the change for later execution,
# they don't actually do the change now.
if len(endNum):
noNum = leaf[:-len(endNum[0])]+"#"
self.dgMod.renameNode(currentItem, noNum)
else:
self.dgMod.renameNode(currentItem, '%s#'%leaf)

# Get the new name, and add it to our list:
dPath = om.MDagPath()
om.MDagPath.getAPathTo(currentItem, dPath)
picker.append(dPath.fullPathName())
# Add the renamed item to our return list:
self.returnList.append(dPath.fullPathName())
dagIterator.next()

if len(picker):
self.displayInfo('Renamed %s node(s)'%len(picker))
# We use a mel command here, rather than the API.  Why not?
mc.select(picker)
else:
self.displayInfo('No duplicate nodes to rename')

# This tells the command what to return upon completion:
self.setResult(self.returnList)
# Required to support undoing:
return self.redoIt()

def isUndoable(self):
return True

def undoIt(self):
# Undo any renaming previously done.
return self.dgMod.undoIt()

def redoIt(self):
# Actually do the renaming.
return self.dgMod.doIt()

# 'Creator Function' needs to return a pointer new instance of this type of class,
# based on how the c++ code works.
# As you can see, the OpenMayaMPx module has it's own functions (for which
# I can find no online documentation).
@classmethod
def cmdCreator(cls):
return ompx.asMPxPtr(cls())

# -----------------------------------
# Plugin registration\degregistration block
# initializePlugin & uninitializePlugin are *required functions*

def initializePlugin(mobject):
# create a MFnPlugin
mfnPlugin = ompx.MFnPlugin(mobject)
try:
# Try to register our plug by passing in the kPluginCmdName, and the command creator:
# we use the '.registerCommand()' method since we're trying to build a
# command.  Other plugin types use different registration functions.  The
# args do differ, check docs.
mfnPlugin.registerCommand(kPluginCmdName, RenameDupesCmd.cmdCreator)
except Exception:
om.MGlobal.displayError("\nRenameDupesCmd registration failed\n")

def uninitializePlugin(mobject):
# create a MFnPlugin
mfnPlugin = ompx.MFnPlugin(mobject)
try:
# Try to deregister our plug by passing in the kPluginCmdName, and the command creator:
mfnPlugin.deregisterCommand(kPluginCmdName)
except Exception:
om.MGlobal.displayError("\nRenameDupesCmd deregistration failed\n")
}}}
After this is loaded in the plugin manager (see [[How can I load \ unload a Python scripted plugin?]]), you should be able to run the comnmand in either mel or Python (and capture the return if you want to):
{{{
import maya.cmds as mc
mc.renameDupes()
# Renamed 2 node(s) #
}}}
http://packages.python.org/MRV/
*"MRV is a multi-platform python development environment to ease rapid development of maintainable, reliable and high-performance code to be used in and around Autodesk Maya."
<<gradient horiz #ddddff  #ffffff  >>''WHAT IS IT?''
*This page is all about how to do things in Maya using its scripting language "mel" (Maya Embedded Language). And in addition to that "elf" (mel's "Extended Layer Format"), for UI creation.  Starting with Maya v8.5, I've been adding [[Python|http://www.python.org]] examples as well, since you can now script with Python //in// Maya.  Starting with Maya 2010, I finally got around to teaching myself the ~OpenMaya API, so you'll see subjects for that as well.
*This page mainly lists code samples, and "how-to's" with mel.  There are no "scripts" for download.  The purpose of this page is to be a resource for creating mel procedures and scripts.
*More info on Maya can be found in the [[Maya Links]] section.
*//This page used to be called ''"How to find stuff using mel"'' on other Wiki's://
**[[www.openwiki.com|http://www.openwiki.com/ow.asp?How+to+find+stuff+using+mel]] (which appears to be down half the time...) & [[warpcat.pbwiki.com|http://warpcat.pbwiki.com/HowToFindStuffUsingMel]] are some past sites.
''WHAT IT ISN'T:''
*Instructions on //how// to script\program. I'm presuming you already know a bit of that. But since there are plenty of examples listed, they may help.
''HISTORY:''
*This page started //years// ago (2000?) as a personal web page with a bunch of random thoughts as I learned mel. So a lot of these notes are from the gamut of versions... 1.0 through currently, >insert current version here<. You will see some pretty simple things listed, and some more complex things as well. I've thought about nixing the simple stuff, but for others that are learning, that would be counterproductive.
*I have posted it as a Wiki primarily because they're so easy to edit, I can add stuff very quickly while in development, from work, home, or off-site.  I'm currently using [[TiddlyWiki|http://tiddlywiki.com/]] due to the fact it's so easy to search (based on the Tags), and update (since I only have to work on one tiddler at a time, rather than the whole page).  Only thing I don't like is you can't add comments :(
''DISCLAIMER''
*I can't be blamed for anything misrepresented on this page! If it doesn't work, no finger-waving my direction.
*Since I work on a Windows system, the majority of the command line stuff I call out to is Win-centric. If you're using Lunix\Unix\OSX etc, I'm fairly confident those args won't work.... (replace with what is appropriate for your OS)
*@@You are free to use any of this information  in your personal or professional work.  I only ask that you give me credit where credit is due.@@ : [[Copyright Information]].
''CONTRIBUTE YOUR BRAIN:''
*If you'd like to add something to this page, please [[email me|WarpCat]] with your addition, and I'll add it in if appropriate, thanks!
*I give credit to those I get info from, whenever possible.
''TAKE IT WITH YOU''
*Since this is a tiddlywiki, it's a 'self contained' wiki.  No servers required to run it, no other installs needed (other than a valid web browser).  Using the //right column// you can download this file (it's only one file), and run it off any other location (memory-stick, cd, hard drive, another web site, etc).  Of course it won't update if you do that, so keep checking back on a regular basis.
----
And if you like how this TiddlyWiki works, check out the home page:
*http://tiddlywiki.com/   -- download TiddlyWiki
*http://tiddlyspot.com/  -- Get your TiddlyWiki hosted online for free (what you're using right now)
All of these will open the documentation in a web browser.
{{{
# Python code
import maya.cmds as mc

# show Python docs for xform:
mc.help('xform', language='python', doc=True)
# show mel docs for ls:
mc.help('ls', language='mel', doc=True)

# show the global documentation for mel:
mc.help(documentation=True, language='mel')
# show the global documentation for Python:
mc.help(documentation=True, language='python')

# show the global documentation for the API:
mc.showHelp("API/main.html", docs=True)

# show the global documentation for node types:
mc.showHelp("Nodes/index.html", docs=True)
}}}
When you access the Maya menu command here:
*Skin -> Edit Smooth Skin -> Paint Skin Weights Tool [Options]
What code does it execute?

That menu command calls to this {{{runTimeCommand}}}:
{{{
ArtPaintSkinWeightsToolOptions;
}}}
Which in turn is a wrapper for this command:
{{{
artAttrSkinToolScript 3;
}}}
Which is a global procedure called to in this script (on Vista 64):
{{{
C:\Program Files\Autodesk\Maya<version>\scripts\others\artAttrSkinToolScript.mel
}}}
----
The code that generates the tool options in the Attribute Editor lives here:
{{{
C:\Program Files\Autodesk\Maya2013\scripts\others\artAttrSkinProperties.mel
}}}
Below are a list of //all// the subjects (tiddlers) in the wiki.  Note that there will be ones for site maintenance etc, that should be disregarded.
----
<<list all>>
What are the current selected animation layers?
{{{
// global string array:
print $gSelectedAnimLayers; }}} You can also use these mel procs (living in {{{layerEditor.mel}}}) to both find the selected anim layer, and pick the contents (this is executed by 'Layers -> Select Objects'): {{{ string$lLayers[] = getSelectedAnimLayer("AnimLayerTab");
layerEditorSelectObjectAnimLayer($lLayers); }}} All {{{getSelectedAnimLayer()}}} is really doing is this: {{{ string$list[] = treeView -query -selectItem ("AnimLayerTabanimLayerEditor");
}}}
----
Pop the animLayer editor into it's own window:
{{{
openFloatingAnimLayerEditor();
}}}
Use {{{createAnimLayerEditor(string $parentLayout, string$toolName )}}} To put it into a UI of your choosing.
----
Delete empty animLayers:
{{{
deleteEmptyAnimLayers();
}}}
----
How can I highlight the root animation layer (by default, named {{{BaseAnimation}}}) and no others?
{{{
string $rootLayer = animLayer -query -root; if(size($rootLayer)){
string $animLayers[] = ls -type "animLayer"; for($i=0;$i<size($animLayers);$i++){ animLayerEditorOnSelect($animLayers[$i], 0); // From layerEditor.mel } animLayerEditorOnSelect($rootLayer, 1);
}
}}}
----
Commands:
*{{{animLayer}}}
----
Where is the anim layer mel code at?
{{{
\Autodesk\Maya20XX\scripts\startup\layerEditor.mel
\Autodesk\Maya20XX\scripts\others\performAnimLayerAddObjects.mel
}}}
----
How is the UI structured?
*The 'Layer Editor' ui in the Channel Box is managed by a form Layout.
*The section below the buttons is a {{{treeView}}} control
----
How are new anim layers made when you press the button?
* A 'Run Time Command' called {{{SelectedAnimLayer}}} is executed, which calls to the global proc {{{layerEditorCreateAnimLayer( true, false)}}} (which lives in {{{layerEditor.mel}}}).
*This in turn runs the {{{animLayer}}} command which physically builds the layer.


Some links:
*http://www.akeric.com/blog/?p=1463 (my own blog)
*http://zoomy.net/2009/07/26/basic-arduino-to-maya-communication/
This is a scratchpad of info as I learn more about this subject.  A lot of this is just pulled directly from the Maya docs.
More notes over on [[API: basics]]
Official online examples here: [[API : Example Code]]
Or you can find examples on your local drive:
{{{
C:\Program Files\Autodesk\Maya20XX\devkit\plug-ins\scripted\*.py
}}}
----
The [[Maya Learning Channel|http://www.youtube.com/user/MayaHowTos/videos?view=0]] Youtube page has a growing series of videos as well:
*[[Loading and executing a Python plug-in in Maya|http://www.youtube.com/watch?v=Wf03mSCdh-Q]].
*[[Creating a Python command plug-in - Part 1: Undo and redo|http://www.youtube.com/watch?v=BZyXe3MhEyI&list=PL2611366C5C04BF9B&index=2]]
*[[Creating a Python command plug-in - Part 2: Custom flags|http://www.youtube.com/watch?v=v1d8fCtIROI&feature=youtube_gdata]]
----
Collection of simple example scripted plugins I've been authoring for the wiki can be shown by clicking on this tag:
*[[scripted plugin]]
----
Notes:
*May be good to prefix all scripted plugin .py files with something... like "sp", so you know they're different from regulard Python scripts?  Scripted Plugins can be loaded in the Maya plugin manager, regular Python scripts can't.
----
If you have Autodesk gold support, you can access their podcasts [[here|http://subscription.autodesk.com/sp/servlet/elearning/course?catID=11484791&cfID=Autodesk+Maya&siteID=11564774]].  There are several called (such as) "API & Game Dev I" and  "API & Game Dev II" by Nathan Martz, lead programmer over at Double Fine Productions, that cover a lot of the API basics (starting with the second video).
----
Writing a scripted plug-in requires the definition of some specialized functions within the plug-in. All scripted plug-in must:
*Define {{{initializePlugin()}}} and {{{uninitializePlugin()}}} entry and exit functions.
**Register and unregister the proxy class within these entry points.
*Implement a creator function (arbitrarily named, but something like {{{creator()}}} is probably a good idea).
*Properly initialize the plugin proxy class via the {{{__init__()}}} method.
Depending on the type of plugin you're authoring, there will be other required functions (an 'initializer' in the case of node creation) or proxy class methods ({{{doIt()}}} in the case of a command, {{{compute()}}} in the case of a node, etc).
----
Plugins have different 'flavors', or classes.
Plugins have different categories.  All subclasses of the {{{maya.OpenMayaMPx}}} module.  It should be noted that this module has functions the subclasses can inherit (like {{{asMPxPtr}}} for example), but I can find no online documentation for the {{{OpenMayaMPx}}} specifically.
>[[Docs for all plugin classes|http://download.autodesk.com/us/maya/2011help/API/group___m_px.html]]
>In the plugin class's documentation, the sections listed as "__Public Member Functions__" are the inherited superclass methods at your disposal when writing your own plugins.
*{{{maya.OpenMayaMPx}}}
**{{{MPxCommand}}} : make custom mel commands.
***http://download.autodesk.com/us/maya/2011help/API/class_m_px_command.html
***Can be created to run in {{{creation}}}, {{{query}}}, and {{{edit}}} modes.
**{{{MPxFileTranslatorCommand}}} : custom file format import/export, read/write.  These interface with Maya's UI, allowing you to select the custom file types in file browsers, etc...
***http://download.autodesk.com/us/maya/2011help/API/class_m_px_file_translator.html
**{{{MPxNode}}} : For making custom DG nodes.
***http://download.autodesk.com/us/maya/2011help/API/class_m_px_node.html
**{{{MPxLocator}}} : A type of {{{MPxNode}}} for custom drawing
***http://download.autodesk.com/us/maya/2009help/API/class_m_px_locator_node.html
**{{{MPXContext}}} : (and {{{ContextCreatorCmd}}}) : For handling mouse\user inputs
***http://download.autodesk.com/us/maya/2011help/API/class_m_px_context.html
** many more!
Each category has similar basic structure, but with extra rules.
----
''Top level overview of plugin structure:''
*Plugin class/classes implements core functionality.
**Derives from an ~MPx class.  Each type of plugin is implemented as python class that will be derived from.
**Implements functionality by overriding interface functions.  Maya gives us a template, and we override that template based on our needs.
**Specific methods needing implementation based on plugin type:
***'doIt' method:
****What actually does the work in the instance of the plugin //command// object.
***'compute' method:
****What actually does the work in the instance of the plugin //node// object.
***Different plugins have other required method implementations.
*Special functions (I author these as classmethods):
**Creator Function:
***Returns a new instance of the class
***Needs to be one per plugin class being authored.
**Syntax Function:
***When creating commands that can accept flags, this special function needs to be setup to create them.
*Registration/Deregistration:
**If multiple plugins classes are being authored in the same Python module, they can share the same registration\deregistration block
**Tells Maya: about new plugins, their types, hooks needed to instance them.
Common Python plugin modules:
{{{
# All plugin functionality lives here:
import maya.OpenMayaMPx as ompx
}}}
Presuming you have a selected hierarchy like below, how can you get back all the 'parent' nodes.  Meaning, any transform node that has a child?
*group1
**some poly mesh A
**some poly mesh B
***some poly mesh C
*group2
**some poly meshD
{{{
string $selObjects[] = ls -sl; string$parents[] = listRelatives -p $selObjects;$parents= stringArrayRemoveDuplicates $parents; print$parents;
//group1
//group2
//some poly mesh B
}}}
*Thanks to a post from Johan Ramstrom
Also see:
[[Based on a selection of nodes, how can I return only the 'groups'?]]
Presuming you have a selected hierarchy like below, how can you get back just the "group" nodes.  Meaning, transforms with no shapes? (just the group# nodes)
*group1
**some poly mesh A
**some poly mesh B
***some poly mesh C
*group2
**some poly meshD
{{{
string $selObjects[] = ls -sl; string$groups[]; clear $groups; for($i=0;$i<size($selObjects);$i++) { string$shapes[] = listRelatives -s $selObjects[$i];
if(size($shapes)==0)$groups[size($groups)] =$selObjects[$i]; } print$groups;
// group1
// group2
}}}
Also see:
[[Based on a selection of nodes, how can I return back all the 'parents'?]]
{{{lsThroughFilter}}}
For example, find all the default shading groups and materials in a new scene:
{{{
string $nodes[] = lsThroughFilter DefaultMaterialsFilter; // Result: lambert1 particleCloud1 // }}} Also see: *[[How can I query all the default itemFilters in Maya?]] *[[How can I use itemFilter or itemFilterAttr?]] This subject is about batching Maya files in a session of Maya //other than the one that is currently open//, via Python. It's one thing to (via the //currently opened Maya//) loop over a list of files opening them in succession and executing code. But if you want to launch //external// Maya's in batch mode (so as to not disturb your current Maya session), open a file, and execute code on that file (all in Python), it's a different story. To batch file via Maya with //mel//, it's pretty straightforward via {{{maya.exe}}}: {{{ > maya -batch -file someMayaFile.ma -command someMelProc }}} There is {{{mayapy.exe}}} as well, but this doesn't launch Maya: It launches Maya's version of Python. It is a Maya mirror of {{{python.exe}}}. However, once it has been launched, Maya itself can be imported in as a Python module, and then batching can take place. Method A explains this below. ---- Different methods below. I came up with Method C first, got suggested Method B, then sort of combined the two to come up with Method A. !Method A The example below will batch over all the passed in Maya files, and saves a new group node in them as proof it worked. Some of the magic is using {{{subprocess.call}}} to call to {{{mayapy.exe}}}, and passing in an additional argument that is the name of the current file to work on. Another bit of trickery is having the module do double-duty: When executed in //GUI Maya// the user runs its main() function to start it up, but when it is called to via {{{mayapy.exe}}} putting it in 'batch mode', the top & bottom section '{{{if __name__ == "__main__":}}}' are executed as well which both imports {{{maya.standalone}}} (thus now physically has Maya running inside of {{{mayapy.exe}}}) and calls to the {{{batchOperation()}}} function, which can then query, via {{{sys.argv}}} the command-line arguments passed in (which are the names of the files to batch over). I have a feeling that's not terribly clear. I hope the code makes more sense ;) I'll label each thing has it's executed so you can see the data flow. GUI mode starts with GUI A and ends with GUI D, which then starts BATCH A and ends with BATCH E. {{{ # batchTest.py import subprocess if __name__ == "__main__": # If we're in 'batch' mode, it means that mayapy.exe is running, # so load maya.standalone into it: import maya.standalone maya.standalone.initialize(name='python') # If you have a userSetup.py that is needed for happy Maya execution, call # to it here: import userSetup userSetup.main() import maya.cmds as mc def main(paths): """ Launched in the gui version of Maya, manually, or via some other script. Parameters : paths : string\list : Path(s) to Maya files to batch over. """ if not isinstance(paths, list): paths = [paths] args = ['mayapy', __file__, '-'] args.extend(paths) # This fires off another version of Maya in 'batch' mode, calling back to # this code, executing the 'batch only' parts. Luckily, the current version # of Maya calling it waits for the other version to complete doing it's thing # before continuing on in this code... subprocess.call(args) def batchOperation(): """ The work done by the batch: This has been called to while Maya is in batch mode, via the subprocess.call() func in the main() function: Because of this, we capture the incoming args via sys.argv. A single instance of Maya is launched, and then all the files are batched over in that instance, and processed """ # The sys.argv vals match the subprocess call above # sys.argv[0] : The path to this module ( __file__ ) # sys.argv[1] : '-' # sys.argv[2] + : Path(s) to the files to batch over paths = sys.argv[2:] # If there is an error, the shell will just disappear. So we wrap it in a # try\except, allowing it to stay open to help track down bugs. try: mc.file(prompt=False) for fil in paths: mc.file(fil, force=True, open=True) mc.group(empty=True, name='I_was_made_in_batch_mode', world=True) mc.file(force=True, save=True) except Exception, e: print "Exception:", e raw_input("Encountered an exception, see above. Press Enter to exit...") finally: mc.file(prompt=True) # When called to via batch mode, run this code. This line must come after the # function it's calling. if __name__ == "__main__": batchOperation() }}} To run in Maya: {{{ import batchTest batchTest.main(['c:/temp/myFileA.ma', 'c:/temp/myFileB.ma']) }}} You should see a shell pop up for the new instance of Maya that is launched (via mayapy.exe), and then each path is opened and batch processed in that shell. The gui version of Maya will wait until completion of the batch to continue on with its code. !Method B: This example was given to me by Keir Rice. Thanks Keir! Make a batch script: {{{batchTest.bat}}} . It runs {{{mayapy.exe}}}, which is //Maya's// version of Python. {{{ REM Launcher batch file: batchTest.bat "%ProgramFiles%\Autodesk\Maya2010\bin\mayapy.exe" "c:\temp\test.py" }}} *Add {{{pause}}} to the end of the batch script if you want the shell to stay open upon completion. Then make the python module it calls to: {{{ # python script to run: c:\temp\test.py import maya.cmds def TestFunction(): print maya.cmds.about(version=True) if __name__ == "__main__": import maya.standalone maya.standalone.initialize(name='python') TestFunction() }}} Finally, run the bat script. Results should be printed in the shell. !Method C: This is one I came up with before I knew about Method A or B, above. Key Components: (the file-names aren't important, just illustrating the example) *{{{mainModule.py}}} : This is the Python module that orchestrates the whole thing. It can be executed from Maya, or the command line. *{{{melScript.mel}}} : This is a 'wrapper' script that our batch operation will call to. It in turn, via the mel {{{python}}} command, will execute the Python code we want to have effect the scene files. *{{{pythonModule.py}}} : This is the Python module that our mel script calls to. In this example, it executes the {{{main()}}} function inside. ---- Here is a bit of code from {{{mainModule.py}}}. By calling to {{{subprocess.call()}}}, we're able to launch Maya in batch mode on a specific file, executing our wrapper mel command on it: http://docs.python.org/library/subprocess.html {{{ # mainModule.py import subprocess subprocess.call(['maya', '-batch', '-file', 'c:\\myFile.ma', '-command', 'melScript']) }}} ---- This is the guts of our wrapper mel script. All it does is call to the Python code we care about: {{{ // melScript.mel global proc melScript(){ python("import pythonModule"); python("pythonModule.main()"); } }}} ---- {{{pythonModule.py}}} and its {{{main()}}} function can prettymuch do whatever you'd like to that scene file: {{{ # pythonModule.py import maya.cmds as mc def main(): # do stuff! }}}  Ran across this post describing how to code in-between blendshapes,... and the absolute chaos that is needed to pull it off: http://forums.cgsociety.org/showthread.php?t=1079399 <<gradient horiz #ffffff #ddddff #8888ff >> The mel wiki blog. *[[2010 01 20]] - Added the HARDWARE category. *[[2010 01 13]] - Added the INFO category. *[[2009 05 13]] - Added API category *[[2008 11 19]] - Updated Python tagging *[[2008 08 14]] - Created the Mel Wiki Guest Book *[[2008 07 05]] - A new mel tiddlywiki online! *[[2008 06 08]] - Blog about my new blog (blog blog blog) *[[2008 05 21]] - tiddlywiki upgraded *[[2008 05 20]] - Python Wiki! *[[2008 03 31]] - More Processing. *[[2008 03 11]] - Added 'Other Links' *[[2008 03 07]] - Added the TROUBLESHOOTING category. *[[2008 02 18]] - Processing! *[[2008 01 29]] - Added [[All Subjects]] tiddler. *[[2008 01 08]] - New feature: [[Visual Guide of UI Controls]] *[[2008 01 07]] - Tiddlyspot back up. And... robots! *[[2008 01 04]] - rain! Tiddlyspot down... *[[2008 01 02]] - New [[PYTHON]] category, update wiki UI formatting. *[[2007 04 27]] - mel wiki is born Where can you download Maya's 'bonus tools'? http://area.autodesk.com/bonus_tools  The below code was originally on [[Brian Ewerts 'match' web page|http://ewertb.soundlinker.com/mel/mel.094.htm]], which went down for a while. It appears to be back up! But, I've left this info in here. http://ewertb.soundlinker.com/maya.htm *Strip component {{{ string$node = "pCube1.f[2]";
string $no_component = match "^[^\.]*"$node;
// Result: "pCube1" //
}}}
*Extract component or attribute, with '.'
{{{
string $node = "pCube1.f[2]"; string$component = match "\\..*" $node; // Result: ".f[2]" // string$nodeAttr = "blinn1.color";
string $attrName = match "\\..*"$nodeAttr;
// Result: ".color" //
}}}
*Extract attribute name, without '.'
{{{
string $node = "pCube1.f[2]"; string$component = substitute "^[^.]*\\." $node ""; // Result: "f[2]" // string$nodeAttr = "blinn1.color";
string $attrName = substitute "^[^.]*\\."$nodeAttr "";
// Result: "color" //
}}}
*Extract parent UI control from full path
{{{
string $uiControl = "OptionBoxWindow|formLayout52|formLayout55|button6"; string$uiParent = substitute "|[^|]*$"$uiControl "";
// Result: OptionBoxWindow|formLayout52|formLayout55 //
}}}
*Strip trailing CR, if any. This is useful when processing text input read from a file using 'fgetline'. (or you could just use the 'strip' command, but the concept is important)
{{{
string $input = "line\n";$string $line = match "^[^(\r\n)]*"$input;
// Result: "line" //
}}}
*Extract directory from path Note that this leaves a trailing slash. This is typically desired, as it makes it easy to simply append a filename, and the slash is required for the ‘getFileList?’ command to return anything useful.
{{{
string $path = "C:/AW/Maya5.0/bin/maya.exe"; string$dir = match "^.*/" $path; // Result: "C:/AW/Maya5.0/bin/" }}} *Extract file from path {{{ string$path = "C:/AW/Maya5.0/bin/maya.exe";
string $filepart = match "[^/\\]*$" $path; // Result: "maya.exe" }}} *Strip numeric suffix {{{ string$node = "pCube1|pCubeShape223";
string $noSuffix = match ".*[^0-9]"$node;
// Result: "pCube1|pCubeShape"
}}}
*Extract numeric suffix
{{{
string $node = "pCube1|pCubeShape223"; string$suffix = match "[0-9]+$"$node;
// Result: "223" //
}}}
*Extract short name of DAG or control path
{{{
string $dagPath = "pCube1|pCubeShape223"; string$shortName = match "[^|]*$"$dagPath;
// Result: pCubeShape223 //
}}}
Pi is the ratio of the circumference of a circle to its diameter, approximately {{{3.14159}}}.
So if you wanted to calculate this yourself:
{{{
# Python code:

# diameter is circumference / pi:
diameter = 5.0

# circumference is pi * diameter:
circumference = 15.7079632679

# so:
pi = circumference/diameter
# 3.14159265359
}}}
As of Maya 2008, when you hit {{{tab}}} in the Python Script Editor, it adds an 'actual tab' ({{{\t}}}), that is '8 spaces' long.  Python's [[PEP8 Style Guide|http://www.python.org/dev/peps/pep-0008/]] says that tabs in general should be avoided (but if you have to use them, they should be '4 spaces' in length).  You should be using '4 spaces' in place of tabs (most external IDE's have the ability to insert spaces instead of tabs when the tab button is pressed).  So the Script Editor has this //completely wrong//.

After searching online, and pinging various user groups, this appears to be a fix value.  In fact, this was reported as a bug to Autodesk in Maya8.5, and I'm told it's //still// not fixed in Maya2009.  :-(  Another reason to use an external IDE.
When you execute a playblast via its UI, you can open a 'Video Compression' sub-ui allowing you to adjust the compression settings.  The {{{playblast}}} command has {{{compression}}} arg you can pass a string value to that, will, from the docs:
>Specify the compression to use for the movie file. On Unix, valid values are "mvc1", "mvc2", "jpeg", "rle", "none". (Default is "mvc2".)  On Windows, if the argument is an empty string ("") a dialog comes up allowing the user to set the codec, data rate, keyframing, compression quality, and codec settings. (This dialog will also come up with playblast -options.) Use of any other string will utilize the codec that was previously set using the dialog.
So on Unix, you can specify values.  On Windows, if you pass it an empty string, it will pop up a dialog box letting you set values.  And, if you "use any other string" will "use the previous setting".

So this tells me that ''NO, you can NOT specify compression options via mel''.  Which kind of sucks.

Searching the internets, it appears that all the other brains have come to the same conclusion.  There are {{{optionVar}}}s that store certain playblast values, but changing them seems to have no effect on the final product, or causes errors.
This tool has actually been around for some time, and while I've never used it, my friends have and vouched for it's abilities:

[[JoystickServer|http://www.geocities.com/jlimperials/realtime.html]] by Jorge Imperial
Download from Highend3d.com [[here|http://www.highend3d.com/f/1086.html?sheet=bg4]]
It basically turns your joystick into a mocap device, which Maya can then interface with.
[img[http://static.highend3d.com/downloadsimages/1086/screen1.jpg]]
Use for finding attribute information based on a node class. Meaning, can find attributes on "transform" nodes, on "joint" nodes, etc. Can't be used to query info on nodes that you specify by name, like attributeQuery does.
*list internal attrs
*list hidden attrs
*list multi attrs
*list leaf attrs
*list writeable attrs
*list boolean attrs
*list enumerated attrs
*list "UI friendly" attr names rather than Maya Ascii names.
On an individual attribute on an individual node, use to find:
*If the attribute exists
*If it is a mulit-attribute
*find the range of its value
*find any "sibling" attributes
*find its parent attribute
*find any children attributes
*and several more....
{{{
// mel
int $exists = attributeQuery -ex -n nodeName attrName; }}} {{{ # Python import maya.cmds exists = mc.attributeQuery('attrName', node='nodeName', exists=True) }}} Find\set the current LINEAR (meters, feet, etc.) units, ANGULAR (degrees, radians) units, or FRAME RATE (film, video, etc.) that Maya uses. Given an object, will return lists of: *Readable attrs *Writable attrs *Array attrs *Visible attrs *Connectable attrs *Keyable attrs *Locked\unlocked attrs *User defined attrs *And many others.... *List both "source" and "destination" connections: {{{ // this will only return object names thaat connect to your object: listConnections "object"; // this will list object.attr namess that connect to your object: listConnections -p 1 "object"; // this will list in pairs, your object.attr's and the connecting object.attr's: listConnections -p 1 -c 1 "object"; // this will list in pairs, your specifieed object.attr, and it's connecting object.attr's: listConnections -p 1 -c 1 "object.tx"; }}} *List "source" or upstream connections only: {{{ // this will only return object names: listConnections -s 1 -d 0 "object"; // this will list object.attr names of soource connections to your object: listConnections -s 1 -d 0 -p 1 "object"; // this will list in pairs, your object.attr's connecting to the source's object.attr's: listConnections -s 1 -d 0 -p 1 -c 1 "object"; // this will list in pairs, your specified object.attr, and it's connecting source object.attr's: listConnections -s 1 -d 0 -p 1 -c 1 "object.tx"; }}} *List "destination" or downstream connections only: {{{ // this will only return object names: listConnections -s 0 -d 1 "object"; // this will list object.attr names of deestination connections to your object: listConnections -s 0 -d 1 -p 1 "object"; // this will list in pairs, your object.attr's and connecting destination object.attr's: listConnections -s 0 -d 1 -p 1 -c 1 "object"; // this will list in pairs, your specified object.attr, and its connecting destination object.attr's: listConnections -s 0 -d 1 -p 1 -c 1 "object.tx"; }}} *Important: Adding an attribute value to any of the queries filters the query to only check only on that object.attr. *The "-t" "type" flag can also be used to query connections to only certain types of nodes. Very handy. Query or set the current frame range. Also: Query\set: playback speed, frames rate, and loopability. Maya8 and later: Set the max playback speed  {{{polyEvaluate}}} is a really versatile command. Things it can do: *For a whole polygonal object, or just a component selection, return the number of: **vertex **edge **face **uv coordinate **triangle **shell *Bounding box data: **For the given object in 3d space, or it's uv's in 2d space. **For the selected components in 3d space, or for the selected uv's in 2d space. **The surface area of the faces in worldspace, or local space ---- Also see: *[[Command: polyInfo]]  {{{polyInfo}}} aids in finding dependencies between polygonal components: *How can I find the specific poly components connected to another poly component? **faces that share the specified edge **faces that share the specified vertex **edges defining a face **vertices defining a face **vertices defining an edge **Edges connected to a vertex *Find non-manifold vertices, edges, and lamina faces? *How can I find the "normal" value of face? Example, get a face's normal value: {{{ polyInfo -fn; // however this will return a string that will need to be tokenized. }}} ---- Also see: *[[Command: polyEvaluate]]  ''Commands'': (WIP) *[[commands|Commands]] **__Can accept__ (when executed, depending on the command): ***command [[flags|Flags]] (& flag arguments), command [[arguments|Arguments]] **__Can provide__ (when executed, depending on the command): ***[[return values|Return Values]] ---- *A command is one of the fundamental building blocks that make up mel. *Many commands can have flags listed after them, or arguments, or both, or neither (it depends on the individual command): **Arguments accept variables you pass into them, and expose those variables to the inner-workings of the command. They are like doors that allow external data into a command. **Flags have several different behaviors: Some flags, if present, modify behavior of the command (their presence acts like a boolean switch, on|off), but take no arguments. Other flags accept arguments. **//Usually//, command arguments and flags are optional. Sometimes certain commands require certain arguments. However, if a flag is used, and takes its own arguments, they are required as well. This is one way commands differ from scripted procedures: If a procedure defines an argument, then the argument is always required. And procedures can't be authored with flags. **Command flags are listed first, then command arguments. It is the way of things. Of course if a flag has its own arguments, they're entered immediately after the flag. *Using the below command, it will open a web browser to list all of the Maya commands. {{{-doc}}} is a flag (which takes no arguments), and {{{"index.html?MEL"}}} is an argument to that //command// (it's //not// an argument to the flag). {{{ showHelp -docs "index.html?MEL"; }}} *In the html help, some of the "commands" will have a "''M''" after them. This signifies that in fact they are //not// commands, but mel [[scripts|Scripts]] that ship with Maya. But they lump them in with the commands, since they provide similar functionality. *These [[scripts|Scripts]] behave like commands in the sense they can usually take [[arguments]] (not [[flags]]), and provide [[return values]]. They provide this functionality by having a global procedure defined //inside// the script, with the //same name// as the script (see 'scripts' above). *What is the difference between a command and a script? **A command (to the best of my knowledge) is a 'programmed' bit of code, probably in c++. A //script// on the other hand, is a bunch of commands working together for some other goal. Custom user-made plugins can provide new commands. **{{{xform}}} for example, is a command, and will move objects about. {{{randomMoveAllObjectsInScene.mel}}} could be a script, that mostly likely calls to {{{xform}}} and many other commands, to have a much broader effect on the scene. *Commands can be entered in two different modes: 'command syntax', and 'function syntax'. <<< *__Command Syntax__: In command syntax you can leave off quotation marks around single-word strings and separate arguments & flags with spaces instead of commas: {{{ setAttr mySphere1.translateX 10; move -absolute 1 1 1; // '-absolute' is a flag, '1' is an argument. }}} *__Function Syntax__: In function syntax, commands are treated like functions (procedures): Strings must be enclosed in quotes, and all arguments must have commas between them. Furthermore, any flags must be encased in quotes, turning them into strings, any arguments must be separated with commas. Finally, all the arguments and flags need to be surrounded by parenthesis: {{{ setAttr("mySphere1.translateX", 10); move("-absolute", 1, 1, 1); }}} <<< ''Returning Values:'' *Many commands provide [[return values]]. How you capture the return value of a script, and pass it into a [[variable]] depends on which syntax you're using: **When in __command syntax__, values aren't returned unless you surround the statement with back-ticks \ back-quotes. **When in __function syntax__, values are returned automatically. A back-tick \ back-quote is the key to the left of ''1'': {{{}}} {{{ //Command syntax capturing return values: string$all[] = ls;
string $selected[] = ls -selection; string$onlyJoints[] = ls -type "joint";
}}}
{{{
//Function syntax capturing return values:
string $all[] = ls(); string$selected[] = ls("-selection");
string $onlyJoints[] = ls("-type", "joint"); }}} By using function syntax, it allows you to 'nest' your commands in ways that you can't using command syntax. This isn't to say you //should//, it just means you //can//. :-) See notes [[here|How can I nest my mel commands?]]. (This is all based on a Windows system) First, you need to get some type of com object solution working in Python for Maya: *See my notes here: [[Getting pywin32 working in Maya]] Once you have that package (or something similar) up and running, you can start having Maya talk to Photoshop. Here's a simple example: {{{ # Presuming you have the package installed.... import win32com.client app = win32com.client.Dispatch("Photoshop.Application") # Application psdFile = 'c:/temp/myPrettyPic.psd' document = app.Open(psdFile) # Document # For each layer in the psd: for layerSet in document.LayerSets: # LayerSet in LayerSets, which PS calls 'groups' print layerSet.Name layerSet.Resize(50, 50) layerSet.Translate(128,128) # Some optional fun: #document.ResizeImage(64, 64) #document.Save() }}} How about some docs? The root for all related scripting docs for multiple versions of Photoshop is here: http://www.adobe.com/devnet/photoshop/scripting.html I would recomend taking a look at the "''~VBScript Reference''" for your version of Photoshop, compared to the ~JavaScript or ~AppleScript: The VB seems to more closely match the Python bindings\syntax.  Much of this I have learned from others, we all ride on shoulders of giants. But for what I present as my own work, it's under the below licence: ---- All information on this wiki is under the Apache Licence, v 2.0: {{{ Copyright 2012 Eric Pavey Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. }}} To understand how this licence works see [[this overview|http://developer.kde.org/documentation/licensing/licenses_summary.html]]. But it pretty much means you can use the information on this wiki however you want, but I always appreciate credit where applicable. Starting in Maya 2013, they have a DG Profiler window, allowing you to see how cheap\expensive node evaluation is. Great resource. Official [[Autodesk Youtube vid|http://www.youtube.com/watch?feature=player_embedded&v=4Nly2Q1mRDM]] on its usage. It is created via the script: {{{ C:\Program Files\Autodesk\Maya20XX\scripts\others\dgProfiler.mel }}} The window is partly created via the {{{dgTimerSpreadsheet}}} command (no online docs), which is part of the {{{dgProfiler.mll}}} plugin that ships with Maya. ---- One of the benefits it has is the ability to export the info as .csv data, for usage in Excel. Since I don't use excel too much, here's the overall process for inspecting the data: *Open Excel and import the csv file. *Select the top lettered columns: Double-click on any line in-between them to expand them. *Drag-select the top entries in the "1" row, from "Node Name" to "Dirty Self (ms)". In the "Editing" menu-bar section, click on the "Sort & Filter" button, and choose "Filter". *This will provide a drop-down for each column, allowing you to sort it by different categories. *Finally, for some visual fluff, you can easily create charts\graphs. **For example, drag select the "Node Name" and "Percent of Runtime" columns from top to bottom. **Choose the "Insert" menu, then a graph (like Column -> Stacked Column). **Watch the magic appear on-screen. ---- Talking with Autodesk Support, the terminology used by the DG Profiler is pulled directly from the [[dgtimer command|http://download.autodesk.com/global/docs/maya2013/en_us/Commands/dgtimer.html]], so you can reference those docs for more insight into the values. But here's a brief overview: *Timer types: **self : The time specific to the node and //not// its children. **inclusive : Time //including children// of the node. **count : Number of operations of the given metric on the node. *Metrics : A type of thing being timed. There are more than what are listed below, but this is all the window exposes. **compute : The time spent in the node's compute method. **dirty : The time spent propagating dirtiness on behalf of the node. So given those definitions, this is my take on what the window values mean. Note that the reported values are based on the framerange being sampled, //and// the number of samples. So for example, if you sampled 100 frames 10 times, you'd need to divide all value by 1000 to get the per-frame value. * % of Runtime : Seemingly self-explanatory. Talking to the Autodesk dev, this is calculated as {{{(a node’s self-compute time/sum of the self-compute times) * 100}}} * Number of Computes : Number of calls to the node's compute method. * Compute Self : Time spent in the nodes compute method. * Compute Inclusive : Time spend in the compute method of the node and all the node's children. * Dirty Self : (This isn't shown in the window, but the data is exported) : Time spent 'propagating dirtiness' on behalf of the node. * Dirty Inclusive : Time spent 'propagating dirtiness' on behalf of the node and all its children. Finally, I've confirmed with the Autodesk dev's that there is a bug in the window itself: When it lists "(ms)" next to the values, it should really be "(sec)", since that's what the {{{dgtimer}}} command returns. ---- The below values are based on test I've done over time on different node types. *Number of Computes : per frame *Compute Self & Dirty Self : milliseconds per frame. For clarity, .001 isn't 10ms, it's a //thousand of a millisecond//. Ranges are from high to low. | Node Type | # of Computes | Compute Self | Dirty Self | | | | | | | animCurveTL | 1 | .002 - .001 | 0 | | animCurveTU | 1 | .002 - .001 | .001 | | decomposeMatrix | 1 | .006 | .006 | | ikHandle | .29 | .001 | .006 | | joint | 2 - .58 | .013 - .002 | .007 - .002 | | orientConstraint | .30 | .006 | .002 - .001 | | parentConstraint | 2 - .58 | .019 - .006 | .008 - .002 | | pointConstraint | 1 - .30 | .008 - .002 | .004 - .001 | | transform | 2.98 - .87 | .014 - .003 | .004 - .001 | | unitConversion | 1.0 | .004 - .001 | .002 - .001 | Now that I've been recording these values.... I'm seeing some very odd results: 'Simple' scenes with only a handful no nodes in them with few connections will have much larger compute \ dirty self values, compared to scenes that are much more complex with many more connections. I'm not sure I'm wrapping my head around this yet. ---- ''Secondary animation % of runtime:'' I compared three simple systems for implementing 'secondary' animation on a rig: One setup with 'set driven keys', one setup with an expression, and the other setup with math nodes. Each setup was designed to have a controller node translate & rotate a target node 2x its amount. *Expression: 45.2% *Set Driven Key: 35.8% *Math nodes (two multiplyDivide) : 16.3% The values are based on all evaluated keyframe data, 'unitConversion' nodes, and anything else related to each system. It goes without saying that the math nodes are the clear winner here. But this was based on a simple behavior of a single linear translation: For more complex states,that would require more math nodes, I wonder how they'd hold up against something more general purpose like the Set Driven Key? I expanded on the above test, making the behavior more complex: Now, the target node needs to translate to 2x the controllers height 50% the way through the controllers animation, then on the second half, translate back down to -2x the height. The Set Driven Key system was easy to setup: I just added another set of keyframe data. In the expression, I introduced an if statement, based on the height of the controller. The node system required the creation and connection of several new notes: A total of two multiplyDivide, on condition, and one plusMinusAverage. Surprisingly, the values changed very little: *Expression: 47.7% *Set Driven Key: 31.9% *Math nodes: 20.5% Math nodes are still the clear winner.  This is in Maya 2008: Still trying to figure out what the top history layout is called. *{{{scriptEditorPanel1Window}}} -- window **{{{TearOffPane}}} -- paneLayout ***{{{scriptEditorPanel1}}} -- panel -- This and the next one are a bit confusing, being by the same name... ****{{{scriptEditorPanel1}}} -- scriptedPanel *****{{{formLayout52}}} -- formLayout ******{{{frameLayout10}}} -- frameLayout *******{{{formLayout53}}} -- formLayout ********All the buttons across the top of the Script Editor ******{{{formLayout54}}} *******{{{paneLayout1}}} -- paneLayout ********{{{cmdScrollFieldReporter1}}} -- cmdScrollFieldReporter (the bottom half of the Script Editor. This value is also held in {{{global string$gCommandReporter}}}
********{{{formLayout55}}}
*********{{{tabLayout2}}} -- tabLayout
**********All the current mel and python tabs in the Script Editor
*********{{{tabLayout3}}} -- tabLayout
**********{{{formLayout66}}} -- formLayout
***********{{{textField5}}}  -- textField
***********{{{textScrollList1}}}  -- textScrollList
You can use the {{{cmdScrollFieldExecuter}}} command to create the bottom half of the Script Editor, in a new window.
Mel:
{{{C:/Program Files/Autodesk/Maya2008/scripts/startup/scriptEditorPanel.mel}}}

[[Welcome]]
The more I learn about matrices in Maya, the more ways I find to access, manipulate, and apply them.  Need to write it down to keep my head straight ;)
The below doc is split into these sections:
*Gotcha's
*Docs
*Access
*Manipulation
*Application
!Matrix gotcha's:
*Internally, API matrix translational data is saved in cm in Maya, regardless of what you have the UI set to (inches, etc).  So if you're //not// working in cm, you'll need to convert the cm data to your 'ui units' if using application methods such as {{{setAttr}}}, or if you're extracting and modifying the data before reapplication.
*"Freezing transforms" on a node will screw up where Maya thinks the world matrix position is:  It will no longer return the correct positional values after that.
**If you freeze transforms on a node, it will think the new world matrix is at the location defined by the 'world rotate pivot' minus the 'local rotate pivot'.  Really, it's just the 'world rotate pivot'.
**Often, I need to rebuild the world matrix with correct worldspace positional information, acquired form the {{{pointPosition}}} command querying the world {{{roatePivot}}} of the given node, and re-inserting it back into the matrix (converting to cm first if need be).
* Trying to get the {{{worldInverseMatrix}}} with the above two issues present can be a pain.  To do it, you first need to fixup your worldMatrix with the correct positional values, then execute the {{{inverse()}}} method on it (presuming this is through the API), rather than querying the {{{worldInverseMatrix}}} directly.
*Matrix attributes on nodes like transforms and joints (unless user-created) are output\read only:  You can't use {{{setAttr}}} to change them.
To help keep the code clean, the below examples //aren't going to handle any of that//.  It's your job to modify them and fix-up where you see fit.
!Matrix-related Docs:
(not all of these are discussed below)  There are additional matrix related nodes and commands here: [[Matrix info]]
!!!Python ~OpenMaya API
*Query\Access matrix data:
**[[OpenMaya.MFnDagNode|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_dag_node.html]] : Can be used to return an //local// (not worldspace) {{{MMatrix}}} for the given {{{MDagPath}}}.
***[[OpenMaya.MFnTransform|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_transform.html]] : Can be used to return a {{{MTransformationMatrix}}} for the given {{{MObject}}} or {{{MDagPath}}}.  Note this will be the //local// matrix of the node, not the worldspace matrix.
**[[OpenMaya.MDagPath|http://download.autodesk.com/us/maya/2010help/API/class_m_dag_path.html]] : Can be used to query a world-space (inclusive) or parent-space (exclusive) {{{MMatrix}}}.
**[[OpenMayaUI.M3dView|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m3d_view.html]] : It has a variety of methods ({{{viewToObjectSpace}}}, {{{projectionMatrix}}}, {{{modelViewMatrix}}}) used for getting and transforming matrices (and vectors) based on the camra, between camera-space, object-space,and world-space.
*Matrix data types:
**[[OpenMaya.MMatrix|http://download.autodesk.com/us/maya/2010help/API/class_m_matrix.html]] : Pure matrix data type.
**[[OpenMaya.MFloatMatrix|http://download.autodesk.com/us/maya/2010help/API/class_m_float_matrix.html]] : This is like a {{{MMatrix}}} but stores the internal data as {{{floats}}}, rather than {{{doubles}}}.
**[[OpenMaya.MTransformationMatrix|http://download.autodesk.com/us/maya/2010help/API/class_m_transformation_matrix.html]] : This provides many helper methods for transforming matrix data.  Note you can't access matrix indices individually or do math-operator (like multiplying two {{{MTransformationMatrix}}}'s together).  In both cases need to be converted to {{{MMatrix}}} first.
*Matrix containers:
**[[OpenMaya.MMatrixArray|http://download.autodesk.com/us/maya/2010help/API/class_m_matrix_array.html]] : Not covered here.  An array of {{{MMatrix}}} data.
*Scripted Plugin related matrix data:
**[[OpenMayaMPx.MPxTransformationMatrix|http://download.autodesk.com/us/maya/2010help/API/class_m_px_transformation_matrix.html]] : Not covered here, can be used to create your own custom scripted plugin based {{{matrix}}} nodes.
**[[OpenMaya.MFnMatrixAttribute|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_matrix_attribute.html]] : Not covered here, used to add matrix attributes on custom nodes authored via scripted plugins.  Used inside the 'initializer' function of the scripted plugin.
**[[OpenMaya.MFnMatrixData|http://download.autodesk.com/us/maya/2010help/API/class_m_fn_matrix_data.html]] : Not covered here, used to access matrix data passed to, or generated by a custom node authored via a scripted plugin.  Code used inside the scripted plugin itself.
!!!Python (& mel)  commands:
*[[xform|http://download.autodesk.com/us/maya/2010help/CommandsPython/xform.html]] : Used to query or set matrix data (in a variety of spaces) by returning or passing a list of 16 floats.
*[[getAttr|http://download.autodesk.com/us/maya/2010help/CommandsPython/getAttr.html]] : Used to query the variety of matrix attributes on a node.  Usually returns a list of 16 floats.
*[[dagPose|http://download.autodesk.com/us/maya/2010help/CommandsPython/dagPose.html]] : Used to store and query matrix data in a {{{dagPose}}} //node//. Most commonly used during skinning operations.
*{{{pointMatrixMult}}}   (Mel only)
**This Mel proc returns the multiplication of a point and a matrix as an array of 3 doubles.  It is a wrapper around the {{{pointMatrixMult}}} node, which the script actually creates, modifies, gathers the return value, and then deletes.
**Located: {{{C:/Program Files/Autodesk/Maya<version>>/scripts/others/pointMatrixMult.mel}}}
!!!Mel variables
*[[matrix|http://download.autodesk.com/us/maya/2010help/index.html?url=Arrays_vectors_and_matrices_Matrices.htm,topicNumber=d0e158454]]
!!!Nodes:
*[[dagNode|http://download.autodesk.com/us/maya/2010help/Nodes/dagNode.html]] : Base node type that stores these attributes: {{{matrix}}} (local), {{{inverseMatrix}}}, {{{worldMatrix}}}, {{{worldInverseMatrix}}}, {{{parentMatrix}}}, {{{inverseParentMatrix}}}.
**[[transform|http://download.autodesk.com/us/maya/2010help/Nodes/transform.html]] : Base transform node (that inherits from {{{dagNode}}}).  Adds the attribute {{{xformMatrix}}} which is the same as the parental {{{matrix}}} (local) attribute.
*[[dagPose|http://download.autodesk.com/us/maya/2010help/Nodes/dagPose.html]] : Created via the {{{dagPose}}} command, used to store matrix data as a pose. Most often used during skinning operations.
*[[addMatrix|http://download.autodesk.com/global/docs/maya2013/en_us/Nodes/addMatrix.html]] : Add a list of matrices together.
*[[fourByFourMatrix|http://download.autodesk.com/global/docs/maya2013/en_us/Nodes/fourByFourMatrix.html]] : This node outputs a 4x4 matrix based on 16 input values. This output matrix attribute can be connected to any attribute that is type "matrix".
*[[holdMatrix|http://download.autodesk.com/global/docs/maya2013/en_us/Nodes/holdMatrix.html]] : Cache a matrix.
*[[multMatrix|http://download.autodesk.com/global/docs/maya2013/en_us/Nodes/multMatrix.html]] : Multiply a list of matrices together.
*[[passMatrix|http://download.autodesk.com/global/docs/maya2013/en_us/Nodes/passMatrix.html]] : Multiply a matrix by a constant without caching anything.
*[[pointMatrixMult|http://download.autodesk.com/global/docs/maya2013/en_us/Nodes/pointMatrixMult.html]] : The dependency graph node to multiply a point by a matrix.  Pairs with the {{{pointMatrixMult}}} mel proc (above).
*[[wtAddMatrix|http://download.autodesk.com/global/docs/maya2013/en_us/Nodes/wtAddMatrix.html]] : Add a weighted list of matrices together.
* {{{matrixNodes.mll}}} plugin : Ships with Maya 2013.  Includes these nodes:
**{{{decomposeMatrix}}} : Previous to Maya 2013, created via the {{{decomposeMatrix.mll}}} plugin.  Exposes the matrix data for a given transform.
**{{{composeMatrix}}}
**{{{inverseMatrix}}}
**{{{transposeMatrix}}}
!Accessing Matrix Data:
!!!API Only:
Here, we have functions that return either {{{MMatrix}}} or {{{MTransformationMatrix}}} objects.
----
^^Calls used in the below //API// examples:^^
{{{
import maya.OpenMaya as om
}}}
{{{
def getMDagPath(node):
"""
Convenience function to make getting MDagPaths easier:
Get a MDagPath for a node.  node is a string name.
"""
selList = om.MSelectionList()
selList.add(node)
mDagPath = om.MDagPath()
selList.getDagPath(0, mDagPath)
return mDagPath
}}}
----
{{{
def get_MDagPath_MMatrix(node):
"""
This will return the worldspace MMatrix of a node. node is a string name.
"""
mDagPath = getMDagPath(node)
mMatrix = mDagPath.inclusiveMatrix()
return mMatrix
}}}
{{{
def get_MFnTransform_MTransformationMatrix(node):
"""
Using a MFnTransform function, return a MTransformationMatrix for the node.
This is the *local* matrix of the node (not worldspace).  node is a string name.
"""
mDagPath = getMDagPath(node)
transformFunc = om.MFnTransform(mDagPath)
mTransformMtx = transformFunc.transformation()
return mTransformMtx
}}}
!!!API and getAttr / xform:
The below to functions are almost the same.  The {{{getAttr}}} method however gives you a few more matrix querying options.
----
^^Calls used in the below //API// examples:^^
{{{
import maya.cmds as mc
}}}
----
{{{
def get_getAttr_MMatrix(node, matrixType):
"""
Access the matrix attr data directly on a node.
node : string name of node to query.
matrixType : "matrix", "inverseMatrix", "worldMatrix", "worldInverseMatrix",
"parentMatrix", "parentInverseMatrix", "xformMatrix"
return a MMatrix
"""
mList = mc.getAttr(node+"."+matrixType)
mMatrix = om.MMatrix()
om.MScriptUtil.createMatrixFromList(mList, mMatrix )
return mMatrix
}}}
{{{
def get_xform_MMatrix(node):
"""
Access the matrix attr data directly on a node.
This will return the worldspace MMatrix for the node.
node : string name of node to query.
return a MMatrix
"""
mList = mc.xform(node, query=True, matrix=True)
mMatrix = om.MMatrix()
om.MScriptUtil.createMatrixFromList(mList, mMatrix )
return mMatrix
}}}
!!!Mel only:
Python has no built-in matrix [[type|http://docs.python.org/library/stdtypes.html]], that's why above we use the Maya API's version.  Here we do it all in mel:
{{{
global proc matrix get_getAttr_matrix(string $node, string$matrixType){
// Access the matrix attr data directly on a node.
// string $node : Name of node to query. // string$ matrixType : "matrix", "inverseMatrix", "worldMatrix",
//     "worldInverseMatrix", "parentMatrix", "parentInverseMatrix",
//     "xformMatrix"
float $m[] =getAttr ($node+"."+$matrixType); matrix$mtx[4][4] = <<$m[0],$m[1],  $m[2],$m[3];
$m[4],$m[5],  $m[6],$m[7];
$m[8],$m[9],  $m[10],$m[11];
$m[12],$m[13], $m[14],$m[15]>>;
return $mtx; } // example: matrix$myMatrix[4][4] = get_getAttr_matrix("pCube1", "worldMatrix")
// Result: << 1 0 0 0;  0 1 0 0;  0 0 1 0;  0 0 0 1 >> //
}}}
{{{
global proc matrix get_xform_matrix(string $node){ // returns a matrix type for the given node's world matrix. float$m[] = xform -query -matrix  $node; matrix$mtx[4][4] = <<$m[0],$m[1],  $m[2],$m[3];
$m[4],$m[5],  $m[6],$m[7];
$m[8],$m[9],  $m[10],$m[11];
$m[12],$m[13], $m[14],$m[15]>>;
return $mtx; } // example: matrix$myMatrix[4][4] = get_xform_matrix("pCube1")
// Result: << 1 0 0 0;  0 1 0 0;  0 0 1 0;  0 0 5.667197 1 >> //
}}}
!Manipulating matrix data:
Once you have API {{{MMatrix}}} data, you can manipulate it like standard types.  //Usually// this is matrix multiplication, and it creates a new matrix:
{{{
cubeMtx = get_MDagPath_MMatrix('pCube1')
sphereMtx = get_MDagPath_MMatrix('pSphere1')
newMtx = cubeMtx * sphereMtx
}}}
Same thing goes for the mel {{{matrix}}} type:
{{{
matrix $cubeMtx[4][4] = getAttr_matrix("pCube1", "worldMatrix"); matrix$sphereMtx[4][4] = getAttr_matrix("pSphere1", "worldMatrix");
matrix $newMtx[4][4] =$cubeMtx * $sphereMtx; }}} It should be noted that {{{MTransformationMatrix}}} has no operator operations, so you can't do multiplication like above. If you wanted to, you'd need to convert it to a {{{MMatrix}}}, do the multiplication, then convert the new {{{MMatrix}}} back to a {{{MTransformationMatrix}}}, see examples of this below. It should be noted however that the {{{MTransformationMatrix}}} class has many methods for setting its values, check the docs. ---- If you want to query the individual elements of a {{{MMatrix}}}, there are a couple different ways: {{{ # Note how you call ( ) to the matrix, rather than access the index directly [ ] ? mtxItem = someMMatrix(2,2) mtxItem = om.MScriptUtil.getDoubleArrayItem(someMMatrix[2], 2) }}} Which is similar for mel {{{matrix}}} types: {{{ float$mtxItem = $newMtx[2][2]; }}} The {{{MTransformationMatrix}}} provides no index access to its internal elements. You first need to convert it to a {{{MMatrix}}} type, then query the values you're after via the above methods: {{{ newMMatrix = myMTransformationMatrix.asMatrix() }}} ---- If you want to set an individual element of a {{{MMatrix}}} you need to use a {{{MScriptUtil}}} convenience function. Here, we set the 2rd row (index 1), 3rd column (index 2) to 3.1: {{{ om.MScriptUtil.setDoubleArray(someMMatrix[1], 2, 3.1) }}} This is pretty easy in mel: {{{$newMtx[2][2] = 3.1;
}}}
Like above you can't directly access the elements of a {{{MTransformationMatrix}}}.  So if you want to set one of them, based on the above solution you'd need to convert it to a {{{MMatrix}}}, modify the element, then re-create the {{{MTransformationMatrix}}} based on the new {{{MMatrix}}} data.  This is lossy however, and you could loose other local transformation data the original {{{MTransformationMatrix}}} was storing:
{{{
myMTransformationMatrix = om.MTransformationMatrix(someMMatrix)
}}}
!Apply matrix data:
Once you have updated\new matrix data, how do you get it back on your nodes?
!!!API Only
It's interesting that I can't find anything via the API to apply a {{{MMatrix}}} back to a node, it only has functions for applying {{{MTransformationMatrix}}} data.  So in theory you could create a new {{{MTransformationMatrix}}} based around a given {{{MMatrix}}}, and use this code:
{{{
def set_MFnTransform_MTransformationMatrix(node, mtf_mtx):
"""
Using a MFnTransform function, apply a MTransformationMatrix to a node.
node is a string name.
"""
mDagPath = getMDagPath(node)
transformFunc = om.MFnTransform(mDagPath)
transformFunc.set(mtf_mtx)

# For example:
sphereMtx = get_MFnTransform_MTransformationMatrix('pSphere1')
set_MFnTransform_MTransformationMatrix('pCube1', sphereMtx)
}}}
!!!API & xform:
{{{
def set_xform_MMatrix(node, mMatrix):
"""
Apply the given MMatrix to the given node in worldspace
"""
mList = [mMatrix(i,j) for i in range(4) for j in range(4)]
mc.xform(node, worldSpace=True, matrix=mList)

# For example:
pCubeMtx = get_MDagPath_MMatrix('pCube1')
set_xform_MMatrix('pSphere1', pCubeMtx, 'worldSpace')
}}}
!!!Mel Only:
{{{
global proc set_xform_matrix(string $node, matrix$matrix){
// Apply the given matrix to the given node in worldspace
// First we need to convert the matrix to a float array:
float $ml[] = {}; for($i=0;$i<4;$i++){
for($j=0;$j<4;$j++){$ml[size($ml)] =$matrix[$i][$j];
}
}
xform -matrix $ml[0]$ml[1] $ml[2]$ml[3] $ml[4]$ml[5] $ml[6]$ml[7] $ml[8]$ml[9] $ml[10]$ml[11] $ml[12]$ml[13] $ml[14]$ml[5]
-worldSpace $node; } // For example: set_xform_matrix("pCube1",$matrix);
}}}

I wanted a way to reference a node by a persistent ID, that would remain the same between Maya sessions, //even if the name of the node changed//.  Meaning, reference a node by a value other than its string name.

Short answer is yes, but //they're only persistent for the given Maya session//:  Restarting Maya rests the id's... :(

And to clarify, I'm not referring to the {{{MTypeId}}} class, which provides access to the unique id provided to a given type\classification of node:  I was looking for a persistent id for a specific instance of a node, like it's location in memory, or a representative hash.
----
What I found id this:  Given an {{{MObject}}} for a node, you can access the secretive {{{myMObject.__hash__()}}} method, which will return a unique hash for that instance of an {{{MObject}}} for the given node.  If you create another {{{MObject}}}, it will have it's own unique hash.  AND, obviously, if you quit Maya, reopen it, and generate a new {{{MObject}}}, it too will have its own unique hash.  There's also the {{{MObjectHandle}}} class that has a {{{hashCode()}}} method, which I presume references the one on the {{{MObject}}}.

~PyMel's {{{PyNode}}} has a similar {{{__hash__()}}} method, which has the same limitations.

So basically, in a given Maya session, you can create a {{{MObject}}} for a node, and then (via the authoring of new tools) access the node by it's 'hash name'.  But creating a new {{{MObject}}} or reloading the scene will break this by generating all new hash values.
----
I brought this up with Autodesk support, and after much troubleshooting\research they said 'no such thing exists'.
----
The current solution I'm working on is to leverage Python's  [[uuid|http://docs.python.org/2/library/uuid.html]] module ([[Universally Unique Identifier|http://en.wikipedia.org/wiki/UUID]]) into a tool that will emulate this functionality by adding\querying custom 'uuid' attrs applied to nodes.
I've pretty-much made the switch from mel (Maya's scripting language) to Python. And what I describe below is standard in Python (implemented differently, but similar visually). But I just recently learned that you can include dots (periods) '.' in mel procedure names. While this doesn't in any way change their behavior, it does let you organize your procs in a more intelligent way based on their names.

Background: In Maya, if you have a global procedure in a mel script, and the global proc and the script share the same name, when you call to the name (via some other proc\script), Maya will search in its 'script path' for the script with the name, then search in that script for the global proc with that name, and (if it finds it) execute the proc. Furthermore, any other global procs in that script are now sourced and can be executed outside of the script by other procedures. Nothing new here. The 'dot in name' convention though lets you associate the script name with the other global procs in the script. When calling them in other procedures/scripts, you'll have a visual reminder of where they came from via their name. To explain this a bit better, an example:
{{{
// foo.mel

global proc foo.boo()
{
print "doing .boo() work\n";
}

global proc foo.shoe()
{
print "doing .shoe() work\n";
}

global proc foo()
{
print "foo.mel  -- I do nothing.\n";
print "My procs:\n";
print "\t.boo()\n";
print "\t.shoe()\n";
}
}}}
The above code resides in 'foo.mel'. Inside, there is a global proc called 'foo()', that doesn't really do anything other than print some info. But its there so when the user calls to 'foo()', the other global proces will become sourced. There are other global procs in the script that do the actual work. When you execute 'foo()', the other global procs 'foo.boo()' and 'foo.shoe()' are sourced, and can be called to inside of that script, or other scripts\procs. If you're calling to them inside that script, it's fairly obvious where they're coming from. But say you have some other script called 'goo.mel':
{{{
// goo.mel

// Execute foo(), making its other global
// procs available  in this script.
// Could have optionally executed 'source foo;'
foo;

// Execute foo's global procs:
foo.boo();
foo.shoe();
}}}
'goo.mel' executes (or optionally sources) 'foo.mel', thus giving 'goo.mel' access to 'foo.mel's' global procs, and then can call to each of them. By having 'foo.' in front of each proc, it's plainly clear to the user where they originally came from, which is a great aid in troubleshooting. This is a simple example, but imagine if you have goo executing procs from foo, moo, hoo, doo, etc, and you can see where this can come in handy.

So again, the 'dot in proc' is by no means required, but it's another tool in your organizational toolkit. 
''Note'':
<<<
I have a newer subject listed here:
[[Positional args in Python authored UI's]]
It doesn't invalidate anything listed below, but puts another spin on it.  When I authored the below section, I didn't quite understand 'positional arguments', and thought the data I was seeing was a bug.  So I put a bit of a negative spin on it.  I have re-written bits of below to reflect the new knowledge, but you should keep that in mind when reading it.
<<<
----
----
Python has a similar issues to mel when it comes to building a UI that calls to an external command:
*In //mel//, say you have a button that references a procedure in the same script as the UI (or it could be in a different script).  If that procedure isn't a //global procedure//, the UI will never be able to find it after UI creation.
*Python has the same issue:  In a Python module you author a Maya UI.  In that UI you create a button that tries to execute a Python function.  But when you run the UI, it can't find the function even though the function was authored in the same module as the UI.  How can you make it work?
I've found --two-- six different solutions.  Part of this ''update'' are three new solutions, now listed first.
*The first example shows a clean way of having a function-authored UI call to a function in the same module, via hard-coded UI control names.
*The second example shows how to author a UI in a class, and call to methods in that class via hard-coded UI control names.
*The third example shows how to author a UI in a class, and call to methods in that class via control object name pointers, rather than hard-coded names.
*The fourth example illustrates the {{{button}}}-argument bug (also see 'one last bug' below), and some solutions around it.
*The fifth (one of the original) example shows how you can create UI's via classes, and pass object pointers back as the commands.
*The sixth (last original) example uses more basic functions, and embeds the commands as strings.
I would recommend using methods 1-4, but I've kept the last two since they do show yet another way of approaching things.
----
''{{{lambda}}}'':
I should call out how important the {{{lambda}}} expression (//Python// expression, not Maya expression) is to this system.  See {{{lambda}}} notes on my [[Python wiki|http://pythonwiki.tiddlyspot.com/#%5B%5BUnderstanding%20lambda%5D%5D]].  I'll touch on it briefly here:  A button command in a Maya UI expects to have either a //string//, or a //function// passed into it.  If you pass something else, you'll raise a {{{TypeError}}} exception like this:
{{{
# Passing in a 'None' object to a button command:
# TypeError: Invalid arguments for flag 'buttonCommand'.  Expected string or function, got NoneType #
}}}
Why is this important?
*{{{lambda}}}'s are 'Python expressions' that return //function objects//.  This means you can use a {{{lambda}}} to wrapper a command you're passing into a UI button command, without having to jump through the hoops of turning that command into a string to be evaluated later.  And because of this, the {{{lambda}}} remembers the 'scope' it was authored in, thus allowing you to continue to search through it's parental namespaces in the containing module.
To put it another way:
*If you make the button command a string, when the command is executed, the string is evaluated in the 'most global scope' of Python.  Technically this is the {{{__builtin__}}} scope of Python, which is the parental scope of modules (which define global scopes) and functions (local scopes).  So that string really has //no// idea about the module, or function, it was authored in.  {{{lambda}}} however isn't an anonymous string: it creates a live function object, fully aware of its scope.  And because of that, makes you authoring life much easier.  If you want more info understanding Python's scope, see my Python wiki [[here|http://pythonwiki.tiddlyspot.com/#%5B%5BPython%20variable%20scope%5D%5D]].
----
''Positional args, what you need to know:''
<<<
I used to think this was a bug in the system, but I've finally tracked this issue down. I explain this in great detail here: [[Positional args in Python authored UI's]], but I will cover it briefly here:
When a UI control is executed, either by changing its value (via a floatSlider, textField, floatField, etc), or by "pressing" it (via a button), the control will return //positional arguments// to its command flags.  This means if you author the {{{-changeCommand}}} of a control to call to a function, the control will pass any positional arguments into that function.  For example, if you have a {{{floatFieldGrp}}}, with three fields, and you map a function into the {{{-changeCommand}}} of that control, any time you change one of the three arguments, it will return all three //positional arguments// to the function defined by the {{{-changeCommand}}}.  If you're not expecting this, it can seem like a bug.  But it's not, and actually, its quite handy.
It should be noted though that this behavior can vary between controls:  The {{{button}}} control always returns back an empty string {{{""}}} as its positional arg.  The 'button' of a {{{textFieldButtonGrp}}} returns back nothing at all as its positional arg.  That difference in behavior I //do// consider a bug.
<<<
----
!Example #1
We make a module called mayaWindowTest01.py.  In it we author two functions, one to build the window, and one that is executed when the button in the window is pressed.
Here, three important things are happening:
#When the UI creates itself, it hard-codes the name of the {{{textFieldButtonGrp}}} as '{{{TFBG_stuff}}}'.
#The {{{buttonCommand}}} of the control is calling to a {{{lambda}}} expression, that actually ends up executing our button command.  You can see an example above it (commented out) for the solution you'd need if you //weren't// using the {{{lambda}}} expression.
#Inside the {{{buttonCmd}}} function, it finds the control to query via the hard-coded name:
{{{
# mayaWindowTest01.py
import maya.cmds as mc

# Pass UI values by hard-coded UI names in functions outside a class:
def buttonCmd(word):
text = mc.textFieldButtonGrp("TFBG_stuff", query=True, text=True)
print text + "  " + str(word)

def mainWindow():
if mc.window("pyWin", exists=True):
mc.deleteUI("pyWin")
mc.window("pyWin", title="Python Window",  resizeToFitChildren=True)
mc.columnLayout(adjustableColumn=True, columnAttach=('both', 5))
# Example of passing our button-commad as a string, rather than lambda:
# mc.textFieldButtonGrp("TFBG_stuff",  buttonCommand="mayaWindowTest01.buttonCmd('Success!')")
mc.textFieldButtonGrp("TFBG_stuff",  buttonCommand=lambda:buttonCmd('Success!'))
mc.showWindow()

mainWindow()
}}}
Then to execute:
{{{
import mayaWindowTest01
}}}
The {{{buttonCmd}}} both queries the UI control value, and an incoming argument, just to illustrate possible usages.  When you hit the button, it queries the UI control text, adds the text passed in as an arg, and prints the result.
Notice the commented-out example above.  If you pass the command in as a string, you need to use the fully-qualified namespace of {{{buttonCmd}}}: '{{{mayaWindowTest01.buttonCmd}}}', since as a string, in a sense the command has no idea where to find the data its executing.  But by using {{{lambda}}}, it is no longer a string, but an actual function, and it finds {{{buttonCmd}}} in the global scope of the module automatically.
!Example #2
Here, we author the UI and the command it calls to inside of a class.  Like Example #1, we hard-code the UI control name for our {{{textFieldButtonGrp}}}.  The {{{buttonCmd}}} method has the same functionality as the {{{buttonCmd}}} function from Example #1.
We still use a {{{lambda}}} to assign our command to our {{{buttonCommand}}} argument.  But notice that the lambda points to '{{{self.buttonCmd}}}', since this is a method of the class:
{{{
# mayaWindowTest02.py
import maya.cmds as mc

# Pass UI values by hard-coded UI names inside a class:
class mainWindow(object):
def __init__(self):
self.showWindow()

def buttonCmd(self, word):
# pull UI control name from our hard-coded name:
text = mc.textFieldButtonGrp("TFBG_stuff", query=True, text=True)
print text + "  " + str(word)

def showWindow(self):
if mc.window("pyWin", exists=True):
mc.deleteUI("pyWin")
mc.window("pyWin", title="Python Window",  resizeToFitChildren=True)
mc.columnLayout(adjustableColumn=True, columnAttach=('both', 5))
# Hard-code our UI name:
mc.textFieldButtonGrp("TFBG_stuff", buttonCommand=lambda:self.buttonCmd('Success!'))
mc.showWindow()
}}}
Then to execute:
{{{
import mayaWindowTest02
win = mayaWindowTest02.mainWindow()
}}}
!Example #3
This is probably the most elegant example, since there is no hard-coding of UI control names.  While nearly identical to Example #2, here we create a class attribute called {{{self.tfbg}}} that stores the object reference created when we author the {{{textFieldButtonGrp}}}.  Inside of our {{{buttonCmd}}} method, we then call to that class attr for our control name.  Never have to wory about UI name clashing!
{{{
# mayaWindowTest03.py
import maya.cmds as mc

# Pass UI values by object pointers inside a class:
class mainWindow(object):
def __init__(self):
self.showWindow()

def buttonCmd(self, word):
# Pull in the control name via the class attr:
text = mc.textFieldButtonGrp(self.tfbg, query=True, text=True)
print text + "  " + str(word)

def showWindow(self):
if mc.window("pyWin", exists=True):
mc.deleteUI("pyWin")
mc.window("pyWin", title="Python Window",  resizeToFitChildren=True)
mc.columnLayout(adjustableColumn=True, columnAttach=('both', 5))
# Create a class attribute, to store the UI name
self.tfbg = mc.textFieldButtonGrp(buttonCommand=lambda:self.buttonCmd('Success!'))
mc.showWindow()
}}}
To execute:
{{{
import mayaWindowTest03
win = mayaWindowTest03.mainWindow()
}}}
!Example #4
(I authored this example when I didn't quite understand //positional arguments//, and though they were a bug.  While I've updated it to reflect that newer knowledge, it was still originally authored to show what I thought the problem was.)
When the {{{button}}} control is pressed, it passes a single empty string back as a //positional argument//.  When  it is pressed, and it tries to execute its {{{command}}}, it also passes and empty string as an argument to the command.  If the command isn't expecting this... bad things.
We can still use {{{lambda}}}, but as you can see, we need to implement the concept of {{{*args}}}, which will let {{{lambda}}} get any number of external args during its execution.
In the below example, a window is created with four buttons.  It shows how you can call to a method generated in an external object, and methods in the same object that created the UI, using {{{lambda}}} or not.  The class {{{MyCmd}}} and it's method {{{printer}}} are designed to illustrate how the {{{button}}} command will pass its empty arg, if not caught by {{{lambda *args}}} first.  To learn more about {{{*args}}}, see my Python wiki [[here|http://pythonwiki.tiddlyspot.com/#argument]].
{{{
# mayaWindowTest04.py
import maya.cmds as mc

class MyCmd(object):
def printer(self, *args):
self.args = args
print "External object, length of positional args: " + str(len(self.args))

class mainWindow(object):
def __init__(self):
self.showWindow()

def mainCmd(self):
print "Internal object, success"

def showWindow(self):
if mc.window("pyWin", exists=True):
mc.deleteUI("pyWin")
mc.window("pyWin", title="Python Window",  resizeToFitChildren=True)
mc.columnLayout(adjustableColumn=True, columnAttach=('both', 5))
# make an object that will execute our external command:
cmdObject = MyCmd()

# Here we use the button command, with and without lambda.  The button
# command always passes an empty string as an arg to the command, so we
# need to catch it with lambda using *args:
mc.button(command=lambda *args:cmdObject.printer(), label="Button, external object, lambda")
mc.button(command=lambda *args:self.mainCmd(), label="Button, this object, lambda")
mc.button(command=cmdObject.printer, label="Button, external object, no lambda")
mc.button(command=self.mainCmd, label="Button, this object, no lambda (will fail)")

# textFieldButtonGrp's button command doesn't return any positional args,
# which I actually think is a bug.  But we can handle it differently because of that
mc.textFieldButtonGrp(buttonCommand=lambda:cmdObject.printer(), buttonLabel="textFieldButtonGrp, external object, lambda" )
mc.textFieldButtonGrp(buttonCommand=lambda:self.mainCmd(), buttonLabel="textFieldButtonGrp, this object, lambda" )
mc.textFieldButtonGrp(buttonCommand=cmdObject.printer, buttonLabel="textFieldButtonGrp, external object, no lambda" )
mc.textFieldButtonGrp(buttonCommand=self.mainCmd, buttonLabel="textFieldButtonGrp, this object, no lambda" )

mc.showWindow()
}}}
To execute:
{{{
import mayaWindowTest04
win = mayaWindowTest04.mainWindow()
}}}

----
''These are two older examples:''
----
!Example #5
(big shout out to Doug Brooks for helping me figure this out...)
Make sure that this module is saved in part of your Maya Python path.
{{{
# myWin.py
import maya.cmds as mc

class MyCmd(object):
# Create a object that will do the work the button requests
def __init__(self, word):
self.val = word
def printer(self, *arg):
print self.val

class MyWin(object):
# Our window object
def mainWindow(self):
# Display the window:
if mc.window("pyWin", exists=True):
mc.deleteUI("pyWin")
mc.window("pyWin", title="Python Window")
mc.columnLayout(adjustableColumn=True, columnAttach=('both', 5))
# make our command object, with argument:
cmdObject = MyCmd("success!")
mc.button(label="super button!", command=cmdObject.printer)
mc.showWindow()
}}}
In the above example, we create two objects, both existing in the same module, {{{myWin.py}}}.  Key things to note:
*Before we make our button, we first create an object that will do the work, including the arguments that should be used:
{{{
cmdObject = MyCmd("success!")
}}}
*Next, when we create the button, we pass a pointer to the object.method we want to execute.  Note that I have left //off// the trailing parenthesis '{{{()}}}' that one would normally include.
{{{
mc.button(label="super button!", command=cmdObject.printer)
}}}
*Now, inspect the {{{MyCmd}}} class:  It has a standard {{{__init__}}} method for turning the passed in variable into an object attribute.  But what is interesting, is the {{{printer}}} method:
{{{
def printer(self, *arg):
}}}
*See the 2nd argument, {{{*arg}}}?  This is a //positional argument//, and can capture arbitrary passed in variables as a {{{tupple}}} (a Python immutable list).  Even though the {{{printer}}} method doesn't call to the {{{*arg}}} inside of it, if you were to remove this argument, it would fail.  Why?  It //seems// that when Maya's {{{mc.button}}} command is ran, it passes an //empty string// as an argument //to the command//.  I have no idea //why// it's doing this, but you need to catch this rouge argument via {{{*args}}}, and then just ignore it.
Finally, you can execute the code:
{{{
import maya.cmds as mc
import myWin
win = myWin.MyWin()
win.mainWindow()
}}}
This will launch the UI.  When you hit the '{{{super button!}}}' button, it //should// print to Maya, {{{success!}}}.
!Example #6
Make sure that this module is saved in part of your Maya Python path:
{{{
# myWin2.py
import maya.cmds as mc

def printer(p):
# our buttom command function
print p

def mainWindow():
if mc.window("pyWin", exists=True):
mc.deleteUI("pyWin")
mc.window("pyWin", title="Python Window")
mc.columnLayout(adjustableColumn=True, columnAttach=('both', 5))
mc.button(label="super button!", command="import myWin2 as mw; mw.printer('success!')")
mc.showWindow()
}}}
This example is a bit more simplistic that the first example.  Here, we have no class objects being created.  Really, the only important thing to note is on the button line:
{{{
mc.button(label="super button!", command="import myWin2 as mw; mw.printer('success!')")
}}}
*Note how for the command, there are actually two separate commands:  The first imports the module that the window was authored in ("{{{import myWin2 as mw}}}"), and the second executes the {{{printer}}} function defined there within ("{{{mw.printer('success!')}}}").  If the import didn't happen, when this command was executed, it'd have no knowledge of what '{{{printer}}}' was.
To execute the code:
{{{
import maya.cmds as mc
import myWin2
myWin2.mainWindow()
}}}
This will launch the UI.  When you hit the '{{{super button!}}}' button, it //should// print to Maya, {{{success!}}}.
Since you're embedding the command as a string in this example, it's not as flexible as the first (in case you wanted a command to run on arbitrarily changing values), but, it is easier to wrap your head around.

http://en.wikipedia.org/wiki/Facial_Action_Coding_System
From Wikipedia:
<<<
Using FACS, human coders can manually code nearly any anatomically possible facial expression, deconstructing it into the specific Action Units (AU) and their temporal segments that produced the expression. As AUs are independent of any interpretation, they can be used for any higher order decision making process including recognition of basic emotions, or pre-programmed commands for an ambient intelligent environment.
<<<
This is good for facial rigging, since there are (quoted from Jeremy Ernst's [[GDC paper|http://www.unrealengine.com/files/downloads/Jeremy_Ernst_FastAndEfficietFacialRigging2.pdf]] ) "32 action units of the face that can achieve the entirety of the range of (e)motion of the face.  An action unit is deﬁned as a contraction or relaxation of 1 or more muscles in the face".

This allows the rigger a set of guidelines to go by when creating facial rigs, that can more closely match what the human face is actually doing.
Given a matrix, how do you find the corresponding Euler rotations?  I've been working on this problem, and my "Third Solution, Method A" gives a good result.  But you can see a history of research below.
!Third Solution
After learning more from the API, I realized the differences between the [[MMatrix|http://download.autodesk.com/us/maya/2010help/api/class_m_matrix.html]] class and the [[MTransformationMatrix|http://download.autodesk.com/us/maya/2010help/api/class_m_transformation_matrix.html]] class:  {{{MMatrix}}} purely holds matrix data, not unlike a {{{MVector}}} storing vector data and nothing else.  the {{{MTransformationMatrix}}} does everything a {{{MMatrix}}} does, but it has knowledge of how Maya wants it, so provides many convenience methods for accessing the data and interaction with a Maya transform node..

The big takeaway I found is this:  {{{MTransformationMatrix}}} objects will keep track of rotations past 360 degrees & rotation order of the node, while {{{MMatrix}}} objects will not. It makes sense:  A matrix itself stores orientations as vectors, which have no concept how how far they've been 'rotated', so the {{{MMatrix}}} object doesn't track this data.  But behind the scenes, the {{{MTransformationMatrix}}} //does// track this info, which the below examples illustrate.

One more very important piece of data:  When extracting a {{{MTransformationMatrix}}} from a node via a {{{MFnTransform}}} function, what you're actually getting is the //local transformation matrix// of that node (since the {{{MTransformationMatrix}}} appears to track transformations //specific to that node//, relative to its parent).  So if you were expecting the world-space matrix, prepare to be disappointed.  You can build a {{{MTransformationMatrix}}} out of a worldspace-acquired {{{MMatrix}}}, but at that point 'rotations past 360' would be lost.
{{{
# Python code
import math
import maya.cmds as mc
import maya.OpenMaya as om

# Define a node to pull a matrix from.
node = 'pCube1'
# Set some rotation values for comparison later:
mc.setAttr('%s.rotate'%node, 15, -45, 1000)
mc.setAttr('%s.scale'%node, 3, 3, 3)
# Change the rot order, to make sure returned euler values are correct:
mc.setAttr('%s.rotateOrder'%node, 3)
}}}
''Method A:  Using {{{MTransformationMatrix}}}''
This, in my opinion, is the best solution.  Via the API, you get an {{{MDagPath}}} object for your node, wrapper it in a {{{MFnTransform}}} object, and then directly extract a {{{MTransformationMatrix}}} object from it.  This object tracks the rotation order (so you don't have to), and rotation values past 360
{{{
#-------------------------------------------
# Part 1: Get a MTransformationMatrix from an object for the sake of the example.
# You can use your own MTransformationMatrix if it already exists of course.

# get a MDagPath for our node:
selList = om.MSelectionList() # make a sel list # MSelectionList
selList.add(node) # add our node by name
mDagPath = om.MDagPath() # create an empty dag path # MDagPath
selList.getDagPath(0, mDagPath) # fill the dag path with our node

# Create a MFnTransform object for our MDagPath,
# and extract a MTransformationMatrix from it:
transformFunc = om.MFnTransform(mDagPath) # MFnTransform
mTransformMtx = transformFunc.transformation() # MTransformationMatrix

#-------------------------------------------
# Part 2, get the euler values
# Get an MEulerRotation object
eulerRot = mTransformMtx.eulerRotation() # MEulerRotation
# note, we *don't* have to set the rot order here...

# Convert from radians to degrees:
angles = [math.degrees(angle) for angle in (eulerRot.x, eulerRot.y, eulerRot.z)]
print angles, "MTransformationMatrix"
}}}
''Method B: Using {{{MMatrix}}}''
While this method works well, it doesn't track rotation values past 360:  We create a {{{MMatrix}}} object directly from the {{{worldMatrix}}} attr queried on our node.  We then convert that to a {{{MTransformationMatrix}}} object so we can extract the {{{MEulerRotation}}} object.  However, the {{{MMatrix}}} doesn't pass along the rotation order of the node, and has no knowledge of rotations past 360, so the resultant {{{MTransformationMatrix}}} won't know that stuff either.  To get accurate rotation values, we have to save the rotation order value ahead of time, and then apply it back before retrieving values from our {{{MEulreRotation}}} object.
{{{
#-------------------------------------------
# Part 1:  Get a MMatrix from an object for the sake of the example.
# You can use your own MMatrix if it already exists of course.

# Get the node's rotate order value:
rotOrder = mc.getAttr('%s.rotateOrder'%node)
# Get the world matrix as a list
matrixList = mc.getAttr('%s.worldMatrix'%node) # len(matrixList) = 16
# Create an empty MMatrix:
mMatrix = om.MMatrix() # MMatrix
# And populate the MMatrix object with the matrix list data:
om.MScriptUtil.createMatrixFromList(matrixList, mMatrix)

#-------------------------------------------
# Part 2, get the euler values
# Convert to MTransformationMatrix to extract rotations:
mTransformMtx = om.MTransformationMatrix(mMatrix)
# Get an MEulerRotation object
eulerRot = mTransformMtx.eulerRotation() # MEulerRotation
# Update rotate order to match original object, since the orig MMatrix has
# no knoweldge of it:
eulerRot.reorderIt(rotOrder)

# Convert from radians to degrees:
angles = [math.degrees(angle) for angle in (eulerRot.x, eulerRot.y, eulerRot.z)]
print angles, "MMatrix"
}}}
Running the above code prints (and I reformatted the float precision issues, just so it's easier to compare to the above values):
{{{
[15, -45, 1000] MTransformationMatrix
[15, -45, -80] MMatrix
}}}
As you can see, the {{{MTransformationMatrix}}} stores the rotation values past 360 deg, while the {{{MMatrix}}} doesn't.
!Second Solution
When I came up with this solution I thought it was pretty slick.  But solution 3 above is even better since it skips the need to create the {{{MQuaternion}}} objects.
{{{
import math
import maya.cmds as mc
import maya.OpenMaya as om

# Define a node to pull a matrix from.  No reason you
# can't use your own matrix of course.
node = 'pCube1'
# Get this nodes rotate order:
rotOrder = mc.getAttr('%s.rotateOrder'%node)

# Get the world matrix as a list
matrixList = mc.getAttr('%s.worldMatrix'%node)
# create an MMatrix to hold this data:
mMatrix = om.MMatrix()
om.MScriptUtil.createMatrixFromList(matrixList, mMatrix)

# Convert MMatrix to MTransformationMatrix object:
mTransformationMatrix = om.MTransformationMatrix(mMatrix)

# Get rotation as MQuaternion:
mQuaternion = mTransformationMatrix.rotation()

# Convert to MEulerRotation:
mEulerRotation = mQuaternion.asEulerRotation()

# Update rotate order to match original object:
mEulerRotation.reorderIt(rotOrder)

# Convert from radians to degrees:
angles = [math.degrees(angle) for angle in (mEulerRotation.x,
mEulerRotation.y,
mEulerRotation.z)]
print angles
# [-26.706627346943492, -79.553892761509957, -58.387916674342371]
}}}
Matrices store rotations as vectors, and because of this (and due to conversion to quaternions) they have no concept of rotations past 360 degrees.  So if you have a source rotation value of 400, this will convert it to 40 (400 - 360 = 40).

While reading the API docs, I saw that the {{{OpenMaya.MTransformationMatrix}}} has a {{{getRotation()}}} method.  I thought it would be better using this method  so I could skip the {{{MQuaternion}}} \ {{{MEulerRotation}}} conversion.  However, I wasn't ever able to get it to work.  Doing some research, I ran across [[this post|http://www.rtrowbridge.com/blog/2009/02/python-api-mtransformationmatrixgetrotation-bug/]] that confirms that it __is a bug__.
!First Solution
[[This post|http://forums.cgsociety.org/archive/index.php/t-617014.html]] gave me the knowledge of how to tap into Maya's API (via Python) to find a solution.
Below is the //first// solution I came up with:  It just uses {{{MMatrix}}} , no {{{MTransformationMatrix}}} is involved.  The problem was that if you //scaled// the node being queried, it would throw off the ~MQuaternion ahead of time.  The above solution fixes this issue.
{{{
# Python code

import math
import maya.cmds as mc
import maya.OpenMaya as om

# Define a node to pull a matrix from.  No reason you
# can't use your own matrix of course.
node = 'pCube1'

# Get the world matrix as a list
matrixList = mc.getAttr('%s.worldMatrix'%node)

# Convert list to MMatrix object
mMatrix = om.MMatrix()
om.MScriptUtil.createMatrixFromList(matrixList, mMatrix)

# Convert matrix to quaternion (MQuaternion object)
quatRotate = om.MQuaternion()
quatRotate.assign(mMatrix)

# Pull Euler rotation values from quaternion (MEulerRotation object)
eulers = quatRotate.asEulerRotation()

# Convert from radians to degrees:
angles = [math.degrees(angle) for angle in (eulers.x, eulers.y, eulers.z)]
print angles

# [-26.706627346943492, -79.553892761509957, -58.387916674342371]
}}}

Presume you have line (vector) defined by the points {{{vStart}}}, {{{vEnd}}}.  You have a point {{{somePoint}}} living off in space.  You want to find the closest point on the line to the point off in space.  As it turns out, this point defines a vector from {{{somePoint}}} to the line which is perpendicular to the line.
http://download.autodesk.com/us/maya/2011help/API/class_m_vector.html
{{{
# Python code
from maya.OpenMaya import MVector

# point off in space
somePoint = MVector(5,7,0)

# start and end of our line:
vStart = MVector(0,0,0)
vEnd = MVector(10,10,0)

# Vector of our line from start to end
vStartEnd = vEnd - vStart
# Find our line length:
vStartEndLen = vStartEnd.length()
# Normalize our line vector length:
vStartEnd.normalize()
# Vector from the start of our line to the point in space:
vStartToPoint = somePoint - vStart

# * = dot product.  This is the distance along our vStartEnd
# where the new point will live.
projectLen = vStartToPoint * vStartEnd

# Find the new point position.  Here, * is multiply,
# since projectLen is a float, not a MVector.
newPoint = vStartEnd * projectLen + vStart

# Bonus:  Track if this point lies within the bounds of our line.  Picture a cylinder
# with infinite radius surrounding our line.  Does the point fall in that?
if projectLen < 0 or projectLen > vStartEndLen:
print "Out Of Bounds:", newPoint.x, newPoint.y, newPoint.z
else:
print "In Bounds:", newPoint.x, newPoint.y, newPoint.z
}}}
{{{
In Bounds: 6.0 6.0 0.0
}}}
You can use....
*The API class method {{{MFnNurbsCurve.closestPoint}}}
*The node [[nearestPointOnCurve|http://download.autodesk.com/global/docs/maya2012/en_us/Nodes/nearestPointOnCurve.html]]
*The node [[pointOnCurveInfo|http://download.autodesk.com/global/docs/maya2012/en_us/Nodes/pointOnCurveInfo.html]]
**This node can be created via the [[pointOnCurve|http://download.autodesk.com/global/docs/maya2012/en_us/CommandsPython/pointOnCurve.html]] command.
I recently ran into this problem:  I had code written that would snap one object to another via their matrices quite successfully.  I was using this in a rigging 'snap' tool.  Then, the design of the rig changed, and there became an offset needed between the source and target nodes (in my case some rotational values).  Since matrices are such nice things to use for transformational snapping, I wanted to keep using this method, but needed a way to calculate the difference of two matrices, store that value, then later re-apply it after the snap to make my target have the same relative transformations to the source based on their initial state.  This is hard to describe, so here's the proof of concept example I came up with:
*Two nodes (cubes) in Maya.
*Transform them both to some new location in space (both in the same location).
*Now apply an //additional// transformation to the target node... maybe a rotational offset?
Our goal is to allow us to transform the source to any new value, and have the target match the new transformation with relative offset previously assigned.  Meaning, if you'd rotated the target cube 90 deg's off from the source, wherever we transform the source, we want the target to match, rotated the same 90 deg's off.

----
This is all implemented through Python, and the code for the imported {{{matrixutils}}} module can be found in my subject [[here|Working with matrices with Python]].  It accesses the API's (~OpenMaya) {{{MMatrix}}} object and provides wrapper code for using it in Python.
{{{
# Python code
import maya.cmds as mc
import matrixutils as matrix

# Setup names for our source node, and our target node.
source = 'src'
target = 'dest'
}}}
As described above, transform both nodes to some location in space.  Then apply an additional transformation to the target.
Find the worldspace inverse matrix of our source object, and the worldspace matrix of our target:
{{{
srcWorldInverseMatrix= matrix.getMMatrix(source, 'worldInverseMatrix')
targetWorldMatrix= matrix.getMMatrix(target, 'worldMatrix')
}}}
Create the difference matrix.  This is done by multiplying the target world matrix by the source world inverse matrix... sort of like subtracting the source from the target to find the difference:
{{{
differenceMatrix =  targetWorldMatrix * srcWorldInverseMatrix
}}}
Set target to the difference matrix, just for visualization:  Should snap it to (or near, depending on the initial difference between the nodes) the origin, showing the difference in trans, rot, scale, and shear vals that were stored:
{{{
matrix.matrixXform(target, differenceMatrix, 'worldSpace')
}}}
Now move the source node somewhere new in the Maya scene.
Execute this code to find the //new// source worldspace matrix:
{{{
newSrcWorldMatrix = matrix.getMMatrix(source, 'worldMatrix')
}}}
Finally move our target to the new location, with the {{{differenceMatrix}}} applied.
{{{
offsetMatrix = differenceMatrix * newSrcWorldMatrix
matrix.matrixXform(target, offsetMatrix, 'worldSpace')
}}}
It should snap to the new location of the source node, but have the additional difference matrix applied, putting it into the same relative state that was originally captured.

I'd been looking for a LONG time, trying to find an IDE for Python that mirrored //one// important feature from Maya's Script Editor:  ''Evaluate Selection'', which is the ability to @@highlight blocks of code@@, and execute just that code block interactively.

//Maya's// implementation of Python in the Script Editor can do this (since version 8.5), but what if you want to author Python //outside// of Maya, but still have this functionality?

After asking a lot of people, and doing a lot of searching, I finally found Wing:
http://www.wingware.com/
[img[https://wingware.com/images/wingide2-personal-screenshot-qtr.png]]
''Wings docs on integrating with Maya'' [[here|http://www.wingware.com/doc/howtos/maya]] (which actually links back to this wiki :-) )
It has three versions:
*Wing IDE 101 (free, but //doesn't// have 'Evaluate Selection')
**Update:  It appears you can hack it:  I saw this post in a forum, from Wingware itself:
<<<
It looks like the keyboard config pref is omitted in 101.  You could
hack it by editing the keyboard.normal file in the Wing installation
and adding:
{{{'Ctrl-F5': 'evaluate-file-in-shell'}}}
Or to evaluate the current selection:
{{{'Ctrl-Shift-F5': 'evaluate-sel-in-shell'}}}
You'll need to restart Wing to read those and you can of course alter
the bindings.  Also, if you're using one of the other keyboard
personalities you should edit the associated keyboard.* file instead.
<<<
*Wing IDE Personal ($35) *Wing IDE Professional ($179 - Lets you access the Wing API via Python, to write your own plugins for the tool + other features)
----
Compare version features:
http://www.wingware.com/wingide/features
----
@@Interaction With Maya@@:
*I've come up with three different ways that allow Wing to interact with Maya and vice-versa (Maya Script Editor replacement, Remote debugging Maya data in Wing, Run Maya in Wings Python shell).  See that subject here:
**[[Interaction between Wing and Maya]]
----
Notes:
*Wing itself runs a different version of Python than you may have installed.  The current version of Wing (as of this update) runs Python 2.5.4.  This is only really important if you get the "Pro" version, and start making your own 'plugin scripts':  The plugins you author will be running Wings version of Python, not your installed version of Python.  Furthermore, the Wing distribution isn't the full install of Python, so not all modules are available.  This isn't a huge deal, but it's important to be aware of if your plugins don't work.  For example, I had one that called to the {{{webbrowser}}} module:  That module isn't distributed with Wing.  Luckily, they have their own function ({{{wingapi.gApplication.OpenURL(url)}}}) that could be used in its place.
----

Presuming you know the name of your camera, and the name of the panel:
{{{
modelPanel -e -cam $camera$panel;
}}}
And if you need to know the name of the currently active panel:
{{{
string  $panel = getPanel -withFocus; }}} or: {{{ string$panel = playblast -activeEditor;
}}}
{{{playblast}}} has the advantage of always returning back a {{{modelPanel}}}: The {{{getPanel}}} command can return back other editor types that may be active.
Also see:
*[[How do I query the name of the camera in the active panel?]]
Had to do some hoop-jumping to get "[[pywin32|http://sourceforge.net/projects/pywin32/]]" working in Maya.  Here's what started the whole shebang:
*Wanted to have Maya control Photoshop.  You can do this via the aforementioned package.
*I'm using Maya2010 64-bit (Win7), with the 64-bit cut of Python 2.6.
*My system-level Python is 32-bit, 2.6.
*When you install {{{pywin32}}}, it installs into the root Python {{{\site-packages}}} folder, which is entirely different from the one Maya's cut of Python uses.
*Furthermore, it doesn't install under a single package dir:  It creates a lot of dirs and loose files, pretty messy.
These were the steps I went through to get it working in Maya:
#Download the {{{pywin32-216.win-amd64-py2.6.exe}}} cut:  This is the 64-bit cut of the package that will match up with Maya's 64-bit cut of Python.
##http://sourceforge.net/projects/pywin32/files/pywin32/Build216/
#Presuming you already have other pre-existing site-packages installed, rename Python's default {{{C:\Python26\Lib\site-packages}}} dir to {{{C:\Python26\Lib\site-packages-old}}} before the install:  When then install runs, it will create a new {{{\site_package}}} dir.
#Run the downloaded package executable.  When complete, the new {{{C:\Python26\Lib\site-packages}}} dir will be populated with the new (messy) package contents.
#Copy all of that new stuff to Maya's site-package dir here: {{{C:\Program Files\Autodesk\Maya20XX\Python\Lib\site-packages}}}
#Delete the new {{{C:\Python26\Lib\site-packages}}} dir.
#Rename the old dir {{{C:\Python26\Lib\site-packages-old}}} back to {{{C:\Python26\Lib\site-packages}}}.
#Launch Maya, and in the script editor, execute:
{{{
import win32com.client
}}}
It should work without a hitch.
And continuing our Photoshop example, launch Photoshop from Maya:
{{{
photoshop = win32com.client.Dispatch("Photoshop.Application")
}}}
Blam.
----
Other notes:
*It appears that you //must// put the {{{pywin32}}} package contents in Maya's {{{/site-packages}}} dir:  I tried other package paths I had defined, but they didn't work.  This package comes with a {{{pywin32.pth}}} file.  According to the docs for the Python [[site|http://docs.python.org/library/site.html]] module, {{{.pth}}} files are only recognized when they live in one of four special directories.
----
Also see:
*[[Control Photoshop from Maya]]
{{{basename}}}
{{{dirname}}}
Say you have a selection of verts, and it's important you process the odd and even numbered verts differently.  How can you generate those two lists?

{{{
// get our vert list:
string $sel[] = ls -fl -sl; // make our buckets string$odd[];  clear $odd; string$even[];  clear $even; for($i=0;$i<size($sel);$i++) // print$sel[$i] { // get just the END number, inside of brackets: string$endNum = match "\$[0-9]+\$$"$sel[$i]; // just num without brackets: int$justNum = match "[0-9]+" $endNum; // if we divide in half, do we have a remainder? Magic with the modulus operator: float$remainder = $justNum%2; if($remainder)
$odd[size($odd)] = $sel[$i];
else
$even[size($even)] = $sel[$i];
}

print $even; print$odd;
}}}
would result something like:
{{{
...
pSphere1.vtx[240]
pSphere1.vtx[260]

pSphere1.vtx[143]
pSphere1.vtx[163]
...
}}}


Thanks to Eric Vignola
*Multiply the unit-vector by the distance, and add that to your original point:
{{{
vector $point = <<1, 1, 0>>; vector$vector = <<1, 1, 0>>;
float $distance = 2; vector$result = ($point + (unit($vector)* $distance)); // Result: <<2.414214, 2.414214, 0>> // }}}  {{{filterExpand}}} *Example, given a selection of polygon and nurbs surfaces, generate a list of only the polygon surfaces: {{{ filterExpand -sm 12; }}} {{{ string$inf[] = listConnections "skinCluster1.matrix";
}}}
Check out the replaceNode.mel script. Located here:
{{{
.../MayaX.X/scripts/others/replaceNode.mel
}}}
''The Mel Wiki Guest Book''
Since this wiki isn't opening to public editing (got too much spam), please email me your guest book entry, and I'll post it!  -- {{{warpcat}}} (at) {{{sbcglobal}}} (dot) {{{net}}} --
Please use this format in your mail:
{{{
Name\Handle:  Joe Bobson
Email (optional): joebob@bob.com
Comment:  Wow, what a great wiki!
}}}
----
----
----
Date: Feb 08, 2010
Name: Zhi Min Chen
Comment:  Great website.  I use it on a regular basis to help me on most my projects at work.  Your wiki's question format is very well thought out and it makes finding answers extremely quick.  Keep up the great work!
----
Date: Aug 15, 2008
Name: Ben Brac
Email: brac@sonic.net
Comment: Awesome wiki ~WarpCat! I use it all the time when the usual documentation leaves much to be desired. Keep the updates coming!
----
Date:  Aug 06, 2008
Name:  Bob Aunum
"Thank you sincerely.  The subject says it all. since i decided to teach myself mel,  i've been looking for a good web resource, but i really didn't expect to find anything as elegantly functional as your wiki.  It's great. Really."
----
Date:  May 19th, 2008
Name:  Fridi Kühn
I am a student from Germany and have recently started helping a games developer to automate their process of animating.  Since I am a beginner to MEL I wanted to state that your mel wiki helped me alot to overcome the mysteries of that language.  I just wanted to thank you for your website and hope you will keep it alive! Please know that I will frequently return and see what's new...
----
<<timeline>>
Had a really weird bug where whenever the hotbox was shown, it will take a 'screen capture' of the previous window inside it.

Come to find out, on Windows 7, if you have it's theme set to 'classic mode', it causes this problem. If you set it back to 'Areo', it seems to resolve.
{{{lockNode}}}

Note:  This is a different kind of "lock"than a "reference" node, which is read-only, or certain system nodes (like lightLinkers) that are read-only.

Requested\suggestion from Matti Grüner:

You can use the {{{addRecentFile.mel}}} script that comes with Maya.  Lives here by default:
{{{
C:\Program Files\Autodesk\Maya<VERSION>\scripts\others\addRecentFile.mel
}}}
Easy to call to via mel:
{{{
addRecentFile(string $file, "mayaAscii"); // or "mayaBinary" }}} If that succeeded, and you go to {{{File -> Recent Files -> }}}You should see the newly added entry. ---- If you want to do this in Python: {{{ import maya.cmds as mc import maya.mel as mm # Open the file! openMe = r'c:\some\awesome\file.ma' mc.file(openMe, open=True, force=True) # Then update the menu! fileType = '' if openMe.endswith('.ma'): fileType = 'mayaAscii' elif openMe.endswith('.mb'): fileType = 'mayaBinary' # Must convert slashes before calling to the mel: mm.eval('addRecentFile("%s", "%s")'%(openMe.replace('\\', '/'), fileType)) }}} Insert on a PC appears to be 'function+left arrow' on a Mac. :-S If the Outliner is active, you can use the //mel procedure//: {{{ fitPanel -selected; }}} Which lives here: {{{ C:\Program Files\Autodesk\Maya20XX\scripts\others\fitPanel.mel }}} I knew this worked for cameras, but didn't know it worked in an {{{outlinerPanel}}} \ {{{outlinerEditor}}} as well. It appears this is the default '{{{f}}}' hotkey... went for many years without knowing this... ---- If the Outliner isn't active, and you want to force this via code through say a custom hotkey: {{{ import maya.cmds as mc # Name of the default Outliner: outliner = "outlinerPanel1" mc.setFocus(outliner) mc.outlinerEditor(outliner, edit=True, showSelected=True) }}} {{{setFocus}}} isn't needed, but it doesn't hurt either. In Python, this concept is handled by the {{{reload}}} command. The first time you {{{import}}} a module (Python's equivalent of a mel script), its loaded in memory. No amount of re-importing will change it in memory. If you make changes to your module //after// its imported, you need to use {{{reload}}} to update it in memory: {{{ import myModule # do work reload(myModule) }}} (Suggested addition by Chris Mills) >See [[How can I find all instanced nodes in the scene?]] for an updated version. ---- Update: As of Maya 2010, there is a Run Time Command called: {{{ ConvertInstanceToObject }}} ...that will do this. I'm not too sure when this was introduced. In in turn calls to the global procedure: {{{ convertInstanceToObject() }}} ...which is found in the mel script: {{{ C:\Program Files\Autodesk\Maya2010\scripts\others\convertInstanceToObject.mel }}} It should be noted that running this is destructive: If the instance has any children with any kind of connections, those connections will be lost as part of the procs duplication\deletion operation. The code I have below works around this issue, in a non-destructive way: ---- Maya seems to provide no easy way to 'uninstance' a shape node, once instanced. This has caused a lot of frustration. The common solution I've seen is to simply duplicate the instance, delete the old one, and rename the duplicate. This is fine, unless there is something parented to the instanced node. The below code jumps through a lot of hoops, but it does so as to not delete the original transform the instance shape node is associated with. In a nutshell: *Find the shape node *Make a dummy shape (mesh) and associated transform *Parent the dummy shape to the same parental transform as the instance. This is silly, and important, so we can get rid of the instance, and not have Maya also delete the transform. *Parent the instance shape to the dummy transform *Duplicate the dummy transform (and thus duplicating the instance shape) *Parent the new uninstanced shape back to original transform *Delete all the dummy stuff. It's still a lot more steps than it should be... {{{ // To start: Select the instanced objects // Get a list of all of our objects string$sel[] = ls -l -sl;
for($i=0;$i<size($sel);$i++)
{
// get a list of the current children of our selection:
string $kids[] = listRelatives -f -s$sel[$i]; for($j=0;$j<size($kids);$j++) { // create a dummy mesh: a dummy shape node, and find its parent name string$dum = createNode mesh -name instanceDummy;
string $dumPare[] = listRelatives -p$dum;
// parent that dummy shape to our current object.  This lets us later
// unparent the instance, and not have the object delete itself.
parent -s -r $dum$sel[$i]; // Now parent the instance under our dummy node, and delete it. string$reParent[] = parent -s -r $kids[$j] $dumPare[0]; // print$reParent[0]
delete $dum; // duplicate the instance shape node (that was just reparented a moment ago), // and then parent the new, uninstaned shape, back to the original parent. string$newShapeParent[] = duplicate -rc $reParent[0]; string$newUninstancedShape[] = listRelatives -s -f $newShapeParent[0]; parent -s -r$newUninstancedShape[0] $sel[$i];

// finally, clean up by deleting the dummy parent node, and the transform left over
// from the duplication of our shape node
delete $dumPare; delete$newShapeParent;
}
}
}}}
In the Maya Menu, you can execute:
*Modify -> Evaluate Nodes -> Evaluate All \ Ignore All
To enable\disable certain types of node evaluations.  Those node types include:
*constraints, expressions, fluids, globalstitch, iksolvers, particles, rigidbodies, & snapshots.
But what code does that UI actually call to?
The UI calls to two maya {{{runTimeCommand}}}s:
{{{
EnableAll;
DisableAll;
}}}
{{{runTimeCommand}}}s are simply small wrappers for other bits of mel.  Those {{{runTimeCommand}}}s actually execute:
{{{
// DisableAll:
doEnableNodeItems false all;
// EnableAll:
doEnableNodeItems true all;
}}}
{{{doEnableNodeItems}}} is a "startup" mel script found below.  That means (to my understanding) that it is executed every time Maya starts up.
*{{{../Maya7.0/scripts/startup/doEnableNodeItems.mel}}}
But this mel script is mainly just a wrapper for this one:
*{{{../MayaX.X/scripts/others/setState.mel}}}
So while you could call to any of the mel listed above to do this, the cleanest way is to call to {{{setState}}}. It's arguements are:
{{{
setState(string $type, int$state);
}}}
The acceptable $types are (as listed above): *{{{"all"}}} *{{{"constraint"}}} *{{{"expression"}}} *{{{"fluid"}}} *{{{"globalstitch"}}} *{{{"iksolver"}}} *{{{"particle"}}} *{{{"rigidbody"}}} *{{{"snapshot"}}} Note that I have found that if the code tries to set the state on something that is "locked" it will fail. This will also fail at Maya startup, which is bad news. For example, one time I had locked a particle shape node's ".isDynamic" attribute. Whenever I'd later open that rig file, none of the constraints would evaluate, since the code to enable their evaulation at startup would crash. Crazy.  There is a handy command for this: {{{toolPropertyWindow}}} ---- Also see: *[[I want to add a UI to the tool settings window, how do I do that?]] Maya 2011(?) introduced the {{{fileDialog2}}} command that supplants the {{{fileBrowserDialog}}}. It has a option on the left for 'folder bookmarks', and for the longest time I couldn't figure out how to update that field. As it turns out, you just drag-and-drop a folder into that field to make a bookmark. That's it. {{{ # Python code import maya.cmds as mc node = 'myNode' colorAttr = 'color' defaultColor = [.9,.9,.9] mc.addAttr(node, longName=colorAttr, attributeType='float3', usedAsColor=True) mc.addAttr(node, longName='%sR'%colorAttr, attributeType='float', parent=colorAttr, defaultValue=defaultColor[0]) mc.addAttr(node, longName='%sG'%colorAttr, attributeType='float', parent=colorAttr, defaultValue=defaultColor[1]) mc.addAttr(node, longName='%sB'%colorAttr, attributeType='float', parent=colorAttr, defaultValue=defaultColor[2]) }}} In this example, I'll add a multi attr of type 'message' to a {{{null1}}} node, and then start connecting the message attrs of other nodes to it: {{{ # Python code import maya.cmds as mc mc.addAttr('null1', longName='myMulti', attributeType='message', multi=True ) mc.connectAttr('object1.message', 'null1.myMulti[0]') mc.connectAttr('object1.message', 'null1.myMulti[1]') }}} To get a list of which attr indices are currently in use, and their values: {{{ # indices are in the form of ["myMulti[0]", "myMulti[1]", etc...] indices = mc.listAttr('null1.myMulti', multi=True) for i in indices: print "null1."+i, " --> ", mc.listConnections('null1.'+i)[0] }}} {{{ null1.myMulti[0] --> object1 null1.myMulti[1] --> object2 }}} Notice how you use {{{listConnections}}}, not {{{getAttr}}} to query {{{message}}} attributes? ---- Also see: *[[How can I get a list of all the child multi-attrs, of a given attr name?]] First, you need to get the existing names: {{{ string$enumAttrs = addAttr -q -enumName "myNode.myEnumAttr";
"enumA:enumB:enumC"
}}}
Then you can append your new attr to those names, and add:
{{{
string $newEnumName = "enumD"; addAttr -e -enumName ($enumAttrs + ":" + $newEnumName) "myNode.myEnumAttr"; }}} ---- Same thing in Python: {{{ import maya.cmds as mc enumAttrs = mc.addAttr("myNode.myEnumAttr", query=True, enumName=True) newEnumName = "enumD" mc.addAttr("myNode.myEnumAttr", edit=True, enumName='%s:%s'%(enumAttrs,newEnumName)) }}} {{{scriptedPanel}}}s seem like magical things: Popping between UI's, docking in the UI and floating on top. How can you easily add one to your own UI? If they're already authored by Maya, it's a simple act of finding the name, then adding it to your own UI with the {{{scriptedPanel}}} command. Below, I create a window that has both a graph editor and the dope sheet, with a time-slider below them. And, it's actually really easy. How can you find the names of the existing scriptedPanels? In the Script Editor, turn on "echo all commands". Then pop off a window you want to use in your own ui. It should print a bunch of stuff, including a line like this: {{{ addDopeSheetPanel dopeSheetPanel1; }}} In this case, "{{{dopeSheetPanel1}}}" is the name of the scriptedPanel we care about, and can now embed into our own UI: {{{ # Python code: import maya.cmds as mc class App(object): """ Create the Maya UI object. """ def __init__(self): self.name = "scriptedPanelTest" self.title = "scriptedPanel test" if mc.window(self.name, exists=True): mc.deleteUI(self.name) mc.window(self.name, title=self.title, resizeToFitChildren=True) form = mc.formLayout() self.paneLayout = mc.paneLayout( configuration='horizontal2' ) mc.scriptedPanel( 'graphEditor1', e=True, parent=self.paneLayout) mc.scriptedPanel( 'dopeSheetPanel1', e=True, parent=self.paneLayout) mc.setParent(form) self.timePort = mc.timePort() mc.formLayout(form, edit=True, attachForm=[(self.paneLayout, "top", 1), (self.paneLayout, "left", 1), (self.paneLayout, "right", 1), (self.timePort, "left", 1), (self.timePort, "right", 1), (self.timePort, "bottom", 1)], attachControl=[(self.paneLayout, "bottom", 0, self.timePort)]) mc.showWindow() App() }}} Just like anything else: {{{ sets -add setName object.attribute; }}} It's fun to add images to your UI's, but the biggest problem is when you give your UI to someone else, usually the hard-coded paths to the imagery break. !!!Python One nice thing about authoring modules in Python is they come with a 'special' {{{__file__}}} attribute. This can let the module itself (or any module that calls to it) know its save location. If you store your images in the same directory as the module, you're good to go. In the below example, presume there is a {{{smiley.bmp}}} image saved in the same directory as the module: {{{ # iconTextButtonTest.py import os import maya.cmds as mc class App(object): def __init__(self): # define save location of this module: self.path = os.path.dirname(os.path.abspath(__file__)) if mc.window(self.name, exists=True): mc.deleteUI(self.name) self.window = mc.window(self.name, resizeToFitChildren=True) self.rootLayout = mc.columnLayout(adjustableColumn=True, columnAttach=('both', 5)) # Create icon based on relative path: self.button = mc.iconTextButton( style='iconOnly', image=os.path.join(self.path, "smiley.bmp")) mc.showWindow() App() }}} !!!Mel A older mel convention I've used is this: Author an "image finder" script, and save it in the same dir as your images. You can then use that script to define your image path during UI creation. {{{ // save this as imageFinder.mel, and save it in the same directory as your images. global proc string imageFinder() { string$description = whatIs imageFinder;
string $path = substitute "Mel procedure found in: "$description "";
string $dir = dirname($path);
return $dir; } }}} Now, inside of your UI, you can call to this script to find the location of your images, and embed that path at UI creation time: {{{ // UI code here...... string$imagePath = imageFinder;
string $image = ($imagePath + "/foo.bmp");
image -image $image -h 128 -w 128; // finish UI code.... }}} Notes: *This is just and example: You will need a uniquely named "imageFinder.mel" script for each directory you'll be searching for images in. I usually name them based on the script that is calling to the images. *The first time you enter the 'imageFinder' script in Maya, it won't work when called to, since Maya will think the imageFinder //procudrue// was 'entered interactively'. You'll either need to call the {{{source}}} command on the imageFinder script after it's been saved, or simply restart Maya. It will work from that point on. *You can use this same technique to have a script's "help" menu\button point to a 'help.html' file; again, with non hard-coded paths. ---- *Also see [[How can I have a script return where it lives on disk?]] *{{{skinCluster}}} : name of a given {{{skinCluster}}} node. *{{{joints}}} : List of joints {{{ # Python code import maya.cmds as mc mc.skinCluster(skinCluster, edit=True, addInfluence=joints) }}} Say you have a set hierarchy in the Outliner, and you want to quickly pick one or more sets, add select one or more objects, and add the selected objects to the selected sets. Maya has the 'Sets Relationship Editor', but I find it's implementation very clunky. {{{ # Python code import maya.cmds as mc sel = mc.ls(selection=True) nodes = [] sets = [] for item in sel: if mc.objectType(item) == "objectSet": sets.append(item) else: nodes.append(item) for s in sets: mc.sets(nodes, addElement=s) }}} A slightly different way: Add selected items to the single selected set. If more than one set is picked, error. Done in ~PyMel: {{{ # Python / PyMel import maya.OpenMaya as om import pymel.core as pm sel = pm.ls(selection=True) allsets = [] nonset = [] for item in sel: if isinstance(item, pm.nt.ObjectSet): allsets.append(item) else: nonset.append(item) if not len(allsets)==1: om.MGlobal.displayError("Please select exactly one set node") else: pm.sets(allsets[0], forceElement=nonset) print "Added items to set '%s':"%theset, [item.name() for item in nonset] }}} {{{select}}} Example: Using a wildcard: {{{ select "foo*"; }}}  In the Attribute Editor for materials, there is a field for "Hardware Texturing". In that field, there is an option to adjust the "Texture resolution". It makes it //look// like this is a //material// property, but in fact, this is done on the '//texture// node level'. >Note: When I first authored this years ago, that may have been the case. But it looks like Maya has now moved this to be a material property. When you adjust that UI drop-down, Maya is actually calling to this proc: *{{{AEhardwareTextureQualityCB}}}, which lives in this script: *{{{../MayaX.X/scripts/AETemplates/AEhardwareTextureTemplate.mel}}} That code does all the magic to make this happen. But if you want to do this on your own, you'd need to: <<< New method: *For the material, you'd need to add a new {{{.resolution}}} attr, and then update it's value. Like below (how the actuall ~MayaAscii stores it). <<< <<< Old method *Find all the "texture" nodes that are connected to a material. This could be file, ramp, noise, etc. ({{{ls -tex}}}) *For each node, you'd need to add a new {{{.resolution}}} attr, and then update it's value. Like below (how the actuall ~MayaAscii stores it). <<< What's interesting, is that as soon as that attr exists, you'll see the "resolution" of the texture change in the viewport. Maya must have some scriptJob running that detects for it(?) {{{ addAttr -ci true -sn "resolution" -ln "resolution" -dv 128 -at "long"; }}} The {{{-dv}}} (default value) is what the new resolution should be. If you set the resolution to "default" in the Attribute Editor, it seems to actually delete the attr completely. The other values are powers of two: *Low: 32 *Med: 64 *High: 128 *Highest: 256 I wonder if you can enter in higher vals... (haven't tried yet) What is interesting: Open the Attribute Editor for a given texture node, and "copy tab" (at the bottom of the UI) to rip off a dupe of it, expand the "Extra Attributes" field. If you then go back to the material's Attribute Editor, and start changing the Hardware Texturing values, you'll see the new attributes get built on the fly on the texture node. Nifty. The {{{controlPoint}}} node (a parental node type of {{{nurbsCurve}}}) has a {{{.weight[]}}} array attr. Each index of that array corresponds to a CV on the curve. The default weights are 1.0 I believe. {{{ setAttr curveShape1.wt[0] .5; }}} I've been told if there is history on the curve, it can reset the values, FYI. After you create a {{{parentConstraint}}}, Maya gives you no easy way to adjust their offset values per the attribute editor. But you still can of course: {{{ setAttr ($pareCon + ".tg[0].tot") -type "double3" 0 2 0;
setAttr ($pareCon + ".tg[0].tor") -type "double3" 0 0 45; }}} {{{.tg}}} is the target list. In the above example, I'm adjusting the offset of the first target. {{{.tot}}} is for offseting translation, and {{{.tor}}} for offsetting rotation. The {{{animView}}} command will let you adjust the start\end time (x-axis), and the min\max value (y-axis) of an {{{animCurveEditor}}} (Graph Editor). The docs say these values can be queried as well, but via mel it does nothing, and via Python I get a {{{RuntimeError}}}. See: [[Why does adding an item to a Maya main menu remove all the items?]] When you RMB in the Graph Editor, a context sensitive menu pops up. How can you append your own items to this? Actually, I have yet to figure out how, and here's why: The script {{{ C:\Program Files\Autodesk\Maya20XX\scripts\others\graphEditorPanel.mel }}} Holds all the code the creating these menus. The proc {{{buildGraphEditorPopupMenuGeneral()}}} specifically is what creates the menu items, and the parental menu's name is {{{graphEditor1GraphEdanimCurveEditorMenu}}}. The issue is, the proc {{{buildGraphEditorPopupMenu()}}} is called whenever the RMB is clicked in the Graph Editor, and it firsts deletes all the menu items, then rebuilds them. So even if you write some code like this to add your own menu item: {{{ setParent -menu graphEditor1GraphEdanimCurveEditorMenu; menuItem -divider true; menuItem -label "AWESOME"; }}} You'll never actually see it, since it will be deleted before the menu is rebuilt for display. The proc {{{defineGraphEditorPopupMenu()}}} physically creates the actual {{{popupMenu}}} that houses the various menu items. In //theory// this proc could be overridden to point to your own {{{popupMenu}}} creation code. The time slider menu's name is {{{TimeSliderMenu}}}. However, if you start appending items to it before the user has first clicked on it, all the standard menu items will be replaced with yours. This issue is described here: [[Why does adding an item to a Maya main menu remove all the items?]] The workaround for the time slider is a bit different than the main menu. There is a script (and global proc) called {{{ C:\Program Files\Autodesk\Maya20xx\scripts\others\TimeSliderMenu.mel }}} When you execute the {{{TimeSliderMenu}}} global proc, it in turn calls to another global proc in that file called {{{updateTimeSliderMenu}}} which actually builds the menu. You need to do these steps first before you add your own items: {{{ source TimeSliderMenu; updateTimeSliderMenu TimeSliderMenu; setParent -menu TimeSliderMenu; menuItem -l "My Awesome Menu"; }}}  Maya is a //statically typed// language (like c++, Java), meaning, when you declare a variable, you have to define what //type// of data the variable is. {{{string$s}}}, {{{int $i}}}, {{{float$nums[]}}} etc.  Python (like Ruby) is an example of a language that is //dynamically typed//:  The type of the data is a part of the stored object, and has nothing to do with the variable name.  The variable name is simply a pointer to a memory location which defines what type of data it is.

You can run into instances in mel where you may need to capture data, but you're not too sure what //type// of data the source is.  An example of this is accessing Maya's {{{optionVar}}} system, which makes a good example.

{{{optionVar}}}s are variables stored on disk, usually for UI preferences.  But you can use them for anything else you need to stay persistent between Maya sessions.  I use them... a lot.  But you can run into instances in your code where you may make an optionVar of 'type string', and then later turn it into a 'string array'.  This is a blessing, an a curse: While {{{optionVar}}}s //are// typed, you can change their type at any point - they're just text stored on disk that can be modified at any point.  But if you want to pull that data into your mel scripts, and the type ihas changed, you can obviously run into problems.

In //Python//, this is a non-issue (see example at bottom).  But in mel this is a big issue.  The below example explains it:

Make a optionVar of type string, called 'ovString', and filled with the text 'firstItem':
{{{
optionVar -stringValue ovString firstItem;
string $str = optionVar -q ovString; // Result: firstItem // }}} Remove it from disk: {{{ optionVar -remove ovString; }}} Remake ovString, but this time make it an array by default: {{{ optionVar -stringValueAppend ovString firstItem; string$str = optionVar -q ovString;
// Error: line 1: Cannot convert data of type string[] to type string. //
}}}
Now our code can't capture its value, since its a string array, and not type string.

To address this, we can make a procedure that can {{{catch}}} problems, and based on the result handle them.  In this case, the code tries to pass a {{{optionVar}}} into a //string array//.  If that fails, it knows it must be of type //string//, and acts accordingly.
{{{
global proc string varTest(string $optionVar){ // define our return value string$stringVar;

// try to turn our optionvar into a string array, catch if fail:
int $bad = catch(eval("string$temp_array[] = optionVar -q "+$optionVar+"")); if($bad){
// failed, this must be a string then
$stringVar = optionVar -q$optionVar;
}
else{
// didn't fail, this must be a list
string $local_ov[] = optionVar -q$optionVar;
$stringVar =$local_ov[0];
}

// return our single string
return $stringVar; } }}} Lets see if it works: {{{ string$str = varTest("ovString");
// Result: firstItem //
}}}
Even though the {{{optionVar}}} ovString is of type string array, our code catches the error, and processes the data correctly.

I should also note that Maya has the {{{whatIs}}} command, to tell you what type a variable is:
{{{
whatIs("$str") // Result: string variable // }}} ---- For comparison, here's the same thing in Python, showing the dynamic typing at work: {{{ # Python code import maya.cmds as mc mc.optionVar(stringValue=('ovString', 'firstItem')) str = mc.optionVar(query='ovString') # firstItem }}} Above, variable {{{str}}} points to a {{{string}}} object, with value "firstItem" {{{ # delete optionVar mc.optionVar(remove='ovString') }}} Now remake our {{{optionVar}}} as a string array (Python list object): {{{ mc.optionVar(stringValueAppend=('ovString', 'firstItem')) str = mc.optionVar(query='ovString') # [u'firstItem'] }}} Now, based on Python dynamic typing system, the {{{str}}} variable points to a {{{list}}} object (emulating Maya's array type). The {{{list}}} object holds one {{{string}}} object at index {{{[0]}}}, which value is "firstItem". So much easier to deal with than mel ;) Like in mel, Python also has a command to tell you what type of object a variable points to: {{{ type(str) # Result: <type 'list'> # # query the string inside of the list: type(str[0]) # Result: <type 'unicode'> # }}}  Whenever you ctrl+shift ~LMB-click on a menu item in one of Maya's main menus, it'll add that command as an {{{shelfButton}}} in the active shelf (via the mel proc {{{menuItemToShelf}}}). You can add your own menus to Maya's main menu as well, for easy user access. If you add these menus via Python, and if the commands they call to are via Python, depending on how the commands are authored they won't later work when assigned to the shelf via ctrl+shift ~LMB-click. The below code examples explain how to author them so they //will// work after Maya restarts. In the below example, three files are authored: One that holds a command to execute, one that builds the Maya menu, and another that then creates the menu. Make sure they're saved in a directory that is part of Maya's Python path. ---- This creates a command to execute, that needs to be passed multiple arguments: {{{ # someModule.py import maya.cmds as mc def someCommand(*args): # A function that can take multiple arguments. print "Executing someCommand():" print "\t", args }}} This code creates the menu, and menuItems that passe multiple arguments to our command: {{{ # awesomeMenu.py import someModule def makeMenu(): if mc.menu("myAwesomeMenu", query=True, exists=True): mc.deleteUI("myAwesomeMenu") mc.menu("myAwesomeMenu", parent="MayaWindow", label="My Awesome Menu", tearOff=True) mc.menuItem(label="Bad command to shelf", command=lambda *args:someModule.someCommand("A","B","C")) mc.menuItem(label="Good command to shelf", command='import someModule; someModule.someCommand("A","B","C")') }}} This code actually builds the menu. Could be added to the {{{userSetup.py}}} so the menu is built every time Maya launches: {{{ # userSetup.py (for example) import awesomeMenu awesomeMenu.makeMenu() }}} ---- *Execute the bottom code in whatever way you see fit: A new menu will appear in Maya's main menubar. *Make sure you have a shelf open: ctrl+shift ~LMB-click on both menu-items to create shelf buttons. If you press both shelf buttons they should both work. *Restart Maya, press the shelf buttons again: The one created via "Bad command to shelf" should give you some type of error like this: {{{ <function <lambda> at 0x0000000022BEC2E8> # Error: invalid syntax # File "<maya console>", line 2 # <function <lambda> at 0x0000000022BEC2E8> # ^ # SyntaxError: invalid syntax # }}} *It's often very convenient to wrapper command callbacks via a Python {{{lambda}}}, since it allows you to embed arguments into it on the fly, without having to hard-code them as a string. Problem is, the anonymous function it generates to wrapper the command is only valid during the current Maya session: When Maya restarts, that memory has been reclaimed, the function no longer exists. *Pressing the shelf item authored via "Good command to shelf" should work correctly, printing out the given text assigned to it at creation: {{{ ('A', 'B', 'C') }}} *It works because of a few specific things: **The command is entirely embedded as a string: It can be re-evaluated as a string successfully, no anonymous {{{lambda}}} function floating around in memory. **It embeds the module import directly in the command-string: If that import wasn't in there, there's a good chance the module wouldn't have yet been imported into proper scope, and it wouldn't know how to execute the given function. *The downside to the command-string is that it looses the capacity to have dynamically changing variables assigned to it (like the {{{lambda}}} allows)... but in my experience this isn't very common, and in most cases probably worth the trade-off if the users want easy access to the commands.  [img[http://farm3.static.flickr.com/2067/2197352149_10f912b166.jpg?v=0]] {{{gradientControl}}}'s are cool, since they're a small little UI showing you a ramp (or curve) that can be manipulated by the user and ties into some object.attr. Problem though, the docs on it leave a //lot// to be desired. (I pulled most of this info from a post by 'ewerybody' on highend3d.com [[here|http://www.highend3d.com/boards/lofiversion/index.php/t214296.html]]) There's two ways I've found to interact with this type of control: Via a ramp, and via a 'ui curve', both described below. The 'curve' method is really similar in process and look as a [[gradientControllNoAttr|How can I author a 'gradientControlNoAttr' into my UI?]]. However, the curve method stores its values as attributes on an object, while the {{{gradientControllNoAttr}}} stores its values in an [[optionVar|How can I store and query variables in Maya, that are stored on the hard drive?]]. ''RAMP:'' {{{ // first we need any object to add the attribute to: string$obj[] = polyCube;
string $attrName = "gradientControl"; // add the attrs to our object that the gradientControl will interact with: string$attrName = "gradientControl";
addAttr -ln ($attrName) -numberOfChildren 3 -at compound -multi$obj[0];
addAttr -sn ($attrName + "Pos") -at "float" -parent$attrName $obj[0]; addAttr -sn ($attrName + "Value") -at "float3" -parent $attrName -storable 1$obj[0];
addAttr -sn ($attrName + "ValueR") -at "float" -parent ($attrName + "Value") $obj[0]; addAttr -sn ($attrName + "ValueG") -at "float" -parent ($attrName + "Value")$obj[0];
addAttr -sn ($attrName + "ValueB") -at "float" -parent ($attrName + "Value") $obj[0]; addAttr -sn ($attrName + "Interpolation") -at "enum" -enumName "0:1:2:3"
-parent $attrName$obj[0];

//give it some default vals, or we'll get an error when the UI tries to build below:
setAttr ($obj[0] + "." +$attrName + "[0]." + $attrName + "Value") -type double3 1 0 0; setAttr ($obj[0] + "." + $attrName + "[0]." +$attrName + "Pos") 0;
setAttr ($obj[0] + "." +$attrName + "[0]." + $attrName + "Interpolation") 3; setAttr ($obj[0] + "." + $attrName + "[1]." +$attrName + "Value") -type double3 0 1 0;
setAttr ($obj[0] + "." +$attrName + "[1]." + $attrName + "Pos") .5; setAttr ($obj[0] + "." + $attrName + "[1]." +$attrName + "Interpolation") 3;

setAttr ($obj[0] + "." +$attrName + "[2]." + $attrName + "Value") -type double3 0 0 1; setAttr ($obj[0] + "." + $attrName + "[2]." +$attrName + "Pos") 1;
setAttr ($obj[0] + "." +$attrName + "[2]." + $attrName + "Interpolation") 3; // now we can open a simple window that contains a control for this attributes: if (window -ex testWin) deleteUI testWin; window testWin; columnLayout; string$colorControl = attrColorSliderGrp -label "color";
gradientControl -at ($obj[0] + "." +$attrName) -selectedColorControl $colorControl; showWindow testWin; }}} Now we have an attrColorSliderGrp that will control the color of whatever part of the gradientControl you have selected. You could make another one to control their position as well. Of course the big problem is you can't query the value of the gradientControl itself, which is bothersome: You can query the attr values on your object, but you really can't find the //interpolated// values that you'd be after. For that, you'd need to write a another proc, probably using the {{{hermite}}} function, to find the interpolated values. If I ever get that code authored, I'll update here. For something similar, check out the [[rampColorPort|How can I make a UI control to edit my ramp?]] command. ---- ''CURVE:'' [img[http://farm3.static.flickr.com/2270/2198047046_1b6111924d.jpg?v=0]] (above image says 'gradientControlNoAttr', but this 'curve' method of the gradientControl looks the same) {{{ // first we need any object to add the attribute to: string$obj[] = polyCube;
string $attrName = "gradientControl"; // add the attrs to our object that the gradientControl will interact with: // The enumName stands for the type of curve interpolation provided: // flat, linear, spline plateau, and spline. addAttr -ln ($attrName) -numberOfChildren 3 -at compound -multi $obj[0]; addAttr -sn ($attrName + "Pos") -at "float" -parent $attrName$obj[0];
addAttr -sn ($attrName + "Value") -at "float" -parent$attrName $obj[0]; addAttr -sn ($attrName + "Interpolation") -at "enum" -enumName "0:1:2:3"
-parent $attrName$obj[0];

// and if you want, you can add some default values:
setAttr ($obj[0] + "." +$attrName + "[0]." + $attrName + "Value") 1; setAttr ($obj[0] + "." + $attrName + "[0]." +$attrName + "Pos") 0;
setAttr ($obj[0] + "." +$attrName + "[0]." + $attrName + "Interpolation") 3; setAttr ($obj[0] + "." + $attrName + "[1]." +$attrName + "Value") .5;
setAttr ($obj[0] + "." +$attrName + "[1]." + $attrName + "Pos") .5; setAttr ($obj[0] + "." + $attrName + "[1]." +$attrName + "Interpolation") 3;

setAttr ($obj[0] + "." +$attrName + "[2]." + $attrName + "Value") 0; setAttr ($obj[0] + "." + $attrName + "[2]." +$attrName + "Pos") 1;
setAttr ($obj[0] + "." +$attrName + "[2]." + $attrName + "Interpolation") 3; // now we can open a simple window that contains a control for this attributes: if (window -ex testWin) deleteUI testWin; window testWin; columnLayout; gradientControl -at ($obj[0] + "." + $attrName) -h 75 testRamp; showWindow testWin; }}} If you open the attribute editor for your object, under extra attributes you can see them change, as you add\remove\modify the gradientControl [img[http://farm3.static.flickr.com/2270/2198047046_1b6111924d.jpg?v=0]] {{{gradientControlNoAttr}}}'s are cool, since they're a small little UI showing you a curve that can be manipulated by the user. Problem though, the docs on it leave a //lot// to be desired. There is also the [[gradientControll|How can I author a 'gradientControl' into my UI?]] which pretty much does the same thing, but ties into an object's attributes. Here's how to get started: {{{ // To get more docs on it than the html page, run this: help gradientControlNoAttr; // standard docs: help -doc gradientControlNoAttr; }}} To first set it up, you'll need to create an [[optionVar|How can I store and query variables in Maya, that are stored on the hard drive?]] to store\set up it's values. We'll call our {{{optionVar}}} '{{{GCNA_test}}}': {{{ // remove the optionVar if it already exists: optionVar -rm "GCNA_test"; // add some default values: optionVar -stringValueAppend "GCNA_test" "1,0,3"; optionVar -stringValueAppend "GCNA_test" ".5,.5,3"; optionVar -stringValueAppend "GCNA_test" "0,1,3"; }}} The data format stored in the optionVars is: *yPos, xPos, curveType The curveType is: *0 = flat *1 = linear *2 = spline plateau *3 = spline *4+ = weird Once the optionVar is in existance, you can build you UI, to take control of it: {{{ global proc tempWin() { if ( window -exists tempWin ) deleteUI tempWin; window -rtf 1 tempWin; columnLayout -adj 1 -co both 5; gradientControlNoAttr -optionVar "GCNA_test" GC_test; showWindow; } tempWin; }}} Now you can adjust and add points to the {{{gradientControlNoAttr}}}. To query the values: {{{ string$vals[] = optionVar -q GCNA_test;
print $vals; }}} Of course, this just returns back the values you set either in the initial {{{optionVar}}} declaration, or based on updating the {{{gradientControlNoAttr}}}, not the //interpolated// values at any random point. For that, you'd need to write a another proc, probably using the {{{hermite}}} function, to find the interpolated values. If I ever get that code authored, I'll update here. For something similar, check out the {{{rampColorPort}}} command. For more info on the {{{gradientControl}}}, see this other posting [[here|http://www.highend3d.com/boards/lofiversion/index.php/t214296.html]] Credit to 'Vlad Dubovoy' on highend3d.com for his posting on this subject that I was able to pull from. Starting with Python 2.5, they introduced the new {{{with}}} statement, which is known as a 'context manager'. See official docs: *http://docs.python.org/reference/compound_stmts.html#with *http://docs.python.org/reference/datamodel.html#context-managers *http://docs.python.org/library/stdtypes.html#context-manager-types *http://www.python.org/dev/peps/pep-0343/ And notes on my Python Wiki: *http://pythonwiki.tiddlyspot.com/#%5B%5Bwith%20statement%5D%5D In a nutshell, it lets you wrap a block of code in a 'context' that controls how that block will be entered, and exited. It also catches exceptions for you, and returns any that occurred, so it takes care of the {{{try}}}\{{{except}}} clause automatically. Maya has {{{progressWindow}}}'s, which provide a nice graphical representation of how long an operation is taking on screen, and allows you to exit out during the operation via the {{{Esc}}} key. However, they're a bit clunky to author. I have a subject on setting them up here: [[How do I create a "Status Window" that shows the graphical progression of some operation?]] It dawned on me, a Python 'context manager' would be a perfect place to author a {{{progressWindow}}}, since you can wrapper all the ugliness of the {{{progressWindow}}} syntax in the context manager, making a much cleaner interface for the user. Contrast this solution with the above link: While it's more code, the bulk of it (the {{{ProgressWindow}}} class) can be hidden from the user. Author the {{{progressWindow}}} context manager: {{{ # Python code import maya.cmds as mc class ProgressWindow(object): """ A context manager wrappering Maya's progressWindow functionality. """ def __init__(self, minF, maxF): self.progressSteps = 100.0 / (maxF-minF) self.progress = 0.0 def __enter__(self): """ Enter the context manager, setup the progress window: """ mc.progressWindow(title='Progress Window!', progress=0, minValue=0, maxValue=100, status='Not started yet...', isInterruptable=True ) return self def update(self): """ Call this every loop once the context has been entered. It detects for progress window canceling, and updates the current progress. """ ret = True if mc.progressWindow( query=True, isCancelled=True ): ret = False else: mc.progressWindow(edit=True, progress=int(self.progress), status='%.1f%%'%self.progress) self.progress += self.progressSteps return ret def __exit__(self, exc_type, exc_value, traceback): """ Called when the context manager is exited, exits the progress window. """ mc.progressWindow(endProgress=1) if exc_type: print "Exiting ProgressWindow, caught exceptions:", exc_type, exc_value return True }}} So how is this used? Here is a simple example: {{{ # Define the frame range the progressWindow should act in: minF = 1 maxF = 500 # We wrapper our loop with the Progress Window context manager: with ProgressWindow(minF, maxF) as progress: for i in range(minF,maxF+1): # call to our update() every frame, and exit out if a cancel event is detected: if not progress.update(): break # Do any work on the current frame (print it in this case), then advance it: print i mc.currentTime(i, edit=True) }}} In the above example, we want to loop over a certain frame range, from frames 1 to 500. In the loop, we have some work to do, and in this case it's just printing the frame number. But where the print statements goes, any amount of other code could go. As you can see, contrasting the 'for loop' code of this example against the above link, it's //much// easier to read: *We wrapper our for loop with our {{{ProgressWindow}}} context manager. *At the start of each looop we {{{update()}}} the progress window, detecting for cancel events, and if so, breaking out of the loop. *When the loop is exited, the {{{__exit__()}}} method of the context manager is automatically called, closing the {{{progressWindow}}}, and handling any exceptions. nice! *This is a general concept I came up with which I'm still roughing out. *A script can hold multiple procedures. Procedures can take arguments. But if a user doesn't define the proper arguments when executing a procedure, they'll get an error. Or, if you change the procedure to have additional arguments, or remove some arguments, any scripts that call to it will need to be updated to pass the correct arguments, or error. *Current Maya Example: **Here is my procedure, with arguments. Let's pretend it's saved in a file called foo.mel {{{ global proc foo(string$a, string $b, string$c)
{
print ($a + "\n"); print ($b + "\n");
print ($c + "\n"); } }}} **And here is our code that calls to it: {{{ foo("please", "don't", "break"); // result: please don't break }}} **Now, pretend you change the arguments of foo to this: {{{ global proc foo(string$a, string $c) { print ($a + "\n");
print ($c + "\n"); } }}} **When executing foo based on the old args, (hoping to now see "please break"), instead Maya will error: {{{ // Error: foo("please", "don't", "break"); // // Error: Line 1.31: Wrong number of arguments on call to foo. // }}} *Other scripting languages like Python allow the authoring of procedures with arguments, but you can author them such that you can assign default values to the arguments, or if you leave an argument out, it won't freak. Maya is much more rigid. Here is the concept I have working to sidestep this limitation. I'm sure it has some bugs, but this is just a prototype. First I'll show the scripts, and then describe what they do: **'Arguemnt-less' script example: {{{ // this file is saved as "argLess.mel" It is our script that has no hard-coded // argument definitions, but can still take passed-in arguments: { // this defines our list of arguments that the script cares about: global string$arglist[];

// now, if it finds an argument it cares about, do something:
if(stringArrayCount("$printme",$arglist))
print ($printme + "\n"); if(stringArrayCount("$addme", $arglist)) { float$val = $addme +$addme;
print ("Added vals = " + $val + "\n"); } } }}} {{{ // this is an example script that would make a call to our "argument-less" script above: // it is saved as a script called "call_argLess.mel" { // Define our arguments: global string$printme = "printing!!!!!";
global float $addme = 2.5; global string$arglist[];
// here we define our global list of argurments. Note we've added one that argLess.mel isn't expecting
$arglist = {"$printme", "$addme", "$notused"};
// and execute our "argumentless" script
source argless;
}
}}}
***To execute call_argLess.mel, you have to source it, since there is no internal procedure definition:
{{{
source call_argLess;
// and the result in the Script Editor:
printing!!!!!
Added vals = 5
}}}
**So what's going on here? We have a script called argLess.mel that has no actual arguemnt definitions (since no procedures have been defined inside of it), yet you can call to it and pass in pre-defined arguments. It's common sense but it had just never occured to me before:
**In call_argLess.mel we setup a global string array called 'global string $arglist[]'. Into this we pass the names of the other global variables we want to send to our argLess.mel script. **In argLess.mel we "pull-in" the global$arglist[] so it's seen inside of the script. Then we stimply check to see if it has data that it can deal with.
**In the case of the example, it knows to print something called $printme, and to add something call$addme. Even though we've 'passed' in something it isn't expecting ($notused), it doesn't matter, since argLess.mel isn't looking for it. **Furthermore, if say we removed an argument from our$arglist[], the script could handle that as well, since it only executes on code that it can find.
*I hope this makes some sense! In a nutshell you have your "arg-less" proc that looks to a global list of arguments to work on. If they exist, then it does stuff. When you "call" to your "arg-less" script, first you define what the args values are, and then point your "global list of arguemnts" to their variable names. Since all the data is "global", they are seen between scripts.
*The only downside I've see so far is the way you need to author your "arg-less" script. You basically have a bunch of "if" statements querying if a variable they care about exists in the 'global var list', and if so, executes on it's contents. In most script\procedure writing you can use your variables all over the code, but using this method it's a bit more compartmentalized. Still, it may have some benefits.
Starting with Python 2.5, they introduced the new {{{with}}} statement, which is known as a 'context manager'.  See official docs:
*http://docs.python.org/reference/compound_stmts.html#with
*http://docs.python.org/reference/datamodel.html#context-managers
*http://docs.python.org/library/stdtypes.html#context-manager-types
*http://www.python.org/dev/peps/pep-0343/
And notes on my Python Wiki:
*http://pythonwiki.tiddlyspot.com/#%5B%5Bwith%20statement%5D%5D
In a nutshell, it lets you wrap a block of code in a 'context' that controls how that block will be entered, and exited.  It also catches exceptions for you, and returns any that occurred, so it takes care of the {{{try}}}\{{{except}}} clause automatically.

I realized this would be a great way to wrap a block of code in an undo queue, which is often needed when authoring Python\API code in Maya.  If this isn't done (based on certain circumstances, usually commands attached to button-press callbacks) when the user undo's, they have to undo every command executed based on the undone function.  And if the function had a hundred loops, the user has to press undo a hundred times...  Wrapping the code in a {{{undoInfo}}} open\close chunk call, it solves for this.  In addition, you need to put your {{{undoInfo}}} calls inside a {{{try}}}\{{{except}}} clause to guarantee that no matter what, you'll close the undo chunk (or your users could get pretty upset with you), and as mentioned above, the {{{with}}} statement takes care of this for you.

I have a solution to this via Python decorators here:
[[How can I author an undo decorator?]]
But why not have //yet another//? :-)
{{{
import maya.cmds as mc
import maya.OpenMaya as om

class UndoManager(object):
"""
This is the context manager class.
"""
def __enter__(self):
# Open our undo chunk
mc.undoInfo(openChunk=True)

def __exit__(self, exc_type, exc_value, traceback):
# Close the undo chunk, warn if any exceptions were caught:
mc.undoInfo(closeChunk=True)
if exc_type:
om.MGlobal.displayWarning('%s : %s'%(exc_type, exc_value))
# If this was false, it would re-raise the exception when complete
return True
}}}
Simple example usage:
{{{
def myFunc():
print "Executing some code... then:"
with UndoManager():
print "Running code in the UndoManager!"
raise Exception("Oops, an exception :-(")
print "Finish executing code..."

myFunc()
}}}
When executed prints:
{{{
Executing some code... then:
Running code in the UndoManager!
# Warning: <type 'exceptions.Exception'> : Oops, an exception :-( #
Finish executing code...
}}}
!!!With UI's:
This works really well when authoring UI's as well.  In the below example, we create a UI with button that will create a sphere for every node in the scene, wrapping the sphere creation in our {{{UndoManager()}}}:
{{{
import maya.cmds as mc

class App(object):

def __init__(self):
if mc.window('ucmt', exists=True):
mc.deleteUI('ucmt')
mc.window("ucmt", title="Undo ContextManager Test",  resizeToFitChildren=True)
mc.columnLayout(adjustableColumn=True, columnAttach=('both', 5))
mc.button(label='FOO!', command=self.buttonCmd)
mc.showWindow()

def buttonCmd(self, *args):
# Wrap everything below in our context manager:
with UndoManager():
for i in range(len(mc.ls())):
mc.polySphere()

# launch the window
App()
}}}
If you press the button to make the spheres, you can undo the operation with a single call to undo.  However, if you modify the above code and comment out this line:
{{{
with UndoManager():
}}}
and try again, you'll see that you'll have to no undo for every sphere that was made.  Yuck!
A common problem I run into when coding in Python in Maya, is the ability to undo:  Sometimes, and often this happens when issuing button commands via a UI, when the user wants to undo the last operation, it will undo //ever step the function took in the operation//.  For example, if you had a function that iterated over a loop making spheres, if you wanted to undo this execution, you'd have to undo for every sphere created, rather than undo the whole operation at once.

I've found the way to make this behave properly is wrap the executed commands inside an {{{undoInfo}}} open\close chunk call, and inside that wrapper the code execution in try\finally clause:  You need to make sure that no matter what happens, even if the command fails for some reason, you can get out and close your undo chunk.

At first I'd embed this {{{undoInfo}}}\try\finally clause directly in the function being called.  But if there were many functions evoking this concept, this could lead to a lot of duplicated code.  Enter the Python ''decorator''.

I consider decorators 'convenience wrappers' (that's how I think of them in my head) for your functions.  I have docs explaining their usage and creation over on my Python Wiki [[here|http://pythonwiki.tiddlyspot.com/#decorator]].

In the below example, I create a Python class that will act as our decorator code.  The great thing about Python and passing arguments to parameters, is that via {{{*args}}} and {{{**kwargs}}} our decorator will intercept all incoming arguments and pass them along properly to the function.
When the decorator runs, it first opens and undo chunk, then tries to execute the decorated function, catching any exceptions it may throw.
When it finishes, it closes the undo chunk, and if there was an exception, it raises it.
{{{
# python code
import maya.cmds as mc

class Undo(object):
"""
Create an undo decorator
"""

def __init__(self, f):
# Called when the Undo decorator is created
self.f = f

def __call__(self, *args, **kwargs):
# Called when the decorated function is executed

mc.undoInfo(openChunk=True)
try:
self.f(*args, **kwargs)
finally:
mc.undoInfo(closeChunk=True)

@Undo                    # This wraps the below function in the decorator
def sphere(rad=3):
# Some function that may have a problem undoing.
#  This code shouldn't, just used as placeholder example.
mc.polySphere(radius=rad)

# Run our code.  We can now easily undo it if we don't like the results.
sphere()
}}}
^^({{{try}}}\{{{except}}} clauses cleaned up to {{{try}}}\{{{finally}}} thanks to suggestion Keir Rice)^^
The irony of the above system is that I authored it to work with button-presses, but the //above system// can't wrapper a class-based method with {{{@Undo}}}, it will get angry (due to the passing of {{{self}}} to the method..

Here is a different approach using a function-based decorator, rather than a class-based one that will work on class methods.  Note how we use the {{{functools.wraps}}} as a decorator //inside our decorator//?  Chaos!
{{{
from functools import wraps
import maya.cmds as mc

def undo(fn):
"""
Create an undo decorator
"""
@wraps(fn)
def wrapper(*args, **kwargs):
mc.undoInfo(openChunk=True)
try:
fn(*args, **kwargs)
finally:
mc.undoInfo(closeChunk=True)

return wrapper

# Make an arbitrary class, with a method to decorate:
class Foo(object):

@undo                        # This wraps the below method in the decorator
def sphere(self, rad=3):
mc.polySphere(radius=rad)

# Now call to our method:
f = Foo()
f.sphere()
}}}
----
Also see:
*[[How can I author an undo context manager?]]
*This will open a new Command Prompt:
{{{
>> maya -batch -file someMayaFile.ma -command "file -save"
}}}
*Same as "maya -batch" but this runs in the same Command Prompt as it was executed in:
{{{
>> mayaBatch -file someMayaFile.ma -command "file -save"
}}}
{{{fileBrowserDialog}}}
*Notes: The docs on this suck, so this is what you need to do:
----
This subject shows how to save the last directory accessed, so you can consistently open your dialogs to the same dir:
[[How can I define a start location for my fileBrowserDialog?]]
----
Example with Python, for picking directories.  Since you can nest functions in Python, it makes it easier to wrapper the functionality of this command together into one cohesive unit.
{{{
import maya.cmds as mc
def fbd():
def fileCommand(directory, ignore):
# This is called by the fileBrowserDialog command after a dir is picked.
print directory
mc.fileBrowserDialog(mode=4, fileCommand=fileCommand, fileType='directory',
actionName='Choose a directory:')
fbd()
}}}
----
*Mel Examples:
**First, built the file brower dialog: -mode is telling it what to do:
{{{
fileBrowserDialog -mode 2 -fileCommand "procName"
-actionName "whatYouAreDoing";
}}}
**-mode 0 is for reading files, so if you type in a name that dosn't exist, the browers will give an error
**-mode 1 & 2 are pretty much the same and are for for writing to file, so you can speficy your own filename in the browers.
**-mode 4 is for selecting directories only.
**-fileCommand is the name of the below proc, that the fileBrowserDialog? passes its info to.
**-actionName is simply what is printed in the UI, telling the user what is going on
**If you're using mode 1 or 2, and you want to specify your own "file types" for filtering, you can use the below code snippet (thanks to Mason Sheffield).
***The {{{-filterList}}} can be called to multiple times to define different file types.  The {{{-filterType}}} is simply the default UI filterList choice.  Also, you //must// set {{{-dialogStyle 1}}} for some reason, or the filtering won't work :(
{{{
-filterList "My file type(*.mft),*.mft"
-filterList "otherFileType(*.oft),*.oft"
-fileType "My file type(*.mft)"
-dialogStyle 1
}}}
*Next, you need to build a proc, that can take the return from the FBD, and then do something with it. It needs to be in the below format, but the proc name, and var names can change.
{{{
global proc procName(string $result, string$type){
textFieldButtonGrp -e -tx $result controlName;} }}} **So, the {{{fileBrowserDialog}}} passes its info, via the {{{$result}}} argument, into the "procName" proc.  Then procName will update controlName with $result. *Another issue: By default you can't specify WHERE the dialog will open too. It appears that it bases where it opens on where Maya's current workspace is. SO, to tell it where to go, you'd need to do something like this: {{{ // query Maya's current workspace: string$mayaWorkspace = workspace -q -dir;
// set the workspace to where you want the dialog to open:
workspace -dir $myCustomPath; // run the dialog code: fileBrowserDialog .... // and set the workspace back again: workspace -dir$mayaWorkspace;
}}}
*Annoying!
----
----

I got an emailed suggestion from Nicolas Combecave.  Thanks Nicolas!
*After scrutining into the fileBrowser mel //command//, I found that the //script// {{{fileBrowserWithFilter}}}, does both in one single command, plus adds an items filtering mechanism. Here is its syntax from the procedure declaration:
{{{
global proc int fileBrowserWithFilter(
string $callBack, string$action,
string $title, string$type,
int $mode, string$filters[],
string $dir) }}} *We can translate it into a mode understandable text: **{{{string$callBack}}} > your procedure to launch upon validation
**{{{string $action}}} > text label on the validation button **{{{string$title}}} > browser title
**{{{string $type}}} > a filetype to select in the dropdown list. Even custom ones (see below). **{{{int$mode}}} > choose for read/write/listDirs... (see description above)
**{{{string $filters[]}}} > fileTypes in the dropdown menu. You can define yours here: {"myFileType,*.mft":"yourFileType,*.yft":"theirFileType,*.tft":etc...} **{{{string$dir}}}  > the starting directory
*So you can use it when you want to specify a file that doesn't exists, into a specified destination, filtering only special file types, even custom ones:
{{{
string $startDir ="c:/tmp/"; fileBrowserWithFilter( "procName", "myLabel", "myTitle", "afileType", 1, {"aFileType,*.aft","anotherFileType,*.anft"},$startDir);
}}}
Given the 'Focal Length' and 'Horizontal Film Aperature'? (since it isn't an actual attribute)
*Code pulled from Maya's {{{AEcameraTemplate.mel}}} script:
{{{
float $focal = getAttr "cameraShape1.focalLength"; float$aperture = getAttr "cameraShape1.horizontalFilmAperture";
float $fov = (0.5 *$aperture) / ($focal * 0.03937);$fov = 2.0 * atan ($fov);$fov = 57.29578 * $fov; }}} Given the 'Horizontal Film Aperature' and 'Angle of View' (Field of View)? *Code pulled from Maya's {{{AEcameraTemplate.mel}}} script. In this example we query the camera's Attribute Editor floatSliderGrp for the FOV, since the FOV isn't an actual camera attribute. {{{ float$fov = floatSliderGrp -q -value fovGrp;
float $aperture = getAttr "cameraShape1.horizontalFilmAperture"); float$focal = tan (0.00872665 * $fov);$focal = (0.5 * $aperture) / ($focal * 0.03937);
}}}
Given the 'Focal Length' and 'Angle of View'?
* I don't know... someone please tell me....
With the Python API:
http://docs.python.org/library/math.html#math.acos
http://docs.python.org/library/math.html#math.degrees
http://download.autodesk.com/us/maya/2010help/API/class_m_vector.html
{{{
# Python code
from math import degrees, acos
from maya.OpenMaya import MVector

# Define two vectors:
vA = MVector(1,0,0)
vB = MVector(0,0,1)

# Get the normalized versions of the vectors:
vA_norm = vA.normal()
vB_norm = vB.normal()

# Find the dot product:
dot = vA_norm * vB_norm

# Get the angle in degrees from the acos of the dot:
angle = degrees(acos(dot))
}}}
{{{
print angle
# 90.0
}}}
----
Via mel's vector types.  In this example, we calculate our two vectors based on three 3d points.
{{{
vector $vA = <<0,0,0>>; vector$vB = <<1,0,0>>;
vector $vC = <<0,.5,.5>>; // Define two vectors: vector$vAB = $vB -$vA;
vector $vAC =$vC - $vA; // Get the normalized versions of the vectors: vector$vAB_norm = unit($vAB); vector$vAC_norm = unit($vAC); // Find the dot product: float$dot = dot($vAB_norm,$vAC_norm);

// Get the angle in degrees from the acos of the dot:
float $angle = rad_to_deg(acos($dot));
// Result: 90.000001 //
}}}
----
You can also use, in Maya:
{{{angleBetween}}} //command//.
OR
{{{angleBetween}}} //node//.
Not a code snippet, but a description of what you need to do.
You can use this to reverse-engineer where a ik handle's pole vector should live, based on the shape of the joint chain itself.
*Get a nice vector library.
*multVal = some val :  This is used to move the location of the pole vector.
*startPoint = vector(first joint worldspace position)
*midPoint = vector(average of all worldspace positions of all joints between start and end)
*endPoint = vector(end joint worldspace position)
*endVector = endPoint - startPoint
*midVector = midPoint - startPoint
*perpendicularVec = crossProduct(endVector ,midVector)
*poleVector = startPoint + (unit( crossProduct(perpendicularVector, endVector ) ) * multVal)

You can then use multVal to 'slide' the pole vector towards and away from the start joint.
Scripting languages like Python allow a procedure to be authored such that if it is expecting an argument, but none is passed in, it can use a default value.  Mel doesn't allow that.  :-(

But, you can use a technique to //simulate// the functionality.  In a nutshell, rather than defining a default argument in the //procedure//, you define it when you pass in an //argument//.

To explain, a simple proc:
{{{
global proc string foofoo(string $arg) { return$arg;
}
}}}
So, whatever you pass in as $arg will be returned. But what if you don't want to pass anything in as$arg, but you still want it to return something by default?  You can use a {{{conditional statement}}} //as// the argument:
{{{
// passing in an arg:
string $arg = "MY ARG"; foofoo((size($arg) > 0 ? $arg : "NO ARG")); // Result: MY ARG // // no arg passed in, using default value: string$arg = "";
foofoo((size($arg) > 0 ?$arg : "NO ARG"));
// Result: NO ARG //
}}}
So either way, you have to pass in $arg, there's no way around that. But, it allows the user to write code to pass in a //different// default value if the argument (in this case) is empty. The conditional statement can be changed to support int values, etc. Also see: *[[How can I use operators outside of conditional statements?]] *[[How can I define a variable outside 'if statement', but change its value within the statment?]]  When I'm rigging, I will often create an initial 'rig-skeleton' that fits inside the mesh to be deformed. To speed things along, I would first just rough in the joint positions. But later I like to get them centered into a selection of verts. The below code will center a joint based on an edge loop. To use the code, pick a joint, then add-select an edge from your mesh (RMB on the mesh -> Edge). The code will (try to) find the edge loop, and center the joint in it. {{{ // Center joint in edge loop. // Select one joint, and one edge. // first, find edge loop: string$sel[] = ls -fl -sl;

string $joints[] = ls -type "joint"$sel;
string $edges[] = polyListComponentConversion -te; int$edgeNum=0;

if(size($sel)!=2) error("Please select exactly one edge, and one joint"); string$buffer[];
tokenize $edges[0] ".[]"$buffer;
$edgeNum =$buffer[size($buffer)-1]; if(size($joints)==0)
error "You didn't pick a joint";
if(size($edges)==0) error "You didn't pick an edge"; polySelect -el$edgeNum;

// convert that to a list of verts:
string $verts[] = polyListComponentConversion -tv;$verts = ls -fl $verts; // Find center of vert positions: float$xyz[] = {0,0,0};
float $x=0; float$y=0;
float $z=0; for($i=0;$i<size($verts);$i++) { // for some reason, no matter what is picked, or nothing is picked, // pointPosition likes to toss a warning and say that more than one // think is picked. So we just hide that, since it shouldn't be // warning at all... :-S scriptEditorInfo -e -sw 1; float$pos[] = pointPosition -w $verts[$i];
scriptEditorInfo -e -sw 0;
$x =$x + $pos[0];$y = $y +$pos[1];
$z =$z + $pos[2]; }$xyz = {($x / size($verts)), ($y / size($verts)), ($z / size($verts))};

// Move joint pivot to new location:
move -a -ws -rpr $xyz[0]$xyz[1] $xyz[2] ($joints[0] + ".rotatePivot") ($joints[0] + ".scalePivot"); print ("Centered " +$joints[0] + " in edge loop\n");

// Finally pick our edge loop, and joint:
select -r $verts; select -add$joints[0];
}}}
There is a mel script that lives here, that will do the switching for you (very handy):
{{{
../MayaX.X/scripts/startup/setNamedPanelLayout.mel
}}}
Which has this argument structure:
{{{
setNamedPanelLayout( string $whichNamedLayout ); }}} So you can call to it like this: {{{ setNamedPanelLayout "Single Perspective View"; }}} And it will switch to that view. You can get a list of these by accessing the Menu: {{{'Panels -> Saved Layouts -> (list of layouts)'}}} The little bit of code that is interesting in that script is this line: (presuming: {{{string$whichNamedLayout = "Single Perspective View";}}})
{{{
string $configName = getPanel -cwl$whichNamedLayout;
// Result: panelConfiguration2 //
}}}
Which actually returns something useful for the code to work with.
__Presuming you have Maya //Unlimited// installed__ (and properly licensed), there are two ways to change what features are available to you.
----
One way is to add this line to your {{{Maya.env}}} file:
{{{
MAYA_LICENSE = complete
}}}
or
{{{
MAYA_LICENSE = unlimited
}}}
Every time you start Maya, it will run in the defined mode.
----
Another way allows you to launch Maya from the command line (probably with a .bat file) with the license defined.  This allows you to say, run //temporarily// in unlimited when you normally only run in complete (via the {{{Maya.env}}}).
{{{
maya -lic=unlimited
}}}
That can be handled through the:
*{{{defaultRenderGlobals}}} node (node type: {{{renderGlobals}}})
**Image format, Renderable Objects, Per camera, what to render (Image, Mask, Depth, or renderable at all), renderable animation range, etc.
It has two sibling nodes that help it control your renders.  The:
*{{{defaultRenderQuality}}} node (type: {{{renderQuality}}})
**Setting Anti-aliasing, particle sampling, motion blur stuff, etc.
*and {{{defaultResolution}}} node (type: {{{resolution}}})
**Resolution, aspect ration, field-rendering, etc.
For example, set our output render format to .jpg:
{{{
setAttr "defaultRenderGlobals.imageFormat" 8;
}}}
For Hardware rendering you have the:
*{{{hardwareRenderGlobals}}} (node type: {{{renderGlobals}}})
*and {{{defaultHardwareRenderGlobals}}} (node type: {{{hwRenderGlobals}}})
**I wonder why it's special and gets two nodes?
Other renderers would have their own nodes.  But since I don't have any loaded right now, this is all I'm listing ;)
Also see:
*[[How can I get a list of the available renderers?]]
*[[How can I change the current renderer through mel?]]
*Edit the Maya script here:
{{{
C:/Program Files/Alias/MayaX.X/scripts/AETemplates/AEshaderTypeNew.mel
}}}
*And in the {{{global proc AEshaderTypeCB}}} inside that script,
*After this line:
**{{{ delete $shaderNode;}}} *Add this: **{{{rename$replaceNode $shaderNode;}}} *Save, re-{{{source}}} {{{AEshaderTypeNew}}} in Maya, it should do just what you want when changing the "Type" in the Attribute editor, when a shader is selected. If you want to some thing more custom, the guts of that script will tell you how to do it. I wonder why this isn't the default option? The {{{defaultRenderGlobals}}} node (see notes [[here|How can I change my Render Settings?]]), who's node type is {{{renderGlobals}}}, allows you to modify it to do this. To change the file format, you modify the {{{.imageFormat}}} attr: {{{ // set to .tga: setAttr defaultRenderGlobals.imageFormat 19; }}} From the docs, these are the current choices: <<< GIF (0), SI (1), RLA (2), Tiff (3), Tiff16 (4), SGI (5), Alias (6) IFF (7) JPEG (8) EPS (9) ~IFF16 (10) Cineon (11) Quantel (12) ~SGI16 (13) TARGA (19) BMP (20) SGIMV (21) QT (22) AVI (23) MACPAINT (30) PHOTOSHOP (31) PNG (32) QUICKDRAW (33) QTIMAGE (34) DDS (35) DDS (36) ~IMFplugin (50) Custom (51) SWF (60) AI (61) SVG (62) SWFT (63) <<< Thanks to a tip from [[Seith|http://seithcg.com/wordpress/]], based on the {{{IMFplugin}}} setting (#50), you can load in formats //other// than what is listed. For example, to render out as {{{.xpm}}}: {{{ // set to IMFplugin format: setAttr defaultRenderGlobals.imageFormat 50; // set the imfPluginKey to .xpm: setAttr defaultRenderGlobals.imfPluginKey -type "string" "xpm"; }}} Nice! If you're wondering, you can visually see the {{{imfPluginKey }}} data in the 'Extra Attributes' section of the Attribute Editor on the {{{defaultRenderGlobals}}}.  {{{ setCurrentRenderer "rendererName"; }}} *Note that {{{setCurrentRenderer}}} is a sub-proc living in {{{.../scripts/others/supportRenderers.mel}}} *This has the same effect as changing the render type in the Render Globals top dropdown menu. It turns out that if you open a scene that's in "Maya Software" mode, and you want to change values on the Mental Ray renderer, you need to "set" the renderer to mental ray first, because by default, the mental ray nodes don't exist in the scene. By setting the renderer to mental ray, the appropriate nodes are created. {{{polyOptions}}} *Example, show the UV map border: {{{ polyOptions -dmb 1; }}} *Example, enable the vertex color of a poly object in shaded mode: {{{ polyOptions -cs 1; }}}  I personally dislike the view-cube. Just yet one more thing to clutter the UI. But maybe now I'll give it a second chance :) Based on this post (by Shawn ~McClelland): http://forums.cgsociety.org/showpost.php?p=6009050&postcount=216 It says: <<< In your install location ({{{C:\Program Files\Autodesk\Maya2009\icons\AutoCam\}}}) there is a file called {{{VCfacemap.png}}} which is basically a simple cube map that the ~ViewCube uses to texture itself. ... Save the {{{VCfacemap.png}}} file and reload Maya, voila you now have a textured viewcube <<< To turn on\off: Window > Settings/Preferences > Preferences -> Interface -> ~ViewCube Some examples :) http://www.flickr.com/photos/7875859@N03/3772730145 {{{jointDisplayScale}}} {{{setStartupMessage}}} *Notes: You'll need to edit the {{{\MayaX.X\scripts\startup\initialLayout.mel}}} script to see this work.  {{{setToolTo}}} *Example: Set the current tool to the "select tool" {{{ setToolTo moverSuperContext; }}} {{{connectionInfo}}} only requires a single object.attr. {{{listConnections}}} also works, but this is a bit more simple: {{{ // Is the object.attr a source of a connection? connectoinInfo -isSource object.tx; }}} {{{ // Is the object.attr the destination of a connection? connectionInfo -isDestination object.tx; }}} {{{ // List an object.attr's source connection, meaning, list the input connection. // This will return a single object.attr. connectionInfo -sourceFromDestination object.tx }}} {{{ // List an object.attr's destination connection, meaning, list the all output connections: // This could return multiple object.attrs. connectionInfo -destinationFromSource object.tx; }}}  Sometimes when running a {{{getAttr}}} on an float node attribute, Maya will return back some very tiny value: {{{ # Python code: print mc.getAttr('myNode.myFloat') 2.7912680472872789e-017 }}} The {{{print}}} statement turns the {{{float}}} into a {{{string}}} for display to the screen. And in the process, does some shorthand so it's not an incredibly long number displayed before you. If you see {{{e-}}} in the number (exponent), it basically means the value is zero for all intensive purposes. But how can you really make that value zero? At least so it prints nicer? If you're using Python (and you should be), you can use Python's {{{round()}}} function to take care of this. Just pass in how many places to the right of the decimal you want it rounded to: {{{ val = 2.7912680472872789e-017 print round(val, 4) 0.0 }}} Matt Estela pointed me to this posting over on tokeru.com: http://www.tokeru.com/t/bin/view/Maya/MayaMelAndExpressions#Strip_spaces_and_punctuation_mak Here's the source from the site (thanks Matt!): {{{ string$comment = "this, is a line with numbers like 0.25 and: stuff!";
string $regex = "[^a-zA-Z0-9_]"; string$replace = "_";

print ($comment+"\n"); int$i = 0;
string $match; int$totalChars = size($comment); for ($i = 0; $i <$totalChars; $i++) {$match  = match $regex$comment;
$comment = substitute$regex $comment$replace;
if ($match == "") break; } print$comment;
print "\n";

// returns "this__is_a_line_with_numbers_like_0_25_and__stuff_"
}}}
I thought I'd see how I could author this in Python, and posted an alternative over at my [[Python Wiki|http://pythonwiki.tiddlyspot.com/#%5B%5BHow%20can%20I%20strip%20illegal%20characters%20from%20a%20string%3F%5D%5D]]
By default, when a UI is created, Maya will remember its size. If later in your script you change it's size, those changes may not be reflected on screen.
{{{
windowPref -remove "UI_nameGoesHere";
}}}
Old example:
{{{
// compute current position:
float $posNowX = obj.translateX; float$posNowY = obj.translateY;
float $posNowZ = obj.translateZ; // compute previous position: float$posThenX = getAttr -t (frame - 1) obj.translateX;
float $posThenY = getAttr -t (frame - 1) obj.translateY; float$posThenZ = getAttr -t (frame - 1) obj.translateZ;

// compute distance traveled per frame:
float $distance = sqrt( pow(($posNowX - $posThenX), 2) + pow(($posNowY - $posThenY), 2) + pow(($posNowZ - $posThenZ), 2) ); print ($distance + "\n");
}}}
Newer example:  (thanks Jamie ~McCarter)
{{{
float $t = currentTime -q; vector$currentP = getAttr object.translate;
vector $previousP = getAttr -t ($t-1) object.translate;
float $dist = mag($currentP - $previousP ); print( "distance traveled " +$dist + "\n");
}}}
Newer, with matrices! ;) Probably the most accurate way of doing it?
>Note:  It appears that this line "{{{float $prevM[] = getAttr -t ($t-1) object.worldMatrix;}}}" causes a cycleCheck warning in Maya.  Not sure why?
{{{
float $t = currentTime -q; float$curM[] = getAttr object.worldMatrix;
float $prevM[] = getAttr -t ($t-1) object.worldMatrix;
vector $currentP = <<$curM[12], $curM[13],$curM[14]>>;
vector $previousP = <<$prevM[12], $prevM[13],$prevM[14]>>;
float $dist = mag($currentP - $previousP ); print( "distance traveled " +$dist + "\n");
}}}
{{{connectControl}}}
The {{{curveInfo}}} node lets you do this.  I havn't actually tried all of this yet, but here's the idea:
Make the {{{curveInfo}}}, and connect your curve to it:
{{{
# Python code
import maya.cmds as mc

lenCalc = mc.createNode("curveInfo")
mc.connectAttr("myCurveShape.worldSpace[0]", lenCalc+".inputCurve")
}}}
The in the //Attribute Editor//, with the new {{{curveInfo}}} selected, go to the "Control Points" drop down, and "Add New Item" for each of the CV's.
Then, those attributes will be available to connect to, either through the 'Connection Editor', or via scripting.

I need to research how to do all of this in mel\Python	
I've made several rigs that could for all intensive purposes be envisioned as suspension bridges:  There is a chain of joints stretched over a certain distance.  There is a controller at the start and end of the chain.  Transforming either the start or the end controller will in-turn transform the chain, but the transformations have a falloff over the distance of the chain.

This is done by constraining all the joints in the chain to both controllers, and then modifying the weights of each constraint to give priority to the closer controller.

Presuming that "target1" is at the same location as "joint1", and "target2" is at the same location as "joint5", here are the resulting weights that would be applied to the joints (based on the below example code):
| | target1 | target 2|
| joint1 | 1.0 | 0 |
| joint2 | .75 | .25 |
| joint3 | .5 | .5 |
| joint4 | .25 | .75 |
| joint5 | 0 | 1.0 |
{{{
# Python code
import maya.cmds as mc

# define our source list of nodes, plus the two targets they'll follow
nodes = ["joint1", "joint2", "joint3", "joint4", "joint5"]
target1 = "locator1"
target2 = "locator2"

# define the "step" a weight will increase or decrease for each node:
weightStep = 1.0/(len(nodes)-1)

for i in range(len(nodes)):
# create the constraint:
pc = mc.parentConstraint(target1, target2, nodes[i], maintainOffset=True)

# query the constraint target attrs just created:
targets = mc.parentConstraint(pc, query=True, targetList=True)

# calculate the weights to be applied to the two target attrs:
w1 = abs(1 - i * weightStep)
w2 = 1 - w1

# apply weights:
mc.setAttr(pc[0]+"."+targets[0]+"W0", w1)
mc.setAttr(pc[0]+"."+targets[1]+"W1", w2)
}}}
The above example gives a linear falloff between the targets.  Multiplying the weights based on a (Python) {{{math.sin()}}} function could start to give you a more ease-in \ ease-out weighting solution.
The {{{animView}}} command give access.
Look at the area between frames 0 and 30, and the value range -10 - 100:
{{{
import maya.cmds as mc
mc.animView( 'graphEditor1GraphEd', startTime=0, endTime=30, minValue=0, maxValue=100 )
}}}
{{{graphEditor1GraphEd}}} is the name of the default Graph Editor.
I wanted to build a rig animation controller that would change its wireframe color depending on which 'state' it was in, via a {{{.localGlobal}}} attr (going from 0-1).  If it was in a "local" state, it would be green, in "global" state, red.

FYI, Maya has 32 available override colors:  0 = default color, and 1-31 are other colors.  Red happens to be 13, and green 14.  The {{{colorIndex}}} command will return back the RGB or HSV vals of each index.
{{{
// Define the 'state' node name (a transform) that has our switch attr (.localGlobal),
// and the shape node name of our animation controller that will change color:
string $stateNode = ("someTransform"); string$controllerShape = ("someShape");

// define our color indices.
int $green = 14; int$red = 13;

// enable our override colors onr our shape:
setAttr ($controllerShape + ".overrideEnabled") 1; // make our condition node, to define what the colors should be: string$con = createNode condition;

// we want values less than .5 to be green, and greater than .5 to be red:
setAttr ($con + ".secondTerm") 0.5; // set our condition to 'greater than' setAttr ($con + ".operation") 2;

// define our condition colors:
setAttr ($con + ".colorIfTrueR")$red;
setAttr ($con + ".colorIfFalseR")$green;

// hook our switch attr into our condition:
connectAttr -f ($stateNode + ".localGlobal") ($con + ".firstTerm");

// and hook the output of the condition into our controllers color:
connectAttr -f ($con + ".outColorR") ($controllerShape + ".overrideColor");
}}}
Now, when the .localGlobal attr goes from 0-1, it will change the wireframe color from green to red.
Got pointed to the blog post [[here|http://www.185vfx.com/2003/03/convert-a-3d-point-to-2d-screen-space-in-maya/]] by Rob Bredow.  Take a gander.
As I figured, Maya actually does most the heavy lifting for you, if you know what to call.  [[This blog post|http://around-the-corner.typepad.com/adn/2012/08/convert-maya-world-coordinates-to-screen-coordinates.html]] by Cyrille Fauvel describes another way to do it.

I've condensed those notes down into my own method here:
{{{
import maya.cmds as mc
import maya.OpenMaya as om
import maya.OpenMayaUI as omui

def getScreenSpace(node):
"""
Return the screen-space position of the node.
0,0 is the bottom left.  +X goes to the right, +Y goes up.
"""
activeView = omui.M3dView.active3dView()

# Can't use 'pointPosition', since that will return values in the 'ui units',
# and we need them returned in 'internal units', which is what the matrix
# attr stores:
mtxList = mc.getAttr("%s.worldMatrix"%node)
# Extract just the position:
pt = om.MPoint(mtxList[12], mtxList[13], mtxList[14])

# Pointer hoop-jumping...
xPtrInit = om.MScriptUtil()
yPtrInit = om.MScriptUtil()
xPtr = xPtrInit.asShortPtr()
yPtr = yPtrInit.asShortPtr()

activeView.worldToView(pt, xPtr, yPtr)

x = xPtrInit.getShort(xPtr)
y = yPtrInit.getShort(yPtr)

return x,y
}}}
Docs for ~OpenMayaUI's [[M3dView|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m3d_view.html]]

Via the mel script {{{polyConvertToShell.mel}}}
{{{
\Maya20XX\scripts\others\polyConvertToShell.mel
}}}
Some languages give you the ability to Boolean test strings:  You can convert a {{{string}}} to a Boolean, and if the string has any characters, the bool = {{{True}}}.  If the string is empty, the bool = {{{False}}}.  How to do something similar with ''mel''?

Mel doesn't have Boolean variable types, so we have to fake it with an {{{int}}}.  (Although, you can make Boolean //attribute// types.  Odd you can make one but not the other.)

You could try this, but we get a warning, and an {{{int}}} of {{{0}}}:
{{{
string $s = "word"; int$i = $s; // Warning: line 2: Converting string "word" to an int value of 0. // // Result: 0 // }}} However, you could use the '{{{?}}}' operator, and get the result you're after: {{{ string$s = "word";
int $i = size($s) ? 1 : 0;
// Result: 1 //
}}}
Show help docs on the {{{?}}} operator:
{{{
showHelp -d "General/_operator.html";
}}}
----

Similar stuff in ''Python''.  Python //does// have Boolean object types, so we first convert the {{{string}}} to {{{Boolean}}}, then to {{{int}}} (or obviously leave off the {{{int}}} part if all you want is the bool).  Trying to convert a {{{string}}} directly to an {{{int}}} raises a {{{ValueError}}}.
{{{
s = "word"
i = int(bool(s))
# 1
}}}
I wanted a way to turn mesh wireframe into a solid volume, so I could 3d-print it.  Sort of like turning a sphere into a solid geodetic dome.  This would be like extruding a circle down every edge of a polygonal mesh, and welding up all the spots they touch.  One of the modelers were I work (Sean Marino) tipped me off to this technique:
*Pick all the faces
*Turn off "Keep faces together"
*Extrude Face : Set Divisions to 1, Increase offset to set desired edge width.
*Delete new faces.
*Re-select all faces.
*Turn on "Keep faces together"
*Extrude Face : Set divisions to 1.  Increase thickness.  Done
Based on that workflow, here's a simple script to do it:
{{{
import maya.cmds as mc

def wireframeToSolid(offset):
"""
Based on the given selection of a single polygonal object, convert it's wireframe
to a solid volume.  Will create a 'thickness' attribute on the mesh object, for adjustment
of the size of the wireframe volume after creation.

Parameters:
offset : float : The thickness of the wires.
"""
sel = mc.ls(selection=True)
assert len(sel)==1, "Please select a single polygonal object"
# Create the custom attr:
if not mc.objExists("%s.thickness"%sel[0]):
mc.addAttr(sel[0], longName="thickness", defaultValue=offset, keyable=True)
mc.setAttr("%s.thickness"%sel[0], offset)

mc.select(sel)
origFaces = mc.polyListComponentConversion(toFace=True)
mc.select(origFaces)
extrudeA = mc.polyExtrudeFacet(constructionHistory=True, keepFacesTogether=0, divisions=1, twist=0, taper=1, off=offset, thickness=0)[0]
mc.delete() # Delete the interior faces creating holes.
mc.select(sel) # Reselect the whole object
newFaces = mc.polyListComponentConversion(toFace=True)
mc.select(newFaces)
extrudeB = mc.polyExtrudeFacet(constructionHistory=True, keepFacesTogether=1, divisions=1, twist=0, taper=1, off=0, thickness=offset)[0]

# Hook up the custom attr:
mc.connectAttr('%s.thickness'%sel[0], '%s.offset'%extrudeA)
mc.connectAttr('%s.thickness'%sel[0], '%s.thickness'%extrudeB)
print "wireframeToSolid: Complete!"
}}}
To use, pick a single poly object and execute:
{{{
wireframeToSolid(.05)
}}}
----
There also appears to be a tool that does this too on Creative Crash:
http://www.creativecrash.com/maya/downloads/scripts-plugins/modeling/poly-tools/c/convert-to-polywire
{{{polyClipboard}}}
{{{popupMenu}}}
Maya comes with a script to do this, which lives here (Maya 2008):
{{{
<drive>:\Program Files\Autodesk\Maya<version>\scripts\others\clusterCurve.mel
}}}
However, it doesn't return anything, just does work.  Here is a modified snippet that can provide the cluster info:
{{{
// $curve is the shape of some curve string$clusters[];
int $numCVs = getAttr -size ($curve + ".controlPoints");
int $i = 0; for ($i; $i <$numCVs; $i++) { //make CV into a cluster string$c[] = cluster -relative ($curve + ".cv[" +$i + "]");
$clusters[$i] = $c[0]; } }}} ---- Also see: *[[How can I get a list of all the CV's on a curve?]] Check out the docs on the {{{draggerContext}}} command. I seem to end up doing this a lot. Using Python and 'list comprehensions', it's really, really easy: In this example, we'll base it on a selection of verts: {{{ # Python code import maya.cmds as mc verts = mc.ls(selection=True, flatten=True) pos = [mc.pointPosition(v, world=True) for v in verts] myCurve = mc.curve(degree=1, point=pos) }}} That's it. If you were basing it of a selection of transforms, you'd need to change your {{{pointPosition}}} arg to '{{{v+".rotatePivot}}}' to pull the proper location, fyi. A combo of the mel {{{copyAEWindow}}} & {{{showEditor}}} global procs, which lives in this script: {{{ C:\Program Files\Autodesk\Maya20XX\scripts\others\showEditor.mel }}} {{{ string$sel[] = ls -sl;
showEditor $sel[0]; copyAEWindow; }}} This will display an Attribute Editor docked in the main panel, then pop a dupe off. ---- Also see: *[[I want to open an Attribute Editor for a certain object. How to do so?]] Simple function to build the material & shading engine, and connect them together. {{{ # Python code import maya.cmds as mc def makeMatAndShader(matName, matType): material = mc.shadingNode(matType, asShader=True, name=matName) # The material will be selected when created: Need to de-select before # Creating our shadingEngine (since it's a set). mc.select(clear=True) # Nope, can't do it this way, won't shade properly later for some reason: # shader = mc.createNode('shadingEngine', name='%sSG'%material) # Need to do it this way: shader = mc.sets(renderable=True, name='%sSG'%material) # Can use this rather than a call to connectAttr: mc.defaultNavigation(connectToExisting=True, source=material, destination=shader) return material, shader }}} {{{ matName = 'myPhong' matType = 'phong' print makeMatAndShader(matName, matType) }}} {{{ (u'myPhong', u'myPhongSG') }}} Often when making UI's you want a {{{fileBrowserDialog}}} to consistently open in the same location. Or, remember the last place it was opened from. The below example shows how to store a setting that remembers the last dir that was accessed, and repoint the browser there on later browsing expeditions. The magic is the the {{{workspace}}} command's {{{directory}}} arg: Need to set that sucker to your saved values. Took me a while to figure that out... I've labeled each section in the order it is executed so it makes more sense ;) {{{ # Python code: import os import maya.cmds as mc # Section 1 # Query the current workspace, since we'll end up changing it while we # open our browsers, and need to set it back to normal later. currentWorkspace = mc.workspace(query=True, active=True) # Section 4 # What is called to via the fileBrowserDialog. This is where the 'action code' # would take place once a file from the browser was selected: def fbdCommand(fileName, fileType): # Do stuff: # stuff, stuff, stuff.... # Then store the path preset: path = os.path.split(fileName)[0] mc.optionVar(stringValue=['testPath', path]) # Section 2 # Load our directory preset (if it exists) before launching the dialog: if mc.optionVar(exists='testPath'): savedPath = mc.optionVar(query='testPath') if os.path.isdir(savedPath): # This is the magic that lets us configure where the browser opens: mc.workspace(directory=savedPath) # Make a file-save dialog (for example). We wrap its execution in a try\finally # clause to make sure that even if it fails, we can set our workspace back. try: # Section 3 mc.fileBrowserDialog(mode=1, fileCommand=fbdCommand, fileType='mayaAscii', operationMode='SaveAs', actionName="Save_as") finally: # Section 5 # Now set our workspace back to normal: if os.path.isdir(currentWorkspace): mc.workspace(directory=currentWorkspace) }}} If you're trying to open the dialog in 'directory mode', which is mode 4, then this subject has additional notes: [[How can I modify the current project \ workspace?]] *Use an 'if statement' with correct variable scope: *Example 1 (keep scope within the variable): {{{ string$foo = "abcd";
if(1)
$foo = "dcba"; print$foo;
// result: "dcba" //
}}}
**This works for two reasons:  {{{$foo}}} is defined first, outside the scope of the 'if statement'. Second, when {{{$foo}}} is updaetd inside the 'if statement', since it's being updated by '{{{$foo = ...}}}', //rather// than '{{{string$foo = ...}}}', then it keeps the original scope of {{{$foo}}}. If we had //instead// updated it with '{{{string$foo = ...}}}', then the print statement would have printed the original value, since we would have broken out of its original scope.  In a nutshell, if you put the variable descriptor before variable name (like {{{string}}}), then that defines the start of a new scope for that variable name.  Every time after that, if you call direcltly to the variable name without the descriptor, then you're still acting within the scope of that original variable.  I really hope this makes some sense.

*Example 2 (//loose// original variable scope due to re-declaring the variable inside the 'if statement'):
{{{
string $foo = "abcd"; if(1) string$foo = "dcba";
print $foo; // result: "abcd" // }}} *Example 3: //Or//, use a 'conditional statement': {{{ string$bob = "asdf";
string $lary =$bob == "asdf" ? "happy" : "sad";
}}}
**so, //if// $bob = asdf, then$lary is "happy". Otherwise, $lary is "sad". **The conditional statements can be nested, to provide different return values. There is the //mel// procedure {{{ source cleanUpScene; deleteUnknownNodes(); }}} Which lives in this script: {{{ C:\Program Files\Autodesk\Maya<VERSION>\scripts\startup\cleanUpScene.mel }}} Optionally you can roll your own. But I've found the above method to be a bit more robust. {{{ import maya.cmds as mc unknown = mc.ls(type='unknown') if unknown: mc.delete(unknown) }}} {{{ camera -e -startupCamera 0$camName;
delete $camName; }}} Default camera's ({{{persp}}}, {{{top}}}, {{{front}}}, {{{side}}}) have a special flag that is set to let Maya know they are "startup cameras". This keeps the cameras persistent between different Maya files when you're opening them, importing, etc. Have you even wondered why when you import multiple maya files the cameras don't start piling up? There have been issues when external tools start to monkey with the cameras, renaming them, or evening creating duplicates, that can't be deleted. Using this method, you can now delete them. FYI, there always needs to be at least one cam in the scene listed as a "startup camera". !!!mel: I'm not sure what version of Maya introduced it, but //at least// by Maya 2009 the {{{sysFile}}} command has a {{{-removeEmptyDir}}} arg (thanks for the tip from Matti Grüner) {{{ sysFile -removeEmptyDir "c:/temp"; }}} http://download.autodesk.com/us/maya/2009help/Commands/sysFile.html !!!Python: Of course if you have Maya 8.5 or newer you can just use Python: This only works if the dir is empty: {{{ import os os.rmdir("c:/temp") }}} if you want to remove a directory, and all the stuff in it: {{{ import shutil shutil.rmtree("c:/temp") }}} !!!Direct Windows system call: The DOS {{{rmdir}}} command. Example: Delete a directory and all files in it ({{{/s}}}), without prompt ({{{/q}}}): {{{ system("rmdir /s /q c:/temp"); }}}  {{{deleteUI "buttonName";}}} And then be sure to save the shelfs\prefs Here is some code to figure out the members of what the current shelf is. {{{ string$buttons[]; clear $buttons; global string$gShelfTopLevel;
if (tabLayout -exists $gShelfTopLevel) { string$currentShelf = tabLayout -query -selectTab $gShelfTopLevel;$buttons = shelfLayout -q -ca $currentShelf; } print$buttons;
}}}
While you're working on contexts, it's often handy to delete them and remake them (not unlike windows) to see your updates:
{{{
if(contextInfo -exists "myContextName == 1){
deleteUI -toolContext "myContextName";
}
// remake context here:
}}}
Often times I want to cleanup a scene by deleting all leaf nodes:  Nodes that don't have children.  Or, hierarchies of the same kind of node that don't have any meaningful children.
{{{
# Python code
import maya.cmds as mc

def delLeafByType(types):
"""
types : list : List of given DAG node types to delete, presuming
they're leaf of a hierarchy.
"""
totalDel = 0
triedToDel = 0
leaf = mc.ls(dag=True, leaf=True)
noDel = []

while len(leaf) > 0 and len(leaf) >= len(noDel):
for i in leaf:
try:
if mc.objectType(i) in types:
mc.delete(i)
totalDel += 1
else:
noDel.append(i)
except Exception, e:
noDel.append(i)
triedToDel += 1
print str(e).strip(), i
leaf = mc.ls(dag=True, leaf=True)

if triedToDel:
print "Deleted %s leaf nodes, tried to delete %s others but couldn't.  Check Script Editor."%(totalDel, triedToDel)
else:
print "Deleted %s leaf nodes"%totalDel
}}}
{{{
delLeafByType(["transform", "locator"])
}}}
{{{
Deleted 14 leaf nodes
}}}
Often, when I'm cleaning a scene for export to game, I want to make sure only nodes of a certain type live in it.  Here's one way to simply remove everything from the scene that isn't part of the list of "acceptable nodes" you want.
{{{
# Python code
import maya.cmds as mc

def delAllByTypes(exceptThese, dag=False):
"""
Delete all nodes in the scene, except the ones provided by the user.
If anything is flagged for deletion and can't be, print exception results.

exceptThese : list : node types that *shouldn't* be deleted.
dag : bool : Optional.  If True, will limit node types to only
DAG nodes (transforms & shapes and their associates).  Otherwise,
look to ALL node types.
"""
nodes = []
if dag:
nodes = mc.ls(dag=True)
else:
nodes = mc.ls()
nodes.reverse()

removal = []
for d in nodes:
if mc.objectType(d) not in exceptThese:
removal.append(d)

for r in removal:
try:
mc.delete(r)
except Exception, e:
print str(e).strip(), r
}}}
{{{
# delete all DAG nodes in the scene that aren't of type 'good':
good = ["joint", "transform", "mesh"]
delAllByTypes(good, dag=True)
}}}
Execute the proc:
{{{
MLdeleteUnused;
}}}
Which lives in the script here:  {{{../MayaX.X/scripts/others/MLdeleteUnused.mel}}}
"ML" stands for "~MultiLister" the old version of the Hypershade (which was brought into Maya from Alias).

This code is also called to when you use "Optimize Scene Size" from the File menu, or in the '~HyperShade -> Edit -> Delete Unused Nodes'.
[[pointCurveConstraint|http://download.autodesk.com/global/docs/maya2012/en_us/CommandsPython/pointCurveConstraint.html]]
This command will constraint a point on a curve to //something else//.  It does not constrain things //to// a curve.
It implements this via a [[leastSquaresModifier|http://download.autodesk.com/global/docs/maya2012/en_us/Nodes/leastSquaresModifier.html]] node.
Below code will find all the incoming and outgoing connections to a node, and //DESTROY// them.
{{{
# Python code
import maya.cmds as mc

node = 'myNode'
incoming = mc.listConnections(node, source=True, destination=False, plugs=True, connections=True)
outgoing = mc.listConnections(node, source=False, destination=True, plugs=True, connections=True)
if incoming:
for i in range(0,len(incoming),2):
mc.disconnectAttr(incoming[i+1], incoming[i])
if outgoing:
for i in range(0,len(outgoing),2):
mc.disconnectAttr(outgoing[i], outgoing[i+1])
}}}
----
Also see:
*[[How can I disconnect an attribute?]]
{{{disconnectAttr}}}
''Some examples'':
''mel'':
{{{
// Disconnect only keyable attrs.
string $obj = "null1"; string$keyable[] = listAttr -k $obj; for($i=0;$i<size($keyable);$i++) { string$incoming[] = listConnections -s 1 -d 0 -p 1 -c 1 ($obj+"."+$keyable[$i]); if (size($incoming) )
disconnectAttr $incoming[1]$incoming[0];
}
}}}
{{{
// Disconnect ALL incoming connections.
string $obj = "null1"; string$incoming[] = listConnections -s 1 -d 0 -p 1 -c 1 $obj; for($i=0;$i<size($incoming);$i=$i+2)
disconnectAttr $incoming[$i+1] $incoming[$i];
}}}
''Python'':
{{{
import maya.cmds as mc

string obj = "null1"
string keyable = mc.listAttr(obj, keyable=True)
for k in keyable:
incoming = mc.listConnections('%s.%s'%(obj,k), source=True,
destination=False, plugs=True, connections=True)
if incoming is not None:
mc.disconnectAttr(incoming[1], incoming[0])
}}}
In both examples we have {{{listConnections}}} return back both plugs and connections, which gives us a list of source\destination objec.attr pairs, making them easy to feed directly into {{{disconnectAttr}}}.
----
Here's another Python example using {{{connectionInfo}}}, which simplifies things a bit:
{{{
objAttr = 'muNode.rotateX'
con = mc.connectionInfo(objAttr, sourceFromDestination=True)
if con:
mc.disconnectAttr(con, objAttr)
}}}
----
Also see:
*[[How can I disconnect all connections to a node?]]
In years past I've had success with {{{polyGeoSampler}}}... but not lately.
----
You can also use this method:
*Map a texture to the displacement channel of the mesh's materials shading engine (via the ui, so it creates the appropriate {{{displacementShader}}} node and connections in the process.
*On the mesh's shape node, under the {{{Displacement Map}}} dropdown, set the {{{initialSampleRate}}} and {{{extraSampleRate}}} attrs to 1.
*Modify -> Convert -> Displacement to polygons.
This will triangulate the mesh in the process, but shouldn't add any extra verts.
{{{waitCursor}}}
Best to make the border size bigger too in the process:
{{{
polyOptions -activeObjects -displayBorder true -global -sizeBorder 10;
}}}
You can also add the {{{-relative}}} flag, which will turn it into a toggle.

To turn it back off:
{{{
polyOptions -activeObjects -displayBorder false;
}}}

Around Maya 2010 (maybe earlier) they have a wiz-bang feature that displays a soothing gradient color in the background of the viewports.  To turn it on, the default hotkey is {{{ALT+B}}}.  Or, you can use code (after hacking apart {{{cycleBackgroundColor.mel}}}):
{{{
# Python code
import maya.cmds as mc

mc.displayPref(displayGradient=True)
mc.optionVar(intValue=["displayGradient", 1])
}}}
I know WAY more stuff in mel than in dos.  But if you operate in windows, and need to do stuff in the system, then you'll need to know how to do it in dos.  Here are some links I've found that are useful for explaining things like batch scripts, redirection, variables, etc.  The list will grow...
*http://www.febooti.com/products/command-line-email/batch-files/
*http://www.computerhope.com/msdos.htm
Python has no built-in vector math calls :(  You can see my notes on this [[here|What mel commands are 'missing' from the Python integration?]].  In Maya however, you have a few solutions to continue to do vector math:
----
''Method A'':  Write your own wrappers around the @@mel@@ vector commands.   You could do it, but that would be silly:
{{{
import maya.mel as mm
def mvCross(vec1, vec2):
mVec1 = vec1.__str__().replace("[", "<<").replace("]",">>")
mVec2 = vec2.__str__().replace("[", "<<").replace("]",">>")
res = mm.eval("cross(" + mVec1 + ", " + mVec2 + ")")
return list(res)

vec1 = [0,1,0]
vec2 = [1,0,0]
cross = mvCross(vec1,vec2)
print cross
# [0.0, 0.0, -1.0]
}}}
----
''Method B'':  Call to {{{maya.OpenMaya}}}, and use API {{{MVector}}} ([[docs|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_vector.html]]) goodness.  ''This is the recommended way.''
{{{
import maya.OpenMaya as om
vec1 = om.MVector(0,1,0)
vec2 = om.MVector(1,0,0)
vec3 = vec1^vec2  # calculate cross product
print vec3.x, vec3.y, vec3.z
# 0.0 0.0 -1.0
}}}
*{{{*}}} operator: The dot product of two {{{MVector}}}s.
*{{{^}}} operator: The cross product of two {{{MVector}}}s.
----
''Method C'':  Write your own Python vector module, or get someone else's.  But why do that when the API gives you all you need?
*I document the math behind some of the basic vector functions [[here|Vector Math]]
*[[Vector|http://code.activestate.com/recipes/578006-vector/]] : A fairly robust looking 2d vector solution.
*The 2d and 3d vector classes in the [[gameobjects|http://code.google.com/p/gameobjects/]] package (over at Google Code).
*~PyGame have contributed [[Vec2d|http://pygame.org/wiki/2DVectorClass]] and [[Vec3d|http://pygame.org/wiki/3DVectorClass]] classes.
----
''Method D'': Get {{{NumPy}}}
http://numpy.scipy.org
I've not tested it, but it's possible you could get a speed boost based on Numpy's ndarray objects.
You'll need to make sure that the lib is installed where Maya can see it, like here:
{{{
C:\Program Files\Autodesk\Maya<version>\Python\lib\site-packages
}}}
Example:
{{{
import numpy
v1 = (1,2,3)
v2 = (3,2,1)
v3 = numpy.cross (u, v)
}}}

You can use the {{{headsUpMessage}}} command to do this.  It will disappear on the next screen refresh (by default).  It has arguments to have it display for a fixed amount of time, or be centered on a particular object \ object selection.

You could do something similar with a {{{confirmDialog}}} or {{{promptDialog}}}, but they are modal dialog boxes that stop the user from interacting until their condition is met.  {{{headsUpMessage}}} doesn't stop the user from interaction, and automatically goes away.

From the docs:
{{{
headsUpMessage "Ouch!";
headsUpMessage -object circle1 "This is Circle 1";
headsUpMessage -selection "These objects are selected";
headsUpMessage -time 5.0 "Text appears for minimum of 5 seconds.";
headsUpMessage -verticalOffset 20 "Text appears 20 pixels above point.";
headsUpMessage -horizontalOffset -20 "Text appears 20 pixels to the left of the point.";
}}}
{{{createDrawCtx}}}
Presuming you have a node with children, how can you duplicate it, but not its children?
You can use the {{{parentOnly}}} argument of the {{{duplicate}}} command
{{{
# Python code
import maya.cmds as mc

sel = mc.ls(selection=True, long=True)
for s in sel:
new = mc.duplicate(s, parentOnly=True)
}}}
----
Old data, incorrect concept (the execution still works, but obviously it's unneeded).
<<<
To my knowledge, you can't:  The children are always created during the duplication.  However, you can duplicate it, and then delete the new children:
{{{
# Python code
import maya.cmds as mc

sel = mc.ls(selection=True, long=True)
for s in sel:
new = mc.duplicate(s, renameChildren=True,  returnRootsOnly=True)
kids = mc.listRelatives(new, children=True,  fullPath=True)
if kids is not None:
mc.delete(kids)
}}}
<<<
If a node lives in a set, when you duplicate the node, the new duplicate well live in that set as well.  But, what if you don't want this behavior?
{{{
import maya.cmds as mc

def dupeNoSet(nodesInSet):
"""
Duplicate the passed in nodes, and remove them from any sets the original
nodes were in.

Args:
nodesInSet : ["node", ...] : List of node names to duplicate.

return : ["node", ...] : List of duplicated node nams.
"""
if len(nodesInSet) == 0:
return []
newNodes = mc.duplicate(nodesInSet, renameChildren=True)

# Rename the new joints, and fill our jointMap dict:
for i in range(len(newNodes)):
outgoing = mc.listConnections(newNodes[i], source=False,
destination=True, plugs=True,
connections=True)
if outgoing is not None:
for i in range(0, len(outgoing), 2):
if "instObjGroups" in outgoing[i]:
try:
mc.disconnectAttr(outgoing[i], outgoing[i+1])
except:
# there can be dupe reports in our outgoing list, so skip
# if its already been disconnected.
pass
return newNodes
}}}
{{{
nodesInSet = mc.ls(selection=True, long=True)
dupes = dupeNoSet(nodesInSet)
}}}
{{{
objectName.f[*];
}}}
One of the most important things when painting smooth skin weights, is holding and unholding influence weights.  If an influence is 'unheld' (unlocked), its influence weights can be modified.  If it is held (locked), its influence weights can't be modified.  In general when painting weights, you want ALL the influences held except the current two you're working on.

In the 'Paint Skin Weights Tool', under the 'Influence' frame, it shows the influence list for everything effecting that geo, and a button at the bottom to 'Toggle Hold Weights on Selected'.  If you have 100 joints, then you need to pick each one in the list, and hit that button.  This can be, really time consuming.  What if you want to simply hold all the weights at once, then unhold just the two of your choosing?

Two simple shelf buttons can be written to do this, the code is below.  The key is to query all the nodes in the scene with a {{{.liw}}} attr.  {{{.liw}}} stands for "Lock Influence Weights", and any node that is added as a smooth skin influence will have this attr added to it.  If the value is 1, the weights are locked\held.  If the value is 0, the weights are unlocked\unheld.
{{{
// 1 = lock\hold, 0 = unlocked\unheld.
//Change this for each shelf button
int $lockState = 1; string$boundJoints[] = ls "*.liw";
for($joint in$boundJoints)
setAttr $joint$lockState;

if($lockState) print "Locked all influence weights in scene\n"; else print "Unlocked all influence weights in scene\n"; // optional: Relaunch the 'Paint Skin Weights Tool' //to see the effect of the code: ArtPaintSkinWeightsToolOptions; }}} Also see: *[[How is a joint's ".liw" (Lock Influence Weights) attribute connected, with regards to a skinCluster?]] The {{{animCurveEditor}}} command lets you access a named Graph Editor. It's confusing, since this is a UI element, you'd think in the Maya mel docs it'd be under the general "Windows" section, or maybe even "Panels \ Controls" sections. But no, it's under "Animation". Which makes sense too I suppose. But I don't like it... {{{graphEditor1GraphEd}}} is the name of the default Graph Editor. From the Maya docs on {{{animCurveEditor}}}: {{{ // Check to see if the "default" graph editor has been created animCurveEditor -exists graphEditor1GraphEd; // Show result curves animCurveEditor -edit -showResults on graphEditor1GraphEd; // Decrease the sampling rate for the result curves animCurveEditor -edit -resultSamples 5 graphEditor1GraphEd; }}} What I'm still trying to figure out: What kind of UI element //is// the 'graph-side' of a 'Graph Editor'? According to the {{{animCurveEditor}}} docs, it gets created by a {{{scriptedPanel}}}. The name of the panel that the default Graph Editor is associated with is {{{graphEditor1}}}: {{{ animCurveEditor -q -pnl graphEditor1GraphEd; // Result: graphEditor1 // }}} But that still dosn't answer the above question.... ---- FYI, the Outliner to the left of the Graph Editor is an {{{outlinerEditor}}} called {{{graphEditor1OutlineEd}}}, and it's parent is a {{{scriptedPanel}}} called {{{graphEditor1}}}. This appears to be the same {{{scriptedPanel}}} that is associted with the default Graph Editor (from above, which would make some sense). {{{ scriptedPanel -q -ex graphEditor1; outlinerEditor -q -ex graphEditor1OutlineEd; }}} If you want to be able to figure out what you have highlighted in that {{{outlinerEditor}}}, see here: [[How can I get a string array of the contents for a selectionConnection?]] Also: [[How can I highlight channels in the Graph Editor based on what's selected in the Channel Box?]] *Every DG node in Maya has the ability to have a "note" added to it, which exposed in the bottom of the Attribute Editor. Not really a convention, but a feature they exposed in the Attribute Editor around Maya 5? How do you update that via mel? *It would seem simple with a setAttr command. The issue is, that attr dosen't exist by default, so if you try to set it without creating it first, it won't work. When entering notes directly in the Attribute Editor, it creates the attr for you behind the scenes. {{{ // mel if(!attributeQuery -n$node -ex "notes")
addAttr -ln notes -dt "string" $node; setAttr ($node + ".notes") -type "string" "My notes";
}}}
{{{
# Python
import maya.cmds as mc
if not mc.attributeQuery('notes', node=node, exists=True):
mc.addAttr(node, longName='notes', dataType='string')
mc.setAttr('%s.notes'%node, "My notes", type='string')
}}}
{{{fileInfo}}}
*Note: This seems similar to the {{{optionVar}}} command, but stores the var's relative to the file, not wherever the optionVar's are stored.
*Example: store a "keyword" with a value in the scene:
{{{
fileInfo "secretData" "WarpCat was here...";
string $secretData[] = fileInfo -q "secretData"; }}} Based on a new install of Maya, I believe the default frame rate is set to '{{{Film (24 fps)}}}'. I work in games, where most of the time the frame rate should be set to '{{{NTSC (30 fps)}}}'. Based on the tools we use, if an animator loads a scene up, and starts animating at 24 fps, then loads it into our animation sequencer that expects things to be at 30fps,... bad things will happen. I've isolated two locations that need to be updated to ensure that whenever a scene is created \ opened, it will be a the right frame rate. For this example, we'll be using '{{{NTSC (30 fps)}}}'. !Location #1: Maya Preferences: Maya has its default preferences (''Window -> Settings / Preferences -> Preferences -> Settings -> Working Units -> Time'') that set the overall time for the scene. When you change the value, Maya calls to the {{{currentUnit}}} command to update the system. What's interesting, is that it //doesn't// seem to modify any {{{optionVar}}}s to store these settings. Look in the {{{global proc prefWndUnitsChanged()}}} in the script: {{{C:/Program Files/Autodesk/Maya<version>/scripts/startup/createPrefWndUI.mel}}} ...to see what's really going on. However, this value can be changed by incoming files with different values. So we need to do something else to ensue we have the correct settings when we open //any// scene... !Location #2: New Scene Options When you make a //new// scene (''File -> New -> Options''), there are //new scene options// where you can set the framerate. These will //override// anything set in your Maya preferences (see #1, above). This is a main gotcha I see for most people: They don't realize that these need updated as well. Changing the 'time' in these options //does// store the change in an {{{optionVar}}}. Look in {{{global proc setDefaultUnits()}}} in the script: {{{C:/Program Files/Autodesk/Maya<version>/scripts/startup/performNewScene.mel}}}} ... for more details. !The Solution: You need these options to be set every time you access a //new// scene, or open an //existing// scene. The best way I've found to do this is add a {{{scriptJob}}} your {{{userSetup.mel}}} that executes on any file access: {{{ // userSetup.mel global proc setNTSC(){ // Set our 'Maya preferences': currentUnit -t ntsc; // Set our 'new scene options': optionVar -sv workingUnitTimeDefault ntsc; } scriptJob -event SceneOpened setNTSC; scriptJob -event NewSceneOpened setNTSC; }}} Done: Anytime you open access a file, you're sure to know that it's at the correct framerate. With a bit more 'detection code', you could query what the values were before modification, and alert the user if any changes were taking place. {{{ string$format = "mayaAscii";
optionVar -sv defaultFileOpenType "mayaAscii";
optionVar -sv "defaultFileSaveType" $format; file -type$format;
}}}
Adding this to your {{{userSetup.mel}}} file will make sure that things are saved in that format by default, and the new scene that Maya opens with is also of that format.
When doing a "Save As", this will set the "File Type" under "General Options" to the defined {{{$format}}}. Optionally, if you really wanted to make sure your users always saved as a given format no matter what: Presuming you push a studio-wide {{{userSetup.mel}}}, in that file, you can set, via the {{{file}}} command, a {{{-preSaveScript}}} arg. That points to a script that will be ran before save. In that script, you can query for the file type, and if not the format you want, change the format, then save. @@Note:@@ Wing can interact with Maya in three different ways. This is one of the three. See an overview here on the whole system: [[Interaction between Wing and Maya]]. See ''Wing Setup Notes'' below for how to setup Wing to use this information. ---- Maya comes with its own cut of Python (see [[Python & Qt versions in Maya]]). The executable for that lives here on Windows: {{{ c:\Program Files\Autodesk\Maya<version>\bin\mayapy.exe }}} Or here on Mac: {{{ /Applications/Autodesk/maya<version>/Maya.app/Contents/bin/mayapy }}} You can execute this directly to launch an interactive prompt of Python (most commonly for batching purposes). Or, if you're running a Python IDE external to Maya, but you want Maya's Python calls to exist in it, you can point your IDE To that exe. There is often an option in your IDE to allow for this (Wing allows you to do this, for example). Once that executable has been started, you still need load and initialize Maya into that session. Per Maya's docs: "{{{These commands take a significant amount of time to execute as they are loading all of the Maya's libraries and initializing the scene.}}}" This is the code I use: {{{ try: import maya.standalone maya.standalone.initialize() print "Imported maya.standalone\n" except: print "Couldn't find 'maya.standalone' for import\n" }}} If you want that code to execute //every time// you launch Maya's version of Python (I do this in Wing), you can author the above code as a module, and point Python's {{{PYTHONSTARTUP}}} environment variable to it: {{{ PYTHONSTARTUP = <somePath>\<somePythonStartupModule>.py }}} I have [[Wing|For Python: Maya 'Script Editor' style IDE]] execute this code for my 'Maya Python coding sessions'. ---- The {{{maya.cmds()}}} library is actually empty on disk (go take a look for yourself) other than the {{{__init__.py}}} module that defines that dir structure //as// a library: {{{ C:\Program Files\Autodesk\Maya<VER>\Python\lib\site-packages\maya\cmds\ }}} Although you can fully access all Maya commands through Python like '{{{maya.cmds.ls()}}}', the Python {{{ls()}}} command wrapper has no physical location on disk: Until you execute the above code example ({{{import maya.standalone}}} ...), Python won't see any of the commands. If you want to get a better understanding, see the subject [[How does Maya populate maya.cmds?]]. !Wing Setup Notes *In Wing, create a new Project, and access the "Project Properties". *In the Environment tab: **Set "Python Executable" to "Custom", and browse to the path mentioned above with {{{mayapy.exe}}} in it. **Set "Environment" to "Add to inherited environment", and paste in the {{{PYTHONSTARTUP}}} path you authored above. **If you want Wing to be able to analyze your ~Maya-Python modules and give you functionality like "Go To Selected Symbol Definition" (ctrl+LMB on a symbol name, F4 hotkey on a symbol, etc), you can add the paths where they're stored to the "Python Path" section of the ui. If you're using Python's packaging system, you only need to add the root dir of each package to this field. **Hit OK *Be sure to "Save Project" ;)  Maya has the mel command {{{python}}}, which lets you execute Python code inside of mel. I will often author python modules outside of the defined 'Python PATH'. If you're in the middle of a mel script, and want to successfully execute Python code that isn't part of the Python path, how to do? Below is one method I have come up with. Presuming you're trying to execute some module called {{{c:\some\path\myModule.py}}}: {{{ // First, set the path to where the module lives, and import the // module. Note the use of Python single-quotes inside the // Maya double-quotes: python("import sys;" + "import os;" + "sys.path.append(os.path.normpath(r'c:/some/path'));" + "import myModule"); // Then, you can execute whatever function is in that module: string$results[] = python("myModule.someFunction()");
}}}
In theory, you could do it all in the same {{{python}}} call.  However, if you want to capture the return value from your executed module, you need to execute it in its //own// {{{python}}} command (according to the docs).  As well, you could split each execution into a separate {{{python}}} call (rather than using '+' to catenate the strings), but I try to keep it as compact as possible.

Also, why am I calling {{{os.path.normpath}}}?  Why not just use double-backslashes in the path name, rather than using forward-slashes, and making the string //raw// (via the little {{{r}}} in front of it)?
*Let's say your path was:  {{{"c:\temp"}}}
*But, when the interpreter sees {{{\t}}}, it thinks 'tab', and inserts a tab into your path:  {{{"c:	emp"}}}
*To author that with double-backslashes, so it would get read in properly: {{{"c:\\temp"}}}.  And in this example, it would work.  BUT:
*I have found mixing double-backslashs with //other// letter combinations creates all sorts of additional problems.  Plus, many Maya commands return forward-slash paths.
*So by passing a a //raw// ('{{{r}}}') string with forwardslashes, and then via {{{os.path.normpath}}} converting that to pythonic-backslashes, it circumvents this issue.


With the {{{python}}} mel command.
Example:  Presuming you have a python script called {{{returnRange.py}}}, with a {{{main}}} function, and that function returns a range of numbers based on two arguments:
{{{
// via mel:
python("import returnRange");
int $rangeInt[] = python("returnRange.main(1, 4)"); print$rangeInt;
1
2
3
}}}
See the Maya docs on how data type conversions are handled.
Also see:
*[[How can I execute mel code via Python?]]

It's possible you may want to execute a Python module, external from Maya, and not part of the system Python path, via mel.  Maybe it launches a custom window or something exciting like that.  Here's one solution:
{{{
string $module = "C:\\path\\to\\my\\module.py"; string$mName = basename($module, ""); string$dName = dirname($module); string$dosCmd = ("chdir " + $dName + " & start " +$mName);
system($dosCmd); }}} Via Maya's [[scriptJob|http://download.autodesk.com/us/maya/2010help/CommandsPython/scriptJob.html]] command, you can easily execute callbacks. And via Maya's [[scriptNode|http://download.autodesk.com/global/docs/maya2013/en_us/CommandsPython/scriptNode.html]] command, you can create 'script nodes' that can execute 'script jobs' when a scene opens. Via this method, its fairly trivial to create a {{{sciptJob}}} that will cause a script to evaluate whenever a certain attribute on a certain node changes. But this all breaks down if that file is referenced: Since the name of the node has now changed (due to the namespace), the {{{scriptJob}}} no longer detects it. Thanks to an undocumented tip from Mason Sheffield, you can actually put a wildcard ({{{*:objName.attr}}}) in front of the object name during the {{{scriptJob}}} authoring: It will now detect the {{{namespace:obj.attr}}} name in the reference. Awesome. However, there are two problems with this system: *Upon open of the un-referenced scene, you'll get a {{{RuntimeError}}} saying (for example): <<< {{{ # RuntimeError: Could not find attribute named "*:mynode.tx" # }}} <<< *If you reference the referenced scene (which can happen) : The {{{scriptJob}}} will no longer evaluate, since it's only looking 'one level deep' for the namespace. If you know this will be consistent, you can embed {{{*:*:}}} in front of your node, instead of just {{{*:}}}. ---- Here's an example of how to set it up: Create this script, and save it as {{{attrCallback.py}}}. Save it in Maya's script path. What does this script do? A: It creates a {{{scriptNode}}} that lives in the current scene, that will execute a {{{scriptJob}}} when that scene is opened. B: Whenever the {{{translateX}}} attr on a node called {{{mynode}}} is modified (in a scene referenced one level deep), it will execute the {{{attrCallback}}} //function//, which simply prints some text. {{{ # attrCallback.py import maya.cmds as mc def attrCallback(): print "mynode.tx changed!" def makeScriptNode(): scriptStr = 'import maya.cmds as mc\n'+\ 'import attrCallback\n'+\ 'mc.scriptJob(attributeChange=["*:mynode.tx", attrCallback.attrCallback])' mc.scriptNode( scriptType=2, beforeScript=scriptStr, name='myScriptNode', stp='python') }}} Make a new scene, and in it create a new node. Rename that node to {{{mynode}}}. In the script editor, execute: {{{ import attrCallback attrCallback.makeScriptNode() }}} This will create the {{{scriptNode}}}. Save your scene as {{{attrCallback.ma}}}. If you modify {{{mynode.translateX}}} nothing will happen, since the {{{scriptNode}}} is searching for the node in a sub-namespace (and it currently lives in the root namespace). Create a new scene. Reference in {{{attrCallback.ma}}}. Adjust the {{{mynode.translateX}}} : You should see the Script Editor starting printing the results from {{{attrCallback()}}}.  So simple, but I always seem to forget the syntax... :-S {{{ import maya.cmds as mc mc.skinCluster(someListOfJoints, aMesh, dropoffRate=5.0, maximumInfluences=4, toSelectedBones=True) print skinCluster # [u'skinCluster1'] }}}  Often times I want to call a function when I close/delete a window. Unfortunately there is no 'delete detection' for this via the {{{window}}} command and no way via the {{{window}}} command to assign callbacks. However I've found two ways to implement callback systems that do detect for window deletion: *Via the {{{OpenMayaUI}}} API, one can create a {{{MUiMessage_addUiDeletedCallback}}} object that will track when the given window is deleted, and execute the provided code when that happens. It also allows for an optional {{{clientData}}} parameter allowing you to easily pass data to the function upon window delete. **Note: It appears that this code runs just before, or possibly at the same time as the window is deleted: It can be used to execute code to safely delete {{{modelPanel}}}s before the window is deleted, when that same code would fail in the {{{scriptJob}}} callback. *It's easy to make a {{{scriptJob}}} which attaches itself to the window, executes when the window is deleted, and for safety can be set to only 'run once'. We have the {{{scriptJob}}} call to the a method on our {{{Window}}} object at time of death telling it what to do. It should be noted that this will execute the code after the window is closed. It should be noted that the {{{scriptJob}}} needs to be called before {{{showWindow}}} or it won't seem to attach correctly. Finally, even though these callbacks are executed when the window is closed, they appear to execute after the window is deleted. If you try to query part of the window ui in the callback, it will fail. I've got around this by storing the values I need to query in optionVar's. {{{ # Python code import maya.cmds as mc import maya.OpenMayaUI as omui class App(object): def __init__(self): self.name = 'myWin' if mc.window(self.name, exists=True): mc.deleteUI(self.name) mc.window(self.name) # OpenMayaUI callback example: omui.MUiMessage_addUiDeletedCallback(self.name, self.MUiMessageCallback, "clientData") # scriptJob callback example: mc.scriptJob(uiDeleted=[self.name, self.scriptJobCallback], runOnce=True) mc.showWindow() def MUiMessageCallback(self, clientData): print "MUiMessage_addUiDeletedCallback", clientData def scriptJobCallback(self, *args): print "scriptJobCallback", args }}} To launch the window: {{{ App() }}} When the window is closed, it will print: {{{ MUiMessage_addUiDeletedCallback clientData scriptJobCallback () }}} Notice how the {{{MUiMessage_addUiDeletedCallback}}} is executed first? {{{commandPort}}} *Example on a local network: First, "Open a commandPort in Maya": **(Win2000 syntax is "computerName:portNumber") {{{ commandPort -n "warpcat:8888"; }}} **How do I find my IP address if need be on Windows? At the Command Prompt (windows): {{{ >> ipConfig }}} **On your external machine or command prompt, open an app to talk with your other machine: ***On Unix, {{{telnet}}}. ***On Linux, {{{socat}}}. ***On Windows I HIGHLY recomend using [[Putty|http://www.chiark.greenend.org.uk/~sgtatham/putty/]], since according to some online threads I've read, W2K telnet acts "funny": It won't accept more than a single character at a time. As a result, you'll need to download a new client. And I've found that Putty works very well. **At the prompt: **Unix (this is the windows format, but I'm 'guessing' it's the same?): {{{ telnet warpcat 8888; }}} **Linux (tip from Hal Bertram): {{{ socat readline tcp4:localhost:8888 }}} ***From Hal: You can use socat instead of telnet to get a maya prompt that feels more like a shell with history, filename completion, and other readline goodness. **Windows: {{{ insert Putty example here }}} **Now you can start typing commands and executing them in Maya. ---- *Notes: **I've only tested this on windows with telnet and putty, FYI. Irony that I don't have a Putty example isn't it? The Python {{{maya}}} package has a {{{mel}}} module. In that, it has the {{{eval}}} function that can evaluate mel directly. Example: Presume you have a mel script called {{{returnRange.mel}}}, that has a {{{global proc returnRange}}} which returns a range of numbers based on two arguments {{{ # via python: import maya.mel as mm range = mm.eval("returnRange(1,10)") print range [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] }}} See the Maya docs on how data type conversions are handled. Also see: *[[How can I execute Python code via mel?]] *[[Understanding Python integration in Maya]] When you query the selection of vert via {{{ls()}}}, it will give you back data like so: {{{pPlane1.vtx[60]}}}. How can you get just the vert id number {{{60}}} from that string? Python's {{{re}}} module makes this pretty easy: {{{ # Python code import re myStr = 'pPlane1.vtx[60]' pattern = r'\d+' # This will return a list ["1", "60"], so grab the last item, & turn it into an int: vid = int(re.findall(pattern, myStr)[-1]) # 60 }}} See my notes on {{{lerp()}}} [[here|How can I find a value some percentage between two other values?]]. This expands on the concept, but using 3d points rather than single values. {{{p1}}} and {{{p2}}} are the two 3d points in space. {{{amt}}} is the percentage (from 0-1) between them you want to find the new point. If {{{amt}}} is {{{.5}}}, {{{lerp3D()}}} will return a point 50% between {{{p1}}} and {{{p2}}}: {{{ # Python code def lerp3D(p1, p2, amt): x = p1[0] + (p2[0] - p1[0]) * amt y = p1[1] + (p2[1] - p1[1]) * amt z = p1[2] + (p2[2] - p1[2]) * amt return [x, y, z] print lerp3d([2,2,2], [10,20,10], .25) # [4.0, 6.5, 4.0] }}} Since color values are also expressed (usually) as three floats, you could use this code to {{{lerp}}} colors too: {{{ print lerp3d([0,0,0], [255, 255, 255], .75) # [191.25, 191.25, 191.25] }}} But, you'd need to convert those to {{{int}}}'s to be usable. ---- For the opposite, see: *[[How can I find what percentage between a start and end value a mid value is?]] In other languages they have a {{{lerp()}}} command. Mel and Python don't seem to. Here's how it works: {{{val1}}} and {{{val2}}} are the two values. {{{amt}}} is the percentage (from 0-1) between them you want to find the new value. If {{{amt}}} is {{{.5}}}, {{{lerp()}}} will return the value 50% between {{{val1}}} and {{{val2}}}: {{{ # Python code def lerp(val1, val2, amt): return val1 + (val2 - val1) * amt print lerp(2, 16, .5) # 9 }}} {{{ // Mel code global proc float lerp(float$val1, float $val2, float$amt)
{
return $val1 + ($val2 - $val1) *$amt;
}

lerp(5, 10, .5);
// Result: 7.5 //
}}}
See docs, and visual examples for {{{lerp()}}} over at [[processing.com|http://www.processing.org/reference/lerp_.html]]
----
Also see:
*[[How can I find a 3d point some percentage between two other 3d points?]]
For the opposite, see:
*[[How can I find what percentage between a start and end value a mid value is?]]
Thanks to my bud Demetrius Leal on the tip with {{{netstat}}}:

On a //Windows// system, you can use {{{subprocess.Popen}}} to run the system {{{netstat}}} command.  It returns a file-object which you can then parse.  It should be noted that this doesn't need to be executed //in Maya//, it could be in an external Python shell.  But Maya needs to be running of course.  And you can run it in Maya if you feel like it ;)
{{{
# Python code
import subprocess

pipe = subprocess.Popen(['netstat', '-ab'], stdout=subprocess.PIPE)
data = [line.strip() for line in pipe.stdout]
for i,e in enumerate(data):
if 'maya.exe' in e and 'LISTENING' in data[i-1]:
print e, data[i-1].strip()
}}}
{{{-a}}} : Displays all connections and listening ports.
{{{-b}}} : Displays the executable involved in creating each connection or listening port.

Will print something like this (presuming you have active commandPorts in Maya...):
{{{
[maya.exe] TCP    [::]:6000              userName:0               LISTENING
}}}
It removes other ports that aren't 'LISTENING', since they'd probably do you no good anyway ;)
I recently had to find all the {{{animCurves}}} that were controlling a node.  At the time, it turned out to be a bit more difficult that it seemed so I came up with the API solutions (B, C) shown below:  See, the curves were in animation layers, and I wasn't getting the result I wanted with the {{{listConnections}}} or {{{listHistory}}} commands.
Thanks to a tip from Han Jiang (that he found over on [[Stack Overflow|http://stackoverflow.com/questions/18738371/how-to-find-all-upstream-dg-nodes-with-maya-python-api]], you can simply use Solution A.
!Solution A:
This will get keys on the node, and dig through the anim layers to find them as well.
{{{
import maya.cmds as mc
curves = mc.ls(mc.listHistory('joint1'), type = 'animCurve')
}}}
!Solution B: Use ~MAnimUtil
[[MAnimUtil|http://download.autodesk.com/us/maya/2010help/API/class_m_anim_util.html]] docs.
This is great, since it does all the heavy lifting for you:  Find all the attrs on the node that have incoming connections, and then for those connections, find the {{{animCurve}}}s controling them.
{{{
import maya.OpenMaya as om
import maya.OpenMayaAnim as oma

# Get a MDagPath for the given node name:
node = 'myNodeName'
selList = om.MSelectionList()
selList.add(node)
mDagPath = om.MDagPath()
selList.getDagPath(0, mDagPath)

# Find all the animated attrs:
mPlugArray = om.MPlugArray()
oma.MAnimUtil.findAnimatedPlugs(mDagPath, mPlugArray)
animCurves = []

# Find the curves ultimately connected to the attrs:
for i in range(mPlugArray.length()):
mObjArray = om.MObjectArray()
oma.MAnimUtil.findAnimation(mPlugArray[i], mObjArray)
for j in range(mObjArray.length()):
depNodeFunc = om.MFnDependencyNode(mObjArray[j])
animCurves.append(depNodeFunc.name())

# See what we found:
for ac in sorted(animCurves):
print ac
}}}
!Solution C: Iterate the DG:
The below example will print a list of all the animation curves on the selected objects, in animation layers or not.
{{{
# Python code
import maya.OpenMaya as om

animCurves = []
# Create a MSelectionList with our selected items:
selList = om.MSelectionList()
om.MGlobal.getActiveSelectionList(selList)

# Create a selection list iterator for what we picked:
mItSelectionList = om.MItSelectionList(selList)
while not mItSelectionList.isDone():
mObject = om.MObject()  # The current object
mItSelectionList.getDependNode(mObject)
# Create a dependency graph iterator for our current object:
mItDependencyGraph = om.MItDependencyGraph(mObject,
om.MItDependencyGraph.kUpstream,
om.MItDependencyGraph.kPlugLevel)
while not mItDependencyGraph.isDone():
currentItem = mItDependencyGraph.currentItem()
dependNodeFunc = om.MFnDependencyNode(currentItem)
# See if the current item is an animCurve:
if currentItem.hasFn(om.MFn.kAnimCurve):
name = dependNodeFunc.name()
animCurves.append(name)
mItDependencyGraph.next()
mItSelectionList.next()

# See what we found:
for ac in sorted(animCurves):
print ac
}}}
!Solution D: findKeyframe
Well, honestly, this really isn't a solution, but I wanted to put it in here anyway:
{{{
import maya.cmds as mc
node = "pCube1"
curves = mc.findKeyframe(node, curve=True, attribute='rotateX')
}}}
The {{{findKeyframe}}} command will return back the {{{animCurve}}} for a specific attribute, based on the //current {{{animLayer}}}//.
{{{listHistory}}}
I found the source of this code below:
{{{
..\Autodesk\Maya2010\Python\Lib\site-packages\maya\app\general\zipScene.py
}}}
The version Maya provides does more error checking, but below I add the ability to //not// store the dir structure of the zipped files, if you don't want to.

Surprisingly easy.

{{{
# Python code
# zipScene.py

import os
import locale
import zipfile
import maya.cmds as mc

def main(storePaths=False):
"""
If storePaths == True, then full directory paths are saved to each file in
the zip.  If False, then all files are at root level of zip.
"""
theLocale = locale.getdefaultlocale()[1]
files = mc.file(query=True, list=True, withoutCopyNumber=True)
zipFileName = os.path.splitext(files[0])[0]+'.zip'
zipper = zipfile.ZipFile(zipFileName, 'w', zipfile.ZIP_DEFLATED)

for f in files:
name = f.encode(theLocale)
if storePaths:
zipper.write(name)
else:
zipper.write(name, os.path.basename(name))
zipper.close()

for f in files:
print "\t",f
print "Added above files to zip:", zipFileName
}}}
I have a post on [[my blog|http://www.akeric.com/blog/?p=1087]] for this topic as well.

I'd tried a variety of methods using mel commands to try and trawl the scene looking for instances.  This worked well on shape nodes.  However, when it dawned on me you can instance transforms (or anything I suppose) just as easily as shapes, that code went out the window.  The Python ~OpenMaya API came to the rescue:
{{{
# Python code
import maya.OpenMaya as om

def getInstances():
instances = []
iterDag = om.MItDag()
while not iterDag.isDone():
instanced = om.MItDag.isInstanced(iterDag)
if instanced:
instances.append(iterDag.fullPathName())
iterDag.next()
return instances
}}}
This function will return a list of the full path to all instanced nodes in the scene.

The below function will then uninstance all those nodes:
{{{
import maya.cmds as mc
def uninstance():
instances = getInstances()
while len(instances):
parent = mc.listRelatives(instances[0], parent=True)[0]
mc.duplicate(parent, renameChildren=True)
mc.delete(parent)
instances = getInstances()
}}}
Note this is slightly destructive to any child nodes to those instances:  Any connections they have will be lost.  I have a mel workaround below (too lazy to port to Python):
----
Also see:
*[[How can I 'uninstance' a node?]] for other methods.
Say you have a polygonal mesh, with a bunch of joints bound to it.  How can you find, for a given joint, all the verts that have non-zero weights?
{{{
# Python code

import maya.cmds as mc
def getWeightedVerts(joint, geo):
geoShape = mc.listRelatives(geo, shapes=True, noIntermediate=True)
skinCluster = mc.listConnections(geoShape, source=True, destination=False,
type="skinCluster",
skipConversionNodes=True)[0]
vertCount = mc.polyEvaluate(geo, vertex=True)
nonZero = []
for i in range(vertCount):
weightVal = mc.skinPercent(skinCluster, geo+".vtx["+str(i)+"]",
transform=joint, query=True)
if weightVal > 0:
nonZero.append(geo+".vtx["+str(i)+"]")
return nonZero
}}}
Usage: (in Python)
{{{
joint = "l_knee"
geo = "legs"
print getWeightedVerts(joint, geo)
['legs.vtx[499]', 'legs.vtx[500]', 'legs.vtx[501]', etc...]
}}}
{{{ls}}}
{{{
// find all objects with an "outTime" attr in your scene:
string $attr = "outTime"; string$objs[] = ls -o ("*." + $attr); print$objs;
// time1
}}}
Notes:
*If you leave off the {{{-o}}} flag, it will return back the whole obj.attr name
*Sometimes, it will return back duplicate names for everything.  Weird.
*I can't believe it's taken me 8.5 versions of Maya to learn this... shame...  Thanks to Doug Brooks for showing me this :) 
Note, this can print a LOT of stuff depending on what's changed in the reference:
{{{
# Python Code
import maya.cmds as mc

allRefs = mc.file(query=True, reference=True)
for ref in allRefs:
refNode = mc.file(ref, query=True, referenceNode=True)

print refNode, ref
editStrings = mc.referenceQuery(ref, topReference=True, editStrings=True, successfulEdits=True)
for es in editStrings:
print "\t", es

# Remove all edits:
mc.file(unloadReference=refNode)
mc.file(cleanReference=refNode)
mc.file(loadReference=refNode)
}}}
----
This tip comes from over at the [[Maya Station|http://mayastation.typepad.com/maya-station/2010/01/remove-reference-edits.html]] blog:
<<<
If you have made changes to your reference file which has then caused incorrect results, For example making changes to an expression then saving the reference file causes you to lose your expression information; simply reloading the reference file will not be enough to get the original data back.

You will need to remove the wrong edits.   In order to do this you need to unload your reference from the Reference Editor, and then go to Reference Editor ->List Reference Edits.   In the window that pops up select the wrong edits and click on Remove Selected Edits.  Once this is done you can Reload you reference, through the reference editor.
<<<

{{{file}}}
*Example:
{{{
string $alldependencies[] = file -q -l; }}} Also check out the {{{filePathEditor}}} command. I should note that this tool only lists dependencies it can actually find. For example, if the user types in a path to a texture that's not on disk, this tool won't return that path, since the texture can't be found. ---- Also see: *[[How can I find all the references in the scene?]]  {{ls}} Example A: Find all objects with the string "bob" in their name: {{{ ls "*bob*"; }}} Example B. Find all "transforms" with the string "larry" in their name: {{{ ls -type transform "*larry*"; }}} And by references, I mean file references. !!!Commands: This Python command would seem to do it: {{{ import maya.cmds as mc topRefs = mc.file(query=True, reference=True) }}} But in fact it will only return the top-level references. Meaning, if you've referenced {{{C.ma}}} into your scene, but in fact it references {{{B.ma}}} and {{{A.ma}}}, only {{{C.ma}}} would be returned. You can use //this// solution instead to get all the references, //and// subreferences. However, it will return back everything 'referenced' in the scene, including textures, so we need to filter it by only maya files. Plus we sort it, and remove any dupes: {{{ allrefs = mc.file(query=True, list=True, withoutCopyNumber=True) fileRefs = sorted(list(set([item for item in allrefs if item.endswith(".ma") or item.endswith(".mb")]))) }}} You can optionally use this ~PyMel code. It returns a dict of {"namespace":"filepath"}: {{{ import pymel.core as pm refs = pm.getReferences(recursive=True) fileRefs = [str(refs[r]) for r in refs] }}} !!!API (Starting in Maya 2011) {{{ import maya.OpenMaya as om topRefs = [] om.MFileIO.getReferences(topRefs) }}} However, this suffers the same fate as the top {{{file}}} command example: Only returns top-level references. This emulates the second command example above, but via the API call, giving you all the subreferences as well: {{{ allrefs = [] om.MFileIO.getFiles(allrefs) fileRefs = sorted(list(set([item for item in allrefs if item.endswith(".ma") or item.endswith(".mb")]))) }}}  {{{listSets}}} Let's you query convenient things like object sets, or rendering sets (shadingEngines. or shaders).  Given this hierarchy: *top **middle1 ***bottom11 ***bottom12 **middle2 {{{ string$kids[] = ls "middle1|*";
// Result: bottom11 bottom12
string $kids[] = ls "top|*"; // Result: middle1 middle2 }}} Basically {{{ls}}} is finding those strings in the full path of the object names since we include the pipe in the search. Tricky! In both examples, you pass in a mesh\vertex ID, it returns back the names of all the verts connected to that one based on common edges. The API version is a lot less code... half of it is just getting an ~MObject... !!! Via the Maya API: {{{ import maya.OpenMaya as om def getConnectedVerts(mesh, vtx): """ Parameters: mesh : string : Name of the mesh to query. vtx : int :The specific vert index to query. return : list : List of full mesh.vtx[#] items that connect. """ # Get an MObject for the passed in mesh: selList = om.MSelectionList() selList.add(mesh) mObject = om.MObject() selList.getDependNode(0, mObject) ret = [] iterVert = om.MItMeshVertex(mObject) while not iterVert.isDone(): if iterVert.index() == vtx: intArray = om.MIntArray() iterVert.getConnectedVertices(intArray) ret = ['%s.vtx[%s]'%(mesh, intArray[i]) for i in range(intArray.length())] break iterVert.next() return ret }}} {{{ mesh = 'pPlane1' vtx = 61 print getConnectedVerts(mesh, vtx) # ['pPlane1.vtx[62]', 'pPlane1.vtx[50]', 'pPlane1.vtx[60]', 'pPlane1.vtx[72]'] }}} !!! Via Maya commands: The {{{polyInfo}}} command returns back its info in a really weird way, so we have to chop it up to make it usable. {{{ import re import maya.cmds as mc def getConnectedVerts(mesh, vtx): """ Parameters: mesh : string : Name of the mesh to query. vtx : int :The specific vert index to query. return : list : List of full mesh.vtx[#] items that connect. """ sourceV = '%s.vtx[%s]'%(mesh,vtx) eStr = mc.polyInfo(sourceV, vertexToEdge=True)[0].strip() edges = ['%s.e[%s]'%(mesh, item) for item in re.split('[: ]', eStr.strip().split(':')[-1])[1:] if item] vStrs = mc.polyInfo(edges, edgeToVertex=True) verts = [] for vStr in vStrs: ids = [] for item in re.split('[: ]', vStr.strip().split(':')[-1])[1:]: if not item: continue try: # I once saw a values passed in as 'Hard': only ints allowed: ids.append(int(item)) except: continue # Remove any dupes: ids = list(set(ids)) tempVs = ['%s.vtx[%s]'%(mesh, item) for item in ids] for item in tempVs: if item not in verts: verts.append(item) verts.remove(sourceV) return verts }}} {{{ mesh = 'pPlane1' vtx = 61 print getConnectedVerts(mesh, vtx) # ['pPlane1.vtx[72]', 'pPlane1.vtx[60]', 'pPlane1.vtx[50]', 'pPlane1.vtx[62]'] }}} {{{getPanel}}} {{{fileExtension}}} {{{currentTime}}} *Example: {{{ float$frame = ‘currentTime -q‘;
}}}

*At the Command Prompt
{{{
>> lmutil lmstat -c <licence file name> -a
}}}
*Notes:
**{{{lmutil}}} is usually found here: {{{c:/aw/com/bin}}}
***But since Autodesk bought Maya, it's probably in a new dir...
**<licence file name> is usually {{{c:/flexlm/aw.dat}}}
{{{polyEditUV}}}

*Example: find a UV called object.map[21]
{{{
polyEditUV -q -uValue object.map[21];
}}}
* Example: Select a vertex, and find it's U value:
{{{
string $sel[] = ls -fl -sl; string$UV[] = polyListComponentConversion -tuv $sel[0]; float$uval[] = polyEditUV -q -uValue $UV[0]; }}} {{{system}}} & {{{set}}} (windows command) (and others): {{{ string$envVar = eval "system \"set MAYA\"";
string $buffer[]; tokenize$envVar "=" $buffer; print$buffer;
}}}
*The system call returns all the variables as a single string, so to make sense of them, tokenize the output by the equals "=" sign.
*To get a list from Windows Command Line, you'd simply type "set MAYA" at the prompt. What's interesting is that Windows doesn't see any environment variables defined by the Maya.env file, but if you make the call like above IN Maya, the variables are visible.
!!!Python:
{{{
import os
msp = os.getenv("MAYA_SCRIPT_PATH")
}}}
!!!Mel:
{{{getenv}}}
*Example:
{{{
string $msp = getenv MAYA_SCRIPT_PATH; }}} The documentation: Example: *Essentials -> Basic Features -> Setting Environment Variables -> Standard Maya environment variables {{{currentCtx}}} {{{translator}}} *Example: {{{ translator -q -do "animImport"; translator -q -do "animExport"; }}}  {{{ string$user = getenv USER;
string $user = getenv USERNAME; }}} i.e., what "kind" of node is' lambert'? This appears to function on non-DAG objects. {{{getClassification}}} {{{ getClassification "lambert"; // Result: shader/surface // }}}  For example, given a poly sphere, named "bob", what type of node is "bob"? (transform). What kind of node is "bobShape"? (mesh\nurbsCurve\etc.). {{{nodeType}}} This is very similar to {{{objectType}}} For example, given a sphere named "bob", what type of object is "bob"? (transform) What type of object is "bobShape"? (mesh) {{{objectType}}} This is very similar to {{{nodeType}}} Given a list of any number of nodes, how can I find their average position in worldspace? First, we need to write a function that can calculate the average value of any number of passed in nodes: {{{ # Python code def average(*args): # find the average of any number of passed in values return sum(args) / len(args) }}} This function is so simple however, it could be written as a lambda: {{{ lambda *args:sum(args)/len(args) }}} Then we can use Python's {{{map}}} built-in function to apply our average function to our positional values. Here it is all on one line using a 'list comprehension', based on selected objects: {{{ import maya.cmds as mc avg = map(lambda *args:sum(args)/len(args), *[mc.pointPosition(p+".rotatePivot", world=True) for p in mc.ls(selection=True)]) }}} ---- But that one line can be hard to read. Below illustrates how to 'simplify' it into multiple lines: Simplification step #1: Move out list of selected objects to its own line and variable. {{{ import maya.cmds as mc transforms = mc.ls(selection=True) avg = map(lambda *args:sum(args)/len(args), *[mc.pointPosition(p+".rotatePivot", world=True) for p in transforms]) }}} Simplification step #2: Move our list of positions to it's own line and variable. {{{ import maya.cmds as mc transforms = mc.ls(selection=True) positions = [mc.pointPosition(p+".rotatePivot", world=True) for p in transforms] avg = map(lambda *args:sum(args)/len(args), *positions) }}} Simplification step #3: Get rid of the lambda, go back to the average() function: {{{ import maya.cmds as mc def average(*args): return sum(args) / len(args) transforms = mc.ls(selection=True) positions = [mc.pointPosition(p+".rotatePivot", world=True) for p in transforms] avg = map(average, *positions) }}} And the end result of all three would look something like this, based on what you had initially picked: {{{ [110.11913165450096, 163.66115890443325, 40.902932167053223] }}} There are two keys to this: #Our {{{average}}} function \ {{{lambda}}} statement can accept any number of passed in arguments via it's {{{*arg}}} argument. #The {{{map}}} function also accepts any number of arguments, via it's {{{*positions}}} (simplification #2) or {{{*[list comprehension]}}} (simplification #1 or first example). I have quite a few notes on list comprehensions and the map function on my [[Python Wiki|http://pythonwiki.tiddlyspot.com/]] This is in relation to DAG nodes. {{{listRelatives}}} In Maya v7 or LESS: {{{closestPointOnMesh.mll}}} ships with Maya's "Bonus Game Tools", and will create a {{{closestPointOnMesh}}} node. You can download this through Autodesk's '[[Area|http://area.autodesk.com/index.php/downloads_plugins/plugins_list/]]' In Maya v8+: It now ships with the ability to create a {{{closestPointOnMesh}}} node, no plugin required! I hear it also has a {{{nearestPointOnMesh}}} node, which is "slower". I have yet to test this. I've not tried it, but it may be worth checking out a solution using [[MMeshIntersector|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m_mesh_intersector.html]]. There is an example using it online [[here|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/index.html?url=cpp_ref/closest_point_cmd_8cpp-example.html,topicNumber=cpp_ref_closest_point_cmd_8cpp_example_html,hash=_a33]] Expanding the notes on [[How can I query the color at a certain UV point on a render node?]], here's how you can find a color based on the location of a given vertex: {{{ // define vert to query, and render node to lookup color from: string$myVert = "myGeo.vtx[88]";
string $myRenderNode = "myFileNode"; // convert from vert to uv: string$uv[] = polyListComponentConversion -tuv $myVert; // Get the UV value of the given vert. The previous // command can return multiple uv's if on a uv border // edge, so we sample the first one found: float$uvVal[] = polyEditUV -q -uValue $uv[0]; // then find the color at hat UV, on the given render node (file, ramp, etc) float$rgbCol[] = colorAtPoint -o RGB -u $uvVal[0] -v$uvVal[1]  $myRenderNode; // 0.482353 0.427451 0.423529 // }}} {{{getFileList}}} *Example: Get a list all the ".mov" files in a specific directory: {{{ string$fileList[] = getFileList -fld "c:/mayaStuff/myFiles/"  -fs "*.mov";
}}}

Some math!
Below example queries the position of two nodes in worldspace, and finds the distance between:
!!!Python:
{{{
import maya.cmds as mc
from math import sqrt

def distBetween(nodeA, nodeB):
posA = mc.xform(nodeA, query=True, worldSpace=True, rotatePivot=True)
posB = mc.xform(nodeB, query=True, worldSpace=True, rotatePivot=True)
dist = sqrt( sum( map( lambda x:pow(x[0]-x[1], 2), zip(posA, posB) ) ) )
return dist
}}}
I think this is a fairly Pythonic way of doing it:  Grab the worldspace rotate pivot positions of the two nodes.  Wrapper a  {{{lambda}}} statement and {{{zip}}} inside a {{{map}}} function. The {{{lambda}}} statement creates an 'anonymous function' that will receive each index in our zipped list as passed to it from the {{{map}}}.   The {{{zip}}} groups their xyz position values into a list, giving you: {{{[ [posA[0],posB[0]], [posA[1],posB[1]], [posA[2],posB[2]] ]}}}.   The {{{lambda}}} then splits out the two values from each list index, subtracts B from A, and raises it to the power of two.  Finally, the three 'powered' values are summed together, and the square root is generated giving us the distance!

This is exactly what the mel example is doing below, it's just doing it on a single line using using Python's built-ins.
!!!Maya Python API:
Via the Python API, you can use the {{{MPoint}}} class, which does all this for you.
http://download.autodesk.com/us/maya/2010help/API/class_m_point.html
{{{
from maya.OpenMaya import MPoint

p1 = MPoint(0,0,0)
p2 = MPoint(3,0,0)
distance = p1.distanceTo(p2)
}}}
{{{
print distance
3.0
}}}
!!!Mel
{{{
float $pointA[] = {0,0,0}; float$pointB[] = {3,0,0};
float $distance = sqrt( pow(($pointA[0] - $pointB[0]), 2) + pow(($pointA[1] - $pointB[1]), 2) + pow(($pointA[2] - $pointB[2]), 2) ); }}} {{{getAttr}}} - but it's the .cp attr that holds the local position, while the .pnts attr holds the tweak value *Example: {{{ polyCube; select -r pCube1.vtx[0]; getAttr pCube1.cp[0]; move -r .1 .1 .1; //Result: 0.1 0.1 0.1 // // need to source the .xv val separately rather than the whole compound value. getAttr pCube1.cp[0].xv; //Result: -0.4 // Real x position (-.5 + .1) }}} The {{{maxValue}}} attribute on the shape node of your NURBS curve will tell you this. {{{ import maya.cmds as mc uVal = mc.getAttr('myCurveShape.maxValue') }}} You could then (for the sake of example) select that point on the curve via: {{{ mc.select('myCurve.u[%s]'%uVal) }}} It should be noted that this length is in 'internal units' (cm), not necessarily what your 'ui units' are. I seem to do this just not quite often enough to remember how to do it, so I'll make a note here. Func returns a tuple containing the min and max frame range based on the list of nodes passed in. {{{ # Python code import maya.cmds as mc def getMinMaxAnimRange(nodes): first = 0 last = 0 curves = mc.listConnections(nodes, source=True, destination=False, type='animCurve') if curves is not None: first = mc.findKeyframe(curves, which='first') last = mc.findKeyframe(curves, which='last') return (first, last) }}} ---- Also see: *[[How can I find the min and max keyframe values for all objects in the scene?]]  Will return back a float array with two items, the [start, end] frames: !!!Mel: Will select the curves in the process: {{{ global proc float[] returnFrameRange(){ select -r ls -type "animCurve"; return {float(findKeyframe -which first), float(findKeyframe -which last)}; } }}} !!!Python Not based on selection. {{{ import maya.cmds as mc def sceneFrameRange(): animCurves = mc.ls(type='animCurve', recursive=True) minF = mc.findKeyframe(animCurves, time=(":",), which="first") maxF = mc.findKeyframe(animCurves, time=(":",), which="last") return minF, maxF }}} Note the special time arg signature. Without that magic it won't properly find all the keys, and just return back zero :S ---- Also see: *[[How can I set the range slider to match the keyframe range on the selected object(s)?]] *[[How can I find the min and max keyframe range for the provided objects?]] !!!Method A, via Python: {{{ import maya.cmds as mc menus = mc.window('MayaWindow', query=True, menuArray=True) # [u'mainFileMenu', u'mainEditMenu', u'mainModifyMenu', u'mainCreateMenu', ... }}} !!!Method B, via mel: All of Maya's main menu's are prefixed with {{{$gMain}}}... Here's how to get a list of them all:
{{{
string $all[] = env; for($i=0;$i<size($all);$i++) { if(match "^\\$gMain" $all[$i] == "$gMain") { global string$temp;
eval("$temp = " +$all[$i]); print ($all[$i] + " = " +$temp + "\n");
}
}
}}}
Also see:
*[[How can I update Maya's menus with my own entry?]]
When referencing multiple files into the same scene while passing each the same namespace, Maya will automatically increment the namespace name.  But via code, this can be tricky to find out.  ~PyMel makes this pretty easy via its {{{createReference}}} command:  It returns back a {{{FileReference}}} object on which you can query a {{{.namespace}}} attr, that holds the namespace name that was used (and possibly incremented):
{{{
import pymel.core as pm

assetPath = "c:/temp/myAwesomeAsset.ma"
ns = "myAwesomeNamespace"
myRef = pm.createReference(assetPath,namespace=ns)
newNS = myRef.namespace
}}}
~PyMel Docs :
*[[createReference|http://download.autodesk.com/global/docs/maya2014/en_us/PyMel/generated/functions/pymel.core.system/pymel.core.system.createReference.html#pymel.core.system.createReference]]
*[[FileReference|http://download.autodesk.com/global/docs/maya2014/en_us/PyMel/generated/classes/pymel.core.system/pymel.core.system.FileReference.html#pymel.core.system.FileReference]]
----
Thanks to Mason Sheffield for the tip.
!!!~PyMel:
{{{
import pymel.core as pm
myNode = pm.PyNode("namespace2:namespace1:objectName")
print myNode.namespace()
print myNode.parentNamespace()
# namespace2:namespace1:
# namespace2:namespace1
}}}
!!!Python:
Single-line solution //not// using regular expressions:
{{{
name = "namespace2:namespace1:objectName"
ns  = name[:-len(name.split(':')[-1])]
# namespace2:namespace1:
}}}
----
Single-line regular-expression solution:
{{{
import re
name = "namespace2:namespace1:objectName"
ns = re.findall('.*:', name)[0] if len(re.findall('.*:', name)) else ""
# namespace2:namespace1:
}}}
----
Older multi-liner regular expression solution:
{{{
import re
name = "namespace2:namespace1:objectName"
ns = ""
try:
ns = re.match('.*:', name).group(0)
except AttributeError:
pass
# namespace2:namespace1:
}}}
!!!Via the API
{{{
# Python code:
import maya.OpenMaya as om

node = 'foo:objectName'
MSelectionList = om.MSelectionList()
MSelectionList.add(node)
MDagPath = om.MDagPath()
MSelectionList.getDagPath(0, MDagPath)

MFnDependencyNode = om.MFnDependencyNode(MDagPath.node())
namespace = MFnDependencyNode.parentNamespace()
# foo
}}}
!!!Mel:
Single line using regular expressions:
{{{
string $name = "assG:bzspsG:asdf:bob"; string$namespace = match ".*:"  $name; // Result: assG:bzsps:asdf: // }}} What the match is saying is: 'as long as I can find some sequence of characters followed by a colon, return that". Once it hits the last colon, it stops matching. {{{pointOnSurface}}} *Example, presuming your shape node is called "nurbsSphereShape1?": {{{ float$normal[] = pointOnSurface -u .5 -v .5 -normal nurbsSphereShape1;
}}}
{{{pointOnCurve}}}
{{{
string $sel[] = ls -sl; referenceQuery -f$sel[0];
}}}

Using [[OpenMaya.MImage|http://download.autodesk.com/us/maya/2010help/api/class_m_image.html#6c551f85e73c1e71b0490dc004fbba4c]] via Python:
{{{
# Python code:
import maya.OpenMaya as om

def getResolution(imagePath):

image = om.MImage()
image.readFromFile(imagePath)

# MScriptUtil magic found here:
# http://download.autodesk.com/us/maya/2010help/api/custom_image_plane_8py-example.html
# But there was a bug in their code:  You need to make a unique MScriptUtil object
# for each pointer:  They were sharing one, which caused the result to be the same
# x,y resolutions, even on rectangular images

# To get the width and height of the image an MScriptUtil is needed
# to pass in a pointer to the MImage::getSize() method
scriptUtilW = om.MScriptUtil()
scriptUtilH = om.MScriptUtil()
widthPtr = scriptUtilW.asUintPtr()
heightPtr = scriptUtilH.asUintPtr()

image.getSize( widthPtr, heightPtr )

width = scriptUtilW.getUint(widthPtr)
height = scriptUtilH.getUint(heightPtr)

return (width, height)
}}}
{{{
imagePath = r'C:\temp\myImage.BMP'
print getResolution(imagePath)
# (64x64)
}}}

----
{{{getAttr}}} & the {{{file}}} node:

Presuming a texture has been assigned to a {{{file}}} texture node, you can use the {{{.outSizeX}}} and {{{.outSizeY}}} attrs on the {{{file}}} node to get the pixel dimensions.
{{{
string $xSize = getAttr "file1.outSizeX"; }}} The below examples expects {{{$object}}} to be some transform-level name:

Method A:
{{{
// Query the object directly (transform level, presuming it HAS a bound shape)
string $cluster = findRelatedSkinCluster$object;
}}}
Method B:
{{{
// query the shape of $object (useful if the object has multiple shape nodes): string$shape[] = listRelatives -s -ni $object; string$cluster = findRelatedSkinCluster $shape[0]; }}} Method C: {{{ // different approach: Use node connections to find it: string$shape[] = listRelatives -s -ni $object; string$cluster[] = listConnections -s 1 -d 0 -type "skinCluster" -scn 1 $shape[0]; }}} ---- {{{findRelatedSkinCluster}}} is a mel script located here: {{{C:\Program Files\Autodesk\Maya<VERSION>\scripts\others\findRelatedSkinCluster.mel}}}  Given a polygonal object that has different UV shells (it's been mapped different ways), how can you get what uv's are in those contiguous shells? Maybe there's a fancier way to do this, via some built-in command, but I couldn't find it. This tool will walk though each UV, expand the selection to the shell it lives in, and then compare the names of what is selected to a list of current shells (and a 'shell' is a sublist of uv's). If the current list finds no matching sublist, it adds itself in. {{{ import maya.cmds as mc import maya.mel as mm def uvShellsFromSelection(): sel = mc.ls(selection=True) shells = [] uvs = mc.ls(mc.polyListComponentConversion(sel, toUV=True), flatten=True) for uv in uvs: mc.select(uv) mm.eval('polySelectBorderShell 0') shell = mc.ls(selection=True) if shell not in shells: shells.append(shell) return shells }}} Presuming the surface is enclosed, you can use this script that comes with Maya: {{{ C:/Program Files/Autodesk/Maya<version>/scripts/others/computePolysetVolume.mel }}} Note: sometimes this likes to return negative values, so use the {{{abs}}} command to correct for it. This could be a vertex, particle, CV, lattice point, etc. If querying a face (or other poly element), it will return the positions of each vertex associated with the face. {{{pointPosition}}} Here's some //Python// code that will return a list with the worldspace position for every component selected, based on using a //list comprehension//: {{{ import maya.cmds as mc pts = [mc.pointPosition(point, world=True) for point in mc.ls(selection=True, flatten=True)] }}} Given a default polygonal cube, if you selected its verts and executed the above you'd get: {{{ print pts [[-0.5, -0.5, 0.5], [0.5, -0.5, 0.5], [-0.5, 0.5, 0.5], [0.5, 0.5, 0.5], [-0.5, 0.5, -0.5], [0.5, 0.5, -0.5], [-0.5, -0.5, -0.5], [0.5, -0.5, -0.5]] }}} I ran into an instance where I had an asset with //many// shaders assigned, and I had to import in a new one and assign it. But when I imported in the new one (not knowing the name), I couldn't figure out which one it was. I wrote this code to find all //shadingEngines// (shaders) in the scene that weren't assigned to anything. //Actually// its the other way around: shadingEngines are sets, so you assign things //to them//. As well, //materials// (phong, lambert, etc) plug into shadingEngines, nothing is actually 'assigned to a material', or vice-versa: {{{ # Python code import maya.cmds as mc def findUnusedShaders(): shadingEngines = mc.ls(type='shadingEngine') unused = [] for se in shadingEngines: items = mc.sets(se, query=True) if items is None: unused.append(se) return unused }}} {{{ unused = findUnusedShaders() }}}  The mel {{{linstep}}} command. This command isn't available in Python. Make your own: {{{ def percentBetween(val, origMin, origMax): return float(val - origMin) / float(origMax - origMin) }}} {{{ print percentBetween(5, 0, 10) 0.5 }}} ---- For the opposite, see: *[[How can I find a value some percentage between two other values?]] *[[How can I find a 3d point some percentage between two other 3d points?]]  Normal maps are finicky things: Often it seems that the green channel needs to be flipped to be viewed properly in Maya relative to how it should be in your game engine. I've written tools to do this, but a modeler just clued me in: Maya has this built in, it's just a bit buried: Select the shape node of your mesh, and in the Attribute Editor under the 'Tangent Space' frame, you can swap the 'Coordinate System' from 'Right Handed' to 'Left Handed', which effectively reverses the green channel of the normal map. Or, here is some ~PyMel to set the {{{tangentSpace}}} enum attr: {{{ # Make all "Tangent Space" Coordinate Systems "Right Handed" import pymel.core as pm allMesh = pm.ls(type='mesh') for mesh in allMesh: mesh.tangentSpace.set(2) }}} {{{ # Make all "Tangent Space" Coordinate Systems "Left Handed" import pymel.core as pm allMesh = pm.ls(type='mesh') for mesh in allMesh: mesh.tangentSpace.set(0) }}}  Windows System Call: {{{ // The number specified is in seconds. However, I have seen this vary on different systems. Weird. system "sleep 3"; }}} Maya command: {{{ pause -sec 5; }}}  Sometimes when writing code that calls to many other procedures, you can run into issues where code will start executing out of order. *In one instance, I'd import a file, and constrain something to it. But the end result had all sorts of problems: the item constrained was in the wrong location. I tried using commands like {{{dgdirty -a}}} and runTimeCommands like {{{EvaluateAll}}} in my code to fix the issues, but neither of them worked. *I figured out though, that by advancing the frame by 1 (and then setting it back), it absolutely makes the scene refresh. This solved the issue. *In the case of my example, come to find out when the rig was imported into the scene, some of its plugs were dirty, thus it was in the wrong location. {{{dgdirty}}} simply made //everything dirty//, and it wouldn't "fix" itself until the next free cycle, which happened //after// I'd constrained my other object and all my code stopped running. {{{EnableAll}}} seemed to have the same effect: Nothing was evaluated until the next free cycle, which was after the code finished. Since I put the frame changing code in the //middle// of my scripts, it forced all the plugs to evaluate themselves //during// the code evaluation. ''Update #3'': I have yet to test it, but there is also the mel command {{{refresh}}} that should be investigated. ''Update #2'': I got the bottom most code working, but I found the secret was this: I needed to run it just before my scene import: Again, I'd have issues where I'd import a scene, run the below refresh code, and it wouldn't work. But if I found that I ran it just before I imported the scene, success! ''Update #1'': The bottom code block was what I //had// been doing. Then I found instances where even it wasn't working: I had proven examples of frames advancing, but the mel after it executing and finishing //before// the frame advanced had finished. Argh! Doing more research, I change approaches: Using the {{{play}}} command, it has a flag called {{{-wait}}} that //forces// Maya to take a break while things are playing. THIS, fixed it: You set the framerange to be one more than the start frame, play that range, then set all your defaults back. ''One other thing'': I found another issue of when neither of these code bits worked: I was setting a dynamic initial state on a softbody mesh, and all parts of that dynamic system were hidden. I found that making that system //visible//, then changing the frame, then setting it back invisible again refreshed it. I thought that calling {{{dgdirty -a}}} before the frame change would cause the plugs to dirty, and force a refresh, but even that didn't do it. In this case, Maya was simply too optimized for its own good. {{{ // define our init values: float$startF = playbackOptions -q -minTime;
float $endF = playbackOptions -q -maxTime; string$loopMode = playbackOptions -q -loop;

// start the playback
currentTime $startF; playbackOptions -loop "once"; playbackOptions -maxTime ($startF+1);
play -wait;

// reset the default values
currentTime $startF; playbackOptions -maxTime$endF;
playbackOptions -loop $loopMode; }}} Another method, still trying to figure out which method is best. {{{ // force the scene to refresh by changing the frame: float$time = currentTime -q;
currentTime ($time + 1); currentTime$time;
}}}
Also see:
*[[How can I Enable \ Disable node evaluation?]]
The animators wanted a tool that would let them grab the faces on the bottom of a characters foot, and generate a representative curve from the border of the selection, which they could use for foot placement reference in their animation.  The below code does that:  Based on a selection of faces, create a nurbs curve that surrounds their border.  However, for speedy coding purposes, it generates a nurbs curve //per edge segment//, and parents them all to a single transform, rather than making a //single curve// for all the points.  That would take more work, since you have to deal with point ordering issues within your selection ;)
{{{
# Python code
# Select polygonal faces, and execute

import maya.cmds as mc

border = mc.polyListComponentConversion(toEdge=True, border=True)
border = mc.ls(border, flatten=True)
if len(border) == 0:
raise TypeError("Please select polygonal faces before executing")
else:
curveList = []
for edge in border:
edgePts = mc.polyListComponentConversion(edge,  toVertex=True)
edgePts = mc.ls(edgePts, flatten=True)
pts = [mc.pointPosition(point, world=True) for point in edgePts]
curveList.append(mc.curve(name="faceToCurve#", degree=1, point=pts))

parent = mc.group(empty=True, name="faceToCurveNode#")
for c in curveList:
shapes = mc.listRelatives(c, shapes=True)
mc.parent(shapes, parent,  shape=True, relative=True)
mc.delete(c)
mc.xform(parent, centerPivots=True)
mc.select(parent)
print "Created '" + parent + "'",
}}}
Name clashing in Maya is a real pain.  Some tools will return back full paths for a node, while others only return back the leaf name.  So a safe way to deal with this is to always generate nodes with unique names, based on what's currently in the scene.
''Update #2:''
'Update #1' works if you can define the names at the time of creation.  But what if your code gives you a name with a number postfix on the end that could be clashing with something else in the scene?  This example shows how to capture the end postfix numbers, remove them, and then add the magical 'pound\hash' symbol that does the name updating that we love:
{{{
#Python code:
import re
import maya.cmds as mc

# create an empty group
mc.group(empty=True, name="group1")
# create another empty group as its child
mc.group(empty=True, name="group2", parent="group1")
# create a third empty group, that clashes names with the second group.
# but since the second group is in a group, Maya allows this
group = mc.group(empty=True, name="group2")

# find the end number on our name:
endNum = re.findall('[0-9]+$', group) try: # try to rename, presuming we found a number newName = group[:-len(endNum[0])]+"#" mc.rename("|"+group, newName) except IndexError: # do nothing if no end number is found. pass }}} ''Update #1:'' Originally I had the below (old) code to check to see if a name already exists, and return back the unique name. But then I got tipped that if you simply use the 'pound' symbol ({{{#}}}) at the end of any object name (when created), it'll always return back a unique name: {{{ #Python code import maya.cmds as mc # make first group. Is called "group1" g1 = mc.group(empty=True, name="group#") # make second group called "group2", which "group1" is now a child of g2 = mc.group(name="group#") # make third group as a new hierarchy. It is automatically named "group3" g3 = mc.group(empty=True, name="group#") }}} The resulting heirarchy looks like this: (no name clashing!) *{{{group2}}} **{{{group1}}} *{{{group3}}} If you //didn't// use the '{{{#}}}' at the end of the names, the resulting hierarchy would look like this: (name clashing) *{{{group1}}} **{{{group}}} *{{{group}}} ---- ''Old code:'' The below goes into a loop checking for the current '{{{checkName}}}'. If it finds a node by that name, it simply prepends an increasingly higher number to the end of the name, and does the check again. When it finds a version of the name with no match, it returns the new name. {{{ # Python code import maya.cmds as mc def uniqueName(name): """return back a unique name for a node""" checkName = name j=0 searching = True while searching: if mc.objExists(checkName): j = j+1 checkName = name + str(j) else: searching = False return checkName # presuming you already have two nodes by the name "checkName" in the # scene, parented to different hierarchies: print uniqueName("checkName") # checkName1 }}} Two ways that I know of: !!!Method #1 : {{{userSetup.py}}}: *Create a {{{userSetup.py}}} module here: (Windows) {{{ <drive>:\Documents and Settings\<username>\My Documents\maya\<Version>\scripts\userSetup.py }}} *And put whatever Python code you want to execute at startup in there. This is basically just like the {{{userSetup.mel}}} file, but for Python. !!!Method #2 : Update {{{PYTHONSTARTUP}}}: *If you add an environment variable with the above name, and point it to a valid python module, Python will execute the code in that module before the prompt is displayed in interactive mode. {{{ PYTHONSTARTUP = c:/some/path/someModule.py }}} *Note: I haven't tested this //in Maya// yet, but I know it works with Python outside of Maya. I use method #1. !!!Method #3 : Author a '{{{sitecustomize}}} and\or {{{usercustomize}}} modules': *See notes on my Python wiki [[here|http://pythonwiki.tiddlyspot.com/#%5B%5BUsing%20the%20sitecustomize%20%26%20usercustomize%20modules%5D%5D]]. *These are Python's equivalent to Maya's {{{userSetup.py}}} module. ---- Also see: *[[How can I update my Python Path?]] I like to have code report info to the user via the command line. But Pythons printing syntax is a bit different from mel: For example in //mel//, if you print this: {{{ print "foo\n"; }}} it happily prints in the command line. But if you do this in //Python//: {{{ print "foo" }}} Nothing shows up in the command line. To get something to show up, you need to put a comma after the string, like so: {{{ print "foo", }}} //That// will now show up in the command line. The comma means "don't add a return character" (and it also adds a an extra space after the string, fyi). Another thing to note: In either mel //or// python, if you put a leading return character in the string like: {{{"\nfoo..."}}}, //that// string won't print to the command line. So finicky. mel has the command {{{env()}}} that returns back the name of every global variable in memory at the time. Via Python, this can be nicely wrappered in to a dictionary containing both the global var name, and its values. This really only falls down in regards to matrix (which are converted into lists of lists of floats) and vector data types (which are converted into 3-float tuples), since Python doesn't have those types (by default). But it still handles the conversion ok :) {{{ # Python code import maya.mel as mm env = {} allMelVars = mm.eval('env()') for v in allMelVars: # Convert mel into Python by assigning it to a dummy var the same # name as the original var, but with an underscore added to the name. # This lets us get around mel global scope naming conflicts if the tool # is ran twice: pv = mm.eval('%s_ = %s'%(v,v)) # strip off mel$ prefix:
env[str(v[1:])] = pv
}}}
Now you can use all of Pythons dictionary tools on the {{{env}}} dict.
If you want to print them all nicely:
{{{
# Cool Python printing module:
from pprint import pprint
pprint(env)
}}}
I like to make a lot of subsets while working, to help organize things.  While sets are {{{DG}}} nodes, and have no real hierarchy, by adding sets to one another, it sort of mirrors the child\parent {{{DAG}}} transform hierarchy, and the Outliner displays them this way.  However, since they aren't in a hierarchy, you can't use commands like {{{listRelatives}}} to get a list of all of their 'children'.  They have no 'children', since they aren't in a hierarchy.  But you still may want to get a list of their 'pseudo-chilld sets' anyway.

This code will recursively search a parental sets for all {{{objectSet}}}s connected too it, and all sets connected to them, etc.
{{{
# Python code
import maya.cmds as mc

sets = ["DZS_TORSO"]
for s in sets:
subSets = mc.listConnections(s, source=True, destination=False, type='objectSet')
if subSets is not None:
for ss in subSets:
sets.append(ss)
print sets
}}}
''Update'': This is a perfect example of overengineering ;)  I did all the below work before I realized there is a {{{listHistory}}} node, which does all this for you.  Check it out...
----
Say you have a list of Maya materials, and you want to find all the place2dTexture nodes connected to them.
{{{
# Python code
import maya.cmds as mc
def allIncomingConnections(nodes, nodeType=None):
"""
Based on the nodes, find all incoming connections, and return them.
This will recursively search through all incoming connections of all inputs.

nodes : string or list : of nodes to find all incoming connections on.

nodeType : None, string, list : Optional, will filter the result by these
types of nodes.

return : list : Nodes found
"""
ret = []

# Convert our args to lists if they were passed in as strings:
if type(nodes) == type(""):
nodes = [nodes]
if nodeType is not None:
if type(nodeType) == type(""):
nodeType = [nodeType]

for n in nodes:
incoming = mc.listConnections(n, source=True, destination=False)
if incoming is not None:
for i in incoming:
if nodeType is not None:
if mc.objectType(i) in nodeType:
ret.append(i)
else:
ret.append(i)
nodes.append(i)

# remove dupes:
ret = list(set(ret))
return ret
}}}
Example:
{{{
incoming = allIncomingConnections("myMaterial", "place2dTexture")
print incoming
# [u'place2dTexture643', u'place2dTexture642', u'place2dTexture641']
}}}
{{{
ls -as;
}}}
The {{{-as}}} stands for 'assemblies'.
I always forget how to do this for some reason... so here it is.  In STONE.
{{{
string $curve = "myCurve"; string$shape[] = listRelatives -shapes $curve; int$numCVs = getAttr -size ($shape[0] + ".controlPoints"); string$cvs[] = ls -fl ($shape[0] + ".cv[0:" +$numCVs + "]");
// myCurveShape.cv[0] myCurveShape.cv[1] myCurveShape.cv[2] etc...
}}}
If you take out the {{{-fl}}} flag from {{{ls}}}, it will collapse them into a single element that still works:
{{{
myCurveShape.cv[0:16] // presuming it had 17 cv's
}}}
I pulled this by digging into the script:
{{{
C:/Program Files/Autodesk/Maya<VER>/scripts/others/selectCurveCV.mel
}}}
Many attributes in in Maya are considered "multi":  They are considered "array" attributes in the API.  They can have many children attributes, and are often dynamically generated.  How to get a list of them?
{{{
import maya.cmds as mc
node = "pPlaneShape1"
attr = "uvSet"

multi = mc.listAttr('%s.%s'%(node,attr), multi=True)
for m in multi:
val = '<compound>'
try:
val = mc.getAttr('%s.%s'%(node,m))
except RuntimeError:
pass
print '%s%s'%(str(m).ljust(40,' '), str(val).rjust(20, ' '))
}}}
Will print something like this (presuming the plane only has four verts):
{{{
uvSet[0]                                          <compound>
uvSet[0].uvSetName                                      map1
uvSet[0].uvSetPoints[0]                         [(0.0, 0.0)]
uvSet[0].uvSetPoints[0].uvSetPointsU                     0.0
uvSet[0].uvSetPoints[0].uvSetPointsV                     0.0
uvSet[0].uvSetPoints[1]                         [(1.0, 0.0)]
uvSet[0].uvSetPoints[1].uvSetPointsU                     1.0
uvSet[0].uvSetPoints[1].uvSetPointsV                     0.0
uvSet[0].uvSetPoints[2]                         [(0.0, 1.0)]
uvSet[0].uvSetPoints[2].uvSetPointsU                     0.0
uvSet[0].uvSetPoints[2].uvSetPointsV                     1.0
uvSet[0].uvSetPoints[3]                         [(1.0, 1.0)]
uvSet[0].uvSetPoints[3].uvSetPointsU                     1.0
uvSet[0].uvSetPoints[3].uvSetPointsV                     1.0
uvSet[0].uvSetTweakLocation             [(0.086363710463047028, 0.047107480466365814)]
}}}
----
Also see:
*[[How can I add a multi attr to my node, query its connections?]]
*[[API: Find all child attributes under a compound attribute]]


{{{env}}}
{{{
>> mayaBatch -proj c:\directory\with\file -archive filename.ma -log c:\output\directory\logFile.txt
}}}
*Notes: I have been unsuccessful getting the return value of this from within Maya using the {{{system}}} command. It will execute and generate a log file, but Maya won't capture the return value.
{{{
runTimeCommand -q -ca;
}}}
If you select a bunch of verts (or any component-level selection), and run {{{ls}}} on your selection, Maya will give you an ordered list.  What if you want them in the order selected?

Based on a lot of research and talking with others, there's no built-in easy way to do this.  Not that it can't be done with a lot of hoop jumping.  It usually involves running scriptJobs that track what the user picks, and updates a global variable or a optionVar.

However, I did find this (free) plugin that seems to do it too:
http://www.3dhornet.eu/index.php?main_page=document_general_info&cPath=63_67&products_id=194

It would be interesting to see how this could also be scripted through the Python API.
Starting in Maya 2012, you can use [[melInfo|http://download.autodesk.com/global/docs/maya2012/en_us/CommandsPython/melInfo.html]]
{{{
# Python code
import maya.cmds as mc

procs = mc.melInfo()
for p in sorted(procs):
print p
}}}
This will return back commands, runTimeCommands, and global procedures.
These could be nodes other than DAG nodes.
{{{listHistory}}}
{{{
listConnections -s 1 -d 0 -p 0 -c 0 "setName";
}}}
*Note: Often times, one would think they could simply select the set, and use the {{{ls}}} command to get an array of membership. The problem is, the {{{ls}}} command will return them in a different order than the Outliner may show. Furthermore, the order seems to change from time to time (hard to confirm this). When an item is "added" to a set, what's actually happening is the set has a new attribute generated, and that attr is connecting to the object. By using the "listConnections" command, we can get a list, in order, of all the attribute connections. The order still may be different than what's shown in the Outliner, but at least it should be consistant.
*There is only one caveat: The listConnections command will return DG objects in a set before it lists DAG objects. If you don't have mixed data types in your sets, then there is no issue. However, if you have both DG and DAG objects in the set, then you still could run into future problems of shifting order in the return value.
I recently needed to find the sets shown in the Outliner.  Problem is, commands like this:
{{{
ls -type "objectSet";
ls -sets;
listSets -type 2;
}}}
Return ALL {{{objectSet}}}s in the scene.

By querying the contents of the {{{itemFilter}}} passed to the {{{setFilter}}} arg on the default {{{outlinerEditor}}} control, we're able to query its contents, which is //just the sets showing up in the Outliner//:
{{{
# Python code
import maya.cmds as mc

# New empty scene, make some sets:
mc.file(new=True, force=True)
mc.sets(name='spam')
mc.sets(name='eggs')
}}}
Now query the sets in the Outliner:
{{{
myOutliner = "outlinerPanel1" # Name of the default Outliner
setFilter = mc.outlinerEditor(myOutliner, query=True, setFilter=True)
outlinerSets = mc.lsThroughFilter(setFilter, nodeArray=True)
print outlinerSets
}}}
{{{
[u'spam', u'eggs']
}}}
----
This will list ALL the sets in the outliner, including any subsets.  What if you want to get only the root most sets (since you can have subsets?).  You can pass the above results into this function to get only sets that aren't members of any others:
{{{
def getRootSets(setData):
ret = []
for s in setData:
outgoing = mc.listConnections('%s.message'%s, source=False, destination=True, type='objectSet')
if not outgoing:
ret.append(s)
return ret
}}}
{{{
renderer -query -namesOfAvailableRenderers;
}}}
...or for multiple objects:
{{{
# Python code
import maya.cmds as mc

meshes = ['myMesh']
}}}
This method requires the selection of objects, which isn't always desirable:
{{{
mc.select(mc.polyListComponentConversion(meshes, toVertex=True))
verts = mc.ls(selection=True, flatten=True)
}}}
Non-selection method, but a bit more code:
{{{
verts = []
for mesh in meshes:
numVerts = mc.polyEvaluate(mesh, vertex=True)
vtxList = ['%s.vtx[%s]'%(mesh, val) for val in range(numVerts)]
verts += vtxList
}}}
{{{
print verts
# [u'myMesh.vtx[0]', u'myMesh.vtx[1]', u'myMesh.vtx[2]', ... ]
}}}
{{{
lsUI -windows;
}}}
I had an issue where a tool would return a list of joints, but I wanted to list them in their hierarchical order.  Below is the solution I came up with:  By querying the long name of each joint, and then simply sorting that list, it will return them in a nice hierarchical order.  I should note that this may not be the //exact// sibling order that Maya has them in since they've been alphabetized at the sibling level:  For example, based on the below print, it's very possible that spineA is the first child of pelvis, rather than hip_L.  But for my usage, it worked fine.
{{{
# Python code
import maya.cmds as mc

# Define a list of joints in random order based on their actual hierarchy:
joints = ['hip_L', 'pelvis', 'hipTwist_L', 'ball_L', 'spineA', 'spineC', 'spineB']
# Sort the joints by their full path.  Generate the list of full paths via a
# Python list comprehension:
sorter = sorted([mc.ls(jntA, long=True)[0] for jntA in joints])
for s in sorter:
print s
}}}
prints:
{{{
|root|pelvis
|root|pelvis|hip_L
|root|pelvis|hip_L|hipTwist_L
|root|pelvis|hip_L|knee_L|ankle_L|ball_L
|root|pelvis|spineA
|root|pelvis|spineA|spineB
|root|pelvis|spineA|spineB|spineC
}}}
Should node that bad things will happen if there are duplicate named things in the scene.
Credit Steve Kestell.

This will return a list of all the items picked in the main {{{Outliner}}}:
{{{
string $myOutliner = "outlinerPanel1"; string$selectionConnection = outlinerEditor -q -selectionConnection $myOutliner; string$selectList[] = selectionConnection -q -obj $selectionConnection; }}} The {{{window}}} command has the flag {{{-rtf}}} (resize to fit), which will make it resize itself (bigger) to fit the child controls. However, if the UI is dynamic, or its child controls change to be smaller, when the UI is regenerated, it'll keep its larger size. How can you make it change size every time, to fit the child controls, even if the child controls shrink the overall UI size? You need to add a call to 'remove the saved window size' at the top of the UI code: {{{ if(windowPref -exists "myUI_name") windowPref -remove "myUI_name"; }}} In this example, you can change the button size however you’d like, and the UI will always resize correctly when reopened: {{{ global proc tempWin_UI() { if(window -exists tempWin_UI) deleteUI tempWin_UI; if(windowPref -exists "tempWin_UI") windowPref -remove "tempWin_UI"; window -t "Temp Window" -rtf 1 tempWin_UI; columnLayout -adj 1 -co both 5; button -w 200 -h 200; showWindow; } tempWin_UI; }}}  As of v8.0, Maya has no good debugger for scripting :( The {{{trace}}} command (mel only, not in Python) allows you to call to it inside a procedure. It will print back values to the Output Window (Maya's standard output, {{{stdout}}}) for debugging purposes. If you use the {{{-where}}} argument, it will //also// add the prefixed file and line number indicating where the trace call originates. For example, save this file on disk as {{{foo.mel}}} in your Script Path, and then run {{{rehash}}} so Maya sees it as a script. Then execute {{{foo}}}. {{{ global proc foo() { global int$intvar;
$intvar = rand(1,100); trace -where ("int$intvar = " + $intvar); } }}} Result in the Output Window when ran would be (executing the procedure multiple times): {{{ file: C:/scripts/foo.mel line 5: int$intvar = 18
line 5: int $intvar = 71 line 5: int$intvar = 61
line 5: int $intvar = 11 line 5: int$intvar = 30
}}}


{{{
>> maya -h
}}}
*Notes: From initial tests, it looks like an empty scene uses about half the ram (35 megs) as the "UI" version (80 megs).
Presuming you have polygonal components picked, like faces:  How can you get just the edges that live on the border of the mesh.  For example, if you had a poly cube missing the top face, and you made a selection of all the faces in the cube, how could you convert that to just the edges around the top open edge?
{{{
import maya.cmds as mc
import maya.mel as mm

def getBorderEdgesFromSelection():
mm.eval('ConvertSelectionToEdges;')
mc.polySelectConstraint(mode=2,type=0x8000,where=1)
borderEdges = mc.ls(selection=True, flatten=True)
mc.polySelectConstraint(mode=0, disable=True)
return borderEdges
}}}
This function both returns a list of the border edges, and selects them in the process.

{{{ConvertSelectionToEdges}}} to a ~RunTimeCommand for '{{{PolySelectConvert 2}}}'.
{{{PolySelectConvert}}} is a global mel proc living in this script:
{{{
C:\Program Files\Autodesk\Maya20XX\scripts\others\PolySelectConvert.mel
}}}
When writing strings to text files, you have to embed a 'newline' character or everything will be on the same line.  For some reason, Notepad doesn't respect the standard {{{\n}}} 'newline' character:  It will print evertying on the same line, with a "square" [] character replacing where the 'newlines' should be.  The secret apparently, is that you need to \\also\\ embed a 'return character', and do it before the 'newline character':
{{{
// snip //
int $fid = fopen$filepath "w";
for($i=0;$i<size($data);$i++)
fprint $fid ($data[$i] + "\r\n"); // snip // }}} You //have// to do it {{{\r\n}}}: Storing {{{\n\r}}} will provide unsatisfactory results :( Also see: *[[How can I write text to my own file?]] The {{{viewLookAt}}} command. Works pretty darn well. You can optionally pass in a position in space to look at. This will fixup the camera so if it has been rotated off-axis that is addressed. New to Maya 2010, and for use in //mel only//, and only on //procedures// (not built-in commands), is: {{{getProcArguments}}} Of course, you //can// wrapper this with Python: {{{ import maya.mel as mm args = mm.eval('getProcArguments stringArrayToString') [u'string[]', u'string'] }}} They use the term //argument//, which I feel is incorrect: Arguments are what you pass into the parameters, and this tool queries the parameter //types// ({{{int}}}, {{{string[]}}}, etc), not the values passed in.  I wanted a way to get a list of all of the parameters that make up the signature of a mel command. Mel doesn't provide for a lot of introspection like Python does. However, the mel {{{help}}} command will return back a bunch of info on a command, including the parameter list (when the command is authored properly via the API). With a bit of string fiddling via Python, we can extract out just the parameter list. For example, running the mel {{{help}}} on the {{{menu}}} command, it prints this: {{{ // mel code help menu; // Result: Synopsis: menu [flags] [String] Flags: -e -edit -q -query -aob -allowOptionBoxes on|off -dai -deleteAllItems -dt -defineTemplate String -dtg -docTag String -en -enable on|off -ex -exists -fi -familyImage String -hm -helpMenu on|off -ia -itemArray -l -label String -mn -mnemonic String -ni -numberOfItems -p -parent String -pmc -postMenuCommand Script -pmo -postMenuCommandOnce on|off -to -tearOff on|off -ut -useTemplate String -vis -visible on|off Command Type: Command // }}} We can intercept that with Python, and pull out just what we want: {{{ # Python code import maya.cmds as mc def getParameterList(melCmd): helper = [line.strip() for line in mc.help(melCmd ,syntaxOnly=True).splitlines()] parameters = [] for h in helper: if h.startswith('-'): splitter = h.split(' ') parameters.append(splitter[1][1:]) return parameters }}} {{{ print getParameterList('menu') [u'edit', u'query', u'allowOptionBoxes', u'deleteAllItems', u'defineTemplate', ... }}}  {{{ import maya.cmds as mc color = mc.grabColor(hsv=True) print color }}} {{{polyUVSet}}} command. Has a variety of options including the ability to (from the docs): *Delete an existing uv set *Rename an existing uv set. *Create a new empty uv set. *Copy the values from one uv set to a another pre-existing uv set. *Set the current uv set to a pre-existing uv set. *Modify sharing between instances of per-instance uv sets *Query the current uv set. *Set the current uv set to the last uv set added to an object. *Query the names of all uv sets Some examples: {{{ //Get all UV sets on a mesh: string$allUV[] = polyUVSet -query -allUVSets "myMesh";
}}}
{{{
// Query the current UV via shading engine:
string $currentUV[] = polyUVSet -query -currentUVSet "someSG"; }}} ---- Also see: *[[Understanding how UV attrs work on polygonal meshes.]] You can set a global int that will tell Maya to //not// access a saved UI configuration when a scene is opened. You also need to update an optionVar: {{{$gUseScenePanelConfig = 0;
optionVar -iv useScenePanelConfig $gUseScenePanelConfig; // run file open code }}} These layouts are saved (unless you set your options to NOT save these files...) in each scene as a {{{scriptNode}}} called {{{uiConfigurationScriptNode}}} (easily accessed via the Expression Editor). OR, you could just modify the Maya Preferences through the UI, which basically does what was done above: *Window -> Settings/Preferences -> Preferences... -> UI Elements -> “When Opening [''uncheck''] Restore Saved Layouts from File”  You can turn on "Auto Frame" in the Graph Editor, but when you restart Maya, it's off again. It doesn't seem to ever remember, which is quite bothersome. It even seems to store an optionVar, but upon restart, it seems reset. Add this to your {{{userSetup.mel}}} file to always force it to be on: {{{ global proc setAutoFrame() { animCurveEditor -edit -autoFit 1 graphEditor1GraphEd; optionVar -intValue graphEditorAutoFit 1; print ("userSetup.mel: ** Turned on Graph Editor 'auto fit'\n"); } scriptJob -event SceneOpened setAutoFrame; }}} Whenever a scene is opened, the scriptJob will run the {{{setAutoFrame}}} proc, resetting these values. Also see: *[[How can I edit \ query the contents of the Graph Editor]] {{{loadPrefObjects}}} *Example: By simply saving a scene called loadPrefObjects.ma in your prefs directory, they will be imported every time a scene is opened.  {{{ cmdFileOutput }}} It should be noted that this only works with calls via the {{{print}}} statement: If a command prints stuff to the script editor, it won't be captured :( ---- Also see: *[[How can I query the contents of the undo queue?]] *Maya has the default hotkeys {{{ctrl+c}}} and {{{ctrl+v}}} like most software to copy and paste data. *//But//, the hotkeys are //context sensitive//: They do different things if the Channel Box, Graph Editor, or modeling panel (like, the perspective view) is active. *In the Channel Box or Graph Editor, they copy and paste //keys//. In a modeling panel, they //physically copy and past scene data//, based on what's currently selected. It does this by exporting and importing data to\from a temp file on disk. *This can wreck some major havoc when it comes to animators (most commonly) copying\pasting keys, and not realizing they //don't// have the Graph Editor\Channel Box actually active. They'll get some temp file dumped into their scene, making the file dirty. Then they yell. It gets ugly. *IMO, what Maya should do by default is //prompt the user// with a confirmDialog //before// the paste (scene import) happens. But //not// prompt for the pasting of keyframes. The below code does that. I made a //new// 'user hotkey', and remapped it to {{{ctrl+v}}} {{{ int$bad = 1;
// get the current panel.  If it's the Graph Editor, we're good.
string $panel = getPanel -withFocus; if(match "^graphEditor"$panel == "graphEditor")
$bad = 0; // is anything picked in the Channel Box? If so, we're good. string$selAttr[] = channelBox -q -sma "mainChannelBox";
if(size($selAttr))$bad = 0;

// if things are still 'bad', then fire up our confirmDialog, since we must be trying
// to paste (import) our temp scene:
if($bad) { string$yesNo = confirmDialog -title "Confirm File Paste"
-message "Are you sure you want to paste (import)\nthe previously 'copied' (exported) Maya file?"
-button "Yes" -button "No" -defaultButton "Yes"
-cancelButton "No" -dismissString "No";
if($yesNo == "Yes") cutCopyPaste "paste"; } else cutCopyPaste "paste"; }}} There have been rare instances where I've needed to create mel procedures inside of Python modules. For example, the {{{outlinerEditor}}} command has a {{{selectCommand}}} argument that expects a //mel procedure// passed in as a string. If you're creating the {{{outlinerEditor}}} via Python (via {{{maya.cmds.outlinerEditor()}}}), and you want to access that argument, you can't call to another Python function... you //have to// call to a mel proc. :-( It's pretty easy to author and execute mel from Python by simply making a multi-line string with the contents of the proc, and having the Python {{{maya.mel.eval()}}} function evaluate it: {{{ # Python code: import maya.mel as mm mel =''' global proc foo(){ print "foo is a go!\\n"; } ''' mm.eval(mel) }}} Then to execute the newly created mel through Python: {{{ # Python code: mm.eval('foo()'); # foo is a go! }}} You can also confirm this in mel of course: {{{ // mel code: foo(); // foo is a go! }}} Continuing the example from above, your Python {{{outlinerEditor}}} code could look like this: {{{ # Python code: import maya.cmds as mc mc.outlinerEditor(myOutliner, selectCommand='foo();') }}} @@Note:@@ Wing can interact with Maya in three different ways. This is one of the three. See an overview here on the whole system: [[Interaction between Wing and Maya]] @@Another Note:@@ : The below examples I've gotten to work repeatedly on Windows. Still having a hard time getting them to work on @@Mac@@ ({{{commandPort}}} problems). ---- I use [[Wing IDE|For Python: Maya 'Script Editor' style IDE]] when authoring Python and mel code for Maya, and have come up with a solution (presuming you have the 'Professional' version of Wing) to have the code (Python //or// mel) you @@highlight in Wing@@ //execute in Maya// (aka 'evaluate selection'). This lets me completely replace the Script Editor when authoring Python //or// mel. >Note that you can have Wing recognize {{{.mel}}} files, with //some// (not full) context sensitive highlighting, correct indentation, scope hilighting, etc: Under Wing 'Prefs -> Files -> File Types', 'insert' a new file type as {{{mel}}} and set its 'Mime Type' to be {{{C++ Source}}}. There are a number of steps involved to get this working. I should point out again this only works with the 'Professional' version of Wing, and you'll need Maya v8.5 or //newer//: when Maya started supporting Python (below this section I list some old code, for version of Maya8.5 and earlier.) !!!Important Starting Notes When it comes to opening {{{commandPorts}}}, the port number is fairly arbitrary. In the below examples I use {{{6000}}}, but you can use another number if you wish. Just make sure to update it in both locations: {{{mayaWingServer.py}}} //and// the function {{{send_to_maya()}}} in {{{wingHotkeys.py}}}. !!!Overview of the below code: *Maya launches, creates a listener-server waiting for input from Wing. *In Wing, the user executes a hotkey that sends the highlighted text from Wing to a temp text file. At the same time, over a {{{commandPort}}} it pings Maya and tells it to evaluate the text file. *Maya's server receives the ping, processes the text file, and evaluates it in Maya, as if it was executed from the Script Editor !!!#1 - userSetup.py & mayaWingServer.py Starting with Maya 2013, the only success I've had getting Wing to talk to Maya is over a 'server' connection, rather than a more simplistic {{{commandPort}}} connection. The module {{{mayaWingServer.py}}} should be authored and placed in the same directory as the user {{{userSetup.py}}} file. When Maya starts up, it should be called to (via {{{userSetup.py}}}) thus launching a listener-server running in a separate thread that will wait for data incoming from Wing, and when it receives it, process the data. {{{ """ mayaWingServer.py Author : Eric Pavey - 2012-10-23 """ import sys import socket import threading import maya.utils as mu import maya.OpenMaya as om import executeWingCode #----------------- PORT = 6000 # Needs to be the same value as authored in wingHotkeys.py below. SIZE = 1024 BACKLOG = 5 def processDataInMaya(data): """ This function is designed to be passed as the 'processFunc' arg of the mayaServer function. It is mainly a try\except wrapper around the executeWingCode.main() function. data : string : The data passed from wing. Currently this is 'python' or 'mel'. """ try: # If we don't evaluate in maya.util.executeInMainThreadWithResult(), # Maya can crash, and that's no good. mu.executeInMainThreadWithResult(executeWingCode.main, data) except Exception, e: om.MGlobal.displayError("Encountered exception: %s"%e) def server(processFunc=processDataInMaya, port=PORT, backlog=BACKLOG, size=SIZE): """ Create a server that will listen for incoming data from Wing, and process it. Modified example taken from: http://ilab.cs.byu.edu/python/socket/echoserver.html The server will wait to recieve data from a single client. When it receives data, it will 'process' it via the processFunc function. Parameters : processFunc : function : A function object that will process the data recieved by the client. It should accept a single string argument. port : int : Default to global PORT. The port to connect to. backlog : int : Default to global BACKLOG. The number of connections the server can have waiting. size : int : Default to global SIZE. The size in bytes to recieve back from the client. """ host = '' s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) try: s.bind((host,port)) except: print "Tried to open port %s, but failed: It's probably already open\n"%port return s.listen(backlog) print "Starting Python server, listening on port %s...\n"%port while True: client, address = s.accept() # client is a socket object data = client.recv(size) if data: processFunc(data) client.close() def startServer(): """ When Maya starts up, execute this to start the Wing listener server: """ threading.Thread(target=server).start() }}} The {{{userSetup.py}}} file should import the above module, and call to {{{startSever()}}}: {{{ # userSetup.py import mayaWingServer mayaWingServer.startServer() }}} If you don't have a {{{userSetup.py}}} file, you can make a new one and stick it here (PC): {{{ C:\Users\<USERNAME>\Documents\maya\python\userSetup.py }}} Or here (Mac): {{{ /Users/<USERNAME>/Library/Preferences/Autodesk/maya/scripts/userSetup.py }}} ---- Older notes: Up until Maya 2013, the below code was all that was needed to get a {{{commandPort}}} opened and let Wing talk to Maya. But something happened in 2013 that broke all this, thus the above code was generated. <<< In Maya's {{{userSetup.mel}}} file, add this line to open a network socket. This will later let Wing talk with Maya. {{{ // userSetup.mel commandPort -name ":6000" -echoOutput; }}} It appears, if you're running Maya on Vista \ 64bit, or maybe it's a Maya2010 thing, you need to call to {{{commandPort}}} twice to get this working, otherwise your socket will later be refused: {{{ // userSetup.mel commandPort -name "127.0.0.1:6000" -echoOutput; commandPort -name ":6000" -echoOutput; }}} For whatever reason, having your {{{userSetup.py}}} execute these commands instead won't let the below process work. This really confuses me, since Maya claims the port is open. But Wing says the port is refused.... <<< !!!#2 - wingHotkeys.py The Wing Python module ({{{wingHotkeys.py}}}) and functions inside are authored to do a few things: #Save the text selected in Wing as a temp file on disk. #Ping Maya through the opened command port, and tell Maya to execute the contents of that file. Depending on the type of data sent, either Python or mel, the tool will tell Maya how to intercept it, and execute it. Again, this code is tailored to //Wing IDE's API//, and saved as part of that program's own "scripts" directory. Default location (on winXP) of that dir is here: {{{ C:\Documents and Settings\<userName>\Application Data\Wing IDE 3\scripts\wingHotkeys.py }}} On Windows 7: {{{ C:\Users\<userName>\AppData\Roaming\Wing IDE 4\scripts\wingHotkeys.py }}} On Mac: {{{ /Users/<userName>/.wingide4/scripts/wingHotkeys.py }}} <<< Note for Mac: The {{{/.wingide4}}} directory seems to be hidden in Finder. To access it, open a Terminal, cd to that folder, and execute: {{{$ open .
}}}
To launch a Finder to that folder.
<<<
Functions:
*{{{send_to_maya()}}} :  Function that does the heavy lifting, and calls to {{{executeWingCode.main()}}} (discussed below).
*{{{python_to_maya()}}} :  Wrapper to send the code as Python to Maya.  I have this mapped to {{{ctrl+p}}}.  (Wing hotkeys don't allow args, so you need to author wrapper functions)
*{{{mel_to_maya()}}} :  Wrapper to send the code as mel to Maya.  I have this mapped to {{{ctrl+m}}}.
The biggest hangup with this system is getting Maya to properly open a {{{commandPort}}}, getting a proper {{{socket.socket()}}} connection, and getting Maya to properly connect via {{{maya.connect()}}}.  Based on the network settings of your machine, the below code may not work for you as-provided in all instances.  Whenever I change machines I seem to have to modify one or more of these areas.
I've left code-examples (commented out) for other alternatives that I've used on various machines to get these working, so if something fails, you can try using those examples.  Otherwise you'll need to strap on your networking programmer hat and dig into the docs a bit.

If you already have a {{{wingHotkeys.py}}} module for Wing, you can just add the below code to it:
{{{
# wingHotkeys.py
# Author:  Eric Pavey - warpcat@sbcglobal.net

import wingapi
import socket
import os

def getWingText():
"""
Based on the Wing API, get the selected text, and return it
"""
editor = wingapi.gApplication.GetActiveEditor()
if editor is None:
return
doc = editor.GetDocument()
start, end = editor.GetSelection()
txt = doc.GetCharRange(start, end)
return txt

def send_to_maya(language):
"""
Send the selected code to be executed in Maya

language : string : either 'mel' or 'python'
"""
# The port the sever is listening on in mayaWingServer.py :
commandPort = 6000

if language != "mel" and language != "python":
raise ValueError("Expecting either 'mel' or 'python'")

# Save the text to a temp file.  If we're dealing with mel, make sure it
# ends with a semicolon, or Maya could become angered!
txt = getWingText()
if language == 'mel':
if not txt.endswith(';'):
txt += ';'
# This saves a temp file on Window.  Mac\Linux will probably need to
# change this to support their OS.
tempFile = os.path.join(os.environ['TMP'], 'wingData.txt')
f = open(tempFile, "w")
f.write(txt)
f.close()

# Create the socket that will connect to Maya,  Opening a socket can vary from
# machine to machine, so if one way doesn't work, try another... :-S
mSocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) # works in 2013...
#mSocket = socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
# More generic code for socket creation thanks to Derek Crosby:
#res = socket.getaddrinfo("localhost", commandPort, socket.AF_UNSPEC, socket.SOCK_STREAM)
#af, socktype, proto, canonname, sa = res[0]
#mSocket = socket.socket(af, socktype, proto)

# Now ping Maya over the command-port
try:
# Make our socket-> Maya connection:   There are different connection ways
# which vary between machines, so sometimes you need to try different
# solutions to get it to work... :-S
mSocket.connect(("127.0.0.1", commandPort)) # works in 2013...
#mSocket.connect(("::1",commandPort))
#mSocket.connect(("localhost", commandPort))

# Send our code to Maya:
# It is intercepted via the function processDataInMaya(), created via mayaWingServer.py
mSocket.send(language)
except Exception, e:
print "Send to Maya fail:", e

mSocket.close()

def python_to_maya():
"""Send the selected Python code to Maya"""
send_to_maya('python')

def mel_to_maya():
"""Send the selected code to Maya as mel"""
send_to_maya('mel')
}}}
!!!#3 - executeWingCode.py
''3.''  The Python module {{{executeWingCode.py}}} is the one Wing's {{{send_to_maya()}}} function (above, step 2) triggers via the Maya listener-sever.  It is what physically evaluates the code executed in Wing, in Maya.
Be sure to save this in a location seen by //Maya's// Python path (probably same dir as {{{userSetup.py}}}).
{{{
"""
executeWingCode.py
Eric Pavey - 2011-03-23
Module that Maya calls to when Wing pings it through a socket, telling Maya
to execute the commands in the temp file as either Python or mel code.
"""
import __main__
import os

import maya.OpenMaya as om

def main(codeType):
"""
Evaluate the temp file on disk, made by Wing, in Maya.

codeType : string : Supports either 'python' or 'mel'
"""
tempFile = os.path.join(os.environ['TEMP'], 'wingData.txt').replace("\\", "/")
if os.access(tempFile , os.F_OK):
# Print the lines from the file in Maya:
with open(tempFile, "r") as f:
for line in f.readlines():
print line.rstrip()
print "\n",

if codeType == "python":
# execute the file contents in Maya:
with open(tempFile , "r") as f:
exec(f, __main__.__dict__, __main__.__dict__)
elif codeType == "mel":
melCmd = 'source "%s"'%tempFile
# This causes the "// Result: " line to show up in the Script Editor:
om.MGlobal.executeCommand(melCmd, True, True)
else:
print "No Wing-generated temp file exists: " + tempFile
}}}
The key here for the ''Python'' execution, is the {{{exec}}} command updating the {{{__main__.__dict__}}} dictionary with any defined variable names passed in from Wing.  It is effectively adding them to the 'main', or 'builtin' scope of Python.  If this //doesn't// happen, after the code is executed, you won't be able to access any variables created\changed from within Maya.

For ''mel'', calling to {{{OpenMaya.MGlobal.executeCommand}}} allows for the result of the execution to be printed to the Script Editor, just like you had originally executed it there.
!!!#4 - Finish
That's it:  You can now highlight code in Wing (either Python or mel), and via a wing hotkey, have it execute directly in Maya.  I use it __every day__...
----
!!!Older methods:
*For Maya versions 8 and //earlier// (Maya 8.5 has Python embedded, yah!)
*Thanks to Hamish ~McKenzie "//macaroniKazoo//" on highend3d.com
*First, in Maya, create an INET domain on the local host at the command port:
**Win2000 syntax is "{{{computerName:portNumber}}}", I've wondered why you don't have to specify the computerName here?
{{{
commandPort -n ":5055";
}}}
*Second, in Python:
{{{
import socket
maya = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
maya.connect(("127.0.0.1", 5055))
}}}
*Then, to actually have Python talk to Maya:
{{{
maya.send('print "I am typing in Python, but I see it in Maya!\\n";')
}}}
*Of course, you have to embed your //mel commands// in the Python syntax.
*Python library docs on 'socket' [[HERE|http://docs.python.org/lib/module-socket.html]]
*What's so special about '127.0.0.1'? Check Wikipedia [[HERE|http://en.wikipedia.org/wiki/127.0.0.1]]
!Worldspace Matrix
If you're only interested in translation values, you can query a nodes {{{worldMatrix}}} attr to get this info directly from the node in question:
{{{
string $node = "pSphere1"; float$offset = 1.0;
float $t = currentTime -q; float$worldMatrix[] = getAttr -t ($t-$offset) ($node+".worldMatrix"); vector$offsetTranslate = <<$worldMatrix[12],$worldMatrix[13], $worldMatrix[14] >>; print$offsetTranslate;
}}}
!decomposeMatrix node
Before I had a better understanding of nodes matrix attrs, I used to use this method:
*The {{{decomposeMatrix}}} plugin wil help do the trick (got the info for this tip in a forum by Lutz Paelike)
*I'm not a big fan of plugins in development, they can really cause a bottleneck, but since this plugin is distributed with Maya, I find it safer than usual.
*What the decomposeMatrix node does, among other things, is let you pass in a source matrix, and it will spit out the worldspace trans, rot, scale, and shear for that matrix.  From there, we can use {{{getAttr -t}}} to query those values in time.
*Given this concept, regardless of your source objects hierarchical transformations, as long as your destination object lives in worldspace, it will follow along happily in time:

First, load the "decomposeMatrix.mll" plugin:
{{{
int $isLoaded = pluginInfo -q -l "decomposeMatrix.mll"; if (!$isLoaded)
loadPlugin "decomposeMatrix.mll";
}}}
Next create the decomposeMatrix node:
{{{
string $dm = createNode decomposeMatrix; }}} given you have an object with it's name in ' string$obj = "myObj" ', connect:
{{{
connectAttr -f ($obj + ".worldMatrix[0]") ($dm + ".inputMatrix");
}}}
Now you can query the decomposeMatrix's output attrs to find the worldspace transformations.  (or, you could connect them to another node, for a direct connection situation) And if we make an *expression* in like the link below, you can query them in time, to generate lag:
{{{
float $t = currentTime -q; followObj.translateX = getAttr -t ($t - 10) decomposeMatrix1.outputTranslateX;
}}}
Also see:
*[[How can I compute distance traveled in an expression?]]
*[[How can I make one object "follow" another, offset in time, but without using getAttr or setAttr?]]
The {{{arrayMapper}}} node, and quite a bit of other work. The expression work below comes from the brain of Daniel Roizman:  roizman@kolektiv.com
*Steps, based on a nurbs curve softbody:
**On your particle object there is a .goalPP attr. This allows the user to change the goal weights per particle in the component editor. However, it'd be a lot easier if you could use a ramp to do this instead.
**On your particle object, in the Attribute editor, under "Add Dynamic Attributes", add a "General" attr that is a float "Per Particle (array)" attr, and name it uValuePP?.
**Next make a "Runtime Before Dynamics Expression" on the new uValuePP? attr by RMB on it in the "Per Particle (Array) Attributes) section:
{{{
myparticle.uValuePP = float(myparticle.particleId) / float(myparticle.count);
}}}
**This isn't super accurate, but it gets the job done.
**RMB on the "goalPP" attr field and choose "Create Ramp (options)".
**Set the "Input V" to uValuePP?, hit OK. This creates the arrayMapper, & associated ramp.
**That's it. Animate your source curve and the default ramp will make it stick on one end, and be very floppy on the other.
*You may want to have a script return back where it physically lives on disk.  You can use this for file processing, tracking of assets... whatever.  How to do?
*The {{{whatIs}}} command is very handy at returning this info.
*For example, you make a mel script called whatsit here:  {{{C:/whatsit.mel}}}  You save it, and then highlight-enter it in the script editor to define it:
{{{
global proc string whatsit()
{
string $whatIs = whatIs whatsit; if(match "^Mel procedure found in: "$whatIs == "Mel procedure found in: ")
$whatIs = substitute "Mel procedure found in: "$whatIs "";
return $whatIs; } }}} *If you then quit Maya, restarted it, and entered the command you'd get this: {{{ whatsit; // Result: C:/whatsit.mel // }}} *One tricky bit where the code can get hung up is if you’re //currently authoring// the code, and trying to get whatIs to work properly. *Say you then highlighted the procedure, and defined it in the script editor by pressing Enter. You //then// run whatsit, and you get: {{{ whatsit; // Result: Mel procedure entered interactively. // }}} *Hmm… not the full path (but true). However, if you have it {{{rehash}}}, then {{{source}}} itself first, then it’s happy: {{{ global proc string whatsit() { rehash; source whatsit; string$whatIs = whatIs whatsit;
if(match "^Mel procedure found in: " $whatIs == "Mel procedure found in: ")$whatIs = substitute "Mel procedure found in: " $whatIs ""; return$whatIs;
}
}}}
*Now try executing the code after ''saving'' the script and 'highlighting-Enter' declaring it in the script editor
**FYI saving it is very important:  Since it's being rehashed and sourced, it will then look a the data ON DISK, not what you last interactively entered in the script editor.
{{{
whatsit;
// Result: C:/whatsit.mel //
}}}
*Again, this is only an issue if you’re in the habit of re-highlighting and re-defining the procedure //while// you’re working on it (which I am).  If you restarted Maya, the first example above would work just fine.
*Be warned:  If you had mel commands outside of the whatsit //proc// but inside the whatsit.mel //script//, the {{{source}}} statement would executethem, so even then it’s not a best case solution.  Python anyone? ;)
----
Also see
*[[How can I query the location of a script?]]
*[[How can I add images to my UI, without hardcoding their paths?]]
I find two schools of though when it comes to switching constraint target weights:  One is to blend the weights over time, providing (hopefully) smooth transitions between the targets.  In this case, the constraint weights are controlled by some float attr, usually 0->1 or 0->10, with 0 being off, and 1/10 being on.  The second is it do a hard switch, where the weights are either on or off (0 or 1), with no blending.  This second method is usually accompanied with a 'switch tool' that will help preserve the position of the node being switched in world-space, so that no pop occurs, yet it now moves relative to a new parent.  This discussion deals with the second method.

If you had four constraint targets, you could create for boolean attrs for turning them on\off.  But this is a lot of unnecessary keyed data to deal with when instead you can do it with a single enum attr that has four values (~enumNames).  As long as the enum attr names are in the same order as the constraint weight targets, they'll pair up nicely.  However, to actually get the enum attr to controll each of the constraint weights is a bit tricky:  When enum 0 is active, you want the four weights to be set to 1,0,0,0.  When enum 1 is active, you want the weights set 0,1,0,0, etc.  This functionality can be provided via 'choice' nodes.  Each choice node has an array 'input' attr, that can have values set for each index.  Based on a connection to the choice's 'input' attr, it will decide what 'input' attr should be passed to the 'output'.
The below function will create the choice node and setup this mapping:
{{{
import maya.cmds as mc
def switchConstraintConnect(switchNode, switchAttr, constraint):
"""
This tool is designed to allow a single enum attr to control the weight switching
on a given parentConstraint.  IMPORTANT:  The passed in enum attr names and the
constraint's weight attrs must be in the same order!

Parameters:
switchNode : string : Name of the node with the switch enum attr.
switchAttr : string : Name of the enum attr used for the switching.
constraint : string : Name of the constraint to control.
"""
enumAttrs = mc.attributeQuery(switchAttr, node=switchNode, listEnum=True)[0].split(':')
conWeightAttrs = mc.parentConstraint(constraint, query=True, weightAliasList=True)
num = len(enumAttrs)
for i in range(num):
choice = mc.createNode('choice', name="choice_%s_%s"%(switchNode, enumAttrs[i]))
mc.connectAttr('%s.%s'%(switchNode, switchAttr), '%s.selector'%choice)
for j in range(num):
val = 1 if j == i else 0
mc.setAttr('%s.input[%s]'%(choice,j), val)
mc.connectAttr('%s.output'%choice, '%s.%s'%(constraint,conWeightAttrs[i]) )
}}}
I had a recent issue where I needed to have a skinned character, made out of many parts, deform a duplicate of itself, but all polycombined together.  I couldn't copy the skin weights since I was going from a bunch of small skinned parts to one big one.

I figured out you can have multiple wraps effect the same target mesh, so that was the route I went:

The default behavior of the wrap command is to have one target mesh (the last picked) wrap all the mesh picked before it.  Normally you use this to have a larger mesh wrapper up many smaller ones.  But I needed the exact opposite behavior.

Furthermore, I learned that the {{{createDeformer -type wrap}}} //doesn't// do the job:  This just makes a wrap deoformer, doesn't do all the 'hooking up' required to make the system work.  However, mel supplies you with a {{{CreateWrap}}} //~runTimeCommand// that calls to a bunch of other scripts\procs that do the heavy lifting.

In the below example, the last node picked will be wrapped to all the mesh picked before it.  Note, you first need to go into the wrap tool window, setup your options, and save the preferences.  The runTimeCommand will use those preferences during the wrap creation.
{{{
# Python code:
import maya.cmds as mc
import maya.mel as mm

sel = mc.ls(selection=True)

targets = sel[:-1]
node = sel[-1]

for t in targets:
mc.select(node)
mc.select(t, add=True)
mm.eval('CreateWrap')
}}}
When you create a wrap through the Maya ui, this is the code it calls to (all procs, not actual commands):
*{{{CreateWrap}}} runTimeCommand
*{{{performCreateWrap false}}} : the code it executes.
**That proc lives in: {{{C:\Program Files\Autodesk\Maya20XX\scripts\others\performCreateWrap.mel}}}
*It calls to the local proc {{{assembleCmd()}}}
*It calls to the global proc {{{doWrapArgList}}}
**That proc lives in: {{{C:\Program Files\Autodesk\Maya20XX\scripts\others\doWrapArgList.mel}}}
*Which calls to the local proc {{{createWrap}}} in the same script, that does the final, actual wrap work.
{{{
# Python code
import maya.cmds as mc

huds = mc.headsUpDisplay(listHeadsUpDisplays=True)
for hud in huds:
mc.headsUpDisplay(hud, edit=True, visible=False)
}}}
Often, animators only want to work on a specific animation channels based on multiple selected objects.  Say you have 10 objects picked, and only want to modify their tx and ry channels in the Graph Editor.  You'd have to, by hand, scroll down through the Graph Editor Outliner, picking those channels.
The Channel Box however has this functionality:  With multiple objects picked, whatever channels are selected in the Channel Box will effect each of those objects.
So the question is, how can you take what's selected in the Channel Box, and 'transfer' it to the Graph Editor?
In a nutshell:
*Find the {{{selectionConnection}}} being used by the Graph Editor Outliner.
*Get a list of all the objects picked.
*Query what attrs are picked in the Channel Box.
*For each obj+attr combo, 'update' the {{{selectionConnection}}} in the Graph Editor Outliner to highlight these channels.  Also need to "un-highlight" the picked //objects//.
This will give the animator the visual filter they need to only work on those channels, in the Graph Editor.
{{{
# Python code
import maya.cmds as mc

selectionConnection = mc.outlinerEditor("graphEditor1OutlineEd",
query=True, selectionConnection=True)
selObj = mc.ls(selection=True, long=True)
selAttr = mc.channelBox("mainChannelBox", query=True,
selectedMainAttributes=True)

for so in selObj:
mc.selectionConnection(selectionConnection, edit=True, deselect=so)
for sa in selAttr:
mc.selectionConnection(selectionConnection, edit=True, select=so+"."+sa)
}}}
It's often nice when there is a long operation that you wrapper that operation with a {{{waitCursor}}} command for your users, so they get the comfortable feeling that the machine is actually doing something important, rather than just being locked up.  Via Python, there are two different implementations that allow you to 'wrapper' your code with other code:  The 'context manager' and the 'decorator'.  Context managers wrapper a block of code, while decorators wrapper functions.

Context manager notes on my Python Wiki:
*http://pythonwiki.tiddlyspot.com/#%5B%5Bwith%20statement%5D%5D
Here, we build a context manager and a decorator for use:
{{{
import maya.cmds as mc
}}}
{{{
class WaitCursor_cm(object):
"""
Our waitCursor context manager:
"""
def __enter__(self):
mc.waitCursor(state=True)
def __exit__(self, *args):
mc.waitCursor(state=False)
}}}
{{{
class WaitCursor_d(object):
"""
Our waitCursor decorator:
"""
def __init__(self, f):
self.f = f
def __call__(self, *args, **kwargs):
mc.waitCursor(state=True)
try:
self.f(*args, **kwargs)
finally:
mc.waitCursor(state=False)
}}}
----
This shows an implementation using the context manager:
{{{
def implementContextManager():
with WaitCursor_cm():
mc.pause(sec=5)

implementContextManager()
}}}
And here an implementation using the decorator:
{{{
@WaitCursor_d
def implementDecorator():
mc.pause(sec=5)

implementDecorator()
}}}
----
In either case when the functions are executed, the pause command is wrappered, properly turning on and off the {{{waitCursor}}}.
{{{
# Python code
import maya.cmds as mc

# Get a list of all the current references.  They in turn
# may reference other things that will be exposed once
# they are imported:
allrefs = mc.file(query=True, reference=True)
for ref in allrefs:
try:
mc.file(ref, importReference=True)
except RuntimeError:
pass
# See if there are any new references to import:
newrefs = mc.file(query=True, reference=True)
if len(newrefs):
allrefs += newrefs
}}}
Presuming you have a list of nodes, each with a numbered postfix on the end, like so:
*bob_1
*bob_2
*bob_3
*etc...
Or, in a hierarchy:
*bob_1
**bob_2
***bob_3
****etc...
And you'd like to increment or decrement those numbers, how would you author code to do so?
It's actually a pretty good example, because you can run into a lot of issues:
{{{
// get our list of nodes, full paths:
string $sel[] = ls -l -sl; // define the number we will add to \ subtract from the postifx int$number = -1;

// loop throug hour list:
for($i=0;$i<size($sel);$i++)
{
// match numbers only on the end of our object name:
string $endString = match "[0-9]*$" $sel[$i];

// increment, or decrement the number.  Temporarily convert our string-based name to an int:
string $newString = int($endString) + $number; // Danger: Can't rename somthing to less than zero, Maya wouldn't accept the name: if(int($newString) >= 0)
{
// If greater than zero, generate our new name.  Substitute only numbers on the end of the name
string $newname = substitute ($endString + "$")$sel[$i]$newString;

// Check to see if an object with this full path name already exists.  If so, print warning, skip
if(objExists $newname) warning ("Can't rename node '" +$sel[$i] + "' to this name: '" +$newname + "'; that name alraedy exists in scene");

// If this is a unique name for the full path:
else
{
// get just the leaf name, if it is a full path name:
string $buffer[]; tokenize$newname "|" $buffer; string$endName = $buffer[size($buffer)-1];

// FINALLY rename our full-path'd node with the leaf name:
rename $sel[$i] $endName; // print$sel[$i] // Important: Redefine the selection list. If you're renaming parental nodes, based on the // full path names, the child path names would then change, and they wouldn't be found // any more by the code. Must update the full paths:$sel = ls -l -sl;
}
}

// If the name would have been less than zero,  print warning, and skip
else
warning ("Can't rename node '" + $sel[$i] + "' to a lower numbered postfix, would be less than zero");
}
}}}
Our result would be:
*bob_0
*bob_1
*bob_2
*etc...
or
*bob_0
**bob_1
***bob_2
****etc...
''Update #2'':
You can use the {{{playblast}}} command, in either mel or Python, to query the active {{{modelPanel}}}.  This has an advantage that it will always return back a {{{modelPanel}}}, even if some other panel (like say, the Outliner) was picked most recently:
{{{
# Python code
import maya.cmds as mc
modelPanel = mc.playblast(activeEditor=True)
}}}
----
''Update #1'':
Here is a Python solution:
{{{
import maya.cmds as mc

visiblePanels = mc.getPanel(visiblePanels=True)
modelPanels = mc.getPanel(type='modelPanel')
modelPanel = list(set.intersection(set(visiblePanels), set(modelPanels)))[0]
}}}
----
I've had times when I'd want to frame the camera on a certain object in code.  But I'm not sure which panel is currently available to view through based on the users currently layout.  Maya has four viewable panels that a camera can exist in:  modelPanel1, modelPanel2, modelPanel3, modelPanel4.  And based on the currently layout, any one of those four could be currently maximized.  The below code will find the //first// one available, and print it's name.
{{{
string $allPanels[] = getPanel -vis; string$camPanel = "";
for($i=0;$i<size($allPanels);$i++)
{
if(match "^modelPanel" $allPanels[$i] == "modelPanel")
{
$camPanel =$allPanels[$i]; break; } } // print ($camPanel + "\n");
}}}
This code could then be used to make the camera in that panel frame some object:
{{{
// we say "if" $camPanel exists, because it's possible that some other // panel is maximized, like the Outliner: if(size($camPanel))
{
setFocus $camPanel; select -r "myGeometry"; FrameSelected; fitPanel -selected; select -cl; } }}} ---- Also see *[[How can I use mel to make the current camera look at an object of choice?]] *[[How do I query the name of the camera in the active panel?]] *In Windows, if you write your own files to disk using Maya using commands like {{{fprint}}}, using Notepad in Windows, which is the default viewer for text documents, doesn't interpret the 'newline\return' characters correctly ({{{\n}}}, {{{\r}}}). *Problem is, "Notepad.exe" //is// in the Windows PATH, so it's really easy to call to to view text files. ~WordPad, //isn't// in the windows path, but it //will// interpret the 'newline\return' character properly. *So what is the best way to call to it? Below is a good example. You'd want to do error checking to make sure your$file actually exists first:
{{{
string $file = "c:/temp/myFile.txt"; string$programFiles = getenv "ProgramFiles";
string $wordPad = ($programFiles + "/Windows NT/Accessories/WORDPAD.EXE");
if(filetest -f $wordPad) system("start " +$wordPad + " " + $file); }}} Doing the same thing with Notepad is easier (since it's in the Windows PATH), but the formatting usually looks screwed up :-( {{{ string$file = "c:/temp/myFile.txt";
system("start notepad " + $file); }}} The {{{launch}}} command. Check it out. ---- Note, I haven't actually gotten this command to work for videos or web pages (haven't tried pdf's). See [[How can I play a movie \ video?]] ---- For web pages, see: [[Launching web browsers]]  {{{ # Python code import maya.cmds as mc def getAllNamespaces(start=':'): namespaces = [start] mc.namespace(setNamespace=":") for n in namespaces: mc.namespace( setNamespace=n) subNs = mc.namespaceInfo(listOnlyNamespaces=True) if subNs is not None: for sn in subNs: if n is not ':': namespaces.append(':%s'%(sn)) else: namespaces.append('%s%s'%(n,sn)) mc.namespace(setNamespace=":") return namespaces }}} {{{ namespaces = getAllNamespaces() for n in namespaces: print n }}} Prints (for example): {{{ : :UI :myNamespace :myNamespace:subNamespace :etc... }}} Without the qualifying reference node, it'll list all edits in the scene. Or you can pass in a reference node name, to limit it to just that reference {{{ string$edits[] = referenceQuery -editStrings refNamespaceRN;
// Result: setAttr refNamespace:myNode.rotate -type "double3" -21.50129 -10.55454 -9.645982 //
}}}
The {{{dgmodified}}} command will.
----
Also see:
*[[How can I query if a scene has unsaved changes?]]
I've found that when trying to use mel to __load__ a Python scripted plugin, you have to provide the //full path// to the scripted plugin, even if it's already in you 'maya plugin path'.  However to __unload__ it, you only need the //name//:
{{{
# Python code
import os
import maya.cmds as mc

# Import our plugin, so we can extract the full path
# from it.  Let's pretend it lives in a package under \mayaPython:
# c:\mayaPython\spDev\myScriptedPlugin.py
import spDev.myScriptedPlugin

# Pull the full path from it:
fullPath = spDev.helloWorld2Cmd_sp.__file__
if fullPath.endswith('.pyc'):
fullPath = fullPath [:-1]
dirPath, plugin = os.path.split(fullPath)
}}}
{{{
# Load:
mc.loadPlugin(fullPath, quiet=True)
mc.pluginInfo(plugin, edit=True, autoload=True)
}}}
{{{
# Unload:
mc.unloadPlugin(plugin, force=True)
mc.pluginInfo(plugin, edit=True, autoload=False)
}}}
If you have the Plug-in Manager open while doing this, you won't always see the checkboxes check on and off.  But if you close it and reopen it, they'll have updated correctly.
----
Based on the above code, it allows you to do something pretty nice: Author a function inside a scripted plugin module that will auto-load (or unload, to allow for iteration while working on the code) the scripted plugin.  I usually stick this below the {{{initializePlugin()}}} and {{{uninitializePlugin()}}} functions.
{{{
import os
import maya.cmds as mc

def pluginLoader(load):
"""
Load or Unload the plugin defined in this file.

Parameters:
load : bool : True to load the plugin, False to unload it.
"""
fullPath = __file__
if fullPath.endswith('.pyc'):
fullPath = fullPath [:-1]
dirPath, plugin = os.path.split(fullPath)

if load:
if not mc.pluginInfo(plugin, query=True, loaded=True):
mc.loadPlugin(fullPath, quiet=True)
mc.pluginInfo(plugin, edit=True, autoload=True)
else:
if mc.pluginInfo(plugin, query=True, loaded=True):
mc.unloadPlugin(plugin, force=True)
mc.pluginInfo(plugin, edit=True, autoload=False)
}}}
You no longer have to worry about about managing your scripted plugin load states as long as that function is called to before you ever call to your scripted plugin command\node\etc.
Below is a //code snippet//.  By itself it won't run, but better than nothing until I get a working example up ;)  But conceptually it works.
{{{
// Make blendShape:
string $blendShape[] = blendShape$target $myMesh; // Turn "on" the$target blendShape (this may be optional)
setAttr($blendShape[0] +$bsattr) 1;

// fire this command to build the context we need
ArtPaintBlendShapeWeightsTool;

// read in our correct map:
select -r $myMesh; string$correctMap = "c:/temp/someMap.jpg";
artAttrCtx -e -importfileload $correctMap artAttrBlendShapeContext; }}} Common operation: {{{ # Python code import maya.cmds as mc plugin = "MyPlugin.mll" mc.loadPlugin(plugin, quiet=True) mc.pluginInfo(plugin, edit=True, autoload=True) }}} If the plugin you're trying to load isn't part of your {{{MAYA_PLUG_IN_PATH}}} Python will raise a {{{RuntimeError}}} [[exception|What kind of exceptions does Python raise when a mel command fails?]]: {{{ # RuntimeError: Plug-in, "MyPlugin.mll", was not found on MAYA_PLUG_IN_PATH. }}} and shoot this error out to Maya: {{{ # Error: line 1: Plug-in, "MyPlugin.mll", was not found on MAYA_PLUG_IN_PATH. }}} ---- Also see: *[[How can I query\update Maya's script path?]] (also applies to plugins) You can write a simple expression to do it. The below code presumes a few things: *You've created a NURBS curve, that is closed. (with a min u of 0, and a max of 1) *You've attached something too it as a motion path. *On the motionPath itself, you've deleted the default keyframes in the {{{.uValue}}} attr {{{ // Maya Expression: int$startFrame = 1;
float $speed = .01; float$curveLenthU = 1.0;

if(currentTime -q <= $startFrame){ motionPath1.uValue = 0; } else{ motionPath1.uValue = motionPath1.uValue +$speed;
if(motionPath1.uValue > $curveLenthU ){ motionPath1.uValue = motionPath1.uValue -1; } } }}} You can change {{{$curveLenthU}}} to be anything you want (if the curve isn't normalize from 0-1), and change the speed to make it faster or slower.
This will generate a custom HUD that will update whenever a new scene is opened \ created.
{{{
# Python code
import os
import maya.cmds as mc

def getSceneName(*args):
"""
Returns the scene name.  Used by the hud call in sceneNameHud()
"""
sceneName = 'untitled scene'
fullSceneName = mc.file(query=True, sceneName=True)
if fullSceneName:
sceneName = os.path.split(fullSceneName)[-1]
return sceneName

def sceneNameHud():
"""
Create a HUD on the top middle of the screen that displays the scene name.
"""
if mc.headsUpDisplay('sceneNameHUD', query=True, exists=True):
mc.headsUpDisplay('sceneNameHUD', remove=True)

mc.headsUpDisplay('sceneNameHUD', section=2, block=0, event='NewSceneOpened',
command=getSceneName)
}}}
{{{rampColorPort}}}
An easy way to do it is with the {{{textToShelf}}} script that ships with Maya.  It lives here:
{{{.../MayaX.X/scripts/startup/textToShelf.mel}}}
Don't forget to save your shelves\prefs after this of course (usually don't when Maya exits, but not always).
Here's the guts of its code, for informative purposes:
{{{
global proc textToShelf (string $label, string$script)
{
global string $gShelfTopLevel; if (tabLayout -exists$gShelfTopLevel)
{
string $currentShelf = tabLayout -query -selectTab$gShelfTopLevel;
setParent $currentShelf; // Create the shelf button on the current shelf. // Give it the default MEL script icon, // and set the short label too. shelfButton -command$script
-label $label -annotation$script
-imageOverlayLabel $label -image1 "commandButton.xpm" -style shelfLayout -query -style$currentShelf
-width shelfLayout -query -cellWidth $currentShelf -height shelfLayout -query -cellHeight$currentShelf;
}
}
}}}
*The DOS attrib command. If there is a way to do it in mel then I'm missing it. Type 'help attrib' in DOS to get all the arugments
*Example: Make a file writable:
{{{
system ("attrib -r " + $nameOfMyFile); }}} I usually like the main menu bar off, but occasionally I like it on, so I can tear off a menu. Rather than having to go through the steps: 'Marking Menu -> Hotbox Controls -> Window Options -> Show Main Menubar' I made this mel toggle: {{{ // Toggle the main menu-bar: global string$gMainWindow;
int $vis = window -q -mbv$gMainWindow;
int $newVis = abs($vis -1);
optionVar -iv mainWindowMenubarVis $newVis; window -e -mbv$newVis $gMainWindow; }}} Starting with the introduction of Qt in Maya 2012, you can make your own custom windows dockable in the Maya UI. The below examples will take a window (who's name is defined by the {{{myAwesomeWindow}}} variable) and turn it into a floating dock, that can then be dragged via the mouse and inserted into various parts of the Maya UI. Docs: [[dockControl|http://download.autodesk.com/global/docs/maya2012/en_us/CommandsPython/dockControl.html]] {{{ # Python code import maya.cmds as mc myAwesomeWindow = "the name of your window..." # Define the name for the docControl: dcName = 'myDC' # Just like you need to delete pre-existing windows before you make new ones, # you need to delete pre-existing dockControls: if mc.dockControl(dcName, query=True, exists=True): mc.deleteUI(dcName) # Create the dockControl that will house the window: mc.dockControl(dcName, allowedArea='all', area='right', floating=True, content=myAwesomeWindow , label='Awesome Dock') }}} {{{allViewFit}}} This is nice to use when you want to frame the camera on something, but don't know which panel the user has active, or which camera they're using. {{{ //Fit the view to all objects: allViewFit(1); //Fit the view to just the selected objects: allViewFit(0); }}} Around Maya 2012, you can use the [[pointOnPolyConstraint|http://download.autodesk.com/global/docs/maya2014/en_us/CommandsPython/pointOnPolyConstraint.html]] command\node to do this. Note, it sticks it to a UV of the poly surface, and I've have questionable results using "maintain offset" with it. ---- Older methods: *This is a general outline, mel to follow *Particle way (credit Colin Penty): **Selct the vert you want to constrain to **"Particles -> Emit from Object [options] -> Emitter Type -> Surface -> Create **Delete the "particle1" node. You now have "emitter1" you can parent objects to, glued to the object. *"Hair Follicle" method: **Found example of this method here: http://www.creativecrash.com/maya/downloads/scripts-plugins/polygon/c/djrivet-mel--3 The [[textureWindow|http://download.autodesk.com/us/maya/2010help/CommandsPython/textureWindow.html]] command. However, the docs say you can only ever have one of these at a time, and the default one exists on Maya startup. So given that, it's probably better to work with the default one than make your own. Based on my tests, I've been unable to get a custom one to work. The {{{condition}}} command. ---- Also see: *[[How can I query if certain conditions exist in Maya?]] Really simple example, running Python: {{{ import maya.cmds as mc def myScriptEditor(): if mc.window('myPyScriptEditor', exists=True): mc.deleteUI('myPyScriptEditor') mc.window("myPyScriptEditor", title="My Python Script Editor") mc.columnLayout(adjustableColumn=True) mc.cmdScrollFieldReporter(height=200) mc.cmdScrollFieldExecuter(height=200, sourceType='python') mc.showWindow() myScriptEditor() }}} *The {{{frameCache}}} node *This is an alternative to the above "expression based" solution. *Example: Make "cube's" .ty lag behind "ball's" .ty by 3 frames: {{{ // this creates the frameCache node: createNode frameCache; // frameCache needs to have time as an input: connectAttr -f time1.outTime frameCache1.varyTime; // frameCache needs to have the animation as an imput: connectAttr -f sphere.ty frameCache1.stream; // To determine the frame offset, you connect the array attr's .past attribute with the // frame offsetvalue as its element (like .past[3]) into the input of your other node: connectAttr -f frameCache1.past[3] cube.ty; }}} *Notes: It appears that after the nodes are connected, the "frameCache" node caches (duh) the animation data. This means that changing the original animation has "strange" results on the frameCache node, with the newer animation not being applied properly to the "offset" node. Don't know the workaround yet.I've spoken with AW about this, and they confirm it's a limitation... A bug report has been submitted. This could also be simply called "how to add things to sets". I find it really handy to organize sets inside of sets. However, my brain can never seem to wrap itself around how to add a 'child set' to a 'parent set' via code: The syntax to me is... a bit backwards: Given a parental set '{{{parentSet}}}', and a set you want to add as a subset called '{{{subset}}}': @@Mel:@@ {{{ sets -addElement parentSet subSet; }}} @@Python:@@ {{{ import maya.cmds as mc mc.sets("subSet", addElement="parentSet") }}} In both instances of the command, to me, it looks like you're trying to add {{{parentSet}}} to {{{subSet}}}, but that's just not the case. In the Outliner this would give you the effect: {{{ - parentSet | ---- subSet }}} {{{play -w;}}} *Example: I have a script that requires the current frame range is played through to define a dynamic simulation. But when I execute my script, the script doesn't wait for the range to finish playing. What to do? Use the -w flag, which is "wait". {{{ //script; play -w; // more script }}}  This... 'annoyance' was introduced around Maya 2008 (+- a version?): If you had objectB.tx connected to objectA.tx, and objectB.tx was keyframed, and you opened the Graph Editor for objectA, you'd see it's 'Translate X' channel expanded, with a pointer to 'objectB.Translate X' under it: ---- (pretend this is the Outliner in the Graph Editor) *objectA **//Translate X// ***@@//objectB.Translate X//@@ ---- @@This@@ is annoying enough on it's own, but presuming that there were many connections from B->A, A's Graph Editor could get full of all sorts of unwanted data. The fix, to turn this "functionality" off: {{{ # Python code import maya.cmds as mc # This is the name of the outlinerEditor in the Graph Editor: graphEd = 'graphEditor1OutlineEd' mc.outlinerEditor(graphEd, edit=True, expandConnections=True) }}} My //guess// is this has something to do with their implementation of animation layers, since the Graph Editor would need to show more than just standard ~animCurves now. Languages like Processing have [[functions|http://www.processing.org/reference/map_.html]] that will take a given value from one range and map it into another. I can't seem to find this in Python, but here's the code: {{{ # Python code def valueRangeMap(val, origMin, origMax, newMin, newMax): """ Will remap val from the original range into the new range. val : float : The value you are mapping. origMin : float : The original minimum value that val should be greater than. origMax : float : The original maximum value that val should be less than. newMin : float : The new minimum value that val will be mapped into. newMax : float : the new maximum value that val will be mapped into. return : float : The newly mapped value. """ # Find the percentage val is between origMin and origMax: percetVal = float(val - origMin) / float(origMax - origMin) # Map into the new range: mappedVal = (newMin+newMax)*percetVal return mappedVal print valueRangeMap(5, 0, 10, 10, 20) # 15.0 }}}  Mel examples first, Python (way at the bottom) second. !Mel Say you have a line with mixed-case characters in it, and you're trying to match a string in it. However, the string you're trying to match could in no-way be in the same case as the original string. In addition, you need to get the result back in the original case. For example: {{{ string$src = "My Mixed Case String";
string $matcher = "mixed case"; }}} What you want to get back is a string like this: {{{ "Mixed Case" }}} There is no "easy" way I've found to do this. If you don't care about having the return value come back case sensitive, you can use the {{{match}}} command combined with the {{{tolower}}} (or {{{toupper}}}) command to format all the string ahead of time. But if you want to maintain case sensivity as part of the return, you need to get into some regular expression voodoo. In a nutshell, the below code will take the {{{$matcher}}} string, and for each alphabetic character, turn it into a matching pair of upper and lower-case characters.  In addition to handling characters that are "special" to {{{match}}}, and need to be escaped when searching.  An example of what this crazy search string looks like is given at the very bottom.
{{{
global proc string matchNonCase(string $matcher, string$line)
{
// convert our $matcher string into a string array: string$array[];
for($i=0;$i<size($matcher);$i++)
$array[$i] = substring $matcher ($i+1) ($i+1); // define characters special to the match command that need to be escaped: string$spcl[] = {".", "*", "+", "^", "$", "\\", "[", "]", "(", ")"}; // generate our special match pattern string: string$matchPattern = "";
for($i=0;$i<size($array);$i++)
{
string $char = match "[a-z]*[A-Z]*"$array[$i]; if(size($char))
{
string $lower = tolower($char);
string $upper = toupper($char);
$matchPattern = ($matchPattern + "[" + $lower +$upper + "]");
}
else
{
int $special = 0; for($j=0;$j<size($spcl);$j++) { if($spcl[$j] ==$array[$i]) {$matchPattern = ($matchPattern + "\\"+$array[$i]);$special = 1;
break;
}
}
if($special == 0)$matchPattern = ($matchPattern +$array[$i]); } } // print$matchPattern;

// and finally, see if we have a match:
string $result = match$matchPattern $line; return$result;
}
}}}
{{{
string $line = "lineData -- \"c:/my/\\Dir$/is/MIXED/case\"  -- more Data";
string $matcher = "/my/\\diR$/is/mIxed/";
string $result = matchNonCase($matcher, $line); // Result: /my/\Dir$/is/MIXED/ //
}}}
If you're wondering, {{{$matchPattern}}} equals this given the above example: {{{ /[mM][yY]/\\[dD][iI][rR]\$/[iI][sS]/[mM][iI][xX][eE][dD]/
}}}
!Python
As ever, doing this in Python is way easier:
{{{
import re

search = "/my/dir/is/mixed"
line = "lineData -- C:/my/Dir/is/MIXED/case --moreData"
print re.findall(search, line, re.IGNORECASE)

# ['/my/Dir/is/MIXED']
}}}
However, embedding special chars will confuse it, so the mel is a bit more robust.  I'm currently checking to see if the special chars in Python can b handled as well.  I presume they can, just havn't found it yet...
We query the {{{.worldMatrix}}} of our source node, then via {{{xform}}} set our destination node to that worldspace transformation:
{{{
// mel
string $source = "pCube1"; string$destination = "pCube2";

float $m[16] = getAttr ($source+".worldMatrix");
xform -worldSpace -matrix $m[0]$m[1] $m[2]$m[3]
$m[4]$m[5] $m[6]$m[7]
$m[8]$m[9] $m[10]$m[11]
$m[12]$m[13] $m[14]$m[15] $destination; }}} {{{ # Python source = "pCube1" destination = "pCube2" m = mc.getAttr(source+".worldMatrix") mc.xform(destination, worldSpace=True, matrix=m) }}} Why is this cool? Because no matter what you have done to the parental hierarchy of either node, and despite the rotation orders of either node, the destination node will perfectly match the worldspace matrix of the source. This also solves problems that other code (like the below example illustrates) will get tripped up on (which include the links at bottom) when dealing with matching orientations: If the __rotate order__ of the destination //differs// from the source, the below code will __fail__. {{{ # Python: import maya.cmds as mc worldRot = mc.xform(source, rotation=True, query=True, worldSpace=True) # two different methods, will fail if differing rotate orders: mc.xform(destination, rotation=worldRot, worldSpace=True) mc.rotate(worldRot[0], worldRot[1], worldRot[2], destination, worldSpace=True) }}} ---- Also see: *[[How can I rotate an object that has one rotation order to the world space orientation of another object with a different rotation order?]] *[[How can I move an object to an exact worldspace position? How can I find an exact worldspace position?]] *[[How can I find the world\local space position of a point?]]  I often find myself needing to mirror nodes from one half of the global YZ plane to the other. This simple Python script will mirror the positions of nodes on the -x side of the YZ plane based on positions on the +x side. All the nodes are selected at once: All the +x nodes first, and the -x nodes second. And they should be selected parent first, child last. {{{ import maya.cmds as mc nodeList = mc.ls(selection=True) if len(nodeList) % 2 == 1: raise(Exception("Please pick an even number of nodes.")) half = len(nodeList)/2 counter=0 while counter < half: sourceNode = nodeList[counter] destNode = nodeList[half + counter] counter = counter+1 sourcePos = mc.pointPosition((sourceNode+".rotatePivot"), world=True) mc.move((sourcePos[0]*-1), sourcePos[1], sourcePos[2], destNode, absolute=True, worldSpace=True, rotatePivotRelative=True) print "Finished World XY Mirror", }}} The script located here: {{{../MayaX.X/scripts/startup/generateChannelMenu.mel}}} This script has all the UI code which builds the marking menu, so edit for your needs. Of course, what would be safer would be to duplicate this script, rename it to something else (like say, {{{myCustomGenerateChannelMenu.mel}}}), and when Maya starts up, add this line to your {{{userSetup.mel}}} script: {{{ source myCustomGenerateChannelMenu; print "Custom generateChannelMenu.mel script sourced -- userSetup.mel\n"; }}} In the UI, Maya calls the term 'project' (as in File -> Project -> Set...). But the mel behind the scenes is {{{workspace}}}. Query the current workspace: {{{ string$proj = workspace -query -active;
}}}
Set the current workspace:
{{{
string $path = "c:/myProject"; if(filetest -d$path){
// This upates the optionVar used by the Preferences UI:
optionVar -sv ProjectsDir $path; // This (procedure, not command) sets the current path as the *default project*. // It also makes directories on disk in the process, so it's not always wanted. // setProject$path;

// This physically sets the project directory, which is also used by fileBrowserDialogs:
workspace -dir $path; // this is also needed to cement things for Maya's project settings, but isn't // needed if you're just trying to update fileBrowserDialogs: workspace -openWorkspace$path;
}
else
warning("Can't set project:  Directory '" + $path + "' doesn't exist."); }}} This sets the '@@current //workspace// directory@@', which also happens to be the path that opens by default when launching a {{{fileBrowser}}} (or a {{{fileBrowserDialog}}} when in //directory// mode), and is also used when searching for files. This is different from the [[current working directory]] (see those notes), that is used by the {{{pwd}}} and {{{chdir}}} commands. If you //don't// set the {{{optionVar}}}, things will still work, but if you look at the Maya Preferences UI, you could see a conflicting path. {{{setProject}}} does the real magic, and makes it persist between Maya sessions. {{{workspace -dir}}} also works, but doesn't seem to persist between Maya sessions. It should be noted that using this technique with a {{{fileBrowserDialog}}} doesn't seem to work, unless it is in 'directory mode', which is mode '4'. For other {{{fileBrowserDialog}}} techniques, see this subject: [[How can I define a start location for my fileBrowserDialog?]]  {{{move}}} \ {{{xform}}} *Example A: Given a transform: {{{ float$position[] = xform -q -ws -rp transformA;
move -a -ws -rpr $position[0]$position[1] $position[2] transformB; }}} *Example B: Given a joint: {{{ float$position[] = xform -q -ws -rp transformA;  // (or jointA, or whatever)
move -a -ws $position[0]$position[1] $position[2] jointB.scalePivot; move -a -ws$position[0] $position[1]$position[2] jointB.rotatePivot;
}}}
{{{autoPlace}}}
*Note: It appears the return values are always in centimeter, so depending on your working units, you may have to use some math to get the correct values.
*Note: It's supposed to work with the mouse position too, but seems very inaccurate
Thanks to 'Campbell' over on highend3d.com for this info
*Do it "C++" style (or so they say...). Here's some examples:
{{{
string $jnts[] = ls ("-type", "joint", listHistory ("-f", 1, listRelatives ("-p", "-ad", sets("-q", "some_quick_select_set")))); }}} {{{ string$jnts[] = ls ("-type", "joint", listHistory ("-f", 1, 'eval("listRelatives -p -ad 'sets -q \"some_quick_select_set\"'")'));
}}}
This is also called 'function syntax', see notes on [[Commands]].

{{{
file -prompt 0;
}}}
Mel solution, for Windows:
{{{
system("start explorer " + toNativePath(dirname(file -q -sn)));
}}}
Python, windows:
{{{
import os
import subprocess
import maya.cmds as mc
fil = mc.file(query=True, sceneName=True)
if fil:
dir = os.path.dirname(fil).replace('/', '\\')
subprocess.Popen(['explorer', dir])
}}}
----
Python solution, for Mac:
{{{
import os
import subprocess
import maya.cmds as mc

def main():
fn = mc.file(query=True, sceneName=True)
if fn:
pth, fil = os.path.split(fn)
# Open a shell:
#subprocess.Popen(['open', '-a', 'Terminal', pth])
# Open Finder:
subprocess.Popen(['open', '-a', 'Finder', pth])
main()
}}}
Note it provides a solution for opening a Terminal shell to the dir as well.
{{{file}}} \ {{{fileDialog}}}
*Example: I want to import a specific kind of file from a specific directory:
{{{
file -i fileDialog -dm \"Z:/rotk/objects/char/rig/scenes/myFile.*\";
}}}
Starting in Maya 2014, they added a {{{-directory}}} flag to the {{{launch}}} command:
{{{
// mel
launch -directory "c:/temp"
}}}
{{{
# Python
import maya.cmds as mc
mc.launch(directory="c:/temp")
}}}
Optionally you can do this in pure Python.  Note on Windows the paths need to be backslashed:
{{{
import os
import subprocess

os.system('explorer c:\\temp')
# or:
subprocess.Popen(['explorer', 'c:\\temp'])
}}}
On Windows this should open Explorer, on Mac, Finder.
----
Very easily, you can write code that will open a window for the currently (saved) scene:
{{{
import os
import maya.cmds as mc

sceneName = mc.file(query=True, sceneName=True)
sceneDir = os.path.dirname(sceneName)
mc.launch(directory=sceneDir)
}}}
{{{
import maya.cmds as mc

def getSavedPath(ovName):
"""
Get an optionVar by the given name.  Return an empty string if either no
optionVar exists, or the path it defines doesn't exist.
"""
savedPath = mc.optionVar(query=ovName)
if savedPath == 0:
savedPath = ""
elif not os.path.isdir(savedPath):
savedPath = ""
return savedPath

def getSavePath(fileType):
"""
Create a fileDialog the user can use to specify a file to save, either new,
or pre-existing.  Will store the path to the file for future access.

returns the name of the file to save.
"""
try:
ovName = '%sSaveDir'%fileType
savedPath = getSavedPath(ovName)
# Open our file browser:
f = mc.fileDialog(mode=1, directoryMask="%s*.%s"%(savedPath,fileType),
title="Save .%s data"%fileType)
# Append the extension to the file if the user didn't:
if f != "":
ext = os.path.splitext(f)
f = "%s.%s"%(ext[0], fileType)
else:
raise Exception

# Save our path for later browsing
browsedPath = os.path.split(f)
mc.optionVar(stringValue=[ovName, browsedPath[0]+"/"])

if os.access(f, os.F_OK) and not os.access(f, os.W_OK):
raise Exception("'%s' is read-only, unable to save."%f)
return f

except Exception:
print "Save canceled by user:",

def getLoadPath(fileType):
"""
Create a fileDialog the user can use to specify a file to load.  Will store
the path to the file for future access.

returns the name of the file to load.
"""
try:
# Define the name of our optionVar
ovName = '%sLoadDir'%fileType
# Query for saved path data:
savedPath = getSavedPath(ovName)
# Open our file browser:
f = mc.fileDialog(mode=0, directoryMask="%s*.%s"%(savedPath,fileType),
title="Load .%s data"%fileType)
# Save our path for later browsing
if f != "":
browsedPath = os.path.split(f)
mc.optionVar(stringValue=[ovName, browsedPath[0]+"/"])
else:
raise Exception
return f

except Exception:
print "Load canceled by user",
}}}
{{{
print getLoadPath("ma")
# C:/temp/file.ma
}}}
{{{
print getSavePath("ma")
# C:/temp/file.ma
}}}
There is a runTimeCommand called:
{{{
HardwareRenderBuffer
}}}
that will launch it, but it's just a wrapper for the procedure:
{{{
glRenderWin()
}}}
which lives in the script:
{{{
C:/Program Files/Autodesk/Maya<VER>/scripts/others/glRenderWin.mel
}}}
----
Also see:
*[[How can I render from the Hardware Render Buffer?]]
In this folder:
{{{
C:\Program Files\Autodesk\Maya20XX\scripts\others
}}}
Live many "marking menu" scripts, named "{{{context*ToolsMM.mel}}}".  For example:
{{{
contextNurbsCurveToolsMM.mel
contextPolyToolsDefaultMM.mel
contextPolyToolsEdgeMM.mel
contextPolyToolsFaceMM.mel
contextPolyToolsMM.mel
contextPolyToolsObjectMM.mel
contextPolyToolsVertexMM.mel
contextToolsMM.mel
etc...
}}}
The easy way to override them is copy them into a version-specific script dir, like
{{{
C:\Users\<userName>\Documents\maya\2014-x64\scripts
}}}
//Not// the version shared scripts dir here:
{{{
C:\Users\<userName>\Documents\maya\scripts
}}}
And then text-edit them to your hearts content ;)

New way my buddy Te pointed out to me:
{{{
# Python code:
import maya.cmds as mc
mc.parent('someShapeNode', 'someTransform', shape=True, add=True)
}}}
I thought the code would //re-parent// the shape node.  But it doesn't, it makes it an instance.
----
Older method:
*First, you "instance" your shape node, which will give you a new transform as well.
*Second, you parent your new instanced shape node to it's new parental transform.
*Third, remove the 'no-longer-needed' transform
{{{
string $shapeNode = "myShape"; string$newParent = "someTransform";
string $instancedShape[] = instance$shapeNode;
parent -s -r ($instancedShape[0] + "|" +$shapeNode) $newParent; delete$instancedShape[0];
}}}
Also see:
[[How can I reparent the shape node of one object to another.  OR, how can I have a single transform with multiple shapes?]]
If you have a polygonal asset with multiple materials assigned to multiple faces, and you pick a single face and try to find what material is assigned to it in the Hypershade, the Hypershade will list ALL the materials assigned to that mesh.

The below code will select the given material assigned to any single face:
{{{
string $sel[] = ls -fl -sl; if(size($sel)!= 1)
error "Please select a single face";
string $shaders[] = listSets -type 1 -object$sel[0];
string $mat[] = listConnections -s 1 -d 0 ($shaders[0] + ".surfaceShader");
select -r $mat[0]; }}} Presuming your selection is a //single face//, this code will find the associated {{{shadingEngine}}}, all items in that engine, and select them. {{{ string$sel[] = ls -fl -sl;
if(size($sel)!= 1) error "Please select a single face"; string$shaders[] = listSets -type 1 -object $sel[0]; string$items[] = sets -q $shaders[0]; select -r$items;
}}}
The above example will pick all faces assigned to that shader in the scene, spanning all meshes.  The code can be changed slightly:  The //below// example will do the same as the above, but it will only pick faces on the //same mesh// as the original selected face.
{{{
string $sel[] = ls -fl -sl; if(size($sel)!= 1)
error "Please select a single face";
string $shaders[] = listSets -type 1 -object$sel[0];
string $items[] = sets -q$shaders[0];
string $locMesh[]; tokenize$sel[0] "." $locMesh; select -cl; for($i=0;$i<size($items);$i++){ if(match$locMesh[0] $items[$i] == $locMesh[0]) select -add$items[$i]; } }}} I blogged about it here: http://www.akeric.com/blog/?p=1049 ---- And notes on the Python functions: http://docs.python.org/library/pickle.html http://docs.python.org/library/pickle.html#module-cPickle http://docs.python.org/library/stringio.html#module-StringIO If you're on Windows, the easiest way is to call out to {{{Windows Media Player}}} via the command line: {{{ string$app = "C:/Program Files/Windows Media Player/wmplayer.exe";
string $vid = "C:/temp/myMovie.avi"; system("start " +$app + " \"" + $vid + "\""); }}} This will of course load it in {{{Windows Media Player}}}. If you wanted to play a movie //in// a Maya UI, you'd need to know HTML programming, and tie that in with the {{{webBrowser}}} mel command (which however, will be removed sometime after Maya 2012). Note: You can find a list of the {{{Windows Media Player}}} command line options here: http://support.microsoft.com/KB/241422 ---- Python code: Here's a Python example using 'Windows Media Player' on my Win7 box: {{{ # Python code import os import subprocess player = os.path.join(os.getenv("ProgramFiles(x86)"), "Windows Media Player\wmplayer.exe") vid = "C:/videos/myVideo.avi" subprocess.Popen([player, vid]) }}} Maya has no built-in sound playing to my knowledge. With Python (on windows), it's pretty easy actually: http://docs.python.org/library/winsound.html {{{ # Python code import winsound winsound.PlaySound( 'c:/temp/myWav.wav', winsound.SND_ALIAS) }}} ---- ~Pre-Python info: The Windows {{{sndrec32}}} executable can be ran in command line mode. In UI mode, it's the little window that ships with Windows and lets you record and playback .wav files. Here are a list of it's arguments that I've found from online searching: (I haven't verified them all yet) {{{ sndrec32 arguments: /embedding - ??? /play - play file /open - open file but don't play it /new - open new file ready for recording /close - close file }}} Based on that, and given a {{{.wav}}} file you'd like to play, you could script something like this (info modified from 'Joojaa' on Highend3d.com forums): {{{ string$wav = "C:/WINDOWS/Media/Notify.wav";
$wav = toNativePath($wav);
system ("shell start /min sndrec32 /play /close " + $wav ); }}} It //looks// like the {{{system}}} command uses both {{{shell}}} and {{{start}}} (since both shell and start are 'arguments' it can call to when calling to a cmd shell). In fact, the {{{system}}} command is //only// using '{{{shell}}}'. '{{{start}}}' is actually being called //by// the command shell once opened, and it has an argument which is {{{/min}}}, which causes the new cmd shell, and thus the sound recorder, to start in minimized mode. Check out the docs on the {{{system}}} command to learn about what {{{start}}}, {{{shell}}}, and {{{load}}} do in its context. So here is another way to visualize how the data is being wrappered, with 'arguments' in quotes ('shell' isn't an actual argument of the {{{system}}} command, but can be considered one in this sense): {{{system "shell" [ start "/min" [ sndrec32 "/play" "/close" [$wav ] ] ]}}}
The Output Window collects {{{stdout}}} and {{{stderr}}} streams from within Maya.  Below are vaious ways to interact with them
!!!Maya Python API:
{{{
import maya.OpenMaya as om
util = om.MStreamUtils()
stdout = util.stdOutStream()
stderr = util.stdErrorStream()
util.writeCharBuffer(stdout, "api stdout to the Output Window\r\n")
util.writeCharBuffer(stderr, "api stderr to the Output Window\r\n")
}}}
!!!Python:
{{{
import sys
sys.__stdout__.write("Python stdout to the Output Window\r\n")
sys.__stderr__.write("Python stderr to the Output Window\r\n")
}}}
!!!Mel:
The {{{trace}}} command (which prints to {{{stdout}}}).  For example:
{{{
trace "Mel stdout to the Output Window";
}}}
----
If you wanted to go the other way, and capture something from {{{stdin}}}, you have two options via Python:
A:  Via Maya's own {{{maya.app}}} package:
{{{
stream =  maya.app.baseUI.StandardInput()
stdin = stream.read()
print stdin
}}}
B:  Via python's own built-in {{{raw_input}}}:
{{{
stdin = raw_input()
}}}
If you were using Python external to Maya you could pass a string to {{{raw_input}}} that it would prompt the user with.  But Maya appears to hijack this functionality.

Found this awesome reference to {{{itertools}}} via the comments in this blog post:
http://tartley.com/?p=1081

http://docs.python.org/library/itertools.html#itertools.product

You need to be running Maya 2010 for {{{itertools.product}}} to work, since {{{product}}} was introduced in Python 2.6
{{{
# Python code
import maya.cmds as mc

import itertools
edge=1
verts=list(itertools.product(*([-edge/2,edge/2],)*3))
print verts
for v in verts:
mc.spaceLocator(position=v)
}}}
prints:
{{{
[(-1, -1, -1), (-1, -1, 0), (-1, 0, -1), (-1, 0, 0), (0, -1, -1), (0, -1, 0), (0, 0, -1), (0, 0, 0)]
}}}
The ~OpenMayaUI API's [[M3dView class|http://docs.autodesk.com/MAYAUL/2013/ENU/Maya-API-Documentation/cpp_ref/class_m3d_view.html]] has several methods for doing this.  An example of projecting a 3d worldspace point to 2d screen-space can be found here:
*[[How can I convert a 3d point to 2d screen space?]]
Here's an overview of the pertinent methods:
*{{{viewToWorld}}} : Takes a point in port coordinates and returns a corresponding ray in world coordinates.  Takes a point in port coordinates and returns a point on the near and far clipping planes.
*{{{viewToObjectSpace}}} : Takes a point in port coordinates and returns a corresponding ray in object coordinates.
*{{{worldToView}}} : Converts a point in world space to port space.
*{{{projectionMatrix}}} : Returns the projection matrix currently being used by ~OpenGL in the current view.
*{{{modelViewMatrix}}} : Returns the modelview matrix currently being used by ~OpenGL in the current view.
It's often handy to have a UI that has a viewport with a custom perspective camera in it.  The below example shows a really easy way of doing it.  By default, it will create a window with the standard {{{persp}}} camera in it.  But it allows the user to pass in their own custom camera name as well.
{{{
# Python code
import maya.cmds as mc

class App(object):
def __init__(self, camera="persp"):
self.name = "customModelPanel"
if mc.window(self.name, exists=True):
mc.deleteUI(self.name)
mc.window(self.name, resizeToFitChildren=True)
mc.paneLayout(configuration='single')
mc.modelPanel(camera=camera, menuBarVisible=True)
mc.showWindow()
}}}
To execute:
{{{
App()
}}}
I often have geometry provided to me from the animation staff placed some distance away from the origin.  For rigging purposes, I need them centered about the origin, with their pivots at the origin.  How to get it moved back there quickly?
{{{
string $sel[] = ls -sl; for($i=0;$i<size($sel);$i++) { xform -cp$sel[$i]; vector$pos = xform -q -ws -rp $sel[$i];
move -a -ws (($pos.x)*-1) (($pos.y)*-1) (($pos.z)*-1); } // After this is done, you probably want to // freeze their transforms too: makeIdentity -a 1$sel;
}}}

Sometimes when working with a UI, I want to be able to query the command it executes.  Sometimes you can just turn on 'echo all commands' in the script editor, but not always.

If the button has a label on it, here is one method to extract the command information:

In this example, I track down the command executed from the "Flood" button in the Pain Smooth Skin Weights Tool.  (irony is you //can// find this out via 'echo all commands')
{{{
# Python code
import maya.cmds as mc

# Get every ui control in the scene:
allCtrls = mc.lsUI(controls=True)
# Filter for just buttons:
allBut = [item for item in allCtrls if mc.button(item, exists=True)]
# Filter buttons by label:
myBut = [b for b in allBut if mc.button(b, query=True, label=True) == 'Flood']
# Extract command:
command = mc.button(myBut[0], query=True, command=True)

print command
# artAttrSkinPaintCtx -e -clear currentCtx
}}}

{{{
string $filters[] = itemFilter -q -listBuiltInFilters; print$filters;
}}}
{{{
DefaultGeometryFilter
DefaultNURBSObjectsFilter
DefaultPolygonObjectsFilter
DefaultSubdivObjectsFilter
DefaultCameraShapesFilter
DefaultJointsFilter
....etc...
}}}
You can also query 'user-defined' filters and 'other filters' as well.
Also see:
*[[Based on an itemFilter, how can I find all the nodes in Maya that match?]]
*[[How can I use itemFilter or itemFilterAttr?]]
{{{
skinCluster -q -inf $object; // or leave off$object for the selected object
}}}

The easiest way is to call out to {{{dos}}} using its {{{DIR}}} command.  The default {{{dos}}} syntax to get a list of all the subdirs of a dir is this:
{{{
DIR /ad /s /b
}}}
You could jump through a lot of hoops with the {{{getFileList}}} command, but I've tried, and it's exponentially slower than doing below:
And here is how to wrapper that with mel:
{{{
// good chance the incomming path has forwardslashes
string $path = "c:/temp"; // convert to backslash:$path = toNativePath(path);

// query the system:
string $dirList = system("DIR "+$path + " /ad /s /b");

// and convert into an array:
string $dirs[]; tokenize$dirList "\n" $dirs; print$dirs;
// the last index will be an empty string, FYI
}}}
You'll probably want to run {{{fromNativePath}}} on each array member to put them back in "forwardslash" mode when you itter through the list.

If you want to kick it up a notch, you can also use dos to look for a particular dir IN each of the paths, at the same time the list is being generated.  Say, you want to find all the dirs that END with {{{\foo}}}.  The dos command would be:
{{{
DIR /ad /s /b |FINDSTR "\\foo$" }}} As you can see, you pipe the return of the DIR command into the FINDSTR command, which then looks for {{{\foo}}} at the end up each line using the ({{{$}}}) regular expression.  You have to use double-backslashes in front of foo, since the backslash is an escape character in regular expressions.
To wrapper that in mel would look like this:
{{{
string $dirList = system("DIR " +$path + " /ad /s /b |FINDSTR \"\\\\foo$\""); }}} And if you wanted to find all the .ma files in that result (notice the {{{/ad}}} was removed): {{{ string$dirList = system("DIR " + $path + " /s /b |FINDSTR \"\\\\foo$\" |FINDSTR \".ma$\" "); }}} And that, is a lot of escape backslashes.... Another dos example querying for a partial name of a file based on a specifically named subdir: {{{ DIR /s /b |FINDSTR /R "\\build\\.*_foo\.py$"
}}}
This says:  Look under the current dir for all subdirs named {{{\build}}}, and return a list of all files that end in {{{_foo.py}}}.
The {{{control}}} command.

While each UI control usually has its own edit and query flags, you can also use the generic {{{control}}} command to do these operations.  Makes it easier, if you know the name of a control, but not its 'type', to edit it.

Good for querying/editing:
control size, visibility, parent, and popup menus among others.
The {{{listConnections}}} command has a '{{{type}}}' parameter that lets you filter the results by a given type.  Unfortunately, you can only pass in a single string argument.  Below is a little tip that let's you specify the connection types ahead of time.  Via Python, we use a //list comprehension// to generate a list of all matching connection types for each of the ones we query.  Then we use the {{{zip}}} Python command to zip our original connection type list together with our connection results list.  Finally, we wrapper that in Python's {{{dict}}} command, which turns the result into an easily queryable dictionary:
{{{
# Python code
import maya.cmds as mc

myNode = 'myNode'
conType = ['bindPose', 'skinCluster']
con = dict(zip(conType, [mc.listConnections(myNode, type=ct) for ct in conType ]))
print con
# {'skinCluster': [u'skinCluster4', u'skinCluster4'], 'bindPose': None}
}}}
In Windows the {{{tasklist}}} command will return this info.
Example if you have two Maya's open:
{{{
> tasklist /FI "IMAGENAME eq maya.exe"

Image Name                     PID Session Name        Session#    Mem Usage
========================= ======== ================ =========== ============
maya.exe                      6064 Console                    1    289,552 K
maya.exe                      1288 Console                    1    289,480 K
}}}
In Maya, you can use Python to query its return:
{{{
import subprocess

def isMayaOpen():
"""
Will return how many open maya.exe applications are running.
"""
mayaOpen = 0
output = subprocess.Popen(['tasklist', '/FI', 'IMAGENAME eq maya.exe'], stdout=subprocess.PIPE).stdout
for line in output:
if 'maya.exe' in line:
mayaOpen = mayaOpen+1
return mayaOpen
}}}
{{{
print isMayaOpen()
2
}}}
----
On a related note, Maya can query its own //process identifier// number via the //mel// command (not in Python for some reason...), which coresponds to the above PID values:
{{{
import maya.mel as mm
pid = mm.eval('getpid');
print pid
1288
}}}
(Answer, from Alias:)
{{{
int $sj = scriptJob -e RecentCommandChanged rcc; global proc rcc() { string$lastCommands[] = repeatLast -q -cl;
if (gmatch $lastCommands[0] "Save*") print ("scene was saved with " +$lastCommands[0] + "\n");
}
}}}

{{{filetest}}}
{{{
int $unloaded = file -query -deferReference$refFilePath;
}}}
Will return {{{1}}} if unloaded, {{{0}}} if loaded.
{{{
import maya.cmds as mc
needsSaving = mc.file(query=True, modified=True)
}}}
Have yet to find a API call for this: [[MFileIO|http://download.autodesk.com/us/maya/2011help/API/class_m_file_i_o.html]] (the obvious place for it) doesn't have a similar method.
----
Also see:
*[[How can I list which nodes have been modifed since the last save?]]
You can actually use the {{{objExists}}} command, like:
{{{
int $txAttrExists= objExists persp.tx; // Result: 1 // }}} Which is easier than the syntax for {{{attributeQuery}}}, and I'm told that it actually evaluates faster too. ''However'', I've learned that if querying for the existence of an attr on a transform, it will also search the shape as well, which often' *isn't* wanted. Given that, you can use {{{attributeQuery}}}, or the {{{listAttr}}} command to get all the attrs on the node, then test for existence of your attr in that list. {{{ import maya.cmds exists = mc.attributeQuery('attrName', node='nodeName', exists=True) }}} ---- There is also the [[attributeExists|http://download.autodesk.com/global/docs/maya2012/en_us/Commands/attributeExists.html]] mel //script// (not available in Python unless eval'd) I've been unable to find anything via mel or the API that returns whether an image has an alpha channel. The file //node// however, knows this: Presuming you've mapped some valid texture to a file node: {{{ int$hasAlpha = getAttr myFileNode.fileHasAlpha;
}}}

*Example: Select an object and:
{{{
string $sel[] = ls -sl; referenceQuery -inr$sel[0];
}}}
----
Via the API, you can query this via the {{{MFnDependencyNode}}} class:
http://download.autodesk.com/us/maya/2010help/API/class_m_fn_dependency_node.html
{{{
import maya.OpenMaya as om
dgIterator = om.MItDependencyNodes()
while not dgIterator.isDone():
currentItem = dgIterator.thisNode() # MObject
currentItemFunc = om.MFnDependencyNode(currentItem)
if currentItemFunc.isFromReferencedFile():
print "I'm referenced:", currentItemFunc.name()
dgIterator.next()
}}}
{{{isTrue}}} is a command that you can use to query various condition and events in Maya.
What are those events and conditions?
The {{{scriptJob}}} command can be used to find them:
{{{
help -doc scriptJob;
}}}
Or you can have the events and conditions listed:
{{{
print scriptJob -listEvents;
print scriptJob -listConditions;
}}}
So for example, if you wanted to know if Maya was currently playing back animation:
{{{
int $playback = isTrue playingBack; }}} Or is something picked: {{{ int$selected = isTrue SomethingSelected;
}}}
There are many others.  Handing if while scripting, you need to have your script detect for a certain condition.
{{{
global proc int isKeyed(string $obj) { string$connections[] = listConnections -s 1 -d 0 $obj; for($i=0;$i<size($connections);$i++) { string$type = objectType($connections[$i]);
if(match "^animCurve" $type == "animCurve") return 1; } return 0; } string$sel[] = ls –l –sl;
int $keyed = isKeyed($sel[0]);
}}}
{{{
float $keys[] = keyframe -q -sl -vc; }}} changing the "-vc" with other flags will return different values Constraints (seemingly all of them) have a {{{-tl}}} (target list) flag that can be used to query a list of targets, and a {{{-wal}}} flag that can be used to query the coresponding list of 'weight attributes' on the constraint itself: Presuming it's a {{{parentConstraint}}} {{{ // mel string$targetObjs[] = parentConstraint -q -tl $constraintName; string$weightAttrs[] = parentConstraint -q -wal $constraintName; }}} Armed with this knowledge, I decided to write a Python function that would capture this data easily for the user. Since the mel command to deal with the a given constraint conveniently matches the objectType of the given node, it allows me to write one piece of code that can work on any constraint type. {{{ # Python code: import maya.cmds as mc def getConstraintTargetData(constName): """ Based on the given constraint, will return a list of data for each constraint weight. Specifically, each list index is a dict, with the keys "target" (target object) and "attribute" (corresponding attribute weight name on the constraint) """ constType = mc.objectType(constName) constraintData = [] targetList = eval('mc.%s("%s", query=True, targetList=True)'%(constType, constName)) weightList = eval('mc.%s("%s", query=True, weightAliasList=True)'%(constType, constName)) for i in range(len(targetList)): constraintData.append({"target":targetList[i], "attribute":weightList[i]}) return constraintData }}} To see it in action, parent constrain pSphere1 to pCube1 and pTorus1: {{{ targetData = getConstraintTargetData("pSphere1_parentConstraint1") print "Number of targets: %s"%len(targetData) for i,e in enumerate(targetData): print "Index %s: %s"%(i, e) print "Weight attribute for index 0: %s"%targetData[0]["attribute"] print "Target object for index 1: %s"%targetData[1]["target"] }}} prints: {{{ Number of targets: 2 Index 0: {'attribute': u'pTorus1W0', 'target': u'pTorus1'} Index 1: {'attribute': u'pCube1W1', 'target': u'pCube1'} Weight attribute for index 0: pTorus1W0 Target object for index 1: pCube1 }}} !!!~PyMel: In this example, we query values for vert 0 on our mesh: {{{ import pymel.core as pm skinCluster = pm.PyNode("someSkinClusterName") mesh = pm.PyNode("someMeshName") joint = pm.PyNode("someJointName") # Get a list of all the weight values on this vert: values = pm.skinPercent(skinCluster, mesh.vtx[0], query=True, value=True) # Get a list of all the transforms influencing this vert. Can't seem to get this command # to work in pure PyMel or Python, have to eval the mel: transforms = pm.mel.eval('skinPercent -query -transform "%s" "%s"'%(skinCluster.nodeName(), mesh.vtx[0])) # Get the float weight value for just this specific joint on this one vert: jointValue = pm.skinPercent(skinCluster, mesh.vtx[0], query=True, transform=joint) }}} !!!Mel Pick a vertex, and run: {{{ // get just the object name from selection: string$selObj[] = ls -o -sl;
// get the vert name
string $selPt[] = ls -sl; // find our skindCluster: string$sc[] = listConnections -s 1 -d 0 -type "skinCluster" $selObj[0]; // get transforms (binding joints and influence object) string$skinInfluences[]=skinPercent -q -t $sc[0]$selPt[0];
// get skin weight of selected vertex
float $sknVals[]=skinPercent -q -v$sc[0] $selPt[0]; // only print values that are greater than 0. If you want to know // influence names even if they are zero, remove the 'if' line: for($i=0;$i<size($skinInfluences);$i++) { if($sknVals[$i] > 0) // print$sknVals[$i] print ($skinTrans[$i] + "\t\t" +$sknVals[$i] + "\n"); } }}} *the index of$skinTrans and $skinVals is 1-1 matched {{{ import maya.cmds as mc print mc.window("", query=True, frontWindow=True) # scriptEditorPanel1Window }}} Note you still need to pass an empty string into the {{{window}}} command to access this functionality. Via the '{{{Deform-> Paint Blend Shape Weights Tool}}}', you can paint the influence that a blend shape has on a mesh. The tool lets you save the weights out as a map, and read the weights back in. But where do the weights actually get stored on the object? On the blendShape node's '{{{.inputTarget.inputTargetGroup.targetWeight}}}' att: {{{ getAttr blendShape1.it[0].itg[0].tw; // Result: 1 1 1 1 1 1 1 0.5 0.5 0.50.5 0.5 etc.... }}} There is a 1:1 relationship beween these values, and the verts on the mesh. I figured this out by looking in the .ma file itself. I couldn't find anything //in// Maya that would explain what\where these values were. You could edit them in the Component Editor, but it wouldn't explain what it was doing. And when you paint the actual weights, or load a weight file, neither does it tell you what it's doing then either. I gave this info to someone else, and they came back with this description: *inputTarget[0]. >> Maybe your source mesh? *inputTargetGroup[1]. >> your target by index *targetWeights[0] >> the actual vert index to modify *0; > the value to set  It's easy enough to just query that part of the UI: {{{ string$char = textField -q -text characterField;
}}}
With the 'Paint Skin Weights Tool' visible:
{{{
# Python code
import maya.cmds as mc
print mc.artAttrSkinPaintCtx('artAttrSkinContext', query=True, influence=True)
}}}
{{{
string $list[]= listAttr -m "<name of blendshapes>.w"; }}} *thanks to a post from David Coleman {{{colorAtPoint}}} *Example given a "ramp" node: {{{ colorAtPoint -o RGB -u .5 -v .5 ramp1; }}} I was told that if your UV's are tiling, UV 0 and 1 can return the same values. Querying .99999 is a safer bet. Should also be noted that this only samples the color for the given node, not the final combination of multiple nodes (if they exist). Haven't yet found an //easy// way to grab the final color of a given uv point based on a complex shading network. ---- Also see: *[[How can I find the color of a render node at a given vertex?]] The {{{undoInfo}}} command will let you print the contents of the undo queue. But it doesn't let you actually capture that data, which is a bit of a pain. The below method shows how you //can// capture that data, but turning on script editor history logging: {{{ # Python code import os import maya.cmds as mc # Define a temp file name, and delete if it exists, since the # history logging will append to it: tempfile = os.path.join(os.getenv("TMP"), "undoInfoTemp.txt") if os.access(tempfile, os.F_OK): os.remove(tempfile) # Set the Script Editor to write out all it's history to this file: mc.scriptEditorInfo(edit=True, historyFilename=tempfile, writeHistory=True) # print our undo queue: mc.undoInfo(query=True, printQueue=True) # Turn off history capture: mc.scriptEditorInfo(edit=True, writeHistory=False, historyFilename='') # Turn the file into a list we can use: undoQueue = [line.strip() for line in open(tempfile)] # And print the result: print "Stuff in queue:" for line in undoQueue: print "\t", line }}} {{{ Stuff in file: # 0: select -r foo # 1: select -cl # 2: select -r stuff }}} {{{ string$paneConfiguration = paneLayout -q -configuration $gMainPane; string$paneKids[] = paneLayout -q -ca $gMainPane; }}} {{{about}}} *Example, query the current date or time: {{{ string$date = about -cd;
string $time = about -ct; }}} You don't want to query the //current// enumAttr value, you want to query //all// their names: ---- {{{ string$enumAttrs = addAttr -q -enumName "myNode.myEnumAttr";
}}}
This returns a single string of attr names separated by colons:
{{{
"enumA:enumB:enumEct"
}}}
----
Tip from my buddy Te:
{{{
string $enumAttrs[] = attributeQuery -node "myNode" -listEnum "myEnumAttr"; }}} This returns an array, with a single string value separated by colons: {{{ {"enumA:enumB:enumEct"} }}} ---- Or, via ~PyMel's [[Attribute.getEnums()|http://download.autodesk.com/global/docs/maya2014/en_us/PyMel/generated/classes/pymel.core.general/pymel.core.general.Attribute.html?highlight=attribute#pymel.core.general.Attribute.getEnums]] method: (Modified example from the ~PyMel docs): {{{ >>> from pymel.core.general import Attribute >>> addAttr( "persp", ln='numbers', at='enum', enumName="zero:one:two:thousand=1000:three") >>> numbers = Attribute('persp.numbers').getEnums() >>> sorted(numbers.items()) [(u'one', 1), (u'thousand', 1000), (u'three', 1001), (u'two', 2), (u'zero', 0)] >>> numbers[1] u'one' >>> numbers['thousand'] 1000 }}} The active influence can be found in: {{{ global string$artSkinLastSelectedInfluence;
}}}
A list of the highlighted influences can be found in:
{{{
global string $gArtSkinOrderedInfluenceSelectionList[]; }}} These values are queried\modified inside this script: {{{ C:\Program Files\Autodesk\Maya20XX\scripts\others\artAttrSkinJointMenu.mel }}} ---- The actual control in Maya is a {{{treeView}}} named {{{theSkinClusterInflList}}}. So you can query the selected influences this way: {{{ string$infs[] = treeView -q -si "theSkinClusterInflList";
}}}
But this won't tell you the 'lead' influence:  Currently it seems you need the above global var to do it.
The ui is made via the proc {{{skinClusterInflBuildList}}} living in this script:
{{{
C:\Program Files\Autodesk\Maya20XX\scripts\others\skinClusterInflMenu.mel
}}}
New in Maya 2010, is the //mel only// command {{{getLastError}}}
First off, you can use the {{{whatIs}}} command, and I have a tiddler specifically authored aroud that here:  [[How can I have a script return where it lives on disk?]]
However, that method can run into problems if you're currently authoring the script, since Maya can think it's an interactively entered procedure possibly, and not give you the path back.

Another solution is to actually use the {{{file}}} command.  Presuming you save a script in your script path, you can query its location this way:
{{{
string $path = file -query -location "testScript.mel"; // Result: C:/temp/./testScript.mel //$scriptLocation = substitute "/./" $scriptLocation "/"; // Result: C:/temp/testScript.mel // }}} With a little formatting via the {{{substitute}}} command, you get the full path back.  When you reference a scene, Maya creates a node of type {{{reference}}} to help manage the changes. Most {{{reference}}} nodes are the defined namespace plus "RN". So if you reference someting in with the "bob" namespace, the {{{reference}}} node created would be called {{{bobRN}}}. Presuming you know that reference node name (easily gathered by the '{{{ls -type "reference";}}}' command), how can you query the namespace that the referenced file currently resides in? {{{ string$refNode = "bobRN";
string $file = getAttr ($refNode +".fileNames[0]") ;
string $ns = file -q -rpr$file;
// bob
}}}
After a file has been referenced into a scene, it's possible that it's namespace could be different from what was specified due to namespace clashing.  How to query what the namespace actually is?
{{{
# Python code
import maya.cmds as mc
namespace = mc.file('c:/path/to/my/file.ma', query=True, namespace=True)
}}}
{{{
polyNormalPerVertex -q -xyz  pSphere1.vtx[41];
}}}
Note, this will shoot back multiple sets 3 floats for each "vertexNormal", one for each tri that the vert shares.

Also see:  [[How can I set the normal of a vertex?]]


{{{
string $name = setParent -q myElementName; }}} Thanks to Eric Vignola ;-) As you edit a ramp node, you can add and remove "colors" from it. You may at some point want to be able to query where on the ramp those colors are. Here is a quick way to do it: {{{ string$ramp = "ramp1";
string $mults[] = listAttr -m ($ramp + ".colorEntryList");
for($i=0;$i<size($mults);$i++)
{
if(match "\\.position$"$mults[$i] == ".position") { float$pos = getAttr ($ramp + "." +$mults[$i]); print ($ramp  + "." + $mults[$i] + "  is: " + $pos + "\n"); } } // result: ramp1.colorEntryList[0].position is: 0 ramp1.colorEntryList[1].position is: 0.5 ramp1.colorEntryList[2].position is: 1 }}} Mel: {{{ string$sceneName = file -query -sceneName;
}}}
Python:
{{{
import maya.cmds as mc
sceneName = mc.file(query=True, sceneName=True)
}}}
Via the API:
{{{
import maya.OpenMaya as om
sceneName = om.MFileIO.currentFile()
}}}
----
The main difference between the commands and the API is the return value when the current scene //isn't saved//:  The {{{file}}} command will return back an empty string.  But {{{MFileIO.currentFile()}}} will return the string {{{untitled}}}, with the current project path.  For example:
{{{
c/somePath/untitled
}}}
*Maya 5:
{{{
addAttr -q -en object.attr;
}}}
*Maya 6 and later:
{{{
getAttr -as object.attr\\ (as string)
}}}


This code works in 2013:  I'm not sure when {{{portWidth}}} and {{{portHeight}}} came online, but they're so easy to use I'm guessing they weren't available in earlier versions of Maya that the below code is based on.
{{{
import maya.OpenMayaUI as omui
activeView = omui.M3dView.active3dView()
width = activeView.portWidth()
height = activeView.portHeight()
}}}
----
No API, just mel.  Note, this returns a slightly larger value than the above and below examples (who's values match one another).
{{{
def getCurrentPanelSize():
# This returns the full name, and is filtered by modelPanel's only:
#mp = mc.playblast(activeEditor=True)
# This returns the leaf name, and can be any type of editor:
mp = mc.getPanel(withFocus=True)

width = mc.control(mp, query=True, width=True)
height = mc.control(mp, query=True, height=True)
return width,height
}}}
What's interesting is the {{{playblast}}} command limits its return to the last active 3D {{{modelPanel}}}, while the {{{getPanel}}} command will return back the last accessed panel or editor of any kind (Graph Editor, Outliner, etc).
----
Based on [[this post|http://www.rtrowbridge.com/blog/2009/05/render-selected-meshes-region/]] by Ryan Trowbridge, I found some code I slightly changed to spit out the width and height in pixels of the active view. The rest of [[the module he wrote|http://www.rtrowbridge.com/rtRenderSelectedMeshesRegion.zip]] to render selected meshes is pretty sweet too.
{{{
import maya.OpenMaya as om
import maya.OpenMayaUI as omui

def getViewportResolution():
activeView = omui.M3dView.active3dView()

xPtrInit = om.MScriptUtil()
yPtrInit = om.MScriptUtil()
widthPtrInit = om.MScriptUtil()
heightPtrInit = om.MScriptUtil()

xPtr = xPtrInit.asUintPtr()
yPtr = yPtrInit.asUintPtr()
widthPtr = widthPtrInit.asUintPtr()
heightPtr = heightPtrInit.asUintPtr()

activeView.viewport(xPtr, yPtr, widthPtr, heightPtr)
viewWidth = widthPtrInit.getUint( widthPtr )
viewHeight = heightPtrInit.getUint( heightPtr )

return (viewWidth, viewHeight)

widthHeight = getViewportResolution()
print widthHeight
#(477, 269)
}}}

{{{
# Python code
import maya.cmds as mc

animCurve = 'myNode_translateX'
time = mc.keyframe(animCurve, query=True, timeChange=True)
vals = mc.keyframe(animCurve, query=True, valueChange=True)
timeValues = zip(time,vals)
print timeValues
# [(0.0, 0.0), (1.0, -0.82123691729992565)]
}}}
{{{
getAttr -type "persp.tx";
// doubleLinear //
getAttr -type "persp.rx";
// doubleAngle //
getAttr -type "persp.v";
// bool //
getAttr -type "persp.filmRollOrder";
// enum //
}}}
{{{
string $selAttr[] = channelBox -q -sma "mainChannelBox"; }}} *Note, you can query the inputs and outputs as well, with different arugments. {{{file}}} *Example: Based on some given filename$filename:
{{{
file -q -rpl $filename; }}}  {{{ # Python code import maya.cmds as mc import maya.mel as mm # cast mel variable to Python: gPlayBackSlider = mm.eval("$g = $gPlayBackSlider") # Is anything highlighted? rangeHighlighted = mc.timeControl(gPlayBackSlider, query=True, rangeVisible=True) # What is the highlight range? highlightedRange = mc.timeControl(gPlayBackSlider, query=True, rangeArray=True) print rangeHighlighted, highlightedRange # 1 [9.0, 17.0] }}} Given a selection, it's easy to change from one polygonal component type to another (via commands like {{{polyListComponentConversion}}}). But what if you just want to query what //type// of polygonal component is picked? I've not found any built-in commands that do this, so here is one solution: {{{ # Python code import maya.cmds as mc def getSelPolyComponentType(): """ Based on the selected polygonal components, return the type selected. If more than one type is selected, raise an exception. If no poly components are picked, return none. """ compTypes = [['.map', 'uv'], ['.vtx', 'vertex'], ['.e', 'edge'], ['.f', 'face'], ['.vtxFace', 'vertexFace']] sel = mc.ls(selection=True, flatten=True) compType = None for s in sel: for searchStr, result in compTypes: if searchStr in s: if not compType: compType = result else: if result != compType: raise Exception('More than one type of component selected') return compType }}} {{{ getPanel -vis; }}} Say the user has picked some anim curves in the Graph Editor... what are they? {{{ string$pickedKeys[] = keyframe -query -selected -name;
// Result: pCube2_rotateZ
}}}
{{{getModifiers}}}
{{{
int $mods = getModifiers; // note that it returns back "bit" values, so Shift: 1, CapsLock: 2, Ctrl: 4, and Alt: 8. }}} ---- Here's a modified version of what the docs have, in Python, showing how to grab multiple values at once via [[bitwise operators|http://wiki.python.org/moin/BitwiseOperators]] {{{ import maya.cmds as mc def PrintModifiers(): mods = mc.getModifiers() print 'Modifiers are:' if (mods & 1) > 0: print ' Shift' if (mods & 2) > 0: print ' CapsLock' if (mods & 4) > 0: print ' Ctrl' if (mods & 8) > 0: print ' Alt' print '\n' mc.window() mc.columnLayout() mc.button(label='Press Me', command=lambda *args:PrintModifiers() ) mc.showWindow() }}} {{{displayRGBColor}}} Basically, the stuff found in 'Window -> Settings/Preferences -> Color Settings' For example, to print a list of every possible UI element and their current values: {{{ displayRGBColor -list; }}} prints: {{{ template 0.47 0.47 0.47 preSelectHilite 1 0 0 userDefined1 0.63 0.41391 0.189 userDefined2 0.62118 0.63 0.189 userDefined3 0.4095 0.63 0.189 // etc... }}} To set the background color to black: {{{ displayRGBColor background 0.0 0.0 0.0; }}} It also lets you create new color presets as well.  The {{{upAxis}}} command. {{{ # Python code import maya.cmds as mc up = mc.upAxis(query=True, axis=True) # y }}} {{{MAYA_SCRIPT_PATH}}} is the environment variable in question. The below docs apply equaly well to {{{MAYA_PLUG_IN_PATH}}}. Additions are //usually// stored and updated in the {{{Maya.env}}} file like: {{{ MAYA_SCRIPT_PATH = c:\myScripts; }}} The {{{Maya.env}}} is usually stored per maya version: {{{ C:\Documents and Settings\<userName>\My Documents\maya\<version>\Maya.env }}} The {{{Maya.env}}} file is parsed when Maya launches, so any modifications to it require Maya to be restarted to be seen. Two examples below to add a new path to the current environment variable, //after// Maya has launched: !!!Python notes: The {{{maya.cmds}}} package doesn't include mel's {{{getenv}}} and {{{putenv}}}, however, Python's {{{os}}} module does contain similar functions ({{{os.getenv}}}, {{{os.putenv}}}). However, based on the below example, {{{os.putenv}}} doesn't actually do anything: It fails to update the path. However, by modifying the dictionary {{{os.environ}}} directly, we are able to make the change. {{{ import os newPath = r"c:\some\path\to\add" # Do this so we have a common base to compare against: comparePath = newPath.lower().replace("\\", '/') notInPath = True sysPath = os.getenv('MAYA_PLUG_IN_PATH') paths = sysPath.split(';') for path in paths: # Make the path we're comparing against the same format # as the one we're trying to add: compare = path.lower().replace("\\", '/').replace("//", '/') if comparePath == compare: notInPath = False break if notInPath: # Update our plugin path: newPath = '%s;%s'%(sysPath, newPath.replace("\\", "/")) #os.putenv('MAYA_PLUG_IN_PATH', newPath) # This doesn't work, interesting... os.environ['MAYA_PLUG_IN_PATH'] = newPath }}} !!!Mel notes: {{{ // Define our new path to add: string$newPath = "c:/temp";

// Get our path, and split into list:
string $msp = getenv "MAYA_SCRIPT_PATH"; string$pathList[];
tokenize $msp ";"$pathList;

// For comparison purposes, make all slashes forward, and add
// a slash to the end
$newPath = fromNativePath($newPath);
if(match "/$"$newPath != "/")
$newPath = ($newPath + "/");

int $found = 0; // Loop through all the paths, seeing if our path already exists: for($i=0;$i<size($pathList);$i++) { // Same comparison check from above: string$compare = fromNativePath($pathList[$i]);
if(match "/$"$compare != "/")
$compare = ($compare + "/");
if(tolower($newPath) == tolower($compare))
{
$found = 1; break; } } // If no new path was found, add: if(!$found)
{
// The *whole* path needs to be re-added:
// putenv seems to replace, not append.
$pathList[size($pathList)] = $newPath; string$fullPath = stringArrayToString($pathList, ";"); putenv "MAYA_SCRIPT_PATH"$fullPath;
print ("Added to MAYA_SCRIPT_PATH '" + $newPath + "'\n"); } else print ("path '" +$newPath + "' is already in the MAYA_SCRIPT_PATH\n");
}}}
To just query what dirs are currently in the path:
{{{
string $msp = getenv "MAYA_SCRIPT_PATH"; string$pathList[];
tokenize $msp ";"$pathList;
print $pathList; }}} Couple different ways: !!!A: *Pick a bunch of objects, with the target last. *Highlight a channel value and hit tab: It will copy that value to all the other selected objects. *Each time you hit tab, it will copy the next value. !!!B: *Pick a bunch of mesh *Pick the numeric values in the Channel Box *RMB on the values -> Duplicate Values There is any annoying feature in Maya that can cause the items highlited in the Graph editor to become de-highlighted... which means you loose all your curves from view. The below code will re-highlight all the objects in the outliner side of the Graph Editor, which will in-turn re-display all their curves: {{{ # Python code import maya.cmds as mc # Maya's standard graph editor outliner name: graphEdOutliner = 'graphEditor1OutlineEd' selectionConnection = mc.outlinerEditor(graphEdOutliner, query=True, selectionConnection=True) mainListConnection = mc.outlinerEditor(graphEdOutliner, query=True, mainListConnection=True) selectList = mc.selectionConnection(mainListConnection, query=True, object=True) if selectList: for so in selectList: mc.selectionConnection(selectionConnection, edit=True, select=so) }}} *Example: Make an evn var with the path to the file, then reference it in: {{{ // here we build the var in Maya, but it could be declared in Windows first: putenv "MAYAFILES" "c:/temp"; file -r -type "mayaAscii" -gl -namespace "TEST" -options "v=0" "$MAYAFILES/myFile.ma";
}}}
*From now on, the scene will look to $MAYAFILES as the directory for the file. If at any point you need to move the file, move it to the new location, and then update the$MAYAFILES enviroment variable. The Maya scene file will automatically look to the new location.
This implements what the "Reload" button on a file texture node does, but for all file nodes in the scene.
{{{
import maya.cmds as mc

print "\nRefreshing all textures in scene:"
files = mc.ls(type='file')
for f in files:
pth = mc.getAttr('%s.fileTextureName'%f)
mc.setAttr('%s.fileTextureName'%f, pth, type='string')
print "\tRefreshed:", f, " : ", pth
print "Texture refresh complete"
}}}
While this isn't mel code, it can be entirely recreated in mel:

There are some nodes in Maya, notably the lightLinker node, that can't be deleted from a scene file.  It's "special".  This is no real issue until, for whatever reason, they start to breed and fill your scene in the background.  I've seen scenes with hundreds of these nodes taking up unnecessary space.  How to get rid of them?  A fellow by the name of Ted Charlton use the below concepts in a script.  And they should work for any other kind of read-only node:

*Select the bad nodes, and "export them as a reference" from your scene as a new file:
{{{
File->Export Selected->Options->"Keep only a Reference" = yes.
}}}
*Then, remove that reference from your scene:File->Reference Editor...->
{{{
Select Reference File->Reference->Remove Reference
}}}
{{{
# Python code
import maya.cmds as mc

nameSpace = "myNamespace:";
mc.namespace(force=True, moveNamespace=[nameSpace, ":"])
mc.namespace(set=":")
mc.namespace(removeNamespace=nameSpace)
}}}
This code takes all nodes in the given namespace, 'moves' (renames) them to the root namespace, then deletes the old, empty namespace.
Based on unclean scene files, I often need to 'clean out' junk namespaces.  But the junk namespaces often have many, many child-namespaces, which can all have nodes living in them.

The below code first recursively searches through the namspace hierarchy of a given namspace.  Once it has that list, child namespace first, it tries to delete all node in each namespace, then finally delete the namespace itself presuming there were no references or read-only nodes in the namespace.
{{{
# Python code
import maya.cmds as mc

def namespaceClense(namespace):
"""
For the given namespace, and all child namespaces, delete all nodes and namespaces.

namespace : string : Starting namespace.

return : list : Any namespaces that weren't able to be deleted, usually due
to references, or special Maya undeletable nodes.
"""
if namespace.endswith(':'):
namespace = namespace[:len(namespace)-1]

# Get a list of all namespaces to delete data from.
namespaces = [namespace]
for n in namespaces:
mc.namespace(setNamespace=":")
mc.namespace(setNamespace=n)
childNs = mc.namespaceInfo(listOnlyNamespaces=True)
if childNs:
namespaces.extend(childNs)
mc.namespace(setNamespace=":")

# Delete stuff in our child namespaces first, then delete the child namespace:
namespaces.sort()
namespaces.reverse()

undeletedNamespaces = []
for n in namespaces:
# Get a list of everything in the given namespace:
allInNs = mc.ls('%s:*'%n, recursive=True, long=True)
# Put in hierarchy order, and reverse.  Needed for happy deleting, don't
# want to delete parents before kids, or code gets all confused.  And
# after doing tests, they delete 25% faster than not being reversed.
allInNs.sort()
allInNs.reverse()
for node in allInNs:
try:
mc.lockNode(node, lock=False)
mc.delete(node)
except:
pass
# Remove namespace if empty (it should be...)
try:
mc.namespace(removeNamespace=n)
except:
undeletedNamespaces.append(n)

return undeletedNamespaces
}}}
If you reference the same file into your scene multiple times, Maya will put it into a unique namespace each time (incrementing it with a #), plus put a file incrementor # at the end of its filepath in the Reference Editor.  Presuming this is your file:
{{{
c:/temp/foo.ma
}}}
and you referenced it in twice, you'd end up with these namespace \ filepath \ 'reference node name' combos:
{{{
foo | c:/temp/foo.ma | fooRN
foo1 | c:/temp/foo.ma{1} | fooRN1
}}}
(that's 'foo-one', not fool, like a court jester)
To remove a reference, based on those conditions, we jump though a few hoops:  The user supplies a namespace name.  That's turned into a {{{reference}}} node name (which by default is name of namespace + 'RN' + incrementor), from which the file path of that reference can be queried, and then removed.

In this example, we remove the reference in namespace {{{foo1}}}:
{{{
string $namespace = "foo1"; // foo + 'one' string$increment = match "[0-9]*$"$namespace;
string $refNode = substitute(($increment+"$"),$namespace, ("RN"+$increment)); string$refFile = referenceQuery -f $refNode; file -rr$refFile;
}}}
Making custom HUD's (heads up display) can be cool, but Maya doesn't seem to provide an easy way to kill them in the UI.  For example, you get someone else's scene file, full of HUD's you don't want to see.  What to do?
{{{
// get a list of all the hud's in the scene:
string $hud[] = headsUpDisplay -lh; // this is a list of all the default HUD's, retrieved from an empty scene with no custom HUD's (using the above command): string$defaultList = "HUDObjDetBackfaces HUDObjDetSmoothness HUDObjDetInstance HUDObjDetDispLayer HUDObjDetDistFromCam HUDObjDetNumSelObjs HUDPolyCountVerts HUDPolyCountEdges HUDPolyCountFaces HUDPolyCountTriangles HUDPolyCountUVs HUDSubdLevel HUDSubdMode HUDCameraNames HUDHQCameraNames HUDFrameRate HUDIKSolverState HUDCurrentCharacter HUDPlaybackSpeed HUDViewAxis HUDFrameCount";

// convert that string to an array:
string $defaultHud[]; tokenize$defaultList " " $defaultHud; // and for each item in the array of all HUD's in the scene, see if there is a default match. If not, kill: for($i=0;$i<size($hud);$i++) // print$defaultHud[$i] { if(stringArrayCount$hud[$i]$defaultHud == 0)
{
headsUpDisplay -rem $hud[$i];
print ("deleted non-default HUD: " + $hud[$i] + "\n");
}
}
}}}
When you skin mesh to joints, there is an an option to 'colorize skeleton'.  But what if you want to turn this //off// after the initial bind?  Or if you want to change the individual colors after the fact?

In the UI, the colors are controlled by the 'Display->Wireframe Color...' UI.  In that UI, you can bonk the "Default" button to reset the color.
All this really does is call to the {{{color}}} command:
{{{
color;
}}}
Which with no args sets the default color on the selected objects.
{{{strip}}}
*Example:
{{{
string $word = "asdf\r\n"; int$size = size($word) \\ result: 6$word = strip($word);$size = size($word); \\ result: 4 }}} I'll often have a selection of nodes that I want to have renamed to have concequetive postfix numbers on the end. Say I have a list of nodes like: *foo *foo23 *foo16 *foo1 I want to rename it so that in the same node order their names are: *foo1 *foo2 *foo3 *foo4 ---- A version using ~PyMel, with padding as well: {{{ import pymel.core as pm def renamePadded(padding=4, startNum=1): """ Based on selection, rename all nodes to match the first, incrementing numbers on the end starting with startNum """ sel = pm.ls(selection=True) rootName = sel[0].stripNum().split("|")[-1] pm.undoInfo(openChunk=True) try: for j,item in enumerate(sel): i = j+startNum padStr = "%0"+str(padding)+"d" execStr = 'name = "%s'+padStr+'"%("'+rootName+'",'+str(i)+')' exec execStr item.rename(name) finally: pm.undoInfo(closeChunk=True) renamePadded() }}} ---- Python It's pretty easy using Python's {{{enumerate}}} class and {{{re}}} module: {{{ # Python code # Rename the selected objects to have incremented postfix values. # If any numric postfix exists, remove it and add the new one. import re import maya.cmds as mc startNum = 1 # Reverse our lists, so we rename things from child to parent, so that changing # a parents name won't confuse the childs name-path: sel = mc.ls(selection=True, long=True) sel.reverse() vals = range(startNum, len(sel)+startNum) vals.reverse() for i,s in enumerate(sel): leaf = s.split('|')[-1] try: # Find every occurrence of a number # starting at the end of the string: num = re.findall('[0-9]+$', leaf)[0]
crop = leaf[:-len(num)]
mc.rename(s, '%s%s'%(crop,vals[i]))
except IndexError:
mc.rename(s, '%s%s'%(leaf,vals[i]))
}}}
When it comes to rigging and tools, duplicate node names can be a real pain.  How can you easily rename all the node names in the scene that clash?
{{{
# Python code
import re
import maya.cmds as mc

newNames = []
fail = []

# Get two lists of all names in the scene that are duplicates.
# If there are any dupes, they'll have a pipe in their name:
dupes = [name for name in mc.ls() if "|" in name]
# Get another list with just the leaf names:
dupesLeaf = [name.split("|")[-1] for name in mc.ls() if "|" in name]

for i,e in enumerate(dupes):
# refresh our list of clashing names:
leafCompare = [name.split("|")[-1] for name in mc.ls() if "|" in name]
# if our current leaf node is in our clashing list, rename:
if dupesLeaf[i] in leafCompare:
# If nodes are referenced (etc) they can't be renamed
try:
endNum = re.findall('[0-9]+$', dupes[i]) try: name = dupesLeaf[i][:-len(endNum[0])]+"#" except IndexError: name = dupesLeaf[i]+"#" newName = mc.rename(dupes[i], name) newNames.append([dupes[i], newName]) except Exception, e: # Tell user the the node that was tried to be renamed, and why it failed. fail.append([dupes[i], str(e).strip()]) if len(fail): print "Some nodes couldn't be renamed:" for f in fail: print "\t"+" : ".join(f) if len(newNames): print "Nodes renamed:" for n in newNames: print "\t"+" : ".join(n) print "Rename complete: Renamed %s node(s), and had %s failures, see Script Editor for deatails." %(len(newNames), len(fail)), }}} To just print a list of all the dupe node names in the scene: {{{ # Python code import maya.cmds as mc dupeNodes = [name for name in mc.ls() if "|" in name] for d in dupeNodes: print d }}} See the command: {{{ glRender }}} For example, render the current sequence as defined by the Hardware Render Globals (presuming the Hardware Render Buffer Window is open): {{{ glRender -renderSequence hardwareRenderView; }}} '{{{hardwareRenderView}}}' is the default name of the {{{glRenderEditor}}} used to display the hardware view. Even though {{{glRenderEditor}}} appears to be a type of UI 'panel\editor' (like say, {{{modelEditor}}}), in the mel docs it's categorized under 'Rendering'. ---- Also see: *[[How can I open the Hardware Render Buffer Window?]] *[[How can I change my Render Settings?]] The.... [[reorder|http://download.autodesk.com/global/docs/maya2012/en_us/CommandsPython/reorder.html]] command.... {{{parent}}} {{{ // mel parent -s -r "shapeNode" "transformNode"; }}} Here's a function in Python that will do it, and clean up the leftover transform nodes: {{{ # Python code import maya.cmds as mc def parentShapes(): """ Select nodes in order: The last node picked will have all other shape nodes parented to it. Note: Should freeze transforms on all nodes before execution! """ sel = mc.ls(selection=True) if len(sel) < 2: raise Exception("Please select at least two objects with shape nodes") source = sel[-1] targets = sel[0:-1] for t in targets: shapes = mc.listRelatives(t, shapes=True) if shapes is not None: for s in shapes: mc.parent(s, source, shape=True, relative=True) mc.delete(t) mc.select(source) }}} ---- Also see: [[How can I parent the instance of a shape node from one object to another?]] For example, you've just created a sphere, and want to redo that action: {{{ repeatLast; }}} Would then execute: {{{ CreatePolygonSphere; polySphere -r 1 -sx 20 -sy 20 -ax 0 1 0 -tx 2 -ch 1; // Result: pSphere1 polySphere1 // }}} *Note, this appears to be an undocumented command, but can be accessed via: {{{ help repeatLast; }}} Also see: *[[How do I query what the last command entered was?]] {{{ // this is the name of the referenced scene you're replacing: string$refScene = "c:/temp/foo.ma";

// find the reference node for this file:
string $refNode = file -q -rfn$refScene;

// name of the scene to replace it with
string $newName = "c:/temp/goo.ma"; file -loadReference$refNode $newName; }}} If you're wondering, this was deduced by picking apart this script: {{{ ../MayaXXXX/scripts/others/referenceEditorPanel.mel }}} In particular, the procs {{{referenceEdRenameCB}}} and {{{findRefNodeToReplace}}}  * Maya has the built-in {{{substitute}}} command, but it only substitutes the //first// instance it encounters. Maya also has the {{{substituteAllString}}} //script//, but it never works like I'd expect. So because of that, we loop over the {{{substitute}}} command until our source no longer contains any of our matching elements. * For example, in our source data have all matching instances of "Happy" replaced with "Sad": {{{ string$source= "Happy Happy Joy Joy";
string $match = "Happy"; string$replace = "Sad";
while(match $match$source == $match)$source = substitute $match$source $replace; print ($source + "\n");
Sad Sad Joy Joy
}}}
Use Maya's {{{imconvert}}} executable outside of Maya, or from a system call:
*Example: Convert a texture to a new resolution of 800x600 at the commandline
{{{
imconvert -geometry 800x600 -filter Quadratic in.jpg out.jpg
}}}
----
Via the API:
{{{
# Python code
import maya.OpenMaya as om

imageFile = 'c:/temp/myImage.jpg'
reiszedImage = 'c:/temp/myImageResized.jpg'
mimage = om.MImage()
mimage.readFromFile(imageFile)
mimage.resize(360, 240, True)
mimage.writeToFile(reiszedImage, 'jpg')
}}}
[[MImage|http://download.autodesk.com/us/maya/2011help/API/class_m_image.html]] docs
{{{selectedNodes}}}
or
{{{ls -sl}}}

I've never actually seen anyone use {{{selectedNodes}}}
{{{rotate}}} \ {{{xform}}}
*Example: transformA has rotate order xyz, transformB has rotate order zyx:
{{{
float $rotationVals[] = xform -q -ws -ro transformA; xform -p 1 -roo xyz transformB; rotate -ws$rotationVals[0] $rotationVals[1]$rotationVals[2] transformB;
xform -p 1 -roo zyx transformB;
}}}
{{{rotate}}} \ {{{xform}}}
*Example: Find the worldspace rotation of one object, and assign it to another. Either of these objects can be children of a hierarchy:
{{{
float $rotationVals[] = xform -q -ws -ro transformA; rotate -ws$rotationVals[0] $rotationVals[1]$rotationVals[2] transformB;
}}}
*This will open in a new command prompt:
{{{
>> maya -prompt
}}}
*This will run in the same command prompt as it was executed in:
{{{
>> mayaBatch -prompt
}}}


{{{system}}}
*Example, open notepad:
{{{
system ("start notepad");
}}}
*You don't have to use "start", but if you don't, as long as the system function is running, you'll be locked out of using Maya.
Had an animator approach me with a problem:  He wanted a tool that would look at ALL the keyframes in the scene, and based on a user-defined start and end range, scale all the keys in the range, and offset all the keys after the range based on the scale value.

The code example does that.  It will also insert keys (maintaining curve shape) on all objects at the oldRange frames, to do proper scaling
{{{
#Python code
import maya.cmds as mc

# define the old and new range:
oldRange = [5, 10]
newRange = [5, 20]

# figure out how much to offset keys after the oldRange
offset = newRange[1] - oldRange[1]

# stamp down keys based on oldRange
curves = mc.ls(type="animCurve")
mc.select(curves, replace=True)
mc.setKeyframe(insert=True, time=oldRange)

# move all keys after the end of the oldRange
mc.selectKey(time=(str(oldRange[1]+1)+':',))
mc.keyframe(edit=True, relative=True, timeChange=offset)

# now scale all keys in the oldRange to match the newRange
mc.select(curves, replace=True)
mc.selectKey(time=(str(oldRange[0])+":"+str(oldRange[1]),))
mc.scaleKey(curves,
time=(oldRange[0],oldRange[1]),
newStartTime=newRange[0],
newEndTime=newRange[1])
}}}
This is actually all Python code, but since it has to do with Maya, I'll include it here ;)
I've read that using the {{{mmap.mmap}}} object is faster than converting a file to a string for searching:  Based on experimentation, this appears to be true.

Sometimes I'll need to search a whole tree of Maya files (ascii files) for certain data. Sometimes that data is as simple as a short string.   This method is way faster than batching the files in Maya one by one and running commands to find the results.
For example, I want to find which Maya files have a joint named "FOO" in them, in my tree:
{{{
import os
import mmap

startDir = r"C:\path\to\my\files"
searchString = "FOO"

print "Starting Search:"
# Get a list of all the ma files under the root dir:
files = []
for dirpath, dirnames, filenames in os.walk(startDir):
for fil in [f for f in filenames if f.endswith(".ma")]:
fpath = "%s/%s"%(dirpath, fil)
files.append(fpath)
# I split this into a separate loop,
# so I can print the above results before the processing starts.

found = []
for fpath in files:
with open(fpath) as f:
s = mmap.mmap(f.fileno(), 0, access=mmap.ACCESS_READ)
if s.find(searchString) != -1:
found.append(fpath)
for f in found:
print f
print "Search Done"
}}}


{{{nurbsSelect}}}
Recently had to write a tool that would select all mesh bound to the same hierarchy:  Say you have a human character made out of multiple meshes.  The tool would allow the user to pick a a single mesh (or multiple meshes) and the tool would select all other mesh skinned to the same hierarchy:
{{{
# Python code
import maya.cmds as mc

# Get out selected mesh
sel = mc.ls(selection=True, long=True)

# Get all joint influences on selected:
allInfs = []
for s in sel:
infs = mc.skinCluster(s, query=True, influence=True)
for i in infs:
if i not in allInfs:
longName = mc.ls(i, long=True)[0]
allInfs.append(longName)

# Find all the unique root joints:
roots = []
for ai in allInfs:
foundRoot = False
split = ai.split('|')
# Remove empty leading strings:
split = [s for s in split if s]
if not foundRoot:
for i,e in enumerate(split):
node = '|'.join(split[0:i+1])
if mc.objectType(node) == 'joint':
if node not in roots:
roots.append(node)
foundRoot = True
break
else:
break

# Find the complete hierarchy tree under our roots:
allJoints = mc.listRelatives(roots, allDescendents=True, type='joint')

# Find all skinCluster nodes these joints influence:
skinClusters = []
for ai in allJoints:
sc = mc.listConnections(ai, source=False, destination=True, type='skinCluster')
if sc:
sc = list(set(sc))
for c in sc:
if c not in skinClusters:
skinClusters.append(c)

# Find all the mesh shape nodes touching our skinClusters:
mesh = []
for sc in skinClusters:
geo = mc.skinCluster(sc, query=True, geometry=True)
for g in geo:
if g not in mesh:
mesh.append(g)

# Get all shape transform nodes:
transforms = []
for m in mesh:
parent = mc.listRelatives(m, parent=True)[0]
transforms.append(parent)

# Select!
mc.select(transforms)
}}}
{{{
import maya.cmds as mc

def getInfluences(sel=None):
"""
Return influences for the selected mesh.  If mesh names are passed in instead,
use them instead of selection.
"""
if not sel:
sel = mc.ls(selection=True)
else:
if type(sel) is not type ([]):
sel = [sel]
if not len(sel):
raise Exception("Please select a node, or pass in a list of nodes")
mesh = mc.listRelatives(sel, shapes=True, noIntermediate=True)
skinClusters = mc.listConnections(mesh, source=True, destination=False, type='skinCluster')
influences = []
if skinClusters:
for sc in skinClusters:
connections = mc.listConnections('%s.matrix'%sc)
if connections:
influences.extend(connections)

influences = sorted(list(set(influences)))
return influences
}}}
{{{
infs = getInfluences()
if len(infs):
for i in infs:
print i
mc.select(infs)
}}}
In Maya's prefs, under Settings -> Timeline, there are options to set the 'Playback Speed' and 'Max Playback Speed'.  My maya had a habit of forgetting this stuff.  I wanted it to play every frame of the animation, but lock it to 30fps.

There are two steps to this:  Update {{{optionVars}}} so the settings will persist between Maya sessions, and updating the values for the current Maya session.  I figured out the optionVars by hunting around my {{{userPrefs.mel}}} file.
I added the below code to my {{{userSetup.mel}}} file:
{{{
optionVar -fv "timeSliderPlaySpeed" 0;
optionVar -fv "timeSliderMaxPlaySpeed" 1;
playbackOptions -playbackSpeed 0;
playbackOptions -maxPlaybackSpeed 1;
}}}
As you can see, you're not setting the actual framerate values:  The values are indexed, so you need to choose the correct index for the option that you're after.  The Prefs UI drop-downs show you the options you can choose from.
{{{
windowPref -w # -h # windowName;
}}}
*Note: This should be entered after the "window" command when making the UI.
Presuming that the joints the mesh are bound to have nothing connected to their transform values, this code should work:
{{{
string $dagPose[] = ls -type "dagPose"; for($i=0;$i<size($dagPose);$i++){ select -r$dagPose[$i]; dagPose -restore; } }}} ---- While I haven't tested it yet, I saw this post to help rest the bind pose after changes have been made to the asset: 1) Select the root joint of the skel, and save out your "bind pose": {{{ select -hierarchy; dagPose -save -selection -name mypose; }}} 2) Later, if any changes have happened to the asset, you can go back to that bind pose: {{{ dagPose -restore mypose; }}} ---- Also see: *[[How can I set the selected meshes to their bind pose?]] *Open the ''UV Texture Editor'' *Image -> Use Image Ratio -> Check ON By default, the UV 0->1 range is a square. But what if your texture is 2:1 (landscape), and you want to see the UV's in the same landscape aspect ratio, rather than a square? Use the above option, and the UV Texture Editor will scale its grid so that the aspect-ratio of the UV's matches that of the texture. The mel command is: {{{ polyNormalPerVertex }}} However, it only works on one vert at a time. Furthermore, if you call to it a lot (if working on a thousand normals, you'll call to it a thousand times), it can really slow down Maya, and eat up all your memory (based on some tests, nearly a meg per call, that's crazy!). Here's a way you can query the normals on the selected items, and then set them again based on the stored values. It works by directly accessing the normal attributes on the polygonal mesh, rather than using the {{{polyNormalPerVertex}}} command at all. {{{ // pick a polygonal object, or pick some components. Then define them: string$sel[] = ls -sl;

// convert everything to vertex-faces
select -r polyListComponentConversion "-tvf" $sel; string$vertFaces[] =  ls -fl -sl;

// define our list that we'll later fill with all of our normal info:
string $cmdList[]; clear$cmdList;

// for each vertex face, store a command that will reapply it's normal values later.
for($i=0;$i<size($vertFaces);$i++)
{
// find the shape node of this object:
string $buffer[]; tokenize$vertFaces[$i] ".[]"$buffer;
string $shape =$buffer[0];
// get the face and vert ID's
int $face =$buffer[size($buffer)-1]; int$vert = $buffer[size($buffer)-2];
// Get the normal value for this particualr vertex-face.  We actually use polyNormalPerVertex here
// because, if we query the vert normal with getAttr (using a syntax similar to the below $cmdLis) // it always returns back these values for all three xyz vert face normals: 100000002004087730000 // The mesh docs say that these attrs have a default value of 1e20, hmm..... // However, once they've been set by the user using the setAttr command, you CAN use getAttr on // them to pull the correct vals. So weird! vector$normalVec = polyNormalPerVertex -q -xyz $vertFaces[$i];
// and build the command to later re-set these values:
$cmdList[$i] = ("setAttr " + $shape + ".npvx.vn[" +$vert + "].vfnl[" + $face +"].fnxy " + ($normalVec.x) + " " + ($normalVec.y) + " " + ($normalVec.z) +";");
}
}}}
Print our findings:
{{{
print $cmdList; }}} Now, go to your objects, and screw up all their normals. Then re-set all the normals to the stored values: {{{ for($i=0;$i<size($cmdList);$i++) eval($cmdList[$i]); }}} After you run this, the normals should be set back again. Minimal memory usage, and much faster than calling to {{{polyNormalPerVertex}}} mutiple times. {{{ # Python code import maya.cmds as mc animCurves = mc.ls(type='animCurve') first = mc.findKeyframe(animCurves, which='first') last = mc.findKeyframe(animCurves, which='last') mc.playbackOptions(min=first, max=last) }}} {{{ selectKey -time ":"; float$allKeys[] = sort(keyframe -q -sl);
playbackOptions -min $allKeys[0] -max$allKeys[(size($allKeys) -1)]; }}} ---- Also see: *[[How can I find the min and max keyframe values for all objects in the scene?]] *[[How can I find the min and max keyframe range for the provided objects?]] Around Maya 2008 (maybe a version or so before?) when you smooth bound a mesh, there was a new option called "Allow Multiple bind poses". This is supposed to bring some functionality benefits, but it also breaks some of Maya's own tools: Notably, if a skeleton is bound to more than one mesh with this option, it will create a bind pose {{{(dagPose}}} node) for each mesh. But Maya's own UI command {{{Skin -> Go To Bind Pose}}} is expecting only a //single// bind pose... and it will fail. Furthermore, Maya expects a mesh to be picked when using its tool. But often I want to pick a joint instead. The below code addresses both: It will track down the {{{dagPose}}} node(s) for each selected mesh\joint, and 'restore' them to their bind pose: {{{ # Python code import maya.cmds as mc # Get a list of everything selected # It is expecting bound mesh\joints or a combination of the two... sel = mc.ls(selection=True) dagPose = [] for s in sel: if mc.objectType(s) == 'joint': # If joints are picked: poses = list(set(mc.listConnections(s, source=False, destination=True, type='dagPose'))) dagPose.extend(poses) else: # If mesh is picked, find their shape nodes: shapes = mc.listRelatives(sel, shapes=True, noIntermediate=True) # get all incoming skinClusters connected to the shapes skinCluster = mc.listConnections(shapes, source=True, destination=False, type="skinCluster") # get all incoming dagPoses connected to the skinClusters. Remove duplicates via 'set' poses = set(mc.listConnections(skinCluster , source=True, destination=False, type="dagPose")) dagPose.extend(poses) # remove any dupes: dagPose = list(set(dagPose)) # 'restore' each dagPose: for d in dagPose: mc.dagPose(d, restore=True) print "Bind Pose restored on these nodes: " + ", ".join(sorted(dagPose)) }}} There's no error detection here, so if you don't have anything picked it will error, or if there are unbound meshes it will error, but it's a start ;) ---- Also see: *[[How can I set all meshs in the scene to their bind pose?]] !!!Via the HUD: This is modified copy of the mel proc {{{setCurrentFrameVisibility()}}} living in {{{initHUDScripts.mel}}}, that simply forces it on: {{{ # Python code import maya.cmds as mc def setFrameCounterOn(): if mc.headsUpDisplay('HUDCurrentFrame', exists=True): mc.headsUpDisplay('HUDCurrentFrame', edit=True, visible=True) mc.menuItem('currentFrameItem', edit=True, checkBox=True) mc.optionVar(intValue=["currentFrameVisibility", 1]) }}} I started to write some code for this and... there's already a command: [[snapKey|http://download.autodesk.com/global/docs/maya2014/en_us/CommandsPython/snapKey.html]] In mel, when copying or pasting all keframes, the syntax is pretty simple (replace {{{...}}} with the rest of the command code): {{{ cutKey -time ":" ... ; }}} And even the Python command docs say this: >{{{-time ":"}}} is a short form to specify all keys. But that's not how the Python formatting actually works. Per Maya Docs -> User Guide -> General -> Python -> Using Python -> Ranges -> You need to specify the time settings in this format: {{{ mc.cutKey(time=(":",), ...) }}}  I first noticed this in Maya 2008. I'm not yet sure if the below solution fixes it for 2008, I'm told it does for 2009. If you have an Nvidia GeForce card, this may do the trick. Set this in your {{{Maya.env}}} file {{{ MAYA_GEFORCE_SKIP_OVERLAY = 1 }}} Found the info on this page (lots of other maya.env stuff in there): http://www.toxik.sk/?p=22  {{{optionVar}}} *Example: {{{ optionVar -iv "myVariable" 4; // Result: 4 // }}} ** After Maya has been restarted, you can query that {{{optionVar}}}. This is how Maya does it's bulk of preset saving. There is the {{{stringToStringArray}}} command, but this only works if you have a 'separation character': Meaning, it works good on string like this: {{{ string$line = "my words";
string $array[] = stringToStringArray$line " ";
print $array; // my // words }}} However, {{{stringToStringArray}}} //won't// work if there is no separation character. So how can you convert a string to a string array without using that command? {{{ string$line = "asdf";
string $array[]; for($i=0;$i<size($matcher);$i++)$array[$i] = substring$matcher ($i+1) ($i+1);
print $array; // a // s // d // f }}} Sometimes the modelers get the left\right sides of an asset switched. This code will swap all _L_ & _R_ characters on all transform node names in the scene. Code takes advantage of ~PyMel's ~PyNode type: Even though the string names change, nodes are still easy to access independent from them. {{{ import pymel.core as pm allTf = pm.ls(type='transform') oldL = [] oldR = [] for tf in allTf: if '_L_' in tf.nodeName(): oldL.append(tf) elif '_R_' in tf.nodeName(): oldR.append(tf) pm.undoInfo(openChunk=True) try: # Rename L to R, but add an underscore to avoid possible name clash for l in oldL: l.rename('_%s'%l.nodeName().replace("_L_", "_R_")) # Rename R to L for r in oldR: r.rename(r.nodeName().replace("_R_", "_L_")) # Remove underscores: for ol in oldL: ol.rename(ol.nodeName()[1:]) finally: pm.undoInfo(closeChunk=True) }}} {{{ctxEditMode}}} or {{{EnterEditMode}}} *Notes: {{{ctxEditMode}}} is the actual command. {{{EnterEditMode}}} is actually a runTimeCommand that simply calls {{{ctxEditMode}}}. They both act as toggles. Fairly easy to check over the trans\rot\scale values queried using ~PyMel: {{{ import pymel.core as pm def isFrozen(target): """ Returns True if the target node is frozen (trans and rot all 0, scale all 1), False otherwise. """ target = pm.PyNode(target) transRot = target.translate.get() + target.rotate.get() scales = target.scale.get() # Handle floating point errors: tol = 0.000001 badTransRot = filter(lambda x: x < -tol or x > tol, transRot) badScale = filter(lambda x: x < 1-tol or x > 1+tol, scales) return not(any(badScale+badTransRot)) }}} {{{setFocus}}} *Note: Maya's four main modelPanels are called "modelPanel1" - 4. {{{timer}}} {{{timerX}}} Python: {{{ import maya.cmds as mc modelPanel = mc.playblast(activeEditor=True) value = not mc.modelEditor(modelPanel, query=True, jointXray=True) mc.modelEditor(modelPanel, edit=True, jointXray=value) }}} Mel: {{{ string$modelPanel = playblast -activeEditor;
int $state = modelEditor -q -jointXray$modelPanel;
int $value = abs(1-$state);
modelEditor -edit -jointXray $value$modelPanel;
}}}
Animator requested a way that they could have a hotkey that would toggle on and off the {{{TimeDragger}}} context.  Said context allows the user to scrub the timeline by clicking the mouse anywhere on the screen.
{{{
global proc toggleTimeDragger(){
global string $gPrevCtx; string$currentCtx = currentCtx;
if($currentCtx != "TimeDragger"){ setToolTo TimeDragger;$gPrevCtx = $currentCtx; } else{ setToolTo$gPrevCtx;
}
}
toggleTimeDragger();
}}}
Put that whole sucker in a hotkey, and you're good to go.
A couple different solutions I've come up with:
!!!{{{autoPlace}}} running in a Python Thread:
The {{{autoPlace}}} command can return the mouse's current ''3d worldspace position'' (always in cm).  If you execute that in a thread in Maya, it can execute constantly in the scene in the background, reporting the position, and executing any other code you need at the same time.
{{{
# loopMousePos.py

import threading

import maya.cmds as mc
import maya.utils as mu

running = False

def mouseEvent(*args):
"""
The code to evaluate in the thread.  In this case, it prints the mouse position.
"""
# This is printing cm values no matter your working unit.  You may need to
# do some conversion...
print mc.autoPlace(useMouse=True)

def looper(*args):
"""
Wrapper for the code that should be evaluated:  This code evaulates in the
Python thread, but it executes the results in Maya.
"""
while True:
# When running in a Python Thread, If you don't evaluate you Maya code
# via this function, Maya *will* crash...
mu.executeInMainThreadWithResult(mouseEvent)

def main():
"""
Create and start the Python Thread.  Main point of execution.
"""
global running
if not running:
threading.Thread(target=looper).start()
running = True
}}}
!!!Query a {{{draggerContext}}}'s 'dragPoint':
You can create a custom {{{draggerContext}}} so that when you enter it and ~LMB-drag around the view, it will print the ''2d screen-space'' position of the mouse, and execute any other code you need:
{{{
# mousePosCtx.py

import maya.cmds as mc

CTX = 'mousePosCtx'

def mousePosDragFunc(*args):
"""
Function called on drag.
"""
dragPosition = mc.draggerContext(CTX, query=True, dragPoint=True)
print dragPosition

def main():
"""
Create and enter the conext.
"""
if mc.contextInfo(CTX, query=True, exists=True):
mc.deleteUI(CTX, toolContext=True)

# Make the context:
mc.draggerContext(CTX, cursor='hand', space='screen', dragCommand=mousePosDragFunc,
projection='viewPlane');

# Set the tool to the context
# Results can be observed by dragging mouse around main window
mc.setToolTo(CTX)
}}}
Starting in Maya 2012, you can use the [[transferShadingSets|http://download.autodesk.com/global/docs/maya2012/en_us/Commands/transferShadingSets.html]] command.  See docs for an example.

There is no {{{scriptJob}}} event for 'scene save' detection, so how can you author your own events to trigger when saving the scene?  Two ways I've found, via the API, and via script overriding:
!!!API:
Via the {{{OpenMaya}}} API's {{{MSceneMessage}}} object, you can build many different kinds of callbacks for various events, including file open, close, save, etc.  Find notes on how to set his up here:
[[API: How can I author callbacks for Maya events?]]
!!!Overriding the menu commands:
You can override the behavior of the //menu// 'File -> Save Scene' pretty easily.  This also works for 'File -> Save Scene [options]'.  However, I highly recomend using the API version above, since its non-destructive.

That menu item executes a {{{runTimeCommand}}} called {{{SaveScene}}} which calls to these procedures:
{{{
// SaveScene runTimeCommand
checkForUnknownNodes();
FileMenu_SaveItem;
}}}
You can override that {{{runTimeCommand}}} with your own global proc pretty easily:
{{{
global proc SaveScene()
{
print "Put code here to execute before save.\n";
checkForUnknownNodes();
FileMenu_SaveItem;
print "Put code here to execute after save.\n";
}
}}}
When you then execute File -> Save, you'll see something like this:
{{{
Put code here to execute before save.
file -save;
// Result: C:/Users/epavey/Documents/maya2010goo/badSetTest.ma //
Put code here to execute after save.
}}}
----
'File -> Save Scene As' (and 'Save Scene As [options]') has a similar {{{runTimeCommand}}} you can override called {{{SaveSceneAs}}}
{{{
checkForUnknownNodes();
projectViewer SaveAs;
}}}
Overriding it is just as easy:
{{{
global proc SaveSceneAs()
{
print "Put code here to execute before save-as.\n";
checkForUnknownNodes();
projectViewer SaveAs;
print "Put code here to execute after save-as.\n";
}
}}}
Simple example of reading in a text file to Maya, and turning its results into a string array.  There is no error checking here:  You'd want to first confirm that the file actually exists on disk before you try and open it
In the process it will strip off any return chars.
{{{
global proc string[] returnFileAsArray(string $filePath){ int$fid = fopen $filePath "r"; string$lines[] = {};
string $line = fgetline$fid;
$lines[0] = strip($line);
while ( size($line) > 0 ){$line = fgetline $fid;$lines[size($lines)] = strip($line);
}
fclose $fid; return$lines;
}
}}}
Also see:
*[[How can I write text to my own file?]]
Often times when engaging in such activities as baking animation curves, you can speed up Maya's performance by replacing the current 3d view ({{{modelPanel}}}) with a non-refreshing item, like the Outliner.  However, there is a way to get even better performance, which is via the {{{refresh}}} command.

Here we'll run a {{{bakeResults}}} over 30 frames, but not update any 3d view in the process:
{{{
import maya.cmds as mc

mc.refresh(suspend=True)
mc.bakeResults(simulation=True, time=(1,30))
mc.refresh(suspend=False)
}}}
Docs [[here|http://download.autodesk.com/global/docs/maya2012/en_us/CommandsPython/refresh.html]]
Some notes from the docs:
<<<
Use this flag ({{{suspend}}}) with caution: although it provides opportunities to enhance performance, much of Maya's dependency graph evaluation in interactive mode is refresh driven, thus use of this flag may lead to slight solve differences when you have a complex dependency graph with interrelations.
<<<
Running a timer on a simple example showed a 3x speedup in evaluation time.
The {{{ikSystem}}} node
*Useful for moving joints around without the IK getting in the way during rig reproportioning.
{{{
setAttr "ikSystem.globalSolve" 0;
}}}
You can turn off the shaded wireframe highlighting via:
{{{
displayPref -wireframeOnShadedActive "off";
}}}
And turn it back on via:
{{{
displayPref -wireframeOnShadedActive "full";
}}}
[[displayPref docs|http://download.autodesk.com/global/docs/maya2014/en_us/CommandsPython/displayPref.html]]
{{{help}}}
I always like having them on, and I find that some code actually turns them off.
{{{
help -popupMode true;
help -popupDisplayTime 10;
}}}

You can ADD tooltips to (nearly) any UI element with their {{{-annotation}}} ({{{-ann}}}) flag.
Here's an example of how you can embed this into a UI for a user, so it's obvious that they can turn them on:
{{{
window -mb 1 -mbv 1;
menu -l "Turn on tooltips";
menuItem -l "Turn On" -c "help -popupMode true; help -popupDisplayTime 10; print \"Tooltips turned on\"";
columnLayout -adj 1;
button -l "Mouse over me" -ann "This is a tooltip";
showWindow;
}}}
In more recent versions of Maya, they've given joints 'displayable labels'.  Maya has a bunch of preset labels, but I tend to prefer my own naming conventions, based on the names of the actual joints.  The below code will turn on the joint lables for all joints in the selected hierarchy, and set the label name to the joint name:
{{{
# python code
import maya.cmds as mc

def enableJointNames(onOff=1):
root = mc.ls(selection=True)[0]
hier = mc.listRelatives(root, allDescendents=True, type='joint')
hier.append(root)
for joint in hier:
mc.setAttr(joint+".drawLabel", onOff)
mc.setAttr(joint+".type", 18)
mc.setAttr(joint+".otherType", joint, type='string')

# to turn on labels, pick the root joint and execute:
enableJointNames()
# to turn off labels, pick the root joint and execute:
enableJointNames(0)
}}}
There is a Maya startup script located here:
{{{
C:/Program Files/Autodesk/Maya<version>/scripts/startup/initHUDScripts.mel
}}}
That is filled with procedures to do this.  Check the script for the particulars, but here are some that can be used:
{{{
setObjectDetailsVisibility(int $visibility) setPolyCountVisibility(int$visibility)
setSubdDetailsVisibility(int $visibility) setCameraNamesVisibility(int$visibility)
setFrameRateVisibility(int $visibility) setCurrentFrameVisibility(int$visibility)
setViewAxisVisibility(int $visibility) // this list goes on... }}} Based on what you have picked, the below code will unload the reference (not remove it, just unload it). Note that it also attempts to check for the parent reference if one exists: If you have multiple levels of referencing, it's possible the selection is one of those sub-levels, so you need to search 'up' to find the parental reference to remove. {{{ string$sel[] = ls -sl;
string $fname = referenceQuery -f$sel[0];
string $refNode = referenceQuery -referenceNode$fname;
string $pRef = referenceQuery -referenceNode -parent$refNode;
file -unloadReference $pRef; }}} Example: Embed a link to this wiki into Maya's Help menu: {{{ menuItem -p$gMainHelpMenu
-l "MEL Wiki" -ann "Your Maya Mel Resource on the Web "
-ecr false -c "showHelp -a \"http://mayamel.tiddlyspot.com/\"";
}}}
All of Maya's main menu's have their names defined in global string arrays.
----
Also see:
*[[How can I find the names of Maya's main UI menus?]]
*[[How can I append a custom sub-menu to one of Maya's main menus?]]
You need to update the {{{XBMLANGPATH}}} environment variable.  This is like {{{MAYA_SCRIPT_PATH}}}, but for icons used for such things as shelf buttons.
{{{
import os
os.environ["XBMLANGPATH"] = "%s;%s"%(os.getenv("XBMLANGPATH"), "c:/some/icon/path/")
}}}
Condensed from the Maya docs:

Method #1: ''userSetup.py''
*Create a {{{userSetup.py}}} module here: (Windows)
{{{
<drive>:\Documents and Settings\<username>\My Documents\maya\<Version>\scripts\userSetup.py
}}}
*Append to {{{sys.path}}} in your {{{userSetup.py}}}:
{{{
import sys
sys.path.append('c:/myPy/maya/scripts')
}}}
Method #2: ''PYTHONPATH''
*Set {{{PYTHONPATH}}} in your {{{Maya.env}}} file, OR as a Windows environment variable:
{{{
PYTHONPATH = c:/myPy/maya/scripts;
}}}
**I've heard that if you have it defined both in your Windows path //and// in the {{{Maya.env}}} file, the Windows one will override the {{{Maya.env}}}, so be aware.
----
Two other important things:
*Make sure your paths //don't// have a slash at the end.  This seems to dissuade Python from recognizing what's //in// the path.
*Don't add any python modules to the default Maya script paths that live under {{{..\My Documents\Maya\scripts}}} or {{{..\My Documents\Maya\<version>\scripts}}}.  Even though, as an exception, the ''{{{userSetup.py}}}'' module //can// live in there (see above), __no other python module can__.  Maya 'just won't see it'.  Very... odd...
Also, be sure to check out how Python ''packages'' work.  See my notes over on my [[Python Wiki|http://pythonwiki.tiddlyspot.com/#Packages]]
!!!Old Bad Way:
Edit the Maya script: {{{\Maya20XX\scripts\others\dagMenuProc.mel       }}}Yuck.
In the procedure {{{dagMenuProc()}}}, '{{{string $shortName}}}' is the name of the object under the curser, which you can then write an "if" statement for allowing you to run other procedures based on that name. !!!New Good Way: With some help from the undocumented {{{dagObjectHit}}} command, and [[this great forum post|http://tech-artists.org/forum/showthread.php?t=419]] (authored way back in 2008). Big kudo's to ''Roger Klado'' for figuring this stuff out and posting about it! I took the guts of what was in that post, modified and re-authored it in Python, with a lot of descriptive text explaining what's going on: When you run the below code, when you ''Alt''+RMB on a node, a custom {{{popupMenu}}} will be created displaying the name of the node. Plus, if you have a component highlighted, it will add an item for that component name. What's going on? *{{{makePopup()}}} creates a {{{popupMenu}}} that will execute when something is Alt+~RMB-clicked. *It in turn has a '{{{postMenuCommand}}}' parameter that executes the {{{postMenuCommand()}}} function each time the {{{popupMenu}}} is created and made visible. *The {{{postMenuCommand()}}} function is what physically builds the new custom {{{popupMenu}}}. However, to //start// this process, it actually calls the {{{overrideDagMenuProc()}}} function: **Via trickery with the (undocumented) {{{dagObjectHit}}} //command//, it (behind the scenes) uses the //mel procedure// {{{dagMenuProc()}}} to re-create that menuing system, //inside our new menu//. This has the advantage of including the object name as the first item in the menu, which is the data we care about. **That menu is completely cleared of all items (since we want to build our own menu), and the object name is returned back to {{{postMenuCommand()}}}. *{{{postMenuCommand()}}} can then start re-building the empty menu with whatever you want, based on the name of the object Alt+RMB'd on. **In the example below, it generates a {{{menuItem}}} with the object name Alt+RMB'd on, and if any component level items were highlighted, will make another {{{menuItem}}} for the one under the cursor. {{{ # Python code import maya.cmds as mc # The name to give our custom, context-sensitive, Alt+RMB popupMenu: POP_NAME = 'myCustomPopupMenu' def overrideDagMenuProc(): """ This function will override the RMB-menu created by dagMenuProc(). It returns the name of the object Alt+RMB'd on: """ # This creates a new menu, for the object Alt+RMB'd on, populated with the # guts of what dagMenuProc() would normally build: mc.dagObjectHit(menu=POP_NAME) # Get a list of all the children in that menu: popChildren = mc.popupMenu(POP_NAME, query=True, itemArray=True) # The menu item's name is the leaf name of the node: If there are duplicate # names in the scene, this is always the leaf. To get the full path, we # need to query the select command embedded in the menuItem: command = mc.menuItem(popChildren[0], query=True, command=True) fullName = command.split(' ')[-1] # Now delete the menu items created by dagMenuProc(), giving us an empty menu: mc.popupMenu(POP_NAME, edit=True, deleteAllItems=True) # Finally return the name of our node, which will be used by postMenuCommand # to build the top label in the empty menu: return fullName def postMenuCommand(*args): """ This function is passed to, and executed by the menu created via makePopup() whenever the popupMenu is shown. It's what you'd update to have custom menu items appear based on what's selected. """ # Delete all the items from any pre-existing menus: if mc.popupMenu(POP_NAME, exists=True): mc.popupMenu(POP_NAME, edit=True, deleteAllItems=True) # Make our menu the current menu for any new children: mc.setParent(POP_NAME, menu=True) if mc.dagObjectHit(): # undocumented command! # If the user has Alt+RMB'd over a node, capture the return of the # function that overrides the dagMenuProc's popupMenu. The return is # the full name of the node that has been Alt+RMB'd over... and use it as # the label for the menu. Extract the leaf name from the full path: fullObjectName = eval('overrideDagMenuProc()') leafObjectName = fullObjectName.split("|")[-1] mc.menuItem(label=leafObjectName) # Here, any custom code can be authored that is based on the object name # For example, track if there are any highlighted components: componentPreSelect = mc.ls(preSelectHilite=True) if len(componentPreSelect): mc.menuItem(divider=True) mc.menuItem(label=componentPreSelect[0]) else: # Otherwise, no thing Alt+RMB'd on: mc.menuItem(label="No object under cursor") def makePopup(): """ Will create the custom, context-sensitive, popupMenu displayed by Alt+RMB'ing on a node. """ # Delete the popupMenu if it already exists: if mc.popupMenu(POP_NAME, exists=True): mc.deleteUI(POP_NAME) # Build the popupMenu, envoking a postMenuCommand when it is shown: mc.popupMenu(POP_NAME, button=3, altModifier=True, markingMenu=True, parent='viewPanes', postMenuCommand=postMenuCommand) }}} {{{ # And execute... makePopup() }}} On a side-note: After several tries, the safest bet is Ctrl+MMB: Ctrl+RMB is used for zoom.  I pulled these notes from highend3d.com by "picksel" *Example: Basically, you create an objectFilter node when you execute itemFilter (don't ask why their names are different). {{{ itemFilter -byName "*lambert*"; }}} *This creates an {{{objectFilter}}} named {{{objectFilter7}}} or something like that. *Then you can do: {{{ lsThroughFilter "objectFilter7"; }}} *and it should return a long list of all nodes containing 'lambert' anywhere in their names. *Now, there is another such thing for ATTRIBUTES which is known as an objectAttrFilter? but I still can't get it to work.. it's accessible via the itemFilterAttr? command.. Also see: *[[Based on an itemFilter, how can I find all the nodes in Maya that match?]] *[[How can I query all the default itemFilters in Maya?]] {{{viewPlace}}} !!!Example {{{ float$pos[] = xform -q -ws -t $objName; string$panelName= playblast -activeEditor;
// or // string $panelName = getPanel -wf; string$camName = modelPanel -q -camera $panelName; viewPlace -la$pos[0] $pos[1]$pos[2] $camName; }}} {{{playblast}}} has the advantage of always returning back a {{{modelPanel}}}: The {{{getPanel}}} command can return back other editor types that may be active. Also see: [[How can I know which camera panel is currently available based on the current layout?]] Maya lets you turn any IK chain into a switchable ik\fk system. Which seems neat at first, until you realize how limiting it is: You need to parent (for example) nurbs curves as a shape node to the joint to add a selection abstraction layer for the animators (so they're not picking the joints directly. But they're still keyframing directly on the joints in FK mode. And this makes you sad. So you don't use it, and end up rigging a system that has multiple IK\FK chains constrained together to pull this off. Then, you figure out from the guy sitting next to you, in fact you //can// do this: *On the ikHandle node turn //off// "IK FK Control". Turn off "Snap enable". *Constrain the joints to your fk controllers. *Now, when switching back and forth between IK and FK, this is what you do: **{{{ikBlend}}} is used to switch back and forth between the ik solve, and the fk system. **Additionally, blend off the constraint weights on the joints. Boom. Thanks to for the info from Mason Sheffield. It's commonly known that you can use operators inside of conditional statements. Like: {{{ int$a;
if($b ==$c)
$a = 1; else$a = 0;
//   '==' is the operator
}}}
But you can also use them //outside// of conditional statements as well, sort of a 'short hand' version:
{{{
int $a =$b == $c; \\ If$b and $c are equal, 1, else 0 int$a = $b !=$c \\ if $b and$c are NOT equal, 1 else 0
int $a =$b || $c; \\ If$b or $c is equal, 1 else 0 int$a = $b <$c;  \\ if $b is less than$c, 1 ,else 0
int $a =$b > $c; \\ if$b is greater than $c 1, else 0 int$a = $b <=$c;  \\ if $b is less than or equal to$c, 1 ,else 0
int $a =$b >= $c; \\ if$b is greater than or equal to $c, 1 ,else 0 }}} ---- There is also the '{{{?}}}' operator. From the Maya docs: The {{{?}}} operator lets you write a shorthand if-else statement in one statement. The operator has the form: {{{condition ? exp1 : exp2;}}} If condition is true, the operator returns the value of exp1. If the condition is false, the operator returns the value of exp2. {{{ // If$y > 20, $x is set to 10, // otherwise$x is set to the value of $y.$x = ($y > 20) ? 10 :$y;

// If $x > 10, print "Greater than", otherwise // print "Less than or equal". print(($x > 10) ? "Greater than" : "Less than or equal");
}}}
I've ran into instances when I'll execute a command from a UI button (for the sake of example), and when I undo the action, I end up undoing a LOT of steps.  I'm not sure yet what causes Maya to decide whether or not it's going to undo the last operation, or all the steps that made up the last operation. But if you run into a similar problem, you can use {{{undoInfo}}} to setup an 'undo chunk' that will store all the operations performed during its creation.  After you close the chunk, if you undo, it will undo everything put in the chunk.

Easy to do, and I recommend doing it with Python, since you can wrapper it in a {{{try}}} \ {{{except}}} clause, so that if any of the code fails in the middle of the chunk, the chunk can still close itself.
{{{
# Python code
import maya.cmds as mc

mc.undoInfo(openChunk=True)
try:
doBunchOfStuff()
except Exception, e:
print e
mc.undoInfo(closeChunk=True)
}}}
{{{
objectB.translateX = getAttr -t (frame-3) objectA.translateY;
}}}
*This will make objectB match objectA's translateX, but three frame laters.
*DRAWBACK:This is using getAttr & setAttr on your source and destination nodes.  It's not querying their absolute position in worldspace, it's the local transformations applied to the nodes themselves.  If they don't have the same initial transformation values, the destination object could have an offset based on the difference of the trans, rot, an scale between the two nodes.  This obviously could be a major issue.  To work around it, look below to the "decomposeMatrix" section.
*I've read in several places that Maya technical guru's don't recomend this operation since the getAttr somehow breaks the dependency graph evaluation, but I personally have never had anything go haywire with it.  It's basically very similar to expression code I used to write in PowerAnimator with great success.If this isn't a viable solution though, then try the below frameCache proposal.

Simple example of writing text to a file.  You should make sure ahead of time that if the file exists, it's writable.  You also need to check and make sure the directory exists too.

FYI, opening these files in Windows Notepad usually has bad formatting.  But opening them in anything else (Word, ~WordPad, etc) has correct formatting.  I don't think Notepad likes the 'newline character' {{{\n}}}.
{{{
string $filepath = "c:/temp/test.txt"; string$data[] = {"line1", "line2", "line etc..."};

int $fid = fopen$filepath "w";
for($i=0;$i<size($data);$i++)
fprint $fid ($data[$i] + "\n"); fclose$fid;

filetest -f $filepath; // Result: 1 // }}} Also see: *[[How can I turn a text file into a string array?]] *[[How can I get return characters to work in Notepad properly?]] By default, when you launch Maya in prompt mode a dos prompt: {{{ c:\> maya -prompt }}} ,,,a new session of Maya will launch in a shell, ready for //mel// commands to be entered and executed. The prompt looks like this: {{{ mel: }}} But what if you want this same functionality, but with //Python// commands? With Maya 8.5 and later, presuming it's been added to you system path, you can execute (on Windows) {{{C:\Program Files\Autodesk\<version>\bin\mayapy.exe}}} from the command prompt, to launch Maya's version of Python in that shell: {{{ c:\> mayapy Python 2.5.1 (r251:54863, Jun 5 2007, 22:56:07) [MSC v.1400 32 bit (Intel)] on win32 Type "help", "copyright", "credits" or "license" for more information. >>> }}} Then you can import in maya.standalone (see notes [[here|How can I execute Maya's version of Python outside of Maya?]]), and start running Maya from within Python: {{{ >>> import maya.standalone >>> maya.standalone.initialize('python') }}} then you can start running Python in maya as usual: {{{ >>> import maya.cmds as mc >>> mc.ls() [u'time1', u'renderPartition', u'renderGlobalsList1', u'defaultLightList1', u'defaultShaderList1'.... }}} ... and yer good to go! An animator asked me if there was a way to change the color of a given curve in the graph editor. I realize that animCurves have both a {{{userCurveColor}}} attr (bool), and a {{{curveColor}}} attr (double3). Armed with this knowledge, I built a function that will query what curves the user has selected in the Graph Editor (both in the Graph Editor Outliner, and in the Graph Editor Panel), launch a color chooser, and color them the defined values: {{{ def setAnimCurveColor(): """ Based on the curves selected in the graph editor, or the obj.attrs selected in the Graph Editor channel box, launch a color-chooser allowing the changing of the individual curve colors. """ # This finds a list of the "obj.attrs" selected in the graph editor channel box: selectionConnection = mc.outlinerEditor("graphEditor1OutlineEd", query=True, selectionConnection=True) outlinerSelection = mc.selectionConnection(selectionConnection, query=True, object=True) # convert to incoming connected keyframe nodes: outlinerAnimNodes = [] if outlinerSelection is not None: for os in outlinerSelection: # make sure we have an attr picked, and not a transform if "." in os: incoming = mc.listConnections(os, source=True, destination=False, type="animCurve") if incoming is not None: outlinerAnimNodes.append(incoming[0]) # This grabs the acutal keyframe nodes picked in the graph editor panel graphEdAnimNodes = mc.keyframe(query=True, selected=True, name=True) if graphEdAnimNodes is None: graphEdAnimNodes = [] # combine lists, and remove dupes curves = list(set(outlinerAnimNodes+graphEdAnimNodes)) # Launch our color chooser: if len(curves) > 0: mc.colorEditor() if mc.colorEditor(query=True, result=True): color = mc.colorEditor(query=True, rgb=True) for c in curves: mc.setAttr("%s.useCurveColor"%c, 1) mc.setAttr("%s.curveColor"%c, *color) else: print "Cancled color chooser", else: print "No cuves picked in Graph Editor", }}} "ELF controll" {{{-bgc}}} Most UI (ELF) controlls have options to change their colors. If they have a {{{-bgc}}} argument, then they can have color added. *Example: Make a button with a color other than default: {{{ button -bgc 1.0 0 0; }}} {{{polyListComponentConversion}}} & {{{polySelectConstraint}}} Take the current selection, convert it to the appropriate component type, the expand it to its //shell// (which is slightly different from the subject-line, but I use this more often): {{{ // Vertex to shell select polyListComponentConversion -toVertex; polySelectConstraint -type 0x0001 -shell 1 -mode 2; polySelectConstraint -disable; }}} {{{ // Edge to shell select polyListComponentConversion -toEdge; polySelectConstraint -type 0x8000 -shell 1 -mode 2; polySelectConstraint -disable; }}} {{{ // Face to shell select polyListComponentConversion -toFace; polySelectConstraint -type 0x0008 -shell 1 -mode 2; polySelectConstraint -disable; }}} {{{ // UV to shell select polyListComponentConversion -toUV; polySelectConstraint -type 0x0010 -shell 1 -mode 2; polySelectConstraint -disable; }}} Note how the constraint needs to be disabled afterwards. Requires two object.attrs (source and destination). {{{isConnected}}} {{{progressWindow}}} ---- Whenever I set these up I always seem to forget the magic, so below is a solid way of doing it. In this example, we're looping over some number of frames, just printing the frame number. {{{ # Python code import maya.cmds as mc # Define the range the progressWindow should act in: minF = 1 maxF = 500 # Setup the progress window: progressSteps = 100.0 / (maxF-minF) progress = 0.0 mc.progressWindow(title='Progress Window!', progress=0, minValue=0, maxValue=100, status='Not started yet...', isInterruptable=True ) # Start looping for i in range(minF,maxF+1): # Update our progress window, or quit if the user has hit escape: if mc.progressWindow( query=True, isCancelled=True ): break mc.progressWindow(edit=True, progress=int(progress), status='%.1f%%'%progress) progress += progressSteps # Do any work that needs to be done this loop\frame (in this case just a print), # then advance the frame: print i mc.currentTime(i, edit=True) # Exit the progress window: mc.progressWindow(endProgress=1) }}} ---- Also see: *[[How can I author a progressWindow context manager?]] {{{optionMenu}}} So simple, but I always seem to forget the syntax... :-S {{{ import maya.cmds as mc skinCluster = mc.skinCluster('myMesh', edit=True, unbind=True) }}} This has the added bonus of unlocking the transform channels for you, compared to just deleting history. *Export an anim (with one or more objects selected): {{{ file -es -type "animExport" -op "-cb api -fea 1 -animation objects -option keys -hierarchy none -controlPoints 0 -shape 000" "c:/temp/foo.anim"; }}} *Import an anim (with one or more objects selected): {{{ file -i -type "animImport" -op "targetTime=4; copies=1; option=replaceCompletely; connect=0;" "C:/temp/test.anim"; }}} *Notes: **You must have the "{{{animImportExport.mll}}}" plugin loaded. **The options listed are based primarily on the copyKey and pasteKey mel commands. In the case of an export, the animation data is copied (via copyKey) into the api clipboard, and then sourced by the plugin for export. In the case of an import, the plugin copys the data from the anim file to the api clipboard, then pastes it (via pasteKey) onto the objects. {{{whatIs}}} *Example A: {{{ whatIs "sphere" // Result: command }}} *Example B: {{{ int$abc[42];
whatIs "$abc"; // Result: int[] variable // }}} Good for figuring out which camera view you're in…. {{{getPanel}}} *Example: get the current or last active panel: {{{ string$panel = getPanel -withFocus;
}}}
*Example: get the current panel the mouse is over:
{{{
string $panel = getPanel -underPointer; }}} *You can also use {{{playblast}}}, if you want to limit the values to only be {{{modelPanel}}} items: {{{ string$panel = playblast -activeEditor;
}}}
----
There is also the //mel// {{{global proc findPanelPopupParent()}}}, which wrappers {{{getPanel -underPointer}}}, and returns the {{{paneLayout}}} under the pointer.
{{{
C:\Program Files\Autodesk\Maya20XX\scripts\others\findPanelPopupParent.mel
}}}
From its docs:
<<<
Find the {{{paneLayout}}} under the mouse pointer.  A {{{popupMenu}}} can be attached to this layout for hotkey-enabled marking menus.  If no {{{paneLayout}}} can be found under the pointer, this method returns "{{{viewPanes}}}".  This is so that the user is not annoyed by error messages when they mistakenly use the wrong hotkey on a non-panel window. ("{{{viewPanes}}}" is Maya's main {{{paneLayout}}})
<<<
{{{about}}}
*Examples:
{{{
about -v; // returns a string with the version number, i.e. 4.0.2
about -p; // returns a string with the product version, i.e. Maya Unlimited 4.0.2
}}}
{{{exists}}}
*Example:
{{{
exists ls;
// result: 1
}}}
{{{catch}}}
*Example A: First define some proc "bob". Then:
{{{
catch (bob)            // this is the start of a new procedure
}}}
**if "bob" failed execution, without the catch, the rest of the new procedure wouldn't execute, but with the catch, the rest of the proc would execute.
*Example B: define some string that does something, $string. Then: {{{ catch (eval($string));
}}}
{{{modelPanel}}} & {{{getPanel}}}
*Example: (presuming the active panel IS a camera view…)
{{{
string $currentPanel = playblast -activeEditor; // or // string$currentPanel = getPanel -withFocus;
string $cameraName = modelPanel -q -cam$currentPanel;
}}}
{{{playblast}}} has the advantage of always returning back a {{{modelPanel}}}: The {{{getPanel}}} command can return back other editor types that may be active.
Also see:
*[[For the current panel, how can I make a named camera be the one viewed through?]]
You can use a sneaky back-door via {{{undoInfo}}}:
{{{
// presuming you say, just moved something:
string lastCmd = undoInfo -q -undoName; // Result: move -r 0.321949 -0.212393 0 // }}} Since Maya's undo-que holds everything just executed (so, it can be undone), you can use this method to query what //would// be undone... which obviously would be the last commands entered. Also see: *[[How can I repeat the last action in Maya?]] I don't render much these days, but I always found this weird: It's the {{{\images}}} directory setup in your current //project// that define where the renders go. If there is no {{{\images}}} dir, then it uses the root of the project. This path is editable by accessing 'File -> Project -> Edit Current...' (before Maya 2012) or 'File -> Project Window' (Maya 2012 and newer). You can confirm this by open the 'Render Settings' window, and at the top of the 'Common' tab, you'll see the 'Path:' to the save directory. Why they don't just have a path you can set in the Render Settings.....? :-S {{{objExists}}} {{{recordAttr}}} *Example: *Select the object you want to record motion on. *In the script editor, enter {{{ recordAttr -at "translateX" -at "translateY"; // to control the tx and ty for example }}} *Execute that bit of code. You'll see new "record1" outputs on your object *Next type in the script editor, but don't execute yet: {{{ play -record; }}} *Now: **select your object in the camera view, **go back and highlight 'play -record' in the script editor, **move your mouse back over your object (but do not pick it!), **and hit the 'Enter' button on the NUMBER pad. **This will execute the mel code, but leave your mouse right over your object ready to be selected and moved. *This will start the recorder, capturing your mouse movement.Click on the object, and start moving it.Obviously, you should constrain you translation plane to the two axes you've selected before you start this process.Hit Esc when done. *This can work for any attr you want actually, I just used trans as an example. *Also, if you want to delete the motion and try again, you'll need to also delete the "record" nodes that are output connections to your animated node as well. You can use this code: {{{ delete ls -type record; }}} When using Python in Maya, to access the bulk of the //mel// commands via Python, you import the {{{mel.cmds}}} package, usually into a namespace, like so: {{{ import maya.cmds as mc print mc.ls() }}} But if you browse to that package on disk, you'll find it empty, only containing an {{{__init__.py}}} file (required for package creation): {{{ C:\Program Files\Autodesk\Maya<VERSION>\Python\Lib\site-packages\maya\cmds }}} So how are all the 'mel commands' added to that package for execution in Python? There is a startup Python module living here, that works the magic of populating that package: {{{ C:\Program Files\Autodesk\Maya<VERSION>\Python\Lib\site-packages\maya\app\commands.py }}} It parses a file called {{{commandList}}} (no extension, but it's text) living here: {{{ C:\Program Files\Autodesk\Maya<VERSION>\bin\commandList }}} You can open that file in a text editor, and what you'll find are two columns: One with a 'mel' command name, and one with a .dll where that command 'lives'. Those .dll's live in the same dir as the {{{commandList}}} file. Here's a sample: {{{ TanimLayer AnimSlice.dll about Shared.dll addAttr Shared.dll addDynamic DynSlice.dll addPP DynSlice.dll affectedNet Shared.dll affects Shared.dll agFormatIn Translators.dll agFormatOut Translators.dll aimConstraint AnimSlice.dll air DynSlice.dll aliasAttr Shared.dll align Shared.dll }}} What {{{commands.py}}} does is parse the {{{commandList}}} file and append each command (via a Python command wrapper function) to {{{maya.cmd}}}'s {{{'__dict__}}}' attribute ({{{maya.cmds.__dict__}}}), which is the lookup table users access when calling their favorite mel command via Python (like {{{maya.cmds.ls(}}}) It also passes the name of the .dll to the command wrapper function, so when the user executes the given command, it first loads the parental .dll. Crack open commands.py for the nitty-gritty details. ---- If you want to see the end result of all this hard work, you can run this code in Maya. But it prints a *lot* of stuff: {{{ import maya.cmds as mc for k in sorted(mc.__dict__.keys()): print k, mc.__dict__[k] }}} Since Python is now available in Maya, it makes sense to use it's power. One of it's coolest features is being able to use its 'object oriented programming' (oop) features. This is old hat in the world of programming, but not supported with mel. Since it's been a relatively new concept for me, I've been having a hard time to find a good description of it in print. As I learn it, I update another wiki (my Python wiki) with notes specifically on it. You can find that info here: http://pythonwiki.tiddlyspot.com/#Class Also, the below link does a pretty good job of it, for the beginner: http://www.pasteur.fr/formation/infobio/python/ch18.html This is pulled from the 'Programming Course for Biologists at the Pasteur Institute', so the examples are a bit... genetics related. But they have nice pictures, and get the point across. And as of //this// writing, it was updated Feb 2, 2008 (pretty recently). I have yet to find an answer to this: When you open a file in Maya, and browse to the path, when you later reopen a file, that path is stored in the top drop-down menu of the {{{fileBrowserDialog}}}. How that path is stored is currently a mystery to me. My guess is that it's handled in the guts of the {{{fileBrowserDialog}}} code: If you do a 'File->Recent Files', then later open a file, the 'Recent Files Opened' path //won't// be in the {{{fileBrowserDialog}}}. But if you call to a {{{fileBrowserDialog}}} either through File->Open (which calls to the {{{OpenScene}}} {{{runTimeCommand}}}), or through your own {{{fileBroswerDialog}}} code, the menu will be updated. You can prove this using this simple example: {{{ # Python code import maya.cmds as mc def importer( fileName, fileType): mc.file( fileName, i=True ); return 1 mc.fileBrowserDialog( m=0, fc=importer, ft='mayaAscii', an='Import', om='Import' ) }}} After you open a file and then relaunch the example, you'll see the path to the file in the top drop down menu. I thought that maybe these values were saved as a global var, since they seem to reset when you quit Maya. However, searching through all of global vars, I could find no path matches. I even checked {{{userPrefs.mel}}}, since that's where {{{optionVar}}}'s are stored, but there was no comparable data in their either. So currently... unsolved mystery.... When Maya launches, via GUI or Batch mode, it executes one of these two Python modules: (From the {{{maya.app.startup}}} Python package) *{{{\Autodesk\Maya20XX\Python\Lib\site-packages\maya\app\startup\}}} **{{{gui.py}}} **{{{batch.py}}} Both modules import the module {{{maya.app.startup.basic.py}}}. In addition, {{{gui.py}}} also does these things: *Replaces {{{sys.stdin}}} with {{{maya.app.baseUI.StandardInput()}}} *Replaces {{{sys.stdout}}} with {{{maya.utils.Output()}}} *Replaces {{{sys.stderr}}} with {{{maya.utils.Output( error=1 )}}} !!!{{{maya.app.startup.basic}}}: Things it does (from notes in that module): *Set up {{{sys.path}}} to include Maya-specific user script directories. **{{{setupScriptPaths()}}} (local function) *Set up auto-load stubs for Maya commands implemented in libraries which are not yet loaded. See "[[How does Maya populate maya.cmds?]]". **{{{maya.app.commands.processCommandList()}}} *Run the user's userSetup.py if it exists **{{{executeUserSetup()}}} (local function) *Register code to be run on exit: **{{{atexit.register( maya.app.finalize )}}} *Set up string table instance for application: **{{{maya.stringTable = utils.StringTable()}}} ---- Also see: *[[Understanding Python integration in Maya]] *".liw" stands for "Lock Influence Weight". By default, a joint doesn't have this attribute, but when it is smooth bound to geometry, each joint receives this new attribute. It is just a custom attribute. Its output connects to the respective skinCluster's ".lockWeights[]" (.lw) imput attribute. ".lockWeights[]" is an array attribute, that can receive inputs from multiple joint.liw attrs. *There is no reference to this attribute (.liw) in the documentation, since it is a custom attr generated by the smoothBind process. You can find documentation for the ".lw" attr in the "joint" documentation. Also see: *[[How can I easily hold or unhold all the influence weights on skinned geo?]] Some good stuff from this post by Peter Shipkov : http://groups.google.com/group/maya_he3d/browse_thread/thread/5a78a2fce5de57b4# getattr: {{{ getAttr someNode.boundingBox.boundingBoxMin; getAttr someNode.boundingBox.boundingBoxMax; }}} Commands: {{{ exactWorldBoundingBox("someNode"); xform -query -boundingBox someNode; polyEvaluate -boundingBox; // whole object polyEvaluate -boundingBox2d; // object uv's polyEvaluate -boundingBoxComponent; // component level polyEvaluate --boundingBoxComponent2d; // component level uv's }}} API: {{{ OpenMaya.MFnDagNode.boundingBox() }}} Generally all my tools are up in source control, and my team members sync (via Perforce in our case) to get them. This isn't bulletproof however, since they'll often forget to. Deep sigh. I saw it discussed by Jeremy Ernst (in his [[gdc presentation pdf|http://www.unrealengine.com/files/downloads/Jeremy_Ernst_FastAndEfficietFacialRigging2.pdf]]) that he makes executable installers for his tools via: *[[Smart Install Maker|http://www.sminstall.com/]] I've yet to use this system, but I like the sound of it. Notes will go here if I ever get around to using it (or something similar). See the blog post here: *http://mayastation.typepad.com/maya-station/2011/03/how-to-sample-a-3d-texture.html Sometimes when I orient constraint one object to another (often joints) with 'maintain offset' turned ON, the object being constrained has new rotation values (usually something like 180, -180, 180) applied. So 'maintain offset' isn't doing its job. Very frustrating, especially since it seem to happen inconsistently. I have found the usual culprit is that the two nodes have //different// rotate orders. If I change the rotate order of node B to match node A, THEN do the orientConstraint, THEN set the rotate order back, it makes it happy, and your rotate values don't change.  A buddy of mine ran into this. He had to encode it as an uncompressed AVI with these values: *640x480 *Millions Colors (not thousands or millions +) *30 fps  Presume you have a rig, that is controlling a skeleton. The skeleton is bound to mesh. But not all of the joints are bound to the mesh: Some leaf joints aren't bound to anything. Before you export to the game, you delete the rig for cleanliness purposes. When you make the joints visible, any joint not bound to a mesh has snapped to identity (directly on top of its parent). Why? How to fix? It appears that Maya is optimizing too much for its own good. It seems that if a joint has incoming connections to translate, rotate, etc, //and// it's hidden, //and// if it's not bound, if you delete the nodes that the incoming connections are coming from, Maya doesn't know what to set the joint attributes to, so it sets them to zero. This snapping them on top of their parent. Being visible, or having mesh bound to it will leave it in the correct place. To fix in code, you can make them visible first. But even then (if this "cleaning step" is happening via code) they may not become visible until after the clean code is done. To force the visibility, you need to change the frame immediately after, to force a scene refresh. {{{ showHidden -all; floattime = currentTime -q;
currentTime ($time + 1); currentTime$time;
}}}
Jump through flaming hoop A, and through flaming hoop B.
Tested in 7.01:
*I'm guessing this may be a display bug in Maya:  If the collision object has input creation history, it appears to also show 'OUTPUTS' (thus, the geoConnector) in the channel box.  However, if its history has been delted before it was made to be collision, and thus there are no inputs, after collision has been added, the 'OUTPUTS' section of the channel box just dosn't show up.
*The geoConnector node is still there, just not showing up.  You can see it in the Hypergraph, and check for it with listConnections.  Bothersome!
Never figured out the exact reasoning, but I've seen this from time to time:  It's possible that whatever layout was saved with their scene file isn't jiving with your current version of Maya.  Usually, no matter what one does, they can't get a camera to appear to view though.

To fix, disable Maya from loading the saved layouts on file open (and then reopen the file):
*Window->Settings\Preferences->Preferences:
**UI Elements
***//Uncheck//:
****{{{When Opening [] Restore Saved Layouts from File}}}
What's going on behind the scenes when you uncheck that box and save the prefs?
{{{
$gUseScenePanelConfig = false; file -uc false; optionVar -iv useScenePanelConfig 0; }}} It's setting the global int$gUseScenePanelConfig to "off", setting the file command's 'uiConfiguration' flag to off, and setting the optionVar 'useScenePanelConfig' to off.
*The actual window is called {{{toolProperties}}}
*It has a master {{{formLayout}}} called {{{toolProperties_C}}}
*There is a {{{tabLayout}}} called {{{context_T}}} which the custom tool settings go.
*Given the Paint Skin Weights tool as an example, its UI information lives in a {{{columnLayout}}} called {{{artAttrSkin}}}, and this is where you can add your custom UI's
----
Also see:
*[[How can I access \ query the Tool Settings UI?]]
{{{C:/Program Files/Alias/MayaX.X/scripts/others/showEditor.mel}}}
And these are some global vars that define some of its elements:
{{{
global string $gAECurrentTab; global string$gAttributeEditorWindowName;
global string $gAEMenuBarLayoutName; }}} {{{ showEditor($myObjName);
}}}
----
Also see:
*[[How can I create a floating Attribute Editor for the selected node?]]
*From Autodesk support when I queried them on this limitation:
**Apperantly Microsoft command-line interpreter {{{CMD.EXE}}} can only execute strings up to 8191 characters in length. So when you pass a mel system call to it, that is longer than 8191 characters, it craps out. For more info on it, see [[HERE|http://support.microsoft.com/default.aspx?scid=kb;en-us;830473]].
*For example:
{{{
string $cmd = "someApp someArgs some more args, more args to 8192 characters...."; system($cmd);
// but... nothing happens.... //
}}}
*Workaround: Try creating a .bat file from Maya using the fopen and fprint commands, fill it with the system commands you want, and execute it instead: {{{system("c:/mybat.bat");}}}.
Also see:
*[[Using the system command in Maya, how can I call to a .bat file and have the .bat file execute on the contents of the directory it lives in?]]
If you're not, save your file as a .ma (mayaAscii).  Open the .ma in a text editor, and look for your value in there.  Often you'll perform an operation via the UI, and even when "Echo All Commands" is turned on in the Script Editor, you still aren't to sure what attrs\values were affected by the result.  If you know the value you're looking for, checking the saved .ma file can often reveal a lot about what is going on.
Say you have a list of object names that you try to pick stored in an array.  But you get an error saying that an item in the list dosn't exist.  But you //know// the object //does// exist, what's causing this?
Example:
{{{
// create two null objects:
group -em;  // this is called "null1" by default
select -cl  ;
group -em;  // this is called "null2" by default

// make our list with an extra object name in it, "null3":
string $list[] = {"null1", "null2", "null3"}; // try and pick the list: select -r$list;
// Error: line 1: No object matches name: null1 //
}}}
*Huh?  Object {{{null1}}} most definitly exists, what's going on?
*I'm not sure if it's a bug, or as designed, but when you try to select a list of objects based on an array, and one or more of the names in the array dosn't exist as an object, it errors that the FIRST object in the array is missing.  This can be //very// confusing to the user.
*Instead, add-select the objects if they exist, and print a warning if they don't:
{{{
select -cl;
for($i=0;$i<size($list);$i++)
{
if(objExists($list[$i]))
select -add $list[$i];
else
warning ("Object in list dosn't exist: " + $list[$i]);
}
// Warning: Object in list dosn't exist: null3 //
ls -sl;
// Result: null1 null2 //
}}}
{{{stringArrayCount}}}
*Example:
{{{
string $string[] = {"happy", "bob", "angry"}; string$strung = "happy";
int $count = stringArrayCount($strung, $string); // Result: 1 // }}} {{{ \\ this will return the shape nodes of the objects based on the selected components: ls -o -sl; }}} Amazingly, seemingly yes. It's called a "home use licence" http://usa.autodesk.com/adsk/servlet/ps/dl/item?siteID=123112&id=13812813&linkID=9242258 From that page: <<< ''Home use license'' ''Issue'' How can I run Maya from home? ''Solution'' If you have a network license under subscription, you can apply for a "home use license". A home use license is a stand-alone license based on a primary license. The primary license can be either a stand-alone or network license. A home use license based on a stand-alone primary license will have the same serial number as the primary license. A home use license based on a network primary license will have a different serial number, which you must obtain from Autodesk. Subscription Contract Managers and Software Coordinators can log on to the Subscription Center to find more details on the Home Use benefit, and to apply for a home use license. To get your license: #Log on to the [[subscription center|http://subscription.autodesk.com/]] #Contract Administration. #Click "Request Home" use. <<< Sometimes you'll luck out when Maya crashes, and it'll save a backup of the current scene, in the current state. It usually tells you this in a dialog box just before it crashes. If you //are// so lucky, you can find those files here (on Windows XP): {{{ C:\Documents and Settings\<userName>\Local Settings\Temp }}} Windows 7: {{{ C:\Users\<userName>\AppData\Local\Temp }}} And they usually have fun names like: {{{ <userName>.20081202.1412.ma }}} {{{<userName> . <year> <month> <day> . <hour> <minute> .ma}}} ---- Python code to auto-open that dir in Explorer (For Windows7 paths): {{{ import os import subprocess profile = os.getenv('USERPROFILE') crashPath = os.path.join(profile, r"AppData\Local\Temp") subprocess.Popen(['explorer', crashPath]) }}} *Example: {{{ listAttr -s -cfo objectName; }}} *The -cfo is the important flag. Layer Editor UI Structure: *{{{global string$gCurrentLayerEditor;}}}  --  {{{formLayout}}}.
**{{{LayerEditorTypeRadio}}}  --  {{{radioButtonGrp}}}.
**{{{DisplayLayerUITabLayout}}}   --   {{{tabLayout}}}
***{{{DisplayLayerTab}}}  --  {{{layout}}}
****{{{formLayout38}}}  --  {{{formLayout}}} -- it's name appears to be generated on the fly
***** ... and they just keep going ...
***{{{RenderLayerTab}}}   --   {{{layout}}}
****{{{RenderLayerFormLayout}}}}  --   {{{formLayout}}}
***** ... and they just keep going ...
Name of last layer editor button selected:
{{{
global int $gLayerEditorLastButtonSelection; }}} UI control type for making layer buttons: {{{ layerButton; }}} Script that holds the guts of the code to build the Layer Editor: {{{ ../MayaXX/scripts/startup/layerEditor.mel }}} By using the Python {{{inspect}}} module, you can query which //line of a module// is currently being executed. By using a Python module's special {{{__file__}}} attribute, you can query which //module// is currently being executed. Combine the two with one of Maya's {{{confirmDialog}}}'s, and you have something useful to tell the user when something bad happens: {{{ # linetest.py import inspect import maya.cmds as mc def getLine(): return inspect.currentframe().f_back.f_lineno def errorWin(message, module, lineNumber): mc.confirmDialog( message="%s\n\n%s\nLine : %d"%(message, module, lineNumber), title="Error", button="Bummer..." ) print "%s\n%s\nLine : %d"%(message, module, lineNumber) def main(): if True != False: errorWin("You have encountered an error :-(", __file__, getLine() ) return }}} Other than displaying a nice {{{confirmDialog}}} for the user to click through, it will also print the coresponding info: {{{ import linetest linetest.main() }}} {{{ You have encountered an error :-( C:\stuff\linetest.py Line : 15 }}} A new blog post came out that covers part of the install process after I got it working. Here is part1: http://around-the-corner.typepad.com/adn/2012/10/building-qt-pyqt-pyside-for-maya-2013.html ---- There are a variety of sources with instructions for installing ~PyQt. These are simply my notes based on those combined sources. Resources I pulled from include: *http://images.autodesk.com/adsk/files/pyqtmaya2013.pdf - Maya 2013 specific instructions. *http://nathanhorne.com/?p=451 - Maya 2011 & 2012 specific instructions. *http://www.maya-python.com/2011/09/building-and-installing-pyqt/ - Maya 2012 instructions. This installation is for Maya 2013 on Windows 7, and I mainly followed the above pdf. ---- #Downloaded these zips, and extracted to a temp folder: ##[[PyQt-win-gpl-4.9.4.zip|http://www.riverbankcomputing.com/software/pyqt/download]] -> {{{\PyQt-win-gpl-4.9.4}}} ##[[qt-4.7.1-modified_for_maya_2013.zip|http://usa.autodesk.com/adsk/servlet/item?id=14561324&siteID=123112]] - "Maya's modified version of the Qt source code" (from the above pdf) -> {{{\Qt-4.7.1-Maya}}} ##[[sip-4.13.3.zip|http://www.riverbankcomputing.com/software/sip/download]] -> {{{\sip-4.13.3}}} #{{{\Qt-4.7.1-Maya}}} itself contains a compressed tar, and install notes ({{{howToBuildQtOnWindows_m2013.txt}}}): I extracted the tar here: {{{c:\qt-adsk-4.7.1}}} (per pdf install notes) and then removed {{{\Qt-4.7.1-Maya}}}. # Build Qt. The above txt file says to download the sdk from here http://get.qt.nokia.com/qtsdk/qt-sdk-win-opensource-2010.05.exe, but that link seems dead. So I instead downloaded the sdk from here: http://qt.nokia.com/downloads and installed it. It is big and huge :-S ##To build qt, the instructions say that I need to unzip the provided {{{openssl-1.0.0e.zip}}},... but that file doesn't exist on my HD and wasn't included with any of the previous downloads. And now I'm stuck :( ---- Giving up on that, I found a link to a 'Maya 2013 - Windows 7 - 64-bit' precompiled version... here: http://codecg.com/2012/04/15/pyqt4-for-maya2013-on-windows-7-x64/ It was a simple matter to get it working: #Unzip to temp folder #Under the {{{\site-packages}}} dir, copy the {{{\PyQt}}} folder along with the three other files ({{{sip.pyd}}}, {{{sipconfig.pyd}}}, {{{sipdistutils.py}}}) to ~Maya-Python's {{{\site_packages}}} dir, which for me lives here: {{{ C:\Program Files\Autodesk\Maya2013\Python\Lib\site-packages }}} Restart Maya, try some example code (copied [[from here|http://nathanhorne.com/?p=183]]): {{{ import maya.OpenMayaUI as mui import PyQt4.QtCore as QtCore import PyQt4.QtGui as QtGui import sip def getMayaWindow(): #Get the maya main window as a QMainWindow instance ptr = mui.MQtUtil.mainWindow() return sip.wrapinstance(long(ptr), QtCore.QObject) class MayaSubWindow(QtGui.QMainWindow): 'My custom window, which i want to parent to the maya main window' def __init__(self, parent=getMayaWindow()): #Init my main window, and pass in the maya main window as it's parent QtGui.QMainWindow.__init__(self, parent) #Show my window myWindow = MayaSubWindow() myWindow.show() }}} @@Success!!!@@ <<gradient horiz #ddddff #ffffff >>This is a [[TiddlyWiki|http://tiddlywiki.com/]]. To really get a grasp on how to navigate it, check out their [[homepage|http://tiddlywiki.com/]]. Quick directions below: ---- Conceptually, each 'subject' I post in the wiki is put in a 'tiddler' (based on how "Tiddlywiki's" work). The [[Instructions For Use]] section you're in now is a 'tiddler'. [[Welcome]] is a tiddler. Tiddlers are like individual blog posts. I tag each tiddler with keywords relevant to the subject of said tiddler, and you can see those tags on a small box on the top right of each tiddler. Clicking on a tag will display a list of every other subject with that tag. Subjects (tiddlers) are also categorized on the left menu-bar under larger subject-headings. ALL the tags from //every// tiddler are in the 'Tags tab', which is on the right most column of the page. Mainly, you come to the page looking for an answer, and to find it, you ''search'' for tags using keywords that may exist in your problem. When you find a tag, click on it, and see the resultant subjects... see if one matches what you're looking for. ''SEARCHING FOR DATA:'' #Browse the "Tags" tab in the //right column// for mel-ish key-words. **Inside the Tags tab, major ''Categories'' are all in caps, like "[[ATTRIBUTES]]". **When picking a 'Tag' with more than one link, you can either: ###'{{{Open all}}}' the topics in that Tag (meaning, fully expand all the topics listed in the middle of that pop-up menu). ###Open a single topic by picking its heading. ###Show all the headings in the Tag by picking: {{{Open tag 'tagname}}}'. #Use your web browsers screen-search ability ('Ctrl+F' in both Firefox & Internet Explorer) to find key-words you're after (good if 'Tags' tab is open). #Or start browsing from the ''Categories'' section in the //left column//. This will open each of their major headings in a new tiddler. If things get too crowded, use the "close all" from the //right column// to clean up the page. Or, you can use "close others" from an individual tiddler (This block called "[[Instructions For Use]]" is a tiddler, for example). ---- ''COPYING DATA FROM WIKI, TO MAYA:'' *The way the text has been entered into this wiki, copying code from the source-boxes should work: {{{ string$source = "source-code in a box";
}}}
*Other times it's not in a box, but is still safe for copy:
{{{string $source = "source-code not in a box, but still safe to copy";}}} *If you copy any code outside of a box that's 'not safe', Maya //may// have a hard time with it's formatting and be angered. Weird I reviewed three different solutions for using the Kinect as a mocap source. I list them in order of usefulness below. ---- Some newer posts: *[[PyKinect (Yep, Python and Kinect, in Visual Studio yet!)|http://channel9.msdn.com/coding4fun/kinect/PyKinect-Yep-Python-and-Kinect-in-Visual-Studio-yet]] ---- To make sense of some of the tech below: *[[PrimeSense|http://www.primesense.com/]] has middleware called [[NiTE|http://www.primesense.com/Nite/]] that makes use of [[OpenNI|http://75.98.78.94/]]. They have [[Kinect drivers|https://github.com/avin2/SensorKinect/tree/unstable/Bin]] for it up on github. **What's interesting is the ~OpenNI page actually links to the ~PrimeSense ~NiTE drivers (see links at bottom of this page). *Brekel uses ~NiTE (and thus ~OpenNI) to work it's magic, iPi Soft uses ~OpenNI directly. !ipiSoft *Main site: http://www.ipisoft.com/index.php *Downloads can be found here: http://www.ipisoft.com/downloads_index.php **Main software is iPi Studio, which does the video->skeletal retargeting. **To capture the video, you need to download iPi Recorder. **It's very important that you uninstall any previously installed ~OpenNI\Kinect drivers\software from any of the below examples and restart your computer before installing their stuff. **However, [[this wiki|http://www.ipisoft.com/en/wiki/index.php?title=FAQ]] says you can use the drivers and software installed by Brekel, if previously installed. Notes: *Wasn't able to export from iPi Studio into Maya using Collada. FBX worked, but the root axes orientations were goofed up since I'm +Z up, and iPi Studio is +Y up. !!!Verdict: *Pros: **While a slower pipeline than Brekel (since this captures video, then processes it) the quality is exponentially better. **Allows you to bring your skeleton\mesh into their software, and retarget directly to it: This allows you to export it back to Maya as a FBX. This saves you from having to convert from the Kinect skel to your skel. **Beta version allows for two Kinects, which should help with tracking data that would be occluded by a single Kinect. **Tracks heads and hands. *Cons: **The Kinect-only version is$395, below solutions are free.
**Animation export only, not mesh.
**Things similar to Brekel:  Small capture volume, problems with occluded limbs (but this should be helped by the two-Kinect setup).
!Brekel Kinect
*Process overview: http://torbensko.com/kinect/
*~OpenNI \ Kinect Install guide: (used by above)  http://www.brekel.com/?page_id=170
*Those two pages link to this software:
**''All-in-one ~OpenNI Kinect Auto Installer''
***Download from [[this page|http://www.brekel.com/?page_id=160]]
***Direct link to [[Brekel OpenNI Kinect Auto Installer - Developer Editionv1.3.2.3.exe|http://www.brekel.com/release/Brekel%20OpenNI%20Kinect%20Auto%20Installer%20-%20Developer%20Edition%20v1.3.2.3.exe]]
***This auto-installs the 32-bit versions (which you want even if you're on a 64-bit machine) of ~OpenNI, the Kinect drivers, and NITE.
**''Brekel Kinect'' main application
***Download from [[this page|http://www.brekel.com/?page_id=160]]
***Direct link to [[Brekel Kinect Setup v0.49.exe|http://www.brekel.com/release/Brekel%20Kinect%20Setup%20v0.49.exe]]
**''Maya stuff'':
***Torbensko's 'Maya ~Mo-Cap Scripts' [[here|http://torbensko.com/kinect/KinectMocap_v0.3.zip]]
***Mirage's Maya ~OpenNI Server: [[here|http://mirage.orz.ne.jp/files/MayaOpenNIServer_02Alpha.zip]]
****Note:  This comes with it's own version of {{{OpenNI.dll}}}, which conflicts with the newer one installed above.  Find this install dir, and rename\delete that file.
***There is another port of Torbensko's code [[here|http://www.soup-dev.com/download.html]]:  I had problems getting his working (although I haven't tested this yet)
!!!Install problems:
*Since I'm on a 64-bit machine, I thought I needed 64-bit code.  Turns out this is incorrect:  Even though you can download 64-bit versions of ~OpenNI, NITE, and the Kinect dirvers, the Brekel Kinect software is 32-bit only, and expects 32-bit dll's.
*I had originally installed all 64-bit stuff, and while I got the ~OpenNI examples working, Brekel wasn't.  After re-installing all 32-bit stuff (based on the 'Quick and automatic method' of the 'Install Guide' link listed above), and rebooting my machine (reboot important) it all started working.
----
The below data is to install the 64-bit versions of the software.  As stated above, __these shouldn't be used__, but since I went through the trouble of finding all of them, I thought I'd leave the data here in case it was actually needed in the future.  It should be noted that there are "stable" and "unstable" versions of the data, and they should not be mixed.
*''~OpenNI'' :
**Need to pick it on [[this page|http://www.openni.org/Downloads/OpenNIModules.aspx]] : "~OpenNI Binaries", "Unstable", "~OpenNI Unstable Build for Windows x64...", and press the download button.
**Direct link to [[openni-win64-1.3.2.3-dev.msi|http://www.openni.org/downloads/openni-win64-1.3.2.3-dev.msi]]
*''Kinect Drivers'':
**Download from [[this page|https://github.com/avin2/SensorKinect/tree/unstable/Bin]]
**Direct link to [[SensorKinect-Win-OpenSource64-5.0.3.4.msi|https://github.com/avin2/SensorKinect/raw/unstable/Bin/SensorKinect-Win-OpenSource64-5.0.3.4.msi]]
*''NITE'' :
**On the bottom of [[this page|http://www.openni.org/downloadfiles/opennimodules/openni-binaries/latest-unstable/]]
**Direct link to [[NITE-Win64-1.4.1.2-Dev.msi|http://www.openni.org/downloads/NITE-Win64-1.4.1.2-Dev.msi]].
!!!Verdict:
*Couldn't ever get 'Mirage's Maya ~OpenNI Server' working:  When I'd try to connect to it from Maya, it would use up all available memory on my machine, and crash Maya.
*I was able to export .bvh files from Brekel Kinect and import them into Maya via a plugin\script combo I found on ~CreativeCrash, but the quality was very jittery and low:
**Need to be facing camera.
**No fast movements.
**Small capture area.
**No head tracking, hand is questionable.
*Mesh\texture export:  Easy, but quality is low.
!Kinect for Windows SDK
*http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-cpp-express : Need to install this first, if you don't have it.  Otherwise the next install step will FAIL.
*http://research.microsoft.com/en-us/um/redmond/projects/kinectsdk/default.aspx
!!!Verdict:
*Just the SDK:  Doesn't really come with any tools to let you export skeletal animation data:  You have to code it all yourself (unless I'm missing something).
*In the skeleton tracking examples they provide, the quality isn't any better than Brekel.


[[Wing|For Python: Maya 'Script Editor' style IDE]] has the ability to interact with Maya in four different ways.  Each has it's own setup, independent from another.  For clarity, here they are listed below:
#''Send Python & mel commands from Wing to Maya, bypassing the Script Editor''.  Meaning, replace the Script Editor with Wing.  See Docs [[here|How can I have Wing send Python or mel code to Maya?]]
##I use this on a daily basis, and the main reason I use Wing.
#''Remote debug Python code executed in Maya with Wing''.  This lets you use Wing's debugger to step through Python code in an active Maya session.  See Docs [[here|Remote Python debugging in Wing]]
##This has been extremely valuable to track down bugs in large modules.
#''Execute a standalone version of Maya inside Wing's Python shell''.  See Docs [[here|How can I execute Maya's version of Python outside of Maya?]]
##Note, I've yet to have a need for this, as neat as it seems.
#''Get source analysis \ auto-completion of the 'maya' Python package working in Wing''.
##This allows you when authoring code like this in Wing:
<<<
{{{
import maya.cmds as mc
import maya.OpenMaya as om
}}}
<<<
##To have Wing auto-complete the typed in module\class\function names.
##This is incredibly handy.  See docs [[here|Source Analysis in Wing]].
----
When you are setting these up for the first time, do each separately before moving on to the next, so as not to confuse yourself.
There is a good chance you have an Nvidia __~GeForce__ video card card.  These cards aren't supported by Maya, they expect you to have a much more expensive __Quadro__ card.  I've used ~GeForce cards for years though, with no ill effect.  Every so often though, usually when a new version of Maya comes out, there can be dramatic slowdowns interaction.  Issues I've seen:
*If joints are visible, there is a 1sec pause when picking anything.
*Having 'high quality rendering' turned on in the modeling panels makings any kind of interaction super-slow.
This happened when I switched to Maya 7:  If joints were visible in scene, picking anything had a 1sec pause.  I learned (took until I installed Maya 2008), that by simply updating to the latest drivers from Nvidia, the problem was solved.  Sometimes it takes some fiddling with the driver options too.

http://www.nvidia.com/Download/index.aspx
I will often work on multiple projects simultaneously, that each have their own set of required preferences.  In the course of a day, I may need to access multiple teams data, each having environment variables that need to be set ahead of time, version control software that lives in different depots, and differing mel\Python paths.

The easiest way to do this I've found is to author unique configuration files for each project, and then have a .bat file copy them on top of the standard location that Maya expects to find them.  To explain:
*For each project, author these custom files, each having a unique purpose:
**{{{projName_userSetup.mel}}}
***Set custom Maya script paths via recursive searching procedure (to support an ever-expanding mel library, without having to ever type in custom script paths again)
***Define my own personal prefs (grid color, set linear units, set correct time units, confirm I'm running the correct version of Maya for this project, etc..)
***Load any project-required plugins.
**{{{projName_userSetup.py}}}
***Set custom Python script paths.
**{{{projName_Maya.env}}}
***Define project-specific environment variables
***//Don't// define Maya Script Path (I do that via custom code in the userSetup.mel)
***Define plug-in path
**{{{mayaLauncher_projName.bat}}}
***Copy {{{projName_userSetup.mel}}} to standard install location as {{{userSetup.mel}}}
***Copy {{{projName_userSetup.py}}} to standard install location as {{{userSetup.py}}}
***Copy {{{projName_Maya.env}}} to standard install location as {{{Maya.env}}}
***Since I use Perforce (P4) as version control software, setup the p4Port, p4Client, and p4User for this project.
***Launch Maya
I have multiple .bat files on my desktop, that when executed, copies all the appropriate code to where Maya expects to find it, sets up my version control software appropriately, and then launches Maya.
Pretty darn easy:
{{{
# Python code
import maya.cmds as mc

mc.showHelp("http://www.akeric.com", absolute=True)
}}}
Growing list as I find them:
*''python_inside_maya'' Google group.  You must be a member to read and post:
**http://groups.google.com/group/python_inside_maya?lnk=li
*''Python Wiki'':  This is one of my other tiddlywiki's, specifically geared to my notes while learning Python (just like this mel wiki).  While it has nothing to do with mel, it's all about the basics of Python, which the mel user trying to learn Python could find valuable.  Plus, I like to plug my site.
**http://pythonwiki.tiddlyspot.com/
*''~Highend3D'''s [[Maya Python Forums|http://www.highend3d.com/boards/index.php?s=282e161ce612a241c6c68355266cbdbf&showforum=723]]

Python comes with a {{{logging}}} module:
http://docs.python.org/library/logging.html#logging.basicConfig
http://docs.python.org/howto/logging.html#logging-basic-tutorial

Really simple notes:
{{{
import logging

logging.basicConfig(filename='c:/temp/example.log', level=logging.DEBUG)
def main():
# Need to get a logger to run from Maya:
logger = logging.getLogger(__name__)
logger.debug('Debug logging message from Maya.')
logger.info('Info message from Maya.')
logger.warning('Warning message from Maya.')
logger.error('Error message from Maya.')
logger.critical('Critical error message from Maya.')
}}}
After running {{{someModule.main()}}}, opening {{{example.log}}}:
{{{
DEBUG:someModule:Debug logging message from Maya.
INFO:someModule:Info message from Maya.
WARNING:someModule:Warning message from Maya.
ERROR:someModule:Error message from Maya.
CRITICAL:someModule:Critical error message from Maya.
}}}
2d recipe:
*http://code.activestate.com/recipes/578047-area-of-polygon-using-shoelace-formula/
----
http://code.activestate.com/recipes/578275/
{{{
def poly_area2D(poly):
total = 0.0
N = len(poly)
for i in range(N):
v1 = poly[i]
v2 = poly[(i+1) % N]
total += v1[0]*v2[1] - v1[1]*v2[0]
return abs(total/2)
}}}
{{{
poly = [[0,0], [0,1], [1,1]]
print poly_area2D(poly)
.5
}}}
----
The original code requires a [[numpy|http://numpy.scipy.org/]] install.  I've re-authored it below to use Maya's {{{OpenMaya.MVector}}} class
http://code.activestate.com/recipes/578276/
{{{
import math
from maya.OpenMaya import MVector

def normal(p1, p2, p3):
va = MVector(p1.x - p2.x, p1.y - p2.y, p1.z - p2.z)
vb = MVector(p3.x - p2.x, p3.y - p2.y, p3.z - p2.z)
n = va^vb # cross
return n

#area of 3d polygon
def poly_area3D(poly):
if len(poly) < 3: # not a plane - no area
return 0
total = [0, 0, 0]
N = len(poly)
vecs = [MVector(points[0], points[1], points[2]) for points in poly]
for i in range(N):
vi1 = vecs[i]
vi2 = vecs[(i+1) % N]
prod = vi1^vi2 # cross
total[0] += prod.x
total[1] += prod.y
total[2] += prod.z
nVec = normal(vecs[0], vecs[1], vecs[2])
tVec = MVector(total[0], total[1], total[2])
dot = abs(tVec*nVec) # dot
return math.sqrt(dot)/2
}}}
{{{
poly = [[0,0,0], [0,4,0], [4,0,0]]
print poly_area3D(poly)
# 8
}}}
<<gradient horiz  #ddddff  #ffffff  >>
[[Welcome]]:
[[About mel wiki]]:
[[Instructions For Use]]:
[[Latest Updates|History]]:
[[Maya Links]]:
[[Other Links]]:
[[About Author|WarpCat]]:
[[Copyright Information]]:
----
''Subscribe:''
''[[RSS|http://mayamel.tiddlyspot.com/index.xml]]'' [img[http://farm1.static.flickr.com/197/492915948_b4a9f3233e.jpg?v=0]]
----
[[All Subjects]]
----
''Categories:''
[[ANIMATION]]
[[API]]
[[ATTRIBUTES]]
[[BATCH]]
[[CLASSIFICATION]]
[[COMPONENTS]]
[[CONTEXT]]
[[DEFORM]]
[[DYNAMICS]]
[[EXPRESSION]]
[[FILE OPERATION]]
[[FUNDAMENTALS]]
[[GENERAL]]
[[HARDWARE]]
[[INFO]]
[[MATH]]
[[NETWORKING]]
[[NURBS]]
[[POLYGON]]
[[PYQT]]
[[PYTHON]]
[[PYMEL]]
[[REFERENCING]]
[[RENDERING]]
[[RIGGING]]
[[SCRIPTING]]
[[SELECTION]]
[[SHADING]]
[[SOUP]]
[[STRING]]
[[SYSTEM]]
[[TEXTURE]]
[[TIME]]
[[TRANSFORMATION]]
[[TROUBLESHOOTING]]
[[UI]]
[[VARIABLES]]
[[WEB]]>>
I got tired of running into rigs where everything is locked and non-keyable.  Blam, fixed:  For the selected objects, make all the standard trans, rot, scale (& vis) channels unlocked, and keyable:
{{{
# Python code
import maya.cmds as mc

sel = mc.ls(selection=True)
attrs = ['tx', 'ty', 'tz', 'rx', 'ry', 'rz', 'sx', 'sy', 'sz', 'v']
objAttrs = ['%s.%s'%(obj, attr) for obj in sel for attr in attrs]

map(lambda x.setAttr(x, keyable=True, lock=False), objAttrs)
}}}
Here's an easy, although not perfect solution for matching the topology of meshB to meshA:
*Dupe the orig meshes, hide them.
*Picking both mesh at the same time, apply new UV's to them, so they both get the exact same UV data.
*Select meshA, add-select meshB.
*Access the 'Mesh -> Transfer Attributes' tool options.
**Set 'Vertex position: On'
**Set 'Sample space:' to UV
**Press 'Transfer'
*meshB should not match the topology of meshA.  You can then transfer meshB's original UV's back onto it from the hidden copy.
On sphere's, this works great :)  Talking with modelers, they've had less successful conversions on complicated character heads.
When I first authored this subject I didn't use matrices very often.  But I've found the more I learn about them, the more I end up using them...
Also see my other subjects:
*[[Working with matrices with Python]]
*[[Different ways to access matrix and apply data]]
----
Launch help for the root {{{dagNode}}} type node, which has the base matrix attrs:
{{{
showHelp -d "Nodes/dagNode.html
}}}
Launch help for the {{{transform}}} node (lots of matrix info):
{{{
showHelp -d "Nodes/transform.html";
}}}
Web:
*I made an image describing how 4x4 matrix multiplication works.  You can find it on my [[blog here|http://www.akeric.com/blog/?p=693]], or on [[flickr here|http://www.flickr.com/photos/warpcat/3956108191/]]
*[[chapter 9|http://books.google.com/books?id=_ztrTBEDK28C&lpg=PA191&ots=r56b7bLPzY&dq=python%20transformation%20matrix&pg=PA181#v=onepage&q=python%20transformation%20matrix&f=false]] from the book [[Beginning Game Development with Python and PyGame: From Novice to Professional|http://www.apress.com/book/view/9781590598726]] has a really well described overview.
*http://eddieoffermann.com/blog/tag/matrix-multiplication/
*http://www.185vfx.com/2003/03/convert-a-3d-point-to-2d-screen-space-in-maya/
*Online video lectures from [[MIT|http://ocw.mit.edu/OcwWeb/Mathematics/18-06Spring-2005/VideoLectures/]]
*http://knol.google.com/k/koen-samyn/matrices-for-3d-applications/2lijysgth48w1/3#
*Two different blog posts by Andy Nicholas: [[How to Read a 3×3 Matrix|http://www.andynicholas.com/?p=861]], [[Rotating Points With a 3×3 Matrix|http://www.andynicholas.com/?p=911]]
----
''Quick 4x4 matrix review of an identity matrix'' (presuming +X is 'left', +Y is 'up', and +Z is 'forward').  To visualize the x, y, and z-axes, use your hand:  Hold your right hand in front of you, pointer straight ahead, thumb up, and middle-finger left:  Middle-finger = +X-axis, thumb = +Y-axis, pointer = +Z-axis.
*The fourth //column// '{{{W}}}' is for the most part unused, it is always {{{(0, 0, 0, 1)}}}:  This is called the 'homogeneous row'.  W =  A scalar (single, compared to array) value (also known as the 'homogeneous coordinate') used for conversion from Euclidean to Cartesian coordinates.  I'm using those terms because I read it somewhere, not because I necessarily understand what they're talking about :-P
*The first three //rows// represent the vectors that point in the x, y, and z directions of the transformation, which represent the //axis// in 3D space.  Effectively the orientation/heading of the 'local axis' of a transform in Maya.  They also calculate //scale//.
*The fourth //row// ({{{w}}}) represents the translation, or point in space when transformed by this matrix.  This is the 'homogeneous row':
| || X | Y | Z | W || notes |
| || | | | || |
|x-axis || 1 | 0 | 0 | 0 || 'left', mag=scaleX |
|y-axis  || 0 | 1 | 0 | 0 || 'up', mag=scaleY |
|z-axis  || 0 | 0 | 1 | 0 || 'forward', mag=scaleZ |
|(w) translate || 0 | 0 | 0 | 1 || |
(remember, the right 'W' column is ignored for what we do in Maya)
*''translation'':  Derived from the bottom row.
**translateX, translateY, translateZ =  {{{(0 ,0 ,0)}}}
*''orientation'':  Vectors that point in the x, y, and z directions of the transformation.
**{{{x-axis}}} : defines the current heading of the  'left' vector = {{{(1, 0, 0)}}}
**{{{y-axis}}} : defines the current heading of the 'up' vector = {{{(0, 1, 0)}}}
**{{{z-axis}}} : defines the current heading of the 'forward' vector = {{{(0, 0, 1)}}}
*''scale'' : The magnitude of each x, y, and z-axis defines the scale = {{{(1, 1, 1)}}}
**scaleX = {{{mag(x-axis)}}} = {{{mag(1, 0, 0)}}} = 1.0
**scaleY = {{{mag(y-axis)}}} = {{{mag(0, 1, 0)}}} = 1.0
**scaleZ = {{{mag(z-axis)}}} = {{{mag(0, 0, 1)}}} = 1.0
*''shear'' : still working on that one ;)
''Some examples, based on that info:''

Where individual rotation axis data is stored in the matrix.  Meaning, when you perform an Euler rotation on a node on an individual axis, what part of the matrix does it modify?  Do you notice that the row and column for the transformed axis (excluding translation operations) aren't modified during the transformation? (since the other axes are transforming //around it//.)
__X-axis__ rotation:
| || X | Y | Z | W |
| || | | | |
|x-axis || 1 | 0 | 0 | 0 |
|y-axis  || 0 | @@1@@ | @@0@@ | 0 |
|z-axis  || 0 | @@0@@ | @@1@@ | 0 |
|(w) translate || 0 | 0 | 0 | 1 |
__Y-axis__ rotation:
| || X | Y | Z | W |
| || | | | |
|x-axis || @@1@@ | 0 | @@0@@ | 0 |
|y-axis  || 0 | 1 |0 | 0 |
|z-axis  || @@0@@ | 0 | @@1@@ | 0 |
|(w) translate || 0 | 0 | 0 | 1 |
__Z-axis__ rotation:
| || X | Y | Z | W |
| || | | | |
|x-axis || @@1@@ | @@0@@ | 0 | 0 |
|y-axis  || @@0@@ | @@1@@ |0 | 0 |
|z-axis  || 0 | 0 | 1 | 0 |
|(w) translate || 0 | 0 | 0 | 1 |
__Translate XYZ__:
| || X | Y | Z | W |
| || | | | |
|x-axis || 1 | 0 | 0 | 0 |
|y-axis  || 0 | 1 |0 | 0 |
|z-axis  || 0 | 0 | 1 | 0 |
|(w) translate || @@0@@ | @@0@@ | @@0@@ | 1 |
*Identity matrix rotated 45 degrees along the Z axis.  Compare this to the above chart that shows where those values will be stored.  Note how the z-axis remains the same {{{(0, 0, 1, 0)}}} since it hasn't changed orientation.  But both the x-axis and y-axis now have a new heading? (since they were transformed by the z-axis rotation)  And notice how all their magnitudes still equals {{{1.0}}}?  Scale remains at {{{(1,1,1}}}).
**Visualize this using the 'left hand rule' described above:  Start with your left hand at identity.  Imagine there is a point on the tip of each finger corresponding to each identity vector.  Now rotate your hand along the z-axis (pointer) //clockwise// 45 degrees.  Your pointer is still pointing the exact same direction {{{(0, 0, 1)}}}, but the points defined by your thumb (+y) and middle finger (+x) have moved in space.  But they're all still the same distance away from the middle of the transform, so their magnitudes still each equal {{{1.0}}}.
| @@.707107@@ | @@-.707107@@ | 0 | 0 |
| @@.707107@@ | @@.707107@@ | 0 | 0 |
| 0 | 0 | 1 | 0 |
| 0 | 0 | 0 | 1 |
*Identity matrix scaled to be half as wide, and twice as high:
scaleX = {{{mag(x-axis)}}} = {{{mag(.5, 0, 0)}}} = .5
scaleY = {{{mag(y-axis)}}} = {{{mag(0, 2, 0)}}} = 2
scaleZ = {{{mag(z-axis)}}} = {{{mag(0, 0, 1)}}} = 1
| .5 | 0 | 0 | 0 |
| 0 | 2 | 0 | 0 |
| 0 | 0 | 1 | 0 |
| 0 | 0 | 0 | 1 |
----
''Maya transformation matrix:''
Simple version:
* Scale Matrix * Rotate Matrix * Translate Matrix = final matrix
Long version:
{{{matrix = SP *(-1) S * SH * SP * ST * RP *(-1) RA * R * RP * RT * T}}}
{{{*}}} = matrix multiplication, (-1) = matrix inversion
*SP = scale pivot point : point around which scales are performed
*S = scale : scaling about x, y, z axes
*SH = shear : shearing in xy, xz, yx
*ST = scale pivot translate :  translation introduced to preserve existing scale transformations when moving pivot. This is used to prevent the object from moving when the objects pivot point is not at the origin and a non-unit scale is applied to the object
*RP = rotate pivot point : point about which rotations are performed
*RA = rotate axis = rotation to orient local rotation space
**AX * AY * AZ
*R = rotate = rotation on x, y, z axes.
**RX * RY * RZ (multiplication is defined by rotate order)
*RT = rotate (pivot) translate :  translation introduced to preserve exisitng rotate transformations when moving pivot. This is used to prevent the object from moving when the objects pivot point is not at the origin and the pivot is moved.
*T = translate :  translation in x, y, z axes.
Matrix multiplication happens in order, from left to right.  It can be thought of exactly like a transform hierarchy, with child nodes on the left, and parental nodes on the right.  The matrix to the right will effect the matrix to the left.  So in effect, the root of the hierarchy is '{{{T}}}' (translate), while the leaf-most child would be '{{{S}}}' (scale).  This is why the translation of a node effects where it is rotated and scaled, the rotation of a node effects the orientation of scale but has no effect on translation, and the scale of a node has no effect over rotation or translation.
>It's important to note that Maya internally doesn't store its animation data as matrices.  It stores them on nodes, as keyframe data (scalar values), expression data, dynamic sim, etc.  The matrix is simply a state value that can be queried based on the end result of the incoming anim data for a given transform.
----
Matrices are //multiplied// together to get new matrices.  For example, if you wanted to assign the position of objectC as the position of objectA + objectB:
{{{
matrixC = matrixB * matrixA
}}}
So when you think of 'adding' values, convert that to 'multiplying' matrices.
But what if you want to 'subtract' values?  For example, you want the position of objectC to be the difference between objectA and objectB?  In this case you add (multiply) by the //inverseMatrix//.
{{{
matrixC = matrixB * inverseMatrixA
}}}
----
{{{dagNode}}} node's matrix related attrs (all of these are available through any {{{transform}}} based node):
*__Local__ matrix data, relative to the nodes //parent//:
**{{{.matrix}}} : Local transformation matrix for the dagNode.
**{{{.inverseMatrix}}}  :  Inverse of matrix attribute.  Multiplying by this value will place it at its parent.
*Matrix data for the nodes __//parent//__:
**{{{.parentMatrix}}} : The parentMatrix instanced attribute represents the world-space transformation matrix for the parents of this dagNode. If the dagNode is a transform node and its inheritTransform attribute is false, then the parentMatrix is identity.
**{{{.parentInverseMatrix}}} : Inverse of parentMatrix instanced attribute.  Multiply the parent by this value to return it to origin.
*Matrix data relative to the __//world//__:
**{{{.worldMatrix}}} :  The worldMatrix instanced attribute is the 4x4 transformation matrix that transforms the object to world-space. There is a world-space matrix for each unique path to the object. Eg. 'ball.worldMatrix[0]' identifies the world-space transformation matrix for the first instance of the object 'ball'. Each world-space transformation matrix is the result of post multiplying the 'matrix' attribute by corresponding 'parentMatrix' instanced attribute (i.e. worldMatrix[i] == matrix x parentMatrix[i]). Thus, the worldMatrix is the concatenation of the 'matrix' attribute of all the dagNodes along the path from the node up to the root of the dag hierarchy.
***Basically:  {{{dagNode.worldMatrix = dagNode.matrix * dagNode.parentMatrix}}}
**{{{.worldInverseMatrix}}} : Inverse of worldMatrix instanced attribute.  Multiplying by this will place it at the world origin.
{{{transform}}} node's matrix related attrs:
*{{{.xformMatrix}}} :  Local transformation matrix. From the docs:  "Contains the same information as the matrix attribute on dagNode but it is stored in a format that can be interpolated easily.".  Personally, I'm not sure what makes it more easy to interpolate.
It should be noted that on all these attrs you //can// connect to or query their //outputs//, but they //don't// allow for input connections or modifications via {{{setAttr}}}.
----
Notes on getting Matrix attr data:
<<<
Some attributes represent transformation matrices. Although these attributes are represented internally as 4x4 matrices, unfortunately, matrix attributes are not returned as MEL 4x4 matrix types. Instead, they are returned as an array of floats where the elements of the matrix are listed in row major order. For instance, "matrix $m[4][4] = getAttr ball.worldMatrix;" will not work. To obtain the value of a matrix attribute, you need something like "float$m[16] = getAttr ball.worldMatrix;".
<<<
These float arrays (for a 4x4 matrix) are indexed like this:
| 0 | 1 | 2 | 3 |
| 4 | 5 | 6 | 7 |
| 8 | 9 | 10 | 11 |
| 12 | 13 | 14 | 15 |
----
{{{xform}}} command:
*It should be noted that when querying matrix //translation// values (index 12, 13, & 14) Maya always returns them as cm values.  If your working units are something else, you'll need to convert them!
*If the node ever had 'freeze transformations' ({{{makeIdentity}}}) applied to it, it will throw off the worldspace matrix position.
{{{
// Copy the worldspace matrix from pCube1 to pCube2:
// Using 'getAttr' on the .worldspaceMatrix, it calculates all
// scale operations based on all parental nodes as well.
// This can cause the target .shear attrs to be effected.
float $m[16] = getAttr pCube1.worldMatrix; xform -matrix$m[0] $m[1]$m[2] $m[3]$m[4] $m[5]$m[6] $m[7]$m[8] $m[9]$m[10] $m[11]$m[12]$m[13]$m[14] $m[15] pCube2; // you could optionally use this to get the matrix, via xform: float$m[16] = xform -query -matrix pCube1;
// Which queries the .xformMatrix attr (see above), but this only
// tracks the local scale values, not any extra parental scale
// values:  .shear attrs are not effected.
}}}
*Sets/returns the composite transformation matrix. *Note* the matrix is represented by 16 double arguments that are specified in row order.
----
''Matrix Nodes''
*{{{decomposeMatrix}}} (standard Maya plugin):
**See Mel Wiki notes [[here|How can I have a node return the worldspace position of my object, offset in time?]]
*{{{addMatrix}}}
**Add a list of matrices together.
*{{{fourByFourMatrix}}}
**This node outputs a 4x4 matrix based on 16 input values. This output matrix attribute can be connected to any attribute that is type "matrix".
*{{{holdMatrix}}}
**Cache a matrix.
*{{{multMatrix}}}
**Multiply a list of matrices together.
*{{{passMatrix}}}
**Multiply a matrix by a constant without caching anything
*{{{pointMatrixMult}}}
**The dependency graph node to multiply a point by a matrix.
*{{{wtAddMatrix}}}
**Add a weighted list of matrices together.
*[[dagPose|http://download.autodesk.com/us/maya/2010help/Nodes/dagPose.html]]
**Created via the {{{dagPose}}} command, used to store matrix data as a pose.  Most often used during skinning operations.
''Matrix Commands''
*[[dagPose|http://download.autodesk.com/us/maya/2010help/CommandsPython/dagPose.html]]
**Used to store and query matrix data in a {{{dagPose}}} node.  Most commonly used during skinning operations.
*{{{pointMatrixMult}}}   (mel script)
**This script returns the multiplication of a point and a matrix as an array of 3 doubles.  It is a wrapper around the {{{pointMatrixMult}}} node, which the script actually creates, modifies, gathers the return value, and then deletes.
**Located: {{{C:/Program Files/Autodesk/Maya<version>>/scripts/others/pointMatrixMult.mel}}}
*For //Python// related matrix commands see:  [[Working with matrices with Python]]
----
Syntax for authoring an identity transformation matrix:
{{{
matrix $m[4][4] = <<1, 0, 0, 0; 0, 1, 0, 0; 0, 0, 1, 0; 0, 0, 0, 1>>; }}} ---- Printing 4x4 matrix data: {{{ float$goo[] = getAttr myNode.worldMatrix;

for($i=1;$i<size($goo)+1;$i++)
{
print ($goo[$i-1] + " ");
if($i%4==0) print("\n"); } 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1 }}} Using {{{getAttr}}} on a matrix attr will return back a float array. But when you want to do matrix math, you have to use the {{{matrix}}} variable type. These funtions will convert back and forth between the two: {{{ global proc matrix floatArrayToMatrix(float$m[]){
if(size($m) != 16) error("Please pass in a float array with exactly 16 elements"); matrix$mat[4][4] = <<$m[0],$m[1], $m[2],$m[3];
$m[4],$m[5], $m[6],$m[7];
$m[8],$m[9], $m[10],$m[11];
$m[12],$m[13], $m[14],$m[15]>>;
return $mat; } }}} {{{ global proc float[] matrixToFloatArray(matrix$m){
float $return[] = {}; for($row=0; $row<4;$row++){
for($column=0;$column<4; $column++)$return[size($return)] =$m[$row][$column];
}
return $return; } }}} ---- Match the worldspaceMatrix of objectB to objectA: {{{ string$source = "pCube1";
string $destination = "pCube2"; float$m[16] = getAttr ($source+".worldMatrix"); xform -worldSpace -matrix$m[0] $m[1]$m[2] $m[3]$m[4] $m[5]$m[6] $m[7]$m[8] $m[9]$m[10] $m[11]$m[12]$m[13]$m[14] $m[15]$destination;
}}}
This will work, no matter what any parental groups have done to the nodes.  Sweet.
----
Another snippet:
Have a destination node match the position of a hierarchy of source nodes.  In this scene, "pCube1" is parented to "group1".  The below code will match the worldspace matrix of "pCube2" to the postion of "pCube1" by multiplying the local matrices of "group1" and "pCube1" together.
{{{
string $sourceParent = "group1"; string$sourceChild= "pCube1";
string $destination = "pCube2"; // query the local matrix of the parent and child matrix$matrixSP[4][4] = floatArrayToMatrix(getAttr ($sourceParent+".matrix")); matrix$matrixSC[4][4] = floatArrayToMatrix(getAttr ($sourceChild+".matrix")); // Generate our new destination matrix, order is important! matrix$dPos[4][4] = $matrixSC *$matrixSP;

float $m[16] = matrixToFloatArray($dPos);

xform -worldSpace  -matrix $m[0]$m[1] $m[2]$m[3]
$m[4]$m[5] $m[6]$m[7]
$m[8]$m[9] $m[10]$m[11]
$m[12]$m[13] $m[14]$m[15] $destination; // it worked. Trust me. }}} *http://sourceforge.net/projects/colladamaya/ **At the time of this authoring, this only supports up to Maya2009 *http://opencollada.org/ **Seems to have more current stuff *http://colladamaya.sourceforge.net/ ** ? http://usa.autodesk.com/adsk/servlet/pc/item?siteID=123112&id=10775855 Includes: *FBX plugin - Multiple OS's, Maya versions, 32\64-bit. *FBX converter (standalone app) *FBX ~QuickTime Viewer Quality links you should know about, having to do with Maya, and mel: ---- 'Official': *[[Autodesk's|http://usa.autodesk.com/adsk/servlet/home?siteID=123112&id=129446]] site. (So long Alias...) *[[Maya Documentation|http://usa.autodesk.com/adsk/servlet/index?siteID=123112&id=8782084]]: Online, for multiple versions. *[[Current release notes|http://usa.autodesk.com/adsk/servlet/index?siteID=123112&id=13710407&linkID=10809894]] *[[Autodesk Subscription|http://subscription.autodesk.com/sp/servlet/home/index?siteID=11564774&id=11595437]] - Need to log in here first **[[Autodesk Maya e-Learning|http://subscription.autodesk.com/sp/servlet/elearning/course?catID=11484791&cfID=Autodesk+Maya&siteID=11564774]] - Can find podcasts buried in here. **[[Ask Autodesk|http://forums.ask.autodesk.com/category.jspa?categoryID=1010]] forums. <<< These sites appear to be down, or lost to the Autodesk takeover. *[[Autodesk Support & Service|http://pointa.autodesk.com/local/enu/portal/signin.jsp?po=enu]] (need to log in here first to access the next two items) **The [[Maya Annex|http://www.alias.com/glb/eng/support/maya.jsp]] **[[Maya Podcasts|http://www.alias.com/glb/eng/support/maya/podcasts/index.jsp]] (in the Annex) <<< *Maya's '[[Bonus Tools|http://area.autodesk.com/downloads/plugins?word=bonus+tools&where=1&software=8&script=&os=]]' *[[Maya Station|http://mayastation.typepad.com/]] blog. (I *think* this can be considered official) *[[Autodesk Area Maya Forum|http://area.autodesk.com/forum/autodesk-maya/]] *[[Autodesk Area Maya Python Forum|http://area.autodesk.com/forum/autodesk-maya/python/]] *[[Autodesk Area Maya SDK Forum|http://area.autodesk.com/forum/autodesk-maya/sdk/]] ---- 'Unofficial': *[[Creative Crash|http://www.creativecrash.com/maya/home]]'s Maya forums. *[[CG Society|http://forums.cgsociety.org/]]'s (~CGTalk) Maya forums. *[[Maya Wiki|http://www.tokeru.com/t]] over at tokeru.com. And they have a pile more links. *[[Brian Ewerts|http://ewertb.soundlinker.com/maya.htm]] mel page (''great'' stuff!). I leared a lot from this page when I was just getting started with mel. *[[python_inside_maya|http://groups.google.com/group/python_inside_maya?hl=en]] Google Group. *List of [[Script Editor Replacements]]. *[[::SOuP|http://www.soup-dev.com/]] : ~SOuP is a collection of nodes for Maya that are based on the principles of building a flexible, non-destructive procedural pipeline. ---- 'Books' *Scripting\Programming: **[[Maya Python for Games and Film|http://www.amazon.com/Maya-Python-Games-Film-Reference/dp/0123785782]] (Amazon), [[Homepage|http://www.maya-python.com/]] (with code examples) ***As of this authoring, the more current book for authoring Python code in Maya. Gives a good overview of Python itself, how it integrates in Maya, Object Oriented Programming, touches on ~PyMel, authoring UI's with Qt, how data works in Maya, & designing scripted plugins via the API. While it doesn't get as in-depth into the API stuff as 'Complete Maya Programming', this is all written in //Python// (compared to the former which is all c++), which makes it far more approachable. Definitely the book to get. **[[Complete Maya Programming|http://www.amazon.com/Complete-Maya-Programming-Extensive-Kaufmann/dp/1558608354/ref=pd_bbs_sr_1?ie=UTF8&s=books&qid=1204144080&sr=1-1]] ***I've read this, recommended. **[[Complete Maya Programming Volume 2|http://www.amazon.com/Complete-Maya-Programming-Vol-Depth/dp/0120884828/ref=pd_bbs_sr_3?ie=UTF8&s=books&qid=1202404517&sr=8-3]] **[[MEL Scripting for Maya Animators|http://www.amazon.com/Scripting-Animators-Kaufmann-Computer-Graphics/dp/0120887932/ref=pd_bbs_sr_1?ie=UTF8&s=books&qid=1202404517&sr=8-1]] ***I've read this, recommended. **[[Processing: A Programming Handbook for Visual Designers and Artists|http://www.amazon.com/Processing-Programming-Handbook-Designers-Artists/dp/0262182629/]] ***I've read this, recommended. It focuses on the [[Processing|2008 02 18]] programming language (wrapper around Java), but it has direct application to mel, and is a great overview to the world of programming and scripting. *Rigging **[[Inspired 3D Advanced Rigging and Deformations|http://www.amazon.com/Inspired-3D-Advanced-Rigging-Deformations/dp/1592001165/ref=pd_bbs_11?ie=UTF8&s=books&qid=1202404700&sr=8-11]] **[[Inspired 3D Character Setup|http://www.amazon.com/Inspired-Character-Setup-Michael-Ford/dp/1931841519/ref=pd_bxgy_b_img_b]] ***The 'Inspired' series of books always seem to have some good fundamentals in them. Good place to start for character setup \ rigging. ---- Got any other suggestions? Let [[me|WarpCat]] know...  This post has a pretty extensive overview: http://around-the-corner.typepad.com/adn/2012/06/maya-compiler-versions.html Ran into a great bug in Maya 2010 on Win7: *Made a window, with a {{{modelPanel}}} displaying a custom camera. *In that {{{modelPanel}}}, I 'isolate select' certain objects. *If I save with the window //open//, it crashes Maya: It locks Maya up immediately after save. *If I turn off 'isolate select' on the window and rebuild it, the problem goes away. How to solve? This is the method I came up with: *Override Maya's 'save' and 'save as' menu commands via [[this code|How can I trigger an event when the scene saves?]] *When I override that code, I detect if my custom window is open, and I delete it. *When the window deletes, I have a custom {{{scriptJob}}} running that executes on that window deletion, and it in turn physically deletes the custom modelPanel in the window. *Deleting that model panel in turn stops the 'isolation selection' for it, since its deleted. *However, I have to wrapper the standard Maya 'save code' in my override code (above) with '{{{evalDeferred}}}' commands, or the scene will save faster than the window is deleted, and it will still hang. What a pain! Ever since Maya switched its back-end to QT, I've noticed some instability, that has continued up to Maya 2014. During certain window commands, usually based around their deletion, but sometimes their creation, calling to these commands can cause Maya to crash. For example, in a script you call to {{{deleteUI}}} to delete a window. And when you do this, Maya crashes. Or at some point in a script you create a window, and it causes Maya to crash. How can you make this work? As it turns out, you need to '{{{evalDeferred}}}' the creation\deletion. Without this step, Maya will continue to crash: {{{ import maya.cmds as mc # Create a window safely (by calling to some window creation class): mc.evalDeferred(lambda *args:MyWindow(), lowestPriority=True) # Delete a window safely by string name: if mc.window("myWindow", exists=True): mc.evalDeferred(lambda *args:mc.deleteUI("myWindow"), lowestPriority=True) }}}  In this example, we have an Python object (made via [[OOP|How does Object Oriented Programming work in Python?]]), but we want to access the attributes of that object //in Maya//, via ''mel''. How to do so? But also, //why// would you want to? The why: For me, I have a lot of older mel scripts doing work. But now a-days I like to do all my scripting in Python. So what I end up with are new tools in Python, but being wrappered and executed with older mel procedures that still chug along. Plus, a Python 'object' is a much more complex data structure than a mel procedure: A mel procedure can only return back a single type of variable (string, int, float array, etc). But with a Python object you can query many different types of data, which is extremely handy. We are also limited again by mel's variable types: It has nothing of a greater complexity like Python's dictionaries, or 'lists (arrays) within lists within lists...'. So if you're using mel to query a more complex data structure in Python, you //first// need to prepare that data //in Python// to be received happily by mel. For example, mel has no idea what a Python dictionary is, so you'd first, in Python, need to split the dictionary apart into variable containers that mel could understand. Here is a simple Python object, as defined by a class. Presume that this file is called {{{MayaTestObj.py}}} and it is saved in Maya's Python path. It has some float, string, and list variables ready to be queried, all mel consumable. From the above discussion, these values //could// have been derived from a more complex Python dictionary, and then made ready for mel consumption. {{{ # Python code # MayaTestObj.py class MObject(object): def __init__(self): self.floatVar = 23.23 self.stringVar = "a string" self.listVar = ["A", "list", "of", "strings"] def __str__(self): return "A Python object trying to live in Maya..." def getFloat(self): return self.floatVar def getString(self): return self.stringVar def getList(self): return self.listVar }}} Now, for interacting with it in mel. We have to use the mel {{{python}}} command to pull in the data we're after: {{{ // mel code global proc getPyObjData() { // First import the module: python("import MayaTestObj"); // Create our object: python("obj = MayaTestObj.MObject()"); // See what our object has to say for itself: python("print obj"); // Now lets grab our variables: float$floatVar = python("obj.getFloat()");
string $stringVar = python("obj.getString()"); string$listVar[] = python("obj.getList()");

// and print the results:
print ($floatVar + "\n"); print ($stringVar +"\n");
print $listVar; } getPyObjData(); }}} {{{ A Python object trying to live in Maya... 23.23 a string A list of strings }}} It should be noted we're calling to the object's 'get' methods to access the attribute data. You //could// call directly to the attributes themselves if no 'get' methods existed, but this is slightly frowned upon, and the get methods should be provided: {{{ float$floatVar = python("obj.floatVar");
// Result: 23.23 //
}}}

I installed ~UltraEdit.  I like ~UltraEdit.  In the process it asked me if it should be the 'default application' for HTML files.  Sure, why not?  Later in Maya, I try to access the docs either through the F1 help, or through the mel:
{{{
help -doc ls;
}}}
And I get an error window:
>Windows cannot find '~UltraEdit.htm\shell\open\command'. Make sure you typed the name correctly, and then try again.
This looks like a registry issue, and sure enough it was.  Long story short, I needed to update (in Windows 7, via regedit.exe) this:
*Computer
**~HKEY_CLASSES_ROOT
***.htm
****(Default) :  Data : Change to -> "~FirefoxHTML"
Since Firefox is my default browser.  I've also seen "~ChromeHTML" for Google Chrome, and "htmlfile" for Internet Explorer.
*Circumference
**Pi (3.14) times Diameter : C = pi * d
*Diameter:
**2 times the Radius :  d = 2 * R
**Circumference / pi : C / pi
*Radius:
**Half the Diameter : R = d / 2
*Area
**Pi times the radius squared : A = pi * r^^2
Python has some shortcuts you can implement when passing arguments to mel commands (or other Python functions).
Take for example a sphere (named {{{pSphere1}}}) that you want to scale.  Here is the basic mel to do so:
{{{
float $scaleVals[] = {1.0, 2.0, .5}; // optionA: setAttr pSphere1.scale -type double3$scaleVals[0] $scaleVals[1]$scaleVals[2];
// optionB also works:
setAttr pSphere1.scale $scaleVals[0]$scaleVals[1] \$scaleVals[2];
}}}
Likewise in Python, you can do something very similar:
{{{
import maya.cmds as mc

scaleVals = [1, 2, .5]
# optionA:
mc.setAttr("pSphere1.scale", scaleVals[0], scaleVals[1], scaleVals[2], type="double3")
# optionB also works:
mc.setAttr("pSphere1.scale", scaleVals[0], scaleVals[1], scaleVals[2])
}}}
However, in Python you can pass all the args in as a list\tuple variable by prefixing the variable name with an asterisk '*'. The function (mel command) will unpack the variable as individual positional arguments. It's important that the variable have the same number of items as the command expects argument values, or a Python {{{RuntimeError}}} exception will be raised:
{{{
# option C, much cleaner!:
mc.setAttr("pSphere1.scale", *scaleVals)
}}}
You can see more about how this argument system works over on my [[Python Wiki|http://pythonwiki.tiddlyspot.com/#argument]].
I keep forgetting this, so I'll make a note:

Outliner -> Display -> Container Contents :
*Under Container
*Under Parent
*Both
*None
----
To modify to dispay 'under container':
{{{
outlinerEditor -e -showContainerContents 1 outlinerPanel1;
outlinerEditor -e -showContainedOnly 1 outlinerPanel1;
}}}
To modify to display 'under parent' (which I prefer...):
{{{
outlinerEditor -e -showContainerContents 0 outlinerPanel1;
outlinerEditor -e -showContainedOnly 0 outlinerPanel1;
}}}
From my bud Te:
----
When you get windows 7 and you use your pen (for weighting or whatever) you might enjoy disabling all the crap that 7 puts on the pen:
<<<
For those of you who use a wacom  here is a link to help remove all of the annoyances dealing with windows 7.

http://forum.wacom.eu/viewtopic.php?f=3&t=2146

first .. start > (then search for) services.msc > scroll down until you find Tablet PC Input Serv...
(right click) : stop > (then right click) properties > startup type : disable.
<<<
{{{aimConstraint}}}s are great, much more stable for handling rotations than {{{orientConstraint}}}s or {{{parentConstraint}}}s (in my experience).  But they too have their bugs.

One of the options you can set during creation is a '{{{worldUpType}}}', which can be set to a variety of options, one of which is '{{{object}}}'.  This allows you to then set the {{{worldUpObject}}} to be the name of a given node.  The result makes the local {{{upVector}}} of your constrained object aim at this '{{{worldUpObject}}}' //position//.

However, sometimes.... it doesn't aim correctly at all.  Or, even worse, the //rotation// values of your '{{{worldUpObject}}}' effect the orientation of your aimed object, (poorly imitating the effect of having the {{{worldUpType}}} set to '{{{objectrotation}}}').  Why?

I've (finally) tracked this down:  If you ''freeze transforms'' ({{{makeIdentity}}} command) on your '{{{worldUpObject}}}', it... screws up... the aim constraint system.  Or, even more nefarious:  If you're authoring 'locators' via code ({{{spaceLocator}}} command) to use as your {{{worldUpObject}}}, you have the option to give them a default '{{{position}}}'.  This has the same effect as creating them at the origin, moving them to that position, and freezing their transforms there.  {{{worldUpObject}}} = fail.  You need to make them at the origin, and then translate them to their required position, and //not// freeze their transforms.

I haven't looked into the technicalities of the reasons behind this.  But I'm happy enough just to know: ''don't freeze transforms on your '{{{worldUpObject}}}''' ;)
When using parentConstraints or orientConstraints, you run into the problem of the constraints 'flipping' during blended rotational transitions.
This usually occurs when the difference between the set of corresponding target rotational axes becomes greater than 180 degrees.
Meaning:
*If you have objectA constrained to targetA, you can rotate targetA all you want, way past +-180 degrees and all will be well.
*However, if you have objectA constrained to targetA and targetB, and a rotation axis on targetB is +-180 different from the corresponding axis on targetA, as you blend your constraint weights, rotational value flipping will ensue will ensue on objectA.
Why is this happening?  My guess is that internally, the constraints are comparing and blending between the [[matrices|Matrix info]] of the two nodes.  Since matrices store orientation data as vectors, those vectors have no concept of a '720 degree' (for example) rotation.  They simply point in that direction, and blend between the shortest distance.
----
Solutions:
WIP :)
*Many constraints have the option of changing their {{{.interpType}}} attr to '{{{cache}}}'.  I have see this fix the problem, but unfortunately animators don't like it, since it tends to screw up the 'scrubbing' of the animation:  It behaves like dynamics, since the cached data is based on the frames before:  if you scrub, the cache becomes confused and introduces other glitches.
I've heard of this both happening in a Maya session, and in API calls.

I've been told that if an expression doesn't 'reference an attribute', then it can cause it to not always execute.  And by 'reference an attribute' I mean:
{{{
foo.tx = 5;
}}}
In that expression, there is a clear reference to an attribute.

However, you could run into trouble here:
{{{
move 0 5 0 foo.tx;
}}}
Sine you're now calling to the move command to do the work, and not referencing an attribute directly.

A hack I'm told that works is to simply have the expression update some dummy attr on a node.  You could create a dummy attr specifically for this, or set the visibility on a node:
{{{
move  0 5 0 foo.tx;
foo.dummy = 1;
}}}
(from Doug Brooks)
On Windows XP, this can happen.  The common fix is this:
*Find your maya.exe file:
{{{
C:\Program Files\...\MayaX.X\bin\maya.exe
}}}
*'Right Mouse Button' on it -> Properties -> Compability
*Check "Run this program in compability mode for:"
*And choose "Windows 2000"

Sometimes when you try to load a plugin, it may toss some esoteric error\warning and fail.  Maya plugins (.mll's) are really just .dll's (Dynamic Link Libraries).  The Maya .mll may be dependent on other dll's on your disk, that you don't have yet installed (the same way that scripts can point to other scripts\procs).  But knowing what your mll is missing can be hard.

''Until now:''
*http://www.dependencywalker.com/
This gives you the (free) "depends.exe" application that will break down what a mll (or dll) is looking for, so you can figure out if you're missing it or not.

Thanks to Doug Brooks for tip.
Your last line may be missing a semicolon:   {{{;}}}
*Example code, that would have a problem:
{{{
// this is a script called foobar.mel
proc foo(){
print "bar\n";}
foo  //  <--- missing the semicolon
}}}
{{{
source foo;
// Error: foo //
// Error: "C:/scripts/foo.mel" line 4.3: Syntax error //
}}}
*The last line, "foo" has no semicolon after it.  This will cause Maya to error when either the script is sourced, (or, if 'proc foo()' was instead 'global proc foo()', then it would error when executed).  Add the semicolon, it'll be happy:
{{{
// this is a script called foobar.mel
proc foo(){
print "bar\n";}
foo;  //  <--- has the semicolon
}}}
{{{
source foo;
bar
}}}
http://download.autodesk.com/us/maya/2011help/API/class_m_vector.html
{{{
# Python code
from maya.OpenMaya import MVector

# In counter-clockwise direction, vertex positions, based on their IDs in
# Maya. If they were clockwise, the normal will face in the other direction.
vA = MVector(0,0,0)
vB = MVector(1,0,0)
vC = MVector(0,.5,.5)
}}}
{{{
# Calculate vectors from A to B and A to C:
vAB = vB - vA
vAC = vC - vA
# Get the cross product, which is the vector perpendicular to the two,
# which is the normal.  MVector ^ operator = cross product.
cross = vAB ^ vAC
# Normalized (length=1) version of the cross product:
normal = cross.normal()
}}}
{{{
# Shorthand of above code:
normal = (vB-vA ^ vC-vA).normal()
}}}
{{{
# Results:
print normal.x, normal.y, normal.z
# 0.0 -0.707106781187 0.707106781187
}}}
Below is a bunch of notes I took while listening to a presentation done by ''Andrea Maiolo'' & ''Tim Naylor'' on their //Bi-directional constraint// rigging system.  Stuck them here mainly just to put them //somewhere// where I wouldn't loose them.  Really, these notes have nothing to do with that constraint system, and more of just a big brain-dump of technical Maya know-how.
<<<
*  Two passes in the DG:
**  The  Push Update Request: 'dirty propogation' pass,
**  Pull Latest Computed Data
* Coordinate Spaces:
** Euclidean - Infinite planes.
** Cartesian - 3d scene with origin.  Ordered valued system in the Euclidean system.  Maya viewport is a Euclidean to Cartesian conversion.
**Polar
**Cylindrical
** Homogenous
* Handedness : Cartesian to Euclidean conversion:  Maya is 'right handed':
** Right hand in front of you:  Thumb is up, pointer is forward, middle finger is left:
**  Pointer is +X, thumb is +Y, middle is -Z.  An 'orthagonal' coordinate system.
**  Positive rotation values go counter-clockwise.
* Vectors:  a direction with a magnitude.
**  Dot Product : Compare directions of two vectors.
***     Normalize vecs before comparing.
***     Returns value between -1 and 1:  -1 = parallel but opposite directions.
***     0 = not parallel.  1 = parallel.
**  Cross Product:  Perpendicular vector of two input vecs
***     Normal vecs first
***     Useful for building orthogonal transforms from vectors.
MEL - sees things as vectors.  API distinguishes between vectors & points.
*  Homogenous Coordinates :  Used to descrive a projection onto an infinite plane. Find a point on an infinitly plane, and you need to convert it to cartesian space, you use the homogenouse coordinate to convert it.
**  Allows for euclidean to cartesian conversion.
**  From infinite space (euclidean) to finite space (cartesian) requires 4 dimensions
**  Positions in space represented as X, Y, Z, W
***  W = Scalar for convertsion from euclidean to cartesian.
**  Vector : direction with arbitrary origin, inifitely long
**  Point : position from a given origin
**  Homogenous vector = << X, Y, Z, 0>>
**  Homogenous point = X, Y, Z, 1
*  The base of all rotations in Maya are vectors.
*  Each Unit vector has it's own XYZ components.  Angle of rotations is calculated from these vectors.
**A matrix is a structure for holding multiple elements that can be recorded or extracted easily and represents useful information to the end user.
*  The fourth (right) column in a 4x4 matrix holds the homogenous scalar values.
*  Each matrix has its own identity, transpose (flip diagonally), and inverse matrix (swapping rows and colums).
*  Can be multipled but are not associateve:  B*A != A*B
*  Multiply matrices in Maya from row to column
*  Transformation matrices are post-multiplied in Maya
Build a point constraint between cube and pyramid:
*  Make VectorProduct node
**  has matrix input
*  Take worldmatrix attr from your cube and feed into matrix input of vectorProduct node
*  Change vectorProduct node operation to 'point matrix product':  Will extract the translation of the worldmatrix.
*  The output of the vectorProduct node is the worldspace translation values of the cube.
*  Make another vectorProduct node, and connect pyramid's parent inversive matrix into it:
**This tells me where the parent of the pyramid is in worldspace.  The path the parentmust take to get back to the origin.
*  Connect the first vectorProduct nodes output (cube's worldspace translation) into the second vectorProduct nodes Input1.  Now in the second vectorProduct node you'll see the worldspace translation values in it's input1 section in the attr editor.
*  Set second vector prodcut node 'operation' to 'Point Matrix Product'.  Which will set it's output to basically be the local space of the pyramid.
*  Connect the output from the second vector product and connect it to the translation of the pyramid.
*  Pyramid now follows cube!
When you use getAttr to query a matrix in Maya, it causes the DG to eval to give
you the most current data.  How do you query this without making the DG eval?  the .matrix attr of a node is output only, so it is only updaed (causing the DG to update)
when it is queried.
*  Invert the parent invert matrix gives you the parent matrix.
**The parent matrix * node matrix = where the node is in worldspace.
*  To apply this to a 'driven node', you multiply the driven nodes inverseParentMatrix times the world-matrix previously generated to get its new local position.
<<<
General numric notes for a 32-bit machine based on c\c++.
| ''Type'' | ''data range'' | ''bits'' | ''data type'' | ''Maya attr type'' |
| boolean | 0 or 1, True or False | 1 | binary | bool |
| byte | -128 -> 127 | 8 | integer | byte |
| unsigned byte | 0 -> 255 | 8 | integer | |
| char | -128 -> 127 | 8 | integer, stored as letters with single quotes in c\c++: 'A' is 65 | char |
| unsigned char | 0 -> 255 | 8 | integer, stored as letters with single quotes in c\c++: 'B' is 66 | |
| int \ short | -32,768 -> 32,767 | 16 | integer | short  |
| unsigned int \ short |  0 ->  65,535 | 16 | integer | |
| long |  -2,147,483,648 -> 2,147,483,647 | 32 | integer | long  |
| unsigned long | 0 -> 4,294,967,295 | 32 | integer | |
| float | -3.4028235E^^38^^ -> 3.4028235E^^38^^ | 32 | floating point | float |
| double | -1.7E^^308^^ -> 1.7E^^308^^ | 64 | floating point | double |
http://msdn.microsoft.com/en-us/library/s3f49ktz.aspx
[[Online Maya 2011 Docs|http://download.autodesk.com/us/maya/2011help/API/class_m_script_util.html]]
From the docs:
<<<
Utility class for working with pointers and references in Python.

Many of Maya's API methods require that one or more of their parameters be passed as pointers or references. Their return values, too, can be pointers or references.

In Python parameters of class types are passed by reference but parameters of simple types, like integers and floats, are passed by value, making it impossible to call those API methods from Python. @@The ~MScriptUtil class bridges this gap by providing methods which return pointers to values of simple types and which can extract values from such pointers. These pointers can also be used wherever an API method requires a reference to a simple type or an array of a simple type.@@
<<<
So while we have this nice class for dealing with c++ pointers '{{{*}}}' and references '{{{&}}}', it's not the easiest thing to understand.
This class also exposes some related helper functions discussed below.

Looks like the Maya 2011 docs have finally give some examples, but before that was around this blog post did a great job of covering how to use it:
http://www.chadvernon.com/blog/resources/maya-api-programming/mscriptutil/
The first example is pulled directly from it (slightly modified), for archival purposes:
----
!!!Pointer generation examples:
''int reference'':
This c++ class expects a int reference ({{{int&}}}) to be passed in.
{{{
MStatus MItMeshPolygon::setIndex( int index, int& prevIndex )
}}}
To make an int pointer you:
#Make a {{{MScriptUtil}}} object
#Update the {{{MScriptUtil}}} with default int data.
#Return a int pointer that can be used.
#Pass that pointer to the requiring method.
#Optional: Query the value of the updated pointer.
{{{
import maya.OpenMaya as om

itPoly = om.MItMeshPolygon(pathShape)
util = om.MScriptUtil()
util.createFromInt(0)
pInt = util.asIntPtr()
itPoly(faceId, pInt)
}}}
----
''array \ list reference'':
There appears to be two different ways to pass lists of Python data to a pointer.  I'm currently not too sure if one is preferable over the either.  But the below example explains the two systems:
{{{
import maya.OpenMaya as om

# Some list of Python ints:
intList = [0,1,2,3]

# Example A:
utilA = om.MScriptUtil()
# Create the pointer from a defined list of four items:
utilA.createFromList(intList, 4)
# Return a pointer object as an 'int 4':
pointerA = utilA.asInt4Ptr()
# You'd pass pointerA to another class for modification...
# Then you'd extract updated values:
resultA = [utilA.getInt4ArrayItem(pointerA, 0, i) for i in range(len(intList))]
print resultA

# Example B:
utilB = om.MScriptUtil()
# Create the pointer by unpacking our int list:
utilB.createFromInt(*intList)
# Return a pointer as an int (and in our case an array of them):
pointerB = utilB.asIntPtr()
# You'd pass pointerB to another class for modification...
# Then you'd extract updated values:
resultB = [utilB.getIntArrayItem(pointerB, i) for i in range(len(intList))]
print resultB
}}}
{{{
[0, 1, 2, 3]
[0, 1, 2, 3]
}}}
*In 'Example A' you can see from the methods being called that every step of the way you need to tell the system how big the passed in list is.  The methods either have the number '4' in their name, or need it passed in as an argument.
*'Example B' is much more flexible as far as both passing data, and extracting it:  You only need to know how big the original list was at the very end, to extract the resultant data.  The {{{getIntArrayItem()}}} method will not raise an exception if you ask for an index outside the original list size range, so you need to only pull the indices based on the original list size.
!!!Helper Functions
These return new {{{OpenMaya}}} objects based on passed in Python lists.  For some reason, __they're not included in the documentation__.
*{{{MScriptUtil.createMatrixFromList()}}} : Return an {{{OpenMaya.MMatrix}}} object.
*{{{MScriptUtil.createFloatMatrixFromList()}}} : Return an {{{OpenMaya.MFloatMatrix}}} object.
*{{{MScriptUtil.createIntArrayFromList()}}} : Return an {{{OpenMaya.MIntArray}}} object.
*{{{MScriptUtil.createFloatArrayFromList()}}} : Return an {{{OpenMaya.MFloatArray}}} object.
*{{{MScriptUtil.createFromList()}}} : Not sure?
If you use Maya, and mel, then your brain may identify with these links.  Pulled from my personal collection, enjoy.
*http://www.makezine.com/
*http://www.ted.com/
*http://www.instructables.com/
*http://www.processing.org/
*http://www.notcot.org/
*http://www.ponoko.com/
*http://graphics.pixar.com/
*http://www.buglabs.net/
*http://www.openmoko.com/
*http://www.arduino.cc/
*http://www.solarbotics.com/
*http://www.chumby.com/
*http://www.python.org/
*http://www.motionmountain.net/
*http://ocw.mit.edu/OcwWeb/
*http://www.metacritic.com/


If you use the version control software [[Perforce|http://www.perforce.com]] (P4), and you're reading this, you probably want a way to have Maya talk with it.  In the past I've written a large mel script to call out to the system and manage P4.  But since the release of Maya2008 which has Python on-board, we might as well ride on the shoulders of giants.

Perforce offers up tools to let Python talk with it.  I've documented this on my Python Wiki here:
{{{http://pythonwiki.tiddlyspot.com/#[[Perforce%20access%20via%20Python]]}}}
(due to formatting reasons, I couldn't get the link to work.  Please copy-paste)

However, to get this working in Maya takes an extra step.  Since Maya runs it's own custom cut of Python, it has those executables saved in a different location from the normal Python install.  When you run the P4\Python installer executable, it'll put the resources in a location that Maya doesn't see it.  ~Maya-Python looks here for 'site-packages' in Python:
{{{
C:\Program Files\Autodesk\Maya<version>\Python\lib\site-packages\
}}}
While 'raw' Python looks here:
{{{
C:\Python<version>\Lib\site-packages\
}}}
When you install P4\Python integration, they go into the //Python// site-packages, not the //~Maya-Python// site-packages.  Copying over the files (listed in my Python Wiki link) seems to work a-ok.
//Or//, you could make another script dir in your ~Maya-Python path, and put the modules there of course.
While not specifically Maya related, this post does a great job of covering concepts and pseudo-code (Python-ish) behind it:
http://freespace.virgin.net/hugo.elias/models/m_perlin.htm
Great page covering many physics topics from cloth simulation to inverse kinematics:
http://freespace.virgin.net/hugo.elias/models/m_main.htm
While not directly Maya related, much of the pseudo-code supplied is easily transferrable to Python.
Recently ran into a problem after importing a fbx file, where Maya's Hypershade\Multilister wouldn't properly pick the shaded components for a given material.  So I wrote this code that does the right thing:
{{{
# Python Code
# Pick materials in the Hypershade:  This will select all objects\components
# they affect:
import maya.cmds as mc

material = mc.ls(selection=True, materials=True)
if len(material):
pick = []
shaders = mc.listConnections(material, source=False, destination=True, type='shadingEngine')
if shaders:
for s in shaders:
stuff = mc.sets(s, query=True)
if stuff:
pick.extend(stuff)
if len(pick):
mc.select(pick)
else:
print "No shaded items found"
else:
print "Please pick one or more materials"
}}}
I've heard this used successfully (Maya 2013):
*Format: qt (quicktime)
*Encoding: H.264, or Sorenson Video
*Quality: 50%
*Display size: Custom, 1280 x 820
*Scale: .5
Notes:  15 sec clip is about 5 megs.
Thanks for the tip TJ ;)
Note:  I have an older subject found [[here|Executing external functions via UI's authord in Python]] that also sheds light on this issue.
<<<
''Update'', bit of an addendum to the '{{{lambda}}}' code below:  The Maya 2010 docs describe using the Python module [[functools|http://docs.python.org/library/functools.html]] under '[[Custom UI using a Python class|http://download.autodesk.com/us/maya/2010help/index.html?url=WS73099cc142f48755f2fc9df120970276f7-2158.htm,topicNumber=d0e183276]]'.  Specifically using {{{functools.partial}}}
Here's a code snippet:
{{{
import functools
# inside your UI:
mc.button(command=functools.partial(self.myMethod, someVal))
# presuming myMethod() was expecting a single arg
}}}
I've found that this will work in rare situations when {{{lambda}}} won't.
<<<
When creating UI controls, one of the several ways of accessing the data is via "positional arguments".  This is data the control can pass back to callback functions when executed (via say, their "changeCommand", or "command" argument).  For example, if you make a {{{floatFieldGrp}}} with three fields, you can use 'positional arguments' to directly intercept those values when modified. But how can you actually do this?
----
The Maya docs loosely cover this here:
''Maya Help -> Using Maya -> General -> Python -> Python -> Using Python -> Positional arguments'' (at the bottom).
Here is a link to the [[online docs|http://download.autodesk.com/us/maya/2008help/General/Using_Python.html]] reference above.  Read that section to get an understanding if the two different methods available.
----
In a nutshell:
*Method #1:  Embedding the callback in a string, using Python string formatting to grab the results:
{{{
mc.floatSlider( cc="print '%(1)s'" )
}}}
**The Python '{{{%(1)s}}}' syntax says capture the first {{{(1)}}} positional arg, and convert it to a string {{{%s}}} for printing.  The UI control returns its positional args as a Python {{{dictionary}}}, that are then passed into the string formatting.
**Given the above example, and presuming that the {{{floatSlider}}} was dragged and produced a value of 3.65, this would be a representation of how the command was being formatted behind the scenes, just before execution:
{{{
print '%(1)s' % {'1': 3.65}
# In the dictionary {}, the '1' represents the first positional arg,
# and 3.65 is the value assigned to it.
}}}
**See Python docs [[online|http://docs.python.org/library/stdtypes.html#string-formatting-operations]]
*Method #2: Uses a //compiled function//, where Maya passes the control's positional arguments to the function.  It's important that your callback function can handle any number of args (usually via {{{*args}}}) since depending on the control type, it can return back a different number of args.
{{{
def genericCallback( *args ):
print( "args: " + str ( args ) )
mc.button( command=genericCallback )
}}}
It should be noted that using method #2, I've found two different approaches:  using the compiled function technique (above), //or// wrappering the compiled function in the Python {{{lambda}}} expression.  What is {{{lambda}}} you may ask?  See notes on my [[Python Wiki|http://pythonwiki.tiddlyspot.com/#%5B%5BUnderstanding%20lambda%5D%5D]].  Easier than describing it all here :)
----
Here's a practical example in a UI, using all three methods on a random selection of UI controls, with notes afterwords:
{{{
import maya.cmds as mc

class PyTempWindow(object):
def __init__(self):
self.showWindow()

def genericCallback(self, *args):
print "Callback args: " + str(args)

def showWindow(self):
if mc.window("PyTempWindow", exists=True):
mc.deleteUI("PyTempWindow")

mc.window("PyTempWindow", title="Positional arg callback UI", resizeToFitChildren=True)
mc.columnLayout(adjustableColumn=True, columnAttach=('both', 5))

mc.text(label="Printed Positional Args:", align="left")
mc.floatSlider(changeCommand="print 'Positional args: %(1)s'")
mc.floatFieldGrp(numberOfFields=3, changeCommand="print 'Positional args: %(1)s %(2)s %(3)s'")
mc.textField(changeCommand="print 'Positional args: %(1)s'")
mc.button(command="print 'Positional args: %(1)s'", label="Positional")
mc.textFieldButtonGrp(changeCommand="print 'Positional args: %(1)s'", buttonCommand="print 'Positional args: %(1)s'")
mc.separator(height=20)

mc.text(label="Callback Function:", align="left")
mc.floatSlider(changeCommand=self.genericCallback)
mc.floatFieldGrp(numberOfFields=3, changeCommand=self.genericCallback)
mc.textField(changeCommand=self.genericCallback)
mc.button(command=self.genericCallback, label="Callback")
mc.textFieldButtonGrp(changeCommand=self.genericCallback, buttonCommand=self.genericCallback)
mc.separator(height=20)

mc.text(label="Lambda Callback Function:", align="left")
mc.floatSlider(changeCommand=lambda *args:self.genericCallback(args, "Custom Lambda Arg"))
mc.floatFieldGrp(numberOfFields=3, changeCommand=lambda *args:self.genericCallback(args, "Custom Lambda Arg"))
mc.textField(changeCommand=lambda *args:self.genericCallback(args, "Custom Lambda Arg"))
mc.button(command=lambda *args:self.genericCallback(args, "Custom Lambda Arg"), label="Callback")
mc.textFieldButtonGrp(changeCommand=lambda *args:self.genericCallback(args, "Custom Lambda Arg"), buttonCommand=lambda *args:self.genericCallback(args, "Custom Lambda Arg"))

mc.showWindow()

win = PyTempWindow()
}}}
So what's going on the the above UI?
*In the first "positional arg" section, the commands are embedded directly into the UI itself, using positional arguments and Pythons string formatting notation.
*In the middle section, the commands are calling to a callback function.  Note in the syntax that the callback function isn't being executed in the control command (there is no parenthesis at the end of it: '{{{changeCommand=self.genericCallback}}}'), there is just a pointer back to the callback function.  This is because a UI control command can only execute strings (the first example) and functions //without arguments// (this example).
*In the bottom section, commands are calling to the callback function, but that's being wrappered in a {{{lambda}}} expression.  Things of note:
**{{{lambda}}}'s return 'anonymous functions':  A function object that can then be executed.
**'{{{lambda *args}}} : this lets the {{{lambda}}} intercept all incoming arguments, and then pass them on to their returned function.
**Since {{{lambda}}}'s //are// 'anonymous functions', this lets then both accept //and// 'pass on' arguments to their containing functions, circumventing the issue of UI's 'only being able to execute functions without args'.  Nice.  In the above examples '{{{lambda *args:self.genericCallback(args, "Custom Lambda Arg")}}}', you can see that the {{{lambda}}} both passes on any //positional args// provided by the UI control when executed, and its own arg: {{{"Custom Lambda Arg"}}}.
----
''What's the result of all of this?''
----
Print result from ''Printed Positional Args'' section, with random UI fiddling (with UI type listed before each):
{{{
# floatSlider:
Positional args: 5.28
# floatFieldGrp:
Positional args: 0.0 3 0.0
# textField:
Positional args: foo
# button:
Positional args:
# textFieldButtonGrp (textField)
Positional args: asdf:
# textFieldButtonGrp (button)
Positional args: %(1)s
}}}
Notes:
*The {{{button}}} returns an empty positional arg.
*The {{{textFieldButtonGrp}}} button returned back a literal string of the string formatting instead of an actual positional arg value.  Odd.  Maybe this is because it actually returns back no positional arguments at all (illustrated below).
----
Print result from ''Callback Function'' section, with random UI fiddling (with UI type listed before each):
{{{
# floatSlider:
Callback args: (u'6.6',)
# floatSliderGrp:
Callback args: (u'0.0', u'3', u'0.0')
# textField:
Callback args: (u'asdf')
# button:
Callback args: (u'')
# textFieldButtonGrp (textField):
Callback args: (u'asdf')
# textFieldButtonGrp (button)
Callback args: ()
}}}
Notes:
*The return value is captured as a Python {{{tuple}}}.  A {{{tuple}}} is an immutable (unchangeable) list.  Based on our {{{genericCallback()}}}, each item in the {{{tuple}}} is turned into a string for printing purposes.
*Like above, the {{{button}}} returned an empty positional arg.
*Here, it can be plainly visualized that the {{{textFieldButtonGrp}}} 'button' returned back //no positional args// to be captured.
----
Print result from ''Lambda Callback Function'' section, with random UI fiddling (with UI type listed before each):
{{{
# floatSlider
Callback args: ((u'11.222',), 'Custom Lambda Arg')
# floatSliderGrp
Callback args: ((u'0.0', u'3', u'0.0'), 'Custom Lambda Arg')
# textField
Callback args: ((u'asdf',), 'Custom Lambda Arg')
# button
Callback args: ((u'',), 'Custom Lambda Arg')
# textFieldButtonGrp (textField):
Callback args: ((u'asdf',), 'Custom Lambda Arg')
# textFieldButtonGrp (button)
Callback args: ((), 'Custom Lambda Arg')
}}}
Notes:
*The return is very similar to the 'Callback Function' section.  But note that rather than printing a list filled with multiple items, the 1st position is another {{{tuple}}}, which has specifically captured the positional arguments from the UI command.
*Since {{{lambda}}} lets us pass our own arguments into the callback, in addition to capturing the //positional arguments// of the control itself, our custom {{{"Custom Lambda Arg"}}} string is listed last.
*This gives another clear indication that the {{{button}}} returns back an empty positional arg, while the {{{textFieldButtonGrp}}} button command returns back no positional args at all.
A shortcut for printing lots of info when it comes to the {{{workspace}}} command.
{{{
# Python code
import maya.cmds as mc

def workspaceInfo():
"""
Print info based on the workspace command.
"""
print "openWorkspace:", mc.workspace(query=True, openWorkspace=True)
print "active:", mc.workspace(query=True, active=True)
print "baseWorkspace:", mc.workspace(query=True, baseWorkspace=True)
print "listWorkspaces:"
for item in mc.workspace(query=True, listWorkspaces=True):
print "\t", item
print "listFullWorkspaces:"
for item in mc.workspace(query=True, listFullWorkspaces=True):
print "\t", item
print "list:"
for item in mc.workspace(query=True, list=True):
print "\t", item
print "directory:", mc.workspace(query=True, directory=True)
print "rootDirectory:", mc.workspace(query=True, rootDirectory=True)
print "fileRule:"
fileRule = mc.workspace(query=True, fileRule=True)
for i in range(0, len(fileRule), 2):
print "\t", fileRule[i], fileRule[i+1]
print "fileRuleList:"
for item in mc.workspace(query=True, fileRuleList=True):
print "\t", item
print "variableList:"
for item in mc.workspace(query=True, variableList=True):
print "\t", item, mc.workspace(query=True, variableEntry=item)
print "shortName:", mc.workspace(query=True, shortName=True)
print "fullName:", mc.workspace(query=True, fullName=True)
}}}
{{{
workspaceInfo()
}}}

''Procedures''  (WIP)
*[[procedures|Procedures]]
**__Can contain__ (when defined):
***[[commands|Commands]]
***//executed// [[procedures|Procedures]] (no nested procedure definitions)
**__Can accept__ (when executed, depending on the procedure):
***procedure [[arguments|Arguments]]
**__Can provide__ (when executed, depending on the procedure):
***[[return values|Return Values]]  (as arguments to other procedures)
----
*Procedures are also known as 'functions' in other languages.
*Procedures can be both defined, and executed.  When defined, they can be //local// to the [[script|Scripts]] they were defined in, or //global//, meaning they're able to be seen by the outside world.  A script needs to be first sourced before any of the 'global procs' defined inside of it can be seen by external code.  However, "local" procedures are never seen outisde of the script they're defined in.
** Why would you want to use local procs?  :  To help remove possible name clashes:  Any global proc can be seen by any other proc or command.  But sometimes you may just want a little "helper" bit of code in a script, and it's not important that can't be seen by anything else outside of the scope of the script.
*A procedure definition can be filled with mel commands, or calls to other pre-defined procedures.  Procedures can be called in other procedures, but you can't 'nest' procedure definitions.
*Once a procedure is defined, it behaves just like a command.
*For example, pretend we have a script called foo.mel, and inside of it we'll make a global procedure definition, that contains one command ({{{print}}}):
{{{
// this is the script foo.mel

// this is a local proc, that is only seen inside of this script:
proc goo(){
print "local goo!\n";}

// this is the global proc, that has the same name as the script,
// so when the script is called to, this proc is executed:
global proc foo()
{
// call to our local proc.
goo;
print "foo!\n";
}
}}}
*After this script is saved on disk (and presuming it's been saved in Mayas [[script path|Script Paths]]), you need to make Maya aware of its existance.  You can either use the source command like so:
{{{
source foo.mel;
}}}
*Or highlight the block of code in the Script Editor, and define it using the //number pad// Enter button.
*This won't actually //execute// the procedure, it will simply let Maya know it exists, and later //be// executed.
*Once define, you can execute your {{{foo()}}} procedure (which lives in the {{{foo.mel}}} script) by typing it at the command line:
{{{
> foo;
local goo!
foo!
}}}
*  If you typed {{{goo}}} at the command line, you'd get an error:
{{{
> goo;
// Error: line 1: Cannot find procedure "goo". //
}}}
*Because {{{goo}}} is a local proc in script {{{foo.mel}}}.
**This COULD bring up some confusion though:  If you're editing this code in the script editor, highlight it, and execute that block, irregarless of wheter you specify a script to be local or global, it will become global during that Maya session.  However, restarting Maya will make the local scripts be local, and you can see this behavior.
Maya //mel// code to open a commandPort:
{{{
commandPort -name "127.0.0.1:7777";
commandPort -name ":7777";
commandPort -name "7777";
}}}
If I don't run //all three// of those lines, Processing gives me this Exception:
{{{
java.net.ConnectException: Connection refused: connect
}}}
----
Processing code to create a locator in Maya whenever the left mouse button is pressed.  This uses the {{{Client}}} library:
http://processing.org/reference/libraries/net/Client.html
{{{
// Import the Client library:
import processing.net.*;
Client mayaClient;

void setup(){
mayaClient = new Client(this, "localhost", 7777);
}

void draw(){
// nothing...
}

void mousePressed(){
if(mouseButton == LEFT){
float x = mouseX;
float y = mouseY * -1 + height; // convert to Maya coordinates
String mel = ("spaceLocator -p "+x+" "+y+" 0;");
mayaClient.write(mel);
ellipse(mouseX, mouseY, 4,4);
}
}
}}}
----
I got tipped off to this code from this blog post:  http://www.jfernsler.com/blog/?p=29
This site has a bunch of language comparisons, usually grouped into three or four per page:
http://hyperpolyglot.org/
~PyMel provides an [[Attribute|http://download.autodesk.com/global/docs/maya2014/en_us/PyMel/generated/classes/pymel.core.general/pymel.core.general.Attribute.html]] class for interacting with a node's attributes.
Quick overview on usage, using a joint node for an example, since it has a {{{type}}} attribute that doesn't behave as one would expect.  And for clarity, //node// refers to a physical node in Maya, while //object// refers to a Python/~PyMel class instance.
{{{
import pymel.core as pm
# This creates a Maya node called 'joint', and returns a PyNode wrapper for it:
j = pm.createNode('joint')
}}}
Node's attrs can be accessed by the same exact name as an attribute on the instanced ~PyNode object:  These object.attribute is a ~PyNode Attribute instance:
{{{
print type(j)
<class 'pymel.core.nodetypes.Joint'> # Subclass of PyNode
print type(j.side)
<class 'pymel.core.general.Attribute'>
}}}
This makes it very easy (with exceptions show below) to get and set values.
!!!Setting Values:
On any 'normal' attribute, you can access it on the ~PyNode directly.  To set the joint node's {{{.side}}} attr, set the coresponding attribute on the object:
{{{
j.side.set(1)
}}}
However, sometimes there are name collisions:  The ~PyMel ~DependNode superclass of the joint has a {{{type}}} //method// that takes over for the joint objects {{{type}}} //attribute//:
{{{
j.type.set(1)
# Error: 'function' object has no attribute 'set'
# Traceback (most recent call last):
#   File "<maya console>", line 1, in <module>
# AttributeError: 'function' object has no attribute 'set' #
}}}
In these cases, there are two options for accessing the attr:  You can wrap the string name of the attribute in the {{{attr}}} method, and call {{{set}}} on it:
{{{
j.attr('type').set(1)
}}}
Or optionally, you can create a whole new {{{Attriibute}}} object around the obj.attr combo, and set it directly:
{{{
jTypeAttr = pm.Attribute('%s.type'%j)
jTypeAttr.set(1)
}}}
!!!Getting Values:
Just like with {{{set}}}, you can use a {{{get}}} method on a given attribute:
{{{
sideVal = j.side.get()
}}}
And just like above, trying to do a get on a superclass overridden attribute causes problems:
{{{
typeVal = j.type.get()
# Error: 'function' object has no attribute 'get'
# Traceback (most recent call last):
#   File "<maya console>", line 1, in <module>
# AttributeError: 'function' object has no attribute 'get' #
}}}
So we jump through some hoops:
{{{
typeVal = j.attr('type').get()
}}}
or:
{{{
jTypeAttr = pm.Attribute('%s.type'%j)
typeVal = jTypeAttr.get()
}}}
!!! Connecting Attributes:
~PyMel has some nice shorthand:
{{{
# Connect two attrs:
myNode.someAttr >> otherNode.otherAttr
# or:
myNode.someAttr.connect(otherNode.otherAttr)
}}}
!!! Disconnecting Attributes:
{{{
myNode.someAttr // otherNode.otherAttr
# or:
myNode.someAttr.disconnect(otherNode.otherAttr)
# or to disconnect from all:
myNode.someAttr.disconnect()
}}}
!!!Locking & Unlocking:
{{{
myNode.someAttr.lock()
myNode.someAttr.unlock()
}}}
!!!Making keyable or unkeyable:
{{{
myNode.someAttr.setKeyable(True)
myNode.someAttr.setKeyable(False)
}}}
!!!Show in the Channel Box:
{{{
myNode.someAttr.showInChannelBox(True)
myNode.someAttr.showInChannelBox(False)
}}}
!!!Adding Attributes:
While {{{PyNodes}}} have an {{{addAttr}}} //method// (via the ~DependNode class), it seems non-functional.  You need to use the regular {{{addAttr}}} (~PyMel) command for that:
{{{
pm.addAttr(myNode, longName="someAttr")
}}}
!!!Deleting Attributes:
{{{
myNode.someAttr.delete()
}}}
----
Also see:
*[[PyMel : Attribute methods]]
Condensation of the ~PyMel [[Attribute|http://download.autodesk.com/global/docs/maya2014/en_us/PyMel/generated/classes/pymel.core.general/pymel.core.general.Attribute.html]] docs.
Also see: [[PyMel : Attribute Access]]
*{{{affected}}} : No docs
*{{{affects}}} : No docs
*{{{array}}} : Returns the array (multi) attribute of the current element
*{{{attr}}} : Returns {{{Attribute}}}
*{{{attrName}}} : String name of the attribute for this plug
*{{{children}}} : Wrapper for {{{attributeQuery -listChildren}}}
*{{{connect}}} : Connect the attributes of two dependency nodes and return the names of the two connected attributes.
*{{{delete}}} : Wrapper for {{{deleteAttr}}}
*{{{disconnect}}} : Disconnects two connected attributes.
*{{{elementByLogicalIndex}}} : find and return a plug with the given logical index.
*{{{elementByPhysicalIndex}}} :  find and return a plug with the given physical index.
*{{{elements}}} : Wrapper for {{{listAttr -multi}}} : Return a list of strings representing all the attributes in the array.
*{{{evaluate}}} : No docs
*{{{evaluateNumElements}}} : Return the total number of elements in the datablock of this array plug
*{{{exists}}} : Whether the attribute actually exists.
*{{{firstParent}}} : deprecated
*{{{get}}} :  returns the value of the named object’s attribute.
*{{{getAlias}}} : Returns the alias for this attribute, or None
*{{{getAllParents}}} : Return a list of all parents above this
*{{{getArrayIndices}}} : Get all set or connected array indices
*{{{getChildren}}} : Wrapper for {{{attributeQuery -listChildren}}}
*{{{getEnums}}} : Returns [[pymel.util.enum.EnumDict|http://download.autodesk.com/global/docs/maya2014/en_us/PyMel/generated/classes/pymel.util.enum/pymel.util.enum.EnumDict.html]] for the given attr.
*{{{getMax}}} : Wrapper for {{{attributeQuery -max}}}
*{{{getMin}}} : Wrapper for {{{attributeQuery -min}}}
*{{{getNumElements}}} : Return the total number of elements in the datablock of this array plug
*{{{getParent}}} : No doc description
*{{{getRange}}} : Wrapper for {{{attributeQuery -range}}}
*{{{getSiblings}}} : Wrapper for {{{attributeQuery -listSiblings}}}
*{{{getSoftMax}}} : Wrapper for {{{attributeQuery -softMax}}}
*{{{getSoftMin}}} : Wrapper for {{{attributeQuery -softMin}}}
*{{{getSoftRange}}} : Wrapper for {{{attributeQuery -softRange}}}
*{{{index}}} : Returns the logical index of the element this plug refers to
*{{{indexMatters}}} : No docs
*{{{info}}} : returns a string containing the name of the node this plug belongs to and the attributes that the plug refers to
*{{{inputs}}} : Wrapper for {{{listConnections -source 1 -destination 0}}}
*{{{insertInput}}} : connect the passed node.outAttr to this attribute and reconnect any pre-existing connection into node.inAttr
*{{{isArray}}} : determines if the plug is an array plug
*{{{isCaching}}} : Returns true if this plug or its attribute has its caching flag set
*{{{isChild}}} : This method determines if the plug is a child plug
*{{{isCompound}}} : This method determines if the plug is a compound plug
*{{{isConnectable}}} : Wrapper for {{{attributeQuery -connectable}}}
*{{{isConnected}}} : Determines if this plug is connected to one or more plugs
*{{{isConnectedTo}}} : Determine if the attribute is connected to the passed attribute
*{{{isDestination}}} : Determines if this plug is connected as a destination.
*{{{isDirty}}} : No docs
*{{{isDynamic}}} : Determines whether the attribute is of dynamic type or not.
*{{{isElement}}} : determines if the plug is an element plug
*{{{isFreeToChange}}} : Returns true if the plug’s value is allowed to be set directly.
*{{{isFromReferencedFile}}} :  determines whether this plug came from a referenced file
*{{{isHidden}}} : Wrapper for {{{attributeQuery -hidden}}}
*{{{isIgnoredWhenRendering}}} : Determines whether a connection to the attribute should be ignored during rendering.
*{{{isInChannelBox}}} : Returns true if this plug or its attribute has its channel box flag set
*{{{isKeyable}}} : Determines if this plug is keyable
*{{{isLocked}}} : Determines the locked state of this plug’s value
*{{{isMulti}}} : This method determines if the plug is an array plug
*{{{isNetworked}}} : determines if the plug is networked or non-networked.
*{{{isNull}}} : determines whether this plug is valid.
*{{{isProcedural}}} :  determines if the plug is a procedural plug
*{{{isSettable}}} : Wrapper for {{{getAttr -settable}}}
*{{{isSource}}} : Determines if this plug is connected as a source.
*{{{isUsedAsColor}}} : Wrapper for {{{attributeQuery -usedAsColor}}}
*{{{item}}} : Returns the logical index of the element this plug refers to.
*{{{lastPlugAttr}}} : No docs (but example)
*{{{lock}}} : Wrapper for {{{setAttr -locked 1}}}
*{{{logicalIndex}}} : Returns the logical index of the element this plug refers to.
*{{{longName}}} : No docs (but example)
*{{{name}}} : Returns the name of the attribute (plug)
*{{{node}}} : plugNode
*{{{nodeName}}} : The node part of this plug as a string
*{{{numChildren}}} : Return the total number of children of this compound plug.
*{{{numConnectedChildren}}} : Return the number of children of this plug that are connected in the dependency graph.
*{{{numConnectedElements}}} : Return the total number of connected element plugs belonging to this array plug.
*{{{numElements}}} : The number of elements in an array attribute.
*{{{outputs}}} : Wrapper for {{{listConnections -source 0 -destination 1}}}
*{{{parent}}} : No docs (but notes)
*{{{plugAttr}}} : No docs (but example)
*{{{plugNode}}} : No docs
*{{{remove}}} : ~removeMultiInstance
*{{{set}}} : Sets the value of a dependency node attribute.
*{{{setAlias}}} : Sets the alias for this attribute (similar to aliasAttr)
*{{{setCaching}}} : Sets whether this plug is cached internally
*{{{setDirty}}} : No docs
*{{{setEnums}}} : No docs
*{{{setKey}}} : creates keyframes for the specified objects, or the active objects if none are specified on the command line
*{{{setKeyable}}} : This overrides the default keyability of a plug set with {{{MFnAttribute::setKeyable}}}
*{{{setLocked}}} : Sets the locked state for this plug’s value
*{{{setMax}}} : No docs
*{{{setMin}}} : No docs
*{{{setNumElements}}} : The method is used to pre-allocate the number of elements that an array plug will contain.
*{{{setRange}}} : provide a min and max value
*{{{setSoftMax}}} : No docs
*{{{setSoftMin}}} : No docs
*{{{setSoftRange}}} : No docs
*{{{shortName}}} : No docs (but example)
*{{{showInChannelBox}}} : Sets whether this plug is displayed in the channel box.
*{{{siblings}}} : Wrapper for {{{attributeQuery -listSiblings}}}
*{{{type}}} : Wrapper for {{{getAttr -type}}}
*{{{unlock}}} : Wrapper for {{{setAttr -locked 0}}}
!!!High level notes as I learn ~PyMel
[[Main Documentation|http://download.autodesk.com/global/docs/maya2013/en_us/PyMel/index.html#pymel-for-maya]]
----
Common ~PyMel //''objects''// (Found under the 'Classes' section of the [[pymel.core.general|http://download.autodesk.com/global/docs/maya2013/en_us/PyMel/generated/pymel.core.general.html]] documentation):
*[[PyNode|http://download.autodesk.com/global/docs/maya2013/en_us/PyMel/generated/classes/pymel.core.general/pymel.core.general.PyNode.html#pymel.core.general.PyNode]] - [[Tutorial|http://download.autodesk.com/global/docs/maya2013/en_us/PyMel/pynodes.html]]
**Also see : [[PyMel : PyNode methods]]
*[[Attribute|http://download.autodesk.com/global/docs/maya2013/en_us/PyMel/generated/classes/pymel.core.general/pymel.core.general.Attribute.html#pymel.core.general.Attribute]] - [[Tutorial|http://download.autodesk.com/global/docs/maya2013/en_us/PyMel/attributes.html]]
----
''Data'' Types [[pymel.core.datatypes|http://download.autodesk.com/global/docs/maya2013/en_us/PyMel/generated/pymel.core.datatypes.html#module-pymel.core.datatypes]] (under 'Classes')
* Includes Matrix, Vector, etc, plus many math related functions.
* Can also be accessed as {{{pymel.core.dt}}}
''Node'' Types :[[pymel.core.nodetypes|http://download.autodesk.com/global/docs/maya2013/en_us/PyMel/generated/pymel.core.nodetypes.html#module-pymel.core.nodetypes]]
*Wrappers around all of Maya's nodes:  Joints, Transforms, Mesh, etc
* Can also be accessed as {{{pymel.core.nt}}}
''Component'' Types :[[pymel.core.general|http://download.autodesk.com/global/docs/maya2013/en_us/PyMel/generated/pymel.core.general.html#module-pymel.core.general]] (under 'Classes')
*Verts, edges, cv's etc.
<<<
When you see stuff like:
{{{
# Result: [nt.Transform(u'pPlane1'), nt.PolyPlane(u'polyPlane1')]
}}}
These are the 'node/component types'.
<<<
''UI'' Types : [[pymel.core.uitype|http://download.autodesk.com/global/docs/maya2013/en_us/PyMel/generated/pymel.core.uitypes.html#module-pymel.core.uitypes]]
* Can also be accessed as {{{pymel.core.ui}}}
----
Calling to mel:
[[pymel.core.language.Mel|http://download.autodesk.com/global/docs/maya2013/en_us/PyMel/generated/classes/pymel.core.language/pymel.core.languag`