Cog3DShapeGeometricOperations.AreRealParallel Method (Cog3DLine, Cog3DLine, Double)

Cog3DShapeGeometricOperations AreRealParallel Method (Cog3DLine, Cog3DLine, Double)

Cognex VisionPro

Check whether two lines are parallel including direction or anti-parallel within the specified tolerance. It is the caller responsibility to map the shapes to a common 3D space before calling this method.

Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D.Core (in Cognex.VisionPro3D.Core.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

public static bool AreRealParallel(
	Cog3DLine lineA,
	Cog3DLine lineB,
	double epsilon
)

public static bool AreRealParallel(
	Cog3DLine lineA,
	Cog3DLine lineB,
	double epsilon
)

Public Shared Function AreRealParallel ( 
	lineA As Cog3DLine,
	lineB As Cog3DLine,
	epsilon As Double
) As Boolean

Public Shared Function AreRealParallel ( 
	lineA As Cog3DLine,
	lineB As Cog3DLine,
	epsilon As Double
) As Boolean

public:
static bool AreRealParallel(
	Cog3DLine^ lineA, 
	Cog3DLine^ lineB, 
	double epsilon
)

public:
static bool AreRealParallel(
	Cog3DLine^ lineA, 
	Cog3DLine^ lineB, 
	double epsilon
)

Parameters

lineA: Type: Cognex.VisionPro3D Cog3DLine
The first line. May not be null.

lineB: Type: Cognex.VisionPro3D Cog3DLine
The second line. May not be null.

epsilon: Type: System Double
The tolerance used in checking.

Return Value

Type: Boolean
True if lineA and lineB are parallel including direction or anti-parallel within the specified tolerance, false otherwise.

Exceptions

Exception	Condition
ArgumentNullException	If lineA or lineB is null.
ArgumentException	If lineA is degenerate or lineB is degenerate.

Remarks

Line parallelism checking methods compute the cross product and dot product of the two unit direction vectors of lineA and lineB.

If the length of the cross product vector is less than or equal to epsilon, AreRealParallel() returns true;
If the dot product is greater than 0 and AreRealParallel() is true, AreRealParallelIncludingDirection() returns true;
If the dot product is less than 0 and AreRealParallel() is true, AreRealAntiParallel() returns true.