UT_GalleryTypes.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.
 *
 * COMMENTS:
 */

#ifndef UT_GALLERYTYPES_H
#define UT_GALLERYTYPES_H

#include "UT_API.h"
#include "UT_Options.h"
#include "UT_StringHolder.h"

namespace UT_Gallery
{
    /// Tag to indicate a snapshot was generated automatically (on a timer).
    static const UT_StringLit AUTO_TAG = "auto";
    /// Tag to indicate an item has been "starred" (marked as a favorite).
    static const UT_StringLit STAR_TAG = "star";

    /// String to identify data source items that are render snapshots.
    static const UT_StringLit ITEM_TYPE_SNAPSHOT = "snapshot";
    /// String to identify data source items that are USD/geometry assets.
    static const UT_StringLit ITEM_TYPE_ASSET = "asset";
    /// String to identify data source items that are materials.
    static const UT_StringLit ITEM_TYPE_MATERIAL = "material";
    /// String to identify data source items that are USD/geometry assets.
    static const UT_StringLit ITEM_TYPE_ANIMATION_CLIP = "animation_clip";
    /// String to identify data source items that are APEX Component assets.
    static const UT_StringLit ITEM_TYPE_APEX_COMPONENT = "apex_component";
    /// String to identify data source items that are just folders.
    static const UT_StringLit ITEM_TYPE_FOLDER = "folder";

    // If you change any of the values in the block below change, you *must*
    // add a database migration step to `UT_GalleryDataSourceDatabaseImpl` 

    /// String to identify the source of the item is a viewport snapshot
    static const UT_StringLit RENDER_METHOD_VIEWPORT_SNAPSHOT = "viewport_snapshot";
    /// String to identify the source of the item is a background render
    static const UT_StringLit RENDER_METHOD_BACKGROUNDRENDER = "backgroundrender";
    /// String to identify the source of the item is a clone
    static const UT_StringLit RENDER_METHOD_CLONE = "clone";
    /// String to identify the source of the item is a live render
    static const UT_StringLit RENDER_METHOD_LIVERENDER = "liverender";
    /// String to identify the source of the item is an external file
    static const UT_StringLit RENDER_METHOD_EXTERNAL = "external";

    /// String specifying the metadata key used to store the clone id if the
    /// item is being rendered by a Houdini Clone.
    static const UT_StringLit METADATA_CLONEID = "cloneid";

    /// Constant string representing an in-memory database backend source
    /// for a gallery model.
    static const UT_StringHolder IN_MEMORY_DATABASE = ":memory:";
    static const UT_StringHolder IN_MEMORY_APEXCATALOG = ":apexcatalog_memory:";

    enum DiffMarker { A, B, None };
};

/// Return the label to use for the given gallery item color.
UT_API const char *UTgetGalleryItemColorLabel(const UT_StringRef &clr);

/// Return the icon resource to use for the given gallery item color.
UT_API const char *UTgetGalleryItemColorIcon(const UT_StringRef &clr);

/// Return the icon resource to use for the given gallery item color.
UT_API const UT_StringArray &UTgetGalleryItemColors();

#endif