API reference - Class DEdgeNotation used in Ruby API documentation Description: An edge class
An edge is a connection between points, usually participating in a larger context such as a polygon. An edge has a defined direction (from p1 to p2). Edges play a role in the database as parts of polygons and to describe a line through both points. The Edge object is also used inside the boolean processor (EdgeProcessor). Altough supported, edges are rarely used as individual database objects. See The Database API for more details about the database objects like the Edge class. Public constructors
Public methods
Public static methods and constants
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description[const] bool !=(const DEdge e)Description: Inequality test
[const] DEdge *(double scale_factor)Description: Scale edge
The * operator scales self with the given factor. This method has been introduced in version 0.22. [const] bool <(const DEdge e)Description: Less operator
[const] bool ==(const DEdge e)Description: Equality test
[const] void assign(const DEdge 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] DBox bboxDescription: Return the bounding box of the edge. [const] bool coincident?(const DEdge e)Description: Coincidence check.
Checks whether a edge is coincident with another edge. Coincidence is defined by being parallel and that at least one point of one edge is on the other edge. [const] bool contains?(const DPoint p)Description: Test whether a point is on an edge.
A point is on a edge if it is on (or at least closer than a grid point to) the edge. [const] bool contains_excl?(const DPoint p)Description: Test whether a point is on an edge excluding the endpoints.
A point is on a edge if it is on (or at least closer than a grid point to) the edge. void createDescription: 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. [const] bool crossed_by?(const DEdge e)Description: Check, if an edge is cut by a line (given by an edge)
This method returns true if p1 is in one semispace while p2 is in the other or one of them is on the line through the edge "e" [const] DPoint crossing_point(const DEdge e)Description: Returns the crossing point on two edges.
This method delivers the point where the given edge (self) crosses the line given by the edge in argument "e". If self does not cross this line, the result is undefined. See crossed_by? for a description of the crossing predicate. This method has been introduced in version 0.19. void 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 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] double distance(const DPoint p)Description: Distance between the edge and a point.
Returns the distance between the edge and the point. The distance is signed which is negative if the point is to the "left" of the edge and positive if the point is to the "right". The distance is measured by projecting the point onto the line through the edge. If the edge is degenerated, the distance is not defined. [const] double distance_abs(const DPoint p)Description: Absolute distance between the edge and a point.
Returns the distance between the edge and the point. [const] DEdge dupDescription: Creates a copy of self [const] double dxDescription: The horizontal extend of the edge. [const] double dx_absDescription: The absolute value of the horizontal extend of the edge. [const] double dyDescription: The vertical extend of the edge. [const] double dy_absDescription: The absolute value of the vertical extend of the edge. DEdge enlarge(const DPoint p)Description: Enlarges the edge.
Enlarges the edge by the given distance and returns the enlarged edge. The edge is overwritten. Enlargement means that the first point is shifted by -p, the second by p. [const] DEdge enlarged(const DPoint p)Description: Returns the enlarged edge (does not modify self)
Enlarges the edge by the given offset and returns the enlarged edge. The edge is not modified. Enlargement means that the first point is shifted by -p, the second by p. DEdge extend(double d)Description: Extends the edge (modifies self)
Extends the edge by the given distance and returns the extended edge. The edge is not modified. Extending means that the first point is shifted by -d along the edge, the second by d. The length of the edge will increase by 2*d. extended is a version that does not modify self but returns the extended edges. This method has been introduced in version 0.23. [const] DEdge extended(double d)Description: Returns the extended edge (does not modify self)
Extends the edge by the given distance and returns the extended edge. The edge is not modified. Extending means that the first point is shifted by -d along the edge, the second by d. The length of the edge will increase by 2*d. extend is a version that modifies self (in-place). This method has been introduced in version 0.23. [static] DEdge from_iedge(const Edge int_edge)Description: Construct a floating-point coordinate edge from an integer coordinate edge Create a floating-point coordinate edge from an integer edge [static] new DEdge from_s(string s)Description: Creates an object from a string Creates the object from a string representation (as returned by to_s) This method has been added in version 0.23. [const] bool intersect?(const DEdge e)Description: Intersection test.
Returns true if the edges intersect. Two edges intersect if they share at least one point. If the edges coincide, they also intersect. For degenerated edges, the intersection is mapped to point containment tests. [const] DPoint intersection_point(const DEdge e)Description: Returns the intersection point of two edges.
This method delivers the intersection point. If the edges do not intersect, the result is undefined. This method has been introduced in version 0.19. [const] bool is_const_object?Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. [const] bool is_degenerate?Description: Test for degenerated edge An edge is degenerate, if both end and start point are identical. [const] bool is_parallel?(const DEdge e)Description: Test for being parallel
[const] double lengthDescription: The length of the edge DEdge move(const DPoint p)Description: Moves the edge.
Moves the edge by the given offset and returns the moved edge. The edge is overwritten. DEdge move(double dx,double dy)Description: Moves the edge.
Moves the edge by the given offset and returns the moved edge. The edge is overwritten. This version has been added in version 0.23. [const] DEdge moved(const DPoint p)Description: Returns the moved edge (does not modify self)
Moves the edge by the given offset and returns the moved edge. The edge is not modified. [const] DEdge moved(double dx,double dy)Description: Returns the moved edge (does not modify self)
Moves the edge by the given offset and returns the moved edge. The edge is not modified. This version has been added in version 0.23. [static] new DEdge newDescription: Default constructor: creates a degenerated edge 0,0 to 0,0 [static] new DEdge new(double x1,double y1,double x2,double y2)Description: Constructor with two coordinates given as single values Two points are given to create a new edge. [static] new DEdge new(const DPoint p1,const DPoint p2)Description: Constructor with two points Two points are given to create a new edge. [static] new DEdge new_pp(const DPoint p1,const DPoint p2)Description: Constructor with two points This method is deprecated. Use method 'new' instead [static] new DEdge new_xyxy(double x1,double y1,double x2,double y2)Description: Constructor with two coordinates given as single values This method is deprecated. Use method 'new' instead [const] double ortho_lengthDescription: The orthogonal length of the edge ("manhattan-length")
[const] DPoint p1Description: The first point. void p1=(const DPoint point)Description: Sets the first point. This method has been added in version 0.23. [const] DPoint p2Description: The second point. void p2=(const DPoint point)Description: Sets the second point. This method has been added in version 0.23. DEdge shift(double d)Description: Shifts the edge (modifies self)
Shifts the edge by the given distance and returns the shifted edge. The edge is not modified. Shifting by a positive value will produce an edge which is shifted by d to the left. Shifting by a negative value will produce an edge which is shifted by d to the right. shifted is a version that does not modify self but returns the extended edges. This method has been introduced in version 0.23. [const] DEdge shifted(double d)Description: Returns the shifted edge (does not modify self)
Shifts the edge by the given distance and returns the shifted edge. The edge is not modified. Shifting by a positive value will produce an edge which is shifted by d to the left. Shifting by a negative value will produce an edge which is shifted by d to the right. shift is a version that modifies self (in-place). This method has been introduced in version 0.23. [const] int side_of(const DPoint p)Description: Indicates at which side the point is located relative to the edge.
Returns 1 if the point is "left" of the edge, 0 if on and -1 if the point is "right" of the edge. [const] double sq_lengthDescription: The square of the length of the edge DEdge swap_pointsDescription: Swap the points of the edge This version modifies self. A version that does not modify self is swapped_points. Swapping the points basically reverses the direction of the edge. This method has been introduced in version 0.23. [const] DEdge swapped_pointsDescription: Returns an edge in which both points are swapped Swapping the points basically reverses the direction of the edge. This method has been introduced in version 0.23. [const] string to_sDescription: Returns a string representing the edge [const] DEdge transformed(const DTrans t)Description: Transform the edge.
Transforms the edge with the given transformation. Does not modify the edge but returns the transformed edge. [const] DEdge transformed(const DCplxTrans t)Description: Transform the edge.
Transforms the edge with the given complex transformation. Does not modify the edge but returns the transformed edge. [const] DEdge transformed_cplx(const DCplxTrans t)Description: Transform the edge.
This method is deprecated. Use method 'transformed' instead [const] double x1Description: Shortcut for p1.x void x1=(double coord)Description: Sets p1.x This method has been added in version 0.23. [const] double x2Description: Shortcut for p2.x void x2=(double coord)Description: Sets p2.x This method has been added in version 0.23. [const] double y1Description: Shortcut for p1.y void y1=(double coord)Description: Sets p1.y This method has been added in version 0.23. [const] double y2Description: Shortcut for p2.y void y2=(double coord)Description: Sets p2.y This method has been added in version 0.23. |