UT_ShotBuilderConfig.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:     UT_ShotBuilderConfig.h ( UT Library, C++)
 *
 * COMMENTS:
 *
 */

#ifndef __UT_SHOTBUILDERCONFIG_H__
#define __UT_SHOTBUILDERCONFIG_H__

#include "FS_API.h"
#include "UT/UT_Color.h"
#include "UT/UT_Function.h"
#include "UT/UT_JSONValueMap.h"
#include "UT/UT_SharedPtr.h"
#include "UT/UT_StringMap.h"
#include <UT/UT_StringArray.h>
#include <UT/UT_Vector3.h>

enum UT_ProjectChangedType
{
    ConfigChanged,
    ContentChanged
};

struct UT_ShotBuilderProjectConfig;

using UT_ProjectCallbackFn = UT_Function<void(int)>;
using UT_ShotBuilderProjectConfigPtr = UT_SharedPtr<UT_ShotBuilderProjectConfig>;

static float theDefaultFPS = 24.0;
static float theDefaultStartFrame = 1001;
static float theDefaultEndFrame = 1024;
static UT_StringHolder theDefaultExtension = "usda";
static UT_StringHolder theDefaultTypeIcon = "SHOTBUILDER_unittype_generic";
static UT_StringHolder theDefaultSublayerIcon = "SHOTBUILDER_sublayer";

struct UT_ShotBuilderLayerConfig
{
    UT_ShotBuilderLayerConfig() = default;
    UT_ShotBuilderLayerConfig(const UT_JSONValue* layerInfo);

    UT_StringHolder myDisplayName;
    UT_StringHolder myComments;
    UT_StringHolder myIcon;
};

struct UT_ShotBuilderUnitConfig
{
    UT_ShotBuilderUnitConfig() = default;
    UT_ShotBuilderUnitConfig(const UT_JSONValue* unitInfo);

    UT_ShotBuilderLayerConfig* layerConfig(const UT_StringRef& layerIdentifier);

    UT_StringHolder myName;
    UT_StringHolder myIcon;
    bool myHasFrameRange;
    UT_StringHolder mySubLayerFormat;
    fpreal myFPS = theDefaultFPS;
    fpreal myStartFrame = theDefaultStartFrame;
    fpreal myEndFrame = theDefaultEndFrame;
    UT_StringArray mySubLayerOrdering;
    UT_StringMap<UT_ShotBuilderLayerConfig> mySubLayers;
    UT_StringArray myPlaceholders;
};

struct UT_ShotBuilderProjectConfig
{
    UT_ShotBuilderProjectConfig(const UT_JSONValue& projectInfo);
    UT_ShotBuilderProjectConfig(const char* configPath);

    void save() const;

    void reload();

    UT_StringHolder myName;
    UT_StringHolder myUnitContextOption;
    UT_StringHolder myProjectDir;
    UT_StringHolder myProjectPath;
    UT_StringHolder myRootPrim;
    UT_StringHolder mySubLayerFormat;
    fpreal myFPS = theDefaultFPS;
    fpreal myStartFrame = theDefaultStartFrame;
    fpreal myEndFrame = theDefaultEndFrame;
    int myVersionPadding = 0;
    UT_StringArray myNonVersionedDirectories;

    UT_StringMap<UT_ShotBuilderUnitConfig> myUnitConfigs;

private:
    void initFromJSON(const UT_JSONValue& projectInfo);
};

class FS_API UT_ShotBuilderConfig
{
public:
    UT_ShotBuilderConfig();
    UT_ShotBuilderConfig(const char* projectConfigPath);

    // Project methods
    UT_StringHolder projectDirectory() const;
    UT_StringHolder projectPath() const;
    bool            isValid() const;
    int             versionPadding() const;
    UT_Vector3D     defaultFrameData() const;
    UT_StringHolder unitContextOption() const;

    // Unit Type methods
    UT_StringArray unitTypes() const;
    UT_StringArray unitsForType(const UT_StringRef &unittype) const;
    UT_StringArray subLayersForType(const UT_StringRef &unitType) const;
    UT_StringArray placeholdersForType(const UT_StringRef &unittype) const;
    UT_StringRef   subLayerFormatForType(const UT_StringRef &unitType) const;
    UT_StringRef   nameTemplateForType(const UT_StringRef &unitType) const;
    UT_StringRef   iconForType(const UT_StringRef &unittype) const;
    UT_StringRef   extensionForType(const UT_StringRef &unitType) const;

    bool isValidUnitType(const UT_StringRef &unitType) const;
    bool isValidUnit(const UT_StringHolder &unitContext) const;
    bool isValidUnit(const UT_StringRef &unitType,
                     const UT_StringRef &unit) const;

    // Unit methods
    UT_StringArray units(const UT_StringRef &pattern = "*") const;

    UT_StringRef   unitLayerPath(const UT_StringRef &unit) const;
    UT_StringRef   unitLayerPath(const UT_StringRef &unitType,
                                 const UT_StringRef &unitName) const;

    // Sublayer methods
    bool         mayBeVersionedFile(const UT_StringHolder &dir,
                                    const UT_StringHolder &filename) const;
    UT_StringRef iconForSubLayer(const UT_StringRef &unitType,
                                 const UT_StringRef &subLayer) const;

    // Write methods
    bool setIconForType(const UT_StringRef &unitType,
                        const UT_StringHolder &label);
    void save() const;

    void reload() const;
    static void reload(const UT_StringRef &configPath);

    // Callback methods
    static int  addProjectChangedCallback(const UT_ProjectCallbackFn &callback);
    static void removeProjectChangedCallback(int);
    static void projectChangedCallback(UT_ProjectChangedType changeType);

private:
    static UT_StringMap<UT_ShotBuilderProjectConfigPtr> theProjectConfigMap;

    UT_ShotBuilderProjectConfigPtr                   myProjectConfig;

    static UT_SortedMap<int, UT_ProjectCallbackFn>   myProjectChangedCallbacks;
    static int                                       myNextProjectChangedCallbackId;

    // private access to unit / layer configs
    const UT_ShotBuilderUnitConfig*
        unitConfig(const UT_StringRef& unitType) const;

    const UT_ShotBuilderLayerConfig*
        layerConfig(const UT_StringRef& unitType,
                    const UT_StringRef& subLayer) const;
};

#endif