Read the current content of a JCAD (JupyterCAD) document.

Use this tool to understand the current state of a JCAD file before modifying it.

:param jcad_path: The path to the JCAD file. :return: The current content of the JCAD file.

Remove an object from the document.

:param name: The name of the object to remove. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Rename an object in the document.

:param old_name: The current name of the object. :param new_name: The new name for the object. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Add an annotation to the document.

:param parent: The object which holds the annotation. :param message: The first messages in the annotation. :param position: The position of the annotation. :param user: The user who create this annotation. :return: The id of the annotation if it is created.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Remove an annotation from the document.

:param annotation_id: The id of the annotation

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

None

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Add an OpenCascade TopoDS shape to the document. You need pythonocc-core installed in order to use this method.

:param shape: The Open Cascade shape to add. :param name: The name that will be used for the object in the document. :param position: The shape 3D position. :param rotation_axis: The 3D axis used for the rotation. :param rotation_angle: The shape rotation angle, in degrees. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Add a box to the document.

:param name: The name that will be used for the object in the document. :param length: The length of the box. :param width: The width of the box. :param height: The height of the box. :param color: The color of the box in hex format (e.g., "#FF5733") or RGB float list. :param position: The shape 3D position. :param rotation_axis: The 3D axis used for the rotation. :param rotation_angle: The shape rotation angle, in degrees. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Add a cone to the document.

:param name: The name that will be used for the object in the document. :param radius1: The bottom radius of the cone. :param radius2: The top radius of the cone. :param height: The height of the cone. :param angle: The revolution angle of the cone (0: no cone, 180: half cone, 360: full cone). :param color: The color of the cone in hex format (e.g., "#FF5733") or RGB float list. :param position: The shape 3D position. :param rotation_axis: The 3D axis used for the rotation. :param rotation_angle: The shape rotation angle, in degrees. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Add a cylinder to the document.

:param name: The name that will be used for the object in the document. :param radius: The radius of the cylinder. :param height: The height of the cylinder. :param angle: The revolution angle of the cylinder (0: no cylinder, 180: half cylinder, 360: full cylinder). :param color: The color of the cylinder in hex format (e.g., "#FF5733") or RGB float list. :param position: The shape 3D position. :param rotation_axis: The 3D axis used for the rotation. :param rotation_angle: The shape rotation angle, in degrees. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Add a sphere to the document.

:param name: The name that will be used for the object in the document. :param radius: The radius of the sphere. :param angle1: The revolution angle of the sphere on the X axis (0: no sphere, 180: half sphere, 360: full sphere). :param angle2: The revolution angle of the sphere on the Y axis (0: no sphere, 180: half sphere, 360: full sphere). :param angle3: The revolution angle of the sphere on the Z axis (0: no sphere, 180: half sphere, 360: full sphere). :param color: The color of the sphere in hex format (e.g., "#FF5733") or RGB float list. :param position: The shape 3D position. :param rotation_axis: The 3D axis used for the rotation. :param rotation_angle: The shape rotation angle, in degrees. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Add a torus to the document.

:param name: The name that will be used for the object in the document. :param radius1: The outer radius of the torus. :param radius2: The inner radius of the torus. :param angle1: The revolution angle of the torus on the X axis (0: no torus, 180: half torus, 360: full torus). :param angle2: The revolution angle of the torus on the Y axis (0: no torus, 180: half torus, 360: full torus). :param angle3: The revolution angle of the torus on the Z axis (0: no torus, 180: half torus, 360: full torus). :param color: The color of the torus in hex format (e.g., "#FF5733") or RGB float list. :param position: The shape 3D position. :param rotation_axis: The 3D axis used for the rotation. :param rotation_angle: The shape rotation angle, in degrees. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Apply a cut boolean operation between two objects. If no objects are provided as input, the last two created objects will be used as operands.

:param name: The name that will be used for the object in the document. :param base: The base object that will be used for the cut. Can be the name of the object or its index in the objects list. :param tool: The tool object that will be used for the cut. Can be the name of the object or its index in the objects list. :param refine: Whether or not to refine the mesh during the cut computation. :param color: The color in hex format (e.g., "#FF5733") or RGB float list. Defaults to the base object's color if None. :param position: The shape 3D position. :param rotation_axis: The 3D axis used for the rotation. :param rotation_angle: The shape rotation angle, in degrees. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Apply a union boolean operation between two objects. If no objects are provided as input, the last two created objects will be used as operands.

:param name: The name that will be used for the object in the document. :param shape1: The first object used for the union. Can be the name of the object or its index in the objects list. :param shape2: The first object used for the union. Can be the name of the object or its index in the objects list. :param refine: Whether or not to refine the mesh during the union computation. :param color: The color in hex format (e.g., "#FF5733") or RGB float list. Defaults to the base object's color if None. :param position: The shape 3D position. :param rotation_axis: The 3D axis used for the rotation. :param rotation_angle: The shape rotation angle, in degrees. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Apply an intersection boolean operation between two objects. If no objects are provided as input, the last two created objects will be used as operands.

:param name: The name that will be used for the object in the document. :param shape1: The first object used for the intersection. Can be the name of the object or its index in the objects list. :param shape2: The first object used for the intersection. Can be the name of the object or its index in the objects list. :param refine: Whether or not to refine the mesh during the intersection computation. :param color: The color in hex format (e.g., "#FF5733") or RGB float list. Defaults to the base object's color if None. :param position: The shape 3D position. :param rotation_axis: The 3D axis used for the rotation. :param rotation_angle: The shape rotation angle, in degrees. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Apply a chamfer operation on an object. If no objects are provided as input, the last created object will be used as operand.

:param name: The name that will be used for the object in the document. :param shape: The input object used for the chamfer. Can be the name of the object or its index in the objects list. :param edge: The edge index where to apply chamfer. :param dist: The distance of the chamfer. :param color: The color in hex format (e.g., "#FF5733") or RGB float list. Defaults to the base object's color if None. :param position: The shape 3D position. :param rotation_axis: The 3D axis used for the rotation. :param rotation_angle: The shape rotation angle, in degrees. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Apply a fillet operation on an object. If no objects are provided as input, the last created object will be used as operand.

:param name: The name that will be used for the object in the document. :param shape: The input object used for the fillet. Can be the name of the object or its index in the objects list. :param edge: The edge index where to apply fillet. :param radius: The radius of the fillet. :param color: The color in hex format (e.g., "#FF5733") or RGB float list. Defaults to the base object's color if None. :param position: The shape 3D position. :param rotation_axis: The 3D axis used for the rotation. :param rotation_angle: The shape rotation angle, in degrees. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Set the visibility of an object.

:param name: The name of the object. :param value: The visibility value (True or False).

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Set the color of an object.

:param name: The name of the object. :param value: The color in hex format (e.g., "#FF5733").

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.