KLayout Manual: Main Index » Class Index » API reference - Class Point

API reference - Class Point

Notation used in Ruby API documentation

Description: An integer point class

Public constructors

new PointnewDefault constructor: creates a point at 0,0
new Pointnew(int x,
int y)
Constructor for a point from two coordinate values

Public methods

[const]bool!=(const Point p)Inequality test operator
[const]Point*(double f)Scaling by some factor
[const]Point+(const Point p)Add one point to another
[const]Point-(const Point p)Subtract one point from another
[const]bool<(const Point p)"less" comparison operator
[const]bool==(const Point p)Equality test operator
[const]voidassign(const Point other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]doubledistance(const Point d)The euclidian distance to another point
[const]PointdupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]doublesq_distance(const Point d)The square euclidian distance to another point
[const]stringto_sString conversion
[const]intxAccessor to the x coordinate
voidx=(int arg1)Write accessor to the x coordinate
[const]intyAccessor to the y coordinate
voidy=(int arg1)Write accessor to the y coordinate

Public static methods and constants

Pointfrom_dpoint(const DPoint p)Create a double point from an integer point

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

[static]new Pointnew_xy(int x,
int y)
Use of this method is deprecated. Use new instead

Detailed description

[const] bool !=(const Point p)

Description: Inequality test operator

[const] Point *(double f)

Description: Scaling by some factor

Scaling may involve rounding for integer coordinate points.

[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] 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] 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 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.

void destroy

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

d:The other point to compute the distance to.

[const] Point dup

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

[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 new

Description: 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_distance(const Point d)

Description: The square euclidian distance to another point

d:The other point to compute the distance to.

[const] string to_s

Description: String conversion

[const] int x

Description: Accessor to the x coordinate

void x=(int arg1)

Description: Write accessor to the x coordinate

[const] int y

Description: Accessor to the y coordinate

void y=(int arg1)

Description: Write accessor to the y coordinate