GB/GB_AttributeListHandle.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.
 *
 * Produced by:
 *      Ondrej Kos
 *      Side Effects Software, Inc.
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        GB_AttributeListHandle.h (C++)
 *
 * COMMENTS:    Used to abstract the interface of dealing with multiple
 *              attributes, and more efficient than dealing with lists of
 *              GB_AttributeHandle(s).
 *
 */
#ifndef __GB_AttributeListHandle_h__
#define __GB_AttributeListHandle_h__

#include "GB_API.h"
#include <SYS/SYS_Types.h>
#include <UT/UT_PtrArray.h>
#include <UT/UT_SymbolTable.h>

#include "GB_AttributeDefines.h"
#include "GB_AttributeHandleBase.h"
#include "GB_AttributeData.h"

class UT_Vector3;
class GB_Detail;
class GB_Attribute;
class GB_AttributeDict;
class GB_AttributeElem;
class GB_AttributeHandle;
class GEO_AttributeHandle;

class GB_API GB_AttributeListHandle : public GB_AttributeHandleBase
{
public:

     /// Creates an empty attribute handle.
             GB_AttributeListHandle();
    virtual ~GB_AttributeListHandle();

    // The operator= does not copy references to the element, only to the
    // detail and the attribute offsets.  No data stored in the original handle
    // will be copied either.
    GB_AttributeListHandle      &operator=(const GB_AttributeListHandle &gah);

    int         entries() const { return myAttribs.entries(); }
    bool        isEmpty() const { return entries() == 0; }

    /// Invalidates the handle (gets rid of references to elements and details)
    virtual void        invalidate();

protected:
    // Add an attribute to the attribute list & name map
    bool                 appendAttribute(GB_AttributeHandle *h);
    bool                 removeAttribute(int i);
    bool                 removeAttribute(const char *name);

    GB_AttributeHandle  *getEntry(int i) const;
    GB_AttributeHandle  *getEntry(const char *name) const;

    /// Removes the attributes
    void                clearAttributes();

private:
    UT_PtrArray<GB_AttributeHandle *>           myAttribs;
    UT_SymbolTable                              myNameMap;
};

#endif

---