Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

performanceOptions([clusterResolution=float], [disableStitch=string], [disableTrimBoundaryDisplay=string], [disableTrimDisplay=string], [latticeResolution=float], [passThroughBindSkinAndFlexors=string], [passThroughBlendShape=string], [passThroughCluster=string], [passThroughDeltaMush=string], [passThroughFlexors=string], [passThroughLattice=string], [passThroughMeshBoolean=string], [passThroughPaintEffects=string], [passThroughSculpt=string], [passThroughWire=string], [regionOfEffect=string], [skipHierarchyTraversal=boolean], [useClusterResolution=string], [useLatticeResolution=string])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

performanceOptions is undoable, queryable, and NOT editable.

Sets the global performance options for the application. The options allow the disabling of features such as stitch surfaces or deformers to cut down on computation time in the scene.

Performance options that are in effect may be on all the time, or they can be turned on only for interaction. In the latter case, the options will only take effect during UI interaction or playback.

Note that none of these performance options will affect rendering.

Return value

stringOne of "on", "off", or "interactive" giving the state of the option
floatGlobal resolution value

In query mode, return type is based on queried flag.

Flags

clusterResolution, disableStitch, disableTrimBoundaryDisplay, disableTrimDisplay, latticeResolution, passThroughBindSkinAndFlexors, passThroughBlendShape, passThroughCluster, passThroughDeltaMush, passThroughFlexors, passThroughLattice, passThroughMeshBoolean, passThroughPaintEffects, passThroughSculpt, passThroughWire, regionOfEffect, skipHierarchyTraversal, useClusterResolution, useLatticeResolution
Long name (short name) Argument types Properties
clusterResolution(cr) float query
Sets the global cluster resolution. This value may range between 0.0 (exact calculation) and 10.0 (rough approximation)
disableStitch(ds) string query
Sets the state of stitch surface disablement. Setting this to "on" suppresses the generation of stitch surfaces. Valid values are "on", "off", "interactive".
disableTrimBoundaryDisplay(dtb) string query
Sets the state of trim boundary drawing disablement. Setting this to "on" suppresses the drawing of surface trim boundaries. Valid values are "on", "off", "interactive".
disableTrimDisplay(dt) string query
Sets the state of trim drawing disablement. Setting this to "on" suppresses the drawing of surface trims. Valid values are "on", "off", "interactive".
latticeResolution(lr) float query
Sets the global lattice resolution. This value may range between 0.0 (exact calculation) and 1.0 (rough approximation)
passThroughBindSkinAndFlexors(pbf) string query
Sets the state of bind skin and all flexors pass through. Valid values are "on", "off", "interactive".
passThroughBlendShape(pbs) string query
Sets the state of blend shape deformer pass through. Valid values are "on", "off", "interactive".
passThroughCluster(pc) string query
Sets the state of cluster deformer pass through. Valid values are "on", "off", "interactive".
passThroughDeltaMush(pdm) string query
Sets the state of delta mush deformer pass through. Valid values are "on", "off", "interactive".
passThroughFlexors(pf) string query
Sets the state of flexor pass through. Valid values are "on", "off", "interactive".
passThroughLattice(pl) string query
Sets the state of lattice deformer pass through. Valid values are "on", "off", "interactive".
passThroughMeshBoolean(pmb) string query
Sets the state of mesh booleans pass through. Valid values are "on", "off", "interactive".
passThroughPaintEffects(pp) string query
Sets the state of paint effects pass through. Valid values are "on", "off", "interactive".
passThroughSculpt(ps) string query
Sets the state of sculpt deformer pass through. Valid values are "on", "off", "interactive".
passThroughWire(pw) string query
Sets the state of wire deformer pass through. Valid values are "on", "off", "interactive".
regionOfEffect(roe) string query
When enabled, an interactive update of translation commands will attempt to determine which components are being changed and only update effected components as a performance optimization while dragging a manip.
skipHierarchyTraversal(sht) boolean query
When enabled, hierarchy traversal of invisible objects in the scene will be disabled in order to increase performance however this has a side effect of performing redundant viewport refreshes on certain actions such as manipulations, start/end of playback, idle refresh calls, etc.
useClusterResolution(ucr) string query
Sets the state of cluster deformer global resolution. This allows clusters to be calculated at a lower resolution. Valid values are "on", "off", "interactive".
useLatticeResolution(ulr) string query
Sets the state of lattice deformer global resolution. This allows lattices to be calculated at a lower resolution. Valid values are "on", "off", "interactive".
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# Disable the generation of stitch surfaces
cmds.performanceOptions( ds=1 )

# Put sculpt deformers into pass-through mode during interaction/playback
cmds.performanceOptions( ps='interactive' )