GraphicState Class Documentation
class GraphicStateNamespace:datalogics_interface
Detailed Description
The graphic state is an internal data structure in a PDF file.
The graphics state holds the parameters that describe graphics within that file.
These parameters define how individual graphics are presented on the page, including layers and transparencies.
Uses types
Constructor & Destructor Documentation
GraphicState
GraphicState()Create a new default GraphicState.
GraphicState
GraphicState(GraphicState && )Parameters
~GraphicState
~GraphicState()Member Function Documentation
clear_extended_graphic_state
void clear_extended_graphic_state()Returns:
voidRemoves the extended graphic state from this graphic state.
get_dash_pattern
std::vector< double > get_dash_pattern()Returns:
std::vector< double >A list containing the dash phase followed by the contents of the DashPattern.
The line DashPattern controls the pattern of dashes and gaps used to stroke paths. It is specified by a dash phase and then a series of elements of a DashPattern list. The DashPattern's members are numbers that specify the lengths of alternating dashes and gaps; the numbers must be nonnegative and not all zero. The dash phase specifies the distance into the dash pattern at which to start the dash. The elements of both the DashPattern List and the dash phase are expressed in user space units. This retrieves the DashPattern used by the Pattern list current graphic state.
get_extended_graphic_state
ExtendedGraphicState * get_extended_graphic_state()Returns:
ExtendedGraphicState *The ExtendedGraphicState, or null if none is set.
The ExtendedGraphicState associated with this GraphicState.
The ExtendedGraphicState can contain additional parameters such as transparency, blend mode, and overprint settings that are not part of the basic GraphicState.
DeprecatedNot yet implemented — always returns nullptr
get_fill_color
Color get_fill_color()Returns:
ColorThe current fill color.
The color used for filling operations in the current GraphicState.
get_line_cap
LineCap get_line_cap()Returns:
LineCapThe current line cap style.
The line cap style used by the current GraphicState, specifying the shape at the ends of open subpaths when stroked.
get_line_flatness
double get_line_flatness()Returns:
doubleThe current line flatness value.
The line flatness tolerance in the current GraphicState, corresponding to the i operator. Default is 1.0.
Flatness controls the maximum distance (in device pixels) between a curve and the flattened line segments that approximate it.
get_line_join
LineJoin get_line_join()Returns:
LineJoinThe current line join style.
The line join style used by the current GraphicState, specifying the shape at the corners where consecutive segments of a path connect at an angle.
get_miter_limit
double get_miter_limit()Returns:
doubleThe current miter limit.
The miter limit for line joins in the current GraphicState, corresponding to the M operator. Default is 10.0.
When two line segments meet at a sharp angle and mitered joins have been specified, the miter limit controls when the join is beveled instead.
get_render_intent
RenderIntent get_render_intent()Returns:
RenderIntentThe current rendering intent.
The color rendering intent for the current GraphicState, corresponding to the Intent key in the image dictionary. The default is RelColorimetric.
get_stroke_color
Color get_stroke_color()Returns:
ColorThe current stroke color.
The color used for stroking operations in the current GraphicState.
get_width
double get_width()Returns:
doubleThe current line width.
The line width used for stroking operations by the current GraphicState, in user space units.
operator=
GraphicState & operator=(GraphicState && )Parameters
Returns:
GraphicState &set_dash_pattern
void set_dash_pattern(const std::vector< double > & pattern)Parameters
pattern: const std::vector< double > &A list containing the dash phase followed by the contents of the DashPattern.
Returns:
voidThe line DashPattern controls the pattern of dashes and gaps used to stroke paths. It is specified by a dash phase and then a series of elements of a DashPattern list. The DashPattern's members are numbers that specify the lengths of alternating dashes and gaps; the numbers must be nonnegative and not all zero. The dash phase specifies the distance into the dash pattern at which to start the dash. The elements of both the DashPattern List and the dash phase are expressed in user space units. This retrieves the DashPattern used by the Pattern list current graphic state.
set_extended_graphic_state
void set_extended_graphic_state(const ExtendedGraphicState & egs)Parameters
egs: const ExtendedGraphicState &The new ExtendedGraphicState, or null to remove it.
Returns:
voidThe ExtendedGraphicState associated with this GraphicState.
The ExtendedGraphicState can contain additional parameters such as transparency, blend mode, and overprint settings that are not part of the basic GraphicState.
Note: The GraphicState copies the EGS internally.
set_fill_color
void set_fill_color(Color color)Parameters
color: ColorThe new fill color.
Returns:
voidThe color used for filling operations in the current GraphicState.
The color may be specified in DeviceGray, DeviceRGB, or DeviceCMYK color spaces.
set_line_cap
void set_line_cap(LineCap cap)Parameters
cap: LineCapThe new line cap style.
Returns:
voidThe line cap style used by the current GraphicState, specifying the shape at the ends of open subpaths when stroked.
set_line_flatness
void set_line_flatness(double flatness)Parameters
flatness: doubleThe new flatness value.
Returns:
voidThe line flatness tolerance in the current GraphicState, corresponding to the i operator. Default is 1.0.
set_line_join
void set_line_join(LineJoin join)Parameters
join: LineJoinThe new line join style.
Returns:
voidThe line join style to be used by the current GraphicState, specifying the shape at the corners where consecutive segments of a path connect at an angle.
set_miter_limit
void set_miter_limit(double limit)Parameters
limit: doubleThe new miter limit value.
Returns:
voidThe miter limit for line joins in the current GraphicState, corresponding to the M operator. Default is 10.0.
set_render_intent
void set_render_intent(RenderIntent intent)Parameters
intent: RenderIntentThe new rendering intent.
Returns:
voidThe color rendering intent for the current GraphicState, corresponding to the Intent key in the image dictionary. The default is RelColorimetric.
set_stroke_color
void set_stroke_color(Color color)Parameters
color: ColorThe new stroke color.
Returns:
voidThe color used for stroking operations in the current GraphicState.
The color may be specified in DeviceGray, DeviceRGB, or DeviceCMYK color spaces.
set_width
void set_width(double width)Parameters
width: doubleThe new line width.
Returns:
voidThe line width used for stroking operations by the current GraphicState, in user space units.