You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

94 lines
2.9 KiB
C++

/*=========================================================================
Program: Visualization Toolkit
Module: vtkLightWidget.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkLightWidget
* @brief 3D widget for showing a LightRepresentation
*
* To use this widget, one generally pairs it with a
* vtkLightRepresentation. Various options are available in the representation
* for controlling how the widget appears, and how it functions.
*
* @par Event Bindings:
* By default, the widget responds to the following VTK events (i.e., it
* watches the vtkRenderWindowInteractor for these events):
* <pre>
* Select and move the sphere to change the light position.
* Select and move the cone or the line to change the focal point.
* Right-Click and scale on the cone to change the cone angle.
* </pre>
*
* @warning
* Note that the widget can be picked even when it is "behind"
* other actors. This is an intended feature and not a bug.
*
* @warning
* This class, and vtkLightRepresentation, are second generation VTK widgets.
*
* @sa
* vtkLightRepresentation vtkSphereWidget
*/
#ifndef vtkLightWidget_h
#define vtkLightWidget_h
#include "vtkAbstractWidget.h"
#include "vtkInteractionWidgetsModule.h" // For export macro
class vtkHandleWidget;
class vtkLightRepresentation;
class VTKINTERACTIONWIDGETS_EXPORT vtkLightWidget : public vtkAbstractWidget
{
public:
static vtkLightWidget* New();
vtkTypeMacro(vtkLightWidget, vtkAbstractWidget);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Specify an instance of vtkWidgetRepresentation used to represent this
* widget in the scene. Note that the representation is a subclass of vtkProp
* so it can be added to the renderer independent of the widget.
*/
void SetRepresentation(vtkLightRepresentation* r);
/**
* Return the representation as a vtkLightRepresentation.
*/
vtkLightRepresentation* GetLightRepresentation();
/**
* Create the default widget representation if one is not set.
*/
void CreateDefaultRepresentation() override;
protected:
vtkLightWidget();
~vtkLightWidget() override = default;
bool WidgetActive = false;
// These methods handle events
static void SelectAction(vtkAbstractWidget*);
static void EndSelectAction(vtkAbstractWidget*);
static void MoveAction(vtkAbstractWidget*);
static void ScaleAction(vtkAbstractWidget*);
private:
vtkLightWidget(const vtkLightWidget&) = delete;
void operator=(const vtkLightWidget&) = delete;
};
#endif