/*****************************************************************************
*
* 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.
*
*****************************************************************************/

// ************************************************************************* //
//                         avtCurveMapper.h                                  //
// ************************************************************************* //

#ifndef AVT_CURVE_MAPPER_H
#define AVT_CURVE_MAPPER_H


#include <avtMapper.h>
#include <LineAttributes.h>

// ****************************************************************************
//  Class: avtCurveMapper
//
//  Purpose:
//
//  Programmer: Kathleen Biagas 
//  Creation:   April 13, 2017
//
//  Modifications:
//
//      Alister Maguire, Mon Jun  4 15:13:43 PDT 2018
//      Added SetViewScale to allow adding a view scale
//      to the mapper. 
//
//      Alister Maguire, Mon Jun 11 10:15:25 PDT 2018
//      Added time cue options. 
//
// ****************************************************************************

class avtCurveMapper : virtual public avtMapper
{
  public:
                              avtCurveMapper();
    virtual                  ~avtCurveMapper();


    void                      SetColor(double [3]);
    void                      SetColor(double, double, double); 

    void                      SetLineWidth(_LineWidth lw);

    void                      SetDrawCurve(bool);
    void                      SetDrawPoints(bool);
    void                      SetStaticPoints(bool);

    void                      SetPointSize(double);
    void                      SetPointStride(int);
    void                      SetPointDensity(int);
    void                      SetSymbolType(int);
    void                      SetTimeForTimeCue(double);
    void                      SetDoBallTimeCue(bool);
    void                      SetTimeCueBallSize(double);
    void                      SetTimeCueBallColor(double [3]);
    void                      SetDoLineTimeCue(bool);
    void                      SetTimeCueLineWidth(double);
    void                      SetTimeCueLineColor(double [3]);
    void                      SetDoCropTimeCue(bool);
    bool                      SetFullFrameScaling(bool, const double *);
    bool                      SetViewScale(const double);            

  protected:
    virtual vtkDataSetMapper *CreateMapper(void); 
    virtual void              CustomizeMappers(void);

  private:
    double                    curveColor[3]; 
    _LineWidth                lineWidth;
    bool                      drawCurve;
    bool                      drawPoints;
    double                    pointSize;
    int                       pointStride;
    bool                      staticPoints;
    int                       pointDensity;
    double                    ffScale[3];
    int                       symbolType;
    double                    timeForTimeCue;
    bool                      doBallTimeCue;
    double                    timeCueBallSize;
    double                    timeCueBallColor[3]; 
    bool                      doLineTimeCue;
    double                    timeCueLineWidth;
    double                    timeCueLineColor[3];
    bool                      doCropTimeCue;

};

#endif


