Point3d Class Reference

#include <MathInterface.h>

Inheritance diagram for Point3d:

Collaboration diagram for Point3d:

Public Slots
void	setXYZ (const double x, const double y, const double z)
	Set the x, y, z coordinate to the given. More...
bool	isOrigin () const
	Test if Point3d is at origin. More...
bool	isEqual (const Point3d p2) const
	Test if current Point3d is equal to specified Point3d. More...
bool	isNotEqual (const Point3d p2) const
	Test if current Point3d is not equal to specified Point3d. More...
double	distance (const Point3d p2) const
	Calculate distance between current Point3d and specified Point3d. More...
double	distanceSq (const Point3d p2) const
	Calculate square distance between current Point3d and specified Point3d. More...
Point3d &	round (const double quantum)
	Round x, y coordinate to floor with the given resolution. More...
Point3d &	interpolate (double t, const Point3d p1, const Point3d p2)
	Calculate Point3d as interpolation between two points. More...
Point3d	add (const Vector3d v)
	Add specified Vector3d to current Point3d. More...
Point3d	minus (const Vector3d v)
	Substracts current Point3d with specified Vector3d. More...
Vector3d	minus (const Point3d p2)
	Substracts current Point3d with specified Point3d. More...
Point3d &	addEq (const Vector3d v)
	Add specified Vector3d to current Point3d. More...
Point3d &	minusEq (const Vector3d v)
	Substract current Point3d with specified Vector3d. More...
Point2d	toPoint2d ()
	Convert current Point3d to bi-dimensionnal Point2d. More...

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

Properties
double	x
double	y
double	z

Detailed Description

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

You can use it in both Script Editor and scriptModule.

Constructor & Destructor Documentation

Point3d::Point3d

(

)

Create a new empty Point3d.

Point3d::Point3d	(	double	x,
		double	y,
		double	z
	)

Create a new Point3d.

Parameters

x	X value
y	Y value
z	Z value

Member Function Documentation

Point3d Point3d::add ( const Vector3d  v )

slot

Add specified Vector3d to current Point3d.

Parameters

v

Vector3d

Returns

New Point3d containing result

Point3d& Point3d::addEq ( const Vector3d  v )

slot

Add specified Vector3d to current Point3d.

Parameters

v

Vector3d

Returns

Point3d reference

double Point3d::distance ( const Point3d  p2 ) const

slot

Calculate distance between current Point3d and specified Point3d.

Parameters

p2	Second Point3d

Returns

Distance value

double Point3d::distanceSq ( const Point3d  p2 ) const

slot

Calculate square distance between current Point3d and specified Point3d.

Parameters

p2	Second Point3d

Returns

Square distance value

Point3d& Point3d::interpolate ( double  t, const Point3d  p1, const Point3d  p2  )

slot

Calculate Point3d as interpolation between two points.

Parameters

t	Factor of interpolation [ 0, 1 ]
p1	First Point3d
p2	Second Point3d

Returns

Point3d reference

bool Point3d::isEqual ( const Point3d  p2 ) const

slot

Test if current Point3d is equal to specified Point3d.

Parameters

p2	Second Point3d

Returns

Result of test

bool Point3d::isNotEqual ( const Point3d  p2 ) const

slot

Test if current Point3d is not equal to specified Point3d.

Parameters

p2	Second Point3d

Returns

Result of test

bool Point3d::isOrigin ( ) const

slot

Test if Point3d is at origin.

Returns

Result of test

Point3d Point3d::minus ( const Vector3d  v )

slot

Substracts current Point3d with specified Vector3d.

Parameters

v

Vector3d

Returns

New Point3d containing result

Vector3d Point3d::minus ( const Point3d  p2 )

slot

Substracts current Point3d with specified Point3d.

Parameters

p2	Second Point3d

Returns

New Point3d containing result

Point3d& Point3d::minusEq ( const Vector3d  v )

slot

Substract current Point3d with specified Vector3d.

Parameters

v

Vector3d

Returns

Point3d reference

Point3d& Point3d::round ( const double  quantum )

slot

Round x, y coordinate to floor with the given resolution.

void Point3d::setXYZ ( const double  x, const double  y, const double  z  )

slot

Set the x, y, z coordinate to the given.

Point2d Point3d::toPoint2d ( )

slot

Convert current Point3d to bi-dimensionnal Point2d.

Returns

new Point2d

Property Documentation

double Point3d::x

readwriteprivate

double Point3d::y

readwriteprivate

double Point3d::z

readwriteprivate

---

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

• dox_files/MathInterface.h