3daa/project_class_design.html at master · bmaltzan/3daa · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<html><head><title>3d ray tracing animation applet: class design</title>

</head>
<!-- ====================================== -->

<body text="#000000" background="../back.jpg" bgcolor="#ffffff" link="#0000ff" vlink="#5500aa" alink="#ff0000">

<font size=5 face="Arial"><p>Class Design
<font size=3 face="Arial"><p>
The Sim class is the main class for this application. Its job is to manage
the interaction between top-level objects, like the display canvas, algorithm,
animation recording, and controller. Sim also creates and manages the control bar at
the top of the applet.

<p><img src="cd1.gif" align=left border=1>The user can use the control bar to select which panel
will be visible in the applet. The user can select to view preference, setup,
simulation, and help panels. <br clear=all>

<!-- ====================================== -->
<font size=5 face="Arial"><p>The Main Classes
<font size=3 face="Arial"><p><img src="cd2.gif" align=left border=1>
<p>Sim stores pointers to each of the main objects. Objects can request
a copy of a pointer to other objects through Sim. Objects use the pointers
to send messages between objects.

<p>The Algorithm class executes or records an execution of the algorithm for
some given data. It also manages the display of a single frame of the recording.

<p>The AlgSource class manages the source code text of the algorithm.
It has methods to return a line of code, and the number of lines of code.
It can also add or remove lines of code. This is used to reflect the changes
the user makes graphically in the setup panel.

<p>The DisplayCanvas class is a double buffer drawing surface. It is used in the
Sim and Setup Panels for displaying 2d projections of a 3d image of the scene.

<p>The Controller class is a graphical VCR-like interface to the thread
playing back the recording of the algorithm's execution.

<p>The ButtonPanel class has buttons to execute, record, and reset the algorithm.

<p>The CodePanel class displays the source code of an algorithm. When a recording is
being played back, this class will display the line of code currently simulated
as executing, in a color different from the other text. It will also allow the
user to view the algorithm's source code, providing a scrollbar.

<p>The AlgControlThread class controls the timing between frames of animation
in the recording playback. It has methods to change speed and direction.

<p>The AlgTape class stores frames of the animation in a recording. It allows
sequential forward and reverse access, and can jump to the first or last
frame.

<p>The SetupButtonPanel class is the main class for the setup panel.
It controls adding and removing data elements for the algorithm. It stores
the data locally, and only updates the algorithm when the user requests
it to be sent to the algorithm.

<p>The SetupElementsPanel is an empty panel in the bottom half of the setup
panel. It is used to temporarily hold panels that allow the user to
edit data properties for the algorithm.

<!-- ====================================== -->


</font></body></html>