Shading.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_CPPPDFShading
#define PDFTRON_H_CPPPDFShading
 
#include <PDF/ColorSpace.h>
#include <PDF/Rect.h>
#include <Common/Matrix2D.h>
#include <C/PDF/TRN_Shading.h>
 
namespace pdftron { 
    namespace PDF {

class Shading
{
public:

     Shading (SDF::Obj shading_dict = 0);
 
     Shading (const Shading& s);
     Shading& operator=(const Shading& s);
     ~Shading();
 
    enum Type
    {
        e_function_shading,
        e_axial_shading,
        e_radial_shading,
        e_free_gouraud_shading,
        e_lattice_gouraud_shading,
        e_coons_shading,
        e_tensor_shading,
        e_null
    };
 
    // Common Static/Global methods -------------------------------------------------
 
#ifndef SWIG
     static Type GetType(SDF::Obj shading_dict);
#endif
 
    // Common methods ------------------------------------------------------------------
 
     Shading::Type GetType() const;

     SDF::Obj GetSDFObj ();

     ColorSpace GetBaseColorSpace();

     bool HasBBox();
 
     Rect GetBBox();
 
     bool HasBackground();

     ColorPt GetBackground();

      bool GetAntialias();
 
    
    // Specific methods ------------------------------------------------------------

     double GetParamStart();

     double GetParamEnd();

     bool IsExtendStart();

     bool IsExtendEnd();
 
     ColorPt GetColor(double t);
 
#ifndef SWIG
     void GetColor(double t, ColorPt& out_color);
#endif
 
 
    // Specific AxialShading methods -----------------------------------------------

     std::vector<double> GetCoordsAxial();
 
#ifndef SWIG
     void GetCoords(double& out_x0, double& out_y0, double& out_x1, double& out_y1);
#endif
 
    // Specific RadialShading methods ----------------------------------------------

     std::vector<double> GetCoordsRadial();
 
#ifndef SWIG
     void GetCoords(double& out_x0, double& out_y0, double& out_r0,
        double& out_x1, double& out_y1, double& out_r1);
#endif
 
 
    // Specific FunctionShading methods --------------------------------------------

     std::vector<double> GetDomain();
 
#ifndef SWIG
     void GetDomain(double& out_xmin, double& out_xmax, double& out_ymin, double& out_ymax);
#endif

     Common::Matrix2D GetMatrix();
 
     ColorPt GetColor(double t1, double t2);
 
#ifndef SWIG
     void GetColor(double t1, double t2, ColorPt& out_color);
#endif

     void Destroy();
 
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
     Shading(TRN_Shading impl);
    TRN_Shading mp_shade;
#endif
// @endcond
};
 
 
#include <Impl/Shading.inl>
 
    };  // namespace PDF
};  // namespace pdftron
 
#endif // PDFTRON_H_CPPPDFShading