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

API reference - Class Shapes

Description: A collection of shapes

Public constructors
Public methods
Public static methods and constants
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description

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 ptr

new

Creates a new object of this class

Public methods

	void	_create		Ensures the C++ object is created
	void	_destroy		Explicitly 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	_manage		Marks the object as managed by the script side.
	void	_unmanage		Marks the object as no longer owned by the script side.
	void	assign	(const Shapes other)	Assigns another object to self
	void	clear		Clear the shape container
[const]	new Shapes ptr	dup		Creates a copy of self
[const,iter]	Shape	each	(unsigned int flags)	Get all shapes
[const,iter]	Shape	each		Get all shapes
[const,iter]	Shape	each_overlapping	(unsigned int flags, const Box region)	Get all shapes that overlap the search box (region)
[const,iter]	Shape	each_overlapping	(const Box region)	Get all shapes that overlap the search box (region)
[const,iter]	Shape	each_touching	(unsigned int flags, const Box region)	Get all shapes that touch the search box (region)
[const,iter]	Shape	each_touching	(const Box region)	Get all shapes that touch the search box (region)
	void	erase	(const Shape shape)	Erase the shape pointed to by the given Shape object
[const]	Shape	find	(const Shape shape)	Finds a shape inside this collected
	Shape	insert	(const Shape shape)	Insert a shape from a shape reference into the shapes list
	Shape	insert	(const Shape shape, const Trans trans)	Insert a shape from a shape reference into the shapes list with a transformation
	Shape	insert	(const Shape shape, const CplxTrans trans)	Insert a shape from a shape reference into the shapes list with a complex transformation
	Shape	insert	(const Shape shape, const ICplxTrans trans)	Insert a shape from a shape reference into the shapes list with a complex integer transformation
	void	insert	(const Region region)	Insert the polygons from the region into this shape container
	void	insert	(const Region region, const ICplxTrans trans)	Insert the polygons from the region into this shape container with a transformation
	void	insert	(const Edges edges)	Insert the edges from the edge collection into this shape container
	void	insert	(const Edges edges, const ICplxTrans trans)	Insert the edges from the edge collection into this shape container with a transformation
	Shape	insert	(const Box box)	Insert a box into the shapes list
	Shape	insert	(const Path path)	Insert a path into the shapes list
	Shape	insert	(const Edge edge)	Insert a edge into the shapes list
	Shape	insert	(const Text text)	Insert a text into the shapes list
	Shape	insert	(const SimplePolygon simple_polygon)	Insert a simple polygon into the shapes list
	Shape	insert	(const Polygon polygon)	Insert a polygon into the shapes list
	Shape	insert	(const Box box, unsigned long property_id)	Insert a box with properties into the shapes list
	Shape	insert	(const Path path, unsigned long property_id)	Insert a path with properties into the shapes list
	Shape	insert	(const Edge edge, unsigned long property_id)	Insert a edge with properties into the shapes list
	Shape	insert	(const Text text, unsigned long property_id)	Insert a text with properties into the shapes list
	Shape	insert	(const SimplePolygon simple_polygon, unsigned long property_id)	Insert a simple polygon with properties into the shapes list
	Shape	insert	(const Polygon polygon, unsigned long property_id)	Insert a polygon with properties into the shapes list
	void	insert_as_edges	(const EdgePairs edge_pairs)	Insert the edge pairs from the edge pair collection as individual edges into this shape container
	void	insert_as_edges	(const EdgePairs edge_pairs, const ICplxTrans trans)	Insert the edge pairs from the edge pair collection as individual into this shape container with a transformation
	void	insert_as_polygons	(const EdgePairs edge_pairs, int e)	Insert the edge pairs from the edge pair collection as polygons into this shape container
	void	insert_as_polygons	(const EdgePairs edge_pairs, const ICplxTrans e, int trans)	Insert the edge pairs from the edge pair collection as polygons into this shape container with a transformation
[const]	bool	is_empty?		Returns a value indicating whether the shapes container is empty
[const]	bool	is_valid?	(const Shape shape)	Test if the given Shape object is still pointing to a valid object
	Shape	replace	(const Shape shape, const Box box)	Replace the given shape with a box
	Shape	replace	(const Shape shape, const Path path)	Replace the given shape with a path
	Shape	replace	(const Shape shape, const Edge edge)	Replace the given shape with an edge object
	Shape	replace	(const Shape shape, const Text text)	Replace the given shape with a text object
	Shape	replace	(const Shape shape, const SimplePolygon simple_polygon)	Replace the given shape with a simple polygon
	Shape	replace	(const Shape shape, const Polygon polygon)	Replace the given shape with a polygon
	Shape	replace_prop_id	(const Shape shape, unsigned long property_id)	Replace (or install) the properties of a shape
[const]	unsigned long	size		Report the number of shapes in this container
	void	transform	(const Trans trans)	Transform all shapes with the given transformation
	void	transform	(const ICplxTrans trans)	Transform all shapes with the given complex integer transformation
	Shape	transform	(const Shape shape, const Trans trans)	Transform the shape given by the reference with the given transformation
	Shape	transform	(const Shape shape, const CplxTrans trans)	Transform the shape given by the reference with the given complex transformation
	Shape	transform	(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 int	SAll	Indicates that all shapes shall be retrieved
unsigned int	SAllWithProperties	Indicates that all shapes with properties shall be retrieved
unsigned int	SBoxes	Indicates that boxes shall be retrieved
unsigned int	SEdges	Indicates that edges shall be retrieved
unsigned int	SPaths	Indicates that paths shall be retrieved
unsigned int	SPolygons	Indicates that polygons shall be retrieved
unsigned int	SProperties	Indicates that only shapes with properties shall be retrieved
unsigned int	STexts	Indicates that texts be retrieved
unsigned int	SUserObjects	Indicates that user objects shall be retrieved

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

	void	create		Use of this method is deprecated. Use _create instead
	void	destroy		Use of this method is deprecated. Use _destroy instead
[const]	bool	destroyed?		Use of this method is deprecated. Use _destroyed? instead
	Shape	insert_box	(const Box box)	Use of this method is deprecated. Use insert instead
	Shape	insert_box_with_properties	(const Box box, unsigned long property_id)	Use of this method is deprecated. Use insert instead
	Shape	insert_edge	(const Edge edge)	Use of this method is deprecated. Use insert instead
	Shape	insert_edge_with_properties	(const Edge edge, unsigned long property_id)	Use of this method is deprecated. Use insert instead
	Shape	insert_path	(const Path path)	Use of this method is deprecated. Use insert instead
	Shape	insert_path_with_properties	(const Path path, unsigned long property_id)	Use of this method is deprecated. Use insert instead
	Shape	insert_polygon	(const Polygon polygon)	Use of this method is deprecated. Use insert instead
	Shape	insert_polygon_with_properties	(const Polygon polygon, unsigned long property_id)	Use of this method is deprecated. Use insert instead
	Shape	insert_simple_polygon	(const SimplePolygon simple_polygon)	Use of this method is deprecated. Use insert instead
	Shape	insert_simple_polygon_with_properties	(const SimplePolygon simple_polygon, unsigned long property_id)	Use of this method is deprecated. Use insert instead
	Shape	insert_text	(const Text text)	Use of this method is deprecated. Use insert instead
	Shape	insert_text_with_properties	(const Text text, unsigned long property_id)	Use of this method is deprecated. Use insert instead
[const]	bool	is_const_object?		Use of this method is deprecated. Use _is_const_object? instead
[static]	unsigned int	s_all		Use of this method is deprecated. Use SAll instead
[static]	unsigned int	s_all_with_properties		Use of this method is deprecated. Use SAllWithProperties instead
[static]	unsigned int	s_boxes		Use of this method is deprecated. Use SBoxes instead
[static]	unsigned int	s_edges		Use of this method is deprecated. Use SEdges instead
[static]	unsigned int	s_paths		Use of this method is deprecated. Use SPaths instead
[static]	unsigned int	s_polygons		Use of this method is deprecated. Use SPolygons instead
[static]	unsigned int	s_properties		Use of this method is deprecated. Use SProperties instead
[static]	unsigned int	s_texts		Use of this method is deprecated. Use STexts instead
[static]	unsigned int	s_user_objects		Use 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

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

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

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.

void assign(const Shapes other)

Description: Assigns another object to self

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 of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[const] new Shapes ptr 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

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.

Shape insert(const Shape shape,const CplxTrans trans)

Description: Insert a shape from a shape reference into the shapes list with a complex 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.

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

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.

void insert(const Region region)

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

void insert(const Region region,const ICplxTrans trans)

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

void insert(const Edges edges)

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

void insert(const Edges edges,const ICplxTrans trans)

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

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 long 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 long property_id)

Description: Insert a path with properties into the shapes list

Returns:

A reference to the new shape (a Shape object)

Shape insert(const Edge edge,unsigned long property_id)

Description: Insert a edge with properties into the shapes list

Returns:

A reference to the new shape (a Shape object)

Shape insert(const Text text,unsigned long property_id)

Description: Insert a text with properties into the shapes list

Returns:

A reference to the new shape (a Shape object)

Shape insert(const SimplePolygon simple_polygon,unsigned long property_id)

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

Returns:

A reference to the new shape (a Shape object)

Shape insert(const Polygon polygon,unsigned long property_id)

Description: Insert a polygon with properties into the shapes list

Returns:

A reference to the new shape (a Shape object)

void insert_as_edges(const EdgePairs edge_pairs)

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

void insert_as_edges(const EdgePairs edge_pairs,const ICplxTrans trans)

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

void insert_as_polygons(const EdgePairs edge_pairs,int e)

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

edge_pairs:	The edge pairs to insert
The:	extension to apply when converting the edges to polygons

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.

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

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

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

This method has been introduced in version 0.23.

Shape insert_box(const Box box)

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

Shape insert_box_with_properties(const Box box,unsigned long property_id)

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

Shape insert_edge(const Edge edge)

Description: Insert a edge into the shapes list

Use of this method is deprecated. Use insert instead

Shape insert_edge_with_properties(const Edge edge,unsigned long property_id)

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

Shape insert_path(const Path path)

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

Shape insert_path_with_properties(const Path path,unsigned long property_id)

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

Shape insert_polygon(const Polygon polygon)

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

Shape insert_polygon_with_properties(const Polygon polygon,unsigned long property_id)

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

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)

Use of this method is deprecated. Use insert instead

Shape insert_simple_polygon_with_properties(const SimplePolygon simple_polygon,unsigned long property_id)

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

Shape insert_text(const Text text)

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

Shape insert_text_with_properties(const Text text,unsigned long property_id)

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

[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

[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] new Shapes ptr new

Description: Creates a new object of this class

Python specific notes:

This method is the default initializer of the object

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)

Shape replace(const Shape shape,const Edge edge)

Description: Replace the given shape with an edge object

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)

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)

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)

Shape replace_prop_id(const Shape shape,unsigned long 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

Use of this method is deprecated. Use SAll instead

[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

[static] unsigned int s_boxes

Description: Indicates that boxes shall be retrieved

Use of this method is deprecated. Use SBoxes instead

[static] unsigned int s_edges

Description: Indicates that edges shall be retrieved

Use of this method is deprecated. Use SEdges instead

[static] unsigned int s_paths

Description: Indicates that paths shall be retrieved

Use of this method is deprecated. Use SPaths instead

[static] unsigned int s_polygons

Description: Indicates that polygons shall be retrieved

Use of this method is deprecated. Use SPolygons instead

[static] unsigned int s_properties

Description: Indicates that only shapes with properties shall be retrieved

Use of this method is deprecated. Use SProperties instead

[static] unsigned int s_texts

Description: Indicates that texts be retrieved

Use of this method is deprecated. Use STexts instead

[static] unsigned int s_user_objects

Description: Indicates that user objects shall be retrieved

Use of this method is deprecated. Use SUserObjects instead

[const] unsigned long 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

Python specific notes:

This method is also available as 'len(object)'

void transform(const Trans trans)

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

void transform(const ICplxTrans trans)

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

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.