OpenMaya.MPoint Class Reference

Class Description

3D point with double-precision coordinates.

---

Constructors

Signature	Parameters	Description
MPoint()		Default constructor. Returns a new MPoint object, initialized to the origin.
MPoint(src)	src - MPoint, MFloatPoint, MVector or MFloatVector	Copy constructor. Returns a new MPoint object with its x, y, z and w coords set to the same values as src. If src is a vector then the new MPoint's w coordinate is set to 1.0.
MPoint(seq)	seq - sequence of two, three or four floats	Returns a new MPoint object whose x, y, z and w coordinates are set to the elements of seq. If the sequence contains fewer than four values w will be set to 1.0. If the sequence contains fewer than three values z will be set to 0.0.
MPoint(x, y, z=0.0, w=1.0)	x - float y - float z - float w - float	Returns a new MPoint object with the specified x, y, z and w coordinates.

Sequence Support

An MPoint is treated a sequence of four float values: [x, y, z, w].

len() returns 4.

Indexing and element assignment are supported.

Deletion, concatenation, repetition and slicing are not supported.

Number Support

Operation	Description
MPoint = MPoint + MVector	Addition of a vector to a point.
MPoint += MVector	In-place addition of a vector to the point. Returns a new reference to the point.
MPoint = MPoint - MVector	Subtraction of a vector from a point.
MPoint -= MVector	In-place subtraction of a vector from a point. Returns a new reference to the point.
MVector = MPoint - MPoint	Vector difference between two points.
MPoint = MMatrix* MPoint	Pre-multiplication of a point by a matrix.
MPoint = MPoint * MMatrix	Post-multiplication of a point by a matrix.
MPoint *= MMatrix	In-place post-multiplication of a point by a matrix. Returns a new reference to the point.
MPoint = MPoint * scalar	Multiplication of a point by a scalar. The scalar must be convertable to float.
MPoint = MPoint / scalar	Division of a point by a scalar. The scalar must be convertable to float.

Comparison Support

MPoint == MPoint	Returns True if each component of the first point is exactly equal to the corresponding component of the second.
MPoint != MPoint	Returns False is any component of the first point is not exactly equal to the corresponding component of the second.

All other comparison operators will raise a TypeError exception.

 

---

Inheritance diagram for OpenMaya.MPoint:

Public Member Functions
	__add__ ()
	__delitem__ ()
	__div__ ()
	__eq__ ()
	__ge__ ()
	__getitem__ ()
	__gt__ ()
	__iadd__ ()
	__imul__ ()
	__init__ ()
	__isub__ ()
	__le__ ()
	__len__ ()
	__lt__ ()
	__mul__ ()
	__ne__ ()
	__radd__ ()
	__rdiv__ ()
	__repr__ ()
	__rmul__ ()
	__rsub__ ()
	__setitem__ ()
	__str__ ()
	__sub__ ()
	cartesianize ()
	distanceTo ()
	homogenize ()
	isEquivalent ()
	rationalize ()

Static Public Attributes
tuple	kOrigin = maya.api.OpenMaya.MPoint(0, 0, 0, 1)
int	kTolerance = 1

Properties
	w
	x
	y
	z

Constructor & Destructor Documentation

OpenMaya.MPoint.__init__

(

)

x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

OpenMaya.MPoint.__add__

(

)

x.__add__(y) <==> x+y

OpenMaya.MPoint.__delitem__

(

)

x.__delitem__(y) <==> del x[y]

OpenMaya.MPoint.__div__

(

)

x.__div__(y) <==> x/y

OpenMaya.MPoint.__eq__

(

)

x.__eq__(y) <==> x==y

OpenMaya.MPoint.__ge__

(

)

x.__ge__(y) <==> x>=y

OpenMaya.MPoint.__getitem__

(

)

x.__getitem__(y) <==> x[y]

OpenMaya.MPoint.__gt__

(

)

x.__gt__(y) <==> x>y

OpenMaya.MPoint.__iadd__

(

)

x.__iadd__(y) <==> x+=y

OpenMaya.MPoint.__imul__

(

)

x.__imul__(y) <==> x*=y

OpenMaya.MPoint.__isub__

(

)

x.__isub__(y) <==> x-=y

OpenMaya.MPoint.__le__

(

)

x.__le__(y) <==> x<=y

OpenMaya.MPoint.__len__

(

)

x.__len__() <==> len(x)

OpenMaya.MPoint.__lt__

(

)

x.__lt__(y) <==> x<y

OpenMaya.MPoint.__mul__

(

)

x.__mul__(y) <==> x*y

OpenMaya.MPoint.__ne__

(

)

x.__ne__(y) <==> x!=y

OpenMaya.MPoint.__radd__

(

)

x.__radd__(y) <==> y+x

OpenMaya.MPoint.__rdiv__

(

)

x.__rdiv__(y) <==> y/x

OpenMaya.MPoint.__repr__

(

)

x.__repr__() <==> repr(x)

OpenMaya.MPoint.__rmul__

(

)

x.__rmul__(y) <==> y*x

OpenMaya.MPoint.__rsub__

(

)

x.__rsub__(y) <==> y-x

OpenMaya.MPoint.__setitem__

(

)

x.__setitem__(i, y) <==> x[i]=y

OpenMaya.MPoint.__str__

(

)

x.__str__() <==> str(x)

OpenMaya.MPoint.__sub__

(

)

x.__sub__(y) <==> x-y

OpenMaya.MPoint.cartesianize

(

)

Convert point to cartesian form.

Signature:	cartesianize()
Parameters:
Returns:	Reference to self.
Description:	Converts this point to cartesian form.

OpenMaya.MPoint.distanceTo

(

)

Return distance between this point and another.

Signature:	distanceTo(other)
Parameters:	other - MPoint
Returns:	float
Description:	Returns the distance between this point and other.

OpenMaya.MPoint.homogenize

(

)

Convert point to homogenous form.

Signature:	homogenize()
Parameters:
Returns:	Reference to self.
Description:	Converts this point to homogenous form.

OpenMaya.MPoint.isEquivalent

(

)

Test for equivalence of two points, within a tolerance.

Signature:	isEquivalent(other, tol=kTolerance)
Parameters:	other - MPoint tol - float
Returns:	Bool
Description:	Returns True if the coordinates of this point and other are equal to within a tolerance of tol.

OpenMaya.MPoint.rationalize

(

)

Convert point to rational form.

Signature:	rationalize()
Parameters:
Returns:	Reference to self.
Description:	Converts this point to rational form.

Member Data Documentation

OpenMaya.MPoint.kOrigin = maya.api.OpenMaya.MPoint(0, 0, 0, 1)

static

Name:	kOrigin
Type:	MPoint
Description:	(0, 0, 0, 1)

OpenMaya.MPoint.kTolerance = 1

static

Name:	kTolerance
Type:	float
Description:	Default tolerance used for inexact comparisons.

Property Documentation

OpenMaya.MPoint.w

static

 W coordinate

Name:	w
Type:	float
Access:	RW
Description:	W coordinate

OpenMaya.MPoint.x

static

 X coordinate

Name:	x
Type:	float
Access:	RW
Description:	X coordinate

OpenMaya.MPoint.y

static

 Y coordinate

Name:	y
Type:	float
Access:	RW
Description:	Y coordinate

OpenMaya.MPoint.z

static

 Z coordinate

Name:	z
Type:	float
Access:	RW
Description:	Z coordinate