VTK  9.2.6
vtkImageActor.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkImageActor.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
37#ifndef vtkImageActor_h
38#define vtkImageActor_h
39
40#include "vtkImageSlice.h"
41#include "vtkRenderingCoreModule.h" // For export macro
42
43class vtkAlgorithm;
45class vtkRenderer;
46class vtkImageData;
47
48class VTKRENDERINGCORE_EXPORT vtkImageActor : public vtkImageSlice
49{
50public:
52 void PrintSelf(ostream& os, vtkIndent indent) override;
53
57 static vtkImageActor* New();
58
60
65 virtual void SetInputData(vtkImageData*);
68
70
76 vtkBooleanMacro(Interpolate, vtkTypeBool);
78
80
84 virtual void SetOpacity(double);
85 virtual double GetOpacity();
86 double GetOpacityMinValue() { return 0.0; }
87 double GetOpacityMaxValue() { return 1.0; }
89
91
95 void SetDisplayExtent(const int extent[6]);
96 void SetDisplayExtent(int minX, int maxX, int minY, int maxY, int minZ, int maxZ);
97 void GetDisplayExtent(int extent[6]);
98 int* GetDisplayExtent() VTK_SIZEHINT(6) { return this->DisplayExtent; }
100
102
108 double* GetBounds() VTK_SIZEHINT(6) override;
109 void GetBounds(double bounds[6]) { this->Superclass::GetBounds(bounds); }
111
113
120 void GetDisplayBounds(double bounds[6]);
122
124
132
134
143 void SetZSlice(int z)
144 {
145 this->SetDisplayExtent(this->DisplayExtent[0], this->DisplayExtent[1], this->DisplayExtent[2],
146 this->DisplayExtent[3], z, z);
147 }
148 int GetZSlice() { return this->DisplayExtent[4]; }
152
161
163
168 vtkGetMacro(ForceOpaque, bool);
169 vtkSetMacro(ForceOpaque, bool);
170 vtkBooleanMacro(ForceOpaque, bool);
172
173protected:
175 ~vtkImageActor() override;
176
181 static int GetOrientationFromExtent(const int extent[6]);
182
183 int DisplayExtent[6];
184 double DisplayBounds[6];
185
186 // Convenience function that returns the input of the mapper
188
189 // the result of HasTranslucentPolygonalGeometry is cached
193
194private:
195 vtkImageActor(const vtkImageActor&) = delete;
196 void operator=(const vtkImageActor&) = delete;
197};
198
199#endif
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:63
draw an image in a rendered 3D scene
Definition: vtkImageActor.h:49
virtual void SetInputData(vtkImageData *)
Set/Get the image data input for the image actor.
int GetWholeZMax()
Set/Get the current slice number.
virtual vtkTypeBool GetInterpolate()
Turn on/off linear interpolation of the image when rendering.
int GetSliceNumberMax()
Return the slice number (& min/max slice number) computed from the display extent.
void GetDisplayExtent(int extent[6])
The image extent is generally set explicitly, but if not set it will be determined from the input ima...
double * GetBounds() override
Get the bounds of this image actor.
int GetSliceNumber()
Return the slice number (& min/max slice number) computed from the display extent.
int * GetDisplayExtent()
The image extent is generally set explicitly, but if not set it will be determined from the input ima...
Definition: vtkImageActor.h:98
double * GetDisplayBounds()
Get the bounds of the data that is displayed by this image actor.
void GetDisplayBounds(double bounds[6])
Get the bounds of the data that is displayed by this image actor.
double GetOpacityMaxValue()
Set/Get the object's opacity.
Definition: vtkImageActor.h:87
vtkTimeStamp TranslucentComputationTime
virtual vtkImageData * GetInput()
Set/Get the image data input for the image actor.
virtual double GetOpacity()
Set/Get the object's opacity.
int GetSliceNumberMin()
Return the slice number (& min/max slice number) computed from the display extent.
virtual void SetOpacity(double)
Set/Get the object's opacity.
vtkTypeBool HasTranslucentPolygonalGeometry() override
Internal method, should only be used by rendering.
static vtkImageActor * New()
Instantiate the image actor.
vtkAlgorithm * GetInputAlgorithm()
virtual void SetInterpolate(vtkTypeBool)
Turn on/off linear interpolation of the image when rendering.
int TranslucentCachedResult
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
double GetOpacityMinValue()
Set/Get the object's opacity.
Definition: vtkImageActor.h:86
void SetDisplayExtent(const int extent[6])
The image extent is generally set explicitly, but if not set it will be determined from the input ima...
void SetZSlice(int z)
Set/Get the current slice number.
static int GetOrientationFromExtent(const int extent[6])
Guess the orientation from the extent.
~vtkImageActor() override
int GetWholeZMin()
Set/Get the current slice number.
void SetDisplayExtent(int minX, int maxX, int minY, int maxY, int minZ, int maxZ)
The image extent is generally set explicitly, but if not set it will be determined from the input ima...
int GetZSlice()
Set/Get the current slice number.
topologically and geometrically regular array of data
Definition: vtkImageData.h:54
represents an image in a 3D scene
Definition: vtkImageSlice.h:50
a simple class to control print indentation
Definition: vtkIndent.h:40
double * GetBounds() override=0
Return a reference to the Prop3D's composite transform.
an ordered list of Props
abstract specification for renderers
Definition: vtkRenderer.h:73
record modification and/or execution time
Definition: vtkTimeStamp.h:36
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SIZEHINT(...)