Interface ICamApiApplicationMainForm

Instance of CAM application

Namespace: CAMAPI.ApplicationMainForm

Assembly: CAMAPI.ApplicationMainForm.dll

Syntax

[Guid("4890D827-4A4E-475E-B82B-D3A38A51849C")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface ICamApiApplicationMainForm

Properties

ActiveClientRect

Active client rectangle of the main application window - the area occupied by the 3D graphic view (excluding side panels, toolbars, title bar). Coordinates are in client pixels of the main application window. Use ClientToScreen to translate into screen coordinates, e.g. to position an overlay window over the 3D view.

Declaration

TCamApiRect ActiveClientRect { get; }

Property Value

Type	Description
TCamApiRect

FiltersManager

Manager for geometry selection filters

Declaration

ICamApiFiltersManager FiltersManager { get; }

Property Value

Type	Description
ICamApiFiltersManager

HotkeyManager

Manager for plugin global keyboard shortcuts

Declaration

ICamApiHotkeyManager HotkeyManager { get; }

Property Value

Type	Description
ICamApiHotkeyManager

MainViewPort

Main view port

Declaration

ICamApiViewPort MainViewPort { get; }

Property Value

Type	Description
ICamApiViewPort

MainWindowHandle

Handle of main application window, can be used to set this window as parent for any child window

Declaration

long MainWindowHandle { get; }

Property Value

Type	Description
long

VerifyCompareManager

Manager for the "Verify compare" mode (machining result vs part)

Declaration

ICamApiVerifyCompareManager VerifyCompareManager { get; }

Property Value

Type	Description
ICamApiVerifyCompareManager

VisibilityManager

Manager for visibility of 3D scene objects per work mode

Declaration

ICamApiVisibilityManager VisibilityManager { get; }

Property Value

Type	Description
ICamApiVisibilityManager

Methods

BeginFreeze(TFreezeInterfaceType)

Declaration

void BeginFreeze(TFreezeInterfaceType FreezeType)

Parameters

Type	Name	Description
TFreezeInterfaceType	FreezeType

ClientToScreen(TCamApiRect)

Declaration

TCamApiRect ClientToScreen(TCamApiRect R)

Parameters

Type	Name	Description
TCamApiRect	R

Returns

Type	Description
TCamApiRect

Close()

Sends signal to close the application like pressing the close button

Declaration

void Close()

CloudsCollabDownload()

Download project from clouds app

Declaration

void CloudsCollabDownload()

CloudsCollabOpenChat()

Open clouds collab chat

Declaration

void CloudsCollabOpenChat()

CloudsCollabShare()

Share in clouds app

Declaration

void CloudsCollabShare()

ConnectPLMConnection(long)

Declaration

void ConnectPLMConnection(long ConnectionId)

Parameters

Type	Name	Description
long	ConnectionId

CrashReport()

Start crash report request

Declaration

void CrashReport()

CreateNewProject(out TResultStatus)

Declaration

void CreateNewProject(out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TResultStatus	ResultStatus

CreateProcessIndicator(string)

Create a controller for the native progress indicator in the status area of the main window. Call Show on the returned object to occupy the indicator, then push progress via SetPercent/SetCaption.

Declaration

ICamApiProgressIndicator CreateProcessIndicator(string Caption)

Parameters

Type	Name	Description
string	Caption

Returns

Type	Description
ICamApiProgressIndicator

DisconnectPLMConnection(long)

Declaration

void DisconnectPLMConnection(long ConnectionId)

Parameters

Type	Name	Description
long	ConnectionId

EndFreeze()

Unfreeze main form of the application

Declaration

void EndFreeze()

ExportCurrentProject(out TResultStatus)

Declaration

void ExportCurrentProject(out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TResultStatus	ResultStatus

ExportDrillPoints(string)

Saves selected drill operation points

Declaration

void ExportDrillPoints(string FileName)

Parameters

Type	Name	Description
string	FileName

ExportProjectToPLM(long)

Declaration

void ExportProjectToPLM(long ConnectionId)

Parameters

Type	Name	Description
long	ConnectionId

ExportProjectWithHistory(string)

Saves current project with full snapshot history

Declaration

void ExportProjectWithHistory(string FileName)

Parameters

Type	Name	Description
string	FileName

ExportSimulationResults(string)

Export simulation results

Declaration

void ExportSimulationResults(string FileName)

Parameters

Type	Name	Description
string	FileName

GetTechnologyForm(out TResultStatus)

Declaration

ICamApiTechnologyForm GetTechnologyForm(out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TResultStatus	ResultStatus

Returns

Type	Description
ICamApiTechnologyForm

GetUiInfo()

Get main for UI state info

Declaration

ICamApiMainFormUiInfo GetUiInfo()

Returns

Type	Description
ICamApiMainFormUiInfo

GetVisible()

Get visibility of main form - it main change in open/close of main application window

Declaration

bool GetVisible()

Returns

Type	Description
bool

ImportMachineSetup(string)

Import machine setup

Declaration

void ImportMachineSetup(string FileName)

Parameters

Type	Name	Description
string	FileName

LoadProjectFromPLM(long)

Declaration

void LoadProjectFromPLM(long ConnectionId)

Parameters

Type	Name	Description
long	ConnectionId

OpenAiAssistant()

Open Ai assistant

Declaration

void OpenAiAssistant()

OpenDotnetInterpreterInVSCode(string)

Open dotnet interpreter in VS Code

Declaration

void OpenDotnetInterpreterInVSCode(string FileName)

Parameters

Type	Name	Description
string	FileName

OpenProject(string, out TResultStatus)

Declaration

void OpenProject(string FileName, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	FileName
TResultStatus	ResultStatus

OpenProjectSnap(string, string, out TResultStatus)

Declaration

void OpenProjectSnap(string FileName, string SnapName, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	FileName
string	SnapName
TResultStatus	ResultStatus

OpenScriptEditor()

Open the script editor (Script IDE) and return its handle so the caller can Load a .spr file. Dispatched on the main UI thread.

Declaration

ICamApiScriptEditor OpenScriptEditor()

Returns

Type	Description
ICamApiScriptEditor

ProcessMessages()

Process pending UI messages of the main application thread (Application.ProcessMessages). Use this between blocks of work that must let the UI repaint/respond.

Declaration

void ProcessMessages()

RegisterHandler(string, ICamApiEventHandler, IListString, out TResultStatus)

Declaration

void RegisterHandler(string HandlerIdent, ICamApiEventHandler Handler, IListString Events, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	HandlerIdent
ICamApiEventHandler	Handler
IListString	Events
TResultStatus	ResultStatus

RunAppSetup(out bool)

Declaration

void RunAppSetup(out bool SettingsChanged)

Parameters

Type	Name	Description
bool	SettingsChanged

RunUtilitiesSetup(TCamApiRect)

Declaration

void RunUtilitiesSetup(TCamApiRect AnchorRect)

Parameters

Type	Name	Description
TCamApiRect	AnchorRect

SaveAsMachineSetup(string)

Saves current project as a machine setup

Declaration

void SaveAsMachineSetup(string FileName)

Parameters

Type	Name	Description
string	FileName

SaveCurrentProject(out TResultStatus)

Declaration

void SaveCurrentProject(out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TResultStatus	ResultStatus

SaveCurrentProjectAs(out TResultStatus)

Declaration

void SaveCurrentProjectAs(out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TResultStatus	ResultStatus

SaveProject()

Save current project

Declaration

void SaveProject()

SaveProjectAs(string)

Save current project to file

Declaration

void SaveProjectAs(string FileName)

Parameters

Type	Name	Description
string	FileName

ScreenToClient(TCamApiRect)

Declaration

TCamApiRect ScreenToClient(TCamApiRect R)

Parameters

Type	Name	Description
TCamApiRect	R

Returns

Type	Description
TCamApiRect

SetCurrentInPrime(bool)

Declaration

void SetCurrentInPrime(bool Value)

Parameters

Type	Name	Description
bool	Value

ShowHelpContents()

Show help

Declaration

void ShowHelpContents()

ShowSnapshotManager(string)

Show tutorial

Declaration

void ShowSnapshotManager(string ProjectPath)

Parameters

Type	Name	Description
string	ProjectPath

ShowToolWindow(string, out TResultStatus)

Declaration

void ShowToolWindow(string ToolID, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	ToolID
TResultStatus	ResultStatus

ShowTutorialWnd()

Show tutorial

Declaration

void ShowTutorialWnd()

SupportRequest()

Start support request

Declaration

void SupportRequest()

UnregisterHandler(string, out TResultStatus)

Declaration

void UnregisterHandler(string HandlerIdent, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	HandlerIdent
TResultStatus	ResultStatus