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

API reference - Class Shapes

Notation used in Ruby API documentation

Description: A collection of shapes

A shapes collection is a collection of geometrical objects, such as polygons, boxes, paths, edges or text objects.

Shapes objects are the basic containers for geometrical objects of a cell. Inside a cell, there is one Shapes object per layer.

Public constructors

ShapesnewCreates a new object of this class

Public methods

[const]voidassign(const Shapes other)Assign the contents of another object to self
voidclearClear the shape container
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]ShapesdupCreates a copy of self
[const,iter]Shapeeach(unsigned int flags)Get all shapes
[const,iter]ShapeeachGet all shapes
[const,iter]Shapeeach_overlapping(unsigned int flags,
const Box region)		Get all shapes that overlap the search box (region)
[const,iter]Shapeeach_overlapping(const Box region)Get all shapes that overlap the search box (region)
[const,iter]Shapeeach_touching(unsigned int flags,
const Box region)		Get all shapes that touch the search box (region)
[const,iter]Shapeeach_touching(const Box region)Get all shapes that touch the search box (region)
voiderase(const Shape shape)Erase the shape pointed to by the given Shape object
[const]Shapefind(const Shape shape)Finds a shape inside this collected
Shapeinsert(const Shape shape)Insert a shape from a shape reference into the shapes list
Shapeinsert(const Shape shape,
const Trans trans)		Insert a shape from a shape reference into the shapes list with a transformation
Shapeinsert(const Shape shape,
const CplxTrans trans)		Insert a shape from a shape reference into the shapes list with a complex transformation
Shapeinsert(const Shape shape,
const ICplxTrans trans)		Insert a shape from a shape reference into the shapes list with a complex integer transformation
Shapeinsert(const Box box)Insert a box into the shapes list
Shapeinsert(const Path path)Insert a path into the shapes list
Shapeinsert(const Edge edge)Insert a edge into the shapes list
Shapeinsert(const Text text)Insert a text into the shapes list
Shapeinsert(const SimplePolygon simple_polygon)Insert a simple polygon into the shapes list
Shapeinsert(const Polygon polygon)Insert a polygon into the shapes list
Shapeinsert(const Box box,
unsigned int property_id)		Insert a box with properties into the shapes list
Shapeinsert(const Path path,
unsigned int property_id)		Insert a path with properties into the shapes list
Shapeinsert(const Edge edge,
unsigned int property_id)		Insert a edge with properties into the shapes list
Shapeinsert(const Text text,
unsigned int property_id)		Insert a text with properties into the shapes list
Shapeinsert(const SimplePolygon simple_polygon,
unsigned int property_id)		Insert a simple polygon with properties into the shapes list
Shapeinsert(const Polygon polygon,
unsigned int property_id)		Insert a polygon with properties into the shapes list
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]boolis_empty?Returns a value indicating whether the shapes container is empty
[const]boolis_valid?(const Shape shape)Test if the given Shape object is still pointing to a valid object
Shapereplace(const Shape shape,
const Box box)		Replace the given shape with a box
Shapereplace(const Shape shape,
const Path path)		Replace the given shape with a path
Shapereplace(const Shape shape,
const Edge edge)		Replace the given shape with an edge object
Shapereplace(const Shape shape,
const Text text)		Replace the given shape with a text object
Shapereplace(const Shape shape,
const SimplePolygon simple_polygon)		Replace the given shape with a simple polygon
Shapereplace(const Shape shape,
const Polygon polygon)		Replace the given shape with a polygon
Shapereplace_prop_id(const Shape shape,
unsigned int property_id)		Replace (or install) the properties of a shape
[const]unsigned intsizeReport the number of shapes in this container
Shapetransform(const Shape shape,
const Trans trans)		Transform the shape given by the reference with the given transformation
Shapetransform(const Shape shape,
const CplxTrans trans)		Transform the shape given by the reference with the given complex transformation
Shapetransform(const Shape shape,
const ICplxTrans trans)		Transform the shape given by the reference with the given complex integer space transformation

Public static methods and constants

unsigned intSAllIndicates that all shapes shall be retrieved
unsigned intSAllWithPropertiesIndicates that all shapes with properties shall be retrieved
unsigned intSBoxesIndicates that boxes shall be retrieved
unsigned intSEdgesIndicates that edges shall be retrieved
unsigned intSPathsIndicates that paths shall be retrieved
unsigned intSPolygonsIndicates that polygons shall be retrieved
unsigned intSPropertiesIndicates that only shapes with properties shall be retrieved
unsigned intSTextsIndicates that texts be retrieved
unsigned intSUserObjectsIndicates that user objects shall be retrieved

Deprecated methods (protected, public, static, non-static and constructors)

Shapeinsert_box(const Box box)Use of this method is deprecated. Use insert instead
Shapeinsert_box_with_properties(const Box box,
unsigned int property_id)		Use of this method is deprecated. Use insert instead
Shapeinsert_edge(const Edge edge)Use of this method is deprecated. Use insert instead
Shapeinsert_edge_with_properties(const Edge edge,
unsigned int property_id)		Use of this method is deprecated. Use insert instead
Shapeinsert_path(const Path path)Use of this method is deprecated. Use insert instead
Shapeinsert_path_with_properties(const Path path,
unsigned int property_id)		Use of this method is deprecated. Use insert instead
Shapeinsert_polygon(const Polygon polygon)Use of this method is deprecated. Use insert instead
Shapeinsert_polygon_with_properties(const Polygon polygon,
unsigned int property_id)		Use of this method is deprecated. Use insert instead
Shapeinsert_simple_polygon(const SimplePolygon simple_polygon)Use of this method is deprecated. Use insert instead
Shapeinsert_simple_polygon_with_properties(const SimplePolygon simple_polygon,
unsigned int property_id)		Use of this method is deprecated. Use insert instead
Shapeinsert_text(const Text text)Use of this method is deprecated. Use insert instead
Shapeinsert_text_with_properties(const Text text,
unsigned int property_id)		Use of this method is deprecated. Use insert instead
[static]unsigned ints_allUse of this method is deprecated. Use SAll instead
[static]unsigned ints_all_with_propertiesUse of this method is deprecated. Use SAllWithProperties instead
[static]unsigned ints_boxesUse of this method is deprecated. Use SBoxes instead
[static]unsigned ints_edgesUse of this method is deprecated. Use SEdges instead
[static]unsigned ints_pathsUse of this method is deprecated. Use SPaths instead
[static]unsigned ints_polygonsUse of this method is deprecated. Use SPolygons instead
[static]unsigned ints_propertiesUse of this method is deprecated. Use SProperties instead
[static]unsigned ints_textsUse of this method is deprecated. Use STexts instead
[static]unsigned ints_user_objectsUse of this method is deprecated. Use SUserObjects instead

Detailed description

[static] unsigned int SAll

Description: Indicates that all shapes shall be retrieved

[static] unsigned int SAllWithProperties

Description: Indicates that all shapes with properties shall be retrieved

[static] unsigned int SBoxes

Description: Indicates that boxes shall be retrieved

[static] unsigned int SEdges

Description: Indicates that edges shall be retrieved

[static] unsigned int SPaths

Description: Indicates that paths shall be retrieved

[static] unsigned int SPolygons

Description: Indicates that polygons shall be retrieved

[static] unsigned int SProperties

Description: Indicates that only shapes with properties shall be retrieved

[static] unsigned int STexts

Description: Indicates that texts be retrieved

[static] unsigned int SUserObjects

Description: Indicates that user objects shall be retrieved

[const] void assign(const Shapes 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 clear

Description: Clear the shape container

This method has been introduced in version 0.16. It can only be used in editable mode.

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] Shapes dup

Description: Creates a copy of self

[const,iter] Shape each(unsigned int flags)

Description: Get all shapes

flags:An "or"-ed combination of the S... constants

[const,iter] Shape each

Description: Get all shapes

This call is equivalent to each(SAll). This convenience method has been introduced in version 0.16

[const,iter] Shape each_overlapping(unsigned int flags,const Box region)

Description: Get all shapes that overlap the search box (region)

flags:An "or"-ed combination of the S... constants
region:The rectangular search region

This method was introduced in version 0.16

[const,iter] Shape each_overlapping(const Box region)

Description: Get all shapes that overlap the search box (region)

region:The rectangular search region

This call is equivalent to each_overlapping(SAll,region). This convenience method has been introduced in version 0.16

[const,iter] Shape each_touching(unsigned int flags,const Box region)

Description: Get all shapes that touch the search box (region)

flags:An "or"-ed combination of the S... constants
region:The rectangular search region

This method was introduced in version 0.16

[const,iter] Shape each_touching(const Box region)

Description: Get all shapes that touch the search box (region)

region:The rectangular search region

This call is equivalent to each_touching(SAll,region). This convenience method has been introduced in version 0.16

void erase(const Shape shape)

Description: Erase the shape pointed to by the given Shape object

shape:The shape which to destroy

This method has been introduced in version 0.16. It can only be used in editable mode. Erasing a shape will invalidate the shape reference. Access to this reference may then render invalid results.

[const] Shape find(const Shape shape)

Description: Finds a shape inside this collected

This method has been introduced in version 0.21. This method tries to find the given shape in this collection. The original shape may be located in another collection. If the shape is found, this method returns a reference to the shape in this collection, otherwise a null reference is returned.

Shape insert(const Shape shape)

Description: Insert a shape from a shape reference into the shapes list

Returns:A reference (a Shape object) to the newly created shape

This method has been introduced in version 0.16.

Shape insert(const Shape shape,const Trans trans)

Description: Insert a shape from a shape reference into the shapes list with a transformation

The:shape to insert
The:transformation to apply before the shape is inserted
Returns:A reference (a Shape object) to the newly created shape

This method has been introduced in version 0.22.

Shape insert(const Shape shape,const CplxTrans trans)

Description: Insert a shape from a shape reference into the shapes list with a complex transformation

The:shape to insert
The:transformation to apply before the shape is inserted
Returns:A reference (a Shape object) to the newly created shape

This method has been introduced in version 0.22.

Shape insert(const Shape shape,const ICplxTrans trans)

Description: Insert a shape from a shape reference into the shapes list with a complex integer transformation

The:shape to insert
The:transformation to apply before the shape is inserted
Returns:A reference (a Shape object) to the newly created shape

This method has been introduced in version 0.22.

Shape insert(const Box box)

Description: Insert a box into the shapes list

Returns:A reference to the new shape (a Shape object)

Starting with version 0.16, this method returns a reference to the newly created shape

Shape insert(const Path path)

Description: Insert a path into the shapes list

Returns:A reference to the new shape (a Shape object)

Starting with version 0.16, this method returns a reference to the newly created shape

Shape insert(const Edge edge)

Description: Insert a edge into the shapes list

Starting with version 0.16, this method returns a reference to the newly created shape

Shape insert(const Text text)

Description: Insert a text into the shapes list

Returns:A reference to the new shape (a Shape object)

Starting with version 0.16, this method returns a reference to the newly created shape

Shape insert(const SimplePolygon simple_polygon)

Description: Insert a simple polygon into the shapes list

Returns:A reference to the new shape (a Shape object)

Starting with version 0.16, this method returns a reference to the newly created shape

Shape insert(const Polygon polygon)

Description: Insert a polygon into the shapes list

Returns:A reference to the new shape (a Shape object)

Starting with version 0.16, this method returns a reference to the newly created shape

Shape insert(const Box box,unsigned int property_id)

Description: Insert a box with properties into the shapes list

Returns:A reference to the new shape (a Shape object)

The property Id must be obtained from the Layout object's property_id method which associates a property set with a property Id. Starting with version 0.16, this method returns a reference to the newly created shape

Shape insert(const Path path,unsigned int property_id)

Description: Insert a path with properties into the shapes list

Returns:A reference to the new shape (a Shape object)

The property Id must be obtained from the Layout object's property_id method which associates a property set with a property Id. Starting with version 0.16, this method returns a reference to the newly created shape

Shape insert(const Edge edge,unsigned int property_id)

Description: Insert a edge with properties into the shapes list

Returns:A reference to the new shape (a Shape object)

The property Id must be obtained from the Layout object's property_id method which associates a property set with a property Id. Starting with version 0.16, this method returns a reference to the newly created shape

Shape insert(const Text text,unsigned int property_id)

Description: Insert a text with properties into the shapes list

Returns:A reference to the new shape (a Shape object)

The property Id must be obtained from the Layout object's property_id method which associates a property set with a property Id. Starting with version 0.16, this method returns a reference to the newly created shape

Shape insert(const SimplePolygon simple_polygon,unsigned int property_id)

Description: Insert a simple polygon with properties into the shapes list

Returns:A reference to the new shape (a Shape object)

The property Id must be obtained from the Layout object's property_id method which associates a property set with a property Id. Starting with version 0.16, this method returns a reference to the newly created shape

Shape insert(const Polygon polygon,unsigned int property_id)

Description: Insert a polygon with properties into the shapes list

Returns:A reference to the new shape (a Shape object)

The property Id must be obtained from the Layout object's property_id method which associates a property set with a property Id. Starting with version 0.16, this method returns a reference to the newly created shape

Shape insert_box(const Box box)

Description: Insert a box into the shapes list

Returns:A reference to the new shape (a Shape object)

This method is deprecated. Use method 'insert' instead

Shape insert_box_with_properties(const Box box,unsigned int property_id)

Description: Insert a box with properties into the shapes list

Returns:A reference to the new shape (a Shape object)

This method is deprecated. Use method 'insert' instead

Shape insert_edge(const Edge edge)

Description: Insert a edge into the shapes list

This method is deprecated. Use method 'insert' instead

Shape insert_edge_with_properties(const Edge edge,unsigned int property_id)

Description: Insert a edge with properties into the shapes list

Returns:A reference to the new shape (a Shape object)

This method is deprecated. Use method 'insert' instead

Shape insert_path(const Path path)

Description: Insert a path into the shapes list

Returns:A reference to the new shape (a Shape object)

This method is deprecated. Use method 'insert' instead

Shape insert_path_with_properties(const Path path,unsigned int property_id)

Description: Insert a path with properties into the shapes list

Returns:A reference to the new shape (a Shape object)

This method is deprecated. Use method 'insert' instead

Shape insert_polygon(const Polygon polygon)

Description: Insert a polygon into the shapes list

Returns:A reference to the new shape (a Shape object)

This method is deprecated. Use method 'insert' instead

Shape insert_polygon_with_properties(const Polygon polygon,unsigned int property_id)

Description: Insert a polygon with properties into the shapes list

Returns:A reference to the new shape (a Shape object)

This method is deprecated. Use method 'insert' instead

Shape insert_simple_polygon(const SimplePolygon simple_polygon)

Description: Insert a simple polygon into the shapes list

Returns:A reference to the new shape (a Shape object)

This method is deprecated. Use method 'insert' instead

Shape insert_simple_polygon_with_properties(const SimplePolygon simple_polygon,unsigned int property_id)

Description: Insert a simple polygon with properties into the shapes list

Returns:A reference to the new shape (a Shape object)

This method is deprecated. Use method 'insert' instead

Shape insert_text(const Text text)

Description: Insert a text into the shapes list

Returns:A reference to the new shape (a Shape object)

This method is deprecated. Use method 'insert' instead

Shape insert_text_with_properties(const Text text,unsigned int property_id)

Description: Insert a text with properties into the shapes list

Returns:A reference to the new shape (a Shape object)

This method is deprecated. Use method 'insert' instead

[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.

[const] bool is_empty?

Description: Returns a value indicating whether the shapes container is empty

This method has been introduced in version 0.20.

[const] bool is_valid?(const Shape shape)

Description: Test if the given Shape object is still pointing to a valid object

This method has been introduced in version 0.16. If the shape represented by the given reference has been deleted, this method returns false. If however, another shape has been inserted already that occupies the original shape's position, this method will return true again.

[static] Shapes new

Description: Creates a new object of this class

Shape replace(const Shape shape,const Box box)

Description: Replace the given shape with a box

Returns:A reference to the new shape (a Shape object)

This method has been introduced with version 0.16. It replaces the given shape with the object specified. It does not change the property Id. To change the property Id, use the replace_prop_id method. To replace a shape and discard the property Id, erase the shape and insert a new shape. This method is permitted in editable mode only.

Shape replace(const Shape shape,const Path path)

Description: Replace the given shape with a path

Returns:A reference to the new shape (a Shape object)

This method has been introduced with version 0.16. It replaces the given shape with the object specified. It does not change the property Id. To change the property Id, use the replace_prop_id method. To replace a shape and discard the property Id, erase the shape and insert a new shape. This method is permitted in editable mode only.

Shape replace(const Shape shape,const Edge edge)

Description: Replace the given shape with an edge object

This method has been introduced with version 0.16. It replaces the given shape with the object specified. It does not change the property Id. To change the property Id, use the replace_prop_id method. To replace a shape and discard the property Id, erase the shape and insert a new shape. This method is permitted in editable mode only.

Shape replace(const Shape shape,const Text text)

Description: Replace the given shape with a text object

Returns:A reference to the new shape (a Shape object)

This method has been introduced with version 0.16. It replaces the given shape with the object specified. It does not change the property Id. To change the property Id, use the replace_prop_id method. To replace a shape and discard the property Id, erase the shape and insert a new shape. This method is permitted in editable mode only.

Shape replace(const Shape shape,const SimplePolygon simple_polygon)

Description: Replace the given shape with a simple polygon

Returns:A reference to the new shape (a Shape object)

This method has been introduced with version 0.16. It replaces the given shape with the object specified. It does not change the property Id. To change the property Id, use the replace_prop_id method. To replace a shape and discard the property Id, erase the shape and insert a new shape. This method is permitted in editable mode only.

Shape replace(const Shape shape,const Polygon polygon)

Description: Replace the given shape with a polygon

Returns:A reference to the new shape (a Shape object)

This method has been introduced with version 0.16. It replaces the given shape with the object specified. It does not change the property Id. To change the property Id, use the replace_prop_id method. To replace a shape and discard the property Id, erase the shape and insert a new shape. This method is permitted in editable mode only.

Shape replace_prop_id(const Shape shape,unsigned int property_id)

Description: Replace (or install) the properties of a shape

Returns:A Shape object representing the new shape

This method has been introduced in version 0.16. It can only be used in editable mode. Changes the properties Id of the given shape or install a properties Id on that shape if it does not have one yet. The property Id must be obtained from the Layout object's property_id method which associates a property set with a property Id. This method will potentially invalidate the shape reference passed to it. Use the reference returned for future references.

[static] unsigned int s_all

Description: Indicates that all shapes shall be retrieved

This method is deprecated. Use method 'SAll' instead

[static] unsigned int s_all_with_properties

Description: Indicates that all shapes with properties shall be retrieved

This method is deprecated. Use method 'SAllWithProperties' instead

[static] unsigned int s_boxes

Description: Indicates that boxes shall be retrieved

This method is deprecated. Use method 'SBoxes' instead

[static] unsigned int s_edges

Description: Indicates that edges shall be retrieved

This method is deprecated. Use method 'SEdges' instead

[static] unsigned int s_paths

Description: Indicates that paths shall be retrieved

This method is deprecated. Use method 'SPaths' instead

[static] unsigned int s_polygons

Description: Indicates that polygons shall be retrieved

This method is deprecated. Use method 'SPolygons' instead

[static] unsigned int s_properties

Description: Indicates that only shapes with properties shall be retrieved

This method is deprecated. Use method 'SProperties' instead

[static] unsigned int s_texts

Description: Indicates that texts be retrieved

This method is deprecated. Use method 'STexts' instead

[static] unsigned int s_user_objects

Description: Indicates that user objects shall be retrieved

This method is deprecated. Use method 'SUserObjects' instead

[const] unsigned int size

Description: Report the number of shapes in this container

Returns:The number of shapes in this container

This method was introduced in version 0.16

Shape transform(const Shape shape,const Trans trans)

Description: Transform the shape given by the reference with the given transformation

Returns:A reference (a Shape object) to the new shape

This method has been introduced in version 0.16. The original shape may be deleted and re-inserted by this method. Therefore, a new reference is returned. It is permitted in editable mode only.

Shape transform(const Shape shape,const CplxTrans trans)

Description: Transform the shape given by the reference with the given complex transformation

Returns:A reference (a Shape object) to the new shape

This method has been introduced in version 0.16. The original shape may be deleted and re-inserted by this method. Therefore, a new reference is returned. It is permitted in editable mode only.

Shape transform(const Shape shape,const ICplxTrans trans)

Description: Transform the shape given by the reference with the given complex integer space transformation

Returns:A reference (a Shape object) to the new shape

This method has been introduced in version 0.22. The original shape may be deleted and re-inserted by this method. Therefore, a new reference is returned. It is permitted in editable mode only.