Changes between Version 4 and Version 5 of MindSeer_Package_Guide


Ignore:
Timestamp:
09/26/06 14:05:41 (11 years ago)
Author:
ebmoore
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • MindSeer_Package_Guide

    v4 v5  
    99 
    1010== colors == 
    11 Colors contain classes related to color schemes (which assign colors to intensity values) and some utilties (class Colors) for converting strings to colors and back again. 
     11Colors contain classes related to color schemes (which assign colors to intensity values) and some utilities (class Colors) for converting strings to colors and back again. 
    1212 
    1313== controls == 
     
    1717The core comprises the central classes for ensuring that MindSeer works.  These include most communication links, the client UI, the Viewport, MindSeer specific Data Set classes (the generic classes are in the vault package) and the security protocol. 
    1818 
    19 === core .client === 
     19=== core.client === 
    2020This includes the Client Manager (which manages communication and acts as a central hub), the callback mechanism, and the client UI (the menus and the base class for Layout Managers). 
    2121 
     
    2626Concrete implementations of Layout Managers and helper files live here. 
    2727 
    28 === core .display === 
     28=== core.display === 
    2929These classes extract user displayable names for objects in trees and lists. 
    3030 
    31 === core .files === 
     31=== core.files === 
    3232Files contain the MindSeer specific data set details.  These refer to the Data Set as a Workspace and include details on creating a tree for the data set. 
    3333 
    34 === core .security === 
     34=== core.security === 
    3535The security files contain the details on establishing and enforcing permissions for users and groups.  This delves heavily into the Java security model.  Most of these are package private for security purposes. 
    3636 
    37 === core .server === 
     37=== core.server === 
    3838These classes include details on communication with the client, launching the server itself and such important classes as the SessionImpl and Viewport. 
    3939 
    4040== data == 
    41 This package deals with Data objects, Encoders and Decoder, the Data Manager, Data Views, Data Models (collections of Data), keys for data and other helper classes and default implemenations of interfaces. 
     41This package deals with Data objects, Encoders and Decoder, the Data Manager, Data Views, Data Models (collections of Data), keys for data and other helper classes and default implementations of interfaces. 
    4242 
    4343== datacontrollers == 
     
    4545 
    4646== doevents == 
    47 In order to implement undo/redo, many commands needed to be encapsulated into using the [http://en.wikipedia.org/wiki/Command_pattern Command Design Pattern].  They are encapsulated into objects that implement DoCommand.  Two main kinds of command objects exist  -- state targeted and invertable.  State targeted commands encapsulate the current and previous state of the target.  Invertable commands store how to change the view and how to undo what they did.  These are then fired at a Do Target (which Viewport later implements), which is in charge of managing the appropriate thread and ensuring efficient execution. 
     47In order to implement undo/redo, many commands needed to be encapsulated into using the [http://en.wikipedia.org/wiki/Command_pattern Command Design Pattern].  They are encapsulated into objects that implement DoCommand.  Two main kinds of command objects exist  -- state targeted and invertible.  State targeted commands encapsulate the current and previous state of the target.  Invertible commands store how to change the view and how to undo what they did.  These are then fired at a Do Target (which Viewport later implements), which is in charge of managing the appropriate thread and ensuring efficient execution. 
    4848 
    49 This packages is probably a bit too generic for its own good as it became complex enough to make incorporating into external programs difficult, but is probably managable if the Controllers are moved into a different package. 
     49This packages is probably a bit too generic for its own good as it became complex enough to make incorporating into external programs difficult, but is probably manageable if the Controllers are moved into a different package. 
    5050 
    5151== helper == 
     
    6464 
    6565== model ==   
    66 This includes all of the details for loading, saving and generating data for 3D surfaces.  It also includes some helper classes for a 3D scene and the Surface Data Model handles alot of Java3D details.  Objects need to implement Surface3DView to be displayable in a Surface Data Model. 
     66This includes all of the details for loading, saving and generating data for 3D surfaces.  It also includes some helper classes for a 3D scene and the Surface Data Model handles aa lotlot of Java3D details.  Objects need to implement Surface3DView to be displayable in a Surface Data Model. 
    6767 
    6868== plugin.plaintext == 
     
    102102 
    103103== viewvolume == 
    104 This package has the Volume Viewport as well as all of the Data Views that are supported by theVolume Viewport.  It also contains Viewport Controllers and helper classes. 
     104This package has the Volume Viewport as well as all of the Data Views that are supported by the Volume Viewport.  It also contains Viewport Controllers and helper classes. 
    105105 
    106106== volume == 
     
    120120 
    121121== files == 
    122 These classe include filters for file types and utilities for files. 
     122These classes include filters for file types and utilities for files. 
    123123 
    124124== remote ==