IPCB_BaselineDimension interface
A baseline dimension on a PCB document, which measures the linear distances of a collection of references from a single base reference.
public interface IPCB_BaselineDimension : IPCB_Dimension
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Inherits: IPCB_Primitive → IPCB_Group → IPCB_Dimension
Remarks
The first reference is the base reference, and all subsequent references are measured relative to it: the dimension value of each of them is its distance from the base reference. The references may be objects (tracks, arcs, pads, vias, text, fills, polygons or components) or points in free space.
The dimension is drawn as one segment for each reference after the base reference. Segment I measures from the base reference to reference I + 1 (References) and has its own text, arrowheads, dimension line and extension lines, which Texts, Arrow1_Track1, Arrow1_Track2, Arrow2_Track1, Arrow2_Track2, Line_Track1, Line_Track2, Extension1_Track and Extension2_Track return for index I. Each segment measures the distance in the direction given by Angle, along a dimension line through its text location (TextLocations).
References_Add adds the text and tracks of a new segment but no text location; add one with TextLocations_Add. References_DeleteLast removes the last text location together with the last segment.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| Angle | double | get; set | The angle of the dimension lines to the horizontal, in degrees. |
| TextLocations | CoordPoint | get; set | The text location of a segment, a point on its dimension line, in internal units (10,000 per mil). |
| TextLocationsCount | int | get; set | The number of text locations of the dimension. |
Angle
The angle of the dimension lines to the horizontal, in degrees.
double GetState_Angle();
void SetState_Angle(double argValue);
Type: double · Access: read/write
At 0 the dimension measures horizontal distances. Rotating the dimension with RotateAroundXY changes the angle by the rotation angle.
TextLocations
The text location of a segment, a point on its dimension line, in internal units (10,000 per mil).
CoordPoint GetState_TextLocations(int argI);
void SetState_TextLocations(int argI, CoordPoint argValue);
Type: CoordPoint · Access: read/write · Index: argI (int): The zero-based index of the segment.
The accessors are extension methods of IPCB_BaselineDimensionHelper (using PCB;).
The dimension line of the segment passes through this point in the direction given by Angle. Assigning a location at an index outside 0 to PCBConstant.MaxReferenceCount - 1 does nothing. When RotateAroundXY rotates the reference points, it rotates the text locations as well.
TextLocationsCount
The number of text locations of the dimension.
int GetState_TextLocationsCount();
void SetState_TextLocationsCount(int argValue);
Type: int · Access: read/write
Assigning a value changes only the count; use TextLocations_Add, TextLocations_Delete, TextLocations_DeleteLast and TextLocations_Clear to add or remove text locations.
Methods
| Method | Returns | Description |
|---|---|---|
| Arrow1_Track1 | IPCB_Track | Returns one of the two tracks of the first arrowhead of a segment. |
| Arrow1_Track2 | IPCB_Track | Returns one of the two tracks of the first arrowhead of a segment. |
| Arrow2_Track1 | IPCB_Track | Returns one of the two tracks of the second arrowhead of a segment. |
| Arrow2_Track2 | IPCB_Track | Returns one of the two tracks of the second arrowhead of a segment. |
| Extension1_Track | IPCB_Track | Returns the extension line of a segment at the base reference. |
| Extension2_Track | IPCB_Track | Returns the extension line of a segment at the measured reference. |
| Line_Track1 | IPCB_Track | Returns one of the two tracks that draw the dimension line of a segment. |
| Line_Track2 | IPCB_Track | Returns one of the two tracks that draw the dimension line of a segment. |
| Text | IPCB_Text | Returns the text of the first segment, the same object as Texts returns for index 0. |
| TextLocations_Add | void | Adds a text location at the end of the dimension's text locations, increasing TextLocationsCount by one. |
| TextLocations_Clear | void | Removes all text locations, setting TextLocationsCount to 0. |
| TextLocations_Delete | void | Removes the text location at the given index, reducing TextLocationsCount by one. |
| TextLocations_DeleteLast | void | Removes the last text location, reducing TextLocationsCount by one. |
| Texts | IPCB_Text | Returns the text that shows the measured value of a segment. |
Arrow1_Track1
Returns one of the two tracks of the first arrowhead of a segment.
IPCB_Track Arrow1_Track1(int argI);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argI | int | value | The zero-based index of the segment. |
Returns: IPCB_Track
Extension method of IPCB_BaselineDimensionHelper (using PCB;).
Arrow1_Track2
Returns one of the two tracks of the first arrowhead of a segment.
IPCB_Track Arrow1_Track2(int argI);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argI | int | value | The zero-based index of the segment. |
Returns: IPCB_Track
Extension method of IPCB_BaselineDimensionHelper (using PCB;).
Arrow2_Track1
Returns one of the two tracks of the second arrowhead of a segment.
IPCB_Track Arrow2_Track1(int argI);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argI | int | value | The zero-based index of the segment. |
Returns: IPCB_Track
Extension method of IPCB_BaselineDimensionHelper (using PCB;).
Arrow2_Track2
Returns one of the two tracks of the second arrowhead of a segment.
IPCB_Track Arrow2_Track2(int argI);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argI | int | value | The zero-based index of the segment. |
Returns: IPCB_Track
Extension method of IPCB_BaselineDimensionHelper (using PCB;).
Extension1_Track
Returns the extension line of a segment at the base reference.
IPCB_Track Extension1_Track(int argI);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argI | int | value | The zero-based index of the segment. |
Returns: IPCB_Track
Extension method of IPCB_BaselineDimensionHelper (using PCB;).
Extension2_Track
Returns the extension line of a segment at the measured reference.
IPCB_Track Extension2_Track(int argI);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argI | int | value | The zero-based index of the segment; segment I measures reference I + 1. |
Returns: IPCB_Track
Extension method of IPCB_BaselineDimensionHelper (using PCB;).
Line_Track1
Returns one of the two tracks that draw the dimension line of a segment.
IPCB_Track Line_Track1(int argI);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argI | int | value | The zero-based index of the segment. |
Returns: IPCB_Track
Extension method of IPCB_BaselineDimensionHelper (using PCB;).
Line_Track2
Returns one of the two tracks that draw the dimension line of a segment.
IPCB_Track Line_Track2(int argI);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argI | int | value | The zero-based index of the segment. |
Returns: IPCB_Track
Extension method of IPCB_BaselineDimensionHelper (using PCB;).
Text
Returns the text of the first segment, the same object as Texts returns for index 0.
IPCB_Text Text();
Returns: IPCB_Text
Extension method of IPCB_BaselineDimensionHelper (using PCB;).
TextLocations_Add
Adds a text location at the end of the dimension's text locations, increasing TextLocationsCount by one.
void TextLocations_Add(CoordPoint argPoint);
void TextLocations_Add(ICoordPoint argPoint);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argPoint | CoordPoint | value | The text location to add, in internal units (10,000 per mil). |
Returns: nothing (void)
The first overload is an extension method of IPCB_BaselineDimensionHelper (using PCB;) with typed parameters; the second is declared by the interface.
Does nothing when the dimension already has PCBConstant.MaxReferenceCount (200) text locations.
TextLocations_Clear
Removes all text locations, setting TextLocationsCount to 0.
void TextLocations_Clear();
Returns: nothing (void)
TextLocations_Delete
Removes the text location at the given index, reducing TextLocationsCount by one.
void TextLocations_Delete(int argIndex);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argIndex | int | value | The zero-based index of the text location. |
Returns: nothing (void)
The text locations after it move down by one index.
TextLocations_DeleteLast
Removes the last text location, reducing TextLocationsCount by one.
void TextLocations_DeleteLast();
Returns: nothing (void)
Texts
Returns the text that shows the measured value of a segment.
IPCB_Text Texts(int argI);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argI | int | value | The zero-based index of the segment. |
Returns: IPCB_Text
Extension method of IPCB_BaselineDimensionHelper (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