Clip Class Documentation
class ClipNamespace:datalogics_interface
Detailed Description
A clipping path is used to mark an area within a page to be highlighted or removed.
The clipping path clips out part of the design. A clip can also be used with text.
The clipping path defines an area within a page (text or graphic) that will be highlighted or removed. For example, a clipping path could be used to remove the background in a photograph, to highlight a person or object in front, or to super-impose text over an image. Only part of the image appears through a shape created with the clipping path.
The Clip class is made up of a list of path and text elements. Any element can have a clip associated with it, and clip objects can hold arbitrary levels of nested container and group objects.
If a group object is inside a clip object, and the clip object also contains at least one text object and no path objects, the group object has a special meaning. All text objects contained in a group object like this are considered to be part of the same BT/ET block. This means that the union of these text objects makes up a single clipping path. The text objects do not intersect.
Uses types
Constructor & Destructor Documentation
Member Function Documentation
add_element
void add_element(Element & element)Parameters
element: Element &- The Element to add to the Clip.
Returns:
voidAdds an Element to a Clip path, after the Element index specified.
add_element
void add_element(Element & element, int add_after)Parameters
element: Element &- The Element to add to the Clip.
add_after: int- The index after which this Element will be added to the Clip's list of Elements. If omitted, it will be added as index 0, i.e., the first Element.
Returns:
voidAdds an Element to a Clip path, after the Element index specified.
clone
std::unique_ptr< Clip > clone()Returns:
std::unique_ptr< Clip >A new clip object deep copy
Makes a new deep copy of this Clip object in memory.
num_elements
int num_elements()Returns:
int- The number of top-level Elements in the Clip.
Gets the number of top-level Elements in a Clip object.
operator=
Parameters
: Clip &&
Returns:
Clip &remove_elements
void remove_elements(int index)Parameters
index: int- The index of the Element to remove.
Returns:
voidRemoves an Element from a Clip object.
remove_elements
void remove_elements(int index, int count)Parameters
index: int- The index of the Element to remove.
count: int
Returns:
voidRemoves an Element from a Clip object.
to_string
std::string to_string()Returns:
std::stringA clipping path is used to mark an area within a page to be highlighted or removed.
The clipping path clips out part of the design. A clip can also be used with text.
The clipping path defines an area within a page (text or graphic) that will be highlighted or removed. For example, a clipping path could be used to remove the background in a photograph, to highlight a person or object in front, or to super-impose text over an image. Only part of the image appears through a shape created with the clipping path.
The Clip class is made up of a list of path and text elements. Any element can have a clip associated with it, and clip objects can hold arbitrary levels of nested container and group objects.
If a group object is inside a clip object, and the clip object also contains at least one text object and no path objects, the group object has a special meaning. All text objects contained in a group object like this are considered to be part of the same BT/ET block. This means that the union of these text objects makes up a single clipping path. The text objects do not intersect.