ScriptModule
Point2d Class Reference

The Point2d class defines a bi-dimensional point container. Point2d objects can be instantiated in the scripting environment. More...

`#include <MathInterface.h>`

Inheritance diagram for Point2d:
[legend]
Collaboration diagram for Point2d:
[legend]

## Public Slots

void setXY (const double, const double)

Point2dround ()

Point2dround (double quantum)

Point2dround (const Vector2d v)

Point2dround (const Vector2d v, double quantum)

Vector2d toVector2d ()
Copy Point2d into a Vector2d container.

double distance (const Point2d p2) const
Calculate distance between two points.

double distanceSq (const Point2d p2) const
Calculate square distance between two points.

Vector2d minus (const Point2d p2)
Substracts current Point2d with specified Point2d.

Point2d minus (const Vector2d v)
Substracts current Point2d with specified Vector2d.

Point2d add (const Vector2d v)
Add specified Vector2d to current Point2d.

Point2daddEq (const Vector2d v)
Add specified Vector2d to current Point2d.

Point2dminusEq (const Vector2d v)
Substract current Point2d with specified Vector2d.

Point2dinterpolate (double t, const Point2d p1, const Point2d p2)
Calculate Point2d as interpolation between two points.

## Public Member Functions

Point2d ()
Create a new empty Point2d.

Point2d (double x, double y)
Create a new Point2d.

double x
x value

double y
y value

## Detailed Description

The Point2d class defines a bi-dimensional point container. Point2d objects can be instantiated in the scripting environment.

## Constructor & Destructor Documentation

 Point2d::Point2d ( )

Create a new empty Point2d.

 Point2d::Point2d ( double x, double y )

Create a new Point2d.

Parameters
 x X value y Y value

## Member Function Documentation

 Point2d Point2d::add ( const Vector2d v )
slot

Add specified Vector2d to current Point2d.

Parameters
Returns
New Point2d containing result
 Point2d& Point2d::addEq ( const Vector2d v )
slot

Add specified Vector2d to current Point2d.

Parameters
Returns
Point2d reference
 double Point2d::distance ( const Point2d p2 ) const
slot

Calculate distance between two points.

Parameters
 p2 Second Point2d
Returns
Distance between current Point2d and p2
 double Point2d::distanceSq ( const Point2d p2 ) const
slot

Calculate square distance between two points.

Parameters
 p2 Second Point2d
Returns
Square distance between current Point2d and p2
 Point2d& Point2d::interpolate ( double t, const Point2d p1, const Point2d p2 )
slot

Calculate Point2d as interpolation between two points.

Parameters
 t Factor of interpolation [ 0, 1 ] p1 First Point2d p2 Second Point2d
Returns
Point2d reference
 Vector2d Point2d::minus ( const Point2d p2 )
slot

Substracts current Point2d with specified Point2d.

Parameters
 p2 Second Point2d
Returns
New Point2d containing result
 Point2d Point2d::minus ( const Vector2d v )
slot

Substracts current Point2d with specified Vector2d.

Parameters
Returns
New Point2d containing result
 Point2d& Point2d::minusEq ( const Vector2d v )
slot

Substract current Point2d with specified Vector2d.

Parameters
Returns
Point2d reference
 Point2d& Point2d::round ( )
slot
 Point2d& Point2d::round ( double quantum )
slot
 Point2d& Point2d::round ( const Vector2d v )
slot
 Point2d& Point2d::round ( const Vector2d v, double quantum )
slot
 void Point2d::setXY ( const double , const double )
slot
 Vector2d Point2d::toVector2d ( )
slot

Copy Point2d into a Vector2d container.

Returns
Vector2d

## Property Documentation

 double Point2d::x
readwrite

x value

 double Point2d::y
readwrite

y value

The documentation for this class was generated from the following file: