HUSD_LockedStage.h

Go to the documentation of this file.

/*
 * Copyright 2019 Side Effects Software Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#ifndef __HUSD_LockedStage_h__
#define __HUSD_LockedStage_h__

#include "HUSD_API.h"
#include "HUSD_DataHandle.h"
#include "HUSD_Utils.h"
#include <UT/UT_Options.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_UniquePtr.h>

// This class wraps a stage that is constructed from a LOP node by the
// HUSD_LockedStageRegistry, and which is guaranteed not to change, even if
// the node recooks. This is used primarily by reference and sublayer LOPs
// which can reference their inputs. But we may reference the same input
// multiple times, with different context options values. So we actually
// need to reference a locked copy of the LOP's stage.
//
// Only the HUSD_LockedStageRegistry singleton should create these objects,
// though they may be destroyed by anyone that holds onto a shared pointer
// to one. Only const methods are exposed publicly.
class HUSD_API HUSD_LockedStage
{
public:
                                ~HUSD_LockedStage();

    bool                         isValid() const;
    bool                         strippedLayers() const
                                 { return myStrippedLayers; }
    fpreal                       time() const
                                 { return myTime; }
    const UT_StringHolder       &getRootLayerIdentifier() const
                                 { return myRootLayerIdentifier; }
    const UT_StringHolder       &getStageCacheIdentifier() const
                                 { return myStageCacheIdentifier; }

private:
                                 HUSD_LockedStage(const HUSD_DataHandle &data,
                                        int nodeid,
                                        bool strip_layers,
                                        fpreal t,
                                        const UT_Options &opts);

    bool                         lockStage(const HUSD_DataHandle &data,
                                        int nodeid,
                                        bool strip_layers,
                                        fpreal t,
                                        const UT_Options &opts);

    class husd_LockedStagePrivate;

    UT_UniquePtr<husd_LockedStagePrivate>        myPrivate;
    UT_StringHolder                              myRootLayerIdentifier;
    UT_StringHolder                              myStageCacheIdentifier;
    UT_Options                                   myOptions;
    fpreal                                       myTime;
    bool                                         myStrippedLayers;
    friend class                                 HUSD_LockedStageRegistry;
};

#endif