Sculpt Brush Tool

About

• Header File: sculpt/description/toolsculptbrushbase.h
• Description Category: Tools. An interactive tool. See Active Tool.
• Included Description:
  • Base Tool

Parameters

Parameters are accessed with C4DAtom::GetParameter()/ C4DAtom::SetParameter(). See Parameter IDs.

---

Parameter: Link Size

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_RADIUS_LINK
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Link Pressure

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_STRENGTH_LINK
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Link Symmetry

• Parameter ID: MDATA_SCULPTBRUSH_MIRRORING_LINK
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Backface

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_BACKFACE
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Keep Visual Size

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_USEZOOMSCALE
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Preview Mode

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_PREVIEWMODE
• Parameter Type: maxon::Int32 (Basic Data Types)
• Cycle Values:
  • Off (MDATA_SCULPTBRUSH_SETTINGS_PREVIEWMODE_OFF)
  • Screen (MDATA_SCULPTBRUSH_SETTINGS_PREVIEWMODE_SCREEN)
  • On Surface (MDATA_SCULPTBRUSH_SETTINGS_PREVIEWMODE_SURFACE)

---

Parameter: Load

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_LOADBRUSHPRESET
• Parameter Type: A button. See Attribute Manager Interaction

---

Parameter: Save

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_ADDBRUSHPRESET
• Parameter Type: A button. See Attribute Manager Interaction

---

Parameter: Reset

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_RESET
• Parameter Type: A button. See Attribute Manager Interaction

---

Parameter: Size

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_RADIUS
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: fx

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_RADIUS_MOD
• Parameter Type: A button. See Attribute Manager Interaction

---

Parameter: Pressure

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_STRENGTH
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: fx

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_STRENGTH_MOD
• Parameter Type: A button. See Attribute Manager Interaction

---

Parameter: Steady Stroke

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_STEADYSTROKE
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Length

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_STEADYSTROKE_VALUE
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Spacing

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_STAMPSPACING
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Percent

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_STAMPSPACING_VALUE
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Edge Detect

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_EDGE
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Angle

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_EDGE_ANGLE
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Draw Mode

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_DRAWMODE
• Parameter Type: maxon::Int32 (Basic Data Types)
• Cycle Values:
  • Freehand (MDATA_SCULPTBRUSH_SETTINGS_DRAWMODE_FREEHAND)
  • Line (MDATA_SCULPTBRUSH_SETTINGS_DRAWMODE_LINE)
  • Lasso Fill (MDATA_SCULPTBRUSH_SETTINGS_DRAWMODE_LASSO_FILL)
  • Poly Fill (MDATA_SCULPTBRUSH_SETTINGS_DRAWMODE_POLY_FILL)
  • Rectangle Fill (MDATA_SCULPTBRUSH_SETTINGS_DRAWMODE_RECTANGLE_FILL)

---

Parameter: Fill Symmetry

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_DRAWMODE_FILL_SYMMETRY
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Fill Backfaces

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_FILL_BACKFACES
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Direction

• Parameter ID: MDATA_SCULPTBRUSH_SETTINGS_DRAWDIR
• Parameter Type: maxon::Int32 (Basic Data Types)
• Cycle Values:
  • Normal (MDATA_SCULPTBRUSH_SETTINGS_DRAWDIR_AVERAGENORMAL)
  • X (MDATA_SCULPTBRUSH_SETTINGS_DRAWDIR_X)
  • Y (MDATA_SCULPTBRUSH_SETTINGS_DRAWDIR_Y)
  • Z (MDATA_SCULPTBRUSH_SETTINGS_DRAWDIR_Z)
  • Camera (MDATA_SCULPTBRUSH_SETTINGS_DRAWDIR_CAMERA)

---

Parameter: Reset

• Parameter ID: MDATA_SCULPTBRUSH_FALLOFF_RESET
• Parameter Type: A button. See Attribute Manager Interaction

---

Parameter: Falloff

• Parameter ID: MDATA_SCULPTBRUSH_FALLOFF_SPLINE
• Parameter Type: SplineData

---

Parameter: Load

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_LOADPRESET
• Parameter Type: A button. See Attribute Manager Interaction

---

Parameter: Save

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_ADDPRESET
• Parameter Type: A button. See Attribute Manager Interaction

---

Parameter: Clear

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_RESET
• Parameter Type: A button. See Attribute Manager Interaction

---

Parameter: Use Stamp

• Parameter ID: MDATA_SCULPTBRUSH_STAMP
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Image

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_TEXTUREFILENAME
• Parameter Type: Filename (Filename Manual)

---

Parameter: Material

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_MATERIAL_LINK
• Parameter Type: BaseLink (BaseLink Manual)

---

Parameter: Rotation

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_ROTATION_VALUE
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: fx

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_ROTATION_VALUE_MOD
• Parameter Type: A button. See Attribute Manager Interaction

---

Parameter: Flip Symmetry

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_SYMMETRICAL
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Flip X

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_FLIP_X
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Flip Y

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_FLIP_Y
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Gray Value

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_MIDVALUE
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Follow

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_FOLLOW
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Use Falloff

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_USEFALLOFF
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Use Alpha Channel

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_USEALPHA
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Show Depth

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_SHOWDEPTH
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Bilinear

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_INTERPOLATE
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Enclose

• Parameter ID: MDATA_SCULPTBRUSH_STAMP_ENCLOSE
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Axis

• Parameter ID: MDATA_SCULPTBRUSH_MIRRORING_AXIS
• Parameter Type: maxon::Int32 (Basic Data Types)
• Cycle Values:
  • World (MDATA_SCULPTBRUSH_MIRRORING_AXIS_OFF)
  • Local (MDATA_SCULPTBRUSH_MIRRORING_AXIS_LOCAL)
  • Workplane (MDATA_SCULPTBRUSH_MIRRORING_AXIS_WORKPLANE)

---

Parameter: X (YZ)

• Parameter ID: MDATA_SCULPTBRUSH_MIRRORING_X
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Y (XZ)

• Parameter ID: MDATA_SCULPTBRUSH_MIRRORING_Y
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Z (XY)

• Parameter ID: MDATA_SCULPTBRUSH_MIRRORING_Z
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Radial

• Parameter ID: MDATA_SCULPTBRUSH_MIRRORING_RADIAL
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Radial Symmetry Mode

• Parameter ID: MDATA_SCULPTBRUSH_MIRRORING_RADIAL_MODE
• Parameter Type: maxon::Int32 (Basic Data Types)
• Cycle Values:
  • XY (MDATA_SCULPTBRUSH_MIRRORING_RADIAL_MODE_X)
  • YZ (MDATA_SCULPTBRUSH_MIRRORING_RADIAL_MODE_Y)
  • ZX (MDATA_SCULPTBRUSH_MIRRORING_RADIAL_MODE_Z)
  • Point (MDATA_SCULPTBRUSH_MIRRORING_RADIAL_MODE_POINT)

---

Parameter: Custom Point

• Parameter ID: MDATA_SCULPTBRUSH_MIRRORING_RADIAL_CUSTOMPOINT
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Number of Radial Strokes

• Parameter ID: MDATA_SCULPTBRUSH_MIRRORING_RADIAL_VALUE
• Parameter Type: maxon::Int32 (Basic Data Types)

---

Parameter: Radial Gap Angle

• Parameter ID: MDATA_SCULPTBRUSH_MIRRORING_RADIAL_GAP
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Load

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_LOADPRESET
• Parameter Type: A button. See Attribute Manager Interaction

---

Parameter: Save

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_ADDPRESET
• Parameter Type: A button. See Attribute Manager Interaction

---

Parameter: Clear

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_RESET
• Parameter Type: A button. See Attribute Manager Interaction

---

Parameter: Use Stencil

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Visible

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_VISIBLE
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Hide During Stroke

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_HIDEONSTROKE
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Image

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_FILENAME
• Parameter Type: Filename (Filename Manual)

---

Parameter: Material

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_MATERIAL_LINK
• Parameter Type: BaseLink (BaseLink Manual)

---

Parameter: Transparency

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_TRANSPARENCY
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Angle

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_ANGLE
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Scale

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_SCALE
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Translate

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_TRANSLATE
• Parameter Type: maxon::Vector32 (Vectors)

---

Parameter: Tile X

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_TILEX
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Tile Y

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_TILEY
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Flip X

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_FLIP_X
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Flip Y

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_FLIP_Y
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Gray Value

• Parameter ID: MDATA_SCULPTBRUSH_STENCIL_MIDVALUE
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Enable Modifiers

• Parameter ID: MDATA_SCULPTBRUSH_MODIFIER_ENABLE
• Parameter Type: maxon::Bool (Basic Data Types)