c4d.IconData¶

class c4d.IconData¶: Represents a single icon in a large bitmap array.

New in version R21.

Attributes

IconData.bmp¶

The bitmap. Can be None.

Type: Optional[c4d.bitmaps.BaseBitmap]

IconData.x¶

The X coordinate of the upper-left corner of the icon.

Type: int

IconData.y¶

The Y coordinate of the upper-left corner of the icon.

Type: int

IconData.w¶

The width of the icon.

Type: int

IconData.h¶

The height of the icon.

Type: int

IconData.flags¶

The flags

Type:

ICONDATAFLAGS_NONE

None.

ICONDATAFLAGS_APPLYCOLORPROFILE

Applies color profile.

ICONDATAFLAGS_DISABLED

Disabled icon.

Methods Signatures

IconData.__init__(self)

Initializes a new Vector.

`IconData.GetClonePart(self)`	Gets a copy of the bitmap’s part for the icon data.
`IconData.GetGuiScalePart(self)`	Gets a copy of the scaled bitmap’s part for the icon data with the size `IconData.GetGuiW()`/`IconData.GetGuiH()`.
`IconData.GetGuiW(self)`	Gets the GUI scaled width of the icon data.
`IconData.GetGuiH(self)`	Gets the GUI scaled height of the icon data.

Methods Documentation

IconData.__init__(self)¶: Initializes a new Vector.

IconData.GetClonePart(self)¶

Gets a copy of the bitmap’s part for the icon data.

Return type: c4d.bitmaps.BaseBitmap
Returns: The copy of the icon part.

IconData.GetGuiScalePart(self)¶

Gets a copy of the scaled bitmap’s part for the icon data with the size IconData.GetGuiW()/IconData.GetGuiH().

Return type: c4d.bitmaps.BaseBitmap
Returns: The copy of the scaled icon part.

IconData.GetGuiW(self)¶

Gets the GUI scaled width of the icon data.

Parameters: value (int) – The GUI scaled width.

IconData.GetGuiH(self)¶

Gets the GUI scaled height of the icon data.

Return type: int
Returns: The GUI scaled height.

ICONDATAFLAGS_NONE	None.
ICONDATAFLAGS_APPLYCOLORPROFILE	Applies color profile.
ICONDATAFLAGS_DISABLED	Disabled icon.