GEO/GEO_AttribDict.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:
 *      Mark Elendt
 *      Side Effects Software Inc.
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        GEO library (C++)
 *
 * COMMENTS:    Attribute dictionaries
 *
 */

#ifndef __GEO_AttribDict_h__
#define __GEO_AttribDict_h__

#include "GEO_API.h"
#include <GB/GB_Attribute.h>

class GB_Vertex;
class GEO_Point;
class GEO_PointList;
class GEO_PrimList;
class GEO_Primitive;
class GEO_Vertex;

class GEO_VertexAttribDict;

/// Attribute dictionary for points
class GEO_API GEO_PointAttribDict : public GB_AttributeDict {
public:
             GEO_PointAttribDict(GEO_PointList &pointList);
    virtual ~GEO_PointAttribDict();

    virtual void        sortAs(const GB_AttributeDict &table);

    /// Note: if the dictionary already has point capture attributes,
    /// append will actually insert the attribute before the existing
    /// capture attribute.   It really should be named "add", but I'm
    /// leaving it "append" to look like the other dictionaries.
    // @{
    GB_AttributeRef     append(const char *n, int s, GB_AttribType type,
                               const void *defValue);
    GB_AttributeRef     append(const char *n, int s,
                               GB_AttribType type,
                               GB_AttribTypeInfo type_info,
                               const void *defValue);
    GB_AttributeRef     appendClone(const GB_Attribute *src);
    // @}
    void                destroy(const char *name, int size,GB_AttribType type);
    /// same as destroy but use relaxed search ignoring size comparison
    void                destroy(const char *name, GB_AttribType type);
    GB_AttributeRef     grow(const char *n, int oldsize, GB_AttribType type,
                             unsigned int addedsize);

    /// fill pt's attr list
    void                fillPoint(GEO_Point &pt) const;
    void                setVertexDict(GEO_VertexAttribDict *vd)
                        {
                            vtxDict = vd;
                        }

    // Methods for handling index attributes (i.e. material)
    
    void                destroyIndex(const char *name, const char *label);
    /// cleaning will remove all unused indices
    void                cleanIndex(const char *name);
    /// Collapses all index attribs
    void                collapseIndex();
    /// Clears all index attribs
    void                resetIndex();

private:
    void                resizeAttribData(int new_size);
    template<typename T> friend void
                        geoCopyAttribDict(T *me, const GB_AttributeDict &src);

private:
    GEO_PointList               &ptList;        // reference to the point list
    GEO_VertexAttribDict        *vtxDict;       // Pointer to vertex dictionary
};

/// Attribute dictionary for vertices
class GEO_API GEO_VertexAttribDict : public GB_AttributeDict {
public:
             GEO_VertexAttribDict(GEO_PrimList &primList);
    virtual ~GEO_VertexAttribDict();

    virtual void        sortAs(const GB_AttributeDict &table);
    GB_AttributeRef     append(const char *n, int s, GB_AttribType type,
                                const void *defValue);
    GB_AttributeRef     append(const char *n, int s, GB_AttribType type,
                               GB_AttribTypeInfo type_info,
                               const void *defValue);
    GB_AttributeRef     appendClone(const GB_Attribute *src);
    void                destroy(const char *name, int size,GB_AttribType type);
    /// same as destroy but use relaxed search ignoring size comparison
    void                destroy(const char *name, GB_AttribType type);
    GB_AttributeRef     grow(const char *n, int oldsize, GB_AttribType type,
                             unsigned int addedsize);

    /// Promote an attribute to the vertex dictionary
    void        promoteAttrib(const char *n, int s, GB_AttribType type);

    /// Demote an attribute to the point dictionary
    void        demoteAttrib(const char *n, int s, GB_AttribType type);
    void        fillVertex(GEO_Vertex &vtx) const;      //Fill vtx's attr list
    void        setPointDict(GEO_PointAttribDict *pd) { ptDict = pd; }

    // Methods for handling index attributes (i.e. material)

    void                destroyIndex(const char *name, const char *label);
    /// cleaning will remove all unused indices
    void                cleanIndex(const char *name);
    /// Collapses all index attribs
    void                collapseIndex();
    /// Clears all index attribs
    void                resetIndex();

private:
    void                resizeAttribData(int new_size);
    template<typename T> friend void
                        geoCopyAttribDict(T *me, const GB_AttributeDict &src);

    // Callback needs access to GA_AttributeRef friend abilities
    static int          translateVtxAttrib(GB_Vertex &v, void *data);
    static int          promoteVtxAttrib(GB_Vertex &v, void *data);
    static int          demoteVtxAttrib(GB_Vertex &v, void *data);
    static int          geoVertexAttribSizeUpdate(GB_Vertex &v, void *data);

private:
    GEO_PrimList        &prList;
    GEO_PointAttribDict *ptDict;
};

/// Attribute dictionary for primitives
class GEO_API GEO_PrimAttribDict : public GB_AttributeDict {
public:
             GEO_PrimAttribDict(GEO_PrimList &primList);
    virtual ~GEO_PrimAttribDict();

    virtual void        sortAs(const GB_AttributeDict &table);
    GB_AttributeRef     append(const char *n, int s, GB_AttribType type,
                               const void *defValue);
    GB_AttributeRef     append(const char *n, int s, GB_AttribType type,
                               GB_AttribTypeInfo type_info,
                               const void *defValue);
    GB_AttributeRef     appendClone(const GB_Attribute *src);
    void                destroy(const char *name, int size,GB_AttribType type);
    /// same as destroy but use relaxed search ignoring size comparison
    void                destroy(const char *name, GB_AttribType type);
    GB_AttributeRef     grow(const char *n, int oldsize, GB_AttribType type,
                             unsigned int addedsize);

    /// fill pr's attr list
    void                fillPrimitive(GEO_Primitive &pr) const;

    // Methods for handling index attributes (i.e. material)
    void                destroyIndex(const char *name, const char *label);
    /// cleaning will remove all unused indices
    void                cleanIndex(const char *name);
    /// Collapses all index attribs
    void                collapseIndex();
    /// Clears all index attribs
    void                resetIndex();

private:
    void                resizeAttribData(int new_size);
    template<typename T> friend void
                        geoCopyAttribDict(T *me, const GB_AttributeDict &src);

private:
    GEO_PrimList        &prList;
};

#endif

---