Ink Class Documentation

class Ink

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::string get_alias()

Returns:

std::string

An alternate name (alias) for this colorant.

get_angle

double get_angle()

Returns:

double

The halftone screen angle for this ink, in degrees.

get_black

double get_black()

Returns:

double

The black component of the CMYK color swatch.

get_blue

int get_blue()

Returns:

int

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

get_colorant_name

std::string get_colorant_name()

Returns:

std::string

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

get_cyan

double get_cyan()

Returns:

double

The cyan component of the CMYK color swatch.

get_density

double get_density()

Returns:

double

The neutral density of this ink.

get_frequency

double get_frequency()

Returns:

double

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

get_green

int get_green()

Returns:

int

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

get_ink_type

InkType get_ink_type()

Returns:

InkType

The ink type of this ink, used for trapping.

get_is_process_color

bool get_is_process_color()

Returns:

bool

Whether this ink represents a process color or a spot color.

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

get_magenta

double get_magenta()

Returns:

double

The magenta component of the CMYK color swatch.

get_red

int get_red()

Returns:

int

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

get_yellow

double get_yellow()

Returns:

double

The yellow component of the CMYK color swatch.

set_alias

void set_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

void set_angle(double angle)

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

void set_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

void set_density(double density)

Parameters

density: double

the neutral density of this ink

Returns:

void

The neutral density of this ink.

set_frequency

void set_frequency(double frequency)

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

void set_ink_type(InkType type)

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

void set_is_process_color(bool value)

Parameters

value: bool

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

Returns:

void

Whether this ink represents a process color or a spot color.

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

set_preview_option

void set_preview_option(SeparationPreviewOption option)

Parameters

option: SeparationPreviewOption

the how the colorant is handled during a separation preview

Returns:

void

How the colorant is handled during a separation preview.