PolyToolsPaintDeform : GlobalUtilityPlugin

Graphite Modeling Tools - Quick Navigation

The PolyToolsPaintDeform Global Utility Plugin introduced in 3ds Max 2011 exposes an interface which provides MAXScript access to the Graphite Paint Deform tools.

The functionality was first implemented in 3ds Max 2010 using different functions that were not officially supported as MAXScript tools. This interface consolidates all relevant properties and methods in one place and let MAXScript users apply them in their own tools.

Alsosee PolyToolsShift : GlobalUtilityPlugin for properties and methods related to the Shift tool also found in the Paint Deform panel of the Ribbon.

Constructor:

Class instances not creatable by MAXScript

PolyToolsPaintDeform interfaces:

Interface:  PolyToolsPaintDeform

Properties:

PolyToolsPaintDeform.CapOffset: bool : Read|Write

Get/set thestate of the Cap Offset option.

When set to true, the deformation over the same vertices within the same stroke will be capped at the Offset value.

When set to false, the deformation over the same vertices within the same stroke will be applied continuously.

PolyToolsPaintDeform.NormalDirection: integer : Read|Write

Get/set the Normal Direction mode for all tools.

Corresponds to the selection of the "Normal Direction" flyout in the Ribbon.

Possible values are:

0 - Original

1 - Deformed

2 - Brush

3 - View

4 - Transform X

5 - Transform Y

6 - Transform Z

Methods:

<bool>PolyToolsPaintDeform.PushPull ()

EntersPush/PullPaint Deformationmode.

Returns true if the mode was entered successfully, false otherwise.

<bool>PolyToolsPaintDeform.RelaxSoften ()

Enters Relax/Soften Paint Deformation mode.

Returns true if the mode was entered successfully, false otherwise.

<bool>PolyToolsPaintDeform.Flatten ()

Enters Flatten Paint Deformation mode.

Returns true if the mode was entered successfully, false otherwise.

<bool>PolyToolsPaintDeform.PinchSpread ()

Enters Pinch/Spread Paint Deformation mode.

Returns true if the mode was entered successfully, false otherwise.

<bool>PolyToolsPaintDeform.Smudge ()

Enters Smudge Paint Deformation mode.

Returns true if the mode was entered successfully, false otherwise.

<bool>PolyToolsPaintDeform.Noise ()

Enters Noise Paint Deformation mode.

Returns true if the mode was entered successfully, false otherwise.

<bool>PolyToolsPaintDeform.Exaggerate ()

Enters Exaggerate Paint Deformation mode.

Returns true if the mode was entered successfully, false otherwise.

<bool>PolyToolsPaintDeform.Revert ()

Enters Revert Paint Deformation mode.

Returns true if the mode was entered successfully, false otherwise.

<bool>PolyToolsPaintDeform.Commit ()

Commits the deformations applied during the current Paint Deformation session.

Equivalent to pressing the Commit button.

Returns true on success, false on failure.

<bool>PolyToolsPaintDeform.Cancel ()

Discards the deformations applied during the current Paint Deformation session.

Equivalent to pressing the Cancel button.

Returns true on success, false on failure.

<bool>PolyToolsPaintDeform.RefreshNormals ()

Updates theBrush tousethe current normals instead of the original normals.

This method is only valid when the NormalDirection property is set to 0 (Original).

To perform automatic update of the normals and always use the deformed ones, set the NormalDirection property to 1 (Deformed).

<bool>PolyToolsPaintDeform.BrushOptions ()

Opens the Brush Options dialog.

Returns true on success, false on failure.

See also PainterInterface : ReferenceTarget

<bool>PolyToolsPaintDeform.EndTool ()

Exits the current Deformation Painting mode, while also commiting the changes.

Returns true on success, false on failure.

Graphite Modeling Tools - Quick Navigation

See Also