就业培训     下载中心     Wiki     联络 登录   注册
  1. 首页
  2. C4D R23.110 C++ SDK
公共成员函数 | 静态公共成员函数 | 私有成员函数 | 所有成员列表

PaintMaterial Class Reference

#include <c4d_painter.h>

Inheritance diagram for PaintMaterial:
Inheritance graph
[ legend ]

详细描述

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

公共成员函数

void  EnableMaterial ( BaseDocument *doc, Bool on, Bool suppressevent=false, Bool domaterialundo=true)
BaseMaterial *  GetBaseMaterial ( BaseDocument *doc)
-  Public Member Functions inherited from PaintBitmap
Int32   GetBw ()
Int32   GetBh ()
PaintTexture *  GetPaintTexture ()
PaintBitmap *  GetParent ()
PaintLayer *  GetLayerDownFirst ()
PaintLayer *  GetLayerDownLast ()
PaintLayer *  GetAlphaFirst ()
PaintLayer *  GetAlphaLast ()
PaintLayerBmp *  AddAlphaChannel ( Int32 bitdepth, PaintLayer *prev=nullptr, Bool undo=true, Bool activate=true)
Bool   AskApplyAlphaMask ()
void  ApplyAlphaMask ( Int32 x, Int32 y, Int32 cnt, PIX *bits, COLORMODE 模式， Bool inverted, Int32 flags)
PaintLayerMask *  FindSelectionMask ( 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
const Char *  GetViewportRenderId ( VIEWPORT_RENDER_ID typeId) const
BaseList2D *  GetNext ()
BaseList2D *  GetPred ()
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)
BaseContainer   GetData ()
void  SetData (const BaseContainer &bc, Bool add=true)
const BaseContainer *  GetDataInstance () const
BaseContainer *  GetDataInstance ()
const BaseContainer &  GetDataInstanceRef () const
BaseContainer &  GetDataInstanceRef ()
String   GetName () const
void  SetName (const maxon::String &name)
String   GetBubbleHelp ()
Bool   TransferGoal ( BaseList2D *dst, Bool undolink)
Bool   TransferMarker ( BaseList2D *dst) const
Bool   比例 ( Float scale)
Bool   编辑 ()
void  GetIcon ( IconData *dat)
GeListHead *  GetNLARoot ()
BaseList2D *  AnimationLayerRemap ( BaseObject **layer=nullptr)
String   GetTypeName ()
BaseList2D *  GetMain () 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
GeListHead *  GetOverrideRoot ()
BaseOverride *  GetFirstOverride ()
GeListHead *  GetShaderRepositoryRoot ()
GeListHead *  GetHiddenShaderRoot ()
maxon::NimbusInterface *  GetNimbusRef (const maxon::Id &spaceId) const
maxon::Result < maxon::NimbusInterface * >  GetOrCreateNimbusRef (const maxon::Id &spaceId)
void  RemoveNimbusRef (const maxon::Id &spaceId)
maxon::Result < maxon::HashMap < maxon::Id , maxon::ForwardRef < maxon::NimbusRef > > >  GetAllNimbusRefs () const
Bool   IsNodeBased () const
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 ( 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)
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 ( BaseDocument *doc)
Bool   SetLayerObject ( LayerObject *layer)
const LayerData *  GetLayerData ( BaseDocument *doc, Bool rawdata=false)
Bool   SetLayerData ( BaseDocument *doc, const LayerData &data)
GeListHead *  GetCTrackRoot ()
CTrack *  GetFirstCTrack ()
CTrack *  FindCTrack (const DescID &id)
-  Public Member Functions inherited from GeListNode
GeListNode *  GetNext ()
GeListNode *  GetPred ()
GeListNode *  GetDown ()
GeListNode *  GetUp ()
GeListNode *  GetDownLast ()
void  InsertBefore ( GeListNode *bl)
void  InsertAfter ( GeListNode *bl)
void  InsertUnder ( GeListNode *bl)
void  InsertUnderLast ( GeListNode *bl)
void  移除 ()
GeListHead *  GetListHead ()
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 ()
BaseDocument *  GetDocument ()
Int32   GetBranchInfo ( BranchInfo *info, Int32 max, GETBRANCHINFO flags)
Bool   IsDocumentRelated ()
Int32   GetInfo ()
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   消息 ( Int32 type, void *data=nullptr)
Bool   MultiMessage ( MULTIMSG_ROUTE flags, Int32 type, void *data)
C4DAtom *  GetClone ( COPYFLAGS flags, AliasTrans *trn)
Bool   CopyTo ( C4DAtom *dst, COPYFLAGS flags, AliasTrans *trn)
Bool   读取 ( HyperFile *hf, Int32 id, Int32 level)
Bool   Write ( HyperFile *hf)
Bool   ReadObject ( HyperFile *hf, Bool readheader)
Bool   WriteObject ( HyperFile *hf)
Bool   GetDescription ( 描述 *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)
DynamicDescription *  GetDynamicDescription ()
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 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)

私有成员函数

  PaintMaterial ()
  ~PaintMaterial ()

Additional Inherited Members

-  Static Public Attributes inherited from BaseList2D
static const Int32   SETBIT_FLAG_NODIRTY
static const Int32   SETBIT_FLAG_REMOVE

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

◆  PaintMaterial()

PaintMaterial () private

◆  ~PaintMaterial()

~ PaintMaterial () private

成员函数文档编制

◆  EnableMaterial()

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

Enables a material for painting.

参数
[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 若 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.

参数
[in] doc Pass the document to look for active paint materials.
[out] mat Filled 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  
)
static

Retrieves a paint material from a paint texture.

参数
[in] tex The paint texture to retrieve the paint material from.
[in] onlyeditable true 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  
)
static

Retrieves all paint materials from a paint texture.

参数
[in] tex The paint texture to retrieve the paint material from.
[out] materials An AtomArray that receives all paint materials.
返回
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.

参数
[in] doc The document of the material.
[in] material The material to evaluate.
[in] create true to force a paint material.
返回
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).

参数
[in] doc The document of the material.
[in] material The material to unload.
[in] forcesave true to force save all the textures.
返回
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 .