FlattenTransparencyParams Class Documentation

classFlattenTransparencyParams

Namespace:datalogics_interface

Detailed Description

Class that represents control parameters for flattening transparencies within a PDF file. PDF files can hold objects that are stacked, and that are partially or fully transparent. This means that these objects can blend in various ways with objects behind them. With a stacked set of transparent graphics or images in a PDF file, each one contributing to the final result that appears on the page. One or more graphics images presented together in a stack is referred to as a transparency group. With a stack of transparent images, the final colors shown are the result of blending the colors of all of the overlapping objects. Flatten Transparency merges a stack of transparent objects or graphics into a single image on the PDF page.

Flattening images in a PDF file is generally necessary before you can send the document to a printer. The flattening process simplifies the PDF file and may make it smaller as well.

Constructor & Destructor Documentation

FlattenTransparencyParams

FlattenTransparencyParams()

Set up default parameters for flattening transparency.

Defaults: UseTextOutlines = false, ConvertStrokesToOutlines = true, ClipComplexRegions = false, InternalDPI = 800, ExternalDPI = 200, PreserveOverprint = true, Quality = 100.

FlattenTransparencyParams

FlattenTransparencyParams(booluse_text_outlines, boolconvert_strokes_to_outlines, boolclip_complex_regions, intinternal_dpi, intexternal_dpi, boolpreserve_overprint, intquality)

Parameters

use_text_outlines: bool
convert_strokes_to_outlines: bool
clip_complex_regions: bool
internal_dpi: int
external_dpi: int
preserve_overprint: bool
quality: int

Set up default parameters for flattening transparency.

Defaults: UseTextOutlines = false, ConvertStrokesToOutlines = true, ClipComplexRegions = false, InternalDPI = 800, ExternalDPI = 200, PreserveOverprint = true, Quality = 100.

~FlattenTransparencyParams

~FlattenTransparencyParams()

Member Function Documentation

get_clip_complex_regions

boolget_clip_complex_regions()

Returns:

bool

If true, ensure that boundaries between vector and rasterized artwork fall along object paths.

get_color_image_quality

FlattenerQualitySettingget_color_image_quality()

Returns:

FlattenerQualitySetting

Quality Setting for Flattened JPEG and JPEG2000 colored Images. This is valid only if the value of ColorCompressionScheme is equal to JPEGCompression or JPEG2000Compression Default value: High

get_convert_strokes_to_outlines

boolget_convert_strokes_to_outlines()

Returns:

bool

If true, convert strokes to outlines.

get_external_dpi

intget_external_dpi()

Returns:

int

Resolution for flattening edges of atomic regions. Range is 1 to 1200.

get_gray_image_quality

FlattenerQualitySettingget_gray_image_quality()

Returns:

FlattenerQualitySetting

Quality Setting for Flattened JPEG and JPEG2000 gray Images. This is valid only if the value of GrayCompressionScheme is equal to GrayJPEGCompression or GrayJPEG2000Compression Default value: High

get_internal_dpi

intget_internal_dpi()

Returns:

int

Resolution for flattening the interior of an atomic region. Range is 1 to 9600.

get_max_page_flattening_time

intget_max_page_flattening_time()

Returns:

int

The maximum allowed time that will be spent flattening a single page. A value less than zero will disable the time limit. A value equal to 0 (default) will set the limit to 120 seconds. A value greater than 0 will set the allowed limit (in seconds). Any value less than 60 seconds will be increased to 60 seconds.

get_preserve_overprint

boolget_preserve_overprint()

Returns:

bool

If true, attempt to preserve overprint.

get_profile_description

std::stringget_profile_description()

Returns:

std::string

Class that represents control parameters for flattening transparencies within a PDF file. PDF files can hold objects that are stacked, and that are partially or fully transparent. This means that these objects can blend in various ways with objects behind them. With a stacked set of transparent graphics or images in a PDF file, each one contributing to the final result that appears on the page. One or more graphics images presented together in a stack is referred to as a transparency group. With a stack of transparent images, the final colors shown are the result of blending the colors of all of the overlapping objects. Flatten Transparency merges a stack of transparent objects or graphics into a single image on the PDF page.

Flattening images in a PDF file is generally necessary before you can send the document to a printer. The flattening process simplifies the PDF file and may make it smaller as well.

get_quality

intget_quality()

Returns:

int

The percentage of vector information that is to be preserved. Lower values will cause higher rasterization of vectors. Range is 0 to 100.

get_use_text_outlines

boolget_use_text_outlines()

Returns:

bool

If true, output text outlines instead of native text.

set_clip_complex_regions

voidset_clip_complex_regions(boolvalue)

Parameters

value: bool

true to ensure that boundaries between vector and rasterized artwork fall along object paths, false otherwise.

Returns:

void

If true, ensure that boundaries between vector and rasterized artwork fall along object paths.

set_color_compression

voidset_color_compression(FlattenerColorCompressionscheme)

Parameters

scheme: FlattenerColorCompression

the compression scheme used for flattened color images. Default to JPEGCompression

Returns:

void

The compression scheme used for flattened color images. Default to JPEGCompression.

set_color_image_quality

voidset_color_image_quality(FlattenerQualitySettingquality)

Parameters

quality: FlattenerQualitySetting

the quality Setting for Flattened JPEG and JPEG2000 colored Images. This is valid only if the value of ColorCompressi... Default value: High

Returns:

void

Quality Setting for Flattened JPEG and JPEG2000 colored Images. This is valid only if the value of ColorCompressionScheme is equal to JPEGCompression or JPEG2000Compression

set_convert_strokes_to_outlines

voidset_convert_strokes_to_outlines(boolvalue)

Parameters

value: bool

true to convert strokes to outlines, false otherwise.

Returns:

void

If true, convert strokes to outlines.

set_external_dpi

voidset_external_dpi(intdpi)

Parameters

dpi: int

the resolution for flattening edges of atomic regions. Range is 1 to 1200

Returns:

void

Resolution for flattening edges of atomic regions. Range is 1 to 1200.

set_gray_compression

voidset_gray_compression(FlattenerGrayCompressionscheme)

Parameters

scheme: FlattenerGrayCompression

the compression scheme used for flattened gray images. Default to GrayJPEGCompression

Returns:

void

The compression scheme used for flattened gray images. Default to GrayJPEGCompression.

set_gray_image_quality

voidset_gray_image_quality(FlattenerQualitySettingquality)

Parameters

quality: FlattenerQualitySetting

the quality Setting for Flattened JPEG and JPEG2000 gray Images. This is valid only if the value of GrayCompressionSc... Default value: High

Returns:

void

Quality Setting for Flattened JPEG and JPEG2000 gray Images. This is valid only if the value of GrayCompressionScheme is equal to GrayJPEGCompression or GrayJPEG2000Compression

set_internal_dpi

voidset_internal_dpi(intdpi)

Parameters

dpi: int

the resolution for flattening the interior of an atomic region. Range is 1 to 9600

Returns:

void

Resolution for flattening the interior of an atomic region. Range is 1 to 9600.

set_max_page_flattening_time

voidset_max_page_flattening_time(intseconds)

Parameters

seconds: int

the maximum allowed time that will be spent flattening a single page. A value less than zero will disable the time li...

Returns:

void

The maximum allowed time that will be spent flattening a single page. A value less than zero will disable the time limit. A value equal to 0 (default) will set the limit to 120 seconds. A value greater than 0 will set the allowed limit (in seconds).

set_mono_compression

voidset_mono_compression(FlattenerMonoCompressionscheme)

Parameters

scheme: FlattenerMonoCompression

the compression scheme used for flattened monochrome images. Default to MonoCCITTGroup4Compression

Returns:

void

The compression scheme used for flattened monochrome images. Default to MonoCCITTGroup4Compression.

set_preserve_overprint

voidset_preserve_overprint(boolvalue)

Parameters

value: bool

true to attempt to preserve overprint, false otherwise.

Returns:

void

If true, attempt to preserve overprint.

set_profile_description

voidset_profile_description(const std::string &description)

Parameters

description: const std::string &

Returns:

void

Class that represents control parameters for flattening transparencies within a PDF file. PDF files can hold objects that are stacked, and that are partially or fully transparent. This means that these objects can blend in various ways with objects behind them. With a stacked set of transparent graphics or images in a PDF file, each one contributing to the final result that appears on the page. One or more graphics images presented together in a stack is referred to as a transparency group. With a stack of transparent images, the final colors shown are the result of blending the colors of all of the overlapping objects. Flatten Transparency merges a stack of transparent objects or graphics into a single image on the PDF page.

Flattening images in a PDF file is generally necessary before you can send the document to a printer. The flattening process simplifies the PDF file and may make it smaller as well.

set_quality

voidset_quality(intquality)

Parameters

quality: int

the percentage of vector information to preserve (0-100). Lower values cause higher rasterization of vectors.

Returns:

void

The percentage of vector information that is to be preserved. Lower values will cause higher rasterization of vectors. Range is 0 to 100.

set_use_text_outlines

voidset_use_text_outlines(boolvalue)

Parameters

value: bool

true to output text outlines instead of native text, false otherwise.

Returns:

void

If true, output text outlines instead of native text.