File: DisplaySettingsSurface.h

package info (click to toggle)
caret 5.6.4~dfsg.1-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 31,904 kB
  • ctags: 28,901
  • sloc: cpp: 378,050; python: 6,718; ansic: 5,507; makefile: 333; sh: 46
file content (283 lines) | stat: -rw-r--r-- 9,566 bytes parent folder | download | duplicates (2)
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
/*LICENSE_START*/
/*
 *  Copyright 1995-2002 Washington University School of Medicine
 *
 *  http://brainmap.wustl.edu
 *
 *  This file is part of CARET.
 *
 *  CARET is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  CARET is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with CARET; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
/*LICENSE_END*/



#ifndef __VE_DISPLAY_SETTINGS_SURFACE_H__
#define __VE_DISPLAY_SETTINGS_SURFACE_H__

#include "DisplaySettings.h"

class BrainModelSurface;
class BrainSet;

/// This class maintains parameters for display of surface.
class DisplaySettingsSurface : public DisplaySettings {
   public:
      /// Surface drawing enums.
      enum DRAW_MODE {
          DRAW_MODE_NODES,
          DRAW_MODE_LINKS,
          DRAW_MODE_LINK_HIDDEN_LINE_REMOVAL,
          DRAW_MODE_LINKS_EDGES_ONLY,
          DRAW_MODE_NODES_AND_LINKS,
          DRAW_MODE_TILES,
          DRAW_MODE_TILES_WITH_LIGHT,
          DRAW_MODE_TILES_WITH_LIGHT_NO_BACK,
          DRAW_MODE_TILES_LINKS_NODES,
          DRAW_MODE_NONE
      };
       
      /// the viewing projection
      enum VIEWING_PROJECTION {
         VIEWING_PROJECTION_ORTHOGRAPHIC,
         VIEWING_PROJECTION_PERSPECTIVE
      };
      
      /// coloring for identify node symbols
      enum IDENTIFY_NODE_COLOR {
         IDENTIFY_NODE_COLOR_BLACK,
         IDENTIFY_NODE_COLOR_BLUE,
         IDENTIFY_NODE_COLOR_GREEN,
         IDENTIFY_NODE_COLOR_RED,
         IDENTIFY_NODE_COLOR_WHITE
      };
      
      /// clipping plane axis
      enum CLIPPING_PLANE_AXIS {
         CLIPPING_PLANE_AXIS_X_NEGATIVE = 0,
         CLIPPING_PLANE_AXIS_X_POSITIVE = 1,
         CLIPPING_PLANE_AXIS_Y_NEGATIVE = 2,
         CLIPPING_PLANE_AXIS_Y_POSITIVE = 3,
         CLIPPING_PLANE_AXIS_Z_NEGATIVE = 4,
         CLIPPING_PLANE_AXIS_Z_POSITIVE = 5,
         CLIPPING_PLANE_AXIS_NUMBER_OF = 6
      };

      /// clipping plane application
      enum CLIPPING_PLANE_APPLICATION {
         CLIPPING_PLANE_APPLICATION_MAIN_WINDOW_ONLY,
         CLIPPING_PLANE_APPLICATION_FIDUCIAL_SURFACES_ONLY,
         CLIPPING_PLANE_APPLICATION_ALL_SURFACES,
      };

      /// get the drawing mode
      DRAW_MODE getDrawMode() const { return drawMode; }
      
      /// set the drawing mode
      void setDrawMode(const DRAW_MODE dm);
      
      /// get the viewing projection
      VIEWING_PROJECTION getViewingProjection() const { return viewingProjection; }
      
      /// set the viewing projection
      void setViewingProjection(const VIEWING_PROJECTION vp) { viewingProjection = vp; }
      
      /// Constructor
      DisplaySettingsSurface(BrainSet* bs);
      
      /// Desstructor
      ~DisplaySettingsSurface();
      
      /// get node brightness
      float getNodeBrightness() const { return nodeBrightness; }
      
      /// set node brightness
      void setNodeBrightness(const float bright) { nodeBrightness = bright; }
      
      /// get node contrast
      float getNodeContrast() const { return nodeContrast; }
      
      /// set node contrast
      void setNodeContrast(const float contrast) { nodeContrast = contrast; }
      
      /// get node size
      float getNodeSize() const { return nodeSize; }
      
      /// set node size
      void setNodeSize(const float size) { nodeSize = size; }
      
      /// get link size
      float getLinkSize() const { return linkSize; }
      
      /// set link size
      void setLinkSize(const float size) { linkSize = size; }
      
      /// get show normals
      bool getShowNormals() const { return showNormals; }
      
      /// set show normals
      void setShowNormals(const bool show) { showNormals = show; }
      
      /// get show morphing total forces
      bool getShowMorphingTotalForces() const { return showMorphingTotalForces; }
      
      /// set show morphing total forces
      void setShowMorphingTotalForces(const bool show) { showMorphingTotalForces = show; }
      
      /// get show morphing angular forces
      bool getShowMorphingAngularForces() const { return showMorphingAngularForces; }
      
      /// set show morphing angular forces
      void setShowMorphingAngularForces(const bool show) { showMorphingAngularForces = show; }
      
      /// get show morphing linear forces
      bool getShowMorphingLinearForces() const { return showMorphingLinearForces; }
      
      /// set show morphing linear forces
      void setShowMorphingLinearForces(const bool show) { showMorphingLinearForces = show; }
      
      /// get display length of force vector
      float getForceVectorDisplayLength() const { return forceVectorDisplayLength; }
      
      /// set the display length of the force vector
      void setForceVectorDisplayLength(const float length) { forceVectorDisplayLength = length; }
      
      /// Get show surface axes info
      void getSurfaceAxesInfo(bool& showAxes,
                              bool& showLetters,
                              bool& showHashMarks,
                              float& axesLength,
                              float axesOffset[3]) const;
                          
      /// set show surface axes info
      void setSurfaceAxesInfo(const bool showAxes,
                              const bool showLetters,
                              const bool showHashMarks,
                              const float axesLength,
                              const float axesOffset[3]);
                          
      /// get the identify node color
      IDENTIFY_NODE_COLOR getIdentifyNodeColor() const { return identifyNodeColor; }
      
      /// set the identify node color
      void setIdentifyNodeColor(const IDENTIFY_NODE_COLOR idc) { identifyNodeColor = idc; }
      
      /// get the opacity
      float getOpacity() const { return opacity; }
      
      /// set the opacity
      void setOpacity(const float opacityIn) { opacity = opacityIn; };

      /// get a clipping plane coordinate
      float getClippingPlaneCoordinate(const CLIPPING_PLANE_AXIS planeAxis) const;

      /// set a clipping plane coordinate
      void setClippingPlaneCoordinate(const CLIPPING_PLANE_AXIS planeAxis,
                                      const float coordinateValue);

      /// get clipping plane enabled
      bool getClippingPlaneEnabled(const CLIPPING_PLANE_AXIS planeAxis) const;

      /// set a clipping plane coordinate
      void setClippingPlaneEnabled(const CLIPPING_PLANE_AXIS planeAxis,
                                   const bool enabled);

      /// get the clipping plane application
      CLIPPING_PLANE_APPLICATION getClippingPlaneApplication() const { return clippingPlaneApplication; }

      /// set the clipping plane application
      void setClippingPlaneApplication(const CLIPPING_PLANE_APPLICATION cpa) { clippingPlaneApplication = cpa; }

      /// Reinitialize all display settings
      void reset();
      
      /// Update any selections due to changes in loaded surface shape file
      void update();
      
      /// apply a scene (set display settings)
      virtual void showScene(const SceneFile::Scene& scene, QString& errorMessage) ;
      
      /// create a scene (read display settings)
      virtual void saveScene(SceneFile::Scene& scene, const bool onlyIfSelected,
                             QString& errorMessage);
                       
   private:
      /// the drawing mode
      DRAW_MODE drawMode;
      
      /// node brightness
      float nodeBrightness;
      
      /// node contrast
      float nodeContrast;
      
      /// node size
      float nodeSize;
      
      /// link size
      float linkSize;
      
      /// display length of a force vector
      float forceVectorDisplayLength;
      
      /// show normals
      bool showNormals;
      
      /// show morphing total forces
      bool showMorphingTotalForces;
      
      /// show morphing angular forces
      bool showMorphingAngularForces;
      
      /// show morphing linear forces
      bool showMorphingLinearForces;
    
      /// the viewing projection
      VIEWING_PROJECTION viewingProjection;
      
      /// show surface axes
      bool showSurfaceAxes;
      
      /// show surface axes letters on surface axes
      bool showSurfaceAxesLetters;
      
      /// show surface axes hash marks
      bool showSurfaceAxesHashMarks;
      
      /// surface axes length
      float surfaceAxesLength;
      
      /// surface axis offset
      float surfaceAxesOffset[3];
      
      /// identify node color
      IDENTIFY_NODE_COLOR identifyNodeColor;
      
      /// surface opacity
      float opacity;

      /// clipping plane coordinate along each axis (negative and positive)
      float clippingPlaneCoordinate[CLIPPING_PLANE_AXIS_NUMBER_OF];

      /// clipping plane enabled for each axis (negative and positive)
      bool clippingPlaneEnabled[CLIPPING_PLANE_AXIS_NUMBER_OF];

      /// how the clipping planes are applied
      CLIPPING_PLANE_APPLICATION clippingPlaneApplication;
};

#endif // __VE_DISPLAY_SETTINGS_SURFACE_H__