vtkLightRepresentation.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 vtkLightRepresentation_h
#define vtkLightRepresentation_h

#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkNew.h"                      // Needed for vtkNew
#include "vtkWidgetRepresentation.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkBox;
class vtkCellPicker;
class vtkConeSource;
class vtkLineSource;
class vtkPointHandleRepresentation3D;
class vtkPolyDataMapper;
class vtkProperty;
class vtkSphereSource;

class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkLightRepresentation
  : public vtkWidgetRepresentation
{
public:
  static vtkLightRepresentation* New();
  vtkTypeMacro(vtkLightRepresentation, vtkWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetMacro(Positional, bool);
  vtkGetMacro(Positional, bool);
  vtkBooleanMacro(Positional, bool);


  void SetLightPosition(double pos[3]);
  vtkGetVector3Macro(LightPosition, double);


  void SetFocalPoint(double pos[3]);
  vtkGetVector3Macro(FocalPoint, double);


  void SetConeAngle(double angle);
  vtkGetMacro(ConeAngle, double);


  void SetLightColor(double* color);
  double* GetLightColor() VTK_SIZEHINT(3);

  enum
  {
    Outside = 0,
    MovingLight,
    MovingFocalPoint,
    MovingPositionalFocalPoint,
    ScalingConeAngle
  };


  vtkSetClampMacro(InteractionState, int, Outside, ScalingConeAngle);


  vtkGetObjectMacro(Property, vtkProperty);


  void BuildRepresentation() override;
  int ComputeInteractionState(int X, int Y, int modify = 0) override;
  void StartWidgetInteraction(double eventPosition[2]) override;
  void WidgetInteraction(double eventPosition[2]) override;
  double* GetBounds() override;


  void ReleaseGraphicsResources(vtkWindow* w) override;
  int RenderOpaqueGeometry(vtkViewport* viewport) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport* viewport) override;

  void GetActors(vtkPropCollection*) override;

protected:
  vtkLightRepresentation();
  ~vtkLightRepresentation() override;

  virtual void SizeHandles();
  virtual void UpdateSources();
  virtual void ScaleConeAngle(double* pickPoint, double* lastPickPoint);

  vtkNew<vtkProperty> Property;
  vtkNew<vtkBox> BoundingBox;
  vtkCellPicker* LastPicker;
  double LastScalingDistance2 = -1;
  double LastEventPosition[3] = { 0, 0, 0 };

  // the Sphere
  vtkNew<vtkSphereSource> Sphere;
  vtkNew<vtkActor> SphereActor;
  vtkNew<vtkPolyDataMapper> SphereMapper;
  vtkNew<vtkCellPicker> SpherePicker;

  // the Cone
  vtkNew<vtkConeSource> Cone;
  vtkNew<vtkActor> ConeActor;
  vtkNew<vtkPolyDataMapper> ConeMapper;
  vtkNew<vtkCellPicker> ConePicker;

  // the Line
  vtkNew<vtkLineSource> Line;
  vtkNew<vtkActor> LineActor;
  vtkNew<vtkPolyDataMapper> LineMapper;
  vtkNew<vtkCellPicker> LinePicker;

  double LightPosition[3] = { 0, 0, 1 };
  double FocalPoint[3] = { 0, 0, 0 };
  double ConeAngle = 30;
  bool Positional = false;

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

VTK_ABI_NAMESPACE_END
#endif