comet.CSwatch

class comet.CSwatch

Methods

CSwatch.getDocument()

Returns the document this swatch belongs to.

Returns

The owning document

Return type

CDocument

Available

CSwatch.getName()

Get the swatch name.

The name is not translated and uses the internal host application name.

Returns

The swatch name

Return type

str

Available

CSwatch.getModel()

Get the color model of this swatch if it is a basic color.

Returns

The color model.

One of Color models.

Returns comet.kColorModelUnknown when the color is not a basic color.

Return type

int

Available

CScript

color::get_space

CSwatch.getSpace()

Get the swatch definition space.

Returns

The swatch definition space.

One of Swatch spaces

Return type

int

Available

CScript

color::get_space

CSwatch.getType()

Get the type of this swatch.

Returns

The swatch type.

One of Swatch types

Return type

int

Available

CScript

color::get_type

CSwatch.getTint()

Get the tint of this swatch.

Returns

The swatch tint

Return type

float

Available

CScript

color::get_tint

CSwatch.isSpot()

Get whether this swatch is a spot color.

Returns

Whether the swatch is a spot color

Return type

bool

Available

CScript

color::is_spot

CSwatch.isLocked()

Get whether this swatch is locked.

Returns

Whether the swatch is locked

Return type

bool

Available

CScript

color::is_locked

CSwatch.isReserved()

Get whether this swatch is reserved by the host application.

Returns

Whether the swatch is reserved

Return type

bool

Available

CScript

color::is_reserved

CSwatch.getColor()

Get the color of the swatch.

Returns

The swatch color.

The return type depends on the swatch color model obtained by getModel():

• comet.kColorModelUnknown:

  None

• Else:

  CColor

Return type

CColor | None

Available

CScript

color::get_colors

CSwatch.getColors()

Get the color values of the swatch.

Returns

The color values.

The return type depends on the swatch color model:

• comet.kColorModelGray:

  Gray value

  float in range[0.0, 1.0]

• comet.kColorModelRGB:

  tuple [int, int, int]

  Red, green, blue values in range[0, 255]

• comet.kColorModelCMYK:

  tuple [float, float, float, float]

  C, M, Y, K values in range[0.0, 1.0]

• comet.kColorModelLAB:

  tuple [float, int, int]

  L, A, B values in range: L[0.0, 100.0], A[-127, 128], B[-127, 128]

• comet.kColorModelUnknown:

  None

Return type

tuple[int, int, int] | tuple[float, float, float, float] | tuple[float, int, int] | None

Available

CScript

color::get_colors

CSwatch.redefine(color, type=1)

Change the definition of this swatch.

Type must be comet.kSwatchTypeBaseColor . Please take care not to change reserved swatches. This may cause serious errors!

Parameters

• color –

  The color values and target color space.

  The parameter type can be:

  • CColor

    A color.

  • tuple [int, int, int]

    Red, Green, Blue values in range[0, 255]

  • tuple [float, float, float, float]

    C, M, Y, K values in range[0.0, 1.0]

  • tuple [float, int, int]

    L, A, B values in range: L[0.0, 100.0], A[-127, 128], B[-127, 128]

  When the swatch is a process color, all values always get converted into the document color space.

  LAB colors are only supported for global swatches.

• type (int) –

  The color type

  • 0: Spot

  • 1: Process

  Ignored.

Return type

None

Raises

• TypeError – When parameter types are invalid

• ValueError –

  • When parameter colors contains invalid values for the required space

  • When parameter type has invalid value

• CometError – On internal error

Available

CScript

color::redefine_swatch

CSwatch.remove()

Deletes this swatch from its document. All subsequent calls to this swatches functions will fail.

Returns

None

Raises

CometError – On internal error

Available