BRAY_AttribList.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        BRAY_AttribList.h (RAY Library, C++)
 *
 * COMMENTS:
 */

#ifndef __BRAY_AttribList__
#define __BRAY_AttribList__

#include "BRAY_API.h"
#include <UT/UT_Array.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_NonCopyable.h>
#include <UT/UT_IntrusivePtr.h>
#include <GA/GA_Types.h>

class UT_JSONWriter;

/// Each BRAY_Object can define a list of attributes that it can evaluate.
class BRAY_API BRAY_AttribList
    : UT_NonCopyable
{
public:
    enum AttributeOwner
    {
        ATTRIB_INVALID = -1,

        ATTRIB_VERTEX = GA_ATTRIB_VERTEX,
        ATTRIB_POINT = GA_ATTRIB_POINT,
        ATTRIB_UNIFORM = GA_ATTRIB_PRIMITIVE,
        ATTRIB_CONSTANT = GA_ATTRIB_DETAIL,
        ATTRIB_DICED_POINT,
        ATTRIB_INSTANCE,

        MAX_ATTRIB_TYPE
    };
    static const char   *owner(AttributeOwner); // Return a label

    struct BRAY_API Attrib
    {
        Attrib() = delete;
        Attrib(const UT_StringHolder &name,
                int tuple_size,
                AttributeOwner owner,
                GA_Storage store,
                bool is_array)
            : myName(name)
            , myTupleSize(tuple_size)
            , myOwner(owner)
            , myStorage(store)
            , myStorageClass(GAstorageClass(store))
            , myIsArray(is_array)
        {
        }
        const UT_StringHolder   &name() const { return myName; }
        int                      tupleSize() const { return myTupleSize; }
        AttributeOwner           owner() const { return myOwner; }
        GA_Storage               storage() const { return myStorage; }
        GA_StorageClass          storageClass() const { return myStorageClass; }
        bool                     isArray() const { return myIsArray; }
        bool                     isDisplayColor() const;
        bool                     isDisplayOpacity() const;
        bool                     isNormal() const;
        bool                     isP() const;

        void                     dump() const;
        void                     dump(UT_JSONWriter &w) const;

        UT_StringHolder myName;
        int             myTupleSize;
        AttributeOwner  myOwner;
        GA_Storage      myStorage;
        GA_StorageClass myStorageClass;
        bool            myIsArray;
    };

    BRAY_AttribList();
    BRAY_AttribList(const Attrib *list, uint list_size, bool volume);
    ~BRAY_AttribList();

    /// Look up a list of attributes in a shared table.  If different
    /// BRAY_Objects share the same attribute list, then it's possible they will
    /// be shaded in batch.  Using the shared table can improve rendering
    /// performance.
    static const BRAY_AttribList        *findList(const Attrib *list,
                                                int list_size,
                                                bool for_volume);
    static const BRAY_AttribList        *findList(const BRAY_AttribList &src);

    void        setCapacity(int n);
    int         addAttribute(const UT_StringHolder &name,
                        int tuple_size,
                        AttributeOwner owner,
                        GA_Storage storage,
                        bool isarray);

    template <int TSIZE=-1>
    int         getIndex(const UT_StringRef &name) const
    {
        for (int i = 0, n = myList.size(); i < n; ++i)
            if (myList[i].name() == name &&
                    (TSIZE < 0 || TSIZE == myList[i].tupleSize()))
            {
                return i;
            }
        return -1;
    }

    int                 size() const { return myList.size(); }
    bool                forVolume() const { return myForVolume; }
    GA_Storage          storage(int i) const { return myList[i].myStorage; }
    int                 tupleSize(int i) const { return myList[i].myTupleSize; }
    AttributeOwner      owner(int i) const { return myList[i].myOwner; }
    GA_StorageClass     storageClass(int i) const { return myList[i].storageClass(); }
    bool                isArray(int i) const { return myList[i].myIsArray; }
    const UT_StringHolder       &name(int i) const { return myList[i].myName; }
    const Attrib        &attrib(int i) const { return myList[i]; }
    const Attrib        &operator[](int i) const { return myList[i]; }
    bool                 isNormal(int i) const { return i == myNormal; }
    bool                 isP(int i) const { return i == myP; }

    int                  displayColor() const { return myDisplayColor; }
    int                  displayOpacity() const { return myDisplayOpacity; }
    int                  normal() const { return myNormal; }
    int                  getP() const { return myP; }

    bool                isDicedNormal() const
                        {
                            return myNormal >= 0
                                && owner(myNormal) == ATTRIB_DICED_POINT;
                        }

    void        dump() const;
    void        dump(UT_JSONWriter &w) const;

private:
    UT_Array<Attrib>    myList;
    int                 myP;
    int                 myDisplayColor;
    int                 myDisplayOpacity;
    int                 myNormal;
    bool                myForVolume;
};

#endif