c4d.CustomIconSettings¶

class c4d.CustomIconSettings¶: Represents the data passed in the MSG_GETCUSTOMICON_SETTINGS.

New in version R21.

Attributes

c4d.CustomIconSettings._iconFileId¶

Custom bitmap file path or icon ID.

Type: str

c4d.CustomIconSettings._colorMode¶

Color mode: 0: None, 1: custom, 2: special cases.

Type: int

c4d.CustomIconSettings._customColor¶

Custom color used if _colorMode == 1.

Type: maxon.Color

c4d.CustomIconSettings._specialColors¶

Special colors (e.g. Light Color for light object).

Type: maxon.BaseArray (maxon.Color)

c4d.CustomIconSettings._defaultIconId¶

Icon ID used if no custom bitmap path / icon ID.

Type: int

c4d.CustomIconSettings._customIcon¶

Custom icon used as default (more priority than _defaultIconId).

Type: c4d.IconData

c4d.CustomIconSettings._fillDefault¶

If True, CustomIconData will be filled always. Set to True only if you provide a _customIcon c4d.IconData or and icon ID different than default, otherwise just leave it False.

Type: bool

c4d.CustomIconSettings._colorizeContrastMode¶

If True, icon bitmap will be inverted with dark colors for better readability.

Type: bool

c4d.CustomIconSettings._colorizeContrastModeMaxBrightnessThreshold¶

Brightness values greater than this value will be considered as full brightness (1.0)

Type: float

Overview¶

`CustomIconSettings.FillCustomIconSettingsFromBaseList2D()`	Fills the passed `c4d.CustomIconSettings` settings with the data from a BaseList2D BaseContainer.
`CustomIconSettings.GetCustomIcon()`	Fill the dictionary cid with the passed CustomIconSettings

Members¶

Icon Settings¶

static CustomIconSettings.FillCustomIconSettingsFromBaseList2D(settings, data, defaultIconId, bcFillDefault)¶

Fills the passed c4d.CustomIconSettings settings with the data from a BaseList2D BaseContainer.

Note

This is mostly used in plugin development. See py-custom-icon example in github.

Parameters

settings (c4d.CustomIconSettings) – The Custom Icon Settings to fill.
data (c4d.BaseContainer) – The BaseContainer of a BaseList2D (retrieved with BaseList2D.GetData()).
defaultIconId (int) – The default IconId the CustomIconSettings should use (usually node.GetType()).
bcFillDefault (bool) – True if default should be filled

static CustomIconSettings.GetCustomIcon(cid, settings, drawBeforeColoring=False)¶

Fill the dictionary cid with the passed CustomIconSettings

Note

This is mostly used in plugin development. See py-custom-icon example in github.

Parameters

cid (dict) – A dictionary with the structure of MSG_GETCUSTOMICON.
settings (c4d.CustomIconSettings) – The Custom Icon Settings to fill cid with.
drawBeforeColoring (bool) – True if the icon should be drawn before color change.

Category	Option	Description
Query	Words and phrases	Search is case-insensitive. Put a phrase in quotes for an exact match. Quoted phrases require every word and disable fuzzy matching.
Terms	OR / AND	Choose whether to match any term or require all terms.
Fuzzy	On / Off	Toggle approximate and prefix matches. Quoted phrases always use strict matching.
Results	Sparse / Dense	Sparse groups multiple hits for one entity and hides its owned API members when the class or module itself matches. Dense lists each match separately.
Sort by	Type / Relevance	Group results by entity type then rank within each group, or rank all results by relevance.
Content	All / API / Manuals / Examples / Resources	Search all documentation, API documentation, manuals, the examples index, or the resources index. Code examples embedded in other sections retain their own content area.
Entity	All / Page / Module / Class / Function / Attribute / Description / Node / Symbol / Icon	Page covers results without a specific entity type. Resource entity types are available with All or Resources; API entity types are available with All or API.
Location	All / Text / Code / Name / Signature	Text covers everything outside code, names, and signatures. Name and Signature are available with All or API.