API reference - Class BoxNotation used in Ruby API documentation Description: A box class with floating-point coordinates
This object represents a box (a rectangular shape). The definition of the attributes is: p1 is the lower left point, p2 the upper right one. If a box is constructed from two points (or four coordinates), the coordinates are sorted accordingly. A box can be empty. An empty box represents no area (not even a point). Empty boxes behave neutral with respect to most operations. Empty boxes return true on empty?. A box can be a point or a single line. In this case, the area is zero but the box still can overlap other boxes for example and it is not empty. 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 Box box)Description: Inequality Return true, if this box and the given box are not equal [const] Box &(const Box box)Description: Intersection of boxes
The intersection of two boxes is the largest box common to both boxes. The intersection may be empty if both boxes to not touch. If the boxes do not overlap but touch the result may be a single line or point with an area of zero. Overwrites this box with the result. [const] Box *(const Box box)Description: Convolve boxes
The * operator convolves the firstbox with the one given as the second argument. The box resulting from "convolution" is the outer boundary of the union set formed by placing the second box at every point of the first. In other words, the returned box of (p1,p2)*(q1,q2) is (p1+q1,p2+q2). [const] Box *(double scale_factor)Description: Scale box
The * operator scales the box with the given factor and returns the result. This method has been introduced in version 0.22. [const] Box +(const Point point)Description: Join box with a point
The + operator joins a point with the box. The resulting box will enclose both the original box and the point. [const] Box +(const Box box)Description: Joining of boxes
The + operator joins the first box with the one given as the second argument. Joining constructs a box that encloses both boxes given. Empty boxes are neutral: they do not change another box when joining. Overwrites this box with the result. [const] bool <(const Box box)Description: Less operator Return true, if this box is 'less' with respect to first and second point (in this order) [const] bool ==(const Box box)Description: Equality Return true, if this box and the given box are equal 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 areaDescription: Compute the box area Returns the box area or 0 if the box is empty void assign(const Box other)Description: Assigns another object to self [const] int bottomDescription: The bottom coordinate of the box Python specific notes:The object exposes a readable attribute 'bottom'. This is the getter. void bottom=(int c)Description: Set the bottom coordinate of the box Python specific notes:The object exposes a writable attribute 'bottom'. This is the setter. [const] Point centerDescription: The center of the box [const] bool contains?(int x,int y)Description: Returns true if the box contains the given point
Tests whether a point (x, y) is inside the box. It also returns true if the point is exactly on the box contour. [const] bool contains?(const Point point)Description: Returns true if the box contains the given point
Tests whether a point is inside the box. It also returns true if the point is exactly on the box contour. 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] new Box ptr dupDescription: Creates a copy of self [const] bool empty?Description: Empty predicate An empty box may be created with the default constructor for example. Such a box is neutral when combining it with other boxes and renders empty boxes if used in box intersections and false in geometrical relationship tests. Box enlarge(int dx,int dy)Description: Enlarges the box by a certain amount.
This is a convenience method which takes two values instead of a Point object. This method has been introduced in version 0.23. Box enlarge(const Point enlargement)Description: Enlarges the box by a certain amount.
Enlarges the box by x and y value specified in the vector passed. Positive values with grow the box, negative ones will shrink the box. The result may be an empty box if the box disappears. The amount specifies the grow or shrink per edge. The width and height will change by twice the amount. Does not check for coordinate overflows. [const] Box enlarged(int dx,int dy)Description: Enlarges the box by a certain amount.
This is a convenience method which takes two values instead of a Point object. This method has been introduced in version 0.23. [const] Box enlarged(const Point enlargement)Description: Enlarges the box by a certain amount.
Enlarges the box by x and y value specified in the vector passed. Positive values with grow the box, negative ones will shrink the box. The result may be an empty box if the box disappears. The amount specifies the grow or shrink per edge. The width and height will change by twice the amount. Does not modify this box. Does not check for coordinate overflows. [static] Box from_dbox(const DBox double_box)Description: Construct an integer box from a floating-point coordinate box Create a integer coordinate box from a floating-point coordinate box [static] new Box 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] unsigned int heightDescription: The height of the box [const] bool inside?(const Box box)Description: Test if this box is inside the argument box Returns true, if this box is inside the given box, i.e. the box intersection renders this box [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 [const] bool is_point?Description: Return true, if the box is a single point [const] int leftDescription: The left coordinate of the box Python specific notes:The object exposes a readable attribute 'left'. This is the getter. void left=(int c)Description: Set the left coordinate of the box Python specific notes:The object exposes a writable attribute 'left'. This is the setter. Box move(int dx,int dy)Description: Moves the box by a certain distance
This is a convenience method which takes two values instead of a Point object. This method has been introduced in version 0.23. Box move(const Point distance)Description: Moves the box by a certain distance
Moves the box by a given offset and returns the moved box. Does not check for coordinate overflows. [const] Box moved(int dx,int dy)Description: Moves the box by a certain distance
This is a convenience method which takes two values instead of a Point object. This method has been introduced in version 0.23. [const] Box moved(const Point distance)Description: Returns the box moved by a certain distance
Moves the box by a given offset and returns the moved box. Does not modify this box. Does not check for coordinate overflows. [static] new Box ptr newDescription: Default constructor: creates an empty (invalid) box Python specific notes:This method is the default initializer of the object [static] new Box ptr new(int left,int bottom,int right,int top)Description: Constructor with four coordinates Four coordinates are given to create a new box. If the coordinates are not provided in the correct order (i.e. right < left), these are swapped. Python specific notes:This method is the default initializer of the object [static] new Box ptr new(const Point lower_left,const Point upper_right)Description: Constructor with two points Two points are given to create a new box. If the coordinates are not provided in the correct order (i.e. right < left), these are swapped. Python specific notes:This method is the default initializer of the object [static] new Box ptr new_lbrt(int left,int bottom,int right,int top)Description: Constructor with four coordinates Use of this method is deprecated. Use new instead [static] new Box ptr new_pp(const Point lower_left,const Point upper_right)Description: Constructor with two points Use of this method is deprecated. Use new instead [const] bool overlaps?(const Box box)Description: Test if this box overlaps the argument box Returns true, if the intersection box of this box with the argument box exists and has a non-vanishing area [const] Point p1Description: The lower left point of the box Python specific notes:The object exposes a readable attribute 'p1'. This is the getter. void p1=(const Point p)Description: Set the lower left point of the box Python specific notes:The object exposes a writable attribute 'p1'. This is the setter. [const] Point p2Description: The upper right point of the box Python specific notes:The object exposes a readable attribute 'p2'. This is the getter. void p2=(const Point p)Description: Set the upper right point of the box Python specific notes:The object exposes a writable attribute 'p2'. This is the setter. [const] int perimeterDescription: Returns the perimeter of the box This method is equivalent to 2*(width+height). For empty boxes, this method returns 0. This method has been introduced in version 0.23. [const] int rightDescription: The right coordinate of the box Python specific notes:The object exposes a readable attribute 'right'. This is the getter. void right=(int c)Description: Set the right coordinate of the box Python specific notes:The object exposes a writable attribute 'right'. This is the setter. [const] string to_sDescription: Convert to a string Python specific notes:This method is also available as 'str(object)' [const] int topDescription: The top coordinate of the box Python specific notes:The object exposes a readable attribute 'top'. This is the getter. void top=(int c)Description: Set the top coordinate of the box Python specific notes:The object exposes a writable attribute 'top'. This is the setter. [const] bool touches?(const Box box)Description: Test if this box touches the argument box Returns true, if this box has at least one point common with the argument box [const] Box transformed(const ICplxTrans t)Description: Transform the box with the given complex transformation
This method has been introduced in version 0.18. [const] Box transformed(const Trans t)Description: Transform the box with the given simple transformation
[const] DBox transformed(const CplxTrans t)Description: Transform the box with the given complex transformation
[const] Box transformed_cplx(const ICplxTrans t)Description: Transform the box with the given complex transformation
Use of this method is deprecated. Use transformed instead [const] DBox transformed_cplx(const CplxTrans t)Description: Transform the box with the given complex transformation
Use of this method is deprecated. Use transformed instead [const] unsigned int widthDescription: The width of the box |