vtkActor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkActor_h
#define vtkActor_h

#include "vtkProp3D.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkRenderer;
class vtkPropCollection;
class vtkActorCollection;
class vtkTexture;
class vtkMapper;
class vtkProperty;

class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkActor : public vtkProp3D
{
public:
  vtkTypeMacro(vtkActor, vtkProp3D);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkActor* New();

  void GetActors(vtkPropCollection*) override;


  int RenderOpaqueGeometry(vtkViewport* viewport) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport* viewport) override;


  vtkTypeBool HasTranslucentPolygonalGeometry() override;
  vtkTypeBool HasOpaqueGeometry() override;

  virtual void Render(vtkRenderer*, vtkMapper*) {}

  void ShallowCopy(vtkProp* prop) override;

  void ReleaseGraphicsResources(vtkWindow*) override;


  void SetProperty(vtkProperty* lut);
  vtkProperty* GetProperty();

  virtual vtkProperty* MakeProperty();


  void SetBackfaceProperty(vtkProperty* lut);
  vtkGetObjectMacro(BackfaceProperty, vtkProperty);


  virtual void SetTexture(vtkTexture*);
  vtkGetObjectMacro(Texture, vtkTexture);

  virtual void SetMapper(vtkMapper*);


  vtkGetObjectMacro(Mapper, vtkMapper);

  using Superclass::GetBounds;
  double* GetBounds() VTK_SIZEHINT(6) override;

  virtual void ApplyProperties() {}

  vtkMTimeType GetMTime() override;

  vtkMTimeType GetRedrawMTime() override;


  vtkGetMacro(ForceOpaque, bool);
  vtkSetMacro(ForceOpaque, bool);
  vtkBooleanMacro(ForceOpaque, bool);
  vtkGetMacro(ForceTranslucent, bool);
  vtkSetMacro(ForceTranslucent, bool);
  vtkBooleanMacro(ForceTranslucent, bool);

  bool GetSupportsSelection() override;

  void ProcessSelectorPixelBuffers(
    vtkHardwareSelector* sel, std::vector<unsigned int>& pixeloffsets) override;

  // Get if we are in the translucent polygonal geometry pass
  bool IsRenderingTranslucentPolygonalGeometry() override { return this->InTranslucentPass; }
  void SetIsRenderingTranslucentPolygonalGeometry(bool val) { this->InTranslucentPass = val; }

protected:
  vtkActor();
  ~vtkActor() override;

  // is this actor opaque
  int GetIsOpaque();
  bool ForceOpaque;
  bool ForceTranslucent;
  bool InTranslucentPass;

  vtkProperty* Property;
  vtkProperty* BackfaceProperty;
  vtkTexture* Texture;
  vtkMapper* Mapper;

  // Bounds are cached in an actor - the MapperBounds are also cache to
  // help know when the Bounds need to be recomputed.
  double MapperBounds[6];
  vtkTimeStamp BoundsMTime;

private:
  vtkActor(const vtkActor&) = delete;
  void operator=(const vtkActor&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif