API reference - Class DPoint

Notation 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

new DPoint ptrnew(const Point point)Creates a floating-point coordinate point from an integer coordinate point
new DPoint ptrnewDefault constructor: creates a point at 0,0
new DPoint ptrnew(const DVector v)Default constructor: creates a point at from an vector
new DPoint ptrnew(double x,
double y)
Constructor for a point from two coordinate values

Public methods

[const]bool!=(const DPoint p)Inequality test operator
[const]DPoint*(double f)Scaling by some factor
[const]DPoint+(const DVector v)Adds a vector to a point
[const]DVector-(const DPoint p)Subtract one point from another
[const]DPoint-@(p)Compute the negative of a point
[const]bool<(const DPoint p)"less" comparison operator
[const]bool==(const DPoint p)Equality test operator
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]doubleabsThe absolute value of the point (Euclidian distance to 0,0)
voidassign(const DPoint other)Assigns another object to self
[const]doubledistance(const DPoint d)The Euclidian distance to another point
[const]new DPoint ptrdupCreates a copy of self
[const]unsigned longhashComputes a hash value
[const]doublesq_absThe square of the absolute value of the point (Euclidian distance to 0,0)
[const]doublesq_distance(const DPoint d)The square Euclidian distance to another point
[const]Pointto_itype(double dbu = 1)Converts the point to an integer coordinate point
[const]stringto_sString conversion
[const]DVectorto_vTurns the point into a vector
[const]doublexAccessor to the x coordinate
voidx=(double coord)Write accessor to the x coordinate
[const]doubleyAccessor to the y coordinate
voidy=(double coord)Write accessor to the y coordinate

Public static methods and constants

new DPoint ptrfrom_s(string s)Creates an object from a string

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[static]new DPoint ptrfrom_ipoint(const Point point)Use of this method is deprecated. Use new instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const DPoint p)

Description: Inequality test operator

*

Signature: [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.

+

Signature: [const] DPoint + (const DVector v)

Description: Adds a vector to a point

Adds vector v to self by adding the coordinates.

Starting with version 0.25, this method expects a vector argument.

-

Signature: [const] DVector - (const DPoint p)

Description: Subtract one point from another

Subtract point p from self by subtracting the coordinates. This renders a vector.

Starting with version 0.25, this method renders a vector.

-@

Signature: [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.

<

Signature: [const] bool < (const DPoint p)

Description: "less" comparison operator

This operator is provided to establish a sorting order

==

Signature: [const] bool == (const DPoint p)

Description: Equality test operator

_create

Signature: void _create

Description: 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.

_destroy

Signature: void _destroy

Description: 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.

_destroyed?

Signature: [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.

_is_const_object?

Signature: [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.

_manage

Signature: void _manage

Description: 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.

_unmanage

Signature: void _unmanage

Description: 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.

abs

Signature: [const] double abs

Description: 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.

assign

Signature: void assign (const DPoint other)

Description: Assigns another object to self

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

distance

Signature: [const] double distance (const DPoint d)

Description: The Euclidian distance to another point

d:The other point to compute the distance to.

dup

Signature: [const] new DPoint ptr dup

Description: Creates a copy of self

from_ipoint

Signature: [static] new DPoint ptr from_ipoint (const Point point)

Description: Creates a floating-point coordinate point from an integer coordinate point

Use of this method is deprecated. Use new instead

Python specific notes:
This method is the default initializer of the object

from_s

Signature: [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.

hash

Signature: [const] unsigned long hash

Description: Computes a hash value

Returns a hash value for the given point. This method enables points as hash keys.

This method has been introduced in version 0.25.

Python specific notes:
This method is also available as 'hash(object)'

is_const_object?

Signature: [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

new

Signature: [static] new DPoint ptr new (const Point point)

Description: Creates a floating-point coordinate point from an integer coordinate point

This constructor has been introduced in version 0.25 and replaces the previous static method 'from_ipoint'.

Python specific notes:
This method is the default initializer of the object

Signature: [static] new DPoint ptr new

Description: Default constructor: creates a point at 0,0

Python specific notes:
This method is the default initializer of the object

Signature: [static] new DPoint ptr new (const DVector v)

Description: Default constructor: creates a point at from an vector

This constructor is equivalent to computing point(0,0)+v. This method has been introduced in version 0.25.

Python specific notes:
This method is the default initializer of the object

Signature: [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

sq_abs

Signature: [const] double sq_abs

Description: 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.

sq_distance

Signature: [const] double sq_distance (const DPoint d)

Description: The square Euclidian distance to another point

d:The other point to compute the distance to.

to_itype

Signature: [const] Point to_itype (double dbu = 1)

Description: Converts the point to an integer coordinate point

The database unit can be specified to translate the floating-point coordinate point in micron units to an integer-coordinate point in database units. The point's' coordinates will be divided by the database unit.

This method has been introduced in version 0.25.

to_s

Signature: [const] string to_s

Description: String conversion

Python specific notes:
This method is also available as 'str(object)' and 'repr(object)'

to_v

Signature: [const] DVector to_v

Description: Turns the point into a vector

This method returns a vector representing the distance from (0,0) to the point.This method has been introduced in version 0.25.

x

Signature: [const] double x

Description: Accessor to the x coordinate

Python specific notes:
The object exposes a readable attribute 'x'. This is the getter.

x=

Signature: 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.

y

Signature: [const] double y

Description: Accessor to the y coordinate

Python specific notes:
The object exposes a readable attribute 'y'. This is the getter.

y=

Signature: 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.