vtkBoundedPlanePointPlacer.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 vtkBoundedPlanePointPlacer_h
#define vtkBoundedPlanePointPlacer_h
 
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkPointPlacer.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkPlane;
class vtkPlaneCollection;
class vtkPlanes;
class vtkRenderer;
 
class VTKINTERACTIONWIDGETS_EXPORT vtkBoundedPlanePointPlacer : public vtkPointPlacer
{
public:
  static vtkBoundedPlanePointPlacer* New();
 
 
  vtkTypeMacro(vtkBoundedPlanePointPlacer, vtkPointPlacer);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkSetClampMacro(
    ProjectionNormal, int, vtkBoundedPlanePointPlacer::XAxis, vtkBoundedPlanePointPlacer::Oblique);
  vtkGetMacro(ProjectionNormal, int);
  void SetProjectionNormalToXAxis()
  {
    this->SetProjectionNormal(vtkBoundedPlanePointPlacer::XAxis);
  }
  void SetProjectionNormalToYAxis()
  {
    this->SetProjectionNormal(vtkBoundedPlanePointPlacer::YAxis);
  }
  void SetProjectionNormalToZAxis()
  {
    this->SetProjectionNormal(vtkBoundedPlanePointPlacer::ZAxis);
  }
  void SetProjectionNormalToOblique()
  {
    this->SetProjectionNormal(vtkBoundedPlanePointPlacer::Oblique);
  }
 
 
  void SetObliquePlane(vtkPlane*);
  vtkGetObjectMacro(ObliquePlane, vtkPlane);
 
 
  void SetProjectionPosition(double position);
  vtkGetMacro(ProjectionPosition, double);
 
 
  void AddBoundingPlane(vtkPlane* plane);
  void RemoveBoundingPlane(vtkPlane* plane);
  void RemoveAllBoundingPlanes();
  virtual void SetBoundingPlanes(vtkPlaneCollection*);
  vtkGetObjectMacro(BoundingPlanes, vtkPlaneCollection);
  void SetBoundingPlanes(vtkPlanes* planes);
 
  enum
  {
    XAxis = 0,
    YAxis,
    ZAxis,
    Oblique
  };
 
  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;
 
  // Description:
  // Orientationation is ignored, and the above method
  // is called instead.
  int ValidateWorldPosition(double worldPos[3], double worldOrient[9]) override;
 
  int UpdateWorldPosition(vtkRenderer* ren, double worldPos[3], double worldOrient[9]) override;
 
protected:
  vtkBoundedPlanePointPlacer();
  ~vtkBoundedPlanePointPlacer() override;
 
  // Indicates the projection normal as laying along the
  // XAxis, YAxis, ZAxis, or Oblique. For X, Y, and Z axes,
  // the projection normal is assumed to be anchored at
  // (0,0,0)
  int ProjectionNormal;
 
  // Indicates a distance from the origin of the projection
  // normal where the project plane will be placed
  double ProjectionPosition;
 
  // If the ProjectionNormal is oblique, this is the oblique
  // plane
  vtkPlane* ObliquePlane;
 
  // A collection of planes used to bound the projection
  // plane
  vtkPlaneCollection* BoundingPlanes;
 
  // Internal method for getting the project normal as a vector
  void GetProjectionNormal(double normal[3]);
 
  // Internal method for getting the origin of the
  // constraining plane as a 3-tuple
  void GetProjectionOrigin(double origin[3]);
 
  // Internal method for getting the orientation of
  // the projection plane
  void GetCurrentOrientation(double worldOrient[9]);
 
  // Calculate the distance of a point from the Object. Negative
  // values imply that the point is outside. Positive values imply that it is
  // inside. The closest point to the object is returned in closestPt.
  static double GetDistanceFromObject(double pos[3], vtkPlaneCollection* pc, double closestPt[3]);
 
private:
  vtkBoundedPlanePointPlacer(const vtkBoundedPlanePointPlacer&) = delete;
  void operator=(const vtkBoundedPlanePointPlacer&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif