VTK  9.3.0
vtkImageActor.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
25#ifndef vtkImageActor_h
26#define vtkImageActor_h
27
28#include "vtkImageSlice.h"
29#include "vtkRenderingCoreModule.h" // For export macro
30
31VTK_ABI_NAMESPACE_BEGIN
32class vtkAlgorithm;
34class vtkRenderer;
35class vtkImageData;
36
37class VTKRENDERINGCORE_EXPORT vtkImageActor : public vtkImageSlice
38{
39public:
41 void PrintSelf(ostream& os, vtkIndent indent) override;
42
46 static vtkImageActor* New();
47
49
54 virtual void SetInputData(vtkImageData*);
57
59
65 vtkBooleanMacro(Interpolate, vtkTypeBool);
67
69
73 virtual void SetOpacity(double);
74 virtual double GetOpacity();
75 double GetOpacityMinValue() { return 0.0; }
76 double GetOpacityMaxValue() { return 1.0; }
78
80
84 void SetDisplayExtent(const int extent[6]);
85 void SetDisplayExtent(int minX, int maxX, int minY, int maxY, int minZ, int maxZ);
86 void GetDisplayExtent(int extent[6]);
87 int* GetDisplayExtent() VTK_SIZEHINT(6) { return this->DisplayExtent; }
89
91
97 double* GetBounds() VTK_SIZEHINT(6) override;
98 void GetBounds(double bounds[6]) { this->Superclass::GetBounds(bounds); }
100
102
109 void GetDisplayBounds(double bounds[6]);
111
113
117 int GetSliceNumber();
118 int GetSliceNumberMax();
119 int GetSliceNumberMin();
121
123
132 void SetZSlice(int z)
133 {
134 this->SetDisplayExtent(this->DisplayExtent[0], this->DisplayExtent[1], this->DisplayExtent[2],
135 this->DisplayExtent[3], z, z);
136 }
137 int GetZSlice() { return this->DisplayExtent[4]; }
141
150
152
157 vtkGetMacro(ForceOpaque, bool);
158 vtkSetMacro(ForceOpaque, bool);
159 vtkBooleanMacro(ForceOpaque, bool);
161
162protected:
164 ~vtkImageActor() override;
165
170 static int GetOrientationFromExtent(const int extent[6]);
171
172 int DisplayExtent[6];
173 double DisplayBounds[6];
174
175 // Convenience function that returns the input of the mapper
177
178 // the result of HasTranslucentPolygonalGeometry is cached
182
183private:
184 vtkImageActor(const vtkImageActor&) = delete;
185 void operator=(const vtkImageActor&) = delete;
186};
187
188VTK_ABI_NAMESPACE_END
189#endif
Superclass for all sources, filters, and sinks in VTK.
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.
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 * 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.
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.
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...
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
represents an image in a 3D scene
a simple class to control print indentation
Definition vtkIndent.h:29
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:59
record modification and/or execution time
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_SIZEHINT(...)