HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
UsdUtilsRegisteredVariantSet Class Reference

#include <registeredVariantSet.h>

Public Types

enum  SelectionExportPolicy { SelectionExportPolicy::Never, SelectionExportPolicy::IfAuthored, SelectionExportPolicy::Always }
 

Public Member Functions

 UsdUtilsRegisteredVariantSet (const std::string &name, const SelectionExportPolicy &selectionExportPolicy)
 
bool operator< (const UsdUtilsRegisteredVariantSet &other) const
 

Static Public Member Functions

static bool GetSelectionExportPolicyFromString (const std::string &selectionExportPolicyStr, SelectionExportPolicy *selectionExportPolicy)
 Returns the export policy from the string. More...
 

Public Attributes

const std::string name
 The name of the variantSet. More...
 
const SelectionExportPolicy selectionExportPolicy
 Specifies how to export a variant selection. More...
 

Detailed Description

Class that holds information about variantSets that are registered with the pipeline.

Registered variantSets are known variantSets in a pipeline that may need to be reasoned about by apps during import/export.

See Also
UsdUtilsGetRegisteredVariantSets

Definition at line 45 of file registeredVariantSet.h.

Member Enumeration Documentation

enum UsdUtilsRegisteredVariantSet::SelectionExportPolicy
strong

This specifies how the variantSet should be treated during export.

Note, in the plugInfo.json, the values for these enum's are lowerCamelCase.

Enumerator
Never 

Never "never" 

    This variantSet selection is meant to remain entirely within an
    application.  This typically represents a "session" variantSelection
    that should not be transmitted down the pipeline.
IfAuthored 

IfAuthored "ifAuthored" 

    This variantSet selection should be exported if there is an authored
    opinion in the application.  This is only relevant if the
    application is able to distinguish between "default" and "set"
    opinions.
Always 

Authored "authored" 

    This variantSet selection should always be exported.

Definition at line 55 of file registeredVariantSet.h.

Constructor & Destructor Documentation

UsdUtilsRegisteredVariantSet::UsdUtilsRegisteredVariantSet ( const std::string &  name,
const SelectionExportPolicy &  selectionExportPolicy 
)
inline

Definition at line 85 of file registeredVariantSet.h.

Member Function Documentation

static bool UsdUtilsRegisteredVariantSet::GetSelectionExportPolicyFromString ( const std::string &  selectionExportPolicyStr,
SelectionExportPolicy *  selectionExportPolicy 
)
static

Returns the export policy from the string.

bool UsdUtilsRegisteredVariantSet::operator< ( const UsdUtilsRegisteredVariantSet &  other) const
inline

Definition at line 94 of file registeredVariantSet.h.

Member Data Documentation

const std::string UsdUtilsRegisteredVariantSet::name

The name of the variantSet.

Definition at line 49 of file registeredVariantSet.h.

const SelectionExportPolicy UsdUtilsRegisteredVariantSet::selectionExportPolicy

Specifies how to export a variant selection.

Definition at line 83 of file registeredVariantSet.h.

The documentation for this class was generated from the following file: