sculptMeshCacheCtx

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

Synopsis

sculptMeshCacheCtx([adjustSize=boolean], [adjustStrength=boolean], [affectAllLayers=boolean], [brushDirection=int], [brushSize=float], [brushStrength=float], [buildUpRate=float], [cloneHideSource=boolean], [cloneMethod=int], [cloneShapeSource=string], [cloneTargetSource=string], [constrainToSurface=boolean], [direction=int], [displayFrozen=boolean], [displayMask=boolean], [displayWireframe=boolean], [falloffType=int], [flood=float], [floodFreeze=float], [frame=boolean], [freezeSelection=boolean], [grabFollowPath=boolean], [grabSilhouette=boolean], [grabTwist=boolean], [inverted=boolean], [lastMode=string], [lockShellBorder=boolean], [makeStroke=[uint, uint, uint, float, float]], [minSize=float], [minStrength=float], [mirror=int], [mode=string], [orientToSurface=boolean], [recordStroke=boolean], [sculptFalloffCurve=string], [size=float], [stampDistance=float], [stampFile=string], [stampFlipX=boolean], [stampFlipY=boolean], [stampOrientToStroke=boolean], [stampPlacement=int], [stampRandomization=boolean], [stampRandomizationSeed=int], [stampRandomizeFlipX=boolean], [stampRandomizeFlipY=boolean], [stampRandomizePosX=float], [stampRandomizePosY=float], [stampRandomizeRotation=float], [stampRandomizeScale=float], [stampRandomizeStrength=float], [stampRotation=float], [steadyStrokeDistance=float], [strength=float], [updatePlane=boolean], [useGlobalSize=boolean], [useScreenSpace=boolean], [useStampDistance=boolean], [useStampImage=boolean], [useSteadyStroke=boolean], [wholeStroke=boolean], [wireframeAlpha=float], [wireframeColor=[float, float, float]])

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

sculptMeshCacheCtx is undoable, queryable, and editable.

Return value

None

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

Flags

Long name (short name)	Argument types	Properties
adjustSize(asz)	boolean
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.
adjustStrength(ast)	boolean
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 mode.
affectAllLayers(aal)	boolean
If true, the brush affects all layers at once.
brushDirection(bd)	int
Specifies the direction of the named brush.
brushSize(bsz)	float
Specifies the world-space size of the named brush.
brushStrength(bst)	float
Specifies the world-space strength of the named brush.
buildUpRate(bur)	float
Specifies the brush strength increasing along the stroke.
cloneHideSource(chs)	boolean
True if the cloned source should be hidden.
cloneMethod(cm)	int
Controls how the source delta vectors should change the target. 0=copy 1=add
cloneShapeSource(css)	string
Name of the shape source to clone.
cloneTargetSource(cas)	string
Name of the target source of the clone.
constrainToSurface(cts)	boolean
If true, the modification keeps the surface curvature.
direction(d)	int
Specifies the direction in which the vertices are moved.
displayFrozen(df)	boolean
If false, turns off the display of frozen area on the object.
displayMask(dm)	boolean
If false, turns off the display of masked area on the object.
displayWireframe(dw)	boolean
If false, turns off the wireframe display of the object.
falloffType(ft)	int
Specifies how the brush determines which vertices to affect.
flood(fl)	float
Sets the brush effect for each vertex to the given value.
floodFreeze(ff)	float
Sets the freeze value for each vertex to the given value.
frame(frm)	boolean
Frames on the sculpted area.
freezeSelection(fsl)	boolean
Freezes selected components.
grabFollowPath(gfp)	boolean
If true, the grab brush effect follows mouse movement.
grabSilhouette(gs)	boolean
If true, the grab brush uses paint-through mode.
grabTwist(gtw)	boolean
If true, the grab brush twists the vertices.
inverted(inv)	boolean
If true, inverts the effect of the brush.
lastMode(lm)	string
Specifies the type of the last active sculpting brush.
lockShellBorder(lsb)	boolean
Lock the shell borders so that they won't be moved by a UV texture brush.
makeStroke(mt)	[uint, uint, uint, float, float]
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 second argument is the side index. use 0 for the original side, and 1 for the mirrored side The third argument is the face index within the specified mesh. The fourth and fifth arguments are the face coordinates within the specified face.
minSize(msz)	float
Specifies the minimum size percentage of the current brush.
minStrength(mst)	float
Specifies the minimum strength percentage of the current brush.
mirror(mr)	int
Specifies the mirror mode of the brush.
mode(m)	string
Specifies the type of sculpting effect the brush will perform.
orientToSurface(ots)	boolean
If true, aligns the brush display to the surface of the mesh.
recordStroke(rcs)	boolean
Set this flag to true to enable stroke recording that can be later played back with the makeStroke flag.
sculptFalloffCurve(sfc)	string
Specifies the falloff curve of sculpting effect the brush will perform.
size(sz)	float
Specifies the world-space size of the current brush.
stampDistance(s)	float
Specifies the stamping distance of the brush.
stampFile(stp)	string
Specifies an image file to use as stamp.
stampFlipX(sfx)	boolean
Specifies if the brush stamp is flipped on the X axis.
stampFlipY(sfy)	boolean
Specifies if the brush stamp is flipped on the Y axis.
stampOrientToStroke(sos)	boolean
Specifies if the brush stamp is aligned to the stroke direction.
stampPlacement(sp)	int
Specifies the placement mode of the stamp image.
stampRandomization(srd)	boolean
Specifies if the brush stamp is randomized.
stampRandomizationSeed(sre)	int
Specifies the stamp randomization seed value. Use a value of 0 to generate a random seed value.
stampRandomizeFlipX(srx)	boolean
Specifies if the brush stamp flipping is randomized on the X axis.
stampRandomizeFlipY(sry)	boolean
Specifies if the brush stamp flipping is randomized on the Y axis.
stampRandomizePosX(spx)	float
Specifies the stamp X position value is randomized.
stampRandomizePosY(spy)	float
Specifies the stamp Y position value is randomized.
stampRandomizeRotation(srr)	float
Specifies the stamp rotation value is randomized.
stampRandomizeScale(src)	float
Specifies the stamp scale value is randomized.
stampRandomizeStrength(srs)	float
Specifies the stamp strength value is randomized.
stampRotation(sr)	float
Specifies the rotation value of the stamp image.
steadyStrokeDistance(ssd)	float
Specifies the distance for the steady stroke.
strength(st)	float
Specifies the world-space strength of the current brush.
updatePlane(upl)	boolean
Recalculates the underlying tool plane for each stamp in a stroke.
useGlobalSize(ugs)	boolean
If true, all the brushes have a shared size property; otherwise size is local.
useScreenSpace(ssp)	boolean
If true, the brush size is in screen space pixels.
useStampDistance(usd)	boolean
Force the stamps to be spread out along the stroke, rather than building up continually.
useStampImage(usi)	boolean
Specifies if the brush uses a stamp image.
useSteadyStroke(uss)	boolean
Turns using steady stroke on/off.
wholeStroke(wst)	boolean
Continuously recalculates the underlying tool plane from all the vertices affected during the stroke.
wireframeAlpha(wa)	float
Sets the alpha value of the wireframe for the object that is being sculpted.
wireframeColor(wc)	[float, float, float]
Sets the color of the wireframe for the object that is being sculpted. Values should be 0-1 RGB.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# Create a new sculpting context, then switch to it
cmds.sculptMeshCacheCtx('sculptMeshCacheContext')
cmds.setToolTo('sculptMeshCacheContext')

# Set sculptMeshCacheContext's brush size to 10.0
cmds.sculptMeshCacheCtx('sculptMeshCacheContext', edit=True, sz=10.0)