\input{config.tex}
-\def\todo{\scriptsize\fbox{\bf TODO !!}\normalsize}
-\def\x{\bm{x}}
-\def\BBTK{{\xspace}The {\bf Black Box Toolkit} }
-\def\bbtk{{\xspace}$\texttt{bbtk}$ }
-\def\bbi{{\xspace}$\texttt{bbi}$ }
-\def\bbStudio{{\xspace}$\texttt{bbStudio}$ }
-\def\bbfy{{\xspace}$\texttt{bbfy}$ }
-\def\bbdoc{{\xspace}$\texttt{bbdoc}$ }
-\def\bbCreatePackage{{\xspace}$\texttt{bbCreatePackage}$ }
-
-\def\bb{{\xspace}$\texttt{bb}$ }
-%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
-
-\def\cmake{{\xspace}$\texttt{cmake}$ }
-
-\def\C{{\xspace}$\texttt{C}$ }
-\def\CPP{{\xspace}$\texttt{C++}$ }
-
-\def\xml{{\xspace}$\texttt{xml}$ }
-
-\def\itk{{\xspace}$\texttt{itk}$ }
-\def\vtk{{\xspace}$\texttt{vtk}$ }
-\def\gdcm{{\xspace}$\texttt{gdcm}$ }
-\def\gsmis{{\xspace}$\texttt{gsmis}$ }
-\def\wx{{\xspace}$\texttt{wxWidgets}$ }
-
-\def\lin{{\xspace}\textit{Linux} }
-\def\win{{\xspace}\textit{Windows} }
-
-% the same macros with no space at the end
-
-\def\BBTKns{{\xspace}The {\bf Black Box Toolkit}}
-\def\bbtkns{{\xspace}$\texttt{bbtk}$}
-\def\bbins{{\xspace}$\texttt{bbi}$}
-\def\bbfyns{{\xspace}$\texttt{bbfy}$}
-\def\bbdocns{{\xspace}$\texttt{bbdoc}$}
-\def\bbCreatePackagens{{\xspace}$\texttt{bbCreatePackage}$}
-
-\def\bbns{{\xspace}$\texttt{bb}$}
-%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
-
-\def\cmakens{{\xspace}$\texttt{cmake}$}
-
-\def\Cns{{\xspace}$\texttt{C}$}
-\def\CPPns{{\xspace}$\texttt{C++}$}
-
-\def\xmlns{{\xspace}$\texttt{xml}$}
-
-\def\itkns{{\xspace}$\texttt{itk}$}
-\def\vtkns{{\xspace}$\texttt{vtk}$}
-\def\gdcmns{{\xspace}$\texttt{gdcm}$}
-\def\gsmisns{{\xspace}$\texttt{gsmis}$}
-\def\wxns{{\xspace}$\texttt{wxWidgets}$}
-
-\def\linns{{\xspace}\textit{Linux}}
-\def\winns{{\xspace}\textit{Windows}}
-
-
-
\begin{document}
\begin{center}
{\Huge User's Guide}
\vspace{1cm}
-\bbtk version 1.0
+\bbtk version \bbtkVersion
\vspace{0.5cm}
-Last modified on : September 16, 2008 \\
+Last modified on : October 12, 2008 \\
Generated on : \today
\vspace{0.5cm}
-Laurent Guigues, Jean-Pierre Roux
+Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
+
+Creatis CNRS 5220, INSERM U620
\end{center}
% ==========================================
\newpage
% ==========================================
\hrule
-\section{What is {\bf bbtk} ?}
+\section{What is bbtk ?}
% ==========================================
\BBTK(\bbtkns) is a set of tools
(\CPP libraries and executables)
creaContours
creaImageIO
creaLib
+
+\end{verbatim}
+which depend on the OpenSource libraries:
+\begin{verbatim}
gdcm
itk
vtk
\item{\bf symbolic} means that a particular
input or output is referenced by a 'name', that is by a symbol
which identifies the input or output.
-It also means that symbolic information (text!) is
+It also means that symbolic information (text) is
attached to a box: description of the box, author,
description of its inputs and outputs, etc.
\end{itemize}
\BBTK provides one : \bbi (the Black Box Interpreter).
\item {\bf Automatic documentation} of existing packages.
\texttt{html} documentation of packages is proposed by
-\bbins.
+\bbStudions.
\end{itemize}
Finally, these different components allow {\bf efficient} :
\item {\bf\emph{std}} : the 'standard' package including basic useful boxes.
\item {\bf\emph{wx}} : basic graphical interface elements (widgets : sliders, buttons, etc. based on the \texttt{wxWidgets} library).
\item {\bf\emph{itk}} : the basic image processing package, based on the \itk library.
- \item {\bf\emph{vtk}} : the basic images and surfaces processing and vizualization package, based on the \vtk library.
+ \item {\bf\emph{vtk}} : the basic images and surfaces processing and visualization package, based on the \vtk library.
\item {\bf\emph{wxvtk}} : widget boxes based on the \vtk library (2D and 3D vizualization and
interaction).
- \item {\bf\emph{itkvtk}} : special boxes (adaptors) to convert \itk structures into \vtk structures and conversally.
%\item {\bf\emph{creaImageIO}} : Provides hight level widgets to read images, including DICOM.
\item {\bf\emph{toolsbbtk}} : Tools for bbtk administration and package development..
\end{itemize}
\item A {\bf\emph{Developement environment}}, called \bbStudio, which provides
\begin{itemize}
- \item An online {\bf\emph{script editor}}
- \item A powerfull {\bf\emph{Help environment}}, called \bbPackageBrowser
- whith integrated
+ \item An online {\bf\emph{script editor and interpretor}}
+ \item A powerful html {\bf\emph{Help environment}}, integrating :
\begin{itemize}
\item Online documentation scaning
\item Retreiving boxes on various criterions
\item Checking Demo and examples
\end{itemize}
-
- \item An {\bf\emph{interpreter}}, called \bbins, which allows to
+ \end{itemize}
+ \item An standalone {\bf\emph{interpreter}}, called \bbins, which allows to
load black box packages and to define and execute
- processing chains by connecting various black boxes of the already loaded packages.
- \item {\bf\emph{Utilities}} :
+ processing chains by connecting various black boxes.
+ \item {\bf\emph{Various Development Utilities}} :
\begin{itemize}
\item \bbfy generates the \CPP code of a black box from a
description file written in \texttt{xml}.
%author, description, inputs, outputs, and so on).
\item \bbCreatePackage allows to create the basic file architecture
to start the development of a new black box package.
- \end{itemize}
- \end{itemize}
+ \item \text{bbCreateBlackbox} allows to create the basic file architecture
+ to start the development of a new black box, that will be included in an already existing package.
+ \item \texttt{bbs2cpp} translates a \texttt{.bbs} script into a \CPP file.
+ \item \texttt{bbc} that interprets (i.e. : executes) a \texttt{.bbs} script.
+ \end{itemize}
+ \item A full {\bf\emph{documentation}} printable (pdf), browsable (html),
+ queryable throught keywords.
\end{itemize}
+
The general architecture of \BBTK
is shown in figure \ref{bb-architecture}.
\newpage
% ==========================================
-\subsection{Structure of this guide}
+\section{Getting started with bbStudio}
% ==========================================
-This guide is divided into three parts.
-
-The first part (\ref{bbStudio}) is a brief presentation of the very intuitive Development
-environment, \bbStudions.
-
-The second part (\ref{bb0})
-is devoted to the use of the \emph{black box interpreter} \bbins.
-This is the highest level of use of the toolkit, which
-allows to create and execute processing chains by connecting
-black boxes of existing packages.
-
-The third part (\ref{cpp}) explains how to
-use the black box toolkit framework in \CPP code,
-typically to develop large applications which
-involve complex graphical interfaces.
-
-
% ==========================================
% ==========================================
% ==========================================
% ==========================================
% ==========================================
% ==========================================
-\vspace{0.5cm}\hrule
-\section{The Development environment (bbStudio)}
-\label{bbStudio}
+
+% ==========================================
+\subsection{The interface}
+% ==========================================
+
+
+%\vspace{0.5cm}\hrule
+%\section{The Development environment (bbStudio)}
+%\label{bbStudio}
Just run it, typing in a console \bbStudio
or clicking on its icon or its menu entry.
\ref{bbi-fig-bbStudio-gui-start}
(the exact appearance of \bbStudio is Operating System and \bbtk version dependent)
+\newpage
+
+
\begin{figure}[!ht]
\caption{\label{bbi-fig-bbStudio-gui-start}The bbStudio Development environment interface at start time}
\begin{center}
\end{center}
\end{figure}
-You can see four parts :
-\begin{itemize}
- \item {\bf{Files}}
- \item {\bf{Messages}}
- \item {\bf{Command}}
- \item {\bf{Help}}
-\end{itemize}
+You can see four parts : \texttt{Files}, \texttt{Messages},
+ \texttt{Command}, \texttt{Help}.\\
-The stuff is written using the Advanced User Interface library of wxWidgets,
+The stuff is written using the Advanced User Interface library of wxWidgets
+(a.k.a. AUI),
whose 'docking manager' allows windows and toolbars to be floated/docked
onto a frame.\\
Please don't use this feature at learning time (the snapshots of this document
wouldn't match with your screen ...)
-\subsection{'Files' part}
+\subsubsection{'Files' part}
\label{bbi-FilesPart}
It's the .bbs script editor.\\
If you load a file holding a script, it will be displayed here, and you'll be
able to modify it, to save it, to save-as it, to run it, using the
-lower toolbar
+lower toolbar (see figure : \ref{lowertoolbar})
+
+\begin{figure}[!ht]
+\caption{\label{lowertoolbar}The lower tool bar}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{lowertoolbar2.png}
+\end{center}
+\end{figure}
+
+% \begin{itemize}
+% \item {\bf\emph{New file}} : Create a new file to hold a script
+% \item {\bf\emph{Open file}} : Open an already existing file holding a script
+% \item {\bf\emph{Close file}} : Close a file holding a script
+% \item {\bf\emph{Save file}} : Save he current file (if modified)
+% \item {\bf\emph{Save file as}} : Save he current file under a different name
+% \item {\bf\emph{Run file}} : Execute the script you just loaded/modified/written
+% \item {\bf\emph{cursor position}} : column number : line number
+% \end{itemize}
-\subsection{'Messages' part}
+
+\subsubsection{'Messages' part}
\label{bbi-MessagesPart}
Two kinds of messages will be output here:\\
System messages : produced by the kernel, in case of a user mistyping, or an execution error\\
-Script messages : produced by the \bbtk equivalent of \texttt{printf} or \texttt{std::cout} in user programs
+Script messages : produced by the \bbtk equivalent of \texttt{printf}
+or \texttt{std::cout} in user programs
-\subsection{'Command' part}
+\subsubsection{'Command' part}
\label{bbi-CommandPart}
This is where user will type his requirements.
-\subsection{'Help Contents' part}
+\subsubsection{'Help Contents' part}
\label{bbi-HelpContentsPart}
The 'Help Contents' part of \bbStudio is used to browse the html help of \BBTK.
application, just using already existing boxes.
\item {\bf\emph{Package Developper's Guide}} : Step to step How-to for user who wants to create his own
black boxes.
- \item {\bf\emph{Developper's Guide}} : For bbtk kernel developpers. Sorry, not yet written.
- \item {\bf\emph{Reference Manual}} : Sorry, not yet written.
- \item {\bf\emph{Booklet}} : Vade mecum. Sorry, not yet written.
+ \item {\bf\emph{Developper's Guide}} : For bbtk kernel developpers. .
+ \item {\bf\emph{Reference Manual}} :
+ \item {\bf\emph{Booklet}} : Vade mecum.
\item {\bf\emph{Doxygen Documentation}} : Doxygen source browser.
\end{itemize}
\item {\bf\emph{Boxes}} : Box retrieving on various criterions :
- \begin{itemize}
- \item {\bf\emph{By name}} (Alphabetical list)
- \item {\bf\emph{By package}} (see table : \ref{bbi-list_of_packages})
- \item {\bf\emph{By category}} (see table : \ref{categories})
- \item {\bf\emph{Adaptors}} Used internaly to perform type conversions (not end user intended)
- \end{itemize}
+ \begin{itemize}
+ \item {\bf\emph{ \texttt{By name}}} (Alphabetical list),
+ \item {\bf\emph{ \texttt{By package}}},
+ \item {\bf\emph{ \texttt{By category}}}.
+ \end{itemize}
+
+ A special hidden Box category, called \texttt{{Adaptors}} exists. \\
+ They are used internaly to perform type conversions. Thought there are not end user intended, you may query them.
+
\end{itemize}
-% ==========================================
-\begin{table}[!ht]
-\caption{\label{bbi-list_of_packages} List of bbtk supplied packages.}
-\small
-\begin{tabular}{|lp{10cm}|}
-\hline
-Package & What it's used for \\ \hline
-\texttt{std} & : the 'standard' package including basic useful boxes \\ \hline
-\texttt{wx} & : basic graphical interface elements (widgets : sliders, buttons, etc.) based on the \texttt{wxWidgets} library \\ \hline
-\itk & : the basic image processing package, based on the \itk library. (without description)\\ \hline
-\vtk & : prints help on the package \texttt{package-name} and its boxes (with brief description). The package must have been previously loaded\\ \hline
-\texttt{wxvtk} & : widget boxes based on the \vtk library.\\ \hline
-\texttt{itkvtk} & : adaptors to convert \itk structures into \vtk structures and conversally.\\ \hline
-%\texttt{creaImageIO} & : provides high level widgets to read images including DICOM.\\ \hline
-\texttt{toolsbbtk} & : Tools for bbtk administration and package development.\\ \hline
-\end{tabular}
-\end{table}
% ==========================================
-% ==========================================
-\begin{table}[!ht]
-\caption{\label{categories} \texttt{Black Box} categories}
-\small
-\begin{tabular}{|lp{10cm}|}
-\hline
- \texttt{Category name} & : Meaning \\ \hline \\ \hline
- \texttt{adaptor} & : Adaptor box \\ \hline
- \texttt{application} & : Final application, end user intended \\ \hline
- \texttt{atomic box} & : System category.
- 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{demo} & : Demonstration \\ \hline
- \texttt{devel} & : Developer tool (bbCreatePackage.bbs, ...) \\ \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{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{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}
-
-% ==========================================
-
-\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}
-
-
-\newpage
- .\newline
- .\newline
- .\newline
- .\newline
- .\newline
- .\newline
-
- . \newline
-% ==========================================
% ==========================================
% ==========================================
% ==========================================
% ==========================================
-% ==========================================
-\vspace{0.5cm}\hrule
-\section{The script manager}
-\label{bb0}
% ==========================================
- Atomatically open in the left upper part of bbStudio.
-
-\begin{figure}[!ht]
-\caption{\label{bbi-fig-bbStudio-file0}The bbStudio script manager}
-\begin{center}
-\includegraphics[width=0.7\textwidth]{bbFile0.png}
-\end{center}
-\end{figure}
-
-Using the lower tool bar (see figure : \ref{lowertoolbar}), you can :
-
-
-\begin{figure}[!ht]
-\caption{\label{lowertoolbar}The lower tool bar}
-\begin{center}
-\includegraphics[width=0.7\textwidth]{lowertoolbar.png}
-\end{center}
-\end{figure}
-
-
- \begin{itemize}
- \item {\bf\emph{New file}} : Create a new file to hold a script
- \item {\bf\emph{Open file}} : Open a already existing file holding a script
- \item {\bf\emph{Close file}} : Close a file holding a script
- \item {\bf\emph{Save file}} : Save he current file (if modified)
- \item {\bf\emph{Save file as}} : Save he current file under a different name
- \item {\bf\emph{Run file}} : Execute the script you just loaded/modified/written
- \end{itemize}
-
-
-The script language is very simple.
-Everything is done with only a very few commands (See table \ref{bbi-reference-box}).
-The philosophy of this part is also very simple :
-it introduces the \bbi commands using examples,
-starting with the most simple commands.
-The first section of this part
-(\ref{bbi-getting-started})
-is designed like a tutorial,
-which progressively introduces all the concepts of the command interpretor.
-We suggest you run \bbStudio and follow the examples,
-to see how it works in practice.
-At the end of this section,
-you will be able to use \bbStudio and write
-own black box processing scripts.
-
-After this tutorial,
-the section \ref{bbi-more-on}
-(called \emph{more on...})
-goes deeper into various issues of the command interpretor.
-Read it at your convenience,
-either linearly to learn more about \bbStudio,
-or in random order to get an answer
-to a particular question.
-
-Finally, the section \ref{bbi-reference}
-summarizes all the commands of \bbStudions,
-their parameters and effect.
-Use it as a reference.
-
-
-\newpage
% ==========================================
-\subsection{Getting started}
-\label{bbi-getting-started}
-
-% ==============================================
-\subsubsection{Installed tree \emph{vs} Built tree}
-% ==============================================
-
-If you want to use the 'installed' version (it means you downloaded and run the Windows
-installer, or the Fedora package, or you downloaded, compiled and installed the
-cvs version), just open a console and type \bbStudions, or double click on the application icon. \\
-If you want to run your own uninstalled version (say : you downloaded and compiled the
-cvs version in order to use a recently commited patch, but you want to be able to still use the standard version),
-you have to open a console, cd in the \texttt{bin} directory of the built tree and type \texttt{./bbStudio}.
+\newpage
% ==============================================
-\subsubsection{Using an already existing script}
+\subsection{Running Demo and Examples}
% ==============================================
Run \bbStudio the way you need. \\
\end{center}
\end{figure}
+\newpage
+
You will be asked to select a Box category (See figure \ref{BoxCategories}); \\
Select \texttt{example}.
Run it, using the lower toolbar (see figure : \ref{lowertoolbar})
-You'll get something like in \ref{execSliderSource}.
+You'll get something like in figure \ref{execSliderSource}.
\begin{figure}[!ht]
\caption{\label{execSliderSource}execution of 'exampleSlider'}
Feel free to move the slider, to check it actually works...
-
\newpage
-% ==========================================
-\subsubsection{Creating and executing black boxes}
-% ==========================================
+Just a few words on what you saw :
+\begin{itemize}
+\item{in the File part} \\
+The source code of the script
+\begin{verbatim}
+ new Slider slider
+ set slider.ReactiveOnTrack 1
+\end{verbatim}
+We create a \texttt{Slider} called \emph{slider}\\
+We tell it to inform anybody that's interested in, that the cursor moved, each time it moved. \\
+The standard behaviour is to inform, only when cursor is released.
+\begin{verbatim}
+ new OutputText text
+\end{verbatim}
+We create a \texttt{OutputText} called \emph{text}
+(in which slider value will be displayed)
+
+\begin{verbatim}
+new LayoutLine layout
+\end{verbatim}
+We create a \texttt{LayoutLine} called \emph{layout},
+a \emph{container} widget, designed to embed other wigets (say, a main window)
+\begin{verbatim}
+connect slider.Widget layout.Widget1
+connect text.Widget layout.Widget2
+\end{verbatim}
+We embed \emph{slider} and \emph{text} into \emph{layout}.
+\begin{verbatim}
+connect slider.BoxChange text.BoxExecute
+connect slider.Out text.In
+\end{verbatim}
+We tell \emph{slider} to inform \emph{text} every time it's modified.\\
+We tell \emph{slider} to pass its output value (\texttt{Out} to \emph{text} input value (\texttt{In})
+\begin{verbatim}
+exec layout
+\end{verbatim}
+We tell \emph{layout} to process itself (it will do it only if it's warned
+that one of its entries was modified since its (own) last processing.
+
+\item{in the Help part}
-To learn interactivelly the script language features, you can use the black box
-interpreter :
-open a console and type \bbStudio
-or double click on the application icon.
-You get a window which looks like the one in figure
-\ref{bbi-fig-bbi-gui}
-(the exact appearance of \bbStudio is system and \bbtk version dependent)
+You can see the graphical representation of the script, as in figure \ref{SmallGraph}.
-%\footnote{If you compiled \bbtk without \wx then \bbi does not have a
-%graphical interface but a simple prompt}.
\begin{figure}[!ht]
-\caption{\label{bbi-fig-bbi-gui}The black box interpreter interface}
+\caption{\label{SmallGraph}Graphical representation of a script}
\begin{center}
-\includegraphics[width=0.7\textwidth]{bbi-gui0.png}
+\includegraphics[width=0.7\textwidth]{SmallGraph.png}
\end{center}
\end{figure}
+Both graphical pipe line (\emph{slider} and \emph{text} are embedded into \emph{layout})
+ and processing pipe line (\emph{slider} warns \emph{text} immedialtely when it's modified, \emph{slider} passed \emph{text} its new value).\\
+ Yes, we know : all the arrows (pipe line arrows and processing arrows) are blue; we are sorry about that...\\
+
+ You could get a much more detailled graph, just clicking on the button \\ \texttt{graph (detailled)} in the toolbar of the \texttt{Command} part, like in
+ figure \ref{LargeGraph}.
+
+\begin{figure}[!ht]
+\caption{\label{LargeGraph}Detailled graphical representation of a script}
+\begin{center}
+\includegraphics[width=0.75\textwidth]{LargeGraph.png}
+\end{center}
+\end{figure}
+
+\end{itemize}
+\newpage
+
+% ==============================================
+\subsection{Online Help}
+% ==============================================
+
+Various levels or help are suplied by \bbStudions.
+
+% ==========================================
+\subsubsection{Command line help}
+% ==========================================
+
+
The 'working' area (the left one, as opposed to the 'help' area, on the right side) is composed of :
-one single line zone (Command), at the bottom in which you can enter your commands and
+one single line area (\texttt{Command}), at the bottom in which you can enter your commands and
a multiple line zone in which the Command interpreter prints out the result of your commands.
The upper part contains the script editor; we shall not use it right now, you may reduce it
-Try typing in the input zone (in this manual,
+Try typing in the \texttt{Command} area (in this manual,
the commands entered by the user will be preceded by a prompt \textgreater) :
\begin{verbatim}
> help
you get something like :
-% std
-% ASCII
-% Add
-% ConcatStrings
-% Configuration
-% Div
-% ExecBbiCommand
-% ExecSystemCommand
-% GetVectorCharElement
-% ...
-% GetVectorUShortElement
-% MagicBox
-% MakeFileName
-% Mul
-% MultipleInputs
-% PrependDataPath
-% PrependPackageDataPath
-% StringRelay
-% StringSelect
-% user
-%
-% workspace
-
-
\begin{verbatim}
std
You'll get a text help, in the 'Message' part :
\begin{verbatim}
-Black Box <std::Add>
+Black Box <std::Add>S
Adds its inputs
By : laurent.guigues@creatis.insa-lyon.fr
Categories : atomic box;math;
'In1' <Double> [] : First number to add
'In2' <Double> [] : Second number to add
* Outputs :
- 'BoxChange' <bbtk::Void> [signal] : Signals modifications of the box
+ 'BoxChange' <bbtk::VoidS> [signal] : Signals modifications of the box
'Out' <Double> [] : Result
\end{verbatim}
-You'll get as well the same information in the 'Help' Part, in html format (see figure : \ref{HelpAdd}) :
+More information about what is a 'box' will be given in the 'Scripting' part of this manual.
+
+% ==========================================
+\subsubsection{Guides}
+% ==========================================
+
+An html version of all the guides is browsable in the \texttt{Help} part of \bbStudions.
+ \begin{itemize}
+ \item {\bf\emph{User's Guide}} : Step to step How-to for user who wants to create his own
+ application, just using already existing boxes.
+ \item {\bf\emph{Package Developper's Guide}} : Step to step How-to for programmer who wants to create his own
+ black boxes/packages.
+ \item {\bf\emph{Developper's Guide}} : For bbtk kernel developpers only. (This one is probabely not very much
+ up-to-date, since we spend more time in developping than writing documentation that's not of user concern).
+ \item {\bf\emph{Reference Manual}} : Contains a exaustive description of all the features for all the commands.
+ \item {\bf\emph{Booklet}} : Vade mecum.
+ \item {\bf\emph{Doxygen Documentation}} : Doxygen source browser.\\ Automatically generated from source file
+ headers. Should concern only the kernel developpers (i.e. : us).
+ \end{itemize}
+
+
+
+% ==========================================
+\subsubsection{Boxes Help}
+% ==========================================
+ Box retrieving on various criteria :
+ \begin{itemize}
+ \item {\bf\emph{Alphabetical list}} \\ This is the 'zero-level' of retrieving.
+ \item {\bf\emph{List by package}} \\ Several packages are supplied with bbtk :
+ \begin{itemize}
+ \item {\bf\emph{std}} : the 'standard' package including basic useful boxes.
+ \item {\bf\emph{wx}} : basic graphical interface elements (widgets : sliders, buttons, etc. based on the \texttt{wxWidgets} library).
+ \item {\bf\emph{itk}} : the basic image processing package, based on the \itk library.
+ \item {\bf\emph{vtk}} : the basic images and surfaces processing and vizualization package, based on the \vtk library.
+ \item {\bf\emph{wxvtk}} : widget boxes based on the \vtk library (2D and 3D vizualization and
+ interaction).
+ %\item {\bf\emph{creaImageIO}} : Provides hight level widgets to read images, including DICOM.
+ \item {\bf\emph{toolsbbtk}} : Tools for bbtk administration and package development, such as :
+ \begin{itemize}
+ \item{\texttt{GUICreateBlackBox}} For creating the XML or C++ code for a new black box
+ \item{\texttt{GUICreatePackage}} For creating a new bbtk package file structure on disk (Graphical user interface for the shell script bbCreatePackage)
+ \item{\texttt{MakePackageDoc}} For creating the html documentation of a package. The doc is generated at the 'canonical' location. Works both for a build tree or an installed toolkit.
+ \end{itemize}
+ \end{itemize}
+ \item {\bf\emph{List by category}}.
+
+
+ A given box may belong to more than one \texttt{category}.\\
+ You have to consider categories like keywords to index black boxes.\\
+ Some of them are mutually exclusive.
+ A black box may be :
+ \begin {itemize}
+ \item{atomic box / complex box}\\
+ Whether it's written is C++ or it's an assembly of several black boxes (atomic or complex).\\
+ Any box is either atomic ou complex.
+ \item{example / demo / application}\\
+ These ones are always complex black boxes.
+ \begin {itemize}
+ \item{example}\\
+ It's just a (simple) example, for programmers, on how to use a given feature.
+ \item{demo}\\
+ It can be a 'good looking' (a.k.a 'sexy') example on some sophisticated work.
+ \item{application}\\
+ It's a Final application, end user intended (e.g. Subscale a huge volume, Crop a DICOM image, etc)
+ \end {itemize}
+ \item{widget}\\
+ Piece of graphical interface (based on \texttt{wxWidgets})
+ \item{Dicom}\\
+ Dicom medical image related box.
+ \item{viewer}\\
+ \item{read/write}
+ \item{mesh}
+ \item{3D Object creator}
+ \item{math}
+ \item{misc}
+ \end {itemize}
+ \end {itemize}
+
+% ==========================================
+\subsubsection{The Package Browser}
+\label{Package_Browser}
+% ==========================================
+
+
+You can run it using the tool bar of the 'Command' part. See figure \ref{imPackage_Browser}.
\begin{figure}[!ht]
-\caption{\label{HelpAdd}The html Help}
+\caption{\label{imPackage_Browser}The Package Browser}
\begin{center}
-\includegraphics[width=0.7\textwidth]{HelpAdd.png}
+\includegraphics[width=0.6\textwidth]{Package_Browser.png}
\end{center}
\end{figure}
-Like previously,
-the \texttt{std::} prepended to the name \texttt{Add}
-means that the box \texttt{Add}
-belongs to the \texttt{std} package.
-Then comes a description
-(the one which was provided by the author of the box),
-the author(s) of the box (usually e-mail adress(es)) and
-the categories to which the box belongs.
-Finally comes the lists of inputs and outputs of the box.
-For each input or output, \bbi provides
-its \emph{name} (between quotes, e.g. \texttt{'ProcessMode'}),
-its \emph{type} (between \texttt{<} and \texttt{>}, e.g. \texttt{<Int>})
-and a description.
-Remark that the box \texttt{Add} is not a 'complex' black box
-but an 'atomic' box, hence its help does not
-mention any information concerning possible internal boxes.
+It allows you to query informations about what you can find in the packages (boxes and applications), using several criterions
+(warning : it's case sensitive, i.e '\texttt{Button}' will give different results than '\texttt{button}' ...)
+\begin {itemize}
+\item Packages :\\
+All the boxes and applications held in a given package (e.g. \texttt{wxvtk}, \texttt{std}, ...)
+\item Name :\\
+You can query on a subpart of the name of a box or an application (e.g. \texttt{DICOM})
+\item Description :\\
+You can query on a substring of the description of a box or an application (e.g. \texttt{utton} : user wants to get all
+the\texttt{Button} as well as the \texttt{button} )
+\item Category :\\
+You can query on a sub part of the category name of a box or an application (e.g. \texttt{3D})
+\item Input Type :\\
+You can query all the boxes or applications that have at least one Input entry of the given type (e.g. \texttt{int})
+\item Output Type :\\
+You can query all the boxes or applications that have at least one Output entry of the given type (e.g. \texttt{int})
+\item Input Nature :\\
+You can query all the boxes or applications that have at least one Input entry of the given nature (e.g. \texttt{signal})
+\item Output Nature :\\
+You can query all the boxes or applications that have at least one Output entry of the given nature (e.g.
+\texttt{signal},\texttt{file name})
+\end {itemize}
+
+
+All these criterions are \emph{AND}ed while the query process.\\
+You can get the whole description of a given box or application clicking on its name.
+
+\newpage
+
+% ==============================================
+\subsection{The Menu}
+% ==============================================
+
+At last, let's have a look at \bbStudio menu.(See figure \ref{themenu})
+
+\begin{figure}[!ht]
+\caption{\label{themenu}The bbStudio menu}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{themenu.png}
+\end{center}
+\end{figure}
+
+\begin {itemize}
+ \item{File}
+ \begin {itemize}
+ \item{Open the bbtk configuration file}
+ \item{Quit}
+ \end {itemize}
+ \item{Tools}
+ \begin {itemize}
+ \item{Create package} :
+ Provides a graphical interface to help Package developper to create a new empty package.
+ \item{Create black box}
+ Provides a graphical interface to help Package developper to create a new empty black box, and add it to an already existing package.
+ \item{Show last image graph}
+ \item{Regenerate package doc} :
+ if user was supplied new black boxes, and added them to an already existing package, he can update the package documentation, in order to benefit all the features of the Help mechanisms.
+ \item{Regenerate boxes list} :
+ if user wants to update only boxes list (quicker)
+ \item{Regenerate all}
+ User wants to rebuild the whole documentation.
+ \end {itemize}
+ \item{Options}
+ \begin {itemize}
+ \item{Reset before running} Before running, all the already boxes are destroyed, all the already loaded packages are unloaded (this is the recomended option).
+ \end {itemize}
+ \item{Windows}
+ User may decide, for any reason of his own, to hide one or more pannels:
+ \begin {itemize}
+ \item{Show 'Files' panel}
+ \item{Show 'Help' panel}
+ \item{Show 'Command' panel}
+ \item{Show 'Messages' panel}
+ \item{Launch Package browser} The package browser is a stand alone application. This can be achieved, too, using the lower tool bar, button 'Start Package Browser'
+ \item{}
+ \end {itemize}
+ \item{About}
+ \begin {itemize}
+ \item{About} Info about \texttt{bbStudio}.
+ \end {itemize}
+\end {itemize}
+% ==========================================
+\section{bbs scripting}
+% ==========================================
+
+% ==========================================
+\subsection{Using an already existing script}
+% ==========================================
+
+Using the lower toolbar (see figure : \ref{lowertoolbarsmall}), open the file
+holding the script.
+
+\begin{figure}[!ht]
+\caption{\label{lowertoolbarsmall}The lower tool bar}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{lowertoolbar.png}
+\end{center}
+\end{figure}
-You can create an \emph{instance} of an \texttt{Add} box by
+ You'll see it, in the '\texttt{Files}' part.\\ \\
+ You may run it, using the lower toolbar. \\
+ \texttt{WARNING :} if the script contains one or more \texttt{LayoutSplit}
+ object, you will have to resize the sub windows. \\ \\
+ You may modify, save or save-as the current script, using the lower toolbar.\\ \\
+ You may have a look at the graphical representation of the pipeline (sorry,
+ right now, to modify the pipeline, you have to modify the script;
+ you cannot modify grapically the pipeline; Work in progress...)
+
+
+% ==========================================
+\subsection{Inside black boxes}
+% ==========================================
+
+After loading the package it belongs to, you can You can create an \emph{instance} of an \texttt{Add} box by
the command \texttt{new} :
+
\begin{verbatim}
> new Add a
\end{verbatim}
a \texttt{C} code, it declares a variable of type \texttt{int} whose
name is \texttt{i}.
Of course, like in \texttt{C} Language, you can declare multiple boxes of the
-same type in \bbi.
+same type in \bbi. \\
+
+You can ask information about a given black box :\\
+In the \texttt{Command part}, type \texttt{help} + black box name, e.g. \\
+
+\begin{verbatim}
+> help Add a
+\end{verbatim}
+Have a look to the 'Help' Part (see figure : \ref{HelpAdd}) :
+
+\begin{figure}[!ht]
+\caption{\label{HelpAdd}The html Help}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{HelpAdd.png}
+\end{center}
+\end{figure}
+
+The \texttt{std::} prepended to the name \texttt{Add}
+means that the box \texttt{Add}
+belongs to the \texttt{std} package.
+Then comes a description
+(the one which was provided by the author of the box),
+the author(s) of the box (usually e-mail adress(es)) and
+the categories to which the box belongs.
+Finally comes the lists of inputs and outputs of the box.
+For each input or output, \bbi provides
+its \emph{name} (between quotes, e.g. \texttt{'ProcessMode'}),
+its \emph{type} (between \texttt{<} and \texttt{>}, e.g. \texttt{<Int>})
+and a description.
+Remark that the box \texttt{Add} is not a 'complex' black box
+but an 'atomic' box, hence its help does not
+mention any information concerning possible internal boxes.
After the creation of the box \texttt{a}, type :
\begin{verbatim}
\texttt{'Always'}, which forces box reprocessing.
\end{itemize}
-Note that all boxes have an input named \texttt{'BoxProcessMode'}.\\
+Note that all boxes have an input named \texttt{'BoxProcessMode'}.
Another way to process the box \texttt{a} is to issue the command :
\begin{verbatim}
It just processes the box if needed.
This command is used to execute boxes that do not have any output,
such as boxes that write something to a file or, display a
-graphical interface, and so on. \\
+graphical interface, and so on.
%To exit \bbi, type :
%\begin{verbatim}
The first three commands build the pipeline,
the next three set \texttt{a} and \texttt{b} black boxes inputs and the last one
-prints \texttt{b} black boxe output (the pipeline is executed before printing, because the interpretor 'knows' the box \texttt{b},
+prints \texttt{b} black box output (the pipeline is executed before printing, because the interpretor 'knows' the box \texttt{b},
whose output is requested, is not up to date.
The command \texttt{'connect a.Out b.In1'} ``plugs'' the output
\texttt{Out} of the box \texttt{a} into the input \texttt{In1} of the
box \texttt{b}.
-Once the boxes connected, the processing of the two boxes are chained :
+Once the boxes are connected, the processing of the two boxes are chained :
getting the output of \texttt{b} requires getting its inputs,
hence getting the output of \texttt{a} which is connected to it.
This pipeline mechanism can recurse into arbitrary long
\texttt{connect fileDialog.Out reader.In} plugs the output of the File Selector (a std::string) to the input of the reader (a std::string, too).\\
\texttt{connect reader.Out viewer.In} plugs the output of the reader (an itk::ImagePointer) to the input of the Viewer (a vtkImageData *)\\
\texttt{connect slider.Out viewer.Slice} plugs the output of the slider (an int) to an other output (named Slide) of the viewer.\\
-\texttt{connect slider.BoxChange viewer.BoxExecute} says the viewer it must re process itself any time the slider is modified.\\
+\texttt{connect slider.BoxChange viewer.BoxExecute} says the viewer that it must re process itself any time the slider is modified.\\
\\
\texttt{exec viewer} processes the viewer.
and at least one ouput called \texttt{Out} and whose role is to convert
a data of the type of \texttt{In}
into a data of the type of \texttt{Out} (other inputs or outputs may serve
-to parameter the adaptor or retreive other usefull information).
+to parameter the adaptor or retreive other useful information).
Under \bbStudions, if you type :
\begin{verbatim}
in a totally transparent way.
In our example, the \texttt{CastUCharToDouble} adaptor
would simply cast the value of the \texttt{char} into a \texttt{double},
-however arbitrarily complex type conversion may be done.
+however arbitrarily complex type conversion may be done.\\
+\texttt{WARNING} : these adaptors are \texttt{C++ static cast}, i.e., there is, right now',
+ no 'intelligent' conversion (only truncation) e.g. think to \texttt{CastDoubleToUChar}!
-\begin{verbatim}
-Question (for info-dev):
-if two adaptors with the same input and output types exist
-in two different packages, currenly loaded,
-which one is chosen by the interpreter at connection time?
-A feature is missing to specify explicitely which one user wants to choose
-(use a namespace notation ?)
-
--> Role of default adaptors
-\end{verbatim}
+%\begin{verbatim}
+%Question (for info-dev):
+%if two adaptors with the same input and output types exist
+%in two different packages, currenly loaded,
+%which one is chosen by the interpreter at connection time?
+%A feature is missing to specify explicitely which one user wants to choose
+%(use a namespace notation ?)
+%
+%-> Role of default adaptors
+%\end{verbatim}
Note that the \texttt{set} and \texttt{print} commands of interpreter
work with adaptors from \texttt{string} to the type of the input to set
Remember the pipeline of figure
\ref{bbi-fig-connecting-black-boxes-1}, which
-computed the sum of three doubles?
+computed the sum of three doubles.
You can consider it as a whole and define
a new black box type, which will be a \emph{complex black box},
having three inputs and one output,
Once you have defined a new type of complex box, you
may like to reuse it. To do this, you can simply
write the \bbi commands defining the new box
-into a text file and afterwards include that file in \bbi.
+into a text file and afterwards include that file in \bbins.
Doing this, you start writing \bbi scripts.
The conventionnal (and mandatory) extension for such scripts is \texttt{bbs}
(black box script).
\texttt{Slider} or a \texttt{FileDialog} rather than a \texttt{InputText}.
See the files \texttt{test*.bbs} in the \texttt{scripts/test} directory.
-There are two kinds of widgets : ``terminal'' widgets and ``container'' widgets.
-The \texttt{InputText}, \texttt{FileDialog} or \texttt{Slider} widgets
-are ``terminal'' widgets.
-``container'' widgets are of another kind : they are designed to
+
+%There are two kinds of widgets : ``terminal'' widgets and ``container'' widgets.
+%The \texttt{InputText}, \texttt{FileDialog} or \texttt{Slider} widgets
+%are ``terminal'' widgets.
+%``container'' widgets are of another kind : they are
+There is a special kind of widget, called '\texttt{Layout}', designed to
contain other widgets in order to build larger dialog boxes.
For example, the \texttt{LayoutSplit} widget is a container which
``splits'' horizontally a window into two parts,
The orientation of the \texttt{LayoutSplit} or of the \texttt{LayoutLine} can be changed by the input \texttt{Orientation}.
See the example \texttt{test/testSizer.bbs}.
With only those two containers you can already create
-complex dialog boxes (of course containers can be nested, which leads to tree-like structures of widgets).
+complex dialog boxes (of course containers can be nested, which leads to tree-like structures of widgets). \\
See the script \texttt{bbtk/share/bbtk/bbs/wx/appli/ExampleLayoutSplit.bbs} for an example.
\item {The \texttt{LayoutTab} widget} is based on the \texttt{wxNotebook.}\\
\end{itemize}
-=====> TODO \\
+%=====> TODO \\
-One word about a special widget in the package \texttt{wx} :
-the \texttt{Button}... to be continued.
+%One word about a special widget in the package \texttt{wx} :
+%the \texttt{Button}... to be continued.
% ==========================================
\subsubsection{Deeper in the boxes}
% ==========================================
% ==========================================
-\subsubsection{Black box packages}
-\label{bbi-more-on-packages}
+%\subsubsection{Black box packages}
+%\label{bbi-more-on-packages}
% ==========================================
-There are various others user-intended packages :
+%There are various others user-intended packages :
-\begin{verbatim}
----> Were moved in a 'Reference Manual' ?\\
----> Any suggestion welcome!
-\end{verbatim}
+%\begin{verbatim}
+%---> Were moved in a 'Reference Manual' ?\\
+%---> Any suggestion welcome!
+%\end{verbatim}
-\begin{itemize}
-\item{vtk} \\
-\item{itk} \\
-\item{...} \\
-\end{itemize}
+%\begin{itemize}
+%\item{vtk} \\
+%\item{itk} \\
+%\item{...} \\
+%\end{itemize}
% ==========================================
\subsubsection{Pipeline processing}
\label{bbi-more-on-pipeline-processing}
%\paragraph{Reducing the number of inputs of a box}
% ==========================================
-\subsubsection{Errors}
-\label{bbi-more-on-errors}
+%\subsubsection{Errors}
+%\label{bbi-more-on-errors}
% ==========================================
\subsubsection{Creating and using your own uninstalled version of bbStudio}
ccmake ../bbtk
\end{verbatim}
-Don't forget to switch ON the flag \textttBBTK\_COMPILE\_DEBUG\_MESSAGE \\
+Don't forget to switch ON the flag \texttt{BBTK\_COMPILE\_DEBUG\_MESSAGE} \\
(see figure : \ref{bb-ccmake})
\begin{figure}[!ht]
-\caption{\label{bb-ccmake}\Running ccmake}
+\caption{\label{bb-ccmake}Running ccmake}
\begin{center}
\includegraphics[width=0.6\textwidth]{ccmake.png}
\end{center}
\end{figure}
-\item As usual, type \texttt{c} untill there is no longer any area quoted with a * (or enlighted in red)\\
+\item As usual, type \texttt{c} until there is no longer any area quoted with a * (or highlighted in red)\\
Ask for generation (type \texttt{g} -once is always enough-)
\item Ask for compilation and link.
\begin{verbatim}
make
\end{verbatim}
-For some strange reasons (?!?), you may be warned that an error occured while documentation generation.\\
-Take it easy, \texttt{make} again!\\
-The dynamic libraries (\texttt{.dll} or \texttt{.so} and the executable programs will be created in the \testtt{bin}
+
+The dynamic libraries (\texttt{.dll} or \texttt{.so} and the executable programs will be created in the \texttt{bin}
directory of the built tree.
\item choose to install or not your own version.
Linux users : Don't forget to \texttt{sudo} before.
\end{itemize}
% ==========================================
-\subsubsection{\bbtk configuration file and search pathes}
+\subsubsection{\bbtk configuration file and search paths}
\label{bbi-more-on-configuration}
At start, \bbi tries to open an \texttt{xml}
variable \texttt{USERPROFILE},
typically \texttt{C:\\...}.
\end{itemize}
-\item If none of these two pathes contains the file then it creates
+\item If none of these two paths contains the file then it creates
a new one in the \texttt{.bbtk} directory.
\end{enumerate}
% ==========================================
-\subsubsection{pipeline creation and execution related commands}
+\subsubsection{Pipeline creation and execution related commands}
\label{bbi-reference-creation-execution}
% ==========================================
-
+ See table \ref{bbi-reference-box}
% ==========================================
\begin{table}[!ht]
\subsubsection{Interpreter related commands}
\label{bbi-reference-interpreter}
% ==========================================
-
+See table \ref{tabbbi-reference-interpreter_1} and \ref{tabbbi-reference-interpreter_2}
% ==========================================
\begin{table}[!ht]
-\caption{\label{bbi-reference-interpreter}\bbi intepreter related commands.}
+\caption{\label{tabbbi-reference-interpreter_1}\bbi intepreter related commands (part 1).}
\small
\begin{tabular}{|lcm{6cm}|}
\hline
\texttt{kind} & \texttt{<box kind>} &
Specifies the \texttt{kind} of the complex black boxes you are describing \\ \hline
+\end{tabular}
+\end{table}
+
+%
+% This arbitrary part1/part2 is to avoid to have all the tables at the end of the docoment ...
+%
+\begin{table}[!ht]
+\caption{\label{tabbbi-reference-interpreter_2}\bbi intepreter related commands (part 2).}
+\small
+\begin{tabular}{|lcm{6cm}|}
+\hline
+Command & Parameters & Effect \\ \hline
\texttt{unload} & \texttt{<package-name>}&
Unloads the package \texttt{package-name}.
The package must have been previously loaded.
\texttt{message} & \texttt{<category>} \texttt{<level>} &
Sets the level of verbosity of \bbi for the category of messages
\texttt{category} to \texttt{level}.\\ \hline
-%See \ref{verbosity}.
+%See \ref{verbosity}.
\texttt{config} & - & Displays the Configuration parameters\\ \hline
\end{table}
% ==========================================
-
+\newpage
% ==========================================
-\subsubsection{complex black box definition related commands}
+\subsubsection{Complex black box definition related commands}
\label{bbi-reference-black-box-definition}
% ==========================================
+See table \ref{bbi-reference-complex-box}
% ==========================================
\begin{table}[!ht]
\caption{\label{bbi-reference-complex-box} \bbi complex black box definition related commands.}
\newpage
% ==========================================
-\vspace{0.5cm}\hrule \\
-\section{The Package Browser}
-\label{Package_Browser}
-% ==========================================
-
-
-You can run it using the tool bar of the 'Command' part.
-
-See figure \ref{Package_Browser}.
-
-\begin{figure}[!ht]
-\caption{\label{Package_Browser}The Package Browser}
-\begin{center}
-\includegraphics[width=0.6\textwidth]{Package_Browser.png}
-\end{center}
-\end{figure}
-
-It allows you to query informations about what you can find in the packages (boxes and applications), using several criterions
-(warning : it's case sensitive, i.e \texttt{Button} will give different results thn \texttt{button} ...)
-\begin {itemize}
-\item Pakages :\\
-All the boxes and applications held in a given package (e.g. \texttt{wxvtk}, \texttt{std}, ...)
-\item Name :\\
-You can query on a subpart of the name of a box or an application (e.g. \texttt{DICOM})
-\item Description :\\
-You can query on a substring of the description of a box or an application (e.g. \texttt{utton} : user wants to get all
-the\texttt{Button} as well as the \texttt{button} )
-\item Category :\\
-You can query on a sub part of the category name of a box or an application (e.g. \texttt{3D})
-\item Input Type :\\
-You can query all the boxes or applications that have at least one Input entry of the given type (e.g. \texttt{int})
-\item Output Type :\\
-You can query all the boxes or applications that have at least one Output entry of the given type (e.g. \texttt{int})
-\item Input Nature :\\
-You can query all the boxes or applications that have at least one Input entry of the given nature (e.g. \texttt{signal})
-\item Output Nature :\\
-You can query all the boxes or applications that have at least one Output entry of the given nature (e.g.
-\texttt{signal},\texttt{file name})
-\end {itemize}
+%\vspace{0.5cm}\hrule \\
-All these criterions are \emph{AND}ed while the query process.\\
-You can get the whole description of a given box or application clicking on its name.
-
% ==========================================
-\vspace{0.5cm}\hrule \\
+%\vspace{0.5cm}\hrule \\
+
\section{Using third party Package}
\label{Third_Party_Package}
% ==========================================
-You will have to update the \emph{bbtk\_config.xml} file.\\
-To know where it is stored, just click on \texttt{Config} button of the \texttt{Command} part toolbar.
+% ==========================================
+\subsection{The configuration file}
+\label{The_configuration_file}
+% ==========================================
+
+First, have a glance at the Configuration, just clicking on \texttt{Config} button of the \texttt{Command} part toolbar.
You'll get something like :
(depending on who you are, and whether \texttt{bbStudio} is installed or not.)\\
-Just use your favourite text editor to add :
-\begin{itemize}
-\item
- at the end of the \texttt{BBS Paths} part
- the name of the directory that contains the \texttt{.bbs} scripts of the package you
-want to use,
-\item at the end of the \texttt{PACKAGE Paths} part
- the name of the directory that contains the dynamic libraries (\texttt{.dll} or \texttt{.so}) of the package
-\end{itemize}
+Note the two main parts : \texttt{BBS Paths} and \texttt{PACKAGE Paths}
+
+To use a third party Package, you will have to update the \emph{bbtk\_config.xml} file.\\
+
+Just use the \texttt{Open bbtk Config file} option of the \texttt{Files} of the \bbStudio menu.
+
+You will get something like :
+\begin{verbatim}
+<config>
+ <description> Sets the search directories in the build tree </description>
+ <url> </url>
+ <bbs_path> /home/jpr/Creatis/bbtk/binLIN/share/bbtk/bbs </bbs_path>
+ <package_path> /home/jpr/Creatis/bbtk/binLIN/bin </package_path>
+# For windows
+ <package_path> /home/jpr/Creatis/bbtk/binLIN/bin\Debug </package_path>
+ <package_path> /home/jpr/Creatis/bbtk/binLIN/bin\Release </package_path>
+#
+ <data_path> </data_path>
+#
+ <default_temp_dir> /home/jpr/Creatis/bbtk/binLIN </default_temp_dir>
+</config>
+\end{verbatim}
+
+%\begin{itemize}
+%\item {
+After the already existing tags
+%bbs\_path
+\texttt{bbs\_path}
+ (i.e. the lines begining by
+ \texttt{bbs\_path}
+ %bbs_path
+and ending by
+\texttt{/bbs\_path})
+
+%/bbs_path})
+ add a new one with the name of the directory that contains the
+ \texttt{.bbs} scripts of the package you
+want to use.\\
+x
+%\item {
+After the already existing tags \texttt{package\_path} (i.e. the lines begining by \texttt{package\_path}
+ and ending by \texttt{/package\_path})
+ add a new one with the name of the directory that contains the the dynamic libraries
+ (\texttt{.dll} or \texttt{.so}) of the package you want to use.
-If you want (and sure you will) to be able to use the Help tools as well on the features provided by this package, you must use the
-option \texttt{Generate index} in the menu \texttt{Tools} of the \texttt{Files} part toolbar.
+%\end{itemize}
+% ==========================================
+\subsection{Updating the documentation}
+\label{Updating_the_documentation}
+% ==========================================
+If you want (and sure you will) to be able to use the Help tools as well as the features provided by this package,
+ you must use the
+option \texttt{Regenerate package doc} in the menu \texttt{Tools} of \texttt{bbStudio}.\\
+You'll be prompted for the Package name. Avoid using the \texttt{-a} option (Regenerate all), since it's time consumming.
+
+If you want (and sure you will) to benefit the features of Box indexing
+ you must use the
+option \texttt{Regenerate Boxes Lists} in the menu \texttt{Tools} of \texttt{bbStudio}.\\
+
+
+% ==========================================
+\subsection{Using the package}
+\label{Using_the_package}
% ==========================================
-\vspace{0.5cm}\hrule \\
+
+The only thing you have to do is to \texttt{load} the package, within the script, or from the
+\texttt{Command} part, and enjoy the black boxes it contains.
+
+% ==========================================
+%\vspace{0.5cm}\hrule \\
\section{Using black boxes in \CPP programs}
\label{cpp}
% ==========================================
-A very usefull feature is that you may use any black box within a \CPP program witout worrying about wxWigets main window.\\
+A very useful feature is that you may use any black box within a \CPP program without worrying about \texttt{wxWigets} main window.\\
Let's look a the following bbs script :
exec layout
\end{verbatim}
-User wants to create a slider and an output text, within a layoutline, and display the slider value in the output text.\\
+User wants to create a slider and an output text, within a LayoutLine, and display the slider value in the output text.\\
Think about the (little!) nightmare to code the same, in 'raw C++', using wxWidgets.\\
-Using \bbtk you just 'convert' the script :
+Using the standalone application \text{bbc} you just 'convert' the script.
+
\begin{verbatim}
#include <bbwxSlider.h>
%\bibliography{all}
+\section{Install and run time issues}
+\begin {itemize}
+\item{make} \\
+For some strange reasons (?!?), you may be warned that an error occured while documentation generation.\\
+Take it easy, \texttt{make} again!\\
+
+\item{\bbStudio} is written using the Advanced User Interface library of wxWidgets.
+If, after some hazardous floating/docking operations onto the frame, you feel
+very unhappy with the result, just remove from the hidden directory
+\texttt{.bbtk} the file named \texttt{bbStudio.aui}. \\
+
+
+\item{ \texttt{WARNING}} : if the script contains one or more \texttt{LayoutSplit}
+ object, you will have to resize the subwindows. \\
+
+\end {itemize}
%\section{Conclusion}
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff