Skip to main content
View as Markdown

IPCB_GridManager interface

No description yet.

public interface IPCB_GridManager

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Derived: IPCB_GridManagerPcbLib

Methods​

MethodReturnsDescription
AddCartesianGridIPCB_CartesianGrid
AddHorizontalGuideIPCB_PlacementGuideLine
AddMCADCartesianGridIPCB_CartesianGrid
AddMCADPolarGridIPCB_PolarGrid
AddMinus45DegreeGuideIPCB_PlacementGuideLine
AddPlus45DegreeGuideIPCB_PlacementGuideLine
AddPolarGridIPCB_PolarGrid
AddSnapPointIPCB_PlacementGuideSnapPoint
AddVerticalGuideIPCB_PlacementGuideLine
BeginUpdatevoid
CanDecrementGridPrioritybool
CanIncrementGridPrioritybool
CreatePlacementGridIteratorIPCB_PlacementGridIterator
CreateRealPlacementGuideIteratorIPCB_RealPlacementGuideIterator
DecrementGridPrioritybool
DeleteAllGridsvoid
DeleteAllGuidesvoid
DeleteAllMCADGridsvoid
DeleteGridbool
DeleteGuidebool
EndUpdatevoid
FindApplicableGridIPCB_PlacementGrid
FindApplicableGridByXYIPCB_PlacementGrid
IncrementGridPrioritybool
NextStateIDvoid
ResolveGridPrioritiesvoid
RunGridEditorbool

AddCartesianGrid​

No description yet.

IPCB_CartesianGrid AddCartesianGrid();

Returns: IPCB_CartesianGrid

Extension method of IPCB_GridManagerHelper (using PCB;).

AddHorizontalGuide​

No description yet.

IPCB_PlacementGuideLine AddHorizontalGuide(int argy, bool argStaticGuide, IPCB_Primitive argSource);
ParameterTypePassing
argyintvalue
argStaticGuideboolvalue
argSourceIPCB_Primitivevalue

Returns: IPCB_PlacementGuideLine

Extension method of IPCB_GridManagerHelper (using PCB;).

AddMCADCartesianGrid​

No description yet.

IPCB_CartesianGrid AddMCADCartesianGrid();

Returns: IPCB_CartesianGrid

Extension method of IPCB_GridManagerHelper (using PCB;).

AddMCADPolarGrid​

No description yet.

IPCB_PolarGrid AddMCADPolarGrid();

Returns: IPCB_PolarGrid

Extension method of IPCB_GridManagerHelper (using PCB;).

AddMinus45DegreeGuide​

No description yet.

IPCB_PlacementGuideLine AddMinus45DegreeGuide(int argx, int argy, bool argStaticGuide, IPCB_Primitive argSource);
ParameterTypePassing
argxintvalue
argyintvalue
argStaticGuideboolvalue
argSourceIPCB_Primitivevalue

Returns: IPCB_PlacementGuideLine

Extension method of IPCB_GridManagerHelper (using PCB;).

AddPlus45DegreeGuide​

No description yet.

IPCB_PlacementGuideLine AddPlus45DegreeGuide(int argx, int argy, bool argStaticGuide, IPCB_Primitive argSource);
ParameterTypePassing
argxintvalue
argyintvalue
argStaticGuideboolvalue
argSourceIPCB_Primitivevalue

Returns: IPCB_PlacementGuideLine

Extension method of IPCB_GridManagerHelper (using PCB;).

AddPolarGrid​

No description yet.

IPCB_PolarGrid AddPolarGrid();

Returns: IPCB_PolarGrid

Extension method of IPCB_GridManagerHelper (using PCB;).

AddSnapPoint​

No description yet.

IPCB_PlacementGuideSnapPoint AddSnapPoint(int argx, int argy, bool argStaticGuide, IPCB_Primitive argSource);
ParameterTypePassing
argxintvalue
argyintvalue
argStaticGuideboolvalue
argSourceIPCB_Primitivevalue

Returns: IPCB_PlacementGuideSnapPoint

Extension method of IPCB_GridManagerHelper (using PCB;).

AddVerticalGuide​

No description yet.

IPCB_PlacementGuideLine AddVerticalGuide(int argx, bool argStaticGuide, IPCB_Primitive argSource);
ParameterTypePassing
argxintvalue
argStaticGuideboolvalue
argSourceIPCB_Primitivevalue

Returns: IPCB_PlacementGuideLine

Extension method of IPCB_GridManagerHelper (using PCB;).

BeginUpdate​

No description yet.

void BeginUpdate();

Returns: nothing (void)

CanDecrementGridPriority​

No description yet.

bool CanDecrementGridPriority(IPCB_PlacementGrid argGrid);
bool CanDecrementGridPriority(object argGrid);
ParameterTypePassing
argGridIPCB_PlacementGridvalue

Returns: bool

The first overload is an extension method of IPCB_GridManagerHelper (using PCB;) with typed parameters; the second is declared by the interface.

CanIncrementGridPriority​

No description yet.

bool CanIncrementGridPriority(IPCB_PlacementGrid argGrid);
bool CanIncrementGridPriority(object argGrid);
ParameterTypePassing
argGridIPCB_PlacementGridvalue

Returns: bool

The first overload is an extension method of IPCB_GridManagerHelper (using PCB;) with typed parameters; the second is declared by the interface.

CreatePlacementGridIterator​

No description yet.

IPCB_PlacementGridIterator CreatePlacementGridIterator();

Returns: IPCB_PlacementGridIterator

Extension method of IPCB_GridManagerHelper (using PCB;).

CreateRealPlacementGuideIterator​

No description yet.

IPCB_RealPlacementGuideIterator CreateRealPlacementGuideIterator();

Returns: IPCB_RealPlacementGuideIterator

Extension method of IPCB_GridManagerHelper (using PCB;).

DecrementGridPriority​

No description yet.

bool DecrementGridPriority(IPCB_PlacementGrid argGrid);
bool DecrementGridPriority(object argGrid);
ParameterTypePassing
argGridIPCB_PlacementGridvalue

Returns: bool

The first overload is an extension method of IPCB_GridManagerHelper (using PCB;) with typed parameters; the second is declared by the interface.

DeleteAllGrids​

No description yet.

void DeleteAllGrids();

Returns: nothing (void)

DeleteAllGuides​

No description yet.

void DeleteAllGuides();

Returns: nothing (void)

DeleteAllMCADGrids​

No description yet.

void DeleteAllMCADGrids();

Returns: nothing (void)

DeleteGrid​

No description yet.

bool DeleteGrid(IPCB_PlacementGrid argGrid);
bool DeleteGrid(object argGrid);
ParameterTypePassing
argGridIPCB_PlacementGridvalue

Returns: bool

The first overload is an extension method of IPCB_GridManagerHelper (using PCB;) with typed parameters; the second is declared by the interface.

DeleteGuide​

No description yet.

bool DeleteGuide(IPCB_PlacementGuide argGuide);
bool DeleteGuide(object argGuide);
ParameterTypePassing
argGuideIPCB_PlacementGuidevalue

Returns: bool

The first overload is an extension method of IPCB_GridManagerHelper (using PCB;) with typed parameters; the second is declared by the interface.

EndUpdate​

No description yet.

void EndUpdate();

Returns: nothing (void)

FindApplicableGrid​

No description yet.

IPCB_PlacementGrid FindApplicableGrid(IPCB_Primitive argPrimitive);
ParameterTypePassing
argPrimitiveIPCB_Primitivevalue

Returns: IPCB_PlacementGrid

Extension method of IPCB_GridManagerHelper (using PCB;).

FindApplicableGridByXY​

No description yet.

IPCB_PlacementGrid FindApplicableGridByXY(int argX, int argY);
ParameterTypePassing
argXintvalue
argYintvalue

Returns: IPCB_PlacementGrid

Extension method of IPCB_GridManagerHelper (using PCB;).

IncrementGridPriority​

No description yet.

bool IncrementGridPriority(IPCB_PlacementGrid argGrid);
bool IncrementGridPriority(object argGrid);
ParameterTypePassing
argGridIPCB_PlacementGridvalue

Returns: bool

The first overload is an extension method of IPCB_GridManagerHelper (using PCB;) with typed parameters; the second is declared by the interface.

NextStateID​

No description yet.

void NextStateID();

Returns: nothing (void)

ResolveGridPriorities​

No description yet.

void ResolveGridPriorities();

Returns: nothing (void)

RunGridEditor​

No description yet.

bool RunGridEditor(IPCB_Board argBoard, IPCB_PlacementGrid argGrid);
bool RunGridEditor(object argBoard, object argGrid);
ParameterTypePassing
argBoardIPCB_Boardvalue
argGridIPCB_PlacementGridvalue

Returns: bool

The first overload is an extension method of IPCB_GridManagerHelper (using PCB;) with typed parameters; the second is declared by the interface.

Returned by​

IPCB_BoardEx.GridManager