#include <c4d_painter.h>

Inheritance diagram for PaintMaterial:

[legend]

Detailed Description

A class for paint materials. It represents a paintable material.

Public Member Functions
void	EnableMaterial (BaseDocument *doc, Bool on, Bool suppressevent=false, Bool domaterialundo=true)

BaseMaterial *	GetBaseMaterial (BaseDocument *doc)

Public Member Functions inherited from PaintBitmap
Int32	GetBw () const

Int32	GetBh () const

PaintTexture *	GetPaintTexture ()

const PaintTexture *	GetPaintTexture () const

PaintBitmap *	GetParent ()

const PaintBitmap *	GetParent () const

PaintLayer *	GetLayerDownFirst ()

const PaintLayer *	GetLayerDownFirst () const

PaintLayer *	GetLayerDownLast ()

const PaintLayer *	GetLayerDownLast () const

PaintLayer *	GetAlphaFirst ()

const PaintLayer *	GetAlphaFirst () const

PaintLayer *	GetAlphaLast ()

const PaintLayer *	GetAlphaLast () const

PaintLayerBmp *	AddAlphaChannel (Int32 bitdepth, PaintLayer *prev=nullptr, Bool undo=true, Bool activate=true)

Bool	AskApplyAlphaMask () const

void	ApplyAlphaMask (Int32 x, Int32 y, Int32 cnt, PIX *bits, COLORMODE mode, Bool inverted, Int32 flags) const

PaintLayerMask *	FindSelectionMask (PaintBitmap *toplevel, Int32 bitdepth)

COLORMODE	GetColorMode () const

UInt32	GetDirty (DIRTYFLAGS flags) const

void	UpdateRefresh (Int32 xmin, Int32 ymin, Int32 xmax, Int32 ymax, UInt32 flags)

void	UpdateRefreshAll (UInt32 flags, Bool reallyall)

Bool	ReCalc (BaseThread thread, Int32 x1, Int32 y1, Int32 x2, Int32 y2, BaseBitmap bmp, Int32 flags, UInt32 showbit)

Public Member Functions inherited from BaseList2D
void	SetBit (Int32 mask)

Bool	GetBit (Int32 mask) const

void	DelBit (Int32 mask)

void	ToggleBit (Int32 mask)

Int32	GetAllBits () const

void	SetAllBits (Int32 bits)

void	SetBitEx (Int32 mask, Int32 flags)

const Char *	GetViewportRenderId (VIEWPORT_RENDER_ID typeId) const

BaseList2D *	GetNext ()

const BaseList2D *	GetNext () const

BaseList2D *	GetPred ()

const BaseList2D *	GetPred () const

BaseContainer	GetData ()

void	SetData (const BaseContainer &bc, Bool add=true)

const BaseContainer &	GetDataInstanceRef () const

BaseContainer &	GetDataInstanceRef ()

const BaseContainer *	GetDataInstance () const

BaseContainer *	GetDataInstance ()

String	GetName () const

void	SetName (const maxon::String &name, Bool setDirty=true)

String	GetBubbleHelp ()

Bool	TransferGoal (BaseList2D *dst, Bool undolink)

Bool	TransferMarker (BaseList2D *dst) const

Bool	CopyDynamicDescriptionFrom (const BaseList2D *src)

Bool	Scale (Float scale)

Bool	Edit ()

void	GetIcon (IconData *dat)

GeListHead *	GetNLARoot (Bool create)

BaseList2D *	AnimationLayerRemap (BaseObject **layer=nullptr)

String	GetTypeName () const

BaseList2D *	GetMain () const

void	InsertTrackSorted (CTrack *track)

Bool	AddEventNotification (BaseList2D bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer data)

Bool	RemoveEventNotification (const BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	FindEventNotification (const BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	SetDescIDState (const DescID &id, DESCIDSTATE descidstate)

DESCIDSTATE	GetDescIDState (const DescID &id, Bool tolerant) const

GeListHead *	GetOverrideRoot (Bool create)

BaseOverride *	GetFirstOverride ()

GeListHead *	GetShaderRepositoryRoot (Bool create)

GeListHead *	GetHiddenShaderRoot (Bool create)

maxon::NimbusForwardRef	GetNimbusRef (const maxon::Id &spaceId) const

maxon::Result< maxon::NimbusForwardRef >	PrivateGetOrCreateNimbusRef (const maxon::Id &spaceId)

void	RemoveNimbusRef (const maxon::Id &spaceId)

maxon::Result< maxon::HashMap< maxon::Id, maxon::NimbusForwardRef > >	GetAllNimbusRefs () const

Bool	IsNodeBased () const

maxon::Result< Bool >	GetAccessedObjects (METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsRec (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, Bool withSiblings, Bool withChildren, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfChildren (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfFirstChildHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< maxon::GenericData >	GroupChanges ()

void	GetMarkerStampEx (UInt32 l1, UInt32 l2)

const GeMarker &	GetMarker () const

void	SetMarker (const GeMarker &m)

Bool	AddUniqueID (Int32 appid, const Char *const mem, Int bytes)

Bool	FindUniqueID (Int32 appid, const Char *&mem, Int &bytes) const

Int32	GetUniqueIDCount () const

Bool	GetUniqueIDIndex (Int32 idx, Int32 &id, const Char *&mem, Int &bytes) const

Bool	SetAnimatedParameter (const CTrack *track, const DescID &id, const GeData &t_data1, const GeData &t_data2, Float mix, DESCFLAGS_SET flags)

Bool	GetAnimatedParameter (const DescID &id, GeData &t_data1, GeData &t_data2, Float &mix, DESCFLAGS_GET flags) const

BaseShader *	GetFirstShader () const

void	InsertShader (BaseShader shader, BaseShader pred=nullptr)

void	ClearKeyframeSelection ()

Bool	FindKeyframeSelection (const DescID &id)

Bool	SetKeyframeSelection (const DescID &id, Bool selection)

Bool	KeyframeSelectionContent ()

LayerObject *	GetLayerObject (const BaseDocument *doc)

const LayerObject *	GetLayerObject (const BaseDocument *doc) const

Bool	SetLayerObject (const LayerObject *layer)

const LayerData *	GetLayerData (const BaseDocument *doc, Bool rawdata=false) const

Bool	SetLayerData (BaseDocument *doc, const LayerData &data)

GeListHead *	GetCTrackRoot (Bool create)

const GeListHead *	GetCTrackRoot () const

CTrack *	GetFirstCTrack ()

const CTrack *	GetFirstCTrack () const

CTrack *	FindCTrack (const DescID &id)

const CTrack *	FindCTrack (const DescID &id) const

Public Member Functions inherited from GeListNode
GeListNode *	GetNext ()

const GeListNode *	GetNext () const

GeListNode *	GetPred ()

const GeListNode *	GetPred () const

GeListNode *	GetDown ()

const GeListNode *	GetDown () const

GeListNode *	GetUp ()

const GeListNode *	GetUp () const

GeListNode *	GetDownLast ()

const GeListNode *	GetDownLast () const

void	InsertBefore (GeListNode *bl)

void	InsertAfter (GeListNode *bl)

void	InsertUnder (GeListNode *bl)

void	InsertUnderLast (GeListNode *bl)

void	Remove ()

void	FlushChilds ()

void	MoveChildrenTo (GeListNode *dest)

GeListHead *	GetListHead ()

const GeListHead *	GetListHead () const

Int32	GetNodeID (Int32 index=0) const

template<typename CAST >
const CAST *	GetNodeData (Int32 index=0) const

template<typename CAST >
CAST *	GetNodeData (Int32 index=0)

void	SetCustomData (GeListNode *node)

GeListNode *	GetCustomData ()

const GeListNode *	GetCustomData () const

const BaseDocument *	GetDocument () const

BaseDocument *	GetDocument ()

maxon::Result< Bool >	GetBranchInfo (const maxon::ValueReceiver< const BranchInfo & > &info, GETBRANCHINFO flags) const

Bool	IsDocumentRelated () const

Int32	GetInfo () const

Bool	GetNBit (NBIT bit) const

UInt32	GetNBitMask (Int32 index) const

Bool	ChangeNBit (NBIT bit, NBITCONTROL bitmode)

Public Member Functions inherited from C4DAtom
Int32	GetType () const

Int32	GetRealType () const

Int32	GetDiskType () const

Bool	IsInstanceOf (Int32 id) const

Int32	GetClassification () const

Bool	Message (Int32 type, void *data=nullptr)

Bool	MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)

C4DAtom *	GetClone (COPYFLAGS flags, AliasTrans *trn) const

Bool	CopyTo (C4DAtom dst, COPYFLAGS flags, AliasTrans trn) const

Bool	Read (HyperFile *hf, Int32 id, Int32 level)

Bool	Write (HyperFile *hf) const

Bool	ReadObject (HyperFile *hf, Bool readheader)

Bool	WriteObject (HyperFile *hf) const

Bool	GetDescription (Description *description, DESCFLAGS_DESC flags) const

Bool	GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags) const

Bool	SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)

DynamicDescription *	GetDynamicDescriptionWritable ()

const DynamicDescription *	GetDynamicDescription () const

Bool	CopyDynamicDescriptionFrom (const BaseList2D *src)

Bool	GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc) const

Bool	TranslateDescID (const DescID &id, DescID &res_id, C4DAtom *&res_at)

UInt32	GetDirty (DIRTYFLAGS flags) const

void	SetDirty (DIRTYFLAGS flags)

UInt32	GetHDirty (HDIRTYFLAGS mask) const

void	SetHDirty (HDIRTYFLAGS mask)

Static Public Member Functions
static PaintMaterial *	GetActivePaintMaterial (BaseDocument doc=nullptr, BaseMaterial *mat=nullptr)

static PaintMaterial *	GetPaintMaterialFromTexture (PaintTexture *tex, Bool onlyeditable)

static Bool	GetAllPaintMaterialsFromTexture (PaintTexture *tex, AtomArray &materials)

static PaintMaterial *	GetPaintMaterial (BaseDocument doc, BaseMaterial material, Bool create)

static Bool	UnloadPaintMaterial (BaseDocument doc, BaseMaterial material, Bool forcesave)

static Bool	SaveDocument (BaseDocument *doc, Bool &cancel)

static Bool	AskNeedToSave (BaseDocument *doc)

static void	GetSelectionMaskState (Bool &hasSelectionMask, Bool &isEditMaskActive)

static void	GetMaterialChannelDisplay (BaseDocument *doc, Bool &isSingleDisplayActive, Int32 &materialChannel)

Static Public Member Functions inherited from PaintBitmap
static Bool	ConvertBits (Int32 cnt, const PIX src, Int32 srcinc, COLORMODE srcmode, PIX dst, Int32 dstinc, COLORMODE dstmode, Int32 dithery, Int32 ditherx)

Static Public Member Functions inherited from BaseList2D
static BaseList2D *	Alloc (Int32 type)

static void	Free (BaseList2D *&bl)

Private Member Functions
	PaintMaterial ()

	~PaintMaterial ()

Additional Inherited Members
Static Public Attributes inherited from BaseList2D
static const Int32	SETBIT_FLAG_NODIRTY

static const Int32	SETBIT_FLAG_REMOVE

Constructor & Destructor Documentation

◆ PaintMaterial()

PaintMaterial ( )

private

◆ ~PaintMaterial()

~PaintMaterial ( )

private

Member Function Documentation

◆ EnableMaterial()

void EnableMaterial	(	BaseDocument *	doc,
		Bool	on,
		Bool	suppressevent = `false`,
		Bool	domaterialundo = `true`
	)

Enables a material for painting.

Parameters

[in]	doc	The document the material belongs to.
[in]	on	true to enable the material for painting, false to disable it.
[in]	suppressevent	Private.
[in]	domaterialundo	If true an undo is created on the undo stack.

◆ GetActivePaintMaterial()

static PaintMaterial* GetActivePaintMaterial	(	BaseDocument *	doc = `nullptr`,
		BaseMaterial **	mat = `nullptr`
	)

static

Retrieves the active paint material.

Parameters

[in]	doc	Pass the document to look for active paint materials.
[out]	mat	Filled with the material linked to the paint material.

Returns: The active paint material, or nullptr if there is none.

◆ GetPaintMaterialFromTexture()

static PaintMaterial* GetPaintMaterialFromTexture	(	PaintTexture *	tex,
		Bool	onlyeditable
	)

static

Retrieves a paint material from a paint texture.

Parameters

[in]	tex	The paint texture to retrieve the paint material from.
[in]	onlyeditable	true to retrieve only editable paint materials.

Returns: The paint material of the texture, or nullptr if there is no paint material available.

◆ GetAllPaintMaterialsFromTexture()

static Bool GetAllPaintMaterialsFromTexture	(	PaintTexture *	tex,
		AtomArray &	materials
	)

static

Retrieves all paint materials from a paint texture.

Parameters

[in]	tex	The paint texture to retrieve the paint material from.
[out]	materials	An AtomArray that receives all paint materials.

Returns: true, if at least one texture was found.

◆ GetPaintMaterial()

static PaintMaterial* GetPaintMaterial	(	BaseDocument *	doc,
		BaseMaterial *	material,
		Bool	create
	)

static

Retrieves the paint material of the material.

Parameters

[in]	doc	The document of the material.
[in]	material	The material to evaluate.
[in]	create	true to force a paint material.

Returns: The paint material, or nullptr if there is none.

◆ UnloadPaintMaterial()

static Bool UnloadPaintMaterial	(	BaseDocument *	doc,
		BaseMaterial *	material,
		Bool	forcesave
	)

static

Unloads a paint material (close all textures of the material).

Parameters

[in]	doc	The document of the material.
[in]	material	The material to unload.
[in]	forcesave	true to force save all the textures.

Returns: true if successful, otherwise false.

◆ SaveDocument()

static Bool SaveDocument	(	BaseDocument *	doc,
		Bool &	cancel
	)

static

Private.

◆ AskNeedToSave()

static Bool AskNeedToSave ( BaseDocument * doc )

static

Private.

◆ GetBaseMaterial()

BaseMaterial* GetBaseMaterial ( BaseDocument * doc )

Private.

◆ GetSelectionMaskState()

static void GetSelectionMaskState	(	Bool &	hasSelectionMask,
		Bool &	isEditMaskActive
	)

static

Private.

◆ GetMaterialChannelDisplay()

static void GetMaterialChannelDisplay	(	BaseDocument *	doc,
		Bool &	isSingleDisplayActive,
		Int32 &	materialChannel
	)

static

Private.

Detailed Description

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ PaintMaterial()

◆ ~PaintMaterial()

Member Function Documentation

◆ EnableMaterial()

◆ GetActivePaintMaterial()

◆ GetPaintMaterialFromTexture()

◆ GetAllPaintMaterialsFromTexture()

◆ GetPaintMaterial()

◆ UnloadPaintMaterial()

◆ SaveDocument()

◆ AskNeedToSave()

◆ GetBaseMaterial()

◆ GetSelectionMaskState()

◆ GetMaterialChannelDisplay()