Open Search
    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 () const
     
    Int32 GetBh () const
     
    PaintTextureGetPaintTexture ()
     
    const PaintTextureGetPaintTexture () const
     
    PaintBitmapGetParent ()
     
    const PaintBitmapGetParent () const
     
    PaintLayerGetLayerDownFirst ()
     
    const PaintLayerGetLayerDownFirst () const
     
    PaintLayerGetLayerDownLast ()
     
    const PaintLayerGetLayerDownLast () const
     
    PaintLayerGetAlphaFirst ()
     
    const PaintLayerGetAlphaFirst () const
     
    PaintLayerGetAlphaLast ()
     
    const PaintLayerGetAlphaLast () const
     
    PaintLayerBmpAddAlphaChannel (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
     
    PaintLayerMaskFindSelectionMask (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 CharGetViewportRenderId (VIEWPORT_RENDER_ID typeId) const
     
    BaseList2DGetNext ()
     
    const BaseList2DGetNext () const
     
    BaseList2DGetPred ()
     
    const BaseList2DGetPred () const
     
    BaseContainer GetData ()
     
    void SetData (const BaseContainer &bc, Bool add=true)
     
    const BaseContainerGetDataInstanceRef () const
     
    BaseContainerGetDataInstanceRef ()
     
    const BaseContainerGetDataInstance () const
     
    BaseContainerGetDataInstance ()
     
    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)
     
    GeListHeadGetNLARoot (Bool create)
     
    BaseList2DAnimationLayerRemap (BaseObject **layer=nullptr)
     
    String GetTypeName () const
     
    BaseList2DGetMain () 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
     
    GeListHeadGetOverrideRoot (Bool create)
     
    BaseOverrideGetFirstOverride ()
     
    GeListHeadGetShaderRepositoryRoot (Bool create)
     
    GeListHeadGetHiddenShaderRoot (Bool create)
     
    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
     
    maxon::Result< BoolGetAccessedObjects (METHOD_ID method, AccessedObjectsCallback &access) const
     
    maxon::Result< BoolGetAccessedObjectsRec (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, Bool withSiblings, Bool withChildren, AccessedObjectsCallback &access) const
     
    maxon::Result< BoolGetAccessedObjectsOfHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const
     
    maxon::Result< BoolGetAccessedObjectsOfChildren (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const
     
    maxon::Result< BoolGetAccessedObjectsOfFirstChildHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const
     
    maxon::Result< maxon::GenericDataGroupChanges ()
     
    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 (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
     
    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 (const BaseDocument *doc)
     
    const LayerObjectGetLayerObject (const BaseDocument *doc) const
     
    Bool SetLayerObject (const LayerObject *layer)
     
    const LayerDataGetLayerData (const BaseDocument *doc, Bool rawdata=false) const
     
    Bool SetLayerData (BaseDocument *doc, const LayerData &data)
     
    GeListHeadGetCTrackRoot (Bool create)
     
    const GeListHeadGetCTrackRoot () const
     
    CTrackGetFirstCTrack ()
     
    const CTrackGetFirstCTrack () const
     
    CTrackFindCTrack (const DescID &id)
     
    const CTrackFindCTrack (const DescID &id) const
     
    - Public Member Functions inherited from GeListNode
    GeListNodeGetNext ()
     
    const GeListNodeGetNext () const
     
    GeListNodeGetPred ()
     
    const GeListNodeGetPred () const
     
    GeListNodeGetDown ()
     
    const GeListNodeGetDown () const
     
    GeListNodeGetUp ()
     
    const GeListNodeGetUp () const
     
    GeListNodeGetDownLast ()
     
    const GeListNodeGetDownLast () 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)
     
    GeListHeadGetListHead ()
     
    const GeListHeadGetListHead () 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)
     
    GeListNodeGetCustomData ()
     
    const GeListNodeGetCustomData () const
     
    const BaseDocumentGetDocument () const
     
    BaseDocumentGetDocument ()
     
    maxon::Result< BoolGetBranchInfo (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)
     
    C4DAtomGetClone (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)
     
    DynamicDescriptionGetDynamicDescriptionWritable ()
     
    const DynamicDescriptionGetDynamicDescription () 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 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 ( )
    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]docThe document the material belongs to.
    [in]ontrue to enable the material for painting, false to disable it.
    [in]suppresseventPrivate.
    [in]domaterialundoIf 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]docPass the document to look for active paint materials.
    [out]matFilled 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]texThe paint texture to retrieve the paint material from.
    [in]onlyeditabletrue 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]texThe paint texture to retrieve the paint material from.
    [out]materialsAn 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]docThe document of the material.
    [in]materialThe material to evaluate.
    [in]createtrue 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]docThe document of the material.
    [in]materialThe material to unload.
    [in]forcesavetrue 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.