CustomSculptBrushBase Class Reference

#include <lib_sculptbrush.h>

Detailed Description

Private. Internal.

Public Types
using	IsAllocType = std::true_type

Public Member Functions
Bool	InitTool (BaseDocument *doc, BaseContainer &data, BaseThread *bt, SculptBrushToolData *tool)
void	FreeTool (BaseDocument *doc, BaseContainer &data, SculptBrushToolData *tool)
void	InitDefaultSettings (BaseDocument *doc, BaseContainer &data, SculptBrushToolData *tool)
Bool	GetDEnabling (const BaseDocument *doc, const BaseContainer &data, const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc, const SculptBrushToolData *tool) const
Bool	SetDParameter (BaseDocument *doc, BaseContainer &data, const DescID &id, const GeData &t_data, DESCFLAGS_SET &flags, SculptBrushToolData *tool)
Bool	GetDDescription (const BaseDocument *doc, const BaseContainer &data, Description *description, DESCFLAGS_DESC &flags, const SculptBrushToolData *tool) const
Bool	Message (BaseDocument *doc, BaseContainer &data, Int32 type, void *t_data, SculptBrushToolData *tool)
Bool	TranslateDescID (BaseDocument *doc, BaseContainer &data, const DescID &id, DescID &res_id, C4DAtom *&res_at, SculptBrushToolData *tool)
Bool	GetCursorInfo (BaseDocument *doc, BaseContainer &data, BaseDraw *bd, Float x, Float y, BaseContainer &bc, SculptBrushToolData *tool)
Bool	MouseInput (BaseDocument *doc, BaseContainer &data, BaseDraw *bd, EditorWindow *win, const BaseContainer &msg, SculptBrushToolData *tool)
Bool	KeyboardInput (BaseDocument *doc, BaseContainer &data, BaseDraw *bd, EditorWindow *win, const BaseContainer &msg, SculptBrushToolData *tool)
Int32	GetState (BaseDocument *doc, SculptBrushToolData *tool)
TOOLDRAW	Draw (BaseDocument *doc, BaseContainer &data, BaseDraw *bd, BaseDrawHelp *bh, BaseThread *bt, TOOLDRAWFLAGS flags, SculptBrushToolData *tool)
Bool	GetDParameter (const BaseDocument *doc, const BaseContainer &data, const DescID &id, GeData &t_data, DESCFLAGS_GET &flags, const SculptBrushToolData *tool) const
Bool	DisplayControl (BaseDocument *doc, BaseObject *op, BaseObject *chainstart, BaseDraw *bd, BaseDrawHelp *bh, ControlDisplayStruct &cds, const SculptBrushToolData *tool) const
Bool	InitDisplayControl (BaseDocument *doc, const BaseContainer &data, BaseDraw *bd, const AtomArray *active, SculptBrushToolData *tool)
void	FreeDisplayControl (SculptBrushToolData *tool)
void	StartStroke (Int32 strokeCount, const BaseContainer &data)
void	StartStrokeInstance (Int32 strokeInstanceID)
void	StartSymmetry ()
void	StartStrokeInstanceDabs (Int32 strokeInstanceID)
void	StartDab (Int32 strokeInstanceID)
void	EndDab (Int32 strokeInstanceID)
void	EndStrokeInstanceDabs (Int32 strokeInstanceID)
void	EndSymmetry ()
void	EndStrokeInstance (Int32 strokeInstanceID)
void	EndStroke ()
void	MouseData (Int32 strokeInstanceID, const BaseContainer &brushData, const SculptMouseData &md)
void	OverwriteLoadedPresetSettings (BaseContainer &data)
void	PostInitDefaultSettings (BaseDocument *doc, BaseContainer &data)
Bool	GetEnabling (Int32 id) const
Bool	HandleFillTool (BaseDocument *doc, BaseContainer &data, BaseDraw *bd, EditorWindow *win, const BaseContainer &msg)
Bool	HandleNonModelPickMode (BaseDocument *doc, BaseContainer &data, BaseDraw *bd, EditorWindow *win, const BaseContainer &msg)
Bool	DrawNonModelPickMode (BaseDocument *doc, BaseContainer &data, BaseDraw *bd, BaseDrawHelp *bh, BaseThread *bt, TOOLDRAWFLAGS flags)
void	FloodSelectedLayer (SculptObject *pSculpt, SculptLayer *pLayer, const BaseContainer &brushData, Int32 function, Bool preview, Float *customStrength=nullptr, const Vector32 *pVertexNormals=nullptr)
void	FloodSelectedLayerWithChannel (SculptObject *pSculpt, SculptLayer *pLayer, const BaseContainer &brushData, Int32 function, BaseChannel *pChannel, Bool preview, Float *customStrength=nullptr, const Vector32 *pVertexNormals=nullptr)
void	FloodSelectedLayerWithBitmap (SculptObject *pSculpt, SculptLayer *pLayer, const BaseContainer &brushData, Int32 function, BaseBitmap *pBitmap, Bool preview, Float *customStrength=nullptr, const Vector32 *pVertexNormals=nullptr)
Bool	HasDrawMode (Int32 mode)
Bool	Flood (BaseDocument *doc, BaseDraw *bd, const BaseContainer &brushData, Int32 button=MDATA_SCULPTBRUSH_SETTINGS_FLOOD)
Bool	FloodWithChannel (BaseDocument *doc, BaseDraw *bd, const BaseContainer &brushData, BaseChannel *pChannel, Int32 button=MDATA_SCULPTBRUSH_SETTINGS_FLOOD)
Bool	FloodWithBitmap (BaseDocument *doc, BaseDraw *bd, const BaseContainer &brushData, BaseBitmap *pBitmap, Int32 button=MDATA_SCULPTBRUSH_SETTINGS_FLOOD)
void	EnableSpecialDrawGizmo ()
void	DisableSpecialDrawGizmo ()
void	SetMouseDrag (Bool value)
Bool	IsMouseDrag ()
void	CacheObjects (BaseDocument *doc)
Int32	GetSelectionCacheCount ()
BaseList2D *	GetSelectionCacheObject (Int32 index)
Float	GetBrushStrength (Bool original)
void	InitZoomScale (BaseDocument *doc)
Bool	HasModifier ()
Bool	HasRespectSelections ()
Bool	WritePresetData (HyperFile *hf)
Bool	ReadPresetData (HyperFile *hf, Int32 level)
Bool	WriteStampPresetData (HyperFile *hf)
Bool	ReadStampPresetData (HyperFile *hf, Int32 level)
Bool	WriteSplinePresetData (HyperFile *hf)
Bool	ReadSplinePresetData (HyperFile *hf, Int32 level)
void	UpdateSettingsAfterPresetLoad (BaseContainer *data)
void	UpdateStencilAfterPresetLoad (BaseContainer *data)
const BaseBitmap *	GetStamp ()
const BaseBitmap *	GetStencil ()

Static Public Member Functions
static CustomSculptBrushBase *	Alloc ()
static CustomSculptBrushBase *	Alloc (const maxon::SourceLocation &)
static void	Free (CustomSculptBrushBase *&p)

Private Member Functions
	CustomSculptBrushBase ()
	~CustomSculptBrushBase ()

Private Attributes
_SculptBrushToolBase *	m_pBase

Friends
class	SculptBrushHotkeyCommandData
class	SymmetryToggleCommandData

Member Typedef Documentation

IsAllocType

using IsAllocType = std::true_type

Constructor & Destructor Documentation

CustomSculptBrushBase()

CustomSculptBrushBase ( )

private

~CustomSculptBrushBase()

~CustomSculptBrushBase ( )

private

Member Function Documentation

Alloc() [1/2]

static CustomSculptBrushBase* Alloc ( )

static

Alloc() [2/2]

static CustomSculptBrushBase* Alloc ( const maxon::SourceLocation &  )

static

Free()

static void Free ( CustomSculptBrushBase *&  p )

static

InitTool()

Bool InitTool	(	BaseDocument *	doc,
		BaseContainer &	data,
		BaseThread *	bt,
		SculptBrushToolData *	tool
	)

FreeTool()

void FreeTool	(	BaseDocument *	doc,
		BaseContainer &	data,
		SculptBrushToolData *	tool
	)

InitDefaultSettings()

void InitDefaultSettings	(	BaseDocument *	doc,
		BaseContainer &	data,
		SculptBrushToolData *	tool
	)

GetDEnabling()

Bool GetDEnabling	(	const BaseDocument *	doc,
		const BaseContainer &	data,
		const DescID &	id,
		const GeData &	t_data,
		DESCFLAGS_ENABLE	flags,
		const BaseContainer *	itemdesc,
		const SculptBrushToolData *	tool
	)		const

SetDParameter()

Bool SetDParameter	(	BaseDocument *	doc,
		BaseContainer &	data,
		const DescID &	id,
		const GeData &	t_data,
		DESCFLAGS_SET &	flags,
		SculptBrushToolData *	tool
	)

GetDDescription()

Bool GetDDescription	(	const BaseDocument *	doc,
		const BaseContainer &	data,
		Description *	description,
		DESCFLAGS_DESC &	flags,
		const SculptBrushToolData *	tool
	)		const

Message()

Bool Message	(	BaseDocument *	doc,
		BaseContainer &	data,
		Int32	type,
		void *	t_data,
		SculptBrushToolData *	tool
	)

TranslateDescID()

Bool TranslateDescID	(	BaseDocument *	doc,
		BaseContainer &	data,
		const DescID &	id,
		DescID &	res_id,
		C4DAtom *&	res_at,
		SculptBrushToolData *	tool
	)

GetCursorInfo()

Bool GetCursorInfo	(	BaseDocument *	doc,
		BaseContainer &	data,
		BaseDraw *	bd,
		Float	x,
		Float	y,
		BaseContainer &	bc,
		SculptBrushToolData *	tool
	)

MouseInput()

Bool MouseInput	(	BaseDocument *	doc,
		BaseContainer &	data,
		BaseDraw *	bd,
		EditorWindow *	win,
		const BaseContainer &	msg,
		SculptBrushToolData *	tool
	)

KeyboardInput()

Bool KeyboardInput	(	BaseDocument *	doc,
		BaseContainer &	data,
		BaseDraw *	bd,
		EditorWindow *	win,
		const BaseContainer &	msg,
		SculptBrushToolData *	tool
	)

GetState()

Int32 GetState	(	BaseDocument *	doc,
		SculptBrushToolData *	tool
	)

Draw()

TOOLDRAW Draw	(	BaseDocument *	doc,
		BaseContainer &	data,
		BaseDraw *	bd,
		BaseDrawHelp *	bh,
		BaseThread *	bt,
		TOOLDRAWFLAGS	flags,
		SculptBrushToolData *	tool
	)

GetDParameter()

Bool GetDParameter	(	const BaseDocument *	doc,
		const BaseContainer &	data,
		const DescID &	id,
		GeData &	t_data,
		DESCFLAGS_GET &	flags,
		const SculptBrushToolData *	tool
	)		const

DisplayControl()

Bool DisplayControl	(	BaseDocument *	doc,
		BaseObject *	op,
		BaseObject *	chainstart,
		BaseDraw *	bd,
		BaseDrawHelp *	bh,
		ControlDisplayStruct &	cds,
		const SculptBrushToolData *	tool
	)		const

InitDisplayControl()

Bool InitDisplayControl	(	BaseDocument *	doc,
		const BaseContainer &	data,
		BaseDraw *	bd,
		const AtomArray *	active,
		SculptBrushToolData *	tool
	)

FreeDisplayControl()

void FreeDisplayControl

(

SculptBrushToolData *

tool

)

StartStroke()

void StartStroke	(	Int32	strokeCount,
		const BaseContainer &	data
	)

StartStrokeInstance()

void StartStrokeInstance

(

Int32

strokeInstanceID

)

StartSymmetry()

void StartSymmetry

(

)

StartStrokeInstanceDabs()

void StartStrokeInstanceDabs

(

Int32

strokeInstanceID

)

StartDab()

void StartDab

(

Int32

strokeInstanceID

)

EndDab()

void EndDab

(

Int32

strokeInstanceID

)

EndStrokeInstanceDabs()

void EndStrokeInstanceDabs

(

Int32

strokeInstanceID

)

EndSymmetry()

void EndSymmetry

(

)

EndStrokeInstance()

void EndStrokeInstance

(

Int32

strokeInstanceID

)

EndStroke()

void EndStroke

(

)

MouseData()

void MouseData	(	Int32	strokeInstanceID,
		const BaseContainer &	brushData,
		const SculptMouseData &	md
	)

OverwriteLoadedPresetSettings()

void OverwriteLoadedPresetSettings

(

BaseContainer &

data

)

PostInitDefaultSettings()

void PostInitDefaultSettings	(	BaseDocument *	doc,
		BaseContainer &	data
	)

GetEnabling()

Bool GetEnabling

(

Int32

id

)

const

HandleFillTool()

Bool HandleFillTool	(	BaseDocument *	doc,
		BaseContainer &	data,
		BaseDraw *	bd,
		EditorWindow *	win,
		const BaseContainer &	msg
	)

HandleNonModelPickMode()

Bool HandleNonModelPickMode	(	BaseDocument *	doc,
		BaseContainer &	data,
		BaseDraw *	bd,
		EditorWindow *	win,
		const BaseContainer &	msg
	)

DrawNonModelPickMode()

Bool DrawNonModelPickMode	(	BaseDocument *	doc,
		BaseContainer &	data,
		BaseDraw *	bd,
		BaseDrawHelp *	bh,
		BaseThread *	bt,
		TOOLDRAWFLAGS	flags
	)

FloodSelectedLayer()

void FloodSelectedLayer	(	SculptObject *	pSculpt,
		SculptLayer *	pLayer,
		const BaseContainer &	brushData,
		Int32	function,
		Bool	preview,
		Float *	customStrength = nullptr,
		const Vector32 *	pVertexNormals = nullptr
	)

FloodSelectedLayerWithChannel()

void FloodSelectedLayerWithChannel	(	SculptObject *	pSculpt,
		SculptLayer *	pLayer,
		const BaseContainer &	brushData,
		Int32	function,
		BaseChannel *	pChannel,
		Bool	preview,
		Float *	customStrength = nullptr,
		const Vector32 *	pVertexNormals = nullptr
	)

FloodSelectedLayerWithBitmap()

void FloodSelectedLayerWithBitmap	(	SculptObject *	pSculpt,
		SculptLayer *	pLayer,
		const BaseContainer &	brushData,
		Int32	function,
		BaseBitmap *	pBitmap,
		Bool	preview,
		Float *	customStrength = nullptr,
		const Vector32 *	pVertexNormals = nullptr
	)

HasDrawMode()

Bool HasDrawMode

(

Int32

mode

)

Flood()

Bool Flood	(	BaseDocument *	doc,
		BaseDraw *	bd,
		const BaseContainer &	brushData,
		Int32	button = MDATA_SCULPTBRUSH_SETTINGS_FLOOD
	)

FloodWithChannel()

Bool FloodWithChannel	(	BaseDocument *	doc,
		BaseDraw *	bd,
		const BaseContainer &	brushData,
		BaseChannel *	pChannel,
		Int32	button = MDATA_SCULPTBRUSH_SETTINGS_FLOOD
	)

FloodWithBitmap()

Bool FloodWithBitmap	(	BaseDocument *	doc,
		BaseDraw *	bd,
		const BaseContainer &	brushData,
		BaseBitmap *	pBitmap,
		Int32	button = MDATA_SCULPTBRUSH_SETTINGS_FLOOD
	)

EnableSpecialDrawGizmo()

void EnableSpecialDrawGizmo

(

)

DisableSpecialDrawGizmo()

void DisableSpecialDrawGizmo

(

)

SetMouseDrag()

void SetMouseDrag

(

Bool

value

)

IsMouseDrag()

Bool IsMouseDrag

(

)

CacheObjects()

void CacheObjects

(

BaseDocument *

doc

)

GetSelectionCacheCount()

Int32 GetSelectionCacheCount

(

)

GetSelectionCacheObject()

BaseList2D* GetSelectionCacheObject

(

Int32

index

)

GetBrushStrength()

Float GetBrushStrength

(

Bool

original

)

InitZoomScale()

void InitZoomScale

(

BaseDocument *

doc

)

HasModifier()

Bool HasModifier

(

)

HasRespectSelections()

Bool HasRespectSelections

(

)

WritePresetData()

Bool WritePresetData

(

HyperFile *

hf

)

ReadPresetData()

Bool ReadPresetData	(	HyperFile *	hf,
		Int32	level
	)

WriteStampPresetData()

Bool WriteStampPresetData

(

HyperFile *

hf

)

ReadStampPresetData()

Bool ReadStampPresetData	(	HyperFile *	hf,
		Int32	level
	)

WriteSplinePresetData()

Bool WriteSplinePresetData

(

HyperFile *

hf

)

ReadSplinePresetData()

Bool ReadSplinePresetData	(	HyperFile *	hf,
		Int32	level
	)

UpdateSettingsAfterPresetLoad()

void UpdateSettingsAfterPresetLoad

(

BaseContainer *

data

)

UpdateStencilAfterPresetLoad()

void UpdateStencilAfterPresetLoad

(

BaseContainer *

data

)

GetStamp()

const BaseBitmap* GetStamp

(

)

GetStencil()

const BaseBitmap* GetStencil

(

)

Friends And Related Function Documentation

SculptBrushHotkeyCommandData

friend class SculptBrushHotkeyCommandData

friend

SymmetryToggleCommandData

friend class SymmetryToggleCommandData

friend

Member Data Documentation

m_pBase

_SculptBrushToolBase* m_pBase

private