Implementation of a point. More...

#include <MFloatPoint.h>

Public Member Functions
	MFloatPoint ()
	Default constructor. More...

	MFloatPoint (const MFloatPoint &srcpt)
	Copy constructor. More...

	MFloatPoint (const MPoint &srcpt)
	Copy constructor. More...

	MFloatPoint (const MFloatVector &src)
	Create a new point and initialize it to the same x, y, z values as the given MFloatVector. More...

	MFloatPoint (const MVector &src)
	Create a new point and initialize it to the same x, y, z values as the given MVector. More...

	MFloatPoint (float xx, float yy, float zz=0.0, float ww=1.0)
	Create a new instance and initialize it to the given position. More...

	MFloatPoint (const float f[4])
	Create a new instance and initialize it to the given position. More...

	MFloatPoint (const double d[4])
	Create a new instance and initialize it to the given position. More...

	~MFloatPoint ()
	Class destructor.

MStatus	get (double dest[4]) const
	Copy the values of x, y, z, and w from the instance to the four elements of the given array of doubles. More...

MStatus	get (float dest[4]) const
	Copy the values of x, y, z, and w from the instance to the four elements of the given array of floats. More...

MStatus	setCast (const MPoint &srcpt)
	Copy the values of x, y, z, and w from srcpt to the instance. More...

MStatus	setCast (const MVector &src)
	Copy the values of x, y, z, and w from src to the instance. More...

MStatus	setCast (const double d[4])
	Copy the values of x, y, z, and w to the instance from the four elements of the given array of doubles. More...

MFloatPoint &	operator= (const MFloatPoint &src)
	The assignment operator. More...

float	operator() (unsigned int i) const
	The index operator. More...

float	operator[] (unsigned int i) const
	The index operator. More...

MFloatVector	operator- (const MFloatPoint &other) const
	The subtraction operator for two MFloatPoints. More...

MFloatPoint	operator+ (const MFloatVector &other) const
	The operator for adding an MFloatVector to an MFloatPoint. More...

MFloatPoint	operator- (const MFloatVector &other) const
	The operator for subtracting an MFloatVector from an MFloatPoint. More...

MFloatPoint &	operator+= (const MFloatVector &vector)
	The in-place addition operator for adding an MFloatVector to an MFloatPoint. More...

MFloatPoint &	operator-= (const MFloatVector &vector)
	The in-place subtraction operator for subtracting an MFloatVector from an MFloatPoint. More...

MFloatPoint	operator* (const int scale) const
	The multipication operator that allows the vector to by scaled by the given parameter. More...

MFloatPoint	operator* (const short scale) const
	The multipication operator that allows the vector to by scaled by the given parameter. More...

MFloatPoint	operator* (const unsigned int scale) const
	The multipication operator that allows the vector to by scaled by the given parameter. More...

MFloatPoint	operator* (const unsigned short scale) const
	The multipication operator that allows the vector to by scaled by the given parameter. More...

MFloatPoint	operator* (const float scale) const
	The multipication operator that allows the vector to by scaled by the given float parameter. More...

MFloatPoint	operator* (const double scale) const
	The multipication operator that allows the vector to by scaled by the given parameter. More...

MFloatPoint	operator/ (const float scale) const
	The division operator that allows the vector to by scaled by the given float parameter. More...

MFloatPoint	operator* (const MFloatMatrix &) const
	The multiplication operator for computing the product of this point instance with the given matrix. More...

MFloatPoint &	operator*= (const MFloatMatrix &)
	The in-place multiplication operator for computing the product of this point instance with the given matrix. More...

MFloatPoint &	operator*= (const int)
	The in-place multiplication operator for computing the scalar product of this point instance with the given scalar. More...

MFloatPoint &	operator*= (const short)
	The in-place multiplication operator for computing the scalar product of this point instance with the given scalar. More...

MFloatPoint &	operator*= (const unsigned int)
	The in-place multiplication operator for computing the scalar product of this point instance with the given scalar. More...

MFloatPoint &	operator*= (const unsigned short)
	The in-place multiplication operator for computing the scalar product of this point instance with the given scalar. More...

MFloatPoint &	operator*= (const float)
	The in-place multiplication operator for computing the scalar product of this point instance with the given scalar. More...

MFloatPoint &	operator*= (const double)
	The in-place multiplication operator for computing the scalar product of this point instance with the given scalar. More...

bool	operator== (const MFloatPoint &other) const
	The equality operator. More...

bool	operator!= (const MFloatPoint &other) const
	The inequality operator. More...

MFloatPoint &	cartesianize ()
	If this point instance is of the form P(Wx, Wy, W*z, W), for some scale factor W != 0, then it is reset to be P(x, y, z, 1). More...

MFloatPoint &	rationalize ()
	If this point instance is of the form P(Wx, Wy, W*z, W) (ie. More...

MFloatPoint &	homogenize ()
	If this point instance is of the form P(x, y, z, W) (ie. More...

float	distanceTo (const MFloatPoint &other) const
	Return the distance between this instance and the point passed as an argument. More...

bool	isEquivalent (const MFloatPoint &other, float tolerance=MFloatPoint_kTol) const
	Returns true if this instance the the point passed as an argument represent the same position within the specified tolerance. More...

float &	operator() (unsigned int i)
	NO SCRIPT SUPPORT. More...

float &	operator[] (unsigned int i)
	NO SCRIPT SUPPORT. More...

Static Public Member Functions
static const char *	className ()
	Returns the name of this class. More...

Public Attributes
float	x
	the x component of the point

float	y
	the y component of the point

float	z
	the z component of the point

float	w
	the w component of the point

Static Public Attributes
static const MFloatPoint	origin
	A constant representing the origin - (0,0,0,1).

Friends
OPENMAYA_EXPORT MFloatPoint	operator* (int, const MFloatPoint &)
	NO SCRIPT SUPPORT. More...

OPENMAYA_EXPORT MFloatPoint	operator* (short, const MFloatPoint &)
	NO SCRIPT SUPPORT. More...

OPENMAYA_EXPORT MFloatPoint	operator* (unsigned int, const MFloatPoint &)
	NO SCRIPT SUPPORT. More...

OPENMAYA_EXPORT MFloatPoint	operator* (unsigned short, const MFloatPoint &)
	NO SCRIPT SUPPORT. More...

OPENMAYA_EXPORT MFloatPoint	operator* (float, const MFloatPoint &)
	NO SCRIPT SUPPORT. More...

OPENMAYA_EXPORT MFloatPoint	operator* (double, const MFloatPoint &)
	NO SCRIPT SUPPORT. More...

OPENMAYA_EXPORT MFloatPoint	operator* (const MFloatMatrix &, const MFloatPoint &)
	NO SCRIPT SUPPORT. More...

OPENMAYA_EXPORT std::ostream &	operator<< (std::ostream &os, const MFloatPoint &p)
	NO SCRIPT SUPPORT. More...

Detailed Description

Implementation of a point.

This class provides an implementation of a point in float. Numerous convienence operators are provided to help with the manipulation of points. This includes operators that work with the MFloatVector and MFloatMatrix classes.

All methods that query the point are threadsafe, all methods that modify the point are not threadsafe.

Examples:: anisotropicShader/anisotropicShader.cpp, blindDataShader/blindDataMesh.cpp, cellShader/cellShader.cpp, dx11Shader/dx11Shader.cpp, flameShader/flameShader.cpp, glslShader/GLSLShader.cpp, gpuCache/CacheReaderAlembic.cpp, gpuCache/gpuCacheDrawOverride.cpp, gpuCache/gpuCacheUtil.h, hwPhongShader/hwPhongShader.cpp, intersectCmd/intersectCmd.cpp, lavaShader/lavaShader.cpp, meshOpCmd/meshOpFtyAction.cpp, noiseShader/noiseShader.cpp, polyPrimitiveCmd/polyPrimitiveCmd.cpp, renderAccessNode/renderAccessNode.cpp, sampleCmd/sampleCmd.cpp, sampleParticles/sampleParticles.cpp, shellNode/shellNode.cpp, solidCheckerShader/solidCheckerShader.cpp, sseDeformer/sseDeformer.cpp, threadedBoundingBox/threadedBoundingBox.cpp, uiDrawManager/uiDrawManager.cpp, viewMRenderOverride/viewMRenderOverride.cpp, viewRenderOverride/viewRenderOverride.cpp, viewRenderOverride/viewRenderOverride.h, viewRenderOverride/viewRenderOverrideOperations.cpp, viewRenderOverrideMRT/viewRenderOverrideMRT.cpp, and viewRenderOverrideMRT/viewRenderOverrideMRT.h.

Constructor & Destructor Documentation

OPENMAYA_NAMESPACE_CLOSE OPENMAYA_MAJOR_NAMESPACE_OPEN MFloatPoint ( )

inline

Default constructor.

The instance is initialized to the origin.

MFloatPoint ( const MFloatPoint & srcpt )

inline

Copy constructor.

Creates an new instance and initializes it to the same point as the given point.

Parameters

[in] srcpt the point object to copy

MFloatPoint ( const MPoint & srcpt )

inline

Copy constructor.

Creates an new instance and initializes it to the same point as the given point.

Warning: This method converts double precision floating point values to single precision. This will result in a loss of precision and, if the double precision value exceeds the valid range for single precision, the result will be undefined and unusable.

Parameters

[in] srcpt the point object to copy

MFloatPoint ( const MFloatVector & srcpt )

inline

Create a new point and initialize it to the same x, y, z values as the given MFloatVector.

Parameters

[in] srcpt the vector object to copy

MFloatPoint ( const MVector & srcpt )

inline

Create a new point and initialize it to the same x, y, z values as the given MVector.

Warning: This method converts double precision floating point values to single precision. This will result in a loss of precision and, if the double precision value exceeds the valid range for single precision, the result will be undefined and unusable.

Parameters

[in] srcpt the vector object to copy

MFloatPoint	(	float	xx,
		float	yy,
		float	zz = `0.0`,
		float	ww = `1.0`
	)

inline

Create a new instance and initialize it to the given position.

Parameters

[in]	xx	the initial value of x
[in]	yy	the initial value of y
[in]	zz	the initial value of z
[in]	ww	the initial value of w

MFloatPoint ( const float f[4] )

inline

Create a new instance and initialize it to the given position.

Parameters

[in] f an array of 4 floats used to initialize x, y, z, and w respectively

MFloatPoint ( const double d[4] )

inline

Create a new instance and initialize it to the given position.

Warning: This method converts double precision floating point values to single precision. This will result in a loss of precision and, if the double precision value exceeds the valid range for single precision, the result will be undefined and unusable.

Parameters

[in] d an array of 4 doubles used to initialize x, y, z, and w respectively

Member Function Documentation

MStatus get ( double dest[4] ) const

inline

Copy the values of x, y, z, and w from the instance to the four elements of the given array of doubles.

Parameters

[out] dest the four element array of doubles

Returns: MS::kSuccess if dest is a non-zero pointer and MS::kFailure otherwise.

MStatus get ( float dest[4] ) const

inline

Copy the values of x, y, z, and w from the instance to the four elements of the given array of floats.

Parameters

[out] dest the four element array of floats

Returns: MS::kSuccess if dest is a non-zero pointer and MS::kFailure otherwise.

MStatus setCast ( const MPoint & srcpt )

inline

Copy the values of x, y, z, and w from srcpt to the instance.

Warning: This method converts double precision floating point values to single precision. This will result in a loss of precision and, if the double precision value exceeds the valid range for single precision, the result will be undefined and unusable.

Parameters

[in] srcpt the point to copy the x, y, z and w values from.

Returns: MS::kSuccess always returned.

MStatus setCast ( const MVector & src )

inline

Copy the values of x, y, z, and w from src to the instance.

Warning: This method converts double precision floating point values to single precision. This will result in a loss of precision and, if the double precision value exceeds the valid range for single precision, the result will be undefined and unusable.

Parameters

[in] src the vector to copy the x, y, z and w values from.

Returns: MS::kSuccess always returned.

MStatus setCast ( const double d[4] )

inline

Copy the values of x, y, z, and w to the instance from the four elements of the given array of doubles.

Warning: This method converts double precision floating point values to single precision. This will result in a loss of precision and, if the double precision value exceeds the valid range for single precision, the result will be undefined and unusable.

Parameters

[in] d the four element array of doubles

Returns: MS::kSuccess if dest is a non-zero pointer and MS::kFailure otherwise

MFloatPoint & operator= ( const MFloatPoint & src )

inline

The assignment operator.

Parameters

[in] src The point to copy from.

float operator() ( unsigned int i ) const

inline

The index operator.

If the argument is 0 it will return the x component of the constant instance.
If the argument is 1 it will return the y component of the constant instance.
If the argument is 2 it will return the z component of the constant instance.
If the argument is 3 it will return the w component of the constant instance. Otherwise it will return the x component of the point.

Parameters

[in] i value indicating which component to return

Returns: The value of the indicated component of the instance.

float operator[] ( unsigned int i ) const

inline

The index operator.

If the argument is 0 it will return the x component of the constant instance.
If the argument is 1 it will return the y component of the constant instance.
If the argument is 2 it will return the z component of the constant instance.
If the argument is 3 it will return the w component of the constant instance. Otherwise it will return the x component of the point.

Parameters

[in] i value indicating which component to return

Returns: The value of the indicated component of the instance.

MFloatVector operator- ( const MFloatPoint & other ) const

inline

The subtraction operator for two MFloatPoints.

The result is the MFloatVector from the other point to this instance.

Parameters

[in] other The point to substract.

Returns: MFloatVector from the other point to this point.

MFloatPoint operator+ ( const MFloatVector & other ) const

inline

The operator for adding an MFloatVector to an MFloatPoint.

A new point is returned whose position is that of the original point translated by the vector.

Parameters

[in] other The vector to add.

MFloatPoint operator- ( const MFloatVector & other ) const

inline

The operator for subtracting an MFloatVector from an MFloatPoint.

A new point is returned whose position is that of the original point translated by the inverse of the vector.

Parameters

[in] other The vector to substract.

MFloatPoint & operator+= ( const MFloatVector & vector )

inline

The in-place addition operator for adding an MFloatVector to an MFloatPoint.

The current instance is translated from its original position by the vector.

Parameters

[in] vector The vector to add.

MFloatPoint & operator-= ( const MFloatVector & vector )

inline

The in-place subtraction operator for subtracting an MFloatVector from an MFloatPoint.

The current instance is translated from its original position by the inverse of the vector.

Parameters

[in] vector The vector to substract.

MFloatPoint operator* ( const int scale ) const

inline

The multipication operator that allows the vector to by scaled by the given parameter.

The x, y, and z components are each multiplied by the parameter. The w component remains unchanged.

Parameters