ColorConvertActions Class Documentation

classColorConvertActions

Namespace:datalogics_interface

Detailed Description

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

Referenced by

ColorConvertParams

Constructor & Destructor Documentation

ColorConvertActions

ColorConvertActions()

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

~ColorConvertActions

~ColorConvertActions()

Member Function Documentation

get_colorant_name

std::stringget_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.

get_convert_intent

RenderIntentget_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.

get_convert_profile

ColorProfileget_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.

get_convert_profile_path

std::stringget_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.

get_embed_color_profile

boolget_embed_color_profile()

Returns:

bool

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

get_intent_to_match

RenderIntentget_intent_to_match()

Returns:

RenderIntent

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

get_is_ink_action

boolget_is_ink_action()

Returns:

bool

Marks this Action to be applied to inks.

get_must_match_all_attrs

ColorConvertObjAttrsget_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.

get_must_match_all_cs_attrs

ColorConvertSpaceTypeget_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.

get_must_match_any_attrs

ColorConvertObjAttrsget_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.

get_must_match_any_cs_attrs

ColorConvertSpaceTypeget_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.

get_preserve_black

boolget_preserve_black()

Returns:

bool

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

get_use_black_point_compensation

boolget_use_black_point_compensation()

Returns:

bool

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

set_colorant_name

voidset_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

set_convert_intent

voidset_convert_intent(RenderIntentintent)

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

set_convert_profile

voidset_convert_profile(ColorProfileprofile)

Parameters

profile: ColorProfile

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

Returns:

void

set_convert_profile_path

voidset_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

set_embed_color_profile

voidset_embed_color_profile(boolembed)

Parameters

embed: bool

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

Returns:

void

set_intent_to_match

voidset_intent_to_match(RenderIntentintent)

Parameters

intent: RenderIntent

the rendering intent to match; UseProfileIntent matches any intent.

Returns:

void

set_is_ink_action

voidset_is_ink_action(boolis_ink)

Parameters

is_ink: bool

true if this Action applies to inks, false otherwise.

Returns:

void

set_must_match_all_attrs

voidset_must_match_all_attrs(ColorConvertObjAttrsattrs)

Parameters

attrs: ColorConvertObjAttrs

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

Returns:

void

set_must_match_all_cs_attrs

voidset_must_match_all_cs_attrs(ColorConvertSpaceTypeattrs)

Parameters

attrs: ColorConvertSpaceType

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

Returns:

void

set_must_match_any_attrs

voidset_must_match_any_attrs(ColorConvertObjAttrsattrs)

Parameters

attrs: ColorConvertObjAttrs

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

Returns:

void

set_must_match_any_cs_attrs

voidset_must_match_any_cs_attrs(ColorConvertSpaceTypeattrs)

Parameters

attrs: ColorConvertSpaceType

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

Returns:

void

set_preserve_black

voidset_preserve_black(boolpreserve)

Parameters

preserve: bool

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

Returns:

void

set_use_black_point_compensation

voidset_use_black_point_compensation(booluse)

Parameters

use: bool

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

Returns:

void