The MLBase project is a collection of classes and modules which provide and manage so called "Base data structures" which can be passed between MeVisLab modules via "Base" fields.
For introductions and further details see
- Chapter 9 of the ML Guide (Base Objects),
- Section 2.1.2.3 of the ML Guide (Base Field),
- Class Base in project mlUtils,
- Class BaseField in project ML, and
- Class SoSFMLBase in the project InventorWrapper,
(Back to Content)
- BaseItem
A general base class (derived from Base) for list items that have an id and a name. Should be used for list objects that are editable via a container and/or editor module.
- BaseContainerItem
The Base object class BaseContainerItem encapsulates a pointer to a Base object as a list item.
- BaseItemParser
The BaseItemParser (derived from ParserBase) is a parser class for BaseItem strings.
- BaseList
The Base object class BaseList which stores a list of BaseContainerItem entries.
- BaseListSortParameters
Class that is designed to hold custom list sorting parameters (such as sort mode).
- BaseListTemplate
The list class template (derived from ListTemplate) for list item classes derived from BaseItem. Persistence of the list is based on the corresponding methods of the list class. The list maintains a 'next id' feature to support unique item id's.
- ListBase
The basic list class (derived from Base) with functionality to
- obtain the number of list elements,
- clear the list,
- enable/disable persistence,
- output persistent state to a stream,
- maintain a last action member variable, describing the most recent action, performed on the list, and
- ListBase::ActionClass:
for constants to describe the type of the action most recently performed enum ActionClass.
- ListContainerBase
Abstract ML module class implementing basic functionality for a list container module. List container modules for a specific list class are derived from this class using the class template ListContainerTemplate. This construct can only be used for list classes derived from BaseListTemplate.
- ListTemplate
A basic list class template (derived from ListBase and std::vector) combining properties of ListBase and a vector of the template argument type. Implements persistence methods that iterate through the vector items and call corresponding persistence methods for each item.
(Back to Content)
- DiscList
Base object class DiscList managing a list of Discs objects.
- KeyFrame
Class KeyFrame consisting of a 3D position, tangent and up vector, describing a position and orientation in space.
- KeyFrameList
List of Base objects of type KeyFrame describing positions and orientations in space.
- ListParser
Parser class (derived from ParserBase) for parsing persistent state strings of list objects.
- MarkerList
Base object class MarkerList managing a list of markers represented by vec4's.
- ParserBase
Basic parser class from which special parser classes can be derived.
- PointList
Base object class PointList managing a list of points.
- RasterFunction
Base Object class managing a general raster function class. This class handles two types of implicit functions which can be rastered into a subimage with the methods draw().
- RasterFunctionList
Base object class managing a list of raster functions. This class maintains a list of raster functions. It uses an STL vector to manage the list. The class is derived from Base to have a common base class for some classes and to have the possibility to add persistence to the object later.
- SphereList
Base object managing a list of Sphere objects.
- StringList
Base object class managing a list for items of type BaseItem usable for string storage.
- StringListContainer
Base object class StringListContainer managing a list of items of type StringList.
- StylePalette
Base object class StylePalette for providing a collection of colors, line styles and marker types.
- VectorList
Base object representing a list of vectors given as vec4's.
- XMarker
Base object class XMarker (derived form baseItem) with 6D pos, 3D vec and type int.
- XMarkerList
Base object class XMarkerList (derived from BaseListTemplate) specialized for XMarker items.
- XMarkerListContainer
Base object class XMarkerListContainer (derived from ListContainerTemplate) for XMarkerList objects.
- VecListTemplate
BaseObject list class template (derived from ListTemplate) for lists of n-tupels of a given type.
- Base object class Vec3iList derived from VecListTemplate.
- Base object class Vec4iList derived from VecListTemplate.
- Base object class Vec6iList derived from VecListTemplate.
- Base object class Vec3fList derived from VecListTemplate.
- Base object class Vec4fList derived from VecListTemplate.
- Base object class Vec6fList derived from VecListTemplate.
All internal data structures and derived classes are also listed on the 'Class List' or 'Class Hierarchy' pages under the 'Classes' tab.
(Back to Content)
- CurveData
Base object class representing a single curve object, consisting of zero or one X- and any number of Y-data series. All X- and Y-series should have the same number of elements. Together, they represent a series of (x, y1, y2, ...) tupels. If no X-series is specified, an automatic series (0, 1, ...) is generated automatically. The expected number and the meaning of the different Y-series depends on the curve type: For curve types requiring a single Y-series (e.g. ctyLine), all Y-series are considered as independent curves defined over the same set of X-coordinates. For curve types requiring pairs or triples of Y-series (e.g. ctyDeltaArea, ctyErrorBar), consecutive Y-series are grouped to pairs or triples, resp. The X- and Y-series data stored in a CurveData object are owned by the object.
- CurveList
Base object class CurveList with a list of CurveData object pointers. The CurveData objects referenced by this list are not owned by the list, i.e. the creator of the objects is responsible for deleting them.
- CurveDataBaseList
Base object class list as alternative implementation for CurveData, essentially a container for Base objects.
- CurveSeries
Type definition of a standard vector of single series of X- or Y-values.
(Back to Content)
- ComposeBaseList
The Engine module ComposeBaseList has two base inputs. It combines those input object in a single output BaseList object.
- CopyBase
Template version of the Engine module CopyBase is used to copy any Base-derived object that provides a virtual assignment operator which allows to copy from Base. This is useful if you want to modify the list while still needing the original one.
- CopyList
Engine module class (derived from CopyBase) for copying ListBase derived classes, which is ok because lists have an assignment operator.
- DecomposeBaseList
Engine module DecomposeBaseList:
Operator with two output fields, decomposing a ListBase input into a single base object and a so-called "rest list".
- ExtractObjectFromList
The Engine module ExtractObjectFromList extracts a single list item (identified by its index) from a given list which has to be derived from BaseListTemplate.
- MergeLists
The Engine module MergeLists merges two lists of the same arbitrary (BaseListTemplate - derived) class.
- StylePaletteOp
ML Module class implementing a StylePalette providing a collection of colors, line styles and marker types.
(Back to Content)
