API reference - Class PointNotation used in Ruby API documentation Description: An integer point class
Points represent a coordinate in the two-dimensional coordinate space of layout. They are not geometrical objects by itself. But they are frequently used in the database API for various purposes. See The Database API for more details about the database objects. Public constructors
Public methods
Public static methods and constants
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description[const] bool !=(const Point p)Description: Inequality test operator [const] Point *(double f)Description: Scaling by some factor Returns the scaled object. All coordinates are multiplied with the given factor and if necessary rounded. [const] Point +(const Point p)Description: Add one point to another Add point p to self by adding the coordinates [const] Point -(const Point p)Description: Subtract one point from another Subtract point p from self by subtracting the coordinates [const] Point -@(p)Description: Compute the negative of a point Returns a new point with -x, -y. This method has been added in version 0.23. [const] bool <(const Point p)Description: "less" comparison operator This operator is provided to establish a sorting order [const] bool ==(const Point p)Description: Equality test operator [const] double absDescription: The absolute value of the point (Euclidian distance to 0,0) The returned value is 'sqrt(x*x+y*y)'. This method has been introduced in version 0.23. [const] void assign(const Point 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. 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. 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 Point d)Description: The Euclidian distance to another point
[const] Point dupDescription: Creates a copy of self [static] Point from_dpoint(const DPoint p)Description: Create a double point from an integer point Creates an double point from an integer point p [static] new Point 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 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. [static] new Point newDescription: Default constructor: creates a point at 0,0 [static] new Point new(int x,int y)Description: Constructor for a point from two coordinate values [static] new Point new_xy(int x,int y)Description: Constructor for a point from two coordinate values This method is deprecated. Use method 'new' instead [const] double sq_absDescription: The square of the absolute value of the point (Euclidian distance to 0,0) The returned value is 'x*x+y*y'. This method has been introduced in version 0.23. [const] double sq_distance(const Point d)Description: The square Euclidian distance to another point
[const] string to_sDescription: String conversion [const] int xDescription: Accessor to the x coordinate void x=(int coord)Description: Write accessor to the x coordinate [const] int yDescription: Accessor to the y coordinate void y=(int coord)Description: Write accessor to the y coordinate |