HUSD_CvexDataCommand.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_CvexDataCommand__
#define __HUSD_CvexDataCommand__

#include "HUSD_API.h"

#include <UT/UT_UniquePtr.h>
#include <VEX/VEX_PodTypes.h>

class HUSD_TimeCode; 
class HUSD_AutoWriteLock;

template <VEX_Precision PREC> class VEX_GeoCommandQueue;
template <typename T> class UT_Array;


/// Specify the VEX runtime precision for HUSD execution of VEX programs.
static constexpr VEX_Precision HUSD_VEX_PREC = VEX_64;


/// Abstracts the object that handles USD VEX edit functions that submitted
/// the stage modificaiton requests with it.
class HUSD_API HUSD_CvexDataCommand
{
public:
    /// Creates the cvex code object given the string and its meaning.
             HUSD_CvexDataCommand();
    virtual ~HUSD_CvexDataCommand();

    /// Applies the commands from the queue.
    virtual void    apply(HUSD_AutoWriteLock &writelock,
                            const HUSD_TimeCode &time_code) = 0;

    /// Sets the number of command queues, usually one for each thread.
    void            setCommandQueueCount( int count );
    int             getCommandQueueCount() const;

    /// Returns the vex data command queue (ie, usd data edit requests).
    VEX_GeoCommandQueue<HUSD_VEX_PREC> &getCommandQueue( int index );

private:
    // Note, using unique ptr to avoid include bloat in the header.
    UT_UniquePtr<UT_Array<VEX_GeoCommandQueue<HUSD_VEX_PREC>>> myVexGeoCommands;
};

#endif