HUSD_CvexDataInputs.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_CvexDataInputs__
#define __HUSD_CvexDataInputs__

#include "HUSD_API.h"
#include <VEX/VEX_GeoInputs.h>
#include <UT/UT_Array.h>
class HUSD_AutoAnyLock;
class HUSD_DataHandle;

/// Class to query an input on a VEX usd geometry (stage).
class HUSD_API HUSD_CvexDataInputs : public VEX_GeoInputs
{
public:
             HUSD_CvexDataInputs();
            ~HUSD_CvexDataInputs() override;

    /// Adds the input data lock to the inputs array.
    void     setInputData(int idx, HUSD_AutoAnyLock *data);

    /// Creates a read lock for the given data, and adds it to the input array.
    void     setInputData(int idx, const HUSD_DataHandle &data);

    /// Removes a specific data lock from the inputs array
    void     removeInputData(int idx);

    /// Removes all the data locks from the inputs array
    void     removeAllInputData();

    /// Returns a data lock (may be null) for a given input index. 
    HUSD_AutoAnyLock *getInputData(int idx) const;

private:
    UT_Array<HUSD_AutoAnyLock *>    myDataLockArray;
    UT_Array<HUSD_DataHandle *>     myDataHandleArray;
    UT_Array<bool>                  myIsOwned;
};

#endif