dox/Widgets/vtkKWEPaintbrushSelectionRepresentation.h

Go to the documentation of this file.

//=============================================================================
//   This file is part of VTKEdge. See vtkedge.org for more information.
//
//   Copyright (c) 2010 Kitware, Inc.
//
//   VTKEdge may be used under the terms of the BSD License
//   Please see the file Copyright.txt in the root directory of
//   VTKEdge for further information.
//
//   Alternatively, you may see: 
//
//   http://www.vtkedge.org/vtkedge/project/license.html
//
//
//   For custom extensions, consulting services, or training for
//   this or any other Kitware supported open source project, please
//   contact Kitware at sales@kitware.com.
//
//
//=============================================================================

#ifndef __vtkKWEPaintbrushSelectionRepresentation_h
#define __vtkKWEPaintbrushSelectionRepresentation_h

#include "VTKEdgeConfigure.h" // needed for export symbols directives
#include "vtkWidgetRepresentation.h"
#include <vtkstd/vector>

class vtkKWEPaintbrushDrawing;
class vtkPointPlacer;
class vtkKWEPaintbrushSketch;
class vtkKWEPaintbrushSelectionWidget;

class VTKEdge_WIDGETS_EXPORT vtkKWEPaintbrushSelectionRepresentation
                                       : public vtkWidgetRepresentation
{
  //BTX
  friend class vtkKWEPaintbrushSelectionWidget;
  //ETX
public:

  vtkTypeRevisionMacro( vtkKWEPaintbrushSelectionRepresentation,
                        vtkWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent);

  //BTX -- States the representation can set itself into
  enum
    {
    PaintbrushRequestSketchSelect,
    PaintbrushSketchSelect,
    PaintbrushSketchUnselect,
    PaintbrushRequestSketchMerge,
    PaintbrushSketchMerge,
    PaintbrushDisabled,
    None
   };
  //ETX

  virtual int  ComputeInteractionState(int X, int Y, int modifier=0);


  virtual void SetPaintbrushDrawing( vtkKWEPaintbrushDrawing * );
  vtkGetObjectMacro( PaintbrushDrawing, vtkKWEPaintbrushDrawing );

  // Descirption:
  // Set / get the Point Placer. The point placer is responsible for
  // converting display coordinates into world coordinates according
  // to some constraints, and for validating world positions.
  // By writing an appopriate point placer, you can disable/enable selection
  // on regions in world space.
  void SetPointPlacer( vtkPointPlacer * );
  vtkGetObjectMacro( PointPlacer, vtkPointPlacer );

  // Descirption:
  // Deep copy.. synchronizes states etc..
  virtual void DeepCopy(vtkWidgetRepresentation *);


  virtual int DisplayPositionIsInside( vtkKWEPaintbrushSketch *s,
                                       double displayPos[2]);


  virtual int WorldPositionIsInside( vtkKWEPaintbrushSketch *s,
                                     double worldPos[3]);

  vtkGetObjectMacro( SelectedSketch, vtkKWEPaintbrushSketch );

  virtual void AddSketchToSelection( vtkKWEPaintbrushSketch * );

  virtual void RemoveSketchFromSelection( vtkKWEPaintbrushSketch * );

  virtual int DeleteSelectedSketches();


  virtual void SelectAllSketches();
  virtual void UnSelectAllSketches();

  //BTX

  const vtkstd::vector< vtkKWEPaintbrushSketch * > & GetSelectedSketches()
    { return this->SelectedSketches; }
  //ETX


  virtual int MergeSelectedSketches( vtkKWEPaintbrushSketch *mergedSketch = NULL,
                                     int removeSketches = 1 );

protected:
  vtkKWEPaintbrushSelectionRepresentation();
  ~vtkKWEPaintbrushSelectionRepresentation();


  vtkSetMacro( InteractionState, int );

  virtual int DragAndDropMerge();

  vtkKWEPaintbrushDrawing        *PaintbrushDrawing;

  vtkPointPlacer             * PointPlacer;

  int    LastDisplayPosition[2];

  vtkKWEPaintbrushSketch * SelectedSketch;


  typedef vtkstd::vector< vtkKWEPaintbrushSketch * > SelectedSketchesType;
  SelectedSketchesType  SelectedSketches;
  int                   PrevInteractionState;
  double                DragBeginPoint[3], DragEndPoint[3];
  vtkKWEPaintbrushSketch * DragAndDropDestination;

private:
  vtkKWEPaintbrushSelectionRepresentation(const vtkKWEPaintbrushSelectionRepresentation&);  //Not implemented
  void operator=(const vtkKWEPaintbrushSelectionRepresentation&);  //Not implemented
};

#endif