[cgkit-commits] cgkit2/doc/tex asfamcimport.tex,NONE,1.1 bvhimport.tex,NONE,1.1 joint.tex,NONE,1.1 b

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

Update of /cvsroot/cgkit/cgkit2/doc/tex
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13316/tex

Modified Files:
	bvh.tex cgkit.tex events.tex ifsimport.tex offimport.tex 
	stlimport.tex targetcamera.tex 
Added Files:
	asfamcimport.tex bvhimport.tex joint.tex 
Log Message:
Updated the docs

Index: stlimport.tex
===================================================================
RCS file: /cvsroot/cgkit/cgkit2/doc/tex/stlimport.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** stlimport.tex	9 Jan 2005 20:13:07 -0000	1.1
--- stlimport.tex	17 Feb 2005 09:02:47 -0000	1.2
***************
*** 1,5 ****
  % STL import

! \subsection{STL import}

  The STL import plugin reads StereoLithography files (both ASCII and binary
--- 1,5 ----
  % STL import

! \subsection{StereoLithography (STL) import}

  The STL import plugin reads StereoLithography files (both ASCII and binary

Index: events.tex
===================================================================
RCS file: /cvsroot/cgkit/cgkit2/doc/tex/events.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** events.tex	9 Jan 2005 20:13:07 -0000	1.2
--- events.tex	17 Feb 2005 09:02:46 -0000	1.3
***************
*** 138,142 ****

  The \class{KeyEvent} class is passed as argument to the \code{KEY_PRESS}
! and \code{KEY_RELEAS} events. The class contains the attributes
  \code{key}, \code{keycode} and \code{mods} (see the constructor for
  a description).
--- 138,142 ----

  The \class{KeyEvent} class is passed as argument to the \code{KEY_PRESS}
! and \code{KEY_RELEASE} events. The class contains the attributes
  \code{key}, \code{keycode} and \code{mods} (see the constructor for
  a description).

Index: offimport.tex
===================================================================
RCS file: /cvsroot/cgkit/cgkit2/doc/tex/offimport.tex,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -C2 -d -r1.1.1.1 -r1.2
*** offimport.tex	12 Dec 2004 14:31:51 -0000	1.1.1.1
--- offimport.tex	17 Feb 2005 09:02:47 -0000	1.2
***************
*** 1,5 ****
  % OFF import

! \subsection{OFF import}

  The OFF import plugin reads \ulink{Geomview}{http://www.geomview.org/} 
--- 1,5 ----
  % OFF import

! \subsection{Geomview Object File Format (OFF) import}

  The OFF import plugin reads \ulink{Geomview}{http://www.geomview.org/} 

--- NEW FILE: asfamcimport.tex ---
% ASF/AMC import

\subsection{Acclaim Skeleton/Motion Capture file (ASF/AMC) import}

The ASF/AMC plugin reads Acclaim Skeleton Files (ASF) containing
the structure of a character and Acclaim Motion Capture (AMC) files
containing the actual motion.

You can read an ASF file alone in which case only the skeleton will
be read. When reading an AMC file, the plugin also has to read the
corresponding ASF file as this file contains information how to interpret
the data in the AMC file. By default, the plugin looks for an ASF file
with the same name than the AMC file but with suffix \code{.asf} instead
of \code{.amc}. If this file doesn't exist the plugin checks if the
directory contains only one ASF file and chooses this one. If this also
fails, an exception is generated and you should pass the ASF
file name explicitly as argument to the \function{load()} function.

The plugin supports the following options that can be passed to
the \function{load()} command when reading AMC files:

\begin{tableiii}{l|l|l}{code}{Option}{Default}{Description}
\lineiii{asf}{\code{None}}{The name of the corresponding skeleton file.}
\lineiii{framerate}{\code{30}}{The framerate of the motion data in the AMC file.}
\end{tableiii}

Index: targetcamera.tex
===================================================================
RCS file: /cvsroot/cgkit/cgkit2/doc/tex/targetcamera.tex,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** targetcamera.tex	10 Feb 2005 17:56:23 -0000	1.2
--- targetcamera.tex	17 Feb 2005 09:02:47 -0000	1.3
***************
*** 49,56 ****
  Return a ray whose origin is at the eye position and that goes through
  a given point on the image plane. The point on the plane is given by
! (\var{x0}, \var{y0}) which each ranges from -1 to 1. (-1,-1) is at the
! lower left and (1,1) at the upper right.  (0,0) is the center of the
! image. The arguments \var{width} and \var{height} determine the ratio
! of the image plane (the absolute values of \var{width} and
  \var{height} are irrelevant). The return value is a 2-tuple (\var{p}, \var{u})
  where \var{p} is the ray origin and \var{u} the normalized
--- 49,56 ----
  Return a ray whose origin is at the eye position and that goes through
  a given point on the image plane. The point on the plane is given by
! (\var{x0}, \var{y0}) which each ranges from 0 to 1. (0,0) is at the
! upper left and (1,1) at the lower right corner. The arguments \var{width} and
! \var{height} determine the ratio of the image plane (the absolute
! values of \var{width} and
  \var{height} are irrelevant). The return value is a 2-tuple (\var{p}, \var{u})
  where \var{p} is the ray origin and \var{u} the normalized
***************
*** 58,62 ****

  \begin{center}
! \includegraphics[width=9cm]{pics/cameraimgplane}
  \end{center}
  \end{methoddesc}
--- 58,62 ----

  \begin{center}
! \includegraphics[width=9cm]{pics/camera01}
  \end{center}
  \end{methoddesc}

--- NEW FILE: joint.tex ---
% Joint

\section{\class{Joint} ---
         Joint class for creating a skeleton}

\begin{classdesc}{Joint}{name = "", \\
			 radius = 0.05, \\
	                 rotationorder = "xyz"
		         }

\var{name} is the name of the joint.

\var{radius} is the radius of the visual representation of the joint/bone.

\var{rotationorder} determines the order of rotation about the individual
axes.
\end{classdesc}

A \class{Joint} has the following slots:

\begin{tableiv}{l|l|c|l}{code}{Slot}{Type}{Access}{Description}
\lineiv{anglex_slot}{float}{rw}{Angle around x axis}
\lineiv{angley_slot}{float}{rw}{Angle around y axis}
\lineiv{anglez_slot}{float}{rw}{Angle around z axis}
\end{tableiv}

\begin{memberdesc}{anglex}
Rotation angle about the local x axis.
\end{memberdesc}

\begin{memberdesc}{angley}
Rotation angle about the local y axis.
\end{memberdesc}

\begin{memberdesc}{anglez}
Rotation angle about the local z axis.
\end{memberdesc}

% Methods
\begin{methoddesc}{freezePivot}{}
Make the current pivot coordinate system the default pose. After
calling this method, the current rotation of the pivot coordinate
system will define the default pose. This means, rotations are now
defined around the local pivot axes.
\end{methoddesc}

Index: cgkit.tex
===================================================================
RCS file: /cvsroot/cgkit/cgkit2/doc/tex/cgkit.tex,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** cgkit.tex	10 Feb 2005 17:56:23 -0000	1.7
--- cgkit.tex	17 Feb 2005 09:02:46 -0000	1.8
***************
*** 160,163 ****
--- 160,164 ----
  \input{trimesh.tex}
  \input{group.tex}
+ \input{joint.tex}
  \input{targetcamera.tex}
  \input{freecamera.tex}
***************
*** 210,213 ****
--- 211,216 ----
  \input{objimport.tex}
  \input{stlimport.tex}
+ \input{asfamcimport.tex}
+ \input{bvhimport.tex}

  %---------------------------------------------------------

--- NEW FILE: bvhimport.tex ---
% BVH import

\subsection{Biovision Hierarchical (BVH) import}

The BVH plugin reads Biovision Hierarchical files containing a skeleton
definition for a character and a motion for the character.

Index: bvh.tex
===================================================================
RCS file: /cvsroot/cgkit/cgkit2/doc/tex/bvh.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** bvh.tex	10 Feb 2005 17:56:23 -0000	1.1
--- bvh.tex	17 Feb 2005 09:02:46 -0000	1.2
***************
*** 1,6 ****
  \section{\module{bvh} ---
!         Reading BioVision Hierarchical (BVH) motion capture files}

  \declaremodule{extension}{cgkit.bvh}
  \modulesynopsis{Reading BioVision Hierarchical (BVH) motion capture files}

--- 1,80 ----
  \section{\module{bvh} ---
!         Reading Biovision Hierarchical (BVH) motion capture files}

  \declaremodule{extension}{cgkit.bvh}
  \modulesynopsis{Reading BioVision Hierarchical (BVH) motion capture files}

+ This module contains the \class{BVHReader} class which can be used as a base
+ class for reading Biovision Hierarchical (BVH) 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.
+ 
+ \begin{classdesc}{BVHReader}{filename}
+   \var{filename} is the name of the BVH file that should be read.
+ \end{classdesc}
+ 
+ \begin{methoddesc}{read}{}
+ Read the entire file.
+ \end{methoddesc}
+ 
+ \begin{methoddesc}{onHierarchy}{root}
+ This method is called after the joint hierarchy was read. The entire 
+ hierarchy is passed in the argument \var{root} which is a \class{Node}
+ object.
+ \end{methoddesc}
+ 
+ \begin{methoddesc}{onMotion}{frames, dt}
+ This method is called when the motion data begins. \var{frames} is the
+ number of motion samples that follow and \var{dt} is the time interval
+ that corresponds to one frame.
+ \end{methoddesc}
+ 
+ \begin{methoddesc}{onFrame}{values}
+ This method is called for each motion sample (frame) in the
+ file. \var{values} is a list of floats that contains the position and
+ angles of the entire skeleton. The order is the same than when
+ traversing the joint hierarchy in a depth-first manner.
+ \end{methoddesc}
+ 
+ % ------------------------------------
+ \subsection{Node objects}
+ 
+ The \method{onHierarchy()} method of the \class{BVHReader} class takes
+ the joint hierarchy of the skeleton as input. Each node in this hierarchy
+ is represented by a \class{Node} object that contains all information
+ stored in the BVH file.
+ 
+ \begin{classdesc*}{Node}
+   A \class{Node} object represents one joint in the hierarchy.
+ \end{classdesc*}
+ 
+ \begin{memberdesc}{name}
+ This is the name of the joint (or the root).
+ \end{memberdesc}
+ 
+ \begin{memberdesc}{channels}
+ This is a list of channel names that are associated with this joint.
+ This list determines how many values are stored in the motion section
+ and how they are to be interpreted. Each channel name can be one
+ of \code{Xposition}, \code{Yposition}, \code{Zposition}, \code{Xrotation},
+ \code{Yrotation}, \code{Zrotation}.
+ \end{memberdesc}
+ 
+ \begin{memberdesc}{offset}
+ This is a 3-tuple of floats containing the offset position of this joint
+ relative to the parent joint.
+ \end{memberdesc}
+ 
+ \begin{memberdesc}{children}
+ This is a list of children joints (which are again described by
+ \class{Node} objects).
+ \end{memberdesc}
+ 
+ \begin{methoddesc}{isRoot}{}
+ Returns \code{True} if the node is the root node.
+ \end{methoddesc}
+ 
+ \begin{methoddesc}{isEndSite}{}
+ Returns \code{True} if the node is a leaf.
+ \end{methoddesc}

Index: ifsimport.tex
===================================================================
RCS file: /cvsroot/cgkit/cgkit2/doc/tex/ifsimport.tex,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -C2 -d -r1.1.1.1 -r1.2
*** ifsimport.tex	12 Dec 2004 14:31:46 -0000	1.1.1.1
--- ifsimport.tex	17 Feb 2005 09:02:47 -0000	1.2
***************
*** 1,5 ****
  % IFS import

! \subsection{IFS import}

  The IFS import plugin reads the Indexed Face Set (IFS) format that is
--- 1,5 ----
  % IFS import

! \subsection{Indexed Face Set (IFS) import}

  The IFS import plugin reads the Indexed Face Set (IFS) format that is

[cgkit-commits] cgkit2/doc/tex asfamcimport.tex,NONE,1.1 bvhimport.tex,NONE,1.1 joint.tex,NONE,1.1 b

[cgkit-commits] cgkit2/doc/tex asfamcimport.tex,NONE,1.1 bvhimport.tex,NONE,1.1 joint.tex,NONE,1.1 bvh.tex,1.1,1.2 cgkit.tex,1.7,1.8 events.tex,1.2,1.3 ifsimport.tex,1.1.1.1,1.2 offimport.tex,1.1.1.1,1.2 stlimport.tex,1.1,1.2 targetcamera.tex,1.2,1.3