This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
variantSpec.h File Reference
+ Include dependency graph for variantSpec.h:

Go to the source code of this file.

Classes

class  SdfVariantSpec
 Represents a single variant in a variant set. More...
 

Functions

 SDF_DECLARE_HANDLES (SdfLayer)
 
 SDF_DECLARE_HANDLES (SdfPrimSpec)
 
 SDF_DECLARE_HANDLES (SdfVariantSpec)
 
 SDF_DECLARE_HANDLES (SdfVariantSetSpec)
 
SDF_API SdfVariantSpecHandle SdfCreateVariantInLayer (const SdfLayerHandle &layer, const SdfPath &primPath, const std::string &variantSetName, const std::string &variantName)
 Convenience function to create a variant spec for a given variant set and a prim at the given path with.
 

Function Documentation

◆ SdfCreateVariantInLayer()

SDF_API SdfVariantSpecHandle SdfCreateVariantInLayer ( const SdfLayerHandle &  layer,
const SdfPath primPath,
const std::string &  variantSetName,
const std::string &  variantName 
)

Convenience function to create a variant spec for a given variant set and a prim at the given path with.

The function creates the prim spec if it doesn't exist already and any necessary parent prims, in the given layer.

It adds the variant set to the variant set list if it doesn't already exist.

It creates a variant spec with the given name under the specified variant set if it doesn't already exist.