pymel.core.context.sculptMeshCacheCtx

sculptMeshCacheCtx(*args, **kwargs)

This is a tool context command for mesh cache sculpting tool. In query mode, return type is based on queried flag.

Flags:

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

Derived from mel command maya.cmds.sculptMeshCacheCtx

Example:

::

import pymel.core as pm

# Create a new sculpting context, then switch to it pm.sculptMeshCacheCtx(‘sculptMeshCacheContext’) # Result: u’sculptMeshCacheContext’ # pm.setToolTo(‘sculptMeshCacheContext’)

# Set sculptMeshCacheContext’s brush size to 10.0 pm.sculptMeshCacheCtx(‘sculptMeshCacheContext’, edit=True, sz=10.0) # Result: u’sculptMeshCacheContext’ #