ColorConvertActions Class

class ColorConvertActions

Namespace:datalogics_interface

Detailed Description

Class that defines color conversion actions for an object described by certain attributes.

Referenced by

ColorConvertParams

Uses types

ColorConvertActionType ColorConvertObjAttrs ColorConvertSpaceType ColorProfile RenderIntent

Constructor & Destructor Documentation

ColorConvertActions()

Default constructor for the ColorConvertActions class. Sets default values to the members.

ColorConvertActions(ColorConvertActions && )

Parameters

: ColorConvertActions &&

ColorConvertActions(const ColorConvertActions & other)

Parameters

other: const ColorConvertActions &

Copy constructor.

~ColorConvertActions()

Member Function Documentation

ColorConvertActionType get_action()

Returns:

ColorConvertActionType

Gets / sets the action, specifying what to do when an object matches this Settings record.

std::string get_colorant_name()

Returns:

std::string

For ink actions (which describe a single colorant, whether used in Separation or DeviceN, and which are not matched using the above matching fields) this describes the colorant of the ink.

RenderIntent get_convert_intent()

Returns:

RenderIntent

Gets / sets the intent that overrides the object's original render intent when performing color conversion. UseProfileIntent means that the intent of the object must not be overridden.

ColorProfile get_convert_profile()

Returns:

ColorProfile

Gets / sets the target ColorProfile for the conversion. If the output intent is embedded, this should be the output intent profile.

std::string get_convert_profile_path()

Returns:

std::string

Gets / sets the target ColorProfile for the conversion using the profile found at the path provided. If the output intent is embedded, this should be the output intent profile. NOTE: If specifying a path, ConvertProfile must be set to Null_ColorProfile.

bool get_embed_color_profile()

Returns:

bool

If true, embed the target profile. If false, the resulting color is Device, if possible.

RenderIntent get_intent_to_match()

Returns:

RenderIntent

Gets / sets the rendering intent of the object. If this is UseProfileIntent this action applies to any intent.

bool get_is_ink_action()

Returns:

bool

Marks this Action to be applied to inks.

ColorConvertObjAttrs get_must_match_all_attrs()

Returns:

ColorConvertObjAttrs

A bit field that gets / sets the attributes an element must match to be color converted. The element must match ALL these attributes to be color converted.

ColorConvertSpaceType get_must_match_all_cs_attrs()

Returns:

ColorConvertSpaceType

A bit field that gets / sets the Color Space attributes an object must match to be color converted. The element must match ALL these Color Space attributes to be color converted.

ColorConvertObjAttrs get_must_match_any_attrs()

Returns:

ColorConvertObjAttrs

A bit field that gets / sets the attributes an element must match to be color converted. The element can match ONE OR MORE of these attributes to be color converted.

ColorConvertSpaceType get_must_match_any_cs_attrs()

Returns:

ColorConvertSpaceType

A bit field that gets / sets the Color Space attributes an object must match to be color converted. The element can match ONE OR MORE Color Space attributes to be color converted.

bool get_preserve_black()

Returns:

bool

If true, perform a black-preserving transform when converting.

bool get_use_black_point_compensation()

Returns:

bool

If true, turn on black point compensation for color conversions.

ColorConvertActions & operator=(ColorConvertActions && )

Parameters

: ColorConvertActions &&

Returns:

ColorConvertActions &

ColorConvertActions & operator=(const ColorConvertActions & other)

Parameters

other: const ColorConvertActions &

Returns:

ColorConvertActions &

Copy assignment.

void set_action(ColorConvertActionType action)

Parameters

action: ColorConvertActionType: the action to apply when an object matches this Settings record.

Returns:

void

void set_colorant_name(const std::string & name)

Parameters

name: const std::string &: the colorant name (used for ink actions that describe a single colorant).

Returns:

void

void set_convert_intent(RenderIntent intent)

Parameters

intent: RenderIntent: the render intent that overrides the object's original render intent during color conversion. UseProfileIntent leaves the original intent in place.

Returns:

void

void set_convert_profile(ColorProfile profile)

Parameters

profile: ColorProfile: the target ColorProfile for the conversion; if the output intent is embedded, this should be the output intent profile.

Returns:

void

void set_convert_profile_path(const std::string & path)

Parameters

path: const std::string &: the path to the target ColorProfile for the conversion. ConvertProfile must be set to Null_ColorProfile when using a path.

Returns:

void

void set_embed_color_profile(bool embed)

Parameters

embed: bool: true to embed the target profile; false to leave the resulting color as Device when possible.

Returns:

void

void set_intent_to_match(RenderIntent intent)

Parameters

intent: RenderIntent: the rendering intent to match; UseProfileIntent matches any intent.

Returns:

void

void set_is_ink_action(bool is_ink)

Parameters

is_ink: bool: true if this Action applies to inks, false otherwise.

Returns:

void

void set_must_match_all_attrs(ColorConvertObjAttrs attrs)

Parameters

attrs: ColorConvertObjAttrs: the bit field of attributes; an element must match ALL of these to be color converted.

Returns:

void

void set_must_match_all_cs_attrs(ColorConvertSpaceType attrs)

Parameters

attrs: ColorConvertSpaceType: the bit field of color-space attributes; an object must match ALL of these to be color converted.

Returns:

void

void set_must_match_any_attrs(ColorConvertObjAttrs attrs)

Parameters

attrs: ColorConvertObjAttrs: the bit field of attributes; an element matching ANY of these is color converted.

Returns:

void

void set_must_match_any_cs_attrs(ColorConvertSpaceType attrs)

Parameters

attrs: ColorConvertSpaceType: the bit field of color-space attributes; an object matching ANY of these is color converted.

Returns:

void

void set_preserve_black(bool preserve)

Parameters

preserve: bool: true to perform a black-preserving transform when converting, false otherwise.

Returns:

void

void set_use_black_point_compensation(bool use)

Parameters

use: bool: true to enable black point compensation for color conversions, false otherwise.

Returns:

void