FlattenTransparencyParams Class Documentation
class FlattenTransparencyParamsNamespace:datalogics_interface
Detailed Description
Represents control parameters for flattening transparencies within a PDF file.
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(bool use_text_outlines, bool convert_strokes_to_outlines, bool clip_complex_regions, int internal_dpi, int external_dpi, bool preserve_overprint, int quality)Parameters
use_text_outlines: boolconvert_strokes_to_outlines: boolclip_complex_regions: boolinternal_dpi: intexternal_dpi: intpreserve_overprint: boolquality: 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(const FlattenTransparencyParams & other)Parameters
Copy constructor.
FlattenTransparencyParams
FlattenTransparencyParams(FlattenTransparencyParams && )Parameters
~FlattenTransparencyParams
~FlattenTransparencyParams()Member Function Documentation
get_clip_complex_regions
bool get_clip_complex_regions()Returns:
boolIf true, ensure that boundaries between vector and rasterized artwork fall along object paths.
get_color_compression
FlattenerColorCompression get_color_compression()Returns:
FlattenerColorCompressionThe compression scheme used for flattened color images. Default to JPEGCompression.
get_color_image_quality
FlattenerQualitySetting get_color_image_quality()Returns:
FlattenerQualitySettingQuality 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
bool get_convert_strokes_to_outlines()Returns:
boolIf true, convert strokes to outlines.
get_external_dpi
int get_external_dpi()Returns:
intResolution for flattening edges of atomic regions. Range is 1 to 1200.
get_gray_compression
FlattenerGrayCompression get_gray_compression()Returns:
FlattenerGrayCompressionThe compression scheme used for flattened gray images. Default to GrayJPEGCompression.
get_gray_image_quality
FlattenerQualitySetting get_gray_image_quality()Returns:
FlattenerQualitySettingQuality 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
int get_internal_dpi()Returns:
intResolution for flattening the interior of an atomic region. Range is 1 to 9600.
get_max_page_flattening_time
int get_max_page_flattening_time()Returns:
intThe 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_mono_compression
FlattenerMonoCompression get_mono_compression()Returns:
FlattenerMonoCompressionThe compression scheme used for flattened monochrome images. Default to MonoCCITTGroup4Compression.
get_preserve_overprint
bool get_preserve_overprint()Returns:
boolIf true, attempt to preserve overprint.
get_profile_description
std::string get_profile_description()Returns:
std::stringRepresents control parameters for flattening transparencies within a PDF file.
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
int get_quality()Returns:
intThe 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
bool get_use_text_outlines()Returns:
boolIf true, output text outlines instead of native text.
operator=
FlattenTransparencyParams & operator=(const FlattenTransparencyParams & other)Parameters
Returns:
FlattenTransparencyParams &Copy assignment.
operator=
Parameters
Returns:
FlattenTransparencyParams &set_clip_complex_regions
void set_clip_complex_regions(bool value)Parameters
value: booltrue to ensure that boundaries between vector and rasterized artwork fall along object paths, false otherwise.
Returns:
voidIf true, ensure that boundaries between vector and rasterized artwork fall along object paths.
set_color_compression
void set_color_compression(FlattenerColorCompression scheme)Parameters
scheme: FlattenerColorCompressionthe compression scheme used for flattened color images. Default to JPEGCompression
Returns:
voidThe compression scheme used for flattened color images. Default to JPEGCompression.
set_color_image_quality
void set_color_image_quality(FlattenerQualitySetting quality)Parameters
quality: FlattenerQualitySettingthe quality Setting for Flattened JPEG and JPEG2000 colored Images. This is valid only if the value of ColorCompressi... Default value: High
Returns:
voidQuality 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
void set_convert_strokes_to_outlines(bool value)Parameters
value: booltrue to convert strokes to outlines, false otherwise.
Returns:
voidIf true, convert strokes to outlines.
set_external_dpi
void set_external_dpi(int dpi)Parameters
dpi: intthe resolution for flattening edges of atomic regions. Range is 1 to 1200
Returns:
voidResolution for flattening edges of atomic regions. Range is 1 to 1200.
set_gray_compression
void set_gray_compression(FlattenerGrayCompression scheme)Parameters
scheme: FlattenerGrayCompressionthe compression scheme used for flattened gray images. Default to GrayJPEGCompression
Returns:
voidThe compression scheme used for flattened gray images. Default to GrayJPEGCompression.
set_gray_image_quality
void set_gray_image_quality(FlattenerQualitySetting quality)Parameters
quality: FlattenerQualitySettingthe quality Setting for Flattened JPEG and JPEG2000 gray Images. This is valid only if the value of GrayCompressionSc... Default value: High
Returns:
voidQuality 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
void set_internal_dpi(int dpi)Parameters
dpi: intthe resolution for flattening the interior of an atomic region. Range is 1 to 9600
Returns:
voidResolution for flattening the interior of an atomic region. Range is 1 to 9600.
set_max_page_flattening_time
void set_max_page_flattening_time(int seconds)Parameters
seconds: intthe maximum allowed time that will be spent flattening a single page. A value less than zero will disable the time li...
Returns:
voidThe 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
void set_mono_compression(FlattenerMonoCompression scheme)Parameters
scheme: FlattenerMonoCompressionthe compression scheme used for flattened monochrome images. Default to MonoCCITTGroup4Compression
Returns:
voidThe compression scheme used for flattened monochrome images. Default to MonoCCITTGroup4Compression.
set_preserve_overprint
void set_preserve_overprint(bool value)Parameters
value: booltrue to attempt to preserve overprint, false otherwise.
Returns:
voidIf true, attempt to preserve overprint.
set_profile_description
void set_profile_description(const std::string & description)Parameters
description: const std::string &
Returns:
voidRepresents control parameters for flattening transparencies within a PDF file.
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
void set_quality(int quality)Parameters
quality: intthe percentage of vector information to preserve (0-100). Lower values cause higher rasterization of vectors.
Returns:
voidThe 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
void set_use_text_outlines(bool value)Parameters
value: booltrue to output text outlines instead of native text, false otherwise.
Returns:
voidIf true, output text outlines instead of native text.