Thread: [cgkit-commits] SF.net SVN: cgkit: [17] maya/trunk/maya_wrapper/doc/tex
Brought to you by:
mbaas
From: <mb...@us...> - 2006-07-04 13:02:29
|
Revision: 17 Author: mbaas Date: 2006-07-04 06:02:23 -0700 (Tue, 04 Jul 2006) ViewCVS: http://svn.sourceforge.net/cgkit/?rev=17&view=rev Log Message: ----------- Updates Modified Paths: -------------- maya/trunk/maya_wrapper/doc/tex/maya.tex maya/trunk/maya_wrapper/doc/tex/plugin.tex Modified: maya/trunk/maya_wrapper/doc/tex/maya.tex =================================================================== --- maya/trunk/maya_wrapper/doc/tex/maya.tex 2006-07-04 12:01:45 UTC (rev 16) +++ maya/trunk/maya_wrapper/doc/tex/maya.tex 2006-07-04 13:02:23 UTC (rev 17) @@ -15,7 +15,7 @@ \date{\today} %--------------------------------------------------------- % Version information -\release{0.9.2} +\release{0.9.3} \setreleaseinfo{} \setshortversion{1.0} %--------------------------------------------------------- Modified: maya/trunk/maya_wrapper/doc/tex/plugin.tex =================================================================== --- maya/trunk/maya_wrapper/doc/tex/plugin.tex 2006-07-04 12:01:45 UTC (rev 16) +++ maya/trunk/maya_wrapper/doc/tex/plugin.tex 2006-07-04 13:02:23 UTC (rev 17) @@ -1,20 +1,20 @@ % Python plugin -The Maya Python plugin defines two new MEL commands \code{python} and +The Maya Python plugin defines two new MEL commands \code{py} and \code{pySource} that can be used to execute Python source code within Maya. Together with the accompanying Python \code{maya} package a Python program can retrieve or manipulate any data within Maya. %-------------------------------------------------------- -\section{MEL command: {\tt python}} +\section{MEL command: {\tt py}} {\bf Synopsis:} \begin{verbatim} -python <string> +py <string> \end{verbatim} -The \code{python} command executes Python source code given as a string. The +The \code{py} command executes Python source code given as a string. The command is somewhat equivalent to the builtin MEL command \code{eval}. The string may either contain a single expression, a single statement @@ -23,17 +23,17 @@ environment are visible in subsequent calls: \begin{verbatim} -python "a=5"; -python "print a"; +py "a=5"; +py "print a"; \end{verbatim} -The namespace is shared by the \code{python} and the \code{pySource} +The namespace is shared by the \code{py} and the \code{pySource} command, so you can call Python functions stored in a file by first executing the file and then calling the functions: \begin{verbatim} pySource myscript; // execute the file myscript.py which defines a function spam() -python "spam()"; // invoke the Python function spam() and return its result +py "spam()"; // invoke the Python function spam() and return its result \end{verbatim} {\bf Return value:} @@ -77,5 +77,18 @@ None +%------------------------------------------------------------------- +\section{Environment variables} +\begin{description} +\item[MAYA_PY_ENABLE_THREADING] (Default: True) You can use this variable + to disable/enable support for multi-threading. When set to False you can + still create threads in your Python code but these threads will only run + while \code{py} or \code{pySource} is still running. After these commands + return, the threads will be blocked and only resume next time you invoke + some Python code. By setting this variable to True, the threads will continue + running after \code{py} or \code{pySource} have already returned. + By default, multi-threading is enabled. Valid values are \code{True}, + \code{False} (case-insensitive) or \code{1}, \code{0}. +\end{description} This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <mb...@us...> - 2006-10-04 13:48:08
|
Revision: 102 http://svn.sourceforge.net/cgkit/?rev=102&view=rev Author: mbaas Date: 2006-10-04 06:47:58 -0700 (Wed, 04 Oct 2006) Log Message: ----------- Update Modified Paths: -------------- maya/trunk/maya_wrapper/doc/tex/api.tex maya/trunk/maya_wrapper/doc/tex/initmaya.tex maya/trunk/maya_wrapper/doc/tex/install.tex maya/trunk/maya_wrapper/doc/tex/introduction.tex maya/trunk/maya_wrapper/doc/tex/maya.tex Added Paths: ----------- maya/trunk/maya_wrapper/doc/tex/remote.tex Modified: maya/trunk/maya_wrapper/doc/tex/api.tex =================================================================== --- maya/trunk/maya_wrapper/doc/tex/api.tex 2006-10-04 13:04:41 UTC (rev 101) +++ maya/trunk/maya_wrapper/doc/tex/api.tex 2006-10-04 13:47:58 UTC (rev 102) @@ -23,7 +23,8 @@ {\bf Float sequences:} -Instead of \class{MPoint} and \class{MVector} it is also possible +Instead of \class{MPoint}, \class{MVector}, \class{MFloatPoint}, +\class{MFloatVector} or \class{MColor} it is also possible to pass sequences with an appropriate number of floats. {\bf Automatic exception translation:} @@ -200,6 +201,16 @@ just modify the intermediate list containing the row and not the actual matrix. +% MFloatPoint +\subsection{\class{MFloatPoint}} + +The following \class{MFloatPoint} methods differ from their C++ +counterparts. + +\begin{methoddesc}{get}{} +Returns a list of 4 floats with the components of the point. +\end{methoddesc} + % MFloatVectorArray %\subsection{\class{MFloatVectorArray}} %{\em ...this class still contains some methods that cannot be called...} @@ -293,6 +304,27 @@ counterparts. \end{methoddesc} +% MGlobal +\subsection{\class{MGlobal}} + +The following \class{MGlobal} methods differ from their C++ +counterparts. + +\begin{funcdesc}{getOptionVarValueInt}{name} +This is the wrapper for MGlobal::getOptionVarValue(const MString \& name, int\& value). +The return value is a tuple (\var{bool}, \var{int}). +\end{funcdesc} + +\begin{funcdesc}{getOptionVarValueFloat}{name} +This is the wrapper for MGlobal::getOptionVarValue(const MString \& name, double\& value). +The return value is a tuple (\var{bool}, \var{float}). +\end{funcdesc} + +\begin{funcdesc}{getOptionVarValueStr}{name} +This is the wrapper for MGlobal::getOptionVarValue(const MString \& name, MString\& value). +The return value is a tuple (\var{bool}, \var{MString}). +\end{funcdesc} + % MMatrix \subsection{\class{MMatrix}} Modified: maya/trunk/maya_wrapper/doc/tex/initmaya.tex =================================================================== --- maya/trunk/maya_wrapper/doc/tex/initmaya.tex 2006-10-04 13:04:41 UTC (rev 101) +++ maya/trunk/maya_wrapper/doc/tex/initmaya.tex 2006-10-04 13:47:58 UTC (rev 102) @@ -11,7 +11,7 @@ in the (MEL) Script Editor you could type the following: \begin{verbatim} -python "import maya.initmaya"; +py "import maya.initmaya"; \end{verbatim} The initialization will perform the following actions: Modified: maya/trunk/maya_wrapper/doc/tex/install.tex =================================================================== --- maya/trunk/maya_wrapper/doc/tex/install.tex 2006-10-04 13:04:41 UTC (rev 101) +++ maya/trunk/maya_wrapper/doc/tex/install.tex 2006-10-04 13:47:58 UTC (rev 102) @@ -12,11 +12,12 @@ To install the Maya plugin do the following steps: \begin{enumerate} -\item Copy the plugin file (\file{sourcepy.mll} +\item Copy the plugin file (\file{sourcepy_*.mll} on Windows, \file{sourcepy.so} on Linux) into one of the Maya plugin directories (e.g. \file{maya/{\em version}/plug-ins}). \item (The following step can be skipped if you are using Windows) -Create an empty file \file{sourcepy.sog} and put it into the same +Create an empty file \file{sourcepy.sog} (it must be the same base name +than the actual plug-in) and put it into the same directory than the actual plugin. Without doing this the plugin will run and you can execute Python code, but you won't be able to import any Python extension module. @@ -39,7 +40,7 @@ (the Python plugin must already be loaded): \begin{verbatim} -python "import maya.initmaya"; +py "import maya.initmaya"; \end{verbatim} This will add the following menu items: Modified: maya/trunk/maya_wrapper/doc/tex/introduction.tex =================================================================== --- maya/trunk/maya_wrapper/doc/tex/introduction.tex 2006-10-04 13:04:41 UTC (rev 101) +++ maya/trunk/maya_wrapper/doc/tex/introduction.tex 2006-10-04 13:47:58 UTC (rev 102) @@ -11,7 +11,7 @@ \begin{itemize} \item A Maya plugin that integrates the Python interpreter into Maya. - This plugin defines two new MEL commands \code{python} and \code{pySource} + This plugin defines two new MEL commands \code{py} and \code{pySource} that allow executing Python source code given as a string or a file. \item A Python package \module{maya} that allows a Python program to communicate with Maya. The package provides Python versions of all MEL Modified: maya/trunk/maya_wrapper/doc/tex/maya.tex =================================================================== --- maya/trunk/maya_wrapper/doc/tex/maya.tex 2006-10-04 13:04:41 UTC (rev 101) +++ maya/trunk/maya_wrapper/doc/tex/maya.tex 2006-10-04 13:47:58 UTC (rev 102) @@ -86,6 +86,7 @@ \input{mel.tex} \input{api.tex} \input{gui.tex} +\input{remote.tex} \input{unittest.tex} %--- @@ -95,15 +96,62 @@ Here is a list of things that still have to be done: \begin{itemize} -\item api: Some SDK classes are still missing (mainly the message classes and some more MPx classes). -\item api: Some automatically generated methods cannot be invoked in Python because some input values are actually output values. -\item api: Friend functions are missing (some operators involving MVectors won't work because of this) +\item api: Some SDK classes are still missing (see below). +\item api: Some automatically generated methods cannot be invoked in Python or are missing entirely (because they take pointers as input and stuff like that) \item api: Automatic exception translation isn't implemented yet -\item api: The virtual method in the MPx classes don't have a safeguard yet to catch Python exceptions and convert them into an appropriate MStatus object. \item Some further convenience classes to access nodes and attributes are not implemented yet \item Python objects cannot be stored within scene files yet \end{itemize} +The following classes from the Maya 7 SDK are still missing (the new classes +from Maya 8 are missing as well): +\begin{itemize} +\item MClothConstraintBridge +\item MClothConstraintCmd +\item MClothControl +\item MClothEdge +\item MClothForce +\item MClothMaterial +\item MClothParticle +\item MClothPolyhedron +\item MClothSolverRegister +\item MClothSystem +\item MClothTriangle +\item MCursor +\item MDrawData +\item MFnFluid +\item MFnPluginData +\item MGeometryData +\item MHWShaderSwatchGenerator +\item MMeshIsectAccelParams +\item MMessageNode +\item MPx3dModelView +\item MPxComponentShape +\item MPxContextCommand +\item MPxDragAndDropBehavior +\item MPxFluidEmitterNode +\item MPxGeometryData +\item MPxGeometryIterator +\item MPxGlBuffer +\item MPxHwShaderNode +\item MPxIkSolver +\item MPxIkSolverNode +\item MPxManipContainer +\item MPxMidiInputDevice +\item MPxModelEditorCommand +\item MPxPolyTrg +\item MPxPolyTweakUVCommand +\item MPxSelectionContext +\item MPxSurfaceShape +\item MPxSurfaceShapeUI +\item MPxToolCommand +\item MPxTransform +\item MPxTransformationMatrix +\item MRenderCallback +\item MSeamInfo +\item MSwatchRenderRegister +\end{itemize} + %--------------------------------------------------------- \appendix Added: maya/trunk/maya_wrapper/doc/tex/remote.tex =================================================================== --- maya/trunk/maya_wrapper/doc/tex/remote.tex (rev 0) +++ maya/trunk/maya_wrapper/doc/tex/remote.tex 2006-10-04 13:47:58 UTC (rev 102) @@ -0,0 +1,44 @@ +\section{\module{remote} --- + Initialization functions} + +\declaremodule{extension}{maya.remote} +\modulesynopsis{Invoke MEL commands from external/remote scripts} + +\begin{funcdesc}{init}{server=None, port=None} +Initialize the remote mel module. \var{server} is a string containing +the server address to connect to. The server string may contain an +optional port number or you may specify the port number via the +\var{port} argument. + +This function must be called before \module{remote.mel} is imported, +otherwise it won't have an effect. +\end{funcdesc} + +% mel +\section{\module{remote.mel} --- Invoke remote MEL commands} +\declaremodule{extension}{maya.remote.mel} +\modulesynopsis{Invoke remote MEL commands} + +This module is similar to the top-level \module{mel} module with +the difference that it doesn't invoke MEL commands locally but +connects to a remote MEL server. This means, you can use this +module also in scripts that are running outside of Maya. + +By default, the module connects to localhost:4870. You can +connect to a different server by using the \function{maya.remote.init()} +function prior to importing \module{maya.remote.mel}. + +% melserver +\section{\module{remote.melserver} --- Contains the MEL server class} +\declaremodule{extension}{maya.remote.melserver} +\modulesynopsis{Contains the MEL server class} + +\begin{funcdesc}{startMELServer}{address=None, port=None} +Start the MEL server thread. \var{address} is the address of the server +(default: localhost), \var{port} is the port number where the server +is listening. +\end{funcdesc} + +\begin{funcdesc}{stopMELServer}{} +Stop the MEL server thread. +\end{funcdesc} This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <mb...@us...> - 2006-10-08 15:10:23
|
Revision: 114 http://svn.sourceforge.net/cgkit/?rev=114&view=rev Author: mbaas Date: 2006-10-08 08:10:17 -0700 (Sun, 08 Oct 2006) Log Message: ----------- Updates Modified Paths: -------------- maya/trunk/maya_wrapper/doc/tex/api.tex maya/trunk/maya_wrapper/doc/tex/license.tex Modified: maya/trunk/maya_wrapper/doc/tex/api.tex =================================================================== --- maya/trunk/maya_wrapper/doc/tex/api.tex 2006-10-08 15:08:57 UTC (rev 113) +++ maya/trunk/maya_wrapper/doc/tex/api.tex 2006-10-08 15:10:17 UTC (rev 114) @@ -405,6 +405,20 @@ as it is again just \code{len(componentIds)}. \end{methoddesc} +% MPxCommand +\subsection{\class{MPxCommand}} + +The following \class{MPxCommand} methods differ from their C++ +counterparts. + +\begin{methoddesc}{getCurrentResultInt}{status=None} +This method gets the current node's result as a int, if possible. +\end{methoddesc} + +\begin{methoddesc}{getCurrentResultFloat}{status=None} +This method gets the current node's result as a Python float, if possible. +\end{methoddesc} + % MSceneMessage \subsection{\class{MSceneMessage}} Modified: maya/trunk/maya_wrapper/doc/tex/license.tex =================================================================== --- maya/trunk/maya_wrapper/doc/tex/license.tex 2006-10-08 15:08:57 UTC (rev 113) +++ maya/trunk/maya_wrapper/doc/tex/license.tex 2006-10-08 15:10:17 UTC (rev 114) @@ -39,7 +39,8 @@ 1.8.1. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently acquired, any and all of the rights conveyed herein. - +\end{verbatim} +\begin{verbatim} 1.9. "Modifications" means any addition to or deletion from the substance or structure of either the Original Code or any previous Modifications. When Covered Code is released as a series of files, a @@ -96,7 +97,8 @@ selling of Original Code, to make, have made, use, practice, sell, and offer for sale, and/or otherwise dispose of the Original Code (or portions thereof). - +\end{verbatim} +\begin{verbatim} (c) the licenses granted in this Section 2.1(a) and (b) are effective on the date Initial Developer first distributes Original Code under the terms of this License. @@ -155,7 +157,8 @@ License or the recipients' rights hereunder. However, You may include an additional document offering the additional rights described in Section 3.5. - +\end{verbatim} +\begin{verbatim} 3.2. Availability of Source Code. Any Modification which You create or to which You contribute must be made available in Source Code form under the terms of this License @@ -207,7 +210,8 @@ Modifications are Contributor's original creation(s) and/or Contributor has sufficient rights to grant the rights conveyed by this License. - +\end{verbatim} +\begin{verbatim} 3.5. Required Notices. You must duplicate the notice in Exhibit A in each file of the Source Code. If it is not possible to put such notice in a particular Source @@ -256,7 +260,8 @@ not governed by the terms of this License and distribute the Larger Work as a single product. In such a case, You must make sure the requirements of this License are fulfilled for the Covered Code. - +\end{verbatim} +\begin{verbatim} 4. Inability to Comply Due to Statute or Regulation. If it is impossible for You to comply with any of the terms of this @@ -316,7 +321,8 @@ COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY COVERED CODE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER. - +\end{verbatim} +\begin{verbatim} 8. TERMINATION. 8.1. This License and the rights granted hereunder will terminate @@ -367,7 +373,8 @@ all end user license agreements (excluding distributors and resellers) which have been validly granted by You or any distributor hereunder prior to termination shall survive termination. - +\end{verbatim} +\begin{verbatim} 9. LIMITATION OF LIABILITY. UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT @@ -424,7 +431,8 @@ work with Initial Developer and Contributors to distribute such responsibility on an equitable basis. Nothing herein is intended or shall be deemed to constitute any admission of liability. - +\end{verbatim} +\begin{verbatim} 13. MULTIPLE-LICENSED CODE. Initial Developer may designate portions of the Covered Code as This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |