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

Synopsis

boxZoomCtx( object , [exists=boolean], [history=boolean], [image1=string], [image2=string], [image3=string], [name=string], [zoomScale=float])

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

boxZoomCtx is undoable, queryable, and editable.

This command can be used to create, edit, or query a box zoom context. If this context is used on a perspective camera, the field of view and view direction are changed. If the camera is orthographic, the orthographic width and eye point are changed. The left and middle mouse interactively zoom the view. The control key can be used to enable box zoom. A box starting from left to right will zoom in, and a box starting from right to left will zoom out.

Return value

stringThe name of the context

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

Flags

exists, history, image1, image2, image3, name, zoomScale
Long name (short name) Argument types Properties
exists(ex) boolean create
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
history(ch) boolean create
If this is a tool command, turn the construction history on for the tool in question.
image1(i1) string createqueryedit
First of three possible icons representing the tool associated with the context.
image2(i2) string createqueryedit
Second of three possible icons representing the tool associated with the context.
image3(i3) string createqueryedit
Third of three possible icons representing the tool associated with the context.
name(n) string create
If this is a tool command, name the tool appropriately.
zoomScale(zs) float createqueryedit
Scale the zoom.

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

cmds.boxZoomCtx( 'boxZoomContext', zs=1.0 )