Cog3DShapeGeometricOperations.AreRealParallel Method (Cog3DPlane, Cog3DPlane, Double)

Cog3DShapeGeometricOperations AreRealParallel Method (Cog3DPlane, Cog3DPlane, Double)

Cognex VisionPro 9.22

Check whether two planes 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: 87.0.0.0

Syntax

C++

Copy to Clipboard Print

public static bool AreRealParallel(
	Cog3DPlane planeA,
	Cog3DPlane planeB,
	double epsilon
)

public static bool AreRealParallel(
	Cog3DPlane planeA,
	Cog3DPlane planeB,
	double epsilon
)

Public Shared Function AreRealParallel ( 
	planeA As Cog3DPlane,
	planeB As Cog3DPlane,
	epsilon As Double
) As Boolean

Public Shared Function AreRealParallel ( 
	planeA As Cog3DPlane,
	planeB As Cog3DPlane,
	epsilon As Double
) As Boolean

public:
static bool AreRealParallel(
	Cog3DPlane^ planeA, 
	Cog3DPlane^ planeB, 
	double epsilon
)

public:
static bool AreRealParallel(
	Cog3DPlane^ planeA, 
	Cog3DPlane^ planeB, 
	double epsilon
)

Parameters

planeA: Type: Cognex.VisionPro3D Cog3DPlane
The first plane. May not be null.

planeB: Type: Cognex.VisionPro3D Cog3DPlane
The second plane. May not be null.

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

Return Value

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

Exceptions

Exception	Condition
ArgumentNullException	If planeA or planeB is null.
ArgumentException	If planeA is degenerate or planeB is degenerate.

Remarks

Plane parallelism checking methods compute the cross product and dot product of the two unit normal vectors of planeA and planeB.

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.