IPCB_OriginalDimension interface
An original dimension on a PCB document, the linear dimension style of early versions, which measures the distance between two points.
public interface IPCB_OriginalDimension : IPCB_Dimension
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Inherits: IPCB_Primitive → IPCB_Group → IPCB_Dimension
Remarks
The dimension measures the distance from (XLocation, YLocation) to (X1Location, Y1Location) and shows it in the board's display unit, formatted according to Style. The newer dimension styles, such as IPCB_LinearDimension, supersede it.
The dimension is drawn with one text and eight tracks: Text shows the value, Track1 and Track2 are the two halves of the dimension line, Track3 to Track6 the two arrowheads and Track7 and Track8 the end marks at the two points. All tracks are drawn on the dimension's layer with the width LineWidth.
The two points are swapped if needed, so that (XLocation, YLocation) is the left point, or the lower one when both points have the same X coordinate. When the distance is too short for the text, the dimension line is drawn outside the measured span, the arrowheads point inward and the text is placed beside the line.
Methods
| Method | Returns | Description |
|---|---|---|
| Text | IPCB_Text | Returns the text that shows the dimension's measured value. |
| Track1 | IPCB_Primitive | Returns the half of the dimension line that starts at the first point (XLocation, YLocation). |
| Track2 | IPCB_Primitive | Returns the half of the dimension line that starts at the second point (X1Location, Y1Location). |
| Track3 | IPCB_Primitive | Returns one of the two tracks of the arrowhead at the first point (XLocation, YLocation). |
| Track4 | IPCB_Primitive | Returns one of the two tracks of the arrowhead at the first point (XLocation, YLocation). |
| Track5 | IPCB_Primitive | Returns one of the two tracks of the arrowhead at the second point (X1Location, Y1Location). |
| Track6 | IPCB_Primitive | Returns one of the two tracks of the arrowhead at the second point (X1Location, Y1Location). |
| Track7 | IPCB_Primitive | Returns the end mark at the first point (XLocation, YLocation). |
| Track8 | IPCB_Primitive | Returns the end mark at the second point (X1Location, Y1Location). |
Text
Returns the text that shows the dimension's measured value.
IPCB_Text Text();
Returns: IPCB_Text
Extension method of IPCB_OriginalDimensionHelper (using PCB;).
The text gets the dimension's layer, TextHeight, TextWidth, TextFont, UseTTFonts, FontName, Bold and Italic. It is placed between the two halves of the dimension line, or beside the line when the distance is too short, and rotated to the line's angle.
Track1
Returns the half of the dimension line that starts at the first point (XLocation, YLocation).
IPCB_Primitive Track1();
Returns: IPCB_Primitive
Extension method of IPCB_OriginalDimensionHelper (using PCB;).
Track2
Returns the half of the dimension line that starts at the second point (X1Location, Y1Location).
IPCB_Primitive Track2();
Returns: IPCB_Primitive
Extension method of IPCB_OriginalDimensionHelper (using PCB;).
Track3
Returns one of the two tracks of the arrowhead at the first point (XLocation, YLocation).
IPCB_Primitive Track3();
Returns: IPCB_Primitive
Extension method of IPCB_OriginalDimensionHelper (using PCB;).
Track4
Returns one of the two tracks of the arrowhead at the first point (XLocation, YLocation).
IPCB_Primitive Track4();
Returns: IPCB_Primitive
Extension method of IPCB_OriginalDimensionHelper (using PCB;).
Track5
Returns one of the two tracks of the arrowhead at the second point (X1Location, Y1Location).
IPCB_Primitive Track5();
Returns: IPCB_Primitive
Extension method of IPCB_OriginalDimensionHelper (using PCB;).
Track6
Returns one of the two tracks of the arrowhead at the second point (X1Location, Y1Location).
IPCB_Primitive Track6();
Returns: IPCB_Primitive
Extension method of IPCB_OriginalDimensionHelper (using PCB;).
Track7
Returns the end mark at the first point (XLocation, YLocation).
IPCB_Primitive Track7();
Returns: IPCB_Primitive
Extension method of IPCB_OriginalDimensionHelper (using PCB;).
The end mark crosses the dimension line at right angles and extends Size on each side of it.
Track8
Returns the end mark at the second point (X1Location, Y1Location).
IPCB_Primitive Track8();
Returns: IPCB_Primitive
Extension method of IPCB_OriginalDimensionHelper (using PCB;).
The end mark crosses the dimension line at right angles and extends Size on each side of it.
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