Sculpt Brush

Detailed Description

Groups
	FIRSTHITPPOINTTYPE
	OVERRIDE
	SAMPLEMODE
	SCULPTBRUSHDATATYPE
	SCULPTBRUSHID
	SCULPTBRUSHMODE
	SCULPTOFFSETFLAGS

Classes
class	SculptFlagChecker
class	SculptPointPolysIterator
struct	SculptMouseData
struct	SculptCustomData
struct	BrushPointData
struct	BrushPolyData
class	BrushDabData
class	CustomSculptBrushBase
class	SculptBrushParams
class	SculptBrushToolData
class	SculptBrushModifierData
class	SculptModifierInterface

Macros
#define	LIBRARY_SCULPTBRUSH

Functions
Bool	RegisterBrushModifier (Int32 id, const String &name, DataAllocator *g, SCULPTBRUSHMODE mode, SCULPTBRUSHDATATYPE type, const String &resource, Bool hide=false, maxon::BaseArray< Int32 > *brushFilters=nullptr, maxon::BaseArray< Int32 > *brushRestrictions=nullptr, Int32 diskLevel=0)
Bool	AddSculptBrushModifierFunction (Int32 id, String name, SCULPTBRUSHMODE mode, SCULPTBRUSHDATATYPE type, maxon::BaseArray< Int32 > *brushFilters=nullptr, maxon::BaseArray< Int32 > *brushRestrictions=nullptr, Bool hide=false)
Bool	IsSculptBrush (Int32 toolID)
SculptBrushToolData *	GetSelectedSculptBrush (BaseDocument *doc)

Variables
class SculptFlagChecker	MAXON_ENUM_FLAGS

Macro Definition Documentation

LIBRARY_SCULPTBRUSH

#define LIBRARY_SCULPTBRUSH

Sculpt brush library ID.

Function Documentation

RegisterBrushModifier()

Bool RegisterBrushModifier	(	Int32	id,
		const String &	name,
		DataAllocator *	g,
		SCULPTBRUSHMODE	mode,
		SCULPTBRUSHDATATYPE	type,
		const String &	resource,
		Bool	hide = false,
		maxon::BaseArray< Int32 > *	brushFilters = nullptr,
		maxon::BaseArray< Int32 > *	brushRestrictions = nullptr,
		Int32	diskLevel = 0
	)

Adds a modifier function. Modifiers can be used with any other sculpting brush.
It is possible to add as many of these modifiers as needed.

Note

A brush Modifier can not access the brush data. So calling GetBrush() will return nullptr.

Parameters

[in]	id	A unique plugin ID. Must be obtained from http://www.plugincafe.com
[in]	name	The name of the modifier that will appear in the modifiers tab for every brush.
[in]	g	The Alloc() method for the SculptBrushModifierData node.
[in]	mode	The mode for the modifier. Note that SCULPTBRUSHMODE::NORMAL modes can not use SCULPTBRUSHMODE::GRAB modes as modifiers.
[in]	type	The type of data that the modifier changes.
[in]	resource	The name of the description resource file.
[in]	hide	If true the modifier is not be displayed on the Modifier tab for any sculpting brush. But it can still be accessed via the SculptModifierInterface.
[in]	brushFilters	A custom list of brushes ID to not display the modifier on specific sculpting brushes. If the modifier is the same functionality as a brush include that brushes ID here and the modifier will be filtered when that brush is selected.
[in]	brushRestrictions	A custom list of brushes ID to only display the modifier for specific sculpting brushes.
[in]	diskLevel	The plugin level is similar to a version number. The default level is 0. Increase this for new revisions of a plugin to allow for forward and backward compatibility. As an example you may have updated a plugin. If you now need to write additional information for new settings or changed types for old settings increase the level. During loading either a 0 is passed (if the file was written by the old plugin) or 1 (if the file was written by the new plugin). This allows to easily write/read new values. For forward and backward compatibility to work any existing read order from a given level must not be changed. Cinema 4D skips any new settings automatically if they have not been read. disklevel is only useful if variables are written/read in NodeData::Write/ NodeData::Read.

Returns

true if successful, otherwise false.

AddSculptBrushModifierFunction()

Bool AddSculptBrushModifierFunction	(	Int32	id,
		String	name,
		SCULPTBRUSHMODE	mode,
		SCULPTBRUSHDATATYPE	type,
		maxon::BaseArray< Int32 > *	brushFilters = nullptr,
		maxon::BaseArray< Int32 > *	brushRestrictions = nullptr,
		Bool	hide = false
	)

Internal. Use RegisterBrushModifier() method instead of this.

Parameters

[in]	id	A unique plugin ID. Must be obtained from http://www.plugincafe.com
[in]	name	The name of the modifier that will appear in the modifiers tab for every brush.
[in]	mode	The mode for the modifier. Note that SCULPTBRUSHMODE::NORMAL modes can not use SCULPTBRUSHMODE::GRAB modes as modifiers.
[in]	type	The type of data that the modifier changes.
[in]	brushFilters	A custom list of brushes ID to not display the modifier on specific sculpting brushes. If the modifier is the same functionality as a brush include that brushes ID here and the modifier will be filtered when that brush is selected.
[in]	brushRestrictions	A custom list of brushes ID to only display the modifier for specific sculpting brushes.
[in]	hide	If true the modifier is not be displayed on the Modifier tab for any sculpting brush. But it can still be accessed via the SculptModifierInterface.

Returns

true if successful, otherwise false.

IsSculptBrush()

Bool IsSculptBrush

(

Int32

toolID

)

Determines if a tool is a Sculpt Brush:

Int32 tool = GetActiveDocument()->GetAction();
Bool isBrush = IsSculptBrush(tool);

Parameters

[in]

toolID

The ID of the tool to check.

Returns

true if the tool is a Sculpt Brush, otherwise false.

GetSelectedSculptBrush()

SculptBrushToolData* GetSelectedSculptBrush

(

BaseDocument *

doc

)

Retrieves a pointer to the currently selected Sculpt Brush.

Parameters

[in]

doc

The document to check. The caller owns the pointed document.

Returns

A pointer to the currently selected SculptBrushToolData if one is currently active, otherwise nullptr.

Variable Documentation

MAXON_ENUM_FLAGS

class SculptFlagChecker MAXON_ENUM_FLAGS