PaintTexture Class Reference

#include <c4d_painter.h>

Inheritance diagram for PaintTexture:

Detailed Description

A class for paint textures, can contain layers and may represent the channel of a material.

Public Member Functions

PaintLayerGetFirstLayer ()
PaintLayerGetLastLayer ()
PaintLayerBmpAddLayerBmp (PaintLayer *insertafter, PaintLayer *layerset=nullptr, COLORMODE mode=COLORMODE::ARGB, Bool useundo=true, Bool activate=true)
PaintLayerFolderAddLayerFolder (PaintLayer *insertafter, PaintLayer *insertunder, Bool useundo=true, Bool activate=true)
void SetActiveLayer (PaintLayer *layer, Bool activatetexture, Bool show=true)
PaintLayerGetActive ()
void GetLinkLayers (AtomArray &layers, Bool addfolders)
void SetColorMode (COLORMODE newcolormode, Bool doundo)
const Filename GetFilename ()
BaseBitmapGetVisibleBitmap (Bool recalc=true)
BaseBitmapGetSelectionMaskTexture (UInt64 width, UInt64 height, Int32 &dirtyCount)
Int32 GetLayerCount () const
Int32 GetAlphaCount () const
Bool SetColorProfile (const ColorProfile &profile)
const ColorProfileGetColorProfile () const
- 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
const CharGetViewportRenderId (VIEWPORT_RENDER_ID typeId) const
BaseList2DGetNext ()
BaseList2DGetPred ()
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 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::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 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 ()
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 PaintTextureGetTexture (const String &name, const Filename &filename, Bool create)
static Bool GetProjectionPaintTextures (const ViewWindow *viewWindow, PaintTexture *&paintTexture)
static GeListHeadGetPaintTextureHead ()
static PaintTextureCreateNewTexture (const Filename &path, const BaseContainer &settings)
static Bool GetTextureDefaults (Int32 channel, BaseContainer &settings)
static PaintTextureGetPaintTextureOfBaseChannel (BaseDocument *doc, BaseChannel *bc)
static Bool SetSelected_Texture (PaintBitmap *bmp, PaintMaterial *preferred)
static PaintTextureGetSelectedTexture ()
static PaintTextureGetSelectedTexturePP (PaintMaterial **ppmat=nullptr)
- 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

 PaintTexture ()
 ~PaintTexture ()

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ PaintTexture()

PaintTexture ( )

◆ ~PaintTexture()

~PaintTexture ( )

Member Function Documentation

◆ GetFirstLayer()

PaintLayer* GetFirstLayer ( )

Retrieves the first layer of the paint texture.

The first layer of the paint texture, or nullptr if there is none.

◆ GetLastLayer()

PaintLayer* GetLastLayer ( )

Retrieves the last layer of the paint texture.

The last layer of the paint texture, or nullptr if there is none.

◆ AddLayerBmp()

PaintLayerBmp* AddLayerBmp ( PaintLayer insertafter,
PaintLayer layerset = nullptr,
Bool  useundo = true,
Bool  activate = true 

Adds a bitmap layer.

[in]insertafterThe layer insertion point.
[in]layersetThe parent layer folder.
[in]modeThe color mode (should be the same as the paint texture): COLORMODE
[in]useundotrue to create an undo on the undo stack, otherwise false.
[in]activatetrue to select the layer.
The added bitmap layer, or nullptr if bitmap layer creation failed.

◆ AddLayerFolder()

PaintLayerFolder* AddLayerFolder ( PaintLayer insertafter,
PaintLayer insertunder,
Bool  useundo = true,
Bool  activate = true 

Adds a layer folder.

[in]insertafterThe layer insertion point.
[in]insertunderThe parent layer folder.
[in]useundotrue to create an undo on the undo stack, otherwise false.
[in]activatetrue to select the layer.
The added layer folder, or nullptr if layer folder creation failed.

◆ SetActiveLayer()

void SetActiveLayer ( PaintLayer layer,
Bool  activatetexture,
Bool  show = true 

Selects a layer.

[in]layerThe layer to select.
[in]activatetexturetrue to select the layer, otherwise false.
[in]showtrue to show the layer, otherwise false.

◆ GetActive()

PaintLayer* GetActive ( )

Retrieves the selected layer.

The selected layer, or nullptr if there is none.

◆ GetLinkLayers()

void GetLinkLayers ( AtomArray layers,
Bool  addfolders 

Retrieves the linked layers.

[in]layersThe array containing the linked layers.
[in]addfoldersIf true the layer hierarchy is taken into account (see layer folders), otherwise false.

◆ SetColorMode()

void SetColorMode ( COLORMODE  newcolormode,
Bool  doundo 

Changes the color mode of the paint texture.

[in]newcolormodeThe new color mode: COLORMODE
[in]doundotrue to create an undo for changing the color mode, otherwise false.

◆ GetFilename()

const Filename GetFilename ( )

Retrieves the filename of the paint texture.

The filename.

◆ GetTexture()

static PaintTexture* GetTexture ( const String name,
const Filename filename,
Bool  create 


◆ GetVisibleBitmap()

BaseBitmap* GetVisibleBitmap ( Bool  recalc = true)


◆ GetSelectionMaskTexture()

BaseBitmap* GetSelectionMaskTexture ( UInt64  width,
UInt64  height,
Int32 dirtyCount 


◆ GetProjectionPaintTextures()

static Bool GetProjectionPaintTextures ( const ViewWindow *  viewWindow,
PaintTexture *&  paintTexture 


◆ GetLayerCount()

Int32 GetLayerCount ( ) const

Retrieves the number of layers of the paint texture.

The number of layers.

◆ GetAlphaCount()

Int32 GetAlphaCount ( ) const

Retrieves the number of alpha channels of the paint texture.

The number of alpha channels.

◆ GetPaintTextureHead()

static GeListHead* GetPaintTextureHead ( )

Retrieves the head of the paint texture list. Use this to browse through the available paint textures.

The head of the paint texture list.

◆ CreateNewTexture()

static PaintTexture* CreateNewTexture ( const Filename path,
const BaseContainer settings 

Creates a new paint texture.

[in]pathThe filename for the paint texture.
[in]settingsThe settings for the texture creation: TEXTURE
The created paint texture if successful, otherwise nullptr.

◆ GetTextureDefaults()

static Bool GetTextureDefaults ( Int32  channel,
BaseContainer settings 

Retrieves the default settings of textures for the passed material channel ID.

[in]channelThe material channel ID: CHANNEL
[out]settingsFilled with the default texture settings of the passed material channel.
true if successful, otherwise false.

◆ GetPaintTextureOfBaseChannel()

static PaintTexture* GetPaintTextureOfBaseChannel ( BaseDocument doc,
BaseChannel bc 

Retrieves the paint texture of a material's channel.

[in]docThe document the material is attached to.
[in]bcThe channel queried for the paint texture.
The paint texture if successful, otherwise nullptr.

◆ SetSelected_Texture()

static Bool SetSelected_Texture ( PaintBitmap bmp,
PaintMaterial preferred 

Selects a paint texture.

[in]bmpThe paint texture to select.
[in]preferredThe preferred paint material, usually nullptr.
true if successful, otherwise false.

◆ GetSelectedTexture()

static PaintTexture* GetSelectedTexture ( )

Retrieves the selected paint texture.

The selected paint texture, or nullptr if no paint is selected.

◆ GetSelectedTexturePP()

static PaintTexture* GetSelectedTexturePP ( PaintMaterial **  ppmat = nullptr)

Retrieves the selected projection painting texture.

[out]ppmatFilled with the preferred paint material, usually nullptr.
The selected projection painting texture, or nullptr if not available.

◆ SetColorProfile()

Bool SetColorProfile ( const ColorProfile profile)

Sets the color profile for the paint texture.

[in]profileThe color profile to set.
true if successful, otherwise false.

◆ GetColorProfile()

const ColorProfile& GetColorProfile ( ) const

Gets the color profile for the paint texture.

The color profile.