Go to: Synopsis. Flags. Return value. Related. MEL examples.

Synopsis

toggle [-above] [-below] [-boundary] [-controlVertex] [-curveEndPoints] [-doNotWrite] [-editPoint] [-extent] [-facet] [-geometry] [-global] [-highPrecisionNurbs] [-hull] [-latticePoint] [-latticeShape] [-localAxis] [-newCurve] [-newPolymesh] [-newSurface] [-normal] [-origin] [-point] [-pointDisplay] [-pointFacet] [-rotatePivot] [-scalePivot] [-selectHandle] [-state boolean] [-surfaceFace] [-template] [-uvCoords] [-vertex] [objects]

toggle is undoable, queryable, and editable.

The toggle command is used to toggle the display of various object features for objects which have these components. For example, CV and edit point display may be toggled for those listed NURB curves or surfaces.

Note: This command is not undoable.

Flags

above, below, boundary, controlVertex, curveEndPoints, doNotWrite, editPoint, extent, facet, geometry, global, highPrecisionNurbs, hull, latticePoint, latticeShape, localAxis, newCurve, newPolymesh, newSurface, normal, origin, point, pointDisplay, pointFacet, rotatePivot, scalePivot, selectHandle, state, surfaceFace, template, uvCoords, vertex
Long name (short name) [argument types] Properties
-state(-st) boolean create
Explicitly set the state to true or false instead of toggling the state. Can not be queried.
-geometry(-g) createquery
Toggle geometry display of listed objects.

In query mode, this flag needs a value.
-controlVertex(-cv) createquery
Toggle CV display of listed curves and surfaces.

In query mode, this flag needs a value.
-editPoint(-ep) createquery
Toggle edit point display of listed curves and surfaces.

In query mode, this flag needs a value.
-hull(-hl) createquery
Toggle hull display of listed curves and surfaces.

In query mode, this flag needs a value.
-curveEndPoints(-cep) createquery
Toggle curve end point display of listed curves.

In query mode, this flag needs a value.
-origin(-o) createquery
Toggle origin display of listed surfaces.

In query mode, this flag needs a value.
-surfaceFace(-sf) createquery
Toggle surface face handle display of listed surfaces.

In query mode, this flag needs a value.
-pointDisplay(-pd) createquery
Toggle point display of listed surfaces.

In query mode, this flag needs a value.
-vertex(-vt) createquery
Toggle vertex display of listed mesh objects.

In query mode, this flag needs a value.
-latticePoint(-lp) createquery
Toggle point display of listed lattices

In query mode, this flag needs a value.
-latticeShape(-ls) createquery
Toggle display of listed lattices

In query mode, this flag needs a value.
-boundary(-bn) createquery
Toggle boundary display of listed mesh objects.

In query mode, this flag needs a value.
-normal(-nr) createquery
Toggle display of normals of listed surface and mesh objects.

In query mode, this flag needs a value.
-point(-pt) createquery
For use with normal flag. Set the normal display style to vertex display.

In query mode, this flag needs a value.
-facet(-f) createquery
For use with normal flag. Set the normal display style to facet display.

In query mode, this flag needs a value.
-pointFacet(-pf) createquery
For use with normal flag. Set the normal display style to vertex and face display.

In query mode, this flag needs a value.
-extent(-et) createquery
Toggle display of extents of listed mesh objects.

In query mode, this flag needs a value.
-uvCoords(-uv) createquery
Toggle display uv coords of listed mesh objects.

In query mode, this flag needs a value.
-selectHandle(-sh) createquery
Toggle select handle display of listed objects.

In query mode, this flag needs a value.
-rotatePivot(-rp) createquery
Toggle rotate pivot display of listed objects.

In query mode, this flag needs a value.
-scalePivot(-sp) createquery
Toggle scale pivot display of listed objects.

In query mode, this flag needs a value.
-localAxis(-la) createquery
Toggle local axis display of listed objects.

In query mode, this flag needs a value.
-global(-gl) create
Toggle state for all objects
-above(-a) create
Toggle state for all objects above listed objects.
-below(-b) create
Toggle state for all objects below listed objects.
-template(-te) createquery
Toggle template state of listed objects

In query mode, this flag needs a value.
-doNotWrite(-dnw) createquery
Toggle the "this should be written to the file" state.

In query mode, this flag needs a value.
-newCurve(-nc) createquery
Set component display state of new curve objects

In query mode, this flag needs a value.
-newSurface(-ns) createquery
Set component display state of new surface objects

In query mode, this flag needs a value.
-newPolymesh(-np) createquery
Set component display state of new polymesh objects

In query mode, this flag needs a value.
-highPrecisionNurbs(-hpn) createquery
Toggle high precision display for Nurbs

In query mode, this flag needs a value.
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 be used more than once in a command

Return value


boolean when in the query mode. none otherwise.

Related

currentUnit, displayAffected, displayColor, displayCull, displayLevelOfDetail, displayPref, displayRGBColor, displaySmoothness, displayStats, displaySurface, hide, refresh, showHidden

MEL examples

$surface1 = `sphere`;
toggle -cv $surface1;
toggle -g -cv;
toggle -q -cv;
    // Returns 0 if the queried state is false.
    // Returns 1 if the queried state is true.