CogCircularAnnulusSection.RadialScale Property

CogCircularAnnulusSection RadialScale Property

Cognex VisionPro 9.8

Returns/sets the radial scale of this annular section. Note that this can be less than or greater than 1 (but not equal to 1, and not <=0) and therefore implies a radial direction.

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

Syntax

C++

Copy to Clipboard Print

public double RadialScale { get; set; }

public double RadialScale { get; set; }

Public Property RadialScale As Double 
	Get 
	Set

Public Property RadialScale As Double 
	Get 
	Set

public:
property double RadialScale {
	double get ();
	void set (double value);
}

public:
property double RadialScale {
	double get ();
	void set (double value);
}

Property Value

Type: Double

Events

Event Type	Reason
CogCircularAnnulusSection Changed	Fires when the value of this property changes. The following state flags may be affected:

Event Type

Reason

CogCircularAnnulusSection Changed

Fires when the value of this property changes.

The following state flags may be affected:

Exceptions

Exception	Condition
ArgumentException	Value <= 0.0 or Value = 1.0

Remarks

Sets or gets the radial scale of this annulus section.

The radial scale determines the relative sizes of the two arcs that make up the annulus section. The two arcs are scaled copies of each other. The start arc is specified by setting the AngleStart and AngleSpan properties. The end arc is specified by applying a radial scale to the start arc.

RadialScale determines which arc is the inner arc and which arc is the outer arc. It also implies a radial direction as shown:

Effect of RadialScale Values

If RadialScale is less than 1:

Start Arc: OuterEnd Arc: InnerRadial Direction: Toward the center

If RadialScale is greater than 1:

Start Arc: InnerEnd Arc: OuterRadial Direction: Away from the center

RadialScale cannot be exactly 1.0, nor can it be less than or equal to zero.

Default Value: 0.5