IPCB_DocumentPainterView interface

No description yet.

public interface IPCB_DocumentPainterView

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
ViewConfigFromString	string	set

ViewConfigFromString

No description yet.

bool SetState_ViewConfigFromString(string argConfigType, string argConfig);

Type: string · Access: write-only · Index: argConfigType (string)

Methods

Method	Returns	Description
AddOrUpdatePrim	void
ClearSelection	void
ClientRect	Rect
FocusedPrimitive	IPCB_Primitive
FocusPrimitive	void
GetState_ViewConfigAsString	bool
KeyDown	void
RunLayerConfigurationDialog	bool
SelectPrimitive	void
SetBoard	void
SetBounds	void
SetCameraAngle	void
SetDegreeOfFreedom	void
SetDocumentPainterListener	void
SetInteractive	void
SetVariant	void
ShowFloorShadow	void
Zoom	void

AddOrUpdatePrim

No description yet.

void AddOrUpdatePrim(IPCB_Primitive argPrim);
void AddOrUpdatePrim(object argPrim);

Parameter	Type	Passing
argPrim	IPCB_Primitive	value

Returns: nothing (void)

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

ClearSelection

No description yet.

void ClearSelection();

Returns: nothing (void)

ClientRect

No description yet.

Rect ClientRect();

Returns: Rect

Extension method of IPCB_DocumentPainterViewHelper (using PCB;).

FocusedPrimitive

No description yet.

IPCB_Primitive FocusedPrimitive();

Returns: IPCB_Primitive

Extension method of IPCB_DocumentPainterViewHelper (using PCB;).

FocusPrimitive

No description yet.

void FocusPrimitive(IPCB_Primitive argPrim);
void FocusPrimitive(object argPrim);

Parameter	Type	Passing
argPrim	IPCB_Primitive	value

Returns: nothing (void)

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

GetState_ViewConfigAsString

No description yet.

bool GetState_ViewConfigAsString(out string argConfigType, out string argConfig);

Parameter	Type	Passing
argConfigType	string	out
argConfig	string	out

Returns: bool

KeyDown

No description yet.

void KeyDown(ref ushort argKey, TShiftStateSet argShift);
void KeyDown(ref ushort argKey, ITransportSet argShift);

Parameter	Type	Passing
argKey	ushort	ref
argShift	TShiftStateSet	value

Returns: nothing (void)

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

RunLayerConfigurationDialog

No description yet.

bool RunLayerConfigurationDialog();

Returns: bool

SelectPrimitive

No description yet.

void SelectPrimitive(IPCB_Primitive argPrim);
void SelectPrimitive(object argPrim);

Parameter	Type	Passing
argPrim	IPCB_Primitive	value

Returns: nothing (void)

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

SetBoard

No description yet.

void SetBoard(IPCB_Board argBoard);
void SetBoard(object argBoard);

Parameter	Type	Passing
argBoard	IPCB_Board	value

Returns: nothing (void)

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

SetBounds

No description yet.

void SetBounds(int argLeft, int argTop, int argWidth, int argHeight);

Parameter	Type	Passing
argLeft	int	value
argTop	int	value
argWidth	int	value
argHeight	int	value

Returns: nothing (void)

SetCameraAngle

No description yet.

void SetCameraAngle(double argLookAtX, double argLookAtY, double argLookAtZ, double argRotationX, double argRotationY, double argRotationZ, double argRotationW, double argZoomMultiplier);

Parameter	Type	Passing
argLookAtX	double	value
argLookAtY	double	value
argLookAtZ	double	value
argRotationX	double	value
argRotationY	double	value
argRotationZ	double	value
argRotationW	double	value
argZoomMultiplier	double	value

Returns: nothing (void)

SetDegreeOfFreedom

No description yet.

void SetDegreeOfFreedom(TDegreeOfFreedom argDegreeOfFreedom);
void SetDegreeOfFreedom(int argDegreeOfFreedom);

Parameter	Type	Passing
argDegreeOfFreedom	TDegreeOfFreedom	value

Returns: nothing (void)

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

SetDocumentPainterListener

No description yet.

void SetDocumentPainterListener(IPCB_DocumentPainterListener argCameraMoveListener);
void SetDocumentPainterListener(object argCameraMoveListener);

Parameter	Type	Passing
argCameraMoveListener	IPCB_DocumentPainterListener	value

Returns: nothing (void)

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

SetInteractive

No description yet.

void SetInteractive(bool argValue);

Parameter	Type	Passing
argValue	bool	value

Returns: nothing (void)

SetVariant

No description yet.

void SetVariant(IProjectVariant argVariant);
void SetVariant(object argVariant);

Parameter	Type	Passing
argVariant	IProjectVariant	value

Returns: nothing (void)

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

ShowFloorShadow

No description yet.

void ShowFloorShadow(bool argEnabled);

Parameter	Type	Passing
argEnabled	bool	value

Returns: nothing (void)

Zoom

No description yet.

void Zoom(int argDelta);

Parameter	Type	Passing
argDelta	int	value

Returns: nothing (void)

Returned by

IPCB_ServerInterface.CreateDocumentPainter