Ink Class Documentation

classInk

Namespace:datalogics_interface

Detailed Description

The ink object represents the color in the color space, CYMK or RGB.

Referenced by

Page

Constructor & Destructor Documentation

~Ink

~Ink()

Member Function Documentation

get_alias

std::stringget_alias()

Returns:

std::string

An alternate name (alias) for this colorant.

get_angle

doubleget_angle()

Returns:

double

The halftone screen angle for this ink, in degrees.

get_black

doubleget_black()

Returns:

double

The black component of the CMYK color swatch.

get_blue

intget_blue()

Returns:

int

The blue component of the RGB color swatch for on-screen display.

get_colorant_name

std::stringget_colorant_name()

Returns:

std::string

The name of the colorant from the Separation or DeviceN color space, or the process color name.

get_cyan

doubleget_cyan()

Returns:

double

The cyan component of the CMYK color swatch.

get_density

doubleget_density()

Returns:

double

The neutral density of this ink.

get_frequency

doubleget_frequency()

Returns:

double

The halftone screen frequency for this ink, in lines per inch.

get_green

intget_green()

Returns:

int

The green component of the RGB color swatch for on-screen display.

get_ink_type

InkTypeget_ink_type()

Returns:

InkType

The ink type of this ink, used for trapping.

get_is_process_color

boolget_is_process_color()

Returns:

bool

True if this is a process color, false if this is a spot color.

get_magenta

doubleget_magenta()

Returns:

double

The magenta component of the CMYK color swatch.

get_red

intget_red()

Returns:

int

The red component of the RGB color swatch for on-screen display.

get_yellow

doubleget_yellow()

Returns:

double

The yellow component of the CMYK color swatch.

set_alias

voidset_alias(const std::string &alias)

Parameters

alias: const std::string &

an alternate name (alias) for this colorant

Returns:

void

An alternate name (alias) for this colorant.

set_angle

voidset_angle(doubleangle)

Parameters

angle: double

the halftone screen angle for this ink, in degrees

Returns:

void

The halftone screen angle for this ink, in degrees.

set_colorant_name

voidset_colorant_name(const std::string &name)

Parameters

name: const std::string &

the name of the colorant from the Separation or DeviceN color space, or the process color name

Returns:

void

The name of the colorant from the Separation or DeviceN color space, or the process color name.

set_density

voidset_density(doubledensity)

Parameters

density: double

the neutral density of this ink

Returns:

void

The neutral density of this ink.

set_frequency

voidset_frequency(doublefrequency)

Parameters

frequency: double

the halftone screen frequency for this ink, in lines per inch

Returns:

void

The halftone screen frequency for this ink, in lines per inch.

set_ink_type

voidset_ink_type(InkTypetype)

Parameters

type: InkType

the ink type of this ink, used for trapping

Returns:

void

The ink type of this ink, used for trapping.

set_is_process_color

voidset_is_process_color(boolvalue)

Parameters

value: bool

the whether this ink represents a process color or a spot color

Returns:

void

True if this is a process color, false if this is a spot color.

set_preview_option

voidset_preview_option(SeparationPreviewOptionoption)

Parameters

option: SeparationPreviewOption

the how the colorant is handled during a separation preview

Returns:

void

How the colorant is handled during a separation preview.