modelEditor

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

Synopsis

modelEditor [-activeComponentsXray boolean] [-activeOnly boolean] [-activeView] [-addObjects string] [-addSelected] [-allObjects boolean] [-backfaceCulling boolean] [-bufferMode string] [-bumpResolution uint uint] [-camera string] [-cameraName string] [-cameraSetup] [-cameras boolean] [-colorMap] [-colorResolution uint uint] [-control] [-controlVertices boolean] [-cullingOverride string] [-default] [-defineTemplate string] [-deformers boolean] [-dimensions boolean] [-displayAppearance string] [-displayLights string] [-displayTextures boolean] [-docTag string] [-dynamicConstraints boolean] [-dynamics boolean] [-editorChanged script] [-exists] [-filter string] [-filteredObjectList] [-fluids boolean] [-fogColor float float float float] [-fogDensity float] [-fogEnd float] [-fogMode string] [-fogSource string] [-fogStart float] [-fogging boolean] [-follicles boolean] [-forceMainConnection string] [-grid boolean] [-hairSystems boolean] [-handles boolean] [-headsUpDisplay boolean] [-highlightConnection string] [-hulls boolean] [-ignorePanZoom boolean] [-ikHandles boolean] [-imagePlane boolean] [-interactive] [-isFiltered] [-jointXray boolean] [-joints boolean] [-lights boolean] [-lineWidth float] [-locators boolean] [-lockMainConnection] [-lowQualityLighting boolean] [-mainListConnection string] [-manipulators boolean] [-maxConstantTransparency float] [-modelPanel string] [-nCloths boolean] [-nParticles boolean] [-nRigids boolean] [-noUndo boolean] [-nurbsCurves boolean] [-nurbsSurfaces boolean] [-objectFilter script] [-objectFilterList script] [-objectFilterListUI script] [-objectFilterShowInHUD boolean] [-objectFilterUI script] [-occlusionCulling boolean] [-panel string] [-parent string] [-pivots boolean] [-planes boolean] [-pluginObjects string boolean] [-polymeshes boolean] [-queryPluginObjects string] [-removeSelected] [-rendererList] [-rendererListUI] [-rendererName string] [-rendererOverrideList] [-rendererOverrideListUI] [-rendererOverrideName string] [-selectionConnection string] [-selectionHiliteDisplay boolean] [-setSelected] [-shadows boolean] [-smoothWireframe boolean] [-sortTransparent boolean] [-stateString] [-strokes boolean] [-subdivSurfaces boolean] [-textureAnisotropic boolean] [-textureDisplay string] [-textureHilight boolean] [-textureMaxSize int] [-textureMemoryUsed] [-textureSampling int] [-textures boolean] [-transpInShadows boolean] [-transparencyAlgorithm string] [-twoSidedLighting boolean] [-unParent] [-unlockMainConnection] [-updateColorMode] [-updateMainConnection] [-useBaseRenderer boolean] [-useColorIndex boolean] [-useDefaultMaterial boolean] [-useInteractiveMode boolean] [-useRGBImagePlane boolean] [-useTemplate string] [-userNode string] [-viewObjects] [-viewSelected boolean] [-viewType] [-wireframeBackingStore boolean] [-wireframeOnShaded boolean] [-xray boolean] [editorName]

modelEditor is undoable, queryable, and editable.

Return value

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

Flags

Long name (short name)	Argument types	Properties
-exists(-ex)
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
-defineTemplate(-dt)	string
Puts a command in a mode where any other flags and args are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
-useTemplate(-ut)	string
Force the command to use a command template other than the current one.
-panel(-pnl)	string
Specifies the panel that the editor belongs to. By default if an editor is created in the create callback of a scripted panel it will belong to that panel. If an editor doesn't belong to a panel it will be deleted when the window that it is in is deleted.
-parent(-p)	string
Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
-unParent(-up)
Specifies that the editor should be removed from its layout. This cannot be used with query.
-control(-ctl)
Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus. Caution: It is possible, at times, for an editor to exist without a control. This flag returns "NONE" if no control is present.
-mainListConnection(-mlc)	string
Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will only display items contained in the selectionConnection object.
-forceMainConnection(-fmc)	string
Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
-selectionConnection(-slc)	string
Specifies the name of a selectionConnection object which the editor will synchronize with its own selection list. As the user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes changes, the editor updates to show the change.
-highlightConnection(-hlc)	string
Specifies the name of a selectionConnection object which the editor will synchronize with its highlight list. Not all editors have a highlight list. For those that do, it is a secondary selection list.
-filter(-f)	string
Specifies the name of an itemFilter object to be placed on this editor. This filters the information coming onto the main list of the editor.
-lockMainConnection(-lck)
Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor. Further changes to the original mainConnection are ignored.
-stateString(-sts)
Query only flag. Returns the MEL command that will edit an editor to match the current editor state. The returned command string uses the string variable $editorName in place of a specific name.
-unlockMainConnection(-ulk)
Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.
-updateMainConnection(-upd)
Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
-docTag(-dtg)	string
Attaches a tag to the Maya editor.
-camera(-cam)	string
Change or query the name of the camera in model editor.
-cameraName(-cn)	string
Set the name of the panel's camera transform and shape. The shape name is computed by appending the string "Shape" to the transform name. This flag may not be queried.
-displayLights(-dl)	string
Sets the lighting for shaded mode. Possible values are "selected", "active", "all", "default", "none".
-bufferMode(-bm)	string
Sets the graphic buffer mode. Possible values are "single" or "double".
-activeOnly(-ao)	boolean
Sets whether only active objects should appear shaded in shaded display.
-interactive(-i)
Causes this command to modify the interactive refresh settings of the view. In this way it is possible to change the behavior of the model editor during playback for improved performance.
-default(-d)
Causes this command to modify the default value of this setting. Newly created model editors will inherit the values. This flag may be used with the -interactive to set default interactive settings.
-ignorePanZoom(-ipz)	boolean
Sets whether the model panel will ignore the 2D pan/zoom value to give an overview of the scene.
-twoSidedLighting(-tsl)	boolean
Turns on or off two sided lighting. This may be used with the -default flag.
-displayAppearance(-da)	string
Sets the display appearance of the model panel. Possible values are "wireframe", "points", "boundingBox", "smoothShaded", "flatShaded". This flag may be used with the -interactive and -default flags. Note that only "wireframe", "points", and "boundingBox" are valid for the interactive mode.
-wireframeOnShaded(-wos)	boolean
Sets whether the model panel will draw the wireframe on all shaded objects (if true) or only for active objects (if false).
-headsUpDisplay(-hud)	boolean
Sets whether the model panel will draw any enabled heads up display elements in this window (if true). Currently this requires the HUD elements to be globally enabled.
-selectionHiliteDisplay( -sel)	boolean
Sets whether the model panel will draw any selection hiliting on the objects in this window.
-useDefaultMaterial(-udm)	boolean
Sets whether the model panel will draw all the shaded surfaces using the default material as opposed to using the material(s) currently assigned to the surfaces.
-useColorIndex(-uci)	boolean
Sets whether the model panel will attempt to use color index mode when possible. Color index mode can provide a performance increase for point, bounding box, and wireframe display modes. This may be used with the -default flag.
-userNode(-un)	string
Allows the user to associate a node name with the modelEditor. The value is automatically updated in the event the node is deleted or renamed.
-wireframeBackingStore(-wbs)	boolean
Sets whether a backing store is used to optimization the drawing of active objects. This mode can provide a performance increase in wireframe mode for certain scenes.
-useRGBImagePlane(-ip)	boolean
Sets whether the model panel will be forced into RGB mode when there is an image plane attached to the panel's camera.
-imagePlane(-imp)	boolean
Turn on/off the display of image plane for the view
-updateColorMode(-ucm)
Using this flag tells the model panel to check which color mode it should be in, and to switch accordingly. This flag may be used to update a model panel after a camera image plane has been added or removed.
-colorMap(-cm)
Queries the color map style for the model panel. Possible values are "colorIndex" and "rgb".
-backfaceCulling(-bfc)	boolean
Turns on or off backface culling for the whole view. This setting overrides the culling settings of individual objects. All objects draw in the view will be backface culled. When backface culling is turned on, surfaces becomes invisible in areas where the normal is pointing away from the camera.
-xray(-xr)	boolean
Turns on or off Xray mode. This may be used with the -default flag.
-jointXray(-jx)	boolean
Turns on or off Xray mode for joints.
-activeComponentsXray(-acx)	boolean
Turns on or off Xray mode for active components.
-maxConstantTransparency( -mct)	float
Sets the maximum constant transparency. Setting this value remaps constant transparency values from the range [0.0, 1.0] to the range [0.0, maxConstantTransparency]. All transparency values are shifted linearly to the new range, so a fully transparency object (transparency 1.0) would appear with a transparency of maxConstantTransparency in the viewport, allowing highly transparent objects to be made visible. This flag only affects constant (non-textured) transparent objects.
-displayTextures(-dtx)	boolean
Turns on or off display of textures in shaded mode
-smoothWireframe(-swf)	boolean
Turns on or off smoothing of wireframe lines and points
-lineWidth(-lw)	float
Set width of lines for display
-textureMaxSize(-tms)	int
Set maximum texture size for hardware texturing. The integer value must be a power of 2. Recommended values are 128 or 256. If the value specified is larger than the OpenGL maximim textures size for the graphics hardware it will be clamped to the OpenGL size. If many large textures are used in a scene reducing this value improves performance. On Impact texture memory is pinned in RAM so using large textures can cause reliability and performance problems. Again reducing this value will help. Software rendering does not use this value. This flag is obsolete as of Maya 6.5. The maxTextureResolution/mtr argument on the displayPref command should be used instead.
-textureMemoryUsed(-tmu)
Returns the total number of bytes used by all texture maps. This is typicly width*height*channels for all texture objects in the scene If the texture is mip mapped all mip map levels are included in the total though not never more than two level will be in use at one time
-textureAnisotropic(-ta)	boolean
Set whether to perform anisotropic texture filtering. Will work only if the anisotropic texture filtering extension is supported in OpenGL on the graphics system.
-textureSampling(-ts)	int
Set the type of sampling to be used for texture display. The argument can be either: 1 : means to perform point sample 2 : means to perform bilinear interpolation (default)
-textureDisplay(-td)	string
Set the type of blending to use for textures. The blend is performed between the destination fragment and the texture fragment. The source is usually the material color. Argument options are: "modulate" : multiply the destination and texture fragment "decal" : overwrite the destination with the texture fragment
-textureHilight(-th)	boolean
Set whether to show specular hilighting when the display is in shaded textured mode.
-fogging(-fg)	boolean
Set whether hardware fogging is enabled or not.
-fogSource(-fsc)	string
Set the type of fog algorithm to use. If the argument is "fragment" (default) then fog is computed per pixel. If the argument is "coordinate" then if the geometry has specified vertex fog coordinates, and the OpenGL extension for vertex fog is supported by the graphics system, then fog is computed per vertex.
-fogMode(-fmd)	string
This determines the drop-off mode for fog. The possibilities are: "linear" : linear drop-off "exponent" : exponential drop-off "exponent2" : squared exponential drop-off
-fogDensity(-fdn)	float
Determines the density of hardware fogging.
-fogEnd(-fen)	float
The end location of hardware fogging.
-fogStart(-fst)	float
The start location of hardware fogging.
-fogColor(-fcl)	float float float float
The color used for hardware fogging.
-shadows(-sdw)	boolean
Turn on/off the display of hardware shadows in shaded mode.
-rendererName(-rnm)	string
Set or get the renderer used for a 3d modeling viewport. The name provided should an internal name of a renderer. The 'rendererList' flag can be used to query for a list of available names. The default renderers available are : "base_OpenGL_Renderer" : The default OpenGL based renderer, and "hwRender_OpenGL_Renderer" : The high quality hardware renderer. The default renderer is "base_OpenGL_Renderer". The high quality renderer is only supported on certain hardware configurations. See the hardware qualification charts for more details.
-rendererList(-rls)
Query for a list of the internal names for renderers available for use with the 3d modeling viewport. The default list contains at least "base_OpenGL_Renderer", and "hwRender_OpenGL_Renderer", if supported. See rendererName for more details on these renderers. Any plugin viewport renderers will also appear in this list.
-rendererListUI(-rlu)
Query for a list of the UI names for renderers available for use with the 3d modeling viewport. The default list consists of the UI name for "base_OpenGL_Renderer", and the UI name for "hwRender_OpenGL_Renderer", if it is supported. Any plugin viewport renderer's UI names will also appear in this list. This list and the list returned from rendererList have a 1:1 correspondance.
-rendererOverrideName(-rom)	string
Set or get the override used for a 3d viewport renderer. The name provided should be the internal name for an override. The 'rendererOverrideList' flag can be used to query for a list of available names. Currently only the "Viewport 2" renderer supports renderer overrides. Setting an empty string will unset any currently active override.
-rendererOverrideList(-rol)
Query for a list of the internal names for renderer overrides for a 3d viewport renderer. Currently only the "Viewport 2" renderer supports renderer overrides.
-rendererOverrideListUI( -rou)
Query for a list of the UI names for renderer overrides for a 3d viewport renderer. Currently only the "Viewport 2" renderer supports renderer overrides.
-colorResolution(-crz)	uint uint
Set the resolution for "baked" color textures when using the hardware renderer. The default value is 256, 256 respectively.
-bumpResolution(-brz)	uint uint
Set the resolution for "baked" bump map textures when using the hardware renderer. The default value is 512, 512 respectively.
-transparencyAlgorithm(-tal)	string
Set the transparency algorithm. The options are: 1) "frontAndBackCull" : Two pass front and back culling technique. 2) "perPolygonSort" : Draw transparent polygons in back-to-front order technique. transparency pptions 1) and 2) are supported by the hardware renderer. Options 1) is supported by the interactive modeling viewports. The default value is "frontAndBackCull".
-transpInShadows(-tis)	boolean
Set whether to enable display of transparency in shadows when using the hardware renderer. The default value is false.
-cullingOverride(-cov)	string
Set whether to override the culling attributes on objects when using the hardware renderer. The options are: "none" : Use the culling object attributes per object. "doubleSided" : Force all objects to be double sided. "singleSided": Force all objects to be single sided. The default value is "none".
-lowQualityLighting(-lql)	boolean
Set whether to use "low quality lighting" when using the hardware renderer. The default value is false.
-occlusionCulling(-ocl)	boolean
Set whether to enable occlusion culling testing when using the hardware renderer. The default value is false.
-useBaseRenderer(-ubr)	boolean
Set whether to use the "base" renderer when using the hardware renderer and in "interactive display mode" (-useInteractiveMode) The default value is false.
-nurbsCurves(-nc)	boolean
Turn on/off the display of nurbs curves for the view of the model editor.
-nurbsSurfaces(-ns)	boolean
Turn on/off the display of nurbs surfaces for the view of the model editor.
-polymeshes(-pm)	boolean
Turn on/off the display of polygon meshes for the view of the model editor.
-subdivSurfaces(-sds)	boolean
Turn on/off the display of subdivision surfaces for the view of the model editor.
-planes(-pl)	boolean
Turn on/off the display of sketch planes for the view of the model editor.
-lights(-lt)	boolean
Turn on/off the display of lights for the view of the model editor.
-cameras(-ca)	boolean
Turn on/off the display of cameras for the view of the model editor.
-controlVertices(-cv)	boolean
Turn on/off the display of NURBS CVs for the view of the model editor.
-grid(-gr)	boolean
Turn on/off the display of the grid for the view of the model editor.
-hulls(-hu)	boolean
Turn on/off the display of NURBS hulls for the view of the model editor.
-joints(-j)	boolean
Turn on/off the display of joints for the view of the model editor.
-ikHandles(-ikh)	boolean
Turn on/off the display of ik handles and end effectors for the view of the model editor.
-deformers(-df)	boolean
Turn on/off the display of deformer objects for the view of the model editor.
-dynamics(-dy)	boolean
Turn on/off the display of dynamics objects for the view of the model editor.
-fluids(-fl)	boolean
Turn on/off the display of fluids for the view of the model editor.
-hairSystems(-hs)	boolean
Turn on/off the display of hairSystems for the view of the model editor.
-follicles(-fo)	boolean
Turn on/off the display of follicles for the view of the model editor.
-nCloths(-ncl)	boolean
Turn on/off the display of nCloths for the view of the model editor.
-nParticles(-npa)	boolean
Turn on/off the display of nParticles for the view of the model editor.
-nRigids(-nr)	boolean
Turn on/off the display of nRigids for the view of the model editor.
-dynamicConstraints(-dc)	boolean
Turn on/off the display of dynamicConstraints for the view of the model editor.
-locators(-lc)	boolean
Turn on/off the display of locator objects for the view of the model editor.
-manipulators(-m)	boolean
Turn on/off the display of manipulator objects for the view of the model editor.
-dimensions(-dim)	boolean
Turn on/off the display of dimension objects for the view of the model editor.
-handles(-ha)	boolean
Turn on/off the display of select handles for the view of the model editor.
-pivots(-pv)	boolean
Turn on/off the display of transform pivots for the view of the model editor.
-textures(-tx)	boolean
Turn on/off the display of texture objects for the view
-strokes(-str)	boolean
Turn on/off the display of Paint Effects strokes for the view
-pluginObjects(-po)	string boolean
Turn on/off the display of plugin objects for the view. It depends on the plugin implementation whether to respect this flag.
-queryPluginObjects(-qpo)	string
Query the on/off state of plugin objects display for the view. To set the on/off state, use -pluginObjects instead.
-allObjects(-alo)	boolean
Turn on/off the display of all objects for the view of the model editor. This excludes NURBS, CVs, hulls, grids and manipulators.
-useInteractiveMode(-ui)	boolean
Turns on or off the use of the special interaction settings during playback. This flag may be used with the -default flag.
-activeView(-av)
Sets this model editor to be the active view. Returns true if successful. On query this flag will return whether the view is the active view.
-sortTransparent(-st)	boolean
This flag turns on/off sorting of transparent objects during shaded mode refresh. Normally, objects are sorted according to their origin in camera space but when this flag is turned off they will be drawn according to their (depth-first traversal) order in the scene graph. This is a global flag that affects all model editors.
-viewSelected(-vs)	boolean
This flag turns on/off viewing of selected objects. When the flag is set to true, the currently active objects are captured and used as the list of objects to view.
-setSelected(-ss)
This flag causes the currently active objects to be the only objects visible in the view (if viewSelected is true).
-addSelected(-as)
This flag causes the currently active objects to be added to the list of objects visible in the view (if viewSelected is true).
-removeSelected(-rs)
This flag causes the currently active objects to be removed from the list of objects visible in the view (if viewSelected is true).
-addObjects(-aob)	string
This flag causes the objects contained within the selection connection to be added to the list of objects visible in the view (if viewSelected is true).
-viewObjects(-vo)
Returns the name (if any) of the objectSet which contains the list of objects visible in the view if viewSelected is true and the list of objects being displayed does not come from the active list.
-noUndo(-nud)	boolean
This flag prevents some viewport operations (such as isolate select) from being added to the undo queue.
-cameraSetup(-cs)
Based on the model editor name passed in will returns a string list containing camera setups. A camera setup can contain one or more cameras which are associated with each other. Camera setups are defined as pairs of consecutive strings in the list. Each pair is comprised of: a string which identifies an active camera, and a string which defines a script to set up a given active camera. As many pairs of strings can be returned as the number of active cameras. If nothing is returned then it is assumed that no set up is required to activate a given camera.
-editorChanged(-ec)	script
An optional script callback which is called when the editors options have changed. This is useful in a situation where a scripted panel contains a modelEditor and wants to be notified when the contained editor changes its options.
-objectFilter(-obf)	script
Set or query the current object filter name. An object filter is required to have already been registered.
-objectFilterUI(-obu)	script
Query the current object filter UI name. The object filter is required to have already been registered.
-objectFilterList(-ofl)	script
Return a list of names of registered filters.
-objectFilterListUI(-ofu)	script
Return a list of UI names of registered filters.
-objectFilterShowInHUD(-ofs)	boolean
Sets whether or not to display the object filter UI name in the heads up display when an object filter is active. This string is concatenated with the camera name.
-isFiltered(-if)
Returns true for model editors with filtering applied to their view of the scene. This could either be an explicit object filter, or a display option such as isolate select which filters the objects that are displayed.
-filteredObjectList(-fol)
For model editors with filtering on (either using an object filter, or isolate select), this flag returns a string list of the objects which are displayed in this editor. Note that this list does not take into account visibility (based on camera frustum or flags), it purely captures the objects which are considered when rendering the view.
-modelPanel(-mp)	string
Allows the created model editor to be embedded in the named model panel. Intended for use with custom model editors created via the API (i.e. the flag would be used on the derived MPxModelEditorCommand), though the flag may also be used on the base modelEditor command to restore a default Maya model editor to the panel. Note that the model editor previously owned by the panel is deleted.
-viewType(-vt)
Returns a string indicating the type of the model editor. For the default model editor, returns the empty string. For custom model editor types created via the API, returns the same string as is returned via the method MPx3dModelView::viewType().

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.

MEL examples

//    Create a window with a model editor and some buttons that
//    change the editor's display of objects in the scene.
//
string $window = `window`;
string $form = `formLayout`;
string $editor = `modelEditor`;
string $column = `columnLayout -adjustableColumn true`;
//    Create some buttons that will alter the display appearance of
//    objects in the model editor, eg. wireframe vs. shaded mode.
//
button -label "Wireframe"
    -command ("modelEditor -edit -displayAppearance wireframe " + $editor);
button -label "Points"
    -command ("modelEditor -edit -displayAppearance points " + $editor);
button -label "Bounding Box"
    -command ("modelEditor -edit -displayAppearance boundingBox " + $editor);
button -label "Smooth Shaded"
    -command ("modelEditor -edit -displayAppearance smoothShaded " + $editor);
button -label "Flat Shaded"
    -command ("modelEditor -edit -displayAppearance flatShaded " + $editor);
//    Set up the window layout attachments.
//
formLayout -edit
    -attachForm    $column "top"    0
    -attachForm    $column "left"   0
    -attachNone    $column "bottom"
    -attachNone    $column "right"
    -attachForm    $editor "top"    0
    -attachControl $editor "left"   0 $column
    -attachForm    $editor "bottom" 0
    -attachForm    $editor "right"  0
    $form;
//    Create a camera for the editor.  This particular camera will
//    have a close up perspective view of the centre of the ground plane.
//
string $camera[] = `camera -centerOfInterest 2.450351
    -position 1.535314 1.135712 1.535314
    -rotation -27.612504 45 0
    -worldUp -0.1290301 0.3488592 -0.1290301`;
//    Attach the camera to the model editor.
//
modelEditor -edit -camera $camera[0] $editor;
//    Put an object in the scene.
//
cone;
showWindow $window;
//    The following two examples assume a custom model editor command
//    defined via the MPxModelEditorCommand API class, named 'myEditor'.
//
//    Create a custom editor, and use it as the model editor of Maya's
//    default modelPanel4 (the perspective view).
//
myEditor -modelPanel modelPanel4;
//    Restore the default model editor.
//
modelEditor -modelPanel modelPanel4;
//
//              The following example shows usage of the render override flags
//              with model panel 'modelPanel4'
//
modelEditor -q -rol modelPanel4;        // Query for non-UI names for any render overrides
modelEditor -q -rou modelPanel4;        // Query for UI names for any render overrides
modelEditor -q -rom modelPanel4;        // Query for any active override
modelEditor -e -rom "myOverride" modelPanel4; // Set active override to 'myOverride' if it exists
modelEditor -e -rom "" modelPanel4;   // Clear out the active override