PDG_CookOptions.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 PDG_COOK_OPTIONS_H
#define PDG_COOK_OPTIONS_H

#include "PDG_API.h"

#include "PDG_CustomHandlers.h"
#include "PDG_Filter.h"

#include <PDGE/PDGE_EvaluationOptions.h>
#include <UT/UT_StringArray.h>

/**
 * Options available to configure the behavior of a PDG cook
 */
struct PDG_API PDG_CookOptions : public PDGE_EvaluationOptions
{
    enum CookType
    {
        eFull,
        eNode,

        eGenerateFull,
        eGenerateNode,
        eGenerateStatic,

        eStaticDepFull,
        eStaticDepNode
    };

    PDG_CookOptions()
        : myCheckpointRate(30)
        , myCheckpointingEnabled(false)
        , myCookTime(0)
        , myCookType(eFull)
        , myRegenerateDefault(PDG_CustomHandlers::eRegenerateAll)
        , mySaveScene(false)
    {
    }

    UT_StringArray                          myNodeNames;
    PDG_Filter                              myStaticFilter;

    UT_StringHolder                         myCheckpointPath;
    int                                     myCheckpointRate;
    bool                                    myCheckpointingEnabled;

    fpreal                                  myCookTime;
    CookType                                myCookType;
    PDG_CustomHandlers::RegenerateResult    myRegenerateDefault;

    bool                                    mySaveScene;
};

#endif