/*****************************************************************************
*
* Copyright (c) 2000 - 2018, Lawrence Livermore National Security, LLC
* Produced at the Lawrence Livermore National Laboratory
* LLNL-CODE-442911
* All rights reserved.
*
* This file is  part of VisIt. For  details, see https://visit.llnl.gov/.  The
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* Redistribution  and  use  in  source  and  binary  forms,  with  or  without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of  source code must  retain the above  copyright notice,
*    this list of conditions and the disclaimer below.
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this  list of  conditions  and  the  disclaimer (as noted below)  in  the
*    documentation and/or other materials provided with the distribution.
*  - Neither the name of  the LLNS/LLNL nor the names of  its contributors may
*    be used to endorse or promote products derived from this software without
*    specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT  HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR  IMPLIED WARRANTIES, INCLUDING,  BUT NOT  LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE
* ARE  DISCLAIMED. IN  NO EVENT  SHALL LAWRENCE  LIVERMORE NATIONAL  SECURITY,
* LLC, THE  U.S.  DEPARTMENT OF  ENERGY  OR  CONTRIBUTORS BE  LIABLE  FOR  ANY
* DIRECT,  INDIRECT,   INCIDENTAL,   SPECIAL,   EXEMPLARY,  OR   CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT  LIMITED TO, PROCUREMENT OF  SUBSTITUTE GOODS OR
* SERVICES; LOSS OF  USE, DATA, OR PROFITS; OR  BUSINESS INTERRUPTION) HOWEVER
* CAUSED  AND  ON  ANY  THEORY  OF  LIABILITY,  WHETHER  IN  CONTRACT,  STRICT
* LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)  ARISING IN ANY  WAY
* OUT OF THE  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*****************************************************************************/

// ************************************************************************* //
//  File: avtLineSamplerFilter.h
// ************************************************************************* //

#ifndef AVT_LineSampler_FILTER_H
#define AVT_LineSampler_FILTER_H


//#include <avtPluginDataTreeIterator.h>
#include <avtPluginFilter.h>
#include <avtTimeLoopFilter.h>
#include <avtDatasetToDatasetFilter.h>

#include <avtVector.h>
#include <avtExtents.h>

#include <LineSamplerAttributes.h>

class vtkTransform;
class vtkDataSet;
class vtkPolyData;
class vtkUnstructuredGrid;


// ****************************************************************************
//  Class: avtLineSamplerFilter
//
//  Purpose:
//      A plugin operator for LineSampler.
//
//  Programmer: allen -- generated by xml2avt
//  Creation:   Thu Oct 14 15:05:33 PST 2010
//
// ****************************************************************************

class avtLineSamplerFilter : virtual public avtPluginFilter,
                             virtual public avtTimeLoopFilter,
                             virtual public avtDatasetToDatasetFilter
{
  public:
                         avtLineSamplerFilter();
    virtual             ~avtLineSamplerFilter();

    static avtFilter    *Create();

    virtual const char  *GetType(void)  { return "avtLineSamplerFilter"; };
    virtual const char  *GetDescription(void)
                             { return "LineSampler"; };

    virtual void         SetAtts(const AttributeGroup*);
    virtual bool         Equivalent(const AttributeGroup*);

  protected:
    LineSamplerAttributes atts;

    virtual void InitializeTimeLoop(void);

    virtual void ExamineContract(avtContract_p in_contract);
    virtual void Execute(void);
    virtual void CreateFinalOutput(void);
    virtual bool ExecutionSuccessful(void);

    virtual vtkDataSet* ExecuteChannelData(vtkDataSet *, int, std::string);
//  virtual vtkDataSet* ExecuteChannelList(vtkDataSet *, int, std::string);

    virtual vtkPolyData* createPoint( avtVector startPoint,
                                     avtVector stopPoint,
                                     bool allocateScalars );
  
    virtual vtkPolyData* createLine( avtVector startPoint,
                                    avtVector stopPoint,
                                    bool allocateScalars );
  
    virtual vtkDataSet* createCone( avtVector startPoint,
                                    avtVector stopPoint,
                                    avtVector normal,
                                    double radius,
                                    double divergence,
                                    bool allocateScalars );

    avtVector ProjectPointOnPlane( avtVector planePoint,
                                   avtVector planeNormal,
                                   avtVector point,
                                   avtVector direction );

    void applyTransform( vtkTransform* transform, avtVector &point );

    void checkBounds( vtkDataSet *in_ds,
                      avtVector &startPoint, avtVector &stopPoint );

    unsigned int checkWall( avtVector &startPoint, avtVector &stopPoint );

    std::vector< std::vector< std::pair< avtVector, float > > > lineSamples;

    vtkDataSet *composite_ds;

    int nTimeSteps;
    double cachedAngle;

    bool validTimeAxis;
    double lastTimeAxisValue;
};
#endif
