import cnc25d_api
cnc25d_api.importing_freecad()
import Part           # to show-up 3D in FreeCAD
import sys            # to exit on error
import argparse       # to define the ABC_design constraint
import math           # usually useful to calcule point coordinates

def ABC_constraint_constructor(parser):
  """ define the ABC constraint constructor using the argparse description
  """
  parser.add_argument('--length_A', '-a', action='store', type=float, default=10.0,
    help="set the length_A of ABC. Default: 10.0")
  parser.add_argument('--length_B', '-b', action='store', type=float, default=0.0,
    help="set the length_B of ABC. If equal 0.0, set to length_A. Default: 0.0")
  parser.add_argument('--smooth_radius', '--sr', action='store', type=float, default=0.0,
    help="set the smooth-radius of the corners of ABC. Default: 0.0")
  return(parser) # return an argparse object

def ABC_constraint_check(c):
  """ check the ABC constraint c and set the dynamic default values
  """
  # dynamic default values
  if(c['length_B']==0):
    c['length_B'] = c['length_A']
  # check the constraint
  if(c['length_B']<c['length_A']*0.1):
    print("ERR129: Error, length_B {:0.3f} is too small compare to length_A {:0.3f}".format(c['length_B'], c['length_A']))
    sys.exit(2)
  return(c) # return a dictionary

def ABC_figures(c):
  """ construct the ABC 2D-figure-outlines at the A-format from the constraint c
      It returns a dictionary of figures with outlines in the A-format
  """
  r_figures = {}
  r_height = {}
  #
  ABC_base_figure = []
  ABC_external_outline_A = [] # the square
  ABC_external_outline_A.append((0.0,0.0, c['smooth_radius']))
  ABC_external_outline_A.append((0.0+c['length_A'], 0.0, c['smooth_radius']))
  ABC_external_outline_A.append((0.0+c['length_A'], 0.0+c['length_B'], c['smooth_radius']))
  ABC_external_outline_A.append((0.0, 0.0+c['length_B'], c['smooth_radius']))
  cnc25d_api.outline_close(ABC_external_outline_A)
  ABC_base_figure.append(ABC_external_outline_A)
  #
  r_figures['ABC_base'] = ABC_base_figure
  r_height['ABC_base'] = c['length_A']
  return((r_figures, r_height)) # return a tuple of two dictionaries

def ABC_3d(c):
  """ construct the ABC-assembly-configuration for 3D-freecad-object from the constraint c
      It returns a dictionary of assembly-configurations
  """
  r_assembly = {}
  r_slice = {}
  #
  simple_abc_assembly = []
  simple_abc_assembly.append(('ABC_base', 0.0, 0.0, c['length_A'], c['length_B'], c['length_A'], 'i', 'xy', 0, 0, 0))
  #
  size_xyz = (c['length_A'], c['length_B'], c['length_A'])
  zero_xyz = (0.0, 0.0, 0.0)
  slice_x = [ (i+1)/12.0*size_xyz[0] for i in range(10) ]
  slice_y = [ (i+1)/12.0*size_xyz[1] for i in range(10) ]
  slice_z = [ (i+0.1)/12.0*size_xyz[2] for i in range(10) ]
  slice_xyz = (size_xyz[0], size_xyz[1], size_xyz[2], zero_xyz[0], zero_xyz[1], zero_xyz[2], slice_z, slice_y, slice_x)
  #
  r_assembly['abc_assembly_conf1'] = simple_abc_assembly
  r_slice['abc_assembly_conf1'] = slice_xyz
  return((r_assembly, r_slice)) # return a tuple of two dictionaries

def ABC_info(c):
  """ create the text info related to the ABC from the constraint c
  """
  r_txt = """
length_A: \t{:0.3f}
length_B:  \t{:0.3f}
smooth_radius: \t{:0.3f}
""".format(c['length_A'], c['length_B'], c['smooth_radius'])
  return(r_txt) # return a string-text

def ABC_self_test():
  """ set the self_tests for the ABC-design
  """
  r_tests = [
    ('default abc', ''),
    ('unregular abc', '--length_A 30.0 --length_B 20.0 --smooth_radius 8.0'),
    ('heigh abc', '--length_A 5.0 --length_B 5.0 --smooth_radius 2.0 --output_file_basename test_output/height_abc.dxf')]
  return(r_tests) # return a list of 2-tuples

class ABC(bare_design):
  """ ABC design
  """
  def __init__(self, constraint={}):
    """ configuration of the ABC design
    """
    self.design_setup(
      s_design_name             = "ABC_design",
      f_constraint_constructor  = ABC_constraint_constructor,
      f_constraint_check        = ABC_constraint_check,
      f_2d_constructor          = ABC_figures,
      d_2d_simulation           = {},
      f_3d_constructor          = ABC_3d,
      f_3d_freecad_constructor  = None,
      f_info                    = cube_info,
      l_display_figure_list     = [],
      s_default_simulation      = "",
      l_2d_figure_file_list     = [],
      l_3d_figure_file_list     = [],
      l_3d_conf_file_list       = [],
      l_3d_freecad_file_list    = None,
      f_cli_return_type         = None,
      l_self_test_list          = ABC_self_test())
    self.apply_constraint(constraint)

if __name__ == "__main__":
  my_abc = ABC()
  my_abc.cli("--length_A 50.0 --length_B 30.0 --output_file_basename test_output/abc.dxf")
  if(cnc25d_api.interpretor_is_freecad()):
    Part.show(my_abc.get_fc_obj_3dconf('abc_assembly_conf1'))

class ABC(bare_design):
  def __init__(self, constraint={}):
    self.design_setup( # function to setup a cnc25d design
      s_design_name             = "ABC_design", # mandatory string, used to enhance information and error messages
      f_constraint_constructor  = ABC_constraint_constructor, # mandatory function, set the design constraint
      f_constraint_check        = ABC_constraint_check, # highly recommended function to check the design constraint
      f_2d_constructor          = ABC_figures, # function that generates a dictionary that contains 2D-figures
      d_2d_simulation           = ABC_simulations(), # dictionary to functions running simulations
      f_3d_constructor          = ABC_3d, # function that generates a dictionary that contains 3D-assembly
      f_3d_freecad_constructor  = ABC_3d_freecad_construction, # function that generates a dictionary that contains 3D-freecad-functions
      f_info                    = ABC_info, # function that generates a string
      l_display_figure_list     = [], # list of the 2D-figures to be displayed in a Tk-window
      s_default_simulation      = "", # simulation string name, set the default action to simulation instead of 2D-figure-display
      l_2d_figure_file_list     = [], # 2D-figures to be written in SVG or DXF files
      l_3d_figure_file_list     = [], # 2D-figures to be written in Brep files
      l_3d_conf_file_list       = [], # 3D-assembly-configurations to be written in Brep files
      l_3d_freecad_file_list    = [], # 3D-freecad-construction to be written in Brep files
      f_cli_return_type         = [], # obsolete function that defines the return value of the method cli()
      l_self_test_list          = ABC_self_test()) # list of tests to be run to check the design
    self.apply_constraint(constraint) # optional but quiet convenient

my_abc = ABC(ABC_constraint)
my_abc.outline_display() # display the 2D-figures of the list l_display_figure_list in Tk-windows
my_abc.write_figure_svg("test_output/abc_macro") # write in SVG files the 2D-figures of the list l_2d_figure_file_list
my_abc.write_figure_dxf("test_output/abc_macro") # write in DXF files the 2D-figures of the list l_2d_figure_file_list
my_abc.write_figure_brep("test_output/abc_macro") # write in Brep files the extruded 2D-figures of the list l_3d_figure_file_list
my_abc.write_assembly_brep("test_output/abc_macro") # write in Brep files the 3D-assembly of the list l_3d_conf_file_list
my_abc.write_freecad_brep("test_output/abc_macro") # write in Brep files the 3D-assembly of the list l_3d_freecad_file_list
#my_abc.run_simulation("sim_A") # run the simulation
my_abc.view_design_configuration() # display information of the design setup. Useful when you want to reuse an old design
my_abc.run_self_test("") # run the test case of the list l_self_test_list
my_abc.cli("--output_file_basename test_output/my_abc.dxf") # Warning: all constraint values are reset to their default values

if(cnc25d_api.interpretor_is_freecad()): # check if the interpretor is freecad
  Part.show(my_abc.get_fc_obj_3dconf('A_3dconf')) # display the 3D object corresponding to the 3D-assembly-configuration abc_3dconf1

my_fig = my_abc.get_A_figure('A_figure') # get the figure A_figure at the A-format
my_fig = my_abc.get_B_figure('A_figure') # get the figure A_figure at the B-format
my_fc_obj = my_abc.get_fc_obj_3dconf('A_3dconf') # get the FreeCAD object generated by the 3D-assembly-configuration A_3dconf
my_fc_obj = my_abc.get_fc_obj_function('A_3dobj') # get the FreeCAD object generated by the 3D-freecad-construction A_3dobj
my_txt = my_abc.info() # get text information about the design ABC
my_constraint = my_abc.get_constraint() # get a dictionary containing all set and internal constraint of the ABC design
my_abc.apply_constraint(my_constraint) # change the constraint of the ABC design my_abc with checking the dictionary set as argument
my_abc.apply_external_constraint(my_constraint) # change the constraint of the ABC design my_abc without checking the dictionary set as argument

(figs, heights) = my_abc.apply_2d_constructor() # generates and returns the 2D-figures according to the current constraint
(assembly_3dconfs, slice_confs) = my_abc.apply_3d_constructor() # generates and returns the 3D-assembly-configurations according to the current constraint
(freecad_function_pts, slice_confs) = my_abc.apply_3d_freecad_constructor()  # generates and returns the 3D-freecad-function-pointers according to the current constraint

my_abc.set_design_name(s_design_name) # overwrite the design name
my_abc.set_constraint_constructor(f_constraint_constructor) # overwrite the function that defines the design constraint
my_abc.set_constraint_check(f_constraint_check) # overwrite the function that checks the design constraint
my_abc.set_2d_constructor(f_2d_constructor) # overwrite the function that generates the 2D-figures
my_abc.set_2d_simulation(d_2d_simulation) # overwrite the dictionary that points to the simulation functions
my_abc.set_3d_constructor(f_3d_constructor) # overwrite the function that generates the 3D-assembly-configurations
my_abc.set_3d_freecad_constructor(f_3d_freecad_constructor) # overwrite the function that points to the freecad-3d-construction functions
my_abc.set_info(f_info) # overwrite the function that generates the information string
my_abc.set_display_figure_list(l_display_figure_list) # overwrite the list of the displayed 2D-figures
my_abc.set_default_simulation(s_default_simulation) # overwrite the default action as simulation. If set to the empty string, display 2D-figures is the default action.
my_abc.set_2d_figure_file_list(l_2d_figure_file_list) # overwrite the list of the 2D-figures to be written in SVG or DXF files
my_abc.set_3d_figure_file_list(l_3d_figure_file_list) # overwrite the list of the 2D-figures to be written in Brep files
my_abc.set_3d_conf_file_list(l_3d_conf_file_list) # overwrite the list of the 3D-assembly-configurations to be written in Brep files
my_abc.set_3d_freecad_file_list(l_3d_freecad_file_list) # overwrite the list of the 3D-freecad-function-construction to be written in Brep files
my_abc.set_cli_return_type(f_cli_return_type) # overwrite the function to generate the return value of the cli() method
my_abc.set_self_test(l_self_test_list) # overwrite the list of tests