Namespace: Autodesk.Revit.DB Class: XYZ

XYZ.IsAlmostEqualTo(XYZ, Double)

Method

Description:
Determines whether 2 vectors are the same within the given tolerance.

Remarks:
This routine uses an input tolerance to compare two vectors to see if they are almost equivalent. Because it is comparing two vectors the tolerance value is not in length units but instead represents the variation in direction between the vectors. For very small tolerance values it should also be possible to compare two points with this method. To compute the distance between two points for a comparison with a larger allowable difference, use DistanceTo(XYZ).

Syntax

public bool IsAlmostEqualTo(
	XYZ source,
	double tolerance
)

Public Function IsAlmostEqualTo ( 
	source As XYZ,
	tolerance As Double
) As Boolean

public:
bool IsAlmostEqualTo(
	XYZ^ source, 
	double tolerance
)

member IsAlmostEqualTo : 
        source : XYZ * 
        tolerance : float -> bool

Parameters

Parameter	Type	Description
source	XYZ	The vector to compare with this vector.
tolerance	Double	The tolerance for equality check.

Return Value

Type	Description
Boolean	True if the vectors are the same; otherwise, false.

Exceptions

Exception	Condition
ArgumentNullException	Thrown when source is.
ArgumentException	Thrown when tolerance is less than 0.