VTK  9.1.0
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=========================================================================*/
140#ifndef vtkImageActor_h
141#define vtkImageActor_h
142
143#include "vtkImageSlice.h"
144#include "vtkRenderingCoreModule.h" // For export macro
145
146class vtkAlgorithm;
148class vtkRenderer;
149class vtkImageData;
150
151class VTKRENDERINGCORE_EXPORT vtkImageActor : public vtkImageSlice
152{
153public:
155 void PrintSelf(ostream& os, vtkIndent indent) override;
156
161
163
171
173
179 vtkBooleanMacro(Interpolate, vtkTypeBool);
181
183
187 virtual void SetOpacity(double);
188 virtual double GetOpacity();
189 double GetOpacityMinValue() { return 0.0; }
190 double GetOpacityMaxValue() { return 1.0; }
192
194
198 void SetDisplayExtent(const int extent[6]);
199 void SetDisplayExtent(int minX, int maxX, int minY, int maxY, int minZ, int maxZ);
201 int* GetDisplayExtent() VTK_SIZEHINT(6) { return this->DisplayExtent; }
203
205
211 double* GetBounds() VTK_SIZEHINT(6) override;
212 void GetBounds(double bounds[6]) { this->Superclass::GetBounds(bounds); }
214
216
223 void GetDisplayBounds(double bounds[6]);
225
227
235
237
246 void SetZSlice(int z)
247 {
248 this->SetDisplayExtent(this->DisplayExtent[0], this->DisplayExtent[1], this->DisplayExtent[2],
249 this->DisplayExtent[3], z, z);
250 }
251 int GetZSlice() { return this->DisplayExtent[4]; }
255
264
266
271 vtkGetMacro(ForceOpaque, bool);
272 vtkSetMacro(ForceOpaque, bool);
273 vtkBooleanMacro(ForceOpaque, bool);
275
276protected:
278 ~vtkImageActor() override;
279
284 static int GetOrientationFromExtent(const int extent[6]);
285
286 int DisplayExtent[6];
287 double DisplayBounds[6];
288
289 // Convenience function that returns the input of the mapper
291
292 // the result of HasTranslucentPolygonalGeometry is cached
296
297private:
298 vtkImageActor(const vtkImageActor&) = delete;
299 void operator=(const vtkImageActor&) = delete;
300};
301
302#endif
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:114
draw an image in a rendered 3D scene
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...
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.
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.
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:157
represents an image in a 3D scene
a simple class to control print indentation
Definition: vtkIndent.h:113
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:173
record modification and/or execution time
Definition: vtkTimeStamp.h:52
void GetBounds(T a, double bds[6])
@ extent
Definition: vtkX3D.h:351
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SIZEHINT(...)