VTK  9.3.0
vtkActor.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
26#ifndef vtkActor_h
27#define vtkActor_h
28
29#include "vtkProp3D.h"
30#include "vtkRenderingCoreModule.h" // For export macro
31
32VTK_ABI_NAMESPACE_BEGIN
33class vtkRenderer;
36class vtkTexture;
37class vtkMapper;
38class vtkProperty;
39
40class VTKRENDERINGCORE_EXPORT vtkActor : public vtkProp3D
41{
42public:
43 vtkTypeMacro(vtkActor, vtkProp3D);
44 void PrintSelf(ostream& os, vtkIndent indent) override;
45
51 static vtkActor* New();
52
59
61
64 int RenderOpaqueGeometry(vtkViewport* viewport) override;
67
69
75
82 virtual void Render(vtkRenderer*, vtkMapper*) {}
83
87 void ShallowCopy(vtkProp* prop) override;
88
95
97
107
114
116
123 vtkGetObjectMacro(BackfaceProperty, vtkProperty);
125
127
132 virtual void SetTexture(vtkTexture*);
133 vtkGetObjectMacro(Texture, vtkTexture);
135
142 virtual void SetMapper(vtkMapper*);
143
145
148 vtkGetObjectMacro(Mapper, vtkMapper);
150
155 using Superclass::GetBounds;
156 double* GetBounds() VTK_SIZEHINT(6) override;
157
166 virtual void ApplyProperties() {}
167
172
180
182
185 vtkGetMacro(ForceOpaque, bool);
186 vtkSetMacro(ForceOpaque, bool);
187 vtkBooleanMacro(ForceOpaque, bool);
188 vtkGetMacro(ForceTranslucent, bool);
189 vtkSetMacro(ForceTranslucent, bool);
190 vtkBooleanMacro(ForceTranslucent, bool);
192
199 bool GetSupportsSelection() override;
200
206 vtkHardwareSelector* sel, std::vector<unsigned int>& pixeloffsets) override;
207
209 // Get if we are in the translucent polygonal geometry pass
210 bool IsRenderingTranslucentPolygonalGeometry() override { return this->InTranslucentPass; }
211 void SetIsRenderingTranslucentPolygonalGeometry(bool val) { this->InTranslucentPass = val; }
213
214protected:
216 ~vtkActor() override;
217
218 // is this actor opaque
223
228
229 // Bounds are cached in an actor - the MapperBounds are also cache to
230 // help know when the Bounds need to be recomputed.
231 double MapperBounds[6];
233
234private:
235 vtkActor(const vtkActor&) = delete;
236 void operator=(const vtkActor&) = delete;
237};
238
239VTK_ABI_NAMESPACE_END
240#endif
an ordered list of actors
represents an object (geometry & properties) in a rendered scene
Definition vtkActor.h:41
void SetProperty(vtkProperty *lut)
Set/Get the property object that controls this actors surface properties.
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:82
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:222
vtkProperty * GetProperty()
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.
int RenderOpaqueGeometry(vtkViewport *viewport) override
Support the standard render methods.
vtkProperty * BackfaceProperty
Definition vtkActor.h:225
void SetBackfaceProperty(vtkProperty *lut)
Set/Get the property object that controls this actors backface surface properties.
vtkTypeBool HasOpaqueGeometry() override
Does this prop have some opaque/translucent polygonal geometry?
~vtkActor() override
vtkTimeStamp BoundsMTime
Definition vtkActor.h:232
bool ForceOpaque
Definition vtkActor.h:220
bool IsRenderingTranslucentPolygonalGeometry() override
Definition vtkActor.h:210
double * GetBounds() override
Return a reference to the Prop3D's composite transform.
vtkTexture * Texture
Definition vtkActor.h:226
vtkProperty * Property
Definition vtkActor.h:224
int GetIsOpaque()
vtkMapper * Mapper
Definition vtkActor.h:227
bool ForceTranslucent
Definition vtkActor.h:221
static vtkActor * New()
Creates an actor with the following defaults: origin(0,0,0) position=(0,0,0) scale=(1,...
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...
int RenderTranslucentPolygonalGeometry(vtkViewport *viewport) override
Support the standard render methods.
void SetIsRenderingTranslucentPolygonalGeometry(bool val)
Definition vtkActor.h:211
a simple class to control print indentation
Definition vtkIndent.h:29
abstract class specifies interface to map data to graphics primitives
Definition vtkMapper.h:77
represents an 3D object for placement in a rendered scene
Definition vtkProp3D.h:39
an ordered list of Props
abstract superclass for all actors, volumes and annotations
Definition vtkProp.h:43
represent surface properties of a geometric object
Definition vtkProperty.h:57
abstract specification for renderers
Definition vtkRenderer.h:59
handles properties associated with a texture map
Definition vtkTexture.h:58
record modification and/or execution time
abstract specification for Viewports
Definition vtkViewport.h:45
window superclass for vtkRenderWindow
Definition vtkWindow.h:25
int vtkTypeBool
Definition vtkABI.h:64
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:270
#define VTK_SIZEHINT(...)