readUtil.h

Go to the documentation of this file.

//
// Copyright 2018 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//


#ifndef PXRUSDMAYA_READUTIL_H
#define PXRUSDMAYA_READUTIL_H

#include "usdMaya/api.h"

#include "pxr/pxr.h"
#include "pxr/usd/sdf/attributeSpec.h"
#include "pxr/usd/usd/attribute.h"

#include <maya/MDGModifier.h>
#include <maya/MFnDependencyNode.h>
#include <maya/MObject.h>
#include <maya/MPlug.h>

#include <string>

PXR_NAMESPACE_OPEN_SCOPE


struct UsdMayaReadUtil
{

    PXRUSDMAYA_API
    static bool ReadFloat2AsUV();

    PXRUSDMAYA_API
    static MObject FindOrCreateMayaAttr(
            const SdfValueTypeName& typeName,
            const SdfVariability variability,
            MFnDependencyNode& depNode,
            const std::string& attrName,
            const std::string& attrNiceName = std::string());

    PXRUSDMAYA_API
    static MObject FindOrCreateMayaAttr(
            const SdfValueTypeName& typeName,
            const SdfVariability variability,
            MFnDependencyNode& depNode,
            const std::string& attrName,
            const std::string& attrNiceName,
            MDGModifier& modifier);

    PXRUSDMAYA_API
    static MObject FindOrCreateMayaAttr(
            const TfType& type,
            const TfToken& role,
            const SdfVariability variability,
            MFnDependencyNode& depNode,
            const std::string& attrName,
            const std::string& attrNiceName,
            MDGModifier& modifier);

    PXRUSDMAYA_API
    static bool SetMayaAttr(
            MPlug& attrPlug,
            const UsdAttribute& usdAttr);

    PXRUSDMAYA_API
    static bool SetMayaAttr(
            MPlug& attrPlug,
            const VtValue& newValue);

    PXRUSDMAYA_API
    static bool SetMayaAttr(
            MPlug& attrPlug,
            const VtValue& newValue,
            MDGModifier& modifier);

    PXRUSDMAYA_API
    static void SetMayaAttrKeyableState(
            MPlug& attrPlug,
            const SdfVariability variability);

    PXRUSDMAYA_API
    static void SetMayaAttrKeyableState(
            MPlug& attrPlug,
            const SdfVariability variability,
            MDGModifier& modifier);



    PXRUSDMAYA_API
    static bool ReadMetadataFromPrim(
            const TfToken::Set& includeMetadataKeys,
            const UsdPrim& prim,
            const MObject& mayaObject);

    PXRUSDMAYA_API
    static bool ReadAPISchemaAttributesFromPrim(
            const TfToken::Set& includeAPINames,
            const UsdPrim& prim,
            const MObject& mayaObject);



    template <typename T>
    static size_t ReadSchemaAttributesFromPrim(
            const UsdPrim& prim,
            const MObject& mayaObject,
            const std::vector<TfToken>& attributeNames,
            const UsdTimeCode& usdTime = UsdTimeCode::Default())
    {
        return ReadSchemaAttributesFromPrim(
                prim,
                mayaObject,
                TfType::Find<T>(),
                attributeNames,
                usdTime);
    }

    static size_t ReadSchemaAttributesFromPrim(
            const UsdPrim& prim,
            const MObject& mayaObject,
            const TfType& schemaType,
            const std::vector<TfToken>& attributeNames,
            const UsdTimeCode& usdTime = UsdTimeCode::Default());

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif