Find file
Fetching contributors…
Cannot retrieve contributors at this time
93 lines (71 sloc) 3.32 KB
Program: Visualization Toolkit
Module: vtkScalarBarWidget.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or for details.
This software is distributed WITHOUT ANY WARRANTY; without even
PURPOSE. See the above copyright notice for more information.
// .NAME vtkScalarBarWidget - 2D widget for manipulating a scalar bar
// .SECTION Description
// This class provides support for interactively manipulating the position,
// size, and orientation of a scalar bar. It listens to Left mouse events and
// mouse movement. It also listens to Right mouse events and notifies any
// observers of Right mouse events on this object when they occur.
// It will change the cursor shape based on its location. If
// the cursor is over an edge of the scalar bar it will change the cursor
// shape to a resize edge shape. If the position of a scalar bar is moved to
// be close to the center of one of the four edges of the viewport, then the
// scalar bar will change its orientation to align with that edge. This
// orientation is sticky in that it will stay that orientation until the
// position is moved close to another edge.
// .SECTION See Also
// vtkInteractorObserver
#ifndef __vtkScalarBarWidget_h
#define __vtkScalarBarWidget_h
#include "vtkBorderWidget.h"
class vtkScalarBarActor;
class vtkScalarBarRepresentation;
class VTK_WIDGETS_EXPORT vtkScalarBarWidget : public vtkBorderWidget
static vtkScalarBarWidget *New();
vtkTypeMacro(vtkScalarBarWidget, vtkBorderWidget);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// 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.
virtual void SetRepresentation(vtkScalarBarRepresentation *rep);
vtkScalarBarRepresentation *GetScalarBarRepresentation()
{ return reinterpret_cast<vtkScalarBarRepresentation *>(this->GetRepresentation()); }
// Description:
// Get the ScalarBar used by this Widget. One is created automatically.
virtual void SetScalarBarActor(vtkScalarBarActor *actor);
virtual vtkScalarBarActor *GetScalarBarActor();
// Description:
// Can the widget be moved. On by default. If off, the widget cannot be moved
// around.
// TODO: This functionality should probably be moved to the superclass.
vtkSetMacro(Repositionable, int);
vtkGetMacro(Repositionable, int);
vtkBooleanMacro(Repositionable, int);
// Description:
// Create the default widget representation if one is not set.
virtual void CreateDefaultRepresentation();
int Repositionable;
// Handle the case of Repositionable == 0
static void MoveAction(vtkAbstractWidget*);
// set the cursor to the correct shape based on State argument
virtual void SetCursor(int State);
vtkScalarBarWidget(const vtkScalarBarWidget&); //Not implemented
void operator=(const vtkScalarBarWidget&); //Not implemented