from typing import Union, List, Any, AnyStr, Callable
Script = Union[AnyStr, Callable[..., Any]]
def insertListItem(*args, **kwargs)->None:
"""
"""
pass
def RenderSequence(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CylindricalProjection(*args, **kwargs)->None:
"""
unknown
"""
pass
def SurfaceFlow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ClosestPointOn(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorRestoreLastClosedTab(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def lookThru(*args, farClip: float=0.0, nearClip: float=0.0, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command sets a particular camera to look through in a view This command may also be
used to view the negative z axis of lights or other DAG objects The standard camera tools
can then be used to place the object Note: if there are multiple objects under the
transform selected, cameras and lights take precedence
:param farClip: (C) Used when setting clip far plane for a new look thru camera Will not
affect the attributes of an existing camera Clip values must come before shape
:param nearClip: (C) Used when setting near clip plane for a new look thru camera Will not
affect the attributes of an existing camera Clip values must come before shap
:returns:
"""
pass
def pixelMove(*args, **kwargs)->None:
"""
The pixelMove command moves objects by what appears as pixel units based on the current
view It takes two integer arguments which specify the direction in screen space an object
should appear to move The vector between the center pixel of the view and the specified
offset is mapped to some world space vector which defines the relative amount to m
:returns:
"""
pass
def arnoldIpr(*args, **kwargs)->None:
"""
"""
pass
def UVEditorToggleTextureBorderDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeRefreshAllSwatchesOnDisk(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyExtrudeVertices(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeGraphRearrange(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BevelPolygon(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def IKHandleTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BakeSpringAnimationOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SubstituteGeometryOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def colorAtPoint(*args, coordU: Union[float, List[float]]=0.0, coordV: Union[float,
List[float]]=0.0, maxU: float=1.0, maxV: float=1.0, minU: float=0.0, minV:
float=0.0, output: AnyStr="", samplesU: int=1, samplesV: int=1,
**kwargs)->None:
"""
The colorAtPoint command is used to query textures or ocean shaders at passed in uv
coordinates (For ocean shaders uv is x and z in worldspace ) The return value is a
floating point array whose size is determined by either the number of input uv arguments
passed in and the the queried value One can query alpha only, rgb only, or rgba values
The
:param coordU: (C M) Input u coordinate to sample texture at
:param coordV: (C M) Input v coordinate to sample texture at
:param maxU: (C) DEFAULT 1.0 Maximum u bounds to sample
:param maxV: (C) DEFAULT 1.0 Maximum v bounds to sample
:param minU: (C) DEFAULT 0.0 Minimum u bounds to sample
:param minV: (C) DEFAULT 0.0 Minimum v bounds to sample
:param output: (C) Type of data to output: A = alpha only RGB = color only RGBA = color and
alpha
:param samplesU: (C) DEFAULT 1 The number of points to sample in the U dimension
:param samplesV: (C) DEFAULT 1 The number of points to sample in the V dimension
:returns:
"""
pass
def blendCtx(*args, **kwargs)->None:
"""
"""
pass
def clearCache(*args, allNodes: bool=True, computed: bool=True, dirty: bool=True,
**kwargs)->int:
"""
Even though dependency graph values are computed or dirty they may still occupy space
temporarily within the nodes This command goes in to all of the data that can be
regenerated if required and removes it from the caches (datablocks), thus clearing up space
in memory
:param allNodes: (C) If toggled then all nodes in the graph are cleared Otherwise only
those nodes that are selected are cleared
:param computed: (C) If toggled then remove all data that is computable (Warning: If the
data is requested for redraw then the recompute will immediately fill the data b
:param dirty: (C) If toggled then remove all heavy data that is dirty
:returns: Number of items removed from caches
"""
pass
def dR_viewLeft(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_IsSubstanceRelocalized(*args, **kwargs)->None:
"""
"""
pass
def textureDeformer(*args, after: bool=True, afterReference: bool=True, before: bool=True,
deformerTools: bool=True, direction: AnyStr="", envelope: float=0.0,
exclusive: Union[AnyStr, bool]="", frontOfChain: bool=True, geometry:
Union[AnyStr, List[AnyStr], bool]="", geometryIndices: bool=True,
ignoreSelected: bool=True, includeHiddenSelections: bool=False, name:
AnyStr="", offset: float=0.0, parallel: bool=True, pointSpace: AnyStr="",
prune: bool=True, remove: Union[bool, List[bool]]=True, split: bool=True,
strength: float=0.0, vectorOffset: List[float, float, float]=None,
vectorSpace: AnyStr="", vectorStrength: List[float, float, float]=None,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a texture deformer for the object The selected objects are the input
geometry objects The deformer node name will be returned
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param direction: (C) Set the deformation direction of texture deformer It can only handle
three types: "Normal", "Handle" and "Vector" "Normal" each vertices use its own
:param envelope: (C) Set the envelope of texture deformer Envelope determines the percent
of deformation The final result is (color * normal * strength + offset) * enve
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param name: (C) Used to specify the name of the node being created
:param offset: (C) Set the offset of texture deformer Offset plus a translation on the
final deformed vertices
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param pointSpace: (C) Set the point space of texture deformer It can only handle three
strings: "World", "Local" and "UV" "World" map world space to color space "Local"
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:param strength: (C) Set the strength of texture deformer Strength determines how strong
the object is deformed
:param vectorOffset: (C) Set the vector offset of texture deformer Vector offset indicates
the offset of the deformation on the vector mode
:param vectorSpace: (C) Set the vector space of texture deformer It can only handle three
strings: "Object", "World" and "Tangent" "Object" use color vector in object spac
:param vectorStrength: (C) Set the vector strength of texture deformer Vector strength
determines how strong the object is deformed on the vector mode
:returns: Texture deformer node name
"""
pass
def CreateHairOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SwapBlendShapeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgCreateIgSplineEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyDelVertex(*args, caching: bool=True, constructionHistory: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Deletes vertices Joins two edges which have a common vertex The vertices must be
connected to exactly two edges (so-called "winged")
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def NodeEditorDeleteNodes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def subdEditUV(*args, angle: Union[float, bool]=0.0, pivotU: Union[float, bool]=0.0, pivotV:
Union[float, bool]=0.0, relative: bool=True, rotateRatio: Union[float, bool]=1.0,
rotation: bool=True, scale: bool=True, scaleU: Union[float, bool]=0.0, scaleV:
Union[float, bool]=0.0, uValue: Union[float, bool]=0.0, uvSetName: Union[AnyStr,
bool]="", vValue: Union[float, bool]=0.0, q=True, query=True,
**kwargs)->Union[bool, Any]:
"""
Command edits uvs on subdivision surfaces When used with the query flag, it returns the uv
values associated with the specified components
:param angle: (C Q) Specifies the angle value (in degrees) that the uv values are to be
rotated by
:param pivotU: (C Q) Specifies the pivot value, in the u direction, about which the scale
or rotate is to be performed
:param pivotV: (C Q) Specifies the pivot value, in the v direction, about which the scale
or rotate is to be performed
:param relative: (C Q) Specifies whether this command is editing the values relative to the
currently existing values Default is true;
:param rotateRatio: (C Q) Specifies the ratio value that the uv values are to be rotated by
Default is 1.0
:param rotation: (C Q) Specifies whether this command is editing the values with rotation
values
:param scale: (C Q) Specifies whether this command is editing the values with scale values
:param scaleU: (C Q) Specifies the scale value in the u direction
:param scaleV: (C Q) Specifies the scale value in the v direction
:param uValue: (C Q) Specifies the value, in the u direction - absolute if relative flag is
false.
:param uvSetName: (C Q) Specifies the name of the uv set to edit uvs on If not specified
will use the current uv set if it exists
:param vValue: (C Q) Specifies the value, in the v direction - absolute if relative flag is
false.
:returns: Success or Failure.
"""
pass
def OutlinerToggleTimeEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def timerX(*args, startTime: float=0.0, **kwargs)->float:
"""
Used to calculate elapsed time This command returns sub-second accurate time values It is
useful from scripts for timing the length of operations Call this command before and after
the operation you wish to time On the first call, do not use any flags It will return the
start time Save this value After the operation, call this command a seco
:param startTime: (C) When this flag is used, the command returns the elapsed time since
the specified start time
:returns: This command returns a different value depending on
the flag used. If no flag is
used, then the start time
is returned. If the "-st" flag is used, then it returns
the
elapsed time since the start time.
"""
pass
def pointLight(*args, decayRate: Union[int, bool]=0, discRadius: Union[float, bool]=0.0,
exclusive: bool=True, intensity: Union[float, bool]=0.0, name: Union[AnyStr,
bool]="", position: Union[List[float, float, float], bool]=None, rgb:
Union[List[float, float, float], bool]=None, rotation: Union[List[float, float,
float], bool]=None, shadowColor: Union[List[float, float, float], bool]=None,
shadowDither: Union[float, bool]=0.0, shadowSamples: Union[int, bool]=0,
softShadow: bool=True, useRayTraceShadows: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The pointLight command is used to edit the parameters of existing pointLights, or to create
new ones The default behaviour is to create a new pointlight
:param decayRate: (C Q E) decay rate of the light (0-no decay, 1-slow, 2-realistic,
3-fast)
:param discRadius: (C Q E) radius of the disc around the light
:param exclusive: (C Q E) This flag is obsolete
:param intensity: (C Q E) intensity of the light (expressed as a percentage)
:param name: (C Q E) specify the name of the light
:param position: (C Q E) This flag is obsolete
:param rgb: (C Q E) color of the light (0-1)
:param rotation: (C Q E) This flag is obsolete
:param shadowColor: (C Q E) the shadow color
:param shadowDither: (C Q E) dither the shadow
:param shadowSamples: (C Q E) number of shadow samples
:param softShadow: (C Q E) soft shadow
:param useRayTraceShadows: (C Q E) ray trace shadows
:returns: Light shape name
"""
pass
def polyMergeFacet(*args, caching: bool=True, constructionHistory: bool=True, firstFacet:
Union[int, bool]=0, mergeMode: Union[int, bool]=0, name: AnyStr="",
nodeState: Union[int, bool]=0, secondFacet: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The second face becomes a hole in the first face.
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param firstFacet: (C Q E) The number of the first (outer) face to merge
:param mergeMode: (C Q E) This flag specifies how faces are merged: 0: moves second face to
first one 1: moves both faces to average 2: moves first face to second one 3, 4, 5:
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param secondFacet: (C Q E) The number of the second (hole) face to merge
:returns: The node name.
"""
pass
def XgPreview(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyBoolOp(*args, faceAreaThreshold: Union[float, bool]=0.0001, operation: Union[int,
bool]=0, preserveColor: bool=False, useThresholds: bool=False,
vertexDistanceThreshold: Union[float, bool]=0.001, caching: bool=True,
mergeUVSets: Union[int, bool]=0, nodeState: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command creates a new poly as the result of a boolean operation on input polys : union,
intersection, difference
:param faceAreaThreshold: (C Q E) Area threshold to determine whether faces should be
collapsed before boolean Attribute is ignored unless useThresholds is set to true Default:
0.000
:param operation: (C Q E) Boolean operation type 1=union, 2=difference, 3=intersection
Default type is union Default: kBoolOpUnion
:param preserveColor: (C Q E) If true, boolean op will compute color for the new mesh If
false, the new mesh won't have any color set Default: false
:param useThresholds: (C Q E) If true, merge vertices with separations less then
vertexDistanceThreshold and collapse faces with areas less then faceAreaThreshold If false,
do no
:param vertexDistanceThreshold: (C Q E) Tolerance to determine whether vertices (and edges)
should be merged before boolean operation is applied Attribute is ignored unless
useThresholds i
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param mergeUVSets: (C Q E) Specify how UV sets will be merged on the output mesh 0 = "No
Merge": Each UV set on each mesh will become a new UV set in the output 1 = "Merge By
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: Object name and node name.
"""
pass
def SelectShortestEdgePathTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LightCentricLightLinkingEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_gridAllTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorCreateIterateCompound(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVCameraBasedProjection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xformConstraint(*args, alongNormal: Union[int, bool]=0, live: bool=True, type: Union[AnyStr,
bool]="", q=True, query=True, e=True, edit=True, **kwargs)->Union[None,
Any]:
"""
This command allows you to change the transform constraint used by the transform tools
during component transforms
:param alongNormal: (Q E) When set the transform constraint will first be applied along the
vertex normals of the components being transformed When queried, returns the curre
:param live: (Q) Query-only flag that can be used to check whether the current live surface
will be used as a transform constraint
:param type: (C Q E) Set the type of transform constraint to use When queried, returns the
current transform constraint as a string none - no constraint surface - const
:returns:
"""
pass
def copyKey(*args, animLayer: AnyStr="", animation: AnyStr="keysOrObjects.", attribute:
Union[AnyStr, List[AnyStr]]="", clipboard: AnyStr="", controlPoints: bool=False,
float: Union[floatrange, List[floatrange]]=None, forceIndependentEulerAngles:
bool=True, hierarchy: AnyStr="", includeUpperBound: bool=True, index: Union[int,
List[int]]=0, option: AnyStr="", shape: bool=True, time: Union[timerange,
List[timerange]]=None, **kwargs)->int:
"""
This command operates on a keyset A keyset is defined as a group of keys within a
specified time range on one or more animation curves The animation curves comprising a
keyset depend on the value of the "-animation" flag: keysOrObjects: Any active keys, when
no target objects or -attribute flags appear on the command line, or All animation curv
:param animLayer: (C) Specifies that the keys getting copied should come from this
specified animation layer If no keys on the object exist on this layer, then no keys ar
:param animation: (C) Where this command should get the animation to act on Valid values
are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Descrip
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param clipboard: (C) Specifies the clipboard to which animation is copied Valid
clipboards are "api" and "anim" The default clipboard is: anim
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param float: (C M) value uniquely representing a non-time-based key (or key range) on a
time-based animCurve Valid floatRange include single values (-f 10) or a string
:param forceIndependentEulerAngles: (C) Specifies that the rotation curves should always be
placed on the clipboard as independent Euler Angles The default value is false
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param includeUpperBound: (C) When the -t/time or -f/float flags represent a range of keys,
this flag determines whether the keys at the upper bound of the range are included in t
:param index: (C M) index of a key on an animCurve In query mode, this flag needs a value
:param option: (C) The option to use when performing the copyKey operation Valid options
are "keys," and "curve." The default copy option is: keys
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:param time: (C M) time uniquely representing a key (or key range) on a time-based
animCurve See the code examples below on how to format for a single frame or frame r
:returns: Number of animation curves copied.
"""
pass
def CopySkinWeightsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def vectorize(*args, browserView: bool=True, byFrame: float=0.0, camera: AnyStr="",
combineFillsEdges: bool=True, currentFrame: bool=True, curveTolerance: float=0.0,
customExtension: AnyStr="", detailLevel: int=0, edgeColor: List[int, int,
int]=None, edgeDetail: bool=True, edgeStyle: AnyStr="", edgeWeight: float=0.0,
endFrame: float=0.0, filenameFormat: AnyStr="", fillStyle: AnyStr="",
flashVersion: int=0, frameRate: int=0, height: int=0, hiddenEdges: bool=True,
highlightLevel: int=0, highlights: bool=True, imageFormat: AnyStr="", layer:
name=None, minEdgeAngle: float=0.0, outlinesAtIntersections: bool=True,
outputFileName: AnyStr="", pixelAspectRatio: float=0.0, reflectionDepth: int=0,
reflections: bool=True, renderLayers: bool=True, renderOptimization: AnyStr="",
renderView: bool=True, secondaryCurveFitting: bool=True, shadows: bool=True,
showBackFaces: bool=True, startFrame: float=0.0, svgAnimation: AnyStr="",
svgCompression: bool=True, width: int=0, **kwargs)->None:
"""
This command renders Maya scenes to various vector and raster formats using the Maya Vector
renderer
:param browserView: (C) Specifies whether to preview the render in the browser This option
is swf only
:param byFrame: (C) Specifies the frame increment
:param camera: (C) Specifies the camera to render
:param combineFillsEdges: (C) Specifies whether fills and edges should be combined as a
single object in Flash This option is swf only
:param currentFrame: (C) Specifies whether to render the current frame only
:param curveTolerance: (C) Specifies the curve tolerance Valid values are in the range:
0.0 to 15.0 The curve tolerance determines how aggressively the renderer tries to fit
:param customExtension: (C) Specifies a custom extension to use for the filename Any
non-empty string is valid
:param detailLevel: (C) Specifies the detail level Valid values are: 0 to 50 The smaller
the value, the more polygons may be combined to produce smaller files A higher va
:param edgeColor: (C) Specifies the red, green, and blue components of the edge color
Valid values are: 0 to 255 for each color component
:param edgeDetail: (C) Specifies whether edge detail should be rendered; ie edges that
have an angle between the face normals of any two adjacent polygons sharing an edge
:param edgeStyle: (C) Specifies the edge style Valid values are: "Outline", "EntireMesh",
"None"
:param edgeWeight: (C) Specifies the edge weight to be used for all edges in points There
are 72 points per inch A value of 0.0 specifies hairline edge weight
:param endFrame: (C) Specifies the end frame
:param filenameFormat: (C) Specifies the file name format Valid values are: "name",
"name.ext", "name.#.ext", "name.ext.#", "name.#", "name#.ext", "name_#.ext"
:param fillStyle: (C) Specifies the fill style Valid values are: "SingleColor", "TwoColor",
"FourColor", "FullColor", "AverageColor", "AreaGradient", "MeshGradient", "Non
:param flashVersion: (C) Specifies the Flash version of the swf output Valid values are: 3,
4, 5 This option is swf only
:param frameRate: (C) Specifies the frame rate This option is for svg and swf only
:param height: (C) Specifies the height of the output image in pixels
:param hiddenEdges: (C) Specifies whether hidden edges should be rendered; ie edges that
have are not visible from the camera
:param highlightLevel: (C) Specifies the highlight level Valid values are: 1 to 8 The
value specifies how many concentric rings will be used to render an object's highlight
:param highlights: (C) Specifies whether highlights should be rendered This option has no
effect for ai, eps, and svg This option is for the SingleColor, AverageColor, an
:param imageFormat: (C) Specifies the image format to render Valid values for the Windows
and Mac platforms are: "swf", "eps", "ai", "svg", "jpg", "iff", "sgi", "tga", "tif
:param layer: (C) Render the specified render layer Only this render layer will be
rendered, regardless of the renderable attribute value of the render layer The lay
:param minEdgeAngle: (C) Specifies the minimum edge angle in degrees Valid values are: 0.0
to 90.0 This angle is the minimum angle between adjacent polygon face normals tha
:param outlinesAtIntersections: (C) Specifies if edges should be drawn when two polygons
intersect By default this flag is enabled
:param outputFileName: (C) Specifies the output file name
:param pixelAspectRatio: (C) Specifes the pixel aspect ratio
:param reflectionDepth: (C) Specifies the reflection depth Valid values are: 1 to 4 The
value specifies how many levels of reflection will be applied This option has no effec
:param reflections: (C) Specifies whether reflections should be rendered This option has
no effect for ai, eps, and svg
:param renderLayers: (C) Specifies whether render layers should be rendered into separate
files
:param renderOptimization: (C) Specifies the render optimization Valid values are: "Safe",
"Good", "Aggressive" "Safe" will remove redundant geometry "Good" removes redundant ge
:param renderView: (C) Specifies whether to display the rendered image to the render view
This option is not applicable when batch rendering
:param secondaryCurveFitting: (C) Specifies whether to do secondary curve fitting
:param shadows: (C) Specifies whether shadows should be rendered This option has no effect
for ai, eps, and svg
:param showBackFaces: (C) Specifies whether back faces will should be rendered; ie faces
whose normals are pointed away from the camera
:param startFrame: (C) Specifies the start frame
:param svgAnimation: (C) Specifies the SVG animation type Valid values are: "Native",
"HTMLScript" This option is SVG only
:param svgCompression: (C) Specifies whether the SVG output should be compressed This
option is svg only
:param width: (C) Specifies the width of the output image in pixels
:returns:
"""
pass
def NodeEditorGraphDownstream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ProfilerToolCpuView(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyInfo(*args, edgeToFace: bool=True, edgeToVertex: bool=True, faceNormals: bool=True,
faceToEdge: bool=True, faceToVertex: bool=True, invalidEdges: bool=True,
invalidVertices: bool=True, laminaFaces: bool=True, nonManifoldEdges: bool=True,
nonManifoldUVEdges: bool=True, nonManifoldUVs: bool=True, nonManifoldVertices:
bool=True, vertexToEdge: bool=True, vertexToFace: bool=True, **kwargs)->AnyStr:
"""
Command queries topological information on polygonal objects and components So, the
command will require the following to be specified: - selection list to query
:param edgeToFace: (C) Returns the faces that share the specified edge Requires edges to
be selected
:param edgeToVertex: (C) Returns the vertices defining an edge Requires edges to be
selected
:param faceNormals: (C) Returns face normals of the specified object If faces are selected
the command returns the face normals of selected faces Else it returns the face
:param faceToEdge: (C) Returns the edges defining a face Requires faces to be selected
:param faceToVertex: (C) Returns the vertices defining a face Requires faces to be
selected
:param invalidEdges: (C) Find all edges that are not associated with any face in the mesh
:param invalidVertices: (C) Find all vertices that are not associated with any face in the
mesh
:param laminaFaces: (C) Find all lamina faces in the specified objects
:param nonManifoldEdges: (C) Find all non-manifold edges in the specified objects
:param nonManifoldUVEdges: (C) Find all non-manifold UV edges in the specified objects
:param nonManifoldUVs: (C) Find all non-manifold UVs in the specified objects
:param nonManifoldVertices: (C) Find all non-manifold vertices in the specified objects
:param vertexToEdge: (C) Returns the Edges connected to a vertex Requires vertices to be
selected
:param vertexToFace: (C) Returns the faces that share the specified vertex Requires
vertices to be selected
:returns: Components
"""
pass
def CreatePolygonConeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_selectModeDisableTweakMarquee(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def QualityDisplayMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_moveTweakTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def floatSliderGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0, adjustableColumn3:
int=0, adjustableColumn4: int=0, adjustableColumn5: int=0,
adjustableColumn6: int=0, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, changeCommand:
Script=None, columnAlign: Union[List[int, AnyStr], List[List[int,
AnyStr]]]=None, columnAlign2: List[AnyStr, AnyStr]=None, columnAlign3:
List[AnyStr, AnyStr, AnyStr]=None, columnAlign4: List[AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAlign5: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAlign6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach: Union[List[int, AnyStr, int], List[List[int,
AnyStr, int]]]=None, columnAttach2: List[AnyStr, AnyStr]=None,
columnAttach3: List[AnyStr, AnyStr, AnyStr]=None, columnAttach4: List[AnyStr,
AnyStr, AnyStr, AnyStr]=None, columnAttach5: List[AnyStr, AnyStr, AnyStr,
AnyStr, AnyStr]=None, columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr, AnyStr]=None, columnOffset2: List[int, int]=None, columnOffset3:
List[int, int, int]=None, columnOffset4: List[int, int, int, int]=None,
columnOffset5: List[int, int, int, int, int]=None, columnOffset6: List[int,
int, int, int, int, int]=None, columnWidth: Union[List[int, int],
List[List[int, int]]]=None, columnWidth1: int=0, columnWidth2: List[int,
int]=None, columnWidth3: List[int, int, int]=None, columnWidth4: List[int,
int, int, int]=None, columnWidth5: List[int, int, int, int, int]=None,
columnWidth6: List[int, int, int, int, int, int]=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dragCommand: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists:
bool=True, extraLabel: Union[AnyStr, bool]="", field: bool=True,
fieldMaxValue: Union[float, bool]=0.0, fieldMinValue: Union[float, bool]=0.0,
fieldStep: Union[float, bool]=0.0, fullPathName: bool=True, height:
Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, isObscured: bool=True, label: Union[AnyStr, bool]="", manage:
bool=True, maxValue: Union[float, bool]=0.0, minValue: Union[float,
bool]=0.0, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, precision: int=0,
preventOverride: bool=True, rowAttach: Union[List[int, AnyStr, int],
List[List[int, AnyStr, int]]]=None, sliderStep: Union[float, bool]=0.0,
statusBarMessage: AnyStr="", step: Union[float, bool]=0.0, useTemplate:
AnyStr="", value: Union[float, bool]=0.0, visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command string executed when the value of the slider changes
It will be executed only once after a drag of the slider
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command string executed repeatedly during a drag of the slider
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param extraLabel: (C Q E) If present on creation this specifies that there will be an
extra label appearing after the slider Sets the string to be the text for the extra labe
:param field: (C) Indicates whether the group will have an editable float field present
that reflects the value of the slider
:param fieldMaxValue: (C Q E) Maximum value that may be entered in the field This value
may be set to any value greater than the -max/maxValue flag By default, it is equal to th
:param fieldMinValue: (C Q E) Minimum value that may be entered in the field This value
may be set to any value less than the -min/minValue flag By default, it is equal to the -
:param fieldStep: (C Q E) Increment for the field
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) If present on creation the group will have static text
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxValue: (C Q E) Maximum value for both the slider and the field
:param minValue: (C Q E) Minimum value for both the slider and the field
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param precision: (C E) Number of digits to the right of the decimal
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param sliderStep: (C Q E) The slider step value represents the amount the value will
increase or decrease when you click either side of the slider
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) Increment for both the slider and field
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Value of the group
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name of the control.
"""
pass
def ScaleKeys(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSplineSelectReplaceBySelectedFaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PinSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PerspGraphOutlinerLayout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def toolHasOptions(*args, **kwargs)->bool:
"""
This command queries a tool to see if it has options If it does, it returns true
Otherwise it returns false
:returns: True if the queried tool has options, otherwise false.
"""
pass
def CreateIllustratorCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVPlanarProjectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DoUnghost(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddOceanPreviewPlane(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BreakLightLinks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateContainerOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateClusterOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def deleteGeometryCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PartialCreaseSubdivSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetBifrostInitialState(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TangentsClamped(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_extrudeTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveWire(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_curveSnapPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OneClickAcknowledge(*args, **kwargs)->None:
"""
"""
pass
def PreInfinityCycleOffset(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AveragePolygonNormals(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmBindPatches(*args, **kwargs)->None:
"""
"""
pass
def TogglePaintAtDepth(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePond(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def bevelPlus(*args, bevelInside: bool=False, capSides: Union[int, bool]=4,
constructionHistory: bool=True, innerStyle: Union[int, bool]=0, joinSurfaces:
bool=True, name: AnyStr="", normalsOutwards: bool=True, numberOfSides: Union[int,
bool]=4, outerStyle: Union[int, bool]=0, polygon: int=0, range: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The bevelPlus command creates a new bevel surface for the specified curves using a given
style curve The first curve should be the "outside" curve, and the (optional) rest of them
should be inside of the first one For predictable results, the curves should be planar and
all in the same plane
:param bevelInside: (C Q E) If true, ensure surface always remains within the original
profile curve Default: false
:param capSides: (C Q) How to cap the bevel 1 - no caps 2 - cap at start only 3 - cap at
end only 4 - cap at start and end Default:4
:param constructionHistory: (C) Turn the construction history on or off
:param innerStyle: (C Q E) Similar to outerStyle, this style is applied to all but the
first (outer) curve specified
:param joinSurfaces: (C Q E) Attach bevelled surfaces into one surface for each input curve
Default:true
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param normalsOutwards: (C Q E) If enabled, the normals point outwards on the resulting
NURBS or poly surface
:param numberOfSides: (C Q E) How to apply the bevel 1 - no bevels 2 - bevel at start only
3 - bevel at end only 4 - bevel at start and end Default: 4
:param outerStyle: (C Q E) Choose a style to use for the bevel of the first (outer) curve
There are 15 predefined styles (values 0 to 14 can be used to select them) For those
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:param range: (C) Force a curve range on complete input curve
:returns: Object name(s) and node name
"""
pass
def BatchRenderOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def adskAssetListUI(*args, **kwargs)->None:
"""
"""
pass
def RemoveFromContainerOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ScaleConstraintOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def iconTextStaticLabel(*args, align: Union[AnyStr, bool]="", annotation: Union[AnyStr,
bool]="", backgroundColor: Union[List[float, float, float], bool]=None,
defineTemplate: AnyStr="", disabledImage: Union[AnyStr, bool]="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, flipX:
bool=True, flipY: bool=True, font: Union[AnyStr, bool]="",
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, image: Union[AnyStr,
bool]="", image1: Union[AnyStr, bool]="", image2: Union[AnyStr,
bool]="", image3: Union[AnyStr, bool]="", imageOverlayLabel:
Union[AnyStr, bool]="", isObscured: bool=True, label: Union[AnyStr,
bool]="", labelOffset: Union[int, bool]=0, ltVersion: Union[AnyStr,
bool]="", manage: bool=True, marginHeight: Union[int, bool]=0,
marginWidth: Union[int, bool]=0, noBackground: bool=True,
numberOfPopupMenus: bool=True, overlayLabelBackColor: Union[List[float,
float, float, float], bool]=None, overlayLabelColor: Union[List[float,
float, float], bool]=None, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, rotation:
Union[float, bool]=0.0, statusBarMessage: AnyStr="", style:
Union[AnyStr, bool]="", useAlpha: bool=True, useTemplate: AnyStr="",
version: Union[AnyStr, bool]="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This control supports up to 3 icon images and 4 different display styles The icon image
displayed is the one that best fits the current size of the control given its current style
This command creates an iconTextStaticLabel
:param align: (C Q E) The label alignment Alignment values are "left", "right", and
"center" By default, the label is aligned "center" Currently only available when -st
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param disabledImage: (C Q E) Image used when the button is disabled Image size must be
the same as the image specified with the i/image flag This is a Windows only flag
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param flipX: (C Q E) Is the image flipped horizontally?
:param flipY: (C Q E) Is the image flipped vertically?
:param font: (C Q E) The font for the text Valid values are "boldLabelFont",
"smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont",
"oblique
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param image: (C Q E) If you are not providing images with different sizes then you may use
this flag for the control's image If the "iconOnly" style is set, the icon wil
:param image1: (C Q E) First of three possible icons The icon that best fits the current
size of the control will be displayed
:param image2: (C Q E) Second of three possible icons The icon that best fits the current
size of the control will be displayed
:param image3: (C Q E) Third of three possible icons The icon that best fits the current
size of the control will be displayed
:param imageOverlayLabel: (C Q E) A short string, up to 6 characters, representing a label
that will be displayed on top of the image
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) The text that appears in the control
:param labelOffset: (C Q E) The label offset Default is 0 Currently only available when
-st/style is set to "iconAndTextCentered"
:param ltVersion: (C Q E) This flag is used to specify the Maya LT version that this
control feature was introduced, if the version flag is not specified, or if the version fl
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param marginHeight: (C Q E) The number of pixels above and below the control content The
default value is 1 pixel
:param marginWidth: (C Q E) The number of pixels on either side of the control content The
default value is 1 pixel
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param overlayLabelBackColor: (C Q E) The RGBA color of the shadow behind the label defined
by imageOverlayLabel Default is 50% transparent black: 0 0 0 .5
:param overlayLabelColor: (C Q E) The RGB color of the label defined by imageOverlayLabel
Default is a light grey: .8 .8 .8
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rotation: (C Q E) The rotation value of the image in radians
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param style: (C Q E) The draw style of the control Valid styles are "iconOnly",
"textOnly", "iconAndTextHorizontal", "iconAndTextVertical", and "iconAndTextCentered" (N
:param useAlpha: (C Q E) Is the image using alpha channel?
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param version: (C Q E) Specify the version that this control feature was introduced The
argument should be given as a string of the version number (e.g "2013", "2014") C
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the iconTextStaticLabel created.
"""
pass
def renderSetup(*args, **kwargs)->None:
"""
"""
pass
def HypershadeGraphClearGraph(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetSmoothBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutTangentLinear(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EnterEditModeRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideCameraManipulators(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cmdShell(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, clear: bool=True, command: Union[AnyStr, bool]="",
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float, float,
float], bool]=None, isObscured: bool=True, manage: bool=True, noBackground:
bool=True, numberOfHistoryLines: Union[int, bool]=0, numberOfPopupMenus: bool=True,
numberOfSavedLines: Union[int, bool]=0, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, prompt: Union[AnyStr,
bool]="", statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a scrolling field that behaves similar to a unix shell for entering
user input You may specify the number of lines that will be remembered by the field with
the -nsl/numberOfSavedLines flag The default number of lines saved is 100 The shellField
also maintains a command history buffer You can specify the number of input lin
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param clear: (C) Erases all visible text, and also deletes any text that had scrolled of
the top of the field After clearing the field it will be blank, and you will
:param command: (C Q E) Command executed when the contents change
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfHistoryLines: (C Q E) The number of input lines to be saved in the command
history buffer You can cycle through this buffer by pressing the up and down arrow keys
Valid
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param numberOfSavedLines: (C Q E) The total number of lines (the scrolled lines and
currently visible lines) that will be remembered by the field Any lines beyond this number
will be
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param prompt: (C Q E) The text that is used as a prompt
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def RandomizeFolliclesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddTargetShapeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OpenScene(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def duplicate(*args, inputConnections: bool=True, instanceLeaf: bool=True, name: AnyStr="",
parentOnly: bool=True, renameChildren: bool=True, returnRootsOnly: bool=True,
smartTransform: bool=True, transformsOnly: bool=True, upstreamNodes: bool=True,
**kwargs)->List[AnyStr]:
"""
This command duplicates the given objects If no objects are given, then the selected list
is duplicated The smart transform feature allows duplicate to transform newly duplicated
objects based on previous transformations between duplications Example: Duplicate an
object and move it to a new location Duplicate it again with the smart duplicate
:param inputConnections: (C) Input connections to the node to be duplicated, are also
duplicated This would result in a fan-out scenario as the nodes at the input side are not
d
:param instanceLeaf: (C) instead of duplicating leaf DAG nodes, instance them
:param name: (C) name to give duplicated object(s)
:param parentOnly: (C) Duplicate only the specified DAG node and not any of its children
:param renameChildren: (C) rename the child nodes of the hierarchy, to make them unique
:param returnRootsOnly: (C) return only the root nodes of the new hierarchy When used with
upstreamNodes flag, the upstream nodes will be omitted in the result This flag contr
:param smartTransform: (C) remembers last transformation and applies it to duplicated
object(s)
:param transformsOnly: (C) Duplicate only transform nodes and not any shapes
:param upstreamNodes: (C) the upstream nodes leading upto the selected nodes (along with
their connections) are also duplicated
:returns: : names of the objects created
"""
pass
def WarpImageOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllRigidConstraints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSplineCacheReplace(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def StitchEdgesToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def allNodeTypes(*args, includeAbstract: bool=True, **kwargs)->List[AnyStr]:
"""
This command returns a list containing the type names of every kind of creatable node
registered with the system Note that some node types are abstract and cannot be created
These will not show up on this list (e.g transform and polyShape both inherit from
dagObject, but dagObject cannot be created directly so it will not appear on this list.)
:param includeAbstract: (C) Show every node type, even the abstract ones which cannot be
created via the 'createNode' command These will have the suffix "(abstract)" appended t
:returns: List of node types
"""
pass
def dR_targetWeldPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GoalOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nurbsUVSet(*args, create: bool=True, useExplicit: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[bool, Any]:
"""
Allows user to toggle between implicit and explicit UVs on a NURBS object Also provides a
facility to create, delete, rename and set the current explicit UVSet An implicit UVSet is
non-editable It uses the parametric make-up of the NURBS object to determine the location
of UVs (isoparm intersections) NURBS objects also support explicit UVSets w
:param create: (C Q E) Creates an explicit UV set on the specified surface If the surface
already has an explicit UV set this flag will do nothing Use the -ue/useExplicit
:param useExplicit: (C Q E) Toggles the usage of explicit/implicit UVs When true, explicit
UVs will be used, otherwise the object will use implicit UVs
:returns: Success or Failure.
"""
pass
def NodeEditorRedockTornOffTab(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllLights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateEmitter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyPipe(*args, axis: Union[List[float, float, float], bool]=None, caching: bool=True,
constructionHistory: bool=True, createUVs: bool=True, height: Union[float,
bool]=2.0, name: AnyStr="", nodeState: Union[int, bool]=0, object: bool=True,
radius: Union[float, bool]=1.0, roundCap: bool=False, subdivisionsAxis: Union[int,
bool]=20, subdivisionsCaps: Union[int, bool]=1, subdivisionsHeight: Union[int,
bool]=1, texture: bool=True, thickness: Union[float, bool]=0.5, q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The polyPipe command creates a new polygonal pipe
:param axis: (C Q E) This flag specifies the primitive axis used to build the pipe Q: When
queried, this flag returns a float[3]
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createUVs: (C Q E) Create UVs or not Default: true
:param height: (C Q E) Height of the pipe Default: 2.0
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node (where applicable)
:param radius: (C Q E) Radius of the pipe Default: 1.0
:param roundCap: (C Q E) To indicate whether we need a round cap Default: false
:param subdivisionsAxis: (C Q E) Subdivisions around the axis Default: 20
:param subdivisionsCaps: (C Q E) Subdivisions along the thickness caps Default: 1
:param subdivisionsHeight: (C Q E) Subdivisions along the height Default: 1
:param texture: (C Q E) Apply texture or not this is an old attribute This is unsupported
and would be removed in a future release Default: true
:param thickness: (C Q E) Thickness of the pipe Default: 0.5
:returns: Object name and node name.
"""
pass
def CombinePolygons(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_moveRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddKeysToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def duplicateSurface(*args, caching: bool=True, constructionHistory: bool=True, faceCountU:
Union[int, bool]=1, faceCountV: Union[int, bool]=1, firstFaceU: Union[int,
bool]=0, firstFaceV: Union[int, bool]=0, local: bool=True, mergeItems:
bool=True, name: AnyStr="", nodeState: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The duplicateSurface command takes a surface patch (face) and and returns the 3D surface
Connected patches are returned as a single surface
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C) Turn the construction history on or off
:param faceCountU: (C Q E) Number of faces in U direction Default: 1
:param faceCountV: (C Q E) Number of faces in V direction Default: 1
:param firstFaceU: (C Q E) First face (U direction index) Default: 0
:param firstFaceV: (C Q E) First face (V direction index) Default: 0
:param local: (C) Copy the transform of the surface and connect to the local space version
instead
:param mergeItems: (C) Merge component results where possible For example, instead of
returning a[1] and a[2], return a[1:2]
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: Object name and node name
"""
pass
def CreatePolygonCubeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def IntersectCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nClothDeleteHistory(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SewUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectUVOverlappingComponentsPerObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleAnimationDetails(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorUnmuteAllTracks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def WireDropoffLocator(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXResetImport(*args, **kwargs)->None:
"""
"""
pass
def GhostObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorPickWalkUp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def colorInputWidgetGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0,
adjustableColumn3: int=0, adjustableColumn4: int=0, adjustableColumn5:
int=0, adjustableColumn6: int=0, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None,
changeCommand: Script=None, columnAlign: Union[List[int, AnyStr],
List[List[int, AnyStr]]]=None, columnAlign2: List[AnyStr, AnyStr]=None,
columnAlign3: List[AnyStr, AnyStr, AnyStr]=None, columnAlign4:
List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign5: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign6: List[AnyStr, AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach: Union[List[int,
AnyStr, int], List[List[int, AnyStr, int]]]=None, columnAttach2:
List[AnyStr, AnyStr]=None, columnAttach3: List[AnyStr, AnyStr,
AnyStr]=None, columnAttach4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach5: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnOffset2: List[int, int]=None, columnOffset3:
List[int, int, int]=None, columnOffset4: List[int, int, int, int]=None,
columnOffset5: List[int, int, int, int, int]=None, columnOffset6:
List[int, int, int, int, int, int]=None, columnWidth: Union[List[int,
int], List[List[int, int]]]=None, columnWidth1: int=0, columnWidth2:
List[int, int]=None, columnWidth3: List[int, int, int]=None,
columnWidth4: List[int, int, int, int]=None, columnWidth5: List[int,
int, int, int, int]=None, columnWidth6: List[int, int, int, int, int,
int]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists:
bool=True, forceDragRefresh: bool=True, fullPathName: bool=True,
height: Union[int, bool]=0, highlightColor: Union[List[float, float,
float], bool]=None, hsvValue: Union[List[float, float, float],
bool]=None, isObscured: bool=True, label: Union[AnyStr, bool]="",
manage: bool=True, noBackground: bool=True, numberOfPopupMenus:
bool=True, parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, rgbValue: Union[List[float, float, float],
bool]=None, rowAttach: Union[List[int, AnyStr, int], List[List[int,
AnyStr, int]]]=None, statusBarMessage: AnyStr="", useTemplate:
AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command string executed when slider value changes
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param forceDragRefresh: (C) If used then force refresh on drag
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param hsvValue: (C Q E) Color in hue, saturation, and value format
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) Label text for the group
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rgbValue: (C Q E) Color in red, green, and blue format
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: (the name of the created group)
"""
pass
def scaleComponents(*args, pivot: List[float, float, float]=None, rotation: List[float, float,
float]=None, **kwargs)->None:
"""
This is a limited version of the scale command First, it only works on selected components
You provide a pivot in world space, and you can provide a rotation This rotation affects
the scaling, so that rather than scaling in X, Y, Z, this is scaling in X, Y, and Z after
they have been rotated by the given rotation This allows selected component
:param pivot: (C) The pivot position in world space (default is origin)
:param rotation: (C) The rotational offset for the scaling (default is none)
:returns:
"""
pass
def RemoveBlendShape(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ThreeBottomSplitViewArrangement(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def attrFieldGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0, adjustableColumn3:
int=0, adjustableColumn4: int=0, adjustableColumn5: int=0, adjustableColumn6:
int=0, annotation: Union[AnyStr, bool]="", attribute: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, changeCommand:
Script=None, columnAlign: Union[List[int, AnyStr], List[List[int,
AnyStr]]]=None, columnAlign2: List[AnyStr, AnyStr]=None, columnAlign3:
List[AnyStr, AnyStr, AnyStr]=None, columnAlign4: List[AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAlign5: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAlign6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach: Union[List[int, AnyStr, int], List[List[int, AnyStr, int]]]=None,
columnAttach2: List[AnyStr, AnyStr]=None, columnAttach3: List[AnyStr, AnyStr,
AnyStr]=None, columnAttach4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach5: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnOffset2: List[int, int]=None, columnOffset3: List[int, int, int]=None,
columnOffset4: List[int, int, int, int]=None, columnOffset5: List[int, int,
int, int, int]=None, columnOffset6: List[int, int, int, int, int, int]=None,
columnWidth: Union[List[int, int], List[List[int, int]]]=None, columnWidth1:
int=0, columnWidth2: List[int, int]=None, columnWidth3: List[int, int,
int]=None, columnWidth4: List[int, int, int, int]=None, columnWidth5: List[int,
int, int, int, int]=None, columnWidth6: List[int, int, int, int, int,
int]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
extraButton: bool=True, extraButtonCommand: Script=None, extraButtonIcon:
Union[AnyStr, bool]="", extraLabel: Union[AnyStr, bool]="", forceAddMapButton:
bool=True, fullPathName: bool=True, height: Union[int, bool]=0, hideMapButton:
bool=True, highlightColor: Union[List[float, float, float], bool]=None,
isObscured: bool=True, label: Union[AnyStr, bool]="", manage: bool=True,
maxValue: Union[float, bool]=0.0, minValue: Union[float, bool]=0.0,
noBackground: bool=True, numberOfFields: int=0, numberOfPopupMenus: bool=True,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, precision: int=0,
preventOverride: bool=True, rowAttach: Union[List[int, AnyStr, int],
List[List[int, AnyStr, int]]]=None, statusBarMessage: AnyStr="", step:
Union[float, bool]=0.0, useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param attribute: (C Q E) The name of a unique attribute of type vector This newly created
field will be attached to the attribute, so that modifications to one will change t
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) The command string is executed when the value of any of the
floatFields change
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param extraButton: (C) Add an extra icon button to the end of this control (before extra
label)
:param extraButtonCommand: (C E) The command string is executed when the extra button is
clicked
:param extraButtonIcon: (C Q E) The icon file name of the extra button
:param extraLabel: (C Q E) set an optional string that will be positioned to the right of
all the fields
:param forceAddMapButton: (C) Force adding a map button to this control If this option is
true, option hideMapButton is suppressed
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param hideMapButton: (C) Force the map button to remain hidden for this control
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) By default, the label of this field will be the name of the attribute
This flag can be used to override that name with whatever the user wants
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxValue: (C Q E) Sets the maximum value for all fields
:param minValue: (C Q E) Sets the minimum value for all fields
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfFields: (C) sets the number of fields Only allowed values are 2 to 4 If
not specified, defaults to 3 NOTE: if the -at flag is used when this widget is created
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param precision: (C E) Sets the precision for all fields
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) Sets the increment for all fields
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The full name of the control.
"""
pass
def NodeEditorGridToggleVisibility(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FullHotboxDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NextKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def particleExists(*args, **kwargs)->bool:
"""
This command is used to query if a particle or soft object with the given name exists
Either the transform or shape name can be used as well as the name of the soft object
:returns: True if there is a particle object or soft object by the given
name, false
otherwise.
"""
pass
def tolerance(*args, angular: Union[float, bool]=0.0, linear: Union[float, bool]=0.0, q=True,
query=True, **kwargs)->Union[None, Any]:
"""
This command sets tolerances used by modelling operations that require a tolerance, such as
surface fillet Linear tolerance is also known as "positional" tolerance Angular tolerance
is also known as "tangential" tolerance
:param angular: (C Q) Sets the angular, or "tangential" tolerance
:param linear: (C Q) Sets the linear, or "positonal" tolerance
:returns:
"""
pass
def CreatePolygonCone(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BufferCurveSnapshot(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonPipeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ProjectTangent(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def curveOnSurface(*args, append: bool=True, degree: float=3, knot: Union[float,
List[float]]=0.0, name: AnyStr="", periodic: bool=True, positionUV:
Union[List[float, float], List[List[float, float]]]=None, replace: bool=True,
**kwargs)->AnyStr:
"""
The curve command creates a new curve from a list of control vertices (CVs) A string is
returned containing the pathname to the newly created curve You can create a curve from
points either in world space or object (local) space, either with weights or without You
can replace an existing curve by using the "-r/replace" flag You can append a poi
:param append: (C) Appends point(s) to the end of an existing curve If you use this flag,
you must specify the name of the curve to append to, at the end of the comman
:param degree: (C) The degree of the new curve Default is 3 Note that you need (degree+1)
curve points to create a visible curve span eg you must place 4 points for
:param knot: (C M) A knot value in a knot vector One flag per knot value There must be
(numberOfPoints + degree - 1) knots and the knot vector must be non-decreasing
:param name: (C) Name of the curve
:param periodic: (C) If on, creates a curve that is periodic Default is off
:param positionUV: (C M) The uv position of a point
:param replace: (C) Replaces an entire existing curve If you use this flag, you must
specify the name of the curve to replace, at the end of the command (See examples
:returns: - name of new curve-on-surface
"""
pass
def DeltaMush(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertSelectionToVertices(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RoundTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideFluids(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ProjectCurveOnSurfaceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def notifyPostRedo(*args, **kwargs)->None:
"""
"""
pass
def Group(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def internalVar(*args, userAppDir: bool=True, userBitmapsDir: bool=True, userHotkeyDir:
bool=True, userMarkingMenuDir: bool=True, userPrefDir: bool=True,
userPresetsDir: bool=True, userScriptDir: bool=True, userShelfDir: bool=True,
userTmpDir: bool=True, userWorkspaceDir: bool=True, **kwargs)->AnyStr:
"""
This command returns the values of internal variables No modification of these variables
is supported
:param userAppDir: (C) Return the user application directory
:param userBitmapsDir: (C) Return the user bitmaps prefs directory
:param userHotkeyDir: (C) Return the user hotkey directory
:param userMarkingMenuDir: (C) Return the user marking menu directory
:param userPrefDir: (C) Return the user preference directory
:param userPresetsDir: (C) Return the user presets directory
:param userScriptDir: (C) Return the user script directory
:param userShelfDir: (C) Return the user shelves directory
:param userTmpDir: (C) Return a temp directory Will check for TMPDIR environment variable,
otherwise will return the current directory
:param userWorkspaceDir: (C) Return the user workspace directory (also known as the
projects directory)
:returns: The value of the variable specified by the flag use.
"""
pass
def ToggleToolbox(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hikCharacterToolWidget(*args, **kwargs)->None:
"""
"""
pass
def shapePanel(*args, control: bool=True, copy: AnyStr="", createString: bool=True,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", editString: bool=True,
exists: bool=True, init: bool=True, isUnique: bool=True, label: Union[AnyStr,
bool]="", menuBarRepeatLast: bool=True, menuBarVisible: bool=True, needsInit:
bool=True, parent: AnyStr="", popupMenuProcedure: Union[Script, bool]=None,
replacePanel: AnyStr="", shapeEditor: bool=True, tearOff: bool=True,
tearOffCopy: AnyStr="", tearOffRestore: bool=True, unParent: bool=True,
useTemplate: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a panel that derives from the base panel class that houses a
shapeEditor
:param control: (Q) Returns the top level control for this panel Usually used for getting
a parent to attach popup menus CAUTION: panels may not have controls at times
:param copy: (E) Makes this panel a copy of the specified panel Both panels must be of the
same type
:param createString: (E) Command string used to create a panel
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the Maya panel
:param editString: (E) Command string used to edit a panel
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param init: (C E) Initializes the panel's default state This is usually done
automatically on file -new and file -open
:param isUnique: (Q) Returns true if only one instance of this panel type is allowed
:param label: (Q E) Specifies the user readable label for the panel
:param menuBarRepeatLast: (C Q E) Controls whether clicking on the menu header with the
middle mouse button would repeat the last selected menu item
:param menuBarVisible: (C Q E) Controls whether the menu bar for the panel is displayed
:param needsInit: (Q E) (Internal) On Edit will mark the panel as requiring initialization
Query will return whether the panel is marked for initialization Used during fil
:param parent: (C) Specifies the parent layout for this panel
:param popupMenuProcedure: (Q E) Specifies the procedure called for building the panel's
popup menu(s) The default value is "buildPanelPopupMenu" The procedure should take one
stri
:param replacePanel: (E) Will replace the specified panel with this panel If the target
panel is within the same layout it will perform a swap
:param shapeEditor: (Q) Query only flag that returns the name of an editor to be associated
with the panel
:param tearOff: (Q E) Will tear off this panel into a separate window with a paneLayout as
the parent of the panel When queried this flag will return if the panel has bee
:param tearOffCopy: (C) Will create this panel as a torn of copy of the specified source
panel
:param tearOffRestore: (C E) Restores panel if it is torn off and focus is given to it If
docked, becomes the active panel in the docked window This should be the default flag
:param unParent: (E) Specifies that the panel should be removed from its layout This
(obviously) cannot be used with query
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the panel
"""
pass
def DeleteChannels(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetFBIKExample(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def jointLattice(*args, after: bool=True, afterReference: bool=True, before: bool=True,
creasing: Union[float, bool]=0.0, deformerTools: bool=True, exclusive:
Union[AnyStr, bool]="", frontOfChain: bool=True, geometry: Union[AnyStr,
List[AnyStr], bool]="", geometryIndices: bool=True, ignoreSelected: bool=True,
includeHiddenSelections: bool=False, joint: AnyStr="", lengthIn: Union[float,
bool]=0.0, lengthOut: Union[float, bool]=0.0, lowerBindSkin: AnyStr="",
lowerTransform: AnyStr="", name: AnyStr="", parallel: bool=True, prune:
bool=True, remove: Union[bool, List[bool]]=True, rounding: Union[float,
bool]=0.0, split: bool=True, upperBindSkin: AnyStr="", upperTransform:
AnyStr="", widthLeft: Union[float, bool]=0.0, widthRight: Union[float,
bool]=0.0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command creates/edits/queries a jointLattice deformer The name of the created/edited
object is returned Usually you would make use of this functionality through the higher
level flexor command
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param creasing: (C Q E) Affects the bulging of lattice points on the inside of the bend
Positive/negative values cause the points to bulge outwards/inwards Default value i
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param joint: (C) Specifies the joint which will be used to drive the bulging behaviours
:param lengthIn: (C Q E) Affects the location of lattice points on the parent bone
Positive/negative values cause the points to move away/towards the joint Changing this pa
:param lengthOut: (C Q E) Affects the location of lattice points on the child bone
Positive/negative values cause the points to move away/towards the joint Changing this
par
:param lowerBindSkin: (C) Specifies the node which is performing the bind skin operation on
the geometry associated with the lower bone
:param lowerTransform: (C) Specifies which dag node is being used to rigidly transform the
lower part of the lattice which this node is going to deform If this flag is not spe
:param name: (C) Used to specify the name of the node being created
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param rounding: (C Q E) Affects the bulging of lattice points on the outside of the bend
Positive/negative values cause the points to bulge outwards/inwards Default value
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:param upperBindSkin: (C) Specifies the node which is performing the bind skin operation on
the geometry associated with the upper bone
:param upperTransform: (C) Specifies which dag node is being used to rigidly transform the
upper part of the lattice which this node is going to deform If this flag is not spe
:param widthLeft: (C Q E) Affects the bulging of lattice points on the left side of the
bend Positive/negative values cause the points to bulge outwards/inwards Default valu
:param widthRight: (C Q E) Affects the bulging of lattice points on the right side of the
bend Positive/negative values cause the points to bulge outwards/inwards Default val
:returns: Name of joint lattice algorithm node created/edited.
"""
pass
def PublishNode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorReduceTraversalDepth(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowDeformers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def IPRRenderIntoNewWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InteractiveBindSkinOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def clearNClothStartState(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LassoTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FlareOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ParticleToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def particleInstancer(*args, addObject: bool=True, aimAxis: Union[AnyStr, bool]="",
aimDirection: Union[AnyStr, bool]="", aimPosition: Union[AnyStr, bool]="",
aimUpAxis: Union[AnyStr, bool]="", aimWorldUp: Union[AnyStr, bool]="",
attributeMapping: bool=True, cycle: Union[AnyStr, bool]="none",
cycleStartObject: Union[AnyStr, bool]="", cycleStep: Union[float,
bool]=0.0, cycleStepUnits: Union[AnyStr, bool]="frames", index: Union[int,
bool]=0, instanceId: Union[AnyStr, bool]="", levelOfDetail: Union[AnyStr,
bool]="geometry", name: Union[AnyStr, bool]="", object: Union[AnyStr,
List[AnyStr], bool]="", objectIndex: Union[AnyStr, bool]="", particleAge:
Union[AnyStr, bool]="", position: Union[AnyStr, bool]="worldPosition",
removeObject: bool=True, rotation: Union[AnyStr, bool]="", rotationOrder:
Union[AnyStr, bool]="", rotationType: Union[AnyStr, bool]="",
rotationUnits: Union[AnyStr, bool]="", scale: Union[AnyStr, bool]="",
shear: Union[AnyStr, bool]="", visibility: Union[AnyStr, bool]="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command is used to create a particle instancer node and set the proper attributes in
the particle shape and in the instancer node It will also create the connections needed
between the particle shape and the instancer node
:param addObject: (C E) This flag indicates that objects specified by the -object flag will
be added to the instancer node as instanced objects
:param aimAxis: (C Q E) This flag sets or queries the particle attribute name to be used
for the aim axis of the instanced objects
:param aimDirection: (C Q E) This flag sets or queries the particle attribute name to be
used for the aim direction of the instanced objects
:param aimPosition: (C Q E) This flag sets or queries the particle attribute name to be
used for the aim position of the instanced objects
:param aimUpAxis: (C Q E) This flag sets or queries the particle attribute name to be used
for the aim up axis of the instanced objects
:param aimWorldUp: (C Q E) This flag sets or queries the particle attribute name to be used
for the aim world up of the instanced objects
:param attributeMapping: (Q) This flag queries the particle attribute mapping list
:param cycle: (C Q E) This flag sets or queries the cycle attribute for the instancer node
The options are "none", "sequential" The default is "none"
:param cycleStartObject: (C Q E) This flag sets or queries the particle attribute name to
be used for the cycle start object of the instanced objects
:param cycleStep: (C Q E) This flag sets or queries the cycle step attribute for the
instancer node This attribute indicates the size of the step in frames or seconds (see cy
:param cycleStepUnits: (C Q E) This flag sets or queries the cycle step unit attribute for
the instancer node The options are "frames" or "seconds" The default is "frames"
:param index: (Q) This flag is used to query the name of the ith instanced object
:param instanceId: (Q) This flag queries the particle attribute name to be used for the id
of the instanced objects
:param levelOfDetail: (C Q E) This flag sets or queries the level of detail of the
instanced objects The options are "geometry", "boundingBox" or "boundingBoxes" The
default is
:param name: (C Q) This flag sets or queries the name of the instancer node
:param object: (C Q E M) This flag indicates which objects will be add/removed from the
list of instanced objects The flag is used in conjuction with the -addObject and -rem
:param objectIndex: (C Q E) This flag sets or queries the particle attribute name to be
used for the object index of the instanced objects
:param particleAge: (C Q E) This flag sets or queries the particle attribute name to be
used for the age of the instanced objects
:param position: (C Q E) DEFAULT "worldPosition" This flag sets or queries the particle
attribute name to be used for the positions of the instanced objects By default the a
:param removeObject: (E) This flag indicates that objects specified by the -object flag
will be removed from the instancer node as instanced objects
:param rotation: (C Q E) This flag sets or queries the particle attribute name to be used
for the rotation of the instanced objects
:param rotationOrder: (C Q E) This flag specifies the rotation order associated with the
rotation flag The options are XYZ, XZY, YXZ, YZX, ZXY, or ZYX By default the attribute i
:param rotationType: (C Q E) This flag sets or queries the particle attribute name to be
used for the rotation type of the instanced objects
:param rotationUnits: (C Q E) This flag specifies the rotation units associated with the
rotation flag The options are degrees or radians By default the attribute is degrees
:param scale: (C Q E) This flag sets or queries the particle attribute name to be used for
the scale of the instanced objects
:param shear: (C Q E) This flag sets or queries the particle attribute name to be used for
the shear of the instanced objects
:param visibility: (C Q E) This flag sets or queries the particle attribute name to be used
for the visibility of the instanced objects
:returns: Command result
"""
pass
def cMuscleWeightPrune(*args, **kwargs)->None:
"""
"""
pass
def ProfilerToolToggleRecording(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AttachCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def radioButton(*args, align: Union[AnyStr, bool]="", annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, changeCommand:
Script=None, collection: AnyStr="", data: Union[int, bool]=0, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dropCallback: Script=None, editable: bool=True, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True, label:
Union[AnyStr, bool]="", manage: bool=True, noBackground: bool=True,
numberOfPopupMenus: bool=True, offCommand: Script=None, onCommand: Script=None,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, recomputeSize: bool=True, select: bool=True, statusBarMessage:
AnyStr="", useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a radio button that is added to the most recently created radio
collection if the -cl/collection flag is not used
:param align: (C Q E) This flag is obsolete and should no longer be used The radio button
label will always be left-aligned
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the radio button's state is changed Note
that this flag should not be used in conjunction with onCommand and offCommand That
:param collection: (C) To explicitly add a radio button to a collection of radio buttons
specify the name of the radio collection
:param data: (C Q E) Internal data associated with the radio button
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editable: (C Q E) The edit state of the radio button By default, this flag is set
to true and the radio button value may be changed by clicking on it If false then t
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) The label text The default label is the name of the control
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param offCommand: (C E) Command executed when the radio button is turned off
:param onCommand: (C E) Command executed when the radio button is turned on
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param recomputeSize: (C Q E) If true then the control will recompute it's size to just fit
the size of the label If false then the control size will remain fixed as you change t
:param select: (C Q E) Select the radio button
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def FilePathEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def adskSceneMetadataCmd(*args, **kwargs)->None:
"""
"""
pass
def addMetadata(*args, channelName: Union[AnyStr, bool]="", channelType: Union[AnyStr, bool]="",
indexType: Union[AnyStr, bool]="", scene: bool=True, streamName: Union[AnyStr,
bool]="", structure: Union[AnyStr, bool]="", q=True, query=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
Defines the attachment of a metadata structure to one or more selected objects This
creates a placeholder with an empty metadata Stream for later population through the
editMetadata command It's similar in concept to the addAttr command for nodes - a data
description is added but no data is actually set When assigning a metadata structure you
m
:param channelName: (C Q) Name of the Channel type to which the structure is to be added
(e.g "vertex") In query mode, this flag can accept a value
:param channelType: (C Q) Obsolete - use the 'channelName' flag instead In query mode,
this flag can accept a value
:param indexType: (C Q) Name of the index type the new Channel should be using If not
specified this defaults to a simple numeric index Of the native types only a mesh "ve
:param scene: (C Q) Use this flag when you want to add metadata to the scene as a whole
rather than to any individual nodes If you use this flag and have nodes selected
:param streamName: (C Q) Name of the empty stream being created In query mode not
specifying a value will return a list of streams on the named channel type In query mode,
:param structure: (C Q) Name of the structure which defines the metadata to be attached to
the object In query mode this will return the name of the structure attached at a
:returns: List of nodes to which a new Stream was successfully added (create mode)
"""
pass
def replaceCacheFrames(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BakeSpringAnimation(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CurveUtilitiesMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def displayCull(*args, backFaceCulling: bool=True, q=True, query=True, **kwargs)->Union[None,
Any]:
"""
This command is responsible for setting the display culling property of back faces of
surfaces
:param backFaceCulling: (C Q) Enable/disable culling of back faces
:returns:
"""
pass
def SetFocusToCommandLine(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShapeEditorDuplicateTarget(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeMoveTabUp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def buttonManip(*args, icon: AnyStr="", **kwargs)->None:
"""
This creates a button manipulator This manipulator has a position in space and a triad
manip for positioning When you click on the top part of the manip, the command defined by
the first argument is executed The command is associated with the manipulator when it is
created If a dag object is included on the command line, the manip will be pare
:param icon: (C) Specify an icon to represent the manipulator
:returns:
"""
pass
def ScriptPaintToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PlaybackToggle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dynSelectCtx(*args, **kwargs)->None:
"""
"""
pass
def DeleteAllControllers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UnpublishRootTransform(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVCentricUVLinkingEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NewSceneOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SurfaceBooleanUnionToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nurbsCurveToBezier(*args, **kwargs)->List[AnyStr]:
"""
The nurbsCurveToBezier command attempts to convert an existing NURBS curve to a Bezier
curve
:returns: (object name and node name)
"""
pass
def polyCopyUV(*args, caching: bool=True, constructionHistory: bool=True, createNewMap:
bool=True, name: AnyStr="", nodeState: Union[int, bool]=0, uvSetName: AnyStr="",
uvSetNameInput: Union[AnyStr, bool]="", worldSpace: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Copy some UVs from a UV set into another
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createNewMap: (C) Set to true if a new map should be created
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param uvSetName: (C) Name of the UV set to be created
:param uvSetNameInput: (C Q E) Specifies name of the input uv set to read the UV
description from Default is the current UV set
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def AddPondSurfaceLocator(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SubdivProxyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddAnimationOffsetOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutlinerRenameSelectedItem(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_rotateRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def art3dPaintCtx(*args, accopacity: bool=False, afterStrokeCmd: Union[AnyStr, bool]="",
alphablendmode: Union[AnyStr, bool]="", assigntxt: bool=True, attrnames:
Union[AnyStr, bool]="", beforeStrokeCmd: Union[AnyStr, bool]="",
brushalignment: bool=True, brushdepth: Union[float, bool]=0.0, brushfeedback:
bool=True, brushtype: Union[AnyStr, bool]="", clear: bool=True, commonattr:
Union[AnyStr, bool]="", dragSlider: AnyStr="", dynclonemode: bool=True,
exists: bool=True, expandfilename: bool=True, exportaspectratio: Union[float,
bool]=0.0, exportfilemode: Union[AnyStr, bool]="luminance/rgb",
exportfilesave: AnyStr="", exportfilesizex: Union[int, bool]=0,
exportfilesizey: Union[int, bool]=0, exportfiletype: Union[AnyStr, bool]="",
extendFillColor: bool=True, fileformat: Union[AnyStr, bool]="",
filetxtaspectratio: Union[float, bool]=1, filetxtsizex: Union[int, bool]=256,
filetxtsizey: Union[int, bool]=256, floodOpacity: Union[float, bool]=0.0,
floodall: bool=True, floodselect: bool=True, history: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", importfileload: AnyStr="", importfilemode: Union[AnyStr,
bool]="alpha", importreassign: bool=False, keepaspectratio: bool=True,
lastRecorderCmd: Union[AnyStr, bool]="", lastStampName: Union[AnyStr,
bool]="", lowerradius: Union[float, bool]=0.0, makeStroke: Union[int,
List[int], bool]=0, mappressure: Union[AnyStr, bool]="none", name: AnyStr="",
opacity: Union[float, bool]=1.0, outline: bool=True, outwhilepaint:
bool=False, paintmode: Union[AnyStr, bool]="screen", paintoperationtype:
Union[AnyStr, bool]="Paint", painttxtattr: Union[AnyStr, bool]="Color",
painttxtattrname: Union[AnyStr, bool]="", pfxScale: Union[float, bool]=0.0,
pfxWidth: Union[float, bool]=0.0, pickColor: bool=True, pickValue: bool=True,
playbackCursor: Union[List[float, float], List[List[float, float]],
bool]=None, playbackPressure: Union[float, List[float], bool]=0.0,
preserveclonesource: bool=True, pressureMapping1: Union[int, bool]=0,
pressureMapping2: Union[int, bool]=0, pressureMapping3: Union[int, bool]=0,
pressureMax1: Union[float, bool]=0.0, pressureMax2: Union[float, bool]=0.0,
pressureMax3: Union[float, bool]=0.0, pressureMin1: Union[float, bool]=0.0,
pressureMin2: Union[float, bool]=0.0, pressureMin3: Union[float, bool]=0.0,
profileShapeFile: Union[AnyStr, bool]="", projective: bool=False, radius:
Union[float, bool]=1.0, record: bool=True, reflection: bool=False,
reflectionaboutorigin: bool=True, reflectionaxis: Union[AnyStr, bool]="x",
reloadtexfile: bool=True, resizeratio: Union[float, bool]=0.0, resizetxt:
bool=True, rgbcolor: Union[List[float, float, float], bool]=None, rgbflood:
Union[List[float, float, float], bool]=None, saveTextureOnStroke: bool=False,
saveonstroke: bool=False, savetexture: bool=True, screenRadius: Union[float,
bool]=0.0, selectclonesource: bool=True, shadernames: Union[AnyStr, bool]="",
shapeattr: bool=False, shapenames: Union[AnyStr, bool]="", showactive:
bool=True, soloAsDiffuse: bool=False, stampDepth: Union[float, bool]=0.0,
stampProfile: Union[AnyStr, bool]="", stampSpacing: Union[float, bool]=1.0,
strokesmooth: Union[AnyStr, bool]="", surfaceConformedBrushVertices:
bool=True, tablet: bool=True, tangentOutline: bool=True, textureFilenames:
bool=True, updateEraseTex: bool=True, usepressure: bool=False, worldRadius:
Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This is a tool context command for 3d Paint tool
:param accopacity: (C Q E) Sets opacity accumulation on/off C: Default is false (Except
for sculpt tool for which it is true by default) Q: When queried, it returns a boolean
:param afterStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
after the end of a stroke C: Default is no command Q: When queried, it returns the curre
:param alphablendmode: (C Q E) Specifies the blend mode used while painting RGB channel
Currently, we support the following blend modes: "Default" "Lighten" "Darken" "Difference"
:param assigntxt: (E) Sends a request to the tool to allocate and assign file textures to
the specified attibute on the selected shaders
:param attrnames: (C Q E) Name of attributes
:param beforeStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
before the start of a stroke C: Default is no command Q: When queried, it returns the cu
:param brushalignment: (C Q E) Specifies the path brush alignemnt If true, the brush will
align to stroke path, otherwise it will align to up vector C: Default is true Q: When q
:param brushdepth: (C Q E) Depth of the brush
:param brushfeedback: (C Q E) Specifies if the brush additional feedback should be drawn
C: Default is TRUE Q: When queried, it returns a boolean
:param brushtype: (C Q E) Name of the brush type
:param clear: (C E) Floods all cvs/vertices to the current value
:param commonattr: (Q) Returns a string with the names of all common to all the shaders
paintable attributes and supported by the Paint Texture Tool
:param dragSlider: (C E) Sets the current brush drag state for resizing or offsetting the
brush (like the 'b' and 'm' default hotkeys) The string argument is one of: "radius
:param dynclonemode: (C Q E) Enable or disable dynamic clone mode
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param expandfilename: (C E) If true, it will expand the name of the export file and
concatenate it with the surface name Otherwise it will take the name as it is C: Default
is
:param exportaspectratio: (C Q E) Value of aspect ratio for export
:param exportfilemode: (C Q E) Specifies the export channel.The valid entries here are:
"alpha", "luminance", "rgb", "rgba" C: Default is "luminance/rgb" Q: When queried, it
retu
:param exportfilesave: (E) Exports the attribute map and saves to a specified file
:param exportfilesizex: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfilesizey: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfiletype: (C Q E) Specifies the image file format It can be one of the
following: "iff", "tiff", "jpeg", "alias", "rgb", "fit" "postScriptEPS", "softimage",
"wavefron
:param extendFillColor: (C Q E) States if the painted textures will be automatically
postprocessed on each stroke to fill in the background color Default is true
:param fileformat: (C Q E) Name of the file format
:param filetxtaspectratio: (C Q E) Specifies the aspect ration of the texture width and
height Default is 1
:param filetxtsizex: (C Q E) Specifies the width of the texture Default is 256
:param filetxtsizey: (C Q E) Specifies the height of the texture Default is 256
:param floodOpacity: (C Q E) Value of the flood opacity
:param floodall: (C Q E) Turn on to flood everything
:param floodselect: (C Q E) Should the selected area be flooded?
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param importfileload: (E) Load the attribute map a specified file
:param importfilemode: (C Q E) Specifies the channel to import The valid entries here are:
"alpha", "luminance", "red", "green", "blue", and "rgb" C: Default is "alpha" Q: When q
:param importreassign: (C Q E) Specifies if the multiply atrribute maps are to be
reassigned while importing Only maps previously exported from within Artisan can be
reassigned C
:param keepaspectratio: (C Q E) States if the aspect ratio of the file texture sizes should
remain constant Default is true boolean
:param lastRecorderCmd: (C Q E) Value of last recorded command
:param lastStampName: (C Q E) Value of the last stamp name
:param lowerradius: (C Q E) Sets the lower size of the brush (only apply on tablet)
:param makeStroke: (C Q E M) Stroke point values
:param mappressure: (C Q E) Sets the tablet pressure mapping when the table is used There
are four options: "none" - the pressure has no effect, "opacity" - the pressure is map
:param name: (C) If this is a tool command, name the tool appropriately
:param opacity: (C Q E) Sets the brush opacity C: Default is 1.0 Q: When queried, it
returns a float
:param outline: (C Q E) Specifies if the brush should be drawn C: Default is TRUE Q: When
queried, it returns a boolean
:param outwhilepaint: (C Q E) Specifies if the brush outline should be drawn while painting
C: Default is FALSE Q: When queried, it returns a boolean
:param paintmode: (C Q E) Specifies the paint mode There are two possibilities: "screen"
and "tangent" C: Default is "screen" Q: When queried, it returns a string
:param paintoperationtype: (C Q E) Specifies the operation type used by the Paint Tool
Currently, we support the following paint modes: "Paint", "Smear", "Blur", "Erase" and
"Clone"
:param painttxtattr: (C Q E) Specifies the attribute on the shader which the user wants to
paint Currently, we support the following attributes: "Color", "Transparency", "Ambien
:param painttxtattrname: (Q E) Returns a string with the names of all paintable attributes
supported by the Paint Texture Tool
:param pfxScale: (Q E) Specifies the scale for Paint Effect brushes
:param pfxWidth: (Q E) Specifies the width for Paint Effect brushes
:param pickColor: (C Q E) Set pick color mode on or off
:param pickValue: (C Q E) Toggle for picking
:param playbackCursor: (C Q E M) Values for the playback cursor
:param playbackPressure: (C Q E M) Valus for the playback pressure
:param preserveclonesource: (C Q E) Whether or not to preserve a clone source
:param pressureMapping1: (C Q E) First pressure mapping value
:param pressureMapping2: (C Q E) Second pressure mapping value
:param pressureMapping3: (C Q E) Third pressure mapping value
:param pressureMax1: (C Q E) First pressure maximum value
:param pressureMax2: (C Q E) Second pressure maximum value
:param pressureMax3: (C Q E) Third pressure maximum value
:param pressureMin1: (C Q E) First pressure minimum value
:param pressureMin2: (C Q E) Second pressure minimum value
:param pressureMin3: (C Q E) Third pressure minimum value
:param profileShapeFile: (Q E) Passes a name of the image file for the stamp shape profile
:param projective: (C Q E) Specifies the projective paint mode C: Default is 'false' Q:
When queried, it returns a boolean
:param radius: (C Q E) Sets the size of the brush C: Default is 1.0 cm Q: When queried,
it returns a float
:param record: (C Q E) Toggle on for recording
:param reflection: (C Q E) Specifies the reflection mode C: Default is 'false' Q: When
queried, it returns a boolean
:param reflectionaboutorigin: (C Q E) Toggle on to reflect about the origin
:param reflectionaxis: (C Q E) Specifies the reflection axis There are three
possibilities: "x", "y" and "z" C: Default is "x" Q: When queried, it returns a string
:param reloadtexfile: (E) Sends a request to the tool to reload the texture from the disc
:param resizeratio: (Q E) Specifies the scale by which to resize the current textures
:param resizetxt: (E) Sends a request to the tool to resize all the currently in use
textures
:param rgbcolor: (C Q E) Colour value
:param rgbflood: (C Q E) Color of the flood
:param saveTextureOnStroke: (C Q E) States if the original texture will be automatically
saved on each stroke Default is false
:param saveonstroke: (C Q E) States if the temporary texture will be automatically saved on
each stroke Default is false
:param savetexture: (E) Sends a request to the tool to save the texture to the disc
:param screenRadius: (C Q E) Brush radius on the screen
:param selectclonesource: (C Q E) Toggle on to select the clone source
:param shadernames: (Q) Returns a string with the names of all shaders assigned to selected
surfaces
:param shapeattr: (Q E) States if the attribute to paint is an attribute of the shape and
not the shader Default is false
:param shapenames: (Q) Returns a string with the names of all surfaces which are being
painted on
:param showactive: (C Q E) Sets on/off the display of the surface isoparms C: Default is
TRUE Q: When queried, it returns a boolean
:param soloAsDiffuse: (Q E) States if the currently paintable texture will be rendered as
as diffuse texture in the viewport Default is false
:param stampDepth: (C Q E) Depth of the stamps
:param stampProfile: (C Q E) Sets the brush profile of the current stamp Currently, the
following profiles are supported: "gaussian", "poly", "solid" and "square" C: Default is
:param stampSpacing: (C Q E) Specifies the stamp spacing Default is 1.0
:param strokesmooth: (C Q E) Stroke smoothing type name
:param surfaceConformedBrushVertices: (C Q E) Enables/disables the the display of the
effective brush area as affected vertices
:param tablet: (Q) Returns true if the tablet device is present, false if it is absent
:param tangentOutline: (C Q E) Enables/disables the display of the brush circle tangent to
the surface
:param textureFilenames: (Q) Returns a string array with the names of all the painted file
textures
:param updateEraseTex: (C Q E) Should the erase texture update?
:param usepressure: (C Q E) Sets the tablet pressure on/off C: Default is false Q: When
queried, it returns a boolean
:param worldRadius: (C Q E) Radius in worldspace
:returns:
"""
pass
def DisableGlobalStitch(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolygonHardenEdge(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def perCameraVisibility(*args, camera: Union[name, bool]=None, exclusive: bool=True, hide:
bool=True, remove: bool=True, removeAll: bool=True, removeCamera:
bool=True, q=True, query=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The perCameraVisibility command creates, queries and removes visibility relationships
between DAG objects and cameras These relationships are applied in any viewport that uses
the cameras involved (They are not used e.g in rendering.) Objects can be set to be
exclusive to a camera (meaning they will only be displayed in viewports using that came
:param camera: (C Q) Specify the camera for the operation
:param exclusive: (C Q) Set objects as being exclusive to the given camera
:param hide: (C Q) Set objects as being hidden from the given camera
:param remove: (C) Used with exclusive or hide, removes the objects instead of adding them
:param removeAll: (C) Remove all exclusivity/hidden objects for all cameras
:param removeCamera: (C) Remove all exclusivity/hidden objects for the given camera
:returns: Command result
"""
pass
def dR_paintRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateHairCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TranslateToolWithSnapMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def deleteUI(*args, collection: bool=True, control: bool=True, editor: bool=True, layout:
bool=True, menu: bool=True, menuItem: bool=True, panel: bool=True, panelConfig:
bool=True, radioMenuItemCollection: bool=True, toolContext: bool=True, uiTemplate:
bool=True, window: bool=True, **kwargs)->None:
"""
This command deletes UI objects such as windows and controls Deleting a layout or window
will also delete all of its children If a flag is used then all objects being deleted must
be of the specified type This command may not be edited or queried NOTE: it is
recommended that the type flags be used to disambiguate different kinds of objects wit
:param collection: (C) Object names for deletion are all radio or tool collections
:param control: (C) Object names for deletion are all controls
:param editor: (C) Object names for deletion are all editors
:param layout: (C) Object names for deletion are all layouts
:param menu: (C) Object names for deletion are all menus
:param menuItem: (C) Object names for deletion are all menu items
:param panel: (C) Object names for deletion are all panels
:param panelConfig: (C) Object names for deletion are panel configurations
:param radioMenuItemCollection: (C) Object names for deletion are all radio menu item
collections
:param toolContext: (C) Object names for deletion are all tool contexts
:param uiTemplate: (C) Object names for deletion are all UI templates
:param window: (C) Object names for deletion are all windows
:returns:
"""
pass
def characterize(*args, activatePivot: bool=True, addAuxEffector: bool=True,
addFloorContactPlane: bool=True, addMissingEffectors: bool=True,
attributeFromHIKProperty: Union[AnyStr, bool]="",
attributeFromHIKPropertyMode: Union[AnyStr, bool]="", autoActivateBodyPart:
bool=True, changePivotPlacement: bool=True, effectors: AnyStr="", fkSkeleton:
AnyStr="", name: AnyStr="", pinHandFeet: bool=True, placeNewPivot: bool=True,
posture: AnyStr="biped", sourceSkeleton: AnyStr="", stancePose: Union[AnyStr,
bool]="", type: AnyStr="name", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command is used to scan a joint hierarchy for predefined joint names or labels If the
required joints are found, human IK effectors will be created to control the skeleton using
full-body IK Alternatively, you can manually create all of the components required for
fullbody IK, and use this command to hook them up Fullbody IK needs 3 major c
:param activatePivot: (E) Activates a pivot that has been properly placed After activating
this new pivot, you will now be able to rotate and translate about this pivot A pi
:param addAuxEffector: (E) Adds an auxilliary (secondary) effector to an existing effector
:param addFloorContactPlane: (E) Adds a floor contact plane to one of the hands or feet
With this plane, you will be able to adjust the floor contact height Select a hand or foot
e
:param addMissingEffectors: (E) This flag tells the characterize command to look for any
effectors that can be added to the skeleton For example, if the user has deleted some
effec
:param attributeFromHIKProperty: (Q) Query for the attribute name associated with a
MotionBuilder property
:param attributeFromHIKPropertyMode: (Q) Query for the attribute name associated with a
MotionBuilder property mode
:param autoActivateBodyPart: (Q E) Query or change whether auto activation of character
nodes representing body parts should be enabled
:param changePivotPlacement: (E) Reverts a pivot back into pivot placement mode A pivot
that is in placement mode will not participate in full body manipulation until it has been
ac
:param effectors: (C) Specify the effectors to be used by human IK by providing 2 pieces of
information for each effector: 1) the partial path of the effector and 2) the n
:param fkSkeleton: (C E) Specify the fk skeleton to be used by human IK by providing 2
pieces of information for each joint of the FK skeleton: 1) the partial path of the joi
:param name: (C) At characterization (FBIK creation) time, use this flag to name your FBIK
character This will affect the name of the hikHandle node and the control
:param pinHandFeet: (C) When the character is first being characterized, pin the hands and
feet by default
:param placeNewPivot: (E) Creates a new pivot and puts it into placement mode Note that
you will not be able to do full body manipulation about this pivot until you have acti
:param posture: (C) Specifies the posture of the character Valid options are "biped" and
"quadruped" The default is "biped"
:param sourceSkeleton: (C E) This flag can be used to characterize a skeleton that has not
been named or labelled according to the FBIK guidelines It specifies the association b
:param stancePose: (C Q) Specify the default stance pose to be used by human IK The stance
pose is specified by providing 2 pieces of information for each joint involved in
:param type: (C) Specifies the technique used by the characterization to identify the joint
type Valid options are "label" and "name" When "label" is used, the join
:returns: Names of full body IK effectors that were created.
"""
pass
def curveBezierCtx(*args, **kwargs)->None:
"""
"""
pass
def DeleteAllClusters(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def saveFluid(*args, currentTime: Union[int, bool]=0, endTime: Union[int, bool]=0, startTime:
Union[int, bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[None,
Any]:
"""
A command to save the current state of the fluid to the initial state cache The grids to
be saved are determined by the cache attributes: cacheDensity, cacheVelocity, etc These
attributes are normally set from the options on Set Initial State The cache must be set up
before invoking this command
:param currentTime: (C Q E) cache state of fluid at current time
:param endTime: (C Q E) end Time for cacheing
:param startTime: (C Q E) start Time for cacheing
:returns:
"""
pass
def RemoveBrushSharing(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nucleusGetnClothExample(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorRippleEditTogglePress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleLayerBar(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleModelEditorBars(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowNURBSCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonCylinderOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyUVOverlap(*args, nonOverlappingComponents: bool=True, overlappingComponents: bool=True,
**kwargs)->List[selectionItem]:
"""
Return the required result on the specified components
:param nonOverlappingComponents: (C) Return non-overlapping components based on
selected/specified components
:param overlappingComponents: (C) Return overlapping components based on selected/specified
components
:returns: List of poly components
"""
pass
def PaintOperationMarkingMenuPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def geometryReplaceCacheFramesOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectIsolate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertSelectionToUVBorder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DecreaseExposureCoarse(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TogglePanZoomPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ApplySettingsToLastStroke(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllMotionPaths(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DetachVertexComponent(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateConstraintOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_conform(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def STRSTweakModeOn(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def listInputDevices(*args, free: bool=True, primary: bool=True, secondary: bool=True,
**kwargs)->List[AnyStr]:
"""
This command lists all input devices that maya knows about
:param free: (C) List the free devices
:param primary: (C) List the primary devices
:param secondary: (C) List the secondary devices
:returns: Command result
"""
pass
def MakePondBoats(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowNRigids(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SculptMeshUnfreezeAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowHairSystems(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RigidBindSkinOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyColorDel(*args, caching: bool=True, colorSetName: Union[AnyStr, bool]="",
constructionHistory: bool=True, name: AnyStr="", nodeState: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Deletes color from selected components
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param colorSetName: (C Q E) The name of the color set to work on
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def SelectUVNonOverlappingComponentsPerObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisplayIntermediateObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowNCloths(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MergeVertices(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConnectNodeToIKFK(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hikRigAlign(*args, **kwargs)->None:
"""
"""
pass
def hikManip(*args, **kwargs)->None:
"""
"""
pass
def polyCollapseEdge(*args, caching: bool=True, constructionHistory: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Turns each selected edge into a point
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def NodeEditorShapeMenuStateNoShapes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonPyramidOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TrimTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TangentsFlat(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def timeEditorTracks(*args, activeClipWeight: Union[time, bool]=None, activeClipWeightId:
Union[time, bool]=None, addTrack: int=0, allClips: bool=True, allTracks:
bool=True, allTracksRecursive: bool=True, composition: bool=True, path:
AnyStr="", plugIndex: Union[int, bool]=0, removeTrack: Union[int,
List[int]]=0, removeTrackByPath: Union[AnyStr, List[AnyStr]]="",
reorderTrack: List[int, int]=None, resetMute: bool=True, resetSolo:
bool=True, selectedTracks: bool=True, trackGhost: bool=True, trackIndex:
Union[int, bool]=0, trackMuted: bool=True, trackName: Union[AnyStr,
bool]="", trackSolo: bool=True, trackType: Union[int, bool]=1, q=True,
query=True, e=True, edit=True, **kwargs)->Union[Int, Any]:
"""
Time Editor tracks commands
:param activeClipWeight: (Q) Get the clip weight at the specified time
:param activeClipWeightId: (Q) Get the clip ID carrying the active clip weight at the
specified time
:param addTrack: (E) Add new track at the track index specified Indices are 0-based
Specify -1 to add the track at the end
:param allClips: (Q) Return a list of clip IDs under the specified track
:param allTracks: (Q) Return a list of strings for all the immediate tracks for the given
tracks node in the format "tracksNode:trackIndex"
:param allTracksRecursive: (Q) Return a list of strings for all the tracks for the given
tracks node, or return a list of strings for all tracks of all tracks nodes in the format
"
:param composition: (Q) Return the composition the specified track belongs to
:param path: (E) Full path of a track node or a track on which to operate For example:
composition1|track1|group; composition1|track1 In query mode, this flag can a
:param plugIndex: (Q E) Get the plug index of the specified track
:param removeTrack: (E M) Remove track at given index It is a multi-use flag
:param removeTrackByPath: (E M) Remove track at given path It is a multi-use flag For
example: composition1|track1|group|track1;
:param reorderTrack: (E) Move the track relative to other tracks The first argument is the
track index (0-based) The second argument can be a positive or negative number to
:param resetMute: (C) Reset all the muted tracks in the active composition
:param resetSolo: (C) Reset the soloing of all tracks on the active composition
:param selectedTracks: (Q) Return a list of the indices for all the selected tracks for the
given tracks node, or return a list of strings for all selected tracks of all tracks
:param trackGhost: (Q E) Ghost all clips under track
:param trackIndex: (Q E) Specify the track index This flag is used in conjunction with the
other flags In query mode, this flag can accept a value
:param trackMuted: (Q E) Return whether the track is muted
:param trackName: (Q E) Display name of the track
:param trackSolo: (Q E) Return whether the track is soloed
:param trackType: (Q E) Specify the track type Can only be used together with -at/addTrack
Does not work by itself In query mode, return the integer corresponding to the
:returns: In edit mode, return the newly created Track index.
"""
pass
def FlipTubeDirection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AnimLayerRelationshipEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hotkeyCtx(*args, addClient: Union[AnyStr, List[AnyStr]]="", clientArray: bool=True,
currentClient: Union[AnyStr, bool]="", insertTypeAt: List[AnyStr, AnyStr]=None,
removeAllClients: bool=True, removeClient: Union[AnyStr, List[AnyStr]]="",
removeType: AnyStr="", type: Union[AnyStr, bool]="", typeArray: bool=True,
typeExists: Union[AnyStr, bool]="", q=True, query=True, **kwargs)->Union[None,
Any]:
"""
This command sets the hotkey context for the entire application
:param addClient: (C M) Associates a client to the given hotkey context type This flag
needs to be used with the flag "type" which specifies the context type
:param clientArray: (Q) Returns an array of the all context clients associated to the
hotkey context type This flag needs to be used with the flag "type" which specifies th
:param currentClient: (C Q) Current client for the given hotkey context type This flag
needs to be used with the flag "type" which specifies the context type
:param insertTypeAt: (C) Inserts a new hotkey context type in the front of the given type
The first argument specifies an existing type If it's empty, the new context type
:param removeAllClients: (C) Removes all the clients associated to the hotkey context type
This flag needs to be used with the flag "type" which specifies the context type
:param removeClient: (C M) Removes a client associated to the hotkey context type This
flag needs to be used with the flag "type" which specifies the context type
:param removeType: (C) Removes the given hotkey context type
:param type: (C Q) Specifies the context type It's used together with the other flags such
as "currentClient", "addClient", "removeClient" and so on
:param typeArray: (Q) Returns a string array containing the names of all hotkey context
types, ordered by priority
:param typeExists: (Q) Returns true|false depending upon whether the specified hotkey
context type exists In query mode, this flag needs a value
:returns:
"""
pass
def dR_viewBack(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dynWireCtx(*args, **kwargs)->None:
"""
"""
pass
def loadPrefObjects(*args, **kwargs)->bool:
"""
This command loads preference dependency nodes from "userPrefObjects.ma", if it exists,
from the user preference directory
:returns: True if successful.
"""
pass
def polyCompare(*args, colorSetIndices: bool=True, colorSets: bool=True, edges: bool=True,
faceDesc: bool=True, userNormals: bool=True, uvSetIndices: bool=True, uvSets:
bool=True, vertices: bool=True, **kwargs)->int:
"""
Compares two Polygonal Geometry objects with a fine control on what to compare
:param colorSetIndices: (C) Compare poly1, poly2 for matching Color Indices
:param colorSets: (C) Compare poly1, poly2 for matching Color Sets
:param edges: (C) Compare poly1, poly2 for matching Edges
:param faceDesc: (C) Compare poly1, poly2 for matching Face Descriptions Face descriptions
describe the topology of a face, for example number and orientation of edges,
:param userNormals: (C) Compare poly1, poly2 for matching User Normals
:param uvSetIndices: (C) Compare poly1, poly2 for matching UV Indices
:param uvSets: (C) Compare poly1, poly2 for matching UV Sets
:param vertices: (C) Compare poly1, poly2 for matching Vertices
:returns: 0 if successful, non-zero if poly1 and poly2 are not determined to be equal based
on requested flags.
The non-zero value depends on which attributes are different:
Vertices
= 1
Edges = 2
Face Descriptions = 4
UV Sets = 8
UV
Indices = 16
Color Sets = 32
Color Indices = 64
User Normals = 128
So a return value of 3, for example, indicates both vertices and edges are different.
"""
pass
def softMod(*args, after: bool=True, afterReference: bool=True, before: bool=True, bindState:
bool=True, curveInterpolation: Union[int, List[int]]=0, curvePoint: Union[float,
List[float]]=0.0, curveValue: Union[float, List[float]]=0.0, deformerTools:
bool=True, envelope: Union[float, bool]=1.0, exclusive: Union[AnyStr, bool]="",
falloffAroundSelection: bool=True, falloffBasedOnX: bool=True, falloffBasedOnY:
bool=True, falloffBasedOnZ: bool=True, falloffCenter: List[float, float,
float]=None, falloffMasking: bool=True, falloffMode: int=0, falloffRadius:
float=0.0, frontOfChain: bool=True, geometry: Union[AnyStr, List[AnyStr], bool]="",
geometryIndices: bool=True, ignoreSelected: bool=True, includeHiddenSelections:
bool=False, name: AnyStr="", parallel: bool=True, prune: bool=True, relative:
bool=True, remove: Union[bool, List[bool]]=True, resetGeometry: bool=True, split:
bool=True, weightedNode: Union[List[AnyStr, AnyStr], bool]=None, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The softMod command creates a softMod or edits the membership of an existing softMod The
command returns the name of the softMod node upon creation of a new softMod
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param bindState: (C) Specifying this flag adds in a compensation to ensure the softModed
objects preserve their spatial position when softModed This is required to preve
:param curveInterpolation: (C M) Ramp interpolation corresponding to the specified
curvePoint position Integer values of 0-3 are valid, corresponding to "none", "linear",
"smooth" a
:param curvePoint: (C M) Position of ramp value on normalized 0-1 scale This flag may only
be used in conjunction with the curveInterpolation and curveValue flags
:param curveValue: (C M) Ramp value corresponding to the specified curvePoint position
This flag may only be used in conjunction with the curveInterpolation and curvePoint f
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param envelope: (C Q E) Set the envelope value for the deformer Default is 1.0
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param falloffAroundSelection: (C) Falloff will be calculated around any selected
components
:param falloffBasedOnX: (C) Falloff will be calculated using the X component
:param falloffBasedOnY: (C) Falloff will be calculated using the Y component
:param falloffBasedOnZ: (C) Falloff will be calculated using the Z component
:param falloffCenter: (C) Set the falloff center point of the softMod
:param falloffMasking: (C) Deformation will be restricted to selected components
:param falloffMode: (C) Set the falloff method used for the softMod
:param falloffRadius: (C) Set the falloff radius of the softMod
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param name: (C) Used to specify the name of the node being created
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param relative: (C) Enable relative mode for the softMod In relative mode, Only the
transformations directly above the softMod are used by the softMod Default is off
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param resetGeometry: (E) Reset the geometry matrices for the objects being deformed by the
softMod This flag is used to get rid of undesirable effects that happen if you sca
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:param weightedNode: (C Q E) Transform node in the DAG above the softMod to which all
percents are applied The second node specifies the descendent of the first node from
where
:returns: [] (the softMod node name and the softMod handle name)
"""
pass
def AddSelectionAsCombinationTarget(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetClumpBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateCurveFromPoly(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Vortex(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetWidthBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def snapTogetherCtx(*args, clearSelection: bool=True, exists: bool=True, history: bool=True,
image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", name: AnyStr="", setOrientation: bool=True,
snapPolygonFace: bool=False, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
The snapTogetherCtx command creates a tool for snapping surfaces together
:param clearSelection: (C Q E) Sets whether the tool should clear the selection on entry to
the tool Default true
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param setOrientation: (C Q E) Sets whether the tool should orient as well as moving an
item Default true
:param snapPolygonFace: (C Q E) Sets whether the tool should snap the cursor to polygon
face centers Default false
:returns: (name of the new context)
"""
pass
def stringArrayIntersector(*args, allowDuplicates: bool=False, defineTemplate: AnyStr="",
exists: bool=True, intersect: List[AnyStr]=None, reset: bool=True,
useTemplate: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
The stringArrayIntersector command creates and edits an object which is able to efficiently
intersect large string arrays The intersector object maintains a sense of "the
intersection so far", and updates the intersection when new string arrays are provided
using the -i/intersect flag Note that the string intersector object may be deleted using
:param allowDuplicates: (C) Should the intersector allow duplicates in the input arrays
(true), or combine all duplicate entries into a single, unique entry (false) This flag m
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param intersect: (C E) Intersect the specified string array with the current intersection
being maintained by the intersector
:param reset: (E) Reset the intersector to begin a new intersection
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the intersector.
"""
pass
def ToggleShelf(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateOcean(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SnapToCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RotateToolMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NonSacredTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sets(*args, addElement: name=None, afterFilters: bool=True, clear: name=None, color:
Union[int, bool]=0, copy: name=None, edges: bool=True, editPoints: bool=True, empty:
bool=True, facets: bool=True, flatten: name=None, forceElement: name=None, include:
name=None, intersection: name=None, isIntersecting: name=None, isMember: name=None,
layer: bool=True, name: AnyStr="", noSurfaceShader: bool=True, noWarnings: bool=True,
nodesOnly: bool=True, remove: name=None, renderable: bool=True, size: bool=True,
split: name=None, subtract: name=None, text: Union[AnyStr, bool]="", union: name=None,
vertices: bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command is used to create a set, query some state of a set, or perform operations to
update the membership of a set A set is a logical grouping of an arbitrary collection of
objects, attributes, or components of objects Sets are dependency nodes Connections from
objects to a set define membership in the set Sets are used throughout Maya i
:param addElement: (E) Adds the list of items to the given set If some of the items cannot
be added to the set because they are in another set which is in the same partiti
:param afterFilters: (E) Default state is false This flag is valid in edit mode only This
flag is for use on sets that are acted on by deformers such as sculpt, lattice, bl
:param clear: (E) An operation which removes all items from the given set making the set
empty
:param color: (C Q E) Defines the hilite color of the set Must be a value in range [-1, 7]
(one of the user defined colors) -1 marks the color has being undefined and th
:param copy: (C) Copies the members of the given set to a new set This flag is for use in
creation mode only
:param edges: (C Q) Indicates the new set can contain edges only This flag is for use in
creation or query mode only The default value is false
:param editPoints: (C Q) Indicates the new set can contain editPoints only This flag is
for use in creation or query mode only The default value is false
:param empty: (C) Indicates that the set to be created should be empty That is, it ignores
any arguments identifying objects to be added to the set This flag is only
:param facets: (C Q) Indicates the new set can contain facets only This flag is for use in
creation or query mode only The default value is false
:param flatten: (E) An operation that flattens the structure of the given set That is, any
sets contained by the given set will be replaced by its members so that the s
:param forceElement: (E) For use in edit mode only Forces addition of the items to the set
If the items are in another set which is in the same partition as the given set,
:param include: (E) Adds the list of items to the given set If some of the items cannot be
added to the set, a warning will be issued This is a less strict version of
:param intersection: (C) An operation that returns a list of items which are members of all
the sets in the list
:param isIntersecting: (C) An operation which tests whether the sets in the list have
common members
:param isMember: (C) An operation which tests whether all the given items are members of
the given set
:param layer: (C) OBSOLETE DO NOT USE
:param name: (C) Assigns string as the name for a new set This flag is only valid for
operations that create a new set
:param noSurfaceShader: (C) If set is renderable, do not connect it to the default surface
shader Flag has no meaning or effect for non renderable sets This flag is for use in
:param noWarnings: (C) Indicates that warning messages should not be reported such as when
trying to add an invalid item to a set (used by UI)
:param nodesOnly: (Q) This flag is usable with the -q/query flag but is ignored if used
with another queryable flags This flag modifies the results of the set membership
:param remove: (E) Removes the list of items from the given set
:param renderable: (C Q) This flag indicates that a special type of set should be created
This type of set (shadingEngine as opposed to objectSet) has certain restrictions o
:param size: (Q) Use the size flag to query the length of the set
:param split: (C) Produces a new set with the list of items and removes each item in the
list of items from the given set
:param subtract: (C) An operation between two sets which returns the members of the first
set that are not in the second set
:param text: (C Q E) Defines an annotation string to be stored with the set
:param union: (C) An operation that returns a list of all the members of all sets listed
:param vertices: (C Q) Indicates the new set can contain vertices only This flag is for
use in creation or query mode only The default value is false
:returns: For creation operations (name of the set that was created or edited)
"""
pass
def CycleFBIKReachKeyingOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBifrostGuide(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ReversePolygonNormalsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisableTimeChangeUndoConsolidation(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphEditorNormalizedView(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ProfilerToolReset(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def stitchSurfacePoints(*args, bias: Union[float, bool]=1.0, caching: bool=True, cvIthIndex:
Union[int, List[int], bool]=1, cvJthIndex: Union[int, List[int],
bool]=1, fixBoundary: bool=False, nodeState: Union[int, bool]=0,
parameterU: Union[float, List[float], bool]=10000, parameterV:
Union[float, List[float], bool]=10000, positionalContinuity: Union[bool,
List[bool]]=True, stepCount: Union[int, List[int], bool]=20,
tangentialContinuity: Union[bool, List[bool]]=False,
togglePointNormals: bool=False, togglePointPosition: bool=True,
toggleTolerance: Union[bool, List[bool]]=False, tolerance: Union[float,
List[float], bool]=0.1, cascade: bool=False, constructionHistory:
bool=True, equalWeight: bool=True, keepG0Continuity: bool=True,
keepG1Continuity: bool=False, name: AnyStr="", object: bool=True,
replaceOriginal: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The stitchSurfacePoints command aligns two or more surface points along the boundaries
together to a single point In the process, a node to average the points is created The
points are averaged together in a weighted fashion The points may be control vertices
along the boundaries If the points are CVs then they are stitched together only with
p
:param bias: (C Q E) Blend CVs in between input surface and result from stitch A value of
0.0 returns the input surface Default: 1.0
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param cvIthIndex: (C Q E M) The ith boundary CV index on the input surface Default: -1
:param cvJthIndex: (C Q E M) The jth boundary CV index on the input surface Default: -1
:param fixBoundary: (C Q E) Fix Boundary CVs while solving for any G1 constraints Default:
false
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param parameterU: (C Q E M) The U parameter value on surface for a point constraint
Default: -10000
:param parameterV: (C Q E M) The V parameter value on surface for a point constraint
Default: -10000
:param positionalContinuity: (C Q E M) Toggle on (off) G0 continuity at edge corresponding
to multi index Default: true
:param stepCount: (C Q E M) Step count for the number of discretizations Default: 20
:param tangentialContinuity: (C Q E M) Toggle on (off) G1 continuity across edge
corresponding to multi index Default: false
:param togglePointNormals: (C Q E) Toggle on (off) normal point constraints on the surface
Default: false
:param togglePointPosition: (C Q E) Toggle on (off) position point constraints on the
surface Default: true
:param toggleTolerance: (C Q E M) Toggle on (off) so as to use Tolerance or specified steps
for discretization Default: false
:param tolerance: (C Q E M) Tolerance to use while discretizing the edge Default: 0.1
:param cascade: (C) Cascade the created stitch node (Only if the surface has a stitch
history) Default is 'false'
:param constructionHistory: (C) Turn the construction history on or off
:param equalWeight: (C) Assign equal weights to all the points being stitched together
Default is 'true' If false, the first point is assigned a weight of 1.0 and the rest
:param keepG0Continuity: (C) Stitch together the points with positional continuity Default
is 'true'
:param keepG1Continuity: (C) Stitch together the points with tangent continuity Default is
'false'
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def PolyExtrudeFaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def trackCtx(*args, alternateContext: bool=True, exists: bool=True, history: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", toolName: Union[AnyStr, bool]="", trackGeometry:
bool=True, trackScale: Union[float, bool]=0.0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create a track context
:param alternateContext: (C Q) Set the ALT+MMB and ALT+SHIFT+MMB to refer to this context
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param toolName: (C Q) Name of the specific tool to which this command refers
:param trackGeometry: (C Q E) Toggle whether the drag should try to track geometry The
context will compute a track plane by intersecting the initial press with geometry or the
l
:param trackScale: (C Q E) Specify the distance to the track plane from the camera The
smaller the scale the slower the drag
:returns: The name of the context
"""
pass
def ProfilerToolShowSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NURBSSmoothnessFineOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_activeHandleXYZ(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EnableParticles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def undo(*args, **kwargs)->None:
"""
Takes the most recent command from the undo list and undoes it
:returns:
"""
pass
def subdLayoutUV(*args, caching: bool=True, nodeState: Union[int, bool]=0, constructionHistory:
bool=True, flipReversed: bool=True, layout: Union[int, bool]=0, layoutMethod:
Union[int, bool]=0, name: AnyStr="", percentageSpace: Union[float, bool]=0.0,
rotateForBestFit: Union[int, bool]=0, scale: Union[int, bool]=0, separate:
Union[int, bool]=0, worldSpace: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Move UVs in the texture plane to avoid overlaps
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param constructionHistory: (C) Turn the construction history on or off
:param flipReversed: (C Q E) If this flag is turned on, the reversed UV pieces are fliped
:param layout: (C Q E) How to move the UV pieces, after cuts are applied: 0 No move is
applied 1 Layout the pieces along the U axis 2 Layout the pieces in a square shape
:param layoutMethod: (C Q E) Which layout method to use: 0 Block Stacking 1 Shape
Stacking
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param percentageSpace: (C Q E) When layout is set to square, this value is a percentage of
the texture area which is added around each UV piece It can be used to ensure each UV pi
:param rotateForBestFit: (C Q E) 0 No rotation is applied 1 Only allow 90 degree rotations
2 Allow free rotations
:param scale: (C Q E) How to scale the pieces, after move and cuts: 0 No scale is applied
1 Uniform scale to fit in unit square 2 Non proportional scale to fit in unit s
:param separate: (C Q E) Which UV edges should be cut: 0 No cuts 1 Cut only along folds 2
Make all necessary cuts to avoid all intersections
:param worldSpace: (C Q E) If true, performs the operation in world space coordinates as
opposed to local space
:returns: The node name.
"""
pass
def mpBirailCtx(*args, **kwargs)->None:
"""
"""
pass
def u3dTopoValid(*args, **kwargs)->None:
"""
"""
pass
def AssignHairConstraintOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CustomPolygonDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshScrapeToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PointOnPolyConstraintOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateDirectionalLightOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_tweakRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EnableAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def refreshEditorTemplates(*args, **kwargs)->None:
"""
This command refreshes all cached attribute editor templates, including those copied from
the standard AE These are the templates constructed internally on a per node type basis
This is useful if attribute elements have changed and the templates need to be re-evaluated
accordingly
:returns:
"""
pass
def MatchTranslation(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SurfaceFlowOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtrudeEdgeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorSelectDownStream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddToContainer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateHair(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TestTextureOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeOpenBrowserWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyDelEdge(*args, caching: bool=True, cleanVertices: bool=True, constructionHistory:
bool=True, name: AnyStr="", nodeState: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Deletes selected edges, and merges neighboring faces If deletion leaves winged vertices,
they may be deleted as well
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param cleanVertices: (C Q E) If on : delete resulting winged vertices C: Default is "off"
Q: When queried, this flag returns an int
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def ProfilerToolShowSelectedRepetition(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def clipMatching(*args, clipDst: List[AnyStr, float]=None, clipSrc: List[AnyStr, float]=None,
matchRotation: int=0, matchTranslation: int=0, **kwargs)->None:
"""
This command is used to compute an offset to apply on a source clip in order to
automatically align it to a destination clip at a specified match element For this command
to work, offset objects must be specified for the character
:param clipDst: (C) The clip to match so that the source clip can be offsetted correctly
This flag takes in a clip name and the percentage value ranging from 0.0 to 1.0
:param clipSrc: (C) The clip to offset so that it aligns with the destination clip This
flag takes in a clip name and the percentage value ranging from 0.0 to 1.0 in or
:param matchRotation: (C) This flag sets the rotation match type By default, it is set to
not match the rotation 0 - None 1 - Match full rotation 2 - Match projected rotatio
:param matchTranslation: (C) This flag sets the translation match type By default, it is
set to not match the translation 0 - None 1 - Match full translation 2 - Match projecte
:returns:
"""
pass
def XgmSetSelectBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NormalizeUVsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def condition(*args, delete: bool=True, dependency: Union[AnyStr, List[AnyStr]]="", initialize:
bool=True, script: AnyStr="", state: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
This command creates a new named condition object whose true/false value is calculated by
running a mel script This new condition can then be used for dimming, or controlling other
scripts, or whatever
:param delete: (C) Deletes the condition
:param dependency: (C M) Each -dependency flag specifies another condition that the new
condition will be dependent on When any of these conditions change, the new-state-scr
:param initialize: (C) Initializes the condition, by forcing it to run its script as soon
as it is created If this flag is not specified, the script will not run until one
:param script: (C) The script that determines the new state of the condition
:param state: (C Q E) Sets the state of the condition This can be used to create a
manually triggered condition: you could create a condition without any dependencies and
:returns:
"""
pass
def TwoPointArcToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GrowPolygonSelectionRegion(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def makeLive(*args, none: bool=True, **kwargs)->None:
"""
This commmand makes an object live A live object defines the surface on which to create
objects and to move object relative to Only construction planes, nurbs surfaces and
polygon meshes can be made live The makeLive command expects one of these types of
objects as an explicit argument If no argument is explicitly specified, then there are a
n
:param none: (C) If the -n/none flag, the live object will become dormant Use of this flag
causes any arguments to be ignored
:returns:
"""
pass
def fluidDeleteCacheFrames(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def blendShapeEditor(*args, control: bool=True, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", exists: bool=True, filter: Union[AnyStr, bool]="",
forceMainConnection: Union[AnyStr, bool]="", highlightConnection:
Union[AnyStr, bool]="", lockMainConnection: bool=True, mainListConnection:
Union[AnyStr, bool]="", panel: Union[AnyStr, bool]="", parent:
Union[AnyStr, bool]="", selectionConnection: Union[AnyStr, bool]="",
stateString: bool=True, targetControlList: bool=True, targetList:
bool=True, unParent: bool=True, unlockMainConnection: bool=True,
updateMainConnection: bool=True, useTemplate: AnyStr="", verticalSliders:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command creates an editor that derives from the base editor class that has controls
for blendShape, control nodes
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param targetControlList: (Q)
:param targetList: (Q)
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param verticalSliders: (C Q E)
:returns: The name of the editor
"""
pass
def TimeEditorClipScaleStart(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RepeatLastActionAtMousePosition(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AnimationSweep(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CutCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def matchTransform(*args, pivots: bool=True, position: bool=True, rotation: bool=True, scale:
bool=True, **kwargs)->None:
"""
This command modifies the source object's transform to match the target object's transform
If no flags are specified then the command will match position, rotation and scaling
:param pivots: (C) Match the source object(s) scale/rotate pivot positions to the target
transform's pivot
:param position: (C) Match the source object(s) position to the target object
:param rotation: (C) Match the source object(s) rotation to the target object
:param scale: (C) Match the source object(s) scale to the target transform
:returns:
"""
pass
def DeleteAttribute(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySplitCtx(*args, enablesnap: bool=True, exists: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
magnetsnap: Union[int, bool]=0, precsnap: Union[float, bool]=0.0,
smoothingangle: Union[float, bool]=0.0, snaptoedge: bool=True, subdivision:
Union[int, bool]=1, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
Create a new context to split facets on polygonal objects
:param enablesnap: (C Q E) Enable/disable custom magnet snapping to start/middle/end of
edge
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param magnetsnap: (C Q E) number of extra magnets to snap onto, regularly spaced along the
edge
:param precsnap: (C Q E) precision for custom magnet snapping Range[0,100] Value 100
means any click on an edge will snap to either extremities or magnets
:param smoothingangle: (C Q E) the threshold that controls whether newly created edges are
hard or soft
:param snaptoedge: (C Q E) Enable/disable snapping to edge If enabled any click in the
current face will snap to the closest valid edge If there is no valid edge, the click w
:param subdivision: (C Q E) number of sub-edges to add between 2 consecutive edge points
Default is 1
:returns:
"""
pass
def HypergraphIncreaseDepth(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyCube(*args, axis: Union[List[float, float, float], bool]=None, caching: bool=True,
constructionHistory: bool=True, createUVs: Union[int, bool]=3, depth: Union[float,
bool]=1.0, height: Union[float, bool]=1.0, name: AnyStr="", nodeState: Union[int,
bool]=0, object: bool=True, subdivisionsDepth: Union[int, bool]=1,
subdivisionsHeight: Union[int, bool]=1, subdivisionsWidth: Union[int, bool]=1,
subdivisionsX: Union[int, bool]=1, subdivisionsY: Union[int, bool]=1,
subdivisionsZ: Union[int, bool]=1, texture: Union[int, bool]=1, width: Union[float,
bool]=1.0, q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr],
Any]:
"""
The cube command creates a new polygonal cube
:param axis: (C Q E) This flag specifies the primitive axis used to build the cube Q: When
queried, this flag returns a float[3]
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createUVs: (C Q E) Create UVs or not 0: No UVs 1: No Normalization 2: Normalize
Each Face Separately 3: Normalize Collectively 4: Normalize and Preserve Aspect Ratio D
:param depth: (C Q E) Depth of the cube Default: 1.0
:param height: (C Q E) Height of the cube Default: 1.0
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node (where applicable)
:param subdivisionsDepth: (C Q E) Subdivisions along the depth of the cube Default: 1
:param subdivisionsHeight: (C Q E) Subdivisions along the height of the cube Default: 1
:param subdivisionsWidth: (C Q E) Subdivisions along the width of the cube Default: 1
:param subdivisionsX: (C Q E) This specifies the number of subdivisions in the X direction
for the cube C: Default is 1 Q: When queried, this flag returns an int
:param subdivisionsY: (C Q E) This flag specifies the number of subdivisions in the Y
direction for the cube C: Default is 1 Q: When queried, this flag returns an int
:param subdivisionsZ: (C Q E) This flag specifies the number of subdivisions in the Z
direction for the cube C: Default is 1 Q: When queried, this flag returns an int
:param texture: (C Q E) What texture mechanism to be applied 0=No textures; 1=Object;
2=Faces Default: 1
:param width: (C Q E) Width of the cube Default: 1.0
:returns: Object name and node name.
"""
pass
def gradientControl(*args, adaptiveScaling: bool=True, annotation: Union[AnyStr, bool]="",
attribute: name=None, backgroundColor: Union[List[float, float, float],
bool]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists:
bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, manage: bool=True, noBackground: bool=True, numberOfControls:
Union[int, bool]=0, numberOfPopupMenus: bool=True, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
refreshOnRelease: Union[int, bool]=0, selectedColorControl: AnyStr="",
selectedInterpControl: AnyStr="", selectedPositionControl: AnyStr="",
staticNumberOfControls: bool=False, staticPositions: bool=False,
statusBarMessage: AnyStr="", upperLimitControl: Union[AnyStr, bool]="",
useTemplate: AnyStr="", verticalLayout: bool=False, visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a control that displays the gradient attribute specified The gradient
attribute must be of the correct form and naming It should be a multi attribute with each
entry a compound composed of: Either a color compound or a float value (the control will
automatically detect which and display a ramp or graph accordingly) A single
:param adaptiveScaling: (C Q E) Allow the ramp widget display to scale vertically to
accommodate values greater than 1.0 True if adaptive scaling is enabled, false (the
default) if
:param annotation: (C Q E) Annotate the control with an extra string value
:param attribute: (C) Specifies the name of the gradient attribute to control
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfControls: (Q) Returns the number of controls in the ramp widget
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param refreshOnRelease: (C Q E) Define how updates are dispatched during interactive
editing of the ramp widget True causes updates to only dispatch after releasing the mouse
butto
:param selectedColorControl: (C E) Specifies the name of a color control to edit the
selected color
:param selectedInterpControl: (C E) Specifies the name of an enum control to edit the
selected interpolation
:param selectedPositionControl: (C E) Specifies the name of a float slider to edit the
selected position
:param staticNumberOfControls: (C Q E) When 'true', this flag disables the
creation/deletion of ramp entries (control points) via ramp widget interaction Default is
false
:param staticPositions: (C Q E) When 'true', this flag disables the interactive
modification of ramp entry positions Default is false
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param upperLimitControl: (C Q E) Specify the name of a text control which is updated with
the current upper display limit for the ramp This option is only effective when
adaptiveSca
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param verticalLayout: (C Q E) When 'true', this makes the control orient vertically rather
than horizontally The default is `false` or horizontal
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the port created or modified
"""
pass
def FrameSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def viewManip(*args, bottomLeft: bool=True, bottomRight: bool=True, compassAngle: Union[float,
bool]=0.0, dragSnap: bool=True, drawCompass: bool=True, fitToView: bool=True,
frontParameters: Union[AnyStr, bool]="", goDefault: bool=True, goHome: bool=True,
homeParameters: Union[AnyStr, bool]="", levelCamera: bool=True, minOpacity:
Union[float, bool]=0.0, namespace: Union[AnyStr, bool]="", postCommand:
Union[AnyStr, bool]="", preCommand: Union[AnyStr, bool]="", preserveSceneUp:
bool=True, resetFront: bool=True, resetHome: bool=True, restoreCenter: bool=True,
selectionLockParameters: Union[AnyStr, bool]="", setFront: bool=True, setHome:
bool=True, size: Union[AnyStr, bool]="", toggleSelectionLock: bool=True, topLeft:
bool=True, topRight: bool=True, visible: bool=True, zoomToFitScene: bool=True,
q=True, query=True, **kwargs)->Union[None, Any]:
"""
Mel access to the view cube manipulator
:param bottomLeft: (C Q) Positions the cube in the bottom left of the screen
:param bottomRight: (C Q) Positions the cube in the bottom right of the screen
:param compassAngle: (C Q) Angle (in degrees) to rotate the compass
:param dragSnap: (C Q) Enable snapping of orbit direction to view cube part directions
during drag operation
:param drawCompass: (C Q) Show compass below the view cube
:param fitToView: (C) Fits the scene bounding box to the active view
:param frontParameters: (C Q) Parameter string for the front position
:param goDefault: (C Q) Go to the default position
:param goHome: (C Q) Go to the home position
:param homeParameters: (C Q) Parameter string for the home position
:param levelCamera: (C) Flattens the camera view rotation relative to the ground plane
:param minOpacity: (C Q) Opacity level (in range [0,1]) on view cube when the cursor is
away from it (it is fully opaque when the cursor is in the view cube area)
:param namespace: (C Q) Namespace to use for the object
:param postCommand: (C Q) Command to run after moving
:param preCommand: (C Q) Command to run before moving
:param preserveSceneUp: (C Q) Specify whether the scene "up" direction should be preserved
:param resetFront: (C Q) Reset the front position
:param resetHome: (C Q) Reset the home position
:param restoreCenter: (C) Repositions the pivot point for orbiting/tumbling the scene to
the center of the scene's bounding box
:param selectionLockParameters: (C Q) String containing the selection lock parameters
:param setFront: (C) Set the front view to the current one
:param setHome: (C) Set the home view to the current one
:param size: (C Q) Set or query the size of the View Cube, which can be one of "tiny",
"small", "normal", "large" or "auto" When set to "auto" the View Cube will be au
:param toggleSelectionLock: (C) Toggle the selection lock
:param topLeft: (C Q) Positions the cube in the top left of the screen
:param topRight: (C Q) Positions the cube in the top right of the screen
:param visible: (C Q) Shows/hides the view manip
:param zoomToFitScene: (C Q) Zoom the camera during animated transitions to fit the scene
object in the viewport
:returns:
"""
pass
def TimeEditorSceneAuthoringToggle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddPondDynamicLocatorOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DecreaseCheckerDensity(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ChangeEdgeWidth(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModifyPaintValuePress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def confirmDialog(*args, annotation: Union[AnyStr, List[AnyStr]]="", backgroundColor:
List[float, float, float]=None, button: Union[AnyStr, List[AnyStr]]="",
cancelButton: AnyStr="", defaultButton: AnyStr="", dismissString: AnyStr="",
icon: AnyStr="", message: AnyStr="", messageAlign: AnyStr="", parent:
AnyStr="", title: AnyStr="", **kwargs)->AnyStr:
"""
The confirmDialog command creates a modal dialog with a message to the user and a variable
number of buttons to dismiss the dialog The dialog is dismissed when the user presses any
button or chooses the close item from the window menu In the case where a button is
pressed then the name of the button selected is returned If the dialog is dismisse
:param annotation: (C M) set the annotation for the buttons
:param backgroundColor: (C) The background color of the dialog The arguments correspond to
the red, green, and blue color components Each component ranges in value from 0.0 to
:param button: (C M) Create a button with the given string as it's text
:param cancelButton: (C) The cancel button is activated by pressing the escape key Note
that this flag does not create a button, it simply indicates which button created via
:param defaultButton: (C) The default button is activated by pressing the enter key Note
that this flag does not create a button, it simply indicates which button created via
:param dismissString: (C) The string returned when the user selects the 'Close' item from
the Window Manager menu If this flag is not set then the string "dismiss" is returne
:param icon: (C) The user can specify one of the four standard icons -- "question",
"information", "warning" and "critical" The question icon indicates that the mess
:param message: (C) The message text appearing in the dialog
:param messageAlign: (C) Align the message left, center, or right
:param parent: (C) Specify the parent window for the dialog The dialog will be centered on
this window and raise and lower with it's parent By default, the dialog is
:param title: (C) The dialog title
:returns: Indicates how the dialog was dismissed. If a button is
pressed then the label of
the button is returned. If the dialog is
closed then the value for the flag dismissString
is
returned.
"""
pass
def HypershadeGraphRemoveSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BakeCustomPivotOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVAutomaticProjection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBifrostCamera(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def scaleKey(*args, animation: AnyStr="keysOrObjects.", attribute: Union[AnyStr,
List[AnyStr]]="", controlPoints: bool=False, float: Union[floatrange,
List[floatrange]]=None, floatPivot: float=0.0, floatScale: float=0.0, hierarchy:
AnyStr="", includeUpperBound: bool=True, index: Union[int, List[int]]=0,
newEndFloat: float=0.0, newEndTime: time=None, newStartFloat: float=0.0,
newStartTime: time=None, scaleSpecifiedKeys: bool=True, shape: bool=True, time:
Union[timerange, List[timerange]]=None, timePivot: time=None, timeScale: float=0.0,
valuePivot: float=0.0, valueScale: float=0.0, **kwargs)->int:
"""
This command operates on a keyset A keyset is defined as a group of keys within a
specified time range on one or more animation curves The animation curves comprising a
keyset depend on the value of the "-animation" flag: keysOrObjects: Any active keys, when
no target objects or -attribute flags appear on the command line, or All animation curv
:param animation: (C) Where this command should get the animation to act on Valid values
are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Descrip
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param float: (C M) value uniquely representing a non-time-based key (or key range) on a
time-based animCurve Valid floatRange include single values (-f 10) or a string
:param floatPivot: (C) Scale pivot along the x-axis for float-input animCurves
:param floatScale: (C) Amount of scale along the x-axis for float-input animCurves
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param includeUpperBound: (C) When the -t/time or -f/float flags represent a range of keys,
this flag determines whether the keys at the upper bound of the range are included in t
:param index: (C M) index of a key on an animCurve In query mode, this flag needs a value
:param newEndFloat: (C) The end of the float range to which the float-input targets should
be scaled
:param newEndTime: (C) The end of the time range to which the targets should be scaled
:param newStartFloat: (C) The start of the float range to which the float-input targets
should be scaled
:param newStartTime: (C) The start of the time range to which the time-input targets should
be scaled
:param scaleSpecifiedKeys: (C) Determines if only the specified keys are affected by the
scale If false, other keys may be adjusted with the scale The default is true
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:param time: (C M) time uniquely representing a key (or key range) on a time-based
animCurve See the code examples below on how to format for a single frame or frame r
:param timePivot: (C) Scale pivot along the time-axis for time-input animCurves
:param timeScale: (C) Amount of scale along the time-axis for time-input animCurves
:param valuePivot: (C) Scale pivot along the value-axis
:param valueScale: (C) Amount of scale along the value-axis
:returns: Number of curves on which scale was performed
"""
pass
def xgmCopyDescription(*args, **kwargs)->None:
"""
"""
pass
def nClothCacheOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def deleteAttr(*args, attribute: AnyStr="", name: AnyStr="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
This command is used to delete a dynamic attribute from a node or nodes The attribute can
be specified by using either the long or short name Only one dynamic attribute can be
deleted at a time Static attributes cannot be deleted Children of a compound attribute
cannot be deleted You must delete the complete compound attribute This command ha
:param attribute: (C) Specify either the long or short name of the attribute
:param name: (C) The name of the node
:returns:
"""
pass
def polyNormal(*args, caching: bool=True, constructionHistory: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, normalMode: Union[int, bool]=0, userNormalMode:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Control the normals of an object This command works on faces or polygonal objects
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param normalMode: (C Q E) Normal mode : 0=reverse, 1=propagate, 2=conform, 3=reverseAndCut,
4=reverseAndPropagate Default: 0
:param userNormalMode: (C Q E) Determines if user normals needs to be reversed as well
Default: true
:returns: The node name.
"""
pass
def dR_quadDrawRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PreInfinityOscillate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def WireTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetPartBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def pathAnimation(*args, bank: bool=False, bankScale: Union[float, bool]=1.0, bankThreshold:
Union[float, bool]=90, curve: Union[AnyStr, bool]="", endTimeU: Union[time,
List[time], bool]=None, endU: Union[float, bool]=0.0, follow: bool=False,
followAxis: Union[AnyStr, bool]="", fractionMode: bool=False, inverseFront:
bool=False, inverseUp: bool=False, name: Union[AnyStr, bool]="", startTimeU:
Union[time, List[time], bool]=None, startU: Union[float, bool]=0.0, upAxis:
Union[AnyStr, bool]="", useNormal: bool=True, worldUpObject: Union[name,
bool]=None, worldUpType: Union[AnyStr, bool]="", worldUpVector:
Union[List[float, float, float], bool]=None, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The pathAnimation command constructs the necessary graph nodes and their interconnections
for a motion path animation Motion path animation requires a curve and one or more other
objects During the animation, the objects will be moved along the 3D curve or the
curveOnSurface. There are two ways to specify the moving objects: by explicitly
speci
:param bank: (Q) If on, enable alignment of the up axis of the moving object(s) to the
curvature of the path geometry Default is false When queried, this flag retur
:param bankScale: (Q) This flag specifies a factor to scale the amount of bank angle
Default is 1.0 When queried, this flag returns a float
:param bankThreshold: (Q) This flag specifies the limit of the bank angle Default is 90
degrees When queried, this flag returns an angle
:param curve: (Q) This flag specifies the name of the curve for the path Default is NONE
When queried, this flag returns a string
:param endTimeU: (Q M) This flag specifies the ending time of the animation for the u
parameter Default is NONE When queried, this flag returns a time
:param endU: (Q) This flag specifies the ending value of the u parameterization for the
animation Default is the end parameterization value of the curve When querie
:param follow: (Q) If on, enable alignment of the front axis of the moving object(s)
Default is false When queried, this flag returns a boolean
:param followAxis: (Q) This flag specifies which object local axis to be aligned to the
tangent of the path curve Default is y When queried, this flag returns a string
:param fractionMode: (Q) If on, evaluation on the path is based on the fraction of length
of the path curve Default is false When queried, this flag returns a boolean
:param inverseFront: (Q) This flag specifies whether or not to align the front axis of the
moving object(s) to the opposite direction of the tangent vector of the path geomet
:param inverseUp: (Q) This flag specifies whether or not to align the up axis of the moving
object(s) to the opposite direction of the normal vector of the path geometry
:param name: (Q) This flag specifies the name for the new motion path node (instead of the
default name) When queried, this flag returns a string
:param startTimeU: (Q M) This flag specifies the starting time of the animation for the u
parameter Default is the the current time When queried, this flag returns a time
:param startU: (Q) This flag specifies the starting value of the u parameterization for the
animation Default is the start parameterization value of the curve When qu
:param upAxis: (Q) This flag specifies which object local axis to be aligned a computed up
direction Default is z When queried, this flag returns a string
:param useNormal: (C Q E) This flag is now obsolete Use -wut/worldUpType instead
:param worldUpObject: (C Q E) Set the DAG object to use for worldUpType "object" and
"objectrotation" See -wut/worldUpType for greater detail The default value is no up
object,
:param worldUpType: (C Q E) Set the type of the world up vector computation The
worldUpType can have one of 5 values: "scene", "object", "objectrotation", "vector", or
"normal"
:param worldUpVector: (C Q E) Set world up vector This is the vector in world coordinates
that up vector should align with See -wut/worldUpType for greater detail If not given
:returns: (name of the created motionPath node)
"""
pass
def StraightenUVBorder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createPolySphereCtx(*args, **kwargs)->None:
"""
"""
pass
def AddSelectionAsInBetweenTargetShape(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateRigidBodySolver(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def flagTest(*args, **kwargs)->None:
"""
"""
pass
def ShatterOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyProjection(*args, constructionHistory: bool=True, createNewMap: bool=True,
imageCenterX: float=0.5, imageCenterY: float=0.5, imageScaleU: float=1,
imageScaleV: float=1, insertBeforeDeformers: bool=True, keepImageRatio:
bool=True, mapDirection: AnyStr="", projectionCenterX: float=0.0,
projectionCenterY: float=0.0, projectionCenterZ: float=0.0,
projectionScaleU: float=0.0, projectionScaleV: float=0.0, rotateX: float=0.0,
rotateY: float=0.0, rotateZ: float=0.0, rotationAngle: float=0, seamCorrect:
bool=True, smartFit: bool=True, type: AnyStr="", uvSetName: AnyStr="",
**kwargs)->AnyStr:
"""
Creates a mapping on the selected polygonal faces When construction history is created,
the name of the new node is returned In other cases, the command returns nothing
:param constructionHistory: (C) Turn the construction history on or off (where applicable)
:param createNewMap: (C) Create new map if it does not exist
:param imageCenterX: (C) Specifies the X (U) translation of the projected UVs Default is
0.5
:param imageCenterY: (C) Specifies the Y (V) translation of the projected UVs Default is
0.5
:param imageScaleU: (C) Specifies the U scale factor of the projected UVs Default is 1
:param imageScaleV: (C) Specifies the V scale factor of the projected UVs Default is 1
:param insertBeforeDeformers: (C) Specifies if the projection node should be inserted
before or after deformer nodes already applied to the shape Inserting the projection after
the d
:param keepImageRatio: (C) Specifies if the xy scaling in the planar projection has to be
uniform By setting this flag, the texture aspect ratio is preserved This flag is ign
:param mapDirection: (C) Specifies the direction of the projection By specifying this flag,
the projection placement values (pcx, pcy, pcz, rx, ry, rz, psu, psv) are interna
:param projectionCenterX: (C) Specifies the X coordinate of the center of the projection
manipulator
:param projectionCenterY: (C) Specifies the Y coordinate of the center of the projection
manipulator
:param projectionCenterZ: (C) Specifies the Z coordinate of the center of the projection
manipulator
:param projectionScaleU: (C) Specifies the U scale component of the projection manipulator
:param projectionScaleV: (C) Specifies the V scale component of the projection manipulator
:param rotateX: (C) Specifies the X-axis rotation of the projection manipulator
:param rotateY: (C) Specifies the Y-axis rotation of the projection manipulator
:param rotateZ: (C) Specifies the Z-axis rotation of the projection manipulator
:param rotationAngle: (C) Specifies the rotation of the projected UVs in the UV space
Default is 0
:param seamCorrect: (C) Specifies if seam correction has to be done for spherical and
cylindrical projections This flag is ignored, if the planar projection is specified
:param smartFit: (C) Specifies if the projection manipulator has to be placed fitting the
object Used for cylindrical and spherical projections For smart fitting the pl
:param type: (C) Specify the type of mapping to be performed Valid values for the STRING
are "planar" "cylindrical" "spherical" Default is planar
:param uvSetName: (C) Specifies name of the uv set to work on
:returns: Name of node created
"""
pass
def snapshotBeadCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
inTangent: bool=True, name: AnyStr="", outTangent: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Creates a context for manipulating in and/or out tangent beads on the motion trail
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param inTangent: (Q E) Indicates that we will be showing beads for the in tangent when
entering the context
:param name: (C) If this is a tool command, name the tool appropriately
:param outTangent: (Q E) Indicates that we will be showing beads for the out tangent when
entering the context
:returns: (name of the new context)
"""
pass
def ToggleVisibilityAndKeepSelectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def iterOnNurbs(*args, **kwargs)->None:
"""
"""
pass
def CreatePolygonSoccerBallOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowPolygonSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowAttributeEditorOrChannelBox(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ActivateFullBodyPivot(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintEffectsToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HardwareRenderBuffer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LoadHIKPropertySetState(*args, **kwargs)->None:
"""
"""
pass
def ShowShadingGroupAttributeEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def readTake(*args, angle: AnyStr="", device: AnyStr="", frequency: float=0.0, linear:
AnyStr="", noTime: bool=True, take: AnyStr="", **kwargs)->None:
"""
This action reads a take (.mov) file to a defined device
:param angle: (C) Sets the angular unit used in the take Valid strings are "deg", "degree",
"rad", and "radian" C: The default is the current user angular unit
:param device: (C) Specifies the device into which the take data is read This is a
required argument
:param frequency: (C) The timestamp is ignored and the specified frequency is used If
timeStamp data is not in the .mov file, the -noTimestamp flag should also be used T
:param linear: (C) Sets the linear unit used in the take Valid strings are "mm",
"millimeter", "cm", "centimeter", "m", "meter", "km", "kilometer", "in", "inch", "ft",
:param noTime: (C) Specifies if the take (.mov) file contains time stamps C: The default
is to assume time stamps are part of the take file
:param take: (C) Reads the specified take file It is safest to pass the full path to the
flag
:returns:
"""
pass
def GraphEditorAbsoluteView(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadePinSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def renderThumbnailUpdate(*args, forceUpdate: AnyStr="", q=True, query=True,
**kwargs)->Union[None, Any]:
"""
Toggle the updating of object thumbnails These are visible in tools like the Attribute
Editor and Hypershade All thumbnails everywhere will not update to reflect changes to the
object until this command is used to toggle to true unless a specific thumbnail is forced
to render using the -forceUpdate flag
:param forceUpdate: (C) Force the thumbnail to update
:returns:
"""
pass
def ShowMeshImprintToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CopySkinWeights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CurveSmoothnessRough(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HIKFullBodyMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def popListItem(*args, **kwargs)->None:
"""
"""
pass
def ToggleModelingToolkit(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FrameAllInAllViews(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TransferAttributeValuesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyListComponentConversion(*args, border: bool=True, fromEdge: bool=True, fromFace:
bool=True, fromUV: bool=True, fromVertex: bool=True,
fromVertexFace: bool=True, internal: bool=True, toEdge:
bool=True, toFace: bool=True, toUV: bool=True, toVertex:
bool=True, toVertexFace: bool=True, uvShell: bool=True,
vertexFaceAllEdges: bool=True, **kwargs)->List[selectionItem]:
"""
This command converts poly components from one or more types to another one or more types,
and returns the list of the conversion It does not change anything of the current database
:param border: (C) Indicates that the converted components must be on the border of the
selection If it is not provided, the converted components will be the related o
:param fromEdge: (C)
:param fromFace: (C)
:param fromUV: (C)
:param fromVertex: (C)
:param fromVertexFace: (C) Indicates the component type to convert from If none of them is
provided, it is assumed to be all of them, including poly objects
:param internal: (C) Indicates that the converted components must be totally envolved by
the source components E.g a converted face must have all of its surrounding ver
:param toEdge: (C)
:param toFace: (C)
:param toUV: (C)
:param toVertex: (C)
:param toVertexFace: (C) Indicates the component type to convert to If none of them is
provided, it is assumed to the object
:param uvShell: (C) Will return UV components within the same UV shell Only works with
-tuv and -fuv flags
:param vertexFaceAllEdges: (C) When converting from face vertices to edges, indicates that
all edges with an end at the face vertex should be included Without this flag, the defau
:returns: List of poly components
"""
pass
def HypershadeGraphAddSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConnectionEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleKeepHardEdgeCulling(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TransformNoSelectOffTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def insertKeyCtx(*args, breakdown: bool=True, exists: bool=True, history: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a context which may be used to insert keys within the graph editor
:param breakdown: (Q E) Specifies whether or not to create breakdown keys
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Context name
"""
pass
def TimeEditorClipTrimStart(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmSelectedPrims(*args, **kwargs)->None:
"""
"""
pass
def SaveCurrentLayout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmPatchInfo(*args, **kwargs)->None:
"""
"""
pass
def SelectToolMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_extrudeBevelRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddPondDynamicBuoy(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dgeval(*args, src: bool=True, verbose: bool=True, **kwargs)->None:
"""
The dgeval command is used to force a dependency graph evaluate of a node or plug Used for
debugging to find propagation problems Normally the selection list is used to determine
which objects to evaluate, but you can add to the selection list by specifying which
objects you want on the command line
:param src: (C) This flag is obsolete Do not use
:param verbose: (C) If this flag is used then the results of the evaluation(s) is/are
printed on stdout
:returns:
"""
pass
def SelectUVNonOverlappingComponents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RegionKeysTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GpuCacheExportSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExportOfflineFileFromRefEd(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleLatticePoints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleFaceMetadata(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PlanarProjection(*args, **kwargs)->None:
"""
unknown
"""
pass
def OutTangentAuto(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def scaleKeyCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name: AnyStr="",
scaleSpecifiedKeys: bool=True, type: Union[AnyStr, bool]="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a context which may be used to scale keyframes within the graph editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param scaleSpecifiedKeys: (Q E) Determines if only the specified keys should be scaled If
false, the non-selected keys will be adjusted during the scale The default is true
:param type: (Q E) rect | manip Specifies the type of scale manipulator to use (Note:
"rect" is a manipulator style context, and "manip" is a gestural style context)
:returns: Scale type, if the type flag was queried
"""
pass
def softSelectOptionsCtx(*args, **kwargs)->None:
"""
"""
pass
def floatSlider(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dragCommand: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, horizontal: bool=True, isObscured:
bool=True, manage: bool=True, maxValue: Union[float, bool]=0.0, minValue:
Union[float, bool]=0.0, noBackground: bool=True, numberOfPopupMenus: bool=True,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, statusBarMessage: AnyStr="", step: Union[float, bool]=0.0,
useTemplate: AnyStr="", value: Union[float, bool]=0.0, visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a slider control that accepts only float values and is bound by a minimum and
maximum value The slider displays a marker indicating the current value of the slider
relative to its minimum and maximum values Click and drag the marker, or on the slider
itself to change the current value
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the value changes This command is not
invoked when the value changes via the -v/value flag
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command executed when the value changes by dragging the slider's
value marker
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param horizontal: (C Q) Orientation of the slider This flag is true by default, which
corresponds to a horizontally oriented slider
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxValue: (C Q E) Upper limit of the slider
:param minValue: (C Q E) Lower limit of the slider
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) The step value represents the amount the value will increase or
decrease when you click either side of the slider
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Value of the slider
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def addExtension(*args, nodeType: Union[AnyStr, bool]="", attributeType: Union[AnyStr, bool]="",
binaryTag: Union[AnyStr, bool]="", cachedInternally: bool=True, category:
Union[AnyStr, List[AnyStr], bool]="", dataType: Union[AnyStr, List[AnyStr],
bool]="", defaultValue: Union[float, bool]=0.0, disconnectBehaviour: Union[int,
bool]=0, enumName: Union[AnyStr, bool]="", exists: bool=True, fromPlugin:
bool=True, hasMaxValue: bool=True, hasMinValue: bool=True, hasSoftMaxValue:
bool=True, hasSoftMinValue: bool=True, hidden: bool=True, indexMatters:
bool=True, internalSet: bool=True, keyable: bool=True, longName: Union[AnyStr,
bool]="", maxValue: Union[float, bool]=0.0, minValue: Union[float, bool]=0.0,
multi: bool=True, niceName: Union[AnyStr, bool]="", numberOfChildren:
Union[int, bool]=0, parent: Union[AnyStr, bool]="", proxy: Union[AnyStr,
bool]="", readable: bool=True, shortName: Union[AnyStr, bool]="",
softMaxValue: Union[float, bool]=0.0, softMinValue: Union[float, bool]=0.0,
storable: bool=True, usedAsColor: bool=True, usedAsFilename: bool=True,
usedAsProxy: bool=True, writable: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
This command is used to add an extension attribute to a node type Either the longName or
the shortName or both must be specified If neither a dataType nor an attributeType is
specified, a double attribute will be added The dataType flag can be specified more than
once indicating that any of the supplied types will be accepted (logical-or) To a
:param nodeType: (C Q E) Specifies the type of node to which the attribute will be added
See the nodeType command for the names of different node types
:param attributeType: (C Q) Specifies the attribute type, see above table for more details
Note that the attribute types "float", "matrix" and "string" are also MEL keywords an
:param binaryTag: (C Q) This flag is obsolete and does not do anything any more
:param cachedInternally: (C Q) Whether or not attribute data is cached internally in the
node This flag defaults to true for writable attributes and false for non-writable
attribu
:param category: (C Q E M) An attribute category is a string associated with the attribute
to identify it (e.g the name of a plugin that created the attribute, version inform
:param dataType: (C Q M) Specifies the data type See "setAttr" for more information on
data type names
:param defaultValue: (C Q E) Specifies the default value for the attribute (can only be
used for numeric attributes)
:param disconnectBehaviour: (C Q) defines the Disconnect Behaviour 2 Nothing, 1 Reset, 0
Delete
:param enumName: (C Q E) Flag used to specify the ui names corresponding to the enum values
The specified string should contain a colon-separated list of the names, with opt
:param exists: (C Q) Returns true if the attribute queried is a user-added, dynamic
attribute; false if not
:param fromPlugin: (C Q) Was the attribute originally created by a plugin? Normally set
automatically when the API call is made - only added here to support storing it in a f
:param hasMaxValue: (C Q E) Flag indicating whether an attribute has a maximum value (can
only be used for numeric attributes)
:param hasMinValue: (C Q E) Flag indicating whether an attribute has a minimum value (can
only be used for numeric attributes)
:param hasSoftMaxValue: (C Q) Flag indicating whether a numeric attribute has a soft
maximum
:param hasSoftMinValue: (C Q) Flag indicating whether a numeric attribute has a soft
minimum
:param hidden: (C Q) Will this attribute be hidden from the UI?
:param indexMatters: (C Q) Sets whether an index must be used when connecting to this
multi-attribute Setting indexMatters to false forces the attribute to non-readable
:param internalSet: (C Q) Whether or not the internal cached value is set when this
attribute value is changed This is an internal flag used for updating UI elements
:param keyable: (C Q) Is the attribute keyable by default?
:param longName: (C Q) Sets the long name of the attribute
:param maxValue: (C Q E) Specifies the maximum value for the attribute (can only be used
for numeric attributes)
:param minValue: (C Q E) Specifies the minimum value for the attribute (can only be used
for numeric attributes)
:param multi: (C Q) Makes the new attribute a multi-attribute
:param niceName: (C Q E) Sets the nice name of the attribute for display in the UI Setting
the attribute's nice name to a non-empty string overrides the default behaviour of
:param numberOfChildren: (C Q) How many children will the new attribute have?
:param parent: (C Q) Attribute that is to be the new attribute's parent
:param proxy: (C Q) Proxy another node's attribute Proxied plug will be connected as
source The UsedAsProxy flag is automatically set in this case
:param readable: (C Q) Can outgoing connections be made from this attribute?
:param shortName: (C Q) Sets the short name of the attribute
:param softMaxValue: (C Q E) Soft maximum, valid for numeric attributes only Specifies the
upper default limit used in sliders for this attribute
:param softMinValue: (C Q E) Soft minimum, valid for numeric attributes only Specifies the
upper default limit used in sliders for this attribute
:param storable: (C Q) Can the attribute be stored out to a file?
:param usedAsColor: (C Q) Is the attribute to be used as a color definition? Must have 3
DOUBLE or 3 FLOAT children to use this flag The attribute type "-at" should be "doubl
:param usedAsFilename: (C Q) Is the attribute to be treated as a filename definition? This
flag is only supported on attributes with data type "-dt" of "string"
:param usedAsProxy: (C Q) Set if the specified attribute should be treated as a proxy to
another attributes
:param writable: (C Q) Can incoming connections be made to this attribute?
:returns:
"""
pass
def xgmPartBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def NodeEditorCreateCompound(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolygonBooleanDifference(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleBorderEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateNURBSCubeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def planarSrf(*args, caching: bool=True, degree: Union[int, bool]=3, keepOutside: bool=False,
nodeState: Union[int, bool]=0, tolerance: Union[float, bool]=0.01,
constructionHistory: bool=True, name: AnyStr="", object: bool=True, polygon:
int=0, range: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
This command computes a planar trimmed surface given planar boundary curves that form a
closed region
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param degree: (C Q E) The degree of the resulting surface: 1 - linear, 3 - cubic Default:
3
:param keepOutside: (C Q E) If true, keep the regions outside the given curves Default:
false
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param tolerance: (C Q E) The distance tolerance for the cvs of the curves to be in the
same plane Default: 0.01
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:param range: (C) Force a curve range on complete input curve
:returns: Object name and node name
"""
pass
def connectDynamic(*args, addScriptHandler: Script=None, collisions: Union[AnyStr,
List[AnyStr]]="", delete: bool=True, emitters: Union[AnyStr,
List[AnyStr]]="", fields: Union[AnyStr, List[AnyStr]]="",
removeScriptHandler: int=0, **kwargs)->AnyStr:
"""
Dynamic connection specifies that the force fields, emitters, or collisions of an object
affect another dynamic object The dynamic object that is connected to a field, emitter, or
collision object is influenced by those fields, emitters and collision objects
Connections are made to individual fields, emitters, collisions So, if an object owns
s
:param addScriptHandler: (C) Registers a script that will be given a chance to handle calls
to the dynamicConnect command This flag allows other dynamics systems to override the
:param collisions: (C M) Connects each object to the collision models of the given object
:param delete: (C) Deletes existing connections
:param emitters: (C M) Connects each object to the emitters of the given object
:param fields: (C M) Connects each object to the fields of the given object
:param removeScriptHandler: (C) This flag is used to remove a callback that was previously
registered with the addScriptHandler flag The argument to this flag is the numerical id r
:returns: Command result
"""
pass
def polyMergeEdge(*args, caching: bool=True, constructionHistory: bool=True, firstEdge:
Union[int, bool]=0, mergeMode: Union[int, bool]=1, mergeTexture: bool=False,
name: AnyStr="", nodeState: Union[int, bool]=0, secondEdge: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
Sews two border edges together.
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param firstEdge: (C Q E) First edge to merge Invalid default value to force the value to
be set Default: -1
:param mergeMode: (C Q E) Merge mode : 0=first, 1=halfway between both edges, 2=second
Default: 1
:param mergeTexture: (C Q E) Boolean which is used to decide if uv coordinates should be
merged or not - along with the geometry Default: false
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param secondEdge: (C Q E) Second edge to merge Invalid default value to force the value
to be set Default: -1
:returns: The node name.
"""
pass
def movieInfo(*args, counter: bool=True, dropFrame: bool=True, frameCount: bool=True,
frameDuration: bool=True, height: bool=True, movieTexture: bool=True, negTimesOK:
bool=True, numFrames: bool=True, quickTime: bool=True, timeCode: bool=True,
timeCodeTrack: bool=True, timeScale: bool=True, twentyFourHourMax: bool=True,
width: bool=True, **kwargs)->None:
"""
movieInfo provides a mechanism for querying information about movie files
:param counter: (C) Query the 'counter' flag of the movie's timecode format If this is
true, the timecode returned by the -timeCode flag will be a simple counter If fa
:param dropFrame: (C) Query the 'drop frame' flag of the movie's timecode format
:param frameCount: (C) Query the number of frames in the movie file
:param frameDuration: (C) Query the frame duration of the movie's timecode format
:param height: (C) Query the height of the movie
:param movieTexture: (C) If set, the string argument is interpreted as the name of a movie
texture node, and the command then operates on the movie loaded by that node
:param negTimesOK: (C) Query the 'neg times OK' flag of the movie's timecode format
:param numFrames: (C) Query the whole number of frames per second of the movie's timecode
format
:param quickTime: (C) Query whether the movie is a QuickTime movie
:param timeCode: (C) Query the timecode of the current movie frame
:param timeCodeTrack: (C) Query whether the movie has a timecode track
:param timeScale: (C) Query the timescale of the movie's timecode format
:param twentyFourHourMax: (C) Query the '24 hour max' flag of the movie's timecode format
:param width: (C) Query the width of the movie
:returns:
"""
pass
def ToggleAttributeEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GlobalStitchOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ReattachSkeletonJoints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hikBodyPart(*args, **kwargs)->None:
"""
"""
pass
def CharacterAnimationEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EnableNucleuses(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertInstanceToObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nurbsBoolean(*args, caching: bool=True, nodeState: Union[int, bool]=0, operation: Union[int,
bool]=0, tolerance: Union[float, bool]=0.01, constructionHistory: bool=True,
name: AnyStr="", nsrfsInFirstShell: int=0, object: bool=True, smartConnection:
bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
This command performs a boolean operation
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param operation: (C Q E) Type of Boolean operation Default: 0
:param tolerance: (C Q E) fitting tolerance Default: 0.01
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nsrfsInFirstShell: (C) The number of selection items comprising the first shell
:param object: (C) Create the result, or just the dependency node
:param smartConnection: (C) Look for any of the selection items having a boolean operation
as history Default is true
:returns: Object name and node name
"""
pass
def CreatePolyFromPreview(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateConstraintClipOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ctxTraverse(*args, down: bool=True, left: bool=True, right: bool=True, up: bool=True,
**kwargs)->None:
"""
This command tells the current context to do a traversal Some contexts will ignore this
command Individual contexts determine what up/down left/right mean
:param down: (C) Move "down" as defined by the current context
:param left: (C) Move "left" as defined by the current context
:param right: (C) Move "right" as defined by the current context
:param up: (C) Move "up" as defined by the current context
:returns:
"""
pass
def ToggleCullingVertices(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def editDisplayLayerMembers(*args, fullNames: bool=True, noRecurse: bool=True, q=True,
query=True, **kwargs)->Union[int, Any]:
"""
This command is used to query and edit membership of display layers No equivalent 'remove'
command is necessary since all objects must be in exactly one display layer Removing an
object from a layer can be accomplished by adding it to a different layer
:param fullNames: (Q) (Query only.) If set then return the full DAG paths of the objects in
the layer Otherwise return just the name of the object
:param noRecurse: (C Q) If set then only add selected objects to the display layer
Otherwise all descendants of the selected objects will also be added
:returns: Number of objects added to the layer
"""
pass
def UngroupOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorCreateClipOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_autoWeldTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_connectTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ikSystem(*args, allowRotation: bool=True, autoPriority: bool=True, autoPriorityMC:
bool=True, autoPrioritySC: bool=True, list: Union[List[int, int], bool]=None,
snap: bool=True, solve: bool=True, solverTypes: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The ikSystem command is used to set the global snapping flag for handles and set the global
solve flag for solvers The standard edit (-e) and query (-q) flags are used for edit and
query functions
:param allowRotation: (Q E) Set true to allow rotation of an ik handle with keys set on
translation
:param autoPriority: (E) set autoPriority for all ikHandles
:param autoPriorityMC: (E) set autoPriority for all multiChain handles
:param autoPrioritySC: (E) set autoPriority for all singleChain handles
:param list: (Q E) returns the solver execution order when in query mode(list of strings)
changes execution order when in edit mode (int old position, int new position)
:param snap: (Q E) Set global snapping
:param solve: (Q E) Set global solve
:param solverTypes: (Q) returns a list of valid solverTypes ( query only )
:returns: Command result
"""
pass
def NCreateEmitter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowCameraManipulators(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def scriptedPanel(*args, control: bool=True, copy: AnyStr="", createString: bool=True,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", editString:
bool=True, exists: bool=True, init: bool=True, isUnique: bool=True, label:
Union[AnyStr, bool]="", menuBarRepeatLast: bool=True, menuBarVisible:
bool=True, needsInit: bool=True, parent: AnyStr="", popupMenuProcedure:
Union[Script, bool]=None, replacePanel: AnyStr="", tearOff: bool=True,
tearOffCopy: AnyStr="", tearOffRestore: bool=True, type: Union[AnyStr,
bool]="", unParent: bool=True, useTemplate: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command will create an instance of the specified scriptedPanelType A panel is a
collection of UI objects (buttons, fields, graphical views) that are grouped together A
panel can be moved around as a group within the application interface, and torn off to
exist in its own window The panel takes care of maintaining the state of its UI when it
:param control: (Q) Returns the top level control for this panel Usually used for getting
a parent to attach popup menus CAUTION: panels may not have controls at times
:param copy: (E) Makes this panel a copy of the specified panel Both panels must be of the
same type
:param createString: (E) Command string used to create a panel
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the Maya panel
:param editString: (E) Command string used to edit a panel
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param init: (C E) Initializes the panel's default state This is usually done
automatically on file -new and file -open
:param isUnique: (Q) Returns true if only one instance of this panel type is allowed
:param label: (Q E) Specifies the user readable label for the panel
:param menuBarRepeatLast: (C Q E) Controls whether clicking on the menu header with the
middle mouse button would repeat the last selected menu item
:param menuBarVisible: (C Q E) Controls whether the menu bar for the panel is displayed
:param needsInit: (Q E) (Internal) On Edit will mark the panel as requiring initialization
Query will return whether the panel is marked for initialization Used during fil
:param parent: (C) Specifies the parent layout for this panel
:param popupMenuProcedure: (Q E) Specifies the procedure called for building the panel's
popup menu(s) The default value is "buildPanelPopupMenu" The procedure should take one
stri
:param replacePanel: (E) Will replace the specified panel with this panel If the target
panel is within the same layout it will perform a swap
:param tearOff: (Q E) Will tear off this panel into a separate window with a paneLayout as
the parent of the panel When queried this flag will return if the panel has bee
:param tearOffCopy: (C) Will create this panel as a torn of copy of the specified source
panel
:param tearOffRestore: (C E) Restores panel if it is torn off and focus is given to it If
docked, becomes the active panel in the docked window This should be the default flag
:param type: (C Q) This flag specifies the type of scripted panel to create
:param unParent: (E) Specifies that the panel should be removed from its layout This
(obviously) cannot be used with query
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the scripted panel.
"""
pass
def SmoothingLevelIncrease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def doubleProfileBirailSurface(*args, blendFactor: Union[float, bool]=0.5, caching: bool=True,
nodeState: Union[int, bool]=0, tangentContinuityProfile1:
bool=False, tangentContinuityProfile2: bool=False,
transformMode: Union[int, bool]=0, constructionHistory:
bool=True, name: AnyStr="", object: bool=True, polygon: int=0,
q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The arguments are 4 cuves called "profile1" "profile2" "rail1" "rail2" This command
builds a railed surface by sweeping profile "profile1" along the two given rail curves
"rail1", "rail2" until "profile2" is reached By using the -blend control, the railed
surface creation could be biased more towards one of the two profile curves The curves (
b
:param blendFactor: (C Q E) A blend factor applied in between the two profiles The amount
of influence 'inputProfile1' has in the surface creation Default: 0.5
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param tangentContinuityProfile1: (C Q E) Need tangent continuity across the input profile
at inputProfile1 Default: false
:param tangentContinuityProfile2: (C Q E) Need tangent continuity across the input curve at
inputProfile2 Default: false
:param transformMode: (C Q E) transform mode ( Non proportional, proportional ) Non
proportional is default value Default: 0
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:returns: Object name and node name
"""
pass
def filter(*args, name: Union[AnyStr, bool]="", type: Union[AnyStr, bool]="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Creates or modifies a filter node Filter nodes are used by applyTake to modify recorded
device data before assigning it to the param curves for the attached attributes
:param name: (C Q E) Name for created filter
:param type: (C Q E) Resamples input data a fixed output rate using the closest sample
point
:returns: filter name
"""
pass
def SelectUVMask(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UnmirrorSmoothProxy(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleXGenDisplayHUD(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def copyFlexor(*args, **kwargs)->AnyStr:
"""
This command copies an existing bone or joint flexor from one bone (joint) to another The
attributes of the flexor and their connections as well as any tweaks in on the latticeFfd
are copied from the original to the new flexor If the selected bone (joint) appears to be
a mirror reflection of the bone (joint) of the existing flexor then the transf
:returns: The name of the new flexor node
"""
pass
def InitialFluidStates(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmMelRender(*args, **kwargs)->None:
"""
"""
pass
def GraphEditorDisplayTangentActive(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddDynamicBuoy(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def isolateSelect(*args, addDagObject: name=None, addSelected: bool=True, addSelectedObjects:
bool=True, loadSelected: bool=True, removeDagObject: name=None,
removeSelected: bool=True, state: bool=True, update: bool=True, viewObjects:
bool=True, q=True, query=True, **kwargs)->Union[bool, Any]:
"""
This command turns on/off isolate select mode in a specified modeling view, specified as
the argument Isolate select mode is a display mode where the currently selected objects
are added to a list and only those objects are displayed in the view It allows for
selective viewing of specific objects and object components
:param addDagObject: () Add the specified object to the set of objects to be displayed in
the view
:param addSelected: () Add the currently active objects to the set of objects to be
displayed in the view
:param addSelectedObjects: () Add selected objects to the set of objects to be displayed in
the view This flag differs from addSelected in that it will ignore selected components
:param loadSelected: () Replace the objects being displayed with the currently active
objects
:param removeDagObject: () Remove the specified object from the set of objects to be
displayed in the view
:param removeSelected: () Remove the currently active objects to the set of objects to be
displayed in the view
:param state: (Q) Turns isolate select mode on/off
:param update: () Update the view's list of objects due to a change to the set of objects
to be displayed
:param viewObjects: (Q) Returns the name (if any) of the objectSet which contains the list
of objects visible in the view if isolate select mode is on If isolate select mod
:returns: When used with query
"""
pass
def skeletonEmbed(*args, mergedMesh: bool=True, segmentationMethod: int=0,
segmentationResolution: int=256, q=True, query=True, **kwargs)->Union[None,
Any]:
"""
This command is used to embed a skeleton inside meshes
:param mergedMesh: (Q) When specified, the query command merges selected meshes together
and returns a Python object representing the merged mesh
:param segmentationMethod: (C) Specifies which segmentation algorithm to use to determine
what is inside the mesh and what is outside the mesh By default, boundary-and-fill-and-gr
:param segmentationResolution: (C) Specifies which segmentation resolution to use for the
voxel grid By default, 256x256x256 voxels will be used
:returns:
"""
pass
def SculptGeometryTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HyperGraphPanelRedoViewChange(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BifMeshExport(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GridUVOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UpdateReferenceSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def reorderDeformers(*args, name: AnyStr="", **kwargs)->None:
"""
This command changes the order in which 2 deformation nodes affect the output geometry The
first string argument is the name of deformer1, the second is deformer2, followed by the
list of objects they deform It inserts deformer2 before deformer1 Currently supported
deformer nodes include: sculpt, cluster, jointCluster, lattice, wire, jointLatti
:param name: (C) This flag is obsolete and is not used
:returns:
"""
pass
def NormalizeUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Snap2PointsTo2PointsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ImportWorkspaceFiles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SaveScene(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePose(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ResetProperty2State(*args, **kwargs)->None:
"""
"""
pass
def OutlinerExpandAllSelectedItems(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertSelectionToUVPerimeter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutlinerToggleShapes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MapUVBorderOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MoveSewUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyAutoProjection(*args, layoutMethod: Union[int, bool]=0, pivot: Union[List[float, float,
float], bool]=None, pivotX: Union[float, bool]=0.0, pivotY: Union[float,
bool]=0.0, pivotZ: Union[float, bool]=0.0, rotate: Union[List[float,
float, float], bool]=None, rotateX: Union[float, bool]=0.0, rotateY:
Union[float, bool]=0.0, rotateZ: Union[float, bool]=0.0, scale:
Union[List[float, float, float], bool]=None, scaleX: Union[float,
bool]=1.0, scaleY: Union[float, bool]=1.0, scaleZ: Union[float,
bool]=1.0, translate: Union[List[float, float, float], bool]=None,
translateX: Union[float, bool]=0.0, translateY: Union[float, bool]=0.0,
translateZ: Union[float, bool]=0.0, caching: bool=True,
constructionHistory: bool=True, createNewMap: bool=True,
insertBeforeDeformers: bool=True, layout: Union[int, bool]=0, name:
AnyStr="", nodeState: Union[int, bool]=0, optimize: Union[int, bool]=0,
percentageSpace: Union[float, bool]=0.0, planes: Union[int, bool]=6,
projectBothDirections: bool=True, scaleMode: Union[int, bool]=0,
skipIntersect: bool=True, uvSetName: AnyStr="", worldSpace: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Projects a map onto an object, using several orthogonal projections simultaneously
:param layoutMethod: (C Q E) Set which layout method to use: 0 Block Stacking 1 Shape
Stacking
:param pivot: (C Q E) This flag specifies the pivot for scaling and rotation C: Default is
0.0 0.0 0.0 Q: When queried, this flag returns a float[3]
:param pivotX: (C Q E) This flag specifies the X pivot for scaling and rotation C: Default
is 0.0 Q: When queried, this flag returns a float
:param pivotY: (C Q E) This flag specifies the Y pivot for scaling and rotation C: Default
is 0.0 Q: When queried, this flag returns a float
:param pivotZ: (C Q E) This flag specifies the Z pivot for scaling and rotation C: Default
is 0.0 Q: When queried, this flag returns a float
:param rotate: (C Q E) This flag specifies the rotation angles around X, Y, Z C: Default
is 0.0 0.0 0.0 Q: When queried, this flag returns a float[3]
:param rotateX: (C Q E) This flag specifies the rotation angle around X C: Default is 0.0
Q: When queried, this flag returns a float
:param rotateY: (C Q E) This flag specifies the rotation angle around Y C: Default is 0.0
Q: When queried, this flag returns a float
:param rotateZ: (C Q E) This flag specifies the rotation angle around Z C: Default is 0.0
Q: When queried, this flag returns a float
:param scale: (C Q E) This flag specifies the scaling vector C: Default is 1.0 1.0 1.0 Q:
When queried, this flag returns a float[3]
:param scaleX: (C Q E) This flag specifies X for scaling vector C: Default is 1.0 Q: When
queried, this flag returns a float
:param scaleY: (C Q E) This flag specifies Y for scaling vector C: Default is 1.0 Q: When
queried, this flag returns a float
:param scaleZ: (C Q E) This flag specifies Z for scaling vector C: Default is 1.0 Q: When
queried, this flag returns a float
:param translate: (C Q E) This flag specifies the translation vector C: Default is 0.0 0.0
0.0 Q: When queried, this flag returns a float[3]
:param translateX: (C Q E) This flag specifies the X translation vector C: Default is 0.0
Q: When queried, this flag returns a float
:param translateY: (C Q E) This flag specifies the Y translation vector C: Default is 0.0
Q: When queried, this flag returns a float
:param translateZ: (C Q E) This flag specifies the Z translation vector C: Default is 0.0
Q: When queried, this flag returns a float
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createNewMap: (C) Set to true if a new map should be created
:param insertBeforeDeformers: (C) Set to true if the new node created should inserted
before any deformer nodes
:param layout: (C Q E) What layout algorithm should be used: 0 UV pieces are set to no
layout 1 UV pieces are aligned along the U axis 2 UV pieces are moved in a square s
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param optimize: (C Q E) Use two different flavors for the cut generation 0 Every face is
assigned to the best plane This optimizes the map distortion 1 Small UV pieces ar
:param percentageSpace: (C Q E) When layout is set to square, this value is a percentage of
the texture area which is added around each UV piece It can be used to ensure each UV pi
:param planes: (C Q E) Number of intermediate projections used Valid numbers are 4, 5, 6,
8, and 12 C: Default is 6
:param projectBothDirections: (C Q E) This flag specifies which reference to use If "on" :
projections are mirrored on directly opposite faces If "off" : projections are not
mirrored on
:param scaleMode: (C Q E) How to scale the pieces, after projections: 0 No scale is applied
1 Uniform scale to fit in unit square 2 Non proportional scale to fit in unit squ
:param skipIntersect: (C Q E) When on, self intersection of UV pieces are not tested This
makes the projection faster and produces fewer pieces, but may lead to overlaps in UV sp
:param uvSetName: (C) Name of the UV set to be created
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def PreviousFrame(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXPushSettings(*args, **kwargs)->None:
"""
"""
pass
def MirrorJointOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshSculptToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TogglePolyDisplayHardEdgesColor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def meshIntersectTest(*args, **kwargs)->None:
"""
"""
pass
def dR_modeUV(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CharacterSetEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DuplicateNURBSPatchesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportConstraints(*args, **kwargs)->None:
"""
"""
pass
def HypershadeOpenSpreadSheetWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddAttribute(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def angleBetween(*args, caching: bool=True, constructionHistory: bool=True, euler: bool=True,
nodeState: int=0, vector1: List[float, float, float]=None, vector1X: float=0.0,
vector1Y: float=0.0, vector1Z: float=0.0, vector2: List[float, float,
float]=None, vector2X: float=0.0, vector2Y: float=0.0, vector2Z: float=0.0,
**kwargs)->List[float]:
"""
Returns the axis and angle required to rotate one vector onto another If the construction
history (ch) flag is ON, then the name of the new dependency node is returned
:param caching: (C) Toggle caching for all attributes so that no recomputation is needed
:param constructionHistory: (C) Turn the construction history on or off
:param euler: (C) return the rotation as 3 Euler angles instead of axis + angle
:param nodeState: (C) This is implemented in the depend node base class and applies to all
nodes Blocking is applied during the evaluation phase to connections An evalua
:param vector1: (C) vector from which to compute the rotation
:param vector1X: (C) X coordinate of the vector from which to compute the rotation
:param vector1Y: (C) Y coordinate of the vector from which to compute the rotation
:param vector1Z: (C) Z coordinate of the vector from which to compute the rotation
:param vector2: (C) vector to which to compute the rotation
:param vector2X: (C) X coordinate of the vector to which to compute the rotation
:param vector2Y: (C) Y coordinate of the vector to which to compute the rotation
:param vector2Z: (C) Z coordinate of the vector to which to compute the rotation
:returns: 3 Euler angles or axis and angle
"""
pass
def NParticleToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BridgeEdgeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def VisualizeMetadataOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_meshColorOverrideTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def getParticleAttr(*args, array: bool=True, attribute: AnyStr="", object: AnyStr="",
**kwargs)->List[float]:
"""
This action will return either an array of values, or the average value and maximum offset,
for a specied per-particle attribute of a particle object or component If a particle
component is specified on the command line, values are returned for that component only If
an object name is given instead, values are returned for all particles in that o
:param array: (C) Tells the action whether you want a full array of data If set true, the
action returns an array of floats containing the values for all the specifie
:param attribute: (C) Tells the action which attribute you want the value of Must be a
per-particle attribute
:param object: (C) This flag is obsolete Instead of using it, please pass the name of the
object and/or components you want on the command line See the examples
:returns: Command result
"""
pass
def ShapeEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleMeshFaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleCurrentContainerHud(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetFKIdFromEffectorId(*args, **kwargs)->None:
"""
"""
pass
def HypershadeSortByTime(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def popPinning(*args, **kwargs)->None:
"""
"""
pass
def xgmSplineSelect(*args, **kwargs)->None:
"""
"""
pass
def texMoveUVShellContext(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", iterations:
Union[int, bool]=0, mask: bool=True, position: bool=True,
shellBorder: Union[float, bool]=0.0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create, edit, or query a texture editor move manip context
Note that the above flags control the global behaviour of all texture editor move manip
contexts Changing one context independently is not allowed Changing a context's behaviour
using the above flags, will change all existing texture editor move manip contexts
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param iterations: (Q E) Sets or queries the number of iterations to perform
:param mask: (Q E) Sets or queries masking on the shell
:param position: (Q) Returns the current position of the manipulator
:param shellBorder: (Q E) Sets or queries the size of the shell border
:returns: (the name of the new context)
"""
pass
def attrEnumOptionMenuGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0,
adjustableColumn3: int=0, adjustableColumn4: int=0,
adjustableColumn5: int=0, adjustableColumn6: int=0, annotation:
Union[AnyStr, bool]="", attribute: name=None, backgroundColor:
Union[List[float, float, float], bool]=None, columnAlign:
Union[List[int, AnyStr], List[List[int, AnyStr]]]=None, columnAlign2:
List[AnyStr, AnyStr]=None, columnAlign3: List[AnyStr, AnyStr,
AnyStr]=None, columnAlign4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAlign5: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAlign6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach: Union[List[int, AnyStr, int],
List[List[int, AnyStr, int]]]=None, columnAttach2: List[AnyStr,
AnyStr]=None, columnAttach3: List[AnyStr, AnyStr, AnyStr]=None,
columnAttach4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach5: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnOffset2: List[int, int]=None, columnOffset3:
List[int, int, int]=None, columnOffset4: List[int, int, int,
int]=None, columnOffset5: List[int, int, int, int, int]=None,
columnOffset6: List[int, int, int, int, int, int]=None, columnWidth:
Union[List[int, int], List[List[int, int]]]=None, columnWidth1: int=0,
columnWidth2: List[int, int]=None, columnWidth3: List[int, int,
int]=None, columnWidth4: List[int, int, int, int]=None, columnWidth5:
List[int, int, int, int, int]=None, columnWidth6: List[int, int, int,
int, int, int]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None,
enable: bool=True, enableBackground: bool=True, enableKeyboardFocus:
bool=True, enumeratedItem: Union[List[int, AnyStr], List[List[int,
AnyStr]]]=None, exists: bool=True, fullPathName: bool=True, height:
Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, isObscured: bool=True, label: Union[AnyStr, bool]="",
manage: bool=True, noBackground: bool=True, numberOfPopupMenus:
bool=True, parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, rowAttach: Union[List[int, AnyStr, int],
List[List[int, AnyStr, int]]]=None, statusBarMessage: AnyStr="",
useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param attribute: (C E) The name of an attribute The button will be attached to the
attribute so the button can be kept in synch with the attribute
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param enumeratedItem: (C M) Enumerated item and the corresponding string If this flag is
not supplied when the control is created, then the command will try to read the values
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) Text for the control
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The full name of the control on creation.
"""
pass
def GetHIKMatrixDecomposition(*args, **kwargs)->None:
"""
"""
pass
def nurbsEditUV(*args, angle: Union[float, bool]=0.0, pivotU: Union[float, bool]=0.0, pivotV:
Union[float, bool]=0.0, relative: bool=True, rotateRatio: Union[float,
bool]=1.0, rotation: bool=True, scale: bool=True, scaleU: Union[float,
bool]=0.0, scaleV: Union[float, bool]=0.0, uValue: Union[float, bool]=0.0,
vValue: Union[float, bool]=0.0, q=True, query=True, **kwargs)->Union[bool,
Any]:
"""
Command Edits UVs on NURBS objects When used with the query flag, it returns the UV values
associated with the specified components
:param angle: (C Q) Specifies the angle value (in degrees) by which the UV values are to be
rotated
:param pivotU: (C Q) Specifies the pivot value, in the u direction, about which the scale
or rotate is to be performed
:param pivotV: (C Q) Specifies the pivot value, in the v direction, about which the scale
or rotate is to be performed
:param relative: (C Q) Specifies whether this command is editing the values relative to the
currently existing values Default is true;
:param rotateRatio: (C Q) Specifies the ratio value by which the UV values are to be
rotated Default is 1.0
:param rotation: (C Q) Specifies whether this command is editing the values with rotation
values
:param scale: (C Q) Specifies whether this command is editing the values with scale values
:param scaleU: (C Q) Specifies the scale value in the u direction
:param scaleV: (C Q) Specifies the scale value in the v direction
:param uValue: (C Q) Specifies the value, in the u direction - absolute if relative flag is
false.
:param vValue: (C Q) Specifies the value, in the v direction - absolute if relative flag is
false.
:returns: Success or Failure.
"""
pass
def ResetTransformations(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AssignHairConstraint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LockContainer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideSubdivSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolygonSelectionConstraints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShapeEditorNewGroup(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TransferAttributeValues(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteKeys(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DuplicateFaceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def offsetSurface(*args, caching: bool=True, distance: Union[float, bool]=1.0, method:
Union[int, bool]=0, nodeState: Union[int, bool]=0, constructionHistory:
bool=True, name: AnyStr="", object: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The offset command creates new offset surfaces from the selected surfaces The default
method is a surface offset, which offsets relative to the surface itself The CV offset
method offsets the CVs directly rather than the surface, so is usually slightly less
accurate but is faster The offset surface will always have the same degree, number of CVs
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param distance: (C Q E) Offset distance Default: 1.0
:param method: (C Q E) Offset method 0 - Surface Fit 1 - CV Fit Default: 0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:returns: Object name and node name
"""
pass
def paintPointsContext(*args, **kwargs)->None:
"""
"""
pass
def twoPointArcCtx(*args, degree: Union[int, bool]=0, exists: bool=True, history: bool=True,
image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", name: AnyStr="", spans: Union[int, bool]=4, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The twoPointArcCtx command creates a new context for creating two point circular arcs
:param degree: (C Q E) Valid values are 1 or 3 Default degree 3
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param spans: (C Q E) Default is 4
:returns: Name of the new context
"""
pass
def IncreaseGammaCoarse(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def toggleDisplacement(*args, **kwargs)->None:
"""
This command toggles the displacement preview of the polygon This command is NOT un-doable
:returns:
"""
pass
def mayaDpiSetting(*args, mode: Union[int, bool]=0, realScaleValue: bool=True, scaleValue:
Union[float, bool]=0.0, systemDpi: bool=True, q=True, query=True,
**kwargs)->Union[int, Any]:
"""
Provide Maya interface scaling based on system DPI or custom scale setting or no scaling
Please note that the change will only take effect after relaunching Maya
:param mode: (C Q) Specifies the interface scaling mode: 0 - System Dpi Based Scaling 1 -
Custom Scaling (Must provide the custom scale value with flag "-scaleValue") 2
:param realScaleValue: (Q) This is a query mode only flag which returns the real scale
value depending on current scaling mode and defined scale value: mode 0 - Return the curr
:param scaleValue: (C Q) Specifies the custom scale of the interface if scaling mode is 1
The allowed values are [1.0, 1.25, 1.5, 2.0] In query mode, return the scale value
:param systemDpi: (Q) This is a query mode only flag which returns the current system dpi
value
:returns: Scale mode or system DPI value, as queried
"""
pass
def workspaceControl(*args, checksPlugins: bool=True, close: bool=True, closeCommand:
Script=None, collapse: bool=True, defineTemplate: AnyStr="",
dockToControl: List[AnyStr, AnyStr]=None, dockToMainWindow: List[AnyStr,
bool]=None, dockToPanel: List[AnyStr, AnyStr, bool]=None, duplicatable:
bool=True, exists: bool=True, floating: bool=True, height: bool=True,
heightProperty: Union[AnyStr, bool]="", horizontal: bool=True,
initCallback: Union[AnyStr, bool]="", initialHeight: int=0, initialWidth:
int=0, label: Union[AnyStr, bool]="", loadImmediately: bool=True,
minimumHeight: Union[int, bool]=0, minimumWidth: Union[int, bool]=0, r:
bool=True, requiredControl: Union[AnyStr, List[AnyStr]]="",
requiredPlugin: Union[AnyStr, List[AnyStr]]="", resizeHeight: int=0,
resizeWidth: int=0, restore: bool=True, retain: bool=True, stateString:
Union[AnyStr, bool]="", tabPosition: List[AnyStr, bool]=None,
tabToControl: List[AnyStr, int]=None, uiScript: Script=None, useTemplate:
AnyStr="", visible: bool=True, visibleChangeCommand: Script=None, width:
bool=True, widthProperty: Union[AnyStr, bool]="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Creates and manages the widget used to host windows in a layout that enables docking and
stacking windows together
:param checksPlugins: (C E) Sets whether the UI (as defined by the uiScript) checks the
loaded state of one or more plug-ins in its code The UI will not be loaded until the aut
:param close: (E) Closes the workspace control
:param closeCommand: (C E) Command that gets executed when the workspace control is closed
:param collapse: (C Q E) Collapse or expand the tab widget parent of the workspace control
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param dockToControl: (C E) Dock this workspace control next to the given control The
first argument is the control name, the second is dock position relative to the control (v
:param dockToMainWindow: (C E) Dock this workspace control into the main window The first
argument is the dock position along the sides of the main window (valid values are: "left
:param dockToPanel: (C E) Dock this workspace control into the workspace docking panel that
the given workspace control is in The first argument is the control name, the seco
:param duplicatable: (C Q E) Controls whether or not this workspace control can be
duplicated The default duplicate state is controlled by whether or not the panel is unique
Un
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param floating: (C Q E) Whether the workspace control is floating
:param height: (Q) Query only flag returning the current height of the control
:param heightProperty: (C Q E) Set height property of the workspace control Valid values
are: fixed - Cannot be resized manually and will not be given any extra space while maximi
:param horizontal: (C Q E) Orientation of the control This flag is true by default, which
corresponds to a horizontally oriented widget Note: currently only "Toolbox" and "Sh
:param initCallback: (C Q E) Adds a mel command to be executed when the control is added to
the layout The command should be a mel proc and it will be called with the workspaceC
:param initialHeight: (C E) The initial height of the workspace control when first shown
:param initialWidth: (C E) The initial width of the workspace control when first shown
:param label: (C Q E) The label text The default label is the name of the workspace
control
:param loadImmediately: (C E) Sets whether the UI (as defined by the uiScript) will be
built immediately on workspace control creation (true) or delayed until the control is
actua
:param minimumHeight: (C Q E) Sets the minimum height of control to the given value If
given value is 0 (False), minimum height is set to 0 If given value is 1 (True), minimum
h
:param minimumWidth: (C Q E) Sets the minimum width of control to the given value This
flag parameter was changed from bool to int in 2018 and old settings are still respected a
:param r: (Q E) Raises a workspace control to the top and makes it active In Query mode,
this flag will return whether the workspace control is active or not Note
:param requiredControl: (C E M) The name of a workspace control that needs to be open in
order for this workspace control to properly function This workspace control will not be
cr
:param requiredPlugin: (C E M) The name of a plug-in that needs to be loaded in order to
build the workspace control UI
:param resizeHeight: (E) Resizes a floating workspace control's height to the given value
:param resizeWidth: (E) Resizes a floating workspace control's width to the given value
:param restore: (C E) Restores the control according to the following rules: If collapsed
then the control will be expanded If hidden then the control will be shown If min
:param retain: (C) Sets whether the workspace control is retained (i.e only hidden) or
deleted when closed Default value is true
:param stateString: (C Q E) String containing the state of the control Can be used with
the initCallback flag
:param tabPosition: (C Q E) Changes the tab position The possible values are: "north",
"east" and "west" The boolean value, if set to true, changes the tab positions of all th
:param tabToControl: (C E) Tab this workspace control into the given control The first
argument is the control name, the second is the index position within the containing tab
:param uiScript: (C E) The specified script will be invoked to build the UI of the
workspaceControl This is a required flag
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the workspace control A control is created
visible by default If the control is created as not visible, the control will be cr
:param visibleChangeCommand: (C E) Command that gets executed when visible state of the
workspace control changes
:param width: (Q) Query only flag returning the current width of the control
:param widthProperty: (C Q E) Set width property of the workspace control Valid values
are: fixed - Cannot be resized manually and will not be given any extra space while
maximiz
:returns: Full path name to the control.
"""
pass
def tangentConstraint(*args, aimVector: Union[List[float, float, float], bool]=None, layer:
AnyStr="", name: Union[AnyStr, bool]="", remove: bool=True, targetList:
bool=True, upVector: Union[List[float, float, float], bool]=None, weight:
Union[float, bool]=0.0, weightAliasList: bool=True, worldUpObject:
Union[name, bool]=None, worldUpType: Union[AnyStr, bool]="",
worldUpVector: Union[List[float, float, float], bool]=None, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
Constrain an object's orientation based on the tangent of the target curve[s] at the
closest point[s] to the object A tangentConstraint takes as input one or more NURBS
curves (the targets) and a DAG transform node (the object) The tangentConstraint orients
the constrained object such that the aimVector (in the object's local coordinate system)
:param aimVector: (C Q E) Set the aim vector This is the vector in local coordinates that
points at the target If not given at creation time, the default value of (1.0, 0.0,
:param layer: (C E) Specify the name of the animation layer where the constraint should be
added
:param name: (C Q E) Sets the name of the constraint node to the specified name Default
name is constrainedObjectName_constraintType
:param remove: (E) removes the listed target(s) from the constraint
:param targetList: (Q) Return the list of target objects
:param upVector: (C Q E) Set local up vector This is the vector in local coordinates that
aligns with the world up vector If not given at creation time, the default value o
:param weight: (C Q E) Sets the weight value for the specified target(s) If not given at
creation time, the default value of 1.0 is used
:param weightAliasList: (Q) Returns the names of the attributes that control the weight of
the target objects Aliases are returned in the same order as the targets are returned
:param worldUpObject: (C Q E) Set the DAG object use for worldUpType "object" and
"objectrotation" See worldUpType for greater detail The default value is no up object,
which is
:param worldUpType: (C Q E) Set the type of the world up vector computation The
worldUpType can have one of 5 values: "scene", "object", "objectrotation", "vector", or
"none"
:param worldUpVector: (C Q E) Set world up vector This is the vector in world coordinates
that up vector should align with See -wut/worldUpType (below)for greater detail If not
:returns: Name of the created constraint node
"""
pass
def ConvertSelectionToFacePerimeter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddToContainerOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SculptMeshActivateBrushSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FreeformFilletOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OpenCloseCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_objectEdgesOnlyTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphEditorLockChannel(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UnitizeUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def shadingLightRelCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
name: AnyStr="", offCommand: Union[AnyStr, bool]="", onCommand:
Union[AnyStr, bool]="", shadingCentric: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a context that can be used for associating lights to shading groups
You can put the context into shading-centric mode by using the -shadingCentric flag and
specifying true This means that the shading group is selected first then lights associated
with the shading group are highlighted Subsequent selections result in assignme
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param offCommand: (C Q E) command to be issued when context is turned on
:param onCommand: (C Q E) command to be issued when context is turned on
:param shadingCentric: (C Q E) shading-centric mode
:returns: Name of the context created.
"""
pass
def SetInitialStateOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NURBSTexturePlacementTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreaseProxyEdgeToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MakeBoatsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UndoViewChange(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def mrShaderManager(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EPCurveToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateAreaLightOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisconnectJoint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgCreateDescription(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def geometryCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def editDisplayLayerGlobals(*args, baseId: Union[int, bool]=0, currentDisplayLayer: Union[name,
bool]=None, mergeType: Union[int, bool]=0, useCurrent: bool=True,
q=True, query=True, **kwargs)->Union[bool, Any]:
"""
Edit the parameter values common to all display layers Some of these paremeters, eg
baseId and mergeType, are stored as preferences and some, eg currentDisplayLayer, are
stored in the file
:param baseId: (C Q) Set base layer ID This is the number at which new layers start
searching for a unique ID
:param currentDisplayLayer: (C Q) Set current display layer; ie the one that all new
objects are added to
:param mergeType: (C Q) Set file import merge type Valid values are 0, none, 1, by number,
and 2, by name
:param useCurrent: (C Q) Set whether or not to enable usage of the current display layer as
the destination for all new nodes
:returns: Command success
"""
pass
def ToggleObjectDetails(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nClothMakeCollide(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintFluidsToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PublishRootTransformOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXProperties(*args, **kwargs)->None:
"""
"""
pass
def HypershadeConvertToFileTextureOptionBox(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def editRenderLayerMembers(*args, fullNames: bool=True, noRecurse: bool=True, remove: bool=True,
q=True, query=True, **kwargs)->Union[int, Any]:
"""
This command is used to query and edit memberships to render layers Only transform and
geometry nodes may be members At render time, all descendants of the members of a render
layer will also be included in the render layer
:param fullNames: (Q) (Query only.) If set then return the full DAG paths of the objects in
the layer Otherwise return just the name of the object
:param noRecurse: (C) If set then only add selected objects to the render layer Otherwise
all descendants of the selected objects will also be added This flag may be app
:param remove: (C) Remove the specified objects from the render layer
:returns: Number of objects added to the layer
"""
pass
def preferredRenderer(*args, fallback: Union[AnyStr, bool]="", makeCurrent: bool=True, q=True,
query=True, **kwargs)->Union[None, Any]:
"""
Command to set the preferred renderer This command can be used to query the preferred
renderer and to set the current renderer as the preferred one It also allows users to
specify a preferred fallback renderer
:param fallback: (C Q) Sets the preferred fallback renderer
:param makeCurrent: (C) Sets the current renderer as the preferred one
:returns:
"""
pass
def setParticleAttr(*args, attribute: AnyStr="", floatValue: float=0.0, object: AnyStr="",
randomFloat: float=0.0, randomVector: List[float, float, float]=None,
relative: bool=False, vectorValue: List[float, float, float]=None,
**kwargs)->None:
"""
This action will set the value of the chosen attribute for every particle or selected
component in the selected or passed particle object Components should not be passed to the
command line For setting the values of components, the components must be selected and
only the particle object's names should be passed to this action If the attribute i
:param attribute: (C) Tells the action which attribute you want to set
:param floatValue: (C) Tells what you want the value to be set to of a float attribute
:param object: (C) If this flag is passed and the STRING is the name of a particle object's
transform or shape, then ONLY that object will be edited, ignoring the selec
:param randomFloat: (C) Tells the command to add a random value from -FLOAT to +FLOAT to
the results of each particle The default is 0.0
:param randomVector: (C) Tells the command to add a random value from <<-x,-y,-z>> to <<x,y,
z>> to the results of each particle The default 0 0 0
:param relative: (C) If this is set to TRUE (the default is FALSE), then the float or
vector value will be added to the current value for each particle
:param vectorValue: (C) Tells what you want the value to be set to of a vector attribute
:returns:
"""
pass
def ContourProjectionOptions(*args, **kwargs)->None:
"""
unknown
"""
pass
def ToggleShowBufferCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmSelectBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def ikSpringSolverCallbacks(*args, **kwargs)->None:
"""
"""
pass
def unknownNode(*args, plugin: bool=True, realClassName: bool=True, realClassTag: bool=True,
q=True, query=True, **kwargs)->Union[List[AnyStr], Any]:
"""
Allows querying of the data stored for unknown nodes (nodes that are defined by a plug-in
that Maya could not load when loading a scene file)
:param plugin: (Q) In query mode return the name of the plug-in from which the unknown node
originated If no plug-in then the empty string is returned
:param realClassName: (Q) Return the real class name of the node
:param realClassTag: (Q) Return the real class IFF tag of the node
:returns: in query mode
"""
pass
def SmoothingLevelDecrease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintGrid(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def translator(*args, defaultFileRule: bool=True, defaultOptions: Union[AnyStr, bool]="",
extension: bool=True, fileCompression: Union[AnyStr, bool]="", filter: bool=True,
list: bool=True, loaded: bool=True, objectType: bool=True, optionsScript:
bool=True, readSupport: bool=True, writeSupport: bool=True, q=True, query=True,
**kwargs)->Union[bool, Any]:
"""
Set or query parameters associated with the file translators specified in as the argument
:param defaultFileRule: (Q) Returns the default file rule value, can return "" as well
:param defaultOptions: (Q) Return/set a string of default options used by this translator
:param extension: (Q) Returns the default file extension for this translator
:param fileCompression: (Q) Specifies the compression action to take when a file is saved
Possible values are "compressed", "uncompressed" "asCompressed"
:param filter: (Q) Returns the filter string used for this translator
:param list: (Q) Return a string array of all the translators that are loaded
:param loaded: (Q) Returns true if the given translator is currently loaded
:param objectType: (Q) This flag is obsolete This will now return the same results as
defaultFileRule going forward
:param optionsScript: (Q) Query the name of the options script to use to post the user
options UI When this script is invoked it will expect the name of the parent layout in
:param readSupport: (Q) Returns true if this translator supports read operations
:param writeSupport: (Q) Returns true if this translator supports write operations
:returns: or string array depending upon which flags are specified.
"""
pass
def quit(*args, abort: bool=True, exitCode: int=0, force: bool=True, **kwargs)->None:
"""
This command is used to exit the application
:param abort: (C) Will quit without saving like -force, but will also prevent
preferences/hotkeys/colors from being saved Use at your own risk
:param exitCode: (C) Specifies the exit code to be returned once the application exits The
default exit code is 0
:param force: (C) If specified, this flag will force a quit without saving or prompting for
saving changes Use at your own risk
:returns:
"""
pass
def assignShaderToType(*args, **kwargs)->None:
"""
"""
pass
def ToggleFrameRate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideNRigids(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DetachSurfacesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hide(*args, allObjects: bool=True, clearLastHidden: bool=True, clearSelection: bool=True,
invertComponents: bool=True, returnHidden: bool=True, testVisibility: bool=True,
**kwargs)->None:
"""
The hide command is used to make objects invisible If no flags are used, the objects
specified, or the active objects if none are specified, will be made invisible
:param allObjects: (C) Make everything invisible (top level objects)
:param clearLastHidden: (C) Clear the last hidden list
:param clearSelection: (C) Clear selection after the operation
:param invertComponents: (C) Hide components that are not specified
:param returnHidden: (C) Hide objects, but also return list of hidden objects
:param testVisibility: (C) Do not change visibility, just test it (returns 1 is invisible,
2 if visible, 3 if partially visible)
:returns:
"""
pass
def xgmPoints(*args, **kwargs)->None:
"""
"""
pass
def ShowMeshAmplifyToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def itemFilterType(*args, text: Union[AnyStr, bool]="", type: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command queries a named itemFilter object This object can be attached to
selectionConnection objects, or to editors, in order to filter the item lists going through
them Using union and intersection filters, complex composite filters can be created
:param text: (Q E) Defines an annotation string to be stored with the filter
:param type: (Q) Query the type of the filter object Possible return values are:
itemFilter, attributeFilter, renderFilter, or unknownFilter
:returns: Single command result
"""
pass
def ParticleFill(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def listCameras(*args, orthographic: bool=True, perspective: bool=True,
**kwargs)->List[AnyStr]:
"""
Command to list all cameras If no flags are given, both perspective and orthographic
cameras will be displayed This command returns an array of camera names When the
transform name uniquely identifies the camera it is used, otherwise the shape name will be
returned
:param orthographic: (C) Display all orthographic cameras
:param perspective: (C) Display all perspective cameras
:returns: Command result
"""
pass
def threePointArcCtx(*args, degree: Union[int, bool]=0, exists: bool=True, history: bool=True,
image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", name: AnyStr="", spans: Union[int, bool]=8, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The threePointArcCtx command creates a new context for creating 3 point arcs
:param degree: (C Q E) VAlid values are 1 or 3 Default degree 3
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param spans: (C Q E) Default is 8
:returns: (name of the new context)
"""
pass
def subdMapCut(*args, caching: bool=True, constructionHistory: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Cut along edges of the texture mapping The cut edges become map borders
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def NodeEditorUnpinSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveFromCharacterSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SubdivSurfaceHierarchyMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def partition(*args, addSet: name=None, name: AnyStr="", removeSet: name=None, render:
bool=False, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command is used to create, query or add/remove sets to a partition If a partition
name needs to be specified, it is the first argument, other arguments represent the set
names Without any flags, the command will create a partition with a default name Any
sets which are arguments to the command will be added to the partition A set can be
:param addSet: (C) Adds the list of sets to the named partition
:param name: (C) Assigns the given name to new partition Valid only for create mode
:param removeSet: (C) Removes the list of sets from the named partition
:param render: (C Q) New partition can contain render sets For use in creation mode only
Default is false Can also be used with query flag - returns boolean
:returns: Name of the partition that was created or edited
"""
pass
def flow(*args, divisions: Union[List[int, int, int], bool]=None, localCompute: bool=True,
localDivisions: Union[List[int, int, int], bool]=None, objectCentered: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The flow command creates a deformation lattice to `bend' the object that is animated along
a curve of a motion path animation The motion path animation has to have the follow option
set to be on
:param divisions: (Q) This flag specifies the number of lattice slices in x,y,z The
default values are 2 5 2 When queried, it returns the uint32_t uint32_t uint32_t
:param localCompute: (Q) This flag specifies whether or not to have local control over the
object deformation Default value: is on when the lattice is around the curve, and
:param localDivisions: (Q) This flag specifies the extent of the region of effect Default
values are 2 2 2 When queried, it returns the uint32_t uint32_t uint32_t
:param objectCentered: (Q) This flag specifies whether to create the lattice around the
selected object at its center, or to create the lattice around the curve Default value
:returns: The names of the created flow node and associated
lattice nodes.
"""
pass
def CreateReferenceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dgPerformance(*args, **kwargs)->None:
"""
"""
pass
def WrinkleTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleTextureBorderEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmSetArchiveSize(*args, **kwargs)->None:
"""
"""
pass
def polyBlendColor(*args, baseColorName: Union[AnyStr, bool]="", blendFunc: Union[int, bool]=0,
blendWeightA: Union[float, bool]=0.0, blendWeightB: Union[float, bool]=0.0,
blendWeightC: Union[float, bool]=0.0, blendWeightD: Union[float, bool]=0.0,
caching: bool=True, constructionHistory: bool=True, dstColorName:
Union[AnyStr, bool]="", name: AnyStr="", nodeState: Union[int, bool]=0,
srcColorName: Union[AnyStr, bool]="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Takes two color sets and blends them together into a third specified color set
:param baseColorName: (Q E) Name of the color set to blend from
:param blendFunc: (Q E) Type of blending function to use
:param blendWeightA: (Q E) Blend weight for linear and bilinear blending functions
:param blendWeightB: (Q E) Blend weight for bilinear and channel blending functions
:param blendWeightC: (Q E) Blend weight for channel functions
:param blendWeightD: (Q E) Blend weight for channel functions
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param dstColorName: (Q E) Name of the color set to copy to
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param srcColorName: (Q E) Name of the color set to copy from
:returns: The node name.
"""
pass
def ProfilerToolShowAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowNonlinears(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConformPolygonOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_preferencesTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def encodeString(*args, **kwargs)->AnyStr:
"""
This action will take a string and encode any character that would need to be escaped
before being sent to some other command Such characters include:
:returns: Command result
"""
pass
def hotkeySet(*args, current: bool=True, delete: bool=True, exists: bool=True, export:
AnyStr="", hotkeySetArray: bool=True, ip: AnyStr="", rename: AnyStr="", source:
AnyStr="", q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Manages hotkey sets in Maya A hotkey set holds hotkey to command mapping information
Default hotkey sets are hotkey sets that are shipped together with Maya They are locked
and cannot be altered A new hotkey set is always duplicated from an existing hotkey set
In create mode, users can choose to specify which hotkey set to duplicate by using
:param current: (C Q E) Sets the hotkey set as the current active hotkey set In query mode,
returns the name of the current hotkey set
:param delete: (E) Deletes the hotkey set if it exists Other flags are ignored Returns
true|false depending on the delete operation
:param exists: (C) Returns true|false depending upon whether the specified object exists
Other flags are ignored
:param export: (E) Exports a hotkey set The argument is used to specify a full path of the
output file
:param hotkeySetArray: (Q) Returns a string array of all existing hotkey set names
:param ip: (E) Imports a hotkey set The argument is used to specify a full path of the
hotkey set file to import
:param rename: (E) Renames an existing hotkey set All white spaces will be replaced with
'_' during operation
:param source: (C) Specifies the source hotkey set If flag is not provided, the current
active hotkey set is used
:returns: The name of the hotkey set.
"""
pass
def InsertKnotOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ImportOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeGraphUpDownstream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PickWalkUseController(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateCluster(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveConstraintTargetOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConnectJoint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RestoreUIElements(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def circularFillet(*args, caching: bool=True, nodeState: Union[int, bool]=0, positionTolerance:
Union[float, bool]=0.01, primaryRadius: Union[float, bool]=1.0,
secondaryRadius: Union[float, bool]=1.0, tangentTolerance: Union[float,
bool]=0.01, constructionHistory: bool=True, curveOnSurface: bool=True, name:
AnyStr="", object: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The cmd is used to compute the rolling ball surface fillet ( circular fillet ) between two
given NURBS surfaces To generate trim curves on the surfaces, use -cos true
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param positionTolerance: (C Q E) C(0) Tolerance For Fillet Surface Default: 0.01
:param primaryRadius: (C Q E) primary Radius Default: 1.0
:param secondaryRadius: (C Q E) secondary Radius Default: 1.0
:param tangentTolerance: (C Q E) G(1) Tolerance For Fillet Surface Default: 0.01
:param constructionHistory: (C) Turn the construction history on or off
:param curveOnSurface: (C) If possible, create 2D curve as a result
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:returns: Object name, node name.
"""
pass
def ubercam(*args, **kwargs)->AnyStr:
"""
Use this command to create a "ubercam" with equivalent behavior to all cameras used by
shots in the sequencer
:returns: Ubercam name
"""
pass
def dR_setExtendEdge(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CycleBackgroundColor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def spaceLocator(*args, absolute: bool=True, name: AnyStr="", position: Union[List[float, float,
float], bool]=None, relative: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The command creates a locator at the specified position in space By default it is created
at (0,0,0)
:param absolute: (C E) If set, the locator's position is in world space
:param name: (C E) Name for the locator
:param position: (C Q E) Location in 3-dimensional space where locator is to be created
:param relative: (C E) If set, the locator's position is relative to its local space The
locator is created in relative mode by default
:returns: The name for the new locator in space.
"""
pass
def SelectSimilarOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshFillToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ikSystemInfo(*args, globalSnapHandle: bool=True, q=True, query=True, **kwargs)->Union[None,
Any]:
"""
This action modifies and queries the current ikSystem controls
:param globalSnapHandle: (C Q) If this flag is off, all ikHandles will not be snapped
:returns:
"""
pass
def layout(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float, float,
float], bool]=None, childArray: bool=True, defineTemplate: AnyStr="", docTag:
Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback: Script=None,
enable: bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
exists: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured: bool=True,
manage: bool=True, noBackground: bool=True, numberOfChildren: bool=True,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="", popupMenuArray:
bool=True, preventOverride: bool=True, statusBarMessage: AnyStr="", useTemplate:
AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script, bool]=None,
width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This command allows you to edit or query the properties of any layout The argument is the
name of the layout
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns:
"""
pass
def MirrorSubdivSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllImagePlanes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def window(*args, backgroundColor: List[float, float, float]=None, closeCommand: Script=None,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", dockCorner:
Union[List[AnyStr, AnyStr], List[List[AnyStr, AnyStr]]]=None, dockStation: bool=True,
dockingLayout: Union[AnyStr, bool]="", exists: bool=True, frontWindow: bool=True,
height: Union[int, bool]=0, iconName: Union[AnyStr, bool]="", iconify: bool=True,
interactivePlacement: bool=True, leftEdge: Union[int, bool]=0, mainMenuBar:
bool=True, mainWindow: bool=True, maximizeButton: bool=True, menuArray: bool=True,
menuBar: bool=True, menuBarCornerWidget: Union[List[AnyStr, AnyStr], bool]=None,
menuBarResize: bool=True, menuBarVisible: bool=True, menuIndex: List[AnyStr,
int]=None, minimizeButton: bool=True, minimizeCommand: Script=None,
nestedDockingEnabled: bool=True, numberOfMenus: bool=True, parent: AnyStr="",
resizeToFitChildren: bool=True, restoreCommand: Script=None, retain: bool=True,
sizeable: bool=True, state: Union[AnyStr, bool]="", title: Union[AnyStr, bool]="",
titleBar: bool=True, titleBarMenu: bool=True, toolbox: bool=True, topEdge: Union[int,
bool]=0, topLeftCorner: Union[List[int, int], bool]=None, useTemplate: AnyStr="",
visible: bool=True, width: Union[int, bool]=0, widthHeight: Union[List[int, int],
bool]=None, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a new window but leaves it invisible It is most efficient to add the
window's elements and then make it visible with the showWindow command The window can have
an optional menu bar Also, the title bar and minimize/maximize buttons can be turned on or
off If the title bar is off, then you cannot have minimize or maximize but
:param backgroundColor: (C E) The background color of the window The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param closeCommand: (C E) Script executed after the window is closed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attach a tag to the window
:param dockCorner: (C M) Specifies which docking areas occupied the four different corners
of the window By default docking windows on the bottom or top will span the whole
:param dockStation: (C) When set this flag specifies that this window can contain other
docked sub-windows
:param dockingLayout: (C Q E) When queried this flag will return a string holding the
docking layout information This string can be set when creating or editing a docking
station
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param frontWindow: (Q) Return the name of the front window Note: you must supply the name
of any window (the window does not need to exist) Returns "unknown" if the front
:param height: (C Q E) Height of the window excluding any window frame in pixels
:param iconName: (C Q E) The window's icon title By default it is the same as the window's
title
:param iconify: (C Q E) Icon state of the window
:param interactivePlacement: (C) Deprecated flag Recognized but not implemented This flag
will be removed in a future version of Maya
:param leftEdge: (C Q E) Position of the left edge of the window
:param mainMenuBar: (C Q E) If this flag is used then the main menu bar will be enabled
:param mainWindow: (C Q E) Main window for the application The main window has an 'Exit'
item in the Window Manager menu By default, the first created window becomes the main
:param maximizeButton: (C Q E) Turns the window's maximize button on or off
:param menuArray: (Q) Return a string array containing the names of the menus in the
window's menu bar
:param menuBar: (C Q) Adds an empty menu bar to the window The Qt name of the object will
be m_menubar_nameOfTheWindow
:param menuBarCornerWidget: (Q E) This flag specifies a widget to add to a corner of the
parent window The first argument corresponds to the widget name and the second to the
positio
:param menuBarResize: (E) This flag should be used with the -mcw/-menuBarCornerWidget flag
This is used to resize the menu bar so that the corner widgets are updated
:param menuBarVisible: (C Q E) Visibility of the menu bar (if there is one)
:param menuIndex: (E) Sets the index of a specified menu
:param minimizeButton: (C Q E) Turns the window's minimize button on or off
:param minimizeCommand: (C E) Script executed after the window is minimized (iconified)
:param nestedDockingEnabled: (C) Controls whether nested docking is enabled or not Nested
docking allows for docking windows next to other docked windows for more possible
arrangeme
:param numberOfMenus: (Q) Return the number of menus attached to the window's menu bar
:param parent: (C) Specifies a parent window or layout which the created window is always
on top of Note: If the parent is a window the created window is not modal, so
:param resizeToFitChildren: (C Q E) The window will always grow/shrink to just fit the
controls it contains
:param restoreCommand: (C E) Script executed after the window is restored from it's
minimized (iconified) state
:param retain: (C) Retains the window after it has been closed The default is to delete
the window when it is closed
:param sizeable: (C Q E) Whether or not the window may be interactively resized
:param state: (C Q E) When queried this flag will return a string holding the window state
information This string is a hexadecimal representation of a binary string and
:param title: (C Q E) The window's title
:param titleBar: (C Q E) Turns the window's title bar on or off
:param titleBarMenu: (C Q E) Controls whether the title bar menu exists in the window title
bar Only valid if -tb/titleBar is true This Windows only flag is true by default
:param toolbox: (C Q E) Makes this a toolbox style window A Windows only flag that makes
the title bar smaller and uses a slightly different display style
:param topEdge: (C Q E) Position of the top edge of the window
:param topLeftCorner: (C Q E) Position of the window's top left corner
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The window's visibility
:param width: (C Q E) Width of the window excluding any window frame in pixels
:param widthHeight: (C Q E) Window's width and height excluding any window frame in pixels
:returns: Name to the window.
"""
pass
def ModelingPanelUndoViewChange(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_rotateTweakTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def buildSendToBackburnerDialog(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RebuildSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddPondBoatLocatorOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def binMembership(*args, addToBin: AnyStr="", exists: AnyStr="", inheritBinsFromNodes:
name=None, isValidBinName: AnyStr="", listBins: bool=True, makeExclusive:
AnyStr="", notifyChanged: bool=True, removeFromBin: AnyStr="", q=True,
query=True, **kwargs)->Union[bool, Any]:
"""
Command to assign nodes to bins
:param addToBin: (C) Add the nodes in a node list to a bin
:param exists: (C) Query if a node exists in a bin The exists flag can take only one node
:param inheritBinsFromNodes: (C) Let the node in the flag's argument inherit bins from
nodes in the specified node list The node list is specified as the object of the command
:param isValidBinName: (C) Query if the specified bin name is valid If so, return true
Otherwise, return false
:param listBins: (C Q) Query and return a list of bins a list of nodes belong to If a bin
contains any of the nodes in the selection list, then it should be included in th
:param makeExclusive: (C) Make the specified nodes belong exclusively in the specified bin
:param notifyChanged: (C) This flag is used to notify that binMembership has been changed
:param removeFromBin: (C) Remove the nodes in a node list from a bin
:returns: Command result
"""
pass
def arnoldRenderView(*args, **kwargs)->None:
"""
"""
pass
def InteractiveBindSkin(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmGrabBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def mayaDpiSettingAction(*args, **kwargs)->None:
"""
"""
pass
def NodeEditorPickWalkLeft(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def shelfTabLayout(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, borderStyle: Union[AnyStr, bool]="",
changeCommand: Script=None, childArray: bool=True, childResizable: bool=True,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
doubleClickCommand: Script=None, dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, fullPathName: bool=True,
height: Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, horizontalScrollBarThickness: int=0, image: Union[AnyStr,
bool]="", imageVisible: bool=True, innerMarginHeight: Union[int, bool]=0,
innerMarginWidth: Union[int, bool]=0, isObscured: bool=True, manage:
bool=True, minChildWidth: Union[int, bool]=0, moveTab: List[int, int]=None,
newTabCommand: Script=None, noBackground: bool=True, numberOfChildren:
bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preSelectCommand: Script=None, preventOverride:
bool=True, scrollable: bool=True, scrollableTabs: bool=True, selectCommand:
Union[Script, bool]=None, selectTab: Union[AnyStr, bool]="", selectTabIndex:
Union[int, bool]=0, showNewTab: bool=True, statusBarMessage: AnyStr="",
tabLabel: Union[List[AnyStr, AnyStr], List[List[AnyStr, AnyStr]], bool]=None,
tabLabelIndex: Union[List[int, AnyStr], List[List[int, AnyStr]], bool]=None,
tabPosition: Union[AnyStr, bool]="", tabTooltip: Union[List[AnyStr, AnyStr],
List[List[AnyStr, AnyStr]], bool]=None, tabTooltipIndex: Union[List[int,
AnyStr], List[List[int, AnyStr]], bool]=None, tabsClosable: bool=True,
tabsVisible: bool=True, useTemplate: AnyStr="", verticalScrollBarThickness:
int=0, visible: bool=True, visibleChangeCommand: Union[Script, bool]=None,
width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates/edits/queries a shelf tab group which is essentially a normal
tabLayout with some drop behaviour in the tab bar A garbage can icon can appear in the top
right corner to dispose of buttons dragged to it from shelves
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param borderStyle: (C Q E) Specify the style of the border for tab layout Valid values
are: "none", "top", "notop" and "full" By default, it will use "full" to draw a simple
:param changeCommand: (C E) Command executed when a tab is selected interactively This
command is only invoked when the selected tab changes Re-selecting the current tab will
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param childResizable: (C Q) Set to true if you want the child of the control layout to be
as wide as the scroll area You may also indicate a minimum width for the child using t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param doubleClickCommand: (C E) Command executed when a tab is double clicked on Note
that the first click will select the tab and the second click will execute the double click
co
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param horizontalScrollBarThickness: (C E) Thickness of the horizontal scroll bar Specify
an integer value greater than or equal to zero This flag has no effect on Windows systems
:param image: (C Q E) Image appearing in top right corner of tab layout
:param imageVisible: (C Q E) Visibility of tab image
:param innerMarginHeight: (C Q) Margin height for all tab children
:param innerMarginWidth: (C Q) Margin width for all tab children
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param minChildWidth: (C Q) Specify a positive non-zero integer value indicating the
minimum width the tab layout's children This flag only has meaning when the
-cr/childResiza
:param moveTab: (C E) Move the tab from the current index to a new index
:param newTabCommand: (C E) Command executed when the 'New Tab' button (on the tab bar) is
clicked Note: in order to show the new tab button use the -snt/showNewTab flag Using
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preSelectCommand: (C E) Command executed when a tab is selected but before it's
contents become visible Re-selecting the current tab will not invoke this command Note
that
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param scrollable: (C Q) Puts all children of this layout within a scroll area
:param scrollableTabs: (C Q E) If true, the active tab in the layout can be scrolled
through with the mouse wheel Default is true
:param selectCommand: (C Q E) Command executed when a tab is selected interactively This
command will be invoked whenever a tab is selected, ie re-selecting the current tab will
:param selectTab: (C Q E) The name, in short form, of the selected tab An empty string is
returned on query if there are no child tabs
:param selectTabIndex: (C Q E) Identical to the -st/selectTab flag except this flag takes a
1-based index to identify the selected tab A value of 0 is returned on query if there a
:param showNewTab: (C Q E) Set to true if you want to have a 'New Tab' button shown at the
end of the tab bar Note: use the -ntc/newTabCommand flag to set the command executed
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param tabLabel: (C Q E M) Set a tab label The first argument is the name of a control
that must be a child of the tab layout The second argument is the label for the tab ass
:param tabLabelIndex: (C Q E M) Identical to the -tl/tabLabel flag except this flag takes a
1-based index to identify the tab you want to set the label for If this flag is queried
:param tabPosition: (C Q E) Changes the tab position The possible values are: "north",
"east" and "west"
:param tabTooltip: (C Q E M) Set a tab tooltip The first argument is the name of a control
that must be a child of the tab layout The second argument is the tooltip for the tab
:param tabTooltipIndex: (C Q E M) Identical to the -tt/tabTooltip flag except this flag
takes a 1-based index to identify the tab you want to set the tooltip for If this flag is
quer
:param tabsClosable: (C Q) Set to true if you want to have a close button icon on all
created tabs
:param tabsVisible: (C Q E) Visibility of the tab labels
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param verticalScrollBarThickness: (C E) Thickness of the vertical scroll bar Specify an
integer value greater than or equal to zero This flag has no effect on Windows systems
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the shelfTabLayout.
"""
pass
def SelectFacetMask(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SplitPolygonTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def memoryDiag(*args, **kwargs)->None:
"""
"""
pass
def newton(*args, attenuation: Union[float, bool]=0.0, magnitude: Union[float, bool]=0.0,
maxDistance: Union[float, bool]=0.0, minDistance: Union[float, bool]=0.0, name:
Union[AnyStr, bool]="", perVertex: bool=True, position: Union[List[float, float,
float], List[List[float, float, float]], bool]=None, torusSectionRadius: Union[float,
bool]=0.0, volumeExclusion: bool=True, volumeOffset: Union[List[float, float, float],
bool]=None, volumeShape: Union[AnyStr, bool]="", volumeSweep: Union[float, bool]=0.0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
For each listed object, the command creates a new field The field has a shape which lives
in the DAG and it has an associated dependency node The field is added to the list of
fields owned by the object Use connectDynamic to cause the field to affect a dynamic
object Note that if more than one object is listed, a separate field is created for e
:param attenuation: (Q E) Attentuation rate of field
:param magnitude: (Q E) Strength of field
:param maxDistance: (Q E) Maximum distance at which field is exerted -1 indicates that the
field has no maximum distance
:param minDistance: (Q E) Minimum distance at which field is exerted Distance is in the
denominator of the field force equation Setting md to a small positive number avoids
:param name: (Q E) name of field
:param perVertex: (Q E) Per-vertex application If this flag is set true, then each
individual point (CV, particle, vertex,etc.) of the chosen object exerts an identical cop
:param position: (Q E M) Position in space (x,y,z) where you want to place a gravity field
The gravity then emanates from this position in space rather than from an object
:param torusSectionRadius: (Q E) Section radius for a torus volume Applies only to torus
Similar to the section radius in the torus modelling primitive
:param volumeExclusion: (Q E) Volume exclusion of the field If true, points outside the
volume (defined by the volume shape attribute) are affected, If false, points inside the v
:param volumeOffset: (Q E) Volume offset of the field Volume offset translates the field's
volume by the specified amount from the actual field location This is in the field'
:param volumeShape: (Q E) Volume shape of the field Sets/edits/queries the field's volume
shape attribute If set to any value other than "none", determines a 3-D volume with
:param volumeSweep: (Q E) Volume sweep of the field Applies only to sphere, cone, cylinder,
and torus Similar effect to the sweep attribute in modelling
:returns: Command result
"""
pass
def BakeSimulationOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtendCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleParticleCount(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setKeyPath(*args, **kwargs)->List[AnyStr]:
"""
The setKeyPath command either creates or edits the path (a nurbs curve) based on the
current position of the selected object at the current time
:returns: (Names of the created curve node and motionPath node)
"""
pass
def SendToUnrealAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExportSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AlembicImportOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisplayUVShaded(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetHIKNode(*args, **kwargs)->None:
"""
"""
pass
def ToggleAutoSmooth(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorToggleCreateNodePane(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeMoveTabDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NextSkinPaintMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyGeoSampler(*args, alphaBlend: AnyStr="", averageColor: bool=True, clampAlphaMax:
float=0.0, clampAlphaMin: float=0.0, clampRGBMax: List[float, float,
float]=None, clampRGBMin: List[float, float, float]=None, colorBlend:
AnyStr="", colorDisplayOption: bool=True, computeShadows: bool=True,
displaceGeometry: bool=True, flatShading: bool=True, ignoreDoubleSided:
bool=True, lightingOnly: bool=True, reuseShadows: bool=True, sampleByFace:
bool=True, scaleFactor: float=0.0, shareUV: bool=True, useLightShadows:
bool=True, e=True, edit=True, **kwargs)->bool:
"""
This command performs a render sampling of surface color and transparency for each selected
vertex or face and stores the sampled data as either the color value, or uses the sampled
data to displace the affected vertices or faces by a sampled data value Transparency is
not used for displacement, and displacement is performed along vertex normals
:param alphaBlend: (C E) When specified, indicates the type of alpha blend to be applied
Options are: "none", "overwrite", "add", "subtract", "multiply", "divide", "average"
:param averageColor: (C E) When used, will mean to force the storage of shared colors for
vertex level sampling By default vertex level sampling stores unshared colors
:param clampAlphaMax: (C E) When used, will mean to clamp the storage of alpha to a
maximum
:param clampAlphaMin: (C E) When used, will mean to clamp the storage of alpha to a
minimum
:param clampRGBMax: (C E) When used, will mean to clamp the storage of RGB color to a
maximum
:param clampRGBMin: (C E) When used, will mean to clamp the storage of RGB color to a
minimum
:param colorBlend: (C E) When specified, indicates the type of color blend to be applied
Options are: "none", "overwrite", "add", "subtract", "multiply", "divide", "average"
:param colorDisplayOption: (C E) Change the display options on the mesh to display the
vertex colors
:param computeShadows: (C E) When used, shadow maps will be computed, saved, and reused
during the sampling process
:param displaceGeometry: (C E) When used, geometry will be displaced along the normals at
the sampling positions, as opposed to storing color values The default is to store colors
:param flatShading: (C E) When used, flat shaded sampling will be computed The default is
smooth shading
:param ignoreDoubleSided: (C E) When specified, the double sided flag will be ignored for
prelighting
:param lightingOnly: (C E) When used, incoming illumination will be computed as opposed to
surface color an tranparency
:param reuseShadows: (C E) When used, if shadow maps were previosly computed and saved,
then they will be reused during the sampling process The computeShadows option must be
:param sampleByFace: (C E) When used, sample will occur at a per face level versus a per
vertex level, which is the default behaviour
:param scaleFactor: (C E) When used, will scale the sampled value by the specified amount
The default scale factor is 1.0 Negative values are acceptable for displacement, bu
:param shareUV: (C E) When used, UVs are shared at a vertex when sampled By default UVs
are forced to be unshared
:param useLightShadows: (C E) When used, will use each lights shadow map options Otherwise
these options will be overrridden when the computeShadows, and/or reusedShadows option
:returns: Success or Failure
"""
pass
def ToggleMeshEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def uvSnapshot(*args, antiAliased: bool=True, blueColor: int=255, entireUVRange: bool=True,
fileFormat: AnyStr="", greenColor: int=255, name: AnyStr="", overwrite:
bool=True, redColor: int=255, uMax: float=0.0, uMin: float=0.0, uvSetName:
AnyStr="", vMax: float=0.0, vMin: float=0.0, xResolution: int=512, yResolution:
int=512, **kwargs)->None:
"""
Builds an image containg the UVs of the selected objects
:param antiAliased: (C) When this flag is set, lines are antialiased
:param blueColor: (C) Blue component of line drawing Default is 255
:param entireUVRange: (C) When this flag is set, the generated image will contain the
entire uv range Default is UV in 0-1 range
:param fileFormat: (C) Output file format Any of those keyword: "iff", "sgi", "pic", "tif",
"als", "gif", "rla", "jpg" Default is iff
:param greenColor: (C) Green component of line drawing Default is 255
:param name: (C) Name of the file to be created
:param overwrite: (C) When this flag is set, existing file can be ovewritten
:param redColor: (C) Red component of line drawing Default is 255
:param uMax: (C) Optional User Specified Max value for U Default value is 1 This will
take precedence over the "entire range" -euv flag
:param uMin: (C) Optional User Specified Min value for U Default value is 0 This will
take precedence over the "entire range" -euv flag
:param uvSetName: (C) Name of the uv set to use Default is the current one
:param vMax: (C) Optional User Specified Max value for V Default value is 1 This will
take precedence over the "entire range" -euv flag
:param vMin: (C) Optional User Specified Min value for V Default value is 0 This will
take precedence over the "entire range" -euv flag
:param xResolution: (C) Horizontal size of the image Default is 512
:param yResolution: (C) Vertical size of the image Default is 512
:returns:
"""
pass
def setFocus(*args, **kwargs)->None:
"""
Give keyboard focus to a specific control or panel, passed as an argument
:returns:
"""
pass
def HideObjectGeometry(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def formLayout(*args, annotation: Union[AnyStr, bool]="", attachControl: Union[List[AnyStr,
AnyStr, int, AnyStr], List[List[AnyStr, AnyStr, int, AnyStr]]]=None, attachForm:
Union[List[AnyStr, AnyStr, int], List[List[AnyStr, AnyStr, int]]]=None,
attachNone: Union[List[AnyStr, AnyStr], List[List[AnyStr, AnyStr]]]=None,
attachOppositeControl: Union[List[AnyStr, AnyStr, int, AnyStr], List[List[AnyStr,
AnyStr, int, AnyStr]]]=None, attachOppositeForm: Union[List[AnyStr, AnyStr, int],
List[List[AnyStr, AnyStr, int]]]=None, attachPosition: Union[List[AnyStr, AnyStr,
int, int], List[List[AnyStr, AnyStr, int, int]]]=None, backgroundColor:
Union[List[float, float, float], bool]=None, childArray: bool=True,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float, float,
float], bool]=None, isObscured: bool=True, manage: bool=True, noBackground:
bool=True, numberOfChildren: bool=True, numberOfDivisions: Union[int, bool]=0,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="", popupMenuArray:
bool=True, preventOverride: bool=True, statusBarMessage: AnyStr="", useTemplate:
AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script, bool]=None,
width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a form layout control A form layout allows absolute and relative
positioning of the controls that are its immediate children Controls have four edges: top,
left, bottom and right There are only two directions that children can be positioned in,
right-left and up-down The attach flags take the direction of an attachment fro
:param annotation: (C Q E) Annotate the control with an extra string value
:param attachControl: (C E M) Arguments are: control, edge, offset, control Valid edge
values are: "top" | "bottom" | "left" | "right" Attach a control to another control
:param attachForm: (C E M) Arguments are: control, edge, offset Valid edge values are:
"top" | "bottom" | "left" | "right" Attach the specified control to the form, offset by
:param attachNone: (C E M) Arguments are: control, edge Valid edge values are: "top" |
"bottom" | "left" | "right" Attach a control to nothing
:param attachOppositeControl: (C E M) Arguments are: control, edge, offset, control Valid
edge values are: "top" | "bottom" | "left" | "right" Attach a control to the opposite side
of an
:param attachOppositeForm: (C E M) Arguments are: control, edge, offset Valid edge values
are: "top" | "bottom" | "left" | "right" Attach a control to the opposite side of the
form
:param attachPosition: (C E M) Arguments are: control, edge, offset, position Valid edge
values are: "top" | "bottom" | "left" | "right" Attach a control to a position in the
form
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfDivisions: (C Q E) Specify the number of horizontal and vertical divisions
across the form Value must be greater than 0
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The full name of the control.
"""
pass
def polyIterOnPoly(*args, **kwargs)->None:
"""
"""
pass
def xgmClumpBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def FreeTangentWeight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeUpdatePSDNetworks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def shaderfx(*args, **kwargs)->None:
"""
"""
pass
def AddFloorContactPlane(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateSubdivPlane(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dirmap(*args, convertDirectory: AnyStr="", enable: bool=True, getAllMappings: bool=True,
getMappedDirectory: AnyStr="", mapDirectory: List[AnyStr, AnyStr]=None,
unmapDirectory: AnyStr="", q=True, query=True, **kwargs)->Union[AnyStr, Any]:
"""
Use this command to map a directory to another directory The first argument is the
directory to map, and the second is the destination directory to map to Directories must
both be absolute paths, and should be separated with forward slashes ('/') The mapping is
case-sensitive on all platforms This command can be useful when moving projects to
:param convertDirectory: (C) Convert a file or directory Returns the name of the mapped
file or directory, if the command is enabled If the given string contains one of the map
:param enable: (C Q) Enable directory mapping Directory mapping is off when you start Maya
If enabled, when opening Maya scenes, file texture paths (and other file path
:param getAllMappings: (C) Get all current mappings Returns string array of current
mappings in format: [redirect1, replacement1, .. redirectN, replacementN]
:param getMappedDirectory: (C) Get the mapped redirected directory The given argument must
exactly match the first string used with the -mapDirectory flag
:param mapDirectory: (C) Map a directory - the first argument is mapped to the second
Neither directory needs to exist on the local machine at the time of invocation
:param unmapDirectory: (C) Unmap a directory The given argument must exactly match the
argument used with the -mapDirectory flag
:returns: when convertDirectory is used
"""
pass
def fluidReplaceFramesOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllPoses(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DuplicateEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FlipTriangleEdge(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyAverageVertex(*args, caching: bool=True, constructionHistory: bool=True, iterations:
Union[int, bool]=0, name: AnyStr="", nodeState: Union[int, bool]=0,
worldSpace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Moves the selected vertices of a polygonal object to round its shape Translate, move,
rotate or scale vertices
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param iterations: (C Q E) Number of rounding steps
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def ToggleTimeSlider(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ScaleCurvatureOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyNormalPerVertex(*args, allLocked: bool=True, deformable: bool=True, freezeNormal:
bool=True, normalX: Union[float, bool]=0.0, normalXYZ: Union[List[float,
float, float], List[List[float, float, float]], bool]=None, normalY:
Union[float, bool]=0.0, normalZ: Union[float, bool]=0.0, relative:
bool=True, unFreezeNormal: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[bool, Any]:
"""
Command associates normal(x, y, z) with vertices on polygonal objects When used with the
query flag, it returns the normal associated with the specified components However, when
queried, the command returns all normals (all vtx-face combinations) on the vertex,
regardless of whether they are shared or not
:param allLocked: (C Q E) Queries if all normals on the selected vertices are locked
(frozen) or not
:param deformable: (C Q E) DEFAULT true OBSOLETE flag This flag will be removed in the
next release
:param freezeNormal: (C Q E) Specifies that the normal values be frozen (locked) at the
current value
:param normalX: (C Q E) Specifies the x value normal
:param normalXYZ: (C Q E M) Specifies the xyz values normal If this flag is used singly,
the specified normal xyz values are used for all selected components If the flag is use
:param normalY: (C Q E) Specifies the y value normal
:param normalZ: (C Q E) Specifies the z value normal
:param relative: (C Q E) When used, the normal values specified are added relative to the
current value
:param unFreezeNormal: (C Q E) Specifies that the normal values that were frozen at the
current value be un-frozen (un-locked)
:returns: Success or Failure.
"""
pass
def HypershadeGraphRemoveUpstream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dbmessage(*args, file: AnyStr="", list: bool=True, monitor: bool=True, type: AnyStr="",
**kwargs)->None:
"""
The dbmessage command is used to install monitors for certain message types, dumping debug
information as they are sent so that the flow of messages can be examined
:param file: (C) Destination file of the message monitoring information Use the special
names stdout and stderr to redirect to your command window As well, the spec
:param list: (C) List all available message types and their current enabled status
:param monitor: (C) Set the monitoring state of the message type ('on' to enable, 'off' to
disable) Returns the list of all message types being monitored after the chan
:param type: (C) Monitor only the messages whose name matches this keyword (default is
all)
:returns:
"""
pass
def NURBSTexturePlacementToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddWire(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createPolyPlaneCtx(*args, **kwargs)->None:
"""
"""
pass
def HideNCloths(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateImagePlane(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CVCurveToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Tension(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideTexturePlacements(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HIKSelectedMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeDisplayAsLargeSwatches(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSplineSelectConvertToFreeze(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtractSubdivSurfaceVertices(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PreferencesWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_lockSelTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def blendShapePanel(*args, blendShapeEditor: bool=True, control: bool=True, copy: AnyStr="",
createString: bool=True, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", editString: bool=True, exists: bool=True, init: bool=True,
isUnique: bool=True, label: Union[AnyStr, bool]="", menuBarRepeatLast:
bool=True, menuBarVisible: bool=True, needsInit: bool=True, parent:
AnyStr="", popupMenuProcedure: Union[Script, bool]=None, replacePanel:
AnyStr="", tearOff: bool=True, tearOffCopy: AnyStr="", tearOffRestore:
bool=True, unParent: bool=True, useTemplate: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a panel that derives from the base panel class that houses a
blendShapeEditor
:param blendShapeEditor: (Q) Query only flag that returns the name of an editor to be
associated with the panel
:param control: (Q) Returns the top level control for this panel Usually used for getting
a parent to attach popup menus CAUTION: panels may not have controls at times
:param copy: (E) Makes this panel a copy of the specified panel Both panels must be of the
same type
:param createString: (E) Command string used to create a panel
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the Maya panel
:param editString: (E) Command string used to edit a panel
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param init: (C E) Initializes the panel's default state This is usually done
automatically on file -new and file -open
:param isUnique: (Q) Returns true if only one instance of this panel type is allowed
:param label: (Q E) Specifies the user readable label for the panel
:param menuBarRepeatLast: (C Q E) Controls whether clicking on the menu header with the
middle mouse button would repeat the last selected menu item
:param menuBarVisible: (C Q E) Controls whether the menu bar for the panel is displayed
:param needsInit: (Q E) (Internal) On Edit will mark the panel as requiring initialization
Query will return whether the panel is marked for initialization Used during fil
:param parent: (C) Specifies the parent layout for this panel
:param popupMenuProcedure: (Q E) Specifies the procedure called for building the panel's
popup menu(s) The default value is "buildPanelPopupMenu" The procedure should take one
stri
:param replacePanel: (E) Will replace the specified panel with this panel If the target
panel is within the same layout it will perform a swap
:param tearOff: (Q E) Will tear off this panel into a separate window with a paneLayout as
the parent of the panel When queried this flag will return if the panel has bee
:param tearOffCopy: (C) Will create this panel as a torn of copy of the specified source
panel
:param tearOffRestore: (C E) Restores panel if it is torn off and focus is given to it If
docked, becomes the active panel in the docked window This should be the default flag
:param unParent: (E) Specifies that the panel should be removed from its layout This
(obviously) cannot be used with query
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the panel
"""
pass
def dR_renderLastTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddKeysTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideStrokePathCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def globalStitch(*args, caching: bool=True, lockSurface: Union[bool, List[bool]]=False,
maxSeparation: Union[float, bool]=0.1, modificationResistance: Union[float,
bool]=1, nodeState: Union[int, bool]=0, sampling: Union[int, bool]=1,
stitchCorners: Union[int, bool]=1, stitchEdges: Union[int, bool]=1,
stitchPartialEdges: bool=False, stitchSmoothness: Union[int, bool]=0,
constructionHistory: bool=True, name: AnyStr="", object: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command computes a globalStitch of NURBS surfaces There should be at least one NURBS
surface The NURBS surface(s) should be untrimmed
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param lockSurface: (C Q E M) Keep the NURBS surface at the specified multi index unchanged
by the fitting Default: false
:param maxSeparation: (C Q E) Maximum separation that will still be stitched Default: 0.1
:param modificationResistance: (C Q E) Modification resistance weight for surface CVs
Default: 1e-1
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param sampling: (C Q E) Sampling when stitching edges Default: 1
:param stitchCorners: (C Q E) Stitch corners of surfaces 0 - off 1 - closest point 2 -
closest knot Default: 1
:param stitchEdges: (C Q E) Stitch edges of surfaces 0 - off 1 - closest point 2 -
matching params Default: 1
:param stitchPartialEdges: (C Q E) Toggle on (off) partial edge stitching Default: false
:param stitchSmoothness: (C Q E) Set type of smoothness of edge join 0 - off 1 - tangent 2
- normal Default: 0
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:returns: Object name and node name
"""
pass
def HypershadeSetTraversalDepthZero(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SmoothTangent(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def arcLengthDimension(*args, **kwargs)->AnyStr:
"""
This command is used to create an arcLength dimension to display the arcLength of a
curve/surface at a specified point on the curve/surface
:returns: Name of the arcLengthDimension node created
"""
pass
def HypershadeDeleteSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectNone(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def clipEditor(*args, allTrackHeights: int=0, autoFit: Union[AnyStr, bool]="", autoFitTime:
Union[AnyStr, bool]="", clipDropCmd: AnyStr="", clipStyle: Union[int, bool]=2,
control: bool=True, defineTemplate: AnyStr="", deleteCmd: AnyStr="",
deselectAll: bool=True, displayActiveKeyTangents: AnyStr="", displayActiveKeys:
AnyStr="", displayInfinities: AnyStr="", displayKeys: AnyStr="",
displayTangents: AnyStr="", displayValues: AnyStr="", docTag: Union[AnyStr,
bool]="", exists: bool=True, filter: Union[AnyStr, bool]="",
forceMainConnection: Union[AnyStr, bool]="", frameAll: bool=True, frameRange:
Union[List[float, float], bool]=None, highlightConnection: Union[AnyStr,
bool]="", highlightedBlend: Union[List[AnyStr, AnyStr], bool]=None,
highlightedClip: Union[List[AnyStr, AnyStr], bool]=None, initialized: bool=True,
listAllCharacters: bool=True, listCurrentCharacters: bool=True,
lockMainConnection: bool=True, lookAt: AnyStr="", mainListConnection:
Union[AnyStr, bool]="", manageSequencer: bool=True, menuContext: Union[AnyStr,
bool]="", panel: Union[AnyStr, bool]="", parent: Union[AnyStr, bool]="",
selectBlend: Union[List[AnyStr, AnyStr, AnyStr], bool]=None, selectClip:
Union[List[AnyStr, AnyStr], bool]=None, selectionConnection: Union[AnyStr,
bool]="", snapTime: Union[AnyStr, bool]="", snapValue: Union[AnyStr, bool]="",
stateString: bool=True, unParent: bool=True, unlockMainConnection: bool=True,
updateMainConnection: bool=True, useTemplate: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a clip editor with the given name
:param allTrackHeights: () OBSOLETE flag Use clipStyle instead
:param autoFit: (Q E) on | off | tgl Auto fit-to-view
:param autoFitTime: (Q E) on | off | tgl Auto fit-to-view along the time axis, as well
:param clipDropCmd: (E) Command executed when clip node is dropped on the TraX editor
:param clipStyle: (Q E) Set/return the clip track style in the specified editor Default is
2 Valid values are 1-3
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param deleteCmd: (E) Command executed when backspace key is pressed
:param deselectAll: (E) Deselect all clips and blends in the editor
:param displayActiveKeyTangents: (E) on | off | tgl Display active key tangents in the
editor
:param displayActiveKeys: (E) on | off | tgl Display active keys in the editor
:param displayInfinities: (E) on | off | tgl Display infinities in the editor
:param displayKeys: (E) on | off | tgl Display keyframes in the editor
:param displayTangents: (E) on | off | tgl Display tangents in the editor
:param displayValues: (E) on | off | tgl Display active keys and tangents values in the
editor
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param frameAll: (E) Frame view around all clips in the editor
:param frameRange: (Q E) The editor's current frame range
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param highlightedBlend: (Q) Returns the highlighted blend, listed as scheduler and index
:param highlightedClip: (Q) Returns the highlighted clip, listed as scheduler and index
:param initialized: (Q) Returns whether the clip editor is fully initialized, and has a
port to draw through If not, the -frameRange and -frameAll flags will fail
:param listAllCharacters: (E) List all characters in the editor and outliner
:param listCurrentCharacters: (E) List only the characters in the editor and outliner
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param lookAt: (E) all | selected | currentTime FitView helpers
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param manageSequencer: (C Q E) Sets/returns whether the clip editor should manage
sequencer nodes If so, animation clips and characters are not represented
:param menuContext: (Q) Returns a string array denoting the type of data object the cursor
is over Returned values are: {"timeSlider"} {"nothing"} {"track", "track index",
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param selectBlend: (Q E) Select the blends specified by the scheduler name and the
indicies of the two clips used in the blend When queried, a string containing the
schedule
:param selectClip: (Q E) Selects the clip specified by the scheduler name and the clip
index When queried, a string containing the scheduler and clip index of all of the sel
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param snapTime: (Q E) none | integer | keyframe Keyframe move snap in time
:param snapValue: (Q E) none | integer | keyframe Keyframe move snap in values
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: Editor name
"""
pass
def falloffCurve(*args, addControlVertex: AnyStr="", annotation: Union[AnyStr, bool]="",
asString: Union[AnyStr, bool]="", backgroundColor: Union[List[float, float,
float], bool]=None, changeCommand: Script=None, currentKey: Union[int, bool]=0,
currentKeyValue: Union[List[float, float], bool]=None, customCurveWidget:
bool=True, defineTemplate: AnyStr="", deleteControlVertex: int=0, docTag:
Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback: Script=None,
enable: bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
exists: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, manage: bool=True, noBackground: bool=True, numberOfPopupMenus:
bool=True, optionVar: Union[AnyStr, bool]="", parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, readOnly: bool=True,
snapToGrid: bool=True, statusBarMessage: AnyStr="", useTemplate: AnyStr="",
visible: bool=True, visibleChangeCommand: Union[Script, bool]=None, width:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a control for editing a 2D control curve The control attaches to an
optionVar used to store and retrieve the encoded control points stored in a string
:param addControlVertex: (E) Used to add a control vertex for the curve
:param annotation: (C Q E) Annotate the control with an extra string value
:param asString: (Q E) Used to query and set the value of the curve as a string of comma
separated values
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (E) Specifies a command to be executed whenever the value of this
curve is modified This option should not be used when specifying an optionVar
:param currentKey: (C Q E) Returns the index of the currently selected key
:param currentKeyValue: (Q E) Get or set the value of the currently selected key
:param customCurveWidget: (C Q E) Determines whether or not the curve widget is using a
custom curve When a custom curve is used, it is stored by a falloff curve in the brush
tool se
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param deleteControlVertex: (E) Used to delete a control vertex of the curve
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param optionVar: (C Q E) Specifies the name of the option var used to store and retrieve
the string value capturing the curve
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param readOnly: (C Q E) Specifies if the curve is read only or not If true, the curve
can't be edited
:param snapToGrid: (C Q E) Specifies whether or not curve control points snap to grid when
they are being moved
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the port created or modified
"""
pass
def ChangeVertexSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RotateUVsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetCombBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SaveCurrentWorkspace(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def unfold(*args, applyToShell: bool=True, areaWeight: float=0.0, globalBlend: float=0.0,
globalMethodBlend: float=0.0, iterations: int=0, optimizeAxis: int=0, pinSelected:
bool=True, pinUvBorder: bool=True, scale: float=0.0, stoppingThreshold: float=0.0,
useScale: bool=True, **kwargs)->int:
"""
None
:param applyToShell: (C) Specifies that the selected components should be only work on
shells that have something have been selected or pinned
:param areaWeight: (C) Surface driven importance 0 treat all faces equal 1 gives more
importance to large ones
:param globalBlend: (C) This allows the user to blend between a local optimization method
(globalBlend = 0.0) and a global optimization method (globalBlend = 1.0) The local
:param globalMethodBlend: (C) The global optimization method uses two functions to compute
a minimization The first function controls edge stretch by using edges lengths between
:param iterations: (C) Maximum number of iterations for each connected UV piece
:param optimizeAxis: (C) Degree of freedom for optimization 0=Optimize freely, 1=Move
vertically only, 2=Move horzontally only
:param pinSelected: (C) Specifies that the selected components should be pinned instead the
unselected components
:param pinUvBorder: (C) Specifies that the UV border should be pinned when doing the solve
By default only unselected components are pinned
:param scale: (C) Ratio between 2d and 3d space
:param stoppingThreshold: (C) Minimum distorsion improvement between two steps in %
:param useScale: (C) Adjust the scale or not
:returns: the number of relaxation iterations carried out
"""
pass
def MakeLive(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HIKComputeReference(*args, **kwargs)->None:
"""
"""
pass
def PolyConvertToLoopAndDelete(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllTransforms(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleEdgeMetadata(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fluidMergeCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleContainerCentric(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ReplaceObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateCharacterOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SineOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtendSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CustomNURBSSmoothness(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HIKSetBodyPartKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PoseEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_activeHandleX(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleCurrentFrame(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def aimConstraint(*args, aimVector: Union[List[float, float, float], bool]=None, layer:
AnyStr="", maintainOffset: bool=True, name: Union[AnyStr, bool]="", offset:
Union[List[float, float, float], bool]=None, remove: bool=True, skip:
Union[AnyStr, List[AnyStr]]="", targetList: bool=True, upVector:
Union[List[float, float, float], bool]=None, weight: Union[float, bool]=0.0,
weightAliasList: bool=True, worldUpObject: Union[name, bool]=None,
worldUpType: Union[AnyStr, bool]="", worldUpVector: Union[List[float, float,
float], bool]=None, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
Constrain an object's orientation to point at a target object or at the average position of
a number of targets An aimConstraint takes as input one or more "target" DAG transform
nodes at which to aim the single "constraint object" DAG transform node The aimConstraint
orients the constrained object such that the aimVector (in the object's local
:param aimVector: (C Q E) Set the aim vector This is the vector in local coordinates that
points at the target If not given at creation time, the default value of (1.0, 0.0,
:param layer: (C E) Specify the name of the animation layer where the constraint should be
added
:param maintainOffset: (C) The offset necessary to preserve the constrained object's
initial rotation will be calculated and used as the offset
:param name: (C Q E) Sets the name of the constraint node to the specified name Default
name is constrainedObjectName_constraintType
:param offset: (C Q E) Sets or queries the value of the offset Default is 0,0,0
:param remove: (E) removes the listed target(s) from the constraint
:param skip: (C E M) Specify the axis to be skipped Valid values are "x", "y", "z" and
"none" During creation, "none" is the default
:param targetList: (Q) Return the list of target objects
:param upVector: (C Q E) Set local up vector This is the vector in local coordinates that
aligns with the world up vector If not given at creation time, the default value o
:param weight: (C Q E) Sets the weight value for the specified target(s) If not given at
creation time, the default value of 1.0 is used
:param weightAliasList: (Q) Returns the names of the attributes that control the weight of
the target objects Aliases are returned in the same order as the targets are returned
:param worldUpObject: (C Q E) Set the DAG object use for worldUpType "object" and
"objectrotation" See worldUpType for greater detail The default value is no up object,
which is
:param worldUpType: (C Q E) Set the type of the world up vector computation The
worldUpType can have one of 5 values: "scene", "object", "objectrotation", "vector", or
"none"
:param worldUpVector: (C Q E) Set world up vector This is the vector in world coordinates
that up vector should align with See -wut/worldUpType (below)for greater detail If not
:returns: name of the created constraint node
"""
pass
def scrollLayout(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, borderVisible: bool=True, childArray: bool=True,
childResizable: bool=True, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
exists: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None,
horizontalScrollBarThickness: int=0, isObscured: bool=True, manage: bool=True,
minChildWidth: Union[int, bool]=0, noBackground: bool=True, numberOfChildren:
bool=True, numberOfPopupMenus: bool=True, panEnabled: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
resizeCommand: Script=None, scrollAreaHeight: bool=True, scrollAreaValue:
bool=True, scrollAreaWidth: bool=True, scrollByPixel: List[AnyStr, int]=None,
scrollPage: AnyStr="", statusBarMessage: AnyStr="", useTemplate: AnyStr="",
verticalScrollBarAlwaysVisible: bool=True, verticalScrollBarThickness: int=0,
visible: bool=True, visibleChangeCommand: Union[Script, bool]=None, width:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a scroll layout A scroll layout is useful for when you have a number
of controls which cannot all be visible at a time This layout will display a horizontal
and/or vertical scroll bar when necessary to bring into view the hidden controls Since the
scroll layout provides no real positioning of children you should use another
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param borderVisible: (C Q E) Visibility of the border
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param childResizable: (C Q) Set to true if you want the child of the control layout to be
as wide as the scroll area You may also indicate a minimum width for the child using t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param horizontalScrollBarThickness: (C E) Thickness of the horizontal scroll bar Specify
an integer value of pixels greater than or equal to 0 Other than setting the value to 0 to
hide the
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param minChildWidth: (C Q) A positive non-zero integer value indicating the minimum width
the scroll layout's child This flag only has meaning when the -cr/childResizable flag
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param panEnabled: (Q E) Set to true if you want to pan the scroll layout using ALT + MMB
On OSX, in one button and two button mode, you could use command+alt+LMB to pan it
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param resizeCommand: (C E) The command invoked when the scroll layout is resized
:param scrollAreaHeight: (Q) Return the height of the scroll area (in pixels)
:param scrollAreaValue: (Q) Return the vertical and horizontal values of the scroll area
(in pixels)
:param scrollAreaWidth: (Q) Return the width of the scroll area (in pixels)
:param scrollByPixel: (E) Scroll the client area in the direction of the string The int
specifies the number of pixels
:param scrollPage: (E) Scroll the client area in the direction of the string Valid values
are "up", "down", "left" or "right"
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param verticalScrollBarAlwaysVisible: (C) Set to true if you want to always have the
vertical scroll bar visible
:param verticalScrollBarThickness: (C E) Thickness of the vertical scroll bar Specify an
integer value of pixels greater than or equal to 0 This flag has no effect on Windows
systems
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def GeometryConstraintOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateNSoftBody(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def reverseSurface(*args, caching: bool=True, direction: Union[int, bool]=0, nodeState:
Union[int, bool]=0, constructionHistory: bool=True, name: AnyStr="", object:
bool=True, replaceOriginal: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The reverseSurface command reverses one or both directions of a surface or can be used to
"swap" the U and V directions (this creates the effect of reversing the surface normal)
The name of the newly reversed surface and the name of the resulting dependency node is
returned The resulting surface has the same parameter ranges as the original surfa
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param direction: (C Q E) The direction to reverse the surface in: 0 - U, 1 - V, 2 - Both U
and V, 3 - Swap Default: 0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def SymmetrizeSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def directKeyCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name:
AnyStr="", option: Union[AnyStr, bool]="", selectedOnly: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a context which may be used to directly manipulate keyframes within
the graph editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param option: (C Q E) Valid values are "move," "insert," "over," and "segmentOver." When
you "move" a key, the key will not cross over (in time) any keys before or after i
:param selectedOnly: (C Q E) Controls whether only selected curves/keys can be moved, or
all
:returns: Context name
"""
pass
def HideBoundingBox(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def switchTable(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True, exists:
bool=True, fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True, label1:
AnyStr="", label2: AnyStr="", manage: bool=True, noBackground: bool=True,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="", popupMenuArray:
bool=True, preventOverride: bool=True, selectedRow: bool=True,
statusBarMessage: AnyStr="", switchNode: Union[name, bool]=None,
underPointerRow: bool=True, useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates/edits/queries the switch table control The optional argument is the
name of the control
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label1: (E) Set the label of the first column
:param label2: (E) Set the label of the second column
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param selectedRow: (Q) The current row selected
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param switchNode: (Q E) The switch node to be displayed in the control
:param underPointerRow: (Q) The row under the pointer
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the switch table control.
"""
pass
def rehash(*args, **kwargs)->None:
"""
"""
pass
def ModifyUVVectorRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportUpAxis(*args, **kwargs)->None:
"""
"""
pass
def PaintGridOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ParentBaseWireOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetCurrentUVSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nClothReplaceFrames(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_showOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def isConnected(*args, ignoreUnitConversion: bool=True, **kwargs)->bool:
"""
The isConnected command is used to check if two plugs are connected in the dependency graph
The return value is false if they are not and true if they are The first string
specifies the source plug to check for connection The second one specifies the destination
plug to check for connection
:param ignoreUnitConversion: (C) In looking for connections, skip past unit conversion
nodes
:returns: Are the two plugs connected?
"""
pass
def SelectPreviousObjects3dsMax(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SurfaceBooleanSubtractToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TransformPolygonComponent(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def StitchSurfacePointsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TogglePolygonFaceTriangles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyQuad(*args, angle: Union[float, bool]=30, caching: bool=True, constructionHistory:
bool=True, keepGroupBorder: bool=True, keepHardEdges: bool=True,
keepTextureBorders: bool=True, name: AnyStr="", nodeState: Union[int, bool]=0,
worldSpace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Merges selected triangles of a polygonal object into four-sided faces
:param angle: (C Q E) Angle threshold above which two triangles are not merged C: Default
is 30 degrees The range is [0.0, 180.0] Q: When queried, this flag returns a f
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param keepGroupBorder: (C Q E) Keep facet group border : If "on", the borders of selected
faces are maintained, otherwise the borders of selected facets may be modified C: Default
:param keepHardEdges: (C Q E) Keep hard edges : If "on", the hard edges of selected faces
are maintained, otherwise they may be deleted between two triangles C: Default is "on"
:param keepTextureBorders: (C Q E) Keep texture border : If "on", the borders of texture
maps are maintained, otherwise the boreders of texture maps may be modified C: Default is
"on"
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def CreatePolygonSphereOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def attachCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def preloadRefEd(*args, control: bool=True, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", exists: bool=True, filter: Union[AnyStr, bool]="",
forceMainConnection: Union[AnyStr, bool]="", highlightConnection: Union[AnyStr,
bool]="", lockMainConnection: bool=True, mainListConnection: Union[AnyStr,
bool]="", panel: Union[AnyStr, bool]="", parent: Union[AnyStr, bool]="",
selectCommand: Union[Script, bool]=None, selectFileNode: bool=True,
selectionConnection: Union[AnyStr, bool]="", stateString: bool=True, unParent:
bool=True, unlockMainConnection: bool=True, updateMainConnection: bool=True,
useTemplate: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This creates an editor for managing which references will be read in (loaded) and which
deferred (unloaded) upon opening a file
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param selectCommand: (C Q E) A script to be executed when an item is selected
:param selectFileNode: (Q) Query the currently selected load setting Returns the id of the
currently selected load setting This id can be used as an argument to the selLoadSe
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: Name of editor
"""
pass
def FBXImport(*args, **kwargs)->None:
"""
"""
pass
def xgmSplineCache(*args, **kwargs)->None:
"""
"""
pass
def DeformerSetEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorSelectConnected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVNormalBasedProjectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cacheAppendOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def isTrue(*args, **kwargs)->None:
"""
This commmand returns the state of the named condition If the condition is true, it
returns 1 Otherwise it returns 0
:returns:
"""
pass
def deformerEvaluator(*args, chains: bool=True, meshes: bool=True, q=True, query=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
Print debug information about deformer evaluator status In query mode the debug
information is returned as a string[], otherwise the information is displayed in the script
editor
:param chains: (C Q) Print information about all supported deformation chains
:param meshes: (C Q) Print information about all meshes
:returns: the debug information when query mode is used.
"""
pass
def TangentsAuto(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ContourProjection(*args, **kwargs)->None:
"""
unknown
"""
pass
def ResetSoftSelectOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_vertLockSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVSnapTogetherOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyPlanarProjection(*args, projectionHorizontalSweep: Union[float, bool]=0.0, seamCorrect:
bool=True, caching: bool=True, constructionHistory: bool=True,
createNewMap: bool=True, imageCenter: Union[List[float, float],
bool]=None, imageCenterX: Union[float, bool]=0.0, imageCenterY:
Union[float, bool]=0.0, imageScale: Union[List[float, float],
bool]=None, imageScaleU: Union[float, bool]=0.0, imageScaleV:
Union[float, bool]=0.0, insertBeforeDeformers: bool=True,
keepImageRatio: bool=True, mapDirection: AnyStr="", name: AnyStr="",
nodeState: Union[int, bool]=0, perInstance: bool=True,
projectionCenter: Union[List[float, float, float], bool]=None,
projectionCenterX: Union[float, bool]=0.0, projectionCenterY:
Union[float, bool]=0.0, projectionCenterZ: Union[float, bool]=0.0,
projectionHeight: Union[float, bool]=0.0, projectionScale:
Union[List[float, float], bool]=None, rotate: Union[List[float, float,
float], bool]=None, rotateX: Union[float, bool]=0.0, rotateY:
Union[float, bool]=0.0, rotateZ: Union[float, bool]=0.0,
rotationAngle: Union[float, bool]=0.0, smartFit: bool=True,
worldSpace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
TpolyProjCmdBase is a base class for the command to create a mapping on the selected
polygonal faces Projects a map onto an object, using an orthogonal projection The piece
of the map defined from isu, isv, icx, icy area, is placed at pcx, pcy, pcz location
:param projectionHorizontalSweep: (C Q E) The angle swept horizontally by the projection
The range is [0, 360]
:param seamCorrect: (C Q E) This flag specifies to perform a seam correction on the mapped
faces
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createNewMap: (C Q) This flag when set true will create a new map with a the name
passed in, if the map does not already exist
:param imageCenter: (C Q E) The center point of the 2D model layout Default: 0.5, 0.5
:param imageCenterX: (C Q E) Image center X coord
:param imageCenterY: (C Q E) Image center Y coord
:param imageScale: (C Q E) Specifies the UV scale : Enlarges or reduces the 2D version of
the model in U or V space relative to the 2D centerpoint Default: 1.0, 1.0
:param imageScaleU: (C Q E) The the U scale : Enlarges or reduces the 2D version of the
model in U space relative to the 2D centerpoint
:param imageScaleV: (C Q E) The V scale : Enlarges or reduces the 2D version of the model
in V space relative to the 2D centerpoint
:param insertBeforeDeformers: (C) This flag specifies if the projection node should be
inserted before or after deformer nodes already applied to the shape Inserting the
projection a
:param keepImageRatio: (C) True means keep any image ratio
:param mapDirection: (C) This flag specifies the mapping direction 'x', 'y' and 'z'
projects the map along the corresponding axis 'c' projects along the current camera view
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param perInstance: (C) True if the new map is per-instance, otherwise it is shared
:param projectionCenter: (C Q E) The point on the object that will be the center of the
projection Default: 0.0, 0.0, 0.0
:param projectionCenterX: (C Q E) Projection center X coord
:param projectionCenterY: (C Q E) Projection center Y coord
:param projectionCenterZ: (C Q E) Projection center Z coord
:param projectionHeight: (C Q E) The height of the map relative to the 3D projection axis
:param projectionScale: (C Q E) The width and the height of the map relative to the 3D
projection axis Default: 1.0, 1.0
:param rotate: (C Q E) The mapping rotate angles Default: 0.0, 0.0, 0.0
:param rotateX: (C Q E) X mapping rotate angle
:param rotateY: (C Q E) Y mapping rotate angle
:param rotateZ: (C Q E) Z mapping rotate angle
:param rotationAngle: (C Q E) The angle for the rotation When the angle is positive, then
the map rotates counterclockwise on the mapped model; if negative, the map rotates clock
:param smartFit: (C) True means use the smart fit algorithm
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def DeleteFBIKAllKeys(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddPondDynamicBuoyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BakeTopologyToTargets(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyAssignSubdivHole(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExpressionEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ArtPaintAttrTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def loft(*args, autoReverse: bool=True, caching: bool=True, close: bool=False, createCusp:
Union[bool, List[bool]]=False, degree: Union[int, bool]=3, nodeState: Union[int,
bool]=0, reverse: Union[bool, List[bool]]=False, reverseSurfaceNormals: bool=False,
sectionSpans: Union[int, bool]=1, uniform: bool=False, constructionHistory: bool=True,
name: AnyStr="", object: bool=True, polygon: int=0, range: bool=True, rebuild:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command computes a skinned (lofted) surface passing through a number of NURBS curves
There must be at least two curves present The NURBS curves may be surface isoparms, curve
on surfaces, trimmed edges or polygon edges
:param autoReverse: (C Q E) If set to true, the direction of the curves for the loft is
computed automatically If set to false, the values of the multi-use reverse flag are use
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param close: (C Q E) If set to true, the resulting surface will be closed (periodic) with
the start (end) at the first curve If set to false, the surface will remain ope
:param createCusp: (C Q E M) Multi-use flag; each occurence of the flag refers to the
matching curve in the loft operation; if the flag is set the particular profile will have
a
:param degree: (C Q E) The degree of the resulting surface Default: 3
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param reverse: (C Q E M) Multi-use flag; each occurence of the flag refers to the matching
curve in the loft operation; if the flag is set the particular curve will be revers
:param reverseSurfaceNormals: (C Q E) If set, the surface normals on the output NURBS
surface will be reversed This is accomplished by swapping the U and V parametric
directions Default
:param sectionSpans: (C Q E) The number of surface spans between consecutive curves in the
loft Default: 1
:param uniform: (C Q E) If set to true, the resulting surface will have uniform
parameterization in the loft direction If set to false, the parameterization will be chord
l
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:param range: (C) Force a curve range on complete input curve
:param rebuild: (C) Rebuild the input curve(s) before using them in the operation Use
nurbsCurveRebuildPref to set the parameters for the conversion
:returns: Object name and node name
"""
pass
def TimeEditorToggleSnapToClipPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllSculptObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyMapCut(*args, caching: bool=True, constructionHistory: bool=True, moveratio:
Union[float, bool]=0.0, name: AnyStr="", nodeState: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Cut along edges of the texture mapping The cut edges become map borders
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param moveratio: (Q E) Cut open ratio related to the neighbor edge length of cut edge
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def greasePencil(*args, **kwargs)->None:
"""
"""
pass
def ReverseCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DetachSkin(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def meshReorder(*args, **kwargs)->None:
"""
"""
pass
def curveIntersect(*args, caching: bool=True, constructionHistory: bool=True, direction:
Union[List[float, float, float], bool]=None, directionX: Union[float,
bool]=0.0, directionY: Union[float, bool]=0.0, directionZ: Union[float,
bool]=0.0, nodeState: Union[int, bool]=0, tolerance: Union[float,
bool]=0.001, useDirection: bool=False, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
You must specify two curves to intersect This command either returns the parameter values
at which the given pair of curves intersect, or returns a dependency node that provides the
intersection information If you want to find the intersection of the curves in a specific
direction you must use BOTH the "-useDirection" flag and the "direction" fl
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C) Turn the construction history on or off
:param direction: (Q E) The direction that the input curves are projected in before
intersecting This vector is only used if "useDirection" flag is true
:param directionX: (Q E) The X component of the direction that the input curves are
projected in before intersecting This vector is only used if "useDirection" flag is true
:param directionY: (Q E) The Y component of the direction that the input curves are
projected in before intersecting This vector is only used if "useDirection" flag is true
:param directionZ: (Q E) The Z component of the direction that the input curves are
projected in before intersecting This vector is only used if "useDirection" flag is true
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param tolerance: (Q E) The tolerance that the intersection is calculated with For example,
given two curves end-to-end, the ends must be within tolerance for an intersecti
:param useDirection: (Q E) If true, use direction flag The input curves are first
projected in a specified direction and then intersected If false, this command will only
fin
:returns: the parameter values at which two curves intersect.
"""
pass
def runup(*args, cache: bool=True, fromPreviousFrame: bool=True, fromStartFrame: bool=True,
maxFrame: time=None, state: bool=True, **kwargs)->AnyStr:
"""
runup plays the scene through a frame of frames, forcing dynamic objects to evaluate as it
does so If no max frame is specified, runup runs up to the current time
:param cache: (C) Cache the state after the runup
:param fromPreviousFrame: (C) Run up the animation from the previously evaluated frame If
no flag is supplied this is the default
:param fromStartFrame: (C) Run up the animation from the start frame If no flag is
supplied -fromPreviousFrame is the default
:param maxFrame: (C) Ending time for runup, in current user time units The runup will
always start at the minimum start frame for all dynamic objects
:param state: (C) Turns runup and cache on/off
:returns: Command result
"""
pass
def gradientControlNoAttr(*args, annotation: Union[AnyStr, bool]="", asString: Union[AnyStr,
bool]="", backgroundColor: Union[List[float, float, float],
bool]=None, changeCommand: Script=None, currentKey: Union[int,
bool]=0, currentKeyChanged: Script=None, currentKeyColorValue:
Union[List[float, float, float], bool]=None, currentKeyCurveValue:
bool=True, currentKeyInterpValue: Union[int, bool]=0, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dragCommand: Script=None, dropCallback: Script=None, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus:
bool=True, exists: bool=True, fullPathName: bool=True, height:
Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, isObscured: bool=True, manage: bool=True, noBackground:
bool=True, numberOfPopupMenus: bool=True, optionVar: Union[AnyStr,
bool]="", parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, rampAsColor: bool=True, statusBarMessage:
AnyStr="", useTemplate: AnyStr="", valueAtPoint: Union[float,
bool]=0.0, visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a control for editing a ramp (2D control curve) The control attaches
to an optionVar used to store and retrieve the encoded gradient control points stored in a
string
:param annotation: (C Q E) Annotate the control with an extra string value
:param asString: (Q E) Used to query and set the value of the ramp as a string of comma
separated values
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (E) Specifies a command to be executed whenever the value of this
ramp is modified This option should not be used when specifying an optionVar
:param currentKey: (C Q E) Returns the index of the currently selected key
:param currentKeyChanged: (E) Specifies a command to be executed whenever the selected key
changes
:param currentKeyColorValue: (Q E) Get or set the color of the currently selected key Only
useful if the ramp is set to be a color ramp
:param currentKeyCurveValue: (Q E) Get or set the value of the currently selected key Only
useful if the ramp is set to be a curve ramp
:param currentKeyInterpValue: (Q E) Get or set the interpolation value for the current key
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (E) Specifies a command to be executed while the ramp is being
modified
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param optionVar: (C Q E) Specifies the name of the option var used to store and retrieve
the string value capturing the curve
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rampAsColor: (C Q E) Sets whether the ramp should be viewed as a colour ramp or as a
curve Default is as a curve
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param valueAtPoint: (Q) Used during query to specify the point at which to query the curve
In query mode, this flag needs a value
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the port created or modified
"""
pass
def SelectTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleUVEditorUVStatisticsHUD(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutTangentFlat(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sculpt(*args, after: bool=True, afterReference: bool=True, before: bool=True,
deformerTools: bool=True, dropoffDistance: Union[float, bool]=1.0, dropoffType:
Union[AnyStr, bool]="", exclusive: Union[AnyStr, bool]="", frontOfChain: bool=True,
geometry: Union[AnyStr, List[AnyStr], bool]="", geometryIndices: bool=True,
groupWithLocator: bool=True, ignoreSelected: bool=True, includeHiddenSelections:
bool=False, insideMode: Union[AnyStr, bool]="", maxDisplacement: Union[float,
bool]=1.0, mode: Union[AnyStr, bool]="", name: AnyStr="", objectCentered: bool=True,
parallel: bool=True, prune: bool=True, remove: Union[bool, List[bool]]=True,
sculptTool: AnyStr="", split: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
This command creates/edits/queries a sculpt object deformer By default for creation mode
an implicit sphere will be used as the sculpting object if no sculpt tool is specified The
name of the created/edited object is returned
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param dropoffDistance: (C Q E) Specifies the distance from the surface of the sculpt
object at which the sculpt object produces no deformation effect Default is 1.0 When
queried,
:param dropoffType: (C Q E) Specifies how the deformation effect drops off from maximum
effect at the surface of the sculpt object to no effect at dropoff distance limit Valid
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param groupWithLocator: (C) Groups the sculptor and its locator together under a single
transform Default is off
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param insideMode: (C Q E) Specifies how the deformation algorithm deals with points that
are inside the sculpting primitve The choices are: ring | even The default is even
:param maxDisplacement: (C Q E) Defines the maximum amount the sculpt object may move a
point on an object which it is deforming Default is 1.0 When queried, this flag returns a
f
:param mode: (C Q E) Specifies which deformation algorithm the sculpt object should use
The choices are: flip | project | stretch The default is stretch When queried,
:param name: (C) Used to specify the name of the node being created
:param objectCentered: (C) Places the sculpt and locator in the center of the bounding box
of the selected object(s) or components Default is off which centers the sculptor an
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param sculptTool: (C) Use the specified NURBS object as the sculpt tool instead of the
default implicit sphere
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:returns: Sculpt algorithm node name, sculpt sphere name, and sculpt stretch origin name
"""
pass
def PostInfinityOscillate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportAutoAxisEnable(*args, **kwargs)->None:
"""
"""
pass
def NodeEditorHideAttributes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyEditEdgeFlow(*args, adjustEdgeFlow: float=1.0, caching: bool=True, constructionHistory:
bool=True, edgeFlow: bool=True, name: AnyStr="", nodeState: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
Edit edges of a polygonal object to respect surface curvature
:param adjustEdgeFlow: (C) The weight value of the edge vertices to be positioned <0:
Concave 0: Middle point 1: Surface continuity >1: Convex Default is 1.0
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param edgeFlow: (C) True to enable edge flow Otherwise, the edge flow is disabled
Default is true
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def dR_viewLightsTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def air(*args, attenuation: Union[float, bool]=0.0, directionX: Union[float, bool]=0.0,
directionY: Union[float, bool]=0.0, directionZ: Union[float, bool]=0.0, enableSpread:
bool=True, fanSetup: bool=True, inheritRotation: bool=True, inheritVelocity:
Union[float, bool]=0.0, magnitude: Union[float, bool]=0.0, maxDistance: Union[float,
bool]=0.0, name: Union[AnyStr, bool]="", perVertex: bool=True, position:
Union[List[float, float, float], List[List[float, float, float]], bool]=None, speed:
Union[float, bool]=0.0, spread: Union[float, bool]=0.0, torusSectionRadius: Union[float,
bool]=0.0, velocityComponentOnly: bool=True, volumeExclusion: bool=True, volumeOffset:
Union[List[float, float, float], bool]=None, volumeShape: Union[AnyStr, bool]="",
volumeSweep: Union[float, bool]=0.0, wakeSetup: bool=True, windSetup: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
For each listed object, the command creates a new field The field has a shape which lives
in the DAG and it has an associated dependency node The field is added to the list of
fields owned by the object Use connectDynamic to cause the field to affect a dynamic
object Note that if more than one object is listed, a separate field is created for e
:param attenuation: (Q E) Attentuation rate of field
:param directionX: (Q E)
:param directionY: (Q E)
:param directionZ: (Q E) Direction that the air will try to match the affected particles'
velocity to NOTE: This is not the velocity; this is only the direction Use the -s
:param enableSpread: (Q E) This tells the system whether or not to use the spread angle
given by '-sp' If this is 'false' then all connected objectswithin the maximum distance
:param fanSetup: (E) Similar to 'windSetup' except that the effects of a fan or a person
blowing air are approximated The user can pass the same flags on the command lin
:param inheritRotation: (Q E) If this is set to 'true', then the direction vector described
with -dx, -dy, and -dz will be considered local to the owning object Therefore, if the
:param inheritVelocity: (Q E) Amount (from 0 to 1) of the field-owner's velocity added to
the vector determined by the direction and speed flags The combination of these two vect
:param magnitude: (Q E) Strength of field
:param maxDistance: (Q E) Maximum distance at which field is exerted -1 indicates that the
field has no maximum distance
:param name: (Q E) name of field
:param perVertex: (Q E) Per-vertex application If this flag is set true, then each
individual point (CV, particle, vertex,etc.) of the chosen object exerts an identical cop
:param position: (Q E M) Position in space (x,y,z) where you want to place a gravity field
The gravity then emanates from this position in space rather than from an object
:param speed: (Q E) How fast the affected objects' speed reaches the speed (based on the
-mag, -dx, -dy, -dz flags) of the air field This value gets clamped internally
:param spread: (Q E) This represents the angle from the direction vector within which
objects will be affected The values are in the range of 0 to 1 A value of 0 will r
:param torusSectionRadius: (Q E) Section radius for a torus volume Applies only to torus
Similar to the section radius in the torus modelling primitive
:param velocityComponentOnly: (Q E) If this is 'false', the air will accelerate or
decelerate the affected objects so that their velocities will eventually match the TOTAL
velocity vect
:param volumeExclusion: (Q E) Volume exclusion of the field If true, points outside the
volume (defined by the volume shape attribute) are affected, If false, points inside the v
:param volumeOffset: (Q E) Volume offset of the field Volume offset translates the field's
volume by the specified amount from the actual field location This is in the field'
:param volumeShape: (Q E) Volume shape of the field Sets/edits/queries the field's volume
shape attribute If set to any value other than "none", determines a 3-D volume with
:param volumeSweep: (Q E) Volume sweep of the field Applies only to sphere, cone, cylinder,
and torus Similar effect to the sweep attribute in modelling
:param wakeSetup: (E) Like the 'windSetup' and 'fanSetup', 'wakeSetup' sets certain values
in the field to approximate the movement of air near a moving object, such as a
:param windSetup: (E) This will set some of the values above in a way that approximates the
effects of a basic wind This allows the user to then change certain values as
:returns: Command result
"""
pass
def CreatePolygonSVG(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PointOnCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def projectionContext(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Set the context for projection manips
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Context name.
"""
pass
def IncrementFluidCenter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_cameraToPoly(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetNormalAngle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def intSliderGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0, adjustableColumn3:
int=0, adjustableColumn4: int=0, adjustableColumn5: int=0, adjustableColumn6:
int=0, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, columnAlign:
Union[List[int, AnyStr], List[List[int, AnyStr]]]=None, columnAlign2:
List[AnyStr, AnyStr]=None, columnAlign3: List[AnyStr, AnyStr, AnyStr]=None,
columnAlign4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign5:
List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign6: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach: Union[List[int,
AnyStr, int], List[List[int, AnyStr, int]]]=None, columnAttach2: List[AnyStr,
AnyStr]=None, columnAttach3: List[AnyStr, AnyStr, AnyStr]=None, columnAttach4:
List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach5: List[AnyStr, AnyStr,
AnyStr, AnyStr, AnyStr]=None, columnAttach6: List[AnyStr, AnyStr, AnyStr,
AnyStr, AnyStr, AnyStr]=None, columnOffset2: List[int, int]=None,
columnOffset3: List[int, int, int]=None, columnOffset4: List[int, int, int,
int]=None, columnOffset5: List[int, int, int, int, int]=None, columnOffset6:
List[int, int, int, int, int, int]=None, columnWidth: Union[List[int, int],
List[List[int, int]]]=None, columnWidth1: int=0, columnWidth2: List[int,
int]=None, columnWidth3: List[int, int, int]=None, columnWidth4: List[int, int,
int, int]=None, columnWidth5: List[int, int, int, int, int]=None,
columnWidth6: List[int, int, int, int, int, int]=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dragCommand: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
extraLabel: Union[AnyStr, bool]="", field: bool=True, fieldMaxValue: Union[int,
bool]=0, fieldMinValue: Union[int, bool]=0, fieldStep: Union[int, bool]=0,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True, label:
Union[AnyStr, bool]="", manage: bool=True, maxValue: Union[int, bool]=0,
minValue: Union[int, bool]=0, noBackground: bool=True, numberOfPopupMenus:
bool=True, parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, rowAttach: Union[List[int, AnyStr, int],
List[List[int, AnyStr, int]]]=None, sliderStep: Union[int, bool]=0,
statusBarMessage: AnyStr="", step: Union[int, bool]=0, useTemplate: AnyStr="",
value: Union[int, bool]=0, visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) The command string executed when the value of the slider
changes It will be executed only once after a drag of the slider
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) The command string executed repeatedly during a drag of the
slider
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param extraLabel: (C Q E) If present on creation this specifies that there will be an
extra label appearing after the slider Sets the string to be the text for the extra labe
:param field: (C) If true on creation the group will have an editable int field present
that reflects the value of the slider
:param fieldMaxValue: (C Q E) Maximum value that may be entered in the field This value
may be set to any value greater than the -max/maxValue flag By default, it is equal to th
:param fieldMinValue: (C Q E) Minimum value that may be entered in the field This value
may be set to any value less than the -min/minValue flag By default, it is equal to the -
:param fieldStep: (C Q E) Increment for the field
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) If present on creation the group will have static text Returns a
string on query
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxValue: (C Q E) Sets the maximum value for both the slider and the field
:param minValue: (C Q E) Sets the minimum value for both the slider and the field
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param sliderStep: (C Q E) On Linux the slider step value represents the amount the value
will increase or decrease when you click either side of the slider
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) Increment for both the slider and field
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Value of the group
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name of the control on creation.
"""
pass
def NodeEditorPinByDefault(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySoftEdge(*args, angle: Union[float, bool]=30, caching: bool=True, constructionHistory:
bool=True, name: AnyStr="", nodeState: Union[int, bool]=0, worldSpace:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
Selectively makes edges soft or hard An edge will be made hard if the angle between two
owning faces is sharper (larger) than the smoothing angle An edge wil be made soft if the
angle between two owning facets is flatter (smaller) than the smoothing angle
:param angle: (C Q E) Smoothing angle C: Default is 30 degrees Q: When queried, this flag
returns a float
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The name of the polySoftEdge node.
"""
pass
def roundCRCtx(*args, **kwargs)->None:
"""
"""
pass
def FBXExportQuickSelectSetAsCache(*args, **kwargs)->None:
"""
"""
pass
def SurfaceBooleanSubtractTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OneClickMenuExecute(*args, **kwargs)->None:
"""
"""
pass
def cylinder(*args, axis: Union[List[float, float, float], bool]=None, caching: bool=True,
degree: Union[int, bool]=3, endSweep: Union[float, bool]=2, heightRatio:
Union[float, bool]=2.0, nodeState: Union[int, bool]=0, pivot: Union[List[float,
float, float], bool]=None, radius: Union[float, bool]=1.0, sections: Union[int,
bool]=8, spans: Union[int, bool]=1, startSweep: Union[float, bool]=0, tolerance:
Union[float, bool]=0.01, useTolerance: bool=False, constructionHistory: bool=True,
name: AnyStr="", object: bool=True, polygon: int=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The cylinder command creates a new cylinder and/or a dependency node that creates one, and
returns their names
:param axis: (C Q E) The primitive's axis
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param degree: (C Q E) The degree of the resulting surface: 1 - linear, 3 - cubic Default:
3
:param endSweep: (C Q E) The angle at which to end the surface of revolution Default is
2Pi radians, or 360 degrees Default: 6.2831853
:param heightRatio: (C Q E) Ratio of "height" to "width" Default: 2.0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pivot: (C Q E) The primitive's pivot point
:param radius: (C Q E) The radius of the object Default: 1.0
:param sections: (C Q E) The number of sections determines the resolution of the surface in
the sweep direction Used only if useTolerance is false Default: 8
:param spans: (C Q E) The number of spans determines the resolution of the surface in the
opposite direction Default: 1
:param startSweep: (C Q E) The angle at which to start the surface of revolution Default:
0
:param tolerance: (C Q E) The tolerance with which to build the surface Used only if
useTolerance is true Default: 0.01
:param useTolerance: (C Q E) Use the specified tolerance to determine resolution Otherwise
number of sections will be used Default: false
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:returns: Object name and node name
"""
pass
def MirrorDeformerWeights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetHIKEffectorName(*args, **kwargs)->None:
"""
"""
pass
def surfaceShaderList(*args, add: name=None, remove: name=None, q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
Add/Remove a relationship between an object and the current shading group
:param add: (C) add object(s) to shader group list
:param remove: (C) remove object(s) to shader group list
:returns:
"""
pass
def defaultLightListCheckBox(*args, annotation: Union[AnyStr, bool]="", backgroundColor:
Union[List[float, float, float], bool]=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True,
exists: bool=True, fullPathName: bool=True, height: Union[int,
bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, isObscured: bool=True, label: AnyStr="", manage:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, shadingGroup: name=None,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a checkBox that controls whether a shadingGroup is
connected/disconnected from the defaultLightList
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C E) Value of the checkbox label
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param shadingGroup: (C E) The shading group that is to be connected/disconnected from the
defaultLightList
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full name to the control
"""
pass
def dR_selectSimilar(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def getFluidAttr(*args, attribute: AnyStr="", lowerFace: bool=True, xIndex: int=0, xvalue:
bool=True, yIndex: int=0, yvalue: bool=True, zIndex: int=0, zvalue: bool=True,
**kwargs)->None:
"""
Returns values of built-in fluid attributes such as density, velocity, etc., for individual
grid cells or for all cells in the grid
:param attribute: (C) Specifies the fluid attribute for which to display values Valid
attributes are "force", "velocity", "density", "falloff", "fuel", "color", and "temp
:param lowerFace: (C) Only valid with "-at velocity" Since velocity values are stored on
the edges of each voxel and not at the center, using voxel based indices to set v
:param xIndex: (C) Only return values for cells with this X index
:param xvalue: () Only get the first component of the vector-valued attribute specified by
the "-at/attribute" flag
:param yIndex: (C) Only return values for cells with this Y index
:param yvalue: () Only get the second component of the vector-valued attribute specified by
the "-at/attribute" flag
:param zIndex: (C) Only return values for cells with this Z index
:param zvalue: () Only get the third component of the vector-valued attribute specified by
the "-at/attribute" flag
:returns:
"""
pass
def SoloMaterial(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyBevel(*args, angleTolerance: Union[float, bool]=20.0, autoFit: bool=True, caching:
bool=True, constructionHistory: bool=True, mergeVertexTolerance: Union[float,
bool]=0.0, mergeVertices: bool=False, miteringAngle: Union[float, bool]=0.0,
name: AnyStr="", nodeState: Union[int, bool]=0, offset: Union[float, bool]=0.2,
offsetAsFraction: bool=False, roundness: Union[float, bool]=0.5, segments:
Union[int, bool]=1, smoothingAngle: Union[float, bool]=0.0, subdivideNgons:
bool=False, useLegacyBevelAlgorithm: bool=False, uvAssignment: Union[int, bool]=0,
worldSpace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Bevel edges
:param angleTolerance: (C Q E) Angular tolerance for creation of extra triangles Note this
attribute is for compatability only and should not be modified in Maya 7.0 files Default:
:param autoFit: (C Q E) If autoFit is on, it computes a smooth roundness : new facets round
off a smooth angle Default: true
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param mergeVertexTolerance: (C Q E) Tolerance within which to merge vertices Default: 0.0
:param mergeVertices: (C Q E) Merge vertices within a tolerance Default: false
:param miteringAngle: (C Q E) Miter faces that have angles less than this value Default:
0.0
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param offset: (C Q E) The offset for bevel Default: 0.2
:param offsetAsFraction: (C Q E) If on, the offset value is treated as a fraction between
zero and one Default: false
:param roundness: (C Q E) The roundness of bevel, it is taken into account when autoFit is
off Default: 0.5
:param segments: (C Q E) The number of segments used for beveling Default: 1
:param smoothingAngle: (C Q E) Create new edges as hard edges if the angle between adjacent
faces exceeds this value Default: 0.0
:param subdivideNgons: (C Q E) Subdivide new faces with more than 4 edges Default: false
:param useLegacyBevelAlgorithm: (C Q E) If on, bevel is done the way maya 2014 did Default:
false
:param uvAssignment: (C Q E) Technique used to compute UVs on new faces 0 computes new UVs
by projecting along surface normal of original mesh onto new mesh 1 computes new UVs by
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def Loft(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisplayUVWireframe(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def linearPrecision(*args, q=True, query=True, **kwargs)->Union[None, Any]:
"""
This command controls the display of linear strings in the interface (See the linearField
command) Setting this affects any linear strings displayed afterwards, formatting them so
they will show at most the specified number of digits after the decimal point Allowed
values are 0 through 6
:returns:
"""
pass
def softModCtx(*args, dragSlider: AnyStr="", exists: bool=True, falseColor: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", reset: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Controls the softMod context
:param dragSlider: (E) Specify the slider mode for hotkey radius resizing
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param falseColor: (E) Enable or disable false color display on the soft mod manipulator
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param reset: (Q E) Reset the tool options to their default values
:returns: - name of the new context created
"""
pass
def DuplicateSpecialOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RotateToolWithSnapMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertSelectionToVertexFaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def mouse(*args, enableScrollWheel: bool=True, mouseButtonTracking: int=0,
mouseButtonTrackingStatus: bool=True, scrollWheelStatus: bool=True, **kwargs)->int:
"""
This command allows to configure mouse
:param enableScrollWheel: (C) Enable or disable scroll wheel support
:param mouseButtonTracking: (C) Set the number (1, 2 or 3) of mouse buttons to track Note:
this is only supported on Macintosh
:param mouseButtonTrackingStatus: (C) returns the current number of mouse buttons being
tracked
:param scrollWheelStatus: (C) returns the current status of scroll wheel support
:returns: When -scrollWheelStatus flag is used, will return 1 if scroll wheel support
enabled, otherwise 0.
When -mouseButtonTrackingStatus flag is used, will return the number
of mouse buttons being tracked.
"""
pass
def webViewCmd(*args, **kwargs)->None:
"""
"""
pass
def colorManagementPrefs(*args, cmConfigFileEnabled: bool=True, cmEnabled: bool=True,
colorManageAllNodes: bool=True, colorManagePots: bool=True,
colorManagedNodes: bool=True, colorManagementSDKVersion: Union[AnyStr,
bool]="", configFilePath: Union[AnyStr, bool]="",
defaultInputSpaceName: Union[AnyStr, bool]="", equalsToPolicyFile:
Union[AnyStr, bool]="", exportPolicy: Union[AnyStr, bool]="",
inhibitEvents: bool=True, inputSpaceNames: bool=True, loadPolicy:
Union[AnyStr, bool]="", loadedDefaultInputSpaceName: Union[AnyStr,
bool]="", loadedOutputTransformName: Union[AnyStr, bool]="",
loadedRenderingSpaceName: Union[AnyStr, bool]="",
loadedViewTransformName: Union[AnyStr, bool]="",
missingColorSpaceNodes: bool=True, ocioRulesEnabled: bool=True,
outputTarget: Union[AnyStr, bool]="", outputTransformEnabled:
bool=True, outputTransformName: Union[AnyStr, bool]="",
outputTransformNames: bool=True, outputTransformUseColorConversion:
bool=True, outputUseViewTransform: bool=True, policyFileName:
Union[AnyStr, bool]="", popupOnError: bool=True, refresh: bool=True,
renderingSpaceName: Union[AnyStr, bool]="", renderingSpaceNames:
bool=True, restoreDefaults: bool=True, viewTransformName: Union[AnyStr,
bool]="", viewTransformNames: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
This command allows querying and editing the color management global data in a scene It
also allows for setting the view transform and rendering space which automatically
configures the color processing in the enabled views
:param cmConfigFileEnabled: (Q E) Turn on or off applying an OCIO configuration file If
set, the color management configuration set in the preferences is used
:param cmEnabled: (Q E) Turn on or off color management in general If set, the color
management configuration set in the preferences is used
:param colorManageAllNodes: (C Q E) Adds color management to all input nodes such as file
texture nodes
:param colorManagePots: (Q E) Turn on or off color management of color pots in the UI If
set, colors in color pots are taken to be in rendering space, and are displayed after bei
:param colorManagedNodes: (Q E) Gets the names of all nodes that apply color management to
bring pixels from an input color space to the rendering space Examples include file textu
:param colorManagementSDKVersion: (Q E) Obtain the version of the color management SDK used
by Maya
:param configFilePath: (Q E) The configuration file to be used, if color management is
enabled
:param defaultInputSpaceName: (Q E) This flag is obsolete See the colorManagementFileRules
command for more information
:param equalsToPolicyFile: (Q E) Query if the current loaded policy settings is the same
with the settings described in the policy file which is the argument of the command In
query
:param exportPolicy: (C Q E) Export the color management parameters to policy file
:param inhibitEvents: (C Q E) Inhibit client-server notifications and event triggers which
occur when changing the color management settings
:param inputSpaceNames: (Q E) Returns the list of available input color spaces Used to
populate the input color spaces UI popup
:param loadPolicy: (C Q E) Load the color management policy file This file overides the
color management settings
:param loadedDefaultInputSpaceName: (Q E) This flag is obsolete
:param loadedOutputTransformName: (Q E) Gets the loaded output transform Used by file open,
import, and reference to check for missing color spaces or transforms
:param loadedRenderingSpaceName: (Q E) Gets the loaded rendering space Used by file open,
import, and reference to check for missing color spaces or transforms
:param loadedViewTransformName: (Q E) Gets the loaded view transform Used by file open,
import, and reference to check for missing color spaces or transforms
:param missingColorSpaceNodes: (Q E) Gets the names of the nodes that have color spaces not
defined in the selected transform collection
:param ocioRulesEnabled: (Q E) Turn on or off the use of colorspace assignment rules from
the OCIO library
:param outputTarget: (Q E) Indicates to which output the outputTransformEnabled or the
outputTransformName flags are to be applied Valid values are "renderer" or "playblast"
:param outputTransformEnabled: (Q E) Turn on or off applying the output transform for out
of viewport renders If set, the output transform set in the preferences is used
:param outputTransformName: (Q E) The output transform to be applied for out of viewport
renders Disables output use view transform mode
:param outputTransformNames: (Q E) Returns the list of available output transforms
:param outputTransformUseColorConversion: (Q E) Turn on or off selecting the color space
conversion for the output color space of viewport renders If set, a conversion color space
is used; otherwi
:param outputUseViewTransform: (Q E) Turns use view transform mode on In this mode, the
output transform is set to match the view transform To turn the mode off, set an output
transfor
:param policyFileName: (Q E) Set the policy file name
:param popupOnError: (Q E) Turn on or off displaying a modal popup on error (as well as the
normal script editor reporting of the error), for this invocation of the command De
:param refresh: (C Q E) Refresh the color management
:param renderingSpaceName: (Q E) The color space to be used during rendering This is the
source color space to the viewing transform, for color managed viewers and color managed
UI
:param renderingSpaceNames: (Q E) Returns the list of available rendering spaces Used to
populate the color management preference UI popup
:param restoreDefaults: (C Q E) Restore the color management settings to their default
value
:param viewTransformName: (Q E) The view transform to be applied by color managed viewers
and color managed UI controls
:param viewTransformNames: (Q E) Returns the list of available view transforms Used to
populate the color management preference UI popup
:returns:
"""
pass
def reproInstancer(*args, **kwargs)->None:
"""
"""
pass
def dR_timeConfigTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GlobalStitch(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintEffectPanelActivate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def copySkinWeights(*args, destinationSkin: Union[AnyStr, bool]="", influenceAssociation:
Union[AnyStr, List[AnyStr], bool]="", mirrorInverse: bool=True, mirrorMode:
Union[AnyStr, bool]="", noBlendWeight: bool=True, noMirror: bool=True,
normalize: bool=True, sampleSpace: Union[int, bool]=0, smooth: bool=True,
sourceSkin: Union[AnyStr, bool]="", surfaceAssociation: Union[AnyStr,
bool]="", uvSpace: Union[List[AnyStr, AnyStr], bool]=None, q=True,
query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Command to copy or mirror the skinCluster weights accross one of the three major axes The
command can be used to mirror weights either from one surface to another or within the same
surface
:param destinationSkin: (C Q E) Specify the destination skin shape
:param influenceAssociation: (C Q E M) The influenceAssociation flag controls how the
influences on the source and target skins are matched up The flag can be included multiple
times to s
:param mirrorInverse: (C Q E) Values are mirrored from the positive side to the negative
If this flag is used then the direction is inverted
:param mirrorMode: (C Q E) The mirrorMode flag defines the plane of mirroring (XY, YZ, or
XZ) when the mirror flag is used The default plane is XY
:param noBlendWeight: (C Q E) When the no blend flag is used, the blend weights on the skin
cluster will not be copied across to the destination
:param noMirror: (C Q E) When the no mirror flag is used, the weights are copied instead of
mirrored
:param normalize: (C Q E) Normalize the skin weights
:param sampleSpace: (C Q E) Selects which space the attribute transfer is performed in 0
is world space, 1 is model space The default is world space
:param smooth: (C Q E) When the smooth flag is used, the weights are smoothly interpolated
between the closest vertices, instead of assigned from the single closest
:param sourceSkin: (C Q E) Specify the source skin shape
:param surfaceAssociation: (C Q E) The surfaceAssociation flag controls how the weights are
transferred between the surfaces: "closestPoint", "rayCast", or "closestComponent" The
defa
:param uvSpace: (C Q E) The uvSpace flag indicates that the weight transfer should occur in
UV space, based on the source and destination UV sets specified
:returns:
"""
pass
def SetMeshRepeatTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_selectTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CycleThroughCameras(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DistributeShellsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SimplifyCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SphericalProjection(*args, **kwargs)->None:
"""
unknown
"""
pass
def SelectToolOptionsMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBifrostChannelField(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgBatchExportArchive(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def poleVectorConstraint(*args, layer: AnyStr="", name: Union[AnyStr, bool]="", remove:
bool=True, targetList: bool=True, weight: Union[float, bool]=0.0,
weightAliasList: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
Constrains the poleVector of an ikRPsolve handle to point at a target object or at the
average position of a number of targets An poleVectorConstraint takes as input one or
more "target" DAG transform nodes at which to aim pole vector for an IK handle using the
rotate plane solver The pole vector is adjust such that the in weighted average of th
:param layer: (C E) Specify the name of the animation layer where the constraint should be
added
:param name: (C Q E) Sets the name of the constraint node to the specified name Default
name is constrainedObjectName_constraintType
:param remove: (E) removes the listed target(s) from the constraint
:param targetList: (Q) Return the list of target objects
:param weight: (C Q E) Sets the weight value for the specified target(s) If not given at
creation time, the default value of 1.0 is used
:param weightAliasList: (Q) Returns the names of the attributes that control the weight of
the target objects Aliases are returned in the same order as the targets are returned
:returns: name of the created constraint node
"""
pass
def dR_loadRecentFile1(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MoveNormalTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_loadRecentFile3(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_loadRecentFile4(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setAttr(*args, alteredValue: bool=True, caching: bool=True, capacityHint: int=0,
channelBox: bool=True, clamp: bool=True, keyable: bool=True, lock: bool=True, size:
int=0, type: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
Sets the value of a dependency node attribute No value for the the attribute is needed
when the -l/-k/-s flags are used The -type flag is only required when setting a
non-numeric attribute The following chart outlines the syntax of setAttr for non-numeric
data types: {TYPE} below means any number of values of type TYPE, separated by a space
:param alteredValue: (C) The value is only the current value, which may change in the next
evalution (if the attribute has an incoming connection) This flag is only used dur
:param caching: (C) Sets the attribute's internal caching on or off Not all attributes can
be defined as caching Only those attributes that are not defined by default
:param capacityHint: (C) Used to provide a memory allocation hint to attributes where the
-size flag cannot provide enough information This flag is optional and is primarily
:param channelBox: (C) Sets the attribute's display in the channelBox on or off Keyable
attributes are always display in the channelBox regardless of the channelBox settti
:param clamp: (C) For numeric attributes, if the value is outside the range of the
attribute, clamp it to the min or max instead of failing
:param keyable: (C) Sets the attribute's keyable state on or off
:param lock: (C) Sets the attribute's lock state on or off
:param size: (C) Defines the size of a multi-attribute array This is only a hint, used to
help allocate memory as efficiently as possible
:param type: (C) Identifies the type of data If the -type flag is not present, a numeric
type is assumed
:returns:
"""
pass
def FBXExportReferencedAssetsContent(*args, **kwargs)->None:
"""
"""
pass
def createNurbsCylinderCtx(*args, **kwargs)->None:
"""
"""
pass
def polySlideEdge(*args, absolute: bool=True, direction: int=0, edgeDirection: float=0.0,
symmetry: bool=True, **kwargs)->bool:
"""
Moves an edge loop selection along the edges connected to the sides of its vertices
:param absolute: (C) This flag specifies whether or not the command uses absolute mode If
in absolute then all vertices will move the same distance (the specified percent
:param direction: (C) This flag specifies the direction of the slide edge movement 0: is
left direction (relative) 1: is right direction (relative) 2: is normal direction
:param edgeDirection: (C) This flag specifies the relative percentage to move along the
edges on either side of the vertices along the edge loop C: Default is 0.0
:param symmetry: (C) This flag specifies whether or not the command will do a symmetrical
slide Only takes effect when symmetry is enabled C: Default is off
:returns: Success value
"""
pass
def polyTestPop(*args, **kwargs)->None:
"""
"""
pass
def setInfinity(*args, attribute: Union[AnyStr, List[AnyStr]]="", controlPoints: bool=False,
hierarchy: AnyStr="", postInfinite: Union[AnyStr, bool]="", preInfinite:
Union[AnyStr, bool]="", shape: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
Set the infinity type before (after) a paramCurve's first (last) keyframe
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param postInfinite: (C Q) Set the infinity type after a paramCurve's last keyframe Valid
values are "constant", "linear", "cycle", "cycleRelative", "oscillate"
:param preInfinite: (C Q) Set the infinity type before a paramCurve's first keyframe Valid
values are "constant", "linear", "cycle", "cycleRelative", "oscillate"
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:returns:
"""
pass
def ShareOneBrush(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def journal(*args, **kwargs)->None:
"""
"""
pass
def projectTangent(*args, caching: bool=True, curvature: bool=False, curvatureScale:
Union[float, bool]=0.0, ignoreEdges: bool=False, nodeState: Union[int,
bool]=0, reverseTangent: bool=False, rotate: Union[float, bool]=0.0,
tangentDirection: Union[int, bool]=1, tangentScale: Union[float, bool]=1.0,
constructionHistory: bool=True, name: AnyStr="", object: bool=True,
replaceOriginal: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The project tangent command is used to align (for tangents) a curve to two other curves or
a surface A surface isoparm may be selected to define the direction (U or V) to align to
The end of the curve must intersect with these other objects Curvature continuity may also
be applied if required Tangent continuity means the end of the curve is mo
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param curvature: (C Q E) Curvature continuity is on if true and off otherwise Default:
false
:param curvatureScale: (C Q E) Curvature scale applied to curvature of curve to align
Available if curvature option is true Default: 0.0
:param ignoreEdges: (C Q E) If false, use the tangents of the trim edge curves if the
surface is trimmed If true, use the tangents of the underlying surface in the U/V
directio
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param reverseTangent: (C Q E) Reverse the tangent direction if true and leave it the way
it is if false Default: false
:param rotate: (C Q E) Amount by which the tangent of the curve to align will be rotated
Available only if the normal direction (3) is not used for tangentDirection Defau
:param tangentDirection: (C Q E) Tangent align direction type legal values: 1=u direction
(of surface or use first curve), 2=v direction (of surface or use second curve), 3=normal
di
:param tangentScale: (C Q E) Tangent scale applied to tangent of curve to align Default:
1.0
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def UVContourStretchProjection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PixelMoveUp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshWaxToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllCameras(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorShapeMenuStateAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AssignOfflineFileOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SubdivSurfaceMatchTopology(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def pause(*args, seconds: int=0, **kwargs)->None:
"""
Pause for a specified number of seconds for canned demos or for test scripts to allow user
to view results
:param seconds: (C) Pause for the specified number of seconds
:returns:
"""
pass
def ShowAllUI(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetKeyPath(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def texSculptCacheSync(*args, **kwargs)->None:
"""
"""
pass
def ExtrudeFaceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddInfluenceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectMultiComponentMask(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportScaleFactor(*args, **kwargs)->None:
"""
"""
pass
def xgmSetGuideCVCount(*args, **kwargs)->None:
"""
"""
pass
def hudSliderButton(*args, allowOverlap: bool=True, block: Union[int, bool]=0, blockAlignment:
Union[AnyStr, bool]="", blockSize: Union[AnyStr, bool]="", buttonLabel:
Union[AnyStr, bool]="", buttonLabelFontSize: Union[AnyStr, bool]="",
buttonPressCommand: Union[Script, bool]=None, buttonReleaseCommand:
Union[Script, bool]=None, buttonShape: Union[AnyStr, bool]="", buttonWidth:
Union[int, bool]=0, decimalPrecision: Union[int, bool]=0, internalPadding:
Union[int, bool]=0, maxValue: Union[float, bool]=0.0, minValue: Union[float,
bool]=0.0, padding: Union[int, bool]=0, section: Union[int, bool]=0,
sliderDragCommand: Union[Script, bool]=None, sliderIncrement: Union[float,
bool]=0.0, sliderLabel: Union[AnyStr, bool]="", sliderLabelFontSize:
Union[AnyStr, bool]="", sliderLabelWidth: Union[int, bool]=0, sliderLength:
Union[int, bool]=0, sliderPressCommand: Union[Script, bool]=None,
sliderReleaseCommand: Union[Script, bool]=None, type: Union[AnyStr,
bool]="", value: Union[float, bool]=0.0, valueAlignment: Union[AnyStr,
bool]="", valueFontSize: Union[AnyStr, bool]="", valueWidth: Union[int,
bool]=0, visible: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[int, Any]:
"""
This command creates a Heads-up Display (HUD) slider button control which is placed in a 2D
inactive overlay plane on the 3D viewport It is to be used to provide hands-on interaction
designated by a user script The HUD slider button control is derived from a generic HUD
object and thus inherits a similar workflow Although this command provides
:param allowOverlap: (C Q E) Sets the Heads-Up Display to be visible regardless of
overlapping section widths/limitations (see -s/section flag description for more details)
:param block: (C Q E) Denotes the individual block that the HUD will reside in, within a
section Each section is composed of a single column of blocks The total number o
:param blockAlignment: (C Q E) Specifies the alignment of the block within its respective
column Available alignments are: "center", "left" and "right" The default alignment is "
:param blockSize: (C Q E) Sets the height of each block Available heights are: small,
medium and large In pixel measurements, each corresponds to a 20, 35 or 50 pixel height
:param buttonLabel: (C Q E) Text label of the HUD button
:param buttonLabelFontSize: (C Q E) Sets the font size of the button label Available sizes
are: small and large
:param buttonPressCommand: (C Q E) Specifies the procedure or script to run during a button
mouse click event
:param buttonReleaseCommand: (C Q E) Specifies the procedure or script to run during a
button mouse release event
:param buttonShape: (C Q E) Specifies the shape of the button Available button shapes are:
"rectangle" and "roundRectangle" The first will draw a rectangular button, while the
:param buttonWidth: (C Q E) Specifies the width of the button
:param decimalPrecision: (C Q E) Sets the decimal precision of any floating point value
returned by the command The valid range of precision values are 1 to 8
:param internalPadding: (C Q E) Specifies the amount of padding between the internal
elements of the HUD For the hudSlider, this represents the padding between the slider bar
and t
:param maxValue: (C Q E) Specify the maximum value of the slider Note: Although this flag
takes in a FLOAT as an argument, if the HUD type is "int", the value will be automa
:param minValue: (C Q E) Specify the minimum value of the slider Note: Although this flag
takes in a FLOAT as an argument, if the HUD type is "int", the value will be automa
:param padding: (C Q E) Specifies the width of both the left and right margins of a block
Default value is 15 pixels
:param section: (C Q E) Defines the section the HUD will appear in There are 10 sections
divided across the screen Five columns and two rows make up the ten element matrix
:param sliderDragCommand: (C Q E) Specifies the procedure or script to run during a slider
mouse drag event
:param sliderIncrement: (C Q E) Specify the number of increments along the slider If not
specified or set to 0 or less, the slider will be linearly even and continuous from
minValu
:param sliderLabel: (C Q E) Text label of the HUD slider
:param sliderLabelFontSize: (C Q E) Sets the font size of the slider label Available sizes
are: small and large
:param sliderLabelWidth: (C Q E) Specifies the pixel width of the virtual "textbox" which
will hold the label The contents of this "textbox" will be left justified If the width
of
:param sliderLength: (C Q E) Specifies the length of the slider in pixels
:param sliderPressCommand: (C Q E) Specifies the procedure or script to run during a slider
mouse click event
:param sliderReleaseCommand: (C Q E) Specifies the procedure or script to run during a
slider mouse release event
:param type: (C Q E) Specify the numeric type of the HUD Available types are: "float" and
"int"
:param value: (C Q E) Set/Return the slider value if the HUD is a valid HUD slider Note:
Although this flag takes in a FLOAT as an argument, if the HUD type is "int", the
:param valueAlignment: (C Q E) Specifies the alignment of the data blocks and the data text,
within a HUD block Available alignments are: "left" and "right" The default alignment
:param valueFontSize: (C Q E) Sets the font size of the slider value Available sizes are:
small and large
:param valueWidth: (C Q E) Specifies the pixel width of the virtual "textbox" which will
hold the slider value (To see a layout of a block, see the description of the -block f
:param visible: (C Q E) Sets the visibility of the Heads-Up Display on and off
:returns: ID number of the Heads-Up Display (HUD).
"""
pass
def dR_slideOff(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorToggleAttrFilter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AssignOfflineFile(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hyperGraph(*args, addBookmark: bool=True, addDependGraph: name=None, addDependNode:
name=None, animateTransition: bool=True, attributeEditor: AnyStr="", backward:
bool=True, bookmarkName: bool=True, breakConnectionCommand: Union[AnyStr,
bool]="", clear: bool=True, collapseContainer: bool=True, connectionDrawStyle:
AnyStr="center", control: bool=True, currentEdge: Union[AnyStr, bool]="",
currentNode: Union[AnyStr, bool]="", debug: AnyStr="", defineTemplate: AnyStr="",
deleteBookmark: AnyStr="", dependGraph: bool=True, dependNode: AnyStr="",
directoryPressCommand: AnyStr="", docTag: Union[AnyStr, bool]="", down:
bool=True, downstream: bool=True, dragAndDropBehaviorCommand: AnyStr="",
dropNode: Union[AnyStr, bool]="", dropTargetNode: Union[AnyStr, bool]="",
edgeDblClickCommand: AnyStr="", edgeDimmedDblClickCommand: AnyStr="",
edgeDropCommand: AnyStr="", edgePressCommand: AnyStr="", edgeReleaseCommand:
AnyStr="", enableAutomaticLayout: bool=True, exists: bool=True, expandContainer:
bool=True, feedbackGadget: Union[AnyStr, bool]="", feedbackNode: Union[AnyStr,
bool]="", filter: Union[AnyStr, bool]="", filterDetail: List[AnyStr, bool]=None,
fitImageToHeight: bool=True, fitImageToWidth: bool=True, focusCommand: AnyStr="",
fold: bool=True, forceMainConnection: Union[AnyStr, bool]="", forceRefresh:
bool=True, forward: bool=True, frame: bool=True, frameBranch: bool=True,
frameGraph: bool=True, frameGraphNoRebuild: bool=True, frameHierarchy: bool=True,
freeform: bool=True, fromAttr: Union[AnyStr, bool]="", fromNode: Union[AnyStr,
bool]="", getNodeList: bool=True, getNodePosition: Union[AnyStr, bool]="",
graphDescription: bool=True, graphLayoutStyle: Union[AnyStr, bool]="",
graphType: Union[AnyStr, bool]="", heatMapDisplay: bool=True,
highlightConnection: Union[AnyStr, bool]="", iconSize: Union[AnyStr, bool]="",
image: Union[AnyStr, bool]="", imageEnabled: bool=True, imageForContainer:
bool=True, imagePosition: Union[List[float, float], bool]=None, imageScale:
Union[float, bool]=0.0, initializeScript: AnyStr="", isHotkeyTarget: bool=True,
layout: bool=True, layoutSelected: AnyStr="", limitGraphTraversal: int=0,
lockMainConnection: bool=True, look: List[float, float]=None,
mainListConnection: Union[AnyStr, bool]="", mergeConnections: bool=True,
navigateHome: bool=True, navup: bool=True, newInputConnection: AnyStr="",
newOutputConnection: AnyStr="", nextView: bool=True, nodeConnectCommand:
AnyStr="", nodeDblClickCommand: AnyStr="", nodeDropCommand: AnyStr="",
nodeMenuCommand: AnyStr="", nodePressCommand: AnyStr="", nodeReleaseCommand:
AnyStr="", opaqueContainers: bool=True, orientation: Union[AnyStr, bool]="",
panView: List[float, float]=None, panel: Union[AnyStr, bool]="", parent:
Union[AnyStr, bool]="", popupMenuScript: AnyStr="", previousView: bool=True,
range: Union[List[float, float], bool]=None, rebuild: bool=True, removeNode:
AnyStr="", rename: bool=True, resetFreeform: bool=True, restoreBookmark:
AnyStr="", scrollUpDownNoZoom: bool=True, selectionConnection: Union[AnyStr,
bool]="", setNodePosition: List[AnyStr, float, float]=None,
showCachedConnections: bool=True, showConnectionFromSelected: bool=True,
showConnectionToSelected: bool=True, showConstraintLabels: bool=True,
showConstraints: bool=True, showDeformers: bool=True, showExpressions: bool=True,
showInvisible: bool=True, showRelationships: bool=True, showShapes: bool=True,
showUnderworld: bool=True, stateString: bool=True, toAttr: Union[AnyStr,
bool]="", toNode: Union[AnyStr, bool]="", transitionFrames: Union[int, bool]=0,
unParent: bool=True, unfold: bool=True, unfoldAll: bool=True, unfoldAllShapes:
bool=True, unfoldHidden: bool=True, unlockMainConnection: bool=True,
updateMainConnection: bool=True, updateNodeAdded: bool=True, updateSelection:
bool=True, upstream: bool=True, useDrawOverrideColor: bool=True,
useFeedbackList: bool=True, useTemplate: AnyStr="", viewOption: Union[AnyStr,
bool]="", visibility: bool=True, zoom: float=0.0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The following is an overview of the basic features of the hypergraph A more detailed
description is given in the user manuals The hypergraph provides the user with the
ability to view and edit the maya scene graph The hypergraph supports two types of graphs:
the DAG or scene hierarchy and the dependency graph The default view of the hypergrap
:param addBookmark: (C E) Create a bookmark for the current hypergraph view
:param addDependGraph: (C E) Add a dependency graph starting at the named node to the view
:param addDependNode: (C E) Add a dependency node to the dependency graph view
:param animateTransition: (C Q E) Turns animate transitions off and on
:param attributeEditor: (C E) Launches attribute editor on selected node
:param backward: (C E) Navigate backward one step
:param bookmarkName: (Q) Returns the bookmark name for the most recently created bookmark
:param breakConnectionCommand: (C Q E) Specify the command to call when a connection is
broken
:param clear: (C E) Clears the current hypergraph view and deletes the graph UI (see also
-rebuild flag)
:param collapseContainer: (C E) Collapses containers selected in DG graph
:param connectionDrawStyle: (C E) Specify how connections between nodes should be drawn
Valid values are "center" (draws connection lines from the center of one node to the center
of
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param currentEdge: (Q E) Return the current edge name
:param currentNode: (Q E) Return the current node name
:param debug: (C E) Run a debug method on the graph
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param deleteBookmark: (C E) Delete the bookmark with the corresponding node name
:param dependGraph: (C E) Displays dependency graph iterated from specified node
:param dependNode: (C E) Displays dependency node in view
:param directoryPressCommand: (C E) Specify a command to run when a directory is pressed
:param docTag: (C Q E) Attaches a tag to the editor
:param down: (C E) Navigate down to the dependency graph containing the current selection
Shows upstream and downstream connections
:param downstream: (C E) Show downstream dependency graph of selected node(s)
:param dragAndDropBehaviorCommand: (C E) Mel proc called when a drag and drop onto a
hyperGraph node has occurred Proc signature is procName (string $editor, string
$sourceNode, string $des
:param dropNode: (Q) Returns the name of the source node in a drag and drop connection,
when called during processing of a drop
:param dropTargetNode: (Q) Returns the name of the destination node in a drag and drop
connection, when called during processing of a drop
:param edgeDblClickCommand: (C E) Mel proc called when an edge is double clicked Proc
signature is procName (string $editor, string $edge)
:param edgeDimmedDblClickCommand: (C E) Mel proc called when a dimmed edge is double
clicked Proc signature is procName (string $editor, string $edge)
:param edgeDropCommand: (C E) Command to execute when an edge drop occurs
:param edgePressCommand: (C E) Command to execute when an edge press occurs
:param edgeReleaseCommand: (C E) Command to execute when an edge release occurs
:param enableAutomaticLayout: (C E) Rebuild the graph if a node is added or removed from
the graph via drag and drop or dg messages Default is true
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param expandContainer: (C E) Expands containers selected in DG graph
:param feedbackGadget: (Q) Returns the name of the current gadget
:param feedbackNode: (Q) Returns the name of the current feedback or highlight node
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param filterDetail: (C E) This flag is obsolete Use the showConstraints, showExpressions,
showDeformer, showInvisible, showShapes and showUnderworld flags instead
:param fitImageToHeight: (C) Changes position and scale of background image, so its height
fits current editor view
:param fitImageToWidth: (C) Changes position and scale of background image, so its width
fits current editor view
:param focusCommand: (C E) Mel proc to be run when the mouse is clicked in the hyper graph
Primarily of use in setting the window focus
:param fold: (C E) Folds (Collapses) selected object
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param forceRefresh: (C E) Forces the hypergraph to refresh (redraw) its contents
:param forward: (C E) Navigate forward one step
:param frame: (C E) Frames the selected objects
:param frameBranch: (C E) Frames the the branch from the selected node on downward
:param frameGraph: (C E) Frames the entire graph
:param frameGraphNoRebuild: (C E) Specify that on zoom out the graph should not rebuild;
for efficiency
:param frameHierarchy: (C E) Frames the hierarchy that contains the selected node
:param freeform: (C Q E) Enable freeform layout mode
:param fromAttr: (Q) Returns the name of the source attribute in a drag and drop connection,
when called during processing of a drop
:param fromNode: (Q) Returns the name of the source node in a drag and drop connection,
when called during processing of a drop
:param getNodeList: (Q) Returns a string array that represents a list of all the nodes in
the graph
:param getNodePosition: (Q) Returns the position of a specified node in x,y graph coords
This flag and its argument must be passed to the command before the -q flag (see exampl
:param graphDescription: (C E) When used, return a description of the current graph
:param graphLayoutStyle: (C Q E) This flag is obsolete The only supported graph layout
style is "hierarchicalLayout" Use of any other style will trigger a warning
:param graphType: (Q) Returns the type name of the current graph in the view (either DAG or
DG)
:param heatMapDisplay: (Q E) Specify whether the heat map should be shown or not
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param iconSize: (C Q E) Set or query the icon size for this hyper graph editor The
currently allowed icon sizes are "smallIcons", "mediumIcons", "largeIcons" and "superIcon
:param image: (C Q E) Specify background image to be loaded from the project image
directory
:param imageEnabled: (C Q E) Enable display of a loaded background image (Freeform DAG view
or DG view)
:param imageForContainer: (C Q E) Specify that the following flags work on selected
containers instead of the whole image: -imageScale,-imagePosition, fitImageToWidth,
-fitImageToHeig
:param imagePosition: (C Q E) Position of the background image
:param imageScale: (C Q E) Uniform scale of the background image
:param initializeScript: (C E) Script to call when the graph is initialized
:param isHotkeyTarget: (Q) For internal use
:param layout: (C E) Perform an automatic layout on the graph
:param layoutSelected: (C E) This flag is obsolete The only supported graph layout style
is "hierarchicalLayout" Use of any other style will trigger a warning
:param limitGraphTraversal: (C E) Limit the graph traversal to a certain number of levels
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param look: (C E) Look at a coordinate in the graph view
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param mergeConnections: (C Q E) Merge groups of connections into 'fat' connections
:param navigateHome: (C E) Navigate to the home (DAG) view
:param navup: (C E) Navigate up to the dependency graph containing the current selection
Shows upstream and downstream connections
:param newInputConnection: (C E) Specify a new connection, input side
:param newOutputConnection: (C E) Specify a new connection, output side
:param nextView: (C E) Changes the view to the next DAG view
:param nodeConnectCommand: (C E) Command to call when a node is connected
:param nodeDblClickCommand: (C E) Command to call when a node is double-clicked
:param nodeDropCommand: (C E) Set the command to be called when a node is dropped in the
hypergraph window
:param nodeMenuCommand: (C E) Command to call when a node menu is activated
:param nodePressCommand: (C E) Set the command to be called when the user presses a mouse
button while the cursor is over a node in the hypergraph window
:param nodeReleaseCommand: (C E) Set the command to be called when the user releases a
mouse button while the cursor is over a node in the hypergraph window
:param opaqueContainers: (Q E) Sets expanded container background opacity
:param orientation: (C Q E) Selects orientation style of graph: "horiz"|"vert"
:param panView: (C E) Pan the view to a new center
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param popupMenuScript: (C E) Set the script to be called to register the popup menu with
the control for this hypergraph The script will be called with a string argument which g
:param previousView: (C E) Changes the view back to the previous DAG view
:param range: (C Q E) Limits the display of nodes to only those within the range There are
two float values expected, the first the lower threshold of the range and the s
:param rebuild: (C E) Rebuilds graph
:param removeNode: (C E) Removes the node identified by string from the graph
:param rename: (C E) Pops up text field over selected object for renaming
:param resetFreeform: (C E) Resets freeform position on all nodes
:param restoreBookmark: (C E) Restore the view corresponding to the bookmark
:param scrollUpDownNoZoom: (C E) Specify if we want to be in the scroll along y only with
no free zooming mode By default, hyper graph editor allows user to pan left and right
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param setNodePosition: (C E) Sets the node identified by string to the (x,y) position in
the window specified by the two floats If the node is not in the graph than it will be a
:param showCachedConnections: (C E) Specify whether cached connections should be shown
:param showConnectionFromSelected: (C Q E) Show the connects (constraints, expresions, and
deformers - see showConstraints for example) leaving from selected nodes This can be
combined with s
:param showConnectionToSelected: (C Q E) Show the connects (constraints, expresions, and
deformers - see showConstraints for example) arriving at selected nodes This can be
combined with sh
:param showConstraintLabels: (C E) Specify whether constraint labels should be shown
:param showConstraints: (C Q E) Show constraint relationships in the DAG
:param showDeformers: (C Q E) Show deformer or geometry filter relationships in the DAG
:param showExpressions: (C Q E) Show expression relationships in the DAG
:param showInvisible: (C Q E) Show invisible nodes in the DAG
:param showRelationships: (C Q E) Show relationship (message) connections
:param showShapes: (C Q E) Show shape nodes in the DAG
:param showUnderworld: (C Q E) Show underworld graphs in the DAG
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param toAttr: (Q) Returns the name of the destination attribute in a drag and drop
connection, when called during processing of a drop
:param toNode: (Q) Returns the name of the destination node in a drag and drop connection,
when called during processing of a drop
:param transitionFrames: (C Q E) Specify te number of transition frames for animate
transitions
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unfold: (C E) Unfolds (expands) selected object
:param unfoldAll: (C E) Unfolds everything under selected object
:param unfoldAllShapes: (C E) Unfolds all shapes
:param unfoldHidden: (C E) Unfolds all hidden objects
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param updateNodeAdded: (C Q E) Update graph when a new node is added to the database
:param updateSelection: (C Q E) Update selection state in the graph when the selection
state of database changes
:param upstream: (C E) Show upstream dependency graph of selected node(s)
:param useDrawOverrideColor: (C E) Specify whether or not to use draw override coloring
:param useFeedbackList: (C Q E) Use feedback or highlight list as the target selection when
processing other hypergraph command-line options
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param viewOption: (C Q E) Set or query the view option for this hyper graph editor The
currently allowed views are "asIcons" and "asList"
:param visibility: (C E) Set the visible state of the selected node(s)
:param zoom: (C E) Specify the zoom factor for animating transitions
:returns: the name of the panel
"""
pass
def setFluidAttr(*args, addValue: bool=True, attribute: AnyStr="", clear: bool=True,
floatRandom: float=0.0, floatValue: float=0.0, lowerFace: bool=True, reset:
bool=True, vectorRandom: List[float, float, float]=None, vectorValue:
List[float, float, float]=None, xIndex: int=0, xvalue: bool=True, yIndex:
int=0, yvalue: bool=True, zIndex: int=0, zvalue: bool=True, **kwargs)->None:
"""
Sets values of built-in fluid attributes such as density, velocity, etc., for individual
grid cells or for all cells in the grid
:param addValue: () Add specified value to attribute
:param attribute: (C) Specifies the fluid attribute for which to set values Valid
attributes are "velocity", "density", "fuel", "color", "falloff", and "temperature"
:param clear: () Set this attribute to 0
:param floatRandom: () If this was a scalar (e.g density) attribute, use a random value in
+-VALUE If fv is specified, it is used as the base value and combined with the r
:param floatValue: () If this was a scalar (e.g density) attribute, use this value
:param lowerFace: (C) Only valid with "-at velocity" Since velocity values are stored on
the edges of each voxel and not at the center, using voxel based indices to set v
:param reset: () Set this attribute to default value
:param vectorRandom: () If this was a vector (e.g velocity) attribute, use a random value
in +-VALUE If vv is specified, it is used as the base value and combined with the
:param vectorValue: () If this was a vector (e.g velocity) attribute, use this value
:param xIndex: (C) Only return values for cells with this X index
:param xvalue: () Only set the first component of the vector-valued attribute specified by
the "-at/attribute" flag
:param yIndex: (C) Only return values for cells with this Y index
:param yvalue: () Only set the second component of the vector-valued attribute specified by
the "-at/attribute" flag
:param zIndex: (C) Only return values for cells with this Z index
:param zvalue: () Only set the third component of the vector-valued attribute specified by
the "-at/attribute" flag
:returns:
"""
pass
def xgmCache(*args, **kwargs)->None:
"""
"""
pass
def convertTessellation(*args, allCameras: bool=True, camera: name=None, **kwargs)->bool:
"""
Command to translate the basic tessellation attributes to advanced If a camera flag is
specified the translation will be based on the distance the surface is from the camera The
closer the surface is to the camera the more triangles there will be in the tessellation
If the "-allCameras" flags is specified, the renderable camera closest to the su
:param allCameras: (C) Specifies that all renderable cameras should be used in calculating
the screen based tessellation
:param camera: (C) Specifies the camera which should be used in calculating the screen
based tessellation
:returns: Success or Failure.
"""
pass
def LockNormals(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hwReflectionMap(*args, backTextureName: Union[AnyStr, bool]="", bottomTextureName:
Union[AnyStr, bool]="", cubeMap: bool=False, decalMode: bool=False, enable:
bool=False, frontTextureName: Union[AnyStr, bool]="", leftTextureName:
Union[AnyStr, bool]="", rightTextureName: Union[AnyStr, bool]="",
sphereMapTextureName: Union[AnyStr, bool]="", topTextureName: Union[AnyStr,
bool]="", q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command creates a hwReflectionMap node for having reflection on textured surfaces that
currently have their boolean attribute displayHWEnvironment set to true
:param backTextureName: (Q) This flag specifies the file texture name for the back side of
the cube Default is none When queried, this flag returns a string
:param bottomTextureName: (Q) This flag specifies the file texture name for the bottom side
of the cube Default is none When queried, this flag returns a string
:param cubeMap: (Q) If on, the reflection of the textures is done using the cube mapping
Default is false The reflection is done using sphere mapping When queried, th
:param decalMode: (Q) If on, the reflection color replaces the surface shading Default is
false The reflection is multiplied to the surface shading When queried, this f
:param enable: (Q) If on, enable the corresponding hwReflectionMap node Default is false
When queried, this flag returns a boolean
:param frontTextureName: (Q) This flag specifies the file texture name for the front side
of the cube Default is none When queried, this flag returns a string
:param leftTextureName: (Q) This flag specifies the file texture name for the left side of
the cube Default is none When queried, this flag returns a string
:param rightTextureName: (Q) This flag specifies the file texture name for the right side
of the cube Default is none When queried, this flag returns a string
:param sphereMapTextureName: (Q) This flag specifies the file texture name for the sphere
mapping option Default is none When queried, this flag returns a string
:param topTextureName: (Q) This flag specifies the file texture name for the top side of
the cube Default is none When queried, this flag returns a string
:returns: (name of the created hwReflectionMap node)
"""
pass
def XgmSplineCacheExportOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SwapBlendShape(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LoadHIKEffectorSetState(*args, **kwargs)->None:
"""
"""
pass
def gravity(*args, attenuation: Union[float, bool]=0.0, directionX: Union[float, bool]=0.0,
directionY: Union[float, bool]=0.0, directionZ: Union[float, bool]=0.0, magnitude:
Union[float, bool]=0.0, maxDistance: Union[float, bool]=0.0, name: Union[AnyStr,
bool]="", perVertex: bool=True, position: Union[List[float, float, float],
List[List[float, float, float]], bool]=None, torusSectionRadius: Union[float,
bool]=0.0, volumeExclusion: bool=True, volumeOffset: Union[List[float, float,
float], bool]=None, volumeShape: Union[AnyStr, bool]="", volumeSweep: Union[float,
bool]=0.0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
For each listed object, the command creates a new field The field has a shape which lives
in the DAG and it has an associated dependency node The field is added to the list of
fields owned by the object Use connectDynamic to cause the field to affect a dynamic
object Note that if more than one object is listed, a separate field is created for e
:param attenuation: (Q E) Attentuation rate of field
:param directionX: (Q E) X-component of direction
:param directionY: (Q E) Y-component of direction
:param directionZ: (Q E) Z-component of direction
:param magnitude: (Q E) Strength of field
:param maxDistance: (Q E) Maximum distance at which field is exerted -1 indicates that the
field has no maximum distance
:param name: (Q E) name of field
:param perVertex: (Q E) Per-vertex application If this flag is set true, then each
individual point (CV, particle, vertex,etc.) of the chosen object exerts an identical cop
:param position: (Q E M) Position in space (x,y,z) where you want to place a gravity field
The gravity then emanates from this position in space rather than from an object
:param torusSectionRadius: (Q E) Section radius for a torus volume Applies only to torus
Similar to the section radius in the torus modelling primitive
:param volumeExclusion: (Q E) Volume exclusion of the field If true, points outside the
volume (defined by the volume shape attribute) are affected, If false, points inside the v
:param volumeOffset: (Q E) Volume offset of the field Volume offset translates the field's
volume by the specified amount from the actual field location This is in the field'
:param volumeShape: (Q E) Volume shape of the field Sets/edits/queries the field's volume
shape attribute If set to any value other than "none", determines a 3-D volume with
:param volumeSweep: (Q E) Volume sweep of the field Applies only to sphere, cone, cylinder,
and torus Similar effect to the sweep attribute in modelling
:returns: Command result
"""
pass
def NodeEditorSetLargeNodeSwatchSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutlinerToggleConnected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def greasePencilHelper(*args, **kwargs)->None:
"""
"""
pass
def HypershadeCloseActiveTab(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def glRenderEditor(*args, control: bool=True, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", exists: bool=True, filter: Union[AnyStr, bool]="",
forceMainConnection: Union[AnyStr, bool]="", highlightConnection:
Union[AnyStr, bool]="", lockMainConnection: bool=True, lookThru:
Union[AnyStr, bool]="", mainListConnection: Union[AnyStr, bool]="", panel:
Union[AnyStr, bool]="", parent: Union[AnyStr, bool]="", selectionConnection:
Union[AnyStr, bool]="", stateString: bool=True, unParent: bool=True,
unlockMainConnection: bool=True, updateMainConnection: bool=True,
useTemplate: AnyStr="", viewCameraName: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Create a glRender view This is a special view used for hardware rendering This command is
used to create and reparent the view as needed to support panels See the glRender command
for controlling the specific behavior of the hardware rendering
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param lookThru: (C Q E) Specify which camera the glRender view should be using
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param viewCameraName: (Q) Returns the name of the current camera used by the glRenderPanel
This is a query only flag
:returns:
"""
pass
def loadUI(*args, listTypes: bool=True, uiFile: AnyStr="", uiString: AnyStr="", verbose:
bool=True, workingDirectory: AnyStr="", **kwargs)->AnyStr:
"""
loadUI command allows loading of a user interface created in Trolltech Qt Designer
:param listTypes: (C) Returns the list of recognized UI types and their associated Maya
command
:param uiFile: (C) Full path to a user interface file to load
:param uiString: (C) Load UI from a formated string
:param verbose: (C) Extra information about created controls will be printed
:param workingDirectory: (C) Sets the working directory, the loader looks for resources
such as icons and resouce files in paths relative to this directory
:returns: Full path name to the root control.
"""
pass
def HotkeyPreferencesWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphDelete(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setInputDeviceMapping(*args, absolute: bool=True, axis: Union[AnyStr, List[AnyStr]]="",
device: AnyStr="", offset: float=0.0, relative: bool=True, scale:
float=0.0, view: bool=True, world: bool=True, **kwargs)->None:
"""
The command sets a scale and offset for all attachments made to a specified device axis
Any attachment made to a mapped device axis will have the scale and offset applied to its
values The value from the device is multiplied by the scale and the offset is added to
this product With an absolute mapping, the attached attribute gets the resulting
:param absolute: (C) report absolute axis values
:param axis: (C M) specify the axis to map
:param device: (C) specify which device to map
:param offset: (C) specify the axis offset value
:param relative: (C) report the change in axis value since the last sample
:param scale: (C) specify the axis scale value
:param view: (C) translate the device coordinates into the coordinates of the active
camera
:param world: (C) translate the device coordinates into world space coordinates
:returns:
"""
pass
def FBXGetTakeComment(*args, **kwargs)->None:
"""
"""
pass
def FBIKReachKeyingOptionIK(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllNURBSCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TexSewActivateBrushSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddCurvesToHairSystem(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportBakeComplexStep(*args, **kwargs)->None:
"""
"""
pass
def XgmSplineCacheEnableSelectedCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def textureWindow(*args, activeSelectionOnTop: bool=True, axesColor: Union[List[float, float,
float], bool]=None, backFacingColor: Union[List[float, float, float, float],
bool]=None, capture: AnyStr="", captureSequenceNumber: int=0, changeCommand:
Union[List[AnyStr, AnyStr, AnyStr, AnyStr], bool]=None, checkerColor1:
Union[List[float, float, float], bool]=None, checkerColor2: Union[List[float,
float, float], bool]=None, checkerColorMode: Union[int, bool]=0,
checkerDensity: Union[int, bool]=0, checkerDrawTileLabels: bool=True,
checkerGradient1: Union[List[float, float, float], bool]=None,
checkerGradient2: Union[List[float, float, float], bool]=None,
checkerGradientOverlay: bool=True, checkerTileLabelColor: Union[List[float,
float, float], bool]=None, clearImage: bool=True, cmEnabled: bool=True,
control: bool=True, defineTemplate: AnyStr="", displayAxes: bool=True,
displayCheckered: bool=True, displayDistortion: bool=True,
displayDivisionLines: bool=True, displayGridLines: bool=True, displayImage:
Union[int, bool]=0, displayIsolateSelectHUD: bool=True, displayLabels:
bool=True, displayOverlappingUVCountHUD: bool=True, displayPreselection:
bool=True, displayReversedUVCountHUD: bool=True, displaySolidMap: bool=True,
displayStyle: Union[AnyStr, bool]="", displayTextureBorder: bool=True,
displayUVShellCountHUD: bool=True, displayUVStatisticsHUD: bool=True,
displayUsedPercentageHUD: bool=True, distortionAlpha: Union[float, bool]=0.0,
distortionPerObject: bool=True, divisions: Union[int, bool]=0, docTag:
Union[AnyStr, bool]="", doubleBuffer: bool=True, drawAxis: bool=True,
drawSubregions: bool=True, exists: bool=True, exposure: Union[float,
bool]=0.0, filter: Union[AnyStr, bool]="", forceMainConnection: Union[AnyStr,
bool]="", forceRebake: bool=True, frameAll: bool=True, frameSelected:
bool=True, frontFacingColor: Union[List[float, float, float, float],
bool]=None, gamma: Union[float, bool]=0.0, gridLinesColor: Union[List[float,
float, float], bool]=None, gridNumbersColor: Union[List[float, float, float],
bool]=None, highlightConnection: Union[AnyStr, bool]="", imageBaseColor:
Union[List[float, float, float], bool]=None, imageDim: bool=True,
imageDisplay: bool=True, imageNames: bool=True, imageNumber: Union[int,
bool]=0, imagePixelSnap: bool=True, imageRatio: bool=True, imageRatioValue:
Union[float, bool]=0.0, imageSize: bool=True, imageTileRange:
Union[List[float, float, float, float], bool]=None, imageUnfiltered:
bool=True, internalFaces: bool=True, labelPosition: Union[AnyStr, bool]="",
loadImage: AnyStr="", lockMainConnection: bool=True, mainListConnection:
Union[AnyStr, bool]="", maxResolution: Union[int, bool]=0, multiColorAlpha:
Union[float, bool]=0.0, nbImages: bool=True, nextView: bool=True, numUvSets:
bool=True, numberOfImages: Union[int, bool]=0, numberOfTextures: Union[int,
bool]=0, panel: Union[AnyStr, bool]="", parent: Union[AnyStr, bool]="",
previousView: bool=True, realSize: bool=True, refresh: bool=True,
relatedFaces: bool=True, removeAllImages: bool=True, removeImage: bool=True,
rendererString: Union[AnyStr, bool]="", reset: bool=True, saveImage:
bool=True, scaleBlue: Union[float, bool]=0.0, scaleGreen: Union[float,
bool]=0.0, scaleRed: Union[float, bool]=0.0, selectInternalFaces: bool=True,
selectRelatedFaces: bool=True, selectionConnection: Union[AnyStr, bool]="",
setUvSet: int=0, singleBuffer: bool=True, size: Union[float, bool]=0.0,
solidMap3dView: bool=True, solidMapColorSeed: Union[int, bool]=0,
solidMapPerShell: bool=True, spacing: float=0.0, stateString: bool=True,
style: Union[int, bool]=0, subdivisionLinesColor: Union[List[float, float,
float], bool]=None, textureBorder3dView: bool=True, textureBorderColor:
Union[List[float, float, float], bool]=None, textureBorderWidth: Union[int,
bool]=0, textureNames: bool=True, textureNumber: Union[int, bool]=0,
tileLabels: bool=True, tileLinesColor: Union[List[float, float, float],
bool]=None, toggle: bool=True, toggleExposure: bool=True, toggleGamma:
bool=True, unParent: bool=True, unlockMainConnection: bool=True,
updateMainConnection: bool=True, useFaceGroup: bool=True, useTemplate:
AnyStr="", usedPercentageHUDRange: Union[List[float, float, float, float],
bool]=None, uvSets: bool=True, viewPortImage: bool=True, viewTransformName:
Union[AnyStr, bool]="", wireframeComponentColor: Union[List[float, float,
float, float], bool]=None, wireframeObjectColor: Union[List[float, float,
float, float], bool]=None, writeImage: AnyStr="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command is used to create a UV Editor and to query or edit the texture editor settings
The UV Editor displays texture mapped polygon objects in 2D texture space Only active
objects are visible in this window The UV Editor has the ability to display two types of
images The Texture Image is a visualisation of the current texture and associ
:param activeSelectionOnTop: (C Q E) Display the solid map / distortion of active selection
on top of others
:param axesColor: (C Q E) The color of axes, default is 0.0 0.0 1.0
:param backFacingColor: (C Q E) Sets or queries the RGBA back facing color
:param capture: (E) Perform an one-time capture of the viewport to the named image file on
disk
:param captureSequenceNumber: (E) When a number greater or equal to 0 is specified each
subsequent refresh will save an image file to disk if the capture flag has been enabled
The na
:param changeCommand: (C Q E) Parameters: First string: command Second string: editorName
Third string: editorCmd Fourth string: updateFunc Call the command when something changes
:param checkerColor1: (C Q E) Sets the first color of the checker and identification
pattern, when color mode is 2-colors
:param checkerColor2: (C Q E) Sets the second color of the checker and identification
pattern, when color mode is 2-colors
:param checkerColorMode: (C Q E) Sets the color mode of the checker and identification
pattern 0: multi-colors; 1: 2-colors;
:param checkerDensity: (C Q E) Sets the density of the checker and identification pattern
:param checkerDrawTileLabels: (C Q E) Toggles the checker tile label display
:param checkerGradient1: (C Q E) Sets the first gradient of the checker and identification
pattern, when color mode is 2-colors
:param checkerGradient2: (C Q E) Sets the second gradient of the checker and identification
pattern, when color mode is 2-colors
:param checkerGradientOverlay: (C Q E) Toggle application of the gradient
:param checkerTileLabelColor: (C Q E) Sets the checker tile label color
:param clearImage: (E) Clears the current Editor Image
:param cmEnabled: (Q E) Turn on or off applying color management in the editor If set, the
color management configuration set in the current editor is used
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param displayAxes: (Q E) Specify true to display the grid axes
:param displayCheckered: (C Q E) Display a unique checker and identification pattern for
each UV tiles
:param displayDistortion: (C Q E) Display the layout in shaded colors to indentify areas
with stretched/squashed UVs
:param displayDivisionLines: (Q E) Specify true to display the subdivision lines between
grid lines
:param displayGridLines: (Q E) Specify true to display the grid lines
:param displayImage: (Q E) Set a particular image in the Editor Image Stack as the current
Editor Image Images are added to the Editor Image Stack using the "si/saveImage" fla
:param displayIsolateSelectHUD: (C Q E) Show heads-up display of isolate selection
:param displayLabels: (Q E) Specify true to display the grid line numeric labels
:param displayOverlappingUVCountHUD: (C Q E) Show heads-up display of overlapping UV count,
as a part UV Statistics HUD
:param displayPreselection: (C Q E) Toggles the pre-selection display
:param displayReversedUVCountHUD: (C Q E) Show heads-up display of UV Shells, as a part UV
Statistics HUD
:param displaySolidMap: (C Q E) Display a solid overlay for the active texture map
:param displayStyle: (C Q E) Set the mode to display the image Valid values are: "color"
to display the basic RGB image "mask" to display the mask channel "lum" to display the l
:param displayTextureBorder: (C Q E) Toggles the texture borders display
:param displayUVShellCountHUD: (C Q E) Show heads-up display of UV Shell count, as a part
UV Statistics HUD
:param displayUVStatisticsHUD: (C Q E) Show heads-up display of UV Statistics
:param displayUsedPercentageHUD: (C Q E) Show heads-up display of used UV space percentage,
as a part UV Statistics HUD
:param distortionAlpha: (C Q E) Set or query the distortion display alpha
:param distortionPerObject: (C Q E) Toggles the per-object distortion display
:param divisions: (C Q E) Sets the number of subdivisions between main grid lines
:param docTag: (C Q E) Attaches a tag to the editor
:param doubleBuffer: (C Q E) Set the display in double buffer mode
:param drawAxis: (C Q E) Set or query whether the axis will be drawn
:param drawSubregions: (C Q E) Toggles the subregion display
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param exposure: (Q E) The exposure value used by the color management of the current
editor
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param forceRebake: (C E) Forces the current cache texture to refresh
:param frameAll: (C) This will zoom on the whole scene
:param frameSelected: (C) This will zoom on the currently selected objects
:param frontFacingColor: (C Q E) Sets or queries the RGBA front facing color
:param gamma: (Q E) The gamma value used by the color management of the current editor
:param gridLinesColor: (C Q E) The color of grid lines, default is 0.325 0.325 0.325
:param gridNumbersColor: (C Q E) The color of grid numbers, default is 0.2 0.2 0.2
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param imageBaseColor: (C Q E) The base color of the image, default is white 1.0 1.0 1.0
:param imageDim: (C Q E) Toggles the image dimming
:param imageDisplay: (Q E) Toggles the Texture Image display
:param imageNames: (Q) List image names for all Texture Images available for display, if
any
:param imageNumber: (Q E) Sets the number of Texture Images to display This depends on the
number of textures corresponding to the current selection If there are N textures,
:param imagePixelSnap: (Q E) Sets a mode so that UV transformations in the UV Texture
Editor will cause UV values to snap to image pixel corners Which pixels are used depends
on
:param imageRatio: (Q E) Sets the window to draw using the Texture Image's height versus
width ratio If the width is greater than the height, then the width is set to be 1 "
:param imageRatioValue: (Q) Query current image ratio value in UV Editor
:param imageSize: (Q) Returns the size of the Texture Image currently being displayed The
values returned are width followed by height Image size can only be queried
:param imageTileRange: (Q E) Sets the UV range of the display The 4 values specify the
minimum U, V and maximum U, V in that order When viewing a texture image, these values af
:param imageUnfiltered: (Q E) Sets the Texture Image to draw unfiltered The image will
appear "pixelated" when the display resolution is higher than the resolution of the image
:param internalFaces: (C Q E) Display contained faces by the selected components
:param labelPosition: (Q E) The position of the grid's numeric labels Valid values are
"axis" and "edge"
:param loadImage: (E) load an image from disk and set it as the current Editor Image
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param maxResolution: (C Q E) This flag will set the current cached texture's maximum
resolution
:param multiColorAlpha: (C Q E) Sets the multi-color alpha of shaded UVs
:param nbImages: (Q) returns the number of images
:param nextView: (E) Switches to the next view
:param numUvSets: (C Q E) This flag will return the number of UV sets for selected objects
in the texture window
:param numberOfImages: (Q) The number of Texture Images currently available for display
:param numberOfTextures: (Q) The number of textures currently available for display
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param previousView: (E) Switches to the previous view
:param realSize: (C) This will display the image with the size of the internal buffer
Note: This argument no long has any affect on image display
:param refresh: (E) requests a refresh of the current Editor Image
:param relatedFaces: (C Q E) Display connected faces by the selected components
:param removeAllImages: (E) remove all the Editor Images from the Editor Image Stack
:param removeImage: (E) remove the current Editor Image from the Editor Image Stack
:param rendererString: (C Q E) Set or query the string describing the current renderer
:param reset: (C) Resets the ground plane to its default values
:param saveImage: (E) save the current Editor Image to memory Saved Editor Images are
stored in an Editor Image Stack The most recently saved image is stored in position
:param scaleBlue: (C Q E) Define the scaling factor for the blue component in the View The
default value is 1 and can be between -1000 to +1000
:param scaleGreen: (C Q E) Define the scaling factor for the green component in the View
The default value is 1 and can be between -1000 to +1000
:param scaleRed: (C Q E) Define the scaling factor for the red component in the View The
default value is 1 and can be between -1000 to +1000
:param selectInternalFaces: (C Q E) Add to selectionList the faces which are contained by
(internal to) selected components
:param selectRelatedFaces: (C) Add to selectionList the faces which are connected to
(non-internally related to) selected components
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param setUvSet: (C E) This flag will set the current UV set on one given selected object
within the texture window
:param singleBuffer: (C Q E) Set the display in single buffer mode
:param size: (C Q E) Sets the size of the grid
:param solidMap3dView: (C Q E) Display a solid overlay for the active texture map in 3D
viewport
:param solidMapColorSeed: (C Q E) Sets the multi-color seed of shaded UVs
:param solidMapPerShell: (C Q E) Display a solid overlay with a random color per shell
:param spacing: (C) Sets the spacing between main grid lines
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param style: (Q E) This flag is obsolete and should not be used
:param subdivisionLinesColor: (C Q E) The color of subdivision lines, default is 0.25 0.25
0.25
:param textureBorder3dView: (C Q E) Toggles the texture borders display in 3d viewport
:param textureBorderColor: (C Q E) Sets the display color of texture border
:param textureBorderWidth: (C Q E) Set the display edge width of texture border
:param textureNames: (Q) Texture names for all Texture Images available for display, if
any
:param textureNumber: (Q E) Sets the number of textures to display This depends on the
number of textures corresponding to the current selection If there are N textures, then t
:param tileLabels: (C Q E) Toggles the texture tile label display
:param tileLinesColor: (C Q E) The color of tile lines, default is 0.0 0.0 0.0
:param toggle: (C Q E) Toggles the ground plane display
:param toggleExposure: (E) Toggles between the current and the default exposure value of
the editor
:param toggleGamma: (E) Toggles between the current and the default gamma value of the
editor
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useFaceGroup: (C Q E) Display faces that are associated with the groupId that is set
on the mesh node that is drawn (The attribute "displayFacesWithGroupId")
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param usedPercentageHUDRange: (C Q E) Sets the range when calculating used UV space
percentage The 4 values specify the minimum U, V and maximum U, V in that order., default
is 0 0 1 1
:param uvSets: (C Q E) This flag will return strings containing UV set and object name
pairs for selected objects in the texture window The syntax of each pair is "objectN
:param viewPortImage: (C E) Toggles the view port/ caching Texture Images
:param viewTransformName: (Q E) Sets the view pipeline to be applied if color management is
enabled in the current editor
:param wireframeComponentColor: (C Q E) Sets or queries the RGBA component wireframe color
:param wireframeObjectColor: (C Q E) Sets or queries the RGBA object wireframe color
:param writeImage: (E) write the current Editor Image to disk
:returns: The name of the texture window
"""
pass
def getMetadata(*args, dataType: bool=True, listChannelNames: bool=True, listMemberNames:
bool=True, listStreamNames: bool=True, memberName: AnyStr="", channelName:
Union[AnyStr, bool]="", channelType: Union[AnyStr, bool]="", endIndex:
AnyStr="", index: Union[AnyStr, List[AnyStr], bool]="", indexType: Union[AnyStr,
bool]="", scene: bool=True, startIndex: AnyStr="", streamName: Union[AnyStr,
bool]="", **kwargs)->List[int]:
"""
This command is used to retrieve the values of metadata elements from a node or scene It
is restricted to returning a single structure member at a time For convenience the detail
required is only enough to find a single Member of a single Structure on a single metadata
Channel In the simplest case if there is a single Stream on one metadata Cha
:param dataType: (C) Used with the flag 'streamName' and 'memberName' to query the dataType
of the specfied member
:param listChannelNames: (C) Query the channel names on the shape This flag can be used
with some flags to filter the results It can be used with the flag 'streamName' to get t
:param listMemberNames: (C) Query the member names on the shape This flag can be used with
some flags to filter the results It can be used with 'streamName' to get the member
:param listStreamNames: (C) Query the stream names on the shape This flag can be used with
some flags to filter the results It can be used with the flag 'channelName' to get t
:param memberName: (C) Name of the Structure member being retrieved The names of the
members are set up in the Structure definition, either through the description passed
:param channelName: (C Q) Filter the metadata selection to only recognize metadata
belonging to the specified named Channel (e.g "vertex") This flag is ignored if the
compon
:param channelType: (C Q) Obsolete - use the 'channelName' flag instead In query mode,
this flag can accept a value
:param endIndex: (C) The metadata is stored in a Stream, which is an indexed list If you
have mesh components selected then the metadata indices are implicit in the list
:param index: (C Q M) In the typical case metadata is indexed using a simple integer value
Certain types of data may use other index types e.g a "vertexFace" component
:param indexType: (C Q) Name of the index type the new Channel should be using If not
specified this defaults to a simple integer index Of the native types only a mesh "ve
:param scene: (C Q) Use this flag when you want to add metadata to the scene as a whole
rather than to any individual nodes If you use this flag and have nodes selected
:param startIndex: (C) The metadata is stored in a Stream, which is an indexed list If you
have mesh components selected then the metadata indices are implicit in the list
:param streamName: (C Q) Name of the metadata Stream Depending on context it could be the
name of a Stream to be created, or the name of the Stream to pass through the filte
:returns: List of integer values from the metadata member
"""
pass
def ShowLastHidden(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dragAttrContext(*args, connectTo: Union[name, List[name], bool]=None, exists: bool=True,
history: bool=True, image1: Union[AnyStr, bool]="", image2: Union[AnyStr,
bool]="", image3: Union[AnyStr, bool]="", name: AnyStr="", reset: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The dragAttrContext allows a user to manipulate the attributes of an object by using a
virtual slider within the viewport The virtual slider is used by dragging in a viewport
with the middle mouse button The speed at which the attributes are changed can be
controlled by holding down the Ctrl key to slow it down and the Shift key to speed it up
:param connectTo: (C Q E M) Specifies an attribute to which to connect the context This is
a multi-use flag, but all attributes used must be from one object
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param reset: (C E) Resets the list of attributes to which the context is connected
:returns: The name of the context created
"""
pass
def findType(*args, deep: bool=True, exact: bool=True, forward: bool=True, type: AnyStr="",
**kwargs)->List[AnyStr]:
"""
The findType command is used to search through a dependency subgraph on a certain node to
find all nodes of the given type The search can go either upstream (input connections) or
downstream (output connections) The plug/attribute dependencies are not taken into account
when searching for matching nodes, only the connections
:param deep: (C) Find all nodes of the given type instead of just the first
:param exact: (C) Match node types exactly instead of any in a node hierarchy
:param forward: (C) Look forwards (downstream) through the graph rather than backwards
(upstream) for matching nodes
:param type: (C) Type of node to look for (e.g "transform") This flag is mandatory
:returns: The list of node(s) of the requested type connected to the given node(s)
"""
pass
def DuplicateCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def bezierAnchorState(*args, even: bool=True, smooth: bool=True, **kwargs)->int:
"""
The bezierAnchorState command provides an easy interface to modify anchor states: -
Smooth/Broken anchor tangents - Even/Uneven weighted anchor tangents
:param even: (C) Sets selected anchors (or attached tangent handles) to even weighting when
true, uneven otherwise
:param smooth: (C) Sets selected anchors (or attached tangent handles) to smooth when true,
broken otherwise
:returns: (number of modified anchors)
"""
pass
def dR_connectPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def helpLine(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True, manage:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a help line where tool help/hints are shown
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name of control.
"""
pass
def CopyMeshAttributes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorAddOnNodeCreate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteHistory(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateCameraAimUpOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeTestTextureOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def removeMultiInstance(*args, allChildren: bool=True, b: bool=True, **kwargs)->bool:
"""
Removes a particular instance of a multiElement This is only useful for input attributes
since outputs will get regenerated the next time the node gets executed This command will
remove the instance and optionally break all incoming and outgoing connections to that
instance If the connections are not broken (with the -b true) flag, then the comm
:param allChildren: (C) If the argument is true, remove all children of the multi parent
:param b: (C) If the argument is true, all connections to the attribute will be broken
before the element is removed If false, then the command will fail if the e
:returns: (true if the instance was removed, false if something went wrong,
like the
attribute is connected but -b true was not specified)
"""
pass
def dR_alwaysOnTopTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CutUVs3D(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorCreateAudioTracksAtEnd(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def callbacks(*args, addCallback: Script=None, clearAllCallbacks: bool=True, clearCallbacks:
bool=True, describeHooks: bool=True, dumpCallbacks: bool=True, executeCallbacks:
bool=True, hook: AnyStr="", listCallbacks: bool=True, owner: AnyStr="",
removeCallback: Script=None, **kwargs)->List[AnyStr]:
"""
This command allows you to add callbacks at key times during UI creation so that the Maya
UI can be extended The list of standard Maya hooks, as well as the arguments which will be
passed to the callback based on the context are enumerated in the describeHooks section
below Custom hooks can also be added if third parties want to add UI extensibil
:param addCallback: (C) Add a callback for the specified hook The owner must also be
specified when adding callbacks
:param clearAllCallbacks: (C) Clear all the callbacks for all hooks and owners This is
generally only used during plugin development and testing as it affects all callbacks
regis
:param clearCallbacks: (C) Clear all the callbacks for the specified owner If a hook is
specified, only the callbacks for that hook and owner will be cleared
:param describeHooks: (C) List the standard Maya hooks Below is a list of the hooks and
their associated arguments and return values Custom hooks added by third parties are
:param dumpCallbacks: (C) Gives a list of all the registered callbacks for all hooks and
owners Can be useful for debugging
:param executeCallbacks: (C) Execute the callbacks for the specified hook, passing the
extra arguments to each callback when it is executed Returns an array (MEL) or list
(Pytho
:param hook: (C) The name of the hook for which the callback should be registered
:param listCallbacks: (C) Get the list of callbacks for the specified hook name If the
owner is specified, only callbacks for the specified hook and owner will be listed
:param owner: (C) The name of the owner registering the callback This is typically a
plugin name
:param removeCallback: (C) Remove an existing callback for the specified hook name The
owner must also be specified when removing a callback
:returns: Command result
"""
pass
def PointOnCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorExportSelectionOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Turbulence(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PasteKeys(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyProjectCurve(*args, addUnderTransform: bool=True, caching: bool=True, direction:
Union[List[float, float, float], bool]=None, directionX: Union[float,
bool]=0.0, directionY: Union[float, bool]=0.0, directionZ: Union[float,
bool]=0.0, nodeState: Union[int, bool]=0, tolerance: Union[float,
bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The polyProjectCurve command creates curves by projecting a selected curve onto a selected
poly mesh The direction of projection will be the current view direction unless the
direction vector is specified with the -direction/-d flag
:param addUnderTransform: (C) True if the resulting curve should be added under the source
transform
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param direction: (C Q E) Direction of projection
:param directionX: (C Q E) X direction of projection
:param directionY: (C Q E) Y direction of projection
:param directionZ: (C Q E) Z direction of projection
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param tolerance: (C Q E) Tolerance to fit to
:returns: Object name and node name
"""
pass
def PaintEffectPanelDeactivate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def moveVertexAlongDirection(*args, direction: Union[List[float, float, float], List[List[float,
float, float]]]=None, magnitude: Union[float, List[float]]=0.0,
normalDirection: Union[float, List[float]]=0.0, uDirection:
Union[float, List[float]]=0.0, uvNormalDirection: Union[List[float,
float, float], List[List[float, float, float]]]=None, vDirection:
Union[float, List[float]]=0.0, **kwargs)->None:
"""
The command moves the selected vertex ( control vertex ) in the specified unit direction by
the given magnitude The vertex(ices) may also be moved in the direction of unit normal (
-n flag ) For NURBS surface vertices the direction of movement could also be either in
tangent along U or tangent along V The flags -n, -u, -v and -d are mutually exc
:param direction: (C M) move the vertex along the direction as specified The direction is
normalized
:param magnitude: (C M) move by the specified magnitude in the direction vector
:param normalDirection: (C M) move components in the direction of normal by the given
magnitude at the respective components The normal is 'normalized'
:param uDirection: (C M) move components in the direction of tangent along U at the
respective components where appropriate The flag is ignored for polygons, NURBS curves T
:param uvNormalDirection: (C M) move in the triad space [u,v,n] at the respective
components by the specified displacements The flag is ignored for polygons, NURBS curves
:param vDirection: (C M) move components in the direction of tangent along V at the
respective components where appropriate The flag is ignored for polygons, NURBS curves
:returns:
"""
pass
def XgmSetPlaceBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def flushUndo(*args, **kwargs)->None:
"""
Removes everything from the undo queue, freeing up memory
:returns:
"""
pass
def XgGuideTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def subdToBlind(*args, absolutePosition: bool=True, includeCreases: bool=False,
includeZeroOffsets: bool=False, **kwargs)->bool:
"""
The subdivision surface hierarchical edits will get copied into blind data on the given
polygon The polygon face count and topology must match the subdivision surface base mesh
face count and topology If they don't, the blind data will still appear, but is not
guaranteed to produce the same result when converted back to a subdivision surface
:param absolutePosition: (C) If set to true, the hierarchical edits are represented as the
point positions, not the point offsets Most of the time, this is not desirable, but if
:param includeCreases: (C) If set, the creases get transfered as well With it false, the
subdivision surface created from the blind data + polygon will have lost all the craes
:param includeZeroOffsets: (C) If set, the zero offset will get included in the blind data
This will greatly increase the size of the blind data, but will also let you keep all cr
:returns: Command result
"""
pass
def extendFluid(*args, **kwargs)->None:
"""
"""
pass
def ShowMeshGrabToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def VortexOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MergeEdgeTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PickWalkLeftSelect(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_viewJointsTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmCreateInteractiveGroomSplines(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CoarserSubdivLevel(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorFbxExportAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def intFieldGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0, adjustableColumn3:
int=0, adjustableColumn4: int=0, adjustableColumn5: int=0, adjustableColumn6:
int=0, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, columnAlign:
Union[List[int, AnyStr], List[List[int, AnyStr]]]=None, columnAlign2:
List[AnyStr, AnyStr]=None, columnAlign3: List[AnyStr, AnyStr, AnyStr]=None,
columnAlign4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign5:
List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign6: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach: Union[List[int,
AnyStr, int], List[List[int, AnyStr, int]]]=None, columnAttach2: List[AnyStr,
AnyStr]=None, columnAttach3: List[AnyStr, AnyStr, AnyStr]=None, columnAttach4:
List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach5: List[AnyStr, AnyStr,
AnyStr, AnyStr, AnyStr]=None, columnAttach6: List[AnyStr, AnyStr, AnyStr,
AnyStr, AnyStr, AnyStr]=None, columnOffset2: List[int, int]=None,
columnOffset3: List[int, int, int]=None, columnOffset4: List[int, int, int,
int]=None, columnOffset5: List[int, int, int, int, int]=None, columnOffset6:
List[int, int, int, int, int, int]=None, columnWidth: Union[List[int, int],
List[List[int, int]]]=None, columnWidth1: int=0, columnWidth2: List[int,
int]=None, columnWidth3: List[int, int, int]=None, columnWidth4: List[int, int,
int, int]=None, columnWidth5: List[int, int, int, int, int]=None, columnWidth6:
List[int, int, int, int, int, int]=None, defineTemplate: AnyStr="", docTag:
Union[AnyStr, bool]="", dragCallback: Script=None, dragCommand: Script=None,
dropCallback: Script=None, enable: bool=True, enable1: bool=True, enable2:
bool=True, enable3: bool=True, enable4: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, extraLabel: Union[AnyStr,
bool]="", fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True, label:
Union[AnyStr, bool]="", manage: bool=True, noBackground: bool=True,
numberOfFields: int=0, numberOfPopupMenus: bool=True, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True, rowAttach:
Union[List[int, AnyStr, int], List[List[int, AnyStr, int]]]=None,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", value: Union[List[int, int,
int, int], bool]=None, value1: Union[int, bool]=0, value2: Union[int, bool]=0,
value3: Union[int, bool]=0, value4: Union[int, bool]=0, visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command string executed when the value of any of the fields
changes
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command string executed when dragging the invisible slider in any
of the fields
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enable1: (C Q E)
:param enable2: (C Q E)
:param enable3: (C Q E)
:param enable4: (C Q E) Enable state for the respective field
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param extraLabel: (C Q E) If present on creation this specifies that there will be an
extra label in the group Sets the string to be label text to the right of fields
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) If present on creation this specifies that there will be a label to
the left of the fields Sets the string to be the label text
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfFields: (C) Set the number of fields on creation One to four fields are
available The default is one field
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Values for all fields
:param value1: (C Q E)
:param value2: (C Q E)
:param value3: (C Q E)
:param value4: (C Q E) Value for the respective field
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def pluginDisplayFilter(*args, classification: Union[AnyStr, bool]="", deregister: bool=True,
exists: bool=True, label: Union[AnyStr, bool]="", listFilters:
bool=True, register: bool=True, q=True, query=True,
**kwargs)->Union[AnyStr, Any]:
"""
Register, deregister or query a plugin display filter Plug-ins can use this command to
register their own display filters which will appear in the 'Show' menus on Maya's model
panels
:param classification: (C Q) The classification used to filter objects in Viewport 2.0
This classification is the same as MFnPlugin::registerNode() If the node was registered w
:param deregister: (C) Deregister a plugin display filter
:param exists: (C) Returns true if the specified filter exists, false otherwise Other
flags are ignored
:param label: (C Q) The string to be displayed for this filter in the UI E.g in the
'Show' menu of a model panel The default value of this flag is the same as the plu
:param listFilters: (Q) Returns an array of all plugin display filters
:param register: (C) Register a plugin display filter The -register is implied if both
-register and -deregister flags are missing in create mode You are responsible fo
:returns: string[]
"""
pass
def FBXLoadImportPresetFile(*args, **kwargs)->None:
"""
"""
pass
def TemplateObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def JointToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CombinePolygonsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def paramLocator(*args, position: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
The command creates a locator in the underworld of a NURBS curve or NURBS surface at the
specified parameter value If no object is specified, then a locator will be created on the
first valid selected item (either a curve point or a surface point)
:param position: (C) Whether to set the locator position in normalized space
:returns: Name for the new locator in the underworld of NURBS shape.
"""
pass
def sbs_GetSubstanceBuildVersion(*args, **kwargs)->None:
"""
"""
pass
def MakeMotorBoatsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CircularFilletOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleAutoActivateBodyPart(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def affectedNet(*args, name: Union[AnyStr, bool]="", type: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This command gets the list of attributes on a node or node type and creates nodes of type
TdnAffect, one for each attribute, that are connected iff the source node's attribute
affects the destination node's attribute
:param name: (C Q E) Name to use for this command
:param type: (C) Get information from the given node type instead of one node
:returns:
"""
pass
def fluidDeleteCacheOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySetVertices(*args, **kwargs)->None:
"""
"""
pass
def OutlinerToggleDAGOnly(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShareUVInstances(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nexQuadDrawContext(*args, **kwargs)->None:
"""
"""
pass
def polyWarpImage(*args, **kwargs)->None:
"""
"""
pass
def curveEditorCtx(*args, direction: Union[int, bool]=0, exists: bool=True, history: bool=True,
image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", name: AnyStr="", relativeTangentSize: Union[float,
bool]=4, title: Union[AnyStr, bool]="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The curveEditorCtx command creates a new NURBS editor context, which is used to edit a
NURBS curve or surface
:param direction: (Q) Query the current direction of the tangent control Always zero for
the curve case In the surface case, its 0 for the normal direction, 1 for U dire
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param relativeTangentSize: (C Q E) Relative size of the tangent manipulator handle Helps
to adjust as the surface parameterization controls the size of the tangent, even if the
shape
:param title: (Q E) The title for the tool
:returns: (name of the new context)
"""
pass
def HypershadeMoveTabLeft(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtractFace(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateNURBSPlaneOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_GetGraphsNamesFromSubstanceNode(*args, **kwargs)->None:
"""
"""
pass
def EnableDynamicConstraints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CVCurveTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllFluids(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nodePreset(*args, attributes: AnyStr="", custom: AnyStr="", delete: List[name, AnyStr]=None,
exists: List[name, AnyStr]=None, isValidName: AnyStr="", list: name=None, load:
List[name, AnyStr]=None, save: List[name, AnyStr]=None, **kwargs)->bool:
"""
Command to save and load preset settings for a node This command allows you to take a
snapshot of the values of all attributes of a node and save it to disk as a preset with
user specified name Later the saved preset can be loaded and applied onto a different node
of the same type The end result is that the node to which the preset is applied ta
:param attributes: (C) A white space separated string of the named attributes to save to
the preset file If not specified, all attributes will be stored
:param custom: (C) Specifies a MEL script for custom handling of node attributes that are
not handled by the general save preset mechanism (ie multis, dynamic attribut
:param delete: (C) Deletes the existing preset for the node specified by the first argument
with the name specified by the second argument
:param exists: (C) Returns true if the node specified by the first argument already has a
preset with a name specified by the second argument This flag can be used to
:param isValidName: (C) Returns true if the name consists entirely of valid characters for
a preset name Returns false if not Because the preset name will become part of a
:param list: (C) Lists the names of all presets which can be loaded onto the specified
node
:param load: (C) Sets the settings of the node specified by the first argument according to
the preset specified by the second argument Any attributes on the node wh
:param save: (C) Saves the current settings of the node specified by the first argument to
a preset of the name specified by the second argument If a preset for that
:returns: if isValidName or exists is used.
"""
pass
def animDisplay(*args, modelUpdate: Union[AnyStr, bool]="", refAnimCurvesEditable: bool=True,
timeCode: Union[AnyStr, bool]="", timeCodeOffset: Union[AnyStr, bool]="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This command changes certain display options used by animation windows
:param modelUpdate: (C Q E) Controls how changes to animCurves are propagated through the
dependency graph Valid modes are "none", "interactive" or "delayed" If modelUpdate is
:param refAnimCurvesEditable: (C Q E) Specify if animation curves from referenced files are
editable
:param timeCode: (C Q E) Controls how time value are display Valid values are "frame",
"timecode", "fulltimecode" If the value is "frame" maya will display time in frame ev
:param timeCodeOffset: (C Q E) This flag has now been deprecated It still exists to not
break legacy scripts, but it will now do nothing See the new timeCode command to set and
q
:returns:
"""
pass
def HideLights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def clipSchedulerOutliner(*args, annotation: Union[AnyStr, bool]="", backgroundColor:
Union[List[float, float, float], bool]=None, clipScheduler: AnyStr="",
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus:
bool=True, exists: bool=True, fullPathName: bool=True, height:
Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, isObscured: bool=True, manage: bool=True, noBackground:
bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates/edits/queries a clip scheduler outliner control
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param clipScheduler: (E) Name of the clip scheduler for which to display information
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the outliner control.
"""
pass
def dgfootprint(*args, **kwargs)->None:
"""
"""
pass
def BakeChannelOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExportSkinWeightMapsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleOutliner(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cMuscleCompIndex(*args, **kwargs)->None:
"""
"""
pass
def nurbsSquare(*args, caching: bool=True, center: Union[List[float, float, float], bool]=None,
centerX: Union[float, bool]=0, centerY: Union[float, bool]=0, centerZ:
Union[float, bool]=0, degree: Union[int, bool]=3, nodeState: Union[int, bool]=0,
normal: Union[List[float, float, float], bool]=None, normalX: Union[float,
bool]=0, normalY: Union[float, bool]=0, normalZ: Union[float, bool]=1,
sideLength1: Union[float, bool]=1.0, sideLength2: Union[float, bool]=1.0,
spansPerSide: Union[int, bool]=1, constructionHistory: bool=True, name:
AnyStr="", object: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The nurbsSquare command creates a square
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param center: (C Q E) The center point of the square
:param centerX: (C Q E) X of the center point Default: 0
:param centerY: (C Q E) Y of the center point Default: 0
:param centerZ: (C Q E) Z of the center point Default: 0
:param degree: (C Q E) The degree of the resulting circle: 1 - linear, 2 - quadratic, 3 -
cubic, 5 - quintic, 7 - heptic Default: 3
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param normal: (C Q E) The normal of the plane in which the square will lie
:param normalX: (C Q E) X of the normal direction Default: 0
:param normalY: (C Q E) Y of the normal direction Default: 0
:param normalZ: (C Q E) Z of the normal direction Default: 1
:param sideLength1: (C Q E) The length of a side on the square Default: 1.0
:param sideLength2: (C Q E) The length of an adjacent side on the square Default: 1.0
:param spansPerSide: (C Q E) The number of spans per side determines the resolution of the
square Default: 1
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:returns: Object name and node name
"""
pass
def TimeEditorToggleTimeCursorRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nClothCreateOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadePerspLayout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddInfluence(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PreviousKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def muMessageAdd(*args, **kwargs)->None:
"""
"""
pass
def PaintGeomCacheToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVSphericalProjection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyDelFacet(*args, caching: bool=True, constructionHistory: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Deletes faces If the result is split into disconnected pieces, the pieces (so-called
shells) are still considered to be one object
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def ToggleTextureBorder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Flare(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def pointOnPolyConstraint(*args, layer: AnyStr="", maintainOffset: bool=True, name:
Union[AnyStr, bool]="", offset: Union[List[float, float, float],
bool]=None, remove: bool=True, skip: Union[AnyStr, List[AnyStr]]="",
targetList: bool=True, weight: Union[float, bool]=0.0,
weightAliasList: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
Constrain an object's position to the position of the target object or to the average
position of a number of targets A pointOnPolyConstraint takes as input one or more
"target" DAG transform nodes at which to position the single "constraint object" DAG
transform node The pointOnPolyConstraint positions the constrained object at the weighted
ave
:param layer: (C E) Specify the name of the animation layer where the constraint should be
added
:param maintainOffset: (C) The offset necessary to preserve the constrained object's
initial position will be calculated and used as the offset
:param name: (C Q E) Sets the name of the constraint node to the specified name Default
name is constrainedObjectName_constraintType
:param offset: (C Q E) Sets or queries the value of the offset Default is 0,0,0
:param remove: (E) removes the listed target(s) from the constraint
:param skip: (C E M) Specify the axis to be skipped Valid values are "x", "y", "z" and
"none" During creation, "none" is the default This flag is multi-use
:param targetList: (Q) Return the list of target objects
:param weight: (C Q E) Sets the weight value for the specified target(s) If not given at
creation time, the default value of 1.0 is used
:param weightAliasList: (Q) Returns the names of the attributes that control the weight of
the target objects Aliases are returned in the same order as the targets are returned
:returns: Name of the created constraint node
"""
pass
def RemoveInbetween(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def reroot(*args, **kwargs)->None:
"""
This command will reroot a skeleton The selected joint or the given joint at the command
line will be the new root of the skeleton All ikHandles passing through the selected joint
or above it will be deleted The given(or selected) joint should not have skin attached
The command works on the given or selected joint No options or flags are nece
:returns:
"""
pass
def displayString(*args, delete: bool=True, exists: bool=True, keys: bool=True, replace:
bool=True, value: Union[AnyStr, bool]="", q=True, query=True,
**kwargs)->Union[None, Any]:
"""
Assign a string value to a string identifier Allows you define a string in one location
and then refer to it by its identifier in many other locations Formatted strings are also
supported (NOTE however, this functionality is now provided in a more general fashion by
the format command, use of format is recommended) You may embed up to 3 special
:param delete: (C) This flag is used to remove an identifer string The command will fail
if the identifier does not exist
:param exists: (C) Returns true or false depending upon whether the specified identifier
exists
:param keys: (C Q) List all displayString keys that match the identifier string The
identifier string may be a whole or partial key string The command will return a l
:param replace: (C Q) Since a displayString command will fail if it tries to assign a new
value to an existing identifer, this flag is required to allow updates to the val
:param value: (C Q) The display string\'s value If you do not specify this flag when
creating a display string then the value will be the same as the identifier
:returns:
"""
pass
def selectPref(*args, affectsActive: bool=True, allowHiliteSelection: bool=True,
autoSelectContainer: bool=True, autoUseDepth: bool=True, clickBoxSize: Union[int,
bool]=0, clickDrag: bool=True, containerCentricSelection: bool=True,
disableComponentPopups: bool=True, expandPopupList: bool=True,
ignoreSelectionPriority: bool=True, manipClickBoxSize: Union[int, bool]=0,
paintSelect: bool=True, paintSelectWithDepth: bool=True, popupMenuSelection:
bool=True, preSelectBackfacing: bool=True, preSelectClosest: bool=True,
preSelectDeadSpace: Union[int, bool]=0, preSelectHilite: bool=True,
preSelectHiliteSize: Union[float, bool]=0.0, preSelectTweakDeadSpace: Union[int,
bool]=0, selectTypeChangeAffectsActive: bool=True, selectionChildHighlightMode:
Union[int, bool]=0, singleBoxSelection: bool=True, straightLineDistance:
bool=True, trackSelectionOrder: bool=True, useDepth: bool=True, xformNoSelect:
bool=True, q=True, query=True, **kwargs)->Union[bool, Any]:
"""
This command controls state variables used to selection UI behavior
:param affectsActive: (C Q) Set affects-active toggle which when on causes the active list
to be affected when changing between object and component selection mode
:param allowHiliteSelection: (C Q) When in component selection mode, allow selection of
objects for editing If an object is selected for editing, it appears in the hilite color
and it
:param autoSelectContainer: (Q) When enabled, with container centric selection also on,
whenever the root transform is selected in the viewport, the container node will
automaticall
:param autoUseDepth: (Q) When enabled, useDepth and paintSelectWithDepth will be
automatically enabled in shaded display mode and disabled in wireframe display mode
:param clickBoxSize: (C Q) When click selecting, this value defines the size of square
picking region surrounding the cursor The size of the square is twice the specified valu
:param clickDrag: (C Q) Set click/drag selection interaction on/off
:param containerCentricSelection: (Q) When enabled, selecting any DAG node in a container
in the viewport will select the container's root transform if there is one If there is no
root t
:param disableComponentPopups: (C Q) A separate preference to allow users to disable popup
menus when selecting components This pref is only meaningful if the popupMenuSelection
pref is
:param expandPopupList: (C Q) When in popup selection mode, if this is set then all
selection items that contain multiple objects or components will be be expanded such that
each
:param ignoreSelectionPriority: (C Q) If this is set, selection priority will be ignored
when performing selection
:param manipClickBoxSize: (C Q) When selecting a manipulator, this value defines the size
of square picking region surrounding the cursor The size of the square is twice the
specif
:param paintSelect: (Q) When enabled, the select tool will use drag selection instead of
marquee selection
:param paintSelectWithDepth: (Q) When enabled, paint selection will not select components
that are behind the surface in the current camera view
:param popupMenuSelection: (C Q) If this is set, a popup menu will be displayed and used to
determine the object to select The menu lists the current user box (marquee) of selected
:param preSelectBackfacing: (Q) When enabled preselection will highlight backfacing
components whose normals face away from the camera
:param preSelectClosest: (Q) When enabled and the cursor is over a surface, preselection
highlighting will try to preselect the closest component to the cursor regardless of dist
:param preSelectDeadSpace: (Q) This value defines the size of the region around the cursor
used for preselection highlighting when the cursor is outside the surface
:param preSelectHilite: (Q) When enabled, the closest component under the cursor will be
highlighted to indicate that clicking will select that component
:param preSelectHiliteSize: (Q) This value defines the size of the region around the cursor
used for preselection highlighting Within this region the closest component to the curso
:param preSelectTweakDeadSpace: (Q) This value defines the size of the region around the
cursor used for preselection highlighting when the cursor is outside the surface in tweak
mode
:param selectTypeChangeAffectsActive: (Q) If true then the active list will be updated
according to the new selection preferences
:param selectionChildHighlightMode: (C Q) Controls the highlighting of the children of a
selected object Valid modes are: 0: Always highlight children 1: Never highlight children
2: Use per-
:param singleBoxSelection: (C Q) Set single box selection on/off This flag indicates
whether just single object will be selected when the user box (marquee) selects several
objects
:param straightLineDistance: (Q) If true then use straight line distances for selection
proximity
:param trackSelectionOrder: (Q) When enabled, the order of selected objects and components
will be tracked The 'ls' command will be able to return the active list in the order of s
:param useDepth: (Q) When enabled, marquee selection will not select components that are
behind the surface in the current camera view
:param xformNoSelect: (C Q) Disable selection in xform tools
:returns: in the query mode.
"""
pass
def FBXGetTakeIndex(*args, **kwargs)->None:
"""
"""
pass
def cone(*args, axis: Union[List[float, float, float], bool]=None, caching: bool=True, degree:
Union[int, bool]=3, endSweep: Union[float, bool]=2, heightRatio: Union[float,
bool]=2.0, nodeState: Union[int, bool]=0, pivot: Union[List[float, float, float],
bool]=None, radius: Union[float, bool]=1.0, sections: Union[int, bool]=8, spans:
Union[int, bool]=1, startSweep: Union[float, bool]=0, tolerance: Union[float,
bool]=0.01, useOldInitBehaviour: bool=False, useTolerance: bool=False,
constructionHistory: bool=True, name: AnyStr="", object: bool=True, polygon: int=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The cone command creates a new cone and/or a dependency node that creates one, and returns
their names
:param axis: (C Q E) The primitive's axis
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param degree: (C Q E) The degree of the resulting surface: 1 - linear, 3 - cubic Default:
3
:param endSweep: (C Q E) The angle at which to end the surface of revolution Default is
2Pi radians, or 360 degrees Default: 6.2831853
:param heightRatio: (C Q E) Ratio of "height" to "width" Default: 2.0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pivot: (C Q E) The primitive's pivot point
:param radius: (C Q E) The radius of the object Default: 1.0
:param sections: (C Q E) The number of sections determines the resolution of the surface in
the sweep direction Used only if useTolerance is false Default: 8
:param spans: (C Q E) The number of spans determines the resolution of the surface in the
opposite direction Default: 1
:param startSweep: (C Q E) The angle at which to start the surface of revolution Default:
0
:param tolerance: (C Q E) The tolerance with which to build the surface Used only if
useTolerance is true Default: 0.01
:param useOldInitBehaviour: (C Q E) Create the cone with base on the origin as in Maya V8.0
and below Otherwise create cone centred at origin Default: false
:param useTolerance: (C Q E) Use the specified tolerance to determine resolution Otherwise
number of sections will be used Default: false
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:returns: Object name and node name
"""
pass
def SelectAllWires(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def vnnConnect(*args, **kwargs)->None:
"""
"""
pass
def AddSelectionAsTargetShape(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def menuItem(*args, allowOptionBoxes: bool=True, annotation: Union[AnyStr, bool]="", boldFont:
bool=False, checkBox: bool=True, collection: Union[AnyStr, bool]="", command:
Union[Script, bool]=None, data: Union[int, bool]=0, defineTemplate: AnyStr="",
divider: bool=True, dividerLabel: Union[AnyStr, bool]="", docTag: Union[AnyStr,
bool]="", dragDoubleClickCommand: Union[Script, bool]=None, dragMenuCommand:
Union[Script, bool]=None, echoCommand: bool=True, enable: bool=True,
enableCommandRepeat: bool=True, exists: bool=True, familyImage: Union[AnyStr,
bool]="", image: Union[AnyStr, bool]="", imageOverlayLabel: Union[AnyStr, bool]="",
insertAfter: AnyStr="", isCheckBox: bool=True, isOptionBox: bool=True,
isRadioButton: bool=True, italicized: bool=False, label: Union[AnyStr, bool]="",
longDivider: bool=True, ltVersion: Union[AnyStr, bool]="", optionBox: bool=True,
optionBoxIcon: Union[AnyStr, bool]="", parent: AnyStr="", postMenuCommand:
Union[Script, bool]=None, postMenuCommandOnce: bool=True, radialPosition:
Union[AnyStr, bool]="", radioButton: bool=True, runTimeCommand: AnyStr="",
sourceType: Union[AnyStr, bool]="", subMenu: bool=True, tearOff: bool=True,
useTemplate: AnyStr="", version: Union[AnyStr, bool]="", visible: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates/edits/queries menu items
:param allowOptionBoxes: (C Q) Deprecated All menus and menu items always allow option
boxes In the case of submenu items this flag specifies whether the submenu will be able
to
:param annotation: (C Q E) Annotate the menu item with an extra string value
:param boldFont: (C Q) Specify if text should be bold Only supported in menus which use
the marking menu implementation Default is false for Windows, and true for all oth
:param checkBox: (C Q E) Creates a check box menu item Argument specifies the check box
value
:param collection: (C Q) To explicitly add a radio menu item to a radioMenuItemCollection
:param command: (C Q E) Attaches a command/script that will be executed when the item is
selected Note this command is not executed when the menu item is in an optionMenu c
:param data: (C Q E) Attaches a piece of user-defined data to the menu item
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param divider: (C Q) Creates a divider menu item
:param dividerLabel: (C Q E) Adds a label to a divider menu item
:param docTag: (C Q E) Attaches a tag to the menu item
:param dragDoubleClickCommand: (C Q E) If the menu item is put on the shelf then this
command will be invoked when the corresponding shelf object is double clicked
:param dragMenuCommand: (C Q E) If the menu item is put on the shelf then this command will
be invoked when the corresponding shelf object is clicked
:param echoCommand: (C Q E) Specify whether the action attached with the c/command flag
should echo to the command output areas when invoked This flag is false by default and m
:param enable: (C Q E) Enable state for the menu item A disabled menu item is dimmed and
unresponsive An enabled menu item is selectable and has normal appearance
:param enableCommandRepeat: (C Q E) This flag only affects menu items to which a command
can be attached Specify true and the command may be repeated by executing the command
repeatLas
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param familyImage: (Q) Get the filename of the family icon associated with the menu The
family icon will be used for the shelf unless an icon is specified with the image f
:param image: (C Q E) The filename of the icon associated with the menu item If the menu
containing the menu item is being edited with a menuEditor widget, then the menuE
:param imageOverlayLabel: (C Q E) Specify a short (5 character) text string to be overlayed
on top of the icon associated with the menu item This is primarily a mechanism for
differe
:param insertAfter: (C) Specify After which item the new one will be placed If this flag
is not specified, item is added at the end of the menu Use the empty string "" to
:param isCheckBox: (Q) Returns true if the item is a check box item
:param isOptionBox: (Q) Returns true if the item is an option box item
:param isRadioButton: (Q) Returns true if the item is a radio button item
:param italicized: (C Q) Specify if text should be italicized Only supported in menus
which use the marking menu implementation Default is false
:param label: (C Q E) The text that appears in the item
:param longDivider: (C Q E) Indicate whether the divider is long or short Has no effect if
divider label is set Default is true
:param ltVersion: (C Q E) This flag is used to specify the Maya LT version that this
control feature was introduced, if the version flag is not specified, or if the version fl
:param optionBox: (C Q) Indicates that the menu item will be an option box item This item
will appear to the right of the preceeding menu item
:param optionBoxIcon: (C Q E) The filename of an icon to be used instead of the usual
option box icon The icon is searched for in the folder specified by the XBMLANGPATH
environm
:param parent: (C) Specify the menu that the item will appear in
:param postMenuCommand: (C Q E) Specify a script to be executed when the submenu is about
to be shown
:param postMenuCommandOnce: (C Q E) Indicate the pmc/postMenuCommand should only be invoked
once Default value is false, ie the pmc/postMenuCommand is invoked everytime the sub menu
i
:param radialPosition: (C Q E) The radial position of the menu item if it is in a Marking
Menu Radial positions are given in the form of a cardinal direction, and may be "N", "NW"
:param radioButton: (C Q E) Creates a radio button menu item Argument specifies the radio
button value
:param runTimeCommand: (C E) A shortcut flag to link the menu item with a runTimeCommand
The value is the name of the runTimeCommand (unique) It copies the following fields fro
:param sourceType: (C Q E) Set the language type for a command script Can only be used in
conjunction with a command flag Without this flag, commands are assumed to be the sa
:param subMenu: (C Q) Indicates that the item will have a submenu Subsequent menuItems
will be added to the submenu until setParent -menu is called Note that a submenu i
:param tearOff: (C Q) For the case where the menu item is a sub menu this flag will make
the sub menu tear-off-able Note that this flag has no effect on the other menu it
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param version: (C Q E) Specify the version that this menu item feature was introduced The
argument should be given as a string of the version number (e.g "2013", "2014")
:param visible: (C Q E) The visible state of the menu item A menu item is created visible
by default Note that a menu item's actual appearance is also dependent on the vis
:returns: Full path name to the menu item.
"""
pass
def DistanceTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleIsolateSelect(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyCloseBorder(*args, caching: bool=True, constructionHistory: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Closes open borders of objects For each border edge given, a face is created to fill the
hole the edge lies on
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def AutoProjectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MakeHoleTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FrameSelectedInAllViews(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def grid(*args, default: bool=True, displayAxes: bool=True, displayAxesBold: bool=True,
displayDivisionLines: bool=True, displayGridLines: bool=True,
displayOrthographicLabels: bool=True, displayPerspectiveLabels: bool=True, divisions:
Union[int, bool]=5, orthographicLabelPosition: Union[AnyStr, bool]="",
perspectiveLabelPosition: Union[AnyStr, bool]="", reset: bool=True, size: Union[float,
bool]=12, spacing: Union[float, bool]=5, style: Union[int, bool]=0, toggle: bool=True,
q=True, query=True, **kwargs)->Union[None, Any]:
"""
This command changes the size and spacing of lines on the ground plane displayed in the
perspective and orthographic views This command lets you reset the ground plane, change
its size and grid line spacing, grid subdivisions and display options
:param default: (Q) Used to specify/query default values
:param displayAxes: (Q) Specify true to display the grid axes
:param displayAxesBold: (Q) Specify true to accent the grid axes by drawing them with a
thicker line
:param displayDivisionLines: (Q) Specify true to display the subdivision lines between grid
lines
:param displayGridLines: (Q) Specify true to display the grid lines
:param displayOrthographicLabels: (Q) Specify true to display the grid line numeric labels
in the orthographic views
:param displayPerspectiveLabels: (Q) Specify true to display the grid line numeric labels
in the perspective view
:param divisions: (Q) Sets the number of subdivisions between major grid lines The default
is 5 If the spacing is 5 units, setting divisions to 5 will cause division lin
:param orthographicLabelPosition: (Q) The position of the grid's numeric labels in
orthographic views Valid values are "axis" and "edge"
:param perspectiveLabelPosition: (Q) The position of the grid's numeric labels in
perspective views Valid values are "axis" and "edge"
:param reset: () Resets the ground plane to its default values
:param size: (Q) Sets the size of the grid in linear units The default is 12 units
:param spacing: (Q) Sets the spacing between major grid lines in linear units The default
is 5 units
:param style: (Q) This flag is obsolete and should not be used
:param toggle: (Q) Turns the ground plane display off in all windows, including
orthographic windows Default is true
:returns:
"""
pass
def ToggleCapsLockDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetDirectionBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteTextureReferenceObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeShowDirectoriesOnly(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def attachGeometryCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveInfluence(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectUVFrontFacingComponents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllNParticles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectLinesMask(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sculptMeshCacheCtx(*args, adjustSize: bool=True, adjustStrength: bool=True,
affectAllLayers: bool=True, brushDirection: Union[int, bool]=0,
brushSize: Union[float, bool]=0.0, brushStrength: Union[float, bool]=0.0,
buildUpRate: Union[float, bool]=0.0, cloneHideSource: bool=True,
cloneMethod: Union[int, bool]=0, cloneShapeSource: Union[AnyStr,
bool]="", cloneTargetSource: Union[AnyStr, bool]="", constrainToSurface:
bool=True, direction: Union[int, bool]=0, displayFrozen: bool=True,
displayMask: bool=True, displayWireframe: bool=True, falloffType:
Union[int, bool]=0, flood: float=0.0, floodFreeze: float=0.0, frame:
bool=True, freezeSelection: bool=True, grabFollowPath: bool=True,
grabSilhouette: bool=True, grabTwist: bool=True, inverted: bool=True,
lastMode: Union[AnyStr, bool]="", lockShellBorder: bool=True,
makeStroke: Union[List[int, int, int, float, float], List[List[int, int,
int, float, float]]]=None, minSize: Union[float, bool]=0.0, minStrength:
Union[float, bool]=0.0, mirror: Union[int, bool]=0, mode: Union[AnyStr,
bool]="", orientToSurface: bool=True, recordStroke: bool=True,
sculptFalloffCurve: Union[AnyStr, bool]="", size: Union[float, bool]=0.0,
stampDistance: Union[float, bool]=0.0, stampFile: Union[AnyStr, bool]="",
stampFlipX: bool=True, stampFlipY: bool=True, stampOrientToStroke:
bool=True, stampPlacement: Union[int, bool]=0, stampRandomization:
bool=True, stampRandomizationSeed: int=0, stampRandomizeFlipX: bool=True,
stampRandomizeFlipY: bool=True, stampRandomizePosX: Union[float,
bool]=0.0, stampRandomizePosY: Union[float, bool]=0.0,
stampRandomizeRotation: Union[float, bool]=0.0, stampRandomizeScale:
Union[float, bool]=0.0, stampRandomizeStrength: Union[float, bool]=0.0,
stampRotation: Union[float, bool]=0.0, steadyStrokeDistance: Union[float,
bool]=0.0, strength: Union[float, bool]=0.0, updatePlane: bool=True,
useGlobalSize: bool=True, useScreenSpace: bool=True, useStampDistance:
bool=True, useStampImage: bool=True, useSteadyStroke: bool=True,
wholeStroke: bool=True, wireframeAlpha: Union[float, bool]=0.0,
wireframeColor: Union[List[float, float, float], bool]=None, q=True,
query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This is a tool context command for mesh cache sculpting tool
:param adjustSize: (E) If true, puts the tool into the mode where dragging the mouse will
edit the brush size If false, puts the tool back into the previous sculpt mode
:param adjustStrength: (E) If true, puts the tool into the mode where dragging the mouse
will edit the brush strength If false, puts the tool back into the previous sculpt mod
:param affectAllLayers: (C Q E) If true, the brush affects all layers at once
:param brushDirection: (Q E) Specifies the direction of the named brush
:param brushSize: (Q E) Specifies the world-space size of the named brush
:param brushStrength: (Q E) Specifies the world-space strength of the named brush
:param buildUpRate: (Q E) Specifies the brush strength increasing along the stroke
:param cloneHideSource: (C Q E) True if the cloned source should be hidden
:param cloneMethod: (C Q E) Controls how the source delta vectors should change the target
0=copy 1=add
:param cloneShapeSource: (C Q E) Name of the shape source to clone
:param cloneTargetSource: (C Q E) Name of the target source of the clone
:param constrainToSurface: (C Q E) If true, the modification keeps the surface curvature
:param direction: (Q E) Specifies the direction in which the vertices are moved
:param displayFrozen: (C Q E) If false, turns off the display of frozen area on the object
:param displayMask: (C Q E) If false, turns off the display of masked area on the object
:param displayWireframe: (C Q E) If false, turns off the wireframe display of the object
:param falloffType: (Q E) Specifies how the brush determines which vertices to affect
:param flood: (C E) Sets the brush effect for each vertex to the given value
:param floodFreeze: (C E) Sets the freeze value for each vertex to the given value
:param frame: (C E) Frames on the sculpted area
:param freezeSelection: (C E) Freezes selected components
:param grabFollowPath: (C Q E) If true, the grab brush effect follows mouse movement
:param grabSilhouette: (C Q E) If true, the grab brush uses paint-through mode
:param grabTwist: (C Q E) If true, the grab brush twists the vertices
:param inverted: (C Q E) If true, inverts the effect of the brush
:param lastMode: (Q E) Specifies the type of the last active sculpting brush
:param lockShellBorder: (C Q E) Lock the shell borders so that they won't be moved by a UV
texture brush
:param makeStroke: (E M) Specify a surface point patch for a brush stroke Multiple patches
can be specified to form a brush stroke The first argument is the mesh index The
:param minSize: (Q E) Specifies the minimum size percentage of the current brush
:param minStrength: (Q E) Specifies the minimum strength percentage of the current brush
:param mirror: (Q E) Specifies the mirror mode of the brush
:param mode: (Q E) Specifies the type of sculpting effect the brush will perform
:param orientToSurface: (C Q E) If true, aligns the brush display to the surface of the
mesh
:param recordStroke: (Q E) Set this flag to true to enable stroke recording that can be
later played back with the makeStroke flag
:param sculptFalloffCurve: (Q E) Specifies the falloff curve of sculpting effect the brush
will perform
:param size: (Q E) Specifies the world-space size of the current brush
:param stampDistance: (Q E) Specifies the stamping distance of the brush
:param stampFile: (Q E) Specifies an image file to use as stamp
:param stampFlipX: (C Q E) Specifies if the brush stamp is flipped on the X axis
:param stampFlipY: (C Q E) Specifies if the brush stamp is flipped on the Y axis
:param stampOrientToStroke: (C Q E) Specifies if the brush stamp is aligned to the stroke
direction
:param stampPlacement: (Q E) Specifies the placement mode of the stamp image
:param stampRandomization: (C Q E) Specifies if the brush stamp is randomized
:param stampRandomizationSeed: (E) Specifies the stamp randomization seed value Use a
value of 0 to generate a random seed value
:param stampRandomizeFlipX: (C Q E) Specifies if the brush stamp flipping is randomized on
the X axis
:param stampRandomizeFlipY: (C Q E) Specifies if the brush stamp flipping is randomized on
the Y axis
:param stampRandomizePosX: (Q E) Specifies the stamp X position value is randomized
:param stampRandomizePosY: (Q E) Specifies the stamp Y position value is randomized
:param stampRandomizeRotation: (Q E) Specifies the stamp rotation value is randomized
:param stampRandomizeScale: (Q E) Specifies the stamp scale value is randomized
:param stampRandomizeStrength: (Q E) Specifies the stamp strength value is randomized
:param stampRotation: (Q E) Specifies the rotation value of the stamp image
:param steadyStrokeDistance: (Q E) Specifies the distance for the steady stroke
:param strength: (Q E) Specifies the world-space strength of the current brush
:param updatePlane: (C Q E) Recalculates the underlying tool plane for each stamp in a
stroke
:param useGlobalSize: (C Q E) If true, all the brushes have a shared size property;
otherwise size is local
:param useScreenSpace: (C Q E) If true, the brush size is in screen space pixels
:param useStampDistance: (C Q E) Force the stamps to be spread out along the stroke, rather
than building up continually
:param useStampImage: (C Q E) Specifies if the brush uses a stamp image
:param useSteadyStroke: (C Q E) Turns using steady stroke on/off
:param wholeStroke: (C Q E) Continuously recalculates the underlying tool plane from all
the vertices affected during the stroke
:param wireframeAlpha: (C Q E) Sets the alpha value of the wireframe for the object that is
being sculpted
:param wireframeColor: (C Q E) Sets the color of the wireframe for the object that is being
sculpted Values should be 0-1 RGB
:returns:
"""
pass
def subgraph(*args, **kwargs)->None:
"""
"""
pass
def SymmetrizeUV(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBifrostKillplane(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectedAnimLayer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SnapPointToPoint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SmoothPolygonOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateSoftBodyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UIModeMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideWrapInfluences(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtendFluid(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PlaybackForward(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hikCustomRigToolWidget(*args, **kwargs)->None:
"""
"""
pass
def TimeEditorClipTrimEnd(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def iconTextCheckBox(*args, align: Union[AnyStr, bool]="", annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None,
changeCommand: Union[Script, bool]=None, defineTemplate: AnyStr="",
disabledImage: Union[AnyStr, bool]="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists:
bool=True, flat: bool=True, flipX: bool=True, flipY: bool=True, font:
Union[AnyStr, bool]="", fullPathName: bool=True, height: Union[int,
bool]=0, highlightColor: Union[List[float, float, float], bool]=None,
highlightImage: Union[AnyStr, bool]="", image: Union[AnyStr, bool]="",
image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", imageOverlayLabel: Union[AnyStr, bool]="",
isObscured: bool=True, label: Union[AnyStr, bool]="", labelOffset:
Union[int, bool]=0, ltVersion: Union[AnyStr, bool]="", manage: bool=True,
marginHeight: Union[int, bool]=0, marginWidth: Union[int, bool]=0,
noBackground: bool=True, numberOfPopupMenus: bool=True, offCommand:
Union[Script, bool]=None, onCommand: Union[Script, bool]=None,
overlayLabelBackColor: Union[List[float, float, float, float], bool]=None,
overlayLabelColor: Union[List[float, float, float], bool]=None, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, rotation: Union[float, bool]=0.0, selectionHighlightImage:
Union[AnyStr, bool]="", selectionImage: Union[AnyStr, bool]="",
statusBarMessage: AnyStr="", style: Union[AnyStr, bool]="", useAlpha:
bool=True, useTemplate: AnyStr="", value: bool=True, version: Union[AnyStr,
bool]="", visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This control supports up to 3 icon images and 4 different display styles The icon image
displayed is the one that best fits the current size of the control given its current style
This command creates an iconTextCheckBox
:param align: (C Q E) The label alignment Alignment values are "left", "right", and
"center" By default, the label is aligned "center" Currently only available when -st
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C Q E) Command executed when the control's state is changed Note
that this flag should not be used in conjunction with onCommand and offCommand That is, o
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param disabledImage: (C Q E) Image used when the button is disabled Image size must be
the same as the image specified with the i/image flag This is a Windows only flag
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param flat: (C Q E) Sets whether the control will be a flat button (0 false, 1 true)
:param flipX: (C Q E) Is the image flipped horizontally?
:param flipY: (C Q E) Is the image flipped vertically?
:param font: (C Q E) The font for the text Valid values are "boldLabelFont",
"smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont",
"oblique
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param highlightImage: (C Q E) Highlight image displayed while the cursor is over the
control Image size must be the same as the image specified with the -i/image flag This is
a
:param image: (C Q E) If you are not providing images with different sizes then you may use
this flag for the control's image If the "iconOnly" style is set, the icon wil
:param image1: (C Q E) First of three possible icons The icon that best fits the current
size of the control will be displayed
:param image2: (C Q E) Second of three possible icons The icon that best fits the current
size of the control will be displayed
:param image3: (C Q E) Third of three possible icons The icon that best fits the current
size of the control will be displayed
:param imageOverlayLabel: (C Q E) A short string, up to 6 characters, representing a label
that will be displayed on top of the image
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) The text that appears in the control
:param labelOffset: (C Q E) The label offset Default is 0 Currently only available when
-st/style is set to "iconAndTextCentered"
:param ltVersion: (C Q E) This flag is used to specify the Maya LT version that this
control feature was introduced, if the version flag is not specified, or if the version fl
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param marginHeight: (C Q E) The number of pixels above and below the control content The
default value is 1 pixel
:param marginWidth: (C Q E) The number of pixels on either side of the control content The
default value is 1 pixel
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param offCommand: (C Q E) Command executed when the control is turned off
:param onCommand: (C Q E) Command executed when the control is turned on
:param overlayLabelBackColor: (C Q E) The RGBA color of the shadow behind the label defined
by imageOverlayLabel Default is 50% transparent black: 0 0 0 .5
:param overlayLabelColor: (C Q E) The RGB color of the label defined by imageOverlayLabel
Default is a light grey: .8 .8 .8
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rotation: (C Q E) The rotation value of the image in radians
:param selectionHighlightImage: (C Q E) Image displayed while the control is selected and
the cursor is over the control Image size must be the same as the image specified with the
-i/imag
:param selectionImage: (C Q E) Image displayed while the control is selected Image size
must be the same as the image specified with the -i/image flag This is a Windows only
flag
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param style: (C Q E) The draw style of the control Valid styles are "iconOnly",
"textOnly", "iconAndTextHorizontal", "iconAndTextVertical", and "iconAndTextCentered" (N
:param useAlpha: (C Q E) Is the image using alpha channel?
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Sets or returns the state of the control
:param version: (C Q E) Specify the version that this control feature was introduced The
argument should be given as a string of the version number (e.g "2013", "2014") C
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def MatchPivots(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyColorSet(*args, allColorSets: bool=True, clamped: bool=True, colorSet: Union[AnyStr,
bool]="", copy: bool=True, create: bool=True, currentColorSet: bool=True,
currentPerInstanceSet: bool=True, delete: bool=True, newColorSet: Union[AnyStr,
bool]="", perInstance: bool=True, rename: bool=True, representation:
Union[AnyStr, bool]="", shareInstances: bool=True, unshared: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[bool, Any]:
"""
Command to do the following to color sets: - delete an existing color set - rename an
existing color set - create a new empty color set - set the current color set to a
pre-existing color set - modify sharing between instances of per-instance color sets -
query the current color set - query the names of all color sets - query the name(s) alon
:param allColorSets: (C Q E) This flag when used in a query will return a list of all of
the color set names
:param clamped: (C Q E) This flag specifies if the color set will truncate any value that
is outside 0 to 1 range
:param colorSet: (C Q E) Specifies the name of the color set that this command needs to
work on This flag has to be specified for this command to do anything meaningful othe
:param copy: (C Q E) This flag when used will result in the copying of the color set
corresponding to name specified with the colorSet flag to the colorSet corresponding
:param create: (C Q E) This flag when used will result in the creation of an empty color
set corresponding to the name specified with the colorSet flag If a color set with
:param currentColorSet: (C Q E) This flag when used will set the current color set that the
object needs to work on, to be the color set corresponding to the name specified with the
:param currentPerInstanceSet: (Q E) This is a query-only flag for use when the current
color set is a per-instance color set family This returns the member of the set family
that corre
:param delete: (C Q E) This flag when used will result in the deletion of the color set
corresponding to the name specified with the colorSet flag
:param newColorSet: (C Q E) Specifies the name that the color set corresponding to the name
specified with the colorSet flag, needs to be renamed to
:param perInstance: (C Q E) This flag can be used in conjunction with the create flag to
indicate whether or not the color set is per-instance When you create a per-instance co
:param rename: (C Q E) This flag when used will result in the renaming of the color set
corresponding to the name specified with the colorSet flag to the name specified usi
:param representation: (C Q E) This flag corresponds to the color channels to used, for
example A(alpha only), RGB, and RGBA
:param shareInstances: (C Q E) This flag is used to modify the sharing of per-instance
color sets within a given color set family so that all selected instances share the
specified
:param unshared: (C Q E) This flag can be used in conjunction with the create and
perInstance flags to indicate that the newly created per-instance set should be created
with
:returns: Success or Failure.
"""
pass
def SetIKFKKeyframe(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def falloffCurveAttr(*args, addControlVertex: AnyStr="", annotation: Union[AnyStr, bool]="",
asString: Union[AnyStr, bool]="", attribute: name=None, backgroundColor:
Union[List[float, float, float], bool]=None, changeCommand: Script=None,
currentKey: Union[int, bool]=0, currentKeyValue: Union[List[float, float],
bool]=None, customCurveWidget: Union[int, bool]=0, defineTemplate:
AnyStr="", deleteControlVertex: int=0, docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists:
bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, manage: bool=True, noBackground: bool=True, numberOfPopupMenus:
bool=True, parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, readOnly: Union[int, bool]=0,
selectedPositionControl: AnyStr="", selectedValueControl: AnyStr="",
snapToGrid: Union[int, bool]=0, statusBarMessage: AnyStr="", useTemplate:
AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a control for editing a 2D control curve This control attaches to a
curve attribute, which must be a multi attribute where each entry is a compound composed
of: A single float for control point position A single float for control point value The
MEL command AEaddCurveControl should be used to attach this control to an attrib
:param addControlVertex: (E) Used to add a control vertex for the curve
:param annotation: (C Q E) Annotate the control with an extra string value
:param asString: (Q E) Used to query and set the value of the curve as a string of comma
separated values
:param attribute: (C) Specifies the name of the curve attribute to control
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (E) Specifies a command to be executed whenever the value of this
curve is modified
:param currentKey: (C Q E) Returns the index of the currently selected key
:param currentKeyValue: (Q E) Get or set the value of the currently selected key
:param customCurveWidget: (C Q E) Determines whether or not the curve widget is using a
custom curve When a custom curve is used, it is stored by a falloff curve in the brush
tool se
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param deleteControlVertex: (E) Used to delete a control vertex of the curve
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param readOnly: (C Q E) Specifies if the curve is read only or not If true, the curve
can't be edited
:param selectedPositionControl: (C E) Specifies the name of a float slider to edit the
selected key position
:param selectedValueControl: (C E) Specifies the name of a float slider to edit the
selected key value
:param snapToGrid: (C Q E) Specifies whether or not curve control points snap to grid when
they are being moved
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the port created or modified
"""
pass
def DeltaMushOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def reverseCurve(*args, caching: bool=True, nodeState: Union[int, bool]=0, constructionHistory:
bool=True, curveOnSurface: bool=True, name: AnyStr="", object: bool=True,
range: bool=True, replaceOriginal: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The reverseCurve command reverses the direction of a curve or curve-on-surface A string is
returned containing the pathname of the newly reversed curve and the name of the resulting
dependency node The reversed curve has the same parameter range as the original curve
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param constructionHistory: (C) Turn the construction history on or off
:param curveOnSurface: (C) If possible, create 2D curve as a result
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param range: (C) Force a curve range on complete input curve
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: (object name and node name)
"""
pass
def ShowObjectGeometry(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PencilCurveTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DecrementFluidCenter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OpenCloseCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmSplineBaseDensityScaleChangeCmd(*args, **kwargs)->None:
"""
"""
pass
def pointOnCurve(*args, caching: bool=True, constructionHistory: bool=True, curvatureCenter:
bool=True, curvatureRadius: bool=True, nodeState: Union[int, bool]=0, normal:
bool=True, normalizedNormal: bool=True, normalizedTangent: bool=True,
parameter: Union[float, bool]=0.0, position: bool=True, tangent: bool=True,
turnOnPercentage: bool=False, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[float3], Any]:
"""
This command returns information for a point on a NURBS curve If no flag is specified, it
assumes p/position by default
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C) Turn the construction history on or off
:param curvatureCenter: (C) Returns the (x,y,z) center of curvature of the specified point
on the curve
:param curvatureRadius: (C) Returns the radius of curvature of the specified point on the
curve
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param normal: (C) Returns the (x,y,z) normal of the specified point on the curve
:param normalizedNormal: (C) Returns the (x,y,z) normalized normal of the specified point
on the curve
:param normalizedTangent: (C) Returns the (x,y,z) normalized tangent of the specified point
on the curve
:param parameter: (Q E) The parameter value on curve Default: 0.0
:param position: (C) Returns the (x,y,z) position of the specified point on the curve
:param tangent: (C) Returns the (x,y,z) tangent of the specified point on the curve
:param turnOnPercentage: (Q E) Whether the parameter is normalized (0,1) or not Default:
false
:returns: Vector query result
"""
pass
def CameraSetEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BreakShadowLinks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetPreferredAngle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def U3DBrushSizeOff(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ls(*args, absoluteName: bool=True, allPaths: bool=True, assemblies: bool=True, cameras:
bool=True, containerType: Union[AnyStr, List[AnyStr]]="", containers: bool=True,
dagObjects: bool=True, defaultNodes: bool=True, dependencyNodes: bool=True, exactType:
Union[AnyStr, List[AnyStr]]="", excludeType: Union[AnyStr, List[AnyStr]]="", flatten:
bool=True, geometry: bool=True, ghost: bool=True, head: int=0, hilite: bool=True,
intermediateObjects: bool=True, invisible: bool=True, leaf: bool=True, lights: bool=True,
live: bool=True, lockedNodes: bool=True, long: bool=True, materials: bool=True,
modified: bool=True, noIntermediate: bool=True, nodeTypes: bool=True, objectsOnly:
bool=True, orderedSelection: bool=True, partitions: bool=True, persistentNodes:
bool=True, planes: bool=True, preSelectHilite: bool=True, readOnly: bool=True,
recursive: bool=True, referencedNodes: bool=True, references: bool=True, renderGlobals:
bool=True, renderQualities: bool=True, renderResolutions: bool=True, renderSetups:
bool=True, selection: bool=True, sets: bool=True, shapes: bool=True, shortNames:
bool=True, showNamespace: bool=True, showType: bool=True, tail: int=0, templated:
bool=True, textures: bool=True, transforms: bool=True, type: Union[AnyStr,
List[AnyStr]]="", undeletable: bool=True, untemplated: bool=True, uuid: bool=True,
visible: bool=True, **kwargs)->List[AnyStr]:
"""
The ls command returns the names (and optionally the type names) of objects in the scene
The most common use of ls is to filter or match objects based on their name (using
wildcards) or based on their type By default ls will match any object in the scene but it
can also be used to filter or list the selected objects when used in conjunction with
:param absoluteName: (C) This flag can be used in conjunction with the showNamespace flag
to specify that the namespace(s) returned by the command be in absolute namespace fo
:param allPaths: (C) List all paths to nodes in DAG This flag only works if -dag is also
specified or if an object name is supplied
:param assemblies: (C) List top level transform Dag objects
:param cameras: (C) List camera shapes
:param containerType: (C M) List containers with the specified user-defined type This flag
cannot be used in conjunction with the type or exactType flag
:param containers: (C) List containers Includes both standard containers as well as other
types of containers such as dagContainers
:param dagObjects: (C) List Dag objects of any type If object name arguments are passed to
the command then this flag will list all Dag objects below the specified object(
:param defaultNodes: (C) Returns default nodes A default node is one that Maya creates
automatically and does not get saved out with the scene, although some of its attribut
:param dependencyNodes: (C) List dependency nodes (including Dag objects)
:param exactType: (C M) List all objects of the specified type, but not objects that are
descendents of that type This flag can appear multiple times on the command line N
:param excludeType: (C M) List all objects that are not of the specified type This flag
can appear multiple times on the command line Note: the type passed to this flag is t
:param flatten: (C) Flattens the returned list of objects so that each component is
identified individually
:param geometry: (C) List geometric Dag objects
:param ghost: (C) List ghosting objects
:param head: (C) This flag specifies the maximum number of elements to be returned from the
beginning of the list of items Note: each type flag will return at most t
:param hilite: (C) List objects that are currently hilited for component selection
:param intermediateObjects: (C) List only intermediate dag nodes
:param invisible: (C) List only invisible dag nodes
:param leaf: (C) List all leaf nodes in Dag This flag is a modifier and must be used in
conjunction with the -dag flag
:param lights: (C) List light shapes
:param live: (C) List objects that are currently live
:param lockedNodes: (C) Returns locked nodes, which cannot be deleted or renamed However,
their status may change
:param long: (C) Return full path names for Dag objects By default the shortest unique
name is returned
:param materials: (C) List materials or shading groups
:param modified: (C) When this flag is set, only nodes modified since the last save will be
returned
:param noIntermediate: (C) List only non intermediate dag nodes
:param nodeTypes: (C) Lists all registered node types
:param objectsOnly: (C) When this flag is set only object names will be returned and
components/attributes will be ignored
:param orderedSelection: (C) List objects and components that are currently selected in
their order of selection This flag depends on the value of the -tso/trackSelectionOrder f
:param partitions: (C) List partitions
:param persistentNodes: (C) Returns persistent nodes, which are nodes that stay in the Maya
session after a file > new These are a special class of default nodes that do not ge
:param planes: (C) List construction plane shapes
:param preSelectHilite: (C) List components that are currently hilited for pre-selection
:param readOnly: (C) Returns referenced nodes Referenced nodes are read only NOTE:
Obsolete Please use "-referencedNodes"
:param recursive: (C) When set to true, this command will look for name matches in all
namespaces When set to false, this command will only look for matches in namespaces
:param referencedNodes: (C) Returns referenced nodes Referenced nodes are read only
:param references: (C) List references associated with files Excludes special reference
nodes such as the sharedReferenceNode and unknown reference nodes
:param renderGlobals: (C) List render globals
:param renderQualities: (C) List named render qualities
:param renderResolutions: (C) List render resolutions
:param renderSetups: (C) Alias for -renderGlobals
:param selection: (C) List objects that are currently selected
:param sets: (C) List sets
:param shapes: (C) List shape objects
:param shortNames: (C) Return short attribute names By default long attribute names are
returned
:param showNamespace: (C) Show the namespace of each object after the object name This
flag cannot be used in conjunction with the showType flag
:param showType: (C) List the type of each object after its name
:param tail: (C) This flag specifies the maximum number of elements to be returned from the
end of the list of items Note: each type flag will return at most this ma
:param templated: (C) List only templated dag nodes
:param textures: (C) List textures
:param transforms: (C) List transform objects
:param type: (C M) List all objects of the specified type This flag can appear multiple
times on the command line Note: the type passed to this flag is the same type
:param undeletable: (C) Returns nodes that cannot be deleted (which includes locked nodes)
These nodes also cannot be renamed
:param untemplated: (C) List only un-templated dag nodes
:param uuid: (C) Return node UUIDs instead of names Note that there are no "UUID paths" -
combining this flag with e.g the -long flag will not result in a path form
:param visible: (C) List only visible dag nodes
:returns: Command result
"""
pass
def symmetricModelling(*args, about: Union[AnyStr, bool]="", allowPartial: bool=True, axis:
Union[AnyStr, bool]="", preserveSeam: Union[int, bool]=0, reset:
bool=True, seamFalloffCurve: Union[AnyStr, bool]="", seamTolerance:
Union[float, bool]=0.0, symmetry: Union[int, bool]=0, tolerance:
Union[float, bool]=0.0, topoSymmetry: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This command allows you to change the symmetric modelling options Symmetric modelling is
an option that allows for reflection of basic manipulator actions such as move, rotate, and
scale
:param about: (C Q E) Set the space in which symmetry should be calculated (object or world
or topo) When queried, returns a string which is the current space being used
:param allowPartial: (C Q E) Specifies whether partial symmetry should be allowed when
enabling topological symmetry
:param axis: (C Q E) Set the current axis to be reflected over When queried, returns a
string which is the current axis
:param preserveSeam: (C Q E) Controls whether selection or symmetry should take priority on
the plane of symmetry When queried, returns an int for the option
:param reset: (C E) Reset the redo information before starting
:param seamFalloffCurve: (C Q E) Set the seam's falloff curve, used to control the seam
strength within the seam tolerance The string is a comma separated list of sets of 3
values f
:param seamTolerance: (C Q E) Set the seam tolerance used for reflection When preserveSeam
is enabled, this tolerance controls the width of the enforced seam When queried, retur
:param symmetry: (C Q E) Set the symmetry option on or off When queried, returns an int
for the option
:param tolerance: (C Q E) Set the tolerance of reflection When queried, returns a float of
the tolerance
:param topoSymmetry: (C Q E) Enable/disable topological symmetry When enabled, the
supplied component/active list will be used to define the topological symmetry seam When
quer
:returns:
"""
pass
def SetShrinkWrapInnerObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorClipLoopToggle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def editor(*args, control: bool=True, defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
exists: bool=True, filter: Union[AnyStr, bool]="", forceMainConnection: Union[AnyStr,
bool]="", highlightConnection: Union[AnyStr, bool]="", lockMainConnection: bool=True,
mainListConnection: Union[AnyStr, bool]="", panel: Union[AnyStr, bool]="", parent:
Union[AnyStr, bool]="", selectionConnection: Union[AnyStr, bool]="", stateString:
bool=True, unParent: bool=True, unlockMainConnection: bool=True,
updateMainConnection: bool=True, useTemplate: AnyStr="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Edit the characteristic of an editor
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: Name of the editor
"""
pass
def RenderSetupWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def spring(*args, addSprings: bool=True, allPoints: bool=False, count: bool=True, damping:
Union[float, bool]=0.2, dampingPS: Union[float, bool]=0.2, endForceWeight:
Union[float, bool]=1.0, exclusive: bool=False, length: Union[float, bool]=0.0,
maxDistance: float=0.0, minDistance: float=0.0, minMax: bool=False, name:
Union[AnyStr, bool]="", noDuplicate: bool=False, restLength: Union[float, bool]=0.0,
restLengthPS: Union[float, bool]=0.0, startForceWeight: Union[float, bool]=1.0,
stiffness: Union[float, bool]=1.0, stiffnessPS: Union[float, bool]=1.0,
useDampingPS: bool=False, useRestLengthPS: bool=False, useStiffnessPS: bool=False,
walkLength: int=0, wireframe: bool=False, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
The spring command can do any of the following: * create a new spring object (shape plus
transform) The shape contains springs between the points (particles, cvs, etc.) of the
objects selected or listed on the command line. * create new springs and add them to an
existing spring object * edit or query certain attributes of an existing spring objec
:param addSprings: (C) If specified, springs will be added to the existing selected set of
springs (Default is to create a new spring object.)
:param allPoints: (C E) If True, sets the mode of spring application to All This will add
springs between all points selected (Default is False.)
:param count: (Q) Return the number of springs in the shape Query-only We maintain this
flag only for compatibility with earlier versions of Maya To get the count o
:param damping: (C Q E) Damping factor for the springs created in the spring object
(Default = 0.2 )
:param dampingPS: (C Q E) Damping factor for the springs created in the spring object This
will initialize all the entries in dampingPS to the specified value In both the fl
:param endForceWeight: (C Q E) Amount of the force of the spring that gets applied to the
point to which the spring ends Valid range is from 0.0 to 1.0 (Default = 1.0 )
:param exclusive: (C) If true, tells the command to create springs only between pairs of
points which are not in the same object (Default is False.)
:param length: (C Q E) Vestigial form of "restLength." Please use "restLength" instead
:param maxDistance: (C E) Maximum distance between two points that a spring would be
considered
:param minDistance: (C) Minimum distance between two points that a spring would be
considered (Default = 0.0 See Defaults for more information on this flag's default.)
:param minMax: (C) If True, sets the mode of the spring application to Min/Max This will
add springs between all points from the specified point groups that are betwee
:param name: (C Q) Name of spring object
:param noDuplicate: (C) Check for existing springs and don't add a new spring between two
points already connected by a spring in the same object Only the object the comman
:param restLength: (C Q E) Per-object rest length for the new springs Springs can use
either their per-object or per-spring rest length See the -lPS and -ulp flags
:param restLengthPS: (C Q E) Per-spring rest length for the new springs This will
initialize all the entries in restLengthPS to the specified value If this flag is not
thrown,
:param startForceWeight: (C Q E) Amount of the force of the spring that gets applied to the
point from which the spring starts Valid range is from 0.0 to 1.0 (Default = 1.0 )
:param stiffness: (C Q E) Stiffness of the springs created in the spring object (Default =
1.0 ) -damp float Vestigial form of "damping." Please use "damping" instead
:param stiffnessPS: (C Q E) Stiffness of the springs created in the spring object This
will initialize all the entries in stiffnessPS to the specified value In both the flag a
:param useDampingPS: (C Q E) Specifies whether to use dampingPS (per spring damping) If
set to false, the per object damping attribute value will be used This flag simply sets
:param useRestLengthPS: (C Q E) Specifies whether to use restLengthPS (per spring
restLength) If set to false, the per object restLength attribute value will be used This
flag sim
:param useStiffnessPS: (C Q E) Specifies whether to use stiffnessPS (per spring stiffness)
If set to false, the per object stiffness attribute value will be used This flag simply
:param walkLength: (C) This flag is valid only when doing wireframe creation It will
create springs between pairs of points connected by the specified number of edges For
:param wireframe: (C) If True, sets the mode of the spring application to Wireframe This
is valid only for springs created on a soft body It will add springs along all e
:returns: Command result
"""
pass
def transformCompare(*args, root: bool=True, **kwargs)->int:
"""
Compares two transforms passed as arguments If they are the same, returns 0 If they are
different, returns 1 If no transforms are specified in the command line, then the
transforms from the active list are used
:param root: (C) Compare the root only, rather than the entire hierarchy below the roots
:returns: 0 if successful, 1 if transform1 and transform2 are not determined to be equal.
"""
pass
def InteractiveSplitToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PreviousManipulatorHandle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CopyKeys(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshRepeatToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySplit(*args, adjustEdgeFlow: Union[float, bool]=0.0, detachEdges: bool=True, edgepoint:
Union[List[int, float], List[List[int, float]]]=None, facepoint: Union[List[int,
float, float, float], List[List[int, float, float, float]]]=None,
insertWithEdgeFlow: bool=True, insertpoint: Union[List[int, float, float, float],
List[List[int, float, float, float]]]=None, projectedCurve: Union[name,
List[name]]=None, projectedCurveTolerance: float=0.0, smoothingangle: float=0.0,
subdivision: Union[int, bool]=1, constructionHistory: bool=True, name: AnyStr="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Split facets/edges of a polygonal object The first and last arguments must be edges
Intermediate points may lie on either a shared face or an edge which neighbors the previous
point
:param adjustEdgeFlow: (C Q E) The weight value of the edge vertices to be positioned
:param detachEdges: (C) Value of the detachEdges attribute for the resulting poly split
node
:param edgepoint: (C M) The given edge is split into two new edges by inserting a new
vertex located the given percentage along the edge Note: This flag is not recommended
:param facepoint: (C M) A new vertex is inserted, lying at the given coordinates inside the
given face Coordinates are given in the local object space Note: This flag is n
:param insertWithEdgeFlow: (C Q E) True to enable edge flow Otherwise, the edge flow is
disabled
:param insertpoint: (C M) This flag allows the caller to insert a new vertex into an edge
or a face To insert a new vertex in an edge, pass the index of the edge and a percen
:param projectedCurve: (C M) Curves to be projected
:param projectedCurveTolerance: (C) Tolerance for curve projection
:param smoothingangle: (C) Subdivide new edges will be soft if less then this angle C:
Default is 0.0
:param subdivision: (C Q E) Subdivide new edges into the given number of sections Edges
involving free points won't be subdivided C: Default is 1 (no subdivision) Q: When que
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:returns: The node name.
"""
pass
def SetFluidAttrFromCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MoveRotateScaleToolToggleSnapRelativeMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CurveEditTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def keyframeRegionDollyCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create a dolly context for the dope sheet editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Context name
"""
pass
def BrushPresetBlendShapeOff(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyColorBlindData(*args, aboveMaxColorBlue: Union[float, List[float]]=0.0,
aboveMaxColorGreen: Union[float, List[float]]=0.0, aboveMaxColorRed:
Union[float, List[float]]=0.0, attrName: Union[AnyStr, List[AnyStr]]="",
belowMinColorBlue: Union[float, List[float]]=0.0, belowMinColorGreen:
Union[float, List[float]]=0.0, belowMinColorRed: Union[float,
List[float]]=0.0, clashColorBlue: float=0.0, clashColorGreen: float=0.0,
clashColorRed: float=0.0, colorBlue: Union[float, List[float]]=0.0,
colorGreen: Union[float, List[float]]=0.0, colorRed: Union[float,
List[float]]=0.0, dataType: Union[AnyStr, List[AnyStr]]="",
enableFalseColor: bool=True, maxColorBlue: Union[float, List[float]]=0.0,
maxColorGreen: Union[float, List[float]]=0.0, maxColorRed: Union[float,
List[float]]=0.0, maxValue: Union[float, List[float]]=0.0, minColorBlue:
Union[float, List[float]]=0.0, minColorGreen: Union[float,
List[float]]=0.0, minColorRed: Union[float, List[float]]=0.0, minValue:
Union[float, List[float]]=0.0, mode: Union[int, List[int]]=0,
noColorBlue: float=0.0, noColorGreen: float=0.0, noColorRed: float=0.0,
numIdTypes: Union[int, List[int]]=0, queryMode: bool=True, typeId:
Union[int, List[int]]=0, useMax: Union[bool, List[bool]]=True, useMin:
Union[bool, List[bool]]=True, value: Union[AnyStr, List[AnyStr]]="",
**kwargs)->List[AnyStr]:
"""
This command applies false color to the selected polygonal components and objects,
depending on whether or not blind data exists for the selected components (or, in the case
of poly objects, dynamic attributes), and, depending on the color mode indicated, what the
values are It is possible to color objects based on whether or not the data exists,
:param aboveMaxColorBlue: (C M) Specifies blue component of color to use for data that is
above max
:param aboveMaxColorGreen: (C M) Specifies green component of color to use for data that is
above max
:param aboveMaxColorRed: (C M) Specifies red component of color to use for data that is
above max
:param attrName: (C M) Specifies the name of the data that is being examined by this
command
:param belowMinColorBlue: (C M) Specifies blue component of color to use for data that is
below min
:param belowMinColorGreen: (C M) Specifies green component of color to use for data that is
below min
:param belowMinColorRed: (C M) Specifies red component of color to use for data that is
below min
:param clashColorBlue: (C) Specifies blue component color to use for data which clashes
:param clashColorGreen: (C) Specifies green component color to use for data which clashes
:param clashColorRed: (C) Specifies red component color to use for data which clashes
:param colorBlue: (C M) Specifies blue component of color to use for given data
:param colorGreen: (C M) Specifies green component of color to use for given data
:param colorRed: (C M) Specifies red component of color to use for given data
:param dataType: (C M) Specifies the type for this id
:param enableFalseColor: (C) Turns false coloring on or off for all poly objects in the
scene
:param maxColorBlue: (C M) Specifies blue component of color to use for max value for
grayscale
:param maxColorGreen: (C M) Specifies green component of color to use for max value for
grayscale
:param maxColorRed: (C M) Specifies red component of color to use for max value for
grayscale
:param maxValue: (C M) Specifies the max value for grayscale or discrete range data
:param minColorBlue: (C M) Specifies blue component of color to use for min value for
grayscale
:param minColorGreen: (C M) Specifies green component of color to use for min value for
grayscale
:param minColorRed: (C M) Specifies red component of color to use for min value for
grayscale
:param minValue: (C M) Specifies the min value for grayscale or discrete range data
:param mode: (C M) Specifies the mode: 0 : binary - only components and objects that have
the data will be colored 1 : discrete value - a value is specified Data that
:param noColorBlue: (C) Specifies blue component of color to use for no data assigned
:param noColorGreen: (C) Specifies green component of color to use for no data assigned
:param noColorRed: (C) Specifies red component of color to use for no data assigned
:param numIdTypes: (C M) Specifies how many attrs are in this id type
:param queryMode: (C) If on, do not color and return selection as string array instead Any
data that would be colored normally (except for 'no color' and out of range col
:param typeId: (C M) Specifies the typeId of the BlindData type being created
:param useMax: (C M) Specifies whether the max should be used for discrete ranges
:param useMin: (C M) Specifies whether the min should be used for discrete ranges
:param value: (C M) The value of the data
:returns: Command result
"""
pass
def RelaxInitialState(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetKeyVertexColor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CancelBatchRender(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportColladaTriangulate(*args, **kwargs)->None:
"""
"""
pass
def dR_modeMulti(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeRevertSelectedSwatches(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_viewXrayTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_selConstraintOff(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExportSkinWeightMaps(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyMoveEdge(*args, caching: bool=True, constructionHistory: bool=True, gain: Union[float,
List[float], bool]=1.0, localCenter: Union[int, bool]=0, localDirection:
Union[List[float, float, float], bool]=None, localDirectionX: Union[float,
bool]=0.0, localDirectionY: Union[float, bool]=0.0, localDirectionZ:
Union[float, bool]=0.0, localRotate: Union[List[float, float, float],
bool]=None, localRotateX: Union[float, bool]=0.0, localRotateY: Union[float,
bool]=0.0, localRotateZ: Union[float, bool]=0.0, localScale: Union[List[float,
float, float], bool]=None, localScaleX: Union[float, bool]=0.0, localScaleY:
Union[float, bool]=0.0, localScaleZ: Union[float, bool]=0.0, localTranslate:
Union[List[float, float, float], bool]=None, localTranslateX: Union[float,
bool]=0.0, localTranslateY: Union[float, bool]=0.0, localTranslateZ:
Union[float, bool]=0.0, name: AnyStr="", nodeState: Union[int, bool]=0, pivot:
Union[List[float, float, float], bool]=None, pivotX: Union[float, bool]=0.0,
pivotY: Union[float, bool]=0.0, pivotZ: Union[float, bool]=0.0, random:
Union[float, bool]=0.0, rotate: Union[List[float, float, float], bool]=None,
rotateX: Union[float, bool]=0.0, rotateY: Union[float, bool]=0.0, rotateZ:
Union[float, bool]=0.0, scale: Union[List[float, float, float], bool]=None,
scaleX: Union[float, bool]=0.0, scaleY: Union[float, bool]=0.0, scaleZ:
Union[float, bool]=0.0, translate: Union[List[float, float, float], bool]=None,
translateX: Union[float, bool]=0.0, translateY: Union[float, bool]=0.0,
translateZ: Union[float, bool]=0.0, worldSpace: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Modifies edges of a polygonal object Translate, move, rotate or scale edges
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param gain: (C Q E M) Gain factor per component Can be painted using Artisan Default:
1.0
:param localCenter: (C Q E) Local center on the edge : 0=Middle point, 1=Start point, 2=End
point Default: 0
:param localDirection: (C Q E) Direction to determine X axis for local space Default: 1.0,
0.0, 0.0
:param localDirectionX: (C Q E) X coord of the X axis
:param localDirectionY: (C Q E) Y coord of the X axis
:param localDirectionZ: (C Q E) Z coord of the X axis
:param localRotate: (C Q E) The local rotations Default: 0.0, 0.0, 0.0
:param localRotateX: (C Q E) Local rotate X coord The range is [0, 360]
:param localRotateY: (C Q E) Local rotate Y coord The range is [0, 360]
:param localRotateZ: (C Q E) Local rotate Z coord : Rotation along the normal The range is
[0, 360]
:param localScale: (C Q E) Local Scale Default: 1.0, 1.0, 1.0
:param localScaleX: (C Q E) Scale X coord
:param localScaleY: (C Q E) Scale Y coord
:param localScaleZ: (C Q E) Scale Z coord
:param localTranslate: (C Q E) Local translate Default: 0.0, 0.0, 0.0
:param localTranslateX: (C Q E) Local translation X coord
:param localTranslateY: (C Q E) Local translation Y coord
:param localTranslateZ: (C Q E) Local translation Z coord : Move along the normal
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pivot: (C Q E) The pivot for scaling and rotation Default: 0.0, 0.0, 0.0
:param pivotX: (C Q E) Pivot X coord
:param pivotY: (C Q E) Pivot Y coord
:param pivotZ: (C Q E) Pivot Z coord
:param random: (C Q E) Random value for all parameters Default: 0.0
:param rotate: (C Q E) Rotation angles around X, Y, Z Default: 0.0, 0.0, 0.0
:param rotateX: (C Q E) Rotation angle around X
:param rotateY: (C Q E) Rotation angle around Y
:param rotateZ: (C Q E) Rotation angle around Z
:param scale: (C Q E) Scaling vector Default: 1.0, 1.0, 1.0
:param scaleX: (C Q E) Scale X coord
:param scaleY: (C Q E) Scale Y coord
:param scaleZ: (C Q E) Scale Z coord
:param translate: (C Q E) Translation vector Default: 0.0, 0.0, 0.0
:param translateX: (C Q E) Translation X coord
:param translateY: (C Q E) Translation Y coord
:param translateZ: (C Q E) Translation Z coord
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def lightList(*args, add: name=None, remove: name=None, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
Add/Remove a relationship between an object and the current light Soon to be replaced by
the connect-attribute command
:param add: (C) add object(s) to light list
:param remove: (C) remove object(s) to light list
:returns:
"""
pass
def distanceDimension(*args, endPoint: List[float, float, float]=None, startPoint: List[float,
float, float]=None, **kwargs)->AnyStr:
"""
This command is used to create a distance dimension to display the distance between two
specified points
:param endPoint: (C) Specifies the point to measure distance to, from the startPoint
:param startPoint: (C) Specifies the point to start measuring distance from
:returns: - the shape name of the DAG node created.
"""
pass
def CreateShrinkWrap(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshSmoothTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeGraphUpstream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgPreRendering(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ArtPaintSelectToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetAsCombinationTarget(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def makebot(*args, checkdepends: bool=True, checkres: int=0, input: AnyStr="", nooverwrite:
bool=True, output: AnyStr="", verbose: bool=True, **kwargs)->None:
"""
The makebot command takes an image file and produces a block ordered texture (BOT) file, to
be used for texture caching If a relative pathname is specified for the input image file,
project management rules apply If a relative pathname is specified for the output BOT file,
project management rules apply and gets put into the sourceImages director
:param checkdepends: (C) the BOT file should only be generated if it doesn't already exists,
or if it is older than the source file
:param checkres: (C) the BOT file should only be generated if its resolution (maximum of
width and height) is larger than the minimum value specified by the argument
:param input: (C) input image file
:param nooverwrite: (C) If -c and/or -r indicate that the BOT file should be generated but
if already exists, then this flag will prevent the file from being overwritten
:param output: (C) output BOT file
:param verbose: (C) Makebot will provide feedback if this flag is specified
:returns:
"""
pass
def RefineSelectedComponents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_targetWeldRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllDynamicConstraints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def resourceManager(*args, nameFilter: AnyStr="", saveAs: List[AnyStr, AnyStr]=None,
**kwargs)->None:
"""
List resources matching certain properties
:param nameFilter: (C) List only resources matching the name Argument may contain ? and *
characters
:param saveAs: (C) Saves a copy of the resource (first parameter) as a separate file
(second parameter)
:returns:
"""
pass
def FBXLoadExportPresetFile(*args, **kwargs)->None:
"""
"""
pass
def HypershadeDeleteAllUtilities(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddToCurrentSceneMotionBuilder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EnterEditMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AttachSubdivSurfaceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_setRelaxAffectsAuto(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artAttrTool(*args, exists: Union[AnyStr, bool]="", remove: AnyStr="", q=True, query=True,
**kwargs)->Union[None, Any]:
"""
The artAttrTool command manages the list of tool types which are used for attribute
painting This command supports querying the list contents as well as adding new tools to
the list Note that there is a set of built-in tools The list of built-ins can be queried
by starting Maya and doing an "artAttrTool -q" The tools which are managed by this
:param exists: (C Q) Checks if the named tool exists, returning true if found, and false
otherwise
:param remove: (C) Removes the named tool from the internal list of tools
:returns:
"""
pass
def PaintOperationMarkingMenuRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def emit(*args, attribute: Union[AnyStr, List[AnyStr]]="", floatValue: Union[float,
List[float]]=0.0, object: AnyStr="", position: Union[List[float, float, float],
List[List[float, float, float]]]=None, vectorValue: Union[List[float, float, float],
List[List[float, float, float]]]=None, **kwargs)->List[int]:
"""
The emit action allows users to add particles to an existing particle object without the
use of an emitter At the same time, it allows them to set any per-particle attribute for
the particles that are created with the action. The particles created do not become a part
of the initial state for the particle object, and will disappear when the scene
:param attribute: (C M) Specifies the attribute on the particle object that any value flags
following it and before the next -attribute flag will be associated with The sam
:param floatValue: (C M) Sets the float value to be used for the "current" attribute of the
"current" particle By current attribute, it is meant the attribute specified by t
:param object: (C) This flag takes the name of a particleShape or the transform directly
above it in the DAG as its parent It specifies which object to add the particl
:param position: (C M) Specifies the positions in the particle object's space (usually
world space) where the particles are to be created One particle is created for each
:param vectorValue: (C M) Sets the vector value to be used for the "current" attribute of
the "current" particle By current attribute, it is meant the attribute specified by
:returns: Integer array containing the list of the particleId attribute values
for the
created particles in the same order that the position flags
were passed.
"""
pass
def SmoothProxy(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def trim(*args, caching: bool=True, locatorU: Union[float, List[float], bool]=0.5, locatorV:
Union[float, List[float], bool]=0.5, nodeState: Union[int, bool]=0, selected:
Union[int, bool]=0, shrink: bool=False, tolerance: Union[float, bool]=0.001,
constructionHistory: bool=True, name: AnyStr="", object: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command trims a surface to its curves on surface by first splitting the surface and
then selecting which regions to keep or discard
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param locatorU: (C Q E M) u parameter value to position a locator on the surface Default:
0.5
:param locatorV: (C Q E M) v parameter value to position a locator on the surface Default:
0.5
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param selected: (C Q E) Specify whether to keep or discard selected regions Default: 0
:param shrink: (C Q E) If true, shrink underlying surface to outer boundaries of trimmed
surface Default: false
:param tolerance: (C Q E) The tolerance with which to trim Default: 0.001
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:returns: Object name and node name.
"""
pass
def loadModule(*args, allModules: bool=True, load: AnyStr="", scan: bool=True,
**kwargs)->List[AnyStr]:
"""
Maya plug-ins may be installed individually within one of Maya's standard plug-in
directories, or they may be packaged up with other resources in a "module" Each module
resides in its own directory and provides a module definition file to make Maya aware of
the plug-ins it provides When Maya starts up it loads all of the module files it finds,
ma
:param allModules: (C) Load all new modules not yet loaded in Maya New modules are the one
returned by the -scan option
:param load: (C) Load the module specified by the module definition file
:param scan: (C) Rescan module presence Returns the list of module definition files found
and not yet loaded into Maya Does not load any of these newly found module
:returns: Command result
"""
pass
def ExportDeformerWeights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def graphSelectContext(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create a selection context for the hypergraph editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:returns: Command result
"""
pass
def Create3DContainerEmitterOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MergeCharacterSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorGraphClearGraph(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyMapSewMove(*args, caching: bool=True, constructionHistory: bool=True, limitPieceSize:
bool=True, name: AnyStr="", nodeState: Union[int, bool]=0, numberFaces:
Union[int, bool]=0, uvSetName: AnyStr="", worldSpace: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command can be used to Move and Sew together separate UV pieces along geometric edges
UV pieces that correspond to the same geometric edge, are merged together by moving the
smaller piece to the larger one.
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param limitPieceSize: (C Q E) When on, this flag specifies that the face number limit
described above should be used
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param numberFaces: (C Q E) Maximum number of faces in a UV piece When trying to combine
two UV pieces into a single one, the merge operation is rejected if the smaller piece h
:param uvSetName: (C) Name of the UV set to be created
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def BrushPresetReplaceShading(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def viewClipPlane(*args, autoClipPlane: bool=True, farClipPlane: Union[float, bool]=0.0,
nearClipPlane: Union[float, bool]=0.0, surfacesOnly: bool=True, q=True,
query=True, **kwargs)->Union[None, Any]:
"""
The viewClipPlane command can be used to query or set a camera's clip planes If a camera
is not specified, the camera in the active view will be used The near and far clip plane
flags may be used in conjunction with the auto clip plane flag
:param autoClipPlane: (C Q) Compute the clip planes such that all object's in the camera's
viewing frustum will be visible
:param farClipPlane: (C Q) Set or query the far clip plane
:param nearClipPlane: (C Q) Set or query the near clip plane
:param surfacesOnly: (C) This flag is to be used in conjunction with the auto clip plane
flag Only the bounding boxes of surfaces will be used to compute the camera's clippi
:returns:
"""
pass
def ChamferVertexOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InsertKeysTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetKeyTranslate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateSoftBody(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeOpenUVEditorWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def iconTextButton(*args, align: Union[AnyStr, bool]="", annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, command:
Union[Script, bool]=None, commandRepeatable: bool=True, defineTemplate:
AnyStr="", disabledImage: Union[AnyStr, bool]="", docTag: Union[AnyStr,
bool]="", doubleClickCommand: Union[Script, bool]=None, dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, flat:
bool=True, flipX: bool=True, flipY: bool=True, font: Union[AnyStr, bool]="",
fullPathName: bool=True, handleNodeDropCallback: Script=None, height:
Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, highlightImage: Union[AnyStr, bool]="", image: Union[AnyStr,
bool]="", image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="",
image3: Union[AnyStr, bool]="", imageOverlayLabel: Union[AnyStr, bool]="",
isObscured: bool=True, label: Union[AnyStr, bool]="", labelEditingCallback:
Script=None, labelOffset: Union[int, bool]=0, ltVersion: Union[AnyStr,
bool]="", manage: bool=True, marginHeight: Union[int, bool]=0, marginWidth:
Union[int, bool]=0, noBackground: bool=True, numberOfPopupMenus: bool=True,
overlayLabelBackColor: Union[List[float, float, float, float], bool]=None,
overlayLabelColor: Union[List[float, float, float], bool]=None, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, rotation: Union[float, bool]=0.0, scaleIcon: bool=True,
selectionImage: Union[AnyStr, bool]="", sourceType: Union[AnyStr, bool]="",
statusBarMessage: AnyStr="", style: Union[AnyStr, bool]="", useAlpha:
bool=True, useTemplate: AnyStr="", version: Union[AnyStr, bool]="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This control supports up to 3 icon images and 4 different display styles The icon image
displayed is the one that best fits the current size of the control given its current style
This command creates an iconTextButton that can be displayed with different icons, with
or without accompanying text label When an argument is passed, it is used to g
:param align: (C Q E) The label alignment Alignment values are "left", "right", and
"center" By default, the label is aligned "center" Currently only available when -st
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param command: (C Q E) Command executed when the control is pressed
:param commandRepeatable: (C Q E) Set if the MEL command specified in the command flag
should be repeatable or not The "g" key, by default, is the shortcut to repeat the last
execute
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param disabledImage: (C Q E) Image used when the button is disabled Image size must be
the same as the image specified with the i/image flag This is a Windows only flag
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param doubleClickCommand: (C Q E) Command executed when the control is double clicked
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param flat: (C Q E) Sets whether the control will be a flat button (0 false, 1 true)
:param flipX: (C Q E) Is the image flipped horizontally?
:param flipY: (C Q E) Is the image flipped vertically?
:param font: (C Q E) The font for the text Valid values are "boldLabelFont",
"smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont",
"oblique
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param handleNodeDropCallback: (C E) Specify a script callback which is called when a node
is dropped on the control The name of the node being dropped will be passed to the
function (p
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param highlightImage: (C Q E) Highlight image displayed while the cursor is over the
control Image size must be the same as the image specified with the -i/image flag This is
a
:param image: (C Q E) If you are not providing images with different sizes then you may use
this flag for the control's image If the "iconOnly" style is set, the icon wil
:param image1: (C Q E) First of three possible icons The icon that best fits the current
size of the control will be displayed
:param image2: (C Q E) Second of three possible icons The icon that best fits the current
size of the control will be displayed
:param image3: (C Q E) Third of three possible icons The icon that best fits the current
size of the control will be displayed
:param imageOverlayLabel: (C Q E) A short string, up to 6 characters, representing a label
that will be displayed on top of the image
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) The text that appears in the control
:param labelEditingCallback: (C E) Specify a callback which is called after the user double
clicks the label of the control to give it a new label The new label string will be
passed
:param labelOffset: (C Q E) The label offset Default is 0 Currently only available when
-st/style is set to "iconAndTextCentered"
:param ltVersion: (C Q E) This flag is used to specify the Maya LT version that this
control feature was introduced, if the version flag is not specified, or if the version fl
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param marginHeight: (C Q E) The number of pixels above and below the control content The
default value is 1 pixel
:param marginWidth: (C Q E) The number of pixels on either side of the control content The
default value is 1 pixel
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param overlayLabelBackColor: (C Q E) The RGBA color of the shadow behind the label defined
by imageOverlayLabel Default is 50% transparent black: 0 0 0 .5
:param overlayLabelColor: (C Q E) The RGB color of the label defined by imageOverlayLabel
Default is a light grey: .8 .8 .8
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rotation: (C Q E) The rotation value of the image in radians
:param scaleIcon: (C E) For "textOnly" and "iconOnly" style, this flag has no effect For
other styles, if the flag is specified, the icon will be scaled to the size of the
:param selectionImage: (C Q E) Image displayed while the control is selected Image size
must be the same as the image specified with the -i/image flag This is a Windows only
flag
:param sourceType: (C Q E) Sets the language type for the command script Can only be used
in conjunction with the c/command or dcc/doubleClickCommand flags Valid values are "
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param style: (C Q E) The draw style of the control Valid styles are "iconOnly",
"textOnly", "iconAndTextHorizontal", "iconAndTextVertical", and "iconAndTextCentered" (N
:param useAlpha: (C Q E) Is the image using alpha channel?
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param version: (C Q E) Specify the version that this control feature was introduced The
argument should be given as a string of the version number (e.g "2013", "2014") C
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the iconTextButton.
"""
pass
def polyPlatonicSolid(*args, axis: Union[List[float, float, float], bool]=None, caching:
bool=True, constructionHistory: bool=True, createUVs: int=4, name:
AnyStr="", nodeState: Union[int, bool]=0, object: bool=True, radius:
Union[float, bool]=1.0, sideLength: Union[float, bool]=1.0, solidType:
int=0, texture: int=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The polyPlatonicSolid command creates a new polygonal platonic solid
:param axis: (C Q E) This flag specifies the primitive axis used to build the platonic
solid Q: When queried, this flag returns a float[3]
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createUVs: (C) This flag alows a specific UV mechanism to be selected, while
creating The valid values are 0, 1, 2 ,3 or 4 0 implies that no UVs will be generated
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node (where applicable)
:param radius: (C Q E) This flag specifies the radius of the platonic solid C: Default is
1.0 Q: When queried, this flag returns a float
:param sideLength: (C Q E) This flag specifies the side length of platonic solid C:
Default is 1.0 Q: When queried, this flag returns a float
:param solidType: (C) This flag allows a specific platonic solid to be selected for
creation of mesh, The valid values are 0, 1, 2 and 3 0 implies dodecahedron to be crea
:param texture: (C) This flag is obsolete and will be removed in the next release The
-cuv/createUVs flag should be used instead
:returns: Object name and node name.
"""
pass
def insertJoint(*args, **kwargs)->AnyStr:
"""
This command will insert a new joint under the given or selected joint If the given joint
has child joints, they will be reparented under the new inserted joint The given joint(or
selected joint) should not have skin attached The command works on the selected joint No
options or flags are necessary
:returns: The name of the new inserted joint
"""
pass
def changeSubdivComponentDisplayLevel(*args, level: Union[int, bool]=0, relative: bool=True,
q=True, query=True, **kwargs)->Union[int, Any]:
"""
Explicitly forces the subdivision surface to display components at a particular level of
refinement
:param level: (C Q) Specifies the display level of components
:param relative: (C Q) If set, level refers to the relative display level
:returns: Command result
"""
pass
def SculptMeshDeactivateBrushStrength(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nodeEditor(*args, activeTab: Union[int, bool]=0, addNewNodes: bool=True, addNode:
Union[AnyStr, List[AnyStr]]="", additiveGraphingMode: bool=True, allAttributes:
bool=True, allNodes: bool=True, allowNewTabs: bool=True, allowTabTearoff:
bool=True, autoSizeNodes: bool=True, beginCreateNode: bool=True,
beginNewConnection: AnyStr="", breakSelectedConnections: bool=True,
closeAllTabs: bool=True, closeTab: int=0, connectSelectedNodes: bool=True,
connectionMinSegment: Union[float, bool]=0.0, connectionOffset: Union[float,
bool]=0.0, connectionRoundness: Union[float, bool]=0.0, connectionStyle:
Union[AnyStr, bool]="", connectionTension: Union[int, bool]=0,
consistentNameSize: bool=True, contentsChangedCommand: Union[Script, bool]=None,
control: bool=True, createInfo: AnyStr="", createNodeCommand: Union[Script,
bool]=None, createTab: List[int, AnyStr]=None, crosshairOnEdgeDragging:
bool=True, customAttributeListEdit: Union[List[AnyStr, AnyStr], bool]=None,
cycleHUD: bool=True, defaultPinnedState: bool=True, defineTemplate: AnyStr="",
deleteSelected: bool=True, docTag: Union[AnyStr, bool]="", dotFormat:
Union[AnyStr, bool]="", downstream: bool=True, duplicateTab: List[int, int]=None,
enableOpenGL: bool=True, exists: bool=True, extendToShapes: bool=True,
feedbackConnection: bool=True, feedbackNode: bool=True, feedbackPlug: bool=True,
feedbackTabIndex: bool=True, feedbackType: bool=True, filter: Union[AnyStr,
bool]="", filterCreateNodeTypes: Union[Script, bool]=None, focusCommand:
Union[Script, bool]=None, forceMainConnection: Union[AnyStr, bool]="", frameAll:
bool=True, frameModelSelection: bool=True, frameSelected: bool=True,
getNodeList: bool=True, graphSelectedConnections: bool=True, graphSelection:
bool=True, gridSnap: bool=True, gridVisibility: bool=True, hasWatchpoint:
bool=True, highlightConnection: Union[AnyStr, bool]="", highlightConnections:
Union[List[AnyStr, bool], List[List[AnyStr, bool]]]=None, hudMessage:
List[AnyStr, int, float]=None, ignoreAssets: bool=True, island: bool=True,
keyPressCommand: Union[Script, bool]=None, keyReleaseCommand: Union[Script,
bool]=None, layout: bool=True, layoutCommand: Union[Script, bool]=None,
lockMainConnection: bool=True, mainListConnection: Union[AnyStr, bool]="",
nodeSwatchSize: AnyStr="", nodeTitleMode: Union[AnyStr, bool]="", nodeViewMode:
AnyStr="", overrideNodeDropPosition: List[float, float]=None, panView:
List[float, float]=None, panel: Union[AnyStr, bool]="", parent: Union[AnyStr,
bool]="", pinSelectedNodes: bool=True, popupMenuScript: Union[Script, bool]=None,
primary: bool=True, redockTab: bool=True, removeDownstream: bool=True,
removeNode: Union[AnyStr, List[AnyStr]]="", removeUnselected: bool=True,
removeUpstream: bool=True, renameNode: AnyStr="", renameTab: List[int,
AnyStr]=None, restoreInfo: AnyStr="", restoreLastClosedTab: bool=True, rootNode:
Union[AnyStr, List[AnyStr]]="", rootsFromSelection: bool=True, scaleView:
float=0.0, selectAll: bool=True, selectConnectionNodes: bool=True,
selectDownstream: bool=True, selectFeedbackConnection: bool=True, selectNode:
Union[AnyStr, List[AnyStr], bool]="", selectUpstream: bool=True,
selectionConnection: Union[AnyStr, bool]="", setWatchpoint: bool=True,
settingsChangedCallback: Union[Script, bool]=None, shaderNetworks: bool=True,
showAllNodeAttributes: AnyStr="", showNamespace: bool=True, showSGShapes:
bool=True, showShapes: bool=True, showTabs: bool=True, showTransforms: bool=True,
stateString: bool=True, syncedSelection: bool=True, tabChangeCommand:
Script=None, toggleAttrFilter: bool=True, toggleSelectedPins: bool=True,
toggleSwatchSize: AnyStr="", toolTipCommand: Union[Script, bool]=None,
traversalDepthLimit: Union[int, bool]=0, unParent: bool=True,
unlockMainConnection: bool=True, updateMainConnection: bool=True, upstream:
bool=True, useAssets: bool=True, useTemplate: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates/edits/queries a nodeEditor editor The optional argument is the name
of the control
:param activeTab: (Q E) Gets/sets the index of the tab widget's (active) visible tab Note:
the index is zero-based
:param addNewNodes: (C Q E) New nodes should be added to the graph, default is on
:param addNode: (E M) Adds a specified node to the graph Passing an empty string means the
current model selection will be added to the graph
:param additiveGraphingMode: (C Q E) When enabled, the graphing will add node networks to
the existing graph instead of replacing it
:param allAttributes: (C Q E) Attributes should not be filtered out of the graph, default
is off
:param allNodes: (C Q E) Nodes should not be filtered out of the graph, default is off
:param allowNewTabs: (Q) Query only Returns whether this Node Editor is allowed to have
new tabs added, either by creating a new tab or duplicating an existing one
:param allowTabTearoff: (C E) Control whether or not the tabs can be torn off and floated
Defaults to true
:param autoSizeNodes: (C Q E) When enabled, default node widths will be dynamically
determined by the node name length, default is on
:param beginCreateNode: (E) Begin interactive node-creation at the mouse position This
will create a control which allows quick creation of a node in the editor The actual cre
:param beginNewConnection: (E) Begin a new interactive connection at the given attribute
:param breakSelectedConnections: (E) Break the selected attribute connections
:param closeAllTabs: (E) Close all tabs on the tab widget
:param closeTab: (E) Closes the tab on the tab widget at the specified index Note: using
this flag on a torn-off tab will close the node editor since there can be only a
:param connectSelectedNodes: (E) Creates a connection between all selected nodes in the
editor The default output port of one node is connected to the default input port of the
next
:param connectionMinSegment: (Q E) Sets the minimum segment length ratio of the connection
leaving an output port Applies to "straight", "corner" and "s-shape" connection styles
Valu
:param connectionOffset: (Q E) Sets the offset length for each connection edges Applies to
"corner" and "s-shape" connection styles Value must be between 0.0 and 1.0
:param connectionRoundness: (Q E) Sets the roundness factor for each connection edges
Applies only to "s-shape" connection style Value must be between 0.5 and 1.0
:param connectionStyle: (Q E) Sets how the connection between nodes are drawn Mode values
are: "bezier", "straight", "corner" and "s-shape" In query mode, returns current connec
:param connectionTension: (Q E) Sets where the vertical line should be drawn on connection
edge, 0 being in the middle Applies to "corner" and "s-shape" connection styles Value mu
:param consistentNameSize: (C Q E) When enabled, the size of the node name will
consistently match the current zoom level When disabled, the node name size will remain
the same after
:param contentsChangedCommand: (C Q E) Specifies a function to be called whenever the
contents of the node editor changes
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param createInfo: (C E) Creates or modifies a hyperGraphInfo network to save the state of
the editor
:param createNodeCommand: (C Q E) Specifies a function to be used to create nodes through
the editor The function will be passed the name of the chosen node type This is used by
the
:param createTab: (C E) Create a new tab inserting it into the tab widget at the specified
index If index is out of range (such as -1), the tab is simply appended You can
:param crosshairOnEdgeDragging: (C Q E) Toggle crosshair cursor during edge dragging
on/off
:param customAttributeListEdit: (Q E) Create/Edit the custom attribute list for the given
node by entering a special "Edit Mode" for the node Note: only one node in the node editor
can b
:param cycleHUD: (C E) Change the HUD to the next state
:param defaultPinnedState: (C Q E) Sets default pinned state of all nodes, 1 for pinned, 0
for unpinned default value 0
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param deleteSelected: (E) Delete the selected nodes and break the selected connections
:param docTag: (C Q E) Attaches a tag to the editor
:param dotFormat: (Q E) In query mode: Get the graph information in DOT format The flag
argument specifies a file path to write to If "-" is supplied, the data is returned
:param downstream: (C E) Include nodes that are downstream of the root nodes
:param duplicateTab: (C E) Duplicates the tab at the specified index, placing it at the
second optional (Python only) specified index To place duplicated tab at the end use -1
:param enableOpenGL: (C Q E) Specifies if OpenGL should be used to render the node editor
view When enabled this will greatly improve performance but is still a work in progress
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param extendToShapes: (C Q E) Include child shapes for each selected transform
:param feedbackConnection: (Q) Returns a description of the connection(s) at the current
mouse position in the editor view, if any The connection(s) will be returned as a list of
:param feedbackNode: (Q) Returns the name of the node at the current mouse position in the
editor view, if any
:param feedbackPlug: (Q) Returns the name of the plug (attribute) at the current mouse
position in the editor view, if any
:param feedbackTabIndex: (Q) Returns the index of the tab at the current mouse position in
the editor view, if any
:param feedbackType: (Q) Returns the most specific type of the feedback item (item at the
current mouse position) in the editor view, if any Will be one of "plug", "node", "
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param filterCreateNodeTypes: (C Q E) Specifies a function to be used to filter the list of
node types which appear in the inline-creation menu (tab key) The function should accept
one s
:param focusCommand: (C Q E) Specifies a function to be called whenever focus changes for
the node editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param frameAll: (E) Frame all the contents of the node editor
:param frameModelSelection: (E) Frame the current model selection
:param frameSelected: (E) Frame the selected contents of the node editor
:param getNodeList: (Q) Returns a list of all nodes displayed in the editor
:param graphSelectedConnections: (E) Graph the nodes connected by the selected attribute
connections
:param graphSelection: (E) Graph the nodes that are currently selected
:param gridSnap: (C Q E) Toggle grid snapping on/off
:param gridVisibility: (C Q E) Toggle grid visiblity on/off
:param hasWatchpoint: (Q) Returns if the selected connection has a watchpoint set
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param highlightConnections: (C Q E M) Sets if selecting a node should highlight its
connections for the specified editor, which can be "regular" or "bifrost"
:param hudMessage: (E) Display the given message on the editor HUD The flag arguments are
(message, type, duration), where type is: upper-left corner top center upper-ri
:param ignoreAssets: (C Q E) Deprecated Do not use in scripts
:param island: (Q E) Deprecated Do not use in scripts
:param keyPressCommand: (C Q E) Specifies a function to be called when a key is pressed and
the editor has focus The function will be passed the name of the editor and an (uppercas
:param keyReleaseCommand: (C Q E) Specifies a function to be called when a key is released
and the editor has focus The function will be passed the name of the editor and an
(upperca
:param layout: (E) Perform an automatic layout of the graph
:param layoutCommand: (C Q E) Specifies a function to override the default action when a
graph layout is required The function will be passed the name of editor The function sho
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param nodeSwatchSize: (E) Sets the icon swatch size of selected nodes in the active scene
(all nodes if none are selected) Size values are "small" and "large"
:param nodeTitleMode: (C Q E) Gets/sets the node title display mode of the current scene
Mode values are: "name" (Display node names), "type" (Display node types), "none" (Do not
:param nodeViewMode: (E) Sets the attribute view mode of selected nodes in the active scene
(all nodes if none are selected) Mode values are: "simple" (no attributes display
:param overrideNodeDropPosition: (E) Specifies the override position for new node Values
are respectively the width and height ratio; 0.0, 0.0 corresponds to the top left corner of
the
:param panView: (E) Pan the view by the given amount Arguments of 0 0 will reset the view
translation
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param pinSelectedNodes: (E) Pins or unpins the selected nodes If no nodes are selected,
this will apply to all displayed nodes
:param popupMenuScript: (C Q E) Set the script to be called to register the popup menu with
the control for this editor The script will be called with a string argument which gives
:param primary: (Q) Query only Returns whether this node editor is the primary one The
primary editor is the only one that will show and allow tabs
:param redockTab: (Q E) If this tab was torn-off from the primary node editor, then the tab
and all its data will be re-docked back into the primary editor and this node edi
:param removeDownstream: (E) Removes all items downstream to the currently active
selection
:param removeNode: (E M) Removes a node from the graph An empty string indicates that
currently selected nodes should be removed
:param removeUnselected: (E) Removes unselected nodes from graph
:param removeUpstream: (E) Removes all items upstream to the currently active selection
:param renameNode: (E) Rename a node in the graph Depending on the zoom level of the view,
an edit field will either appear on the node item or in a popup dialog to allow
:param renameTab: (E) Renames the tab at the specified index with the (optional) name If
no name is specified (Python only) or an empty string ("") is used then an inline
:param restoreInfo: (C E) Restores the editor state corresponding to supplied
hyperGraphInfo node
:param restoreLastClosedTab: (Q E) If this node editor is the primary one, then restore the
last closed tab (if any) In query mode returns whether there is a tab available to
restore
:param rootNode: (C E M) Add a node name as a root node of the graph Passing an empty
string clears the current root node list When queried, returns the list of current roo
:param rootsFromSelection: (C E) Specify that the root nodes for the graph should taken
from the currently active selection
:param scaleView: (E) Scales the graph view by the given factor An argument of zero means
reset to default
:param selectAll: (E) Select all items in the graph
:param selectConnectionNodes: (E) Select the nodes connected by the selected attribute
connections
:param selectDownstream: (E) Select all items downstream to the currently active selection
:param selectFeedbackConnection: (E) Select the feedback connection(s) in the editor view,
if any
:param selectNode: (Q E M) Select a node in the graph Passing an empty string clears the
current selection When queried, returns the list of currently selected nodes
:param selectUpstream: (E) Select all items upstream to the currently active selection
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param setWatchpoint: (C E) Adds or removes the watchpoint on the selected connections
:param settingsChangedCallback: (C Q E) Specifies a function to be called whenever settings
for the node editor get changed
:param shaderNetworks: (E) Graph the shader network for all the objects on the selection
list that have shaders
:param showAllNodeAttributes: (E) Display all attributes for the given node, not just
primary attributes Passing an empty string will apply this to all currently selected nodes
If n
:param showNamespace: (C Q E) Specifies whether nodes will have their namespace displayed
if they are not in the root namespace
:param showSGShapes: (C Q E) Show shapes that are connected to the network through a
shading group
:param showShapes: (C Q E) Show shape nodes
:param showTabs: (C) Creation time flag to explicitly control the visibility of the tabs
If this is set to true or false the tabs visibility will respect that setting I
:param showTransforms: (C Q E) Show transforms
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param syncedSelection: (C Q E) Keep the graph selection in sync with the model selection
:param tabChangeCommand: (C E) Command executed when the current (active) tab is changed
Re-selecting the current tab will not invoke this command NOTE: This command will also be
:param toggleAttrFilter: (E) Toggles the display of the attribute filter field on selected
nodes If any of the selected nodes have the field displayed, this operation will hide
:param toggleSelectedPins: (E) Toggles pinned state on selected nodes If any selected
nodes are unpinned, this operation will choose to pin all nodes If no nodes are selected,
th
:param toggleSwatchSize: (E) Toggles the swatch size of the given node between small and
large If supplied node name was empty, this will be applied to selection, and if no node
:param toolTipCommand: (C Q E) Specifies a function to override the tooltip that is
displayed for a node The function will be passed the name of the node under the cursor,
and sho
:param traversalDepthLimit: (C Q E) Specify the maximum number of edges which will be
followed from any root node when building the graph A negative value means unlimited
Default is u
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param upstream: (C E) Include nodes that are upstream of the root nodes
:param useAssets: (C Q E) Use assets and published attributes instead of contents and
actual attributes
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the created control.
"""
pass
def CreateNURBSCylinderOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LevelOfDetailGroup(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PostInfinityCycleOffset(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshGrabUVToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PasteVertexSkinWeights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artAttrCtx(*args, accopacity: bool=False, activeListChangedProc: Union[AnyStr, bool]="",
afterStrokeCmd: Union[AnyStr, bool]="", alphaclamp: Union[AnyStr, bool]="none",
alphaclamplower: Union[float, bool]=0.0, alphaclampupper: Union[float, bool]=1.0,
attrSelected: Union[AnyStr, bool]="", beforeStrokeCmd: Union[AnyStr, bool]="",
brushalignment: bool=True, brushfeedback: bool=True, clamp: Union[AnyStr,
bool]="none", clamplower: Union[float, bool]=0.0, clampupper: Union[float,
bool]=1.0, clear: bool=True, colorAlphaValue: Union[float, bool]=0.0,
colorRGBAValue: Union[List[float, float, float, float], bool]=None,
colorRGBValue: Union[List[float, float, float], bool]=None, colorRamp:
Union[AnyStr, bool]="", colorfeedback: bool=False, colorfeedbackOverride:
bool=False, colorrangelower: Union[float, bool]=0.0, colorrangeupper:
Union[float, bool]=1.0, dataTypeIndex: Union[int, bool]=0, disablelighting:
bool=False, dragSlider: AnyStr="", duringStrokeCmd: Union[AnyStr, bool]="",
dynclonemode: bool=True, exists: bool=True, expandfilename: bool=True,
exportaspectratio: Union[float, bool]=0.0, exportfilemode: Union[AnyStr,
bool]="luminance/rgb", exportfilesave: AnyStr="", exportfilesizex: Union[int,
bool]=0, exportfilesizey: Union[int, bool]=0, exportfiletype: Union[AnyStr,
bool]="", filterNodes: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
importfileload: AnyStr="", importfilemode: Union[AnyStr, bool]="alpha",
importreassign: bool=False, interactiveUpdate: bool=True, lastRecorderCmd:
Union[AnyStr, bool]="", lastStampName: Union[AnyStr, bool]="", lowerradius:
Union[float, bool]=0.0, makeStroke: Union[int, List[int], bool]=0, mappressure:
Union[AnyStr, bool]="none", maxvalue: Union[float, bool]=1.0, minvalue:
Union[float, bool]=0.0, name: AnyStr="", objattrArray: Union[AnyStr, bool]="",
opacity: Union[float, bool]=1.0, outline: bool=True, outwhilepaint: bool=False,
paintNodeArray: Union[AnyStr, bool]="", paintattrselected: AnyStr="", paintmode:
Union[AnyStr, bool]="screen", paintoperationtype: Union[AnyStr, bool]="Paint",
pickColor: bool=True, pickValue: bool=True, playbackCursor: Union[List[float,
float], List[List[float, float]], bool]=None, playbackPressure: Union[float,
List[float], bool]=0.0, preserveclonesource: bool=True, profileShapeFile:
Union[AnyStr, bool]="", projective: bool=False, radius: Union[float, bool]=1.0,
rampMaxColor: Union[List[float, float, float], bool]=None, rampMinColor:
Union[List[float, float, float], bool]=None, record: bool=True, reflection:
bool=False, reflectionaboutorigin: bool=True, reflectionaxis: Union[AnyStr,
bool]="x", screenRadius: Union[float, bool]=0.0, selectclonesource: bool=True,
selectedattroper: Union[AnyStr, bool]="absolute", showactive: bool=True,
stampDepth: Union[float, bool]=0.0, stampProfile: Union[AnyStr, bool]="",
stampSpacing: Union[float, bool]=1.0, strokesmooth: Union[AnyStr, bool]="",
surfaceConformedBrushVertices: bool=True, tablet: bool=True, tangentOutline:
bool=True, toolOffProc: Union[AnyStr, bool]="", toolOnProc: Union[AnyStr,
bool]="", useColorRamp: bool=True, useMaxMinColor: bool=True, usepressure:
bool=False, value: Union[float, bool]=0.0, whichTool: Union[AnyStr, bool]="",
worldRadius: Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This is a context command to set the flags on the artAttrContext, which is the base context
for attribute painting operations All commands require the name of the context as the last
argument as this provides the name of the context to create, edit or query This is a
context command to set the flags on the Attribute Paint Tool context
:param accopacity: (C Q E) Sets opacity accumulation on/off C: Default is false (Except
for sculpt tool for which it is true by default) Q: When queried, it returns a boolean
:param activeListChangedProc: (C Q E) Accepts a string that contains a MEL command that is
invoked whenever the active list changes There may be some situations where the UI, for
example
:param afterStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
after the end of a stroke C: Default is no command Q: When queried, it returns the curre
:param alphaclamp: (C Q E) Specifies if the weight value should be alpha clamped to the
lower and upper bounds There are four options here: "none" - no clamping is performed,
:param alphaclamplower: (C Q E) Specifies the lower bound for the alpha values C: Default
is 0.0 Q: When queried, it returns a float
:param alphaclampupper: (C Q E) Specifies the upper bound for the alpha values C: Default
is 1.0 Q: When queried, it returns a float
:param attrSelected: (Q) Returns a name of the currently selected attribute Q: When
queried, it returns a string
:param beforeStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
before the start of a stroke C: Default is no command Q: When queried, it returns the cu
:param brushalignment: (C Q E) Specifies the path brush alignemnt If true, the brush will
align to stroke path, otherwise it will align to up vector C: Default is true Q: When q
:param brushfeedback: (C Q E) Specifies if the brush additional feedback should be drawn
C: Default is TRUE Q: When queried, it returns a boolean
:param clamp: (C Q E) Specifies if the weight value should be clamped to the lower and
upper bounds There are four options here: "none" - no clamping is performed, "lower
:param clamplower: (C Q E) Specifies the lower bound for the values C: Default is 0.0 Q:
When queried, it returns a float
:param clampupper: (C Q E) Specifies the upper bound for the values C: Default is 1.0 Q:
When queried, it returns a float
:param clear: (C E) Floods all cvs/vertices to the current value
:param colorAlphaValue: (C Q E) The Alpha value of the color
:param colorRGBAValue: (C Q E) The RGBA value of the color
:param colorRGBValue: (C Q E) The RGB value of the color
:param colorRamp: (C Q E) Allows a user defined color ramp to be used to map values to
colors
:param colorfeedback: (C Q E) Sets on/off the color feedback display C: Default is FALSE
Q: When queried, it returns a boolean
:param colorfeedbackOverride: (C Q E) Sets on/off the color feedback override C: Default
is FALSE Q: When queried, it returns a boolean
:param colorrangelower: (C Q E) Specifies the value that maps to black when color feedback
mode is on C: Default is 0.0 Q: When queried, it returns a float
:param colorrangeupper: (C Q E) Specifies the value that maps to the maximum color when
color feedback mode is on C: Default is 1.0 Q: When queried, it returns a float
:param dataTypeIndex: (Q E) When the selected paintable attribute is a vectorArray, it
specifies which field to paint on
:param disablelighting: (C Q E) If color feedback is on, this flag determines whether
lighting is disabled or not for the surfaces that are affected C: Default is FALSE Q:
When qu
:param dragSlider: (C E) Sets the current brush drag state for resizing or offsetting the
brush (like the 'b' and 'm' default hotkeys) The string argument is one of: "radius
:param duringStrokeCmd: (C Q E) The passed string is executed as a MEL command during the
stroke, each time the mouse is dragged C: Default is no command Q: When queried, it
retur
:param dynclonemode: (C Q E) Enable or disable dynamic clone mode
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param expandfilename: (C E) If true, it will expand the name of the export file and
concatenate it with the surface name Otherwise it will take the name as it is C: Default
is
:param exportaspectratio: (C Q E) Value of aspect ratio for export
:param exportfilemode: (C Q E) Specifies the export channel.The valid entries here are:
"alpha", "luminance", "rgb", "rgba" C: Default is "luminance/rgb" Q: When queried, it
retu
:param exportfilesave: (E) Exports the attribute map and saves to a specified file
:param exportfilesizex: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfilesizey: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfiletype: (C Q E) Specifies the image file format It can be one of the
following: "iff", "tiff", "jpeg", "alias", "rgb", "fit" "postScriptEPS", "softimage",
"wavefron
:param filterNodes: (E) Sets the node filter
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param importfileload: (E) Load the attribute map a specified file
:param importfilemode: (C Q E) Specifies the channel to import The valid entries here are:
"alpha", "luminance", "red", "green", "blue", and "rgb" C: Default is "alpha" Q: When q
:param importreassign: (C Q E) Specifies if the multiply atrribute maps are to be
reassigned while importing Only maps previously exported from within Artisan can be
reassigned C
:param interactiveUpdate: (C Q E) Specifies how often to transfer the painted values into
the attribute TRUE: transfer them "continuously" (many times per stroke) FALSE: transfer
the
:param lastRecorderCmd: (C Q E) Value of last recorded command
:param lastStampName: (C Q E) Value of the last stamp name
:param lowerradius: (C Q E) Sets the lower size of the brush (only apply on tablet)
:param makeStroke: (C Q E M) Stroke point values
:param mappressure: (C Q E) Sets the tablet pressure mapping when the table is used There
are four options: "none" - the pressure has no effect, "opacity" - the pressure is map
:param maxvalue: (C Q E) Specifies the maximum value for each attribute C: Default is 1.0
Q: When queried, it returns a float
:param minvalue: (C Q E) Specifies the minimum value for each attribute C: Default is 0.0
Q: When queried, it returns a float
:param name: (C) If this is a tool command, name the tool appropriately
:param objattrArray: (Q) An array of all paintable attributes Each element of the array is
a string with the following information: NodeType.NodeName.AttributeName.MenuType
:param opacity: (C Q E) Sets the brush opacity C: Default is 1.0 Q: When queried, it
returns a float
:param outline: (C Q E) Specifies if the brush should be drawn C: Default is TRUE Q: When
queried, it returns a boolean
:param outwhilepaint: (C Q E) Specifies if the brush outline should be drawn while painting
C: Default is FALSE Q: When queried, it returns a boolean
:param paintNodeArray: (Q) An array of paintable nodes Q: When queried, it returns a
string
:param paintattrselected: (E) An array of selected paintable attributes Each element of
the array is a string with the following information: NodeType.NodeName.AttributeName
:param paintmode: (C Q E) Specifies the paint mode There are two possibilities: "screen"
and "tangent" C: Default is "screen" Q: When queried, it returns a string
:param paintoperationtype: (C Q E) Specifies the operation type used by the Paint Tool
Currently, we support the following paint modes: "Paint", "Smear", "Blur", "Erase" and
"Clone"
:param pickColor: (C Q E) Set pick color mode on or off
:param pickValue: (C Q E) Toggle for picking
:param playbackCursor: (C Q E M) Values for the playback cursor
:param playbackPressure: (C Q E M) Valus for the playback pressure
:param preserveclonesource: (C Q E) Whether or not to preserve a clone source
:param profileShapeFile: (Q E) Passes a name of the image file for the stamp shape profile
:param projective: (C Q E) Specifies the projective paint mode C: Default is 'false' Q:
When queried, it returns a boolean
:param radius: (C Q E) Sets the size of the brush C: Default is 1.0 cm Q: When queried,
it returns a float
:param rampMaxColor: (C Q E) Defines a special color to be used when the value is greater
than or equal to the maximum value
:param rampMinColor: (C Q E) Defines a special color to be used when the value is less than
or equal to the minimum value
:param record: (C Q E) Toggle on for recording
:param reflection: (C Q E) Specifies the reflection mode C: Default is 'false' Q: When
queried, it returns a boolean
:param reflectionaboutorigin: (C Q E) Toggle on to reflect about the origin
:param reflectionaxis: (C Q E) Specifies the reflection axis There are three
possibilities: "x", "y" and "z" C: Default is "x" Q: When queried, it returns a string
:param screenRadius: (C Q E) Brush radius on the screen
:param selectclonesource: (C Q E) Toggle on to select the clone source
:param selectedattroper: (C Q E) Sets the edit weight operation Four edit weights
operations are provided : "absolute" - the value of the weight is replaced by the current
one, "add
:param showactive: (C Q E) Sets on/off the display of the surface isoparms C: Default is
TRUE Q: When queried, it returns a boolean
:param stampDepth: (C Q E) Depth of the stamps
:param stampProfile: (C Q E) Sets the brush profile of the current stamp Currently, the
following profiles are supported: "gaussian", "poly", "solid" and "square" C: Default is
:param stampSpacing: (C Q E) Specifies the stamp spacing Default is 1.0
:param strokesmooth: (C Q E) Stroke smoothing type name
:param surfaceConformedBrushVertices: (C Q E) Enables/disables the the display of the
effective brush area as affected vertices
:param tablet: (Q) Returns true if the tablet device is present, false if it is absent
:param tangentOutline: (C Q E) Enables/disables the display of the brush circle tangent to
the surface
:param toolOffProc: (C Q E) Accepts a strings describing the name of a MEL procedure that
is invoked whenever the tool is turned off For example, cloth invokes "clothPaintToolO
:param toolOnProc: (C Q E) Accepts a strings describing the name of a MEL procedure that is
invoked whenever the tool is turned on For example, cloth invokes "clothPaintToolOn
:param useColorRamp: (C Q E) Specifies whether the user defined color ramp should be used
to map values from to colors If this is turned off, the default greyscale feedback will
:param useMaxMinColor: (C Q E) Specifies whether the out of range colors should be used
See rampMinColor and rampMaxColor flags for further details
:param usepressure: (C Q E) Sets the tablet pressure on/off C: Default is false Q: When
queried, it returns a boolean
:param value: (C Q E) Specifies the value for each attribute C: Default is 0.0 Q: When
queried, it returns a float
:param whichTool: (C Q E) The string defines the name of the tool to be used for the
Artisan context An example is "artClothPaint" In query mode, the tool name for the given
:param worldRadius: (C Q E) Radius in worldspace
:returns: The name of the context created.
"""
pass
def snapshot(*args, constructionHistory: bool=True, endTime: Union[time, bool]=None, increment:
Union[time, bool]=None, motionTrail: bool=False, name: Union[AnyStr, bool]="",
startTime: Union[time, bool]=None, update: Union[AnyStr, bool]="always", q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command can be used to create either a series of surfaces evaluated at the times
specified by the command flags, or a motion trail displaying the trajectory of the object's
pivot point at the times specified. If the constructionHistory flag is true, the output
shapes or motion trail will re-update when modifications are made to the animation
:param constructionHistory: (C Q) update with changes to original geometry
:param endTime: (C Q E) time to stop copying target geometry Default: 10.0
:param increment: (C Q E) time increment between copies Default: 1.0
:param motionTrail: (C) Rather than create a series of surfaces, create a motion trail
displaying the location of the object's pivot point at the specified time steps Defau
:param name: (C Q E) the name of the snapshot node Query returns string
:param startTime: (C Q E) time to begin copying target geometry Default: 1.0
:param update: (C Q E) This flag can only be used if the snapshot has constructionHistory
It sets the snapshot node's update value The update value controls whether the s
:returns: names of nodes created or edited: transform-name [snapshot-node-name]
"""
pass
def Create3DContainer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AttachToPath(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorClipScaleEnd(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setAttrMapping(*args, absolute: bool=True, attribute: Union[AnyStr, List[AnyStr]]="", axis:
AnyStr="", clutch: AnyStr="", device: AnyStr="", offset: float=0.0,
relative: bool=True, scale: float=0.0, selection: bool=True, q=True,
query=True, **kwargs)->Union[None, Any]:
"""
This command applies an offset and scale to a specified device attachment This command is
different than the setInputDeviceMapping command, which applies a mapping to a device axis
The value from the device is multiplied by the scale and the offset is added to this
product With an absolute mapping, the attached attribute gets the resulting valu
:param absolute: (C) Make the mapping absolute
:param attribute: (C M) The attribute used in the attachment
:param axis: (C) The axis on the device used in the attachment
:param clutch: (C) The clutch button used in the attachment
:param device: (C) The device used in the attachment
:param offset: (C) Specify the offset value
:param relative: (C) Make the mapping relative
:param scale: (C) Specify the scale value
:param selection: (C) This flag specifies the mapping should be on the selected objects
:returns:
"""
pass
def pairBlend(*args, attribute: Union[AnyStr, List[AnyStr]]="", input1: bool=True, input2:
bool=True, node: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
The pairBlend node allows a weighted combinations of 2 inputs to be blended together It is
created automatically when keying or constraining an attribute which is already connected.
Alternatively, the pairBlend command can be used to connect a pairBlend node to connected
attributes of a node The previously existing connections are rewired to inpu
:param attribute: (C M) The name of the attribute(s) which the blend will drive This flag
is required when creating the blend
:param input1: (Q) Returns a string array of the node(s) connected to input 1
:param input2: (Q) Returns a string array of the node(s) connected to input 2
:param node: (C) The name of the node which the blend will drive This flag is required
when creating the blend
:returns: name of pairBlend node
"""
pass
def inViewMessage(*args, alpha: float=0.0, assistMessage: AnyStr="", backColor: int=0, clear:
AnyStr="", clickKill: bool=True, dragKill: bool=True, fade: bool=True,
fadeInTime: int=0, fadeOutTime: int=0, fadeStayTime: int=0, font: AnyStr="",
fontSize: int=0, frameOffset: int=0, hide: bool=True, message: AnyStr="",
minimize: bool=True, position: AnyStr="", restore: bool=True, show: bool=True,
statusMessage: AnyStr="", textAlpha: float=0.0, textOffset: int=0, uvEditor:
bool=True, **kwargs)->None:
"""
Used for displaying in-view messages Note: On Linux, the alpha and textAlpha flags for
inViewMessage are only supported when running a window manager that supports compositing
(transparency and opacity) Otherwise, they are ignored In addition, the flags for message
fading: -fade, -fadeInTime, -fadeStay and -fadeOutTime are supported, but the me
:param alpha: (C) Sets the maximum alpha transparency for the message box
:param assistMessage: (C) The user assistance message to be displayed, can be html format
:param backColor: (C) Sets the background color for the message using the format 0xAARRGGBB,
alpha is not taken into account
:param clear: (C) Use this flag to clear the message at a specified position The supported
positions are the same as for the -pos/position flag
:param clickKill: (C) Use this flag if the message needs to be deleted on mouse click
:param dragKill: (C) Use this flag if the message needs to be deleted on mouse drag
:param fade: (C) Whether the message will fade after a time interval or not
:param fadeInTime: (C) Sets how long it takes for the image to fade in (milliseconds)
:param fadeOutTime: (C) Sets how long it takes for the image to fade out (milliseconds)
:param fadeStayTime: (C) Sets how long the image stays at max opacity (milliseconds)
:param font: (C) Sets the message to a font (eg "Arial")
:param fontSize: (C) Sets the message font size
:param frameOffset: (C) Sets how far the message appears from the edge of the viewport in
pixels
:param hide: (C) Hides all messages
:param message: (C) The message to be displayed, can be html format General message,
inherited by -amg/assistMessage and -smg/statusMessage
:param minimize: (C) Minimize all messages
:param position: (C) The position that the message will appear at relative to the active
viewport The supported positions are: "topLeft" "topCenter" "topRight" "midLeft"
:param restore: (C) Restore all messages
:param show: (C) Shows all messages
:param statusMessage: (C) The status info message to be displayed, can be html format
:param textAlpha: (C) Sets the maximum alpha transparency for the message text
:param textOffset: (C) Sets how far the text appears from the edge of the message box in
pixels
:param uvEditor: (C) Show the message in the active UV editor view
:returns:
"""
pass
def SelectAllJoints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeEditPSDFile(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RebuildCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideGeometry(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExportProxyContainer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fileDialog(*args, application: bool=True, defaultFileName: AnyStr="", directoryMask:
AnyStr="", mode: int=0, title: AnyStr="", **kwargs)->AnyStr:
"""
The fileBrowserDialog and fileDialog commands have now been deprecated Both commands are
still callable, but it is recommended that the fileDialog2 command be used instead To
maintain some backwards compatibility, both fileBrowserDialog and fileDialog will convert
the flags/values passed to them into the appropriate flags/values that the fileDial
:param application: (C) This is a "Mac" only flag This brings up the dialog which selects
only the application bundle
:param defaultFileName: (C) Set default file name This flag is available under "write"
mode
:param directoryMask: (C) This can be used to specify what directory and file names will be
displayed in the dialog If not specified, the current directory will be used, with
:param mode: (C) Defines the mode in which to run the file dialog: 0 for read 1 for write
Write mode can not be used in conjunction with the -application flag
:param title: (C) Set title text The default value under "write" mode is "Save As" The
default value under "read" mode is "Open"
:returns: Name of dialog
"""
pass
def invertShape(*args, **kwargs)->None:
"""
"""
pass
def SelectToolMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MoveRotateScaleToolToggleSnapMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PlaybackStop(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_safeFrameTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleEdgeIDs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TangentsPlateau(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def selectKeyframe(*args, **kwargs)->None:
"""
"""
pass
def HypershadeOpenCreateWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def combinationShape(*args, addDriver: bool=True, allDrivers: bool=True, blendShape: AnyStr="",
combinationTargetIndex: int=0, combinationTargetName: AnyStr="",
combineMethod: Union[int, bool]=0, driverTargetIndex: Union[int,
List[int]]=0, driverTargetName: Union[AnyStr, List[AnyStr]]="", exist:
bool=True, removeDriver: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[Int, Any]:
"""
Command to create or edit drive relationship of blend shape targets
:param addDriver: () Add drivers to the combination shape
:param allDrivers: (Q) All drivers of the combination shape
:param blendShape: (C) Associated blend shape node of the combination shape In query mode,
this flag can accept a value
:param combinationTargetIndex: (C) Driven blend shape target index of the combination shape
In query mode, this flag can accept a value
:param combinationTargetName: (C) Driven blend shape target name of the combination shape
In query mode, this flag can accept a value
:param combineMethod: (C Q E) Combine method of the combination shape: 0 : Multiplication 1
: Lowest Weighting 2 : Lowest Weighting (Smooth)
:param driverTargetIndex: (C M) Driver blend shape target index of the combination shape
:param driverTargetName: (C M) Driver blend shape target name of the combination shape
:param exist: (Q) If the combination shape exist
:param removeDriver: () Remove drivers from the combination shape
:returns: In edit mode, return the newly created combination shape node name.
"""
pass
def sbs_GetBakeFormat(*args, **kwargs)->None:
"""
"""
pass
def melOptions(*args, duplicateVariableWarnings: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
Set and query options that affect the behavior of Maya's Embedded Language (MEL)
:param duplicateVariableWarnings: (C Q) When turned on, this option will cause a warning to
be generated whenever a MEL variable is declared within the same scope as another variable
with t
:returns:
"""
pass
def xgmExport(*args, **kwargs)->None:
"""
"""
pass
def polySphericalProjection(*args, imageCenter: Union[List[float, float], bool]=None,
imageCenterX: Union[float, bool]=0.5, imageCenterY: Union[float,
bool]=0.5, imageScale: Union[List[float, float], bool]=None,
imageScaleU: Union[float, bool]=1.0, imageScaleV: Union[float,
bool]=1.0, projectionCenter: Union[List[float, float, float],
bool]=None, projectionCenterX: Union[float, bool]=0.0,
projectionCenterY: Union[float, bool]=0.0, projectionCenterZ:
Union[float, bool]=0.0, projectionHorizontalSweep: Union[float,
bool]=0.0, projectionScale: Union[List[float, float], bool]=None,
projectionScaleU: Union[float, bool]=180.0, projectionScaleV:
Union[float, bool]=90.0, radius: Union[float, bool]=0.0, rotate:
Union[List[float, float, float], bool]=None, rotateX: Union[float,
bool]=0.0, rotateY: Union[float, bool]=0.0, rotateZ: Union[float,
bool]=0.0, rotationAngle: Union[float, bool]=10.0, seamCorrect:
bool=True, caching: bool=True, constructionHistory: bool=True,
createNewMap: bool=True, insertBeforeDeformers: bool=True,
keepImageRatio: bool=True, mapDirection: AnyStr="", name: AnyStr="",
nodeState: Union[int, bool]=0, perInstance: bool=True, smartFit:
bool=True, worldSpace: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
TpolyProjCmdBase is a base class for the command to create a mapping on the selected
polygonal faces Projects a spherical map onto an object
:param imageCenter: (C Q E) This flag specifies the center point of the 2D model layout C:
Default is 0.5 0.5 Q: When queried, this flag returns a float[2]
:param imageCenterX: (C Q E) This flag specifies X for the center point of the 2D model
layout C: Default is 0.5 Q: When queried, this flag returns a float
:param imageCenterY: (C Q E) This flag specifies Y for the center point of the 2D model
layout C: Default is 0.5 Q: When queried, this flag returns a float
:param imageScale: (C Q E) This flag specifies the UV scale : Enlarges or reduces the 2D
version of the model in U or V space relative to the 2D centerpoint C: Default is 1.0
:param imageScaleU: (C Q E) This flag specifies the U scale : Enlarges or reduces the 2D
version of the model in U space relative to the 2D centerpoint C: Default is 1.0 Q: Wh
:param imageScaleV: (C Q E) This flag specifies the V scale : Enlarges or reduces the 2D
version of the model in V space relative to the 2D centerpoint C: Default is 1.0 Q: Wh
:param projectionCenter: (C Q E) This flag specifies the origin point from which the map is
projected C: Default is 0.0 0.0 0.0 Q: When queried, this flag returns a float[3]
:param projectionCenterX: (C Q E) This flag specifies X for the origin point from which the
map is projected C: Default is 0.0 Q: When queried, this flag returns a float
:param projectionCenterY: (C Q E) This flag specifies Y for the origin point from which the
map is projected C: Default is 0.0 Q: When queried, this flag returns a float
:param projectionCenterZ: (C Q E) This flag specifies Z for the origin point from which the
map is projected C: Default is 0.0 Q: When queried, this flag returns a float
:param projectionHorizontalSweep: (C Q E) The angle swept horizontally by the projection
The range is [0, 360]
:param projectionScale: (C Q E) This flag specifies the width and the height of the map
relative to the 3D projection axis C: Default is 180.0 90.0 Q: When queried, this flag
retu
:param projectionScaleU: (C Q E) This flag specifies the width of the map relative to the
3D projection axis : the scale aperture The range is [0, 360] C: Default is 180.0 Q:
When
:param projectionScaleV: (C Q E) This flag specifies the height of the map relative to the
3D projection axis : the scale height C: Default is 90.0 Q: When queried, this flag
retur
:param radius: (C Q E) Used by the UI : Manipulator
:param rotate: (C Q E) This flag specifies the mapping rotate angles C: Default is 0.0 0.0
0.0 Q: When queried, this flag returns a float[3]
:param rotateX: (C Q E) This flag specifies X mapping rotate angle C: Default is 0.0 Q:
When queried, this flag returns a float[3]
:param rotateY: (C Q E) This flag specifies Y mapping rotate angle C: Default is 0.0 Q:
When queried, this flag returns a float
:param rotateZ: (C Q E) This flag specifies Z mapping rotate angle C: Default is 0.0 Q:
When queried, this flag returns a float
:param rotationAngle: (C Q E) This flag specifies the rotation angle in the mapping space
When the angle is positive, then the map rotates counterclockwise on the mapped model, w
:param seamCorrect: (C Q E) This flag specifies to perform a seam correction on the mapped
faces
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createNewMap: (C Q) This flag when set true will create a new map with a the name
passed in, if the map does not already exist
:param insertBeforeDeformers: (C) This flag specifies if the projection node should be
inserted before or after deformer nodes already applied to the shape Inserting the
projection a
:param keepImageRatio: (C) True means keep any image ratio
:param mapDirection: (C) This flag specifies the mapping direction 'x', 'y' and 'z'
projects the map along the corresponding axis 'c' projects along the current camera view
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param perInstance: (C) True if the new map is per-instance, otherwise it is shared
:param smartFit: (C) True means use the smart fit algorithm
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def objExists(*args, **kwargs)->bool:
"""
This command simply returns true or false depending on whether an object with the given
name exists
:returns: Command result
"""
pass
def currentTime(*args, update: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[time, Any]:
"""
When given a time argument (with or without the -edit flag) this command sets the current
global time The model updates and displays at the new time, unless "-update off" is
present on the command line
:param update: (C) change the current time, but do not update the world Default value is
true
:returns: Command result
"""
pass
def xgmSplineGeometryConvert(*args, **kwargs)->None:
"""
"""
pass
def dpBirailCtx(*args, **kwargs)->None:
"""
"""
pass
def connectJoint(*args, connectMode: bool=True, parentMode: bool=True, **kwargs)->None:
"""
This command will connect two skeletons based on the two selected joints The first
selected joint can be made a child of the parent of the second selected joint or a child of
the second selected joint, depending on the flags used Note1: The first selected joint
must be the root of a skeleton The second selected joint must have a parent Note2:
:param connectMode: (C) The first selected joint will be parented under the parent of the
second selected joint
:param parentMode: (C) The first selected joint will be parented under the second selected
joint Both joints will be in the active list(selection list)
:returns:
"""
pass
def shadingConnection(*args, connectionState: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
Sets the connection state of a connection between nodes that are used in shading Specify
the destination attribute of the connection
:param connectionState: (C Q E) Specifies the state of the connection On/True/1 means the
connection is still active Off/False/0 means the connection is inactive
:returns:
"""
pass
def hikRigSync(*args, **kwargs)->None:
"""
"""
pass
def stitchSurface(*args, bias: Union[float, bool]=1.0, caching: bool=True, cvIthIndex:
Union[int, List[int], bool]=1, cvJthIndex: Union[int, List[int], bool]=1,
fixBoundary: bool=False, nodeState: Union[int, bool]=0, parameterU:
Union[float, List[float], bool]=10000, parameterV: Union[float, List[float],
bool]=10000, positionalContinuity: Union[bool, List[bool]]=True, stepCount:
Union[int, List[int], bool]=20, tangentialContinuity: Union[bool,
List[bool]]=False, togglePointNormals: bool=False, togglePointPosition:
bool=True, toggleTolerance: Union[bool, List[bool]]=False, tolerance:
Union[float, List[float], bool]=0.1, cascade: bool=False,
constructionHistory: bool=True, keepG0Continuity: bool=True,
keepG1Continuity: bool=False, name: AnyStr="", numberOfSamples: int=20,
object: bool=True, replaceOriginal: bool=True, weight0: float=0.5, weight1:
float=0.5, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The stitchSurface command aligns two surfaces together to be G(0) and/or G(1) continuous by
ajusting only the Control Vertices of the surfaces The two surfaces can be stitched by
specifying the two isoparm boundary edges that are to stitched together The edge to which
the two surfaces are stitched together is obtained by doing a weighted average
:param bias: (C Q E) Blend CVs in between input surface and result from stitch A value of
0.0 returns the input surface Default: 1.0
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param cvIthIndex: (C Q E M) The ith boundary CV index on the input surface Default: -1
:param cvJthIndex: (C Q E M) The jth boundary CV index on the input surface Default: -1
:param fixBoundary: (C Q E) Fix Boundary CVs while solving for any G1 constraints Default:
false
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param parameterU: (C Q E M) The U parameter value on surface for a point constraint
Default: -10000
:param parameterV: (C Q E M) The V parameter value on surface for a point constraint
Default: -10000
:param positionalContinuity: (C Q E M) Toggle on (off) G0 continuity at edge corresponding
to multi index Default: true
:param stepCount: (C Q E M) Step count for the number of discretizations Default: 20
:param tangentialContinuity: (C Q E M) Toggle on (off) G1 continuity across edge
corresponding to multi index Default: false
:param togglePointNormals: (C Q E) Toggle on (off) normal point constraints on the surface
Default: false
:param togglePointPosition: (C Q E) Toggle on (off) position point constraints on the
surface Default: true
:param toggleTolerance: (C Q E M) Toggle on (off) so as to use Tolerance or specified steps
for discretization Default: false
:param tolerance: (C Q E M) Tolerance to use while discretizing the edge Default: 0.1
:param cascade: (C) Cascade the created stitch node (Only if the surface has a stitch
history) Default is 'false'
:param constructionHistory: (C) Turn the construction history on or off
:param keepG0Continuity: (C) Stitch together with positional continuity Default is 'true'
:param keepG1Continuity: (C) Stitch together with tangent continuity Default is 'false'
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param numberOfSamples: (C) The number of samples on the edge Default is 20
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:param weight0: (C) The weighting factor for the first edge Default is 0.5
:param weight1: (C) The weighting factor for the second edge Default is 0.5
:returns: Object name and node name
"""
pass
def CreateShrinkWrapOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def attributeQuery(*args, affectsAppearance: bool=True, affectsWorldspace: bool=True,
attributeType: bool=True, cachedInternally: bool=True, categories: bool=True,
channelBox: bool=True, connectable: bool=True, enum: bool=True, exists:
bool=True, hidden: bool=True, indeterminant: bool=True, indexMatters:
bool=True, internal: bool=True, internalGet: bool=True, internalSet:
bool=True, keyable: bool=True, listChildren: bool=True, listDefault:
bool=True, listEnum: bool=True, listParent: bool=True, listSiblings:
bool=True, longName: bool=True, maxExists: bool=True, maximum: bool=True,
message: bool=True, minExists: bool=True, minimum: bool=True, multi:
bool=True, niceName: bool=True, node: name=None, numberOfChildren: bool=True,
range: bool=True, rangeExists: bool=True, readable: bool=True, renderSource:
bool=True, shortName: bool=True, softMax: bool=True, softMaxExists:
bool=True, softMin: bool=True, softMinExists: bool=True, softRange:
bool=True, softRangeExists: bool=True, storable: bool=True, type: AnyStr="",
typeExact: AnyStr="", usedAsColor: bool=True, usedAsFilename: bool=True,
usesMultiBuilder: bool=True, worldspace: bool=True, writable: bool=True,
**kwargs)->List[float]:
"""
attributeQuery returns information about the configuration of an attribute It handles both
boolean flags, returning true or false, as well as other return values Specifying more
than one boolean flag will return the logical "and" of all the specified boolean flags You
may not specify any two flags when both do not provide a boolean return type
:param affectsAppearance: (C) Return true if the attribute affects the appearance of the
node
:param affectsWorldspace: (C) Return the status of the attribute flag marking attributes
affecting worldspace
:param attributeType: (C) Return the name of the attribute type (will be the same type
names as described in the addAttr and addExtension commands)
:param cachedInternally: (C) Return whether the attribute is cached within the node as well
as in the datablock
:param categories: (C) Return the categories to which the attribute belongs or an empty
list if it does not belong to any
:param channelBox: (C) Return whether the attribute should show up in the channelBox or
not
:param connectable: (C) Return the connectable status of the attribute
:param enum: (C) Return true if the attribute is a enum attribute
:param exists: (C) Return true if the attribute exists
:param hidden: (C) Return the hidden status of the attribute
:param indeterminant: (C) Return true if this attribute might be used in evaluation but
it's not known for sure until evaluation time
:param indexMatters: (C) Return the indexMatters status of the attribute
:param internal: (C) Return true if the attribute is either internalSet or internalGet
:param internalGet: (C) Return true if the attribute come from getCachedValue
:param internalSet: (C) Return true if the attribute must be set through setCachedValue
:param keyable: (C) Return the keyable status of the attribute
:param listChildren: (C) Return the list of children attributes of the given attribute
:param listDefault: (C) Return the default values of numeric and compound numeric
attributes
:param listEnum: (C) Return the list of enum strings for the given attribute
:param listParent: (C) Return the parent of the given attribute
:param listSiblings: (C) Return the list of sibling attributes of the given attribute
:param longName: (C) Return the long name of the attribute
:param maxExists: (C) Return true if the attribute has a hard maximum A min does not have
to be present
:param maximum: (C) Return the hard maximum of the attribute's value
:param message: (C) Return true if the attribute is a message attribute
:param minExists: (C) Return true if the attribute has a hard minimum A max does not have
to be present
:param minimum: (C) Return the hard minimum of the attribute's value
:param multi: (C) Return true if the attribute is a multi-attribute
:param niceName: (C) Return the nice name (or "UI name") of the attribute
:param node: (C) Use all attributes from node named NAME
:param numberOfChildren: (C) Return the number of children the attribute has
:param range: (C) Return the hard range of the attribute's value
:param rangeExists: (C) Return true if the attribute has a hard range Both min and max
must be present
:param readable: (C) Return the readable status of the attribute
:param renderSource: (C) Return whether this attribute is marked as a render source or not
:param shortName: (C) Return the short name of the attribute
:param softMax: (C) Return the soft max (slider range) of the attribute's value
:param softMaxExists: (C) Return true if the attribute has a soft maximum A min does not
have to be present
:param softMin: (C) Return the soft min (slider range) of the attribute's value
:param softMinExists: (C) Return true if the attribute has a soft minimum A max does not
have to be present
:param softRange: (C) Return the soft range (slider range) of the attribute's value
:param softRangeExists: (C) Return true if the attribute has a soft range Both min and max
must be present
:param storable: (C) Return true if the attribute is storable
:param type: (C) Use static attributes from nodes of type TYPE Includes attributes
inherited from parent class nodes
:param typeExact: (C) Use static attributes only from nodes of type TYPE Does not included
inherited attributes
:param usedAsColor: (C) Return true if the attribute should bring up a color picker
:param usedAsFilename: (C) Return true if the attribute should bring up a file browser
:param usesMultiBuilder: (C) Return true if the attribute is a multi-attribute and it uses
the multi-builder to handle its data
:param worldspace: (C) Return the status of the attribute flag marking worldspace
attribute
:param writable: (C) Return the writable status of the attribute
:returns: when querying ranges or default values
"""
pass
def text(*args, align: Union[AnyStr, bool]="", annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, dropRectCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, font: Union[AnyStr,
bool]="", fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, hyperlink: bool=True, isObscured:
bool=True, label: Union[AnyStr, bool]="", manage: bool=True, noBackground: bool=True,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="", popupMenuArray:
bool=True, preventOverride: bool=True, recomputeSize: bool=True, statusBarMessage:
AnyStr="", useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, wordWrap: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a simple text label control
:param align: (C Q E) The label alignment Alignment values are "left", "right", and
"center" Note that the alignment will only be noticable if the control is wider than
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param dropRectCallback: (E) Adds a callback that is called when a drag and drop operation
is hovering above the drop site It returns the shape of the rectangle to be drawn to h
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param font: (C Q E) The font for the text Valid values are "boldLabelFont",
"smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont",
"oblique
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param hyperlink: (C Q E) Sets the label text to be a hyperlink if the argument is true
The label text must be a proper HTML link In MEL, double quotes in the link will most
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) The label text The default label is the name of the control
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param recomputeSize: (C Q E) If true then the control will recompute it's size to just fit
the size of the label If false then the control size will remain fixed as you change t
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:param wordWrap: (C Q) If true then label text is wrapped where necessary at word-breaks
If false, it is not wrapped at all The default value of this flag is false
:returns: Full path name to the control.
"""
pass
def nParticle(*args, attribute: Union[AnyStr, bool]="", cache: bool=True, conserve: Union[float,
bool]=0.0, count: bool=True, deleteCache: bool=True, dynamicAttrList: bool=True,
floatValue: float=0.0, gridSpacing: Union[float, List[float], bool]=0.0, inherit:
Union[float, bool]=0.0, jitterBasePoint: Union[List[float, float, float],
List[List[float, float, float]], bool]=None, jitterRadius: Union[float,
List[float], bool]=0.0, lowerLeft: Union[List[float, float, float],
List[List[float, float, float]], bool]=None, name: Union[AnyStr, bool]="",
numJitters: Union[int, List[int], bool]=0, order: Union[int, bool]=0, particleId:
Union[int, bool]=0, perParticleDouble: bool=True, perParticleVector: bool=True,
position: Union[List[float, float, float], List[List[float, float, float]]]=None,
shapeName: Union[AnyStr, bool]="", upperRight: Union[List[float, float, float],
List[List[float, float, float]], bool]=None, vectorValue: List[float, float,
float]=None, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
The nParticle command creates a new nParticle object from a list of world space points If
an nParticle object is created, the command returns the names of the new particle shape and
its associated particle object dependency node If an object was queried, the results of
the query are returned Per particle attributes can be queried using the parti
:param attribute: (Q E) Used in per particle attribute query and edit Specifies the name
of the attribute being queried or edited In query mode, this flag needs a value
:param cache: (C Q E) Turns caching on/off for the particle shape
:param conserve: (Q E) Conservation of momentum control (between 0 and 1) Specifies the
fraction of the particle shape's existing momentum which is conserved from frame to
:param count: (Q) Returns the number of particles in the object
:param deleteCache: (C) Deletes the particle shapes cache This command is not undoable
:param dynamicAttrList: (Q) Returns a list of the dynamic attributes in the object
:param floatValue: (E) Used only in per particle attribute edit Specifies that the edit is
of a float attribute and must be followed by the new float value
:param gridSpacing: (C Q M) Spacing between particles in the grid
:param inherit: (Q E) Inherit this fraction (0-1) of emitting object's velocity
:param jitterBasePoint: (C Q M) Base point (center point) for jitters The command will
create one swatch of jitters for each base point It will pair up other flags with base
point
:param jitterRadius: (C Q M) Max radius from the center to place the particle instances
:param lowerLeft: (C Q M) Lower left point of grid
:param name: (Q E) name of particle object
:param numJitters: (C Q M) Number of jitters (instances) per particle
:param order: (Q E) Used in per particle attribute query and edit Specifies the zero-based
order (index) of the particle whose attribute is being queried or edited in t
:param particleId: (Q E) Used in per particle attribute query and edit Specifies the id of
the particle whose attribute is being queried or edited Querying the value of a p
:param perParticleDouble: (Q) Returns a list of the per-particle double attributes,
excluding initial-state, cache, and information-only attributes
:param perParticleVector: (Q) Returns a list of the per-particle vector attributes,
excluding initial-state, cache, and information-only attributes
:param position: (M) World-space position of each particle
:param shapeName: (Q E) Specify the shape name used for geometry instancing DO not confuse
this with the -n flag which names the particle object
:param upperRight: (C Q M) Upper right point of grid
:param vectorValue: (E) Used only in per particle attribute edit Specifies that the edit
is of a vector attribute and must be followed by all three float values for the vec
:returns: The name of the nParticle object created
"""
pass
def PaintEffectsToPolyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeCreateContainerOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SculptPolygonsTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def toolBar(*args, allowedArea: Union[AnyStr, List[AnyStr], bool]="all", annotation:
Union[AnyStr, bool]="", area: Union[AnyStr, bool]="", backgroundColor:
Union[List[float, float, float], bool]=None, content: Union[AnyStr, bool]="",
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float, float,
float], bool]=None, isObscured: bool=True, label: Union[AnyStr, bool]="", manage:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a toolbar Tool bars are movable panel that contains a set of controls They are
placed in the tool bar area around the central control in a main window Tool bars can be
moved inside their current area, moved into new areas and floated
:param allowedArea: (C Q E M) Areas where the dock control may be placed Valid values are
"top", "left", "bottom", "right" and "all" The default is "all"
:param annotation: (C Q E) Annotate the control with an extra string value
:param area: (C Q E) The initial dock area for this dock control Valid values are "top",
"left", "bottom" and "right" This is a required flag
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param content: (C Q) The name of the control that is a content of this dock control This
is a required flag
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) The label text The default label is the name of the control
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def nexConnectCtx(*args, **kwargs)->None:
"""
"""
pass
def TimeEditorUnsoloAllTracks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def saveShelf(*args, **kwargs)->bool:
"""
This command saves the specified shelf (first argument) to the specified file (second
argument) Note that this command doesn't work well with controls that have mixed mel and
python command callbacks Also, because it saves the state to a mel file, it does not work
with callbacks that are python callable objects
:returns: True if successful.
"""
pass
def CurveUtilitiesMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyMirrorFace(*args, axis: Union[int, bool]=0, axisDirection: Union[int, bool]=1, caching:
bool=True, constructionHistory: bool=True, direction: Union[int, bool]=0,
mergeMode: Union[int, bool]=1, mergeThreshold: Union[float, bool]=0.001,
mergeThresholdType: Union[int, bool]=0, mirrorAxis: Union[int, bool]=2,
mirrorPosition: Union[float, bool]=0.0, name: AnyStr="", nodeState:
Union[int, bool]=0, pivot: Union[List[float, float, float], bool]=None,
pivotX: Union[float, bool]=0.0, pivotY: Union[float, bool]=0.0, pivotZ:
Union[float, bool]=0.0, worldSpace: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Mirror all the faces of the selected object
:param axis: (C Q E) Axis to mirror the object along Default: 0
:param axisDirection: (C Q E) Direction to mirror the object along Default: 1
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param direction: (C Q E) Direction to mirror the object along Default: 0
:param mergeMode: (C Q E) Merge mode to apply Default: 1
:param mergeThreshold: (C Q E) Tolerance to determine whether vertices should be merged
Default: 0.001
:param mergeThresholdType: (C Q E) Merge mode to apply Default: 0
:param mirrorAxis: (C Q E) Mirror axis type selection Default: 2
:param mirrorPosition: (C Q E) Custom mirror axis position Default: 0.0
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pivot: (C Q E) Pivot point of the mirror plane Default: 0.0, 0.0, 0.0
:param pivotX: (C Q E) Translation X coord
:param pivotY: (C Q E) Translation Y coord
:param pivotZ: (C Q E) Translation Z coord
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def PolyExtrudeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SendToUnrealSetProject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nodeOutliner(*args, addCommand: Union[Script, bool]=None, addObject: name=None, annotation:
Union[AnyStr, bool]="", attrAlphaOrder: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, connectivity:
Union[name, bool]=None, currentSelection: bool=True, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, fullPathName: bool=True,
height: Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, isObscured: bool=True, lastClickedNode: bool=True, lastMenuChoice:
Union[AnyStr, bool]="", longNames: bool=True, manage: bool=True, menuCommand:
Script=None, menuMultiOption: bool=True, multiSelect: bool=True, niceNames:
bool=True, noBackground: bool=True, noConnectivity: bool=True, nodesDisplayed:
bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, pressHighlightsUnconnected: bool=True,
preventOverride: bool=True, redraw: bool=True, redrawRow: bool=True, remove:
Union[AnyStr, List[AnyStr]]="", removeAll: bool=True, replace: Union[name,
bool]=None, selectCommand: Union[Script, bool]=None, showConnectedOnly:
bool=True, showHidden: bool=True, showInputs: bool=True, showNonConnectable:
bool=True, showNonKeyable: bool=True, showOutputs: bool=True, showPublished:
bool=True, showReadOnly: bool=True, statusBarMessage: AnyStr="", useTemplate:
AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script, bool]=None,
width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
The nodeOutliner command creates, edits and queries an outline control that shows
dependency nodes and their attributes Compound attributes are further expandable to show
their children Additional configure flags allow multi selection, customizable commands to
issue upon selection, and showing connections (and connectability) to a single input
at
:param addCommand: (C Q E) Command executed when the node outliner adds something String
commands use substitution of the term %node for whatever is added, eg, if you want to
:param addObject: (E) add the given object to the display
:param annotation: (C Q E) Annotate the control with an extra string value
:param attrAlphaOrder: (C Q E) Specify how attributes are to be sorted Current recognised
values are "default" for no sorting and "ascend" to sort attributes from 'a' to ''z' and
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param connectivity: (Q E) Takes an attribute argument ("nodeName.attributeName"), dims any
attributes that can't connect to the given, and highlights any attributes already co
:param currentSelection: (Q) Retruns a string array containing what is currently selected
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param lastClickedNode: (Q) Returns a string with the last clicked node
:param lastMenuChoice: (Q) Returns the text of the most recent menu selection
:param longNames: (Q E) Controls whether long or short attribute names will be used in the
interface Note that this flag is ignored if the niceNames flag is set Default is
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param menuCommand: (E) Attaches the given command to each item in the popup menu
:param menuMultiOption: (Q E) Sets whether a menu option labelled "next available" will
appear as the first option on any multi-attribute's right mouse button menu Defaults to
Tr
:param multiSelect: (Q E) Allow multiSelect; more than one thing to be selected at a time
:param niceNames: (Q E) Controls whether the attribute names will be displayed in a more
user-friendly, readable way When this is on, the longNames flag is ignored When th
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param noConnectivity: (E) Reset the node outliner to not show any connectivity, ie, redraw
all rows normally
:param nodesDisplayed: (Q) Returns a string array containing the list of nodes showing in
the node Outliner
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param pressHighlightsUnconnected: (Q E) Sets whether clicking on an unconnected plug will
select it or not Default is True
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param redraw: (E) Redraws the displayed space
:param redrawRow: (E) Redraws the given row
:param remove: (E M) remove the given object from the display
:param removeAll: (E) remove all objects from the display
:param replace: (Q E) replace what's displayed with the given objects
:param selectCommand: (Q E) Command issued by selecting Different from the c flag in that
this command will only be issued if something is selected
:param showConnectedOnly: (Q E) show (true) or hide (false) only attributes that are
connected matching input/output criteria
:param showHidden: (Q E) show (true) or hide (false) UI invisible attributes that match the
input/output criteria
:param showInputs: (Q E) show only UI visible attributes that can be connected to
:param showNonConnectable: (Q E) show (true) or hide (false) non connectable attributes
that match the input/output criteria
:param showNonKeyable: (Q E) show (true) or hide (false) non keyframeable (animatable)
attributes that match the input/output criteria
:param showOutputs: (Q E) show only UI visible attributes that can be connected from
:param showPublished: (Q E) Show only published attributes for an asset or a member of an
asset This flag is ignored on nodes not related to assets
:param showReadOnly: (Q E) show only read only attributes attributes that can be connected
from
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns:
"""
pass
def createPolySoccerBallCtx(*args, **kwargs)->None:
"""
"""
pass
def extendCurve(*args, caching: bool=True, distance: Union[float, bool]=1, extendMethod:
Union[int, bool]=0, extensionType: Union[int, bool]=0, inputPoint:
Union[List[float, float, float], bool]=None, join: bool=True, nodeState:
Union[int, bool]=0, pointX: Union[float, bool]=0, pointY: Union[float, bool]=0,
pointZ: Union[float, bool]=0, removeMultipleKnots: bool=False, start: Union[int,
bool]=1, constructionHistory: bool=True, curveOnSurface: bool=True, name:
AnyStr="", noChanges: bool=True, object: bool=True, range: bool=True,
replaceOriginal: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
This command extends a curve or creates a new curve as an extension
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param distance: (C Q E) The distance to extend Used only for extendMethod is byDistance
Default: 1
:param extendMethod: (C Q E) The method with which to extend: 0 - based on distance, 2 - to
a 3D point Default: 0
:param extensionType: (C Q E) The type of extension: 0 - linear, 1 - circular, 2 -
extrapolate Default: 0
:param inputPoint: (C Q E) The point to extend to (optional)
:param join: (C Q E) If true, join the extension to original curve Default: true
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pointX: (C Q E) X of the point to extend to Default: 0
:param pointY: (C Q E) Y of the point to extend to Default: 0
:param pointZ: (C Q E) Z of the point to extend to Default: 0
:param removeMultipleKnots: (C Q E) If true remove multiple knots at join Used only if join
is true Default: false
:param start: (C Q E) Which end of the curve to extend 0 - end, 1 - start, 2 - both
Default: 1
:param constructionHistory: (C) Turn the construction history on or off
:param curveOnSurface: (C) If possible, create 2D curve as a result
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param noChanges: (C Q E) If set then the operation node will be automatically put into
pass-through mode
:param object: (C) Create the result, or just the dependency node
:param range: (C) Force a curve range on complete input curve
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def ToggleViewCube(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fluidDeleteCacheFramesOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AnimationTurntable(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySplitRing(*args, adjustEdgeFlow: Union[float, bool]=1.0, caching: bool=True,
constructionHistory: bool=True, direction: bool=True, divisions: Union[int,
bool]=2, enableProfileCurve: bool=True, fixQuads: bool=False,
insertWithEdgeFlow: bool=False, name: AnyStr="", nodeState: Union[int,
bool]=0, profileCurveInputOffset: Union[float, bool]=0.0,
profileCurveInputScale: Union[float, bool]=1.0, profileCurve_FloatValue:
Union[float, bool]=0.0, profileCurve_Interp: Union[int, bool]=0,
profileCurve_Position: Union[float, bool]=0.0, rootEdge: Union[int, bool]=1,
smoothingAngle: Union[float, bool]=0.0, splitType: Union[int, bool]=0,
useEqualMultiplier: bool=True, useFaceNormalsAtEnds: bool=True, weight:
Union[float, bool]=0.5, worldSpace: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Splits a series of ring edges of connected quads and inserts connecting edges between them
:param adjustEdgeFlow: (C Q E) The weight value of the edge vertices to be positioned
Default: 1.0f
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param direction: (C Q E) This attribute is used when doing an absolute split If true then
the distance is taken from the start vertex of the root edge If false the distance
:param divisions: (C Q E) Number of divisions Default: 2
:param enableProfileCurve: (C Q E) Enables the use of the profile curve Default: true
:param fixQuads: (C Q E) Fixes splits which go across a quad face leaving a 5 and 3 sided
faces by splitting from the middle of the new edge to the vertex accross from the ed
:param insertWithEdgeFlow: (C Q E) True to enable edge flow Otherwise, the edge flow is
disabled Default: false
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param profileCurveInputOffset: (C Q E) Changes the offset to the multisplit profile curve
eg if the profile curve values go between 0 and 1 and this value is set to -1 then the
profile c
:param profileCurveInputScale: (C Q E) Changes the range of values that the profile curve
represents eg if the profile curve values go between 0 and 1 and this value is set to 2
then the
:param profileCurve_FloatValue: (C Q E) ?????
:param profileCurve_Interp: (C Q E) ????? Default: 0
:param profileCurve_Position: (C Q E) ?????
:param rootEdge: (C Q E) The weight attribute uses the start vertex of this edge to
determine where the new split occurs Default: -1
:param smoothingAngle: (C Q E) Angle below which new edges will be smoothed Default: kPi
:param splitType: (C Q E) Format: 0 - Absolute, 1 - Relative, 2 - Multi Default:
TdnpolySplitRing::Relative
:param useEqualMultiplier: (C Q E) Changes how the profile curve effects the offset when
doing a multisplit If true then the verts will be offset the same distance based on the
shorte
:param useFaceNormalsAtEnds: (C Q E) When doing a multisplit on a set of non-closed edge
ring this will toggle the normals at the ends of the split to be calculated as the edge
normal or
:param weight: (C Q E) Weight value controlling the relative positioning of the new points
on existing edges Range is [0.0, 1.0] Value of 0.1 indicates the new edges will
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def SculptMeshActivateBrushStrength(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def inheritTransform(*args, off: bool=True, on: bool=True, preserve: bool=True, toggle:
bool=True, q=True, query=True, **kwargs)->Union[None, Any]:
"""
This command toggles the inherit state of an object If this flag is off the object will
not inherit transformations from its parent In other words transformations applied to the
parent node will not affect the object and it will act as though it is under the world If
the -p flag is specified then the object's transformation will be modified to
:param off: (C Q) turn off inherit state for the given object(s)
:param on: (C Q) turn on inherit state for the given object(s)
:param preserve: (C Q) preserve the objects world-space position by modifying the object(s)
transformation matrix
:param toggle: (C Q) toggle the inherit state for the given object(s) (default if no flags
are given) -on turn on inherit state for the given object(s) -off turn off inhe
:returns:
"""
pass
def manipMoveContext(*args, activeHandle: Union[int, bool]=0, activeHandleNormal: Union[int,
bool]=3, alignAlong: List[float, float, float]=None, constrainAlongNormal:
bool=True, currentActiveHandle: Union[int, bool]=0, editPivotMode:
bool=True, editPivotPosition: bool=True, exists: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", interactiveUpdate: bool=True, lastMode: Union[int,
bool]=0, manipVisible: bool=True, mode: Union[int, bool]=3, orientAxes:
Union[List[float, float, float], bool]=None, orientJoint: Union[AnyStr,
bool]="", orientJointEnabled: bool=True, orientObject: AnyStr="",
orientTowards: List[float, float, float]=None, pinPivot: bool=True,
pivotOriHandle: bool=True, position: bool=True, postCommand: Script=None,
postDragCommand: List[Script, AnyStr]=None, preCommand: Script=None,
preDragCommand: List[Script, AnyStr]=None, preserveChildPosition:
bool=False, preserveUV: bool=True, reflection: bool=True, reflectionAbout:
int=0, reflectionAxis: int=0, reflectionTolerance: float=0.0,
secondaryAxisOrient: Union[AnyStr, bool]="", snap: bool=True,
snapComponentsRelative: bool=True, snapLiveFaceCenter: bool=True,
snapLivePoint: bool=True, snapPivotOri: bool=True, snapPivotPos: bool=True,
snapRelative: bool=True, snapValue: Union[float, bool]=0.0, translate:
Union[List[float, float, float], bool]=None, tweakMode: bool=True,
xformConstraint: Union[AnyStr, bool]="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create, edit, or query a move manip context Note that the
flags -s, -sv, -sr, -scr, -slp, -slf control the global behaviour of all move manip context
Changing one context independently is not allowed Changing a context's behaviour using
the above flags, will change all existing move manip context
:param activeHandle: (Q E) Sets the default active handle for the manip That is, the
handle which should be initially active when the tool is activated Values can be: 0 - X a
:param activeHandleNormal: (Q E) 0 - U axis handle is active 1 - V axis handle is active 2
- N axis handle is active ( default ) 3 - Center handle (all 3 axes) is active applicable
o
:param alignAlong: (C E) Aligns active handle along vector
:param constrainAlongNormal: (Q E) When true, transform constraints are applied along the
vertex normal first and only use the closest point when no intersection is found along the
nor
:param currentActiveHandle: (Q E) Sets the active handle for the manip Values can be: 0 -
X axis handle is active 1 - Y axis handle is active 2 - Z axis handle is active 3 - Center
h
:param editPivotMode: (Q) Returns true manipulator is in edit pivot mode
:param editPivotPosition: (Q) Returns the current position of the edit pivot manipulator
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param interactiveUpdate: (Q E) Value can be : true or false This flag value is valid only
if the mode is 3 i.e move vertex normal
:param lastMode: (Q) Returns the previous translation mode
:param manipVisible: (Q) Returns true if the main translate manipulator is visible
:param mode: (Q E) Translate mode: 0 - Object Space 1 - Local Space 2 - World Space
(default) 3 - Move Along Vertex Normal 4 - Move Along Rotation Axis 5 - Move Along L
:param orientAxes: (Q E) Orients manipulator rotating around axes by specified angles
:param orientJoint: (Q E) Specifies the type of orientation for joint orientation Valid
options are: none, xyz, xzy, yxz, yzx, zxy, zyx
:param orientJointEnabled: (Q E) Specifies if joints should be reoriented when moved
:param orientObject: (C E) Orients manipulator to the passed in object/component
:param orientTowards: (C E) Orients active handle towards world point
:param pinPivot: (Q E) Pin component pivot When the component pivot is set and pinned
selection changes will not reset the pivot position and orientation
:param pivotOriHandle: (Q E) When true, the pivot manipulator will show the orientation
handle during editing Default is true
:param position: (Q) Returns the current position of the manipulator
:param postCommand: (C E) Specifies a command to be executed when the tool is exited
:param postDragCommand: (C E) Specifies a command and a node type The command will be
executed at the end of a drag when a node of the specified type is in the selection
:param preCommand: (C E) Specifies a command to be executed when the tool is entered
:param preDragCommand: (C E) Specifies a command and a node type The command will be
executed at the start of a drag when a node of the specified type is in the selection
:param preserveChildPosition: (Q E) When false, the children objects move when their parent
is moved When true, the worldspace position of the children will be maintained as the
parent
:param preserveUV: (Q E) When false, the uvs are not changes to match the vertex edit When
true, the uvs are edited to project to new values to stop texture swimming as vert
:param reflection: () This flag is obsolete Reflection is now managed as part of selection
itself using the symmetricModeling command
:param reflectionAbout: () This flag is obsolete Reflection is now managed as part of
selection itself using the symmetricModeling command
:param reflectionAxis: () This flag is obsolete Reflection is now managed as part of
selection itself using the symmetricModeling command
:param reflectionTolerance: () This flag is obsolete Reflection is now managed as part of
selection itself using the symmetricModeling command
:param secondaryAxisOrient: (Q E) Specifies the global axis (in world coordinates) that
should be used to should be used to align the second axis of the orientJointType triple
Valid
:param snap: (Q E) Value can be : true or false Enable/Disable the discrete move If set
to true, the move manipulator of all the move contexts would snap at discrete
:param snapComponentsRelative: (Q E) Value can be : true or false If true, while snapping
a group of CVs/Vertices, the relative spacing between them will be preserved If false, all
the
:param snapLiveFaceCenter: (Q E) Value can be : true or false If true, while moving on the
live polygon object, the move manipulator will snap to the face centers of the object
:param snapLivePoint: (Q E) Value can be : true or false If true, while moving on the live
polygon object, the move manipulator will snap to the vertices of the object
:param snapPivotOri: (Q E) Snap pivot orientation Modify pivot orientation when snapping
the pivot to a component
:param snapPivotPos: (Q E) Snap pivot position Modify pivot position when snapping the
pivot to a component
:param snapRelative: (Q E) Value can be : true or false Applicable only when the snap is
enabled If true, the snapValue is treated relative to the original position before mo
:param snapValue: (Q E) Applicable only when the snap is enabled The manipulator of all
move contexts would move in steps of 'snapValue'
:param translate: (Q E) Returns the translation of the manipulator for its current
orientation/mode
:param tweakMode: (Q E) When true, the manipulator is hidden and highlighted components can
be selected and moved in one step using a click-drag interaction
:param xformConstraint: (Q E) none - no transform constraint edge - edge transform
constraint surface - surface transform constraint
:returns: The name of the new context
"""
pass
def constructionHistory(*args, toggle: bool=True, q=True, query=True, **kwargs)->Union[None,
Any]:
"""
This command turns construction history on or off
:param toggle: (C Q) Turns construction history on or off
:returns:
"""
pass
def ConformPolygonNormals(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ScaleToolWithSnapMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyAppend(*args, append: Union[List[float, float, float], List[List[float, float,
float]]]=None, constructionHistory: bool=True, edge: Union[int, List[int]]=0,
hole: Union[bool, List[bool]]=True, name: AnyStr="", point: Union[List[float,
float, float], List[List[float, float, float]]]=None, subdivision: Union[int,
bool]=1, texture: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Appends a new face to the selected polygonal object The first argument must be a border
edge The new face will be automatically closed
:param append: (C M) Appends to the given polygon object The append flag should be used
multiple times to specify the edges, points, and holes that make up the new face
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param edge: (C M) Adds the given edge of the selected object to the new face This edge
must be a border, which will be then shared by the new face and the neighboring
:param hole: (C M) Add a hole The following points and edges will define a hole Note that
this flag should be avoided in Python You may use the "append" flag instead
:param name: (C) Give a name to the resulting node
:param point: (C M) Adds a new point to the new face Coordinates of free points are given
in the local object reference Note that this flag should be avoided in Python
:param subdivision: (C Q E) This flag specifies the level of subdivisions Automatically
subdivides new edges into the given number of edges Existing edges cannot be subdivided
:param texture: (C Q E) Specifies how new faces are mapped 0 - None; 1 - Normalize; 2 -
Unitize C: Default is 0 (no mapping) Q: When queried, this flag returns an int
:returns: The node name.
"""
pass
def XgmSetSelectBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateFBIKOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CopyVertexSkinWeights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBifrostEmissionRegion(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def disconnectAttr(*args, nextAvailable: bool=True, **kwargs)->AnyStr:
"""
Disconnects two connected attributes First argument is the source attribute, second is the
destination
:param nextAvailable: (C) If the destination multi-attribute has set the indexMatters to be
false, the command will disconnect the first matching connection No index needs to
:returns: A phrase containing the names of the disconnected attributes.
"""
pass
def manipMoveLimitsCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Create a context for the translate limits manipulator
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Name of newly created context
"""
pass
def ArchiveSceneOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeviceEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleFaceNormalDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutlinerToggleShowMuteInformation(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorOpenContentBrowser(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def toggleAxis(*args, origin: bool=True, view: bool=True, q=True, query=True,
**kwargs)->Union[bool, Any]:
"""
Toggles the state of the display axis Note: the display of the axis in the bottom left
corner has been rendered obsolete by the headsUpDisplay command
:param origin: (C Q) Turns display of the axis at the origin of the ground plane on or off
:param view: (C Q) Turns display of the axis at the bottom left of each view on or off
(Obsolete - refer to the headsUpDisplay command)
:returns: if in the query mode, otherwise none.
"""
pass
def HideFur(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetNoiseBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadePinByDefault(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteHair(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_modeEdge(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorCreateAudioClip(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorCreateForEachCompound(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetDrivenKeyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePartition(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def performanceOptions(*args, clusterResolution: Union[float, bool]=0.0, disableStitch:
Union[AnyStr, bool]="", disableTrimBoundaryDisplay: Union[AnyStr,
bool]="", disableTrimDisplay: Union[AnyStr, bool]="", latticeResolution:
Union[float, bool]=0.0, passThroughBindSkinAndFlexors: Union[AnyStr,
bool]="", passThroughBlendShape: Union[AnyStr, bool]="",
passThroughCluster: Union[AnyStr, bool]="", passThroughDeltaMush:
Union[AnyStr, bool]="", passThroughFlexors: Union[AnyStr, bool]="",
passThroughLattice: Union[AnyStr, bool]="", passThroughPaintEffects:
Union[AnyStr, bool]="", passThroughSculpt: Union[AnyStr, bool]="",
passThroughWire: Union[AnyStr, bool]="", skipHierarchyTraversal:
bool=True, useClusterResolution: Union[AnyStr, bool]="",
useLatticeResolution: Union[AnyStr, bool]="", q=True, query=True,
**kwargs)->Union[AnyStr, Any]:
"""
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 d
:param clusterResolution: (Q) Sets the global cluster resolution This value may range
between 0.0 (exact calculation) and 10.0 (rough approximation)
:param disableStitch: (Q) Sets the state of stitch surface disablement Setting this to
"on" suppresses the generation of stitch surfaces Valid values are "on", "off", "inter
:param disableTrimBoundaryDisplay: (Q) Sets the state of trim boundary drawing disablement
Setting this to "on" suppresses the drawing of surface trim boundaries Valid values are
"on", "
:param disableTrimDisplay: (Q) Sets the state of trim drawing disablement Setting this to
"on" suppresses the drawing of surface trims Valid values are "on", "off", "interactive"
:param latticeResolution: (Q) Sets the global lattice resolution This value may range
between 0.0 (exact calculation) and 1.0 (rough approximation)
:param passThroughBindSkinAndFlexors: (Q) Sets the state of bind skin and all flexors pass
through Valid values are "on", "off", "interactive"
:param passThroughBlendShape: (Q) Sets the state of blend shape deformer pass through
Valid values are "on", "off", "interactive"
:param passThroughCluster: (Q) Sets the state of cluster deformer pass through Valid
values are "on", "off", "interactive"
:param passThroughDeltaMush: (Q) Sets the state of delta mush deformer pass through Valid
values are "on", "off", "interactive"
:param passThroughFlexors: (Q) Sets the state of flexor pass through Valid values are "on",
"off", "interactive"
:param passThroughLattice: (Q) Sets the state of lattice deformer pass through Valid
values are "on", "off", "interactive"
:param passThroughPaintEffects: (Q) Sets the state of paint effects pass through Valid
values are "on", "off", "interactive"
:param passThroughSculpt: (Q) Sets the state of sculpt deformer pass through Valid values
are "on", "off", "interactive"
:param passThroughWire: (Q) Sets the state of wire deformer pass through Valid values are
"on", "off", "interactive"
:param skipHierarchyTraversal: (Q) When enabled, hierarchy traversal of invisible objects
in the scene will be disabled in order to increase performance however this has a side
effect
:param useClusterResolution: (Q) Sets the state of cluster deformer global resolution This
allows clusters to be calculated at a lower resolution Valid values are "on", "off", "int
:param useLatticeResolution: (Q) Sets the state of lattice deformer global resolution This
allows lattices to be calculated at a lower resolution Valid values are "on", "off", "int
:returns: One of "on", "off", or "interactive" giving the state of the option
"""
pass
def HIKSetSelectionKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def IntersectSurfacesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleFaceNormals(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintEffectsToNurbs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DoUnghostOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TangentsStepped(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def manipScaleContext(*args, activeHandle: Union[int, bool]=0, alignAlong: List[float, float,
float]=None, constrainAlongNormal: bool=True, currentActiveHandle:
Union[int, bool]=0, editPivotMode: bool=True, editPivotPosition:
bool=True, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", lastMode:
Union[int, bool]=0, manipVisible: bool=True, mode: Union[int, bool]=3,
orientAxes: Union[List[float, float, float], bool]=None, orientObject:
AnyStr="", orientTowards: List[float, float, float]=None, pinPivot:
bool=True, pivotOriHandle: bool=True, position: bool=True, postCommand:
Script=None, postDragCommand: List[Script, AnyStr]=None, preCommand:
Script=None, preDragCommand: List[Script, AnyStr]=None,
preserveChildPosition: bool=False, preserveUV: bool=True,
preventNegativeScale: bool=True, reflection: bool=True, reflectionAbout:
int=0, reflectionAxis: int=0, reflectionTolerance: float=0.0, scale:
Union[List[float, float, float], bool]=None, snap: bool=True,
snapPivotOri: bool=True, snapPivotPos: bool=True, snapRelative: bool=True,
snapValue: Union[float, bool]=0.0, tweakMode: bool=True, useManipPivot:
bool=True, useObjectPivot: bool=True, xformConstraint: Union[AnyStr,
bool]="", q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command can be used to create, edit, or query a scale manip context
:param activeHandle: (Q E) Sets the default active handle for the manip That is, the
handle which should be initially active when the tool is activated Values can be: 0 - X a
:param alignAlong: (C E) Aligns active handle along vector
:param constrainAlongNormal: (Q E) When true, transform constraints are applied along the
vertex normal first and only use the closest point when no intersection is found along the
nor
:param currentActiveHandle: (Q E) Sets the active handle for the manip Values can be: 0 -
X axis handle is active 1 - Y axis handle is active 2 - Z axis handle is active 3 - Center
h
:param editPivotMode: (Q) Returns true manipulator is in edit pivot mode
:param editPivotPosition: (Q) Returns the current position of the edit pivot manipulator
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param lastMode: (Q) Returns the previous scaling mode
:param manipVisible: (Q) Returns true if the scale manipulator is visible
:param mode: (Q E) Scale mode: 0 - Object Space 1 - Local Space 2 - World Space (default) 3
- Scale Along Vertex Normal 4 - Scale Along Rotation Axis 5 - Scale Along Li
:param orientAxes: (Q E) Orients manipulator rotating around axes by specified angles
:param orientObject: (C E) Orients manipulator to the passed in object/component
:param orientTowards: (C E) Orients active handle towards world point
:param pinPivot: (Q E) Pin component pivot When the component pivot is set and pinned
selection changes will not reset the pivot position and orientation
:param pivotOriHandle: (Q E) When true, the pivot manipulator will show the orientation
handle during editing Default is true
:param position: (Q) Returns the current position of the manipulator
:param postCommand: (C E) Specifies a command to be executed when the tool is exited
:param postDragCommand: (C E) Specifies a command and a node type The command will be
executed at the end of a drag when a node of the specified type is in the selection
:param preCommand: (C E) Specifies a command to be executed when the tool is entered
:param preDragCommand: (C E) Specifies a command and a node type The command will be
executed at the start of a drag when a node of the specified type is in the selection
:param preserveChildPosition: (Q E) When false, the children objects move when their parent
is rotated When true, the worldspace position of the children will be maintained as the
pare
:param preserveUV: (Q E) When false, the uvs are not changes to match the vertex edit When
true, the uvs are edited to project to new values to stop texture swimming as vert
:param preventNegativeScale: (Q) When this is true, negative scale is not allowed
:param reflection: () This flag is obsolete Reflection is now managed as part of selection
itself using the symmetricModeling command
:param reflectionAbout: () This flag is obsolete Reflection is now managed as part of
selection itself using the symmetricModeling command
:param reflectionAxis: () This flag is obsolete Reflection is now managed as part of
selection itself using the symmetricModeling command
:param reflectionTolerance: () This flag is obsolete Reflection is now managed as part of
selection itself using the symmetricModeling command
:param scale: (Q E) Returns the scale of the manipulator for its current orientation/mode
:param snap: (C Q E) Specify that the manipulation is to use absolute snap
:param snapPivotOri: (Q E) Snap pivot orientation Modify pivot orientation when snapping
the pivot to a component
:param snapPivotPos: (Q E) Snap pivot position Modify pivot position when snapping the
pivot to a component
:param snapRelative: (C Q E) Specify that the manipulation is to use relative snap
:param snapValue: (C Q E) Specify the snapping value
:param tweakMode: (Q E) When true, the manipulator is hidden and highlighted components can
be selected and scaled in one step using a click-drag interaction
:param useManipPivot: (C Q E) Specify whether to pivot on the manip
:param useObjectPivot: (C Q E) Specify whether to pivot on the object
:param xformConstraint: (Q E) none - no transform constraint edge - edge transform
constraint surface - surface transform constraint
:returns: (name of the new context)
"""
pass
def DeleteConstraints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ResampleCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleNormals(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_nexCmd(*args, **kwargs)->None:
"""
"""
pass
def TimeEditorToggleMuteSelectedTracks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nBase(*args, clearCachedTextureMap: AnyStr="", clearStart: bool=True, stuffStart: bool=True,
textureToVertex: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[bool, Any]:
"""
Edits one or more nBase objects Note that nBase objects include nCloth, nRigid and
nParticle objects, but the options on this command do not currently apply to nParticle
objects
:param clearCachedTextureMap: (C E) Clear the cached texture map for the specified
attribute from the nBase
:param clearStart: (C E) Indicates that start state should be cleared
:param stuffStart: (C E) Indicates that current state should be stuffed into the start
state
:param textureToVertex: (C E) Transfer the texture map data for the specified attribute
into the related per-vertex attribute
:returns: Command result
"""
pass
def PreInfinityLinear(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SphericalProjectionOptions(*args, **kwargs)->None:
"""
unknown
"""
pass
def ConvertSelectionToEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def toggleWindowVisibility(*args, **kwargs)->None:
"""
Toggle the visibility of a window If no window is specified then the current window (most
recently created) is used See also the window command's vis/visible flag
:returns:
"""
pass
def filterExpand(*args, expand: bool=True, fullPath: bool=False, selectionMask: Union[int,
List[int]]=0, symActive: bool=True, symNegative: bool=True, symPositive:
bool=True, symSeam: bool=True, **kwargs)->List[AnyStr]:
"""
Based on selected components (or components specified on the command line), the command
filters and/or expands the list given the options Returns a string array containing all
matching selection items Selection masks are as follows: Object Type Mask Handle 0 Nurbs
Curves 9 Nurbs Surfaces 10 Nurbs Curves On Surface 11 Polygon 12 Locator XYZ 22 Or
:param expand: (C) Each item is a single entity if this is true Default is true
:param fullPath: (C) If this is true and the selection item is a DAG object, return its
full selection path, instead of the name of the object only when this value is fal
:param selectionMask: (C M) Specify the selection mask
:param symActive: (C) If symmetry is enabled only return the components on the active
symmetry side of the object This flag has no effect if symmetry is not active
:param symNegative: (C) If symmetry is enabled only return the components on the negative
side of the object relative to the current symmetry plane This flag has no effect
:param symPositive: (C) If symmetry is enabled only return the components on the positive
side of the object relative to the current symmetry plane This flag has no effect
:param symSeam: (C) If symmetry is enabled only return the components that lie equally on
both sides of the object relative to the current symmetry plane This flag has
:returns: Command result
"""
pass
def TagAsControllerParent(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TemplateBrushSettings(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ReorderVertex(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ctxAbort(*args, **kwargs)->None:
"""
This command tells the current context to reset itself, losing what has been done so far
If a escape context has been set it then makes that context current
:returns:
"""
pass
def AddDivisionsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def colorManagementCatalog(*args, addTransform: AnyStr="", editUserTransformPath: AnyStr="",
listSupportedExtensions: bool=True, listTransformConnections:
bool=True, path: AnyStr="", queryUserTransformPath: bool=True,
removeTransform: AnyStr="", transformConnection: AnyStr="", type:
AnyStr="", **kwargs)->None:
"""
This non-undoable action performs additions and removals of custom color transforms from
the Autodesk native color transform catalog Once a custom color transform has been added
to the catalog, it can be used in the same way as the builtin Autodesk native color
transforms
:param addTransform: (C) Add transform to collection
:param editUserTransformPath: (C) Edit the user transform directory By changing the
directory, all custom transforms currently added could be changed, and new ones could
appear
:param listSupportedExtensions: (C) List the file extensions that are supported by add
transform This list is valid for all transform types, and therefore this flag does not
require us
:param listTransformConnections: (C) List the transforms that can be used as source (for
"view" and "output" types) or destination (for "input" and "rendering space" types) to
connect a
:param path: (C) In addTransform mode, the path to the transform data file
:param queryUserTransformPath: (C) Query the user transform directory
:param removeTransform: (C) Remove transform from collection
:param transformConnection: (C) In addTransform mode, an existing transform to which the
added transform will be connected For an input transform or rendering space transform,
this
:param type: (C) The type of transform added, removed, or whose transform connections are
to be listed Must be one of "view", "rendering space", "input", or "output"
:returns:
"""
pass
def FBXExportConvertUnitString(*args, **kwargs)->None:
"""
"""
pass
def NodeEditorExtendToShapes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def U3DBrushSizeOn(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyCut(*args, caching: bool=True, constructionHistory: bool=True, cutPlaneCenter:
Union[List[float, float, float], bool]=None, cutPlaneCenterX: Union[float,
bool]=0.0, cutPlaneCenterY: Union[float, bool]=0.0, cutPlaneCenterZ: Union[float,
bool]=0.0, cutPlaneHeight: Union[float, bool]=0.0, cutPlaneRotate: Union[List[float,
float, float], bool]=None, cutPlaneRotateX: Union[float, bool]=0.0,
cutPlaneRotateY: Union[float, bool]=0.0, cutPlaneRotateZ: Union[float, bool]=0.0,
cutPlaneSize: Union[List[float, float], bool]=None, cutPlaneWidth: Union[float,
bool]=0.0, cuttingDirection: AnyStr="", deleteFaces: bool=False, extractFaces:
bool=False, extractOffset: Union[List[float, float, float], bool]=None,
extractOffsetX: Union[float, bool]=0.0, extractOffsetY: Union[float, bool]=0.0,
extractOffsetZ: Union[float, bool]=0.0, name: AnyStr="", nodeState: Union[int,
bool]=0, onObject: bool=True, worldSpace: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command splits a mesh, or a set of poly faces, along a plane The position and
orientation of the plane can be adjusted using the appropriate flags listed above In
addition, the cut operation can also delete the faces lying on one side of the cutting
plane, or extract those faces by an offset amount
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param cutPlaneCenter: (C Q E) The position of the cutting plane Default: 0.0, 0.0, 0.0
:param cutPlaneCenterX: (C Q E) Cutting plane center X coord
:param cutPlaneCenterY: (C Q E) Cutting plane center Y coord
:param cutPlaneCenterZ: (C Q E) Cutting plane center Z coord
:param cutPlaneHeight: (C Q E) The height of the cutting plane
:param cutPlaneRotate: (C Q E) The orientation of the cutting plane Default: 0.0, 0.0,
0.0
:param cutPlaneRotateX: (C Q E) cutting plane X rotate angle
:param cutPlaneRotateY: (C Q E) cutting plane Y rotate angle
:param cutPlaneRotateZ: (C Q E) cutting plane Z rotate angle
:param cutPlaneSize: (C Q E) The width and the height of the cutting plane Default: 1.0,
1.0
:param cutPlaneWidth: (C Q E) The width of the cutting plane
:param cuttingDirection: (C) This flag specifies the direction of the cutting plane Valid
values are "x", "y", "z" A value of "x" will cut the object along the YZ plane cutting
:param deleteFaces: (C Q E) whether to delete the one-half of the cut-faces of the poly If
true, they are deleted Default: false
:param extractFaces: (C Q E) whether to extract the cut-faces of the poly into a separate
shell If true, they are extracted Default: false
:param extractOffset: (C Q E) The displacement offset of the cut faces Default: 0.5, 0.5,
0.5
:param extractOffsetX: (C Q E) The X-displacement offset of the cut faces
:param extractOffsetY: (C Q E) The Y-displacement offset of the cut faces
:param extractOffsetZ: (C Q E) The Z-displacement offset of the cut faces
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param onObject: (C Q E) whether to act on the entire polyObject or its selected face
components Default: true
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def vnnPaste(*args, **kwargs)->None:
"""
"""
pass
def retimeKeyCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", moveByFrame:
int=0, name: AnyStr="", snapOnFrame: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[bool, Any]:
"""
This command creates a context which may be used to scale keyframes within the graph editor
using the retime tool
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param moveByFrame: (E) Move the selected retime bar by the specified number of frames
:param name: (C) If this is a tool command, name the tool appropriately
:param snapOnFrame: (Q E) When set, the retime markers will snap on frames as they are
moved
:returns: Query value from the snapOnFame setting.
"""
pass
def CreateNURBSSphereOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeImport(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def listAttr(*args, array: bool=True, caching: bool=True, category: Union[AnyStr,
List[AnyStr]]="", changedSinceFileOpen: bool=True, channelBox: bool=True,
connectable: bool=True, extension: bool=True, fromPlugin: bool=True, hasData:
bool=True, hasNullData: bool=True, inUse: bool=True, keyable: bool=True, leaf:
bool=True, locked: bool=True, multi: bool=True, output: bool=True, ramp: bool=True,
read: bool=True, readOnly: bool=True, scalar: bool=True, scalarAndArray: bool=True,
settable: bool=True, shortNames: bool=True, string: Union[AnyStr, List[AnyStr]]="",
unlocked: bool=True, usedAsFilename: bool=True, userDefined: bool=True, visible:
bool=True, write: bool=True, **kwargs)->List[AnyStr]:
"""
This command lists the attributes of a node If no flags are specified all attributes are
listed
:param array: (C) only list array (not multi) attributes
:param caching: (C) only show attributes that are cached internally
:param category: (C M) only show attributes belonging to the given category Category
string can be a regular expression
:param changedSinceFileOpen: (C) Only list the attributes that have been changed since the
file they came from was opened Typically useful only for objects/attributes coming from
re
:param channelBox: (C) only show non-keyable attributes that appear in the channelbox
:param connectable: (C) only show connectable attributes
:param extension: (C) list user-defined attributes for all nodes of this type (extension
attributes)
:param fromPlugin: (C) only show attributes that were created by a plugin
:param hasData: (C) list only attributes that have data (all attributes except for message
attributes)
:param hasNullData: (C) list only attributes that have null data This will list all
attributes that have data (see hasData flag) but the data value is uninitialized A comm
:param inUse: (C) only show attributes that are currently marked as in use This flag
indicates that an attribute affects the scene data in some way For example it ha
:param keyable: (C) only show attributes that can be keyframed
:param leaf: (C) Only list the leaf-level name of the attribute controlPoints[44].xValue
would be listed as "xValue"
:param locked: (C) list only attributes which are locked
:param multi: (C) list each currently existing element of a multi-attribute
:param output: (C) List only the attributes which are numeric or which are compounds of
numeric attributes
:param ramp: (C) list only attributes which are ramps
:param read: (C) list only attributes which are readable
:param readOnly: (C) List only the attributes which are readable and not writable
:param scalar: (C) only list scalar numerical attributes
:param scalarAndArray: (C) only list scalar and array attributes
:param settable: (C) list attribute which are settable
:param shortNames: (C) list short attribute names (default is to list long names)
:param string: (C M) List only the attributes that match the other criteria AND match the
string(s) passed from this flag String can be a regular expression
:param unlocked: (C) list only attributes which are unlocked
:param usedAsFilename: (C) list only attributes which are designated to be treated as
filenames
:param userDefined: (C) list user-defined (dynamic) attributes
:param visible: (C) only show visible or non-hidden attributes
:param write: (C) list only attributes which are writable
:returns: : List of attributes matching criteria
"""
pass
def OutlinerToggleNamespace(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateFluidCacheOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshGrabTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Gravity(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleDisplacement(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowModelingUI(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshFoamyTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetFocusToNumericInputLine(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OneClickExecute(*args, **kwargs)->None:
"""
"""
pass
def bifSaveFrame(*args, **kwargs)->None:
"""
"""
pass
def HypershadeOpenRenderViewWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def curveRGBColor(*args, hueSaturationValue: bool=True, list: bool=True, listNames: bool=True,
remove: bool=True, resetToFactory: bool=True, resetToSaved: bool=True, q=True,
query=True, **kwargs)->Union[List[float], Any]:
"""
This command creates, changes or removes custom curve colors, which are used to draw the
curves in the Graph Editor The custom curve names may contain the wildcards "?", which
marches a single character, and "*", which matches any number of characters These colors
are part of the UI and not part of the saved data for a model This command is not
:param hueSaturationValue: (C Q) Indicates that rgb values are really hsv values
:param list: (C) Writes out a list of all curve color names and their values
:param listNames: (C) Returns an array of all curve color names
:param remove: (C) Removes the named curve color
:param resetToFactory: (C) Resets all the curve colors to their factory defaults
:param resetToSaved: (C) Resets all the curve colors to their saved values
:returns: HSV values from querying the hsv flag
"""
pass
def symbolButton(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, command: Union[Script, bool]=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dropCallback: Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, fullPathName: bool=True,
height: Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, image: Union[AnyStr, bool]="", isObscured: bool=True, manage:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a symbol button A symbol button behaves like a regular button, the
only difference is a symbol button displays an image rather that a text label A command
may be attached to the button which will be executed when the button is pressed
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param command: (C Q E) Command executed when the symbol button is pressed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param image: (C Q E) Image for the button
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def dgdirty(*args, allPlugs: bool=True, clean: bool=True, implicit: bool=True, list:
Union[AnyStr, bool]="", propagation: bool=True, showTiming: bool=True, verbose:
bool=True, q=True, query=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The dgdirty command is used to force a dependency graph dirty message on a node or plug
Used for debugging to find evaluation problems If no nodes are specified then the current
selection list is used If the list flag is used it will return the list of things
currently marked as dirty (or clean if the clean flag was also used) The returned valu
:param allPlugs: (C Q) Ignore the selected or specified objects and dirty (or clean) all
plugs
:param clean: (C Q) If this flag is set then the attributes are cleaned Otherwise they are
set to dirty
:param implicit: (C Q) If this flag is set then allow the implicit or default nodes to be
processed as well Otherwise they will be skipped for efficiency
:param list: (C Q) When this flag is specified then instead of sending out dirty/clean
messages the list of currently dirty/clean objects will be returned The allPlugs
:param propagation: (C Q) If this flag is set then the ability of dirty messages to flow
through the graph is left enabled
:param showTiming: (C Q) If this flag is used then show how long the dirty messages took to
propagate
:param verbose: (C Q) Prints out all of the plugs being set dirty on stdout
:returns: List of dirty/clean plugs in list plug mode.
"""
pass
def ConvertSelectionToUVShellBorder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OneClickDisconnect(*args, **kwargs)->None:
"""
"""
pass
def iGroom(*args, **kwargs)->None:
"""
"""
pass
def BestPlaneTexturingTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmWidthBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def SetFluidAttrFromCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def subdMatchTopology(*args, frontOfChain: bool=True, **kwargs)->bool:
"""
Command matches topology across multiple subdiv surfaces - at all levels
:param frontOfChain: (C) This command is used to specify that the new addTopology node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's hi
:returns: Success or Failure.
"""
pass
def XgExportArchive(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def uniform(*args, attenuation: Union[float, bool]=0.0, directionX: Union[float, bool]=0.0,
directionY: Union[float, bool]=0.0, directionZ: Union[float, bool]=0.0, magnitude:
Union[float, bool]=0.0, maxDistance: Union[float, bool]=0.0, name: Union[AnyStr,
bool]="", perVertex: bool=True, position: Union[List[float, float, float],
List[List[float, float, float]], bool]=None, torusSectionRadius: Union[float,
bool]=0.0, volumeExclusion: bool=True, volumeOffset: Union[List[float, float,
float], bool]=None, volumeShape: Union[AnyStr, bool]="", volumeSweep: Union[float,
bool]=0.0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
For each listed object, the command creates a new field The field has a shape which lives
in the DAG and it has an associated dependency node The field is added to the list of
fields owned by the object Use connectDynamic to cause the field to affect a dynamic
object Note that if more than one object is listed, a separate field is created for e
:param attenuation: (Q E) Attentuation rate of field
:param directionX: (Q E) X-component of direction
:param directionY: (Q E) Y-component of direction
:param directionZ: (Q E) Z-component of direction
:param magnitude: (Q E) Strength of field
:param maxDistance: (Q E) Maximum distance at which field is exerted -1 indicates that the
field has no maximum distance
:param name: (Q E) name of field
:param perVertex: (Q E) Per-vertex application If this flag is set true, then each
individual point (CV, particle, vertex,etc.) of the chosen object exerts an identical cop
:param position: (Q E M) Position in space (x,y,z) where you want to place a gravity field
The gravity then emanates from this position in space rather than from an object
:param torusSectionRadius: (Q E) Section radius for a torus volume Applies only to torus
Similar to the section radius in the torus modelling primitive
:param volumeExclusion: (Q E) Volume exclusion of the field If true, points outside the
volume (defined by the volume shape attribute) are affected, If false, points inside the v
:param volumeOffset: (Q E) Volume offset of the field Volume offset translates the field's
volume by the specified amount from the actual field location This is in the field'
:param volumeShape: (Q E) Volume shape of the field Sets/edits/queries the field's volume
shape attribute If set to any value other than "none", determines a 3-D volume with
:param volumeSweep: (Q E) Volume sweep of the field Applies only to sphere, cone, cylinder,
and torus Similar effect to the sweep attribute in modelling
:returns: Command result
"""
pass
def ViewAlongAxisNegativeZ(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ViewAlongAxisNegativeX(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeSelectConnected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorCreateAnimTracksAtEnd(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeOpenBinsWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_SetBakeFormat(*args, **kwargs)->None:
"""
"""
pass
def SelectPolygonToolMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def blend2(*args, autoAnchor: bool=True, autoNormal: bool=True, caching: bool=True,
flipLeftNormal: bool=False, flipRightNormal: bool=False, leftAnchor: Union[float,
bool]=0.0, leftEnd: Union[float, bool]=1.0, leftStart: Union[float, bool]=0.0,
multipleKnots: bool=True, nodeState: Union[int, bool]=0, positionTolerance:
Union[float, bool]=0.1, reverseLeft: bool=False, reverseRight: bool=False,
rightAnchor: Union[float, bool]=0.0, rightEnd: Union[float, bool]=1.0, rightStart:
Union[float, bool]=0.0, tangentTolerance: Union[float, bool]=0.1,
constructionHistory: bool=True, crvsInFirstRail: Union[int, bool]=0, name: AnyStr="",
object: bool=True, polygon: int=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
This command creates a surface by blending between given curves This is an enhancement
(more user control) compared to blend which is now obsolete
:param autoAnchor: (C Q E) If true and both paths are closed, automatically determine the
value on the right rail so that they match Default: true
:param autoNormal: (C Q E) If true, the direction of each starting tangent is computed
based on given geometry Default: true
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param flipLeftNormal: (C Q E) If true, flip the starting tangent off the left boundary
Default: false
:param flipRightNormal: (C Q E) If true, flip the starting tangent off the right boundary
Default: false
:param leftAnchor: (C Q E) The reference parameter on the left boundary where the blend
surface starts in the case of the closed rail Default: 0.0
:param leftEnd: (C Q E) The reference parameter on the left boundary where the blend
surface ends Default: 1.0
:param leftStart: (C Q E) The reference parameter on the left boundary where the blend
surface starts Default: 0.0
:param multipleKnots: (C Q E) If true, use the new blend which produces fully multiple
interior knots Default: true
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param positionTolerance: (C Q E) The positional C(0) tolerance of the blend surface to the
adjacent surfaces Default: 0.1
:param reverseLeft: (C Q E) If true, reverse the direction off the left boundary
autoDirection must be false for this value to be considered Default: false
:param reverseRight: (C Q E) If true, reverse the direction of the right boundary
autoDirection must be false for this value to be considered Default: false
:param rightAnchor: (C Q E) The reference parameter on the right boundary where the blend
surface starts in the case of the closed rail Default: 0.0
:param rightEnd: (C Q E) The reference parameter on the right boundary where the blend
surface ends Default: 1.0
:param rightStart: (C Q E) The reference parameter on the right boundary where the blend
surface starts Default: 0.0
:param tangentTolerance: (C Q E) The tangent G(1) continuity tolerance of the blend surface
to the adjacent surfaces Default: 0.1
:param constructionHistory: (C) Turn the construction history on or off
:param crvsInFirstRail: (C Q E) Number of curves in the first rail of the blend
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:returns: Object name and node name
"""
pass
def HypershadeAddOnNodeCreate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def pose(*args, allPoses: bool=True, apply: bool=True, name: Union[AnyStr, bool]="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command is used to create character poses
:param allPoses: (Q) This flag is used to query all the poses in the scene
:param apply: (C) This flag is used in conjunction with the name flag to specify a pose
should be applied to the character
:param name: (C Q) In create mode, specify the pose name In query mode, return a list of
all the poses for the character In apply mode, specify the pose to be applied
:returns: Pose name
"""
pass
def AddToCharacterSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TwoPointArcTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def WedgePolygonOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setStartupMessage(*args, **kwargs)->None:
"""
Update the startup window message Also know as the 'Splash Screen', this is the window
that appears while the application is starting up
:returns:
"""
pass
def PrelightPolygonOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeDuplicateShadingNetwork(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowLattices(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVSphericalProjectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HIKPinTranslate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddFaceDivisionsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def keyframeOutliner(*args, animCurve: AnyStr="", annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None,
defineTemplate: AnyStr="", display: Union[AnyStr, bool]="", docTag:
Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, fullPathName: bool=True,
height: Union[int, bool]=0, highlightColor: Union[List[float, float,
float], bool]=None, isObscured: bool=True, manage: bool=True,
noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates/edits/queries a keyframe outliner control
:param animCurve: (E) Name of the animation curve for which to display keyframes
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param display: (Q E) narrow | wide What columns to display When "narrow", time and value
will be displayed, when "wide" tangent information will be displayed as well
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the outliner control.
"""
pass
def shelfLayout(*args, alignment: Union[AnyStr, bool]="", annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, cellHeight:
Union[int, bool]=0, cellWidth: Union[int, bool]=0, cellWidthHeight:
Union[List[int, int], bool]=None, childArray: bool=True, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dropCallback: Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, fullPathName: bool=True,
height: Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, horizontal: bool=True, isObscured: bool=True, ltVersion:
Union[AnyStr, bool]="", manage: bool=True, noBackground: bool=True,
numberOfChildren: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, position: Union[List[AnyStr,
int], List[List[AnyStr, int]]]=None, preventOverride: bool=True, spacing:
Union[int, bool]=0, statusBarMessage: AnyStr="", style: Union[AnyStr, bool]="",
useTemplate: AnyStr="", version: Union[AnyStr, bool]="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a new empty shelf layout The shelf layout can accept drops of
commands scripts Use the addNewShelfTab MEL command to add a shelf to the top level
shelves
:param alignment: (C Q E) Sets the alignment of the buttons in the layout When horizontal
is true, valid options are "left" and "right" When horizontal is false, valid optio
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param cellHeight: (C Q E) Set or query the height of the items in the shelf
:param cellWidth: (C Q E) Set or query the width of the items in the shelf
:param cellWidthHeight: (C Q E) Set the width and height of the items in the shelf
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param horizontal: (C Q E) Orientation of the layout This flag is true by default, which
corresponds to a horizontally laid out shelf
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param ltVersion: (C Q E) This flag is used to specify the Maya LT version that this
control feature was introduced, if the version flag is not specified, or if the version fl
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param position: (C E M) Specify the name of a child control in the grid layout along with
a 1-based integer value indicating the desired position of the child Positions inc
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param spacing: (C Q E) Sets the space between children
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param style: (C Q E) Set or query the current style of the items in the shelf Valid
styles are "iconOnly", "textOnly", "iconAndTextHorizontal" and "iconAndTextVertical"
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param version: (C Q E) Specify the version that this feature was introduced The argument
should be given as a string of the version number (e.g "2014", "2015") Currently
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the layout.
"""
pass
def CreateWrap(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphEditorStackedView(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_selectRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmFreezeBrushContext(*args, **kwargs)->None:
"""
"""
pass
def HypershadeTransferAttributeValuesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BrushPresetBlendOff(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def targetWeldCtx(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", mergeToCenter:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[None,
Any]:
"""
Create a new context to weld vertices together on a poly object
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param mergeToCenter: (C Q E) If mergeToCenter is set to true then the source and target
vertices's will be moved to the center before doing the merge If set to false the source
:returns:
"""
pass
def PolygonBooleanIntersection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyHole(*args, assignHole: bool=True, createHistory: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[bool, Any]:
"""
Command to set and clear holes on given faces
:param assignHole: (C Q E) Assign the selected faces to be hole or unassign the hole faces
to be non-hole By default, the command will assign faces to be hole
:param createHistory: (C Q E) For objects that have no construction history, this flag can
be used to force the creation of construction history for hole By default, history is n
:returns: Success or Failure.
"""
pass
def SpreadSheetEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXRead(*args, **kwargs)->None:
"""
"""
pass
def commandPort(*args, bufferSize: int=0, close: bool=True, echoOutput: bool=True, listPorts:
bool=True, name: AnyStr="", noreturn: bool=True, pickleOutput: bool=True,
prefix: AnyStr="", returnNumCommands: bool=True, securityWarning: bool=True,
sourceType: AnyStr="", q=True, query=True, **kwargs)->Union[bool, Any]:
"""
Opens or closes the Maya command port The command port comprises a socket to which a
client program may connect An example command port client "mcp" is included in the Motion
Capture developers kit It supports multi-byte commands and uses utf-8 as its transform
format It will receive utf8 command string and decode it to Maya native coding The
:param bufferSize: (C) Commands and results are each subject to size limits This option
allows the user to specify the size of the buffer used to communicate with Maya If
:param close: (C) Closes the commandPort, deletes the pipes
:param echoOutput: (C) Sends a copy of all command output to the command port Typically
only the result is transmitted This option provides a copy of all output
:param listPorts: (C) Returns the available ports
:param name: (C) Specifies the name of the command port which this command creates
CommandPort names of the form name create a UNIX domain socket on the localhost co
:param noreturn: (C) Do not write the results from executed commands back to the command
port socket Instead, the results from executed commands are written to the scrip
:param pickleOutput: (C) Python output will be pickled
:param prefix: (C) The string argument is the name of a Maya command taking one string
argument This command is called each time data is sent to the command port The
:param returnNumCommands: (C) Ignore the result of the command, but return the number of
commands that have been read and executed in this call This is a simple way to track buff
:param securityWarning: (C) Enables security warning on command port input
:param sourceType: (C) The string argument is used to indicate which source type would be
passed to the commandPort, like "mel", "python" The default source type is "mel"
:returns: - in query mode
"""
pass
def PublishConnections(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_rotatePress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RandomizeShellsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_pointSnapRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ArtPaintBlendShapeWeightsToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def muMessageDelete(*args, **kwargs)->None:
"""
"""
pass
def PartitionEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorClipHoldToggle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def geometryReplaceCacheOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeCloseAllTabs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def panelConfiguration(*args, addPanel: Union[List[bool, AnyStr, AnyStr, AnyStr, AnyStr],
List[List[bool, AnyStr, AnyStr, AnyStr, AnyStr]]]=None, configString:
Union[AnyStr, bool]="", createStrings: bool=True, defaultImage:
Union[AnyStr, bool]="", defineTemplate: AnyStr="", editStrings:
bool=True, exists: bool=True, image: Union[AnyStr, bool]="",
isFixedState: bool=True, label: Union[AnyStr, bool]="", labelStrings:
bool=True, numberOfPanels: bool=True, removeAllPanels: bool=True,
removeLastPanel: bool=True, replaceCreateString: List[int, AnyStr]=None,
replaceEditString: List[int, AnyStr]=None, replaceFixedState: List[int,
bool]=None, replaceLabel: List[int, AnyStr]=None, replacePanel: List[int,
bool, AnyStr, AnyStr, AnyStr, AnyStr]=None, replaceTypeString: List[int,
AnyStr]=None, sceneConfig: bool=True, typeStrings: bool=True,
useTemplate: AnyStr="", userCreated: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a panel configuration object Typically you would not call this method
command directly Instead use the Panel Editor Once a panel configuration is created you
can make it appear in the main Maya window by selecting it from any panel's "Panels->Saved
Layouts" menu
:param addPanel: (C E M) Adds the specified panel to the configuration Arguments are:
isFixed, label string, type string, create string, edit string
:param configString: (C Q E) Specifies the string that arranges the panels
:param createStrings: (Q) Returns an string array of the panel creation strings
:param defaultImage: (C Q) The default image for this configuration Once the default image
is set it may not be changed If an image is set with the -i/image flag then it's va
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param editStrings: (Q) Returns an string array of the panel edit strings
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param image: (C Q E) The user specified image for this configuration Use this flag to
override the default image
:param isFixedState: (Q) Returns an integer array of whether the panels have fixed states
or not
:param label: (C Q E) Configuration label
:param labelStrings: (Q) Returns an string array of the panel labels
:param numberOfPanels: (Q) Returns the number of panels in the configuration
:param removeAllPanels: (E) Removes the last panel in the config
:param removeLastPanel: (E) Removes the last panel in the config
:param replaceCreateString: (E) Replaces the specified create string The index is 1 based
:param replaceEditString: (E) Replaces the specified edit string The index is 1 based
:param replaceFixedState: (E) Replaces the specified fixed state value (true|false) The
index is 1 based
:param replaceLabel: (E) Replaces the specified label The index is 1 based
:param replacePanel: (C E) Replaces the specified panel in the configuration Arguments
are: index, isFixed, label string, type string, create string, edit string The index is
:param replaceTypeString: (E) Replaces the specified type string The index is 1 based
:param sceneConfig: (C Q E) Specifies whether the configuration is associated with the
scene Scene configurations are created when the scene is opened and deleted when the scen
:param typeStrings: (Q) Returns an string array of the panel types
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param userCreated: (C Q E) Returns true if the configuration was created by the user If
it is user created, the configuration will show up in the RMB menu in the toolbox's sav
:returns: The name of the panelConfiguration created.
"""
pass
def ArcLengthTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cycleCheck(*args, all: bool=True, children: bool=True, dag: bool=True, evaluation:
bool=True, firstCycleOnly: bool=True, firstPlugPerNode: bool=True,
lastPlugPerNode: bool=True, list: bool=True, listSeparator: AnyStr="", parents:
bool=True, secondary: bool=True, timeLimit: time=None, q=True, query=True,
**kwargs)->Union[bool, Any]:
"""
This command searches for plug cycles in the dependency graph If a plug or node is
selected then it searches for cycles that that plug or node is involved with Plugs or
nodes can also be passed as arguments If the -all flag is used then the entire graph is
searched Normally the return value is a boolean indicating whether or not the given item
:param all: (C) search the entire graph for cycles instead of the selection list (Note: if
nothing is selected, -all is assumed)
:param children: (C) Do not consider cycles on the children, only the specified plugs
:param dag: (C) Also look for cycles due to relationships in the DAG For each DAG node,
the parenting connection on its children is also considered when searching f
:param evaluation: (C Q) Turn on and off cycle detection during graph evaluation
:param firstCycleOnly: (C) When -list is used to return a plug list, the list may contain
multiple cycles or partial cycles When -firstCycleOnly is specified only the first su
:param firstPlugPerNode: (C) When -list is used to return a plug list, the list will
typically contain multiple plugs per node (e.g .. A.output B.input B.output C.input ...),
r
:param lastPlugPerNode: (C) When -list is used to return a plug list, the list will
typically contain multiple plugs per node (e.g .. A.output B.input B.output C.input ...),
r
:param list: (C) Return all plugs involved in one or more cycles If not specified, returns
a boolean indicating whether a cycle exists
:param listSeparator: (C) When -list is used to return a plug list, the list may contain
multiple cycles or partial cycles Use -listSeparator to specify a string that will be
:param parents: (C) Do not consider cycles on the parents, only the specified plugs
:param secondary: (C) Look for cycles on related plugs as well as the specified plugs
Default is "on" for the "-all" case and "off" for others
:param timeLimit: (C) Limit the search to the given amount of time
:returns: in the general case.
"""
pass
def xgmDirectionBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def SendAsNewScenePrintStudio(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModifyOpacityPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Import(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dynExpression(*args, creation: bool=True, name: Union[AnyStr, bool]="", runtime: bool=True,
runtimeAfterDynamics: bool=True, runtimeBeforeDynamics: bool=True, string:
AnyStr="", q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command describes an expression that belongs to the specified particle shape The
expression is a block of code of unlimited length with a C-like syntax that can perform
conversions, mathematical operations, and logical decision making on any numeric
attribute(s) or per-particle attribute(s) in the scene One expression can read and alter
any
:param creation: (C Q E) Tells the command that the string passed will be a creation
expression for the particle shape This means that this expression will be executed when
:param name: (C Q E) Name to use for this command
:param runtime: (C Q E) Tells the command that the string passed will be a runtime
expression for the particle shape This expression will be executed at the beginning of ru
:param runtimeAfterDynamics: (C Q E) Tells the command that the string passed will be a
runtime expression for the particle shape This expression will be executed after dynamics
wheneve
:param runtimeBeforeDynamics: (C Q E) Tells the command that the string passed will be a
runtime expression for the particle shape This expression will be executed before dynamics
whenev
:param string: (C E) Set the expression string This is queriable with the -q/query flag
and the -rbd/runtimeBeforeDynamics, the -rab/runtimeAfterDynamics or the -c/creat
:returns: The particle shape which this expression belongs to
"""
pass
def nClothCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def renderSetupFind(*args, **kwargs)->None:
"""
"""
pass
def AssignOfflineFileFromRefEd(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PreviousGreasePencilFrame(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hyperShade(*args, assign: AnyStr="", clearWorkArea: bool=True, collapse: AnyStr="",
createNode: AnyStr="", dependGraphArea: bool=True, downStream: bool=True,
duplicate: bool=True, fixRenderSize: bool=True, incremental: bool=True,
listDownstreamNodes: name=None, listDownstreamShaderNodes: name=None,
listUpstreamNodes: name=None, name: AnyStr="", networks: bool=True, noSGShapes:
bool=True, noShapes: bool=True, noTransforms: bool=True, objects: AnyStr="",
renderCreateAndDrop: AnyStr="", reset: bool=True, resetGraph: bool=True,
resetSwatch: bool=True, setAllowsRegraphing: bool=True, setWorkArea: AnyStr="",
shaderNetwork: AnyStr="", shaderNetworks: bool=True,
shaderNetworksSelectMaterialNodes: bool=True, snapShot: bool=True, uncollapse:
AnyStr="", upStream: bool=True, userDefinedLayout: bool=True, workAreaAddCmd:
AnyStr="", workAreaDeleteCmd: AnyStr="", workAreaSelectCmd: AnyStr="",
**kwargs)->AnyStr:
"""
Commands for shader editing in the hypergraph
:param assign: (C) Assign the specified shader node to renderable objects on the active
list The node can either be a shading group or the shader node attached to the
:param clearWorkArea: (C) Push the current work area on to the stack and create a clear
work area
:param collapse: (C) Hide the upstream nodes from the specified node
:param createNode: (C) Create a node of the specified type This is called when a new
rendering node is created using drag and drop from the image browser or from the RMB c
:param dependGraphArea: (C) When setting a work area, and the work area doesn't already
exist this flag inicates a new graph should be created that is either a depend graph or a
:param downStream: (C) Show nodes downstream from the specified node
:param duplicate: (C) Duplicate upstream nodes If the node is a shader make sure duplicate
include the shading group if there is one
:param fixRenderSize: (C) If set to true dont rerender swatches when they change size as
the user zooms
:param incremental: (C) Enable or disable incremental layout when making new nodes or
connections
:param listDownstreamNodes: (C) List all the downstream render nodes from the specified
nodes
:param listDownstreamShaderNodes: (C) List all the downstream shader nodes from the
specified nodes
:param listUpstreamNodes: (C) List all the upstream render nodes from the specified nodes
:param name: (C) Name for the work area created by this command
:param networks: (C) Do an incremental layout on all of the nodes in the current selection
list and that are in the current work area
:param noSGShapes: (C) Display only shapes that are connected to nodes in the network other
than a shading group
:param noShapes: (C) Display no shapes when graphing networks
:param noTransforms: (C) Display no transforms when graphing networks
:param objects: (C) Select the objects which are attached to the specified shader node The
shader node can be either the shading group or the shader attached to the sha
:param renderCreateAndDrop: (C) Create a render node of the specified type and put user
into drag and drop mode to place or connect it
:param reset: (C) Reset the Hypershade panel to its initial state In particular delete all
the work areas
:param resetGraph: (C) Reset the current graph Typically called prior to rebuilding a
folder in a Hypershade view
:param resetSwatch: (C) For all selected nodes remove user defined swatches if the node has
one
:param setAllowsRegraphing: (C) For internal use only
:param setWorkArea: (C) Set the work area to the existing named work area
:param shaderNetwork: (C) Show the shader network for the specified material node If the
materials shading group has a displacement or volume map these will be shown If not
:param shaderNetworks: (C) Show the shader network for all the objects on the selection
list that have shaders
:param shaderNetworksSelectMaterialNodes: (C) Select the material nodes in the shader
network for all the objects on the selection list that have shaders
:param snapShot: (C) Put hypergraph in snapshot mode This is only for testing
:param uncollapse: (C) Unhide the upstream nodes from the specified node
:param upStream: (C) Show nodes upstream from the specified node
:param userDefinedLayout: (C) Enable or disable remembrance of user defined layouts
Default is disabled until this functionality is better tested
:param workAreaAddCmd: (C) Set the MEL procedure called when a new work area is added to
HyperShade
:param workAreaDeleteCmd: (C) Set the MEL procedure called when a work area is deleted in
HyperShade
:param workAreaSelectCmd: (C) Set the MEL procedure called when a work area is selected in
HyperShade
:returns: Command result
"""
pass
def changeSubdivRegion(*args, action: int=0, level: int=0, **kwargs)->bool:
"""
Changes a subdivision surface region based on the command parameters The command operates
on the selected subdivision surfaces
:param action: (C) Specifies the action to the selection region 1 = delete selection region
2 = enlarge selection region
:param level: (C) Specify the level of the subdivision surface to perform the operation
:returns: Command result
"""
pass
def SculptMeshInvertFreeze(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def outlinerEditor(*args, allowMultiSelection: bool=True, alwaysToggleSelect: bool=True,
animLayerFilterOptions: Union[AnyStr, bool]="", attrAlphaOrder: Union[AnyStr,
bool]="", attrFilter: Union[AnyStr, bool]="", autoExpand: bool=True,
autoExpandLayers: bool=True, autoSelectNewObjects: bool=True,
containersIgnoreFilters: bool=True, control: bool=True, defineTemplate:
AnyStr="", directSelect: bool=True, displayMode: Union[AnyStr, bool]="",
doNotSelectNewObjects: bool=True, docTag: Union[AnyStr, bool]="",
dropIsParent: bool=True, editAttrName: bool=True, exists: bool=True,
expandAllItems: bool=True, expandAllSelectedItems: bool=True,
expandAttribute: bool=True, expandConnections: bool=True, expandObjects:
bool=True, feedbackItemName: bool=True, feedbackRowNumber: bool=True,
filter: Union[AnyStr, bool]="", forceMainConnection: Union[AnyStr, bool]="",
getCurrentSetOfItem: Union[int, bool]=0, highlightActive: bool=True,
highlightConnection: Union[AnyStr, bool]="", highlightSecondary: bool=True,
ignoreDagHierarchy: bool=True, ignoreHiddenAttribute: bool=True,
ignoreOutlinerColor: bool=True, isChildSelected: Union[name, bool]=None,
isSet: Union[int, bool]=0, isSetMember: Union[int, bool]=0,
lockMainConnection: bool=True, longNames: bool=True, mainListConnection:
Union[AnyStr, bool]="", mapMotionTrails: bool=True, masterOutliner:
Union[AnyStr, bool]="", niceNames: bool=True, object: Union[name, bool]=None,
organizeByClip: bool=True, organizeByLayer: bool=True, panel: Union[AnyStr,
bool]="", parent: Union[AnyStr, bool]="", parentObject: bool=True, pinPlug:
Union[name, bool]=None, refresh: bool=True, removeFromCurrentSet: int=0,
renameItem: int=0, renameSelectedItem: bool=True, renderFilterActive:
bool=True, renderFilterIndex: Union[int, bool]=0, renderFilterVisible:
bool=True, selectCommand: Union[Script, bool]=None, selectionConnection:
Union[AnyStr, bool]="", selectionOrder: AnyStr="", setFilter: Union[AnyStr,
bool]="", setsIgnoreFilters: bool=True, showAnimCurvesOnly: bool=True,
showAnimLayerWeight: bool=True, showAssets: bool=True,
showAssignedMaterials: bool=True, showAttrValues: bool=True, showAttributes:
bool=True, showCompounds: bool=True, showConnected: bool=True,
showContainedOnly: bool=True, showContainerContents: bool=True, showDagOnly:
bool=True, showLeafs: bool=True, showMuteInfo: bool=True, showNamespace:
bool=True, showNumericAttrsOnly: bool=True, showParentContainers: bool=True,
showPinIcons: bool=True, showPublishedAsConnected: bool=True,
showReferenceMembers: bool=True, showReferenceNodes: bool=True,
showSelected: bool=True, showSetMembers: bool=True, showShapes: bool=True,
showTextureNodesOnly: bool=True, showTimeEditor: bool=True, showUVAttrsOnly:
bool=True, showUnitlessCurves: bool=True, showUpstreamCurves: bool=True,
sortOrder: Union[AnyStr, bool]="", stateString: bool=True, transmitFilters:
bool=True, unParent: bool=True, unlockMainConnection: bool=True, unpinPlug:
name=None, updateMainConnection: bool=True, useTemplate: AnyStr="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates an outliner editor which can be used to display a list of objects.
:param allowMultiSelection: (C E) If true then multiple selection will be allowed in the
outliner
:param alwaysToggleSelect: (C E) If true, then clicking on an item in the outliner will
select or deselect it without affecting the selection of other items (unless
allowMultiSelecti
:param animLayerFilterOptions: (C Q E) Specifies whether a filter is to be applied when
displaying animation layers If so, the options can be "allAffecting" (no filter), "active"
(only th
:param attrAlphaOrder: (C Q E) Specify how attributes are to be sorted Current recognised
values are "default" for no sorting and "ascend" to sort attributes from 'a' to ''z' and
:param attrFilter: (C Q E) Specifies the name of an itemFilter object to be placed on this
editor This filters the attributes displayed in the editor
:param autoExpand: (C Q E) This flag specifies whether or not objects that are loaded in
should have their attributes automatically expanded
:param autoExpandLayers: (C Q E) If true then when a node with animation layer is displayed,
all the animation layers will show up in expanded form
:param autoSelectNewObjects: (C Q E) This flag specifies whether or not new objects added
to the outliner should be automatically selected
:param containersIgnoreFilters: (C Q E) This flag specifices whether or not filters should
be ignored when displaying container contents
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param directSelect: (C E) If true then clicking on an item in the outliner will add or
remove just that item from the selection connection If false then clicking on an item i
:param displayMode: (C Q E) Affects how the outliner displays when a filter is applied
List mode is a non-indented flat list DAG mode indents to represent the hierarchical str
:param doNotSelectNewObjects: (C Q E) If true this flag specifies that new objects added to
the outliner will not be selected, even if they are active
:param docTag: (C Q E) Attaches a tag to the editor
:param dropIsParent: (C Q E) This flag specifies the mode for drag and drop If the flag is
true, dropping items will do a reparent If it is false, dropping will reorder items
:param editAttrName: (C Q E) This flag specifies whether or not attribute names can be
edited By default double-clicking on an attribute will open the expression editor for
that
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param expandAllItems: (C E) Expand or collapse all items in the outliner
:param expandAllSelectedItems: (C E) Expand or collapse all selected items in the outliner
:param expandAttribute: (E) Force the outliner to fill the selection list with only
attributes
:param expandConnections: (C Q E) This flag specifies whether or not attributes should be
expanded to show their input connections Note: currently the expansion will only show
animCu
:param expandObjects: (C Q E) This flag specifies whether or not objects that are loaded in
should be automatically expanded
:param feedbackItemName: (Q) Returns the outliner item name at the current mouse position,
if any
:param feedbackRowNumber: (Q) Returns the outliner row number at the current mouse position,
if any
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param getCurrentSetOfItem: (Q) Returns the current set of item at the given row As an
item can belong to number of sets, current set is the set to which the item belongs to
curren
:param highlightActive: (C Q E) This flag specifies whether or not the outliner should
highlight objects that are active Note: if the outliner is driving the contents of another
ed
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param highlightSecondary: (C Q E) This flag specifies whether or not the outliner should
highlight objects that are contained in the highlightConnection
:param ignoreDagHierarchy: (C Q E) This flag specifies whether or not DAG objects are
displayed in their DAG hierarchy Warning: using this flag without some other form of
sensible fil
:param ignoreHiddenAttribute: (C Q E) Sets whether or not the outliner ignores the 'hidden
in outliner' flag on nodes
:param ignoreOutlinerColor: (C Q E) Sets whether or not the outliner ignores the 'use
outliner color' flag on nodes
:param isChildSelected: (Q) This flag allows you to query if one or more of the children of
the specified item is selected in the outliner The item should be specified using a
:param isSet: (Q) Returns true if the item present at the given row is a set
:param isSetMember: (Q) Returns true if the item present at the given row is a set member
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param longNames: (Q E) Controls whether long or short attribute names will be used in the
interface Note that this flag is ignored if the -niceNames flag is set Default i
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param mapMotionTrails: (C Q E) Sets whether or not we replace the motion trail in the
outliner with the object it is trailing
:param masterOutliner: (C Q E) This flag is the name of an outliner that this outliner will
share the objects and state from When an outliner is shared, all of its state informati
:param niceNames: (Q E) Controls whether the attribute names will be displayed in a more
user-friendly, readable way When this is on, the longNames flag is ignored When th
:param object: (Q) This flags is used together with the parentObject flag to get the name
of the parent object for the specified object
:param organizeByClip: (C Q E) If true then when a node with Time Editor clips is displayed,
attributes will be displayed according to the clip(s) it belongs to eg: Clip1 Attr1 At
:param organizeByLayer: (C Q E) If true then when a node with animation layer is displayed,
attributes will be displayed according to the layer(s) it belongs to eg: Layer1 Attr1 At
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param parentObject: (Q)
:param pinPlug: (C Q E) Pins the named plug, so it always appears in the outliner,
irrespective of the incoming selection connection In query mode, returns a list of the pi
:param refresh: (E) Causes the outliner to refresh itself
:param removeFromCurrentSet: (E) Removes selected members of a set from their current set
Current set is the set to which item at the given row belongs to If no selected items,
the
:param renameItem: (E) Renames the item at the given row index in the outliner
:param renameSelectedItem: (E) Rename the first selected item in the outliner
:param renderFilterActive: (Q) This is a query only flag which returns true if the render
setup filter is Active, i.e one of the four render filters (Inside Selected, Outside Selec
:param renderFilterIndex: (C Q E) Sets the Render Setup Filter to the index passed This
only works if the filter is visible in outliner and its selection is not locked Valid
indices
:param renderFilterVisible: (C Q E) Show/Hide the Render Setup Filter in outliner In query
mode returns whether the Render Setup Filter is visible or not
:param selectCommand: (C Q E) A command to be executed when an item is selected
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param selectionOrder: (E) Specify how objects are sorted in selection list Current
recognised values are "chronological" for sorting in selection order and "display" to sort
:param setFilter: (C Q E) Specifies the name of a filter which is used to filter which (if
any) sets to display
:param setsIgnoreFilters: (C Q E) This flag specifies whether or not the filter should be
ignored for expanding sets to show set members (default is true)
:param showAnimCurvesOnly: (C Q E) This flag modifies the showConnected flag If
showConnected is set to true then this flag will cause display of only those attributes
that are connec
:param showAnimLayerWeight: (C Q E) If true then when a node with animation layer is
displayed, the weight of the layer will be displayed if it is keyed
:param showAssets: (C Q E) This flags specifies whether assets should be shown in the
outliner
:param showAssignedMaterials: (C Q E) Specifies whether to show assigned materials under
shapes
:param showAttrValues: (C Q E) This flag specifies whether attribute values or attribute
names should be displayed Note: currently only string attributes can have their values
dis
:param showAttributes: (C Q E) Specifies whether to show attributes or not
:param showCompounds: (C Q E) This flag specifies whether or not compound attributes should
be displayed, or just the leaf attributes Note: if showConnected is true, and the comp
:param showConnected: (C Q E) This flag modifies the showAttributes flag If showAttributes
is set to true then this flag will cause display of only those attributes that are conn
:param showContainedOnly: (C Q E) This flags specifies whether nodes belonging to
containers should be show under the container node only Otherwise, it will show up under
the world a
:param showContainerContents: (C Q E) This flags specifies whether the contents of the
container should be shown under the container node in the outliner
:param showDagOnly: (C Q E) This flag specifies whether all dependency graph objects will
be displayed, or just DAG objects
:param showLeafs: (C Q E) This flag specifies whether or not leaf attributes should be
displayed, or just the compound attributes Note: if showConnected is true, and the leaf
:param showMuteInfo: (C Q E) This flag specifies whether mute information will be
displayed
:param showNamespace: (C Q E) This flag specifies whether all objects will have their
namespace displayed, if namespace different than root
:param showNumericAttrsOnly: (C Q E) This flag specifies whether or not all attributes
should be displayed, or just numeric attributes Note: if showConnected is true, and the
attribute
:param showParentContainers: (C Q E) This flags specifies whether nodes belonging to
containers/assets should show their containers/assets as well in its outliner
:param showPinIcons: (C Q E) Sets whether pin icons are shown for unpinned plugs
:param showPublishedAsConnected: (C Q E) This flags enables attributes that are published
to be displayed in italics Otherwise, only attributes connected as a destination are shown
in itali
:param showReferenceMembers: (C Q E) Specifies whether to show reference node members under
the reference node in the outliner
:param showReferenceNodes: (C Q E) Specifies whether to show reference nodes or not
:param showSelected: (C E) If true then the selected items are expanded in the outliner
:param showSetMembers: (C Q E) If true then when a set is expanded, the set members will be
displayed If false, then only other sets will be displayed
:param showShapes: (C Q E) Specifies whether to show shapes or not
:param showTextureNodesOnly: (C Q E) This flag modifies the showConnected flag If
showConnected is set to true then this flag will cause display of only those attributes
that are connec
:param showTimeEditor: (C Q E) If true, all nodes related to the Time Editor will be shown
as a hierarchy
:param showUVAttrsOnly: (C Q E) This flag specifies whether or not all attributes should be
displayed, or just uv attributes Note: currently the only attribute which will be displa
:param showUnitlessCurves: (C Q E) This flag (in combination with -expandConnections)
specifies whether or not connection expansion should show unitless animCurves
:param showUpstreamCurves: (C Q E) Specifies exactly which attributes are displayed when
showAttributes and expandConnections are both true If true, the dependency graph is
searched u
:param sortOrder: (C Q E) Specify how objects are to be sorted Current recognised values
are "none" for no sorting and "dagName" to sort DAG objects by name Notes: a) non-DA
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param transmitFilters: (C Q E) This flag specifies how the selectionConnection is
populated when attribute filters are enabled If this flag is set to true, then all the
attributes
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param unpinPlug: (C E) Unpins the named plug
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: (the name of the editor)
"""
pass
def ConvertSelectionToUVShell(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllStaticChannels(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetBreakdownKeyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateFBIK(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateCameraOnly(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RenderOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyCylindricalProjection(*args, caching: bool=True, constructionHistory: bool=True,
createNewMap: bool=True, imageCenter: Union[List[float, float],
bool]=None, imageCenterX: Union[float, bool]=0.0, imageCenterY:
Union[float, bool]=0.0, imageScale: Union[List[float, float],
bool]=None, imageScaleU: Union[float, bool]=0.0, imageScaleV:
Union[float, bool]=0.0, insertBeforeDeformers: bool=True,
keepImageRatio: bool=True, mapDirection: AnyStr="", name:
AnyStr="", nodeState: Union[int, bool]=0, perInstance: bool=True,
projectionCenter: Union[List[float, float, float], bool]=None,
projectionCenterX: Union[float, bool]=0.0, projectionCenterY:
Union[float, bool]=0.0, projectionCenterZ: Union[float, bool]=0.0,
projectionHeight: Union[float, bool]=0.0,
projectionHorizontalSweep: Union[float, bool]=0.0,
projectionScale: Union[List[float, float], bool]=None,
projectionScaleU: Union[float, bool]=0.0, projectionScaleV:
Union[float, bool]=0.0, radius: Union[float, bool]=10.0,
rotationAngle: Union[float, bool]=0.0, seamCorrect: bool=False,
smartFit: bool=True, worldSpace: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
TpolyProjCmdBase is a base class for the command to create a mapping on the selected
polygonal faces Projects a cylindrical map onto an object
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createNewMap: (C Q) This flag when set true will create a new map with a the name
passed in, if the map does not already exist
:param imageCenter: (C Q E) The center point of the 2D model layout Default: 0.5, 0.5
:param imageCenterX: (C Q E) Image center X coord
:param imageCenterY: (C Q E) Image center Y coord
:param imageScale: (C Q E) Specifies the UV scale : Enlarges or reduces the 2D version of
the model in U or V space relative to the 2D centerpoint Default: 1.0, 1.0
:param imageScaleU: (C Q E) Specifies the UV scale : Enlarges or reduces the 2D version of
the model in U or V space relative to the 2D centerpoint
:param imageScaleV: (C Q E) The V scale : Enlarges or reduces the 2D version of the model
in V space relative to the 2D centerpoint
:param insertBeforeDeformers: (C) This flag specifies if the projection node should be
inserted before or after deformer nodes already applied to the shape Inserting the
projection a
:param keepImageRatio: (C) True means keep any image ratio
:param mapDirection: (C) This flag specifies the mapping direction 'x', 'y' and 'z'
projects the map along the corresponding axis 'c' projects along the current camera view
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param perInstance: (C) True if the new map is per-instance, otherwise it is shared
:param projectionCenter: (C Q E) The origin point from which the map is projected Default:
0.0, 0.0, 0.0
:param projectionCenterX: (C Q E) Projection center X coord
:param projectionCenterY: (C Q E) Projection center Y coord
:param projectionCenterZ: (C Q E) Projection center Z coord
:param projectionHeight: (C Q E) The height of the map relative to the 3D projection axis
:param projectionHorizontalSweep: (C Q E) The angle swept by the 3D projection axis
:param projectionScale: (C Q E) The width and the height of the map relative to the 3D
projection axis Default: 180.0, 1.0
:param projectionScaleU: (C Q E) The width of the map relative to the 3D projection axis
:param projectionScaleV: (C Q E) The height of the map relative to the 3D projection axis
:param radius: (C Q E) Used by the UI : Manipulator Default: 10.0
:param rotationAngle: (C Q E) The for the rotation When the angle is positive, then the
map rotates counterclockwise on the mapped model, whereas when it is negative then the map
:param seamCorrect: (C Q E) Used to indicate fixing UV seams Default: false
:param smartFit: (C) True means use the smart fit algorithm
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def MoveToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def memory(*args, adjustedVirtualMemory: bool=True, asFloat: bool=True, debug: bool=True,
freeMemory: bool=True, gigaByte: bool=True, heapMemory: bool=True, kiloByte:
bool=True, megaByte: bool=True, pageFaults: bool=True, pageReclaims: bool=True,
physicalMemory: bool=True, processVirtualMemory: bool=True, summary: bool=True,
swapFree: bool=True, swapLogical: bool=True, swapMax: bool=True, swapPhysical:
bool=True, swapReserved: bool=True, swapVirtual: bool=True, swaps: bool=True,
**kwargs)->None:
"""
Used to query essential statistics on memory availability and usage By default memory
sizes are returned in bytes Since Maya's command engine only supports 32-bit signed
integers, any returned value which cannot fit into 31 bits will be truncated to 2,147,483,
647 and a warning message displayed To avoid having memory sizes truncated use one of
:param adjustedVirtualMemory: (C) Returns size of adjusted virtual memory allocated by the
process The adjustment is done by computing an offset when the application is launched
that
:param asFloat: (C) Causes numeric values to be returned as floats rather than ints This
can be useful if you wish to retain some of the significant digits lost when us
:param debug: (C) Print debugging statistics on arena memory (if it exists)
:param freeMemory: (C) Returns size of free memory
:param gigaByte: (C) Return memory sizes in gigabytes (1024*1024*1024 bytes)
:param heapMemory: (C) Returns size of memory heap
:param kiloByte: (C) Return memory sizes in kilobytes (1024 bytes)
:param megaByte: (C) Return memory sizes in megabytes (1024*1024 bytes)
:param pageFaults: (C) Returns number of page faults
:param pageReclaims: (C) Returns number of page reclaims
:param physicalMemory: (C) Returns size of physical memory
:param processVirtualMemory: (C) Returns size of virtual memory allocated by the process
:param summary: (C) Returns a summary of memory usage The size flags are ignored and all
memory sizes are given in megabytes
:param swapFree: (C) Returns size of free swap
:param swapLogical: (C) Returns size of logical swap
:param swapMax: (C) Returns maximum swap size
:param swapPhysical: (C) Returns size of physical swap
:param swapReserved: (C) Returns size of reserved swap
:param swapVirtual: (C) Returns size of virtual swap
:param swaps: (C) Returns number of swaps
:returns:
"""
pass
def polyNormalizeUV(*args, centerOnTile: bool=True, normalizeDirection: Union[int, bool]=0,
normalizeType: Union[int, bool]=0, preserveAspectRatio: bool=True, caching:
bool=True, constructionHistory: bool=True, createNewMap: bool=True,
insertBeforeDeformers: bool=True, name: AnyStr="", nodeState: Union[int,
bool]=0, uvSetName: AnyStr="", worldSpace: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Normalizes the UVs of input polyFaces The existing UVs of the faces are normalized between
0 and 1
:param centerOnTile: (C Q E) If true, will center UV's on the UV tile they are most over
If false, will center UV's in the 0-1 region
:param normalizeDirection: (C Q E) V
:param normalizeType: (C Q E) Collective
:param preserveAspectRatio: (C Q E) Scale uniform along u and v C: Default is on Q: When
queried, returns an int
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createNewMap: (C) Set to true if a new map should be created
:param insertBeforeDeformers: (C) Set to true if the new node created should inserted
before any deformer nodes
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param uvSetName: (C) Name of the UV set to be created
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def SelectAllAssets(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def geometryCacheOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyBlindData(*args, associationType: AnyStr="", binaryData: Union[AnyStr, List[AnyStr]]="",
booleanData: Union[bool, List[bool]]=True, delete: bool=True, doubleData:
Union[float, List[float]]=0.0, int64Data: Union[int64, List[int64]]=None,
intData: Union[int, List[int]]=0, longDataName: Union[AnyStr,
List[AnyStr]]="", rescan: bool=True, reset: bool=True, shape: bool=True,
shortDataName: Union[AnyStr, List[AnyStr]]="", stringData: Union[AnyStr,
List[AnyStr]]="", typeId: int=0, e=True, edit=True, **kwargs)->AnyStr:
"""
Command creates blindData types (basically creates an instance of TdnPolyBlindData) When
used with the query flag, it returns the data types that define this blindData type This
command is to be used create a blindData node *and* to edit the same. The associationType
flag *has* to be specified at all times. This is because if an instance of the
:param associationType: (C E) Specifies the dataTypes that are part of BlindData node being
created Allowable associations are "object" for any object, and "vertex" "edge" and "f
:param binaryData: (C E M) Specifies the data type is a binary data value
:param booleanData: (C E M) Specifies the data type is a boolean logic value
:param delete: (C E) Specifies that this will remove the blind data if found
:param doubleData: (C E M) Specifies the data type is a floating point double value
:param int64Data: (C E M) Specifies the data type is an 64-bit integer value
:param intData: (C E M) Specifies the data type is an integer value
:param longDataName: (C E M) Specifies the long name of the data that is being modified by
this command
:param rescan: (C E) Enables a rescan of blind data nodes for cached information
:param reset: (C E) Specifies that this command will reset the given attribute to default
value
:param shape: (C E) For object association only, apply blind data to the shape(s) below
this node instead of the node itself
:param shortDataName: (C E M) Specifies the short name of the data that is being modified
by this command
:param stringData: (C E M) Specifies the data type is a string value
:param typeId: (C E) Specifies the typeId of the BlindData type being created
:returns: Name of nodes created
"""
pass
def colorSliderButtonGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0,
adjustableColumn3: int=0, adjustableColumn4: int=0, adjustableColumn5:
int=0, adjustableColumn6: int=0, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None,
buttonCommand: Script=None, buttonLabel: Union[AnyStr, bool]="",
changeCommand: Script=None, columnAlign: Union[List[int, AnyStr],
List[List[int, AnyStr]]]=None, columnAlign2: List[AnyStr, AnyStr]=None,
columnAlign3: List[AnyStr, AnyStr, AnyStr]=None, columnAlign4:
List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign5: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign6: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach:
Union[List[int, AnyStr, int], List[List[int, AnyStr, int]]]=None,
columnAttach2: List[AnyStr, AnyStr]=None, columnAttach3: List[AnyStr,
AnyStr, AnyStr]=None, columnAttach4: List[AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach5: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr, AnyStr]=None, columnOffset2: List[int, int]=None,
columnOffset3: List[int, int, int]=None, columnOffset4: List[int, int,
int, int]=None, columnOffset5: List[int, int, int, int, int]=None,
columnOffset6: List[int, int, int, int, int, int]=None, columnWidth:
Union[List[int, int], List[List[int, int]]]=None, columnWidth1: int=0,
columnWidth2: List[int, int]=None, columnWidth3: List[int, int,
int]=None, columnWidth4: List[int, int, int, int]=None, columnWidth5:
List[int, int, int, int, int]=None, columnWidth6: List[int, int, int,
int, int, int]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dragCommand: Script=None,
dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
forceDragRefresh: bool=True, fullPathName: bool=True, height:
Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, hsvValue: Union[List[float, float, float], bool]=None,
image: Union[AnyStr, bool]="", isObscured: bool=True, label:
Union[AnyStr, bool]="", manage: bool=True, noBackground: bool=True,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, rgbValue:
Union[List[float, float, float], bool]=None, rowAttach: Union[List[int,
AnyStr, int], List[List[int, AnyStr, int]]]=None, statusBarMessage:
AnyStr="", symbolButtonCommand: Script=None, symbolButtonDisplay:
bool=True, useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param buttonCommand: (C E) Command string executed when the button is pressed
:param buttonLabel: (C Q E) The button text
:param changeCommand: (C E) Command string executed when slider value changes
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command string executed when slider value marker is dragged
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param forceDragRefresh: (C Q E) If used then force refresh on drag
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param hsvValue: (C Q E) Color in hue, saturation, and value format
:param image: (C Q E) Image displayed on the symbol button
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) Label text for the group
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rgbValue: (C Q E) Color in red, green, and blue format
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param symbolButtonCommand: (C E) Command string executed when the symbol button is
pressed
:param symbolButtonDisplay: (C Q E) Visibility of the symbol button
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def PointConstraint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GridOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddInBetweenTargetShapeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_bridgeTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fontDialog(*args, FontList: bool=True, scalable: bool=True, **kwargs)->AnyStr:
"""
Displays a dialog of available fonts for the user to select from The name of the selected
font is returned, or an empty string if no font was selected When the FontList flag is
used, no dialog is displayed Instead the command returns an array of the available fonts
:param FontList: (C) Returns an array of all available font names No dialog is displayed
:param scalable: (C) Limits the fonts returned or displayed to just those that are
scalable
:returns: Dialog name
"""
pass
def PreInfinityConstant(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddDivisions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def readPDC(*args, **kwargs)->None:
"""
"""
pass
def NodeEditorCopy(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyLayoutUV(*args, caching: bool=True, constructionHistory: bool=True, flipReversed:
bool=True, layout: Union[int, bool]=0, layoutMethod: Union[int, bool]=0, name:
AnyStr="", nodeState: Union[int, bool]=0, percentageSpace: Union[float,
bool]=0.0, rotateForBestFit: Union[int, bool]=0, scale: Union[int, bool]=0,
separate: Union[int, bool]=0, uvSetName: AnyStr="", worldSpace: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Move UVs in the texture plane to avoid overlaps
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param flipReversed: (C Q E) If this flag is turned on, the reversed UV pieces are fliped
:param layout: (C Q E) How to move the UV pieces, after cuts are applied: 0 No move is
applied 1 Layout the pieces along the U axis 2 Layout the pieces in a square shape
:param layoutMethod: (C Q E) Which layout method to use: 0 Block Stacking 1 Shape
Stacking
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param percentageSpace: (C Q E) When layout is set to square, this value is a percentage of
the texture area which is added around each UV piece It can be used to ensure each UV pi
:param rotateForBestFit: (C Q E) 0 No rotation is applied 1 Only allow 90 degree rotations
2 Allow free rotations
:param scale: (C Q E) How to scale the pieces, after move and cuts: 0 No scale is applied
1 Uniform scale to fit in unit square 2 Non proportional scale to fit in unit s
:param separate: (C Q E) Which UV edges should be cut: 0 No cuts 1 Cut only along folds 2
Make all necessary cuts to avoid all intersections
:param uvSetName: (C) Name of the UV set to be created
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def FBXUICallBack(*args, **kwargs)->None:
"""
"""
pass
def OffsetSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def arnoldFlushCache(*args, **kwargs)->None:
"""
"""
pass
def SelectPreviousObjectsMotionBuilder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def timeFieldGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0, adjustableColumn3:
int=0, adjustableColumn4: int=0, adjustableColumn5: int=0, adjustableColumn6:
int=0, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, columnAlign:
Union[List[int, AnyStr], List[List[int, AnyStr]]]=None, columnAlign2:
List[AnyStr, AnyStr]=None, columnAlign3: List[AnyStr, AnyStr, AnyStr]=None,
columnAlign4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign5:
List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign6: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach: Union[List[int,
AnyStr, int], List[List[int, AnyStr, int]]]=None, columnAttach2: List[AnyStr,
AnyStr]=None, columnAttach3: List[AnyStr, AnyStr, AnyStr]=None, columnAttach4:
List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach5: List[AnyStr, AnyStr,
AnyStr, AnyStr, AnyStr]=None, columnAttach6: List[AnyStr, AnyStr, AnyStr,
AnyStr, AnyStr, AnyStr]=None, columnOffset2: List[int, int]=None,
columnOffset3: List[int, int, int]=None, columnOffset4: List[int, int, int,
int]=None, columnOffset5: List[int, int, int, int, int]=None, columnOffset6:
List[int, int, int, int, int, int]=None, columnWidth: Union[List[int, int],
List[List[int, int]]]=None, columnWidth1: int=0, columnWidth2: List[int,
int]=None, columnWidth3: List[int, int, int]=None, columnWidth4: List[int, int,
int, int]=None, columnWidth5: List[int, int, int, int, int]=None,
columnWidth6: List[int, int, int, int, int, int]=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dragCommand: Script=None, dropCallback: Script=None, enable: bool=True,
enable1: bool=True, enable2: bool=True, enable3: bool=True, enable4: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
extraLabel: Union[AnyStr, bool]="", fullPathName: bool=True, height: Union[int,
bool]=0, highlightColor: Union[List[float, float, float], bool]=None,
isObscured: bool=True, label: Union[AnyStr, bool]="", manage: bool=True,
noBackground: bool=True, numberOfFields: int=0, numberOfPopupMenus: bool=True,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, precision: int=0,
preventOverride: bool=True, rowAttach: Union[List[int, AnyStr, int],
List[List[int, AnyStr, int]]]=None, statusBarMessage: AnyStr="", step:
Union[time, bool]=None, useTemplate: AnyStr="", value: Union[List[time, time,
time, time], bool]=None, value1: Union[time, bool]=None, value2: Union[time,
bool]=None, value3: Union[time, bool]=None, value4: Union[time, bool]=None,
visible: bool=True, visibleChangeCommand: Union[Script, bool]=None, width:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command string executed when the value of any of the fields
changes
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command string executed when dragging the invisible slider in any
of the fields
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enable1: (C Q E)
:param enable2: (C Q E)
:param enable3: (C Q E)
:param enable4: (C Q E) Enable state for the respective field
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param extraLabel: (C Q E) If present on creation this specifies that there will be an
extra label in the group Sets the string to be label text to the right of fields
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) If present on creation this specifies that there will be a label to
the left of the fields Sets the string to be the label text
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfFields: (C) Set the number of fields on creation One to four fields are
available The default is one field
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param precision: (C E) Set the number of digits to the right of the decimal
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) Set the delta of invisioSlider delta , the invisioSlider step is
delta/10.0 in LMB , delta in MMB,delta*10.0 in RMB Default is 10.0
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Values for all fields
:param value1: (C Q E)
:param value2: (C Q E)
:param value3: (C Q E)
:param value4: (C Q E) Value for the respective field
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def CreatePoseInterpolatorEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RotateTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ChangeUVSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def disableIncorrectNameWarning(*args, **kwargs)->None:
"""
Disable the warning dialog which complains about incorrect node names when opening Maya
files
:returns:
"""
pass
def CreateClip(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OrientJointOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AttachBrushToCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def headsUpDisplay(*args, allDescendants: bool=True, allowOverlap: bool=True, attachToRefresh:
bool=True, attributeChange: AnyStr="", block: Union[int, bool]=0,
blockAlignment: Union[AnyStr, bool]="", blockSize: Union[AnyStr, bool]="",
command: Union[Script, bool]=None, conditionChange: AnyStr="",
conditionFalse: AnyStr="", conditionTrue: AnyStr="", connectionChange:
AnyStr="", dataAlignment: Union[AnyStr, bool]="", dataFontSize: Union[AnyStr,
bool]="", dataWidth: Union[int, bool]=0, decimalPrecision: Union[int,
bool]=0, disregardIndex: bool=True, event: AnyStr="", exists: bool=True,
getOption: Union[AnyStr, bool]="", gridColor: Union[int, bool]=0, label:
Union[AnyStr, bool]="", labelFontSize: Union[AnyStr, bool]="", labelWidth:
Union[int, bool]=0, lastOccupiedBlock: int=0, layoutVisibility: bool=True,
listConditions: bool=True, listEvents: bool=True, listHeadsUpDisplays:
bool=True, listNodeChanges: bool=True, listPresets: bool=True, name:
AnyStr="", nextFreeBlock: int=0, nodeChanges: Union[AnyStr, List[AnyStr],
bool]="", padding: Union[int, bool]=0, preset: Union[AnyStr, bool]="",
refresh: bool=True, remove: bool=True, removeID: int=0, removePosition:
List[int, int]=None, resetNodeChanges: Union[AnyStr, List[AnyStr]]="",
scriptResult: bool=True, section: Union[int, bool]=0, setOption: List[AnyStr,
AnyStr]=None, showGrid: bool=True, visible: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[int, Any]:
"""
This command creates a Heads-up Display (HUD) object which is placed in a 2D inactive
overlay plane on the 3D viewport It is to be used to provide hands-on information
designated by a user script The text string displayed on the viewport is formatted using
the various flags of this command The only mandatory flags, on creation are the section
a
:param allDescendants: (C E) This flag can only be used in conjunction with the
-ac/attributeChange flag If it is specified, and the HUD is attached to a compound or
multi attri
:param allowOverlap: (C Q E) Sets the Heads-Up Display to be visible regardless of
overlapping section widths/limitations (see -s/section flag description for more details)
:param attachToRefresh: (C Q E) Attaches the command to the refresh process The script is
then run each time an idle refresh is run and updates directly following it
:param attributeChange: (C E) Runs the command when the named attribute changes value The
string must identify both the dependency node and the particular attribute If the depen
:param block: (C Q E) Denotes the individual block that the HUD will reside in, within a
section Each section is composed of a single column of blocks The total number o
:param blockAlignment: (C Q E) Specifies the alignment of the block within its respective
column Available alignments are: "center", "left" and "right" The default alignment is "
:param blockSize: (C Q E) Sets the height of each block Available heights are: small,
medium and large In pixel measurements, each corresponds to a 20, 35 or 50 pixel height
:param command: (C Q E) Specifies the procedure or script to run, in order to obtain the
desired information This must return a value or an array of values A warning will
:param conditionChange: (C E) A trigger which runs the command (to sample the data), when
the named condition changes The named condition must be pre-defined or a user defined bo
:param conditionFalse: (C E) A trigger which runs the command (to sample the data), when
the named condition becomes false The named condition must be pre-defined or a user defi
:param conditionTrue: (C E) A trigger which runs the command (to sample the data), when the
named condition becomes true The named condition must be pre-defined or a user defin
:param connectionChange: (C E) Runs the command when the named attribute changes its
connectivity The string must identify both the dependency node and the particular
attribute I
:param dataAlignment: (C Q E) Specifies the alignment of the data blocks and the data text,
within a HUD block Available alignments are: "left" and "right" The default alignment
:param dataFontSize: (C Q E) Sets the font size of the returned data Available sizes are:
small and large
:param dataWidth: (C Q E) Specifies the pixel width of the virtual "textbox" which will
hold a data value For commands which return more than one value (ie arrays), one of t
:param decimalPrecision: (C Q E) Sets the decimal precision of any floating point value
returned by the command The valid range of precision values are 1 to 8
:param disregardIndex: (C E) This flag can only be used in conjunction with the
-ac/attributeChange flag If it is specified, and the HUD is attached to a multi (indexed)
attribu
:param event: (C E) Runs the command when the named event occurs The named event, must be
a pre-defined Maya event To get a list of what events exist, use the -le/list
:param exists: (C Q) This flag returns whether the given object exists in the Heads-Up
Display layout An object name must be supplied with this command This flag cannot
:param getOption: (Q) This flag will return the value of the option specified by the string
See setOption for a list of options In query mode, this flag needs a value
:param gridColor: (C Q E) This flag specifies a color for the grid lines using the inactive
color palette Specifying an index number between 1 to 23 will select the correspon
:param label: (C Q E) Text string that appears to the left of the desired information
:param labelFontSize: (C Q E) Sets the font size of the label Available sizes are: small
and large
:param labelWidth: (C Q E) Specifies the pixel width of the virtual "textbox" which will
hold the label The contents of this "textbox" will be left justified If the width of
:param lastOccupiedBlock: (C) Returns the block number of the last occupied block in a
given section
:param layoutVisibility: (C Q E) Sets the visibility of Heads-Up Display layout on and off
This does not modify individual visibilities of heads-up displays, but turns off the layou
:param listConditions: (C Q) This flag will return a string array containing all names of
the available conditions
:param listEvents: (C Q) This flag will return a string array containing all names of the
available events
:param listHeadsUpDisplays: (C Q) This flag will return a string array containing all names
of existing HUDs
:param listNodeChanges: (C Q) This flag will return a string array containing all names of
the available node changes
:param listPresets: (C Q) This flag will return a string array containing all names of the
available preset HUDs
:param name: (E) This flag only permits the EDITING of the name of the Heads-Up Display
:param nextFreeBlock: (C) Returns the block number of the next free block in a given
section
:param nodeChanges: (C Q E M) Works only with selection based triggers (ie
"SelectionChanged" or "SomethingSelected"), otherwise this flag is ignored This flag
attaches the HUD
:param padding: (C Q E) Specifies the width of both the left and right margins of a block
Default value is 15 pixels
:param preset: (C Q E) This setting is used to select certain pre-defined HUDs, some of
which retrieve specific data, that is unobtainable through normal MEL commands or sc
:param refresh: (C) This flag forces the given Heads-Up Display element to refresh,
updating the value displayed This flag cannot be combined with any other flag
:param remove: (C E) This command will remove a given HUD object, given a specified HUD
name This flag will override all other flags and is mutually exclusive from the o
:param removeID: (C E) This command will remove a given HUD object, given a specified HUD
ID number assigned to it at creation time This flag will override all other flags
:param removePosition: (C E) This command will remove the contents of a specific block
location in the HUD layout This flag will override all other flags and is mutually
exclusi
:param resetNodeChanges: (E M) This flag will reset a specificied nodeChange back to false
This flag only operates under the edit flag See the description for the -nc/nodeChanges
:param scriptResult: (Q) This flag is only used in conjunction with the query flag Calling
a query on this flag returns the most recent result of the HUD
:param section: (C Q E) Defines the section the HUD will appear in There are 10 sections
divided across the screen Five columns and two rows make up the ten element matrix
:param setOption: (E) This flag will edit the option specified by the first string Current
options are: smpPolyCount - "cage" or "smp" - in smooth mesh preview, determine
:param showGrid: (C Q E) This flag will toggle the display of the grid lines of the HUD
layout
:param visible: (C Q E) Sets the visibility of the Heads-Up Display on and off
:returns: ID number of the Heads-Up Display (HUD), for regular command execution.
"""
pass
def OneClickFetchRemoteCharacter(*args, **kwargs)->None:
"""
"""
pass
def PolyBrushMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RenameAttribute(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def psdConvSolidTxOptions(*args, **kwargs)->None:
"""
"""
pass
def sphere(*args, axis: Union[List[float, float, float], bool]=None, caching: bool=True,
degree: Union[int, bool]=3, endSweep: Union[float, bool]=2, heightRatio: Union[float,
bool]=2.0, nodeState: Union[int, bool]=0, pivot: Union[List[float, float, float],
bool]=None, radius: Union[float, bool]=1.0, sections: Union[int, bool]=8, spans:
Union[int, bool]=1, startSweep: Union[float, bool]=0, tolerance: Union[float,
bool]=0.01, useTolerance: bool=False, constructionHistory: bool=True, name:
AnyStr="", object: bool=True, polygon: int=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The sphere command creates a new sphere The number of spans in the in each direction of
the sphere is determined by the useTolerance attribute If -ut is true then the -tolerance
attribute will be used If -ut is false then the -sections attribute will be used
:param axis: (C Q E) The primitive's axis
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param degree: (C Q E) The degree of the resulting surface: 1 - linear, 3 - cubic Default:
3
:param endSweep: (C Q E) The angle at which to end the surface of revolution Default is
2Pi radians, or 360 degrees Default: 6.2831853
:param heightRatio: (C Q E) Ratio of "height" to "width" Default: 2.0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pivot: (C Q E) The primitive's pivot point
:param radius: (C Q E) The radius of the object Default: 1.0
:param sections: (C Q E) The number of sections determines the resolution of the surface in
the sweep direction Used only if useTolerance is false Default: 8
:param spans: (C Q E) The number of spans determines the resolution of the surface in the
opposite direction Default: 1
:param startSweep: (C Q E) The angle at which to start the surface of revolution Default:
0
:param tolerance: (C Q E) The tolerance with which to build the surface Used only if
useTolerance is true Default: 0.01
:param useTolerance: (C Q E) Use the specified tolerance to determine resolution Otherwise
number of sections will be used Default: false
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:returns: Object name and node name
"""
pass
def FourViewArrangement(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddTimeWarp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def aliasAttr(*args, remove: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
Allows aliases (alternate names) to be defined for any attribute of a specified node When
an attribute is aliased, the alias will be used by the system to display information about
the attribute The user may, however, freely use either the alias or the original name of
the attribute Only a single alias can be specified for an attribute so settin
:param remove: (C) Specifies that aliases listed should be removed (otherwise new aliases
are added)
:returns: in query mode.
"""
pass
def dR_bridgeRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def attrFieldSliderGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0,
adjustableColumn3: int=0, adjustableColumn4: int=0, adjustableColumn5:
int=0, adjustableColumn6: int=0, annotation: Union[AnyStr, bool]="",
attribute: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, columnAlign:
Union[List[int, AnyStr], List[List[int, AnyStr]]]=None, columnAlign2:
List[AnyStr, AnyStr]=None, columnAlign3: List[AnyStr, AnyStr,
AnyStr]=None, columnAlign4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAlign5: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAlign6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach: Union[List[int, AnyStr, int], List[List[int, AnyStr,
int]]]=None, columnAttach2: List[AnyStr, AnyStr]=None, columnAttach3:
List[AnyStr, AnyStr, AnyStr]=None, columnAttach4: List[AnyStr, AnyStr,
AnyStr, AnyStr]=None, columnAttach5: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnOffset2: List[int, int]=None, columnOffset3:
List[int, int, int]=None, columnOffset4: List[int, int, int, int]=None,
columnOffset5: List[int, int, int, int, int]=None, columnOffset6:
List[int, int, int, int, int, int]=None, columnWidth: Union[List[int,
int], List[List[int, int]]]=None, columnWidth1: int=0, columnWidth2:
List[int, int]=None, columnWidth3: List[int, int, int]=None,
columnWidth4: List[int, int, int, int]=None, columnWidth5: List[int, int,
int, int, int]=None, columnWidth6: List[int, int, int, int, int,
int]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists:
bool=True, extraButton: bool=True, extraButtonCommand: Script=None,
extraButtonIcon: Union[AnyStr, bool]="", fieldMaxValue: Union[float,
bool]=0.0, fieldMinValue: Union[float, bool]=0.0, fieldStep: Union[float,
bool]=0.0, forceAddMapButton: bool=True, fullPathName: bool=True,
height: Union[int, bool]=0, hideMapButton: bool=True, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True,
label: Union[AnyStr, bool]="", manage: bool=True, maxValue: Union[float,
bool]=0.0, minValue: Union[float, bool]=0.0, noBackground: bool=True,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, precision: int=0, preventOverride: bool=True,
rowAttach: Union[List[int, AnyStr, int], List[List[int, AnyStr,
int]]]=None, sliderMaxValue: Union[float, bool]=0.0, sliderMinValue:
Union[float, bool]=0.0, sliderStep: Union[float, bool]=0.0,
statusBarMessage: AnyStr="", step: Union[float, bool]=0.0, useTemplate:
AnyStr="", vertical: bool=True, visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param attribute: (C Q E) The name of a unique attribute of type double or int This newly
created field will be attached to the attribute, so that modifications to one will c
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) The command string is executed when the value of the slider or
floatField changes It will be executed only once after a drag of the slider
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param extraButton: (C) Add an extra icon button to the end of this control
:param extraButtonCommand: (C E) The command string is executed when the extra button is
clicked
:param extraButtonIcon: (C Q E) The icon file name of the extra button
:param fieldMaxValue: (C Q E) Set the maximum value for the field This flag allows you to
specify a maximum bound for the field higher than that of the slider (See note above ab
:param fieldMinValue: (C Q E) Set the minimum value for the field This flag allows you to
specify a minimum bound for the field lower than that of the slider (See note above abo
:param fieldStep: (C Q E) Sets the increment for the float field
:param forceAddMapButton: (C) Force adding a map button to this control If this option is
true, option hideMapButton is suppressed
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param hideMapButton: (C) Force the map button to remain hidden for this control
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) By default, the label of this field will be the name of the attribute
This flag can be used to override that name with whatever string you want
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxValue: (C Q E) Sets the maximum value for both the slider and the field (See
note above about min and max values)
:param minValue: (C Q E) Sets the minimum value for both the slider and the field (by
default max and min are set according to what is in the attribute, if anything If no m
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param precision: (C E) Sets the number of digits to the right of the decimal (If attached
to an int attribute, this is automatically set to 0 and cannot be overridden.)
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param sliderMaxValue: (C Q E) Set the maximum value for the slider The slider max will be
clipped to the field max
:param sliderMinValue: (C Q E) Set the minimum value for the slider The slider min will be
clipped to the field min
:param sliderStep: (C Q E) On Linux the slider step value represents the amount the value
will increase or decrease when you click either side of the slider
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) Sets the increment for both the slider and float field
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param vertical: (C Q) Whether the orientation of the controls in this group are horizontal
(default) or vertical
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def outlinerPanel(*args, control: bool=True, copy: AnyStr="", createString: bool=True,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", editString:
bool=True, exists: bool=True, init: bool=True, isUnique: bool=True, label:
Union[AnyStr, bool]="", menuBarRepeatLast: bool=True, menuBarVisible:
bool=True, needsInit: bool=True, outlinerEditor: bool=True, parent: AnyStr="",
popupMenuProcedure: Union[Script, bool]=None, replacePanel: AnyStr="",
tearOff: bool=True, tearOffCopy: AnyStr="", tearOffRestore: bool=True,
unParent: bool=True, useTemplate: AnyStr="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates, edit and queries outliner panels which contain only an outliner
editor
:param control: (Q) Returns the top level control for this panel Usually used for getting
a parent to attach popup menus CAUTION: panels may not have controls at times
:param copy: (E) Makes this panel a copy of the specified panel Both panels must be of the
same type
:param createString: (E) Command string used to create a panel
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the Maya panel
:param editString: (E) Command string used to edit a panel
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param init: (C E) Initializes the panel's default state This is usually done
automatically on file -new and file -open
:param isUnique: (Q) Returns true if only one instance of this panel type is allowed
:param label: (Q E) Specifies the user readable label for the panel
:param menuBarRepeatLast: (C Q E) Controls whether clicking on the menu header with the
middle mouse button would repeat the last selected menu item
:param menuBarVisible: (C Q E) Controls whether the menu bar for the panel is displayed
:param needsInit: (Q E) (Internal) On Edit will mark the panel as requiring initialization
Query will return whether the panel is marked for initialization Used during fil
:param outlinerEditor: (Q) This flag returns the name of the outliner editor contained by
the panel
:param parent: (C) Specifies the parent layout for this panel
:param popupMenuProcedure: (Q E) Specifies the procedure called for building the panel's
popup menu(s) The default value is "buildPanelPopupMenu" The procedure should take one
stri
:param replacePanel: (E) Will replace the specified panel with this panel If the target
panel is within the same layout it will perform a swap
:param tearOff: (Q E) Will tear off this panel into a separate window with a paneLayout as
the parent of the panel When queried this flag will return if the panel has bee
:param tearOffCopy: (C) Will create this panel as a torn of copy of the specified source
panel
:param tearOffRestore: (C E) Restores panel if it is torn off and focus is given to it If
docked, becomes the active panel in the docked window This should be the default flag
:param unParent: (E) Specifies that the panel should be removed from its layout This
(obviously) cannot be used with query
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: (the name of the panel)
"""
pass
def NodeEditorAdditiveGraphingMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def modelPanel(*args, barLayout: bool=True, camera: Union[AnyStr, bool]="", control: bool=True,
copy: AnyStr="", createString: bool=True, defineTemplate: AnyStr="", docTag:
Union[AnyStr, bool]="", editString: bool=True, exists: bool=True, init:
bool=True, isUnique: bool=True, label: Union[AnyStr, bool]="",
menuBarRepeatLast: bool=True, menuBarVisible: bool=True, modelEditor: bool=True,
needsInit: bool=True, parent: AnyStr="", popupMenuProcedure: Union[Script,
bool]=None, replacePanel: AnyStr="", tearOff: bool=True, tearOffCopy: AnyStr="",
tearOffRestore: bool=True, unParent: bool=True, useTemplate: AnyStr="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a panel consisting of a model editor See the modelEditor command
documentation for more information
:param barLayout: (Q) This flag returns the name of the layout which is the parent of the
panels icon bar
:param camera: (Q E) Query or edit the camera in a modelPanel
:param control: (Q) Returns the top level control for this panel Usually used for getting
a parent to attach popup menus CAUTION: panels may not have controls at times
:param copy: (E) Makes this panel a copy of the specified panel Both panels must be of the
same type
:param createString: (E) Command string used to create a panel
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the Maya panel
:param editString: (E) Command string used to edit a panel
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param init: (C E) Initializes the panel's default state This is usually done
automatically on file -new and file -open
:param isUnique: (Q) Returns true if only one instance of this panel type is allowed
:param label: (Q E) Specifies the user readable label for the panel
:param menuBarRepeatLast: (C Q E) Controls whether clicking on the menu header with the
middle mouse button would repeat the last selected menu item
:param menuBarVisible: (C Q E) Controls whether the menu bar for the panel is displayed
:param modelEditor: (Q) This flag returns the name of the model editor contained by the
panel
:param needsInit: (Q E) (Internal) On Edit will mark the panel as requiring initialization
Query will return whether the panel is marked for initialization Used during fil
:param parent: (C) Specifies the parent layout for this panel
:param popupMenuProcedure: (Q E) Specifies the procedure called for building the panel's
popup menu(s) The default value is "buildPanelPopupMenu" The procedure should take one
stri
:param replacePanel: (E) Will replace the specified panel with this panel If the target
panel is within the same layout it will perform a swap
:param tearOff: (Q E) Will tear off this panel into a separate window with a paneLayout as
the parent of the panel When queried this flag will return if the panel has bee
:param tearOffCopy: (C) Will create this panel as a torn of copy of the specified source
panel
:param tearOffRestore: (C E) Restores panel if it is torn off and focus is given to it If
docked, becomes the active panel in the docked window This should be the default flag
:param unParent: (E) Specifies that the panel should be removed from its layout This
(obviously) cannot be used with query
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the panel.
"""
pass
def HypershadeSetTraversalDepthUnlim(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PokePolygonOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ctxEditMode(*args, buttonDown: bool=True, buttonUp: bool=True, **kwargs)->None:
"""
This command tells the current context to switch edit modes.
:param buttonDown: (C) Edit mode is being invoked from a hotkey press event
:param buttonUp: (C) Edit mode is being invoked from a hotkey release event
:returns:
"""
pass
def MirrorPolygonGeometry(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExportOfflineFileFromRefEdOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BrushAnimationMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PinSelectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectLightsShadowingObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetKeyAnimated(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmPushOver(*args, **kwargs)->None:
"""
"""
pass
def dR_graphEditorTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleViewAxis(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutlinerWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleEditPoints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RaiseMainWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def stroke(*args, name: AnyStr="", pressure: bool=False, seed: int=0, **kwargs)->AnyStr:
"""
The stroke command creates a new Paint Effects stroke node
:param name: (C) Sets the name of the stroke to the input string
:param pressure: (C) On creation, allows the copying of the pressure mapping settings from
the Paint Effects Tool Default is false
:param seed: (C) Sets the random seed for this stroke
:returns: (The path to the new stroke or the replaced stroke)
"""
pass
def CreateEmptyUVSetOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmCreateInteractiveGroomSplinesOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeDisplayAsSmallSwatches(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ReplaceObjectsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UndoCanvas(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ungroup(*args, absolute: bool=True, parent: AnyStr="", relative: bool=True, world:
bool=True, **kwargs)->None:
"""
This command ungroups the specified objects The objects will be placed at the same level
in the hierarchy the group node occupied unless the -w flag is specified, in which case
they will be placed under the world If an object is ungrouped and there is an object in
the new group with the same name then this command will rename the ungrouped obje
:param absolute: (C) preserve existing world object transformations (overall object
transformation is preserved by modifying the objects local transformation) [default]
:param parent: (C) put the ungrouped objects under the given parent
:param relative: (C) preserve existing local object transformations (don't modify local
transformation)
:param world: (C) put the ungrouped objects under the world
:returns:
"""
pass
def rebuildCurve(*args, caching: bool=True, degree: Union[int, bool]=3, endKnots: Union[int,
bool]=0, fitRebuild: bool=True, keepControlPoints: bool=False, keepEndPoints:
bool=True, keepRange: Union[int, bool]=1, keepTangents: bool=True, nodeState:
Union[int, bool]=0, rebuildType: Union[int, bool]=0, smartSurfaceCurveRebuild:
bool=False, spans: Union[int, bool]=4, tolerance: Union[float, bool]=0.01,
constructionHistory: bool=True, name: AnyStr="", object: bool=True, range:
bool=True, replaceOriginal: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
This command rebuilds a curve by modifying its parameterization In some cases the shape
may also change The rebuildType (-rt) determines how the curve is to be rebuilt The
optional second curve can be used to specify a reference parameterization
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param degree: (C Q E) The degree of the resulting curve 1 - linear, 2 - quadratic, 3 -
cubic, 5 - quintic, 7 - heptic Default: 3
:param endKnots: (C Q E) End conditions for the curve 0 - uniform end knots, 1 - multiple
end knots, Default: 0
:param fitRebuild: (C Q E) If true use the least squares fit rebuild Otherwise use the
convert method Default: true
:param keepControlPoints: (C Q E) If true, the CVs will remain the same This forces
uniform parameterization unless rebuildType is matchKnots Default: false
:param keepEndPoints: (C Q E) If true, keep the endpoints the same Default: true
:param keepRange: (C Q E) Determine the parameterization for the resulting curve 0 -
reparameterize the resulting curve from 0 to 1, 1 - keep the original curve parameterizat
:param keepTangents: (C Q E) If true, keep the end tangents the same Default: true
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param rebuildType: (C Q E) How to rebuild the input curve 0 - uniform, 1 - reduce spans,
2 - match knots, 3 - remove multiple knots, 4 - curvature 5 - rebuild ends 6 - clean D
:param smartSurfaceCurveRebuild: (C Q E) If true, curve on surface is rebuild in 3D and 2D
info is kept Default: false
:param spans: (C Q E) The number of spans in resulting curve Used only if rebuildType is
uniform Default: 4
:param tolerance: (C Q E) The tolerance with which to rebuild Default: 0.01
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param range: (C) Force a curve range on complete input curve
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def CreateVolumeCone(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def instanceable(*args, allow: bool=True, recursive: bool=True, shape: bool=True, q=True,
query=True, **kwargs)->Union[List[bool], Any]:
"""
Flags one or more DAG nodes so that they can (or cannot) be instanced This command sets an
internal state on the specified DAG nodes which is checked whenever Maya attempts an
instancing operation If no node names are provided on the command line then the current
selection list is used Sets are automatically expanded to their constituent object
:param allow: (C Q) Specifies the new instanceable state for the node Specify true to
allow the node to be instanceable, and false to prevent it from being instanced T
:param recursive: (C) Can be specified with the -allow flag in create or edit mode to
recursively apply the -allow setting to all non-shape children of the selected node(s
:param shape: (C) Can be specified with the -allow flag in create or edit mode to apply the
-allow setting to all shape children of the selected node(s) This flag can
:returns: For query execution.
"""
pass
def xgmFileRender(*args, **kwargs)->None:
"""
"""
pass
def extendSurface(*args, caching: bool=True, distance: Union[float, bool]=1, extendDirection:
Union[int, bool]=0, extendMethod: Union[int, bool]=0, extendSide: Union[int,
bool]=1, extensionType: Union[int, bool]=0, join: bool=True, nodeState:
Union[int, bool]=0, constructionHistory: bool=True, name: AnyStr="", object:
bool=True, replaceOriginal: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
This command extends a surface or creates a new surface as an extension
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param distance: (C Q E) The distance to extend (for by distance only) Default: 1
:param extendDirection: (C Q E) Which parametric direction of the surface to extend ( 0 - U,
1 - V, 2 - both ) Default: 0
:param extendMethod: (C Q E) The extend method (0 - distance) Default: 0
:param extendSide: (C Q E) Which end of the surface to extend ( 0 - end, 1 - start, 2 -
both ) Default: 1
:param extensionType: (C Q E) The type of extension (0 - tangent, 2 - extrapolate) Default:
0
:param join: (C Q E) Join extension to original Default: true
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def rangeControl(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changedCommand: Script=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dropCallback: Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, fullPathName: bool=True,
height: Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, isObscured: bool=True, manage: bool=True, maxRange: Union[time,
bool]=None, minRange: Union[time, bool]=None, noBackground: bool=True,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="", popupMenuArray:
bool=True, preventOverride: bool=True, statusBarMessage: AnyStr="",
useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, width: Union[int, bool]=0, widthHeight: List[int, int]=None,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a control used for displaying and modifying the current playback range
Note: only one master rangeControl may exist Any addition rangeControls that a user
creates are slaved to the master range control widget
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changedCommand: (C E) script to be executed when the range changes
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxRange: (C Q E) Controls the max range displayable in the control
:param minRange: (C Q E) Controls the max range displayable in the control
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:param widthHeight: (C E) Controls the dimensions of the control
:returns: Name of newly created rangeControl.
"""
pass
def renderSetupSelect(*args, **kwargs)->None:
"""
"""
pass
def HypershadeSelectDownStream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_modeObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyCreaseTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def renderManip(*args, camera: List[bool, bool, bool, bool, bool]=None, light: List[bool, bool,
bool]=None, spotLight: List[bool, bool, bool, bool, bool, bool, bool]=None,
state: bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[None,
Any]:
"""
This command creates manipulators for cameras or lights
:param camera: (Q E) Query or edit the visiblity status of the component camera
manipulators The order of components are: cycling index, center of interest, pivot, clipp
:param light: (Q E) Query or edit the visiblity status of the component light manipulators
The order of components are: cycling index, center of interest, and pivot
:param spotLight: (Q E) Query or edit the visiblity status of the component spot light
manipulators The order of components are: cycling index, center of interest, pivot, c
:param state: (Q E) Query or edit the state of manipulators on an camera, ambient light,
directional light, point light, or spot light This flag's default value is on
:returns:
"""
pass
def ToggleZoomInMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Birail1Options(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cMuscleWeightDefault(*args, **kwargs)->None:
"""
"""
pass
def LoopBrushAnimation(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleFbikDetails(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeSortReverseOrder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def containerBind(*args, allNames: bool=True, bindingSet: Union[AnyStr, bool]="",
bindingSetConditions: bool=True, bindingSetList: bool=True, force: bool=True,
preview: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This is an accessory command to the container command which is used for some automated
binding operations on the container A container's published interface can be bound using a
bindingSet on the associated container template
:param allNames: (C) Specifies that all published names on the container should be
considered during the binding operation By default only unbound published names will b
:param bindingSet: (Q) Specifies the name of the template binding set to use for the bind
or query operation This flag is not available in query mode In query mode, this
:param bindingSetConditions: (Q) Used in query mode, returns a list of binding set
condition entries from the specified template binding set The list returned is composed of
of all
:param bindingSetList: (Q E) Used in query mode, returns a list of available binding sets
that are defined on the associated container template
:param force: (C) This flag is used to force certain operations to proceed that would
normally not be performed
:param preview: (C) This flag will provide a preview of the results of a binding operation
but will not actually perform it A list of publishedName/boundName pairs are
:returns:
"""
pass
def TimeEditorExplodeGroup(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setDrivenKeyframe(*args, attribute: Union[AnyStr, List[AnyStr]]="", controlPoints:
bool=False, currentDriver: Union[AnyStr, bool]="", driven: bool=True,
driver: bool=True, driverValue: Union[float, List[float]]=0.0, hierarchy:
AnyStr="", inTangentType: AnyStr="", insert: bool=True, insertBlend:
bool=True, outTangentType: AnyStr="", shape: bool=True, value: float=0.0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[int, Any]:
"""
This command sets a driven keyframe A driven keyframe is similar to a regular keyframe
However, while a standard keyframe always has an x-axis of time in the graph editor, for a
drivenkeyframe the user may choose any attribute as the x-axis of the graph editor
:param attribute: (C M) Attribute name to set keyframes on
:param controlPoints: (C) Explicitly specify whether or not to include the control points
of a shape (see "-s" flag) in the list of attributes Default: false
:param currentDriver: (C Q) Set the driver to be used for the current driven keyframe to
the attribute passed as an argument
:param driven: (Q) Returns list of driven attributes for the selected item
:param driver: (Q) Returns list of available drivers for the attribute
:param driverValue: (C M) Value of the driver to use for this keyframe Default value is
the current value
:param hierarchy: (C) Controls the objects this command acts on, relative to the specified
(or active) target objects Valid values are "above," "below," "both," and "none
:param inTangentType: (C) The in tangent type for keyframes set by this command Valid
values are: "auto", clamped", "fast", "flat", "linear", "plateau", "slow", "spline", and
:param insert: (C) Insert keys at the given time(s) and preserve the shape of the animation
curve(s) Note: the tangent type on inserted keys will be fixed so that the
:param insertBlend: (C) If true, a pairBlend node will be inserted for channels that have
nodes other than animCurves driving them, so that such channels can have blended an
:param outTangentType: (C) The out tangent type for keyframes set by this command Valid
values are: "auto", "clamped", "fast", "flat", "linear", "plateau", "slow", "spline", "
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true
:param value: (C) Value to set the keyframe at Default is the current value
:returns: Number of keyframes set.
"""
pass
def geomToBBox(*args, bakeAnimation: bool=True, combineMesh: bool=True, endTime: time=None,
keepOriginal: bool=True, name: AnyStr="", nameSuffix: AnyStr="", sampleBy:
time=None, shaderColor: List[float, float, float]=None, single: bool=True,
startTime: time=None, **kwargs)->None:
"""
Create polygonal mesh bounding boxes for geometry Can also create a single bounding box
per hierarchy
:param bakeAnimation: (C) Bake the animation Can be used with startTime, endTime and
sampleBy flags If used alone, the time slider will be used to specify the startTime and
:param combineMesh: (C) Combine resulting bounding boxes Mutually exclusive with -s/single
option
:param endTime: (C) Used with bakeAnimation flag Specifies the end time of the baking
process
:param keepOriginal: (C) Do not remove the selected nodes used to create the bounding
boxes
:param name: (C) Specifies the bounding box name
:param nameSuffix: (C) Specifies the bounding box name suffix
:param sampleBy: (C) Used with bakeAnimation flag Specifies the animation evaluation time
increment
:param shaderColor: (C) Set the color attribute of the Lambert material associate with the
bounding box The RGB values should be defined between 0 to 1.0 Default value is
:param single: (C) Create a single bounding box per hierarchy selected
:param startTime: (C) Used with bakeAnimation flag Specifies the start time of the baking
process
:returns:
"""
pass
def createPolyHelixCtx(*args, **kwargs)->None:
"""
"""
pass
def getRenderTasks(*args, camera: AnyStr="", renderLayer: AnyStr="", **kwargs)->List[AnyStr]:
"""
Command to return render tasks to render an image source Image source can depend on
upstream image sources that result from renderings of 3D scene, or 2D renderings (e.g
render targets) This command obtains the graph of image source render dependencies, and
creates render tasks according to these dependencies A render task has context, which ca
:param camera: (C) Camera node to use in the render context for the image source render
task
:param renderLayer: (C) Render layer to use in the render context for the image source
render task
:returns: Render tasks (one per string) for argument render target.
"""
pass
def polyCrease(*args, createHistory: bool=True, operation: Union[int, bool]=0, relativeValue:
Union[float, bool]=0.0, value: Union[float, List[float], bool]=0.0, vertexValue:
Union[float, List[float], bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[bool, Any]:
"""
Command to set the crease values on the edges or vertices of a poly The crease values are
used by the smoothing algorithm
:param createHistory: (C Q E) For objects that have no construction history, this flag can
be used to force the creation of construction history for creasing By default, history
:param operation: (C Q E) Operation to perform Valid values are: 0: Crease the specified
components 1: Remove the crease values for the specified components 2: Remove all c
:param relativeValue: (C Q E) Specifies a new relative value for all selected vertex and
edge components This flag can not be used at the same time as either the value or vertexV
:param value: (C Q E M) Specifies the crease value for the selected edge components When
specified multiple times, the values are assigned respectively to the specified edg
:param vertexValue: (C Q E M) Specifies the crease value for the selected vertex components
When specified multiple times, the values are assigned respectively to the specified v
:returns: Success or Failure.
"""
pass
def FBXExportQuaternion(*args, **kwargs)->None:
"""
"""
pass
def CleanupPolygon(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EditFluidResolutionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportIncludeChildren(*args, **kwargs)->None:
"""
"""
pass
def scriptCtx(*args, allComponents: Union[bool, List[bool]]=True, allObjects: Union[bool,
List[bool]]=True, animBreakdown: Union[bool, List[bool]]=True, animCurve:
Union[bool, List[bool]]=True, animInTangent: Union[bool, List[bool]]=True,
animKeyframe: Union[bool, List[bool]]=True, animOutTangent: Union[bool,
List[bool]]=True, baseClassName: Union[AnyStr, bool]="scriptTool", camera:
Union[bool, List[bool]]=True, cluster: Union[bool, List[bool]]=True,
collisionModel: Union[bool, List[bool]]=True, controlVertex: Union[bool,
List[bool]]=True, cumulativeLists: bool=True, curve: Union[bool, List[bool]]=True,
curveKnot: Union[bool, List[bool]]=True, curveOnSurface: Union[bool,
List[bool]]=True, curveParameterPoint: Union[bool, List[bool]]=True, dimension:
Union[bool, List[bool]]=True, dynamicConstraint: Union[bool, List[bool]]=True,
edge: Union[bool, List[bool]]=True, editPoint: Union[bool, List[bool]]=True,
emitter: Union[bool, List[bool]]=True, enableRootSelection: bool=False,
escToQuit: bool=False, exists: bool=True, exitUponCompletion: bool=True,
expandSelectionList: bool=True, facet: Union[bool, List[bool]]=True, field:
Union[bool, List[bool]]=True, finalCommandScript: Union[Script, bool]=None,
fluid: Union[bool, List[bool]]=True, follicle: Union[bool, List[bool]]=True,
forceAddSelect: bool=False, hairSystem: Union[bool, List[bool]]=True, handle:
Union[bool, List[bool]]=True, history: bool=True, hull: Union[bool,
List[bool]]=True, ignoreInvalidItems: bool=True, ikEndEffector: Union[bool,
List[bool]]=True, ikHandle: Union[bool, List[bool]]=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
imagePlane: Union[bool, List[bool]]=True, implicitGeometry: Union[bool,
List[bool]]=True, isoparm: Union[bool, List[bool]]=True, joint: Union[bool,
List[bool]]=True, jointPivot: Union[bool, List[bool]]=True, lastAutoComplete:
bool=True, lattice: Union[bool, List[bool]]=True, latticePoint: Union[bool,
List[bool]]=True, light: Union[bool, List[bool]]=True, localRotationAxis:
Union[bool, List[bool]]=True, locator: Union[bool, List[bool]]=True, locatorUV:
Union[bool, List[bool]]=True, locatorXYZ: Union[bool, List[bool]]=True, nCloth:
Union[bool, List[bool]]=True, nParticle: Union[bool, List[bool]]=True,
nParticleShape: Union[bool, List[bool]]=True, nRigid: Union[bool,
List[bool]]=True, name: AnyStr="", nonlinear: Union[bool, List[bool]]=True,
nurbsCurve: Union[bool, List[bool]]=True, nurbsSurface: Union[bool,
List[bool]]=True, objectComponent: bool=True, orientationLocator: Union[bool,
List[bool]]=True, particle: Union[bool, List[bool]]=True, particleShape:
Union[bool, List[bool]]=True, plane: Union[bool, List[bool]]=True, polymesh:
Union[bool, List[bool]]=True, polymeshEdge: Union[bool, List[bool]]=True,
polymeshFace: Union[bool, List[bool]]=True, polymeshFreeEdge: Union[bool,
List[bool]]=True, polymeshUV: Union[bool, List[bool]]=True, polymeshVertex:
Union[bool, List[bool]]=True, polymeshVtxFace: Union[bool, List[bool]]=True,
rigidBody: Union[bool, List[bool]]=True, rigidConstraint: Union[bool,
List[bool]]=True, rotatePivot: Union[bool, List[bool]]=True, scalePivot:
Union[bool, List[bool]]=True, sculpt: Union[bool, List[bool]]=True, selectHandle:
Union[bool, List[bool]]=True, setAllowExcessCount: Union[bool, List[bool]]=True,
setAutoComplete: Union[bool, List[bool]]=True, setAutoToggleSelection: Union[bool,
List[bool]]=True, setDoneSelectionPrompt: Union[AnyStr, List[AnyStr]]="",
setNoSelectionHeadsUp: Union[AnyStr, List[AnyStr]]="", setNoSelectionPrompt:
Union[AnyStr, List[AnyStr]]="", setSelectionCount: Union[int, List[int]]=0,
setSelectionHeadsUp: Union[AnyStr, List[AnyStr]]="", setSelectionPrompt:
Union[AnyStr, List[AnyStr]]="", showManipulators: bool=True, spring: Union[bool,
List[bool]]=True, springComponent: Union[bool, List[bool]]=True, stroke:
Union[bool, List[bool]]=True, subdiv: Union[bool, List[bool]]=True,
subdivMeshEdge: Union[bool, List[bool]]=True, subdivMeshFace: Union[bool,
List[bool]]=True, subdivMeshPoint: Union[bool, List[bool]]=True, subdivMeshUV:
Union[bool, List[bool]]=True, surfaceEdge: Union[bool, List[bool]]=True,
surfaceFace: Union[bool, List[bool]]=True, surfaceKnot: Union[bool,
List[bool]]=True, surfaceParameterPoint: Union[bool, List[bool]]=True,
surfaceRange: Union[bool, List[bool]]=True, surfaceUV: Union[bool,
List[bool]]=True, texture: Union[bool, List[bool]]=True, title: Union[AnyStr,
bool]="", toolCursorType: Union[AnyStr, bool]="", toolFinish: Union[Script,
bool]=None, toolStart: Union[Script, bool]=None, totalSelectionSets: Union[int,
bool]=0, vertex: Union[bool, List[bool]]=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command allows a user to create their own tools based on the selection tool A number
of selection lists can be collected, the behaviour of the selection and the selection masks
are fully customizable, etc The command is processed prior to being executed The keyword
"$Selection#" where # is a number 1 or greater specifies a selection set T
:param allComponents: (C Q M) Set all component selection masks on/off
:param allObjects: (C Q M) Set all object selection masks on/off
:param animBreakdown: (C Q M) Set animation breakdown selection mask on/off
:param animCurve: (C Q M) Set animation curve selection mask on/off
:param animInTangent: (C Q M) Set animation in-tangent selection mask on/off
:param animKeyframe: (C Q M) Set animation keyframe selection mask on/off
:param animOutTangent: (C Q M) Set animation out-tangent selection mask on/off
:param baseClassName: (C Q E) This string will be used to produce MEL function names for
the property sheets for the tool For example, if "myScriptTool" was given, the functions
:param camera: (C Q M) Set camera selection mask on/off (object flag)
:param cluster: (C Q M) Set cluster selection mask on/off (object flag)
:param collisionModel: (C Q M) Set collision model selection mask on/off (object flag)
:param controlVertex: (C Q M) Set control vertex selection mask on/off (component flag)
:param cumulativeLists: (C Q E) If set, the selection lists will be cumulative For example,
the second list will contain all the items from the first list, the third all the items
:param curve: (C Q M) Set curve selection mask on/off (object flag)
:param curveKnot: (C Q M) Set curve knot selection mask on/off (component flag)
:param curveOnSurface: (C Q M) Set curve-on-surface selection mask on/off (object flag)
:param curveParameterPoint: (C Q M) Set curve parameter point selection mask on/off
(component flag)
:param dimension: (C Q M) Set dimension shape selection mask on/off (object flag)
:param dynamicConstraint: (C Q M) Set dynamicConstraint selection mask on/off (object
flag)
:param edge: (C Q M) Set mesh edge selection mask on/off (component flag)
:param editPoint: (C Q M) Set edit-point selection mask on/off (component flag)
:param emitter: (C Q M) Set emitter selection mask on/off (object flag)
:param enableRootSelection: (C Q E) If set, the items to be selected are at their root
transform level Default is false
:param escToQuit: (C Q E) If set to true, exit the tool when press "Esc" Default is false
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param exitUponCompletion: (C Q E) If set, completing the last selection set will exit the
tool Default is true
:param expandSelectionList: (C Q E) If set, the selection lists will expand to have a
single component in each item You probably want this as a default, otherwise two isoparms
on the s
:param facet: (C Q M) Set mesh face selection mask on/off (component flag)
:param field: (C Q M) Set field selection mask on/off (object flag)
:param finalCommandScript: (C Q E) Supply the script that will be run when the user presses
the enter key and the context is completed Depending on the number of selection sets you
ha
:param fluid: (C Q M) Set fluid selection mask on/off (object flag)
:param follicle: (C Q M) Set follicle selection mask on/off (object flag)
:param forceAddSelect: (C Q E) If set to true, together with -setAutoToggleSelection (see
below) on the first selection set, causes the first selection after the computation of the
:param hairSystem: (C Q M) Set hairSystem selection mask on/off (object flag)
:param handle: (C Q M) Set object handle selection mask on/off (object flag)
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param hull: (C Q M) Set hull selection mask on/off (component flag)
:param ignoreInvalidItems: (C Q E) If you have multiple selection sets, the state of the
selection set is recorded at the time you "complete it" You could then delete some of the
item
:param ikEndEffector: (C Q M) Set ik end effector selection mask on/off (object flag)
:param ikHandle: (C Q M) Set ik handle selection mask on/off (object flag)
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param imagePlane: (C Q M) Set image plane selection mask on/off (component flag)
:param implicitGeometry: (C Q M) Set implicit geometry selection mask on/off (object
flag)
:param isoparm: (C Q M) Set surface iso-parm selection mask on/off (component flag)
:param joint: (C Q M) Set ik handle selection mask on/off (object flag)
:param jointPivot: (C Q M) Set joint pivot selection mask on/off (component flag)
:param lastAutoComplete: (C Q E) True if auto complete is set for the last selection set,
false otherwise Mostly used for query, but if present in conjuction with
-sac/setAutoComple
:param lattice: (C Q M) Set lattice selection mask on/off (object flag)
:param latticePoint: (C Q M) Set lattice point selection mask on/off (component flag)
:param light: (C Q M) Set light selection mask on/off (object flag)
:param localRotationAxis: (C Q M) Set local rotation axis selection mask on/off (component
flag)
:param locator: (C Q M) Set locator (all types) selection mask on/off (object flag)
:param locatorUV: (C Q M) Set uv locator selection mask on/off (object flag)
:param locatorXYZ: (C Q M) Set xyz locator selection mask on/off (object flag)
:param nCloth: (C Q M) Set nCloth selection mask on/off (object flag)
:param nParticle: (C Q M) Set nParticle point selection mask on/off (component flag)
:param nParticleShape: (C Q M) Set nParticle shape selection mask on/off (object flag)
:param nRigid: (C Q M) Set nRigid selection mask on/off (object flag)
:param name: (C) If this is a tool command, name the tool appropriately
:param nonlinear: (C Q M) Set nonlinear selection mask on/off (object flag)
:param nurbsCurve: (C Q M) Set nurbs-curve selection mask on/off (object flag)
:param nurbsSurface: (C Q M) Set nurbs-surface selection mask on/off (object flag)
:param objectComponent: (C Q) Component flags apply to object mode
:param orientationLocator: (C Q M) Set orientation locator selection mask on/off (object
flag)
:param particle: (C Q M) Set particle point selection mask on/off (component flag)
:param particleShape: (C Q M) Set particle shape selection mask on/off (object flag)
:param plane: (C Q M) Set sketch plane selection mask on/off (object flag)
:param polymesh: (C Q M) Set poly-mesh selection mask on/off (object flag)
:param polymeshEdge: (C Q M) Set poly-mesh edge selection mask on/off (component flag)
:param polymeshFace: (C Q M) Set poly-mesh face selection mask on/off (component flag)
:param polymeshFreeEdge: (C Q M) Set poly-mesh free-edge selection mask on/off (component
flag)
:param polymeshUV: (C Q M) Set poly-mesh UV point selection mask on/off (component flag)
:param polymeshVertex: (C Q M) Set poly-mesh vertex selection mask on/off (component
flag)
:param polymeshVtxFace: (C Q M) Set poly-mesh vertexFace selection mask on/off (component
flag)
:param rigidBody: (C Q M) Set rigid body selection mask on/off (object flag)
:param rigidConstraint: (C Q M) Set rigid constraint selection mask on/off (object flag)
:param rotatePivot: (C Q M) Set rotate pivot selection mask on/off (component flag)
:param scalePivot: (C Q M) Set scale pivot selection mask on/off (component flag)
:param sculpt: (C Q M) Set sculpt selection mask on/off (object flag)
:param selectHandle: (C Q M) Set select handle selection mask on/off (component flag)
:param setAllowExcessCount: (C E M) If set, the number if items is to be interpreted as the
minimum
:param setAutoComplete: (C E M) If set to true, as soon as the specified number of items is
selected the tool will start the next selection set or run the command
:param setAutoToggleSelection: (C E M) If set to true, it is as if "shift" key is pressed
when there are no modifiers pressed That means that you get the "toggle select" behaviour
by defa
:param setDoneSelectionPrompt: (C E M) If setAutoComplete is not set (see below) this
string will be shown as soon as the tool has enough items for a particular selection set
If this is n
:param setNoSelectionHeadsUp: (C E M) Supply a string that will be shown as a heads up
prompt when there is nothing selected This must be set separately for each selection set
:param setNoSelectionPrompt: (C E M) Supply a string that will be shown as help when there
is nothing selected This must be set separately for each selection set
:param setSelectionCount: (C E M) The number of items in this selection set 0 means as
many as you need until completion
:param setSelectionHeadsUp: (C E M) Supply a string that will be shown as a heads up prompt
when there is something selected This must be set separately for each selection set
:param setSelectionPrompt: (C E M) Supply a string that will be shown as help when there is
something selected This must be set separately for each selection set
:param showManipulators: (C Q E) If set, the manipulators will be shown for any active
objects Basically, it is as if you are in the Show Manipulator tool
:param spring: (C Q M) Set spring shape selection mask on/off (object flag)
:param springComponent: (C Q M) Set individual spring selection mask on/off (component
flag)
:param stroke: (C Q M) Set the Paint Effects stroke selection mask on/off (object flag)
:param subdiv: (C Q M) Set subdivision surfaces selection mask on/off (object flag)
:param subdivMeshEdge: (C Q M) Set subdivision surfaces mesh edge selection mask on/off
(component flag)
:param subdivMeshFace: (C Q M) Set subdivision surfaces mesh face selection mask on/off
(component flag)
:param subdivMeshPoint: (C Q M) Set subdivision surfaces mesh point selection mask on/off
(component flag)
:param subdivMeshUV: (C Q M) Set subdivision surfaces mesh UV map selection mask on/off
(component flag)
:param surfaceEdge: (C Q M) Set surface edge selection mask on/off (component flag)
:param surfaceFace: (C Q M) Set surface face selection mask on/off (component flag)
:param surfaceKnot: (C Q M) Set surface knot selection mask on/off (component flag)
:param surfaceParameterPoint: (C Q M) Set surface parameter point selection mask on/off
(component flag)
:param surfaceRange: (C Q M) Set surface range selection mask on/off (component flag)
:param surfaceUV: (C Q M) Set surface uv selection mask on/off (component flag)
:param texture: (C Q M) Set texture selection mask on/off (object flag)
:param title: (C Q E) Supply a string that will be used as a precursor to all the messages;
i.e., the "name" of the tool
:param toolCursorType: (C Q E) Supply the string identifier to set the tool cursor type
when inside of tool The following are the valid ids: "create", "dolly", "edit", "pencil",
"
:param toolFinish: (C Q E) Supply the script that will be run when the user exits the
script
:param toolStart: (C Q E) Supply the script that will be run when the user first enters the
script
:param totalSelectionSets: (C Q E) Total number of selection sets
:param vertex: (C Q M) Set mesh vertex selection mask on/off (component flag)
:returns: Context name
"""
pass
def surfaceSampler(*args, camera: name=None, fileFormat: Union[AnyStr, List[AnyStr]]="",
filename: Union[AnyStr, List[AnyStr]]="", filterSize: float=0.0, filterType:
int=0, flipU: bool=True, flipV: bool=True, ignoreMirroredFaces: bool=True,
ignoreTransforms: bool=True, mapHeight: Union[int, List[int]]=0,
mapMaterials: Union[bool, List[bool]]=True, mapOutput: Union[AnyStr,
List[AnyStr]]="", mapSpace: Union[AnyStr, List[AnyStr]]="", mapWidth:
Union[int, List[int]]=0, maxSearchDistance: Union[float, List[float]]=0.0,
maximumValue: Union[float, List[float]]=0.0, overscan: int=0, searchCage:
Union[AnyStr, List[AnyStr]]="", searchMethod: int=0, searchOffset:
Union[float, List[float]]=0.0, shadows: Union[bool, List[bool]]=True,
source: Union[AnyStr, List[AnyStr]]="", sourceUVSpace: Union[AnyStr,
List[AnyStr]]="", superSampling: int=0, target: Union[AnyStr,
List[AnyStr]]="", targetUVSpace: Union[AnyStr, List[AnyStr]]="",
useGeometryNormals: bool=True, uvSet: Union[AnyStr, List[AnyStr]]="",
**kwargs)->None:
"""
Maps surface detail from a source surface to a new texture map on a target surface Both
objects must be selected when the command is invoked, with the source surface selected
first, and the target last
:param camera: (C) Specify the camera to use for camera specific lighting calculations such
as specular highlights or reflections
:param fileFormat: (C M) The image format as a file extension (e.g "dds") This must be
included once for every output map specified
:param filename: (C M) The filename to use when creating the map This must be included
once for every output map specified
:param filterSize: (C) The filter size to use in pixels Larger values (e.g over 2.0) will
produce smoother/softer results, while values closer to 1.0 will produce sharper
:param filterType: (C) The filter type to use 0 is a Guassian filter, 1 is a triangular
filter, 2 is a box filter
:param flipU: (C) Flip the U coordinate of the generated image
:param flipV: (C) Flip the V coordinate of the generated image
:param ignoreMirroredFaces: (C) Stops reverse wound (i.e mirrored) faces from contributing
to the map generation
:param ignoreTransforms: (C) Controls whether transforms are used (meaning the search is
performed in worldspace), or not (meaning the search is performed in object space)
:param mapHeight: (C M) Pixel width of the generated map This must be included once for
every output map specified
:param mapMaterials: (C M) Where appropriate (e.g normal maps), this controls whether the
material should be included when sampling the map attribute This must be included on
:param mapOutput: (C M) Specifies a new output map to create One of "normal",
"displacement" "diffuseRGB", "litAndShadedRGB", or "alpha"
:param mapSpace: (C M) The space to generate the map in Valid keyword is "object" Default
is tangent space This must be included once for every output map specified
:param mapWidth: (C M) Pixel width of the generated map Some output image formats require
even or power of 2 This must be included once for every output map specified
:param maxSearchDistance: (C M) Controls the maximum distance away from a target surface
that will be searched for source surfaces A value of 0 indicates no limit When generated
m
:param maximumValue: (C M) The maximum value to include in the map This allows control of
how floating point values (like displacement) are quantised into integer image format
:param overscan: (C) The number of additional pixels to render around UV borders This will
help to minimise texel filtering artifacts on UV seams When mipmaps are going
:param searchCage: (C M) Specifies a search envelope surface to use as a search guide when
looking for source surfaces If this flag is included, it must be included once for
:param searchMethod: (C) Controls the search method used to match sample points on a target
surface to points on the sources 0 is closest to envelope, 1 is prefer any inters
:param searchOffset: (C M) Specifies a fixed offset from a target surface to use as the
starting point when looking for source surfaces This value is only used when no search
:param shadows: (C M) Where appropriate (e.g lit and shaded), this controls whether
shadows are included in the calculation Currently only depth map shadows are supporte
:param source: (C M) Specifies a surface to use as a sampling source
:param sourceUVSpace: (C M) Specifies that the transfer of data between the surfaces should
be done in UV space and specifies the name of the UV set on the source surface(s) tha
:param superSampling: (C) Controls the number of sampling points calculated for each output
value The algorithm will use 2 ^ n squared samples for each point (so a value of 0
:param target: (C M) Specified a surface to sample output information for
:param targetUVSpace: (C M) Specifies that the transfer of data between the surfaces should
be done in UV space and specifies the name of the UV set on the target surface(s) tha
:param useGeometryNormals: (C) Controls whether geometry or surface normals are used for
surface searching Using geometry normals will ensure a smooth mapping but can introduce
di
:param uvSet: (C M) The name of the UV set to use when creating output maps If this flag
is included, it must be included once for every target
:returns:
"""
pass
def PolygonBooleanDifferenceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideControllers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dynControl(*args, **kwargs)->None:
"""
"""
pass
def nexMultiCutCtx(*args, **kwargs)->None:
"""
"""
pass
def date(*args, date: bool=True, format: AnyStr="", shortDate: bool=True, shortTime: bool=True,
time: bool=True, **kwargs)->AnyStr:
"""
Returns information about current time and date Use the predefined formats, or the -format
flag to specify the output format
:param date: (C) Returns the current date Format is YYYY/MM/DD
:param format: (C) Current second, with leading 0 if necessary
:param shortDate: (C) Returns the current date Format is MM/DD
:param shortTime: (C) Returns the current time Format is hh:mm
:param time: (C) Returns the current time Format is hh:mm:ss
:returns: Command result
"""
pass
def AddOceanDynamicLocator(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphSnapOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def goal(*args, goal: Union[AnyStr, List[AnyStr], bool]="", index: bool=True,
useTransformAsGoal: bool=True, weight: float=0.0, q=True, query=True,
**kwargs)->Union[AnyStr, Any]:
"""
Specifies the given objects as being goals for the given particle object If the goal
objects are geometry, each particle in the particle object will each try to follow or match
its position to that of a certain vertex/CV/lattice point of the goal If the goal object
is another particle object, each particle will try to follow a paricle of the goal
:param goal: (C Q M) This flag specifies string to be a goal of the particle object on the
command line or the currently selected particle object This flag can be used m
:param index: (Q) Returns array of multi-attribute indices for the goals Intended for use
by the Attribute Editor
:param useTransformAsGoal: (C) Use transform of specified object instead of the shape
Meaningful only for particle and geometry objects Can only be passed once, applies to all
ob
:param weight: (C) This specifies the goal weight as a value from 0 to 1 A value of 0
means that the goal's position will have no effect on the particle object, while
:returns: Command result
"""
pass
def displacementToPoly(*args, findBboxOnly: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[bool, Any]:
"""
Command bakes geometry with displacement mapping into a polygonal object
:param findBboxOnly: (C Q E) When used, only the bounding box scale for the displaced
object is found
:returns: Success or Failure.
"""
pass
def SelectToolOptionsMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorPaste(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertSelectionToUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SingleViewArrangement(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleGrid(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AssumePreferredAngleOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def squareSurface(*args, caching: bool=True, continuityType1: Union[int, bool]=2,
continuityType2: Union[int, bool]=2, continuityType3: Union[int, bool]=2,
continuityType4: Union[int, bool]=2, curveFitCheckpoints: Union[int, bool]=5,
endPointTolerance: Union[float, bool]=0.1, nodeState: Union[int, bool]=0,
rebuildCurve1: bool=False, rebuildCurve2: bool=False, rebuildCurve3:
bool=False, rebuildCurve4: bool=False, constructionHistory: bool=True, name:
AnyStr="", object: bool=True, polygon: int=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command produces a square surface given 3 or 4 curves This resulting square surface
is created within the intersecting region of the selected curves The order of selection is
important and the curves must intersect or their ends must meet.
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param continuityType1: (C Q E) Continuity type legal values for curve 1: 1 - fixed
boundary 2 - tangent continuity 3 - implied tangent continuity Default: 2
:param continuityType2: (C Q E) Continuity type legal values for curve 2: 1 - fixed
boundary 2 - tangent continuity 3 - implied tangent continuity Default: 2
:param continuityType3: (C Q E) Continuity type legal values for curve 3: 1 - fixed
boundary 2 - tangent continuity 3 - implied tangent continuity Default: 2
:param continuityType4: (C Q E) Continuity type legal values for curve 4: 1 - fixed
boundary 2 - tangent continuity 3 - implied tangent continuity Default: 2
:param curveFitCheckpoints: (C Q E) The number of points per span to check the tangency
deviation between the boundary curve and the created tangent square surface Only available
for t
:param endPointTolerance: (C Q E) Tolerance for end points, only used if endPoint attribute
is true Default: 0.1
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param rebuildCurve1: (C Q E) A boolean to determine if input curve 1 should be rebuilt
(with curvature continuity) Default: false
:param rebuildCurve2: (C Q E) A boolean to determine if input curve 2 should be rebuilt
(with curvature continuity) Default: false
:param rebuildCurve3: (C Q E) A boolean to determine if input curve 3 should be rebuilt
(with curvature continuity) Default: false
:param rebuildCurve4: (C Q E) A boolean to determine if input curve 4 should be rebuilt
(with curvature continuity) Default: false
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:returns: Object name and node name
"""
pass
def texSelectShortestPathCtx(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Creates a new context to select shortest edge path between two vertices or UVs in the
texture editor window
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:returns:
"""
pass
def FBXImportUpAxis(*args, **kwargs)->None:
"""
"""
pass
def XgmSplineCacheDeleteNodesAhead(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeShowDirectoriesAndFiles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PickWalkRight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateCameraOnlyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeUnpinSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def subdMapSewMove(*args, caching: bool=True, nodeState: Union[int, bool]=0,
constructionHistory: bool=True, limitPieceSize: bool=True, name: AnyStr="",
numberFaces: Union[int, bool]=0, worldSpace: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command can be used to Move and Sew together separate UV pieces along geometric edges
UV pieces that correspond to the same geometric edge, are merged together by moving the
smaller piece to the larger one The argument is a UV selection list
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param constructionHistory: (C) Turn the construction history on or off
:param limitPieceSize: (C Q E) When on, this flag specifies that the face number limit
described above should be used
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param numberFaces: (C Q E) Maximum number of faces in a UV piece When trying to combine
two UV pieces into a single one, the merge operation is rejected if the smaller piece h
:param worldSpace: (C Q E) If true, performs the operation in world space coordinates as
opposed to local space
:returns: The node name.
"""
pass
def ToggleUnsharedUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hyperPanel(*args, control: bool=True, copy: AnyStr="", createString: bool=True,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", editString: bool=True,
exists: bool=True, hyperEditor: bool=True, init: bool=True, isUnique: bool=True,
label: Union[AnyStr, bool]="", menuBarRepeatLast: bool=True, menuBarVisible:
bool=True, needsInit: bool=True, parent: AnyStr="", popupMenuProcedure:
Union[Script, bool]=None, replacePanel: AnyStr="", tearOff: bool=True,
tearOffCopy: AnyStr="", tearOffRestore: bool=True, unParent: bool=True,
useTemplate: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates, edit and queries hypergraph panels which contain only a hypergraph
editor
:param control: (Q) Returns the top level control for this panel Usually used for getting
a parent to attach popup menus CAUTION: panels may not have controls at times
:param copy: (E) Makes this panel a copy of the specified panel Both panels must be of the
same type
:param createString: (E) Command string used to create a panel
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the Maya panel
:param editString: (E) Command string used to edit a panel
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param hyperEditor: (Q) This flag returns the name of the hypergraph editor contained by
the panel
:param init: (C E) Initializes the panel's default state This is usually done
automatically on file -new and file -open
:param isUnique: (Q) Returns true if only one instance of this panel type is allowed
:param label: (Q E) Specifies the user readable label for the panel
:param menuBarRepeatLast: (C Q E) Controls whether clicking on the menu header with the
middle mouse button would repeat the last selected menu item
:param menuBarVisible: (C Q E) Controls whether the menu bar for the panel is displayed
:param needsInit: (Q E) (Internal) On Edit will mark the panel as requiring initialization
Query will return whether the panel is marked for initialization Used during fil
:param parent: (C) Specifies the parent layout for this panel
:param popupMenuProcedure: (Q E) Specifies the procedure called for building the panel's
popup menu(s) The default value is "buildPanelPopupMenu" The procedure should take one
stri
:param replacePanel: (E) Will replace the specified panel with this panel If the target
panel is within the same layout it will perform a swap
:param tearOff: (Q E) Will tear off this panel into a separate window with a paneLayout as
the parent of the panel When queried this flag will return if the panel has bee
:param tearOffCopy: (C) Will create this panel as a torn of copy of the specified source
panel
:param tearOffRestore: (C E) Restores panel if it is torn off and focus is given to it If
docked, becomes the active panel in the docked window This should be the default flag
:param unParent: (E) Specifies that the panel should be removed from its layout This
(obviously) cannot be used with query
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the panel
"""
pass
def xgmSplineQuery(*args, **kwargs)->None:
"""
"""
pass
def HideMarkers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def WhatsNewHighlightingOff(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EnableConstraints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PerspRelationshipEditorLayout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_softSelDistanceTypeGlobal(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dynamicConstraintRemove(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeCreateAsset(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeSelectCamerasAndImagePlanes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CutUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AimConstraint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllConstraints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorUnmuteSelectedTracks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PublishChildAnchorOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def commandEcho(*args, addFilter: List[AnyStr]=None, filter: Union[List[AnyStr], bool]=None,
lineNumbers: bool=True, state: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command controls what is echoed to the command window
:param addFilter: (C) This flag allows you to append filters to the current list of
filtered commands when echo all commands is enabled Just like the filter flag, you can
:param filter: (C Q) This flag allows you to filter out unwanted commands when echo all
commands is enabled You can provide a partial command name, so all commands that
:param lineNumbers: (C Q) If true then file name and line number information is provided in
error and warning messages If false then no file name and line number information
:param state: (C Q) If true then all commands are echoed to the command window If false
then only relevant commands are echoed
:returns:
"""
pass
def UVContourStretchProjectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowStrokes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ArtPaintSelectTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteExpressions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def projectCurve(*args, caching: bool=True, direction: Union[List[float, float, float],
bool]=None, directionX: Union[float, bool]=0.0, directionY: Union[float,
bool]=0.0, directionZ: Union[float, bool]=1.0, nodeState: Union[int, bool]=0,
tolerance: Union[float, bool]=0.01, useNormal: bool=False,
constructionHistory: bool=True, name: AnyStr="", object: bool=True, range:
bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The projectCurve command creates curves on surface where all selected curves project onto
the selected surfaces Projection can be done using the surface normals or the user can
specify the vector to project along Note: the user does not have to specify the curves and
surfaces in any particular order in the command line
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param direction: (C Q E) Direction of projection Available only if useNormal is false
:param directionX: (C Q E) X direction of projection Default: 0.0
:param directionY: (C Q E) Y direction of projection Default: 0.0
:param directionZ: (C Q E) Z direction of projection Default: 1.0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param tolerance: (C Q E) Tolerance to fit to Default: 0.01
:param useNormal: (C Q E) True if the surface normal is to be used and false if the
direction vector should be used instead Default: false
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param range: (C) Force a curve range on complete input curve
:returns: Object name and node name
"""
pass
def ToggleCreaseEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateTextureDeformerOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def group(*args, absolute: bool=True, empty: bool=True, name: AnyStr="", parent: AnyStr="",
relative: bool=True, useAsGroup: AnyStr="", world: bool=True, **kwargs)->AnyStr:
"""
This command groups the specified objects under a new group and returns the name of the new
group If the -em flag is specified, then an empty group (with no objects) is created If
the -w flag is specified then the new group is placed under the world, otherwise if -p is
specified it is placed under the specified node If neither -w or -p is spec
:param absolute: (C) preserve existing world object transformations (overall object
transformation is preserved by modifying the objects local transformation) [default]
:param empty: (C) create an empty group (with no objects in it)
:param name: (C) Assign given name to new group node
:param parent: (C) put the new group under the given parent
:param relative: (C) preserve existing local object transformations (relative to the new
group node)
:param useAsGroup: (C) Use the specified node as the group node The specified node must be
derived from the transform node and must not have any existing parents or childr
:param world: (C) put the new group under the world
:returns: - name of the group node
"""
pass
def dR_snapToBackfacesTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SubdivSmoothnessHull(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorFrameCenterView(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConnectToTime(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MakeCollideOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DynamicRelationshipEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtrudeVertex(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintEffectsToCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def arnoldRender(*args, **kwargs)->None:
"""
"""
pass
def Birail2Options(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AnimationSweepOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExportAnimOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AutobindContainerOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UpdateBindingSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowBaseWire(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nucleusDisplayNComponentNodes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportLights(*args, **kwargs)->None:
"""
"""
pass
def SelectPointsMask(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LastActionTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddOceanDynamicLocatorOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def referenceEdit(*args, applyFailedEdits: bool=True, changeEditTarget: List[AnyStr,
AnyStr]=None, failedEdits: bool=True, removeEdits: bool=True,
successfulEdits: bool=True, editCommand: Union[AnyStr, List[AnyStr], bool]="",
onReferenceNode: Union[AnyStr, List[AnyStr], bool]="", **kwargs)->None:
"""
Use this command to remove and change the modifications which have been applied to
references A valid commandTarget is either a reference node, a reference file, a node in a
reference, or a plug from a reference Only modifications that have been made from the
currently open scene can be changed or removed The 'referenceQuery -topReference' comma
:param applyFailedEdits: (C) Attempts to apply any unapplied edits This flag is useful if
previously failing edits have been fixed using the -changeEditTarget flag This flag ca
:param changeEditTarget: (C) Used to change a target of the specified edits This flag
takes two parameters: the old target of the edits, and the new target to change it to The
:param failedEdits: (C) This is a secondary flag used to indicate whether or not failed
edits should be acted on (e.g queried, removed, etc...) A failed edit is an edit wh
:param removeEdits: (C) Remove edits which affect the specified unloaded commandTarget
:param successfulEdits: (C) This is a secondary flag used to indicate whether or not
successful edits should be acted on (e.g queried, removed, etc...) A successful edit is
an
:param editCommand: (C Q M) This is a secondary flag used to indicate which type of
reference edits should be considered by the command If this flag is not specified all edit
t
:param onReferenceNode: (C Q M) This is a secondary flag used to indicate that only those
edits which are stored on the indicated reference node should be considered This flag
only
:returns:
"""
pass
def xgmSetActive(*args, **kwargs)->None:
"""
"""
pass
def SetKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmPrimSelectionContext(*args, **kwargs)->None:
"""
"""
pass
def nClothReplaceCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePointLightOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nop(*args, **kwargs)->None:
"""
"""
pass
def TogglePolyDisplayHardEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphEditorAlwaysDisplayTangents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeToggleZoomOut(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateClipOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddWrapInfluence(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeShapeMenuStateNoShapes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OffsetCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AppendToHairCacheOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def animView(*args, endTime: time=None, maxValue: float=0.0, minValue: float=0.0, nextView:
bool=True, previousView: bool=True, startTime: time=None, q=True, query=True,
e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This command allows you to specify the current view range within an animation editor
:param endTime: () End time to display within the editor
:param maxValue: () Upper value to display within the editor
:param minValue: () Lower value to display within the editor
:param nextView: (E) Switches to the next view
:param previousView: (E) Switches to the previous view
:param startTime: () Start time to display within the editor
:returns:
"""
pass
def attachNclothCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideFkSkeleton(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleIKSolvers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideSelectedObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorCreateDoWhileCompound(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtractSubdivSurfaceVerticesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def viewSet(*args, animate: bool=True, back: bool=True, bottom: bool=True, fit: bool=True,
fitFactor: float=0.0, front: bool=True, home: bool=True, keepRenderSettings:
bool=True, leftSide: bool=True, namespace: AnyStr="", nextView: bool=True, persp:
bool=True, previousView: bool=True, rightSide: bool=True, side: bool=True, top:
bool=True, viewNegativeX: bool=True, viewNegativeY: bool=True, viewNegativeZ:
bool=True, viewX: bool=True, viewY: bool=True, viewZ: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command positions the camera to one of the pre-defined positions If the fit flag is
set in conjunction with persp, top, side, or front, the view is "fit" based on the list of
selected objects (if there are any) or on all the objects if nothing is selected Notice
that the fit flag cannot be set in conjunction with view along axis commands lik
:param animate: (C) Specifies that the transition between camera positions should be
animated
:param back: (C) Moves the camera to the back position
:param bottom: (C) Moves the camera to the bottom position
:param fit: (C Q) Apply a viewFit after positioning camera to persp, top, side, or front
:param fitFactor: (C) Specifies how much of the view should be filled with the "fitted"
items
:param front: (C) Moves the camera to the front position
:param home: (C) Executes the camera's home attribute command Before the string is
executed, all occurances of "%camera" will be replaced by the camera's name Use t
:param keepRenderSettings: (C Q) Retain the 'renderable' flag vaue on the view Especially
important if it switches from perspective to orthographic and then back again
:param leftSide: (C) Moves the camera to the left side position
:param namespace: (C) Specifies a namespace that should be excluded All objects in the
specified namespace will be excluded from the fit process
:param nextView: (C Q) Moves the camera to the next position
:param persp: (C) Moves the camera to the persp position
:param previousView: (C Q) Moves the camera to the previous position
:param rightSide: (C) Moves the camera to the right side position
:param side: (C) Moves the camera to the (right) side position (deprecated)
:param top: (C) Moves the camera to the top position
:param viewNegativeX: (C) Moves the camera to view along negative X axis
:param viewNegativeY: (C) Moves the camera to view along negative Y axis
:param viewNegativeZ: (C) Moves the camera to view along negative Z axis
:param viewX: (C) Moves the camera to view along X axis
:param viewY: (C) Moves the camera to view along Y axis
:param viewZ: (C) Moves the camera to view along Z axis
:returns:
"""
pass
def TimeEditorSetZeroKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def alignSurface(*args, caching: bool=True, curvatureContinuity: bool=False, curvatureScale1:
Union[float, bool]=0.0, curvatureScale2: Union[float, bool]=0.0, directionU:
bool=True, joinParameter: Union[float, bool]=123456.0, nodeState: Union[int,
bool]=0, positionalContinuity: bool=True, positionalContinuityType: Union[int,
bool]=1, reverse1: bool=False, reverse2: bool=False, swap1: bool=False, swap2:
bool=False, tangentContinuity: bool=True, tangentContinuityType: Union[int,
bool]=1, tangentScale1: Union[float, bool]=1.0, tangentScale2: Union[float,
bool]=1.0, twist: bool=False, attach: bool=True, constructionHistory:
bool=True, keepMultipleKnots: bool=True, name: AnyStr="", object: bool=True,
replaceOriginal: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The surface align command is used to align surfaces in maya The main alignment options are
positional, tangent and curvature continuity Curvature continuity implies tangent
continuity NOTE: this tool is based on Studio's align tool Positional continuity means
the surfaces (move) or the ends of the surfaces (modify) are changed Tangent conti
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param curvatureContinuity: (C Q E) Curvature continuity is on if true and off otherwise
Default: false
:param curvatureScale1: (C Q E) Curvature scale applied to curvature of first surface for
curvature continuity Default: 0.0
:param curvatureScale2: (C Q E) Curvature scale applied to curvature of second surface for
curvature continuity Default: 0.0
:param directionU: (C Q E) If true use U direction of surface and V direction otherwise
Default: true
:param joinParameter: (C Q E) Parameter on reference surface where modified surface is to
be aligned to Default: 123456.0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param positionalContinuity: (C Q E) Positional continuity is on if true and off otherwise
Default: true
:param positionalContinuityType: (C Q E) Positional continuity type legal values: 1 - move
first surface, 2 - move second surface, 3 - move both surfaces, 4 - modify first surface, 5
- modif
:param reverse1: (C Q E) If true, reverse the direction (specified by directionU) of the
first input surface before doing align Otherwise, do nothing to the first input surf
:param reverse2: (C Q E) If true, reverse the direction (specified by directionU) of the
second input surface before doing align Otherwise, do nothing to the second input su
:param swap1: (C Q E) If true, swap the UV directions of the first input surface before
doing align Otherwise, do nothing to the first input surface before aligning NOTE
:param swap2: (C Q E) If true, swap the UV directions of the second input surface before
doing align Otherwise, do nothing to the second input surface before aligning NO
:param tangentContinuity: (C Q E) Tangent continuity is on if true and off otherwise
Default: true
:param tangentContinuityType: (C Q E) Tangent continuity type legal values: 1 - do tangent
continuity on first surface, 2 - do tangent continuity on second surface Default: 1
:param tangentScale1: (C Q E) Tangent scale applied to tangent of first surface for tangent
continuity Default: 1.0
:param tangentScale2: (C Q E) Tangent scale applied to tangent of second surface for
tangent continuity Default: 1.0
:param twist: (C Q E) If true, reverse the second surface in the opposite direction
(specified by directionU) before doing align This will avoid twists in the aligned sur
:param attach: (C) Should surfaces be attached after alignment?
:param constructionHistory: (C) Turn the construction history on or off
:param keepMultipleKnots: (C) Should multiple knots be kept?
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def cacheFileCombine(*args, cacheIndex: bool=True, channelName: Union[AnyStr, List[AnyStr]]="",
connectCache: Union[AnyStr, bool]="", keepWeights: bool=True, layerNode:
bool=True, nextAvailable: bool=True, object: Union[AnyStr, bool]="",
objectIndex: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Creates a cacheBlend node that can be used to combine, layer or blend multiple cacheFiles
for a given object
:param cacheIndex: (Q) A query only flag that returns the index related to the cache
specified with the connectCache flag
:param channelName: (E M) Used in conjunction with the connectCache flag to indicate the
channel(s) that should be connected If not specified, the first channel in the file i
:param connectCache: (Q E) An edit flag that specifies a cacheFile node that should be
connected to the next available index on the specified cacheBlend node As a query flag,
:param keepWeights: (E) This is a flag for use in combination with the connectCache flag
only By default, the connectCache flag will set all weights other than the newly ad
:param layerNode: (Q) A query flag that returns a string array of the existing cacheBlends
on the selected object(s) Returns an empty string array if no cacheBlends are f
:param nextAvailable: (Q) A query flag that returns the next available index on the
selected cacheBlend node
:param object: (Q) This flag is used in combination with the objectIndex flag It is used
to specify the object whose index you wish to query In query mode, this flag
:param objectIndex: (Q E) In edit mode, used in conjunction with the connectCache flag to
indicate the objectIndex to be connected In query mode, returns the index related to
:returns: Name of created cache layer node(s)
"""
pass
def CreateEmitterOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolygonCopy(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def WhatsNewStartupDialogOff(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ActivateGlobalScreenSliderModeMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ProjectCurveOnMeshOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def textScrollList(*args, allItems: bool=True, allowAutomaticSelection: bool=True,
allowMultiSelection: bool=True, annotation: Union[AnyStr, bool]="", append:
Union[AnyStr, List[AnyStr]]="", appendPosition: Union[List[int, AnyStr],
List[List[int, AnyStr]]]=None, backgroundColor: Union[List[float, float,
float], bool]=None, defineTemplate: AnyStr="", deleteKeyCommand: Script=None,
deselectAll: bool=True, deselectIndexedItem: Union[int, List[int]]=0,
deselectItem: Union[AnyStr, List[AnyStr]]="", docTag: Union[AnyStr, bool]="",
doubleClickCommand: Script=None, dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, font: Union[AnyStr,
bool]="", fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, lineFont: Union[List[int, AnyStr], List[List[int, AnyStr]]]=None,
manage: bool=True, noBackground: bool=True, numberOfItems: bool=True,
numberOfPopupMenus: bool=True, numberOfRows: Union[int, bool]=0,
numberOfSelectedItems: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, removeAll: bool=True,
removeIndexedItem: Union[int, List[int]]=0, removeItem: Union[AnyStr,
List[AnyStr]]="", selectCommand: Script=None, selectIndexedItem: Union[int,
List[int], bool]=0, selectItem: Union[AnyStr, List[AnyStr], bool]="",
selectUniqueTagItem: Union[AnyStr, List[AnyStr], bool]="", showIndexedItem:
int=0, statusBarMessage: AnyStr="", uniqueTag: Union[AnyStr,
List[AnyStr]]="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates/edits/queries a text scrolling list The list can be in single select
mode where only one item at at time is selected, or in multi-select mode where many items
may be selected Note: The -dgc/dragCallback flag works only on Windows
:param allItems: (Q) All the items
:param allowAutomaticSelection: (C Q E) Specify automatic selection mode When
automaticSelection is on each item that the mouse is over (during dragging once an item has
been selected) wil
:param allowMultiSelection: (C Q E) Specify multi or single selection mode
:param annotation: (C Q E) Annotate the control with an extra string value
:param append: (C E M) Add an item to the end of the list
:param appendPosition: (C E M) Append an item at the specified position The position is a
1-based index
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param deleteKeyCommand: (C E) Specify the command to be executed when the delete or
backspace key is pressed
:param deselectAll: (C E) Deselect all items
:param deselectIndexedItem: (C E M) Deselect the indexed item Indices are 1-based
:param deselectItem: (C E M) Deselect the item that contains the specified text
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param doubleClickCommand: (C E) Specify the command to be executed when an item is double
clicked
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param font: (C Q E) The font for the list items Valid values are "boldLabelFont",
"smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont", "o
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param lineFont: (C E M) Specify the font for a specific line of the list The indices are
1-based Valid font values are "boldLabelFont", "smallBoldLabelFont", "tinyBoldLabe
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfItems: (Q) Number of items
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param numberOfRows: (C Q E) Number of visible rows
:param numberOfSelectedItems: (Q) Number of selected items
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param removeAll: (C E) Remove all items
:param removeIndexedItem: (C E M) Remove the indexed item Indices are 1-based
:param removeItem: (C E M) Remove the item with the specified text
:param selectCommand: (C E) Specify the command to be executed when an item is selected
:param selectIndexedItem: (C Q E M) Select the indexed item Indices are 1-based
:param selectItem: (C Q E M) Select the item that contains the specified text
:param selectUniqueTagItem: (C Q E M) Allow item selections based on the unique tag In
query mode, it will return the unique tag of the selected items
:param showIndexedItem: (C E) Show the indexed item Scroll the list as necessary so that
the indexed item is visible Indices are 1-based
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param uniqueTag: (C E M) This flag can only be used in conjunction with the append or the
appendPosition flag The string specifies a unique tag for the appended item; the ta
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def mayaPreviewRenderIntoNewWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteCurrentWorkspace(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportOCMerge(*args, **kwargs)->None:
"""
"""
pass
def IncreaseCheckerDensity(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def scaleConstraint(*args, layer: AnyStr="", maintainOffset: bool=True, name: Union[AnyStr,
bool]="", offset: Union[List[float, float, float], bool]=None, remove:
bool=True, scaleCompensate: bool=True, skip: Union[AnyStr, List[AnyStr]]="",
targetList: bool=True, weight: Union[float, bool]=0.0, weightAliasList:
bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
Constrain an object's scale to the scale of the target object or to the average scale of a
number of targets A scaleConstraint takes as input one or more "target" DAG transform
nodes to which to scale the single "constraint object" DAG transform node The
scaleConstraint scales the constrained object at the weighted geometric mean of the world
sp
:param layer: (C E) Specify the name of the animation layer where the constraint should be
added
:param maintainOffset: (C) The offset necessary to preserve the constrained object's
initial scale will be calculated and used as the offset
:param name: (C Q E) Sets the name of the constraint node to the specified name Default
name is constrainedObjectName_constraintType
:param offset: (C Q E) Sets or queries the value of the offset Default is 1,1,1
:param remove: (E) removes the listed target(s) from the constraint
:param scaleCompensate: (C E) Used only when constraining a joint It specify if a
scaleCompensate will be applied on constrained joint If true it will connect
Tjoint.aCompensate
:param skip: (C E M) Specify the axis to be skipped Valid values are "x", "y", "z" and
"none" During creation, "none" is the default This flag is multi-use
:param targetList: (Q) Return the list of target objects
:param weight: (C Q E) Sets the weight value for the specified target(s) If not given at
creation time, the default value of 1.0 is used
:param weightAliasList: (Q) Returns the names of the attributes that control the weight of
the target objects Aliases are returned in the same order as the targets are returned
:returns: Name of the created constraint node
"""
pass
def RenameCurrentUVSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def replaceCacheFramesOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CopyFlexor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LockCurveLength(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def radioButtonGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0, adjustableColumn3:
int=0, adjustableColumn4: int=0, adjustableColumn5: int=0,
adjustableColumn6: int=0, annotation: Union[AnyStr, bool]="", annotation1:
Union[AnyStr, bool]="", annotation2: Union[AnyStr, bool]="", annotation3:
Union[AnyStr, bool]="", annotation4: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, changeCommand:
Script=None, changeCommand1: Script=None, changeCommand2: Script=None,
changeCommand3: Script=None, changeCommand4: Script=None, columnAlign:
Union[List[int, AnyStr], List[List[int, AnyStr]]]=None, columnAlign2:
List[AnyStr, AnyStr]=None, columnAlign3: List[AnyStr, AnyStr, AnyStr]=None,
columnAlign4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign5:
List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign6: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach: Union[List[int,
AnyStr, int], List[List[int, AnyStr, int]]]=None, columnAttach2: List[AnyStr,
AnyStr]=None, columnAttach3: List[AnyStr, AnyStr, AnyStr]=None,
columnAttach4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach5:
List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach6:
List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnOffset2:
List[int, int]=None, columnOffset3: List[int, int, int]=None, columnOffset4:
List[int, int, int, int]=None, columnOffset5: List[int, int, int, int,
int]=None, columnOffset6: List[int, int, int, int, int, int]=None,
columnWidth: Union[List[int, int], List[List[int, int]]]=None, columnWidth1:
int=0, columnWidth2: List[int, int]=None, columnWidth3: List[int, int,
int]=None, columnWidth4: List[int, int, int, int]=None, columnWidth5:
List[int, int, int, int, int]=None, columnWidth6: List[int, int, int, int,
int, int]=None, data1: Union[int, bool]=0, data2: Union[int, bool]=0, data3:
Union[int, bool]=0, data4: Union[int, bool]=0, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, editable: bool=True, enable: bool=True, enable1: bool=True,
enable2: bool=True, enable3: bool=True, enable4: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists:
bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, label: Union[AnyStr, bool]="", label1: Union[AnyStr, bool]="",
label2: Union[AnyStr, bool]="", label3: Union[AnyStr, bool]="", label4:
Union[AnyStr, bool]="", labelAnnotation: Union[AnyStr, bool]="",
labelArray2: Union[List[AnyStr, AnyStr], bool]=None, labelArray3:
Union[List[AnyStr, AnyStr, AnyStr], bool]=None, labelArray4:
Union[List[AnyStr, AnyStr, AnyStr, AnyStr], bool]=None, manage: bool=True,
noBackground: bool=True, numberOfPopupMenus: bool=True,
numberOfRadioButtons: int=0, offCommand: Script=None, offCommand1:
Script=None, offCommand2: Script=None, offCommand3: Script=None,
offCommand4: Script=None, onCommand: Script=None, onCommand1: Script=None,
onCommand2: Script=None, onCommand3: Script=None, onCommand4: Script=None,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, rowAttach: Union[List[int, AnyStr, int], List[List[int, AnyStr,
int]]]=None, select: Union[int, bool]=0, shareCollection: AnyStr="",
statusBarMessage: AnyStr="", useTemplate: AnyStr="", vertical: bool=True,
visible: bool=True, visibleChangeCommand: Union[Script, bool]=None, width:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param annotation1: (C Q E) specifies the tooptip of the first radiobutton
:param annotation2: (C Q E) specifies the tooptip of the second radiobutton
:param annotation3: (C Q E) specifies the tooptip of the third radiobutton
:param annotation4: (C Q E) specifies the tooptip of the fourth radiobutton
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the group changes state Note that this
flag should not be used in conjunction with onCommand and offCommand That is, one shou
:param changeCommand1: (C E)
:param changeCommand2: (C E)
:param changeCommand3: (C E)
:param changeCommand4: (C E) Specify a changed state command for each respective radio
button
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param data1: (C Q E)
:param data2: (C Q E)
:param data3: (C Q E)
:param data4: (C Q E) Internal data associated with each radio button
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editable: (C Q E) The edit state of the group By default, this flag is set to true
and the radio button values may be changed by clicking on them If false then the r
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enable1: (C Q E)
:param enable2: (C Q E)
:param enable3: (C Q E)
:param enable4: (C Q E) Enable state of the individual radio buttons
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) When present on creation an optional text label will be built with
the group The string specifies the label text
:param label1: (C Q E)
:param label2: (C Q E)
:param label3: (C Q E)
:param label4: (C Q E) Specify label strings for the respective radio buttons in the group
:param labelAnnotation: (C Q E) when present on creation an optional text label will be
built with the group The string specifies the label tooltip
:param labelArray2: (C Q E)
:param labelArray3: (C Q E)
:param labelArray4: (C Q E) Specify multiple labels in a single flag These flags are
ignored if the number of radio buttons doesn't match
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param numberOfRadioButtons: (C) Number of radio buttons in the group (1 - 4)
:param offCommand: (C E) Command executed when any radio button turns off
:param offCommand1: (C E)
:param offCommand2: (C E)
:param offCommand3: (C E)
:param offCommand4: (C E) Off command for each respective radio button
:param onCommand: (C E) Command executed when any radio button turns on
:param onCommand1: (C E)
:param onCommand2: (C E)
:param onCommand3: (C E)
:param onCommand4: (C E) On command for each respective radio button
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param select: (C Q E) Selected radio button The argument is a 1 based integer
:param shareCollection: (C) Specify the radioButtonGrp that this radio group is to be
associated with By default the radio group will be a separate collection
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param vertical: (C Q) Whether the orientation of the radio buttons in this group are
horizontal (default) or vertical
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def RenderIntoNewWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyQueryBlindData(*args, associationType: AnyStr="", binaryData: AnyStr="", booleanData:
bool=True, doubleData: float=0.0, intData: int=0, longDataName:
Union[AnyStr, List[AnyStr]]="", maxValue: float=0.0, minValue: float=0.0,
shortDataName: Union[AnyStr, List[AnyStr]]="", showComp: bool=True,
stringData: AnyStr="", subString: AnyStr="", typeId: int=0,
**kwargs)->AnyStr:
"""
Command query's blindData associated with particular polygonal components So, the command
will require the following to be specified: - selection list to query Optional are the: -
typeId - associationType - longDataName or shortDataName of data being queried - The
actual data being specified - showComponent flag Note that for object level blind
:param associationType: (C) Specifies the dataTypes that are part of BlindData node being
queried Allowable associations are "object" for any object, and "vertex" "edge" and "f
:param binaryData: (C) Specifies the binary string value to search for
:param booleanData: (C) Specifies the string value to search for
:param doubleData: (C) Specifies the double/float value to search for
:param intData: (C) Specifies the integer value to search for
:param longDataName: (C M) Specifies the long name of the data that is being queried by
this command
:param maxValue: (C) Specifies the maximum value to search for This option will query
float, double, and integer types of blind data
:param minValue: (C) Specifies the minimum value to search for This option will query
float, double and integer types of blind data
:param shortDataName: (C M) Specifies the short name of the data that is being queried by
this command
:param showComp: (C) The showComponent option controls whether the
object.[component].attribute name is output preceeding the actual value If the
showComponent option is
:param stringData: (C) Specifies the string value to search for
:param subString: (C) Specifies the substring that should be checked against a STRING type
blind data If the sub string is found query is successful Will not look at non
:param typeId: (C) Specifies the typeId of the BlindData type being queried If the typeId
is not specified, then all of the components that match the query will be out
:returns: Blind data
"""
pass
def xgmFreezeBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def polyClean(*args, caching: bool=True, cleanEdges: bool=True, cleanPartialUVMapping:
bool=True, cleanUVs: bool=True, cleanVertices: bool=True, constructionHistory:
bool=True, frozen: bool=True, name: AnyStr="", nodeState: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
polyClean will attempt to remove components that are invalid in the description of a poly
mesh
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param cleanEdges: (C Q E) If true, the operation will look for and delete edges that are
not associated with any face in the mesh
:param cleanPartialUVMapping: (C Q E) If true, the operation will look for any faces on the
mesh that do not have complete UV mapping Maya requires that all vertices that make up a
mesh
:param cleanUVs: (C Q E) If true, the operation will look for and delete UVs that are not
associated with any face in the mesh
:param cleanVertices: (C Q E) If true, the operation will look for and delete vertices that
are not associated with any face in the mesh
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param frozen: (C Q E) Toggle frozen state for a particular node to keep current evaluation
state and prevent any other indirect changes to it
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def bindSkin(*args, byClosestPoint: bool=True, byPartition: bool=True, colorJoints: bool=True,
delete: bool=True, doNotDescend: bool=True, enable: bool=True, name: AnyStr="",
partition: AnyStr="", toAll: bool=True, toSelectedBones: bool=True, toSkeleton:
bool=True, unbind: bool=True, unbindKeepHistory: bool=True, unlock: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command binds the currently selected objects to the currently selected skeletons
Shapes which can be bound are: meshes, nurbs curves, nurbs surfaces, lattices, subdivision
surfaces, and API shapes Multiple shapes and multiple skeletons can be bound at once by
selecting them or specifying them on the command line Selection order is not impor
:param byClosestPoint: (C) bind each point in the object to the segment closest to the
point The byClosestPoint and byPartition flags are mutually exclusive The byClosestPoin
:param byPartition: (C) bind each group in the partition to the segment closest to the
group's centroid A partition must be specified with the -p/-partition flag
:param colorJoints: (C) In bind mode, this flag assigns colors to the joints based on the
colors assigned to the joint's skin set In delete and unlock mode, this flag remov
:param delete: (C) Detach the skin on the selected skeletons and remove all bind- related
construction history
:param doNotDescend: (C) Do not descend to shapes that are parented below the selected
object(s) Bind only the selected objects
:param enable: (C) Enable or disable a bind that has been disabled on the selected
skeletons To enable the bind on selected bones only, select the bones and use the -t
:param name: (C) This flag is obsolete
:param partition: (C) Specify a partition to bind by This is only valid when used with the
-bp/-byPartition flag
:param toAll: (C) objects will be bound to the entire selected skeletons Even bones with
zero influence will be bound, whereas the toSkeleton will only bind non-zero
:param toSelectedBones: (C) objects will be bound to the selected bones only
:param toSkeleton: (C) objects will be bound to the selected skeletons The toSkeleton,
toAll and toSelectedBones flags are mutually exclusive The toSkeleton flag is the d
:param unbind: (C) unbind the selected objects They will no longer move with the skeleton
Any bindSkin history that is no longer used will be deleted
:param unbindKeepHistory: (C) unbind the selected objects They will no longer move with
the skeleton However, existing weights on the skin will be kept for use the next time the
:param unlock: (C) unlock the selected objects Since bindSkin will no longer give normal
results if bound objects are moved away from the skeleton, bindSkin locks tran
:returns: Command result
"""
pass
def container(*args, addNode: List[AnyStr]=None, asset: Union[List[AnyStr], bool]=None,
assetMember: Union[AnyStr, bool]="", bindAttr: Union[List[AnyStr, AnyStr],
bool]=None, connectionList: bool=True, current: bool=True, fileName:
Union[List[AnyStr], bool]=None, findContainer: Union[List[AnyStr], bool]=None,
force: bool=True, includeHierarchyAbove: bool=True, includeHierarchyBelow:
bool=True, includeNetwork: bool=True, includeNetworkDetails: Union[AnyStr,
List[AnyStr]]="", includeShaders: bool=True, includeShapes: bool=True,
includeTransform: bool=True, isContainer: bool=True, name: AnyStr="", nodeList:
bool=True, nodeNamePrefix: bool=True, parentContainer: bool=True, preview:
bool=True, publishAndBind: List[AnyStr, AnyStr]=None, publishAsChild:
Union[List[AnyStr, AnyStr], bool]=None, publishAsParent: Union[List[AnyStr,
AnyStr], bool]=None, publishAsRoot: List[AnyStr, bool]=None, publishAttr:
Union[AnyStr, bool]="", publishConnections: bool=True, publishName: Union[AnyStr,
bool]="", removeContainer: bool=True, removeNode: List[AnyStr]=None, type:
Union[AnyStr, bool]="", unbindAndUnpublish: AnyStr="", unbindAttr:
Union[List[AnyStr, AnyStr], bool]=None, unbindChild: AnyStr="", unbindParent:
AnyStr="", unpublishChild: AnyStr="", unpublishName: AnyStr="", unpublishParent:
AnyStr="", unsortedOrder: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create and query container nodes It is also used to perform
operations on containers such as: add and remove nodes from the container publish
attributes from nodes inside the container replace the connections and values from one
container onto another one remove a container without removing its member nodes
:param addNode: (C E) Specifies the list of nodes to add to container
:param asset: (Q) When queried, if all the nodes in nodeList belong to the same container,
returns container's name Otherwise returns empty string This flag is funct
:param assetMember: (Q) Can be used during query in conjunction with the bindAttr flag to
query for the only published attributes related to the specified node within the co
:param bindAttr: (Q E) Bind a contained attribute to an unbound published name on the
interface of the container; returns a list of bound published names The first string
:param connectionList: (Q) Returns a list of the exterior connections to the container
node
:param current: (C Q E) In create mode, specify that the newly created asset should be
current In edit mode, set the selected asset as current In query, return the current
:param fileName: (Q) Used to query for the assets associated with a given file name In
query mode, this flag needs a value
:param findContainer: (Q) When queried, if all the nodes in nodeList belong to the same
container, returns container's name Otherwise returns empty string In query mode, thi
:param force: (C E) This flag can be used in conjunction with -addNode and -removeNode
flags only If specified with -addNode, nodes will be disconnected from their curr
:param includeHierarchyAbove: (C E) Used to specify that the parent hierarchy of the
supplied node list should also be included in the container (or deleted from the container)
Hierarc
:param includeHierarchyBelow: (C E) Used to specify that the hierarchy below the supplied
node list should also be included in the container (or delete from the container)
Hierarchy in
:param includeNetwork: (C E) Used to specify that the node network connected to supplied
node list should also be included in the container Network traversal will stop at defaul
:param includeNetworkDetails: (C E M) Used to specify specific parts of the network that
should be included Valid arguments to this flag are: "channels", "sdk", "constraints",
"history"
:param includeShaders: (C E) Used to specify that for any shapes included, their shaders
will also be included in the container
:param includeShapes: (C E) Used to specify that for any transforms selected, their direct
child shapes will be included in the container (or deleted from the container) This f
:param includeTransform: (C E) Used to specify that for any shapes selected, their parent
transform will be included in the container (or deleted from the container) This flag is
:param isContainer: (Q) Return true if the selected or specified node is a container node
If multiple containers are queried, only the state of the first will be returned
:param name: (C) Sets the name of the newly-created container
:param nodeList: (Q) When queried, returns a list of nodes in container The list will be
sorted in the order they were added to the container This will also display any
:param nodeNamePrefix: (C E) Specifies that the name of published attributes should be of
the form "node_attr" Must be used with the -publishConnections/-pc flag
:param parentContainer: (Q) Flag to query the parent container of a specified container
:param preview: (C) This flag is valid in create mode only It indicates that you do not
want the container to be created, instead you want to preview its contents When
:param publishAndBind: (E) Publish the given name and bind the attribute to the given name
First string specifies the node and attribute name in "node.attr" format Second str
:param publishAsChild: (Q E) Publish contained node to the interface of the container to
indicate it can be a child of external nodes The second string is the name of the publis
:param publishAsParent: (Q E) Publish contained node to the interface of the container to
indicate it can be a parent to external nodes The second string is the name of the publi
:param publishAsRoot: (Q E) Publish or unpublish a node as a root The significance of root
transform node is twofold When container-centric selection is enabled, the root tran
:param publishAttr: (Q) In query mode, can only be used with the -publishName(-pn) flag,
and takes an attribute as an argument; returns the published name of the attribute,
:param publishConnections: (C E) Publish all connections from nodes inside the container to
nodes outside the container
:param publishName: (Q E) Publish a name to the interface of the container, and returns the
actual name published to the interface In query mode, returns the published names
:param removeContainer: (E) Disconnects all the nodes from container and deletes container
node
:param removeNode: (E) Specifies the list of nodes to remove from container If node is a
member of a nested container, it will be added to the parent container To remove
:param type: (C Q) By default, a container node will be created Alternatively, the type
flag can be used to indicate that a different type of container should be creat
:param unbindAndUnpublish: (E) Unbind the given attribute (in "node.attr" format) and
unpublish its associated name Unbinding a compound may trigger unbinds of its compound
parent
:param unbindAttr: (Q E) Unbind a published attribute from its published name on the
interface of the container, leaving an unbound published name on the interface of the con
:param unbindChild: (E) Unbind the node published as child, but do not remove its published
name from the interface of the container
:param unbindParent: (E) Unbind the node published as parent, but do not remove its
published name from the interface of the container
:param unpublishChild: (E) Unpublish node published as child from the interface of the
container
:param unpublishName: (E) Unpublish an unbound name from the interface of the container
:param unpublishParent: (E) Unpublish node published as parent from the interface of the
container
:param unsortedOrder: (Q) This flag has no effect on the operation of the container command
(OBSOLETE)
:returns: Name of the node created.
"""
pass
def SubdividePolygon(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SoftModDeformer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddAuxEffector(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def QuickRigEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def itemFilter(*args, byBin: Union[AnyStr, List[AnyStr], bool]="", byName: Union[AnyStr,
bool]="", byScript: Union[AnyStr, bool]="", byType: Union[AnyStr, List[AnyStr],
bool]="", category: Union[AnyStr, List[AnyStr], bool]="", classification:
Union[AnyStr, bool]="", clearByBin: bool=True, clearByType: bool=True,
difference: Union[List[AnyStr, AnyStr], bool]=None, exists: bool=True,
intersect: Union[List[AnyStr, AnyStr], bool]=None, listBuiltInFilters: bool=True,
listOtherFilters: bool=True, listUserFilters: bool=True, negate: bool=True,
parent: Union[AnyStr, bool]="", pythonModule: Union[AnyStr, bool]="",
secondScript: Union[AnyStr, bool]="", text: Union[AnyStr, bool]="", union:
Union[List[AnyStr, AnyStr], bool]=None, uniqueNodeNames: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a named itemFilter object This object can be attached to
selectionConnection objects, or to editors, in order to filter the item lists going through
them Using union, intersection and difference filters, complex composite filters can be
created
:param byBin: (C Q E M) The filter will only pass items whose bin list contains the given
string as a bin name This is a multi-use flag If more than one occurance of this
:param byName: (C Q E) The filter will only pass items whose names match the given regular
expression string This string can contain the special characters * and ? '?' ma
:param byScript: (C Q E) The filter will run a MEL script named by the given string on each
item name Items will pass the filter if the script returns a non-zero value The
:param byType: (C Q E M) The filter will only pass items whose typeName matches the given
string The typeName of an object can be found using the nodeType command This is a
:param category: (C Q E M) A string for categorizing the filter
:param classification: (C Q E) Indicates whether the filter is a built-in or user filter
The string argument must be either "builtIn" or "user" The "other" classification is depr
:param clearByBin: (C E) This flag will clear any existing bins associated with this
filter
:param clearByType: (C E) This flag will clear any existing typeNames associated with this
filter
:param difference: (C Q E) The filter will consist of the set difference of two other
filters, whose names are the given strings Items will pass this filter if and only if the
:param exists: (C) Returns true|false depending upon whether the specified object exists
Other flags are ignored
:param intersect: (C Q E) The filter will consist of the intersection of two other filters,
whose names are the given strings Items will pass this filter if and only if they
:param listBuiltInFilters: (Q) Returns an array of all item filters with classification
"builtIn"
:param listOtherFilters: (Q) The "other" classification is deprecated Use "user" instead
Returns an array of all item filters with classification "other"
:param listUserFilters: (Q) Returns an array of all item filters with classification
"user"
:param negate: (C Q E) This flag can be used to cause the filter to invert itself, and
reverse what passes and what fails
:param parent: (C Q E) Optional If specified, the filter's life-span is linked to that of
the parent When the parent goes out of scope, so does the filter If not specifi
:param pythonModule: (C Q E) Treat -bs/byScript and -ss/secondScript as Python functions
located in the specified module
:param secondScript: (C Q E) Cannot be used in conjunction with the -bs flag The second
script is for filtering whole lists at once, rather than individually Its signature must
:param text: (C Q E) Defines an annotation string to be stored with the filter
:param union: (C Q E) The filter will consist of the union of two other filters, whose
names are the given strings Items will pass this filter if they pass at least one o
:param uniqueNodeNames: (C Q E) Returns unique node names to script filters so there are no
naming conflicts
:returns: Single command result
"""
pass
def polyShortestPathCtx(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Creates a new context to select shortest edge path between two vertices or UVs in the 3d
viewport
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:returns:
"""
pass
def PolygonBooleanUnionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TestTexture(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeDeleteAllCamerasAndImagePlanes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def freezeOptions(*args, displayLayers: bool=True, downstream: Union[AnyStr, bool]="",
explicitPropagation: bool=True, invisible: bool=True, referencedNodes:
bool=True, runtimePropagation: bool=True, upstream: Union[AnyStr, bool]="",
q=True, query=True, **kwargs)->Union[AnyStr, Any]:
"""
This command provides access to the options used by the evaluation manager to handle
propagation and recognition of when a node is in a frozen state See the individual flags
for the different options available These values are all stored as user preferences and
persist across sessions
:param displayLayers: (C Q) If this option is enabled then any nodes that are in an enabled,
invisible display layer will be considered to be frozen, and the frozen state will p
:param downstream: (C Q) Controls how frozen state is propagated downstream from currently
frozen nodes Valid values are "none" for no propagation, "safe" for propagation do
:param explicitPropagation: (C Q) When turned on this will perform an extra pass when the
evaluation graph is constructed to perform intelligent propagation of the frozen state to
rel
:param invisible: (C Q) If this option is enabled then any nodes that are invisible, either
directly or via an invisible parent node, will be considered to be frozen, and th
:param referencedNodes: (C Q) If this option is enabled then any nodes that are referenced
in from a frozen referenced node will also be considered to be frozen, and the frozen st
:param runtimePropagation: (C Q) When turned on this will allow the frozen state to
propagate during execution of the evaluation graph See also "explicitPropagation" This
option al
:param upstream: (C Q) Controls how frozen state is propagated upstream from currently
frozen nodes Valid values are "none" for no propagation, "safe" for propagation upst
:returns: Current value of the option if querying the downstream or upstream flags
"""
pass
def SelectUVTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def superCtx(*args, **kwargs)->None:
"""
"""
pass
def AveragePolygonNormalsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteUVsWithoutHotkey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModifyPaintValueRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def texMoveContext(*args, editPivotMode: bool=True, exists: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
position: bool=True, snap: bool=True, snapComponentsRelative: bool=True,
snapPixelMode: Union[int, bool]=0, snapValue: Union[float, bool]=0.0,
tweakMode: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create, edit, or query a texture editor move manip context
Note that the above flags control the global behaviour of all texture editor move manip
contexts Changing one context independently is not allowed Changing a context's behaviour
using the above flags, will change all existing texture editor move manip contexts
:param editPivotMode: (Q) Returns true when the manipulator is in edit pivot mode
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param position: (Q) Returns the current position of the manipulator
:param snap: (Q E) Sets or queries whether snapping is to be used
:param snapComponentsRelative: (Q E) Value can be : true or false If true, while snapping
a group of UVs, the relative spacing between them will be preserved If false, all the UVs
will
:param snapPixelMode: (Q E) Sets the snapping mode to be the pixel center or upper left
corner
:param snapValue: (Q E) Sets or queries the size of the snapping increment
:param tweakMode: (Q E) When true, the manipulator is hidden and highlighted components can
be selected and moved in one step using a click-drag interaction
:returns: (the name of the new context)
"""
pass
def PolyMergeEdgesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ReattachSkeleton(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateJiggleOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSplineCacheDisableSelectedCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyAppendVertex(*args, append: Union[List[float, float, float], List[List[float, float,
float]]]=None, constructionHistory: bool=True, hole: Union[bool,
List[bool]]=True, name: AnyStr="", point: Union[List[float, float, float],
List[List[float, float, float]]]=None, texture: Union[int, bool]=0,
vertex: Union[int, List[int]]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Appends a new face to the selected polygonal object The direction of the normal is given
by the vertex order: the face normal points towards the user when the vertices rotate
counter clockwise Note that holes must be described in the opposite direction
:param append: (C M) Append a vertex or a point to the selected object, or mark the start
of a hole This flag may also be used in place of the "hole", "vertex" and "poin
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param hole: (C M) Add a hole The following points and edges will define a hole Note that
this flag should be avoided in Python You may use the "append" flag instead
:param name: (C) Give a name to the resulting node
:param point: (C M) Adds a new point to the new face Coordinates of free points are given
in the local object reference Note that this flag should be avoided in Python
:param texture: (C Q E) Specifies how new faces are mapped 0 - None; 1 - Normalize; 2 -
Unitize C: Default is 0 (no mapping) Q: When queried, this flag returns an int
:param vertex: (C M) Adds the given vertex of the selected object to the new face Note
that this flag should be avoided in Python You may use the "append" flag instead
:returns: The node name.
"""
pass
def ShowTexturePlacements(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hikGetNodeCount(*args, **kwargs)->None:
"""
"""
pass
def dgmodified(*args, **kwargs)->List[AnyStr]:
"""
The dgmodified command is used to find out which nodes in the dependency graph have been
modified This is mostly useful for fixing instances where file new asks you to save when
no changes have been made to the scene
:returns: list of all nodes that have been modified
"""
pass
def NodeEditorPublishCompound(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GoToWorkingFrame(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def KeyBlendShapeTargetsWeight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def renderPartition(*args, q=True, query=True, **kwargs)->Union[AnyStr, Any]:
"""
Set or query the model's current partition When flag q is not used, a partion name must be
passed as an argument In this case the current partition is set to that name
:returns: The render partition
"""
pass
def CreateUVsBasedOnCamera(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fluidVoxelInfo(*args, checkBounds: bool=True, inBounds: List[int, int, int]=None,
objectSpace: bool=True, radius: float=0.0, voxel: List[float, float,
float]=None, voxelCenter: bool=True, xIndex: int=0, yIndex: int=0, zIndex:
int=0, **kwargs)->None:
"""
Provides basic information about the mapping of a fluid voxel grid into world- or object
space of the fluid Use this command to determine the center point of a voxel, or to find
the voxel containing a given point, among other things
:param checkBounds: (C) If this flag is on, and the voxel index of a point that is out of
bounds is requested, then we return nothing
:param inBounds: (C) Are the three ints representing the x, y, z indices of a voxel within
the bounds of the fluid's voxel grid? True if yes, false if not (For 2D fluids
:param objectSpace: (C) Whether the queried value should be returned in object space (TRUE),
or world space (FALSE, the default)
:param radius: (C) Modifier for the -voxel flag Returns a list of index triples
identifying voxels that fall within the given radius of the point specified by the -vox
:param voxel: (C) Returns array of three ints representing the x, y, z indices of the voxel
within which the given point position is contained If the checkBounds flag
:param voxelCenter: (C) The center position of the specified voxels Returns an array of
floats (three for each of the indices in the query) (Valid only with the -xIndex, -
:param xIndex: (C) Only return values for cells with this X index
:param yIndex: (C) Only return values for cells with this Y index
:param zIndex: (C) Only return values for cells with this Z index
:returns:
"""
pass
def SmoothHairCurvesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NewtonOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def lsUI(*args, cmdTemplates: bool=True, collection: bool=True, contexts: bool=True,
controlLayouts: bool=True, controls: bool=True, dumpWidgets: bool=True, editors:
bool=True, head: int=0, long: bool=True, menuItems: bool=True, menus: bool=True,
numWidgets: bool=True, panels: bool=True, radioMenuItemCollections: bool=True, tail:
int=0, type: Union[AnyStr, List[AnyStr]]="", windows: bool=True,
**kwargs)->List[AnyStr]:
"""
This command returns the names of UI objects
:param cmdTemplates: (C) UI command templates created using ELF UI commands
:param collection: (C) Control collections created using ELF UI commands
:param contexts: (C) Tool contexts created using ELF UI commands
:param controlLayouts: (C) Control layouts created using ELF UI commands [e.g formLayouts,
paneLayouts, etc.]
:param controls: (C) Controls created using ELF UI commands [e.g buttons, checkboxes,
etc]
:param dumpWidgets: (C) Dump all QT widgets used by Maya
:param editors: (C) All currently existing editors
:param head: (C) The parameter specifies the maximum number of elements to be returned from
the beginning of the list of items (Note: each flag will return at most t
:param long: (C) Use long pathnames instead of short non-path names
:param menuItems: (C) Menu items created using ELF UI commands
:param menus: (C) Menus created using ELF UI commands
:param numWidgets: (C) Reports the number of QT widgets used by Maya
:param panels: (C) All currently existing panels
:param radioMenuItemCollections: (C) Menu item collections created using ELF UI commands
:param tail: (C) The parameter specifies the maximum number of elements to be returned from
the end of the list of items (Note: each flag will return at most this ma
:param type: (C M) List all objects of a certain type specified by the string argument For
example, "window", "menu", "control", or "controlLayout"
:param windows: (C) Windows created using ELF UI commands
:returns: The names of the object arguments.
"""
pass
def hikGetNodeIdFromName(*args, **kwargs)->None:
"""
"""
pass
def subdToPoly(*args, applyMatrixToResult: bool=True, caching: bool=True, copyUVTopology:
bool=False, depth: Union[int, bool]=0, extractPointPosition: bool=False, format:
Union[int, bool]=0, inSubdCVId: Union[List[int, int], List[List[int, int]],
bool]=None, inSubdCVIdLeft: Union[int, bool]=0, inSubdCVIdRight: Union[int,
bool]=0, maxPolys: Union[int, bool]=0, nodeState: Union[int, bool]=0,
outSubdCVId: Union[List[int, int], List[List[int, int]], bool]=None,
outSubdCVIdLeft: Union[int, bool]=0, outSubdCVIdRight: Union[int, bool]=0, outv:
Union[int, List[int], bool]=0, preserveVertexOrdering: bool=True, sampleCount:
Union[int, bool]=1, shareUVs: bool=False, subdNormals: bool=False,
addUnderTransform: bool=True, connectShaders: bool=True, constructionHistory:
bool=True, name: AnyStr="", object: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command tessellates a subdivision surface and produces polygon The name of the new
polygon is returned If construction history is ON, then the name of the new dependency
node is returned as well
:param applyMatrixToResult: (C Q E) If true, the matrix on the input geometry is applied to
the object and the resulting geometry will have identity matrix on it If false the
conversio
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param copyUVTopology: (C Q E) Copy over uv topology (shared/unshared) from the original
subdivision surface to the converted polygonal mesh Default: false
:param depth: (C Q E) The depth at which constant-depth tessellates the surface Default: 0
:param extractPointPosition: (C Q E) Determines how the position of a mesh point is
calculated If on the position of the mesh point is returned If off the position of the
point of the s
:param format: (C Q E) Format: 0 - Uniform 1 - Adaptive 2 - Polygon Count 3 - Vertices
Default: 0
:param inSubdCVId: (C Q E M) Input CV Id
:param inSubdCVIdLeft: (C Q E) Higher 32 bit integer of the input CV Id
:param inSubdCVIdRight: (C Q E) Lower 32 bit integer of the input CV Id
:param maxPolys: (C Q E) The maximum number of polygons at which by polygons tessellates
If this attribute is greater than zero, it will override the sample count and depth
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param outSubdCVId: (C Q E M) Output CV Id
:param outSubdCVIdLeft: (C Q E) Higher 32 bit integer of the output CV Id
:param outSubdCVIdRight: (C Q E) Lower 32 bit integer of the output CV Id
:param outv: (C Q E M) Out Vertices corresponding to the inSubDCVs
:param preserveVertexOrdering: (C Q E) Preserve vertex ordering in conversion Default:
true
:param sampleCount: (C Q E) The number of samples per face Default: 1
:param shareUVs: (C Q E) Force sharing of uvs on all common vertices - the value of this
attribute gets overridden by the value of the copyUVTopology attribute Default: fals
:param subdNormals: (C Q E) Keep subdiv surface normals Default: false
:param addUnderTransform: (C Q) If true then add the result underneath a transform node
:param connectShaders: (C) If true, all shader assignment will be copied from the original
subdiv surface to the converted polygonal surface Default: true
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:returns: The polygon and optionally the dependency node name
"""
pass
def NodeEditorCloseAllTabs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXProperty(*args, **kwargs)->None:
"""
"""
pass
def cmdScrollFieldExecuter(*args, annotation: Union[AnyStr, bool]="", appendText: AnyStr="",
autoCloseBraces: bool=True, backgroundColor: Union[List[float, float,
float], bool]=None, clear: bool=True, commandCompletion: bool=True,
copySelection: bool=True, currentLine: Union[int, bool]=0,
cutSelection: bool=True, defineTemplate: AnyStr="", docTag:
Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, execute: bool=True, executeAll:
bool=True, exists: bool=True, fileChangedCommand: Script=None,
filename: bool=True, filterKeyPress: Union[Script, bool]=None,
fullPathName: bool=True, hasFocus: bool=True, hasSelection:
bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, insertText: AnyStr="",
isObscured: bool=True, load: bool=True, loadContents: AnyStr="",
loadFile: AnyStr="", manage: bool=True, modificationChangedCommand:
Script=None, modified: bool=True, noBackground: bool=True,
numberOfLines: Union[int, bool]=0, numberOfPopupMenus: bool=True,
objectPathCompletion: bool=True, parent: Union[AnyStr, bool]="",
pasteSelection: bool=True, popupMenuArray: bool=True,
preventOverride: bool=True, redo: bool=True, removeStoredContents:
AnyStr="", replaceAll: List[AnyStr, AnyStr]=None, saveFile:
AnyStr="", saveSelection: AnyStr="", saveSelectionToShelf: bool=True,
searchAndSelect: bool=True, searchDown: bool=True, searchMatchCase:
bool=True, searchString: Union[AnyStr, bool]="", searchWraps:
bool=True, select: List[int, int]=None, selectAll: bool=True,
selectedText: bool=True, showLineNumbers: bool=True,
showTooltipHelp: bool=True, source: bool=True, sourceType:
Union[AnyStr, bool]="", spacesPerTab: Union[int, bool]=4,
statusBarMessage: AnyStr="", storeContents: AnyStr="",
tabsForIndent: bool=True, text: Union[AnyStr, bool]="", textLength:
bool=True, undo: bool=True, useTemplate: AnyStr="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
A script editor executer control used to issue script commands to Maya
:param annotation: (C Q E) Annotate the control with an extra string value
:param appendText: (C E) Appends text to the end of this field
:param autoCloseBraces: (C Q E) Specifies whether a closing brace should automatically be
added when hitting enter after an opening brace (default on)
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param clear: (C E) Clears the field
:param commandCompletion: (C Q E) Enable/disable command completion
:param copySelection: (C E) Copies the current selection from this field
:param currentLine: (C Q E) Sets/returns the current line which the cursor is on
:param cutSelection: (C E) Cuts the current selection from this field
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param execute: (C E) Executes the current selection If there is no selection, all text is
executed
:param executeAll: (C E) Executes all text
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fileChangedCommand: (C E) Only valid when this field contains a file Sets a script
which will be called whenever the file is externally modified, renamed or removed from
disk
:param filename: (Q) Returns the full path + filename of the script which was either loaded
or saved If there isn't one returns an empty string
:param filterKeyPress: (C Q E) Sets a script which will be called to handle key-press
events The function should have the following signature: proc int filterKeyPress(int
$modifie
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param hasFocus: (Q) Whether this control is currently in focus
:param hasSelection: (Q) Whether this control currently has a selection or not
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param insertText: (C E) Inserts the specified text into the position under the cursor,
replacing any currently selected text The selection and cursor position can be set us
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param load: (C E) Prompts the user for a script to load into this field The loaded
filename becomes associated with this executer field and saving will save directly
:param loadContents: (C E) Loads the contents of the specified filename into this field
The path and extension for this filename is provided internally This command is only i
:param loadFile: (C E) If the provided string is a fully specified file path, then attempts
to load the file contents into this field If the string is empty or not valid t
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param modificationChangedCommand: (C E) Sets a script which will be called whenever the
content of this field changes in a way that affects the modification state In MEL, the
function shou
:param modified: (Q E) Sets or returns whether the field has been modified
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfLines: (Q) Returns the total number of lines in the document
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param objectPathCompletion: (C Q E) Enable/disable path completion
:param parent: (C Q) The parent layout for this control
:param pasteSelection: (C E) Pastes text into this field at the current caret position
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param redo: (C E) Redo the last operation
:param removeStoredContents: (C E) Removes the stored contents of this field with the
specified filename The path and extension for the file is provided internally This
command is on
:param replaceAll: (C E) Replaces all instances of the first string in the field text with
the second string The case sensitivity of this operation is set with the -searchMa
:param saveFile: (C E) Saves the entire script contents of this field directly to the
specified file path
:param saveSelection: (C E) Prompts to save the current selection to a file The default
filename prompt will be prepended with the given string
:param saveSelectionToShelf: (C E) Prompts to save the current selection to an item in the
shelf
:param searchAndSelect: (Q) Searches for (and selects) the specified search string using
the specified search options
:param searchDown: (C Q E) Specifies whether to search from the cursor down, or up
:param searchMatchCase: (C Q E) Specifies whether the search is to be case sensitive or
not
:param searchString: (C Q E) Specifies the string to search for
:param searchWraps: (C Q E) Specifies whether the search should wrap around
:param select: (C E) Selects text within a specified range
:param selectAll: (C E) Selects all text
:param selectedText: (Q) The text in the current selection range
:param showLineNumbers: (C Q E) Shows/hides the line numbes column
:param showTooltipHelp: (C Q E) Enable/disable tooltips in the command execution window
:param source: (C E) Prompts the user for a script to source (execute without loading)
:param sourceType: (C Q) Sets the source type for this command executer field Valid values
are "mel" (enabled by default) and "python"
:param spacesPerTab: (C Q E) Specifies the number of spaces equivalent to one tab stop
(default 4)
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param storeContents: (C E) If the provided string is a fully specified file path, then
attempts to store the contents of this field to that path Otherwise, uses the provided s
:param tabsForIndent: (C Q E) Specifies whether tab characters should be inserted when
indenting (default on)
:param text: (C Q E) Replaces the field text with the given string
:param textLength: (Q) The number of characters in this text field
:param undo: (C E) Undo the last operation
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the executer control
"""
pass
def ShowClusters(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeSelectUtilities(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AssetEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def characterMap(*args, mapAttr: Union[List[AnyStr, AnyStr], bool]=None, mapMethod: AnyStr="",
mapNode: Union[List[AnyStr, AnyStr], bool]=None, mapping: Union[AnyStr,
bool]="", proposedMapping: bool=True, unmapAttr: List[AnyStr, AnyStr]=None,
unmapNode: List[AnyStr, AnyStr]=None, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command is used to create a correlation between the attributes of 2 or more characters
:param mapAttr: (C Q E) In query mode, this flag can be used to query the mapping stored by
the specified map node It returns an array of strings In non-query mode, this f
:param mapMethod: (C) This is is valid in create mode only It specifies how the mapping
should be done Valid options are: "byNodeName", "byAttrName", and "byAttrOrder"
:param mapNode: (C Q) This flag can be used to map all the attributes on the source node to
their matching attributes on the destination node
:param mapping: (Q) This flag is valid in query mode only It must be used before the query
flag with a string argument It is used for querying the mapping for a partic
:param proposedMapping: (Q) This flag is valid in query mode only It is used to get an
array of the mapping that the character map would prvide if called with the specified cha
:param unmapAttr: (C E) This flag can be used to unmap the mapping stored by the specified
map node
:param unmapNode: (C) This flag can be used to unmap all the attributes on the source node
to their matching attributes on the destination node Note that mapped attribute
:returns: characterMap name
"""
pass
def FBXLoadMBImportPresetFile(*args, **kwargs)->None:
"""
"""
pass
def dR_edgedFacesTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def wrinkleContext(*args, branchCount: Union[int, bool]=2, branchDepth: Union[int, bool]=0,
exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name:
AnyStr="", randomness: Union[float, bool]=0.0, style: Union[AnyStr,
bool]="radial", thickness: Union[float, bool]=0.0, wrinkleCount: Union[int,
bool]=3, wrinkleIntensity: Union[float, bool]=0.0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a context that creates wrinkles
:param branchCount: (C Q E) Set the number of branches spawned from a crease for radial
wrinkles Default is 2
:param branchDepth: (C Q E) Set the depth of branching for radial wrinkles Defaults to 0
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param randomness: (C Q E) Set the deviation of the wrinkle creases from straight lines and
other elements of the wrinkle structure Defaults to 0.2
:param style: (C Q E) Set the wrinkle characteristic shape."lines"|"radial"|"custom
Default is "radial"
:param thickness: (C Q E) Set the thickness of wrinkle creases by setting the dropoff
distance on the underlying wires
:param wrinkleCount: (C Q E) Set the number of wrinkle creases Default is 3
:param wrinkleIntensity: (C Q E) Set the depth intensity of the wrinkle furrows Defaults
to 0.5
:returns: The name of the context created
"""
pass
def ToggleIKHandleSnap(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InvertSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def disable(*args, value: bool=True, **kwargs)->None:
"""
This command enables or disables the control passed as argument
:param value: (C) If true, this command disables the control If false, this command
enables the control Default value is true (disable)
:returns:
"""
pass
def CreateSculptDeformerOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TumbleTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def textFieldButtonGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0,
adjustableColumn3: int=0, adjustableColumn4: int=0, adjustableColumn5:
int=0, adjustableColumn6: int=0, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None,
buttonCommand: Script=None, buttonLabel: Union[AnyStr, bool]="",
changeCommand: Script=None, columnAlign: Union[List[int, AnyStr],
List[List[int, AnyStr]]]=None, columnAlign2: List[AnyStr, AnyStr]=None,
columnAlign3: List[AnyStr, AnyStr, AnyStr]=None, columnAlign4:
List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign5: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign6: List[AnyStr, AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach: Union[List[int,
AnyStr, int], List[List[int, AnyStr, int]]]=None, columnAttach2:
List[AnyStr, AnyStr]=None, columnAttach3: List[AnyStr, AnyStr,
AnyStr]=None, columnAttach4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach5: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnOffset2: List[int, int]=None, columnOffset3: List[int, int,
int]=None, columnOffset4: List[int, int, int, int]=None, columnOffset5:
List[int, int, int, int, int]=None, columnOffset6: List[int, int, int,
int, int, int]=None, columnWidth: Union[List[int, int], List[List[int,
int]]]=None, columnWidth1: int=0, columnWidth2: List[int, int]=None,
columnWidth3: List[int, int, int]=None, columnWidth4: List[int, int, int,
int]=None, columnWidth5: List[int, int, int, int, int]=None,
columnWidth6: List[int, int, int, int, int, int]=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dropCallback: Script=None, editable: bool=True, enable: bool=True,
enableBackground: bool=True, enableButton: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, fileName:
Union[AnyStr, bool]="", forceChangeCommand: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float,
float, float], bool]=None, insertText: AnyStr="", insertionPosition:
Union[int, bool]=0, isObscured: bool=True, label: Union[AnyStr, bool]="",
manage: bool=True, noBackground: bool=True, numberOfPopupMenus:
bool=True, parent: Union[AnyStr, bool]="", placeholderText: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
rowAttach: Union[List[int, AnyStr, int], List[List[int, AnyStr,
int]]]=None, statusBarMessage: AnyStr="", text: Union[AnyStr, bool]="",
textChangedCommand: Script=None, useTemplate: AnyStr="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param buttonCommand: (C E) Command attached to the button
:param buttonLabel: (C Q E) Label text of the button
:param changeCommand: (C E) Command executed when the field text changes and user presses
Enter or Return
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editable: (C Q E) The edit state of the field By default, this flag is set to true
and the field value may be changed by typing into it If false then the field is 'r
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableButton: (C Q E) Enable state of the button By default, this flag is set to
true and the button is enabled Specify true, and the button will appear dimmed or greyed
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fileName: (C Q E) Text in the field as a filename This does conversions between
internal and external (UI) file representation
:param forceChangeCommand: (C E) If used together with -text or -inserText flag, change
command will be executed after text modification
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param insertText: (C E) Insert text into the field at the current insertion position
(specified by the -ip/insertionPosition flag)
:param insertionPosition: (C Q E) The insertion position for inserted text This is a 1
based value where position 1 specifies the beginning of the field Position 0 may be used
to sp
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) Label text for the group
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param placeholderText: (C Q E) Setting this property makes the line edit display a
grayed-out placeholder text as long as the text field is empty and the widget doesn't have
focus
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param text: (C Q E) Text in the field
:param textChangedCommand: (C E) Command executed immediately when the field text changes
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def RigidBodySolver(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FrameAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def psdExport(*args, alphaChannelIdx: Union[int, bool]=0, bytesPerChannel: Union[int, bool]=0,
emptyLayerSet: bool=True, format: Union[AnyStr, bool]="", layerName: Union[AnyStr,
bool]="", layerSetName: Union[AnyStr, bool]="", outFileName: Union[AnyStr,
bool]="", preMultiplyAlpha: bool=True, psdFileName: Union[AnyStr, bool]="",
q=True, query=True, **kwargs)->Union[None, Any]:
"""
Writes the Photoshop file layer set into different formats The output file depth (bit per
channel ) can be different from that of the input If the input is 16 bpc and output is 8
bpc, there will be data loss
:param alphaChannelIdx: (C Q) Index of the alpha channel to output, if not supplied, writes
out the default alpha channel The index is zero based This is useful to write out spe
:param bytesPerChannel: (C Q) Output file depth Any of these keyword: 0 for choosing depth
based on input 1 for 8 bits per channel 2 for 16 bits per channel Default is 0
:param emptyLayerSet: (C Q) Option to check if the given layer set is empty or not This
should be used in query mode and input file name and layer set names should be specified
:param format: (C Q) Output file format Any of these keyword: "iff", "sgi", "pic", "tif",
"als", "gif", "rla", "jpg" Default is iff
:param layerName: (C Q) Name of the layer to output
:param layerSetName: (C Q) Name of the layer set to output, if not supplied, writes out the
Composite image In query mode, this flag needs a value
:param outFileName: (C Q) Name(with path) of the output file
:param preMultiplyAlpha: (C Q) Option to multiply RGB colors with alpha values If (r,g,b,
a) is the value of pixel, it will be changed to (r*a, g*a, b*a, a) when this flag is used
:param psdFileName: (C Q) Name(with path) of the input Photoshop file In query mode, this
flag needs a value
:returns:
"""
pass
def evaluationManager(*args, cycleCluster: Union[AnyStr, bool]="", disableInfo: Union[AnyStr,
bool]="", empty: bool=True, enabled: bool=True, idleAction: Union[int,
bool]=0, idleBuild: bool=True, invalidate: bool=True, manipulation:
bool=True, manipulationReady: bool=True, mode: Union[AnyStr, bool]="",
downstreamFrom: Union[AnyStr, bool]="", nodeTypeGloballySerialize:
bool=True, nodeTypeParallel: bool=True, nodeTypeSerialize: bool=True,
nodeTypeUntrusted: bool=True, upstreamFrom: Union[AnyStr, bool]="",
safeMode: bool=True, q=True, query=True, **kwargs)->Union[List[AnyStr],
Any]:
"""
Handles turning on and off the evaluation manager method of evaluating the DG Query the
'mode' flag to see all available evaluation modes The special mode 'off' disables the
evaluation manager The scheduling override flags 'nodeTypeXXX' force certain node types to
use specific scheduling types, even though the node descriptions might indicate ot
:param cycleCluster: (C Q) Returns a list of nodes that are stored together with the given
one in a cycle cluster The list will be empty when the evaluation mode is not active
:param disableInfo: (Q) Returns a list of strings that contain the reasons that the
evaluation manager has been disabled (as distinct from it being deliberately turned off,
:param empty: (Q) Valid in query mode only Checks to see if the evaluation graph has any
nodes in it This is independent of the current mode
:param enabled: (Q) Valid in query mode only Checks to see if the evaluation manager is
currently enabled This is independent of the current mode
:param idleAction: (C Q) This flag sets the actions EM will perform on idle It accepts the
following values: 0 - No action 1 - Graph Rebuild 2 - EM Manipulation Preparation
:param idleBuild: (C Q) This flag is obsolete Please use the -idleAction flag with a value
of 1 in order to activate evaluation graph rebuild on idle
:param invalidate: (C Q) This flag invalidates the graph Value is used to control auto
rebuilding on idle (false) or forced (true) This command should be used as a last res
:param manipulation: (C Q) This flag is used to activate evaluation manager manipulation
support
:param manipulationReady: (Q) Valid in query mode only Checks to see if the evaluation
manager manipulation is currently ready/allowed This is independent of the current mode
:param mode: (C Q) Changes the current evaluation mode in the evaluation manager Supported
values are "off", "serial" and "parallel"
:param downstreamFrom: (C Q) Find the DG nodes that are immediately downstream of the named
one in the evaluation graph Note that the connectivity is via evaluation mode connect
:param nodeTypeGloballySerialize: (C Q) This flag is used only when the evaluation manager
is in "parallel" mode but can be set at anytime It activates or deactivates the override
to force
:param nodeTypeParallel: (C Q) This flag is used only when the evaluation manager is in
"parallel" mode but can be set at anytime It activates or deactivates the override to
force
:param nodeTypeSerialize: (C Q) This flag is used only when the evaluation manager is in
"parallel" mode but can be set at anytime It activates or deactivates the override to
force
:param nodeTypeUntrusted: (C Q) This flag is used only when the evaluation manager is in
"parallel" mode but can be set at anytime It activates or deactivates the override to
force
:param upstreamFrom: (C Q) Find the DG nodes that are immediately upstream of the named one
in the evaluation graph Note that the connectivity is via evaluation mode connectio
:param safeMode: (C Q) This flag activates/deactivates parallel evaluation safe mode When
enabled, parallel execution will fall back to serial when evaluation graph is mis
:returns: The names of all evaluation manager modes (querying without flags)
"""
pass
def DuplicateFace(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artSetPaintCtx(*args, accopacity: bool=False, afterStrokeCmd: Union[AnyStr, bool]="",
beforeStrokeCmd: Union[AnyStr, bool]="", brushalignment: bool=True,
brushfeedback: bool=True, clear: bool=True, dragSlider: AnyStr="",
dynclonemode: bool=True, exists: bool=True, expandfilename: bool=True,
exportaspectratio: Union[float, bool]=0.0, exportfilemode: Union[AnyStr,
bool]="luminance/rgb", exportfilesave: AnyStr="", exportfilesizex: Union[int,
bool]=0, exportfilesizey: Union[int, bool]=0, exportfiletype: Union[AnyStr,
bool]="", history: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", importfileload:
AnyStr="", importfilemode: Union[AnyStr, bool]="alpha", importreassign:
bool=False, lastRecorderCmd: Union[AnyStr, bool]="", lastStampName:
Union[AnyStr, bool]="", lowerradius: Union[float, bool]=0.0, makeStroke:
Union[int, List[int], bool]=0, mappressure: Union[AnyStr, bool]="none",
name: AnyStr="", objectsetnames: Union[AnyStr, bool]="", opacity:
Union[float, bool]=1.0, outline: bool=True, outwhilepaint: bool=False,
paintmode: Union[AnyStr, bool]="screen", paintoperationtype: Union[AnyStr,
bool]="Paint", pickColor: bool=True, pickValue: bool=True, playbackCursor:
Union[List[float, float], List[List[float, float]], bool]=None,
playbackPressure: Union[float, List[float], bool]=0.0, preserveclonesource:
bool=True, profileShapeFile: Union[AnyStr, bool]="", projective: bool=False,
radius: Union[float, bool]=1.0, record: bool=True, reflection: bool=False,
reflectionaboutorigin: bool=True, reflectionaxis: Union[AnyStr, bool]="x",
screenRadius: Union[float, bool]=0.0, selectclonesource: bool=True,
setcolorfeedback: bool=True, setdisplaycvs: bool=True, setopertype:
Union[AnyStr, bool]="add", settomodify: Union[AnyStr, bool]="", showactive:
bool=True, stampDepth: Union[float, bool]=0.0, stampProfile: Union[AnyStr,
bool]="", stampSpacing: Union[float, bool]=1.0, strokesmooth: Union[AnyStr,
bool]="", surfaceConformedBrushVertices: bool=True, tablet: bool=True,
tangentOutline: bool=True, usepressure: bool=False, worldRadius: Union[float,
bool]=0.0, q=True, query=True, e=True, edit=True, **kwargs)->Union[None,
Any]:
"""
This tool allows the user to modify the set membership (add, transfer, remove cvs) on nurbs
surfaces using Maya Artisan's interface
:param accopacity: (C Q E) Sets opacity accumulation on/off C: Default is false (Except
for sculpt tool for which it is true by default) Q: When queried, it returns a boolean
:param afterStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
after the end of a stroke C: Default is no command Q: When queried, it returns the curre
:param beforeStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
before the start of a stroke C: Default is no command Q: When queried, it returns the cu
:param brushalignment: (C Q E) Specifies the path brush alignemnt If true, the brush will
align to stroke path, otherwise it will align to up vector C: Default is true Q: When q
:param brushfeedback: (C Q E) Specifies if the brush additional feedback should be drawn
C: Default is TRUE Q: When queried, it returns a boolean
:param clear: (C E) Floods all cvs/vertices to the current value
:param dragSlider: (C E) Sets the current brush drag state for resizing or offsetting the
brush (like the 'b' and 'm' default hotkeys) The string argument is one of: "radius
:param dynclonemode: (C Q E) Enable or disable dynamic clone mode
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param expandfilename: (C E) If true, it will expand the name of the export file and
concatenate it with the surface name Otherwise it will take the name as it is C: Default
is
:param exportaspectratio: (C Q E) Value of aspect ratio for export
:param exportfilemode: (C Q E) Specifies the export channel.The valid entries here are:
"alpha", "luminance", "rgb", "rgba" C: Default is "luminance/rgb" Q: When queried, it
retu
:param exportfilesave: (E) Exports the attribute map and saves to a specified file
:param exportfilesizex: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfilesizey: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfiletype: (C Q E) Specifies the image file format It can be one of the
following: "iff", "tiff", "jpeg", "alias", "rgb", "fit" "postScriptEPS", "softimage",
"wavefron
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param importfileload: (E) Load the attribute map a specified file
:param importfilemode: (C Q E) Specifies the channel to import The valid entries here are:
"alpha", "luminance", "red", "green", "blue", and "rgb" C: Default is "alpha" Q: When q
:param importreassign: (C Q E) Specifies if the multiply atrribute maps are to be
reassigned while importing Only maps previously exported from within Artisan can be
reassigned C
:param lastRecorderCmd: (C Q E) Value of last recorded command
:param lastStampName: (C Q E) Value of the last stamp name
:param lowerradius: (C Q E) Sets the lower size of the brush (only apply on tablet)
:param makeStroke: (C Q E M) Stroke point values
:param mappressure: (C Q E) Sets the tablet pressure mapping when the table is used There
are four options: "none" - the pressure has no effect, "opacity" - the pressure is map
:param name: (C) If this is a tool command, name the tool appropriately
:param objectsetnames: (C Q E) Default name of object sets
:param opacity: (C Q E) Sets the brush opacity C: Default is 1.0 Q: When queried, it
returns a float
:param outline: (C Q E) Specifies if the brush should be drawn C: Default is TRUE Q: When
queried, it returns a boolean
:param outwhilepaint: (C Q E) Specifies if the brush outline should be drawn while painting
C: Default is FALSE Q: When queried, it returns a boolean
:param paintmode: (C Q E) Specifies the paint mode There are two possibilities: "screen"
and "tangent" C: Default is "screen" Q: When queried, it returns a string
:param paintoperationtype: (C Q E) Specifies the operation type used by the Paint Tool
Currently, we support the following paint modes: "Paint", "Smear", "Blur", "Erase" and
"Clone"
:param pickColor: (C Q E) Set pick color mode on or off
:param pickValue: (C Q E) Toggle for picking
:param playbackCursor: (C Q E M) Values for the playback cursor
:param playbackPressure: (C Q E M) Valus for the playback pressure
:param preserveclonesource: (C Q E) Whether or not to preserve a clone source
:param profileShapeFile: (Q E) Passes a name of the image file for the stamp shape profile
:param projective: (C Q E) Specifies the projective paint mode C: Default is 'false' Q:
When queried, it returns a boolean
:param radius: (C Q E) Sets the size of the brush C: Default is 1.0 cm Q: When queried,
it returns a float
:param record: (C Q E) Toggle on for recording
:param reflection: (C Q E) Specifies the reflection mode C: Default is 'false' Q: When
queried, it returns a boolean
:param reflectionaboutorigin: (C Q E) Toggle on to reflect about the origin
:param reflectionaxis: (C Q E) Specifies the reflection axis There are three
possibilities: "x", "y" and "z" C: Default is "x" Q: When queried, it returns a string
:param screenRadius: (C Q E) Brush radius on the screen
:param selectclonesource: (C Q E) Toggle on to select the clone source
:param setcolorfeedback: (C Q E) Specifies if the color feedback is on or off C: Default
is ON Q: When queried, it returns a boolean
:param setdisplaycvs: (C Q E) Specifies if the active cvs are displayed C: Default is ON
Q: When queried, it returns a boolean
:param setopertype: (C Q E) Specifies the setEdit operation ("add", "transfer", "remove")
C: Default is "add" Q: When queried, it returns a string
:param settomodify: (C Q E) Specifies the name of the set to modify Q: When queried, it
returns a string
:param showactive: (C Q E) Sets on/off the display of the surface isoparms C: Default is
TRUE Q: When queried, it returns a boolean
:param stampDepth: (C Q E) Depth of the stamps
:param stampProfile: (C Q E) Sets the brush profile of the current stamp Currently, the
following profiles are supported: "gaussian", "poly", "solid" and "square" C: Default is
:param stampSpacing: (C Q E) Specifies the stamp spacing Default is 1.0
:param strokesmooth: (C Q E) Stroke smoothing type name
:param surfaceConformedBrushVertices: (C Q E) Enables/disables the the display of the
effective brush area as affected vertices
:param tablet: (Q) Returns true if the tablet device is present, false if it is absent
:param tangentOutline: (C Q E) Enables/disables the display of the brush circle tangent to
the surface
:param usepressure: (C Q E) Sets the tablet pressure on/off C: Default is false Q: When
queried, it returns a boolean
:param worldRadius: (C Q E) Radius in worldspace
:returns:
"""
pass
def igConvertToLogical(*args, **kwargs)->None:
"""
"""
pass
def PublishConnectionsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolygonBooleanIntersectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cacheFile(*args, appendFrame: bool=True, attachFile: bool=True, cacheFileNode: Union[AnyStr,
List[AnyStr]]="", cacheFormat: Union[AnyStr, bool]="", cacheInfo: Union[AnyStr,
List[AnyStr], bool]="", cacheableAttrs: Union[AnyStr, bool]="", cacheableNode:
Union[AnyStr, List[AnyStr]]="", channelIndex: bool=True, channelName:
Union[AnyStr, List[AnyStr], bool]="", convertPc2: bool=True, createCacheNode:
bool=True, creationChannelName: Union[AnyStr, List[AnyStr]]="", dataSize:
bool=True, deleteCachedFrame: bool=True, descriptionFileName: bool=True,
directory: Union[AnyStr, bool]="", doubleToFloat: bool=True, endTime: time=None,
fileName: Union[AnyStr, bool]="", format: AnyStr="", geometry: bool=True, inAttr:
Union[AnyStr, List[AnyStr]]="", inTangent: AnyStr="", interpEndTime: time=None,
interpStartTime: time=None, noBackup: bool=True, outAttr: Union[AnyStr,
List[AnyStr]]="", outTangent: AnyStr="", pc2File: AnyStr="", pointCount:
bool=True, points: Union[AnyStr, List[AnyStr]]="", pointsAndNormals: Union[AnyStr,
List[AnyStr]]="", prefix: bool=True, refresh: bool=True, replaceCachedFrame:
bool=True, replaceWithoutSimulating: bool=True, runupFrames: Union[int, bool]=2,
sampleMultiplier: Union[int, bool]=1, simulationRate: Union[time, bool]=None,
singleCache: bool=True, startTime: time=None, staticCache: bool=True, worldSpace:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Creates one or more cache files on disk to store attribute data for a span of frames The
caches can be created for points/normals on a geometry (using the pts/points or
pan/pointsAndNormals flag), for vectorArray output data (using the oa/outAttr flag), or for
additional node specific data (using the cnd/cacheableNode flag for those nodes that
sup
:param appendFrame: (C) Appends data to the cache for the times specified by the startTime
and endTime flags If no time is provided, appends the current time Must be used
:param attachFile: (C) Used to indicate that rather than creating a cache file, that an
existing cache file on disk should be attached to an attribute in the scene The inA
:param cacheFileNode: (C M) Specifies the name of the cache file node(s) we are
appending/replacing to if more than one cache is attached to the specified geometries In
query m
:param cacheFormat: (C Q) Cache file format, default is Maya's .mcx format, but others
available via plugin
:param cacheInfo: (C Q M) In create mode, used to specify a mel script returning a string
array When creating the cache, this mel script will be executed and the returned str
:param cacheableAttrs: (Q) Returns the list of cacheable attributes defined on the
accompanying cache node This argument requires the use of the cacheableNode flag
:param cacheableNode: (C M) Specifies the name of a cacheable node whose contents will be
cached A cacheable node is a node that is specially designed to work with the caching
:param channelIndex: (C Q) A query-only flag which returns the channel index for the
selected geometry for the cacheFile node specified using the cacheFileNode flag
:param channelName: (C Q M) When attachFile is used, used to indicate the channel in the
file that should be attached to inAttr If not specified, the first channel in the file
:param convertPc2: (C) Convert a PC2 file to the Maya cache format (true), or convert Maya
cache to pc2 format (false)
:param createCacheNode: (C) Used to indicate that rather than creating a cache file, that a
cacheFile node should be created related to an existing cache file on disk
:param creationChannelName: (C M) When creating a new cache, this multi-use flag specifies
the channels to be cached The names come from the cacheable channel names defined by the
ob
:param dataSize: (Q) This is a query-only flag that returns the size of the data being
cached per frame This flag is to be used in conjunction with the cacheableNode, po
:param deleteCachedFrame: (C) Deletes cached data for the times specified by the
startTime/endTime flags If no time is provided, deletes the current frame Must be used in
conjun
:param descriptionFileName: (Q) This is a query-only flag that returns the name of the
description file for an existing cacheFile node Or if no cacheFile node is specified, it
retu
:param directory: (C Q) Specifies the directory where the cache files will be located If
the directory flag is not specified, the cache files will be placed in the project
:param doubleToFloat: (C) During cache creation, double data is stored in the file as
floats This helps cut down file size
:param endTime: (C) Specifies the end frame of the cache range
:param fileName: (C Q) Specifies the base file name for the cache files If more than one
object is being cached and the format is OneFilePerFrame, each cache file will be
:param format: (C) Specifies the distribution format of the cache Valid values are
"OneFile" and "OneFilePerFrame"
:param geometry: (Q) A query flag which returns the geometry controlled by the specified
cache node
:param inAttr: (C M) Specifies the name of the attribute that the cache file will drive
This file is optional when creating cache files If this flag is not used during
:param inTangent: (C) Specifies the in-tangent type when interpolating frames before the
replaced frame(s) Must be used with the ist/interpStartTime and iet/interpEndTime
:param interpEndTime: (C) Specifies the frame until which there will be linear
interpolation, beginning at endTime Must be used with the rpf/replaceCachedFrame or
apf/appendF
:param interpStartTime: (C) Specifies the frame from which to begin linear interpolation,
ending at startTime Must be used with the rpf/replaceCachedFrame or apf/appendFrame fl
:param noBackup: (C) Specifies that backup files should not be created for any files that
may be over-written during append, replace or delete cache frames Can only be u
:param outAttr: (C M) Specifies the name of the attribute that will be cached to disk In
query mode, this flag needs a value
:param outTangent: (C) Specifies the out-tangent type when interpolating frames after the
replaced frame(s) Must be used with the ist/interpStartTime and iet/interpEndTime
:param pc2File: (C) Specifies the full path to the pc2 file Must be used in conjunction
with the pc2 flag
:param pointCount: (Q) A query flag which returns the number of points stored in the cache
file The channelName flag should be used to specify the channel to be queried
:param points: (C M) Specifies the name of a geometry whose points will be cached In query
mode, this flag needs a value
:param pointsAndNormals: (C M) Specifies the name of a geometry whose points and normals
will be cached The normals is per-vertex per-polygon The normals cache cannot be
imported
:param prefix: (C) Indicates that the specified fileName should be used as a prefix for the
cacheName
:param refresh: (C) When used during cache creation, forces a screen refresh during caching
This causes the cache creation to be slower but allows you to see how the si
:param replaceCachedFrame: (C) Replaces cached data for the times specified by the
startTime/endTime flags If no time is provided, replaces cache file for the current time
Must b
:param replaceWithoutSimulating: (E) When replacing cached frames, this flag specifies
whether the replacement should come from the cached node without simulating or from
advancing time
:param runupFrames: (C Q E) Specifies the number of frames of runup to simulate ahead of
the starting frame The value must be greater than or equal to 0 The default is 2
:param sampleMultiplier: (C Q E) Specifies the sample rate when caches are being created as
a multiple of simulation Rate If the value is 1, then a sample will be cached everytime t
:param simulationRate: (C Q E) Specifies the simulation rate when caches are being created
During cache creation, the time will be advanced by the simulation rate, until the end t
:param singleCache: (C) When used in conjunction with the points, pointsAndNormal or
cacheableNode flag, specifies whether multiple geometries should be put into a single ca
:param startTime: (C) Specifies the start frame of the cache range
:param staticCache: (C Q) If false, during cache creation, do not save a cache for the
object if it appears to have no animation or deformation If true, save a cache even if
:param worldSpace: (C) If the points flag is used, turning on this flag will result in the
world space positions of the points being written The expected use of this flag
:returns: name of created cache description file(s)
"""
pass
def LookAtSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setToolTo(*args, **kwargs)->None:
"""
This command switches control to the named context
:returns:
"""
pass
def setKeyCtx(*args, breakdown: bool=True, exists: bool=True, history: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[bool, Any]:
"""
This command creates a context which may be used to set keys within the graph editor
:param breakdown: (Q E) Specifies whether or not to create breakdown keys
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Value of the breakdown flag, when queried
"""
pass
def SetProject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def defaultNavigation(*args, connectToExisting: bool=True, createNew: bool=True,
defaultAttribute: bool=True, defaultTraversal: bool=True,
defaultWorkingNode: bool=True, delete: bool=True, destination: name=None,
disconnect: bool=True, force: bool=True, ignore: bool=True,
navigatorDecisionString: AnyStr="", quiet: bool=True, relatedNodes:
bool=True, source: name=None, unignore: bool=True, **kwargs)->AnyStr:
"""
The defaultNavigation command defines default behaviours when creating or manipulating
connections between nodes and when navigating between nodes via those connections This
command is primarily used by attribute editors
:param connectToExisting: (C) Connect the destination (which is a node.attribute or simply
node) to an existing source If the source is specified (as node.attribute or simply as
:param createNew: (C) Create a new node and connect it to the node.attribute specified
using the destination flag
:param defaultAttribute: (C) Returns the name of the attribute to which a connectNodeToNode
would connect, given the source (attribute) and destination (node) flags Returns a st
:param defaultTraversal: (C) Returns the name of the node to which it would make the most
sense to navigate to from the destination node.attribute specified The destination is s
:param defaultWorkingNode: (C) Returns the name of the node which the user is most likely
to want to work with if they are interested in the attributes of the destination node The
:param delete: (C) Delete nodes with connections flowing into the node.attribute specified
by the destination flag
:param destination: (C) Specifies an existing destination attribute for a createNew or
connectToExisting
:param disconnect: (C) If used then disconnect the destination if it exists
:param force: (C) If set to true, then an attempt to connect a source attribute to a
destination attribute which already has a source will cause the existing source to
:param ignore: (C) Ignore any connections flowing into the node.attribute specified by the
destination flag
:param navigatorDecisionString: (C) This is your opportunity to pass the navigator a string
that can help it decide what behaviour to execute
:param quiet: (C) If set to true, then under no circumstances should the user be prompted
for more information Default value is false
:param relatedNodes: (C) List nodes which are conceptually related to the node.attribute
specified by the destination Related nodes may include, but are not limited to, node
:param source: (C) Specifies an existing source attribute for a connectToExisting
:param unignore: (C) Stop ignoring any connections flowing into the node.attribute
specified by the destination flag
:returns: or array of strings
"""
pass
def NodeEditorToggleZoomIn(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyCreaseCtx(*args, createSet: AnyStr="", exists: bool=True, extendSelection: bool=True,
image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", relative: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
Create a new context to crease components on polygonal objects
:param createSet: (E) Creates a set for the selected components
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param extendSelection: (C Q E) Enable/disable extending selection to all connected creased
components
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param relative: (C Q E) Enable/disable applying value relative to existing crease value
If disabled, absolute value is applied
:returns:
"""
pass
def hikGetEffectorIdFromName(*args, **kwargs)->None:
"""
"""
pass
def SetVertexNormal(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshCloneTargetToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySplitCtx2(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", adjustEdgeFlow:
Union[float, bool]=0.0, constrainToEdges: bool=True, edgeMagnets: Union[int,
bool]=0, insertWithEdgeFlow: bool=True, snapTolerance: Union[float, bool]=0.0,
snappedToEdgeColor: Union[List[float, float, float], bool]=None,
snappedToFaceColor: Union[List[float, float, float], bool]=None,
snappedToMagnetColor: Union[List[float, float, float], bool]=None,
snappedToVertexColor: Union[List[float, float, float], bool]=None, q=True,
query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Create a new context to split facets on polygonal objects
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param adjustEdgeFlow: (C Q E) The weight value of the edge vertices to be positioned
:param constrainToEdges: (C Q E) Enable/disable snapping to edge If enabled any click in
the current face will snap to the closest valid edge If there is no valid edge, the click
w
:param edgeMagnets: (C Q E) number of extra magnets to snap onto, regularly spaced along
the edge
:param insertWithEdgeFlow: (C Q E) True to enable edge flow Otherwise, the edge flow is
disabled
:param snapTolerance: (C Q E) precision for custom magnet snapping Range[0,1] Value 1
means any click on an edge will snap to either extremities or magnets
:param snappedToEdgeColor: (C Q E) Color for edge snapping
:param snappedToFaceColor: (C Q E) Color for face snapping
:param snappedToMagnetColor: (C Q E) Color for magnet snapping
:param snappedToVertexColor: (C Q E) Color for vertex snapping
:returns:
"""
pass
def IntersectSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SculptSubdivsToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GpuCacheExportAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InTangentAuto(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CenterViewOfSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorClipScaleToggle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleRotationPivots(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MoveRight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MergeEdgeToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleProxyDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UntemplateObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateWrapOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphEditorFrameAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowSmoothSkinInfluences(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectUVShell(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ZoomTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ParticleFillOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ResetWeightsToDefault(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVPlanarProjection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def psdEditTextureFile(*args, addChannel: Union[AnyStr, List[AnyStr]]="", addChannelColor:
Union[List[AnyStr, float, float, float], List[List[AnyStr, float, float,
float]]]=None, addChannelImage: Union[List[AnyStr, AnyStr],
List[List[AnyStr, AnyStr]]]=None, deleteChannel: Union[AnyStr,
List[AnyStr]]="", psdFileName: AnyStr="", snapShotImage: AnyStr="",
uvSnapPostionTop: bool=True, **kwargs)->None:
"""
Edits the existing PSD file Addition and deletion of the channels (layer sets) are
supported
:param addChannel: (C M) Adds an empty layer set with the given name to a already existing
PSD file
:param addChannelColor: (C M) (M) Specifies the filled color of the layer which is created
in a layer set given by the layer name
:param addChannelImage: (C M) (M) Specifies the image file name whose image needs to be
added as a layer to a given layer set which is the first string
:param deleteChannel: (C M) (M) Deletes the channels (layer sets) from a PSD file This is
a multiuse flag
:param psdFileName: (C) PSD file name
:param snapShotImage: (C) Image file name on the disk containing UV snapshot / reference
image
:param uvSnapPostionTop: (C) Specifies the position of UV snapshot image layer in the PSD
file "True" positions this layer at the top and "False" positions the layer at the bott
:returns:
"""
pass
def SelectAllPolygonGeometry(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TwoSideBySideViewArrangement(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleFastInteraction(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TogglePaintOnPaintableObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dynPaintCtx(*args, **kwargs)->None:
"""
"""
pass
def RenderTextureRangeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateVolumeLightOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleSelectionHandles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshBulgeToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def mouldSrf(*args, **kwargs)->None:
"""
"""
pass
def ApplySettingsToSelectedStroke(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sequenceManager(*args, addSequencerAudio: AnyStr="", attachSequencerAudio: AnyStr="",
currentShot: Union[AnyStr, bool]="", currentTime: Union[time, bool]=None,
listSequencerAudio: AnyStr="", listShots: bool=True, modelPanel:
Union[AnyStr, bool]="", node: Union[AnyStr, bool]="", writableSequencer:
Union[AnyStr, bool]="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
The sequenceManager command manages sequences, shots, and their related scenes
:param addSequencerAudio: (C) Add an audio clip to the sequencer by specifying a filename
:param attachSequencerAudio: (C) Add an audio clip to the sequencer by specifying an audio
node
:param currentShot: (Q) Returns the shot that is being used at the current sequence time
:param currentTime: (C Q) Set the current sequence time
:param listSequencerAudio: (C) List the audio clips added to the sequencer
:param listShots: (C) List all the currently defined shots across all scene segments
:param modelPanel: (C Q) Sets a dedicated modelPanel to be used as the panel that the
sequencer will control
:param node: (Q) Returns the SequenceManager node, of which there is only ever one
:param writableSequencer: (Q) Get the writable sequencer node Create it if it doesn't
exist
:returns:
"""
pass
def DeleteRigidBodies(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FlipUVsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyColorSetCmdWrapper(*args, **kwargs)->None:
"""
"""
pass
def TimeEditorClipResetTiming(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ikHandleCtx(*args, autoPriorityH: bool=True, createCurve: bool=True, createRootAxis:
bool=True, exists: bool=True, forceSolverH: bool=True, history: bool=True,
image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", name: AnyStr="", numSpans: int=1, parentCurve:
bool=True, poWeightH: Union[float, bool]=1, priorityH: Union[int, bool]=1,
rootOnCurve: bool=True, rootTwistMode: bool=True, simplifyCurve: bool=True,
snapCurve: bool=True, snapHandleH: bool=True, solverTypeH: Union[AnyStr,
bool]="", stickyH: Union[AnyStr, bool]="off", twistType: AnyStr="linear",
weightH: Union[float, bool]=1, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
The ikHandle context command (ikHandleCtx) updates parameters of ikHandle tool The options
for the tool will be set to the flags that the user specifies
:param autoPriorityH: (C Q E) Specifies that this handle's priority is assigned
automatically C: The default is off Q: When queried, this flag returns an int
:param createCurve: (C Q E) Specifies if a curve should be automatically created for the
ikSplineHandle The flag is ignored in the ikHandleCtx C: The default is on Q: When qu
:param createRootAxis: (E) Specifies if a root transform should automatically be created
above the joints affected by the ikSplineHandle This option is used to prevent the roo
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param forceSolverH: (C Q E) Specifies if the ikSolver is enabled for the ikHandle C: The
default is on Q: When queried, this flag returns an int
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param numSpans: (E) Specifies the number of spans in the automatically generated curve of
the ikSplineHandle This flag is ignored in the ikHandleCtx C: The default is
:param parentCurve: (E) Specifies if the curve should automatically be parented to the
parent of the first joint affected by the ikSplineHandle The flag is ignored in the i
:param poWeightH: (C Q E) Specifies the position/orientation weight of the ikHandle C: The
default is 1 Q: When queried, this flag returns a float
:param priorityH: (C Q E) Specifies the priority of the ikHandle C: The default is 1 Q:
When queried, this flag returns an int
:param rootOnCurve: (E) Specifies if the root is locked onto the curve of the
ikSplineHandle This flag is ignored in the ikHandleCtx C: The default is on Q: When
queried,
:param rootTwistMode: (E) Specifies whether the start joint is allowed to twist or not If
not, then the required twist is distributed over the remaining joints This applies
:param simplifyCurve: (E) Specifies if the ikSplineHandle curve should be simplified This
flag is ignored in the ikHandleCtx C: The default is on Q: When queried, this retu
:param snapCurve: (E) Specifies if the curve should automatically snap to the first joint
affected by the ikSplineHandle This flag is ignored in the ikHandleCtx C: The d
:param snapHandleH: (C Q E) Specifies if the ikHandle snapping is on C: The default is on
Q: When queried, this flag returns an int
:param solverTypeH: (C Q E) Lists what ikSolver is being used The ikSplineSolver may not
be selected To use an ikSplineSolver use the ikSplineHandleCtx command C: The default
:param stickyH: (C Q E) Specifies if the ikHandle is sticky or not Valid strings are
"sticky" and "off" C: The default is "off" Q: When queried, this flag returns a strin
:param twistType: (E) Specifies the type of interpolation to be used by the ikSplineHandle
This flag is ignored in the ikHandleCtx The interpolation options are "linear"
:param weightH: (C Q E) Specifies the weight of the ikHandle C: The default is 1 Q: When
queried, this flag returns a float
:returns: Context name
"""
pass
def PrelightPolygon(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TransplantHairOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def geomBind(*args, bindMethod: int=0, falloff: Union[float, bool]=0.0, geodesicVoxelParams:
List[int, bool]=None, maxInfluences: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This command is used to compute weights using geodesic voxel binding algorithm It works by
setting the right weights values on an already-existing skinCluster node
:param bindMethod: (C) Specifies which bind algorithm to use By default, Geodesic Voxel
will be used Available algorithms are: 3 - Geodesic Voxel
:param falloff: (C Q E) Falloff controlling the bind stiffness Valid values range from
[0..1]
:param geodesicVoxelParams: (C Q E) Specifies the geodesic voxel binding parameters This
flag is composed of three parameters: 0 - Maximum voxel grid resolution which must be a
power o
:param maxInfluences: (C Q E) Specifies the maximum influences a vertex can have By
default, all influences are used (-1)
:returns:
"""
pass
def getRenderDependencies(*args, **kwargs)->AnyStr:
"""
Command to return dependencies of an image source Image sources (such as render targets)
can depend on other upstream image sources that result from renderings of 3D scene, or
renderings of 2D compositing graphs This command returns these dependencies, so that they
can be analyzed and rendered
:returns: Dependencies for argument image source
"""
pass
def SoftModTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def psdChannelOutliner(*args, addChild: Union[List[AnyStr, AnyStr], List[List[AnyStr,
AnyStr]]]=None, allItems: bool=True, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
doubleClickCommand: AnyStr="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float,
float, float], bool]=None, isObscured: bool=True, manage: bool=True,
noBackground: bool=True, numberOfItems: bool=True, numberOfPopupMenus:
bool=True, parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, psdParent: AnyStr="", removeAll: bool=True,
removeChild: Union[AnyStr, List[AnyStr]]="", select: AnyStr="",
selectCommand: AnyStr="", selectItem: bool=True, statusBarMessage:
AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
Create a psdChannelOutliner control which is capable of displaying a tree structure upto
one level
:param addChild: (E M) This flag should be used along with the "-psdParent/ppa" flag A
string item gets added as a child to the parent specifed with "-psdParent/ppa" flag
:param allItems: (Q) Returns all the items in the form parent.child
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param doubleClickCommand: (C E) Specify the command to be executed when an item is double
clicked
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfItems: (Q) Total number of items in the control
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param psdParent: (E) Adds an item string to the controls which is treated as parent
:param removeAll: (E) Removes all the items from the control
:param removeChild: (E M) Deletes the particular child of the parent as specifed in
"-psdParent/ppa" flag
:param select: (E) Select the named item
:param selectCommand: (C E) Specify the command to be executed when an item is selected
:param selectItem: (Q) Returns the selected items
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The full name of the psdChannelOutliner control
"""
pass
def selectionConnection(*args, activeCacheList: bool=True, activeCharacterList: bool=True,
activeList: bool=True, addScript: Union[Script, bool]=None, addTo:
AnyStr="", characterList: bool=True, clear: bool=True, connectionList:
bool=True, defineTemplate: AnyStr="", deselect: name=None, editor:
Union[AnyStr, bool]="", exists: bool=True, filter: Union[AnyStr,
bool]="", findObject: Union[name, bool]=None, g: bool=True,
highlightList: bool=True, identify: bool=True, keyframeList: bool=True,
lock: bool=True, modelList: bool=True, object: Union[name, bool]=None,
parent: Union[AnyStr, bool]="", remove: AnyStr="", removeScript:
Union[Script, bool]=None, select: name=None, setList: bool=True,
switch: bool=True, useTemplate: AnyStr="", worldList: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a named selectionConnection object This object is simply a shared
selection list It may be used by editors to share their highlight data For example, an
outliner may attach its selected list to one of these objects, and a graph editor may use
the same object as a list source Then, the graph editor would only display objects
:param activeCacheList: (C) Specifies that this connection should reflect the cache that
objects on the active list belong to
:param activeCharacterList: (C) Specifies that this connection should reflect the
characters that objects on the active list belong to
:param activeList: (C) Specifies that this connection should reflect the active list
(geometry objects and keys)
:param addScript: (C Q E) Specify a script to be called when something is added to the
selection
:param addTo: (C E) The name of a selection connection that should be added to this list of
connections
:param characterList: (C) Specifies that this connection should reflect all the characters
in the world
:param clear: (C E) Remove everything from the selection connection
:param connectionList: (C Q) Specifies that this connection should contain a list of
selection connections
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param deselect: (C E) Remove something from the selection
:param editor: (C Q E) Specifies that this connection should reflect the
-mainListConnection of the specified editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Optionally specifies an itemFilter for this connection An empty
string ("") clears the current filter If a filter is specified, all the information
:param findObject: (Q) Find a selection connection in this list that wraps the specified
object
:param g: (C Q E) A global selection connection cannot be deleted by any script commands
:param highlightList: (C) Specifies that this connection is being used as a highlight list
:param identify: (Q) Find out what type of selection connection this is May be: activeList
| modelList | keyframeList | worldList | objectList listList | editorList | co
:param keyframeList: (C) Specifies that this connection should reflect the animation
portion of the active list
:param lock: (C Q E) For activeList connections, locking the connection means that it will
not listen to activeList changes
:param modelList: (C) Specifies that this connection should reflect the modeling (i.e
excluding keys) portion of the active list
:param object: (C Q E) Specifies that this connection should wrap around the specified
object (which may be a set) Query will return all the members of the selection conne
:param parent: (C Q E) The name of a UI object this should be attached to When the parent
is destroyed, the selectionConnection will auto-delete If no parent is specified
:param remove: (C E) The name of a selection connection that should be removed from this
list of connections
:param removeScript: (C Q E) Specify a script to be called when something is removed from
the selection
:param select: (C E) Add something to the selection This does not replace the existing
selection
:param setList: (C) Specifies that this connection should reflect all the sets in the
world
:param switch: (C Q) Acts as a modifier to -connectionList which sets the list of objects
to be the first non-empty selection connection selection connections are tested
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param worldList: (C) Specifies that this connection should reflect all objects in the
world
:returns: Value of the queried flag
"""
pass
def geometryMergeCacheOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateConstraint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def scmh(*args, absolute: bool=True, ignore: Union[int, List[int]]=0, quiet: bool=True,
relative: bool=True, **kwargs)->None:
"""
Set the current manipulator handle value(s) In UI units (where applicable), though the
syntax is set to handle the unit type of the current manipulator handle (if available)
:param absolute: (C) The values are absolute
:param ignore: (C M) This is a multiuse flag which specifies that the index-th (1-based)
entry is to be ignored
:param quiet: (C) This flag suppresses all error messages
:param relative: (C) The values are relative
:returns:
"""
pass
def NodeEditorShowAllCustomAttrs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeCreateTab(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PublishRootTransform(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorToggleTimeCursorPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportProtectDrivenKeys(*args, **kwargs)->None:
"""
"""
pass
def SplitMeshWithProjectedCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportColladaFrameRate(*args, **kwargs)->None:
"""
"""
pass
def recordDevice(*args, cleanup: bool=True, data: bool=True, device: Union[AnyStr,
List[AnyStr]]="", duration: Union[int, bool]=60, playback: bool=False, state:
bool=True, wait: bool=True, q=True, query=True, **kwargs)->Union[None, Any]:
"""
Starts and stops server side device recording The data is recorded at the device rate
Once recorded, the data may be brought into Maya with the applyTake command
:param cleanup: (C) Removes the recorded data from the device
:param data: (Q) Specifies if the device has recorded data If the device is recording at
the time of query, the flag will return false Q: When queried, this flag re
:param device: (C M) Specifies which device(s) to start record recording The listed
device(s) will start recording regardless of their record enable state C: The defaul
:param duration: (C Q) Duration (in seconds) of the recording When the duration expires,
the device will still be in a recording state and must be told to stop recording
:param playback: (C Q) If any attribute is connected to an animation curve, the animation
curve will play back while recording the device(s) including any animation curves
:param state: (C Q) Start or stop device recording C: The default is true Q: When queried,
this flag returns an int
:param wait: (C) If -p/playback specified, wait until playback completion before returning
control to the user This flag is ignored if -p is not used
:returns:
"""
pass
def FBXGetTakeName(*args, **kwargs)->None:
"""
"""
pass
def MakeCurvesDynamicOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def timeEditorPanel(*args, activeClipEditMode: Union[int, bool]=0, activeTabRootClipId:
bool=True, activeTabTime: bool=True, activeTabView: Union[int, bool]=0,
autoFit: Union[AnyStr, bool]="", autoFitTime: Union[AnyStr, bool]="",
control: bool=True, defineTemplate: AnyStr="", displayActiveKeyTangents:
AnyStr="", displayActiveKeys: AnyStr="", displayInfinities: AnyStr="",
displayKeys: AnyStr="", displayTangents: AnyStr="", displayValues:
AnyStr="", docTag: Union[AnyStr, bool]="", exists: bool=True, filter:
Union[AnyStr, bool]="", forceMainConnection: Union[AnyStr, bool]="",
groupIdForTabView: Union[int, bool]=0, highlightConnection: Union[AnyStr,
bool]="", keyingTarget: Union[int, bool]=0, layerId: int=0,
lockMainConnection: bool=True, lookAt: AnyStr="", mainListConnection:
Union[AnyStr, bool]="", menu: Script=None, minClipWidth: Union[int, bool]=0,
panel: Union[AnyStr, bool]="", parent: Union[AnyStr, bool]="",
selectionConnection: Union[AnyStr, bool]="", setToPrevClipEditMode:
bool=True, snapTime: Union[AnyStr, bool]="", snapToClip: bool=True,
snapToFrame: bool=True, snapTolerance: Union[int, bool]=0, snapValue:
Union[AnyStr, bool]="", stateString: bool=True, tabView: int=0, timeCursor:
bool=True, unParent: bool=True, unlockMainConnection: bool=True,
updateMainConnection: bool=True, useTemplate: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Time Editor - non-linear animation editor
:param activeClipEditMode: (Q E) Set the appropriate clip edit mode for the editor 0:
Default Mode 1: Trim Mode 2: Scale Mode 3: Loop Mode 4: Hold Mode
:param activeTabRootClipId: (Q) Get the clip id for which current active tab has been
opened In case of main tab, this will return -1 meaning there is no root clip
:param activeTabTime: (Q) Get current time displayed inside the active tab This will be
global time in case of the main tab and local time for others
:param activeTabView: (Q E) Get/set the index of the tab widget's (active) visible tab
Note: the index is zero-based
:param autoFit: (Q E) on | off | tgl Auto fit-to-view
:param autoFitTime: (Q E) on | off | tgl Auto fit-to-view along the time axis, as well
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param displayActiveKeyTangents: (E) on | off | tgl Display active key tangents in the
editor
:param displayActiveKeys: (E) on | off | tgl Display active keys in the editor
:param displayInfinities: (E) on | off | tgl Display infinities in the editor
:param displayKeys: (E) on | off | tgl Display keyframes in the editor
:param displayTangents: (E) on | off | tgl Display tangents in the editor
:param displayValues: (E) on | off | tgl Display active keys and tangents values in the
editor
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param groupIdForTabView: (Q) Get the group clip id for the given tab view index To
specify the tab index, this flag must appear before the -query flag In query mode, this
flag
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param keyingTarget: (Q E) Set keying target to specified clip ID If keying into layer,
'-layer' flag must be used In query mode, the clip id is omitted, and the name of the
:param layerId: (E) Indicate layer ID of keying target
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param lookAt: (E) all | selected | currentTime FitView helpers
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param menu: (C) Specify a script to be run when the editor is created The function will
be passed one string argument which is the new editor's name
:param minClipWidth: (Q E) Set the minimum clip width
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param setToPrevClipEditMode: (E) Revert to previous clip edit mode
:param snapTime: (Q E) none | integer | keyframe Keyframe move snap in time
:param snapToClip: (Q E) Enable/Disable snap-to-clip option in Time Editor while
manipulating and drag-and-drop clips When snapToClip is on all manipulated timing will
land
:param snapToFrame: (Q E) Enable/Disable snap-to-frame option in Time Editor while
manipulating and drag-and-drop clips When snapToFrame is on all manipulated timing will
lan
:param snapTolerance: (Q E) Set the tolerance value for snapping
:param snapValue: (Q E) none | integer | keyframe Keyframe move snap in values
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param tabView: (E) Create a tab view for the given group clip ID
:param timeCursor: (Q E) Activate the time cursor in Time Editor for scrubbing
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: Command result
"""
pass
def fluidReplaceFrames(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def parentConstraint(*args, createCache: List[float, float]=None, decompRotationToChild:
bool=True, deleteCache: bool=True, layer: AnyStr="", maintainOffset:
bool=True, name: Union[AnyStr, bool]="", remove: bool=True, skipRotate:
Union[AnyStr, List[AnyStr]]="", skipTranslate: Union[AnyStr,
List[AnyStr]]="", targetList: bool=True, weight: Union[float, bool]=0.0,
weightAliasList: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
Constrain an object's position and rotation so that it behaves as if it were a child of the
target object(s) In the case of multiple targets, the overall position and rotation of the
constrained object is the weighted average of each target's contribution to the position
and rotation of the object A parentConstraint takes as input one or more "t
:param createCache: (E) This flag is used to generate an animation curve that serves as a
cache for the constraint The two arguments define the start and end frames The ca
:param decompRotationToChild: (C) During constraint creation, if the rotation offset
between the constrained object and the target object is maintained, this flag indicates
close to w
:param deleteCache: (E) Delete an existing interpolation cache
:param layer: (C E) Specify the name of the animation layer where the constraint should be
added
:param maintainOffset: (C) If this flag is specified the position and rotation of the
constrained object will be maintained
:param name: (C Q E) Sets the name of the constraint node to the specified name Default
name is constrainedObjectName_constraintType
:param remove: (E) removes the listed target(s) from the constraint
:param skipRotate: (C M) Causes the axis specified not to be considered when constraining
rotation Valid arguments are "x", "y", "z" and "none"
:param skipTranslate: (C M) Causes the axis specified not to be considered when
constraining translation Valid arguments are "x", "y", "z" and "none"
:param targetList: (Q) Return the list of target objects
:param weight: (C Q E) Sets the weight value for the specified target(s) If not given at
creation time, the default value of 1.0 is used
:param weightAliasList: (Q) Returns the names of the attributes that control the weight of
the target objects Aliases are returned in the same order as the targets are returned
:returns: Name of the created constraint node
"""
pass
def arnoldRenderToTexture(*args, **kwargs)->None:
"""
"""
pass
def AirOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def popupMenu(*args, allowOptionBoxes: bool=True, altModifier: bool=True, button: Union[int,
bool]=0, ctrlModifier: bool=True, defineTemplate: AnyStr="", deleteAllItems:
bool=True, exists: bool=True, itemArray: bool=True, markingMenu: bool=True,
numberOfItems: bool=True, parent: AnyStr="", postMenuCommand: Script=None,
postMenuCommandOnce: bool=True, shiftModifier: bool=True, useTemplate: AnyStr="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a popup menu and attaches it to the current control if no parent is
specified The popup menu is posted with the right mouse button by default Popup menus
can be added to any kind of control, however, on some widgets, only the standard menu
button (3rd mouse button) can be used to trigger popup menus This is to meet generall
:param allowOptionBoxes: (C Q) Indicate whether the menu will be able to support option box
menu items An error results if an option box item is added to a menu that doesn't allow
:param altModifier: (C Q E) Specify this flag if the Alt modifier must be pressed when
posting the popup menu
:param button: (C Q E) Indicate which button posts the popup menu Valid values range from
1 to 3 where 1 is the left most button on the mouse
:param ctrlModifier: (C Q E) Specify this flag if the Cntl modifier must be pressed when
posting the popup menu
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param deleteAllItems: (E) Delete all the items in this menu
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param itemArray: (Q) Return string array of the menu item names
:param markingMenu: (C Q E) Set the marking menu state of this popup menu
:param numberOfItems: (Q) Return number of items in the menu
:param parent: (C) Specify the control that the popup menu will appear in
:param postMenuCommand: (C E) Specify a script to be executed when the popup menu is about
to be shown
:param postMenuCommandOnce: (C Q E) Indicate the -pmc/postMenuCommand should only be
invoked once Default value is false, ie the -pmc/postMenuCommand is invoked every time
the popup m
:param shiftModifier: (C Q E) Specify this flag if the Shift modifier must be pressed when
posting the popup menu
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: Full path name to the menu.
"""
pass
def SaveSceneAs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artPuttyCtx(*args, accopacity: bool=False, activeListChangedProc: Union[AnyStr, bool]="",
afterStrokeCmd: Union[AnyStr, bool]="", alphaclamp: Union[AnyStr, bool]="none",
alphaclamplower: Union[float, bool]=0.0, alphaclampupper: Union[float,
bool]=1.0, attrSelected: Union[AnyStr, bool]="", autosmooth: bool=False,
beforeStrokeCmd: Union[AnyStr, bool]="", brushStrength: Union[float, bool]=1.0,
brushalignment: bool=True, brushfeedback: bool=True, clamp: Union[AnyStr,
bool]="none", clamplower: Union[float, bool]=0.0, clampupper: Union[float,
bool]=1.0, clear: bool=True, collapsecvtol: Union[float, bool]=0.005,
colorAlphaValue: Union[float, bool]=0.0, colorRGBAValue: Union[List[float,
float, float, float], bool]=None, colorRGBValue: Union[List[float, float,
float], bool]=None, colorRamp: Union[AnyStr, bool]="", colorfeedback:
bool=False, colorfeedbackOverride: bool=False, colorrangelower: Union[float,
bool]=0.0, colorrangeupper: Union[float, bool]=1.0, dataTypeIndex: Union[int,
bool]=0, disablelighting: bool=False, dispdecr: bool=True, dispincr: bool=True,
dragSlider: AnyStr="", duringStrokeCmd: Union[AnyStr, bool]="", dynclonemode:
bool=True, erasesrfupd: bool=True, exists: bool=True, expandfilename: bool=True,
exportaspectratio: Union[float, bool]=0.0, exportfilemode: Union[AnyStr,
bool]="luminance/rgb", exportfilesave: AnyStr="", exportfilesizex: Union[int,
bool]=0, exportfilesizey: Union[int, bool]=0, exportfiletype: Union[AnyStr,
bool]="", filterNodes: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
importfileload: AnyStr="", importfilemode: Union[AnyStr, bool]="alpha",
importreassign: bool=False, interactiveUpdate: bool=True, invertrefvector:
bool=False, lastRecorderCmd: Union[AnyStr, bool]="", lastStampName:
Union[AnyStr, bool]="", lowerradius: Union[float, bool]=0.0, makeStroke:
Union[int, List[int], bool]=0, mappressure: Union[AnyStr, bool]="none",
maxdisp: Union[float, bool]=1.0, maxvalue: Union[float, bool]=1.0, minvalue:
Union[float, bool]=0.0, mouldtypehead: Union[AnyStr, bool]="", mouldtypemouse:
Union[AnyStr, bool]="push", mouldtypetail: Union[AnyStr, bool]="", name:
AnyStr="", objattrArray: Union[AnyStr, bool]="", opacity: Union[float,
bool]=1.0, outline: bool=True, outwhilepaint: bool=False, paintNodeArray:
Union[AnyStr, bool]="", paintattrselected: AnyStr="", paintmode: Union[AnyStr,
bool]="screen", paintoperationtype: Union[AnyStr, bool]="Paint", pickColor:
bool=True, pickValue: bool=True, playbackCursor: Union[List[float, float],
List[List[float, float]], bool]=None, playbackPressure: Union[float,
List[float], bool]=0.0, polecv: bool=True, preserveclonesource: bool=True,
profileShapeFile: Union[AnyStr, bool]="", projective: bool=False, radius:
Union[float, bool]=1.0, rampMaxColor: Union[List[float, float, float],
bool]=None, rampMinColor: Union[List[float, float, float], bool]=None, record:
bool=True, reflection: bool=False, reflectionaboutorigin: bool=True,
reflectionaxis: Union[AnyStr, bool]="x", refsurface: bool=True, refvector:
Union[AnyStr, bool]="normal", refvectoru: Union[float, bool]=0.0, refvectorv:
Union[float, bool]=0.0, screenRadius: Union[float, bool]=0.0,
selectclonesource: bool=True, selectedattroper: Union[AnyStr, bool]="absolute",
showactive: bool=True, smoothiters: Union[int, bool]=3, stampDepth: Union[float,
bool]=0.0, stampProfile: Union[AnyStr, bool]="", stampSpacing: Union[float,
bool]=1.0, stitchcorner: bool=True, stitchedgeflood: bool=True, stitchtype:
Union[AnyStr, bool]="position", strokesmooth: Union[AnyStr, bool]="",
surfaceConformedBrushVertices: bool=True, tablet: bool=True, tangentOutline:
bool=True, toolOffProc: Union[AnyStr, bool]="", toolOnProc: Union[AnyStr,
bool]="", updateerasesrf: bool=True, updaterefsrf: bool=True, useColorRamp:
bool=True, useMaxMinColor: bool=True, usepressure: bool=False, value:
Union[float, bool]=0.0, whichTool: Union[AnyStr, bool]="", worldRadius:
Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This is a context command to set the flags on the artAttrContext, which is the base context
for attribute painting operations All commands require the name of the context as the last
argument as this provides the name of the context to create, edit or query This command
is used to modify NURBS surfaces using a brush based interface (Maya Artisan
:param accopacity: (C Q E) Sets opacity accumulation on/off C: Default is false (Except
for sculpt tool for which it is true by default) Q: When queried, it returns a boolean
:param activeListChangedProc: (C Q E) Accepts a string that contains a MEL command that is
invoked whenever the active list changes There may be some situations where the UI, for
example
:param afterStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
after the end of a stroke C: Default is no command Q: When queried, it returns the curre
:param alphaclamp: (C Q E) Specifies if the weight value should be alpha clamped to the
lower and upper bounds There are four options here: "none" - no clamping is performed,
:param alphaclamplower: (C Q E) Specifies the lower bound for the alpha values C: Default
is 0.0 Q: When queried, it returns a float
:param alphaclampupper: (C Q E) Specifies the upper bound for the alpha values C: Default
is 1.0 Q: When queried, it returns a float
:param attrSelected: (Q) Returns a name of the currently selected attribute Q: When
queried, it returns a string
:param autosmooth: (C Q E) Sets up the auto smoothing option When the brush is in the
smooth mode, adjusting the strength will adjust how fast the surfaces is smoothed out C:
:param beforeStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
before the start of a stroke C: Default is no command Q: When queried, it returns the cu
:param brushStrength: (C Q E) Sets the strength of the brush Brush strength is supported
by the pinch and slide brushes In pinch mode, adjusting the strength will adjust how qui
:param brushalignment: (C Q E) Specifies the path brush alignemnt If true, the brush will
align to stroke path, otherwise it will align to up vector C: Default is true Q: When q
:param brushfeedback: (C Q E) Specifies if the brush additional feedback should be drawn
C: Default is TRUE Q: When queried, it returns a boolean
:param clamp: (C Q E) Specifies if the weight value should be clamped to the lower and
upper bounds There are four options here: "none" - no clamping is performed, "lower
:param clamplower: (C Q E) Specifies the lower bound for the values C: Default is 0.0 Q:
When queried, it returns a float
:param clampupper: (C Q E) Specifies the upper bound for the values C: Default is 1.0 Q:
When queried, it returns a float
:param clear: (C E) Floods all cvs/vertices to the current value
:param collapsecvtol: (C Q E) Specifies the tolerance for the collapse cv detection C:
Default is 0.005 cm Q: When queried, it returns a float
:param colorAlphaValue: (C Q E) The Alpha value of the color
:param colorRGBAValue: (C Q E) The RGBA value of the color
:param colorRGBValue: (C Q E) The RGB value of the color
:param colorRamp: (C Q E) Allows a user defined color ramp to be used to map values to
colors
:param colorfeedback: (C Q E) Sets on/off the color feedback display C: Default is FALSE
Q: When queried, it returns a boolean
:param colorfeedbackOverride: (C Q E) Sets on/off the color feedback override C: Default
is FALSE Q: When queried, it returns a boolean
:param colorrangelower: (C Q E) Specifies the value that maps to black when color feedback
mode is on C: Default is 0.0 Q: When queried, it returns a float
:param colorrangeupper: (C Q E) Specifies the value that maps to the maximum color when
color feedback mode is on C: Default is 1.0 Q: When queried, it returns a float
:param dataTypeIndex: (Q E) When the selected paintable attribute is a vectorArray, it
specifies which field to paint on
:param disablelighting: (C Q E) If color feedback is on, this flag determines whether
lighting is disabled or not for the surfaces that are affected C: Default is FALSE Q:
When qu
:param dispdecr: (C E) Decreases a maximum displacement by 10%
:param dispincr: (C E) Increases a maximum displacement by 10%
:param dragSlider: (C E) Sets the current brush drag state for resizing or offsetting the
brush (like the 'b' and 'm' default hotkeys) The string argument is one of: "radius
:param duringStrokeCmd: (C Q E) The passed string is executed as a MEL command during the
stroke, each time the mouse is dragged C: Default is no command Q: When queried, it
retur
:param dynclonemode: (C Q E) Enable or disable dynamic clone mode
:param erasesrfupd: (C Q E) Toggles the update for the erase surface
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param expandfilename: (C E) If true, it will expand the name of the export file and
concatenate it with the surface name Otherwise it will take the name as it is C: Default
is
:param exportaspectratio: (C Q E) Value of aspect ratio for export
:param exportfilemode: (C Q E) Specifies the export channel.The valid entries here are:
"alpha", "luminance", "rgb", "rgba" C: Default is "luminance/rgb" Q: When queried, it
retu
:param exportfilesave: (E) Exports the attribute map and saves to a specified file
:param exportfilesizex: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfilesizey: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfiletype: (C Q E) Specifies the image file format It can be one of the
following: "iff", "tiff", "jpeg", "alias", "rgb", "fit" "postScriptEPS", "softimage",
"wavefron
:param filterNodes: (E) Sets the node filter
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param importfileload: (E) Load the attribute map a specified file
:param importfilemode: (C Q E) Specifies the channel to import The valid entries here are:
"alpha", "luminance", "red", "green", "blue", and "rgb" C: Default is "alpha" Q: When q
:param importreassign: (C Q E) Specifies if the multiply atrribute maps are to be
reassigned while importing Only maps previously exported from within Artisan can be
reassigned C
:param interactiveUpdate: (C Q E) Specifies how often to transfer the painted values into
the attribute TRUE: transfer them "continuously" (many times per stroke) FALSE: transfer
the
:param invertrefvector: (C Q E) Sets the invert of the reference vector option when the
reflection is ON If it is true, the reference vector for the reflected stroke is negated
wit
:param lastRecorderCmd: (C Q E) Value of last recorded command
:param lastStampName: (C Q E) Value of the last stamp name
:param lowerradius: (C Q E) Sets the lower size of the brush (only apply on tablet)
:param makeStroke: (C Q E M) Stroke point values
:param mappressure: (C Q E) Sets the tablet pressure mapping when the table is used There
are four options: "none" - the pressure has no effect, "opacity" - the pressure is map
:param maxdisp: (C Q E) Defines a maximum displacement ( maxDisp in [0.0..5.0] ) C:
Default is 1.0 Q: When queried, it returns a float
:param maxvalue: (C Q E) Specifies the maximum value for each attribute C: Default is 1.0
Q: When queried, it returns a float
:param minvalue: (C Q E) Specifies the minimum value for each attribute C: Default is 0.0
Q: When queried, it returns a float
:param mouldtypehead: (C Q E) Type of type mould to use
:param mouldtypemouse: (C Q E) Specifies the putty operations/mode ("push" - pushes CVs
along the given direction (see refvector flag), "pull" - pulls CVs along the specified
direc
:param mouldtypetail: (C Q E) Type of eraser mould to use
:param name: (C) If this is a tool command, name the tool appropriately
:param objattrArray: (Q) An array of all paintable attributes Each element of the array is
a string with the following information: NodeType.NodeName.AttributeName.MenuType
:param opacity: (C Q E) Sets the brush opacity C: Default is 1.0 Q: When queried, it
returns a float
:param outline: (C Q E) Specifies if the brush should be drawn C: Default is TRUE Q: When
queried, it returns a boolean
:param outwhilepaint: (C Q E) Specifies if the brush outline should be drawn while painting
C: Default is FALSE Q: When queried, it returns a boolean
:param paintNodeArray: (Q) An array of paintable nodes Q: When queried, it returns a
string
:param paintattrselected: (E) An array of selected paintable attributes Each element of
the array is a string with the following information: NodeType.NodeName.AttributeName
:param paintmode: (C Q E) Specifies the paint mode There are two possibilities: "screen"
and "tangent" C: Default is "screen" Q: When queried, it returns a string
:param paintoperationtype: (C Q E) Specifies the operation type used by the Paint Tool
Currently, we support the following paint modes: "Paint", "Smear", "Blur", "Erase" and
"Clone"
:param pickColor: (C Q E) Set pick color mode on or off
:param pickValue: (C Q E) Toggle for picking
:param playbackCursor: (C Q E M) Values for the playback cursor
:param playbackPressure: (C Q E M) Valus for the playback pressure
:param polecv: (C Q E) Pull all the pole CVs to the same position
:param preserveclonesource: (C Q E) Whether or not to preserve a clone source
:param profileShapeFile: (Q E) Passes a name of the image file for the stamp shape profile
:param projective: (C Q E) Specifies the projective paint mode C: Default is 'false' Q:
When queried, it returns a boolean
:param radius: (C Q E) Sets the size of the brush C: Default is 1.0 cm Q: When queried,
it returns a float
:param rampMaxColor: (C Q E) Defines a special color to be used when the value is greater
than or equal to the maximum value
:param rampMinColor: (C Q E) Defines a special color to be used when the value is less than
or equal to the minimum value
:param record: (C Q E) Toggle on for recording
:param reflection: (C Q E) Specifies the reflection mode C: Default is 'false' Q: When
queried, it returns a boolean
:param reflectionaboutorigin: (C Q E) Toggle on to reflect about the origin
:param reflectionaxis: (C Q E) Specifies the reflection axis There are three
possibilities: "x", "y" and "z" C: Default is "x" Q: When queried, it returns a string
:param refsurface: (C Q E) Sets on/off the update of the reference surface If it is true
the reference surface is automatically updated on the per stroke bases If it is false
:param refvector: (C Q E) Specifies the direction of the push/pull operation ("normal" -
sculpt along normals, "firstnormal" - sculpt along the first normal of the stroke, "vi
:param refvectoru: (C Q E) Specifies the U component of the UV vector to be used when
-refVector is set to "uvvector"
:param refvectorv: (C Q E) Specifies the V component of the UV vector to be used when
-refVector is set to "uvvector"
:param screenRadius: (C Q E) Brush radius on the screen
:param selectclonesource: (C Q E) Toggle on to select the clone source
:param selectedattroper: (C Q E) Sets the edit weight operation Four edit weights
operations are provided : "absolute" - the value of the weight is replaced by the current
one, "add
:param showactive: (C Q E) Sets on/off the display of the surface isoparms C: Default is
TRUE Q: When queried, it returns a boolean
:param smoothiters: (C Q E) Sets the quality of the smoothing operation (number of
iterations) C: Default is 3 Q: When queried, it returns an int
:param stampDepth: (C Q E) Depth of the stamps
:param stampProfile: (C Q E) Sets the brush profile of the current stamp Currently, the
following profiles are supported: "gaussian", "poly", "solid" and "square" C: Default is
:param stampSpacing: (C Q E) Specifies the stamp spacing Default is 1.0
:param stitchcorner: (C Q E) Sets on/off the stitching corner mode C: Default is "off" Q:
When queried, it returns a boolean
:param stitchedgeflood: (E) Triggers postprocessing stitching edge procedure
:param stitchtype: (C Q E) Sets on/off the stitching mode ( "off" - stitching is turned off,
"position" - position stitching is done without taking care about the tangent conti
:param strokesmooth: (C Q E) Stroke smoothing type name
:param surfaceConformedBrushVertices: (C Q E) Enables/disables the the display of the
effective brush area as affected vertices
:param tablet: (Q) Returns true if the tablet device is present, false if it is absent
:param tangentOutline: (C Q E) Enables/disables the display of the brush circle tangent to
the surface
:param toolOffProc: (C Q E) Accepts a strings describing the name of a MEL procedure that
is invoked whenever the tool is turned off For example, cloth invokes "clothPaintToolO
:param toolOnProc: (C Q E) Accepts a strings describing the name of a MEL procedure that is
invoked whenever the tool is turned on For example, cloth invokes "clothPaintToolOn
:param updateerasesrf: (C E) Updates the erase surface
:param updaterefsrf: (C E) Updates the reference surface
:param useColorRamp: (C Q E) Specifies whether the user defined color ramp should be used
to map values from to colors If this is turned off, the default greyscale feedback will
:param useMaxMinColor: (C Q E) Specifies whether the out of range colors should be used
See rampMinColor and rampMaxColor flags for further details
:param usepressure: (C Q E) Sets the tablet pressure on/off C: Default is false Q: When
queried, it returns a boolean
:param value: (C Q E) Specifies the value for each attribute C: Default is 0.0 Q: When
queried, it returns a float
:param whichTool: (C Q E) The string defines the name of the tool to be used for the
Artisan context An example is "artClothPaint" In query mode, the tool name for the given
:param worldRadius: (C Q E) Radius in worldspace
:returns:
"""
pass
def ToggleViewportRenderer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_selectPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorGridToggleSnap(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def illustratorCurves(*args, caching: bool=True, constructionHistory: bool=True,
illustratorFilename: AnyStr="", nodeState: Union[int, bool]=0, object:
bool=True, tolerance: Union[float, bool]=0.001, q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The illustratorCurves command creates NURBS curves from an input Adobe(R) Illustrator(R)
file
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C) Turn the construction history on or off
:param illustratorFilename: (C) Input Adobe(R) Illustrator(R) file name
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node
:param tolerance: (C Q E) CVs on the output curve get snapped if the distance between two
contiguous CVs are lesser than this tolerance value Default: 0.001f
:returns: Object name and node name
"""
pass
def ColorPreferencesWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AlignUV(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyVertexNormalCtx(*args, **kwargs)->None:
"""
"""
pass
def nucleusDisplayMaterialNodes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeToggleTransformDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SendAsNewScene3dsMax(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NParticleTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def track(*args, down: float=0.0, left: float=0.0, right: float=0.0, upDistance01: float=0.0,
upDistance02: float=0.0, **kwargs)->None:
"""
The track command translates a camera horizontally or vertically in the world space The
viewing-direction and up-direction of the camera are not altered There is no translation
in the viewing direction The track command can be applied to either a perspective or an
orthographic camera When no camera name is supplied, this command is applied to
:param down: (C) Set the amount of down translation in unit distance
:param left: (C) Set the amount of left translation in unit distance
:param right: (C) Set the amount of right translation in unit distance
:param upDistance01: (C) Set the amount of up translation in unit distance This is
equivalent to using up/upDistance02 flag
:param upDistance02: (C) Set the amount of up translation in unit distance This is
equivalent to using u/upDistance01 flag
:returns:
"""
pass
def FBXImportSkeletonDefinitionsAs(*args, **kwargs)->None:
"""
"""
pass
def FloatSelectedPondObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveBifrostFoam(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddToCurrentScene3dsMax(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetCutSewUVTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportConstraints(*args, **kwargs)->None:
"""
"""
pass
def timeEditorBakeClips(*args, bakeToAnimSource: AnyStr="", bakeToClip: AnyStr="", clipId:
Union[int, List[int]]=0, combineLayers: bool=True, forceSampling:
bool=True, keepOriginalClip: bool=True, path: Union[AnyStr,
List[AnyStr]]="", sampleBy: time=None, targetTrackIndex: int=0,
targetTracksNode: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[int, Any]:
"""
This command is used to bake Time Editor clips and to blend them into a single clip
:param bakeToAnimSource: (C) Bake/merge the selected clips into the animation source
:param bakeToClip: (C) Bake/merge the selected clips into a clip
:param clipId: (C M) Clip IDs of the clips to bake
:param combineLayers: (C) Combine the layers of the input clip
:param forceSampling: (C) Force sampling on the whole time range when baking
:param keepOriginalClip: (C) Keep the source clips after baking
:param path: (C M) Full path of clips on which to operate For example:
composition1|track1|group; composition1|track1|group|track2|clip1
:param sampleBy: (C) Sampling interval when baking crossfades and timewarps
:param targetTrackIndex: (C) Specify the target track when baking containers If
targetTrackIndex is specified, the track index within the specified node is used If
targetTrackI
:param targetTracksNode: (C) Target tracks node when baking containers
:returns: Command result
"""
pass
def AlignCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def evaluator(*args, clusters: bool=True, configuration: Union[AnyStr, List[AnyStr], bool]="",
enable: bool=True, info: bool=True, name: Union[AnyStr, bool]="", nodeType:
Union[AnyStr, List[AnyStr], bool]="", nodeTypeChildren: bool=True, priority:
Union[int, bool]=0, valueName: Union[AnyStr, bool]="", q=True, query=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
Handles turning on and off custom evaluation overrides used by the evaluation manager
Query no flag to see all available custom evaluators Query the 'enable' flag to check if
an evaluator is currently enabled If the 'name' flag isn't used then return all modes and
their current active state
:param clusters: (Q) This flag queries the list of clusters currently assigned to the named
custom evaluator The return value will be an array of strings where the array
:param configuration: (C Q M) Sends configuration information to a custom evaluator It's
up to the evaluator to understand what they mean Multiple configuration messages can be
:param enable: (C Q) Enables or disables a specific graph evaluation runtime, depending on
the state of the flag In order to use this flag you must also specify the name
:param info: (Q) Queries the evaluator information Only valid in query mode since the
information is generated by the evaluator's internal state and cannot be change
:param name: (C Q) Names a particular DG evaluation override evaluator Evaluators are
registered automatically by name Query this flag to get a list of available runt
:param nodeType: (C Q M) Names a particular node type to be passed to the evaluator request
Evaluators can either use or ignore the node type information as passed In query
:param nodeTypeChildren: (C Q) If enabled when using the 'nodeType' flag then handle all of
the node types derived from the given one as well Default is to only handle the named n
:param priority: (C Q) Query or set the evaluator priority Custom evaluator with highest
priority order will get the chance to claim the nodes first Evaluators must have
:param valueName: (Q) Queries a value from a given evaluator Evaluators can define a set
of values for which they answer In query mode, this flag can accept a value
:returns: the list of available evaluators (querying with no evaluator flag or invalid
evaluator name)
"""
pass
def PostInfinityLinear(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artSelectCtx(*args, accopacity: bool=False, addselection: bool=True, afterStrokeCmd:
Union[AnyStr, bool]="", beforeStrokeCmd: Union[AnyStr, bool]="",
brushalignment: bool=True, brushfeedback: bool=True, clear: bool=True,
dragSlider: AnyStr="", dynclonemode: bool=True, exists: bool=True,
expandfilename: bool=True, exportaspectratio: Union[float, bool]=0.0,
exportfilemode: Union[AnyStr, bool]="luminance/rgb", exportfilesave: AnyStr="",
exportfilesizex: Union[int, bool]=0, exportfilesizey: Union[int, bool]=0,
exportfiletype: Union[AnyStr, bool]="", history: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", importfileload: AnyStr="", importfilemode: Union[AnyStr,
bool]="alpha", importreassign: bool=False, importthreshold: Union[float,
bool]=0.5, lastRecorderCmd: Union[AnyStr, bool]="", lastStampName:
Union[AnyStr, bool]="", lowerradius: Union[float, bool]=0.0, makeStroke:
Union[int, List[int], bool]=0, mappressure: Union[AnyStr, bool]="none", name:
AnyStr="", opacity: Union[float, bool]=1.0, outline: bool=True, outwhilepaint:
bool=False, paintmode: Union[AnyStr, bool]="screen", paintoperationtype:
Union[AnyStr, bool]="Paint", pickColor: bool=True, pickValue: bool=True,
playbackCursor: Union[List[float, float], List[List[float, float]], bool]=None,
playbackPressure: Union[float, List[float], bool]=0.0, preserveclonesource:
bool=True, profileShapeFile: Union[AnyStr, bool]="", projective: bool=False,
radius: Union[float, bool]=1.0, record: bool=True, reflection: bool=False,
reflectionaboutorigin: bool=True, reflectionaxis: Union[AnyStr, bool]="x",
screenRadius: Union[float, bool]=0.0, selectall: bool=True, selectclonesource:
bool=True, selectop: Union[AnyStr, bool]="select", showactive: bool=True,
stampDepth: Union[float, bool]=0.0, stampProfile: Union[AnyStr, bool]="",
stampSpacing: Union[float, bool]=1.0, strokesmooth: Union[AnyStr, bool]="",
surfaceConformedBrushVertices: bool=True, tablet: bool=True, tangentOutline:
bool=True, toggleall: bool=True, unselectall: bool=True, usepressure:
bool=False, worldRadius: Union[float, bool]=0.0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
This command is used to select/deselect/toggle components on selected surfaces using a
brush interface (Maya Artisan) Since, it selects components of the surface, it only works
in the component mode
:param accopacity: (C Q E) Sets opacity accumulation on/off C: Default is false (Except
for sculpt tool for which it is true by default) Q: When queried, it returns a boolean
:param addselection: (C Q E) If true, each new stroke adds cvs to the active list If false,
each stroke replaces the previous selection C: Default is true Q: When queried, it
:param afterStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
after the end of a stroke C: Default is no command Q: When queried, it returns the curre
:param beforeStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
before the start of a stroke C: Default is no command Q: When queried, it returns the cu
:param brushalignment: (C Q E) Specifies the path brush alignemnt If true, the brush will
align to stroke path, otherwise it will align to up vector C: Default is true Q: When q
:param brushfeedback: (C Q E) Specifies if the brush additional feedback should be drawn
C: Default is TRUE Q: When queried, it returns a boolean
:param clear: (C E) Floods all cvs/vertices to the current value
:param dragSlider: (C E) Sets the current brush drag state for resizing or offsetting the
brush (like the 'b' and 'm' default hotkeys) The string argument is one of: "radius
:param dynclonemode: (C Q E) Enable or disable dynamic clone mode
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param expandfilename: (C E) If true, it will expand the name of the export file and
concatenate it with the surface name Otherwise it will take the name as it is C: Default
is
:param exportaspectratio: (C Q E) Value of aspect ratio for export
:param exportfilemode: (C Q E) Specifies the export channel.The valid entries here are:
"alpha", "luminance", "rgb", "rgba" C: Default is "luminance/rgb" Q: When queried, it
retu
:param exportfilesave: (E) Exports the attribute map and saves to a specified file
:param exportfilesizex: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfilesizey: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfiletype: (C Q E) Specifies the image file format It can be one of the
following: "iff", "tiff", "jpeg", "alias", "rgb", "fit" "postScriptEPS", "softimage",
"wavefron
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param importfileload: (E) Load the attribute map a specified file
:param importfilemode: (C Q E) Specifies the channel to import The valid entries here are:
"alpha", "luminance", "red", "green", "blue", and "rgb" C: Default is "alpha" Q: When q
:param importreassign: (C Q E) Specifies if the multiply atrribute maps are to be
reassigned while importing Only maps previously exported from within Artisan can be
reassigned C
:param importthreshold: (C Q E) Specifies the threshold for the import of the attribute
maps C: Default is 0.5 Q: When queried, it returns a float
:param lastRecorderCmd: (C Q E) Value of last recorded command
:param lastStampName: (C Q E) Value of the last stamp name
:param lowerradius: (C Q E) Sets the lower size of the brush (only apply on tablet)
:param makeStroke: (C Q E M) Stroke point values
:param mappressure: (C Q E) Sets the tablet pressure mapping when the table is used There
are four options: "none" - the pressure has no effect, "opacity" - the pressure is map
:param name: (C) If this is a tool command, name the tool appropriately
:param opacity: (C Q E) Sets the brush opacity C: Default is 1.0 Q: When queried, it
returns a float
:param outline: (C Q E) Specifies if the brush should be drawn C: Default is TRUE Q: When
queried, it returns a boolean
:param outwhilepaint: (C Q E) Specifies if the brush outline should be drawn while painting
C: Default is FALSE Q: When queried, it returns a boolean
:param paintmode: (C Q E) Specifies the paint mode There are two possibilities: "screen"
and "tangent" C: Default is "screen" Q: When queried, it returns a string
:param paintoperationtype: (C Q E) Specifies the operation type used by the Paint Tool
Currently, we support the following paint modes: "Paint", "Smear", "Blur", "Erase" and
"Clone"
:param pickColor: (C Q E) Set pick color mode on or off
:param pickValue: (C Q E) Toggle for picking
:param playbackCursor: (C Q E M) Values for the playback cursor
:param playbackPressure: (C Q E M) Valus for the playback pressure
:param preserveclonesource: (C Q E) Whether or not to preserve a clone source
:param profileShapeFile: (Q E) Passes a name of the image file for the stamp shape profile
:param projective: (C Q E) Specifies the projective paint mode C: Default is 'false' Q:
When queried, it returns a boolean
:param radius: (C Q E) Sets the size of the brush C: Default is 1.0 cm Q: When queried,
it returns a float
:param record: (C Q E) Toggle on for recording
:param reflection: (C Q E) Specifies the reflection mode C: Default is 'false' Q: When
queried, it returns a boolean
:param reflectionaboutorigin: (C Q E) Toggle on to reflect about the origin
:param reflectionaxis: (C Q E) Specifies the reflection axis There are three
possibilities: "x", "y" and "z" C: Default is "x" Q: When queried, it returns a string
:param screenRadius: (C Q E) Brush radius on the screen
:param selectall: (C E) Selects all vertices/egdes/faces/uvs
:param selectclonesource: (C Q E) Toggle on to select the clone source
:param selectop: (C Q E) Specifies the selection operation ("select", "unselect", "toggle")
C: Default is "select" Q: When queried, it returns a string
:param showactive: (C Q E) Sets on/off the display of the surface isoparms C: Default is
TRUE Q: When queried, it returns a boolean
:param stampDepth: (C Q E) Depth of the stamps
:param stampProfile: (C Q E) Sets the brush profile of the current stamp Currently, the
following profiles are supported: "gaussian", "poly", "solid" and "square" C: Default is
:param stampSpacing: (C Q E) Specifies the stamp spacing Default is 1.0
:param strokesmooth: (C Q E) Stroke smoothing type name
:param surfaceConformedBrushVertices: (C Q E) Enables/disables the the display of the
effective brush area as affected vertices
:param tablet: (Q) Returns true if the tablet device is present, false if it is absent
:param tangentOutline: (C Q E) Enables/disables the display of the brush circle tangent to
the surface
:param toggleall: (C E) Toggle all vertices/egdes/faces/uvs
:param unselectall: (C E) Unselects all vertices/egdes/faces/uvs
:param usepressure: (C Q E) Sets the tablet pressure on/off C: Default is false Q: When
queried, it returns a boolean
:param worldRadius: (C Q E) Radius in worldspace
:returns:
"""
pass
def timeEditorClipOffset(*args, applyToAllRoots: bool=True, clipId: Union[int, List[int]]=0,
matchClipId: int=0, matchDstTime: time=None, matchObj: name=None,
matchOffsetRot: bool=True, matchOffsetTrans: bool=True, matchPath:
AnyStr="", matchRotOp: int=0, matchSrcTime: time=None, matchTransOp:
int=0, offsetTransform: bool=True, path: Union[AnyStr,
List[AnyStr]]="", resetMatch: int=0, resetMatchPath: AnyStr="",
rootObj: Union[AnyStr, List[AnyStr], bool]="", upVectorX: float=0.0,
upVectorY: float=0.0, upVectorZ: float=0.0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
This command is used to compute an offset to apply on a source clip in order to
automatically align it to a destination clip at a specified match element For this command
to work, offset objects must be specified for the character
:param applyToAllRoots: (C) Apply root offsets to all roots in the population However, if
the root objects are specified by rootObj flag, this flag will be ignored
:param clipId: (C E M) ID of the clip to be edited
:param matchClipId: (C) Specify the ID of a clip to match
:param matchDstTime: (C) Specify the time on target clip
:param matchObj: (C) Specify the object to match
:param matchOffsetRot: (Q) Get the rotation of the match offset matrix
:param matchOffsetTrans: (Q) Get the translation of the match offset matrix
:param matchPath: (C) Full path of the clip to match For example:
composition1|track1|Group|track2|clip1
:param matchRotOp: (C) Specify the option for matching rotation 0 : full - All rotation
components are matched 1 : Y - Y component is matched 2 : none - No rotation matchi
:param matchSrcTime: (C) Specify the time on source clip
:param matchTransOp: (C) Specify the option for matching translation 0 : full - All
translation components are matched 1 : XZ - X and Z components are matched 2 : none - No
:param offsetTransform: (C Q) Create/get an offset for the specified clip
:param path: (C E M) Full path of a clip to be edited For example:
composition1|track1|group; composition1|track1|group|track2|clip1 In query mode, this flag
can accept
:param resetMatch: (C) Specify clip ID to remove offset
:param resetMatchPath: (C) Specify clip's full path to remove offset For example:
composition1|track1|Group|track2|clip1
:param rootObj: (C Q E M) Specify the root objects If specified, this flag will take
precedence over applyToAllRoots flag When used in query mode, returns list of roots defi
:param upVectorX: (C) Specify the X coordinate of the up vector
:param upVectorY: (C) Specify the Y coordinate of the up vector
:param upVectorZ: (C) Specify the Z coordinate of the up vector
:returns:
"""
pass
def FBXImportSetTake(*args, **kwargs)->None:
"""
"""
pass
def HypershadeGridToggleVisibility(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyConvertToRingAndSplit(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ThreePointArcToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SmoothCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def WireDropoffLocatorOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PublishParentAnchor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BrushPresetBlend(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PencilCurveToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportConvertUnitString(*args, **kwargs)->None:
"""
"""
pass
def CreateFluidCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def toolButton(*args, allowMultipleTools: bool=True, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, changeCommand:
Script=None, collection: AnyStr="", defineTemplate: AnyStr="", docTag:
Union[AnyStr, bool]="", doubleClickCommand: Script=None, dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float, float,
float], bool]=None, image1: Union[AnyStr, bool]="", image2: Union[AnyStr,
bool]="", image3: Union[AnyStr, bool]="", imageOverlayLabel: Union[AnyStr,
bool]="", isObscured: bool=True, ltVersion: Union[AnyStr, bool]="", manage:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True, offCommand:
Script=None, onCommand: Script=None, parent: Union[AnyStr, bool]="",
popupIndicatorVisible: bool=True, popupMenuArray: bool=True, preventOverride:
bool=True, select: bool=True, statusBarMessage: AnyStr="", style: AnyStr="",
tool: Union[AnyStr, List[AnyStr], bool]="", toolArray: bool=True, toolCount:
bool=True, toolImage1: Union[List[AnyStr, AnyStr], List[List[AnyStr, AnyStr]],
bool]=None, toolImage2: Union[List[AnyStr, AnyStr], List[List[AnyStr, AnyStr]],
bool]=None, toolImage3: Union[List[AnyStr, AnyStr], List[List[AnyStr, AnyStr]],
bool]=None, useTemplate: AnyStr="", version: Union[AnyStr, bool]="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a toolButton that is added to the most recently created tool button
collection unless the cl/collection flag is used It also attaches the named tool,
activating it when this control is selected By default, this control only handles one
tool at a time Using the t/tool flag to associate a new tool will simply override the
pre
:param allowMultipleTools: (C Q) Indicates whether this control will allow you to attach
more than one tool By default, this control accepts only one tool You can add multiple
tool
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the control's state is changed Note that
this flag should not be used in conjunction with onCommand and offCommand That is, o
:param collection: (C E) To explicitly add a tool button to a tool collection
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param doubleClickCommand: (C E) Command executed when the control is double clicked
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param image1: (C Q E)
:param image2: (C Q E)
:param image3: (C Q E) This control supports three images The image that best fits the
current size of the control will be displayed This flag applies the image to the cu
:param imageOverlayLabel: (C Q E) A short string (5 characters) label that will be
displayed on top of the icon
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param ltVersion: (C Q E) This flag is used to specify the Maya LT version that this
control feature was introduced, if the version flag is not specified, or if the version fl
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param offCommand: (C E) Command executed when the control is turned off
:param onCommand: (C E) Command executed when the control is turned on
:param parent: (C Q) The parent layout for this control
:param popupIndicatorVisible: (C Q E) Edit this flag to set the visibility of the popup
tool indicator The indicator is a simple image that appears in the top right corner of the
button
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param select: (C E) Will set this button as the selected one This flag also queries the
select state of the control
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param style: (C E) The draw style of the control Valid styles are "iconOnly", "textOnly",
"iconAndTextHorizontal" and "iconAndTextVertical"
:param tool: (C Q E M) The name of the tool to be attached to the button If the tool
specified is already attached to this button then it will be selected Query this flag
:param toolArray: (Q) This query only flag returns the names of all the tools attached to
the toolButton control
:param toolCount: (Q) This query only flag return the number of tools attached to the
toolButton control
:param toolImage1: (C Q E M)
:param toolImage2: (C Q E M)
:param toolImage3: (C Q E M) This control supports three images The image that best fits
the current size of the control will be displayed This flag applies the image to the sp
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param version: (C Q E) Specify the version that this tool button feature was introduced
The argument should be given as a string of the version number (e.g "2013", "2014"
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the toolButton created.
"""
pass
def findKeyframe(*args, animation: AnyStr="keysOrObjects.", attribute: Union[AnyStr,
List[AnyStr]]="", controlPoints: bool=False, curve: bool=True, float:
Union[floatrange, List[floatrange]]=None, hierarchy: AnyStr="",
includeUpperBound: bool=True, index: Union[int, List[int]]=0, shape: bool=True,
time: Union[timerange, List[timerange]]=None, timeSlider: bool=True, which:
AnyStr="", **kwargs)->time:
"""
This command operates on a keyset A keyset is defined as a group of keys within a
specified time range on one or more animation curves The animation curves comprising a
keyset depend on the value of the "-animation" flag: keysOrObjects: Any active keys, when
no target objects or -attribute flags appear on the command line, or All animation curv
:param animation: (C) Where this command should get the animation to act on Valid values
are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Descrip
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param curve: (C) Return a list of the existing curves driving the selected object or
attributes The which, index, floatRange, timeRange, and includeUpperBound flags
:param float: (C M) value uniquely representing a non-time-based key (or key range) on a
time-based animCurve Valid floatRange include single values (-f 10) or a string
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param includeUpperBound: (C) When the -t/time or -f/float flags represent a range of keys,
this flag determines whether the keys at the upper bound of the range are included in t
:param index: (C M) index of a key on an animCurve In query mode, this flag needs a value
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:param time: (C M) time uniquely representing a key (or key range) on a time-based
animCurve See the code examples below on how to format for a single frame or frame r
:param timeSlider: (C) Get the next key time from the ticks displayed in the time slider
If this flag is set, then the -an/animation flag is ignored
:param which: (C) next | previous | first | last How to find the key
:returns: Command result
"""
pass
def PolygonPasteOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateSubdivRegion(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nonLinear(*args, after: bool=True, afterReference: bool=True, autoParent: bool=True,
before: bool=True, commonParent: bool=True, defaultScale: bool=True,
deformerTools: bool=True, exclusive: Union[AnyStr, bool]="", frontOfChain:
bool=True, geometry: Union[AnyStr, List[AnyStr], bool]="", geometryIndices:
bool=True, ignoreSelected: bool=True, includeHiddenSelections: bool=False, name:
AnyStr="", parallel: bool=True, prune: bool=True, remove: Union[bool,
List[bool]]=True, split: bool=True, type: AnyStr="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command creates a functional deformer of the specified type that will deform the
selected objects The deformer consists of three nodes: The deformer driver that gets
connected to the history of the selected objects, the deformer handle transform that
controls position and orientation of the axis of the deformation and the deformer handle
that
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param autoParent: (C) Parents the deformer handle under the selected object's transform
This flag is valid only when a single object is selected
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param commonParent: (C) Creates a new transform and parents the selected object and the
deformer handle under it This flag is valid only when a single object is selected
:param defaultScale: (C) Sets the scale of the deformation handle to 1 By default the
deformation handle is scaled to the match the largest dimension of the selected objects
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param name: (C) Used to specify the name of the node being created
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:param type: (C) Specifies the type of deformation The current valid deformation types
are: bend, twist, squash, flare, sine and wave
:returns: Deformer driver name, deformer handle transform name.
"""
pass
def shot(*args, audio: Union[AnyStr, bool]="", clip: Union[AnyStr, bool]="", clipDuration:
Union[time, bool]=None, clipOpacity: Union[float, bool]=0.0, clipSyncState: bool=True,
clipZeroOffset: Union[time, bool]=None, copy: bool=True, createCustomAnim: bool=True,
currentCamera: Union[AnyStr, bool]="", customAnim: bool=True, deleteCustomAnim:
bool=True, determineTrack: bool=True, endTime: Union[time, bool]=None, favorite:
bool=True, flag1: bool=True, flag10: bool=True, flag11: bool=True, flag12: bool=True,
flag2: bool=True, flag3: bool=True, flag4: bool=True, flag5: bool=True, flag6:
bool=True, flag7: bool=True, flag8: bool=True, flag9: bool=True, hasCameraSet:
bool=True, hasStereoCamera: bool=True, imagePlaneVisibility: bool=True, linkAudio:
Union[AnyStr, bool]="", lock: bool=True, mute: bool=True, paste: bool=True,
pasteInstance: bool=True, postHoldTime: Union[time, bool]=None, preHoldTime:
Union[time, bool]=None, scale: Union[float, bool]=0.0, selfmute: bool=True,
sequenceDuration: Union[time, bool]=None, sequenceEndTime: Union[time, bool]=None,
sequenceStartTime: Union[time, bool]=None, shotName: Union[AnyStr, bool]="",
sourceDuration: Union[time, bool]=None, startTime: Union[time, bool]=None, track:
Union[int, bool]=0, transitionInLength: Union[time, bool]=None, transitionInType:
Union[int, bool]=0, transitionOutLength: Union[time, bool]=None, transitionOutType:
Union[int, bool]=0, unlinkAudio: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Use this command to create a shot node or manipulate that node
:param audio: (C Q E) Specify the audio clip for this shot Audio can be linked to a shot
to allow playback of specific sounds when that shot is being displayed in the Seq
:param clip: (C Q E) The clip associated with this shot This clip will be posted to the
currentCamera's imagePlane Refer to the shot node's documentation for details on
:param clipDuration: (C Q E) Length of clip This is used for the display of the clip
indicator bar in the Sequencer
:param clipOpacity: (C Q E) Opacity for the shot's clip, this value is assigned to the
currentCamera's imagePlane Refer to the shot node's documentation for details on how came
:param clipSyncState: (C Q E) The viewport synchronization status of the clip associated
with this shot Return values are, 0 = no clip associated with this shot 1 = clip is fully
:param clipZeroOffset: (C Q E) Specify which time of the clip corresponds to the beginning
of the shot This is used to properly align splitted clips
:param copy: (C Q E) This flag is used to copy a shot to the clipboard In query mode, this
flag allows you to query what, if anything, has been copied into the shot clip
:param createCustomAnim: (E) Creates an animation layer and links the shot node's
customAnim attr to the weight attr of the animation layer
:param currentCamera: (C Q E) The camera associated with this shot Refer to the shot
node's documentation for details on how cameras are used by shots and the Sequencer
:param customAnim: (Q) Returns the name of the animation layer node linked to this shot
node's customAnim attr
:param deleteCustomAnim: (E) Disconnects the animation layer from this shot's customAnim
attr and deletes the animation layer node
:param determineTrack: (Q E) Determines an available track for the shot Returns a new
track number or the existing track number if the current track is available
:param endTime: (C Q E) The shot end time in the Maya timeline Changing the startTime will
extend the duration of a shot
:param favorite: (C Q E) Make the shot a favorite This is a UI indicator only to
streamline navigation in the Sequencer panel
:param flag1: (C Q E) User specified state flag 1/12 for this shot
:param flag10: (C Q E) User specified state flag 10/12 for this shot
:param flag11: (C Q E) User specified state flag 11/12 for this shot
:param flag12: (C Q E) User specified state flag 12/12 for this shot
:param flag2: (C Q E) User specified state flag 2/12 for this shot
:param flag3: (C Q E) User specified state flag 3/12 for this shot
:param flag4: (C Q E) User specified state flag 4/12 for this shot
:param flag5: (C Q E) User specified state flag 5/12 for this shot
:param flag6: (C Q E) User specified state flag 6/12 for this shot
:param flag7: (C Q E) User specified state flag 7/12 for this shot
:param flag8: (C Q E) User specified state flag 8/12 for this shot
:param flag9: (C Q E) User specified state flag 9/12 for this shot
:param hasCameraSet: (C Q E) Returns true if the camera associated with this shot is a
camera set
:param hasStereoCamera: (C Q E) Returns true if the camera associated with this shot is a
stereo camera
:param imagePlaneVisibility: (C Q E) Visibility of the shot imageplane, this value is
assigned to the currentCamera's imagePlane
:param linkAudio: (C Q E) Specify an audio clip to link to this shot Any currently linked
audio will be unlinked
:param lock: (C Q E) Lock a specific shot This is different than locking an entire track,
which is done via the shotTrack command
:param mute: (C Q E) Mute a specific shot This is different than muting an entire track,
which is done via the shotTrack command Querying this attribute will return tru
:param paste: (C Q E) This flag is used to paste a shot or shots from the clipboard to the
sequence timeline Shots are added to the clipboard using the c/copy flag
:param pasteInstance: (C Q E) This flag is used to paste an instance of a shot or shots
from the clipboard to the sequence timeline Unlike the p/paste flag, which duplicates the
:param postHoldTime: (C Q E) Specify the time length to append to the shot in the sequence
timeline This repeats the last frame of the shot, in sequence time, over the specified
:param preHoldTime: (C Q E) Specify the time length to prepend to the shot in the sequence
timeline This repeats the first frame of the shot, in sequence time, over the specifi
:param scale: (C Q E) Specify an amount to scale the Maya frame range of the shot This
will affect the sequenceEndFrame, leaving the sequenceStartFrame unchanged
:param selfmute: (C Q E) Query if this individual shot's own mute state is set This is
different from the flag "mute", which will return true if this shot is muted due to th
:param sequenceDuration: (Q E) Return the sequence duration of the shot, which will include
the holds and scale This flag can only be queried
:param sequenceEndTime: (C Q E) The shot end in the sequence timeline Changing the endTime
of a shot will scale it in sequence time
:param sequenceStartTime: (C Q E) The shot start in the sequence timeline Changing the
startTime of a shot will shift it in sequence time
:param shotName: (C Q E) Specify a user-defined name for this shot This allows the
assignment of names that are not valid as node names within Maya Whenever the shotName at
:param sourceDuration: (Q E) Return the number of source frames in the shot This flag can
only be queried
:param startTime: (C Q E) The shot start time in the Maya timeline Changing the startTime
will extend the duration of a shot
:param track: (Q E) Specify the track in which this shot resides
:param transitionInLength: (C Q E) Length of the transtion into the shot
:param transitionInType: (Q E) Specify the the type of transition for the transition into
the shot 0 = Fade 1 = Dissolve
:param transitionOutLength: (C Q E) Length of the transtion out of the shot
:param transitionOutType: (Q E) Specify the the type of transition for the transition out
of the shot 0 = Fade 1 = Dissolve
:param unlinkAudio: (Q E) COMMENT Unlinks any currently linked audio
:returns: Shot name
"""
pass
def moveKeyCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", moveFunction:
Union[AnyStr, bool]="", name: AnyStr="", option: Union[AnyStr, bool]="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a context which may be used to move keyframes within the graph editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param moveFunction: (Q E) linear | power | constant Specifies how the keys are dragged
The default move type is constant where all keys move the same amount as controlled by
:param name: (C) If this is a tool command, name the tool appropriately
:param option: (C Q E) Valid values are "move," "insert," "over," and "segmentOver." When
you "move" a key, the key will not cross over (in time) any keys before or after i
:returns: Context name
"""
pass
def CreateDiskCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SymmetrizeUVBrushSizeOn(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorFrameAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HIKInitAxis(*args, **kwargs)->None:
"""
"""
pass
def CreateSpotLight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SoloLastOutput(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def resampleFluid(*args, resampleDepth: Union[int, bool]=0, resampleHeight: Union[int, bool]=0,
resampleWidth: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
A command to extend the fluid grid, keeping the voxels the same size, and keeping the
existing contents of the fluid in the same place Note that the fluid transform is also
modified to make this possible
:param resampleDepth: (C Q E) Change depth resolution to this value
:param resampleHeight: (C Q E) Change height resolution to this value
:param resampleWidth: (C Q E) Change width resolution to this value
:returns:
"""
pass
def XgmSplinePresetImport(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nucleusDisplayTransformNodes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OneClickAcknowledgeCallback(*args, **kwargs)->None:
"""
"""
pass
def SendAsNewSceneMotionBuilder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideClusters(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_viewBottom(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GeometryConstraint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def mtkShrinkWrap(*args, **kwargs)->None:
"""
"""
pass
def ExtendCurveOnSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmModifierGuideOp(*args, **kwargs)->None:
"""
"""
pass
def CreateSculptDeformer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CameraModeToggle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePoseOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DecreaseGammaFine(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def myTestCmd(*args, **kwargs)->None:
"""
"""
pass
def dR_tweakPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EmitFluidFromObjectOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ProductInformation(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def namespaceInfo(*args, absoluteName: bool=True, baseName: bool=True, currentNamespace:
bool=True, dagPath: bool=True, fullName: bool=True, internal: bool=True,
isRootNamespace: bool=True, listNamespace: bool=True,
listOnlyDependencyNodes: bool=True, listOnlyNamespaces: bool=True, parent:
bool=True, recurse: bool=True, shortName: bool=True, **kwargs)->AnyStr:
"""
This command displays information about a namespace The target namespace can optionally be
specified on the command line If no namespace is specified, the command will display
information about the current namespace A namespace is a simple grouping of objects
under a given name Each item in a namespace can then be identified by its own name,
:param absoluteName: (C) This is a general flag which can be used to specify the desired
format for the namespace(s) returned by the command The absolute name of the namespa
:param baseName: (C) This is a general flag which can be used to specify the desired format
for the namespace(s) returned by the command The base name of the namespace c
:param currentNamespace: (C) Display the name of the current namespace
:param dagPath: (C) This flag modifies the 'listNamespace' and 'listOnlyDependencyNodes'
flags to indicate that the names of any dag objects returned will include as muc
:param fullName: (C) This is a general flag which can be used to specify the desired format
for the namespace(s) returned by the command The full name of the namespace c
:param internal: (C) This flag is used together with the 'listOnlyDependencyNodes' flag
When this flag is set, the returned list will include internal nodes (for example
:param isRootNamespace: (C) Returns true if the namespace is root(":"), false if not
:param listNamespace: (C) List the contents of the namespace
:param listOnlyDependencyNodes: (C) List all dependency nodes in the namespace
:param listOnlyNamespaces: (C) List all namespaces in the namespace
:param parent: (C) Display the parent of the namespace By default, the list returned will
not include internal nodes (such as itemFilters) To include the internal nod
:param recurse: (C) Can be specified with 'listNamespace', 'listOnlyNamespaces' or
'listOnlyDependencyNode' to cause the listing to recursively include any child namespa
:param shortName: (C) This flag is deprecated and may be removed in future releases of Maya
It is a synonym for the baseName flag Please use the baseName flag instead
:returns: Command result
"""
pass
def ToggleWireframeInArtisan(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectComponentToolMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def skinPercent(*args, ignoreBelow: Union[float, bool]=0.0, normalize: bool=True, pruneWeights:
float=0.0, relative: bool=True, resetToDefault: bool=True, transform:
Union[AnyStr, bool]="", transformMoveWeights: Union[AnyStr, List[AnyStr]]="",
transformValue: Union[List[AnyStr, float], List[List[AnyStr, float]]]=None,
value: bool=True, zeroRemainingInfluences: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command edits and queries the weight values on members of a skinCluster node, given as
the first argument If no object components are explicitly mentioned in the command line,
the current selection list is used Note that setting multiple weights in a single
invocation of this command is far more efficient than calling it once per weighted v
:param ignoreBelow: (Q) Limits the output of the -value and -transform queries to the
entries whose weight values are over the specified limit This flag has to be used befo
:param normalize: (C) If set, the weights not assigned by the -transformValue flag are
normalized so that the sum of the all weights for the selected object component add
:param pruneWeights: (C) Sets to zero any weight smaller than the given value for all the
selected components To use this command to set all the weights to zero, you must tu
:param relative: (C) Used with -transformValue to specify a relative setting of values If
-relative is true, the value passed to -tv is added to the previous value Othe
:param resetToDefault: (C) Sets the weights of the selected components to their default
values, overwriting any custom weights
:param transform: (Q) In Mel, when used after the -query flag (without an argument) the
command returns an array of strings corresponding to the names of the transforms in
:param transformMoveWeights: (C M) This flag is used to transfer weights from a source
influence to one or more target influences It acts on the selected vertices The flag must
be us
:param transformValue: (C M) Accepts a pair consisting of a transform name and a value and
assigns that value as the weight of the selected object components corresponding to the
:param value: (Q) Returns an array of doubles corresponding to the joint weights for the
selected object component
:param zeroRemainingInfluences: (C) If set, the weights not assigned by the -transformValue
flag are set to 0 The default is off
:returns:
"""
pass
def CreatePointLight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeOpenPropertyEditorWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CurlCurvesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateCameraAim(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BlindDataEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_GetEditionModeScale(*args, **kwargs)->None:
"""
"""
pass
def OffsetSurfacesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SnapPointToPointOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artSetPaint(*args, **kwargs)->None:
"""
"""
pass
def dR_multiCutPointCmd(*args, **kwargs)->None:
"""
"""
pass
def SelectAllNURBSSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PanZoomTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleMeshMaps(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleRangeSlider(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeAdditiveGraphingMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySphere(*args, axis: Union[List[float, float, float], bool]=None, createUVs: int=2,
radius: Union[float, bool]=0.5, subdivisionsAxis: Union[int, bool]=0,
subdivisionsHeight: Union[int, bool]=0, subdivisionsX: Union[int, bool]=20,
subdivisionsY: Union[int, bool]=20, texture: int=0, caching: bool=True,
constructionHistory: bool=True, name: AnyStr="", nodeState: Union[int, bool]=0,
object: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The sphere command creates a new polygonal sphere
:param axis: (C Q E) This flag specifies the primitive axis used to build the sphere Q:
When queried, this flag returns a float[3]
:param createUVs: (C) This flag alows a specific UV mechanism to be selected, while
creating the sphere The valid values are 0, 1, or 2 0 implies that no UVs will be gen
:param radius: (C Q E) This flag specifies the radius of the sphere C: Default is 0.5 Q:
When queried, this flag returns a float
:param subdivisionsAxis: (C Q E) Subdivisions around the axis
:param subdivisionsHeight: (C Q E) Subdivisions along the height of the sphere
:param subdivisionsX: (C Q E) This specifies the number of subdivisions in the X direction
for the sphere C: Default is 20 Q: When queried, this flag returns an int
:param subdivisionsY: (C Q E) This flag specifies the number of subdivisions in the Y
direction for the sphere C: Default is 20 Q: When queried, this flag returns an int
:param texture: (C) This flag is obsolete and will be removed in the next release The
-cuv/createUVs flag should be used instead
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node (where applicable)
:returns: Object name and node name.
"""
pass
def PaintEffectsTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeConvertPSDToFileTexture(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DollyTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateNURBSPlane(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def loadPlugin(*args, addCallback: Script=None, allPlugins: bool=True, name: AnyStr="", quiet:
bool=True, removeCallback: Script=None, **kwargs)->List[AnyStr]:
"""
Load plug-ins into Maya The parameter(s) to this command are either the names or pathnames
of plug-in files The convention for naming plug-ins is to use a .so extension on Linux, a
.mll extension on Windows and .bundle extension on Mac OS X If no extension is provided
then the default extension for the platform will be used To load a Python plu
:param addCallback: (C) Add a MEL or Python callback script to be called after a plug-in is
loaded For MEL, the procedure should have the following signature: global proc p
:param allPlugins: (C) Cause all plug-ins in the search path specified in MAYA_PLUG_IN_PATH
to be loaded
:param name: (C) Set a user defined name for the plug-ins that are loaded If the name is
already taken, then a number will be added to the end of the name to make it
:param quiet: (C) Don't print a warning if you attempt to load a plug-in that is already
loaded
:param removeCallback: (C) Removes a procedure which was previously added with
-addCallback
:returns: the internal names of the successfully loaded plug-ins
"""
pass
def setUITemplate(*args, popTemplate: bool=True, pushTemplate: bool=True, q=True, query=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command sets the current(default) command template for the ELF commands The special
name NONE can be used to set no templates current See "uiTemplate" command also
:param popTemplate: (C) Pop the current template off of the stack and sets the next
template on the stack to be current
:param pushTemplate: (C) Push the current template onto a stack that can later be popped
:returns: The name of the currently selected command template.
"""
pass
def boundary(*args, caching: bool=True, endPoint: bool=False, endPointTolerance: Union[float,
bool]=0.1, nodeState: Union[int, bool]=0, order: bool=True, constructionHistory:
bool=True, name: AnyStr="", object: bool=True, polygon: int=0, range: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command produces a boundary surface given 3 or 4 curves This resulting boundary
surface passes through two of the given curves in one direction, while in the other
direction the shape is defined by the remaining curve(s) If the "endPoint" option is on,
then the curve endpoints must touch before a surface will be created This is the usual
si
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param endPoint: (C Q E) True means the curve ends must touch before a surface will be
created Default: false
:param endPointTolerance: (C Q E) Tolerance for end points, only used if endPoint attribute
is true Default: 0.1
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param order: (C Q E) True if the curve order is important Default: true
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:param range: (C) Force a curve range on complete input curve
:returns: Object name and node name
"""
pass
def SelectPreviousObjectsMudbox(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def flowLayout(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, childArray: bool=True, columnSpacing: Union[int,
bool]=0, defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, horizontal: bool=True, isObscured:
bool=True, manage: bool=True, noBackground: bool=True, numberOfChildren:
bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, statusBarMessage:
AnyStr="", useTemplate: AnyStr="", vertical: bool=True, visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0, wrap:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a layout that arranges its children along a single line (either
horizontal or vertical) Depending on the value of the -wrap boolean flag (default is
false), if the layout's parent cannot fit all the children on one line, the children will
either wrap onto the next line(s) or be truncated
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param columnSpacing: (C Q E) Sets the space between children
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param horizontal: (C Q E) Orientation of the layout This flag is true by default, which
corresponds to a horizontally laid out control
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param vertical: (C Q) This flag is obsolete Please use the -hr/-horizontal flag instead
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:param wrap: (C Q E) When set to true, if the layout's parent cannot fit all the children
in a single line, the children will wrap onto the next line(s) Default setting
:returns: Full path name to the control.
"""
pass
def xgmBakeGuideToUVSpace(*args, **kwargs)->None:
"""
"""
pass
def radioCollection(*args, collectionItemArray: bool=True, defineTemplate: AnyStr="", exists:
bool=True, gl: bool=True, numberOfCollectionItems: bool=True, parent:
AnyStr="", select: Union[AnyStr, bool]="", useTemplate: AnyStr="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a radio button collection Collections are parented to the current
default layout if no parent is specified with the -p/parent flag As children of the layout
they will be deleted when the layout is deleted Collections may also span more than one
window if the -gl/global flag is used In this case the collection has no parent
:param collectionItemArray: (Q) Return a string list giving the long names of all the items
in this collection
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param gl: (C Q) Set the collection to have no parent layout Global collections must be
explicitly deleted
:param numberOfCollectionItems: (Q) Return the number of items in this collection
:param parent: (C) The parent of the collection The collection will be deleted along with
the parent
:param select: (C Q E) Select the specified collection item If queried will return the
name of the currently selected collection item
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: Full path name to the collection.
"""
pass
def floatFieldGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0, adjustableColumn3:
int=0, adjustableColumn4: int=0, adjustableColumn5: int=0, adjustableColumn6:
int=0, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, columnAlign:
Union[List[int, AnyStr], List[List[int, AnyStr]]]=None, columnAlign2:
List[AnyStr, AnyStr]=None, columnAlign3: List[AnyStr, AnyStr, AnyStr]=None,
columnAlign4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign5:
List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign6: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach: Union[List[int,
AnyStr, int], List[List[int, AnyStr, int]]]=None, columnAttach2: List[AnyStr,
AnyStr]=None, columnAttach3: List[AnyStr, AnyStr, AnyStr]=None,
columnAttach4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach5:
List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach6: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnOffset2: List[int,
int]=None, columnOffset3: List[int, int, int]=None, columnOffset4: List[int,
int, int, int]=None, columnOffset5: List[int, int, int, int, int]=None,
columnOffset6: List[int, int, int, int, int, int]=None, columnWidth:
Union[List[int, int], List[List[int, int]]]=None, columnWidth1: int=0,
columnWidth2: List[int, int]=None, columnWidth3: List[int, int, int]=None,
columnWidth4: List[int, int, int, int]=None, columnWidth5: List[int, int, int,
int, int]=None, columnWidth6: List[int, int, int, int, int, int]=None,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dragCommand: Script=None, dropCallback: Script=None, enable:
bool=True, enable1: bool=True, enable2: bool=True, enable3: bool=True,
enable4: bool=True, enableBackground: bool=True, enableKeyboardFocus:
bool=True, exists: bool=True, extraLabel: Union[AnyStr, bool]="",
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True, label:
Union[AnyStr, bool]="", manage: bool=True, noBackground: bool=True,
numberOfFields: int=0, numberOfPopupMenus: bool=True, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, precision: int=0, preventOverride:
bool=True, rowAttach: Union[List[int, AnyStr, int], List[List[int, AnyStr,
int]]]=None, showTrailingZeros: bool=True, statusBarMessage: AnyStr="", step:
Union[float, bool]=10.0, useTemplate: AnyStr="", value: Union[List[float,
float, float, float], bool]=None, value1: Union[float, bool]=0.0, value2:
Union[float, bool]=0.0, value3: Union[float, bool]=0.0, value4: Union[float,
bool]=0.0, visible: bool=True, visibleChangeCommand: Union[Script, bool]=None,
width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command string executed when the value of any of the fields
changes
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command string executed when dragging the invisible slider in any
of the fields
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enable1: (C Q E)
:param enable2: (C Q E)
:param enable3: (C Q E)
:param enable4: (C Q E) Enable state for the respective field
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param extraLabel: (C Q E) If present on creation this specifies that there will be an
extra label in the group Sets the string to be label text to the right of fields
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) If present on creation this specifies that there will be a label to
the left of the fields Sets the string to be the label text
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfFields: (C) Set the number of fields on creation One to four fields are
available The default is one field
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param precision: (C E) Set the number of digits to the right of the decimal
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param showTrailingZeros: (C E) Show trailing zeros or not
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) Set the delta of invisioSlider delta , the invisioSlider step is
delta/10.0 in LMB , delta in MMB,delta*10.0 in RMB Default is 10.0
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Values for all fields
:param value1: (C Q E)
:param value2: (C Q E)
:param value3: (C Q E)
:param value4: (C Q E) Value for the respective field
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def flushThumbnailCache(*args, **kwargs)->None:
"""
"""
pass
def MakeFluidCollideOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fontAttributes(*args, **kwargs)->None:
"""
"""
pass
def nurbsCube(*args, axis: Union[List[float, float, float], bool]=None, caching: bool=True,
degree: Union[int, bool]=3, heightRatio: Union[float, bool]=1.0, lengthRatio:
Union[float, bool]=1.0, nodeState: Union[int, bool]=0, patchesU: Union[int,
bool]=1, patchesV: Union[int, bool]=1, pivot: Union[List[float, float, float],
bool]=None, width: Union[float, bool]=1.0, constructionHistory: bool=True, name:
AnyStr="", object: bool=True, polygon: int=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The nurbsCube command creates a new NURBS Cube made up of six planes It creates an unit
cube with center at origin by default
:param axis: (C Q E) The primitive's axis
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param degree: (C Q E) The degree of the resulting surface 1 - linear, 2 - quadratic, 3 -
cubic, 5 - quintic, 7 - heptic Default: 3
:param heightRatio: (C Q E) Ratio of "height" to "width" Default: 1.0
:param lengthRatio: (C Q E) Ratio of "length" to "width" Default: 1.0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param patchesU: (C Q E) Number of sections in U Default: 1
:param patchesV: (C Q E) Number of sections in V Default: 1
:param pivot: (C Q E) The primitive's pivot point
:param width: (C Q E) Width of the object Default: 1.0
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:returns: Object name and node name
"""
pass
def undoInfo(*args, chunkName: Union[AnyStr, bool]="", closeChunk: bool=True, infinity:
bool=True, length: Union[int, bool]=0, openChunk: bool=True, printQueue: bool=True,
printRedoQueue: bool=True, redoName: Union[AnyStr, bool]="", redoQueueEmpty:
bool=True, state: bool=True, stateWithoutFlush: bool=True, undoName: Union[AnyStr,
bool]="", undoQueueEmpty: bool=True, q=True, query=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command controls the undo/redo parameters In query mode, if invoked without flags
(other than the query flag), this command will return the number of items currently on the
undo queue
:param chunkName: (C Q) Sets the name used to identify a chunk for undo/redo purposes when
opening a chunk
:param closeChunk: (C) Closes the chunk that was opened earlier by openChunk Once close
chunk is called, all undoable operations in the chunk will undo as a single undo op
:param infinity: (C Q) Set the queue length to infinity
:param length: (C Q) Specifies the maximum number of items in the undo queue The infinity
flag overrides this one
:param openChunk: (C) Opens a chunk so that all undoable operations after this call will
fall into the newly opened chunk, until close chunk is called Once close chunk is
:param printQueue: (Q) Prints to the Script Editor the contents of the undo queue
:param printRedoQueue: (Q) Prints to the Script Editor the contents of the redo queue
:param redoName: (Q) Returns what will be redone (if anything)
:param redoQueueEmpty: (Q) Return true if the redo queue is empty Return false if there is
at least one command in the queue to be redone
:param state: (C Q) Turns undo/redo on or off
:param stateWithoutFlush: (C Q) Turns undo/redo on or off without flushing the queue Use
with CAUTION!! Note that if you perform destructive operations while stateWithoutFlush is
d
:param undoName: (Q) Returns what will be undone (if anything)
:param undoQueueEmpty: (Q) Return true if the undo queue is empty Return false if there is
at least one command in the queue to be undone
:returns: If querying undoName or redoName
"""
pass
def polyBevel3(*args, angleTolerance: Union[float, bool]=20.0, autoFit: bool=True, caching:
bool=True, chamfer: bool=True, constructionHistory: bool=True, depth:
Union[float, bool]=1.0, fillNgons: bool=False, mergeVertexTolerance: Union[float,
bool]=0.0, mergeVertices: bool=False, miterAlong: Union[int, bool]=0, mitering:
Union[int, bool]=0, miteringAngle: Union[float, bool]=0.0, name: AnyStr="",
nodeState: Union[int, bool]=0, offset: Union[float, bool]=0.2, offsetAsFraction:
bool=False, roundness: Union[float, bool]=0.5, segments: Union[int, bool]=1,
smoothingAngle: Union[float, bool]=0.0, uvAssignment: Union[int, bool]=0,
worldSpace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Bevel edges
:param angleTolerance: (C Q E) Angular tolerance for creation of extra triangles Note this
attribute is for compatability only and should not be modified in Maya 7.0 files Default:
:param autoFit: (C Q E) If autoFit is on, it computes a smooth roundness : new facets round
off a smooth angle Default: true
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param chamfer: (C Q E) If chamfer is on, the surface is smoothed out at bevels When it is
off, the shape of the surface remains the same Default: true
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param depth: (C Q E) The depth of bevel One means a smooth surface, -1 means maximum
depth Default: 1.0
:param fillNgons: (C Q E) Subdivide new faces with more than 4 edges Default: false
:param mergeVertexTolerance: (C Q E) Tolerance within which to merge vertices Default: 0.0
:param mergeVertices: (C Q E) Merge vertices within a tolerance Default: false
:param miterAlong: (C Q E) Controls in which direction new vertices should we offseted
Default: 0
:param mitering: (C Q E) Controls how the topology should look like at corners Default: 0
:param miteringAngle: (C Q E) Miter faces that have angles less than this value Default:
0.0
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param offset: (C Q E) The offset for bevel Default: 0.2
:param offsetAsFraction: (C Q E) If on, the offset value is treated as a fraction between
zero and one Default: false
:param roundness: (C Q E) The roundness of bevel, it is taken into account when autoFit is
off Default: 0.5
:param segments: (C Q E) The number of segments used for beveling Default: 1
:param smoothingAngle: (C Q E) Create new edges as hard edges if the angle between adjacent
faces exceeds this value Default: 0.0
:param uvAssignment: (C Q E) Technique used to compute UVs on new faces 0 computes new UVs
by projecting along surface normal of original mesh onto new mesh 1 computes new UVs by
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def OneClickGetContactingAppName(*args, **kwargs)->None:
"""
"""
pass
def SquareSurfaceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ScaleUVTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def circle(*args, caching: bool=True, center: Union[List[float, float, float], bool]=None,
centerX: Union[float, bool]=0, centerY: Union[float, bool]=0, centerZ: Union[float,
bool]=0, degree: Union[int, bool]=3, first: Union[List[float, float, float],
bool]=None, firstPointX: Union[float, bool]=1, firstPointY: Union[float, bool]=0,
firstPointZ: Union[float, bool]=0, fixCenter: bool=True, nodeState: Union[int,
bool]=0, normal: Union[List[float, float, float], bool]=None, normalX: Union[float,
bool]=0, normalY: Union[float, bool]=0, normalZ: Union[float, bool]=1, radius:
Union[float, bool]=1.0, sections: Union[int, bool]=8, sweep: Union[float,
bool]=6.2831853, tolerance: Union[float, bool]=0.01, useTolerance: bool=False,
constructionHistory: bool=True, name: AnyStr="", object: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The circle command creates a circle or partial circle (arc)
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param center: (C Q E) The center point of the circle
:param centerX: (C Q E) X of the center point Default: 0
:param centerY: (C Q E) Y of the center point Default: 0
:param centerZ: (C Q E) Z of the center point Default: 0
:param degree: (C Q E) The degree of the resulting circle: 1 - linear, 3 - cubic Default:
3
:param first: (C Q E) The start point of the circle if fixCenter is false Determines the
orientation of the circle if fixCenter is true
:param firstPointX: (C Q E) X of the first point Default: 1
:param firstPointY: (C Q E) Y of the first point Default: 0
:param firstPointZ: (C Q E) Z of the first point Default: 0
:param fixCenter: (C Q E) Fix the center of the circle to the specified center point
Otherwise the circle will start at the specified first point Default: true
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param normal: (C Q E) The normal of the plane in which the circle will lie
:param normalX: (C Q E) X of the normal direction Default: 0
:param normalY: (C Q E) Y of the normal direction Default: 0
:param normalZ: (C Q E) Z of the normal direction Default: 1
:param radius: (C Q E) The radius of the circle Default: 1.0
:param sections: (C Q E) The number of sections determines the resolution of the circle
Used only if useTolerance is false Default: 8
:param sweep: (C Q E) The sweep angle determines the completeness of the circle A full
circle is 2Pi radians, or 360 degrees Default: 6.2831853
:param tolerance: (C Q E) The tolerance with which to build a circle Used only if
useTolerance is true Default: 0.01
:param useTolerance: (C Q E) Use the specified tolerance to determine resolution Otherwise
number of sections will be used Default: false
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:returns: Object name and node name
"""
pass
def assembly(*args, active: Union[AnyStr, bool]="", activeLabel: Union[AnyStr, bool]="",
canCreate: Union[AnyStr, bool]="", createOptionBoxProc: Union[Script, bool]=None,
createRepresentation: AnyStr="", defaultType: Union[AnyStr, bool]="",
deleteRepresentation: AnyStr="", deregister: AnyStr="", input: AnyStr="", isAType:
Union[AnyStr, bool]="", isTrackingMemberEdits: Union[AnyStr, bool]="", label:
Union[AnyStr, bool]="", listRepTypes: bool=True, listRepTypesProc: Union[Script,
bool]=None, listRepresentations: bool=True, listTypes: bool=True, name: AnyStr="",
newRepLabel: AnyStr="", postCreateUIProc: Union[Script, bool]=None, proc:
Script=None, renameRepresentation: AnyStr="", repLabel: Union[AnyStr, bool]="",
repName: AnyStr="", repNamespace: Union[AnyStr, bool]="", repPostCreateUIProc:
Union[AnyStr, bool]="", repPreCreateUIProc: Union[AnyStr, bool]="", repType:
Union[AnyStr, bool]="", repTypeLabel: Union[AnyStr, bool]="", repTypeLabelProc:
Union[Script, bool]=None, type: Union[AnyStr, bool]="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
Command to register assemblies for the scene assembly framework, to create them, and to
edit and query them Assembly nodes are DAG nodes, and are therefore shown in the various
DAG editors (Outliner, Hypergraph, Node Editor) At assembly creation time, the node name
defaults to the node type name The assembly command can create any node that is d
:param active: (Q E) Set the active representation by name, or query the name of the active
representation Edit mode can be applied to more than one assembly Query mode
:param activeLabel: (Q E) Set the active representation by label, or query the label of the
active representation Edit mode can be applied to more than one assembly Query mo
:param canCreate: (Q) Query the representation types the specific assembly can create
:param createOptionBoxProc: (Q E) Set or query the option box menu procedure for a specific
assembly type The assembly type will be the default type, unless the -type flag is used
to
:param createRepresentation: (E) Create and add a specific type of representation for an
assembly If the representation type needs additional parameters, they must be specified
usin
:param defaultType: (Q E) Set or query the default type of assembly When the assembly
command is used to perform an operation on an assembly type rather than on an assembly o
:param deleteRepresentation: (E) Delete a specific representation from an assembly
:param deregister: (E) Deregister a registered assembly type If the deregistered type is
the default type, the default type will be set to the empty string
:param input: (E) Specify the additional parameters of representation creation procedure
when creating a representation This flag must be used with createRepresentati
:param isAType: (Q) Query whether the given object is of an assembly type
:param isTrackingMemberEdits: (Q) Query whether the given object is tracking member edits
:param label: (Q E) Set or query the label for an assembly type Assembly type is specified
with flag "type" If no type specified, the default type is used
:param listRepTypes: (Q) Query the supported representation types for a given assembly type
The assembly type will be the default type, unless the -type flag is used to spec
:param listRepTypesProc: (Q E) Set or query the procedure that provides the representation
type list which an assembly type supports This procedure takes no argument, and returns
:param listRepresentations: (Q) Query the created representations list for a specific
assembly The -repType flag can be used to filter the list and return representations for a
sin
:param listTypes: (Q) Query the supported assembly types
:param name: (C) Specify the name of the assembly when creating it
:param newRepLabel: (E) Specify the representation label to set on representation label
edit
:param postCreateUIProc: (Q E) Set or query the UI post-creation procedure for a given
assembly type This procedure will be invoked by Maya immediately after an assembly of the
sp
:param proc: (E) Specify the procedure when setting the representation UI post- or
pre-creation procedure, for a given assembly type The assembly type will be the de
:param renameRepresentation: (E) Renames the representation that is the argument to this
flag The repName flag must be used to provide the new name
:param repLabel: (Q E) Query or edit the label of the representation that is the argument
to this flag, for a given assembly In both query and edit modes, the -repLabel fl
:param repName: (E) Specify the representation name to set on representation creation or
rename This flag is optional with the createRepresentation flag: if omitted, th
:param repNamespace: (Q) Query the representation namespace of this assembly node The
value returned is used by Maya for creating the namespace where nodes created by the ac
:param repPostCreateUIProc: (Q E) Set or query the UI post-creation procedure for a
specific representation type, and for a specific assembly type This procedure takes two
arguments,
:param repPreCreateUIProc: (Q E) Set or query the UI pre-creation procedure for a specific
representation type, and for a specific assembly type This procedure takes no argument,
an
:param repType: (Q) Specify a representation type to use as a filter for the
-listRepresentations query The representation type is the argument to this flag In query
m
:param repTypeLabel: (Q) Query the label of the specific representation type In query mode,
this flag needs a value
:param repTypeLabelProc: (Q E) Set or query the procedure that provides the representation
type label, for a given assembly type The procedure takes the representation type as its
:param type: (C Q E) Set or query properties for the specified registered assembly type In
query mode, this flag needs a value
:returns:
"""
pass
def FBXImportSkins(*args, **kwargs)->None:
"""
"""
pass
def createAttrPatterns(*args, patternDefinition: AnyStr="", patternFile: AnyStr="",
patternType: AnyStr="", **kwargs)->AnyStr:
"""
Create a new instance of an attribute pattern given a pattern type (e.g XML) and a string
or data file containing the description of the attribute tree in the pattern's format
:param patternDefinition: (C) Hardcoded string containing the pattern definition, for
simpler formats that don't really need a separate file for definition
:param patternFile: (C) File where the pattern information can be found
:param patternType: (C) Name of the pattern definition type to use in creating this
instance of the pattern
:returns: Name of created pattern
"""
pass
def BakeDeformerTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def bakeResults(*args, animation: AnyStr="keysOrObjects.", attribute: Union[AnyStr,
List[AnyStr]]="", bakeOnOverrideLayer: bool=True, controlPoints: bool=False,
destinationLayer: AnyStr="", disableImplicitControl: bool=True, float:
Union[floatrange, List[floatrange]]=None, hierarchy: AnyStr="",
includeUpperBound: bool=True, index: Union[int, List[int]]=0, minimizeRotation:
bool=True, oversamplingRate: int=1, preserveOutsideKeys: bool=False,
removeBakedAnimFromLayer: bool=True, removeBakedAttributeFromLayer: bool=True,
resolveWithoutLayer: Union[AnyStr, List[AnyStr]]="", sampleBy: time=None,
shape: bool=True, simulation: bool=False, smart: List[bool, float]=None,
sparseAnimCurveBake: bool=False, time: Union[timerange, List[timerange]]=None,
q=True, query=True, e=True, edit=True, **kwargs)->Union[int, Any]:
"""
This command allows the user to replace a chain of dependency nodes which define the value
for an attribute with a single animation curve Command allows the user to specify the
range and frequency of sampling This command operates on a keyset A keyset is defined as
a group of keys within a specified time range on one or more animation curves
:param animation: (C) Where this command should get the animation to act on Valid values
are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." See command
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param bakeOnOverrideLayer: (C) If true, all layered and baked attribute will be added as a
top override layer
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param destinationLayer: (C) This flag can be used to specify an existing layer where the
baked results should be stored Use this flag with caution If the destination layer alr
:param disableImplicitControl: (C) Whether to disable implicit control after the anim
curves are obtained as the result of this command An implicit control to an attribute is
some fun
:param float: (C M) value uniquely representing a non-time-based key (or key range) on a
time-based animCurve Valid floatRange include single values (-f 10) or a string
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param includeUpperBound: (C) When the -t/time or -f/float flags represent a range of keys,
this flag determines whether the keys at the upper bound of the range are included in t
:param index: (C M) index of a key on an animCurve In query mode, this flag needs a value
:param minimizeRotation: (C) Specify whether to minimize the local Euler component from key
to key during baking of rotation channels
:param oversamplingRate: (C) Amount of samples per sampleBy period Default is 1
:param preserveOutsideKeys: (C) Whether to preserve keys that are outside the bake range
when there are directly connected animation curves or a pairBlend node which has an
animatio
:param removeBakedAnimFromLayer: (C) If true, all baked animation will be removed from the
layer Otherwise all layer associated with the baked animation will be muted
:param removeBakedAttributeFromLayer: (C) If true, all baked attribute will be removed from
the layer Otherwise all layer associated with the baked attribute will be muted
:param resolveWithoutLayer: (C M) This flag can be used to specify a list of layers to be
merged together during the bake process This is a multi-use flag Its name refers to the
fac
:param sampleBy: (C) Amount to sample by Default is 1.0 in current timeUnit
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:param simulation: (C) Using this flag instructs the command to preform a simulation
instead of just evaluating each attribute separately over the range of time The simula
:param smart: (C) Specify whether to enable smart bake and the optional smart bake
tolerance
:param sparseAnimCurveBake: (C) When this is true and anim curves are being baked, do not
insert any keys into areas of the curve where animation is defined And, use as few keys
as
:param time: (C M) time uniquely representing a key (or key range) on a time-based
animCurve See the code examples below on how to format for a single frame or frame r
:returns: - The number of channels baked
"""
pass
def textField(*args, alwaysInvokeEnterCommandOnReturn: bool=True, annotation: Union[AnyStr,
bool]="", backgroundColor: Union[List[float, float, float], bool]=None,
changeCommand: Script=None, defineTemplate: AnyStr="", disableButtons: bool=True,
disableClearButton: bool=True, disableHistoryButton: bool=True, docTag:
Union[AnyStr, bool]="", dragCallback: Script=None, drawInactiveFrame: bool=True,
dropCallback: Script=None, editable: bool=True, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, enterCommand:
Script=None, exists: bool=True, fileName: Union[AnyStr, bool]="", font:
Union[AnyStr, bool]="", fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, insertText:
AnyStr="", insertionPosition: Union[int, bool]=0, isObscured: bool=True, manage:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", placeholderText: Union[AnyStr, bool]="", popupMenuArray:
bool=True, preventOverride: bool=True, receiveFocusCommand: Script=None,
searchField: bool=True, statusBarMessage: AnyStr="", text: Union[AnyStr, bool]="",
textChangedCommand: Script=None, useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a text field control
:param alwaysInvokeEnterCommandOnReturn: (C Q E) Sets whether to always invoke the enter
command when the return key is pressed by the user By default, this option is false
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the text changes This command is not
invoked when the value changes via the -tx/text flag
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param disableButtons: (C Q E) Sets the visibility state of search field buttons to
true/false depending on the passed value In Query mode returns whether both buttons are
visible
:param disableClearButton: (C Q E) Sets the visibility state of search field clear button
to true/false depending on the passed value In Query mode returns whether clear button of
sea
:param disableHistoryButton: (C Q E) Sets the visibility state of search field history
button to true/false depending on the passed value In Query mode returns whether history
button of
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param drawInactiveFrame: (C Q E) Sets whether the text field draws itself with a frame
when it's inactive By default, this option is false
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editable: (C Q E) The edit state of the field By default, this flag is set to true
and the field value may be changed by typing into it If false then the field is 'r
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param enterCommand: (C E) Command executed when the keypad 'Enter' key is pressed
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fileName: (C Q E) Text in the field as a filename This does conversions between
internal and external (UI) file representation
:param font: (C Q E) The font for the text Valid values are "boldLabelFont",
"smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont",
"oblique
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param insertText: (C E) Insert text into the field at the current insertion position
(specified by the -ip/insertionPosition flag)
:param insertionPosition: (C Q E) The insertion position for inserted text This is a 1
based value where position 1 specifies the beginning of the field Position 0 may be used
to sp
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param placeholderText: (C Q E) Setting this property makes the line edit display a
grayed-out placeholder text as long as the text field is empty and the widget doesn't have
focus
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param receiveFocusCommand: (C E) Command executed when the field receives focus
:param searchField: (C) Creates a search field instead of a text field
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param text: (C Q E) The field text
:param textChangedCommand: (C E) Command executed immediately when the field text changes
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def polyMoveFacetUV(*args, axisLen: Union[List[float, float], bool]=None, axisLenX: Union[float,
bool]=1.0, axisLenY: Union[float, bool]=1.0, caching: bool=True,
constructionHistory: bool=True, name: AnyStr="", nodeState: Union[int,
bool]=0, pivot: Union[List[float, float], bool]=None, pivotU: Union[float,
bool]=0.0, pivotV: Union[float, bool]=0.0, random: Union[float, bool]=0.0,
rotationAngle: Union[float, bool]=0.0, scale: Union[List[float, float],
bool]=None, scaleU: Union[float, bool]=1.0, scaleV: Union[float, bool]=1.0,
translate: Union[List[float, float], bool]=None, translateU: Union[float,
bool]=0.0, translateV: Union[float, bool]=0.0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Modifies the map by moving all UV values associated with the selected face(s) The UV
coordinates of the model are manipulated without changing the vertices of the 3D object
:param axisLen: (C Q E) Axis Length vector, used to draw the manip handles C: Default is
1.0, 1.0 Q: When queried, this flag returns a float[2]
:param axisLenX: (C Q E) Axis Length in X, used to draw the manip handles C: Default is
1.0 Q: When queried, this flag returns a float
:param axisLenY: (C Q E) Axis Length in Y, used to draw the manip handles C: Default is
1.0 Q: When queried, this flag returns a float
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pivot: (C Q E) This flag specifies the pivot for scaling and rotation C: Default is
0.0 0.0 Q: When queried, this flag returns a float[2]
:param pivotU: (C Q E) This flag specifies U for the pivot for scaling and rotation C:
Default is 0.0 Q: When queried, this flag returns a float
:param pivotV: (C Q E) This flag specifies V for the pivot for scaling and rotation C:
Default is 0.0 Q: When queried, this flag returns a float
:param random: (C Q E) This flag specifies the random value for all parameters C: Default
is 0.0 The range is [-10.0, 10.0] Q: When queried, this flag returns a float
:param rotationAngle: (C Q E) Angle of rotation C: Default is 0.0 Q: When queried, this
flag returns a float
:param scale: (C Q E) This flag specifies the scaling vector C: Default is 1.0 1.0 Q:
When queried, this flag returns a float
:param scaleU: (C Q E) This flag specifies U for the scaling vector C: Default is 1.0 Q:
When queried, this flag returns a float
:param scaleV: (C Q E) This flag specifies V for the scaling vector C: Default is 1.0 Q:
When queried, this flag returns a float
:param translate: (C Q E) This flag specifies the translation vector C: Default is 0.0 0.0
Q: When queried, this flag returns a float[2]
:param translateU: (C Q E) This flag specifies the U translation vector C: Default is 0.0
Q: When queried, this flag returns a float
:param translateV: (C Q E) This flag specifies the V translation vector C: Default is 0.0
Q: When queried, this flag returns a float
:returns: The node name.
"""
pass
def FBXImportForcedFileAxis(*args, **kwargs)->None:
"""
"""
pass
def PanePop(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TangentsSpline(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def thumbnailCaptureComponent(*args, capture: bool=True, capturedFrameCount: bool=True,
closeCurrentSession: bool=True, delete: bool=True, endFrame:
Union[int, bool]=0, fileDialogCallback: AnyStr="",
isSessionOpened: bool=True, launchedFromOptionsBox: bool=True,
previewPath: bool=True, removeProjectThumbnail: AnyStr="", save:
AnyStr="", startFrame: Union[int, bool]=0, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command is used to generate a thumbnail/playblast sequence from the scene
:param capture: (C) Create a new component to capture a sequence of image for the current
scene
:param capturedFrameCount: (Q) Query only Return the number of frames that have been
captured
:param closeCurrentSession: (C) Delete the current thumbnail component (preview image will
be destroyed)
:param delete: (C) Delete the generated image sequence and preview for the current capture
session
:param endFrame: (C Q) Set the end captured frame Only valid when the -c/capture flag is
set If -sf/startFrame is set and not -ef/endFrame, or if endFrame is smaller than
:param fileDialogCallback: (C) MEL only Set the callback file dialog which is called after
the capture component window has been closed Only valid when the -c/capture flag is set
:param isSessionOpened: (Q) Returns true if a thumbnail/playblast capture session is
currently running (already opened and still not cancelled/saved)
:param launchedFromOptionsBox: (Q) Returns true if the thumbnail capture component was
launched through the options dialog box, else false
:param previewPath: (Q) Returns the generated preview path (the first frame of generated
sequence resized to 100x100 px)
:param removeProjectThumbnail: (C) Remove all captured thumbnail/playblast from the given
project file path
:param save: (C) Save the generated image sequence for the given file to disk The file
path must be an absolute path
:param startFrame: (C Q) Set the start captured frame Only valid when -c/capture flag is
set
:returns:
"""
pass
def xgmExportToP3D(*args, **kwargs)->None:
"""
"""
pass
def OffsetEdgeLoopTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeRemoveTab(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PruneSculpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BendCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonSphere(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def agFormatOut(*args, **kwargs)->None:
"""
"""
pass
def SubdivProxy(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def transformLimits(*args, enableRotationX: List[bool, bool]=None, enableRotationY: List[bool,
bool]=None, enableRotationZ: List[bool, bool]=None, enableScaleX: List[bool,
bool]=None, enableScaleY: List[bool, bool]=None, enableScaleZ: List[bool,
bool]=None, enableTranslationX: List[bool, bool]=None, enableTranslationY:
List[bool, bool]=None, enableTranslationZ: List[bool, bool]=None, remove:
bool=True, rotationX: Union[List[float, float], bool]=None, rotationY:
Union[List[float, float], bool]=None, rotationZ: Union[List[float, float],
bool]=None, scaleX: Union[List[float, float], bool]=None, scaleY:
Union[List[float, float], bool]=None, scaleZ: Union[List[float, float],
bool]=None, translationX: Union[List[float, float], bool]=None,
translationY: Union[List[float, float], bool]=None, translationZ:
Union[List[float, float], bool]=None, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
The transformLimits command allows us to set, edit, or query the limits of the
transformation that can be applied to objects We can also turn any limits off which may
have been previously set When an object is first created, all the transformation limits
are off by default. Transformation limits allow us to control how much an object can be
tra
:param enableRotationX: (Q) enable/disable the lower and upper x-rotation limits When
queried, it returns boolean boolean
:param enableRotationY: (Q) enable/disable the lower and upper y-rotation limits When
queried, it returns boolean boolean
:param enableRotationZ: (Q) enable/disable the lower and upper z-rotation limits When
queried, it returns boolean boolean
:param enableScaleX: (Q) enable/disable the lower and upper x-scale limits When queried, it
returns boolean boolean
:param enableScaleY: (Q) enable/disable the lower and upper y-scale limits When queried, it
returns boolean boolean
:param enableScaleZ: (Q) enable/disable the lower and upper z-scale limits When queried, it
returns boolean boolean
:param enableTranslationX: (Q) enable/disable the ower and upper x-translation limits When
queried, it returns boolean boolean
:param enableTranslationY: (Q) enable/disable the lower and upper y-translation limits When
queried, it returns boolean boolean
:param enableTranslationZ: (Q) enable/disable the lower and upper z-translation limits When
queried, it returns boolean boolean
:param remove: (C) turn all the limits off and reset them to their default values
:param rotationX: (Q) set the lower and upper x-rotation limits When queried, it returns
angle angle
:param rotationY: (Q) set the lower and upper y-rotation limits When queried, it returns
angle angle
:param rotationZ: (Q) set the lower and upper z-rotation limits When queried, it returns
angle angle
:param scaleX: (Q) set the lower and upper x-scale limits When queried, it returns float
float
:param scaleY: (Q) set the lower and upper y-scale limits When queried, it returns float
float
:param scaleZ: (Q) set the lower and upper z-scale limits When queried, it returns float
float
:param translationX: (Q) set the lower and upper x-translation limits When queried, it
returns linear linear
:param translationY: (Q) set the lower and upper y-translation limits When queried, it
returns linear linear
:param translationZ: (Q) set the lower and upper z-translation limits When queried, it
returns linear linear
:returns:
"""
pass
def SetMeshWaxTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyEditEdgeFlowOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def viewFit(*args, allObjects: bool=True, animate: bool=True, center: bool=True, fitFactor:
float=0.0, namespace: AnyStr="", **kwargs)->None:
"""
The viewFit command positions the specified camera so its point-of-view contains all
selected objects other than itself If no objects are selected, everything is fit to the
view (excepting cameras, lights, and sketching plannes) The fit-factor, if specified,
determines how much of the view should be filled If a camera is not specified, the camer
:param allObjects: (C) Specifies that all objects are to be fit regardless of the active
list
:param animate: (C) Specifies that the transition between camera positions should be
animated
:param center: (C) Specifies that the camera moves to the center of the selected object,
but does not move the camera closer
:param fitFactor: (C) Specifies how much of the view should be filled with the "fitted"
items
:param namespace: (C) Specifies a namespace that should be excluded All objects in the
specified namespace will be excluded from the fit process
:returns:
"""
pass
def AddInBetweenTargetShape(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MirrorCutPolygonGeometryOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowAllComponents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def pasteKey(*args, animLayer: AnyStr="", animation: AnyStr="keysOrObjects.", attribute:
Union[AnyStr, List[AnyStr]]="", clipboard: AnyStr="", connect: bool=False, copies:
int=0, float: floatrange=None, floatOffset: float=0.0, includeUpperBound:
bool=True, index: int=0, matchByName: bool=False, option: AnyStr="", time:
timerange=None, timeOffset: time=None, valueOffset: float=0.0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[int, Any]:
"""
The pasteKey command pastes curve segment hierarchies from the clipboard onto other objects
or curves If the object hierarchy from which the curve segments were copied or cut does
not match the object hierarchy being pasted to, pasteKey will paste as much as it can match
in the hierarchy If animation from only one object is on the clipboard, it w
:param animLayer: (C) Specifies that the keys getting pasted should be pasted onto curves
on the specified animation layer.If that layer doesn't exist for the specified ob
:param animation: (C) Where this command should get the animation to act on Valid values
are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Descrip
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param clipboard: (C) Specifies the clipboard from which animation is pasted Valid
clipboards are "api" and "anim" The default clipboard is: anim
:param connect: (C) When true, connect the source curve with the destination curve's value
at the paste time (This has the effect of shifting the clipboard curve in val
:param copies: (C) The number of times to paste the source curve
:param float: (C) value uniquely representing a non-time-based key (or key range) on a
time-based animCurve Valid floatRange include single values (-f 10) or a string
:param floatOffset: (C) How much to offset the pasted keys in time (for non-time-input
animation curves)
:param includeUpperBound: (C) When the -t/time or -f/float flags represent a range of keys,
this flag determines whether the keys at the upper bound of the range are included in t
:param index: (C) index of a key on an animCurve In query mode, this flag needs a value
:param matchByName: (C) When true, we will only paste onto items in the scene whose node
and attribute names match up exactly with a corresponding item in the clipboard No
:param option: (C) Valid values are "insert", "replace", "replaceCompletely", "merge",
"scaleInsert," "scaleReplace", "scaleMerge", "fitInsert", "fitReplace", and "fitM
:param time: (C) time uniquely representing a key (or key range) on a time-based animCurve
See the code examples below on how to format for a single frame or frame r
:param timeOffset: (C) How much to offset the pasted keys in time (for time-input animation
curves)
:param valueOffset: (C) How much to offset the pasted keys in value
:returns: The number of curves pasted
"""
pass
def TrackTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ClusterCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportShowUI(*args, **kwargs)->None:
"""
"""
pass
def RenderPassSetEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeSelectTextures(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PointConstraintOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AlignSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def removeJoint(*args, **kwargs)->None:
"""
This command will remove the selected joint or the joint given at the command line from the
skeleton The given (or selected) joint should not be the root joint of the skeleton, and
not have skin attached The command works on the given (or selected) joint No options or
flags are necessary
:returns:
"""
pass
def IncreaseManipulatorSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectVertexMask(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideFollicles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ArtPaintAttrToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PublishAttributesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshRelaxTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CurveFillet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExport(*args, **kwargs)->None:
"""
"""
pass
def DeactivateGlobalScreenSliderModeMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def renderGlobalsNode(*args, name: AnyStr="", parent: AnyStr="", renderQuality: AnyStr="",
renderResolution: AnyStr="", shared: bool=True, skipSelect: bool=True,
**kwargs)->AnyStr:
"""
This command creates a new node in the dependency graph of the specified type The
renderGlobalsNode creates a render globals node and registers it with the model The
createNode command will not register nodes of this type correctly
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param parent: (C) Specifies the parent in the DAG under which the new node belongs
:param renderQuality: (C) Set the quality to be the renderQuality node with the given name
:param renderResolution: (C) Set the resolution to be the resolution node with the given
name
:param shared: (C) This node is shared across multiple files, so only create it if it does
not already exist
:param skipSelect: (C) This node is not to be selected after creation, the original
selection will be preserved
:returns: The name of the new node.
"""
pass
def multiProfileBirailSurface(*args, caching: bool=True, nodeState: Union[int, bool]=0,
tangentContinuityProfile1: bool=False, tangentContinuityProfile2:
bool=False, transformMode: Union[int, bool]=0,
constructionHistory: bool=True, name: AnyStr="", object:
bool=True, polygon: int=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The cmd creates a railed surface by sweeping the profiles using two rail curves The two
rails are the last two arguments For examples, if 5 curves are specified, they will
correspond to "curve1" "curve2" "curve3" "rail1" "rail2" In this case, the cmd creates a
railed surface by sweeping the profile "curve1" to profile "curve2", profile "curve2"
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param tangentContinuityProfile1: (C Q E) Tangent continuous across the first profile The
profile must be a surface curve Default: false
:param tangentContinuityProfile2: (C Q E) Tangent continuous across the last profile The
profile must be a surface curve Default: false
:param transformMode: (C Q E) transform mode ( Non proportional, proportional ) Non
proportional is default value Default: 0
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:returns: Object name and node name
"""
pass
def objectTypeUI(*args, isType: AnyStr="", listAll: bool=True, superClasses: bool=True,
**kwargs)->AnyStr:
"""
This command returns the type of UI element such as button, sliders, etc
:param isType: (C) Returns true|false if the object is of the specified type
:param listAll: (C) Returns a list of all known UI commands and their respective types
Each entry contains three strings which are the command name, ui type and class n
:param superClasses: (C) Returns a list of the names of all super classes for the given
object Note that all class names are internal and are subject to change
:returns: The type of the specified object.
"""
pass
def gridLayout(*args, allowEmptyCells: bool=True, annotation: Union[AnyStr, bool]="", autoGrow:
bool=True, backgroundColor: Union[List[float, float, float], bool]=None,
cellHeight: Union[int, bool]=0, cellWidth: Union[int, bool]=0, cellWidthHeight:
List[int, int]=None, childArray: bool=True, columnsResizable: bool=False,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, fullPathName:
bool=True, gridOrder: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True, manage:
bool=True, noBackground: bool=True, numberOfChildren: bool=True,
numberOfColumns: Union[int, bool]=0, numberOfPopupMenus: bool=True,
numberOfRows: Union[int, bool]=0, numberOfRowsColumns: List[int, int]=None,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, position:
Union[List[AnyStr, int], List[List[AnyStr, int]]]=None, preventOverride:
bool=True, statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This layout arranges children in a grid fashion where every cell in the grid is the same
size You may specify the number of rows and columns as well as the width and height of the
grid cells
:param allowEmptyCells: (C Q) Specify true if you want free positioning of the children in
the layout and potentially leaving empty cells between children Set to false if you wan
:param annotation: (C Q E) Annotate the control with an extra string value
:param autoGrow: (C Q) Specify true if you want the grid layout size to grow as children
are added For example, if the grid layout has 2 columns and 2 rows then adding a f
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param cellHeight: (C Q E) A positive non-zero integer value indicating the height of cells
in the grid layout
:param cellWidth: (C Q E) A positive non-zero integer value indicating the width of cells
in the grid layout
:param cellWidthHeight: (C E) Two positive non-zero integer values for indicating the width
and height, respectively, of the cells in the grid layout
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param columnsResizable: (C Q) Specify true if you want the number of columns to adjust
according to the width of the layout Set to false if you want the number of columns to
rema
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param gridOrder: (Q) As opposed to the childArray flag, the gridOrder flag returns the
children of the grid Layout in the order they are diplayed in the window
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfColumns: (C Q E) A positive non-zero integer value indicating the number of
columns in the grid layout
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param numberOfRows: (C Q E) A positive non-zero integer value indicating the number of
rows in the grid layout
:param numberOfRowsColumns: (C E) Two positive non-zero integer values for the number of
rows and columns, respectively, in the grid layout
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param position: (C E M) Specify the name of a child control in the grid layout along with
a 1-based integer value indicating the desired position of the child Positions inc
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def ExtractFaceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TogglePolyNonPlanarFaceDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModifyUpperRadiusPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PerPointEmissionRates(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_GetEnumCount(*args, **kwargs)->None:
"""
"""
pass
def parent(*args, absolute: bool=True, addObject: bool=True, noConnections: bool=True,
noInvScale: bool=True, relative: bool=True, removeObject: bool=True, shape:
bool=True, world: bool=True, **kwargs)->List[AnyStr]:
"""
This command parents (moves) objects under a new group, removes objects from an existing
group, or adds/removes parents If the -w flag is specified all the selected or specified
objects are parented to the world (unparented first) If the -rm flag is specified then
all the selected or specified instances are removed If there are more than two
:param absolute: (C) preserve existing world object transformations (overall object
transformation is preserved by modifying the objects local transformation) If the obje
:param addObject: (C) preserve existing local object transformations but don't reparent,
just add the object(s) under the parent Use -world to add the world as a parent o
:param noConnections: (C) The parent command will normally generate new instanced set
connections when adding instances (ie make a connection to the shading engine for new i
:param noInvScale: (C) The parent command will normally connect inverseScale to its parent
scale on joints This is used to compensate scale on joint The connection of inv
:param relative: (C) preserve existing local object transformations (relative to the parent
node)
:param removeObject: (C) Remove the immediate parent of every object specified To remove
only a single instance of a shape from a parent, the path to the shape should be spe
:param shape: (C) The parent command usually only operates on transforms Using this flags
allows a shape that is specified to be directly parented under the given tra
:param world: (C) unparent given object(s) (parent to world)
:returns: Names of the objects parented (possibly renamed)
"""
pass
def showManipCtx(*args, currentNodeName: bool=True, exists: bool=True, history: bool=True,
image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", incSnap: Union[List[int, bool], List[List[int,
bool]]]=None, incSnapRelative: Union[List[int, bool], List[List[int,
bool]]]=None, incSnapUI: bool=True, incSnapValue: Union[List[int, float],
List[List[int, float]], bool]=None, lockSelection: bool=True, name: AnyStr="",
toggleIncSnap: bool=True, toolFinish: Union[Script, bool]=None, toolStart:
Union[Script, bool]=None, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create a show manip context The show manip context will
display manips for all selected objects that have valid manips defined for them
:param currentNodeName: (Q) Returns the name of the first node that the context is attached
to
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param incSnap: (C Q E M) If true, the manipulator owned by the context will use
incremental snapping for specified mode
:param incSnapRelative: (C Q E M) If true, the manipulator owned by the context will use
relative incremental snapping for specified mode
:param incSnapUI: (Q) Returns an array of elements indicating what kind of incremental snap
UI is required by the manipulator owned by the context If no UI is required, t
:param incSnapValue: (C Q E M) Supply the step value which the manipulator owned by the
context will use for specified mode
:param lockSelection: (C Q E) If true, this context will never change the current selection
By default this is set to false
:param name: (C) If this is a tool command, name the tool appropriately
:param toggleIncSnap: (C E) Toggles (enables/disables) snapping for all modes
:param toolFinish: (C Q E) Supply the script that will be run when the user exits the
script
:param toolStart: (C Q E) Supply the script that will be run when the user first enters the
script
:returns: The name of the newly created context.
"""
pass
def dgfilter(*args, attribute: AnyStr="", list: bool=True, logicalAnd: List[AnyStr,
AnyStr]=None, logicalNot: AnyStr="", logicalOr: List[AnyStr, AnyStr]=None, name:
AnyStr="", node: AnyStr="", nodeType: AnyStr="", plug: AnyStr="",
**kwargs)->AnyStr:
"""
The dgfilter command is used to define Dependency Graph filters that select DG objects
based on certain criteria The command itself can be used to filter objects or it can be
attached to a dbtrace object to selectively filter what output is traced If objects are
specified then apply the filter to those objects and return a boolean indicating whet
:param attribute: (C) Select objects whose attribute names match the pattern
:param list: (C) List the available filters If used in conjunction with the -name flag it
will show a description of what the filter is
:param logicalAnd: (C) Logical AND of two filters
:param logicalNot: (C) Logical inverse of filter
:param logicalOr: (C) Logical OR of two filters
:param name: (C) Use filter named FILTER (or create new filter with that name) If no
objects are specified then the name given to the filter will be returned
:param node: (C) Select objects whose node names match the pattern
:param nodeType: (C) Select objects whose node type names match the pattern
:param plug: (C) Select objects whose plug names match the pattern
:returns: if creating filter or getting filter info
"""
pass
def BoundaryOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PickWalkDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SculptSurfacesToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyTorus(*args, axis: Union[List[float, float, float], bool]=None, caching: bool=True,
constructionHistory: bool=True, createUVs: bool=True, name: AnyStr="", nodeState:
Union[int, bool]=0, object: bool=True, radius: Union[float, bool]=1.0,
sectionRadius: Union[float, bool]=0.50, subdivisionsAxis: Union[int, bool]=20,
subdivisionsHeight: Union[int, bool]=20, subdivisionsX: Union[int, bool]=20,
subdivisionsY: Union[int, bool]=20, texture: bool=True, twist: Union[float,
bool]=0.0, q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr],
Any]:
"""
The torus command creates a new polygonal torus
:param axis: (C Q E) This flag specifies the primitive axis used to build the torus Q:
When queried, this flag returns a vector
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createUVs: (C Q E) Create UVs or not Default: true
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node (where applicable)
:param radius: (C Q E) Radius of the torus Default: 1.0
:param sectionRadius: (C Q E) Section of the torus Default: 0.50
:param subdivisionsAxis: (C Q E) Subdivisions about the vertical axis Default: 20
:param subdivisionsHeight: (C Q E) Subdivisions along the height Default: 20
:param subdivisionsX: (C Q E) This specifies the number of subdivisions in the X direction
for the torus (number of sections) C: Default is 20 Q: When queried, this flag returns
:param subdivisionsY: (C Q E) This flag specifies the number of subdivisions in the Y
direction for the torus (number of segments per section) C: Default is 20 Q: When queried,:param texture: (C Q E) Apply texture or not this is an old attribute This is unsupported
and would be removed in a future release Default: true
:param twist: (C Q E) Twist angle of the torus Default: 0.0
:returns: Object name and node name.
"""
pass
def paramDimContext(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Command used to register the paramDimCtx tool
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: - name of the context created
"""
pass
def connectControl(*args, fileName: bool=True, index: int=0, preventContextualMenu: bool=True,
preventOverride: bool=True, **kwargs)->None:
"""
This command attaches a UI widget, specified as the first argument, to one or more
dependency node attributes The attributes/nodes don't have to exist yet, they will get
looked up as needed With no flag specified, this command works on these kinds of controls:
floatField, floatScrollBar, floatSlider, intField, intScrollBar, intSlider, floatFieldG
:param fileName: (C) This flag causes the connection to be treated as a filename, and the
conversion from internal to external filename representation is made as the data
:param index: (C) This flag enables you to pick out a sub-control from a group that
contains a number of different controls For example, you can connect one field of
:param preventContextualMenu: (C) If true, this flag will block the right mouse button menu
of the associated control attribute
:param preventOverride: (C) If true, this flag disallows overriding the control's attribute
via the control's right mouse button menu
:returns:
"""
pass
def xgmSculptLayerInit(*args, **kwargs)->None:
"""
"""
pass
def SelectPolygonToolMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateAnnotateNode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HidePlanes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SlideEdgeToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutlinerToggleAssignedMaterials(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeToggleNodeSwatchSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def attachCurve(*args, blendBias: Union[float, bool]=0.5, blendKnotInsertion: bool=False,
caching: bool=True, keepMultipleKnots: bool=True, method: Union[int, bool]=0,
nodeState: Union[int, bool]=0, parameter: Union[float, bool]=0.1, reverse1:
bool=False, reverse2: bool=False, constructionHistory: bool=True, name:
AnyStr="", object: bool=True, replaceOriginal: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This attach command is used to attach curves Once the curves are attached, there will be
multiple knots at the joined point(s) These can be kept or removed if the user wishes If
there are two curves, the end of the first curve is attached to the start of the second
curve If there are more than two curves, closest endpoints are joined Note: i
:param blendBias: (C Q E) Skew the result toward the first or the second curve depending on
the blend factory being smaller or larger than 0.5 Default: 0.5
:param blendKnotInsertion: (C Q E) If set to true, insert a knot in one of the original
curves (relative position given by the parameter attribute below) in order to produce a
slightly
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param keepMultipleKnots: (C Q E) If true, keep multiple knots at the join parameter
Otherwise remove them Default: true
:param method: (C Q E) Attach method (connect-0, blend-1) Default: 0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param parameter: (C Q E) The parameter value for the positioning of the newly inserted
knot Default: 0.1
:param reverse1: (C Q E) If true, reverse the first input curve before doing attach
Otherwise, do nothing to the first input curve before attaching NOTE: setting this attri
:param reverse2: (C Q E) If true, reverse the second input curve before doing attach
Otherwise, do nothing to the second input curve before attaching NOTE: setting this att
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def keyTangent(*args, absolute: bool=True, animation: AnyStr="keysOrObjects.", attribute:
Union[AnyStr, List[AnyStr]]="", controlPoints: bool=False, float:
Union[floatrange, List[floatrange]]=None, g: bool=True, hierarchy: AnyStr="",
inAngle: Union[float, bool]=0.0, inTangentType: Union[AnyStr, bool]="",
inWeight: Union[float, bool]=0.0, includeUpperBound: bool=True, index: Union[int,
List[int]]=0, ix: Union[float, bool]=0.0, iy: Union[float, bool]=0.0, lock:
bool=True, outAngle: Union[float, bool]=0.0, outTangentType: Union[AnyStr,
bool]="", outWeight: Union[float, bool]=0.0, ox: Union[float, bool]=0.0, oy:
Union[float, bool]=0.0, pluginTangentTypes: Union[AnyStr, bool]="", relative:
bool=True, shape: bool=True, stepAttributes: bool=True, time: Union[timerange,
List[timerange]]=None, unify: bool=True, weightLock: bool=True,
weightedTangents: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[int, Any]:
"""
This command operates on a keyset A keyset is defined as a group of keys within a
specified time range on one or more animation curves The animation curves comprising a
keyset depend on the value of the "-animation" flag: keysOrObjects: Any active keys, when
no target objects or -attribute flags appear on the command line, or All animation curv
:param absolute: (C E) Changes to tangent positions are NOT relative to the current
position
:param animation: (C) Where this command should get the animation to act on Valid values
are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Descrip
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param float: (C M) value uniquely representing a non-time-based key (or key range) on a
time-based animCurve Valid floatRange include single values (-f 10) or a string
:param g: (C) Required for all operations on the global tangent type The global tangent
type is used by the setKeyframe command when tangent types have not been s
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param inAngle: (C Q E) New value for the angle of the in-tangent Returns a float[] when
queried
:param inTangentType: (C Q E) Specify the in-tangent type Valid values are "spline,"
"linear," "fast," "slow," "flat," "step," "stepnext," "fixed," "clamped," "plateau" and
"auto
:param inWeight: (C Q E) New value for the weight of the in-tangent Returns a float[] when
queried
:param includeUpperBound: (C) When the -t/time or -f/float flags represent a range of keys,
this flag determines whether the keys at the upper bound of the range are included in t
:param index: (C M) index of a key on an animCurve In query mode, this flag needs a value
:param ix: (C Q E) New value for the x-component of the in-tangent This is a unit
independent representation of the tangent component Returns a float[] when queried
:param iy: (C Q E) New value for the y-component of the in-tangent This is a unit
independent representation of the tangent component Returns a float[] when queried
:param lock: (C Q E) Lock a tangent so in and out tangents move together Returns an int[]
when queried
:param outAngle: (C Q E) New value for the angle of the out-tangent Returns a float[] when
queried
:param outTangentType: (C Q E) Specify the out-tangent type Valid values are "spline,"
"linear," "fast," "slow," "flat," "step," "stepnext," "fixed," "clamped," "plateau" and
"aut
:param outWeight: (C Q E) New value for the weight of the out-tangent Returns a float[]
when queried
:param ox: (C Q E) New value for the x-component of the out-tangent This is a unit
independent representation of the tangent component Returns a float[] when queried
:param oy: (C Q E) New value for the y-component of the out-tangent This is a unit
independent representation of the tangent component Returns a float[] when queried
:param pluginTangentTypes: (Q) Returns a list of the plug-in tangent types that have been
loaded Return type is a string array
:param relative: (C E) Changes to tangent positions are relative to the current position
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:param stepAttributes: (C E) The setKeyframe command will automatically set tangents for
boolean and enumerated attributes to step This flag mirrors this behavior for the keyTan
:param time: (C M) time uniquely representing a key (or key range) on a time-based
animCurve See the code examples below on how to format for a single frame or frame r
:param unify: (C E) Unify a tangent so in and out tangents are equal and move together
:param weightLock: (C Q E) Lock the weight of a tangent so it is fixed Returns an int[]
when queried Note: weightLock is only obeyed within the graph editor It is not obeyed
:param weightedTangents: (C Q E) Specify whether or not the tangents on the animCurve are
weighted Note: switching a curve from weightedTangents true to false and back to true
again
:returns: Number of curves on which tangents were modified.
"""
pass
def fluidAppendOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def VolumeAxisOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def geometryExportCacheOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def displayRGBColor(*args, create: bool=True, hueSaturationValue: bool=True, list: bool=True,
resetToFactory: bool=True, resetToSaved: bool=True, q=True, query=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command changes or queries the display color for anything in the application that
allows the user to set its color These colors are part of the UI and not part of the saved
data for a model This command is not undoable
:param create: (C) Creates a new RGB display color which can be queried or set If is used
only when saving color preferences name Specifies the name of color to chang
:param hueSaturationValue: (C Q) Indicates that rgb values are really hsv values Upon
query, returns the HSV valuses as an array of 3 floats r g b The RGB values for the color
(Be
:param list: (C) Writes out a list of all RGB color names and their value
:param resetToFactory: (C) Resets all the RGB display colors to their factory defaults
:param resetToSaved: (C) Resets all the RGB display colors to their saved values
:returns: when the list flag is used, none otherwise
"""
pass
def keyframe(*args, absolute: bool=True, adjustBreakdown: bool=True, animation:
AnyStr="keysOrObjects.", attribute: Union[AnyStr, List[AnyStr]]="", breakdown:
bool=False, clipTime: List[time, time, float]=None, controlPoints: bool=False,
eval: bool=True, float: Union[floatrange, List[floatrange]]=None, floatChange:
Union[float, bool]=0.0, hierarchy: AnyStr="", includeUpperBound: bool=True, index:
Union[int, List[int]]=0, indexValue: bool=True, keyframeCount: bool=True,
lastSelected: bool=True, name: bool=True, option: AnyStr="", relative: bool=True,
selected: bool=True, shape: bool=True, tickDrawSpecial: bool=True, time:
Union[timerange, List[timerange]]=None, timeChange: Union[time, bool]=None,
valueChange: Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[int, Any]:
"""
This command operates on a keyset A keyset is defined as a group of keys within a
specified time range on one or more animation curves The animation curves comprising a
keyset depend on the value of the "-animation" flag: keysOrObjects: Any active keys, when
no target objects or -attribute flags appear on the command line, or All animation curv
:param absolute: (C) Move amounts are absolute
:param adjustBreakdown: (C) When false, moving keys will not preserve breakdown timing,
when true (the default) breakdowns will be adjusted to preserve their timing relationship
:param animation: (C) Where this command should get the animation to act on Valid values
are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Descrip
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param breakdown: (C Q E) Sets the breakdown state for the key Returns an integer Default
is false The breakdown state of a key cannot be set in the same command as it is m
:param clipTime: (C) Modifies the final time where a key is inserted using an offset, pivot,
and scale
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param eval: (C Q) Returns the value(s) of the animCurves when evaluated (without regard to
input connections) at the times given by the -t/time or -f/float flags Cann
:param float: (C M) value uniquely representing a non-time-based key (or key range) on a
time-based animCurve Valid floatRange include single values (-f 10) or a string
:param floatChange: (C Q E) How much (with -relative) or where (with -absolute) to move
keys (on non-time-input animation curves) along the x (float) axis Returns float[] when
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param includeUpperBound: (C) When the -t/time or -f/float flags represent a range of keys,
this flag determines whether the keys at the upper bound of the range are included in t
:param index: (C M) index of a key on an animCurve In query mode, this flag needs a value
:param indexValue: (C Q) Query-only flag that returns an int for the key's index
:param keyframeCount: (C Q) Returns an int for the number of keys found for the targets
:param lastSelected: (C Q) When used in queries, this flag returns requested values for the
last selected key
:param name: (C Q) Returns the names of animCurves of specified nodes, attributes or keys
:param option: (C E) Valid values are "move," "insert," "over," and "segmentOver." When you
"move" a key, the key will not cross over (in time) any keys before or after i
:param relative: (C) Move amounts are relative to a key's current position
:param selected: (C Q) When used in queries, this flag returns requested values for any
active keys
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:param tickDrawSpecial: (C E) Sets the special drawing state for this key when it is drawn
as a tick in the timeline
:param time: (C M) time uniquely representing a key (or key range) on a time-based
animCurve See the code examples below on how to format for a single frame or frame r
:param timeChange: (C Q E) How much (with -relative) or where (with -absolute) to move keys
(on time-input animation curves) along the x (time) axis Returns float[] when queri
:param valueChange: (C Q E) How much (with -relative) or where (with -absolute) to move
keys along the y (value) axis Returns float[] when queried
:returns: (except where noted below)
Number of curves on which keys were modified.
In
-query mode, the command can return a variety of things,
as described with each queryable
flag below.
"""
pass
def toolPropertyWindow(*args, field: Union[AnyStr, bool]="", helpButton: Union[AnyStr, bool]="",
icon: Union[AnyStr, bool]="", inMainWindow: bool=True, location:
Union[AnyStr, bool]="", noviceMode: bool=True, resetButton: Union[AnyStr,
bool]="", restore: bool=True, selectCommand: Union[AnyStr, bool]="",
showCommand: Union[AnyStr, bool]="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
End users should only call this command as 1 a query (in the custom tool property sheet
code) or 2 with no arguments to create the default tool property sheet The more complex
uses of it are internal
:param field: (Q E) Sets/returns the name of the text field used to store the tool name in
the property sheet
:param helpButton: (Q E) Sets/returns the name of the button used to show help on the tool
in the property sheet
:param icon: (Q E) Sets/returns the name of the static picture object (used to display the
tool icon in the property sheet)
:param inMainWindow: (C) Specify true if you want the tool settings to appear in the main
window rather than a separate window
:param location: (Q E) Sets/returns the location of the current tool property sheet, or an
empty string if there is none
:param noviceMode: (Q E) Sets/returns the 'novice mode' flag.(unused at the moment)
:param resetButton: (Q E) Sets/returns the name of the button used to restore the tool
settings in the property sheet
:param restore: (C) Reopens the tool settings window This flag can be used with the flag
inMainWindow for the fall back location if the tool settings can't be restored
:param selectCommand: (Q E) Sets/returns the property sheet's select command
:param showCommand: (Q E) Sets/returns the property sheet's display command
:returns:
"""
pass
def PFXUVSetLinkingEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def delete(*args, all: bool=True, attribute: Union[AnyStr, List[AnyStr]]="", channels:
bool=True, constraints: bool=True, constructionHistory: bool=True, controlPoints:
bool=False, expressions: bool=True, hierarchy: AnyStr="", inputConnectionsAndNodes:
bool=True, motionPaths: bool=True, shape: bool=True, staticChannels: bool=True,
timeAnimationCurves: bool=True, unitlessAnimationCurves: bool=True, **kwargs)->None:
"""
This command is used to delete selected objects, or all objects, or objects specified along
with the command Flags are available to filter the type of objects that the command acts
on At times, more than just specified items will be deleted For example, deleting two
CVs in the same "row" on a NURBS surface will delete the whole row
:param all: (C) Remove all objects of specified kind, in the scene This flag is to be used
in conjunction with the following flags
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param channels: (C) Remove animation channels in the scene Either all channels can be
removed, or the scope can be narrowed down by specifying some of the above mention
:param constraints: (C) Remove selected constraints and constraints attached to the
selected nodes, or remove all constraints in the scene
:param constructionHistory: (C) Remove the construction history on the objects specified or
selected
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param expressions: (C) Remove expressions in the scene Either all expressions can be
removed, or the scope can be narrowed down by specifying some of the above mentioned o
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param inputConnectionsAndNodes: (C) Break input connection to specified attribute and
delete all unconnected nodes that are left behind The graph will be traversed until a node
that ca
:param motionPaths: (C) Remove motion paths in the scene Either all motion paths can be
removed, or the scope can be narrowed down by specifying some of the above mentioned
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:param staticChannels: (C) Remove static animation channels in the scene Either all static
channels can be removed, or the scope can be narrowed down by specifying some of the
:param timeAnimationCurves: (C) Modifies the -c/channels and -sc/staticChannels flags When
true, only channels connected to time-input animation curves (for instance, those created
:param unitlessAnimationCurves: (C) Modifies the -c/channels and -sc/staticChannels flags
When true, only channels connected to unitless-input animation curves (for instance, those
cre
:returns:
"""
pass
def expression(*args, alwaysEvaluate: Union[int, bool]=0, animated: Union[int, bool]=0,
attribute: Union[AnyStr, bool]="", name: Union[AnyStr, bool]="", object:
Union[AnyStr, bool]="", safe: bool=True, shortNames: bool=True, string:
Union[AnyStr, bool]="", timeDependent: bool=True, unitConversion: Union[AnyStr,
bool]="all.", q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command describes an expression that belongs to the current scene The expression is a
block of code of unlimited length with a C-like syntax that can perform conversions,
mathematical operations, and logical decision making on any numeric attribute(s) in the
scene One expression can read and alter any number of numeric attributes Theoretica
:param alwaysEvaluate: (C Q E) If this is TRUE (the default), then the expression will be
evaluated whenever time changes regardless of whether the other inputs have changed, and a
:param animated: (C Q E) Sets the animation mode on the expression node: 0 = Not Animated,
1 = Animated, 2 = Animated with No Callback
:param attribute: (C Q E) Sets the name of the attribute to use for the expression
:param name: (C Q E) Sets the name of the dependency graph node to use for the expression
:param object: (C Q E) Sets the "default" object for the expression This allows the
expression writer to not type the object name for frequently-used objects See the exam
:param safe: (Q) Returns true if no potential side effect can occurs running that
expression Safe expression will be optimized to evaluate only when needed even if f
:param shortNames: (C Q E) When used with the -q/query flag, tells the command to return
the expression with attribute names as short as possible The default is to return the
:param string: (C Q E) Set the expression string
:param timeDependent: (Q) Returns true if expression is evaluated when time change An
expression can be time-dependent for the following reasons: - The expression refers to '
:param unitConversion: (Q E) Insert specified unit conversion nodes at creation: "all",
"none," or "angularOnly." Default is "all." For angularOnly, will insert unit conversion n
:returns: The name of the expression
"""
pass
def DeleteAllNParticles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PreloadReferenceEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def IKSplineHandleTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CurveSmoothnessMedium(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ProportionalModificationTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def connectionInfo(*args, destinationFromSource: bool=True, getExactDestination: bool=True,
getExactSource: bool=True, getLockedAncestor: bool=True, isDestination:
bool=True, isExactDestination: bool=True, isExactSource: bool=True,
isLocked: bool=True, isSource: bool=True, sourceFromDestination: bool=True,
**kwargs)->bool:
"""
The connectionInfo command is used to get information about connection sources and
destinations Unlike the isConnected command, this command needs only one end of the
connection
:param destinationFromSource: (C) If the specified plug (or its ancestor) is a source, this
flag returns the list of destinations connected from the source (array of strings, empty
a
:param getExactDestination: (C) If the plug or its ancestor is connection destination, this
returns the name of the plug that is the exact destination (empty string if there is no
:param getExactSource: (C) If the plug or its ancestor is a connection source, this returns
the name of the plug that is the exact source (empty string if there is no such con
:param getLockedAncestor: (C) If the specified plug is locked, its name is returned If an
ancestor of the plug is locked, its name is returned If more than one ancestor is locke
:param isDestination: (C) Returns true if the plug (or its ancestor) is the destination of
a connection, false otherwise
:param isExactDestination: (C) Returns true if the plug is the exact destination of a
connection, false otherwise
:param isExactSource: (C) Returns true if the plug is the exact source of a connection,
false otherwise
:param isLocked: (C) Returns true if this plug (or its ancestor) is locked
:param isSource: (C) Returns true if the plug (or its ancestor) is the source of a
connection, false otherwise
:param sourceFromDestination: (C) If the specified plug (or its ancestor) is a destination,
this flag returns the source of the connection (string, empty if none)
:returns: When asking for a property, depending on the flags used.
"""
pass
def PaintEffectsPanel(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def color(*args, rgbColor: List[float, float, float]=None, userDefined: int=0, **kwargs)->None:
"""
This command sets the dormant wireframe color of the specified objects to be their class
color or if the -ud/userDefined flag is specified, one of the user defined colors The
-rgb/rgbColor flags can be specified if the user requires floating point RGB colors
:param rgbColor: (C) Specifies and rgb color to set the selected object to
:param userDefined: (C) Specifies the user defined color index to set selected object to
The valid range of numbers is [1-8]
:returns:
"""
pass
def dR_hypergraphTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyHelix(*args, caching: bool=True, coils: Union[float, bool]=3, constructionHistory:
bool=True, createUVs: Union[int, bool]=2, direction: Union[int, bool]=1, height:
Union[float, bool]=2.0, name: AnyStr="", nodeState: Union[int, bool]=0, object:
bool=True, radius: Union[float, bool]=0.4, roundCap: bool=False,
subdivisionsAxis: Union[int, bool]=8, subdivisionsCaps: Union[int, bool]=0,
subdivisionsCoil: Union[int, bool]=50, texture: Union[int, bool]=2,
useOldInitBehaviour: bool=False, width: Union[float, bool]=2.0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The polyHelix command creates a new polygonal helix
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param coils: (C Q E) Number of coils Default: 3
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createUVs: (C Q E) Create UVs or not 0: No UVs 1: No Normalization 2: Normalize 3:
Normalize and Preserve Aspect Ratio Default: 2
:param direction: (C Q E) What should be the direction of the coil 0=Clockwise;
1=Counterclockwise Default: 1
:param height: (C Q E) Height of the helix Default: 2.0
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node (where applicable)
:param radius: (C Q E) Radius of tube Default: 0.4
:param roundCap: (C Q E) To indicate whether we need a round cap Default: false
:param subdivisionsAxis: (C Q E) Subdivisions around the axis Default: 8
:param subdivisionsCaps: (C Q E) Subdivisions along the thickness caps Default: 0
:param subdivisionsCoil: (C Q E) Subdivisions along the coil Default: 50
:param texture: (C Q E) What texture mechanism to be applied 0=No textures; 1=Object;
2=Faces Default: 2
:param useOldInitBehaviour: (C Q E) Create the helix with base on the origin as in Maya
V8.0 and below Otherwise create helix centred at origin Default: false
:param width: (C Q E) Width of the helix Default: 2.0
:returns: Object name and node name.
"""
pass
def bakeClip(*args, blend: List[int, int]=None, clipIndex: Union[int, List[int]]=0,
keepOriginals: bool=True, name: AnyStr="", **kwargs)->AnyStr:
"""
This command is used to bake clips and blends into a single clip
:param blend: (C) Specify the indices of the clips being blended
:param clipIndex: (C M) Specify the index of the clip to bake
:param keepOriginals: (C) Keep original clips in the trax editor and place the merged clip
into the visor The default is to schedule the merged clip, and to keep the original
:param name: (C) Specify the name of the new clip to create
:returns: clip name
"""
pass
def HIKToggleReleasePinning(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dgtimer(*args, combineType: bool=True, hide: Union[AnyStr, List[AnyStr], bool]="",
hierarchy: bool=True, maxDisplay: Union[int, bool]=0, name: Union[AnyStr, bool]="",
noHeader: bool=True, outputFile: Union[AnyStr, bool]="", overhead: bool=True,
rangeLower: float=0.0, rangeUpper: float=0.0, reset: bool=True, returnCode:
Union[AnyStr, bool]="", returnType: Union[AnyStr, bool]="", show: Union[AnyStr,
List[AnyStr], bool]="", sortMetric: Union[AnyStr, bool]="", sortType: Union[AnyStr,
bool]="", threshold: Union[float, bool]=0.0, timerOff: bool=True, timerOn:
bool=True, trace: bool=True, type: Union[AnyStr, bool]="", uniqueName: bool=True,
updateHeatMap: int=0, q=True, query=True, **kwargs)->Union[float, Any]:
"""
This command measures dependency graph node performance by managing timers on a per-node
basis Logically, each DG node has a timer associated with it which records the amount of
real time spent in various operations on its plugs The time measurement includes the cost
of copying data to the node on behalf of the operation, MEL commands executed by
:param combineType: (Q) Causes all nodes of the same type (e.g animCurveTA) to be combined
in the output display
:param hide: (C Q M) This flag is the converse of -show As with -show, it is a query-only
flag which can be specified multiple times If you do specify -hide, we display
:param hierarchy: (C Q) Used to specify that a hierarchy of the dependency graph be
affected, thus "-reset -hierarchy -name ball" will reset the timers on the node named "ba
:param maxDisplay: (Q) Truncates the display so that only the most expenive "n" entries are
printed in the output display
:param name: (C Q) Used in conjunction with -reset or -query to specify the name of the
node to reset or print timer values for When querying a single timer, only a si
:param noHeader: (C Q) Used in conjunction with -query to prevent any header or footer
information from being printed All that will be output is the per-node timing data
:param outputFile: (Q) Specifies where the output of timing or tracing is displayed The
flag takes a string argument which accepts three possible values: The name of a fil
:param overhead: (C Q) Turns on and off the measurement of timing overhead Under ordinary
circumstances the amount of timing overhead is minimal compared with the events b
:param rangeLower: (C) This flag can be specified to limit the range of nodes which are
displayed in a query, or the limits of the heat map with -updateHeatMap The value i
:param rangeUpper: (C) This flag can be specified to limit the range of nodes which are
displayed in a query, or the limits of the heat map with -updateHeatMap The value i
:param reset: (C) Resets the node timers to zero By default, the timers on all nodes as
well as the global timers are reset, but if specified with the -name or -type
:param returnCode: (C Q) This flag has been replaced by the more general -returnType flag
The -returnCode flag was unfortunately specific to the compute metric only It exis
:param returnType: (Q) This flag specifies what the double value returned by the dgtimer
command represents By default, the value returned is the global total as displayed
:param show: (C Q M) Used in conjunction with -query to specify which columns are to be
displayed in the per-node section of the output -show takes an argument, which ca
:param sortMetric: (C Q) Used in conjunction with -query to specify which metric is to be
sorted on when the per-node section of the output is generated, for example "draw" t
:param sortType: (C Q) Used in conjunction with -query to specify which timer is to be
sorted on when the per-node section of the output is generated, for example "self" ti
:param threshold: (Q) Truncates the display once the value falls below the threshold value
The threshold applies to whatever timer is being used for sorting For example,
:param timerOff: (C Q) Turns off node timing By default, the timers on all nodes are
turned off, but if specified with the -name or -type flags, only the timers on specifi
:param timerOn: (C Q) Turns on node timing By default, the timers on all nodes are turned
on, but if specified with the -name or -type flags, only the timers on specified
:param trace: (C) Turns on or off detailed execution tracing By default, tracing is off
If enabled, each timeable operation is logged when it starts and again when i
:param type: (C Q) Used in conjunction with -reset or -query to specify the type of the
node(s) (e.g animCurveTA) to reset or print timer values for When querying, us
:param uniqueName: (C Q) Used to specify that the DAG nodes listed in the output should be
listed by their unique names The full DAG path to the object will be printed out i
:param updateHeatMap: (C) Forces Maya's heat map to rebuild based on the specified
parameters The heat map is an internal dgtimer structure used in mapping intensity values
t
:returns: By default, the total of self-compute time for all nodes. Can be modified via the
-returnType, -sortMetric and -sortType flags.
"""
pass
def hwRender(*args, acceleratedMultiSampleSupport: bool=True, activeTextureCount: bool=True,
camera: Union[AnyStr, bool]="", currentFrame: bool=True, currentView: bool=True,
edgeAntiAliasing: Union[List[int, int], bool]=None, fixFileNameNumberPattern:
bool=True, frame: float=0.0, fullRenderSupport: bool=True, height: Union[int,
bool]=0, imageFileName: bool=True, layer: Union[name, bool]=None,
limitedRenderSupport: bool=True, lowQualityLighting: bool=True, noRenderView:
bool=True, notWriteToFile: bool=True, printGeometry: bool=True,
renderHardwareName: bool=True, renderRegion: Union[List[int, int, int, int],
bool]=None, renderSelected: bool=True, textureResolution: Union[int, bool]=0,
width: Union[int, bool]=0, writeAlpha: bool=True, writeDepth: bool=True, q=True,
query=True, **kwargs)->Union[bool, Any]:
"""
Renders an image or a sequence using the hardware rendering engine
:param acceleratedMultiSampleSupport: (Q) This flag when used with query will return
whether the graphics supports hardware accelerated multi-sampling
:param activeTextureCount: (Q) This flag when used with query will return the number of
textures that have been bound to the graphics by the hardware renderer
:param camera: (C Q) Specify the camera to use Use the first available camera if the
camera given is not found
:param currentFrame: (C Q) Render the current frame
:param currentView: (C Q) When turned on, only the current view will be rendered
:param edgeAntiAliasing: (C Q) Enables multipass rendering Controls for the number of
exposures rendered per frame are provided in the form of two associated flag arguments The
f
:param fixFileNameNumberPattern: (C Q) This flag allows the user to take the
hardwareRenderGlobals filename as the initial filename pattern, fix the frame number
pattern in the filename in
:param frame: (C) Specify the frame to render
:param fullRenderSupport: (C Q) This flag may be used in the create or query context In
the create context, it will force the renderer to abort and not render any frames if the
har
:param height: (C Q) Height If not used, the height is taken from the render globals
settings
:param imageFileName: (C Q) This flag let people query the image name for a specified frame
The frame can be specified using the "-frame" flag When no "-frame" is used, the cu
:param layer: (C Q) Render the specified render layer Only this render layer will be
rendered, regardless of the renderable attribute value of the render layer The lay
:param limitedRenderSupport: (Q) This flag when used with query will return whether limited
rendering is supported on the current graphics system Please see the graphics card qualif
:param lowQualityLighting: (C Q) Disable lighting evaluation per pixel (fragment) Note:
The values passed via the command will override settings stored in the hardware render
global
:param noRenderView: (C Q) When turned on, the render view is not updated after image
computation
:param notWriteToFile: (C Q) This flag is set to true if the user does not want to write
the image to a file It is set to false, otherwise The default value of the flag is "fal
:param printGeometry: (C Q) Print the geomety objects as they get translated
:param renderHardwareName: (Q) This flag will create a graphics context and return the name
of the graphics hardware being used The graphics hardware is determined by creating an
:param renderRegion: (C Q) Render region The parameters are 4 integers, indicating left
right bottom top of the region
:param renderSelected: (C Q) Only renders the selected objects
:param textureResolution: (C Q) Specify the desired resolution of baked textures
:param width: (C Q) Width If not used, the width is taken from the render globals
settings
:param writeAlpha: (C Q) Read the alpha channel of color buffer and return as tif file
:param writeDepth: (C Q) Read the depth buffer and return as tif file
:returns: Command result
"""
pass
def HypershadeGraphDownstream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshSmoothTargetToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GpuCacheRefreshAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectSimilar(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def mtkQuadDrawPoint(*args, **kwargs)->None:
"""
"""
pass
def TimeEditorKeepTransitionsToggleRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sysFile(*args, copy: AnyStr="", delete: bool=True, makeDir: bool=True, move: AnyStr="",
removeEmptyDir: bool=True, rename: AnyStr="", **kwargs)->bool:
"""
This command provides a system independent way to create a directory or to rename or delete
a file
:param copy: (C) Copy the file to the name given by the newFileName paramter
:param delete: (C) Deletes the file
:param makeDir: (C) Create the directory path given in the parameter This will create the
entire path if more than one directory needs to be created
:param move: (C) Behaves identically to the -rename flag and remains for compatibility with
old scripts
:param removeEmptyDir: (C) Delete the directory path given in the parameter if the
directory is empty The command will not delete a directory which is not empty
:param rename: (C) Rename the file to the name given by the newFileName parameter
:returns: True if successful, false otherwise.
"""
pass
def UnpinSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FreeformFillet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateActiveRigidBodyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BevelPlusOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportSmoothingGroups(*args, **kwargs)->None:
"""
"""
pass
def NURBSSmoothnessRough(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SculptMeshDeactivateBrushSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def vnnCompound(*args, **kwargs)->None:
"""
"""
pass
def emitter(*args, alongAxis: Union[float, bool]=0.0, aroundAxis: Union[float, bool]=0.0,
awayFromAxis: Union[float, bool]=0.0, awayFromCenter: Union[float, bool]=0.0,
cycleEmission: Union[AnyStr, bool]="", cycleInterval: Union[int, bool]=0,
directionX: Union[float, bool]=0.0, directionY: Union[float, bool]=0.0, directionZ:
Union[float, bool]=0.0, directionalSpeed: Union[float, bool]=0.0, maxDistance:
Union[float, bool]=0.0, minDistance: Union[float, bool]=0.0, name: Union[AnyStr,
bool]="", needParentUV: bool=True, normalSpeed: Union[float, bool]=0.0, position:
Union[List[float, float, float], List[List[float, float, float]], bool]=None,
randomDirection: Union[float, bool]=0.0, rate: Union[float, bool]=0.0,
scaleRateByObjectSize: bool=True, scaleSpeedBySize: bool=True, speed: Union[float,
bool]=0.0, speedRandom: Union[float, bool]=0.0, spread: Union[float, bool]=0.0,
tangentSpeed: Union[float, bool]=0.0, torusSectionRadius: Union[float, bool]=0.0,
type: Union[AnyStr, bool]="", volumeOffset: Union[List[float, float, float],
bool]=None, volumeShape: Union[AnyStr, bool]="", volumeSweep: Union[float,
bool]=0.0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Creates, edits or queries an auxiliary dynamics object (for example, a field or emitter)
Creates an emitter object If object names are provided or if objects are selected, applies
the emitter to the named/selected object(s)in the scene Particles will then be emitted
from each If no objects are named or selected, or if the -pos option is specifi
:param alongAxis: (Q E) Initial velocity multiplier in the direction along the central axis
of the volume See the diagrams in the documentation Applies only to volume emit
:param aroundAxis: (Q E) Initial velocity multiplier in the direction around the central
axis of the volume See the diagrams in the documentation Applies only to volume emi
:param awayFromAxis: (Q E) Initial velocity multiplier in the direction away from the
central axis of the volume See the diagrams in the documentation Used only with the cyli
:param awayFromCenter: (Q E) Initial velocity multiplier in the direction away from the
center point of a cube or sphere volume emitter Used only with the cube and sphere volume
:param cycleEmission: (Q E) Possible values are "none" and "frame." Cycling emission
restarts the random number stream after a specified interval This can either be a number
of
:param cycleInterval: (Q E) Specifies the number of frames or particles between restarts of
the random number stream See cycleEmission Has no effect if cycleEmission is set to
:param directionX: (Q E) x-component of emission direction Used for directional emitters,
and for volume emitters with directionalSpeed
:param directionY: (Q E) y-component of emission direction Used for directional emitters,
and for volume emitters with directionalSpeed
:param directionZ: (Q E) z-component of emission direction Used for directional emitters,
and for volume emitters with directionalSpeed
:param directionalSpeed: (Q E) For volume emitters only, adds a component of speed in the
direction specified by the directionX, Y, and Z attributes Applies only to volume emitter
:param maxDistance: (Q E) Maximum distance at which emission ends
:param minDistance: (Q E) Minimum distance at which emission starts
:param name: (C Q E) Object name
:param needParentUV: (Q E) If aNeedParentUV is true, compute parentUV value from each
triangle or each line segment, then send out to the target particle object You also need
:param normalSpeed: (Q E) Normal speed multiple for point emission For each emitted
particle, multiplies the component of the velocity normal to the surface or curve by this
:param position: (C Q E M) world-space position
:param randomDirection: (Q E) Magnitude of a random component of the speed from volume
emission
:param rate: (Q E) Rate at which particles emitted (can be non-integer) For point emission
this is rate per point per unit time For surface emission it is rate per sq
:param scaleRateByObjectSize: (Q E) Applies to curve and surface emitters, only If true,
number of particles is determined by object size (area or length) times rate value If
false, o
:param scaleSpeedBySize: (Q E) Indicates whether the scale of a volume emitter affects its
velocity
:param speed: (Q E) Speed multiple Multiplies the velocity of the emitted particles by
this amount Does not apply to volume emitters For that emitter type, use direct
:param speedRandom: (Q E) Identifies a range of random variation for the speed of each
generated particle If set to a non-zero value, speed becomes the mean value of the gene
:param spread: (Q E) Random spread (0-1), as a fraction of 90 degrees, along specified
direction Directional emitters only
:param tangentSpeed: (Q E) Tangent speed multiple for point emission For each emitted
particle, multiplies the component of the velocity tangent to the surface or curve by thi
:param torusSectionRadius: (Q E) Section radius for a torus volume Applies only to torus
Similar to the section radius in the torus modelling primitive
:param type: (Q E) Type of emitter The choices are omni | dir | direction | surf | surface
| curve | curv The default is omni The full definition of these types are:
:param volumeOffset: (Q E) Volume offset of the emitter Volume offset translates the
emission volume by the specified amount from the actual emitter location This is in the e
:param volumeShape: (Q E) Volume shape of the emitter Sets/edits/queries the field's
volume shape attribute If set to any value other than "none", determines a 3-D volume wi
:param volumeSweep: (Q E) Volume sweep of the emitter Applies only to sphere, cone,
cylinder, and torus Similar effect to the sweep attribute in modelling
:returns: Command result
"""
pass
def EnterEditModePress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeRefreshFileListing(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def render(*args, abortMissingTexture: bool=True, batch: bool=True, keepPreImage: bool=True,
layer: AnyStr="", nglowpass: bool=True, nshadows: bool=True, replace: bool=True,
xresolution: int=0, yresolution: int=0, **kwargs)->AnyStr:
"""
The render command is used to start off a MayaSoftware rendering session of the currently
active camera If a rendering is already in progress, then this command stops the rendering
This command is not undoable
:param abortMissingTexture: (C) Abort renderer when encountered missing texture Only
available when -batch is set
:param batch: (C) Run in batch mode Compute the images for all renderable cameras This is
the mel equivalent of running maya in batch mode with the -render flag set
:param keepPreImage: (C) Keep the renderings prior to post-process around Only available
when -batch is set
:param layer: (C) Render the specified render layer Only this render layer will be
rendered, regardless of the renderable attribute value of the render layer The lay
:param nglowpass: (C) Overwrite glow pass capabilities (can turn off glow pass globally by
setting this value to false)
:param nshadows: (C) Shadowing capabilities (can turn off shadow globally by setting this
value to false)
:param replace: (C) Replace the rendered image if it already exists Only available when
-batch is set
:param xresolution: (C) Overwrite x resolution
:param yresolution: (C) Overwrite y resolution
:returns: The name of the rendered image.
"""
pass
def fileInfo(*args, referenceNode: Union[AnyStr, bool]="", remove: Union[AnyStr, bool]="",
q=True, query=True, **kwargs)->Union[List[AnyStr], Any]:
"""
fileInfo provides a mechanism for keeping information related to a Maya scene file Each
invocation of the command consists of a keyword/value pair, where both the keyword and the
associated value are strings The command may be invoked multiple times with different
keywords Maya emits this command several times into each file it creates, primaril
:param referenceNode: (Q) Specify the name of a referenceNode to indicate the scene file to
query This flag is only valid during query In query mode, this flag needs a value
:param remove: (C Q) If the remove flag is specified, the string following it is a keyword
to remove from the list of fileInfo to be saved with the scene file
:returns: Command result
"""
pass
def Create2DContainerOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowLights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleSelectDetails(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AttachSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintReduceWeightsToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PickWalkIn(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_bevelPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshGrabUVTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MakeFluidCollide(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_viewGridTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def colorManagementConvert(*args, toDisplaySpace: List[float, float, float]=None,
**kwargs)->None:
"""
This command can be used to convert rendering (a.k.a working) space color values to
display space color values This is useful if you create custom UI with colors painted to
screen, where you need to handle color management yourself The current view transform set
in the Color Management user preferences will be used
:param toDisplaySpace: (C) Converts the given RGB value to display space
:returns:
"""
pass
def SelectAllGeometry(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def floatSliderButtonGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0,
adjustableColumn3: int=0, adjustableColumn4: int=0, adjustableColumn5:
int=0, adjustableColumn6: int=0, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None,
buttonCommand: Script=None, buttonLabel: Union[AnyStr, bool]="",
changeCommand: Script=None, columnAlign: Union[List[int, AnyStr],
List[List[int, AnyStr]]]=None, columnAlign2: List[AnyStr, AnyStr]=None,
columnAlign3: List[AnyStr, AnyStr, AnyStr]=None, columnAlign4:
List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign5: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign6: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach:
Union[List[int, AnyStr, int], List[List[int, AnyStr, int]]]=None,
columnAttach2: List[AnyStr, AnyStr]=None, columnAttach3: List[AnyStr,
AnyStr, AnyStr]=None, columnAttach4: List[AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach5: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr, AnyStr]=None, columnOffset2: List[int, int]=None,
columnOffset3: List[int, int, int]=None, columnOffset4: List[int, int,
int, int]=None, columnOffset5: List[int, int, int, int, int]=None,
columnOffset6: List[int, int, int, int, int, int]=None, columnWidth:
Union[List[int, int], List[List[int, int]]]=None, columnWidth1: int=0,
columnWidth2: List[int, int]=None, columnWidth3: List[int, int,
int]=None, columnWidth4: List[int, int, int, int]=None, columnWidth5:
List[int, int, int, int, int]=None, columnWidth6: List[int, int, int,
int, int, int]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dragCommand: Script=None,
dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
extraLabel: Union[AnyStr, bool]="", field: bool=True, fieldMaxValue:
Union[float, bool]=0.0, fieldMinValue: Union[float, bool]=0.0,
fieldStep: Union[float, bool]=0.0, fullPathName: bool=True, height:
Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, image: Union[AnyStr, bool]="", isObscured: bool=True,
label: Union[AnyStr, bool]="", manage: bool=True, maxValue:
Union[float, bool]=0.0, minValue: Union[float, bool]=0.0,
noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, precision: int=0,
preventOverride: bool=True, rowAttach: Union[List[int, AnyStr, int],
List[List[int, AnyStr, int]]]=None, sliderStep: Union[float, bool]=0.0,
statusBarMessage: AnyStr="", step: Union[float, bool]=0.0,
symbolButtonCommand: Script=None, symbolButtonDisplay: bool=True,
useTemplate: AnyStr="", value: Union[float, bool]=0.0, visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param buttonCommand: (C E) Command string to be executed when the button is pressed
:param buttonLabel: (C Q E) The button text
:param changeCommand: (C E) Command string executed when the value of the slider changes
It will be executed only once after a drag of the slider
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command string executed repeatedly during a drag of the slider
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param extraLabel: (C Q E) If present on creation this specifies that there will be an
extra label appearing after the slider Sets the string to be the text for the extra labe
:param field: (C) Indicates whether the group will have an editable float field present
that reflects the value of the slider
:param fieldMaxValue: (C Q E) Maximum value that may be entered in the field This value
may be set to any value greater than the -max/maxValue flag By default, it is equal to th
:param fieldMinValue: (C Q E) Minimum value that may be entered in the field This value
may be set to any value less than the -min/minValue flag By default, it is equal to the -
:param fieldStep: (C Q E) Increment for the field
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param image: (C Q E) Image displayed on the symbol button
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) If present on creation the group will have static text
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxValue: (C Q E) Maximum value for both the slider and the field
:param minValue: (C Q E) Minimum value for both the slider and the field
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param precision: (C E) Number of digits to the right of the decimal
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param sliderStep: (C Q E) The slider step value represents the amount the value will
increase or decrease when you click either side of the slider
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) Increment for both the slider and field
:param symbolButtonCommand: (C E) Command string executed when the symbol button is
pressed
:param symbolButtonDisplay: (C Q E) Visibility of the symbol button
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Value of the group
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def GetToonExample(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def jointDisplayScale(*args, absolute: bool=True, ikfk: Union[float, bool]=0.0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[float, Any]:
"""
This action modifies and queries the current display size of skeleton joints The joint
display size is controlled by a scale factor; a scale factor of 1 sets the display size to
its default, which is 1 in diameter With the plain format, the float argument is the
factor with respect to the default size When -a/absolute is used, the float argument
:param absolute: (C Q E) Interpret the float argument as the display size as opposed to the
scale factor
:param ikfk: (C Q E) Set the display size of ik/fk skeleton joints
:returns: Returns current display size of skeleton joints.
"""
pass
def OptimizeSceneOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_selConstraintAngle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def componentBox(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
execute: List[AnyStr, bool]=None, exists: bool=True, fullPathName: bool=True,
height: Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, isObscured: bool=True, labelWidth: Union[int, bool]=0, manage:
bool=True, maxHeight: Union[int, bool]=0, maxWidth: Union[int, bool]=0,
noBackground: bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, precision: Union[int, bool]=3,
preventOverride: bool=True, rowHeight: int=0, selectedAttr: bool=True,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a component box, which is sensitive to the active list It displays
certain components of the last node on the active list, and provides a two-way connection
to keep the widget up to date
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param execute: (E) Immediately executes the command string once for every cell (or every
selected cell, if the boolean argument is TRUE) in the component box, for every
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param labelWidth: (Q E) An optional flag which is used to modify the width assigned to
labels appearing in the componentBox
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxHeight: (Q E) An optional flag which is used to limit the height of the
componentBox
:param maxWidth: (Q E) An optional flag which is used to limit the width of the
componentBox
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param precision: (Q E) Controls the number of digits to the right of the decimal point
that will be displayed for float-valued components Default is 3 Queried, returns an
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowHeight: (E) An optional flag which is used to set the height of all rows in the
componentBox
:param selectedAttr: (Q) Returns a list of names of all the attributes that are selected
This flag is ignored when not being queried
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: (the name of the new component box)
"""
pass
def sound(*args, endTime: Union[time, bool]=None, file: Union[AnyStr, bool]="", length:
bool=True, mute: bool=True, name: Union[AnyStr, bool]="", offset: Union[time,
bool]=None, sourceEnd: Union[time, bool]=None, sourceStart: Union[time, bool]=None,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Creates an audio node which can be used with UI commands such as soundControl or
timeControl which support sound scrubbing and sound during playback
:param endTime: (C Q E) Time at which to end the sound
:param file: (C Q E) Name of sound file
:param length: (Q) Query the length (in the current time unit) of the sound
:param mute: (C Q E) Mute the audio clip
:param name: (C Q E) Name to give the resulting audio node
:param offset: (C Q E) Time at which to start the sound
:param sourceEnd: (C Q E) Time offset from the start of the sound file at which to end the
sound
:param sourceStart: (C Q E) Time offset from the start of the sound file at which to start
the sound
:returns: Name of resulting audio node
"""
pass
def DetachSkinOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorToggleSoloSelectedTracks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_movePress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmFindAttachment(*args, **kwargs)->None:
"""
"""
pass
def insertJointCtx(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The command will create an insert joint context The insert joint tool inserts joints into
an existing chain of joints
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:returns: The name of the context.
"""
pass
def xgmParticleRender(*args, **kwargs)->None:
"""
"""
pass
def CreateCreaseSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AlembicReplace(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SquashOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dataStructure(*args, asFile: Union[AnyStr, bool]="", asString: Union[AnyStr, bool]="",
dataType: bool=True, format: Union[AnyStr, bool]="", listMemberNames:
Union[AnyStr, bool]="", name: Union[AnyStr, bool]="", remove: bool=True,
removeAll: bool=True, q=True, query=True, **kwargs)->Union[AnyStr, Any]:
"""
Takes in a description of the structure and creates it, adding it to the list of available
data structures The structure definition can either be supplied in the asString flag or
exist in a file that is referenced by the asFile flag If the remove flag is specified
with a name flag then the data structure will be removed This is to keep all stru
:param asFile: (C Q) Specify a file that contains the serialized data which describes the
structure The format of the data is specified by the 'format' flag
:param asString: (C Q) Specify the string containing the serialized data which describes
the structure The format of the data is specified by the 'format' flag
:param dataType: (C Q) Used with the flag 'listMemberNames' to query the type of the member
The type is appended after each relative member in the array For example, if t
:param format: (C Q) Format of data to expect in the structure description "raw" is
supported natively and will be assumed if the format type is omitted Others are avai
:param listMemberNames: (C Q) Query the member names in the dataStructure The member names
will be returned in an array The name of the data structure will not be returned To g
:param name: (Q) Query mode only Name of the data structure to be queried, or set to list
the available names In query mode, this flag can accept a value
:param remove: (C) Remove the named data structure It's an error if it doesn't exist
:param removeAll: (C) Remove all metadata structures This flag can not be used in
conjunction with any other flags
:returns: Name of the resulting structure, should match the name defined in the structure
description
"""
pass
def DeleteAllCameras(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def profiler(*args, addCategory: AnyStr="", allCategories: bool=True, bufferSize: Union[int,
bool]=0, categoryIndex: Union[int, bool]=0, categoryIndexToName: Union[int,
bool]=0, categoryInfo: Union[AnyStr, bool]="", categoryName: Union[AnyStr,
bool]="", categoryNameToIndex: Union[AnyStr, bool]="", categoryRecording:
bool=True, clearAllMelInstrumentation: bool=True, colorIndex: int=0, eventCPUId:
bool=True, eventCategory: bool=True, eventColor: bool=True, eventCount: bool=True,
eventDescription: bool=True, eventDuration: bool=True, eventIndex: Union[int,
bool]=0, eventName: bool=True, eventStartTime: bool=True, eventThreadId: bool=True,
instrumentMel: bool=True, load: Union[AnyStr, bool]="", output: Union[AnyStr,
bool]="", procedureDescription: AnyStr="", procedureName: AnyStr="",
removeCategory: AnyStr="", reset: bool=True, sampling: bool=True, signalEvent:
bool=True, signalMelEvent: bool=True, q=True, query=True, **kwargs)->Union[None,
Any]:
"""
The profiler is used to record timing information from key events within Maya, as an aid in
tuning the performance of scenes, scripts and plug-ins User written plug-ins and Python
scripts can also generate profiling information for their own code through the
MProfilingScope (C++), MProfilingContextManager (Python) and MProfiler classes in the API
:param addCategory: (C) Add a new category for the profiler Returns the index of the new
category
:param allCategories: (Q) Query the names of all categories If the categoryInfo flag is
set then alternate the name of the category with the description of the category
:param bufferSize: (C Q) Toggled : change the buffer size to fit the specified number of
events (requires that sampling is off) Query : return the current buffer size The new
:param categoryIndex: (C Q) Used in conjunction with other flags, to indicate the index of
the category In query mode, this flag needs a value
:param categoryIndexToName: (C Q) Returns the name of the category with a given index In
query mode, this flag needs a value
:param categoryInfo: (C Q) When used with the addCategory flag set the description of the
added profiler category In query mode return the description of the category referenc
:param categoryName: (Q) Used in conjunction with other flags, to indicate the name of the
category In query mode, this flag needs a value
:param categoryNameToIndex: (C Q) Returns the index of the category with a given name In
query mode, this flag needs a value
:param categoryRecording: (C Q) Toggled : Enable/disable the recording of the category
Query : return if the recording of the category is On Requires the -categoryIndex or
-catego
:param clearAllMelInstrumentation: (C) Clear all MEL command or procedure instrumentation
:param colorIndex: (C) Used with "-instrumentMel true" to specify the color index to show
the profiling result
:param eventCPUId: (Q) Query the CPU ID of the event at the given index Requires the
-eventIndex flag to specify the event to be queried
:param eventCategory: (Q) Query the category index the event at the given index belongs to
Requires the -eventIndex flag to specify the event to be queried
:param eventColor: (Q) Query the color of the event at the given index Requires the
-eventIndex flag to specify the event to be queried
:param eventCount: (Q) Query the number of events in the buffer
:param eventDescription: (Q) Query the description of the event at the given index
Requires the -eventIndex flag to specify the event to be queried
:param eventDuration: (Q) Query the duration of the event at the given index, the time unit
is microsecond Note that a signal event has a 0 duration Requires the -eventIndex
:param eventIndex: (Q) Used usually in conjunction with other flags, to indicate the index
of the event In query mode, this flag needs a value
:param eventName: (Q) Query the name of the event at the given index Requires the
-eventIndex flag to specify the event to be queried
:param eventStartTime: (Q) Query the time of the event at the given index, the time unit is
microsecond Requires the -eventIndex flag to specify the event to be queried
:param eventThreadId: (Q) Query the thread ID of the event at the given index Requires the
-eventIndex flag to specify the event to be queried
:param instrumentMel: (C) Enable/Diable the instrumentation of a MEL command or procedure
When the instrumentation is enabled, the execution of MEL command or procedure can b
:param load: (C Q) Read the recorded events from the specified file
:param output: (C Q) Output the recorded events to the specified file
:param procedureDescription: (C) Used with "-instrumentMel true" to provide a description
of the MEL command or procedure being instrumented This description can be viewed in the
Pr
:param procedureName: (C) Used with -instrumentMel to specify the name of the procedure to
be enabled/disabled the instrumentation
:param removeCategory: (C) Remove an existing category for the profiler Returns the index
of the removed category
:param reset: (C Q) reset the profiler's data (requires that sampling is off)
:param sampling: (C Q) Toggled : Enable/disable the recording of events Query : return if
the recording of events is On
:param signalEvent: (Q) Query if the event at the given index is a signal event Requires
the -eventIndex flag to specify the event to be queried A Signal Event only rememb
:param signalMelEvent: (C) Used with "-instrumentMel true", inform profiler that this
instrumented MEL command or procedure will be taken as a signal event during profiling A
:returns:
"""
pass
def columnLayout(*args, adjustableColumn: bool=True, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, childArray:
bool=True, columnAlign: AnyStr="", columnAttach: List[AnyStr, int]=None,
columnOffset: List[AnyStr, int]=None, columnWidth: Union[int, bool]=0,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float, float,
float], bool]=None, isObscured: bool=True, manage: bool=True, noBackground:
bool=True, numberOfChildren: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
rowSpacing: Union[int, bool]=0, statusBarMessage: AnyStr="", useTemplate:
AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script, bool]=None,
width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a layout that arranges its children in a single column
:param adjustableColumn: (C E) Sets the children of the layout to be attached on both sides
They will stretch or shrink with the layout
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param columnAlign: (C E) Sets the alignment of children containing text or pixmaps Align
values: "left" | "right" | "center"
:param columnAttach: (C E) Sets the attachment and offsets for the children of the layout
Side values: "left" | "right" | "both" Left or both is recommended
:param columnOffset: (C E) Sets the offsets for children of the layout Side values: "left"
| "right" | "both"
:param columnWidth: (C Q E) Sets the width of the column Unless the children are attached
to both sides of the column, the width cannot be enforced Larger children will expand
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowSpacing: (C Q E) Sets the space between children
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def dR_selectModeHybrid(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypergraphWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LightningOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def u3dAutoSeam(*args, **kwargs)->None:
"""
"""
pass
def HideManipulators(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ReducePolygon(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def texLatticeDeformContext(*args, envelope: Union[float, bool]=0.0, exists: bool=True,
history: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
latticeColumns: Union[int, bool]=0, latticeRows: Union[int, bool]=0,
name: AnyStr="", showMoveManipulator: bool=True, snapPixelMode:
bool=True, useBoundingRect: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[int, Any]:
"""
This command creates a context which may be used to deform UV maps with lattice manipulator
This context only works in the texture UV editor
:param envelope: (C Q E) Specifies the influence of the lattice
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param latticeColumns: (C Q E) Specifies the number column points the lattice contains The
maximum size lattice is restricted to 8 columns
:param latticeRows: (C Q E) Specifies the number of rows the lattice contains The maximum
size lattice is restricted to 8 rows
:param name: (C) If this is a tool command, name the tool appropriately
:param showMoveManipulator: (C Q E) Specifies whether show move manipulator in UV Editor
:param snapPixelMode: (C Q E) Specifies the influenced uv points should be snapped to a
pixel center or corner
:param useBoundingRect: (C Q E) When constructing the lattice use the bounding box of the
selected UVs for the extents of the lattice When this is disabled the extents of the
marqu
:returns: Number of column divisions, when querying the latticeColumns flag.
"""
pass
def RepeatLast(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmUISelectionSync(*args, **kwargs)->None:
"""
"""
pass
def CreateBifrostAero(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmGuideSculptContext(*args, **kwargs)->None:
"""
"""
pass
def skinBindCtx(*args, about: Union[AnyStr, bool]="", axis: Union[AnyStr, bool]="", colorRamp:
Union[AnyStr, bool]="", currentInfluence: Union[AnyStr, bool]="",
displayInactiveMode: Union[int, bool]=0, displayNormalized: bool=True, exists:
bool=True, falloffCurve: Union[AnyStr, bool]="", history: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", symmetry: bool=True, tolerance: Union[float,
bool]=0.0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command creates a tool that can be used to edit volumes from an interactive bind
:param about: (C Q E) The space in which the axis should be mirrored Valid values are:
"world" and "object"
:param axis: (C Q E) The mirror axis Valid values are: "x","y", and "z"
:param colorRamp: (C Q E) Set the values on the color ramp used to display the weight
values
:param currentInfluence: (C Q E) Set the index of the current influence or volume to be
adjusted by the manipulator
:param displayInactiveMode: (C Q E) Determines the display mode for drawing volumes that
are not selected, in particular which volume cages if any are displayed 0 - None 1 -
Nearby vol
:param displayNormalized: (C Q E) Display raw select weights (false) or finalized
normalized weights (true)
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param falloffCurve: (C Q E) Set the values on the falloff curve control
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param symmetry: (C Q E) Controls whether or not the tool operates in symmetric (mirrored)
mode
:param tolerance: (C Q E) The tolerance setting for determining whether another influence
is symmetric to the the current influence
:returns: The name of the context created
"""
pass
def assignCommand(*args, addDivider: AnyStr="", altModifier: bool=True, annotation:
Union[AnyStr, bool]="", command: Union[Script, bool]=None, commandModifier:
bool=True, ctrlModifier: bool=True, data1: Union[AnyStr, bool]="", data2:
Union[AnyStr, bool]="", data3: Union[AnyStr, bool]="", delete: int=0,
dividerString: Union[AnyStr, bool]="", enableCommandRepeat: bool=True,
factorySettings: bool=True, index: int=0, keyArray: bool=True, keyString:
Union[AnyStr, bool]="", keyUp: bool=True, name: bool=True,
numDividersPreceding: Union[int, bool]=0, numElements: bool=True,
optionModifier: bool=True, sortByKey: bool=True, sourceUserCommands:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[None,
Any]:
"""
This command allows the user to assign hotkeys and manipulate the internal array of named
command objects Each object in the array has an 1-based index which is used for
referencing Under expected usage you should not need to use this command directly as the
Hotkey Editor may be used to assign hotkeys This command is obsolete for setting new
ho
:param addDivider: (E) Appends an "annotated divider" item to the end of the list of
commands
:param altModifier: (E) This flag specifies if an alt modifier is used for the key
:param annotation: (Q E) The string is the english name describing the command
:param command: (Q E) This is the command that is executed when this object is mapped to a
key or menuItem
:param commandModifier: (E) This flag specifies if a command modifier is used for the key
This is only available on systems which support a separate command key
:param ctrlModifier: (E) This flag specifies if a ctrl modifier is used for the key
:param data1: (Q E) Optional, user-defined data strings may be attached to the nameCommand
objects
:param data2: (Q E) Optional, user-defined data strings may be attached to the nameCommand
objects
:param data3: (Q E) Optional, user-defined data strings may be attached to the nameCommand
objects
:param delete: (E) This tells the Manager to delete the object at position index
:param dividerString: (Q) If the passed index corresponds to a "divider" item, then the
divider's annotation is returned Otherwise, a null string is returned
:param enableCommandRepeat: (E) This flag specifies whether command repeat is enabled
:param factorySettings: (E) This flag sets the manager back to factory settings
:param index: (E) The index of the object to operate on The index value ranges from 1 to
the number of name command objects
:param keyArray: (Q) This flag returns all of the hotkeys on the command
:param keyString: (Q E) This specifies a key to assign a command to in edit mode In query
mode this flag returns the key string, modifiers and indicates if the command is m
:param keyUp: (E) This flag specifies if the command is executed on keyUp or keyDown
:param name: (Q) The name of the command object
:param numDividersPreceding: (Q) If the index of a namedCommand object C is passed in, then
this flag returns the number of "divider" items preceding C when the namedCommands are sor
:param numElements: (Q) This command returns the number of namedCommands in the system
This flag doesn't require the index to be specified
:param optionModifier: (E) This flag specifies if an option modifier is used for the key
:param sortByKey: (Q E) This key tells the manager to sort by key or by order of creation
:param sourceUserCommands: (E) This command sources the user named command file
:returns:
"""
pass
def keyframeRegionSetKeyCtx(*args, breakdown: bool=True, exists: bool=True, history: bool=True,
image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="",
image3: Union[AnyStr, bool]="", name: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a context which may be used to set keys within the keyframe region of
the dope sheet editor
:param breakdown: (Q E) Specifies whether or not to create breakdown keys
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Context name
"""
pass
def FillHole(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertSelectionToShellBorder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LayoutUVOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cluster(*args, after: bool=True, afterReference: bool=True, before: bool=True, bindState:
bool=True, deformerTools: bool=True, envelope: Union[float, bool]=1.0, exclusive:
Union[AnyStr, bool]="", frontOfChain: bool=True, geometry: Union[AnyStr,
List[AnyStr], bool]="", geometryIndices: bool=True, ignoreSelected: bool=True,
includeHiddenSelections: bool=False, name: AnyStr="", parallel: bool=True, prune:
bool=True, relative: bool=True, remove: Union[bool, List[bool]]=True,
resetGeometry: bool=True, split: bool=True, weightedNode: Union[List[AnyStr,
AnyStr], bool]=None, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The cluster command creates a cluster or edits the membership of an existing cluster The
command returns the name of the cluster node upon creation of a new cluster After
creating a cluster, the cluster's weights can be modified using the percent command or the
set editor window
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param bindState: (C) When turned on, this flag adds in a compensation to ensure the
clustered objects preserve their spatial position when clustered This is required to
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param envelope: (C Q E) Set the envelope value for the deformer Default is 1.0
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param name: (C) Used to specify the name of the node being created
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param relative: (C) Enable relative mode for the cluster In relative mode, Only the
transformations directly above the cluster are used by the cluster Default is off
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param resetGeometry: (E) Reset the geometry matrices for the objects being deformed by the
cluster This flag is used to get rid of undesirable effects that happen if you sca
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:param weightedNode: (C Q E) Transform node in the DAG above the cluster to which all
percents are applied The second DAGobject specifies the descendent of the first DAGobject
f
:returns: (the cluster node name and the cluster handle name)
"""
pass
def RemoveMaterialSoloing(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def displayStats(*args, **kwargs)->None:
"""
"""
pass
def evalNoSelectNotify(*args, **kwargs)->None:
"""
"""
pass
def FBXImportShapes(*args, **kwargs)->None:
"""
"""
pass
def texSculptCacheContext(*args, adjustSize: bool=True, adjustStrength: bool=True, direction:
Union[int, bool]=0, falloffType: Union[int, bool]=0, floodPin:
float=0.0, grabTwist: bool=True, inverted: bool=True, mode:
Union[AnyStr, bool]="", sculptFalloffCurve: Union[AnyStr, bool]="",
showBrushRingDuringStroke: bool=True, size: Union[float, bool]=0.0,
strength: Union[float, bool]=0.0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
This is a tool context command for uv cache sculpting tool
:param adjustSize: (E) If true, puts the tool into the mode where dragging the mouse will
edit the brush size If false, puts the tool back into the previous sculpt mode
:param adjustStrength: (E) If true, puts the tool into the mode where dragging the mouse
will edit the brush strength If false, puts the tool back into the previous sculpt mod
:param direction: (Q E) Specifies how the brush determines where the uvs go
:param falloffType: (Q E) Specifies how the brush determines which uvs to affect
:param floodPin: (C E) Sets the pin value for each UV to the given value
:param grabTwist: (C Q E) If true, the grab brush twists the UVs
:param inverted: (C Q E) If true, inverts the effect of the brush
:param mode: (Q E) Specifies the type of sculpting effect the brush will perform
:param sculptFalloffCurve: (Q E) Specifies the falloff curve that affects the brush
:param showBrushRingDuringStroke: (Q E) Specifies whether or not to show the brush ring
during stroke
:param size: (Q E) Specifies the world-space size of the current brush
:param strength: (Q E) Specifies the world-space strength of the current brush
:returns:
"""
pass
def NextManipulatorHandle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModifyLowerRadiusRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RandomizeShells(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteFBIKBodyPartKeys(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmWidthBrushContext(*args, **kwargs)->None:
"""
"""
pass
def subdivCrease(*args, sharpness: bool=True, **kwargs)->bool:
"""
Set the creasing on subdivision mesh edges or mesh points that are on the selection list
:param sharpness: (C) Specifies the sharpness value to set the crease to
:returns: Command result
"""
pass
def TimeEditorCreateGroupFromSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBifrostAccelerator(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeShowConnectedAttrs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def listConnections(*args, connections: bool=False, destination: bool=True, exactType:
bool=True, plugs: bool=False, shapes: bool=False, skipConversionNodes:
bool=False, source: bool=True, type: AnyStr="", **kwargs)->List[AnyStr]:
"""
This command returns a list of all attributes/objects of a specified type that are
connected to the given object(s) If no objects are specified then the command lists the
connections on selected nodes
:param connections: (C) If true, return both attributes involved in the connection The one
on the specified object is given first Default false
:param destination: (C) Give the attributes/objects that are on the "destination" side of
connection to the given object Default true
:param exactType: (C) When set to true, -t/type only considers node of this exact type
Otherwise, derived types are also taken into account
:param plugs: (C) If true, return the connected attribute names; if false, return the
connected object names only Default false;
:param shapes: (C) Actually return the shape name instead of the transform when the shape
is "selected" Default false
:param skipConversionNodes: (C) If true, skip over unit conversion nodes and return the
node connected to the conversion node on the other side Default false
:param source: (C) Give the attributes/objects that are on the "source" side of connection
to the given object Default true
:param type: (C) If specified, only take objects of a specified type
:returns: List of connection plugs/nodes
"""
pass
def u3dLayout(*args, **kwargs)->None:
"""
"""
pass
def ThreeTopSplitViewArrangement(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fluidReplaceCacheOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def debug(*args, **kwargs)->None:
"""
"""
pass
def LoopBrushAnimationOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def posePanel(*args, control: bool=True, copy: AnyStr="", createString: bool=True,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", editString: bool=True,
exists: bool=True, init: bool=True, isUnique: bool=True, label: Union[AnyStr,
bool]="", menuBarRepeatLast: bool=True, menuBarVisible: bool=True, needsInit:
bool=True, parent: AnyStr="", popupMenuProcedure: Union[Script, bool]=None,
poseEditor: bool=True, replacePanel: AnyStr="", tearOff: bool=True, tearOffCopy:
AnyStr="", tearOffRestore: bool=True, unParent: bool=True, useTemplate: AnyStr="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a panel that derives from the base panel class that houses a
poseEditor
:param control: (Q) Returns the top level control for this panel Usually used for getting
a parent to attach popup menus CAUTION: panels may not have controls at times
:param copy: (E) Makes this panel a copy of the specified panel Both panels must be of the
same type
:param createString: (E) Command string used to create a panel
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the Maya panel
:param editString: (E) Command string used to edit a panel
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param init: (C E) Initializes the panel's default state This is usually done
automatically on file -new and file -open
:param isUnique: (Q) Returns true if only one instance of this panel type is allowed
:param label: (Q E) Specifies the user readable label for the panel
:param menuBarRepeatLast: (C Q E) Controls whether clicking on the menu header with the
middle mouse button would repeat the last selected menu item
:param menuBarVisible: (C Q E) Controls whether the menu bar for the panel is displayed
:param needsInit: (Q E) (Internal) On Edit will mark the panel as requiring initialization
Query will return whether the panel is marked for initialization Used during fil
:param parent: (C) Specifies the parent layout for this panel
:param popupMenuProcedure: (Q E) Specifies the procedure called for building the panel's
popup menu(s) The default value is "buildPanelPopupMenu" The procedure should take one
stri
:param poseEditor: (Q) Query only flag that returns the name of an editor to be associated
with the panel
:param replacePanel: (E) Will replace the specified panel with this panel If the target
panel is within the same layout it will perform a swap
:param tearOff: (Q E) Will tear off this panel into a separate window with a paneLayout as
the parent of the panel When queried this flag will return if the panel has bee
:param tearOffCopy: (C) Will create this panel as a torn of copy of the specified source
panel
:param tearOffRestore: (C E) Restores panel if it is torn off and focus is given to it If
docked, becomes the active panel in the docked window This should be the default flag
:param unParent: (E) Specifies that the panel should be removed from its layout This
(obviously) cannot be used with query
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the panel
"""
pass
def ShowRenderingUI(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ActivateGlobalScreenSlider(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorGraphAllShapes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HidePolygonSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateEmptyUVSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeCreatePSDFile(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def menuSet(*args, addMenu: AnyStr="", allMenuSets: bool=True, currentMenuSet: Union[AnyStr,
bool]="", exists: Union[AnyStr, bool]="", hotBoxVisible: bool=True, insertMenu:
List[AnyStr, int]=None, label: Union[AnyStr, bool]="", menuArray:
Union[List[AnyStr], bool]=None, moveMenu: List[AnyStr, int]=None, moveMenuSet:
List[AnyStr, int]=None, numberOfMenuSets: bool=True, numberOfMenus: bool=True,
permanent: bool=True, removeMenu: AnyStr="", removeMenuSet: AnyStr="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a menu set which is used to logically order menus for display in the main menu bar
Such menu sets can be edited and reordered dynamically
:param addMenu: (C) Appends a menu onto the end of the current menu set
:param allMenuSets: (Q) Returns an array of the all the menu set object names in use Query
returns string array
:param currentMenuSet: (C Q) The currently active menu set under which all operations
affect (append, insert, remove, etc.) Query returns string
:param exists: (Q) Returns whether the specified menu set exists This query flag supports
string arguments ie menuSet -q -exists animationMenuSet; In query mode, thi
:param hotBoxVisible: (C Q E) Whether this menu set should be displayed in the hotbox as
well as in the main menubar
:param insertMenu: (C) Inserts a menu into a specified index in the current menu set
:param label: (C Q) The label of the current menu set Query returns string
:param menuArray: (C Q) An array of menu names (strings) in the current menu set Query
returns string array
:param moveMenu: (C) Moves a specified menu from the current menu set to a new position
:param moveMenuSet: (C) Moves a specified menu set to another index
:param numberOfMenuSets: (Q) Number of menuSets in total Query returns int
:param numberOfMenus: (Q) The mumber of menus in the current menu set Query returns int
:param permanent: (C Q E) Whether this menu set can be removed
:param removeMenu: (C) Removes a specified menu from the current menu set
:param removeMenuSet: (C) Removes the specified menu set object from the list of all menu
sets
:returns: Name of resulting menu set. (If there are no menu sets left, an empty string is
returned)
"""
pass
def workspace(*args, active: bool=True, baseWorkspace: Union[AnyStr, bool]="", create:
AnyStr="", directory: Union[AnyStr, bool]="", expandName: Union[AnyStr, bool]="",
fileRule: Union[List[AnyStr, AnyStr], bool]=None, fileRuleEntry: Union[AnyStr,
bool]="", fileRuleList: bool=True, filter: bool=True, fullName: bool=True, list:
bool=True, listFullWorkspaces: bool=True, listWorkspaces: bool=True,
newWorkspace: bool=True, objectType: Union[List[AnyStr, AnyStr], bool]=None,
objectTypeEntry: Union[AnyStr, bool]="", objectTypeList: bool=True,
openWorkspace: bool=True, projectPath: Union[AnyStr, bool]="",
removeFileRuleEntry: AnyStr="", removeVariableEntry: AnyStr="", renderType:
Union[List[AnyStr, AnyStr], bool]=None, renderTypeEntry: Union[AnyStr, bool]="",
renderTypeList: bool=True, rootDirectory: bool=True, saveWorkspace: bool=True,
shortName: bool=True, update: bool=True, updateAll: bool=True, variable:
Union[List[AnyStr, AnyStr], bool]=None, variableEntry: Union[AnyStr, bool]="",
variableList: bool=True, q=True, query=True, **kwargs)->Union[AnyStr, Any]:
"""
Create, open, or edit a workspace associated with a given workspace file The string
argument represents the workspace If no workspace is specified then the current workspace
is assumed A workspace provides the underlying definition of a Maya Project Each project
has an associated workspace file, named workspace.mel, which is stored in the pro
:param active: (C Q) This flag is a synonym for -o/openWorkspace
:param baseWorkspace: (Q) A workspace may be based on another workspace This means that
all the file rules and variables in the base workspace apply to this workspace unless
:param create: (C) Create a new directory If the directory name is not a full path name,
it will be created as a subdirectory of the "current" directory set with the -
:param directory: (C Q) This option will set the current workspace directory to the path
specified When queried it will return the current workspace directory This directo
:param expandName: (C Q) Query for the full path location of a filename using the current
workspace definition The path may be a project relative file name, a full path name
:param fileRule: (C Q) Set the default location for a file The first parameter is the
fileRule name(scenes, images, etc) and the second is the location When queried, it r
:param fileRuleEntry: (C Q) Return the location for the given fileRule
:param fileRuleList: (C Q) Returns a list of the currently defined file rules
:param filter: () This flag is obsolete
:param fullName: (C Q) Return the full name of the workspace
:param list: (C Q) This option will list the current workspace directory If a path is
specified for the "workspaceFile" then the contents of that directory will be lis
:param listFullWorkspaces: (C Q) Returns a list of the full path names of all the currently
defined workspaces
:param listWorkspaces: (C Q) Returns a list of all the currently defined workspace names
:param newWorkspace: (C) This specifies that a new workspace is being created with a given
path (full path or relative to "current" directory) If a workspace with this path
:param objectType: (C Q) This flag is obsolete All default locations will be added to the
fileRules going forward
:param objectTypeEntry: (C Q) This flag is obsolete This will now return the same as
fileRuleEntry
:param objectTypeList: (C Q) This flag is obsolete This will now return the same results
as fileRuleList going forward
:param openWorkspace: (C Q) Open the workspace The workspace becomes the current
workspace
:param projectPath: (C Q) Convert filePath passed as argument to a filename that is
relative to the project root directory (if possible) and return it If the filePath is not
:param removeFileRuleEntry: (C) Remove the given file rule from the specified workspace If
the workspace name is not specified, the given file rule will be removed from the current
:param removeVariableEntry: (C) Remove the given variable from the specified workspace If
the workspace name is not specified, the given variable will be removed from the current w
:param renderType: (C Q) This flag is obsolete All default render types will be added to
fileRules going forward
:param renderTypeEntry: (C Q) This flag is obsolete, use fileRuleEntry going forward
:param renderTypeList: (C Q) This flag is obsolete, use fileRuleList going forward
:param rootDirectory: (Q) Returns the root directory of the workspace
:param saveWorkspace: (C) Save the workspace Workspaces are normally saved when Maya exits
but this flag will make sure that the data is flushed to disk
:param shortName: (C Q) Query the short name of the workspace
:param update: (C) This flag reads all the workspace definitions from the project directory
It is used by Maya at startup time to find the available workspaces
:param updateAll: (C) This flag is a synonym for -u/update
:param variable: (C Q) Set or query the value of a project variable Project variables are
used when expanding names See the -en/expandName flag below
:param variableEntry: (C Q) Given a variable name, will return its value
:param variableList: (C Q) Return a list of all variables in the workspace
:returns: Project short name when querying the 'shortName' flag.
"""
pass
def AddKeyToolDeactivate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DetachSkeletonJoints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmSplineApplyRenderOverride(*args, **kwargs)->None:
"""
"""
pass
def texSmoothContext(*args, **kwargs)->None:
"""
"""
pass
def dR_objectXrayTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TogglePolyDisplayEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def disconnectJoint(*args, attachHandleMode: bool=True, deleteHandleMode: bool=True,
**kwargs)->AnyStr:
"""
This command will break a skeleton at the selected joint and delete any associated handles
:param attachHandleMode: (C) This flag is obsolete and no longer supported
:param deleteHandleMode: (C) Delete the handle on the associated joint
:returns: After the joint is disconnected, a new joint will be created. The return value is
the name of the newly created joint and its ancestor.
"""
pass
def DeleteExpressionsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyClipboard(*args, clear: bool=True, color: bool=True, copy: bool=True, paste: bool=True,
shader: bool=True, uvCoordinates: bool=True, **kwargs)->bool:
"""
The command allows the user to copy and paste certain polygonal attributes to a clipboard
These attributes are: 1) Shader (shading engine) assignment 2) Texture coordinate (UV)
assignment 3) Color value assignment Any combination of attributes can be chosen for the
copy or paste operation If the attribute has not been copied to the clipboard,
:param clear: (C) When used, will mean to clear the specified attribute argument(s)
:param color: (C) When used, will be to copy or paste color attributes
:param copy: (C) When used, will mean to copy the specified attribute argument(s)
:param paste: (C) When used, will mean to paste the specified attribute argument(s)
:param shader: (C) When used, will be to copy or paste shader attributes
:param uvCoordinates: (C) When used, will be to copy or paste texture coordinate
attributes
:returns: Success or Failure
"""
pass
def moduleDetectionLogic(*args, **kwargs)->None:
"""
"""
pass
def PolyExtrudeEdgesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RenderLayerEditorWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SnapToPoint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OffsetCurveOnSurfaceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideStrokeControlCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HoldCurrentKeys(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def StitchSurfacePoints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TwoStackedViewArrangement(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BakeNonDefHistoryOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CustomPolygonDisplayOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateWakeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EditMembershipTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowNParticles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Snap2PointsTo2Points(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dynamicLoad(*args, q=True, query=True, **kwargs)->Union[None, Any]:
"""
Dynamically load the DLL passed as argument
:returns:
"""
pass
def DeleteAllJoints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertSelectionToShell(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TranslateToolMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeDisplayAsMediumSwatches(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateCameraAimUp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyAssignSubdivHoleOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def drawExtrudeFacetCtx(*args, **kwargs)->None:
"""
"""
pass
def directConnectPath(*args, **kwargs)->None:
"""
"""
pass
def shotRipple(*args, deleted: bool=True, endDelta: Union[time, bool]=None, endTime: Union[time,
bool]=None, startDelta: Union[time, bool]=None, startTime: Union[time,
bool]=None, q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
When Ripple Edit Mode is enabled, neighboring shots to the shot that gets manipulated are
moved in sequence time to either make way or close up gaps corresponding to that node's
editing Given some parameters about the shot edit that just took place, this command will
choose which other shots to move, and move them the appropriate amounts If no sho
:param deleted: (C Q E) Specify whether this ripple edit is due to a shot deletion
:param endDelta: (C Q E) Specify the change in the end time in frames
:param endTime: (C Q E) Specify the initial shot end time in the sequence timeline
:param startDelta: (C Q E) Specify the change in the start time in frames
:param startTime: (C Q E) Specify the initial shot start time in the sequence timeline
:returns:
"""
pass
def ShowBoundingBox(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def frameLayout(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, backgroundShade: bool=True, borderStyle:
Union[AnyStr, bool]="", borderVisible: bool=True, childArray: bool=True,
collapsable: bool=True, collapse: bool=True, collapseCommand: Script=None,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, expandCommand:
Script=None, font: Union[AnyStr, bool]="", fullPathName: bool=True, height:
Union[int, bool]=0, highlightColor: Union[List[float, float, float], bool]=None,
isObscured: bool=True, label: Union[AnyStr, bool]="", labelAlign: Union[AnyStr,
bool]="top", labelIndent: Union[int, bool]=0, labelVisible: bool=True,
labelWidth: Union[int, bool]=0, manage: bool=True, marginHeight: Union[int,
bool]=0, marginWidth: Union[int, bool]=0, noBackground: bool=True,
numberOfChildren: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preCollapseCommand:
Script=None, preExpandCommand: Script=None, preventOverride: bool=True,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates frame layout control A frame layout may draw a border around its
child controls as well as a display a title Frame layouts may also be collapsable
Collapsing a frame layout will make the child of the frame layout invisible and shrink the
frame layout size The frame layout may then be expanded to make its child visible Note
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param backgroundShade: (C Q E) Controls whether the background of the frame layout draws
with a shaded effect It is turned off by default
:param borderStyle: (C Q E) This flag is obsolete The border style is no longer supported
Using this flag will return a warning
:param borderVisible: (C Q E) Visibility of the border
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param collapsable: (C Q E) Collapsibility of the frame layout
:param collapse: (C Q E) Collapse state of the frame layout
:param collapseCommand: (C E) Command executed after the frame is collapsed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param expandCommand: (C E) Command executed after the frame is expanded
:param font: (C Q E) The font for the frame label Valid values are "boldLabelFont",
"smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont", "
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) Label string for the frame layout
:param labelAlign: (C Q E) How to align the label Default is "top"
:param labelIndent: (C Q E) Indentation for the frame label
:param labelVisible: (C Q E) Visibility of the frame label
:param labelWidth: (C Q E) Width of the label
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param marginHeight: (C Q E) Vertical distance between the frame and its children
:param marginWidth: (C Q E) Horizontal distance between the frame and its children
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preCollapseCommand: (C E) Command executed just before the frame is collapsed
:param preExpandCommand: (C E) Command executed just before the frame is expanded
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def UpdateCurrentSceneMudbox(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def runTimeCommand(*args, **kwargs)->None:
"""
"""
pass
def upAxis(*args, axis: Union[AnyStr, bool]="", rotateView: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
The upAxis command changes the world up direction Current implementation provides only two
choices of axis (the Y-axis or the Z-axis) as the world up direction. By default, the
ground plane in Maya is on the XY plane Hence, the default up-direction is the direction
of the positive Z-axis. The -ax flag is mandatory In conjunction with the -ax f
:param axis: (Q) This flag specifies the axis as the world up direction The valid axis are
either "y" or "z" When queried, it returns a string
:param rotateView: (C) This flag specifies to rotate the view as well
:returns:
"""
pass
def HypershadeFrameAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddCombinationTarget(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Birail3Options(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HIKCharacterControlsTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def viewPlace(*args, animate: bool=True, eyePoint: List[float, float, float]=None, fieldOfView:
float=0.0, lookAt: List[float, float, float]=None, ortho: bool=True, perspective:
bool=True, upDirection: List[float, float, float]=None, viewDirection: List[float,
float, float]=None, **kwargs)->None:
"""
This command positions the camera as specified The lookAt and viewDirection flags are
mutually exclusive, as are the ortho and perspective flags If this command switches a
camera from ortho to perspective or the other way around without specifying a new field of
view, then one is calculated based on a heuristic involving the selected objects I
:param animate: (C) If set to true then animate the camera transition from current position
to the final one
:param eyePoint: (C) The new eye point in world coordinates
:param fieldOfView: (C) The new field of view (in degrees, for perspective cameras, and in
world distance for ortho cameras)
:param lookAt: (C) The new look-at point in world coordinates
:param ortho: (C) Sets the camera to be orthgraphic
:param perspective: (C) Sets the camera to be perspective
:param upDirection: (C) The new up direction vector
:param viewDirection: (C) The new view direction vector
:returns:
"""
pass
def channelBox(*args, annotation: Union[AnyStr, bool]="", attrBgColor: Union[List[float, float,
float], bool]=None, attrColor: Union[List[float, float, float], bool]=None,
attrFilter: Union[AnyStr, bool]="", attrRegex: Union[AnyStr, bool]="",
attributeEditorMode: bool=False, backgroundColor: Union[List[float, float,
float], bool]=None, containerAtTop: bool=True, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, enableLabelSelection: bool=False, execute:
List[AnyStr, bool]=None, exists: bool=True, fieldWidth: Union[int, bool]=0,
fixedAttrList: Union[List[AnyStr], bool]=None, fullPathName: bool=True, height:
Union[int, bool]=0, highlightColor: Union[List[float, float, float], bool]=None,
historyObjectList: bool=True, hyperbolic: bool=True, inputs: bool=True,
isObscured: bool=True, labelWidth: Union[int, bool]=0, longNames: bool=True,
mainListConnection: Union[AnyStr, bool]="", mainObjectList: bool=True, manage:
bool=True, maxHeight: Union[int, bool]=0, maxWidth: Union[int, bool]=0,
niceNames: bool=True, noBackground: bool=True, nodeRegex: Union[AnyStr, bool]="",
numberOfPopupMenus: bool=True, outputObjectList: bool=True, outputs: bool=True,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, precision: Union[int,
bool]=3, preventOverride: bool=True, select: Union[AnyStr, List[AnyStr]]="",
selectedHistoryAttributes: bool=True, selectedMainAttributes: bool=True,
selectedOutputAttributes: bool=True, selectedShapeAttributes: bool=True,
shapeObjectList: bool=True, shapes: bool=True, showNamespace: bool=True,
showTransforms: bool=True, speed: Union[float, bool]=1.0, statusBarMessage:
AnyStr="", takeFocus: bool=True, update: bool=True, useManips: Union[AnyStr,
bool]="", useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a channel box, which is sensitive to the active list It displays
certain attributes (channels) of the last node on the active list, and provides a two-way
connection to keep the widget up to date Note: when setting the color of attribute names,
that color is only valid for its current Maya session; each subsequent session wi
:param annotation: (C Q E) Annotate the control with an extra string value
:param attrBgColor: (C Q E) Controls the background text color of specific attribute names
As with the foreground option, this text coloring also depends on the node name choic
:param attrColor: (C Q E) Controls the foreground text color of specific attribute names
This text coloring also depends on the node name choice for the nodeRegex flag Argum
:param attrFilter: (Q E) Specifies the name of an itemFilter object to be placed on the
channel box This filters the attributes displayed A filter of "0" can be used to res
:param attrRegex: (C Q E) Specifies a valid regular expression to specify which attribute
names should be selected for foreground text coloring If attrRegex is unspecified th
:param attributeEditorMode: (Q E) Modifies what appears in the channel box for use in the
attribute editor Default is false Queried, returns a boolean
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param containerAtTop: (Q E) This flag can be used to specify whether or not the container
is drawn at the top of the channel box when a node in the container is selected
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param enableLabelSelection: (Q E) Enables the selection of attributes in the channelBox
when used in conjunction with -attributeEditorMode Default is false Queried, returns a
boolea
:param execute: (E) Immediately executes the command string once for every cell (or every
selected cell, if the boolean argument is TRUE) in the channel box, for every m
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fieldWidth: (Q E) An optional flag which is used to modify the width assigned to
fields appearing in the channelBox
:param fixedAttrList: (C Q E) Forces the channel box to only display attributes with the
specified names, in the order they are specified If an empty list is specified, then the
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param historyObjectList: (Q) Returns a list of strings, the names of every INPUT node
associated with an object on the main object list that is of the same type as the node
displ
:param hyperbolic: (C Q E) Determines whether or not the distance that the mouse has been
dragged should be interpreted as a linear or hyperbolic function The default is set t
:param inputs: (Q) Returns the items shown under the 'INPUTS' heading in the channel box
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param labelWidth: (Q E) An optional flag which is used to modify the width assigned to
labels appearing in the channelBox
:param longNames: (Q E) Controls whether long or short attribute names will be used in the
interface Note that this flag is ignored if the -niceNames flag is set Default i
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object which
the editor will use as its source of content The channel box will only display the (last)
i
:param mainObjectList: (Q) Returns a list of strings, the names of every object on the
active list that is the same type as the object displayed in the top (main) section of th
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxHeight: (Q E) An optional flag which is used to limit the height of the
channelBox
:param maxWidth: (Q E) An optional flag which is used to limit the width of the channelBox
:param niceNames: (Q E) Controls whether the attribute names will be displayed in a more
user-friendly, readable way When this is on, the longNames flag is ignored When th
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param nodeRegex: (C Q E) Specifies a valid regular expression to specify which node names
should (potentially) have their attributes selected for foreground text coloring If
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param outputObjectList: (Q) Returns a list of strings, the names of every OUTPUT node
associated an object on the main object list that is of the same type as the node
displayed
:param outputs: (Q) Returns the items shown under the 'OUTPUTS' heading in the channel box
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param precision: (Q E) Controls the number of digits to the right of the decimal point
that will be displayed for float-valued channels Default is 3 Queried, returns an i
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param select: (E M) Allows programmatic selection of items (nodes or plugs) in the channel
box Selection is equivalent to clicking the item with the mouse; therefore on
:param selectedHistoryAttributes: (Q) Returns a list of strings, the names of all the
selected attributes in the INPUT section of the channel box
:param selectedMainAttributes: (Q) Returns a list of strings, the names of all the selected
attributes in the top section of the channel box
:param selectedOutputAttributes: (Q) Returns a list of strings, the names of all the
selected attributes in the OUTPUT section of the channel box
:param selectedShapeAttributes: (Q) Returns a list of strings, the names of all the
selected attributes in the middle (shape) section of the channel box
:param shapeObjectList: (Q) Returns a list of strings, the names of every shape associated
with an object on the main object list that is of the same type as the object displaye
:param shapes: (Q) Returns the items shown under the 'SHAPES' heading in the channel box
:param showNamespace: (C Q E) Controls whether or not the namespace of an object is
displayed if the object is not in the root namespace
:param showTransforms: (Q E) Controls whether this control will display transform
attributes only, or all other attributes False by default Queried, returns a boolean
:param speed: (C Q E) Controls the speed at which the attributes are changed based on the
distance the mouse has been dragged Common settings for slow/medium/fast are 0.1
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param takeFocus: (E) causes the channel box to take over the keyboard focus, if it can
:param update: (E) This flag can be used to force an update of the channel box display, for
example after changing a display preference
:param useManips: (C Q E) When you click on a field or label in the channel box, the tool
switches to a manipulator that can change that value if you drag in the 3d view This
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: (the name of the new channel box)
"""
pass
def GoToFBIKStancePose(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ImportSkinWeightMaps(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def layeredTexturePort(*args, annotation: Union[AnyStr, bool]="", backgroundColor:
Union[List[float, float, float], bool]=None, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float,
float, float], bool]=None, isObscured: bool=True, manage: bool=True,
noBackground: bool=True, node: name=None, numberOfPopupMenus: bool=True,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, selectedAlphaControl: AnyStr="",
selectedBlendModeControl: AnyStr="", selectedColorControl: AnyStr="",
selectedIsVisibleControl: AnyStr="", statusBarMessage: AnyStr="",
useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a 3dPort that displays an image representing the layered texture node
specified
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param node: (C) Specifies the name of the newLayeredTexture node this port will represent
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param selectedAlphaControl: (C) Specifies the name of the UI-control that represents the
currently selected layer's alpha
:param selectedBlendModeControl: (C) Specifies the name of the UI-control that represents
the currently selected layer's blend mode
:param selectedColorControl: (C) Specifies the name of the UI-control that represents the
currently selected layer's color
:param selectedIsVisibleControl: (C) Specifies the name of the UI-control that represents
the currently selected layer's visibility
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def cutKey(*args, animation: AnyStr="keysOrObjects.", attribute: Union[AnyStr, List[AnyStr]]="",
clear: bool=True, controlPoints: bool=False, float: Union[floatrange,
List[floatrange]]=None, hierarchy: AnyStr="", includeUpperBound: bool=True, index:
Union[int, List[int]]=0, option: AnyStr="", selectKey: bool=True, shape: bool=True,
time: Union[timerange, List[timerange]]=None, **kwargs)->int:
"""
This command operates on a keyset A keyset is defined as a group of keys within a
specified time range on one or more animation curves The animation curves comprising a
keyset depend on the value of the "-animation" flag: keysOrObjects: Any active keys, when
no target objects or -attribute flags appear on the command line, or All animation curv
:param animation: (C) Where this command should get the animation to act on Valid values
are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Descrip
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param clear: (C) Just remove the keyframes (i.e do not overwrite the clipboard)
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param float: (C M) value uniquely representing a non-time-based key (or key range) on a
time-based animCurve Valid floatRange include single values (-f 10) or a string
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param includeUpperBound: (C) When the -t/time or -f/float flags represent a range of keys,
this flag determines whether the keys at the upper bound of the range are included in t
:param index: (C M) index of a key on an animCurve In query mode, this flag needs a value
:param option: (C) Option for how to perform the cutKey operation Valid values for this
flag are "keys", "curve", "curveCollapse", "curveConnect", "areaCollapse" The
:param selectKey: (C) Select the keyframes of curves which have had keys removed
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:param time: (C M) time uniquely representing a key (or key range) on a time-based
animCurve See the code examples below on how to format for a single frame or frame r
:returns: Number of animation curves cut.
"""
pass
def polyExtrudeEdge(*args, caching: bool=True, constructionHistory: bool=True, createCurve:
bool=True, divisions: Union[int, bool]=1, gain: Union[float, List[float],
bool]=1.0, inputCurve: name=None, keepFacesTogether: bool=True,
localCenter: Union[int, bool]=0, localDirection: Union[List[float, float,
float], bool]=None, localDirectionX: Union[float, bool]=0.0,
localDirectionY: Union[float, bool]=0.0, localDirectionZ: Union[float,
bool]=0.0, localRotate: Union[List[float, float, float], bool]=None,
localRotateX: Union[float, bool]=0.0, localRotateY: Union[float, bool]=0.0,
localRotateZ: Union[float, bool]=0.0, localScale: Union[List[float, float,
float], bool]=None, localScaleX: Union[float, bool]=0.0, localScaleY:
Union[float, bool]=0.0, localScaleZ: Union[float, bool]=0.0,
localTranslate: Union[List[float, float, float], bool]=None,
localTranslateX: Union[float, bool]=0.0, localTranslateY: Union[float,
bool]=0.0, localTranslateZ: Union[float, bool]=0.0, name: AnyStr="",
nodeState: Union[int, bool]=0, offset: Union[float, bool]=0.0, pivot:
Union[List[float, float, float], bool]=None, pivotX: Union[float, bool]=0.0,
pivotY: Union[float, bool]=0.0, pivotZ: Union[float, bool]=0.0, random:
Union[float, bool]=0.0, rotate: Union[List[float, float, float], bool]=None,
rotateX: Union[float, bool]=0.0, rotateY: Union[float, bool]=0.0, rotateZ:
Union[float, bool]=0.0, scale: Union[List[float, float, float], bool]=None,
scaleX: Union[float, bool]=0.0, scaleY: Union[float, bool]=0.0, scaleZ:
Union[float, bool]=0.0, smoothingAngle: Union[float, bool]=0.0, taper:
Union[float, bool]=1.0, taperCurve_FloatValue: Union[float, bool]=0.0,
taperCurve_Interp: Union[int, bool]=0, taperCurve_Position: Union[float,
bool]=0.0, thickness: Union[float, bool]=0.0, translate: Union[List[float,
float, float], bool]=None, translateX: Union[float, bool]=0.0, translateY:
Union[float, bool]=0.0, translateZ: Union[float, bool]=0.0, twist:
Union[float, bool]=0.0, worldSpace: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Extrude edges separately or together
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createCurve: (C) If true then the operation can create a curve
:param divisions: (C Q E) How many internal edges are creating when pulling Default: 1
:param gain: (C Q E M) Gain factor per component Can be painted using Artisan Default:
1.0
:param inputCurve: (C) This flag specifies the name of the curve to be used as input for
the operation
:param keepFacesTogether: (C Q E) How to extrude edges If "on", extruded faces produced
from the edges being extruded will be kept together Otherwise they are pulled
independently
:param localCenter: (C Q E) Local center on the edge : 0=Middle point, 1=Start point, 2=End
point Default: 0
:param localDirection: (C Q E) Direction to determine X axis for local space Default: 1.0,
0.0, 0.0
:param localDirectionX: (C Q E) X coord of the X axis
:param localDirectionY: (C Q E) Y coord of the X axis
:param localDirectionZ: (C Q E) Z coord of the X axis
:param localRotate: (C Q E) The local rotations Default: 0.0, 0.0, 0.0
:param localRotateX: (C Q E) Local rotate X coord The range is [0, 360]
:param localRotateY: (C Q E) Local rotate Y coord The range is [0, 360]
:param localRotateZ: (C Q E) Local rotate Z coord : Rotation along the normal The range is
[0, 360]
:param localScale: (C Q E) Local Scale Default: 1.0, 1.0, 1.0
:param localScaleX: (C Q E) Scale X coord
:param localScaleY: (C Q E) Scale Y coord
:param localScaleZ: (C Q E) Scale Z coord
:param localTranslate: (C Q E) Local translate Default: 0.0, 0.0, 0.0
:param localTranslateX: (C Q E) Local translation X coord
:param localTranslateY: (C Q E) Local translation Y coord
:param localTranslateZ: (C Q E) Local translation Z coord : Move along the normal
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param offset: (C Q E) Edges are moved this distance in the opposite direction of the edge
Default: 0.0
:param pivot: (C Q E) The pivot for scaling and rotation Default: 0.0, 0.0, 0.0
:param pivotX: (C Q E) Pivot X coord
:param pivotY: (C Q E) Pivot Y coord
:param pivotZ: (C Q E) Pivot Z coord
:param random: (C Q E) Random value for all parameters Default: 0.0
:param rotate: (C Q E) Rotation angles around X, Y, Z Default: 0.0, 0.0, 0.0
:param rotateX: (C Q E) Rotation angle around X
:param rotateY: (C Q E) Rotation angle around Y
:param rotateZ: (C Q E) Rotation angle around Z
:param scale: (C Q E) Scaling vector Default: 1.0, 1.0, 1.0
:param scaleX: (C Q E) Scale X coord
:param scaleY: (C Q E) Scale Y coord
:param scaleZ: (C Q E) Scale Z coord
:param smoothingAngle: (C Q E) Angle below which new edges will be smoothed Default:
kPi/6.0
:param taper: (C Q E) Taper or Scale along the extrusion path Default: 1.0
:param taperCurve_FloatValue: (C Q E) ?????
:param taperCurve_Interp: (C Q E) ????? Default: 0
:param taperCurve_Position: (C Q E) ?????
:param thickness: (C Q E) Edges are moved this distance in the direction of the connected
face normals Default: 0.0f
:param translate: (C Q E) Translation vector Default: 0.0, 0.0, 0.0
:param translateX: (C Q E) Translation X coord
:param translateY: (C Q E) Translation Y coord
:param translateZ: (C Q E) Translation Z coord
:param twist: (C Q E) Twist or Rotation along the extrusion path Default: 0.0
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def HypershadeSelectShadingGroupsAndMaterials(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyPoke(*args, caching: bool=True, constructionHistory: bool=True, localTranslate:
List[float, float, float]=None, localTranslateX: float=0.0, localTranslateY:
float=0.0, localTranslateZ: float=0.0, name: AnyStr="", nodeState: Union[int,
bool]=0, translate: List[float, float, float]=None, translateX: float=0.0,
translateY: float=0.0, translateZ: float=0.0, worldSpace: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Introduces a new vertex in the middle of the selected face, and connects it to the rest of
the vertices of the face
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param localTranslate: (C) Translate the new vertex in the local face coordinate
:param localTranslateX: (C) Translate the new vertex in the local face coordinate along X
:param localTranslateY: (C) Translate the new vertex in the local face coordinate along Y
:param localTranslateZ: (C) Translate the new vertex in the local face coordinate along Z
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param translate: (C) Translate the new vertex in the world space
:param translateX: (C) Translate the new vertex in the world space along X
:param translateY: (C) Translate the new vertex in the world space along Y
:param translateZ: (C) Translate the new vertex in the world space along Z
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name
"""
pass
def CreateNURBSCircle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutlinerToggleIgnoreUseColor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def listRelatives(*args, allDescendents: bool=True, allParents: bool=True, children: bool=True,
fullPath: bool=True, noIntermediate: bool=True, parent: bool=True, path:
bool=True, shapes: bool=True, type: Union[AnyStr, List[AnyStr]]="",
**kwargs)->List[AnyStr]:
"""
This command lists parents and children of DAG objects The flags -c/children,
-ad/allDescendents, -s/shapes, -p/parent and -ap/allParents are mutually exclusive Only
one can be used in a command When listing parents of objects directly under the world,
the command will return an empty parent list Listing parents of objects directly under a
sh
:param allDescendents: (C) Returns all the children, grand-children etc of this dag node
If a descendent is instanced, it will appear only once on the list returned Note tha
:param allParents: (C) Returns all the parents of this dag node Normally, this command
only returns the parent corresponding to the first instance of the object
:param children: (C) List all the children of this dag node (default)
:param fullPath: (C) Return full pathnames instead of object names
:param noIntermediate: (C) No intermediate objects
:param parent: (C) Returns the parent of this dag node
:param path: (C) Return a proper object name that can be passed to other commands
:param shapes: (C) List all the children of this dag node that are shapes (ie, not
transforms)
:param type: (C M) List all relatives of the specified type
:returns: Command result
"""
pass
def GeometryToBoundingBox(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ProfilerToolThreadView(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonPrism(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ResetWireOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def keyframeRegionInsertKeyCtx(*args, breakdown: bool=True, exists: bool=True, history:
bool=True, image1: Union[AnyStr, bool]="", image2: Union[AnyStr,
bool]="", image3: Union[AnyStr, bool]="", name: AnyStr="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command creates a context which may be used to insert keys within the keyframe region
of the dope sheet editor
:param breakdown: (Q E) Specifies whether or not to create breakdown keys
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Context name
"""
pass
def dR_coordSpaceObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dgControl(*args, **kwargs)->None:
"""
"""
pass
def HighQualityDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeRevertToDefaultTabs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowFur(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SubstituteGeometry(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphEditorDisableCurveSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetPlaceBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetGrabBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_activeHandleYZ(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def directionalLight(*args, decayRate: int=0, discRadius: Union[float, bool]=0.0, exclusive:
bool=True, intensity: Union[float, bool]=0.0, name: Union[AnyStr, bool]="",
position: Union[List[float, float, float], bool]=None, rgb:
Union[List[float, float, float], bool]=None, rotation: Union[List[float,
float, float], bool]=None, shadowColor: Union[List[float, float, float],
bool]=None, shadowDither: Union[float, bool]=0.0, shadowSamples: Union[int,
bool]=0, softShadow: bool=True, useRayTraceShadows: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[double], Any]:
"""
TlightCmd is the base class for other light commands TnonAmbientLightCmd is a class that
looks like a command but is not It is a base class for the extended/nonExtended lights
TnonExtendedLightCmd is a base class and not a real command It is inherited by several
lights: TpointLight, TdirectionalLight, TspotLight etc The directionalLight comman
:param decayRate: (C) Decay rate of the light (0-no decay, 1-slow, 2-realistic, 3-fast)
:param discRadius: (C Q) Radius of shadow disc
:param exclusive: (C Q) True if the light is exclusively assigned
:param intensity: (C Q) Intensity of the light
:param name: (C Q) Name of the light
:param position: (C Q) Position of the light
:param rgb: (C Q) RGB colour of the light
:param rotation: (C Q) Rotation of the light for orientation, where applicable
:param shadowColor: (C Q) Color of the light's shadow
:param shadowDither: (C Q) Shadow dithering value
:param shadowSamples: (C Q) Numbr of shadow samples to use
:param softShadow: (C Q) True if soft shadowing is to be enabled
:param useRayTraceShadows: (C Q) True if ray trace shadows are to be used
:returns: when querying the rgb or shadowColor flags
double when querying the intensity
flag
boolean when querying the useRayTraceShadows or exclusive flags
linear[] when querying
the position flag
angle[] when querying the rotation flag
string when querying the name
flag
"""
pass
def artUserPaintCtx(*args, accopacity: bool=False, activeListChangedProc: Union[AnyStr,
bool]="", afterStrokeCmd: Union[AnyStr, bool]="", alphaclamp: Union[AnyStr,
bool]="none", alphaclamplower: Union[float, bool]=0.0, alphaclampupper:
Union[float, bool]=1.0, attrSelected: Union[AnyStr, bool]="",
beforeStrokeCmd: Union[AnyStr, bool]="", brushalignment: bool=True,
brushfeedback: bool=True, chunkCommand: Union[AnyStr, bool]="", clamp:
Union[AnyStr, bool]="none", clamplower: Union[float, bool]=0.0, clampupper:
Union[float, bool]=1.0, clear: bool=True, colorAlphaValue: Union[float,
bool]=0.0, colorRGBAValue: Union[List[float, float, float, float],
bool]=None, colorRGBValue: Union[List[float, float, float], bool]=None,
colorRamp: Union[AnyStr, bool]="", colorfeedback: bool=False,
colorfeedbackOverride: bool=False, colorrangelower: Union[float, bool]=0.0,
colorrangeupper: Union[float, bool]=1.0, dataTypeIndex: Union[int, bool]=0,
disablelighting: bool=False, dragSlider: AnyStr="", duringStrokeCmd:
Union[AnyStr, bool]="", dynclonemode: bool=True, exists: bool=True,
expandfilename: bool=True, exportaspectratio: Union[float, bool]=0.0,
exportfilemode: Union[AnyStr, bool]="luminance/rgb", exportfilesave:
AnyStr="", exportfilesizex: Union[int, bool]=0, exportfilesizey: Union[int,
bool]=0, exportfiletype: Union[AnyStr, bool]="", filterNodes: bool=True,
finalizeCmd: Union[AnyStr, bool]="", fullpaths: bool=False,
getArrayAttrCommand: Union[AnyStr, bool]="", getSurfaceCommand:
Union[AnyStr, bool]="", getValueCommand: Union[AnyStr, bool]="", history:
bool=True, image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="",
image3: Union[AnyStr, bool]="", importfileload: AnyStr="", importfilemode:
Union[AnyStr, bool]="alpha", importreassign: bool=False, initializeCmd:
Union[AnyStr, bool]="", interactiveUpdate: bool=True, lastRecorderCmd:
Union[AnyStr, bool]="", lastStampName: Union[AnyStr, bool]="", lowerradius:
Union[float, bool]=0.0, makeStroke: Union[int, List[int], bool]=0,
mappressure: Union[AnyStr, bool]="none", maxvalue: Union[float, bool]=1.0,
minvalue: Union[float, bool]=0.0, name: AnyStr="", objattrArray:
Union[AnyStr, bool]="", opacity: Union[float, bool]=1.0, outline: bool=True,
outwhilepaint: bool=False, paintNodeArray: Union[AnyStr, bool]="",
paintattrselected: AnyStr="", paintmode: Union[AnyStr, bool]="screen",
paintoperationtype: Union[AnyStr, bool]="Paint", pickColor: bool=True,
pickValue: bool=True, playbackCursor: Union[List[float, float],
List[List[float, float]], bool]=None, playbackPressure: Union[float,
List[float], bool]=0.0, preserveclonesource: bool=True, profileShapeFile:
Union[AnyStr, bool]="", projective: bool=False, radius: Union[float,
bool]=1.0, rampMaxColor: Union[List[float, float, float], bool]=None,
rampMinColor: Union[List[float, float, float], bool]=None, record:
bool=True, reflection: bool=False, reflectionaboutorigin: bool=True,
reflectionaxis: Union[AnyStr, bool]="x", screenRadius: Union[float,
bool]=0.0, selectclonesource: bool=True, selectedattroper: Union[AnyStr,
bool]="absolute", setArrayValueCommand: Union[AnyStr, bool]="",
setValueCommand: Union[AnyStr, bool]="", showactive: bool=True, stampDepth:
Union[float, bool]=0.0, stampProfile: Union[AnyStr, bool]="", stampSpacing:
Union[float, bool]=1.0, strokesmooth: Union[AnyStr, bool]="",
surfaceConformedBrushVertices: bool=True, tablet: bool=True,
tangentOutline: bool=True, toolCleanupCmd: Union[AnyStr, bool]="",
toolOffProc: Union[AnyStr, bool]="", toolOnProc: Union[AnyStr, bool]="",
toolSetupCmd: Union[AnyStr, bool]="", useColorRamp: bool=True,
useMaxMinColor: bool=True, usepressure: bool=False, value: Union[float,
bool]=0.0, whichTool: Union[AnyStr, bool]="", worldRadius: Union[float,
bool]=0.0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This is a context command to set the flags on the artAttrContext, which is the base context
for attribute painting operations All commands require the name of the context as the last
argument as this provides the name of the context to create, edit or query This command
executes a scriptable paint (Maya Artisan) It allows the user to apply Mel
:param accopacity: (C Q E) Sets opacity accumulation on/off C: Default is false (Except
for sculpt tool for which it is true by default) Q: When queried, it returns a boolean
:param activeListChangedProc: (C Q E) Accepts a string that contains a MEL command that is
invoked whenever the active list changes There may be some situations where the UI, for
example
:param afterStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
after the end of a stroke C: Default is no command Q: When queried, it returns the curre
:param alphaclamp: (C Q E) Specifies if the weight value should be alpha clamped to the
lower and upper bounds There are four options here: "none" - no clamping is performed,
:param alphaclamplower: (C Q E) Specifies the lower bound for the alpha values C: Default
is 0.0 Q: When queried, it returns a float
:param alphaclampupper: (C Q E) Specifies the upper bound for the alpha values C: Default
is 1.0 Q: When queried, it returns a float
:param attrSelected: (Q) Returns a name of the currently selected attribute Q: When
queried, it returns a string
:param beforeStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
before the start of a stroke C: Default is no command Q: When queried, it returns the cu
:param brushalignment: (C Q E) Specifies the path brush alignemnt If true, the brush will
align to stroke path, otherwise it will align to up vector C: Default is true Q: When q
:param brushfeedback: (C Q E) Specifies if the brush additional feedback should be drawn
C: Default is TRUE Q: When queried, it returns a boolean
:param chunkCommand: (C Q E) Specifies th name of the Mel script/procedure that is called
once for every selected surface when a chunk is received on that surface Q: When querie
:param clamp: (C Q E) Specifies if the weight value should be clamped to the lower and
upper bounds There are four options here: "none" - no clamping is performed, "lower
:param clamplower: (C Q E) Specifies the lower bound for the values C: Default is 0.0 Q:
When queried, it returns a float
:param clampupper: (C Q E) Specifies the upper bound for the values C: Default is 1.0 Q:
When queried, it returns a float
:param clear: (C E) Floods all cvs/vertices to the current value
:param colorAlphaValue: (C Q E) The Alpha value of the color
:param colorRGBAValue: (C Q E) The RGBA value of the color
:param colorRGBValue: (C Q E) The RGB value of the color
:param colorRamp: (C Q E) Allows a user defined color ramp to be used to map values to
colors
:param colorfeedback: (C Q E) Sets on/off the color feedback display C: Default is FALSE
Q: When queried, it returns a boolean
:param colorfeedbackOverride: (C Q E) Sets on/off the color feedback override C: Default
is FALSE Q: When queried, it returns a boolean
:param colorrangelower: (C Q E) Specifies the value that maps to black when color feedback
mode is on C: Default is 0.0 Q: When queried, it returns a float
:param colorrangeupper: (C Q E) Specifies the value that maps to the maximum color when
color feedback mode is on C: Default is 1.0 Q: When queried, it returns a float
:param dataTypeIndex: (Q E) When the selected paintable attribute is a vectorArray, it
specifies which field to paint on
:param disablelighting: (C Q E) If color feedback is on, this flag determines whether
lighting is disabled or not for the surfaces that are affected C: Default is FALSE Q:
When qu
:param dragSlider: (C E) Sets the current brush drag state for resizing or offsetting the
brush (like the 'b' and 'm' default hotkeys) The string argument is one of: "radius
:param duringStrokeCmd: (C Q E) The passed string is executed as a MEL command during the
stroke, each time the mouse is dragged C: Default is no command Q: When queried, it
retur
:param dynclonemode: (C Q E) Enable or disable dynamic clone mode
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param expandfilename: (C E) If true, it will expand the name of the export file and
concatenate it with the surface name Otherwise it will take the name as it is C: Default
is
:param exportaspectratio: (C Q E) Value of aspect ratio for export
:param exportfilemode: (C Q E) Specifies the export channel.The valid entries here are:
"alpha", "luminance", "rgb", "rgba" C: Default is "luminance/rgb" Q: When queried, it
retu
:param exportfilesave: (E) Exports the attribute map and saves to a specified file
:param exportfilesizex: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfilesizey: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfiletype: (C Q E) Specifies the image file format It can be one of the
following: "iff", "tiff", "jpeg", "alias", "rgb", "fit" "postScriptEPS", "softimage",
"wavefron
:param filterNodes: (E) Sets the node filter
:param finalizeCmd: (C Q E) Specifies the name of the Mel script/procedure that is called
at the end of each stroke Q: When queried, it returns a string
:param fullpaths: (C Q E) Specifies whether full path names should be used when surface
names are passed to scripts If false, just the surface name is passed C: Default is f
:param getArrayAttrCommand: (C Q E) Specifies the name of the Mel script/procedure that is
called once for every surface that is selected for painting This procedure returns a
string,
:param getSurfaceCommand: (C Q E) Specifies the name of the Mel script/procedure that is
called once for every dependency node on the selection list, whenever Artisan processes the
se
:param getValueCommand: (C Q E) Specifies the name of the Mel script/procedure that is
called every time a value on the surface is needed by the scriptable paint tool Q: When
queri
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param importfileload: (E) Load the attribute map a specified file
:param importfilemode: (C Q E) Specifies the channel to import The valid entries here are:
"alpha", "luminance", "red", "green", "blue", and "rgb" C: Default is "alpha" Q: When q
:param importreassign: (C Q E) Specifies if the multiply atrribute maps are to be
reassigned while importing Only maps previously exported from within Artisan can be
reassigned C
:param initializeCmd: (C Q E) Specifies the name of the Mel script/procedure that is called
in the beginning of each stroke Q: When queried, it returns a string
:param interactiveUpdate: (C Q E) Specifies how often to transfer the painted values into
the attribute TRUE: transfer them "continuously" (many times per stroke) FALSE: transfer
the
:param lastRecorderCmd: (C Q E) Value of last recorded command
:param lastStampName: (C Q E) Value of the last stamp name
:param lowerradius: (C Q E) Sets the lower size of the brush (only apply on tablet)
:param makeStroke: (C Q E M) Stroke point values
:param mappressure: (C Q E) Sets the tablet pressure mapping when the table is used There
are four options: "none" - the pressure has no effect, "opacity" - the pressure is map
:param maxvalue: (C Q E) Specifies the maximum value for each attribute C: Default is 1.0
Q: When queried, it returns a float
:param minvalue: (C Q E) Specifies the minimum value for each attribute C: Default is 0.0
Q: When queried, it returns a float
:param name: (C) If this is a tool command, name the tool appropriately
:param objattrArray: (Q) An array of all paintable attributes Each element of the array is
a string with the following information: NodeType.NodeName.AttributeName.MenuType
:param opacity: (C Q E) Sets the brush opacity C: Default is 1.0 Q: When queried, it
returns a float
:param outline: (C Q E) Specifies if the brush should be drawn C: Default is TRUE Q: When
queried, it returns a boolean
:param outwhilepaint: (C Q E) Specifies if the brush outline should be drawn while painting
C: Default is FALSE Q: When queried, it returns a boolean
:param paintNodeArray: (Q) An array of paintable nodes Q: When queried, it returns a
string
:param paintattrselected: (E) An array of selected paintable attributes Each element of
the array is a string with the following information: NodeType.NodeName.AttributeName
:param paintmode: (C Q E) Specifies the paint mode There are two possibilities: "screen"
and "tangent" C: Default is "screen" Q: When queried, it returns a string
:param paintoperationtype: (C Q E) Specifies the operation type used by the Paint Tool
Currently, we support the following paint modes: "Paint", "Smear", "Blur", "Erase" and
"Clone"
:param pickColor: (C Q E) Set pick color mode on or off
:param pickValue: (C Q E) Toggle for picking
:param playbackCursor: (C Q E M) Values for the playback cursor
:param playbackPressure: (C Q E M) Valus for the playback pressure
:param preserveclonesource: (C Q E) Whether or not to preserve a clone source
:param profileShapeFile: (Q E) Passes a name of the image file for the stamp shape profile
:param projective: (C Q E) Specifies the projective paint mode C: Default is 'false' Q:
When queried, it returns a boolean
:param radius: (C Q E) Sets the size of the brush C: Default is 1.0 cm Q: When queried,
it returns a float
:param rampMaxColor: (C Q E) Defines a special color to be used when the value is greater
than or equal to the maximum value
:param rampMinColor: (C Q E) Defines a special color to be used when the value is less than
or equal to the minimum value
:param record: (C Q E) Toggle on for recording
:param reflection: (C Q E) Specifies the reflection mode C: Default is 'false' Q: When
queried, it returns a boolean
:param reflectionaboutorigin: (C Q E) Toggle on to reflect about the origin
:param reflectionaxis: (C Q E) Specifies the reflection axis There are three
possibilities: "x", "y" and "z" C: Default is "x" Q: When queried, it returns a string
:param screenRadius: (C Q E) Brush radius on the screen
:param selectclonesource: (C Q E) Toggle on to select the clone source
:param selectedattroper: (C Q E) Sets the edit weight operation Four edit weights
operations are provided : "absolute" - the value of the weight is replaced by the current
one, "add
:param setArrayValueCommand: (C Q E) Specifies the name of the Mel script/procedure that is
called for each paint stamp A stamp may affect one or more values on the surface This
call r
:param setValueCommand: (C Q E) Specifies the name of the Mel script/procedure that is
called every time a value on the surface is changed Q: When queried, it returns a string
:param showactive: (C Q E) Sets on/off the display of the surface isoparms C: Default is
TRUE Q: When queried, it returns a boolean
:param stampDepth: (C Q E) Depth of the stamps
:param stampProfile: (C Q E) Sets the brush profile of the current stamp Currently, the
following profiles are supported: "gaussian", "poly", "solid" and "square" C: Default is
:param stampSpacing: (C Q E) Specifies the stamp spacing Default is 1.0
:param strokesmooth: (C Q E) Stroke smoothing type name
:param surfaceConformedBrushVertices: (C Q E) Enables/disables the the display of the
effective brush area as affected vertices
:param tablet: (Q) Returns true if the tablet device is present, false if it is absent
:param tangentOutline: (C Q E) Enables/disables the display of the brush circle tangent to
the surface
:param toolCleanupCmd: (C Q E) Specifies the name of the Mel script/procedure that is
called when this tool is exited Q: When queried, it returns a string
:param toolOffProc: (C Q E) Accepts a strings describing the name of a MEL procedure that
is invoked whenever the tool is turned off For example, cloth invokes "clothPaintToolO
:param toolOnProc: (C Q E) Accepts a strings describing the name of a MEL procedure that is
invoked whenever the tool is turned on For example, cloth invokes "clothPaintToolOn
:param toolSetupCmd: (C Q E) Specifies the name of the Mel script/procedure that is called
once for every selected surface when an initial click is received on that surface Q: W
:param useColorRamp: (C Q E) Specifies whether the user defined color ramp should be used
to map values from to colors If this is turned off, the default greyscale feedback will
:param useMaxMinColor: (C Q E) Specifies whether the out of range colors should be used
See rampMinColor and rampMaxColor flags for further details
:param usepressure: (C Q E) Sets the tablet pressure on/off C: Default is false Q: When
queried, it returns a boolean
:param value: (C Q E) Specifies the value for each attribute C: Default is 0.0 Q: When
queried, it returns a float
:param whichTool: (C Q E) The string defines the name of the tool to be used for the
Artisan context An example is "artClothPaint" In query mode, the tool name for the given
:param worldRadius: (C Q E) Radius in worldspace
:returns: The name of the context created.
"""
pass
def CreateCameraFromView(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def mirrorJoint(*args, mirrorBehavior: bool=True, mirrorXY: bool=True, mirrorXZ: bool=True,
mirrorYZ: bool=True, searchReplace: List[AnyStr, AnyStr]=None,
**kwargs)->List[AnyStr]:
"""
This command will duplicate a branch of the skeleton from the selected joint symmetrically
about a plane in world space There are three mirroring modes(xy-, yz-, xz-plane)
:param mirrorBehavior: (C) The mirrorBehavior flag is used to specify that when performing
the mirror, the joint orientation axes should be mirrored such that equal rotations o
:param mirrorXY: (C) mirror skeleton from the selected joint about xy-plane in world space
:param mirrorXZ: (C) mirror skeleton from the selected joint about xz-plane in world space
:param mirrorYZ: (C) mirror skeleton from the selected joint about yz-plane in world space
:param searchReplace: (C) After performing the mirror, rename the new joints by searching
the name for the first specified string and replacing it with the second specified st
:returns: Names of the mirrored joints
"""
pass
def ParentConstraint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def colorSliderGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0, adjustableColumn3:
int=0, adjustableColumn4: int=0, adjustableColumn5: int=0,
adjustableColumn6: int=0, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, changeCommand:
Script=None, columnAlign: Union[List[int, AnyStr], List[List[int,
AnyStr]]]=None, columnAlign2: List[AnyStr, AnyStr]=None, columnAlign3:
List[AnyStr, AnyStr, AnyStr]=None, columnAlign4: List[AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAlign5: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAlign6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach: Union[List[int, AnyStr, int], List[List[int,
AnyStr, int]]]=None, columnAttach2: List[AnyStr, AnyStr]=None,
columnAttach3: List[AnyStr, AnyStr, AnyStr]=None, columnAttach4: List[AnyStr,
AnyStr, AnyStr, AnyStr]=None, columnAttach5: List[AnyStr, AnyStr, AnyStr,
AnyStr, AnyStr]=None, columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr, AnyStr]=None, columnOffset2: List[int, int]=None, columnOffset3:
List[int, int, int]=None, columnOffset4: List[int, int, int, int]=None,
columnOffset5: List[int, int, int, int, int]=None, columnOffset6: List[int,
int, int, int, int, int]=None, columnWidth: Union[List[int, int],
List[List[int, int]]]=None, columnWidth1: int=0, columnWidth2: List[int,
int]=None, columnWidth3: List[int, int, int]=None, columnWidth4: List[int,
int, int, int]=None, columnWidth5: List[int, int, int, int, int]=None,
columnWidth6: List[int, int, int, int, int, int]=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dragCommand: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists:
bool=True, forceDragRefresh: bool=True, fullPathName: bool=True, height:
Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, hsvValue: Union[List[float, float, float], bool]=None,
isObscured: bool=True, label: Union[AnyStr, bool]="", manage: bool=True,
noBackground: bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True, rgbValue:
Union[List[float, float, float], bool]=None, rowAttach: Union[List[int,
AnyStr, int], List[List[int, AnyStr, int]]]=None, statusBarMessage:
AnyStr="", useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command string executed when slider value changes
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command string executed when slider value marker is dragged
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param forceDragRefresh: (C Q E) If used then force refresh on drag
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param hsvValue: (C Q E) Color in hue, saturation, and value format
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) Label text for the group
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rgbValue: (C Q E) Color in red, green, and blue format
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def renderSettings(*args, camera: AnyStr="", customTokenString: AnyStr="", firstImageName:
bool=True, fullPath: bool=True, fullPathTemp: bool=True,
genericFrameImageName: AnyStr="", imageGenericName: bool=True,
lastImageName: bool=True, layer: AnyStr="", leaveUnmatchedTokens: bool=True,
**kwargs)->List[AnyStr]:
"""
Query interface to the common tab of the render settings
:param camera: (C) Specify a camera that you want to replace the current renderable camera
:param customTokenString: (C) Specify a custom key-value string to use to replace custom
tokens in the file name Use with firstImageName or lastImageName Basic tokens (Scene, La
:param firstImageName: (C) Returns the first image name
:param fullPath: (C) Returns the full path for the image using the current project Use
with firstImageName, lastImageName, or genericFrameImageName
:param fullPathTemp: (C) Returns the full path for the preview render of the image using
the current project Use with firstImageName, lastImageName, or genericFrameImageName
:param genericFrameImageName: (C) Returns the generic frame image name with the custom
specified frame index token
:param imageGenericName: (C) Returns the image generic name
:param lastImageName: (C) Returns the last image name
:param layer: (C) Specify a render layer name that you want to replace the current render
layer
:param leaveUnmatchedTokens: (C) Do not remove unmatched tokens from the name string Use
with firstImageName or lastImageName
:returns: Command result
"""
pass
def DisableFluids(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateNURBSCylinder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleScalePivots(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def recordAttr(*args, attribute: Union[AnyStr, List[AnyStr]]="", delete: bool=True, q=True,
query=True, **kwargs)->Union[None, Any]:
"""
This command sets up an attribute to be recorded When the record command is executed, any
changes to this attribute are recorded When recording stops these changes are turned into
keyframes If no attributes are specified all attributes of the node are recorded When
the query flag is used, a list of the attributes being recorded will be return
:param attribute: (C M) specify the attribute to record
:param delete: (C) Do not record the specified attributes
:returns:
"""
pass
def MoveSkinJointsTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleVertices(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVOrientShells(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportSplitAnimationIntoTakes(*args, **kwargs)->None:
"""
"""
pass
def CreateBifrostLiquid(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UseSelectedEmitter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def addAttr(*args, attributeType: Union[AnyStr, bool]="", binaryTag: Union[AnyStr, bool]="",
cachedInternally: bool=True, category: Union[AnyStr, List[AnyStr], bool]="",
dataType: Union[AnyStr, List[AnyStr], bool]="", defaultValue: Union[float,
bool]=0.0, disconnectBehaviour: Union[int, bool]=0, enumName: Union[AnyStr,
bool]="", exists: bool=True, fromPlugin: bool=True, hasMaxValue: bool=True,
hasMinValue: bool=True, hasSoftMaxValue: bool=True, hasSoftMinValue: bool=True,
hidden: bool=True, indexMatters: bool=True, internalSet: bool=True, keyable:
bool=True, longName: Union[AnyStr, bool]="", maxValue: Union[float, bool]=0.0,
minValue: Union[float, bool]=0.0, multi: bool=True, niceName: Union[AnyStr,
bool]="", numberOfChildren: Union[int, bool]=0, parent: Union[AnyStr, bool]="",
proxy: Union[AnyStr, bool]="", readable: bool=True, shortName: Union[AnyStr,
bool]="", softMaxValue: Union[float, bool]=0.0, softMinValue: Union[float,
bool]=0.0, storable: bool=True, usedAsColor: bool=True, usedAsFilename: bool=True,
usedAsProxy: bool=True, writable: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This command is used to add a dynamic attribute to a node or nodes Either the longName or
the shortName or both must be specified If neither a dataType nor an attributeType is
specified, a double attribute will be added The dataType flag can be specified more than
once indicating that any of the supplied types will be accepted (logical-or) To
:param attributeType: (C Q) Specifies the attribute type, see above table for more details
Note that the attribute types "float", "matrix" and "string" are also MEL keywords an
:param binaryTag: (C Q) This flag is obsolete and does not do anything any more
:param cachedInternally: (C Q) Whether or not attribute data is cached internally in the
node This flag defaults to true for writable attributes and false for non-writable
attribu
:param category: (C Q E M) An attribute category is a string associated with the attribute
to identify it (e.g the name of a plugin that created the attribute, version inform
:param dataType: (C Q M) Specifies the data type See "setAttr" for more information on
data type names
:param defaultValue: (C Q E) Specifies the default value for the attribute (can only be
used for numeric attributes)
:param disconnectBehaviour: (C Q) defines the Disconnect Behaviour 2 Nothing, 1 Reset, 0
Delete
:param enumName: (C Q E) Flag used to specify the ui names corresponding to the enum values
The specified string should contain a colon-separated list of the names, with opt
:param exists: (C Q) Returns true if the attribute queried is a user-added, dynamic
attribute; false if not
:param fromPlugin: (C Q) Was the attribute originally created by a plugin? Normally set
automatically when the API call is made - only added here to support storing it in a f
:param hasMaxValue: (C Q E) Flag indicating whether an attribute has a maximum value (can
only be used for numeric attributes)
:param hasMinValue: (C Q E) Flag indicating whether an attribute has a minimum value (can
only be used for numeric attributes)
:param hasSoftMaxValue: (C Q) Flag indicating whether a numeric attribute has a soft
maximum
:param hasSoftMinValue: (C Q) Flag indicating whether a numeric attribute has a soft
minimum
:param hidden: (C Q) Will this attribute be hidden from the UI?
:param indexMatters: (C Q) Sets whether an index must be used when connecting to this
multi-attribute Setting indexMatters to false forces the attribute to non-readable
:param internalSet: (C Q) Whether or not the internal cached value is set when this
attribute value is changed This is an internal flag used for updating UI elements
:param keyable: (C Q) Is the attribute keyable by default?
:param longName: (C Q) Sets the long name of the attribute
:param maxValue: (C Q E) Specifies the maximum value for the attribute (can only be used
for numeric attributes)
:param minValue: (C Q E) Specifies the minimum value for the attribute (can only be used
for numeric attributes)
:param multi: (C Q) Makes the new attribute a multi-attribute
:param niceName: (C Q E) Sets the nice name of the attribute for display in the UI Setting
the attribute's nice name to a non-empty string overrides the default behaviour of
:param numberOfChildren: (C Q) How many children will the new attribute have?
:param parent: (C Q) Attribute that is to be the new attribute's parent
:param proxy: (C Q) Proxy another node's attribute Proxied plug will be connected as
source The UsedAsProxy flag is automatically set in this case
:param readable: (C Q) Can outgoing connections be made from this attribute?
:param shortName: (C Q) Sets the short name of the attribute
:param softMaxValue: (C Q E) Soft maximum, valid for numeric attributes only Specifies the
upper default limit used in sliders for this attribute
:param softMinValue: (C Q E) Soft minimum, valid for numeric attributes only Specifies the
upper default limit used in sliders for this attribute
:param storable: (C Q) Can the attribute be stored out to a file?
:param usedAsColor: (C Q) Is the attribute to be used as a color definition? Must have 3
DOUBLE or 3 FLOAT children to use this flag The attribute type "-at" should be "doubl
:param usedAsFilename: (C Q) Is the attribute to be treated as a filename definition? This
flag is only supported on attributes with data type "-dt" of "string"
:param usedAsProxy: (C Q) Set if the specified attribute should be treated as a proxy to
another attributes
:param writable: (C Q) Can incoming connections be made to this attribute?
:returns:
"""
pass
def CurlCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetFullBodyIKKeys(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dbtrace(*args, filter: Union[AnyStr, bool]="", info: bool=True, keyword: Union[AnyStr,
List[AnyStr], bool]="", mark: bool=True, output: Union[AnyStr, bool]="", timed:
bool=True, title: AnyStr="", verbose: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
The dbtrace command is used to manipulate trace objects The keyword is the only mandatory
argument, indicating which trace object is to be altered Trace Objects to affect (keyword
KEY) Optional filtering criteria (filter FILTER) Function (off, output FILE, mark, title
TITLE, timed : default operation is to enable traces) You can use the query m
:param filter: (C Q) Set the filter object for these trace objects (see 'dgfilter')
:param info: (Q) In query mode return a brief description of the trace object
:param keyword: (C Q M) Keyword of the trace objects to affect In query mode, this flag can
accept a value
:param mark: (C) Display a mark for all outputs of defined trace objects
:param output: (C Q) Destination file of the affected trace objects Use the special names
stdout and stderr to redirect to your command window The special name msdev is
:param timed: (C Q) Turn on/off timing information in the output of the specified trace
objects
:param title: (C) Display a title mark for all outputs of defined trace objects
:param verbose: (C) Include all traces in output and filter queries, not just those turned
on
:returns:
"""
pass
def expressionEditorListen(*args, listenFile: AnyStr="", listenForAttr: AnyStr="",
listenForExpression: AnyStr="", listenForName: AnyStr="",
stopListenForAttr: AnyStr="", stopListenForExpression: AnyStr="",
stopListenForName: AnyStr="", **kwargs)->None:
"""
Listens for messages for the Expression Editor, at its request, and communicates them to it
This action is for internal use only and should not be called by users This action should
be called only by the Expression Editor
:param listenFile: (C) Listen for changes to the file argument
:param listenForAttr: (C) Listen for changes to the attributes of the node argument
:param listenForExpression: (C) Listen for changes to the named expression
:param listenForName: (C) Listen for name changes for the node argument
:param stopListenForAttr: (C) Stop listening for changes to the attributes of the node
argument
:param stopListenForExpression: (C) Stop listening for changes to the named expression
:param stopListenForName: (C) Stop listening for name changes for the node argument
:returns:
"""
pass
def xgmPointRender(*args, **kwargs)->None:
"""
"""
pass
def ProfilerToolCategoryView(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artBuildPaintMenu(*args, **kwargs)->None:
"""
??
:returns:
"""
pass
def sbs_GetChannelsNamesFromSubstanceNode(*args, **kwargs)->None:
"""
"""
pass
def particle(*args, attribute: Union[AnyStr, bool]="", cache: bool=True, conserve: Union[float,
bool]=0.0, count: bool=True, deleteCache: bool=True, dynamicAttrList: bool=True,
floatValue: float=0.0, gridSpacing: Union[float, List[float], bool]=0.0, inherit:
Union[float, bool]=0.0, jitterBasePoint: Union[List[float, float, float],
List[List[float, float, float]], bool]=None, jitterRadius: Union[float,
List[float], bool]=0.0, lowerLeft: Union[List[float, float, float],
List[List[float, float, float]], bool]=None, name: Union[AnyStr, bool]="",
numJitters: Union[int, List[int], bool]=0, order: Union[int, bool]=0, particleId:
Union[int, bool]=0, perParticleDouble: bool=True, perParticleVector: bool=True,
position: Union[List[float, float, float], List[List[float, float, float]]]=None,
shapeName: Union[AnyStr, bool]="", upperRight: Union[List[float, float, float],
List[List[float, float, float]], bool]=None, vectorValue: List[float, float,
float]=None, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The particle command creates a new particle object from a list of world space points If a
particle object is created, the command returns the names of the new particle shape and its
associated particle object dependency node If an object was queried, the results of the
query are returned Per particle attributes can be queried using the particleI
:param attribute: (Q E) Used in per particle attribute query and edit Specifies the name
of the attribute being queried or edited In query mode, this flag needs a value
:param cache: (C Q E) Turns caching on/off for the particle shape
:param conserve: (Q E) Conservation of momentum control (between 0 and 1) Specifies the
fraction of the particle shape's existing momentum which is conserved from frame to
:param count: (Q) Returns the number of particles in the object
:param deleteCache: (C) Deletes the particle shapes cache This command is not undoable
:param dynamicAttrList: (Q) Returns a list of the dynamic attributes in the object
:param floatValue: (E) Used only in per particle attribute edit Specifies that the edit is
of a float attribute and must be followed by the new float value
:param gridSpacing: (C Q M) Spacing between particles in the grid
:param inherit: (Q E) Inherit this fraction (0-1) of emitting object's velocity
:param jitterBasePoint: (C Q M) Base point (center point) for jitters The command will
create one swatch of jitters for each base point It will pair up other flags with base
point
:param jitterRadius: (C Q M) Max radius from the center to place the particle instances
:param lowerLeft: (C Q M) Lower left point of grid
:param name: (Q E) name of particle object
:param numJitters: (C Q M) Number of jitters (instances) per particle
:param order: (Q E) Used in per particle attribute query and edit Specifies the zero-based
order (index) of the particle whose attribute is being queried or edited in t
:param particleId: (Q E) Used in per particle attribute query and edit Specifies the id of
the particle whose attribute is being queried or edited Querying the value of a p
:param perParticleDouble: (Q) Returns a list of the per-particle double attributes,
excluding initial-state, cache, and information-only attributes
:param perParticleVector: (Q) Returns a list of the per-particle vector attributes,
excluding initial-state, cache, and information-only attributes
:param position: (M) World-space position of each particle
:param shapeName: (Q E) Specify the shape name used for geometry instancing DO not confuse
this with the -n flag which names the particle object
:param upperRight: (C Q M) Upper right point of grid
:param vectorValue: (E) Used only in per particle attribute edit Specifies that the edit
is of a vector attribute and must be followed by all three float values for the vec
:returns: The name of the particle object created
"""
pass
def CreateLocator(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateBindingSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FlowPathObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def plane(*args, length: float=0.0, name: AnyStr="", position: List[float, float, float]=None,
rotation: List[float, float, float]=None, size: float=0.0, width: float=0.0,
**kwargs)->AnyStr:
"""
The command creates a sketch plane (also known as a "construction plane") in space To
create an object (such as a NURBS curve, joint chain or polygon) on a construction plane,
you need to first make the plane live See also the makeLive command
:param length: (C) The length of plane "linear" means that this flag can handle values
with units
:param name: (C) Name the resulting object
:param position: (C) 3D position where the centre of the plane is positioned "linear"
means that this flag can handle values with units
:param rotation: (C) The rotation of plane "angle" means that this flag can handle values
with units
:param size: (C) The combined size (size x size) of plane "linear" means that this flag
can handle values with units
:param width: (C) The width of plane "linear" means that this flag can handle values with
units
:returns: (name of the new plane)
"""
pass
def meshRemapContext(*args, **kwargs)->None:
"""
"""
pass
def DeleteAllLattices(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ogsdebug(*args, **kwargs)->None:
"""
"""
pass
def IncreaseExposureFine(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphEditorEnableCurveSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nexQuadDrawCtx(*args, **kwargs)->None:
"""
"""
pass
def PoleVectorConstraint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetActiveKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModifyConstraintAxis(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ComponentEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UnpublishChildAnchor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SnapToMeshCenter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GeometryToBoundingBoxOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorShowAllAttrs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BreakRigidBodyConnection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def picture(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float, float,
float], bool]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, image: Union[AnyStr, bool]="",
isObscured: bool=True, manage: bool=True, noBackground: bool=True,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="", popupMenuArray:
bool=True, preventOverride: bool=True, statusBarMessage: AnyStr="", tile: bool=True,
useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a static image
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param image: (C Q E) Sets the image given the .xpm file name
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param tile: (C Q E) If true, the picture is tiled to fill the picture area False by
default (Windows only flag)
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the picture control created.
"""
pass
def SelectAllNRigids(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def windowPref(*args, enableAll: bool=True, exists: bool=True, height: Union[int, bool]=0,
leftEdge: Union[int, bool]=0, loadAll: bool=True, maximized: bool=True,
parentMain: bool=True, remove: bool=True, removeAll: bool=True,
restoreMainWindowState: AnyStr="", saveAll: bool=True, saveMainWindowState:
AnyStr="", topEdge: Union[int, bool]=0, topLeftCorner: Union[List[int, int],
bool]=None, width: Union[int, bool]=0, widthHeight: Union[List[int, int],
bool]=None, q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Create or modify preferred window attributes The size and position of a window is retained
during and between application sessions A default window preference is created when a
window is closed Window preferences must be named and, consequently, only affect the
window with a matching name Note that window preferences are not applied to the mai
:param enableAll: (C Q) Enable/disable all window preferences Preferences are enabled by
default Set this flag to false and window's will ignore all preference values
:param exists: (C) Returns true|false depending upon whether the specified object exists
Other flags are ignored
:param height: (C Q E) Height of the window
:param leftEdge: (C Q E) Left edge position of the window
:param loadAll: (C) Reads in file with window attributes from disk
:param maximized: (C Q E) Maximize the window
:param parentMain: (C Q) Set whether window is parented to main application window Windows
only
:param remove: (C) Remove a window preference
:param removeAll: (C) Remove all window preferences
:param restoreMainWindowState: (C) Reads in file with main window state (positions of
toolbars and dock controls)
:param saveAll: (C) Writes out file with window attributes
:param saveMainWindowState: (C) Writes out file with main window state (positions of
toolbars and dock controls)
:param topEdge: (C Q E) Top edge position of the window
:param topLeftCorner: (C Q E) Top and left edge position of the window
:param width: (C Q E) Width of the window
:param widthHeight: (C Q E) Width and height of the window
:returns:
"""
pass
def dR_selConstraintEdgeRing(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def editRenderLayerAdjustment(*args, attributeLog: bool=True, layer: Union[name, bool]=None,
nodeLog: bool=True, remove: bool=True, q=True, query=True,
**kwargs)->Union[int, Any]:
"""
This command is used to create, edit, and query adjustments to render layers An adjustment
allows different attribute values or connections to be used depending on the active render
layer
:param attributeLog: (Q) Output all adjustments for the specified layer sorted by attribute
name
:param layer: (C Q) Specified layer in which the adjustments will be modified If not
specified the active render layer will be used
:param nodeLog: (Q) Output all adjustments for the specified layer sorted by node name
:param remove: (C) Remove the specified adjustments from the render layer If an adjustment
is removed from the current layer, the specified plug will revert back to it
:returns: Number of adjustments applied
"""
pass
def RemoveFromContainer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmRebuildSplineDescription(*args, **kwargs)->None:
"""
"""
pass
def refresh(*args, currentView: bool=True, fileExtension: AnyStr="", filename: AnyStr="",
force: bool=True, suspend: bool=True, **kwargs)->None:
"""
This command is used to force a redraw during script execution Normally, redraw is
suspended while scripts are executing but sometimes it is useful to show intermediate
results for purposes such as capturing images from the screen If the -cv flag is
specified, then only the current active view is redrawn
:param currentView: (C) Redraw only the current view (default redraws all views)
:param fileExtension: (C) Specify the type of file to save using the filename flag
:param filename: (C) Specify the name of a file in which to save a snapshot of the
viewports, or just the current one if the currentView flag is set
:param force: (C) Force the refresh regardless of the state of the model
:param suspend: (C) Suspends or resumes Maya's handling of refresh events Specify "on" to
suspend refreshing, and "off" to resume refreshing Note that resuming refresh
:returns:
"""
pass
def DisplayLayerEditorWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolygonCollapseEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def optionMenuGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0, adjustableColumn3:
int=0, adjustableColumn4: int=0, adjustableColumn5: int=0, adjustableColumn6:
int=0, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, columnAlign:
Union[List[int, AnyStr], List[List[int, AnyStr]]]=None, columnAlign2:
List[AnyStr, AnyStr]=None, columnAlign3: List[AnyStr, AnyStr, AnyStr]=None,
columnAlign4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign5:
List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign6: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach: Union[List[int,
AnyStr, int], List[List[int, AnyStr, int]]]=None, columnAttach2: List[AnyStr,
AnyStr]=None, columnAttach3: List[AnyStr, AnyStr, AnyStr]=None,
columnAttach4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach5:
List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach6: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnOffset2: List[int,
int]=None, columnOffset3: List[int, int, int]=None, columnOffset4: List[int,
int, int, int]=None, columnOffset5: List[int, int, int, int, int]=None,
columnOffset6: List[int, int, int, int, int, int]=None, columnWidth:
Union[List[int, int], List[List[int, int]]]=None, columnWidth1: int=0,
columnWidth2: List[int, int]=None, columnWidth3: List[int, int, int]=None,
columnWidth4: List[int, int, int, int]=None, columnWidth5: List[int, int, int,
int, int]=None, columnWidth6: List[int, int, int, int, int, int]=None,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, extraLabel:
Union[AnyStr, bool]="", fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, itemListLong: bool=True, itemListShort: bool=True, label:
Union[AnyStr, bool]="", manage: bool=True, noBackground: bool=True,
numberOfItems: bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True, rowAttach:
Union[List[int, AnyStr, int], List[List[int, AnyStr, int]]]=None, select:
Union[int, bool]=0, statusBarMessage: AnyStr="", useTemplate: AnyStr="",
value: Union[AnyStr, bool]="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when a new item is selected
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param extraLabel: (C Q E) If present on creation this specifies that there will be an
extra label to the right of the option menu Sets the string to be the extra label text
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param itemListLong: (Q) Returns the long names of the items
:param itemListShort: (Q) Returns the short names of the items
:param label: (C Q E) If present on creation this specifies that there will be a label to
the left of the option menu Sets the string to be the label text
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfItems: (Q) Returns the number of items
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param select: (C Q E) Selects an item by index The first item is 1
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Select an item by value Also, returns the text of the currently
selected item
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The full name of the control on creation.
"""
pass
def polyUnite(*args, caching: bool=True, mergeUVSets: int=1, nodeState: Union[int, bool]=0,
centerPivot: bool=True, objectPivot: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command creates a new poly as an union of a list of polys If no objects are specified
in the command line, then the objects from the active list are used
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param mergeUVSets: (C) Specify how UV sets will be merged on the output mesh The choices
are 0 | 1 | 2 0 = Do not merge Each UV set on each mesh will become a new UV set
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param centerPivot: (C) Set the resulting object's pivot to the center of the selected
objects bounding box
:param objectPivot: (C) Set the resulting object's pivot to last selected object's pivot
:returns: Object name and node name.
"""
pass
def SubdivSmoothnessRough(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def animCurveEditor(*args, areCurvesSelected: bool=True, autoFit: Union[AnyStr, bool]="",
autoFitTime: Union[AnyStr, bool]="", classicMode: bool=True, clipTime:
Union[AnyStr, bool]="", constrainDrag: Union[int, bool]=0, control:
bool=True, curvesShown: bool=True, curvesShownForceUpdate: bool=True,
defineTemplate: AnyStr="", denormalizeCurvesCommand: AnyStr="",
displayActiveKeyTangents: AnyStr="", displayActiveKeys: AnyStr="",
displayInfinities: AnyStr="", displayKeys: AnyStr="", displayNormalized:
bool=True, displayTangents: AnyStr="", displayValues: AnyStr="", docTag:
Union[AnyStr, bool]="", exists: bool=True, filter: Union[AnyStr, bool]="",
forceMainConnection: Union[AnyStr, bool]="", highlightConnection:
Union[AnyStr, bool]="", keyingTime: Union[AnyStr, bool]="",
lockMainConnection: bool=True, lookAt: AnyStr="", mainListConnection:
Union[AnyStr, bool]="", menu: Script=None, normalizeCurvesCommand:
AnyStr="", outliner: Union[AnyStr, bool]="", panel: Union[AnyStr, bool]="",
parent: Union[AnyStr, bool]="", preSelectionHighlight: bool=True,
renormalizeCurves: bool=True, resultSamples: Union[time, bool]=None,
resultScreenSamples: Union[int, bool]=0, resultUpdate: Union[AnyStr,
bool]="", selectionConnection: Union[AnyStr, bool]="",
showActiveCurveNames: bool=True, showBufferCurves: Union[AnyStr, bool]="",
showCurveNames: bool=True, showResults: Union[AnyStr, bool]="",
showUpstreamCurves: bool=True, smoothness: Union[AnyStr, bool]="",
snapTime: Union[AnyStr, bool]="", snapValue: Union[AnyStr, bool]="",
stackedCurves: bool=True, stackedCurvesMax: Union[float, bool]=0.0,
stackedCurvesMin: Union[float, bool]=0.0, stackedCurvesSpace: Union[float,
bool]=0.0, stateString: bool=True, unParent: bool=True,
unlockMainConnection: bool=True, updateMainConnection: bool=True,
useTemplate: AnyStr="", valueLinesToggle: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Edit a characteristic of a graph editor
:param areCurvesSelected: (Q) Returns a boolean to know if at least one curve is selected
in the graph editor
:param autoFit: (Q E) on | off | tgl Auto fit-to-view
:param autoFitTime: (Q E) on | off | tgl Auto fit-to-view along the time axis, as well
:param classicMode: (Q E) When on, the graph editor is displayed in "Classic Mode",
otherwise "Suites Mode" is used
:param clipTime: (Q E) Valid values: "on" "off" Display the clips with their offset and
scale applied to the anim curves in the clip
:param constrainDrag: (C Q E) Constrains all Graph Editor animation curve drag operations
to either the X-axis, the Y-axis, or to neither of those axes Values to supply are: 0 fo
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param curvesShown: (Q) Returns a string array containing the names of the animCurve nodes
currently displayed in the graph editor
:param curvesShownForceUpdate: (Q) Returns a string array containing the names of the
animCurve nodes currently displayed in the graph editor Unlike the curvesShown flag, this
will fo
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param denormalizeCurvesCommand: (C E) Sets the script that is run to denormalize curves in
the graph editor This is intended for internal use only
:param displayActiveKeyTangents: (E) on | off | tgl Display active key tangents in the
editor
:param displayActiveKeys: (E) on | off | tgl Display active keys in the editor
:param displayInfinities: (E) on | off | tgl Display infinities in the editor
:param displayKeys: (E) on | off | tgl Display keyframes in the editor
:param displayNormalized: (Q E) When on, display all curves normalized to the range -1 to
+1
:param displayTangents: (E) on | off | tgl Display tangents in the editor
:param displayValues: (E) on | off | tgl Display active keys and tangents values in the
editor
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param keyingTime: (Q) The current time in the given curve to be keyed in the graph editor
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param lookAt: (E) all | selected | currentTime FitView helpers
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param menu: (C) Specify a script to be run when the editor is created The function will
be passed one string argument which is the new editor's name
:param normalizeCurvesCommand: (C E) Sets the script that is run to normalize curves in the
graph editor This is intended for internal use only
:param outliner: (Q E) The name of the outliner that is associated with the graph editor
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param preSelectionHighlight: (Q E) When on, the curve/key/tangent under the mouse pointer
is highlighted to ease selection
:param renormalizeCurves: (E) This flag causes the curve normalization factors to be
recalculated
:param resultSamples: (Q E) Specify the sampling for result curves Note: the smaller this
number is, the longer it will take to update the display
:param resultScreenSamples: (Q E) Specify the screen base result sampling for result curves
If 0, then results are sampled in time
:param resultUpdate: (Q E) Valid values: "interactive" "delayed" Controls how changes to
animCurves are reflected in the result curves (if results are being shown) If resultUp
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param showActiveCurveNames: (Q E) Display the active curve(s)'s name
:param showBufferCurves: (Q E) Valid values: "on" "off" "tgl" Display buffer curves
:param showCurveNames: (Q E) Display the curves's name
:param showResults: (Q E) Valid values: "on" "off" "tgl" Display result curves from
expression or other non-keyed action
:param showUpstreamCurves: (Q E) If true, the dependency graph is searched upstream for all
curves that drive the selected plugs (showing multiple curves for example in a typical dri
:param smoothness: (Q E) Valid values: "coarse" "rough" "medium" "fine" Specify the display
smoothness of animation curves
:param snapTime: (Q E) none | integer | keyframe Keyframe move snap in time
:param snapValue: (Q E) none | integer | keyframe Keyframe move snap in values
:param stackedCurves: (Q E) Switches the display mode between normal (all curves sharing
one set of axes) to stacked (each curve on its own value axis, stacked vertically)
:param stackedCurvesMax: (Q E) Sets the maximum value on the per-curve value axis when in
stacked mode
:param stackedCurvesMin: (Q E) Sets the minimum value on the per-curve value axis when in
stacked mode
:param stackedCurvesSpace: (Q E) Sets the spacing between curves when in stacked mode
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param valueLinesToggle: (E) on | off | tgl Display the value lines for high/low/zero of
selected curves in the editor
:returns: Editor name
"""
pass
def NodeEditorGraphUpDownstream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetCombBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ReverseSurfaceDirectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def contentBrowser(*args, addContentPath: AnyStr="", context: Union[List[AnyStr, AnyStr,
AnyStr], bool]=None, control: bool=True, defineTemplate: AnyStr="", docTag:
Union[AnyStr, bool]="", exists: bool=True, filter: Union[AnyStr, bool]="",
forceMainConnection: Union[AnyStr, bool]="", highlightConnection:
Union[AnyStr, bool]="", location: AnyStr="", lockMainConnection: bool=True,
mainListConnection: Union[AnyStr, bool]="", panel: Union[AnyStr, bool]="",
parent: Union[AnyStr, bool]="", preview: bool=True, refreshTreeView:
bool=True, removeContentPath: AnyStr="", saveCurrentContext: bool=True,
selectionConnection: Union[AnyStr, bool]="", stateString: bool=True,
thumbnailView: bool=True, treeView: bool=True, unParent: bool=True,
unlockMainConnection: bool=True, updateMainConnection: bool=True,
useTemplate: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command is used to edit and query a Content Browser The Content Browser is a unique
panel, so only one instance of it can exist at a given time The optional argument is the
name of the control
:param addContentPath: (E) Adds the given path(s) to the libraries displayed on the
Examples tab Also updates the corresponding MAYA_CONTENT_PATH environment variable
:param context: (Q E) Sets the default location for the given context The two optional
arguments (Python only) are the category (tab) and location To clear the content u
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param location: (E) Switches to the Examples tab and selects the given library location
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param preview: (E) Shows / hides the preview panel Note: this flag will not affect the
currently opened Content Browser, but only any subsequently opened ones
:param refreshTreeView: (E) Forces a refresh of the Examples tab tree view pane
:param removeContentPath: (E) Removes the given path(s) from the libraries displayed on the
Examples tab Also updates the corresponding MAYA_CONTENT_PATH environment variable
:param saveCurrentContext: (E) Saves the context for the current Content Browser tab
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param thumbnailView: (E) Shows / hides the thumbnail panel Note: this flag will not
affect the currently opened Content Browser, but only any subsequently opened ones
:param treeView: (E) Shows / hides the tree view panel Note: this flag will not affect the
currently opened Content Browser, but only any subsequently opened ones
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the panel
"""
pass
def Birail2(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Birail3(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Birail1(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportInstances(*args, **kwargs)->None:
"""
"""
pass
def frameBufferName(*args, autoTruncate: bool=True, camera: AnyStr="", renderLayer: AnyStr="",
renderPass: AnyStr="", **kwargs)->AnyStr:
"""
Returns the frame buffer name for a given renderPass renderLayer and camera combination
Optionally, this command can apply a name truncation algorithm so that the frameBuffer name
will respect the maximum length imposed by the destination file format, if applicable
:param autoTruncate: (C) use this flag to apply a name truncation algorithm so that the
frameBuffer name will respect the maximum length imposed by the destination file forma
:param camera: (C) Specify a camera
:param renderLayer: (C) Specify a renderer layer
:param renderPass: (C) Specify a renderer pass
:returns: Command result
"""
pass
def SequenceEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HIKPinRotate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nClothDeleteHistoryOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_gridSnapRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVStraightenOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectVertexFaceMask(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def notifyPostUndo(*args, **kwargs)->None:
"""
"""
pass
def PaintReduceWeightsTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyMoveFacet(*args, attraction: Union[float, bool]=0.0, caching: bool=True,
constructionHistory: bool=True, gain: Union[float, List[float], bool]=1.0,
gravity: Union[List[float, float, float], bool]=None, gravityX: Union[float,
bool]=0.0, gravityY: Union[float, bool]=0.0, gravityZ: Union[float, bool]=0.0,
localCenter: Union[int, bool]=0, localDirection: Union[List[float, float,
float], bool]=None, localDirectionX: Union[float, bool]=0.0, localDirectionY:
Union[float, bool]=0.0, localDirectionZ: Union[float, bool]=0.0, localRotate:
Union[List[float, float, float], bool]=None, localRotateX: Union[float,
bool]=0.0, localRotateY: Union[float, bool]=0.0, localRotateZ: Union[float,
bool]=0.0, localScale: Union[List[float, float, float], bool]=None,
localScaleX: Union[float, bool]=0.0, localScaleY: Union[float, bool]=0.0,
localScaleZ: Union[float, bool]=0.0, localTranslate: Union[List[float, float,
float], bool]=None, localTranslateX: Union[float, bool]=0.0, localTranslateY:
Union[float, bool]=0.0, localTranslateZ: Union[float, bool]=0.0, magnX:
Union[float, bool]=0.0, magnY: Union[float, bool]=0.0, magnZ: Union[float,
bool]=0.0, magnet: Union[List[float, float, float], bool]=None, name:
AnyStr="", nodeState: Union[int, bool]=0, offset: Union[float, bool]=0.0,
pivot: Union[List[float, float, float], bool]=None, pivotX: Union[float,
bool]=0.0, pivotY: Union[float, bool]=0.0, pivotZ: Union[float, bool]=0.0,
random: Union[float, bool]=0.0, rotate: Union[List[float, float, float],
bool]=None, rotateX: Union[float, bool]=0.0, rotateY: Union[float, bool]=0.0,
rotateZ: Union[float, bool]=0.0, scale: Union[List[float, float, float],
bool]=None, scaleX: Union[float, bool]=0.0, scaleY: Union[float, bool]=0.0,
scaleZ: Union[float, bool]=0.0, translate: Union[List[float, float, float],
bool]=None, translateX: Union[float, bool]=0.0, translateY: Union[float,
bool]=0.0, translateZ: Union[float, bool]=0.0, weight: Union[float, bool]=0.0,
worldSpace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Modifies facet of a polygonal object Translate, move, rotate or scale facets
:param attraction: (C Q E) Attraction, related to magnet The range is [-2.0, 2.0]
Default: 0.0
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param gain: (C Q E M) Gain factor per component Can be painted using Artisan Default:
1.0
:param gravity: (C Q E) The gravity vector Default: 0.0, -1.0, 0.0
:param gravityX: (C Q E) Gravity X coord
:param gravityY: (C Q E) Gravity Y coord
:param gravityZ: (C Q E) Gravity Z coord
:param localCenter: (C Q E) Local center on the edge : 0=Middle point, 1=Start point, 2=End
point Default: 0
:param localDirection: (C Q E) Direction to determine X axis for local space Default: 1.0,
0.0, 0.0
:param localDirectionX: (C Q E) X coord of the X axis
:param localDirectionY: (C Q E) Y coord of the X axis
:param localDirectionZ: (C Q E) Z coord of the X axis
:param localRotate: (C Q E) The local rotations Default: 0.0, 0.0, 0.0
:param localRotateX: (C Q E) Local rotate X coord The range is [0, 360]
:param localRotateY: (C Q E) Local rotate Y coord The range is [0, 360]
:param localRotateZ: (C Q E) Local rotate Z coord : Rotation along the normal The range is
[0, 360]
:param localScale: (C Q E) Local Scale Default: 1.0, 1.0, 1.0
:param localScaleX: (C Q E) Scale X coord
:param localScaleY: (C Q E) Scale Y coord
:param localScaleZ: (C Q E) Scale Z coord
:param localTranslate: (C Q E) Local translate Default: 0.0, 0.0, 0.0
:param localTranslateX: (C Q E) Local translation X coord
:param localTranslateY: (C Q E) Local translation Y coord
:param localTranslateZ: (C Q E) Local translation Z coord : Move along the normal
:param magnX: (C Q E) Magnet X coord
:param magnY: (C Q E) Magnet Y coord
:param magnZ: (C Q E) Magnet Z coord
:param magnet: (C Q E) The magnet vector Default: 0.0, 0.0, 0.0
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param offset: (C Q E) Local offset Faces are moved this distance towards the inside of
the face Default: 0.0
:param pivot: (C Q E) The pivot for scaling and rotation Default: 0.0, 0.0, 0.0
:param pivotX: (C Q E) Pivot X coord
:param pivotY: (C Q E) Pivot Y coord
:param pivotZ: (C Q E) Pivot Z coord
:param random: (C Q E) Random value for all parameters Default: 0.0
:param rotate: (C Q E) Rotation angles around X, Y, Z Default: 0.0, 0.0, 0.0
:param rotateX: (C Q E) Rotation angle around X
:param rotateY: (C Q E) Rotation angle around Y
:param rotateZ: (C Q E) Rotation angle around Z
:param scale: (C Q E) Scaling vector Default: 1.0, 1.0, 1.0
:param scaleX: (C Q E) Scale X coord
:param scaleY: (C Q E) Scale Y coord
:param scaleZ: (C Q E) Scale Z coord
:param translate: (C Q E) Translation vector Default: 0.0, 0.0, 0.0
:param translateX: (C Q E) Translation X coord
:param translateY: (C Q E) Translation Y coord
:param translateZ: (C Q E) Translation Z coord
:param weight: (C Q E) The weight, related to gravity Default: 0.0
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def getModulePath(*args, moduleName: AnyStr="", **kwargs)->AnyStr:
"""
Returns the module path for a given module name
:param moduleName: (C) The name of the module whose path you want to retrieve
:returns: Command result
"""
pass
def SplitUV(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisplayLight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_customPivotToolRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DuplicateNURBSPatches(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeFrameSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def panelHistory(*args, back: bool=True, clear: bool=True, defineTemplate: AnyStr="", exists:
bool=True, forward: bool=True, historyDepth: Union[int, bool]=0, isEmpty:
bool=True, suspend: bool=True, targetPane: Union[AnyStr, bool]="",
useTemplate: AnyStr="", wrap: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a panel history object The object is targeted on a particular
paneLayout and thereafter notes changes in panel configurations within that paneLayout,
building up a history list The list can be stepped through backwards or forwards
:param back: (E) Go back one level on the history list
:param clear: (E) Clear the history stack
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param forward: (E) Go forward one level on the history list
:param historyDepth: (Q E) Specifies how many levels of history are maintained
:param isEmpty: (Q) Returns true if there is currently no panel history
:param suspend: (E) Specifies whether to suspend or resume updates to the panel history
Useful for chunking a number of changes into one history event
:param targetPane: (C Q) Specifies which paneLayout the history will be maintained for
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param wrap: (Q E) Specifies whether the history will wrap at the end and beginning This
value is true by default
:returns: The name of the panelHistory object created.
"""
pass
def HypershadeShapeMenuStateAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def boxDollyCtx(*args, alternateContext: bool=True, exists: bool=True, history: bool=True,
image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", name: AnyStr="", toolName: Union[AnyStr, bool]="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create, edit, or query a dolly context
:param alternateContext: (C Q) Set the ALT+MMB and ALT+SHIFT+MMB to refer to this context
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param toolName: (C Q) Name of the specific tool to which this command refers
:returns: The name of the context
"""
pass
def NodeEditorTransforms(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetCurrentColorSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeConvertToFileTexture(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintCacheToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeCreateNewTab(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createPolyPlatonicSolidCtx(*args, **kwargs)->None:
"""
"""
pass
def polySplitVertex(*args, caching: bool=True, constructionHistory: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, worldSpace: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Use this command to split one or more vertices. A mesh is made up of one or more faces The
faces are defined by edges which connect vertices together Typically a face will share
vertices and edges with adjacent faces in the same mesh Sharing vertices and edges helps
reduce the amount of memory used by a mesh It also ensures that when a face is
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The polySplitVert node name.
"""
pass
def dR_visorTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonPlane(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVCreateSnapshot(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AutoProjection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetKeyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PrefixHierarchyNames(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MirrorJoint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmCombBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def SetKeyScale(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportHardEdges(*args, **kwargs)->None:
"""
"""
pass
def EvaluationToolkit(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateNodeWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateWake(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmGuideContext(*args, **kwargs)->None:
"""
"""
pass
def NonWeightedTangents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def shadingNetworkCompare(*args, byName: bool=False, byValue: bool=True, delete: bool=True,
equivalent: bool=True, network1: bool=True, network2: bool=True,
upstreamOnly: bool=False, q=True, query=True,
**kwargs)->Union[List[AnyStr|AnyStr|int], Any]:
"""
This command allows you to compare two shading networks
:param byName: (C) Indicates whether the comparison should consider node names If true,
two shading networks will be considered equivalent only if the names of corresp
:param byValue: (C) Indicates whether the comparison should consider the values of
unconnected attributes If true, two shading networks will be considered equivalent on
:param delete: (C) Deletes the specified comparison from memory
:param equivalent: (Q) Returns an int 1 if the shading networks in the specified
comparison are equivalent 0 otherwise
:param network1: (Q) Returns a string[] Returns an empty string array if the shading
networks in the specified comparison are not equivalent Otherwise returns the nodes
:param network2: (Q) Returns a string[] Returns an empty string array if the shading
networks in the specified comparison are not equivalent Otherwise returns the nodes
:param upstreamOnly: (C) Indicates whether the comparison should consider nodes which are
connected downstream from shading network nodes If true, only those nodes which are
:returns: Command result
"""
pass
def FBXResetExport(*args, **kwargs)->None:
"""
"""
pass
def dR_setExtendLoop(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def renderQualityNode(*args, name: AnyStr="", parent: AnyStr="", shared: bool=True, skipSelect:
bool=True, **kwargs)->AnyStr:
"""
This command creates a new node in the dependency graph of the specified type The
renderQualityNode creates a render quality node and registers it with the model The
createNode command will not register nodes of this type correctly
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param parent: (C) Specifies the parent in the DAG under which the new node belongs
:param shared: (C) This node is shared across multiple files, so only create it if it does
not already exist
:param skipSelect: (C) This node is not to be selected after creation, the original
selection will be preserved
:returns: The name of the new node.
"""
pass
def ShowSurfaceCVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_symmetryFlip(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def lightlink(*args, b: bool=True, hierarchy: bool=True, light: Union[name, List[name]]=None,
make: bool=True, object: Union[name, List[name]]=None, sets: bool=True, shadow:
bool=True, shapes: bool=True, transforms: bool=True, useActiveLights: bool=True,
useActiveObjects: bool=True, q=True, query=True, **kwargs)->Union[AnyStr, Any]:
"""
This command is used to make, break and query light linking relationships between
lights/sets of lights and objects/sets of objects If no make, break or query flag is
specified and both lights and objects flags are present, the make flag is assumed to be
specified If no make, break or query flag is specified and only one of the lights and
objec
:param b: (C) The presence of this flag on the command indicates that the command is being
invoked to break links between lights and renderable objects
:param hierarchy: (C) When querying, specifies whether the result should include the
hierarchy of transforms above shapes linked to the queried light/object The transform
:param light: (C M) The argument to the light flag specifies a node to be used by the
command in performing the action as if the node is a light This is a multiuse flag
:param make: (C) The presence of this flag on the command indicates that the command is
being invoked to make links between lights and renderable objects
:param object: (C M) The argument to the object flag specifies a node to be used by the
command in performing the action as if the node is an object This is a multiuse f
:param sets: (C) When querying, specifies whether the result should include sets linked to
the queried light/object Default is true
:param shadow: (C) Specify that shadows are to be linked
:param shapes: (C) When querying, specifies whether the result should include shapes linked
to the queried light/object Default is true
:param transforms: (C) When querying, specifies whether the result should include
transforms immediately above shapes linked to the queried light/object Default is true
:param useActiveLights: (C) Specify that active lights are to be used
:param useActiveObjects: (C) Specify that active objects are to be used
:returns: Single element command result
"""
pass
def ProjectCurveOnSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EnableTimeChangeUndoConsolidation(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RotateUVTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SymmetrizeUVUpdateCommand(*args, **kwargs)->None:
"""
"""
pass
def NodeEditorPickWalkRight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MirrorSkinWeightsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_selectAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_selConstraintEdgeLoop(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeIncreaseTraversalDepth(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def eval(*args, **kwargs)->Any:
"""
This function takes a string which contains MEL code and evaluates it using the MEL
interpreter The result is converted into a Python data type and is returned If an error
occurs during the execution of the MEL script, a Python exception is raised with the
appropriate error message
:returns: depending on input.
"""
pass
def syncSculptCache(*args, **kwargs)->None:
"""
"""
pass
def exactWorldBoundingBox(*args, calculateExactly: bool=True, ignoreInvisible: bool=True,
**kwargs)->List[float]:
"""
This command figures out an exact-fit bounding box for the specified objects (or selected
objects if none are specified) This bounding box is always in world space
:param calculateExactly: (C) Should the bounding box calculation be exact?
:param ignoreInvisible: (C) Should the bounding box calculation include or exclude
invisible objects?
:returns: xmin, ymin, zmin, xmax, ymax, zmax.
"""
pass
def Shatter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorShowCustomAttrs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_selConstraintBorder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteStaticChannels(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ParticleTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TruncateHairCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Duplicate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyContourProjection(*args, caching: bool=True, constructionHistory: bool=True,
createNewMap: bool=True, flipRails: bool=True, insertBeforeDeformers:
bool=True, method: Union[int, bool]=0, name: AnyStr="", nodeState:
Union[int, bool]=0, offset0: Union[float, bool]=0.0, offset1:
Union[float, bool]=0.0, offset2: Union[float, bool]=0.0, offset3:
Union[float, bool]=0.0, reduceShear: Union[float, bool]=0.0,
smoothness0: Union[float, bool]=0.0, smoothness1: Union[float,
bool]=0.0, smoothness2: Union[float, bool]=0.0, smoothness3:
Union[float, bool]=0.0, userDefinedCorners: bool=True, uvSetName:
AnyStr="", worldSpace: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Performs a contour stretch UV projection onto an object
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createNewMap: (C) Set to true if a new map should be created
:param flipRails: (C Q E) If true, flip which curves are the rails of the birail surface
:param insertBeforeDeformers: (C) Set to true if the new node created should inserted
before any deformer nodes
:param method: (C Q E) Sets which projection method to use Valid values are 0: Walk
Contours 1: NURBS Projection
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param offset0: (C Q E) Sets the offset on edge 0 of the NURBS surface
:param offset1: (C Q E) Sets the offset on edge 1 of the NURBS surface
:param offset2: (C Q E) Sets the offset on edge 2 of the NURBS surface
:param offset3: (C Q E) Sets the offset on edge 3 of the NURBS surface
:param reduceShear: (C Q E) Sets the 'reduce shear' parameter of the projection
:param smoothness0: (C Q E) Sets the smoothness of edge 0 of the NURBS surface
:param smoothness1: (C Q E) Sets the smoothness of edge 1 of the NURBS surface
:param smoothness2: (C Q E) Sets the smoothness of edge 2 of the NURBS surface
:param smoothness3: (C Q E) Sets the smoothness of edge 3 of the NURBS surface
:param userDefinedCorners: (C Q E) If true, the four vertices specified by user will be
taken as corners to do the projection
:param uvSetName: (C) Name of the UV set to be created
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def NodeEditorCreateNodePopup(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportSkeletonDefinitions(*args, **kwargs)->None:
"""
"""
pass
def SetKeyRotate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtrudeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fcheck(*args, **kwargs)->None:
"""
Invokes the fcheck program to display images in a separate window
:returns:
"""
pass
def ActivateViewport20(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def tabLayout(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, borderStyle: Union[AnyStr, bool]="", changeCommand:
Script=None, childArray: bool=True, childResizable: bool=True, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", doubleClickCommand: Script=None,
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, horizontalScrollBarThickness: int=0,
image: Union[AnyStr, bool]="", imageVisible: bool=True, innerMarginHeight:
Union[int, bool]=0, innerMarginWidth: Union[int, bool]=0, isObscured: bool=True,
manage: bool=True, minChildWidth: Union[int, bool]=0, moveTab: List[int,
int]=None, newTabCommand: Script=None, noBackground: bool=True, numberOfChildren:
bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preSelectCommand: Script=None, preventOverride:
bool=True, scrollable: bool=True, scrollableTabs: bool=True, selectCommand:
Union[Script, bool]=None, selectTab: Union[AnyStr, bool]="", selectTabIndex:
Union[int, bool]=0, showNewTab: bool=True, statusBarMessage: AnyStr="", tabLabel:
Union[List[AnyStr, AnyStr], List[List[AnyStr, AnyStr]], bool]=None,
tabLabelIndex: Union[List[int, AnyStr], List[List[int, AnyStr]], bool]=None,
tabPosition: Union[AnyStr, bool]="", tabTooltip: Union[List[AnyStr, AnyStr],
List[List[AnyStr, AnyStr]], bool]=None, tabTooltipIndex: Union[List[int, AnyStr],
List[List[int, AnyStr]], bool]=None, tabsClosable: bool=True, tabsVisible:
bool=True, useTemplate: AnyStr="", verticalScrollBarThickness: int=0, visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a tab group Tab groups are a specialized form of control layouts that
contain only control layouts Whenever a control layout is added to a tab group it will
have a tab provided for it that allows selection of that group from amongst other tabbed
control groups Only one child of a tab layout is visible at a time
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param borderStyle: (C Q E) Specify the style of the border for tab layout Valid values
are: "none", "top", "notop" and "full" By default, it will use "full" to draw a simple
:param changeCommand: (C E) Command executed when a tab is selected interactively This
command is only invoked when the selected tab changes Re-selecting the current tab will
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param childResizable: (C Q) Set to true if you want the child of the control layout to be
as wide as the scroll area You may also indicate a minimum width for the child using t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param doubleClickCommand: (C E) Command executed when a tab is double clicked on Note
that the first click will select the tab and the second click will execute the double click
co
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param horizontalScrollBarThickness: (C E) Thickness of the horizontal scroll bar Specify
an integer value greater than or equal to zero This flag has no effect on Windows systems
:param image: (C Q E) Image appearing in top right corner of tab layout
:param imageVisible: (C Q E) Visibility of tab image
:param innerMarginHeight: (C Q) Margin height for all tab children
:param innerMarginWidth: (C Q) Margin width for all tab children
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param minChildWidth: (C Q) Specify a positive non-zero integer value indicating the
minimum width the tab layout's children This flag only has meaning when the
-cr/childResiza
:param moveTab: (C E) Move the tab from the current index to a new index
:param newTabCommand: (C E) Command executed when the 'New Tab' button (on the tab bar) is
clicked Note: in order to show the new tab button use the -snt/showNewTab flag Using
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preSelectCommand: (C E) Command executed when a tab is selected but before it's
contents become visible Re-selecting the current tab will not invoke this command Note
that
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param scrollable: (C Q) Puts all children of this layout within a scroll area
:param scrollableTabs: (C Q E) If true, the active tab in the layout can be scrolled
through with the mouse wheel Default is true
:param selectCommand: (C Q E) Command executed when a tab is selected interactively This
command will be invoked whenever a tab is selected, ie re-selecting the current tab will
:param selectTab: (C Q E) The name, in short form, of the selected tab An empty string is
returned on query if there are no child tabs
:param selectTabIndex: (C Q E) Identical to the -st/selectTab flag except this flag takes a
1-based index to identify the selected tab A value of 0 is returned on query if there a
:param showNewTab: (C Q E) Set to true if you want to have a 'New Tab' button shown at the
end of the tab bar Note: use the -ntc/newTabCommand flag to set the command executed
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param tabLabel: (C Q E M) Set a tab label The first argument is the name of a control
that must be a child of the tab layout The second argument is the label for the tab ass
:param tabLabelIndex: (C Q E M) Identical to the -tl/tabLabel flag except this flag takes a
1-based index to identify the tab you want to set the label for If this flag is queried
:param tabPosition: (C Q E) Changes the tab position The possible values are: "north",
"east" and "west"
:param tabTooltip: (C Q E M) Set a tab tooltip The first argument is the name of a control
that must be a child of the tab layout The second argument is the tooltip for the tab
:param tabTooltipIndex: (C Q E M) Identical to the -tt/tabTooltip flag except this flag
takes a 1-based index to identify the tab you want to set the tooltip for If this flag is
quer
:param tabsClosable: (C Q) Set to true if you want to have a close button icon on all
created tabs
:param tabsVisible: (C Q E) Visibility of the tab labels
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param verticalScrollBarThickness: (C E) Thickness of the vertical scroll bar Specify an
integer value greater than or equal to zero This flag has no effect on Windows systems
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def AttachSubdivSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleCreaseVertices(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_multiCutRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ChangeFullBodyPivotPlacement(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertToFrozen(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PerspGraphLayout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def selectContext(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name:
AnyStr="", q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
Creates a context to perform selection
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Name of the context created
"""
pass
def DeleteSurfaceFlowOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyMergeEdgeCtx(*args, activeNodes: bool=True, exists: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
immediate: bool=True, name: AnyStr="", previous: bool=True, reset:
bool=True, toolNode: bool=True, caching: bool=True, constructionHistory:
bool=True, firstEdge: Union[int, bool]=0, mergeMode: Union[int, bool]=1,
mergeTexture: bool=False, nodeState: Union[int, bool]=0, secondEdge:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Sews two border edges together.
:param activeNodes: (Q) Return the active nodes in the tool
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param immediate: (E) Acts on the object not the tool defaults
:param name: (C) If this is a tool command, name the tool appropriately
:param previous: (E) Reset to previously stored values
:param reset: (E) Reset to default values
:param toolNode: (Q) Return the node used for tool defaults
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param firstEdge: (C Q E) First edge to merge Invalid default value to force the value to
be set Default: -1
:param mergeMode: (C Q E) Merge mode : 0=first, 1=halfway between both edges, 2=second
Default: 1
:param mergeTexture: (C Q E) Boolean which is used to decide if uv coordinates should be
merged or not - along with the geometry Default: false
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param secondEdge: (C Q E) Second edge to merge Invalid default value to force the value
to be set Default: -1
:returns: The node name.
"""
pass
def NodeEditorGraphAllShapesExceptShading(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def listInputDeviceButtons(*args, **kwargs)->List[AnyStr]:
"""
This command lists all of the buttons of the specified input device specified as an
argument
:returns: Command result
"""
pass
def SubdividePolygonOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConnectJointOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshPinchToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EnableNCloths(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportCacheFile(*args, **kwargs)->None:
"""
"""
pass
def sceneUIReplacement(*args, clear: bool=True, deleteRemaining: bool=True, getNextFilter:
List[AnyStr, AnyStr]=None, getNextPanel: List[AnyStr, AnyStr]=None,
getNextScriptedPanel: List[AnyStr, AnyStr]=None, update: AnyStr="",
**kwargs)->AnyStr:
"""
This command returns existing scene based UI that can be utilized by the scene that is
being loaded It can also delete any such UI that is not used by the loading scene
:param clear: (C) Frees any resources allocated by the command
:param deleteRemaining: (C) Delete any UI that is scene dependent and has not been
referenced by this command since the last update
:param getNextFilter: (C) Returns the next filter of the specified type with the specified
name
:param getNextPanel: (C) Returns the next panel of the specified type, preferably with the
specified label
:param getNextScriptedPanel: (C) Returns the next scripted panel of the specified scripted
panel type, preferably with the specified label
:param update: (C) Updates the state of the command to reflect the current state of the
application The string argument is the name of the main window pane layout hold
:returns: When used with getNextScriptedPanel, getNextPanel, or getNextFilter
"""
pass
def singleProfileBirailSurface(*args, caching: bool=True, nodeState: Union[int, bool]=0,
tangentContinuityProfile1: bool=False, transformMode: Union[int,
bool]=0, constructionHistory: bool=True, name: AnyStr="",
object: bool=True, polygon: int=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This cmd creates a railed surface by sweeping the profile curve along the two rail curves
One of the requirements for surface creation is the profile curve must intersect the two
rail curves If the profile is a surface curve i.e isoparm, curve on surface or trimmed
edge then tangent continuity across the surface underlying the profile may be ena
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param tangentContinuityProfile1: (C Q E) Need to be tangent continuous across the profile
The profile must be a surface curve Default: false
:param transformMode: (C Q E) transform mode ( Non proportional, proportional ) Non
proportional is default value Default: 0
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:returns: Object name and node name
"""
pass
def ViewAlongAxisNegativeY(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorRenderSwatches(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CurveSmoothnessCoarse(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def selectKeyCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name:
AnyStr="", q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This command creates a context which may be used to select keyframes within the graph
editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns:
"""
pass
def EnableSnapshots(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowManipulatorTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MoveNearestPickedKeyToolDeactivate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def objectCenter(*args, gl: bool=True, local: bool=True, x: bool=True, y: bool=True, z:
bool=True, **kwargs)->List[float]:
"""
This command returns the coordinates of the center of the bounding box of the specified
object If one coordinate only is specified, it will be returned as a float If no
coordinates are specified, an array of floats is returned, containing x, y, and z If you
specify multiple coordinates, only one will be returned
:param gl: (C) Return positional values in global coordinates (default)
:param local: (C) Return positional values in local coordinates
:param x: (C) Return X value only
:param y: (C) Return Y value only
:param z: (C) Return Z value only
:returns: When the asking for the center (default).
"""
pass
def NodeEditorAutoSizeNodes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorCloseActiveTab(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorDeleteClips(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MakePondBoatsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleUseDefaultMaterial(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportInputConnections(*args, **kwargs)->None:
"""
"""
pass
def cacheFileMerge(*args, endTime: time=None, geometry: bool=True, startTime: time=None, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[float], Any]:
"""
If selected/specified caches can be successfully merged, will return the start/end frames
of the new cache followed by the start/end frames of any gaps in the merged cache for which
no data should be written to file In query mode, will return the names of geometry
associated with the specified cache file nodes
:param endTime: (C) Specifies the end frame of the merge range If not specified, will
figure out range from times of caches being merged
:param geometry: (Q) Query-only flag used to find the geometry nodes associated with the
specified cache files
:param startTime: (C) Specifies the start frame of the merge range If not specified, will
figure out range from the times of the caches being merged
:returns: The start and end times of merged cache followed by start/end of any gaps
"""
pass
def closeCurve(*args, blendBias: Union[float, bool]=0.5, blendKnotInsertion: bool=False,
caching: bool=True, nodeState: Union[int, bool]=0, parameter: Union[float,
bool]=0.1, preserveShape: Union[int, bool]=1, constructionHistory: bool=True,
curveOnSurface: bool=True, name: AnyStr="", object: bool=True, replaceOriginal:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr],
Any]:
"""
The closeCurve command closes a curve, making it periodic The pathname to the newly closed
curve and the name of the resulting dependency node are returned If a curve is not
specified in the command, then the first active curve will be used
:param blendBias: (C Q E) Skew the result toward the first or the second curve depending on
the blend value being smaller or larger than 0.5 Default: 0.5
:param blendKnotInsertion: (C Q E) If set to true, insert a knot in one of the original
curves (relative position given by the parameter attribute below) in order to produce a
slightly
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param parameter: (C Q E) The parameter value for the positioning of the newly inserted
knot Default: 0.1
:param preserveShape: (C Q E) 0 - without preserving the shape 1 - preserve shape 2 - blend
Default: 1
:param constructionHistory: (C) Turn the construction history on or off
:param curveOnSurface: (C) If possible, create 2D curve as a result
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def setDynamic(*args, allOnWhenRun: bool=True, disableAllOnWhenRun: bool=True, setAll:
bool=True, setOff: bool=True, setOn: bool=True, **kwargs)->AnyStr:
"""
setDynamic sets the isDynamic attribute of particle objects on or off If no objects are
specified, it sets the attribute for any selected objects If -all is thrown, it sets the
attribute for all particle objects in the scene By default it sets the attribute true
(on); if the -off flag is thrown, it sets the attribute false (off) WARNING: setDy
:param allOnWhenRun: (C) Obsolete, no longer suppported or necessary
:param disableAllOnWhenRun: (C) Obsolete, no longer suppported or necessary
:param setAll: (C) Set for all objects
:param setOff: (C) Sets isDynamic false
:param setOn: (C) Sets isDynamic true This flag is set by default
:returns: array
"""
pass
def LayoutUVRectangle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateOceanOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EmitFluidFromObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ViewSequence(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def volumeBind(*args, influence: Union[AnyStr, bool]="", name: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
Command for creating and editing volume binding nodes The node is use for storing volume
data to define skin weighting data
:param influence: (Q E) Edit or Query the list of influences connected to the skin cluster
:param name: (C) Used to specify the name of the node being created
:returns: List of queried influences
"""
pass
def animLayer(*args, addRelatedKG: bool=True, addSelectedObjects: bool=True, affectedLayers:
bool=True, animCurves: bool=True, attribute: Union[AnyStr, List[AnyStr], bool]="",
baseAnimCurves: bool=True, bestAnimLayer: bool=True, bestLayer: bool=True,
blendNodes: bool=True, children: Union[AnyStr, bool]="", collapse: bool=True,
copy: AnyStr="", copyAnimation: AnyStr="", copyNoAnimation: AnyStr="",
excludeBoolean: bool=True, excludeDynamic: bool=True, excludeEnum: bool=True,
excludeRotate: bool=True, excludeScale: bool=True, excludeTranslate: bool=True,
excludeVisibility: bool=True, exists: bool=True, extractAnimation: AnyStr="",
findCurveForPlug: Union[AnyStr, bool]="", forceUIRebuild: bool=True,
forceUIRefresh: bool=True, layeredPlug: Union[AnyStr, bool]="", lock: bool=False,
maxLayers: bool=True, moveLayerAfter: AnyStr="", moveLayerBefore: AnyStr="",
mute: bool=False, override: bool=False, parent: Union[AnyStr, bool]="",
passthrough: bool=True, preferred: bool=True, removeAllAttributes: bool=True,
removeAttribute: Union[AnyStr, List[AnyStr]]="", root: Union[AnyStr, bool]="",
selected: bool=True, solo: bool=False, weight: Union[float, bool]=1,
writeBlendnodeDestinations: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates and edits animation layers
:param addRelatedKG: (C Q E) Used adding attributes to a layer Determines if associated
keying groups should be added or not to the layer
:param addSelectedObjects: (C Q E) Adds selected object(s) to the layer
:param affectedLayers: (Q) Return the layers that the currently selected object(s) are
members of
:param animCurves: (C Q E) In query mode returns the anim curves associated with this
layer
:param attribute: (C Q E M) Adds a specific attribute on a object to the layer
:param baseAnimCurves: (C Q E) In query mode returns the base layer anim curves associated
with this layer, if any
:param bestAnimLayer: (C Q E) In query mode returns the best anim layers for keying for the
selected objects If used in conjunction with -at, will return the best anim layers for
:param bestLayer: (Q) Return the layer that will be keyed for specified attribute
:param blendNodes: (C Q E) In query mode returns the blend nodes associated with this
layer
:param children: (Q) Get the list of children layers Return value is a string array
:param collapse: (C Q E) Determine if a layer is collapse in the layer editor
:param copy: (E) Copy from layer
:param copyAnimation: (C E) Copy animation from specified layer to destination layer, only
animation that are on attribute layered by both layer that are concerned
:param copyNoAnimation: (E) Copy from layer without the animation curves
:param excludeBoolean: (C Q E) When adding selected object(s) to the layer, excludes any
boolean attributes
:param excludeDynamic: (C Q E) When adding selected object(s) to the layer, excludes any
dynamic attributes
:param excludeEnum: (C Q E) When adding selected object(s) to the layer, excludes any enum
attributes
:param excludeRotate: (C Q E) When adding selected object(s) to the layer, exclude the
rotate attribute
:param excludeScale: (C Q E) When adding selected object(s) to the layer, exclude the scale
attribute
:param excludeTranslate: (C Q E) When adding selected object(s) to the layer, excludes the
translate attribute
:param excludeVisibility: (C Q E) When adding selected object(s) to the layer, exclude the
visibility attribute
:param exists: (Q) Determine if an layer exists
:param extractAnimation: (C E) Transfer animation from specified layer to destination layer,
only animation that are on attribute layered by both layer that are concerned
:param findCurveForPlug: (Q E) Finds the parameter curve containing the animation data for
the specified plug on the given layer In query mode, this flag needs a value
:param forceUIRebuild: (C) Rebuilds the animation layers user interface
:param forceUIRefresh: (C) Refreshes the animation layers user interface
:param layeredPlug: (Q) Returns the plug on the blend node corresponding to the specified
layer In query mode, this flag needs a value
:param lock: (C Q E) Set the lock state of the specified layer A locked layer cannot
receive key Default is false
:param maxLayers: (Q) Returns the maximum number of anim layers supported by this product
:param moveLayerAfter: (E) Move layer after the specified layer
:param moveLayerBefore: (E) Move layer before the specified layer
:param mute: (C Q E) Set the mute state of the specified layer Default is false
:param override: (C Q E) Set the overide state of the specified layer Default is false
:param parent: (C Q E) Set the parent of the specified layer Default is the animation
layer root
:param passthrough: (C Q E) Set the passthrough state of the specified layer Default is
true
:param preferred: (C Q E) Determine if a layer is a preferred layer, the best layer
algorithm will try to set keyframe in preferred layer first
:param removeAllAttributes: (E) Remove all objects from layer
:param removeAttribute: (E M) Remove object from layer
:param root: (Q) Return the base layer if it exist
:param selected: (C Q E) Determine if a layer is selected, a selected layer will be show in
the timecontrol, graph editor
:param solo: (C Q E) Set the solo state of the specified layer Default is false
:param weight: (C Q E) Set the weight of the specified layer between 0.0 and 1.0 Default
is 1
:param writeBlendnodeDestinations: (E) In edit mode writes the destination plugs of the
blend nodes that belong to the layer into the blend node This is used for layer
import/export purpo
:returns: Return values currently not documented.
"""
pass
def HypershadeSelectBakeSets(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleUIElements(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportCacheFile(*args, **kwargs)->None:
"""
"""
pass
def projectionManip(*args, fitBBox: bool=True, projType: int=0, switchType: bool=True, q=True,
query=True, **kwargs)->Union[None, Any]:
"""
Various commands to set the manipulator to interesting positions
:param fitBBox: (C) Fit the projection manipulator size and position to the shading group
bounding box The orientation is not modified
:param projType: (C) Set the projection type to the given value Projection type values
are: 1 = planar 2 = spherical 3 = cylindrical 4 = ball 5 = cubic 6 = triplana
:param switchType: (C) Loop over the allowed types If the hardware shading is on, it loops
over the hardware shadeable types (planar, cylindrical, spherical), otherwise, i
:returns:
"""
pass
def texScaleContext(*args, editPivotMode: bool=True, exists: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
position: bool=True, preventNegativeScale: bool=True, snap: bool=True,
snapRelative: bool=True, snapValue: Union[float, bool]=0.0, tweakMode:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command can be used to create, edit, or query a scale context for the UV Editor Note
that the above flag controls the global behaviour of all texture editor scale contexts
Changing one context independently is not allowed Changing a context's behaviour using the
above flag, will change all existing texture editor scale contexts
:param editPivotMode: (Q) Returns true when manipulator is in edit pivot mode
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param position: (Q) Returns the current position of the manipulator
:param preventNegativeScale: (Q E) Prevent negative scale for components
:param snap: (Q E) Sets or queries whether snapping is to be used
:param snapRelative: (Q E) Sets or queries whether snapping is relative
:param snapValue: (Q E) Sets or queries the size of the snapping increment
:param tweakMode: (Q E) When true, the manipulator is hidden and highlighted components can
be selected and scaled in one step using a click-drag interaction
:returns: : name of the context created
"""
pass
def evalContinue(*args, **kwargs)->None:
"""
"""
pass
def volumeAxis(*args, alongAxis: Union[float, bool]=0.0, aroundAxis: Union[float, bool]=0.0,
attenuation: Union[float, bool]=0.0, awayFromAxis: Union[float, bool]=0.0,
awayFromCenter: Union[float, bool]=0.0, detailTurbulence: Union[float, bool]=0.0,
directionX: Union[float, bool]=0.0, directionY: Union[float, bool]=0.0,
directionZ: Union[float, bool]=0.0, directionalSpeed: Union[float, bool]=0.0,
invertAttenuation: bool=True, magnitude: Union[float, bool]=0.0, maxDistance:
Union[float, bool]=0.0, name: Union[AnyStr, bool]="", perVertex: bool=True,
position: Union[List[float, float, float], List[List[float, float, float]],
bool]=None, torusSectionRadius: Union[float, bool]=0.0, turbulence: Union[float,
bool]=0.0, turbulenceFrequencyX: Union[float, bool]=0.0, turbulenceFrequencyY:
Union[float, bool]=0.0, turbulenceFrequencyZ: Union[float, bool]=0.0,
turbulenceOffsetX: Union[float, bool]=0.0, turbulenceOffsetY: Union[float,
bool]=0.0, turbulenceOffsetZ: Union[float, bool]=0.0, turbulenceSpeed:
Union[float, bool]=0.0, volumeExclusion: bool=True, volumeOffset:
Union[List[float, float, float], bool]=None, volumeShape: Union[AnyStr, bool]="",
volumeSweep: Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
For each listed object, the command creates a new field The field has a shape which lives
in the DAG and it has an associated dependency node The field is added to the list of
fields owned by the object Use connectDynamic to cause the field to affect a dynamic
object Note that if more than one object is listed, a separate field is created for e
:param alongAxis: (Q E) Initial velocity multiplier in the direction along the central axis
of the volume See the diagrams in the documentation
:param aroundAxis: (Q E) Initial velocity multiplier in the direction around the central
axis of the volume See the diagrams in the documentation
:param attenuation: (Q E) Attentuation rate of field
:param awayFromAxis: (Q E) Initial velocity multiplier in the direction away from the
central axis of the volume See the diagrams in the documentation Used only with the cyli
:param awayFromCenter: (Q E) Initial velocity multiplier in the direction away from the
center point of a cube or sphere volume Used only with the cube and sphere volumes
:param detailTurbulence: (Q E) The relative intensity of a second higher frequency
turbulence This can be used to create fine features in large scale flows Both the speed
and the
:param directionX: (Q E) x-component of force direction Used with directional speed
:param directionY: (Q E) y-component of force direction Used with directional speed
:param directionZ: (Q E) z-component of force direction Used with directional speed
:param directionalSpeed: (Q E) Adds a component of speed in the direction specified by the
directionX, Y, and Z attributes
:param invertAttenuation: (Q E) If this attribute is FALSE, the default, then the
attenuation makes the field's effect decrease as the affected point is further from the
volume's ax
:param magnitude: (Q E) Strength of field
:param maxDistance: (Q E) Maximum distance at which field is exerted -1 indicates that the
field has no maximum distance
:param name: (Q E) name of field
:param perVertex: (Q E) Per-vertex application If this flag is set true, then each
individual point (CV, particle, vertex,etc.) of the chosen object exerts an identical cop
:param position: (Q E M) Position in space (x,y,z) where you want to place a gravity field
The gravity then emanates from this position in space rather than from an object
:param torusSectionRadius: (Q E) Section radius for a torus volume Applies only to torus
Similar to the section radius in the torus modelling primitive
:param turbulence: (Q E) Adds a force simulating a turbulent wind that evolves over time
:param turbulenceFrequencyX: (Q E) The repeats of the turbulence function in X
:param turbulenceFrequencyY: (Q E) The repeats of the turbulence function in Y
:param turbulenceFrequencyZ: (Q E) The repeats of the turbulence function in Z
:param turbulenceOffsetX: (Q E) The translation of the turbulence function in X
:param turbulenceOffsetY: (Q E) The translation of the turbulence function in Y
:param turbulenceOffsetZ: (Q E) The translation of the turbulence function in Z
:param turbulenceSpeed: (Q E) The rate of change of the turbulence over time The
turbulence loops seamlessly every 1.0/turbulenceSpeed seconds To animate this rate attach
a new
:param volumeExclusion: (Q E) Volume exclusion of the field If true, points outside the
volume (defined by the volume shape attribute) are affected, If false, points inside the v
:param volumeOffset: (Q E) Volume offset of the field Volume offset translates the field's
volume by the specified amount from the actual field location This is in the field'
:param volumeShape: (Q E) Volume shape of the field Sets/edits/queries the field's volume
shape attribute If set to any value other than "none", determines a 3-D volume with
:param volumeSweep: (Q E) Volume sweep of the field Applies only to sphere, cone, cylinder,
and torus Similar effect to the sweep attribute in modelling
:returns: Command result
"""
pass
def IncrementAndSave(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveShrinkWrapTarget(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def character(*args, addElement: name=None, addOffsetObject: Union[AnyStr, bool]="",
characterPlug: bool=True, clear: name=None, empty: bool=True, excludeDynamic:
bool=True, excludeRotate: bool=True, excludeScale: bool=True, excludeTranslate:
bool=True, excludeVisibility: bool=True, flatten: name=None, forceElement:
name=None, include: name=None, intersection: Union[name, bool]=None,
isIntersecting: Union[name, bool]=None, isMember: Union[name, bool]=None,
library: bool=True, memberIndex: Union[int, bool]=0, name: AnyStr="", noWarnings:
bool=True, nodesOnly: bool=True, offsetNode: bool=True, remove: name=None,
removeOffsetObject: AnyStr="", root: AnyStr="", scheduler: bool=True, split:
name=None, subtract: Union[name, bool]=None, text: Union[AnyStr, bool]="", union:
Union[name, bool]=None, userAlias: Union[name, bool]=None, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command is used to manage the membership of a character Characters are a type of set
that gathers together the attributes of a node or nodes that a user wishes to animate as a
single entity
:param addElement: (E) Adds the list of items to the given character If some of the items
cannot be added to the character because they are in another character, the comma
:param addOffsetObject: (Q E) Indicates that the selected character member objects should
be used when calculating and applying offsets The flag argument is used to specify the c
:param characterPlug: (Q) Returns the plug on the character that corresponds to the
specified character member
:param clear: (E) An operation which removes all items from the given character
:param empty: (C) Indicates that the character to be created should be empty (i.e it
ignores any arguments identifying objects to be added to the character
:param excludeDynamic: (C) When creating the character, exclude dynamic attributes
:param excludeRotate: (C) When creating the character, exclude rotate attributes from
transform-type nodes
:param excludeScale: (C) When creating the character, exclude scale attributes from
transform-type nodes
:param excludeTranslate: (C) When creating the character, exclude translate attributes from
transform-type nodes For example, if your character contains joints only, perhaps you
:param excludeVisibility: (C) When creating the character, exclude visibility attribute
from transform-type nodes
:param flatten: (E) An operation that flattens the structure of the given character That
is, any characters contained by the given character will be replaced by its mem
:param forceElement: (E) For use in edit mode only Forces addition of the items to the
character If the items are in another character which is in the character partition,
:param include: (E) Adds the list of items to the given character If some of the items
cannot be added to the character, a warning will be issued This is a less strict
:param intersection: (Q) An operation that returns a list of items which are members of all
the character in the list In general, characters should be mutually exclusive
:param isIntersecting: (Q) An operation which tests whether or not the characters in the
list have common members In general, characters should be mutually exclusive, so this
:param isMember: (Q) An operation which tests whether or not all the given items are
members of the given character
:param library: (Q) Returns the clip library associated with this character, if there is
one A clip library will only exist if you have created clips on your character
:param memberIndex: (Q) Returns the memberIndex of the specified character member if used
after the query flag Or if used before the query flag, returns the member that cor
:param name: (C) Assigns string as the name for a new character Valid for operations that
create a new character
:param noWarnings: (C) Indicates that warning messages should not be reported such as when
trying to add an invalid item to a character (used by UI)
:param nodesOnly: (Q) This flag modifies the results of character membership queries When
listing the attributes (e.g sphere1.tx) contained in the character, list only t
:param offsetNode: (Q) Returns the name of the characterOffset node used to add offsets to
the root of the character
:param remove: (E) Removes the list of items from the given character
:param removeOffsetObject: (E) Indicates that the selected character offset objects should
be removed as offsets The flag argument is used to specify the character
:param root: (C) Specifies the transform node which will act as the root of the character
being created This creates a characterOffset node in addition to the charac
:param scheduler: (Q) Returns the scheduler associated with this character, if there is one
A scheduler will only exist if you have created clips on your character
:param split: (C) Produces a new set with the list of items and removes each item in the
list of items from the given set
:param subtract: (Q) An operation between two characters which returns the members of the
first character that are not in the second character In general, characters sho
:param text: (C Q E) Defines an annotation string to be stored with the character
:param union: (Q) An operation that returns a list of all the members of all characters
listed
:param userAlias: (Q) Returns the user defined alias for the given attribute on the
character or and empty string if there is not one Characters automatically alias the a
:returns: For creation operations (name of the character that was created or edited)
"""
pass
def SelectAllStrokes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def timeWarp(*args, deleteFrame: int=0, frame: Union[float, List[float], bool]=0.0, g:
bool=True, interpType: Union[List[int, AnyStr], bool]=None, moveFrame:
Union[List[int, float], bool]=None, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command is used to create a time warp input to a set of animation curves
:param deleteFrame: (E) The flag value indicates the 0-based index of the warp frame to
delete This flag can only be used in edit mode
:param frame: (C Q E M) In create and edit mode, this flag can be used to specify warp
frames added to the warp operation In query mode, this flag returns a list of the fra
:param g: (C Q E) In create mode, creates a global time warp node which impacts every
animated object in the scene In query mode, returns the global time warp node N
:param interpType: (C Q E) This flag can be used to set the interpolation type for a given
span Valid interpolation types are linear, easeIn and easeOut When queried, it retu
:param moveFrame: (Q E) This flag can be used to move a singular warp frame The first
value specified indicates the 0-based index of the warp frame to move The second valu
:returns: timeWarp name
"""
pass
def containerTemplate(*args, addBindingSet: AnyStr="", addNames: bool=True, addView: AnyStr="",
allKeyable: bool=True, attribute: Union[AnyStr, List[AnyStr]]="",
attributeList: Union[AnyStr, bool]="", baseName: Union[AnyStr, bool]="",
bindingSetList: Union[AnyStr, bool]="", childAnchor: bool=True, delete:
bool=True, expandCompounds: bool=True, fromContainer: AnyStr="",
fromSelection: bool=True, layoutMode: int=0, matchName: Union[AnyStr,
bool]="", parentAnchor: bool=True, publishedNodeList: Union[AnyStr,
bool]="", removeBindingSet: AnyStr="", removeView: AnyStr="",
rootTransform: bool=True, save: bool=True, searchPath: Union[AnyStr,
bool]="", templateList: Union[AnyStr, bool]="", updateBindingSet:
AnyStr="", useHierarchy: bool=True, exists: bool=True, fileName:
Union[AnyStr, bool]="", force: bool=True, load: bool=True, matchFile:
Union[AnyStr, bool]="", silent: bool=True, unload: bool=True, viewList:
Union[AnyStr, bool]="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
A container template is a description of a container's published interface This command
provides the ability to create and save a template file for a container or load an existing
template file Once a template exists, the user can query the template information
:param addBindingSet: (C E) This argument is used to add a new binding set with the given
name to a template A default binding set will be created If the binding set already e
:param addNames: (E) In edit mode, when used with the fromContainer flag, any published
name on the container not present as an attribute on the template will be added to
:param addView: (C E) This argument is used to add a new view with the given name to a
template By default a view containing a flat list of all template attributes will b
:param allKeyable: (C E) Used when the fromSelection flag is true and fromContainer is
false If true we will use all keyable attributes to define the template or the view, i
:param attribute: (C E M) If fromSelection is true and allKeyable is false, this attribute
name will be used to create an attribute item in the template file
:param attributeList: (C Q E) Used in query mode, returns a list of attributes contained in
the template definition
:param baseName: (C Q) Used in query mode, returns the base name of the template The
basename is the template name with any package qualifiers stripped off
:param bindingSetList: (C Q) Used in query mode, returns a list of all binding sets defined
on the template
:param childAnchor: (C Q) This flag can be optionally specified when querying the
publishedNodeList The resulting list will contain only childAnchor published nodes
:param delete: (C) Delete the specified template and its file All objects that are
associated with this template or contained in the same template file will be deleted
:param expandCompounds: (C E) This argument is used to determine how compound parent
attributes and their children will be added to generated views when both are published to
the
:param fromContainer: (C) This argument is used in create or edit mode to specify a
container node to be used for generating the template contents In template creation mode,
:param fromSelection: (C E) If true, we will use the active selection list to create the
template or the view If allKeyable is also true then we will create the template from a
:param layoutMode: (C) This argument is used to specify the layout mode when creating a
view Values correspond as follows: 0: layout in flat list (default when not creatin
:param matchName: (Q) Used in query mode in conjunction with other flags this flag
specifies an optional template name that is to be matched as part of the query operation
:param parentAnchor: (C Q) This flag can be optionally specified when querying the
publishedNodeList The resulting list will contain only parentAnchor published nodes
:param publishedNodeList: (C Q E) Used in query mode, returns a list of published nodes
contained in the template definition By default all published nodes on the template will
be re
:param removeBindingSet: (C E) This argument is used to remove the named binding set from
the template The template must be saved before the binding set is permanently removed fro
:param removeView: (C E) This argument is used to remove the named view from the template
The template must be saved before the view is permanently removed from the template
:param rootTransform: (C Q) This flag can be optionally specified when querying the
publishedNodeList The resulting list will contain only rootTransform published nodes
:param save: (C) Save the specified template to a file If a filename is specified for the
template, the entire file (and all templates associated with it) will be sa
:param searchPath: (Q E) The template searchPath is an ordered list of all locations that
are being searched to locate template files (first location searched to last locatio
:param templateList: (Q) Used in query mode, returns a list of all loaded templates This
query can be used with optional matchFile and matchName flags When used with the ma
:param updateBindingSet: (C E) This argument is used to update an existing binding set with
new bindings When used with the fromContainer argument binding set entries with be repl
:param useHierarchy: (C E) If true, and the fromSelection flag is set, the selection list
will expand to include it's hierarchy also
:param exists: (Q) Returns true or false depending upon whether the specified template
exists When used with the matchFile argument, the query will return true if the
:param fileName: (C Q) Specifies the filename associated with the template This argument
can be used in conjunction with load, save or query modes If no filename is assoc
:param force: (C) This flag is used with some actions to allow them to proceed with an
overwrite or destructive operation When used with load, it will allow an existi
:param load: () Load an existing template from a file If a filename is specified for the
template, the entire file (and all templates in it) will be loaded If no f
:param matchFile: (Q) Used in query mode in conjunction with other flags this flag
specifies an optional file name that is to be matched as part of the query operation In
:param silent: (C Q E) Silent mode will suppress any error or warning messages that would
normally be reported from the command execution The return values are unaffected
:param unload: (C) Unload the specified template This action will not delete the
associated template file if one exists, it merely removes the template definition from
:param viewList: (C Q) Used in query mode, returns a list of all views defined on the
template
:returns:
"""
pass
def FBXImportSetLockedAttribute(*args, **kwargs)->None:
"""
"""
pass
def CutSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorGraphUpstream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportScaleFactor(*args, **kwargs)->None:
"""
"""
pass
def ToggleTangentDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dbcount(*args, enabled: bool=True, file: AnyStr="", keyword: AnyStr="", list: bool=True,
maxdepth: int=0, quick: bool=True, reset: bool=True, spreadsheet: bool=True,
**kwargs)->None:
"""
The dbcount command is used to print and manage a list of statistics collected for counting
operations These statistics are displayed as a list of hits on a particular location in
code, with added reference information for pointers/strings/whatever If -reset is not
specified then statistics are printed
:param enabled: (C) Set the enabled state of the counters ('on' to enable, 'off' to
disable) Returns the list of all counters affected
:param file: (C) Destination file of the enabled count objects Use the special names
stdout and stderr to redirect to your command window As well, the special name
:param keyword: (C) Print only the counters whose name matches this keyword (default is
all)
:param list: (C) List all available counters and their current enabled status (The only
thing you can do when counters are disabled.)
:param maxdepth: (C) Maximum number of levels down to traverse and report 0 is the default
and it means continue recursing as many times as are requested
:param quick: (C) Display only a summary for each counter type instead of the full details
:param reset: (C) Reset all counters back to 0 and remove all but the top level counters
Returns the list of all counters affected
:param spreadsheet: (C) Display in spreadsheet format instead of the usual nested braces
This will include a header row that contains 'Count Level1 Level2 Level3...', makin
:returns:
"""
pass
def PolyExtrudeEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RandomizeFollicles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def bakePartialHistory(*args, allShapes: bool=True, postSmooth: bool=False, preCache: bool=True,
preDeformers: bool=True, prePostDeformers: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command is used to bake sections of the construction history of a shape node when
possible A typical usage would be on a shape that has both modelling operations and
deformers in its history Using this command with the -prePostDeformers flag will bake the
modeling portions of the graph, so that only the deformers remain Note that not all
m
:param allShapes: (C Q) Specifies that the bake operation should be performed on all shapes
in the entire scene By default, only selected objects are baked If this option
:param postSmooth: (C Q) Specifies whether or not a smoothing operation should be done on
skin vertices This smoothing is only done on vertices that are found to deviate lar
:param preCache: (C Q) Specifies baking of any history operations that occur before the
caching operation, including deformers In query mode, returns a list of the nodes t
:param preDeformers: (C Q) Specifies baking of any modeling operations in the history that
occur before the deformers In query mode, returns a list of the nodes that will be b
:param prePostDeformers: (C Q) Specifies baking of all modeling operations in the history
whether they are before or after the deformers in the history If neither the -prePostDefo
:returns: name of shapes that were baked
"""
pass
def hotkeyEditor(*args, **kwargs)->None:
"""
"""
pass
def file(*args, absoluteName: bool=True, activate: bool=True, activeProxy: bool=True, add:
bool=True, anyModified: bool=True, applyTo: AnyStr="", buildLoadSettings: bool=True,
channels: bool=True, cleanReference: AnyStr="", command: Union[List[AnyStr, AnyStr],
bool]=None, compress: bool=True, constraints: bool=True, constructionHistory:
bool=True, copyNumberList: bool=True, defaultExtensions: bool=True, defaultNamespace:
bool=True, deferReference: bool=False, editCommand: AnyStr="", errorStatus: bool=True,
executeScriptNodes: bool=True, exists: bool=True, expandName: bool=True, exportAll:
bool=True, exportAnim: bool=True, exportAnimFromReference: bool=True,
exportAsReference: bool=True, exportAsSegment: bool=True, exportSelected: bool=True,
exportSelectedAnim: bool=True, exportSelectedAnimFromReference: bool=True,
exportSelectedNoReference: bool=True, exportSelectedStrict: bool=True,
exportSnapshotCallback: List[Script, AnyStr]=None, exportUnloadedReferences: bool=True,
expressions: bool=True, fileMetaData: bool=True, flushReference: AnyStr="", force:
bool=True, groupLocator: bool=True, groupName: AnyStr="", groupReference: bool=True,
ignoreVersion: bool=True, i: bool=True, importFrameRate: bool=True, importReference:
bool=True, importTimeRange: AnyStr="", lastFileOption: bool=True, lastTempFile:
bool=True, list: bool=True, loadAllDeferred: bool=True, loadAllReferences: bool=True,
loadNoReferences: bool=True, loadReference: Union[AnyStr, bool]="",
loadReferenceDepth: AnyStr="", loadReferencePreview: AnyStr="", loadSettings:
AnyStr="", location: bool=True, lockContainerUnpublished: bool=True, lockFile:
bool=True, lockReference: bool=True, mapPlaceHolderNamespace: Union[List[AnyStr,
AnyStr], List[List[AnyStr, AnyStr]], bool]=None, mergeNamespaceWithParent: bool=True,
mergeNamespaceWithRoot: bool=True, mergeNamespacesOnClash: bool=True, modified:
bool=True, moveSelected: bool=True, namespace: AnyStr="", newFile: bool=True, open:
bool=True, options: Union[AnyStr, bool]="", parentNamespace: bool=True,
postSaveScript: AnyStr="", preSaveScript: AnyStr="", preserveName: bool=True,
preserveReferences: bool=True, preview: bool=True, prompt: bool=True, proxyManager:
AnyStr="", proxyTag: AnyStr="", reference: bool=True, referenceDepthInfo: int=0,
referenceNode: Union[AnyStr, bool]="", relativeNamespace: AnyStr="",
removeDuplicateNetworks: bool=True, removeReference: bool=True, rename: AnyStr="",
renameAll: bool=True, renameToSave: bool=False, renamingPrefix: Union[AnyStr, bool]="",
renamingPrefixList: bool=True, replaceName: Union[List[AnyStr, AnyStr],
List[List[AnyStr, AnyStr]], bool]=None, resetError: bool=True, returnNewNodes:
bool=True, save: bool=True, saveDiskCache: Union[AnyStr, bool]="always",
saveReference: bool=True, saveReferencesUnloaded: bool=True, saveTextures:
Union[AnyStr, bool]="unlessRef", sceneName: bool=True, segment: AnyStr="", selectAll:
bool=True, shader: bool=True, sharedNodes: Union[AnyStr, List[AnyStr]]="",
sharedReferenceFile: bool=True, shortName: bool=True, strict: bool=True,
swapNamespace: Union[List[AnyStr, AnyStr], List[List[AnyStr, AnyStr]]]=None, type:
Union[AnyStr, bool]="", uiConfiguration: bool=True, unloadReference: AnyStr="",
unresolvedName: bool=True, usingNamespaces: bool=True, withoutCopyNumber: bool=True,
writable: bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
Opening, importing, exporting, referencing, saving, or renaming a file This command needs
a single main flag that specifies the action to take Some of the main flags also take
optional secondary flags to modify that action The main flags are: cr ea ean ear eas er
esa es esn ex fr i ir l lr lrp loc ltf mf new o op ot pmt r rdi rn rr rts s sa s
:param absoluteName: (C Q) This is a general flag which can be used to specify the desired
format for the namespace(s) returned by the command The absolute name of the namespa
:param activate: () This flag is obsolete
:param activeProxy: (C) This flag is intended for internal use by Maya during file
referencing It specifes which file is the active proxy when the file is loaded when used
:param add: (C) When used with selectAll it indicates that the specified items should be
added to the active list without removing existing items from the active lis
:param anyModified: (Q) This flag is obsolete Please use file -q -modified instead
:param applyTo: (C) When importing or referencing an offline edit file, apply it to to the
given reference (i.e., determine what <main> gets mapped to) Specify the refe
:param buildLoadSettings: (C) When used with the "o/open" flag it indicates that the
specified file should be read for reference hierarchy information only This information
will
:param channels: (C Q) For use with exportSelected to specify whether attached channels
should be included in the export
:param cleanReference: (C) Remove edits from the passed in reference node The reference
must be in an unloaded state To remove a particular type of edit, use the editCommand
:param command: (C Q) Specifies the callback to execute before any file operation This is
an internal flag used only in the file format
:param compress: (C) When used with save, it will compress (gzip) the file on output
:param constraints: (C Q) For use with exportSelected to specify whether attached
constraints should be included in the export
:param constructionHistory: (C Q) For use with exportSelected to specify whether attached
construction history should be included in the export
:param copyNumberList: (Q) When queried, this flag returns a string array containing a
number that uniquely identifies each instance the file is used
:param defaultExtensions: (C Q) Use the default extensions to rename the files This
defaults to true, but is a persistent setting within a given session of Maya, meaning that
if yo
:param defaultNamespace: (C) Use the default name space for import and referencing This is
an advanced option If set, then on import or reference, Maya will attempt to place al
:param deferReference: (C Q) When used in conjunction with the -reference flag, this flag
determines if the reference is loaded, or if loading is deferred C: The default is fals
:param editCommand: (C) For use with cleanReference Remove only this type of edit
Supported edits are: setAttr addAttr deleteAttr connectAttr disconnectAttr and parent
:param errorStatus: (Q) Query the error status of the last file read Returns true if and
error occurred during the last file read
:param executeScriptNodes: (C) If true, allow the appropriate script nodes to execute If
false, do not allow any script node scripts to run For more information, see the document
:param exists: (Q) Query if the file exists Returns true if the file exists
:param expandName: (Q) This is a query only flag that can be used to query for the file
path name of the file
:param exportAll: (C) Export everything into a single file Returns the name of the
exported file
:param exportAnim: (C) Export all animation nodes and animation helper nodes from all
objects in the scene The resulting animation export file will contain connections to
:param exportAnimFromReference: (C) Export the main scene animation nodes and animation
helper nodes from all referenced objects This flag, when used in conjunction with the
-rfn/refer
:param exportAsReference: (C) Export the selected objects into a reference file with the
given name The file is saved on disk during the process Returns the name of the referenc
:param exportAsSegment: () This flag is obsolete
:param exportSelected: (C) Export the selected items into the specified file Returns the
name of the exported file
:param exportSelectedAnim: (C) Export all animation nodes and animation helper nodes from
the selected objects in the scene See -ean/exportAnim flag description for details on usa
:param exportSelectedAnimFromReference: (C) Export the main scene animation nodes and
animation helper nodes from the selected referenced objects This flag, when used in
conjunction with the -
:param exportSelectedNoReference: () This flag is obsolete
:param exportSelectedStrict: (C) Export the selected items into the specified file This
flag differs from exportSelected in that it will only export the nodes that are explicitly
on
:param exportSnapshotCallback: (C) When specified alongside -ea/exportAll,
es/exportSelected and -ess/exportSelectedStrict, this flag enables Maya to temporarily
duplicate the export t
:param exportUnloadedReferences: (C) Only effective when preserveReferences is used When
used with the exportAll flag, tells the exporter to include all unloaded references in the
expor
:param expressions: (C Q) For use with exportSelected to specify whether attached
expressions should be included in the export
:param fileMetaData: (Q) This is a query only flag to get the file metadata for audio files
It returns the referenceTime This field is only extracted from BWAVE files, for
:param flushReference: (C) This flag will unload the reference file associated with the
passed reference node, retaining all associated reference nodes and scene files ** This
:param force: (C) Force an action to take place (new, open, save, remove reference, unload
reference) Used with removeReference to force remove reference namespace ev
:param groupLocator: (C) Used only with the -r and the -gr flag Used to group the output
of groupReference under a locator
:param groupName: (C) Used only with the -gr flag Optionally used to set the name of the
transform node that the imported/referenced items will be grouped under
:param groupReference: (C) Used only with the -r or the -i flag Used to group all the
imported/referenced items under a single transform
:param ignoreVersion: (C) Used to open files with version greater or less than those
officially supported Data loss, data corruption or failure to open altogether are all pos
:param i: (C) Import the specified file Returns the name of the imported file
:param importFrameRate: (C) Used only with the -i flag Used to import the frame rate and
set it as Maya's frame rate
:param importReference: (C) Remove the encapsulation of the reference around the data
within the specified file This makes the contents of the specified file part of the
curren
:param importTimeRange: (C) Used only with the -i flag Used to import the time range and
apply it to Maya's playback range in one of three different ways as specified by the st
:param lastFileOption: (Q) On query, returns the last option string used by the file
command
:param lastTempFile: (Q) When queried, this flag returns the temp file name used during
file save The temp file will be left in the same directory as the intended file name
:param list: (Q) List all files Returns a string array of the names of all
segment/reference files Duplicates will be removed So if a file is referenced more than
:param loadAllDeferred: (C) This flag is obsolete, and has been replaced by the
loadReferenceDepth flag When used with the -open flag, determines if the -deferReference
flag is
:param loadAllReferences: (C) This flag is obsolete and has been replaced with the
loadReferenceDepth flag When used with the -open flag, this will cause all references to
be loa
:param loadNoReferences: (C) This flag is obsolete and has been replaced witht the
loadReferenceDepth flag When used with the -open flag, no references will be loaded When
used
:param loadReference: (C Q) This flag loads a file and associates it with the passed
reference node If the reference node does not exist, the command will fail If the file
is
:param loadReferenceDepth: (C) Used to specify which references should be loaded Valid
types are "all", "none" and "topOnly", which will load all references, no references and
top
:param loadReferencePreview: (C) This flag will perform a special preview-only load of a
reference file A preview-only reference file is not completely loaded, but instead is
partia
:param loadSettings: (C) When used with the "o/open" flag this flag specifies which
reference load settings should be used Reference load settings specify which references s
:param location: (Q) Query the location of the given file name
:param lockContainerUnpublished: (C) Set the unpublised lock state for all containers in
this file This will not lock the attributes in the main scene directly, but any file that
refere
:param lockFile: (C) Lock or unlock the main scene Any file referencing this scene will
automatically lock all attributes and nodes Also prevents reference edits from b
:param lockReference: (C) Locks attributes and nodes from the referenced file
:param mapPlaceHolderNamespace: (C Q E M) Map a placeHolderNamespace to the given reference
Must be used with the file -i/import, -r/reference flags in create mode The first string
is the p
:param mergeNamespaceWithParent: (C) Used with the removeReference flag When removing a
file reference and its namespace, move the rest of the namespace content to parent
namespace Can
:param mergeNamespaceWithRoot: (C) Used with the removeReference flag When removing a file
reference and its namespace, move the rest of the namespace content to root namespace
Canno
:param mergeNamespacesOnClash: (C) Used with the import, reference or edit flags, this
option will prevent new namespaces from being created when namespaces of the same name
already ex
:param modified: (C Q) Set the modified state of the entire scene If the scene is modified
it will need to be saved before a new file is opened or created Normally there
:param moveSelected: (E) This flag is obsolete
:param namespace: (E) The namespace name to use that will group all objects during
importing and referencing Change the namespace used to group all the objects from the s
:param newFile: (C) Initialize the scene Returns untitled scene with default location
:param open: (C) Open the specified file Returns the name of the opened file
:param options: (C Q) Set/query the currently set file options file options are used while
saving a maya file Two file option flags supported in current file command are
:param parentNamespace: (Q) Returns the name(s) of a referenced file's parent namespaces
:param postSaveScript: (C) When used with the save flag, the specified script will be
executed after the file is saved
:param preSaveScript: (C) When used with the save flag, the specified script will be
executed before the file is saved
:param preserveName: (C) When used with compress, it will retain the regular extension
rather than appending .gz
:param preserveReferences: (C) Modifies the various import/export flags such that
references are imported/exported as actual references rather than copies of those
references
:param preview: (C) Used in conjunction with any of the -exportXXX flags, causes Maya to
return a list of the nodes that would be exported, without actually writing the
:param prompt: (C Q) This flag controls the display of file prompting dialogs Some
examples of file prompting dialogs include error messages that require user confirmati
:param proxyManager: (C) When a one or more proxy references are added to an existing file
reference, the proxy manage node is used to define the proxies associated with that
:param proxyTag: (C) This flag is intended for internal use only during file load or
preload Proxy tags are names you assign to proxy references to more easily manage th
:param reference: (Q) Create a reference to the specified file Returns the name of the
file referenced Query all file references from the specified file
:param referenceDepthInfo: (C) This flag is used to store reference loading preferences
associated with a Maya ascii file (.ma) This flag is only useful during file I/O so users
s
:param referenceNode: (Q) This flag is only used during queries In MEL, if it appears
before -query then it must be followed by the name of one of the scene's reference nodes
:param relativeNamespace: (C) This flag can be used with the exportSelected,
exportSelectedStrict and exportAll operations to specify that the nodes in the exported
file are to be
:param removeDuplicateNetworks: (C) When set, Maya will remove imported networks if the
same network is also detected in the current scene You can explicitly specify that certain
types
:param removeReference: (C) Remove the given file reference from its parent This will also
Remove everything this file references Returns the name of the file removed If the
:param rename: (C) Rename the scene Used mostly during save to set the saveAs name
Returns the new name of the scene
:param renameAll: (C) If true, rename all newly-created nodes, not just those whose names
clash with existing nodes Only available with -i/import
:param renameToSave: (C Q) If true, the scene will need to be renamed before it can be
saved When queried this flag returns true if the scene must be renamed before it can be
:param renamingPrefix: (C Q) The string to use as a prefix for all objects from this file
This flag has been replaced by -ns/namespace
:param renamingPrefixList: (Q) This flag returns a list of all of the renaming prefixes
used by the file
:param replaceName: (C Q E M) Define a search and replace string Will apply search and
replace to leaf node names The search string can include namespaces and wild-cards, but
wi
:param resetError: (C) Turn off any pre-existing global file errors
:param returnNewNodes: (C) Used to control the return value in open, import, loadReference,
and reference operations It will force the file command to return a list of new nod
:param save: (C) Save the specified file Returns the name of the saved file
:param saveDiskCache: (C Q) This flag sets the saveAs option for Jiggle disk caches The
valid inputs are "always" - always copy a file texture to a new location, "never" - do n
:param saveReference: (C) Save reference node edits and connections to reference file This
includes newly added history and animation, provided that these do not apply to any
:param saveReferencesUnloaded: (C) This flag can only be used in conjunction with the save
flag It specifies that the saved file will be saved with all references unloaded
:param saveTextures: (C Q) This flag sets the saveAs option for 3d Paint file textures The
valid inputs are "always" - always copy a file texture to a new location, "unlessRef
:param sceneName: (Q) return the name of the current scene
:param segment: () This flag is obsolete
:param selectAll: (C) Select all the components of this file as well as its child files
Note that the file specified must be one that is already opened in this Maya sessi
:param shader: (C Q) For use with exportSelected to specify whether attached shaders should
be included in the export
:param sharedNodes: (C M) This flag modifies the '-r/reference' flag to indicate that
certain types of nodes within that reference should be treated as shared nodes All share
:param sharedReferenceFile: (C) Can only be used in conjunction with the -r/reference flag
and the -ns/namespace flag (there is no prefix support) This flag modifies the '-r/refere
:param shortName: (Q) When used with a main query flag it indicates that the file name
returned will be the short name (i.e., just a file name without any directory paths)
:param strict: (C) Set strict file path resolution If true, all paths will be matched
exactly, both relative and absolute Relative paths will be considered relative t
:param swapNamespace: (C M) Can only be used in conjunction with the -r/reference or
-i/import flags This flag will replace any occurrences of a given namespace to an
alternate
:param type: (C Q) Set the type of this file By default this can be any one of:
"mayaAscii", "mayaBinary", "mel", "OBJ", "directory", "plug-in", "audio", "move", "EPS"
:param uiConfiguration: (C Q) Save the ui configuration with the scene in a uiConfiguration
script node (eg panes, etc.) The current default is on and is set in initialStartup.m
:param unloadReference: (C) This flag will unload the reference file associated with the
passed reference node
:param unresolvedName: (Q) When used with a main query flag it indicates that the file name
returned will be unresolved (i.e., it will be the path originally specified when the
:param usingNamespaces: (Q) Returns boolean Queries whether the specified reference file
uses namespaces or renaming prefixes
:param withoutCopyNumber: (Q) When used with a main query flag it indicates that the file
name returned will not have a copy number appended to the end If this flag is not presen
:param writable: (Q) Query whether the given file is writable in the current scene For
main scene files this indicates writable to the file system by the current user F
:returns: The name of the specified file for most actions. When the returnNewNodes flag is
used, an array of strings will be returned indicating the names of the nodes that were
read.
"""
pass
def polyRemesh(*args, caching: bool=True, constructionHistory: bool=True, interpolationType:
Union[int, bool]=0, name: AnyStr="", nodeState: Union[int, bool]=0,
reduceThreshold: Union[float, bool]=0.0, refineThreshold: Union[float, bool]=0.0,
smoothStrength: Union[float, bool]=0.0, tessellateBorders: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Triangulates, then remeshes the given mesh through edge splitting and collapsing Edges
longer than the specified refinement threshold are split, and edges shorter than the
reduction threshold are collapsed
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param interpolationType: (C Q E) Algorithm used for interpolating new vertices
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param reduceThreshold: (C Q E) A percentage of the refineThreshold Edges shorter than
this percentage will be reduced to a single vertex
:param refineThreshold: (C Q E) Triangle edges longer than this value will be split into
two edges
:param smoothStrength: (C Q E) Amount of smoothing applied to the vertices after remeshing
:param tessellateBorders: (C Q E) Specifies if the borders of the selected region are
allowed to be remeshed
:returns: The node name.
"""
pass
def BevelOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AffectSelectedObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def QuadrangulateOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def inViewEditor(*args, visible: bool=True, q=True, query=True, **kwargs)->Union[None, Any]:
"""
Mel access to the In-View Editor In-View Editors display a customizable subset of a node's
attributes, letting you adjust attributes directly in a scene instead of opening the
Channel Box or Attribute Editor
:param visible: (C Q) Shows/hides the In-View Editor outside the Show Manips context
:returns:
"""
pass
def poseInterpolator(*args, **kwargs)->None:
"""
"""
pass
def lockNode(*args, ignoreComponents: bool=True, lock: bool=True, lockName: bool=True,
lockUnpublished: bool=True, q=True, query=True, **kwargs)->Union[List[bool], Any]:
"""
Locks or unlocks one or more dependency nodes A locked node is restricted in the following
ways: It may not be deleted It may not be renamed Its parenting may not be changed
Attributes may not be added to or removed from it Locked attributes may not be unlocked
Unlocked attributes may not be locked Note that an unlocked attribute of a loc
:param ignoreComponents: (C Q) Normally, the presence of a component in the list of objects
to be locked will cause the command to fail with an error But if this flag is supplied
:param lock: (C Q) Specifies the new lock state for the node The default is true
:param lockName: (C Q) Specifies the new lock state for the node's name
:param lockUnpublished: (C Q) Used in conjunction with the lock flag On a container, lock
or unlock all unpublished attributes on the members of the container For non-containers
:returns: For query execution.
"""
pass
def dgInfo(*args, allNodes: bool=True, connections: bool=True, dirty: bool=True, nodes:
bool=True, nonDeletable: bool=True, outputFile: AnyStr="", propagation: bool=True,
short: bool=True, size: bool=True, subgraph: bool=True, type: AnyStr="",
**kwargs)->None:
"""
This command prints information about the DG in plain text The scope of the information
printed is the entire graph if the all flag is used, the nodes/plugs on the command line if
they were specified, and the selection list, in that order Each plug on a connection will
have two pieces of state information displayed together at the end of the line
:param allNodes: (C) Use the entire graph as the context
:param connections: (C) Print the connection information
:param dirty: (C) Only print dirty/clean nodes/plugs/connections Default is both
:param nodes: (C) Print the specified nodes (or the entire graph if -all is used)
:param nonDeletable: (C) Include non-deletable nodes as well (normally not of interest)
:param outputFile: (C) Send the output to the file FILE instead of STDERR
:param propagation: (C) Only print propagating/not propagating nodes/plugs/connections
Default is both
:param short: (C) Print using short format instead of long
:param size: (C) Show datablock sizes for all specified nodes Return value is tuple of all
selected nodes (NumberOfNodes, NumberOfDatablocks, TotalDatablockMemory)
:param subgraph: (C) Print the subgraph affected by the node or plugs (or all nodes in the
graph grouped in subgraphs if -all is used)
:param type: (C) Filter output to only show nodes of type NODETYPE
:returns:
"""
pass
def UnpublishParentAnchor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OpenSceneOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_slideEdge(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cMuscleQuery(*args, **kwargs)->None:
"""
"""
pass
def headsUpMessage(*args, horizontalOffset: int=0, object: AnyStr="", selection: bool=True,
time: float=0.0, uvTextureEditor: bool=True, verticalOffset: int=0,
viewport: bool=True, **kwargs)->None:
"""
This command draws a message in the 3d view The message is automatically erased at the
next screen refresh
:param horizontalOffset: (C) If this flag is specified, the message will appear the
specified distance (in pixels) to the right of the point Otherwise, a default horizontal
offs
:param object: (C) If an object is specified, then the message is drawn just above the
object's bounding-box centre point If this flag is not specified, or the object
:param selection: (C) If this flag is specified, the message will be centred among the
currently selected objects This flag does nothing if the object flag is also specif
:param time: (C) If this flag is specified, the message will be displayed for a minimum of
the given amount of time (in seconds) Otherwise a default time of 1.0 seco
:param uvTextureEditor: (C) Should the HUD be shown in the UV Texture Editor?
:param verticalOffset: (C) If this flag is specified, the message will appear the specified
distance (in pixels) above the point Otherwise, a default vertical offset of 0 pixe
:param viewport: (C) Should the HUD be shown in the viewport?
:returns:
"""
pass
def MakeBrushSpring(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MatchScaling(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Art3dPaintToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InTangentLinear(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def keyframeRegionCurrentTimeCtx(*args, exists: bool=True, history: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="",
image3: Union[AnyStr, bool]="", name: AnyStr="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a context which may be used to change current time within the keyframe
region of the dope sheet editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Context name
"""
pass
def FBXExportTriangulate(*args, **kwargs)->None:
"""
"""
pass
def keyframeRegionMoveKeyCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", option: Union[AnyStr, bool]="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a context which may be used to move keyframes within the keyframe
region of the dope sheet editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param option: (C Q E) Valid values are "move," "insert," "over," and "segmentOver"
Specifies the keyframe -option to use When you "move" a key, the key will not cross ov
:returns: Context name
"""
pass
def RadialOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AlembicHelp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UpdateCurrentSceneMotionBuilder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintEffectsMeshQuality(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyToCurve(*args, **kwargs)->None:
"""
"""
pass
def ptexBake(*args, **kwargs)->None:
"""
"""
pass
def xgmInterpSetup(*args, **kwargs)->None:
"""
"""
pass
def showSelectionInTitle(*args, **kwargs)->None:
"""
This command causes the title of the window specified as an argument to be linked to the
current file and selection When selection changes, the window title will change to show
the current file name and the name of the last selected object
:returns:
"""
pass
def DeleteAllNRigids(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HIKGetRemoteCharacterList(*args, **kwargs)->None:
"""
"""
pass
def BatchRender(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectContiguousEdgesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmPointsContext(*args, **kwargs)->None:
"""
"""
pass
def TransferAttributes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateSubCharacterOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_vertSelectLocked(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def currentCtx(*args, **kwargs)->AnyStr:
"""
This command returns the currently selected tool context
:returns: : The name of the currently selected tool context.
"""
pass
def polySelectConstraintMonitor(*args, changeCommand: List[AnyStr, AnyStr]=None, create:
bool=True, delete: bool=True, **kwargs)->None:
"""
Manage the window to display/edit the polygonal selection constraint parameters
:param changeCommand: (C) Specifies the mel callback to refresh the window First argument
is the callback, second is the window name
:param create: (C) Specifies the Monitor should be created
:param delete: (C) Specifies that the Monitor should be removed
:returns:
"""
pass
def texSmudgeUVContext(*args, dragSlider: Union[AnyStr, bool]="", effectType: Union[AnyStr,
bool]="", exists: bool=True, functionType: Union[AnyStr, bool]="",
history: bool=True, image1: Union[AnyStr, bool]="", image2: Union[AnyStr,
bool]="", image3: Union[AnyStr, bool]="", name: AnyStr="", pressure:
Union[float, bool]=0.0, radius: Union[float, bool]=0.0, smudgeIsMiddle:
bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a context for smudge UV tool This context only works in the texture
UV editor
:param dragSlider: (Q E) radius | none Enables the drag slider mode This is to support
brush resizing while holding the 'b' or 'B' button
:param effectType: (Q E) fixed | smudge Specifies the effect of the tool In fixed mode,
the UVs move as if they are attached by a rubber band In smudge mode the UVs are mov
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param functionType: (Q E) exponential | linear | constant Specifies how UVs fall off from
the center of influence
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param pressure: (Q E) Pressure value when effect type is set to smudge
:param radius: (Q E) Radius of the smudge tool All UVs within this radius are affected by
the tool
:param smudgeIsMiddle: (Q E) By default, the left mouse button initiates the smudge
However, this conflicts with selection When smudgeIsMiddle is on, smudge mode is activated
b
:returns: Name of the effect type created.
"""
pass
def PoseInterpolatorNewGroup(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_disableTexturesTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def arnoldBakeGeo(*args, **kwargs)->None:
"""
"""
pass
def curve(*args, append: bool=True, bezier: bool=True, degree: float=3, editPoint:
Union[List[float, float, float], List[List[float, float, float]]]=None, knot:
Union[float, List[float]]=0.0, name: AnyStr="", objectSpace: bool=True, periodic:
bool=True, point: Union[List[float, float, float], List[List[float, float,
float]]]=None, pointWeight: Union[List[float, float, float, float], List[List[float,
float, float, float]]]=None, replace: bool=True, worldSpace: bool=True,
**kwargs)->AnyStr:
"""
The curve command creates a new curve from a list of control vertices (CVs) A string is
returned containing the pathname to the newly created curve You can create a curve from
points either in world space or object (local) space, either with weights or without You
can replace an existing curve by using the "-r/replace" flag You can append a poi
:param append: (C) Appends point(s) to the end of an existing curve If you use this flag,
you must specify the name of the curve to append to, at the end of the comman
:param bezier: (C) The created curve will be a bezier curve
:param degree: (C) The degree of the new curve Default is 3 Note that you need (degree+1)
curve points to create a visible curve span eg you must place 4 points for
:param editPoint: (C M) The x, y, z position of an edit point "linear" means that this
flag can take values with units This flag can not be used with the -point or the -po
:param knot: (C M) A knot value in a knot vector One flag per knot value There must be
(numberOfPoints + degree - 1) knots and the knot vector must be non-decreasing
:param name: (C) Name of the curve
:param objectSpace: (C) Points are in object, or "local" space This is the default You
cannot specify both "-os" and "-ws" in the same command
:param periodic: (C) If on, creates a curve that is periodic Default is off
:param point: (C M) The x, y, z position of a point "linear" means that this flag can take
values with units
:param pointWeight: (C M) The x,y,z and w values of a point, where the w is a weight value
A rational curve will be created if this flag is used "linear" means that this fla
:param replace: (C) Replaces an entire existing curve If you use this flag, you must
specify the name of the curve to replace, at the end of the command (See examples
:param worldSpace: (C) Points are in world space The default is "-os" You cannot specify
both "-os" and "-ws" in the same command
:returns: The path to the new curve or the replaced curve
"""
pass
def HypershadeDisplayAsIcons(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SplitEdge(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LayoutUVAlongOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CleanupPolygonOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dollyCtx(*args, alternateContext: bool=True, boxDollyType: Union[AnyStr, bool]="",
centerOfInterestDolly: bool=True, dollyTowardsCenter: bool=True, exists: bool=True,
history: bool=True, image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="",
image3: Union[AnyStr, bool]="", localDolly: bool=True, name: AnyStr="", orthoZoom:
bool=True, scale: Union[float, bool]=0.0, toolName: Union[AnyStr, bool]="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create, edit, or query a dolly context
:param alternateContext: (C Q) Set the ALT+MMB and ALT+SHIFT+MMB to refer to this context
:param boxDollyType: (C Q E) Set the behavior of where the camera's center of interest is
set to after the box dolly In surface mode, the center of interest will be snapped to t
:param centerOfInterestDolly: (C Q E) Set the translate the camera's center of interest
Left and right drag movements with the mouse will translate the center of interest towards
or away
:param dollyTowardsCenter: (C Q E) Dolly towards center (if true), else dolly towards point
where user clicks in the view
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param localDolly: (C Q E) Dolly with respect to the camera's center of interest The
camera will not pass through the center of interest Local dolly only applies to perspecti
:param name: (C) If this is a tool command, name the tool appropriately
:param orthoZoom: (C Q E) Zoom orthographic view (if true), else dolly orthographic camera
Default value is true
:param scale: (C Q E) The sensitivity for dollying the camera
:param toolName: (C Q) Name of the specific tool to which this command refers
:returns: The name of the context
"""
pass
def DisplayShaded(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSplineCacheImportOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def buildKeyframeMenu(*args, **kwargs)->None:
"""
This command handles building the "dynamic" Keyframe menu, to show attributes of currently
selected objects, filtered by the current manipulator menuName is the string returned by
the "menu" command The target menu will entries appended to it (and deleted from it) to
always show what's currently keyframable
:returns:
"""
pass
def OrientConstraint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def renderSetupSwitchVisibleRenderLayer(*args, **kwargs)->None:
"""
"""
pass
def dR_viewTop(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HairUVSetLinkingEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def saveAllShelves(*args, **kwargs)->bool:
"""
This command writes all shelves that are immediate children of the specified control layout
to the prefs directory
:returns: True if successful, otherwise issues an error message and returns false.
"""
pass
def TexSculptDeactivateBrushStrength(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DistributeShells(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllNonLinearDeformers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SavePreferences(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonHelixOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveWrapInfluence(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PickWalkLeft(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MakeCurvesDynamic(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dbPeek(*args, **kwargs)->None:
"""
"""
pass
def SelectAllSculptObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateParticleDiskCacheOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectCurveCVsFirst(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ChannelControlEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateDagContainer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddMissingFBIKEffectorsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertToKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllIKHandles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def deleteHistoryAheadOfGeomCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ResetWire(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def pointConstraint(*args, layer: AnyStr="", maintainOffset: bool=True, name: Union[AnyStr,
bool]="", offset: Union[List[float, float, float], bool]=None, remove:
bool=True, skip: Union[AnyStr, List[AnyStr]]="", targetList: bool=True,
weight: Union[float, bool]=0.0, weightAliasList: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
Constrain an object's position to the position of the target object or to the average
position of a number of targets A pointConstraint takes as input one or more "target" DAG
transform nodes at which to position the single "constraint object" DAG transform node The
pointConstraint positions the constrained object at the weighted average of the
:param layer: (C E) Specify the name of the animation layer where the constraint should be
added
:param maintainOffset: (C) The offset necessary to preserve the constrained object's
initial position will be calculated and used as the offset
:param name: (C Q E) Sets the name of the constraint node to the specified name Default
name is constrainedObjectName_constraintType
:param offset: (C Q E) Sets or queries the value of the offset Default is 0,0,0
:param remove: (E) removes the listed target(s) from the constraint
:param skip: (C E M) Specify the axis to be skipped Valid values are "x", "y", "z" and
"none" During creation, "none" is the default This flag is multi-use
:param targetList: (Q) Return the list of target objects
:param weight: (C Q E) Sets the weight value for the specified target(s) If not given at
creation time, the default value of 1.0 is used
:param weightAliasList: (Q) Returns the names of the attributes that control the weight of
the target objects Aliases are returned in the same order as the targets are returned
:returns: Name of the created constraint node
"""
pass
def dR_quadDrawClearDots(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SculptMeshFrame(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BaseLevelComponentDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateDagContainerOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def testPassContribution(*args, **kwargs)->None:
"""
"""
pass
def SetMeshMaskTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def showShadingGroupAttrEditor(*args, q=True, query=True, **kwargs)->Union[bool, Any]:
"""
The showShadingGroupAttrEditor command opens up the attribute editor for the current
object's shading-group information
:returns: true if a shading group is displayed, otherwise false.
"""
pass
def createPtexUV(*args, **kwargs)->None:
"""
"""
pass
def selectedNodes(*args, **kwargs)->None:
"""
"""
pass
def HideUIElements(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintEffectsWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createMeshFromPoints(*args, **kwargs)->None:
"""
"""
pass
def FourViewLayout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveBifrostKillplane(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVEditorFrameSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeTransferAttributeValues(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateLatticeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Unfold3DContext(*args, **kwargs)->None:
"""
"""
pass
def PolyConvertToLoopAndDuplicate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetClumpBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphCopy(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetHIKChildCount(*args, **kwargs)->None:
"""
"""
pass
def AddBlendShapeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OneClickGetState(*args, **kwargs)->None:
"""
"""
pass
def dR_mtkPanelTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutlinerToggleAttributes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EditCharacterAttributes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SimplifyCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolySpinEdgeBackward(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSplineCacheImport(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddDynamicBuoyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtrudeFace(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def resolutionNode(*args, name: AnyStr="", parent: AnyStr="", shared: bool=True, skipSelect:
bool=True, **kwargs)->AnyStr:
"""
This command creates a new node in the dependency graph of the specified type The
resolutionNode creates a render resolution node and registers it with the model The
createNode command will not register nodes of this type correctly
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param parent: (C) Specifies the parent in the DAG under which the new node belongs
:param shared: (C) This node is shared across multiple files, so only create it if it does
not already exist
:param skipSelect: (C) This node is not to be selected after creation, the original
selection will be preserved
:returns: The name of the new node.
"""
pass
def polyCutCtx(*args, deleteFaces: bool=False, exists: bool=True, extractFaces: bool=False,
extractOffset: Union[List[float, float, float], bool]=None, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Create a new context to cut facets on polygonal objects
:param deleteFaces: (C Q E) whether to delete the one-half of the cut-faces of the poly If
true, they are deleted Default: false
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param extractFaces: (C Q E) whether to extract the cut-faces of the poly into a separate
shell If true, they are extracted Default: false
:param extractOffset: (C Q E) The displacement offset of the cut faces Default: 0.5, 0.5,
0.5
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:returns:
"""
pass
def SelectAllParticles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleFaceIDs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyAverageNormal(*args, allowZeroNormal: bool=True, distance: float=0.0, postnormalize:
bool=True, prenormalize: bool=True, replaceNormalXYZ: List[float, float,
float]=None, **kwargs)->AnyStr:
"""
Set normals of vertices or vertex-faces to an average value when the vertices within a
given threshold First, it sorts out the containing edges, and set them to be soft, if it
is possible, so to let the normals appear to be "merged" The remained components then are
sorted into lumps where vertices in each lump are within the given threshold For
:param allowZeroNormal: (C) Specifies whether to allow zero normals to be created By
default it is false If it is false, replaceNormal is needed
:param distance: (C) Specifies the distance threshold All vertices within the threshold
are considered when computing an average normal By default it is 0.0
:param postnormalize: (C) Specifies whether to normalize the resulting normals By default
it is true
:param prenormalize: (C) Specifies whether to normalize the normals before averaging By
default it is true
:param replaceNormalXYZ: (C) If the allowZeroNormal is false, this value is used to replace
the zero normals By default it is (1, 0, 0)
:returns: of the node name.
"""
pass
def MirrorSkinWeights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmPromoteRender(*args, **kwargs)->None:
"""
"""
pass
def RemoveBifrostEmissionRegion(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleMaterialLoadingDetailsVisibility(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AutoPaintMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def overrideModifier(*args, clear: bool=True, press: Union[AnyStr, List[AnyStr]]="", release:
Union[AnyStr, List[AnyStr]]="", **kwargs)->None:
"""
This command allows you to assign modifier key behaviour to other parts of the system For
example you can use a hotkey or input device instead of a modifer key to perform the same
action Note that the original modifier key behaviour is not altered in anyway For
example, if you've assigned "Ctrl" key behaviour to the "c" key then the "Ctrl" key
:param clear: (C) Don't force any modifier keys
:param press: (C M) Force the following modifier to be pressed Valid values are "Alt",
"Ctrl", "Shift"
:param release: (C M) Force the following modifier to be released Valid values are "Alt",
"Ctrl", "Shift"
:returns:
"""
pass
def FBXExportBakeResampleAnimation(*args, **kwargs)->None:
"""
"""
pass
def SelectAllFollicles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GpuCacheImportOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PositionAlongCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def movOut(*args, comment: bool=False, file: AnyStr="", precision: int=6, time: timerange=None,
**kwargs)->None:
"""
Exports a .mov file from the listed attributes Valid attribute types are numeric
attributes; time attributes; linear attributes; angular attributes; compound attributes
made of the types listed previously; and multi attributes composed of the types listed
previously Length, angle, and time values will be written to the file in the user units
I
:param comment: (C) If true, the attributes written to the .mov file will be listed in a
commented section at the top of the .mov file The default is false
:param file: (C) The name of the .mov file If no extension is used, a .mov will be added
:param precision: (C) Sets the number of digits to the right of the decimal place in the
.mov file C: The default is 6
:param time: (C) The time range to save as a .mov file The default is the current time
range
:returns:
"""
pass
def align(*args, alignToLead: bool=False, coordinateSystem: name=None, xAxis: AnyStr="", yAxis:
AnyStr="", zAxis: AnyStr="", **kwargs)->bool:
"""
Align or spread objects along X Y and Z axis
:param alignToLead: (C) When set, the min, center or max values are computed from the lead
object Otherwise, the values are averaged for all objects Default is false
:param coordinateSystem: (C) Defines the X, Y, and Z coordinates Default is the world
coordinates
:param xAxis: (C) Any of none, min, mid, max, dist, stack This defines the kind of
alignment to perfom, default is none
:param yAxis: (C) Any of none, min, mid, max, dist, stack This defines the kind of
alignment to perfom, default is none
:param zAxis: (C) Any of none, min, mid, max, dist, stack This defines the kind of
alignment to perfom, default is none
:returns: true/false
"""
pass
def blendShape(*args, after: bool=True, afterReference: bool=True, automatic: bool=True,
before: bool=True, copyDelta: List[int, int, int]=None, copyInBetweenDelta:
List[int, int, int, int]=None, deformerTools: bool=True, envelope: Union[float,
bool]=1.0, exclusive: Union[AnyStr, bool]="", export: AnyStr="", exportTarget:
Union[List[int, int], List[List[int, int]]]=None, flipTarget: Union[List[int,
int], List[List[int, int]]]=None, frontOfChain: bool=True, geometry:
Union[AnyStr, List[AnyStr], bool]="", geometryIndices: bool=True,
ignoreSelected: bool=True, ip: AnyStr="", inBetween: bool=True, inBetweenIndex:
int=0, inBetweenType: AnyStr="", includeHiddenSelections: bool=False,
mergeSource: Union[int, List[int]]=0, mergeTarget: int=0, mirrorDirection: int=0,
mirrorTarget: Union[List[int, int], List[List[int, int]]]=None, name: AnyStr="",
normalizationGroups: bool=True, origin: AnyStr="", parallel: bool=True, prune:
bool=True, remove: Union[bool, List[bool]]=True, resetTargetDelta:
Union[List[int, int], List[List[int, int]]]=None, split: bool=True,
suppressDialog: bool=True, symmetryAxis: Union[AnyStr, bool]="", symmetryEdge:
Union[AnyStr, List[AnyStr], bool]="", symmetrySpace: Union[int, bool]=0,
tangentSpace: bool=True, target: Union[List[AnyStr, int, AnyStr, float],
List[List[AnyStr, int, AnyStr, float]], bool]=None, topologyCheck: bool=True,
transform: Union[AnyStr, bool]="", weight: Union[List[int, float], List[List[int,
float]], bool]=None, weightCount: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command creates a blendShape deformer, which blends in specified amounts of each
target shape to the initial base shape Each base shape is deformed by its own set of
target shapes Every target shape has an index that associates it with one of the shape
weight values.
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param automatic: (C E) The -automatic flag is used to specify deformer ordering in a way
that choses between -frontOfChain and -before automatically If the geometry being
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param copyDelta: (E) Set the base, source, and destination delta index values
:param copyInBetweenDelta: (E) Set the base, target, source, and destination delta index
values
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param envelope: (C Q E) Set the envelope value for the deformer, controlling how much of
the total deformation gets applied Default is 1.0
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param export: (E) Export the shapes to the named file path
:param exportTarget: (E M) Specify the base and target index pairs for the export
:param flipTarget: (E M) Flip the list of base and target pairs
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param ip: (E) Import the shapes from the named file path
:param inBetween: (C E) Indicate that the specified target should serve as an inbetween An
inbetween target is one that serves as an intermediate target between the base sh
:param inBetweenIndex: (E) Only used with the -rtd/-resetTargetDelta flag to remove delta
values for points in the inbetween target geometry defined by this index
:param inBetweenType: (C E) Specify if the in-between target to be created is relative to
the hero target or if it is absolute If it is relative to hero targets, the in-between
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param mergeSource: (E M) List of source indexes for a merge
:param mergeTarget: (E) Target index of a merge
:param mirrorDirection: (E) Mirror direction; 0 = negative, 1 = positive
:param mirrorTarget: (E M) Mirror the list of base and target pairs
:param name: (C) Used to specify the name of the node being created
:param normalizationGroups: (Q) Returns a list of the used normalization group IDs
:param origin: (C) blendShape will be performed with respect to the world by default Valid
values are "world" and "local" The local flag will cause the blend shape to
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param resetTargetDelta: (E M) Remove all delta values for points in the target geometry,
including all sequential targets defined by target index Parameter list: uint: the base o
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:param suppressDialog: (C E) Suppress dialog box and run the command as defined by the
user
:param symmetryAxis: (Q E) Axis for symmetry Valid values are "X", "Y", and "Z"
:param symmetryEdge: (Q E M) One or two symmetry edge names, separated by a "." See the
blendShape node's symmetryEdge attribute for legal values
:param symmetrySpace: (Q E) Space for symmetry 0 = Topological, 1 = Object, 2 = UV
:param tangentSpace: (C E) Indicate that the delta of the specified target should be
relative to the tangent space of the surface
:param target: (C Q E M) Set target object as the index target shape for the base shape
base object The full influence of target shape takes effect when its shape weight is
:param topologyCheck: (C) Set the state of checking for a topology match between the shapes
being blended Default is on
:param transform: (Q E) Set transform for target, then the deltas will become relative to a
post transform Typically the best workflow for this option is to choose a joint
:param weight: (C Q E M) Set the weight value (second parameter) at index (first
parameter)
:param weightCount: (C Q E) Set the number of shape weight values
:returns: (the blendShape node name)
"""
pass
def ToggleHelpLine(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeDeleteAllTextures(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NURBSToPolygons(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def containerProxy(*args, fromTemplate: AnyStr="", type: AnyStr="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
Creates a new container with the same published interface, dynamic attributes and attribute
values as the specified container but with fewer container members This proxy container
can be used as a reference proxy so that values can be set on container attributes without
loading in the full container The proxy container will contain one or more lo
:param fromTemplate: (C) Specifies the name of a template file which will be used to create
the new container proxy Stand-in attributes will be created and published for all
:param type: (C) Specifies the type of container node to use for the proxy This flag is
only valid in conjunction with the fromTemplate flag When creating a proxy f
:returns:
"""
pass
def ParentConstraintOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmLengthBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def timeEditorClipLayer(*args, addAttribute: AnyStr="", addLayer: AnyStr="", addObject:
AnyStr="", allLayers: bool=True, attribute: Union[AnyStr,
List[AnyStr]]="", attributeKeyable: Union[AnyStr, bool]="", clipId:
int=0, index: int=0, keySiblings: bool=True, layerId: int=0, layerName:
Union[AnyStr, bool]="", mode: int=0, mute: bool=True, name: bool=True,
path: AnyStr="", removeAttribute: AnyStr="", removeLayer: bool=True,
removeObject: AnyStr="", resetSolo: bool=True, setKeyframe: bool=True,
solo: bool=True, zeroKeying: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Time Editor clip layers commands
:param addAttribute: (E) Add given plug to a layer with a supplied layerId
:param addLayer: (E) Add a new layer with a given name
:param addObject: (E) Add given object with all its attributes in the clip to a layer with
a supplied layerId
:param allLayers: (Q) Return all layers given clip ID
:param attribute: (E M) The attribute path to key
:param attributeKeyable: (Q) Return whether specified attribute is keyable
:param clipId: (E) ID of the clip this layer command operates on In query mode, this flag
can accept a value
:param index: (E) Layer index, used when adding new layer at specific location in the
stack
:param keySiblings: (E) If set to true, additional attributes might be keyed while keying
to achieve desired result
:param layerId: (E) Layer ID used in conjunction with other edit flags In query mode, this
flag can accept a value
:param layerName: (Q E) Edit layer name In query mode, return the layer name given its
layer ID and clip ID
:param mode: (E) To control the playback speed of the clip by animation curve: 0 : additive
1 : additive override 2 : override 3 : override passthrough
:param mute: (E) Mute/unmute a layer given its layer ID and clip ID
:param name: (Q) Query the attribute name of a layer given its layer ID and clip ID
:param path: (E) Full path of a layer or a clip on which to operate For example:
composition1|track1|clip1|layer1; composition1|track1|group|track1|clip1 In query m
:param removeAttribute: (E) Remove given plug from a layer with a supplied layerId
:param removeLayer: (E) Remove layer with an ID
:param removeObject: (E) Remove given object with all its attributes in the clip to a layer
with a supplied layerId
:param resetSolo: (E) Unsolo all soloed layers in a given clip ID
:param setKeyframe: (E) Set keyframe on specified attributes on specified layer of a clip
Use -clipId to indicate the specified clip Use -layerId to indicate the specified
:param solo: (E) Solo/unsolo a layer given its layers ID and clip ID
:param zeroKeying: (E) Indicate if the key to set should be zero offset from original
animation
:returns: Command result
"""
pass
def vnnNode(*args, **kwargs)->None:
"""
"""
pass
def OrientConstraintOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ResetTransformationsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cacheAppend(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def latticeDeformKeyCtx(*args, envelope: Union[float, bool]=0.0, exists: bool=True, history:
bool=True, image1: Union[AnyStr, bool]="", image2: Union[AnyStr,
bool]="", image3: Union[AnyStr, bool]="", latticeColumns: Union[int,
bool]=0, latticeRows: Union[int, bool]=0, name: AnyStr="",
scaleLatticePts: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a context which may be used to deform key frames with lattice
manipulator This context only works in the graph editor
:param envelope: (Q E) Specifies the influence of the lattice
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param latticeColumns: (Q E) Specifies the number column points the lattice contains
:param latticeRows: (Q E) Specifies the number of rows the lattice contains
:param name: (C) If this is a tool command, name the tool appropriately
:param scaleLatticePts: (Q E) Specifies if the selected lattice points should scale around
the pick point If this value is false the the default operation is 'move'
:returns: Context name
"""
pass
def ExportOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeGridToggleSnap(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetHIKEffectorCount(*args, **kwargs)->None:
"""
"""
pass
def UVUnstackShellsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def filterCurve(*args, cutoffFrequency: float=0.0, endTime: time=None, filter: AnyStr="",
keepKeysOnFrame: bool=True, kernel: AnyStr="", keySync: bool=True, maxTimeStep:
float=0.0, minTimeStep: float=0.0, period: float=0.0, precision: float=0.0,
precisionMode: int=0, preserveKeyTangent: Union[AnyStr, List[AnyStr]]="",
samplingRate: float=0.0, selectedKeys: bool=True, startTime: time=None,
timeTolerance: float=0.0, tolerance: float=0.0, **kwargs)->int:
"""
The filterCurve command takes a list of anim curve and filters them using a specified
filter The following filters are supported: butterworth euler keyReducer keySync resample
simplify
:param cutoffFrequency: (C) Defines the cutoff frequency (in Hz) for the Butterworth
filter
:param endTime: (C) Specify the end time of the section to filter If not specified, the
last key of the animation curve is used to define the end time
:param filter: (C) Specifies the filter type to use The avalible filters are: butterworth
euler (default) keyReducer keySync resample simplify
:param keepKeysOnFrame: (C) When specified, a secondary filter pass is applied to position
keys on whole frames This flag is only supported by the Butterworth filter
:param kernel: (C) Gaussian4 Filter: (2^(-4x*x)) weighted moving average
:param keySync: (C) When specified, a secondary filter pass is applied that adds a key to
sibling curves (X,Y,Z) for each key that is encountered This flag is only supp
:param maxTimeStep: (C) Simplify filter
:param minTimeStep: (C) Simplify filter
:param period: (C) Resample filter
:param precision: (C) Defines the precision parameter For the Key Reducer filter, this
parameter specifies the error limit between the source and output curves Greater v
:param precisionMode: (C) Defines whether the precision value should be treated as: 0: An
absolute value 1: A percentage
:param preserveKeyTangent: (C M) When specified, keys whose in or out tangent type match
the specified type are preserved Supported tangent types: fixed linear flat smooth step
clam
:param samplingRate: (C) Defines the rate at which keys are added to the Butterworth
filtered curve in frames per second (FPS)
:param selectedKeys: (C) When specified, the filter is only applied to selected keys This
flag supercedes the startTime/endTime specification
:param startTime: (C) Specify the start time to filter If not specified, then the first
key in the animation curve is used to get the start time
:param timeTolerance: (C) Simplify filter
:param tolerance: (C) Simplify filter
:returns: The number of filtered curves
"""
pass
def VisorWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nexTRSContext(*args, **kwargs)->None:
"""
"""
pass
def getDefaultBrush(*args, **kwargs)->AnyStr:
"""
The command returns the name of the default Paint Effects brush
:returns: Name of the default brush node
"""
pass
def shelfButton(*args, align: Union[AnyStr, bool]="", annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, command:
Union[Script, bool]=None, commandRepeatable: bool=True, defineTemplate:
AnyStr="", disabledImage: Union[AnyStr, bool]="", docTag: Union[AnyStr,
bool]="", doubleClickCommand: Union[Script, bool]=None, dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableCommandRepeat: bool=True, enableKeyboardFocus: bool=True,
exists: bool=True, flat: bool=True, flexibleWidthType: Union[int, bool]=0,
flexibleWidthValue: Union[int, bool]=0, flipX: bool=True, flipY: bool=True,
font: Union[AnyStr, bool]="", fullPathName: bool=True, handleNodeDropCallback:
Script=None, height: Union[int, bool]=0, highlightColor: Union[List[float,
float, float], bool]=None, highlightImage: Union[AnyStr, bool]="", image:
Union[AnyStr, bool]="", image1: Union[AnyStr, bool]="", image2: Union[AnyStr,
bool]="", image3: Union[AnyStr, bool]="", imageOverlayLabel: Union[AnyStr,
bool]="", isObscured: bool=True, label: Union[AnyStr, bool]="",
labelEditingCallback: Script=None, labelOffset: Union[int, bool]=0, ltVersion:
Union[AnyStr, bool]="", manage: bool=True, marginHeight: Union[int, bool]=0,
marginWidth: Union[int, bool]=0, menuItem: Union[List[AnyStr, AnyStr],
List[List[AnyStr, AnyStr]]]=None, menuItemPython: Union[int, List[int]]=0,
noBackground: bool=True, noDefaultPopup: bool=True, numberOfPopupMenus:
bool=True, overlayLabelBackColor: Union[List[float, float, float, float],
bool]=None, overlayLabelColor: Union[List[float, float, float], bool]=None,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, rotation: Union[float, bool]=0.0, scaleIcon: bool=True,
selectionImage: Union[AnyStr, bool]="", sourceType: Union[AnyStr, bool]="",
statusBarMessage: AnyStr="", style: Union[AnyStr, bool]="", useAlpha: bool=True,
useTemplate: AnyStr="", version: Union[AnyStr, bool]="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This control supports up to 3 icon images and 4 different display styles The icon image
displayed is the one that best fits the current size of the control given its current style
This command creates an iconTextButton that is designed to be on the shelf The button
contains a command that can be drag'n'dropped
:param align: (C Q E) The label alignment Alignment values are "left", "right", and
"center" By default, the label is aligned "center" Currently only available when -st
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param command: (C Q E) Command executed when the control is pressed
:param commandRepeatable: (C Q E) Set if the MEL command specified in the command flag
should be repeatable or not The "g" key, by default, is the shortcut to repeat the last
execute
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param disabledImage: (C Q E) Image used when the button is disabled Image size must be
the same as the image specified with the i/image flag This is a Windows only flag
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param doubleClickCommand: (C Q E) Command executed when the control is double clicked
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableCommandRepeat: (C Q E) This flag only affects menu items to which a command
can be attached Specify true and the command may be repeated by executing the command
repeatLas
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param flat: (C Q E) Sets whether the control will be a flat button (0 false, 1 true)
:param flexibleWidthType: (C Q E) This flag is used to have the shelf button have a wider
or thinner width The valid values are: Standard = 1, Custom = 2, Automatic = 3 The
Standard
:param flexibleWidthValue: (C Q E) This flag is only useful when the Custom
flexibleWidthType is chosen The value is a width in pixels
:param flipX: (C Q E) Is the image flipped horizontally?
:param flipY: (C Q E) Is the image flipped vertically?
:param font: (C Q E) The font for the text Valid values are "boldLabelFont",
"smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont",
"oblique
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param handleNodeDropCallback: (C E) Specify a script callback which is called when a node
is dropped on the control The name of the node being dropped will be passed to the
function (p
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param highlightImage: (C Q E) Highlight image displayed while the cursor is over the
control Image size must be the same as the image specified with the -i/image flag This is
a
:param image: (C Q E) If you are not providing images with different sizes then you may use
this flag for the control's image If the "iconOnly" style is set, the icon wil
:param image1: (C Q E) First of three possible icons The icon that best fits the current
size of the control will be displayed
:param image2: (C Q E) Second of three possible icons The icon that best fits the current
size of the control will be displayed
:param image3: (C Q E) Third of three possible icons The icon that best fits the current
size of the control will be displayed
:param imageOverlayLabel: (C Q E) A short string, up to 6 characters, representing a label
that will be displayed on top of the image
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) The text that appears in the control
:param labelEditingCallback: (C E) Specify a callback which is called after the user double
clicks the label of the control to give it a new label The new label string will be
passed
:param labelOffset: (C Q E) The label offset Default is 0 Currently only available when
-st/style is set to "iconAndTextCentered"
:param ltVersion: (C Q E) This flag is used to specify the Maya LT version that this
control feature was introduced, if the version flag is not specified, or if the version fl
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param marginHeight: (C Q E) The number of pixels above and below the control content The
default value is 1 pixel
:param marginWidth: (C Q E) The number of pixels on either side of the control content The
default value is 1 pixel
:param menuItem: (C E M) Creates menu items for this button by passing in arguments for the
menu item label and command for each item These should be passed as strings: "lab
:param menuItemPython: (C E M) This flag is used to specify that a menu item is in Python
The integer value is the index of the menuItem that is modified by this flag This is 0 b
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param noDefaultPopup: (C) Disable the default popup menus
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param overlayLabelBackColor: (C Q E) The RGBA color of the shadow behind the label defined
by imageOverlayLabel Default is 50% transparent black: 0 0 0 .5
:param overlayLabelColor: (C Q E) The RGB color of the label defined by imageOverlayLabel
Default is a light grey: .8 .8 .8
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rotation: (C Q E) The rotation value of the image in radians
:param scaleIcon: (C E) For "textOnly" and "iconOnly" style, this flag has no effect For
other styles, if the flag is specified, the icon will be scaled to the size of the
:param selectionImage: (C Q E) Image displayed while the control is selected Image size
must be the same as the image specified with the -i/image flag This is a Windows only
flag
:param sourceType: (C Q E) Sets the language type for the command script Can only be used
in conjunction with the c/command or dcc/doubleClickCommand flags Valid values are "
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param style: (C Q E) The draw style of the control Valid styles are "iconOnly",
"textOnly", "iconAndTextHorizontal", "iconAndTextVertical", and "iconAndTextCentered" (N
:param useAlpha: (C Q E) Is the image using alpha channel?
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param version: (C Q E) Specify the version that this control feature was introduced The
argument should be given as a string of the version number (e.g "2013", "2014") C
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The full name of the button.
"""
pass
def FBXGetTakeCount(*args, **kwargs)->None:
"""
"""
pass
def listNodesWithIncorrectNames(*args, **kwargs)->None:
"""
List all nodes with incorrect names in the Script Editor
:returns:
"""
pass
def polySelect(*args, add: bool=True, addFirst: bool=True, asSelectString: bool=True, deselect:
bool=True, edgeBorder: Union[int, List[int], bool]=0, edgeBorderPath:
Union[List[int, int], List[List[int, int]], bool]=None, edgeBorderPattern:
Union[List[int, int], List[List[int, int]], bool]=None, edgeLoop: Union[int,
List[int], bool]=0, edgeLoopOrBorder: Union[int, List[int], bool]=0,
edgeLoopOrBorderPattern: Union[List[int, int], List[List[int, int]], bool]=None,
edgeLoopPath: Union[List[int, int], List[List[int, int]], bool]=None,
edgeLoopPattern: Union[List[int, int], List[List[int, int]], bool]=None,
edgeRing: Union[int, List[int], bool]=0, edgeRingPath: Union[List[int, int],
List[List[int, int]], bool]=None, edgeRingPattern: Union[List[int, int],
List[List[int, int]], bool]=None, edgeUVLoopOrBorder: Union[int, List[int],
bool]=0, everyN: int=0, extendToShell: Union[int, List[int], bool]=0,
noSelection: bool=True, replace: bool=True, shortestEdgePath: Union[List[int,
int], List[List[int, int]], bool]=None, shortestEdgePathUV: Union[List[int, int],
List[List[int, int]], bool]=None, shortestFacePath: Union[List[int, int],
List[List[int, int]], bool]=None, toggle: bool=True, q=True, query=True,
**kwargs)->Union[List[int], Any]:
"""
This command makes different types of poly component selections The return value is an
integer array containing the id's of the components in the selection in order If a given
type of selection loops back on itself then this is indicated by the start id appearing
twice, once at the start and once at the end
:param add: (C Q) Indicates that the specified items should be added to the active list
without removing existing items from the active list
:param addFirst: (C Q) Indicates that the specified items should be added to the front of
the active list without removing existing items from the active list
:param asSelectString: (C Q) Changes the return type from an integer array to a string
array which can be used as a selection string
:param deselect: (C Q) Indicates that the specified items should be removed from the active
list if they are on the active list
:param edgeBorder: (C Q M) Select all conected border edges starting at the given edge In
query mode, this flag needs a value
:param edgeBorderPath: (C Q M) Given two edges on the same border, this will select the
edges on the border in the path between them In query mode, this flag needs a value
:param edgeBorderPattern: (C Q M) Given two edges on the same border, this will check how
many edges there are between the given edges and then continue that pattern of selection
arou
:param edgeLoop: (C Q M) Select an edge loop starting at the given edge In query mode,
this flag needs a value
:param edgeLoopOrBorder: (C Q M) Select an edge loop or all conected border edges,
depending on whether the edge is on a border or not, starting at the given edge In query
mode, thi
:param edgeLoopOrBorderPattern: (C Q M) Given two edges either on the same edge loop or on
the same edge border, this will check how many edges there are between the given edges and
then co
:param edgeLoopPath: (C Q M) Given two edges that are on the same edge loop, this will
select the shortest path between them on the loop In query mode, this flag needs a value
:param edgeLoopPattern: (C Q M) Given two edges on the same edge loop, this will check how
many edges there are between the given edges and then continue that pattern of selection a
:param edgeRing: (C Q M) Select an edge ring starting at the given edge In query mode,
this flag needs a value
:param edgeRingPath: (C Q M) Given two edges that are on the same edge ring, this will
select the shortest path between them on the ring In query mode, this flag needs a value
:param edgeRingPattern: (C Q M) Given two edges on the same edge ring, this will check how
many edges there are between the given edges and then continue that pattern of selection a
:param edgeUVLoopOrBorder: (C Q M) Select an edge loop or border, terminating at UV borders
In query mode, this flag needs a value
:param everyN: (C) Number of elements to stride over If less than 1 then use 1, meaning
every element 2 means every second one, etc
:param extendToShell: (C Q M) Select the poly shell given a face id In query mode, this
flag needs a value
:param noSelection: (C Q) If this flag is used then the selection is not changed at all
:param replace: (C Q) Indicates that the specified items should replace the existing items
on the active list
:param shortestEdgePath: (C Q M) Given two vertices, this will select the shortest path
between them in the 3d object space In query mode, this flag needs a value
:param shortestEdgePathUV: (C Q M) Given two UVs, this will select the shortest path
between them in the 2d texture space In query mode, this flag needs a value
:param shortestFacePath: (C Q M) Given two faces, this will select the shortest path
between them in the 3d object space In query mode, this flag needs a value
:param toggle: (C Q) Indicates that those items on the given list which are on the active
list should be removed from the active list and those items on the given list wh
:returns: List of selected components.
"""
pass
def setParent(*args, defineTemplate: AnyStr="", menu: bool=True, topLevel: bool=True, upLevel:
bool=True, useTemplate: AnyStr="", q=True, query=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command changes the default parent to be the specified parent Two special parents are
"|" which indicates the top level layout of the window hierarchy, or ".." which indicates
one level up in the hierarchy Trying to move above the top level has no effect A
control must be parented to a control layout A control layout may be parented to a
:param defineTemplate: (C) Put a command in a mode where any other flags and args are
parsed and added to the command template with the given name They will be used as default
:param menu: (C Q) Parent menu for menu items
:param topLevel: (C) Move to the top level layout in the hierarchy Equivalent to use "|"
:param upLevel: (C) Move up one level in the hierarchy Equivalent to use ".."
:param useTemplate: (C) Will force the command to use a command template given by the name
other than the current one
:returns: Name of the parent if the parent changes. Empty string if the parent
doesn't
change.
"""
pass
def renderSetupFindCollections(*args, **kwargs)->None:
"""
unknown
"""
pass
def CutKeys(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ClearCurrentCharacterList(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModifyStampDepthPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorToggleConsistentNodeNameSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeOutlinerPerspLayout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySlideEdgeCtx(*args, **kwargs)->None:
"""
"""
pass
def testPa(*args, **kwargs)->None:
"""
"""
pass
def ImportAnimOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportConvert2Tif(*args, **kwargs)->None:
"""
"""
pass
def OutlinerExpandAllItems(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def intersect(*args, caching: bool=True, firstSurface: bool=True, nodeState: Union[int, bool]=0,
tolerance: Union[float, bool]=0.01, constructionHistory: bool=True,
curveOnSurface: bool=True, name: AnyStr="", object: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The intersect command creates a curve on surface where all surfaces intersect with each
other By default, the curve on surface is created for both surfaces However, by using the
-fs flag, only the first surface will have a curve on surface Also, the intersection curve
can be created as a 3D curve rather than a curve on surface
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param firstSurface: (Q E) Creates a curve-on-surface on the first surface only or on all
surfaces (default)
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param tolerance: (C Q E) Tolerance to fit to Default: 0.01
:param constructionHistory: (C) Turn the construction history on or off
:param curveOnSurface: (C) If possible, create 2D curve as a result
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:returns: Object name and node name
"""
pass
def DeleteStaticChannelsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createPolyPyramidCtx(*args, **kwargs)->None:
"""
"""
pass
def shapeCompare(*args, **kwargs)->int:
"""
Compares two shapes If no shapes are specified in the command line, then the shapes from
the active list are used
:returns: 0 if successful, 1 if both shapes are not determined to be equal
based on
requested flags.
"""
pass
def ScaleToolMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def snapshotModifyKeyCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Creates a context for inserting/delete keys on an editable motion trail
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: (name of the new context)
"""
pass
def HypershadeConnectSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nodeType(*args, apiType: bool=True, derived: bool=True, inherited: bool=True, isTypeName:
bool=True, **kwargs)->AnyStr:
"""
This command returns a string which identifies the given node's type When no flags are
used, the unique type name is returned This can be useful for seeing if two nodes are of
the same type When the api flag is used, the MFn::Type of the node is returned This can
be useful for seeing if a plug-in node belongs to a given class The api flag ca
:param apiType: (C) Return the MFn::Type value (as a string) corresponding to the given
node This is particularly useful when the given node is defined by a plug-in, si
:param derived: (C) Return a string array containing the names of all the currently known
node types which derive from the type of the specified node
:param inherited: (C) Return a string array containing the names of all the base node types
inherited by the specified node
:param isTypeName: (C) If this flag is present, then the argument provided to the command
is the name of a node type rather than the name of a specific node
:returns: Single command result
"""
pass
def FBXExportSkins(*args, **kwargs)->None:
"""
"""
pass
def HypershadePickWalkRight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def canCreateManip(*args, **kwargs)->bool:
"""
This command returns true if there can be a manipulator made for the specified selection,
false otherwise
:returns: Command result
"""
pass
def UnfoldPackUVs3DInEmptyTile(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolySelectToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def multiTouch(*args, gestures: bool=True, trackpad: Union[int, bool]=0, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
Used to interact with the Gestura (multi-touch) library
:param gestures: (C Q) Enables/Disables multi touch gestures
:param trackpad: (C Q) Sets the trackpad mode Values can be: 1 - Cursor Control only 2 -
Multi-touch Gestures Only 3 - Cursor and Multi-touch Note: this is a "Mac" only fl
:returns:
"""
pass
def canvas(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float, float,
float], bool]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, hsvValue: Union[List[float, float,
float], bool]=None, isObscured: bool=True, manage: bool=True, noBackground:
bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, pressCommand: Script=None, preventOverride: bool=True,
rgbValue: Union[List[float, float, float], bool]=None, statusBarMessage: AnyStr="",
useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Creates a control capable of displaying a color swatch This control can also accept a
command to be called when the colour swatch is pressed by the user Note: The
-dgc/dragCallback and -dpc/dropCallback are not available for this control
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param hsvValue: (C Q E) Three float values corresponding to the hue, saturation, and value
color components, where the hue value ranges from 0.0 to 360.0 and the saturation
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param pressCommand: (C E) Command to be executed when there is a mouse press
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rgbValue: (C Q E) Three float values corresponding to the red, green, and blue color
components, all of which range from 0.0 to 1.0
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The full name of the canvas.
"""
pass
def ShowAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshSmearToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshSculptTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nClothDeleteCacheFrames(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetNClothStartFromMesh(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveBifrostAccelerator(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyMergeVertices(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nodeTreeLister(*args, addFavorite: Union[AnyStr, List[AnyStr]]="", addItem:
Union[List[AnyStr, AnyStr, Script], List[List[AnyStr, AnyStr, Script]]]=None,
addVnnItem: Union[List[AnyStr, AnyStr, AnyStr, AnyStr], List[List[AnyStr,
AnyStr, AnyStr, AnyStr]]]=None, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, clearContents:
bool=True, collapsePath: Union[AnyStr, List[AnyStr]]="", defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dropCallback: Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, executeItem: AnyStr="", exists: bool=True,
expandPath: Union[AnyStr, List[AnyStr]]="", expandToDepth: int=0,
favoritesCallback: Script=None, favoritesList: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float,
float, float], bool]=None, isObscured: bool=True, itemScript: Union[AnyStr,
bool]="", manage: bool=True, noBackground: bool=True, nodeLibrary:
Union[AnyStr, bool]="", numberOfPopupMenus: bool=True, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
refreshCommand: Union[Script, bool]=None, removeFavorite: Union[AnyStr,
List[AnyStr]]="", removeItem: Union[AnyStr, List[AnyStr]]="",
resultsPathUnderCursor: bool=True, selectPath: Union[AnyStr,
List[AnyStr]]="", statusBarMessage: AnyStr="", useTemplate: AnyStr="",
visible: bool=True, visibleChangeCommand: Union[Script, bool]=None,
vnnString: bool=True, width: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates/edits/queries the node tree lister control nodeTreeLister is a
treeLister, but items are assumed to have commands which return dependency node names
Dragging from the results pane is supported The optional argument is the name of the
control
:param addFavorite: (C E M) Add an item path to the favorites folder The item path does
not have to actually be in the tree
:param addItem: (C E M) Add an item to the control The arguments are item-path,icon path,
command where item-path is the path from the root of the tree to the item's name ic
:param addVnnItem: (C E M) Add a VNN (Virtual Node Network) item to the control The
arguments are: item-path, icon-path, vnn-string, vnn-action Where item-path is the path
fr
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param clearContents: (E) Clears the contents of the control
:param collapsePath: (E M) Collapse a path in the tree
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param executeItem: (E) Execute the command associated with an item
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param expandPath: (E M) Expand a path in the tree
:param expandToDepth: (E) Expand the tree to the given depth
:param favoritesCallback: (C E) This script is called whenever a favorite is added or
removed It is passed two arguments: The item's path and a boolean indicating if it is
being ad
:param favoritesList: (Q) Returns the list of favorite items
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param itemScript: (Q) Returns the language and script command of the passed item path as a
two-element list, the first element is the string "MEL" or "Python" and the seco
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param nodeLibrary: (C Q E) The node library that this tree lister is currently displaying
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param refreshCommand: (C Q E) Command executed when the refresh button is pressed Note:
by default the refresh button is hidden and will be shown automatically when this command
:param removeFavorite: (E M) Remove an item from favorites Accepts the full favorite path
or the tail of the full path
:param removeItem: (E M) Remove an item path
:param resultsPathUnderCursor: (Q) Returns the path to the result (right-pane) item under
the mouse cursor Returns an empty string if there is no such item
:param selectPath: (E M) Select a path in the tree
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param vnnString: (Q) Returns the VNN (Virtual Node Network) string of the passed item
path
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the created control.
"""
pass
def ContentBrowserWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeSelectUpStream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmGuideRender(*args, **kwargs)->None:
"""
"""
pass
def subdDisplayMode(*args, **kwargs)->None:
"""
"""
pass
def SelectMaskToolMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def untangleUV(*args, mapBorder: AnyStr="", maxRelaxIterations: int=0, pinBorder: bool=True,
pinSelected: bool=True, pinUnselected: bool=True, relax: AnyStr="",
relaxTolerance: float=0.0, shapeDetail: float=0.0, **kwargs)->int:
"""
This command will aid in the creation of non-overlapping regions (i.e polygons) in texture
space by untangling texture UVs This is done in two stages:
:param mapBorder: (C) Map the border containing the selected UV into a variety of shapes
that may be more amenable to UV relaxation operations There are various types of
:param maxRelaxIterations: (C) The relaxation process is an iterative algorithm Using this
flag will put an upper limit on the number of iterations that will be performed
:param pinBorder: (C) If this is true, then the relevant texture borders are pinned in
place during any relaxation
:param pinSelected: (C) If this is true, then then any selected UVs are pinned in place
during any relaxation
:param pinUnselected: (C) If this is true, then all unselected UVs in each mesh are pinned
in place during any relaxation
:param relax: (C) Relax all UVs in the shell of the selected UV's The relaxation is done
by simulating a spring system where each UV edge is treated as a spring Ther
:param relaxTolerance: (C) This sets the tolerance which is used to determine when the
relaxation process can stop Smaller tolerances yield better results but can take much lo
:param shapeDetail: (C) If the mapBorder flag is set to circular or square, then this flag
will control how much of the border's corresponding surface shape should be retain
:returns: the number of relaxation iterations carried out
"""
pass
def MakeHoleToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonHelix(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleToolSettings(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmClumpBrushContext(*args, **kwargs)->None:
"""
"""
pass
def spBirailCtx(*args, **kwargs)->None:
"""
"""
pass
def keyframeRegionScaleKeyCtx(*args, exists: bool=True, history: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", name: AnyStr="", scaleSpecifiedKeys:
bool=True, type: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a context which may be used to scale keyframes within the keyframe
region of the dope sheet editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param scaleSpecifiedKeys: (Q E) Determines if only the specified keys should be scaled If
false, the non-selected keys will be adjusted during the scale The default is true
:param type: (E) rect | manip Specifies the type of scale manipulator to use
:returns: Context name
"""
pass
def nameCommand(*args, annotation: AnyStr="", command: Script=None, data1: AnyStr="", data2:
AnyStr="", data3: AnyStr="", default: bool=True, sourceType: AnyStr="",
**kwargs)->AnyStr:
"""
This command creates a nameCommand object Each nameCommand object can be connected to a
hotkey Thereafter, the nameCommand's command string will be executed whenever the hotkey
is pressed (or released, as specified by the user)
:param annotation: (C) A description of the command
:param command: (C) The command that is executed when the nameCommand is invoked
:param data1: (C)
:param data2: (C)
:param data3: (C) These are optional, user-defined data strings that are attached to the
nameCommand object They can be edited or queried using the assignCommand comm
:param default: (C) Indicate that this name command is a default command Default name
commands will not be saved to preferences
:param sourceType: (C) Sets the language type for the command script Can only be used in
conjunction with the -command flag Valid values are "mel" (enabled by default), a
:returns: The name of the nameCommand object created
"""
pass
def FBXExportReferencedContainersContent(*args, **kwargs)->None:
"""
"""
pass
def sbs_SetEditionModeScale(*args, **kwargs)->None:
"""
"""
pass
def MoveLeft(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def rename(*args, ignoreShape: bool=True, uuid: bool=True, **kwargs)->AnyStr:
"""
Renames the given object to have the new name If only one argument is supplied the command
will rename the (first) selected object If the new name conflicts with an existing name,
the object will be given a unique name based on the supplied name It is not legal to
rename an object to the empty string When a transform is renamed then any shape
:param ignoreShape: (C) Indicates that renaming of shape nodes below transform nodes should
be prevented
:param uuid: (C) Indicates that the new name is actually a UUID, and that the command
should change the node's UUID (In which case its name remains unchanged.)
:returns: The new name. When undone returns original name.
"""
pass
def TogglePolyDisplaySoftEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dynCache(*args, **kwargs)->None:
"""
Cache the current state of all particle shapes at the current time
:returns:
"""
pass
def SelectHierarchy(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OneClickMotionBuilderSendToCurrentScene(*args, **kwargs)->None:
"""
"""
pass
def manipPivot(*args, moveToolOri: int=0, ori: Union[List[float, float, float], bool]=None,
oriValid: bool=True, pinPivot: bool=True, pos: Union[List[float, float, float],
bool]=None, posValid: bool=True, reset: bool=True, resetOri: bool=True,
resetPos: bool=True, rotateToolOri: int=0, scaleToolOri: int=0, snapOri:
bool=True, snapPos: bool=True, valid: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
Changes transform component pivot used by the move/rotate/scale manipulators
:param moveToolOri: (C) Change move tool's axis orientation to the specified mode This
flag is the same as using "manipMoveContext -e -mode" on the Move tool except that th
:param ori: (C Q) Component pivot orientation in world-space
:param oriValid: (Q) Returns true if component pivot orientation is valid
:param pinPivot: (C Q) Pin component pivot Selection changes will not reset the pivot
position/orientation when a custom pivot is set and pinning is on
:param pos: (C Q) Component pivot position in world-space
:param posValid: (Q) Returns true if component pivot position is valid
:param reset: (C) Clear the saved component pivot position and orientation
:param resetOri: (C) Clear the saved component pivot orientation
:param resetPos: (C) Clear the saved component pivot position
:param rotateToolOri: (C) Change rotate tool's axis orientation to the specified mode This
flag is the same as using "manipRotateContext -e -mode" on the Rotate tool except t
:param scaleToolOri: (C) Change scale tool's axis orientation to the specified mode This
flag is the same as using "manipScaleContext -e -mode" on the Scale tool except that
:param snapOri: (C Q) Snap pivot orientation Modify pivot orientation when snapping the
pivot to a component
:param snapPos: (C Q) Snap pivot position Modify pivot position when snapping the pivot to
a component
:param valid: (Q) Returns true if component pivot position or orientation is valid
:returns:
"""
pass
def renderPassRegistry(*args, channels: int=0, isPassSupported: bool=True, passID: AnyStr="",
passName: bool=True, renderer: AnyStr="", supportedChannelCounts:
bool=True, supportedDataTypes: bool=True, supportedPassSemantics:
bool=True, supportedRenderPassNames: bool=True, supportedRenderPasses:
bool=True, **kwargs)->List[AnyStr]:
"""
query information related with render passes
:param channels: (C) Specify the number of channels for query
:param isPassSupported: (C) Return whether the pass is supported by the renderer This flag
must be specified by the flag -passID firstly The renderer whose default value is the
:param passID: (C) Specify the render pass ID for query
:param passName: (C) Get the pass name for the passID This flag must be specified by the
flag -passID firstly
:param renderer: (C) Specify a renderer when using this command By default the current
renderer is specified
:param supportedChannelCounts: (C) List channel counts supported by the renderer(specified
by the flag -renderer) and the specified pass ID This flag must be specified by the flag
-pa
:param supportedDataTypes: (C) List frame buffer types supported by the renderer(specified
by the flag -renderer), the specified passID and channels This flag must be specified by
:param supportedPassSemantics: (C) List pass semantics supported by the specified passID
This flag must be specified by the flag -passId firstly
:param supportedRenderPassNames: (C) List render pass names supported by the
renderer(specified by the flag -renderer)
:param supportedRenderPasses: (C) List render passes supported by the renderer(specified by
the flag -renderer)
:returns: Command result
"""
pass
def MakePressureCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CycleIKHandleStickyState(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PruneSmallWeights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ikSplineHandleCtx(*args, autoPriorityH: bool=True, createCurve: bool=True, createRootAxis:
bool=True, exists: bool=True, forceSolverH: bool=True, history: bool=True,
image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", name: AnyStr="", numSpans: int=1, parentCurve:
bool=True, poWeightH: Union[float, bool]=1, priorityH: Union[int, bool]=1,
rootOnCurve: bool=True, rootTwistMode: bool=True, simplifyCurve:
bool=True, snapCurve: bool=True, snapHandleH: bool=True, solverTypeH:
Union[AnyStr, bool]="", stickyH: Union[AnyStr, bool]="off", twistType:
AnyStr="linear", weightH: Union[float, bool]=1, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The ikSplineHandle context command (ikSplineHandleCtx) updates parameters of ikSplineHandle
tool The options for the tool will be set to the flags the user specifies
:param autoPriorityH: (C Q E) Specifies that this handle's priority is assigned
automatically C: The default is off Q: When queried, this flag returns an int
:param createCurve: (C Q E) Specifies if a curve should be automatically created for the
ikSplineHandle C: The default is on Q: When queried, this flag returns an int
:param createRootAxis: (E) Specifies if a root transform should automatically be created
above the joints affected by the ikSplineHandle This option is used to prevent the roo
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param forceSolverH: (C Q E) Specifies if the ikSolver is enabled for the ikHandle C: The
default is on Q: When queried, this flag returns an int
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param numSpans: (E) Specifies the number of spans in the automatically generated curve of
the ikSplineHandle C: The default is 1 Q: When queried, this flag returns an
:param parentCurve: (E) Specifies if the curve should automatically be parented to the
parent of the first joint affected by the ikSplineHandle C: The default is on Q: Whe
:param poWeightH: (C Q E) Specifies the position/orientation weight of the ikHandle C: The
default is 1 Q: When queried, this flag returns a float
:param priorityH: (C Q E) Specifies the priority of the ikHandle C: The default is 1 Q:
When queried, this flag returns an int
:param rootOnCurve: (E) Specifies if the root is locked onto the curve of the
ikSplineHandle C: The default is on Q: When queried, this flag returns an int
:param rootTwistMode: (E) Specifies whether the start joint is allowed to twist or not If
not, then the required twist is distributed over the remaining joints This applies
:param simplifyCurve: (E) Specifies if the ikSplineHandle curve should be simplified C:
The default is on Q: When queried, this returns an int
:param snapCurve: (E) Specifies if the curve should automatically snap to the first joint
affected by the ikSplineHandle C: The default is off Q: When queried, this flag
:param snapHandleH: (C Q E) Specifies if the ikHandle snapping is on This flag is ignored
for the ikSplineSolver C: The default is on Q: When queried, this flag returns an in
:param solverTypeH: (C Q E) Lists what ikSolver is being used For the ikSplineContext the
solver can only be the ikSplineSolver and this flag is ignored C: The default solver
:param stickyH: (C Q E) Specifies if the ikHandle is sticky or not Valid strings are
"sticky" and "off" This flag is ignored for the ikSplineSolver C: The default is "off
:param twistType: (E) Specifies the type of interpolation to be used by the ikSplineHandle
The interpolation options are "linear", "easeIn", "easeOut", and "easeInOut" C
:param weightH: (C Q E) Specifies the weight of the ikHandle This flag is ignored in the
ikSplineHandleCtx C: The default is 1 Q: When queried, this flag returns a float
:returns: The name of the context.
"""
pass
def xgmAddGuide(*args, **kwargs)->None:
"""
"""
pass
def boxZoomCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name: AnyStr="",
zoomScale: Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
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 zo
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param zoomScale: (C Q E) Scale the zoom
:returns: The name of the context
"""
pass
def CreatePolygonTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddPondDynamicLocator(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MoveSkinJointsToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NewScene(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveBindingSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MakePressureCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateSubdivSurfaceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowAnimationUI(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeSelectMaterialsFromObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyDuplicateAndConnect(*args, removeOriginalFromShaders: bool=True, renameChildren:
bool=True, **kwargs)->None:
"""
This command duplicates the input polygonal object, connects up the outMesh attribute of
the original polygonal shape to the inMesh attribute of the newly created duplicate shape
and copies over the shader assignments from the original shape to the new duplicated shape
The command will fail if no objects are selected or sent as argument or if the
:param removeOriginalFromShaders: (C) Used to specify if the original object should be
removed from the shaders (shadingGroups) that it is a member of The shader associations
will get tr
:param renameChildren: (C) rename the children nodes of the hierarchy, to make them unique
:returns:
"""
pass
def ProjectWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowWrapInfluences(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def rampWidget(*args, **kwargs)->None:
"""
"""
pass
def NodeEditorIncreaseTraversalDepth(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Delete(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def coarsenSubdivSelectionList(*args, **kwargs)->bool:
"""
Coarsens a subdivision surface set of components based on the selection list The selected
components are selected at a coarser level
:returns: Command result
"""
pass
def SetFullBodyIKKeysBodyPart(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SymmetrizeUVBrushSizeOff(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBifrostMotionField(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TogglePolygonFaceCenters(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ParticleInstancer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sortCaseInsensitive(*args, **kwargs)->List[AnyStr]:
"""
This command sorts all the strings of an array in a case insensitive way
:returns: string to sort
"""
pass
def ModifyDisplacementPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def itemFilterAttr(*args, byName: Union[AnyStr, bool]="", byNameString: Union[AnyStr,
List[AnyStr], bool]="", byScript: Union[AnyStr, bool]="", classification:
Union[AnyStr, bool]="", dynamic: bool=True, exists: bool=True, hasCurve:
bool=True, hasDrivenKey: bool=True, hasExpression: bool=True, hidden:
bool=True, intersect: Union[List[AnyStr, AnyStr], bool]=None, keyable:
bool=True, listBuiltInFilters: bool=True, listOtherFilters: bool=True,
listUserFilters: bool=True, negate: bool=True, parent: AnyStr="", published:
bool=True, readable: bool=True, scaleRotateTranslate: bool=True,
secondScript: Union[AnyStr, bool]="", text: Union[AnyStr, bool]="", union:
Union[List[AnyStr, AnyStr], bool]=None, writable: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a named itemFilterAttr object This object can be attached to editors,
in order to filter the attributes going through them Using union and intersection filters,
complex composite filters can be created
:param byName: (C Q E) The filter will only pass items whose names match the given regular
expression string This string can contain the special characters * and ? '?' ma
:param byNameString: (C Q E M) The filter will only pass items whose names match the given
string This is a multi-use flag which allows the user to specify several strings The fi
:param byScript: (C Q E) The filter will run a MEL script named by the given string on each
attribute name Attributes will pass the filter if the script returns a non-zero v
:param classification: (C Q E) Indicates whether the filter is a built-in or user filter
The string argument must be either "builtIn" or "user" The "other" filter classification
:param dynamic: (C Q E) The filter will only pass dynamic attributes
:param exists: (C Q E) The filter will only pass attributs that exist
:param hasCurve: (C Q E) The filter will only pass attributes that are driven by animation
curves
:param hasDrivenKey: (C Q E) The filter will only pass attributes that are driven by driven
keys
:param hasExpression: (C Q E) The filter will only pass attributes that are driven by
expressions
:param hidden: (C Q E) The filter will only pass attributes that are hidden to the user
:param intersect: (C Q E) The filter will consist of the intersection of two other filters,
whose names are the given strings Attributes will pass this filter if and only if
:param keyable: (C Q E) The filter will only pass attributes that are keyable
:param listBuiltInFilters: (Q) Returns an array of all attribute filters with
classification "builtIn"
:param listOtherFilters: (Q) The "other" classification has been deprecated Use "user"
instead Returns an array of all attribute filters with classification "other"
:param listUserFilters: (Q) Returns an array of all attribute filters with classification
"user"
:param negate: (C Q E) This flag can be used to cause the filter to invert itself, and
reverse what passes and what fails
:param parent: () This flag is no longer supported
:param published: (C Q E) The filter will only pass attributes that are published on the
container
:param readable: (C Q E) The filter will only pass attributes that are readable (outputs)
:param scaleRotateTranslate: (C Q E) The filter will show only SRT attributes: scale,
rotate, translate and their children
:param secondScript: (C Q E) Can be used in conjunction with the -bs flag The second
script is for filtering whole lists at once, rather than individually Its signature must
be
:param text: (C Q E) Defines an annotation string to be stored with the filter
:param union: (C Q E) The filter will consist of the union of two other filters, whose
names are the given strings Attributes will pass this filter if they pass at least
:param writable: (C Q E) The filter will only pass attributes that are writable (inputs)
:returns: Single command result
"""
pass
def OutlinerToggleOrganizeByLayer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def caddyManip(*args, **kwargs)->None:
"""
"""
pass
def InsertEdgeLoopToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def geometryMergeCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyEvaluate(*args, accurateEvaluation: bool=True, activeShells: bool=True, activeUVShells:
bool=True, area: bool=True, boundingBox: bool=True, boundingBox2d: bool=True,
boundingBoxComponent: bool=True, boundingBoxComponent2d: bool=True,
displayStats: bool=True, edge: bool=True, edgeComponent: bool=True, face:
bool=True, faceArea: bool=True, faceComponent: bool=True, format: bool=True,
shell: bool=True, triangle: bool=True, triangleComponent: bool=True, uvArea:
bool=True, uvComponent: bool=True, uvEdgePairs: bool=True, uvFaceArea:
bool=True, uvSetName: AnyStr="", uvShell: bool=True, uvShellIds: bool=True,
uvcoord: bool=True, uvsInShell: int=0, vertex: bool=True, vertexComponent:
bool=True, worldArea: bool=True, worldFaceArea: bool=True, **kwargs)->Any:
"""
Returns the required counts on the specified objects
:param accurateEvaluation: (C) used to get accurate results for the bounding box
computation For objects with large vertex counts, accurate evaluation takes more time
:param activeShells: (C) returns the indices of active shells as an array of int
:param activeUVShells: (C) returns the indices of active UV shells (for the current map if
one is not specified) as an array of int
:param area: (C) returns the surface area of the object's faces in local space as a float
:param boundingBox: (C) returns the object's bounding box in 3d space as 6 floats in MEL:
xmin xmax ymin ymax zmin zmax, or as a tuple of three pairs in Python: ((xmin,xmax)
:param boundingBox2d: (C) returns the object's uv bounding box (for the current map if one
is not specified) in 2d space as 4 floats in MEL : xmin xmax ymin ymax, or as a tupl
:param boundingBoxComponent: (C) returns the bounding box of selected components in 3d
space as 6 floats in MEL : xmin xmax ymin ymax zmin zmax, or as a tuple of three pairs in
Pytho
:param boundingBoxComponent2d: (C) returns the bounding box of selected/specified
components uv coordinates in 2d space as 4 floats in MEL : xmin xmax ymin ymax, or as a
tuple of two p
:param displayStats: (C) toggles the display of poly statistics for the active View All
other flags are ignored if this flag is specified (Obsolete - refer to the headsUpDis
:param edge: (C) returns the number of edges as an int
:param edgeComponent: (C) returns the object's number of selected edges as an int
:param face: (C) returns the number of faces as an int
:param faceArea: (C) returns the surface area of selected/specified faces in local space as
an array of float
:param faceComponent: (C) returns the object's number of selected faces as an int
:param format: (C) used to display the results as an explicit sentence
:param shell: (C) returns the number of shells (disconnected pieces) as an int
:param triangle: (C) returns the number of triangles as an int
:param triangleComponent: (C) returns the number of triangles of selected components as an
int
:param uvArea: (C) returns the UV area of the object's faces in 2d space as a float
:param uvComponent: (C) returns the object's number of selected uv coordinates as an int
:param uvEdgePairs: (C) returns the pairs of UVs that are on the selected/specified edges
:param uvFaceArea: (C) returns the UV area of selected/specified faces in 2d space as an
array of float
:param uvSetName: (C) used when querying texture vertices to specify the uv set If a uv
set is not specified then the current map for the object will be used
:param uvShell: (C) returns the number of UV shells (for the current map if one is not
specified) as an int
:param uvShellIds: (C) returns the UV shell indices for selected/specified faces or UVs as
an array of int (for the current map if one is not specified), one shell index pe
:param uvcoord: (C) returns the number of uv coordinates (for the current map if one is not
specified) as an int
:param uvsInShell: (C) returns all UVs inside specified shell(for the current map if one is
not specified), use activeUVShells to get shell indices for current selection, u
:param vertex: (C) returns the number of vertices as an int
:param vertexComponent: (C) returns the object's number of selected vertices as an int
:param worldArea: (C) returns the surface area of the object's faces in world space as a
float
:param worldFaceArea: (C) returns the surface area of selected/specified faces in world
space as an array of float
:returns: a MEL array of values, a Python dictionary, or a string, depending on
the format
requested and the language called from.
"""
pass
def polySelectEditCtx(*args, adjustEdgeFlow: Union[float, bool]=1.0, divisions: Union[int,
bool]=2, exists: bool=True, fixQuads: bool=False, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
insertWithEdgeFlow: bool=False, smoothingAngle: Union[float, bool]=0.0,
splitType: Union[int, bool]=0, useEqualMultiplier: bool=True,
absoluteOffset: bool=True, autoComplete: bool=True, deleteEdge: bool=True,
endVertexOffset: Union[float, bool]=0.0, mode: Union[int, bool]=0,
startVertexOffset: Union[float, bool]=0.0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a new context to select and edit polygonal objects
:param adjustEdgeFlow: (C Q E) The weight value of the edge vertices to be positioned
Default: 1.0f
:param divisions: (C Q E) Number of divisions Default: 2
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param fixQuads: (C Q E) Fixes splits which go across a quad face leaving a 5 and 3 sided
faces by splitting from the middle of the new edge to the vertex accross from the ed
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param insertWithEdgeFlow: (C Q E) True to enable edge flow Otherwise, the edge flow is
disabled Default: false
:param smoothingAngle: (C Q E) Angle below which new edges will be smoothed Default: kPi
:param splitType: (C Q E) Format: 0 - Absolute, 1 - Relative, 2 - Multi Default:
TdnpolySplitRing::Relative
:param useEqualMultiplier: (C Q E) Changes how the profile curve effects the offset when
doing a multisplit If true then the verts will be offset the same distance based on the
shorte
:param absoluteOffset: (C Q E) This flag is deprecated Use splitType/stp instead This
flag is deprecated Use splitType/stp instead
:param autoComplete: (C) If true then use auto completion on selections
:param deleteEdge: (C Q E) When true, the end edges are deleted so the end triangles are
converted to quads
:param endVertexOffset: (C Q E) Weight value controlling the offset of the end vertex of
the edgeloop
:param mode: (C Q E) which mode to work on Available modes are 1-loop and 2-ring
:param startVertexOffset: (C Q E) Weight value controlling the offset of the start vertex
of the edgeloop
:returns: The context name
"""
pass
def sbs_GetPackageFullPathNameFromSubstanceNode(*args, **kwargs)->None:
"""
"""
pass
def polySetToFaceNormal(*args, setUserNormal: bool=False, **kwargs)->AnyStr:
"""
This command takes selected polygonal vertices or vertex-faces and changes their normals
If the option userNormal is used, the new normal values will be the face normals arround
the vertices/vertex-faces Otherwise the new normal values will be default values according
to the internal calculation
:param setUserNormal: (C) when this flag is presented, user normals will be created on each
vertex face and the values will be the face normal value Otherwise the normal valu
:returns: of the node name
"""
pass
def FBXExportSmoothMesh(*args, **kwargs)->None:
"""
"""
pass
def polySeparate(*args, caching: bool=True, nodeState: Union[int, bool]=0, removeShells:
bool=True, separateSpecificShell: Union[int, List[int]]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command creates new objects from the given poly A new object will be created for each
section of the mesh that is distinct (no edges connect it to the rest of the mesh)
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param removeShells: (C) Remove the shells after creation
:param separateSpecificShell: (C M) List of shell ids to be separated
:returns: Object name(s) and node name.
"""
pass
def CreateSpringOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ScaleKeysOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveBifrostCollider(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def saveInitialState(*args, attribute: Union[AnyStr, List[AnyStr]]="", saveall: bool=True,
**kwargs)->AnyStr:
"""
saveInitialState saves the current state of dynamics objects as the initial state A
dynamic object is a particle shape, rigid body, rigid constraint or rigid solver If no
objects are specified, it saves the initial state for any selected objects It returns the
names of the objects for which initial state was saved
:param attribute: (C M) Save the initial state of the specified attribute only This is a
multi-use flag
:param saveall: (C) Save the initial state for all dynamics objects in the scene
:returns: Command result
"""
pass
def dR_setRelaxAffectsBorders(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ResetReflectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def launch(*args, directory: AnyStr="", movie: AnyStr="", pdfFile: AnyStr="", webPage:
AnyStr="", **kwargs)->None:
"""
Launch the appropriate application to open the document, web page or directory specified
:param directory: (C) A directory
:param movie: (C) A movie file The only acceptable movie file formats are MPEG, Quicktime,
and Windows Media file The file's name must end with .mpg, .mpeg, .mp4, .w
:param pdfFile: (C) A PDF (Portable Document Format) document The file's name must end
with .pdf
:param webPage: (C) A web page
:returns:
"""
pass
def xgmDataQueryHelperForTest(*args, **kwargs)->None:
"""
"""
pass
def RotateToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def attrControlGrp(*args, annotation: Union[AnyStr, bool]="", attribute: Union[name, bool]=None,
changeCommand: Union[Script, bool]=None, enable: bool=True, exists:
bool=True, handlesAttribute: Union[name, bool]=None, hideMapButton:
bool=True, label: Union[AnyStr, bool]="", preventOverride: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a control of the type most appropriate for the specified attribute,
and associates the control with the attribute Any change to the control will cause a
change in the attribute value, and any change to the attribute value will be reflected in
the control Not all attribute types are supported
:param annotation: (C Q E) Sets or queries the annotation value of the control group
:param attribute: (C Q E) Sets or queries the attribute the control represents The name of
the attribute must be fully specified, including the name of the node Some types o
:param changeCommand: (C Q E) Sets or queries the change command of the control group The
change command will be executed when the control is used to change the value of the attr
:param enable: (C Q E) Sets or queries the enable state of the control group The control
is dimmed if the enable state is set to false
:param exists: (C Q E) Returns whether the specified object exists or not Other flags are
ignored
:param handlesAttribute: (Q E) Returns true or false as to whether this command can create
a control for the specified attribute In query mode, this flag needs a value
:param hideMapButton: (C Q E) Force the map button to remain hidden for this control
:param label: (C Q E) Sets or queries the label of the control group
:param preventOverride: (C Q E) Sets or queries the prevent adjustment state of the control
group If true, the RMB menu for the control will not allow adjustments to be made
:returns: The control name.
"""
pass
def ModifyOpacityRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def clearDynStartState(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def paramDimension(*args, **kwargs)->AnyStr:
"""
This command is used to create a param dimension to display the parameter value of a
curve/surface at a specified point on the curve/surface
:returns: Name of the paramDimension shape node created
"""
pass
def applyTake(*args, channel: Union[AnyStr, List[AnyStr]]="", device: Union[AnyStr,
List[AnyStr]]="", filter: Union[AnyStr, List[AnyStr]]="", preview: bool=True,
recurseChannel: bool=True, reset: bool=True, specifyChannel: bool=True,
startTime: time=None, **kwargs)->None:
"""
This command takes data in a device (refered to as a take) and converts it into a form that
may be played back and reviewed The take can either be imported through the readTake
action, or recorded by the recordDevice action The take is either converted into animation
curves or if the -preview flag is used, into blendDevice nodes The command loo
:param channel: (C M) This flag overrides the set channel enable value If a channel is
specified, it will be enabled C: The default is all applyTake enabled channels for
:param device: (C M) Specifies which device contains the take C: The default is all
applyTake enabled devices
:param filter: (C M) This flag specifies the filters to use during the applyTake If this
flag is used multiple times, the ordering of the filters is from left to right
:param preview: (C) Applies the take to blendDevice nodes attached to the target attributes
connected to the device attachments Animation curves attached to the attribu
:param recurseChannel: (C) When this flag is used, the children of the channel(s) specified
by -c/channel are also applied C: The default is all of the enabled channels
:param reset: (C) Resets the blendDevice nodes affected by -preview The preview data is
removed and if animation curves exist, they are used during playback
:param specifyChannel: (C) This flag is used with -c/channel flag When used, applyTake
will only work on the channels listed with the -c/channel flag C: The default is all of
:param startTime: (C) The default start time for a take is determined at record time The
startTime option sets the starting time of the take in the current animation unit
:returns:
"""
pass
def MoveRotateScaleTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TextureViewWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FitBSpline(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXResamplingRate(*args, **kwargs)->None:
"""
"""
pass
def dR_hypershadeTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_gridSnapPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def muMessageQuery(*args, **kwargs)->None:
"""
"""
pass
def FBXExportApplyConstantKeyReducer(*args, **kwargs)->None:
"""
"""
pass
def SelectFacePath(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExportSelectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeSaveSwatchesToDisk(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AbortCurrentTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def collision(*args, friction: Union[float, bool]=0.0, name: Union[AnyStr, bool]="", offset:
Union[float, bool]=0.0, resilience: Union[float, bool]=0.0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
For each listed object, the command creates a new field The field has a shape which lives
in the DAG and it has an associated dependency node The field is added to the list of
fields owned by the object Use connectDynamic to cause the field to affect a dynamic
object Note that if more than one object is listed, a separate field is created for e
:param friction: (Q E) Friction of the surface This is the amount of the colliding
particle's velocity parallel to the surface which is removed when the particle collides
:param name: (Q E) name of field
:param offset: (Q E) Offset value for the connector
:param resilience: (Q E) Resilience of the surface This is the amount of the colliding
particle's velocity reflected along the normal of the surface A value of 1 will give
:returns: Geometry names that were setup for particle collision.
"""
pass
def TexSewDeactivateBrushSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def makePaintable(*args, activate: bool=True, activateAll: bool=True, altAttribute:
Union[AnyStr, List[AnyStr], bool]="", attrType: Union[AnyStr, bool]="",
clearAll: bool=True, remove: bool=True, shapeMode: Union[AnyStr, bool]="",
uiName: Union[AnyStr, bool]="", q=True, query=True, **kwargs)->Union[None,
Any]:
"""
Make attributes of nodes paintable to Attribute Paint Tool This command is used to
register new attributes to the Attribute Paint tool as paintable Once registered the
attributes will be recognized by the Attribute Paint tool and the user will be able to
paint them
:param activate: (C Q) Activate / deactivate the given paintable attribute Used to filter
out some nodes in the attribute paint tool
:param activateAll: (C Q) Activate / deactivate all the registered paintable attributes
Used to filter out some nodes in the attribute paint tool
:param altAttribute: (C Q M) Define an alternate attribute which will also receive the same
values There can be multiple such flags
:param attrType: (C Q) Paintable attribute type Supported types: intArray, doubleArray,
vectorArray, multiInteger, multiFloat, multiDouble, multiVector
:param clearAll: (C Q) Removes all paintable attribute definitions
:param remove: (C Q) Make the attribute not paintable any more
:param shapeMode: (C Q) This flag controls how Artisan correlates the paintable node to a
corresponding shape node It is used for attributes of type multi of multi, where t
:param uiName: (C Q) UI name Default is the attribute name
:returns:
"""
pass
def licenseCheck(*args, **kwargs)->None:
"""
"""
pass
def RemoveLatticeTweaks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DetachCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyMultiLayoutUV(*args, flipReversed: bool=True, gridU: int=0, gridV: int=0, layout: int=0,
layoutMethod: int=0, offsetU: float=0.0, offsetV: float=0.0,
percentageSpace: float=0.0, prescale: int=0, rotateForBestFit: int=0,
scale: int=0, sizeU: float=0.0, sizeV: float=0.0, uvSetName: AnyStr="",
**kwargs)->None:
"""
place the UVs of the selected polygonal objects so that they do not overlap
:param flipReversed: (C) If this flag is turned on, the reversed UV pieces are fliped
:param gridU: (C) The U size of the grids
:param gridV: (C) The V size of the grids
:param layout: (C) How to move the UV pieces, after cuts are applied: 0 No move is applied
1 Layout the pieces along the U axis 2 Layout the pieces in a square shape
:param layoutMethod: (C) // -lm/layoutMethod layoutMethod integer // (C, E, Q) Which layout
method to use: // 0 Block Stacking // 1 Shape Stacking
:param offsetU: (C) Offset the layout in the U direction by the given value
:param offsetV: (C) Offset the layout in the V direction by the given value
:param percentageSpace: (C) When layout is set to square, this value is a percentage of the
texture area which is added around each UV piece It can be used to ensure each UV pi
:param prescale: (C) Prescale the shell before laying it out 0 No scale is applied 1
Object space scaling applied 2 World space scaling applied
:param rotateForBestFit: (C) How to rotate the pieces, before move: 0 No rotation is
applied 1 Only allow 90 degree rotations 2 Allow free rotations
:param scale: (C) How to scale the pieces, after move: 0 No scale is applied 1 Uniform
scale to fit in unit square 2 Non proportional scale to fit in unit square
:param sizeU: (C) Scale the layout in the U direction by the given value
:param sizeV: (C) Scale the layout in the V direction by the given value
:param uvSetName: (C) Specifies the name of the uv set to edit uvs on If not specified
will use the current uv set if it exists
:returns:
"""
pass
def HypershadePublishConnections(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def showHelp(*args, absolute: bool=True, docs: bool=True, helpTable: bool=True, version:
bool=True, q=True, query=True, **kwargs)->Union[None, Any]:
"""
Invokes a web browser to open the on-line documentation and help files It will open the
help page for a given topic, or open a browser to a specific URL
:param absolute: (C) The specified "URL" is an absolute URL that should be passed directly
to the web browser
:param docs: (C Q) Use this flag to directly specify a help file relative to the on-line
documentation root
:param helpTable: (C Q) Use this flag to specify which file will be used to search for help
topics when the -d/docs and -a/absolute flags are not used If only a file name i
:param version: (Q) Use this flag to get the Maya version that the showHelp command uses
:returns:
"""
pass
def polySelectSp(*args, **kwargs)->None:
"""
"""
pass
def AssignTemplateOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ViewAlongAxisX(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ViewAlongAxisZ(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def distanceDimContext(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Command used to register the distanceDimCtx tool
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: - name of the context created
"""
pass
def ATOMTemplateOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AppendToPolygonToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintCacheTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleBackfaceGeometry(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorGraphNoShapes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_mtkToolTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def subdAutoProjection(*args, caching: bool=True, nodeState: Union[int, bool]=0,
constructionHistory: bool=True, layout: Union[int, bool]=0,
layoutMethod: Union[int, bool]=0, name: AnyStr="", optimize: Union[int,
bool]=0, percentageSpace: Union[float, bool]=0.0, planes: Union[int,
bool]=6, scale: Union[int, bool]=0, skipIntersect: bool=True,
worldSpace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Projects a texture map onto an object, using several orthogonal projections simultaneously
The argument is a face selection list
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param constructionHistory: (C) Turn the construction history on or off
:param layout: (C Q E) What layout algorithm should be used: 0 UV pieces are aligned along
the U axis 1 UV pieces are moved in a square shape
:param layoutMethod: (C Q E) Which layout method to use: 0 Block Stacking 1 Shape
Stacking
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param optimize: (C Q E) Use two different flavors for the cut generation 0 Every face is
assigned to the best plane This optimizes the map distortion 1 Small UV pieces ar
:param percentageSpace: (C Q E) When layout is set to square, this value is a percentage of
the texture area which is added around each UV piece It can be used to ensure each UV pi
:param planes: (C Q E) Number of intermediate projections used Valid numbers are 4, 5, 6,
8, and 12 C: Default is 6
:param scale: (C Q E) How to scale the pieces, after projections: 0 No scale is applied 1
Uniform scale to fit in unit square 2 Non proportional scale to fit in unit squ
:param skipIntersect: (C Q E) When on, self intersection of UV pieces are not tested This
makes the projection faster and produces fewer pieces, but may lead to overlaps in UV sp
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def AddPfxToHairSystem(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dynPref(*args, autoCreate: bool=True, echoCollision: bool=True, runupFrom: Union[int,
bool]=0, runupToCurrentTime: bool=True, saveOnQuit: bool=True, saveRuntimeState:
bool=True, q=True, query=True, **kwargs)->Union[None, Any]:
"""
This action modifies and queries the current state of "autoCreate rigid bodies", "run up to
current time", and "run up from" (previous time or start time)
:param autoCreate: (C Q) If on, autoCreate rigid bodies
:param echoCollision: (C Q) If on, will cause particle systems to echo to the Script Editor
the command that they are running for each particle collision event If off, only the
:param runupFrom: (C Q) If on, run up from previous time; if 2, run up from start time
:param runupToCurrentTime: (C Q) If on, run up the scene to current time
:param saveOnQuit: (C Q) If on, save the current values of preferences to userPrefs file
:param saveRuntimeState: (C Q) If on, runtime state as well as initial state of all
particle objects will be saved to file If off, only initial state will be saved
:returns:
"""
pass
def waitCursor(*args, state: bool=True, q=True, query=True, **kwargs)->Union[bool, Any]:
"""
This command sets/resets a wait cursor for the entire Maya application This works as a
stack, such that for each waitCursor -state on command executed there should be a matching
waitCursor -state off command pending Warning: If a script fails that has turned the wait
cursor on, the wait cursor may be left on You need to turn it off manually from
:param state: (C Q) Set or reset the wait cursor for the entire Maya application
:returns: True if the wait cursor is on.
"""
pass
def FBXUIShowOptions(*args, **kwargs)->None:
"""
"""
pass
def hwRenderLoad(*args, **kwargs)->None:
"""
Empty command used to force the dynamic load of HR render
:returns:
"""
pass
def RemoveBifrostAdaptiveMesh(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SubdivToNURBSOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UnfoldUV(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveBifrostGuide(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteCurrentColorSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UpdateCurrentScene3dsMax(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RelaxInitialStateOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateTextureDeformer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def choice(*args, attribute: Union[AnyStr, List[AnyStr]]="", controlPoints: bool=False, index:
Union[int, bool]=0, name: Union[AnyStr, bool]="", selector: Union[name, bool]=None,
shape: bool=True, sourceAttribute: name=None, time: Union[time, List[time]]=None,
q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The choice command provides a mechanism for changing the inputs to an attribute based on
some (usually time-based) criteria For example, an object could be animated from frames 1
to 30 by a motion path, then from frames 30 to 50 it follows keyframe animation, and after
frame 50 it returns to the motion path Or, a revolve surface could change its
:param attribute: (C M) specifies the attributes onto which choice node(s) should be
created The default is all keyable attributes of the given objects Note that although
:param controlPoints: (C) Explicitly specify whether or not to include the control points
of a shape (see "-s" flag) in the list of attributes Default: false
:param index: (C Q) specifies the multi-input index of the choice node to connect the
source attribute to When queried, returns a list of integers one per specified -t/
:param name: (C Q) the name to give to any newly created choice node(s) When queried,
returns a list of strings
:param selector: (C Q) specifies the attribute to be used as the choice node's selector
The value of the selector at a given time determines which of the choice node's mul
:param shape: (C) Consider all attributes of shapes below transforms as well, except
"controlPoints" Default: true
:param sourceAttribute: (C) specifies the attribute to connect to the choice node that will
be selected at the given time(s) specified by -t/time
:param time: (C M) specifies the time at which the choice should use the given source
attribute, or the currently connected attribute if source attribute is not specifi
:returns: The newly created and/or modified choice nodes, with the attribute
for which a
selector keyframe was created.
For example: choice1.input[3] choice2.input[3]
"""
pass
def OutlinerToggleReferenceMembers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SendToUnityAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MovePolygonComponent(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def objectType(*args, isAType: AnyStr="", isType: AnyStr="", tagFromType: AnyStr="",
typeFromTag: int=0, typeTag: bool=True, **kwargs)->AnyStr:
"""
This command returns the type of elements Warning: This command is incomplete and may not
be supported by all object types
:param isAType: (C) Returns true if the object is the specified type or derives from an
object that is of the specified type This flag will only work with dependency no
:param isType: (C) Returns true if the object is exactly of the specified type False
otherwise
:param tagFromType: (C) Returns the type tag given a type name
:param typeFromTag: (C) Returns the type name given an integer type tag
:param typeTag: (C) Returns an integer tag that is unique for that object type Not all
object types will have tags This is the unique 4-byte value that is used to iden
:returns: The type of the specified object
"""
pass
def AbcExport(*args, **kwargs)->None:
"""
"""
pass
def polyFlipUV(*args, caching: bool=True, constructionHistory: bool=True, createNewMap:
bool=True, cutUV: bool=True, flipType: Union[int, bool]=0,
insertBeforeDeformers: bool=True, local: bool=True, name: AnyStr="", nodeState:
Union[int, bool]=0, pivotU: Union[float, bool]=0.0, pivotV: Union[float,
bool]=0.0, usePivot: bool=True, uvSetName: AnyStr="", worldSpace: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Flip (mirror) the UVs (in texture space) of input polyFaces, about either the U or V axis.
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createNewMap: (C) Set to true if a new map should be created
:param cutUV: (C Q E) Cut UV edges when flipping some components on a UV shell C: Default
is on Q: When queried, returns an int
:param flipType: (C Q E) Vertical
:param insertBeforeDeformers: (C) Set to true if the new node created should inserted
before any deformer nodes
:param local: (C Q E) Flips in the local space of the input faces C: Default is on Q:
When queried, returns an int
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pivotU: (C Q E) Specifies the pivot value, in the U direction
:param pivotV: (C Q E) Specifies the pivot value, in the V direction
:param usePivot: (C Q E) Flip using pivot or not C: Default is off Q: When queried,
returns an int
:param uvSetName: (C) Name of the UV set to be created
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def ShowFkSkeleton(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BatchBakeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createPolyPipeCtx(*args, **kwargs)->None:
"""
"""
pass
def SnapToGrid(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddSelectionAsCombinationTargetOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def scriptEditorInfo(*args, clearHistory: bool=True, clearHistoryFile: bool=True,
historyFilename: Union[AnyStr, bool]="", input: AnyStr="", suppressErrors:
bool=True, suppressInfo: bool=True, suppressResults: bool=True,
suppressStackWindow: bool=True, suppressWarnings: bool=True, writeHistory:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
Use this command to directly manipulate and query the contents of the Command Window window
Note: Due to recent changes, certain flags will no longer work on the Script Editor Window
All flags will continue to work with the CommandWindow (old Script Editor) Note: This
command cannot be used to create a new script editor window
:param clearHistory: (E) Clears the read-only text in the upper field of the Command
Window
:param clearHistoryFile: (E) Clear the file defined by the -hf/historyFilename flag, but
only if -wh/writeHistory is true Use this flag to start a new history file, since the de
:param historyFilename: (Q E) Sets or returns the name of the file that the Command Window
will use to echo all of its history to If this is an empty string when the -wh/writeHis
:param input: (E) Sets the text in the lower field of the Command Window Set this value to
an empty string to clear the field Note: this flag only affects the Comman
:param suppressErrors: (Q E) When true, Command Window and Script Editor will not display
error messages
:param suppressInfo: (Q E) When true, Command Window and Script Editor will not display
info messages generated by Maya
:param suppressResults: (Q E) When true, Command Window and Script Editor will not display
command results
:param suppressStackWindow: (Q E) When true and when the stackTrace mechanism is on, this
flag will suppress the display of the stack window If stack trace is enabled then results
wi
:param suppressWarnings: (Q E) When true, Command Window and Script Editor will not display
warning messages
:param writeHistory: (Q E) When true, Command Window will echo all of its history to the
file defined by the -hf/historyFilename flag This flag effectively turns file writing
:returns: The name of the Command Window window is returned.
"""
pass
def GravityOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RenderFlagsWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Extrude(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def propMove(*args, percent: Union[float, List[float]]=0.0, percentX: Union[float,
List[float]]=0.0, percentY: Union[float, List[float]]=0.0, percentZ: Union[float,
List[float]]=0.0, pivot: List[float, float, float]=None, rotate: List[float, float,
float]=None, scale: List[float, float, float]=None, translate: List[float, float,
float]=None, worldSpace: bool=True, **kwargs)->None:
"""
Performs a proportional translate, scale or rotate operation on any number of objects The
percentages to rotate, scale or translate by can be specified using either the -p flags or
-px, -py, -pz flags Each selected object must have a corresponding -p or -px, -py, -pz
flag The rotate, scale or translate performed is relative
:param percent: (C M) The percentage effect that the specified x,y,z has on an object This
flag must be specified once for each object, ie if there are 4 objects specifi
:param percentX: (C M) The percentage effect that the specified x has on an object This
flag is specified one per object The value ranges between 0.0 and 1.0, but can be
:param percentY: (C M) The percentage effect that the specified y has on an object This
flag is specified one per object The value ranges between 0.0 and 1.0, but can be
:param percentZ: (C M) The percentage effect that the specified z has on an object This
flag is specified one per object The value ranges between 0.0 and 1.0, but can be
:param pivot: (C) Specify the pivot about which a rotation or scale will occur The change
in pivot lasts only as long as the current 'propMove' command, and so must b
:param rotate: (C) Proportionally rotate each object by the given angles The rotation
values are scaled by the percentage specified by that object's corresponding "-pe
:param scale: (C) Proportionally scale each object by the given amounts The scale values
are scaled by the percentage specified by that object's corresponding "-perce
:param translate: (C) Proportionally translate each object by the given amounts The
translation values are scaled by the percentage specified by that object's correspondi
:param worldSpace: (C) Use worldspace for the calculations
:returns:
"""
pass
def SetStrokeControlCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_vertUnlockAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyCBoolOp(*args, classification: Union[int, bool]=0, faceAreaThreshold: Union[float,
bool]=0.0001, operation: Union[int, bool]=0, preserveColor: bool=False,
useCarveBooleans: bool=True, useThresholds: bool=False,
vertexDistanceThreshold: Union[float, bool]=0.001, caching: bool=True,
mergeUVSets: Union[int, bool]=0, nodeState: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command creates a new poly as the result of a boolean operation on input polys : union,
intersection, difference
:param classification: (C Q E) Changes how intersections of open and closed manifolds are
treated 1 for "Edge", 2 for "Normal"
:param faceAreaThreshold: (C Q E) Area threshold to determine whether faces should be
collapsed before boolean Attribute is ignored unless useThresholds is set to true Default:
0.000
:param operation: (C Q E) Boolean operation type 1=union, 2=difference, 3=intersection
Default type is union Default: kBoolOpUnion
:param preserveColor: (C Q E) If true, boolean op will compute color for the new mesh If
false, the new mesh won't have any color set Default: false
:param useCarveBooleans: (C Q E) If true, use the Carve Boolean library
:param useThresholds: (C Q E) If true, merge vertices with separations less then
vertexDistanceThreshold and collapse faces with areas less then faceAreaThreshold If false,
do no
:param vertexDistanceThreshold: (C Q E) Tolerance to determine whether vertices (and edges)
should be merged before boolean operation is applied Attribute is ignored unless
useThresholds i
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param mergeUVSets: (C Q E) Specify how UV sets will be merged on the output mesh 0 = "No
Merge": Each UV set on each mesh will become a new UV set in the output 1 = "Merge By
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: Object name and node name.
"""
pass
def XgGroomingVis(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def meshReorderContext(*args, **kwargs)->None:
"""
"""
pass
def GraphCut(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def panZoomCtx(*args, alternateContext: bool=True, buttonDown: bool=True, buttonUp: bool=True,
exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name: AnyStr="",
panMode: bool=True, toolName: Union[AnyStr, bool]="", zoomMode: bool=True,
zoomScale: Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create camera 2D pan/zoom context
:param alternateContext: (C Q) Set the ALT+MMB and ALT+SHIFT+MMB to refer to this context
:param buttonDown: (C) Perform the button down operation
:param buttonUp: (C) Perform the button up operation
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param panMode: (C) Specify to create a camera 2D pan context, which is the default
:param toolName: (C Q) Name of the specific tool to which this command refers
:param zoomMode: (C) Specify to create a camera 2D zoom context
:param zoomScale: (C Q E) Scale the zoom The smaller the scale the slower the drag
:returns: The name of the context
"""
pass
def displaySurface(*args, flipNormals: bool=True, twoSidedLighting: bool=True, xRay: bool=True,
q=True, query=True, **kwargs)->Union[bool, Any]:
"""
This command toggles display options on the specified or active surfaces Typically this
command applies to NURBS or poly mesh surfaces and ignores other type of objects
:param flipNormals: (Q) flip normal direction on the surface
:param twoSidedLighting: (Q) toggle if the surface should be considered two-sided If it's
single-sided, drawing and rendering may use single sided lighting and back face cull to
:param xRay: (Q) toggle X ray mode (make surface transparent)
:returns: when in the query mode.
"""
pass
def SquareSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveShrinkWrapInnerObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutTangentSpline(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def help(*args, documentation: bool=True, language: AnyStr="", list: bool=True,
popupDisplayTime: Union[int, bool]=4, popupMode: bool=True, popupPauseTime: Union[int,
bool]=800, popupSimpleMode: bool=True, rolloverMode: bool=True, syntaxOnly: bool=True,
q=True, query=True, **kwargs)->Union[None, Any]:
"""
With no arguments, help tells how to use help If a command name is specified, help will
return the quick help for that command Other flags can be used to open the online
documentation, or to list available commands based on a pattern Pattern follows the
following syntax: * matches any string ? matches any character [agj] matches a, g or j
[^0-
:param documentation: (C) Use a browser to show the documentation associated with the
single command name given A pattern cannot be used with this flag If no command name is
:param language: (C) Show the help for this command in the specified language Valid values
are "mel" and "python" The default is Mel Used with the doc flag
:param list: (C) List all the commands whose names match the regular expression Pass the
regular expression as the first argument to the command specified
:param popupDisplayTime: (C Q) Set the amount of time, in seconds, that the popup help will
be displayed The default is 4 seconds This flag is mutually exclusive of the list and
:param popupMode: (C Q) Turn on or off popup help mode This flag is mutually exclusive of
the list and doc flags
:param popupPauseTime: (C Q) Set the amount of time, in milliseconds, before the popup help
will be displayed The default is 800 milliseconds This flag is mutually exclusive of
:param popupSimpleMode: (C Q) Turn on or off simple popup help mode If set, ToolClips will
display only name and keyboard shortcut
:param rolloverMode: (C Q) Turn on or off rollover help mode This flag is mutually
exclusive with the list and doc flags
:param syntaxOnly: (C) When no other flag is specified, return only the syntax part of the
quick help
:returns:
"""
pass
def treeView(*args, addItem: Union[List[AnyStr, AnyStr], List[List[AnyStr, AnyStr]]]=None,
allowDragAndDrop: bool=True, allowHiddenParents: bool=True, allowMultiSelection:
bool=True, allowReparenting: bool=True, annotation: Union[AnyStr, bool]="",
attachButtonRight: int=0, backgroundColor: Union[List[float, float, float],
bool]=None, borderHighlite: List[AnyStr, bool]=None, borderHighliteColor:
List[AnyStr, float, float, float]=None, buttonErase: Union[List[AnyStr, bool],
List[List[AnyStr, bool]]]=None, buttonState: Union[List[AnyStr, int, AnyStr],
List[List[AnyStr, int, AnyStr]]]=None, buttonStyle: Union[List[AnyStr, int,
AnyStr], List[List[AnyStr, int, AnyStr]]]=None, buttonTextIcon: Union[List[AnyStr,
int, AnyStr], List[List[AnyStr, int, AnyStr]]]=None, buttonTooltip:
Union[List[AnyStr, int, AnyStr], List[List[AnyStr, int, AnyStr]]]=None,
buttonTransparencyColor: Union[List[AnyStr, int, float, float, float],
List[List[AnyStr, int, float, float, float]]]=None, buttonTransparencyOverride:
Union[List[AnyStr, int, bool], List[List[AnyStr, int, bool]]]=None, buttonVisible:
Union[List[AnyStr, int, bool], List[List[AnyStr, int, bool]]]=None, children:
Union[AnyStr, bool]="", clearSelection: bool=True, contextMenuCommand: Script=None,
defineTemplate: AnyStr="", displayLabel: Union[List[AnyStr, AnyStr],
List[List[AnyStr, AnyStr]]]=None, displayLabelSuffix: Union[List[AnyStr, AnyStr],
List[List[AnyStr, AnyStr]]]=None, docTag: Union[AnyStr, bool]="",
dragAndDropCommand: Script=None, dragCallback: Script=None, dropCallback:
Script=None, editLabelCommand: Script=None, enable: bool=True, enableBackground:
bool=True, enableButton: Union[List[AnyStr, int, int], List[List[AnyStr, int,
int]]]=None, enableKeyboardFocus: bool=True, enableKeys: bool=True, enableLabel:
List[AnyStr, int]=None, exists: bool=True, expandCollapseCommand: Script=None,
expandItem: List[AnyStr, bool]=None, flatButton: Union[int, bool]=0, font:
Union[List[AnyStr, AnyStr], bool]=None, fontFace: List[AnyStr, int]=None,
fullPathName: bool=True, height: Union[int, bool]=0, hideButtons: bool=True,
highlightColor: Union[List[float, float, float], bool]=None, highlite: List[AnyStr,
bool]=None, highliteColor: List[AnyStr, float, float, float]=None,
ignoreButtonClick: Union[List[AnyStr, int, int], List[List[AnyStr, int,
int]]]=None, image: Union[List[AnyStr, int, AnyStr], List[List[AnyStr, int,
AnyStr]]]=None, insertItem: Union[List[AnyStr, AnyStr, int], List[List[AnyStr,
AnyStr, int]]]=None, isItemExpanded: Union[AnyStr, bool]="", isLeaf: Union[AnyStr,
bool]="", isObscured: bool=True, item: Union[AnyStr, bool]="", itemAnnotation:
Union[List[AnyStr, AnyStr], bool]=None, itemDblClickCommand: Script=None,
itemDblClickCommand2: Script=None, itemExists: Union[AnyStr, bool]="", itemIndex:
Union[AnyStr, bool]="", itemParent: Union[AnyStr, bool]="", itemRenamedCommand:
Script=None, itemSelected: Union[AnyStr, bool]="", itemVisible: List[AnyStr,
bool]=None, labelBackgroundColor: List[AnyStr, float, float, float]=None, manage:
bool=True, noBackground: bool=True, numberOfButtons: int=0, numberOfPopupMenus:
bool=True, ornament: List[AnyStr, int, int, int]=None, ornamentColor: List[AnyStr,
float, float, float]=None, parent: Union[AnyStr, bool]="", popupMenuArray:
bool=True, pressCommand: Union[List[int, Script], List[List[int, Script]]]=None,
preventOverride: bool=True, removeAll: bool=True, removeItem: AnyStr="",
reverseTreeOrder: bool=True, rightPressCommand: Union[List[int, Script],
List[List[int, Script]]]=None, select: List[AnyStr, int]=None, selectCommand:
Script=None, selectItem: List[AnyStr, bool]=None, selectionChangedCommand:
Script=None, selectionColor: Union[List[AnyStr, float, float, float], bool]=None,
showItem: AnyStr="", statusBarMessage: AnyStr="", textColor: List[AnyStr, float,
float, float]=None, useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a custom control
:param addItem: (C E M) Adds a tree view item to the tree view First argument specifies
the item's name, second argument specifies the item's parent (use an empty string to
:param allowDragAndDrop: (C Q E) Allow the user to perform drag and drop of treeView items
If enabled, re-ordering / re-parenting operations can be perfomed with the middle mouse bu
:param allowHiddenParents: (C Q E) If not cleared(default), the treeView will make parent
nodes of visible nodes automatically visible
:param allowMultiSelection: (C Q E) Specify multi or single selection mode Allow the user
to perform multiple selection by holding ctrl or shift key while selecting items of
treeView i
:param allowReparenting: (C Q E) Allow the user to reparent items in the tree view using
the middle mouse button Defaults to true If false, user can still reorder items within a
gr
:param annotation: (C Q E) Annotate the control with an extra string value
:param attachButtonRight: (C E) Sets tree view item's buttons to appear on the right or
left Argument specifies if they are to be attached to the right, if it is set to false
they
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param borderHighlite: (C E) Sets an item's border as highlit or not First Argument
specifies item, second argument specifies on or off
:param borderHighliteColor: (C E) Sets the color an item's border highlite will turn when
highlite is enabled first parameter specifies layer three float values specify RGB values,
b
:param buttonErase: (C Q E M) If buttonErase was set true , then even if the button of the
treeView item is set invisible , the treeView will still erase the buttonRect of this tr
:param buttonState: (C E M) Sets the state of a button First argument specifies the layer,
second argument specifies which button, third argument specifies the state Possible s
:param buttonStyle: (C E M) Sets the type of button, used to indicate possible states and
if the button is reset upon release First argument specifies the layer, second argumen
:param buttonTextIcon: (C E M) Sets a one letter text to use as the icon to use for a
specific button on a specific item First argument specifies the item, second argument
specifi
:param buttonTooltip: (C E M) Sets a tooltip for specific button on a specific item First
argument specifies the item, second argument specifies the button, third argument specif
:param buttonTransparencyColor: (C E M) Sets the background color of a button that will be
used if buttonTransparencyOverride is enabled First argument specifies item, second
argument spec
:param buttonTransparencyOverride: (C E M) Sets a button's background as being overridden
or not First argument specifies item, second argument specifies button, third argument
specifies over
:param buttonVisible: (C M) Sets a button as visible or not First Argument specifies item
Second Argument specifies a button Third Argument specifies visible or not
:param children: (Q) Query the children of an item If the argument is null, all items will
be returned In query mode, this flag needs a value
:param clearSelection: (C E) Clears all selected items
:param contextMenuCommand: (C E) Set the callback function to be invoked just before any
attached context menu is shown This can be used as a replacement to, or in addition to the
p
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param displayLabel: (C E M) Set a label for the item that is different than the string
that identifies the item This label will be used in the display of the item The first pa
:param displayLabelSuffix: (C E M) Set a suffix for the display label for the item This
suffix will not be shown when renaming the item in the tree view
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragAndDropCommand: (C E) Sets the callback function to be invoked upon drag and
drop of layers the callback function should take as parameters: - a string array of the
dropp
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editLabelCommand: (C E) Set the callback function to be invoked when the user
changes the name of an item by double clicking it in the UI The callback should accept two
str
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableButton: (C E M) Sets a specific button on a specific item to being usable or
not First argument specifies the item, second argument specifies the button, third argu
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param enableKeys: (E) By default the treeview does not accept input from the keyboard By
enabling keyboard support The treeview will support up/down navigation using the
:param enableLabel: (C E) enables or disables the label of a tree view item from being
displayed The first parameter specifies the item, the second specifies on or off
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param expandCollapseCommand: (C E) Set the callback function to be invoked upon hitting
the expand/collapse button The function should take as parameters: - a string for the item
for
:param expandItem: (C E) Expands or collapses an item's children First argument specifies
the item, second argument specifies expanded or collapsed
:param flatButton: (C Q E) Type of flat button to use
:param font: (C Q E) The first parameter specifies the item string for the TtreeViewNode in
the TtreeNodeMap The second string specifies the font for the text Valid val
:param fontFace: (C E) Sets the font face used for the specified item's text: 0 for normal,
1 for bold, 2 for italic
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param hideButtons: (C E) Hides the buttons for an item in the tree view Can only be used
when adding the item to the tree with the "addItem" flag Space for the buttons is l
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param highlite: (C E) Sets an item as highlit Highliting is shown by outlining the item
First parameter specifies the item, the second specifies the highliting or not
:param highliteColor: (C E) Sets the color an item's highlite will turn when highlite is
enabled first parameter specifies layer three float values specify RGB values, between
:param ignoreButtonClick: (C E M) Sets a specific button on a specific item to ignore the
button clicks First argument specifies the item ,second argument specifies the button,
third
:param image: (C E M) Sets an image to use as the icon for the button First argument
specifies the item, second argument specifies the button, third argument specifies th
:param insertItem: (C E M) Create and insert a tree view item to the tree view First
argument specifies the item's name, second argument specifies the item's parent (use an em
:param isItemExpanded: (Q) Is the item in the tree view expanded In query mode, this flag
needs a value
:param isLeaf: (Q) Query whether an item is a leaf In query mode, this flag needs a value
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param item: (Q) Specify the item to query Used with the flag "selectionColor" and
"itemAnnotation" In query mode, this flag needs a value
:param itemAnnotation: (C Q E) Annotate the specified item with an extra string value When
used for query, this flag has no argument and needs to be used with the flag "item"
:param itemDblClickCommand: (C E) Set the callback function to be invoked when an item in
the tree has been double clicked The callback should accept one string, the display label
of
:param itemDblClickCommand2: (C E) Set the callback function to be invoked when an item in
the tree has been double clicked This callback is similar to itemDblClickCommand(idc), but
i
:param itemExists: (C Q) Queries the existence of the specified Tree View item In query
mode, this flag needs a value
:param itemIndex: (C Q) Get the index for the specified item in the list of children of the
item's parent Index is 0-based In query mode, this flag needs a value
:param itemParent: (C Q) If the specified item is a child, it returns the parent item If
the specified item is not a child it returns nothing In query mode, this flag needs
:param itemRenamedCommand: (C E) Set the callback function to be invoked when an item in
the tree has been renamed This occurs if there is a successful return of the command
attache
:param itemSelected: (Q) Queries the item is currently selected or not In query mode, this
flag needs a value
:param itemVisible: (C Q E) Control the given item's visibility
:param labelBackgroundColor: (C E) Set the background color for text label for a particular
item in the tree The first parameter specifies layer Set (-1.0, -1.0, -1.0) to restore
the
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfButtons: (C E) Specifies the number of buttons for items in the tree
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param ornament: (C E) Sets an item as having an ornament (a small colored circle), its
on/off state, if it should have a dot, and its size First Argument specifies item,
:param ornamentColor: (C E) Sets the color an ornament will be draw with for the specified
layer
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param pressCommand: (C E M) Sets the callback function to be invoked upon clicking a
treeView button First argument specifies which treeView button Second argument specifies
t
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param removeAll: (C E) Removes all items from the tree view
:param removeItem: (C E) Removes a tree view item from the tree view If this item has
children items, all children items are removed First argument specifies the item's nam
:param reverseTreeOrder: (C E) Controls the order the tree will be drawn in (reversed if
true)
:param rightPressCommand: (C E M) Sets the callback function to be invoked upon right
clicking a treeView button First argument specifies which treeView button Second argument
speci
:param select: (C E) Set selection on an element The first parameter specifies the item,
the second specifies on or off
:param selectCommand: (C E) Set the callback function to be invoked when an item is
selected or deselected in the tree The function should accept one string argument and one
in
:param selectItem: (C Q E) Sets an item's selected state first argument specifies the item,
second argument specifies selection status When used for query without arguments,
:param selectionChangedCommand: (C E) Set the callback function to be invoked when a
complete selection operation triggered by the user has occurred successfully The callback
is invoked
:param selectionColor: (C Q E) Sets the color an item will turn to indicate that it is
selected first parameter specifies the item three float values specify RGB values, between
0
:param showItem: (C E) Show the item Scroll the list as necessary so that item is visible
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param textColor: (C E) Sets the label's text color for the specified layer first argument
specifies layer three float values specify RGB values, between 0 and 1
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The full name of the control.
"""
pass
def polyToSubdiv(*args, absolutePosition: bool=True, applyMatrixToResult: bool=True, caching:
bool=True, maxEdgesPerVert: Union[int, bool]=32, maxPolyCount: Union[int,
bool]=1000, nodeState: Union[int, bool]=0, preserveVertexOrdering: bool=True,
quickConvert: bool=True, uvPoints: Union[List[float, float], List[List[float,
float]], bool]=None, uvPointsU: Union[float, bool]=0.0, uvPointsV: Union[float,
bool]=0.0, uvTreatment: Union[int, bool]=0, addUnderTransform: bool=True,
constructionHistory: bool=True, name: AnyStr="", object: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command converts a polygon and produces a subd surface The name of the new
subdivision surface is returned If construction history is ON, then the name of the new
dependency node is returned as well
:param absolutePosition: (C Q E) If true, the possible blind data information that comes
from the polygon will be treated as absolute positions of the vertices, instead of the
relati
:param applyMatrixToResult: (C Q E) If true, the matrix on the input geometry is applied to
the object and the resulting geometry will have identity matrix on it If false the
conversio
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param maxEdgesPerVert: (C Q E) The maximum allowed valence for a vertex on the input mesh
Default: 32
:param maxPolyCount: (C Q E) The maximum number of polygons accepted on the input mesh
Default: 1000
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param preserveVertexOrdering: (C Q E) Preserve vertex ordering in conversion Default:
true
:param quickConvert: (C Q E) Debug flag to test the performance Default: true
:param uvPoints: (C Q E M) This is a cached uv point needed to transfer uv data associated
with finer level vertices (when switching between standard editing mode and poly prox
:param uvPointsU: (C Q E) U value of a cached uv point
:param uvPointsV: (C Q E) V value of a cached uv point
:param uvTreatment: (C Q E) Treatment of Subd UVs when in proxy mode: 0 - preserve Subd UVs
1 - build Subd UVs from Poly UVs 2 - no UVs on Subd Default: 0
:param addUnderTransform: (C) If true then add the new subdivision surface under the poly's
transform
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:returns: - the subdivision and optionally the dependency node name
"""
pass
def enableDevice(*args, apply: bool=True, device: Union[AnyStr, bool]="", enable: bool=True,
monitor: bool=True, record: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
Sets (or queries) the device enable state for actions involving the device -monitor
affects all assignInputDevice and attachDeviceAttr actions for the named device -record
controls if the device is recorded (by default) by a recordDevice action -apply channelName
[channelName .. ] controls if data from the device channel is applied (by default)
:param apply: (C Q) enable/disable "applyTake" for the specified channel(s)
:param device: (C Q) specifies the device to change
:param enable: (C Q) enable (or disable) monitor/record/apply
:param monitor: (C Q) enables/disables visible update for the device (default)
:param record: (C Q) enable/disable "recordDevice" device recording
:returns:
"""
pass
def PolygonCollapse(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def assignInputDevice(*args, clutch: AnyStr="", continuous: bool=True, device: AnyStr="",
immediate: bool=True, multiple: bool=True, q=True, query=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command associates a command string (i.e a mel script) with the input device When
the device moves or a button on the device is pressed, the command string is executed as if
you typed it into the window If the command string contains the names of buttons or axes
of the device, the current value of these buttons/axes are substituted in Butt
:param clutch: (C) specify a clutch button This button must be down for the command string
to be executed If no clutch is specified the command string is executed eve
:param continuous: (C) if this flag is set the command string is continously (once for
everytime the device changes state) By default if a clutch button is specified the c
:param device: (C) specify which device to assign the command string
:param immediate: (C) Immediately executes the command, without using the queue
:param multiple: (C) if this flag is set the other command strings associated with this
device are not deleted By default, when a new command string is attached to the d
:returns: Command result
"""
pass
def ShowSelectedObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def editMetadata(*args, memberName: AnyStr="", remove: bool=True, stringValue: Union[AnyStr,
List[AnyStr]]="", value: Union[float, List[float]]=0.0, channelName:
Union[AnyStr, bool]="", channelType: Union[AnyStr, bool]="", endIndex:
AnyStr="", index: Union[AnyStr, List[AnyStr], bool]="", indexType:
Union[AnyStr, bool]="", scene: bool=True, startIndex: AnyStr="", streamName:
Union[AnyStr, bool]="", **kwargs)->AnyStr:
"""
This command is used to set metadata elements onto or remove metadata elements from an
object Before using this command you must first attach a metadata stream type to the
object using the addMetadata command or an API equivalent The command has four basic
variations: Set per-component metadata on meshes Remove per-component metadata on meshes
S
:param memberName: (C) Name of the Structure member being edited The names of the members
are set up in the Structure definition, either through the description passed in
:param remove: (C) If the remove flag is set then the metadata will be removed rather than
have values set In this mode the "memberName", "value", and "stringValue" fl
:param stringValue: (C M) String value to be set into the specified metadata locations
This flag can only be used when the data member is a numeric type If the member has N
:param value: (C M) Numeric value to be set into the specified metadata locations This
flag can only be used when the data member is a numeric type If the member has N
:param channelName: (C Q) Filter the metadata selection to only recognize metadata
belonging to the specified named Channel (e.g "vertex") This flag is ignored if the
compon
:param channelType: (C Q) Obsolete - use the 'channelName' flag instead In query mode,
this flag can accept a value
:param endIndex: (C) The metadata is stored in a Stream, which is an indexed list If you
have mesh components selected then the metadata indices are implicit in the list
:param index: (C Q M) In the typical case metadata is indexed using a simple integer value
Certain types of data may use other index types e.g a "vertexFace" component
:param indexType: (C Q) Name of the index type the new Channel should be using If not
specified this defaults to a simple integer index Of the native types only a mesh "ve
:param scene: (C Q) Use this flag when you want to add metadata to the scene as a whole
rather than to any individual nodes If you use this flag and have nodes selected
:param startIndex: (C) The metadata is stored in a Stream, which is an indexed list If you
have mesh components selected then the metadata indices are implicit in the list
:param streamName: (C Q) Name of the metadata Stream Depending on context it could be the
name of a Stream to be created, or the name of the Stream to pass through the filte
:returns: Name of the node where the new edits reside, empty string if edits failed. It
will be an editMetadata node if construction history was present.
"""
pass
def EnableFluids(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SaveFluidStateAs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModifyConstraintAxisOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutlinerRevealSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyCollapseFacet(*args, areaThreshold: Union[float, bool]=0.1, caching: bool=True,
constructionHistory: bool=True, name: AnyStr="", nodeState: Union[int,
bool]=0, useAreaThreshold: bool=False, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Turns each selected facet into a point
:param areaThreshold: (C Q E) Area threshold to determine whether faces should be collapsed
Attribute is ignored unless useAreaThreshold is set to true Default: 0.1
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param useAreaThreshold: (C Q E) If true only collapse faces with area less than the area
threshold, otherwise collapse all faces regardless of area Default: false
:returns: The node name.
"""
pass
def xgmGuideGeom(*args, **kwargs)->None:
"""
"""
pass
def modelingToolkitSuperCtx(*args, **kwargs)->None:
"""
"""
pass
def ArtPaintBlendShapeWeightsTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectContainerContents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ClosestPointOnOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ikHandleDisplayScale(*args, q=True, query=True, e=True, edit=True, **kwargs)->Union[float,
Any]:
"""
This action modifies and queries the current display size of ikHandle The default display
scale is 1.0
:returns: Returns current display size of ikHandle.
"""
pass
def timeEditorClip(*args, absolute: bool=True, addAttribute: Union[AnyStr, List[AnyStr]]="",
allowShrinking: bool=True, animSource: Union[AnyStr, bool]="", audio:
AnyStr="", children: Union[int, bool]=0, clipAfter: bool=True, clipBefore:
bool=True, clipDataType: bool=True, clipId: Union[int, List[int]]=0,
clipIdFromNodeName: Union[int, bool]=0, clipIdFromPath: bool=True, clipNode:
bool=True, clipPath: bool=True, copyClip: bool=True, crossfadeMode:
Union[int, bool]=0, crossfadePlug: bool=True, curveTime: Union[time,
bool]=None, defaultGhostRoot: bool=True, drivenAttributes: bool=True,
drivenClipsBySource: Union[AnyStr, bool]="", drivenObjects: bool=True,
drivenRootObjects: bool=True, drivingSources: Union[AnyStr, bool]="",
duplicateClip: bool=True, duration: Union[time, bool]=None, emptySource:
bool=True, endTime: Union[time, bool]=None, existingOnly: bool=True, exists:
bool=True, explode: int=0, exportAllClips: bool=True, exportFbx: AnyStr="",
extend: bool=True, extendParent: bool=True, ghost: bool=True, ghostRootAdd:
Union[AnyStr, List[AnyStr]]="", ghostRootRemove: Union[AnyStr,
List[AnyStr]]="", group: bool=True, holdEnd: Union[time, bool]=None,
holdStart: Union[time, bool]=None, importTakeDestination: int=1,
isContainer: bool=True, listUserGhostRoot: bool=True, loopEnd: Union[time,
bool]=None, loopStart: Union[time, bool]=None, minClipDuration: bool=True,
modifyAnimSource: bool=True, moveClip: time=None, mute: bool=True, name:
Union[AnyStr, bool]="", parent: int=0, parentClipId: Union[int, bool]=0,
parentGroupId: bool=True, pasteClip: time=None, path: Union[AnyStr,
List[AnyStr]]="", preserveAnimationTiming: bool=True, razorClip: time=None,
remap: List[AnyStr, AnyStr]=None, remapSource: List[AnyStr, AnyStr]=None,
remappedSourceAttrs: bool=True, remappedTargetAttrs: bool=True,
removeAttribute: Union[AnyStr, List[AnyStr]]="", removeClip: bool=True,
removeCrossfade: bool=True, removeWeightCurve: bool=True, resetTiming:
bool=True, resetTransition: bool=True, ripple: bool=True, rootClipId: int=0,
rootPath: AnyStr="", scaleEnd: time=None, scalePivot: time=None, scaleStart:
time=None, setKeyframe: Union[AnyStr, List[AnyStr]]="", speedRamping:
Union[int, bool]=7, startTime: Union[time, bool]=None, timeWarp: bool=True,
timeWarpCurve: bool=True, timeWarpType: Union[int, bool]=0, track:
Union[AnyStr, bool]="", tracksNode: bool=True, transition: bool=True,
trimEnd: time=None, trimStart: time=None, truncated: bool=True,
uniqueAnimSource: bool=True, userGhostRoot: bool=True, weightCurve:
bool=True, zeroKeying: bool=True, addObjects: Union[AnyStr, bool]="",
addRelatedKG: bool=True, addSelectedObjects: bool=True, attribute:
Union[AnyStr, List[AnyStr]]="", exclusive: bool=True, importAllFbxTakes:
bool=True, importFbx: AnyStr="", importFbxTakes: AnyStr="", importMayaFile:
AnyStr="", importOption: AnyStr="", importPopulateOption: AnyStr="",
importedContainerNames: AnyStr="", includeRoot: bool=True,
populateImportedAnimSources: AnyStr="", poseClip: bool=True, recursively:
bool=True, removeSceneAnimation: bool=True, showAnimSourceRemapping:
bool=True, takeList: AnyStr="", takesToImport: AnyStr="", type: Union[AnyStr,
List[AnyStr], bool]="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command edits/queries Time Editor clips
:param absolute: (Q) This flag is used in conjunction with other timing flags like -s/start,
-d/duration, -ed/end, etc to query (global) absolute time
:param addAttribute: (E M) Add new attribute to the clip
:param allowShrinking: (E) When extending clip, allow shrinking
:param animSource: (C Q E) Populate based on animation source
:param audio: (C) Create a clip with audio inside
:param children: (Q) Get children clip IDs
:param clipAfter: (Q) Get the clip ID of the next clip
:param clipBefore: (Q) Get the clip ID of the previous clip
:param clipDataType: (Q) Query the type of data being driven by the given clip ID Return
values are: 0 : Animation - Clip drives animation curves 1 : Audio - Clip drives aud
:param clipId: (C E M) ID of the clip to be edited
:param clipIdFromNodeName: (Q) Get clip ID from clip node name
:param clipIdFromPath: (Q) Flag for querying the clip ID given the path Clip path is a
vertical-bar-delimited string to indicate a hierarchical structure of a clip Please ref
:param clipNode: (Q) Flag for querying the name of the clip node
:param clipPath: (Q) Flag for querying the path given the clip ID Clip path is a vertical
bar delimited string to indicate a hierarchical structure of a clip Please ref
:param copyClip: (E) Get the selected clip IDs and store them in a list that could be used
for pasting
:param crossfadeMode: (Q E) Set the crossfading mode between two clips that lie on the same
track, and that are specified with the -clipId flags: 0 : linear - Two clips are blen
:param crossfadePlug: (Q) Get plug path for a custom crossfade curve between 2 clips
:param curveTime: (Q) Query the curve local time in relation to the given clip
:param defaultGhostRoot: (Q E) Edit or query default ghost root variable Determine whether
to use the default ghost root (object driven by clip)
:param drivenAttributes: (Q) Return a list of attributes driven by a clip
:param drivenClipsBySource: (Q) Returns the clips driven by the given source Can filter
the return result by the specified type, like animCurve, expression, constraint, etc This
f
:param drivenObjects: (Q) Return an array of strings consisting of the names of all objects
driven by the current clip and its children clips
:param drivenRootObjects: (Q) Return an array of strings consisting of the names of all
root objects driven by this clip and its children clips
:param drivingSources: (Q) Return all sources driving the given clip Can filter the return
result by the specified type, like animCurve, expression, constraint, etc If used a
:param duplicateClip: (E) Duplicate clip into two clips with the same timing info
:param duration: (C Q) Relative duration of the new clip
:param emptySource: (C) Create a clip with an empty source
:param endTime: (Q) Query the relative end time of the clip
:param existingOnly: (E) This flag can only be used in edit mode, in conjunction with the
animSource flag Retain the animSource flag functionality but only bind attributes t
:param exists: (Q) Return true if the specified clip exists
:param explode: (E) Reparent all tracks and their clips within a group out to its parent
track node and remove the group
:param exportAllClips: (E) When used with the ef/exportFbx flag, export all clips
:param exportFbx: (E) Export currently selected clips to FBX files
:param extend: (E) Extend the clip to encompass all children
:param extendParent: (E) Extend parent to fit this clip
:param ghost: (Q E) Enable/disable ghosting for the specified clip
:param ghostRootAdd: (E M) Add path to specified node as a custom ghost root
:param ghostRootRemove: (E M) Remove path to specified node as a custom ghost root
:param group: (C) Specify if the new container should be created as a group, containing
other specified clips
:param holdEnd: (Q E) Hold clip's end to time
:param holdStart: (Q E) Hold clip's start to time
:param importTakeDestination: (C) Specify how to organize imported FBX takes: 0 - Import
takes into a group (default) 1 - Import takes into multiple compositions 2 - Import takes
as a
:param isContainer: (Q) Indicate if given clip ID is a container
:param listUserGhostRoot: (Q) Get user defined ghost root object for indicated clips
:param loopEnd: (Q E) Loop clip's end to time
:param loopStart: (Q E) Loop clip's start to time
:param minClipDuration: (Q) Returns the minimum allowed clip duration
:param modifyAnimSource: (C E) When populating, automatically modify Anim Source without
asking the user
:param moveClip: (E) Move clip by adding delta to its start time
:param mute: (Q E) Mute/Unmute the clip given a clip ID In query mode, return the muted
state of the clip Clips muted by soloing are not affected by this flag
:param name: (Q E) Name of the clip A clip will never have an empty name If an empty
string is provided, it will be replaced with "_"
:param parent: (E) Specify group/object parent ID
:param parentClipId: (C Q) Specify the parent clip ID of a clip to be created
:param parentGroupId: (Q) Return the parent group ID of the given clip
:param pasteClip: (E) Paste clip to the given time and track Destination track is required
to be specified through the track flag in the format "tracksNode:trackIndex" A
:param path: (E M) Full path of the clip to be edited For example:
composition1|track1|clip1 In query mode, this flag can accept a value
:param preserveAnimationTiming: (C) When used with the population command, it ensures the
animation is offset within a clip in such way that it matches its original scene timing,
regard
:param razorClip: (E) Razor clip into two clips at the specified time
:param remap: (E) Change animation source for a given clip item to a new one, specified by
the target path This removes all clips for the roster item and creates new
:param remapSource: (E) Set animation source to be remapped for a given clip item to new
one, specified by the target path
:param remappedSourceAttrs: (Q) Return an array of attribute indices and names of the
source attributes of a remapped clip
:param remappedTargetAttrs: (Q) Return an array of attribute indices and names of the
target attributes of a remapped clip
:param removeAttribute: (E M) Remove attribute from the clip
:param removeClip: (E) Remove clip of specified ID
:param removeCrossfade: (E) Remove custom crossfade between two clips specified by -clipId
flags
:param removeWeightCurve: (C Q E) Remove the weight curve connected to the clip
:param resetTiming: (E) Reset start and duration of a clip with the given clip ID to the
values stored in its Anim Source
:param resetTransition: (E) Reset transition intervals between specified clips
:param ripple: (E) Apply rippling to a clip operation
:param rootClipId: (E) ID of the root clip It is used together with various clip editing
flags When used, the effect of clip editing and its parameters will be affected b
:param rootPath: (E) Path of the root clip It is used together with various clip editing
flags When used, the effect of clip editing and its parameters will be affected
:param scaleEnd: (E) Scale the end time of the clip to the given time
:param scalePivot: (E) Scale the time of the clip based on the pivot This should be used
together with -scs/scaleStart or -sce/scaleEnd
:param scaleStart: (E) Scale the start time of the clip to the given time
:param setKeyframe: (E M) Set keyframe on a specific clip for a specified attribute
:param speedRamping: (Q E) To control the playback speed of the clip by animation curve: 1
: create - Attach a speed curve and a time warp curve to the clip to control the play
:param startTime: (C Q) Relative start time of the new clip
:param timeWarp: (Q) Return true if the clip is being warped by the speed curve If no
speed curve is attached to the clip, it will always return false
:param timeWarpCurve: (Q) Returns the name of the time warp curve connected to the clip
:param timeWarpType: (Q E) Time warp mode: 0: remapping - Connected time warp curve
performs frame by frame remapping 1: speed curve - Connected time warp curve acts as a
speed
:param track: (C Q E) The new clip container will be created on the track in the format
"trackNode:trackNumber", or on a track path, for example "composition1|track1" In
:param tracksNode: (Q) Get tracks node if specified clip is a group clip
:param transition: (E) Create transition intervals between specified clips
:param trimEnd: (E) Trim the end time of the clip to the given time
:param trimStart: (E) Trim the start time of the clip to the given time
:param truncated: (Q) This flag is used in conjunction with other timing flags like
-s/start, -d/duration, -ed/end, etc to query (global) truncated time
:param uniqueAnimSource: (E) If a given clip is sharing its Anim Source node with another
clip, make the Anim Source of this clip unique
:param userGhostRoot: (Q E) Edit or query custom ghost root variable Determine whether to
use user defined ghost root
:param weightCurve: (C Q E) In edit mode, create a weight curve and connect it to the clip
In query mode, return the name of the weight curve connected to the clip
:param zeroKeying: (E) A toggle flag to use in conjunction with k/setKeyframe, set the
value of the key frame(s) to be keyed to zero
:param addObjects: (C Q E) Populate the given object(s) and their attributes to anim source
to Time Editor For multiple object, pass each name separated by semicolon In query
:param addRelatedKG: (C Q E) During population, determine if associated keying groups
should be populated or not Normally used for populating HIK By default the value is
false
:param addSelectedObjects: (C Q E) Populate the currently selected objects and their
attributes to anim source or Time Editor In query mode, return the number of attributes
that will
:param attribute: (C E M) Populate a specific attribute on a object
:param exclusive: (C E) Populate all types of animation sources which are not listed by
"type" Flag
:param importAllFbxTakes: (C) Import all FBX takes into the new anim sources (for
timeEditorAnimSource command) or new containers (for timeEditorClip command)
:param importFbx: (C) Import an animation from FBX file into the new anim source (for
timeEditorAnimSource command) or new container (for timeEditorClip command)
:param importFbxTakes: (C) Import multiple FBX takes (separated by semicolons) into the new
anim sources (for timeEditorAnimSource command) or new containers (for timeEditorCli
:param importMayaFile: (C) Import an animation from Maya file into the new anim sources
(for timeEditorAnimSource command) or new containers (for timeEditorClip command)
:param importOption: (E) Option for importing animation source Specify either 'connect' or
'generate' connect: Only connect with nodes already existing in the scene Import
:param importPopulateOption: (E) Option for population when importing
:param importedContainerNames: (C) Internal use only To be used along with
populateImportedAnimSources to specify names for the created containers
:param includeRoot: (C E) Populate transform (Translate, Rotate, Scale) of hierarchy root
nodes
:param populateImportedAnimSources: (C) Internal use only Populate the Time Editor with
clips using the Animation Sources specified (use ; as a delimiter for multiple anim
sources)
:param poseClip: (C) Populate as pose clip with current attribute values
:param recursively: (C E) Populate selection recursively, adding all the children
:param removeSceneAnimation: (C E) If true, remove animation from scene when creating clips
or anim sources Only Time Editor will drive the removed scene animation
:param showAnimSourceRemapping: (C) Show a remapping dialog when the imported anim source
attributes do not match the scene attributes
:param takeList: (C) Internal use only To be used along with populateImportedAnimSources
to specify the imported take names
:param takesToImport: (C) Internal use only To be used along with
populateImportedAnimSources to specify the imported take indices
:param type: (C Q E M) Only populate the specified type of animation source
:returns: Return created clip's name.
"""
pass
def xgmWrapXGen(*args, **kwargs)->None:
"""
"""
pass
def polyConnectComponents(*args, adjustEdgeFlow: Union[float, bool]=0.0, caching: bool=True,
constructionHistory: bool=True, insertWithEdgeFlow: bool=True, name:
AnyStr="", nodeState: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Splits polygon edges according to the selected components The selected components are
gathered into connected 'paths' that define continuous splits Mixed components (vertices,
edges and faces) can be used at once The connection rules are: * Edges can connect to
other edges in the same face or to vertices in the same face (that are not in the edg
:param adjustEdgeFlow: (C Q E) The weight value of the edge vertices to be positioned
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param insertWithEdgeFlow: (C Q E) True to enable edge flow Otherwise, the edge flow is
disabled
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def MirrorCutPolygonGeometry(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PlanarProjectionOptions(*args, **kwargs)->None:
"""
unknown
"""
pass
def FreezeTransformationsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def saveViewportSettings(*args, **kwargs)->None:
"""
This command causes all the 3d views to save their settings as optionVar's This is called
automatically by the system when Maya exits
:returns:
"""
pass
def HypershadeShowCustomAttrs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorToggleNodeTitleMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePondOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xpmPicker(*args, fileName: AnyStr="", parent: AnyStr="", **kwargs)->AnyStr:
"""
Open a dialog and ask you to choose a xpm file
:param fileName: (C) default filename to display in dialog
:param parent: (C) parent window for modal dialog
:returns: The full name of the xpm file
"""
pass
def manipComponentPivot(*args, **kwargs)->None:
"""
"""
pass
def GraphCopyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ReverseCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def batchRender(*args, filename: AnyStr="", melCommand: AnyStr="", numProcs: int=0,
preRenderCommand: AnyStr="", remoteRenderMachine: AnyStr="",
renderCommandOptions: AnyStr="", showImage: bool=True, status: AnyStr="",
useRemoteRender: bool=True, useStandalone: bool=True, verbosity: int=0,
**kwargs)->None:
"""
The batchRender command is used to spawn off a separate rendering session of the current
maya file If no mayaFile is specified, it'll ask you whether you want the current job
killed The batchRender will spawn a separate maya process in which commands will be
communicated to it through a commandPort If Maya is unable to find an available port a
:param filename: (C) Filename to be rendered; if empty, a temporary filename will be
created
:param melCommand: (C) Mel command to execute to run a renderer other than the software
renderer
:param numProcs: (C) Number of processors to use (0 means use all available processors)
:param preRenderCommand: (C) Command to be run prior to invoking a batch render
:param remoteRenderMachine: (C) Name of remote render machine Not available on Windows
:param renderCommandOptions: (C) Arguments to the render command for batch rendering
:param showImage: (C) Show progress of the current rendering job
:param status: (C) Status string for displaying the batch render status
:param useRemoteRender: (C) If remote rendering is desired Not available on Windows
:param useStandalone: (C) Batch rendering is to be done by exporting the scene and
rendering with a standalone renderer
:param verbosity: (C) Defines the verbosity level to report the batch rendering status: 1:
display only one start message, then one message when all frames are rendered 2
:returns:
"""
pass
def CharacterMapper(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Art3dPaintTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ParentOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RotateToolMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def resetTool(*args, **kwargs)->None:
"""
This command resets a tool back to its "factory settings"
:returns:
"""
pass
def subdCleanTopology(*args, **kwargs)->bool:
"""
Command cleans topology of subdiv surfaces - at all levels It cleans the geometry of
vertices that satisfy the following conditions: - Zero edits - Default uvs (uvs obtained by
subdividing parent face) - No creases
:returns: Success or Failure.
"""
pass
def convertSolidTx(*args, alpha: bool=True, antiAlias: bool=True, backgroundColor: List[int,
int, int]=None, backgroundMode: AnyStr="", camera: name=None,
componentRange: bool=True, doubleSided: bool=True, fileFormat: AnyStr="",
fileImageName: AnyStr="", fillTextureSeams: bool=True, force: bool=True,
fullUvRange: bool=True, name: AnyStr="", pixelFormat: AnyStr="8",
resolutionX: int=0, resolutionY: int=0, reuseDepthMap: bool=False,
samplePlane: bool=True, samplePlaneRange: List[float, float, float,
float]=None, shadows: bool=True, uvBBoxIntersect: bool=True, uvRange:
List[float, float, float, float]=None, uvSetName: AnyStr="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
Command to convert a texture on a surface to a file texture The first argument is a
rendering node or attribute If only the node is specified, the outColor attribute will be
sampled If the node does not have an outColor attribute, the first attribute on the node
which is: readable, not writable, not hidden, connectable, and not a multi is used
:param alpha: (C) Specify whether to compute the transparency when baking lighting The
conversion will sample both the color and transparency of the shading network;
:param antiAlias: (C) Perform anti-aliasing on the resulting image Convert solid texture
will generally take four times longer than without anti-aliasing By default this
:param backgroundColor: (C) Set the background color to a specific value Default is to use
the shader default color to fill the background Valid values range from 0 to 255 if
:param backgroundMode: (C) Defines how the background of the texture should be filled
Three modes are available: "shader" or 1: uses the default shader color "color" or 2: us
:param camera: (C) Specify a camera to use in baking lighting If a camera is not specified
the camera in the active view will be used
:param componentRange: (C) If one or more components have been selected to use, then if
this flag is set, then the uv range of the components is used to fit into the texture ma
:param doubleSided: (C) Specify whether the sampler should flip the surface normal if the
sample point faces away from the camera Note: flipping the normal will make the re
:param fileFormat: (C) File format to be used for output IFF is the default if unspecified
Other valid formats are: als: Alias PIX cin: Cineon eps: EPS gif: GIF iff: Maya
:param fileImageName: (C) Specify the output path and name of file texture image If the
file name doesn't contain a directory separator, the image will be written to source i
:param fillTextureSeams: (C) Specify whether or not to overscan the polygon beyond its
outer edges, when creating the file texture, in order to fill the texture seams Default
is
:param force: (C) If the output image already exists overwrite it By default this flag is
off
:param fullUvRange: (C) Sample using the full uv range of the surface This flag cannot be
used with the -uvr flag A 2D texture placement node will be created and connected
:param name: (C) Set the name of the file texture node Name conflict resolution will be
used to determine valid names when multiple objects are specified
:param pixelFormat: (C) Specifies the pixel format of the image Note that not all file
formats support all pixel formats Available options: "8": 8 bits per channel, unsign
:param resolutionX: (C) Set the horizontal image resolution If this flag is not specified,
the resolution will be set to 256
:param resolutionY: (C) Set the vertical image resolution If this flag is not specified,
the resolution will be set to 256
:param reuseDepthMap: (C) Specify whether or not to reuse all the generated dmaps Default
is false
:param samplePlane: (C) Specify whether to sample using a virtual plane This virtual plane
has texture coordinates in the rectangle defined by the -samplePlaneRange flag I
:param samplePlaneRange: (C) Specify the uv range of the texture coordinates used to sample
if the -samplePlane option is set There are four arguments corresponding to uMin, uMa
:param shadows: (C) Specify whether to compute shadows when baking lighting Disk based
shadow maps will be used Only lights with depth map shadows enabled will contrib
:param uvBBoxIntersect: (C) This flag is obsolete
:param uvRange: (C) Specify the uv range in which samples will be computed There are four
arguments corresponding to uMin, uMax, vMin and vMax Each value should be spe
:param uvSetName: (C) Specify which uv set has to be used as the driving parametrization
for convert solid
:returns: File texture nodes
"""
pass
def nClothMakeCollideOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleFBIKEffectorsRotatePinState(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FlipUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PickWalkRightSelect(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AlignUVOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nameField(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Union[Script, bool]=None,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, drawInactiveFrame: bool=True, dropCallback: Script=None, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True, exists:
bool=True, fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True, manage:
bool=True, nameChangeCommand: Union[Script, bool]=None, noBackground: bool=True,
numberOfPopupMenus: bool=True, object: Union[AnyStr, bool]="", parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
receiveFocusCommand: Union[Script, bool]=None, statusBarMessage: AnyStr="",
useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates an editable field that can be linked to the name of a Maya object The
field will always show the name of the object
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C Q E) This command is executed when the field text is changed by
the user
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param drawInactiveFrame: (C Q E) Sets whether the name field draws itself with a frame
when it is inactive By default, this option is false
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param nameChangeCommand: (C Q E) This command is executed when the name of the node
changes NOTE: this will be executed when the node name changes, whether or not the
name-change or
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param object: (C Q E) Attaches the field to the named dage object, so that the field will
always display the object's name
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param receiveFocusCommand: (C Q E) Command executed when the field receives focus
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def UnmirrorSmoothProxyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolygonSoftenHardenOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CVHardnessOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def modelCurrentTimeCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", percent: Union[float, bool]=50, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a context which may be used to change current time within the model
views
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param percent: (Q E) Percent of the screen space that represents the full time slider
range (default is 50%)
:returns: Context name
"""
pass
def UnlockCurveLength(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Lightning(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PreInfinityCycle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeRenameActiveTab(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def playblast(*args, activeEditor: bool=True, cameraSetup: Union[List[AnyStr, AnyStr],
List[List[AnyStr, AnyStr]]]=None, clearCache: bool=True, codecOptions: bool=True,
combineSound: bool=True, completeFilename: AnyStr="", compression: AnyStr="",
editorPanelName: AnyStr="", endTime: time=None, filename: AnyStr="",
forceOverwrite: bool=True, format: AnyStr="", frame: Union[time, List[time]]=None,
framePadding: int=0, height: int=0, indexFromZero: bool=True, offScreen:
bool=True, offScreenViewportUpdate: bool=True, options: bool=True, percent:
int=50, quality: int=0, rawFrameNumbers: bool=True, replaceAudioOnly: bool=True,
replaceEndTime: time=None, replaceFilename: AnyStr="", replaceStartTime:
time=None, sequenceTime: bool=True, showOrnaments: bool=True, sound: AnyStr="",
startTime: time=None, throwOnError: bool=True, useTraxSounds: bool=True, viewer:
bool=True, width: int=0, widthHeight: List[int, int]=None, **kwargs)->AnyStr:
"""
This command playblasts the current playback range Sound is optional Note that the
playblast command registers a condition called "playblasting" so that users can monitor
whether playblasting is occurring You may monitor the condition using the API
(MConditionMessage) or a script (scriptJob and condition commands)
:param activeEditor: (C) This flag will return the current model editor that would be used
for playblast It does not invoke playblast itself
:param cameraSetup: (C M) Information about camera setup The first string defines a camera
setup MEL procedure The camera setup procedure will be invoked before executing a
:param clearCache: (C) When true, all previous temporary playblast files will be deleted
before the new playblast files are created and the remaining temporary playblast fi
:param codecOptions: (C) Brings up the OS specific dialog for setting playblast codec
options, and does not run the playblast
:param combineSound: (C) Combine the trax sounds into a single track This might force a
resampling of the sound if the sound paramters don't match up
:param completeFilename: (C) When set, this string specifies the exact name of the output
image In contrast with the -f/filename flag, -cf/completeFilename does not append any f
:param compression: (C) Specify the compression to use for the movie file To determine
which settings are available on your system, use the `playblast -options` command Th
:param editorPanelName: (C) This optional flag specifies the name of the model editor or
panel, which is to be used for playblast The current model editor or panel won't be use
:param endTime: (C) Specify the end time of the playblast Default is the end time of the
playback range displayed in the Time Slider Overridden by -frame
:param filename: (C) The filename to use for the output of this playblast If the file
already exists, a confirmation box will be displayed if playblast is performed inte
:param forceOverwrite: (C) Overwrite existing playblast files which may have the the same
name as the one specified with the "-f" flag
:param format: (C) Same as "image"
:param frame: (C M) List of frames to blast One frame specified per flag The frames can
be specified in any order but will be output in an ordered sequence When speci
:param framePadding: (C) Number of zeros used to pad file name Typically set to 4 to
support fcheck
:param height: (C) Height of the final image This value will be clamped if larger than the
width of the active window Windows: If not using fcheck, the width and heig
:param indexFromZero: (C) Output frames starting with file.0000.ext and incrementing by one
Typically frames use the Maya time as their frame number This option can only be
:param offScreen: (C) When set, this toggle allow playblast to use an offscreen buffer to
render the view This allows playblast to work when the application is iconified,
:param offScreenViewportUpdate: (C) When set, this toggle allows playblast to update the
viewport while rendering with the offscreen buffer
:param options: (C) Brings up a dialog for setting playblast options, and does not run the
playblast
:param percent: (C) Percentage of current view size to use during blasting Accepted values
are integers between 10 and 100 All other values are clamped to be within th
:param quality: (C) Specify the compression quality factor to use for the movie file Value
should be in the 0-100 range
:param rawFrameNumbers: (C) Playblast typically numbers its frames sequentially, starting
at zero This flag will override the default action and frames will be numbered using t
:param replaceAudioOnly: (C) When set, this string dictates that only the audio will be
replaced when the scene is re-playblasted
:param replaceEndTime: (C) Specify the end time of a replayblast of an existing playblast
Default is the start time of the playback range displayed in the Time Slider Overrid
:param replaceFilename: (C) When set, this string specifies the name of an input playblast
file which will have frames replaced according to the replace start and end times
:param replaceStartTime: (C) Specify the start time of a replayblast of an existing
playblast Default is the start time of the playback range displayed in the Time Slider
Overr
:param sequenceTime: (C) Use sequence time
:param showOrnaments: (C) Sets whether or not model view ornaments (e.g the axis icon)
should be displayed
:param sound: (C) Specify the sound node to be used during playblast
:param startTime: (C) Specify the start time of the playblast Default is the start time of
the playback range displayed in the Time Slider Overridden by -frame
:param throwOnError: (C) Playblast is tolerant of failures in most situations When set,
this toggle allows playblast to throw an error on these failures
:param useTraxSounds: (C) Use sounds from TRAX
:param viewer: (C) Specify whether a viewer should be launched for the playblast Default
is "true" Runs "fcheck" when -fmt is "image" The player for movie files depe
:param width: (C) Width of the final image This value will be clamped if larger than the
width of the active window Windows: If not using fcheck, the width and heigh
:param widthHeight: (C) Final image's width and height Values larger than the dimensions
of the active window are clamped A width and height of 0 means to use the window's
:returns: Name of moviefile created.
"""
pass
def NodeEditorPinSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hilite(*args, replace: bool=True, toggle: bool=True, unHilite: bool=True, **kwargs)->None:
"""
Hilites/Unhilites the specified object(s) Hiliting an object makes it possible to select
the components of the object If no objects are specified then the selection list is used
:param replace: (C) Hilite the specified objects Any objects previously hilited will no
longer be hilited
:param toggle: (C) Toggle the hilite state of the specified objects
:param unHilite: (C) Remove the specified objects from the hilite list
:returns:
"""
pass
def AddSelectionAsTargetShapeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmLengthBrushContext(*args, **kwargs)->None:
"""
"""
pass
def containerView(*args, itemInfo: Union[AnyStr, bool]="", itemList: bool=True,
viewDescription: bool=True, viewLabel: bool=True, viewList: bool=True,
viewName: Union[AnyStr, bool]="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
A container view defines the layout information for the published attributes of a
particular container Container views can be selected from a set of built-in views or may
be defined on an associated container template This command queries the view-related
information for a container node The information returned from this command will be based
o
:param itemInfo: (Q) Used in query mode in conjunction with the itemList flag The command
will return a list of information for each item in the view, the information fi
:param itemList: (Q) Used in query mode, the command will return a list of information for
each item in the view The viewName flag is used to select the view to query T
:param viewDescription: (Q) Used in query mode, returns the description field associated
with the selected view If no description was defined for this view, the value will be e
:param viewLabel: (Q) Used in query mode, returns the display label associated with the
view An appropriate label suitable for the user interface will be returned based o
:param viewList: (Q) Used in query mode, command will return a list of all views defined
for the given target (container or template)
:param viewName: (Q) Used in query mode, specifies the name of the queried view when used
in conjunction with a template target When used in conjunction with a container
:returns:
"""
pass
def listInputDeviceAxes(*args, **kwargs)->List[AnyStr]:
"""
This command lists all of the axes of the specified input device
:returns: Command result
"""
pass
def SculptReferenceVectorMarkingMenuRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cMuscleWeightSave(*args, **kwargs)->None:
"""
"""
pass
def SelectAllLattices(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TexSculptActivateBrushStrength(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Newton(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetCutBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeRenderPerspLayout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMarkers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RetimeKeysToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def radial(*args, attenuation: Union[float, bool]=0.0, magnitude: Union[float, bool]=0.0,
maxDistance: Union[float, bool]=0.0, name: Union[AnyStr, bool]="", perVertex:
bool=True, position: Union[List[float, float, float], List[List[float, float,
float]], bool]=None, torusSectionRadius: Union[float, bool]=0.0, type: Union[float,
bool]=0.0, volumeExclusion: bool=True, volumeOffset: Union[List[float, float, float],
bool]=None, volumeShape: Union[AnyStr, bool]="", volumeSweep: Union[float, bool]=0.0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
For each listed object, the command creates a new field The field has a shape which lives
in the DAG and it has an associated dependency node The field is added to the list of
fields owned by the object Use connectDynamic to cause the field to affect a dynamic
object Note that if more than one object is listed, a separate field is created for e
:param attenuation: (Q E) Attentuation rate of field
:param magnitude: (Q E) Strength of field
:param maxDistance: (Q E) Maximum distance at which field is exerted -1 indicates that the
field has no maximum distance
:param name: (Q E) name of field
:param perVertex: (Q E) Per-vertex application If this flag is set true, then each
individual point (CV, particle, vertex,etc.) of the chosen object exerts an identical cop
:param position: (Q E M) Position in space (x,y,z) where you want to place a gravity field
The gravity then emanates from this position in space rather than from an object
:param torusSectionRadius: (Q E) Section radius for a torus volume Applies only to torus
Similar to the section radius in the torus modelling primitive
:param type: (Q E) Type of radial field (0 - 1) This controls the algorithm by which the
field is attenuated Type 1, provided for backward compatibility, specifies th
:param volumeExclusion: (Q E) Volume exclusion of the field If true, points outside the
volume (defined by the volume shape attribute) are affected, If false, points inside the v
:param volumeOffset: (Q E) Volume offset of the field Volume offset translates the field's
volume by the specified amount from the actual field location This is in the field'
:param volumeShape: (Q E) Volume shape of the field Sets/edits/queries the field's volume
shape attribute If set to any value other than "none", determines a 3-D volume with
:param volumeSweep: (Q E) Volume sweep of the field Applies only to sphere, cone, cylinder,
and torus Similar effect to the sweep attribute in modelling
:returns: Command result
"""
pass
def dR_selConstraintElement(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def U3DBrushPressureOff(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def roundConstantRadius(*args, append: bool=False, constructionHistory: bool=True, name:
AnyStr="", object: bool=True, radiuss: Union[float, List[float]]=0.0,
side: Union[List[AnyStr, int], List[List[AnyStr, int]]]=None, sidea:
Union[int, List[int]]=0, sideb: Union[int, List[int]]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command generates constant radius NURBS fillets and NURBS corner surfaces for matching
edge pairs on NURBS surfaces An edge pair is a matching pair of surface isoparms or trim
edges This command can handle more than one edge pair at a time This command can also
handle compound edges, which is where an edge pair is composed of more than two
:param append: (C) If true, then an edge pair is being added to an existing round
dependency node Default is false When this flag is true, an existing round dependenc
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param radiuss: (C M) Use this flag to specify radius This overrides the "r/radius" flag
If only one "rad" flag is used, then it is applied to all edge pairs If more th
:param side: (C M) Use this flag for compound edges It replaces the sidea/sideb flags and
is compatible with Python The first argument must be either "a" or "b" The
:param sidea: (C M) Use this flag for compound edges in conjunction with the following
"-sb" flag This flag is not intended for use from Python Please see "side" flag
:param sideb: (C M) Use this flag for compound edges in conjunction with the "-sa" flag
See description for the "-sa" flag This flag is not intended for use from Pytho
:returns: (resulting NURBS surfaces' names and node name)
"""
pass
def RenderViewNextImage(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorSetKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def IncreaseExposureCoarse(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def openMayaPref(*args, errlog: bool=True, lazyLoad: bool=True, oldPluginWarning: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[int, Any]:
"""
Set or query API preferences
:param errlog: (C Q E) toggles whether or not an error log of failed API method calls will
be created When set to true, a file called "OpenMayaErrorLog" will be created in
:param lazyLoad: (C Q E) toggles whether or not plugins will be loaded with the RTLD_NOW
flag or the RTLD_LAZY flag of dlopen(3C) If set to true, RTLD_LAZY will be used In
:param oldPluginWarning: (C Q E) toggles whether or not loadPlugin will generate a warning
when plug-ins are loaded that were compiled against an older, and possibly incompatible
May
:returns: indicates success or failure
"""
pass
def renderInfo(*args, castShadows: bool=True, chordHeight: float=0.0, chordHeightRatio:
float=0.0, doubleSided: bool=True, edgeSwap: bool=True, minScreen: float=0.0,
name: AnyStr="", opposite: bool=True, smoothShading: bool=True, unum: int=0,
useChordHeight: bool=True, useChordHeightRatio: bool=True, useDefaultLights:
bool=True, useMinScreen: bool=True, utype: int=0, vnum: int=0, vtype: int=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
The renderInfo commands sets geometric properties of surfaces of the selected object
:param castShadows: (C) Determines if object casts shadow or not
:param chordHeight: (C) Tessellation subdivision criteria
:param chordHeightRatio: (C) Tessellation subdivision criteria
:param doubleSided: (C) Determines if object double or single sided
:param edgeSwap: (C) Tessellation subdivision criteria
:param minScreen: (C) Tessellation subdivision criteria
:param name: (C) Namespace to use
:param opposite: (C) Determines if the normals of the object is to be reversed
:param smoothShading: (C) Determines if smooth shaded, or flat shaded - applies only to
polysets
:param unum: (C) Tessellation subdivision criteria
:param useChordHeight: (C) Tessellation subdivision criteria
:param useChordHeightRatio: (C) Tessellation subdivision criteria
:param useDefaultLights: (C) Obsolete flag
:param useMinScreen: (C) Tessellation subdivision criteria
:param utype: (C) Tessellation subdivision criteria
:param vnum: (C) Tessellation subdivision criteria
:param vtype: (C) Tessellation subdivision criteria
:returns:
"""
pass
def DeleteAllIKHandles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CutPolygon(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetDensityBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def reorderContainer(*args, back: bool=True, front: bool=True, relative: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This command reorders (moves) objects relative to their siblings in a container For
relative moves, both positive and negative numbers may be specified Positive numbers move
the object forward and negative numbers move the object backward amoung its siblings When
an object is at the end (beginning) of the list of siblings, a relative move of 1
:param back: (C Q E) Move object(s) to back of container contents list
:param front: (C Q E) Move object(s) to front of container contents list
:param relative: (C Q E) Move object(s) relative to other container contents
:returns:
"""
pass
def TranslateToolMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_connectRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutTangentPlateau(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportAnimationOnly(*args, **kwargs)->None:
"""
"""
pass
def NamespaceEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MirrorSubdivSurfaceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def checkBoxGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0, adjustableColumn3:
int=0, adjustableColumn4: int=0, adjustableColumn5: int=0, adjustableColumn6:
int=0, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, changeCommand1:
Script=None, changeCommand2: Script=None, changeCommand3: Script=None,
changeCommand4: Script=None, columnAlign: Union[List[int, AnyStr],
List[List[int, AnyStr]]]=None, columnAlign2: List[AnyStr, AnyStr]=None,
columnAlign3: List[AnyStr, AnyStr, AnyStr]=None, columnAlign4: List[AnyStr,
AnyStr, AnyStr, AnyStr]=None, columnAlign5: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAlign6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach: Union[List[int, AnyStr, int], List[List[int, AnyStr,
int]]]=None, columnAttach2: List[AnyStr, AnyStr]=None, columnAttach3:
List[AnyStr, AnyStr, AnyStr]=None, columnAttach4: List[AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach5: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnOffset2: List[int, int]=None, columnOffset3: List[int, int, int]=None,
columnOffset4: List[int, int, int, int]=None, columnOffset5: List[int, int, int,
int, int]=None, columnOffset6: List[int, int, int, int, int, int]=None,
columnWidth: Union[List[int, int], List[List[int, int]]]=None, columnWidth1:
int=0, columnWidth2: List[int, int]=None, columnWidth3: List[int, int,
int]=None, columnWidth4: List[int, int, int, int]=None, columnWidth5: List[int,
int, int, int, int]=None, columnWidth6: List[int, int, int, int, int, int]=None,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dropCallback: Script=None, editable: bool=True, enable: bool=True,
enable1: bool=True, enable2: bool=True, enable3: bool=True, enable4: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True, label:
Union[AnyStr, bool]="", label1: Union[AnyStr, bool]="", label2: Union[AnyStr,
bool]="", label3: Union[AnyStr, bool]="", label4: Union[AnyStr, bool]="",
labelArray2: Union[List[AnyStr, AnyStr], bool]=None, labelArray3:
Union[List[AnyStr, AnyStr, AnyStr], bool]=None, labelArray4: Union[List[AnyStr,
AnyStr, AnyStr, AnyStr], bool]=None, manage: bool=True, noBackground: bool=True,
numberOfCheckBoxes: int=0, numberOfPopupMenus: bool=True, offCommand:
Script=None, offCommand1: Script=None, offCommand2: Script=None, offCommand3:
Script=None, offCommand4: Script=None, onCommand: Script=None, onCommand1:
Script=None, onCommand2: Script=None, onCommand3: Script=None, onCommand4:
Script=None, parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, rowAttach: Union[List[int, AnyStr, int],
List[List[int, AnyStr, int]]]=None, statusBarMessage: AnyStr="", useTemplate:
AnyStr="", value1: bool=True, value2: bool=True, value3: bool=True, value4:
bool=True, valueArray2: List[bool, bool]=None, valueArray3: List[bool, bool,
bool]=None, valueArray4: List[bool, bool, bool, bool]=None, vertical: bool=True,
visible: bool=True, visibleChangeCommand: Union[Script, bool]=None, width:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the group changes state Note that this
flag should not be used in conjunction with onCommand and offCommand That is, one shou
:param changeCommand1: (C E)
:param changeCommand2: (C E)
:param changeCommand3: (C E)
:param changeCommand4: (C E) Specify a changed state command for each respective check box
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editable: (C Q E) The edit state of the group By default, this flag is set to true
and the check box values may be changed by clicking on them If false then the chec
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enable1: (C Q E)
:param enable2: (C Q E)
:param enable3: (C Q E)
:param enable4: (C Q E) Enable state of the individual check boxes
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) When present on creation an optional text label will be built with
the group The string specifes the label text
:param label1: (C Q E)
:param label2: (C Q E)
:param label3: (C Q E)
:param label4: (C Q E) Specify label strings for the respective check boxes in the group
:param labelArray2: (C Q E)
:param labelArray3: (C Q E)
:param labelArray4: (C Q E) Specify multiple labels in a single flag These flags are
ignored if the number of radio buttons doesn't match
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfCheckBoxes: (C) Number of check boxes in the group (1 - 4)
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param offCommand: (C E) Command executed when any check box turns off
:param offCommand1: (C E)
:param offCommand2: (C E)
:param offCommand3: (C E)
:param offCommand4: (C E) Off command for each respective check box
:param onCommand: (C E) Command executed when any check box turns on
:param onCommand1: (C E)
:param onCommand2: (C E)
:param onCommand3: (C E)
:param onCommand4: (C E) On command for each respective check box
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value1: (C Q E)
:param value2: (C Q E)
:param value3: (C Q E)
:param value4: (C Q E) Values for the respective check boxes in the group
:param valueArray2: (C Q E)
:param valueArray3: (C Q E)
:param valueArray4: (C Q E) Specifies multiple values in a single flag These flags are
ignored if the number of check boxes doesn't match
:param vertical: (C Q) Whether the orientation of the checkbox controls in this group are
horizontal (default) or vertical
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def event(*args, count: Union[int, bool]=0, delete: bool=True, dieAtCollision: bool=True, emit:
Union[int, bool]=0, list: bool=True, name: Union[AnyStr, bool]="", proc: Union[Script,
bool]=None, random: bool=True, rename: Union[AnyStr, bool]="", select: bool=True,
split: Union[int, bool]=0, spread: Union[float, bool]=0.0, target: Union[AnyStr,
bool]="", q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The event command assigns collision events to a particle object Collision events are
stored in multi-attributes in the particle shape The event command returns the event name
:param count: (Q E) Collision number (for each particle) to which this event applies Zero
(the default) indicates that it applies to all collisions
:param delete: (C) Delete the specified event
:param dieAtCollision: (Q E) Particle dies at the collision specified by "count." If no
count value is given, die at first collision
:param emit: (Q E) Emit n additional particles into the assigned target object The
original (colliding) particle survives as well, and remains in its original object
:param list: (C) List all events for the chosen shape, like this: event1Name event2Name ..
If no shape identified, list all events for all shapes, like this: shape1N
:param name: (C Q E) Assign a name to an event you are creating, or identify an event you
wish to edit, query, or delete See examples
:param proc: (C Q E) Specify a MEL proc to be called each time the event occurs This must
be a global proc with arguments as follows: global proc procName( string obj, i
:param random: (Q E) Used with -split and -emit flags If -random is set true and -split or
-emit is set to n, then a random number of particles uniformly distributed bet
:param rename: (Q) Assign a new name to an event you are editing See examples
:param select: () This flag is obsolete See the -name flag
:param split: (Q E) Colliding particle splits into specified number of new particles These
new particles become part of the assigned target object If no target has bee
:param spread: (Q E) Particles created at collision will spread out a random amount from
the rebound direction of the colliding particle The spread is specified as a fra
:param target: (Q E) Target object for emitting or split particles New particles created
through the -emit or -split flags join this object
:returns: for creation; string array for list.
"""
pass
def UnpublishAttributes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OpenCloseSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def simplify(*args, animation: AnyStr="keysOrObjects.", attribute: Union[AnyStr,
List[AnyStr]]="", controlPoints: bool=False, float: Union[floatrange,
List[floatrange]]=None, floatTolerance: float=0.0, hierarchy: AnyStr="",
includeUpperBound: bool=True, index: Union[int, List[int]]=0, shape: bool=True,
time: Union[timerange, List[timerange]]=None, timeTolerance: time=None,
valueTolerance: float=0.0, **kwargs)->int:
"""
This command operates on a keyset A keyset is defined as a group of keys within a
specified time range on one or more animation curves The animation curves comprising a
keyset depend on the value of the "-animation" flag: keysOrObjects: Any active keys, when
no target objects or -attribute flags appear on the command line, or All animation curv
:param animation: (C) Where this command should get the animation to act on Valid values
are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Descrip
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param float: (C M) value uniquely representing a non-time-based key (or key range) on a
time-based animCurve Valid floatRange include single values (-f 10) or a string
:param floatTolerance: (C) Specify the x-axis tolerance (defaults to 0.05) for float-input
animCurves such as those created by "Set Driven Keyframe" This flag is ignored on an
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param includeUpperBound: (C) When the -t/time or -f/float flags represent a range of keys,
this flag determines whether the keys at the upper bound of the range are included in t
:param index: (C M) index of a key on an animCurve In query mode, this flag needs a value
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:param time: (C M) time uniquely representing a key (or key range) on a time-based
animCurve See the code examples below on how to format for a single frame or frame r
:param timeTolerance: (C) Specify the x-axis tolerance (defaults to 0.05 seconds) for
time-input animCurves This flag is ignored on animCurves driven by floats Higher time t
:param valueTolerance: (C) Specify the value tolerance (defaults to 0.01)
:returns: Number of animation curves simplified
"""
pass
def renderWindowEditor(*args, autoResize: bool=True, blendMode: Union[int, bool]=0, caption:
Union[AnyStr, bool]="", changeCommand: Union[List[AnyStr, AnyStr, AnyStr,
AnyStr], bool]=None, clear: Union[List[int, int, float, float, float],
bool]=None, cmEnabled: bool=True, colorManage: bool=True, compDisplay:
Union[int, bool]=0, compImageFile: Union[AnyStr, bool]="", control:
bool=True, currentCamera: Union[AnyStr, bool]="", currentCameraRig:
Union[AnyStr, bool]="", defineTemplate: AnyStr="", displayImage:
Union[int, bool]=0, displayImageViewCount: Union[int, bool]=0,
displayStyle: Union[AnyStr, bool]="", docTag: Union[AnyStr, bool]="",
doubleBuffer: bool=True, drawAxis: bool=True, editorName: bool=True,
exists: bool=True, exposure: Union[float, bool]=0.0, filter:
Union[AnyStr, bool]="", forceMainConnection: Union[AnyStr, bool]="",
frameImage: bool=True, frameRegion: bool=True, gamma: Union[float,
bool]=0.0, highlightConnection: Union[AnyStr, bool]="", loadImage:
AnyStr="", lockMainConnection: bool=True, mainListConnection:
Union[AnyStr, bool]="", marquee: Union[List[float, float, float, float],
bool]=None, nbImages: bool=True, nextViewImage: bool=True,
outputColorManage: bool=True, panel: Union[AnyStr, bool]="", parent:
Union[AnyStr, bool]="", pcaption: Union[AnyStr, bool]="", realSize:
bool=True, refresh: bool=True, removeAllImages: bool=True, removeImage:
bool=True, resetRegion: bool=True, resetViewImage: bool=True, saveImage:
bool=True, scaleBlue: Union[float, bool]=0.0, scaleGreen: Union[float,
bool]=0.0, scaleRed: Union[float, bool]=0.0, selectionConnection:
Union[AnyStr, bool]="", showRegion: Union[List[int, int], bool]=None,
singleBuffer: bool=True, snapshot: Union[List[AnyStr, int, int],
bool]=None, snapshotMode: bool=True, stateString: bool=True, stereo:
Union[int, bool]=0, stereoImageOrientation: Union[List[AnyStr, AnyStr],
bool]=None, stereoMode: Union[AnyStr, bool]="", toggle: bool=True,
unParent: bool=True, unlockMainConnection: bool=True,
updateMainConnection: bool=True, useTemplate: AnyStr="", viewImageCount:
Union[int, bool]=0, viewTransformName: Union[AnyStr, bool]="",
writeImage: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Create a editor window that can receive the result of the rendering process
:param autoResize: (C Q E) Lets the render view editor automatically resize the viewport or
not
:param blendMode: (C Q E) Sets the blend mode for the render view New image sent to the
render view will be blended with the previous image in the render view, and the compos
:param caption: (C Q E) Sets the caption which appears at the bottom of the render view
:param changeCommand: (C Q E) Parameters: First string: command Second string: editorName
Third string: editorCmd Fourth string: updateFunc Call the command when something changes
:param clear: (C Q E) Clear the image with the given color at the given resolution
Argumnets are respecively: width height red green blue
:param cmEnabled: (Q E) Turn on or off applying color management in the View If set, the
color management configuration set in the current view is used
:param colorManage: (E) When used with the writeImage flag, causes the written image to be
color-managed using the settings from the view color manager attached to the view
:param compDisplay: (C Q E) 0 : disable compositing 1 : displays the composited image
immediately For example, when foreground layer tile is sent to the render view window, th
:param compImageFile: (C Q E) Open the given image file and blend with the buffer as if the
image was just rendered
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param currentCamera: (C Q E) Get or set the current camera (used when redoing last
render)
:param currentCameraRig: (C Q E) Get or set the current camera rig name If a camera rig is
specified, it will be used when redoing the last render as opposed to the currentCamera va
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param displayImage: (Q E) Set a particular image in the Editor Image Stack as the current
Editor Image Images are added to the Editor Image Stack using the "si/saveImage" fla
:param displayImageViewCount: (Q) Query the number of views stored for a given image in the
Editor Image Stack This is not the same as querying using "viewImageCount" which returns
t
:param displayStyle: (C Q E) Set the mode to display the image Valid values are: "color"
to display the basic RGB image "mask" to display the mask channel "lum" to display the l
:param docTag: (C Q E) Attaches a tag to the editor
:param doubleBuffer: (C Q E) Set the display in double buffer mode
:param drawAxis: (C Q E) Set or query whether the axis will be drawn
:param editorName: (Q) Returns the name of the editor, or an empty string if the editor has
not been created yet
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param exposure: (Q E) The exposure value used by the color management of the current view
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param frameImage: (C Q E) Frames the image inside the window
:param frameRegion: (C Q E) Frames the region inside the window
:param gamma: (Q E) The gamma value used by the color management of the current view
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param loadImage: (E) load an image from disk and set it as the current Editor Image
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param marquee: (C Q E) The arguments define the four corners of a rectangle: top left
bottom right The rectangle defines a marquee for the render computation
:param nbImages: (Q) returns the number of images
:param nextViewImage: (C E) The render editor has the capability to render multiple cameras
within a single view This is different from image binning where an image is saved M
:param outputColorManage: (E) When used with the writeImage flag, causes the written image
to be color-managed using the outpute color space in the color preferences attached to t
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param pcaption: (C Q E) Get or set the permanent caption which appears under the image
that is currently showing in the render editor
:param realSize: (C Q E) Display the image with a one to one pixel match
:param refresh: (E) requests a refresh of the current Editor Image
:param removeAllImages: (E) remove all the Editor Images from the Editor Image Stack
:param removeImage: (E) remove the current Editor Image from the Editor Image Stack
:param resetRegion: (C Q E) Forces a reset of any marquee/region
:param resetViewImage: (C E) The render editor has the capability to render multiple
cameras within a single view This is different from image binning where an image is saved
M
:param saveImage: (E) save the current Editor Image to memory Saved Editor Images are
stored in an Editor Image Stack The most recently saved image is stored in position
:param scaleBlue: (C Q E) Define the scaling factor for the blue component in the View The
default value is 1 and can be between -1000 to +1000
:param scaleGreen: (C Q E) Define the scaling factor for the green component in the View
The default value is 1 and can be between -1000 to +1000
:param scaleRed: (C Q E) Define the scaling factor for the red component in the View The
default value is 1 and can be between -1000 to +1000
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param showRegion: (C Q E) Shows the current region at the given resolution The two
parameters define the width and height
:param singleBuffer: (C Q E) Set the display in single buffer mode
:param snapshot: (C Q E) Makes a copy of the camera of the model editor at the given size
First argument is the editor name, second is the width, third is the height
:param snapshotMode: (C Q E) Get or set the window's snapshot mode
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param stereo: (C Q E) Puts the editor into stereo image mode The effective resolution of
the output image is twice the size of the horizontal size The orientation of the
:param stereoImageOrientation: (C Q E) Specifies the orientation of stereo camera renders
The first argument specifies the orientation value for the firstleft image and the second
argumen
:param stereoMode: (C Q E) Specifies how the image is displayed in the view By default the
stereo is rendered with a side by side image The rendered image is a single image t
:param toggle: (C Q E) Turns the ground plane display on/off
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param viewImageCount: (C Q E) The render editor has the capability to render multiple
cameras within a single view This is different from image binning where an image is saved
M
:param viewTransformName: (Q E) Sets/gets the view transform to be applied if color
management is enabled in the current view
:param writeImage: (E) write the current Editor Image to disk
:returns: The name of the editor
"""
pass
def SubdivSurfaceCleanTopology(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_symmetrize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def copyDeformerWeights(*args, destinationDeformer: Union[AnyStr, bool]="", destinationShape:
Union[AnyStr, bool]="", mirrorInverse: bool=True, mirrorMode:
Union[AnyStr, bool]="", noMirror: bool=True, smooth: bool=True,
sourceDeformer: Union[AnyStr, bool]="", sourceShape: Union[AnyStr,
bool]="", surfaceAssociation: Union[AnyStr, bool]="", uvSpace:
Union[List[AnyStr, AnyStr], bool]=None, q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
Command to copy or mirror the deformer weights accross one of the three major axes The
command can be used to mirror weights either from one surface to another or within the same
surface
:param destinationDeformer: (C Q E) Specify the deformer used by the destination shape
:param destinationShape: (C Q E) Specify the destination deformed shape
:param mirrorInverse: (C Q E) Values are mirrored from the positive side to the negative
If this flag is used then the direction is inverted
:param mirrorMode: (C Q E) The mirrorMode flag defines the plane of mirroring (XY, YZ, or
XZ) when the mirror flag is used The default plane is XY
:param noMirror: (C Q E) When the no mirror flag is used, the weights are copied instead of
mirrored
:param smooth: (C Q E) When the smooth flag is used, the weights are smoothly interpolated
between the closest vertices, instead of assigned from the single closest
:param sourceDeformer: (C Q E) Specify the deformer whose weights should be mirrored When
queried, returns the deformers used by the source shapes
:param sourceShape: (C Q E) Specify the source deformed shape
:param surfaceAssociation: (C Q E) The surfaceAssociation flag controls how the weights are
transferred between the surfaces: "closestPoint", "rayCast", or "closestComponent" The
defa
:param uvSpace: (C Q E) The uvSpace flag indicates that the weight transfer should occur in
UV space, based on the source and destination UV sets specified
:returns:
"""
pass
def rebuildSurface(*args, caching: bool=True, degreeU: Union[int, bool]=3, degreeV: Union[int,
bool]=3, direction: Union[int, bool]=2, endKnots: Union[int, bool]=0,
fitRebuild: Union[int, bool]=0, keepControlPoints: bool=False, keepCorners:
bool=True, keepRange: Union[int, bool]=1, nodeState: Union[int, bool]=0,
rebuildType: Union[int, bool]=0, spansU: Union[int, bool]=4, spansV:
Union[int, bool]=4, tolerance: Union[float, bool]=0.01, constructionHistory:
bool=True, name: AnyStr="", object: bool=True, polygon: int=0,
replaceOriginal: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
This command rebuilds a surface by modifying its parameterization In some cases the shape
of the surface may also change The rebuildType (-rt) attribute determines how the surface
is rebuilt The optional second surface can be used to specify a reference
parameterization
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param degreeU: (C Q E) The degree of the resulting surface in the u direction 0 - maintain
current, 1 - linear, 2 - quadratic, 3 - cubic, 5 - quintic, 7 - heptic Default: 3
:param degreeV: (C Q E) The degree of the resulting surface in the v direction 0 - maintain
current, 1 - linear, 2 - quadratic, 3 - cubic, 5 - quintic, 7 - heptic Default: 3
:param direction: (C Q E) The direction in which to rebuild: 0 - U, 1 - V, 2 - Both U and V
Default: 2
:param endKnots: (C Q E) End conditions for the surface 0 - uniform end knots, 1 - multiple
end knots, Default: 0
:param fitRebuild: (C Q E) Specify the type of rebuild method to be used: 0 - Convert
Classic, the default and original convert method 1 - Fit using the least squares fit meth
:param keepControlPoints: (C Q E) Use the control points of the input surface This forces
uniform parameterization unless rebuildType is 2 (match knots) Default: false
:param keepCorners: (C Q E) The corners of the resulting surface will not change from the
corners of the input surface Default: true
:param keepRange: (C Q E) Determine the parameterization for the resulting surface 0 -
reparameterize the resulting surface from 0 to 1; 1 - keep the original surface paramet
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param rebuildType: (C Q E) The rebuild type: 0 - uniform, 1 - reduce spans, 2 - match
knots, 3 - remove multiple knots, 4 - force non rational 5 - rebuild ends 6 - trim convert
:param spansU: (C Q E) The number of spans in the u direction in resulting surface Used
only when rebuildType is 0 - uniform If 0, keep the same number of spans as the or
:param spansV: (C Q E) The number of spans in the v direction in resulting surface Used
only when rebuildType is 0 - uniform If 0, keep the same number of spans as the or
:param tolerance: (C Q E) The tolerance with which to rebuild Default: 0.01
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def FloodSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutTangentFixed(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeSelectObjectsWithMaterials(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def characterizationToolUICmd(*args, **kwargs)->None:
"""
"""
pass
def listSets(*args, allSets: bool=True, extendToShape: bool=True, object: name=None, type:
int=0, **kwargs)->List[AnyStr]:
"""
The listSets command is used to get a list of all the sets an object belongs to To get
sets of a specific type for an object use the type flag as well To get a list of all sets
in the scene then don't use an object in the command line but use one of the flags instead
:param allSets: (C) Returns all sets in the scene
:param extendToShape: (C) When requesting a transform's sets also walk down to the shape
immediately below it for its sets
:param object: (C) Returns all sets which this object is a member of
:param type: (C) Returns all sets in the scene of the given type: 1 - all rendering sets 2
- all deformer sets
:returns: (string array of all sets the object belongs to)
"""
pass
def polyColorPerVertex(*args, alpha: Union[float, bool]=0.0, clamped: bool=True, colorB:
Union[float, bool]=0.0, colorDisplayOption: bool=True, colorG:
Union[float, bool]=0.0, colorR: Union[float, bool]=0.0, colorRGB:
Union[List[float, float, float], bool]=None, notUndoable: bool=True,
relative: bool=True, remove: bool=True, representation: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[bool,
Any]:
"""
Command associates color(rgb and alpha) with vertices on polygonal objects When used with
the query flag, it returns the color associated with the specified components
:param alpha: (C Q E) Specifies the alpha channel of color
:param clamped: (C Q E) This flag specifies if the color set will truncate any value that
is outside 0 to 1 range
:param colorB: (C Q E) Specifies the B channel of color
:param colorDisplayOption: (C Q E) Change the display options on the mesh to display the
vertex colors
:param colorG: (C Q E) Specifies the G channel of color
:param colorR: (C Q E) Specifies the R channel of color
:param colorRGB: (C Q E) Specifies the RGB channels of color
:param notUndoable: (C Q E) Execute the command, but without having the command be undoable
This option will greatly improve performance for large numbers of object This will
:param relative: (C Q E) When used, the color values specified are added relative to the
current values
:param remove: (C Q E) When used, the color values are removed from the selected or
specified objects or components This option only supports meshes with no construction h
:param representation: (C Q E) This flag corresponds to the color channels to used, for
example A(alpha only), RGB, and RGBA
:returns: Success or Failure.
"""
pass
def TimeEditorMuteSelectedTracks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Revolve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BakeChannel(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AttributeEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_setRelaxAffectsAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def showHidden(*args, above: bool=True, allObjects: bool=True, below: bool=True, lastHidden:
bool=True, **kwargs)->None:
"""
The showHidden command is used to make invisible objects visible If no flags are specified,
only the objects given to the command will be made visible If a parent of an object is
invisible, the object will still be invisible Invisibility is inherited To ensure the
object becomes visible, use the -a/above flag This forces all invisible ancestor
:param above: (C) Make objects and all their invisible ancestors visible
:param allObjects: (C) Make all invisible objects visible
:param below: (C) Make objects and all their invisible descendants visible
:param lastHidden: (C) Show everything that was hidden with the last hide command
:returns:
"""
pass
def displaySmoothness(*args, all: bool=True, boundary: bool=True, defaultCreation: bool=True,
divisionsU: Union[int, bool]=0, divisionsV: Union[int, bool]=0, full:
bool=True, hull: bool=True, pointsShaded: Union[int, bool]=0, pointsWire:
Union[int, bool]=0, polygonObject: Union[int, bool]=0,
renderTessellation: bool=True, simplifyU: Union[int, bool]=0, simplifyV:
Union[int, bool]=0, q=True, query=True, **kwargs)->Union[None, Any]:
"""
This command is responsible for setting the display smoothness of NURBS curves and surfaces
to either predefined or custom values It also sets display modes for smoothness such as
hulls and the hull simplification factors At present, this command is NOT un-doable
:param all: (C Q) Change smoothness for all curves and surfaces
:param boundary: (C Q) Display wireframe surfaces using only the boundaries of the surface
Not fully implemented yet
:param defaultCreation: (C Q) The default values at creation (applies only -du, -dv, -pw,
-ps)
:param divisionsU: (C Q) Number of isoparm divisions per span in the U direction The valid
range of values is [0,64]
:param divisionsV: (C Q) Number of isoparm divisions per span in the V direction The valid
range of values is [0,64]
:param full: (C Q) Display surface at full resolution - the default
:param hull: (C Q) Display surface using the hull (control points are drawn rather than
surface knot points) This mode is a useful display performance improvement when
:param pointsShaded: (C Q) Number of points per surface span in shaded mode The valid
range of values is [1,64]
:param pointsWire: (C Q) Number of points per surface isoparm span or the number of points
per curve span in wireframe mode The valid range of values is [1,128] Note: This
:param polygonObject: (C Q) Display the polygon objects with the given resolution
:param renderTessellation: (C Q) Display using render tesselation parameters when in shaded
mode
:param simplifyU: (C Q) Number of spans to skip in the U direction when in hull display
mode
:param simplifyV: (C Q) Number of spans to skip in the V direction when in hull display
mode
:returns:
"""
pass
def dagCommandWrapper(*args, **kwargs)->None:
"""
"""
pass
def polyReduce(*args, caching: bool=True, cachingReduce: bool=False, colorWeights: Union[float,
bool]=0, compactness: Union[float, bool]=0.0, constructionHistory: bool=True,
geomWeights: Union[float, bool]=1, invertVertexWeights: bool=True, keepBorder:
bool=True, keepBorderWeight: Union[float, bool]=0.5, keepColorBorder: bool=True,
keepColorBorderWeight: Union[float, bool]=0.5, keepCreaseEdge: bool=True,
keepCreaseEdgeWeight: Union[float, bool]=0.5, keepFaceGroupBorder: bool=True,
keepFaceGroupBorderWeight: Union[float, bool]=0.5, keepHardEdge: bool=True,
keepHardEdgeWeight: Union[float, bool]=0.5, keepMapBorder: bool=True,
keepMapBorderWeight: Union[float, bool]=0.5, keepOriginalVertices: bool=False,
keepQuadsWeight: Union[float, bool]=0, name: AnyStr="", nodeState: Union[int,
bool]=0, percentage: Union[float, bool]=0, preserveLocation: bool=False,
preserveTopology: bool=True, replaceOriginal: bool=True, sharpness: Union[float,
bool]=0, symmetryPlaneW: Union[float, bool]=0, symmetryPlaneX: Union[float,
bool]=0, symmetryPlaneY: Union[float, bool]=0, symmetryPlaneZ: Union[float,
bool]=0, symmetryTolerance: Union[float, bool]=0, termination: Union[int,
bool]=0, triangleCount: Union[int, bool]=0, triangulate: bool=True,
useVirtualSymmetry: Union[int, bool]=0, uvWeights: Union[float, bool]=0,
version: Union[int, bool]=0, vertexCount: Union[int, bool]=0, vertexMapName:
Union[AnyStr, bool]="", vertexWeightCoefficient: Union[float, bool]=1,
weightCoefficient: Union[float, bool]=10000, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Simplify a polygonal object by reducing geometry while preserving the overall shape of the
mesh The algorithm for polyReduce was changed in 2014 to use a new algorithm derived from
Softimage However, the command still defaults to using the old algorithm for backwards
compatibility Therefore, we recommend setting the version flag to 1 for best r
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param cachingReduce: (C Q E) Cache intermediate reductions for speed at the expense of
memory It is recommended that caching be enabled when using the new algorithm (-version
1
:param colorWeights: (C Q E) This flag only applies when using the old algorithm and is
provided for backwards compatibility How much consideration vertex color is given in the
:param compactness: (C Q E) This flag only applies when using the old algorithm and is
provided for backwards compatibility Tolerance for compactness for the generated triangle
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param geomWeights: (C Q E) This flag only applies when using the old algorithm and is
provided for backwards compatibility How much consideration vertex positions are given in
:param invertVertexWeights: (C Q E) This flag controls how weight map values are
interpreted If true, a vertex weight of 1.0 means a vertex is unlikely to be reduced If
false, a verte
:param keepBorder: (C Q E) If true, reduction will try to retain geometric borders and the
border of the selection C: Default is true Q: When queried, this flag returns a boo
:param keepBorderWeight: (C Q E) If keepBorder is on, this flag specifies the weight to
assign to borders Setting this value to 0 will disable border preservation and a value of
1 w
:param keepColorBorder: (C Q E) If true, reduction will try to retain color borders These
are determined according to color Ids This flag only applies when using the new algorithm
:param keepColorBorderWeight: (C Q E) If keepColorBorder is on, this flag specifies the
weight to assign to color borders Setting this value to 0 will disable color border
preservation a
:param keepCreaseEdge: (C Q E) If true, reduction will try to retain crease edges C:
Default is true This flag only applies when using the new algorithm (-version 1) C:
Default
:param keepCreaseEdgeWeight: (C Q E) If keepCreaseEdge is on, this flag specifies the
weight to assign to crease edges Setting this value to 0 will disable crease edge
preservation and
:param keepFaceGroupBorder: (C Q E) If true, reduction will try to retain borders of face
groups, which are mostly used to define material assignments This flag only applies when
using
:param keepFaceGroupBorderWeight: (C Q E) If keepFaceGroupBorder is on, this flag specifies
the weight to assign to material borders Setting this value to 0 will disable group border
preserv
:param keepHardEdge: (C Q E) If true, reduction will try to retain hard edges C: Default
is true Q: When queried, this flag returns a boolean
:param keepHardEdgeWeight: (C Q E) If keepHardEdge is on, this flag specifies the weight to
assign to hard edges Setting this value to 0 will disable hard edge preservation and a
valu
:param keepMapBorder: (C Q E) If true, reduction will try to retain UV borders A UV border
is present if the faces on either side of the edge do not share UV Ids C: Default is t
:param keepMapBorderWeight: (C Q E) If keepMapBorder is on, this flag specifies the weight
to assign to UV map borders Setting this value to 0 will disable UV map border
preservation a
:param keepOriginalVertices: (C Q E) This flag only applies when using the old algorithm
and is provided for backwards compatibility If true, vertices will try to retain their
original
:param keepQuadsWeight: (C Q E) This flag controls how much consideration is given to
oreserving quad faces during reduction A higher weight means the reduction will try harder
to
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param percentage: (C Q E) This flag specifies how many vertices to remove during reduction
as a percentage of the original mesh This flag only applies if the termination flag
:param preserveLocation: (C) This flag guarantees that if the original geometry is
preserved, the new geometry will have the same location C: Default is false
:param preserveTopology: (C Q E) this flag guarantees that the topological type will be
preserved during reduction In particular, if the input is manifold then the output will be
ma
:param replaceOriginal: (C) Create "in place" (i.e., replace) (not available in all
commands) NOTE: This flag is intended for use by the "Reduce" menu item If 'polyReduce
-rpo
:param sharpness: (C Q E) Sharpness controls the balance between preserving small, sharp
details versus larger shapes At low values, details that are small relative to the ge
:param symmetryPlaneW: (C Q E) W value of the symmetry plane This flag only applies when
using the new algorithm (-version 1) and the useVirtualSymmetry flag is set to 2 C: Defau
:param symmetryPlaneX: (C Q E) X value of the symmetry plane This flag only applies when
using the new algorithm (-version 1) and the useVirtualSymmetry flag is set to 2 C: Defau
:param symmetryPlaneY: (C Q E) Y value of the symmetry plane This flag only applies when
using the new algorithm (-version 1) and the useVirtualSymmetry flag is set to 2 C: Defau
:param symmetryPlaneZ: (C Q E) Z value of the symmetry plane This flag only applies when
using the new algorithm (-version 1) and the useVirtualSymmetry flag is set to 2 C: Defau
:param symmetryTolerance: (C Q E) Tolerance to use when applying symmetry For each vertex
of the mesh, we find its exact symmetric point, then we look for the closest vertex to the
e
:param termination: (C Q E) This flag specifies the termination condition to use when
reducing the mesh This flag only applies to the new algorithm (-version 1) 0 Percentage
1
:param triangleCount: (C Q E) This flag specifies a target number of triangles to retain
after reduction Note that other factors such as quad and feature preservation may take pr
:param triangulate: (C Q E) This flag only applies when using the old algorithm and is
provided for backwards compatibility This attribute specifies if the geometry or the sele
:param useVirtualSymmetry: (C Q E) This flag controls whether symmetry is preserved during
the reduction This flag only applies when using the new algorithm (-version 1) and the
keepQ
:param uvWeights: (C Q E) This flag only applies when using the old algorithm and is
provided for backwards compatibility How much consideration uv positions are given in the
:param version: (C Q E) Version of the poly reduce algorithm to use 0 Old algorithm used
in Maya 2013 and prior for backwards compatibility 1 New algorithm derived from Sof
:param vertexCount: (C Q E) This flag specifies a target number of vertices to retain after
reduction Note that other factors such as quad and feature preservation may take pre
:param vertexMapName: (C Q) Name of a color set to be added to the output mesh that stores
a mapping from vertices in the output mesh to vertices in the input mesh The color se
:param vertexWeightCoefficient: (C Q E) This flag specifies a constant value to multiply to
each weight map value A value of zero turns off the weight map This flag only applies
when usin
:param weightCoefficient: (C Q E) This flag only applies when using the old algorithm and
is provided for backwards compatibility The weight of each vertex is multiplied with this
co
:returns: The node name.
"""
pass
def tumbleCtx(*args, alternateContext: bool=True, autoOrthoConstrain: bool=True, autoSetPivot:
bool=True, exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", localTumble:
Union[int, bool]=0, name: AnyStr="", objectTumble: bool=True, orthoLock:
bool=True, orthoStep: Union[float, bool]=0.0, toolName: Union[AnyStr, bool]="",
tumbleScale: Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create, edit, or query a tumble context
:param alternateContext: (C Q) Set the ALT+MMB and ALT+SHIFT+MMB to refer to this context
:param autoOrthoConstrain: (C Q E) Automatically constrain horizontal and vertical
rotations when the camera is orthographic The shift key can be used to unconstrain the
rotation
:param autoSetPivot: (C Q E) Automatically set the camera pivot to the selection or tool
effect region
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param localTumble: (C Q E) Describes what point the camera will tumble around: 0 for the
camera's tumble pivot 1 for the camera's center of interest 2 for the camera's local ax
:param name: (C) If this is a tool command, name the tool appropriately
:param objectTumble: (C Q E) Make the camera tumble around the selected object, if true
:param orthoLock: (C Q E) Orthographic cameras cannot be tumbled while orthoLock is on
:param orthoStep: (C Q E) Specify the angular step in degrees for orthographic rotation If
camera is orthographic and autoOrthoConstrain is toggled on the rotation will be st
:param toolName: (C Q) Name of the specific tool to which this command refers
:param tumbleScale: (C Q E) Set the rotation speed A tumble scale of 1.0 will result in in
40 degrees of rotation per 100 pixels of cursor drag
:returns: The name of the context
"""
pass
def RenderViewWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EmptyAnimLayer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def uvLink(*args, b: bool=True, isValid: bool=True, make: bool=True, queryObject: name=None,
texture: name=None, uvSet: name=None, q=True, query=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command is used to make, break and query UV linking relationships between UV sets on
objects and textures that use those UV sets If no make, break or query flag is specified
and both uvSet and texture flags are present, the make flag is assumed to be specified If
no make, break or query flag is specified and only one of the uvSet and textu
:param b: (C) The presence of this flag on the command indicates that the command is being
invoked to break links between UV sets and textures
:param isValid: (C) This flag is used to verify whether or not a texture or UV set is valid
for the purposes of UV linking It should be used in conjunction with either
:param make: (C) The presence of this flag on the command indicates that the command is
being invoked to make links between UV sets and textures
:param queryObject: (C) This flag should only be used in conjunction with a query of a
texture This flag is used to indicate that the results of the query should be limited
:param texture: (C) The argument to the texture flag specifies the texture to be used by
the command in performing the action
:param uvSet: (C) The argument to the uvSet flag specifies the UV set to be used by the
command in performing the action
:returns: or array of strings for query
boolean for isValid
"""
pass
def PoleVectorConstraintOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def renameUI(*args, **kwargs)->AnyStr:
"""
This command renames the UI object passed as first arument to the new name specified as
second argument If the new name is a duplicate, or not valid, then re-naming fails and the
old name is returned
:returns: The new name, or the old name if re-naming fails.
"""
pass
def AnimationSnapshot(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmSplineSetCurrentDescription(*args, **kwargs)->None:
"""
"""
pass
def ToggleUVIsolateViewSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def jointCluster(*args, aboveBound: Union[float, bool]=0.0, aboveCluster: bool=True,
aboveDropoffType: Union[AnyStr, bool]="", aboveValue: Union[float, bool]=0.0,
belowBound: Union[float, bool]=0.0, belowCluster: bool=True, belowDropoffType:
Union[AnyStr, bool]="", belowValue: Union[float, bool]=0.0, deformerTools:
bool=True, joint: AnyStr="", name: AnyStr="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The joint cluster command adds high-level controls to manage the cluster percentage values
on a bound skin around a joint JointClusters are one way to create smooth bending
behaviour on skin when joints rotate a <---- aboveBound ____________a_________ a \
Joint1 a Joint2 _____________a_______ \ a \ \ b <--- belowBound a \ \ b \ b
:param aboveBound: (C Q E) Specifies the where the drop-off begins in the direction of the
bone above the joint A value of 100 indicates the entire length of the bone The def
:param aboveCluster: (Q) Returns the name of the cluster associated with the bone above
this joint
:param aboveDropoffType: (C Q E) Specifies the type of percentage drop-off in the direction
of the bone above this joint Valid values are "linear", "exponential", "sine" and "none"
:param aboveValue: (C Q E) Specifies the drop-off percentage of the joint cluster in the
direction of the bone above the cluster A value of 100 indicates the entire length of
:param belowBound: (C Q E) Specifies where the drop-off ends in the direction of the bone
below the joint A value of 100 indicates the entire length of the bone The default v
:param belowCluster: (Q) Returns the name of the cluster associated with this joint
:param belowDropoffType: (C Q E) Specifies the type of type of percentage drop-off in the
direction of the bone below this joint Valid values are "linear", "exponential", "sine"
and
:param belowValue: (C Q E) Specifies the drop-off percentage of the joint cluster in the
direction of the joint below the cluster A value of 100 indicates the entire length of
:param deformerTools: (Q) Used to query for the helper nodes associated with the
jointCluster
:param joint: (C) Specifies the joint that the cluster should act about
:param name: (C) This flag is obsolete
:returns: Name of the new jointCluster node
"""
pass
def DuplicateWithTransform(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AttachSelectedAsSourceField(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def subdCollapse(*args, caching: bool=True, level: Union[int, bool]=0, nodeState: Union[int,
bool]=0, constructionHistory: bool=True, name: AnyStr="", object: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command converts a takes a subdivision surface, passed as the argument, and produces a
subdivision surface with a number of hierarchy levels "removed" Returns the name of the
subdivision surface created and optionally the DG node that does the conversion
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param level: (C Q E) The level that will now become the base mesh Default: 0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:returns: The subd surface and optionally the dependency node name
"""
pass
def HideJoints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleChannelsLayers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddHolderOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NEmitFromObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetLengthBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshScrapeTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def StraightenCurvesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportUseTmpFilePeripheral(*args, **kwargs)->None:
"""
"""
pass
def PolyMerge(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def rigidBody(*args, active: bool=True, angularVelocity: bool=True, applyForceAt: Union[AnyStr,
bool]="", bounciness: Union[float, bool]=0.6, cache: bool=True, centerOfMass:
Union[List[float, float, float], bool]=None, collisions: bool=True, contactCount:
bool=True, contactName: bool=True, contactPosition: bool=True, damping:
Union[float, bool]=0.0, deleteCache: bool=True, dynamicFriction: Union[float,
bool]=0.2, force: bool=True, ignore: bool=True, impulse: List[float, float,
float]=None, impulsePosition: List[float, float, float]=None,
initialAngularVelocity: Union[List[float, float, float], bool]=None,
initialVelocity: Union[List[float, float, float], bool]=None, layer: Union[int,
bool]=0, lockCenterOfMass: bool=True, mass: Union[float, bool]=1.0, name:
Union[AnyStr, bool]="", orientation: Union[List[float, float, float], bool]=None,
particleCollision: bool=True, passive: bool=True, position: Union[List[float,
float, float], bool]=None, removeShape: Union[AnyStr, bool]="", solver:
Union[AnyStr, bool]="", spinImpulse: List[float, float, float]=None,
standInObject: Union[AnyStr, bool]="", staticFriction: Union[float, bool]=0.2,
tesselationFactor: Union[int, bool]=200, velocity: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a rigid body from a polygonal or nurbs surface
:param active: (C Q E) Creates a rigid body that is active An active rigid body accepts
and causes collisions and is effected by dynamic fields This is the default
:param angularVelocity: (Q) Current angular velocity of rigid body
:param applyForceAt: (C Q E) Determines how forces are applied to the rigid body The
choices are centerOfMass | boundingBox | verticesOrCVs Default: boundingBox
:param bounciness: (C Q E) Sets the restitution (or bounciness) of the rigid body Range:
0.0 - 2.0 Default: 0.6
:param cache: (C Q E) Turns caching on (1) or off (0) for the rigid body Default: off
:param centerOfMass: (C Q E) Sets the center of mass (x,y,z) of the rigid body Default:
actual center of mass
:param collisions: (C Q E) Truns collisions on/off for the rigid body If the collisions
are turned of the rigid body will not collide with any other rigid body Default: on
:param contactCount: (Q) returns the current contact count for the rigid body
:param contactName: (Q) returns all the rigid body names which are in contact with this
shape One name for each contact will be returned
:param contactPosition: (Q) returns all the contact position One position for each contact
will be returned
:param damping: (C Q E) Sets the damping value of the rigid body Range: -2.0 - 2.0
Default: 0.0
:param deleteCache: (E) Deletes the cache (if one exists) of the rigid body
:param dynamicFriction: (C Q E) Sets the dynamic friction for the rigid body Range: 0.0 -
1.0 Default: 0.2
:param force: (Q) Current force on the rigid body
:param ignore: (C Q E) Causes the rigid body to be ignored in the rigid solver Default:
off
:param impulse: (C E) Applies an impulse (instantaneous) force on a rigid body Default:
0.0 0.0 0.0
:param impulsePosition: (C E) The position at which the impulse is applied Default: the
bodies center of mass
:param initialAngularVelocity: (C Q E) Sets the initial angular velocity of the rigid body
Default: 0.0 0.0 0.0
:param initialVelocity: (C Q E) Sets the initial velocity of the rigid body Default: 0.0
0.0 0.0
:param layer: (C Q E) Sets the collision layer of the rigid body Only rigid bodies in the
same collision layer can collide with each other Range: >= 0 Default: 0
:param lockCenterOfMass: (C Q E) Locks the center of mass for the rigid body Default: off
:param mass: (C Q E) Sets the mass of the rigid body Range: > 0 Default: 1.0
:param name: (C Q E) Assigns the rigid body the given name
:param orientation: (C Q E) Sets the initial orientation (x,y,z) of the rigid body
Default: current orientation
:param particleCollision: (C Q E) Turns the ability for a rigid body to collide with
particles on and off The particles will exert a force on the rigid body Default: off
:param passive: (C Q E) Creates a rigid body that is passive A passive rigid body does not
react to collisions but active rigid bodies can collide with it Dynamic Fields w
:param position: (C Q E) Sets the initial position (x,y,z) of the rigid body Default:
current position
:param removeShape: (C Q E) Remove the named shape
:param solver: (C Q E) The name of the solver which this rigid node is to resided If the
solver does not exists then the rigid body will not be created If the edit flag i
:param spinImpulse: (C E) Applies an spin impulse (instantaneous rotational) force on a
rigid body Default: 0.0 0.0 0.0
:param standInObject: (C Q E) Causes the simulator to use a stand in object for the
simulation The choices are none | cube | sphere The default is none Default: none
:param staticFriction: (C Q E) Sets the static friction for the rigid body Range: 0.0 -
1.0 Default: 0.2
:param tesselationFactor: (C Q) Sets the tesselation factor for a rigid body surface
Range: >= 10 Default: 200
:param velocity: (Q) Current velocity of rigid body
:returns: New rigid body name.
"""
pass
def canCreateCaddyManip(*args, **kwargs)->bool:
"""
This command returns true if there can be a manipulator made for the specified selection,
false otherwise
:returns: The queried value
"""
pass
def timePort(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, globalTime: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured: bool=True,
manage: bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
snap: bool=True, statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a simple time control widget See also the "timeControl" command
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param globalTime: (C Q E) "true" means this widget controls and displays the global,
dependency graph time "false" means time changes here do NOT affect the dependency graph
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param snap: (C Q E) "true" means this widget is constrained to having values that are
integers representing the current time unit. "false" means the current time indica
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Widget name
"""
pass
def MakeBrushSpringOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def selectKeyframeRegionCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This command creates a context which may be used to select keyframes within the keyframe
region of the dope sheet editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns:
"""
pass
def ShowLightManipulators(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def deleteExtension(*args, attribute: AnyStr="", forceDelete: bool=True, nodeType: AnyStr="",
**kwargs)->int:
"""
This command is used to delete an extension attribute from a node type The attribute can
be specified by using either the long or short name Only one extension attribute can be
deleted at a time Children of a compound attribute cannot be deleted, you must delete the
complete compound attribute This command has no undo, edit, or query capabiliti
:param attribute: (C) Specify either the long or short name of the attribute
:param forceDelete: (C) If this flag is set and turned ON then data values for the
extension attributes are all deleted without confirmation If it's set and turned OFF then
:param nodeType: (C) The name of the node type
:returns: Number of nodes with altered data after the delete
"""
pass
def AnimationSnapshotOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setRenderPassType(*args, defaultDataType: bool=True, numChannels: int=0, type: AnyStr="",
**kwargs)->bool:
"""
This command will set the passID of a renderPass node and create the custom attributes
specified by the corresponding render pass definition If the render pass node already has
a passID assigned to it, attributes that are no longer required become hidden, and new
attributes are unhidden and/or created as needed This allows passIDs to be changed b
:param defaultDataType: (C) If set, the render pass will use its default data type
:param numChannels: (C) Specify the number of channels to use in the render pass Note that
this flag is only valid if there is an implementation supporting the requested nu
:param type: (C) Specify the pass type to assign to the pass node(s)
:returns: true/false
"""
pass
def renameAttr(*args, **kwargs)->AnyStr:
"""
Renames the given user-defined attribute to the name given in the string argument If the
new name conflicts with an existing name then this command will fail Note that it is not
legal to rename an attribute to the empty string
:returns: The new name. When undone returns the original name.
"""
pass
def geometryConstraint(*args, layer: AnyStr="", name: Union[AnyStr, bool]="", remove: bool=True,
targetList: bool=True, weight: Union[float, bool]=0.0, weightAliasList:
bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
Constrain an object's position based on the shape of the target surface(s) at the closest
point(s) to the object A geometryConstraint takes as input one or more surface shapes
(the targets) and a DAG transform node (the object) The geometryConstraint position
constrained object such object lies on the surface of the target with the greatest weig
:param layer: (C E) Specify the name of the animation layer where the constraint should be
added
:param name: (C Q E) Sets the name of the constraint node to the specified name Default
name is constrainedObjectName_constraintType
:param remove: (E) removes the listed target(s) from the constraint
:param targetList: (Q) Return the list of target objects
:param weight: (C Q E) Sets the weight value for the specified target(s) If not given at
creation time, the default value of 1.0 is used
:param weightAliasList: (Q) Returns the names of the attributes that control the weight of
the target objects Aliases are returned in the same order as the targets are returned
:returns: Name of the created constraint node
"""
pass
def toolCollection(*args, collectionItemArray: bool=True, defineTemplate: AnyStr="", exists:
bool=True, gl: bool=True, numberOfCollectionItems: bool=True, parent:
AnyStr="", select: Union[AnyStr, bool]="", useTemplate: AnyStr="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a tool button collection Collections are parented to the current
default layout if no parent is specified with the -p/parent flag As children of the layout
they will be deleted when the layout is deleted Collections may also span more than one
window if the -gl/global flag is used In this case the collection has no parent a
:param collectionItemArray: (Q) Returns a string list giving the long names of all the
items in this collection
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param gl: (C Q) Set the collection to have no parent layout This flag must be specified
when the collection is created and can not be queried or edited Consequentl
:param numberOfCollectionItems: (Q) Returns the number of items that are in this
collection
:param parent: (C) Specify the parent to associate the collection with The collection will
be deleted along with the parent This flag must be specified when the colle
:param select: (C Q E) Select the specified collection item If queried will return the
name of the currently selected collection item
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the toolCollection created.
"""
pass
def RigidBindSkin(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nodeGrapher(*args, **kwargs)->None:
"""
"""
pass
def AppendToHairCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteSurfaceFlow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshFillTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fileBrowserDialog(*args, actionName: AnyStr="", dialogStyle: int=0, fileCommand:
Script=None, fileType: AnyStr="", filterList: Union[AnyStr,
List[AnyStr]]="", includeName: AnyStr="", mode: int=0, operationMode:
AnyStr="", tipMessage: AnyStr="", windowTitle: AnyStr="",
**kwargs)->AnyStr:
"""
The fileBrowserDialog and fileDialog commands have now been deprecated Both commands are
still callable, but it is recommended that the fileDialog2 command be used instead To
maintain some backwards compatibility, both fileBrowserDialog and fileDialog will convert
the flags/values passed to them into the appropriate flags/values that the fileDial
:param actionName: (C) Script to be called when the file is validated
:param dialogStyle: (C) 0 for old style dialog 1 for Windows 2000 style Explorer style 2
for Explorer style with "Shortcut" tip at bottom
:param fileCommand: (C) The script to run on command action
:param fileType: (C) Set the type of file to filter By default this can be any one of:
"mayaAscii", "mayaBinary", "mel", "OBJ", "directory", "plug-in", "audio", "move",
:param filterList: (C M) Specify file filters Used with dialog style 1 and 2 Each string
should be a description followed by a comma followed by a semi-colon separated list
:param includeName: (C) Include the given string after the actionName in parentheses If
the name is too long, it will be shortened to fit on the dialog (for example, /usr/a
:param mode: (C) Defines the mode in which to run the file brower: 0 for read 1 for write 2
for write without paths (segmented files) 4 for directories have meaning w
:param operationMode: (C) Enables the option dialog Valid strings are: "Import"
"Reference" "SaveAs" "ExportAll" "ExportActive"
:param tipMessage: (C) Message to be displayed at the bottom of the style 2 dialog box
:param windowTitle: (C) Set the window title of a style 1 or 2 dialog box
:returns: Dialog name
"""
pass
def PolyEditEdgeFlow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintEffectsToPoly(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def instancer(*args, addObject: bool=True, cycle: Union[AnyStr, bool]="none", cycleStep:
Union[float, bool]=0.0, cycleStepUnits: Union[AnyStr, bool]="frames", index:
Union[int, bool]=0, levelOfDetail: Union[AnyStr, bool]="geometry", name:
Union[AnyStr, bool]="", object: Union[AnyStr, List[AnyStr], bool]="",
objectPosition: Union[AnyStr, bool]="", objectRotation: Union[AnyStr, bool]="",
objectScale: Union[AnyStr, bool]="", pointDataSource: bool=True, removeObject:
bool=True, rotationOrder: Union[AnyStr, bool]="", rotationUnits: Union[AnyStr,
bool]="", valueName: Union[AnyStr, bool]="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command is used to create a instancer node and set the proper attributes in the node
:param addObject: (C E) This flag indicates that objects specified by the -object flag will
be added to the instancer node as instanced objects
:param cycle: (C Q E) This flag sets or queries the cycle attribute for the instancer node
The options are "none" or "sequential" The default is "none"
:param cycleStep: (C Q E) This flag sets or queries the cycle step attribute for the
instancer node This attribute indicates the size of the step in frames or seconds (see cy
:param cycleStepUnits: (C Q E) This flag sets or queries the cycle step unit attribute for
the instancer node The options are "frames" or "seconds" The default is "frames"
:param index: (Q) This flag is used to query the name of the ith instanced object
:param levelOfDetail: (C Q E) This flag sets or queries the level of detail of the
instanced objects The options are "geometry", "boundingBox", "boundingBoxes" The default
is "g
:param name: (C Q) This flag sets or queries the name of the instancer node
:param object: (C Q E M) This flag indicates which objects will be add/removed from the
list of instanced objects The flag is used in conjuction with the -add and -remove fl
:param objectPosition: (Q) This flag queries the given objects position This object can be
any instanced object or sub-object
:param objectRotation: (Q) This flag queries the given objects rotation This object can be
any instanced object or sub-object
:param objectScale: (Q) This flag queries the given objects scale This object can be any
instanced object or sub-object
:param pointDataSource: (Q) This flag is used to query the source node supply the data for
the input points
:param removeObject: (E) This flag indicates that objects specified by the -object flag
will be removed from the instancer node as instanced objects
:param rotationOrder: (C Q E) This flag specifies the rotation order associated with the
rotation flag The options are XYZ, XZY, YXZ, YZX, ZXY, or ZYX By default the attribute i
:param rotationUnits: (C Q E) This flag specifies the rotation units associated with the
rotation flag The options are degrees or radians By default the attribute is degrees
:param valueName: (Q) This flag is used to query the value(s) of the array associated with
the given name If the -index flag is used in conjuction with this flag then the
:returns: Command result
"""
pass
def HideNURBSCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def openGLExtension(*args, extension: AnyStr="", renderer: bool=True, vendor: bool=True,
version: bool=True, **kwargs)->AnyStr:
"""
Command returns the extension name depending on whether a given OpenGL extension is
supported or not The input is the extension string to the -extension flag If the
-extension flag is not used, or if the string argument to this flag is an empty string than
all extension names are returned in a single string If the extension exists it is not
nece
:param extension: (C) Specifies the OpenGL extension to query
:param renderer: (C) Specifies to query the OpenGL renderer
:param vendor: (C) Specifies to query the company responsible for the OpenGL
implementation
:param version: (C) Specifies to query the OpenGL version
:returns: The supported string(s)
"""
pass
def SubdivSmoothnessMediumOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def arnoldCopyAsAdmin(*args, **kwargs)->None:
"""
"""
pass
def LoftOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def u3dUnfold(*args, **kwargs)->None:
"""
"""
pass
def TurbulenceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ReferenceEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportSetMayaFrameRate(*args, **kwargs)->None:
"""
"""
pass
def texManipContext(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Command used to register the texSelectCtx tool Command used to register the texManipCtx
tool
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:returns: : name of the context created
"""
pass
def xgmDensityComp(*args, **kwargs)->None:
"""
"""
pass
def createNurbsPlaneCtx(*args, **kwargs)->None:
"""
"""
pass
def CreateNURBSSquare(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def truncateHairCache(*args, q=True, query=True, e=True, edit=True, **kwargs)->Union[None,
Any]:
"""
This command sets the end time of a hair cache to the current time If the current time is
less than the end time of the cache, the cache is truncated so that only the portion of the
cache up to and including the current time is preserved
:returns:
"""
pass
def arcLenDimContext(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Command used to register the arcLenDimCtx tool
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: : name of the context created
"""
pass
def RemoveWireOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def promptDialog(*args, backgroundColor: List[float, float, float]=None, button: Union[AnyStr,
List[AnyStr]]="", cancelButton: AnyStr="", defaultButton: AnyStr="",
dismissString: AnyStr="", message: AnyStr="", messageAlign: AnyStr="", parent:
AnyStr="", scrollableField: bool=True, style: AnyStr="", text: Union[AnyStr,
bool]="", title: AnyStr="", q=True, query=True, **kwargs)->Union[AnyStr, Any]:
"""
The promptDialog command creates a modal dialog with a message to the user, a text field in
which the user may enter a response, and a variable number of buttons to dismiss the dialog
The dialog is dismissed when the user presses any button or chooses the close item from
the window menu In the case where a button is pressed then the name of the b
:param backgroundColor: (C) The background color of the dialog The arguments correspond to
the red, green, and blue color components Each component ranges in value from 0.0 to
:param button: (C M) Create a button with the given string as it's text
:param cancelButton: (C) The cancel button is activated by pressing the escape key Note
that this flag does not create a button, it simply indicates which button created via
:param defaultButton: (C) The default button is activated by pressing the enter key Note
that this flag does not create a button, it simply indicates which button created via
:param dismissString: (C) The string returned when the user selects the 'Close' item from
the Window Manager menu If this flag is not set then the string "dismiss" is returne
:param message: (C) The message text appearing in the dialog
:param messageAlign: (C) Align the message left, center, or right
:param parent: (C) Specify the parent window for the dialog The dialog will be centered on
this window and raise and lower with it's parent By default, the dialog is
:param scrollableField: (C) By default a single line text field is used in the dialog
Specify true for a multi-line scroll field
:param style: (C) Specify the type of input expected in the input field Vaid input types
are "integer" "float" "text" If this flag is not specified, we assume the in
:param text: (C Q) The field text
:param title: (C) The dialog title
:returns: Indicates how the dialog was dismissed. If a button is
pressed then the label of
the button is returned. If the dialog is
closed then the value for the flag
ds/dismissString is
returned.
"""
pass
def TimeEditorFrameSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InsertIsoparms(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportLights(*args, **kwargs)->None:
"""
"""
pass
def dR_meshAlphaTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nodeCast(*args, copyDynamicAttrs: bool=True, disableAPICallbacks: bool=True,
disableScriptJobCallbacks: bool=True, disconnectUnmatchedAttrs: bool=True, force:
bool=True, swapNames: bool=True, swapValues: bool=True, **kwargs)->int:
"""
Given two nodes, a source node of type A and a target node of type B, where type A is
either type B or a sub-type of B, this command will replace the target node with the source
node That is, all node connections, DAG hierarchy and attribute values on the target node
will be removed from the target node and placed on the source node This operatio
:param copyDynamicAttrs: (C) If the target node contains any dynamic attributes that are
not defined on the source node, then create identical dynamic attricutes on the source no
:param disableAPICallbacks: (C) add comment
:param disableScriptJobCallbacks: (C) add comment
:param disconnectUnmatchedAttrs: (C) If the node that is being swapped out has any
connections that do not exist on the target node, then indicate if the connection should be
disconnecte
:param force: (C) Forces the command to do the node cast operation even if the nodes do not
share a common base object When this flag is specified the command will tr
:param swapNames: (C) Swap the names of the nodes By default names are not swapped
:param swapValues: (C) Indicates if the commands should exchange attributes on the common
attributes between the two nodes For example, if the nodes are the same base type
:returns: 0 for success, 1 for failure.
"""
pass
def reorder(*args, back: bool=True, front: bool=True, relative: int=0, **kwargs)->None:
"""
This command reorders (moves) objects relative to their siblings For relative moves, both
positive and negative numbers may be specified Positive numbers move the object forward
and negative numbers move the object backward amoung its siblings When an object is at the
end (beginning) of the list of siblings, a relative move of 1 (-1) will put t
:param back: (C) Move object(s) to back of sibling list
:param front: (C) Move object(s) to front of sibling list
:param relative: (C) Move object(s) relative to other siblings
:returns:
"""
pass
def polyDuplicateEdge(*args, adjustEdgeFlow: Union[float, bool]=0.0, deleteEdge: bool=True,
endVertexOffset: Union[float, bool]=0.0, insertWithEdgeFlow: bool=True,
offset: float=0.0, smoothingAngle: Union[float, bool]=0.0, splitType:
Union[int, bool]=0, startVertexOffset: Union[float, bool]=0.0, caching:
bool=True, constructionHistory: bool=True, name: AnyStr="", nodeState:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Duplicates a series of connected edges (edgeLoop)
:param adjustEdgeFlow: (C Q E) The weight value of the edge vertices to be positioned
:param deleteEdge: (C Q E) When true, the end edges are deleted so the end triangles are
converted to quads
:param endVertexOffset: (C Q E) Weight value controlling the offset of the end vertex of
the edgeloop
:param insertWithEdgeFlow: (C Q E) True to enable edge flow Otherwise, the edge flow is
disabled
:param offset: (C) Weight value controlling the relative positioning of the new edges The
range of values is [0.0, 1.0]
:param smoothingAngle: (C Q E) Angle below which new edges will be smoothed
:param splitType: (C Q E) Format: 0 - Absolute, 1 - Relative, 2 - Multi
:param startVertexOffset: (C Q E) Weight value controlling the offset of the start vertex
of the edgeloop
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def BrushPresetReplaceShadingOff(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def saveImage(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, currentView: bool=True, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True, enableKeyboardFocus:
bool=True, exists: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, image: Union[AnyStr,
bool]="", isObscured: bool=True, manage: bool=True, noBackground: bool=True,
numberOfPopupMenus: bool=True, objectThumbnail: AnyStr="", parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True, sceneFile:
AnyStr="", statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a static image for non-xpm files Any image file format supported by
the file texture node is supported by this command This command creates a static image
control for non-xpm files used to display a thumbnail image of the scene file
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param currentView: (E) Generate the image from the current view
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param image: (C Q E) Sets the image given the file name
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param objectThumbnail: (E) Use an image of the named object, if possible
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param sceneFile: (E) The name of the file that the icon is to be associated with
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the image created.
"""
pass
def ExportOfflineFileOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadePickWalkUp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectCVsMask(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorSetTraversalDepthZero(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def relationship(*args, b: bool=True, relationshipData: Union[AnyStr, List[AnyStr], bool]="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This is primarily for use with file IO Rather than write out the specific
attributes/connections required to maintain a relationship, a description of the related
nodes/plugs is written instead The relationship must have an owner node, and have a
specific type During file read, maya will make the connections and/or set the data
necessary to repr
:param b: (C Q E) Break the specified relationship instead of creating it
:param relationshipData: (C Q E M) Provide relationship data to be used when creating the
relationship
:returns:
"""
pass
def pfxstrokes(*args, filename: AnyStr="", postCallback: bool=True, selected: bool=True,
**kwargs)->None:
"""
This command will loop through all the Paint Effects strokes, including pfxHair nodes, and
write the current state of all the tubes to a file For normal stroke nodes tubes must be
ON in the brush or there will be no output For pfxHair nodes there will always be output,
but the format is different than for stroke nodes(however one can assign a bru
:param filename: (C) The output file
:param postCallback: (C) Output information to the file after the Runtime Callback MEL
function has been invoked The default is to output the information prior to the callba
:param selected: (C) Only loop through the selected strokes
:returns:
"""
pass
def launchImageEditor(*args, editImageFile: AnyStr="", viewImageFile: AnyStr="",
**kwargs)->None:
"""
Launch the appropriate application to edit/view the image files specified This command
works only on the Macintosh and Windows platforms
:param editImageFile: (C) If the file is a PSD, then the specified verison of Photoshop is
launched, and the file is opened in it If file is any other image type, then the pr
:param viewImageFile: (C) Opens up an Image editor to view images
:returns:
"""
pass
def RedoPreviousIPRRender(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtendCurveOnSurfaceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllFurs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def detachDeviceAttr(*args, all: bool=True, attribute: AnyStr="", axis: AnyStr="", device:
AnyStr="", selection: bool=True, q=True, query=True, **kwargs)->Union[None,
Any]:
"""
This command detaches connections between device axes and node attributes The command line
arguments are the same as for the corresponding attachDeviceAttr except for the clutch
argument which can not be used in this command
:param all: (C) Delete all attachments on every device
:param attribute: (C) The attribute to detach This flag must be used with the -d/device
flag
:param axis: (C) The axis to detach This flag must be used with the -d/device flag
:param device: (C) Delete the attachment for this device If the -ax/axis flag is not used,
all of the attachments connected to this device are detached
:param selection: (C) Detaches selection attachments
:returns:
"""
pass
def AddShrinkWrapSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypergraphDecreaseDepth(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmMoveDescription(*args, **kwargs)->None:
"""
"""
pass
def PruneLattice(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetPartBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SendToUnrealSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetHIKChildId(*args, **kwargs)->None:
"""
"""
pass
def XgmSetLengthBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideNonlinears(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolygonNormalEditTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AutoPaintMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def subdivDisplaySmoothness(*args, smoothness: Union[int, bool]=0, q=True, query=True,
**kwargs)->Union[bool, Any]:
"""
Sets or querys the display smoothness of subdivision surfaces on the selection list or of
all subdivision surfaces if the -all option is set Smoothness options are; rough, medium,
or fine Rough is the default
:param smoothness: (C Q) Smoothness - 1 rough, 2 medium, 3 fine
:returns: Command result
"""
pass
def TexSculptUnpinAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectContiguousEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InTangentClamped(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def curveCVCtx(*args, bezier: bool=True, degree: Union[int, bool]=0, exists: bool=True,
history: bool=True, image1: Union[AnyStr, bool]="", image2: Union[AnyStr,
bool]="", image3: Union[AnyStr, bool]="", multEndKnots: bool=True, name:
AnyStr="", preserveShape: bool=True, rational: bool=True, refit: bool=True,
symmetry: bool=True, uniform: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
The curveCVCtx command creates a new context for creating curves by placing control
vertices (CVs)
:param bezier: (C Q E)
:param degree: (C Q E) Curve degree
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param multEndKnots: (C Q E) Specify if multiple end knots are to be created
:param name: (C) If this is a tool command, name the tool appropriately
:param preserveShape: (C Q E) Set this flag to make the operation preserve the shape
:param rational: (C Q E) Should the curve be rational?
:param refit: (C Q E) Set this flag to refit the curve
:param symmetry: (C Q E) Specify if symmetry is to be used
:param uniform: (C Q E) Should the curve use uniform parameterization?
:returns: (name of the new context)
"""
pass
def NodeEditorSelectUpStream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setEditCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name: AnyStr="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a tool that can be used to modify set membership
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: The name of the context
"""
pass
def AddBlendShape(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorCutClips(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def selectPriority(*args, allComponents: Union[int, bool]=0, allObjects: Union[int, bool]=0,
animBreakdown: Union[int, bool]=0, animCurve: Union[int, bool]=0,
animInTangent: Union[int, bool]=0, animKeyframe: Union[int, bool]=0,
animOutTangent: Union[int, bool]=0, byName: Union[List[AnyStr, bool],
List[List[AnyStr, bool]]]=None, camera: Union[int, bool]=0, cluster:
Union[int, bool]=0, collisionModel: Union[int, bool]=0, controlVertex:
Union[int, bool]=0, curve: Union[int, bool]=0, curveKnot: Union[int, bool]=0,
curveOnSurface: Union[int, bool]=0, curveParameterPoint: Union[int, bool]=0,
dimension: Union[int, bool]=0, dynamicConstraint: Union[int, bool]=0, edge:
Union[int, bool]=0, editPoint: Union[int, bool]=0, emitter: Union[int,
bool]=0, facet: Union[int, bool]=0, field: Union[int, bool]=0, fluid:
Union[int, bool]=0, follicle: Union[int, bool]=0, hairSystem: Union[int,
bool]=0, handle: Union[int, bool]=0, hull: Union[int, bool]=0,
ikEndEffector: Union[int, bool]=0, ikHandle: Union[int, bool]=0, imagePlane:
Union[int, bool]=0, implicitGeometry: Union[int, bool]=0, isoparm: Union[int,
bool]=0, joint: Union[int, bool]=0, jointPivot: Union[int, bool]=0, lattice:
Union[int, bool]=0, latticePoint: Union[int, bool]=0, light: Union[int,
bool]=0, localRotationAxis: Union[int, bool]=0, locator: Union[int, bool]=0,
locatorUV: Union[int, bool]=0, locatorXYZ: Union[int, bool]=0, meshUVShell:
Union[int, bool]=0, motionTrailPoint: Union[int, bool]=0,
motionTrailTangent: Union[int, bool]=0, nCloth: Union[int, bool]=0,
nParticle: Union[int, bool]=0, nParticleShape: Union[int, bool]=0, nRigid:
Union[int, bool]=0, nonlinear: Union[int, bool]=0, nurbsCurve: Union[int,
bool]=0, nurbsSurface: Union[int, bool]=0, orientationLocator: Union[int,
bool]=0, particle: Union[int, bool]=0, particleShape: Union[int, bool]=0,
plane: Union[int, bool]=0, polymesh: Union[int, bool]=0, polymeshEdge:
Union[int, bool]=0, polymeshFace: Union[int, bool]=0, polymeshFreeEdge:
Union[int, bool]=0, polymeshUV: Union[int, bool]=0, polymeshVertex:
Union[int, bool]=0, polymeshVtxFace: Union[int, bool]=0, queryByName:
Union[AnyStr, bool]="", rigidBody: Union[int, bool]=0, rigidConstraint:
Union[int, bool]=0, rotatePivot: Union[int, bool]=0, scalePivot: Union[int,
bool]=0, sculpt: Union[int, bool]=0, selectHandle: Union[int, bool]=0,
spring: Union[int, bool]=0, springComponent: Union[int, bool]=0, stroke:
Union[int, bool]=0, subdiv: Union[int, bool]=0, subdivMeshEdge: Union[int,
bool]=0, subdivMeshFace: Union[int, bool]=0, subdivMeshPoint: Union[int,
bool]=0, subdivMeshUV: Union[int, bool]=0, surfaceEdge: Union[int, bool]=0,
surfaceFace: Union[int, bool]=0, surfaceKnot: Union[int, bool]=0,
surfaceParameterPoint: Union[int, bool]=0, surfaceRange: Union[int, bool]=0,
texture: Union[int, bool]=0, vertex: Union[int, bool]=0, q=True, query=True,
**kwargs)->Union[int, Any]:
"""
The selectPriority command is used to change the selection priority of particular types of
objects that can be selected when using the select tool It accepts no other arguments
besides the flags These flags are the same as used by the 'selectType' command
:param allComponents: (C Q) Set all component selection priority
:param allObjects: (C Q) Set all object selection priority
:param animBreakdown: (C Q) Set animation breakdown selection priority
:param animCurve: (C Q) Set animation curve selection priority
:param animInTangent: (C Q) Set animation in-tangent selection priority
:param animKeyframe: (C Q) Set animation keyframe selection priority
:param animOutTangent: (C Q) Set animation out-tangent selection priority
:param byName: (C M) Set selection priority for the specified user-defined selection type
:param camera: (C Q) Set camera selection priority
:param cluster: (C Q) Set cluster selection priority
:param collisionModel: (C Q) Set collision model selection priority
:param controlVertex: (C Q) Set control vertex selection priority
:param curve: (C Q) Set curve selection priority
:param curveKnot: (C Q) Set curve knot selection priority
:param curveOnSurface: (C Q) Set curve-on-surface selection priority
:param curveParameterPoint: (C Q) Set curve parameter point selection priority
:param dimension: (C Q) Set dimension shape selection priority
:param dynamicConstraint: (C Q) Set dynamicConstraint selection priority
:param edge: (C Q) Set mesh edge selection priority
:param editPoint: (C Q) Set edit-point selection priority
:param emitter: (C Q) Set emitter selection priority
:param facet: (C Q) Set mesh face selection priority
:param field: (C Q) Set field selection priority
:param fluid: (C Q) Set fluid selection priority
:param follicle: (C Q) Set follicle selection priority
:param hairSystem: (C Q) Set hairSystem selection priority
:param handle: (C Q) Set object handle selection priority
:param hull: (C Q) Set hull selection priority
:param ikEndEffector: (C Q) Set ik end effector selection priority
:param ikHandle: (C Q) Set ik handle selection priority
:param imagePlane: (C Q) Set image plane selection mask priority
:param implicitGeometry: (C Q) Set implicit geometry selection priority
:param isoparm: (C Q) Set surface iso-parm selection priority
:param joint: (C Q) Set ik handle selection priority
:param jointPivot: (C Q) Set joint pivot selection priority
:param lattice: (C Q) Set lattice selection priority
:param latticePoint: (C Q) Set lattice point selection priority
:param light: (C Q) Set light selection priority
:param localRotationAxis: (C Q) Set local rotation axis selection priority
:param locator: (C Q) Set locator (all types) selection priority
:param locatorUV: (C Q) Set uv locator selection priority
:param locatorXYZ: (C Q) Set xyz locator selection priority
:param meshUVShell: (C Q) Set uv shell component mask on/off
:param motionTrailPoint: (C Q) Set motion point selection priority
:param motionTrailTangent: (C Q) Set motion point tangent priority
:param nCloth: (C Q) Set nCloth selection priority
:param nParticle: (C Q) Set nParticle point selection priority
:param nParticleShape: (C Q) Set nParticle shape selection priority
:param nRigid: (C Q) Set nRigid selection priority
:param nonlinear: (C Q) Set nonlinear selection priority
:param nurbsCurve: (C Q) Set nurbs-curve selection priority
:param nurbsSurface: (C Q) Set nurbs-surface selection priority
:param orientationLocator: (C Q) Set orientation locator selection priority
:param particle: (C Q) Set particle point selection priority
:param particleShape: (C Q) Set particle shape selection priority
:param plane: (C Q) Set sketch plane selection priority
:param polymesh: (C Q) Set poly-mesh selection priority
:param polymeshEdge: (C Q) Set poly-mesh edge selection priority
:param polymeshFace: (C Q) Set poly-mesh face selection priority
:param polymeshFreeEdge: (C Q) Set poly-mesh free-edge selection priority
:param polymeshUV: (C Q) Set poly-mesh UV point selection priority
:param polymeshVertex: (C Q) Set poly-mesh vertex selection priority
:param polymeshVtxFace: (C Q) Set poly-mesh vtxFace selection priority
:param queryByName: (Q) Query selection priority for the specified user-defined selection
type In query mode, this flag needs a value
:param rigidBody: (C Q) Set rigid body selection priority
:param rigidConstraint: (C Q) Set rigid constraint selection priority
:param rotatePivot: (C Q) Set rotate pivot selection priority
:param scalePivot: (C Q) Set scale pivot selection priority
:param sculpt: (C Q) Set sculpt selection priority
:param selectHandle: (C Q) Set select handle selection priority
:param spring: (C Q) Set spring shape selection priority
:param springComponent: (C Q) Set individual spring selection priority
:param stroke: (C Q) Set stroke selection priority
:param subdiv: (C Q) Set subdivision surface selection priority
:param subdivMeshEdge: (C Q) Set subdivision surface mesh edge selection priority
:param subdivMeshFace: (C Q) Set subdivision surface mesh face selection priority
:param subdivMeshPoint: (C Q) Set subdivision surface mesh point selection priority
:param subdivMeshUV: (C Q) Set subdivision surface mesh UV map selection priority
:param surfaceEdge: (C Q) Set surface edge selection priority
:param surfaceFace: (C Q) Set surface face selection priority
:param surfaceKnot: (C Q) Set surface knot selection priority
:param surfaceParameterPoint: (C Q) Set surface parameter point selection priority
:param surfaceRange: (C Q) Set surface range selection priority
:param texture: (C Q) Set texture selection priority
:param vertex: (C Q) Set mesh vertex selection priority
:returns: if a query operation
"""
pass
def ExportProxyContainerOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TogglePolyCount(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgCreateDescriptionEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def arnoldUpdateTx(*args, **kwargs)->None:
"""
"""
pass
def hudSlider(*args, allowOverlap: bool=True, block: Union[int, bool]=0, blockAlignment:
Union[AnyStr, bool]="", blockSize: Union[AnyStr, bool]="", decimalPrecision:
Union[int, bool]=0, dragCommand: Union[Script, bool]=None, internalPadding:
Union[int, bool]=0, label: Union[AnyStr, bool]="", labelFontSize: Union[AnyStr,
bool]="", labelWidth: Union[int, bool]=0, maxValue: Union[float, bool]=0.0,
minValue: Union[float, bool]=0.0, padding: Union[int, bool]=0, pressCommand:
Union[Script, bool]=None, releaseCommand: Union[Script, bool]=None, section:
Union[int, bool]=0, sliderIncrement: Union[float, bool]=0.0, sliderLength:
Union[int, bool]=0, type: Union[AnyStr, bool]="", value: Union[float, bool]=0.0,
valueAlignment: Union[AnyStr, bool]="", valueFontSize: Union[AnyStr, bool]="",
valueWidth: Union[int, bool]=0, visible: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[int, Any]:
"""
This command creates a Heads-up Display (HUD) slider control which is placed in a 2D
inactive overlay plane on the 3D viewport It is to be used to provide hands-on interaction
designated by a user script The HUD slider is derived from a generic HUD object and thus
inherits a similar workflow Although this command provides much of the same funct
:param allowOverlap: (C Q E) Sets the Heads-Up Display to be visible regardless of
overlapping section widths/limitations (see -s/section flag description for more details)
:param block: (C Q E) Denotes the individual block that the HUD will reside in, within a
section Each section is composed of a single column of blocks The total number o
:param blockAlignment: (C Q E) Specifies the alignment of the block within its respective
column Available alignments are: "center", "left" and "right" The default alignment is "
:param blockSize: (C Q E) Sets the height of each block Available heights are: small,
medium and large In pixel measurements, each corresponds to a 20, 35 or 50 pixel height
:param decimalPrecision: (C Q E) Sets the decimal precision of any floating point value
returned by the command The valid range of precision values are 1 to 8
:param dragCommand: (C Q E) Specifies the procedure or script to run during a mouse drag
event
:param internalPadding: (C Q E) Specifies the amount of padding between the internal
elements of the HUD For the hudSlider, this represents the padding between the slider bar
and t
:param label: (C Q E) Text label of the HUD
:param labelFontSize: (C Q E) Sets the font size of the label Available sizes are: small
and large
:param labelWidth: (C Q E) Specifies the pixel width of the virtual "textbox" which will
hold the label The contents of this "textbox" will be left justified If the width of
:param maxValue: (C Q E) Specify the maximum value of the slider Note: Although this flag
takes in a FLOAT as an argument, if the HUD type is "int", the value will be automa
:param minValue: (C Q E) Specify the minimum value of the slider Note: Although this flag
takes in a FLOAT as an argument, if the HUD type is "int", the value will be automa
:param padding: (C Q E) Specifies the width of both the left and right margins of a block
Default value is 15 pixels
:param pressCommand: (C Q E) Specifies the procedure or script to run during a mouse click
event
:param releaseCommand: (C Q E) Specifies the procedure or script to run during a mouse
release event
:param section: (C Q E) Defines the section the HUD will appear in There are 10 sections
divided across the screen Five columns and two rows make up the ten element matrix
:param sliderIncrement: (C Q E) Specify the number of increments along the slider If not
specified or set to 0 or less, the slider will be linearly even and continuous from
minValu
:param sliderLength: (C Q E) Specifies the length of the slider in pixels
:param type: (C Q E) Specify the numeric type of the HUD Available types are: "float" and
"int"
:param value: (C Q E) Set/Return the slider value if the HUD is a valid HUD slider Note:
Although this flag takes in a FLOAT as an argument, if the HUD type is "int", the
:param valueAlignment: (C Q E) Specifies the alignment of the data blocks and the data text,
within a HUD block Available alignments are: "left" and "right" The default alignment
:param valueFontSize: (C Q E) Sets the font size of the slider value Available sizes are:
small and large
:param valueWidth: (C Q E) Specifies the pixel width of the virtual "textbox" which will
hold the slider value (To see a layout of a block, see the description of the -block f
:param visible: (C Q E) Sets the visibility of the Heads-Up Display on and off
:returns: ID number of the Heads-Up Display (HUD).
"""
pass
def SaveHIKCharacterDefinition(*args, **kwargs)->None:
"""
"""
pass
def CustomNURBSSmoothnessOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def STRSTweakModeToggle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def bifrost(*args, **kwargs)->None:
"""
"""
pass
def Bevel(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmPlaceBrushContext(*args, **kwargs)->None:
"""
"""
pass
def TesselateSubdivSurfaceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def timeEditorComposition(*args, active: bool=True, allCompositions: bool=True, createTrack:
bool=True, delete: bool=True, duplicateFrom: AnyStr="", rename:
List[AnyStr, AnyStr]=None, tracksNode: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Commands related to composition management inside Time Editor
:param active: (Q E) Query or edit the active composition
:param allCompositions: (Q) Return all compositions inside Time Editor
:param createTrack: (C) Create a default track when creating a new composition
:param delete: (Q E) Delete the composition
:param duplicateFrom: (C) Duplicate the composition
:param rename: (E) Rename the composition of the first name to the second name
:param tracksNode: (Q) Query the tracks node of a composition
:returns: Return values currently not documented.
"""
pass
def PruneSmallWeightsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypergraphHierarchyWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshAmplifyTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AlignSurfacesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def graphEditor(*args, **kwargs)->None:
"""
unknown
"""
pass
def dR_convertSelectionToVertex(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorCopyClips(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshFreezeToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshFlattenToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def savePrefs(*args, colors: bool=True, general: bool=True, hotkeys: bool=True, menuSets:
bool=True, plugins: bool=True, uiLayout: bool=True, **kwargs)->None:
"""
This command saves preferences to disk If no flags are specified then all pref types get
saved out
:param colors: (C) Save the color prefs to disk
:param general: (C) Save the general prefs to disk (optionVars)
:param hotkeys: (C) Save the hotkeys to disk
:param menuSets: (C) Save the menuSet preferences to disk
:param plugins: (C) Save the plug-in prefs to disk
:param uiLayout: (C) Save each window's size and position to disk
:returns:
"""
pass
def NodeEditorGraphAddSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowUIElements(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nucleusDisplayDynamicConstraintNodes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModifyStampDepthRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteEntireHairSystem(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OffsetEdgeLoopToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisableIKSolvers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ScaleTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sculptTarget(*args, after: bool=True, afterReference: bool=True, before: bool=True,
deformerTools: bool=True, exclusive: AnyStr="", frontOfChain: bool=True,
geometry: Union[AnyStr, List[AnyStr]]="", geometryIndices: bool=True,
ignoreSelected: bool=True, inbetweenWeight: float=0.0,
includeHiddenSelections: bool=False, name: AnyStr="", parallel: bool=True,
prune: bool=True, regenerate: bool=True, remove: Union[bool, List[bool]]=True,
snapshot: int=0, split: bool=True, target: int=0, e=True, edit=True,
**kwargs)->None:
"""
This command is used to specify the blend shape target to be modified by the sculpting
tools and transform manipulators
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param deformerTools: () Returns the name of the deformer tool objects (if any) as string
string ..
:param exclusive: (C) Puts the deformation set in a deform partition
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: () Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param inbetweenWeight: (E) Specifies the in between target weight of the blend shape node
that will be made editable by the sculpting and transform tools
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param name: (C) Used to specify the name of the node being created
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param regenerate: (E) When this flag is specified a new shape is created for the specified
blend shape target, if the shape does not already exist The name of the new sha
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param snapshot: (E) This flag should only be used internally to add in-between target
When this flag is specified a snapshot of the shape will be taken for the specifie
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:param target: (E) Specifies the target index of the blend shape node that will be made
editable by the sculpting and transform tools
:returns:
"""
pass
def xgmGroomConvert(*args, **kwargs)->None:
"""
"""
pass
def DisplayWireframe(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PanelPreferencesWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MinimizeApplication(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def timeCode(*args, mayaStartFrame: Union[float, bool]=0.0, productionStartFrame: Union[float,
bool]=0.0, productionStartHour: Union[float, bool]=0.0, productionStartMinute:
Union[float, bool]=0.0, productionStartSecond: Union[float, bool]=0.0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[time, Any]:
"""
Use this command to query and set the time code information in the file
:param mayaStartFrame: (C Q E) Sets the Maya start time of the time code, in frames In
query mode, returns the Maya start frame of the time code
:param productionStartFrame: (C Q E) Sets the production start time of the time code, in
terms of frames In query mode, returns the sub-second frame of production start time
:param productionStartHour: (C Q E) Sets the production start time of the time code, in
terms of hours In query mode, returns the hour of production start time
:param productionStartMinute: (C Q E) Sets the production start time of the time code, in
terms of minutes In query mode, returns the minute of production start time
:param productionStartSecond: (C Q E) Sets the production start time of the time code, in
terms of seconds In query mode, returns the second of production start time
:returns: values
"""
pass
def lassoContext(*args, drawClosed: bool=True, exists: bool=True, history: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Creates a context to perform selection via a "lasso" Use for irregular selection regions,
where the "marquee-style" select of the "selectContext" is inappropriate
:param drawClosed: (C Q E) Turns the closed display of the lasso on/off
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Name of the context created
"""
pass
def setMenuMode(*args, **kwargs)->AnyStr:
"""
Optionally sets a new Menu Mode for the menu bar in the main Maya window Returns the
current Menu Mode, and if a new one is specified, then the previous Menu Mode is returned
Note that due to recent changes to the menu set architecture (8.0+), this function now
takes a menu set as a parameter instead of a label
:returns: The current Menu Mode for the menu bar in the main Maya window.
"""
pass
def PolyMergeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowManipulators(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def play(*args, forward: bool=True, playSound: bool=True, record: bool=True, sound:
Union[AnyStr, bool]="", state: bool=True, wait: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command starts and stops playback In order to change the frame range of playback, see
the playbackOptions command
:param forward: (C Q) When true, play back the animation from the currentTime to the
maximum of the playback range When false, play back from the currentTime to the minim
:param playSound: (C Q) Specify whether or not sound should be used during playback
:param record: (C Q) enable the recording system and start one playback loop
:param sound: (C Q) Specify the sound node to be used during playback
:param state: (C Q) start or stop playing back
:param wait: (C) Wait till completion before returning control to command Window
:returns:
"""
pass
def SelectToggleMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hotkeyEditorPanel(*args, annotation: Union[AnyStr, bool]="", backgroundColor:
Union[List[float, float, float], bool]=None, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float,
float, float], bool]=None, isObscured: bool=True, manage: bool=True,
noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
A hotkeyEditor creates a new hotkey editor in the current layout The hotkey editor lets
you assign predefined commands, MEL scripts, or marking menus to keys and key combinations
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the editor.
"""
pass
def getPanel(*args, allConfigs: bool=True, allPanels: bool=True, allScriptedTypes: bool=True,
allTypes: bool=True, atPosition: List[int, int]=None, configWithLabel: AnyStr="",
containing: AnyStr="", invisiblePanels: bool=True, scriptType: AnyStr="", type:
AnyStr="", typeOf: AnyStr="", underPointer: bool=True, visiblePanels: bool=True,
withFocus: bool=True, withLabel: AnyStr="", **kwargs)->List[AnyStr]:
"""
This command returns panel and panel configuration information
:param allConfigs: (C) Return the names of the all panel configuration in a string array
:param allPanels: (C) Return the names of all the panels in a string array
:param allScriptedTypes: (C) Return the names of all types of scripted panels in a string
array
:param allTypes: (C) Return the names of all types of panels, except scripted types in a
string array
:param atPosition: (C) Return the name of the panel which contains the specified screen
coordinates An empty string is returned if there is no panel at those coordinates
:param configWithLabel: (C) Return the name of the panel configuration with the specified
label text
:param containing: (C) Return the name of the panel containing the specified control An
empty string is returned if the specified control is not in any panel
:param invisiblePanels: (C) Return the names of all the invisible panels in a string array
:param scriptType: (C) Return the names of all scripted panels of the specified type in a
string array
:param type: (C) Return the names of all panels of the specified type in a string array
:param typeOf: (C) Return the type of the specified panel
:param underPointer: (C) Return the name of the panel that the pointer is currently over
An empty string is returned if the pointer is not over any panel
:param visiblePanels: (C) Return the names of all the visible panels in a string array
:param withFocus: (C) Return the name of the panel that currently has focus If no panel
has focus then the last panel that had focus is returned
:param withLabel: (C) Return the name of the panel with the specified label text
:returns: An array of panel names
"""
pass
def polyBridgeEdge(*args, bridgeOffset: Union[int, bool]=0, caching: bool=True,
constructionHistory: bool=True, curveType: Union[int, bool]=0, divisions:
Union[int, bool]=1, inputCurve: name=None, name: AnyStr="", nodeState:
Union[int, bool]=0, smoothingAngle: Union[float, bool]=0.0, startVert1:
Union[int, bool]=1, startVert2: Union[int, bool]=1, taper: Union[float,
bool]=1.0, taperCurve_FloatValue: Union[float, bool]=0.0, taperCurve_Interp:
Union[int, bool]=0, taperCurve_Position: Union[float, bool]=0.0, twist:
Union[float, bool]=0.0, worldSpace: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Bridges two sets of edges
:param bridgeOffset: (C Q E) Add offset to which vertices are connected Default: 0
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param curveType: (C Q E) Format: 0 - Linear, 1 - Blend, 2 - Curve Default:
TdnpolyBridgeEdge::Linear
:param divisions: (C Q E) The number of subdivisions in the bridging faces (resulting in
(divisions+1) row of faces) Default: 1
:param inputCurve: (C) This flag specifies the name of the curve to be used as input for
the operation
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param smoothingAngle: (C Q E) Angle below which new edges will be smoothed Default:
kPi/6.0
:param startVert1: (C Q E) The start vertex from the first set of edges Default: -1
:param startVert2: (C Q E) The start vertex from the second set of edges Default: -1
:param taper: (C Q E) Taper or Scale along the extrusion path Default: 1.0
:param taperCurve_FloatValue: (C Q E) Value for taperCurve; Curve control for taper along
extrusion Using this curve, the taper along extrusion can be changed from a simple linear
scaling
:param taperCurve_Interp: (C Q E) Interpolation type for taperCurve; Curve control for
taper along extrusion Using this curve, the taper along extrusion can be changed from a
simple l
:param taperCurve_Position: (C Q E) Position for taperCurve; Curve control for taper along
extrusion Using this curve, the taper along extrusion can be changed from a simple linear
scal
:param twist: (C Q E) Twist or Rotation along the extrusion path Default: 0.0
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def PolyExtrudeVerticesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVGatherShells(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorToggleShowNamespace(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nClothDeleteCacheOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AssignBrushToHairSystem(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_cycleCustomCameras(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def view2dToolCtx(*args, alternateContext: bool=True, boxzoom: bool=True, dolly: bool=True,
exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name:
AnyStr="", toolName: Union[AnyStr, bool]="", track: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This class creates a context for the View Tools "track", "dolly", and "box zoom" in the
Hypergraph
:param alternateContext: (C Q) Set the ALT+MMB and ALT+SHIFT+MMB to refer to this context
:param boxzoom: (C Q) Perform Box Zoom
:param dolly: (C Q) Dollies the view
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param toolName: (C Q) Name of the specific tool to which this command refers
:param track: (C Q) Tracks the view
:returns: The context name
"""
pass
def hasMetadata(*args, asList: bool=True, ignoreDefault: bool=True, memberName: AnyStr="",
channelName: Union[AnyStr, bool]="", channelType: Union[AnyStr, bool]="",
endIndex: AnyStr="", index: Union[AnyStr, List[AnyStr], bool]="", indexType:
Union[AnyStr, bool]="", scene: bool=True, startIndex: AnyStr="", streamName:
Union[AnyStr, bool]="", **kwargs)->List[AnyStr]:
"""
This command is used to query for the presence of metadata elements on a node, components,
or scene The command works at all levels of metadata presence, from the existence of any
metadata at all on a node or scene right down to the presence of metadata values set on a
particular metadata Stream index Filter Flags channelName - Only look for meta
:param asList: (C) Use this flag when you want to return string values indicating where the
metadata lives rather than boolean values See the command description for m
:param ignoreDefault: (C) Use this flag when you want to skip over any metadata that has
only default values i.e the metadata may exist but it hasn't had a new value set yet
:param memberName: (C) Name of the Structure member being checked The names of the members
are set up in the Structure definition, either through the description passed in
:param channelName: (C Q) Filter the metadata selection to only recognize metadata
belonging to the specified named Channel (e.g "vertex") This flag is ignored if the
compon
:param channelType: (C Q) Obsolete - use the 'channelName' flag instead In query mode,
this flag can accept a value
:param endIndex: (C) The metadata is stored in a Stream, which is an indexed list If you
have mesh components selected then the metadata indices are implicit in the list
:param index: (C Q M) In the typical case metadata is indexed using a simple integer value
Certain types of data may use other index types e.g a "vertexFace" component
:param indexType: (C Q) Name of the index type the new Channel should be using If not
specified this defaults to a simple integer index Of the native types only a mesh "ve
:param scene: (C Q) Use this flag when you want to add metadata to the scene as a whole
rather than to any individual nodes If you use this flag and have nodes selected
:param startIndex: (C) The metadata is stored in a Stream, which is an indexed list If you
have mesh components selected then the metadata indices are implicit in the list
:param streamName: (C Q) Name of the metadata Stream Depending on context it could be the
name of a Stream to be created, or the name of the Stream to pass through the filte
:returns: List of indexes in the filtered list which contain metadata
"""
pass
def scriptJob(*args, allChildren: bool=True, attributeAdded: List[AnyStr, Script]=None,
attributeChange: List[AnyStr, Script]=None, attributeDeleted: List[AnyStr,
Script]=None, compressUndo: bool=True, conditionChange: List[AnyStr, Script]=None,
conditionFalse: List[AnyStr, Script]=None, conditionTrue: List[AnyStr,
Script]=None, connectionChange: List[AnyStr, Script]=None, disregardIndex:
bool=True, event: List[AnyStr, Script]=None, exists: int=0, force: bool=True,
idleEvent: Script=None, kill: Union[int, List[int]]=0, killAll: bool=True,
killWithScene: bool=True, listConditions: bool=True, listEvents: bool=True,
listJobs: bool=True, nodeDeleted: List[AnyStr, Script]=None, nodeNameChanged:
List[AnyStr, Script]=None, optionVarChanged: List[AnyStr, Script]=None, parent:
AnyStr="", permanent: bool=True, protected: bool=True, replacePrevious: bool=True,
runOnce: bool=True, timeChange: Script=None, uiDeleted: List[AnyStr, Script]=None,
**kwargs)->int:
"""
This command creates a "script job", which is a MEL command or script This job is attached
to the named condition, event, or attribute Each time the condition switches to the
desired state (or the trigger is triggered, etc), the script is run Script jobs are tied
to the event loop in the interactive application They are run during idle events
:param allChildren: (C) This flag can only be used in conjunction with the
-ac/attributeChange flag If it is specified, and the job is attached to a compound
attribute, the
:param attributeAdded: (C) Run the script when the named attribute is added The string
must identify both the dependency node and the particular attribute If the dependency n
:param attributeChange: (C) Run the script when the named attribute changes value The
string must identify both the dependency node and the particular attribute If the depende
:param attributeDeleted: (C) Run the script when the named attribute is deleted The string
must identify both the dependency node and the particular attribute If the dependency
:param compressUndo: (C) If this is set to true, and the scriptJob is undoable, then its
action will be bundled with the last user action for undo purposes For example; if t
:param conditionChange: (C) Run the script when the named condition changes state The
string must be the name of a pre-defined, or a user-defined boolean condition To get a li
:param conditionFalse: (C) Run the script when the named condition becomes false The
string must be the name of a pre-defined, or a user-defined boolean condition To get a li
:param conditionTrue: (C) Run the script when the named condition becomes true The string
must be the name of a pre-defined, or a user-defined boolean condition To get a lis
:param connectionChange: (C) Run the script when the named attribute changes its
connectivity The string must identify both the dependency node and the particular
attribute If
:param disregardIndex: (C) This flag can only be used in conjunction with the
-ac/attributeChange flag If it is specified, and the job is attached to a multi (indexed)
attribu
:param event: (C) Run the script when the named event occurs This string must be the name
of a pre-defined maya event To get a list of what events exist, use the -li
:param exists: (C) Returns true if a scriptJob with the specified "job number" exists, and
false otherwise The "job number" should be a value that was returned on crea
:param force: (C) This flag can only be used with -kill, -killAll, or -replacePrevious It
enables the deletion of protected jobs
:param idleEvent: (C) Run the script every time maya is idle WARNING, as long as an idle
event is is registered, the application will keep calling it and will use up all
:param kill: (C M) Kills the job with the specified job number Permanent jobs cannot be
killed, however, and protected jobs can only be killed if the -force flag is us
:param killAll: (C) Kills all jobs Permanent jobs will not be deleted, and protected jobs
will only be deleted if the -force flag is used
:param killWithScene: (C) Attaches the job to the current scene, and when the scene is
emptied The current scene is emptied by opening a new or existing scene
:param listConditions: (C) User Interface for Rendering
:param listEvents: (C) This causes the command to return a string array containing the
names of all existing events Below is the descriptions for all the existing events:
:param listJobs: (C) This causes the command to return a string array containing a
description of all existing jobs, along with their job numbers These numbers can be us
:param nodeDeleted: (C) Run the script when the named node is deleted
:param nodeNameChanged: (C) Run the script when the name of the named node changes
:param optionVarChanged: (C) Run the script when the named optionVar changes value If the
optioNVar is deleted, this job is killed (even if the deletion is undoable)
:param parent: (C) Attaches this job to a piece of maya UI When the UI is destroyed, the
job will be killed along with it
:param permanent: (C) Makes the job un-killable Permanent jobs exist for the life of the
application, or for the life of their parent object The -killWithScene flag does
:param protected: (C) Makes the job harder to kill Protected jobs must be killed or
replaced intentionally by using the -force flag The -killWithScene flag does apply to
:param replacePrevious: (C) This flag can only be used with the -parent flag Before the
new scriptJob is created, any existing scriptJobs that have the same parent are first de
:param runOnce: (C) If this is set to true, the script will only be run a single time If
false (the default) the script will run every time the triggering condition/eve
:param timeChange: (C) Run the script whenever the current time changes The script will
not be executed if the time is changed by clicking on the time slider, whereas scri
:param uiDeleted: (C) Run the script when the named piece of UI is deleted
:returns: The job number, which can be used to kill the job. The job
number will be a value
greater than or equal to zero
"""
pass
def XgmSetDirectionBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeDeleteAllLights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideDeformingGeometry(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def checkBox(*args, align: Union[AnyStr, bool]="", annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, changeCommand:
Union[Script, bool]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None, editable:
bool=True, enable: bool=True, enableBackground: bool=True, enableKeyboardFocus:
bool=True, exists: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured: bool=True,
label: Union[AnyStr, bool]="", manage: bool=True, noBackground: bool=True,
numberOfPopupMenus: bool=True, offCommand: Union[Script, bool]=None, onCommand:
Union[Script, bool]=None, parent: Union[AnyStr, bool]="", popupMenuArray:
bool=True, preventOverride: bool=True, recomputeSize: bool=True, statusBarMessage:
AnyStr="", useTemplate: AnyStr="", value: bool=True, visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a check box A check box is a simple control containing a text label
and a state of either on or off Commands can be attached to any or all of the following
events: when the check box is turned on, turned off, or simply when it's state is changed
:param align: (C Q E) This flag is obsolete and should no longer be used The check box
label will always be left-aligned
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C Q E) Command executed when the check box's state is changed Note
that this flag should not be used in conjunction with onCommand and offCommand That is,
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editable: (C Q E) The edit state of the check box By default, this flag is set to
true and the check box value may be changed by clicking on it If false then the che
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) The label text The default label is the name of the control
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param offCommand: (C Q E) Command executed when the check box is turned off
:param onCommand: (C Q E) Command executed when the check box is turned on
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param recomputeSize: (C Q E) If true then the control will recompute it's size to just fit
the size of the label If false then the control size will remain fixed as you change t
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) State of the check box
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def FBXImportAxisConversionEnable(*args, **kwargs)->None:
"""
"""
pass
def blindDataType(*args, dataType: Union[AnyStr, List[AnyStr]]="", longDataName: Union[AnyStr,
List[AnyStr]]="", longNames: bool=True, query: bool=True, shortDataName:
Union[AnyStr, List[AnyStr]]="", shortNames: bool=True, typeId: int=0,
typeNames: bool=True, **kwargs)->AnyStr:
"""
This command creates a blind data type, which is represented by a blindDataTemplate node in
the DG A blind data type can have one or more attributes On the command line, the
attributes should be ordered by type for best memory utilization, largest first: string,
binary, double, float, int, and finally boolean Once a blind data type is created, b
:param dataType: (C M) Specifies the dataTypes that are part of BlindData node being
created Allowable strings are "int", "float", "double", "string", "boolean" and "binar
:param longDataName: (C M) Specifies the long names of the datas that are part of BlindData
node being created Must be used togeter with the -dt and -sdn flags to specify each
:param longNames: (C) Specifies that for a query command the long attributes names be
listed
:param query: (C) Specifies that this is a special query type command
:param shortDataName: (C M) Specifies the short names of the data that are part of
BlindData node being created Must be used togeter with the -dt and -ldn flags to specify
each
:param shortNames: (C) Specifies that for a query command the short attribute names be
listed
:param typeId: (C) Specifies the typeId of the BlindData type being created
:param typeNames: (C) Specifies that for a query command the data types be listed
:returns: Name of nodes created
"""
pass
def FilletBlendToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SmoothingDisplayToggle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleFBIKEffectorsTranslatePinState(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artBaseCtx(*args, **kwargs)->None:
"""
"""
pass
def Quadrangulate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def psdTextureFile(*args, channelRGB: Union[List[AnyStr, int, int, int, int], List[List[AnyStr,
int, int, int, int]]]=None, channels: Union[List[AnyStr, int, bool],
List[List[AnyStr, int, bool]]]=None, imageFileName: Union[List[AnyStr,
AnyStr, int], List[List[AnyStr, AnyStr, int]]]=None, psdFileName: AnyStr="",
snapShotImageName: AnyStr="", uvSnapPostionTop: bool=True, xResolution:
int=0, yResolution: int=0, **kwargs)->None:
"""
Creates a Photoshop file with UVSnap shot image and the layer set names as the input
:param channelRGB: (C M) (M) Layer set names, index, red, green and blue values are given
as input Using this flag, the layers created can be filled with specified colors T
:param channels: (C M) (M) Layer set names and index are given as input This is a multi
use flag A layer set with the given name will be created The second argument is t
:param imageFileName: (C M) Image file name, Layerset name and index The image in the file
will be transferred to layer set specified The index specifies the placement order o
:param psdFileName: (C) PSD file name
:param snapShotImageName: (C) Image file name on the disk containing UV snapshot /
reference image
:param uvSnapPostionTop: (C) Specifies the position of UV snapshot image layer in the PSD
file "True" positions this layer at the top and "False" positions the layer at the bott
:param xResolution: (C) X - resolution of the image
:param yResolution: (C) Y - resolution of the image
:returns:
"""
pass
def paintPointsCmd(*args, **kwargs)->None:
"""
"""
pass
def ToggleHoleFaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmExportSplineDataInternal(*args, **kwargs)->None:
"""
"""
pass
def DeactivateGlobalScreenSlider(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def doBlur(*args, colorFile: AnyStr="", length: float=0.0, memCapSize: float=0.0, sharpness:
float=0.0, smooth: float=0.0, smoothColor: bool=True, vectorFile: AnyStr="",
**kwargs)->AnyStr:
"""
The doBlur command will invoke the blur2d, which is a Maya stand-alone application to do
2.5 motion blur given the color image and the motion vector file For a given input
colorFile name, e.g "xxx.iff", the output blurred image will be "xxx_blur.iff" in the same
directory as the input colorFile There is currently no control over the name of the
:param colorFile: (C) Name of the input color image to be blurred
:param length: (C) Scale applied on the motion vector Ranges from 0 to infinity
:param memCapSize: (C) Size of the memory cap, in bytes
:param sharpness: (C) Determines the shape of the blur filter The higher the value, the
narrower the filter, the sharper the blur The lower the value, the wider the filt
:param smooth: (C) Filter size to smooth the blurred image The higher the value, the more
anti-aliased the alpha channel Ranges from 1.0 to 5.0
:param smoothColor: (C) Whether to smooth the color or not
:param vectorFile: (C) Name of the input motion vector file
:returns: Command result
"""
pass
def PlanarOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def blend(*args, **kwargs)->None:
"""
"""
pass
def GoToBindPose(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_SetEngine(*args, **kwargs)->None:
"""
"""
pass
def TimeEditorClipRazor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def applyMetadata(*args, format: AnyStr="", scene: bool=True, value: AnyStr="",
**kwargs)->bool:
"""
Define the values of a particular set of metadata on selected objects This command is used
in preservation of metadata through Maya file formats (.ma/.mb) If any metadata already
exists it will be kept and merged with the new metadata, overwriting duplicate entries
(i.e if this command specifies data at index N and you already have a value at i
:param format: (C) Name of the data association format type to use in the value flag
parsing Default value is "raw"
:param scene: (C) Use this flag when you want to apply metadata to the scene as a whole
rather than to any individual nodes If you use this flag and have nodes select
:param value: (C) String containing all of the metadata to be assigned to the selected
object
:returns: True if the application succeeded
"""
pass
def HypershadePickWalkDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideHairSystems(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PlayblastWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ViewAlongAxisY(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideKinematics(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowIKHandles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshRelaxToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PublishAttributes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def autoSave(*args, destination: Union[int, bool]=0, destinationFolder: bool=True, enable:
bool=True, folder: Union[AnyStr, bool]="", interval: Union[float, bool]=0.0,
limitBackups: bool=True, maxBackups: Union[int, bool]=0, perform: bool=True,
prompt: bool=True, q=True, query=True, **kwargs)->Union[None, Any]:
"""
Provides an interface to the auto-save mechanism
:param destination: (C Q) Sets the option for where auto-save files go 0 - auto-saves go
into the workspace autosave folder 1 - auto-saves go into the named folder (set with
:param destinationFolder: (Q) Queries the actual destination folder for auto-saves, based
on the current setting of the -destination flag, workspace rules and environment variable
:param enable: (C Q) Enables or disables auto-saves
:param folder: (C Q) Sets the folder for auto-saves used if the destination option is 1
:param interval: (C Q) Sets the interval between auto-saves (in seconds) The default
interval is 600 seconds (10 minutes)
:param limitBackups: (C Q) Sets whether the number of auto-save files is limited
:param maxBackups: (C Q) Sets the maximum number of auto-save files, if limiting is in
effect
:param perform: (C) Invokes the auto-save process
:param prompt: (C Q) Sets whether the auto-save prompts the user before auto-saving
:returns:
"""
pass
def ToggleToolMessage(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToolSettingsWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySelectConstraint(*args, angle: Union[int, bool]=0, anglePropagation: bool=True,
angleTolerance: Union[float, bool]=0.0, anglebound: Union[List[float,
float], bool]=None, border: bool=True, borderPropagation: bool=True,
convexity: Union[int, bool]=0, crease: bool=True, disable: bool=True,
dist: Union[int, bool]=0, distaxis: Union[List[float, float, float],
bool]=None, distbound: Union[List[float, float], bool]=None,
distpoint: Union[List[float, float, float], bool]=None, edgeDistance:
int=0, geometricarea: Union[int, bool]=0, geometricareabound:
Union[List[float, float], bool]=None, holes: Union[int, bool]=0,
length: Union[int, bool]=0, lengthbound: Union[List[float, float],
bool]=None, loopPropagation: bool=True, max2dAngle: float=0.0,
max3dAngle: float=0.0, mode: Union[int, bool]=0, nonmanifold:
Union[int, bool]=0, oppositeEdges: bool=True, order: Union[int,
bool]=0, orderbound: Union[List[int, int], bool]=None, orient:
Union[int, bool]=0, orientaxis: Union[List[float, float, float],
bool]=None, orientbound: Union[List[float, float], bool]=None,
planarity: Union[int, bool]=0, propagate: Union[int, bool]=0, random:
Union[int, bool]=0, randomratio: Union[float, bool]=0.0,
returnSelection: bool=True, ringPropagation: bool=True, shell:
bool=True, size: Union[int, bool]=0, smoothness: Union[int, bool]=0,
stateString: bool=True, textured: Union[int, bool]=0, texturedarea:
Union[int, bool]=0, texturedareabound: Union[List[float, float],
bool]=None, textureshared: Union[int, bool]=0, topology: Union[int,
bool]=0, type: Union[int, bool]=0, uvBorderSelection: bool=True,
uvConstraint: bool=True, uvEdgeLoopPropagation: bool=True,
uvEdgeRingPropagation: bool=True, uvFaceOrientation: Union[int,
bool]=0, uvShell: bool=True, visibility: Union[int, bool]=0,
visibilityangle: Union[float, bool]=0.0, visibilitypoint:
Union[List[float, float, float], bool]=None, where: Union[int, bool]=0,
wholeSensitive: bool=True, q=True, query=True, **kwargs)->Union[None,
Any]:
"""
Changes the global polygonal selection constraints
:param angle: (C Q) 0(off) 1(on)
:param anglePropagation: (C Q) If true, selection will be extended to all connected
components whose normal is close to any of the normals of the original selection (see
angleToler
:param angleTolerance: (C Q) When angle propagation is turned on, this controls what is the
maximum difference of the normal vectors where the selection propagates
:param anglebound: (C Q) min and max angles The given value should be in the current units
that Maya is using See the examples for how to check the current unit For vertic
:param border: (C Q) Use "-uvConstraint true" to edit/query UV view constraint If true,
selection will be extended to all connected border components so that the whole "
:param borderPropagation: (C Q) If true, selection will be extended to all connected border
components so that the whole "loop" is selected
:param convexity: (C Q) 0(off) 1(concave) 2(convex)
:param crease: (C Q) If true, selection will be extended to all connected creased
components
:param disable: (C) Toggles off all constraints for all component types, but leaves the
other constraint parameters This flag may be used together with other ones toggl
:param dist: (C Q) 0(off) 1(to point) 2(to axis) 3(to plane)
:param distaxis: (C Q) axis (Normal to the plane in case of distance to plane)
:param distbound: (C Q) min and max distances
:param distpoint: (C Q) point (Axis/plane origin in case of distance to axis/plane)
:param edgeDistance: (C) Maximum distance (number of edges) to extend the edge selection
for "Contiguous Edges" propagate mode 0 means to ignore the distance constraint
:param geometricarea: (C Q) 0(off) 1(on)
:param geometricareabound: (C Q) min and max areas
:param holes: (C Q) 0(off) 1(holed) 2(non holed)
:param length: (C Q) 0(off) 1(on)
:param lengthbound: (C Q) min and max lengths
:param loopPropagation: (C Q) If true, edge selection will be extended to a loop
:param max2dAngle: (C) Maximum angle between two consecutive edges in the 2d tangent plane
for "Contiguous Edges" propagate mode
:param max3dAngle: (C) Maximum angle between two consecutive edges in 3d space for
"Contiguous Edges" propagate mode
:param mode: (C Q) 0(Off) 1(Next) 2(Current and Next) 3(All and Next) Off : no constraints
are used at all Next : constraints will be used to filter next selections
:param nonmanifold: (C Q) 0(off) 1(on)
:param oppositeEdges: (C) Use the opposite edges
:param order: (C Q) 0(off) 1(on)
:param orderbound: (C Q) min and max orders number of owning edges
:param orient: (C Q) 0(off) 1(orientation) 2(direction)
:param orientaxis: (C Q) axis
:param orientbound: (C Q) min and max angles The given value should be in the current
units that Maya is using See the examples for how to check the current unit
:param planarity: (C Q) 0(off) 1(non planar) 2(planar)
:param propagate: (C Q) 0(Off) 1(More) 2(Less) 3(Border) 4(Contiguous Edges) 5(Grow Along
Loop) 6(Shrink Along Loop) More : will add current selection border to current sel
:param random: (C Q) 0(off) 1(on)
:param randomratio: (C Q) ratio [0,1]
:param returnSelection: (C) If true, current selection will not be modified, instead the
new selection will be returned as result
:param ringPropagation: (C Q) If true, edge selection will be extended to a ring
:param shell: (C Q) If true, selection will be extended to all connected components so that
the whole piece of object is selected
:param size: (C Q) 0(off) 1(triangles) 2(quads) 3(nsided)
:param smoothness: (C Q) 0(off) 1(hard) 2(smooth)
:param stateString: (Q) Query only flag Returns the MEL command that would restore all the
current settings
:param textured: (C Q) 0(off) 1(mapped) 2(unmapped)
:param texturedarea: (C Q) 0(off) 1(Area specified is unsigned) 2(Area specified is
signed)
:param texturedareabound: (C Q) min and max areas
:param textureshared: (C Q) 0(off) 1(on) This option will select any UVs on the currentMap
which are shared by more than one vertex
:param topology: (C Q) 0(off) 1(non triangulatable) 2(lamina) 3(non triangulatable and
lamina)
:param type: (C Q) 0x0000(none) 0x0001(vertex) 0x8000(edge) 0x0008(face) 0x0010(texture
coordinates)
:param uvBorderSelection: (C Q) This flag only works on UV view If true, selection will be
extended to all UV border components It also removes all components not on UV border from
:param uvConstraint: (C) If true, applicable constraint flags will work on UV view In
query mode, this flag can accept a value
:param uvEdgeLoopPropagation: (C Q) Use "-uvConstraint true" to edit/query UV view
constraint If true, UV edge selection will be extended to a loop
:param uvEdgeRingPropagation: (C Q) This flag only works on UV view If true, UV edge
selection will be extended to a ring
:param uvFaceOrientation: (C Q) This flag only works on UV view 0(Off) 1(Front Face) 2(Back
Face)
:param uvShell: (C Q) If true, selection will be extended to all connected components in UV
space
:param visibility: (C Q) 0(off) 1(on)
:param visibilityangle: (C Q) angle [0,360]
:param visibilitypoint: (C Q) point
:param where: (C Q) 0(off) 1(on border) 2(inside)
:param wholeSensitive: (C Q) Tells how to select faces : either by picking anywhere inside
the face (if true) or by picking on the face center marker (if false)
:returns:
"""
pass
def CreateSubdivCylinder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorCreateClip(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SubdCutUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createNurbsSphereCtx(*args, **kwargs)->None:
"""
"""
pass
def RemoveBifrostEmitter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideStrokes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BakeCustomPivot(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TextureCentricUVLinkingEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyCone(*args, axis: Union[List[float, float, float], bool]=None, caching: bool=True,
constructionHistory: bool=True, createUVs: Union[int, bool]=2, height: Union[float,
bool]=2.0, name: AnyStr="", nodeState: Union[int, bool]=0, object: bool=True,
radius: Union[float, bool]=1.0, roundCap: bool=False, subdivisionsAxis: Union[int,
bool]=20, subdivisionsCap: Union[int, bool]=0, subdivisionsHeight: Union[int,
bool]=1, subdivisionsX: Union[int, bool]=20, subdivisionsY: Union[int, bool]=1,
subdivisionsZ: Union[int, bool]=0, texture: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The cone command creates a new polygonal cone
:param axis: (C Q E) This flag specifies the primitive axis used to build the cone Q: When
queried, this flag returns a float[3]
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createUVs: (C Q E) Create UVs or not 0: No UVs 1: No Normalization 2: Normalize 3:
Normalize and Preserve Aspect Ratio Default: 2
:param height: (C Q E) Height of the cone Default: 2.0
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node (where applicable)
:param radius: (C Q E) Radius of the cone Default: 1.0
:param roundCap: (C Q E) To indicate whether we need a round cap Default: false
:param subdivisionsAxis: (C Q E) Subdivisions around the axis Default: 20
:param subdivisionsCap: (C Q E) Subdivisions on the bottom cap Default: 0
:param subdivisionsHeight: (C Q E) Subdivisions along the height Default: 1
:param subdivisionsX: (C Q E) This specifies the number of subdivisions in the X direction
for the cone C: Default is 20 Q: When queried, this flag returns an int
:param subdivisionsY: (C Q E) This flag specifies the number of subdivisions in the Y
direction for the cone C: Default is 1 Q: When queried, this flag returns an int
:param subdivisionsZ: (C Q E) This flag specifies the number of subdivisions in the Z
direction for the cone C: Default is 0 Q: When queried, this flag returns an int
:param texture: (C Q E) Apply texture or not Default: true
:returns: Object name and node name.
"""
pass
def HypershadeHideAttributes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShortPolygonNormals(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportGenerateLog(*args, **kwargs)->None:
"""
"""
pass
def CreateDiskCacheOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PasteKeysOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModelingPanelRedoViewChange(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def IKSplineHandleToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RenameCurrentColorSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleFkSkeletonVisibility(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TagAsController(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PruneCluster(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xform(*args, absolute: bool=True, boundingBox: bool=True, boundingBoxInvisible: bool=True,
centerPivots: bool=True, centerPivotsOnComponents: bool=True, deletePriorHistory:
bool=True, euler: bool=True, matrix: Union[List[float, float, float, float, float,
float, float, float, float, float, float, float, float, float, float, float],
bool]=None, objectSpace: bool=True, pivots: Union[List[float, float, float],
bool]=None, preserve: bool=True, preserveUV: bool=False, reflection: bool=True,
reflectionAboutBBox: bool=True, reflectionAboutOrigin: bool=True, reflectionAboutX:
bool=True, reflectionAboutY: bool=True, reflectionAboutZ: bool=True,
reflectionTolerance: float=0.0, relative: bool=True, rotateAxis: Union[List[float,
float, float], bool]=None, rotateOrder: Union[AnyStr, bool]="", rotatePivot:
Union[List[float, float, float], bool]=None, rotateTranslation: Union[List[float,
float, float], bool]=None, rotation: Union[List[float, float, float], bool]=None,
scale: Union[List[float, float, float], bool]=None, scalePivot: Union[List[float,
float, float], bool]=None, scaleTranslation: Union[List[float, float, float],
bool]=None, shear: Union[List[float, float, float], bool]=None, translation:
Union[List[float, float, float], bool]=None, worldSpace: bool=True,
worldSpaceDistance: bool=True, zeroTransformPivots: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command can be used query/set any element in a transformation node It can also be
used to query some values that cannot be set directly such as the transformation matrix or
the bounding box It can also set both pivot points to convenient values All values are
specified in transformation coordinates (attribute-space) In addition, the attr
:param absolute: (C) perform absolute transformation (default)
:param boundingBox: (Q) Returns the bounding box of an object The values returned are in
the following order: xmin ymin zmin xmax ymax zmax
:param boundingBoxInvisible: (Q) Returns the bounding box of an object This includes the
bounding boxes of all invisible children which are not included using the boundingBox flag
:param centerPivots: (C) Set pivot points to the center of the object's bounding box (see
-p flag)
:param centerPivotsOnComponents: (C) Set pivot points to the center of the component's
bounding box (see -p flag)
:param deletePriorHistory: (C) If true then delete the construction history before the
operation is performed
:param euler: (C) modifer for -relative flag that specifies rotation values should be added
to current XYZ rotation values
:param matrix: (C Q) Sets/returns the composite transformation matrix *Note* the matrix is
represented by 16 double arguments that are specified in row order
:param objectSpace: (C Q) treat values as object-space transformation values (only works
for pivots, translations, rotation, rotation axis, matrix, and bounding box flags)
:param pivots: (C Q) convenience method that changes both the rotate and scale pivots
simultaneously (see -rp -sp flags for more info)
:param preserve: (C) preserve overall transformation used to prevent object from "jumping"
when changing pivots or rotation order the default value is true (used with
:param preserveUV: (C) When true, UV values on rotated components are projected across the
rotation in 3d space For small edits, this will freeze the world space texture m
:param reflection: (C) To move the corresponding symmetric components also
:param reflectionAboutBBox: (C) Sets the position of the reflection axis at the geometry
bounding box
:param reflectionAboutOrigin: (C) Sets the position of the reflection axis at the origin
:param reflectionAboutX: (C) Specifies the X=0 as reflection plane
:param reflectionAboutY: (C) Specifies the Y=0 as reflection plane
:param reflectionAboutZ: (C) Specifies the Z=0 as reflection plane
:param reflectionTolerance: (C) Specifies the tolerance to findout the corresponding
reflected components
:param relative: (C) perform relative transformation
:param rotateAxis: (C Q) rotation axis orientation (when used with the -p flag the overall
rotation is preserved by modifying the rotation to compensate for the axis rotation
:param rotateOrder: (C Q) rotation order (when used with the -p flag the overall rotation
is preserved by modifying the local rotation to be quivalent to the old one) Valid va
:param rotatePivot: (C Q) rotate pivot point transformation (when used with the -p flag the
overall transformation is preserved by modifying the rotation translation)
:param rotateTranslation: (C Q) rotation translation
:param rotation: (C Q) rotation transformation
:param scale: (C Q) scale transformation
:param scalePivot: (C Q) scale pivot point transformation (when used with the -p flag the
overall transformation is preserved by modifying the scale translation)
:param scaleTranslation: (C Q) scale translation
:param shear: (C Q) shear transformation The values represent the shear <xy,xz,yz>
:param translation: (C Q) translation
:param worldSpace: (C Q) (works for pivots, translations, rotation, rotation axis, matrix,
and bounding box flags) Note that, when querying the scale, that this calculation
:param worldSpaceDistance: (C Q) Values for -sp, -rp, -st, -rt, -t, -piv flags are treated
as world space distances to move along the local axis (where the local axis depends on
whe
:param zeroTransformPivots: (C) reset pivot points and pivot translations without changing
the overall matrix by applying these values into the translation channel
:returns:
"""
pass
def dynParticleCtx(*args, conserve: Union[float, bool]=0.0, cursorPlacement: bool=True, exists:
bool=True, grid: bool=True, gridSpacing: Union[float, bool]=0.0, history:
bool=True, image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="",
image3: Union[AnyStr, bool]="", jitterRadius: Union[float, bool]=0.0,
lowerLeftX: Union[float, bool]=0.0, lowerLeftY: Union[float, bool]=0.0,
lowerLeftZ: Union[float, bool]=0.0, name: AnyStr="", nucleus: bool=True,
numJitters: Union[int, bool]=0, particleName: Union[AnyStr, bool]="",
sketch: bool=True, sketchInterval: Union[int, bool]=0, textPlacement:
bool=True, upperRightX: Union[float, bool]=0.0, upperRightY: Union[float,
bool]=0.0, upperZ: Union[float, bool]=0.0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
The particle context command creates a particle context The particle context provides an
interactive means to create particle objects The particle context command also provides an
interactive means to set the option values, through the Tool Property Sheet, for the
"particle" command that the context will issue
:param conserve: (Q E) Conservation of momentum control (between 0 and 1) For smaller
values, the field will tend to erase any existing velocity the object has (in other w
:param cursorPlacement: (Q E) Use the cursor to place the lower left and upper right of the
grid
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param grid: (Q E) Create a particle grid
:param gridSpacing: (Q E) Spacing between particles in the grid
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param jitterRadius: (Q E) Max radius from the center to place the particle instances
:param lowerLeftX: (Q E) Lower left X position of the particle grid
:param lowerLeftY: (Q E) Lower left Y position of the particle grid
:param lowerLeftZ: (Q E) Lower left Z position of the particle grid
:param name: (C) If this is a tool command, name the tool appropriately
:param nucleus: (Q E) If set true then an nParticle is generated with a nucleus node
connection Otherwise a standard particle is created
:param numJitters: (Q E) Number of jitters (instances) per particle
:param particleName: (Q E) Particle name
:param sketch: (Q E) Create particles in sketch mode
:param sketchInterval: (Q E) Interval between particles, when in sketch mode
:param textPlacement: (Q E) Use the textfields to specify the lower left and upper right
of/ the grid
:param upperRightX: (Q E) Upper right X position of the particle grid
:param upperRightY: (Q E) Upper right Y position of the particle grid
:param upperZ: (Q E) Upper right Z position of the particle grid
:returns:
"""
pass
def DeleteAllContainers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CutKeysOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyMapSew(*args, caching: bool=True, constructionHistory: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Sew border edges in texture space Selected edges must be map borders
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def SurfaceEditingTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ClearBifrostInitialState(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_symmetryTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySpinEdge(*args, **kwargs)->None:
"""
"""
pass
def detachSurface(*args, caching: bool=True, direction: Union[int, bool]=1, keep: Union[bool,
List[bool]]=True, nodeState: Union[int, bool]=0, parameter: Union[float,
List[float], bool]=0.0, constructionHistory: bool=True, name: AnyStr="",
object: bool=True, replaceOriginal: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The detachSurface command detaches a surface into pieces, given a list of parameter values
and a direction You can also specify which pieces to keep and which to discard using the
"-k" flag The names of the newly detached surface(s) are returned If history is on, the
name of the resulting dependency node is also returned You can only detach in
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param direction: (C Q E) Direction in which to detach: 0 - V direction, 1 - U direction
Default: 1
:param keep: (C Q E M) Keep the detached pieces Default: true
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param parameter: (C Q E M) Parameter at which to detach Default: 0.0
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def filletCurve(*args, bias: Union[float, bool]=0.0, blendControl: bool=False, caching:
bool=True, circular: bool=True, curveParameter1: Union[float, bool]=0.0,
curveParameter2: Union[float, bool]=0.0, depth: Union[float, bool]=0.5,
freeformBlend: bool=False, nodeState: Union[int, bool]=0, radius: Union[float,
bool]=1.0, constructionHistory: bool=True, join: bool=True, name: AnyStr="",
object: bool=True, replaceOriginal: bool=True, trim: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The curve fillet command creates a fillet curve between two curves If no objects are
specified in the command line, then the first two active curves are used The fillet
created can be circular (with a radius) or freeform (with a type of tangent or blend)
:param bias: (C Q E) Adjusting the bias value causes the fillet curve to be skewed to one
of the input curves Available only if blendControl is true Default: 0.0
:param blendControl: (C Q E) If true then depth and bias can be controlled Otherwise,
depth and bias are not available options Default: false
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param circular: (C Q E) Curve fillet will be created as circular if true or freeform if
false Default: true
:param curveParameter1: (C Q E) Parameter where fillet curve will contact the primary input
curve Default: 0.0
:param curveParameter2: (C Q E) Parameter where fillet curve will contact the secondary
input curve Default: 0.0
:param depth: (C Q E) Adjusts the depth of the fillet curve Available only if blendControl
is true Default: 0.5
:param freeformBlend: (C Q E) The freeform type is blend if true or tangent if false
Available if the fillet type is freeform Default: false
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param radius: (C Q E) The radius if creating a circular fillet Default: 1.0
:param constructionHistory: (C) Turn the construction history on or off
:param join: (C) Should the fillet be joined?
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:param trim: (C) Should the fillet be trimmed?
:returns: Object name and node name
"""
pass
def referenceQuery(*args, child: bool=True, isExportEdits: bool=True, isLoaded: bool=True,
liveEdits: bool=True, dagPath: bool=True, editAttrs: bool=True, editNodes:
bool=True, editStrings: bool=True, failedEdits: bool=True, filename:
bool=True, isNodeReferenced: bool=True, isPreviewOnly: bool=True, namespace:
bool=True, nodes: bool=True, parent: bool=True, parentNamespace: bool=True,
referenceNode: bool=True, shortName: bool=True, showDagPath: bool=True,
showNamespace: bool=True, successfulEdits: bool=True, topReference:
bool=True, unresolvedName: bool=True, withoutCopyNumber: bool=True,
editCommand: Union[AnyStr, List[AnyStr], bool]="", onReferenceNode:
Union[AnyStr, List[AnyStr], bool]="", **kwargs)->List[AnyStr]:
"""
Use this command to find out information about references and referenced nodes A valid
target is either a reference node, a reference file, or a referenced node Some flags don't
require a target, see flag descriptions for more information on what effect this has When
a scene contains multiple levels of file references, those edits which affect a
:param child: (C) This flag modifies the '-rfn/-referenceNode' and '-f/-filename' flags to
indicate the the children of the target reference will be returned Returns
:param isExportEdits: (C) Returns a boolean indicating whether the specified reference node
or file name is an edits file (created with the Export Edits feature)
:param isLoaded: (C) Returns a boolean indicating whether the specified reference node or
file name refers to a loaded or unloaded reference
:param liveEdits: (C) Specifies that the edits should be returned based on the live edits
database Only valid when used in conjunction with the editStrings flag
:param dagPath: (C) This flag modifies the '-n/-nodes' flag to indicate that the names of
any dag objects returned will include as much of the dag path as is necessary t
:param editAttrs: (C) Returns string array A main flag used to query the edits that have
been applied to the target Only the names of the attributes involved in the refe
:param editNodes: (C) Returns string array A main flag used to query the edits that have
been applied to the target Only the names of the nodes involved in the reference
:param editStrings: (C) Returns string array A main flag used to query the edits that have
been applied to the target The edit will be returned as a valid MEL command A v
:param failedEdits: (C) This is a secondary flag used to indicate whether or not failed
edits should be acted on (e.g queried, removed, etc...) A failed edit is an edit wh
:param filename: (C) Returns string A main flag used to query the filename associated with
the target reference
:param isNodeReferenced: (C) Returns boolean A main flag used to determine whether or not
the target node comes from a referenced file true if the target node comes from a refe
:param isPreviewOnly: (C) Returns boolean This flag is used to determine whether or not
the target reference node is only a preview reference node
:param namespace: (C) Returns string This flag returns the full namespace path of the
target reference, starting from the root namespace ":" It can be combined with the
:param nodes: (C) Returns string array A main flag used to query the contents of the
target reference
:param parent: (C) This flag modifies the '-rfn/-referenceNode' and '-f/-filename' flags to
indicate the the parent of the target reference will be returned
:param parentNamespace: (C) A main flag used to query and return the parent namespace of
the target reference
:param referenceNode: (C) Returns string A main flag used to query the reference node
associated with the target reference
:param shortName: (C) This flag modifies the '-f/-filename' and '-ns/-namespace' flags
Used with the '-f/-filename' flag indicates that the file name returned will be the
:param showDagPath: (C) Shows/hides the full dag path for edits If false only displays the
node-name of reference edits Must be used with the -editNodes, -editStrings or -
:param showNamespace: (C) Shows/hides the namespaces on nodes in the reference edits Must
be used with the -editNodes, -editStrings or -editAttrs flag
:param successfulEdits: (C) This is a secondary flag used to indicate whether or not
successful edits should be acted on (e.g queried, removed, etc...) A successful edit is
an
:param topReference: (C) This flag modifies the '-rfn/-referenceNode' flag to indicate the
top level ancestral reference of the target reference will be returned
:param unresolvedName: (C) This flag modifies the '-f/-filename' flag to indicate that the
file name returned will be unresolved (i.e it will be the path originally specified
:param withoutCopyNumber: (C) This flag modifies the '-f/-filename' flag to indicate that
the file name returned will not have a copy number (e.g '{1}') appended to the end If t
:param editCommand: (C Q M) This is a secondary flag used to indicate which type of
reference edits should be considered by the command If this flag is not specified all edit
t
:param onReferenceNode: (C Q M) This is a secondary flag used to indicate that only those
edits which are stored on the indicated reference node should be considered This flag
only
:returns: For query execution.
"""
pass
def autoPlace(*args, useMouse: bool=True, **kwargs)->List[float]:
"""
This command takes a point in the centre of the current modeling pane and projects it onto
the live surface This produces a point in 3 space which is returned If the um/useMouse
flag is set the current mouse position is used rather than the centre of the modeling pane
:param useMouse: (C) Use the current mouse position rather than the centre of the active
view
:returns: Placement location in 3D space
"""
pass
def Triangulate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteHairCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def truncateFluidCache(*args, q=True, query=True, e=True, edit=True, **kwargs)->Union[None,
Any]:
"""
This command sets the end time of a fluid cache to the current time If the current time is
less than the end time of the cache, the cache is truncated so that only the portion of the
cache up to and including the current time is preserved
:returns:
"""
pass
def adskAssetList(*args, **kwargs)->None:
"""
"""
pass
def UpdateBindingSetOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nClothMergeCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectUVBorderComponents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeToggleNodeTitleMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideSmoothSkinInfluences(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_GetEngine(*args, **kwargs)->None:
"""
"""
pass
def Help(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def listAnimatable(*args, active: bool=True, manip: bool=True, manipHandle: bool=True, shape:
bool=True, type: bool=True, **kwargs)->List[AnyStr]:
"""
This command list the animatable attributes of a node Command flags allow filtering by the
current manipulator, or node type
:param active: (C) This flag is obsolete and no longer supported
:param manip: (C) Return only those attributes affected by the current manip If there is
no manip active and any other flags are specified, output is the same as if t
:param manipHandle: (C) Return only those attributes affected by the current manip handle
If there is no manip handle active and any other flags are specified, output is th
:param shape: (C) This flag is obsolete and no longer supported
:param type: (C) Instead of returning attributes, Return the types of nodes that are
currently animatable
:returns: All animatable attributes found
"""
pass
def ConnectComponents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def blendTwoAttr(*args, attribute: Union[AnyStr, List[AnyStr]]="", attribute0: Union[name,
bool]=None, attribute1: Union[name, bool]=None, blender: Union[name,
bool]=None, controlPoints: bool=False, driver: Union[int, bool]=0, name:
Union[AnyStr, bool]="", shape: bool=True, time: timerange=None, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
A blendTwoAttr nodes takes two inputs, and blends the values of the inputs from one to the
other, into an output value The blending of the two inputs uses a blending function, and
the following formula:
:param attribute: (C M) A list of attributes for the selected nodes for which a
blendTwoAttr node will be created In query mode, this flag needs a value
:param attribute0: (C Q E) The attribute that should be connected to the first input of the
new blendTwoAttr node When queried, it returns a string
:param attribute1: (C Q E) The attribute that should be connected to the second input of
the new blendTwoAttr node When queried, it returns a string
:param blender: (C Q E) The blender attribute This is the attribute that will be connected
to the newly created blendTwoAttr node(s) blender attribute This attribute contr
:param controlPoints: (C) Explicitly specify whether or not to include the control points
of a shape (see "-s" flag) in the list of attributes Default: false
:param driver: (C Q E) The index of the driver attribute for this blend node (0 or 1) When
queried, it returns an integer
:param name: (C Q) name for the new blend node(s)
:param shape: (C) Consider all attributes of shapes below transforms as well, except
"controlPoints" Default: true
:param time: (C) The time range between which the blending between the 2 attributes should
occur If a single time is specified, then the blend will cause an abrupt c
:returns: The names of the blendTwoAttr dependency nodes that were created.
"""
pass
def gpuCache(*args, **kwargs)->None:
"""
"""
pass
def CreateHairCacheOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyCreateFacetCtx(*args, append: bool=True, exists: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
maximumNumberOfPoints: Union[int, bool]=0, planarConstraint: bool=True,
subdivision: Union[int, bool]=1, texture: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Create a new context to create polygonal objects
:param append: (C Q E) Allows to switch to polyAppendFacetCtx tool
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param maximumNumberOfPoints: (C Q E) Allows the ability to set a upper bound on the number
of points in interactively place before polygon is created A value less than 2 will mean
that
:param planarConstraint: (C Q E) allows/avoid new facet to be non-planar If on, all new
points will be projected onto current facet plane
:param subdivision: (C Q E) Number of subdivisions for each edge Default: 1
:param texture: (C Q E) What texture mechanism to be applied 0=No textures, 1=Normalized,
Undistorted textures 2=Unitized textures Default: 0
:returns:
"""
pass
def getAttr(*args, asString: bool=True, caching: bool=True, channelBox: bool=True,
expandEnvironmentVariables: bool=True, keyable: bool=True, lock: bool=True,
multiIndices: bool=True, settable: bool=True, silent: bool=True, size: bool=True,
time: time=None, type: bool=True, **kwargs)->Any:
"""
This command returns the value of the named object's attribute UI units are used where
applicable Currently, the types of attributes that can be displayed are: numeric
attributes string attributes matrix attributes numeric compound attributes (whose children
are all numeric) vector array attributes double array attributes int32 array attributes
:param asString: (C) This flag is only valid for enum attributes It allows you to get the
attribute values as strings instead of integer values Note that the returned s
:param caching: (C) Returns whether the attribute is set to be cached internally
:param channelBox: (C) Returns whether the attribute is set to show in the channelBox
Keyable attributes also show in the channel box
:param expandEnvironmentVariables: (C) Expand any environment variable and (tilde
characters on UNIX) found in string attributes which are returned
:param keyable: (C) Returns the keyable state of the attribute
:param lock: (C) Returns the lock state of the attribute
:param multiIndices: (C) If the attribute is a multi, this will return a list containing
all of the valid indices for the attribute
:param settable: (C) Returns 1 if this attribute is currently settable by setAttr, 0
otherwise An attribute is settable if it's not locked and either not connected, or h
:param silent: (C) When evaluating an attribute that is not a numeric or string value,
suppress the error message saying that the data cannot be displayed The attribut
:param size: (C) Returns the size of a multi-attribute array Returns 1 if non-multi
:param time: (C) Evaluate the attribute at the given time instead of the current time
:param type: (C) Returns the type of data currently in the attribute Attributes of simple
types such as strings and numerics always contain data, but attributes of c
:returns: Value or state of the attribute. The number and type
of values returned is
dependent on the attribute type.
"""
pass
def PolySpinEdgeForward(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LevelOfDetailUngroup(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleLatticeShape(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BakeSimulation(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GlobalDiskCacheControl(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def IKHandleToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def unknownPlugin(*args, dataTypes: bool=True, list: bool=True, nodeTypes: bool=True, remove:
bool=True, version: bool=True, q=True, query=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
Allows querying of the unknown plug-ins used by the scene, and provides a means to remove
them
:param dataTypes: (Q) Returns the data types associated with the given unknown plug-in
This will always be empty for pre-Maya 2014 files
:param list: (Q) Lists the unknown plug-ins in the scene
:param nodeTypes: (Q) Returns the node types associated with the given unknown plug-in
This will always be empty for pre-Maya 2014 files
:param remove: (C) Removes the given unknown plug-in from the scene For Maya 2014 files
and onwards, this will fail if node or data types defined by the plug-in are st
:param version: (Q) Returns the version string of the given unknown plug-in
:returns: in query mode
"""
pass
def ShowGeometry(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InsertKeysToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def arnoldAIR(*args, **kwargs)->None:
"""
"""
pass
def MoveUp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def optionMenu(*args, alwaysCallChangeCommand: bool=True, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, beforeShowPopup:
Script=None, changeCommand: Script=None, defineTemplate: AnyStr="", docTag:
Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback: Script=None,
enable: bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
exists: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, itemListLong: bool=True, itemListShort: bool=True, label:
Union[AnyStr, bool]="", manage: bool=True, maxVisibleItems: Union[int, bool]=0,
noBackground: bool=True, numberOfItems: bool=True, numberOfPopupMenus: bool=True,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, select: Union[int, bool]=0, statusBarMessage: AnyStr="", useTemplate:
AnyStr="", value: Union[AnyStr, bool]="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a popup menu control The command creates the control and provides its
menu Subsequent calls to the menuItem command will place them in the popup Note that
commands attached to menu items will not get called Attach any commands via the
-cc/changedCommand flag
:param alwaysCallChangeCommand: (C Q) Toggle whether to always call the change command,
regardless of the change
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param beforeShowPopup: (C E) Callback that is called just before we show the drop down
menu
:param changeCommand: (C E) Adds a callback that is called when a new item is selected The
MEL script will have the newly selected item's value substituted for #1 For Python,
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param itemListLong: (Q) The long names of the menu items
:param itemListShort: (Q) The short names of the menu items
:param label: (C Q E) The optional label text to the left of the popup menu
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxVisibleItems: (C Q E) The maximum number of items that are visible in the popup
menu If the popup contains more items than this, a scrollbar is added automatically
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfItems: (Q) The number of menu items
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param select: (C Q E) The current menu item The argument and return value is 1-based
Note that the current menu item can only be set if it is enabled
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) The text of the current menu item
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def ConformPolygon(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyOptions(*args, activeObjects: bool=True, allEdges: bool=True, backCullVertex: bool=True,
backCulling: bool=True, colorMaterialChannel: Union[AnyStr, bool]="",
colorShadedDisplay: bool=True, displayAlphaAsGreyScale: bool=True,
displayBorder: bool=True, displayCenter: bool=True, displayCreaseEdge:
bool=True, displayCreaseVertex: bool=True, displayGeometry: bool=True,
displayInvisibleFaces: bool=True, displayItemNumbers: List[bool, bool, bool,
bool]=None, displayMapBorder: bool=True, displayMetadata: List[bool, bool,
bool]=None, displayNormal: bool=True, displaySubdComps: bool=True,
displayTangent: bool=True, displayTriangle: bool=True, displayUVTopology:
bool=True, displayUVs: bool=True, displayVertex: bool=True, displayWarp:
bool=True, facet: bool=True, fullBack: bool=True, gl: bool=True, hardBack:
bool=True, hardEdge: bool=True, hardEdgeColor: bool=True, materialBlend:
Union[AnyStr, bool]="", newPolymesh: bool=True, point: bool=True, pointFacet:
bool=True, relative: bool=True, reuseTriangles: bool=True, sizeBorder:
Union[float, bool]=0.0, sizeNormal: Union[float, bool]=0.0, sizeUV: Union[float,
bool]=0.0, sizeVertex: Union[float, bool]=0.0, smoothDrawType: Union[int,
bool]=0, softEdge: bool=True, vertexNormalMethod: Union[int, bool]=0,
wireBackCulling: bool=True, q=True, query=True, **kwargs)->Union[None, Any]:
"""
Changes the global display polygonal attributes
:param activeObjects: (C Q) Apply user choices for all active objects
:param allEdges: (C Q) Display all edges in solid line
:param backCullVertex: (C Q) BackCull vertices
:param backCulling: (C Q) Display with no back culling
:param colorMaterialChannel: (C Q) If colorShadedDisplay is true, then determines which
material channel to display color per vertex in The options are: "none" : disable material
shad
:param colorShadedDisplay: (C Q) Use color per vertex display in shaded mode
:param displayAlphaAsGreyScale: (C Q) Display alpha as grey scale
:param displayBorder: (C Q) Highlight border edge
:param displayCenter: (C Q) Display facet centers
:param displayCreaseEdge: (C Q) Highlight creased edges
:param displayCreaseVertex: (C Q) Highlight creased vertices
:param displayGeometry: (C Q) Display geometry
:param displayInvisibleFaces: (C Q) Highlight invisible faces
:param displayItemNumbers: (C Q) Displays item numbers (vertices edges facets uvs)
:param displayMapBorder: (C Q) Highlight map border edge
:param displayMetadata: (C Q) Displays component metadata (vertices edges facets
vertexFaces)
:param displayNormal: (C Q) Display normals
:param displaySubdComps: (C Q) Display subdivided components when in Smooth Mesh Preview
mode
:param displayTangent: (C Q) Display tangent
:param displayTriangle: (C Q) Display triangulation
:param displayUVTopology: (C Q) Option on UV display to display UVs topologically
:param displayUVs: (C Q) Display UVs
:param displayVertex: (C Q) Display vertices
:param displayWarp: (C Q) Highlight warped facets
:param facet: (C Q) For use with -dn flag Set the normal display style to facet display
:param fullBack: (C Q) Display with full back culling
:param gl: (C Q) Apply user choices for all objects
:param hardBack: (C Q) Backculled hard edges only for backculled faces
:param hardEdge: (C Q) Display only hard edges
:param hardEdgeColor: (C Q) Display hard edges as separate color
:param materialBlend: (C Q) The options are: "overwrite" "add" "subtract" "multiply"
"divide" "average" "modulate2x"
:param newPolymesh: (C Q) Set component display state of new polymesh objects
:param point: (C Q) For use with -dn flag Set the normal display style to vertex display
:param pointFacet: (C Q) For use with -dn flag Set the normal display style to vertex and
face display
:param relative: (C Q) When this flag is used with flags dealing with size, the value
(size) is a multiplication factor : i.e for flags : -sizeNormal, -sizeBorder When thi
:param reuseTriangles: (C Q) Avoid regenerating triangles, by reusing the old triangles
upstream in the construction history The construction history is searched upstream and do
:param sizeBorder: (C Q) Set the size of the polygonal border edges
:param sizeNormal: (C Q) Set the size of the polygonal normals
:param sizeUV: (C Q) Set the size of the polygonal UV
:param sizeVertex: (C Q) Set the size of the polygonal vertex
:param smoothDrawType: (C Q) This setting only works with the newPolymesh flag Sets a new
default attribute value for the smoothDrawType attribute on a polymesh object Options
:param softEdge: (C Q) Display soft edges in dotted lines
:param vertexNormalMethod: (C Q) This setting only works with the newPolymesh flag Sets a
new default attribute value for the vertexNormalMethod attribute on a polymesh object
Opti
:param wireBackCulling: (C Q) Backculled faces are in wireframe
:returns:
"""
pass
def CreateCharacter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TransformNoSelectOnTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MergeVertexToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Create2DContainer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PlaceFullBodyPivot(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HIKLiveConnectionTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def draggerContext(*args, anchorPoint: Union[List[float, float, float], bool]=None, button:
Union[int, bool]=0, currentStep: Union[int, bool]=0, cursor: Union[AnyStr,
bool]="", dragCommand: Union[Script, bool]=None, dragPoint: Union[List[float,
float, float], bool]=None, drawString: AnyStr="", exists: bool=True,
finalize: Union[Script, bool]=None, helpString: Union[AnyStr, bool]="",
history: bool=True, holdCommand: Union[Script, bool]=None, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", initialize: Union[Script, bool]=None, modifier: Union[AnyStr,
bool]="", name: AnyStr="", plane: List[float, float, float]=None,
prePressCommand: Union[Script, bool]=None, pressCommand: Union[Script,
bool]=None, projection: Union[AnyStr, bool]="", releaseCommand: Union[Script,
bool]=None, snapping: bool=True, space: Union[AnyStr, bool]="", stepsCount:
Union[int, bool]=0, undoMode: Union[AnyStr, bool]="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The draggerContext allows the user to program the behavior of the mouse or an equivalent
dragging device in MEL
:param anchorPoint: (Q) Anchor point (double array) where dragger was initially pressed
:param button: (Q) Returns the current mouse button (1,2,3)
:param currentStep: (Q) Current step (press-drag-release sequence) for dragger context
When queried before first press event happened, returns 0
:param cursor: (C Q E) Cursor displayed while context is active Valid values are:
"default", "hand", "crossHair", "dolly", "track", and "tumble"
:param dragCommand: (C Q E) Command called when mouse dragger is dragged
:param dragPoint: (Q) Drag point (double array) current position of dragger during drag
:param drawString: (C E) A string to be drawn at the current position of the pointer
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param finalize: (C Q E) Command called when the tool is exited
:param helpString: (Q) Help string for context
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param holdCommand: (C Q E) Command called when mouse dragger is held
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param initialize: (C Q E) Command called when the tool is entered
:param modifier: (Q) Returns the current modifier type: ctrl, alt or none
:param name: (C) If this is a tool command, name the tool appropriately
:param plane: (C E) Provide normal of projection plane (see -projection flag for details)
:param prePressCommand: (C Q E) Command called when mouse dragger is pressed It is called
before pressCommand, so it can be used for initialization of context
:param pressCommand: (C Q E) Command called when mouse dragger is pressed
:param projection: (C Q E) project to closest point on object bounding box
:param releaseCommand: (C Q E) Command called when mouse dragger is released
:param snapping: (C Q E) Enable/disable snapping for dragger context
:param space: (C Q E) screen space
:param stepsCount: (C Q E) Number of steps (press-drag-release sequences) for dragger
context When combined with undoMode flag, several steps might be recorded as single undo
:param undoMode: (C Q E) Undo queue mode for the context actions Acceptable values are:
"all" default behaviour when every action that happens during dragger context activit
:returns: The name of the context.
"""
pass
def polyChipOff(*args, attraction: Union[float, bool]=0.0, caching: bool=True,
constructionHistory: bool=True, duplicate: bool=True, gain: Union[float,
List[float], bool]=1.0, gravity: Union[List[float, float, float], bool]=None,
gravityX: Union[float, bool]=0.0, gravityY: Union[float, bool]=0.0, gravityZ:
Union[float, bool]=0.0, keepFacesTogether: bool=True, keepFacetTogether:
bool=True, localCenter: Union[int, bool]=0, localDirection: Union[List[float,
float, float], bool]=None, localDirectionX: Union[float, bool]=0.0,
localDirectionY: Union[float, bool]=0.0, localDirectionZ: Union[float,
bool]=0.0, localRotate: Union[List[float, float, float], bool]=None,
localRotateX: Union[float, bool]=0.0, localRotateY: Union[float, bool]=0.0,
localRotateZ: Union[float, bool]=0.0, localScale: Union[List[float, float,
float], bool]=None, localScaleX: Union[float, bool]=0.0, localScaleY:
Union[float, bool]=0.0, localScaleZ: Union[float, bool]=0.0, localTranslate:
Union[List[float, float, float], bool]=None, localTranslateX: Union[float,
bool]=0.0, localTranslateY: Union[float, bool]=0.0, localTranslateZ:
Union[float, bool]=0.0, magnX: Union[float, bool]=0.0, magnY: Union[float,
bool]=0.0, magnZ: Union[float, bool]=0.0, magnet: Union[List[float, float,
float], bool]=None, name: AnyStr="", nodeState: Union[int, bool]=0, offset:
Union[float, bool]=0.0, pivot: Union[List[float, float, float], bool]=None,
pivotX: Union[float, bool]=0.0, pivotY: Union[float, bool]=0.0, pivotZ:
Union[float, bool]=0.0, random: Union[float, bool]=0.0, scale: Union[List[float,
float, float], bool]=None, scaleX: Union[float, bool]=0.0, scaleY: Union[float,
bool]=0.0, scaleZ: Union[float, bool]=0.0, translate: Union[List[float, float,
float], bool]=None, translateX: Union[float, bool]=0.0, translateY: Union[float,
bool]=0.0, translateZ: Union[float, bool]=0.0, weight: Union[float, bool]=0.0,
worldSpace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Extract facets Faces can be extracted separately or together, and manipulations can be
performed either in world or object space
:param attraction: (C Q E) Attraction, related to magnet The range is [-2.0, 2.0]
Default: 0.0
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param duplicate: (C Q E) If "on", facets are duplicated, otherwise original facets are
removed C: Default is "on" Q: When queried, this flag returns an int
:param gain: (C Q E M) Gain factor per component Can be painted using Artisan Default:
1.0
:param gravity: (C Q E) The gravity vector Default: 0.0, -1.0, 0.0
:param gravityX: (C Q E) Gravity X coord
:param gravityY: (C Q E) Gravity Y coord
:param gravityZ: (C Q E) Gravity Z coord
:param keepFacesTogether: (C Q E) How to extrude edges If "on", extruded faces produced
from the edges being extruded will be kept together Otherwise they are pulled
independently
:param keepFacetTogether: (C Q E) How to extrude edges If "on", extruded faces produced
from the edges being extruded will be kept together Otherwise they are pulled
independently
:param localCenter: (C Q E) Local center on the edge : 0=Middle point, 1=Start point, 2=End
point Default: 0
:param localDirection: (C Q E) Direction to determine X axis for local space Default: 1.0,
0.0, 0.0
:param localDirectionX: (C Q E) X coord of the X axis
:param localDirectionY: (C Q E) Y coord of the X axis
:param localDirectionZ: (C Q E) Z coord of the X axis
:param localRotate: (C Q E) The local rotations Default: 0.0, 0.0, 0.0
:param localRotateX: (C Q E) Local rotate X coord The range is [0, 360]
:param localRotateY: (C Q E) Local rotate Y coord The range is [0, 360]
:param localRotateZ: (C Q E) Local rotate Z coord : Rotation along the normal The range is
[0, 360]
:param localScale: (C Q E) Local Scale Default: 1.0, 1.0, 1.0
:param localScaleX: (C Q E) Scale X coord
:param localScaleY: (C Q E) Scale Y coord
:param localScaleZ: (C Q E) Scale Z coord
:param localTranslate: (C Q E) Local translate Default: 0.0, 0.0, 0.0
:param localTranslateX: (C Q E) Local translation X coord
:param localTranslateY: (C Q E) Local translation Y coord
:param localTranslateZ: (C Q E) Local translation Z coord : Move along the normal
:param magnX: (C Q E) Magnet X coord
:param magnY: (C Q E) Magnet Y coord
:param magnZ: (C Q E) Magnet Z coord
:param magnet: (C Q E) The magnet vector Default: 0.0, 0.0, 0.0
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param offset: (C Q E) Local offset Faces are moved this distance towards the inside of
the face Default: 0.0
:param pivot: (C Q E) The pivot for scaling and rotation Default: 0.0, 0.0, 0.0
:param pivotX: (C Q E) Pivot X coord
:param pivotY: (C Q E) Pivot Y coord
:param pivotZ: (C Q E) Pivot Z coord
:param random: (C Q E) Random value for all parameters Default: 0.0
:param scale: (C Q E) Scaling vector Default: 1.0, 1.0, 1.0
:param scaleX: (C Q E) Scale X coord
:param scaleY: (C Q E) Scale Y coord
:param scaleZ: (C Q E) Scale Z coord
:param translate: (C Q E) Translation vector Default: 0.0, 0.0, 0.0
:param translateX: (C Q E) Translation X coord
:param translateY: (C Q E) Translation Y coord
:param translateZ: (C Q E) Translation Z coord
:param weight: (C Q E) The weight, related to gravity Default: 0.0
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def DisplayShadedAndTextured(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def keyframeRegionDirectKeyCtx(*args, exists: bool=True, history: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", name: AnyStr="", option: AnyStr="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command creates a context which may be used to directly manipulate keyframes within
the dope sheet editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param option: (C) Valid values are "move," "insert," "over," and "segmentOver." When you
"move" a key, the key will not cross over (in time) any keys before or after i
:returns: Context name
"""
pass
def ConvertSelectionToVertexPerimeter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySubdivideEdge(*args, caching: bool=True, constructionHistory: bool=True, divisions:
Union[int, bool]=1, name: AnyStr="", nodeState: Union[int, bool]=0, size:
Union[float, bool]=0.0, worldSpace: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Subdivides an edge into two or more subedges Default : divide edge into two edges of
equal length
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param divisions: (C Q E) The maximum number of vertices to be inserted in each edge This
number may be reduced if it creates edges shorter than the specified minimum length
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param size: (C Q E) The minimum length of each subedge created If the given subdivision
creates edges that are shorter than this length, the number of divisions is chan
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def InTangentFixed(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def mouldMesh(*args, **kwargs)->None:
"""
"""
pass
def createLayeredPsdFile(*args, imageFileName: Union[List[AnyStr, AnyStr, AnyStr],
List[List[AnyStr, AnyStr, AnyStr]]]=None, psdFileName: AnyStr="",
xResolution: int=0, yResolution: int=0, **kwargs)->None:
"""
Creates a layered PSD file with image names as input to individual layers
:param imageFileName: (C M) Layer name, blend mode, Image file name The image in the file
will be transferred to layer specified The image file specified can be in any of the f
:param psdFileName: (C) PSD file name
:param xResolution: (C) X - resolution of the image
:param yResolution: (C) Y - resolution of the image
:returns:
"""
pass
def xgmNoiseBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def hitTest(*args, **kwargs)->List[AnyStr]:
"""
The hitTest command hit-tests a point in the named control and returns a list of items
underneath the point The point is specified in pixels with the origin (0,0) at the
top-left corner This position is compatible with the coordinates provided by a
drop-callback The types of items that may be returned depends upon the specific control;
not all c
:returns: items underneath the hit-point
"""
pass
def intScrollBar(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dragCommand: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, horizontal: bool=True,
isObscured: bool=True, largeStep: Union[int, bool]=0, manage: bool=True,
maxValue: Union[int, bool]=0, minValue: Union[int, bool]=0, noBackground:
bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, statusBarMessage:
AnyStr="", step: Union[int, bool]=0, useTemplate: AnyStr="", value: Union[int,
bool]=0, visible: bool=True, visibleChangeCommand: Union[Script, bool]=None,
width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Create a scroll bar control that accepts only integer values and is bound by a minimum and
maximum value The scroll bar displays a marker indicating the current value of the scroll
bar relative to its minimum and maximum values Click and drag the marker or on the scroll
bar itself to change the current value
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the value changes This command is not
invoked when the value changes via the -v/value flag
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command executed when the value changes by dragging the scroll
bar's value marker
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param horizontal: (C Q) Orientation of the scroll bar This flag is true by default, which
corresponds to a horizontally oriented scroll bar
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param largeStep: (C Q E) Larger increment for the scroll bar, ie the increment used when
the press is between the arrow button and the thumb
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxValue: (C Q E) Upper limit of the scroll bar
:param minValue: (C Q E) Lower limit of the scroll bar
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) Smaller increment for the scroll bar, ie the increment used when the
arrow buttons are pressed
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Value of the scroll bar
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def setDynStartState(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def workspacePanel(*args, defineTemplate: AnyStr="", exists: bool=True, mainWindow: bool=True,
useTemplate: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Workspace panel
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param mainWindow: (C Q E) Main window for the application The main window has an 'Exit'
item in the Window Manager menu By default, the first created window becomes the main
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: Full path name to the workspace panel.
"""
pass
def GraphEditorDisplayValues(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorBackToParent(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideNURBSSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HyperGraphPanelUndoViewChange(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVEditorUnpinAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def subdiv(*args, currentLevel: bool=True, currentSubdLevel: bool=True, deepestLevel: Union[int,
bool]=0, displayLoad: bool=True, edgeStats: bool=True, faceStats: bool=True,
maxPossibleLevel: Union[int, bool]=0, proxyMode: Union[int, bool]=0, smallOffsets:
bool=True, q=True, query=True, **kwargs)->Union[None, Any]:
"""
Provides useful information about the selected subdiv or components, such as the deepest
subdivided level, the children or parents of the currently selected components, etc
:param currentLevel: (C Q) When queried, this flag returns an integer representing the
level of the currently selected subdiv surface component(s) Returns -1, if there are mor
:param currentSubdLevel: (C Q) When queried, this flag returns an integer representing the
level of the currently selected subdiv surface, regardless of whether components are sele
:param deepestLevel: (C Q) When queried, this flag returns an integer representing the
deepest level to which the queried subdiv surface has been subdivided
:param displayLoad: (C Q) When queried, this flag prints the display load of selected
subdiv
:param edgeStats: (C Q) When queried, this flag prints stats on the current subd
:param faceStats: (C Q) When queried, this flag prints stats on the current subd
:param maxPossibleLevel: (C Q) When queried, this flag returns an integer representing the
maximum possible level to which the queried subdiv surface can been subdivided
:param proxyMode: (C Q) When queried, this flag returns an integer representing whether or
not the subdivision surface is in "polygon proxy" mode "Proxy" mode allows the ba
:param smallOffsets: (C Q) When queried, this flag prints the number of subdiv vertices in
the hierarchy that have a small enough offset so that the vertex is not required
:returns:
"""
pass
def exportEdits(*args, excludeHierarchy: bool=True, excludeNode: Union[AnyStr, List[AnyStr],
bool]="", exportSelected: bool=True, force: bool=True, includeAnimation:
bool=True, includeConstraints: bool=True, includeDeformers: bool=True,
includeNetwork: bool=True, includeNode: Union[AnyStr, List[AnyStr], bool]="",
includeSetAttrs: bool=True, includeSetDrivenKeys: bool=True, includeShaders:
bool=True, selected: bool=True, type: Union[AnyStr, bool]="", editCommand:
Union[AnyStr, List[AnyStr], bool]="", onReferenceNode: Union[AnyStr,
List[AnyStr], bool]="", q=True, query=True, **kwargs)->Union[List[AnyStr],
Any]:
"""
Use this command to export edits made in the scene to a file The exported file can be
subsequently imported to another scene Edits may include: nodes, connections and reference
edits such as value changes The nodes that are included in the exported file will be based
on the options used At least one option flag that describes the set of target
:param excludeHierarchy: (C Q) By default, all DAG parents and DAG history are written to
the export file To prevent any DAG relations not otherwise connected to the target nodes
:param excludeNode: (C Q M) Prevent the node from being included in the list of nodes being
exported This flag is useful to exclude specific scene nodes that might otherwise be
:param exportSelected: (C Q) The selected nodes and their connections to each other will be
exported Additionally, any dangling connections to non-exported nodes will be exporte
:param force: (C Q) Force the export action to take place This flag is required to
overwrite an existing file
:param includeAnimation: (C Q) Additionally include animation nodes and animation helper
nodes associated with the target nodes being exported
:param includeConstraints: (C Q) Additionally include constraint-related nodes associated
with the target nodes being exported
:param includeDeformers: (C Q) Additionally include deformer networks associated with the
target nodes being exported
:param includeNetwork: (C Q) Additionally include the network of nodes connected to the
target nodes being exported
:param includeNode: (C Q M) Additionally include the named node in the list of nodes being
exported In the case where more than one Maya node has the same name, the DAG path ca
:param includeSetAttrs: (C Q) When using the -selected/-sel flag, if any of the selected
nodes are referenced, also include/exclude any setAttr edits on those nodes If used with
:param includeSetDrivenKeys: (C Q) Additionally include setDrivenKey-related nodes
associated with the target nodes being exported
:param includeShaders: (C Q) Additionally include shaders associated with the target nodes
being exported
:param selected: (C Q) Export will operate on the list of nodes currently selected This
flag differs from the exportSelected flag in that the selected nodes are not export
:param type: (C Q) Set the type of the exported file Valid values are "editMA" or "editMB"
Note that this command respects the global "defaultExtensions" setting for
:param editCommand: (C Q M) This is a secondary flag used to indicate which type of
reference edits should be considered by the command If this flag is not specified all edit
t
:param onReferenceNode: (C Q M) This is a secondary flag used to indicate that only those
edits which are stored on the indicated reference node should be considered This flag
only
:returns: For query execution.
"""
pass
def GraphEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddMissingFBIKEffectors(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def addPP(*args, attribute: AnyStr="", **kwargs)->List[AnyStr]:
"""
Adds per-point (per-cv, per-vertex, or per-particle) attribute capability for an attribute
of an emitter or field The -atr flag identifies the attribute If no attribute is named,
addPP returns a warning and does nothing The command adds any other necessary attributes
wherever they are needed, and makes all necessary connections If any of the a
:param attribute: (C) Name of attribute to which you wish to add PP capability Currently
the only attribute supported is rate (for emitters)
:returns: Returns names of emitters/fields for which the per-point
capability was added for
the specified attribute.
"""
pass
def SelectTextureReferenceObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowKinematics(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportInAscii(*args, **kwargs)->None:
"""
"""
pass
def HypershadeDeleteAllBakeSets(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def copyNode(*args, **kwargs)->None:
"""
"""
pass
def dR_bevelRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeDisplayInterestingShapes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def scriptedPanelType(*args, addCallback: Union[AnyStr, bool]="", copyStateCallback:
Union[AnyStr, bool]="", createCallback: Union[AnyStr, bool]="",
customView: bool=True, defineTemplate: AnyStr="", deleteCallback:
Union[AnyStr, bool]="", exists: bool=True, hotkeyCtxClient: Union[AnyStr,
bool]="", initCallback: Union[AnyStr, bool]="", label: Union[AnyStr,
bool]="", obsolete: bool=True, removeCallback: Union[AnyStr, bool]="",
retainOnFileOpen: bool=True, saveStateCallback: Union[AnyStr, bool]="",
unique: bool=True, useTemplate: AnyStr="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command defines the callbacks for a type of scripted panel The panel type created by
this command is then used when creating a scripted panel See also the 'scriptedPanel'
command
:param addCallback: (C Q E) This flag specifies the callback procedure for adding the panel
to a particular control layout The parent layout is guaranteed to be the current def
:param copyStateCallback: (C Q E) This flag specifies the callback procedure for copying
the state of the panel when a tear-off copy of the panel is made The callback proc has the
fo
:param createCallback: (C Q E) This flag specifies the callback procedure for initially
creating the panel object No UI should be created here Any editors owned by the panel
shou
:param customView: (C Q E) This flag specifies if this view is a custom 3d view for
MPx3dModelView types This flag should only be used for MPx3dModelView types
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param deleteCallback: (C Q E) This flag specifies the callback procedure for final
deletion of the panel The callback proc has the form: global proc procName (string
$panelName)
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param hotkeyCtxClient: (C Q E) This flag is used to specify the name of the hotkey context
client for this panel type By default, it is the same as the panel type
:param initCallback: (C Q E) This flag specifies the callback procedure for the initialize
callback This will be called on file -new and file -open to give the panel an opportun
:param label: (C Q E) Label for the panel
:param obsolete: (C Q E) This flag specifies that this type is no longer used in Maya
:param removeCallback: (C Q E) This flag specifies the callback procedure for removing the
panel from its current control layout Any editors should be unparented here The callbac
:param retainOnFileOpen: (C Q E) This flag specifies if panels of this type should be
retained after restoring panel cofiguration during file open Default value is false
:param saveStateCallback: (C Q E) This flag specifies the callback procedure for saving the
state of the panel The callback proc has the form: global proc string procName (string
$pa
:param unique: (C Q E) This flag specifies if only one instance of this type of panel can
exist at a given time
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the scripted panel type.
"""
pass
def GraphCutOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetVertexNormalOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DistributeUVsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleMainMenubar(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorToggleNodeSwatchSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FullCreaseSubdivSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModifyDisplacementRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXLoadMBExportPresetFile(*args, **kwargs)->None:
"""
"""
pass
def grabColor(*args, hsvValue: bool=True, rgbValue: bool=True, **kwargs)->float:
"""
This command changes the cursor and enters a modal state which will be exited by pressing a
mouse button The color component values of the pixel below the cursor at the time of the
button press are returned
:param hsvValue: (C) The 3 returned float values will specify the hue, saturation and value
color components
:param rgbValue: (C) The 3 returned float values will specify the red, green and blue color
components
:returns: []
Three float values representing the color components of the pixel below
the
cursor. If no flags are specified then the default is to return
the red, green and blue
color components.
"""
pass
def FBXExportColladaSingleMatrix(*args, **kwargs)->None:
"""
"""
pass
def hotkey(*args, altModifier: bool=True, autoSave: bool=True, commandModifier: bool=True,
ctrlModifier: bool=True, ctxClient: Union[AnyStr, bool]="", dragPress: bool=True,
factorySettings: bool=True, isModifier: bool=True, keyShortcut: AnyStr="", name:
Union[AnyStr, bool]="", pressCommandRepeat: bool=True, releaseCommandRepeat:
bool=True, releaseName: Union[AnyStr, bool]="", shiftModifier: bool=True,
sourceUserHotkeys: bool=True, q=True, query=True, **kwargs)->Union[None, Any]:
"""
This command sets the single-key hotkeys for the entire application
:param altModifier: (C Q)
:param autoSave: (C) If set to true then the hotkeys will always be saved when you quit If
false then the hotkeys are not saved unless "savePrefs -hotkeys" is used
:param commandModifier: (C) The Command key must be pressed to get the hotkey This is only
available on systems which have a separate command key Note that if menu item accele
:param ctrlModifier: (C Q) The Ctrl key must be pressed to get the hotkey Note that if
menu item accelerator keys are being used (menuItem -ke/keyEquivalent), then the acceler
:param ctxClient: (C Q) Specifies the hotkey context It is used together with the other
flags to modify or query the hotkey for a certain hotkey context If it is not speci
:param dragPress: (C) Specify true and the command may be executed during manipulator
dragging, if the tool context also allows this This flag is false by default
:param factorySettings: (C) Resets the hotkeys back to the initial defaults
:param isModifier: (C) This flag is obsolete and should no longer be used
:param keyShortcut: (C) Specify what key is being set The key must be either a single
ascii character (capital and lowercase can be set independently) or one of the keyword
:param name: (C Q) The name of the namedCommand object that will be executed when the key
is pressed
:param pressCommandRepeat: (C) Specify true and the command may be repeated by executing
the command repeatLast This flag is false by default
:param releaseCommandRepeat: (C) Specify true and the command may be repeated by executing
the command repeatLast This flag is false by default
:param releaseName: (C Q) The name of the namedCommand object that will be executed when
the key is released
:param shiftModifier: (C Q) The Shift key must be pressed to get the hotkey
:param sourceUserHotkeys: (C) This flag is obsolete Please use import flag from hotkeySet
command to import the user hotkeys
:returns:
"""
pass
def paintEffectsDisplay(*args, meshDrawEnable: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
Command to set the global display methods for paint effects items
:param meshDrawEnable: (C Q) Set whether mesh draw is enabled on objects
:returns:
"""
pass
def MovePolygonComponentOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SculptSubdivsTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_meshOffsetTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UnlockNormals(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_objectTemplateTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleShowResults(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LayoutUV(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EditFluidResolution(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshMaskToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def makeIdentity(*args, apply: bool=False, jointOrient: bool=True, normal: int=0,
preserveNormals: bool=True, rotate: bool=True, scale: bool=True, translate:
bool=True, **kwargs)->None:
"""
The makeIdentity command is a quick way to reset the selected transform and all of its
children down to the shape level by the identity transformation You can also specify which
of transform, rotate or scale is applied down from the selected transform The identity
transformation means: translate = 0, 0, 0 rotate = 0, 0, 0 scale = 1, 1, 1 shear =
:param apply: (C) If this flag is true, the accumulated transforms are applied to the shape
after the transforms are made identity, such that the world space positions
:param jointOrient: (C) If this flag is set, the joint orient on joints will be reset to
align with worldspace
:param normal: (C) If this flag is set to 1, the normals on polygonal objects will be
frozen This flag is valid only when the -apply flag is on If this flag is set to
:param preserveNormals: (C) If this flag is true, the normals on polygonal objects will be
reversed if the objects are negatively scaled (reflection) This flag is valid only wh
:param rotate: (C) If this flag is true, only the rotation is applied to the shape The
rotation will be changed to 0, 0, 0 If neither translate nor rotate nor scale f
:param scale: (C) If this flag is true, only the scale is applied to the shape The scale
factor will be changed to 1, 1, 1 If neither translate nor rotate nor scale
:param translate: (C) If this flag is true, only the translation is applied to the shape
The translation will be changed to 0, 0, 0 If neither translate nor rotate nor s
:returns:
"""
pass
def HypershadeDeleteUnusedNodes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetSmoothBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EditPolygonType(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_viewPersp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cMuscleSimulate(*args, **kwargs)->None:
"""
"""
pass
def separator(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, horizontal: bool=True, isObscured:
bool=True, manage: bool=True, noBackground: bool=True, numberOfPopupMenus:
bool=True, parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, statusBarMessage: AnyStr="", style: Union[AnyStr,
bool]="", useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a separator widget in a variety of drawing styles
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param horizontal: (C Q) Specify the orientation of the separator True for horizontal and
false for vertical Only valid when style equals "single"
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param style: (C Q E) Specify the style of the separator Valid values are "none", "single",
"in", "out" and "shelf" Note: the values "double", "singleDash" and "doubleDa
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def DisplaySmoothShaded(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dynPaintEditor(*args, activeOnly: bool=True, autoSave: bool=True, camera: Union[AnyStr,
bool]="", canvasMode: bool=True, canvasUndo: bool=True, changeCommand:
Union[List[AnyStr, AnyStr, AnyStr, AnyStr], bool]=None, clear: List[float,
float, float]=None, control: bool=True, currentCanvasSize: bool=True,
defineTemplate: AnyStr="", displayAppearance: Union[AnyStr, bool]="",
displayFog: bool=True, displayImage: Union[int, bool]=0, displayLights:
Union[AnyStr, bool]="", displayStyle: Union[AnyStr, bool]="",
displayTextures: bool=True, docTag: Union[AnyStr, bool]="", doubleBuffer:
bool=True, drawAxis: bool=True, drawContext: bool=True, exists: bool=True,
fastUpdate: int=0, fileName: Union[AnyStr, bool]="", filter: Union[AnyStr,
bool]="", forceMainConnection: Union[AnyStr, bool]="", highlightConnection:
Union[AnyStr, bool]="", iconGrab: bool=True, loadImage: AnyStr="",
lockMainConnection: bool=True, mainListConnection: Union[AnyStr, bool]="",
menu: AnyStr="", nbImages: bool=True, newImage: Union[List[int, int, float,
float, float], bool]=None, paintAll: float=0.0, panel: Union[AnyStr,
bool]="", parent: Union[AnyStr, bool]="", redrawLast: bool=True, refresh:
bool=True, refreshMode: Union[int, bool]=0, removeAllImages: bool=True,
removeImage: bool=True, rollImage: List[float, float]=None, saveAlpha:
bool=True, saveBumpmap: Union[AnyStr, bool]="", saveImage: bool=True,
scaleBlue: Union[float, bool]=0.0, scaleGreen: Union[float, bool]=0.0,
scaleRed: Union[float, bool]=0.0, selectionConnection: Union[AnyStr,
bool]="", singleBuffer: bool=True, snapShot: bool=True, stateString:
bool=True, swap: int=0, tileSize: int=0, unParent: bool=True, undoCache:
bool=True, unlockMainConnection: bool=True, updateMainConnection: bool=True,
useTemplate: AnyStr="", wrap: List[bool, bool]=None, writeImage: AnyStr="",
zoom: Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Create a editor window that can be painted into
:param activeOnly: (Q E) For Scene mode, this determines if only the active strokes will be
refreshed
:param autoSave: (Q E) For Canvas mode, this determines if the buffer will be saved to a
disk file after every stroke Good for painting textures and viewing the results in
:param camera: (Q E) Sets the name of the camera which the Paint Effects panel looks
through
:param canvasMode: (Q E) Sets the Paint Effects panel into Canvas mode if true
:param canvasUndo: (E) Does a fast undo in Canvas mode This is a special undo because we
are not using any history when we paint in Canvas mode so we provide a single leve
:param changeCommand: (C Q E) Parameters: First string: command Second string: editorName
Third string: editorCmd Fourth string: updateFunc Call the command when something changes
:param clear: (E) Clears the buffer (if in Canvas mode) to the floating point values (R,G,
B)
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param currentCanvasSize: (Q) In Query mode, this returns the (X,Y) resolution of the
current canvas
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param displayAppearance: (Q E) Sets the display appearance of the model panel Possible
values are "wireframe", "points", "boundingBox", "smoothShaded", "flatShaded" This flag
may
:param displayFog: (Q E) For Scene mode, this determines if fog will be displayed in the
Paint Effects panel when refreshing the scene If fog is on, but this is off, fog wil
:param displayImage: (Q E) Set a particular image in the Editor Image Stack as the current
Editor Image Images are added to the Editor Image Stack using the "si/saveImage" fla
:param displayLights: (Q E) Sets the lighting for shaded mode Possible values are
"selected", "active", "all", "default"
:param displayStyle: (C Q E) Set the mode to display the image Valid values are: "color"
to display the basic RGB image "mask" to display the mask channel "lum" to display the l
:param displayTextures: (Q E) Turns on or off display of textures in shaded mode
:param docTag: (C Q E) Attaches a tag to the editor
:param doubleBuffer: (C Q E) Set the display in double buffer mode
:param drawAxis: (C Q E) Set or query whether the axis will be drawn
:param drawContext: (Q) Returns the name of the context
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fastUpdate: () Obsolete - do not use
:param fileName: (Q E) This sets the file to which the canvas will be saved
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param iconGrab: (E) This puts the Paint Effects panel into Grab Icon mode where the user
is expected to drag out a section of the screen to be made into an icon
:param loadImage: (E) load an image from disk and set it as the current Editor Image
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param menu: (C) Sets the name of the script used to build a menu in the editor The script
takes the editor name as an argument
:param nbImages: (Q) returns the number of images
:param newImage: (Q E) Starts a new image in edit mode, setting the resolution to the
integer values (X,Y) and clearing the buffer to the floating point values (R,G,B) In
:param paintAll: (E) Redraws the buffer in current refresh mode
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param redrawLast: (E) Redraws the last stroke again Useful when it's brush has just
changed This feature does a fast undo and redraws the stroke again
:param refresh: (E) requests a refresh of the current Editor Image
:param refreshMode: (Q E) Sets the refresh mode to the specified value 0 - Do not draw
strokes on refresh, 1 - Redraw strokes in wireframe mode, 2 - Redraw strokes in final r
:param removeAllImages: (E) remove all the Editor Images from the Editor Image Stack
:param removeImage: (E) remove the current Editor Image from the Editor Image Stack
:param rollImage: (E) In Canvas mode, this rolls the image by the floating point values (X,
Y) X and Y are between 0 (no roll) and 1 (full roll) A value of .5 rolls the i
:param saveAlpha: (Q E) For Canvas mode, this determines if the alpha will be saved when
storing the canvas to a disk file
:param saveBumpmap: (Q E) Saves the current buffer as a bump map to the specified file
:param saveImage: (E) save the current Editor Image to memory Saved Editor Images are
stored in an Editor Image Stack The most recently saved image is stored in position
:param scaleBlue: (C Q E) Define the scaling factor for the blue component in the View The
default value is 1 and can be between -1000 to +1000
:param scaleGreen: (C Q E) Define the scaling factor for the green component in the View
The default value is 1 and can be between -1000 to +1000
:param scaleRed: (C Q E) Define the scaling factor for the red component in the View The
default value is 1 and can be between -1000 to +1000
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param singleBuffer: (C Q E) Set the display in single buffer mode
:param snapShot: (E) Takes a snapshot of the current camera view
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param swap: () Obsolete - do not use
:param tileSize: (E) Sets the size of the tile for the hardware texture redraw of the
display buffer
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param undoCache: (E) By default the last image is cached for undo If this is set false,
then undoing will be disabled in canvas mode and undo in scene mode will force a
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param wrap: (Q E) For Canvas mode, should the buffer wrap in U, and V (respectively) when
painting
:param writeImage: (E) write the current Editor Image to disk
:param zoom: (Q E) Zooms the Canvas image by the specified value
:returns: Editor name
"""
pass
def CreateSubdivTorus(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MapUVBorder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBifrostKillField(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def currentUnit(*args, angle: Union[AnyStr, bool]="", fullName: bool=True, linear: Union[AnyStr,
bool]="", time: Union[AnyStr, bool]="", updateAnimation: bool=True, q=True,
query=True, **kwargs)->Union[AnyStr, Any]:
"""
This command allows you to change the units in which you will work in Maya There are three
types of units: linear, angular and time The current unit affects how all commands in
Maya interpret their numeric values For example, if the current linear unit is cm, then
the command: move 5 -2 3; sphere -radius 4; will be interpreted as moving 5cm in
:param angle: (C Q) Set the current angular unit Valid strings are: [deg | degree | rad |
radian] When queried, returns a string which is the current angular unit
:param fullName: (Q) A query only flag When specified in conjunction with any of the
-linear/-angle/-time flags, will return the long form of the unit For example, mm a
:param linear: (C Q) Set the current linear unit Valid strings are: [mm | millimeter | cm
| centimeter | m | meter | km | kilometer | in | inch | ft | foot | yd | yard |
:param time: (C Q) Set the current time unit Valid strings are: [hour | min | sec |
millisec | game | film | pal | ntsc | show | palf | ntscf | 23.976fps | 29.97fps |
:param updateAnimation: (C) An edit only flag When specified in conjunction with the -time
flag indicates that times for keys are not updated By default when the current time
:returns: The new current unit that has been set
"""
pass
def FBXExportShapes(*args, **kwargs)->None:
"""
"""
pass
def HypershadeSortByName(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def layoutDialog(*args, backgroundColor: List[float, float, float]=None, dismiss: AnyStr="",
parent: AnyStr="", title: AnyStr="", uiScript: Script=None, **kwargs)->AnyStr:
"""
The layoutDialog command creates a modal dialog containing a formLayout with 100 divisions
The formLayout can be populated with arbitrary UI elements through use of the
'-ui/-uiScript' flag NOTE: A layoutDialog is not a window and certain UI elements will
not function properly within it In particular menuBars and panels containing menuBars
shou
:param backgroundColor: (C) The background color of the dialog The arguments correspond to
the red, green, and blue color components Each component ranges in value from 0.0 to
:param dismiss: (C) Dismiss the current layoutDialog The specified string will be set as
the result of the initial layoutDialog command
:param parent: (C) Specify the parent window for the dialog The dialog will be centered on
this window and raise and lower with it's parent By default, the dialog is
:param title: (C) The dialog title
:param uiScript: (C) The specified MEL procedure name will be invoked to build the UI of
the layoutDialog This flag is required when creating a layoutDialog The top-lev
:returns: The string specified by the -dismiss flag, or "dismiss" if the dialog
was closed.
"""
pass
def DeleteAllShadingGroupsAndMaterials(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_coordSpaceWorld(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateAmbientLight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_objectBackfaceTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RelaxUVShell(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CollapseSubdivSurfaceHierarchy(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OptimzeUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OneClickDispatch(*args, **kwargs)->None:
"""
"""
pass
def rowColumnLayout(*args, adjustableColumn: int=0, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, childArray:
bool=True, columnAlign: Union[List[int, AnyStr], List[List[int,
AnyStr]]]=None, columnAttach: Union[List[int, AnyStr, int], List[List[int,
AnyStr, int]]]=None, columnOffset: Union[List[int, AnyStr, int],
List[List[int, AnyStr, int]]]=None, columnSpacing: Union[List[int, int],
List[List[int, int]]]=None, columnWidth: Union[List[int, int],
List[List[int, int]]]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
exists: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, manage: bool=True, noBackground: bool=True, numberOfChildren:
bool=True, numberOfColumns: Union[int, bool]=0, numberOfPopupMenus:
bool=True, numberOfRows: Union[int, bool]=0, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, rowAlign:
Union[List[int, AnyStr], List[List[int, AnyStr]]]=None, rowAttach:
Union[List[int, AnyStr, int], List[List[int, AnyStr, int]]]=None,
rowHeight: Union[List[int, int], List[List[int, int]]]=None, rowOffset:
Union[List[int, AnyStr, int], List[List[int, AnyStr, int]]]=None,
rowSpacing: Union[List[int, int], List[List[int, int]]]=None,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a rowColumn layout A rowColumn layout positions children in either a
row or column format A column layout, specified with the -nc/numberOfColumns flag, allows
you set text alignment, attachments and offsets for each column in the layout Every member
of a column will have the same alignment, attachment and offsets Likewise t
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param columnAlign: (C E M) Alignment for text and pixmaps in the specified column Values
are: "left", "right" and "center" Only valid for column format, ie number of columns
:param columnAttach: (C E M) The attachments and offsets for the children in the specified
column The first argument is the 1-based column index The second argument is the atta
:param columnOffset: (C E M) The attachment offset for the specified column The first
argument is the 1-based column index The second argument is the attachment, valid values
a
:param columnSpacing: (C E M) The space between columns in pixels In column format this
flag specifies that the space be to the left of the given column In row format it specifi
:param columnWidth: (C E M) Width of a column This flag is valid only in column format
The column width must be greater than 0 The first argument is the 1-based column index
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfColumns: (C Q) Number of columns This flag is mutually exclusive to the
-nr/numRows flag Either one or the other can be specified
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param numberOfRows: (C Q) Number of rows This flag is mutually exclusive to the
-nc/numColumns flag Either one or the other can be specified
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAlign: (C E M) Alignment for text and pixmaps in the specified row Values are:
"left", "right" and "center" Only valid for row format, ie number of rows specifie
:param rowAttach: (C E M) The attachments and offsets for the children in the specified row
The first argument is the 1-based row index The second argument is the attachment
:param rowHeight: (C E M) Height of a row This flag is only valid in row format The row
height must be greater than 0 The first argument is the 1-based row index The secon
:param rowOffset: (C E M) The attachment offset for the specified row The first argument
is the 1-based row index The second argument is the attachment, valid values are "to
:param rowSpacing: (C E M) The space between rows, in pixels In row format this specifies
the space above the specified row In column format it specifies the space between al
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def SelectAllSubdivGeometry(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleReflection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DistributeUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def keyingGroup(*args, activator: Union[name, bool]=None, addElement: name=None, afterFilters:
bool=True, category: Union[AnyStr, bool]="", clear: name=None, color: Union[int,
bool]=0, copy: name=None, edges: bool=True, editPoints: bool=True, empty:
bool=True, excludeDynamic: bool=True, excludeRotate: bool=True, excludeScale:
bool=True, excludeTranslate: bool=True, excludeVisibility: bool=True, facets:
bool=True, flatten: name=None, forceElement: name=None, include: name=None,
intersection: name=None, isIntersecting: name=None, isMember: name=None, layer:
bool=True, minimizeRotation: bool=True, name: AnyStr="", noSurfaceShader:
bool=True, noWarnings: bool=True, nodesOnly: bool=True, remove: name=None,
removeActivator: name=None, renderable: bool=True, setActiveFilter:
Union[AnyStr, bool]="", size: bool=True, split: name=None, subtract: name=None,
text: Union[AnyStr, bool]="", union: name=None, vertices: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command is used to manage the membership of a keying group Keying groups allow users
to effectively manage related keyframe data, allowing keys on attributes in the keying
group to be set and edited as a single entity
:param activator: (Q E) Sets the selected node(s) as activators for the given keying group
In query mode, returns list of objects that activate the given keying group
:param addElement: (E) Adds the list of items to the given set If some of the items cannot
be added to the set because they are in another set which is in the same partiti
:param afterFilters: (E) Default state is false This flag is valid in edit mode only This
flag is for use on sets that are acted on by deformers such as sculpt, lattice, bl
:param category: (C Q E) Sets the keying group's category This is what the global, active
keying group filter will use to match
:param clear: (E) An operation which removes all items from the given set making the set
empty
:param color: (C Q E) Defines the hilite color of the set Must be a value in range [-1, 7]
(one of the user defined colors) -1 marks the color has being undefined and th
:param copy: (C) Copies the members of the given set to a new set This flag is for use in
creation mode only
:param edges: (C Q) Indicates the new set can contain edges only This flag is for use in
creation or query mode only The default value is false
:param editPoints: (C Q) Indicates the new set can contain editPoints only This flag is
for use in creation or query mode only The default value is false
:param empty: (C) Indicates that the set to be created should be empty That is, it ignores
any arguments identifying objects to be added to the set This flag is only
:param excludeDynamic: (C) When creating the keying group, exclude dynamic attributes
:param excludeRotate: (C) When creating the keying group, exclude rotate attributes from
transform-type nodes
:param excludeScale: (C) When creating the keying group, exclude scale attributes from
transform-type nodes
:param excludeTranslate: (C) When creating the keying group, exclude translate attributes
from transform-type nodes For example, if your keying group contains joints only, perha
:param excludeVisibility: (C) When creating the keying group, exclude visibility attribute
from transform-type nodes
:param facets: (C Q) Indicates the new set can contain facets only This flag is for use in
creation or query mode only The default value is false
:param flatten: (E) An operation that flattens the structure of the given set That is, any
sets contained by the given set will be replaced by its members so that the s
:param forceElement: (E) For use in edit mode only Forces addition of the items to the set
If the items are in another set which is in the same partition as the given set,
:param include: (E) Adds the list of items to the given set If some of the items cannot be
added to the set, a warning will be issued This is a less strict version of
:param intersection: (C) An operation that returns a list of items which are members of all
the sets in the list
:param isIntersecting: (C) An operation which tests whether the sets in the list have
common members
:param isMember: (C) An operation which tests whether all the given items are members of
the given set
:param layer: (C) OBSOLETE DO NOT USE
:param minimizeRotation: (C Q E) This flag only affects the attribute contained in the
immediate keyingGroup It does not affect attributes in sub-keyingGroups Those will need
to se
:param name: (C) Assigns string as the name for a new set This flag is only valid for
operations that create a new set
:param noSurfaceShader: (C) If set is renderable, do not connect it to the default surface
shader Flag has no meaning or effect for non renderable sets This flag is for use in
:param noWarnings: (C) Indicates that warning messages should not be reported such as when
trying to add an invalid item to a set (used by UI)
:param nodesOnly: (Q) This flag is usable with the -q/query flag but is ignored if used
with another queryable flags This flag modifies the results of the set membership
:param remove: (E) Removes the list of items from the given set
:param removeActivator: (E) Removes the selected node(s) as activators for the given keying
group
:param renderable: (C Q) This flag indicates that a special type of set should be created
This type of set (shadingEngine as opposed to objectSet) has certain restrictions o
:param setActiveFilter: (C Q E) Sets the global, active keying group filter, which will
affect activation of keying groups Only keying groups with categories that match the
filter
:param size: (Q) Use the size flag to query the length of the set
:param split: (C) Produces a new set with the list of items and removes each item in the
list of items from the given set
:param subtract: (C) An operation between two sets which returns the members of the first
set that are not in the second set
:param text: (C Q E) Defines an annotation string to be stored with the set
:param union: (C) An operation that returns a list of all the members of all sets listed
:param vertices: (C Q) Indicates the new set can contain vertices only This flag is for
use in creation or query mode only The default value is false
:returns: For creation operations (name of the keying group that was created or edited)
"""
pass
def MoveDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmDirectionBrushContext(*args, **kwargs)->None:
"""
"""
pass
def HypershadeRemoveAsset(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmPolyToGuide(*args, **kwargs)->None:
"""
"""
pass
def ShowRiggingUI(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def deleteAttrPattern(*args, allPatterns: bool=True, patternName: AnyStr="", patternType:
AnyStr="", **kwargs)->AnyStr:
"""
After a while the list of attribute patterns could become cluttered This command provides
a way to remove patterns from memory so that only the ones of interest will show
:param allPatterns: (C) If specified it means delete all known attribute patterns
:param patternName: (C) The name of the pattern to be deleted
:param patternType: (C) Delete all patterns of the given type
:returns: Name(s) of deleted pattern(s)
"""
pass
def ScaleConstraint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SaveBrushPreset(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXClose(*args, **kwargs)->None:
"""
"""
pass
def NextFrame(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HIKCycleMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolygonBooleanUnion(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artAttrPaintVertexCtx(*args, accopacity: bool=False, activeListChangedProc: Union[AnyStr,
bool]="", afterStrokeCmd: Union[AnyStr, bool]="", alphaclamp:
Union[AnyStr, bool]="none", alphaclamplower: Union[float, bool]=0.0,
alphaclampupper: Union[float, bool]=1.0, attrSelected: Union[AnyStr,
bool]="", beforeStrokeCmd: Union[AnyStr, bool]="", brushalignment:
bool=True, brushfeedback: bool=True, clamp: Union[AnyStr,
bool]="none", clamplower: Union[float, bool]=0.0, clampupper:
Union[float, bool]=1.0, clear: bool=True, colorAlphaValue:
Union[float, bool]=0.0, colorRGBAValue: Union[List[float, float,
float, float], bool]=None, colorRGBValue: Union[List[float, float,
float], bool]=None, colorRamp: Union[AnyStr, bool]="", colorfeedback:
bool=False, colorfeedbackOverride: bool=False, colorrangelower:
Union[float, bool]=0.0, colorrangeupper: Union[float, bool]=1.0,
dataTypeIndex: Union[int, bool]=0, disablelighting: bool=False,
dragSlider: AnyStr="", duringStrokeCmd: Union[AnyStr, bool]="",
dynclonemode: bool=True, exists: bool=True, expandfilename: bool=True,
exportaspectratio: Union[float, bool]=0.0, exportfilemode:
Union[AnyStr, bool]="luminance/rgb", exportfilesave: AnyStr="",
exportfilesizex: Union[int, bool]=0, exportfilesizey: Union[int,
bool]=0, exportfiletype: Union[AnyStr, bool]="", filterNodes:
bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
importfileload: AnyStr="", importfilemode: Union[AnyStr,
bool]="alpha", importreassign: bool=False, interactiveUpdate:
bool=True, lastRecorderCmd: Union[AnyStr, bool]="", lastStampName:
Union[AnyStr, bool]="", lowerradius: Union[float, bool]=0.0,
makeStroke: Union[int, List[int], bool]=0, mappressure: Union[AnyStr,
bool]="none", maxvalue: Union[float, bool]=1.0, minvalue: Union[float,
bool]=0.0, name: AnyStr="", objattrArray: Union[AnyStr, bool]="",
opacity: Union[float, bool]=1.0, outline: bool=True, outwhilepaint:
bool=False, paintComponent: Union[int, bool]=0, paintNodeArray:
Union[AnyStr, bool]="", paintNumChannels: Union[int, bool]=0,
paintRGBA: bool=False, paintVertexFace: bool=False,
paintattrselected: AnyStr="", paintmode: Union[AnyStr, bool]="screen",
paintoperationtype: Union[AnyStr, bool]="Paint", pickColor: bool=True,
pickValue: bool=True, playbackCursor: Union[List[float, float],
List[List[float, float]], bool]=None, playbackPressure: Union[float,
List[float], bool]=0.0, preserveclonesource: bool=True,
profileShapeFile: Union[AnyStr, bool]="", projective: bool=False,
radius: Union[float, bool]=1.0, rampMaxColor: Union[List[float, float,
float], bool]=None, rampMinColor: Union[List[float, float, float],
bool]=None, record: bool=True, reflection: bool=False,
reflectionaboutorigin: bool=True, reflectionaxis: Union[AnyStr,
bool]="x", screenRadius: Union[float, bool]=0.0, selectclonesource:
bool=True, selectedattroper: Union[AnyStr, bool]="absolute",
showactive: bool=True, stampDepth: Union[float, bool]=0.0,
stampProfile: Union[AnyStr, bool]="", stampSpacing: Union[float,
bool]=1.0, strokesmooth: Union[AnyStr, bool]="",
surfaceConformedBrushVertices: bool=True, tablet: bool=True,
tangentOutline: bool=True, toolOffProc: Union[AnyStr, bool]="",
toolOnProc: Union[AnyStr, bool]="", useColorRamp: bool=True,
useMaxMinColor: bool=True, usepressure: bool=False, value:
Union[float, bool]=0.0, vertexColorRange: bool=False,
vertexColorRangeLower: Union[float, bool]=0.0, vertexColorRangeUpper:
Union[float, bool]=1.0, whichTool: Union[AnyStr, bool]="",
worldRadius: Union[float, bool]=0.0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
This is a context command to set the flags on the artAttrContext, which is the base context
for attribute painting operations All commands require the name of the context as the last
argument as this provides the name of the context to create, edit or query This is a
context command to set the flags on the Paint color on vertex Tool context
:param accopacity: (C Q E) Sets opacity accumulation on/off C: Default is false (Except
for sculpt tool for which it is true by default) Q: When queried, it returns a boolean
:param activeListChangedProc: (C Q E) Accepts a string that contains a MEL command that is
invoked whenever the active list changes There may be some situations where the UI, for
example
:param afterStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
after the end of a stroke C: Default is no command Q: When queried, it returns the curre
:param alphaclamp: (C Q E) Specifies if the weight value should be alpha clamped to the
lower and upper bounds There are four options here: "none" - no clamping is performed,
:param alphaclamplower: (C Q E) Specifies the lower bound for the alpha values C: Default
is 0.0 Q: When queried, it returns a float
:param alphaclampupper: (C Q E) Specifies the upper bound for the alpha values C: Default
is 1.0 Q: When queried, it returns a float
:param attrSelected: (Q) Returns a name of the currently selected attribute Q: When
queried, it returns a string
:param beforeStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
before the start of a stroke C: Default is no command Q: When queried, it returns the cu
:param brushalignment: (C Q E) Specifies the path brush alignemnt If true, the brush will
align to stroke path, otherwise it will align to up vector C: Default is true Q: When q
:param brushfeedback: (C Q E) Specifies if the brush additional feedback should be drawn
C: Default is TRUE Q: When queried, it returns a boolean
:param clamp: (C Q E) Specifies if the weight value should be clamped to the lower and
upper bounds There are four options here: "none" - no clamping is performed, "lower
:param clamplower: (C Q E) Specifies the lower bound for the values C: Default is 0.0 Q:
When queried, it returns a float
:param clampupper: (C Q E) Specifies the upper bound for the values C: Default is 1.0 Q:
When queried, it returns a float
:param clear: (C E) Floods all cvs/vertices to the current value
:param colorAlphaValue: (C Q E) The Alpha value of the color
:param colorRGBAValue: (C Q E) The RGBA value of the color
:param colorRGBValue: (C Q E) The RGB value of the color
:param colorRamp: (C Q E) Allows a user defined color ramp to be used to map values to
colors
:param colorfeedback: (C Q E) Sets on/off the color feedback display C: Default is FALSE
Q: When queried, it returns a boolean
:param colorfeedbackOverride: (C Q E) Sets on/off the color feedback override C: Default
is FALSE Q: When queried, it returns a boolean
:param colorrangelower: (C Q E) Specifies the value that maps to black when color feedback
mode is on C: Default is 0.0 Q: When queried, it returns a float
:param colorrangeupper: (C Q E) Specifies the value that maps to the maximum color when
color feedback mode is on C: Default is 1.0 Q: When queried, it returns a float
:param dataTypeIndex: (Q E) When the selected paintable attribute is a vectorArray, it
specifies which field to paint on
:param disablelighting: (C Q E) If color feedback is on, this flag determines whether
lighting is disabled or not for the surfaces that are affected C: Default is FALSE Q:
When qu
:param dragSlider: (C E) Sets the current brush drag state for resizing or offsetting the
brush (like the 'b' and 'm' default hotkeys) The string argument is one of: "radius
:param duringStrokeCmd: (C Q E) The passed string is executed as a MEL command during the
stroke, each time the mouse is dragged C: Default is no command Q: When queried, it
retur
:param dynclonemode: (C Q E) Enable or disable dynamic clone mode
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param expandfilename: (C E) If true, it will expand the name of the export file and
concatenate it with the surface name Otherwise it will take the name as it is C: Default
is
:param exportaspectratio: (C Q E) Value of aspect ratio for export
:param exportfilemode: (C Q E) Specifies the export channel.The valid entries here are:
"alpha", "luminance", "rgb", "rgba" C: Default is "luminance/rgb" Q: When queried, it
retu
:param exportfilesave: (E) Exports the attribute map and saves to a specified file
:param exportfilesizex: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfilesizey: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfiletype: (C Q E) Specifies the image file format It can be one of the
following: "iff", "tiff", "jpeg", "alias", "rgb", "fit" "postScriptEPS", "softimage",
"wavefron
:param filterNodes: (E) Sets the node filter
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param importfileload: (E) Load the attribute map a specified file
:param importfilemode: (C Q E) Specifies the channel to import The valid entries here are:
"alpha", "luminance", "red", "green", "blue", and "rgb" C: Default is "alpha" Q: When q
:param importreassign: (C Q E) Specifies if the multiply atrribute maps are to be
reassigned while importing Only maps previously exported from within Artisan can be
reassigned C
:param interactiveUpdate: (C Q E) Specifies how often to transfer the painted values into
the attribute TRUE: transfer them "continuously" (many times per stroke) FALSE: transfer
the
:param lastRecorderCmd: (C Q E) Value of last recorded command
:param lastStampName: (C Q E) Value of the last stamp name
:param lowerradius: (C Q E) Sets the lower size of the brush (only apply on tablet)
:param makeStroke: (C Q E M) Stroke point values
:param mappressure: (C Q E) Sets the tablet pressure mapping when the table is used There
are four options: "none" - the pressure has no effect, "opacity" - the pressure is map
:param maxvalue: (C Q E) Specifies the maximum value for each attribute C: Default is 1.0
Q: When queried, it returns a float
:param minvalue: (C Q E) Specifies the minimum value for each attribute C: Default is 0.0
Q: When queried, it returns a float
:param name: (C) If this is a tool command, name the tool appropriately
:param objattrArray: (Q) An array of all paintable attributes Each element of the array is
a string with the following information: NodeType.NodeName.AttributeName.MenuType
:param opacity: (C Q E) Sets the brush opacity C: Default is 1.0 Q: When queried, it
returns a float
:param outline: (C Q E) Specifies if the brush should be drawn C: Default is TRUE Q: When
queried, it returns a boolean
:param outwhilepaint: (C Q E) Specifies if the brush outline should be drawn while painting
C: Default is FALSE Q: When queried, it returns a boolean
:param paintComponent: (C Q E) Specifies whether face or vertex or vertex face is being
painted 1 - Vertex 2 - VertexFace 3 - Face C: Default is Vertex Q: When queried, it
return
:param paintNodeArray: (Q) An array of paintable nodes Q: When queried, it returns a
string
:param paintNumChannels: (C Q E) Number of channels to paint - 1 (alpha), 3 (RGB), or 4
(RGBA)
:param paintRGBA: (C Q E) Specifies whether RGB or RGBA channels are being painted TRUE:
RGBA channels FALSE: RGB channels Alpha channel remains unaffected C: Default is F
:param paintVertexFace: (C Q E) Specifies whether vertex face is being painted TRUE:
Vertex face being painted (Allows each face connected to the vertex to be painted) FALSE:
Vert
:param paintattrselected: (E) An array of selected paintable attributes Each element of
the array is a string with the following information: NodeType.NodeName.AttributeName
:param paintmode: (C Q E) Specifies the paint mode There are two possibilities: "screen"
and "tangent" C: Default is "screen" Q: When queried, it returns a string
:param paintoperationtype: (C Q E) Specifies the operation type used by the Paint Tool
Currently, we support the following paint modes: "Paint", "Smear", "Blur", "Erase" and
"Clone"
:param pickColor: (C Q E) Set pick color mode on or off
:param pickValue: (C Q E) Toggle for picking
:param playbackCursor: (C Q E M) Values for the playback cursor
:param playbackPressure: (C Q E M) Valus for the playback pressure
:param preserveclonesource: (C Q E) Whether or not to preserve a clone source
:param profileShapeFile: (Q E) Passes a name of the image file for the stamp shape profile
:param projective: (C Q E) Specifies the projective paint mode C: Default is 'false' Q:
When queried, it returns a boolean
:param radius: (C Q E) Sets the size of the brush C: Default is 1.0 cm Q: When queried,
it returns a float
:param rampMaxColor: (C Q E) Defines a special color to be used when the value is greater
than or equal to the maximum value
:param rampMinColor: (C Q E) Defines a special color to be used when the value is less than
or equal to the minimum value
:param record: (C Q E) Toggle on for recording
:param reflection: (C Q E) Specifies the reflection mode C: Default is 'false' Q: When
queried, it returns a boolean
:param reflectionaboutorigin: (C Q E) Toggle on to reflect about the origin
:param reflectionaxis: (C Q E) Specifies the reflection axis There are three
possibilities: "x", "y" and "z" C: Default is "x" Q: When queried, it returns a string
:param screenRadius: (C Q E) Brush radius on the screen
:param selectclonesource: (C Q E) Toggle on to select the clone source
:param selectedattroper: (C Q E) Sets the edit weight operation Four edit weights
operations are provided : "absolute" - the value of the weight is replaced by the current
one, "add
:param showactive: (C Q E) Sets on/off the display of the surface isoparms C: Default is
TRUE Q: When queried, it returns a boolean
:param stampDepth: (C Q E) Depth of the stamps
:param stampProfile: (C Q E) Sets the brush profile of the current stamp Currently, the
following profiles are supported: "gaussian", "poly", "solid" and "square" C: Default is
:param stampSpacing: (C Q E) Specifies the stamp spacing Default is 1.0
:param strokesmooth: (C Q E) Stroke smoothing type name
:param surfaceConformedBrushVertices: (C Q E) Enables/disables the the display of the
effective brush area as affected vertices
:param tablet: (Q) Returns true if the tablet device is present, false if it is absent
:param tangentOutline: (C Q E) Enables/disables the display of the brush circle tangent to
the surface
:param toolOffProc: (C Q E) Accepts a strings describing the name of a MEL procedure that
is invoked whenever the tool is turned off For example, cloth invokes "clothPaintToolO
:param toolOnProc: (C Q E) Accepts a strings describing the name of a MEL procedure that is
invoked whenever the tool is turned on For example, cloth invokes "clothPaintToolOn
:param useColorRamp: (C Q E) Specifies whether the user defined color ramp should be used
to map values from to colors If this is turned off, the default greyscale feedback will
:param useMaxMinColor: (C Q E) Specifies whether the out of range colors should be used
See rampMinColor and rampMaxColor flags for further details
:param usepressure: (C Q E) Sets the tablet pressure on/off C: Default is false Q: When
queried, it returns a boolean
:param value: (C Q E) Specifies the value for each attribute C: Default is 0.0 Q: When
queried, it returns a float
:param vertexColorRange: (C Q E) Specifies whether the vertex color range should be applied
to the currently selected object C: Default is false Q: When queried, it returns a boolea
:param vertexColorRangeLower: (C Q E) Specifies the min value of the vertex color range C:
Default is 0.0 Q: When queried, it returns a float
:param vertexColorRangeUpper: (C Q E) Specifies the max value of the vertex color range C:
Default is 1.0 Q: When queried, it returns a float
:param whichTool: (C Q E) The string defines the name of the tool to be used for the
Artisan context An example is "artClothPaint" In query mode, the tool name for the given
:param worldRadius: (C Q E) Radius in worldspace
:returns:
"""
pass
def GoToMaxFrame(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def requires(*args, dataType: Union[AnyStr, List[AnyStr]]="", nodeType: Union[AnyStr,
List[AnyStr]]="", **kwargs)->None:
"""
This command is used during file I/O to specify the requirements needed to load the given
file It defines what file format version was used to write the file, or what plug-ins are
required to load the scene The first string names a product (either "maya", or a plug-in
name) The second string gives the version This command is only useful during
:param dataType: (C M) Specify a data type defined by this plug-in The data type is
specified by MFnPlugin::registerData() when register the plug-in
:param nodeType: (C M) Specify a node type defined by this plug-in The node type is
specified by MFnPlugin::registerNode() when register the plug-in
:returns:
"""
pass
def SmoothBindSkinOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertSelectionToContainedEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyMoveVertex(*args, caching: bool=True, constructionHistory: bool=True, gain: Union[float,
List[float], bool]=1.0, localDirection: Union[List[float, float, float],
bool]=None, localDirectionX: Union[float, bool]=0.0, localDirectionY:
Union[float, bool]=0.0, localDirectionZ: Union[float, bool]=0.0,
localTranslate: Union[List[float, float, float], bool]=None,
localTranslateX: Union[float, bool]=0.0, localTranslateY: Union[float,
bool]=0.0, localTranslateZ: Union[float, bool]=0.0, name: AnyStr="",
nodeState: Union[int, bool]=0, pivot: Union[List[float, float, float],
bool]=None, pivotX: Union[float, bool]=0.0, pivotY: Union[float, bool]=0.0,
pivotZ: Union[float, bool]=0.0, random: Union[float, bool]=0.0, rotate:
Union[List[float, float, float], bool]=None, rotateX: Union[float, bool]=0.0,
rotateY: Union[float, bool]=0.0, rotateZ: Union[float, bool]=0.0, scale:
Union[List[float, float, float], bool]=None, scaleX: Union[float, bool]=0.0,
scaleY: Union[float, bool]=0.0, scaleZ: Union[float, bool]=0.0, translate:
Union[List[float, float, float], bool]=None, translateX: Union[float,
bool]=0.0, translateY: Union[float, bool]=0.0, translateZ: Union[float,
bool]=0.0, worldSpace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Modifies vertices of a polygonal object Translate, rotate or scale vertices in local or
world space
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param gain: (C Q E M) Gain factor per component Can be painted using Artisan Default:
1.0
:param localDirection: (C Q E) Direction to determine X axis for local space Default: 1.0,
0.0, 0.0
:param localDirectionX: (C Q E) X coord of the X axis
:param localDirectionY: (C Q E) Y coord of the X axis
:param localDirectionZ: (C Q E) Z coord of the X axis
:param localTranslate: (C Q E) Local translate Default: 0.0, 0.0, 0.0
:param localTranslateX: (C Q E) Local translation X coord
:param localTranslateY: (C Q E) Local translation Y coord
:param localTranslateZ: (C Q E) Local translation Z coord : Move along the normal
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pivot: (C Q E) The pivot for scaling and rotation Default: 0.0, 0.0, 0.0
:param pivotX: (C Q E) Pivot X coord
:param pivotY: (C Q E) Pivot Y coord
:param pivotZ: (C Q E) Pivot Z coord
:param random: (C Q E) Random value for all parameters Default: 0.0
:param rotate: (C Q E) Rotation angles around X, Y, Z Default: 0.0, 0.0, 0.0
:param rotateX: (C Q E) Rotation angle around X
:param rotateY: (C Q E) Rotation angle around Y
:param rotateZ: (C Q E) Rotation angle around Z
:param scale: (C Q E) Scaling vector Default: 1.0, 1.0, 1.0
:param scaleX: (C Q E) Scale X coord
:param scaleY: (C Q E) Scale Y coord
:param scaleZ: (C Q E) Scale Z coord
:param translate: (C Q E) Translation vector Default: 0.0, 0.0, 0.0
:param translateX: (C Q E) Translation X coord
:param translateY: (C Q E) Translation Y coord
:param translateZ: (C Q E) Translation Z coord
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def HypershadeDeleteDuplicateShadingNetworks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SubdivSmoothnessRoughOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutTangentClamped(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def srtContext(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name: AnyStr="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create a combined transform (translate/scale/rotate) context
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: - name of the newly created context
"""
pass
def orientConstraint(*args, createCache: List[float, float]=None, deleteCache: bool=True,
layer: AnyStr="", maintainOffset: bool=True, name: Union[AnyStr, bool]="",
offset: Union[List[float, float, float], bool]=None, remove: bool=True,
skip: Union[AnyStr, List[AnyStr]]="", targetList: bool=True, weight:
Union[float, bool]=0.0, weightAliasList: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Constrain an object's orientation to match the orientation of the target or the average of
a number of targets An orientConstraint takes as input one or more "target" DAG transform
nodes to control the orientation of the single "constraint object" DAG transform The
orientConstraint orients the constrained object to match the weighted average of t
:param createCache: (E) This flag is used to generate an animation curve that serves as a
cache for the constraint The two arguments define the start and end frames The ca
:param deleteCache: (E) Delete an existing interpolation cache
:param layer: (C E) Specify the name of the animation layer where the constraint should be
added
:param maintainOffset: (C) The offset necessary to preserve the constrained object's
initial orientation will be calculated and used as the offset
:param name: (C Q E) Sets the name of the constraint node to the specified name Default
name is constrainedObjectName_constraintType
:param offset: (C Q E) Sets or queries the value of the offset Default is 0,0,0
:param remove: (E) removes the listed target(s) from the constraint
:param skip: (C E M) Specify the axis to be skipped Valid values are "x", "y", "z" and
"none" The default value in create mode is "none" This flag is multi-use
:param targetList: (Q) Return the list of target objects
:param weight: (C Q E) Sets the weight value for the specified target(s) If not given at
creation time, the default value of 1.0 is used
:param weightAliasList: (Q) Returns the names of the attributes that control the weight of
the target objects Aliases are returned in the same order as the targets are returned
:returns: [] ( name of the created constraint node)
"""
pass
def SetTimecode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetFreezeBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def geoUtils(*args, **kwargs)->None:
"""
"""
pass
def PolyConvertToRingAndCollapse(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ImportDeformerWeights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FlowPathObjectOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def viewHeadOn(*args, **kwargs)->None:
"""
The viewHeadOn command positions the specified camera so it is looking "down" the normal of
the live object, and fitted to the live object If the live object is a surface, an
arbitrary normal is chosen
:returns:
"""
pass
def ikHandle(*args, autoPriority: bool=True, connectEffector: bool=True, createCurve: bool=True,
createRootAxis: bool=True, curve: Union[name, bool]=None, disableHandles:
bool=True, enableHandles: bool=True, endEffector: Union[AnyStr, bool]="", exists:
AnyStr="", forceSolver: bool=True, freezeJoints: bool=True, jointList: bool=True,
name: Union[AnyStr, bool]="", numSpans: int=0, parentCurve: bool=True,
positionWeight: Union[float, bool]=0.0, priority: Union[int, bool]=0, rootOnCurve:
bool=True, rootTwistMode: bool=True, setupForRPsolver: bool=True, simplifyCurve:
bool=True, snapCurve: bool=True, snapHandleFlagToggle: bool=True,
snapHandleToEffector: bool=True, solver: Union[AnyStr, bool]="", startJoint:
Union[AnyStr, bool]="", sticky: Union[AnyStr, bool]="", twistType: Union[AnyStr,
bool]="", weight: Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
The handle command is used to create, edit, and query a handle within Maya The standard
edit (-e) and query (-q) flags are used for edit and query functions If there are 2
joints selected and neither -startJoint nor -endEffector flags are not specified, then the
handle will be created from the selected joints If a single joint is selected and
:param autoPriority: (E) Specifies that this handle's priority is assigned automatically
The assigned priority will be based on the hierarchy distance from the root of the s
:param connectEffector: (C E) This option is set to true as default, meaning that
end-effector translate is connected with the endJoint translate
:param createCurve: (C) Specifies if a curve should automatically be created for the
ikSplineHandle
:param createRootAxis: (C) Specifies if a root transform should automatically be created
above the joints affected by the ikSplineHandle This option is used to prevent the roo
:param curve: (C Q E) Specifies the curve to be used by the ikSplineHandle Joints will be
moved to align with this curve This flag is mandatory if you use the -freezeJoi
:param disableHandles: (E) set given handles to full fk (ikBlend attribute = 0.0)
:param enableHandles: (E) set given handles to full ik (ikBlend attribute = 1.0)
:param endEffector: (C Q E) Specifies the end-effector of the handle's joint chain The end
effector may be specified with a joint or an end-effector If a joint is specified, a
:param exists: (E) Indicates if the specified handle exists or not
:param forceSolver: (C Q E) Forces the solver to be used everytime It could also be known
as animSticky So, after you set the first key the handle is sticky
:param freezeJoints: (C E) Forces the curve, specfied by -curve option, to align itself
along the existing joint chain When false, or unspecified, the joints will be moved to
:param jointList: (E) Returns the list of joints that the handle is manipulating
:param name: (C Q E) Specifies the name of the handle
:param numSpans: (C) Specifies the number of spans in the automatically generated curve of
the ikSplineHandle
:param parentCurve: (C) Specifies if the curve should automatically be parented to the
parent of the first joint affected by the ikSplineHandle
:param positionWeight: (C Q E) Specifies the position/orientation weight of a handle This
is used to compute the "distance" between the goal position and the end-effector position
:param priority: (C Q E) Sets the priority of the handle Logically, all handles with a
lower number priority are solved before any handles with a higher numbered priority (
:param rootOnCurve: (C Q E) Specifies if the root is locked onto the curve of the
ikSplineHandle
:param rootTwistMode: (C Q E) Specifies whether the start joint is allowed to twist or not
If not, then the required twist is distributed over the remaining joints This applies
:param setupForRPsolver: (E) If the flag is set and ikSolver is ikRPsolver, call
RPRotateSetup for the new ikHandle It is for ikRPsolver only
:param simplifyCurve: (C) Specifies if the ikSplineHandle curve should be simplified
:param snapCurve: (C) Specifies if the curve should automatically snap to the first joint
affected by the ikSplineHandle
:param snapHandleFlagToggle: (C Q E) Specifies that the handle position should be snapped
to the end-effector position if the end-effector is moved by the user Setting this flag on
allo
:param snapHandleToEffector: (E) All handles are immediately moved so that the handle
position and orientation matches the end-effector position and orientation
:param solver: (C Q E) Specifies the solver The complete list of available solvers may not
be known until run-time because some of the solvers may be implemented as plug-i
:param startJoint: (C Q E) Specifies the start joint of the handle's joint chain
:param sticky: (C Q E) Specifies that this handle is "sticky" Valid values are "off",
"sticky", "superSticky" Sticky handles are solved when the skeleton is being manipul
:param twistType: (C Q E) Specifies the type of interpolation to be used by the
ikSplineHandle The interpolation options are "linear", "easeIn", "easeOut", and
"easeInOut"
:param weight: (C Q E) Specifies the handles weight in error calculations The weight only
applies when handle goals are in conflict and cannot be solved simultaneously Wh
:returns: Command result
"""
pass
def mrMapVisualizer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_GoToMarketPlace(*args, **kwargs)->None:
"""
"""
pass
def VertexNormalEditTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def typeManipContextCommand(*args, **kwargs)->None:
"""
"""
pass
def SelectHullsMask(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def renderWindowSelectContext(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Set the selection context for the render view panel
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:returns: Context name
"""
pass
def dR_showAbout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def addDynamicAttribute(*args, **kwargs)->None:
"""
"""
pass
def error(*args, noContext: bool=True, showLineNumber: bool=True, **kwargs)->None:
"""
The error command is provided so that the user can issue error messages from his/her
scripts and control execution in the event of runtime errors The string argument is
displayed in the command window (or stdout if running in batch mode) after being prefixed
with an error message heading and surrounded by // The error command also causes
execut
:param noContext: (C) Do not include the context information with the error message
:param showLineNumber: (C) Obsolete Will be deleted in the next version of Maya Use the
checkbox in the script editor that enables line number display instead
:returns:
"""
pass
def MirrorPolygonGeometryOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowHotbox(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def defineVirtualDevice(*args, axis: int=0, channel: AnyStr="", clear: bool=True, create:
bool=True, device: AnyStr="", parent: AnyStr="", undefine: bool=True,
usage: AnyStr="", q=True, query=True, **kwargs)->Union[None, Any]:
"""
This command defines a virtual device Virtual devices act like real devices and are useful
to manipulate/playback data when an command device is not connected to the computer
:param axis: (C) Specifies the axis number of the channel All children have their axis
number determined by their parent's axis number and the width of the parent ch
:param channel: (C) After a -create is started, channels may be added to the device
definition The channel string wil be the name of the channel being added to the devi
:param clear: (C) The -clear option will end a device definition and throw away any defined
channels
:param create: (C) Start defining a virtual device If a device is currently being defined,
the -create flag will produce an error
:param device: (C) The -device flag ends the device definition All of the channels between
the -create flag and the -device flag are added to the specified device If
:param parent: (C) Specified the parent channel of the channel being defined If the
channel does not exist, or is an incompatible type, the command will fail
:param undefine: (C) Undefines the device specified with the -device flag
:param usage: (C) rotZ
:returns:
"""
pass
def LayerRelationshipEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmSplinePreset(*args, **kwargs)->None:
"""
"""
pass
def CurveFlowOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def savePrefObjects(*args, **kwargs)->bool:
"""
This command saves preference dependency nodes to "userPrefObjects.ma" in the user
preference directory
:returns: True if successful.
"""
pass
def xgmSmoothBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def DopeSheetEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleOppositeFlagOfSelectedShapes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmGroomTransfer(*args, **kwargs)->None:
"""
"""
pass
def xgmMakeGuideDynamic(*args, **kwargs)->None:
"""
"""
pass
def CVHardness(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonTorusOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmCreateSplineDescription(*args, **kwargs)->None:
"""
"""
pass
def TimeEditorCreateOverrideLayer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RenderLayerRelationshipEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_modePoly(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyForceUV(*args, cameraProjection: bool=True, createNewMap: bool=True, flipHorizontal:
bool=True, flipVertical: bool=True, g: bool=True, local: bool=True, normalize:
AnyStr="", numItems: int=0, preserveAspectRatio: bool=True, unitize: bool=True,
unshare: bool=True, uvSetName: AnyStr="", **kwargs)->bool:
"""
A set of functionalities can be called through this command The input for this command is
a set of faces Based on the arguments passed, the UVs for these selected faces can be
created
:param cameraProjection: (C) Project the UVs based on the camera position/orientation
:param createNewMap: (C) Create new map if it does not exist
:param flipHorizontal: (C) OBSOLETE flag Use polyFlipUV instead
:param flipVertical: (C) OBSOLETE flag Use polyFlipUV instead
:param g: (C) OBSOLETE flag
:param local: (C) OBSOLETE flag
:param normalize: (C) OBSOLETE flag Use polyNormalizeUV instead
:param numItems: (C) This flag is only used for the best plane texturing of polygonal faces
This flag should be followed by a selection list If not specified, the selec
:param preserveAspectRatio: (C) OBSOLETE flag
:param unitize: (C) To unitize the UVs of the selected faces
:param unshare: (C) To unshare tye specified UV
:param uvSetName: (C) Specifies name of the uv set to work on
:returns: true/false
"""
pass
def SelectEdgeLoop(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PlaybackBackward(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hardwareRenderPanel(*args, camera: Union[AnyStr, bool]="", control: bool=True, copy:
AnyStr="", createString: bool=True, defineTemplate: AnyStr="", docTag:
Union[AnyStr, bool]="", editString: bool=True, exists: bool=True,
glRenderEditor: bool=True, init: bool=True, isUnique: bool=True, label:
Union[AnyStr, bool]="", menuBarRepeatLast: bool=True, menuBarVisible:
bool=True, needsInit: bool=True, parent: AnyStr="", popupMenuProcedure:
Union[Script, bool]=None, replacePanel: AnyStr="", tearOff: bool=True,
tearOffCopy: AnyStr="", tearOffRestore: bool=True, unParent: bool=True,
useTemplate: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates, edit and queries hardware render panels which contain only a hardware
render editor
:param camera: (Q E) Query or edit the camera in a gl render panel
:param control: (Q) Returns the top level control for this panel Usually used for getting
a parent to attach popup menus CAUTION: panels may not have controls at times
:param copy: (E) Makes this panel a copy of the specified panel Both panels must be of the
same type
:param createString: (E) Command string used to create a panel
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the Maya panel
:param editString: (E) Command string used to edit a panel
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param glRenderEditor: (Q) Query only This flag returns the name of the gl render editor
contained in the panel
:param init: (C E) Initializes the panel's default state This is usually done
automatically on file -new and file -open
:param isUnique: (Q) Returns true if only one instance of this panel type is allowed
:param label: (Q E) Specifies the user readable label for the panel
:param menuBarRepeatLast: (C Q E) Controls whether clicking on the menu header with the
middle mouse button would repeat the last selected menu item
:param menuBarVisible: (C Q E) Controls whether the menu bar for the panel is displayed
:param needsInit: (Q E) (Internal) On Edit will mark the panel as requiring initialization
Query will return whether the panel is marked for initialization Used during fil
:param parent: (C) Specifies the parent layout for this panel
:param popupMenuProcedure: (Q E) Specifies the procedure called for building the panel's
popup menu(s) The default value is "buildPanelPopupMenu" The procedure should take one
stri
:param replacePanel: (E) Will replace the specified panel with this panel If the target
panel is within the same layout it will perform a swap
:param tearOff: (Q E) Will tear off this panel into a separate window with a paneLayout as
the parent of the panel When queried this flag will return if the panel has bee
:param tearOffCopy: (C) Will create this panel as a torn of copy of the specified source
panel
:param tearOffRestore: (C E) Restores panel if it is torn off and focus is given to it If
docked, becomes the active panel in the docked window This should be the default flag
:param unParent: (E) Specifies that the panel should be removed from its layout This
(obviously) cannot be used with query
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: Panel name
"""
pass
def cMuscleRayIntersect(*args, **kwargs)->None:
"""
"""
pass
def ToggleBackfaceCulling(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyPyramid(*args, axis: Union[List[float, float, float], bool]=None, caching: bool=True,
constructionHistory: bool=True, createUVs: Union[int, bool]=2, name: AnyStr="",
nodeState: Union[int, bool]=0, numberOfSides: Union[int, bool]=4,
numderOfSides: Union[int, bool]=4, object: bool=True, sideLength: Union[float,
bool]=1.0, subdivisionsCaps: Union[int, bool]=0, subdivisionsHeight: Union[int,
bool]=1, texture: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The pyramid command creates a new polygonal pyramid
:param axis: (C Q E) This flag specifies the primitive axis used to build the pyramid Q:
When queried, this flag returns a float[3]
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createUVs: (C Q E) Create UVs or not 0: No UVs 1: No Normalization 2: Normalize 3:
Normalize and Preserve Aspect Ratio Default: 2
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param numberOfSides: (C Q E) Number of sides of Pyramid Default: 4
:param numderOfSides: (C Q E) Number of sides of Pyramid Default: 4
:param object: (C) Create the result, or just the dependency node (where applicable)
:param sideLength: (C Q E) Side length of the Pyramid Default: 1.0
:param subdivisionsCaps: (C Q E) Subdivisions on bottom cap Default: 0
:param subdivisionsHeight: (C Q E) Subdivisions along the height Default: 1
:param texture: (C Q E) Apply texture or not Default: true
:returns: Object name and node name.
"""
pass
def PixelMoveRight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def alignCtx(*args, align: bool=True, anchorFirstObject: bool=False, distribute: bool=True,
exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name: AnyStr="",
showAlignTouch: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
The alignCtx command creates a tool for aligning and distributing objects
:param align: (C Q E) Align objects
:param anchorFirstObject: (C Q E) Anchor first or last selected object Default false Only
applicable when aligning objects
:param distribute: (C Q E) Distribute objects
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param showAlignTouch: (C Q E) Show or hide align touching handles Default true Only
applicable when aligning objects
:returns: (name of the new context)
"""
pass
def paint3d(*args, **kwargs)->None:
"""
"""
pass
def FBXImportCameras(*args, **kwargs)->None:
"""
"""
pass
def geometryDeleteCacheFramesOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetProperty2StateAttrNameFromHIKEffectorId(*args, **kwargs)->None:
"""
"""
pass
def RemoveSubdivProxyMirrorOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleFocalLength(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def menuSetPref(*args, exists: bool=True, force: bool=True, loadAll: bool=True, removeAll:
bool=True, saveAll: bool=True, saveBackup: bool=True, version: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Provides the functionality to save and load menuSets between sessions of Maya For Internal
Use Only!
:param exists: (Q) Returns whether the menuSet preferences file exists or not
:param force: (C E) Forces a specified operation to continue even if errors are encountered
(such as invalid preferences)
:param loadAll: (C) Loads all the menuSets from the preferences file only if the
preferences version matches, or the -force flag is enabled On successful load, of a pre
:param removeAll: (C) Removes all the menuSets from the preferences file (removes the whole
file)
:param saveAll: (C) Saves all the current menuSets into the preferences file
:param saveBackup: (C) Saves a backup of the current menu set preferences file if one
exists This backup will be saved in the same location as the current preferences file
:param version: (Q) The base version string which is saved out to file It is also checked
upon loading in order to indicate changes in the default prefs since the prefs
:returns:
"""
pass
def greaseRenderPlane(*args, **kwargs)->None:
"""
"""
pass
def polyCutUVCtx(*args, loopSpeed: Union[int, bool]=0, mapBordersColor: Union[List[float, float,
float], bool]=None, showCheckerMap: bool=True, showTextureBorders: bool=True,
showUVShellColoring: bool=True, steadyStroke: bool=True, steadyStrokeDistance:
Union[float, bool]=0.0, symmetry: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[bool, Any]:
"""
Create a new context to cut UVs on polygonal objects
:param loopSpeed: (Q E) Edit the speed of loop cutting
:param mapBordersColor: (Q E) Color of UV map border edges in 3d view
:param showCheckerMap: (Q E) Display checker map
:param showTextureBorders: (Q E) Display texture border edges
:param showUVShellColoring: (Q E) Turn on UV shell coloring or not
:param steadyStroke: (Q E) Turn on steady stroke or not
:param steadyStrokeDistance: (Q E) The distance for steady stroke
:param symmetry: (Q E) Symmetric modeling
:returns: Whether steady stroke is on or not, when querying the steadyStroke flag.
"""
pass
def HideLattices(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def extrude(*args, caching: bool=True, degreeAlongLength: Union[int, bool]=1, direction:
Union[List[float, float, float], bool]=None, directionX: Union[float, bool]=0,
directionY: Union[float, bool]=1, directionZ: Union[float, bool]=0, extrudeType:
Union[int, bool]=2, fixedPath: bool=False, length: Union[float, bool]=1, nodeState:
Union[int, bool]=0, pivot: Union[List[float, float, float], bool]=None,
reverseSurfaceIfPathReversed: bool=False, rotation: Union[float, bool]=0.0, scale:
Union[float, bool]=1.0, subCurveSubSurface: bool=False, useComponentPivot:
Union[int, bool]=0, useProfileNormal: bool=False, constructionHistory: bool=True,
mergeItems: bool=True, name: AnyStr="", object: bool=True, polygon: int=0, range:
bool=True, rebuild: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
This command computes a surface given a profile curve and possibly a path curve There are
three ways to extrude a profile curve The most basic method is called a "distance" extrude
where direction and length are specified No path curve is necessary in this case The
second method is called "flat" extrude This method sweeps the profile curve dow
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param degreeAlongLength: (C Q E) Surface degree along the distance when a distance extrude
is performed Default: 1
:param direction: (C Q E) The direction in which to extrude Use only for distance
extrudeType and useProfileNormal off
:param directionX: (C Q E) X of the direction Default: 0
:param directionY: (C Q E) Y of the direction Default: 1
:param directionZ: (C Q E) Z of the direction Default: 0
:param extrudeType: (C Q E) The extrude type (distance-0, flat-1, or tube-2) Default: 2
:param fixedPath: (C Q E) If true, the resulting surface will be placed at the path curve
Otherwise, the resulting surface will be placed at the profile curve Default: false
:param length: (C Q E) The distance to extrude Use only for distance extrudeType Default:
1
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pivot: (C Q E) The pivot point used for tube extrudeType
:param reverseSurfaceIfPathReversed: (C Q E) If true, extrude type is tube (2) and path has
been internally reversed then computed surface is reversed in the direction corresponding
to the path
:param rotation: (C Q E) Amount to rotate the profile curve as it sweeps along the path
curve Default: 0.0
:param scale: (C Q E) Amount to scale the profile curve as it sweeps along the path curve
Default: 1.0
:param subCurveSubSurface: (C Q E) If true, curve range on the path will get applied to the
resulting surface instead of cut before the extrude Default: false
:param useComponentPivot: (C Q E) Use closest endpoint of the path - 0, component pivot - 1
or the center of the bounding box of the profile - 2 Default: 0
:param useProfileNormal: (C Q E) If true, use the profile curve normal for the direction in
which to extrude Use only for distance or tube extrudeType Default: false
:param constructionHistory: (C) Turn the construction history on or off
:param mergeItems: (C) Merge component results where possible For example, instead of
returning a[1] and a[2], return a[1:2]
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:param range: (C) Force a curve range on complete input curve
:param rebuild: (C) Rebuild the input curve(s) before using them in the operation Use
nurbsCurveRebuildPref to set the parameters for the conversion
:returns: Object name and node name
"""
pass
def CreateMotionTrail(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nucleusGetnParticleExample(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonSoccerBall(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def convertUnit(*args, fromUnit: AnyStr="", toUnit: AnyStr="", **kwargs)->float:
"""
This command converts values between different units of measure The command takes a string,
because a string can incorporate unit names as well as values (see examples)
:param fromUnit: (C) The unit to convert from If not supplied, it is assumed to be the
system default The from unit may also be supplied as part of the value e.g 11.2m
:param toUnit: (C) The unit to convert to If not supplied, it is assumed to be the system
default
:returns: or string
"""
pass
def PaintOnPaintableObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def camera(*args, aspectRatio: Union[float, bool]=0.0, cameraScale: Union[float, bool]=0.0,
centerOfInterest: Union[float, bool]=0.0, clippingPlanes: bool=True, depthOfField:
bool=True, displayFieldChart: bool=True, displayFilmGate: bool=True,
displayFilmOrigin: bool=True, displayFilmPivot: bool=True, displayGateMask:
bool=True, displayResolution: bool=True, displaySafeAction: bool=True,
displaySafeTitle: bool=True, fStop: Union[float, bool]=0.0, farClipPlane:
Union[float, bool]=0.0, farFocusDistance: Union[float, bool]=0.0, filmFit:
Union[AnyStr, bool]="", filmFitOffset: Union[float, bool]=0.0, filmRollOrder:
Union[AnyStr, bool]="", filmRollValue: Union[float, bool]=0.0, filmTranslateH:
Union[float, bool]=0.0, filmTranslateV: Union[float, bool]=0.0, focalLength:
Union[float, bool]=0.0, focusDistance: Union[float, bool]=0.0, homeCommand:
Union[AnyStr, bool]="", horizontalFieldOfView: Union[float, bool]=0.0,
horizontalFilmAperture: Union[float, bool]=0.0, horizontalFilmOffset: Union[float,
bool]=0.0, horizontalPan: Union[float, bool]=0.0, horizontalRollPivot: Union[float,
bool]=0.0, horizontalShake: Union[float, bool]=0.0, journalCommand: bool=True,
lensSqueezeRatio: Union[float, bool]=0.0, lockTransform: bool=True, motionBlur:
bool=True, name: Union[AnyStr, bool]="", nearClipPlane: Union[float, bool]=0.0,
nearFocusDistance: Union[float, bool]=0.0, orthographic: bool=True,
orthographicWidth: Union[float, bool]=0.0, overscan: Union[float, bool]=0.0,
panZoomEnabled: bool=True, position: Union[List[float, float, float], bool]=None,
postScale: Union[float, bool]=0.0, preScale: Union[float, bool]=0.0, renderPanZoom:
bool=True, rotation: Union[List[float, float, float], bool]=None, shakeEnabled:
bool=True, shakeOverscan: Union[float, bool]=0.0, shakeOverscanEnabled: bool=True,
shutterAngle: Union[float, bool]=0.0, startupCamera: bool=True,
stereoHorizontalImageTranslate: Union[float, bool]=0.0,
stereoHorizontalImageTranslateEnabled: bool=True, verticalFieldOfView: Union[float,
bool]=0.0, verticalFilmAperture: Union[float, bool]=0.0, verticalFilmOffset:
Union[float, bool]=0.0, verticalLock: bool=True, verticalPan: Union[float, bool]=0.0,
verticalRollPivot: Union[float, bool]=0.0, verticalShake: Union[float, bool]=0.0,
worldCenterOfInterest: Union[List[float, float, float], bool]=None, worldUp:
Union[List[float, float, float], bool]=None, zoom: Union[float, bool]=0.0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
Create, edit, or query a camera with the specified properties The resulting camera can
be repositioned using the viewPlace command Many of the camera settings only affect the
resulting rendered image E.g the F/Stop, shutter speed, the film related options, etc
Scaling the camera icon does not change any camera properties
:param aspectRatio: (C Q E) The ratio of the film back width to the film back height
:param cameraScale: (C Q E) Scale the camera
:param centerOfInterest: (C Q E) Set the linear distance from the camera's eye point to the
center of interest
:param clippingPlanes: (C Q E) Activate manual clipping planes
:param depthOfField: (C Q E) Determines whether a depth of field calculation is performed
to give varying focus depending on the distance of the objects
:param displayFieldChart: (C Q E) Activate display of the video field chart when looking
through the camera
:param displayFilmGate: (C Q E) Activate display of the film gate icons when looking
through the camera
:param displayFilmOrigin: (C Q E) Activate the display of the film origin guide when
looking through the camera
:param displayFilmPivot: (C Q E) Activate display of the film pivot guide when looking
through the camera
:param displayGateMask: (C Q E) Display the gate mask, file or resolution, as a shaded area
to the edge of the viewport
:param displayResolution: (C Q E) Activate display of the current rendering resolution (as
defined in the render globals) when looking through the camera
:param displaySafeAction: (C Q E) Activate display of the video Safe Action guide when
looking through the camera
:param displaySafeTitle: (C Q E) Activate display of the video Safe Title guide when
looking through the camera
:param fStop: (C Q E) A real lens normally contains a diaphragm or other stop which blocks
some of the light that would otherwise pass through it This stop is usually app
:param farClipPlane: (C Q E) Specify the distance to the far clipping plane
:param farFocusDistance: (C Q E) Linear distance to the far focus plane
:param filmFit: (C Q E) This describes how the digital image (in pixels) relates to the
film back Since the film back is defined in terms of real numbers with some arbitrar
:param filmFitOffset: (C Q E) Since we know from the above that the digital image may not
match the film back exactly, we now have the question of how to position one relative to
:param filmRollOrder: (C Q E) Specifies how the roll is applied with respect to the pivot
value Rotate-Translate The film back is first rotated then translated by the pivot point
:param filmRollValue: (C Q E) This specifies that amount of rotation around the film back
The roll value is specified in degrees The rotation occurs around the specified pivot p
:param filmTranslateH: (C Q E) The horizontal film translation Values are normalized to
the viewing area
:param filmTranslateV: (C Q E) The vertical film translation Values are normalized to the
viewing area
:param focalLength: (C Q E) This is the distance along the lens axis between the lens and
the film plane when "focal distance" is infinitely large This is an optical property o
:param focusDistance: (C Q E) Set the focus at a certain distance in front of the camera
:param homeCommand: (C Q E) Specify the command to execute when "viewSet -home" is applied
to this camera All occurances of "%camera" will be replaced with the cameras name bef
:param horizontalFieldOfView: (C Q E) This is the film back width as seen by the lens when
focused at infinity (ie., focal length away) measured as an angle Note that it has nothing
to d
:param horizontalFilmAperture: (C Q E) The horizontal width of the camera's film plane The
camera's film is located on the film plane The extent of the film which will be exposed to
an i
:param horizontalFilmOffset: (C Q E) Horizontal offset from the center of the film back
Normally the film back will be centered on the lens axis However, this need not be so
Film offs
:param horizontalPan: (C Q E) Horizontal 2D camera pan (inches)
:param horizontalRollPivot: (C Q E) The horizontal pivot point from the center of the film
back The pivot point is used during rotation of the film back The pivot is the point
where t
:param horizontalShake: (C Q E) Another horizontal offset from the center of the film back,
which can be used and stored on the camera in addition to the horizonal film offset attri
:param journalCommand: (C Q E) Journal interactive camera commands Commands can be undone
when a camera is journaled
:param lensSqueezeRatio: (C Q E) This is presently just an information field in the camera
editor is meant to convey the horizontal distortion of the anamorphic lens normally used
wi
:param lockTransform: (C Q E) Lock the camera When a camera is locked, its transformation
information, that is, its Translate and Rotate properties cannot be adjusted, and the ce
:param motionBlur: (C Q E) Determines whether the camera's image is motion blured (as
opposed to an object's image) For example, if you want to blur the camera movement when y
:param name: (C Q E) Name of the camera
:param nearClipPlane: (C Q E) Specify the distance to the NEAR clipping plane
:param nearFocusDistance: (C Q E) Linear distance to the near focus plane
:param orthographic: (C Q E) Activate the orthographic camera
:param orthographicWidth: (C Q E) Set the orthographic projection width
:param overscan: (C Q E) Set the percent of overscan
:param panZoomEnabled: (C Q E) Toggle camera 2D pan and zoom
:param position: (C Q E) Three linear values can be specified to translate the camera
:param postScale: (C Q E) The post-scale value This value multiplied against the computed
projection matrix It is applied after the the film roll
:param preScale: (C Q E) The pre-scale value The value is multiplied against the computed
projection matrix It is applied before the film roll
:param renderPanZoom: (C Q E) Toggle camera 2D pan and zoom in render
:param rotation: (C Q E) Three angular values can be specified to rotate the camera
:param shakeEnabled: (C Q E) Toggles the effect of the horizontal and vertical shake
attributes
:param shakeOverscan: (C Q E) Controls the amount of overscan in the output rendered image
For use when adding film-based camera shake Acts as a multiplier to the film aperture
:param shakeOverscanEnabled: (C Q E) Toggles the effect of the shake overscan attribute
:param shutterAngle: (C Q E) Specify the shutter angle (degrees)
:param startupCamera: (C Q E) A startup camera is marked undeletable and implicit This
flag can be used to set or query the startup state of a camera There must always be at
lea
:param stereoHorizontalImageTranslate: (C Q E) A film-back offset for use in stereo camera
rigs
:param stereoHorizontalImageTranslateEnabled: (C Q E) Toggles the effect of the stereo HIT
attribute
:param verticalFieldOfView: (C Q E) Set the vertical field of view
:param verticalFilmAperture: (C Q E) The vertical height of the camera's film plane This
double precision parameter is always specified in inches
:param verticalFilmOffset: (C Q E) Vertical offset from the center of the film back This
double precision parameter is always specified in inches
:param verticalLock: (C Q E) Lock the size of the vertical film aperture
:param verticalPan: (C Q E) Vertical 2D camera pan (inches)
:param verticalRollPivot: (C Q E) Vertical pivot point used for rotating the film back
This double precision parameter corresponds to the normalized viewport This value is used
to c
:param verticalShake: (C Q E) Vertical offset from the center of the film back See
horizontal shake attribute description This is toggled by the shake enabled attribute
:param worldCenterOfInterest: (C Q E) Camera world center of interest point
:param worldUp: (C Q E) Camera world up vector
:param zoom: (C Q E) The percent over the film viewable frustum to display
:returns: (transform name and shape name)
"""
pass
def ThreeRightSplitViewArrangement(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_DoCmd(*args, **kwargs)->None:
"""
"""
pass
def BrushAnimationMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SnapToPixel(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TexSculptInvertPin(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def IncreaseGammaFine(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleFkIk(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PickColorDeactivate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sampleImage(*args, fastSample: bool=True, resolution: List[int, name]=None,
**kwargs)->None:
"""
The sampleImage command is used to control parameters of sample images, such as swatches in
the multilister The fast option turns on or off some rendering cheats which speed up the
render but may cause edges to look ragged The resolution option specifies the width in
pixels of the image which will be rendered for the specified node Note that the
:param fastSample: (C) If fast but rough rendering for sampleImage is to be used
:param resolution: (C) The first argument to this flag specifies a resolution in pixels
The second argument specifies a dependency node The effect of this flag is that fu
:returns:
"""
pass
def ctxCompletion(*args, **kwargs)->None:
"""
This command tells the current context to finish what it is doing and create any objects
that is is working on
:returns:
"""
pass
def intSlider(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dragCommand:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float, float,
float], bool]=None, horizontal: bool=True, isObscured: bool=True, manage:
bool=True, maxValue: Union[int, bool]=0, minValue: Union[int, bool]=0,
noBackground: bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
statusBarMessage: AnyStr="", step: Union[int, bool]=0, useTemplate: AnyStr="",
value: Union[int, bool]=0, visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Create a slider control that accepts only integer values and is bound by a minimum and
maximum value The slider displays a marker indicating the current value of the slider
relative to its minimum and maximum values Click and drag the marker or on the slider
itself to change the current value
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the value changes This command is not
invoked when the value changes via the -v/value flag
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command executed when the value changes by dragging the slider's
value marker
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param horizontal: (C Q) Orientation of the slider This flag is true by default, which
corresponds to a horizontally oriented slider
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxValue: (C Q E) Upper limit of the slider
:param minValue: (C Q E) Lower limit of the slider
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) The step value represents the amount the value will increase or
decrease when you click either side of the slider
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Value of the slider
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def dR_increaseManipSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def iconTextRadioButton(*args, align: Union[AnyStr, bool]="", annotation: Union[AnyStr,
bool]="", backgroundColor: Union[List[float, float, float], bool]=None,
changeCommand: Union[Script, bool]=None, collection: AnyStr="",
defineTemplate: AnyStr="", disabledImage: Union[AnyStr, bool]="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, flat:
bool=True, flipX: bool=True, flipY: bool=True, font: Union[AnyStr,
bool]="", fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None,
highlightImage: Union[AnyStr, bool]="", image: Union[AnyStr, bool]="",
image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", imageOverlayLabel: Union[AnyStr, bool]="",
isObscured: bool=True, label: Union[AnyStr, bool]="", labelOffset:
Union[int, bool]=0, ltVersion: Union[AnyStr, bool]="", manage:
bool=True, marginHeight: Union[int, bool]=0, marginWidth: Union[int,
bool]=0, noBackground: bool=True, numberOfPopupMenus: bool=True,
offCommand: Union[Script, bool]=None, onCommand: Union[Script,
bool]=None, overlayLabelBackColor: Union[List[float, float, float,
float], bool]=None, overlayLabelColor: Union[List[float, float, float],
bool]=None, parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, rotation: Union[float, bool]=0.0, select:
bool=True, selectionHighlightImage: Union[AnyStr, bool]="",
selectionImage: Union[AnyStr, bool]="", statusBarMessage: AnyStr="",
style: Union[AnyStr, bool]="", useAlpha: bool=True, useTemplate:
AnyStr="", version: Union[AnyStr, bool]="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This control supports up to 3 icon images and 4 different display styles The icon image
displayed is the one that best fits the current size of the control given its current style
This command creates a iconTextRadioButton that is added to the most recently created
iconTextRadioCollection unless the -cl/cluster flag is used
:param align: (C Q E) The label alignment Alignment values are "left", "right", and
"center" By default, the label is aligned "center" Currently only available when -st
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C Q E) Command executed when the control's state is changed Note
that this flag should not be used in conjunction with onCommand and offCommand That is, o
:param collection: (C) To explicitly add the control to the specified collection
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param disabledImage: (C Q E) Image used when the button is disabled Image size must be
the same as the image specified with the i/image flag This is a Windows only flag
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param flat: (C Q E) Sets whether the control will be a flat button (0 false, 1 true)
:param flipX: (C Q E) Is the image flipped horizontally?
:param flipY: (C Q E) Is the image flipped vertically?
:param font: (C Q E) The font for the text Valid values are "boldLabelFont",
"smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont",
"oblique
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param highlightImage: (C Q E) Highlight image displayed while the cursor is over the
control Image size must be the same as the image specified with the -i/image flag This is
a
:param image: (C Q E) If you are not providing images with different sizes then you may use
this flag for the control's image If the "iconOnly" style is set, the icon wil
:param image1: (C Q E) First of three possible icons The icon that best fits the current
size of the control will be displayed
:param image2: (C Q E) Second of three possible icons The icon that best fits the current
size of the control will be displayed
:param image3: (C Q E) Third of three possible icons The icon that best fits the current
size of the control will be displayed
:param imageOverlayLabel: (C Q E) A short string, up to 6 characters, representing a label
that will be displayed on top of the image
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) The text that appears in the control
:param labelOffset: (C Q E) The label offset Default is 0 Currently only available when
-st/style is set to "iconAndTextCentered"
:param ltVersion: (C Q E) This flag is used to specify the Maya LT version that this
control feature was introduced, if the version flag is not specified, or if the version fl
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param marginHeight: (C Q E) The number of pixels above and below the control content The
default value is 1 pixel
:param marginWidth: (C Q E) The number of pixels on either side of the control content The
default value is 1 pixel
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param offCommand: (C Q E) Command executed when the control is turned off
:param onCommand: (C Q E) Command executed when the control is turned on
:param overlayLabelBackColor: (C Q E) The RGBA color of the shadow behind the label defined
by imageOverlayLabel Default is 50% transparent black: 0 0 0 .5
:param overlayLabelColor: (C Q E) The RGB color of the label defined by imageOverlayLabel
Default is a light grey: .8 .8 .8
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rotation: (C Q E) The rotation value of the image in radians
:param select: (C Q E) Will set this button as the selected one
:param selectionHighlightImage: (C Q E) Image displayed while the control is selected and
the cursor is over the control Image size must be the same as the image specified with the
-i/imag
:param selectionImage: (C Q E) Image displayed while the control is selected Image size
must be the same as the image specified with the -i/image flag This is a Windows only
flag
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param style: (C Q E) The draw style of the control Valid styles are "iconOnly",
"textOnly", "iconAndTextHorizontal", "iconAndTextVertical", and "iconAndTextCentered" (N
:param useAlpha: (C Q E) Is the image using alpha channel?
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param version: (C Q E) Specify the version that this control feature was introduced The
argument should be given as a string of the version number (e.g "2013", "2014") C
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the iconTextRadioButton created.
"""
pass
def OutlinerCollapseAllItems(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TensionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def layerButton(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, color: List[float, float,
float]=None, command: Script=None, current: bool=True, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", doubleClickCommand: Script=None,
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, hideOnPlaybackCommand:
Script=None, highlightColor: Union[List[float, float, float], bool]=None,
identification: Union[int, bool]=0, isObscured: bool=True, label: Union[AnyStr,
bool]="", labelWidth: bool=True, layerHideOnPlayback: bool=True, layerState:
Union[AnyStr, bool]="", layerVisible: bool=True, manage: bool=True, name:
Union[AnyStr, bool]="", noBackground: bool=True, numberOfPopupMenus: bool=True,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, renameCommand: AnyStr="", select: bool=True, statusBarMessage:
AnyStr="", transparent: bool=True, typeCommand: Script=None, useTemplate:
AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script, bool]=None,
visibleCommand: Script=None, width: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Creates a layer bar button widget This widget contains both the name of the layer to which
it refers and a color swatch indicating it's color assignment It is used primarily in the
construction of the layerBar and layer Editor window, being the widget used for each layer
in the respective lists
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Set the command to call on a change of any kind
:param color: (C E) Layer color, specified with normalized real numbers in R, G, B space
:param command: (C E) Set the command to call on a single click
:param current: (C E) Set this button to display as the current layer The current layer is
the one which the user has the option of adding all newly created objects into
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param doubleClickCommand: (C E) Set the command to call on a double click
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param hideOnPlaybackCommand: (C E) Command that is called when the hide on playback
indicator of the layer button is pressed
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param identification: (C Q E) This is the integer identification number associated with
the layer
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) Label text for the button
:param labelWidth: (Q) Query the width of the label part so as to determine if button
clicks are in the label part or the colour swatch part
:param layerHideOnPlayback: (C Q E) Indicates whether the layer is visible or invisible
during the playback
:param layerState: (C Q E) Describes the state of the layer This may be one of normal,
template, or reference
:param layerVisible: (C Q E) Indicates whether the layer is visible or invisible
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param name: (C Q) Name of the layer
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param renameCommand: (C E) Set the command to call when the layer gets renamed The string
'#1' will be substituted with the control's name and '#2' will be replaced with the l
:param select: (C Q E) Set this button to display as a selected layer
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param transparent: (C Q E) Indicate whether the layer color is visible or transparent
:param typeCommand: (C E) Command that is called when the type indicator of the layer
button is pressed
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param visibleCommand: (C E) Command that is called when the visibility indicator of the
layer button is pressed
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def SmoothingDisplayShowBoth(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def layeredShaderPort(*args, annotation: Union[AnyStr, bool]="", backgroundColor:
Union[List[float, float, float], bool]=None, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float,
float, float], bool]=None, isObscured: bool=True, manage: bool=True,
noBackground: bool=True, node: name=None, numberOfPopupMenus: bool=True,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, selectedColorControl: AnyStr="",
selectedTransparencyControl: AnyStr="", statusBarMessage: AnyStr="",
useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a 3dPort that displays an image representing the layered shader node
specified
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param node: (C) Specifies the name of the newLayeredShader node this port will represent
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param selectedColorControl: (C) Specifies the name of the UI-control that represents the
currently selected layer's color
:param selectedTransparencyControl: (C) Specifies the name of the UI-control that
represents the currently selected layer's transparency
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def createNurbsCircleCtx(*args, **kwargs)->None:
"""
"""
pass
def CreateSpring(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UniversalManip(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def visor(*args, addFolder: bool=True, addNodes: Union[AnyStr, bool]="", allowPanningInX:
bool=True, allowPanningInY: bool=True, allowZooming: bool=True, command: Union[AnyStr,
bool]="", deleteFolder: Union[AnyStr, bool]="", editFolder: Union[AnyStr, bool]="",
folderList: Union[AnyStr, bool]="", menu: Union[AnyStr, bool]="", name: Union[AnyStr,
bool]="", nodeType: Union[AnyStr, bool]="", openDirectories: bool=True, openFolder:
bool=True, parent: Union[AnyStr, bool]="", path: Union[AnyStr, bool]="",
popupMenuScript: Union[AnyStr, bool]="", rebuild: bool=True, refreshAllSwatches:
bool=True, refreshSelectedSwatches: bool=True, refreshSwatch: Union[AnyStr, bool]="",
reset: bool=True, restrictPanAndZoom: bool=True, saveSwatches: bool=True, scrollBar:
Union[AnyStr, bool]="", scrollPercent: Union[float, bool]=0.0, selectedGadgets:
Union[AnyStr, bool]="", showDividers: bool=True, showFiles: bool=True, showFolders:
bool=True, showNodes: bool=True, stateString: bool=True, style: Union[AnyStr,
bool]="", transform: Union[AnyStr, bool]="", type: Union[AnyStr, bool]="", q=True,
query=True, **kwargs)->Union[AnyStr, Any]:
"""
Command for the creation and manipulation of a Visor UI element The Visor is used to
display the contents of a scene (rendering related nodes in particular), as well as files
on disk which the user may wish to bring into the scene (shader and texture libraries for
example)
:param addFolder: (C Q) Add a new folder to the current visual browser
:param addNodes: (C Q) Add dependency graph nodes by name to a user defined custom folder
The argument is a string encolsed in quotes with 1 one more node names seperated
:param allowPanningInX: (C Q) Specifies whether or not the user should be able to pan the
contents of the visor horizontally Default is true
:param allowPanningInY: (C Q) Specifies whether or not the user should be able to pan the
contents of the visor vertically Default is true
:param allowZooming: (C Q) Specifies whether or not the user should be able to zoom the
contents of the visor Default is true
:param command: (C Q) Mel command which will return a list of nodes to add to a folder
:param deleteFolder: (C Q) Delete the specified folder and all of its children
:param editFolder: (C Q) Edit the name and MEL command for an existing folder
:param folderList: (Q) Return a string array of the folders in the visor
:param menu: (C Q) Set the name of the script to run to get a popup menu
:param name: (C Q) Name of the new folder
:param nodeType: (C Q) A node type used by folders of type nodeTypeInDAG
:param openDirectories: (C Q) When adding a new folder indicate if it sub directories will
be show The default is to not show sub directories
:param openFolder: (C Q) When adding a new folder indicate if it will be open or closed by
default The default is closed
:param parent: (C Q) Parent folder of this folder
:param path: (C Q) Path to a file system directory to be displayed in the folder
:param popupMenuScript: (C Q) Specifies the script to be called when the right mouse button
is pressed in the visor The name of the editor in which the right mouse button was pre
:param rebuild: (C Q) Rebuild the visor after interactively adding a folder
:param refreshAllSwatches: (C Q) Refresh the swatches of all files currently displayed in
this visor
:param refreshSelectedSwatches: (C Q) Refresh the swatches of all files currently selected
in any visor
:param refreshSwatch: (C Q) Refresh the swatch of the file with the specified path
:param reset: (C Q) Clear all previously loaded folder descriptions in preperation for
building a new visual browser
:param restrictPanAndZoom: (C Q) Specifies whether the panning and zooming of the visor
should be restricted to keep the contents in the top left corner of the visor when they are
sm
:param saveSwatches: (C Q) Save swatches to disk for currently displayed image files
:param scrollBar: (C Q) Set the name of the scroll bar associated with visor
:param scrollPercent: (C Q) Set the percentage value for the scroll bar Typically called
from a a scroll bars callback
:param selectedGadgets: (Q) Return a string array of the currently selected gadgets (files,
folders, nodes) in the visor
:param showDividers: (C Q) Specifies whether or not the visor should show dividers The
default is true If -showDividers is set to false, dividers will be drawn as folders ins
:param showFiles: (C Q) Specifies whether or not the visor should show files The default
is true
:param showFolders: (C Q) Specifies whether or not the visor should show folders The
default is true
:param showNodes: (C Q) Specifies whether or not the visor should show nodes The default
is true
:param stateString: (C Q) Return the MEL command string to save the folder setup in visor
:param style: (C Q) Set display style for the browser Options are: outliner A single
column with an outliner style icon and a text label singleColumn A single column wi
:param transform: (C Q) Name of a transform node used by folders of type nodeTypeInDAG
:param type: (C Q) Type of the new folder Options are: command A mel command that will
return a list of depend nodes that will be displayed in the folder connectedNode
:returns: Command result
"""
pass
def mateCtx(*args, **kwargs)->None:
"""
"""
pass
def soloMaterial(*args, attr: Union[AnyStr, bool]="", last: bool=True, node: Union[AnyStr,
bool]="", unsolo: bool=True, q=True, query=True, **kwargs)->Union[bool, Any]:
"""
Shows a preview of a specified material node output attribute
:param attr: (C Q) The attr flag specifies a node attribute to solo
:param last: (C Q) Whether to solo the last material node and attribute
:param node: (C Q) The node flag specifies the node to solo
:param unsolo: (C Q) Whether to remove soloing
:returns: Success or Failure
"""
pass
def CollapseSubdivSurfaceHierarchyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleCompIDs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nucleusDisplayTextureNodes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setKeyframeBlendshapeTargetWts(*args, **kwargs)->int:
"""
This command can be used to keyframe per-point blendshape target weights It operates on
the currently selected objects as follows When the base object is selected, then the
target weights are keyed for all targets When only target shapes are selected, then the
weights for thoses targets are keyframed
:returns: number of vertices for which the targets weights are keyed
"""
pass
def TanimLayer(*args, **kwargs)->None:
"""
"""
pass
def SubdivSmoothnessFine(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def softSelect(*args, compressUndo: Union[int, bool]=0, enableFalseColor: Union[int, bool]=0,
softSelectColorCurve: Union[AnyStr, bool]="", softSelectCurve: Union[AnyStr,
bool]="", softSelectDistance: Union[float, bool]=0.0, softSelectEnabled:
Union[int, bool]=0, softSelectFalloff: Union[int, bool]=0, softSelectReset:
bool=True, softSelectUVDistance: Union[float, bool]=0.0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This command allows you to change the soft modelling options Soft modelling is an option
that allows for reflection of basic manipulator actions such as move, rotate, and scale
:param compressUndo: (C Q E) Controls how soft selection settings behave in undo: 0 means
all changes undo individually 1 means all consecutive changes undo as a group 2 means on
:param enableFalseColor: (C Q E) Set soft select color feedback on or off When queried,
returns an int indicating whether color feedback is currently enabled
:param softSelectColorCurve: (C Q E) Sets the color ramp used to display false color
feedback for soft selected components in the viewport The color curve is encoded as a
string of comm
:param softSelectCurve: (C Q E) Sets the falloff curve used to calculate selection weights
for components within the falloff distance The curve is encoded as a string of comma sepa
:param softSelectDistance: (C Q E) Sets the falloff distance (radius) used for world and
object space soft selection When queried, returns a float indicating the current falloff
dista
:param softSelectEnabled: (C Q E) Sets soft selection based modeling on or off When
queried, returns an int indicating the current state of the option
:param softSelectFalloff: (C Q E) Sets the falloff mode: 0 for volume based falloff 1 for
surface based falloff 2 for global falloff When queried, returns an int indicating the
fallof
:param softSelectReset: (C E) Resets soft selection to its default settings
:param softSelectUVDistance: (C Q E) Sets the falloff distance (radius) used for UV space
soft selection When queried, returns a float indicating the current falloff distance
:returns:
"""
pass
def UnlockContainer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AlembicExportSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorCreatePoseClip(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def offsetCurveOnSurface(*args, caching: bool=True, checkPoints: Union[int, bool]=3,
connectBreaks: Union[int, bool]=2, cutLoop: bool=False, distance:
Union[float, bool]=1.0, nodeState: Union[int, bool]=0, stitch:
bool=True, subdivisionDensity: Union[int, bool]=5, tolerance:
Union[float, bool]=0.01, constructionHistory: bool=True, name:
AnyStr="", object: bool=True, range: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The offsetCurveOnSurface command offsets a curve on surface resulting in another curve on
surface The connecting type for breaks in offsets is off (no connection), circular
(connect with an arc) or linear (connect linearly resulting in a sharp corner) If loop
cutting is on then any loops in the offset curves are trimmed away and a sharp corner is
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param checkPoints: (C Q E) Checkpoints for fit quality per span Not advisable to change
this value Default: 3
:param connectBreaks: (C Q E) Connect breaks method (between gaps): 0 - off, 1 - circular,
2 - linear Default: 2
:param cutLoop: (C Q E) Do loop cutting Default: false
:param distance: (C Q E) Offset distance Default: 1.0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param stitch: (C Q E) Stitch curve segments together Not advisable to change this value
Default: true
:param subdivisionDensity: (C Q E) Maximum subdivision density per span Default: 5
:param tolerance: (C Q E) Tolerance Default: 0.01
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param range: (C) Force a curve range on complete input curve
:returns: Object name and node name
"""
pass
def AlembicExportSelectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteEdge(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshKnifeToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def minimizeApp(*args, **kwargs)->None:
"""
This command minimizes (iconifies) all of the application's windows into a single desktop
icon To restore the application click on the desktop icon
:returns:
"""
pass
def WaveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def effector(*args, hide: bool=True, name: Union[AnyStr, bool]="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The effector command is used to set the name or hidden flag for the effector The standard
edit (-e) and query (-q) flags are used for edit and query functions
:param hide: (C Q E) Specifies whether to hide drawing of effector if attached to a handle
:param name: (C Q E) Specifies the name of the effector
:returns: Command result
"""
pass
def devicePanel(*args, control: bool=True, copy: AnyStr="", createString: bool=True,
defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="", editString:
bool=True, exists: bool=True, init: bool=True, isUnique: bool=True, label:
Union[AnyStr, bool]="", menuBarRepeatLast: bool=True, menuBarVisible: bool=True,
needsInit: bool=True, parent: AnyStr="", popupMenuProcedure: Union[Script,
bool]=None, replacePanel: AnyStr="", tearOff: bool=True, tearOffCopy: AnyStr="",
tearOffRestore: bool=True, unParent: bool=True, useTemplate: AnyStr="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command is now obsolete It is included only for the purpose of file compatibility It
creates a blank panel
:param control: (Q) Returns the top level control for this panel Usually used for getting
a parent to attach popup menus CAUTION: panels may not have controls at times
:param copy: (E) Makes this panel a copy of the specified panel Both panels must be of the
same type
:param createString: (E) Command string used to create a panel
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the Maya panel
:param editString: (E) Command string used to edit a panel
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param init: (C E) Initializes the panel's default state This is usually done
automatically on file -new and file -open
:param isUnique: (Q) Returns true if only one instance of this panel type is allowed
:param label: (Q E) Specifies the user readable label for the panel
:param menuBarRepeatLast: (C Q E) Controls whether clicking on the menu header with the
middle mouse button would repeat the last selected menu item
:param menuBarVisible: (C Q E) Controls whether the menu bar for the panel is displayed
:param needsInit: (Q E) (Internal) On Edit will mark the panel as requiring initialization
Query will return whether the panel is marked for initialization Used during fil
:param parent: (C) Specifies the parent layout for this panel
:param popupMenuProcedure: (Q E) Specifies the procedure called for building the panel's
popup menu(s) The default value is "buildPanelPopupMenu" The procedure should take one
stri
:param replacePanel: (E) Will replace the specified panel with this panel If the target
panel is within the same layout it will perform a swap
:param tearOff: (Q E) Will tear off this panel into a separate window with a paneLayout as
the parent of the panel When queried this flag will return if the panel has bee
:param tearOffCopy: (C) Will create this panel as a torn of copy of the specified source
panel
:param tearOffRestore: (C E) Restores panel if it is torn off and focus is given to it If
docked, becomes the active panel in the docked window This should be the default flag
:param unParent: (E) Specifies that the panel should be removed from its layout This
(obviously) cannot be used with query
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: name of panel
"""
pass
def SelectAllBrushes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def StitchTogetherOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MediumQualityDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportQuaternion(*args, **kwargs)->None:
"""
"""
pass
def PaintOnViewPlane(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSplineCacheReplaceOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nucleusGetEffectsAsset(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def timeControl(*args, animCurveNames: bool=True, animLayerFilterOptions: Union[AnyStr,
bool]="", animLayerShowWeight: bool=True, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, beginScrub:
bool=True, currentFrameColor: List[float, float, float, float]=None,
defineTemplate: AnyStr="", displaySound: bool=True, docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
endScrub: bool=True, exists: bool=True, forceRedraw: bool=True, forceRefresh:
bool=True, foregroundColor: List[float, float, float]=None, fullPathName:
bool=True, globalTime: bool=True, greasePencilSequenceNames: bool=True, height:
Union[int, bool]=0, highlightColor: Union[List[float, float, float], bool]=None,
isObscured: bool=True, mainListConnection: Union[AnyStr, bool]="", manage:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, pressCommand: Script=None,
preventOverride: bool=True, range: bool=True, rangeArray: bool=True,
rangeVisible: bool=True, releaseCommand: Script=None, repeatChunkSize:
Union[float, bool]=1.0, repeatOnHold: bool=True, resample: bool=True,
showGreaseFrames: Union[AnyStr, bool]="active", showKeys: Union[AnyStr,
bool]="active", showKeysCombined: bool=True, snap: bool=True, sound:
Union[AnyStr, bool]="", statusBarMessage: AnyStr="", tickSize: Union[int,
bool]=0, tickSpan: Union[int, bool]=0, useTemplate: AnyStr="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, waveform:
Union[AnyStr, bool]="top", width: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a control that can be used for changing current time,
displaying/editing keys, and displaying/scrubbing sound.
:param animCurveNames: (C Q) When "showKeys" is not "none", querying this flag will return
the names of all the animCurves for which keyframe ticks are being displayed Query ret
:param animLayerFilterOptions: (C Q E) Specifies whether a filter is to be applied when
displaying animation layers If so, the options can be "allAffecting" (no filter), "active"
(only th
:param animLayerShowWeight: (C Q E) Specifies or queries whether weights are to be shown
when displaying animation layers
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param beginScrub: (E) Set this widget up for sound scrubbing Subsequent changes to
current time will result in "sound scrubbing" behavior, until the "-endScrub" command i
:param currentFrameColor: (E) This flag is used to specify the rgba color of the current
frame overlay rectangle in the timeControl
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param displaySound: (Q E) Turn sound display off Query returns int
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param endScrub: (E) End sound scubbing for this widget This stops sound scrubbing
behavior and should be issued before any subsequent "-beginScrub" flags
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param forceRedraw: (C E) Force a redraw of the time control UI Similiar to forceRefresh
but does not rebuild key information
:param forceRefresh: (C E) Force a refresh of the time control UI
:param foregroundColor: (E) This flag is used to specify the rgb color of the vertical
lines and numeric text in the timeControl
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param globalTime: (C Q E) "true" means this widget controls and displays the global,
dependency graph time "false" means time changes here do NOT affect the dependency graph
:param greasePencilSequenceNames: (Q) Returns the names of all grease pencil sequences that
have frames being displayed in the time line Query returns string[]
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the time slider will use as its source of content The time slider will only display keys
for
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param pressCommand: (C E) script to run on mouse-down in this control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param range: (C Q) Returns string representing the currently highlighted range visible on
the time slider A range from 10 to 20 would be returned as "10:20" When ther
:param rangeArray: (C Q) Returns a float array representing the currently highlighted range
visible on the time slider A range from 10 to 20 would be returned as { 10.0, 20.
:param rangeVisible: (C Q) Returns true if a currently highlighted range is visible on the
time slider, false if no
:param releaseCommand: (C E) script to run on mouse-up in this control
:param repeatChunkSize: (Q E) How much sound (in the current time unit) is repeated when
-repeatOnHold is true Default is 1.0
:param repeatOnHold: (Q E) Repeat sound during mouse-down events
:param resample: (E) Resample the sound display to fit the widget
:param showGreaseFrames: (C Q E) "active" will show grease frames for the active camera
"none" shows no grease frames "all" will show all grease frames Default "active" Query
ret
:param showKeys: (C Q E) "active" will show tick marks for keyframes on all active objects
"none" shows no tick marks Any other name is taken as the name of a channel box w
:param showKeysCombined: (C Q E) This flag can be used in conjunction with the showKeys
flag to enable a combination of "active" + "channel box" behavior Specifically, if channel
bo
:param snap: (C Q E) "true" means this widget is constrained to having values that are
integers representing the current time unit. "false" means the current time indica
:param sound: (Q E) Name of audio depend node whose data should display in the
sound-display widget Query returns string
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param tickSize: (C Q E) Specifies the width of keyframe ticks drawn in the time slider
The value will be clamped to the range [1, 63]
:param tickSpan: (C Q E) Specifies the interval between keyframe ticks in the timeControl
For example, a value of 10, will place ticks at 0, 10, 20, etc
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param waveform: (Q E) Determines what part of the sound waveform to display, when
-displaySound is "true" Valid values are "top", "bottom", and "both" Default is "top"
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Name of created or edited control
"""
pass
def polySelectCtx(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", mode: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Create a new context to select polygon components
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param mode: (C Q E) Edge loop or Edge ring or Border edge mode
:returns:
"""
pass
def dR_activeHandleZ(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_activeHandleY(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddEdgeDivisionsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BendCurvesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AlignCameraToPolygon(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LatticeDeformKeysTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def timeEditorAnimSource(*args, addSource: AnyStr="", apply: bool=True, bakeToAnimSource:
AnyStr="", calculateTiming: bool=True, copyAnimation: bool=True,
drivenClips: bool=True, export: AnyStr="", isUnique: bool=True,
removeSource: AnyStr="", targetIndex: Union[AnyStr, bool]="", targets:
bool=True, addObjects: Union[AnyStr, bool]="", addRelatedKG: bool=True,
addSelectedObjects: bool=True, attribute: Union[AnyStr,
List[AnyStr]]="", exclusive: bool=True, importAllFbxTakes: bool=True,
importFbx: AnyStr="", importFbxTakes: AnyStr="", importMayaFile:
AnyStr="", importOption: AnyStr="", importPopulateOption: AnyStr="",
importedContainerNames: AnyStr="", includeRoot: bool=True,
populateImportedAnimSources: AnyStr="", poseClip: bool=True,
recursively: bool=True, removeSceneAnimation: bool=True,
showAnimSourceRemapping: bool=True, takeList: AnyStr="",
takesToImport: AnyStr="", type: Union[AnyStr, List[AnyStr], bool]="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Commands for managing animation sources
:param addSource: (E) Add single new target attribute with its animation
:param apply: (E) Connect anim source's animation directly to the target objects If the
Time Editor is not muted, connect to scene storage instead
:param bakeToAnimSource: (E) Create a new anim source with the same animation as this anim
source All non-curve inputs will be baked down, whereas curve sources will be shared
:param calculateTiming: (Q E) Adjust start/duration when adding/removing sources If query
it returns the [start,duration] pair
:param copyAnimation: (E) Copy animation when adding source
:param drivenClips: (Q) Return all clips driven by the given anim source
:param export: (E) Export given anim source and the animation curves to a specified Maya
file
:param isUnique: (Q) Return true if the anim source node is only driving a single clip
:param removeSource: (E) Remove single attribute
:param targetIndex: (Q) Get target index
:param targets: (Q) Get a list of all targets in this anim source
:param addObjects: (C Q E) Populate the given object(s) and their attributes to anim source
to Time Editor For multiple object, pass each name separated by semicolon In query
:param addRelatedKG: (C Q E) During population, determine if associated keying groups
should be populated or not Normally used for populating HIK By default the value is
false
:param addSelectedObjects: (C Q E) Populate the currently selected objects and their
attributes to anim source or Time Editor In query mode, return the number of attributes
that will
:param attribute: (C E M) Populate a specific attribute on a object
:param exclusive: (C E) Populate all types of animation sources which are not listed by
"type" Flag
:param importAllFbxTakes: (C) Import all FBX takes into the new anim sources (for
timeEditorAnimSource command) or new containers (for timeEditorClip command)
:param importFbx: (C) Import an animation from FBX file into the new anim source (for
timeEditorAnimSource command) or new container (for timeEditorClip command)
:param importFbxTakes: (C) Import multiple FBX takes (separated by semicolons) into the new
anim sources (for timeEditorAnimSource command) or new containers (for timeEditorCli
:param importMayaFile: (C) Import an animation from Maya file into the new anim sources
(for timeEditorAnimSource command) or new containers (for timeEditorClip command)
:param importOption: (E) Option for importing animation source Specify either 'connect' or
'generate' connect: Only connect with nodes already existing in the scene Import
:param importPopulateOption: (E) Option for population when importing
:param importedContainerNames: (C) Internal use only To be used along with
populateImportedAnimSources to specify names for the created containers
:param includeRoot: (C E) Populate transform (Translate, Rotate, Scale) of hierarchy root
nodes
:param populateImportedAnimSources: (C) Internal use only Populate the Time Editor with
clips using the Animation Sources specified (use ; as a delimiter for multiple anim
sources)
:param poseClip: (C) Populate as pose clip with current attribute values
:param recursively: (C E) Populate selection recursively, adding all the children
:param removeSceneAnimation: (C E) If true, remove animation from scene when creating clips
or anim sources Only Time Editor will drive the removed scene animation
:param showAnimSourceRemapping: (C) Show a remapping dialog when the imported anim source
attributes do not match the scene attributes
:param takeList: (C) Internal use only To be used along with populateImportedAnimSources
to specify the imported take names
:param takesToImport: (C) Internal use only To be used along with
populateImportedAnimSources to specify the imported take indices
:param type: (C Q E M) Only populate the specified type of animation source
:returns: Command result
"""
pass
def HypershadeToggleAttrFilter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportTangents(*args, **kwargs)->None:
"""
"""
pass
def CurveFilletOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def particleRenderInfo(*args, attrList: Union[int, bool]=0, attrListAll: bool=True, name:
Union[int, bool]=0, renderTypeCount: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This action provides information access to the particle render subclasses These are
derived from TdynRenderBase This action is used primarily by the Attribute Editor to
gather information about attributes used for rendering
:param attrList: (Q) Return the list of attributes used by this render type
:param attrListAll: (Q) Return a complete list of all render attributes used by the
particle object This also includes the per particle attributes
:param name: (Q) Return the name of the render subclass using the render type
:param renderTypeCount: (Q) Return the count of registered render classes for particle
:returns:
"""
pass
def cMuscleAbout(*args, **kwargs)->None:
"""
"""
pass
def sbs_GetGlobalTextureHeight(*args, **kwargs)->None:
"""
"""
pass
def MoveNormalToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PostInfinityCycle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ChangeNormalSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyOutput(*args, allValues: bool=True, color: bool=True, colorDesc: bool=True, edge:
bool=True, edgeFace: bool=True, face: bool=True, faceNorm: bool=True, force:
bool=True, group: bool=True, noOutput: bool=True, normDesc: bool=True,
outputFile: AnyStr="", triangle: bool=True, uvDesc: bool=True, uvValue:
bool=True, vert: bool=True, vertEdge: bool=True, vertNorm: bool=True,
**kwargs)->None:
"""
Dumps a description of internal memory representation of poly objects If no objects are
specified in the command line, then the objects from the active list are used If
information on the geometry in the history of a poly shape is desired, then the plug of
interest needs to be specified in the command line Default behaviour is to print only a
su
:param allValues: (C) Shortcut for setting all the flags above
:param color: (C) Prints the color per vertex In case of multiple sets, all sets are
printed
:param colorDesc: (C) Print the color per vertex description Each integer is an entry in
the color array
:param edge: (C) Print the edge description
:param edgeFace: (C) Prints the edge to face adjascency list Only available if the
information is already computed on the object
:param face: (C) Print the faces description
:param faceNorm: (C) Prints the normals per face Only available if the information is
already computed on the object
:param force: (C) Force evaluation of missing pieces before printing
:param group: (C) Print the groups of the object
:param noOutput: (C) Dont output any data Would be useful if you want to just evaluate the
data, for testing purposes
:param normDesc: (C) Prints the normals per vertex description Each integer is an entry in
the vertNorm array Only available if the information is already computed on t
:param outputFile: (C) Location of the output file
:param triangle: (C) Prints the triangles per face Only available if the information is
already computed on the object
:param uvDesc: (C) Print the UV description Each integer is an entry in the uvValue array
:param uvValue: (C) Prints the UV positions In case of multiple UV sets, all sets are
printed
:param vert: (C) Prints the vertex positions
:param vertEdge: (C) Prints the vertex to edge adjascency list Only available if the
information is already computed on the object
:param vertNorm: (C) Prints the normals per vertex Only available if the information is
already computed on the object
:returns:
"""
pass
def sbs_GetEnumValue(*args, **kwargs)->None:
"""
"""
pass
def FireOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorGhostTrackToggle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def format(*args, stringArg: Union[AnyStr, List[AnyStr]]="", **kwargs)->AnyStr:
"""
This command takes a format string, where the format string contains format specifiers The
format specifiers have a number associated with them relating to which parameter they
represent to allow for alternate ordering of the passed-in values for other languages by
merely changing the format string
:param stringArg: (C M) Specify the arguments for the format string
:returns: Command result
"""
pass
def swatchRefresh(*args, **kwargs)->bool:
"""
The swatchRefresh command causes image source node swatches to be refreshed on screen The
purpose of this command is to provide a mechanism to trigger a swatch refresh in cases that
are not subject to dirty propagation in the dependency graph This command only works with
imageSource-derived node types Invoking this command with no arguments will
:returns: true if all arguments are valid image source nodes and the operation succeded.
"""
pass
def PickWalkUp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateSubdivCone(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def colorManagementFileRules(*args, addRule: AnyStr="", colorSpace: Union[AnyStr, bool]="",
down: AnyStr="", evaluate: AnyStr="", extension: Union[AnyStr,
bool]="", listRules: bool=True, load: bool=True, moveUp: AnyStr="",
pattern: Union[AnyStr, bool]="", remove: AnyStr="",
restoreDefaults: bool=True, save: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This non-undoable action manages the list of rules that Maya uses to assign an initial
input color space to dependency graph nodes that read in color information from a file
Rules are structured in a chain of responsibility, from highest priority rule to lowest
priority rule, each rule matching a file path pattern and extension If a rule matches
:param addRule: (C E) Add a rule with the argument name to the list of rules, as the
highest-priority rule If this flag is used, the pattern, extension, and colorSpace fl
:param colorSpace: (C Q E) The input color space for the rule If the rule matches a file
path, this is the color space that is returned This color space must match an existin
:param down: (C E) Move the rule with the argument name down one position towards lower
priority
:param evaluate: (C E) Evaluates the list of rules and returns the input color space name
that corresponds to the argument file path
:param extension: (C Q E) The file extension for the rule is case insensitive
:param listRules: (C E) Returns an array of rule name strings, in order, from
lowest-priority (rule 0) to highest-priority (last rule in array)
:param load: (C E) Read the rules from Maya preferences Any existing rules are cleared
:param moveUp: (C E) Move the rule with the argument name up one position towards higher
priority
:param pattern: (C Q E) The file path pattern for the rule This is the substring to match
in the file path, expressed as a glob pattern: for example, '*' matches all files
:param remove: (C E) Remove the rule with the argument name from the list of rules
:param restoreDefaults: (C E) Restore the list of rules to the default ones only
:param save: (C E) Save the rules to Maya preferences
:returns:
"""
pass
def attributeName(*args, leaf: bool=True, long: bool=True, nice: bool=True, short: bool=True,
**kwargs)->AnyStr:
"""
This command takes one "node.attribute"-style specifier on the command line and returns
either the attribute's long, short, or nice name (The "nice" name, or UI name, is the name
used to display the attribute in Maya's interface, and may be localized when running Maya
in a language other than English.) If more than one "node.attribute" specifier i
:param leaf: (C) When false, shows parent multi attributes (like "controlPoints[2].xValue")
When true, shows only the leaf-level attribute name (like "xValue") Defa
:param long: (C) Returns names in "long name" format like "translateX"
:param nice: (C) Returns names in "nice name" format like "Translate X"
:param short: (C) Returns names in "short name" format like "tx"
:returns: Command result
"""
pass
def OptimzeUVsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Air(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleKeepWireCulling(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateBezierCurveToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EnableExpressions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateExpressionClip(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBoatLocatorOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def groupParts(*args, **kwargs)->None:
"""
"""
pass
def xgmBrushManip(*args, **kwargs)->None:
"""
"""
pass
def XgmSplineCacheCreate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeAutoSizeNodes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_scalePress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateNURBSTorusOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def rotate(*args, absolute: bool=True, centerPivot: bool=True, componentSpace: bool=True,
constrainAlongNormal: bool=True, deletePriorHistory: bool=True, euler: bool=True,
forceOrderXYZ: bool=True, objectCenterPivot: bool=True, objectSpace: bool=True,
orientAxes: List[float, float, float]=None, pivot: List[float, float, float]=None,
preserveChildPosition: bool=False, preserveGeometryPosition: bool=False, preserveUV:
bool=False, reflection: bool=True, reflectionAboutBBox: bool=True,
reflectionAboutOrigin: bool=True, reflectionAboutX: bool=True, reflectionAboutY:
bool=True, reflectionAboutZ: bool=True, reflectionTolerance: float=0.0, relative:
bool=True, rotateX: bool=True, rotateXY: bool=True, rotateXYZ: bool=True, rotateXZ:
bool=True, rotateY: bool=True, rotateYZ: bool=True, rotateZ: bool=True, symNegative:
bool=True, translate: bool=True, worldSpace: bool=True, xformConstraint: AnyStr="",
**kwargs)->None:
"""
The rotate command is used to change the rotation of geometric objects The rotation values
are specified as Euler angles (rx, ry, rz) The values are interpreted based on the current
working unit for Angular measurements Most often this is degrees The default behaviour,
when no objects or flags are passed, is to do a absolute rotate on each cur
:param absolute: (C) Perform an absolute operation
:param centerPivot: (C) Let the pivot be the center of the bounding box of all objects
:param componentSpace: (C) Rotate in local component space
:param constrainAlongNormal: (C) When true, transform constraints are applied along the
vertex normal first and only use the closest point when no intersection is found along the
nor
:param deletePriorHistory: (C) If true then delete the history prior to the current
operation
:param euler: (C) Modifer for -relative flag that specifies rotation values should be added
to current XYZ rotation values
:param forceOrderXYZ: (C) When true, euler rotation value will be understood in XYZ
rotation order not per transform node basis
:param objectCenterPivot: (C) Let the pivot be the center of the bounding box of each
object
:param objectSpace: (C) Perform rotation about object-space axis
:param orientAxes: (C) Euler axis for orientation
:param pivot: (C) Define the pivot point for the transformation
:param preserveChildPosition: (C) When true, transforming an object will apply an opposite
transform to its child transform to keep them at the same world-space position Default is
f
:param preserveGeometryPosition: (C) When true, transforming an object will apply an
opposite transform to its geometry points to keep them at the same world-space position
Default is f
:param preserveUV: (C) When true, UV values on rotated components are projected across the
rotation in 3d space For small edits, this will freeze the world space texture m
:param reflection: (C) To move the corresponding symmetric components also
:param reflectionAboutBBox: (C) Sets the position of the reflection axis at the geometry
bounding box
:param reflectionAboutOrigin: (C) Sets the position of the reflection axis at the origin
:param reflectionAboutX: (C) Specifies the X=0 as reflection plane
:param reflectionAboutY: (C) Specifies the Y=0 as reflection plane
:param reflectionAboutZ: (C) Specifies the Z=0 as reflection plane
:param reflectionTolerance: (C) Specifies the tolerance to findout the corresponding
reflected components
:param relative: (C) Perform a operation relative to the object's current position
:param rotateX: (C) Rotate in X direction
:param rotateXY: (C) Rotate in X and Y direction
:param rotateXYZ: (C) Rotate in all directions (default)
:param rotateXZ: (C) Rotate in X and Z direction
:param rotateY: (C) Rotate in Y direction
:param rotateYZ: (C) Rotate in Y and Z direction
:param rotateZ: (C) Rotate in Z direction
:param symNegative: (C) When set the component transformation is flipped so it is relative
to the negative side of the symmetry plane The default (no flag) is to transform
:param translate: (C) When true, the command will modify the node's translate attribute
instead of its rotateTranslate attribute, when rotating around a pivot other than t
:param worldSpace: (C) Perform rotation about global world-space axis
:param xformConstraint: (C) Apply a transform constraint to moving components none - no
constraint surface - constrain components to the surface edge - constrain components to
:returns:
"""
pass
def xgmCutBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def SetFullBodyIKKeysKeyToPin(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteTimeWarp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateBezierCurveTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MergeUV(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def buildBookmarkMenu(*args, editor: AnyStr="", type: AnyStr="", **kwargs)->None:
"""
This command handles building the "dynamic" Bookmark menu, to show all bookmarks ("sets")
of a specified type ("sets -text") menuName is the string returned by the "menu" command
:param editor: (C) Name of the editor which this menu belongs to
:param type: (C) Type of bookmark (sets -text) to display
:returns:
"""
pass
def MatchUVsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def flushIdleQueue(*args, **kwargs)->None:
"""
"""
pass
def SymmetrizeUVOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createCurveWarp(*args, **kwargs)->None:
"""
"""
pass
def SinglePerspectiveViewLayout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtrudeVertexOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SubdivSmoothnessHullOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EmitFromObjectOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetHairExample(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createNurbsTorusCtx(*args, **kwargs)->None:
"""
"""
pass
def dbpeek(*args, allObjects: bool=True, argument: Union[AnyStr, List[AnyStr], bool]="", count:
Union[int, bool]=0, evaluationGraph: bool=True, operation: Union[AnyStr, bool]="",
outputFile: Union[AnyStr, bool]="", q=True, query=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The dbpeek command is used to analyze the Maya data for information of interest See a
description of the flags for details on what types of things can be analyzed
:param allObjects: (C Q) Ignore any specified or selected objects and peek into all
applicable objects The definition of "allObjects" will vary based on the peek operation b
:param argument: (C Q M) Specify one or more arguments to be passed to the operation The
acceptable values for the argument string are documented in the flag to which they w
:param count: (C Q) Specify a count to be used by the test Different tests make different
use of the count, query the operation to find out how it interprets the value
:param evaluationGraph: (C Q) Ignore any nodes that are not explicitly part of the
evaluation graph Usually this means nodes that are affected either directly or indirectly
by an
:param operation: (C Q) Specify the peeking operation to perform The various operations
are registered at run time and can be listed by querying this flag without a value
:param outputFile: (C Q) Specify the location of a file to which the information is to be
dumped Default will return the value from the command Use the special names stdout
:returns: Query of operation yields a string array with available operations
"""
pass
def HypershadeOpenOutlinerWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MoveUVTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisableMemoryCaching(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleMultiColorFeedback(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyMergeEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def propModCtx(*args, animCurve: Union[AnyStr, bool]="", animCurveFalloff: Union[List[float,
float], bool]=None, animCurveParam: Union[AnyStr, bool]="", direction:
Union[List[float, float, float], bool]=None, exists: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", linear: Union[float, bool]=0.0, linearParam: Union[List[float, float],
bool]=None, nurbsCurve: Union[AnyStr, bool]="", powerCutoff: Union[float,
bool]=10.0, powerCutoffParam: Union[List[float, float], bool]=None, powerDegree:
Union[float, bool]=3, powerDegreeParam: Union[float, bool]=3, script:
Union[AnyStr, bool]="", scriptParam: Union[AnyStr, bool]="", type: Union[int,
bool]=1, worldspace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Controls the proportional move context
:param animCurve: (C Q E) Name of the anim curve to use as a drop-off curve Only the 0 ->
side of the curve will be used and the distance will be mapped to "seconds" The pro
:param animCurveFalloff: (C Q E) The profile of the curve will be used as the profile for
propmod function in both U and V This will be scaled in U, V according to the paramters
pro
:param animCurveParam: (C Q E) Name of the anim curve to use as a drop-off curve Only the
0 -> side of the curve will be used and the distance will be mapped to "seconds", where 1
:param direction: (C Q E) Direction along which to compute the distance for the distance
based drop-off functions The default is (1 1 1)
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param linear: (C Q E) If using linear drop-off function, this is its slope The default of
-0.1 means the point at the locator moves with it and the point 10 units away do
:param linearParam: (C Q E) If using parametric linear drop-off function, these specify its
limits along the U and V directions
:param nurbsCurve: (C Q E) Name of the nurbs curve to use as a drop-off curve The closest
point distance would be used as the drop off percentage
:param powerCutoff: (C Q E) If using the power drop-off function, this is its distance
cutoff value The default is 10.0
:param powerCutoffParam: (C Q E) If using the power drop-off function, these specify one of
it's limits, 0 for U, and 1 and V The default cutoff is 10.0
:param powerDegree: (C Q E) If using the power drop-off function, this is its degree The
default is 3
:param powerDegreeParam: (C Q E) If using the power drop-off function, this is its degree
The default is 3
:param script: (C Q E) The name of the script to use to compute the drop-off The script
takes 6 floats as input - first 3 are the position of the move locator, the next 3
:param scriptParam: (C Q E) The name of the script to use to compute the drop-off The
script takes 4 floats as input - first 2 are the parametric position of the move locator,
:param type: (C Q E) Choose the type for the drop-off function Legal values are 1 for
linear, 2 for power, 3 for script, 4 for anim curve The default is 1
:param worldspace: (C Q E) Set the space in which the tool works True for world space,
false for parametric space
:returns: Name of the new context created
"""
pass
def displayAffected(*args, q=True, query=True, **kwargs)->Union[int, Any]:
"""
Turns on/off the special coloring of objects that are affected by the objects that are
currently in the selection list If one of the curves in a loft were selected and this
feature were turned on, then the lofted surface would be highlighted because it is affected
by the loft curve
:returns: Affected display count
"""
pass
def marker(*args, attach: bool=True, detach: bool=True, frontTwist: Union[float, bool]=0,
orientationMarker: bool=True, positionMarker: bool=True, sideTwist: Union[float,
bool]=0, time: Union[time, bool]=None, upTwist: Union[float, bool]=0, valueU:
Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The marker command creates one or two markers, on a motion path curve, at the specified
time and location The optionnal string argument is the parent object name.
:param attach: (C) This flag specifies to attach the selected 3D position markers to their
parent geometry
:param detach: (C) This flag specifies to detach the selected position markers from their
parent geometry to the 3D space
:param frontTwist: (Q) This flag specifies the amount of twist angle about the front vector
for the marker Default is 0 When queried, this flag returns a angle
:param orientationMarker: (Q) This flag specifies creation of an orientation marker
Default is not set. When queried, this flag returns a boolean
:param positionMarker: (Q) This flag specifies creation of a position marker Default is
set When queried, this flag returns a boolean
:param sideTwist: (Q) This flag specifies the amount of twist angle about the side vector
for the marker Default is 0 When queried, this flag returns a angle
:param time: (Q) This flag specifies the time for the marker Default is the current time
When queried, this flag returns a time
:param upTwist: (Q) This flag specifies the amount of twist angle about the up vector for
the marker Default is 0 When queried, this flag returns a angle
:param valueU: (Q) This flag specifies the location of the position marker w.r.t the
parent geometry u parameterization Default is the value at current time When que
:returns: (name of the created markers)
"""
pass
def TogglePanelMenubar(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ClearInitialState(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowNURBSSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InitialFluidStatesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorGraphRemoveUnselected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyEditUV(*args, angle: Union[float, bool]=0.0, pivotU: Union[float, bool]=0.0, pivotV:
Union[float, bool]=0.0, relative: bool=True, rotateRatio: Union[float, bool]=1.0,
rotation: bool=True, scale: bool=True, scaleU: Union[float, bool]=0.0, scaleV:
Union[float, bool]=0.0, uValue: Union[float, bool]=0.0, uvSetName: Union[AnyStr,
bool]="", vValue: Union[float, bool]=0.0, q=True, query=True,
**kwargs)->Union[bool, Any]:
"""
Command edits uvs on polygonal objects When used with the query flag, it returns the uv
values associated with the specified components
:param angle: (C Q) Specifies the angle value (in degrees) that the uv values are to be
rotated by
:param pivotU: (C Q) Specifies the pivot value, in the u direction, about which the scale
or rotate is to be performed
:param pivotV: (C Q) Specifies the pivot value, in the v direction, about which the scale
or rotate is to be performed
:param relative: (C Q) Specifies whether this command is editing the values relative to the
currently existing values Default is true;
:param rotateRatio: (C Q) Specifies the ratio value that the uv values are to be rotated by
Default is 1.0
:param rotation: (C Q) Specifies whether this command is editing the values with rotation
values
:param scale: (C Q) Specifies whether this command is editing the values with scale values
:param scaleU: (C Q) Specifies the scale value in the u direction
:param scaleV: (C Q) Specifies the scale value in the v direction
:param uValue: (C Q) Specifies the value, in the u direction - absolute if relative flag is
false.
:param uvSetName: (C Q) Specifies the name of the uv set to edit uvs on If not specified
will use the current uv set if it exists
:param vValue: (C Q) Specifies the value, in the v direction - absolute if relative flag is
false.
:returns: Success or Failure.
"""
pass
def PaintRandom(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ReversePolygonNormals(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmBakeGuideVertices(*args, **kwargs)->None:
"""
"""
pass
def ToggleCameraNames(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def scale(*args, absolute: bool=True, centerPivot: bool=True, componentSpace: bool=True,
constrainAlongNormal: bool=True, deletePriorHistory: bool=True, distanceOnly:
bool=True, localSpace: bool=True, objectCenterPivot: bool=True, objectSpace:
bool=True, orientAxes: List[float, float, float]=None, pivot: List[float, float,
float]=None, preserveChildPosition: bool=False, preserveGeometryPosition: bool=False,
preserveUV: bool=False, reflection: bool=True, reflectionAboutBBox: bool=True,
reflectionAboutOrigin: bool=True, reflectionAboutX: bool=True, reflectionAboutY:
bool=True, reflectionAboutZ: bool=True, reflectionTolerance: float=0.0, relative:
bool=True, scaleX: bool=True, scaleXY: bool=True, scaleXYZ: bool=True, scaleXZ:
bool=True, scaleY: bool=True, scaleYZ: bool=True, scaleZ: bool=True, symNegative:
bool=True, worldSpace: bool=True, xformConstraint: AnyStr="", **kwargs)->None:
"""
The scale command is used to change the sizes of geometric objects The default behaviour,
when no objects or flags are passed, is to do a relative scale on each currently selected
object object using each object's existing scale pivot point
:param absolute: (C) Perform an absolute operation
:param centerPivot: (C) Let the pivot be the center of the bounding box of all objects
:param componentSpace: (C) Move in local component space
:param constrainAlongNormal: (C) When true, transform constraints are applied along the
vertex normal first and only use the closest point when no intersection is found along the
nor
:param deletePriorHistory: (C) If true then delete the history prior to the current
operation
:param distanceOnly: (C) Scale only the distance between the objects
:param localSpace: (C) Use local space for scaling
:param objectCenterPivot: (C) Let the pivot be the center of the bounding box of each
object
:param objectSpace: (C) Use object space for scaling
:param orientAxes: (C) Use the angles for the orient axes
:param pivot: (C) Define the pivot point for the transformation
:param preserveChildPosition: (C) When true, transforming an object will apply an opposite
transform to its child transform to keep them at the same world-space position Default is
f
:param preserveGeometryPosition: (C) When true, transforming an object will apply an
opposite transform to its geometry points to keep them at the same world-space position
Default is f
:param preserveUV: (C) When true, UV values on scaled components are projected along the
axis of scaling in 3d space For small edits, this will freeze the world space text
:param reflection: (C) To move the corresponding symmetric components also
:param reflectionAboutBBox: (C) Sets the position of the reflection axis at the geometry
bounding box
:param reflectionAboutOrigin: (C) Sets the position of the reflection axis at the origin
:param reflectionAboutX: (C) Specifies the X=0 as reflection plane
:param reflectionAboutY: (C) Specifies the Y=0 as reflection plane
:param reflectionAboutZ: (C) Specifies the Z=0 as reflection plane
:param reflectionTolerance: (C) Specifies the tolerance to findout the corresponding
reflected components
:param relative: (C) Perform a operation relative to the object's current position
:param scaleX: (C) Scale in X direction
:param scaleXY: (C) Scale in X and Y direction
:param scaleXYZ: (C) Scale in all directions (default)
:param scaleXZ: (C) Scale in X and Z direction
:param scaleY: (C) Scale in Y direction
:param scaleYZ: (C) Scale in Y and Z direction
:param scaleZ: (C) Scale in Z direction
:param symNegative: (C) When set the component transformation is flipped so it is relative
to the negative side of the symmetry plane The default (no flag) is to transform
:param worldSpace: (C) Use world space for scaling
:param xformConstraint: (C) Apply a transform constraint to moving components none - no
constraint surface - constrain components to the surface edge - constrain components to
:returns:
"""
pass
def Redo(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBifrostFoam(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Fire(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def affects(*args, type: AnyStr="", **kwargs)->AnyStr:
"""
This command returns the list of attributes on a node or node type which affect the named
attribute
:param type: (C) static node type from which to get 'affects' information
:returns: List of affected/affecting attributes
"""
pass
def LODGenerateMeshes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def softModContext(*args, **kwargs)->None:
"""
"""
pass
def graphDollyCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name:
AnyStr="", q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command can be used to create a dolly context for the graph editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Context name
"""
pass
def CreateVolumeLight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_extrudeRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def palettePort(*args, actualTotal: Union[int, bool]=0, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, changeCommand:
Script=None, colorEditable: bool=True, colorEdited: Script=None,
defineTemplate: AnyStr="", dimensions: Union[List[int, int], bool]=None,
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, editable: bool=True, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float, float,
float], bool]=None, hsvValue: Union[List[int, int, float, float, float],
bool]=None, isObscured: bool=True, manage: bool=True, noBackground: bool=True,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="", popupMenuArray:
bool=True, preventOverride: bool=True, redraw: bool=True, rgbValue:
Union[List[int, float, float, float], bool]=None, setCurCell: Union[int,
bool]=0, statusBarMessage: AnyStr="", topDown: bool=True, transparent:
Union[int, bool]=0, useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates an array of color cells It could be used to to store an retrieve some
colors you want to manage during your working session
:param actualTotal: (C Q) Set the actual number of palette entries This number must be
greater than zero, but not be greater than maximum number of palette entries defined by
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) This command string will be executed when a color in the
palette is changed
:param colorEditable: (C Q E) If true then the user can modify the current index's color
:param colorEdited: (C E) This command string will be executed when a color in the palette
is edited
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param dimensions: (C Q) Set the dimensions of the array
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editable: (C Q E) If true then the user can change the current color
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param hsvValue: (C Q E) Set a color for a given cell, using HSV format On query return
the color of the current cell
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param redraw: (C E) Forces a redraw of the array
:param rgbValue: (C Q E) Set a color for a given cell, using RGB format On query return
the color of the current cell
:param setCurCell: (C Q E) Set the current cell in the array to the given index Returns
the current cell when queried
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param topDown: (C) If this flag is true, it indicates that first entry should appear in
top left as opposed to the bottom left
:param transparent: (C Q E) Set a given cell to be the transparent color A cell value of
-1 indicates that no cell is transparent On query returns the current transparent cell
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the palettePort created
"""
pass
def freeFormFillet(*args, bias: Union[float, bool]=0.5, caching: bool=True, depth: Union[float,
bool]=0.5, nodeState: Union[int, bool]=0, positionTolerance: Union[float,
bool]=0.1, tangentTolerance: Union[float, bool]=0.1, constructionHistory:
bool=True, name: AnyStr="", object: bool=True, polygon: int=0, range:
bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
This command creates a free form surface fillet across two surface trim edges or isoparms
or curve on surface The fillet surface creation has blend controls in the form of bias and
depth The bias value scales the tangents at the two ends across the two selected curves
The depth values controls the curvature of the fillet across the two selected
:param bias: (C Q E) Bias value for fillet Default: 0.5
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param depth: (C Q E) Depth value for fillet Default: 0.5
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param positionTolerance: (C Q E) C(0) Tolerance For Filleted Surface creation Default:
0.1
:param tangentTolerance: (C Q E) G(1) continuity Tolerance For Filleted Surface creation
Default: 0.1
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:param range: (C) Force a curve range on complete input curve
:returns: Object name and node name
"""
pass
def dropoffLocator(*args, **kwargs)->List[AnyStr]:
"""
This command adds one or more dropoff locators to a wire curve, one for each selected curve
point The dropoff locators can be used to provide localized tuning of the wire deformation
about the curve point The arguments are two floats, the envelope and percentage, followed
by the wire node name and then by the curve point(s)
:returns: Locator name(s)
"""
pass
def vnn(*args, **kwargs)->None:
"""
"""
pass
def DeleteAllRigidConstraints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisplayShadingMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetPreferredAngleOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def evalDeferred(*args, evaluateNext: bool=True, list: bool=True, lowPriority: bool=True,
lowestPriority: bool=True, **kwargs)->List[AnyStr]:
"""
This command takes the string it is given and evaluates it during the next available idle
time It is useful for attaching commands to controls that can change or delete the control
:param evaluateNext: (C) Specified that the command to be executed should be ran with the
highest priority, ideally queued up next
:param list: (C) Return a list of the command strings that are currently pending on the
idle queue By default, it will return the list of commands for all priorities
:param lowPriority: (C) Specified that the command to be executed should be deferred with
the low priority That is, it will be executed whenever Maya is idle
:param lowestPriority: (C) Specified that the command to be executed should be deferred
with the lowest priority That is, it will be executed when no other idle events are sch
:returns: Command result
"""
pass
def messageLine(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True, exists:
bool=True, fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True, manage:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a message line where tool feedback is shown
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: : Full path name to the control.
"""
pass
def nurbsSelect(*args, borderSelection: bool=True, bottomBorder: bool=True, growSelection:
int=0, leftBorder: bool=True, rightBorder: bool=True, shrinkSelection: int=0,
topBorder: bool=True, **kwargs)->None:
"""
Performs selection operations on NURBS objects.
:param borderSelection: (C) Extract the border of the current CV selection
:param bottomBorder: (C) Selects the bottom border of the surface (V=0)
:param growSelection: (C) Grows the CV selection by the given number of CV
:param leftBorder: (C) Selects the left border of the surface (U=0)
:param rightBorder: (C) Selects the right border of the surface (U=MAX)
:param shrinkSelection: (C) Shrinks the CV selection by the given number of CV
:param topBorder: (C) Selects the top border of the patches (V=MAX)
:returns:
"""
pass
def geometryDeleteCacheFrames(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllNCloths(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySelectEditCtxDataCmd(*args, **kwargs)->None:
"""
"""
pass
def copyAttr(*args, attribute: Union[AnyStr, List[AnyStr]]="", containerParentChild: bool=True,
inConnections: bool=True, keepSourceConnections: bool=True, outConnections:
bool=True, renameTargetContainer: bool=True, values: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Given two nodes, transfer the connections and/or the values from the first node to the
second for all attributes whose names and data types match When values are transferred,
they are transferred directly They are not mapped or modified in any way The
transferAttributes command can be used to transfer and remap some mesh attributes The
attribut
:param attribute: (C M) The name of the attribute(s) for which connections and/or values
will be transferred If no attributes are specified, then all attributes will be tra
:param containerParentChild: (C) For use when copying from one container to another only
This option indicates that the published parent and/or child relationships on the original
c
:param inConnections: (C) Indicates that incoming connections should be transferred
:param keepSourceConnections: (C) For use with the outConnections flag only Indicates that
the connections should be maintained on the first node, in addition to making them to the
s
:param outConnections: (C) Indicates that outgoing connections should be transferred
:param renameTargetContainer: (C) For use when copying from one container to another only
This option will rename the target container to the name of the original container, and
rena
:param values: (C) Indicates that values should be transferred
:returns:
"""
pass
def nClothReplaceFramesOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetFluidExample(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ResampleCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetInitialState(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MediumPolygonNormals(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateNURBSCircleOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def WrinkleToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def detachCurve(*args, caching: bool=True, keep: Union[bool, List[bool]]=True, nodeState:
Union[int, bool]=0, parameter: Union[float, List[float], bool]=0.0,
constructionHistory: bool=True, curveOnSurface: bool=True, name: AnyStr="",
object: bool=True, replaceOriginal: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The detachCurve command detaches a curve into pieces, given a list of parameter values You
can also specify which pieces to keep and which to discard using the "-k" flag The names
of the newly detached curve(s) is returned If history is on, then the name of the
resulting dependency node is also returned You can use this command to open a perio
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param keep: (C Q E M) Whether or not to keep a detached piece This multi attribute should
be one element larger than the parameter multi attribute Default: true
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param parameter: (C Q E M) Parameter values to detach at Default: 0.0
:param constructionHistory: (C) Turn the construction history on or off
:param curveOnSurface: (C) If possible, create 2D curve as a result
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def insertKnotSurface(*args, addKnots: bool=True, caching: bool=True, direction: Union[int,
bool]=1, insertBetween: bool=False, nodeState: Union[int, bool]=0,
numberOfKnots: Union[int, List[int], bool]=1, parameter: Union[float,
List[float], bool]=0.0, constructionHistory: bool=True, name: AnyStr="",
object: bool=True, replaceOriginal: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The insertKnotSurface command inserts knots (aka isoparms) into a surface given a list of
parameter values The number of knots to add at each parameter value and whether the knots
are added or complemented can be specified The name of the surface is returned and if
history is on, the name of the resulting dependency node is also returned You mu
:param addKnots: (C Q E) Whether to add knots or complement Complement means knots will be
added to reach the specified number of knots Default: true
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param direction: (C Q E) Direction in which to insert knot: 0 - V direction, 1 - U
direction Default: 1
:param insertBetween: (C Q E) If set to true, and there is more than one parameter value
specified, the knots will get inserted at equally spaced intervals between the given param
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param numberOfKnots: (C Q E M) How many knots to insert Default: 1
:param parameter: (C Q E M) Parameter value(s) where knots are added Default: 0.0
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def dR_multiCutTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def deleteNclothCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MergeUVOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBIKReachKeyingOptionSimple(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NCreateEmitterOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def WeightedTangents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ParentBaseWire(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolygonCopyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmPlaceBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def CreateNURBSSquareOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CutUVsWithoutHotkey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PickWalkStopAtTransform(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyPinUV(*args, createHistory: bool=True, operation: Union[int, bool]=0, unpinned:
bool=True, uvSetName: Union[AnyStr, bool]="", value: Union[float, List[float],
bool]=0.0, q=True, query=True, e=True, edit=True, **kwargs)->Union[bool, Any]:
"""
This command is used to pin and unpin UVs A "pinned" UV is one which should not be
modified Each UV has an associated pin weight, that defaults to 0.0 meaning that the UV
is not pinned If pin weight is set to 1.0 then it becomes fully pinned and UV tools should
not modify that UV If the pin weight is set to a value between 0.0 and 1.0 then UV
:param createHistory: (C Q E) For objects that have no construction history, this flag can
be used to force the creation of construction history for pinning By default, history i
:param operation: (C Q E) Operation to perform Valid values are: 0: Set pin weights on the
selected UVs 1: Set pin weights to zero for the selected UVs 2: Remove pin weight
:param unpinned: (Q E) List all selected UVs which are not pinned
:param uvSetName: (C Q E) Specifies the name of the UV set to edit UVs on If not specified
the current UV set will be used if it exists
:param value: (C Q E M) Specifies the pin value for the selected UV components When
specified multiple times, the values are assigned respectively to the specified UVs
:returns: Success or Failure.
"""
pass
def dR_softSelDistanceTypeVolume(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectEdgeMask(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artSelect(*args, **kwargs)->None:
"""
"""
pass
def progressWindow(*args, endProgress: bool=True, isCancelled: bool=True, isInterruptable:
bool=True, maxValue: Union[int, bool]=0, minValue: Union[int, bool]=0,
progress: Union[int, bool]=0, status: Union[AnyStr, bool]="", step: int=0,
title: Union[AnyStr, bool]="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[bool, Any]:
"""
The progressWindow command creates a window containing a status message, a graphical
progress gauge, and optionally a "Hit ESC to Cancel" label for interruptable operations
Only one progress window is allowed on screen at a time While the window is visible, the
busy cursor is shown
:param endProgress: (C) Terminates the progress window No other flags can be used at the
same time This is normally issued through MEL in response to the -ic/isCancelled f
:param isCancelled: (Q) Returns true if the user has tried to cancel the operation Returns
false otherwise
:param isInterruptable: (C Q E) Returns true if the progress window should respond to
attempts to cancel the operation The cancel button is disabled if this is set to true
:param maxValue: (C Q E) The maximum or "ending" value of the progress indicator If the
progress value is greater than the -max/maxValue, the progress value will be set to t
:param minValue: (C Q E) The minimum or "starting" value of the progress indicator If the
progress value is less than the -min/minValue, the progress value will be set to th
:param progress: (C Q E) The amount of progress currently shown on the control The value
will always be between min and max Default is equal to the minimum when the control
:param status: (C Q E) The status text appearing above the progress gauge
:param step: (E) Increments the -pr/progress value by the amount specified
:param title: (C Q E) The window title
:returns: Returns true if the window was successfully
created, and false if the window
could not be created (possibly
because one is already showing).
"""
pass
def SubdivSurfacePolygonProxyMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AlignCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def manipRotateLimitsCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Create a context for the rotate limits manipulator
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Name of newly created context
"""
pass
def ogsRender(*args, activeMultisampleType: Union[AnyStr, bool]="", activeRenderOverride:
Union[AnyStr, bool]="", activeRenderTargetFormat: Union[AnyStr, bool]="",
availableFloatingPointTargetFormat: bool=True, availableMultisampleType:
bool=True, availableRenderOverrides: bool=True, camera: Union[AnyStr, bool]="",
currentFrame: bool=True, currentView: bool=True, enableFloatingPointRenderTarget:
bool=True, enableMultisample: bool=True, frame: float=0.0, height: Union[int,
bool]=0, layer: Union[name, bool]=None, noRenderView: bool=True, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[bool, Any]:
"""
Renders an image or a sequence using the OGS rendering engine
:param activeMultisampleType: (Q E) Query the current active multisample type
:param activeRenderOverride: (Q E) Set or query the current active render override
:param activeRenderTargetFormat: (Q E) Query the current active floating point target
format
:param availableFloatingPointTargetFormat: (Q E) Returns the names of available floating
point render target format
:param availableMultisampleType: (Q E) Returns the names of available multisample type
:param availableRenderOverrides: (Q E) Returns the names of available render overrides
:param camera: (C Q E) Specify the camera to use Use the first available camera if the
camera given is not found
:param currentFrame: (C Q E) Render the current frame
:param currentView: (C Q E) When turned on, only the current view will be rendered
:param enableFloatingPointRenderTarget: (Q E) Enable/disable floating point render target
:param enableMultisample: (Q E) Enable/disable multisample
:param frame: (C E) Specify the frame to render
:param height: (C Q E) The height flag pass the height to the ogsRender command If not
used, the height is taken from the render globals settings
:param layer: (C Q E) Render the specified render layer Only this render layer will be
rendered, regardless of the renderable attribute value of the render layer The lay
:param noRenderView: (C Q E) When turned on, the render view is not updated after image
computation
:param width: (C Q E) The width flag pass the width to the ogsRender command If not used,
the width is taken from the render globals settings
:returns: Query result
"""
pass
def ResolveInterpenetration(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PickWalkOut(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyTriangulate(*args, caching: bool=True, constructionHistory: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Triangulation breaks polygons down into triangles, ensuring that all faces are planar and
non-holed Triangulation of models can be beneficial in many areas
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def dR_convertSelectionToUV(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModifyUVVectorPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportUseSceneName(*args, **kwargs)->None:
"""
"""
pass
def ProfilerToolHideSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def shotTrack(*args, insertTrack: int=0, lock: bool=True, mute: bool=True, numTracks: Union[int,
bool]=0, removeEmptyTracks: bool=True, removeTrack: int=0, selfmute: bool=True,
solo: bool=True, swapTracks: List[int, int]=None, title: Union[AnyStr, bool]="",
track: Union[int, bool]=0, unsolo: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
This command is used for inserting and removing tracks related to the shots displayed in
the Sequencer It can also be used to modify the track state, for example, to lock or mute
a track
:param insertTrack: (C) This flag is used to insert a new empty track at the track index
specified
:param lock: (C Q E) This flag specifies whether shots on a track are to be locked or not
:param mute: (C Q E) This flag specifies whether shots on a track are to be muted or not
:param numTracks: (Q) To query the number of tracks
:param removeEmptyTracks: (C) This flag is used to remove all tracks that have no clips
:param removeTrack: (C) This flag is used to remove the track with the specified index The
track must have no clips on it before it can be removed
:param selfmute: (C Q E) This flag specifies whether shots on a track are to be muted or
not (unlike mute, this disregards soloing)
:param solo: (C Q E) This flag specifies whether shots on a track are to be soloed or not
:param swapTracks: (C) This flag is used to swap the contents of two specified tracks
:param title: (C Q E) This flag specifies the title for the track
:param track: (C Q E) Specify the track on which to operate by using the track's
trackNumber In query mode, this flag needs a value
:param unsolo: (Q) This flag specifies whether shots on a track are to be unsoloed or not
:returns:
"""
pass
def playbackOptions(*args, animationEndTime: Union[time, bool]=None, animationStartTime:
Union[time, bool]=None, blockingAnim: bool=True, by: Union[float, bool]=1.0,
framesPerSecond: bool=True, loop: Union[AnyStr, bool]="", maxPlaybackSpeed:
Union[float, bool]=0.0, maxTime: Union[time, bool]=None, minTime:
Union[time, bool]=None, playbackSpeed: Union[float, bool]=0.0, view:
Union[AnyStr, bool]="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command sets/queries certain values associated with playback: looping style, start/end
times, etc Only commands modifying the -minTime/maxTime, the
-animationStartTime/animationEndTime, or the -by value are undoable
:param animationEndTime: (C Q E) Sets the end time of the animation Query returns a float
:param animationStartTime: (C Q E) Sets the start time of the animation Query returns a
float
:param blockingAnim: (C Q) All tangents playback as stepped so that animation can be viewed
in pure pose-to-pose form
:param by: (C Q E) Increment between times viewed during playback (Default 1.0)
:param framesPerSecond: (C Q) Queries the actual playback rate Query returns a float
:param loop: (C Q E) Controls if and how playback repeats Valid values are "once,"
"continuous," and "oscillate." Query returns string
:param maxPlaybackSpeed: (C Q E) Sets the desired maximum playback speed Query returns a
float The maxPlaybackSpeed is only used by Maya when your playbackSpeed is 0 (play every
fr
:param maxTime: (C Q E) Sets the end of the playback time range Query returns a float
:param minTime: (C Q E) Sets the start of the playback time range Query returns a float
:param playbackSpeed: (C Q E) Sets the desired playback speed Query returns a float
:param view: (C Q E) Controls how many modelling views update during playback Valid values
are "all" and "active" Query returns a string
:returns: or float
Query of edited option.
"""
pass
def SmoothBindSkin(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ResetLattice(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def colorIndexSliderGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0,
adjustableColumn3: int=0, adjustableColumn4: int=0, adjustableColumn5:
int=0, adjustableColumn6: int=0, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None,
changeCommand: Script=None, columnAlign: Union[List[int, AnyStr],
List[List[int, AnyStr]]]=None, columnAlign2: List[AnyStr, AnyStr]=None,
columnAlign3: List[AnyStr, AnyStr, AnyStr]=None, columnAlign4:
List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign5: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign6: List[AnyStr, AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach: Union[List[int,
AnyStr, int], List[List[int, AnyStr, int]]]=None, columnAttach2:
List[AnyStr, AnyStr]=None, columnAttach3: List[AnyStr, AnyStr,
AnyStr]=None, columnAttach4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach5: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnOffset2: List[int, int]=None, columnOffset3:
List[int, int, int]=None, columnOffset4: List[int, int, int, int]=None,
columnOffset5: List[int, int, int, int, int]=None, columnOffset6:
List[int, int, int, int, int, int]=None, columnWidth: Union[List[int,
int], List[List[int, int]]]=None, columnWidth1: int=0, columnWidth2:
List[int, int]=None, columnWidth3: List[int, int, int]=None,
columnWidth4: List[int, int, int, int]=None, columnWidth5: List[int,
int, int, int, int]=None, columnWidth6: List[int, int, int, int, int,
int]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dragCommand: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, extraLabel:
Union[AnyStr, bool]="", forceDragRefresh: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float,
float, float], bool]=None, invisible: Union[int, bool]=0, isObscured:
bool=True, label: Union[AnyStr, bool]="", manage: bool=True, maxValue:
Union[int, bool]=0, minValue: Union[int, bool]=0, noBackground:
bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
rowAttach: Union[List[int, AnyStr, int], List[List[int, AnyStr,
int]]]=None, statusBarMessage: AnyStr="", useTemplate: AnyStr="",
value: Union[int, bool]=0, visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the value changes This command is not
invoked when the value changes via the -v/value flag
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command executed when the value changes by dragging the slider's
value marker
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param extraLabel: (C Q E) Sets the string to be the text for the extra label
:param forceDragRefresh: (C Q E) If used then force refresh on drag
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param invisible: (C Q E) Set the invisible color index
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) Label text for the group
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxValue: (C Q E) Maximum color index
:param minValue: (C Q E) Minimum color index
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Color index
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def dR_pointSnapPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SurfaceBooleanIntersectTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def curveAddPtCtx(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The curveAddPtCtx command creates a new curve add points context, which adds either control
vertices (CVs) or edit points to an existing curve
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:returns: (name of the new context)
"""
pass
def CloseFrontWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createDisplayLayer(*args, empty: bool=True, makeCurrent: bool=True, name: AnyStr="",
noRecurse: bool=True, number: int=0, **kwargs)->AnyStr:
"""
Create a new display layer The display layer number will be assigned based on the first
unassigned number not less than the base index number found in the display layer global
parameters Normally all objects and their descendants will be added to the new display
layer but if the '-nr' flag is specified then only the objects themselves will be add
:param empty: (C) If set then create an empty display layer ie Do not add the selected
items to the new display layer
:param makeCurrent: (C) If set then make the new display layer the current one
:param name: (C) Name of the new display layer being created
:param noRecurse: (C) If set then only add selected objects to the display layer Otherwise
all descendants of the selected objects will also be added
:param number: (C) Number for the new display layer being created
:returns: Name of display layer node that was created
"""
pass
def nClothCreate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSplinePresetExport(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleChannelBox(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllClusters(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PresetBlendingWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateShot(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExpandSelectedComponents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def querySubdiv(*args, action: int=0, level: int=0, relative: bool=True, **kwargs)->bool:
"""
Queries a subdivision surface based on a set of query parameters and updates the selection
list with the results
:param action: (C) Specifies the query parameter: 1 = find all tweaked verticies at level 2
= find all sharpened vertices at level 3 = find all sharpened edges at level
:param level: (C) Specify the level of the subdivision surface on which to perform the
operation
:param relative: (C) If set, level flag refers to the level relative to the current
component display level
:returns: Command result
"""
pass
def PolyCreaseToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Drag(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_extrudePress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtrudeEdge(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateNURBSSphere(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MakeBoats(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TransplantHair(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dagObjectHit(*args, **kwargs)->None:
"""
"""
pass
def AddSelectionAsInBetweenTargetShapeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_slideSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowStrokeControlCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MergeMultipleEdgesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowControllers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateOceanWakeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OneClickSetCallback(*args, **kwargs)->None:
"""
"""
pass
def curveMoveEPCtx(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The curveMoveEPCtx command creates a new context for moving curve edit points using a
manipulator Edit points can only be moved one at a time
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:returns: (name of the new context)
"""
pass
def artAttrSkinPaint(*args, **kwargs)->None:
"""
"""
pass
def editorTemplate(*args, addAdskAssetControls: bool=True, addComponents: bool=True,
addControl: bool=True, addDynamicControl: bool=True, addExtraControls:
bool=True, addSeparator: bool=True, annotateFieldOnly: bool=True,
annotation: AnyStr="", beginLayout: AnyStr="", beginNoOptimize: bool=True,
beginScrollLayout: bool=True, callCustom: bool=True, collapse: bool=True,
debugMode: bool=True, dimControl: List[AnyStr, AnyStr, bool]=None,
endLayout: bool=True, endNoOptimize: bool=True, endScrollLayout: bool=True,
extraControlsLabel: AnyStr="", interruptOptimize: bool=True, label:
AnyStr="", listExtraAttributes: AnyStr="", preventOverride: bool=True,
queryControl: List[AnyStr, AnyStr]=None, queryLabel: List[AnyStr,
AnyStr]=None, queryName: List[AnyStr, AnyStr]=None, removeControl:
List[AnyStr, AnyStr]=None, suppress: AnyStr="", **kwargs)->AnyStr:
"""
The editorTemplate command allows the user to specify the conceptual layout of an attribute
editor and leave the details of exactly which UI elements are used in the final result to
the automatic dialog generation mechanism
:param addAdskAssetControls: (C) Adds controls for dynamic attributes of adskMaterial nodes
and organizes them in a layout according to the XML ui description specified in the asset
:param addComponents: (C) This flag will add a frameLayout with a channel box which will
display any selected components for the object
:param addControl: (C) The first argument is the name of the attribute for which you wish
to add a control You can assume that when the editor is created from the template
:param addDynamicControl: (C) As -addControl with the exception that the attribute for
which the control is to be created/attached is dynamic [Note: -addControl will also work
fo
:param addExtraControls: (C) By default, if there are attributes of a node which you do not
-addControl or -suppress, then controls will be created automatically and appended to
:param addSeparator: (C) Adds a separator to the template
:param annotateFieldOnly: (C) This flag can only be used with the -annotation flag By
default, for any Attribute Editor controlGroups created by the -addControl flag, the
-annota
:param annotation: (C) This flag can only be used with the -addControl or the
-addDynamicControl flags The string will be used as an annotation on the controls created
in
:param beginLayout: (C) Begins a layout in the template with the title specified by the
string argument Items between this flag and its corresponding -endLayout flag will b
:param beginNoOptimize: (C) Specifies that the layout of items between this flag and its
corresponding -endNoOptimize flag is not to be optimized to minimize space
:param beginScrollLayout: (C) Begins a scrollLayout Items between this flag and its
corresponding -endScrollLayout flag will be contained within the layout
:param callCustom: (C) Specifies that at this point in the template when building the
dialog, the procedure specified by the first argument is to be called to create some U
:param collapse: (C) This flag is only valid when used in conjunction with a
-bl/beginLayout flag It is used to specify the initial expand/collapse state of the
layout
:param debugMode: (C) Set debugging mode for the template
:param dimControl: (C) This flag is only useful AFTER a control has already been created
(using the -addControl flag) The first argument is the node name and the second is
:param endLayout: (C) Ends a layout in the template started by -beginLayout
:param endNoOptimize: (C) Ends a set of non-optimized items
:param endScrollLayout: (C) Ends a scrollLayout
:param extraControlsLabel: (C) By default the label is "Extra Attributes" Specify an
alternate label or an empty string to hide the label This flag must be used in conjuction
wit
:param interruptOptimize: (C) Enforces a division between two sets of items whose layouts
may be optimized
:param label: (C) This flag can only be used with the -addControl or the -addDynamicControl
flags And it must be specified FIRST The string will override the name of
:param listExtraAttributes: (C) List extra attributes.This flag is only useful AFTER a
control has already been created (using the -addControl flag) The first argument is the
node
:param preventOverride: (C) If true, this flag disallows overriding the control's attribute
via the control's right mouse button menu
:param queryControl: (C) This flag is only useful AFTER a control has already been created
(using the -addControl flag) The first argument is the node name and the second is
:param queryLabel: (C) This flag is only useful AFTER a control has already been created
(using the -addControl flag) The first argument is the node name and the second is
:param queryName: (C) This flag is only useful AFTER a control has already been created
(using the -addControl flag) The first argument is the node name and the second is
:param removeControl: (C) This flag is obsolete and should no longer be used
:param suppress: (C) Prevent a control for the attribute specified by the string argument
from appearing in the editor created from the template
:returns: For queryControl, the appropriate attribute type will be
returned.
string
array
For listExtraAttributes, extra attributes will be returned.
"""
pass
def turbulence(*args, attenuation: Union[float, bool]=0.0, frequency: Union[float, bool]=0.0,
magnitude: Union[float, bool]=0.0, maxDistance: Union[float, bool]=0.0, name:
Union[AnyStr, bool]="", noiseLevel: Union[int, bool]=0, noiseRatio: Union[float,
bool]=0.0, perVertex: bool=True, phase: Union[float, bool]=0.0, phaseX:
Union[float, bool]=0.0, phaseY: Union[float, bool]=0.0, phaseZ: Union[float,
bool]=0.0, position: Union[List[float, float, float], List[List[float, float,
float]], bool]=None, torusSectionRadius: Union[float, bool]=0.0,
volumeExclusion: bool=True, volumeOffset: Union[List[float, float, float],
bool]=None, volumeShape: Union[AnyStr, bool]="", volumeSweep: Union[float,
bool]=0.0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
For each listed object, the command creates a new field The field has a shape which lives
in the DAG and it has an associated dependency node The field is added to the list of
fields owned by the object Use connectDynamic to cause the field to affect a dynamic
object Note that if more than one object is listed, a separate field is created for e
:param attenuation: (Q E) Attentuation rate of field
:param frequency: (Q E) Frequency of turbulence field This determines how often motion is
disrupted
:param magnitude: (Q E) Strength of field
:param maxDistance: (Q E) Maximum distance at which field is exerted -1 indicates that the
field has no maximum distance
:param name: (Q E) name of field
:param noiseLevel: (Q E) If the noiseLevel parameter is greater than zero, the field will
do multiple lookups in the table Each additional lookup is weighted using noiseRati
:param noiseRatio: (Q E) If noiseLevel is greater than zero, then noiseRatio is the
relative magnitude for each consecutive noise evaluation These are cumulative: for exampl
:param perVertex: (Q E) Per-vertex application If this flag is set true, then each
individual point (CV, particle, vertex,etc.) of the chosen object exerts an identical cop
:param phase: (Q E) Phase shift of turbulence field This influences the direction of the
disruption This flag is obsolete and is retained only for backward compatibili
:param phaseX: (Q E) X component of phase shift of turbulence field This influences the
direction of the disruption
:param phaseY: (Q E) Y component of phase shift of turbulence field This influences the
direction of the disruption
:param phaseZ: (Q E) Z component of phase shift of turbulence field This influences the
direction of the disruption
:param position: (Q E M) Position in space (x,y,z) where you want to place a gravity field
The gravity then emanates from this position in space rather than from an object
:param torusSectionRadius: (Q E) Section radius for a torus volume Applies only to torus
Similar to the section radius in the torus modelling primitive
:param volumeExclusion: (Q E) Volume exclusion of the field If true, points outside the
volume (defined by the volume shape attribute) are affected, If false, points inside the v
:param volumeOffset: (Q E) Volume offset of the field Volume offset translates the field's
volume by the specified amount from the actual field location This is in the field'
:param volumeShape: (Q E) Volume shape of the field Sets/edits/queries the field's volume
shape attribute If set to any value other than "none", determines a 3-D volume with
:param volumeSweep: (Q E) Volume sweep of the field Applies only to sphere, cone, cylinder,
and torus Similar effect to the sweep attribute in modelling
:returns: Command result
"""
pass
def CreateCreaseSetOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def flexor(*args, atBones: bool=True, atJoints: bool=True, deformerCommand: AnyStr="", list:
bool=True, name: AnyStr="", noScale: bool=True, toSkeleton: bool=True, type:
AnyStr="", q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr],
Any]:
"""
This command creates a flexor A flexor a deformer plus a set of driving attributes For
example, a flexor might be a sculpt object that is driven by a joint's x rotation and a
cube's y position
:param atBones: (C) Add a flexor at bones Flexor will be added at each of the selected
bones, or at all bones in the selected skeleton if the -ts flag is also specified
:param atJoints: (C) Add a flexor at joints Flexor will be added at each of the selected
joints, or at all joints in the selected skeleton if the -ts flag is specified
:param deformerCommand: (C) String representing underlying deformer command string
:param list: (Q) List all possible types of flexors Query mode only
:param name: (C) This flag is obsolete
:param noScale: (C) Do not auto-scale the flexor to the size of the nearby geometry
:param toSkeleton: (C) Specifies that flexors will be added to the entire skeleton rather
than just to the selected joints/bones This flag is used in conjunction with the
:param type: (C) Specifies which type of flexor To see list of valid types, use the
"flexor -query -list" command
:returns: (the names of the new flexor nodes)
"""
pass
def NodeEditorToggleZoomOut(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_contextChanged(*args, **kwargs)->None:
"""
"""
pass
def NodeEditorShapeMenuStateAllExceptShadingGroupMembers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmCombBrushContext(*args, **kwargs)->None:
"""
"""
pass
def PolygonApplyColorOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def texWinToolCtx(*args, alternateContext: bool=True, boxzoom: bool=True, dolly: bool=True,
exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name:
AnyStr="", toolName: Union[AnyStr, bool]="", track: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This class creates a context for the View Tools "track", "dolly", and "box zoom" in the
texture window
:param alternateContext: (C Q) Set the ALT+MMB and ALT+SHIFT+MMB to refer to this context
:param boxzoom: (C Q E) Perform Box Zoom
:param dolly: (C Q E) Dollies the view
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param toolName: (C Q) Name of the specific tool to which this command refers
:param track: (C Q E) Tracks the view
:returns: Context name
"""
pass
def CreatePolygonPyramid(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmCurveToGuide(*args, **kwargs)->None:
"""
"""
pass
def ExtendFluidOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def bevel(*args, bevelShapeType: Union[int, bool]=1, caching: bool=True, cornerType: Union[int,
bool]=2, depth: Union[float, bool]=0.5, extrudeDepth: Union[float, bool]=1.0,
nodeState: Union[int, bool]=0, tolerance: Union[float, bool]=0.01, width: Union[float,
bool]=0.5, constructionHistory: bool=True, joinSurfaces: bool=True, name: AnyStr="",
numberOfSides: Union[int, bool]=4, object: bool=True, polygon: int=0, range:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr],
Any]:
"""
The bevel command creates a new bevel surface for the specified curve The curve can be any
nurbs curves
:param bevelShapeType: (C Q E) Shape type: 1 - straight cut, 2 - curve out, 3 - curve in
Default: 1
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param cornerType: (C Q E) Corner type: 1 - linear, 2 - circular Default: 2
:param depth: (C Q E) The depth for bevel Default: 0.5
:param extrudeDepth: (C Q E) The extrude depth for bevel Default: 1.0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param tolerance: (C Q E) The tolerance for bevel offsets Default: 0.01
:param width: (C Q E) The width for bevel Default: 0.5
:param constructionHistory: (C) Turn the construction history on or off
:param joinSurfaces: (C Q E) Attach bevelled surfaces into one surface for each input curve
Default:true
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param numberOfSides: (C Q E) How to apply the bevel 1 - no bevels 2 - bevel at start only
3 - bevel at end only 4 - bevel at start and end Default: 4
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:param range: (C) Force a curve range on complete input curve
:returns: Object name and node name
"""
pass
def appendListItem(*args, **kwargs)->None:
"""
"""
pass
def MakePondMotorBoatsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetRigidBodyInterpenetration(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshBulgeTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PublishChildAnchor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SmoothSkinWeightsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def bifMeshExport(*args, **kwargs)->None:
"""
"""
pass
def TimeEditorAddToSoloSelectedTracks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nClothMergeCacheOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeRefreshSelectedSwatchesOnDisk(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def torus(*args, axis: Union[List[float, float, float], bool]=None, caching: bool=True, degree:
Union[int, bool]=3, endSweep: Union[float, bool]=2, heightRatio: Union[float,
bool]=2.0, minorSweep: Union[float, bool]=6.2831853, nodeState: Union[int, bool]=0,
pivot: Union[List[float, float, float], bool]=None, radius: Union[float, bool]=1.0,
sections: Union[int, bool]=8, spans: Union[int, bool]=1, startSweep: Union[float,
bool]=0, tolerance: Union[float, bool]=0.01, useTolerance: bool=False,
constructionHistory: bool=True, name: AnyStr="", object: bool=True, polygon: int=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The torus command creates a new torus and/or a dependency node that creates one, and
returns their names
:param axis: (C Q E) The primitive's axis
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param degree: (C Q E) The degree of the resulting surface: 1 - linear, 3 - cubic Default:
3
:param endSweep: (C Q E) The angle at which to end the surface of revolution Default is
2Pi radians, or 360 degrees Default: 6.2831853
:param heightRatio: (C Q E) Ratio of "height" to "width" Default: 2.0
:param minorSweep: (C Q E) The sweep angle for the minor circle in the torus Default:
6.2831853
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pivot: (C Q E) The primitive's pivot point
:param radius: (C Q E) The radius of the object Default: 1.0
:param sections: (C Q E) The number of sections determines the resolution of the surface in
the sweep direction Used only if useTolerance is false Default: 8
:param spans: (C Q E) The number of spans determines the resolution of the surface in the
opposite direction Default: 1
:param startSweep: (C Q E) The angle at which to start the surface of revolution Default:
0
:param tolerance: (C Q E) The tolerance with which to build the surface Used only if
useTolerance is true Default: 0.01
:param useTolerance: (C Q E) Use the specified tolerance to determine resolution Otherwise
number of sections will be used Default: false
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:returns: Object name and node name
"""
pass
def deviceEditor(*args, control: bool=True, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", exists: bool=True, filter: Union[AnyStr, bool]="",
forceMainConnection: Union[AnyStr, bool]="", highlightConnection: Union[AnyStr,
bool]="", lockMainConnection: bool=True, mainListConnection: Union[AnyStr,
bool]="", panel: Union[AnyStr, bool]="", parent: Union[AnyStr, bool]="",
selectionConnection: Union[AnyStr, bool]="", stateString: bool=True, takePath:
Union[AnyStr, bool]="", unParent: bool=True, unlockMainConnection: bool=True,
updateMainConnection: bool=True, useTemplate: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This creates an editor for creating/modifying attachments to input devices
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param takePath: (Q E) The path used for writing/reading take data through the editor
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: name of the editor
"""
pass
def TimeEditorWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateExpressionClipOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SewUVsWithoutHotkey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectComponentToolMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BifMeshImport(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RebuildSurfacesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def attrColorSliderGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0,
adjustableColumn3: int=0, adjustableColumn4: int=0, adjustableColumn5:
int=0, adjustableColumn6: int=0, annotation: Union[AnyStr, bool]="",
attrNavDecision: Union[List[name, AnyStr], bool]=None, attribute:
Union[AnyStr, bool]="", backgroundColor: Union[List[float, float, float],
bool]=None, columnAlign: Union[List[int, AnyStr], List[List[int,
AnyStr]]]=None, columnAlign2: List[AnyStr, AnyStr]=None, columnAlign3:
List[AnyStr, AnyStr, AnyStr]=None, columnAlign4: List[AnyStr, AnyStr,
AnyStr, AnyStr]=None, columnAlign5: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAlign6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach: Union[List[int, AnyStr, int], List[List[int,
AnyStr, int]]]=None, columnAttach2: List[AnyStr, AnyStr]=None,
columnAttach3: List[AnyStr, AnyStr, AnyStr]=None, columnAttach4:
List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach5: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach6: List[AnyStr, AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr]=None, columnOffset2: List[int, int]=None,
columnOffset3: List[int, int, int]=None, columnOffset4: List[int, int,
int, int]=None, columnOffset5: List[int, int, int, int, int]=None,
columnOffset6: List[int, int, int, int, int, int]=None, columnWidth:
Union[List[int, int], List[List[int, int]]]=None, columnWidth1: int=0,
columnWidth2: List[int, int]=None, columnWidth3: List[int, int,
int]=None, columnWidth4: List[int, int, int, int]=None, columnWidth5:
List[int, int, int, int, int]=None, columnWidth6: List[int, int, int,
int, int, int]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
exists: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, hsvValue:
Union[List[float, float, float], bool]=None, isObscured: bool=True,
label: Union[AnyStr, bool]="", manage: bool=True, noBackground:
bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, rgbValue:
Union[List[float, float, float], bool]=None, rowAttach: Union[List[int,
AnyStr, int], List[List[int, AnyStr, int]]]=None, showButton: bool=True,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param attrNavDecision: (C Q E) The first argument is the name of an attribute The button
will be attached to the attribute so the button can be kept in synch with the attribute T
:param attribute: (C Q E) The name of a unique attribute of type 3double This newly
created field will be attached to the attribute, so that modifications to one will change
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param hsvValue: (C Q E) Specifies the color in hsv style
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) By default, the label of this field will be the name of the attribute
This flag can be used to override that name with whatever the user wants
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rgbValue: (C Q E) Specifies the color in rgb style
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param showButton: (C Q E) Control the display of the texture link button True by default
(show it)
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: (the name of the created group)
"""
pass
def cMuscleRelaxSetup(*args, **kwargs)->None:
"""
"""
pass
def shadingGeometryRelCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", offCommand: Union[AnyStr, bool]="",
onCommand: Union[AnyStr, bool]="", shadingCentric: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a context that can be used for associating geometry to shading groups
You can put the context into shading-centric mode by using the -shadingCentric flag and
specifying true This means that the shading group is selected first then geometry
associated with the shading group are highlighted Subsequent selections result in
assi
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param offCommand: (C Q E) command to be issued when context is turned on
:param onCommand: (C Q E) command to be issued when context is turned on
:param shadingCentric: (C Q E) shading-centric mode
:returns: Name of the context created.
"""
pass
def warning(*args, noContext: bool=True, showLineNumber: bool=True, **kwargs)->None:
"""
The warning command is provided so that the user can issue warning messages from his/her
scripts The string argument is displayed in the command window (or stdout if running in
batch mode) after being prefixed with a warning message heading and surrounded by the
appropriate language separators (# for Python, // for Mel)
:param noContext: (C) Do not include the context information with the warning message
:param showLineNumber: (C) Obsolete Will be deleted in the next version of Maya Use the
checkbox in the script editor that enables line number display instead
:returns:
"""
pass
def attachFluidCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LockTangentWeight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def arnoldListAttributes(*args, **kwargs)->None:
"""
"""
pass
def FireworksOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def componentEditor(*args, control: bool=True, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", exists: bool=True, filter: Union[AnyStr, bool]="", floatField:
Union[AnyStr, bool]="", floatSlider: Union[AnyStr, bool]="",
forceMainConnection: Union[AnyStr, bool]="", hidePathName: bool=True,
hideZeroColumns: bool=True, highlightConnection: Union[AnyStr, bool]="",
lockInput: bool=True, lockMainConnection: bool=True, mainListConnection:
Union[AnyStr, bool]="", newTab: List[AnyStr, AnyStr, AnyStr]=None,
operationCount: bool=True, operationLabels: bool=True, operationType:
Union[int, bool]=0, panel: Union[AnyStr, bool]="", parent: Union[AnyStr,
bool]="", precision: Union[int, bool]=0, removeTab: AnyStr="", selected:
bool=True, selectionConnection: Union[AnyStr, bool]="", setOperationLabel:
List[int, AnyStr]=None, showObjects: bool=True, showSelected: bool=True,
sortAlpha: bool=True, stateString: bool=True, unParent: bool=True,
unlockMainConnection: bool=True, updateMainConnection: bool=True,
useTemplate: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a new component editor in the current layout
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param floatField: (C Q E) assigns a float field that the component editor will use for
editing groups of values
:param floatSlider: (C Q E) assigns a float slider that the component editor will use for
editing groups of values
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param hidePathName: (C Q E) Hides path name of displayed element By default this flag is
set to false
:param hideZeroColumns: (C Q E) Hides columns whose elements are all zero By default this
flag is set to false
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param lockInput: (C Q E) Prevents the editor from responding to changes in the active list
Independent of selection connection
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param newTab: (C E) Creates a new tab, named by the first argument, based on an existing
tab, given as the second argument using elements from a set, given in the third
:param operationCount: (Q) returns the total number of operation types known to the
component editor
:param operationLabels: (Q) returns a string array containing the names for all operation
types known to the editor
:param operationType: (C Q E) Tells the editor which of its known operation types it should
be performing This is a 0-based index
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param precision: (C Q E) Specifies the maximum number of digits displayed to the right of
the decimal place Can be 0 to 20
:param removeTab: (E) Removes the tab based on the set provided
:param selected: (Q) Returns a list of strings, containing the labels of the currently
selected columns
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param setOperationLabel: (E) uses the string as the new name for the existing operation
type specified by the integer index Note that there is no messaging system which allows U
:param showObjects: (C) Restricts the display to columns that are in the current active
list
:param showSelected: (C E) Restricts the display to those columns which are currently
selected By default this flag is set to false, so all columns are selected The results f
:param sortAlpha: (C Q E) Controls alphabetical (true), or hierarchical sorting of columns
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The panel name
"""
pass
def RevolveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def rampColorPort(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
exists: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, manage: bool=True, noBackground: bool=True, node: name=None,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, selectedColorControl:
AnyStr="", selectedInterpControl: AnyStr="", selectedPositionControl:
AnyStr="", statusBarMessage: AnyStr="", useTemplate: AnyStr="",
verticalLayout: bool=True, visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a control that displays an image representing the ramp node specified,
and supports editing of that node
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param node: (C) Specifies the name of the newRamp texture node this port will represent
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param selectedColorControl: (C E) Set the name of the control (if any) which is to be used
to show the color of the currently selected entry in the ramp This control will
automatical
:param selectedInterpControl: (C E) Set the name of the control (if any) which is to be
used to show the interpolation of the currently selected entry in the ramp This control
will aut
:param selectedPositionControl: (C E) Set the name of the control (if any) which is to be
used to show the position of the currently selected entry in the ramp This control will
automati
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param verticalLayout: (C Q E) Set the preview's layout
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the port created or modified
"""
pass
def TogglePolyUVsCreateShader(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmPreview(*args, **kwargs)->None:
"""
"""
pass
def clipEditorCurrentTimeCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a context which may be used to change current time within the track
area of a clip editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Context name
"""
pass
def HideHotbox(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SmoothPolygon(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteChannelsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def textManip(*args, visible: bool=True, q=True, query=True, **kwargs)->Union[None, Any]:
"""
Shows/hides the text manip
:param visible: (C Q) Shows/hides the text manip
:returns:
"""
pass
def fluidMergeCacheOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateBlendShapeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def isDescendentPulling(*args, **kwargs)->None:
"""
"""
pass
def GroupOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SendToUnitySetProject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MergeVertexTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def lsThroughFilter(*args, item: Union[AnyStr, List[AnyStr]]="", nodeArray: bool=True, reverse:
bool=True, selection: bool=True, sort: AnyStr="", **kwargs)->List[AnyStr]:
"""
List all objects in the world that pass a given filter
:param item: (C M) Run the filter on specified node(s), using the fast version of this
command
:param nodeArray: (C) Fast version that runs an entire array of nodes through the filter at
one time
:param reverse: (C) Only available in conjunction with nodeArray flag Reverses the order
of nodes in the returned arrays if true
:param selection: (C) Run the filter on selected nodes only, using the fast version of this
command
:param sort: (C) Only available in conjunction with nodeArray flag Orders the nodes in the
returned array Current options are: "byName", "byType", and "byTime"
:returns: List of nodes passing the filter
"""
pass
def dolly(*args, absolute: bool=True, distance: float=0.0, dollyTowardsCenter: bool=True,
orthoScale: float=0.0, relative: bool=True, **kwargs)->None:
"""
The dolly command moves a camera along the viewing direction in the world space The
viewing-direction and up-direction of the camera are not altered There are two modes of
operation: Relative mode: for a perspective camera, the camera is moved along its viewing
direction, and the distance of travel is computed with respect to the current positi
:param absolute: (C) This flag modifies the behavior of the distance and orthoScale flags
When used in conjunction with the distance flag, the distance argument specifie
:param distance: (C) Unit distance to dolly a perspective camera
:param dollyTowardsCenter: (C) This flag controls whether the dolly is performed towards
the center of the view (if true), or towards the point where the user clicks (if false)
By
:param orthoScale: (C) Scale to change the ortho width of an orthographic camera
:param relative: (C) This flag modifies the behavior of the distance and orthoScale flags
When used in conjunction with the distance flag, the camera eye and center of i
:returns:
"""
pass
def ExportDeformerWeightsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fitBspline(*args, caching: bool=True, nodeState: Union[int, bool]=0, tolerance: Union[float,
bool]=0.1, constructionHistory: bool=True, name: AnyStr="", object: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The fitBspline command fits the CVs from an input curve and and returns a 3D curve
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param tolerance: (C Q E) Tolerance for the fit The resulting curve will be kept within
tolerance of the given points Default: 0.1
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:returns: Object name and node name
"""
pass
def ReverseSurfaceDirection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def suitePrefs(*args, applyToSuite: AnyStr="", installedAsSuite: bool=True, isCompleteSuite:
bool=True, **kwargs)->None:
"""
This command sets the mouse and keyboard interaction mode for Maya and other Suites
applications (if Maya is part of a Suites install)
:param applyToSuite: (C) Apply the mouse and keyboard interaction settings for the given
application to all applications in the Suite (if Maya is part of a Suites install) V
:param installedAsSuite: (C) Returns true if Maya is part of a Suites install, false
otherwise
:param isCompleteSuite: (C) Returns true if the Suites install contains all Entertainment
Creation Suite products, false otherwise
:returns:
"""
pass
def MoveInfluence(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SmoothHairCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def U3DBrushPressureOn(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShrinkLoopPolygonSelectionRegion(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AssumePreferredAngle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectCurveCVsLast(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InteractivePlayback(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HIKBodyPartMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def keyframeStats(*args, adjustableColumn: int=0, adjustableColumn2: int=0, adjustableColumn3:
int=0, adjustableColumn4: int=0, adjustableColumn5: int=0, adjustableColumn6:
int=0, animEditor: Union[AnyStr, bool]="", annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, classicMode:
bool=True, columnAlign: Union[List[int, AnyStr], List[List[int,
AnyStr]]]=None, columnAlign2: List[AnyStr, AnyStr]=None, columnAlign3:
List[AnyStr, AnyStr, AnyStr]=None, columnAlign4: List[AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAlign5: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAlign6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach: Union[List[int, AnyStr, int], List[List[int, AnyStr,
int]]]=None, columnAttach2: List[AnyStr, AnyStr]=None, columnAttach3:
List[AnyStr, AnyStr, AnyStr]=None, columnAttach4: List[AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach5: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnOffset2: List[int, int]=None, columnOffset3: List[int,
int, int]=None, columnOffset4: List[int, int, int, int]=None, columnOffset5:
List[int, int, int, int, int]=None, columnOffset6: List[int, int, int, int,
int, int]=None, columnWidth: Union[List[int, int], List[List[int, int]]]=None,
columnWidth1: int=0, columnWidth2: List[int, int]=None, columnWidth3:
List[int, int, int]=None, columnWidth4: List[int, int, int, int]=None,
columnWidth5: List[int, int, int, int, int]=None, columnWidth6: List[int, int,
int, int, int, int]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", dragCallback: Script=None, dropCallback: Script=None, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
exists: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, manage: bool=True, noBackground: bool=True, numberOfPopupMenus:
bool=True, parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
precision: Union[int, bool]=3, preventOverride: bool=True, rowAttach:
Union[List[int, AnyStr, int], List[List[int, AnyStr, int]]]=None,
statusBarMessage: AnyStr="", timeAnnotation: Union[AnyStr, bool]="",
useTemplate: AnyStr="", valueAnnotation: Union[AnyStr, bool]="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param animEditor: (Q E) The name of the animation editor which is associated with the
control
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param classicMode: (Q E) Edit display mode True means stats only, otherwise show time
value
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param precision: (Q E) Controls the number of digits to the right of the decimal point
that will be displayed for float-valued channels Default is 3 Queried, returns an i
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param timeAnnotation: (C Q E) Annotate the time field with an extra string value
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param valueAnnotation: (C Q E) Annotate the value field with an extra string value
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the stats control.
"""
pass
def polyMergeUV(*args, caching: bool=True, constructionHistory: bool=True, distance:
Union[float, bool]=0.0, name: AnyStr="", nodeState: Union[int, bool]=0,
uvSetName: AnyStr="", worldSpace: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Merge UVs of an object based on their distance UVs are merge only if they belong to the
same 3D vertex
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param distance: (C Q E) This flag specifies the maximum distance to merge UVs C: Default
is 0.0 Q: When queried, this flag returns a double
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param uvSetName: (C) Name of the UV set to be created
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def NURBSSmoothnessHull(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AverageVertex(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyWedgeFace(*args, axis: List[float, float, float]=None, caching: bool=True, center:
List[float, float, float]=None, constructionHistory: bool=True, divisions:
int=0, edge: Union[int, List[int]]=0, name: AnyStr="", nodeState: Union[int,
bool]=0, wedgeAngle: float=0.0, worldSpace: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Extrude faces about an axis The axis is the average of all the selected edges If the
edges are not aligned, the wedge may not look intuitive To separately wedge faces about
different wedge axes, the command should be issued as many times as the wedge axes (as in
the second example)
:param axis: (C) This flag (along with -center) can be used instead of the -edge flag to
specify the axis about which the wedge is performed The flag expects three c
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param center: (C) This flag (along with -axis) can be used instead of the -edge flag to
specify the location about which the wedge is performed The flag expects three
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param divisions: (C) This flag specifies the number of subdivisions along the extrusion
:param edge: (C M) This flag specifies the edgeId that should be used to perform the wedge
about Multiple edges can be specified The wedge operation is performed abou
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param wedgeAngle: (C) This flag specifies the angle of rotation
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def drag(*args, attenuation: Union[float, bool]=0.0, directionX: Union[float, bool]=0.0,
directionY: Union[float, bool]=0.0, directionZ: Union[float, bool]=0.0, magnitude:
Union[float, bool]=0.0, maxDistance: Union[float, bool]=0.0, name: Union[AnyStr,
bool]="", perVertex: bool=True, position: Union[List[float, float, float],
List[List[float, float, float]], bool]=None, torusSectionRadius: Union[float,
bool]=0.0, useDirection: bool=True, volumeExclusion: bool=True, volumeOffset:
Union[List[float, float, float], bool]=None, volumeShape: Union[AnyStr, bool]="",
volumeSweep: Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
For each listed object, the command creates a new field The field has a shape which lives
in the DAG and it has an associated dependency node The field is added to the list of
fields owned by the object Use connectDynamic to cause the field to affect a dynamic
object Note that if more than one object is listed, a separate field is created for e
:param attenuation: (Q E) Attentuation rate of field
:param directionX: (Q E) X-component of direction
:param directionY: (Q E) Y-component of direction
:param directionZ: (Q E) Z-component of direction
:param magnitude: (Q E) Strength of field
:param maxDistance: (Q E) Maximum distance at which field is exerted -1 indicates that the
field has no maximum distance
:param name: (Q E) name of field
:param perVertex: (Q E) Per-vertex application If this flag is set true, then each
individual point (CV, particle, vertex,etc.) of the chosen object exerts an identical cop
:param position: (Q E M) Position in space (x,y,z) where you want to place a gravity field
The gravity then emanates from this position in space rather than from an object
:param torusSectionRadius: (Q E) Section radius for a torus volume Applies only to torus
Similar to the section radius in the torus modelling primitive
:param useDirection: (Q E) Enable/disable direction Drag will use -dx/-dy/-dz arguments if
and only if this flag is set true
:param volumeExclusion: (Q E) Volume exclusion of the field If true, points outside the
volume (defined by the volume shape attribute) are affected, If false, points inside the v
:param volumeOffset: (Q E) Volume offset of the field Volume offset translates the field's
volume by the specified amount from the actual field location This is in the field'
:param volumeShape: (Q E) Volume shape of the field Sets/edits/queries the field's volume
shape attribute If set to any value other than "none", determines a 3-D volume with
:param volumeSweep: (Q E) Volume sweep of the field Applies only to sphere, cone, cylinder,
and torus Similar effect to the sweep attribute in modelling
:returns: Command result
"""
pass
def HypershadeToggleZoomIn(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def currentTimeCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name:
AnyStr="", q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command creates a context which may be used to change current time within the graph
editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Context name
"""
pass
def adskAsset(*args, **kwargs)->None:
"""
"""
pass
def NodeEditorGraphRemoveUpstream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def wrinkle(*args, axis: List[float, float, float]=None, branchCount: int=2, branchDepth: int=0,
center: List[float, float, float]=None, crease: Union[AnyStr, List[AnyStr]]="",
dropoffDistance: float=0.0, envelope: float=1.0, randomness: float=0.2, style:
AnyStr="", thickness: float=1.0, uvSpace: List[float, float, float, float,
float]=None, wrinkleCount: int=3, wrinkleIntensity: float=0.5,
**kwargs)->List[AnyStr]:
"""
The wrinkle command is used to create a network of wrinkles on a surface It automatically
creates a network of wrinkle curves that control a wire deformer The wrinkle curves are
attached to a cluster deformer
:param axis: (C) Specifies the plane of the wrinkle
:param branchCount: (C) Specifies the number of branches per wrinkle Default is 2
:param branchDepth: (C) Specifies the depth of the branching Default is 0
:param center: (C) Specifies the center of the wrinkle
:param crease: (C M) Specifies an existing curve to serve as the wrinkle
:param dropoffDistance: (C) Specifies the dropoff distance around the center
:param envelope: (C) The envelope globally attenuates the amount of deformation Default is
1.0
:param randomness: (C) Amount of randomness Default is 0.2
:param style: (C) Specifies the wrinkle style Valid values are "radial" or "tangential"
:param thickness: (C) Wrinkle thickness Default is 1.0
:param uvSpace: (C) 1/2 length, 1/2 breadth, rotation angle, center u, v definition of a
patch in uv space where the wrinkle is to be constructed
:param wrinkleCount: (C) Specifies the number of wrinkle lines to be generated Default is
3
:param wrinkleIntensity: (C) Increasing the intensity makes it more wrinkly Default is
0.5
:returns: List of clusters created followed by list of wire deformers created.
"""
pass
def MoveNearestPickedKeyToolActivate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InteractiveSplitTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DetachSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RerootSkeleton(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphDeleteOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleStatusLine(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hudButton(*args, allowOverlap: bool=True, block: Union[int, bool]=0, blockAlignment:
Union[AnyStr, bool]="", blockSize: Union[AnyStr, bool]="", buttonShape:
Union[AnyStr, bool]="", buttonWidth: Union[int, bool]=0, label: Union[AnyStr,
bool]="", labelFontSize: Union[AnyStr, bool]="", padding: Union[int, bool]=0,
pressCommand: Union[Script, bool]=None, releaseCommand: Union[Script, bool]=None,
section: Union[int, bool]=0, visible: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[int, Any]:
"""
This command creates a Heads-up Display (HUD) button control which is placed in a 2D
inactive overlay plane on the 3D viewport It is to be used to provide hands-on interaction
designated by a user script The HUD button is derived from a generic HUD object and thus
inherits a similar workflow Although this command provides much of the same funct
:param allowOverlap: (C Q E) Sets the Heads-Up Display to be visible regardless of
overlapping section widths/limitations (see -s/section flag description for more details)
:param block: (C Q E) Denotes the individual block that the HUD will reside in, within a
section Each section is composed of a single column of blocks The total number o
:param blockAlignment: (C Q E) Specifies the alignment of the block within its respective
column Available alignments are: "center", "left" and "right" The default alignment is "
:param blockSize: (C Q E) Sets the height of each block Available heights are: small,
medium and large In pixel measurements, each corresponds to a 20, 35 or 50 pixel height
:param buttonShape: (C Q E) Specifies the shape of the button Available button shapes are:
"rectangle" and "roundRectangle" The first will draw a rectangular button, while the
:param buttonWidth: (C Q E) Specifies the width of the button
:param label: (C Q E) Text label of the HUD button
:param labelFontSize: (C Q E) Sets the font size of the label Available sizes are: small
and large
:param padding: (C Q E) Specifies the width of both the left and right margins of a block
Default value is 15 pixels
:param pressCommand: (C Q E) Specifies the procedure or script to run during a mouse click
event
:param releaseCommand: (C Q E) Specifies the procedure or script to run during a mouse
release event
:param section: (C Q E) Defines the section the HUD will appear in There are 10 sections
divided across the screen Five columns and two rows make up the ten element matrix
:param visible: (C Q E) Sets the visibility of the Heads-Up Display on and off
:returns: ID number of the Heads-Up Display (HUD).
"""
pass
def FBXExportBakeComplexAnimation(*args, **kwargs)->None:
"""
"""
pass
def dgcontrol(*args, **kwargs)->None:
"""
"""
pass
def xgmSetAttr(*args, **kwargs)->None:
"""
"""
pass
def orbit(*args, horizontalAngle: float=0.0, pivotPoint: List[float, float, float]=None,
rotationAngles: List[float, float]=None, verticalAngle: float=0.0, **kwargs)->None:
"""
The orbit command revolves the camera(s) horizontally and/or vertically in the perspective
window The rotation axis is with respect to the camera To revolve horizontally: the
rotation axis is the camera up direction vector To revolve vertically: the rotation axis
is the camera left direction vector When both the horizontal and the vertical
:param horizontalAngle: (C) Angle to revolve horizontally
:param pivotPoint: (C) Used as the pivot point in the world space
:param rotationAngles: (C) Angle to revolve horizontally and vertically
:param verticalAngle: (C) Angle to revolve vertically
:returns:
"""
pass
def renderSetupPostApply(*args, **kwargs)->None:
"""
"""
pass
def defineDataServer(*args, device: AnyStr="", server: AnyStr="", undefine: bool=True,
**kwargs)->None:
"""
Connects to the specified data servername, creating a named device which then can be
attached to device handlers When the device is defined, it queries queries the server for
data axis information The "CapChannels" present are represented as axis in form
"channelName"."usage" for scalar channels and "channelName"."component" for compound
channel
:param device: (C) specified the device name to be given to the server connection device
name must be unique or the command fails
:param server: (C) specifies the name of the server with which the define device connects,
and can be specifiied in two ways name -- the name of the server socket Serve
:param undefine: (C) undefines (destroys) the dataServer device, closing the connection
with the server
:returns:
"""
pass
def PolygonSoftenHarden(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowDynamicsUI(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FrameSelectedWithoutChildrenInAllViews(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NURBSToPolygonsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def renderSetupHighlight(*args, **kwargs)->None:
"""
"""
pass
def InsertIsoparmsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeDuplicateWithoutNetwork(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_scaleTweakTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportMergeBackNullPivots(*args, **kwargs)->None:
"""
"""
pass
def SelectEdgeRingSp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dgdebug(*args, **kwargs)->None:
"""
"""
pass
def wire(*args, after: bool=True, afterReference: bool=True, before: bool=True, crossingEffect:
Union[float, bool]=0, deformerTools: bool=True, dropoffDistance: Union[List[int,
float], List[List[int, float]], bool]=None, envelope: Union[float, bool]=1.0,
exclusive: Union[AnyStr, bool]="", frontOfChain: bool=True, geometry: Union[AnyStr,
List[AnyStr], bool]="", geometryIndices: bool=True, groupWithBase: bool=False, holder:
Union[List[int, AnyStr], List[List[int, AnyStr]], bool]=None, ignoreSelected:
bool=True, includeHiddenSelections: bool=False, localInfluence: Union[float, bool]=0,
name: AnyStr="", parallel: bool=True, prune: bool=True, remove: Union[bool,
List[bool]]=True, split: bool=True, wire: Union[AnyStr, List[AnyStr], bool]="",
wireCount: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
This command creates a wire deformer
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param crossingEffect: (C Q E) Set the amount of convolution effect Varies from fully
convolved at 0 to a simple additive effect at 1 (which is what you get with the filter
off)
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param dropoffDistance: (C Q E M) Set the dropoff distance (second parameter) for the wire
at index (first parameter)
:param envelope: (C Q E) Set the envelope value for the deformer Default is 1.0
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param groupWithBase: (C) Groups the wire with the base wire so that they can easily be
moved together to create a ripple effect Default is false
:param holder: (C Q E M) Set the specified curve or surface (second parameter as a holder
for the wire at index (first parameter)
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param localInfluence: (C Q E) Set the local control a wire has with respect to other wires
irrespective of whether it is deforming the surface Varies from no local effect at 0 to
:param name: (C) Used to specify the name of the node being created
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:param wire: (C Q E M) Specify or query the wire curve name
:param wireCount: (C Q E) Set the number of wires
:returns: The wire node name and the wire curve name
"""
pass
def FBXImportUnlockNormals(*args, **kwargs)->None:
"""
"""
pass
def geometryExportCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleMeshUVBorders(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowPlanes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyMergeFacetCtx(*args, activeNodes: bool=True, exists: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
immediate: bool=True, name: AnyStr="", previous: bool=True, reset:
bool=True, toolNode: bool=True, caching: bool=True, constructionHistory:
bool=True, firstFacet: Union[int, bool]=0, mergeMode: Union[int, bool]=0,
nodeState: Union[int, bool]=0, secondFacet: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The second face becomes a hole in the first face.
:param activeNodes: (Q) Return the active nodes in the tool
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param immediate: (E) Acts on the object not the tool defaults
:param name: (C) If this is a tool command, name the tool appropriately
:param previous: (E) Reset to previously stored values
:param reset: (E) Reset to default values
:param toolNode: (Q) Return the node used for tool defaults
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param firstFacet: (C Q E) The number of the first (outer) face to merge
:param mergeMode: (C Q E) This flag specifies how faces are merged: 0: moves second face to
first one 1: moves both faces to average 2: moves first face to second one 3, 4, 5:
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param secondFacet: (C Q E) The number of the second (hole) face to merge
:returns: The node name.
"""
pass
def ParticleCollisionEvents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def stitchSurfaceCtx(*args, **kwargs)->None:
"""
"""
pass
def toggle(*args, above: bool=True, below: bool=True, boundary: bool=True, boundingBox:
bool=True, controlVertex: bool=True, doNotWrite: bool=True, editPoint: bool=True,
extent: bool=True, facet: bool=True, geometry: bool=True, gl: bool=True,
highPrecisionNurbs: bool=True, hull: bool=True, latticePoint: bool=True,
latticeShape: bool=True, localAxis: bool=True, newCurve: bool=True, newPolymesh:
bool=True, newSurface: bool=True, normal: bool=True, origin: bool=True, point:
bool=True, pointDisplay: bool=True, pointFacet: bool=True, rotatePivot: bool=True,
scalePivot: bool=True, selectHandle: bool=True, state: bool=True, surfaceFace:
bool=True, template: bool=True, uvCoords: bool=True, vertex: bool=True, q=True,
query=True, **kwargs)->Union[bool, Any]:
"""
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
:param above: (C) Toggle state for all objects above listed objects
:param below: (C) Toggle state for all objects below listed objects
:param boundary: (C Q) Toggle boundary display of listed mesh objects
:param boundingBox: (C Q) Toggle or query the bounding box display of listed objects
:param controlVertex: (C Q) Toggle CV display of listed curves and surfaces
:param doNotWrite: (C Q) Toggle the "this should be written to the file" state
:param editPoint: (C Q) Toggle edit point display of listed curves and surfaces
:param extent: (C Q) Toggle display of extents of listed mesh objects
:param facet: (C Q) For use with normal flag Set the normal display style to facet
display
:param geometry: (C Q) Toggle geometry display of listed objects
:param gl: (C) Toggle state for all objects
:param highPrecisionNurbs: (C Q) Toggle high precision display for Nurbs
:param hull: (C Q) Toggle hull display of listed curves and surfaces
:param latticePoint: (C Q) Toggle point display of listed lattices
:param latticeShape: (C Q) Toggle display of listed lattices
:param localAxis: (C Q) Toggle local axis display of listed objects
:param newCurve: (C Q) Set component display state of new curve objects
:param newPolymesh: (C Q) Set component display state of new polymesh objects
:param newSurface: (C Q) Set component display state of new surface objects
:param normal: (C Q) Toggle display of normals of listed surface and mesh objects
:param origin: (C Q) Toggle origin display of listed surfaces
:param point: (C Q) For use with normal flag Set the normal display style to vertex
display
:param pointDisplay: (C Q) Toggle point display of listed surfaces
:param pointFacet: (C Q) For use with normal flag Set the normal display style to vertex
and face display
:param rotatePivot: (C Q) Toggle rotate pivot display of listed objects
:param scalePivot: (C Q) Toggle scale pivot display of listed objects
:param selectHandle: (C Q) Toggle select handle display of listed objects
:param state: (C) Explicitly set the state to true or false instead of toggling the state
Can not be queried
:param surfaceFace: (C Q) Toggle surface face handle display of listed surfaces
:param template: (C Q) Toggle template state of listed objects
:param uvCoords: (C Q) Toggle display uv coords of listed mesh objects
:param vertex: (C Q) Toggle vertex display of listed mesh objects
:returns: when in the query mode. none otherwise.
"""
pass
def IntersectCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def menuEditor(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, cellHeight: Union[int, bool]=0, cellWidth: Union[int,
bool]=0, cellWidthHeight: List[int, int]=None, checkBoxPresent: List[bool,
AnyStr, int]=None, checkBoxState: List[bool, AnyStr, int]=None, childArray:
bool=True, command: Union[List[AnyStr, AnyStr, int], bool]=None, defineTemplate:
AnyStr="", delete: List[AnyStr, int]=None, docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, iconMenuCallback: AnyStr="", image:
Union[List[AnyStr, AnyStr, int], bool]=None, isObscured: bool=True, label:
Union[List[AnyStr, AnyStr, int], bool]=None, manage: bool=True, menuItemTypes:
bool=True, noBackground: bool=True, numberOfChildren: bool=True,
numberOfPopupMenus: bool=True, optionBoxCommand: Union[List[AnyStr, AnyStr, int],
bool]=None, optionBoxPresent: List[bool, AnyStr, int]=None, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
radioButtonPresent: List[bool, AnyStr, int]=None, radioButtonState: List[bool,
AnyStr, int]=None, separator: Union[List[AnyStr, int], bool]=None,
statusBarMessage: AnyStr="", style: Union[AnyStr, bool]="", subMenuAt:
List[AnyStr, int]=None, subMenuEditorWindow: AnyStr="", subMenuEditorsOpen:
bool=True, subMenuOf: List[AnyStr, AnyStr, int]=None, topLevelMenu: Union[AnyStr,
bool]="", useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
A menuEditor displays the contents of a popup menu and allows the menu's items to be edited
Menu items are represented by labelled icons which can be dragged around within the editor
to change the menu's layout Various objects can be dragged and dropped into the menuEditor
to create new menu items: toolButtons from the shelf or toolbox, shelfButt
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param cellHeight: (Q E) The height of the icons in the menuEditor
:param cellWidth: (Q E) The width of the icons in the menuEditor
:param cellWidthHeight: (E) The width and height of the icons in the menuEditor
:param checkBoxPresent: (Q E) This controls whether a menu item has a check box or not The
arguments are a flag indicating presence, followed by the position of the menu item Th
:param checkBoxState: (Q E) The state of the check box associated with a menu item The
arguments are a flag indicating state, followed by the position of the menu item This fl
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param command: (Q E) The command or script executed by a menu item The arguments are the
command string or script name, followed by the position of the menu item This f
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param delete: (E) Deletes the menu item at the given position, removing it from the menu
If the menu item has a submenu, and a sub-menuEditor is open and attached to
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param iconMenuCallback: (C) This is the name of a MEL callback procedure that is called to
create the popup menus attached to icons in the menuEditor The callback is called onc
:param image: (Q E) The filename of the icon associated with a menu item This icon is
displayed by the menuEditor to represent the menu item The arguments are the icon
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (Q E) The label of a menu item The arguments are the label text, followed by
the position of the menu item If queried, an array of strings is returned co
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param menuItemTypes: (Q) This is a query only flag Returns an array of strings indicating
the type of contents in each cell of the menuEditor Cells can be "vacant", or may
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param optionBoxCommand: (Q E) The command or script executed by a menu item's associated
option box item The arguments are the command string or script name, followed by the posi
:param optionBoxPresent: (Q E) This controls whether a menu item has an associated option
box item or not The arguments are a flag indicating presence, followed by the position of
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param radioButtonPresent: (Q E) This controls whether a menu item has a radio button or
not The arguments are a flag indicating presence, followed by the position of the menu
item
:param radioButtonState: (Q E) The state of the radio button associated with a menu item
The arguments are a flag indicating state, followed by the position of the menu item This
:param separator: (Q E) In edit mode this adds a separator to the menuEditor at the
specified position The parameters are the radialPosition and the overflowRow If queried
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param style: (Q E) This is the style of icons within the menuEditor Valid styles are
"iconOnly", "textOnly", "iconAndTextHorizontal" and "iconAndTextVertical"
:param subMenuAt: (E) Creates a submenu item at the given position A submenu item created
within the radial portion of a menu will overwrite whatever item (if any) is cur
:param subMenuEditorWindow: (C) The name of the window which contains a sub-menuEditor
Only use when creatitg a sub-menuEditor This window will automatically be closed if a
parent
:param subMenuEditorsOpen: (Q) This is a query only flag Returns an array of booleans,
each of which indicates if a sub-menuEditor is open and attached to the menu item in a
parti
:param subMenuOf: (C) Attaches a sub-menuEditor to its parent menuEditor Only use when
creatitg a sub-menuEditor The arguments are the name of the parent menuEditor, fol
:param topLevelMenu: (Q E) The popup menu to attach to the editor All editing operations
performed in the editor (i.e inserting/deleting/moving an item) will be immediately r
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the editor.
"""
pass
def XgmSetNoiseBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def autoKeyframe(*args, addAttr: name=None, characterOption: Union[AnyStr, bool]="standard",
listAttr: bool=True, noReset: bool=True, state: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[int, Any]:
"""
With no flags, this command will set keyframes on all attributes that have been modified
since an "autoKeyframe -state on" command was issued To stop keeping track of modified
attributes, use "autoKeyframe -state off" autoKeyframe does not create new animation
curves An attribute must have already been keyframed (with the setKeyframe command) fo
:param addAttr: (E) Add to the list of plugs (node.attribute) that autoKeyframe is
currently considering for auto keying This list is transient and short-lived, and is
:param characterOption: (C Q E) Valid options are: "standard", "all" Dictates whether when
auto-keying characters the auto-key works as usual or whether it keys all of the characte
:param listAttr: (Q) Returns the list of plugs (node.attribute) that autoKeyframe is
currently considering for auto keying This list is transient and short-lived, and is
:param noReset: (C E) Must be used in conjunction with the state/st flag When noReset/nr
is specified, the list of plugs to be autokeyed is not cleared when the state cha
:param state: (C Q E) turns on/off remembering of modified attributes
:returns: Number of keyframes set.
"""
pass
def ThreeLeftSplitViewArrangement(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_customPivotToolPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def itemFilterRender(*args, **kwargs)->None:
"""
"""
pass
def SoftModToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeShapeMenuStateAllExceptShadingGroupMembers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DragOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeSelectLights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_quadDrawTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dockControl(*args, allowedArea: Union[AnyStr, List[AnyStr], bool]="all", annotation:
Union[AnyStr, bool]="", area: Union[AnyStr, bool]="", backgroundColor:
Union[List[float, float, float], bool]=None, closeCommand: Script=None,
content: Union[AnyStr, bool]="", defineTemplate: AnyStr="", docTag:
Union[AnyStr, bool]="", dockStation: AnyStr="", dragCallback: Script=None,
dropCallback: Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, enablePopupOption: bool=True, exists: bool=True,
fixedHeight: bool=True, fixedWidth: bool=True, floatChangeCommand: Script=None,
floating: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, label: Union[AnyStr, bool]="", manage: bool=True, moveable:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
r: bool=True, retain: bool=True, sizeable: bool=True, splitLayout: AnyStr="",
state: Union[AnyStr, bool]="", statusBarMessage: AnyStr="", useTemplate:
AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script, bool]=None,
width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Create a dockable control, also known as tool palette or utility window Dock controls are
secondary windows placed in the dock area around the central control in a main window Dock
windows can be moved inside their current area, moved into new areas and floated (e.g
undocked) Dock control consists of a title bar and the content area The titleb
:param allowedArea: (C Q E M) Areas where the dock control may be placed Valid values are
"top", "left", "bottom", "right" and "all" The default is "all"
:param annotation: (C Q E) Annotate the control with an extra string value
:param area: (C Q E) The initial dock area for this dock control This is a required flag
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param closeCommand: (C E) Script executed after the dock control is closed
:param content: (C Q) The name of the control that is the content of this dock control
This is a required flag
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dockStation: (C) The name of the control the window can be docked into If this is
not set it is assumed to be the main window
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param enablePopupOption: (C Q E) Whether or not the menu option for the dock control in
the UI Elements popup menu is enabled
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fixedHeight: (C Q E) Whether or not the dockControl height may be interactively
resized
:param fixedWidth: (C Q E) Whether or not the dockControl width may be interactively
resized
:param floatChangeCommand: (C E) The script executed when the floating state of the dock
widget changes
:param floating: (C Q E) Whether the dock widget is floating A floating dock widget is
presented to the user as an independent window "on top" of main window, instead of bei
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) The label text The default label is the name of the control
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param moveable: (C Q E) Control over whether or not the dockControl may be
undocked/redocked
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param r: (Q E) Whether the dock widget is visible and either floating or at the top of its
dock widget area
:param retain: (C Q E) Control over whether or not the window and its contents are deleted
when closed The default is true The window and its contents are retained when c
:param sizeable: (C Q E) Whether or not the dockControl width may be interactively resized
Deprecated!! Use the fixedWidth flag instead
:param splitLayout: (C) When two windows are added to a single docking area they are by
default tabbed together Setting a value for splitLayout will allow it to be placed n
:param state: (C Q E) When queried this flag will return a string holding the dock control
state information This string is a hexadecimal representation of a binary strin
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def Parent(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintEffectsGlobalSettings(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def menuBarLayout(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, childArray: bool=True, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, fullPathName: bool=True,
height: Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, isObscured: bool=True, manage: bool=True, menuArray: bool=True,
menuBarVisible: bool=True, menuIndex: List[AnyStr, int]=None, noBackground:
bool=True, numberOfChildren: bool=True, numberOfMenus: bool=True,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, statusBarMessage:
AnyStr="", useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a layout containing a menu bar The menu bar will appear and behave similar to any
menu bar created with the 'window -menuBar true' command Menus may be created with a
menuBarLayout as their parent Child controls are simply positioned to fill the
menuBarLayout area beneath the menu bar consequently, some other layout should be used as
the
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param menuArray: (Q) Return a string array containing the names of the menus in the
layout's menu bar
:param menuBarVisible: (C Q E) Visibility of the menu bar
:param menuIndex: (E) Sets the index of a specified menu
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfMenus: (Q) Return the number of menus attached to the layout's menu bar
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def BevelPlus(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeDisplayAsExtraLargeSwatches(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GPUBuiltInDeformerControl(*args, **kwargs)->None:
"""
"""
pass
def PolygonClearClipboardOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def getFileList(*args, filespec: AnyStr="", folder: AnyStr="", **kwargs)->List[AnyStr]:
"""
Returns a list of files matching an optional wildcard pattern Note that this command works
directly on raw system files and does not go through standard Maya file path resolution
:param filespec: (C) wildcard specifier for search
:param folder: (C) return a directory listing
:returns: an array of file names
"""
pass
def ShowAllPolyComponents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyPrimitiveMisc(*args, **kwargs)->None:
"""
"""
pass
def AddEdgeDivisions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SubdivToNURBS(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveSubdivProxyMirror(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySplitEdge(*args, operation: Union[int, bool]=0, caching: bool=True,
constructionHistory: bool=True, name: AnyStr="", nodeState: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
Split Edges.
:param operation: (C Q E) 0 means use a Non-Manifold method, 1 means use a Manifold method
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def UVSnapTogether(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FluidEmitterOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleSoftEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def regionSelectKeyCtx(*args, bottomManip: Union[float, bool]=0.0, exists: bool=True, history:
bool=True, image1: Union[AnyStr, bool]="", image2: Union[AnyStr,
bool]="", image3: Union[AnyStr, bool]="", leftManip: Union[float,
bool]=0.0, name: AnyStr="", rightManip: Union[float, bool]=0.0,
topManip: Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[float, Any]:
"""
This command creates a context which may be used to scale keyframes within the graph editor
using the region select tool
:param bottomManip: (Q) Get a point located inside the bottom manipulator of the region box,
in screen space
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param leftManip: (Q) Get a point located inside the left manipulator of the region box, in
screen space
:param name: (C) If this is a tool command, name the tool appropriately
:param rightManip: (Q) Get a point located inside the right manipulator of the region box,
in screen space
:param topManip: (Q) Get a point located inside the top manipulator of the region box, in
screen space
:returns: Manip values, when queried
"""
pass
def EnableSelectedIKHandles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DefaultQualityDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def attrEnumOptionMenu(*args, annotation: Union[AnyStr, bool]="", attribute: name=None,
backgroundColor: Union[List[float, float, float], bool]=None,
changeCommand: Script=None, defineTemplate: AnyStr="", docTag:
Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, enumeratedItem: Union[List[int, AnyStr],
List[List[int, AnyStr]]]=None, exists: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float,
float, float], bool]=None, isObscured: bool=True, label: Union[AnyStr,
bool]="", manage: bool=True, noBackground: bool=True,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, statusBarMessage:
AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command creates an enumerated attribute control It is usually an option menu
:param annotation: (C Q E) Annotate the control with an extra string value
:param attribute: (C E) Attribute that the menu controls
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) The command string is executed when the value of the option
menu changes
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param enumeratedItem: (C M) Enumerated item and the corresponding string If this flag is
not supplied when the control is created, then the command will try to read the values
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) The label text
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The full name of the control.
"""
pass
def SelectAllMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVNormalBasedProjection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorRenameActiveTab(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmNop(*args, **kwargs)->None:
"""
"""
pass
def OrientJoint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def rollCtx(*args, alternateContext: bool=True, exists: bool=True, history: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", rollScale: Union[float, bool]=0.0, toolName:
Union[AnyStr, bool]="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Create, edit, or query a roll context
:param alternateContext: (C Q) Set the ALT+MMB and ALT+SHIFT+MMB to refer to this context
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param rollScale: (C Q E) In degrees of rotation per 100 pixels of cursor drag
:param toolName: (C Q) Name of the specific tool to which this command refers
:returns: The name of the context
"""
pass
def SetMeshEraseTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_overlayAppendMeshTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MatchTransform(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintSetMembershipTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshFreezeTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModifyLowerRadiusPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_bridgePress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AimConstraintOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def button(*args, actOnPress: bool=True, actionIsSubstitute: bool=True, align: Union[AnyStr,
bool]="", annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, command: Union[Script, bool]=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True, enableKeyboardFocus:
bool=True, exists: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured: bool=True,
label: Union[AnyStr, bool]="", manage: bool=True, noBackground: bool=True,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="", popupMenuArray:
bool=True, preventOverride: bool=True, recomputeSize: bool=True, statusBarMessage:
AnyStr="", useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a button control capable of displaying a textual label and executing a command when
selected by the user
:param actOnPress: (C Q E) If true then the command specified by the command flag will be
executed when a mouse button is pressed If false then that command will be executed a
:param actionIsSubstitute: (C Q E) This flag is obsolete and should no longer be used
:param align: (C Q E) This flag is obsolete and should no longer be used The button label
will always be center-aligned
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param command: (C Q E) Command executed when the control is pressed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) The label text The default label is the name of the control
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param recomputeSize: (C Q E) If true then the control will recompute it's size to just fit
the size of the label If false then the control size will remain fixed as you change t
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def Create2DContainerEmitter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Unfold3DuvUpdateCommand(*args, **kwargs)->None:
"""
"""
pass
def nClothReplaceCacheOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CoarseLevelComponentDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nurbsCopyUVSet(*args, q=True, query=True, e=True, edit=True, **kwargs)->Union[bool, Any]:
"""
This is only a sample command for debugging purposes, which makes a copy of the implicit st
parameterization on a nurbs surface to be the 1st explicit uvset
:returns: Success or Failure.
"""
pass
def XgmSplineCacheDeleteOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RotateUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def webBrowserPrefs(*args, **kwargs)->None:
"""
"""
pass
def webBrowser(*args, annotation: Union[AnyStr, bool]="", back: bool=True, backgroundColor:
Union[List[float, float, float], bool]=None, defineTemplate: AnyStr="", docTag:
Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback: Script=None,
enable: bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
exists: bool=True, find: AnyStr="", forward: bool=True, fullPathName: bool=True,
height: Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, home: bool=True, isObscured: bool=True, manage: bool=True,
matchCase: bool=True, matchWholeWorld: bool=True, noBackground: bool=True,
numberOfPopupMenus: bool=True, openURL: Union[AnyStr, bool]="", parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
reload: bool=True, searchForward: bool=True, statusBarMessage: AnyStr="", stop:
bool=True, urlChangedCb: AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0, wrap:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command is obsolete and will be removed in next version of Maya The internal web
browser of Maya has been replaced by a plug-in which allows your own browser to connect
with Maya Please refer help for information on how to setup communication of Maya with
external web browser application
:param annotation: (C Q E) Annotate the control with an extra string value
:param back: (C) Go back a page
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param find: (C) Find text in a page
:param forward: (C) Go forward a page
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param home: (C) Go to the home page
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param matchCase: (C) True if the match should respect the case
:param matchWholeWorld: (C) True if the match should check the whole world
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param openURL: (C Q E) Open the named URL
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param reload: (C) Reload the current page
:param searchForward: (C) True if search should be going forward from the current location
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param stop: (C) Stop loading a page
:param urlChangedCb: (C) Command to call when the URL changes
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:param wrap: (C) Set to true if the page should wrap
:returns: Full path name to the control
"""
pass
def createPolyPrismCtx(*args, **kwargs)->None:
"""
"""
pass
def CreateLattice(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BothProxySubdivDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BlendShapeEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetOceanPondExample(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def attributeMenu(*args, beginMenu: bool=True, editor: AnyStr="", finishMenu: bool=True,
inputs: bool=True, plug: name=None, regPulldownMenuCommand: AnyStr="",
unregPulldownMenuCommand: int=0, **kwargs)->AnyStr:
"""
Action to generate popup connection menus for Hypershade This command is used internally
by the Hypershade panel
:param beginMenu: (C) If true the menu will be used to start a connection edit so it will
list all available attributes for either inputs or outputs If false the menu wil
:param editor: (C) Name of the Hypergraph, Hypershade or Visor editor for which this menu
is being built This argument is no longer mandatory If it is omitted, the in
:param finishMenu: (C) finishes the menu
:param inputs: (C) If true only attributes which can be used as inputs will be listed If
false only attributes which can be used as outputs will be listed
:param plug: (C) If inputs is false then we are completing a connection and the name of the
plug at the other end of the connection must be supplied
:param regPulldownMenuCommand: (C) This flag will register a callback that allows the user
to define their own popup menu for a specific node type for use in the Hypershade and
Hypergr
:param unregPulldownMenuCommand: (C) This flag will unregister a callback procedure that
was registered with the -regPulldownMenuCommand flag The argument should be the integer
identifi
:returns: Command result
"""
pass
def UVAutomaticProjectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutlinerUnhide(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def floatScrollBar(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dragCommand: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists:
bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, horizontal:
bool=True, isObscured: bool=True, largeStep: Union[float, bool]=0.0, manage:
bool=True, maxValue: Union[float, bool]=0.0, minValue: Union[float,
bool]=0.0, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, statusBarMessage: AnyStr="", step: Union[float, bool]=0.0,
useTemplate: AnyStr="", value: Union[float, bool]=0.0, visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a scroll bar control that accepts only float values and is bound by a minimum and
maximum value The scroll bar displays a marker indicating the current value of the scroll
bar relative to its minimum and maximum values Click and drag the marker or on the scroll
bar itself to change the current value
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the value changes This command is not
invoked when the value changes via the -v/value flag
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command executed when the value changes by dragging the scroll
bar's value marker
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param horizontal: (C Q) Orientation of the slider This flag is true by default, which
corresponds to a horizontally oriented slider
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param largeStep: (C Q E) Larger increment for the scroll bar, ie the increment used when
the press is between the arrow button and the thumb
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxValue: (C Q E) Upper limit of the scroll bar
:param minValue: (C Q E) Lower limit of the scroll bar
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) Smaller increment for the scroll bar, ie the increment used when the
arrow buttons are pressed
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Value of the scroll bar
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def ViewImage(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBifrostFoamMask(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateSubdivSphere(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeShowAllAttrs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllDynamicConstraints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createEditor(*args, noCloseOnDelete: bool=True, queueForDelete: bool=True, **kwargs)->None:
"""
This command creates a property sheet for any dependency node The second argument is the
name of the node, and the first is the name of a layout into which the property sheet
controls should be placed The property sheets created by this command can by
user-customized using the editorTemplate command
:param noCloseOnDelete: (C) If this flag is set then don't close the editor when the data
is deleted
:param queueForDelete: (C) The specified layout is put on a queue When the queue is full,
layouts past the end of the queue are automatically deleted If the layout is already
:returns:
"""
pass
def ExportOfflineFile(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def surface(*args, degreeU: int=0, degreeV: int=0, formU: AnyStr="", formV: AnyStr="", knotU:
Union[float, List[float]]=0.0, knotV: Union[float, List[float]]=0.0, name:
AnyStr="", objectSpace: bool=True, point: Union[List[float, float, float],
List[List[float, float, float]]]=None, pointWeight: Union[List[float, float, float,
float], List[List[float, float, float, float]]]=None, worldSpace: bool=True,
**kwargs)->AnyStr:
"""
The cmd creates a NURBS spline surface (rational or non rational) The surface is created
by specifying control vertices (CV's) and knot sequences in the U and V direction You
cannot query the properties of the surface using this command See examples below
:param degreeU: (C) Degree in surface U direction Default is degree 3
:param degreeV: (C) Degree in surface V direction Default is degree 3
:param formU: (C) The string for open is "open" , for closed is "closed" or for periodic is
"periodic" in U
:param formV: (C) The string for open is "open" , for closed is "closed" or for periodic is
"periodic" in V
:param knotU: (C M) Knot value(s) in U direction One flag per knot value There must be
(numberOfPointsInU + degreeInU - 1) knots and the knot vector must be non-decrea
:param knotV: (C M) Knot value(s) in V direction One flag per knot value There must be
(numberOfPointsInV + degreeInV - 1) knots and the knot vector must be non-decrea
:param name: (C) Name to use for new transforms
:param objectSpace: (C) Should the operation happen in objectSpace?
:param point: (C M) To specify non rational CV with (x, y, z) values "linear" means that
this flag can take values with units Note that you must specify (degree+1) sur
:param pointWeight: (C M) To specify rational CV with (x, y, z, w) values "linear" means
that this flag can take values with units Note that you must specify (degree+1) surf
:param worldSpace: (C) Should the operation happen in worldSpace?
:returns: The path to the new surface
"""
pass
def NURBSSmoothnessHullOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BrushPresetBlendShape(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def makeSingleSurface(*args, caching: bool=True, constructionHistory: bool=True, name:
AnyStr="", nodeState: Union[int, bool]=0, object: bool=True,
stitchTolerance: float=0.1, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
This command performs a stitch and tessellate operation
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node
:param stitchTolerance: (E) Stitch tolerance Default: 0.1
:returns: Object name and node name.
"""
pass
def BridgeEdge(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LatticeDeformKeysToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ArtPaintSkinWeightsTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateUVShellAlongBorder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateMotionTrailOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllImagePlanes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InsertKnot(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeOpenModelEditorWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SurfaceBooleanUnionTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AttachSurfacesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_renderGlobalsTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Squash(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DecreaseGammaCoarse(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateBlendShape(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllRigidBodies(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CopyUVsToUVSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nexCtx(*args, **kwargs)->None:
"""
"""
pass
def SelectAllFluids(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def rotationInterpolation(*args, convert: Union[AnyStr, bool]="", q=True, query=True,
**kwargs)->Union[None, Any]:
"""
The rotationInterpolation command converts the rotation curves to the desired rotation
interpolation representation For example, an Euler-angled representation can be converted
to Quaternion
:param convert: (C Q) Specifies the rotation interpolation mode for the curves after
converting Possible choices are "none" (unsynchronized Euler-angled curves which are
:returns:
"""
pass
def arnoldExportAss(*args, **kwargs)->None:
"""
"""
pass
def refineSubdivSelectionList(*args, **kwargs)->bool:
"""
Refines a subdivision surface set of components based on the selection list The selected
components are subdivided The selection list after the command is the newly created
components at the finer subdivision level
:returns: Command result
"""
pass
def CreateImagePlaneOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def deviceManager(*args, attachment: bool=True, axisCoordChanges: bool=True, axisIndex:
Union[int, bool]=0, axisName: bool=True, axisOffset: bool=True, axisScale:
bool=True, deviceIndex: Union[int, bool]=0, deviceNameFromIndex: Union[int,
bool]=0, numAxis: bool=True, numDevices: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This command queriers the internal device manager for information on attached devices
:param attachment: (Q) Returns the plugs that a device and axis are attached to Expects
the -deviceIndex and axisIndex to be used in conjunction
:param axisCoordChanges: (Q) Returns whether the axis coordinate changes Expects the
-deviceIndex and -axisIndex flags to be used in conjunction
:param axisIndex: (C Q E) Used usually in conjunction with other flags, to indicate the
index of the axis
:param axisName: (Q) Returns the name of the axis Expects the -deviceIndex and -axisIndex
flags to be used in conjunction
:param axisOffset: (Q) Returns the offset of the axis Expects the -deviceIndex and
-axisIndex flags to be used in conjunction
:param axisScale: (Q) Returns the scale of the axis Expects the -deviceIndex and
-axisIndex flags to be used in conjunction
:param deviceIndex: (C Q E) Used usually in conjunction with other flags, to indicate the
index of the device
:param deviceNameFromIndex: (Q) Returns the name of the device with the given index
:param numAxis: (Q) Returns the number of axis this device has Expects the -deviceIndex
flag to be used
:param numDevices: (Q) Returns the number of devices currently attached
:returns:
"""
pass
def DuplicateEdgesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_objectHideTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_paintPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def poseEditor(*args, control: bool=True, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", exists: bool=True, filter: Union[AnyStr, bool]="",
forceMainConnection: Union[AnyStr, bool]="", highlightConnection: Union[AnyStr,
bool]="", lockMainConnection: bool=True, mainListConnection: Union[AnyStr,
bool]="", panel: Union[AnyStr, bool]="", parent: Union[AnyStr, bool]="",
selectionConnection: Union[AnyStr, bool]="", stateString: bool=True, unParent:
bool=True, unlockMainConnection: bool=True, updateMainConnection: bool=True,
useTemplate: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates an editor that derives from the base editor class that has controls
for deformer and control nodes
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the editor
"""
pass
def EnableGlobalStitch(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyExtrudeFacet(*args, attraction: Union[float, bool]=0.0, caching: bool=True,
constructionHistory: bool=True, createCurve: bool=True, divisions:
Union[int, bool]=1, gain: Union[float, List[float], bool]=1.0, gravity:
Union[List[float, float, float], bool]=None, gravityX: Union[float,
bool]=0.0, gravityY: Union[float, bool]=0.0, gravityZ: Union[float,
bool]=0.0, inputCurve: name=None, keepFacesTogether: bool=True,
keepFacetTogether: bool=True, localCenter: Union[int, bool]=0,
localDirection: Union[List[float, float, float], bool]=None,
localDirectionX: Union[float, bool]=0.0, localDirectionY: Union[float,
bool]=0.0, localDirectionZ: Union[float, bool]=0.0, localRotate:
Union[List[float, float, float], bool]=None, localRotateX: Union[float,
bool]=0.0, localRotateY: Union[float, bool]=0.0, localRotateZ: Union[float,
bool]=0.0, localScale: Union[List[float, float, float], bool]=None,
localScaleX: Union[float, bool]=0.0, localScaleY: Union[float, bool]=0.0,
localScaleZ: Union[float, bool]=0.0, localTranslate: Union[List[float,
float, float], bool]=None, localTranslateX: Union[float, bool]=0.0,
localTranslateY: Union[float, bool]=0.0, localTranslateZ: Union[float,
bool]=0.0, magnX: Union[float, bool]=0.0, magnY: Union[float, bool]=0.0,
magnZ: Union[float, bool]=0.0, magnet: Union[List[float, float, float],
bool]=None, name: AnyStr="", nodeState: Union[int, bool]=0, offset:
Union[float, bool]=0.0, pivot: Union[List[float, float, float], bool]=None,
pivotX: Union[float, bool]=0.0, pivotY: Union[float, bool]=0.0, pivotZ:
Union[float, bool]=0.0, random: Union[float, bool]=0.0, reverseAllFaces:
bool=True, rotate: Union[List[float, float, float], bool]=None, rotateX:
Union[float, bool]=0.0, rotateY: Union[float, bool]=0.0, rotateZ:
Union[float, bool]=0.0, scale: Union[List[float, float, float], bool]=None,
scaleX: Union[float, bool]=0.0, scaleY: Union[float, bool]=0.0, scaleZ:
Union[float, bool]=0.0, smoothingAngle: Union[float, bool]=0.0, taper:
Union[float, bool]=1.0, taperCurve_FloatValue: Union[float, bool]=0.0,
taperCurve_Interp: Union[int, bool]=0, taperCurve_Position: Union[float,
bool]=0.0, thickness: Union[float, bool]=0.0, translate: Union[List[float,
float, float], bool]=None, translateX: Union[float, bool]=0.0, translateY:
Union[float, bool]=0.0, translateZ: Union[float, bool]=0.0, twist:
Union[float, bool]=0.0, weight: Union[float, bool]=0.0, worldSpace:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
Extrude faces Faces can be extruded separately or together, and manipulations can be
performed either in world or object space
:param attraction: (C Q E) Attraction, related to magnet The range is [-2.0, 2.0]
Default: 0.0
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createCurve: (C) If true then the operation can create a curve
:param divisions: (C Q E) How many divisions should the extrusion be broken-up into
Default: 1
:param gain: (C Q E M) Gain factor per component Can be painted using Artisan Default:
1.0
:param gravity: (C Q E) The gravity vector Default: 0.0, -1.0, 0.0
:param gravityX: (C Q E) Gravity X coord
:param gravityY: (C Q E) Gravity Y coord
:param gravityZ: (C Q E) Gravity Z coord
:param inputCurve: (C) This flag specifies the name of the curve to be used as input for
the operation
:param keepFacesTogether: (C Q E) How to extrude faces If "on", faces are pulled together
(connected ones stay connected), otherwise they are pulled independently Default: true
:param keepFacetTogether: (C Q E) How to extrude edges If "on", extruded faces produced
from the edges being extruded will be kept together Otherwise they are pulled
independently
:param localCenter: (C Q E) Local center on the edge : 0=Middle point, 1=Start point, 2=End
point Default: 0
:param localDirection: (C Q E) Direction to determine X axis for local space Default: 1.0,
0.0, 0.0
:param localDirectionX: (C Q E) X coord of the X axis
:param localDirectionY: (C Q E) Y coord of the X axis
:param localDirectionZ: (C Q E) Z coord of the X axis
:param localRotate: (C Q E) The local rotations Default: 0.0, 0.0, 0.0
:param localRotateX: (C Q E) Local rotate X coord The range is [0, 360]
:param localRotateY: (C Q E) Local rotate Y coord The range is [0, 360]
:param localRotateZ: (C Q E) Local rotate Z coord : Rotation along the normal The range is
[0, 360]
:param localScale: (C Q E) Local Scale Default: 1.0, 1.0, 1.0
:param localScaleX: (C Q E) Scale X coord
:param localScaleY: (C Q E) Scale Y coord
:param localScaleZ: (C Q E) Scale Z coord
:param localTranslate: (C Q E) Local translate Default: 0.0, 0.0, 0.0
:param localTranslateX: (C Q E) Local translation X coord
:param localTranslateY: (C Q E) Local translation Y coord
:param localTranslateZ: (C Q E) Local translation Z coord : Move along the normal
:param magnX: (C Q E) Magnet X coord
:param magnY: (C Q E) Magnet Y coord
:param magnZ: (C Q E) Magnet Z coord
:param magnet: (C Q E) The magnet vector Default: 0.0, 0.0, 0.0
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param offset: (C Q E) Local offset Faces are moved this distance towards the inside of
the face Default: 0.0
:param pivot: (C Q E) The pivot for scaling and rotation Default: 0.0, 0.0, 0.0
:param pivotX: (C Q E) Pivot X coord
:param pivotY: (C Q E) Pivot Y coord
:param pivotZ: (C Q E) Pivot Z coord
:param random: (C Q E) Random value for all parameters Default: 0.0
:param reverseAllFaces: (C Q E) If "on", original faces are reversed in case of extruding
all faces Default: true
:param rotate: (C Q E) Rotation angles around X, Y, Z Default: 0.0, 0.0, 0.0
:param rotateX: (C Q E) Rotation angle around X
:param rotateY: (C Q E) Rotation angle around Y
:param rotateZ: (C Q E) Rotation angle around Z
:param scale: (C Q E) Scaling vector Default: 1.0, 1.0, 1.0
:param scaleX: (C Q E) Scale X coord
:param scaleY: (C Q E) Scale Y coord
:param scaleZ: (C Q E) Scale Z coord
:param smoothingAngle: (C Q E) Angle below which new edges will be smoothed Default:
kPi/6.0
:param taper: (C Q E) Taper or Scale along the extrusion path Default: 1.0
:param taperCurve_FloatValue: (C Q E) ?????
:param taperCurve_Interp: (C Q E) ????? Default: 0
:param taperCurve_Position: (C Q E) ?????
:param thickness: (C Q E) Faces are moved outwards from their original position to give the
object a consistent thickess Default: 0.0f
:param translate: (C Q E) Translation vector Default: 0.0, 0.0, 0.0
:param translateX: (C Q E) Translation X coord
:param translateY: (C Q E) Translation Y coord
:param translateZ: (C Q E) Translation Z coord
:param twist: (C Q E) Twist or Rotation along the extrusion path Default: 0.0
:param weight: (C Q E) The weight, related to gravity Default: 0.0
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def BrushPresetBlendShadingOff(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisableSelectedIKHandles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SaveSceneOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def StraightenCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Create3DContainerOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NextGreasePencilFrame(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_selectModeMarquee(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def applyAttrPattern(*args, nodeType: AnyStr="", patternName: AnyStr="", **kwargs)->int:
"""
Take the attribute structure described by a pre-defined pattern and apply it either to a
node (as dynamic attributes) or a node type (as extension attributes) The same pattern can
be applied more than once to different nodes or node types as the operation duplicates the
attribute structure described by the pattern See the 'createAttrPatterns' com
:param nodeType: (C) Name of the node type to which the attribute pattern is to be applied
This flag will cause a new extension attribute tree to be created, making the
:param patternName: (C) The name of the pattern to apply The pattern with this name must
have been previously created using the createAttrPatterns command
:returns: Number of nodes or node types to which the attribute were added
"""
pass
def MakeCollideHair(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BreakTangent(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SnapKeysOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorShowConnectedAttrs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InTangentFlat(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideIKHandles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideDeformers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_quadDrawPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetCutBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyEditUVShell(*args, angle: Union[float, bool]=0.0, pivotU: Union[float, bool]=0.0,
pivotV: Union[float, bool]=0.0, relative: bool=True, rotateRatio:
Union[float, bool]=1.0, rotation: bool=True, scale: bool=True, scaleU:
Union[float, bool]=0.0, scaleV: Union[float, bool]=0.0, uValue: Union[float,
bool]=0.0, uvSetName: Union[AnyStr, bool]="", vValue: Union[float,
bool]=0.0, q=True, query=True, **kwargs)->Union[bool, Any]:
"""
Command edits uv shells on polygonal objects When used with the query flag, it returns the
transformation values associated with the specified components
:param angle: (C Q) Specifies the angle value (in degrees) that the uv values are to be
rotated by
:param pivotU: (C Q) Specifies the pivot value, in the u direction, about which the scale
or rotate is to be performed
:param pivotV: (C Q) Specifies the pivot value, in the v direction, about which the scale
or rotate is to be performed
:param relative: (C Q) Specifies whether this command is editing the values relative to the
currently existing values Default is true;
:param rotateRatio: (C Q) Specifies the ratio value that the uv values are to be rotated by
Default is 1.0
:param rotation: (C Q) Specifies whether this command is editing the values with rotation
values
:param scale: (C Q) Specifies whether this command is editing the values with scale values
:param scaleU: (C Q) Specifies the scale value in the u direction
:param scaleV: (C Q) Specifies the scale value in the v direction
:param uValue: (C Q) Specifies the value, in the u direction - absolute if relative flag is
false.
:param uvSetName: (C Q) Specifies the name of the uv set to edit uvs on If not specified
will use the current uv set if it exists
:param vValue: (C Q) Specifies the value, in the v direction - absolute if relative flag is
false.
:returns: Success or Failure.
"""
pass
def CreateConstructionPlaneOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def menu(*args, allowOptionBoxes: bool=True, defineTemplate: AnyStr="", deleteAllItems:
bool=True, docTag: Union[AnyStr, bool]="", enable: bool=True, exists: bool=True,
familyImage: Union[AnyStr, bool]="", helpMenu: bool=True, itemArray: bool=True, label:
Union[AnyStr, bool]="", ltVersion: Union[AnyStr, bool]="", mnemonic: Union[AnyStr,
bool]="", numberOfItems: bool=True, parent: AnyStr="", postMenuCommand: Script=None,
postMenuCommandOnce: bool=True, scrollable: bool=True, tearOff: bool=True,
useTemplate: AnyStr="", version: Union[AnyStr, bool]="", visible: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a new menu and adds it to the default window's menubar if no parent is
specified The menu can be enabled/disabled Note that this command may also be used on
menu objects created using the command menuItem -sm/subMenu true
:param allowOptionBoxes: (C Q) Deprecated All menus now always allow option boxes
Indicate whether the menu will be able to support option box menu items
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param deleteAllItems: (C E) Delete all the items in this menu
:param docTag: (C Q E) Attaches a tag to the menu
:param enable: (C Q E) Enables/disables the menu
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param familyImage: (C Q E) The filename of the icon associated with the menu This icon
will be used if a menu item does not have an icon image defined
:param helpMenu: (C Q E) Indicates that this menu is the help menu and will be the right
most menu in the menu bar On Unix systems the help menu is also right justified in t
:param itemArray: (Q) Return string array of the menu item names
:param label: (C Q E) The text that is displayed for the menu If no label is supplied then
the menuName will be used
:param ltVersion: (C Q E) This flag is used to specify the Maya LT version that this
control feature was introduced, if the version flag is not specified, or if the version fl
:param mnemonic: (C Q E) Set the Alt key to post that menu The character specified must
match the case of its corresponding character in the menu item text, but selection fr
:param numberOfItems: (Q) Return number of items in the menu
:param parent: (C) Specify the window that the menu will appear in
:param postMenuCommand: (C E) Specify a script to be executed when the menu is about to be
shown
:param postMenuCommandOnce: (C Q E) Indicate the -pmc/postMenuCommand should only be
invoked once Default value is false, ie the -pmc/postMenuCommand is invoked every time
the menu is
:param scrollable: (C Q E) Make the popup menus support scrolling Default value is false
:param tearOff: (C) Makes the menu tear-off-able
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param version: (C Q E) Specify the version that this menu feature was introduced The
argument should be given as a string of the version number (e.g "2014", "2015") Curr
:param visible: (C Q E) Shows/hides the menu
:returns: Full path name to the menu.
"""
pass
def timeField(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dragCommand:
Script=None, dropCallback: Script=None, editable: bool=True, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, enterCommand:
Script=None, exists: bool=True, fullPathName: bool=True, height: Union[int,
bool]=0, highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, manage: bool=True, noBackground: bool=True, numberOfPopupMenus:
bool=True, parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, precision:
Union[int, bool]=0, preventOverride: bool=True, receiveFocusCommand: Script=None,
statusBarMessage: AnyStr="", step: Union[time, bool]=None, useTemplate: AnyStr="",
value: Union[time, bool]=None, visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a field control that accepts only time values An invisible slider is attached to
the field and accessed by holding down the Ctrl modifier key while pressing one of the
mouse buttons Dragging the invisible slider to the right with the middle mouse button
increases the field value by the amount specified with the -s/step flag, while dragging
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the field changes This command is not
invoked when the value changes via the -v/value flag
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command executed when dragging in the field
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editable: (C Q E) The edit state of the field By default, this flag is set to true
and the field value may be changed by typing into it If false then the field canno
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param enterCommand: (C E) Command executed when the keypad 'Enter' key is pressed
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param precision: (C Q E) Number of digits to the right of the decimal place
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param receiveFocusCommand: (C E) Command executed when the field receives focus
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) Increment for the invisible slider The field value will change by
this amount when the invisible slider is dragged
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Value of the field
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def WalkTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def StraightenUVBorderOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DuplicateSpecial(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CopyUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBifrostEmitter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FluidGradients(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateShotOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def interactionStyle(*args, **kwargs)->None:
"""
"""
pass
def SaveSceneAsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetShrinkWrapTarget(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshEraseToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectTimeWarp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artFluidAttr(*args, **kwargs)->None:
"""
"""
pass
def TangentsFixed(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def redo(*args, **kwargs)->None:
"""
Takes the most recently undone command from the undo list and redoes it
:returns:
"""
pass
def nurbsToPolygonsPref(*args, chordHeight: Union[float, bool]=0.0, chordHeightRatio:
Union[float, bool]=0.0, delta3D: Union[float, bool]=0.0, edgeSwap:
bool=True, format: Union[int, bool]=0, fraction: Union[float, bool]=0.0,
matchRenderTessellation: Union[int, bool]=0, merge: Union[int, bool]=0,
mergeTolerance: Union[float, bool]=0.0, minEdgeLen: Union[float,
bool]=0.0, polyCount: Union[int, bool]=0, polyType: Union[int, bool]=0,
uNumber: Union[int, bool]=0, uType: Union[int, bool]=0, useChordHeight:
bool=True, useChordHeightRatio: bool=True, vNumber: Union[int, bool]=0,
vType: Union[int, bool]=0, q=True, query=True, **kwargs)->Union[None,
Any]:
"""
This command sets the values used by the nurbs-to-polygons (or "tesselate") preference
This preference is used by Maya menu items and is saved between Maya sessions To query any
of the flags, use the "-query" flag For more information on the flags, see the node
documentation for the "nurbsTessellate" node
:param chordHeight: (C Q)
:param chordHeightRatio: (C Q)
:param delta3D: (C Q)
:param edgeSwap: (C Q)
:param format: (C Q) Valid values are 0, 1 and 2
:param fraction: (C Q)
:param matchRenderTessellation: (C Q)
:param merge: (C Q)
:param mergeTolerance: (C Q)
:param minEdgeLen: (C Q)
:param polyCount: (C Q)
:param polyType: (C Q)
:param uNumber: (C Q)
:param uType: (C Q)
:param useChordHeight: (C Q)
:param useChordHeightRatio: (C Q)
:param vNumber: (C Q)
:param vType: (C Q)
:returns:
"""
pass
def CreateNURBSTorus(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nSoft(*args, convert: bool=True, duplicate: bool=True, duplicateHistory: bool=True, goal:
float=0.0, hideOriginal: bool=True, q=True, query=True, **kwargs)->Union[AnyStr,
Any]:
"""
Makes a nSoft body from the object(s) passed on the command line or in the selection list
The geometry can be a NURBS, polygonal, lattice object The resulting nSoft body is made up
of a hierarchy with a particle shape and a geometry shape, thus: T / \ T G / P
Dynamics are applied to the particle shape and the resulting particle po
:param convert: (C) This tells the command that you want the original object to be the
actual deformed object The particle shape portion of the nSoft body will be inser
:param duplicate: (C) This tells the command that you want to make a copy of the original
object and use the copy as the deforming geometry Input connections to the origi
:param duplicateHistory: (C) This is the same as -d, except that upstream history, is
duplicated as well, instead of just input connections This flag and -d are mutually
exclusi
:param goal: (C) This is the same as -d, but in addition it tells the command that you want
the resulting nSoft body to try to follow the original geometry, using the
:param hideOriginal: (C) This flag is used only when duplicating (-d, -g, or -dh) If set
to true, whichever of the two objects is NOT the nSoft object will be hidden In oth
:returns: array
"""
pass
def GraphEditorUnlockChannel(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutlinerToggleAutoExpandLayers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fluidEmitter(*args, cycleEmission: Union[AnyStr, bool]="", cycleInterval: Union[int,
bool]=0, densityEmissionRate: Union[float, bool]=0.0, fluidDropoff:
Union[float, bool]=0.0, fuelEmissionRate: Union[float, bool]=0.0,
heatEmissionRate: Union[float, bool]=0.0, maxDistance: Union[float, bool]=0.0,
minDistance: Union[float, bool]=0.0, name: Union[AnyStr, bool]="", position:
Union[List[float, float, float], List[List[float, float, float]], bool]=None,
rate: Union[float, bool]=0.0, torusSectionRadius: Union[float, bool]=0.0,
type: Union[AnyStr, bool]="", volumeOffset: Union[List[float, float, float],
bool]=None, volumeShape: Union[AnyStr, bool]="", volumeSweep: Union[float,
bool]=0.0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
Creates, edits or queries an auxiliary dynamics object (for example, a field or emitter)
Creates an emitter object If object names are provided or if objects are selected, applies
the emitter to the named/selected object(s)in the scene Fluid will then be emitted from
each If no objects are named or selected, or if the -pos option is specified,
:param cycleEmission: (Q E) Possible values are "none" and "frame." Cycling emission
restarts the random number stream after a specified interval This can either be a number
of
:param cycleInterval: (Q E) Specifies the number of frames or particles between restarts of
the random number stream See cycleEmission Has no effect if cycleEmission is set to
:param densityEmissionRate: (Q E) Rate at which density is emitted
:param fluidDropoff: (Q E) Fluid Emission Dropoff in volume
:param fuelEmissionRate: (Q E) Rate at which is emitted
:param heatEmissionRate: (Q E) Rate at which density is emitted
:param maxDistance: (Q E) Maximum distance at which emission ends
:param minDistance: (Q E) Minimum distance at which emission starts
:param name: (C Q E) Object name
:param position: (C Q E M) world-space position
:param rate: (Q E) Rate at which particles emitted (can be non-integer) For point emission
this is rate per point per unit time For surface emission it is rate per sq
:param torusSectionRadius: (Q E) Section radius for a torus volume Applies only to torus
Similar to the section radius in the torus modelling primitive
:param type: (Q E) Type of emitter The choices are omni | dir | direction | surf | surface
| curve | curv The default is omni The full definition of these types are:
:param volumeOffset: (Q E) Volume offset of the emitter Volume offset translates the
emission volume by the specified amount from the actual emitter location This is in the e
:param volumeShape: (Q E) Volume shape of the emitter Sets/edits/queries the field's
volume shape attribute If set to any value other than "none", determines a 3-D volume wi
:param volumeSweep: (Q E) Volume sweep of the emitter Applies only to sphere, cone,
cylinder, and torus Similar effect to the sweep attribute in modelling
:returns: Command result
"""
pass
def StitchTogether(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def geometryAppendCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleUVEditorUVStatisticsHUDOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def writeTake(*args, angle: AnyStr="", device: AnyStr="", linear: AnyStr="", noTime: bool=True,
precision: int=6, take: AnyStr="", virtualDevice: AnyStr="", **kwargs)->None:
"""
This action writes a take from a device with recorded data to a take (.mov) file The
writeTake action can also write the virtual definition of a device See also: recordDevice,
readTake, defineVirtualDevice
:param angle: (C) Sets the angular unit used in the take Valid strings are
[deg|degree|rad|radian] C: The default is the current user angular unit
:param device: (C) Specifies the device that contains the take This is a required argument
If the device does not contain a take, the action will fail
:param linear: (C) Sets the linear unit used in the take Valid strings are
[mm|millimeter|cm|centimeter|m|meter|km|kilometer|in|inch|ft|foot|yd|yard|mi|mile] C: The
de
:param noTime: (C) The take (.mov) file will not contain time stamps C: The default is to
put time stamps in the take file
:param precision: (C) Sets the number of digits to the right of the decimal place in the
take file C: The default is 6
:param take: (C) Write out the take to a file with the specified name
:param virtualDevice: (C) Writes out the virtual device definition to a mel script with the
specified file name
:returns:
"""
pass
def attachDeviceAttr(*args, attribute: Union[AnyStr, List[AnyStr]]="", axis: AnyStr="", camera:
bool=True, cameraRotate: bool=True, cameraTranslate: bool=True, clutch:
AnyStr="", device: AnyStr="", selection: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command associates a device/axis pair with a node/attribute pair When the device axis
moves, the value of the attribute is set to the value of the axis This value can be scaled
and offset using the setAttrScale command
:param attribute: (C M) specify the attribute to attach to
:param axis: (C) specify the axis to attach from
:param camera: (C) This flag attaches the device/axis to the current camera The mapping
between device axes and camera controls is uses a heuristic based on the device
:param cameraRotate: (C) This flag attaches the device/axis to the current cameras rotation
controls
:param cameraTranslate: (C) This flag attaches the device/axis to the current cameras
translate controls
:param clutch: (C) specify a clutch button This button must be down for the command string
to be executed If no clutch is specified the command string is executed eve
:param device: (C) specify which device to assign the command string
:param selection: (C) This flag attaches to the nodes in the selection list This is
different from the default arguments of the command since changing the selection will
:returns:
"""
pass
def ToggleCurveSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BakeNonDefHistory(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LoadHIKCharacterState(*args, **kwargs)->None:
"""
"""
pass
def xgmPresetSnapshotContext(*args, **kwargs)->None:
"""
"""
pass
def saveToolSettings(*args, **kwargs)->None:
"""
This command causes all the tools not on the shelf to save their settings as optionVars
This is called automatically by the system when Maya exits
:returns:
"""
pass
def pointOnSurface(*args, caching: bool=True, constructionHistory: bool=True, nodeState:
Union[int, bool]=0, normal: bool=True, normalizedNormal: bool=True,
normalizedTangentU: bool=True, normalizedTangentV: bool=True, parameterU:
Union[float, bool]=0.0, parameterV: Union[float, bool]=0.0, position:
bool=True, tangentU: bool=True, tangentV: bool=True, turnOnPercentage:
bool=False, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[float3], Any]:
"""
This command returns information for a point on a surface If no flag is specified, this
command assumes p/position by default If more than one flag is specifed, then a string
array is returned
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C) Turn the construction history on or off
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param normal: (C Q E) Returns the (x,y,z) normal of the specified point on the surface
:param normalizedNormal: (C Q E) Returns the (x,y,z) normalized normal of the specified
point on the surface
:param normalizedTangentU: (C Q E) Returns the (x,y,z) normalized U tangent of the
specified point on the surface
:param normalizedTangentV: (C Q E) Returns the (x,y,z) normalized V tangent of the
specified point on the surface
:param parameterU: (Q E) The U parameter value on surface Default: 0.0
:param parameterV: (Q E) The V parameter value on surface Default: 0.0
:param position: (C Q E) Returns the (x,y,z) positon of the specified point on the surface
:param tangentU: (C Q E) Returns the (x,y,z) U tangent of the specified point on the
surface
:param tangentV: (C Q E) Returns the (x,y,z) V tangent of the specified point on the
surface
:param turnOnPercentage: (Q E) Whether the parameter is normalized (0,1) or not Default:
false
:returns: Vector query result
"""
pass
def DeleteSelectedContainers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtendCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def getClassification(*args, satisfies: AnyStr="", **kwargs)->List[AnyStr]:
"""
Returns the classification string for a given node type Classification strings look like
file pathnames ("shader/reflective" or "texture/2D", for example) Multiple classifications
can be combined into a single compound classification string by joining the individual
classifications with ':' For example, the classification string
"shader/reflect
:param satisfies: (C) Returns true if the given node type's classification satisfies the
classification string which is passed with the flag A non-compound classification
:returns: Returns the classification strings for the given node type, or
an empty array if
the node type is not classified.
"""
pass
def vnnCopy(*args, **kwargs)->None:
"""
"""
pass
def InsertKeyToolActivate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def duplicateCurve(*args, caching: bool=True, constructionHistory: bool=True, local: bool=True,
maxValue: Union[float, bool]=1.0, mergeItems: bool=True, minValue:
Union[float, bool]=1.0, name: AnyStr="", nodeState: Union[int, bool]=0,
range: bool=True, relative: bool=False, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The duplicateCurve command takes a curve on a surface and and returns the 3D curve The
curve on a surface could be isoparam component, trimmed edge or curve on surface object
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C) Turn the construction history on or off
:param local: (C) Copy the transform of the surface and connect to the local space version
instead
:param maxValue: (C Q E) Maximum parameter value for the curve segment Must be greater
than or equal to the minValue attribute If relative is true, then this attribute has
:param mergeItems: (C) Merge component results where possible For example, instead of
returning a[1] and a[2], return a[1:2]
:param minValue: (C Q E) Minimum parameter value for the curve segment If relative is true,
then this attribute has minimum value of 0.0 Default: 1.0
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param range: (C) Force a curve range on complete input curve
:param relative: (C Q E) True means use a relative parameter range, from 0.0 to 1.0
Otherwise, the parameter values are absolute values Default: false
:returns: Object name and node name
"""
pass
def panel(*args, control: bool=True, copy: AnyStr="", createString: bool=True, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", editString: bool=True, exists: bool=True,
init: bool=True, isUnique: bool=True, label: Union[AnyStr, bool]="",
menuBarRepeatLast: bool=True, menuBarVisible: bool=True, needsInit: bool=True,
parent: AnyStr="", popupMenuProcedure: Union[Script, bool]=None, replacePanel:
AnyStr="", tearOff: bool=True, tearOffCopy: AnyStr="", tearOffRestore: bool=True,
unParent: bool=True, useTemplate: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This command allows editing or querying properties of any panels Not all of the common
properites of panels can be used with this command Flags such as -tearOff and
-replacePanel require that you use the explicit panel command The command 'getPanel
-typeOf panelName' will return the explicit type of a panel
:param control: (Q) Returns the top level control for this panel Usually used for getting
a parent to attach popup menus CAUTION: panels may not have controls at times
:param copy: (E) Makes this panel a copy of the specified panel Both panels must be of the
same type
:param createString: (E) Command string used to create a panel
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the Maya panel
:param editString: (E) Command string used to edit a panel
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param init: (C E) Initializes the panel's default state This is usually done
automatically on file -new and file -open
:param isUnique: (Q) Returns true if only one instance of this panel type is allowed
:param label: (Q E) Specifies the user readable label for the panel
:param menuBarRepeatLast: (C Q E) Controls whether clicking on the menu header with the
middle mouse button would repeat the last selected menu item
:param menuBarVisible: (C Q E) Controls whether the menu bar for the panel is displayed
:param needsInit: (Q E) (Internal) On Edit will mark the panel as requiring initialization
Query will return whether the panel is marked for initialization Used during fil
:param parent: (C) Specifies the parent layout for this panel
:param popupMenuProcedure: (Q E) Specifies the procedure called for building the panel's
popup menu(s) The default value is "buildPanelPopupMenu" The procedure should take one
stri
:param replacePanel: (E) Will replace the specified panel with this panel If the target
panel is within the same layout it will perform a swap
:param tearOff: (Q E) Will tear off this panel into a separate window with a paneLayout as
the parent of the panel When queried this flag will return if the panel has bee
:param tearOffCopy: (C) Will create this panel as a torn of copy of the specified source
panel
:param tearOffRestore: (C E) Restores panel if it is torn off and focus is given to it If
docked, becomes the active panel in the docked window This should be the default flag
:param unParent: (E) Specifies that the panel should be removed from its layout This
(obviously) cannot be used with query
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns:
"""
pass
def nClothAppendOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PasteUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleSurfaceOrigin(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintVertexColorToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePlatonicSolidOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def diskCache(*args, append: bool=True, cacheType: Union[AnyStr, bool]="", close: Union[AnyStr,
bool]="", closeAll: bool=True, delete: Union[AnyStr, bool]="", deleteAll:
bool=True, empty: Union[AnyStr, bool]="", emptyAll: bool=True, enabledCachesOnly:
bool=True, endTime: Union[time, bool]=None, frameRangeType: Union[AnyStr,
bool]="", overSample: bool=True, samplingRate: Union[int, bool]=0, startTime:
Union[time, bool]=None, tempDir: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
Command to create, clear, or close disk cache(s)
:param append: (C Q) Append at the end and not to flush the existing cache
:param cacheType: (C Q) Specifies the type of cache to overwrite "mcfp" for particle
playback cache, "mcfi" for particle initial cache "mcj" for jiggle cache This option
:param close: (C Q) Close the cache given the disk cache node name If
-eco/enabledCachesOnly is "true" only enabled disk cache nodes are affected
:param closeAll: (C Q) Close all disk cache files If -eco/enabledCachesOnly is "true" only
enabled disk cache nodes are affected
:param delete: (C Q) Delete the cache given the disk cache node name If
-eco/enabledCachesOnly is "true" only enabled disk cache nodes are affected
:param deleteAll: (C Q) Delete all disk cache files If -eco/enabledCachesOnly is "true"
only enabled disk cache nodes are affected
:param empty: (C Q) Clear the content of the disk cache with the given disk cache node name
If -eco/enabledCachesOnly is "true" only enabled disk cache nodes are affect
:param emptyAll: (C Q) Clear the content of all disk caches If -eco/enabledCachesOnly is
"true" only enabled disk cache nodes are affected
:param enabledCachesOnly: (C Q) When present, this flag restricts the -ea/emptyAll, so that
only "enabled" disk caches (i.e., disk cache nodes with the ".enable" attribute set to "t
:param endTime: (C Q) Specifies the end frame of the cache range
:param frameRangeType: (C Q) Specifies the type of frame range to use, namely "Render
Globals", "Time Slider", and "Start/End" In the case of "Time Slider", startFrame and
endFr
:param overSample: (C Q) Over sample if true Otherwise, under sample
:param samplingRate: (C Q) Specifies how frequently to sample relative to each frame When
over-sampling (-overSample has been specified), this parameter determines how many ti
:param startTime: (C Q) Specifies the start frame of the cache range
:param tempDir: (C Q) Query-only flag for the location of temporary diskCache files
:returns:
"""
pass
def sbs_AffectTheseAttributes(*args, **kwargs)->None:
"""
"""
pass
def SetRigidBodyCollision(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateText(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_softSelStickyPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GoToMinFrame(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def renderSetupLegacyLayer(*args, **kwargs)->None:
"""
"""
pass
def ToggleVertexNormalDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def bezierCurveToNurbs(*args, **kwargs)->List[AnyStr]:
"""
The bezierCurveToNurbs command attempts to convert an existing NURBS curve to a Bezier
curve
:returns: (object name and node name)
"""
pass
def mirrorShape(*args, **kwargs)->None:
"""
"""
pass
def assignViewportFactories(*args, materialFactory: Union[AnyStr, bool]="", nodeType:
Union[AnyStr, bool]="", textureFactory: Union[AnyStr, bool]="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Sets viewport factories for displays as materials or textures
:param materialFactory: (C Q E) Set or query the materialFactory for the node type
:param nodeType: (C Q E) The node type
:param textureFactory: (C Q E) Set or query the textureFactory for the node type
:returns:
"""
pass
def CopySelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertSelectionToEdgePerimeter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeOpenConnectWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllChannels(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PixelMoveLeft(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def attrNavigationControlGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0,
adjustableColumn3: int=0, adjustableColumn4: int=0,
adjustableColumn5: int=0, adjustableColumn6: int=0, annotation:
Union[AnyStr, bool]="", attrNavDecision: Union[List[name, AnyStr],
bool]=None, attribute: Union[name, bool]=None, backgroundColor:
Union[List[float, float, float], bool]=None, columnAlign:
Union[List[int, AnyStr], List[List[int, AnyStr]]]=None,
columnAlign2: List[AnyStr, AnyStr]=None, columnAlign3: List[AnyStr,
AnyStr, AnyStr]=None, columnAlign4: List[AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAlign5: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAlign6: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr, AnyStr]=None, columnAttach: Union[List[int, AnyStr, int],
List[List[int, AnyStr, int]]]=None, columnAttach2: List[AnyStr,
AnyStr]=None, columnAttach3: List[AnyStr, AnyStr, AnyStr]=None,
columnAttach4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach5: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnOffset2: List[int, int]=None, columnOffset3:
List[int, int, int]=None, columnOffset4: List[int, int, int,
int]=None, columnOffset5: List[int, int, int, int, int]=None,
columnOffset6: List[int, int, int, int, int, int]=None,
columnWidth: Union[List[int, int], List[List[int, int]]]=None,
columnWidth1: int=0, columnWidth2: List[int, int]=None,
columnWidth3: List[int, int, int]=None, columnWidth4: List[int,
int, int, int]=None, columnWidth5: List[int, int, int, int,
int]=None, columnWidth6: List[int, int, int, int, int, int]=None,
connectAttrToDropped: Union[Script, bool]=None,
connectNodeToDropped: Union[Script, bool]=None, connectToExisting:
Union[Script, bool]=None, createNew: Union[Script, bool]=None,
defaultTraversal: Union[Script, bool]=None, defineTemplate:
AnyStr="", delete: Union[AnyStr, bool]="", disconnect:
Union[Script, bool]=None, docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus:
bool=True, exists: bool=True, extraButton: bool=True,
extraButtonCommand: Script=None, extraButtonIcon: Union[AnyStr,
bool]="", fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None,
ignore: Union[Script, bool]=None, ignoreNotSupported: bool=True,
isObscured: bool=True, label: Union[AnyStr, bool]="", manage:
bool=True, noBackground: bool=True, noIgnorableMenu: bool=True,
noKeyableMenu: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, relatedNodes: Union[Script, bool]=None,
rowAttach: Union[List[int, AnyStr, int], List[List[int, AnyStr,
int]]]=None, statusBarMessage: AnyStr="", unignore: Union[Script,
bool]=None, useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param attrNavDecision: (C Q E) The first argument is the name of an attribute The button
will be attached to the attribute so the button can be kept in synch with the attribute T
:param attribute: (C Q E) The name of an attribute The button will be attached to the
attribute so the button can be kept in synch with the attribute
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param connectAttrToDropped: (C Q E) The script to execute when a node is dragged and
dropped onto an attribute (multilister dnd attribute editor) Your script should take in
two argumen
:param connectNodeToDropped: (C Q E) The script to execute when a node is dragged and
dropped onto a node (the multilister issues this) Your script should take in two
arguments: the sou
:param connectToExisting: (C Q E) The script to execute when a connection should be made to
an existing node
:param createNew: (C Q E) The script to execute when a new "connection" is requested
:param defaultTraversal: (C Q E) The script to execute to find out the name of the default
traversal node The script you attach should be able to take in one argument (the
attribute
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param delete: (C Q E) The script to execute when the connection (and the node connected
to) should be deleted
:param disconnect: (C Q E) The script to execute when a "disconnection" is requested
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param extraButton: (C) Add an extra icon button to the last of this control
:param extraButtonCommand: (C E) The command string is executed when the extra button is
clicked
:param extraButtonIcon: (C Q E) The icon file name of the extra button
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param ignore: (C Q E) The script to execute when the connection should be ignored
:param ignoreNotSupported: () Obsolete flag; has no effect
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) Text for the control
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param noIgnorableMenu: (C E) Not show ignorable related popup menu when right click the
label
:param noKeyableMenu: (C E) Not show keyable related popup menu when right click the label
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param relatedNodes: (C Q E) The script to execute to find out what the related nodes are
The script you attach should be able to take in one argument (the attribute) and return
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param unignore: (C Q E) The script to execute when the connection should be unignored
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def ContentBrowserLayout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def viewCamera(*args, move: name=None, sideView: bool=True, topView: bool=True,
**kwargs)->None:
"""
The viewCamera command is used to position a camera to look directly at the side or top of
another camera This is primarily useful for the user when he or she is setting
depth-of-field and clipping planes, if they are being used The default behaviour: If no
other flags are specified, the camera in the active panel is moved and the -t is presumed
:param move: (C) Specifies which camera needs to move
:param sideView: (C) Position camera to look at the side of the target camera
:param topView: (C) Position camera to look at the top of the target camera (default)
:returns:
"""
pass
def FBXPopSettings(*args, **kwargs)->None:
"""
"""
pass
def CreateSubCharacter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CylindricalProjectionOptions(*args, **kwargs)->None:
"""
unknown
"""
pass
def GoToPreviousDrivenKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeGraphRemoveUnselected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateNURBSCube(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyCollapseTweaks(*args, hasVertexTweaks: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
A command that updates a mesh's vertex tweaks by applying its tweak data (stored on the
mesh node) onto its respective vertex data This command is only useful in cases where no
construction history is associated with the shape node If a mesh name is not specified as
input, a singly selected mesh (if any) will have its tweaked vertices baked
:param hasVertexTweaks: (C Q) Determines whether an individual mesh has vertex tweaks
:returns:
"""
pass
def SelectMeshUVShell(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_coordSpaceLocal(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def attachSurface(*args, blendBias: Union[float, bool]=0.5, blendKnotInsertion: bool=False,
caching: bool=True, directionU: bool=True, keepMultipleKnots: bool=True,
method: Union[int, bool]=0, nodeState: Union[int, bool]=0, parameter:
Union[float, bool]=0.1, reverse1: bool=False, reverse2: bool=False, swap1:
bool=False, swap2: bool=False, twist: bool=False, constructionHistory:
bool=True, name: AnyStr="", object: bool=True, replaceOriginal: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This attach command is used to attach surfaces Once the surfaces are attached, there will
be multiple knots at the joined point(s) These can be kept or removed if the user wishes
The end of the first surface is attached to the start of the second surface in the
specified direction Note: if the command is done with Keep Original off there will
:param blendBias: (C Q E) Skew the result toward the first or the second curve depending on
the blend factory being smaller or larger than 0.5 Default: 0.5
:param blendKnotInsertion: (C Q E) If set to true, insert a knot in one of the original
curves (relative position given by the parameter attribute below) in order to produce a
slightly
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param directionU: (C Q E) If true attach in U direction of surface and V direction
otherwise Default: true
:param keepMultipleKnots: (C Q E) If true, keep multiple knots at the join parameter
Otherwise remove them Default: true
:param method: (C Q E) Attach method (connect-0, blend-1) Default: 0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param parameter: (C Q E) The parameter value for the positioning of the newly inserted
knot Default: 0.1
:param reverse1: (C Q E) If true, reverse the direction (specified by directionU) of the
first input surface before doing attach Otherwise, do nothing to the first input sur
:param reverse2: (C Q E) If true, reverse the direction (specified by directionU) of the
second input surface before doing attach Otherwise, do nothing to the second input s
:param swap1: (C Q E) If true, swap the UV directions of the first input surface before
doing attach Otherwise, do nothing to the first input surface before attaching NO
:param swap2: (C Q E) If true, swap the UV directions of the second input surface before
doing attach Otherwise, do nothing to the second input surface before attaching
:param twist: (C Q E) If true, reverse the second surface in the opposite direction
(specified by directionU) before doing attach This will avoid twists in the attached s
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def polySubdivideFacet(*args, divisions: Union[int, bool]=1, divisionsU: Union[int, bool]=0,
divisionsV: Union[int, bool]=0, mode: Union[int, bool]=0, subdMethod:
Union[int, bool]=0, caching: bool=True, constructionHistory: bool=True,
name: AnyStr="", nodeState: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Subdivides a face into quads or triangles In quad mode, a center point is introduced at
the center of each face and midpoints are inserted on all the edges of each face New faces
(all quadrilaterals) are built by adding edges from the midpoints towards the center In
triangle mode, only the center point is created; new faces (all triangles) are
:param divisions: (C Q E) This number specifies how many times to recursively subdivide the
selected faces For example, with divisions set to 3 in quad mode, each initial qua
:param divisionsU: (C Q E) The number of subdivision steps to perform along the U direction
A square face will be subdivided into 4^(divisions) faces in quad mode, 4*3^(divisi
:param divisionsV: (C Q E) The number of subdivision steps to perform along the V direction
A square face will be subdivided into 4^(divisions) faces in quad mode, 4*3^(divisi
:param mode: (C Q E) The subdivision mode 0: subdivision into quads 1: subdivision into
triangles C: Default is 0 Q: When queried, this flag returns an int
:param subdMethod: (C Q E) Type of subdivision to use: 0 - exponential - traditional
subdivision 1 - linear - number of faces per edge grows linearly
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def convertIffToPsd(*args, iffFileName: Union[AnyStr, bool]="", psdFileName: Union[AnyStr,
bool]="", xResolution: Union[int, bool]=0, yResolution: Union[int, bool]=0,
q=True, query=True, **kwargs)->Union[None, Any]:
"""
Converts iff file to PSD file of given size
:param iffFileName: (C Q) Input iff file name
:param psdFileName: (C Q) Output file name
:param xResolution: (C Q) X resolution of the image
:param yResolution: (C Q) Y resolution of the image
:returns:
"""
pass
def control(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float, float,
float], bool]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True, manage:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This command allows you to edit or query the properties of any control
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns:
"""
pass
def ShowJoints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def uiTemplate(*args, defineTemplate: AnyStr="", exists: bool=True, useTemplate: AnyStr="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a new command template object Template objects can hold default flag
arguments for multiple UI commands The command arguments are specified with the individual
commands using the -defineTemplate flag and the desired flags and arguments See also
setUITemplate
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the uiTemplate created.
"""
pass
def GraphPaste(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UnfoldUVOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolySelectTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleFBIKEffectorsPinState(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LongPolygonNormals(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmSelectBrushContext(*args, **kwargs)->None:
"""
"""
pass
def ShareColorInstances(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVCylindricProjection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleSurfaceFaceCenters(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AssignNewMaterial(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CloudImportExport(*args, **kwargs)->None:
"""
"""
pass
def dR_showHelp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fluidDeleteCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BatchBake(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NormalConstraint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def boneLattice(*args, after: bool=True, afterReference: bool=True, before: bool=True, bicep:
Union[float, bool]=0.0, deformerTools: bool=True, exclusive: Union[AnyStr,
bool]="", frontOfChain: bool=True, geometry: Union[AnyStr, List[AnyStr],
bool]="", geometryIndices: bool=True, ignoreSelected: bool=True,
includeHiddenSelections: bool=False, joint: Union[AnyStr, bool]="", lengthIn:
Union[float, bool]=0.0, lengthOut: Union[float, bool]=0.0, name: AnyStr="",
parallel: bool=True, prune: bool=True, remove: Union[bool, List[bool]]=True,
split: bool=True, transform: AnyStr="", tricep: Union[float, bool]=0.0,
widthLeft: Union[float, bool]=0.0, widthRight: Union[float, bool]=0.0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates/edits/queries a boneLattice deformer The name of the created/edited
object is returned Usually you would make use of this functionality through the higher
level flexor command
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param bicep: (C Q E) Affects the bulging of lattice points on the inside of the bend
Positive/negative values cause the points to bulge outwards/inwards Default value i
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param joint: (C Q E) Specifies which joint will be used to drive the bulging behaviors
:param lengthIn: (C Q E) Affects the location of lattice points along the upper half of the
bone Positive/negative values cause the points to move away/towards the center of
:param lengthOut: (C Q E) Affects the location of lattice points along the lower half of
the bone Positive/negative values cause the points to move away/towards the center of
:param name: (C) Used to specify the name of the node being created
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:param transform: (C) Specifies which dag node is being used to rigidly transform the
lattice which this node is going to deform If this flag is not specified an identity
:param tricep: (C Q E) Affects the bulging of lattice points on the outside of the bend
Positive/negative values cause the points to bulge outwards/inwards Default value
:param widthLeft: (C Q E) Affects the bulging of lattice points on the left side of the
bend Positive/negative values cause the points to bulge outwards/inwards Default valu
:param widthRight: (C Q E) Affects the bulging of lattice points on the right side of the
bend Positive/negative values cause the points to bulge outwards/inwards Default val
:returns: Name of bone lattice algorithm node created/edited.
"""
pass
def smoothCurve(*args, caching: bool=True, nodeState: Union[int, bool]=0, smoothness:
Union[float, bool]=10.0, constructionHistory: bool=True, name: AnyStr="",
object: bool=True, replaceOriginal: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The smooth command smooths the curve at the given control points
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param smoothness: (C Q E) smoothness factor Default: 10.0
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def dR_convertSelectionToEdge(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def radioMenuItemCollection(*args, defineTemplate: AnyStr="", exists: bool=True, gl: bool=True,
parent: AnyStr="", useTemplate: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a radioMenuItemCollection Attach radio menu items to radio menu item
collection objects to get radio button behaviour Radio menu item collections will be
parented to the current menu if no parent is specified with the -p/parent flag As children
of the menu they will be deleted when the menu is deleted Collections may also s
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param gl: (C Q) Set the collection to have no parent menu Global collections must be
explicitly deleted
:param parent: (C) The parent of the collection The collection will be deleted along with
the parent
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: Full path name to the collection.
"""
pass
def CreateQuickSelectSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DecreaseManipulatorSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nurbsToPoly(*args, caching: bool=True, constructionHistory: bool=True, curvatureTolerance:
Union[int, bool]=2, explicitTessellationAttributes: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, object: bool=True, smoothEdge: bool=False,
smoothEdgeRatio: Union[float, bool]=0.99, uDivisionsFactor: Union[float,
bool]=1.5, vDivisionsFactor: Union[float, bool]=1.5, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command tesselates a NURBS surface and produces a polygonal surface The name of the
new polygonal surface is returned If construction history is ON, then the name of the new
dependency node is returned as well
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C) Turn the construction history on or off
:param curvatureTolerance: (C Q E) Presets for level of secondary criteria curvature
tolerance: 0 = highest tolerance, 1 = high tolerance, 2 = medium tolerance, 3 = no
tolerance Defaul
:param explicitTessellationAttributes: (C Q E) specify advanced or novice mode for
tessellation parameters Default: true
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node
:param smoothEdge: (C Q E) Specifies if the decision to continue tessellation should be
based on the nurbs edge smoothness Default: false
:param smoothEdgeRatio: (C Q E) Specifies the edge smooth ratio The higher the value, the
smoother the edge will be Default: 0.99
:param uDivisionsFactor: (C Q E) Specifies the tessellation increase factor in U for novice
mode Default: 1.5
:param vDivisionsFactor: (C Q E) Specifies the tessellation increase factor in V for novice
mode Default: 1.5
:returns: The polygon and optionally the dependency node name.
"""
pass
def subdListComponentConversion(*args, border: bool=True, fromEdge: bool=True, fromFace:
bool=True, fromUV: bool=True, fromVertex: bool=True, internal:
bool=True, toEdge: bool=True, toFace: bool=True, toUV:
bool=True, toVertex: bool=True, uvShell: bool=True,
uvShellBorder: bool=True, **kwargs)->List[AnyStr]:
"""
This command converts subdivision surface components from one or more types to another one
or more types, and returns the list of the conversion It does not change the currently
selected objects Use the "-in/internal" flag to specify conversion to "connected" vs
"contained" components For example, if the internal flag is specified when convert
:param border: (C) Convert to a border
:param fromEdge: (C) Indicates the component type to convert from: Edges
:param fromFace: (C) Indicates the component type to convert from: Faces
:param fromUV: (C) Indicates the component type to convert from: UVs
:param fromVertex: (C) Indicates the component type to convert from: Vertex
:param internal: (C) Applicable when converting from "smaller" component types to larger
ones Specifies conversion to "connected" vs "contained" components See example
:param toEdge: (C) Indicates the component type to convert to: Edges
:param toFace: (C) Indicates the component type to convert to: Faces
:param toUV: (C) Indicates the component type to convert to: UVs
:param toVertex: (C) Indicates the component type to convert to: Vertices
:param uvShell: (C) Will return UV components within the same UV shell Only works with
-tuv and -fuv flags
:param uvShellBorder: (C) Will return UV components on the border within the same UV shell
Only works with -tuv and -fuv flags
:returns: List of subdivision surface components
"""
pass
def HideDynamicConstraints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def namespace(*args, absoluteName: bool=True, addNamespace: AnyStr="", collapseAncestors:
AnyStr="", deleteNamespaceContent: bool=True, exists: Union[AnyStr, bool]="",
force: bool=True, isRootNamespace: Union[AnyStr, bool]="",
mergeNamespaceWithOther: AnyStr="", mergeNamespaceWithParent: bool=True,
mergeNamespaceWithRoot: bool=True, moveNamespace: List[AnyStr, AnyStr]=None,
parent: AnyStr="", recurse: bool=True, relativeNames: bool=True, removeNamespace:
AnyStr="", rename: List[AnyStr, AnyStr]=None, setNamespace: AnyStr="",
validateName: AnyStr="", q=True, query=True, **kwargs)->Union[AnyStr, Any]:
"""
This command allows a namespace to be created, set or removed A namespace is a simple
grouping of objects under a given name Namespaces are primarily used to resolve name-clash
issues in Maya, where a new object has the same name as an existing object (from importing
a file, for example) Using namespaces, you can have two objects with the same
:param absoluteName: (C Q) This is a general flag which can be used to specify the desired
format for the namespace(s) returned by the command The absolute name of the namespa
:param addNamespace: (C) Create a new namespace with the given name Both qualified names
("A:B") and unqualified names ("A") are acceptable If any of the higher-level names
:param collapseAncestors: (C) Delete all empty ancestors of the given namespace An empty
namespace is a a namespace that does not contain any objects or other nested namespaces
:param deleteNamespaceContent: (C) Used with the 'rm/removeNamespace' flag to indicate that
when removing a namespace the contents of the namespace will also be removed
:param exists: (Q) Returns true if the specified namespace exists, false if not
:param force: (C) Used with 'mv/moveNamespace' to force the move operation to ignore name
clashes
:param isRootNamespace: (Q) Returns true if the specified namespace is root, false if not
:param mergeNamespaceWithOther: (C) Used with the 'rm/removeNamespace' flag When removing
a namespace, move the rest of the namespace content to the specified namespace
:param mergeNamespaceWithParent: (C) Used with the 'rm/removeNamespace' flag When removing
a namespace, move the rest of the namespace content to the parent namespace
:param mergeNamespaceWithRoot: (C) Used with the 'rm/removeNamespace' flag When removing a
namespace, move the rest of the namespace content to the root namespace
:param moveNamespace: (C) Move the contents of the first namespace into the second
namespace Child namespaces will also be moved Attempting to move a namespace containing
re
:param parent: (C) Used with the 'addNamespace' or 'rename' flags to specifiy the parent of
the new namespace The full namespace parent path is required When using 'a
:param recurse: (Q) Can be used with the 'exists' flag to recursively look for the
specified namespace
:param relativeNames: (C Q) Turns on relative name lookup, which causes name lookups within
Maya to be relative to the current namespace By default this is off, meaning that na
:param removeNamespace: (C) Deletes the given namespace The namespace must be empty for it
to be deleted
:param rename: (C) Rename the first namespace to second namespace name Child namespaces
will also be renamed Both names are relative to the current namespace Use the
:param setNamespace: (C) Sets the current namespace
:param validateName: (C) Convert the specified name to a valid name to make it contain no
illegal characters The leading illegal characters will be removed and other illegal
:returns: Command result
"""
pass
def ProjectCurveOnMesh(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Wave(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllSounds(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RenderGlobalsWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyCylinder(*args, axis: Union[List[float, float, float], bool]=None, caching: bool=True,
constructionHistory: bool=True, createUVs: Union[int, bool]=2, height:
Union[float, bool]=2.0, name: AnyStr="", nodeState: Union[int, bool]=0,
object: bool=True, radius: Union[float, bool]=1.0, roundCap: bool=False,
subdivisionsAxis: Union[int, bool]=20, subdivisionsCaps: Union[int, bool]=0,
subdivisionsHeight: Union[int, bool]=1, subdivisionsX: Union[int, bool]=20,
subdivisionsY: Union[int, bool]=1, subdivisionsZ: Union[int, bool]=1, texture:
Union[int, bool]=2, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The cylinder command creates a new polygonal cylinder
:param axis: (C Q E) This flag specifies the primitive axis used to build the cylinder Q:
When queried, this flag returns a float[3]
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createUVs: (C Q E) Create UVs or not 0: No UVs 1: No Normalization 2: Normalize 3:
Normalize and Preserve Aspect Ratio Default: 2
:param height: (C Q E) Height of the cylinder Default: 2.0
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node (where applicable)
:param radius: (C Q E) Radius of the cylinder Default: 1.0
:param roundCap: (C Q E) To indicate whether we need a round cap Default: false
:param subdivisionsAxis: (C Q E) Subdivisions around the axis Default: 20
:param subdivisionsCaps: (C Q E) Subdivisions on the caps Default: 0
:param subdivisionsHeight: (C Q E) Subdivisions along the height Default: 1
:param subdivisionsX: (C Q E) This specifies the number of subdivisions in the X direction
for the cylinder C: Default is 20 Q: When queried, this flag returns an int
:param subdivisionsY: (C Q E) This flag specifies the number of subdivisions in the Y
direction for the cylinder C: Default is 1 Q: When queried, this flag returns an int
:param subdivisionsZ: (C Q E) This flag specifies the number of subdivisions in the Z
direction for the cylinder C: Default is 1 Q: When queried, this flag returns an int
:param texture: (C Q E) What texture mechanism to be applied 0=No textures, 1=Object,
2=Faces Default: 2
:returns: Object name and node name.
"""
pass
def InTangentPlateau(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RelaxUVShellOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyMergeVertex(*args, alwaysMergeTwoVertices: bool=False, caching: bool=True,
constructionHistory: bool=True, distance: Union[float, bool]=0.0,
mergeToComponents: Union[AnyStr, bool]="", name: AnyStr="", nodeState:
Union[int, bool]=0, texture: bool=True, worldSpace: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Merge vertices within a given threshold.
:param alwaysMergeTwoVertices: (C Q E) This flag specifies whether to always merge if only
two vertices are selected regardless of distance C: Default is false Q: When queried,
this flag
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param distance: (C Q E) This flag specifies the distance within which vertices will be
merged C: Default is 0.0 (i.e vertices are coincident) Q: When queried, this flag r
:param mergeToComponents: (C Q E) Optionally defines the position to merge all of the
vertices to If set, the distance flag will be ignored, and instead the center point of the
set c
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param texture: (C Q E) This flag specifies whether the texture is sewn in addition to the
3d edge C: Default is true Q: When queried, this flag returns a boolean
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def geometryReplaceCacheFrames(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PluginManager(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SplitPolygonToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OneClickSetupMotionBuilderCharacterStream(*args, **kwargs)->None:
"""
"""
pass
def tension(*args, after: bool=True, afterReference: bool=True, before: bool=True,
deformerTools: bool=True, envelope: Union[float, bool]=1, exclusive: Union[AnyStr,
bool]="", frontOfChain: bool=True, geometry: Union[AnyStr, List[AnyStr], bool]="",
geometryIndices: bool=True, ignoreSelected: bool=True, includeHiddenSelections:
bool=False, inwardConstraint: Union[float, bool]=0.0, name: AnyStr="",
outwardConstraint: Union[float, bool]=0.0, parallel: bool=True, pinBorderVertices:
bool=True, prune: bool=True, remove: Union[bool, List[bool]]=True,
smoothingIterations: Union[int, bool]=10, smoothingStep: Union[float, bool]=0.5,
split: bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command is used to create, edit and query tension nodes
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param envelope: (C Q E) Envelope of the tension node The envelope determines the percent
of deformation Value is clamped to [0, 1] range Default is 1
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param inwardConstraint: (C Q E) Constrains the movement of the vertex to not move inward
from the input deforming shape to preserve the contour Value is in the [0,1] range
Default
:param name: (C) Used to specify the name of the node being created
:param outwardConstraint: (C Q E) Constrains the movement of the vertex to not move outward
from the input deforming shape to preserve the contour Value is in the [0,1] range
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param pinBorderVertices: (C Q E) If enabled, vertices on mesh borders will be pinned to
their current position during smoothing Default is true
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param smoothingIterations: (C Q E) Number of smoothing iterations performed by the tension
node Default is 10
:param smoothingStep: (C Q E) Step amount used per smoothing iteration Value is clamped to
[0, 1] range A higher value may lead to instabilities but converges faster compared to
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:returns: Tension deformer node name
"""
pass
def select(*args, add: bool=True, addFirst: bool=True, all: bool=True, allDagObjects: bool=True,
allDependencyNodes: bool=True, clear: bool=True, containerCentric: bool=True,
deselect: bool=True, hierarchy: bool=True, noExpand: bool=True, replace: bool=True,
symmetry: bool=True, symmetrySide: int=0, toggle: bool=True, visible: bool=True,
**kwargs)->None:
"""
This command is used to put objects onto or off of the active list If none of the five
flags [-add, -af, -r, -d, -tgl] are specified, the default is to replace the objects on the
active list with the given list of objects When selecting a set as in "select set1", the
behaviour is for all the members of the set to become selected instead of the s
:param add: (C) Indicates that the specified items should be added to the active list
without removing existing items from the active list
:param addFirst: (C) Indicates that the specified items should be added to the front of the
active list without removing existing items from the active list
:param all: (C) Indicates that all deletable root level dag objects and all deletable
non-dag dependency nodes should be selected
:param allDagObjects: (C) Indicates that all deletable root level dag objects should be
selected
:param allDependencyNodes: (C) Indicates that all deletable dependency nodes including all
deletable dag objects should be selected
:param clear: (C) Clears the active list This is more efficient than "select -d;" Also
"select -d;" will not remove sets from the active list unless the "-ne" flag i
:param containerCentric: (C) Specifies that the same selection rules as apply to selection
in the main viewport will also be applied to the select command In particular, if the
:param deselect: (C) Indicates that the specified items should be removed from the active
list if they are on the active list
:param hierarchy: (C) Indicates that all children, grandchildren, .. of the specified dag
objects should also be selected
:param noExpand: (C) Indicates that any set which is among the specified items should not
be expanded to its list of members This allows sets to be selected as opposed t
:param replace: (C) Indicates that the specified items should replace the existing items on
the active list
:param symmetry: (C) Specifies that components should be selected symmetrically using the
current symmetricModelling command settings If symmetric modeling is not enable
:param symmetrySide: (C) Indicates that components involved in the current symmetry object
should be selected, according to the supplied parameter Valid values for the param
:param toggle: (C) Indicates that those items on the given list which are on the active
list should be removed from the active list and those items on the given list wh
:param visible: (C) Indicates that of the specified items only those that are visible
should be affected
:returns:
"""
pass
def CreateConstructionPlane(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateNSoftBodyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def displayColor(*args, active: bool=True, create: bool=True, dormant: bool=True, list:
bool=True, queryIndex: int=0, resetToFactory: bool=True, resetToSaved:
bool=True, q=True, query=True, **kwargs)->Union[None, Any]:
"""
This command changes or queries the display color for anything in the application that
allows the user to set its color The color is defined by a color index into either the
dormant or active color palette These colors are part of the UI and not part of the saved
data for a model This command is not undoable
:param active: (C) Specifies the color index applies to active color palette name
Specifies the name of color to change index The color index for the color
:param create: (C) Creates a new display color which can be queried or set If is used only
when saving color preferences
:param dormant: (C) Specifies the color index applies to dormant color palette If neither
of the dormant or active flags is specified, dormant is the default
:param list: (C) Writes out a list of all color names and their value
:param queryIndex: (C) Allows you to obtain a list of color names with the given color
indices
:param resetToFactory: (C) Resets all display colors to their factory defaults
:param resetToSaved: (C) Resets all display colors to their saved values
:returns:
"""
pass
def attributeInfo(*args, allAttributes: bool=True, bool: bool=True, enumerated: bool=True,
hidden: bool=True, inherited: bool=True, internal: bool=True, leaf: bool=True,
logicalAnd: bool=True, multi: bool=True, short: bool=True, userInterface:
bool=True, writable: bool=True, type: AnyStr="", **kwargs)->List[AnyStr]:
"""
This command lists all of the attributes that are marked with certain flags Combinations
of flags may be specified and all will be considered (The method of combination depends on
the state of the "logicalAnd/and" flag.) When the "allAttributes/all" flag is specified,
attributes of all types will be listed
:param allAttributes: (C) Show all attributes associated with the node regardless of type
Use of this flag overrides any other attribute type flags and logical operation that
:param bool: (C) Show the attributes that are of type boolean Use the 'on' state to get
only boolean attributes; the 'off' state to ignore boolean attributes
:param enumerated: (C) Show the attributes that are of type enumerated Use the 'on' state
to get only enumerated attributes; the 'off' state to ignore enumerated attribute
:param hidden: (C) Show the attributes that are marked as hidden Use the 'on' state to get
hidden attributes; the 'off' state to get non-hidden attributes
:param inherited: (C) Filter the attributes based on whether they belong to the node type
directly or have been inherited from a root type (e.g meshShape/direct or dagObj
:param internal: (C) Show the attributes that are marked as internal to the node Use the
'on' state to get internal attributes; the 'off' state to get non-internal attri
:param leaf: (C) Show the attributes that are complex leaves (ie that have parent
attributes and have no children themselves) Use the 'on' state to get leaf attribu
:param logicalAnd: (C) The default is to take the logical 'or' of the above conditions
Specifying this flag switches to the logical 'and' instead
:param multi: (C) Show the attributes that are multis Use the 'on' state to get multi
attributes; the 'off' state to get non-multi attributes
:param short: (C) Show the short attribute names instead of the long names
:param userInterface: (C) Show the UI-friendly attribute names instead of the Maya ASCII
names Takes precedence over the -s/-short flag if both are specified
:param writable: (C) Show the attributes that are writable (ie can have input connections)
Use the 'on' state to get writable attributes; the 'off' state to get non-wri
:param type: (C) static node type from which to get 'affects' information
:returns: List of attributes matching criteria
"""
pass
def ToggleUVEditorIsolateSelectHUD(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def offsetCurve(*args, caching: bool=True, connectBreaks: Union[int, bool]=2, cutLoop:
bool=False, cutRadius: Union[float, bool]=0.0, distance: Union[float, bool]=1.0,
nodeState: Union[int, bool]=0, normal: Union[List[float, float, float],
bool]=None, reparameterize: bool=False, stitch: bool=True, subdivisionDensity:
Union[int, bool]=5, tolerance: Union[float, bool]=0.01, useGivenNormal:
bool=True, constructionHistory: bool=True, name: AnyStr="", object: bool=True,
range: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The offset command creates new offset curves from the selected curves The connecting type
for breaks in offsets is off (no connection), circular (connect with an arc) or linear
(connect linearly resulting in a sharp corner) If loop cutting is on then any loops in the
offset curves are trimmed away For the default cut radius of 0.0 a sharp corner
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param connectBreaks: (C Q E) Connect breaks method (between gaps): 0 - off, 1 - circular,
2 - linear Default: 2
:param cutLoop: (C Q E) Do loop cutting Default: false
:param cutRadius: (C Q E) Loop cut radius Only used if cutLoop attribute is set true
Default: 0.0
:param distance: (C Q E) Offset distance Default: 1.0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param normal: (C Q E) Offset plane normal
:param reparameterize: (C Q E) Do reparameterization It is not advisable to change this
value Default: false
:param stitch: (C Q E) Stitch curve segments together It is not advisable to change this
value Default: true
:param subdivisionDensity: (C Q E) Maximum subdivision density per span Default: 5
:param tolerance: (C Q E) Tolerance Default: 0.01
:param useGivenNormal: (C Q E) Use the given normal (or, alternativelly, geometry normal)
Default: 1
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param range: (C) Force a curve range on complete input curve
:returns: Object name and node name
"""
pass
def DetachSkeleton(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def prepareRender(*args, defaultTraversalSet: Union[AnyStr, bool]="", deregister: AnyStr="",
invokePostRender: bool=True, invokePostRenderFrame: bool=True,
invokePostRenderLayer: bool=True, invokePreRender: bool=True,
invokePreRenderFrame: bool=True, invokePreRenderLayer: bool=True,
invokeSettingsUI: bool=True, label: Union[AnyStr, bool]="",
listTraversalSets: bool=True, postRender: Union[Script, bool]=None,
postRenderFrame: Union[Script, bool]=None, postRenderLayer: Union[Script,
bool]=None, preRender: Union[Script, bool]=None, preRenderFrame: Union[Script,
bool]=None, preRenderLayer: Union[Script, bool]=None, restore: bool=True,
saveAssemblyConfig: bool=True, settingsUI: Union[Script, bool]=None, setup:
bool=True, traversalSet: Union[AnyStr, bool]="", traversalSetInit:
Union[Script, bool]=None, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This command is used to register, manage and invoke render traversals Render traversals
are used to configure a scene to prepare it for rendering This command has special support
for scene assembly nodes To render scene assembly nodes, a rendering traversal can
activate an appropriate representation, for each assembly node in the scene When ren
:param defaultTraversalSet: (Q E) Set or query the default traversal set The prepareRender
command performs operations on the default traversal set, unless the -traversalSet flag is
:param deregister: (E) Deregister a registered traversal set If the deregistered traversal
set is the default traversal set, the new default traversal set will be the "nul
:param invokePostRender: (C) Invoke the postRender render traversal for a given traversal
set The traversal set will be the default traversal set, unless the -traversalSet flag
:param invokePostRenderFrame: (C) Invoke the postRenderFrame render traversal for a given
traversal set The traversal set will be the default traversal set, unless the
-traversalSet
:param invokePostRenderLayer: (C) Invoke the postRenderLayer render traversal for a given
traversal set The traversal set will be the default traversal set, unless the
-traversalSet
:param invokePreRender: (C) Invoke the preRender render traversal for a given traversal set
The traversal set will be the default traversal set, unless the -traversalSet flag i
:param invokePreRenderFrame: (C) Invoke the preRenderFrame render traversal for a given
traversal set The traversal set will be the default traversal set, unless the
-traversalSet f
:param invokePreRenderLayer: (C) Invoke the preRenderLayer render traversal for a given
traversal set The traversal set will be the default traversal set, unless the
-traversalSet f
:param invokeSettingsUI: (C) Invoke the settings UI callback to populate a layout with UI
controls, for a given traversal set The current UI parent will be a form layout, which
:param label: (Q E) Set or query the label for a given traversal set The label is used for
UI display purposes, and can be localized The traversal set will be the defa
:param listTraversalSets: (Q) Query the supported render traversal sets
:param postRender: (Q E) Set or query the postRender render traversal for a given traversal
set This traversal is run after a render The traversal set will be the default t
:param postRenderFrame: (Q E) Set or query the postRenderFrame render traversal for a given
traversal set This traversal is run after the render of a single frame, with a render
:param postRenderLayer: (Q E) Set or query the postRenderLayer render traversal for a given
traversal set This traversal is run after a render layer is rendered, within a render
:param preRender: (Q E) Set or query the preRender render traversal for a given traversal
set This traversal is run before a render The traversal set will be the default t
:param preRenderFrame: (Q E) Set or query the preRenderFrame render traversal for a given
traversal set This traversal is run before the render of a single frame, with a render
:param preRenderLayer: (Q E) Set or query the preRenderLayer render traversal for a given
traversal set This traversal is run before a render layer is rendered, within a render
:param restore: (C) Clean up after rendering, including restoring the assembly active
representation configuration for the whole scene, if the saveAssemblyConfig flag fo
:param saveAssemblyConfig: (Q E) Set or query whether or not the assembly active
representation configuration for the whole scene should be saved for a given traversal set
The trave
:param settingsUI: (Q E) Set or query the settings UI callback for a given traversal set
The traversal set will be the default traversal set, unless the -traversalSet flag i
:param setup: (C) Setup render preparation, including saving the assembly active
representation configuration for the whole scene, if the saveAssemblyConfig flag for t
:param traversalSet: (C Q E) Set or query properties for the specified registered traversal
set In query mode, this flag needs a value
:param traversalSetInit: (Q E) Set or query the traversal set initialisation callback for a
given traversal set The traversal set will be the default traversal set, unless the -tr
:returns:
"""
pass
def DeleteAllParticles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleAutoFrame(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def clipSchedule(*args, allAbsolute: bool=True, allRelative: bool=True, blend: Union[List[int,
int], bool]=None, blendNode: Union[List[int, int], bool]=None, blendUsingNode:
AnyStr="", character: bool=True, clipIndex: Union[int, bool]=0, cycle:
Union[float, bool]=0.0, defaultAbsolute: bool=True, enable: bool=True, group:
bool=True, groupIndex: Union[int, List[int]]=0, groupName: Union[AnyStr,
bool]="", hold: Union[time, bool]=None, insertTrack: int=0, instance:
AnyStr="", listCurves: bool=True, listPairs: bool=True, lock: bool=True, mute:
bool=True, name: Union[AnyStr, bool]="", postCycle: Union[float, bool]=0.0,
preCycle: Union[float, bool]=0.0, remove: bool=True, removeBlend: List[int,
int]=None, removeEmptyTracks: bool=True, removeTrack: int=0,
rotationsAbsolute: bool=True, scale: Union[float, bool]=0.0, shift: int=0,
shiftIndex: Union[int, List[int]]=0, solo: bool=True, sourceClipName:
bool=True, sourceEnd: Union[time, bool]=None, sourceStart: Union[time,
bool]=None, start: Union[time, bool]=None, track: Union[int, bool]=0, weight:
Union[float, bool]=0.0, weightStyle: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command is used to create, edit and query clips and blends in the Trax editor It
operates on the clipScheduler node attached to the character In query mode, if no flags
are specified, returns an array of strings in this form: (clipName,clipIndex,clipStart,
clipSourceStart,clipSourceEnd,clipScale,clipPreCycle,clipPostCycle,clipHold)
:param allAbsolute: (Q E) Set all channels to be calculated with absolute offsets This
flag cannot be used in conjunction with the ar/allRelative, ra/rotationsAbsolute or da/
:param allRelative: (Q E) Set all channels to be calculated with relative offsets This
flag cannot be used in conjunction with the aa/allAbsolute, ra/rotationsAbsolute or da/
:param blend: (C Q) This flag is used to blend two clips, whose indices are provided as
flag arguments
:param blendNode: (Q) This query only flag list all of the blend nodes associated with the
blend defined by the two clip indices This flag returns a string array In quer
:param blendUsingNode: (C) This flag is used to blend using an existing blend node It is
used in conjunction with the blend flag The blend flag specifies the clip indices for
:param character: (Q) This flag is used to query which characters this scheduler controls
It returns an array of strings
:param clipIndex: (C Q) Specify the index of the clip to schedule In query mode, returns
an array of strings in this form: (clipName,index,start,sourceStart,sourceEnd,scale
:param cycle: (C Q) This flag is now obsolete Use the postCycle flag instead
:param defaultAbsolute: (Q E) Sets all top-level channels except rotations in the clip to
relative, and the remaining channels to absolute This is the default during clip creatio
:param enable: (C Q) This flag is used to enable or disable a clip It must be used in
conjunction with the ci/clipIndex flag The specified clip will be enabled or disab
:param group: (C) This flag is used to add (true) or remove (false) a list of clips
(specified with groupIndex) into a group
:param groupIndex: (C M) This flag specifies a multiple number of clips to be added or
removed from a group
:param groupName: (C Q) This flag is used to specify the group that should be added to If
no group by that name exists and new group is created with that name By default i
:param hold: (C Q) Specify how long to hold the last value of the clip after its normal or
cycled end
:param insertTrack: (C) This flag is used to insert a new empty track at the track index
specified
:param instance: (C) Create an instanced copy of the named clip An instanced clip is one
that is linked to an original clip Thus, changes to the animation curve of the
:param listCurves: (C Q) This flag is used to list the animation curves associated with a
clip It should be used in conjunction with the clipIndex flag, which specifies the
:param listPairs: (Q) This query only flag returns a string array containing the channels
in a character that are used by a clip and the names of the animation curves that
:param lock: (Q E) This flag specifies whether clips on a track are to be locked or not
Must be used in conjuction with the track flag
:param mute: (Q E) This flag specifies whether clips on a track are to be muted or not
Must be used in conjuction with the track flag
:param name: (C Q) This flag is used to query the name of the clip node associated with the
specified clip index, or to specify the name of the instanced clip during in
:param postCycle: (C Q) Specify the number of times to repeat the clip after its normal
end
:param preCycle: (C Q) Specify the number of times to repeat the clip before its normal
start
:param remove: (C) This flag is used to remove a clip from the timeline It must be used in
conjunction with the ci/clipIndex flag The specified clip will be removed f
:param removeBlend: (C) This flag is used to remove an existing blend between two clips,
whose indices are provided as flag arguments
:param removeEmptyTracks: (C) This flag is used to remove all tracks that have no clips
:param removeTrack: (C) This flag is used to remove the track with the specified index The
track must have no clips on it before it can be removed
:param rotationsAbsolute: (Q E) Set all channels except rotations to be calculated with
relative offsets Rotation channels will be calculated with absolute offsets This flag
canno
:param scale: (C Q) Specify the amount to scale the clip Values must be greater than 0
:param shift: (C) This flag allows multiple clips to be shifted by a certain number of
tracks and works in conjunction with the shiftIndex flag The flag specifies the
:param shiftIndex: (C M) This flag allows multiple clips to be shifted by a certain number
of tracks and works in conjunction with the shiftAmount flag The flag specifies th
:param solo: (Q E) This flag specifies whether clips on a track are to be soloed or not
Must be used in conjuction with the track flag
:param sourceClipName: (C Q) This flag is used to query the name of the source clip node
associated with the specified clip index
:param sourceEnd: (C Q) Specify where to end in the source clip's animation curves
:param sourceStart: (C Q) Specify where to start in the source clip's animation curves
:param start: (C Q) Specify the placement of the start of the clip
:param track: (C Q) Specify the track to operate on For example, which track to place a
clip on, which track to mute/lock/solo In query mode, it may be used in conjuct
:param weight: (C Q) This flag is used in to set or query the weight of the clip associated
with the specified clip index
:param weightStyle: (C Q) This flag is used to set or query the weightStyle attribute of
the clip associated with the specified clip index
:returns: Clip name
"""
pass
def dR_selectModeRaycast(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def commandLogging(*args, historySize: Union[int, bool]=0, logCommands: bool=True, logFile:
Union[AnyStr, bool]="", recordCommands: bool=True, resetLogFile: bool=True,
q=True, query=True, **kwargs)->Union[None, Any]:
"""
This command controls logging of Maya commands, in memory and on disk Note that if
commands are logged in memory, they will be available to the crash reporter and appear in
crash logs
:param historySize: (C Q) Sets the number of entries in the in-memory command history
:param logCommands: (C Q) Enables or disables the on-disk logging of commands
:param logFile: (C Q) Sets the filename to use for the on-disk log If logging is active,
the current file will be closed before the new one is opened
:param recordCommands: (C Q) Enables or disables the in-memory logging of commands
:param resetLogFile: (C Q) Reset the log filename to the default ('mayaCommandLog.txt' in
the application folder, alongside 'Maya.env' and the default projects folder)
:returns:
"""
pass
def Planar(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PublishParentAnchorOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateVolumeCube(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cMuscleWeightMirror(*args, **kwargs)->None:
"""
"""
pass
def OutlinerToggleIgnoreHidden(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeRenameTab(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nurbsCurveRebuildPref(*args, **kwargs)->None:
"""
"""
pass
def ShowBatchRender(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RecentCommandsWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphEditorValueLinesToggle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeExpandAsset(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddWireOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def showWindow(*args, **kwargs)->None:
"""
Make a window visible If no window is specified then the current window (most recently
created) is used See also the window command's vis/visible flag If the specified window
is iconified, it will be opened
:returns:
"""
pass
def HypershadeGraphMaterialsOnSelectedObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cMuscleBindSticky(*args, **kwargs)->None:
"""
"""
pass
def WhatsNewHighlightingOn(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LockCamera(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleLocalRotationAxes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RetimeKeysTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UniformOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hikGlobals(*args, releaseAllPinning: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[bool, Any]:
"""
Sets global HumanIK flags for the application
:param releaseAllPinning: (Q E) Sets the global release all pinning hik flag When this
flag is set, all pinning states are ignored
:returns: Giving the state of the option
"""
pass
def mute(*args, disable: bool=True, force: bool=True, q=True, query=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The mute command is used to disable and enable playback on a channel When a channel is
muted, it retains the value that it was at prior to being muted
:param disable: (C) Disable muting on the channels
:param force: (C) Forceable disable of muting on the channels If there are keys on the
mute channel, the animation and mute node will both be removed If this flag is
:returns: Name(s) of the mute node(s)
"""
pass
def TimeEditorDeleteSelectedTracks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SubdivSmoothnessFineOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonPipe(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleUVShellBorder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateJiggleDeformer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetGrabBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetAsCombinationTargetOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_EditSubstance(*args, **kwargs)->None:
"""
"""
pass
def RedoPreviousRender(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InsertEdgeLoopTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Ungroup(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyAppendFacetCtx(*args, append: bool=True, exists: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
isRotateAvailable: bool=True, maximumNumberOfPoints: Union[int, bool]=0,
planarConstraint: bool=True, rotate: Union[float, bool]=0.0,
subdivision: Union[int, bool]=1, texture: Union[int, bool]=1, q=True,
query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Create a new context to append facets on polygonal objects
:param append: (C Q E) Allows to switch to polyCreateFacetCtx tool
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param isRotateAvailable: (Q) Tells if the control associated to rotate flag is available
If several edges are already selected and they are not aligned (thus there is no "rotati
:param maximumNumberOfPoints: (C Q E) Allows the ability to set a upper bound on the number
of points in interactively place before polygon is created A value less than 2 will mean
that
:param planarConstraint: (C Q E) Allows/avoid new facet to be non-planar If on, all new
points will be projected onto current facet plane Selected edges will be checked as well
:param rotate: (C Q E) Rotate current facet around the first edge selected
:param subdivision: (C Q E) Number of sub-edges created for each new edge Default is 1
:param texture: (C Q E) Number of textures Default is 1
:returns:
"""
pass
def sbs_AffectedByAllInputs(*args, **kwargs)->None:
"""
"""
pass
def setXformManip(*args, showUnits: bool=True, suppress: bool=True, useRotatePivot: bool=True,
worldSpace: bool=True, q=True, query=True, **kwargs)->Union[None, Any]:
"""
This command changes some of the settings of the xform manip, to control its appearance
:param showUnits: (Q) If set to true, the xform manip displays current units; otherwise,
the manip hides them
:param suppress: (Q) If set to true, the xform manip is suppressed and therefore not
visible or usable
:param useRotatePivot: (Q) If set to true, the xform manip uses the rotate pivot; otherwise,
the manip uses the bounding-box center Defaults false
:param worldSpace: (Q) If set to true, the xform manip is always in world space If false,
the manip is in object space (Note: when multiple objects are selected the manip
:returns:
"""
pass
def MakePondMotorBoats(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EditTexture(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectEdgeRing(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MergeToCenter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyUVSet(*args, allUVSets: bool=True, allUVSetsIndices: bool=True, allUVSetsWithCount:
bool=True, copy: bool=True, create: bool=True, currentLastUVSet: bool=True,
currentPerInstanceUVSet: bool=True, currentUVSet: bool=True, delete: bool=True,
genNewUVSet: bool=True, newUVSet: Union[AnyStr, bool]="", perInstance: bool=True,
projections: bool=True, rename: bool=True, reorder: bool=True, shareInstances:
bool=True, unshared: bool=True, uvSet: Union[AnyStr, bool]="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[bool, Any]:
"""
Command to do the following to uv sets: - delete an existing uv set - rename an existing
uv set - create a new empty uv set - copy the values from one uv set to a another
pre-existing uv set - reorder two uv sets - set the current uv set to a pre-existing uv
set - modify sharing between instances of per-instance uv sets - query the current uv
:param allUVSets: (Q E) This flag when used in in a query will return a list of all of the
uv set names
:param allUVSetsIndices: (Q E) This flag when queried will return a list of the logical
plug indices of all the uv sets in the sparse uv set array
:param allUVSetsWithCount: (Q E) This flag when used in a query will return a list of all
of the uv set family names, with a count appended to the perInstance sets indicating the
num
:param copy: (C Q E) This flag when used will result in the copying of the uv set
corresponding to name specified with the uvSet flag to the uvset corresponding to the na
:param create: (C Q E) This flag when used will result in the creation of an empty uv set
corresponding to the name specified with the uvSet flag If a uvSet with that name
:param currentLastUVSet: (C Q E) This flag when used will set the current uv set that the
object needs to work on, to be the last uv set added to the object If no uv set exists
for
:param currentPerInstanceUVSet: (Q E) This is a query-only flag for use when the current uv
set is a per-instance uv set family This returns the member of the set family that
corresponds
:param currentUVSet: (C Q E) This flag when used will set the current uv set that the
object needs to work on, to be the uv set corresponding to the name specified with the
uvSet
:param delete: (C Q E) This flag when used will result in the deletion of the uv set
corresponding to the name specified with the uvSet flag
:param genNewUVSet: (Q E) This is a query-only flag to generate a new unique name
:param newUVSet: (C Q E) Specifies the name that the uv set corresponding to the name
specified with the uvSet flag, needs to be renamed to
:param perInstance: (C Q E) This flag can be used in conjunction with the create flag to
indicate whether or not the uv set is per-instance When you create a per-instance uv se
:param projections: (Q E) This flag when used in a query will return a list of polygon uv
projection node names The order of the list is from most-recently-applied to least-r
:param rename: (C Q E) This flag when used will result in the renaming of the uv set
corresponding to the name specified with the uvSet flag to the name specified using the
:param reorder: (C Q E) This flag when used will result in the reordering of two uv sets
corresponding to name specified with the uvSet flag, and the uvset corresponding to
:param shareInstances: (C Q E) This flag is used to modify the sharing of per-instance uv
sets within a given uv set family so that all selected instances share the specified set
:param unshared: (C Q E) This flag can be used in conjunction with the create and
perInstance flags to indicate that the newly created per-instance set should be created
with
:param uvSet: (C Q E) Specifies the name of the uv set that this command needs to work on
This flag has to be specified for this command to do anything meaningful other t
:returns: Success or Failure.
"""
pass
def HideNParticles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeOpenMaterialViewerWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshSmoothToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setDefaultShadingGroup(*args, q=True, query=True, **kwargs)->Union[None, Any]:
"""
The setDefaultShadingGroup command is used to change which shading group is considered the
current default shading group Subsequently created objects will be assigned to the new
default group
:returns:
"""
pass
def spotLightPreviewPort(*args, annotation: Union[AnyStr, bool]="", backgroundColor:
Union[List[float, float, float], bool]=None, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True,
manage: bool=True, noBackground: bool=True, numberOfPopupMenus:
bool=True, parent: Union[AnyStr, bool]="", popupMenuArray: bool=True,
preventOverride: bool=True, spotLight: name=None, statusBarMessage:
AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, widthHeight: List[int, int]=None, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a 3dPort that displays an image representing the illumination provided
by the spotLight It is a picture of a plane being illuminated by a light The optional
argument is the name of the 3dPort
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param spotLight: (C) Name of the spotLight
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:param widthHeight: (C) The width and height of the port
:returns: - the name of the port created or modified
"""
pass
def ToggleMeshPoints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NormalConstraintOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CopyUVsToUVSetOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SplitVertex(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def addDynamic(*args, **kwargs)->AnyStr:
"""
Makes the "object" specified as second argument the source of an existing field or emitter
specified as the first argument In practical terms, what this means is that a field will
emanate its force from its owner object, and an emitter will emit from its owner object
addDynamic makes the specified field or emitter a child of the owner's transfor
:returns: The name of the source object and the field or emitter which was
attached to it.
"""
pass
def ShowSculptObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EnableMemoryCaching(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorCreateAdditiveLayer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Sine(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RedoViewChange(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RebuildCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dagPose(*args, addToPose: bool=True, atPose: bool=True, bindPose: bool=True, g: bool=True,
members: bool=True, name: Union[AnyStr, bool]="", remove: bool=True, reset:
bool=True, restore: bool=True, save: bool=True, selection: bool=True, worldParent:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command is used to save and restore the matrix information for a dag hierarchy
Specifically, the data stored will restore the translate, rotate, scale, scale pivot,
rotate pivot, rotation order, and (for joints) joint order for all the objects on the
hierarchy Data for other attributes is not stored by this command This command can also
be
:param addToPose: (C) Allows adding the selected items to the dagPose
:param atPose: (Q) Query whether the hierarchy is at same position as the pose Names of
hierarchy members that are not at the pose position will be returned An empty
:param bindPose: (C Q) Used to specify the bindPose for the selected hierarchy Each
hierarchy can have only a single bindPose, which is saved automatically at the time of
:param g: (C) This flag can be used in conjunction with the restore flag to signal that the
members of the pose should be restored to the global pose The global p
:param members: (Q) Query the members of the specified pose The pose should be specified
using the selection list, the -bp/-bindPose or the -n/-name flag
:param name: (C Q) Specify the name of the pose This can be used during create, restore,
reset, remove, and query operations to specify the pose to be created or acted
:param remove: (C) Remove the selected joints from the specified pose
:param reset: (C) Reset the pose on the selected joints If you are resetting pose data for
a bindPose, take care It is appropriate to use the -rs/-reset flag if a jo
:param restore: (C) Restore the hierarchy to a saved pose To specify the pose, select the
pose node, or use the -bp/-bindPose or -n/-name flag
:param save: (C) Save a dagPose for the selected dag hierarchy The name of the new pose
will be returned
:param selection: (C Q) Whether or not to store a pose for all items in the hierarchy, or
for only the selected items
:param worldParent: (C) Indicates that the selected pose member should be recalculated as
if it is parented to the world This is typically used when you plan to reparent th
:returns: Name of pose
"""
pass
def CreateTextureReferenceObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FluidGradientsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectSurfacePointsMask(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def python(*args, **kwargs)->None:
"""
"""
pass
def createPolyCubeCtx(*args, **kwargs)->None:
"""
"""
pass
def FBXImportShowUI(*args, **kwargs)->None:
"""
"""
pass
def ShowSubdivSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ikfkDisplayMethod(*args, display: Union[AnyStr, bool]="", q=True, query=True,
**kwargs)->Union[None, Any]:
"""
The ikfkDisplayMethod command is used to specify how ik/fk blending should be shown
:param display: (C Q) Specify how ik/fk blending should be shown when the handle is
selected Possible choices are "none" (do not display any blending), "ik" (only show ik
:returns:
"""
pass
def ShowMeshFoamyToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def getProcArguments(*args, **kwargs)->None:
"""
"""
pass
def bufferCurve(*args, animation: AnyStr="keysOrObjects.", attribute: Union[AnyStr,
List[AnyStr]]="", controlPoints: bool=False, exists: bool=True, float:
Union[floatrange, List[floatrange]]=None, hierarchy: AnyStr="",
includeUpperBound: bool=True, index: Union[int, List[int]]=0, overwrite:
bool=True, shape: bool=True, swap: bool=True, time: Union[timerange,
List[timerange]]=None, useReferencedCurve: bool=True, q=True, query=True,
**kwargs)->Union[int, Any]:
"""
This command operates on a keyset A keyset is defined as a group of keys within a
specified time range on one or more animation curves The animation curves comprising a
keyset depend on the value of the "-animation" flag: keysOrObjects: Any active keys, when
no target objects or -attribute flags appear on the command line, or All animation curv
:param animation: (C) Where this command should get the animation to act on Valid values
are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Descrip
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param exists: (Q) Returns true if a buffer curve currently exists on the specified
attribute; false otherwise
:param float: (C M) value uniquely representing a non-time-based key (or key range) on a
time-based animCurve Valid floatRange include single values (-f 10) or a string
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param includeUpperBound: (C) When the -t/time or -f/float flags represent a range of keys,
this flag determines whether the keys at the upper bound of the range are included in t
:param index: (C M) index of a key on an animCurve In query mode, this flag needs a value
:param overwrite: (C) Create a buffer curve "true" means create a buffer curve whether or
not one already existed "false" means if a buffer curve exists already then lea
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:param swap: (C) For animated attributes which have buffer curves, swap the buffer curve
with the current animation curve
:param time: (C M) time uniquely representing a key (or key range) on a time-based
animCurve See the code examples below on how to format for a single frame or frame r
:param useReferencedCurve: (C Q) In create mode, sets the buffer curve to the referenced
curve Curves which are not from file references will ignore this flag In query mode,
return
:returns: Number of buffer curves
"""
pass
def transferAttributes(*args, after: bool=True, afterReference: bool=True, before: bool=True,
colorBorders: int=0, deformerTools: bool=True, exclusive: Union[AnyStr,
bool]="", flipUVs: int=0, frontOfChain: bool=True, geometry:
Union[AnyStr, List[AnyStr], bool]="", geometryIndices: bool=True,
ignoreSelected: bool=True, includeHiddenSelections: bool=False,
matchChoice: int=0, name: AnyStr="", parallel: bool=True, prune:
bool=True, remove: Union[bool, List[bool]]=True, sampleSpace: int=0,
searchMethod: int=0, searchScaleX: float=0.0, searchScaleY: float=0.0,
searchScaleZ: float=0.0, sourceColorSet: AnyStr="", sourceUvSet:
AnyStr="", sourceUvSpace: AnyStr="", split: bool=True, targetColorSet:
AnyStr="", targetUvSet: AnyStr="", targetUvSpace: AnyStr="",
transferColors: int=0, transferNormals: int=0, transferPositions: int=0,
transferUVs: int=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Samples the attributes of a source surface (first argument) and transfers them onto a
target surface (second argument)
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param colorBorders: (C E) Controls whether color borders are preserved when transferring
color data If this is non-zero, any color borders will be mapped onto the nearest edg
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param flipUVs: (C E) Controls how sampled UV data is flipped before being transferred to
the target 0 means no flipping; 1 means UV data is flipped in the U direction; 2
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param matchChoice: (C E) When using topological component matching, selects between
possible matches If the meshes involved in the transfer operation have symmetries in thei
:param name: (C) Used to specify the name of the node being created
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param sampleSpace: (C E) Selects which space the attribute transfer is performed in 0 is
world space, 1 is model space, 4 is component-based, 5 is topology-based The defaul
:param searchMethod: (C E) Specifies which search method to use when correlating points 0
is closest along normal, 3 is closest to point The default is closest to point
:param searchScaleX: (C E) Specifies an optional scale that should be applied to the x-axis
of the target model before transferring data A value of 1.0 (the default) means no
:param searchScaleY: (C E) Specifies an optional scale that should be applied to the y-axis
of the target model before transferring data A value of 1.0 (the default) means no
:param searchScaleZ: (C E) Specifies an optional scale that should be applied to the z-axis
of the target model before transferring data A value of 1.0 (the default) means no
:param sourceColorSet: (C) Specifies the name of a single color set on the source
surface(s) that should be transferred to the target This value is only used when the
operatio
:param sourceUvSet: (C) Specifies the name of a single UV set on the source surface(s) that
should be transferred to the target This value is only used when the operation i
:param sourceUvSpace: (C) Specifies the name of the UV set on the source surface(s) that
should be used as the transfer space This value is only used when the operation is co
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:param targetColorSet: (C) Specifies the name of a single color set on the target surface
that should be receive the sampled color data This value is only used when the operat
:param targetUvSet: (C) Specifies the name of a single UV set on the target surface that
should be receive the sampled UV data This value is only used when the operation is
:param targetUvSpace: (C) Specifies the name of the UV set on the target surface( that
should be used as the transfer space This value is only used when the operation is conf
:param transferColors: (C E) Controls color set transfer 0 means no color sets are
transferred, 1 means that a single color set (specified by sourceColorSet and
targetColorSet)
:param transferNormals: (C E) A non-zero value indicates vertex normals should be sampled
and written into user normals on the target surface
:param transferPositions: (C E) A non-zero value indicates vertex position should be
sampled, causing the target surface to "wrap" to the source surface(s)
:param transferUVs: (C E) Controls UV set transfer 0 means no UV sets are transferred, 1
means that a single UV set (specified by sourceUVSet and targetUVSet) is transferred,
:returns: The node name.
"""
pass
def SwapBufferCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def iprEngine(*args, copy: AnyStr="", defineTemplate: AnyStr="", diagnostics: bool=True,
estimatedMemory: bool=True, exists: bool=True, iprImage: Union[AnyStr, bool]="",
motionVectorFile: bool=True, object: Union[name, bool]=None, region:
Union[List[int, int, int, int], bool]=None, relatedFiles: bool=True,
releaseIprImage: bool=True, resolution: bool=True, scanlineIncrement:
Union[AnyStr, bool]="", showProgressBar: bool=True, startTuning: bool=True,
stopTuning: bool=True, underPixel: List[int, int]=None, update: bool=True,
updateDepthOfField: bool=True, updateLightGlow: bool=True, updateMotionBlur:
bool=True, updatePort: Union[AnyStr, bool]="", updateShaderGlow: bool=True,
updateShading: bool=True, updateShadowMaps: bool=True, useTemplate: AnyStr="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Command to create or edit an iprEngine A iprEngine is an object that watches for changes
to shading networks and automatically reshades to generate an up-to-date image
:param copy: (E) Copies the deep raster file, as well as its related files, to the new
location
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param diagnostics: (E) The diagnostics should be shown
:param estimatedMemory: (Q) Displays the estimated memory being used by IPR
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param iprImage: (C Q E) Specify the ipr image to use
:param motionVectorFile: (Q) Returns the name of the motion vector file used by IPR
:param object: (C Q E) The objects to be tuned
:param region: (C Q E) The coordinates of the region to be tuned The integers are in the
sequence left bottom right top or x1,y2 x2,y2
:param relatedFiles: (Q) Returns the names for the related files, e.g, the
non-glow-non-blur image, the motion vector file, and the depth-map files
:param releaseIprImage: (E) The ipr image should be released and memory should be freed
:param resolution: (Q) The width and height of the ipr file
:param scanlineIncrement: (C Q E) Set the scanline increment percentage If the height of
the region being update is 240 pixels, and the scanlineIncrement is 10% then the image will
r
:param showProgressBar: (C Q E) Show progress bar during tuning
:param startTuning: (C Q E) An ipr image has been specified and now changes to shading
networks should force an image to be produced
:param stopTuning: (C Q E) Tuning should cease but ipr image should not be closed
:param underPixel: (E) Get list of objects under the pixel sprcified
:param update: (C E) Force an update
:param updateDepthOfField: (C E) Force a refresh of depth-of-field
:param updateLightGlow: (C Q E) Automatically update when light glow changes
:param updateMotionBlur: (C Q E) Automatically update when 2.5D motion blur changes
:param updatePort: (C Q E) The name of the port that is to be updated when pixel values are
recomputed (not currently supported)
:param updateShaderGlow: (C Q E) Automatically update when shader glow changes
:param updateShading: (C Q E) Automatically update shading
:param updateShadowMaps: (C E) Force the shadow maps to be generated and an update to
occur
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: - the name of the ipr engine created or modified
"""
pass
def UnghostObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def pointPosition(*args, local: bool=True, world: bool=True, **kwargs)->List[float]:
"""
This command returns the world or local space position for any type of point object Valid
selection items are: - curve and surface CVs - poly vertices - lattice points - particles -
curve and surface edit points - curve and surface parameter points - poly uvs -
rotate/scale/joint pivots - selection handles - locators, param locators and arc length
:param local: (C) Return the point in local space coordinates
:param world: (C) Return the point in world space coordinates
:returns: Command result
"""
pass
def TangetConstraint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def KeyframeTangentMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def annotate(*args, point: List[float, float, float]=None, text: AnyStr="", **kwargs)->AnyStr:
"""
This command is used to create an annotation to be attached to the specified objects at the
specified point
:param point: (C) Specifies the point about which the annotation text is to be centered
:param text: (C) Specifies the annotation text
:returns: Annotation added
"""
pass
def geometryReplaceCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShapeEditorSelectNone(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def subdToNurbs(*args, **kwargs)->None:
"""
"""
pass
def UVCameraBasedProjectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CommandShell(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SculptGeometryToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeTestTexture(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LoadHIKCharacterDefinition(*args, **kwargs)->None:
"""
"""
pass
def nClothAppend(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def reference(*args, **kwargs)->None:
"""
"""
pass
def FloatSelectedObjectsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateOceanWake(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def scriptNode(*args, afterScript: Union[AnyStr, bool]="", beforeScript: Union[AnyStr, bool]="",
executeAfter: bool=True, executeBefore: bool=True, ignoreReferenceEdits:
bool=True, name: AnyStr="", scriptType: Union[int, bool]=0, sourceType:
Union[AnyStr, bool]="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
scriptNodes contain scripts that are executed when a file is loaded or when the script node
is deleted If a script modifies a referenced node, the changes will be tracked as
reference edits unless the scriptNode was created with the ignoreReferenceEdits flag The
scriptNode command is used to create, edit, query, and test scriptNodes
:param afterScript: (C Q E) The script executed when the script node is deleted C: The
default is an empty string Q: When queried, this flag returns a string
:param beforeScript: (C Q E) The script executed during file load C: The default is an
empty string Q: When queried, this flag returns a string
:param executeAfter: (C) Execute the script stored in the .after attribute of the
scriptNode This script is normally executed when the script node is deleted
:param executeBefore: (C) Execute the script stored in the .before attribute of the
scriptNode This script is normally executed when the file is loaded
:param ignoreReferenceEdits: (C) Sets whether changes made to referenced nodes during the
execution of the script should be recorded as reference edits This flag must be set when
th
:param name: (C) When creating a new scriptNode, this flag specifies the name of the node
If a non-unique name is used, the name will be modified to ensure uniquenes
:param scriptType: (C Q E) Execute on time changed
:param sourceType: (C Q E) Sets the language type for both the attached scripts Valid
values are "mel" (enabled by default), and "python"
:returns:
"""
pass
def debugVar(*args, **kwargs)->None:
"""
"""
pass
def CreateAreaLight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OpenCloseSurfacesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def wireContext(*args, crossingEffect: Union[float, bool]=0, deformationOrder: Union[AnyStr,
bool]="", dropoffDistance: Union[float, bool]=0.0, envelope: Union[float,
bool]=1.0, exclusive: bool=True, exclusivePartition: Union[AnyStr, bool]="",
exists: bool=True, groupWithBase: bool=False, history: bool=True, holder:
bool=False, image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="",
image3: Union[AnyStr, bool]="", localInfluence: Union[float, bool]=0, name:
AnyStr="", q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command creates a tool that can be used to create a wire deformer
:param crossingEffect: (C Q E) Set the amount of convolution filter effect Varies from
fully convolved at 0 to a simple additive effect at 1 Default is 0
:param deformationOrder: (C Q E) Set the appropriate flag that determines the position in
in the deformation hierarchy
:param dropoffDistance: (C Q E) Set the dropoff Distance for the wires
:param envelope: (C Q E) Set the envelope value for the deformer Default is 1.0
:param exclusive: (C Q E) Set exclusive mode on or off
:param exclusivePartition: (C Q E) Set the name of an exclusive partition
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param groupWithBase: (C Q E) Groups the wire with the base wire so that they can easily be
moved together to create a ripple effect Default is false
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param holder: (C E) Controls whether the user can specify holders for the wires from the
wire context A holder is a curve that you can use to limit the wire's deformati
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param localInfluence: (C Q E) Set the amount of local influence a wire has with respect to
other wires Default is 0
:param name: (C) If this is a tool command, name the tool appropriately
:returns: The name of the context created
"""
pass
def OutlinerToggleReferenceNodes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PerspTextureLayout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def rowLayout(*args, adjustableColumn: int=0, adjustableColumn1: int=0, adjustableColumn2:
int=0, adjustableColumn3: int=0, adjustableColumn4: int=0, adjustableColumn5:
int=0, adjustableColumn6: int=0, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, childArray:
bool=True, columnAlign: Union[List[int, AnyStr], List[List[int, AnyStr]]]=None,
columnAlign1: AnyStr="", columnAlign2: List[AnyStr, AnyStr]=None, columnAlign3:
List[AnyStr, AnyStr, AnyStr]=None, columnAlign4: List[AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAlign5: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAlign6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None,
columnAttach: Union[List[int, AnyStr, int], List[List[int, AnyStr, int]]]=None,
columnAttach1: AnyStr="", columnAttach2: List[AnyStr, AnyStr]=None,
columnAttach3: List[AnyStr, AnyStr, AnyStr]=None, columnAttach4: List[AnyStr,
AnyStr, AnyStr, AnyStr]=None, columnAttach5: List[AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnAttach6: List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr,
AnyStr]=None, columnOffset1: int=0, columnOffset2: List[int, int]=None,
columnOffset3: List[int, int, int]=None, columnOffset4: List[int, int, int,
int]=None, columnOffset5: List[int, int, int, int, int]=None, columnOffset6:
List[int, int, int, int, int, int]=None, columnWidth: Union[List[int, int],
List[List[int, int]]]=None, columnWidth1: int=0, columnWidth2: List[int,
int]=None, columnWidth3: List[int, int, int]=None, columnWidth4: List[int, int,
int, int]=None, columnWidth5: List[int, int, int, int, int]=None, columnWidth6:
List[int, int, int, int, int, int]=None, defineTemplate: AnyStr="", docTag:
Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback: Script=None,
enable: bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
exists: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, manage: bool=True, noBackground: bool=True, numberOfChildren:
bool=True, numberOfColumns: Union[int, bool]=0, numberOfPopupMenus: bool=True,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, rowAttach: Union[List[int, AnyStr, int], List[List[int, AnyStr,
int]]]=None, statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a layout capable of positioning children into a single horizontal row
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout
:param adjustableColumn1: (C) Specifies that the first column has an adjustable size that
changes with the size of the parent layout Ignored if there isn't exactly one column
:param adjustableColumn2: (C) Specifies which of the two columns has an adjustable size
that changes with the size of the parent layout Ignored if there isn't exactly two
columns
:param adjustableColumn3: (C) Specifies which of the three columns has an adjustable size
that changes with the size of the parent layout Ignored if there isn't exactly three col
:param adjustableColumn4: (C) Specifies which of the four columns has an adjustable size
that changes with the size of the parent layout Ignored if there isn't exactly four colum
:param adjustableColumn5: (C) Specifies which of the five columns has an adjustable size
that changes with the size of the parent layout Ignored if there isn't exactly five colum
:param adjustableColumn6: (C) Specifies which of the six columns has an adjustable size
that changes with the size of the parent layout Ignored if there isn't exactly six
columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param columnAlign: (C E M) Text alignment for the specified column Valid values are
"left", "right", and "center"
:param columnAlign1: (C) Text alignment for the first column Valid values are "left",
"right", and "center" Ignored if there isn't exactly one column
:param columnAlign2: (C) Text alignment for both columns Valid values are "left", "right",
and "center" Ignored if there isn't exactly two columns
:param columnAlign3: (C) Text alignment for all three columns Valid values are "left",
"right", and "center" Ignored if there isn't exactly three columns
:param columnAlign4: (C) Text alignment for all four columns Valid values are "left",
"right", and "center" Ignored if there isn't exactly four columns
:param columnAlign5: (C) Text alignment for all five columns Valid values are "left",
"right", and "center" Ignored if there isn't exactly five columns
:param columnAlign6: (C) Text alignment for all six columns Valid values are "left",
"right", and "center" Ignored if there isn't exactly six columns
:param columnAttach: (C E M) Horizontally attach a particular column The first argument is
a 1-based index specifying the column The second argument is the attachment, valid va
:param columnAttach1: (C) Attachment type for the first column Ignored if there isn't
exactly one column Valid values are "left", "right", and "both"
:param columnAttach2: (C) Attachment type for both columns Ignored if there isn't exactly
two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C) Attachment type for all three columns Ignored if there isn't
exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C) Attachment type for all four columns Ignored if there isn't
exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C) Attachment type for all five columns Ignored if there isn't
exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C) Attachment type for all six columns Ignored if there isn't
exactly six columns Valid values are "left", "right", and "both"
:param columnOffset1: (C) Used in conjunction with the -columnAttach1 flag If that flag is
not used then this flag will be ignored Sets the offset for the first column The
:param columnOffset2: (C) Used in conjunction with the -columnAttach2 flag If that flag is
not used then this flag will be ignored Sets the offset for both columns The offs
:param columnOffset3: (C) Used in conjunction with the -columnAttach3 flag If that flag is
not used then this flag will be ignored Sets the offset for all three columns The
:param columnOffset4: (C) Used in conjunction with the -columnAttach4 flag If that flag is
not used then this flag will be ignored Sets the offset for all four columns The
:param columnOffset5: (C) Used in conjunction with the -columnAttach5 flag If that flag is
not used then this flag will be ignored Sets the offset for all five columns The
:param columnOffset6: (C) Used in conjunction with the -columnAttach6 flag If that flag is
not used then this flag will be ignored Sets the offset for all six columns The o
:param columnWidth: (C E M) Width of a particular column The first argument is a 1-based
index specifying the column The second argument is the width value
:param columnWidth1: (C) Width for the first column Ignored if there isn't exactly one
column
:param columnWidth2: (C) Widths for both columns Ignored if there isn't exactly two
columns
:param columnWidth3: (C) Widths for all three columns Ignored if there isn't exactly three
columns
:param columnWidth4: (C) Widths for all four columns Ignored if there isn't exactly four
columns
:param columnWidth5: (C) Widths for all five columns Ignored if there isn't exactly five
columns
:param columnWidth6: (C) Widths for all six columns Ignored if there isn't exactly six
columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfColumns: (C Q) Number of columns in the row The specified number of columns
must be a value greater than 0
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Vertically attach a particular column The first argument is a
1-based index specifying the column The second argument is the attachment, valid valu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def ProfilerToolHideSelectedRepetition(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def aaf2fcp(*args, deleteFile: bool=True, dstPath: AnyStr="", getFileName: int=0, progress:
int=0, srcFile: AnyStr="", terminate: int=0, waitCompletion: int=0,
**kwargs)->AnyStr:
"""
This command is used to convert an aff file to a Final Cut Pro (fcp) xml file The
conversion process can take several seconds to complete and the command is meant to be run
asynchronously
:param deleteFile: (C) Delete temporary file Can only be used with the terminate option
:param dstPath: (C) Specifiy a destination path
:param getFileName: (C) Query output file name
:param progress: (C) Request progress report
:param srcFile: (C) Specifiy a source file
:param terminate: (C) Complete the task
:param waitCompletion: (C) Wait for the conversion process to complete
:returns: Command result
"""
pass
def SetDrivenKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def spreadSheetEditor(*args, allAttr: bool=True, attrRegExp: Union[AnyStr, bool]="", control:
bool=True, defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
execute: AnyStr="", exists: bool=True, filter: Union[AnyStr, bool]="",
fixedAttrList: Union[List[AnyStr], bool]=None, forceMainConnection:
Union[AnyStr, bool]="", highlightConnection: Union[AnyStr, bool]="",
keyableOnly: bool=True, lockMainConnection: bool=True, longNames:
bool=True, mainListConnection: Union[AnyStr, bool]="", niceNames:
bool=True, panel: Union[AnyStr, bool]="", parent: Union[AnyStr, bool]="",
precision: Union[int, bool]=0, selectedAttr: bool=True,
selectionConnection: Union[AnyStr, bool]="", showShapes: bool=True,
stateString: bool=True, unParent: bool=True, unlockMainConnection:
bool=True, updateMainConnection: bool=True, useTemplate: AnyStr="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a new spread sheet editor in the current layout
:param allAttr: (Q) Returns a list of all the attribute names currently being displayed
This flag is ignored when not being queried
:param attrRegExp: (C Q E) Filter the current displayed attribute names This expression
matches the case-insensitive substring of attribute names
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the editor
:param execute: (E) Immediately executes the command string once for every selected cell in
the spreadSheet Before the command is executed, "#A" is substituted with the
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param fixedAttrList: (C Q E) Forces the editor to only display attributes with the
specified names
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param keyableOnly: (C Q E) Limits the displayed attributes to be those that are keyable
True by default
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param longNames: (C Q E) Controls whether the attributes are displayed using their long
names or their short names
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param niceNames: (C Q E) Controls whether the attribute names will be displayed in a more
user-friendly, readable way When this is on, the longNames flag is ignored When th
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param precision: (C Q E) Specifies the maximum number of digits displayed to the right of
the decimal place Can be 0 to 20
:param selectedAttr: (Q) Returns a list of all the attribute names that are selected This
flag is ignored when not being queried
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param showShapes: (C Q E) If true, when transforms are selected their shapes will be
displayed instead
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the editor
"""
pass
def adskAssetLibrary(*args, **kwargs)->None:
"""
"""
pass
def dR_nexTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AlembicExportAllOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowFluids(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def selectKey(*args, addTo: bool=True, animation: AnyStr="keysOrObjects.", attribute:
Union[AnyStr, List[AnyStr]]="", clear: bool=True, controlPoints: bool=False,
float: Union[floatrange, List[floatrange]]=None, hierarchy: AnyStr="", inTangent:
bool=True, includeUpperBound: bool=True, index: Union[int, List[int]]=0,
keyframe: bool=True, outTangent: bool=True, remove: bool=True, replace: bool=True,
shape: bool=True, time: Union[timerange, List[timerange]]=None, toggle: bool=True,
unsnappedKeys: float=0.0, **kwargs)->int:
"""
This command operates on a keyset A keyset is defined as a group of keys within a
specified time range on one or more animation curves The animation curves comprising a
keyset depend on the value of the "-animation" flag: keysOrObjects: Any active keys, when
no target objects or -attribute flags appear on the command line, or All animation curv
:param addTo: (C) Add to the current selection of keyframes/tangents
:param animation: (C) Where this command should get the animation to act on Valid values
are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Descrip
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param clear: (C) Remove all keyframes and tangents from the active list
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param float: (C M) value uniquely representing a non-time-based key (or key range) on a
time-based animCurve Valid floatRange include single values (-f 10) or a string
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param inTangent: (C) Select in-tangents of keyframes in the specified time range
:param includeUpperBound: (C) When the -t/time or -f/float flags represent a range of keys,
this flag determines whether the keys at the upper bound of the range are included in t
:param index: (C M) index of a key on an animCurve In query mode, this flag needs a value
:param keyframe: (C) select only keyframes (cannot be combined with -in/-out)
:param outTangent: (C) Select out-tangents of keyframes in the specified time range
:param remove: (C) Remove from the current selection of keyframes/tangents
:param replace: (C) Replace the current selection of keyframes/tangents
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:param time: (C M) time uniquely representing a key (or key range) on a time-based
animCurve See the code examples below on how to format for a single frame or frame r
:param toggle: (C) Toggle the picked state of the specified keyset
:param unsnappedKeys: (C) Select only keys that have times that are not a multiple of the
specified numeric value
:returns: The number of curves on which keys were
selected (or deselcted).
"""
pass
def displayPref(*args, activeObjectPivots: bool=True, displayAffected: bool=True,
displayGradient: bool=True, ghostFrames: Union[List[int, int, int], bool]=None,
materialLoadingMode: Union[AnyStr, bool]="", maxHardwareTextureResolution:
bool=True, maxTextureResolution: Union[int, bool]=0, purgeExistingTextures:
bool=True, regionOfEffect: bool=True, shadeTemplates: bool=True,
textureDrawPixel: bool=True, wireframeOnShadedActive: Union[AnyStr, bool]="",
q=True, query=True, **kwargs)->Union[None, Any]:
"""
This command sets/queries the state of global display parameters
:param activeObjectPivots: (C Q) Sets the display state for drawing pivots for active
objects
:param displayAffected: (C Q) Turns on/off the special coloring of objects that are
affected by the objects that are currently in the selection list If one of the curves in a
lof
:param displayGradient: (C Q) Set whether to display the background using a colored
gradient as opposed to a constant background color
:param ghostFrames: (C Q) Sets the ghosting frame preferences: steps before, steps after
and step size
:param materialLoadingMode: (C Q) Sets the material loading mode when loading the scene
Possible values for the string argument are "immediate", "deferred" and "parallel"
:param maxHardwareTextureResolution: (Q) Query the maximum allowable hardware texture
resolution available on the current video card This maximum can vary between different
video cards and
:param maxTextureResolution: (C Q) Sets the maximum hardware texture resolution to be used
when creating hardware textures for display The maximum will be clamped to the maximum
allow
:param purgeExistingTextures: (C) Purge any existing hardware textures This will force a
re-evaluation of hardware textures used for display, and thus may take some time to
evaluate
:param regionOfEffect: (C Q) Turns on/off the display of the region of curves/surfaces that
is affected by changes to selected CVs and edit points
:param shadeTemplates: (C Q) Turns on/off the display of templated surfaces as shaded in
shaded display mode If its off, templated surfaces appear in wireframe
:param textureDrawPixel: (C Q) Sets the display mode for drawing image planes True for use
of gltexture calls for perspective views This flag should not normally be needed Image
:param wireframeOnShadedActive: (C Q) Sets the display state for drawing the wireframe on
active shaded objects Possible values for the string argument are "full", "reduced" and
"none"
:returns:
"""
pass
def fileDialog2(*args, buttonBoxOrientation: int=0, cancelCaption: AnyStr="", caption:
AnyStr="", dialogStyle: int=0, fileFilter: AnyStr="", fileMode: int=0,
fileTypeChanged: Script=None, hideNameEdit: bool=True, okCaption: AnyStr="",
optionsUICancel: Script=None, optionsUICommit: Script=None, optionsUICommit2:
Script=None, optionsUICreate: Script=None, optionsUIInit: Script=None,
returnFilter: bool=True, selectFileFilter: AnyStr="", selectionChanged:
Script=None, setProjectBtnEnabled: bool=True, startingDirectory: AnyStr="",
**kwargs)->AnyStr:
"""
This command provides a dialog that allows users to select files or directories
:param buttonBoxOrientation: (C) 1 Vertical button box layout Cancel button is below the
accept button 2 Horizontal button box layout Cancel button is to the right of the accept
b
:param cancelCaption: (C) If the dialogStyle flag is set to 2 then this provides a caption
for the Cancel button within the dialog
:param caption: (C) Provide a title for the dialog
:param dialogStyle: (C) 1 On Windows or Mac OS X will use a native style file dialog 2 Use
a custom file dialog with a style that is consistent across platforms
:param fileFilter: (C) Provide a list of file type filters to the dialog Multiple filters
should be separated by double semi-colons See the examples section
:param fileMode: (C) Indicate what the dialog is to return 0 Any file, whether it exists
or not 1 A single existing file 2 The name of a directory Both directories an
:param fileTypeChanged: (C) MEL only The string is interpreted as a MEL callback, to be
called when the user-selected file type changes The callback is of the form: global pro
:param hideNameEdit: (C) Hide name editing input field
:param okCaption: (C) If the dialogStyle flag is set to 2 then this provides a caption for
the OK, or Accept, button within the dialog
:param optionsUICancel: (C) MEL only The string is interpreted as a MEL callback, to be
called when the dialog is cancelled (with Cancel button or close button to close window)
:param optionsUICommit: (C) MEL only The string is interpreted as a MEL callback, to be
called when the dialog is successfully dismissed It will not be called if the user canc
:param optionsUICommit2: (C) MEL only As optionsUICommit, the given string is interpreted
as a MEL callback, to be called when the dialog is successfully dismissed The differen
:param optionsUICreate: (C) MEL only The string is interpreted as a MEL callback, to be
called on creation of the file dialog The callback is of the form: global proc MyCustom
:param optionsUIInit: (C) MEL only The string is interpreted as a MEL callback, to be
called just after file dialog creation, to initialize controls The callback is of the f
:param returnFilter: (C) If true, the selected filter will be returned as the last item in
the string array along with the selected files
:param selectFileFilter: (C) Specify the initial file filter to select Specify just the
begining text and not the full wildcard spec
:param selectionChanged: (C) MEL only The string is interpreted as a MEL callback, to be
called when the user changes the file selection in the file dialog The callback is of t
:param setProjectBtnEnabled: (C) Define whether the project button should be enabled
:param startingDirectory: (C) Provide the starting directory for the dialog
:returns: array
"""
pass
def SetToFaceNormalsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintRandomOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphPasteOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def license(*args, borrow: bool=True, info: bool=True, isBorrowed: bool=True, isExported:
bool=True, isTrial: bool=True, licenseMethod: bool=True, productChoice: bool=True,
r: bool=True, showBorrowInfo: bool=True, showProductInfoDialog: bool=True, status:
bool=True, usage: bool=True, **kwargs)->AnyStr:
"""
This command displays version information about the application if it is executed without
flags If one of the above flags is specified then the specified version information is
returned
:param borrow: (C) This flag is obsolete and no longer supported
:param info: (C) This flag is obsolete and no longer supported
:param isBorrowed: (C) This flag is obsolete and no longer supported
:param isExported: (C) This flag is obsolete and no longer supported
:param isTrial: (C) This flag is obsolete and no longer supported
:param licenseMethod: (C) This flag is obsolete and no longer supported
:param productChoice: (C) This flag is obsolete and no longer supported
:param r: (C) This flag is obsolete and no longer supported
:param showBorrowInfo: (C) This flag is obsolete and no longer supported
:param showProductInfoDialog: (C) Show the Product Information Dialog
:param status: (C) This flag is obsolete and no longer supported
:param usage: (C) This flag is obsolete and no longer supported
:returns: The application's license information.
"""
pass
def HypershadeDisplayAllShapes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddToCurrentSceneMudbox(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MirrorDeformerWeightsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddAnimationOffset(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyExtrudeFacesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadePickWalkLeft(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TransferVertexOrder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FreezeTransformations(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def skinCluster(*args, addInfluence: Union[AnyStr, List[AnyStr]]="", addToSelection: bool=True,
after: bool=True, afterReference: bool=True, baseShape: Union[AnyStr,
List[AnyStr]]="", before: bool=True, bindMethod: Union[int, bool]=0,
deformerTools: bool=True, dropoffRate: Union[float, bool]=0.0, exclusive:
Union[AnyStr, bool]="", forceNormalizeWeights: bool=True, frontOfChain:
bool=True, geometry: Union[AnyStr, List[AnyStr], bool]="", geometryIndices:
bool=True, heatmapFalloff: float=0.0, ignoreBindPose: bool=True,
ignoreHierarchy: bool=True, ignoreSelected: bool=True, includeHiddenSelections:
bool=False, influence: Union[AnyStr, bool]="", lockWeights: bool=True,
maximumInfluences: Union[int, bool]=0, moveJointsMode: bool=True, name:
AnyStr="", normalizeWeights: Union[int, bool]=0, nurbsSamples: int=0,
obeyMaxInfluences: bool=True, parallel: bool=True, polySmoothness: float=0.0,
prune: bool=True, recacheBindMatrices: bool=True, remove: Union[bool,
List[bool]]=True, removeFromSelection: bool=True, removeInfluence: Union[AnyStr,
List[AnyStr]]="", removeUnusedInfluence: bool=True, selectInfluenceVerts:
AnyStr="", skinMethod: Union[int, bool]=1, smoothWeights: float=0.0,
smoothWeightsMaxIterations: int=2, split: bool=True, toSelectedBones: bool=True,
toSkeletonAndTransforms: bool=True, unbind: bool=True, unbindKeepHistory:
bool=True, useGeometry: bool=True, volumeBind: float=0.0, volumeType: int=0,
weight: float=0.0, weightDistribution: Union[int, bool]=1, weightedInfluence:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
The skinCluster command is used for smooth skinning in maya It binds the selected geometry
to the selected joints or skeleton by means of a skinCluster node Each point of the bound
geometry can be affected by any number of joints The extent to which each joint affects
the motion of each point is regulated by a corresponding weight factor Weight
:param addInfluence: (E M) The specified transform or joint will be added to the list of
transforms that influence the bound geometry The maximum number of influences will be
:param addToSelection: (E) When used in conjunction with the selectInfluenceVerts flag,
causes the vertices afftected by the influence to be added to the current selection, wit
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param baseShape: (E M) This flag can be used in conjunction with the -addInfluence flag to
specify the shape that will be used as the base shape when an influence object wi
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param bindMethod: (C Q) This flag sets the binding method 0 - Closest distance between a
joint and a point of the geometry 1 - Closest distance between a joint, considerin
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param dropoffRate: (C Q E) Sets the rate at which the influence of a transform drops as
the distance from that transform increases The valid range is between 0.1 and 10.0 In
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param forceNormalizeWeights: (E) If the normalization mode is none or post, it is possible
(indeed likely) for the weights in the skin cluster to no longer add up to 1 This flag
for
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param heatmapFalloff: (C) This flag sets the heatmap binding falloff If set to 0.0
(default) the deformation will be smoother due to many small weights spread over the mesh
s
:param ignoreBindPose: (C E) This flag is deprecated and no longer used It will be ignored
if used
:param ignoreHierarchy: (C Q) Deprecated Use bindMethod flag instead Disregard the place
of the joints in the skeleton hierarchy when computing the closest joints that influence
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param influence: (Q E) This flag specifies the influence object that will be used for the
current edit operation In query mode, returns a string array of the influence obj
:param lockWeights: (Q E) Lock the weights of the specified influence object to their
current value or to the value specified by the -weight flag
:param maximumInfluences: (C Q E) Sets the maximum number of transforms that can influence
a point (have non-zero weight for the point) when the skinCluster is first created or a
new
:param moveJointsMode: (E) If set to true, puts the skin into a mode where joints can be
moved without modifying the skinning If set to false, takes the skin out of move joint
:param name: (C) Used to specify the name of the node being created
:param normalizeWeights: (C Q E) This flag sets the normalization mode 0 - none, 1 -
interactive, 2 - post (default) Interactive normalization makes sure the weights on the
influenc
:param nurbsSamples: (C E) Sets the number of sample points that will be used along an
influence curve or in each direction on an influence NURBS surface to influence the bound
:param obeyMaxInfluences: (C Q E) When true, the skinCluster will continue to enforce the
maximum influences each time the user modifies the weight, so that any given point is only
we
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param polySmoothness: (C E) This flag controls how accurately the skin control points
follow a given polygon influence object The higher the value of polySmoothnmess the more
r
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param recacheBindMatrices: (E) Forces the skinCluster node to recache its bind matrices
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param removeFromSelection: (E) When used in conjunction with the selectInfluenceVerts flag,
causes the vertices afftected by the influence to be removed from the current selection
:param removeInfluence: (E M) Remove the specified transform or joint from the list of
transforms that influence the bound geometry The weights for the affected points are
renorma
:param removeUnusedInfluence: (C) If this flag is set to true then transform or joint whose
weights are all zero (they have no effect) will not be bound to the geometry Having this
o
:param selectInfluenceVerts: (E) Given the name of a transform, this will select the verts
or control points being influenced by this transform, so users may visualize which
vertices
:param skinMethod: (C Q E) This flag set the skinning method 0 - classical linear skinning
(default) 1 - dual quaternion (volume preserving), 2 - a weighted blend between the
:param smoothWeights: (E) This flag is used to detect sudden jumps in skin weight values,
which often indicates bad weighting, and then smooth out those jaggies in skin weight
:param smoothWeightsMaxIterations: (E) This flag is valid only with the smooth weights flag
It is possible that not all the vertices detected as needing smoothing can be smoothed in
1 ite
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:param toSelectedBones: (C) geometry will be bound to the selected bones only
:param toSkeletonAndTransforms: (C) geometry will be bound to the skeleton and any
transforms in the hierarchy If any of the transforms are also bindable objects, assume
that only the
:param unbind: (E) Unbinds the geometry from the skinCluster and deletes the skinCluster
node
:param unbindKeepHistory: (E) Unbinds the geometry from the skinCluster, but keeps the
skinCluster node so that its weights can be used when the skin is rebound To rebind, use
th
:param useGeometry: (E) When adding an influence to a skinCluster, use the geometry
parented under the influence transform to determine the weight dropoff of that influence
:param volumeBind: (C) Creates a volume bind node and attaches it to the new skin cluster
node This node holds hull geometry parameters for a volume based weighting system
:param volumeType: (C) Defines the initial shape of the binding volume (see volumeBind) 0
- Default (currently set to a capsule) 1 - Capsule, 2 - Cylinder
:param weight: (E) This flag is only valid in conjunction with the -addInfluence flag It
sets the weight for the influence object that is being added
:param weightDistribution: (C Q E) This flag sets the weight distribution mode 0 -
distance (default), 1 - neighbors When normalizeWeights is in effect, and a weight has been
reduced
:param weightedInfluence: (Q) This flag returns a string array of the influence objects
(joints and transform) that have non-zero weighting
:returns: (the skinCluster node name)
"""
pass
def NodeEditorGraphRemoveDownstream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SeparatePolygon(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def walkCtx(*args, alternateContext: bool=True, crouchCount: Union[float, bool]=0.0, exists:
bool=True, history: bool=True, image1: Union[AnyStr, bool]="", image2: Union[AnyStr,
bool]="", image3: Union[AnyStr, bool]="", name: AnyStr="", toolName: Union[AnyStr,
bool]="", walkHeight: Union[float, bool]=0.0, walkSensitivity: Union[float,
bool]=0.0, walkSpeed: Union[float, bool]=0.0, walkToolHud: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create, edit, or query a walk context
:param alternateContext: (C Q) Set the ALT+MMB and ALT+SHIFT+MMB to refer to this context
:param crouchCount: (C Q E) The camera crouch count
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param toolName: (C Q) Name of the specific tool to which this command refers
:param walkHeight: (C Q E) The camera initial height
:param walkSensitivity: (C Q E) The camera rotate sensitivity
:param walkSpeed: (C Q E) The camera move speed
:param walkToolHud: (C Q E) Control whether show walk tool HUD
:returns: The name of the context
"""
pass
def FBXExportGenerateLog(*args, **kwargs)->None:
"""
"""
pass
def showMetadata(*args, auto: bool=True, dataType: Union[AnyStr, bool]="", interpolation:
bool=True, isActivated: bool=True, listAllStreams: bool=True, listMembers:
bool=True, listValidMethods: bool=True, listVisibleStreams: bool=True, member:
Union[AnyStr, bool]="", method: Union[AnyStr, bool]="", range:
Union[List[float, float], bool]=None, rayScale: Union[float, bool]=0.0,
stream: Union[AnyStr, bool]="", q=True, query=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command is used to show metadata values which is in the specified channels "vertex",
"edge", "face", and "vertexFace" in the viewport You can view the data by three ways:
"color": draw color on the components "ray": draw a ray on the components "string": draw
2d strings on the components For example, if the metadata of "shape.vtx[1]" is
:param auto: (C Q) Similar to the flag "-range", but uses the min/max value from the
metadata in the same stream and member instead of the specified input value In que
:param dataType: (C Q) In create mode, when used with the flags "stream" and "member",
specify a member to show If the flag "off" is used, specify the member to turn off
:param interpolation: (C Q) In create mode, enable/disable interpolation for "color" method
When interpolation is on, the components will be displayed in the interpolated color
:param isActivated: (C Q) Used to check if the given stream is activated If some shapes
are selected, query their states If no shape is selected, query the states of all sha
:param listAllStreams: (C Q) Used with object names to list all streams of the specified
objects no matter if they are visible in the viewport Or you can use the flag individua
:param listMembers: (C Q) Used with the flag 'stream' to get the member list in the
specified stream
:param listValidMethods: (C Q) List the valid visual methods that can be set for the
current stream and member Some data type cannot be displayed by some methods For example,
if
:param listVisibleStreams: (C Q) Used with object names to list the name of the current
visible streams of the specified object Or you can use the flag with no object name to
list a
:param member: (C Q) In create mode, when used with the flags "stream" and "dataType",
specify a member to show If the flag "off" is on, specify the member to turn off
:param method: (C Q) Determine the method of visualization: "color" convert metadata to a
color value and draw the components with the color "ray" convert metadata to a v
:param range: (C Q) Specify the range of data to use The value which is out of the range
will be clamped to the min/max value If the method of visualization is "color"
:param rayScale: (C Q) Specify the scale of the ray to display it with a proper length
:param stream: (C Q) In create mode, when used with the flags "member" and "dataType",
specify a member to show If the flag "off" is used, specify the member to turn off
:returns: result of the operation or the queried status
"""
pass
def hardware(*args, brdType: bool=True, cpuType: bool=True, graphicsType: bool=True, megaHertz:
bool=True, numProcessors: bool=True, **kwargs)->AnyStr:
"""
Return description of the hardware available in the machine
:param brdType: (C) Returns IP number identifying the CPU motherboard
:param cpuType: (C) Returns type of CPU
:param graphicsType: (C) Returns string identifying graphics hardware type
:param megaHertz: (C) Returns string identifying the speed of the CPU chip
:param numProcessors: (C) Returns string identifying the number of processors
:returns: Command result
"""
pass
def SmoothSkinWeights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def displayLevelOfDetail(*args, levelOfDetail: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command is responsible for setting the display level-of-detail for edit refreshes If
enabled, objects will draw with lower detail based on their distance from the camera When
disabled objects will display at full resolution at all times This is not an undoable
command
:param levelOfDetail: () Enable/disable level of detail
:returns:
"""
pass
def IPROptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LayoutUVAlong(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeReduceTraversalDepth(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeRenderTextureRange(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ArchiveScene(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def movieCompressor(*args, **kwargs)->None:
"""
"""
pass
def cMuscleWeight(*args, **kwargs)->None:
"""
"""
pass
def dR_modeVert(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PruneWire(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cacheFileTrack(*args, insertTrack: int=0, lock: bool=True, mute: bool=True,
removeEmptyTracks: bool=True, removeTrack: int=0, solo: bool=True, track:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This command is used for inserting and removing tracks related to the caches displayed in
the trax editor It can also be used to modify the track state, for example, to lock or
mute a track
:param insertTrack: (C) This flag is used to insert a new empty track at the track index
specified
:param lock: (C Q E) This flag specifies whether clips on a track are to be locked or not
:param mute: (C Q E) This flag specifies whether clips on a track are to be muted or not
:param removeEmptyTracks: (C) This flag is used to remove all tracks that have no clips
:param removeTrack: (C) This flag is used to remove the track with the specified index The
track must have no clips on it before it can be removed
:param solo: (C Q E) This flag specifies whether clips on a track are to be soloed or not
:param track: (C Q E) Used to specify a new track index for a cache to be displayed
Track-indices are 1-based
:returns:
"""
pass
def xgmSmoothBrushContext(*args, **kwargs)->None:
"""
"""
pass
def dR_testCmd(*args, **kwargs)->None:
"""
"""
pass
def NEmitFromObjectOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmCutBrushContext(*args, **kwargs)->None:
"""
"""
pass
def MakeShadowLinks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FloatSelectedPondObjectsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def insertKnotCurve(*args, addKnots: bool=True, caching: bool=True, insertBetween: bool=False,
nodeState: Union[int, bool]=0, numberOfKnots: Union[int, List[int], bool]=1,
parameter: Union[float, List[float], bool]=0.0, constructionHistory:
bool=True, curveOnSurface: bool=True, name: AnyStr="", object: bool=True,
replaceOriginal: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The insertKnotCurve command inserts knots into a curve given a list of parameter values
The number of knots to add at each parameter value and whether the knots are added or
complemented can be specified The name of the curve is returned If construction history
is on, the name of the resulting dependency node is also returned An edit point wil
:param addKnots: (C Q E) Whether to add knots or complement Complement means knots will be
added to reach the specified number of knots Default: true
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param insertBetween: (C Q E) If set to true, and there is more than one parameter value
specified, the knots will get inserted at equally spaced intervals between the given param
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param numberOfKnots: (C Q E M) How many knots to insert At any point on the curve, there
can be a maximum of "degree" knots Default: 1
:param parameter: (C Q E M) Parameter value(s) where knots are added Default: 0.0
:param constructionHistory: (C) Turn the construction history on or off
:param curveOnSurface: (C) If possible, create 2D curve as a result
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def PolygonSoftenEdge(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutlinerCollapseAllSelectedItems(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideUnselectedCVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def WireToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateGhostOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def listAttrPatterns(*args, patternType: bool=True, verbose: bool=True,
**kwargs)->List[AnyStr]:
"""
Attribute patterns are plain text descriptions of an entire Maya attribute forest
("forest" because there could be an arbitrary number of root level attributes, it's not
restricted to having a single common parent though in general that practice is a good
idea.) This command lists the various pattern types available, usually created via plugin,
as
:param patternType: (C) If turned on then show the list of pattern types rather than actual
instantiated patterns
:param verbose: (C) If turned on then show detailed information about the patterns or
pattern types The same list of instance or pattern names is returned as for the no
:returns: List of patterns or pattern instances available
"""
pass
def cmdFileOutput(*args, close: int=0, closeAll: bool=True, open: Union[AnyStr, bool]="",
status: Union[int, bool]=0, q=True, query=True, **kwargs)->Union[int, Any]:
"""
This command will open a text file to receive all of the commands and results that normally
get printed to the Script Editor window or console The file will stay open until an
explicit -close with the correct file descriptor or a -closeAll, so care should be taken
not to leave a file open To enable logging to commence as soon as Maya starts up,
:param close: (C) Closes the file corresponding to the given descriptor If -3 is returned,
the file did not exist -1 is returned on error, 0 is returned on successfu
:param closeAll: (C) Closes all open files
:param open: (C Q) Opens the given file for writing (will overwrite if it exists and is
writable) If successful, a value is returned to enable status queries and file
:param status: (C Q) Queries the status of the given descriptor -3 is returned if no such
file exists, -2 indicates the file is not open, -1 indicates an error condition
:returns: : On open, returns a value (descriptor) that can be used to query
the status or
close the file. Otherwise, a status code
indicating status of file
"""
pass
def GraphEditorNeverDisplayTangents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UntrimSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveBlendShapeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_coordSpaceCustom(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonCube(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVUnstackShells(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nexMultiCutContext(*args, **kwargs)->None:
"""
"""
pass
def connectAttr(*args, force: bool=True, lock: bool=True, nextAvailable: bool=True,
referenceDest: AnyStr="", **kwargs)->AnyStr:
"""
Connect the attributes of two dependency nodes and return the names of the two connected
attributes The connected attributes must be be of compatible types First argument is the
source attribute, second one is the destination Refer to dependency node documentation
:param force: (C) Forces the connection If the destination is already connected, the old
connection is broken and the new one made
:param lock: (C) If the argument is true, the destination attribute is locked after making
the connection If the argument is false, the connection is unlocked before
:param nextAvailable: (C) If the destination multi-attribute has set the indexMatters to be
false with this flag specified, a connection is made to the next available index N
:param referenceDest: (C) This flag is used for file io only The flag indicates that the
connection replaces a connection made in a referenced file, and the flag argument ind
:returns: A phrase containing the names of the connected attributes.
"""
pass
def treeLister(*args, addFavorite: Union[AnyStr, List[AnyStr]]="", addItem: Union[List[AnyStr,
AnyStr, Script], List[List[AnyStr, AnyStr, Script]]]=None, addVnnItem:
Union[List[AnyStr, AnyStr, AnyStr, AnyStr], List[List[AnyStr, AnyStr, AnyStr,
AnyStr]]]=None, annotation: Union[AnyStr, bool]="", backgroundColor:
Union[List[float, float, float], bool]=None, clearContents: bool=True,
collapsePath: Union[AnyStr, List[AnyStr]]="", defineTemplate: AnyStr="", docTag:
Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback: Script=None,
enable: bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
executeItem: AnyStr="", exists: bool=True, expandPath: Union[AnyStr,
List[AnyStr]]="", expandToDepth: int=0, favoritesCallback: Script=None,
favoritesList: bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, itemScript: Union[AnyStr, bool]="", manage: bool=True, noBackground:
bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, refreshCommand:
Union[Script, bool]=None, removeFavorite: Union[AnyStr, List[AnyStr]]="",
removeItem: Union[AnyStr, List[AnyStr]]="", resultsPathUnderCursor: bool=True,
selectPath: Union[AnyStr, List[AnyStr]]="", statusBarMessage: AnyStr="",
useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, vnnString: bool=True, width: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates/edits/queries the tree lister control The optional argument is the
name of the control
:param addFavorite: (C E M) Add an item path to the favorites folder The item path does
not have to actually be in the tree
:param addItem: (C E M) Add an item to the control The arguments are item-path,icon path,
command where item-path is the path from the root of the tree to the item's name ic
:param addVnnItem: (C E M) Add a VNN (Virtual Node Network) item to the control The
arguments are: item-path, icon-path, vnn-string, vnn-action Where item-path is the path
fr
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param clearContents: (E) Clears the contents of the control
:param collapsePath: (E M) Collapse a path in the tree
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param executeItem: (E) Execute the command associated with an item
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param expandPath: (E M) Expand a path in the tree
:param expandToDepth: (E) Expand the tree to the given depth
:param favoritesCallback: (C E) This script is called whenever a favorite is added or
removed It is passed two arguments: The item's path and a boolean indicating if it is
being ad
:param favoritesList: (Q) Returns the list of favorite items
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param itemScript: (Q) Returns the language and script command of the passed item path as a
two-element list, the first element is the string "MEL" or "Python" and the seco
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param refreshCommand: (C Q E) Command executed when the refresh button is pressed Note:
by default the refresh button is hidden and will be shown automatically when this command
:param removeFavorite: (E M) Remove an item from favorites Accepts the full favorite path
or the tail of the full path
:param removeItem: (E M) Remove an item path
:param resultsPathUnderCursor: (Q) Returns the path to the result (right-pane) item under
the mouse cursor Returns an empty string if there is no such item
:param selectPath: (E M) Select a path in the tree
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param vnnString: (Q) Returns the VNN (Virtual Node Network) string of the passed item
path
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the created control.
"""
pass
def timer(*args, endTimer: bool=True, lapTime: bool=True, name: AnyStr="", startTimer:
bool=True, **kwargs)->None:
"""
Allow simple timing of scripts and commands The resolution of this timer is at the level
of your OS's gettimeofday() function Note:This command does not handle stacked calls For
example, this code below will give an incorrect answer on the second timer -e call timer
-s; timer -s; timer -e; timer -e; To do this use named timers: timer -s; time
:param endTimer: (C) Stop the timer and return the time elapsed since the timer was started
(in seconds) Once a timer is turned off it no longer exists, though it can be
:param lapTime: (C) Get the lap time of the timer (time elapsed since start in seconds)
Unlike the end flag this keeps the timer running
:param name: (C) Use a named timer for the operation If this is omitted then the default
timer is assumed
:param startTimer: (C) Start the timer
:returns:
"""
pass
def SplitEdgeRingToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_loadRecentFile2(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def getInputDeviceRange(*args, maxValue: bool=True, minValue: bool=True,
**kwargs)->List[float]:
"""
This command lists the minimum and maximum values the device axis can return This value is
the raw device values before any mapping is applied If you don't specify an axis the
values for all axes of the device are returned
:param maxValue: (C) list only the maximum value of the axis
:param minValue: (C) list only the minimum value of the axis
:returns: Command result
"""
pass
def createNurbsCubeCtx(*args, **kwargs)->None:
"""
"""
pass
def glRender(*args, accumBufferPasses: Union[int, bool]=0, alphaSource: Union[AnyStr, bool]="",
antiAliasMethod: Union[AnyStr, bool]="", cameraIcons: bool=True, clearClr:
Union[List[float, float, float], bool]=None, collisionIcons: bool=True,
crossingEffect: bool=True, currentFrame: bool=True, drawStyle: Union[AnyStr,
bool]="", edgeSmoothness: Union[float, bool]=0.0, emitterIcons: bool=True,
fieldIcons: bool=True, flipbookCallback: Union[AnyStr, bool]="", frameEnd:
Union[int, bool]=0, frameIncrement: Union[int, bool]=0, frameStart: Union[int,
bool]=0, fullResolution: bool=True, grid: bool=True, imageDirectory: Union[AnyStr,
bool]="", imageName: Union[AnyStr, bool]="", imageSize: Union[List[int, int,
float], bool]=None, lightIcons: bool=True, lightingMode: Union[AnyStr, bool]="",
lineSmoothing: bool=True, offScreen: bool=True, renderFrame: Union[AnyStr,
bool]="", renderSequence: Union[AnyStr, bool]="", sharpness: Union[float,
bool]=0.0, shutterAngle: Union[float, bool]=0.0, textureDisplay: bool=True,
transformIcons: bool=True, useAccumBuffer: bool=True, viewport: Union[List[int,
int, float], bool]=None, writeDepthMap: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
This command provides access to the Hardware Render Manager (HRM) There is
one-and-only-one HRM in maya The HRM controls the rendering performed in the hardware
render buffer window This command allows shell scripts, to modify the render state, and to
initiate a render request
:param accumBufferPasses: (Q E) Set the number of accum buffer render passes
:param alphaSource: (Q E) Control the alpha source when writing image files Valid values
include: off, alpha, red, green, blue, luminance, clamp, invClamp
:param antiAliasMethod: (Q E) Set the method used for anti-aliasing polygons: off, uniform,
gaussian
:param cameraIcons: (Q E) Set display status of camera icons
:param clearClr: (Q E) Set the viewport clear color (0 - 1)
:param collisionIcons: (Q E) Set display status of collison model icons
:param crossingEffect: (Q E) Enable/disable image filtering with a convolution filter
:param currentFrame: (Q) Returns the current frame being rendered
:param drawStyle: (Q E) Set the object drawing style: boundingBox, points, wireframe,
flatShaded, smoothShaded
:param edgeSmoothness: (Q E) Controls the amount of edge smoothing A value of 0.0 gives no
smoothing, 1.0 gives default smoothing, and any other value scales the amount of defau
:param emitterIcons: (Q E) Set display status of emitter icons
:param fieldIcons: (Q E) Set display status of field icons
:param flipbookCallback: (Q E) Register a procedure to be called after the render sequence
has completed Used to build the flipbook pulldown menu See the example section for more
:param frameEnd: (Q E) Set the last frame to be rendered
:param frameIncrement: (Q E) Set the frame increment during rendering
:param frameStart: (Q E) Set the first frame to be rendered
:param fullResolution: (Q E) Enable/disable rendering to full image output resolution Must
set a valid image output resolution (-is)
:param grid: (Q E) Set display status of the grid
:param imageDirectory: (Q E) Set the directory for the image files
:param imageName: (Q E) Set the base name of the image files
:param imageSize: (Q E) Set the image output size Takes width, height and aspect ratio
Pass 0,0,0 to use current port size The image size must be equal to or greater then
:param lightIcons: (Q E) Set display status of light icons
:param lightingMode: (Q E) Set the lighting mode used for rendering: all, selected,
default
:param lineSmoothing: (Q E) Enable/disable anti-aliased lines
:param offScreen: (Q E) When set, this toggle allow HRM to use an offscreen buffer to
render the view This allows HRM to work when the application is iconified, or obscured
:param renderFrame: (Q E) Render the current frame Requires the name of the view in which
to render
:param renderSequence: (Q E) Render the current frame sequence Requires the name of the
view in which to render
:param sharpness: (Q E) Control the sharpness level of the convolution filter
:param shutterAngle: (Q E) Set the shutter angle used for motion blur (0 - 1) A value of
0.0 gives no blurring, 0.5 gives correct blurring, and 1.0 gives continuous blurring
:param textureDisplay: (Q E) Enable/disable texture map display
:param transformIcons: (Q E) Set display status of transform icons
:param useAccumBuffer: (Q E) Enable/disable the accumulation buffer
:param viewport: (Q E) Set the viewport size Pass in the width, height and aspect ratio
This size will be used for all test rendering and image output size unless full re
:param writeDepthMap: (Q E) Enable/disable writing of zdepth to image files
:returns:
"""
pass
def bakeSimulation(*args, animation: AnyStr="keysOrObjects.", attribute: Union[AnyStr,
List[AnyStr]]="", bakeOnOverrideLayer: bool=True, controlPoints: bool=False,
destinationLayer: AnyStr="", disableImplicitControl: bool=True, float:
Union[floatrange, List[floatrange]]=None, hierarchy: AnyStr="",
includeUpperBound: bool=True, index: Union[int, List[int]]=0,
minimizeRotation: bool=True, preserveOutsideKeys: bool=False,
removeBakedAnimFromLayer: bool=True, removeBakedAttributeFromLayer:
bool=True, resolveWithoutLayer: Union[AnyStr, List[AnyStr]]="", sampleBy:
time=None, shape: bool=True, simulation: bool=True, smart: List[bool,
float]=None, sparseAnimCurveBake: bool=False, time: Union[timerange,
List[timerange]]=None, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This command operates on a keyset A keyset is defined as a group of keys within a
specified time range on one or more animation curves The animation curves comprising a
keyset depend on the value of the "-animation" flag: keysOrObjects: Any active keys, when
no target objects or -attribute flags appear on the command line, or All animation curv
:param animation: (C) Where this command should get the animation to act on Valid values
are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Descrip
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param bakeOnOverrideLayer: (C) If true, all layered and baked attributes will be added as
a top override layer
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param destinationLayer: (C) This flag can be used to specify an existing layer where the
baked results should be stored
:param disableImplicitControl: (C) Whether to disable implicit control after the anim
curves are obtained as the result of this command An implicit control to an attribute is
some fun
:param float: (C M) value uniquely representing a non-time-based key (or key range) on a
time-based animCurve Valid floatRange include single values (-f 10) or a string
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param includeUpperBound: (C) When the -t/time or -f/float flags represent a range of keys,
this flag determines whether the keys at the upper bound of the range are included in t
:param index: (C M) index of a key on an animCurve In query mode, this flag needs a value
:param minimizeRotation: (C) Specify whether to minimize the local euler component from key
to key during baking of rotation channels
:param preserveOutsideKeys: (C) Whether to preserve keys that are outside the bake range
when there are directly connected animation curves The default (false) is to remove
frames
:param removeBakedAnimFromLayer: (C) If true, all baked animation will be removed from the
layer
:param removeBakedAttributeFromLayer: (C) If true, all baked attributes will be removed
from the layer
:param resolveWithoutLayer: (C M) This flag can be used to specify a list of layers to be
merged together during the bake process This is a multi-use flag Its name refers to the
fac
:param sampleBy: (C) Amount to sample by Default is 1.0 in current timeUnit
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:param simulation: (C) Using this flag instructs the command to preform a simulation
instead of just evaluating each attribute separately over the range of time The simula
:param smart: (C) Specify whether to enable smart bake and the optional smart bake
tolerance
:param sparseAnimCurveBake: (C) When baking anim curves, do not insert any keys into areas
of the curve where animation is defined And, use as few keys as possible to bake the pre
:param time: (C M) time uniquely representing a key (or key range) on a time-based
animCurve See the code examples below on how to format for a single frame or frame r
:returns:
"""
pass
def dR_selectInvert(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def prependListItem(*args, **kwargs)->None:
"""
"""
pass
def cameraSet(*args, active: bool=True, appendTo: bool=True, camera: Union[AnyStr, bool]="",
clearDepth: bool=True, deleteAll: bool=True, deleteLayer: bool=True, insertAt:
bool=True, layer: Union[int, bool]=0, name: Union[AnyStr, bool]="", numLayers:
bool=True, objectSet: Union[AnyStr, bool]="", order: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command manages camera set nodes Camera sets allow the users to break a single camera
shot into layers Instead of drawing all objects with a single camera, you can isolate the
camera to only focus on certain objects and layer another camera into the viewport that
draws the other objects The situation to use camera sets primarily occurs when
:param active: (C Q E) Gets / sets the active camera layer
:param appendTo: (C E) Append a new camera and/or object set to then end of the cameraSet
layer list This flag cannot be used in conjunction with insert flag Additionally
:param camera: (C Q E) Set/get the camera for a particular layer When in query mode, You
must specify the layer with the layer flag
:param clearDepth: (C Q E) Specifies if the drawing buffer should be cleared before
beginning the draw for that layer
:param deleteAll: (C E) Delete all camera layers
:param deleteLayer: (C E) Delete a layer from the camera set You must specify the layer
using the layer flag
:param insertAt: (C E) Inserts the specified camera and/or object set at the specified
layer This flag cannot be used in conjunction with the append flag Additionally, th
:param layer: (C Q E) Specifies the layer index to be used when accessing layer
information
:param name: (C Q) Gets or sets the name for the created camera set
:param numLayers: (C Q) Returns the number of layers defined in the specified cameraSet
:param objectSet: (C Q E) Set/get the objectSet for a particular layer When in query mode,
you must specify the layer with the layer flag
:param order: (C Q E) Set the order in which a particular layer is processed This flag
must be used in conjunction with the layer flag
:returns: The new cameraSet node (when in create mode)
"""
pass
def EditOversamplingForCacheSettings(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def unapplyOverride(*args, **kwargs)->None:
"""
"""
pass
def EnableRigidBodies(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def pickWalk(*args, direction: AnyStr="", recurse: bool=True, type: AnyStr="",
**kwargs)->List[AnyStr]:
"""
The pickWalk command allows you to quickly change the selection list relative to the nodes
that are currently selected It is called pickWalk, because it walks from one selection
list to another by unselecting what's currently selected, and selecting nodes that are in
the specified direction from the currently selected list If you specify objects
:param direction: (C) The direction to walk from the node The choices are up | down | left
| right | in | out up walks to the parent node, down to the child node, and le
:param recurse: (C) If specified then recurse down when walking
:param type: (C) The choices are nodes | instances | edgeloop | edgering | faceloop | keys
| latticepoints | motiontrailpoints If type is nodes, then the left and ri
:returns: A list of the newly selected items
"""
pass
def HypershadeMoveTabRight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BakeAllNonDefHistory(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySuperCtx(*args, **kwargs)->None:
"""
"""
pass
def SetBreakdownKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_softSelDistanceTypeObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportFinestSubdivLevel(*args, **kwargs)->None:
"""
"""
pass
def ShowDeformingGeometry(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ScaleToolMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportBakeComplexStart(*args, **kwargs)->None:
"""
"""
pass
def PrevSkinPaintMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def deformer(*args, after: bool=True, afterReference: bool=True, before: bool=True,
deformerTools: bool=True, exclusive: Union[AnyStr, bool]="", frontOfChain:
bool=True, geometry: Union[AnyStr, List[AnyStr], bool]="", geometryIndices:
bool=True, ignoreSelected: bool=True, includeHiddenSelections: bool=False, name:
AnyStr="", parallel: bool=True, prune: bool=True, remove: Union[bool,
List[bool]]=True, split: bool=True, type: AnyStr="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command creates a deformer of the specified type The deformer will deform the
selected objects
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param name: (C) Used to specify the name of the node being created
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:param type: (C) Specify the type of deformer to create This flag is required in create
mode Typically the type should specify a loaded plugin deformer This comman
:returns: Name of the algorithm node created/edited.
"""
pass
def polyExtrudeVertex(*args, caching: bool=True, constructionHistory: bool=True, divisions:
Union[int, bool]=1, length: Union[float, bool]=0, name: AnyStr="",
nodeState: Union[int, bool]=0, width: Union[float, bool]=0, worldSpace:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
Command that extrudes selected vertices outwards
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param divisions: (C Q E) This flag specifies the number of subdivisions C: Default is 1
Q: When queried, this flag returns an int
:param length: (C Q E) This flag specifies the length of the vertex extrusion C: Default
is 0 Q: When queried, this flag returns a float
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param width: (C Q E) This flag specifies the width of the vertex extrusion C: Default is
0 Q: When queried, this flag returns a float
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def ToggleUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PerspGraphHypergraphLayout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def scrollField(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, clear: bool=True,
command: AnyStr="", defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, editable: bool=True,
enable: bool=True, enableBackground: bool=True, enableKeyboardFocus: bool=True,
enterCommand: Script=None, exists: bool=True, font: Union[AnyStr, bool]="",
fontPointSize: Union[int, bool]=0, fullPathName: bool=True, height: Union[int,
bool]=0, highlightColor: Union[List[float, float, float], bool]=None,
insertText: AnyStr="", insertionPosition: Union[int, bool]=0, isObscured:
bool=True, keyPressCommand: Script=None, manage: bool=True, noBackground:
bool=True, numberOfLines: Union[int, bool]=0, numberOfPopupMenus: bool=True,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, qtFont: Union[AnyStr, bool]="", selection: bool=True,
statusBarMessage: AnyStr="", text: Union[AnyStr, bool]="", useTemplate:
AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script, bool]=None,
width: Union[int, bool]=0, wordWrap: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a scrolling field that handles multiple lines of text
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the value changes This command is
executed whenever the field loses focus
:param clear: (C E) Removes all text in the field
:param command: (C E) Obsolete - use "enterCommand" instead
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editable: (C Q E) The edit state of the field By default, this flag is set to true
and the field value may be changed by typing into it If false then the field is 'r
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param enterCommand: (C E) Command executed when the enter key is pressed This applies to
the enter key on the numeric keypad only
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param font: (C Q E) The font for the text Valid values are "boldLabelFont",
"smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont",
"oblique
:param fontPointSize: (C Q E) The font point size for the text
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param insertText: (C E) Insert text into the field at the current insertion position
(specified by the -ip/insertionPosition flag)
:param insertionPosition: (C Q E) The insertion position for inserted text This is a 1
based value where position 1 specifies the beginning of the field Position 0 may be used
to sp
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param keyPressCommand: (C E) Command executed when any key is pressed
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfLines: (Q) Number of lines in the scroll field
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param qtFont: (C Q E) The Qt font family for the text
:param selection: (Q) The selected text in the field An empty string is returned if there
is no selected text
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param text: (C Q E) The field text
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:param wordWrap: (C) Specify true to break lines at spaces, tabs, or newlines Text will
continue on the following line A value of false will not break text between word
:returns: Full path name to the control.
"""
pass
def shapeEditor(*args, clearSelection: bool=True, control: bool=True, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", exists: bool=True, filter: Union[AnyStr,
bool]="", forceMainConnection: Union[AnyStr, bool]="", highlightConnection:
Union[AnyStr, bool]="", lockMainConnection: bool=True, lowestSelection:
bool=True, mainListConnection: Union[AnyStr, bool]="", panel: Union[AnyStr,
bool]="", parent: Union[AnyStr, bool]="", selectionConnection: Union[AnyStr,
bool]="", stateString: bool=True, targetControlList: bool=True, targetList:
bool=True, unParent: bool=True, unlockMainConnection: bool=True,
updateMainConnection: bool=True, useTemplate: AnyStr="", verticalSliders:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command creates an editor that derives from the base editor class that has controls
for deformer, control nodes
:param clearSelection: (E) Clear the shape editor selection
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param lowestSelection: (Q) Query the lowest selection item
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param targetControlList: (Q) Query the target control list
:param targetList: (Q) Query the target list
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param verticalSliders: (C Q E) Should the sliders be vertical?
:returns: The name of the editor
"""
pass
def SplitEdgeRingTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def gameExporter(*args, **kwargs)->None:
"""
"""
pass
def ogs(*args, deviceInformation: bool=True, disposeReleasableTextures: bool=True, dumpTexture:
AnyStr="", enableHardwareInstancing: bool=True, fragmentEditor: AnyStr="", fragmentXML:
AnyStr="", gpuMemoryTotal: Union[int, bool]=0, gpuMemoryUsed: bool=True,
isLegacyViewportEnabled: bool=True, isWinRemoteSession: bool=True, pause: bool=True,
rebakeTextures: bool=True, regenerateUVTilePreview: AnyStr="", reloadTextures:
bool=True, reset: bool=True, shaderSource: Union[AnyStr, bool]="", toggleTexturePaging:
bool=True, traceRenderPipeline: bool=True, q=True, query=True, **kwargs)->Union[AnyStr,
Any]:
"""
OGS is one of the viewport renderers As there is a lot of effort involved in migrating
functionality it will evolve over several releases As it evolves it is prudent to provide
safeguards to get the database back to a known state That is the function of this command,
similar to how 'dgdirty' is used to restore state to the dependency graph
:param deviceInformation: (C) If used then output the current device information
:param disposeReleasableTextures: (C) Clear up all the releasable file textures in GPU
memory that are not required for rendering
:param dumpTexture: (C) If used then dump GPU texture memory usage info (in MB), must be
used with FLAG gpuMemoryUsed The final info detail is specified by the string param
:param enableHardwareInstancing: (C) Enables/disables new gpu instancing of instanceable
render items in OGS
:param fragmentEditor: (C) If used then launch the fragment editor UI
:param fragmentXML: (C) Get the fragment XML associated with a shading node
:param gpuMemoryTotal: (C Q) Get or set the total amount of GPU memory which Maya is
allowed to use (in MB)
:param gpuMemoryUsed: (C) If used then output the estimated amount of GPU memory in use (in
MB)
:param isLegacyViewportEnabled: (Q) To query if the legacy viewport is enabled
:param isWinRemoteSession: (Q) Query if this is a remote session
:param pause: (C Q) Toggle pausing VP2 display update
:param rebakeTextures: (C) If used then re-bake all baked textures for OGS
:param regenerateUVTilePreview: (C) If used then regenerate all UV tiles preview textures
for OGS
:param reloadTextures: (C) If used then reload all textures for OGS
:param reset: (C Q) If used then reset the entire OGS database for all viewports using it
In query mode the number of viewports that would be affected is returned but t
:param shaderSource: (Q) Get the shader source for the specified material
:param toggleTexturePaging: (C) If used then toggle the default OGS Texture paging
mechanism
:param traceRenderPipeline: (C) Enable debug tracing of the renderer pipeline
:returns: Result of the operation
"""
pass
def Fireworks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetHIKParentId(*args, **kwargs)->None:
"""
"""
pass
def ClearCurrentContainer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AssignOfflineFileFromRefEdOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def colorEditor(*args, alpha: Union[float, bool]=0.0, hsvValue: Union[List[float, float, float],
bool]=None, mini: bool=True, parent: AnyStr="", position: List[int, int]=None,
result: bool=True, rgbValue: Union[List[float, float, float], bool]=None,
q=True, query=True, **kwargs)->Union[AnyStr, Any]:
"""
The colorEditor command displays a modal dialog that may be used to specify colors in RGB
or HSV The default behaviour when no arguments are specified is to provide an initial
color of black (rgb 0.0 0.0 0.0) The command will return the user's color component
values along with a boolean to indicate whether the dialog was dismissed by pressing th
:param alpha: (C Q) Float values corresponding to the alpha transparency component, , which
ranges from 0.0 to 1.0 Use this flag to specify the initial alpha value of t
:param hsvValue: (C Q) Three float values corresponding to the hue, saturation, and value
color components, where the hue value ranges from 0.0 to 360.0 and the saturation
:param mini: (C) Enable the mini color editor mode
:param parent: (C) Specify the parent window for the dialog The dialog will be centered on
this window and raise and lower with it's parent By default, the dialog is
:param position: (C) Specify the window position for the dialog
:param result: (Q) This query only flag returns true if the dialog's "OK" button was
pressed, false otherwise If you query this flag immediately after showing the Colo
:param rgbValue: (C Q) Three float values corresponding to the red, green, and blue color
components, all of which range from 0.0 to 1.0 Use this flag to specify the initi
:returns: The string format is "float float float boolean". The first three
float values
correspond to the color components.
The final argument is 1 if the dialog's "OK" button
was pressed,
and 0 if the "Cancel" button was pressed.
"""
pass
def Snap3PointsTo3Points(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def repeatLast(*args, **kwargs)->None:
"""
"""
pass
def SelectObjectsIlluminatedByLight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def containerPublish(*args, bindNode: Union[List[AnyStr, AnyStr], bool]=None,
bindTemplateStandins: bool=True, inConnections: bool=True, mergeShared:
bool=True, outConnections: bool=True, publishNode: Union[List[AnyStr,
AnyStr], bool]=None, unbindNode: Union[AnyStr, bool]="", unpublishNode:
Union[AnyStr, bool]="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This is an accessory command to the container command which is used for some advanced
publishing operations on the container For example, the "publishConnections" flag on the
container will publish all the connections, but this command can be used to publish just
the inputs, outputs, or to collapse the shared inputs into a single attribute before
:param bindNode: (C Q E) Bind the specified node to the published node name
:param bindTemplateStandins: (C Q E) This flag will create a temporary stand-in attribute
for any attributes that exist in the template but are not already bound This enables you
to set
:param inConnections: (C) Specifies that the unpublished connections to nodes in the
container from external nodes should be published
:param mergeShared: (C) For use with the inConnections flag Indicates that when an
external attribute connects to multiple internal attributes within the container, a singl
:param outConnections: (C) Specifies that the unpublished connections from nodes in the
container to external nodes should be published
:param publishNode: (C Q E) Publish a name and type When first published, nothing will be
bound To bind a node to the published name, use the bindNode flag
:param unbindNode: (C Q E) Unbind the node that is published with the name specified by the
flag
:param unpublishNode: (C Q E) Unpublish the specified published node name
:returns:
"""
pass
def NodeEditorCreateTab(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolygonClearClipboard(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmDensityBrushToolCmd(*args, **kwargs)->None:
"""
"""
pass
def geometryDeleteCacheOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def agFormatIn(*args, **kwargs)->None:
"""
"""
pass
def ShotPlaylistEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetFullBodyIKKeysAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def geometryAppendCacheOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def renderLayerMembers(*args, **kwargs)->None:
"""
"""
pass
def SendToUnitySelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectNextIntermediatObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TwistOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def STRSTweakModeOff(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def rigidSolver(*args, autoTolerances: bool=True, bounciness: bool=True, cacheData: bool=True,
collide: bool=True, collisionTolerance: Union[float, bool]=0.02, contactData:
bool=True, create: bool=True, current: bool=True, deleteCache: bool=True,
displayCenterOfMass: bool=True, displayConstraint: bool=True, displayVelocity:
bool=True, dynamics: bool=True, friction: bool=True, interpenetrate: bool=True,
interpenetrationCheck: bool=True, name: Union[AnyStr, bool]="", rigidBodies:
bool=True, rigidBodyCount: bool=True, showCollision: bool=True,
showInterpenetration: bool=True, solverMethod: Union[int, bool]=2, startTime:
Union[float, bool]=0.0, state: bool=True, statistics: bool=True, stepSize:
Union[float, bool]=0.0333, velocityVectorScale: Union[float, bool]=0.0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This command sets the attributes for the rigid solver
:param autoTolerances: (Q E) Turns the auto tolerance calculation on and off The auto
tolerances calculation will override the default or user defined values of the step size
an
:param bounciness: (Q E) Turns bounciness on and off for the an the objects in the
simulation Default value: on
:param cacheData: (Q E) Turns the cache on fall all rigid bodies in the system Default
value: off
:param collide: (Q E) Disallows the interpenetration of the two rigid bodies listed
Default: Collide is on for all bodies
:param collisionTolerance: (Q E) Sets the collision tolerance This is the error at which
two objects are considered to have collided Range: 0.0005 - 1.000 Default: 0.02
:param contactData: (Q E) Turns the contact data information on/off for all rigid bodies
Default value: off
:param create: (C) Creates a new rigid solver
:param current: (C) Sets rigid solver as the current solver
:param deleteCache: (Q E) Deletes the cache for all rigid bodies in the system
:param displayCenterOfMass: (Q E) Displays the center of mass icon Default value: on
:param displayConstraint: (Q E) Displays the constraint vectors Default value: on
:param displayVelocity: (Q E) Displays the velocity vectors Default value: off
:param dynamics: (Q E) Turns dynamics on and off for the an the objects in the simulation
Default value: on
:param friction: (Q E) Turns friction on and off for the an the objects in the simulation
Default value: on
:param interpenetrate: (Q E) Allows the two rigid bodies listed to interpenetrate Default:
interpenetration is off for all bodies
:param interpenetrationCheck: (E) Checks for interpenetrating rigid bodies in the scene
:param name: (C Q E) Name of the new object
:param rigidBodies: (Q) Returns a list of rigid bodies in the solver
:param rigidBodyCount: (Q) Returns the number of rigid bodies in the solver
:param showCollision: (Q E) Displays the colliding objects in a different color
:param showInterpenetration: (Q E) Displays the interpenetrating objects in a different
color
:param solverMethod: (Q E) Sets the solver method The choices are 0 | 1 | 2 0 = Euler
(fastest/least acurate), 1 = Runge-Kutta ( slower/more acurate), 2 = adaptive Runge-Kutt
:param startTime: (C Q E) Sets the start time for the solver
:param state: (Q E) Turns the rigid solver on or off
:param statistics: (Q E) Turns the statistic information on/off for all rigid bodies
Default value: off
:param stepSize: (Q E) Sets the solvers step size This is the maximum size of a single
step the solver will take at one time Range: 0.0004 - 0.100 Default: 0.0333
:param velocityVectorScale: (Q E) scales the velocity vector display Default value: 1.0
:returns:
"""
pass
def ToggleVisibilityAndKeepSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PokePolygon(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def closeSurface(*args, blendBias: Union[float, bool]=0.5, blendKnotInsertion: bool=False,
caching: bool=True, direction: Union[int, bool]=0, nodeState: Union[int,
bool]=0, parameter: Union[float, bool]=0.1, preserveShape: Union[int, bool]=1,
constructionHistory: bool=True, name: AnyStr="", object: bool=True,
replaceOriginal: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The closeSurface command closes a surface in the U, V, or both directions, making it
periodic The close direction is controlled by the direction flag If a surface is not
specified in the command, then the first selected surface will be used The pathname to
the newly closed surface and the name of the resulting dependency node are returned Thi
:param blendBias: (C Q E) Skew the result toward the first or the second surface depending
on the blend value being smaller or larger than 0.5 Default: 0.5
:param blendKnotInsertion: (C Q E) If set to true, insert a knot in one of the original
surfaces (relative position given by the parameter attribute below) in order to produce a
slight
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param direction: (C Q E) The direction in which to close: 0 - U, 1 - V, 2 - Both U and V
Default: 0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param parameter: (C Q E) The parameter value for the positioning of the newly inserted
knot Default: 0.1
:param preserveShape: (C Q E) 0 - without preserving the shape 1 - preserve shape 2 - blend
Default: 1
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def ImportDeformerWeightsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_softSelToolTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Create3DContainerEmitter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def pushPinning(*args, **kwargs)->None:
"""
"""
pass
def CreatePassiveRigidBody(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TangentsLinear(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GoToNextDrivenKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def manipScaleLimitsCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Create a context for the scale limits manipulator
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Name of newly created context.
"""
pass
def polyMoveUV(*args, axisLen: Union[List[float, float], bool]=None, axisLenX: Union[float,
bool]=0.0, axisLenY: Union[float, bool]=0.0, caching: bool=True,
constructionHistory: bool=True, name: AnyStr="", nodeState: Union[int, bool]=0,
pivot: Union[List[float, float], bool]=None, pivotU: Union[float, bool]=0.0,
pivotV: Union[float, bool]=0.0, random: Union[float, bool]=0.0, rotationAngle:
Union[float, bool]=0.0, scale: Union[List[float, float], bool]=None, scaleU:
Union[float, bool]=0.0, scaleV: Union[float, bool]=0.0, translate:
Union[List[float, float], bool]=None, translateU: Union[float, bool]=0.0,
translateV: Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Moves selected UV coordinates in 2D space As the selected UVs are adjusted, the way the
image is mapped onto the object changes accordingly This command manipulates the UV values
without changing the 3D geometry of the object
:param axisLen: (C Q E) AxisLen vector, used to draw the manip handles Default: 1.0, 1.0
:param axisLenX: (C Q E) AxisLen X coord
:param axisLenY: (C Q E) AxisLen Y coord
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pivot: (C Q E) The pivot for scaling and rotation Default: 0.5, 0.5
:param pivotU: (C Q E) Pivot U coord
:param pivotV: (C Q E) Pivot V coord
:param random: (C Q E) Random value, added to all parameters Default: 0.0
:param rotationAngle: (C Q E) Angle of rotation Default: 0.0
:param scale: (C Q E) Scaling vector Default: 1.0, 1.0
:param scaleU: (C Q E) Scaling U coord
:param scaleV: (C Q E) Scaling V coord
:param translate: (C Q E) Translation vector Default: 0.0, 0.0
:param translateU: (C Q E) Translation U coord
:param translateV: (C Q E) Translation V coord
:returns: The node name.
"""
pass
def GpuCacheExportSelectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyDisplayReset(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ResetTemplateBrush(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SmokeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dynGlobals(*args, active: bool=True, listAll: bool=True, overSampling: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This node edits and queries the attributes of the active dynGlobals node in the scene
There can be only one active node of this type The active dynGlobals node is the first one
that was created, either with a "createNode" command or by accessing/editing any of the
attributes on the node through this command
:param active: (Q) This flag returns the name of the active dynGlobals node in the the
scene Only one dynGlobals node is active It is the first on created Any additi
:param listAll: (Q) This flag will list all of the dynGlobals nodes in the scene
:param overSampling: (Q E) This flag will set the current overSampling value for all of the
particle in the scene
:returns: For edit commands
"""
pass
def threadCount(*args, numberOfThreads: Union[int, bool]=0, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command sets the number of threads to be used by Maya in regions of code that are
multithreaded By default the number of threads is equal to the number of logical CPUs, not
the number of physical CPUs Logical CPUs are different from physical CPUs in the following
ways: A physical CPU with hyperthreading counts as two logical CPUs A dual-cor
:param numberOfThreads: (C Q) Sets the number of threads to use
:returns:
"""
pass
def CurveSmoothnessFine(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBIKReachKeyingOptionFK(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowMeshSprayToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportFileVersion(*args, **kwargs)->None:
"""
"""
pass
def PreviousViewArrangement(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteKeysOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectSharedUVInstances(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def snapMode(*args, curve: bool=True, distanceIncrement: Union[float, bool]=0.0, edgeMagnet:
Union[int, bool]=0, edgeMagnetTolerance: Union[float, bool]=0.0, grid: bool=True,
liveFaceCenter: bool=True, livePoint: bool=True, meshCenter: bool=True,
pixelCenter: bool=True, pixelSnap: bool=True, point: bool=True, tolerance:
Union[int, bool]=0, useTolerance: bool=True, uvTolerance: Union[int, bool]=0,
viewPlane: bool=True, q=True, query=True, **kwargs)->Union[bool, Any]:
"""
The snapMode command is used to control snapping It toggles the snapping modes in effect
and sets information used for snapping
:param curve: (C Q) Set curve snap mode
:param distanceIncrement: (C Q) Set the distance for the snapping to objects such as a
lines or planes
:param edgeMagnet: (C Q) Number of extra magnets to snap onto, regularly spaced along the
edge
:param edgeMagnetTolerance: (C Q) Precision for edge magnet snapping
:param grid: (C Q) Set grid snap mode
:param liveFaceCenter: (C Q) While moving on live polygon objects, snap to its face
centers
:param livePoint: (C Q) While moving on live polygon objects, snap to its vertices
:param meshCenter: (C Q) While moving, snap on the center of the mesh that intersect the
line from the camera to the cursor
:param pixelCenter: (C Q) Snap UV to the center of the pixel instead of the corner
:param pixelSnap: (C Q) Snap UVs to the nearest pixel center or corner
:param point: (C Q) Set point snap mode
:param tolerance: (C Q) Tolerance defines the size of the square region in which points
must lie in order to be snapped to The tolerance value is the distance from the curs
:param useTolerance: (C Q) If useTolerance is set, then point snapping is limited to points
that are within a square region surrounding the cursor position The size of the squ
:param uvTolerance: (C Q) uvTolerance defines the size of the square region in which points
must lie in order to be snapped to, in the UV Editor The tolerance value is the di
:param viewPlane: (C Q) Set view-plane snap mode
:returns: if command is a query
"""
pass
def SelectEdgeLoopSp(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ObjectCentricLightLinkingEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def textFieldGrp(*args, adjustableColumn: int=0, adjustableColumn2: int=0, adjustableColumn3:
int=0, adjustableColumn4: int=0, adjustableColumn5: int=0, adjustableColumn6:
int=0, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, columnAlign:
Union[List[int, AnyStr], List[List[int, AnyStr]]]=None, columnAlign2:
List[AnyStr, AnyStr]=None, columnAlign3: List[AnyStr, AnyStr, AnyStr]=None,
columnAlign4: List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign5:
List[AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAlign6: List[AnyStr,
AnyStr, AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach: Union[List[int,
AnyStr, int], List[List[int, AnyStr, int]]]=None, columnAttach2: List[AnyStr,
AnyStr]=None, columnAttach3: List[AnyStr, AnyStr, AnyStr]=None, columnAttach4:
List[AnyStr, AnyStr, AnyStr, AnyStr]=None, columnAttach5: List[AnyStr, AnyStr,
AnyStr, AnyStr, AnyStr]=None, columnAttach6: List[AnyStr, AnyStr, AnyStr,
AnyStr, AnyStr, AnyStr]=None, columnOffset2: List[int, int]=None,
columnOffset3: List[int, int, int]=None, columnOffset4: List[int, int, int,
int]=None, columnOffset5: List[int, int, int, int, int]=None, columnOffset6:
List[int, int, int, int, int, int]=None, columnWidth: Union[List[int, int],
List[List[int, int]]]=None, columnWidth1: int=0, columnWidth2: List[int,
int]=None, columnWidth3: List[int, int, int]=None, columnWidth4: List[int, int,
int, int]=None, columnWidth5: List[int, int, int, int, int]=None,
columnWidth6: List[int, int, int, int, int, int]=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dropCallback: Script=None, editable: bool=True, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fileName: Union[AnyStr, bool]="", forceChangeCommand: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float, float,
float], bool]=None, insertText: AnyStr="", insertionPosition: Union[int,
bool]=0, isObscured: bool=True, label: Union[AnyStr, bool]="", manage:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", placeholderText: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, rowAttach:
Union[List[int, AnyStr, int], List[List[int, AnyStr, int]]]=None,
statusBarMessage: AnyStr="", text: Union[AnyStr, bool]="", textChangedCommand:
Script=None, useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
All of the group commands position their individual controls in columns starting at column
1 The layout of each control (ie column) can be customized using the -cw/columnWidth,
-co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags By
default, columns are left aligned with no offset and are 100 pixels wide Only o
:param adjustableColumn: (C E) Specifies which column has an adjustable size that changes
with the sizing of the layout The column value is a 1-based index Passing 0 as argument
:param adjustableColumn2: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly two columns
:param adjustableColumn3: (C E) Specifies that the column has an adjustable size that
changes with the size of the parent layout Ignored if there are not exactly three columns
:param adjustableColumn4: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly four columns
:param adjustableColumn5: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly five columns
:param adjustableColumn6: (C E) Specifies which column has an adjustable size that changes
with the size of the parent layout Ignored if there are not exactly six columns
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the field text changes and user presses
Enter or Return
:param columnAlign: (C E M) Arguments are : column number, alignment type Possible
alignments are: left | right | center Specifies alignment type for the specified column
:param columnAlign2: (C E) Sets the text alignment of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "center"
:param columnAlign3: (C E) Sets the text alignment for all three columns Ignored if there
are not exactly three columns Valid values are "left", "right", and "center"
:param columnAlign4: (C E) Sets the text alignment for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "center"
:param columnAlign5: (C E) Sets the text alignment for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "center"
:param columnAlign6: (C E) Sets the text alignment for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "center"
:param columnAttach: (C E M) Arguments are : column number, attachment type, and offset
Possible attachments are: left | right | both Specifies column attachment types and offe
:param columnAttach2: (C E) Sets the attachment type of both columns Ignored if there are
not exactly two columns Valid values are "left", "right", and "both"
:param columnAttach3: (C E) Sets the attachment type for all three columns Ignored if
there are not exactly three columns Valid values are "left", "right", and "both"
:param columnAttach4: (C E) Sets the attachment type for all four columns Ignored if there
are not exactly four columns Valid values are "left", "right", and "both"
:param columnAttach5: (C E) Sets the attachment type for all five columns Ignored if there
are not exactly five columns Valid values are "left", "right", and "both"
:param columnAttach6: (C E) Sets the attachment type for all six columns Ignored if there
are not exactly six columns Valid values are "left", "right", and "both"
:param columnOffset2: (C E) This flag is used in conjunction with the -columnAttach2 flag
If that flag is not used then this flag will be ignored It sets the offset for the tw
:param columnOffset3: (C E) This flag is used in conjunction with the -columnAttach3 flag
If that flag is not used then this flag will be ignored It sets the offset for the th
:param columnOffset4: (C E) This flag is used in conjunction with the -columnAttach4 flag
If that flag is not used then this flag will be ignored It sets the offset for the fo
:param columnOffset5: (C E) This flag is used in conjunction with the -columnAttach5 flag
If that flag is not used then this flag will be ignored It sets the offset for the fi
:param columnOffset6: (C E) This flag is used in conjunction with the -columnAttach6 flag
If that flag is not used then this flag will be ignored It sets the offset for the si
:param columnWidth: (C E M) Arguments are : column number, column width Sets the width of
the specified column where the first parameter specifies the column (1 based index) an
:param columnWidth1: (C E) Sets the width of the first column Ignored if there is not
exactly one column
:param columnWidth2: (C E) Sets the column widths of both columns Ignored if there are not
exactly two columns
:param columnWidth3: (C E) Sets the column widths for all 3 columns Ignored if there are
not exactly 3 columns
:param columnWidth4: (C E) Sets the column widths for all 4 columns Ignored if there are
not exactly 4 columns
:param columnWidth5: (C E) Sets the column widths for all 5 columns Ignored if there are
not exactly 5 columns
:param columnWidth6: (C E) Sets the column widths for all 6 columns Ignored if there are
not exactly 6 columns
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editable: (C Q E) The edit state of the field By default, this flag is set to true
and the field value may be changed by typing into it If false then the field is 'r
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fileName: (C Q E) Text in the field as a filename This does conversions between
internal and external (UI) file representation
:param forceChangeCommand: (C E) If used together with -text or -inserText flag, change
command will be executed after text modification
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param insertText: (C E) Insert text into the field at the current insertion position
(specified by the -ip/insertionPosition flag)
:param insertionPosition: (C Q E) The insertion position for inserted text This is a 1
based value where position 1 specifies the beginning of the field Position 0 may be used
to sp
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) Label text for the group
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param placeholderText: (C Q E) Setting this property makes the line edit display a
grayed-out placeholder text as long as the text field is empty and the widget doesn't have
focus
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowAttach: (C E M) Arguments are : column, attachment type, offset Possible
attachments are: top | bottom | both Specifies attachment types and offsets for the
entire
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param text: (C Q E) Text in the field
:param textChangedCommand: (C E) Command executed immediately when the field text changes
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def SculptReferenceVectorMarkingMenuPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def clip(*args, absolute: bool=True, absoluteRotations: bool=True, active: Union[AnyStr,
bool]="", addTrack: bool=True, allAbsolute: bool=True, allClips: bool=True,
allRelative: bool=True, allSourceClips: bool=True, animCurveRange: bool=True,
character: bool=True, constraint: bool=True, copy: bool=True, defaultAbsolute:
bool=True, duplicate: bool=True, endTime: Union[time, bool]=None, expression:
bool=True, ignoreSubcharacters: bool=True, isolate: bool=True, leaveOriginal:
bool=True, mapMethod: AnyStr="", name: Union[AnyStr, List[AnyStr], bool]="", newName:
AnyStr="", paste: bool=True, pasteInstance: bool=True, remove: bool=True, removeTrack:
bool=True, rotationOffset: Union[List[float, float, float], bool]=None,
rotationsAbsolute: bool=True, scheduleClip: bool=True, sourceClipName: bool=True,
split: time=None, startTime: Union[time, bool]=None, translationOffset:
Union[List[float, float, float], bool]=None, useChannel: Union[AnyStr,
List[AnyStr]]="", q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr],
Any]:
"""
This command is used to create, edit and query character clips
:param absolute: (C) This flag is now deprecated Use aa/allAbsolute, ar/allRelative,
ra/rotationsAbsolute, or da/defaultAbsolute instead This flag controls whether the
:param absoluteRotations: (C) This flag is now deprecated Use aa/allAbsolute,
ar/allRelative, ra/rotationsAbsolute, or da/defaultAbsolute instead If true, this
overrides the -ab
:param active: (Q E) Query or edit the active clip This flag is not valid in create mode
Making a clip active causes its animCurves to be hooked directly to the charact
:param addTrack: () This flag is now obsolete Use the insertTrack flag on the clipSchedule
command instead
:param allAbsolute: (C) Set all channels to be calculated with absolute offsets This flag
cannot be used in conjunction with the ar/allRelative, ra/rotationsAbsolute or da/
:param allClips: (Q) This flag is used to query all the clips in the scene Nodes of type
"animClip" that are storing poses, are not returned by this command
:param allRelative: (C) Set all channels to be calculated with relative offsets This flag
cannot be used in conjunction with the aa/allAbsolute, ra/rotationsAbsolute or da/
:param allSourceClips: (Q) This flag is used to query all the source clips in the scene
Nodes of type "animClip" that are storing poses or clip instances, are not returned by
:param animCurveRange: (C) This flag can be used at the time you create the clip instead of
the startTime and endTime flags It specifies that you want the range of the clip to
:param character: (Q) This is a query only flag which operates on the specified clip It
returns the names of any characters that a clip is associated with
:param constraint: (C) This creates a clip out of any constraints on the character The
constraint will be moved off of the character and into the clip, so that it is only
:param copy: (C Q) This flag is used to copy a clip or clips to the clipboard It should be
used in conjunction with the name flag to copy the named clips on the specif
:param defaultAbsolute: (C) Sets all top-level channels except rotations in the clip to
relative, and the remaining channels to absolute This is the default during clip creatio
:param duplicate: (Q) Duplicate the clip specified by the name flag The start time of the
new clip should be specified with the startTime flag
:param endTime: (C Q E) Specify the clip end
:param expression: (C) This creates a clip out of any expressions on the character The
expression will be moved off of the character and into the clip, so that it is only
:param ignoreSubcharacters: (C) During clip creation, duplication and isolation,
subcharacters are included by default If you want to create a clip on the top level
character only,
:param isolate: (C) This flag should be used in conjunction with the name flag to specify
that a clip or clips should be copied to a new clip library The most common us
:param leaveOriginal: (C) This flag is used when creating a clip to specify that the
animation curves should be copied to the clip library, and left on the character
:param mapMethod: (C) This is is valid with the paste and pasteInstance flags only It
specifies how the mapping should be done Valid options are: "byNodeName", "byAttrNa
:param name: (C Q M) In create mode, specify the clip name In query mode, return a list of
all the clips In duplicate mode, specify the clip to be duplicated In copy m
:param newName: (C) Rename a clip Must be used in conjunction with the clip name flag,
which is used to specify the clip to be renamed
:param paste: (C) This flag is used to paste a clip or clips from the clipboard to a
character Clips are added to the clipboard using the c/copy flag
:param pasteInstance: (C) This flag is used to paste an instance of a clip or clips from
the clipboard to a character Unlike the p/paste flag, which duplicates the animCurves
:param remove: (Q) Remove the clip specified by the name flag The clip will be permanently
removed from the library and deleted from any times where it has been schedu
:param removeTrack: (C) This flag is now obsolete Use removeTrack flag on the clipSchedule
command instead
:param rotationOffset: (C Q) Return the channel offsets used to modify the clip's rotation
:param rotationsAbsolute: (C) Set all channels except rotations to be calculated with
relative offsets Rotation channels will be calculated with absolute offsets This flag
canno
:param scheduleClip: (C) This flag is used when creating a clip to specify whether or not
the clip should immediately be scheduled at the current time If the clip is not sch
:param sourceClipName: (Q) This flag is for query only It returns the name of the source
clip that controls an instanced clip
:param split: (C E) Split an existing clip into two clips The split occurs around the
specified time
:param startTime: (C Q E) Specify the clip start
:param translationOffset: (C Q) Return the channel offsets used to modify the clip's
translation
:param useChannel: (C M) Specify which channels should be acted on This flag is valid only
in conjunction with clip creation, and the isolate flag The specified channels mu
:returns: clip names
"""
pass
def DecreaseExposureFine(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def curveSketchCtx(*args, degree: Union[int, bool]=0, exists: bool=True, history: bool=True,
image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", name: AnyStr="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The curveSketchCtx command creates a new curve sketch context, also known as the "pencil
context"
:param degree: (C Q E) Valid values are 1 or 3
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: (name of the new curve sketch context)
"""
pass
def MakeLightLinks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportFillTimeline(*args, **kwargs)->None:
"""
"""
pass
def EnableNParticles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintGeomCacheTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def userCtx(*args, **kwargs)->None:
"""
"""
pass
def saveMenu(*args, **kwargs)->AnyStr:
"""
This command is used for saving the contents of a menu, so that another instance of the
menu may be recreated later The command writes out a file which, when run as a script,
will rebuild the menuItems contained in the original menu Note that the fileName is
relative to the user's marking menu preference directory Note that this command is used
:returns: The name of the saved file.
"""
pass
def listDeviceAttachments(*args, attribute: AnyStr="", axis: AnyStr="", clutch: AnyStr="",
device: AnyStr="", file: AnyStr="", selection: bool=True, write:
bool=True, **kwargs)->AnyStr:
"""
This command lists the current set of device attachments The listing is in the form of the
commands required to recreate them This includes both attachments and device mappings
:param attribute: (C) specify the attribute attachments to list
:param axis: (C) specify the axis attachments to list
:param clutch: (C) List only attachment clutched with this button
:param device: (C) specify which device attachments to list
:param file: (C) Specify the name of the file to write out device attachments
:param selection: (C) This flag list only attachments on selection
:param write: (C) Write out device attachments to a file specified by the -f flag, is set
If -f is not set, it'll write out to a file named for the device
:returns: Command result
"""
pass
def panZoom(*args, absolute: bool=True, downDistance: float=0.0, leftDistance: float=0.0,
relative: bool=True, rightDistance: float=0.0, upDistance: float=0.0, zoomRatio:
float=0.0, **kwargs)->None:
"""
The panZoom command pans/zooms the 2D film The panZoom command can be applied to either a
perspective or an orthographic camera When no camera name is supplied, this command is
applied to the camera in the active view
:param absolute: (C) This flag modifies the behavior of the distance and zoomRatio flags
If specified, the distance and zoomRatio value will be applied directly
:param downDistance: (C) Set the amount of down pan distance in inches
:param leftDistance: (C) Set the amount of left pan distance in inches
:param relative: (C) This flag modifies the behavior of the distance and zoomRatio flags
If specified, the distance or zoomRatio value is used multiply the camera's exis
:param rightDistance: (C) Set the amount of right pan distance in inches
:param upDistance: (C) Set the amount of up pan distance in inches
:param zoomRatio: (C) Set the amount of zoom ratio
:returns:
"""
pass
def webView(*args, urlAddress: AnyStr="", windowHeight: int=0, windowWidth: int=0,
**kwargs)->None:
"""
This command allows the user to bring up a web page view
:param urlAddress: (C) Bring up webView on given URL
:param windowHeight: (C) Set the window height
:param windowWidth: (C) Set the window width
:returns:
"""
pass
def DeleteAllNCloths(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GoToDefaultView(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmNoiseBrushContext(*args, **kwargs)->None:
"""
"""
pass
def ScaleToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ctxData(*args, **kwargs)->None:
"""
"""
pass
def HIKUiControl(*args, **kwargs)->None:
"""
"""
pass
def jointCtx(*args, autoJointOrient: Union[AnyStr, bool]="xyz", autoPriorityH: bool=True,
createIKHandle: bool=True, degreeOfFreedomJ: Union[AnyStr, bool]="xyz", exists:
bool=True, forceSolverH: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", jointAutoLimits: bool=True,
jointOrientationJ: Union[List[float, float, float], bool]=None, largeBoneLength:
Union[float, bool]=0.0, largeBoneRadius: Union[float, bool]=0.0, poWeightH:
Union[float, bool]=1, priorityH: Union[int, bool]=0, scaleCompensateJ: bool=True,
scaleJ: Union[List[float, float, float], bool]=None, scaleOrientationJ:
Union[List[float, float, float], bool]=None, secondaryAxisOrient: Union[AnyStr,
bool]="", smallBoneLength: Union[float, bool]=0.0, smallBoneRadius: Union[float,
bool]=0.0, snapHandleH: bool=True, solverTypeH: Union[AnyStr, bool]="", stickyH:
Union[AnyStr, bool]="off", symmetry: bool=True, symmetryAxis: Union[AnyStr,
bool]="", variableBoneSize: bool=True, weightH: Union[float, bool]=1, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The joint context command (jointCtx) updates the parameters of the joint tool The options
for the tool will be set by the flags the user specifies
:param autoJointOrient: (C Q E) Specifies the joint orientation Valid string choices are
permutations of the axes; "none", "xyz", "yzx", "zxy", "xzy", "yxz", "zyx" The first
lette
:param autoPriorityH: (C Q E) Specifies if the ikHandle's priority is assigned
automatically C: The default is off Q: When queried, this flag returns an int
:param createIKHandle: (C Q E) Enables the joint tool to create an ikHandle when the tool
is completed C: The default is off Q: When queried, this flag returns an int
:param degreeOfFreedomJ: (C Q E) Specifies the degrees of freedom for all of the joints
created by the tool Valid string choices are the free axes; "x", "y", "z", "xy", "xz",
"yz",
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param forceSolverH: (C Q E) Specifies if the ikSolver for the ikHandle is enabled C: The
default is on Q: When queried, this flag returns an int
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param jointAutoLimits: (C Q E) Automatically computes the joint limits based on the kind
of joint created C: The default is off Q: When queried, this flag returns an int
:param jointOrientationJ: (C Q E) Sets the orientation of the joints created by the tool
If autoJointOrient in on, these values will be ignored C: The default is 0 0 0 Q: When
quer
:param largeBoneLength: (C Q E) Specifies the length above which bones should be assigned
the largeBoneRadius
:param largeBoneRadius: (C Q E) Specifies the radius for bones whose length is above the
largeBoneLength
:param poWeightH: (C Q E) Specifies the position/orientation weight of the ikHandle C: The
default is 1 Q: When queried, this flag returns a float
:param priorityH: (C Q E) Specifies the priority of the ikHandle C: The default is on Q:
When queried, this flag returns an int
:param scaleCompensateJ: (C Q E) Specifies if scale compensate is enabled C: The default
is on Q: When queried, this flag returns an int
:param scaleJ: (C Q E) Sets the scale for the joints created by the tool C: The default is
1 1 1 Q: When queried, this flag returns an array of three floats
:param scaleOrientationJ: (C Q E) Sets the current value for the scale orientation If
autoJointOrient in on, these values will be ignored C: The default is 0 0 0 Q: When
queried, t
:param secondaryAxisOrient: (C Q E) Specifies the orientation of the secondary rotate axis
Valid string choices are: "xup", "xdown", "yup", "ydown", "zup", "zdown", "none"
:param smallBoneLength: (C Q E) Specifies the length below which bones should be assigned
the smallBoneRadius
:param smallBoneRadius: (C Q E) Specifies the radius for bones whose length is below the
smallBoneLength
:param snapHandleH: (C Q E) Sepcifies if snapping is enabled for the ikHandle C: The
default is on Q: When queried, this flag returns an int
:param solverTypeH: (C Q E) Sets the name of the solver to use with the ikHandle C: The
default is the solver set to the default in the user preferences Q: When queried, this
:param stickyH: (C Q E) Specifies if the ikHandle is sticky or not If "sticky" is passed
then the ikHandle will be sticky If "off" is used then ikHandle stickiness will be
:param symmetry: (C Q E) Automaticaly create a symmetry joint based if symmetry is on C:
The default is off Q: When queried, this flag returns an int
:param symmetryAxis: (C Q E) Automaticaly create a symmetry joint use x, y , z axis or
combination to do the symmetry C: The default is x Q: When queried, this flag returns a
s
:param variableBoneSize: (C Q E) Specifies whether or not variable bone length and radius
settings should be used
:param weightH: (C Q E) Specifies the weight of the ikHandle The weight is relative to the
other ikHandles in the scene C: The default is 1 Q: When queried, this flag ret
:returns: The name of the context.
"""
pass
def HypershadeExportSelectedNetwork(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonType(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def instance(*args, leaf: bool=True, name: AnyStr="", smartTransform: bool=True,
**kwargs)->AnyStr:
"""
Instancing is a way of making the same object appear twice in the scene This is
accomplished by creation of a new transform node that points to an exisiting object
Changes to the transform are independent but changes to the "instanced" object affect all
instances since the node is shared If no objects are given, then the selected list is
instan
:param leaf: (C) Instances leaf-level objects Acts like duplicate except leaf-level
objects are instanced
:param name: (C) Name to give new instance
:param smartTransform: (C) Transforms instances item based on movements between transforms
:returns: - the name of the new transform node is returned.
"""
pass
def dR_scaleRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def editImportedStatus(*args, **kwargs)->None:
"""
"""
pass
def nurbsPlane(*args, axis: Union[List[float, float, float], bool]=None, caching: bool=True,
degree: Union[int, bool]=3, lengthRatio: Union[float, bool]=1.0, nodeState:
Union[int, bool]=0, patchesU: Union[int, bool]=1, patchesV: Union[int, bool]=1,
pivot: Union[List[float, float, float], bool]=None, width: Union[float,
bool]=1.0, constructionHistory: bool=True, name: AnyStr="", object: bool=True,
polygon: int=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The nurbsPlane command creates a new NURBS Plane and return the name of the new surface It
creates an unit plane with center at origin by default
:param axis: (C Q E) The primitive's axis
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param degree: (C Q E) The degree of the resulting surface 1 - linear, 2 - quadratic, 3 -
cubic, 5 - quintic, 7 - heptic Default: 3
:param lengthRatio: (C Q E) The ratio of "length" to "width" of the plane Default: 1.0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param patchesU: (C Q E) The number of spans in the U direction Default: 1
:param patchesV: (C Q E) The number of spans in the V direction Default: 1
:param pivot: (C Q E) The primitive's pivot point
:param width: (C Q E) The width of the plane Default: 1.0
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:returns: Object name and node name
"""
pass
def dR_softSelDistanceTypeSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmNullRender(*args, **kwargs)->None:
"""
"""
pass
def igBrush(*args, **kwargs)->None:
"""
"""
pass
def retimeHelper(*args, **kwargs)->None:
"""
"""
pass
def xgmRebuildCurve(*args, **kwargs)->None:
"""
"""
pass
def FluidEmitter(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OutlinerToggleSetMembers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshFlattenTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def unloadPlugin(*args, addCallback: Script=None, force: bool=True, removeCallback: Script=None,
**kwargs)->List[AnyStr]:
"""
Unload plug-ins from Maya After the successful execution of this command, plug-in services
will no longer be available
:param addCallback: (C) Add a procedure to be called just before a plugin is unloaded The
procedure should have one string argument, which will be the plugin's name
:param force: (C) Unload the plugin even if it is providing services This is not
recommended If you unload a plug-in that implements a node or data type in the scene
:param removeCallback: (C) Remove a procedure which was previously added with -addCallback
:returns: the internal names of the successfully unloaded plug-ins
"""
pass
def snapKey(*args, animation: AnyStr="keysOrObjects.", attribute: Union[AnyStr,
List[AnyStr]]="", controlPoints: bool=False, float: Union[floatrange,
List[floatrange]]=None, hierarchy: AnyStr="", includeUpperBound: bool=True, index:
Union[int, List[int]]=0, shape: bool=True, time: Union[timerange,
List[timerange]]=None, timeMultiple: float=0.0, valueMultiple: float=0.0,
**kwargs)->int:
"""
This command operates on a keyset A keyset is defined as a group of keys within a
specified time range on one or more animation curves The animation curves comprising a
keyset depend on the value of the "-animation" flag: keysOrObjects: Any active keys, when
no target objects or -attribute flags appear on the command line, or All animation curv
:param animation: (C) Where this command should get the animation to act on Valid values
are "objects," "keys," and "keysOrObjects" Default: "keysOrObjects." (See Descrip
:param attribute: (C M) List of attributes to select In query mode, this flag needs a
value
:param controlPoints: (C) This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes Default: false (No
:param float: (C M) value uniquely representing a non-time-based key (or key range) on a
time-based animCurve Valid floatRange include single values (-f 10) or a string
:param hierarchy: (C) Hierarchy expansion options Valid values are "above," "below," "both,
" and "none." (Not valid for "pasteKey" cmd.) In query mode, this flag needs a
:param includeUpperBound: (C) When the -t/time or -f/float flags represent a range of keys,
this flag determines whether the keys at the upper bound of the range are included in t
:param index: (C M) index of a key on an animCurve In query mode, this flag needs a value
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true (Not valid for "pasteKey" cmd.) In query mode, this fl
:param time: (C M) time uniquely representing a key (or key range) on a time-based
animCurve See the code examples below on how to format for a single frame or frame r
:param timeMultiple: (C) If this flag is present, key times will be snapped to a multiple
of the specified float value
:param valueMultiple: (C) If this flag is present, key values will be snapped to a multiple
of the specified float value
:returns: Number of animation curves
with keys that were not snapped because of
time-snapping
conflicts.
"""
pass
def SculptSurfacesTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def controller(*args, allControllers: bool=True, children: bool=True, group: bool=True, index:
Union[int, bool]=0, isController: Union[AnyStr, bool]="", parent: bool=True,
pickWalkDown: bool=True, pickWalkLeft: bool=True, pickWalkRight: bool=True,
pickWalkUp: bool=True, unparent: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Commands for managing animation sources
:param allControllers: (C Q E) When this flag is queried, returns all dependNode attached
to a controller in the scene
:param children: (Q E) Return true if the specified dependNode is a controller
:param group: (C Q E) Create a controller that is not associated with any object This new
controller will be the parent of all the selected objects
:param index: (Q E) In query mode, returns the index of the controller in the parent
controller's list of children In edit mode, reorder the parent controller's childre
:param isController: (C Q E) Returns true if the specified dependNode is a controller
:param parent: (C Q E) Set or query the parent controller of the selected controller node
:param pickWalkDown: (Q E) Return the first child
:param pickWalkLeft: (Q E) Return the previous sibling
:param pickWalkRight: (Q E) Return the next sibling
:param pickWalkUp: (Q E) Return the parent
:param unparent: (Q E) Unparent all selected controller objects from their respective
parent
:returns: Command result
"""
pass
def ThreePointArcTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UniversalManipOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dagObjectCompare(*args, attribute: bool=True, bail: AnyStr="", connection: bool=True,
namespace: AnyStr="", relative: bool=True, short: bool=True, type:
bool=True, **kwargs)->None:
"""
dagObjectCompare can be used to compare to compare objects based on: type - Currently
supports transform nodes and shape nodes relatives - Compares DAG objects' children and
parents connections - Checks to make sure the two dags are connected to the same sources
and destinations attributes - Checks to make sure that the properties of active attrib
:param attribute: (C) Compare dag object attributes
:param bail: (C) Bail on first error or bail on category Legal values are "never", "first",
and "category"
:param connection: (C) Compare dag connections
:param namespace: (C) The baseline namespace
:param relative: (C) dag relatives
:param short: (C) Compress output to short form (not as verbose)
:param type: (C) Compare based on dag object type
:returns:
"""
pass
def pluginInfo(*args, activeFile: bool=True, animCurveInterp: Union[AnyStr, bool]="",
apiVersion: bool=True, autoload: bool=True, cacheFormat: bool=True,
changedCommand: Script=None, command: Union[AnyStr, List[AnyStr], bool]="",
constraintCommand: bool=True, controlCommand: bool=True, data: Union[List[AnyStr,
AnyStr], List[List[AnyStr, AnyStr]], bool]=None, dependNode: Union[bool,
List[bool]]=True, dependNodeByType: Union[AnyStr, bool]="", dependNodeId:
Union[AnyStr, bool]="", device: bool=True, dragAndDropBehavior: bool=True,
iksolver: bool=True, listPlugins: bool=True, listPluginsPath: bool=True,
loadPluginPrefs: bool=True, loaded: bool=True, modelEditorCommand: bool=True,
name: Union[AnyStr, bool]="", path: Union[AnyStr, bool]="", pluginsInUse:
bool=True, referenceTranslators: bool=True, registered: bool=True, remove:
bool=True, renderer: bool=True, savePluginPrefs: bool=True, serviceDescriptions:
bool=True, settings: bool=True, tool: Union[AnyStr, List[AnyStr], bool]="",
translator: bool=True, unloadOk: bool=True, userNamed: bool=True, vendor:
Union[AnyStr, bool]="", version: bool=True, writeRequires: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[Any, Any]:
"""
This command provides access to the plug-in registry of the application It is used mainly
to query the characteristics of registered plug-ins Plugins automatically become
registered the first time that they are loaded The argument is either the internal name
of the plug-in or the path to access it
:param activeFile: (Q) Restricts the command to the active file only, not the entire scene
This only affects the dependNode/dn and pluginsInUse/pu flags For use during ex
:param animCurveInterp: (Q) Returns a string array containing the names of all of the
animation curve interpolators registered by this plug-in
:param apiVersion: (Q) Returns a string containing the version of the API that this plug-in
was compiled with See the comments in MTypes.h for the details on how to interp
:param autoload: (C Q E) Sets whether or not this plug-in should be loaded every time the
application starts up Returns a boolean in query mode
:param cacheFormat: (Q) Returns a string array containing the names of all of the
registered geometry cache formats
:param changedCommand: (C) Adds a callback that will get executed every time the plug-in
registry changes Any other previously registered callbacks will also get called
:param command: (Q M) Returns a string array containing the names of all of the normal
commands registered by this plug-in Constraint, control, context and model editor c
:param constraintCommand: (Q) Returns a string array containing the names of all of the
constraint commands registered by this plug-in
:param controlCommand: (Q) Returns a string array containing the names of all of the
control commands registered by this plug-in
:param data: (Q M) Returns a string array containing the names of all of the data types
registered by this plug-in
:param dependNode: (Q M) Returns a string array containing the names of all of the custom
nodes types registered by this plug-in
:param dependNodeByType: (Q) Returns a string array of all registered node types within a
specified class of nodes Each custom node type registered by a plug-in belongs to a mor
:param dependNodeId: (Q) Returns an integer array containing the ids of all of the custom
node types registered by this plug-in
:param device: (Q) Returns a string array containing the names of all of the devices
registered by this plug-in
:param dragAndDropBehavior: (Q) Returns a string array containing the names of all of the
drag and drop behaviors registered by this plug-in
:param iksolver: (Q) Returns a string array containing the names of all of the ik solvers
registered by this plug-in
:param listPlugins: (Q) Returns a string array containing all the plug-ins that are
currently loaded
:param listPluginsPath: (Q) Returns a string array containing the full paths of all the
plug-ins that are currently loaded
:param loadPluginPrefs: (C) Loads the plug-in preferences (ie autoload) from
pluginPrefs.mel into Maya
:param loaded: (Q) Returns a boolean specifying whether or not the plug-in is loaded
:param modelEditorCommand: (Q) Returns a string array containing the names of all of the
model editor commands registered by this plug-in
:param name: (Q) Returns a string containing the internal name by which the plug-in is
registered
:param path: (Q) Returns a string containing the absolute path name to the plug-in
:param pluginsInUse: (Q) Returns a string array containing all the plug-ins that are
currently being used in the scene
:param referenceTranslators: (Q) If this flag is used in conjunction with the
pluginsInUse/pu flag then it will modify the output When true it will only show plug-ins
currently in u
:param registered: (Q) Returns a boolean specifying whether or not plug-in is currently
registered with the system
:param remove: (E) Removes the given plug-in's record from the registry There is no return
value
:param renderer: (Q) Returns a string array containing the names of all of the renderers
registered by this plug-in
:param savePluginPrefs: (C) Saves the plug-in preferences (ie autoload) out to
pluginPrefs.mel
:param serviceDescriptions: (Q) If there are services in use, then this flag will return a
string array containing short descriptions saying what those services are
:param settings: (Q) Returns an array of values with the loaded, autoload, registered
flags
:param tool: (Q M) Returns a string array containing the names of all of the tool contexts
registered by this plug-in
:param translator: (Q) Returns a string array containing the names of all of the file
translators registered by this plug-in
:param unloadOk: (Q) Returns a boolean that specifies whether or not the plug-in can be
safely unloaded It will return false if the plug-in is currently in use For exam
:param userNamed: (Q) Returns a boolean specifying whether or not the plug-in has been
assigned a name by the user
:param vendor: (Q) Returns a string containing the vendor of the plug-in
:param version: (Q) Returns a string containing the version the plug-in
:param writeRequires: (C Q E) Sets whether or not this plug-in should write "requires"
command into the saved file "requires" command could autoload the plug-in when you open
or
:returns: Dependent upon the action requested.
"""
pass
def xgmGrabBrushContext(*args, **kwargs)->None:
"""
"""
pass
def Radial(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateSubdivSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def subdMirror(*args, caching: bool=True, nodeState: Union[int, bool]=0, xMirror: bool=False,
yMirror: bool=False, zMirror: bool=False, constructionHistory: bool=True, name:
AnyStr="", object: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
This command takes a subdivision surface, passed as the argument, and produces a
subdivision surface that is a mirror Returns the name of the subdivision surface created
and optionally the DG node that does the mirroring
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param xMirror: (C Q E) Mirror the vertices in X Default: false
:param yMirror: (C Q E) Mirror the vertices in Y Default: false
:param zMirror: (C Q E) Mirror the vertices in Z Default: false
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:returns: The subdivision surface and optionally the dependency node name
"""
pass
def HypershadeDisplayNoShapes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def u3dOptimize(*args, **kwargs)->None:
"""
"""
pass
def dR_wireframeSmoothTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def modelEditor(*args, activeComponentsXray: bool=True, activeCustomEnvironment: AnyStr="",
activeCustomGeometry: Union[AnyStr, bool]="", activeCustomLighSet: Union[AnyStr,
bool]="", activeCustomOverrideGeometry: Union[AnyStr, bool]="",
activeCustomRenderer: Union[AnyStr, bool]="", activeOnly: bool=True,
activeShadingGraph: Union[AnyStr, bool]="", activeView: bool=True, addObjects:
AnyStr="", addSelected: bool=True, addSelectedObjects: bool=True, allObjects:
bool=True, backfaceCulling: bool=True, bufferMode: Union[AnyStr, bool]="",
bumpResolution: Union[List[int, int], bool]=None, camera: Union[AnyStr,
bool]="", cameraName: AnyStr="", cameraSet: Union[AnyStr, bool]="",
cameraSetup: bool=True, cameras: bool=True, capture: Union[AnyStr, bool]="",
captureSequenceNumber: Union[int, bool]=0, clipGhosts: bool=True, cmEnabled:
bool=True, colorMap: bool=True, colorResolution: Union[List[int, int],
bool]=None, control: bool=True, controlVertices: bool=True, cullingOverride:
Union[AnyStr, bool]="", default: bool=True, defineTemplate: AnyStr="",
deformers: bool=True, dimensions: bool=True, displayAppearance: Union[AnyStr,
bool]="", displayLights: Union[AnyStr, bool]="", displayTextures: bool=True,
docTag: Union[AnyStr, bool]="", dynamicConstraints: bool=True, dynamics:
bool=True, editorChanged: Union[Script, bool]=None, exists: bool=True,
exposure: Union[float, bool]=0.0, filter: Union[AnyStr, bool]="",
filteredObjectList: bool=True, fluids: bool=True, fogColor: Union[List[float,
float, float, float], bool]=None, fogDensity: Union[float, bool]=0.0, fogEnd:
Union[float, bool]=0.0, fogMode: Union[AnyStr, bool]="", fogSource:
Union[AnyStr, bool]="", fogStart: Union[float, bool]=0.0, fogging: bool=True,
follicles: bool=True, forceMainConnection: Union[AnyStr, bool]="", gamma:
Union[float, bool]=0.0, greasePencils: bool=True, grid: bool=True, hairSystems:
bool=True, handles: bool=True, headsUpDisplay: bool=True, height: bool=True,
highlightConnection: Union[AnyStr, bool]="", hulls: bool=True, ignorePanZoom:
bool=True, ikHandles: bool=True, imagePlane: bool=True, interactive: bool=True,
interactiveBackFaceCull: bool=True, interactiveDisableShadows: bool=True,
isFiltered: bool=True, jointXray: bool=True, joints: bool=True, lights:
bool=True, lineWidth: Union[float, bool]=0.0, locators: bool=True,
lockMainConnection: bool=True, lowQualityLighting: bool=True,
mainListConnection: Union[AnyStr, bool]="", manipulators: bool=True,
maxConstantTransparency: Union[float, bool]=0.0, maximumNumHardwareLights:
bool=True, modelPanel: AnyStr="", motionTrails: bool=True, nCloths: bool=True,
nParticles: bool=True, nRigids: bool=True, noUndo: bool=True, nurbsCurves:
bool=True, nurbsSurfaces: bool=True, objectFilter: Union[Script, bool]=None,
objectFilterList: Union[Script, bool]=None, objectFilterListUI: Union[Script,
bool]=None, objectFilterShowInHUD: bool=True, objectFilterUI: Union[Script,
bool]=None, occlusionCulling: bool=True, panel: Union[AnyStr, bool]="", parent:
Union[AnyStr, bool]="", particleInstancers: bool=True, pivots: bool=True,
planes: bool=True, pluginObjects: Union[List[AnyStr, bool], List[List[AnyStr,
bool]]]=None, pluginShapes: bool=True, polymeshes: bool=True,
queryPluginObjects: Union[AnyStr, bool]="", removeSelected: bool=True,
rendererDeviceName: bool=True, rendererList: bool=True, rendererListUI:
bool=True, rendererName: Union[AnyStr, bool]="", rendererOverrideList:
bool=True, rendererOverrideListUI: bool=True, rendererOverrideName:
Union[AnyStr, bool]="", resetCustomCamera: bool=True, sceneRenderFilter:
Union[AnyStr, bool]="", selectionConnection: Union[AnyStr, bool]="",
selectionHiliteDisplay: bool=True, setSelected: bool=True, shadingModel:
Union[int, bool]=0, shadows: bool=True, smallObjectCulling: bool=True,
smallObjectThreshold: Union[float, bool]=0.0, smoothWireframe: bool=True,
sortTransparent: bool=True, stateString: bool=True, stereoDrawMode: bool=True,
strokes: bool=True, subdivSurfaces: bool=True, textureAnisotropic: bool=True,
textureCompression: bool=True, textureDisplay: Union[AnyStr, bool]="",
textureEnvironmentMap: bool=True, textureHilight: bool=True, textureMaxSize:
Union[int, bool]=0, textureMemoryUsed: bool=True, textureSampling: Union[int,
bool]=0, textures: bool=True, toggleExposure: bool=True, toggleGamma: bool=True,
transpInShadows: bool=True, transparencyAlgorithm: Union[AnyStr, bool]="",
twoSidedLighting: bool=True, unParent: bool=True, unlockMainConnection:
bool=True, updateColorMode: bool=True, updateMainConnection: bool=True,
useBaseRenderer: bool=True, useColorIndex: bool=True, useDefaultMaterial:
bool=True, useInteractiveMode: bool=True, useRGBImagePlane: bool=True,
useReducedRenderer: bool=True, useTemplate: AnyStr="", userNode: Union[AnyStr,
bool]="", viewObjects: bool=True, viewSelected: bool=True, viewTransformName:
Union[AnyStr, bool]="", viewType: bool=True, width: bool=True,
wireframeBackingStore: bool=True, wireframeOnShaded: bool=True, xray: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create, edit or query a model editor Note that some of the flags of this command may have
different settings for normal mode and for interactive/playback mode For example, a
modelEditor can be set to use shaded mode normally, but to use wireframe during playback
for greater speed Some flags also support having defaults set so that new model edi
:param activeComponentsXray: (Q E) Turns on or off Xray mode for active components
:param activeCustomEnvironment: (E) Specifies a path to an image file to be used as
environment map It is only enabled when a valid scene render filter is specified
:param activeCustomGeometry: (Q E) Specifies an identifier for custom geometry to override
the geometry to display It is only enabled when a valid scene render filter is specified
:param activeCustomLighSet: (Q E) Specifies an identifier for the light set to use with a
scene render filter It is only enabled when a valid scene render filter is specified
:param activeCustomOverrideGeometry: (Q E) Specifies an identifier for an override on the
custom geometry for a scene render filter
:param activeCustomRenderer: (Q E) Specifies an identifier for custom renderer to use when
a valid scene render filter is also specified
:param activeOnly: (Q E) Sets whether only active objects should appear shaded in shaded
display
:param activeShadingGraph: (Q E) Specifies the shading graph to use to override material
display Only enabled when a valid scene render filter is specified
:param activeView: (Q E) 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
:param addObjects: (E) 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 tru
:param addSelected: (E) This flag causes the currently active objects to be added to the
list of objects visible in the view (if viewSelected is true)
:param addSelectedObjects: (C) If set then add the selected objects to the editor
:param allObjects: (Q E) Turn on/off the display of all objects for the view of the model
editor This excludes NURBS, CVs, hulls, grids and manipulators
:param backfaceCulling: (Q E) 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
:param bufferMode: (Q E) Deprecated: this is not supported in Viewport 2.0 Sets the
graphic buffer mode Possible values are "single" or "double"
:param bumpResolution: (Q E) Set the resolution for "baked" bump map textures when using
the hardware renderer The default value is 512, 512 respectively
:param camera: (Q E) Change or query the name of the camera in model editor
:param cameraName: (C E) 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 m
:param cameraSet: (C Q E) Name of the camera set
:param cameraSetup: (Q) 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 ar
:param cameras: (Q E) Turn on/off the display of cameras for the view of the model editor
:param capture: (Q E) Perform an one-time capture of the viewport to the named image file
on disk
:param captureSequenceNumber: (Q E) When a number greater or equal to 0 is specified each
subsequent refresh will save an image file to disk if the capture flag has been enabled
The na
:param clipGhosts: (C Q E) Define whether the clip ghosts should be added or not
:param cmEnabled: (Q E) Turn on or off applying color management in the editor If set, the
color management configuration set in the current editor is used
:param colorMap: (Q) Queries the color map style for the model panel Possible values are
"colorIndex" and "rgb"
:param colorResolution: (Q E) Set the resolution for "baked" color textures when using the
hardware renderer The default value is 256, 256 respectively
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param controlVertices: (Q E) Turn on/off the display of NURBS CVs for the view of the
model editor
:param cullingOverride: (Q E) Set whether to override the culling attributes on objects
when using the hardware renderer The options are: "none" : Use the culling object
attribut
:param default: (Q E) 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
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param deformers: (Q E) Turn on/off the display of deformer objects for the view of the
model editor
:param dimensions: (Q E) Turn on/off the display of dimension objects for the view of the
model editor
:param displayAppearance: (Q E) Sets the display appearance of the model panel Possible
values are "wireframe", "points", "boundingBox", "smoothShaded", "flatShaded" This flag
may
:param displayLights: (Q E) Sets the lighting for shaded mode Possible values are
"selected", "active", "all", "default", "none"
:param displayTextures: (Q E) Turns on or off display of textures in shaded mode
:param docTag: (C Q E) Attaches a tag to the editor
:param dynamicConstraints: (Q E) Turn on/off the display of dynamicConstraints for the view
of the model editor
:param dynamics: (Q E) Turn on/off the display of dynamics objects for the view of the
model editor
:param editorChanged: (C Q E) 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 mo
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param exposure: (Q E) The exposure value used by the color management of the current
editor
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param filteredObjectList: (Q) 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 disp
:param fluids: (Q E) Turn on/off the display of fluids for the view of the model editor
:param fogColor: (Q E) The color used for hardware fogging
:param fogDensity: (Q E) Determines the density of hardware fogging
:param fogEnd: (Q E) The end location of hardware fogging
:param fogMode: (Q E) This determines the drop-off mode for fog The possibilities are:
"linear" : linear drop-off "exponent" : exponential drop-off "exponent2" : squared
:param fogSource: (Q E) 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
:param fogStart: (Q E) The start location of hardware fogging
:param fogging: (Q E) Set whether hardware fogging is enabled or not
:param follicles: (Q E) Turn on/off the display of follicles for the view of the model
editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param gamma: (Q E) The gamma value used by the color management of the current editor
:param greasePencils: (C Q E) Define whether the grease pencil marks should be added or
not
:param grid: (Q E) Turn on/off the display of the grid for the view of the model editor
:param hairSystems: (Q E) Turn on/off the display of hairSystems for the view of the model
editor
:param handles: (Q E) Turn on/off the display of select handles for the view of the model
editor
:param headsUpDisplay: (Q E) 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
:param height: (Q) Return the height of the associated viewport in pixels
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param hulls: (Q E) Turn on/off the display of NURBS hulls for the view of the model
editor
:param ignorePanZoom: (Q E) Sets whether the model panel will ignore the 2D pan/zoom value
to give an overview of the scene
:param ikHandles: (Q E) Turn on/off the display of ik handles and end effectors for the
view of the model editor
:param imagePlane: (Q E) Turn on/off the display of image plane for the view
:param interactive: (Q E) 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 dur
:param interactiveBackFaceCull: (C Q E) Define whether interactive backface culling should
be on or not
:param interactiveDisableShadows: (C Q E) Define whether interactive shadows should be
disabled or not
:param isFiltered: (Q) 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
:param jointXray: (Q E) Turns on or off Xray mode for joints
:param joints: (Q E) Turn on/off the display of joints for the view of the model editor
:param lights: (Q E) Turn on/off the display of lights for the view of the model editor
:param lineWidth: (Q E) Set width of lines for display
:param locators: (Q E) Turn on/off the display of locator objects for the view of the model
editor
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param lowQualityLighting: (Q E) Set whether to use "low quality lighting" when using the
hardware renderer The default value is false
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param manipulators: (Q E) Turn on/off the display of manipulator objects for the view of
the model editor
:param maxConstantTransparency: (Q E) Sets the maximum constant transparency Setting this
value remaps constant transparency values from the range [0.0, 1.0] to the range [0.0,
maxConsta
:param maximumNumHardwareLights: (C Q E) Define whether the hardware light maximum should
be respected or not
:param modelPanel: (C) 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 fla
:param motionTrails: (Q E) Turn on/off the Motion Trail display in the Viewport
:param nCloths: (Q E) Turn on/off the display of nCloths for the view of the model editor
:param nParticles: (Q E) Turn on/off the display of nParticles for the view of the model
editor
:param nRigids: (Q E) Turn on/off the display of nRigids for the view of the model editor
:param noUndo: (E) This flag prevents some viewport operations (such as isolate select)
from being added to the undo queue
:param nurbsCurves: (Q E) Turn on/off the display of nurbs curves for the view of the model
editor
:param nurbsSurfaces: (Q E) Turn on/off the display of nurbs surfaces for the view of the
model editor
:param objectFilter: (Q E) Set or query the current object filter name An object filter is
required to have already been registered
:param objectFilterList: (Q) Return a list of names of registered filters
:param objectFilterListUI: (Q) Return a list of UI names of registered filters
:param objectFilterShowInHUD: (Q E) 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 th
:param objectFilterUI: (Q) Query the current object filter UI name The object filter is
required to have already been registered
:param occlusionCulling: (Q E) Set whether to enable occlusion culling testing when using
the hardware renderer The default value is false
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param particleInstancers: (C Q E) Define whether the particle instances should be shown or
not
:param pivots: (Q E) Turn on/off the display of transform pivots for the view of the model
editor
:param planes: (Q E) Turn on/off the display of sketch planes for the view of the model
editor
:param pluginObjects: (E M) Turn on/off the display of plug-in objects for the view It
depends on the plug-in implementation whether to respect this flag
:param pluginShapes: (E) Turn on/off the display of plug-in shapes for the view It depends
on the plug-in implementation whether to respect this flag
:param polymeshes: (Q E) Turn on/off the display of polygon meshes for the view of the
model editor
:param queryPluginObjects: (Q) Query the on/off state of plug-in objects display for the
view To set the on/off state, use -pluginObjects instead
:param removeSelected: (E) This flag causes the currently active objects to be removed from
the list of objects visible in the view (if viewSelected is true)
:param rendererDeviceName: (Q) Query for the name of the draw API used by the Viewport 2.0
renderer for a 3d modeling viewport The possible return values are "VirtualDeviceGL" if
:param rendererList: (Q) Query for a list of the internal names for renderers available for
use with the 3d modeling viewport The default list contains at least "vp2Renderer
:param rendererListUI: (Q) 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 "vp2Rend
:param rendererName: (Q E) Set or get the renderer used for a 3d modeling viewport The
name provided should be an internal name of a renderer The 'rendererList' flag can be u
:param rendererOverrideList: (Q) Query for a list of the internal names for renderer
overrides for a 3d viewport renderer Currently only the "Viewport 2" renderer supports
renderer
:param rendererOverrideListUI: (Q) Query for a list of the UI names for renderer overrides
for a 3d viewport renderer Currently only the "Viewport 2" renderer supports renderer
overri
:param rendererOverrideName: (Q E) Set or get the override used for a 3d viewport renderer
The name provided should be the internal name for an override The 'rendererOverrideList'
fl
:param resetCustomCamera: (E) When specified will reset the camera transform for the active
custom camera used for a scene render filter It is only enabled when a valid scene ren
:param sceneRenderFilter: (Q E) Specifies the name of a scene render filter
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param selectionHiliteDisplay: (Q E) Sets whether the model panel will draw any selection
hiliting on the objects in this window
:param setSelected: (E) This flag causes the currently active objects to be the only
objects visible in the view (if viewSelected is true)
:param shadingModel: (C Q E) Shading model to use
:param shadows: (Q E) Turn on/off the display of hardware shadows in shaded mode
:param smallObjectCulling: (C Q E) Define whether small object culling should be enabled or
not
:param smallObjectThreshold: (C Q E) Threshold used for small object culling
:param smoothWireframe: (Q E) Turns on or off smoothing of wireframe lines and points
:param sortTransparent: (Q E) This flag turns on/off sorting of transparent objects during
shaded mode refresh Normally, objects are sorted according to their origin in camera sp
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param stereoDrawMode: (C Q E) If this flag is used then set stereo draw mode
:param strokes: (Q E) Turn on/off the display of Paint Effects strokes for the view
:param subdivSurfaces: (Q E) Turn on/off the display of subdivision surfaces for the view
of the model editor
:param textureAnisotropic: (Q E) Set whether to perform anisotropic texture filtering Will
work only if the anisotropic texture filtering extension is supported in OpenGL on the gra
:param textureCompression: (C Q E) Defines whether texture compression should be used or
not
:param textureDisplay: (Q E) 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
:param textureEnvironmentMap: (C Q E) If true then use a texture environment map
:param textureHilight: (Q E) Set whether to show specular hilighting when the display is in
shaded textured mode
:param textureMaxSize: (Q E) 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
:param textureMemoryUsed: (Q) 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
:param textureSampling: (Q E) 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
:param textures: (Q E) Turn on/off the display of texture objects for the view
:param toggleExposure: (E) Toggles between the current and the default exposure value of
the editor
:param toggleGamma: (E) Toggles between the current and the default gamma value of the
editor
:param transpInShadows: (Q E) Set whether to enable display of transparency in shadows when
using the hardware renderer The default value is false
:param transparencyAlgorithm: (Q E) Set the transparency algorithm The options are: 1)
"frontAndBackCull" : Two pass front and back culling technique 2) "perPolygonSort" : Draw
transp
:param twoSidedLighting: (Q E) Turns on or off two sided lighting This may be used with
the -default flag
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateColorMode: (E) 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 p
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useBaseRenderer: (Q E) Set whether to use the "base" renderer when using the
hardware renderer and in "interactive display mode" (-useInteractiveMode) The default value
is
:param useColorIndex: (Q E) Sets whether the model panel will attempt to use color index
mode when possible Color index mode can provide a performance increase for point, bound
:param useDefaultMaterial: (Q E) 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 t
:param useInteractiveMode: (Q E) Turns on or off the use of the special interaction
settings during playback This flag may be used with the -default flag
:param useRGBImagePlane: (Q E) Sets whether the model panel will be forced into RGB mode
when there is an image plane attached to the panel's camera
:param useReducedRenderer: (C Q E) Set true if using the reduced renderer
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param userNode: (Q E) 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
:param viewObjects: (Q) 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 bei
:param viewSelected: (Q E) 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 o
:param viewTransformName: (Q E) Sets the view pipeline to be applied if color management is
enabled in the current editor
:param viewType: (Q) Returns a string indicating the type of the model editor For the
default model editor, returns the empty string For custom model editor types creat
:param width: (Q) Return the width of the associated viewport in pixels
:param wireframeBackingStore: (Q E) Sets whether a backing store is used to optimization
the drawing of active objects This mode can provide a performance increase in wireframe
mode fo
:param wireframeOnShaded: (Q E) Sets whether the model panel will draw the wireframe on all
shaded objects (if true) or only for active objects (if false)
:param xray: (Q E) Turns on or off Xray mode This may be used with the -default flag
:returns: the name of the editor.
"""
pass
def SculptPolygonsToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ModifyUpperRadiusRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def roll(*args, absolute: bool=True, degree: float=0.0, relative: bool=True, **kwargs)->None:
"""
The roll command rotates a camera about its viewing direction, a positive angle produces
clockwise camera rotation, while a negative angle produces counter-clockwise camera
rotation The default mode is relative and the rotation is applied with respect to the
current orientation of the camera When mode is set to absolute, the rotation is applied
:param absolute: (C) Set to absolute mode
:param degree: (C) Set the amount of the rotation angle
:param relative: (C) Set to relative mode
:returns:
"""
pass
def ConvertSelectionToContainedFaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SlideEdgeTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorFramePlaybackRange(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Export(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Bend(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorKeepTransitionsTogglePress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshSmearTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectBrushNames(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def constrain(*args, barrier: bool=True, damping: Union[float, bool]=0.0, directionalHinge:
bool=True, hinge: bool=True, interpenetrate: bool=True, nail: bool=True, name:
Union[AnyStr, bool]="", orientation: Union[List[float, float, float], bool]=None,
pinConstraint: bool=True, position: Union[List[float, float, float], bool]=None,
restLength: Union[float, bool]=0.0, spring: bool=True, stiffness: Union[float,
bool]=0.0, q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This command constrains rigid bodies to the world or other rigid bodies
:param barrier: (C Q) Creates a barrier constraint This command requires one rigid bodies
:param damping: (C Q E) Sets the damping constant Default value: 0.1 Range: -1000.0 to
1000.0
:param directionalHinge: (C Q) Creates a directional hinge constraint This command
requires two rigid bodies The directional hinge always maintains the initial direction of
its a
:param hinge: (C Q) Creates a hinge constraint This command requires one or two rigid
bodies
:param interpenetrate: (C Q E) Allows (or disallows) the rigid bodies defined in the
constrain to ipenetrate
:param nail: (C Q) Creates a nail constraint This command requires one rigid body
:param name: (C Q E) Names the rigid constraint
:param orientation: (C Q E) Set initial orientation of the constraint in world space This
command is only valid with hinge and barrier constraints Default value: 0.0 0.0 0.0
:param pinConstraint: (C Q) Creates a pin constraint This command requires two rigid
bodies
:param position: (C Q E) Set initial position of the constraint in world space Default
value: 0.0 0.0 0.0 for uni-constraints, midpoint of bodies for deul constraint
:param restLength: (C Q E) Sets the rest length Default value: 1.0
:param spring: (C Q) Creates a spring constraint This command requires one or two
rigidies
:param stiffness: (C Q E) Sets the springs stiffness constant Default value: 5.0
:returns:
"""
pass
def nexConnectContext(*args, **kwargs)->None:
"""
"""
pass
def cmdScrollFieldReporter(*args, annotation: Union[AnyStr, bool]="", backgroundColor:
Union[List[float, float, float], bool]=None, clear: bool=True,
copySelection: bool=True, cutSelection: bool=True, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dropCallback: Script=None, echoAllCommands: bool=True, enable:
bool=True, enableBackground: bool=True, enableKeyboardFocus:
bool=True, exists: bool=True, filterSourceType: Union[AnyStr,
bool]="", fullPathName: bool=True, hasFocus: bool=True, height:
Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, isObscured: bool=True, lineNumbers: bool=True, manage:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True,
parent: Union[AnyStr, bool]="", pasteSelection: bool=True,
popupMenuArray: bool=True, preventOverride: bool=True,
receiveFocusCommand: Script=None, saveSelection: AnyStr="",
saveSelectionToShelf: bool=True, select: List[int, int]=None,
selectAll: bool=True, stackTrace: bool=True, statusBarMessage:
AnyStr="", suppressErrors: bool=True, suppressInfo: bool=True,
suppressResults: bool=True, suppressStackTrace: bool=True,
suppressWarnings: bool=True, text: Union[AnyStr, bool]="",
textLength: bool=True, useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
A script editor reporter control used to receive and display the history of processed
commmands
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param clear: (C E) Clears the field
:param copySelection: (C E) Copies the current selection from this field
:param cutSelection: (C E) Cuts the current selection from this field
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param echoAllCommands: (C Q E) Echo all commands (Global parameter, affects all command
reporters)
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filterSourceType: (C Q E) Filters the specified source type from showing in this
command reporter Currently supports either "mel", "python", or "" (default) Setting the
filt
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param hasFocus: (Q) Whether this control is currently in focus
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param lineNumbers: (C Q E) Show line numbers (in Error/Warning messages) (Global
parameter, affects all command reporters)
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param pasteSelection: (C E) Pastes text into this field at the current caret position
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param receiveFocusCommand: (C E) Command executed when the field receives focus
:param saveSelection: (C E) Prompts to save the current selection to a file The default
filename prompt will be prepended with the given string
:param saveSelectionToShelf: (C E) Prompts to save the current selection to an item in the
shelf
:param select: (C E) Selects text within a specified range
:param selectAll: (C E) Selects all text
:param stackTrace: (C Q E) Show stack trace (Global parameter, affects all command
reporters)
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param suppressErrors: (C Q E) Suppress errors
:param suppressInfo: (C Q E) Suppress info
:param suppressResults: (C Q E) Suppress results
:param suppressStackTrace: (C Q E) Suppress stack trace
:param suppressWarnings: (C Q E) Suppress warnings
:param text: (C Q E) Replaces the field text with the given string
:param textLength: (Q) The number of characters in this text field
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the reporter control
"""
pass
def cameraView(*args, addBookmark: bool=True, animate: bool=True, bookmarkType: int=0, camera:
name=None, name: AnyStr="", removeBookmark: bool=True, setCamera: bool=True,
setView: bool=True, e=True, edit=True, **kwargs)->AnyStr:
"""
This command creates a preset view for a camera which is then independent of the camera
The view stores a camera's eye point, center of interest point, up vector, tumble pivot,
horizontal aperture, vertical aperature, focal length, orthographic width, and whether the
camera is orthographic or perspective by default Or you can only store 2D pan/zo
:param addBookmark: (C E) Associate this view with the camera specified or the camera in
the active model panel This flag can be used for creation or edit
:param animate: (C E) Set the animation capability for view switches
:param bookmarkType: (C) Specify the bookmark type, which can be: 0 3D bookmark; 1 2D
Pan/Zoom bookmark
:param camera: (E) Specify the camera to use This flag should be used in conjunction with
the add bookmark, remove bookmark, set camera, or set view flags If this fla
:param name: (C) Set the name of the view This flag can only be used for creation
:param removeBookmark: (E) Remove the association of this view with the camera specified or
the camera in the active model panel This can only be used with edit
:param setCamera: (E) Set this view into a camera specified by the camera flag or the
camera in the active model panel This flag can only be used with edit
:param setView: (E) Set the camera view to match a camera specified or the active model
panel This flag can only be used with edit
:returns: (name of the camera view)
"""
pass
def TimeEditorPasteClips(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def orbitCtx(*args, alternateContext: bool=True, exists: bool=True, history: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", localOrbit: bool=True, name: AnyStr="", orbitScale: Union[float,
bool]=0.0, toolName: Union[AnyStr, bool]="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Create, edit, or query an orbit context
:param alternateContext: (C Q) Set the ALT+MMB and ALT+SHIFT+MMB to refer to this context
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param localOrbit: (C Q E) Orbit around the camera's center of interest
:param name: (C) If this is a tool command, name the tool appropriately
:param orbitScale: (C Q E) In degrees of rotation per 100 pixels of cursor drag
:param toolName: (C Q) Name of the specific tool to which this command refers
:returns: The name of the context
"""
pass
def DeleteMemoryCaching(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def profilerTool(*args, categoryView: bool=True, collapseSelectedEvents: bool=True,
collapseSelectedEventsRepetition: bool=True, cpuView: bool=True, destroy:
bool=True, eventTypes: bool=True, exists: bool=True, expandSelectedEvents:
bool=True, expandSelectedEventsRepetition: bool=True, findNext: bool=True,
findPrevious: bool=True, frameAll: bool=True, frameSelected: bool=True,
isolateSegment: int=0, make: bool=True, matchWholeWord: bool=True,
searchEvent: Union[AnyStr, bool]="", segmentCount: bool=True, showAllEvent:
bool=True, showCriticalPath: bool=True, showSelectedEvents: bool=True,
showSelectedEventsRepetition: bool=True, threadView: bool=True,
unisolateSegment: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This script is intended to be used by the profilerPanel to interact with the profiler
tool's view (draw region) It can be used to control some behaviors about the profiler Tool
:param categoryView: (E) Change view mode to category view
:param collapseSelectedEvents: (E) Hide all sub-events of selected events so that only
top-level events show
:param collapseSelectedEventsRepetition: (E) Hide all sub-events repetition of selected
events based on their comment
:param cpuView: (E) Change view mode to cpu view
:param destroy: (C) Destroy the profiler tool Internal flag Should not be used by user
:param eventTypes: (Q) Return JSON data containing the list of event types on currently
existing events If the value of the flag is true then show only event types for sel
:param exists: (Q) Query if the profiler tool view exists Profiler tool can only exist
after "profilerTool -make" is called
:param expandSelectedEvents: (E) Show all sub-events of selected events
:param expandSelectedEventsRepetition: (E) Show all sub-events repetition of selected
events based on their comment
:param findNext: (Q) This flag is used along with flag -searchEvent
:param findPrevious: (Q) This flag is used along with flag -searchEvent
:param frameAll: (E) Frame on all events in the profilerToolView
:param frameSelected: (E) Frame on all selected events in the profilerToolView
:param isolateSegment: (E) Isolate a specified segment A segment is a set of events that
happened in one animation frame You can use flag -segmentCount to query the number of
:param make: (C) Make the profiler tool and parent it to the most recent layout created
Internal flag Should not be used by user
:param matchWholeWord: (E) Tells profiler tool if it should match whole word when searching
event(s) The default value is false
:param searchEvent: (Q) Search event(s) You can set -matchWholeWord before you use
-searchEvent If -matchWholeWord has been set to true, the profiler tool will search even
:param segmentCount: (Q) Returns the number of segments in the event buffer
:param showAllEvent: (E) Show all events (if events were hidden by filtering) (true) or
Hide all events (false)
:param showCriticalPath: (E) Show critical path of selected frame
:param showSelectedEvents: (E) Show only the selected events (true) or hide all selected
events (false)
:param showSelectedEventsRepetition: (E) Show only the selected events repetition based on
their comment (true) or Hide all selected events repetition based on their comment (false)
:param threadView: (E) Change view mode to thread view
:param unisolateSegment: (E) Unisolate current isolated segment If no segment is currently
isolated, nothing will happen
:returns:
"""
pass
def EmitFromObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectUVOverlappingComponents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Goal(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def substituteGeometry(*args, disableNonSkinDeformers: bool=True, newGeometryToLayer: bool=True,
oldGeometryToLayer: bool=True, reWeightDistTolerance: float=0.0,
retainOldGeometry: bool=True, **kwargs)->AnyStr:
"""
This command can be used to replace the geometry which is already connected to deformers
with a new geometry The weights on the old geometry will be retargeted to the new geometry
:param disableNonSkinDeformers: (C) This flag controls the state of deformers other than
skin deformers after the substitution has taken place If the flag is true then non-skin
deforme
:param newGeometryToLayer: (C) Create a new layer for the new geometry
:param oldGeometryToLayer: (C) Create a new layer and move the old geometry to this layer
:param reWeightDistTolerance: (C) Specify the distance tolerance value to be used for
retargeting weights While transferring weights the command tries to find the corresponding
verti
:param retainOldGeometry: (C) A copy of the old geometry should be retained
:returns: Name of shapes that were replaced
"""
pass
def WarpImage(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GrowLoopPolygonSelectionRegion(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportAxisConversionMethod(*args, **kwargs)->None:
"""
"""
pass
def xgmGuideSculptToolCmd(*args, **kwargs)->None:
"""
"""
pass
def ToggleUVDistortion(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVEditorFrameAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddTargetShape(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def listNodeTypes(*args, exclude: AnyStr="", **kwargs)->List[AnyStr]:
"""
Lists dependency node types satisfying a specified classification string See the
'getClassification' command for a list of the standard classification strings
:param exclude: (C) Nodes that satisfies this exclude classification will be filtered out
:returns: The type names of all node types in the system that satisfy the
given
classification string.
"""
pass
def NodeEditorGraphRemoveSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MergeMultipleEdges(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def manipRotateContext(*args, activeHandle: Union[int, bool]=0, alignAlong: List[float, float,
float]=None, centerTrackball: bool=True, constrainAlongNormal: bool=True,
currentActiveHandle: Union[int, bool]=0, editPivotMode: bool=True,
editPivotPosition: bool=True, exists: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
lastMode: Union[int, bool]=0, manipVisible: bool=True, mode: Union[int,
bool]=1, modifyTranslation: bool=False, orientAxes: Union[List[float,
float, float], bool]=None, orientObject: AnyStr="", orientTowards:
List[float, float, float]=None, pinPivot: bool=True, pivotOriHandle:
bool=True, position: bool=True, postCommand: Script=None,
postDragCommand: List[Script, AnyStr]=None, preCommand: Script=None,
preDragCommand: List[Script, AnyStr]=None, preserveChildPosition:
bool=False, preserveUV: bool=True, reflection: bool=True,
reflectionAbout: int=0, reflectionAxis: int=0, reflectionTolerance:
float=0.0, rotate: Union[List[float, float, float], bool]=None, snap:
bool=True, snapPivotOri: bool=True, snapPivotPos: bool=True,
snapRelative: bool=True, snapValue: Union[float, bool]=0.0, tweakMode:
bool=True, useCenterPivot: bool=True, useManipPivot: bool=True,
useObjectPivot: bool=True, xformConstraint: Union[AnyStr, bool]="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create, edit, or query a rotate manip context
:param activeHandle: (Q E) Sets the default active handle for the manip That is, the
handle which should be initially active when the tool is activated Values can be: 0 - X a
:param alignAlong: (C E) Aligns active handle along vector
:param centerTrackball: (C Q E) Specify if the center is to be handled like a trackball
:param constrainAlongNormal: (Q E) When true, transform constraints are applied along the
vertex normal first and only use the closest point when no intersection is found along the
nor
:param currentActiveHandle: (Q E) Sets the active handle for the manip Values can be: 0 -
X axis handle is active 1 - Y axis handle is active 2 - Z axis handle is active 3 - View
rot
:param editPivotMode: (Q) Returns true manipulator is in edit pivot mode
:param editPivotPosition: (Q) Returns the current position of the edit pivot manipulator
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param lastMode: (Q) Returns the previous rotation mode
:param manipVisible: (Q) Returns true if the rotate manipulator is visible
:param mode: (Q E) Rotate mode: 0 - Object Space (default) 1 - World Space 2 - Gimbal Mode
3 - Custom Axis Orientation 10 - Component Space
:param modifyTranslation: (Q E) When false, and an object is rotated about a point other
than its rotate pivot, its rotateTranslate attribute is modified to put the object at the
co
:param orientAxes: (Q E) Orients manipulator rotating around axes by specified angles
:param orientObject: (C E) Orients manipulator to the passed in object/component
:param orientTowards: (C E) Orients active handle towards world point
:param pinPivot: (Q E) Pin component pivot When the component pivot is set and pinned
selection changes will not reset the pivot position and orientation
:param pivotOriHandle: (Q E) When true, the pivot manipulator will show the orientation
handle during editing Default is true
:param position: (Q) Returns the current position of the manipulator
:param postCommand: (C E) Specifies a command to be executed when the tool is exited
:param postDragCommand: (C E) Specifies a command and a node type The command will be
executed at the end of a drag when a node of the specified type is in the selection
:param preCommand: (C E) Specifies a command to be executed when the tool is entered
:param preDragCommand: (C E) Specifies a command and a node type The command will be
executed at the start of a drag when a node of the specified type is in the selection
:param preserveChildPosition: (Q E) When false, the children objects move when their parent
is rotated When true, the worldspace position of the children will be maintained as the
pare
:param preserveUV: (Q E) When false, the uvs are not changes to match the vertex edit When
true, the uvs are edited to project to new values to stop texture swimming as vert
:param reflection: () This flag is obsolete Reflection is now managed as part of selection
itself using the symmetricModeling command
:param reflectionAbout: () This flag is obsolete Reflection is now managed as part of
selection itself using the symmetricModeling command
:param reflectionAxis: () This flag is obsolete Reflection is now managed as part of
selection itself using the symmetricModeling command
:param reflectionTolerance: () This flag is obsolete Reflection is now managed as part of
selection itself using the symmetricModeling command
:param rotate: (Q E) Returns the rotation of the manipulator for its current
orientation/mode
:param snap: (C Q E) Specify that the manipulation is to use absolute snap
:param snapPivotOri: (Q E) Snap pivot orientation Modify pivot orientation when snapping
the pivot to a component
:param snapPivotPos: (Q E) Snap pivot position Modify pivot position when snapping the
pivot to a component
:param snapRelative: (C Q E) Specify that the manipulation is to use relative snap
:param snapValue: (C Q E) Specify the snapping value
:param tweakMode: (Q E) When true, the manipulator is hidden and highlighted components can
be selected and rotated in one step using a click-drag interaction
:param useCenterPivot: (Q E) When true, use the center of the selection's bounding box as
the center of the rotation (for all objects)
:param useManipPivot: (Q E) When true, use the manipulator's center as the center of the
rotation (for all objects)
:param useObjectPivot: (Q E) When true, use each object's pivot as the center of its
rotation
:param xformConstraint: (Q E) none - no transform constraint edge - edge transform
constraint surface - surface transform constraint
:returns: (name of the new context)
"""
pass
def FineLevelComponentDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MakeCollide(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def adskRepresentation(*args, **kwargs)->None:
"""
"""
pass
def polyColorMod(*args, alphaScale_FloatValue: Union[float, bool]=0.0, alphaScale_Interp:
Union[int, bool]=0, alphaScale_Position: Union[float, bool]=0.0,
baseColorName: AnyStr="", blueScale_FloatValue: Union[float, bool]=0.0,
blueScale_Interp: Union[int, bool]=0, blueScale_Position: Union[float,
bool]=0.0, caching: bool=True, constructionHistory: bool=True,
greenScale_FloatValue: Union[float, bool]=0.0, greenScale_Interp: Union[int,
bool]=0, greenScale_Position: Union[float, bool]=0.0, huev: Union[float,
bool]=0.0, intensityScale_FloatValue: Union[float, bool]=0.0,
intensityScale_Interp: Union[int, bool]=0, intensityScale_Position:
Union[float, bool]=0.0, name: AnyStr="", nodeState: Union[int, bool]=0,
redScale_FloatValue: Union[float, bool]=0.0, redScale_Interp: Union[int,
bool]=0, redScale_Position: Union[float, bool]=0.0, satv: Union[float,
bool]=1.0, value: Union[float, bool]=1.0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Modifies the attributes of a poly color set
:param alphaScale_FloatValue: (C Q E) ?????
:param alphaScale_Interp: (C Q E) ????? Default: 0
:param alphaScale_Position: (C Q E) ?????
:param baseColorName: (C) The name of the color set to be modified
:param blueScale_FloatValue: (C Q E) ?????
:param blueScale_Interp: (C Q E) ????? Default: 0
:param blueScale_Position: (C Q E) ?????
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param greenScale_FloatValue: (C Q E) ?????
:param greenScale_Interp: (C Q E) ????? Default: 0
:param greenScale_Position: (C Q E) ?????
:param huev: (C Q E) Hue rotates hue value of the final color Default: 0.0
:param intensityScale_FloatValue: (C Q E) ?????
:param intensityScale_Interp: (C Q E) ????? Default: 0
:param intensityScale_Position: (C Q E) ?????
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param redScale_FloatValue: (C Q E) ?????
:param redScale_Interp: (C Q E) ????? Default: 0
:param redScale_Position: (C Q E) ?????
:param satv: (C Q E) Sat scales the staturation of the final color Default: 1.0
:param value: (C Q E) Value scales the final color value Default: 1.0
:returns: The node name.
"""
pass
def subdPlanarProjection(*args, caching: bool=True, nodeState: Union[int, bool]=0,
constructionHistory: bool=True, createNewMap: bool=True, imageCenter:
Union[List[float, float], bool]=None, imageCenterX: Union[float,
bool]=0.5, imageCenterY: Union[float, bool]=0.5, imageScale:
Union[List[float, float], bool]=None, imageScaleU: Union[float,
bool]=1.0, imageScaleV: Union[float, bool]=1.0, insertBeforeDeformers:
bool=True, keepImageRatio: bool=True, mapDirection: AnyStr="", name:
AnyStr="", projectionCenter: Union[List[float, float, float],
bool]=None, projectionCenterX: Union[float, bool]=0.0,
projectionCenterY: Union[float, bool]=0.0, projectionCenterZ:
Union[float, bool]=0.0, projectionHeight: Union[float, bool]=1.0,
projectionScale: Union[List[float, float], bool]=None,
projectionWidth: Union[float, bool]=1.0, rotate: Union[List[float,
float, float], bool]=None, rotateX: Union[float, bool]=0.0, rotateY:
Union[float, bool]=0.0, rotateZ: Union[float, bool]=0.0,
rotationAngle: Union[float, bool]=10.0, smartFit: bool=True,
worldSpace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
TsubProjCmdBase is a base class for the command to create a mapping on the selected
subdivision faces Projects a map onto an object, using an orthogonal projection The piece
of the map defined from isu, isv, icx, icy area, is placed at pcx, pcy, pcz location
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param constructionHistory: (C) Turn the construction history on or off
:param createNewMap: (C Q E) This flag when set true will create a new map with a the name
passed in, if the map does not already exist
:param imageCenter: (C Q E) This flag specifies the center point of the 2D model layout C:
Default is 0.5 0.5 Q: When queried, this flag returns a float[2]
:param imageCenterX: (C Q E) This flag specifies X for the center point of the 2D model
layout C: Default is 0.5 Q: When queried, this flag returns a float
:param imageCenterY: (C Q E) This flag specifies Y for the center point of the 2D model
layout C: Default is 0.5 Q: When queried, this flag returns a float
:param imageScale: (C Q E) This flag specifies the UV scale : Enlarges or reduces the 2D
version of the model in U or V space relative to the 2D centerpoint C: Default is 1.0
:param imageScaleU: (C Q E) This flag specifies the U scale : Enlarges or reduces the 2D
version of the model in U space relative to the 2D centerpoint C: Default is 1.0 Q: Wh
:param imageScaleV: (C Q E) This flag specifies the V scale : Enlarges or reduces the 2D
version of the model in V space relative to the 2D centerpoint C: Default is 1.0 Q: Wh
:param insertBeforeDeformers: (C) This flag specifies if the projection node should be
inserted before or after deformer nodes already applied to the shape Inserting the
projection a
:param keepImageRatio: (C) True means keep any image ratio
:param mapDirection: (C) This flag specifies the mapping direction 'x', 'y' and 'z'
projects the map along the corresponding axis 'c' projects along the current camera view
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param projectionCenter: (C Q E) This flag specifies the origin point from which the map is
projected C: Default is 0.0 0.0 0.0 Q: When queried, this flag returns a float[3]
:param projectionCenterX: (C Q E) This flag specifies X for the origin point from which the
map is projected C: Default is 0.0 Q: When queried, this flag returns a float
:param projectionCenterY: (C Q E) This flag specifies Y for the origin point from which the
map is projected C: Default is 0.0 Q: When queried, this flag returns a float
:param projectionCenterZ: (C Q E) This flag specifies Z for the origin point from which the
map is projected C: Default is 0.0 Q: When queried, this flag returns a float
:param projectionHeight: (C Q E) This flag specifies the height of the map relative to the
3D projection axis C: Default is 1.0 Q: When queried, this flag returns a float
:param projectionScale: (C Q E) This flag specifies the width and the height of the map
relative to the 3D projection axis C: Default is 1.0 1.0 Q: When queried, this flag
returns
:param projectionWidth: (C Q E) This flag specifies the width of the map relative to the 3D
projection axis C: Default is 1.0 Q: When queried, this flag returns a float
:param rotate: (C Q E) This flag specifies the mapping rotate angles C: Default is 0.0 0.0
0.0 Q: When queried, this flag returns a float[3]
:param rotateX: (C Q E) This flag specifies X mapping rotate angle C: Default is 0.0 Q:
When queried, this flag returns a float[3]
:param rotateY: (C Q E) This flag specifies Y mapping rotate angle C: Default is 0.0 Q:
When queried, this flag returns a float
:param rotateZ: (C Q E) This flag specifies Z mapping rotate angle C: Default is 0.0 Q:
When queried, this flag returns a float
:param rotationAngle: (C Q E) This flag specifies the rotation angle in the mapping space
When the angle is positive, then the map rotates counterclockwise on the mapped model, w
:param smartFit: (C) True means use the smart fit algorithm
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def MarkingMenuPreferencesWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintSetMembershipToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UnpublishNode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisplayShadingMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertSelectionToUVEdgeLoop(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectLightsIlluminatingObject(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowDynamicConstraints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def greasePencilCtx(*args, autoCreateFrames: bool=True, canDraw: bool=True, createOrEditFrame:
Union[int, bool]=0, exists: bool=True, exportArchive: List[AnyStr,
AnyStr]=None, fileTextureSize: Union[int, bool]=0, greasePencilType:
Union[int, bool]=0, image1: Union[AnyStr, bool]="", image2: Union[AnyStr,
bool]="", image3: Union[AnyStr, bool]="", importArchive: AnyStr="",
makeStroke: Union[int, List[int], bool]=0, removeFrame: int=0,
resetBrushes: bool=True, rgbcolor: Union[List[float, float, float],
bool]=None, sequenceNodeName: Union[AnyStr, bool]="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This is a tool context command for the grease pencil tool
:param autoCreateFrames: (C Q E) Should frames be automatically created when drawing?
:param canDraw: (Q) Check to see if drawing is allowed
:param createOrEditFrame: (Q) Frame number for create or edit
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param exportArchive: (E) Modify names of export archive
:param fileTextureSize: (C Q E) Both width and height dimensions of the file texture (they
are square)
:param greasePencilType: (C Q E) Grease pencil type 1 = Pencil, 2 = Marker, 3 = Soft
Pencil, 4 = Eraser
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param importArchive: (E) Modify name of import archive
:param makeStroke: (C Q E M) Stroke point values
:param removeFrame: (E) Remove the given frame
:param resetBrushes: (Q E) Should the brushes reset?
:param rgbcolor: (C Q E) Color of the grease pencil
:param sequenceNodeName: (Q) Query the name of the sequence node
:returns:
"""
pass
def BendOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sculptMeshCacheChangeCloneSource(*args, blendShape: Union[AnyStr, bool]="", target:
Union[AnyStr, bool]="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
This command changes the source blend shape and target for the clone target tool Used
internally for undo/redo, and should not be called directly
:param blendShape: (C Q E) Set which blend shape should be used as the source when using
the clone tool When queried, returns the current blend shape name as a string
:param target: (C Q E) Set which blend shape should be used as the target when using the
clone tool When queried, returns the current blend shape target name as a string
:returns:
"""
pass
def NodeEditorToggleNodeSelectedPins(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NURBSSmoothnessRoughOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hotBox(*args, PaneOnlyMenus: bool=True, PaneToggleMenus: bool=True, animationOnlyMenus:
bool=True, animationToggleMenus: bool=True, clothOnlyMenus: bool=True,
clothToggleMenus: bool=True, commonOnlyMenus: bool=True, commonToggleMenus:
bool=True, customMenuSetsToggleMenus: bool=True, displayCenterOnly: bool=True,
displayHotbox: bool=True, displayStyle: bool=True, displayZonesOnly: bool=True,
dynamicsOnlyMenus: bool=True, dynamicsToggleMenus: bool=True, liveOnlyMenus:
bool=True, liveToggleMenus: bool=True, menuSetOnly: AnyStr="", menuSetToggle:
List[AnyStr, bool]=None, modelingOnlyMenus: bool=True, modelingToggleMenus:
bool=True, noClickCommand: Script=None, noClickDelay: float=0.0, noClickPosition:
bool=True, noKeyPress: bool=True, polygonsOnlyMenus: bool=True, polygonsToggleMenus:
bool=True, position: List[int, int]=None, release: bool=True, renderingOnlyMenus:
bool=True, renderingToggleMenus: bool=True, riggingOnlyMenus: bool=True,
riggingToggleMenus: bool=True, rmbPopups: bool=True, showAllToggleMenus: bool=True,
surfacesOnlyMenus: bool=True, surfacesToggleMenus: bool=True, transparenyLevel:
Union[int, bool]=0, updateMenus: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command controls parameters related to the hotBox menubar palette When the command is
invoked with no flags, the hotBox is popped up
:param PaneOnlyMenus: (C) Sets a row of menus to be the only visible row
:param PaneToggleMenus: (C Q) Sets the visibilty of a row of menus to on or off
:param animationOnlyMenus: (C Q)
:param animationToggleMenus: (C Q)
:param clothOnlyMenus: (C Q)
:param clothToggleMenus: (C Q)
:param commonOnlyMenus: (C Q)
:param commonToggleMenus: (C Q)
:param customMenuSetsToggleMenus: (C Q)
:param displayCenterOnly: (C) Three different display styles are defined for the hotBox It
can be fully displayed (dh), display only the marking menu zones (dzo) or no display (d
:param displayHotbox: (C Q)
:param displayStyle: (Q) Returns a string that identifies the flag used to set the current
display style The results can be dh, dzo, or dco, depending on which style the hot
:param displayZonesOnly: (C Q)
:param dynamicsOnlyMenus: (C Q)
:param dynamicsToggleMenus: (C Q)
:param liveOnlyMenus: (C Q)
:param liveToggleMenus: (C Q)
:param menuSetOnly: (C) Show only the named menu set
:param menuSetToggle: (C) Update the given menu sets with the paired toggle value
:param modelingOnlyMenus: (C Q)
:param modelingToggleMenus: (C Q)
:param noClickCommand: (C) The command to be executed if the hotBox is engaged and then
disengaged within noClickDelay time units
:param noClickDelay: (C) If the hotBox is engaged and then disengaged within this time
interval, then the noClickCommand is executed The time interval is in seconds The def
:param noClickPosition: (C) If a -noClickCommand has been specified then this flag will
cause the X and Y screen coordinates of the mouse pointer to be appended as arguments to
:param noKeyPress: (C Q) Normally the hotbox is popped by a pressing a keyboard key Use
the nkp flag to pop the hotbox from a device other than the keyboard (still use the r
:param polygonsOnlyMenus: (C Q)
:param polygonsToggleMenus: (C Q)
:param position: (C) Specify the screen position the hotbox should be centered at next time
it is displayed The default is the cursor position
:param release: (C Q) Action to be called on the release of the key which invoked the
hotbox
:param renderingOnlyMenus: (C Q)
:param renderingToggleMenus: (C Q)
:param riggingOnlyMenus: (C Q)
:param riggingToggleMenus: (C Q)
:param rmbPopups: (C Q) Enables/Disables a popup menu of the current function set This
popup menu appear when the right mouse button is pressed in the center zone of the ho
:param showAllToggleMenus: (C Q) Sets the visibility of all menus to on or off When
queried, will only return true if all menu rows are visible
:param surfacesOnlyMenus: (C Q)
:param surfacesToggleMenus: (C Q)
:param transparenyLevel: (C Q) The percentage of transparency, from 0 to 100 Currently,
only the values 0, 25, 50, 75 and 100 are supported Any other values will be rounded off
t
:param updateMenus: (C) Reloads the hotBox menus from the main menubar This flag is used
when the menus in the main menubar are modified, and the hotBox menus need to be re
:returns:
"""
pass
def FBXImportResamplingRateSource(*args, **kwargs)->None:
"""
"""
pass
def melInfo(*args, **kwargs)->List[AnyStr]:
"""
This command returns the names of all global MEL procedures that are currently defined as a
string array The user can query the definition of each MEL procedure using the "whatIs"
command
:returns: procedure names
"""
pass
def Undo(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyRemoveAllCrease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteVertex(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyInstallAction(*args, commandName: bool=True, convertSelection: bool=True,
installConstraint: bool=True, installDisplay: bool=True, keepInstances:
bool=True, uninstallConstraint: bool=True, uninstallDisplay: bool=True,
q=True, query=True, **kwargs)->Union[List[AnyStr], Any]:
"""
Installs/uninstalls several things to help the user to perform the specified action :
Pickmask Internal selection constraints Display attributes
:param commandName: (Q) return as a string the name of the command previously installed
:param convertSelection: (C) convert all polys selected in object mode into their full
matching component selection For example : if a polyMesh is selected, polyInstallAction
-c
:param installConstraint: (C Q) C: install selection pickmask and internal constraints for
actionname Q: returns 1 if any internal constraint is set for current action
:param installDisplay: (C Q) C: install display attributes for actionname Q: returns 1 if
any display is set for current action
:param keepInstances: (C) Convert components for all selected instances rather than only
the first selected instance
:param uninstallConstraint: (C) uninstall internal constraints previously installed
:param uninstallDisplay: (C) uninstall display attributes previously installed
:returns: When installing constraint, returns as an array of strings the
items on which the
installed command will act on. otherwise, returns nothing
"""
pass
def StitchEdgesTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShelfPreferencesWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CutPolygonOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportConvertDeformingNullsToJoint(*args, **kwargs)->None:
"""
"""
pass
def createNode(*args, name: AnyStr="", parent: AnyStr="", shared: bool=True, skipSelect:
bool=True, **kwargs)->AnyStr:
"""
This command creates a new node in the dependency graph of the specified type
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param parent: (C) Specifies the parent in the DAG under which the new node belongs
:param shared: (C) This node is shared across multiple files, so only create it if it does
not already exist
:param skipSelect: (C) This node is not to be selected after creation, the original
selection will be preserved
:returns: The name of the new node.
"""
pass
def evalEcho(*args, **kwargs)->None:
"""
"""
pass
def dynExport(*args, allObjects: bool=True, attribute: Union[AnyStr, List[AnyStr]]="", format:
AnyStr="", maxFrame: time=None, minFrame: time=None, onlyUpdateParticles:
bool=True, overSampling: int=0, path: AnyStr="", **kwargs)->AnyStr:
"""
Export particle data to disk files For cache export (-format cache), dynExport also sets
three attributes of the current dynGlobals node It sets the useParticleRenderCache
attribute to true, and the min/maxFrameOfLastParticleRenderCache attributes to correspond
to the min and max frames Exported .pda or .pdb files are assigned a name of form o
:param allObjects: (C) Ignore the selection list and export all particle objects If you
also specify an object name, the -all flag will be ignored
:param attribute: (C M) Name of attribute to be exported If any specified object does not
have one of the specified attributes, dynExport will issue an error and not do the
:param format: (C) Desired format: "binary" ("pdb"), "ascii" ("pda"), or "cache" ("pdc")
The pdc format is for use by the Maya particle system to cache particle data
:param maxFrame: (C) Ending frame to be exported
:param minFrame: (C) Starting frame to be exported The export operation will play the
scene through from min frame to max frame as it exports
:param onlyUpdateParticles: (C) Specify to only update the particles before exporting
:param overSampling: (C) OverSampling to be used during export
:param path: (C) This option allows you to specify a subdirectory of the workspace
"particles" directory where you want the exported files to be stored By default, f
:returns: Path to the exported files
"""
pass
def SetMeshSmoothTargetTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def move(*args, absolute: bool=True, componentOffset: bool=True, componentSpace: bool=True,
constrainAlongNormal: bool=True, deletePriorHistory: bool=True, localSpace: bool=True,
moveX: bool=True, moveXY: bool=True, moveXYZ: bool=True, moveXZ: bool=True, moveY:
bool=True, moveYZ: bool=True, moveZ: bool=True, objectSpace: bool=True, orientJoint:
AnyStr="", parameter: bool=True, preserveChildPosition: bool=False,
preserveGeometryPosition: bool=False, preserveUV: bool=False, reflection: bool=True,
reflectionAboutBBox: bool=True, reflectionAboutOrigin: bool=True, reflectionAboutX:
bool=True, reflectionAboutY: bool=True, reflectionAboutZ: bool=True,
reflectionTolerance: float=0.0, relative: bool=True, rotatePivotRelative: bool=True,
scalePivotRelative: bool=True, secondaryAxisOrient: AnyStr="", symNegative: bool=True,
worldSpace: bool=True, worldSpaceDistance: bool=True, xformConstraint: AnyStr="",
**kwargs)->None:
"""
The move command is used to change the positions of geometric objects The default
behaviour, when no objects or flags are passed, is to do a absolute move on each currently
selected object in the world space The value of the coordinates are interpreted as being
defined in the current linear unit unless the unit is explicitly mentioned When usi
:param absolute: (C) Perform an absolute operation
:param componentOffset: (C) Move components individually in local space
:param componentSpace: (C) Move in local component space
:param constrainAlongNormal: (C) When true, transform constraints are applied along the
vertex normal first and only use the closest point when no intersection is found along the
nor
:param deletePriorHistory: (C) If true then delete the history prior to the current
operation
:param localSpace: (C) Move in local space
:param moveX: (C) Move in X direction
:param moveXY: (C) Move in XY direction
:param moveXYZ: (C) Move in all directions (default)
:param moveXZ: (C) Move in XZ direction
:param moveY: (C) Move in Y direction
:param moveYZ: (C) Move in YZ direction
:param moveZ: (C) Move in Z direction
:param objectSpace: (C) Move in object space
:param orientJoint: (C) Default is xyz
:param parameter: (C) Move in parametric space
:param preserveChildPosition: (C) When true, transforming an object will apply an opposite
transform to its child transform to keep them at the same world-space position Default is
f
:param preserveGeometryPosition: (C) When true, transforming an object will apply an
opposite transform to its geometry points to keep them at the same world-space position
Default is f
:param preserveUV: (C) When true, UV values on translated components are projected along
the translation in 3d space For small edits, this will freeze the world space text
:param reflection: (C) To move the corresponding symmetric components also
:param reflectionAboutBBox: (C) Sets the position of the reflection axis at the geometry
bounding box
:param reflectionAboutOrigin: (C) Sets the position of the reflection axis at the origin
:param reflectionAboutX: (C) Specifies the X=0 as reflection plane
:param reflectionAboutY: (C) Specifies the Y=0 as reflection plane
:param reflectionAboutZ: (C) Specifies the Z=0 as reflection plane
:param reflectionTolerance: (C) Specifies the tolerance to findout the corresponding
reflected components
:param relative: (C) Perform a operation relative to the object's current position
:param rotatePivotRelative: (C) Move relative to the object's rotate pivot point
:param scalePivotRelative: (C) Move relative to the object's scale pivot point
:param secondaryAxisOrient: (C) Default is xyz
:param symNegative: (C) When set the component transformation is flipped so it is relative
to the negative side of the symmetry plane The default (no flag) is to transform
:param worldSpace: (C) Move in world space
:param worldSpaceDistance: (C) Move is specified in world space units
:param xformConstraint: (C) Apply a transform constraint to moving components none - no
constraint surface - constrain components to the surface edge - constrain components to
:returns:
"""
pass
def toolDropped(*args, **kwargs)->None:
"""
This command builds and executes the commands necessary to recreate the specified tool
button It is invoked when a tool is dropped on the shelf
:returns:
"""
pass
def soundControl(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, beginScrub: bool=True, defineTemplate: AnyStr="",
displaySound: bool=True, docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, endScrub: bool=True, exists:
bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, manage: bool=True, maxTime: Union[time, bool]=None, minTime:
Union[time, bool]=None, noBackground: bool=True, numberOfPopupMenus: bool=True,
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, pressCommand:
AnyStr="", preventOverride: bool=True, releaseCommand: AnyStr="",
repeatChunkSize: Union[float, bool]=1.0, repeatOnHold: bool=True, resample:
bool=True, sound: Union[AnyStr, bool]="", statusBarMessage: AnyStr="",
useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, waveform: Union[AnyStr, bool]="top", width: Union[int, bool]=0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a control used for changing current time and scratching/scrubbing
through sound files
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param beginScrub: (E) Set this widget up for sound scrubbing Subsequent changes to
current time will result in "sound scrubbing" behavior, until the "-endScrub" command i
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param displaySound: (Q E) Turn sound display off Query returns int
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param endScrub: (E) End sound scubbing for this widget This stops sound scrubbing
behavior and should be issued before any subsequent "-beginScrub" flags
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxTime: (C Q E) Controls the max time of the range displayed in the control Query
returns float
:param minTime: (C Q E) Controls the min time of the range displayed in the control Query
returns float
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param pressCommand: (C E) script to run on mouse-down in this control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param releaseCommand: (C E) script to run on mouse-up in this control
:param repeatChunkSize: (Q E) How much sound (in the current time unit) is repeated when
-repeatOnHold is true Default is 1.0
:param repeatOnHold: (Q E) Repeat sound during mouse-down events
:param resample: (E) Resample the sound display to fit the widget
:param sound: (Q E) Name of audio depend node whose data should display in the
sound-display widget Query returns string
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param waveform: (Q E) Determines what part of the sound waveform to display, when
-displaySound is "true" Valid values are "top", "bottom", and "both" Default is "top"
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Name of created or edited control.
"""
pass
def createRenderLayer(*args, empty: bool=True, g: bool=True, makeCurrent: bool=True, name:
AnyStr="", noRecurse: bool=True, number: int=0, **kwargs)->AnyStr:
"""
Create a new render layer The render layer number will be assigned based on the first
unassigned number not less than the base index number found in the render layer global
parameters Normally all objects and their descendants will be added to the new render
layer but if '-noRecurse' is specified then only the objects themselves will be added On
:param empty: (C) If set then create an empty render layer The global flag or specified
member list will take precidence over use of this flag
:param g: (C) If set then create a layer that contains all DAG objects in the scene Any
future objects created will also automatically become members of this laye
:param makeCurrent: (C) If set then make the new render layer the current one
:param name: (C) Name of the new render layer being created
:param noRecurse: (C) If set then only add specified objects to the render layer Otherwise
all descendants will also be added
:param number: (C) Number for the new render layer being created
:returns: Name of render layer node that was created
"""
pass
def dgstats(*args, **kwargs)->None:
"""
"""
pass
def CreateSpotLightOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def clearShear(*args, **kwargs)->None:
"""
"""
pass
def joint(*args, absolute: bool=True, angleX: Union[float, bool]=0.0, angleY: Union[float,
bool]=0.0, angleZ: Union[float, bool]=0.0, assumePreferredAngles: bool=True,
automaticLimits: bool=True, children: bool=True, component: bool=True,
degreeOfFreedom: Union[AnyStr, bool]="", exists: Union[AnyStr, bool]="",
limitSwitchX: bool=True, limitSwitchY: bool=True, limitSwitchZ: bool=True, limitX:
Union[List[float, float], bool]=None, limitY: Union[List[float, float], bool]=None,
limitZ: Union[List[float, float], bool]=None, name: Union[AnyStr, bool]="",
orientJoint: AnyStr="", orientation: Union[List[float, float, float], bool]=None,
position: Union[List[float, float, float], bool]=None, radius: Union[float, bool]=0.0,
relative: bool=True, rotationOrder: Union[AnyStr, bool]="", scale: Union[List[float,
float, float], bool]=None, scaleCompensate: bool=True, scaleOrientation:
Union[List[float, float, float], bool]=None, secondaryAxisOrient: AnyStr="",
setPreferredAngles: bool=True, stiffnessX: Union[float, bool]=0.0, stiffnessY:
Union[float, bool]=0.0, stiffnessZ: Union[float, bool]=0.0, symmetry: bool=True,
symmetryAxis: AnyStr="", zeroScaleOrient: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The joint command is used to create, edit, and query, joints within Maya (The standard
edit(-e) and query(-q) flags are used for edit and query functions) If the object is not
specified, the currently selected object (dag object) will be used Multiple objects are
allowed only for the edit mode The same edit flags will be applied on all the joi
:param absolute: (C Q E) The joint center position is in absolute world coordinates (This
is the default.)
:param angleX: (C Q E) Set the x-axis angle When queried, this flag returns a float
:param angleY: (C Q E) Set the y-axis angle When queried, this flag returns a float
:param angleZ: (C Q E) Set the z-axis angle When queried, this flag returns a float
:param assumePreferredAngles: (E) Meaningful only in the edit mode It sets the joint
angles to the corresponding preferred angles
:param automaticLimits: (C) Meaningful only in edit mode It sets the joint to appropriate
hinge joint with joint limits It modifies the joint only if (a) it connects exactly t
:param children: (E) It tells the command to apply all the edit options not only to the
selected joints, but also to their descendent joints in the DAG
:param component: (C E) Use with the -position switch to position the joint relative to its
parent (like -relative) but to compute new positions for all children joints so t
:param degreeOfFreedom: (C Q E) Specifies the degrees of freedom for the IK Valid strings
consist of non-duplicate letters from x, y, and z The letters in the string indicate what
:param exists: (Q) Does the named joint exist? When queried, this flag returns a boolean
:param limitSwitchX: (C Q E) Use the limit the x-axis rotation? When queried, this flag
returns a boolean
:param limitSwitchY: (C Q E) Use the limit the y-axis rotation? When queried, this flag
returns a boolean
:param limitSwitchZ: (C Q E) Use the Limit the z-axis rotation? When queried, this flag
returns a boolean
:param limitX: (C Q E) Set lower and upper limits on the x-axis of rotation Also turns on
the joint limit When queried, this flag returns 2 floats
:param limitY: (C Q E) Set lower and upper limits on the y-axis of rotation Also turns on
the joint limit When queried, this flag returns 2 floats
:param limitZ: (C Q E) Set lower and upper limits on the z-axis of rotation Also turns on
the joint limit When queried, this flag returns 2 floats
:param name: (C Q E) Specifies the name of the joint When queried, this flag returns a
string
:param orientJoint: (E) The argument can be one of the following strings: xyz, yzx, zxy,
zyx, yxz, xzy, none It modifies the joint orientation and scale orientation so that
:param orientation: (C Q E) The joint orientation When queried, this flag returns 3
floats
:param position: (C Q E) Specifies the position of the center of the joint This position
may be relative to the joint's parent or in absolute world coordinates (see -r and -
:param radius: (C Q E) Specifies the joint radius
:param relative: (C Q E) The joint center position is relative to the joint's parent
:param rotationOrder: (C Q E) The rotation order of the joint The argument can be one of
the following strings: xyz, yzx, zxy, zyx, yxz, xzy
:param scale: (C Q E) Scale of the joint When queried, this flag returns 3 floats
:param scaleCompensate: (C Q E) It sets the scaleCompenstate attribute of the joint to the
given argument When this is true, the scale of the parent joint will be compensated befor
:param scaleOrientation: (C Q E) Set the orientation of the coordinate axes for scaling
When queried, this flag returns 3 floats
:param secondaryAxisOrient: (E) The argument can be one of the following strings: xup,
xdown, yup, ydown, zup, zdown, none This flag is used in conjunction with the
-oj/orientJoint
:param setPreferredAngles: (E) Meaningful only in the edit mode It sets the preferred
angles to the current joint angles
:param stiffnessX: (C Q E) Set the stiffness (from 0 to 100.0) for x-axis When queried,
this flag returns a float
:param stiffnessY: (C Q E) Set the stiffness (from 0 to 100.0) for y-axis When queried,
this flag returns a float
:param stiffnessZ: (C Q E) Set the stiffness (from 0 to 100.0) for z-axis When queried,
this flag returns a float
:param symmetry: (C E) Create a symmetric joint from the current joint
:param symmetryAxis: (C E) This flag specifies the axis used to mirror symmetric joints
Any combination of x, y, z can be used This option is only used when the symmetry flag
:param zeroScaleOrient: (E) It sets the scale orientation to zero and compensate the change
by modifing the translation and joint orientation for joint or rotation for general t
:returns: Command result
"""
pass
def revolve(*args, autoCorrectNormal: bool=False, axis: Union[List[float, float, float],
bool]=None, axisChoice: Union[int, bool]=0, axisX: Union[float, bool]=1, axisY:
Union[float, bool]=0, axisZ: Union[float, bool]=0, bridge: bool=False, caching:
bool=True, computePivotAndAxis: Union[int, bool]=0, degree: Union[int, bool]=3,
endSweep: Union[float, bool]=6.2831853, nodeState: Union[int, bool]=0, pivot:
Union[List[float, float, float], bool]=None, pivotX: Union[float, bool]=0, pivotY:
Union[float, bool]=0, pivotZ: Union[float, bool]=0, radius: Union[float, bool]=1,
radiusAnchor: Union[float, bool]=1, sections: Union[int, bool]=8, startSweep:
Union[float, bool]=0, tolerance: Union[float, bool]=0.01, useTolerance: bool=False,
constructionHistory: bool=True, name: AnyStr="", object: bool=True, polygon: int=0,
range: bool=True, rebuild: bool=True, useLocalPivot: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command creates a revolved surface by revolving the given profile curve about an axis
The profile curve can be a curve, curve-on-surface, surface isoparm, or trim edge
:param autoCorrectNormal: (C Q E) If this is set to true we will attempt to reverse the
direction of the axis in case it is necessary to do so for the surface normals to end up
pointi
:param axis: (C Q E) Revolve axis
:param axisChoice: (C Q E) Only used for computed axis/pivot case As we are computing the
axis for a planar curve, we have two choices for the major axis based axis We will c
:param axisX: (C Q E) X of the axis Default: 1
:param axisY: (C Q E) Y of the axis Default: 0
:param axisZ: (C Q E) Z of the axis Default: 0
:param bridge: (C Q E) If true, we will close a partial revolve to get a pie shaped surface
The surface will be closed, but not periodic the way it is in the full revolve
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param computePivotAndAxis: (C Q E) If this is set to 2, we will compute the axis, use the
curve position and radius to compute the pivot for the revolve internally The value of the
pi
:param degree: (C Q E) The degree of the resulting surface Default: 3
:param endSweep: (C Q E) The value for the end sweep angle, in the current units This must
be no more than the maximum, 360 degrees, or 2 Pi radians Default: 6.2831853
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pivot: (C Q E) Revolve pivot point
:param pivotX: (C Q E) X of the pivot Default: 0
:param pivotY: (C Q E) Y of the pivot Default: 0
:param pivotZ: (C Q E) Z of the pivot Default: 0
:param radius: (C Q E) The pivot point will be this distance away from the bounding box of
the curve, if computedPivot is set to true The value of the pivot attribute is i
:param radiusAnchor: (C Q E) The position on the curve for the anchor point so that we can
compute the pivot using the radius value If in 0 - 1 range, its on the curve, normaliz
:param sections: (C Q E) Number of sections of the resulting surface (if tolerance is not
used) Default: 8
:param startSweep: (C Q E) The value for the start sweep angle, in the current units This
must be no more than the maximum, 360 degrees, or 2 Pi radians Default: 0
:param tolerance: (C Q E) Tolerance to build to (if useTolerance attribute is set) Default:
0.01
:param useTolerance: (C Q E) Use the tolerance, or the number of sections to control the
sections Default: false
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param polygon: (C) The value of this argument controls the type of the object created by
this operation 0: nurbs surface 1: polygon (use nurbsToPolygonsPref to set the
:param range: (C) Force a curve range on complete input curve
:param rebuild: (C) Rebuild the input curve(s) before using them in the operation Use
nurbsCurveRebuildPref to set the parameters for the conversion
:param useLocalPivot: (C Q E) If true, then the pivot of the profile curve is used as the
start point of the axis of revolution
:returns: Object name and node name
"""
pass
def SelectUVBorder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CopyKeysOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def texCutContext(*args, adjustSize: bool=True, displayShellBorders: bool=True,
edgeSelectSensitive: Union[float, bool]=0.0, exists: bool=True, history:
bool=True, image1: Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="",
image3: Union[AnyStr, bool]="", mode: Union[AnyStr, bool]="", moveRatio:
Union[float, bool]=0.0, name: AnyStr="", size: Union[float, bool]=0.0,
steadyStroke: bool=True, steadyStrokeDistance: Union[float, bool]=0.0,
touchToSew: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[float, Any]:
"""
This command creates a context for cut uv tool This context only works in the UV editor
:param adjustSize: (E) If true, puts the tool into the mode where dragging the mouse will
edit the brush size If false, puts the tool back into the previous mode
:param displayShellBorders: (Q E) Toggle the display of shell borders
:param edgeSelectSensitive: (Q E) Set the value of the edge selection sensitivity
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param mode: (Q E) Specifies the type of effect the brush will perform, Cut or Sew
:param moveRatio: (Q E) The cut open ratio relative to edge length
:param name: (C) If this is a tool command, name the tool appropriately
:param size: (Q E) Brush size value of the brush ring
:param steadyStroke: (Q E) Turn on steady stroke or not
:param steadyStrokeDistance: (Q E) The distance for steady stroke
:param touchToSew: (Q E) Toggle the touch to sew mode
:returns: Size of the brush rung, when querying brushSize
"""
pass
def ToggleVertMetadata(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def spotLight(*args, barnDoors: bool=True, bottomBarnDoorAngle: Union[float, bool]=0.0,
coneAngle: Union[float, bool]=0.0, decayRate: int=0, discRadius: Union[float,
bool]=0.0, dropOff: Union[float, bool]=0.0, exclusive: bool=True, intensity:
Union[float, bool]=0.0, leftBarnDoorAngle: Union[float, bool]=0.0, name:
Union[AnyStr, bool]="", penumbra: Union[float, bool]=0.0, position:
Union[List[float, float, float], bool]=None, rgb: Union[List[float, float, float],
bool]=None, rightBarnDoorAngle: Union[float, bool]=0.0, rotation:
Union[List[float, float, float], bool]=None, shadowColor: Union[List[float, float,
float], bool]=None, shadowDither: Union[float, bool]=0.0, shadowSamples:
Union[int, bool]=0, softShadow: bool=True, topBarnDoorAngle: Union[float,
bool]=0.0, useRayTraceShadows: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
TlightCmd is the base class for other light commands TnonAmbientLightCmd is a class that
looks like a command but is not It is a base class for the extended/nonExtended lights
TnonExtendedLightCmd is a base class and not a real command It is inherited by several
lights: TpointLight, TdirectionalLight, TspotLight etc The spotLight command is us
:param barnDoors: (C Q E) Are the barn doors enabled?
:param bottomBarnDoorAngle: (C Q E) Angle of the bottom of the barn door
:param coneAngle: (C Q E) angle of the spotLight
:param decayRate: (C) Decay rate of the light (0-no decay, 1-slow, 2-realistic, 3-fast)
:param discRadius: (C Q) Radius of shadow disc
:param dropOff: (C Q E) dropOff of the spotLight
:param exclusive: (C Q) True if the light is exclusively assigned
:param intensity: (C Q) Intensity of the light
:param leftBarnDoorAngle: (C Q E) Angle of the left of the barn door
:param name: (C Q) Name of the light
:param penumbra: (C Q E) specify penumbra region
:param position: (C Q) Position of the light
:param rgb: (C Q) RGB colour of the light
:param rightBarnDoorAngle: (C Q E) Angle of the right of the barn door
:param rotation: (C Q) Rotation of the light for orientation, where applicable
:param shadowColor: (C Q) Color of the light's shadow
:param shadowDither: (C Q) Shadow dithering value
:param shadowSamples: (C Q) Numbr of shadow samples to use
:param softShadow: (C Q) True if soft shadowing is to be enabled
:param topBarnDoorAngle: (C Q E) Angle of the top of the barn door
:param useRayTraceShadows: (C Q) True if ray trace shadows are to be used
:returns: Light shape name
boolean Barn door enabled state
angle Left barn door angle
angle
Right barn door angle
angle Top barn door angle
angle Bottom barn door angle
angle Cone
angle
angle Penumbra angle
float Dropoff value
"""
pass
def subdTransferUVsToCache(*args, **kwargs)->bool:
"""
The subdivision surface finer level uvs will get copied to the polygonToSubd node sent in
as argument
:returns: Command result
"""
pass
def untrim(*args, caching: bool=True, nodeState: Union[int, bool]=0, constructionHistory:
bool=True, curveOnSurface: bool=True, name: AnyStr="", noChanges: bool=True, object:
bool=True, replaceOriginal: bool=True, untrimAll: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
Untrim the surface
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param constructionHistory: (C) Turn the construction history on or off
:param curveOnSurface: (C) If possible, create 2D curve as a result
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param noChanges: (C Q E) If set then the operation node will be automatically put into
pass-through mode
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:param untrimAll: (Q E) if true, untrim all the trims for the surface else untrim only the
last trim
:returns: Object name and node name
"""
pass
def Unparent(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonTorus(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UnfoldPackUVs3DInCurrentTile(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ScaleToolWithSnapMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectSharedColorInstances(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveJoint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateReference(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorDiveIntoCompound(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBifrostAdaptiveMesh(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def igBrushContext(*args, **kwargs)->None:
"""
"""
pass
def CreatePolygonPrismOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dynTestData(*args, **kwargs)->None:
"""
"""
pass
def dR_setRelaxAffectsInterior(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddBifrostCollider(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SmoothProxyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateCurveFromPolyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PointOnPolyConstraint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InsertJointTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def deformerWeights(*args, attribute: Union[AnyStr, List[AnyStr], bool]="", defaultValue:
Union[float, bool]=0.0, deformer: Union[AnyStr, List[AnyStr], bool]="",
export: bool=True, format: Union[AnyStr, bool]="", ignoreName: bool=True,
im: bool=True, method: Union[AnyStr, bool]="", path: Union[AnyStr, bool]="",
positionTolerance: Union[float, bool]=0.0, remap: Union[AnyStr,
List[AnyStr], bool]="", shape: Union[AnyStr, List[AnyStr], bool]="", skip:
Union[AnyStr, List[AnyStr], bool]="", vertexConnections: bool=True,
weightPrecision: Union[int, bool]=0, weightTolerance: Union[float,
bool]=0.0, worldSpace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Command to import and export deformer weights to and from a simple XML file The weight
data is stored in a per-vertex fashion along with a "point cloud" corresponding to the
vertices from the geometry input to the deformer For example a cluster deformer would have
the following information: On import the weights are then mapped back to a specif
:param attribute: (C Q E M) Specify the long name of deformer attribute that should be
imported/exported along with the deformerWeights i.e -at "envelope" -at "skinningMethod"
:param defaultValue: (C Q E) Manually set the default value Default values are values that
are not written to file For example, for blendShapes the default value is automatical
:param deformer: (C Q E M) Specify the deformer whose weights should be exported or
imported If a pattern is supplied for the deformer name (i.e: cluster*), only the first
def
:param export: (C Q E) Export the given deformer
:param format: (C Q E) Specify either "XML" or "JSON" as the file extension to save as
:param ignoreName: (C Q E) Ignore the names of the layers on import, just use the order of
the layers instead This can be used when joint names have been changed Leaving it o
:param im: (C Q E) Import weights to the specified deformer See the method flag for
details on how the weights will be mapped to the destination deformer
:param method: (C Q E) Specify the method used to map the weight during import Valid
values are: "index", "nearest", "barycentric", "bilinear" and "over" The "index" meth
:param path: (C Q E) The path to the given file Default to the current project
:param positionTolerance: (C Q E) The position tolerance is used to determine the radius of
search for the nearest method This flag is only used with import Defaults to a huge
numbe
:param remap: (C Q E M) Remap maps source regular expression to destination format It maps
any name that matches the regular expression (before the semi-colon) to the expre
:param shape: (C Q E M) Specify the source shape Export will write out all the deformers
on the shape node into one file If a pattern is supplied for the shape name (i.e:
:param skip: (C Q E M) Skip any deformer, shape, or layer that whose name matches the given
regular expression string
:param vertexConnections: (C Q E) Export vertex connection information, which is required
for -m/-method "barycentric" and "bilinear" The flag is only used with -ex/-export flag
The
:param weightPrecision: (C Q E) Sets the output decimal precision for exported weights The
default value is 3
:param weightTolerance: (C Q E) The weight tolerance is used to decide if a given weight
value is close enough to the default value that it does not need to be included This flag
i
:param worldSpace: (C Q E) For spatially based association methods (nearest), the position
should be based on the world space position rather then the local object space
:returns: path to the file imported/exported, if successful
"""
pass
def MatchRotation(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportBakeComplexEnd(*args, **kwargs)->None:
"""
"""
pass
def ParameterTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nodeIconButton(*args, align: Union[AnyStr, bool]="", annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None, command:
Union[Script, bool]=None, defineTemplate: AnyStr="", disabledImage:
Union[AnyStr, bool]="", docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, flipX:
bool=True, flipY: bool=True, font: Union[AnyStr, bool]="", fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float,
float, float], bool]=None, image: Union[AnyStr, bool]="", image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", imageOverlayLabel: Union[AnyStr, bool]="", isObscured: bool=True,
label: Union[AnyStr, bool]="", labelOffset: Union[int, bool]=0, ltVersion:
Union[AnyStr, bool]="", manage: bool=True, marginHeight: Union[int, bool]=0,
marginWidth: Union[int, bool]=0, noBackground: bool=True,
numberOfPopupMenus: bool=True, overlayLabelBackColor: Union[List[float,
float, float, float], bool]=None, overlayLabelColor: Union[List[float, float,
float], bool]=None, parent: Union[AnyStr, bool]="", popupMenuArray:
bool=True, preventOverride: bool=True, rotation: Union[float, bool]=0.0,
statusBarMessage: AnyStr="", style: Union[AnyStr, bool]="", useAlpha:
bool=True, useTemplate: AnyStr="", version: Union[AnyStr, bool]="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This control supports up to 3 icon images and 4 different display styles The icon image
displayed is the one that best fits the current size of the control given its current style
This command creates a button that can be displayed with different icons, with or without
a text label If the button is drag and dropped onto other controls (e.g., Hy
:param align: (C Q E) The label alignment Alignment values are "left", "right", and
"center" By default, the label is aligned "center" Currently only available when -st
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param command: (C Q E) Command executed when the control is pressed The command should
return a string which will be used to facilitate node drag and drop
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param disabledImage: (C Q E) Image used when the button is disabled Image size must be
the same as the image specified with the i/image flag This is a Windows only flag
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param flipX: (C Q E) Is the image flipped horizontally?
:param flipY: (C Q E) Is the image flipped vertically?
:param font: (C Q E) The font for the text Valid values are "boldLabelFont",
"smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont",
"oblique
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param image: (C Q E) If you are not providing images with different sizes then you may use
this flag for the control's image If the "iconOnly" style is set, the icon wil
:param image1: (C Q E) First of three possible icons The icon that best fits the current
size of the control will be displayed
:param image2: (C Q E) Second of three possible icons The icon that best fits the current
size of the control will be displayed
:param image3: (C Q E) Third of three possible icons The icon that best fits the current
size of the control will be displayed
:param imageOverlayLabel: (C Q E) A short string, up to 6 characters, representing a label
that will be displayed on top of the image
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C Q E) The text that appears in the control
:param labelOffset: (C Q E) The label offset Default is 0 Currently only available when
-st/style is set to "iconAndTextCentered"
:param ltVersion: (C Q E) This flag is used to specify the Maya LT version that this
control feature was introduced, if the version flag is not specified, or if the version fl
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param marginHeight: (C Q E) The number of pixels above and below the control content The
default value is 1 pixel
:param marginWidth: (C Q E) The number of pixels on either side of the control content The
default value is 1 pixel
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param overlayLabelBackColor: (C Q E) The RGBA color of the shadow behind the label defined
by imageOverlayLabel Default is 50% transparent black: 0 0 0 .5
:param overlayLabelColor: (C Q E) The RGB color of the label defined by imageOverlayLabel
Default is a light grey: .8 .8 .8
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rotation: (C Q E) The rotation value of the image in radians
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param style: (C Q E) The draw style of the control Valid styles are "iconOnly",
"textOnly", "iconAndTextHorizontal", "iconAndTextVertical", and "iconAndTextCentered" (N
:param useAlpha: (C Q E) Is the image using alpha channel?
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param version: (C Q E) Specify the version that this control feature was introduced The
argument should be given as a string of the version number (e.g "2013", "2014") C
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the button
"""
pass
def PaintEffectsToCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorToggleExtendParentsPress(*args, **kwargs)->None:
"""
unknown
"""
pass
def PasteSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def movIn(*args, file: AnyStr="", startTime: time=None, **kwargs)->None:
"""
Imports a .mov file into animation curves connected to the listed attributes The attribute
must be writable, since an animation curve will be created and connected to the attribute
If an animation curve already is connected to the attribute, the imported data is pasted
onto that curve The starting time used for the .mov file importation is the
:param file: (C) The name of the .mov file If no extension is used, a .mov will be added
:param startTime: (C) The default start time for importing the .mov file is the current
time The startTime option sets the starting time for the .mov data in the current
:returns:
"""
pass
def SplitMeshWithProjectedCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddHolder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgExpressionEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CenterPivot(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyCheck(*args, edge: bool=True, face: bool=True, faceOffset: bool=True, openFile:
AnyStr="", **kwargs)->int:
"""
Dumps a description of internal memory representation of poly objects
:param edge: (C) Check edge descriptions If no flag is set, a complete check is performed
:param face: (C) Check face descriptions If no flag is set, a complete check is performed
:param faceOffset: (C) Check face offset descriptions If no flag is set, a complete check
is performed
:param openFile: (C) Opens a file that contains a poly description, as dumped out by the
debug commands
:returns: The number of errors.
"""
pass
def DeleteAllClips(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeRenderTextureRangeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NURBSSmoothnessFine(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def customerInvolvementProgram(*args, **kwargs)->None:
"""
"""
pass
def ReducePolygonOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateParticleDiskCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyCreateFacet(*args, constructionHistory: bool=True, hole: Union[bool, List[bool]]=True,
name: AnyStr="", point: Union[List[float, float, float], List[List[float,
float, float]]]=None, subdivision: Union[int, bool]=1, texture: Union[int,
bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
Create a new polygonal object with the specified face, which will be closed List of
arguments must have at least 3 points
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param hole: (C M) Add a hole The following points will define a hole Holes can be
defined either clockwise or counterclockwise Note that this flag is not recommende
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param point: (C M) Adds a new point to the face Coordinates of points are given in world
reference The point flag may also be passed with no arguments That indicates
:param subdivision: (C Q E) This flag specifies the level of subdivision Subdivides edges
into the given number of edges C: Default is 1 (no subdivision) Q: When queried, thi
:param texture: (C Q E) Specifies how the face is mapped 0 - None; 1 - Normalize; 2 -
Unitize C: Default is 0 (no mapping) Q: When queried, this flag returns an int
:returns: Object name and node name.
"""
pass
def rampWidgetAttrless(*args, **kwargs)->None:
"""
"""
pass
def DisableParticles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OpenVisorForMeshes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UpdateEraseSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddPointsTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def graphTrackCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr, bool]="",
image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", name:
AnyStr="", q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr,
Any]:
"""
This command can be used to create a track context for the graph editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Context name
"""
pass
def ArtPaintSkinWeightsToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorImportAnimation(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeDraggerToolDeactivate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nClothRemove(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FloatSelectedObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorExplodeCompound(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def intField(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dragCommand:
Script=None, dropCallback: Script=None, editable: bool=True, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, enterCommand:
Script=None, exists: bool=True, fullPathName: bool=True, height: Union[int,
bool]=0, highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, manage: bool=True, maxValue: Union[int, bool]=0, minValue: Union[int,
bool]=0, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
receiveFocusCommand: Script=None, statusBarMessage: AnyStr="", step: Union[int,
bool]=0, useTemplate: AnyStr="", value: Union[int, bool]=0, visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a field control that accepts only integer values and is bound by a minimum and
maximum value An invisible slider is attached to the field and accessed by holding down
the Ctrl modifier key while pressing one of the mouse buttons Dragging the invisible
slider to the right with the middle mouse button increases the field value by the amount
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the value changes This command is not
invoked when the value changes via the -v/value flag
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command executed when the value changes by dragging the invisible
slider
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editable: (C Q E) The edit state of the field By default, this flag is set to true
and the field value may be changed by typing into it If false then the field is 'r
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param enterCommand: (C E) Command executed when the keypad 'Enter' key is pressed
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxValue: (C Q E) Upper limit of the field
:param minValue: (C Q E) Lower limit of the field
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param receiveFocusCommand: (C E) Command executed when the field receives focus
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) Increment for the invisible slider The field value will change by
this amount when the invisible slider is dragged
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Value of the field
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def HideLightManipulators(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_setExtendBorder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Create2DContainerEmitterOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NURBSSmoothnessMedium(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Smoke(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateGhost(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TexSculptDeactivateBrushSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def LowQualityDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateIllustratorCurvesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeToggleUseAssetsAndPublishedAttributes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVSetEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_GetAllInputsFromSubstanceNode(*args, **kwargs)->None:
"""
"""
pass
def unassignInputDevice(*args, clutch: AnyStr="", device: AnyStr="", q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command deletes all command strings associated with this device
:param clutch: (C) Only delete command attachments with this clutch
:param device: (C) Specifies the device to work on
:returns:
"""
pass
def dR_selectModeTweakMarquee(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BrushPresetBlendShading(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetDensityBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def mouldSubdiv(*args, **kwargs)->None:
"""
"""
pass
def removeListItem(*args, **kwargs)->None:
"""
"""
pass
def loadFluid(*args, currentTime: bool=True, frame: Union[float, bool]=0.0, initialConditions:
bool=True, q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
A command to set builtin fluid attributes such as Density, Velocity, etc for all cells in
the grid from the initial state cache
:param currentTime: (C Q E) This flag is now obsolete Move the cache clip in the Trax
editor to view different frames of the playback cache
:param frame: (C Q E) This flag is now obsolete Move the cache clip in the Trax editor to
view different frames of the playback cache
:param initialConditions: (C Q E) load initial conditions cache
:returns:
"""
pass
def AddBoatLocator(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AddFaceDivisions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveBifrostField(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def QualityDisplayMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DetachComponent(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmDraRender(*args, **kwargs)->None:
"""
"""
pass
def DisableSnapshots(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_convertSelectionToFace(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def trimCtx(*args, **kwargs)->None:
"""
"""
pass
def polyUVCoverage(*args, uvRange: List[float, float, float, float]=None,
**kwargs)->List[float]:
"""
Return the UV space coverage of the specified components
:param uvRange: (C) UV space range for calculating the coverage The 4 values specify the
minimum U, V and maximum U, V in that order Default is 0.0 0.0 1.0 1.0
:returns: UV space coverage percentage
"""
pass
def dR_selConstraintUVEdgeLoop(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FitBSplineOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ReassignBoneLatticeJoint(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EnableIKSolvers(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def symmetrizeUV(*args, **kwargs)->None:
"""
"""
pass
def AddCombinationTargetOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artAttrSkinPaintCtx(*args, accopacity: bool=False, activeListChangedProc: Union[AnyStr,
bool]="", afterStrokeCmd: Union[AnyStr, bool]="", alphaclamp:
Union[AnyStr, bool]="none", alphaclamplower: Union[float, bool]=0.0,
alphaclampupper: Union[float, bool]=1.0, attrSelected: Union[AnyStr,
bool]="", beforeStrokeCmd: Union[AnyStr, bool]="", brushalignment:
bool=True, brushfeedback: bool=True, clamp: Union[AnyStr, bool]="none",
clamplower: Union[float, bool]=0.0, clampupper: Union[float, bool]=1.0,
clear: bool=True, colorAlphaValue: Union[float, bool]=0.0,
colorRGBAValue: Union[List[float, float, float, float], bool]=None,
colorRGBValue: Union[List[float, float, float], bool]=None, colorRamp:
Union[AnyStr, bool]="", colorfeedback: bool=False,
colorfeedbackOverride: bool=False, colorrangelower: Union[float,
bool]=0.0, colorrangeupper: Union[float, bool]=1.0, dataTypeIndex:
Union[int, bool]=0, disablelighting: bool=False, dragSlider: AnyStr="",
duringStrokeCmd: Union[AnyStr, bool]="", dynclonemode: bool=True,
exists: bool=True, expandfilename: bool=True, exportaspectratio:
Union[float, bool]=0.0, exportfilemode: Union[AnyStr,
bool]="luminance/rgb", exportfilesave: AnyStr="", exportfilesizex:
Union[int, bool]=0, exportfilesizey: Union[int, bool]=0,
exportfiletype: Union[AnyStr, bool]="", filterNodes: bool=True,
history: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", importfileload:
AnyStr="", importfilemode: Union[AnyStr, bool]="alpha", importreassign:
bool=False, influence: Union[AnyStr, bool]="", interactiveUpdate:
bool=True, lastRecorderCmd: Union[AnyStr, bool]="", lastStampName:
Union[AnyStr, bool]="", lowerradius: Union[float, bool]=0.0,
makeStroke: Union[int, List[int], bool]=0, mappressure: Union[AnyStr,
bool]="none", maxvalue: Union[float, bool]=1.0, minvalue: Union[float,
bool]=0.0, name: AnyStr="", objattrArray: Union[AnyStr, bool]="",
opacity: Union[float, bool]=1.0, outline: bool=True, outwhilepaint:
bool=False, paintNodeArray: Union[AnyStr, bool]="", paintSelectMode:
Union[int, bool]=0, paintattrselected: AnyStr="", paintmode:
Union[AnyStr, bool]="screen", paintoperationtype: Union[AnyStr,
bool]="Paint", pickColor: bool=True, pickValue: bool=True,
playbackCursor: Union[List[float, float], List[List[float, float]],
bool]=None, playbackPressure: Union[float, List[float], bool]=0.0,
preserveclonesource: bool=True, profileShapeFile: Union[AnyStr,
bool]="", projective: bool=False, radius: Union[float, bool]=1.0,
rampMaxColor: Union[List[float, float, float], bool]=None,
rampMinColor: Union[List[float, float, float], bool]=None, record:
bool=True, reflection: bool=False, reflectionaboutorigin: bool=True,
reflectionaxis: Union[AnyStr, bool]="x", screenRadius: Union[float,
bool]=0.0, selectclonesource: bool=True, selectedattroper: Union[AnyStr,
bool]="absolute", showactive: bool=True, skinPaintMode: Union[int,
bool]=0, stampDepth: Union[float, bool]=0.0, stampProfile: Union[AnyStr,
bool]="", stampSpacing: Union[float, bool]=1.0, strokesmooth:
Union[AnyStr, bool]="", surfaceConformedBrushVertices: bool=True,
tablet: bool=True, tangentOutline: bool=True, toolOffProc: Union[AnyStr,
bool]="", toolOnProc: Union[AnyStr, bool]="", useColorRamp: bool=True,
useMaxMinColor: bool=True, usepressure: bool=False, value: Union[float,
bool]=0.0, whichTool: Union[AnyStr, bool]="", worldRadius: Union[float,
bool]=0.0, xrayJoints: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This is a context command to set the flags on the artAttrContext, which is the base context
for attribute painting operations All commands require the name of the context as the last
argument as this provides the name of the context to create, edit or query This is a
context command to set the flags on the Paint skin weights tool context
:param accopacity: (C Q E) Sets opacity accumulation on/off C: Default is false (Except
for sculpt tool for which it is true by default) Q: When queried, it returns a boolean
:param activeListChangedProc: (C Q E) Accepts a string that contains a MEL command that is
invoked whenever the active list changes There may be some situations where the UI, for
example
:param afterStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
after the end of a stroke C: Default is no command Q: When queried, it returns the curre
:param alphaclamp: (C Q E) Specifies if the weight value should be alpha clamped to the
lower and upper bounds There are four options here: "none" - no clamping is performed,
:param alphaclamplower: (C Q E) Specifies the lower bound for the alpha values C: Default
is 0.0 Q: When queried, it returns a float
:param alphaclampupper: (C Q E) Specifies the upper bound for the alpha values C: Default
is 1.0 Q: When queried, it returns a float
:param attrSelected: (Q) Returns a name of the currently selected attribute Q: When
queried, it returns a string
:param beforeStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
before the start of a stroke C: Default is no command Q: When queried, it returns the cu
:param brushalignment: (C Q E) Specifies the path brush alignemnt If true, the brush will
align to stroke path, otherwise it will align to up vector C: Default is true Q: When q
:param brushfeedback: (C Q E) Specifies if the brush additional feedback should be drawn
C: Default is TRUE Q: When queried, it returns a boolean
:param clamp: (C Q E) Specifies if the weight value should be clamped to the lower and
upper bounds There are four options here: "none" - no clamping is performed, "lower
:param clamplower: (C Q E) Specifies the lower bound for the values C: Default is 0.0 Q:
When queried, it returns a float
:param clampupper: (C Q E) Specifies the upper bound for the values C: Default is 1.0 Q:
When queried, it returns a float
:param clear: (C E) Floods all cvs/vertices to the current value
:param colorAlphaValue: (C Q E) The Alpha value of the color
:param colorRGBAValue: (C Q E) The RGBA value of the color
:param colorRGBValue: (C Q E) The RGB value of the color
:param colorRamp: (C Q E) Allows a user defined color ramp to be used to map values to
colors
:param colorfeedback: (C Q E) Sets on/off the color feedback display C: Default is FALSE
Q: When queried, it returns a boolean
:param colorfeedbackOverride: (C Q E) Sets on/off the color feedback override C: Default
is FALSE Q: When queried, it returns a boolean
:param colorrangelower: (C Q E) Specifies the value that maps to black when color feedback
mode is on C: Default is 0.0 Q: When queried, it returns a float
:param colorrangeupper: (C Q E) Specifies the value that maps to the maximum color when
color feedback mode is on C: Default is 1.0 Q: When queried, it returns a float
:param dataTypeIndex: (Q E) When the selected paintable attribute is a vectorArray, it
specifies which field to paint on
:param disablelighting: (C Q E) If color feedback is on, this flag determines whether
lighting is disabled or not for the surfaces that are affected C: Default is FALSE Q:
When qu
:param dragSlider: (C E) Sets the current brush drag state for resizing or offsetting the
brush (like the 'b' and 'm' default hotkeys) The string argument is one of: "radius
:param duringStrokeCmd: (C Q E) The passed string is executed as a MEL command during the
stroke, each time the mouse is dragged C: Default is no command Q: When queried, it
retur
:param dynclonemode: (C Q E) Enable or disable dynamic clone mode
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param expandfilename: (C E) If true, it will expand the name of the export file and
concatenate it with the surface name Otherwise it will take the name as it is C: Default
is
:param exportaspectratio: (C Q E) Value of aspect ratio for export
:param exportfilemode: (C Q E) Specifies the export channel.The valid entries here are:
"alpha", "luminance", "rgb", "rgba" C: Default is "luminance/rgb" Q: When queried, it
retu
:param exportfilesave: (E) Exports the attribute map and saves to a specified file
:param exportfilesizex: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfilesizey: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfiletype: (C Q E) Specifies the image file format It can be one of the
following: "iff", "tiff", "jpeg", "alias", "rgb", "fit" "postScriptEPS", "softimage",
"wavefron
:param filterNodes: (E) Sets the node filter
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param importfileload: (E) Load the attribute map a specified file
:param importfilemode: (C Q E) Specifies the channel to import The valid entries here are:
"alpha", "luminance", "red", "green", "blue", and "rgb" C: Default is "alpha" Q: When q
:param importreassign: (C Q E) Specifies if the multiply atrribute maps are to be
reassigned while importing Only maps previously exported from within Artisan can be
reassigned C
:param influence: (Q E) Specifies which joint has been selected by the user for painting
Q: When queried, it returns a string
:param interactiveUpdate: (C Q E) Specifies how often to transfer the painted values into
the attribute TRUE: transfer them "continuously" (many times per stroke) FALSE: transfer
the
:param lastRecorderCmd: (C Q E) Value of last recorded command
:param lastStampName: (C Q E) Value of the last stamp name
:param lowerradius: (C Q E) Sets the lower size of the brush (only apply on tablet)
:param makeStroke: (C Q E M) Stroke point values
:param mappressure: (C Q E) Sets the tablet pressure mapping when the table is used There
are four options: "none" - the pressure has no effect, "opacity" - the pressure is map
:param maxvalue: (C Q E) Specifies the maximum value for each attribute C: Default is 1.0
Q: When queried, it returns a float
:param minvalue: (C Q E) Specifies the minimum value for each attribute C: Default is 0.0
Q: When queried, it returns a float
:param name: (C) If this is a tool command, name the tool appropriately
:param objattrArray: (Q) An array of all paintable attributes Each element of the array is
a string with the following information: NodeType.NodeName.AttributeName.MenuType
:param opacity: (C Q E) Sets the brush opacity C: Default is 1.0 Q: When queried, it
returns a float
:param outline: (C Q E) Specifies if the brush should be drawn C: Default is TRUE Q: When
queried, it returns a boolean
:param outwhilepaint: (C Q E) Specifies if the brush outline should be drawn while painting
C: Default is FALSE Q: When queried, it returns a boolean
:param paintNodeArray: (Q) An array of paintable nodes Q: When queried, it returns a
string
:param paintSelectMode: (Q E) Specifies whether the paint select tool: adds to selection
(1) removes from selection (2), toggles selection (3) Q: When queried, it returns an int a
:param paintattrselected: (E) An array of selected paintable attributes Each element of
the array is a string with the following information: NodeType.NodeName.AttributeName
:param paintmode: (C Q E) Specifies the paint mode There are two possibilities: "screen"
and "tangent" C: Default is "screen" Q: When queried, it returns a string
:param paintoperationtype: (C Q E) Specifies the operation type used by the Paint Tool
Currently, we support the following paint modes: "Paint", "Smear", "Blur", "Erase" and
"Clone"
:param pickColor: (C Q E) Set pick color mode on or off
:param pickValue: (C Q E) Toggle for picking
:param playbackCursor: (C Q E M) Values for the playback cursor
:param playbackPressure: (C Q E M) Valus for the playback pressure
:param preserveclonesource: (C Q E) Whether or not to preserve a clone source
:param profileShapeFile: (Q E) Passes a name of the image file for the stamp shape profile
:param projective: (C Q E) Specifies the projective paint mode C: Default is 'false' Q:
When queried, it returns a boolean
:param radius: (C Q E) Sets the size of the brush C: Default is 1.0 cm Q: When queried,
it returns a float
:param rampMaxColor: (C Q E) Defines a special color to be used when the value is greater
than or equal to the maximum value
:param rampMinColor: (C Q E) Defines a special color to be used when the value is less than
or equal to the minimum value
:param record: (C Q E) Toggle on for recording
:param reflection: (C Q E) Specifies the reflection mode C: Default is 'false' Q: When
queried, it returns a boolean
:param reflectionaboutorigin: (C Q E) Toggle on to reflect about the origin
:param reflectionaxis: (C Q E) Specifies the reflection axis There are three
possibilities: "x", "y" and "z" C: Default is "x" Q: When queried, it returns a string
:param screenRadius: (C Q E) Brush radius on the screen
:param selectclonesource: (C Q E) Toggle on to select the clone source
:param selectedattroper: (C Q E) Sets the edit weight operation Four edit weights
operations are provided : "absolute" - the value of the weight is replaced by the current
one, "add
:param showactive: (C Q E) Sets on/off the display of the surface isoparms C: Default is
TRUE Q: When queried, it returns a boolean
:param skinPaintMode: (Q E) Specifies whether the skin paint tool is in paint skin weights
mode (1) Marquee select mode (0), or paint select mode (2) Q: When queried, it returns
:param stampDepth: (C Q E) Depth of the stamps
:param stampProfile: (C Q E) Sets the brush profile of the current stamp Currently, the
following profiles are supported: "gaussian", "poly", "solid" and "square" C: Default is
:param stampSpacing: (C Q E) Specifies the stamp spacing Default is 1.0
:param strokesmooth: (C Q E) Stroke smoothing type name
:param surfaceConformedBrushVertices: (C Q E) Enables/disables the the display of the
effective brush area as affected vertices
:param tablet: (Q) Returns true if the tablet device is present, false if it is absent
:param tangentOutline: (C Q E) Enables/disables the display of the brush circle tangent to
the surface
:param toolOffProc: (C Q E) Accepts a strings describing the name of a MEL procedure that
is invoked whenever the tool is turned off For example, cloth invokes "clothPaintToolO
:param toolOnProc: (C Q E) Accepts a strings describing the name of a MEL procedure that is
invoked whenever the tool is turned on For example, cloth invokes "clothPaintToolOn
:param useColorRamp: (C Q E) Specifies whether the user defined color ramp should be used
to map values from to colors If this is turned off, the default greyscale feedback will
:param useMaxMinColor: (C Q E) Specifies whether the out of range colors should be used
See rampMinColor and rampMaxColor flags for further details
:param usepressure: (C Q E) Sets the tablet pressure on/off C: Default is false Q: When
queried, it returns a boolean
:param value: (C Q E) Specifies the value for each attribute C: Default is 0.0 Q: When
queried, it returns a float
:param whichTool: (C Q E) The string defines the name of the tool to be used for the
Artisan context An example is "artClothPaint" In query mode, the tool name for the given
:param worldRadius: (C Q E) Radius in worldspace
:param xrayJoints: (Q E) Specifies whether joints should be displayed in xray mode while
painting Q: When queried, it returns a boolean
:returns:
"""
pass
def RemoveBifrostFoamMask(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Boundary(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypergraphDGWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_bevelTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveConstraintTarget(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def iconTextRadioCollection(*args, collectionItemArray: bool=True, defineTemplate: AnyStr="",
disableCommands: bool=True, exists: bool=True, gl: bool=True,
numberOfCollectionItems: bool=True, parent: AnyStr="", select:
Union[AnyStr, bool]="", useTemplate: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a cluster for iconTextRadioButtons Clusters will be parented to the
current default layout if no parent is specified with the -p/parent flag As children of
the layout they will be deleted when the layout is deleted Clusters may also span more
than one window if the -g/global flag is used In this case the cluster has no pare
:param collectionItemArray: (Q) Returns a string list giving the long names of all the
items in this collection
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param disableCommands: (E) Allows a particular iconTextRadioButton in the collection to be
selected without invoking the commands attached to the -cc/changeCommand, -onc/onComm
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param gl: (C Q) Set the collection to have no parent layout If the collection has a
parent layout then it will be deleted with that layout, otherwise if it is speci
:param numberOfCollectionItems: (Q) Returns the number of items that are in this
collection
:param parent: (C) Set the specified layout to be the parent layout of the cluster
:param select: (C Q E) Select the specified collection item If queried will return the
name of the currently selected collection item
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: The name of the iconTextRadioCollection created.
"""
pass
def LevelOfDetailGroupOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ClearPaintEffectsView(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CurveFlow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleDisplayGradient(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ScriptPaintTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeEditTexture(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DetachCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def commandLine(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, command: Script=None, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, enterCommand: Script=None, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, holdFocus: bool=True,
inputAnnotation: Union[AnyStr, bool]="", isObscured: bool=True, manage:
bool=True, noBackground: bool=True, numberOfHistoryLines: Union[int, bool]=0,
numberOfPopupMenus: bool=True, outputAnnotation: Union[AnyStr, bool]="",
parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride:
bool=True, sourceType: Union[AnyStr, bool]="", statusBarMessage: AnyStr="",
useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a single line for command input/output.
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param command: (C E) Command executed when the command line text changes
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param enterCommand: (C E) Command executed when the keypad 'Enter' key is pressed
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param holdFocus: (C Q E) Sets whether the command line should hold focus after exectuing a
command
:param inputAnnotation: (C Q E) Annotate the input field with an extra string value
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfHistoryLines: (C Q E) Sets the maximum number of commands saved to the
command line history Up to -nhl/numberOfHistoryLines previous commands will be available
by pressin
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param outputAnnotation: (C Q E) Annotate the output field with an extra string value
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param sourceType: (C Q E) Sets the source type of this command line Currently supports
"mel" (enabled by default) and "python"
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: : Full path name to the control.
"""
pass
def DeleteAllExpressions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createPolyTorusCtx(*args, **kwargs)->None:
"""
"""
pass
def FBXExportCameras(*args, **kwargs)->None:
"""
"""
pass
def ToggleSceneTimecode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MergeVerticesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleFullScreenMode(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_viewFront(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def addIK2BsolverCallbacks(*args, **kwargs)->None:
"""
"""
pass
def AddPondBoatLocator(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def texTweakUVContext(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", position:
bool=True, tolerance: Union[float, bool]=0.0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create, edit, or query a texture editor move manip context
Note that the above flags control the global behaviour of all texture editor move manip
contexts Changing one context independently is not allowed Changing a context's behaviour
using the above flags, will change all existing texture editor move manip contexts
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param position: (Q) Returns the current position of the manipulator
:param tolerance: (C Q E) Controls the initial selection snapping tolerance
:returns: (the name of the new context)
"""
pass
def ShowCameras(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createNurbsSquareCtx(*args, **kwargs)->None:
"""
"""
pass
def MatchUVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVIsolateLoadSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyStraightenUVBorder(*args, blendOriginal: Union[float, bool]=0.0, caching: bool=True,
constructionHistory: bool=True, curvature: Union[float, bool]=0.0,
gapTolerance: Union[int, bool]=0, name: AnyStr="", nodeState:
Union[int, bool]=0, preserveLength: Union[float, bool]=0.0,
uvSetName: AnyStr="", worldSpace: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Move border UVs along a simple curve
:param blendOriginal: (C Q) Interpolation factor between the target and original UV shape
When the value is 0, the UVs will exactly fit the target curve When the value is 1, n
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param curvature: (C Q) How curved the UV path will be 0 is a straight line When the
values is 1, the mid point of the curve will be moved away from a straight line by 1/2
:param gapTolerance: (C Q) When non 0, Small gaps between UV selection are filled The
integer number represent how many UVs must be traversed to connect togeterh selected piec
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param preserveLength: (C Q) How much we want to respect the UV edge ratios When the value
is 1, we build new UV position along the desired curve, respecting the original UV spa
:param uvSetName: (C) Name of the UV set to be created
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name
"""
pass
def TexSculptActivateBrushSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectMaskToolMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVCylindricProjectionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateNURBSConeOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artAttrSkinPaintCmd(*args, **kwargs)->None:
"""
"""
pass
def ConvertSelectionToFaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorSetTraversalDepthUnlim(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ScriptEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GameExporterWnd(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OptimizeScene(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SubdivSmoothnessMedium(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SurfaceEditingToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeConvertPSDToLayeredTexture(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OffsetCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphSnap(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def deltaMush(*args, after: bool=True, afterReference: bool=True, before: bool=True,
deformerTools: bool=True, envelope: Union[float, bool]=1, exclusive: Union[AnyStr,
bool]="", frontOfChain: bool=True, geometry: Union[AnyStr, List[AnyStr], bool]="",
geometryIndices: bool=True, ignoreSelected: bool=True, includeHiddenSelections:
bool=False, inwardConstraint: Union[float, bool]=0.0, name: AnyStr="",
outwardConstraint: Union[float, bool]=0.0, parallel: bool=True,
pinBorderVertices: bool=True, prune: bool=True, remove: Union[bool,
List[bool]]=True, smoothingIterations: Union[int, bool]=10, smoothingStep:
Union[float, bool]=0.5, split: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command is used to create, edit and query deltaMush nodes
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param envelope: (C Q E) Envelope of the delta mush node The envelope determines the
percent of deformation Value is clamped to [0, 1] range Default is 1
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param inwardConstraint: (C Q E) Constrains the movement of the vertex to not move inward
from the input deforming shape to preserve the contour Value is in the [0,1] range
Default
:param name: (C) Used to specify the name of the node being created
:param outwardConstraint: (C Q E) Constrains the movement of the vertex to not move outward
from the input deforming shape to preserve the contour Value is in the [0,1] range
Defaul
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param pinBorderVertices: (C Q E) If enabled, vertices on mesh borders will be pinned to
their current position during smoothing Default is true
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param smoothingIterations: (C Q E) Number of smoothing iterations performed by the delta
mush node Default is 10
:param smoothingStep: (C Q E) Step amount used per smoothing iteration Value is clamped to
[0, 1] range A higher value may lead to instabilities but converges faster compared to
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:returns: Delta mush deformer node name
"""
pass
def SelectUnmappedFaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SymmetrizeUVContext(*args, **kwargs)->None:
"""
"""
pass
def CreatePassiveRigidBodyOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_outlinerTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllRigidBodies(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectObjectsShadowedByLight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_targetWeldTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteFBIKSelectedKeys(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShadingGroupAttributeEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SoftModDeformerOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def imageWindowEditor(*args, **kwargs)->None:
"""
"""
pass
def DisableConstraints(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PickWalkUpSelect(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def checkDefaultRenderGlobals(*args, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
To query whether or not the defaultRenderGlobals node has been modified since the last file
save, use `ls -modified` To force the scene to be dirty/clean use `file -modified`
:returns:
"""
pass
def HideUnselectedObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GreasePencilTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeDraggerToolActivate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cMuscleSplineBind(*args, **kwargs)->None:
"""
"""
pass
def TimeEditorToggleSnapToClipRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def arclen(*args, caching: bool=True, constructionHistory: bool=True, nodeState: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[float, Any]:
"""
This command returns the arclength of a curve if the history flag is not set (the default)
If the history flag is set, a node is created that can produce the arclength, and is
connected and its name returned Having the construction history option on makes this
command useful for expressions
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C) Turn the construction history on or off
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: Length in non history mode.
"""
pass
def dimWhen(*args, clear: bool=True, false: bool=True, true: bool=True, **kwargs)->None:
"""
This method attaches the named UI object (first argument) to the named condition (second
argument) so that the object will be dimmed when the condition is in a particular state
This command will fail if the object does not exist If the condition does not exist (yet),
that's okay --- a placeholder will be used until such a condition comes into ex
:param clear: (C) Remove the condition on the specified dimmable
:param false: (C) Dim the object when the condition is false
:param true: (C) Dim the object when the condition is true (default)
:returns:
"""
pass
def DeleteMotionPaths(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyUniteSkinned(*args, centerPivot: bool=True, constructionHistory: bool=True,
mergeUVSets: Union[int, bool]=1, objectPivot: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Command to combine poly mesh objects (as polyUnite) while retaining the smooth skinning
setup on the combined object
:param centerPivot: (C Q E) Set the resulting object's pivot to the center of the selected
objects bounding box
:param constructionHistory: (C Q E) Turn the construction history on or off
:param mergeUVSets: (C Q E) Specify how UV sets will be merged on the output mesh The
choices are 0 | 1 | 2 0 = Do not merge Each UV set on each mesh will become a new UV set
:param objectPivot: (C Q E) Set the resulting object's pivot to last selected object's
pivot
:returns:
"""
pass
def polyMapDel(*args, caching: bool=True, constructionHistory: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Deletes texture coordinates (UVs) from selected faces
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def swatchDisplayPort(*args, annotation: Union[AnyStr, bool]="", backgroundColor:
Union[List[float, float, float], bool]=None, borderColor:
Union[List[float, float, float], bool]=None, borderWidth: Union[int,
bool]=0, defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists:
bool=True, fullPathName: bool=True, height: Union[int, bool]=0,
highlightColor: Union[List[float, float, float], bool]=None, isObscured:
bool=True, manage: bool=True, noBackground: bool=True,
numberOfPopupMenus: bool=True, parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, pressCommand: Script=None, preventOverride:
bool=True, renderPriority: int=0, renderSize: Union[int, bool]=0,
shadingNode: Union[name, bool]=None, statusBarMessage: AnyStr="",
useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, widthHeight:
List[int, int]=None, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a 3dPort that displays a swatch representing the shading node The
optional argument is the name of the 3dPort
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param borderColor: (C Q E) The border color of the swatch
:param borderWidth: (C Q E) The border width of the swatch The value will be clamped
between 0 and 4
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param pressCommand: (C E) Specifies the command to be run when the swatch is clicked on
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param renderPriority: (C E) Specifies the priority to render the swatch This flag can
only be used in parallel swatch rendering When more than one swatch are waiting in the re
:param renderSize: (C Q E) The render size of the swatch The value will be clamped between
32 and 512
:param shadingNode: (C Q E) Name of the shadingNode
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:param widthHeight: (C E) The width and height of the port
:returns: - the name of the port created or modified
"""
pass
def particleFill(*args, closePacking: bool=True, doubleWalled: bool=True, maxX: float=0.0,
maxY: float=0.0, maxZ: float=0.0, minX: float=0.0, minY: float=0.0, minZ:
float=0.0, particleDensity: float=0.0, resolution: int=0, **kwargs)->None:
"""
This command generates an nParticle system that fills the selected object with a grid of
particles
:param closePacking: (C) If this is on then the particles are positioned as closely as
possible in a hexagonal close packing arrangement Otherwise particles are packed in a
:param doubleWalled: (C) This flag should be used if the thickness of the object to fill
has been modeled( for example a mug ) Otherwise the particles will be created inside
:param maxX: (C) The fill max bounds of the particles in X relative to the X bounds of the
object A value of zero is totally empty and one is totally full The defau
:param maxY: (C) The fill max bounds of the particles in Y relative to the Y bounds of the
object A value of zero is totally empty and one is totally full The defau
:param maxZ: (C) The fill max bounds of the particles in Z relative to the Z bounds of the
object A value of zero is totally empty and one is totally full The defau
:param minX: (C) The fill lower bounds of the particles in X relative to the X bounds of
the object A value of zero is totally full and one is totally empty The def
:param minY: (C) The fill lower bounds of the particles in Y relative to the Y bounds of
the object A value of zero is totally full and one is totally empty The def
:param minZ: (C) The fill lower bounds of the particles in Z relative to the Z bounds of
the object A value of zero is totally full and one is totally empty The def
:param particleDensity: (C) This controls the size of the particles At a value of 1.0 the
particle size will exactly match the grid spacing determined by the resolution paramet
:param resolution: (C) This determines the total number of particles generated It
represent the resolution along the largest axis of the object's bounding box For a cube
:returns:
"""
pass
def SnapKeys(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyOptUvs(*args, applyToShell: bool=True, areaWeight: float=0.0, caching: bool=True,
constructionHistory: bool=True, globalBlend: float=0.0, globalMethodBlend:
float=0.0, iterations: int=0, name: AnyStr="", nodeState: Union[int, bool]=0,
optimizeAxis: int=0, pinSelected: bool=True, pinUvBorder: bool=True, scale:
float=0.0, stoppingThreshold: float=0.0, useScale: bool=True, uvSetName:
AnyStr="", worldSpace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Optimizes selected UVs
:param applyToShell: (C) Specifies where the whole object or just shells that are selected
or pinned should be affected
:param areaWeight: (C) Surface driven importance 0 treat all faces equal 1 gives more
importance to large ones
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param globalBlend: (C) This allows the user to blend between a local optimization method
(globalBlend = 0.0) and a global optimization method (globalBlend = 1.0) The local
:param globalMethodBlend: (C) The global optimization method uses two functions to compute
a minimization The first function controls edge stretch by using edges lengths between
:param iterations: (C) Maximum number of iterations for each connected UV piece
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param optimizeAxis: (C) Degree of freedom for optimization: 0=Optimize freely, 1=Move
vertically only, 2=Move horzontally only
:param pinSelected: (C) Specifies that the selected components should be pinned instead of
the unselected components
:param pinUvBorder: (C) Specifies that the UV border should be pinned when doing the solve
By default only unselected components are pinned
:param scale: (C) Ratio between 2d and 3d space
:param stoppingThreshold: (C) Minimum distorsion improvement between two steps in %
:param useScale: (C) Adjust the scale or not
:param uvSetName: (C) Name of the UV set to be created
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def arnoldTemperatureToColor(*args, **kwargs)->None:
"""
"""
pass
def ShowAllEditedComponents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeDeleteAllShadingGroupsAndMaterials(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CommandWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Uniform(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateFlexorWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UnparentOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UntrimSurfacesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def snapshotBeadContext(*args, **kwargs)->None:
"""
"""
pass
def UVEditorInvertPin(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyUVRectangle(*args, caching: bool=True, constructionHistory: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Given two vertices, does one of the following: 1) If the vertices define opposite corners
of a rectangular area of quads, assigns a grid of UVs spanning the 0-1 area to that
rectangle 2) If the vertices define an edge in a rectangular and topologically cylindrical
area of quads, assigns UVs spanning the 0-1 area to that cylindrical patch, using th
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:returns: The node name.
"""
pass
def keyframeRegionTrackCtx(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", name: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create a track context for the dope sheet editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Context name
"""
pass
def PaintEffectsToNurbsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateEmptyGroup(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createPolyCylinderCtx(*args, **kwargs)->None:
"""
"""
pass
def dR_curveSnapRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportMode(*args, **kwargs)->None:
"""
"""
pass
def FBXGetTakeReferenceTimeSpan(*args, **kwargs)->None:
"""
"""
pass
def nexOpt(*args, **kwargs)->None:
"""
"""
pass
def polyCacheMonitor(*args, cacheValue: bool=True, nodeName: AnyStr="", **kwargs)->None:
"""
When the cacheInput attribute has a positive value the midModifier node caches the output
mesh improving performance in computations of downstream nodes When the counter has a zero
value the midModifier releases the cached data
:param cacheValue: (C) Flag to indicate whether the node's cache counter should be
incremented or decremented True increments the counter, false decrements the counter
:param nodeName: (C) Name of the node whose cache counter needs to be changed
:returns:
"""
pass
def VolumeAxis(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RotateToolWithSnapMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BreakTangents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TogglePolyDisplayLimitToSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeToggleShowNamespace(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UncreaseSubdivSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AnimationTurntableOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RemoveShrinkWrapSurfaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_viewRight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateContainer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideIntermediateObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AlembicExportAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportDeleteOriginalTakeOnSplitAnimation(*args, **kwargs)->None:
"""
"""
pass
def dR_multiCutPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorClipTrimToggle(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllInput(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RenderViewPrevImage(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeletePolyElements(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def exclusiveLightCheckBox(*args, annotation: Union[AnyStr, bool]="", backgroundColor:
Union[List[float, float, float], bool]=None, defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True,
label: AnyStr="", light: name=None, manage: bool=True, noBackground:
bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width:
Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a checkBox that controls a light's exclusive non-exclusive status An
exclusive light is one that is not hooked up to the default-light-list, thus it does not
illuminate all objects be default However an exclusive light can be linked to an object
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C E) Value of the checkbox label
:param light: (C) The light that is to be made exclusive/non-exclusive
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full name to the control
"""
pass
def PlayblastOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleCVs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportEmbeddedTextures(*args, **kwargs)->None:
"""
"""
pass
def DuplicateCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeDeleteNodes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fluidAppend(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setNClothStartState(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TrimToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshKnifeTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleColorFeedback(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateTextOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleSubdDetails(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorSoloSelectedTracks(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fluidReplaceCache(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def debugNamespace(*args, **kwargs)->None:
"""
"""
pass
def CreateActiveRigidBody(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleHulls(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AttachToPathOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetHIKNodeName(*args, **kwargs)->None:
"""
"""
pass
def JointTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MakeMotorBoats(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PickWalkDownSelect(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def normalConstraint(*args, aimVector: Union[List[float, float, float], bool]=None, layer:
AnyStr="", name: Union[AnyStr, bool]="", remove: bool=True, targetList:
bool=True, upVector: Union[List[float, float, float], bool]=None, weight:
Union[float, bool]=0.0, weightAliasList: bool=True, worldUpObject:
Union[name, bool]=None, worldUpType: Union[AnyStr, bool]="",
worldUpVector: Union[List[float, float, float], bool]=None, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
Constrain an object's orientation based on the normal of the target surface(s) at the
closest point(s) to the object A normalConstraint takes as input one or more surface
shapes (the targets) and a DAG transform node (the object) The normalConstraint orients
the constrained object such that the aimVector (in the object's local coordinate system)
:param aimVector: (C Q E) Set the aim vector This is the vector in local coordinates that
points at the target If not given at creation time, the default value of (1.0, 0.0,
:param layer: (C E) Specify the name of the animation layer where the constraint should be
added
:param name: (C Q E) Sets the name of the constraint node to the specified name Default
name is constrainedObjectName_constraintType
:param remove: (E) removes the listed target(s) from the constraint
:param targetList: (Q) Return the list of target objects
:param upVector: (C Q E) Set local up vector This is the vector in local coordinates that
aligns with the world up vector If not given at creation time, the default value o
:param weight: (C Q E) Sets the weight value for the specified target(s) If not given at
creation time, the default value of 1.0 is used
:param weightAliasList: (Q) Returns the names of the attributes that control the weight of
the target objects Aliases are returned in the same order as the targets are returned
:param worldUpObject: (C Q E) Set the DAG object use for worldUpType "object" and
"objectrotation" See worldUpType for greater detail The default value is no up object,
which is
:param worldUpType: (C Q E) Set the type of the world up vector computation The
worldUpType can have one of 5 values: "scene", "object", "objectrotation", "vector", or
"none"
:param worldUpVector: (C Q E) Set world up vector This is the vector in world coordinates
that up vector should align with See -wut/worldUpType (below)for greater detail If not
:returns: Name of the created constraint node
"""
pass
def DeleteAllStrokes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllHistory(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def baseTemplate(*args, exists: bool=True, fileName: Union[AnyStr, bool]="", force: bool=True,
load: bool=True, matchFile: Union[AnyStr, bool]="", silent: bool=True, unload:
bool=True, viewList: Union[AnyStr, bool]="", q=True, query=True, e=True,
edit=True, **kwargs)->Union[None, Any]:
"""
This is the class for the commands that edit and/or query templates
:param exists: (Q) Returns true or false depending upon whether the specified template
exists When used with the matchFile argument, the query will return true if the
:param fileName: (C Q) Specifies the filename associated with the template This argument
can be used in conjunction with load, save or query modes If no filename is assoc
:param force: (C) This flag is used with some actions to allow them to proceed with an
overwrite or destructive operation When used with load, it will allow an existi
:param load: () Load an existing template from a file If a filename is specified for the
template, the entire file (and all templates in it) will be loaded If no f
:param matchFile: (Q) Used in query mode in conjunction with other flags this flag
specifies an optional file name that is to be matched as part of the query operation In
:param silent: (C Q E) Silent mode will suppress any error or warning messages that would
normally be reported from the command execution The return values are unaffected
:param unload: (C) Unload the specified template This action will not delete the
associated template file if one exists, it merely removes the template definition from
:param viewList: (C Q) Used in query mode, returns a list of all views defined on the
template
:returns:
"""
pass
def HideCameras(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorToggleUseAssetsAndPublishedAttributes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleSymmetryDisplay(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setKeyframe(*args, animLayer: AnyStr="", animated: bool=False, attribute: Union[AnyStr,
List[AnyStr]]="", breakdown: bool=False, clip: AnyStr="", controlPoints:
bool=False, dirtyDG: bool=True, float: Union[float, List[float]]=0.0,
hierarchy: AnyStr="", identity: bool=True, inTangentType: AnyStr="", insert:
bool=True, insertBlend: bool=True, minimizeRotation: bool=False, noResolve:
bool=True, outTangentType: AnyStr="", respectKeyable: bool=True, shape:
bool=True, time: Union[time, List[time]]=None, useCurrentLockedWeights:
bool=False, value: float=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[int, Any]:
"""
This command creates keyframes for the specified objects, or the active objects if none are
specified on the command line The default time for the new keyframes is the current time
Override this behavior with the "-t" flag on the command line The default value for the
keyframe is the current value of the attribute for which a keyframe is set
:param animLayer: (C) Specifies that the new key should be placed in the specified
animation layer Note that if the objects being keyframed are not already part of the la
:param animated: (C) Add the keyframe only to the attribute(s) that have already a keyframe
on Default: false
:param attribute: (C M) Attribute name to set keyframes on
:param breakdown: (C Q E) Sets the breakdown state for the key Default is false
:param clip: (C) Specifies that the new key should be placed in the specified clip Note
that if the objects being keyframed are not already part of the clip, this fl
:param controlPoints: (C) Explicitly specify whether or not to include the control points
of a shape (see "-s" flag) in the list of attributes Default: false
:param dirtyDG: (C) Allow dirty messages to be sent out when a keyframe is set
:param float: (C M) Float time at which to set a keyframe on float-based animation curves
:param hierarchy: (C) Controls the objects this command acts on, relative to the specified
(or active) target objects Valid values are "above," "below," "both," and "none
:param identity: (C) Sets an identity key on an animation layer An identity key is one
that nullifies the effect of the anim layer This flag has effect only when the at
:param inTangentType: (C) The in tangent type for keyframes set by this command Valid
values are: "auto", clamped", "fast", "flat", "linear", "plateau", "slow", "spline", and
:param insert: (C) Insert keys at the given time(s) and preserve the shape of the animation
curve(s) Note: the tangent type on inserted keys will be fixed so that the
:param insertBlend: (C) If true, a pairBlend node will be inserted for channels that have
nodes other than animCurves driving them, so that such channels can have blended an
:param minimizeRotation: (C) For rotations, ensures that the key that is set is a minimum
distance away from the previous key Default is false
:param noResolve: (C) When used with the -value flag, causes the specified value to be set
directly onto the animation curve, without attempting to resolve the value acros
:param outTangentType: (C) The out tangent type for keyframes set by this command Valid
values are: "auto", "clamped", "fast", "flat", "linear", "plateau", "slow", "spline", "
:param respectKeyable: (C) When used with the -attribute flag, prevents the keying of the
non keyable attributes
:param shape: (C) Consider attributes of shapes below transforms as well, except
"controlPoints" Default: true
:param time: (C M) Time at which to set a keyframe on time-based animation curves
:param useCurrentLockedWeights: (C) If we are setting a key over an existing key, use that
key tangent's locked weight value for the new locked weight value Default is false
:param value: (C) Value at which to set the keyframe Using the value flag will not cause
the keyed attribute to change to the specified value until the scene re-evalu
:returns: Number of keyframes set by this command.
"""
pass
def ToggleHikDetails(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreatePolygonPlaneOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InTangentSpline(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectUVBackFacingComponents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyRemoveCrease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hardenPointCurve(*args, caching: bool=True, multiplicity: Union[int, bool]=1, nodeState:
Union[int, bool]=0, constructionHistory: bool=True, name: AnyStr="",
object: bool=True, replaceOriginal: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The hardenPointCurve command changes the knots of a curve given a list of control point
indices so that the knot corresponding to that control point gets the specified
multiplicity Multiplicity of -1 is the universal value used for multiplicity equal to the
degree of the curve. limitations The CV whose multiplicity is being raised needs to have
i
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param multiplicity: (C Q E) the required multiplicity of the curve knot Default: -1
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def AbcImport(*args, **kwargs)->None:
"""
"""
pass
def stackTrace(*args, **kwargs)->None:
"""
"""
pass
def createPolyConeCtx(*args, **kwargs)->None:
"""
"""
pass
def LODGenerateMeshesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def selLoadSettings(*args, activeProxy: Union[AnyStr, bool]="", deferReference: bool=True,
fileName: Union[AnyStr, bool]="", numSettings: Union[int, bool]=0,
proxyManager: Union[AnyStr, bool]="", proxySetFiles: Union[AnyStr, bool]="",
proxySetTags: Union[AnyStr, bool]="", proxyTag: Union[AnyStr, bool]="",
referenceNode: Union[AnyStr, bool]="", shortName: bool=True,
unresolvedName: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command is used to edit and query information about the implicit load settings
Currently this is primarily intended for internal use within the Preload Reference Editor
selLoadSettings acts on load setting IDs When implict load settings are built for a target
scene, there will be one load setting for each reference in the target scene Each
:param activeProxy: (C Q E) Change or query the active proxy of a proxy set In query mode,
returns the proxyTag of the active proxy; in edit mode, finds the proxy in the proxyS
:param deferReference: (C Q E) Change or query the load state of a reference
:param fileName: (C Q) Return the file name reference file(s) associated with the indicated
load setting(s)
:param numSettings: (C Q) Return the number of settings in the group of implicit load
settings This is equivalent to number of references in the scene plus 1
:param proxyManager: (C Q) Return the name(s) of the proxy manager(s) associated with the
indicated load setting(s)
:param proxySetFiles: (C Q) Return the name(s) of the proxy(ies) available in the proxy set
associated with the indicated load setting(s)
:param proxySetTags: (C Q) Return the name(s) of the proxy tag(s) available in the proxy
set associated with the indicated load setting(s)
:param proxyTag: (C Q) Return the name(s) of the proxy tag(s) associated with the indicated
load setting(s)
:param referenceNode: (C Q) Return the name(s) of the reference node(s) associated with the
indicated load setting(s)
:param shortName: (C Q) Formats the return value of the 'fileName' query flag to only
return the short name(s) of the reference file(s)
:param unresolvedName: (C Q) Formats the return value of the 'fileName' query flag to
return the unresolved name(s) of the reference file(s) The unresolved file name is the
file
:returns: For query execution.
"""
pass
def CompleteCurrentTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ProfilerTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nucleusDisplayOtherNodes(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def BevelPolygonOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def isDirty(*args, connection: bool=True, datablock: bool=True, **kwargs)->bool:
"""
The isDirty command is used to check if a plug is dirty The return value is 0 if it is not
and 1 if it is If more than one plug is specified then the result is the logical "or" of
all objects (ie returns 1 if *any* of the plugs are dirty)
:param connection: (C) Check the connection of the plug (default)
:param datablock: (C) Check the datablock entry for the plug
:returns: Is the plug dirty? If more than one plug is given then it returns the
logical
"and" of all dirty states.
"""
pass
def meshRemap(*args, **kwargs)->None:
"""
"""
pass
def dR_activeHandleXY(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_activeHandleXZ(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleCharacterControls(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def lattice(*args, after: bool=True, afterReference: bool=True, before: bool=True,
commonParent: bool=True, deformerTools: bool=True, divisions: Union[List[int, int,
int], bool]=None, dualBase: bool=True, exclusive: Union[AnyStr, bool]="",
freezeMapping: bool=True, frontOfChain: bool=True, geometry: Union[AnyStr,
List[AnyStr], bool]="", geometryIndices: bool=True, ignoreSelected: bool=True,
includeHiddenSelections: bool=False, latticeReset: bool=True, ldivisions:
Union[List[int, int, int], bool]=None, name: AnyStr="", objectCentered: bool=True,
outsideFalloffDistance: float=0.0, outsideLattice: int=0, parallel: bool=True,
position: List[float, float, float]=None, prune: bool=True, remove: Union[bool,
List[bool]]=True, removeTweaks: bool=True, rotation: List[float, float, float]=None,
scale: List[float, float, float]=None, split: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command creates a lattice deformer that will deform the selected objects If the
object centered flag is used, the initial lattice will fit around the selected objects The
lattice will be selected when the command is completed The lattice deformer has an
associated base lattice Only objects which are contained by the base lattice will be
de
:param after: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param afterReference: (C E) The -afterReference flag is used to specify deformer ordering
in a hybrid way that choses between -before and -after automatically If the geometry b
:param before: (C E) If the default behavior for insertion/appending into/onto the existing
chain is not the desired behavior then this flag can be used to force the comm
:param commonParent: (C) Group the base lattice and the deformed lattice under a common
transform This means that you can resize the lattice without affecting the deformatio
:param deformerTools: (Q) Returns the name of the deformer tool objects (if any) as string
string ..
:param divisions: (C Q E) Set the number of lattice slices in x, y, z Default is 2, 5, 2
When queried, this flag returns float float float When you change the number of div
:param dualBase: (C) Create a special purpose ffd deformer node which accepts 2 base
lattices The default is off which results in the creation of a normal ffd deformer n
:param exclusive: (C Q) Puts the deformation set in a deform partition
:param freezeMapping: (C Q E) The base position of the geometries points is fixed at the
time this flag is set When mapping is frozen, moving the geometry with respect to the lat
:param frontOfChain: (C E) This command is used to specify that the new deformer node
should be placed ahead (upstream) of existing deformer and skin nodes in the shape's histo
:param geometry: (Q E M) The specified object will be added to the list of objects being
deformed by this deformer object, unless the -rm flag is also specified When queried
:param geometryIndices: (Q) Complements the -geometry flag in query mode Returns the multi
index of each geometry
:param ignoreSelected: (C) Tells the command to not deform objects on the current selection
list
:param includeHiddenSelections: (C) Apply the deformer to any visible and hidden objects in
the selection list Default is false
:param latticeReset: (E) Reset the lattice to match its base position This will undo any
deformations that the lattice is causing The lattice will only deform points that a
:param ldivisions: (C Q E) Set the number of local lattice slices in x, y, z
:param name: (C) Used to specify the name of the node being created
:param objectCentered: (C) Centers the lattice around the selected object(s) or components
Default is off which centers the lattice at the origin
:param outsideFalloffDistance: (C) Set the falloff distance used when the setting for
transforming points outside of the base lattice is set to 2 The distance value is a
positive numb
:param outsideLattice: (C) Set the mode describing how points outside the base lattice are
transformed 0 (the default) specifies that no outside points are transformed 1 spec
:param parallel: (C E) Inserts the new deformer in a parallel chain to any existing
deformers in the history of the object A blendShape is inserted to blend the parallel r
:param position: (C) Used to specify the position of the newly created lattice
:param prune: (E) Removes any points not being deformed by the deformer in its current
configuration from the deformer set
:param remove: (E M) Specifies that objects listed after the -g flag should be removed from
this deformer
:param removeTweaks: (E) Remove any lattice deformations caused by moving lattice points
Translations/rotations and scales on the lattice itself are not removed
:param rotation: (C) Used to specify the initial rotation of the newly created lattice
:param scale: (C) Used to specify the initial scale of the newly created lattice
:param split: (C E) Branches off a new chain in the dependency graph instead of
inserting/appending the deformer into/onto an existing chain Works in create mode (and e
:returns: Ffd node name, lattice name, base lattice name.
"""
pass
def pointCurveConstraint(*args, caching: bool=True, nodeState: Union[int, bool]=0,
pointConstraintUVW: Union[List[float, float, float], bool]=None,
pointWeight: Union[float, bool]=1.0, position: List[float, float,
float]=None, weight: float=0.0, constructionHistory: bool=True, name:
AnyStr="", object: bool=True, replaceOriginal: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The command enables direct manipulation of a NURBS curve It does so by apply a position
constraint at the specified parameter location on the NURBS curve If construction history
for the cmd is enabled, a locator is created to enable subsequent interactive manipulation
of the curve The locator position may be key framed or transformed and the "c
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param pointConstraintUVW: (C Q E) Point constraint parameter space location on input NURBS
Object
:param pointWeight: (C Q E) Point constraint weight Determines how strong an influence the
constraint has on the input NURBS object Default: 1.0
:param position: (C) The new desired position in space for the nurbs object at the
specified parameter space component If not specified, the position is taken to be the
:param weight: (C) weight of the lsq constraint The larger the weight, the least squares
constraint is strictly met
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object Name(s), node name.
"""
pass
def createSubdivRegion(*args, **kwargs)->bool:
"""
Creates a subdivision surface region based on the selection list Once a selection region
is created, only the components in the selection list or converted from the selection list
will be displayed and selectible through the UI
:returns: Command result
"""
pass
def hotkeyCheck(*args, altModifier: bool=True, commandModifier: bool=True, ctrlModifier:
bool=True, isRepeatable: bool=True, keyString: AnyStr="", keyUp: bool=True,
optionModifier: bool=True, **kwargs)->AnyStr:
"""
This command checks if the given hotkey is mapped to a nameCommand object If so, the
annotation of the nameCommand object is returned Otherwise an empty string is returned
:param altModifier: (C) Specifies if the Alt key is pressed
:param commandModifier: (C) Specifies if the command key is pressed
:param ctrlModifier: (C) Specifies if the Ctrl key is pressed
:param isRepeatable: (C) Specify this flag if the hotkey is repeatable
:param keyString: (C) The key to check
:param keyUp: (C) Specifies if the hotkey is on keyup or keydown (i.e Release or Press)
:param optionModifier: (C) Specifies if the option key is pressed
:returns: Contains all clients name, each followed by the annotation of the corresponding
nameCommand object, or
an empty string.
"""
pass
def moduleInfo(*args, definition: bool=True, listModules: bool=True, moduleName: AnyStr="",
path: bool=True, version: bool=True, **kwargs)->List[AnyStr]:
"""
Returns information on modules found by Maya
:param definition: (C) Returns module definition file name for the module specified by the
-moduleName parameter
:param listModules: (C) Returns an array containing the names of all currently loaded
modules
:param moduleName: (C) The name of the module whose information you want to retrieve Has
to be used with either -definition / -path / -version flags
:param path: (C) Returns the module path for the module specified by the -moduleName
parameter
:param version: (C) Returns the module version for the module specified by the -moduleName
parameter
:returns: Command result
"""
pass
def whatsNewHighlight(*args, highlightColor: Union[List[float, float, float], bool]=None,
highlightOn: bool=True, showStartupDialog: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command is used to toggle the What's New highlighting feature, and the display of the
settings dialog for the feature that appears on startup
:param highlightColor: (C Q) Set the color of the What's New highlight The arguments
correspond to the red, green, and blue color components Each color component ranges in
valu
:param highlightOn: (C Q) Toggle the What's New highlighting feature When turned on, menu
items and buttons introduced in the latest version will be highlighted
:param showStartupDialog: (C Q) Set whether the settings dialog for this feature appears on
startup
:returns:
"""
pass
def ShowStrokePathCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NextViewArrangement(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleCommandLine(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyFlipEdge(*args, q=True, query=True, e=True, edit=True, **kwargs)->Union[bool, Any]:
"""
Command to flip the edges shared by 2 adjacent triangles When used with the edit flag, new
edges can be added to the same node, instead of creating a separate node in the chain
:returns: Success or Failure.
"""
pass
def ToggleVertIDs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisplacementToPolygon(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UVStraighten(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def filePathEditor(*args, attributeOnly: bool=True, attributeType: Union[AnyStr, bool]="",
byType: Union[AnyStr, bool]="", copyAndRepath: List[AnyStr, AnyStr]=None,
deregisterType: AnyStr="", force: bool=True, listDirectories: Union[AnyStr,
bool]="", listFiles: Union[AnyStr, bool]="", listRegisteredTypes: bool=True,
preview: bool=True, recursive: bool=True, refresh: bool=True, registerType:
AnyStr="", relativeNames: bool=True, repath: AnyStr="", replaceAll:
bool=True, replaceField: AnyStr="", replaceString: List[AnyStr, AnyStr]=None,
status: bool=True, temporary: bool=True, typeLabel: Union[AnyStr, bool]="",
unresolved: bool=True, withAttribute: bool=True, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
Maya can reference and use external files, such as textures or other Maya scenes This
command is used to get the information about those file paths and modify them in bulk By
default, only the most frequently used types of files are presented to the user: Texture
Scene reference Audio Image plane For the command to manage more file types, thos
:param attributeOnly: (Q) Used with "listFiles" to return the node and attribute name that
are using the files
:param attributeType: (Q) Query the attribute type for the specified plug
:param byType: (Q) Used with "listFiles" to query files that are used by the specified node
type or attribute type In query mode, this flag needs a value
:param copyAndRepath: (C) Copy a source file to the destination path and repath the plug
data to the new file The source file must have the same name as the one in the plug
:param deregisterType: (C) Deregister a file type from the list of registered types so the
command stops handling it Unless the "temporary" flag is used, the type will be remo
:param force: (C) Used with flag "repath" to repath all files to the new location,
including the resolved files Otherwise, "repath" will only deal with the missing fi
:param listDirectories: (Q) List all sub directories of the specified directory Only
directories containing at least one file whose type is registered (see "registerType")
will
:param listFiles: (Q) List files in the specified directory No recursion in subdirectories
will be performed In query mode, this flag needs a value
:param listRegisteredTypes: (Q) Query the list of registered attribute types The
registered types include the auto-loaded types from the preference file and the types
explicitly re
:param preview: (C) Used with "repath", "replaceString" or "copyAndRepath" to preview the
result of the operation instead of excuting it When it is used with "repath" o
:param recursive: (C) Used with flag "repath" to search the files in the target directory
and its subdirectories recursively If the flag is on, the command will repath th
:param refresh: (C) Clear and re-collect the file information in the scene The command
does not automatically track file path modifications in the scene So it is the u
:param registerType: (C) Register a new file type that the command will handle and
recognize from now on Unless the "temporary" flag is used, the registered type is saved
in
:param relativeNames: (Q) Used with "listDirectories" or "listFiles" to return the relative
path of each directory or file Paths are relative to the current project folder I
:param repath: (C) Replace the directory part of a file path with a specified location The
file name will be preserved
:param replaceAll: (C) Used with flag "replaceString", specifies how many times the matched
string will be replaced When the flag is false, only the first matched string w
:param replaceField: (C) Used with the "replaceString" flag to control the scope of the
replacement Possible values are: "pathOnly" - only replace strings in the directory p
:param replaceString: (C) Replace the target string with the new string in the file paths
The flag needs two arguments: the first one is the target string and the second one
:param status: (Q) Used with "listFiles", this will cause the returned list of files to
include one status flag per file: 0 if it cannot be resolved and 1 if it can Us
:param temporary: (C) Make the effect of the "register"/"deregister" flag only applicable
in the current session Normally, a type registration/deregistration is permanent
:param typeLabel: (C Q) Used with "registerType" to set the label name for the new file
type Used with "query" to return the type label for the specified attribute type Fo
:param unresolved: (Q) Used with "listFiles" to query the unresolved files that are being
used in the scene
:param withAttribute: (Q) Used with "listFiles" to return the name of the plug using a
given file For example, if "file.jpg" is used by the plug "node1.fileTextureName", then
:returns:
"""
pass
def DisableExpressions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def shadingNode(*args, asLight: bool=True, asPostProcess: bool=True, asRendering: bool=True,
asShader: bool=True, asTexture: bool=True, asUtility: bool=True,
isColorManaged: bool=True, name: AnyStr="", parent: AnyStr="", shared:
bool=True, skipSelect: bool=True, **kwargs)->AnyStr:
"""
This command creates a new node in the dependency graph of the specified type The
shadingNode command classifies any DG node as a shader, texture light, post process, or
utility so that it can be properly organized in the multi-lister Recall that any DG node
can be used a part of a a shader, texture or light - regardless of how it is classified
:param asLight: (C) classify the current DG node as a light
:param asPostProcess: (C) classify the current DG node as a post process
:param asRendering: (C) classify the current DG node as a rendering node
:param asShader: (C) classify the current DG node as a shader
:param asTexture: (C) classify the current DG node as a texture
:param asUtility: (C) classify the current DG node as a utility
:param isColorManaged: (C) classify the current DG node as being color managed
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param parent: (C) Specifies the parent in the DAG under which the new node belongs
:param shared: (C) This node is shared across multiple files, so only create it if it does
not already exist
:param skipSelect: (C) This node is not to be selected after creation, the original
selection will be preserved
:returns: The name of the new node.
"""
pass
def SendAsNewSceneMudbox(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_SetGlobalTextureWidth(*args, **kwargs)->None:
"""
"""
pass
def MakePaintable(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteCurrentUVSet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polyPlane(*args, axis: Union[List[float, float, float], bool]=None, createUVs: Union[int,
bool]=1, height: Union[float, bool]=1.0, subdivisionsHeight: Union[int, bool]=0,
subdivisionsWidth: Union[int, bool]=10, subdivisionsX: Union[int, bool]=5,
subdivisionsY: Union[int, bool]=5, texture: Union[int, bool]=1, width:
Union[float, bool]=1.0, caching: bool=True, constructionHistory: bool=True, name:
AnyStr="", nodeState: Union[int, bool]=0, object: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
Create a new polygonal plane
:param axis: (C Q E) This flag specifies the primitive axis used to build the plane
:param createUVs: (C Q E) Create UVs or not 0: No UVs 1: No Normalization 2: Normalize and
Preserve Aspect Ratio Default: 1
:param height: (C Q E) Height of the plane Default: 1.0
:param subdivisionsHeight: (C Q E) Subdivisions along the height of the sphere
:param subdivisionsWidth: (C Q E) Subdivisions along the width of the plane Default: 10
:param subdivisionsX: (C Q E) This specifies the number of subdivisions in the X direction
for the plane Default is 5
:param subdivisionsY: (C Q E) This flag specifies the number of subdivisions in the Y
direction for the plane Default is 5
:param texture: (C Q E) What texture mechanism to be applied 0=No textures; 1=stretch to
fit; 2=preserve aspect ratio Default: 1
:param width: (C Q E) Width of the plane Default: 1.0
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node (where applicable)
:returns: Object name and node name.
"""
pass
def xgmDensityBrushContext(*args, **kwargs)->None:
"""
"""
pass
def texturePlacementContext(*args, exists: bool=True, history: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr,
bool]="", labelMapping: bool=True, name: AnyStr="", q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a command for creating new texture placement contexts By default label mapping is
on when the context is created
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param labelMapping: (C Q E) Set the context to label mapping
:param name: (C) If this is a tool command, name the tool appropriately
:returns: The name of the context created
"""
pass
def floatField(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dragCommand:
Script=None, dropCallback: Script=None, editable: bool=True, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, enterCommand:
Script=None, exists: bool=True, fullPathName: bool=True, height: Union[int,
bool]=0, highlightColor: Union[List[float, float, float], bool]=None,
isObscured: bool=True, manage: bool=True, maxValue: Union[float, bool]=0.0,
minValue: Union[float, bool]=0.0, noBackground: bool=True, numberOfPopupMenus:
bool=True, parent: Union[AnyStr, bool]="", popupMenuArray: bool=True, precision:
Union[int, bool]=0, preventOverride: bool=True, receiveFocusCommand: Script=None,
showTrailingZeros: bool=True, statusBarMessage: AnyStr="", step: Union[float,
bool]=0.0, useTemplate: AnyStr="", value: Union[float, bool]=0.0, visible:
bool=True, visibleChangeCommand: Union[Script, bool]=None, width: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Create a field control that accepts only float values and is bound by a minimum and maximum
value An invisible slider is attached to the field and accessed by holding down the Ctrl
modifier key while pressing one of the mouse buttons Dragging the invisible slider to the
right with the middle mouse button increases the field value by the amount sp
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the field changes This command is not
invoked when the value changes via the -v/value flag
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragCommand: (C E) Command executed when dragging in the field
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editable: (C Q E) The edit state of the field By default, this flag is set to true
and the field value may be changed by typing into it If false then the field can n
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param enterCommand: (C E) Command executed when the keypad 'Enter' key is pressed
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxValue: (C Q E) Upper limit of the field
:param minValue: (C Q E) Lower limit of the field
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param precision: (C Q E) Number of digits to the right of the decimal place
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param receiveFocusCommand: (C E) Command executed when the field receives focus
:param showTrailingZeros: (C Q E) Show trailing zeros or not
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (C Q E) Increment for the invisible slider The field value will change by
this amount when the invisible slider is dragged
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Value of the field
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def dR_multiCutSlicePointCmd(*args, **kwargs)->None:
"""
"""
pass
def CustomNURBSComponentsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeSortByType(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GridUV(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_GetGlobalTextureWidth(*args, **kwargs)->None:
"""
"""
pass
def SimplifyStrokePathCurves(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectCurveCVsAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectPolygonSelectionBoundary(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FrontPerspViewLayout(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySewEdge(*args, caching: bool=True, constructionHistory: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, texture: bool=True, tolerance: Union[float,
bool]=0.0, worldSpace: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Merge border edges within a given threshold.
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param texture: (C Q E) If true : texture is sewn as well as the 3d edge C: Default is
true Q: When queried, this flag returns an int
:param tolerance: (C Q E) The tolerance to sew edges (edge distance) C: Default is 0.0 Q:
When queried, this flag returns a float
:param worldSpace: (C Q E) This flag specifies which reference to use If "on" : all
geometrical values are taken in world reference If "off" : all geometrical values are
take
:returns: The node name.
"""
pass
def EnableNRigids(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def renderLayerPostProcess(*args, keepImages: bool=True, sceneName: Union[AnyStr, bool]="",
q=True, query=True, **kwargs)->Union[None, Any]:
"""
Post process the results when rendering is done with Presently this generates a layered
PSD file using individual iff files
:param keepImages: (C Q) When set to on, the original iff images are kept after the
conversion to PSD Default is to remove them
:param sceneName: (C Q) Specifies the scene name for interactive batch rendering
:returns:
"""
pass
def polyPrimitive(*args, axis: Union[List[float, float, float], bool]=None, createUVs:
Union[int, bool]=0, polyType: int=0, radius: Union[float, bool]=1.0,
sideLength: Union[float, bool]=1.0, texture: Union[int, bool]=0, caching:
bool=True, constructionHistory: bool=True, name: AnyStr="", nodeState:
Union[int, bool]=0, object: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
Create a polygon primative
:param axis: (C Q E) This flag specifies the primitive axis used to build the primitive
polygon Q: When queried, this flag returns a float[3]
:param createUVs: (C Q E) Create UVs or not 0: No UVs 1: No Normalization 2: Normalize
Each Face Separately 3: Normalize Collectively 4: Normalize and Preserve Aspect Ratio
:param polyType: (C) This flag allows a specific primitive poly to be selected for creation
of mesh, The valid values is 0 0 implies soccer ball to be created C: Default
:param radius: (C Q E) This flag specifies the radius of the primitive polygon C: Default
is 1.0 Q: When queried, this flag returns a float
:param sideLength: (C Q E) This flag specifies the side length of primitive polygon C:
Default is 1.0 Q: When queried, this flag returns a float
:param texture: (C Q E) What texture mechanism to be applied 0=No textures, 1=Object,
2=Faces
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node (where applicable)
:returns: Object name and node name.
"""
pass
def HypershadeDisplayAsList(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def textCurves(*args, font: AnyStr="", name: AnyStr="", object: bool=True, text: AnyStr="",
q=True, query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The textCurves command creates NURBS curves from a text string using the specified font A
single letter can be made up of more than one NURBS curve The number of curves per letter
varies with the font
:param font: (C) The font to use
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param text: (C) The string to create the curves for
:returns: Object name and node name
"""
pass
def textureLassoContext(*args, **kwargs)->None:
"""
"""
pass
def vortex(*args, attenuation: Union[float, bool]=0.0, axisX: Union[float, bool]=0.0, axisY:
Union[float, bool]=0.0, axisZ: Union[float, bool]=0.0, magnitude: Union[float,
bool]=0.0, maxDistance: Union[float, bool]=0.0, name: Union[AnyStr, bool]="",
perVertex: bool=True, position: Union[List[float, float, float], List[List[float,
float, float]], bool]=None, torusSectionRadius: Union[float, bool]=0.0,
volumeExclusion: bool=True, volumeOffset: Union[List[float, float, float],
bool]=None, volumeShape: Union[AnyStr, bool]="", volumeSweep: Union[float, bool]=0.0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
For each listed object, the command creates a new field The field has a shape which lives
in the DAG and it has an associated dependency node The field is added to the list of
fields owned by the object Use connectDynamic to cause the field to affect a dynamic
object Note that if more than one object is listed, a separate field is created for e
:param attenuation: (Q E) Attentuation rate of field
:param axisX: (Q E) X-component of vortex axis
:param axisY: (Q E) Y-component of vortex axis
:param axisZ: (Q E) Z-component of vortex axis
:param magnitude: (Q E) Strength of field
:param maxDistance: (Q E) Maximum distance at which field is exerted -1 indicates that the
field has no maximum distance
:param name: (Q E) name of field
:param perVertex: (Q E) Per-vertex application If this flag is set true, then each
individual point (CV, particle, vertex,etc.) of the chosen object exerts an identical cop
:param position: (Q E M) Position in space (x,y,z) where you want to place a gravity field
The gravity then emanates from this position in space rather than from an object
:param torusSectionRadius: (Q E) Section radius for a torus volume Applies only to torus
Similar to the section radius in the torus modelling primitive
:param volumeExclusion: (Q E) Volume exclusion of the field If true, points outside the
volume (defined by the volume shape attribute) are affected, If false, points inside the v
:param volumeOffset: (Q E) Volume offset of the field Volume offset translates the field's
volume by the specified amount from the actual field location This is in the field'
:param volumeShape: (Q E) Volume shape of the field Sets/edits/queries the field's volume
shape attribute If set to any value other than "none", determines a 3-D volume with
:param volumeSweep: (Q E) Volume sweep of the field Applies only to sphere, cone, cylinder,
and torus Similar effect to the sweep attribute in modelling
:returns: Command result
"""
pass
def TransformPolygonComponentOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeGraphRemoveDownstream(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ikSolver(*args, epsilon: Union[float, bool]=0.0, maxIterations: Union[int, bool]=0, name:
Union[AnyStr, bool]="", solverType: Union[AnyStr, bool]="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
The ikSolver command is used to set the attributes for an IK Solver or create a new one
The standard edit (-e) and query (-q) flags are used for edit and query functions
:param epsilon: (C Q E) max error
:param maxIterations: (C Q E) Sets the max iterations for a solution
:param name: (C Q E) Name of solver
:param solverType: (C Q E) valid solverType (only ikSystem knows what is valid) for
creation of a new solver (required)
:returns: Command result
"""
pass
def CreateDirectionalLight(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def fluidCacheInfo(*args, attribute: Union[AnyStr, bool]="", cacheTime: Union[time, bool]=None,
endFrame: bool=True, hasCache: bool=True, hasData: bool=True,
initialConditions: bool=True, playback: bool=True, resolution: bool=True,
startFrame: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
A command to get information about the fluids cache Get the startFrame and resolution for
InitialConditions Get the endFrame as well for a playback cache Note that for the
playback cache, it will look at the current time (or last frame if the current time is past
end of cache)
:param attribute: (C Q E) Modifier to the "hasData" flag, used to query whether a cache has
data (at the current time) for a specific fluid attribute Valid attribute values a
:param cacheTime: (C Q E) Only valid with the -hasData flag The time the -hasData flag
uses when it queries the cache to see if there is data
:param endFrame: (C Q E) Returns end time of cache as float
:param hasCache: (C Q E) Returns true if fluid has specified cache, false if not
:param hasData: (C Q E) Queries whether a given cache has data in it at the time specified
by the -time flag (If not -time flag is present, -hasData assumes the current tim
:param initialConditions: (C Q E) Specifies the cache to be queried is the "Initial
Conditions" cache
:param playback: (C Q E) Specifies the cache to be queried is the "Playback" cache
:param resolution: (C Q E) Returns cache resolution as float[]
:param startFrame: (C Q E) Returns start time for cache as float
:returns:
"""
pass
def soft(*args, convert: bool=True, duplicate: bool=True, duplicateHistory: bool=True, goal:
float=0.0, hideOriginal: bool=True, name: AnyStr="", q=True, query=True,
**kwargs)->Union[AnyStr, Any]:
"""
Makes a soft body from the object(s) passed on the command line or in the selection list
The geometry can be a NURBS, polygonal, lattice object The resulting soft body is made up
of a hierarchy with a particle shape and a geometry shape, thus: T / \ T G / P
Dynamics are applied to the particle shape and the resulting particle posi
:param convert: (C) This tells the command that you want the original object to be the
actual deformed object The particle shape portion of the soft body will be insert
:param duplicate: (C) This tells the command that you want to make a copy of the original
object and use the copy as the deforming geometry Input connections to the origi
:param duplicateHistory: (C) This is the same as -d, except that upstream history, is
duplicated as well, instead of just input connections This flag and -d are mutually
exclusi
:param goal: (C) This is the same as -d, but in addition it tells the command that you want
the resulting soft body to try to follow the original geometry, using the
:param hideOriginal: (C) This flag is used only when duplicating (-d, -g, or -dh) If set
to true, whichever of the two objects is NOT the soft object will be hidden In othe
:param name: () This flag is obsolete If you wish to give your new soft object a name, use
the rename command (or from the UI, use the outliner)
:returns: array
"""
pass
def reloadImage(*args, **kwargs)->bool:
"""
This command reloads an xpm image from disk This can be used when the file has changed on
disk and needs to be reloaded The first string argument is the file name of the .xpm file
The second string argument is the name of a control using the specified pixmap
:returns: True if image is successfully loaded, false otherwise.
"""
pass
def Quit(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMaxInfluences(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AssignTemplate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateSubdivCube(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def transferShadingSets(*args, sampleSpace: Union[int, bool]=0, searchMethod: Union[int,
bool]=0, q=True, query=True, e=True, edit=True, **kwargs)->Union[None,
Any]:
"""
Command to transfer shading set assignments between meshes The last mesh in the list
receives the shading assignments from the other meshes
:param sampleSpace: (C Q E) Selects which space the attribute transfer is performed in 0
is world space, 1 is model space The default is world space
:param searchMethod: (C Q E) Specifies which search method to use when correlating points
0 is closest along normal, 3 is closest to point The default is closest to point
:returns:
"""
pass
def tumble(*args, azimuthAngle: float=0.0, elevationAngle: float=0.0, localTumble: int=0,
pivotPoint: List[float, float, float]=None, rotationAngles: List[float, float]=None,
**kwargs)->None:
"""
The tumble command revolves the camera(s) by varying the azimuth and elevation angles in
the perspective window When both the azimuth and the elevation angles are supplied on the
command line, the camera is firstly tumbled for the azimuth angle, then tumbled for the
elevation angle When no camera name is supplied, this command is applied to the
:param azimuthAngle: (C) Degrees to change the azimuth angle
:param elevationAngle: (C) Degrees to change the elevation angle
:param localTumble: (C) Describes what point the camera will tumble around: 0 for the
camera's tumble pivot, 1 for the camera's center of interest, and 2 for the camera's lo
:param pivotPoint: (C) Three dimensional point used as the pivot point in the world space
:param rotationAngles: (C) Two values in degrees to change the azimuth and elevation
angles
:returns:
"""
pass
def dispatchGenericCommand(*args, **kwargs)->None:
"""
unknown
"""
pass
def workspaceControlState(*args, defaultTopLeftCorner: Union[List[int, int], bool]=None,
defaultWidthHeight: Union[List[int, int], bool]=None, exists:
bool=True, height: Union[int, bool]=0, leftEdge: Union[int, bool]=0,
maximized: bool=True, remove: bool=True, topEdge: Union[int, bool]=0,
topLeftCorner: Union[List[int, int], bool]=None, width: Union[int,
bool]=0, widthHeight: Union[List[int, int], bool]=None, q=True,
query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Create or modify preferred window attributes for workspace controls The size and position
of a workspace control is retained during application sessions (although position only
applies to workspace controls that are alone in a floating workspace docking panel) A
default workspace control state is created when a workspace control is closed Worksp
:param defaultTopLeftCorner: (C Q E) Top and left edge position that the window will have
when "Remember size and position" is off and when the panel is first opened The values
will be
:param defaultWidthHeight: (C Q E) Width and height that the window will have when
"Remember size and position" is off and when the panel is first opened The values will be
DPI scaled
:param exists: (C) Returns true|false depending upon whether the specified object exists
Other flags are ignored
:param height: (C Q E) Height of the window
:param leftEdge: (C Q E) Left edge position of the window
:param maximized: (C Q E) Maximize the window
:param remove: (C) Remove a window preference
:param topEdge: (C Q E) Top edge position of the window
:param topLeftCorner: (C Q E) Top and left edge position of the window
:param width: (C Q E) Width of the window
:param widthHeight: (C Q E) Width and height of the window
:returns:
"""
pass
def bezierAnchorPreset(*args, preset: int=0, **kwargs)->int:
"""
This command provides a queryable interface for Bezier curve shapes
:param preset: (C) Selects a preset to apply to selected Bezier anchors Valid arguments
are: 0: Bezier 1: Bezier Corner 2: Corner
:returns: (number of modified anchors)
"""
pass
def NodeEditorToggleLockUnlock(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_softSelStickyRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShrinkPolygonSelectionRegion(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def arnoldPlugins(*args, **kwargs)->None:
"""
"""
pass
def AlembicOpen(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def bezierInfo(*args, anchorFromCV: int=0, cvFromAnchor: int=0, isAnchorSelected: bool=True,
isTangentSelected: bool=True, onlyAnchorsSelected: bool=True,
onlyTangentsSelected: bool=True, **kwargs)->int:
"""
This command provides a queryable interface for Bezier curve shapes
:param anchorFromCV: (C) Returns the Bezier anchor index from a given CV index
:param cvFromAnchor: (C) Returns the CV index for a given Bezier anchor index
:param isAnchorSelected: (C) Returns 1 if an anchor CV is currently selected 0, otherwise
:param isTangentSelected: (C) Returns 1 if a tangent CV is currently selected 0,
otherwise
:param onlyAnchorsSelected: (C) Returns 1 if the only CV components selected are anchor CVs
0, otherwise
:param onlyTangentsSelected: (C) Returns 1 if the only CV components selected are tangent
CVs 0, otherwise
:returns: Queried value
"""
pass
def dR_customPivotTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AppendToPolygonTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisableRigidBodies(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateNURBSCone(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sceneEditor(*args, control: bool=True, defineTemplate: AnyStr="", docTag: Union[AnyStr,
bool]="", exists: bool=True, filter: Union[AnyStr, bool]="",
forceMainConnection: Union[AnyStr, bool]="", highlightConnection: Union[AnyStr,
bool]="", lockMainConnection: bool=True, mainListConnection: Union[AnyStr,
bool]="", onlyParents: bool=True, panel: Union[AnyStr, bool]="", parent:
Union[AnyStr, bool]="", refreshReferences: bool=True, selectCommand:
Union[Script, bool]=None, selectItem: Union[int, bool]=0, selectReference:
Union[AnyStr, bool]="", selectionConnection: Union[AnyStr, bool]="", shortName:
bool=True, stateString: bool=True, unParent: bool=True, unlockMainConnection:
bool=True, unresolvedName: bool=True, updateMainConnection: bool=True,
useTemplate: AnyStr="", withoutCopyNumber: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This creates an editor for managing the files in a scene
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param onlyParents: (Q) When used with the 'selectItem' or 'selectReference' queries it
indicates that, if both a parent and a child file or reference are selected, only the
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param refreshReferences: (E) Force refresh of references
:param selectCommand: (C Q E) A script to be executed when an item is selected
:param selectItem: (Q E) Query or change the currently selected item When queried, the
currently selected file name will be return
:param selectReference: (Q) Query the currently selected reference Returns the name of the
currently selected reference node
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param shortName: (Q) When used with the 'selectItem' query it indicates that the file name
returned will be the short name (i.e just a file name without any directory pa
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param unresolvedName: (Q) When used with the 'selectItem' query it indicates that the file
name returned will be unresolved (i.e it will be the path originally specified when
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param withoutCopyNumber: (Q) When used with the 'selectItem' query it indicates that the
file name returned will not have a copy number appended to the end If this flag is not p
:returns: Name of editor.
"""
pass
def RenderTextureRange(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def insertListItemBefore(*args, **kwargs)->None:
"""
"""
pass
def NodeEditorGraphRearrange(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MoveIKtoFK(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GamePipeline(*args, **kwargs)->None:
"""
"""
pass
def CreatePolygonCylinder(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshPinchTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorAddIterationStatePorts(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def attrCompatibility(*args, addAttr: bool=True, clear: bool=True, dumpTable: bool=True,
enable: bool=True, nodeRename: AnyStr="", pluginNode: AnyStr="",
removeAttr: bool=True, renameAttr: AnyStr="", type: AnyStr="", version:
AnyStr="", **kwargs)->None:
"""
This command is used by Maya to handle compatibility issues between file format versions by
providing a mechanism to describe differences between two versions Plug-in writers can
make use of this command to handle attribute compatibility changes to files. The first
optional command argument argument is a node type name and the second optional comm
:param addAttr: (C) Add the given attribute to the named node
:param clear: (C) Clear out the compatibility table This is only used internally for
debugging purposes
:param dumpTable: (C) Dump the current contents of the compatibility table This is only
used internally for debugging purposes
:param enable: (C) Enable or disable the compatibility table This is only used internally
for debugging purposes
:param nodeRename: (C) Replace all uses of the node type 'nodeName' with given string
:param pluginNode: (C) Registers the string argument as a plug-in node type This is
necessary for subsequent attrCompatibility calls that reference node attributes of unlo
:param removeAttr: (C) Remove the given attribute from the named node
:param renameAttr: (C) Change the short name of the attribute specified in the command's
arguments to the new short name provided as a parameter to this flag Once the mapp
:param type: (C) Change the type of the given attribute to the given type
:param version: (C) Set the version target for subsequent commands to the given string
:returns:
"""
pass
def timeEditor(*args, allClips: AnyStr="", clipId: Union[int, List[int]]=0, commonParentTrack:
bool=True, composition: AnyStr="", drivingClipsForAttr: AnyStr="",
drivingClipsForObj: List[AnyStr, int]=None, includeParent: bool=True, mute:
bool=True, selectedClips: AnyStr="", topLevelClips: AnyStr="", q=True,
query=True, **kwargs)->Union[AnyStr, Any]:
"""
General Time Editor commands
:param allClips: (C) Return an exhaustive (recursive) list of all clip IDs from the active
composition Arguments may be used to filter the returning result An empty str
:param clipId: (C M) ID of the clip to be edited
:param commonParentTrack: (C) Locate the common parent track node and track index of the
given clip IDs Requires a list of clip IDs to be specified using the clipId flag The for
:param composition: (C) A flag to use in conjunction with -dca/drivingClipsForObj to
indicate the name of composition to use By default if this flag is not provided, curren
:param drivingClipsForAttr: (C) Return a list of clips driving the specified attribute(s)
If the composition is not specified, current active composition will be used
:param drivingClipsForObj: (C) Return a list of clips driving the specified object(s) with
an integer value indicating the matching mode If no object is specified explicitly, the
:param includeParent: (C) A toggle flag to use in conjunction with -dca/drivingClipsForObj
When toggled, parent clip is included in selection (the entire hierarchy will be se
:param mute: (C Q) Mute/unmute Time Editor
:param selectedClips: (C) Return a list of clip IDs of currently selected Time Editor clips
Arguments may be used to filter the returning result An empty string will return
:param topLevelClips: (C) Return a list of all top-level clip IDs from the active
composition Arguments may be used to filter the returning result An empty string will
retur
:returns: Command result
"""
pass
def ParticleInstancerOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PerformanceSettingsWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def smoothTangentSurface(*args, caching: bool=True, direction: Union[int, bool]=1, nodeState:
Union[int, bool]=0, parameter: Union[float, List[float], bool]=0.0,
smoothness: Union[int, bool]=1, constructionHistory: bool=True, name:
AnyStr="", object: bool=True, replaceOriginal: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The smoothTangentSurface command smooths the surface along an isoparm at each parameter
value The name of the surface is returned and if history is on, the name of the resulting
dependency node is also returned This command only applies to parameter values with a
multiple knot value (If the given parameter value has no multiple knot associated w
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param direction: (C Q E) Direction in which to smooth knot: 0 - V direction, 1 - U
direction Default: 1
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param parameter: (C Q E M) Parameter value(s) where knots are added Default: 0.0
:param smoothness: (C Q E) Smoothness to get: 0 - Tangent, 1 - Maximum (based on the
degree) Default: 1
:param constructionHistory: (C) Turn the construction history on or off
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def SetFullBodyIKKeysSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolygonCollapseFaces(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSplineCacheCreateOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSplineCacheExport(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetEditor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeRestoreLastClosedTab(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HIKSetFullBodyKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyBrushMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def baseView(*args, itemInfo: Union[AnyStr, bool]="", itemList: bool=True, viewDescription:
bool=True, viewLabel: bool=True, viewList: bool=True, viewName: Union[AnyStr,
bool]="", q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
A view defines the layout information for the attributes of a particular node type or
container Views can be selected from a set of built-in views or may be defined on an
associated container template This command queries the view-related information for a
container node or for a given template The information returned from this command will be
:param itemInfo: (Q) Used in query mode in conjunction with the itemList flag The command
will return a list of information for each item in the view, the information fi
:param itemList: (Q) Used in query mode, the command will return a list of information for
each item in the view The viewName flag is used to select the view to query T
:param viewDescription: (Q) Used in query mode, returns the description field associated
with the selected view If no description was defined for this view, the value will be e
:param viewLabel: (Q) Used in query mode, returns the display label associated with the
view An appropriate label suitable for the user interface will be returned based o
:param viewList: (Q) Used in query mode, command will return a list of all views defined
for the given target (container or template)
:param viewName: (Q) Used in query mode, specifies the name of the queried view when used
in conjunction with a template target When used in conjunction with a container
:returns:
"""
pass
def ProjectTangentOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RoundToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorSetSmallNodeSwatchSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolygonPaste(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def nurbsToSubdivPref(*args, bridge: Union[int, bool]=0, capType: Union[int, bool]=0,
collapsePoles: bool=True, matchPeriodic: bool=True, maxPolyCount:
Union[int, bool]=0, offset: Union[float, bool]=0.0, reverseNormal:
bool=True, solidType: Union[int, bool]=0, trans00: Union[float, bool]=0.0,
trans01: Union[float, bool]=0.0, trans02: Union[float, bool]=0.0,
trans10: Union[float, bool]=0.0, trans11: Union[float, bool]=0.0,
trans12: Union[float, bool]=0.0, trans20: Union[float, bool]=0.0,
trans21: Union[float, bool]=0.0, trans22: Union[float, bool]=0.0,
trans30: Union[float, bool]=0.0, trans31: Union[float, bool]=0.0,
trans32: Union[float, bool]=0.0, q=True, query=True,
**kwargs)->Union[None, Any]:
"""
This command sets the values used by the nurbs-to-subdivision surface preference This
preference is used by the nurbs creation commands and is saved between Maya sessions To
query any of the flags, use the "-query" flag For more information on the flags, see the
node documentation for the "nurbsToSubdivProc" node
:param bridge: (C Q) Valid values are 0, 1, 2 or 3
:param capType: (C Q) Valid values are 0 or 1
:param collapsePoles: (C Q)
:param matchPeriodic: (C Q)
:param maxPolyCount: (C Q)
:param offset: (C Q)
:param reverseNormal: (C Q)
:param solidType: (C Q) Valid values are 0, 1 or 2
:param trans00: (C Q)
:param trans01: (C Q)
:param trans02: (C Q)
:param trans10: (C Q)
:param trans11: (C Q)
:param trans12: (C Q)
:param trans20: (C Q)
:param trans21: (C Q)
:param trans22: (C Q)
:param trans30: (C Q)
:param trans31: (C Q)
:param trans32: (C Q)
:returns:
"""
pass
def audioTrack(*args, insertTrack: int=0, lock: bool=True, mute: bool=True, numTracks:
Union[int, bool]=0, removeEmptyTracks: bool=True, removeTrack: int=0, solo:
bool=True, swapTracks: List[int, int]=None, title: Union[AnyStr, bool]="",
track: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[None, Any]:
"""
This command is used for inserting and removing tracks related to the audio clips displayed
in the sequencer It can also be used to modify the track state, for example, to lock or
mute a track
:param insertTrack: (C) This flag is used to insert a new empty track at the track index
specified Indices are 1-based
:param lock: (C Q E) This flag specifies whether all audio clips on the same track as the
specified audio node are to be locked at their current location and track
:param mute: (C Q E) This flag specifies whether all audio clips on the same track as the
specified audio node are to be muted or not
:param numTracks: (Q) To query the number of audio tracks
:param removeEmptyTracks: (C) This flag is used to remove all tracks that have no clips
:param removeTrack: (C) This flag is used to remove the track with the specified index The
track must have no clips on it before it can be removed
:param solo: (C Q E) This flag specifies whether all audio clips on the same track as the
specified audio node are to be soloed or not
:param swapTracks: (C) This flag is used to swap the contents of two specified tracks
Indices are 1-based
:param title: (C Q E) This flag specifies the title for the track
:param track: (C Q E) Specify the track on which to operate by using the track's
trackNumber In query mode, this flag needs a value
:returns:
"""
pass
def imfPlugins(*args, extension: Union[AnyStr, bool]="", keyword: Union[AnyStr, bool]="",
multiFrameSupport: Union[AnyStr, bool]="", pluginName: Union[AnyStr, bool]="",
readSupport: Union[AnyStr, bool]="", writeSupport: Union[AnyStr, bool]="",
q=True, query=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command queries all the available imf plugins for its name, keyword or image file
extension Only one of the attributes (name, keyword or extension) can be queried at a time
If no flags are specified, this command returns a list of all available plugin names
:param extension: (C Q) image file extension
:param keyword: (C Q) imf keyword
:param multiFrameSupport: (C Q) multi frame IO is supported
:param pluginName: (C Q) imf plugin name
:param readSupport: (C Q) read operation is supported
:param writeSupport: (C Q) write operation is supported
:returns: Command result
"""
pass
def UnitizeUVsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def polySmooth(*args, caching: bool=True, constructionHistory: bool=True, name: AnyStr="",
nodeState: Union[int, bool]=0, continuity: Union[float, bool]=1.0, degree: int=0,
divisions: Union[int, bool]=1, divisionsPerEdge: int=0, keepBorder: bool=True,
keepHardEdge: bool=False, keepMapBorders: int=0, keepSelectionBorder: bool=False,
keepTesselation: bool=True, keepTessellation: bool=True, method: int=0,
osdCreaseMethod: Union[int, bool]=0, osdFvarBoundary: Union[int, bool]=0,
osdFvarPropagateCorners: bool=True, osdSmoothTriangles: bool=True,
osdVertBoundary: Union[int, bool]=0, propagateEdgeHardness: bool=False,
pushStrength: float=0.0, roundness: float=0.0, smoothUVs: bool=True,
subdivisionLevels: int=0, subdivisionType: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Smooth a polygonal object This command works on polygonal objects or faces
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param continuity: (C Q E) This flag specifies the smoothness parameter The minimum value
of 0.0 specifies that the faces should only be subdivided Maximum value of 1.0 smoot
:param degree: (C) Degree of the resulting limit surface
:param divisions: (C Q E) This flag specifies the number of recursive smoothing steps C:
Default is 1 Q: When queried, this flag returns an int
:param divisionsPerEdge: (C) Number of subdivisions along one edge for each step
:param keepBorder: (C Q E) If on, the border of the object will not move during smoothing
operation C: Default is "on" Q: When queried, this flag returns an int
:param keepHardEdge: (C Q E) If true, vertices on hard edges will not be modified C:
Default is false Q: When queried, this flag returns a boolean
:param keepMapBorders: (C) Treatment of UV map borders 0 - all map border edges will be
smoothed 1 - map borders that are also geometry borders will be smoothed 2 - no map bord
:param keepSelectionBorder: (C Q E) If true, vertices on border of the selection will not
be modified C: Default is false Q: When queried, this flag returns a boolean
:param keepTesselation: (C) If true: the object will be smoothed consistently from frame to
frame This is best when the object is being deformed or animated If false: non-sta
:param keepTessellation: (C) If true: the object will be smoothed consistently from frame
to frame This is best when the object is being deformed or animated If false: non-sta
:param method: (C) Type of smoothing algorithm to use 0 - exponential - traditional
smoothing 1 - linear - number of faces per edge grows linearly
:param osdCreaseMethod: (C Q E) Controls how boundary edges and vertices are interpolated
:param osdFvarBoundary: (C Q E) Controls how boundaries are treated for face-varying data
(UVs and Vertex Colors)
:param osdFvarPropagateCorners: (C Q E)
:param osdSmoothTriangles: (C Q E) Apply a special subdivision rule be applied to all
triangular faces that was empirically determined to make triangles subdivide more smoothly
:param osdVertBoundary: (C Q E) Controls how boundary edges and vertices are interpolated
:param propagateEdgeHardness: (C Q E) If true, edges which are a result of smoothed edges
will be given the same value for their edge hardness New subdivided edges will always be
smooth
:param pushStrength: (C) COMMENT 0.0 is approximation, 1.0 is interpolation scheme
:param roundness: (C) When 1.0, push vectors are renormalized to keep length constant
:param smoothUVs: (C) If true: UVs as well as geometry will be smoothed
:param subdivisionLevels: (C) Number of times the subdivide and smooth operation is run
:param subdivisionType: (C Q E) The subdivision method used for smoothing C: Default is 0
0: Maya Catmull-Clark 1: OpenSubdiv Catmull-Clark
:returns: The node name.
"""
pass
def progressBar(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, beginProgress: bool=True, defineTemplate: AnyStr="",
docTag: Union[AnyStr, bool]="", dragCallback: Script=None, dropCallback:
Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, endProgress: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isCancelled: bool=True,
isInterruptable: bool=True, isMainProgressBar: bool=True, isObscured: bool=True,
manage: bool=True, maxValue: Union[int, bool]=0, minValue: Union[int, bool]=0,
noBackground: bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True, progress:
Union[int, bool]=0, status: Union[AnyStr, bool]="", statusBarMessage: AnyStr="",
step: int=0, useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Creates a progress bar control that graphically fills in as its progress value increases.
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param beginProgress: (C E) Only valid for the main progress bar Shows the main progress
bar (normally in the Help Line) This is normally issued through MEL when a length compu
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param endProgress: (E) Only valid for the main progress bar Hides the progress bar No
other flags can be used at the same time This is normally issued through MEL in resp
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isCancelled: (Q) Returns true if the user has tried to cancel the operation Returns
false otherwise
:param isInterruptable: (C Q E) Only valid for the main progress bar Returns true if the
isCancelled flag should respond to attempts to cancel the operation Setting this to true
wi
:param isMainProgressBar: (C Q E) Determines whether this progressBar is used to show the
progress of all basic operations such as Open/Save file The main progressBar behaves very
di
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maxValue: (C Q E) The maximum or "ending" value of the progress indicator If the
progress value is greater than the -max/maxValue, the progress value will be set to t
:param minValue: (C Q E) The minimum or "starting" value of the progress indicator If the
progress value is less than the -min/minValue, the progress value will be set to th
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param progress: (C Q E) The amount of progress currently shown on the control The value
will always be between min and max Default is equal to the minimum when the control
:param status: (C Q E) Only valid for the main progress bar Sets the contents of the
helpLine control when the progressBar is showing Use this instead of setting the helpL
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param step: (E) Increments the -pr/progress value by the amount specified
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def FrameSelectedWithoutChildren(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def getModifiers(*args, **kwargs)->int:
"""
This command returns the current state of the modifier keys The state of each modifier can
be obtained by testing for the modifier's corresponding bit value in the return value
Shift is bit 1, Ctrl is bit 3, Alt is bit 4, and bit 5 is the 'Windows' key on Windows
keyboards and the Command key on Mac keyboards See the provided example for more de
:returns: indicating which modifier keys are pressed.
"""
pass
def texRotateContext(*args, editPivotMode: bool=True, exists: bool=True, image1: Union[AnyStr,
bool]="", image2: Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="",
position: bool=True, snap: bool=True, snapRelative: bool=True, snapValue:
Union[float, bool]=0.0, tweakMode: bool=True, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command can be used to create, edit, or query a rotate context for the UV Editor Note
that the above flag controls the global behaviour of all texture editor rotate contexts
Changing one context independently is not allowed Changing a context's behaviour using the
above flag, will change all existing texture editor rotate contexts
:param editPivotMode: (Q) Returns true when the manipulator is in edit pivot mode
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param position: (Q) Returns the current position of the manipulator
:param snap: (Q E) Sets or queries whether snapping is to be used
:param snapRelative: (Q E) Sets or queries whether snapping is relative
:param snapValue: (Q E) Sets or queries the size of the snapping increment
:param tweakMode: (Q E) When true, the manipulator is hidden and highlighted components can
be selected and rotated in one step using a click-drag interaction
:returns: : name of the context created
"""
pass
def GpuCacheImport(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ConvertToBreakdown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def WhatsNewStartupDialogOn(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSetFreezeBrushToolOption(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def viewLookAt(*args, position: List[float, float, float]=None, **kwargs)->None:
"""
The viewLookAt command positions the specified camera so it is looking at the centroid of
all selected objects If no objects are specified the camera will look at the ground plane
:param position: (C) Position in world space to make the camera look at
:returns:
"""
pass
def scriptTable(*args, afterCellChangedCmd: Script=None, annotation: Union[AnyStr, bool]="",
backgroundColor: Union[List[float, float, float], bool]=None,
cellBackgroundColorCommand: Script=None, cellChangedCmd: Script=None,
cellForegroundColorCommand: Script=None, cellIndex: Union[List[int, int],
bool]=None, cellValue: Union[AnyStr, bool]="", clearRow: int=0, clearTable:
bool=True, columnFilter: List[int, AnyStr]=None, columnWidth: Union[List[int,
int], List[List[int, int]]]=None, columns: Union[int, bool]=0, defineTemplate:
AnyStr="", deleteRow: int=0, docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dropCallback: Script=None, editable: bool=True, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, excludingHeaders:
bool=True, exists: bool=True, fullPathName: bool=True, getCellCmd: Script=None,
height: Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, insertRow: int=0, isObscured: bool=True, label: Union[List[int,
AnyStr], List[List[int, AnyStr]]]=None, manage: bool=True, multiEditEnabled:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
rowHeight: Union[int, bool]=0, rows: Union[int, bool]=0, rowsRemovedCmd:
Script=None, rowsToBeRemovedCmd: Script=None, selectedCells: Union[List[int],
bool]=None, selectedColumns: Union[List[int], bool]=None, selectedRow:
bool=True, selectedRows: Union[List[int], bool]=None, selectionBehavior:
Union[int, bool]=0, selectionChangedCmd: Script=None, selectionMode: Union[int,
bool]=0, sortEnabled: bool=True, statusBarMessage: AnyStr="",
underPointerColumn: bool=True, underPointerRow: bool=True, useDoubleClickEdit:
bool=True, useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand:
Union[Script, bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True,
edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates/edits/queries the script table control
:param afterCellChangedCmd: (C E) Sets the script to call after the value of a cell has
been changed The procedure is called with 2 integer arguments specifying the row and
column fo
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param cellBackgroundColorCommand: (C E) Sets the script to call when it requires the
background color of a cell The procedure is called with 2 integer arguments specifying the
row and colu
:param cellChangedCmd: (C E) Sets the script to call when somebody has changed the value of
a cell The procedure is called with 2 integer arguments specifying the row and column
:param cellForegroundColorCommand: (C E) Sets the script to call when it requires the
foreground color of a cell The procedure is called with 2 integer arguments specifying the
row and colu
:param cellIndex: (Q E) used with cellValue , to give the index of row and column This flag
and its argument must be passed to the command before the -q flag (see examples)
:param cellValue: (Q E) query and set the cell value on the table by the index of row and
column referred in flag -cellIndex In edit mode, if flag -multiEditEnabled is True
:param clearRow: (E) Clear the contents for all the cells on the specified row Any
procedure specified by the -gcc flag will be called to populate the cleared cells The
:param clearTable: (E) Clears the contents of all the cells in the table Any procedure
specified by the -gcc flag will be called to populate the cleared cells
:param columnFilter: (C E) Filter the specified column with the string value provided Set
filter to columns 0 will apply the filter to all columns The filter is case insensit
:param columnWidth: (C E M) Set the width of the specified column The column number is
1-based (ie the first column is 1 not 0)
:param columns: (C Q E) Set the number of columns in the table
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param deleteRow: (E) Delete the specified row The row number is 1-based (i.e the first
row is 1 not 0)
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param editable: (C Q E) The edit state of the table By default, this flag is set to true,
and the table can be edited If false, then the table is 'read only' and cannot be
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param excludingHeaders: (Q) when querying the count for the rows or the columns , the
number returned will not include the headers
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param getCellCmd: (C E) Sets the script to call when it requires the contents of a cell
The procedure is called with 2 integer arguments specifying the row and column for w
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param insertRow: (E) Insert an empty row before the specified row Any procedure specified
by the -gcc flag will be called to populate the new new cells The row number i
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param label: (C E M) Set the label of the specified column The column number is 1-based
(ie the first column is 1 not 0)
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param multiEditEnabled: (C Q E) True: scriptTable support multi-editing function
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param rowHeight: (C Q E) Sets the height for each row in the scriptTable
:param rows: (C Q E) Set the number of rows in the table
:param rowsRemovedCmd: (C E) Sets the script to call after rows are removed by pressing
'delete' or 'backspace' key The procedure is called with one argument specifying that sel
:param rowsToBeRemovedCmd: (C E) Sets the script to call when 'delete' or 'backspace' key
is pressed The procedure is called with one argument specifying the selected rows to be
rem
:param selectedCells: (Q E) Select the cells or return the cells currently selected This
returns a list of indices, the first of each pair is the row, the second is the column,
:param selectedColumns: (Q E) select the columns or return the columns currently selected
This returns a list of indices of each column completely selected The returned column nu
:param selectedRow: (Q) The current row selected The returned row number is 1-based (ie
the first row is 1 not 0)
:param selectedRows: (Q E) In edit mode, select the rows given as argument In query mode,
return a list of indices of completely selected rows The row numbers are 1-based
:param selectionBehavior: (C Q E) Set the selection behavior, valid values are from 0 to 2
(inclusive) 0 - Selecting single items 1 - Selecting only rows 2 - Selecting only
columns
:param selectionChangedCmd: (C E) Sets the script to call when a complete selection
operation triggered by the user has occurred successfully The script does not pass any
parameters
:param selectionMode: (C Q E) Set the selection Mode, valid values are from 0 to 4
(inclusive) 0 - Items cannot be selected 1 - When the user selects an item, any
already-selecte
:param sortEnabled: (C Q E) enable scriptTable sorted by column default value is false and
the whole row will be sorted
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param underPointerColumn: (Q) The column under the pointer The returned column number is
1-based (i.e the first column is 1 not 0)
:param underPointerRow: (Q) The row under the pointer The returned row number is 1-based
(i.e the first row is 1 not 0)
:param useDoubleClickEdit: (C Q E) this controls the cell edit mode False: Click in the
cell to select (in Row selection, the last cell of the row is edited, in Column selection,
the l
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The full path name to the created script table control.
"""
pass
def dR_decreaseManipSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetToFaceNormals(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ChamferVertex(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def about(*args, apiVersion: bool=True, application: bool=True, batch: bool=True,
buildDirectory: bool=True, buildVariant: bool=True, codeset: bool=True,
compositingManager: bool=True, connected: bool=True, ctime: bool=True, currentDate:
bool=True, currentTime: bool=True, cutIdentifier: bool=True, date: bool=True,
environmentFile: bool=True, evalVersion: bool=True, file: bool=True, fontInfo:
bool=True, helpDataDirectory: bool=True, installedVersion: bool=True, ioVersion:
bool=True, irix: bool=True, is64: bool=True, languageResources: bool=True, linux:
bool=True, linux64: bool=True, liveUpdate: bool=True, localizedResourceLocation:
bool=True, ltVersion: bool=True, macOS: bool=True, macOSppc: bool=True, macOSx86:
bool=True, majorVersion: bool=True, minorVersion: bool=True, ntOS: bool=True,
operatingSystem: bool=True, operatingSystemVersion: bool=True, patchVersion:
bool=True, preferences: bool=True, product: bool=True, qtVersion: bool=True, tablet:
bool=True, tabletMode: bool=True, uiLanguage: bool=True, uiLanguageForStartup:
bool=True, uiLanguageIsLocalized: bool=True, uiLocaleLanguage: bool=True, version:
bool=True, win64: bool=True, windowManager: bool=True, windows: bool=True,
**kwargs)->AnyStr:
"""
This command displays version information about the application if it is executed without
flags If one of the above flags is specified then the specified version information is
returned
:param apiVersion: (C) Returns the api version
:param application: (C) Returns the application name string
:param batch: (C) Returns true if application is in batch mode
:param buildDirectory: (C) Returns the build directory string
:param buildVariant: (C) Returns the build variant string
:param codeset: (C) Returns a string identifying the codeset (codepage) of the locale that
Maya is running in Example return values include "UTF-8", "ISO-8859-1", "1252
:param compositingManager: (C) On Linux, returns true if there is a compositing manager
running; on all other platforms, it always returns true
:param connected: (C) Return whether the user is connected or not to the Internet
:param ctime: (C) Returns the current time in the format Wed Jan 02 02:03:55 1980\n\0
:param currentDate: (C) Returns the current date in the format yyyy/mm/dd, e.g 2003/05/04
:param currentTime: (C) Returns the current time in the format hh:mm:ss, e.g 14:27:53
:param cutIdentifier: (C) Returns the cut string
:param date: (C) Returns the build date string
:param environmentFile: (C) Returns the location of the application defaults file
:param evalVersion: (C) This flag is now deprecated Always returns false, as the eval
version is no longer supported
:param file: (C) Returns the file version string
:param fontInfo: (C) Returns a string of the specifications of the fonts requested, and the
specifications of the fonts that are actually being used
:param helpDataDirectory: (C) Returns the help data directory
:param installedVersion: (C) Returns the product version string
:param ioVersion: (C) Returns true if this is the Maya IO version of the application
:param irix: (C) Returns true if the operating system is Irix Always false with support
for Irix removed
:param is64: (C) Returns true if the application is 64 bit
:param languageResources: (C) Returns a string array of the currently installed language
resources Each string entry consists of three elements delimited with a colon (':') The
:param linux: (C) Returns true if the operating system is Linux
:param linux64: (C) Returns true if the operating system is Linux 64 bit
:param liveUpdate: (C) This flag is deprecated(2019) and may be removed in future releases
of Maya Returns Autodesk formatted product information
:param localizedResourceLocation: (C) Returns the path to the top level of the localized
resource directory, if we are running in an alternate language Returns an empty string if
we are
:param ltVersion: (C) Returns true if this is the Maya LT version of the application
:param macOS: (C) Returns true if the operating system is Macintosh
:param macOSppc: (C) Returns true if the operating system is a PowerPC Macintosh
:param macOSx86: (C) Returns true if the operating system is an Intel Macintosh
:param majorVersion: (C) Returns the major version of Maya
:param minorVersion: (C) Returns the minor version of Maya
:param ntOS: (C) Returns true if the operating system is Windows
:param operatingSystem: (C) Returns the operating system type Valid return types are "nt",
"win64", "mac", "linux" and "linux64"
:param operatingSystemVersion: (C) Returns the operating system version on Linux this
returns the equivalent of uname -srvm
:param patchVersion: (C) Returns the patch version of Maya
:param preferences: (C) Returns the location of the preferences directory
:param product: (C) Returns the license product name
:param qtVersion: (C) Returns Qt version string
:param tablet: (C) Windows only Returns true if the PC is a Tablet PC
:param tabletMode: (C) Windows 8 (and above) only If your device is a Tablet PC, then the
convertible mode the device is currently running in Returns either: tablet or la
:param uiLanguage: (C) Returns the language that Maya's running in Example return values
include "en_US" for English and "ja_JP" for Japanese
:param uiLanguageForStartup: (C) Returns the language that is used for Maya's next start up
This is read from config file and is rewritten after setting ui language in preference
:param uiLanguageIsLocalized: (C) Returns true if we are running in an alternate language,
not the default (English)
:param uiLocaleLanguage: (C) Returns the language locale of the OS English is default
:param version: (C) Returns the version string
:param win64: (C) Returns true if the operating system is Windows x64 based
:param windowManager: (C) Returns the name of the Window Manager that is assumed to be
running
:param windows: (C) Returns true if the operating system is Windows based
:returns: The application's version information.
"""
pass
def curveEPCtx(*args, bezier: bool=True, degree: Union[int, bool]=0, exists: bool=True,
history: bool=True, image1: Union[AnyStr, bool]="", image2: Union[AnyStr,
bool]="", image3: Union[AnyStr, bool]="", name: AnyStr="", preserveShape:
bool=True, preserveShapeFraction: Union[float, bool]=0.0, refit: bool=True,
uniform: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
The curveEPCtx command creates a new context for creating curves by placing edit points
:param bezier: (C Q E) Use bezier curves
:param degree: (C Q E) Curve degree
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:param preserveShape: (C Q E) Set this flag to make the operation preserve the shape
:param preserveShapeFraction: (C Q E) Fraction value used when preserving the shape
:param refit: (C Q E) Set this flag to refit the curve
:param uniform: (C Q E) Should the curve use uniform parameterization?
:returns: (name of the new context)
"""
pass
def selectType(*args, allComponents: bool=True, allObjects: bool=True, animBreakdown: bool=True,
animCurve: bool=True, animInTangent: bool=True, animKeyframe: bool=True,
animOutTangent: bool=True, byName: Union[List[AnyStr, bool], List[List[AnyStr,
bool]]]=None, camera: bool=True, cluster: bool=True, collisionModel: bool=True,
controlVertex: bool=True, curve: bool=True, curveKnot: bool=True,
curveOnSurface: bool=True, curveParameterPoint: bool=True, dimension: bool=True,
dynamicConstraint: bool=True, edge: bool=True, editPoint: bool=True, emitter:
bool=True, facet: bool=True, field: bool=True, fluid: bool=True, follicle:
bool=True, hairSystem: bool=True, handle: bool=True, hull: bool=True,
ikEndEffector: bool=True, ikHandle: bool=True, imagePlane: bool=True,
implicitGeometry: bool=True, isoparm: bool=True, joint: bool=True, jointPivot:
bool=True, lattice: bool=True, latticePoint: bool=True, light: bool=True,
localRotationAxis: bool=True, locator: bool=True, locatorUV: bool=True,
locatorXYZ: bool=True, meshUVShell: bool=True, motionTrailPoint: bool=True,
motionTrailTangent: bool=True, nCloth: bool=True, nParticle: bool=True,
nParticleShape: bool=True, nRigid: bool=True, nonlinear: bool=True, nurbsCurve:
bool=True, nurbsSurface: bool=True, objectComponent: bool=True,
orientationLocator: bool=True, particle: bool=True, particleShape: bool=True,
plane: bool=True, polymesh: bool=True, polymeshEdge: bool=True, polymeshFace:
bool=True, polymeshFreeEdge: bool=True, polymeshUV: bool=True, polymeshVertex:
bool=True, polymeshVtxFace: bool=True, queryByName: Union[AnyStr, bool]="",
rigidBody: bool=True, rigidConstraint: bool=True, rotatePivot: bool=True,
scalePivot: bool=True, sculpt: bool=True, selectHandle: bool=True, spring:
bool=True, springComponent: bool=True, stroke: bool=True, subdiv: bool=True,
subdivMeshEdge: bool=True, subdivMeshFace: bool=True, subdivMeshPoint: bool=True,
subdivMeshUV: bool=True, surfaceEdge: bool=True, surfaceFace: bool=True,
surfaceKnot: bool=True, surfaceParameterPoint: bool=True, surfaceRange:
bool=True, surfaceUV: bool=True, texture: bool=True, vertex: bool=True, q=True,
query=True, **kwargs)->Union[bool, Any]:
"""
The selectType command is used to change the set of allowable types of objects that can be
selected when using the select tool It accepts no other arguments besides the flags
There are basically two different types of items that are selectable when interactively
selecting objects in the 3D views They are classified as objects (entire objects) o
:param allComponents: (C Q) Set all component selection masks on/off
:param allObjects: (C Q) Set all object selection masks on/off
:param animBreakdown: (C Q) Set animation breakdown selection mask on/off
:param animCurve: (C Q) Set animation curve selection mask on/off
:param animInTangent: (C Q) Set animation in-tangent selection mask on/off
:param animKeyframe: (C Q) Set animation keyframe selection mask on/off
:param animOutTangent: (C Q) Set animation out-tangent selection mask on/off
:param byName: (C M) Set the specified user-defined selection mask on/off (object flag)
:param camera: (C Q) Set camera selection mask on/off (object flag)
:param cluster: (C Q) Set cluster selection mask on/off (object flag)
:param collisionModel: (C Q) Set collision model selection mask on/off (object flag)
:param controlVertex: (C Q) Set control vertex selection mask on/off (component flag)
:param curve: (C Q) Set curve selection mask on/off (object flag)
:param curveKnot: (C Q) Set curve knot selection mask on/off (component flag)
:param curveOnSurface: (C Q) Set curve-on-surface selection mask on/off (object flag)
:param curveParameterPoint: (C Q) Set curve parameter point selection mask on/off
(component flag)
:param dimension: (C Q) Set dimension shape selection mask on/off (object flag)
:param dynamicConstraint: (C Q) Set dynamicConstraint selection mask on/off (object flag)
:param edge: (C Q) Set mesh edge selection mask on/off (component flag)
:param editPoint: (C Q) Set edit-point selection mask on/off (component flag)
:param emitter: (C Q) Set emitter selection mask on/off (object flag)
:param facet: (C Q) Set mesh face selection mask on/off (component flag)
:param field: (C Q) Set field selection mask on/off (object flag)
:param fluid: (C Q) Set fluid selection mask on/off (object flag)
:param follicle: (C Q) Set follicle selection mask on/off (object flag)
:param hairSystem: (C Q) Set hairSystem selection mask on/off (object flag)
:param handle: (C Q) Set object handle selection mask on/off (object flag)
:param hull: (C Q) Set hull selection mask on/off (component flag)
:param ikEndEffector: (C Q) Set ik end effector selection mask on/off (object flag)
:param ikHandle: (C Q) Set ik handle selection mask on/off (object flag)
:param imagePlane: (C Q) Set image plane selection mask on/off (component flag)
:param implicitGeometry: (C Q) Set implicit geometry selection mask on/off (object flag)
:param isoparm: (C Q) Set surface iso-parm selection mask on/off (component flag)
:param joint: (C Q) Set ik handle selection mask on/off (object flag)
:param jointPivot: (C Q) Set joint pivot selection mask on/off (component flag)
:param lattice: (C Q) Set lattice selection mask on/off (object flag)
:param latticePoint: (C Q) Set lattice point selection mask on/off (component flag)
:param light: (C Q) Set light selection mask on/off (object flag)
:param localRotationAxis: (C Q) Set local rotation axis selection mask on/off (component
flag)
:param locator: (C Q) Set locator (all types) selection mask on/off (object flag)
:param locatorUV: (C Q) Set uv locator selection mask on/off (object flag)
:param locatorXYZ: (C Q) Set xyz locator selection mask on/off (object flag)
:param meshUVShell: (C Q) Set uv shell component mask on/off
:param motionTrailPoint: (C Q) Set motion point selection mask on/off
:param motionTrailTangent: (C Q) Set motion point tangent mask on/off
:param nCloth: (C Q) Set nCloth selection mask on/off (object flag)
:param nParticle: (C Q) Set nParticle point selection mask on/off (component flag)
:param nParticleShape: (C Q) Set nParticle shape selection mask on/off (object flag)
:param nRigid: (C Q) Set nRigid selection mask on/off (object flag)
:param nonlinear: (C Q) Set nonlinear selection mask on/off (object flag)
:param nurbsCurve: (C Q) Set nurbs-curve selection mask on/off (object flag)
:param nurbsSurface: (C Q) Set nurbs-surface selection mask on/off (object flag)
:param objectComponent: (C Q) Component flags apply to object mode
:param orientationLocator: (C Q) Set orientation locator selection mask on/off (object
flag)
:param particle: (C Q) Set particle point selection mask on/off (component flag)
:param particleShape: (C Q) Set particle shape selection mask on/off (object flag)
:param plane: (C Q) Set sketch plane selection mask on/off (object flag)
:param polymesh: (C Q) Set poly-mesh selection mask on/off (object flag)
:param polymeshEdge: (C Q) Set poly-mesh edge selection mask on/off (component flag)
:param polymeshFace: (C Q) Set poly-mesh face selection mask on/off (component flag)
:param polymeshFreeEdge: (C Q) Set poly-mesh free-edge selection mask on/off (component
flag)
:param polymeshUV: (C Q) Set poly-mesh UV point selection mask on/off (component flag)
:param polymeshVertex: (C Q) Set poly-mesh vertex selection mask on/off (component flag)
:param polymeshVtxFace: (C Q) Set poly-mesh vertexFace selection mask on/off (component
flag)
:param queryByName: (Q) Query the specified user-defined selection mask (object flag) In
query mode, this flag needs a value
:param rigidBody: (C Q) Set rigid body selection mask on/off (object flag)
:param rigidConstraint: (C Q) Set rigid constraint selection mask on/off (object flag)
:param rotatePivot: (C Q) Set rotate pivot selection mask on/off (component flag)
:param scalePivot: (C Q) Set scale pivot selection mask on/off (component flag)
:param sculpt: (C Q) Set sculpt selection mask on/off (object flag)
:param selectHandle: (C Q) Set select handle selection mask on/off (component flag)
:param spring: (C Q) Set spring shape selection mask on/off (object flag)
:param springComponent: (C Q) Set individual spring selection mask on/off (component
flag)
:param stroke: (C Q) Set the Paint Effects stroke selection mask on/off (object flag)
:param subdiv: (C Q) Set subdivision surfaces selection mask on/off (object flag)
:param subdivMeshEdge: (C Q) Set subdivision surfaces mesh edge selection mask on/off
(component flag)
:param subdivMeshFace: (C Q) Set subdivision surfaces mesh face selection mask on/off
(component flag)
:param subdivMeshPoint: (C Q) Set subdivision surfaces mesh point selection mask on/off
(component flag)
:param subdivMeshUV: (C Q) Set subdivision surfaces mesh UV map selection mask on/off
(component flag)
:param surfaceEdge: (C Q) Set surface edge selection mask on/off (component flag)
:param surfaceFace: (C Q) Set surface face selection mask on/off (component flag)
:param surfaceKnot: (C Q) Set surface knot selection mask on/off (component flag)
:param surfaceParameterPoint: (C Q) Set surface parameter point selection mask on/off
(component flag)
:param surfaceRange: (C Q) Set surface range selection mask on/off (component flag)
:param surfaceUV: (C Q) Set surface uv selection mask on/off (component flag)
:param texture: (C Q) Set texture selection mask on/off (object flag)
:param vertex: (C Q) Set mesh vertex selection mask on/off (component flag)
:returns: if a query operation
"""
pass
def ShowResultsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphEditorFrameCenterView(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshCloneTargetTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleCustomNURBSComponents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RenderDiagnostics(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_defLightTGL(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeSetLargeNodeSwatchSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ResolveInterpenetrationOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def WedgePolygon(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AttachCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXGetTakeLocalTimeSpan(*args, **kwargs)->None:
"""
"""
pass
def colorIndex(*args, hueSaturationValue: bool=True, resetToFactory: bool=True, resetToSaved:
bool=True, q=True, query=True, **kwargs)->Union[int, Any]:
"""
The index specifies a color index in the color palette The r, g, and b values (between
0-1) specify the RGB values (or the HSV values if the -hsv flag is used) for the color
:param hueSaturationValue: (C Q) Indicates that rgb values are really hsv values Upon
query, returns the HSV valuses as an array of 3 floats
:param resetToFactory: (C) Resets all color index palette entries to their factory
defaults
:param resetToSaved: (C) Resets all color palette entries to their saved values
:returns: Returns 1 on success.
"""
pass
def NURBSSmoothnessMediumOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ExtendSurfacesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HideSculptObjects(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TangetConstraintOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_SetGlobalTextureHeight(*args, **kwargs)->None:
"""
"""
pass
def ToggleUVTextureImage(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshImprintTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def createNurbsConeCtx(*args, **kwargs)->None:
"""
"""
pass
def iconTextScrollList(*args, allowMultiSelection: bool=True, annotation: Union[AnyStr,
bool]="", append: Union[AnyStr, List[AnyStr]]="", backgroundColor:
Union[List[float, float, float], bool]=None, changeCommand: Script=None,
defineTemplate: AnyStr="", deselectAll: bool=True, docTag: Union[AnyStr,
bool]="", doubleClickCommand: Script=None, dragCallback: Script=None,
dragFeedbackVisible: bool=True, dropCallback: Script=None,
dropRectCallback: Script=None, editIndexed: int=0, editable: bool=True,
enable: bool=True, enableBackground: bool=True, enableKeyboardFocus:
bool=True, exists: bool=True, fullPathName: bool=True, height: Union[int,
bool]=0, highlightColor: Union[List[float, float, float], bool]=None,
isObscured: bool=True, itemAt: Union[List[int, int], bool]=None,
itemTextColor: Union[List[int, float, float, float], List[List[int,
float, float, float]]]=None, manage: bool=True, noBackground: bool=True,
numberOfIcons: Union[int, bool]=0, numberOfPopupMenus: bool=True,
numberOfRows: bool=True, parent: Union[AnyStr, bool]="", popupMenuArray:
bool=True, preventOverride: bool=True, removeAll: bool=True,
selectCommand: Script=None, selectIndexedItem: Union[int, List[int],
bool]=0, selectItem: Union[AnyStr, List[AnyStr], bool]="",
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, visualRectAt:
Union[List[int, int], bool]=None, width: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates/edits/queries a text scrolling list The list can be in single select
mode where only one item at at time is selected, or in multi-select mode where many items
may be selected
:param allowMultiSelection: (C Q E) Specify multi or single selection mode
:param annotation: (C Q E) Annotate the control with an extra string value
:param append: (C E M) Add an item to the end of the list
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Script to run when the list changes
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param deselectAll: (C E) Deselect all items
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param doubleClickCommand: (C E) Specify the command to be executed when an item is double
clicked
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dragFeedbackVisible: (C E) Should the drag feedback be shown in the scrollbar?
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param dropRectCallback: (E) Adds a callback that is called when a drag and drop operation
is hovering above the drop site It returns the shape of the rectangle to be drawn to h
:param editIndexed: (C E) Index of the edited field
:param editable: (C E) Set the field to be editable or not
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param itemAt: (Q) Return the name of the item, if any, located at given point In query
mode, this flag needs a value
:param itemTextColor: (C E M) Set the text color of the item at the given index Arguments
are: index, red, green, and blue Indices are 1-based Each color component ranges in va
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfIcons: (Q) Number of icons
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param numberOfRows: (Q) Number of visible rows
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param removeAll: (C E) Remove all items
:param selectCommand: (C E) Specify the command to be executed when an item is selected
:param selectIndexedItem: (C Q E M) Select the indexed item Indices are 1-based
:param selectItem: (C Q E M) Select the item that contains the specified text
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param visualRectAt: (Q) Return the visual rectangle of the item, if any, located at given
point The result is a an array of 4 integers, in local coordinates, describing the
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def renderer(*args, addGlobalsNode: Union[AnyStr, bool]="", addGlobalsTab: List[AnyStr, AnyStr,
AnyStr]=None, batchRenderOptionsProcedure: Union[AnyStr, bool]="",
batchRenderOptionsStringProcedure: Union[AnyStr, bool]="", batchRenderProcedure:
Union[AnyStr, bool]="", cancelBatchRenderProcedure: Union[AnyStr, bool]="",
changeIprRegionProcedure: Union[AnyStr, bool]="", commandRenderProcedure:
Union[AnyStr, bool]="", exists: bool=True, globalsNodes: bool=True,
globalsTabCreateProcNames: bool=True, globalsTabLabels: bool=True,
globalsTabUpdateProcNames: bool=True, iprOptionsMenuLabel: Union[AnyStr, bool]="",
iprOptionsProcedure: Union[AnyStr, bool]="", iprOptionsSubMenuProcedure:
Union[AnyStr, bool]="", iprRenderProcedure: Union[AnyStr, bool]="",
iprRenderSubMenuProcedure: Union[AnyStr, bool]="", isRunningIprProcedure:
Union[AnyStr, bool]="", logoCallbackProcedure: Union[AnyStr, bool]="",
logoImageName: Union[AnyStr, bool]="", materialViewRendererList: bool=True,
materialViewRendererPause: bool=True, materialViewRendererSuspend: bool=True,
namesOfAvailableRenderers: bool=True, pauseIprRenderProcedure: Union[AnyStr,
bool]="", polyPrelightProcedure: Union[AnyStr, bool]="",
refreshIprRenderProcedure: Union[AnyStr, bool]="", renderDiagnosticsProcedure:
Union[AnyStr, bool]="", renderGlobalsProcedure: Union[AnyStr, bool]="",
renderMenuProcedure: Union[AnyStr, bool]="", renderOptionsProcedure: Union[AnyStr,
bool]="", renderProcedure: Union[AnyStr, bool]="", renderRegionProcedure:
Union[AnyStr, bool]="", renderSequenceProcedure: Union[AnyStr, bool]="",
rendererUIName: Union[AnyStr, bool]="", renderingEditorsSubMenuProcedure:
Union[AnyStr, bool]="", showBatchRenderLogProcedure: Union[AnyStr, bool]="",
showBatchRenderProcedure: Union[AnyStr, bool]="", showRenderLogProcedure:
Union[AnyStr, bool]="", startIprRenderProcedure: Union[AnyStr, bool]="",
stopIprRenderProcedure: Union[AnyStr, bool]="", supportColorManagement: bool=True,
textureBakingProcedure: Union[AnyStr, bool]="", unregisterRenderer: bool=True,
q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
Command to register renders This command allows you to specify the UI name and procedure
names for renderers The command also allow you to query the UI name and the procedure
names for the registered renders
:param addGlobalsNode: (C Q E) This flag allows the user to add a globals node the
specified renderer uses
:param addGlobalsTab: (C E) Add a tab associated with the specified renderer for the
unified render globals window
:param batchRenderOptionsProcedure: (C Q E) Set or query the batch render options procedure
associated with the specified renderer
:param batchRenderOptionsStringProcedure: (C Q E) Set or query the argument string that
will be used with the command line utility 'Render' when doing a batch render
:param batchRenderProcedure: (C Q E) Set or query the batch render procedure associated
with the specified renderer
:param cancelBatchRenderProcedure: (C Q E) Set or query returns the cancel batch render
procedure associated with the specified renderer
:param changeIprRegionProcedure: (C Q E) Set or query the change IPR region procedure
associated with the specified renderer
:param commandRenderProcedure: (C Q E) Set or query the command line rendering procedure
associated with the specified renderer
:param exists: (Q E) The flag returns true if the specified renderer is registered in the
registry, and it returns false otherwise
:param globalsNodes: (C Q E) This flag returns the list of render globals nodes the
specified renderer uses
:param globalsTabCreateProcNames: (C Q E) This flag returns the names of procedures that
are used to create the unified render globals window tabs that are associated with the
specified rende
:param globalsTabLabels: (C Q E) This flag returns the labels of unified render globals
window tabs that are associated with the specified renderer
:param globalsTabUpdateProcNames: (C Q E) This flag returns the names of procedures that
are used to update the unified render globals window tabs that are associated with the
specified rende
:param iprOptionsMenuLabel: (C Q E) Set or query the label for the IPR update options menu
which is under the render view's IPR menu
:param iprOptionsProcedure: (C Q E) Set or query the IPR render options procedure
associated with the specified renderer
:param iprOptionsSubMenuProcedure: (C Q E) Set or query the procedure for creating the sub
menu for the IPR update options menu which is under the render view's IPR menu
:param iprRenderProcedure: (C Q E) Set or query the IPR render command associated with the
specified renderer
:param iprRenderSubMenuProcedure: (C Q E) Set or query the procedure for creating the sub
menu for the IPR render menu which is under the render view's IPR menu
:param isRunningIprProcedure: (C Q E) Set or query the isRunningIpr command associated with
the specified renderer
:param logoCallbackProcedure: (C Q E) Set or query the procedure which is a callback
associated to the logo for the specified renderer For example, the logo and the callback
can be used
:param logoImageName: (C Q E) Set or query the logo image name for the specified renderer
The logo is a image representing the renderer
:param materialViewRendererList: (Q E) Returns the names of material view renderers that
are currently registered
:param materialViewRendererPause: (Q E) Specifies whether to pause the material viewer
Useful for globally halting updates to the material viewer The material view renderer will
remain su
:param materialViewRendererSuspend: (Q E) Specifies whether to suspend or resume the
material view renderer Useful for temporarily stopping the material view renderer while
another rendering
:param namesOfAvailableRenderers: (Q E) Returns the names of renderers that are currently
registered
:param pauseIprRenderProcedure: (C Q E) Set or query the pause IPR render procedure
associated with the specified renderer
:param polyPrelightProcedure: (C Q E) Set or query the polygon prelight procedure
associated with the specified renderer
:param refreshIprRenderProcedure: (C Q E) Set or query the refresh IPR render procedure
associated with the specified renderer
:param renderDiagnosticsProcedure: (C Q E) Set or query the render diagnostics procedure
associated with the specified renderer
:param renderGlobalsProcedure: (C Q E) This flag is obsolete It will be removed in the
next release
:param renderMenuProcedure: (C Q E) This flag is obsolete It will be removed in the next
release
:param renderOptionsProcedure: (C Q E) Set or query the render options procedure associated
with the specified renderer
:param renderProcedure: (C Q E) Set or query the render command associated with the
specified renderer
:param renderRegionProcedure: (C Q E) Set or query the render region procedure associated
with the specified renderer
:param renderSequenceProcedure: (C Q E) Set or query the sequence rendering procedure
associated with the specified renderer
:param rendererUIName: (C Q E) Set or query the rendererUIName for the specified renderer
The rendererUIName is the name of the renderer as it would appear in menus
:param renderingEditorsSubMenuProcedure: (C Q E) Set or query the procedure reponsible for
creating renderer specific editors submenu under the "Rendering Editors" menu for the
specified renderer
:param showBatchRenderLogProcedure: (C Q E) Set or query the log file batch procedure
associated with the specified renderer
:param showBatchRenderProcedure: (C Q E) Set or query the show batch render procedure
associated with the specified renderer
:param showRenderLogProcedure: (C Q E) Set or query the log file render procedure
associated with the specified renderer
:param startIprRenderProcedure: (C Q E) Set or query the start IPR render procedure
associated with the specified renderer
:param stopIprRenderProcedure: (C Q E) Set or query the stop IPR render procedure
associated with the specified renderer
:param supportColorManagement: (Q E) Specifies whether the renderer supports color
management
:param textureBakingProcedure: (C Q E) Set or query the texture baking procedure associated
with the specified renderer
:param unregisterRenderer: (Q E) Unregister the specified renderer
:returns:
"""
pass
def CreateSetOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisableAll(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleIKAllowRotation(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MakeMotionField(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectAllOutput(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorPickWalkDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmGeoRender(*args, **kwargs)->None:
"""
"""
pass
def HypershadeDuplicateWithConnections(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PolyMergeVerticesOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def EPCurveTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintFluidsTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetWorkingFrame(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artFluidAttrCtx(*args, accopacity: bool=False, activeListChangedProc: Union[AnyStr,
bool]="", afterStrokeCmd: Union[AnyStr, bool]="", alphaclamp: Union[AnyStr,
bool]="none", alphaclamplower: Union[float, bool]=0.0, alphaclampupper:
Union[float, bool]=1.0, attrSelected: Union[AnyStr, bool]="", autoSave:
Union[AnyStr, bool]="", beforeStrokeCmd: Union[AnyStr, bool]="",
brushalignment: bool=True, brushfeedback: bool=True, clamp: Union[AnyStr,
bool]="none", clamplower: Union[float, bool]=0.0, clampupper: Union[float,
bool]=1.0, clear: bool=True, colorAlphaValue: Union[float, bool]=0.0,
colorRGBAValue: Union[List[float, float, float, float], bool]=None,
colorRGBValue: Union[List[float, float, float], bool]=None, colorRamp:
Union[AnyStr, bool]="", colorfeedback: bool=False, colorfeedbackOverride:
bool=False, colorrangelower: Union[float, bool]=0.0, colorrangeupper:
Union[float, bool]=1.0, currentPaintableFluid: Union[AnyStr, bool]="",
dataTypeIndex: Union[int, bool]=0, delaySelectionChanged: bool=True,
disablelighting: bool=False, displayAsRender: bool=True, displayVelocity:
bool=True, doAutoSave: bool=True, dragSlider: AnyStr="", duringStrokeCmd:
Union[AnyStr, bool]="", dynclonemode: bool=True, exists: bool=True,
expandfilename: bool=True, exportaspectratio: Union[float, bool]=0.0,
exportfilemode: Union[AnyStr, bool]="luminance/rgb", exportfilesave:
AnyStr="", exportfilesizex: Union[int, bool]=0, exportfilesizey: Union[int,
bool]=0, exportfiletype: Union[AnyStr, bool]="", filterNodes: bool=True,
history: bool=True, image1: Union[AnyStr, bool]="", image2: Union[AnyStr,
bool]="", image3: Union[AnyStr, bool]="", importfileload: AnyStr="",
importfilemode: Union[AnyStr, bool]="alpha", importreassign: bool=False,
interactiveUpdate: bool=True, lastRecorderCmd: Union[AnyStr, bool]="",
lastStampName: Union[AnyStr, bool]="", lowerradius: Union[float, bool]=0.0,
makeStroke: Union[int, List[int], bool]=0, mappressure: Union[AnyStr,
bool]="none", maxvalue: Union[float, bool]=1.0, minvalue: Union[float,
bool]=0.0, name: AnyStr="", objattrArray: Union[AnyStr, bool]="", opacity:
Union[float, bool]=1.0, outline: bool=True, outwhilepaint: bool=False,
paintNodeArray: Union[AnyStr, bool]="", paintattrselected: AnyStr="",
paintmode: Union[AnyStr, bool]="screen", paintoperationtype: Union[AnyStr,
bool]="Paint", pickColor: bool=True, pickValue: bool=True, playbackCursor:
Union[List[float, float], List[List[float, float]], bool]=None,
playbackPressure: Union[float, List[float], bool]=0.0, preserveclonesource:
bool=True, profileShapeFile: Union[AnyStr, bool]="", projective: bool=False,
property: Union[AnyStr, bool]="", radius: Union[float, bool]=1.0,
rampMaxColor: Union[List[float, float, float], bool]=None, rampMinColor:
Union[List[float, float, float], bool]=None, record: bool=True, reflection:
bool=False, reflectionaboutorigin: bool=True, reflectionaxis: Union[AnyStr,
bool]="x", rgbValue: Union[List[float, float, float], bool]=None,
screenRadius: Union[float, bool]=0.0, selectclonesource: bool=True,
selectedattroper: Union[AnyStr, bool]="absolute", showactive: bool=True,
stampDepth: Union[float, bool]=0.0, stampProfile: Union[AnyStr, bool]="",
stampSpacing: Union[float, bool]=1.0, strokesmooth: Union[AnyStr, bool]="",
surfaceConformedBrushVertices: bool=True, tablet: bool=True,
tangentOutline: bool=True, toolOffProc: Union[AnyStr, bool]="", toolOnProc:
Union[AnyStr, bool]="", useColorRamp: bool=True, useMaxMinColor: bool=True,
useStrokeDirection: bool=True, usepressure: bool=False, value: Union[float,
bool]=0.0, velocity: Union[List[float, float, float], bool]=None,
whichTool: Union[AnyStr, bool]="", worldRadius: Union[float, bool]=0.0,
q=True, query=True, e=True, edit=True, **kwargs)->Union[None, Any]:
"""
This is a context command to set the flags on the artAttrContext, which is the base context
for attribute painting operations All commands require the name of the context as the last
argument as this provides the name of the context to create, edit or query This command
is used to paint properties (such as density) of selected fluid volumes
:param accopacity: (C Q E) Sets opacity accumulation on/off C: Default is false (Except
for sculpt tool for which it is true by default) Q: When queried, it returns a boolean
:param activeListChangedProc: (C Q E) Accepts a string that contains a MEL command that is
invoked whenever the active list changes There may be some situations where the UI, for
example
:param afterStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
after the end of a stroke C: Default is no command Q: When queried, it returns the curre
:param alphaclamp: (C Q E) Specifies if the weight value should be alpha clamped to the
lower and upper bounds There are four options here: "none" - no clamping is performed,
:param alphaclamplower: (C Q E) Specifies the lower bound for the alpha values C: Default
is 0.0 Q: When queried, it returns a float
:param alphaclampupper: (C Q E) Specifies the upper bound for the alpha values C: Default
is 1.0 Q: When queried, it returns a float
:param attrSelected: (Q) Returns a name of the currently selected attribute Q: When
queried, it returns a string
:param autoSave: (C Q E) A MEL command to save the fluid state Called before an event
which could overwrite unsaved values of painted fluid properties Such events include:
:param beforeStrokeCmd: (C Q E) The passed string is executed as a MEL command immediately
before the start of a stroke C: Default is no command Q: When queried, it returns the cu
:param brushalignment: (C Q E) Specifies the path brush alignemnt If true, the brush will
align to stroke path, otherwise it will align to up vector C: Default is true Q: When q
:param brushfeedback: (C Q E) Specifies if the brush additional feedback should be drawn
C: Default is TRUE Q: When queried, it returns a boolean
:param clamp: (C Q E) Specifies if the weight value should be clamped to the lower and
upper bounds There are four options here: "none" - no clamping is performed, "lower
:param clamplower: (C Q E) Specifies the lower bound for the values C: Default is 0.0 Q:
When queried, it returns a float
:param clampupper: (C Q E) Specifies the upper bound for the values C: Default is 1.0 Q:
When queried, it returns a float
:param clear: (C E) Floods all cvs/vertices to the current value
:param colorAlphaValue: (C Q E) The Alpha value of the color
:param colorRGBAValue: (C Q E) The RGBA value of the color
:param colorRGBValue: (C Q E) The RGB value of the color
:param colorRamp: (C Q E) Allows a user defined color ramp to be used to map values to
colors
:param colorfeedback: (C Q E) Sets on/off the color feedback display C: Default is FALSE
Q: When queried, it returns a boolean
:param colorfeedbackOverride: (C Q E) Sets on/off the color feedback override C: Default
is FALSE Q: When queried, it returns a boolean
:param colorrangelower: (C Q E) Specifies the value that maps to black when color feedback
mode is on C: Default is 0.0 Q: When queried, it returns a float
:param colorrangeupper: (C Q E) Specifies the value that maps to the maximum color when
color feedback mode is on C: Default is 1.0 Q: When queried, it returns a float
:param currentPaintableFluid: (Q) Query the name of the fluid on which this context is
currently painting Returns string
:param dataTypeIndex: (Q E) When the selected paintable attribute is a vectorArray, it
specifies which field to paint on
:param delaySelectionChanged: (C Q E) Internal use only Under normal conditions, the tool
responds to changes to the selection list so it can update its list of paintable geometry
When
:param disablelighting: (C Q E) If color feedback is on, this flag determines whether
lighting is disabled or not for the surfaces that are affected C: Default is FALSE Q:
When qu
:param displayAsRender: (C Q E) When true, sets the "Shaded Display" attribute of the fluid
to "AsRender": all fluid properties displayed as hardware rendered When false, displays
:param displayVelocity: (C Q E) Turns on/off velocity display, independently of the above
"dar/displayAsRender" setting Use this flag to enable velocity display while only
displayi
:param doAutoSave: (E) Execute the -autoSave command if there are unsaved painted fluid
properties
:param dragSlider: (C E) Sets the current brush drag state for resizing or offsetting the
brush (like the 'b' and 'm' default hotkeys) The string argument is one of: "radius
:param duringStrokeCmd: (C Q E) The passed string is executed as a MEL command during the
stroke, each time the mouse is dragged C: Default is no command Q: When queried, it
retur
:param dynclonemode: (C Q E) Enable or disable dynamic clone mode
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param expandfilename: (C E) If true, it will expand the name of the export file and
concatenate it with the surface name Otherwise it will take the name as it is C: Default
is
:param exportaspectratio: (C Q E) Value of aspect ratio for export
:param exportfilemode: (C Q E) Specifies the export channel.The valid entries here are:
"alpha", "luminance", "rgb", "rgba" C: Default is "luminance/rgb" Q: When queried, it
retu
:param exportfilesave: (E) Exports the attribute map and saves to a specified file
:param exportfilesizex: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfilesizey: (C Q E) Specifies the width of the attribute map to export C:
Default width is 256 Q: When queried, it returns an integer
:param exportfiletype: (C Q E) Specifies the image file format It can be one of the
following: "iff", "tiff", "jpeg", "alias", "rgb", "fit" "postScriptEPS", "softimage",
"wavefron
:param filterNodes: (E) Sets the node filter
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param importfileload: (E) Load the attribute map a specified file
:param importfilemode: (C Q E) Specifies the channel to import The valid entries here are:
"alpha", "luminance", "red", "green", "blue", and "rgb" C: Default is "alpha" Q: When q
:param importreassign: (C Q E) Specifies if the multiply atrribute maps are to be
reassigned while importing Only maps previously exported from within Artisan can be
reassigned C
:param interactiveUpdate: (C Q E) Specifies how often to transfer the painted values into
the attribute TRUE: transfer them "continuously" (many times per stroke) FALSE: transfer
the
:param lastRecorderCmd: (C Q E) Value of last recorded command
:param lastStampName: (C Q E) Value of the last stamp name
:param lowerradius: (C Q E) Sets the lower size of the brush (only apply on tablet)
:param makeStroke: (C Q E M) Stroke point values
:param mappressure: (C Q E) Sets the tablet pressure mapping when the table is used There
are four options: "none" - the pressure has no effect, "opacity" - the pressure is map
:param maxvalue: (C Q E) Specifies the maximum value for each attribute C: Default is 1.0
Q: When queried, it returns a float
:param minvalue: (C Q E) Specifies the minimum value for each attribute C: Default is 0.0
Q: When queried, it returns a float
:param name: (C) If this is a tool command, name the tool appropriately
:param objattrArray: (Q) An array of all paintable attributes Each element of the array is
a string with the following information: NodeType.NodeName.AttributeName.MenuType
:param opacity: (C Q E) Sets the brush opacity C: Default is 1.0 Q: When queried, it
returns a float
:param outline: (C Q E) Specifies if the brush should be drawn C: Default is TRUE Q: When
queried, it returns a boolean
:param outwhilepaint: (C Q E) Specifies if the brush outline should be drawn while painting
C: Default is FALSE Q: When queried, it returns a boolean
:param paintNodeArray: (Q) An array of paintable nodes Q: When queried, it returns a
string
:param paintattrselected: (E) An array of selected paintable attributes Each element of
the array is a string with the following information: NodeType.NodeName.AttributeName
:param paintmode: (C Q E) Specifies the paint mode There are two possibilities: "screen"
and "tangent" C: Default is "screen" Q: When queried, it returns a string
:param paintoperationtype: (C Q E) Specifies the operation type used by the Paint Tool
Currently, we support the following paint modes: "Paint", "Smear", "Blur", "Erase" and
"Clone"
:param pickColor: (C Q E) Set pick color mode on or off
:param pickValue: (C Q E) Toggle for picking
:param playbackCursor: (C Q E M) Values for the playback cursor
:param playbackPressure: (C Q E M) Valus for the playback pressure
:param preserveclonesource: (C Q E) Whether or not to preserve a clone source
:param profileShapeFile: (Q E) Passes a name of the image file for the stamp shape profile
:param projective: (C Q E) Specifies the projective paint mode C: Default is 'false' Q:
When queried, it returns a boolean
:param property: (C Q E) Specifies a property to paint on the fluid Valid values are
"color", "density", "densityAndColor," "densityAndFuel," "temperature," "fuel", "velocit
:param radius: (C Q E) Sets the size of the brush C: Default is 1.0 cm Q: When queried,
it returns a float
:param rampMaxColor: (C Q E) Defines a special color to be used when the value is greater
than or equal to the maximum value
:param rampMinColor: (C Q E) Defines a special color to be used when the value is less than
or equal to the minimum value
:param record: (C Q E) Toggle on for recording
:param reflection: (C Q E) Specifies the reflection mode C: Default is 'false' Q: When
queried, it returns a boolean
:param reflectionaboutorigin: (C Q E) Toggle on to reflect about the origin
:param reflectionaxis: (C Q E) Specifies the reflection axis There are three
possibilities: "x", "y" and "z" C: Default is "x" Q: When queried, it returns a string
:param rgbValue: (C Q E) Specifies the values of the red, green, and blue components of the
color to use when painting the property "color."
:param screenRadius: (C Q E) Brush radius on the screen
:param selectclonesource: (C Q E) Toggle on to select the clone source
:param selectedattroper: (C Q E) Sets the edit weight operation Four edit weights
operations are provided : "absolute" - the value of the weight is replaced by the current
one, "add
:param showactive: (C Q E) Sets on/off the display of the surface isoparms C: Default is
TRUE Q: When queried, it returns a boolean
:param stampDepth: (C Q E) Depth of the stamps
:param stampProfile: (C Q E) Sets the brush profile of the current stamp Currently, the
following profiles are supported: "gaussian", "poly", "solid" and "square" C: Default is
:param stampSpacing: (C Q E) Specifies the stamp spacing Default is 1.0
:param strokesmooth: (C Q E) Stroke smoothing type name
:param surfaceConformedBrushVertices: (C Q E) Enables/disables the the display of the
effective brush area as affected vertices
:param tablet: (Q) Returns true if the tablet device is present, false if it is absent
:param tangentOutline: (C Q E) Enables/disables the display of the brush circle tangent to
the surface
:param toolOffProc: (C Q E) Accepts a strings describing the name of a MEL procedure that
is invoked whenever the tool is turned off For example, cloth invokes "clothPaintToolO
:param toolOnProc: (C Q E) Accepts a strings describing the name of a MEL procedure that is
invoked whenever the tool is turned on For example, cloth invokes "clothPaintToolOn
:param useColorRamp: (C Q E) Specifies whether the user defined color ramp should be used
to map values from to colors If this is turned off, the default greyscale feedback will
:param useMaxMinColor: (C Q E) Specifies whether the out of range colors should be used
See rampMinColor and rampMaxColor flags for further details
:param useStrokeDirection: (C Q E) Applicable only during "velocity" painting Specifies
whether the value of the painted velocity should come from the direction of the brush
stroke, o
:param usepressure: (C Q E) Sets the tablet pressure on/off C: Default is false Q: When
queried, it returns a boolean
:param value: (C Q E) Specifies the value for each attribute C: Default is 0.0 Q: When
queried, it returns a float
:param velocity: (C Q E) Specifies the values of the x, y, and z components of the velocity
to use when painting the property "velocity"
:param whichTool: (C Q E) The string defines the name of the tool to be used for the
Artisan context An example is "artClothPaint" In query mode, the tool name for the given
:param worldRadius: (C Q E) Radius in worldspace
:returns:
"""
pass
def AddOceanSurfaceLocator(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmSyncPatchVisibility(*args, **kwargs)->None:
"""
"""
pass
def CreaseProxyEdgeTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def hotkeyMapSet(*args, **kwargs)->None:
"""
"""
pass
def nClothDeleteCacheFramesOpt(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DetachEdgeComponent(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CoarsenSelectedComponents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TogglePanZoomRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GetSettingsFromSelectedStroke(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def setNodeTypeFlag(*args, display: bool=True, threadSafe: bool=True, q=True, query=True,
**kwargs)->Union[bool, Any]:
"""
This command sets static data on the specified node type This will affect the class of
node type as a whole The argument passed may be the name of the node type or the node type
tag Node type tags may be found using the objectType command
:param display: (C Q) Sets whether the node type will appear in the UI or not Setting
display to false will cause the node type to not appear in the UI Query mode to obt
:param threadSafe: (C Q) This flag is obsolete Has no effect
:returns: Did the command succeed?
"""
pass
def CreateAmbientLightOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TranslateToolWithSnapMarkingMenu(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SelectBorderEdgeTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeSetSmallNodeSwatchSize(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SurfaceBooleanIntersectToolOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXImportMergeAnimationLayers(*args, **kwargs)->None:
"""
"""
pass
def SelectAllHairSystem(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def cMuscleCache(*args, **kwargs)->None:
"""
"""
pass
def TesselateSubdivSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def arrayMapper(*args, destAttr: AnyStr="", inputU: AnyStr="", inputV: AnyStr="", mapTo:
AnyStr="", target: Union[AnyStr, List[AnyStr]]="", type: AnyStr="",
**kwargs)->List[AnyStr]:
"""
Create an arrayMapper node and connect it to a target object If the -type flag is used,
then this command also creates an external node used for computing the output values If
the input attribute does not already exist, it will be created The output attribute must
exists If a flag is omitted, the selection list will be used to supply the needed
:param destAttr: (C) Specifies the attribute which will be the downstream connection for
the output data from the mapper node The attribute type will be used to determin
:param inputU: (C) Specifies the upstream attribute to connect to the mapper's uCoordPP
attribute If the flag is omitted, no input connection is made
:param inputV: (C) Specifies the upstream attribute to connect to the mapper's vCoordPP
attribute If the flag is omitted, no input connection is made
:param mapTo: (C) Specifies an existing node to be used to compute the output values This
node must be of the appropriate type Currently, only ramp nodes may be used
:param target: (C M) Specifies the target object to be connected to
:param type: (C) Specifies the node type to create which will be used to compute the output
values Currently, only ramp is valid If the flag is omitted, no connecti
:returns: Names of created arrayMapper nodes.
"""
pass
def printStudio(*args, **kwargs)->None:
"""
"""
pass
def imagePlane(*args, camera: Union[AnyStr, bool]="", counter: bool=True, detach: bool=True,
dropFrame: bool=True, fileName: AnyStr="", frameDuration: Union[int, bool]=0,
height: Union[float, bool]=0.0, imageSize: Union[List[int, int], bool]=None,
lookThrough: Union[AnyStr, bool]="", maintainRatio: bool=True, name:
Union[AnyStr, bool]="", negTimesOK: bool=True, numFrames: Union[int, bool]=0,
quickTime: bool=True, showInAllViews: bool=True, timeCode: Union[int, bool]=0,
timeCodeTrack: bool=True, timeScale: Union[int, bool]=0, twentyFourHourMax:
bool=True, width: Union[float, bool]=0.0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[bool, Any]:
"""
The imagePlane command allows querying of various properties of an image plane and any
movie in use by the image plane It also supports creating and edit The object passed to
the command may either be an imagePlane node, or a camera, in which case the command uses
the image plane attached to the camera (if any) If no object is passed in, the cur
:param camera: (C Q E) When creating, it will try to attach the created image plane to the
specified camera If the given camera is invalid, creating will fail When queryi
:param counter: () Query the 'counter' flag of the movie's timecode format If this is true,
the timecode returned by the -timeCode flag will be a simple counter If fa
:param detach: (E) This flag can only be used in the edit mode, when this flag is used in
edit, it will detach current image plane from any camera it attaches to and ma
:param dropFrame: (Q) Query the 'drop frame' flag of the movie's timecode format
:param fileName: (C E) Set the image name for image plane to read
:param frameDuration: (Q) Query the frame duration of the movie's timecode format
:param height: (C Q E) Height of the image plane When creating, if this flag is not
specified, it will use 10.0 as default height
:param imageSize: (Q) Get size of the loaded image
:param lookThrough: (C Q E) The camera currently used for image plane to look through
:param maintainRatio: (C Q E) Let the image plane respect the picture aspect ratio When
creating, if this flag is not specified, it will use true as default value
:param name: (C Q) Set the image plane node name when creating or return the image plane
name when querying
:param negTimesOK: (Q) Query the 'neg times OK' flag of the movie's timecode format
:param numFrames: (Q) Query the whole number of frames per second of the movie's timecode
format
:param quickTime: (Q) Query whether the image plane is using a QuickTime movie
:param showInAllViews: (C Q E) The flag is used to show the current image plane in all
views or not
:param timeCode: (Q) Query the whole number of frames per second of the movie's timecode
format
:param timeCodeTrack: (Q) Query whether the movie on the image plane has a timecode track
:param timeScale: (Q) Query the timescale of the movie's timecode format
:param twentyFourHourMax: (Q) Query the '24 hour max' flag of the movie's timecode format
:param width: (C Q E) Width of the image plane When creating, if this flag is not
specified, it will use 10.0 as default width
:returns: Command result
"""
pass
def DeleteAllWires(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ScaleCurvature(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def MakeUVInstanceCurrent(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleOriginAxis(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FBXExportHardEdges(*args, **kwargs)->None:
"""
"""
pass
def alignCurve(*args, caching: bool=True, curvatureContinuity: bool=False, curvatureScale1:
Union[float, bool]=0.0, curvatureScale2: Union[float, bool]=0.0, joinParameter:
Union[float, bool]=123456.0, nodeState: Union[int, bool]=0,
positionalContinuity: bool=True, positionalContinuityType: Union[int, bool]=1,
reverse1: bool=False, reverse2: bool=False, tangentContinuity: bool=True,
tangentContinuityType: Union[int, bool]=1, tangentScale1: Union[float, bool]=1.0,
tangentScale2: Union[float, bool]=1.0, attach: bool=True, constructionHistory:
bool=True, keepMultipleKnots: bool=True, name: AnyStr="", object: bool=True,
replaceOriginal: bool=True, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The curve align command is used to align curves in maya The main alignment options are
positional, tangent and curvature continuity Curvature continuity implies tangent
continuity Positional continuity means the curves (move) or the ends of the curves
(modify) are changed Tangent continuity means one of the curves is modified to be tangent
at
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param curvatureContinuity: (C Q E) Curvature continuity is on if true and off otherwise
Default: false
:param curvatureScale1: (C Q E) Curvature scale applied to curvature of first curve for
curvature continuity Default: 0.0
:param curvatureScale2: (C Q E) Curvature scale applied to curvature of second curve for
curvature continuity Default: 0.0
:param joinParameter: (C Q E) Parameter on reference curve where modified curve is to be
aligned to Default: 123456.0
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param positionalContinuity: (C Q E) Positional continuity is on if true and off otherwise
Default: true
:param positionalContinuityType: (C Q E) Positional continuity type legal values: 1 - move
first curve, 2 - move second curve, 3 - move both curves, 4 - modify first curve, 5 -
modify second
:param reverse1: (C Q E) If true, reverse the first input curve before doing align
Otherwise, do nothing to the first input curve before aligning NOTE: setting this attribu
:param reverse2: (C Q E) If true, reverse the second input curve before doing align
Otherwise, do nothing to the second input curve before aligning NOTE: setting this attri
:param tangentContinuity: (C Q E) Tangent continuity is on if true and off otherwise
Default: true
:param tangentContinuityType: (C Q E) Tangent continuity type legal values: 1 - do tangent
continuity on first curve, 2 - do tangent continuity on second curve Default: 1
:param tangentScale1: (C Q E) Tangent scale applied to tangent of first curve for tangent
continuity Default: 1.0
:param tangentScale2: (C Q E) Tangent scale applied to tangent of second curve for tangent
continuity Default: 1.0
:param attach: (C) True if the curve is to be attached
:param constructionHistory: (C) Turn the construction history on or off
:param keepMultipleKnots: (C) True if multiple knots should be left as-is
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param object: (C) Create the result, or just the dependency node
:param replaceOriginal: (C) Create "in place" (i.e., replace)
:returns: Object name and node name
"""
pass
def editRenderLayerGlobals(*args, baseId: Union[int, bool]=0, currentRenderLayer: Union[name,
bool]=None, enableAutoAdjustments: bool=True, mergeType: Union[int,
bool]=0, useCurrent: bool=True, q=True, query=True,
**kwargs)->Union[bool, Any]:
"""
Edit the parameter values common to all render layers Some of these paremeters, eg baseId
and mergeType, are stored as preferences and some, eg currentRenderLayer, are stored in
the file
:param baseId: (C Q) Set base layer ID This is the number at which new layers start
searching for a unique ID
:param currentRenderLayer: (C Q) Set current render layer This will will update the
renderLayerManger and all DAG objects to identify them as members of the render layer This
flag
:param enableAutoAdjustments: (C Q) Set whether or not to enable automatic creation of
adjustments when certain attributes (ie surface render stats, shading group assignment, or
render
:param mergeType: (C Q) Set file import merge type Valid values are 0, none, 1, by number,
and 2, by name
:param useCurrent: (C Q) Set whether or not to enable usage of the current render layer as
the destination for all new nodes
:returns: Command success
"""
pass
def xgmClumpMap(*args, **kwargs)->None:
"""
"""
pass
def GraphEditorFrameSelected(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PaintVertexColorTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def AlembicImport(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PickColorActivate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Twist(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def artAttr(*args, **kwargs)->None:
"""
"""
pass
def CreatePartitionOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeOpenGraphEditorWindow(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def OffsetCurveOnSurface(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetPassiveKey(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def NodeEditorToggleSyncedSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ShowFollicles(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllLights(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetFullBodyIKKeysOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def FilletBlendTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorRippleEditToggleRelease(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSplineCacheDelete(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateUVsBasedOnCameraOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeCollapseAsset(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def XgmSplineGeometryConvert(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_extrudeBevelPress(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def Snap3PointsTo3PointsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def InsertKeyToolDeactivate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def TimeEditorExportSelection(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def manipOptions(*args, enableSmartDuplicate: bool=True, enableSmartExtrude: bool=True,
forceRefresh: bool=True, handleSize: Union[float, bool]=0.0, hideManipOnCtrl:
bool=True, hideManipOnShift: bool=True, hideManipOnShiftCtrl: bool=True,
linePick: Union[float, bool]=0.0, lineSize: Union[float, bool]=0.0,
middleMouseRepositioning: bool=True, pivotRotateHandleOffset: Union[int,
bool]=0, planeHandleOffset: Union[int, bool]=0, pointSize: Union[float,
bool]=0.0, preselectHighlight: bool=True, refreshMode: Union[int, bool]=0,
relative: bool=True, rememberActiveHandle: bool=True,
rememberActiveHandleAfterToolSwitch: bool=True, scale: Union[float, bool]=0.0,
showExtrudeSliders: bool=True, showPivotRotateHandle: bool=True,
showPlaneHandles: bool=True, smartDuplicateType: Union[int, bool]=0, q=True,
query=True, **kwargs)->Union[None, Any]:
"""
Changes the global manipulator parameters
:param enableSmartDuplicate: (C Q) Enables Shift-Duplicate option on t/r/s manips
:param enableSmartExtrude: (C Q) Enables Shift-Extrude option on t/r/s manips
:param forceRefresh: (C) Force a refresh if there is any deferred evaluation
:param handleSize: (C Q) Sets the maximum handles size in pixels, for small handles
:param hideManipOnCtrl: (C Q) Hide transform manip when the Ctrl key is pressed
:param hideManipOnShift: (C Q) Hide transform manip when the Shift key is pressed
:param hideManipOnShiftCtrl: (C Q) Hide transform manip when the Shift and Ctrl keys are
both pressed
:param linePick: (C Q) Set the width of picking zone for long handles
:param lineSize: (C Q) Set the width of long handles (drawn as lines)
:param middleMouseRepositioning: (C Q) Specify if the middle mouse should reposition
:param pivotRotateHandleOffset: (C Q) Set the offset of the pivot rotation handle
:param planeHandleOffset: (C Q) Set the offset of the planar drag handles
:param pointSize: (C Q) Set the size of points (used to display previous states)
:param preselectHighlight: (C Q) Set whether manip handles should be highlighted when
moving mouse
:param refreshMode: (C Q) Set the global refresh mode
:param relative: (C) All values are interpreted as multiplication factors instead of final
values
:param rememberActiveHandle: (C Q) Set whether manip handles should be remembered after
selection change
:param rememberActiveHandleAfterToolSwitch: (C Q) Set whether manip handles should be
remembered after manipulator change
:param scale: (C Q) Global scaling factor of all manipulators
:param showExtrudeSliders: (C Q) Specify if the extrude sliders are to be shown on the
manip
:param showPivotRotateHandle: (C Q) Toggles the visibility of the pivot rotation handle
:param showPlaneHandles: (C Q) Toggles the visibility of the planar drag handles
:param smartDuplicateType: (C Q) Change Shift-Duplicate or Shift-Extrude between Copy and
Instance on t/r/s manips
:returns:
"""
pass
def polyPrism(*args, axis: Union[List[float, float, float], bool]=None, caching: bool=True,
constructionHistory: bool=True, createUVs: int=2, length: Union[float, bool]=2.0,
name: AnyStr="", nodeState: Union[int, bool]=0, numberOfSides: Union[int, bool]=3,
numderOfSides: Union[int, bool]=3, object: bool=True, sideLength: Union[float,
bool]=2.0, subdivisionsCaps: Union[int, bool]=2, subdivisionsHeight: Union[int,
bool]=1, texture: int=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[List[AnyStr], Any]:
"""
The prism command creates a new polygonal prism
:param axis: (C Q E) This flag specifies the primitive axis used to build the prism Q:
When queried, this flag returns a float[3]
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param createUVs: (C) This flag alows a specific UV mechanism to be selected, while
creating the primitive The valid values are 0, 1, 2 or 3 0 implies that no UVs will b
:param length: (C Q E) This flag specifies the length of the prism C: Default is 2.0 Q:
When queried, this flag returns a float
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param numberOfSides: (C Q E) This specifies the number of sides for the prism C: Default
is 3 Q: When queried, this flag returns an int
:param numderOfSides: (C Q E) This specifies the number of sides for the prism C: Default
is 3 Q: When queried, this flag returns an int
:param object: (C) Create the result, or just the dependency node (where applicable)
:param sideLength: (C Q E) This flag specifies the edge length of the prism C: Default is
2.0 Q: When queried, this flag returns a float
:param subdivisionsCaps: (C Q E) This flag specifies the subdivisions on the caps for the
prism C: Default is 2 Q: When queried, this flag returns an int
:param subdivisionsHeight: (C Q E) This specifies the subdivisions along the height for the
prism C: Default is 1 Q: When queried, this flag returns an int
:param texture: (C) This flag is obsolete and will be removed in the next release The
-cuv/createUVs flag should be used instead
:returns: Object name and node name.
"""
pass
def AddKeyToolActivate(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def RaiseApplicationWindows(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DisplayViewport(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def floatSlider2(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand1: AnyStr="", changeCommand2:
AnyStr="", defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor:
Union[List[float, float, float], bool]=None, isObscured: bool=True, manage:
bool=True, maximum: Union[float, bool]=0.0, minimum: Union[float, bool]=0.0,
noBackground: bool=True, numberOfPopupMenus: bool=True, parent: Union[AnyStr,
bool]="", polarity: Union[int, bool]=0, popupMenuArray: bool=True,
positionControl1: AnyStr="", positionControl2: AnyStr="", preventOverride:
bool=True, statusBarMessage: AnyStr="", useTemplate: AnyStr="", value1:
Union[float, bool]=0.0, value2: Union[float, bool]=0.0, values: List[float,
float]=None, visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a float slider containing two handles The two handles are arranged
such that they cannot pass one another, thus handle 1 will always have a value less than or
or equal to handle 2 when you adjust the values Each handle may have a MEL command
associated with it which is issued when the handle moves and thus can be used to upda
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand1: (C E) Command to be associated with handle 1 and issued whenever the
value of the handle is changed (except when values are changed via the -hv/handleValue
:param changeCommand2: (C E) Command to be associated with handle 2 and issued whenever the
value of the handle is changed (except when values are changed via the -hv/handleValue
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param maximum: (C Q E) Maximum limit of the slider The default value is 10.0 The maximum
value occurs at the top(right) end of the slider unless -polarity was specified
:param minimum: (C Q E) Minimum limit of the slider The default value is 0.0 The minimum
value occurs at the bottom end of the slider unless -polarity was specified Note:
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param polarity: (C Q E) Specifies the polarity of the slider If 0 (the default), the
minimum value (specified by the -minimum flag) occurs at the bottom end of the slider a
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param positionControl1: (C E) Set the name of the control (if any) which is associated
with handle 1 of this slider The control must be a "floatField" The control always
display
:param positionControl2: (C E) Set the name of the control (if any) which is associated
with handle 2 of this slider The control must be a "floatField" The control always
display
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value1: (C Q E) Value of handle 1 To ensure that handle 1 stays at or below handle
2, an error will occur if the value specified is too large If you wish to set bo
:param value2: (C Q E) Value of handle 2 To ensure that handle 2 stays at or above handle
2, an error will occur if the value specified is too large If you wish to set bo
:param values: (C E) Sets the value for handles 1 and 2 simulteneously The first argument
is applied to handle 1 and must be less than or equal to the second (handle 2)
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the port created or modified
"""
pass
def GpuCacheExportAllOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SetMeshSprayTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def paneLayout(*args, activeFrameThickness: Union[int, bool]=0, activePane: Union[AnyStr,
bool]="", activePaneIndex: Union[int, bool]=0, annotation: Union[AnyStr,
bool]="", backgroundColor: Union[List[float, float, float], bool]=None,
childArray: bool=True, configuration: Union[AnyStr, bool]="", defineTemplate:
AnyStr="", docTag: Union[AnyStr, bool]="", dragCallback: Script=None,
dropCallback: Script=None, enable: bool=True, enableBackground: bool=True,
enableKeyboardFocus: bool=True, exists: bool=True, fullPathName: bool=True,
height: Union[int, bool]=0, highlightColor: Union[List[float, float, float],
bool]=None, isObscured: bool=True, manage: bool=True, noBackground: bool=True,
numberOfChildren: bool=True, numberOfPopupMenus: bool=True,
numberOfVisiblePanes: bool=True, pane1: bool=True, pane2: bool=True, pane3:
bool=True, pane4: bool=True, paneSize: Union[List[int, int, int], List[List[int,
int, int]], bool]=None, paneUnderPointer: bool=True, parent: Union[AnyStr,
bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
separatorMovedCommand: Script=None, separatorThickness: Union[int, bool]=0,
setPane: Union[List[AnyStr, int], List[List[AnyStr, int]]]=None,
staticHeightPane: int=0, staticWidthPane: int=0, statusBarMessage: AnyStr="",
useTemplate: AnyStr="", visible: bool=True, visibleChangeCommand: Union[Script,
bool]=None, width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a pane layout A pane layout may have any number of children but at
any one time only certain children may be visible, as determined by the current layout
configuration For example a horizontally split pane shows only two children, one on top of
the other and a visible separator between the two The separator may be moved to v
:param activeFrameThickness: (C Q E) The thickness of the frame drawn around the active
frame Specify an integer value greater than or equal to 0
:param activePane: (C Q E) The active pane has a colored border surrounding it Only one
pane may be active at any one time Using either of the flags -ap/activePane or -api/ac
:param activePaneIndex: (C Q E) The active pane index The active pane has a colored border
surrounding it Only one pane may be active at any one time Using either of the flags -a
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param childArray: (Q) Returns a string array of the names of the layout's immediate
children
:param configuration: (C Q E) Set the layout configuration for the panes Valid values are:
"single", "horizontal2", "vertical2", "horizontal3", "vertical3", "top3", "left3", "bot
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfChildren: (Q) Returns in an int the number of immediate children of the
layout
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param numberOfVisiblePanes: (Q) Return the number of panes visible for the present
configuration
:param pane1: (Q)
:param pane2: (Q)
:param pane3: (Q)
:param pane4: (Q) Return the name of the control in the respective pane
:param paneSize: (C Q E M) The size of a pane in the current pane layout configuration The
first argument specifies the pane index and is an integer value ranging from 1 to 4
:param paneUnderPointer: (Q) Return the name of the child occupying the pane that the
pointer is currently over An empty string is returned if the pointer is not over a pane
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param separatorMovedCommand: (C E) This command executed when the pane separators are
moved
:param separatorThickness: (C Q E) The thickness of the separators between the panes
Specify an integer value greater than 0 This flag has no effect on Windows systems
:param setPane: (C E M) This flag allows you to put a child of this layout in a particular
pane The first argument is the full or short name of the control The second argu
:param staticHeightPane: (C E) Set a pane to have a static height, i.e its height will not
change when the layout is dynamically resized Only one pane can be set to have a static
:param staticWidthPane: (C E) Set a pane to have a static width, i.e its width will not
change when the layout is dynamically resized Only one pane can be set to have a static w
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def SmoothCurve(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def getLastError(*args, **kwargs)->None:
"""
"""
pass
def polyTransfer(*args, alternateObject: Union[AnyStr, bool]="", caching: bool=True,
constructionHistory: bool=True, name: AnyStr="", nodeState: Union[int, bool]=0,
uvSets: bool=True, vertexColor: bool=True, vertices: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Transfer information from one polygonal object to another one Both objects must have
identical topology, that is same vertex, edge, and face numbering The flags specify which
of the vertices, UV sets or vertex colors will be copied
:param alternateObject: (C Q E) Name of the alternate object
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param constructionHistory: (C Q) Turn the construction history on or off (where
applicable) If construction history is on then the corresponding node will be inserted
into the histo
:param name: (C) Give a name to the resulting node
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param uvSets: (C Q E) When true, the UV sets are copied from the alternate object C:
Default is "on"
:param vertexColor: (C Q E) When true, the colors per vertex are copied from the alternate
object C: Default is "off"
:param vertices: (C Q E) When true, the vertices positions are copied from the alternate
object C: Default is "off"
:returns: representing the node name.
"""
pass
def percent(*args, addPercent: bool=True, dropoffAxis: List[float, float, float]=None,
dropoffCurve: AnyStr="", dropoffDistance: float=0.0, dropoffPosition: List[float,
float, float]=None, dropoffType: AnyStr="", multiplyPercent: bool=True, value:
Union[float, bool]=1, q=True, query=True, **kwargs)->Union[None, Any]:
"""
This command sets percent values on members of a weighted node such as a cluster or a
jointCluster With no flags specified the command sets the percent value for selected
components of the specified node to the specified percent value A dropoff from the
specified percent value to 0 can be specified from a point, plane or curve using a dropoff
dis
:param addPercent: (C) Add the percent value specified with the -v flag to the existing
percent values
:param dropoffAxis: (C) Specifies the axis along which to dropoff the percent value,
starting from the dropoffPosition
:param dropoffCurve: (C) Specifies the curve around which to dropoff the percent value
:param dropoffDistance: (C) Specifies the dropoff distance from the point, plane or curve
that was specified using the -dp -dax or -dc flags
:param dropoffPosition: (C) Specifies the point around which to dropoff the percent value
:param dropoffType: (C) Specifies the type of dropoff Used in conjunction with the -dp,
-dax or -dc flags Default is linear Valid values are: linear, sine, exponential, l
:param multiplyPercent: (C) Multiply the percent value specified with the -v flag with
existing percent values
:param value: (C Q) The percent value to be applied The default is 1 In query mode,
returns an array of doubles corresponding to the weights of the selected object com
:returns:
"""
pass
def MoveTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def xgmPartBrushContext(*args, **kwargs)->None:
"""
"""
pass
def selectMode(*args, component: bool=True, hierarchical: bool=True, leaf: bool=True, object:
bool=True, preset: bool=True, root: bool=True, template: bool=True, q=True,
query=True, **kwargs)->Union[bool, Any]:
"""
The selectMode command is used to change the selection mode Object, component, root, leaf
and template modes are mutually exclusive
:param component: (C Q) Set component selection on Component selection mode allows
filtered selection based on the component selection mask The component selection mask is
:param hierarchical: (C Q) Set hierarchical selection on There are three types of
hierarchical selection: root, leaf and template Hierarchical mode is set if root, leaf or
te
:param leaf: (C Q) Set leaf selection mode on This mode allows the leaf level objects to
be selected It is similar to object selection mode but ignores the object sel
:param object: (C Q) Set object selection on Object selection mode allows filtered
selection based on the object selection mask The object selection mask is the set of
:param preset: (C Q) Allow selection of anything with the mask set, independent of it being
an object or a component
:param root: (C Q) Set root selection mode on This mode allows the root of a hierarchy to
be selected by selecting any of its descendents It ignores the object select
:param template: (C Q) Set template selection mode on This mode allows selection of
templated objects It selects the templated object closest to the root of the hierarchy
:returns: if a query operation
"""
pass
def contextInfo(*args, c: bool=True, escapeContext: bool=True, exists: bool=True, image1:
bool=True, image2: bool=True, image3: bool=True, title: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command allows you to get information on named contexts
:param c: (C) Return the class type of the named context
:param escapeContext: (C) Return the command string that will allow you to exit the current
tool
:param exists: (C) Return true if the context exists, false if it does not exists (or is
internal and therefore untouchable)
:param image1: (C) Returns the name of an xpm associated with the named context
:param image2: (C) Returns the name of an xpm associated with the named context
:param image3: (C) Returns the name of an xpm associated with the named context
:param title: (C) Return the title string of the named context
:returns: Info requested
"""
pass
def CutCurveOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def HypershadeRefreshSelectedSwatches(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateVolumeSphere(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def DeleteAllFurs(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ToggleEvaluationManagerVisibility(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def bifMeshImport(*args, **kwargs)->None:
"""
"""
pass
def ConnectComponentsOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CircularFillet(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def optionVar(*args, arraySize: AnyStr="", clearArray: Union[AnyStr, List[AnyStr]]="", exists:
AnyStr="", floatValue: Union[List[AnyStr, float], List[List[AnyStr, float]]]=None,
floatValueAppend: Union[List[AnyStr, float], List[List[AnyStr, float]]]=None,
intValue: Union[List[AnyStr, int], List[List[AnyStr, int]]]=None, intValueAppend:
Union[List[AnyStr, int], List[List[AnyStr, int]]]=None, list: bool=True, remove:
Union[AnyStr, List[AnyStr]]="", removeFromArray: Union[List[AnyStr, int],
List[List[AnyStr, int]]]=None, stringValue: Union[List[AnyStr, AnyStr],
List[List[AnyStr, AnyStr]]]=None, stringValueAppend: Union[List[AnyStr, AnyStr],
List[List[AnyStr, AnyStr]]]=None, version: int=0, q=True, query=True,
**kwargs)->Union[int, Any]:
"""
This command allows you to set and query variables which are persistent between different
invocations of Maya These variables are stored as part of the preferences
:param arraySize: (C) returns the size of the array named "string" If no such variable
exists, it returns 0 If the variable is not an array, it returns 1
:param clearArray: (C M) If there is an array named "string", it is set to be empty Empty
arrays are not saved
:param exists: (C) returns 1 if a variable named "string" exists, 0 otherwise All other
flags will be ignored if this is used (Query has higher precedence)
:param floatValue: (C M) creates a new variable named "string" with double value "float"
If a variable already exists with this name, it is overridden in favour of the new v
:param floatValueAppend: (C M) adds this value to the end of the array of floats named
"string" If no such array exists, one is created If there was a float value with this
name
:param intValue: (C M) creates a new variable named "string" with integer value "int" If a
variable already exists with this name, it is overridden in favour of the new va
:param intValueAppend: (C M) adds this value to the end of the array of ints named "string"
If no such array exists, one is created If there was an int value with this name bef
:param list: (C) this returns a list of all the defined variable names All other flags
will be ignored if this one is used (Query and exists flags have a higher pre
:param remove: (C M) removes the variable named "string", if one exists Note: all removals
are done before any value setting, if both the -r and other (-sv, -iv, -fv) fl
:param removeFromArray: (C M) removes the element numbered "int" in the array named
"string" Everything beyond it then gets shuffled down
:param stringValue: (C M) creates a new variable named using the first string with value
given by the second string If a variable already exists with this name, it is overrid
:param stringValueAppend: (C M) adds the value given by the second string to the end of the
array of strings named by the first string If no such array exists, one is created If t
:param version: (C) Preferences version number to warn about incompatbile preference files
:returns: 0 or 1 for the exists option
"""
pass
def ambientLight(*args, ambientShade: Union[float, bool]=0.0, discRadius: Union[float,
bool]=0.0, exclusive: bool=True, intensity: Union[float, bool]=0.0, name:
Union[AnyStr, bool]="", position: Union[List[float, float, float], bool]=None,
rgb: Union[List[float, float, float], bool]=None, rotation: Union[List[float,
float, float], bool]=None, shadowColor: Union[List[float, float, float],
bool]=None, shadowDither: Union[float, bool]=0.0, shadowSamples: Union[int,
bool]=0, softShadow: bool=True, useRayTraceShadows: bool=True, q=True,
query=True, e=True, edit=True, **kwargs)->Union[List[double], Any]:
"""
TlightCmd is the base class for other light commands The ambientLight command is used to
edit the parameters of existing ambientLights, or to create new ones The default behaviour
is to create a new ambientlight This is the commmand that instantiates an ambientLight or
edits the parameters of an existing one TambientLightCmd inherits from Tlig
:param ambientShade: (C Q E) ambientShade
:param discRadius: (C Q E) radius of the disc around the light
:param exclusive: (C Q) True if the light is exclusively assigned
:param intensity: (C Q) Intensity of the light
:param name: (C Q) Name of the light
:param position: (C Q) Position of the light
:param rgb: (C Q) RGB colour of the light
:param rotation: (C Q) Rotation of the light for orientation, where applicable
:param shadowColor: (C Q) Color of the light's shadow
:param shadowDither: (C Q E) dither the shadow
:param shadowSamples: (C Q E) number of shadow samples
:param softShadow: (C Q E) soft shadow
:param useRayTraceShadows: (C Q) True if ray trace shadows are to be used
:returns: when querying the rgb or shadowColor flags
double when querying the intensity
flag
boolean when querying the useRayTraceShadows or exclusive flags
linear[] when querying
the position flag
angle[] when querying the rotation flag
string when querying the name
flag
"""
pass
def OutlinerDoHide(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def bakeDeformer(*args, colorizeSkeleton: bool=True, customRangeOfMotion: timerange=None,
dstMeshName: AnyStr="", dstSkeletonName: AnyStr="", hierarchy: bool=True,
influences: List[AnyStr]=None, maxInfluences: int=0, pruneWeights: float=0.0,
smoothWeights: int=0, srcMeshName: AnyStr="", srcSkeletonName: AnyStr="",
**kwargs)->AnyStr:
"""
Given a rigged character, whose mesh shape is determined by a set of deformers,
bakeDeformer calculates linear blend skin weights most closely approximating observed
deformations To do this, a test set of examples is generated by moving the rig through a
range of motion Results mesh and pose pairs are then used to solve a constrained
optimization
:param colorizeSkeleton: (C) The new skin cluster created will have its skeleton colorized
Must be used with the -srcSkeletonName and -dstSkeletonName flags
:param customRangeOfMotion: (C) When this flag is specified with the frames for the range
of motion to be used, the tool will step through each frame as a separate pose Otherwise
t
:param dstMeshName: (C) The destination mesh name
:param dstSkeletonName: (C) The destination skeleton name
:param hierarchy: (C) All children of the passed joints that are used in the influences
flag are used
:param influences: (C) A list of joints that are used as the influences to determine new
weights
:param maxInfluences: (C) The maximum number of influences per vertex
:param pruneWeights: (C) On the newly created skin cluster, set any weight below the given
the value to zero (post-processing) This will call the skinPercent command as foll
:param smoothWeights: (C) The number of smoothing iterations for smoothing weights
(post-processing) This also renormalizes the remaining the weights
:param srcMeshName: (C) The source mesh name
:param srcSkeletonName: (C) The source skeleton name
:returns: BakeDeformer name
"""
pass
def texSelectContext(*args, exists: bool=True, image1: Union[AnyStr, bool]="", image2:
Union[AnyStr, bool]="", image3: Union[AnyStr, bool]="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
Command used to register the texSelectCtx tool
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:returns: : name of the context created
"""
pass
def subdDuplicateAndConnect(*args, **kwargs)->None:
"""
This command duplicates the input subdivision surface object, connects up the outSubdiv
attribute of the original subd shape to the create attribute of the newly created duplicate
shape and copies over the shader assignments from the original shape to the new duplicated
shape The command will fail if no objects are selected or sent as argument or
:returns:
"""
pass
def PolyExtrude(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def listHistory(*args, allConnections: bool=True, allFuture: bool=True, allGraphs: bool=True,
breadthFirst: bool=True, future: bool=True, futureLocalAttr: bool=True,
futureWorldAttr: bool=True, groupLevels: bool=True, historyAttr: bool=True,
interestLevel: int=0, leaf: bool=True, levels: int=0, pruneDagObjects:
bool=True, q=True, query=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command traverses backwards or forwards in the graph from the specified node and
returns all of the nodes whose construction history it passes through The construction
history consists of connections to specific attributes of a node defined as the creators
and results of the node's main data, eg the curve for a Nurbs Curve node For informa
:param allConnections: (C) If specified, the traversal that searches for the history or
future will not restrict its traversal across nodes to only dependent plugs Thus it wil
:param allFuture: (C) If listing the future, list all of it Otherwise if a shape has an
attribute that represents its output geometry data, and that plug is connected, on
:param allGraphs: (C) This flag is obsolete and has no effect
:param breadthFirst: (C) The breadth first traversal will return the closest nodes in the
traversal first The depth first traversal will follow a complete path away from the
:param future: (C) List the future instead of the history
:param futureLocalAttr: (Q) This flag allows querying of the local-space future-related
attribute(s) on shape nodes
:param futureWorldAttr: (Q) This flag allows querying of the world-space future-related
attribute(s) on shape nodes
:param groupLevels: (C) The node names are grouped depending on the level > 1 is the lead,
the rest are grouped with it
:param historyAttr: (Q) This flag allows querying of the attribute where history connects
on shape nodes
:param interestLevel: (C) If this flag is set, only nodes whose historicallyInteresting
attribute value is not less than the value will be listed The historicallyInteresting
:param leaf: (C) If transform is selected, show history for its leaf shape Default is
true
:param levels: (C) Levels deep to traverse Setting the number of levels to 0 means do all
levels All levels is the default
:param pruneDagObjects: (C) If this flag is set, prune at dag objects
:returns: List of history nodes
"""
pass
def CreateCameraAimOptions(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PostInfinityConstant(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def GraphEditorFramePlaybackRange(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def ikSpringSolverRestPose(*args, **kwargs)->None:
"""
"""
pass
def XgmSetWidthBrushTool(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def SewUVs3D(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def workspaceLayoutManager(*args, collapseMainWindowControls: List[AnyStr, bool]=None, current:
bool=True, delete: AnyStr="", i: AnyStr="", listLayouts: bool=True,
listModuleLayouts: bool=True, listUserLayouts: bool=True, modified:
AnyStr="", parentWorkspaceControl: AnyStr="", reset: bool=True,
restoreMainWindowControls: bool=True, save: bool=True, saveAs:
AnyStr="", setCurrent: AnyStr="", setCurrentCallback: AnyStr="",
setModifiedCallback: AnyStr="", type: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
The Workspace Layout Manager loads and saves the layout of the various toolbars and windows
in the user interface This command allows listing and managing their properties
:param collapseMainWindowControls: (C) Saves main window layout and collapses all other
controls in main window except the given one (first parameter) if it does not have any size
constrai
:param current: (C Q) Get the name of the current layout
:param delete: (C) Delete the given workspace The string is the name of the layout, not
the file name
:param i: (C) Import the given workspace file to the workspaces directory The string is an
absolute path
:param listLayouts: (C) List the names of all registered layouts
:param listModuleLayouts: (C) List the names of module layouts
:param listUserLayouts: (C) List the names of user layouts
:param modified: (C) Check whether or not the specified layout has been modified
:param parentWorkspaceControl: (C) Returns the parent workspace control of the given UI
(panel) or an empty string if it does not exist
:param reset: (C) Reset the current workspace to its original layout Factory layouts will
be reverted to default while user layouts will be reloaded from disk
:param restoreMainWindowControls: (C) Restores the main window layout to the one saved with
the -cmw/-collapseMainWindowControls flag The loaded workspace file will be deleted once
it is
:param save: (C) Save the current layout
:param saveAs: (C) Save the current layout under the specified name
:param setCurrent: (C) Load the given workspace The string is the name of the layout, not
the file name
:param setCurrentCallback: (C) MEL only The string is interpreted as a MEL callback, which
is called each time a layout is set as current (with -setCurrent flag) The callback is
:param setModifiedCallback: (C) MEL only The string is interpreted as a MEL callback,
which is called each time a layout is modified or restored, that is, each time the
-modified f
:param type: (C) Get the type of the specified layout: FACTORY, FACTORY_OVERRIDE, MODULE,
MODULE_OVERRIDE or USER
:returns: depending on arguments
"""
pass
def PolygonApplyColor(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dopeSheetEditor(*args, autoFit: Union[AnyStr, bool]="", autoFitTime: Union[AnyStr, bool]="",
control: bool=True, defineTemplate: AnyStr="", displayActiveKeyTangents:
AnyStr="", displayActiveKeys: AnyStr="", displayInfinities: AnyStr="",
displayKeys: AnyStr="", displayTangents: AnyStr="", displayValues:
AnyStr="", docTag: Union[AnyStr, bool]="", exists: bool=True, filter:
Union[AnyStr, bool]="", forceMainConnection: Union[AnyStr, bool]="",
hierarchyBelow: bool=True, highlightConnection: Union[AnyStr, bool]="",
lockMainConnection: bool=True, lookAt: AnyStr="", mainListConnection:
Union[AnyStr, bool]="", outliner: Union[AnyStr, bool]="", panel:
Union[AnyStr, bool]="", parent: Union[AnyStr, bool]="",
selectionConnection: Union[AnyStr, bool]="", selectionWindow:
Union[List[float, float, float, float], bool]=None, showScene: bool=True,
showSummary: bool=True, showTicks: bool=True, snapTime: Union[AnyStr,
bool]="", snapValue: Union[AnyStr, bool]="", stateString: bool=True,
unParent: bool=True, unlockMainConnection: bool=True, updateMainConnection:
bool=True, useTemplate: AnyStr="", q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
Edit a characteristic of a dope sheet editor
:param autoFit: (Q E) on | off | tgl Auto fit-to-view
:param autoFitTime: (Q E) on | off | tgl Auto fit-to-view along the time axis, as well
:param control: (Q) Query only Returns the top level control for this editor Usually used
for getting a parent to attach popup menus Caution: It is possible for an ed
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param displayActiveKeyTangents: (E) on | off | tgl Display active key tangents in the
editor
:param displayActiveKeys: (E) on | off | tgl Display active keys in the editor
:param displayInfinities: (E) on | off | tgl Display infinities in the editor
:param displayKeys: (E) on | off | tgl Display keyframes in the editor
:param displayTangents: (E) on | off | tgl Display tangents in the editor
:param displayValues: (E) on | off | tgl Display active keys and tangents values in the
editor
:param docTag: (C Q E) Attaches a tag to the editor
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param filter: (C Q E) Specifies the name of an itemFilter object to be used with this
editor This filters the information coming onto the main list of the editor
:param forceMainConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param hierarchyBelow: (Q E) display animation for objects hierarchically
:param highlightConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its highlight list Not all editors have a highlight list
F
:param lockMainConnection: (C E) Locks the current list of objects within the
mainConnection, so that only those objects are displayed within the editor Further changes
to the origi
:param lookAt: (E) all | selected | currentTime FitView helpers
:param mainListConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will use as its source of content The editor will only display items contained
in
:param outliner: (Q E) the name of the outliner which is associated with the dope sheet
:param panel: (C Q) Specifies the panel for this editor By default if an editor is created
in the create callback of a scripted panel it will belong to that panel If a
:param parent: (C Q E) Specifies the parent layout for this editor This flag will only
have an effect if the editor is currently un-parented
:param selectionConnection: (C Q E) Specifies the name of a selectionConnection object that
the editor will synchronize with its own selection list As the user selects things in this
e
:param selectionWindow: (Q E) The selection area specified as left, right, bottom, top
respectively
:param showScene: (Q E) display the scene summary object
:param showSummary: (Q E) display the summary object
:param showTicks: (Q E) display per animation tick divider in channel
:param snapTime: (Q E) none | integer | keyframe Keyframe move snap in time
:param snapValue: (Q E) none | integer | keyframe Keyframe move snap in values
:param stateString: (Q) Query only flag Returns the MEL command that will create an editor
to match the current editor state The returned command string uses the string va
:param unParent: (C E) Specifies that the editor should be removed from its layout This
cannot be used in query mode
:param unlockMainConnection: (C E) Unlocks the mainConnection, effectively restoring the
original mainConnection (if it is still available), and dynamic updates
:param updateMainConnection: (C E) Causes a locked mainConnection to be updated from the
orginal mainConnection, but preserves the lock state
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:returns: Editor name
"""
pass
def AutobindContainer(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def keyframeRegionSelectKeyCtx(*args, exists: bool=True, history: bool=True, image1:
Union[AnyStr, bool]="", image2: Union[AnyStr, bool]="", image3:
Union[AnyStr, bool]="", name: AnyStr="", q=True, query=True,
e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a context which may be used to select keyframes within the keyframe
region of the dope sheet editor
:param exists: (C) Returns true or false depending upon whether the specified object exists
Other flags are ignored
:param history: (C) If this is a tool command, turn the construction history on for the
tool in question
:param image1: (C Q E) First of three possible icons representing the tool associated with
the context
:param image2: (C Q E) Second of three possible icons representing the tool associated with
the context
:param image3: (C Q E) Third of three possible icons representing the tool associated with
the context
:param name: (C) If this is a tool command, name the tool appropriately
:returns: Context name
"""
pass
def nurbsToSubdiv(*args, addUnderTransform: bool=True, caching: bool=True, collapsePoles:
bool=False, constructionHistory: bool=True, matchPeriodic: bool=False,
maxPolyCount: Union[int, bool]=1000, name: AnyStr="", nodeState: Union[int,
bool]=0, object: bool=True, reverseNormal: bool=True, q=True, query=True,
e=True, edit=True, **kwargs)->Union[List[AnyStr], Any]:
"""
This command converts a NURBS surface and produces a subd surface The name of the new
subdivision surface is returned If construction history is ON, then the name of the new
dependency node is returned as well
:param addUnderTransform: (C Q E) Specify whether the new surface should be added under the
old transform or not
:param caching: (C Q E) Toggle caching for all attributes so that no recomputation is
needed
:param collapsePoles: (C Q E) Collapse poles into a single point Default: false
:param constructionHistory: (C) Turn the construction history on or off
:param matchPeriodic: (C Q E) Match periodic surface texture mapping in the result
Default: false
:param maxPolyCount: (C Q E) The maximum number of base mesh faces in the resulting
subdivision surface Default: 1000
:param name: (C) Sets the name of the newly-created node If it contains namespace path,
the new node will be created under the specified namespace; if the namespace
:param nodeState: (C Q E) This is implemented in the depend node base class and applies to
all nodes Blocking is applied during the evaluation phase to connections An evalua
:param object: (C) Create the result, or just the dependency node
:param reverseNormal: (C Q E) Reverse the NURBS surface normal in the conversion Default:
true
:returns: The subd surface and optionally the dependency node name
"""
pass
def UIModeMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def CreateConstraintClip(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def dR_createCameraFromView(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def sbs_GetEnumName(*args, **kwargs)->None:
"""
"""
pass
def image(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float, float,
float], bool]=None, defineTemplate: AnyStr="", docTag: Union[AnyStr, bool]="",
dragCallback: Script=None, dropCallback: Script=None, enable: bool=True,
enableBackground: bool=True, enableKeyboardFocus: bool=True, exists: bool=True,
fullPathName: bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float,
float, float], bool]=None, image: Union[AnyStr, bool]="", isObscured: bool=True,
manage: bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True, parent:
Union[AnyStr, bool]="", popupMenuArray: bool=True, preventOverride: bool=True,
statusBarMessage: AnyStr="", useTemplate: AnyStr="", visible: bool=True,
visibleChangeCommand: Union[Script, bool]=None, width: Union[int, bool]=0, q=True,
query=True, e=True, edit=True, **kwargs)->Union[AnyStr, Any]:
"""
This command creates a static image for non-xpm files Any image file format supported by
the file texture node is supported by this command
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param image: (C Q E) Sets the image given the file name
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: The name of the image created.
"""
pass
def symbolCheckBox(*args, annotation: Union[AnyStr, bool]="", backgroundColor: Union[List[float,
float, float], bool]=None, changeCommand: Script=None, defineTemplate:
AnyStr="", disableOffImage: Union[AnyStr, bool]="", disableOnImage:
Union[AnyStr, bool]="", docTag: Union[AnyStr, bool]="", dragCallback:
Script=None, dropCallback: Script=None, enable: bool=True, enableBackground:
bool=True, enableKeyboardFocus: bool=True, exists: bool=True, fullPathName:
bool=True, height: Union[int, bool]=0, highlightColor: Union[List[float,
float, float], bool]=None, image: Union[AnyStr, bool]="", innerMargin:
bool=True, isObscured: bool=True, ltVersion: Union[AnyStr, bool]="", manage:
bool=True, noBackground: bool=True, numberOfPopupMenus: bool=True,
offCommand: Script=None, offImage: Union[AnyStr, bool]="", onCommand:
Script=None, onImage: Union[AnyStr, bool]="", parent: Union[AnyStr, bool]="",
popupMenuArray: bool=True, preventOverride: bool=True, statusBarMessage:
AnyStr="", useTemplate: AnyStr="", value: bool=True, version: Union[AnyStr,
bool]="", visible: bool=True, visibleChangeCommand: Union[Script, bool]=None,
width: Union[int, bool]=0, q=True, query=True, e=True, edit=True,
**kwargs)->Union[AnyStr, Any]:
"""
This command creates a symbol check box A symbol check box is a simple control containing
a pixmap and a state of either on or off Commands can be attached to any or all of the
following events: when the symbol check box is turned on, turned off, or simply when it's
state is changed
:param annotation: (C Q E) Annotate the control with an extra string value
:param backgroundColor: (C Q E) The background color of the control The arguments
correspond to the red, green, and blue color components Each component ranges in value
from 0.0 t
:param changeCommand: (C E) Command executed when the check box's state is changed Note
that this flag should not be used in conjunction with onCommand and offCommand That is,
:param defineTemplate: (C) Puts the command in a mode where any other flags and arguments
are parsed and added to the command template specified in the argument They will be u
:param disableOffImage: (C Q E) Image displayed when the check box is off and disabled
:param disableOnImage: (C Q E) Image displayed when the check box is on and disabled
:param docTag: (C Q E) Add a documentation flag to the control The documentation flag has
a directory structure (e.g., -dt render/multiLister/createNode/material)
:param dragCallback: (C E) Adds a callback that is called when the middle mouse button is
pressed The MEL version of the callback is of the form: global proc string[] callback
:param dropCallback: (C E) Adds a callback that is called when a drag and drop operation is
released above the drop site The MEL version of the callback is of the form: global
:param enable: (C Q E) The enable state of the control By default, this flag is set to
true and the control is enabled Specify false and the control will appear dimmed or
:param enableBackground: (C Q E) Enables the background color of the control
:param enableKeyboardFocus: (C Q E) If enabled, the user can navigate to the control with
the tab key and select values with the keyboard If not, the user can only use the mouse
This
:param exists: (C) Returns whether the specified object exists or not Other flags are
ignored
:param fullPathName: (Q) Return the full path name of the widget, which includes all the
parents
:param height: (C Q E) The height of the control The control will attempt to be this size
if it is not overruled by parent layout conditions
:param highlightColor: (C Q E) The highlight color of the control The arguments correspond
to the red, green, and blue color components Each component ranges in value from 0.0 to
:param image: (C Q E) Image of the check box
:param innerMargin: (C Q E) This flag will revert the symbolCheckBox to its pre Maya 2.5
behaviour of having a 2 pixel inner margin This flag is for backward compatibility on L
:param isObscured: (Q) Return whether the control can actually be seen by the user The
control will be obscured if its state is invisible, if it is blocked (entirely or pa
:param ltVersion: (C Q E) This flag is used to specify the Maya LT version that this
control feature was introduced, if the version flag is not specified, or if the version fl
:param manage: (C Q E) Manage state of the control An unmanaged control is not visible,
nor does it take up any screen real estate All controls are created managed by def
:param noBackground: (C E) Clear/reset the control's background Passing true means the
background should not be drawn at all, false means the background should be drawn The s
:param numberOfPopupMenus: (Q) Return the number of popup menus attached to this control
:param offCommand: (C E) Command executed when the symbol check box is turned off
:param offImage: (C Q E) Image displayed when the check box is off
:param onCommand: (C E) Command executed when the symbol check box is turned on
:param onImage: (C Q E) Image displayed when the check box is on
:param parent: (C Q) The parent layout for this control
:param popupMenuArray: (Q) Return the names of all the popup menus attached to this
control
:param preventOverride: (C Q E) If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu
:param statusBarMessage: (C E) Extra string to display in the status bar when the mouse is
over the control
:param useTemplate: (C) Forces the command to use a command template other than the current
one
:param value: (C Q E) Value of the check box
:param version: (C Q E) Specify the version that this control feature was introduced The
argument should be given as a string of the version number (e.g "2017", "2018") C
:param visible: (C Q E) The visible state of the control A control is created visible by
default Note that a control's actual appearance is also dependent on the visible s
:param visibleChangeCommand: (C Q E) Command that gets executed when visible state of the
control changes
:param width: (C Q E) The width of the control The control will attempt to be this size if
it is not overruled by parent layout conditions
:returns: Full path name to the control.
"""
pass
def AddInbetween(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def PixelMoveDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def UnifyTangents(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass
def KeyframeTangentMarkingMenuPopDown(*args, **kwargs)->None:
"""
runTimeCommand
"""
pass