\documentclass[11pt,final,a4paper]{article}
\input{config.tex}
\begin{document}
-\begin{center}
-
-{\Large \BBTK}
-\vspace{1cm}
-
-{\Huge User's Guide}
-\vspace{1cm}
-
-\bbtk version 1.0
-\vspace{0.5cm}
-
-
-Last modified on : September 16, 2008 \\
-Generated on : \today
-\vspace{0.5cm}
-
-Laurent Guigues, Jean-Pierre Roux
-\end{center}
-
-% ==========================================
-\tableofcontents
+\bbtkGuide[User's Guide]
% ==========================================
-\listoftables
-\listoffigures
-
-% ==========================================
-%\section*{Abstract}
% ==========================================
\newpage
-% ==========================================
\hrule
-\section{What is {\bf bbtk} ?}
+\section{Introduction}
+% ==========================================
+\subsection{What is bbtk ?}
% ==========================================
\BBTK(\bbtkns) is a set of tools
(\CPP libraries and executables)
of elementary processing \emph{units}, called {\bf black boxes},
and the definition and execution of processing \emph{chains}
made up of these black boxes. \\
-It's a part of the \texttt{Creatools suite} composed mainly of :
-\begin{verbatim}
- bbtk
- creaContours
- creaReaders
- creaViewers
- gdcm
- itk
- vtk
- wxWidgets
-\end{verbatim}
+
+%It's a part of the \texttt{Creatools suite} composed mainly of :
+%\begin{verbatim}
+% bbtk
+% creaContours
+% creaImageIO
+% creaLib
+
+%\end{verbatim}
+%which depend on the OpenSource libraries:
+%\begin{verbatim}
+% gdcm
+% itk
+% vtk
+% wxWidgets
+%\end{verbatim}
% ==========================================
-\subsection{The black box philosophy}
+\subsubsection{The black box philosophy}
% ==========================================
\href{http://www.answers.com/topic/black-box-theater}{The Answers Dictionary} defines a {\bf black box} as
\emph{``any component in a system in which only the input and output
characteristics are of interest, without regard to its internal mechanism
or structure''}. \\
-We should merge theese definitions. :
+We should merge these definitions. :
not only the inputs and outputs are of interest but also
\emph{what the box does} !
-Hence, I would say that a black box is any \emph{\bf documented}
+Hence, we would say that a black box is any \emph{\bf documented}
component of a system, letting the user know
\emph{\bf what} the box is supposed to do and
\emph{\bf how to use it}
\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}
\begin{itemize}
\item The definition of an {\bf interpreted script language},
which allows to manipulate packages and boxes very easily in symbolic way.
-\BBTK provides one : \bbi (the Black Box Interpreter).
+\BBTK provides one : \bbs (the Black Box Script language) and its interpreter
+\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} :
\end{itemize}
% ==========================================
-\subsection{\bbtk components}
+\subsubsection{\bbtk components}
% ==========================================
\BBTK includes :
\begin{itemize}
\item A \CPP {\bf\emph{library}} - called \bbtk - which defines a framework
(abstract classes) to develop black boxes and store them into
dynamic libraries, called black box \emph{packages}.
- \item Different {\bf\emph{black box packages}} :
+ \item Different {\bf\emph{"core" black box packages}} :
\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{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{creaReaders}} : Provides hight level widgets to read images, including DICOM.
- \item {\bf\emph{toolsbbtk}} : Tools for bbtk administration and package development..
+ %\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
- 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}} :
+ \end{itemize}
+ \item An standalone {\bf\emph{interpreter}}, called \bbins, which allows to
+ execute \bbs scripts or commands.
+ \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}.
%\item \bbdoc generates the html documentation of a black box package
%(author, description, description of its black boxes :
%author, description, inputs, outputs, and so on).
- \item \bbCreatePackage allows to create the basic file architecture
+ \item \bbCreatePackage allows to create the basic file architecture.
to start the development of a new black box package.
- \end{itemize}
- \end{itemize}
+ \item \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 \bbs2cpp translates a \texttt{.bbs} script into a \CPP file.
+ \item \bbc (sorry : Linux Only, for the moment) that compiles \texttt{.bbs} scripts into executables.
+ \item \bbRegeneratePackageDoc which creates the html documentation of the Package.
+ \item \bbRegenerateBoxesLists which creates the html pages of the various lists of all the currenly installed boxes.
+ \item \bbPlugPackage which automatically incorporates a new package.
+ \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}.
\end{center}
\end{figure}
-\newpage
+%%\newpage
% ==========================================
-\subsection{Structure of this guide}
+\subsection{Content of this guide}
% ==========================================
-This guide is divided into three parts.
-
-The first part (\ref{bbStudio}) is a brief presentation of the very intuitive Development
-environment, \bbStudions.
+Read this \texttt{Users' Guide} if you want to learn how to use
+\bbtk development environnement (\bbStudions) and how to write black box scripts.\\
+If you aim is to write your own Packages and Black Boxes, you have to read the
+\texttt{Package Developper's Guide}.
-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.
-
-
-% ==========================================
-% ==========================================
% ==========================================
+\newpage
+\hrule
+\section{Getting started with bbStudio}
+\label{bbStudio}
% ==========================================
+
+
% ==========================================
+\subsection{The interface}
% ==========================================
-\vspace{0.5cm}\hrule
-\section{The Development environment (bbStudio)}
-\label{bbStudio}
+
+
+%\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.
-At start, \bbStudio opens with a very minimal 'How to use' in the middle. \\
-Don't forget to read it : it will vanish at the first mouse click. \\
-\begin{verbatim}
-1) Click on the 'Demo' or 'Examples' link.
-2) Select a Demo or an Example
-3) Click on the [Source] link : the source file is loaded in bbStudio
-4) Click on the 'Run button' (the down arrow at the bottom right
- of the source file).
-\end{verbatim}
-
You'll get something like in figure
\ref{bbi-fig-bbStudio-gui-start}
-(the exact appearance of \bbStudio is Operating System and \bbtk version dependent)
+(the exact appearance of \bbStudio is Operating System and \bbtk version dependent).
+
+At start, \bbStudio opens with a very minimal 'How to use' in the middle.
+Don't forget to read it : it will vanish at the first mouse click.
+
\begin{figure}[!ht]
\caption{\label{bbi-fig-bbStudio-gui-start}The bbStudio Development environment interface at start time}
\end{center}
\end{figure}
+%Let's have a look at the resized window :
+%\begin{figure}[!ht]
+%\caption{\label{bbi-fig-bbStudio-gui}The bbStudio Development environment interface}
+%\begin{center}
+%\includegraphics[width=0.7\textwidth]{bbStudioMainPage.png}
+%\end{center}
+%\end{figure}
+
+The interface is divided into four parts : \texttt{Files}, \texttt{Messages},
+ \texttt{Command}, \texttt{Help}.
+It 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.
+Feel free to resize/reposition any part you want.
+Your preferences will be kept next time you run again \bbStudions.
+
+%Please don't use this feature at learning time
+%(the snapshots of this document wouldn't match with your screen ...)
+
+\subsubsection{'Files' part}
+\label{bbi-FilesPart}
-Feel free to resize any part you want.
-Your preferences will be kept next time you run again \bbStudio. \\
+It's the \bbs script editor.
-Let's have a look at the resized window :
+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 (see figure \ref{lowertoolbar})
\begin{figure}[!ht]
-\caption{\label{bbi-fig-bbStudio-gui}The bbStudio Development environment interface}
+\caption{\label{lowertoolbar}The 'Files' lower tool bar}
\begin{center}
-\includegraphics[width=0.7\textwidth]{bbStudioMainPage.png}
+\includegraphics[width=0.7\textwidth]{lowertoolbar2.png}
\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}
-
-The stuff is written using the Advanced User Interface library of wxWidgets,
-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}
-\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
+% \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.
+You can type here \bbs commands which are executed on the fly.
+The buttons are shortcuts to usual commands.
-\subsection{'Help Contents' part}
+\subsubsection{'Help' part}
\label{bbi-HelpContentsPart}
-The 'Help Contents' part of \bbStudio is used to browse the html help of \BBTK.
-All the entries of the starting page are self-explanatory :
- \begin{itemize}
- \item {\bf\emph{Help Contents}}
- \begin{itemize}
- %\item {\bf\emph{Wiki}} : Direct link to the bbtk Wiki (intranet only, right now, www
- %later).
- \item {\bf\emph{Demo}} : Link to some 'sophisticated' demonstrations.
- \item {\bf\emph{Examples}} : Link to some detailed 'How to use' examples
- \end{itemize}
-
- \item {\bf\emph{Guides}}
- \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 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{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}
-
- \end{itemize}
+The 'Help' part of \bbStudio is used to browse the html help of \BBTKns.
-% ==========================================
-\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{creaReaders} & : 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}
+%\newpage
-Using the lower tool bar (see figure : \ref{lowertoolbar}), you can :
+% ==============================================
+\subsection{Running Demos and Examples}
+% ==============================================
+In the 'Help' part (See figure \ref{HelpContents}), select \texttt{Examples} link.
\begin{figure}[!ht]
-\caption{\label{lowertoolbar}The lower tool bar}
+\caption{\label{HelpContents}\bbStudio 'Help' panel}
\begin{center}
-\includegraphics[width=0.7\textwidth]{lowertoolbar.png}
+\includegraphics[width=0.7\textwidth]{HelpContents.png}
\end{center}
\end{figure}
+%\newpage
- \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
-
+You will get a list of examples (See figure \ref{example}).
-% ==========================================
-\subsection{Getting started}
-\label{bbi-getting-started}
+Note : due to an unfixed bug in Linux, you have to click on 'reload' to get it. \\
-% ==============================================
-\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. \\
+\begin{figure}[!ht]
+\caption{\label{example}Examples list}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{example.png}
+\end{center}
+\end{figure}
-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 bin directory of the built tree and type \texttt{./bbStudio}.
-% ==============================================
-\subsubsection{Using an already existing script}
-% ==============================================
+%\begin{figure}[!ht]
+%\caption{\label{BoxCategories}Box Categories}
+%\begin{center}
+%\includegraphics[width=0.7\textwidth]{BoxCategories.png}
+%\end{center}
+%\end{figure}
-Run \bbStudio the way you need. \\
-In the part 'Help contents' (See figure \ref{HelpContents}), select \texttt{Examples} link.
+Select \texttt{wx::exampleSlider}.
+
\begin{figure}[!ht]
-\caption{\label{HelpContents}Help Contents}
+\caption{\label{exampleSlider}Html documentation of example 'exampleSlider'}
\begin{center}
-\includegraphics[width=0.7\textwidth]{HelpContents.png}
+\includegraphics[width=0.7\textwidth]{exampleSlider.png}
\end{center}
\end{figure}
-You will be asked to select a Box category (See figure \ref{BoxCategories}); \\
-Select \texttt{example}.
+You can see information on the example and
+the graphical representation of the workflow defined by the script
+(the elementary boxes that compose it, and their connections, see figure \ref{exampleSlider}).
+Click on \texttt{[source]}, it will be loaded
+in the 'Files' part, within the script editor (See figure \ref{exampleSliderSource});
\begin{figure}[!ht]
-\caption{\label{BoxCategories}Box Categories}
+\caption{\label{exampleSliderSource}Source code of 'exampleSlider'}
\begin{center}
-\includegraphics[width=0.7\textwidth]{BoxCategories.png}
+\includegraphics[width=0.7\textwidth]{exampleSliderSource.png}
\end{center}
-\end{figure}
+\end{figure}
-You will be asked to choose a script (See figure \ref{example}).
+Run it, using the 'Files' toolbar (see figure \ref{lowertoolbar})
+
+You'll get something like in figure \ref{execSliderSource}.
\begin{figure}[!ht]
-\caption{\label{example}example list}
+\caption{\label{execSliderSource}Execution of 'exampleSlider'}
\begin{center}
-\includegraphics[width=0.7\textwidth]{example.png}
+\includegraphics[width=0.7\textwidth]{execSliderSource.png}
\end{center}
\end{figure}
+Feel free to move the slider, to check whether it actually works...
+
+%\newpage
+
+Just a few words on what you saw :
+\begin{itemize}
+\item{In the source code of the script} : \\
+\begin{verbatim}
+ load std
+ load wx
+\end{verbatim}
+These \bbs commands load the packages std and wx
+\begin{verbatim}
+ new Slider slider
+ set slider.ReactiveOnTrack 1
+\end{verbatim}
+We create a \texttt{Slider} box called \emph{slider}.
+
+We tell it to inform anybody that's interested in, that the cursor moved, each time it moved.
+The default behaviour is to inform only when cursor is released.
+\begin{verbatim}
+ new OutputText text
+\end{verbatim}
+We create an \texttt{OutputText} box called \emph{text}
+(in which slider value will be displayed)
+
+\begin{verbatim}
+ new LayoutLine layout
+\end{verbatim}
+We create a \texttt{LayoutLine} box called \emph{layout},
+a widget box designed to embed other widgets (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.
+This also produces the execution of the boxes connected to it (the slider, the text).
+
+\item{In the Help part}
+
+You can see the graphical representation of the workflow (pipeline) created by the script,
+as in figure \ref{SmallGraph}.
-Select \texttt{wx::exampleSlider} (See figure \ref{exampleSlider});
-
\begin{figure}[!ht]
-\caption{\label{exampleSlider}example 'exampleSlider'}
+\caption{\label{SmallGraph}Graphical representation of a pipeline}
\begin{center}
-\includegraphics[width=0.7\textwidth]{exampleSlider.png}
+\includegraphics[width=0.7\textwidth]{SmallGraph.png}
\end{center}
\end{figure}
-You can see the graphical summary representation of the current script (the elementary boxes that compose it, and their
-connections) \\
-Click on \texttt{source}, and you'll be able to see the (very simple) script,
-in the 'Files' part, within the script editor (See figure \ref{exampleSliderSource});
+The representation includes
+both the graphical interface-related pipeline
+(\emph{slider} and \emph{text} are embedded into \emph{layout})
+ and the data processing-related pipeline
+(\emph{slider} warns \emph{text} immediately when it's modified,
+\emph{slider} passes \emph{text} its output value)\footnote{Yes, we know : all the arrows (graphical interface pipeline arrows and data processing arrows)
+are blue; using different colors is planned for next release...}.
+
+You can get a much more detailled graph,
+like in figure \ref{LargeGraph},
+just clicking on the button
+'\texttt{graph (detailled)}' in the toolbar of the \texttt{Command} part.
+
\begin{figure}[!ht]
-\caption{\label{exampleSliderSource}source code of 'exampleSlider'}
+\caption{\label{LargeGraph}Detailled graphical representation of a pipeline}
\begin{center}
-\includegraphics[width=0.7\textwidth]{exampleSliderSource.png}
+\includegraphics[width=0.75\textwidth]{LargeGraph.png}
\end{center}
-\end{figure}
+\end{figure}
+
+\end{itemize}
+%\newpage
+
+% ==============================================
+\subsection{Online Help}
+% ==============================================
+
+Various levels or help are supplied 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 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.
+Command line help for the black box scripting language (\bbsns) can be obtained
+in this zone (see \ref{Scripting}).
-Run it, using the lower toolbar (see figure : \ref{lowertoolbar})
+% ==========================================
+\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}} : This guide !
+ \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 probably 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 files. Should only concern the kernel developpers.
+ \end{itemize}
+
+
+
+
+% ==========================================
+\subsubsection{Boxes Help}
+% ==========================================
+ Lists of currently available boxes from installed packages
+ \begin{itemize}
+ \item {\bf\emph{Alphabetical list}} : %This is the 'zero-level' of retrieving.
+ \item {\bf\emph{List by package}} Boxes indexed by package
+ \item {\bf\emph{List by category}} :
+ Each box is indexed by a list of keywords, called 'categories', such as '\texttt{read/write}',
+ '\texttt{filter}', '\texttt{viewer}', ...
+ A given box may belong to more than one \texttt{category}, however some categories are mutually exclusive.
+ Standard categories are :
+ \begin {itemize}
+ \item\texttt{atomic box}/\texttt{complex box}\\
+ Whether it's an 'atomic' unit written is C++ and available in binary form in a package or it's an assembly of several black boxes (atomic or complex) which is described in \bbs script language.\\
+ Any box is either atomic ou complex.\\
+ Any pipeline described in a \bbs script is itself viewed as a complex black box hence is tagged as belonging to this category.
+ \item\texttt{example} / \texttt{demo} / \texttt{application}\\
+ These ones are scripts which produce a result when executed (i.e. they
+ execute a pipeline like \texttt{exampleSlider} above), as oposite to the scripts which only define complex boxes but do not instanciate and execute boxes.
+ \begin {itemize}
+ \item\texttt{example} : It's just a (simple) example, for programmers, on how to use a given feature. The \texttt{Examples} link on the starting page links to the list of the boxes of this category.
+ \item\texttt{demo} : It can be a 'good looking' (a.k.a 'sexy') example on some sophisticated work, done only by using \texttt{bbtk}. The \texttt{Demos} link on the starting page links to the list of the boxes of this category.
+ \item\texttt{application} : It's a final application, end user intended (e.g. Subscale a huge volume without loading it in memory, Crop a DICOM image, etc.)
+ \end {itemize}
+ \item\texttt{widget} : A piece of graphical interface (based on \texttt{wxWidgets})
+ \item\texttt{dicom} : Dicom medical image-related box.
+ \item\texttt{viewer} : A box allowing to view something (e.g. an image).
+ \item\texttt{read/write} : An I/O-related box
+ \item\texttt{mesh} : A mesh-related box
+ \item\texttt{filter} : A filter, mainly image filters.
+ \item\texttt{image} : An image-related box
+ \item\texttt{3D object creator} : A box which creates a 3D object to be injected into a 3D view (e.g. a plane, a surface).
+ \item\texttt{math} : Math
+ \item\texttt{misc} : Miscellaneous...
+ \end {itemize}
+ Remark that the list of categories is 'auto-extensible' : each time a new box is created which belongs to a new category and the boxes list is regenerated, then the new category appears in the list, holding the new box. The above list only contains the categories used in the packages provided with current \bbtk release.
+ \item {\bf\emph{ List of adaptors}} : The adaptors are a special type of black box which are used internaly to perform type conversions. Thought there are not end user intended, you may see their list. Adaptors belong to the \texttt{adaptor} category.
+ \end {itemize}
+
+% ==========================================
+\subsubsection{The Package Browser}
+\label{Package_Browser}
+% ==========================================
-You'll get something like in \ref{execSliderSource}.
+The package browser is a standalone application which
+dynamically loads and queries the available packages.
+It is thus a smarter tool than the static html documentation.
+You can run it with the command \texttt{bbPackageBrowser}
+or in \bbStudio using either the button of the 'Command' part
+or the menu entry 'Windows$>$Start Package Browser'.
+Remark that it may take some time to start because it loads all available
+packages at start.
+Its appearance is reproduced in figure \ref{imPackage_Browser}.
\begin{figure}[!ht]
-\caption{\label{execSliderSource}execution of 'exampleSlider'}
+\caption{\label{imPackage_Browser}The Package Browser}
\begin{center}
-\includegraphics[width=0.7\textwidth]{execSliderSource.png}
+\includegraphics[width=0.6\textwidth]{Package_Browser.png}
\end{center}
\end{figure}
-Feel free to move the slider, to check it actually works...
+It allows you to find boxes using a multi-criteria filtering principle :
+The boxes listed are the one whose attributes match \emph{all} the
+words entered in the 'Filter' part.
+You can get the whole description of a given box clicking on its name.
+Warnings :
-\newpage
+\begin{itemize}
+\item It's case sensitive, i.e '\texttt{Button}'
+will give different results than '\texttt{button}'
+\item You have to press enter in the filter zone to update the boxes list
+\item A filtering string only has to match a subpart of the related attribute of a box.
+For example, entering 'utt' in the 'Name' attribute will match a box called 'Button'.
+\end{itemize}
-% ==========================================
-\subsubsection{Creating and executing black boxes}
-% ==========================================
+Attributes :
+
+\begin {itemize}
+\item Package : The name of the package to which the box belongs (e.g. \texttt{wxvtk}, \texttt{std})
+\item Name : The name of a box or an application (e.g. \texttt{Reader}, \texttt{example})
+\item Description : A part of the description of a box (e.g. \texttt{3D}, \texttt{image})
+\item Category : The categories of the box (e.g. \texttt{demo})
+\item Input/Output Type : The \CPP type of an input or output (e.g. \texttt{int}, \texttt{vtkImageData*}, \texttt{std::string})
+\item Input/Output Nature : The \texttt{nature} of an input or output (e.g. \texttt{file name}, \texttt{signal})
+\end {itemize}
-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)
+%If 'Show widgets' is selected then
-%\footnote{If you compiled \bbtk without \wx then \bbi does not have a
-%graphical interface but a simple prompt}.
+
+%%\newpage
+
+% ==============================================
+\subsection{The Menu}
+% ==============================================
+
+At last, let's have a look at \bbStudio menu.(See figure \ref{themenu})
\begin{figure}[!ht]
-\caption{\label{bbi-fig-bbi-gui}The black box interpreter interface}
+\caption{\label{themenu}The bbStudio menu}
\begin{center}
-\includegraphics[width=0.7\textwidth]{bbi-gui0.png}
+\includegraphics[width=0.7\textwidth]{themenu.png}
\end{center}
\end{figure}
-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
-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
+\begin {itemize}
+ \item{\texttt{File}}
+ \begin {itemize}
+ \item{\texttt{Open the bbtk configuration file}}
+ \item{\texttt{Quit}}
+ \end {itemize}
+ \item{\texttt{Tools}}
+ \begin {itemize}
+ \item{\texttt{Create package}} :
+ Provides a graphical interface to help package developpers to create a new empty package.
+ \item{\texttt{Create black box}}
+ Provides a graphical interface to help package developpers to create a new empty black box, and add it to an already existing package.
+ \item{\texttt{Plug Package}}
+ Incorporates a package into the list of known packages. Updates the html documentation.
+ \item{\texttt{Regenerate package doc}} :
+ If a package has changed (e.g. new boxes) this updates the package html documentation.
+ \item{\texttt{Regenerate boxes list}} :
+ Updates the boxes lists (alphabetical, by package, ...)
+ \item{\texttt{Regenerate all}}
+ Regenerates all the packages documentations and the boxes lists (may be long...).
+ \item{\texttt{Show last graph}}
+ Shows the last pipeline graph that was generated
+ \end {itemize}
+ \item{\texttt{Options}}
+ \begin {itemize}
+ \item{\texttt{Reset before running}} Before running a script, all the already created boxes are destroyed,
+ all the already loaded packages are unloaded (this is the recomended option).
+ \end {itemize}
+ \item{\texttt{Windows}}
+ User may decide, for any reason of his own, to hide one or more panels:
+ \begin {itemize}
+ \item{\texttt{Show 'Files' panel}}
+ \item{\texttt{Show 'Help' panel}}
+ \item{\texttt{Show 'Command' panel}}
+ \item{\texttt{Show 'Messages' panel}}
+ \item{\texttt{Start Package browser}} : starts the package browser (see \ref{Package_Browser}).
+ \end {itemize}
+ \item{\texttt{About}}
+ \begin {itemize}
+ \item{\texttt{About}} : Info about \texttt{bbStudio}.
+ \end {itemize}
+\end {itemize}
+
+
+
+
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+\newpage
+\hrule
+\section{Writing black box scripts (\bbsns)}
+\label{Scripting}
+% ==========================================
+% ==========================================
+% ==========================================
-Try typing in the input zone (in this manual,
+This section introduces how to write down black box scripts (\bbsns)
+to create and execute pipelines.
+
+% ==========================================
+\subsection{The commands}
+% ==========================================
+In \bbStudio, try typing in the \texttt{Command} area (in what follows,
the commands entered by the user will be preceded by a prompt \textgreater) :
\begin{verbatim}
> help
\end{verbatim}
To get help on a particular command type \texttt{help <command-name>},
-for example :
+for example:
\begin{verbatim}
> help author
\end{verbatim}
\end{verbatim}
The \texttt{help} command has multiple usages.
-It is used to get help about almost anything in the interpretor!
+It is used to get help about almost anything in the interpreter!
Type \texttt{'help help'} to get help on the \texttt{help} command itself :
\begin{verbatim}
> help help
of a black box instance.
\end{verbatim}
-At start the interpretor does not know any black box.
+%More information about what is a 'box' will be given in the 'Scripting' part of this manual.
+
+
+% ==========================================
+\subsection{Creating and executing black boxes}
+% ==========================================
+
+At start the interpreter does not know any black box.
If you type \texttt{'help packages'}, which is
the third form of the \texttt{help} command, you get :
\begin{verbatim}
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
\end{verbatim}
Now the interpreter knows the package \texttt{std} and the black boxes it provides,
-such as the \texttt{'Add'} box, the \texttt{'ConcatStrings'} box, and so on. Remark that the
+such as the \texttt{Add} box, the \texttt{ConcatStrings} box, and so on. Remark that the
content of \texttt{std} may vary from one version to another
as new black boxes might be added to it.
If you type :
'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}) :
-
-\begin{figure}[!ht]
-\caption{\label{HelpAdd}The html Help}
-\begin{center}
-\includegraphics[width=0.7\textwidth]{HelpAdd.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.
-
-You can create an \emph{instance} of an \texttt{Add} box by
+After loading the package it belongs to, you can create an \emph{instance} of an \texttt{Add} box by
the command \texttt{new} :
+
\begin{verbatim}
> new Add a
\end{verbatim}
a \emph{box type} , like \texttt{int} is a data type
in \texttt{C} langage. The \texttt{new} command allows to create
an instance of a box type, exactly like \texttt{int i;} in
-a \texttt{C} code, it declares a variable of type \texttt{int} whose
+a \texttt{C} code 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. \\
After the creation of the box \texttt{a}, type :
\begin{verbatim}
which means that \bbi workspace now contains a black box named \texttt{a},
of type \texttt{std::Add}.
-Now look back at the help on \texttt{Add} boxes :
-you can see that this type of box has two inputs,
-with name \texttt{In1} and \texttt{In2},
-and an output, with name \texttt{Out}.
-You can set the input \texttt{In1}
-of the \texttt{Add} box \texttt{a} to the value $1$
-by the command :
+Type
\begin{verbatim}
-> set a.In1 1
+Help Add
\end{verbatim}
+ and 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}
-Similarly, setting the input \texttt{In2} of \texttt{a} to the value $2$
-is done with :
+
+You can see 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} ,
+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
+include a pipeline graph.
+
+You can see that \texttt{Add} boxes have two inputs,
+with name \texttt{In1} and \texttt{In2},
+and an output, with name \texttt{Out}.
+
+You can set the input \texttt{In1}
+of the \texttt{Add} box \texttt{a} to the value $1$
+by the command :
+\begin{verbatim}
+> set a.In1 1
+\end{verbatim}
+
+Similarly, setting the input \texttt{In2} of \texttt{a} to the value $2$
+is done with :
\begin{verbatim}
> set a.In2 2
\end{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. \newline
%To exit \bbi, type :
%\begin{verbatim}
%Good bye !
%\end{verbatim}
+
+
% ==========================================
\hrule
% ==========================================
% ==========================================
-\subsubsection{Connecting black boxes}
+\subsection{Connecting black boxes}
\label{bbi-connecting-black-boxes}
% ==========================================
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},
-whose output is requested, is not up to date.
+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
Some explainations : the \texttt{include} instructions load the necessary packages. \\
-\texttt{new FileSelector} will pop a File Selector, at run time, that will out the user chosen file name. \\
-\texttt{new Slider} will pop a Slider, at run time, that will out an integer, used later as a slice number.\\
-\texttt{new ImageReader} will read any itk readable file, whose name is passed as a std::string, and return a itk::ImagePointer.\\
-\texttt{new Viewer2D} display a plane, whose number id specified by an integer.\\
+\texttt{FileSelector} will pop a File Selector, at run time, that will out the user chosen file name. \\
+\texttt{Slider} will pop a Slider, at run time, that will out an integer, used later as a slice number.\\
+\texttt{ImageReader} will read any itk readable file, whose name is passed as a std::string, and return a pointer on an itk image.\\
+\texttt{Viewer2D} displays a plane, whose number is specified by an integer.\\
\\
\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 reader.Out viewer.In} plugs the output of the reader (an bbtk::any<bbitk::ImagePointer> which is a type defined by the
+itk package which can hold any itk image pointer) 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
% ==========================================
% ==========================================
-\subsubsection{Creating complex black boxes}
+\subsection{Creating complex black boxes}
\label{bbi-complex-black-boxes}
% ==========================================
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,
As a side note, we can say that, for consistency reasons, it would have been better to name
\texttt{In1}, \texttt{In2} and \texttt{In3} the inputs of the black box \texttt{Add3},
since all the 'natural entry' of a box is named \texttt{In}, or \texttt{In}\emph{x} if there are more than one 'natural
-entry'.
-
+entry'
+.
+\newline
% ==========================================
\hrule
\paragraph{Summary}
% ==========================================
% ==========================================
-\subsubsection{Writing scripts}
+\subsection{Writing scripts files}
\label{bbi-writing-scripts}
% ==========================================
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.
-Doing this, you start writing \bbi scripts.
-The conventionnal (and mandatory) extension for such scripts is \texttt{bbs}
+write the \bbs commands defining the new box
+into a text file and afterwards include that file in \bbins.
+Doing this, you start writing \bbs scripts.
+The conventional (and mandatory) extension for such scripts is \texttt{bbs}
(black box script).
For consistency reasons, you are requested to prepend \texttt{bb} to the name.
> include Add3
\end{verbatim}
-\subsubsection{Creating complex black boxes that use complex black boxes}
+\subsection{Creating complex black boxes that use complex black boxes}
\label{bbi-complex-complex-black-boxes}
\end{file}
+The inner boxes have they own entries (In1, In2, In3 for box a, In1, In2 for box b )\\
+Only the inputs In1, In2, In3 of box a and the input In2 of box b is of interest for the end user, but he dosn't want to have to
+care neither about the inner boxes name, nor about the names of their Inputs.\\
+The writer of the complex box has the ability to give these inputs a meaningfull name !
+\begin{verbatim}
+ input In3 a.In3 "third double to add"
+ input In4 b.In2 "fourth double to add"
+\end{verbatim}
+
-\subsubsection{Naming Conventions}
+\subsection{Naming Conventions}
\label{bbi-Naming Conventions}
can be defined in the \texttt{bbAdd3.bbs} file.
\item
Search Paths :
-For consistency reasons, the names of dynamic libraries holding the packages must start by \texttt{libbb}.
-For instance, the package \texttt{wx} will be in the library \texttt{libbbwx.dll} (Windows) or \texttt{libbbwx.so}
+For consistency reasons, the names of dynamic libraries holding the packages start by \texttt{bb}.
+For instance, the package \texttt{wx} will be in the library \texttt{bbwx.dll} (Windows) or \texttt{libbbwx.so}
(Linux).
\begin{itemize}
\item The \texttt{include} command tells the interpreter to include a script file.
\item Lines starting with a \texttt{\#} or with a \texttt{\//\//} are considered as comments by the interpreter.
-\item Lines between a line starting with a \texttt{\//*} an a line starting with a \texttt{*\//} are considered as comments by the interpreter.
+\item Lines between a line starting with a \texttt{\//*} an a line ending with a \texttt{*\//} are considered as comments by the interpreter.
\end{itemize}
\hrule
% ==========================================
% ==========================================
-\subsubsection{Creating command line applications}
+\subsection{Creating command line applications}
\label{bbi-command-line-app}
% ==========================================
x+y=7
\end{verbatim}
-\bbStudio is always compiled in graphical mode (with \wx), therefore
-you can also use the \texttt{-g} commutator.
+You can also use the \texttt{-g} commutator.
\bbi then prompts the user in graphical mode,
displaying a dialog box for each input,
like in fig. \ref{bb-input-dialog-box}.
\end{center}
\end{figure}
+Note that for both \texttt{-t} and \texttt{-g} options,
+the input from the user is a \texttt{string} and
+\bbi converts it to the right input type using
+an \texttt{adaptor}, hence the right adaptors must be loaded.
+
% ==========================================
\hrule
\paragraph{Summary}
% ==========================================
% ==========================================
-\subsubsection{Using graphical interface boxes (widget boxes)}
+\subsection{Using graphical interface boxes (widget boxes)}
\label{bbi-widget}
% ==========================================
% ==========================================
-\subsubsection{Overwiew}
-\label{bbi-overview}
+%\subsubsection{Overview}
+%\label{bbi-overview}
% ==========================================
-\bbStudio is always compiled in graphical mode
-(option \texttt{BUILD\_bbi\_GRAPHICAL} of \cmakens, requires \wxns),
-then you can use special black boxes which are
-graphical interface components (widgets).
-Basic components are provided in the package \texttt{wx},
+Basic graphical interface components are provided in the package \texttt{wx},
such as buttons, sliders, file open/save dialogs, etc.
As first example, type the following commands in \bbi :
\end{verbatim}
You can reproduce the same experiment as above using a
-\texttt{Slider} or a \texttt{FileDialog} rather than a \texttt{InputText}.
-See the files \texttt{test*.bbs} in the \texttt{scripts/test} directory.
+\texttt{Slider} or a \texttt{FileDialog} rather than a \texttt{InputText}..
-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
+% ==========================================
+%\subsubsection{Layout widgets}
+%\label{bbi-layout-widgets}
+% ==========================================
+
+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,
+``splits'' a window into two parts, either horizontally or vertically,
each part including another widget.
-The size of the two parts can be adjusted by the user thanks
-to a ``handle''.
+The initial size of the two parts can be fixed by the input 'Proportion'
+and be adjusted by the user thanks to a ``handle''.
-The script \texttt{scripts/test/testSplit.bbs} demonstrate its use.
+The example \texttt{exampleLayoutSplit} demonstrates its use.
Run it : it displays a window with two sliders.
Move the sliders and close the window.
-The final positions of the sliders are printed out.
-Now edit the file to see how this is done :
+Now look at the source file to see how this is done :
\begin{file}{scripts/test/testSplit.bbs}
\begin{verbatim}
-load std
load wx
new Slider s1
connect s1.Widget s.Widget1
connect s2.Widget s.Widget2
-print s1=$s1.Out$\\n
-print s2=$s2.Out$\\n
+exec s
\end{verbatim}
\end{file}
First, the two sliders \texttt{s1} and \texttt{s2} are created.
A \texttt{LayoutSplit} box \texttt{s} is also created.
The \texttt{connect} commands then ``includes'' the sliders in the
-split ``container''.
+split widget.
The input \texttt{Widget} is common to all widget boxes :
every widget can be inserted into another widget.
-The outputs \texttt{Widget1},\texttt{Widget2} are specific of \emph{container}
+The outputs \texttt{Widget1},\texttt{Widget2} are specific of \emph{layout}
widgets
(in \bbi type \texttt{help Slider} :
you will see the output \texttt{Widget};
type \texttt{help LayoutSplit} :
you will see the inputs \texttt{Widget1} and \texttt{Widget2}
and the output \texttt{Widget}).
-When you connect the \texttt{Widget} output of a container
-to the \texttt{Widget}i input of a widget,
-you order to include the widget in the container.
+When you connect the \texttt{Widget} output of a box
+to the \texttt{Widget}i input of a layout widget,
+you order to include the widget in the layout.
Of course, the order of connection is important.
In our case, the slider \texttt{s1} is included first,
then the slider \texttt{s2} : \texttt{s1} will be placed
on top of \texttt{s2} (the \texttt{LayoutSplit} box is
implemented that way, but this is arbitrary choice).
-Right now, there are only \emph{three} container widgets in the \texttt{wx} package :
+Right now, there are only \emph{three} layout widgets in the \texttt{wx} package :
\begin{itemize}
-\item {the \texttt{LayoutSplit} widget} we just described, the \texttt{LayoutLine} , and the \texttt{LayoutTab}
-widget.
+\item {the \texttt{LayoutSplit} widget} we just described
-\item {the \texttt{LayoutLine} widget} can have multiple children and
+\item {the \texttt{LayoutLine} widget} can have multiple children
+(\texttt{Widget1}, \texttt{Widget2},\dots \texttt{Widget9} inputs) and
divides its window into as much parts as children,
each part of equal size.
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).
-See the script \texttt{bbtk/share/bbtk/bbs/wx/appli/ExampleLayoutSplit.bbs} for an example.
+With only those two layout widgets you can already create
+complex dialog boxes
+(of course layouts can be nested, which leads to tree-like
+structures of widgets). \\
+See the script \texttt{exampleComplexLayoutSplit\_In\_LayoutSplit} for an example.
+
+\item {The \texttt{LayoutTab} widget} arranges its children
+in different pages or 'tabs' (\texttt{wxNotebook}-based).
+The label of each page is the name of the widget it contains.
-\item {The \texttt{LayoutTab} widget} is based on the \texttt{wxNotebook.}\\
-The label of each 'note book' is the name of the object it contains.
\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}
+\subsection{Deeper in the boxes}
\label{bbi-deep-box}
% ==========================================
-Any widget box has two mandatory Inputs :
+\subsubsection{Default and mandatory inputs and outputs}
+\begin{itemize}
+\item Any \texttt{atomic} black box has two default Inputs, which are created by the system :
\begin{itemize}
\item {\bf\emph{BoxExecute}} : Any signal received by this input executes the box
\item {\bf\emph{BoxProcessMode}} : Sets the processing mode of the box :
\begin{itemize}
- \item {\bf\emph{Pipeline}} : bbBackwardUpdate() calls Process() only if Status == MODIFIED \\
- The box executes itself only when an entry was changed (normal pipeline processing).
- \item {\bf\emph{Reactive}} : bbSetModifiedStatus() calls bbUpdate() \\
- Warning : Re-processed immediately when \emph{any entry} changed.\\
- To be more selective, better use \texttt{connect A.BoxChange \emph{currentBox}.BoxExecute}.
- \item {\bf\emph{Always}} : bbUpdate() always calls Process. \\
- Usefull for 'sources', that must be processed, even when no entry changed (e.g. : FileSelector, ColorSelector)\\
+ \item {\bf\emph{Pipeline}} :% bbBackwardUpdate() calls Process() only if Status == MODIFIED \\
+ The box executes itself only when an input was changed (normal pipeline processing).
+ \item {\bf\emph{Reactive}} : %bbSetModifiedStatus() calls bbUpdate() \\
+ Re-processes immediately when \emph{any input} changes.\\
+ To be more selective, better use
+ '\texttt{connect A.BoxChange B.BoxExecute}'.
+ \item {\bf\emph{Always}} :% bbUpdate() always calls Process. \\
+ Usefull for 'sources', that must be processed, even when no input changed (e.g. : FileSelector, ColorSelector)\\
This one is not end user intended (for Package developer only)
\end{itemize}
\end{itemize}
+\item And one default output :
+\begin{itemize}
+ \item {\bf\emph{BoxChange}} : Signals any modification of the box. This output may be connected if necessary to the \emph{BoxExecute}
+ input of an other box : each time the boxes changes (e.g. a Slider is moved) the box it is connected to will be forced to update.
+\end{itemize}
+
+If you create complex boxes, it is a good idea to define those inputs and outputs to be able
+to force the execution of your complex box or be aware of its changes...
-Any widget box has five Inputs, that will be dealt with only if the box is not connected to the \emph{Widget}i of any \emph{Layout box} :
+\item Any {\bf widget} box has five Inputs, that will be dealt with only if the box is not connected to the \emph{Widget}i of any \emph{Layout} box :
\begin{itemize}
\item {\bf\emph{WinHeight}} : Height of the window
\item {\bf\emph{WinWidth}} : Width of the window
\item {\bf\emph{WinDialog}} : When set to 'true', creates a \emph{dialog window}, that blocks the pipeline until it is closed (\emph{modal})
\end{itemize}
+If you define a complex widget box, it is a good idea to define these inputs to be able
+to customize your window settings.
+
+\item Any {\bf widget} box has one mandatory Output :
-Any \emph{Layout box} (i.e. \emph{LayoutLine}, \emph{LayoutSplit} or \emph{LayoutTab}) has at one or more mandatory Inputs :
+\begin{itemize}
+ \item {\bf\emph{Widget}} : that is the \texttt{wxWindow} itself. If it's not connected to the \texttt{Widget}\emph{i} of any \emph{Layout box}, then the box will create its own window (frame or dialog) on execution. If it's connected to the \texttt{Widget}\texttt{\emph{i}} of a \texttt{Layout box},
+ it will be embedded in its parent window.
+\end{itemize}
+
+If you define a complex widget box, it is a good idea to use this standard name for your window output
+
+\item Any {\bf Layout} box (i.e. \emph{LayoutLine}, \emph{LayoutSplit} or \emph{LayoutTab}) has one or more mandatory Inputs :
\begin{itemize}
\item {\bf\emph{Widget}}\texttt{i} : e.g. a \emph{LayoutSplit} box (Widget which splits a window in two resizeable parts)
has two Input parameters \emph{Widget1} and \emph{Widget2}, used to embed the child windows.\\
e.g. a \emph{LayoutLine} divides the window in up to 9 (depending on the number of inputs \emph{Widget}i) fixed size parts.
\end{itemize}
+If you define a complex layout box, it is a good idea to use these standard names for your
+sub-windows inputs.
-Any widget box has two mandatory Outputs :
+\end{itemize}
-\begin{itemize}
- \item {\bf\emph{Widget}} : that is the \texttt{wxWindow} itself. If it's not connected to the \texttt{Widget}\emph{i} of any \emph{Layout box}, it
- will popup. If it's connected to the \texttt{Widget}\texttt{\emph{i}} of any \texttt{Layout box}, it will be embedded in its parent window.
- \item {\bf\emph{Boxchange}} : Signals any modification of the box. This output may be connect if necessary to the \emph{BoxExecute} entry of an other box,
- further within the execution pipeline.
-\end{itemize}
+% ==========================================
+%\subsection{More on ...}
+%\label{bbi-more-on}
+% ==========================================
+% ==========================================
+%\subsubsection{Black box packages}
+%\label{bbi-more-on-packages}
+% ==========================================
+%There are various others user-intended packages :
+%\begin{verbatim}
+%---> Were moved in a 'Reference Manual' ?\\
+%---> Any suggestion welcome!
+%\end{verbatim}
+
+%\begin{itemize}
+%\item{vtk} \\
+%\item{itk} \\
+%\item{...} \\
+%\end{itemize}
% ==========================================
-\subsection{More on ...}
-\label{bbi-more-on}
+%\subsubsection{Pipeline processing}
+%\label{bbi-more-on-pipeline-processing}
% ==========================================
+%\begin{itemize}
+%\item the ``control'' mechanism in bbi.
+
+%When a box is requested to update itself, it asks (recursively) each one of its inputs if it was modified.\\
+%In normal pipe-line mode, it will be re-processed if at least one of its imputs was actually modified, as the output of a previous box.
+
+%(switch exec commands, e.g. Button)
+%\item the role of ProcessMode to update widgets.
+%\end{itemize}
+
+%\subsubsection{Advanced issues}
+%\paragraph{Reducing the number of inputs of a box}
% ==========================================
-\subsubsection{Black box packages}
-\label{bbi-more-on-packages}
+%\subsubsection{Errors}
+%\label{bbi-more-on-errors}
+
% ==========================================
-There are various others user-intended packages :
-\begin{verbatim}
----> Were moved in a 'Reference Manual' ?\\
----> Any suggestion welcome!
-\end{verbatim}
-\begin{itemize}
-\item{vtk} \\
-\item{itk} \\
-\item{...} \\
-\end{itemize}
% ==========================================
-\subsubsection{Pipeline processing}
-\label{bbi-more-on-pipeline-processing}
+%\vspace{0.5cm}
+\hrule
+\newpage
+\section{Using third party Package}
+\label{Third_Party_Package}
+% ==========================================
+% ==========================================
+\subsection{Plugging in a Package}
+\label{Plugging_in_a_Package}
% ==========================================
-\begin{itemize}
-\item the ``control'' mechanism in bbi.
-When a box is requested to update itself, it asks (recursively) each one of its inputs if it was modified.\\
-In normal pipe-line mode, it will be re-processed if at least one of its imputs was actually modified, as the output of a previous box.
+\bbStudio makes it easy for you : in the menu \texttt{Tools} just click on the
+option \texttt{Plug Package}. You will be asked to '\texttt{Select
+package directory}'. Browse untill you find the install or the build directory,
+depending whether you installed the package or not.
-(switch exec commands, e.g. Button)
-\item the role of ProcessMode to update widgets.
-\end{itemize}
+\bbStudio will update the configuration file, generate the 'Package
+documentation', and update the 'Boxes Lists'.
+
+You will be able to use the new package just as you did for any other \bbtk
+canonical Package.
+
+% ==========================================
+\subsection{Hard incorporating of a Package}
+\label{Hard_incorporating_of_a_Package}
% ==========================================
-\subsubsection{Complex black boxes}
-\label{bbi-more-on-complex-black-boxes}
-Creation of complex widgets (containers, contained...)
-%\subsubsection{Advanced issues}
-%\paragraph{Reducing the number of inputs of a box}
+If the Package you want to use is supplied in a non standard way (e.g. : you
+where given one ore more dynamic libraries (\texttt{.dll} or \texttt{.so}), and/or
+one or more directories containing \bbtk scripts (\texttt{.bbs})
+you can edit your \bbtk configuration and add the appropriate
+paths, see \ref{The_configuration_file}.
+%\end{itemize}
+% ==========================================
+\subsection{Updating the documentation}
+\label{Updating_the_documentation}
% ==========================================
-\subsubsection{Errors}
-\label{bbi-more-on-errors}
+You may add your own boxes (simple boxes, if you are aware enough in \CPP
+language, or complex boxes if you are aware enough in bbtk scripting).
+To update the html help of this package,
+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.
+
+To update html boxes lists with the new boxes,
+use the option \texttt{Regenerate Boxes Lists}
+in the menu \texttt{Tools} of \texttt{bbStudio}.
+
+% ==========================================
+\subsection{Using the package}
+\label{Using_the_package}
% ==========================================
-\subsubsection{Creating and using your own uninstalled version of bbStudio}
-\label{bbi-more-on-your_own_version}
-Suppose 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 :
-\begin{itemize}
-\item cvs checkout the sources :
-\begin{verbatim}
-cvs checkout bbtk
-\end{verbatim}
-\item
-create a build directory
-\begin{verbatim}
-mkdir buildBBTK
-\end{verbatim}
-\item cd in the build directory:
-\begin{verbatim}
-cd buildBBTK
-\end{verbatim}
-\item run ccmake.
-\begin{verbatim}
-ccmake ../bbtk
-\end{verbatim}
+The only thing you have to do is to \texttt{include} or \texttt{load} the package,
+within a script, or from the \texttt{Command} part,
+and enjoy the black boxes it contains.
-Don't forget to switch ON the flag \textttBBTK\_COMPILE\_DEBUG\_MESSAGE \\
-(see figure : \ref{bb-ccmake})
+% ==========================================
+%\subsection{Packages you'll probably want to use }
+%\label{Packages_you_ll_want_to_use}
+% ==========================================
+%\begin {itemize}
+%\item{\texttt{creaLib}} \\
+%a.k.a \texttt{crea}. It's a set of 'low level' utilities, needed by other
+%packages (an, sure, useful as well for people that doesn't use bbtkns.
+%\item{\texttt{creaContours}} \\
+%Provides sophisticated widgets for managing 3D R.O.I. (Regions of interest)
+%\item{\texttt{creaImageIO}} \\
+%Allows browsing, selectionning, ordering directories containing images of almost any type
+%(including DICOM)
+%\end {itemize}
+%\newpage
+
+% ==========================================
+%\vspace{0.5cm}
+\hrule
+\newpage
+\section{Using black boxes in \CPP programs}
+\label{cpp}
+% ==========================================
-\begin{figure}[!ht]
-\caption{\label{bb-ccmake}\Running ccmake}
-\begin{center}
-\includegraphics[width=0.6\textwidth]{ccmake.png}
-\end{center}
-\end{figure}
+A very useful feature is that you may use any widget
+black box within a \CPP program
+without worrying about writing a \wx main application.\\
-\item As usual, type \texttt{c} untill there is no longer any area quoted with a * (or enlighted in red)\\
-Ask for generation (type \texttt{g} -once is always enough-)
+Let's look a the following bbs script :
-\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!\\
+# Load the packages
+load std
+load wx
-The dynamic libraries (\texttt{.dll} or {.so} ans the executable programs will be created in the \testtt{bin}
-directory of the built tree.
+# Create the Objects
+new Slider slider
+new OutputText text
+new LayoutLine layout
-\item choose to install or not your own version.
-\begin{verbatim}
-make install
+# Graphical pipeline
+connect slider.Widget layout.Widget1
+connect text.Widget layout.Widget2
+
+# Execution pipeline
+connect slider.BoxChange text.BoxExecute
+connect slider.Out text.In
+
+# Go!
+exec layout
\end{verbatim}
-Linux users : Don't forget to \texttt{sudo} before.
-\end{itemize}
-% ==========================================
-\subsubsection{\bbtk configuration file and search pathes}
-\label{bbi-more-on-configuration}
-At start, \bbi tries to open an \texttt{xml}
-configuration file named \texttt{bbtk\_config.xml}.
-The search order is
-\begin{enumerate}
-\item The current directory
-\item The subdir \texttt{.bbtk} of the user's home directory.
-\begin{itemize}
-\item On \texttt{Unix}, the home directory is the
-one stored by the environnement variable \texttt{HOME},
-typically \texttt{/home/username}.
-\item On \texttt{Windows}, the home directory is
-the user's profile directory stored by the environnement
-variable \texttt{USERPROFILE},
-typically \texttt{C:\\...}.
-\end{itemize}
-\item If none of these two pathes contains the file then it creates
-a new one in the \texttt{.bbtk} directory.
-\end{enumerate}
+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.
-Once created, you can edit the \texttt{bbtk\_config.xml} file located
-in your \texttt{.bbtk} directory. It contains :
+The following \CPP code does the same :
-\begin{file}{bbtk\_config.xml}
\begin{verbatim}
-<?xml version="1.0" encoding="iso-8859-1"?>
-<config>
- <description> </description>
- <bbs_path> </bbs_path>
- <package_path>
- /usr/local/lib
- </package_path>
- <data_path> </data_path>
- <default_temp_dir>$</default_temp_dir>
-</config>
-\end{verbatim}
-\end{file}
+#include <bbtkFactory.h>
+#include <bbwxSlider.h>
+#include <bbwxOutputText.h>
+#include <bbwxLayoutLine.h>
-You can add pathes to
-\begin{itemize}
-\item A custom folder in which to search for \texttt{.bbs} scripts (\texttt{include} command of \bbi) by adding an \texttt{xml} tag :
-\texttt{<bbs\_path>complete\_path\_to\_folder<\/bbs\_path>}.
-\item A custom folder in which to search for packages (\texttt{load} command of \bbi) by adding an \texttt{xml} tag :
-\texttt{<package\_path>complete\_path\_to\_folder<\/package\_path>}.
-\end{itemize}
+int main(int argv, char* argc[])
+{
+ try
+ {
+ // we need to intanciate a bbtk::Factory to be aware of the adaptors
+ bbtk::Factory::Pointer factory = bbtk::Factory::New();
+
+ // Load the packages
+ // ----------------
+ factory->LoadPackage("std");
+ factory->LoadPackage("wx");
+
+ // Create the Objects
+ // ------------------
+ bbwx::Slider::Pointer slider = bbwx::Slider::New("slider");
+ bbwx::OutputText::Pointer text = bbwx::OutputText::New("text");
+ bbwx::LayoutLine::Pointer layout = bbwx::LayoutLine::New("layout");
+
+ // Graphical pipeline
+ bbtk::Connection::Pointer c1 = bbtk::Connection::New(slider,"Widget",
+ layout,"Widget1");
+
+ bbtk::Connection::Pointer c2 = bbtk::Connection::New(text,"Widget",
+ layout,"Widget2");
+
+ // Execution pipeline
+ // ------------------
+
+ // We have to pass the 'factory', in order to call automatically an adaptor,
+ // if necessary.
+ bbtk::Connection::Pointer s2t = bbtk::Connection::New(slider,"Out",
+ text,"In",
+ factory);
+ bbtk::Connection::Pointer c3 = bbtk::Connection::New(slider,"BoxChange",
+ text,"BoxExecute");
+ layout->bbSetInputWinDialog(true);
+
+ // Go!
+ // ---
+ layout->bbExecute();
+ }
+ catch (bbtk::Exception e)
+ {
+ bbtk::MessageManager::SetMessageLevel("Error",1);
+ e.Print();
+ }
+}
-\newpage
+In this code, we use the headers of the \texttt{bbwx} \CPP library,
+which define the black boxes of the \texttt{wx} package.
+
+to be continued ...
+
+\end{verbatim}
% ==========================================
-\subsection{Language reference}
+\hrule
+\newpage
+\section{\bbs language reference}
\label{bbi-reference}
% ==========================================
-
% ==========================================
-\subsubsection{pipeline creation and execution related commands}
+\subsection{Pipeline creation and execution related commands}
\label{bbi-reference-creation-execution}
% ==========================================
-
+% See table \ref{bbi-reference-box}
% ==========================================
\begin{table}[!ht]
-\caption{\label{bbi-reference-box} \bbi pipeline creation and execution related commands.}
+\caption{\label{bbi-reference-box} \bbs pipeline creation and execution related commands.}
\small
\begin{tabular}{|lcm{6cm}|}
\hline
Command & Parameters & Effect \\ \hline
-\texttt{new} & \texttt{<boxtype>} \texttt{<box-name>}&
-Creates a box of type \texttt{boxtype} and name
+\texttt{new} & \texttt{<box-type>} \texttt{<box-name>}&
+Creates a box of type \texttt{box-type} and name
\texttt{box-name}.\\ \hline
+\texttt{newgui} & \texttt{<box-name>} \texttt{<gui-box-name>} &
+Automatically creates a graphical user interface with name \texttt{gui-box-name}
+for the black box \texttt{box-name} and connects it to the box inputs\\ \hline
+
\texttt{delete} & \texttt{<box-name>} &
-Destroys the box named \texttt{box-name}.\\ \hline
+Destroys the box named \texttt{box-name}\\ \hline
\texttt{connect} & \texttt{<box1.output>} \texttt{<box2.input>} &
Connects the output
\texttt{set} & \texttt{<box.input>} \texttt{<value>} &
Sets the input \texttt{input} of
the box named \texttt{box} to the value \texttt{value}.
-There must exist an \texttt{adaptor}
+An \texttt{adaptor} must exist
in the packages loaded which converts a \texttt{std::string}
to the type of the input \texttt{input}. \\ \hline
-\texttt{print} & \texttt{<string>} &
-Prints the string after substituting each token of the form \texttt{\$box.output\$} by the adaptation to string of the value of the
-output \texttt{output} of the box named \texttt{box}.
-There must exist an \texttt{adaptor}
-in the packages loaded which converts
-the type of the output \texttt{output}
-to a \texttt{std::string}.
-\\ \hline
-
\texttt{exec} & \texttt{<box-name>} &
Executes the box named \texttt{box-name}.
If needed the boxes
connected to its inputs
are also processed recursively (pipeline processing).\\ \hline
-\texttt{exec} & \texttt{freeze} &
- allows to block execution commands while keeping definition commands active.\\ \hline
-\texttt{exec} & \texttt{unfreeze} &
- turns back to 'normal' mode.\\ \hline
+& \texttt{freeze} &
+ Allows to block execution commands while keeping definition commands active (this one is not for end user)\\ \hline
+& \texttt{unfreeze} &
+ Turns back to 'normal' mode (this one is not for end user).\\ \hline
\end{tabular}
\end{table}
% ==========================================
\newpage
% ==========================================
-\subsubsection{Interpreter related commands}
+\subsection{Package related commands}
+\label{bbi-reference-package}
+
+\begin{table}[!ht]
+\caption{\label{tabbbi-reference-interpreter_1}\bbs package related commands. }% (part 1).}
+\small
+\begin{tabular}{|lcm{6cm}|}
+\hline
+Command & Parameters & Effect \\ \hline
+
+
+\texttt{include} & \texttt{<package-name>} &
+Loads the package \texttt{package-name} and includes all its complex box definition scripts. \\ \hline
+
+\texttt{load} & \texttt{<package-name>} &
+Loads the atomic black boxes of package \texttt{package-name}.
+Loads the dynamic library but not the complex boxes defined in the scripts shipped with the package.
+Use it only if you know that you won't work with its complex black boxes \\ \hline
+
+\texttt{unload} & \texttt{<package-name>}&
+Unloads the package \texttt{package-name}.
+The package must have been previously loaded.
+No box of a type defined in this package must still exist.\\ \hline
+
+\texttt{reset} & - & Deletes all boxes and unloads all packages so
+that the interpreter gets back to its initial state \\ \hline
+
+
+\texttt{package} & \texttt{<package-name>} &
+All complex black boxes definitions until the next \texttt{endpackage}
+will be stored into the package \texttt{package-name} \\ \hline
+
+\texttt{endpackage} & - &
+Closes a \texttt{package} command \\ \hline
+
+
+\end{tabular}
+\end{table}
+\newpage
+
+% ==========================================
+\subsection{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}\bbs intepreter related commands. }% (part 1).}
\small
\begin{tabular}{|lcm{6cm}|}
\hline
Command & Parameters & Effect \\ \hline
-\texttt{author} & - &
-Adds the string <string> to the author information of the black box being defined \\ \hline
-
-\texttt{category} & - &
- Adds the string <string> to the category information of the black box being defined \\ \hline
\texttt{help} & - &
Prints help on available commands \\ \hline
\texttt{box-type}.
The box type must belong to a package which has been previously loaded \\ \hline
+\texttt{message}
+& - &
+Prints information on available kinds of messages and their current level\\ \hline
+
+ & \texttt{<kind>} \texttt{<level>} &
+Sets the level of verbosity of the interpreter for the kind of messages
+\texttt{kind} to \texttt{level}.\\ \hline
+
+
\texttt{include} & \texttt{<file-name>} &
Includes and executes the content of the file named \texttt{file-name}
exactly like if you were typing its content at the place were the
\texttt{include} command is. \\ \hline
-\texttt{load} & \texttt{<package-name>} &
-Loads the package \texttt{package-name}\\ \hline
+\texttt{print} & \texttt{<string>} &
+Prints the string after substituting each token of the form \texttt{\$box.output\$} by the adaptation to string of the value of the
+output \texttt{output} of the box named \texttt{box}.
+An \texttt{adaptor} must exist
+in the packages loaded which converts
+the type of the output \texttt{output}
+to a \texttt{std::string}.
+\\ \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{graph} & ... &
+Generates the html doc including the pipeline graph for a given complex box \\ \hline
-\texttt{kind} & \texttt{<box kind>} &
-Specifies the \texttt{kind} of the complex black boxes you are describing \\ \hline
+\texttt{index} & ... &
+Generates the html index of currently loaded boxes types \\ \hline
-\texttt{unload} & \texttt{<package-name>}&
-Unloads the package \texttt{package-name}.
-The package must have been previously loaded.
-No box of a type defined in this package must still exist.\\ \hline
+\texttt{config} & - & Displays the configuration parameters\\ \hline
-\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}.
-\texttt{config} & - & Displays the Configuration parameters\\ \hline
-
-\texttt{reset} & - & Deletes all boxes and unloads all packages so
-that \bbi gets back to its initial state \\ \hline
+\texttt{debug} & \texttt{<debug-directive>} &
+[expr|-C|-D]
+ Prints debug info on living bbtk objects containing the string \texttt{expr} (default expr='').
+ \texttt{-C} checks the factory integrity.
+ \texttt{-D} turns on objects debug info after main ends\\ \hline
\texttt{quit} & - & Exits the interpreter\\ \hline
\end{table}
% ==========================================
-
+\newpage
% ==========================================
-\subsubsection{complex black box definition related commands}
+\subsection{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.}
+\caption{\label{bbi-reference-complex-box} \bbs complex black box definition related commands.}
\small
\begin{tabular}{|lcm{6cm}|}
\hline
Command & Parameters & Effect \\ \hline
-\texttt{define} & \texttt{<box-type>} &
-Starts the definition of a complex black box of type
-\texttt{box-type}\\ \hline
+\texttt{define} & \texttt{<box-type>} [\texttt{<package-name>}] &
+Starts the definition of a complex black box of type
+\texttt{box-type}. If \texttt{<package-name>} is provided then includes the
+box in the given package (otherwise it is defined in the current package,
+i.e. \texttt{user} if outside a \texttt{package/endpackage} block). \\ \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
+Concatenate the string to the author string
+of the current complex black box.\\ \hline
\texttt{description} & \texttt{<string>} &
-Sets the description of the complex black box currently being defined \\ \hline
+Concatenate the string to the description of the current complex black box.
+\\ \hline
+
+\texttt{category} & \texttt{<string>} &
+Specifies the \texttt{categories} of the current complex black box.
+The categories must be separated by semicolons, e.g. "\texttt{widget;image}"\\ \hline
+
+\texttt{kind} & \texttt{<box kind>} &
+Specifies the \texttt{kind} of the current complex black box
+( ADAPTOR, DEFAULT\_ADAPTOR, WIDGET\_ADAPTOR, DEFAULT\_WIDGET\_ADAPTOR )\\ \hline
\texttt{input} & \texttt{<name>} \texttt{<box.input>} \texttt{<help>} &
Defines a new input for the current complex black box,
\texttt{<help>} is the help string for the new output.
The box \texttt{box} must already have been created in the complex box and of course have an output named \texttt{output}. \\ \hline
-
\end{tabular}
\end{table}
-% ==========================================
-\newpage
+%\newpage
+Note : if outside a \texttt{define/endefine} block then the current complex black box
+is '\texttt{user::workspace}', that is the main program equivalent
+(this is how applications are documented).
+This remark holds for all complex black box related commands.
+
+
+
-% ==========================================
-\vspace{0.5cm}\hrule \\
-\section{The Package Browser}
-\label{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}
-% ==========================================
-\vspace{0.5cm}\hrule \\
-\section{Using third party Package}
-\label{Third_Party_Package}
-% ==========================================
% ==========================================
-\vspace{0.5cm}\hrule \\
-\section{Using black boxes in \CPP programs}
-\label{cpp}
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+%\hrule
+\newpage
+\section{Install and run time issues}
% ==========================================
-A very usefull feature is that you may use any black box within a \CPP program witout worrying about wxWigets main window.\\
-Let's look a the following bbs script :
+
+
+%%==============================================================================================
+%%==============================================================================================
+\subsection{\bbtk configuration file}
+\label{The_configuration_file}
+%%==============================================================================================
+%%==============================================================================================
+
+At start, \bbtk applications (\bbStudio, \bbi) try
+to open an \texttt{xml}
+configuration file named \texttt{bbtk\_config.xml}.
+The search order is
+\begin{enumerate}
+\item The current directory
+\item The subdir \texttt{.bbtk} of the user's home directory.
+\begin{itemize}
+\item On \texttt{Unix}, the home directory is the
+one stored by the environnement variable \texttt{HOME},
+typically \texttt{/home/username}.
+\item On \texttt{Windows}, the home directory is
+the user's profile directory stored by the environnement
+variable \texttt{USERPROFILE},
+typically \texttt{C:$\backslash$ Documents and Settings$\backslash$ username}.
+\end{itemize}
+\item If none of these two paths contains the file then it creates
+a new one in the \texttt{.bbtk} directory.
+\end{enumerate}
+
+
+Information on \bbtk configuration is
+obtained in \bbStudio by clicking on the
+\texttt{Config} button of the \texttt{Command} part toolbar.
+
+If you did not installed other packages than the ones
+provided by \bbtk, you get something like :
\begin{verbatim}
-# Load the packages
-load std
-load wx
+ =============
+ Configuration
+ =============
+ bbtk_config.xml : [/home/guigues/.bbtk/bbtk_config.xml]
+ Documentation Path : [/usr/local/bin/../share/bbtk/doc]
+ Data Path : [/usr/local/bin/../share/bbtk/data]
+ Temp Directory : []
+ File Separator : [/]
+ BBS Paths
+ --- [.]
+ --- [/usr/local/bin/../share/bbtk/bbs]
+ PACKAGE Paths :
+ --- [.]
+ --- [/usr/local/bin/../lib]
+\end{verbatim}
-# Create the Objects
-new Slider slider
-new OutputText text
-new LayoutLine layout
+The first line let you know which configuration file is currently used.
-# Graphical pipeline
-connect slider.Widget layout.Widget1
-connect text.Widget layout.Widget2
+You can open this file using \bbStudio menu \texttt{Files$>$Open bbtk Config file}.
-# Execution pipeline
-connect slider.BoxChange text.BoxExecute
-connect slider.Out text.In
+You will get something like :
-# Go!
-exec layout
+\begin{verbatim}
+<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>
+<config>
+ <bbs_path> </bbs_path>
+ <package_path> </package_path>
+ <default_temp_dir> $ </default_temp_dir>
+</config>
\end{verbatim}
-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.\\
+The \texttt{xml} tags \texttt{bbs\_path} and \texttt{package\_path}
+allow to set additionnal directories in which to search
+for \bbs files and packages dynamic libraries.
-Using \bbtk you just 'convert' the script :
+For example, if you add the line :
\begin{verbatim}
+ <bbs_path> /home/guigues/bbs </bbs_path>
+\end{verbatim}
-#include <bbwxSlider.h>
-#include <bbwxOutputText.h>
-#include <bbtkFactory.h>
-#include <bbwxLayoutLine.h>
+Then the interpreter will search for \bbs in the folder \texttt{/home/guigues/bbs},
+which allows a command like \texttt{'include bbMyBox.bbs'} to work if
+the folder \texttt{/home/guigues/bbs} contains the file \texttt{bbMyBox.bbs}.
-int main(int argv, char* argc[])
-{
- // we need to intanciate a bbtk::Factory to be aware of the adaptors
- bbtk::Factory::Pointer factory = bbtk::Factory::New();
-
- // Load the packages
- // ----------------
- factory->LoadPackage("std");
- factory->LoadPackage("wx");
-
- // Create the Objects
- // ------------------
- bbwx::Slider::Pointer slider = bbwx::Slider::New("slider");
- bbwx::OutputText::Pointer text = bbwx::OutputText::New("text");
- bbwx::LayoutLine::Pointer layout = bbwx::LayoutLine::New("layout");
-
- // Graphical pipeline
- bbtk::Connection::Pointer c1 = bbtk::Connection::New(slider,"Widget",
- layout,"Widget1");
-
- bbtk::Connection::Pointer c2 = bbtk::Connection::New(text,"Widget",
- layout,"Widget2");
-
- // Execution pipeline
- // ------------------
-
- // We have to pass the 'factory', in order to call automatically an adaptor, if necessary.
- bbtk::Connection::Pointer s2t = bbtk::Connection::New(slider,"Out",
- text,"In",
- factory);
- bbtk::Connection::Pointer c3 = bbtk::Connection::New(slider,"BoxChange",
- text,"BoxExecute");
- layout->bbSetInputWinDialog(true);
-
- // Go!
- // ---
- layout->bbExecute();
+The same, the \texttt{xml} tag \texttt{<package\_path>} let you
+set additional path in which to find a package dynamic library,
+hence allowing to load additionnal packages with the \texttt{'load'} command.
- }
- catch (bbtk::Exception e)
- {
- bbtk::MessageManager::SetMessageLevel("Error",1);
- e.Print();
- }
-}
-\end{verbatim}
+All \bbs and package paths are summmarized in the
+information output when pressing 'Config' in \bbStudio.
+You can see that two \bbs paths are always set :
+\begin{itemize}
+\item The current directory (\texttt{.})
+\item The \bbs folder of \bbtk
+\end{itemize}
+Also, two package paths are always set :
+\begin{itemize}
+\item The current directory (\texttt{.})
+\item The libraries folder of \bbtk
+\end{itemize}
+
+Additional paths set in your \texttt{bbtk\_config.xml} are added after those standard paths.
+Note that the order displayed is the one in which the folders are searched when
+\texttt{include} or \texttt{load} commands are issued.
-%\bibliography{all}
+%%==============================================================================================
+\subsection{Misc}
+\begin {itemize}
+%\item{make} \\
+%For some strange reasons (?!?), at \texttt{cmake} time,
+%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}. \\
+
+
+\end {itemize}
-%\section{Conclusion}
\end{document}
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff