GB/GB_AttributeDefines.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:
 *      George ElKoura
 *      Side Effects Software, Inc.
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        GB_AttributeDefines.h (C++)
 *
 * COMMENTS:    
 *
 */
#ifndef __GB_AttributeDefines_h__
#define __GB_AttributeDefines_h__

/// This enum defines the types of storage for attributes in GA_Attribute
/// @warning
///     Do not change the numeric values since these are saved in binary
///     geometry files.
enum GB_AttribType {
        /// Attribute storage is 32-bit floating point values
        GB_ATTRIB_FLOAT = 0,
        /// Attribute storage is 32-bit integer values
        GB_ATTRIB_INT           = 1,
        /// @deprecated Please use GA_ATTRIB_INDEX instead
        GB_ATTRIB_STRING        = 2,

        /// Mixed attributes are not saved/loaded in .bgeo files.  They
        /// represent blind data that the geometry library doesn't know
        /// anything about.
        GB_ATTRIB_MIXED         = 3,

        /// A GB_ATTRIB_INDEX attribute maintains a separate table of string
        /// values.  These string values have a unique integer associated with
        /// them.  The attribute stores a 32-bit integer which refers to a
        /// string in the table on the GB_Attribute.  The following methods are
        /// used to access the table:
        /// - GB_Attribute::saveIndexValues()
        /// - GB_Attribute::loadIndexValues()
        /// - GB_Attribute::addIndex()
        /// - GB_Attribute::renameIndex()
        /// - GB_Attribute::destroyIndex()
        /// - GB_Attribute::clearIndex()
        /// - GB_Attribute::removeRedundantIndex()
        /// - GB_Attribute::getIndexSize()
        /// - GB_Attribute::getIndex()
        GB_ATTRIB_INDEX         = 4,    // Index of strings

        /// Same as float, but is always has a tuple size of 3 floats.
        /// In addition, when the geometry is transformed, any vector
        /// attributes are transformed as a @b normal.
        GB_ATTRIB_VECTOR        = 5,
};

/// Extended type information for attributes.
enum GB_AttribTypeInfo {
        // No extra type information
        GB_ATTRIB_INFO_NONE         = 0,    // no info available
        /// Floating values represent index/value pairs for capture weights
        GB_ATTRIB_INFO_INDEX_PAIR   = 1,

        /// Sentinal
        GB_ATTRIB_NUM_INFO
};

#define GB_ATTRIB_ALIGN_SIZE    sizeof(void *)

enum GB_AttributeStorage {
    GB_STORAGE_UNDEF,

    GB_STORAGE_INT,
    GB_STORAGE_INT8,
    GB_STORAGE_INT16,
    GB_STORAGE_INT32,
    GB_STORAGE_INT64,

    GB_STORAGE_FPREAL,
    GB_STORAGE_FPREAL16,
    GB_STORAGE_FPREAL32,
    GB_STORAGE_FPREAL64,

    GB_STORAGE_STRING,
    GB_STORAGE_OPAQUE,
    GB_STORAGE_VOID
};


#endif

---