[cgkit-commits] SF.net SVN: cgkit: [187] cgkit/trunk/doc/tex

[<mb...@us...>]

Revision: 187
          http://svn.sourceforge.net/cgkit/?rev=187&view=rev
Author:   mbaas
Date:     2006-12-01 07:21:27 -0800 (Fri, 01 Dec 2006)

Log Message:
-----------
Update

Modified Paths:
--------------
    cgkit/trunk/doc/tex/maimport.tex
    cgkit/trunk/doc/tex/mayaascii.tex

Modified: cgkit/trunk/doc/tex/maimport.tex
===================================================================
--- cgkit/trunk/doc/tex/maimport.tex	2006-12-01 14:13:18 UTC (rev 186)
+++ cgkit/trunk/doc/tex/maimport.tex	2006-12-01 15:21:27 UTC (rev 187)
@@ -8,7 +8,7 @@
 in cgkit.  So only those nodes are imported that have an equivalent
 component in cgkit.  Currently, these are cameras, light sources, raw
 geometry (polys, NURBS (wip)) and skeletons. Polygonal spheres, cubes
-and planes will be imported true spheres, cubes, planes if their ``creator''
+and planes will be imported as true spheres, cubes, planes if their ``creator''
 node is maintained. In all other cases, you should delete history on your
 objects in order to see the geometry in cgkit. You can also create 
 active and passive rigid bodies in Maya which will prepare those objects

Modified: cgkit/trunk/doc/tex/mayaascii.tex
===================================================================
--- cgkit/trunk/doc/tex/mayaascii.tex	2006-12-01 14:13:18 UTC (rev 186)
+++ cgkit/trunk/doc/tex/mayaascii.tex	2006-12-01 15:21:27 UTC (rev 187)
@@ -5,11 +5,15 @@
 \modulesynopsis{Reading Maya ASCII files}
 
 This module contains the \class{MAReader} class which can be used as a
-base class for reading Maya ASCII files. The class reads the file
+base class for reading Maya ASCII (*.ma) files. The class reads the file
 and invokes callback methods with the corresponding data in the
 file. Derived classes have to implement those callback methods and
 process the data as appropriate.
 
+The module also contains a couple of helper classes that may be
+used by a derived reader class to facilitate the processing of the
+data.
+
 %----------------------------------------------------------------
 \subsection{MAReader class}
 
@@ -168,6 +172,19 @@
 %----------------------------------------------------------------
 \subsection{Attribute class}
 
+The \class{Attribute} class can be used to convert the value of an
+attribute (as specified by the \code{setAttr} MEL command) into an
+appropriate Python value.
+
+An \class{Attribute} object is initialized with the arguments that
+were passed to the \method{onSetAttr()} callback of the reader
+class. The value can be retrieved using the \method{getValue()}
+method. Whenever you have prior knowledge of the node you are 
+currently processing you should pass the expected type of the
+attribute to the \method{getValue()} method to prevent the
+method from having to guess the type in case it is not specified
+in the \code{setAttr} call.
+
 \begin{classdesc}{Attribute}{attr, vals, opts}
 
 \var{attr}, \var{vals} and \var{opts} are the arguments of the 
@@ -191,7 +208,7 @@
 \end{methoddesc}
 
 \begin{methoddesc}{getValue}{type=None, n=None}
-Return the value of the attribute as appropriate Python value.
+Return the value of the attribute as an appropriate Python value.
 \var{type} is a string containing the required type of the value.
 If \code{None} is passed, the method tries to retrieve the value from
 the attribute itself. If it fails, an exception is thrown. The following


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.