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

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

=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
// .NAME vtkAssignCoordinates - Given two(or three) arrays take the values
// in those arrays and simply assign them to the coordinates of the vertices.
//
// .SECTION Description
// Given two(or three) arrays take the values in those arrays and simply assign
// them to the coordinates of the vertices. Yes you could do this with the array
// calculator, but your mom wears army boots so we're not going to.

#ifndef vtkAssignCoordinates_h
#define vtkAssignCoordinates_h

#include "vtkInfovisLayoutModule.h" // For export macro
#include "vtkPassInputTypeAlgorithm.h"

class VTKINFOVISLAYOUT_EXPORT vtkAssignCoordinates : public vtkPassInputTypeAlgorithm
{
public:
  static vtkAssignCoordinates *New();

  vtkTypeMacro(vtkAssignCoordinates, vtkPassInputTypeAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // Set the x coordinate array name.
  vtkSetStringMacro(XCoordArrayName);
  vtkGetStringMacro(XCoordArrayName);

  // Description:
  // Set the y coordinate array name.
  vtkSetStringMacro(YCoordArrayName);
  vtkGetStringMacro(YCoordArrayName);

  // Description:
  // Set the z coordinate array name.
  vtkSetStringMacro(ZCoordArrayName);
  vtkGetStringMacro(ZCoordArrayName);

  // Description:
  // Set if you want a random jitter
  vtkSetMacro(Jitter,bool);

protected:
  vtkAssignCoordinates();
  ~vtkAssignCoordinates();

  int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
  int FillInputPortInformation(int port, vtkInformation* info);

private:

  char* XCoordArrayName;
  char* YCoordArrayName;
  char* ZCoordArrayName;
  bool Jitter;

  vtkAssignCoordinates(const vtkAssignCoordinates&);  // Not implemented.
  void operator=(const vtkAssignCoordinates&);  // Not implemented.
};

#endif

