The PaintAttributesDrawMode class is used to access and set brush parameters used by the painting tool. These parameters control the paint radius mode, brush modes, mesh vertex format channel index edited by each brush, brush channel states, brush colors and brush alpha values. The level of flexibility provided allows multiple brushes to paint multiple vertex format channels simultaneously.
| Class Hierarchy | No registered superclass. |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | ClearActiveBrushChannelTypeStates | Disables all channel types for the active brush. |
| int32 | DisableAllBrushes | Disables all brushes. The brush state is set to disabled, but the channel type, color and alpha value are left intact. |
| int32 | GetActiveBrushChannelTypeState | Get the state (on or off) for a channel in the active brush. |
| <Color> | GetActiveBrushColor | Gets the color of the active brush. |
| double | GetBrushAlpha | Gets the alpha value of a brush. |
| int32 | GetBrushChannelIndex | Gets the mesh vertex channel index being edited by a brush. |
| int32 | GetBrushChannelTypeState | Gets the channel type state of a brush. |
| <Color> | GetBrushColor | Gets the color of a brush. |
| int32 | GetBrushState | Gets the state (enabled or disabled) of a brush. |
| int32 | GetMaxPaintBrushes | Gets the maximum number of paint brushes supported by the draw mode. |
| int32 | ResetAllBrushes | Resets all brushes. All brushes are set to disabled, all channels on all brushes are turned off, all brush colors are set to black, and all alpha values are set to 0.0. |
| int32 | ResetBrush | Resets a brush. All channels on the brush are turned off, the brush color is set to black, and the alpha value is set to 0.0. |
| int32 | SetActiveBrushChannelTypeState | Sets the state (on or off) for a channel in the active brush. |
| int32 | SetActiveBrushColor | Sets the color of the active brush. |
| int32 | SetBrushAlpha | Sets the alpha value of a brush. |
| int32 | SetBrushChannelIndex | Sets the edited mesh vertex channel index of a brush. |
| int32 | SetBrushChannelTypeState | Sets the channel type state of a brush. |
| int32 | SetBrushColor | Sets the color of a brush. |
| int32 | SetBrushState | Sets the state (enabled or disabled) of a brush. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| int32 | ActiveBrush | This member is used to get or set the active (or selected) brush index. The active brush represents the brush that is edited when the user changes brush states using the mouse, and is also the brush used to display paint indicators. |
| double | ActiveBrushAlpha | This member is used to get or set the alpha value of the active brush. |
| int32 | ActiveBrushChannelIndex | This member is used to get or set the channel index that the active brush is editing. |
| double | BrushRadius | This member is used to get or set the radius of the paint brush. |
| int32 | BrushRange | This member is used to get or set the range mode of the paint brush. 0 represents fixed units and 1 represents geometric topology. |