VERICUT API Guide-converted

VERICUT Development Tools

1

OptiPath API

Introduction

OptiPath API is designed to enable an interface between VERICUT and customized plug-

in toolpath optimization programs. OptiPath API is only available on Windows platform.

installation.

How to build a plug-in library

The plug-in format used by VERICUT is a "WIN32 Dynamic Linked Library" which can

be built using MSVC. The following files/libraries are needed:

opapi.h, optimport.h, opapi.lib, opapi.dll

and a sample C file called "opapi_template.c"

The easiest way to build such a plug-in dll , for example, "opapi_usr.dll", is to start with

creating a C/C++ file, like "opapi_usr.c", with the skeleton code found in

"opapi_template.c".

There is one setup function must be present with exactly the declaration style and name

void opapi_set_terminate_function(OPAPI_TerminateFunction);

void opapi_set_tool_change_setup_function(OPAI_ToolSetupFunction);

void opapi_set_user_data(void *);

2

In addition, there are 25 optional utility functions that provide the user program with

detailed process data. All the functions are described in the Function Definition section at

the end of this document. Examples can be found in "opapi_template.c".

char *opapi_get_variable_value(char *);

double opapi_get_axial_depth(void);

double opapi_get_program_feedrate(void);

double opapi_get_spindle_speed(void);

int opapi_get_thin_cut_flag(void);

int opapi_get_turning_contact_profile(int*, int**, sOPAPI_PROFILE **);

void opapi_free(char *);

void opapi_get_contact_area(int *, double *);

void opapi_get_current_tool(char **, int *, sOPAPI_APT_CUTTER *);

void opapi_get_cut_machine_position(double[12], double[12]);

void opapi_get_cut_tool_position(double[6], double[6]);

void opapi_get_decompressed_map_data(sOPAPI_MAP, int *, char **);

void opapi_get_grid_map(sOPAPI_MAP *);

void opapi_get_motion_type(eOPAPI_MOTION_TYPE *, double[6]);

3

Include "opapi.h" and "optimport.h" in "opapi_usr.c". Compile and link all the usr files

with "opapi.lib". This will generate a ".dll" library.

Set system environment variable "CGTECH_OPAPI" set to where this dll is , for

example, "c:\opapi\opapi_usr.dll" and place "opapi.dll" in the same directory where

"CGTech.dll" is. OptiPath API mode is now ready to go.

4

Function Definitions

Setup Functions

void opapi_setup(void)

Setup function. Must be present with exactly the same declaration style and name. Called

when OptiPath API library is first loaded. It is to register user's optimization function.

The following functions can be and should only be called in this setup function:

opapi_set_initialize_function(OPAPI_InitializeFunction);

registered, func_p, should have the following declaration style:

typedef int (*OPAPI_InitializeFunction)(void *userData);

which returns 1 if initialization is successful or 0 if initialization failed. If failed, OptiPath

will be turned off. This function should only be called in opapi_setup() function. Once

registered, the initialization function, func_p, will be called each time the user turn

OptiPath on.

void opapi_set_optimize_function(OPAPI_OptimizeFunction func_p)

Register user's optimization function with VERICUT. The optimization function

registered, func_p, should have the following declaration style:

typedef void (*OPAPI_OptimizeFunction)(void *userData);