Tools/Free/egDocStyle
From Osipa Entertainment
|
Wiki auto-generated by uMen.py on 1/27/2009. uMen is © 2009 Osipa Entertainment, LLC
All page contents are © Osipa Entertainment, LLC
egDocStyle.mel
This mel script is meant to provide examples of the various tags that you can use to get extra functionality out of the uMen menu. It is recommended that you open this script's autoUI through the uMen menu, open it in a text editor, and load it's wiki at : http://docs.osipaentertainment.com/index.php/Tools/Free/egDocStyle all at the same time so you can compare. This will allow you to see how each relates to the other. Keep in mind that the mel/py ( in this case, mel ) file is considered the "source" document, and that the autoUI and autoWiki are referring to it when they are created. Following the videos on the wiki will walk you through documentation and features, which this script itself is a working example of.
Comments with the 'doc' tag like these lines that occur BEFORE the first procedure will be considered documentation for the entire script. These appear in the "Documentation" tab in the autoUI and serve as the introduction material on the autoWiki.
A 'hlpDoc' tag before the first procedure is going to serve as either an absolute or relative link to a web page or a file location. If no 'hlpDoc' is included, the script's file name is appended to the wikiRoot (which you set this in the uMen setup window). This means you can have local and global references both working side-by-side. You can see osipaEntertainment documentation with an absolute link next to documentation of your own on an internal server, both working.
A 'hplVid' tag is currently only set up to handle youTube using a youTube video ID.
If you are reading this on a wiki page, what you are seeing is automatically generated wiki content created from parsing egDocStyle.mel.
All documentation will obviously be pushed to wiki format on the wiki, so any wiki formatting you use in the documentation will work, so technically, you can insert any kind of video or link anywhere in a doc tag, as long as it is valid wiki, like : this. Which will obviously clutter slightly in the autoUI and mel, but work in the wiki. This is the recommended way to add images. A tag like this:
Should work just fine. Remember that it needs to be behind a 'doc' tag to be picked up by the wiki creator.
If it isn't already obvious, either, this and the other two example scripts are WILDLY over-commented, but, that's because of their goals as examples, and by no means a suggestion that you should write 60 lines of comments for every line of code.
Demo & Training
Procedures
Global procedures available to be used
egDocStyle_nothing
Usage
egDocStyle_nothing ;
Synopsis
No description available
Return Value
None
egDocStyle_docTag
Usage
egDocStyle_docTag ;
Synopsis
By adding commenting with the 'doc' tag, you'll see this message in the maya autoUI, and as a description for this procedure in the autoWiki
Return Value
None
egDocStyle_defaults_noVarTags
Usage
egDocStyle_defaults_noVarTags "" << 0, 0, 0 >> 0.0 0 { "" } { << 0, 0, 0 >> } { 0.0 } { 0 } ;
egDocStyle_defaults_noVarTags $name $direction $amount $count $items $positions $lengths $numbers ;
Synopsis
The autoUI will build fields for all your variables, and inform you of the return type. The type of variable affects what pressing the button next to it will do. No matter what your variable type is, your selections of objects or attributes, will be used to fill in your variable's value when you press it's button. ( Or in the case of a bool, it toggles )
Variables
name, direction, amount, count, items, positions, lengths, numbers
| Name | Variable Type | Default value(s) |
| name | string | "" |
| direction | vector | << 0, 0, 0 >> |
| amount | float | 0.0 |
| count | int | 0 |
| items | string[] | { "" } |
| positions | vector[] | { << 0, 0, 0 >> } |
| lengths | float[] | { 0.0 } |
| numbers | int[] | { 0 } |
Return Value
string
egDocStyle_varDocTag
Usage
egDocStyle_varDocTag "" << 0, 0, 0 >> 0.0 0 { "" } { << 0, 0, 0 >> } { 0.0 } { 0 } ;
egDocStyle_varDocTag $name $direction $amount $count $items $positions $lengths $numbers ;
Synopsis
The 'varDoc' will create toolTips over the associated variable's are in the autoUI, as well as appear as descriptions for your variables on your autoWiki
Variables
name, direction, amount, count, items, positions, lengths, numbers
| Name | Variable Type | Default value(s) |
| name | string | "" |
- The name you'd like to use
| direction | vector | << 0, 0, 0 >> |
- The direction to point to
| amount | float | 0.0 |
- A 0-1 value to indicate how much to do something
| count | int | 0 |
- Run through a loop this many times
| items | string[] | { "" } |
- Affect these items
| positions | vector[] | { << 0, 0, 0 >> } |
- Send in positions as a vector, each array entry being an x, y, and a z
| lengths | float[] | { 0.0 } |
- This is how long each item is from the origin
| numbers | int[] | { 0 } |
- A list of numbers that aren't that interesting
Return Value
None
egDocStyle_varDrpTag
Usage
egDocStyle_varDrpTag "" << 0, 0, 0 >> 0.0 0 { "" } { << 0, 0, 0 >> } { 0.0 } { 0 } ;
egDocStyle_varDrpTag $name $direction $amount $count $items $positions $lengths $numbers ;
Synopsis
A 'varDrp' line is there to set a default, or many defaults (dropdowns) for a variable. They'll show up in the right mouse button popup for your variable buttons, and the first of them will be automatically entered into your variable's field in the autoUI. The list of default values will also appear in your autoWiki.
Variables
name, direction, amount, count, items, positions, lengths, numbers
| Name | Variable Type | Default value(s) |
| name | string | "a", "b", "c", "d" |
| direction | vector | << 5,5,5 >>, << 6,6,6 >>, << 7,7,7 >>, << 8,8,8 >> |
| amount | float | 0.1, 0.2, 0.3, 0.4 |
| count | int | 1, 2, 3, 4, 5 |
| items | string[] | { "a", "b", "c" }, { "d", "e", "f" } |
| positions | vector[] | { << 0, 0, 0 >>, << 1, 1, 1 >> }, { << 2, 2, 2 >>, << 3, 3, 3 >> } |
| lengths | float[] | { 0.0, 0.1, 0.2 }, { 0.3, 0.4, 0.5 } |
| numbers | int[] | { 1, 2, 3, 4 }, { 10, 11, 12, 13, 14 } |
Return Value
None
egDocStyle_varDocAndDrp
Demo & Training
Usage
egDocStyle_varDocAndDrp "" << 0, 0, 0 >> 0.0 0 { "" } { << 0, 0, 0 >> } { 0.0 } { 0 } ;
egDocStyle_varDocAndDrp $name $direction $amount $count $items $positions $lengths $numbers ;
Synopsis
Here's what a fully marked up procedure would look like to get maximum use of the autoUI and the autoWiki
Variables
name, direction, amount, count, items, positions, lengths, numbers
| Name | Variable Type | Default value(s) |
| name | string | "a", "b", "c", "d" |
- The name you'd like to use
| direction | vector | << 5,5,5 >>, << 6,6,6 >>, << 7,7,7 >>, << 8,8,8 >> |
- The direction to point to
| amount | float | 0.1, 0.2, 0.3, 0.4 |
- A 0-1 value to indicate how much to do something
| count | int | 1, 2, 3, 4, 5 |
- Run through a loop this many times
| items | string[] | { "a", "b", "c" }, { "d", "e", "f" } |
- Affect these items
| positions | vector[] | { << 0, 0, 0 >>, << 1, 1, 1 >> }, { << 2, 2, 2 >>, << 3, 3, 3 >> } |
- Send in positions as a vector, each array entry being an x, y, and a z
| lengths | float[] | { 0.0, 0.1, 0.2 }, { 0.3, 0.4, 0.5 } |
- This is how long each item is from the origin
| numbers | int[] | { 1, 2, 3, 4 }, { 10, 11, 12, 13, 14 } |
- A list of numbers that aren't that interesting
Return Value
None
egDocStyle_hlpVidTag
Demo & Training
Usage
egDocStyle_hlpVidTag ;
Synopsis
The 'hlpVid' tag will create a link to a youTube video in the autoUI and autoWiki page, the tag is merely the video's youTube ID
Return Value
None
Additional Information
Legals
Osipa Entertainment, LLC makes no guarantees or warranties related to download and/or use of any tools, mel and python scripts and plugins.
Although Osipa Entertainment provides some tools, mel and python scripts and plugins for free, it is it is prohibited to remove any of the documentation, copyright notices, and/or any references and links to Osipa Entertainment, LLC.
