By default the .res file includes the tabs for Stamps and Stencils and the options for Size, Pressure, Steady Stroke, Spacing and the Draw Modes.
If any of these options are need then hide them in the .res file by adding the following lines to the top of it:

By Default the Draw Modes that are available are Freehand, Line, Lasso Fill, Polygon Fill and Rectangle Fill.
To remove any of these or add more, customize the list. Here is an example below where support is added for all the different modes, including DragDab and DragRect.
Just remove any from this list to suit the brush. By default Freehand is set, so if the Draw Mode is hidden the brush will still work.

Also make sure the priority for any sculpting plugins are set correctly. Sculpt brush plugins need to be loaded after the main sculpting plugin.
To ensure this set the priority in PluginMessage(Int32 id, void *data) as shown below:

构造函数 & 析构函数文档编制

◆  SculptBrushParams()

◆  ~SculptBrushParams()

成员函数文档编制

◆  Alloc()

Allocates a SculptBrushParams object. Destroy the allocated SculptBrushParams object with Free() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

返回

The allocated SculptBrushParams object, or nullptr if the allocation failed.

◆  Free()

Destructs SculptBrushParams objects allocated with Alloc() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

参数

[in,out]

params

The SculptBrushParams object to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆  EnableStencil()

Enables/disables stencils in the brush.

注意

Setting to false frees up some resource and computation time.
Setting to false also removes the tab from the brush interface.

参数

[in]

enable

true if the brush uses stencils, false if not. Default is true .

◆  EnableStamp()

Enables/disables stamps in the brush.

注意

Setting to false frees up some resource and computation time.
Setting to false also removes the tab from the brush interface.

参数

[in]

enable

true if the brush uses stamps, false if not. Default is true .

◆  EnableInvertCheckbox()

Enables/disables the Invert checkbox in the brush.

注意

By default the invert checkbox is not part of the base .res file so add it manually: GROUP MDATA_SCULPTBRUSH_SETTINGS_GROUP { COLUMNS 3; BOOL MDATA_SCULPTBRUSH_SETTINGS_INVERT { } STATICTEXT { DUMMY ; } STATICTEXT { DUMMY ; } }

参数

[in]

enable

true if the brush uses the Invert checkbox, false if not. Default is false .

◆  EnableBuildup()

Enables/disables the Buildup slider in the brush.

注意

By default the Buildup slider is not part of the base .res file so to add it manually: GROUP MDATA_SCULPTBRUSH_SETTINGS_GROUP { COLUMNS 3; REAL MDATA_SCULPTBRUSH_SETTINGS_BUILDUP { MIN 1; MAX 100; MINSLIDER 1; MAXSLIDER 100; CUSTOMGUI REALSLIDER; FIT_H; SCALE_H; } STATICTEXT { JOINENDSCALE; } STATICTEXT { JOINEND; } }

参数

[in]

enable

true if the brush uses the Buildup slider, false if not. Default is false .

◆  EnableNonModelPickMode()

Enables/disables non model pick mode, i.e. the brush do anything if the user clicks-off of a model: SculptBrushToolData::HandleNonModelPickMode and SculptBrushToolData::DrawNonModelPickMode are implemented.

参数

[in]

enable

true if SculptBrushToolData::HandleNonModelPickMode and SculptBrushToolData::DrawNonModelPickMode are implemented, false if not. Default is false .

◆  EnableFlood()

Enables/disables the Flood function in the brush: SculptBrushToolData::FloodSelectedLayer is implemented.

注意

By default the Flood button is not part of the base .res file so add it manually: GROUP MDATA_SCULPTBRUSH_SETTINGS_GROUP { COLUMNS 3; BUTTON MDATA_SCULPTBRUSH_SETTINGS_FLOOD { } STATICTEXT { JOINENDSCALE; } STATICTEXT { JOINEND; } }

参数

[in]

enable

true if SculptBrushToolData::FloodSelectedLayer is implemented, false if not. Default is false .

◆  EnableMultiThreading()

Enables/disables multithreading for the brush. Private .

警告

Never enable multithreading!

Tells the system that the brush can be multithreaded. If true then the dabs are distributed over multiple threads and are drawn in any order.
Any calls to the MovePointFunc could now be for any stroke instance and could be out of order and from different threads.

参数

[in]

enable

true if the brush multithreaded, false if not. Default is false .

◆  EnableBrushAccess()

Enables/disables getting access to the brush via dab->GetBrush().

参数

[in]

enable

true if access to the brush is needed, false if not. Default is false .

◆  EnableToolSpecificSmooth()

Enables/disables the brush own smooth operation that gets used when the Shift key is pressed.

注意

Check for this in the MovePointFunc method if (GetBrushOverride() & OVERRIDE::SMOOTHTOOL) is true and then implement the custom smooth method. Otherwise it will use the Smooth Brush for smoothing.

参数

[in]

enable

true if the brush handles smoothing, false if not. Default is false .

◆  EnableModifier()

Tells the system that the brush can use modifiers from other brushes (display the Modifiers tab).

参数

[in]

enable

true if the brush wants to be able to use modifiers from other brushes.

◆  EnablePython()

Enables/disables Python for the brush. Private .

警告

Never enable for a C++ plugin! This is only ever used internally by Python brushes. When enabled it routes the calls to SculptBrushToolData::ApplyPythonDab .
All calls are only ever single threaded with no access to the brush data.

◆  EnableDrawDirection()

When enabled the Draw Direction UI will appear in the Settings tab.
Calls can then be made to GetDrawDirectionNormal() to get the direction of the normal based on the currently selected Draw Direction.

参数

[in]

enable

true to display the Draw Direction UI options. Disabled by default.

◆  EnableCustomStamp()

Enables/disables call to SculptBrushToolData::GetCustomData to change the stamp before a dab is drawn.

注意

EnableBrushAccess(true) must also be set.

参数

[in]

enable

true if the brush has a custom stamp, false if not. Default is false .

◆  EnableRespectSelections()

Enables/disables the brush to respect Point and Polygon selections when in Point or Polygon mode respectively.

参数

[in]

enable

true if the brush should respect selections, false if not. Default is false .

◆  EnableFillToolIsolatedPointRemover()

Enables/disables the Fill algorithm to remove any isolated points. That is any points that are selected but have no neighboring selections.
This can happen on high resolution meshes due to the nature of the hit detection against screen space pixels defined by the fill tools.
By setting to false it keeps any isolated points that are selected. This is true by default so isolated points are removed before being sent to the MovePointFunc 函数。

参数

[in]

enable

true if the brush should remove isolated points, false if it should keep them. Default is true .

◆  EnablePressureHUD()

Enables/disables displaying the pressure value in the sculpting size/pressure HUD.

参数

[in]

enable

true if the brush should display the pressure value, false if not. Default is true .

◆  EnableMouseData()

Enables/disables the callback for the MouseData method.

由于

R17.032

参数

[in]

enable

true if you need the MouseData callback, false if not. Default is false .

◆  EnableBackfaceSculpting()

Tells the system that this brush supports backface sculpting and that the Backface option should be displayed in the brushes settings.

由于

R17.032

参数

[in]

enable

true if the brush supports backface sculpting, false if not. Default is false .

◆  SetFloodType()

Specifies what kind of data the Flood operation will change (points or mask).

参数

[in]

type

The flood data type. Default is SCULPTBRUSHDATATYPE::POINT .

◆  SetBrushMode()

Specifies the type of brush (grab or normal).

参数

[in]

mode

The brush mode. Default is SCULPTBRUSHMODE::NORMAL .

◆  SetFirstHitPointType()

Specifies what should happen when the user first clicks on model before dragging.

参数

[in]

type

The first hit point type. Default is FIRSTHITPPOINTTYPE::SELECTED .

◆  SetUndoType()

Specifies what kind of data the brush changes and stores in the undo system (point or mask).

参数

[in]

type

The brush data type. Default is SCULPTBRUSHDATATYPE::POINT .

◆  SetPolygonObjectDirtyFlags()

Sets which flags should be checked to do a rebuild of the collision structure for a PolygonObject .
These flags are used to check against the PolygonObjects dirty flags when a stroke is about to be done on a PolygonObject .
If the flags being checked are dirty since the last check then the collision cache structure for the object will be rebuilt.
This can be used in cases such as the Select Brush where you are not directly moving the points of the model during a stroke.
So you can set all the flags except the DIRTYFLAGS::SELECT (using something like ( DIRTYFLAGS::ALL & ~DIRTYFLAGS SELECT ) to ensure that the object is not recalculated when just the select flags are changed.
In all other cases the object will be rebuilt.

由于

R17.032

参数

[in]

flags

The dirty flags to check. By default this is set to DIRTYFLAGS::ALL .

◆  SetMovePointFunc()

A pointer to the static method that is called to modify the SculptObject .
The MovePointFunc method must be implemented and passed like the following:

// Declare the MovePointFunc method Bool MySculptBrush::MovePointFunc( BrushDabData *dab) { // Implement the functionality of the brush here return true ; }

//Then pass it into the parameters method like pParams-> SetMovePointFunc (&MySculptBrush::MovePointFunc);

参数

[in]

surfaceMovePointFunc

The static method to call for each brush dab.

• SculptBrushParams