PaintMaterial Class Reference

#include <c4d_painter.h>

Inheritance diagram for PaintMaterial:

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)
BaseMaterialGetBaseMaterial (BaseDocument *doc)
- Public Member Functions inherited from PaintBitmap
Int32 GetBw ()
Int32 GetBh ()
PaintTextureGetPaintTexture ()
PaintBitmapGetParent ()
PaintLayerGetLayerDownFirst ()
PaintLayerGetLayerDownLast ()
PaintLayerGetAlphaFirst ()
PaintLayerGetAlphaLast ()
PaintLayerBmpAddAlphaChannel (Int32 bitdepth, PaintLayer *prev=nullptr, Bool undo=true, Bool activate=true)
Bool AskApplyAlphaMask ()
void ApplyAlphaMask (Int32 x, Int32 y, Int32 cnt, PIX *bits, COLORMODE mode, Bool inverted, Int32 flags)
PaintLayerMaskFindSelectionMask (PaintBitmap **toplevel, Int32 *bitdepth)
COLORMODE GetColorMode ()
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 CharGetViewportRenderId (VIEWPORT_RENDER_ID typeId) const
BaseList2DGetNext ()
BaseList2DGetPred ()
BaseContainer GetData ()
void SetData (const BaseContainer &bc, Bool add=true)
const BaseContainerGetDataInstance () const
BaseContainerGetDataInstance ()
const BaseContainerGetDataInstanceRef () const
BaseContainerGetDataInstanceRef ()
String GetName () const
void SetName (const maxon::String &name)
String GetBubbleHelp ()
Bool TransferGoal (BaseList2D *dst, Bool undolink)
Bool TransferMarker (BaseList2D *dst) const
Bool Scale (Float scale)
Bool Edit ()
void GetIcon (IconData *dat)
GeListHeadGetNLARoot ()
BaseList2DAnimationLayerRemap (BaseObject **layer=nullptr)
String GetTypeName ()
BaseList2DGetMain () const
void InsertTrackSorted (CTrack *track)
Bool AddEventNotification (BaseList2D *bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer *data)
Bool RemoveEventNotification (BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
Bool FindEventNotification (BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
Bool SetDescIDState (const DescID &id, DESCIDSTATE descidstate)
DESCIDSTATE GetDescIDState (const DescID &id, Bool tolerant) const
GeListHeadGetOverrideRoot ()
BaseOverrideGetFirstOverride ()
GeListHeadGetShaderRepositoryRoot ()
GeListHeadGetHiddenShaderRoot ()
maxon::NimbusForwardRef GetNimbusRef (const maxon::Id &spaceId) const
maxon::Result< maxon::NimbusForwardRefPrivateGetOrCreateNimbusRef (const maxon::Id &spaceId)
void RemoveNimbusRef (const maxon::Id &spaceId)
maxon::Result< maxon::HashMap< maxon::Id, maxon::NimbusForwardRef > > GetAllNimbusRefs () const
Bool IsNodeBased () const
void GetMarkerStampEx (UInt32 *l1, UInt32 *l2)
const GeMarkerGetMarker () 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 (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)
BaseShaderGetFirstShader () const
void InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
void ClearKeyframeSelection ()
Bool FindKeyframeSelection (const DescID &id)
Bool SetKeyframeSelection (const DescID &id, Bool selection)
Bool KeyframeSelectionContent ()
LayerObjectGetLayerObject (BaseDocument *doc)
Bool SetLayerObject (LayerObject *layer)
const LayerDataGetLayerData (BaseDocument *doc, Bool rawdata=false)
Bool SetLayerData (BaseDocument *doc, const LayerData &data)
GeListHeadGetCTrackRoot ()
CTrackGetFirstCTrack ()
CTrackFindCTrack (const DescID &id)
- Public Member Functions inherited from GeListNode
GeListNodeGetNext ()
GeListNodeGetPred ()
GeListNodeGetDown ()
GeListNodeGetUp ()
GeListNodeGetDownLast ()
void InsertBefore (GeListNode *bl)
void InsertAfter (GeListNode *bl)
void InsertUnder (GeListNode *bl)
void InsertUnderLast (GeListNode *bl)
void Remove ()
GeListHeadGetListHead ()
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)
GeListNodeGetCustomData ()
BaseDocumentGetDocument ()
Int32 GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)
Bool IsDocumentRelated ()
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)
C4DAtomGetClone (COPYFLAGS flags, AliasTrans *trn)
Bool CopyTo (C4DAtom *dst, COPYFLAGS flags, AliasTrans *trn)
Bool Read (HyperFile *hf, Int32 id, Int32 level)
Bool Write (HyperFile *hf)
Bool ReadObject (HyperFile *hf, Bool readheader)
Bool WriteObject (HyperFile *hf)
Bool GetDescription (Description *description, DESCFLAGS_DESC flags)
Bool GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags)
Bool SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)
DynamicDescriptionGetDynamicDescription ()
Bool GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc)
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 PaintMaterialGetActivePaintMaterial (BaseDocument *doc=nullptr, BaseMaterial **mat=nullptr)
static PaintMaterialGetPaintMaterialFromTexture (PaintTexture *tex, Bool onlyeditable)
static Bool GetAllPaintMaterialsFromTexture (PaintTexture *tex, AtomArray &materials)
static PaintMaterialGetPaintMaterial (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 BaseList2DAlloc (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 ( )

◆ ~PaintMaterial()

~PaintMaterial ( )

Member Function Documentation

◆ EnableMaterial()

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

Enables a material for painting.

[in]docThe document the material belongs to.
[in]ontrue to enable the material for painting, false to disable it.
[in]domaterialundoIf true an undo is created on the undo stack.

◆ GetActivePaintMaterial()

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

Retrieves the active paint material.

[in]docPass the document to look for active paint materials.
[out]matFilled with the material linked to the paint material.
The active paint material, or nullptr if there is none.

◆ GetPaintMaterialFromTexture()

static PaintMaterial* GetPaintMaterialFromTexture ( PaintTexture tex,
Bool  onlyeditable 

Retrieves a paint material from a paint texture.

[in]texThe paint texture to retrieve the paint material from.
[in]onlyeditabletrue to retrieve only editable paint materials.
The paint material of the texture, or nullptr if there is no paint material available.

◆ GetAllPaintMaterialsFromTexture()

static Bool GetAllPaintMaterialsFromTexture ( PaintTexture tex,
AtomArray materials 

Retrieves all paint materials from a paint texture.

[in]texThe paint texture to retrieve the paint material from.
[out]materialsAn AtomArray that receives all paint materials.
true, if at least one texture was found.

◆ GetPaintMaterial()

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

Retrieves the paint material of the material.

[in]docThe document of the material.
[in]materialThe material to evaluate.
[in]createtrue to force a paint material.
The paint material, or nullptr if there is none.

◆ UnloadPaintMaterial()

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

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

[in]docThe document of the material.
[in]materialThe material to unload.
[in]forcesavetrue to force save all the textures.
true if successful, otherwise false.

◆ SaveDocument()

static Bool SaveDocument ( BaseDocument doc,
Bool cancel 


◆ AskNeedToSave()

static Bool AskNeedToSave ( BaseDocument doc)


◆ GetBaseMaterial()

BaseMaterial* GetBaseMaterial ( BaseDocument doc)


◆ GetSelectionMaskState()

static void GetSelectionMaskState ( Bool hasSelectionMask,
Bool isEditMaskActive 


◆ GetMaterialChannelDisplay()

static void GetMaterialChannelDisplay ( BaseDocument doc,
Bool isSingleDisplayActive,
Int32 materialChannel