IPCB_LinearDimension interface

A linear dimension on a PCB document, which measures the distance between two reference points in the direction of its angle and shows it with a dimension line, arrowheads, extension lines and a text.

public interface IPCB_LinearDimension : IPCB_Dimension

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Inherits: IPCB_Primitive → IPCB_Group → IPCB_Dimension

Derived: IPCB_LinearDiameterDimension

Remarks

A new linear dimension has two references. The dimension measures the distance between its first two reference points (References 0 and 1) in the direction given by Angle, along a dimension line through the text location (TextX, TextY).

The text and the eight tracks that draw the dimension are returned by Text, Arrow1_Track1, Arrow1_Track2, Arrow2_Track1, Arrow2_Track2, Line_Track1, Line_Track2, Extension1_Track and Extension2_Track.

Properties

Property	Type	Access	Description
Angle	double	get; set	The angle of the dimension line to the horizontal, in degrees.

Angle

The angle of the dimension line to the horizontal, in degrees.

double GetState_Angle();
void SetState_Angle(double argValue);

Type: double · Access: read/write

The default is 0, at which the dimension measures horizontal distances. Rotating the dimension with RotateAroundXY changes the angle by the rotation angle.

Methods

Method	Returns	Description
Arrow1_Track1	IPCB_Track	Returns one of the two tracks of the first arrowhead.
Arrow1_Track2	IPCB_Track	Returns one of the two tracks of the first arrowhead.
Arrow2_Track1	IPCB_Track	Returns one of the two tracks of the second arrowhead.
Arrow2_Track2	IPCB_Track	Returns one of the two tracks of the second arrowhead.
Extension1_Track	IPCB_Track	Returns the extension line at the first reference point.
Extension2_Track	IPCB_Track	Returns the extension line at the second reference point.
Line_Track1	IPCB_Track	Returns one of the two tracks that draw the dimension line.
Line_Track2	IPCB_Track	Returns one of the two tracks that draw the dimension line.
Text	IPCB_Text	Returns the text that shows the measured distance.

Arrow1_Track1

Returns one of the two tracks of the first arrowhead.

IPCB_Track Arrow1_Track1();

Returns: IPCB_Track

Extension method of IPCB_LinearDimensionHelper (using PCB;).

Arrow1_Track2

Returns one of the two tracks of the first arrowhead.

IPCB_Track Arrow1_Track2();

Returns: IPCB_Track

Extension method of IPCB_LinearDimensionHelper (using PCB;).

Arrow2_Track1

Returns one of the two tracks of the second arrowhead.

IPCB_Track Arrow2_Track1();

Returns: IPCB_Track

Extension method of IPCB_LinearDimensionHelper (using PCB;).

Arrow2_Track2

Returns one of the two tracks of the second arrowhead.

IPCB_Track Arrow2_Track2();

Returns: IPCB_Track

Extension method of IPCB_LinearDimensionHelper (using PCB;).

Extension1_Track

Returns the extension line at the first reference point.

IPCB_Track Extension1_Track();

Returns: IPCB_Track

Extension method of IPCB_LinearDimensionHelper (using PCB;).

Extension2_Track

Returns the extension line at the second reference point.

IPCB_Track Extension2_Track();

Returns: IPCB_Track

Extension method of IPCB_LinearDimensionHelper (using PCB;).

Line_Track1

Returns one of the two tracks that draw the dimension line.

IPCB_Track Line_Track1();

Returns: IPCB_Track

Extension method of IPCB_LinearDimensionHelper (using PCB;).

Line_Track2

Returns one of the two tracks that draw the dimension line.

IPCB_Track Line_Track2();

Returns: IPCB_Track

Extension method of IPCB_LinearDimensionHelper (using PCB;).

Text

Returns the text that shows the measured distance.

IPCB_Text Text();

Returns: IPCB_Text

Extension method of IPCB_LinearDimensionHelper (using PCB;).

Inherited members

• From IPCB_Dimension: ArrowLength, ArrowLineWidth, ArrowPosition, ArrowSize, Bold, DimensionKind, ExtensionLineWidth, ExtensionOffset, ExtensionPickGap, FontName, Italic, LineWidth, MoveTextByXY, MoveTextToXY, References, References_Add, References_Count, References_Delete, References_DeleteLast, References_IndexOf, References_Validate, ResetPrefixIfNeeded, RotateAroundXY, Size, Style, TextDimensionUnit, TextFont, TextFormat, TextGap, TextHeight, TextLineWidth, TextPosition, TextPrecision, TextPrefix, TextSuffix, TextValue, TextWidth, TextX, TextY, UseTTFonts, X1Location, Y1Location
• From IPCB_Group: AddPCBObject, FastSetState_XSizeYSize, FreePrimitives, GetPrimitiveAt, GetPrimitiveCount, GroupIterator_Create, GroupIterator_Destroy, LayerUsed, PrimitiveLock, RemovePCBObject, ReplicateWithChildren, SetState_LayersUsedArray, SetState_XSizeYSize, XLocation, YLocation
• From IPCB_Primitive: AllowGlobalEdit, BeginModify, Board, BoundingRectangle, BoundingRectangleChildren, BoundingRectangleForPainting, BoundingRectangleForSelection, CancelModify, Component, Coordinate, DescriptorString, DetailString, Dimension, DrawAsPreview, DRCError, Enabled, Enabled_Direct, Enabled_vComponent, Enabled_vCoordinate, Enabled_vDimension, Enabled_vNet, Enabled_vPolygon, EnableDraw, EndModify, Export_ToParameters, FlipXY, GraphicallyInvalidate, Handle, Identifier, InBoard, InComponent, InCoordinate, Index, InDimension, InNet, InPolygon, InSelectionMemory, IsAssyTestPoint_Bottom, IsAssyTestPoint_Top, IsElectricalPrim, IsFreePrimitive, IsHidden, IsKeepout, IsPreRoute, IsSaveable, IsTenting, IsTenting_Bottom, IsTenting_Top, IsTestPoint_Bottom, IsTestPoint_Top, Layer, MiscFlag1, MiscFlag2, MiscFlag3, Moveable, MoveByXY, MoveToXY, Net, ObjectID, ObjectIDString, PadCacheRobotFlag, PasteMaskExpansion, Polygon, PolygonOutline, PowerPlaneClearance, PowerPlaneConnectStyle, PowerPlaneReliefExpansion, Preview, ReliefAirGap, ReliefConductorWidth, ReliefEntries, Replicate, RequiredParamterSpace, RotateBy, Selected, SolderMaskExpansion, SwapLayerPairs, TearDrop, UnionIndex, UniqueId, UniqueID, Used, UserRouted, V7Layer, ViewableObjectID