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

// ************************************************************************* //
//                              avtLabelFilter.h                             //
// ************************************************************************* //

#ifndef AVT_Label_FILTER_H
#define AVT_Label_FILTER_H

#include <avtDataTreeIterator.h>
#include <vtkSystemIncludes.h>

class vtkDataSet;


// ****************************************************************************
//  Class: avtLabelFilter
//
//  Purpose:
//      This operator is the implied operator associated with an Label plot.
//
//  Programmer: Brad Whitlock
//  Creation:   Thu Jan 22 11:52:38 PDT 2004
//
//  Modifications:
//    Eric Brugger, Tue Aug 19 10:32:52 PDT 2014
//    Modified the class to work with avtDataRepresentation.
//
//    Kathleen Biagas, Wed Jun  3 10:28:07 PDT 2015
//    Added mayBeLogical, cellOrigin, nodeOrigin, to aid in calculating
//    logical indices.
//
//    Alister Maguire, Mon Feb 26 09:28:05 PST 2018
//    Added ModifyContract to turn on MIR if needed.  
//
// ****************************************************************************

class avtLabelFilter : public avtDataTreeIterator
{
  public:
                              avtLabelFilter();
    virtual                  ~avtLabelFilter();

    virtual const char       *GetType(void)   { return "avtLabelFilter"; };
    virtual const char       *GetDescription(void)
                                  { return "Labelling values"; };

    void                      SetLabelVariable(const char *);
    void                      SetMayBeLogical(bool val) 
                                  { mayBeLogical = val; }
    void                      SetCellOrigin(vtkIdType val) 
                                  { cellOrigin = val; }
    void                      SetNodeOrigin(vtkIdType val) 
                                  { nodeOrigin = val; }
  protected:
    enum QuantizationRetval
    {
        NoAction,
        DiscardedQuantizedNormals,
        CreatedQuantizedNormals
    };

    unsigned char             FindClosestVector(const double *vec) const;
    QuantizationRetval        CreateQuantizedNormalsFromPointNormals(
                                  vtkDataSet *outDS, bool isMesh);
    QuantizationRetval        CreateQuantizedNormalsFromCellNormals(
                                  vtkDataSet *outDS, bool isMesh);

    char                     *labelVariable;
    bool                      mayBeLogical;
    vtkIdType                 cellOrigin;
    vtkIdType                 nodeOrigin;

    virtual avtDataRepresentation *ExecuteData(avtDataRepresentation *);
    virtual void              UpdateDataObjectInfo(void);
    virtual avtContract_p     ModifyContract(avtContract_p);
};


#endif
