updates

[bbtk.git] / kernel / doc / bbtkUsersGuide / bbtkUsersGuide.tex

diff --git a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
index ef94c95d8470b3e375a5ffb5dca1a1408f4e0fd6..045b66bd9484276c5b16c7bd870c7a41e55d1cbf 100644 (file)
--- a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
+++ b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
@@ -259,27 +259,44 @@ Package         & What it's used for \\ \hline
               Automatically assigned to Atomic Black Boxes (c++ defined)     \\ \hline
  \texttt{complex box}    & : System category.
               Automatically assigned to Complex Black Boxes (script defined) \\ \hline  
               Automatically assigned to Atomic Black Boxes (c++ defined)     \\ \hline
  \texttt{complex box}    & : System category.
               Automatically assigned to Complex Black Boxes (script defined) \\ \hline  

- \texttt{command line}   & : Script which defines a command line application (no embedded GUI, but command line imput parameters) \\ \hline
+ \texttt{command line}   & : Script which defines a command line application \\ 
+                         & :(no embedded GUI, but command line imput parameters) \\ \hline

  \texttt{demo}           & : Demonstration                             \\ \hline
  \texttt{devel}          & : Developer tool (bbCreatePackage.bbs, ...) \\ \hline
  \texttt{demo}           & : Demonstration                             \\ \hline
  \texttt{devel}          & : Developer tool (bbCreatePackage.bbs, ...) \\ \hline

- \texttt{dicom}          & : DICOM aware box \\ \hline 
+ \texttt{dicom}          & : DICOM aware box                            \\ \hline 

  \texttt{example}        & : Example script showing a box use-case      \\ \hline
  \texttt{filter}         & : Image processing box                       \\ \hline
  \texttt{image}          & : Image processing related box               \\ \hline
  \texttt{interaction}    & :                                            \\ \hline
  \texttt{example}        & : Example script showing a box use-case      \\ \hline
  \texttt{filter}         & : Image processing box                       \\ \hline
  \texttt{image}          & : Image processing related box               \\ \hline
  \texttt{interaction}    & :                                            \\ \hline

- \texttt{math}           & : Mathematical operations\\ \hline
- \texttt{mesh}           & : Mesh processing related box \\ \hline
+ \texttt{math}           & : Mathematical operations                    \\ \hline
+ \texttt{mesh}           & : Mesh processing related box                 \\ \hline

  \texttt{misc}           & : A box that cannot be put in other category ! \\ \hline
  \texttt{read/write}     & : Box that read or write data from or to disk  \\ \hline
  \texttt{misc}           & : A box that cannot be put in other category ! \\ \hline
  \texttt{read/write}     & : Box that read or write data from or to disk  \\ \hline

- \texttt{viewer}         & : Box which displays some data \\ \hline
- \texttt{widget}         & : Piece of graphical interface  \\ \hline 
+ \texttt{viewer}         & : Box which displays some data                \\ \hline
+ \texttt{widget}         & : Piece of graphical interface                \\ \hline 

  
  \texttt{3D object creator} & : Sophisticated 3D widget  \\ \hline  
  \texttt{toolsbbtk}         & : Component of bbStudio    \\ \hline  
 \end{tabular}
 \end{table}
 
  
  \texttt{3D object creator} & : Sophisticated 3D widget  \\ \hline  
  \texttt{toolsbbtk}         & : Component of bbStudio    \\ \hline  
 \end{tabular}
 \end{table}
 

+% ==========================================

 
 

+\begin{table}[!ht]
+\caption{\label{kinds} \texttt{Black Box} kinds}
+\small
+\begin{tabular}{|ll|}
+\hline
+\texttt{Kind name}                & : Meaning                         \\ \hline \\ \hline
+\texttt{ADAPTOR}                  & : Adaptor Box                     \\ \hline
+\texttt{DEFAULT\_ADAPTOR}         & :                                  \\ \hline
+\texttt{WIDGET\_ADAPTOR}          & :                                  \\ \hline
+\texttt{DEFAULT\_WIDGET\_ADAPTOR} & :                                  \\ \hline
+\texttt{GUI}                      & :                                  \\ \hline
+\texttt{DEFAULT\_GUI}             & :                                  \\ \hline
+\texttt{ALL}                      & : If kind='ALL' then sets the level for all kinds \\ \hline
+\end{tabular}
+\end{table}

 
 
 
 
 
 


@@ -2034,6 +2051,12 @@ Loads the package \texttt{package-name}\\ \hline
 \texttt{include} & \texttt{<package-name>} & 
 Loads the package \texttt{package-name} and includes all the complex black boxes that comes with it \\ \hline 
 
 \texttt{include} & \texttt{<package-name>} & 
 Loads the package \texttt{package-name} and includes all the complex black boxes that comes with it \\ \hline 
 

+\texttt{kind} & \texttt{<box kind>} & 
+Specifies the \texttt{kind} of the complex black boxes you are describing \\ \hline 
+
+
+
+

 \texttt{unload} & \texttt{<package-name>}& 
 Unloads the package \texttt{package-name}. 
 The package must have been previously loaded. 
 \texttt{unload} & \texttt{<package-name>}& 
 Unloads the package \texttt{package-name}. 
 The package must have been previously loaded. 


@@ -2078,7 +2101,6 @@ Starts the definition of a complex black box of type
 \texttt{endefine} & - & 
 Ends the definition of a complex black box type\\ \hline 
 
 \texttt{endefine} & - & 
 Ends the definition of a complex black box type\\ \hline 
 

-

 \texttt{author} & \texttt{<string>} & 
 Sets the author(s) of the complex black box currently being defined \\ \hline 
 
 \texttt{author} & \texttt{<string>} & 
 Sets the author(s) of the complex black box currently being defined \\ \hline 
 


@@ -2086,18 +2108,17 @@ Sets the author(s) of the complex black box currently being defined \\ \hline
 Sets the description of the complex black box currently being defined 
 \\ \hline 
 
 Sets the description of the complex black box currently being defined 
 \\ \hline 
 

-

 \texttt{input} & \texttt{<name>} \texttt{<box.input>} \texttt{<help>} & 
 Defines a new input for the current complex black box, 
 named \texttt{name}. 
 It is defined as corresponding to 
 \texttt{input} & \texttt{<name>} \texttt{<box.input>} \texttt{<help>} & 
 Defines a new input for the current complex black box, 
 named \texttt{name}. 
 It is defined as corresponding to 

-the input \texttt{input} of the box \texttt{box}. 
+the input \texttt{input} of the box \texttt{box}.
+ 

 \texttt{<help>} is the help string for the new input.
 The box \texttt{box} must already have been created in the complex box 
 and of course have an input named \texttt{input}.
 \\ \hline 
 
 \texttt{<help>} is the help string for the new input.
 The box \texttt{box} must already have been created in the complex box 
 and of course have an input named \texttt{input}.
 \\ \hline 
 

-

 \texttt{output} & \texttt{<name>} \texttt{<box.output>} \texttt{<help>} & 
 Defines a new output for the current complex black box, 
 named \texttt{name}. 
 \texttt{output} & \texttt{<name>} \texttt{<box.output>} \texttt{<help>} & 
 Defines a new output for the current complex black box, 
 named \texttt{name}.