API reference - Class DPointNotation used in Ruby API documentation Description: A point class with double (floating-point) coordinates
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. Other than the integer variant (Point), points with floating-point coordinates can represent fractions of a database unit. 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 DPoint p)Description: Inequality test operator [const] DPoint *(double f)Description: Scaling by some factor Returns the scaled object. All coordinates are multiplied with the given factor and if necessary rounded. [const] DPoint +(const DPoint p)Description: Add one point to another Add point p to self by adding the coordinates [const] DPoint -(const DPoint p)Description: Subtract one point from another Subtract point p from self by subtracting the coordinates [const] DPoint -@(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 DPoint p)Description: "less" comparison operator This operator is provided to establish a sorting order [const] bool ==(const DPoint p)Description: Equality test operator 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 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 _manageDescription: 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 _unmanageDescription: 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. [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. void assign(const DPoint other)Description: Assigns another object to self void createDescription: Ensures the C++ object is created Use of this method is deprecated. Use _create instead void destroyDescription: 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] double distance(const DPoint d)Description: The Euclidian distance to another point
[const] new DPoint ptr dupDescription: Creates a copy of self [static] DPoint from_ipoint(const Point p)Description: Create a floating-point coordinate point from an integer coordinate point [static] new DPoint ptr 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 Use of this method is deprecated. Use _is_const_object? instead [static] new DPoint ptr newDescription: Default constructor: creates a point at 0,0 Python specific notes:This method is the default initializer of the object [static] new DPoint ptr new(double x,double y)Description: Constructor for a point from two coordinate values Python specific notes:This method is the default initializer of the object [static] new DPoint ptr new_xy(double x,double y)Description: Constructor for a point from two coordinate values Use of this method is deprecated. Use 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 DPoint d)Description: The square Euclidian distance to another point
[const] string to_sDescription: String conversion Python specific notes:This method is also available as 'str(object)' [const] double xDescription: Accessor to the x coordinate Python specific notes:The object exposes a readable attribute 'x'. This is the getter. void x=(double coord)Description: Write accessor to the x coordinate Python specific notes:The object exposes a writable attribute 'x'. This is the setter. [const] double yDescription: Accessor to the y coordinate Python specific notes:The object exposes a readable attribute 'y'. This is the getter. void y=(double coord)Description: Write accessor to the y coordinate Python specific notes:The object exposes a writable attribute 'y'. This is the setter. |