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

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

=========================================================================*/
// .NAME vtkRegularPolygonSource - create a regular, n-sided polygon and/or polyline
// .SECTION Description
// vtkRegularPolygonSource is a source object that creates a single n-sided polygon and/or 
// polyline. The polygon is centered at a specified point, orthogonal to
// a specified normal, and with a circumscribing radius set by the user. The user can
// also specify the number of sides of the polygon ranging from [3,N].
//
// This object can be used for seeding streamlines or defining regions for clipping/cutting.

#ifndef __vtkRegularPolygonSource_h
#define __vtkRegularPolygonSource_h

#include "vtkPolyDataAlgorithm.h"

class VTK_GRAPHICS_EXPORT vtkRegularPolygonSource : public vtkPolyDataAlgorithm 
{
public:
  // Description:
  // Standard methods for instantiation, obtaining type and printing instance values.
  static vtkRegularPolygonSource *New();
  vtkTypeMacro(vtkRegularPolygonSource,vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // Set/Get the number of sides of the polygon. By default, the number of sides
  // is set to six.
  vtkSetClampMacro(NumberOfSides,int,3,VTK_LARGE_INTEGER);
  vtkGetMacro(NumberOfSides,int);

  // Description:
  // Set/Get the center of the polygon. By default, the center is set at the
  // origin (0,0,0).
  vtkSetVector3Macro(Center,double);
  vtkGetVectorMacro(Center,double,3);

  // Description:
  // Set/Get the normal to the polygon. The ordering of the polygon will be
  // counter-clockwise around the normal (i.e., using the right-hand rule).
  // By default, the normal is set to (0,0,1).
  vtkSetVector3Macro(Normal,double);
  vtkGetVectorMacro(Normal,double,3);

  // Description:
  // Set/Get the radius of the polygon. By default, the radius is set to 0.5.
  vtkSetMacro(Radius,double);
  vtkGetMacro(Radius,double);

  // Description:
  // Control whether a polygon is produced. By default, GeneratePolygon is enabled.
  vtkSetMacro(GeneratePolygon,int);
  vtkGetMacro(GeneratePolygon,int);
  vtkBooleanMacro(GeneratePolygon,int);
  
  // Description:
  // Control whether a polyline is produced. By default, GeneratePolyline is enabled.
  vtkSetMacro(GeneratePolyline,int);
  vtkGetMacro(GeneratePolyline,int);
  vtkBooleanMacro(GeneratePolyline,int);
  
protected:
  vtkRegularPolygonSource();
  ~vtkRegularPolygonSource() {}

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

  int    NumberOfSides;
  double Center[3];
  double Normal[3];
  double Radius;
  int    GeneratePolygon;
  int    GeneratePolyline;

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

#endif
