UsdUtilsRegisteredVariantSet Class Reference

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

Public Types
enum	SelectionExportPolicy { Never, IfAuthored, Always }
	This specifies how the variantSet should be treated during export. More...

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

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 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. 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. 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. This variantSet selection should always be exported.

Definition at line 55 of file registeredVariantSet.h.

Member Data Documentation

const std::string name

The name of the variantSet.

Definition at line 49 of file registeredVariantSet.h.

const SelectionExportPolicy selectionExportPolicy

Specifies how to export a variant selection.

Definition at line 78 of file registeredVariantSet.h.

---

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

• pxr/usd/usdUtils/registeredVariantSet.h