cam.operators.path_ops

cam.operators.path_ops#

Blender Operator definitions are in this file. They mostly call the functions from ‘utils.py’

Classes#

`PathsBackground`	Calculate CAM Paths in Background. File Has to Be Saved Before.
`KillPathsBackground`	Remove CAM Path Processes in Background.
`CalculatePath`	Calculate CAM Paths
`PathsAll`	Calculate All CAM Paths
`PathsChain`	Calculate a Chain and Export the G-code Alltogether.
`PathExportChain`	Calculate a Chain and Export the G-code Together.
`PathExport`	Export G-code. Can Be Used only when the Path Object Is Present

Functions#

_calc_path(operator, context)

Calculate the path for a given operator and context.

Module Contents#

class PathsBackground[source]#

Bases: bpy.types.Operator

Calculate CAM Paths in Background. File Has to Be Saved Before.

bl_idname = 'object.calculate_cam_paths_background'[source]#

bl_label = 'Calculate CAM Paths in Background'[source]#

bl_options[source]#

execute(context)[source]#

Execute the CAM operation in the background.

This method initiates a background process to perform CAM operations based on the current scene and active CAM operation. It sets up the necessary paths for the script and starts a subprocess to handle the CAM computations. Additionally, it manages threading to ensure that the main thread remains responsive while the background operation is executed.

Parameters:: context – The context in which the operation is executed.
Returns:: A dictionary indicating the completion status of the operation.
Return type:: dict

class KillPathsBackground[source]#

Bases: bpy.types.Operator

Remove CAM Path Processes in Background.

bl_idname = 'object.kill_calculate_cam_paths_background'[source]#

bl_label = 'Kill Background Computation of an Operation'[source]#

bl_options[source]#

execute(context)[source]#

Execute the CAM operation in the given context.

This method retrieves the active CAM operation from the scene and checks if there are any ongoing processes related to CAM path calculations. If such processes exist and match the current operation, they are terminated. The method then marks the operation as not computing and returns a status indicating that the execution has finished.

Parameters:: context – The context in which the operation is executed.
Returns:: A dictionary with a status key indicating the result of the execution.
Return type:: dict

async _calc_path(operator, context)[source]#

Calculate the path for a given operator and context.

This function processes the current scene’s CAM operations based on the specified operator and context. It handles different geometry sources, checks for valid operation parameters, and manages the visibility of objects and collections. The function also retrieves the path using an asynchronous operation and handles any exceptions that may arise during this process. If the operation is invalid or if certain conditions are not met, appropriate error messages are reported to the operator.

Parameters:

operator (bpy.types.Operator) – The operator that initiated the path calculation.
context (bpy.types.Context) – The context in which the operation is executed.

Returns:

A tuple indicating the status of the operation.: Returns {‘FINISHED’, True} if successful, {‘FINISHED’, False} if there was an error, or {‘CANCELLED’, False} if the operation was cancelled.

Return type:

tuple

class CalculatePath[source]#

Bases: bpy.types.Operator, cam.operators.async_op.AsyncOperatorMixin

Calculate CAM Paths

bl_idname = 'object.calculate_cam_path'[source]#

bl_label = 'Calculate CAM Paths'[source]#

bl_options[source]#

classmethod poll(context)[source]#

Check if the current CAM operation is valid.

This method checks the active CAM operation in the given context and determines if it is valid. It retrieves the active operation from the scene’s CAM operations and validates it using the isValid function. If the operation is valid, it returns True; otherwise, it returns False.

Parameters:: context (Context) – The context containing the scene and CAM operations.
Returns:: True if the active CAM operation is valid, False otherwise.
Return type:: bool

async execute_async(context)[source]#

Execute an asynchronous calculation of a path.

This method performs an asynchronous operation to calculate a path based on the provided context. It awaits the result of the calculation and prints the success status along with the return value. The return value can be used for further processing or analysis.

Parameters:: context (Any) – The context in which the path calculation is to be executed.
Returns:: The result of the path calculation.
Return type:: Any

class PathsAll[source]#

Bases: bpy.types.Operator

Calculate All CAM Paths

bl_idname = 'object.calculate_cam_paths_all'[source]#

bl_label = 'Calculate All CAM Paths'[source]#

bl_options[source]#

execute(context)[source]#

Execute CAM operations in the current Blender context.

This function iterates through the CAM operations defined in the current scene and executes the background calculation for each operation. It sets the active CAM operation index and prints the name of each operation being processed. This is typically used in a Blender add-on or script to automate CAM path calculations.

Parameters:

context (bpy.context) – The current Blender context.

Returns:

A dictionary indicating the completion status of the operation,: typically {‘FINISHED’}.

Return type:

dict

draw(context)[source]#

Draws the user interface elements for the operation selection.

This method utilizes the Blender layout system to create a property search interface for selecting operations related to CAM functionalities. It links the current instance’s operation property to the available CAM operations defined in the Blender scene.

Parameters:: context (bpy.context) – The context in which the drawing occurs,

class PathsChain[source]#

Bases: bpy.types.Operator, cam.operators.async_op.AsyncOperatorMixin

Calculate a Chain and Export the G-code Alltogether.

bl_idname = 'object.calculate_cam_paths_chain'[source]#

bl_label = 'Calculate CAM Paths in Current Chain and Export Chain G-code'[source]#

bl_options[source]#

classmethod poll(context)[source]#

Check the validity of the active CAM chain in the given context.

This method retrieves the active CAM chain from the scene and checks its validity using the isChainValid function. It returns a boolean value indicating whether the CAM chain is valid or not.

Parameters:: context (Context) – The context containing the scene and CAM chain information.
Returns:: True if the active CAM chain is valid, False otherwise.
Return type:: bool

async execute_async(context)[source]#

Execute asynchronous operations for CAM path calculations.

This method sets the object mode for the Blender scene and processes a series of CAM operations defined in the active CAM chain. It reports the progress of each operation and handles any exceptions that may occur during the path calculation. After successful calculations, it exports the resulting mesh data to a specified G-code file.

Parameters:: context (bpy.context) – The Blender context containing scene and
Returns:: A dictionary indicating the result of the operation, typically {‘FINISHED’}.
Return type:: dict

class PathExportChain[source]#

Bases: bpy.types.Operator

Calculate a Chain and Export the G-code Together.

bl_idname = 'object.cam_export_paths_chain'[source]#

bl_label = 'Export CAM Paths in Current Chain as G-code'[source]#

bl_options[source]#

classmethod poll(context)[source]#

Check the validity of the active CAM chain in the given context.

This method retrieves the currently active CAM chain from the scene context and checks its validity using the isChainValid function. It returns a boolean indicating whether the active CAM chain is valid or not.

Parameters:: context (object) – The context containing the scene and CAM chain information.
Returns:: True if the active CAM chain is valid, False otherwise.
Return type:: bool

execute(context)[source]#

Execute the CAM path export process.

This function retrieves the active CAM chain from the current scene and gathers the mesh data associated with the operations of that chain. It then exports the G-code path using the specified filename and the collected mesh data. The function is designed to be called within the context of a Blender operator.

Parameters:

context (bpy.context) – The context in which the operator is executed.

Returns:

A dictionary indicating the completion status of the operation,: typically {‘FINISHED’}.

Return type:

dict

class PathExport[source]#

Bases: bpy.types.Operator

Export G-code. Can Be Used only when the Path Object Is Present

bl_idname = 'object.cam_export'[source]#

bl_label = 'Export Operation G-code'[source]#

bl_options[source]#

execute(context)[source]#

Execute the CAM operation and export the G-code path.

This method retrieves the active CAM operation from the current scene and exports the corresponding G-code path to a specified filename. It prints the filename and relevant operation details to the console for debugging purposes. The G-code path is generated based on the CAM path data associated with the active operation.

Parameters:

context – The context in which the operation is executed.

Returns:

A dictionary indicating the completion status of the operation,: typically {‘FINISHED’}.

Return type:

dict