Working with Clips in PS file| Python

Add Clip in PS Document

In a PS document, a clip is a boundary defined by a path that restricts the visibility of content within the current graphics state in PS viewers or editors. Any content extending beyond this boundary will be truncated.
In Python, clipping paths can be assigned in three ways:

• By using any class implemented in aspose.pydrawing.GraphicsPath, capable of containing closed shapes.;
• By utilizing a text outline;
• By employing a 1 bpp (bits per pixel) 2-color image as a stencil mask.

Currently, the Aspose.Page for Python via .NET library supports the first and second methods of clipping. In the example below, we create a circular shape as a clipping path and use it to clip a blue-filled rectangle within the same graphics state.
In the example below we obtain a circle shape as a clipping path and cut off a blue-filled rectangle in the same graphics state.

In order to add a clip to the new PsDocument with Aspose.Page for Python via .NET library in this example we do the following steps:

1. Create an output stream for the resulting PS file.
2. Create a PsSaveOptions object with the default options.
3. Create a 1-paged PsDocument with an already created output stream and save options.
4. Create a new graphics state.
5. Create a circle (aspose.pydrawing.GraphicsPath object) shape.
6. Set a clip with this path.
7. Set a paint to the current graphics state of PsDocument.
8. Fill the rectangle path with the current paint.
9. Exit from the current graphics state to the upper level one.
10. Translate to the place of the filled rectangle.
11. Stroke with a dashed line the bounds of the same rectangle above the filled one to show the bounds of the clipped filled rectangle.
12. Close the page.
13. Save the document.

# Create an output stream for PostScript document
with open(data_dir + "Clipping_outPS.ps", "wb") as out_ps_stream:
    # Create the save options with default values
    options = PsSaveOptions()
    
    # Create new 1-paged PS Document
    document = PsDocument(out_ps_stream, options, False)
    
    # Create a graphics path from the rectangle
    rectange_path = aspose.pydrawing.drawing2d.GraphicsPath()
    rectange_path.add_rectangle(aspose.pydrawing.RectangleF(0, 0, 300, 200))
    
    ##################################### Clipping by the shape //////////////////////////////////////////////////////////////////////
    
    # Save the graphics state in order to return back to this state after the transformation
    document.write_graphics_save()
    
    # Displace the current graphics state on 100 points to the right and 100 points to the bottom.
    document.translate(100, 100)
    
    # Create a graphics path from the circle
    circle_path = aspose.pydrawing.drawing2d.GraphicsPath()
    circle_path.add_ellipse(aspose.pydrawing.RectangleF(50, 0, 200, 200))
    
    # Add clipping by circle to the current graphics state
    document.clip(circle_path)
    
    # Set the paint in the current graphics state
    document.set_paint(aspose.pydrawing.SolidBrush(aspose.pydrawing.Color.blue))
    
    # Fill the rectangle in the current graphics state (with clipping)
    document.fill(rectange_path)
    
    # Restore the graphics state to the previus (upper) level
    document.write_graphics_restore()
    
    # Displace the upper level graphics state on 100 points to the right and 100 points to the bottom.
    document.translate(100, 100)
    
    pen = aspose.pydrawing.Pen(aspose.pydrawing.SolidBrush(aspose.pydrawing.Color.blue))
    pen.width = float(2)
    pen.dash_style = aspose.pydrawing.drawing2d.DashStyle.DASH
    
    document.set_stroke(pen)
    
    # Draw the rectangle in the current graphics state (has no clipping) above clipped rectangle
    document.draw(rectange_path)
    
    ########################################################################################################################
    
    # Close the current page
    document.close_page()
    
    # Save the document
    document.save()

See working with clips in PS documents in .NET, Java.

The result of running this code is

You can download examples and data files from GitHub.