VTK  9.0.1
vtkActor.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkActor.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 =========================================================================*/
32 #ifndef vtkActor_h
33 #define vtkActor_h
34 
35 #include "vtkProp3D.h"
36 #include "vtkRenderingCoreModule.h" // For export macro
37 
38 class vtkRenderer;
39 class vtkPropCollection;
40 class vtkActorCollection;
41 class vtkTexture;
42 class vtkMapper;
43 class vtkProperty;
44 
45 class VTKRENDERINGCORE_EXPORT vtkActor : public vtkProp3D
46 {
47 public:
48  vtkTypeMacro(vtkActor, vtkProp3D);
49  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
56  static vtkActor* New();
57 
63  void GetActors(vtkPropCollection*) override;
64 
66 
69  int RenderOpaqueGeometry(vtkViewport* viewport) override;
72 
74 
80 
87  virtual void Render(vtkRenderer*, vtkMapper*) {}
88 
92  void ShallowCopy(vtkProp* prop) override;
93 
100 
102 
112 
119 
121 
128  vtkGetObjectMacro(BackfaceProperty, vtkProperty);
130 
132 
137  virtual void SetTexture(vtkTexture*);
138  vtkGetObjectMacro(Texture, vtkTexture);
140 
147  virtual void SetMapper(vtkMapper*);
148 
150 
153  vtkGetObjectMacro(Mapper, vtkMapper);
155 
160  using Superclass::GetBounds;
161  double* GetBounds() VTK_SIZEHINT(6) override;
162 
171  virtual void ApplyProperties() {}
172 
176  vtkMTimeType GetMTime() override;
177 
185 
187 
190  vtkGetMacro(ForceOpaque, bool);
191  vtkSetMacro(ForceOpaque, bool);
192  vtkBooleanMacro(ForceOpaque, bool);
193  vtkGetMacro(ForceTranslucent, bool);
194  vtkSetMacro(ForceTranslucent, bool);
195  vtkBooleanMacro(ForceTranslucent, bool);
197 
204  bool GetSupportsSelection() override;
205 
211  vtkHardwareSelector* sel, std::vector<unsigned int>& pixeloffsets) override;
212 
214  // Get if we are in the translucent polygonal geometry pass
215  bool IsRenderingTranslucentPolygonalGeometry() override { return this->InTranslucentPass; }
216  void SetIsRenderingTranslucentPolygonalGeometry(bool val) { this->InTranslucentPass = val; }
218 
219 protected:
221  ~vtkActor() override;
222 
223  // is this actor opaque
224  int GetIsOpaque();
228 
233 
234  // Bounds are cached in an actor - the MapperBounds are also cache to
235  // help know when the Bounds need to be recomputed.
236  double MapperBounds[6];
238 
239 private:
240  vtkActor(const vtkActor&) = delete;
241  void operator=(const vtkActor&) = delete;
242 };
243 
244 #endif
an ordered list of actors
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:46
void SetProperty(vtkProperty *lut)
Set/Get the property object that controls this actors surface properties.
virtual vtkProperty * MakeProperty()
Create a new property suitable for use with this type of Actor.
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this actor.
void GetActors(vtkPropCollection *) override
For some exporters and other other operations we must be able to collect all the actors or volumes.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkMTimeType GetRedrawMTime() override
Return the mtime of anything that would cause the rendered image to appear differently.
virtual void Render(vtkRenderer *, vtkMapper *)
This causes the actor to be rendered.
Definition: vtkActor.h:87
void ProcessSelectorPixelBuffers(vtkHardwareSelector *sel, std::vector< unsigned int > &pixeloffsets) override
allows a prop to update a selections color buffers Default just forwards to the Mapper
virtual void SetMapper(vtkMapper *)
This is the method that is used to connect an actor to the end of a visualization pipeline,...
vtkTypeBool HasTranslucentPolygonalGeometry() override
Does this prop have some opaque/translucent polygonal geometry?
vtkMTimeType GetMTime() override
Get the actors mtime plus consider its properties and texture if set.
bool InTranslucentPass
Definition: vtkActor.h:227
vtkProperty * GetProperty()
int RenderOpaqueGeometry(vtkViewport *viewport) override
Support the standard render methods.
vtkProperty * BackfaceProperty
Definition: vtkActor.h:230
void SetBackfaceProperty(vtkProperty *lut)
Set/Get the property object that controls this actors backface surface properties.
vtkTypeBool HasOpaqueGeometry() override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
~vtkActor() override
vtkTimeStamp BoundsMTime
Definition: vtkActor.h:237
bool ForceOpaque
Definition: vtkActor.h:225
bool IsRenderingTranslucentPolygonalGeometry() override
Definition: vtkActor.h:215
vtkTexture * Texture
Definition: vtkActor.h:231
vtkProperty * Property
Definition: vtkActor.h:229
int GetIsOpaque()
vtkMapper * Mapper
Definition: vtkActor.h:232
bool ForceTranslucent
Definition: vtkActor.h:226
double * GetBounds() override
Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
void ShallowCopy(vtkProp *prop) override
Shallow copy of an actor.
virtual void SetTexture(vtkTexture *)
Set/Get the texture object to control rendering texture maps.
bool GetSupportsSelection() override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
static vtkActor * New()
Creates an actor with the following defaults: origin(0,0,0) position=(0,0,0) scale=(1,...
int RenderTranslucentPolygonalGeometry(vtkViewport *viewport) override
void SetIsRenderingTranslucentPolygonalGeometry(bool val)
Definition: vtkActor.h:216
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract class specifies interface to map data to graphics primitives
Definition: vtkMapper.h:81
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:44
an ordered list of Props
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:54
virtual double * GetBounds()
Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
Definition: vtkProp.h:132
represent surface properties of a geometric object
Definition: vtkProperty.h:62
abstract specification for renderers
Definition: vtkRenderer.h:68
handles properties associated with a texture map
Definition: vtkTexture.h:66
record modification and/or execution time
Definition: vtkTimeStamp.h:33
abstract specification for Viewports
Definition: vtkViewport.h:45
window superclass for vtkRenderWindow
Definition: vtkWindow.h:38
int vtkTypeBool
Definition: vtkABI.h:69
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:293
#define VTK_SIZEHINT(...)