Class Shape (version 0.18)Description: A shape proxy The shape proxy is basically a pointer to a shape of different kinds. No copy of the shape is created: if the shape proxy is copied the copy still points to the original shape. If the original shape is modified or deleted, the shape proxy will also point to a modified or invalid shape. The proxy can be "null" which decribes an invalid reference.
Method Overview
[const] bool !=( Shape )Description: Inequality
[const] bool ==( Shape )Description: Equality Equality of shapes is not specified by the identity of the objects but by the identity of the pointers - both shapes must reference the same object.
[const] const ref Trans array_transDescription: Get the array instance member transformation This attribute is valid only if is_array_member? is true. The transformation returned describes the relative transformation of the array member addressed.
assign( Shape 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.
[const] Box bboxDescription: Compute the bounding box of the shape that is referenced
[const] Box boxDescription: Instantiate the box object If a box is referenced, this object is instantiated by this method.
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] Shape dupDescription: Creates a copy of self.
yield Edge each_edgeDescription: Iterate over the edges of the object This method applies to polygons and simple polygons.
[const] yield Point each_pointDescription: Iterate over all points of the object This method applies to paths.
[const] yield Point each_point_hole( unsigned int hole_index )Description: Iterate over the points of a hole contour This method applies to polygons. Simple polygons deliver an empty sequence.
[const] yield Point each_point_hullDescription: Iterate over the hull contour of the object This method applies to polygons.
[const] Edge edgeDescription: Instantiate the edge object If a edge is referenced, this object is instantiated by this method.
[const] bool has_prop_id?Description: Check, if the shape is associated with a properties Id
[const] unsigned int holesDescription: Return the number of holes This method applies to polygons. Simple polygons deliver a zero value.
[const] bool is_array_member?Description: Returns true, if the shape referenced is a member of a shape array
[const] bool is_box?Description: Test if the shape proxy points to a box
[const] bool is_edge?Description: Test if the shape proxy points to a edge
[const] bool is_null?Description: Test if the shape proxy is a null object
[const] bool is_path?Description: Test if the shape proxy points to a path
[const] bool is_polygon?Description: Test if the shape proxy points to a polygon
[const] bool is_simple_polygon?Description: Test if the shape proxy points to a simple polygon
[const] bool is_text?Description: Test if the shape proxy points to a text
[const] bool is_user_object?Description: Test if the shape proxy points to a user object
[const] Path pathDescription: Instantiate the path object If a path is referenced, this object is instantiated by this method.
[const] int path_bgnextDescription: Obtain the path's "begin" extension Applies to paths only.
[const] int path_endextDescription: Obtain the path's "end" extension Applies to paths only.
[const] int path_widthDescription: Obtain the path width Applies to paths only.
[const] Polygon polygonDescription: Instantiate the polygon object If a polygon is referenced, this object is instantiated by this method. Paths and boxes are converted to polygons.
[const] unsigned int prop_idDescription: Get the properties Id associated with the shape
[const] bool round_path?Description: Returns true, if the path has round ends Applies to paths only.
[const] SimplePolygon simple_polygonDescription: Instantiate the simple polygon object If a simple polygon is referenced, this object is instantiated by this method. Paths and boxes are converted to polygons.
[static] int t_boxDescription:
[static] int t_box_arrayDescription:
[static] int t_box_array_memberDescription:
[static] int t_edgeDescription:
[static] int t_nullDescription:
[static] int t_pathDescription:
[static] int t_path_ptr_arrayDescription:
[static] int t_path_ptr_array_memberDescription:
[static] int t_path_refDescription:
[static] int t_polygonDescription:
[static] int t_polygon_ptr_arrayDescription:
[static] int t_polygon_ptr_array_memberDescription:
[static] int t_polygon_refDescription:
[static] int t_short_boxDescription:
[static] int t_short_box_arrayDescription:
[static] int t_short_box_array_memberDescription:
[static] int t_simple_polygonDescription:
[static] int t_simple_polygon_ptr_arrayDescription:
[static] int t_simple_polygon_ptr_array_memberDescription:
[static] int t_simple_polygon_refDescription:
[static] int t_textDescription:
[static] int t_text_ptr_arrayDescription:
[static] int t_text_ptr_array_memberDescription:
[static] int t_text_refDescription:
[static] int t_user_objectDescription:
[const] Text textDescription: Instantiate the text object If a text is referenced, this object is instantiated by this method.
[const] int text_fontDescription: Obtain the text's font Applies to texts only. Will throw an exception if not a text.
[const] int text_sizeDescription: Obtain the text size Applies to texts only. Will throw an exception if not a text.
[const] string text_stringDescription: Obtain the text string Applies to texts only. Will throw an exception if not a text.
[const] Trans text_transDescription: Obtain the text transformation Applies to texts only. Will throw an exception if not a text.
[const] string to_sDescription: Create a string showing the contents of the reference This method has been introduced with version 0.16.
[const] int typeDescription: Return the type of the shape reference The returned values are the t_... constants available through the corresponding class members.
|