Interface ICamApiSimulator

Manages simulation of the project

Namespace: CAMAPI.Simulator

Assembly: CAMAPI.Simulator.dll

Syntax

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("AF46B3B9-0DC7-4780-96D2-1B146E058330")]
public interface ICamApiSimulator

Properties

BreakOnEndOfOperation

Should simulator break simulation on the end of operation

Declaration

bool BreakOnEndOfOperation { get; set; }

Property Value

Type	Description
bool

BreakOnErrors

Should simulator break simulation on errors

Declaration

bool BreakOnErrors { get; set; }

Property Value

Type	Description
bool

BreakOnStopCommand

Should simulator break simulation on special STOP command

Declaration

bool BreakOnStopCommand { get; set; }

Property Value

Type	Description
bool

Channel[int]

Declaration

ICamApiMcdChannel Channel[int Index] { get; }

Parameters

Type	Name	Description
int	Index

Property Value

Type	Description
ICamApiMcdChannel

ChannelCount

Number of execution channels in the simulator. Always at least 1; values greater than 1 only appear on genuinely multi-channel machines (e.g. multi-turret lathe-mills).

Declaration

int ChannelCount { get; }

Property Value

Type	Description
int

ChannelsVisible

Whether the multi-channel view is enabled in the simulation tree

Declaration

bool ChannelsVisible { get; set; }

Property Value

Type	Description
bool

CheckGouges

Should simulator check for gouges

Declaration

bool CheckGouges { get; set; }

Property Value

Type	Description
bool

CheckHiddenNodesCollisions

Should simulator check for collisions with hidden machine nodes (deepest detection level). Setting this to true also enables CheckMachineCollisions and CheckHolderCollisions.

Declaration

bool CheckHiddenNodesCollisions { get; set; }

Property Value

Type	Description
bool

CheckHolderCollisions

Should simulator check for holder collisions. Setting this to false also disables CheckMachineCollisions and CheckHiddenNodesCollisions.

Declaration

bool CheckHolderCollisions { get; set; }

Property Value

Type	Description
bool

CheckMachineCollisions

Should simulator check for machine collisions. Setting this to true also enables CheckHolderCollisions. Setting this to false also disables CheckHiddenNodesCollisions.

Declaration

bool CheckMachineCollisions { get; set; }

Property Value

Type	Description
bool

ColoredWorkpiece

Whether the workpiece is rendered with colored toolpath traces (per-operation colors). When false, the workpiece is rendered monochrome.

Declaration

bool ColoredWorkpiece { get; set; }

Property Value

Type	Description
bool

CompensationCurveVisible

Whether tool compensation curve is shown in the simulation viewport

Declaration

bool CompensationCurveVisible { get; set; }

Property Value

Type	Description
bool

GCodeViewVisible

Whether the G-code view (NC text + simulation by NC) is enabled

Declaration

bool GCodeViewVisible { get; set; }

Property Value

Type	Description
bool

MetallicWorkpiece

Whether the workpiece is rendered with a metallic shading material

Declaration

bool MetallicWorkpiece { get; set; }

Property Value

Type	Description
bool

MultiChannelMode

Whether the multi-channel simulation mode is enabled. When true, channels execute in parallel with synchronisation at sync-points; when false, channels run as one sequential stream. Has no observable effect on single-channel projects (ChannelCount = 1).

Declaration

bool MultiChannelMode { get; set; }

Property Value

Type	Description
bool

RapidScalePower

Rapid motion scale as a power of 2: 0 = x1, 1 = x2, 2 = x4, ..., 7 = x128. Setting this property updates the underlying step length scale to (1 shl Value).

Declaration

int RapidScalePower { get; set; }

Property Value

Type	Description
int

SimulationCurrentTime

Current simulation time in minutes from the beginning of the technological process. Setting the value moves the simulation cursor to the corresponding point on the toolpath.

Declaration

double SimulationCurrentTime { get; set; }

Property Value

Type	Description
double

SimulationMethod

Simulation method (solid / voxel 3D / voxel 5D)

Declaration

TCamApiSimulationMethod SimulationMethod { get; set; }

Property Value

Type	Description
TCamApiSimulationMethod

SimulationSpeedPercent

Speed of smooth simulation in percents (0-100)

Declaration

int SimulationSpeedPercent { get; set; }

Property Value

Type	Description
int

SmoothSimulationEnabled

Smooth simulation mode: when true, toolpath is painted continuously along the trajectory; when false, simulation advances per block

Declaration

bool SmoothSimulationEnabled { get; set; }

Property Value

Type	Description
bool

SourceModelVisible

Whether the source (initial) part model is shown in the simulation viewport

Declaration

bool SourceModelVisible { get; set; }

Property Value

Type	Description
bool

ToolPathVisible

Whether the toolpath polyline is shown in the simulation viewport

Declaration

bool ToolPathVisible { get; set; }

Property Value

Type	Description
bool

ToolVisible

Whether the cutting tool is shown in the simulation viewport

Declaration

bool ToolVisible { get; set; }

Property Value

Type	Description
bool

VideoMode

Visualization mode of the workpiece (Model / Rest / Cut-in)

Declaration

TCamApiVideoMode VideoMode { get; set; }

Property Value

Type	Description
TCamApiVideoMode

Visualization3DEnabled

Whether 3D visualization mode is enabled (false = 2D-only mode)

Declaration

bool Visualization3DEnabled { get; set; }

Property Value

Type	Description
bool

WorkpieceColor

Workpiece display color as packed RGB integer 0xRRGGBB

Declaration

int WorkpieceColor { get; set; }

Property Value

Type	Description
int

WorkpieceVisible

Whether the workpiece is shown in the simulation viewport

Declaration

bool WorkpieceVisible { get; set; }

Property Value

Type	Description
bool

Methods

DeleteChips()

Start the asynchronous "delete chips" process. Removes detached fragments of the workpiece left after machining.

Declaration

void DeleteChips()

FastSimulateAllOperations()

Calculate simulation results for all operations in the project

Declaration

void FastSimulateAllOperations()

FastSimulateCurrentOperation()

Calculate simulation results for the current operation

Declaration

void FastSimulateCurrentOperation()

FastSimulateUpToCurrentOperation()

Calculate simulation results from the first operation to the current operation (inclusive)

Declaration

void FastSimulateUpToCurrentOperation()

GoToNextError()

Activate the next simulation error: the next CLDATA command with an error, or the next operation that has errors. If no further error exists, the active node is unchanged.

Declaration

void GoToNextError()

GoToPrevError()

Activate the previous simulation error: the previous CLDATA command with an error, or the previous operation that has errors. If no prior error exists, the active node is unchanged.

Declaration

void GoToPrevError()

ResetSimulationResults()

Stop current simulation and delete all simulation results

Declaration

void ResetSimulationResults()

ResetWorkpiece()

Reset the workpiece to its initial state: clear cuts/chips and restore original geometry. Differs from ResetSimulationResults: this affects the workpiece model, not the simulation status of operations.

Declaration

void ResetWorkpiece()

SaveMachiningResultToSTL(ICamApiPartStage, string, out TResultStatus)

Declaration

void SaveMachiningResultToSTL(ICamApiPartStage PartStage, string FileName, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
ICamApiPartStage	PartStage
string	FileName
TResultStatus	ResultStatus

SmoothSimulationStart()

Smoothly start simulation from the current operation up to the end

Declaration

void SmoothSimulationStart()

SmoothSimulationStepBackward()

Execute previous command in smooth simulation mode

Declaration

void SmoothSimulationStepBackward()

SmoothSimulationStepForward()

Execute next command in smooth simulation mode

Declaration

void SmoothSimulationStepForward()

SmoothSimulationStop()

Stop current process of smooth simulation

Declaration

void SmoothSimulationStop()

SwapPhysicMulti()

Swap between PhysicGOTO and MultiGOTO toolpath representation modes

Declaration

void SwapPhysicMulti()