OpenMaya.MFloatPoint Class Reference

Class Description

3D point with single-precision coordinates.

---

Constructors

Signature	Parameters	Description
MFloatPoint()		Default constructor. Returns a new MFloatPoint object, initialized to the origin.
MFloatPoint(src)	src - MFloatPoint, MPoint, MFloatVector or MVector	Copy constructor. Returns a new MFloatPoint object with its x, y, z and w coords set to the same values as src. If src is a vector then the new MFloatPoint's w coordinate is set to 1.0.
MFloatPoint(seq)	seq - sequence of two, three or four Floats	Returns a new MFloatPoint 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.
MFloatPoint(x, y, z=0.0, w=1.0)	x - Float y - Float z - Float w - Float	Returns a new MFloatPoint object with the specified x, y, z and w coordinates.

Sequence Support

An MFloatPoint 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
MFloatPoint = MFloatPoint + MFloatVector	Addition of a vector to a point.
MFloatPoint += MFloatVector	In-place addition of a vector to the point. Returns a new reference to the point.
MFloatPoint = MFloatPoint - MFloatVector	Subtraction of a vector from a point.
MFloatPoint -= MFloatVector	In-place subtraction of a vector from a point. Returns a new reference to the point.
MFloatVector = MFloatPoint - MFloatPoint	Vector difference between two points.
MFloatPoint = MFloatMatrix* MFloatPoint	Pre-multiplication of a point by a matrix.
MFloatPoint = MFloatPoint * MFloatMatrix	Post-multiplication of a point by a matrix.
MFloatPoint *= MFloatMatrix	In-place post-multiplication of a point by a matrix. Returns a new reference to the point.
MFloatPoint = MFloatPoint * scalar	Multiplication of a point by a scalar. The scalar must be convertable to Float.
MFloatPoint = MFloatPoint / scalar	Division of a point by a scalar. The scalar must be convertable to Float.

Comparison Support

MFloatPoint == MFloatPoint	Returns True if each component of the first point is exactly equal to the corresponding component of the second.
MFloatPoint != MFloatPoint	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.MFloatPoint:

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.MFloatPoint(0, 0, 0, 1)
float	kTolerance = 9.999999747378752e-06

Properties
	w
	x
	y
	z

Constructor & Destructor Documentation

OpenMaya.MFloatPoint.__init__

(

)

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

Member Function Documentation

OpenMaya.MFloatPoint.__add__

(

)

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

OpenMaya.MFloatPoint.__delitem__

(

)

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

OpenMaya.MFloatPoint.__div__

(

)

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

OpenMaya.MFloatPoint.__eq__

(

)

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

OpenMaya.MFloatPoint.__ge__

(

)

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

OpenMaya.MFloatPoint.__getitem__

(

)

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

OpenMaya.MFloatPoint.__gt__

(

)

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

OpenMaya.MFloatPoint.__iadd__

(

)

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

OpenMaya.MFloatPoint.__imul__

(

)

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

OpenMaya.MFloatPoint.__isub__

(

)

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

OpenMaya.MFloatPoint.__le__

(

)

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

OpenMaya.MFloatPoint.__len__

(

)

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

OpenMaya.MFloatPoint.__lt__

(

)

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

OpenMaya.MFloatPoint.__mul__

(

)

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

OpenMaya.MFloatPoint.__ne__

(

)

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

OpenMaya.MFloatPoint.__radd__

(

)

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

OpenMaya.MFloatPoint.__rdiv__

(

)

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

OpenMaya.MFloatPoint.__repr__

(

)

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

OpenMaya.MFloatPoint.__rmul__

(

)

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

OpenMaya.MFloatPoint.__rsub__

(

)

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

OpenMaya.MFloatPoint.__setitem__

(

)

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

OpenMaya.MFloatPoint.__str__

(

)

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

OpenMaya.MFloatPoint.__sub__

(

)

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

OpenMaya.MFloatPoint.cartesianize

(

)

Convert point to cartesian form.

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

OpenMaya.MFloatPoint.distanceTo

(

)

Return distance between this point and another.

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

OpenMaya.MFloatPoint.homogenize

(

)

Convert point to homogenous form.

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

OpenMaya.MFloatPoint.isEquivalent

(

)

Test for equivalence of two points, within a tolerance.

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

OpenMaya.MFloatPoint.rationalize

(

)

Convert point to rational form.

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

Member Data Documentation

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

static

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

OpenMaya.MFloatPoint.kTolerance = 9.999999747378752e-06

static

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

Property Documentation

OpenMaya.MFloatPoint.w

static

 W coordinate

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

OpenMaya.MFloatPoint.x

static

 X coordinate

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

OpenMaya.MFloatPoint.y

static

 Y coordinate

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

OpenMaya.MFloatPoint.z

static

 Z coordinate

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