c4d.gui.GradientCustomGui

class c4d.gui.GradientCustomGui

Gradient GUI(CUSTOMGUI_GRADIENT) for Gradient data type. These are the settings:

Symbol ID

Type

Description

Property in a res file

GRADIENTPROPERTY_ALPHA_WITH_COLOR

bool

If GRADIENTPROPERTY_ALPHA is set to True, this creates a Gradient with Color and Alpha.
It’s also shows controls to handle both gradients.
GRADIENT MYGRADIENT { COLOR; }

GRADIENTPROPERTY_ALPHA

bool

Creates an Alpha gradient.

GRADIENT MYGRADIENT { ALPHA; }

GRADIENTPROPERTY_NOEDITCOLOR

bool

No color editing.

GRADIENT MYGRADIENT { NOEDITCOLOR; }

GRADIENTPROPERTY_NOPRESETS

bool

No load/save preset buttons.

GRADIENT MYGRADIENT { NOPRESETS; }

GRADIENTPROPERTY_NOINTERPOLATION

bool

No Interpolation parameter.

GRADIENT MYGRADIENT { NOINTERPOLATION; }

GRADIENTPROPERTY_NOKNOTPOSITION

bool

No Knot Position parameter.

GRADIENT MYGRADIENT { NOKNOTPOSITION; }

GRADIENTPROPERTY_NOBIASPOSITION

bool

No Bias Position parameter.

GRADIENT MYGRADIENT { NOBIASPOSITION; }

GRADIENTPROPERTY_NOBRIGHTNESS

bool

No Brightness parameter.

GRADIENT MYGRADIENT { NOBRIGHTNESS; }

Note

These 2 options are allowed:

  • DR_COLORFIELD_ICC_BASEDOC: Use ICC profile of the current document.

  • DR_COLORFIELD_ICC_BPTEX: Use ICC profile of the current BodyPain3D texture.

This is what it looks like:

../../../../_images/gradientcustomgui_gradient.png

Methods Signatures

GradientCustomGui.SetGradient(self, data)

Sets the data.

GradientCustomGui.GetGradient(self)

Get the data.

Inheritance

Parent Class:

Methods Documentation

GradientCustomGui.SetGradient(self, data)

Sets the data.

Parameters

data (c4d.Gradient) – The new Gradient data.

Return type

bool

Returns

True if successful, otherwise False.

GradientCustomGui.GetGradient(self)

Get the data.

Return type

c4d.Gradient

Returns

The new gradient data object.