Class SimulatorHelper
Inheritance
SimulatorHelper
Assembly: CAMAPI.DotnetHelper.dll
Syntax
public static class SimulatorHelper
Methods
BreakOnEndOfOperation(ComWrapper<ICamApiSimulator>)
Should simulator break simulation on the end of operation
Declaration
public static bool BreakOnEndOfOperation(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
BreakOnErrors(ComWrapper<ICamApiSimulator>)
Should simulator break simulation on errors
Declaration
public static bool BreakOnErrors(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
BreakOnStopCommand(ComWrapper<ICamApiSimulator>)
Should simulator break simulation on special STOP command
Declaration
public static bool BreakOnStopCommand(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
Channel(ComWrapper<ICamApiSimulator>, int)
Channel by zero-based index in range [0..ChannelCount-1].
Declaration
public static ComWrapper<ICamApiMcdChannel> Channel(this ComWrapper<ICamApiSimulator> simulatorCom, int index)
Parameters
Returns
ChannelCount(ComWrapper<ICamApiSimulator>)
Number of execution channels in the simulator (always at least 1).
Declaration
public static int ChannelCount(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
ChannelsVisible(ComWrapper<ICamApiSimulator>)
Whether the multi-channel view is enabled in the simulation tree
Declaration
public static bool ChannelsVisible(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
CheckGouges(ComWrapper<ICamApiSimulator>)
Should simulator check for gouges
Declaration
public static bool CheckGouges(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
CheckHiddenNodesCollisions(ComWrapper<ICamApiSimulator>)
Should simulator check for collisions with hidden machine nodes (deepest detection level).
Setting this to true also enables CheckMachineCollisions and CheckHolderCollisions.
Declaration
public static bool CheckHiddenNodesCollisions(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
CheckHolderCollisions(ComWrapper<ICamApiSimulator>)
Should simulator check for holder collisions.
Setting this to false also disables CheckMachineCollisions and CheckHiddenNodesCollisions.
Declaration
public static bool CheckHolderCollisions(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
CheckMachineCollisions(ComWrapper<ICamApiSimulator>)
Should simulator check for machine collisions.
Setting this to true also enables CheckHolderCollisions.
Setting this to false also disables CheckHiddenNodesCollisions.
Declaration
public static bool CheckMachineCollisions(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
ColoredWorkpiece(ComWrapper<ICamApiSimulator>)
Whether the workpiece is rendered with colored toolpath traces
Declaration
public static bool ColoredWorkpiece(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
CompensationCurveVisible(ComWrapper<ICamApiSimulator>)
Whether tool compensation curve is shown in the simulation viewport
Declaration
public static bool CompensationCurveVisible(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
DeleteChips(ComWrapper<ICamApiSimulator>)
Start the asynchronous "delete chips" process
Declaration
public static void DeleteChips(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
FastSimulateAllOperations(ComWrapper<ICamApiSimulator>)
Calculate simulation results for all operations in the project
Declaration
public static void FastSimulateAllOperations(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
FastSimulateCurrentOperation(ComWrapper<ICamApiSimulator>)
Calculate simulation results for the current operation
Declaration
public static void FastSimulateCurrentOperation(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
FastSimulateUpToCurrentOperation(ComWrapper<ICamApiSimulator>)
Calculate simulation results from the first operation to the current operation (inclusive)
Declaration
public static void FastSimulateUpToCurrentOperation(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
GCodeViewVisible(ComWrapper<ICamApiSimulator>)
Whether the G-code view (NC text + simulation by NC) is enabled
Declaration
public static bool GCodeViewVisible(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
GoToNextError(ComWrapper<ICamApiSimulator>)
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
public static void GoToNextError(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
GoToPrevError(ComWrapper<ICamApiSimulator>)
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
public static void GoToPrevError(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Whether the workpiece is rendered with metallic shading
Declaration
public static bool MetallicWorkpiece(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
MultiChannelMode(ComWrapper<ICamApiSimulator>)
Whether the multi-channel simulation mode is enabled.
Declaration
public static bool MultiChannelMode(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
RapidScalePower(ComWrapper<ICamApiSimulator>)
Rapid motion scale as a power of 2: 0 = x1, 1 = x2, ..., 7 = x128
Declaration
public static int RapidScalePower(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
ResetSimulationResults(ComWrapper<ICamApiSimulator>)
Stop current simulation and delete all simulation results
Declaration
public static void ResetSimulationResults(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
ResetWorkpiece(ComWrapper<ICamApiSimulator>)
Reset the workpiece (clear cuts/chips and restore the original geometry)
Declaration
public static void ResetWorkpiece(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
SaveMachiningResultToSTL(ComWrapper<ICamApiSimulator>, ComWrapper<ICamApiPartStage>?, string)
Save result of simulation to the STL file
Declaration
public static void SaveMachiningResultToSTL(this ComWrapper<ICamApiSimulator> simulatorCom, ComWrapper<ICamApiPartStage>? partStage, string fileName)
Parameters
SetBreakOnEndOfOperation(ComWrapper<ICamApiSimulator>, bool)
Should simulator break simulation on the end of operation
Declaration
public static void SetBreakOnEndOfOperation(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetBreakOnErrors(ComWrapper<ICamApiSimulator>, bool)
Should simulator break simulation on errors
Declaration
public static void SetBreakOnErrors(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetBreakOnStopCommand(ComWrapper<ICamApiSimulator>, bool)
Should simulator break simulation on special STOP command
Declaration
public static void SetBreakOnStopCommand(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetChannelsVisible(ComWrapper<ICamApiSimulator>, bool)
Whether the multi-channel view is enabled in the simulation tree
Declaration
public static void SetChannelsVisible(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetCheckGouges(ComWrapper<ICamApiSimulator>, bool)
Should simulator check for gouges
Declaration
public static void SetCheckGouges(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetCheckHiddenNodesCollisions(ComWrapper<ICamApiSimulator>, bool)
Should simulator check for collisions with hidden machine nodes (deepest detection level).
Setting this to true also enables CheckMachineCollisions and CheckHolderCollisions.
Declaration
public static void SetCheckHiddenNodesCollisions(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetCheckHolderCollisions(ComWrapper<ICamApiSimulator>, bool)
Should simulator check for holder collisions.
Setting this to false also disables CheckMachineCollisions and CheckHiddenNodesCollisions.
Declaration
public static void SetCheckHolderCollisions(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetCheckMachineCollisions(ComWrapper<ICamApiSimulator>, bool)
Should simulator check for machine collisions.
Setting this to true also enables CheckHolderCollisions.
Setting this to false also disables CheckHiddenNodesCollisions.
Declaration
public static void SetCheckMachineCollisions(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetColoredWorkpiece(ComWrapper<ICamApiSimulator>, bool)
Whether the workpiece is rendered with colored toolpath traces
Declaration
public static void SetColoredWorkpiece(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetCompensationCurveVisible(ComWrapper<ICamApiSimulator>, bool)
Whether tool compensation curve is shown in the simulation viewport
Declaration
public static void SetCompensationCurveVisible(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetGCodeViewVisible(ComWrapper<ICamApiSimulator>, bool)
Whether the G-code view (NC text + simulation by NC) is enabled
Declaration
public static void SetGCodeViewVisible(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
Whether the workpiece is rendered with metallic shading
Declaration
public static void SetMetallicWorkpiece(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetMultiChannelMode(ComWrapper<ICamApiSimulator>, bool)
Set whether the multi-channel simulation mode is enabled.
Declaration
public static void SetMultiChannelMode(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetRapidScalePower(ComWrapper<ICamApiSimulator>, int)
Rapid motion scale as a power of 2: 0 = x1, 1 = x2, ..., 7 = x128
Declaration
public static void SetRapidScalePower(this ComWrapper<ICamApiSimulator> simulatorCom, int value)
Parameters
SetSimulationCurrentTime(ComWrapper<ICamApiSimulator>, double)
Current simulation time in minutes from the beginning of the technological process
Declaration
public static void SetSimulationCurrentTime(this ComWrapper<ICamApiSimulator> simulatorCom, double value)
Parameters
SetSimulationMethod(ComWrapper<ICamApiSimulator>, TCamApiSimulationMethod)
Simulation method (solid / voxel 3D / voxel 5D)
Declaration
public static void SetSimulationMethod(this ComWrapper<ICamApiSimulator> simulatorCom, TCamApiSimulationMethod value)
Parameters
SetSmoothSimulationEnabled(ComWrapper<ICamApiSimulator>, bool)
Smooth simulation mode: when true, toolpath is painted continuously along the trajectory;
when false, simulation advances per block
Declaration
public static void SetSmoothSimulationEnabled(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetSourceModelVisible(ComWrapper<ICamApiSimulator>, bool)
Whether the source part model is shown in the simulation viewport
Declaration
public static void SetSourceModelVisible(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
Whether the toolpath polyline is shown in the simulation viewport
Declaration
public static void SetToolPathVisible(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
Whether the cutting tool is shown in the simulation viewport
Declaration
public static void SetToolVisible(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetVideoMode(ComWrapper<ICamApiSimulator>, TCamApiVideoMode)
Visualization mode of the workpiece (Model / Rest / Cut-in)
Declaration
public static void SetVideoMode(this ComWrapper<ICamApiSimulator> simulatorCom, TCamApiVideoMode value)
Parameters
SetVisualization3DEnabled(ComWrapper<ICamApiSimulator>, bool)
Whether 3D visualization mode is enabled (false = 2D-only mode)
Declaration
public static void SetVisualization3DEnabled(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SetWorkpieceColor(ComWrapper<ICamApiSimulator>, int)
Workpiece display color as packed RGB integer 0xRRGGBB
Declaration
public static void SetWorkpieceColor(this ComWrapper<ICamApiSimulator> simulatorCom, int value)
Parameters
SetWorkpieceVisible(ComWrapper<ICamApiSimulator>, bool)
Whether the workpiece is shown in the simulation viewport
Declaration
public static void SetWorkpieceVisible(this ComWrapper<ICamApiSimulator> simulatorCom, bool value)
Parameters
SimulationCurrentTime(ComWrapper<ICamApiSimulator>)
Current simulation time in minutes from the beginning of the technological process
Declaration
public static double SimulationCurrentTime(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
SimulationMethod(ComWrapper<ICamApiSimulator>)
Simulation method (solid / voxel 3D / voxel 5D)
Declaration
public static TCamApiSimulationMethod SimulationMethod(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
SmoothSimulationEnabled(ComWrapper<ICamApiSimulator>)
Smooth simulation mode: when true, toolpath is painted continuously along the trajectory;
when false, simulation advances per block
Declaration
public static bool SmoothSimulationEnabled(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
SmoothSimulationStart(ComWrapper<ICamApiSimulator>)
Smoothly start simulation from the current operation up to the end
Declaration
public static void SmoothSimulationStart(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
SmoothSimulationStepBackward(ComWrapper<ICamApiSimulator>)
Execute previous command in smooth simulation mode
Declaration
public static void SmoothSimulationStepBackward(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
SmoothSimulationStepForward(ComWrapper<ICamApiSimulator>)
Execute next command in smooth simulation mode
Declaration
public static void SmoothSimulationStepForward(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
SmoothSimulationStop(ComWrapper<ICamApiSimulator>)
Stop current process of smooth simulation
Declaration
public static void SmoothSimulationStop(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
SourceModelVisible(ComWrapper<ICamApiSimulator>)
Whether the source part model is shown in the simulation viewport
Declaration
public static bool SourceModelVisible(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
SwapPhysicMulti(ComWrapper<ICamApiSimulator>)
Swap between PhysicGOTO and MultiGOTO toolpath representation modes
Declaration
public static void SwapPhysicMulti(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Whether the toolpath polyline is shown in the simulation viewport
Declaration
public static bool ToolPathVisible(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
Whether the cutting tool is shown in the simulation viewport
Declaration
public static bool ToolVisible(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
VideoMode(ComWrapper<ICamApiSimulator>)
Visualization mode of the workpiece (Model / Rest / Cut-in)
Declaration
public static TCamApiVideoMode VideoMode(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
Visualization3DEnabled(ComWrapper<ICamApiSimulator>)
Whether 3D visualization mode is enabled (false = 2D-only mode)
Declaration
public static bool Visualization3DEnabled(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
WorkpieceColor(ComWrapper<ICamApiSimulator>)
Workpiece display color as packed RGB integer 0xRRGGBB
Declaration
public static int WorkpieceColor(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns
WorkpieceVisible(ComWrapper<ICamApiSimulator>)
Whether the workpiece is shown in the simulation viewport
Declaration
public static bool WorkpieceVisible(this ComWrapper<ICamApiSimulator> simulatorCom)
Parameters
Returns