repy_module.h

//------------------------------------------------------------------------------
//-- REPY module
//------------------------------------------------------------------------------
//-- This file belongs to the REPY-2.0 module project:
//--
//--    · http://www.dsquaredrobotics.com/wiki/index.php?title=REPY-2.0
//--
//--
//-- REPY-2.0 was designed using the 00ML (Object-Oriented Mechanics Library).
//-- More info about the OOML at:
//--    · http://iearobotics.com/oomlwiki/doku.php
//--
//-- REPY-2.0 concept is deeply based on Juan Gonzalez-Gomez REPY module. More
//-- info about the original REPY at:
//--    · http://www.thingiverse.com/thing:13442
//--    · http://www.iearobotics.com/wiki/index.php?title=M%C3%B3dulos_REPY-1
//--
//------------------------------------------------------------------------------
//-- Author: David Estevez (DEF)
//--
//-- Released under the GPL license (more info on LICENSE.txt file)
//------------------------------------------------------------------------------

#ifndef REPY_MODULE_H
#define REPY_MODULE_H

#include <ooml/core.h>
#include <ooml/components.h>

#include "servos/basicservo.h"
#include "boards/basicsquaredpcb.h"

class REPY_module : public AbstractPart
{
public:
    REPY_module(BasicServo& servo,  BasicSquaredPCB& pcb);



    //-- Configuring the module:
    //--------------------------------------------------------------------------------
    void configRender( bool show_servo = true, bool show_assembly = true, bool show_lower = true, bool show_upper = true );

    void configHorn( int num_arms, int cut_part = 20.5/2.0 - 3);


    //-- Data interface (for reading the module attributes)
    //--------------------------------------------------------------------------------
    //-- Module components:
    //---------------------------------------
    Component get_lower_part();

    Component get_upper_part();

    BasicServo * get_servo();

    BasicSquaredPCB * get_pcb();

    Component get_fake_axis();

    Component get_fake_axis_with_tol();


    //-- Lower part data:
    //-------------------------------------
    double get_lower_base_thickness();

    double get_lower_front_ear_thickness();

    double get_lower_back_ear_thickness();

    double get_lower_ear_shift();

    double get_lower_ear_radius();

    double get_lower_screw_safe();

    double get_lower_border_safe();


    //-- Upper part data:
    //--------------------------------------
    double get_upper_base_thickness();

    double get_upper_front_ear_thickness();

    double get_upper_back_ear_thickness();

    double get_upper_ear_shift();

    double get_upper_ear_radius();

    double get_upper_screw_safe();

    double get_upper_border_safe();

    //-- Tolerances:
    //--------------------------------------
    double get_body_servo_x_tol();

    double get_body_servo_y_tol();

    double get_ear_clearance_tol();

    double get_fake_axis_tol();


    //-- Visibility flags:
    //---------------------------------------
    bool get_show_servo();

    bool get_show_assembly();

    bool get_show_lower();

    bool get_show_upper();


    //-- Dimensions calculated by the software to build the module:
    //-------------------------------------
    double get_side();

    double get_central_part();


protected:

    virtual Component build();

private:
    Component lower_part();

    Component upper_part();

    Component make_ear( double base, double height, double thickness, double shift, double radius);

    //-- Needed components that define the module:
    //--------------------------------------------
    Component lower, upper;

    BasicServo * servo;

    BasicSquaredPCB * pcb;

    Component fake_axis, fake_axis_with_tol;


    //-- Needed dimensions
    //-------------------------------------------------------------------------------
    //-- General:
    //---------------------------------------------
    double board_safe;

    //-- Lower part:
    //---------------------------------------------
    double lower_base_thickness;
    double lower_front_ear_thickness;
    double lower_back_ear_thickness;
    double lower_ear_shift;
    double lower_ear_radius;
    double lower_screw_safe;
    double lower_border_safe;

    //-- Upper part:
    //-----------------------------------------------
    double upper_base_thickness;
    double upper_front_ear_thickness;
    double upper_back_ear_thickness;
    double upper_ear_shift;
    double upper_ear_radius;
    double upper_screw_safe;
    double upper_border_safe;

    //-- Tolerances:
    //------------------------------------------------
    double body_servo_x_tol;
    double body_servo_y_tol;
    double ear_clearance_tol;
    double fake_axis_tol;

    //-- Visibility flags:
    //-----------------------------------------------
    bool show_servo;
    bool show_assembly;
    bool show_lower;
    bool show_upper;

    //-- Dimensions calculated automatically by the software:
    //-------------------------------------------------------
    double side;
    double central_part;
};

#endif // REPY_MODULE_H