c4d.BitmapButtonStruct

class c4d.BitmapButtonStruct

Bitmap button data type (CUSTOMDATATYPE_BITMAPBUTTON) for BitmapButtonCustomGui.

New in version R17.032.

Note

Used to get a bitmap button in the Attribute Manager.
Specify an object, BitmapButtonStruct.op, that provides an icon through the MSG_DESCRIPTION_GETBITMAP message.

Attributes

BitmapButtonStruct.op

[Read/Write]

The object to send MSG_DESCRIPTION_GETBITMAP to.

Type: BaseList2D

BitmapButtonStruct.id

[Read/Write]

The ID of the bitmap button.

Type: DescID

BitmapButtonStruct.dirty

[Read/Write]

The dirty flag. Internally used to detect changes. If this flag changes on parameter set, a new MSG_DESCRIPTION_GETBITMAP will be emitted.

Type: int

Methods Signatures

BitmapButtonStruct.__init__(self, op, id, dirty)

Constructor.

Inheritance

Parent Class:

Methods Documentation

BitmapButtonStruct.__init__(self, op, id, dirty)

Constructor.

Parameters
  • op (c4d.BaseList2D) – The object to send MSG_DESCRIPTION_GETBITMAP to.

  • id (c4d.DescID) – The ID of the bitmap button.

  • dirty (int) – The dirty flag. Internally used to detect changes. If this flag changes on parameter set, a new MSG_DESCRIPTION_GETBITMAP will be emitted.

Return type

c4d.BitmapButtonStruct

Returns

The new bitmap button data.