Script
Public Slots | Public Member Functions | Properties | List of all members
Point3d Class Reference

#include <math.h>

Inheritance diagram for Point3d:
Inheritance graph
[legend]
Collaboration diagram for Point3d:
Collaboration graph
[legend]

Public Slots

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

Public Member Functions

 Point3d ()
 Create a new empty Point3d.
 
 Point3d (double x, double y, double z)
 Create a new Point3d.
 

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
xX value
yY value
zZ value

Member Function Documentation

Point3d Point3d::add ( Vector3d  v)
slot

Add specified Vector3d to current Point3d.

Parameters
vVector3d
Returns
New Point3d containing result
Point3d& Point3d::addEq ( Vector3d  v)
slot

Add specified Vector3d to current Point3d.

Parameters
vVector3d
Returns
Point3d reference
double Point3d::distance ( Point3d  p2)
slot

Calculate distance between current Point3d and specified Point3d.

Parameters
p2Second Point3d
Returns
Distance value
double Point3d::distanceSq ( Point3d  p2)
slot

Calculate square distance between current Point3d and specified Point3d.

Parameters
p2Second Point3d
Returns
Square distance value
Point3d& Point3d::interpolate ( double  t,
Point3d  p1,
Point3d  p2 
)
slot

Calculate Point3d as interpolation between two points.

Parameters
tFactor of interpolation [ 0, 1 ]
p1First Point3d
p2Second Point3d
Returns
Point3d reference
bool Point3d::isEqual ( Point3d  p2)
slot

Test if current Point3d is equal to specified Point3d.

Parameters
p2Second Point3d
Returns
Result of test
bool Point3d::isNotEqual ( Point3d  p2)
slot

Test if current Point3d is not equal to specified Point3d.

Parameters
p2Second Point3d
Returns
Result of test
bool Point3d::isOrigin ( )
slot

Test if Point3d is at origin.

Returns
Result of test
Point3d Point3d::minus ( Vector3d  v)
slot

Substracts current Point3d with specified Vector3d.

Parameters
vVector3d
Returns
New Point3d containing result
Vector3d Point3d::minus ( Point3d  p2)
slot

Substracts current Point3d with specified Point3d.

Parameters
p2Second Point3d
Returns
New Point3d containing result
Point3d& Point3d::minusEq ( Vector3d  v)
slot

Substract current Point3d with specified Vector3d.

Parameters
vVector3d
Returns
Point3d reference
Point3d& Point3d::round ( double  quantum)
slot

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

void Point3d::setXYZ ( double  x,
double  y,
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
readwrite
double Point3d::y
readwrite
double Point3d::z
readwrite

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