This is the working branch from my desktop, that drives the cubes well with no bugs...
[SugarCubes.git] / _Mappings.pde
1 /**
2 * DOUBLE BLACK DIAMOND DOUBLE BLACK DIAMOND
3 *
4 * //\\ //\\ //\\ //\\
5 * ///\\\ ///\\\ ///\\\ ///\\\
6 * \\\/// \\\/// \\\/// \\\///
7 * \\// \\// \\// \\//
8 *
9 * EXPERTS ONLY!! EXPERTS ONLY!!
10 *
11 * This file implements the mapping functions needed to lay out the physical
12 * cubes and the output ports on the panda board. It should only be modified
13 * when physical changes or tuning is being done to the structure.
14 */
15
16 public Model buildModel() {
17
18
19 // Shorthand helpers for specifying wiring more quickly
20 final Cube.Wiring WFL = Cube.Wiring.FRONT_LEFT;
21 final Cube.Wiring WFR = Cube.Wiring.FRONT_RIGHT;
22 final Cube.Wiring WRL = Cube.Wiring.REAR_LEFT;
23 final Cube.Wiring WRR = Cube.Wiring.REAR_RIGHT;
24
25 // Utility value if you need the height of a cube shorthand
26 final float CH = Cube.EDGE_HEIGHT;
27
28 // Positions for the bass box
29 final float BBY = BassBox.EDGE_HEIGHT + BoothFloor.PLEXI_WIDTH;
30 final float BBX = 56;
31 final float BBZ = 2;
32
33
34 // The model is represented as an array of towers. The cubes in the tower
35 // are represenented relatively. Each tower has an x, y, z reference position,
36 // which is typically the base cube's bottom left corner.
37 //
38 // Following that is an array of floats. A 2-d array contains an x-offset
39 // and a z-offset from the previous reference position. Typically the first cube
40 // will just be {0, 0}. Each successive cube uses the position of the previous
41 // cube as its reference.
42 //
43 // A 3-d array contains an x-offset, a z-offset, and a rotation about the
44 // y-axis.
45 //
46 // The cubes automatically increment their y-position by Cube.EDGE_HEIGHT.
47 TowerMapping[] towerCubes = new TowerMapping[] {
48
49
50
51 //back left cubes: temp Channel 1
52 new TowerMapping(0, Cube.EDGE_HEIGHT, 72, new CubeMapping[] {
53 new CubeMapping(0, 14, -45 , WRL),
54 new CubeMapping(18, -12, -20, WFL),
55 new CubeMapping(5, 9, 45, WRR),
56
57
58 }),
59 //back left cube tower: Channel 2
60 new TowerMapping(0, Cube.EDGE_HEIGHT, 70, new CubeMapping[] {
61 new CubeMapping(18, -2.5, 45, WRL),
62 new CubeMapping(15, -6, 45, WFR),
63 new CubeMapping(-6 , 7, 5, WRR),
64 new CubeMapping(18, 11, -5, WFL)
65
66 }),
67
68 //second from left back tower: Channel 3
69 new TowerMapping(31, Cube.EDGE_HEIGHT, 73.5, new CubeMapping[] {
70 new CubeMapping( 12.5, 5.5 , 10 , WRR),
71 new CubeMapping( 16.5, 2.5 , 30, WRR),
72 new CubeMapping( 16.5, 3, 10, WRR),
73 new CubeMapping(.5, 4.5, -10 , WFL)
74 } ),
75
76 //center tower, Channel 4
77 new TowerMapping(106, Cube.EDGE_HEIGHT, 84, new CubeMapping[] {
78 new CubeMapping( -3.5, -2, 10, WFL),
79 new CubeMapping( -11, 5, 30, WFR),
80 new CubeMapping( 13.5, 2, 15, WRR),
81 new CubeMapping(20.75, -4, 35 , WRL)
82 } ),
83
84 //second from back right tower, Channel 5
85
86 new TowerMapping(160, Cube.EDGE_HEIGHT, 78, new CubeMapping[] {
87 new CubeMapping( -31.5, -.5 , 5 , WFR),
88 new CubeMapping( 7, -.5, 60, WRL),
89 new CubeMapping( -5.5, -3, 0, WFR),
90 new CubeMapping(22 , 2 , 30 , WRL)
91 }),
92
93
94 //back right cubes: temp Channel 6
95 new TowerMapping(201, Cube.EDGE_HEIGHT, 72, new CubeMapping[] {
96 new CubeMapping(7.5, 6, 25, WRL),
97 new CubeMapping(-4.5, -0.5, 18, WFR),
98 new CubeMapping(8.5, .5, 30, WRL),
99 new CubeMapping(-7, -14, 10, WFR)
100
101 }),
102
103
104
105
106
107 //tower to the right of BASS BOX
108 new TowerMapping (192, Cube.EDGE_HEIGHT, 40, new CubeMapping[] {
109 new CubeMapping(-6, 4, -10, WRL),
110 new CubeMapping(5 ,5 , 5, WFR ),
111 new CubeMapping(-2, .5 , -3, WFL),
112 new CubeMapping(-10, 5.5 , -20, WRR )
113 }),
114
115 //end right tower in middle, right of previous tower
116 new TowerMapping (214, Cube.EDGE_HEIGHT, 37, new CubeMapping[] {
117 new CubeMapping(10,0 , 50, WRR),
118 new CubeMapping(5 ,5 , 65, WFL)
119 }),
120 // // DJ booth, from back left to back right
121
122 new TowerMapping(BBX, BBY, BBZ, new CubeMapping[] {
123 new CubeMapping(3, 28, 3, WFL),
124 new CubeMapping(-2, 11.5, 10, WFR),
125 new CubeMapping(10.5, 4.5, 40, WFR)
126
127
128 }),
129
130
131
132 new TowerMapping(BBX, BBY, BBZ, new CubeMapping[] {
133 new CubeMapping(-7.25, 7.5, -25, WFR),
134 new CubeMapping(7.5, -15.75, 12, WRL),
135
136
137 }),
138 new TowerMapping(BBX, BBY, BBZ, new CubeMapping[] {
139 new CubeMapping(19.625, 5.375, -22, WFR),
140 new CubeMapping(8, -14.5, 10, WRR),
141 }),
142 new TowerMapping(BBX, BBY, BBZ, new CubeMapping[] {
143 new CubeMapping(48, 4.75, -35, WRL),
144 new CubeMapping(8, -15, 10, WRR),
145 }),
146 new TowerMapping(BBX, BBY, BBZ, new CubeMapping[] {
147 new CubeMapping(78.75, 3.75, -28, WRR),
148 new CubeMapping(8, -15, 10, WRR),
149 }),
150
151 // next two are right DJ channel
152
153 new TowerMapping(BBX, BBY, BBZ, new CubeMapping[] {
154 new CubeMapping(105, 20.5, 20, WRR),
155 new CubeMapping(6, -6, 30, WFR),
156 }),
157
158 new TowerMapping(BBX, BBY, BBZ, new CubeMapping[] {
159 new CubeMapping(104.75, 0, -27, WRL),
160 new CubeMapping(8, -15, 10, WFL),
161 }),
162
163
164 };
165
166 // Single cubes can be constructed directly here if you need them
167 Cube[] singleCubes = new Cube[] {
168 //back left channel behind speaker
169 new Cube(15, int( Cube.EDGE_HEIGHT), 39, 0, 10, 0, WRL),
170 new Cube(-6, int(Cube.EDGE_HEIGHT), 47, 0, 20, 0, WFR),
171 new Cube(0, int(2*Cube.EDGE_HEIGHT), 46, 0, 40, 0, WRR),
172
173 // Top left Channel Above DJ booth
174 new Cube(33, int(4.5*Cube.EDGE_HEIGHT ), 28, 0, 10, 0, WRR),
175 new Cube(35, int(5*Cube.EDGE_HEIGHT ), 52, 0, 10, 0, WRR),
176 new Cube(56, int(5*Cube.EDGE_HEIGHT ), 69, 0, 10, 0, WFL),
177 new Cube(76, int(5*Cube.EDGE_HEIGHT ), 61, 0, -45, 0, WRL),
178
179 //next channel to the right, same height
180 new Cube(85, int(5*Cube.EDGE_HEIGHT ), 77, 0, 20, 0, WRL),
181 new Cube(92, int(6*Cube.EDGE_HEIGHT ), 63, 0,20, 0, WRR),
182 new Cube(86, int(6*Cube.EDGE_HEIGHT ), 47, 0, -45, 0, WRL),
183 new Cube(123, int(6*Cube.EDGE_HEIGHT ), 31, 0, 20, 0, WFR),
184
185 // next channel to right, same height
186 new Cube(111, int(5*Cube.EDGE_HEIGHT ), 79, 0, 30, 0, WRL),
187 new Cube(125, int(6*Cube.EDGE_HEIGHT ), 76, 0,27, 0, WRL),
188 new Cube(144, int(5*Cube.EDGE_HEIGHT ), 44, 0, 45, 0, WRR),
189 new Cube(134, int(5*Cube.EDGE_HEIGHT ), 42, 0, 45, 0, WRL),
190
191 //next channel to right
192 new Cube(185, int(4*Cube.EDGE_HEIGHT ), 73, 0, -45, 0, WRR),
193 new Cube(170, int(5*Cube.EDGE_HEIGHT ), 58, 0,40, 0, WRL),
194 new Cube(158, int(6*Cube.EDGE_HEIGHT ), 34, 0, 40, 0, WFR),
195 new Cube(130, int(6*Cube.EDGE_HEIGHT ), 10, 0, -5, 30, WRL),
196
197 //next channel highest to the right
198 new Cube(203, int(5*Cube.EDGE_HEIGHT ), 55, 0, 35, 0, WRR),
199 new Cube(174, int(5*Cube.EDGE_HEIGHT ), 32, 0,35, 0, WFR),
200 new Cube(178, int(6.5*Cube.EDGE_HEIGHT ), 16, 0, 20 , 30, WRL),
201 new Cube(212, int(6.5*Cube.EDGE_HEIGHT ), 23, 0, 20 ,30, WRR),
202
203 //last channel
204 new Cube(204, int(5*Cube.EDGE_HEIGHT ), 28, 0, 25, 0, WFR),
205 new Cube(185, int(6*Cube.EDGE_HEIGHT ), 38, 0,40, 0, WRR),
206
207 // new Cube(x, y, z, rx, ry, rz, wiring),
208 };
209
210 // The bass box!
211 //BassBox bassBox = new BassBox(BBX, 0, BBZ);
212 //test for Alex, should be commented out
213
214 // The speakers!
215 //List<Speaker> speakers = Arrays.asList(new Speaker[] {
216 // each speaker parameter is x, y, z, rotation, the left speaker comes first
217 // new Speaker(-12, 6, 0, 15),
218 // new Speaker(TRAILER_WIDTH - Speaker.EDGE_WIDTH + 8, 6, 3, -15)
219 // });
220
221 //////////////////////////////////////////////////////////////////////
222 // BENEATH HERE SHOULD NOT REQUIRE ANY MODIFICATION!!!! //
223 //////////////////////////////////////////////////////////////////////
224
225 // These guts just convert the shorthand mappings into usable objects
226 ArrayList<Tower> towerList = new ArrayList<Tower>();
227 ArrayList<Cube> tower;
228 Cube[] cubes = new Cube[80];
229 int cubeIndex = 1;
230 float px, pz, ny;
231 for (TowerMapping tm : towerCubes) {
232 px = tm.x;
233 ny = tm.y;
234 pz = tm.z;
235 tower = new ArrayList<Cube>();
236 for (CubeMapping cm : tm.cubeMappings) {
237 tower.add(cubes[cubeIndex++] = new Cube(px = px + cm.dx, ny, pz = pz + cm.dz, 0, cm.ry, 0, cm.wiring));
238 ny += Cube.EDGE_HEIGHT;
239 }
240 towerList.add(new Tower(tower));
241 }
242 for (Cube cube : singleCubes) {
243 cubes[cubeIndex++] = cube;
244 }
245
246 return new Model(towerList, cubes, null, null);
247 }
248
249 /**
250 * This function maps the panda boards. We have an array of them, each has
251 * an IP address and a list of channels.
252 */
253 public PandaMapping[] buildPandaList() {
254 final int LEFT_SPEAKER = 0;
255 final int RIGHT_SPEAKER = 1;
256
257 return new PandaMapping[] {
258 new PandaMapping(
259 // 8 maps to: 3, 4, 7, 8, 13, 14, 15, 16. So if it's J4,
260 "10.200.1.30", new ChannelMapping[] {
261 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 52, 53, 54, 55}), //30 J3
262 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 64, 65, 66, 67}), //30 J4 //ORIG
263 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 1,2,3,7 }), //30 J7
264 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 39, 40, 38, 37}), //30 J8
265 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 16, 17, 18, 19 }), //30 J13
266 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 20, 21, 22, 23}), //30 J14
267 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 24, 25, 26, 27 }), // 30 J15
268 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 28, 29 }), // 30 J16
269 }),
270 new PandaMapping(
271 "10.200.1.29", new ChannelMapping[] {
272 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 68, 65, 66, 67 }), //29 J3
273 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 30,31 }), //29 J4
274 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 20, 21, 22, 23 }), // 29 J7
275 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 60, 61 , 62, 63 }), //29 J8 //XXX
276 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 17, 18, 19, 20 }), //29 J13 //XX //bassbox
277 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 24, 25, 26, 27}), //29 J14
278 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 41,42,43,44 }), //29 J15
279 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 16, 17,18,19 }), //29 J16
280 }),
281 new PandaMapping(
282 "10.200.1.28", new ChannelMapping[] {
283 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 56, 57, 58, 59 }), //28 J3
284 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 64, 69 }), //28 J4
285 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 48, 49, 50, 51 }), //28 J7
286 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 13, 14 , 15, 16 }), //28 J8
287 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 8,9,10,11 }), //28 J13
288 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 35,36,34,33}), //28 J14
289 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 12, 13, 14, 15 }), //28 J15
290 new ChannelMapping(ChannelMapping.MODE_CUBES, new int[] { 30, 31, 32, 48 }), //28 J16
291 }),
292 };
293
294 }
295
296
297
298 class TowerMapping {
299 public final float x, y, z;
300 public final CubeMapping[] cubeMappings;
301
302 TowerMapping(float x, float y, float z, CubeMapping[] cubeMappings) {
303 this.x = x;
304 this.y = y;
305 this.z = z;
306 this.cubeMappings = cubeMappings;
307 }
308 }
309
310 class CubeMapping {
311 public final float dx, dz, ry;
312 public final Cube.Wiring wiring;
313
314 CubeMapping(float dx, float dz, Cube.Wiring wiring) {
315 this(dx, dz, 0, wiring);
316 }
317
318 CubeMapping(float dx, float dz, float ry) {
319 this(dz, dz, ry, Cube.Wiring.FRONT_LEFT);
320 }
321
322 CubeMapping(float dx, float dz, float ry, Cube.Wiring wiring) {
323 this.dx = dx;
324 this.dz = dz;
325 this.ry = ry;
326 this.wiring = wiring;
327 }
328 }
329
330 /**
331 * Each panda board has an IP address and a fixed number of channels. The channels
332 * each have a fixed number of pixels on them. Whether or not that many physical
333 * pixels are connected to the channel, we still send it that much data.
334 */
335 class PandaMapping {
336
337 // How many channels are on the panda board
338 public final static int CHANNELS_PER_BOARD = 8;
339
340 // How many total pixels on the whole board
341 public final static int PIXELS_PER_BOARD = ChannelMapping.PIXELS_PER_CHANNEL * CHANNELS_PER_BOARD;
342
343 final String ip;
344 final ChannelMapping[] channelList = new ChannelMapping[CHANNELS_PER_BOARD];
345
346 PandaMapping(String ip, ChannelMapping[] rawChannelList) {
347 this.ip = ip;
348
349 // Ensure our array is the right length and has all valid items in it
350 for (int i = 0; i < channelList.length; ++i) {
351 channelList[i] = (i < rawChannelList.length) ? rawChannelList[i] : new ChannelMapping();
352 if (channelList[i] == null) {
353 channelList[i] = new ChannelMapping();
354 }
355 }
356 }
357 }
358
359 /**
360 * Each channel on a pandaboard can be mapped in a number of modes. The typial is
361 * to a series of connected cubes, but we also have special mappings for the bass box,
362 * the speaker enclosures, and the DJ booth floor.
363 *
364 * This class is just the mapping meta-data. It sanitizes the input to make sure
365 * that the cubes and objects being referenced actually exist in the model.
366 *
367 * The logic for how to encode the pixels is contained in the PandaDriver.
368 */
369 class ChannelMapping {
370
371 // How many cubes per channel xc_PB is configured for
372 public final static int CUBES_PER_CHANNEL = 4;
373
374 // How many total pixels on each channel
375 public final static int PIXELS_PER_CHANNEL = Cube.POINTS_PER_CUBE * CUBES_PER_CHANNEL;
376
377 public static final int MODE_NULL = 0;
378 public static final int MODE_CUBES = 1;
379 public static final int MODE_BASS = 2;
380 public static final int MODE_SPEAKER = 3;
381 public static final int MODE_STRUTS_AND_FLOOR = 4;
382 public static final int MODE_INVALID = 5;
383
384 public static final int NO_OBJECT = -1;
385
386 final int mode;
387 final int[] objectIndices = new int[CUBES_PER_CHANNEL];
388
389 ChannelMapping() {
390 this(MODE_NULL);
391 }
392
393 ChannelMapping(int mode) {
394 this(mode, new int[]{});
395 }
396
397 ChannelMapping(int mode, int rawObjectIndex) {
398 this(mode, new int[]{ rawObjectIndex });
399 }
400
401 ChannelMapping(int mode, int[] rawObjectIndices) {
402 if (mode < 0 || mode >= MODE_INVALID) {
403 throw new RuntimeException("Invalid channel mapping mode: " + mode);
404 }
405 if (mode == MODE_SPEAKER) {
406 if (rawObjectIndices.length != 1) {
407 throw new RuntimeException("Speaker channel mapping mode must specify one speaker index");
408 }
409 int speakerIndex = rawObjectIndices[0];
410 if (speakerIndex < 0 || speakerIndex >= glucose.model.speakers.size()) {
411 //throw new RuntimeException("Invalid speaker channel mapping: " + speakerIndex);
412 }
413 } else if ((mode == MODE_STRUTS_AND_FLOOR) || (mode == MODE_BASS) || (mode == MODE_NULL)) {
414 if (rawObjectIndices.length > 0) {
415 //throw new RuntimeException("Bass/floor/null mappings cannot specify object indices");
416 }
417 } else if (mode == MODE_CUBES) {
418 for (int rawCubeIndex : rawObjectIndices) {
419 if (glucose.model.getCubeByRawIndex(rawCubeIndex) == null) {
420 throw new RuntimeException("Non-existing cube specified in cube mapping: " + rawCubeIndex);
421 }
422 }
423 }
424
425 this.mode = mode;
426 for (int i = 0; i < objectIndices.length; ++i) {
427 objectIndices[i] = (i < rawObjectIndices.length) ? rawObjectIndices[i] : NO_OBJECT;
428 }
429 }
430 }