Changes between Initial Version and Version 1 of code/doc/Level

Timestamp:

Feb 27, 2008, 11:24:21 PM (17 years ago)

Author:

landauf

Comment:

—

code/doc/Level

@@ +1 @@
+= Level =
+
+== Description ==
+
+A [wiki:Level] is a combination of a xml-file and a [wiki:ClassTreeMask]. They define a set of objects that can be loaded by the [wiki:Loader]. If you don't specify a [wiki:ClassTreeMask mask], every object gets loaded. If you exclude certain classes, objects of those classes aren't loaded. A [wiki:Loader loaded] object knows in which [wiki:Level] it was defined. This way it's possible to selecitvely delete objects of a specific [wiki:Level].
+
+You can think of a [wiki:Levle] as a static and well defined unit. It's not possible to change the xml-file or the [wiki:ClassTreeMask mask] of a [wiki:Level]. The same xml-file comined with a different [wiki:ClassTreeMask mask] defines another [wiki:Level]. However it's still possible to apply another [wiki:ClassTreeMask mask] to a (already masked) [wiki:Level] by using the functions of the [wiki:Loader]. But the other mask is intersected with the mask of the level, so it's only possible to exclude even more classes, but you can't include previously excluded classes.
+
+Recapitulatory we can state: A xml-file defines the maximal set of objects in a [wiki:Level] and a [wiki:Level] defines the maximal set of objects that can be loaded by the [wiki:Loader]. But both, [wiki:Level] and [wiki:Loader] can use [wiki:ClassTreeMask masks] to reduce the amount of objects.
+
+== Functions ==
+
+ * '''Constructor''':
+   * '''Level('''''file''''')''': Creates a [wiki:Level] that includes all objects from ''file''.
+   * '''Level('''''file''''', '''''mask''''')''': Creates a [wiki:Level] that includes all objects from ''file'' whose classes are included in ''mask''.
+
+ * '''Level''':
+   * '''getFile()''': Returns the name of the file.
+   * '''getMask()''': Returns a reference to the mask.