Point2d Class Reference

#include <MathInterface.h>

Inheritance diagram for Point2d:

Collaboration diagram for Point2d:

Public Slots
void	setXY (const double, const double)
	Set the value of x, y coordinate. More...
Point2d &	round ()
	round x and y to floor with a resolution of 1.0/64.0 More...
Point2d &	round (double quantum)
	round x and y to floor with a resolution given More...
Point2d &	round (const Vector2d v)
	Rounds this point in the direction of the given vector and using the resolution of 1.0/64.0. More...
Point2d &	round (const Vector2d v, double quantum)
	Rounds this point in the direction of the given vector and using the given resolution. More...
Vector2d	toVector2d ()
	Copy Point2d into a Vector2d container. More...
double	distance (const Point2d p2) const
	Calculate distance between two points. More...
double	distanceSq (const Point2d p2) const
	Calculate square distance between two points. More...
Vector2d	minus (const Point2d p2)
	Substracts current Point2d with specified Point2d. More...
Point2d	minus (const Vector2d v)
	Substracts current Point2d with specified Vector2d. More...
Point2d	add (const Vector2d v)
	Add specified Vector2d to current Point2d. More...
Point2d &	addEq (const Vector2d v)
	Add specified Vector2d to current Point2d. More...
Point2d &	minusEq (const Vector2d v)
	Substract current Point2d with specified Vector2d. More...
Point2d &	interpolate (double t, const Point2d p1, const Point2d p2)
	Calculate Point2d as interpolation between two points. More...

Public Member Functions
	Point2d ()
	Create a new empty Point2d. More...
	Point2d (double x, double y)
	Create a new Point2d. More...

Properties
double	x
	x value More...
double	y
	y value More...

Detailed Description

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

You can use it in both Script Editor and scriptModule.

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

v

Vector2d

Returns

New Point2d containing result

Point2d& Point2d::addEq ( const Vector2d  v )

slot

Add specified Vector2d to current Point2d.

Parameters

v

Vector2d

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

v

Vector2d

Returns

New Point2d containing result

Point2d& Point2d::minusEq ( const Vector2d  v )

slot

Substract current Point2d with specified Vector2d.

Parameters

v

Vector2d

Returns

Point2d reference

Point2d& Point2d::round ( )

slot

round x and y to floor with a resolution of 1.0/64.0

Point2d& Point2d::round ( double  quantum )

slot

round x and y to floor with a resolution given

Point2d& Point2d::round ( const Vector2d  v )

slot

Rounds this point in the direction of the given vector and using the resolution of 1.0/64.0.

Point2d& Point2d::round ( const Vector2d  v, double  quantum  )

slot

Rounds this point in the direction of the given vector and using the given resolution.

void Point2d::setXY ( const double  , const double    )

slot

Set the value of x, y coordinate.

Vector2d Point2d::toVector2d ( )

slot

Copy Point2d into a Vector2d container.

Returns

Vector2d

Property Documentation

double Point2d::x

readwriteprivate

x value

double Point2d::y

readwriteprivate

y value

---

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

• dox_files/MathInterface.h