Class UsdVariantSet

Represents one or more USD variant sets. This object holds slection state and exposes access to the current selection as well as an API to apply selection changes (used by the editor).

Inheritance

Object

Component

Behaviour

MonoBehaviour

UsdVariantSet

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(String, Single)

MonoBehaviour.InvokeRepeating(String, Single, Single)

MonoBehaviour.CancelInvoke(String)

MonoBehaviour.IsInvoking(String)

MonoBehaviour.StartCoroutine(String)

MonoBehaviour.StartCoroutine(String, Object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(String)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(Object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, Component)

Component.TryGetComponent<T>(T)

Component.GetComponent(String)

Component.GetComponentInChildren(Type, Boolean)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(Boolean)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, Boolean)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(Boolean)

Component.GetComponentsInChildren<T>(Boolean, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, Boolean)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(Boolean)

Component.GetComponentsInParent<T>(Boolean, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(String)

Component.SendMessageUpwards(String, Object, SendMessageOptions)

Component.SendMessageUpwards(String, Object)

Component.SendMessageUpwards(String)

Component.SendMessageUpwards(String, SendMessageOptions)

Component.SendMessage(String, Object)

Component.SendMessage(String)

Component.SendMessage(String, Object, SendMessageOptions)

Component.SendMessage(String, SendMessageOptions)

Component.BroadcastMessage(String, Object, SendMessageOptions)

Component.BroadcastMessage(String, Object)

Component.BroadcastMessage(String)

Component.BroadcastMessage(String, SendMessageOptions)

Component.rigidbody2D

Component.camera

Component.light

Component.animation

Component.constantForce

Component.renderer

Component.audio

Component.networkView

Component.collider

Component.collider2D

Component.hingeJoint

Component.particleSystem

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(Object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, Boolean)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, Boolean)

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, Single)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.ToString()

Object.name

Object.hideFlags

Namespace: Unity.Formats.USD

Syntax

public class UsdVariantSet : MonoBehaviour

Remarks

Note that a singe asset can have multiple variant sets and each is independent. For example, the modelingVariant set may have two variants: CupWithHandle and CupWithoutHandle, while the shadingVariant set may have three variants: Red, Green, Blue. The full outer product of all variant selections is possible, e.g. Red, Green, or Blue CupWithHandle and Red, Green, or Blue CupWithoutHandle.

For more details on USD variant sets and selections, see: https://graphics.pixar.com/usd/docs/USD-Glossary.html#USDGlossary-VariantSet

Fields

m_primPath

Declaration

public string m_primPath

Field Value

Type	Description
String

m_selected

Declaration

public string[] m_selected

Field Value

Type	Description
String[]

m_variantCounts

Declaration

public int[] m_variantCounts

Field Value

Type	Description
Int32[]

m_variants

Declaration

public string[] m_variants

Field Value

Type	Description
String[]

m_variantSetNames

Declaration

public string[] m_variantSetNames

Field Value

Type	Description
String[]

Methods

ApplyVariantSelections()

Syncs the current Unity state to USD and reimports any affected GameObjects. Note that this may result in the objects being destroyed and recreated.

Declaration

public void ApplyVariantSelections()

GetVariantSelections()

Returns a collection of VariantSetName -> ActiveVariantSelectionName, which represents the active variant selection at the prim associated with this behaviour.

Declaration

public Dictionary<string, string> GetVariantSelections()

Returns

Type	Description
Dictionary<String, String>

Examples

If two sets with selections are modelingVariant=CupWithHandle and shadingVariant=BrightBlue, resulting in a bright blue cup with a handle. In this example, the selections dictionary would contain: { "modelingVariant" = "CupWithHandle", "shadingVariant" = "BrightBlue" }

LoadFromUsd(pxr.UsdPrim)

Loads the variant sets and selection state from USD into the UsdVariantSet behaviour.

Declaration

public void LoadFromUsd(pxr.UsdPrim prim)

Parameters

Type	Name	Description
pxr.UsdPrim	prim