TensorAttributes.h 6.31 KB
Newer Older
hrchilds's avatar
hrchilds committed
1 2
/*****************************************************************************
*
3
* Copyright (c) 2000 - 2014, Lawrence Livermore National Security, LLC
hrchilds's avatar
hrchilds committed
4
* Produced at the Lawrence Livermore National Laboratory
brugger's avatar
 
brugger committed
5
* LLNL-CODE-442911
hrchilds's avatar
hrchilds committed
6 7
* All rights reserved.
*
brugger's avatar
 
brugger committed
8
* This file is  part of VisIt. For  details, see https://visit.llnl.gov/.  The
hrchilds's avatar
hrchilds committed
9 10 11 12 13 14 15 16 17 18
* 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
brugger's avatar
 
brugger committed
19 20 21
*    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
hrchilds's avatar
hrchilds committed
22 23 24 25 26
*    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
brugger's avatar
 
brugger committed
27 28 29
* 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
hrchilds's avatar
hrchilds committed
30 31 32 33 34 35 36 37 38
* 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.
*
*****************************************************************************/

hrchilds's avatar
hrchilds committed
39 40 41 42
#ifndef TENSORATTRIBUTES_H
#define TENSORATTRIBUTES_H
#include <string>
#include <AttributeSubject.h>
43

hrchilds's avatar
hrchilds committed
44 45 46 47 48 49 50 51 52 53 54
#include <ColorAttribute.h>

// ****************************************************************************
// Class: TensorAttributes
//
// Purpose:
//    Attributes for the tensor plot
//
// Notes:      Autogenerated by xml2atts.
//
// Programmer: xml2atts
55
// Creation:   omitted
hrchilds's avatar
hrchilds committed
56 57 58 59 60 61 62 63
//
// Modifications:
//   
// ****************************************************************************

class TensorAttributes : public AttributeSubject
{
public:
64
    // These constructors are for objects of this class
hrchilds's avatar
hrchilds committed
65 66
    TensorAttributes();
    TensorAttributes(const TensorAttributes &obj);
67 68 69 70 71
protected:
    // These constructors are for objects derived from this class
    TensorAttributes(private_tmfs_t tmfs);
    TensorAttributes(const TensorAttributes &obj, private_tmfs_t tmfs);
public:
hrchilds's avatar
hrchilds committed
72 73
    virtual ~TensorAttributes();

hrchilds's avatar
hrchilds committed
74
    virtual TensorAttributes& operator = (const TensorAttributes &obj);
hrchilds's avatar
hrchilds committed
75 76
    virtual bool operator == (const TensorAttributes &obj) const;
    virtual bool operator != (const TensorAttributes &obj) const;
77 78 79 80
private:
    void Init();
    void Copy(const TensorAttributes &obj);
public:
hrchilds's avatar
hrchilds committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96

    virtual const std::string TypeName() const;
    virtual bool CopyAttributes(const AttributeGroup *);
    virtual AttributeSubject *CreateCompatible(const std::string &) const;
    virtual AttributeSubject *NewInstance(bool) const;

    // Property selection methods
    virtual void SelectAll();
    void SelectTensorColor();
    void SelectColorTableName();

    // Property setting methods
    void SetUseStride(bool useStride_);
    void SetStride(int stride_);
    void SetNTensors(int nTensors_);
    void SetScale(double scale_);
hrchilds's avatar
hrchilds committed
97 98
    void SetScaleByMagnitude(bool scaleByMagnitude_);
    void SetAutoScale(bool autoScale_);
hrchilds's avatar
hrchilds committed
99 100 101 102
    void SetColorByEigenvalues(bool colorByEigenvalues_);
    void SetUseLegend(bool useLegend_);
    void SetTensorColor(const ColorAttribute &tensorColor_);
    void SetColorTableName(const std::string &colorTableName_);
103
    void SetInvertColorTable(bool invertColorTable_);
hrchilds's avatar
hrchilds committed
104 105 106 107 108 109

    // Property getting methods
    bool                 GetUseStride() const;
    int                  GetStride() const;
    int                  GetNTensors() const;
    double               GetScale() const;
hrchilds's avatar
hrchilds committed
110 111
    bool                 GetScaleByMagnitude() const;
    bool                 GetAutoScale() const;
hrchilds's avatar
hrchilds committed
112 113 114 115 116 117
    bool                 GetColorByEigenvalues() const;
    bool                 GetUseLegend() const;
    const ColorAttribute &GetTensorColor() const;
          ColorAttribute &GetTensorColor();
    const std::string    &GetColorTableName() const;
          std::string    &GetColorTableName();
118
    bool                 GetInvertColorTable() const;
hrchilds's avatar
hrchilds committed
119 120

    // Persistence methods
hrchilds's avatar
hrchilds committed
121
    virtual bool CreateNode(DataNode *node, bool completeSave, bool forceAdd);
hrchilds's avatar
hrchilds committed
122 123 124 125 126 127 128 129 130 131 132
    virtual void SetFromNode(DataNode *node);


    // Keyframing methods
    virtual std::string               GetFieldName(int index) const;
    virtual AttributeGroup::FieldType GetFieldType(int index) const;
    virtual std::string               GetFieldTypeName(int index) const;
    virtual bool                      FieldsEqual(int index, const AttributeGroup *rhs) const;

    // User-defined methods
    bool ChangesRequireRecalculation(const TensorAttributes &obj);
133 134 135 136 137 138 139 140 141 142 143 144

    // IDs that can be used to identify fields in case statements
    enum {
        ID_useStride = 0,
        ID_stride,
        ID_nTensors,
        ID_scale,
        ID_scaleByMagnitude,
        ID_autoScale,
        ID_colorByEigenvalues,
        ID_useLegend,
        ID_tensorColor,
145 146 147
        ID_colorTableName,
        ID_invertColorTable,
        ID__LAST
148 149
    };

hrchilds's avatar
hrchilds committed
150 151 152 153 154
private:
    bool           useStride;
    int            stride;
    int            nTensors;
    double         scale;
hrchilds's avatar
hrchilds committed
155 156
    bool           scaleByMagnitude;
    bool           autoScale;
hrchilds's avatar
hrchilds committed
157 158 159 160
    bool           colorByEigenvalues;
    bool           useLegend;
    ColorAttribute tensorColor;
    std::string    colorTableName;
161
    bool           invertColorTable;
162 163 164

    // Static class format string for type map.
    static const char *TypeMapFormatString;
165
    static const private_tmfs_t TmfsStruct;
hrchilds's avatar
hrchilds committed
166
};
167
#define TENSORATTRIBUTES_TMFS "biidbbbbasb"
hrchilds's avatar
hrchilds committed
168 169

#endif