CogMath.InsidePointCircle Method

CogMath InsidePointCircle Method

Cognex VisionPro 9.7

Returns whether the given point is inside the given circle.

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 73.0.0.0

Syntax

public static bool InsidePointCircle(
	double x,
	double y,
	CogCircle circle,
	ICogImage image
)

public static bool InsidePointCircle(
	double x,
	double y,
	CogCircle circle,
	ICogImage image
)

Public Shared Function InsidePointCircle ( 
	x As Double,
	y As Double,
	circle As CogCircle,
	image As ICogImage
) As Boolean

Public Shared Function InsidePointCircle ( 
	x As Double,
	y As Double,
	circle As CogCircle,
	image As ICogImage
) As Boolean

public:
static bool InsidePointCircle(
	double x, 
	double y, 
	CogCircle^ circle, 
	ICogImage^ image
)

public:
static bool InsidePointCircle(
	double x, 
	double y, 
	CogCircle^ circle, 
	ICogImage^ image
)

Parameters

x: Type: System Double
The x-coordinate of the point to test.

y: Type: System Double
The y-coordinate of the point to test.

circle: Type: Cognex.VisionPro CogCircle
The circle.

image: Type: Cognex.VisionPro ICogImage
An image that specifies the coordinate space to use.

Return Value

Type: Boolean

True if the point (x,y) is in or on the circle.

Exceptions

Exception	Condition
ArgumentException	circle is NULL.
CogSpaceTreeInvalidNameSyntaxException	At least one shape's selected space names is not a legal space name.
CogSpaceTreeNotUniqueException	At least one shape's selected space names is a nonqualified space name and more than one instance of it exists in image's coordinate space tree.
CogSpaceTreeNotInTreeException	At least one shape does not exist in image's coordinate space tree.
CogImageNoTreeException	The coordinate space tree is missing from image.

Remarks

Returns true if the given point is on or in circle.

If you supply a value for the image parameter, then circle is mapped to the selected space of image before the measurement is computed and the result is expressed in that space. x and y are presumed to be expressed in the selected space of image.

If you do not supply a value for image, then circle, x, and y are presumed to be in the same coordinate space.