Path Class

class Path : Element

Namespace:datalogics_interface

Inherits from:: Element

Detailed Description

A path in a PDF file defines shapes.

Paths in PDF files are used to draw lines, define filled areas, and define boundaries for clipping graphics. A path is composed of straight and curved line segments.

Referenced by

Path

Uses types

Clip ElementCloneFlags ElementType GraphicState Matrix Path PathPaintOp Rect

Constructor & Destructor Documentation

Path()

Create a path.

Path(GraphicState gs)

Parameters

gs: GraphicState

Create a path.

Path(Path && )

Parameters

: Path &&

~Path()

Member Function Documentation

void add_curve(const Point & p1, const Point & p2, const Point & p3)

Parameters

p1: const Point &: - first Bezier control point
p2: const Point &: - second Bezier control point
p3: const Point &: - the ending Point of the Bezier curve which will also be the current point of the current path.

Returns:

void

Adds a Bezier curve from the current path using the first two points specified as Bezier control points ending at the third point. The new current point is then set to the third point.

void add_curve_v(const Point & p1, const Point & p2)

Parameters

p1: const Point &: - first Bezier control point
p2: const Point &: - the ending Point of the Bezier curve which will also be the new current point of the path.

Returns:

void

Adds a Bezier curve from the current path. This extends from the current path to the point Point2 using the current point and the first point specified as Bezier control points ending at the second point. The new current point is then set to the second point.

void add_curve_y(const Point & p1, const Point & p2)

Parameters

p1: const Point &: - first Bezier control point
p2: const Point &: - second Bezier control point and the ending Point of the Bezier curve which will also be the new current point of the path.

Returns:

void

Adds a Bezier curve from the current path. This extends from the current path to the point Point2 using the two points specified as Bezier control points ending at the second point. The new current point is then set to the second point.

void add_line(const Point & pt)

Parameters

pt: const Point &: - the coordinates of the endpoint of the new line.

Returns:

void

Adds a line to the current path from the current path position. The given point becomes the new current position.

void add_rect(const Point & pt, double width, double height)

Parameters

pt: const Point &: - the coordinates of the lower left corner of the new rectangle.
width: double: - the width of the new rectangle.
height: double: - the height of the new rectangle.

Returns:

void

Adds a rectangle to the current path with the lower left corner at the give point, and with the width and height specified.

void clear_graphic_state()

Returns:

void

Removes the graphic state from this path.

std::unique_ptr< Path > clone()

Returns:

std::unique_ptr< Path >

The copied path.

Makes a copy of the path.

Make a copy of an path to obtain a new path that has a distinct set of attributes.

std::unique_ptr< Path > clone(ElementCloneFlags flags)

Parameters

flags: ElementCloneFlags

Returns:

std::unique_ptr< Path >

The copied path.

Makes a copy of the path.

Make a copy of an path to obtain a new path that has a distinct set of attributes.

void close_path()

Returns:

void

Closes the current subpath.

Rect get_bounding_box()

Returns:

Rect

The bounding box for this element. The coordinates of the bounding box are specified in user space coordinates, relative to the element's Content. Note that user space coordinates correspond to unrotated pages; any rotation specified in the page dictionary is not taken into account.

The bounding box for this element.

The bounding box is a rectangle that is guaranteed to encompass the element, but it is not guaranteed to be the smallest box that could contain the element. For example, if the element is a Path that contains an arc, the bounding box encompasses the bezier control points, and not just the curve itself.

std::unique_ptr< Clip > get_clip()

Returns:

std::unique_ptr< Clip >

The current Clip for this Element, or NULL if no clip is set.

Gets the current Clip for an Element.

ElementType get_element_type()

Returns:

ElementType

Returns the runtime type of this element.

std::unique_ptr< GraphicState > get_graphic_state()

Returns:

std::unique_ptr< GraphicState >

The graphic state, or nullptr if none is set.

Get the graphic state of the current path.

May return null if this element does not have a GraphicState.

Matrix get_matrix()

Returns:

Matrix

The current transformation matrix applied to this element.

The transformation matrix for the element.

PathPaintOp get_paint_op()

Returns:

PathPaintOp

the PathPaintOpFlags flags describing the fill and stroke attributes.

Gets the fill and stroke attributes of a path.

std::vector< std::shared_ptr< Segment > > get_segments()

Returns:

std::vector< std::shared_ptr< Segment > >

Get the segments of the path.

Returns a list of Segment objects, one for each segment in the path.

void move_to(const Point & pt)

Parameters

pt: const Point &: - the coordinates of the new current point.

Returns:

void

Moves the current point of the path to the given point.

Path & operator=(Path && )

Parameters

: Path &&

Returns:

Path &

void rotate(double theta)

Parameters

theta: double: The rotation angle in degrees.

Returns:

void

Rotate an element by theta degrees counterclockwise using the matrix [ cos T sin T -sin T cos T 0 0 ].

void scale(double sx, double sy)

Parameters

sx: double: The horizontal scale factor.
sy: double: The vertical scale factor.

Returns:

void

Scale an element by (sx,sy) units using the matrix [ sx 0 0 sy 0 0 ].

void set_clip(Clip & clip)

Parameters

clip: Clip &: The clip to set as the current clip for this element, or NULL to remove clipping.

Returns:

void

Sets the current Clip for an Element.

void set_graphic_state(const GraphicState & gs)

Parameters

gs: const GraphicState &: - the new/updated Graphic State for the path.

Returns:

void

Set the Graphic State of the current path.

Note: The Path copies the graphic state internally.

void set_matrix(const Matrix & matrix)

Parameters

matrix: const Matrix &: The transformation matrix for the element.

Returns:

void

Set the transformation matrix for the element.

void set_paint_op(PathPaintOp op)

Parameters

op: PathPaintOp: - the flags describing the fill and stroke attributes.

Returns:

void

Sets the fill and stroke attributes of a path.

void translate(double tx, double ty)

Parameters

tx: double: The horizontal translation distance in user space units.
ty: double: The vertical translation distance in user space units.

Returns:

void

Translate an element by (tx,ty) units using the matrix [ 1 0 0 1 tx ty ].

T * try_as(typename T )

Parameters

: typename T

Returns:

T *

Attempt to downcast this element to a derived type. Returns a pointer to the derived type, or nullptr if the type doesn't match.

const T * try_as(typename T )

Parameters

: typename T

Returns:

const T *

Const overload of try_as(). Returns a const pointer, or nullptr.