ShadingPattern Class Documentation
class ShadingPattern : PatternNamespace:datalogics_interface
- Inherits from:
Pattern
- Derived classes:
- AxialShadingPattern
Detailed Description
A shading pattern consists of a smoothly varying gradient between two colors.
Uses types
Member Function Documentation
get_anti_alias
bool get_anti_alias()Returns:
booltrue if anti-aliasing is enabled, false otherwise.
Gets whether anti-aliasing is enabled for the shading.
When enabled, the shading function is filtered to prevent aliasing artifacts.
get_bounding_box
Rect get_bounding_box()Returns:
RectThe bounding box Rect, or NULL if none is set.
Gets the bounding box of the shading.
The coordinates are interpreted in the target coordinate space. If present, provides an additional, temporary clipping boundary to the shading.
get_color_space
std::unique_ptr< ColorSpace > get_color_space()Returns:
std::unique_ptr< ColorSpace >The ColorSpace of the shading pattern.
Gets the color space of a shading pattern.
This space is restricted to be any space except a Pattern space.
get_pdf_object
std::unique_ptr< PDFObject > get_pdf_object()Returns:
std::unique_ptr< PDFObject >The PDFObject representing this pattern in the PDF document.
Gets the underlying PDF object for this pattern.
set_anti_alias
void set_anti_alias(bool anti_alias)Parameters
anti_alias: booltrue to enable anti-aliasing, false to disable it.
Returns:
voidSets whether anti-aliasing is enabled for the shading.
When enabled, the shading function is filtered to prevent aliasing artifacts.
set_bounding_box
void set_bounding_box(const Rect & bbox)Parameters
bbox: const Rect &The bounding box Rect to set, or NULL to remove it.
Returns:
voidSets the bounding box of the shading.
The coordinates are interpreted in the target coordinate space. If present, provides an additional, temporary clipping boundary to the shading. Set to NULL to remove the bounding box.
set_color_space
void set_color_space(ColorSpace & color_space)Parameters
color_space: ColorSpace &The ColorSpace to set for the shading pattern.
Returns:
voidSets the color space of a shading pattern.
This space is restricted to be any space except a Pattern space.
to_string
std::string to_string()Returns:
std::stringA string describing the shading pattern.
Converts the shading pattern to a string representation.