Skip to main content
View as Markdown

IPCB_RadialDimension interface

A radial dimension on a PCB document, which measures the radius of an arc or a circle.

public interface IPCB_RadialDimension : IPCB_Dimension

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Inherits: IPCB_Primitive → IPCB_Group → IPCB_Dimension

Derived: IPCB_RadialDiameterDimension

Remarks​

A radial dimension has two references: reference 0 is the arc whose radius is measured and reference 1 is the point where the dimension line bends. When the primitives are regenerated, TextValue is set to the radius of the arc (for a pad with a round hole, half the hole size; 0 when reference 0 refers to neither) and the dimension's location (XLocation, YLocation) is set to the bend point.

The dimension line runs from the arc to the bend point and from there to the text location (TextX, TextY), with the arrowhead on the arc. The directions of both parts are rounded to multiples of AngleStep. With ArrowPosition set to TDimensionArrowPosition.eInside, the first part starts at the center of the arc instead. When the text location lies inside the circle, the dimension is drawn inside it, with the bend point halfway between the arc and the text location.

A new radial dimension has the text prefix "R ", TextPosition set to TDimensionTextPosition.eTextUniDirectional, ArrowPosition set to TDimensionArrowPosition.eOutside and an AngleStep of 45. While the dimension refers to an arc that is not selected, MoveByXY and RotateAroundXY do not change its references or its text location.

The text and the four tracks that draw the dimension are returned by Text, Arrow_Track1, Arrow_Track2, Line1_Track and Line2_Track.

Properties​

PropertyTypeAccessDescription
AngleStepdoubleget; setThe angular step, in degrees, to which the directions of the dimension line are rounded.

AngleStep​

The angular step, in degrees, to which the directions of the dimension line are rounded.

double GetState_AngleStep();
void SetState_AngleStep(double argValue);

Type: double · Access: read/write

When the primitives are regenerated, the direction from the center of the arc to the bend point (reference 1) is rounded to a multiple of this step within the arc's range of angles, or to the nearest end of that range when it lies outside it, and the direction from the bend point to the text location (TextX, TextY) is rounded to a multiple of this step. The default is 45.

Methods​

MethodReturnsDescription
Arrow_Track1IPCB_TrackReturns one of the two tracks of the arrowhead on the arc.
Arrow_Track2IPCB_TrackReturns one of the two tracks of the arrowhead on the arc.
Line1_TrackIPCB_TrackReturns the part of the dimension line that runs from the arc to the bend point.
Line2_TrackIPCB_TrackReturns the part of the dimension line that runs from the bend point to the text location.
TextIPCB_TextReturns the text that shows the measured radius.

Arrow_Track1​

Returns one of the two tracks of the arrowhead on the arc.

IPCB_Track Arrow_Track1();

Returns: IPCB_Track

Extension method of IPCB_RadialDimensionHelper (using PCB;).

Arrow_Track2​

Returns one of the two tracks of the arrowhead on the arc.

IPCB_Track Arrow_Track2();

Returns: IPCB_Track

Extension method of IPCB_RadialDimensionHelper (using PCB;).

Line1_Track​

Returns the part of the dimension line that runs from the arc to the bend point.

IPCB_Track Line1_Track();

Returns: IPCB_Track

Extension method of IPCB_RadialDimensionHelper (using PCB;).

With ArrowPosition set to TDimensionArrowPosition.eInside and the text location outside the circle, the line starts at the center of the arc. It is drawn with the width ArrowLineWidth.

Line2_Track​

Returns the part of the dimension line that runs from the bend point to the text location.

IPCB_Track Line2_Track();

Returns: IPCB_Track

Extension method of IPCB_RadialDimensionHelper (using PCB;).

It is drawn with the width ArrowLineWidth.

Text​

Returns the text that shows the measured radius.

IPCB_Text Text();

Returns: IPCB_Text

Extension method of IPCB_RadialDimensionHelper (using PCB;).

With TextPosition set to TDimensionTextPosition.eTextUniDirectional (the default), the text is horizontal, vertically centered on the text location and placed TextGap to its right, or to its left when the line from the bend point runs leftwards.

Inherited members​