Module vrVariants
[frames] | no frames]

Module vrVariants

Contains functions to capture and activate variant sets.

Functions
 
selectVariantSet(name)
Activates a variant set.
 
selectVariantSet(name, excludeViewpoint)
Activates a variant set.
 
activateCapturedVariantSet(name)
Activates a captured variant set.
 
createAndCaptureVariantSet(variantName, groupName)
Captures variants to variant set.
Function Details

selectVariantSet(name)

 

Activates a variant set. The variant set will activate all states of its defined node and material variants.

Parameters:
  • name (string) - The name of the variant set.

selectVariantSet(name, excludeViewpoint)

 

Activates a variant set. The variant set will activate all states of its defined node and material variants.

Parameters:
  • name (string) - The name of the variant set.
  • excludeViewpoint (bool) - exclude viewpoint from this variant set.

activateCapturedVariantSet(name)

 

Activates a captured variant set. The variant set will activate all states of its defined node and material variants.

Parameters:
  • name (string) - The name of the captured variant set.

createAndCaptureVariantSet(variantName, groupName)

 

Captures variants to variant set.

Parameters:
  • variantName (string) - The name of the variant set.
  • groupName (string) - Name of the variant set group.