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

  Program:   Visualization Toolkit
  Module:    vtkPointSource.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   vtkPointSource
 * @brief   create a random cloud of points
 *
 * vtkPointSource is a source object that creates a user-specified number
 * of points within a specified radius about a specified center point.
 * By default location of the points is random within the sphere. It is
 * also possible to generate random points only on the surface of the
 * sphere. The output PolyData has the specified number of points and
 * 1 cell - a vtkPolyVertex containing all of the points.
*/

#ifndef vtkPointSource_h
#define vtkPointSource_h

#include "vtkFiltersSourcesModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"

#define VTK_POINT_UNIFORM   1
#define VTK_POINT_SHELL     0

class vtkRandomSequence;

class VTKFILTERSSOURCES_EXPORT vtkPointSource : public vtkPolyDataAlgorithm
{
public:
  static vtkPointSource *New();
  vtkTypeMacro(vtkPointSource,vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  //@{
  /**
   * Set the number of points to generate.
   */
  vtkSetClampMacro(NumberOfPoints,vtkIdType,1,VTK_ID_MAX);
  vtkGetMacro(NumberOfPoints,vtkIdType);
  //@}

  //@{
  /**
   * Set the center of the point cloud.
   */
  vtkSetVector3Macro(Center,double);
  vtkGetVectorMacro(Center,double,3);
  //@}

  //@{
  /**
   * Set the radius of the point cloud.  If you are
   * generating a Gaussian distribution, then this is
   * the standard deviation for each of x, y, and z.
   */
  vtkSetClampMacro(Radius,double,0.0,VTK_DOUBLE_MAX);
  vtkGetMacro(Radius,double);
  //@}

  //@{
  /**
   * Specify the distribution to use.  The default is a
   * uniform distribution.  The shell distribution produces
   * random points on the surface of the sphere, none in the interior.
   */
  vtkSetMacro(Distribution,int);
  void SetDistributionToUniform() {
    this->SetDistribution(VTK_POINT_UNIFORM);};
  void SetDistributionToShell() {
    this->SetDistribution(VTK_POINT_SHELL);};
  vtkGetMacro(Distribution,int);
  //@}

  //@{
  /**
   * Set/get the desired precision for the output points.
   * vtkAlgorithm::SINGLE_PRECISION - Output single-precision floating point.
   * vtkAlgorithm::DOUBLE_PRECISION - Output double-precision floating point.
   */
  vtkSetMacro(OutputPointsPrecision,int);
  vtkGetMacro(OutputPointsPrecision,int);
  //@}

  //@{
  /**
   * Set/Get a random sequence generator.
   * By default, the generator in vtkMath is used to maintain backwards
   * compatibility.
   */
  virtual void SetRandomSequence(vtkRandomSequence *randomSequence);
  vtkGetObjectMacro(RandomSequence,vtkRandomSequence);
  //@}

protected:
  vtkPointSource(vtkIdType numPts=10);
  ~vtkPointSource() VTK_OVERRIDE;

  int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) VTK_OVERRIDE;

  double Random();

  vtkIdType NumberOfPoints;
  double Center[3];
  double Radius;
  int Distribution;
  int OutputPointsPrecision;
  vtkRandomSequence* RandomSequence;

private:
  vtkPointSource(const vtkPointSource&) VTK_DELETE_FUNCTION;
  void operator=(const vtkPointSource&) VTK_DELETE_FUNCTION;
};

#endif