KLayout Manual: Main Index » Class Index » API reference - Class ShapeProcessor

API reference - Class ShapeProcessor

Description: The shape processor (boolean, sizing, merge on shapes)

Public constructors
Public methods
Detailed description

The shape processor implements the boolean and edge set operations (size, merge). Because the shape processor might allocate resources which can be reused in later operations, it is implemented as an object that can be used several times. The shape processor is similar to the EdgeProcessor. The latter is specialized on handling polygons and edges directly.

Public constructors

ShapeProcessor

new

Creates a new object of this class

Public methods

[const]	void	assign	(const ShapeProcessor other)	Assign the contents of another object to self
	void	boolean	(const Layout layout_a, const Cell cell_a, unsigned int layer_a, const Layout layout_b, const Cell cell_b, unsigned int layer_b, Shapes out, int mode, bool hierarchical, bool resolve_holes, bool min_coherence)	Boolean operation on shapes from layouts
	Edge[]	boolean	(Shape[] in_a, CplxTrans[] trans_a, Shape[] in_b, CplxTrans[] trans_b, int mode)	Boolean operation on two given shape sets into an edge set
	Edge[]	boolean	(Shape[] in_a, Shape[] in_b, int mode)	Boolean operation on two given shape sets into an edge set
	Polygon[]	boolean_to_polygon	(Shape[] in_a, CplxTrans[] trans_a, Shape[] in_b, CplxTrans[] trans_b, int mode, bool resolve_holes, bool min_coherence)	Boolean operation on two given shape sets into a polygon set
	Polygon[]	boolean_to_polygon	(Shape[] in_a, Shape[] in_b, int mode, bool resolve_holes, bool min_coherence)	Boolean operation on two given shape sets into a polygon set
	void	create		Ensures the C++ object is created
	void	destroy		Explicitly destroy the object
[const]	bool	destroyed?		Returns a value indicating whether the object was already destroyed
[const]	ShapeProcessor	dup		Creates a copy of self
[const]	bool	is_const_object?		Returns a value indicating whether the reference is a const reference
	void	merge	(const Layout layout, const Cell cell, unsigned int layer, Shapes out, bool hierarchical, unsigned int min_wc, bool resolve_holes, bool min_coherence)	Merge the given shapes from a layout into a shapes container
	Edge[]	merge	(Shape[] in, CplxTrans[] trans, unsigned int min_wc)	Merge the given shapes
	Edge[]	merge	(Shape[] in, unsigned int min_wc)	Merge the given shapes
	Polygon[]	merge_to_polygon	(Shape[] in, CplxTrans[] trans, unsigned int min_wc, bool resolve_holes, bool min_coherence)	Merge the given shapes
	Polygon[]	merge_to_polygon	(Shape[] in, unsigned int min_wc, bool resolve_holes, bool min_coherence)	Merge the given shapes
	void	size	(const Layout layout, const Cell cell, unsigned int layer, Shapes out, int dx, int dy, unsigned int mode, bool hierarchical, bool resolve_holes, bool min_coherence)	Sizing operation on shapes from layouts
	void	size	(const Layout layout, const Cell cell, unsigned int layer, Shapes out, int d, unsigned int mode, bool hierarchical, bool resolve_holes, bool min_coherence)	Sizing operation on shapes from layouts
	Edge[]	size	(Shape[] in, CplxTrans[] trans, int d, unsigned int mode)	Size the given shapes
	Edge[]	size	(Shape[] in, CplxTrans[] trans, int dx, int dy, unsigned int mode)	Size the given shapes
	Edge[]	size	(Shape[] in, int d, unsigned int mode)	Size the given shapes
	Edge[]	size	(Shape[] in, int dx, int dy, unsigned int mode)	Size the given shapes
	Polygon[]	size_to_polygon	(Shape[] in, CplxTrans[] trans, int d, unsigned int mode, bool resolve_holes, bool min_coherence)	Size the given shapes
	Polygon[]	size_to_polygon	(Shape[] in, CplxTrans[] trans, int dx, int dy, unsigned int mode, bool resolve_holes, bool min_coherence)	Size the given shapes
	Polygon[]	size_to_polygon	(Shape[] in, int d, unsigned int mode, bool resolve_holes, bool min_coherence)	Size the given shapes
	Polygon[]	size_to_polygon	(Shape[] in, int dx, int dy, unsigned int mode, bool resolve_holes, bool min_coherence)	Size the given shapes

Detailed description

[const] void assign(const ShapeProcessor other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

void boolean(const Layout layout_a,const Cell cell_a,unsigned int layer_a,const Layout layout_b,const Cell cell_b,unsigned int layer_b,Shapes out,int mode,bool hierarchical,bool resolve_holes,bool min_coherence)

Description: Boolean operation on shapes from layouts

layout_a:	The layout from which to take the shapes for input A
cell_a:	The cell (in 'layout') from which to take the shapes for input A
layer_a:	The cell (in 'layout') from which to take the shapes for input A
layout_b:	The layout from which to take the shapes for input B
cell_b:	The cell (in 'layout') from which to take the shapes for input B
layer_b:	The cell (in 'layout') from which to take the shapes for input B
out:	The shapes container where to put the shapes into (is cleared before)
mode:	The boolean operation (see EdgeProcessor)
hierarchical:	Collect shapes from sub cells as well
resolve_holes:	true, if holes should be resolved into the hull
min_coherence:	true, if minimum polygons should be created for touching corners

See the EdgeProcessor for a description of the boolean operations. This implementation takes shapes from layout cells (optionally all in hierarchy) and produces new shapes in a shapes container.

Edge[] boolean(Shape[] in_a,CplxTrans[] trans_a,Shape[] in_b,CplxTrans[] trans_b,int mode)

Description: Boolean operation on two given shape sets into an edge set

in_a:	The set of shapes to use for input A
trans_a:	A set of transformations to apply before the shapes are used
in_b:	The set of shapes to use for input A
trans_b:	A set of transformations to apply before the shapes are used
mode:	The boolean operation (see EdgeProcessor)

See the EdgeProcessor for a description of the boolean operations. This implementation takes shapes rather than polygons for input and produces an edge set.

Edge[] boolean(Shape[] in_a,Shape[] in_b,int mode)

Description: Boolean operation on two given shape sets into an edge set

in_a:	The set of shapes to use for input A
in_b:	The set of shapes to use for input A
mode:	The boolean operation (see EdgeProcessor)

See the EdgeProcessor for a description of the boolean operations. This implementation takes shapes rather than polygons for input and produces an edge set.

This version does not allow to specify a transformation for each shape (unity is assumed).

Polygon[] boolean_to_polygon(Shape[] in_a,CplxTrans[] trans_a,Shape[] in_b,CplxTrans[] trans_b,int mode,bool resolve_holes,bool min_coherence)

Description: Boolean operation on two given shape sets into a polygon set

in_a:	The set of shapes to use for input A
trans_a:	A set of transformations to apply before the shapes are used
in_b:	The set of shapes to use for input A
trans_b:	A set of transformations to apply before the shapes are used
mode:	The boolean operation (see EdgeProcessor)
resolve_holes:	true, if holes should be resolved into the hull
min_coherence:	true, if minimum polygons should be created for touching corners

See the EdgeProcessor for a description of the boolean operations. This implementation takes shapes rather than polygons for input and produces a polygon set.

Polygon[] boolean_to_polygon(Shape[] in_a,Shape[] in_b,int mode,bool resolve_holes,bool min_coherence)

Description: Boolean operation on two given shape sets into a polygon set

in_a:	The set of shapes to use for input A
in_b:	The set of shapes to use for input A
mode:	The boolean operation (see EdgeProcessor)
resolve_holes:	true, if holes should be resolved into the hull
min_coherence:	true, if minimum polygons should be created for touching corners

See the EdgeProcessor for a description of the boolean operations. This implementation takes shapes rather than polygons for input and produces a polygon set.

This version does not allow to specify a transformation for each shape (unity is assumed).

void create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] ShapeProcessor dup

Description: Creates a copy of self

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void merge(const Layout layout,const Cell cell,unsigned int layer,Shapes out,bool hierarchical,unsigned int min_wc,bool resolve_holes,bool min_coherence)

Description: Merge the given shapes from a layout into a shapes container

layout:	The layout from which to take the shapes
cell:	The cell (in 'layout') from which to take the shapes
layer:	The cell (in 'layout') from which to take the shapes
out:	The shapes container where to put the shapes into (is cleared before)
hierarchical:	Collect shapes from sub cells as well
min_wc:	The minimum wrap count for output (0: all polygons, 1: at least two overlapping)
resolve_holes:	true, if holes should be resolved into the hull
min_coherence:	true, if minimum polygons should be created for touching corners

See the EdgeProcessor for a description of the merge method. This implementation takes shapes from a layout cell (optionally all in hierarchy) and produces new shapes in a shapes container.

Edge[] merge(Shape[] in,CplxTrans[] trans,unsigned int min_wc)

Description: Merge the given shapes

in:	The set of shapes to merge
trans:	A corresponding set of transformations to apply on the shapes
min_wc:	The minimum wrap count for output (0: all polygons, 1: at least two overlapping)

See the EdgeProcessor for a description of the merge method. This implementation takes shapes rather than polygons for input and produces an edge set.

Edge[] merge(Shape[] in,unsigned int min_wc)

Description: Merge the given shapes

in:	The set of shapes to merge
min_wc:	The minimum wrap count for output (0: all polygons, 1: at least two overlapping)

See the EdgeProcessor for a description of the merge method. This implementation takes shapes rather than polygons for input and produces an edge set.

This version does not allow to specify a transformation for each shape (unity is assumed).

Polygon[] merge_to_polygon(Shape[] in,CplxTrans[] trans,unsigned int min_wc,bool resolve_holes,bool min_coherence)

Description: Merge the given shapes

in:	The set of shapes to merge
trans:	A corresponding set of transformations to apply on the shapes
min_wc:	The minimum wrap count for output (0: all polygons, 1: at least two overlapping)
resolve_holes:	true, if holes should be resolved into the hull
min_coherence:	true, if minimum polygons should be created for touching corners

See the EdgeProcessor for a description of the merge method. This implementation takes shapes rather than polygons for input and produces a polygon set.

Polygon[] merge_to_polygon(Shape[] in,unsigned int min_wc,bool resolve_holes,bool min_coherence)

Description: Merge the given shapes

in:	The set of shapes to merge
min_wc:	The minimum wrap count for output (0: all polygons, 1: at least two overlapping)
resolve_holes:	true, if holes should be resolved into the hull
min_coherence:	true, if minimum polygons should be created for touching corners

See the EdgeProcessor for a description of the merge method. This implementation takes shapes rather than polygons for input and produces a polygon set.

This version does not allow to specify a transformation for each shape (unity is assumed).

[static] ShapeProcessor new

Description: Creates a new object of this class

void size(const Layout layout,const Cell cell,unsigned int layer,Shapes out,int dx,int dy,unsigned int mode,bool hierarchical,bool resolve_holes,bool min_coherence)

Description: Sizing operation on shapes from layouts

layout:	The layout from which to take the shapes
cell:	The cell (in 'layout') from which to take the shapes
layer:	The cell (in 'layout') from which to take the shapes
out:	The shapes container where to put the shapes into (is cleared before)
dx:	The sizing value in x-direction (see EdgeProcessor)
dy:	The sizing value in y-direction (see EdgeProcessor)
mode:	The sizing mode (see EdgeProcessor)
hierarchical:	Collect shapes from sub cells as well
resolve_holes:	true, if holes should be resolved into the hull
min_coherence:	true, if minimum polygons should be created for touching corners

See the EdgeProcessor for a description of the sizing operation. This implementation takes shapes from a layout cell (optionally all in hierarchy) and produces new shapes in a shapes container.

void size(const Layout layout,const Cell cell,unsigned int layer,Shapes out,int d,unsigned int mode,bool hierarchical,bool resolve_holes,bool min_coherence)

Description: Sizing operation on shapes from layouts

layout:	The layout from which to take the shapes
cell:	The cell (in 'layout') from which to take the shapes
layer:	The cell (in 'layout') from which to take the shapes
out:	The shapes container where to put the shapes into (is cleared before)
d:	The sizing value (see EdgeProcessor)
mode:	The sizing mode (see EdgeProcessor)
hierarchical:	Collect shapes from sub cells as well
resolve_holes:	true, if holes should be resolved into the hull
min_coherence:	true, if minimum polygons should be created for touching corners

See the EdgeProcessor for a description of the sizing operation. This implementation takes shapes from a layout cell (optionally all in hierarchy) and produces new shapes in a shapes container. This is the isotropic version which does not allow to specify different sizing values in x and y-direction.