variantSpec.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_SDF_VARIANT_SPEC_H
#define PXR_USD_SDF_VARIANT_SPEC_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/sdf/api.h"
#include "pxr/usd/sdf/declareSpec.h"
#include "pxr/usd/sdf/proxyTypes.h"
#include "pxr/usd/sdf/spec.h"
#include <string>
 
PXR_NAMESPACE_OPEN_SCOPE
 
SDF_DECLARE_HANDLES(SdfLayer);
SDF_DECLARE_HANDLES(SdfPrimSpec);
SDF_DECLARE_HANDLES(SdfVariantSpec);
SDF_DECLARE_HANDLES(SdfVariantSetSpec);
 
class SdfPath;
 
class SdfVariantSpec : public SdfSpec
{
    SDF_DECLARE_SPEC(SdfVariantSpec, SdfSpec);
 
public:
 
    SDF_API
    static SdfVariantSpecHandle New(const SdfVariantSetSpecHandle& owner,
                                    const std::string& name);
 
 
 
    SDF_API
    std::string GetName() const;
 
    SDF_API
    TfToken GetNameToken() const;
 
 
    SDF_API
    SdfVariantSetSpecHandle GetOwner() const;
 
    SDF_API
    SdfPrimSpecHandle GetPrimSpec() const;
 
    SDF_API
    SdfVariantSetsProxy GetVariantSets() const;
 
    SDF_API
    std::vector<std::string> GetVariantNames(const std::string& name) const;
 
};
 
SDF_API SdfVariantSpecHandle SdfCreateVariantInLayer(
    const SdfLayerHandle &layer,
    const SdfPath &primPath,
    const std::string &variantSetName,
    const std::string &variantName );
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif /* SDF_VARIANT_SPEC_H */