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

  Program:   ParaView
  Module:    vtkPartitionOrderingInterface.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html 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   vtkPartitionOrderingInterface
 * @brief   Interface for ordering compositing.
 *
 *
 *      An interface class to get the order of process for parallel
 *      compositing.
 *
 * @sa
 *      vtkPKdTree,vtkPartitionOrdering
*/

#ifndef vtkPartitionOrderingInterface_h
#define vtkPartitionOrderingInterface_h

#include "vtkObject.h"
#include "vtkPVVTKExtensionsRenderingModule.h" // needed for export macro
#include "vtkSmartPointer.h"                   // For automatic reference counting

class vtkDataSet;
class vtkIntArray;
class vtkMultiProcessController;

class VTKPVVTKEXTENSIONSRENDERING_EXPORT vtkPartitionOrderingInterface : public vtkObject
{
public:
  vtkTypeMacro(vtkPartitionOrderingInterface, vtkObject);

  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
  static vtkPartitionOrderingInterface* New();

  // the number of processes
  int GetNumberOfRegions();

  /**
   * Return a list of all processes in order from front to back given a
   * vector direction of projection.  Use this to do visibility sorts
   * in parallel projection mode. `orderedList' will be resized to the number
   * of processes. The return value is the number of processes.
   * \pre orderedList_exists: orderedList!=0
   */
  int ViewOrderAllProcessesInDirection(
    const double directionOfProjection[3], vtkIntArray* orderedList);

  /**
   * Return a list of all processes in order from front to back given a
   * camera position.  Use this to do visibility sorts in perspective
   * projection mode. `orderedList' will be resized to the number
   * of processes. The return value is the number of processes.
   * \pre orderedList_exists: orderedList!=0
   */
  int ViewOrderAllProcessesFromPosition(const double cameraPosition[3], vtkIntArray* orderedList);

  //@{
  /**
   * Set the implementation to use for the view order methods. Current options
   * are vtkPKdTree and vtkPartitionOrdering.
   */
  void SetImplementation(vtkObject* implementation);
  vtkObject* GetImplementation() { return this->Implementation; }
  //@}

  vtkMTimeType GetMTime() VTK_OVERRIDE;

protected:
  vtkPartitionOrderingInterface();
  ~vtkPartitionOrderingInterface() override;

private:
  // Implementation must be either a vtkPKdTree object or a vtkPartitionOrdering object.
  vtkSmartPointer<vtkObject> Implementation;

  vtkPartitionOrderingInterface(const vtkPartitionOrderingInterface&) = delete;
  void operator=(const vtkPartitionOrderingInterface&) = delete;
};

#endif
