Skip to main content
View as Markdown

IPCB_ComponentClearanceConstraint interface

A component clearance rule (TRuleKind.eRule_ComponentClearance) that defines the minimum distance between components, horizontally (Gap) and vertically (VerticalGap).

public interface IPCB_ComponentClearanceConstraint : IPCB_Rule

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Inherits: IPCB_Primitive → IPCB_Rule

Remarks​

The rule checks pairs of components and component bodies (IPCB_ComponentBody). A new rule has a horizontal and a vertical clearance of 10 mil.

Properties​

PropertyTypeAccessDescription
CollisionCheckModeTComponentCollisionCheckModeget; setA check mode that the rule no longer uses.
Gapintget; setThe minimum horizontal clearance between components, in the plane of the board, in internal units (10,000 per mil).
ShowDistancesboolget; setWhether the check searches for the closest points of two components that are closer than the clearance, instead of stopping at the first points found within the clearance.
VerticalGapintget; setThe minimum vertical clearance between components, perpendicular to the board, in internal units (10,000 per mil).

CollisionCheckMode​

A check mode that the rule no longer uses.

TComponentCollisionCheckMode GetState_CollisionCheckMode();
void SetState_CollisionCheckMode(TComponentCollisionCheckMode argValue);

Type: TComponentCollisionCheckMode · Access: read/write

The accessors are extension methods of IPCB_ComponentClearanceConstraintHelper (using PCB;).

Reading always returns TComponentCollisionCheckMode.eComponentBodyCheck; assigning a value has no effect.

Gap​

The minimum horizontal clearance between components, in the plane of the board, in internal units (10,000 per mil).

int GetState_Gap();
void SetState_Gap(int argValue);

Type: int · Access: read/write

A new rule has 10 mil.

ShowDistances​

Whether the check searches for the closest points of two components that are closer than the clearance, instead of stopping at the first points found within the clearance.

bool GetState_ShowDistances();
void SetState_ShowDistances(bool argValue);

Type: bool · Access: read/write

The default is false.

VerticalGap​

The minimum vertical clearance between components, perpendicular to the board, in internal units (10,000 per mil).

int GetState_VerticalGap();
void SetState_VerticalGap(int argValue);

Type: int · Access: read/write

A new rule has 10 mil.

Inherited members​