modelAPI.h

Go to the documentation of this file.

//
// Copyright 2016 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 USD_GENERATED_MODELAPI_H
#define USD_GENERATED_MODELAPI_H


#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/usd/usd/apiSchemaBase.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"

#include "pxr/base/vt/value.h"

#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/vec3f.h"
#include "pxr/base/gf/matrix4d.h"

#include "pxr/base/tf/token.h"
#include "pxr/base/tf/type.h"

PXR_NAMESPACE_OPEN_SCOPE

class SdfAssetPath;

// -------------------------------------------------------------------------- //
// MODELAPI                                                                   //
// -------------------------------------------------------------------------- //

class UsdModelAPI : public UsdAPISchemaBase
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::NonAppliedAPI;

    explicit UsdModelAPI(const UsdPrim& prim=UsdPrim())
        : UsdAPISchemaBase(prim)
    {
    }

    explicit UsdModelAPI(const UsdSchemaBase& schemaObj)
        : UsdAPISchemaBase(schemaObj)
    {
    }

    USD_API
    virtual ~UsdModelAPI();

    USD_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);

    USD_API
    static UsdModelAPI
    Get(const UsdStagePtr &stage, const SdfPath &path);


protected:
    USD_API
    UsdSchemaKind _GetSchemaKind() const override;

private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    USD_API
    static const TfType &_GetStaticTfType();

    static bool _IsTypedSchema();

    // override SchemaBase virtuals.
    USD_API
    const TfType &_GetTfType() const override;

public:
    // ===================================================================== //
    // Feel free to add custom code below this line, it will be preserved by 
    // the code generator. 
    //
    // Just remember to: 
    //  - Close the class declaration with }; 
    //  - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
    //  - Close the include guard with #endif
    // ===================================================================== //
    // --(BEGIN CUSTOM CODE)--

    
    enum KindValidation{
        KindValidationNone,
        KindValidationModelHierarchy
    };

    USD_API
    bool GetKind(TfToken* kind) const;
    
    USD_API
    bool SetKind(const TfToken& kind) const;

    USD_API
    bool IsKind(const TfToken& baseKind,
                KindValidation validation=KindValidationModelHierarchy) const;

    USD_API
    bool IsModel() const;

    USD_API
    bool IsGroup() const;


    
    USD_API
    bool GetAssetIdentifier(SdfAssetPath *identifier) const;

    USD_API
    void SetAssetIdentifier(const SdfAssetPath &identifier) const;
    
    USD_API
    bool GetAssetName(std::string *assetName) const;

    USD_API
    void SetAssetName(const std::string &assetName) const;
    
    USD_API
    bool GetAssetVersion(std::string *version) const;

    USD_API
    void SetAssetVersion(const std::string &version) const;

    USD_API
    bool GetPayloadAssetDependencies(VtArray<SdfAssetPath> *assetDeps) 
        const;
    
    USD_API
    void SetPayloadAssetDependencies(const VtArray<SdfAssetPath> &assetDeps) 
        const;

    USD_API
    bool GetAssetInfo(VtDictionary *info) const;

    USD_API
    void SetAssetInfo(const VtDictionary &info) const;


protected:
    
    template<typename T>
    bool _GetAssetInfoByKey(const TfToken &key, T *val) const {
        VtValue vtVal = GetPrim().GetAssetInfoByKey(key);
        if (!vtVal.IsEmpty() && vtVal.IsHolding<T>()) {
            *val = vtVal.UncheckedGet<T>();
            return true;
        }
        return false;
    }
};

#define USDMODEL_ASSET_INFO_KEYS \
    (identifier)                \
    (name)                      \
    (version)                   \
    (payloadAssetDependencies)

TF_DECLARE_PUBLIC_TOKENS(UsdModelAPIAssetInfoKeys, USD_API, USDMODEL_ASSET_INFO_KEYS);

PXR_NAMESPACE_CLOSE_SCOPE

#endif