vtkPolygonalSurfacePointPlacer.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkPolygonalSurfacePointPlacer.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.

=========================================================================*/
#ifndef vtkPolygonalSurfacePointPlacer_h
#define vtkPolygonalSurfacePointPlacer_h

#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkPolyDataPointPlacer.h"

class  vtkPolyDataCollection;
class  vtkCellPicker;
class  vtkPolygonalSurfacePointPlacerInternals;
class  vtkPolyData;

// The Node stores information about the point. This information is used by
// the interpolator. Reusing this information avoids the need for a second
// pick operation to regenerate it. (Cellpickers are slow).
struct vtkPolygonalSurfacePointPlacerNode
{
  double       WorldPosition[3];
  double       SurfaceWorldPosition[3];
  vtkIdType    CellId;
  vtkIdType    PointId;
  double       ParametricCoords[3]; // parametric coords within cell
  vtkPolyData  *PolyData;
};

class VTKINTERACTIONWIDGETS_EXPORT vtkPolygonalSurfacePointPlacer
                                  : public vtkPolyDataPointPlacer
{
public:
  static vtkPolygonalSurfacePointPlacer *New();


  vtkTypeMacro(vtkPolygonalSurfacePointPlacer,vtkPolyDataPointPlacer);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  // Descuription:
  // Add /remove a prop, to place points on
  void AddProp( vtkProp * ) override;
  void RemoveViewProp(vtkProp *prop) override;
  void RemoveAllProps() override;

  int ComputeWorldPosition( vtkRenderer *ren,
                                    double displayPos[2],
                                    double worldPos[3],
                                    double worldOrient[9] ) override;

  int ComputeWorldPosition( vtkRenderer *ren,
                                    double displayPos[2],
                                    double refWorldPos[3],
                                    double worldPos[3],
                                    double worldOrient[9] ) override;

  int ValidateWorldPosition( double worldPos[3] ) override;

  int UpdateNodeWorldPosition( double worldPos[3],
                                       vtkIdType nodePointId ) override;

  int ValidateDisplayPosition( vtkRenderer *, double displayPos[2] ) override;

  int ValidateWorldPosition( double worldPos[3],
                                     double worldOrient[9] ) override;


  vtkGetObjectMacro( CellPicker, vtkCellPicker );


  vtkGetObjectMacro( Polys, vtkPolyDataCollection );


  vtkSetMacro( DistanceOffset, double );
  vtkGetMacro( DistanceOffset, double );


  vtkSetMacro( SnapToClosestPoint, vtkTypeBool );
  vtkGetMacro( SnapToClosestPoint, vtkTypeBool );
  vtkBooleanMacro( SnapToClosestPoint, vtkTypeBool );


  typedef vtkPolygonalSurfacePointPlacerNode Node;
  Node *GetNodeAtWorldPosition( double worldPos[3] );

protected:
  vtkPolygonalSurfacePointPlacer();
  ~vtkPolygonalSurfacePointPlacer() override;

  // The props that represents the terrain data (one or more) in a rendered
  // scene
  vtkCellPicker                           *CellPicker;
  vtkPolyDataCollection                   *Polys;
  vtkPolygonalSurfacePointPlacerInternals *Internals;
  double                                   DistanceOffset;
  vtkTypeBool                                      SnapToClosestPoint;

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

#endif