Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
vtkMRMLViewNode.h
Go to the documentation of this file.
1/*=auto=========================================================================
2
3 Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All Rights Reserved.
4
5 See COPYRIGHT.txt
6 or http://www.slicer.org/copyright/copyright.txt for details.
7
8 Program: 3D Slicer
9 Module: $RCSfile: vtkMRMLViewNode.h,v $
10 Date: $Date: 2006/03/19 17:12:28 $
11 Version: $Revision: 1.6 $
12
13=========================================================================auto=*/
14
15#ifndef __vtkMRMLViewNode_h
16#define __vtkMRMLViewNode_h
17
18// VTK includes
20
24class VTK_MRML_EXPORT vtkMRMLViewNode
26{
27public:
30 void PrintSelf(ostream& os, vtkIndent indent) override;
31
32 //--------------------------------------------------------------------------
34 //--------------------------------------------------------------------------
35
37
39 void ReadXMLAttributes( const char** atts) override;
40
42 void WriteXML(ostream& of, int indent) override;
43
47
49 const char* GetNodeTagName() override;
50
52 static double* defaultBackgroundColor();
53 static double* defaultBackgroundColor2();
54
56 static void GetDefaultBoxColor(double color[3]);
57
59 vtkGetMacro(BoxVisible, int);
60 vtkSetMacro(BoxVisible, int);
61
63 vtkSetVector3Macro(BoxColor, double);
64 vtkGetVector3Macro(BoxColor, double);
65
67 vtkGetMacro(AxisLabelsVisible, int);
68 vtkSetMacro(AxisLabelsVisible, int);
69
71 vtkGetMacro(AxisLabelsCameraDependent, int);
72 vtkSetMacro(AxisLabelsCameraDependent, int);
73
75 vtkGetMacro(FiducialsVisible, int);
76 vtkSetMacro(FiducialsVisible, int);
77
78 vtkGetMacro(FiducialLabelsVisible, int);
79 vtkSetMacro(FiducialLabelsVisible, int);
80
82 vtkGetMacro(FieldOfView, double);
83 vtkSetMacro(FieldOfView, double);
84
86 vtkGetMacro(LetterSize, double);
87 vtkSetMacro(LetterSize, double);
88
90 vtkGetMacro(AnimationMode, int);
91 vtkSetMacro(AnimationMode, int);
92 static const char* GetAnimationModeAsString(int id);
93 static int GetAnimationModeFromString(const char* name);
94
95 vtkGetMacro(ViewAxisMode, int);
96 vtkSetMacro(ViewAxisMode, int);
97 static const char* GetViewAxisModeAsString(int id);
98 static int GetViewAxisModeFromString(const char* name);
99
101 vtkGetMacro(SpinDirection, int);
102 vtkSetMacro(SpinDirection, int);
103 static const char* GetSpinDirectionAsString(int id);
104 static int GetSpinDirectionFromString(const char* name);
105
107 vtkGetMacro(SpinDegrees, double);
108 vtkSetMacro(SpinDegrees, double);
109
110 vtkGetMacro(RotateDegrees, double);
111 vtkSetMacro(RotateDegrees, double);
112
114 vtkGetMacro(AnimationMs, int);
115 vtkSetMacro(AnimationMs, int);
116
118 vtkGetMacro(RockLength, int);
119 vtkSetMacro(RockLength, int);
120
122 vtkGetMacro(RockCount, int);
123 vtkSetMacro(RockCount, int);
124
126 vtkGetMacro(StereoType, int);
127 vtkSetMacro(StereoType, int);
128 static const char* GetStereoTypeAsString(int id);
129 static int GetStereoTypeFromString(const char* name);
130
132 vtkGetMacro(RenderMode, int);
133 vtkSetMacro(RenderMode, int);
134 static const char* GetRenderModeAsString(int id);
135 static int GetRenderModeFromString(const char* name);
136
139 vtkGetMacro(UseDepthPeeling, int);
140 vtkSetMacro(UseDepthPeeling, int);
141
144 vtkGetMacro(FPSVisible, int);
145 vtkSetMacro(FPSVisible, int);
146
149 vtkGetMacro(GPUMemorySize, int);
150 vtkSetMacro(GPUMemorySize, int);
151
160 vtkBooleanMacro(AutoReleaseGraphicsResources, bool);
162
163
165 vtkSetMacro(ExpectedFPS, double);
166 vtkGetMacro(ExpectedFPS, double);
167
168 vtkSetMacro(VolumeRenderingQuality, int);
169 vtkGetMacro(VolumeRenderingQuality, int);
170 static const char* GetVolumeRenderingQualityAsString(int id);
171 static int GetVolumeRenderingQualityFromString(const char* name);
172
174 vtkGetMacro(RaycastTechnique, int);
175 vtkSetMacro(RaycastTechnique, int);
176 static const char* GetRaycastTechniqueAsString(int id);
177 static int GetRaycastTechniqueFromString(const char* name);
178
184
191
193 enum
194 {
198 };
199
201 enum
202 {
210 };
211
213 enum
214 {
224 };
225
227 enum
228 {
232 };
233
235 enum
236 {
237 Off = 0,
241 };
242
244 enum
245 {
250 };
251
253 enum
254 {
255 Composite = 0, // Composite with directional lighting (default)
256 CompositeEdgeColoring, // Composite with fake lighting (edge coloring, faster) - Not used
262 };
263
265 enum
266 {
269 };
270
276 void SetInteracting(int);
277 vtkGetMacro(Interacting, int);
278 vtkBooleanMacro(Interacting, int);
279
309
312 vtkGetMacro (LinkedControl, int );
313 vtkSetMacro (LinkedControl, int );
314 vtkBooleanMacro(LinkedControl, int);
315
321 void SetInteractionFlags(unsigned int);
322 vtkGetMacro(InteractionFlags, unsigned int);
323
325
328 vtkGetMacro(ShadowsVisibility, bool);
329 vtkSetMacro(ShadowsVisibility, bool);
330 vtkBooleanMacro(ShadowsVisibility, bool);
332
334
337 vtkGetMacro(AmbientShadowsSizeScale, double);
338 vtkSetMacro(AmbientShadowsSizeScale, double);
339 vtkBooleanMacro(AmbientShadowsSizeScale, double);
341
343
346 vtkBooleanMacro(AmbientShadowsVolumeOpacityThreshold, double);
348
350
354 vtkGetMacro(AmbientShadowsIntensityScale, double);
355 vtkSetMacro(AmbientShadowsIntensityScale, double);
357
359
363 vtkGetMacro(AmbientShadowsIntensityShift, double);
364 vtkSetMacro(AmbientShadowsIntensityShift, double);
366
367protected:
372
376 double BoxColor[3];
381
387
391
395
398
401
405
408
411
416
419
422
428
437
440
446
447 bool ShadowsVisibility{false};
452
455 unsigned int InteractionFlags;
456
457};
458
459#endif
void SetInteractionFlags(unsigned int)
@ AmbientShadowsVolumeOpacityThresholdFlag
void PrintSelf(ostream &os, vtkIndent indent) override
void ReadXMLAttributes(const char **atts) override
Read node attributes from XML file.
int FPSVisible
Show the Frame per second as text on the lower right part of the view.
static const char * GetAnimationModeAsString(int id)
int StereoType
Parameters for stereo viewing.
double AmbientShadowsSizeScale
@ IllustrativeContextPreservingExploration
static const char * GetStereoTypeAsString(int id)
double VolumeRenderingOversamplingFactor
static double * defaultBackgroundColor()
Return the color the view nodes have for the background by default.
static int GetRaycastTechniqueFromString(const char *name)
void operator=(const vtkMRMLViewNode &)
@ Adaptive
quality determined from desired update rate
@ Maximum
high image quality, rendering time is not considered
@ Normal
good image quality at reasonable speed
static const char * GetVolumeRenderingQualityAsString(int id)
double AmbientShadowsIntensityShift
static const char * GetSpinDirectionAsString(int id)
int RenderMode
Specifies orthographic or perspective rendering.
double AmbientShadowsVolumeOpacityThreshold
static int GetVolumeRenderingQualityFromString(const char *name)
static const char * GetRenderModeAsString(int id)
static void GetDefaultBoxColor(double color[3])
Return default box color.
static int GetStereoTypeFromString(const char *name)
void SetInteracting(int)
void WriteXML(ostream &of, int indent) override
Write this node's information to a MRML file in XML format.
static int GetViewAxisModeFromString(const char *name)
static int GetSpinDirectionFromString(const char *name)
const char * GetNodeTagName() override
Get node XML tag name (like Volume, Model)
int UseDepthPeeling
Use the depth peeling rendering mode.
double ExpectedFPS
Expected frame per second rendered.
int RockLength
Parameters of automatic rock.
vtkMRMLViewNode(const vtkMRMLViewNode &)
vtkMRMLCopyContentMacro(vtkMRMLViewNode)
static const char * GetViewAxisModeAsString(int id)
static int GetRenderModeFromString(const char *name)
static const char * GetRaycastTechniqueAsString(int id)
int AnimationMode
Parameters of automatic spin.
static int GetAnimationModeFromString(const char *name)
~vtkMRMLViewNode() override
bool AutoReleaseGraphicsResources
Immediately release graphics resources when they are not in use.
unsigned int InteractionFlags
bool VolumeRenderingSurfaceSmoothing
Make surface appearance smoother in volume rendering. Off by default.
static vtkMRMLViewNode * New()
vtkMRMLNode * CreateNodeInstance() override
MRMLNode methods.
double AmbientShadowsIntensityScale
static double * defaultBackgroundColor2()