Class Shapes (version 0.18)Description: A collection of shapes A shapes collection is a collection of geometrical objects, such as polygons, boxes, paths, edges or text objects.
Method Overview
assign( 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.
clearDescription: Clear the shape container This method has been introduced in version 0.16. It can only be used in editable mode.
destroyDescription: 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 destroyedDescription: Tell, if the object was 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 dupDescription: Creates a copy of self.
[const] yield Shape each( unsigned int flags )Description: Get all shapes
[const] yield Shape eachDescription: Get all shapes This call is equivalent to each(s_all). This convenience method has been introduced in version 0.16
[const] yield Shape each_overlapping( Box region )Description: Get all shapes that overlap the search box (region) This call is equivalent to each_overlapping(s_all,region). This convenience method has been introduced in version 0.16
[const] yield Shape each_overlapping( unsigned int flags, Box region )Description: Get all shapes that overlap the search box (region) This method was introduced in version 0.16
[const] yield Shape each_touching( Box region )Description: Get all shapes that touch the search box (region) This call is equivalent to each_touching(s_all,region). This convenience method has been introduced in version 0.16
[const] yield Shape each_touching( unsigned int flags, Box region )Description: Get all shapes that touch the search box (region) This method was introduced in version 0.16
erase( Shape shape )Description: Erase the shape pointed to by the given Shape object 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.
Shape insert( Edge edge, unsigned int property_id )
|
| returns: | A reference to the new shape (a Shape object) |
Description: Insert a simple polygon into the shapes list
Starting with version 0.16, this method returns a reference to the newly created shape
| returns: | A reference to the new shape (a Shape object) |
Description: Insert a polygon into the shapes list
Starting with version 0.16, this method returns a reference to the newly created shape
| returns: | A reference to the new shape (a Shape object) |
Description: Insert a path into the shapes list
Starting with version 0.16, this method returns a reference to the newly created shape
| returns: | A reference to the new shape (a Shape object) |
Description: Insert a path with properties into the shapes list
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
| returns: | A reference to the new shape (a Shape object) |
Description: Insert a text into the shapes list
Starting with version 0.16, this method returns a reference to the newly created shape
| returns: | A reference to the new shape (a Shape object) |
Description: Insert a text with properties into the shapes list
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
| returns: | A reference to the new shape (a Shape object) |
Description: Insert a simple polygon with properties into the shapes list
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
| returns: | A reference to the new shape (a Shape object) |
Description: Insert a polygon with properties into the shapes list
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
| returns: | A reference to the new shape (a Shape object) |
Description: Insert a box into the shapes list
Starting with version 0.16, this method returns a reference to the newly created shape
| returns: | A reference to the new shape (a Shape object) |
Description: Insert a edge into the shapes list
Starting with version 0.16, this method returns a reference to the newly created shape
Description: Insert a box with properties into the shapes list
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
| returns: | A reference to the new shape (a Shape object) |
Description: Insert a shape from a shape reference into the shapes list
This method has been introduced in version 0.16.
| returns: | A reference (a Shape object) to the newly created 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.
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.
Description: Replace the given shape with a polygon
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.
| returns: | A reference to the new shape (a Shape object) |
Description: Replace the given shape with a text 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.
| returns: | A reference to the new shape (a Shape object) |
Description: Replace the given shape with a path
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.
| returns: | A reference to the new shape (a Shape object) |
Description: Replace the given shape with a box
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.
| returns: | A reference to the new shape (a Shape object) |
Description: Replace the given shape with a simple polygon
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.
| returns: | A reference to the new shape (a Shape object) |
Description: Replace (or install) the properties of a 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.
| returns: | A Shape object representing the new shape |
Description:
Description:
Description:
Description:
Description:
Description:
Description:
Description:
Description:
Description: Report the number of shapes in this container
This method was introduced in version 0.16
| returns: | The number of shapes in this container |
Description: Transform the shape given by the reference with the given transformation
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.
| returns: | A reference (a Shape object) to the new shape |
Description: Transform the shape given by the reference with the given complex transformation
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.
| returns: | A reference (a Shape object) to the new shape |