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

new Shapes ptrnewCreates a new object of this class

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const Shapes other)Assigns another object to self
voidclearClears the shape container
[const]new Shapes ptrdupCreates a copy of self
[const,iter]Shapeeach(unsigned int flags)Gets all shapes
[const,iter]ShapeeachGets all shapes
[const,iter]Shapeeach_overlapping(unsigned int flags,
const Box region)
Gets all shapes that overlap the search box (region)
[const,iter]Shapeeach_overlapping(unsigned int flags,
const DBox region)
Gets all shapes that overlap the search box (region) where the search box is given in micrometer units
[const,iter]Shapeeach_overlapping(const Box region)Gets all shapes that overlap the search box (region)
[const,iter]Shapeeach_overlapping(const DBox region)Gets all shapes that overlap the search box (region) where the search box is given in micrometer units
[const,iter]Shapeeach_touching(unsigned int flags,
const Box region)
Gets all shapes that touch the search box (region)
[const,iter]Shapeeach_touching(unsigned int flags,
const DBox region)
Gets all shapes that touch the search box (region) where the search box is given in micrometer units
[const,iter]Shapeeach_touching(const Box region)Gets all shapes that touch the search box (region)
[const,iter]Shapeeach_touching(const DBox region)Gets all shapes that touch the search box (region) where the search box is given in micrometer units
voiderase(const Shape shape)Erases the shape pointed to by the given Shape object
[const]Shapefind(const Shape shape)Finds a shape inside this collected
Shapeinsert(const Shape shape)Inserts a shape from a shape reference into the shapes list
Shapeinsert(const Shape shape,
const Trans trans)
Inserts a shape from a shape reference into the shapes list with a transformation
Shapeinsert(const Shape shape,
const DTrans trans)
Inserts a shape from a shape reference into the shapes list with a transformation (given in micrometer units)
Shapeinsert(const Shape shape,
const ICplxTrans trans)
Inserts a shape from a shape reference into the shapes list with a complex integer transformation
Shapeinsert(const Shape shape,
const DCplxTrans trans)
Inserts a shape from a shape reference into the shapes list with a complex integer transformation (given in micrometer units)
voidinsert(const RecursiveShapeIterator iter)Inserts the shapes taken from a recursive shape iterator
voidinsert(const RecursiveShapeIterator iter,
const ICplxTrans trans)
Inserts the shapes taken from a recursive shape iterator with a transformation
voidinsert(const Shapes shapes)Inserts the shapes taken from another shape container
voidinsert(const Shapes shapes,
const ICplxTrans trans)
Inserts the shapes taken from another shape container with a transformation
voidinsert(const Shapes shapes,
unsigned int flags)
Inserts the shapes taken from another shape container
voidinsert(const Shapes shapes,
unsigned int flags,
const ICplxTrans trans)
Inserts the shapes taken from another shape container with a transformation
voidinsert(const Region region)Inserts the polygons from the region into this shape container
voidinsert(const Region region,
const ICplxTrans trans)
Inserts the polygons from the region into this shape container with a transformation
voidinsert(const Region region,
const DCplxTrans trans)
Inserts the polygons from the region into this shape container with a transformation (given in micrometer units)
voidinsert(const Edges edges)Inserts the edges from the edge collection into this shape container
voidinsert(const Edges edges,
const ICplxTrans trans)
Inserts the edges from the edge collection into this shape container with a transformation
voidinsert(const Edges edges,
const DCplxTrans trans)
Inserts the edges from the edge collection into this shape container with a transformation (given in micrometer units)
Shapeinsert(const Box box)Inserts a box into the shapes list
Shapeinsert(const DBox box)Inserts a micrometer-unit box into the shapes list
Shapeinsert(const Path path)Inserts a path into the shapes list
Shapeinsert(const DPath path)Inserts a micrometer-unit path into the shapes list
Shapeinsert(const Edge edge)Inserts a edge into the shapes list
Shapeinsert(const DEdge edge)Inserts a micrometer-unit edge into the shapes list
Shapeinsert(const Text text)Inserts a text into the shapes list
Shapeinsert(const DText text)Inserts a micrometer-unit text into the shapes list
Shapeinsert(const SimplePolygon simple_polygon)Inserts a simple polygon into the shapes list
Shapeinsert(const DSimplePolygon simple_polygon)Inserts a micrometer-unit simple polygon into the shapes list
Shapeinsert(const Polygon polygon)Inserts a polygon into the shapes list
Shapeinsert(const DPolygon polygon)Inserts a micrometer-unit polygon into the shapes list
Shapeinsert(const Box box,
unsigned long property_id)
Inserts a box with properties into the shapes list
Shapeinsert(const DBox box,
unsigned long property_id)
Inserts a micrometer-unit box with properties into the shapes list
Shapeinsert(const Path path,
unsigned long property_id)
Inserts a path with properties into the shapes list
Shapeinsert(const DPath path,
unsigned long property_id)
Inserts a micrometer-unit path with properties into the shapes list
Shapeinsert(const Edge edge,
unsigned long property_id)
Inserts a edge with properties into the shapes list
Shapeinsert(const DEdge edge,
unsigned long property_id)
Inserts a micrometer-unit edge with properties into the shapes list
Shapeinsert(const Text text,
unsigned long property_id)
Inserts a text with properties into the shapes list
Shapeinsert(const DText text,
unsigned long property_id)
Inserts a micrometer-unit text with properties into the shapes list
Shapeinsert(const SimplePolygon simple_polygon,
unsigned long property_id)
Inserts a simple polygon with properties into the shapes list
Shapeinsert(const DSimplePolygon simple_polygon,
unsigned long property_id)
Inserts a micrometer-unit simple polygon with properties into the shapes list
Shapeinsert(const Polygon polygon,
unsigned long property_id)
Inserts a polygon with properties into the shapes list
Shapeinsert(const DPolygon polygon,
unsigned long property_id)
Inserts a micrometer-unit polygon with properties into the shapes list
voidinsert_as_edges(const EdgePairs edge_pairs)Inserts the edge pairs from the edge pair collection as individual edges into this shape container
voidinsert_as_edges(const EdgePairs edge_pairs,
const ICplxTrans trans)
Inserts the edge pairs from the edge pair collection as individual into this shape container with a transformation
voidinsert_as_edges(const EdgePairs edge_pairs,
const DCplxTrans trans)
Inserts the edge pairs from the edge pair collection as individual into this shape container with a transformation (given in micrometer units)
voidinsert_as_polygons(const EdgePairs edge_pairs,
int e)
Inserts the edge pairs from the edge pair collection as polygons into this shape container
voidinsert_as_polygons(const EdgePairs edge_pairs,
double e)
Inserts the edge pairs from the edge pair collection as polygons into this shape container
voidinsert_as_polygons(const EdgePairs edge_pairs,
const ICplxTrans e,
int trans)
Inserts the edge pairs from the edge pair collection as polygons into this shape container with a transformation
voidinsert_as_polygons(const EdgePairs edge_pairs,
const DCplxTrans e,
double trans)
Inserts the edge pairs from the edge pair collection as polygons into this shape container with a transformation
[const]boolis_empty?Returns a value indicating whether the shapes container is empty
[const]boolis_valid?(const Shape shape)Tests if the given Shape object is still pointing to a valid object
Shapereplace(const Shape shape,
const Box box)
Replaces the given shape with a box
Shapereplace(const Shape shape,
const DBox box)
Replaces the given shape with a box given in micrometer units
Shapereplace(const Shape shape,
const Path path)
Replaces the given shape with a path
Shapereplace(const Shape shape,
const DPath path)
Replaces the given shape with a path given in micrometer units
Shapereplace(const Shape shape,
const Edge edge)
Replaces the given shape with an edge object
Shapereplace(const Shape shape,
const DEdge edge)
Replaces the given shape with a edge given in micrometer units
Shapereplace(const Shape shape,
const Text text)
Replaces the given shape with a text object
Shapereplace(const Shape shape,
const DText text)
Replaces the given shape with a text given in micrometer units
Shapereplace(const Shape shape,
const SimplePolygon simple_polygon)
Replaces the given shape with a simple polygon
Shapereplace(const Shape shape,
const DSimplePolygon simple_polygon)
Replaces the given shape with a simple polygon given in micrometer units
Shapereplace(const Shape shape,
const Polygon polygon)
Replaces the given shape with a polygon
Shapereplace(const Shape shape,
const DPolygon polygon)
Replaces the given shape with a polygon given in micrometer units
Shapereplace_prop_id(const Shape shape,
unsigned long property_id)
Replaces (or install) the properties of a shape
[const]unsigned longsizeGets the number of shapes in this container
voidtransform(const Trans trans)Transforms all shapes with the given transformation
voidtransform(const DTrans trans)Transforms all shapes with the given transformation (given in micrometer units)
voidtransform(const ICplxTrans trans)Transforms all shapes with the given complex integer transformation
voidtransform(const DCplxTrans trans)Transforms all shapes with the given transformation (given in micrometer units)
Shapetransform(const Shape shape,
const Trans trans)
Transforms the shape given by the reference with the given transformation
Shapetransform(const Shape shape,
const DTrans trans)
Transforms the shape given by the reference with the given transformation, where the transformation is given in micrometer units
Shapetransform(const Shape shape,
const ICplxTrans trans)
Transforms the shape given by the reference with the given complex integer space transformation
Shapetransform(const Shape shape,
const DCplxTrans trans)
Transforms the shape given by the reference with the given complex transformation, where the transformation is given in micrometer units

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)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
Shapeinsert_box(const Box box)Use of this method is deprecated. Use insert instead
Shapeinsert_box_with_properties(const Box box,
unsigned long 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 long 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 long 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 long 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 long 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 long property_id)
Use of this method is deprecated. Use insert instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? 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

SAll

Signature: [static] unsigned int SAll

Description: Indicates that all shapes shall be retrieved

SAllWithProperties

Signature: [static] unsigned int SAllWithProperties

Description: Indicates that all shapes with properties shall be retrieved

SBoxes

Signature: [static] unsigned int SBoxes

Description: Indicates that boxes shall be retrieved

SEdges

Signature: [static] unsigned int SEdges

Description: Indicates that edges shall be retrieved

SPaths

Signature: [static] unsigned int SPaths

Description: Indicates that paths shall be retrieved

SPolygons

Signature: [static] unsigned int SPolygons

Description: Indicates that polygons shall be retrieved

SProperties

Signature: [static] unsigned int SProperties

Description: Indicates that only shapes with properties shall be retrieved

STexts

Signature: [static] unsigned int STexts

Description: Indicates that texts be retrieved

SUserObjects

Signature: [static] unsigned int SUserObjects

Description: Indicates that user objects shall be retrieved

_create

Signature: 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.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

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

_destroyed?

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

_is_const_object?

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

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: void assign (const Shapes other)

Description: Assigns another object to self

clear

Signature: void clear

Description: Clears the shape container

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

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

destroyed?

Signature: [const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

dup

Signature: [const] new Shapes ptr dup

Description: Creates a copy of self

each

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

Description: Gets all shapes

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

Signature: [const,iter] Shape each

Description: Gets all shapes

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

each_overlapping

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

Description: Gets 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

Signature: [const,iter] Shape each_overlapping (unsigned int flags,const DBox region)

Description: Gets all shapes that overlap the search box (region) where the search box is given in micrometer units

flags:An "or"-ed combination of the S... constants
region:The rectangular search region as a DBox object in micrometer units

This method was introduced in version 0.25

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

Description: Gets 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

Signature: [const,iter] Shape each_overlapping (const DBox region)

Description: Gets all shapes that overlap the search box (region) where the search box is given in micrometer units

region:The rectangular search region as a DBox object in micrometer units

This call is equivalent to each_touching(SAll,region).

This method was introduced in version 0.25

each_touching

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

Description: Gets 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

Signature: [const,iter] Shape each_touching (unsigned int flags,const DBox region)

Description: Gets all shapes that touch the search box (region) where the search box is given in micrometer units

flags:An "or"-ed combination of the S... constants
region:The rectangular search region as a DBox object in micrometer units

This method was introduced in version 0.25

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

Description: Gets 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

Signature: [const,iter] Shape each_touching (const DBox region)

Description: Gets all shapes that touch the search box (region) where the search box is given in micrometer units

region:The rectangular search region as a DBox object in micrometer units

This call is equivalent to each_touching(SAll,region).

This method was introduced in version 0.25

erase

Signature: void erase (const Shape shape)

Description: Erases 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.

find

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

insert

Signature: Shape insert (const Shape shape)

Description: Inserts 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.

Signature: Shape insert (const Shape shape,const Trans trans)

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

shape:The shape to insert
trans: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.

Signature: Shape insert (const Shape shape,const DTrans trans)

Description: Inserts a shape from a shape reference into the shapes list with a transformation (given in micrometer units)

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

This method has been introduced in version 0.25.

Signature: Shape insert (const Shape shape,const ICplxTrans trans)

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

shape:The shape to insert
trans: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.

Signature: Shape insert (const Shape shape,const DCplxTrans trans)

Description: Inserts a shape from a shape reference into the shapes list with a complex integer transformation (given in micrometer units)

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

This method has been introduced in version 0.25.

Signature: void insert (const RecursiveShapeIterator iter)

Description: Inserts the shapes taken from a recursive shape iterator

iter:The iterator from which to take the shapes from

This method iterates over all shapes from the iterator and inserts them into the container.

This method has been introduced in version 0.25.3.

Signature: void insert (const RecursiveShapeIterator iter,const ICplxTrans trans)

Description: Inserts the shapes taken from a recursive shape iterator with a transformation

iter:The iterator from which to take the shapes from
trans:The transformation to apply

This method iterates over all shapes from the iterator and inserts them into the container. The given transformation is applied before the shapes are inserted.

This method has been introduced in version 0.25.3.

Signature: void insert (const Shapes shapes)

Description: Inserts the shapes taken from another shape container

shapes:The other container from which to take the shapes from

This method takes all shapes from the given container and inserts them into this one.

This method has been introduced in version 0.25.3.

Signature: void insert (const Shapes shapes,const ICplxTrans trans)

Description: Inserts the shapes taken from another shape container with a transformation

shapes:The other container from which to take the shapes from
trans:The transformation to apply

This method takes all shapes from the given container and inserts them into this one after applying the given transformation.

This method has been introduced in version 0.25.3.

Signature: void insert (const Shapes shapes,unsigned int flags)

Description: Inserts the shapes taken from another shape container

shapes:The other container from which to take the shapes from
flags:The filter flags for taking the shapes from the input container (see S... constants)

This method takes all selected shapes from the given container and inserts them into this one.

This method has been introduced in version 0.25.3.

Signature: void insert (const Shapes shapes,unsigned int flags,const ICplxTrans trans)

Description: Inserts the shapes taken from another shape container with a transformation

shapes:The other container from which to take the shapes from
flags:The filter flags for taking the shapes from the input container (see S... constants)
trans:The transformation to apply

This method takes all selected shapes from the given container and inserts them into this one after applying the given transformation.

This method has been introduced in version 0.25.3.

Signature: void insert (const Region region)

Description: Inserts the polygons from the region into this shape container

region:The region to insert

This method inserts all polygons from the region into this shape container.

This method has been introduced in version 0.23.

Signature: void insert (const Region region,const ICplxTrans trans)

Description: Inserts the polygons from the region into this shape container with a transformation

region:The region to insert
trans:The transformation to apply

This method inserts all polygons from the region into this shape container. Before a polygon is inserted, the given transformation is applied.

This method has been introduced in version 0.23.

Signature: void insert (const Region region,const DCplxTrans trans)

Description: Inserts the polygons from the region into this shape container with a transformation (given in micrometer units)

region:The region to insert
trans:The transformation to apply (displacement in micrometer units)

This method inserts all polygons from the region into this shape container. Before a polygon is inserted, the given transformation is applied.

This method has been introduced in version 0.25.

Signature: void insert (const Edges edges)

Description: Inserts the edges from the edge collection into this shape container

edges:The edges to insert

This method inserts all edges from the edge collection into this shape container.

This method has been introduced in version 0.23.

Signature: void insert (const Edges edges,const ICplxTrans trans)

Description: Inserts the edges from the edge collection into this shape container with a transformation

edges:The edges to insert
trans:The transformation to apply

This method inserts all edges from the edge collection into this shape container. Before an edge is inserted, the given transformation is applied.

This method has been introduced in version 0.23.

Signature: void insert (const Edges edges,const DCplxTrans trans)

Description: Inserts the edges from the edge collection into this shape container with a transformation (given in micrometer units)

edges:The edges to insert
trans:The transformation to apply (displacement in micrometer units)

This method inserts all edges from the edge collection into this shape container. Before an edge is inserted, the given transformation is applied.

This method has been introduced in version 0.25.

Signature: Shape insert (const Box box)

Description: Inserts 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

Signature: Shape insert (const DBox box)

Description: Inserts a micrometer-unit box into the shapes list

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

This method behaves like the insert version with a Box argument, except that it will internally translate the box from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape insert (const Path path)

Description: Inserts 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

Signature: Shape insert (const DPath path)

Description: Inserts a micrometer-unit path into the shapes list

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

This method behaves like the insert version with a Path argument, except that it will internally translate the path from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape insert (const Edge edge)

Description: Inserts a edge into the shapes list

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

Signature: Shape insert (const DEdge edge)

Description: Inserts a micrometer-unit edge into the shapes list

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

This method behaves like the insert version with a Edge argument, except that it will internally translate the edge from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape insert (const Text text)

Description: Inserts 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

Signature: Shape insert (const DText text)

Description: Inserts a micrometer-unit text into the shapes list

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

This method behaves like the insert version with a Text argument, except that it will internally translate the text from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape insert (const SimplePolygon simple_polygon)

Description: Inserts 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

Signature: Shape insert (const DSimplePolygon simple_polygon)

Description: Inserts a micrometer-unit simple polygon into the shapes list

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

This method behaves like the insert version with a SimplePolygon argument, except that it will internally translate the polygon from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape insert (const Polygon polygon)

Description: Inserts 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

Signature: Shape insert (const DPolygon polygon)

Description: Inserts a micrometer-unit polygon into the shapes list

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

This method behaves like the insert version with a Polygon argument, except that it will internally translate the polygon from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape insert (const Box box,unsigned long property_id)

Description: Inserts 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

Signature: Shape insert (const DBox box,unsigned long property_id)

Description: Inserts a micrometer-unit box with properties into the shapes list

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

This method behaves like the insert version with a Box argument and a property ID, except that it will internally translate the box from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape insert (const Path path,unsigned long property_id)

Description: Inserts 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

Signature: Shape insert (const DPath path,unsigned long property_id)

Description: Inserts a micrometer-unit path with properties into the shapes list

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

This method behaves like the insert version with a Path argument and a property ID, except that it will internally translate the path from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape insert (const Edge edge,unsigned long property_id)

Description: Inserts 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

Signature: Shape insert (const DEdge edge,unsigned long property_id)

Description: Inserts a micrometer-unit edge with properties into the shapes list

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

This method behaves like the insert version with a Edge argument and a property ID, except that it will internally translate the edge from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape insert (const Text text,unsigned long property_id)

Description: Inserts 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

Signature: Shape insert (const DText text,unsigned long property_id)

Description: Inserts a micrometer-unit text with properties into the shapes list

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

This method behaves like the insert version with a Text argument and a property ID, except that it will internally translate the text from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape insert (const SimplePolygon simple_polygon,unsigned long property_id)

Description: Inserts 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

Signature: Shape insert (const DSimplePolygon simple_polygon,unsigned long property_id)

Description: Inserts a micrometer-unit simple polygon with properties into the shapes list

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

This method behaves like the insert version with a SimplePolygon argument and a property ID, except that it will internally translate the simple polygon from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape insert (const Polygon polygon,unsigned long property_id)

Description: Inserts 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

Signature: Shape insert (const DPolygon polygon,unsigned long property_id)

Description: Inserts a micrometer-unit polygon with properties into the shapes list

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

This method behaves like the insert version with a Polygon argument and a property ID, except that it will internally translate the polygon from micrometer to database units.

This variant has been introduced in version 0.25.

insert_as_edges

Signature: void insert_as_edges (const EdgePairs edge_pairs)

Description: Inserts the edge pairs from the edge pair collection as individual edges into this shape container

edge_pairs:The edge pairs to insert

This method inserts all edge pairs from the edge pair collection into this shape container. Each edge from the edge pair is inserted individually into the shape container.

This method has been introduced in version 0.23.

Signature: void insert_as_edges (const EdgePairs edge_pairs,const ICplxTrans trans)

Description: Inserts the edge pairs from the edge pair collection as individual into this shape container with a transformation

edges:The edge pairs to insert
trans:The transformation to apply

This method inserts all edge pairs from the edge pair collection into this shape container. Each edge from the edge pair is inserted individually into the shape container. Before each edge is inserted into the shape collection, the given transformation is applied.

This method has been introduced in version 0.23.

Signature: void insert_as_edges (const EdgePairs edge_pairs,const DCplxTrans trans)

Description: Inserts the edge pairs from the edge pair collection as individual into this shape container with a transformation (given in micrometer units)

edges:The edge pairs to insert
trans:The transformation to apply (displacement in micrometer units)

This method inserts all edge pairs from the edge pair collection into this shape container. Each edge from the edge pair is inserted individually into the shape container. Before each edge is inserted into the shape collection, the given transformation is applied.

This method has been introduced in version 0.25.

insert_as_polygons

Signature: void insert_as_polygons (const EdgePairs edge_pairs,int e)

Description: Inserts the edge pairs from the edge pair collection as polygons into this shape container

edge_pairs:The edge pairs to insert
e:The extension to apply when converting the edges to polygons (in database units)

This method inserts all edge pairs from the edge pair collection into this shape container. The edge pairs are converted to polygons covering the area between the edges. The extension parameter specifies a sizing which is applied when converting the edge pairs to polygons. This way, degenerated edge pairs (i.e. two point-like edges) do not vanish.

This method has been introduced in version 0.23.

Signature: void insert_as_polygons (const EdgePairs edge_pairs,double e)

Description: Inserts the edge pairs from the edge pair collection as polygons into this shape container

edge_pairs:The edge pairs to insert
e:The extension to apply when converting the edges to polygons (in micrometer units)

This method is identical to the version with a integer-type e parameter, but for this version the e parameter is given in micrometer units.

This method has been introduced in version 0.25.

Signature: void insert_as_polygons (const EdgePairs edge_pairs,const ICplxTrans e,int trans)

Description: Inserts the edge pairs from the edge pair collection as polygons into this shape container with a transformation

edges:The edge pairs to insert
e:The extension to apply when converting the edges to polygons (in database units)
trans:The transformation to apply

This method inserts all edge pairs from the edge pair collection into this shape container. The edge pairs are converted to polygons covering the area between the edges. The extension parameter specifies a sizing which is applied when converting the edge pairs to polygons. This way, degenerated edge pairs (i.e. two point-like edges) do not vanish. Before a polygon is inserted into the shape collection, the given transformation is applied.

This method has been introduced in version 0.23.

Signature: void insert_as_polygons (const EdgePairs edge_pairs,const DCplxTrans e,double trans)

Description: Inserts the edge pairs from the edge pair collection as polygons into this shape container with a transformation

edges:The edge pairs to insert
e:The extension to apply when converting the edges to polygons (in micrometer units)
trans:The transformation to apply (displacement in micrometer units)

This method is identical to the version with a integer-type e and trans parameter, but for this version the e parameter is given in micrometer units and the trans parameter is a micrometer-unit transformation.

This method has been introduced in version 0.25.

insert_box

Signature: Shape insert_box (const Box box)

Description: Inserts a box into the shapes list

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

Use of this method is deprecated. Use insert instead

insert_box_with_properties

Signature: Shape insert_box_with_properties (const Box box,unsigned long property_id)

Description: Inserts a box with properties into the shapes list

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

Use of this method is deprecated. Use insert instead

insert_edge

Signature: Shape insert_edge (const Edge edge)

Description: Inserts a edge into the shapes list

Use of this method is deprecated. Use insert instead

insert_edge_with_properties

Signature: Shape insert_edge_with_properties (const Edge edge,unsigned long property_id)

Description: Inserts a edge with properties into the shapes list

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

Use of this method is deprecated. Use insert instead

insert_path

Signature: Shape insert_path (const Path path)

Description: Inserts a path into the shapes list

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

Use of this method is deprecated. Use insert instead

insert_path_with_properties

Signature: Shape insert_path_with_properties (const Path path,unsigned long property_id)

Description: Inserts a path with properties into the shapes list

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

Use of this method is deprecated. Use insert instead

insert_polygon

Signature: Shape insert_polygon (const Polygon polygon)

Description: Inserts a polygon into the shapes list

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

Use of this method is deprecated. Use insert instead

insert_polygon_with_properties

Signature: Shape insert_polygon_with_properties (const Polygon polygon,unsigned long property_id)

Description: Inserts a polygon with properties into the shapes list

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

Use of this method is deprecated. Use insert instead

insert_simple_polygon

Signature: Shape insert_simple_polygon (const SimplePolygon simple_polygon)

Description: Inserts a simple polygon into the shapes list

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

Use of this method is deprecated. Use insert instead

insert_simple_polygon_with_properties

Signature: Shape insert_simple_polygon_with_properties (const SimplePolygon simple_polygon,unsigned long property_id)

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

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

Use of this method is deprecated. Use insert instead

insert_text

Signature: Shape insert_text (const Text text)

Description: Inserts a text into the shapes list

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

Use of this method is deprecated. Use insert instead

insert_text_with_properties

Signature: Shape insert_text_with_properties (const Text text,unsigned long property_id)

Description: Inserts a text with properties into the shapes list

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

Use of this method is deprecated. Use insert instead

is_const_object?

Signature: [const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

is_empty?

Signature: [const] bool is_empty?

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

This method has been introduced in version 0.20.

is_valid?

Signature: [const] bool is_valid? (const Shape shape)

Description: Tests 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.

new

Signature: [static] new Shapes ptr new

Description: Creates a new object of this class

Python specific notes:
This method is the default initializer of the object

replace

Signature: Shape replace (const Shape shape,const Box box)

Description: Replaces 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.

Signature: Shape replace (const Shape shape,const DBox box)

Description: Replaces the given shape with a box given in micrometer units

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

This method behaves like the replace version with a Box argument, except that it will internally translate the box from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape replace (const Shape shape,const Path path)

Description: Replaces 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.

Signature: Shape replace (const Shape shape,const DPath path)

Description: Replaces the given shape with a path given in micrometer units

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

This method behaves like the replace version with a Path argument, except that it will internally translate the path from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape replace (const Shape shape,const Edge edge)

Description: Replaces 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.

Signature: Shape replace (const Shape shape,const DEdge edge)

Description: Replaces the given shape with a edge given in micrometer units

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

This method behaves like the replace version with an Edge argument, except that it will internally translate the edge from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape replace (const Shape shape,const Text text)

Description: Replaces 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.

Signature: Shape replace (const Shape shape,const DText text)

Description: Replaces the given shape with a text given in micrometer units

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

This method behaves like the replace version with a Text argument, except that it will internally translate the text from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape replace (const Shape shape,const SimplePolygon simple_polygon)

Description: Replaces 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.

Signature: Shape replace (const Shape shape,const DSimplePolygon simple_polygon)

Description: Replaces the given shape with a simple polygon given in micrometer units

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

This method behaves like the replace version with a SimplePolygon argument, except that it will internally translate the simple polygon from micrometer to database units.

This variant has been introduced in version 0.25.

Signature: Shape replace (const Shape shape,const Polygon polygon)

Description: Replaces 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.

Signature: Shape replace (const Shape shape,const DPolygon polygon)

Description: Replaces the given shape with a polygon given in micrometer units

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

This method behaves like the replace version with a Polygon argument, except that it will internally translate the polygon from micrometer to database units.

This variant has been introduced in version 0.25.

replace_prop_id

Signature: Shape replace_prop_id (const Shape shape,unsigned long property_id)

Description: Replaces (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.

s_all

Signature: [static] unsigned int s_all

Description: Indicates that all shapes shall be retrieved

Use of this method is deprecated. Use SAll instead

s_all_with_properties

Signature: [static] unsigned int s_all_with_properties

Description: Indicates that all shapes with properties shall be retrieved

Use of this method is deprecated. Use SAllWithProperties instead

s_boxes

Signature: [static] unsigned int s_boxes

Description: Indicates that boxes shall be retrieved

Use of this method is deprecated. Use SBoxes instead

s_edges

Signature: [static] unsigned int s_edges

Description: Indicates that edges shall be retrieved

Use of this method is deprecated. Use SEdges instead

s_paths

Signature: [static] unsigned int s_paths

Description: Indicates that paths shall be retrieved

Use of this method is deprecated. Use SPaths instead

s_polygons

Signature: [static] unsigned int s_polygons

Description: Indicates that polygons shall be retrieved

Use of this method is deprecated. Use SPolygons instead

s_properties

Signature: [static] unsigned int s_properties

Description: Indicates that only shapes with properties shall be retrieved

Use of this method is deprecated. Use SProperties instead

s_texts

Signature: [static] unsigned int s_texts

Description: Indicates that texts be retrieved

Use of this method is deprecated. Use STexts instead

s_user_objects

Signature: [static] unsigned int s_user_objects

Description: Indicates that user objects shall be retrieved

Use of this method is deprecated. Use SUserObjects instead

size

Signature: [const] unsigned long size

Description: Gets the number of shapes in this container

Returns:The number of shapes in this container

This method was introduced in version 0.16

Python specific notes:
This method is also available as 'len(object)'

transform

Signature: void transform (const Trans trans)

Description: Transforms all shapes with the given transformation

This method will invalidate all references to shapes inside this collection.

It has been introduced in version 0.23.

Signature: void transform (const DTrans trans)

Description: Transforms all shapes with the given transformation (given in micrometer units)

This method will invalidate all references to shapes inside this collection. The displacement of the transformation is given in micrometer units.

It has been introduced in version 0.25.

Signature: void transform (const ICplxTrans trans)

Description: Transforms all shapes with the given complex integer transformation

This method will invalidate all references to shapes inside this collection.

It has been introduced in version 0.23.

Signature: void transform (const DCplxTrans trans)

Description: Transforms all shapes with the given transformation (given in micrometer units)

This method will invalidate all references to shapes inside this collection. The displacement of the transformation is given in micrometer units.

It has been introduced in version 0.25.

Signature: Shape transform (const Shape shape,const Trans trans)

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

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

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.

This method has been introduced in version 0.16.

Signature: Shape transform (const Shape shape,const DTrans trans)

Description: Transforms the shape given by the reference with the given transformation, where the transformation is given in micrometer units

trans:The transformation to apply (displacement in micrometer units)
Returns:A reference (a Shape object) to the new shape

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. This method has been introduced in version 0.25.

Signature: Shape transform (const Shape shape,const ICplxTrans trans)

Description: Transforms 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.

Signature: Shape transform (const Shape shape,const DCplxTrans trans)

Description: Transforms the shape given by the reference with the given complex transformation, where the transformation is given in micrometer units

trans:The transformation to apply (displacement in micrometer units)
Returns:A reference (a Shape object) to the new shape

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. This method has been introduced in version 0.25.