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 ()
 
const PaintLayerGetFirstLayer () const
 
PaintLayerGetLastLayer ()
 
const PaintLayerGetLastLayer () const
 
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 () const
 
BaseBitmapGetVisibleBitmap (Bool recalc=true)
 
BaseBitmapGetSelectionMaskTexture (UInt64 width, UInt64 height, Int32 &dirtyCount)
 
Int32 GetLayerCount () const
 
Int32 GetAlphaCount () const
 
Bool SetColorProfile (const ColorProfile &profile, Int32 index=COLORPROFILE_INDEX_IMAGE)
 
const ColorProfileGetColorProfile (Int32 index=COLORPROFILE_INDEX_IMAGE) const
 
- 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
 
const BaseList2DGetMain () const
 
BaseList2DGetMain ()
 
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
 
const CTrackGetFirstCTrack () const
 
CTrackGetFirstCTrack ()
 
const CTrackFindCTrack (const DescID &id) const
 
CTrackFindCTrack (const DescID &id)
 
- 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 C4DAtomGoal
Bool HasLinks () const
 
- 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 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)
 

Static Public Attributes

static constexpr Int32 COLORPROFILE_INDEX_IMAGE
 
static constexpr Int32 COLORPROFILE_INDEX_RENDERSPACE
 
static constexpr Int32 COLORPROFILE_INDEX_VIEW_TRANSFORM
 
static constexpr Int32 COLORPROFILE_INDEX_DISPLAYSPACE
 
- Static Public Attributes inherited from BaseList2D
static const Int32 SETBIT_FLAG_NODIRTY
 
static const Int32 SETBIT_FLAG_REMOVE
 

Private Member Functions

 PaintTexture ()
 
 ~PaintTexture ()
 

Constructor & Destructor Documentation

◆ PaintTexture()

PaintTexture ( )
private

◆ ~PaintTexture()

~PaintTexture ( )
private

Member Function Documentation

◆ GetFirstLayer() [1/2]

PaintLayer* GetFirstLayer ( )

Retrieves the first layer of the paint texture.

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

◆ GetFirstLayer() [2/2]

const PaintLayer* GetFirstLayer ( ) const

◆ GetLastLayer() [1/2]

PaintLayer* GetLastLayer ( )

Retrieves the last layer of the paint texture.

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

◆ GetLastLayer() [2/2]

const PaintLayer* GetLastLayer ( ) const

◆ AddLayerBmp()

PaintLayerBmp* AddLayerBmp ( PaintLayer insertafter,
PaintLayer layerset = nullptr,
COLORMODE  mode = COLORMODE::ARGB,
Bool  useundo = true,
Bool  activate = true 
)

Adds a bitmap layer.

Parameters
[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.
Returns
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.

Parameters
[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.
Returns
The added layer folder, or nullptr if layer folder creation failed.

◆ SetActiveLayer()

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

Selects a layer.

Parameters
[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.

Returns
The selected layer, or nullptr if there is none.

◆ GetLinkLayers()

void GetLinkLayers ( AtomArray layers,
Bool  addfolders 
)

Retrieves the linked layers.

Parameters
[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.

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

◆ GetFilename()

const Filename GetFilename ( ) const

Retrieves the filename of the paint texture.

Returns
The filename.

◆ GetTexture()

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

Private.

◆ GetVisibleBitmap()

BaseBitmap* GetVisibleBitmap ( Bool  recalc = true)

Private.

◆ GetSelectionMaskTexture()

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

Private.

◆ GetProjectionPaintTextures()

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

Private.

◆ GetLayerCount()

Int32 GetLayerCount ( ) const

Retrieves the number of layers of the paint texture.

Returns
The number of layers.

◆ GetAlphaCount()

Int32 GetAlphaCount ( ) const

Retrieves the number of alpha channels of the paint texture.

Returns
The number of alpha channels.

◆ GetPaintTextureHead()

static GeListHead* GetPaintTextureHead ( )
static

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

Returns
The head of the paint texture list.

◆ CreateNewTexture()

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

Creates a new paint texture.

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

◆ GetTextureDefaults()

static Bool GetTextureDefaults ( Int32  channel,
BaseContainer settings 
)
static

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

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

◆ GetPaintTextureOfBaseChannel()

static PaintTexture* GetPaintTextureOfBaseChannel ( BaseDocument doc,
BaseChannel bc 
)
static

Retrieves the paint texture of a material's channel.

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

◆ SetSelected_Texture()

static Bool SetSelected_Texture ( PaintBitmap bmp,
PaintMaterial preferred 
)
static

Selects a paint texture.

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

◆ GetSelectedTexture()

static PaintTexture* GetSelectedTexture ( )
static

Retrieves the selected paint texture.

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

◆ GetSelectedTexturePP()

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

Retrieves the selected projection painting texture.

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

◆ SetColorProfile()

Bool SetColorProfile ( const ColorProfile profile,
Int32  index = COLORPROFILE_INDEX_IMAGE 
)

Sets the color profile for the paint texture.

Since
R17.032
Parameters
[in]profileThe color profile to set.
[in]indexIndex of the colorprofile to set (COLORPROFILE_INDEX_*).
Returns
true if successful, otherwise false.

◆ GetColorProfile()

const ColorProfile& GetColorProfile ( Int32  index = COLORPROFILE_INDEX_IMAGE) const

Gets the color profile for the paint texture.

Since
R17.032
Parameters
[in]indexIndex of the colorprofile to retrieve (COLORPROFILE_INDEX_*).
Returns
The color profile.

Member Data Documentation

◆ COLORPROFILE_INDEX_IMAGE

constexpr Int32 COLORPROFILE_INDEX_IMAGE
staticconstexpr

Index of the image color profile.

◆ COLORPROFILE_INDEX_RENDERSPACE

constexpr Int32 COLORPROFILE_INDEX_RENDERSPACE
staticconstexpr

Index of the renderspace color profile.

◆ COLORPROFILE_INDEX_VIEW_TRANSFORM

constexpr Int32 COLORPROFILE_INDEX_VIEW_TRANSFORM
staticconstexpr

Index of the view transform.

◆ COLORPROFILE_INDEX_DISPLAYSPACE

constexpr Int32 COLORPROFILE_INDEX_DISPLAYSPACE
staticconstexpr

Index of the displayspace color profile.