GState.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFGState
#define PDFTRON_H_CPPPDFGState
 
#include <C/PDF/TRN_GState.h>
#include <Common/Matrix2D.h>
#include <PDF/ColorSpace.h>
#include <PDF/Font.h>
#include <PDF/PatternColor.h>
 
namespace pdftron { 
    namespace PDF {

class GState 
{
public:
 
     GState();
     GState(const GState& c);
     GState& operator=(const GState& c);
 
    // GState properties
    enum GStateAttribute
    {       
        e_transform = 0,            // General graphics state attributes
        e_rendering_intent,
 
        e_stroke_cs,
        e_stroke_color,
        e_fill_cs,
        e_fill_color,
 
        e_line_width,                // Path attributes
        e_line_cap,
        e_line_join,
        e_flatness,
        e_miter_limit,
        e_dash_pattern,       
 
        e_char_spacing,              // Text attributes
        e_word_spacing,
        e_horizontal_scale,
        e_leading,
        e_font,
        e_font_size,
        e_text_render_mode,
        e_text_rise,
        e_text_knockout,
 
        // Adjusts the text position by a given amount. The attribute can be 
        // accessed through Element interface
        e_text_pos_offset,
 
        e_blend_mode,                // Extended graphics state attributes 
        e_opacity_fill,
        e_opacity_stroke,
        e_alpha_is_shape,
        e_soft_mask,
        e_smoothnes,
        e_auto_stoke_adjust,
        e_stroke_overprint, 
        e_fill_overprint,
        e_overprint_mode,
        e_transfer_funct,
        e_BG_funct,
        e_UCR_funct,
        e_halftone,
 
        // null attribute
        e_null
    };
 
    // Get Methods ------------------------------------------------------------------
 
     Common::Matrix2D GetTransform();
 
     ColorSpace GetStrokeColorSpace();
 
     ColorSpace GetFillColorSpace();

     ColorPt GetStrokeColor();
 
     PatternColor GetStrokePattern();
 
     ColorPt GetFillColor();
 
     PatternColor GetFillPattern();

     double GetFlatness() const;
 
 
    enum LineCap 
    {
        e_butt_cap = 0,     // The stroke is squared off at the endpoint of the path.
        e_round_cap,        // A semicircular arc with a diameter equal to the line width.
        e_square_cap        // squared off stroke continues beyond the endpoint of the path.
    };
 
     LineCap GetLineCap() const;
 
 
    enum LineJoin
    {
        e_miter_join = 0,   // The two segments are extended until they meet
        e_round_join,       // A circle with a diameter equal to the line width
        e_bevel_join        // The two segments are finished with butt caps
    };
 
     LineJoin GetLineJoin() const;
 
     double GetLineWidth() const;
 
     double GetMiterLimit() const;
 
     std::vector<double> GetDashes() const;
 
#ifndef SWIG
     void GetDashes(std::vector<double>& dashes) const;
#endif
 
     double GetPhase() const;
 
     double GetCharSpacing() const;
 
     double GetWordSpacing() const;
 
     double GetHorizontalScale() const;
 
     double GetLeading() const;
 
     Font GetFont() const;
 
     double GetFontSize() const;
 
    enum TextRenderingMode 
    {
        e_fill_text = 0,            // Fill text.
        e_stroke_text,              // Stroke text.
        e_fill_stroke_text,         // Fill, then stroke text.
        e_invisible_text,           // Neither fill nor stroke text (invisible).
        e_fill_clip_text,           // Fill text and add to path for clipping (see above).
        e_stroke_clip_text,         // Stroke text and add to path for clipping.
        e_fill_stroke_clip_text,    // Fill, then stroke text and add to path for clipping.
        e_clip_text                 // Add text to path for clipping.
    };
 
     TextRenderingMode GetTextRenderMode() const;
 
     double GetTextRise() const;
 
     bool IsTextKnockout() const;
 
    enum RenderingIntent
    {
        e_absolute_colorimetric,
        e_relative_colorimetric,
        e_saturation,
        e_perceptual
    };
 
     RenderingIntent GetRenderingIntent() const;
 
     static RenderingIntent GetRenderingIntentType(const char* name);
 
    // Extended graphics state 'Get' methods ----------------------------------------
 
    // The standard separable blend modes available in PDF.
    enum BlendMode
    {
        e_bl_compatible = 0, 
        e_bl_normal, 
        e_bl_multiply, 
        e_bl_screen, 
        e_bl_difference, 
        e_bl_darken, 
        e_bl_lighten, 
        e_bl_color_dodge, 
        e_bl_color_burn, 
        e_bl_exclusion, 
        e_bl_hard_light, 
        e_bl_overlay, 
        e_bl_soft_light, 
        e_bl_luminosity, 
        e_bl_hue, 
        e_bl_saturation,
        e_bl_color
    };

     BlendMode GetBlendMode();
   
     double GetFillOpacity() const;

     double GetStrokeOpacity() const;
 
     bool GetAISFlag() const;
   
     SDF::Obj GetSoftMask();
 
    Common::Matrix2D GetSoftMaskTransform();
 
     bool GetStrokeOverprint() const;
 
     bool GetFillOverprint() const;

     int GetOverprintMode() const;

     bool GetAutoStrokeAdjust() const;

     double GetSmoothnessTolerance() const;

     SDF::Obj GetTransferFunct();

     SDF::Obj GetBlackGenFunct();

     SDF::Obj GetUCRFunct();

     SDF::Obj GetHalftone();
 
    // Set Methods ------------------------------------------------------------------
 
     void SetTransform(const Common::Matrix2D& mtx);

     void SetTransform(double a, double b, double c, double d, double h, double v);
 
     void Concat(const Common::Matrix2D& mtx);
     void Concat(double a, double b, double c, double d, double h, double v);
 
     void SetStrokeColorSpace(ColorSpace cs);

     void SetFillColorSpace(ColorSpace cs);

     void SetStrokeColor(const ColorPt& c);
 
     void SetStrokeColor(PatternColor pattern);
 
     void SetStrokeColor(PatternColor pattern, const ColorPt& c);

     void SetFillColor(const ColorPt& c);
 
     void SetFillColor(PatternColor pattern);
 
     void SetFillColor(PatternColor pattern, const ColorPt& c);
 
     void SetFlatness(double flatness);

     void SetLineCap(LineCap cap);
 
     void SetLineJoin(LineJoin join);

     void SetLineWidth(double width);
 
     void SetMiterLimit(double miter_limit);
 
     void SetDashPattern(const std::vector<double>& dash_array, double phase);
 
     void SetCharSpacing(double char_spacing);

     void SetWordSpacing(double word_spacing);

     void SetHorizontalScale(double hscale);

     void SetLeading(double leading);

     void SetFont(Font font, double font_sz);

     void SetTextRenderMode(TextRenderingMode rmode);

     void SetTextRise(double rise);

     void SetTextKnockout(bool knockout);
    
     void SetRenderingIntent(RenderingIntent intent);
 
    // Extended graphics state 'Set' methods ----------------------------------------

     void SetBlendMode(BlendMode BM);

     void SetFillOpacity(double ca);

     void SetStrokeOpacity(double ca);

     void SetAISFlag(bool AIS);

     void SetSoftMask(SDF::Obj SM);

     void SetStrokeOverprint(bool OP);

     void SetFillOverprint(bool op);

     void SetOverprintMode(int OPM);

     void SetAutoStrokeAdjust(bool SA);

     void SetSmoothnessTolerance(double SM);

     void SetBlackGenFunct(SDF::Obj BG);

     void SetUCRFunct(SDF::Obj UCR);

     void SetTransferFunct(SDF::Obj TR);

     void SetHalftone(SDF::Obj HT);
    
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    GState(TRN_GState impl);
    TRN_GState mp_state;
#endif
// @endcond
};
 
 
#include <Impl/GState.inl>
 
    };  // namespace PDF
};  // namespace pdftron
 
 
 
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
#ifdef _WIN32
  // A forward declaration for GDI+
  namespace Gdiplus { class Bitmap; };
#endif
#endif
// @endcond
 
#endif // PDFTRON_H_CPPPDFGState