Project

General

Profile

Download (5.79 KB) Statistics
| Branch: | Revision:

library / src / main / java / org / distorted / library / DistortedCubes.java @ 3d590d8d

1
///////////////////////////////////////////////////////////////////////////////////////////////////
2
// Copyright 2016 Leszek Koltunski                                                               //
3
//                                                                                               //
4
// This file is part of Distorted.                                                               //
5
//                                                                                               //
6
// Distorted is free software: you can redistribute it and/or modify                             //
7
// it under the terms of the GNU General Public License as published by                          //
8
// the Free Software Foundation, either version 2 of the License, or                             //
9
// (at your option) any later version.                                                           //
10
//                                                                                               //
11
// Distorted is distributed in the hope that it will be useful,                                  //
12
// but WITHOUT ANY WARRANTY; without even the implied warranty of                                //
13
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                                 //
14
// GNU General Public License for more details.                                                  //
15
//                                                                                               //
16
// You should have received a copy of the GNU General Public License                             //
17
// along with Distorted.  If not, see <http://www.gnu.org/licenses/>.                            //
18
///////////////////////////////////////////////////////////////////////////////////////////////////
19

    
20
package org.distorted.library;
21

    
22
///////////////////////////////////////////////////////////////////////////////////////////////////
23
/**
24
 * Instance of this class represents a flat set of cubes optionally textured as a whole.
25
 * (a subset of a NxMx1 cuboid build with 1x1x1 cubes, i.e. the MxNx1 cuboid with arbitrary cubes missing)
26
 * <p>
27
 * General idea is as follows:
28
 * <ul>
29
 * <li> Create an instance of this class
30
 * <li> Optionally texture it
31
 * <li> Apply some effects
32
 * <li> Draw it!
33
 * </ul>
34
 * <p>
35
 * The effects we can apply fall into three general categories:
36
 * <ul>
37
 * <li> Matrix Effects, i.e. ones that change the Cuboid's ModelView Matrix (moves, scales, rotations)
38
 * <li> Vertex Effects, i.e. effects that are implemented in the Vertex Shader. Those typically change
39
 *      the shape of (some sub-Region of) the Cuboid in some way (deforms, distortions, sinks)
40
 * <li> Fragment Effects, i.e. effects that change (some of) the pixels of the Texture (transparency, macroblock)
41
 * </ul>
42
 * <p>
43
 * 
44
 */
45
public class DistortedCubes extends DistortedObject
46
   {
47
   
48
///////////////////////////////////////////////////////////////////////////////////////////////////
49
// PUBLIC API
50
///////////////////////////////////////////////////////////////////////////////////////////////////
51
/**
52
 * Creates internal memory representation of a cuboid subset.
53
 *
54
 * @param cols Integer helping to parse the next parameter.
55
 * @param desc String describing the subset of a MxNx1 cuboid that we want to create.
56
 *             Its MxN characters - all 0 or 1 - decide of appropriate field is taken or not.
57
 *      <p></p>
58
 *      <p>
59
 *      <pre>
60
 *      For example, (cols=2, desc="111010") describes the following shape:
61
 *
62
 *      XX
63
 *      X
64
 *      X
65
 *
66
 *      whereas (cols=2,desc="110001") describes
67
 *
68
 *      XX
69
 *
70
 *       X
71
 *      </pre>
72
 *      </p>
73
 * @param cubeSize size, in pixels, of the single 1x1x1 cube our cuboid is built from
74
 * @param frontOnly Only create the front wall or side and back as well?
75
 */
76
 public DistortedCubes(int cols, String desc, int cubeSize, boolean frontOnly)
77
   {
78
   int Rs = 0;
79
   int Cs = 0;
80
     
81
   if( cols>0 )
82
     {
83
     int reallen = desc.length();
84
     int len = reallen;
85

    
86
     if( (reallen/cols)*cols != reallen )
87
       {
88
       len = ((reallen/cols)+1)*cols;
89
       for(int i=reallen; i<len; i++) desc += "0";
90
       }
91
    
92
     if( desc.contains("1") )
93
       {
94
       Cs = cols;
95
       Rs = len/cols;
96
       }
97
     }
98
     
99
   mGrid = DistortedGridFactory.getGrid(cols,desc, frontOnly);
100
   initializeData(cubeSize*Cs,cubeSize*Rs,frontOnly ? 1 : cubeSize);
101
   }
102

    
103
///////////////////////////////////////////////////////////////////////////////////////////////////
104
/**
105
 * Creates internal memory representation of a full, hole-less cuboid subset.
106
 *
107
 * @param cols Number of columns
108
 * @param rows Number of rows
109
 * @param cubeSize size, in pixels, of the single 1x1x1 cube our cuboid is built from
110
 * @param frontOnly Only create the front wall or side and back as well?
111
 */
112
 public DistortedCubes(int cols, int rows, int cubeSize, boolean frontOnly)
113
   {
114
   mGrid = DistortedGridFactory.getGrid(cols,rows, frontOnly);
115
   initializeData(cubeSize*cols,cubeSize*rows,frontOnly ? 1 : cubeSize);
116
   }
117

    
118
///////////////////////////////////////////////////////////////////////////////////////////////////
119
/**
120
 * Convenience constructor.
121
 */
122
 public DistortedCubes(int cols, String desc, int gridSize)
123
   {
124
   this(cols,desc,gridSize,false);
125
   }
126

    
127
///////////////////////////////////////////////////////////////////////////////////////////////////
128
/**
129
 * Copy constructor.
130
 *
131
 * @param dc Object to copy
132
 * @param flags see {@link DistortedObject#DistortedObject(DistortedObject,int)}
133
 */
134
 public DistortedCubes(DistortedCubes dc, int flags)
135
   {
136
   super(dc,flags);
137
   }
138

    
139
///////////////////////////////////////////////////////////////////////////////////////////////////
140

    
141
 protected DistortedObject deepCopy(int flags)
142
   {
143
   return new DistortedCubes(this,flags);
144
   }
145

    
146
///////////////////////////////////////////////////////////////////////////////////////////////////   
147
 }
(4-4/18)