All Variables Grouped
From Macros Wiki
Jump to navigationJump to search
| Program_Variables | Description |
| PLUGIN_VERSION_1 | Version number of GibbsCAM that the macro plugin |
| PLUGIN_VERSION_2 | was developed for, expressed as 3 values. eg 9.5.1 |
| PLUGIN_VERSION_3 | version_1 = 9, version_2 = 5, version_3 = 1 |
| GIBBSCAM_VERSION_1 | Version number of GibbsCAM that is |
| GIBBSCAM_VERSION_2 | currently running, expressed as 3 values |
| GIBBSCAM_VERSION_3 | same format as plugin_version |
| CURRENT_WG_NUMBER | The current WorkGroup number |
| CURRENT_CS_NUMBER | The current CS number |
| SCREEN_WIDTH | Total screen width, in screen units |
| SCREEN_HEIGHT | Total screen height |
| GIBBSCAM_WINDOW_X1 | Left corner of GibbsCAM window |
| GIBBSCAM_WINDOW_Y1 | Top corner of GibbsCAM window |
| GIBBSCAM_WINDOW_X2 | Right corner of GibbsCAM window |
| GIBBSCAM_WINDOW_Y2 | Bottom corner of GibbsCAM window |
| EXCEL_IS_OPEN | Set to 1 if Excel is currently opened by a macro |
| EXCEL_IS_VISIBLE | Set to 1 if Excel is visible, 0 if hidden |
| Mill Tool Types | Description |
| MTOOL_TYPE_ROUGH_END_MILL | Rough End Mill |
| MTOOL_TYPE_FINISH_END_MILL | Finish End Mill |
| MTOOL_TYPE_BALL_END_MILL | Ball-nosed End Mill |
| MTOOL_TYPE_SHELL_CUTTER | Shell cutter |
| MTOOL_TYPE_FACE_CUTTER | Face Cutter |
| MTOOL_TYPE_FLY_CUTTER | Fly Cutter |
| MTOOL_TYPE_KEY_CUTTER | Key Cutter |
| MTOOL_TYPE_THREAD_MILL | Thread Mill |
| MTOOL_TYPE_DRILL | Drill |
| MTOOL_TYPE_CENTER_DRILL | Center Drill |
| MTOOL_TYPE_SPOT_DRILL | spot Drill |
| MTOOL_TYPE_BORE | Bore |
| MTOOL_TYPE_BACK_BORE | Back Bore |
| MTOOL_TYPE_TAP | Tap |
| MTOOL_TYPE_RIGID_TAP | Rigid Tap |
| MTOOL_TYPE_SPOT_FACE | Spot Face |
| MTOOL_TYPE_REAMER | Reamer |
| MTOOL_TYPE_COUNTERSINK | Countersink |
| MTOOL_TYPE_ROUNDOVER | Roundover |
| MTOOL_TYPE_THREAD_HALF_PROF | Half Profile Thread |
| MTOOL_TYPE_THREAD_FULL_PROF | Full Profile Thread |
| MTOOL_TYPE_CONVEX_TIP | Convex Tip |
| MTOOL_TYPE_BARREL | Barrel |
| MTOOL_TYPE_TAPERED_BARREL | Tapered Barrel |
| MTOOL_TYPE_DOVETAIL | Dovetail |
| MTOOL_TYPE_TAPERED_BARREL | Tapered Barrel |
| MTOOL_TYPE_TANGENT_MILL | Tangent Mill |
| MTOOL_TYPE_FORM | 2D Form Tool |
| MTOOL_TYPE_2DFORM | 2D Form Tool |
| MTOOL_TYPE_3DFORM | 3D Form Tool |
| Lathe Tool Types | Description |
| LTOOL_TYPE_80_DEG | 80 Degree Insert |
| LTOOL_TYPE_75_DEG | 75 Degree Insert |
| LTOOL_TYPE_55_DEG | 55 Degree Insert |
| LTOOL_TYPE_35_DEG | 35 Degree Insert |
| LTOOL_TYPE_ROUND | Round Insert |
| LTOOL_TYPE_SQUARE | Square Insert |
| LTOOL_TYPE_TRIANGLE | Triangular Insert |
| LTOOL_TYPE_TRIGON | Trigon Insert |
| LTOOL_TYPE_PENTAGON | Pentagon Insert |
| LTOOL_TYPE_55_PARA | 55 Degree Parallelogram |
| LTOOL_TYPE_RECTANGLE | Rectangular Insert |
| LTOOL_TYPE_GROOVE | Grooving Tool |
| LTOOL_TYPE_CUTOFF | Cutoff Tool |
| LTOOL_TYPE_THREAD1 | Threading Insert, Type 1 |
| LTOOL_TYPE_THREAD2 | Threading Insert, Type 2 |
| LTOOL_TYPE_THREADN | Threading Insert, Type 1 |
| LTOOL_TYPE_THREADL | Threading Insert, Type 2 |
| LTOOL_TYPE_VPROFILE | V Profile |
| LTOOL_TYPE_FORM | 2D Form Tool |
| LTOOL_TYPE_2DFORM | 2D Form Tool |
| LTOOL_TYPE_3DFORM | 3D Form Tool |
| TOOL_TYPE_UTIL | Utility Tool |
| Long Versions | Description |
| TOOL_ORIENT_UP_RIGHT | Up and Right |
| TOOL_ORIENT_UP_LEFT | Up and Left |
| TOOL_ORIENT_DOWN_LEFT | Down and Left |
| TOOL_ORIENT_DOWN_RIGHT | Down and Right |
| TOOL_ORIENT_RIGHT_UP | Right and Up |
| TOOL_ORIENT_LEFT_UP | Left and Up |
| TOOL_ORIENT_LEFT_DOWN | Left and Down |
| TOOL_ORIENT_RIGHT_DOWN | Right and Down |
| Short Versions | |
| TOOL_ORIENT_UR | Up and Right |
| TOOL_ORIENT_UL | Up and Left |
| TOOL_ORIENT_DL | Down and Left |
| TOOL_ORIENT_DR | Down and Right |
| TOOL_ORIENT_RU | Right and Up |
| TOOL_ORIENT_LU | Left and Up |
| TOOL_ORIENT_LD | Left and Down |
| TOOL_ORIENT_RD | Right and Down |
| Mill Tool Holder Types | Description |
| MTOOL_HOLDER_TYPE_BORE | Bore |
| MTOOL_HOLDER_TYPE_COLLET | Collet |
| MTOOL_HOLDER_TYPE_TG_COLLET | Collet - TG |
| MTOOL_HOLDER_TYPE_DRILL | Drill |
| MTOOL_HOLDER_TYPE_MILL | Mill |
| MTOOL_HOLDER_TYPE_ROT_CLAMP | Rotary Clamp |
| MTOOL_HOLDER_TYPE_SHELL | Shell |
| MTOOL_HOLDER_TYPE_SHRINK_FIT | Shrink Fit |
| MTOOL_HOLDER_TYPE_TAP | Tap |
| Feature_Types | Description |
| FEAT_TYPE_POINT | Point |
| FEAT_TYPE_LINE | Line |
| FEAT_TYPE_ARC | Circular Arc |
| FEAT_TYPE_CURVE | Curve (Spline) |
| FEAT_TYPE_SPLINE | Curve (Spline) |
| FEAT_TYPE_LINE_IJK | Line with IJK tool vector |
| FEAT_TYPE_RAPID | Rapid Move |
| FEAT_TYPE_CTOOL | CTool Marker |
| FEAT_TYPE_MARKER | CTool Marker |
| WorkGroup Data | Description |
| WG_TYPE_PART_GEO | Type is Geometry |
| WG_TYPE_PART_STOCK | Type is Stock |
| WG_AXIS_X | Revolve Around X / Extrude along X |
| WG_AXIS_Y | Revolve Around Y / Extrude along Y |
| WG_AXIS_Z | Revolve Around Z / Extrude along Z |
| These variables are set by some of the macro commands | Description |
| PointRef | Reference number of point created |
| LineRef | Reference number of line created |
| CircleRef | Reference number of circle created |
| ContourRef | Reference number of contour created |
| SolidRef | Reference number of solid created |
| ExcelError | Error code set by all Excel commands (0 = no error) |
| ExcelCellLength | Length of text read from a cell in characters |
| FileError | Error code set by all file commands (0 = no error) |
| ReadVarsNumVars | Number of variables read using READ_NUM_VARS command |
| HoleFrError | Error code set by all HOLEFR commands (0 = no error) |
| CsNumber | Number of CS created |
| WgNumber | Number of WorkGroup created |
| Button | Number of button pressed on macro dialog (0 = OK button) |
The HOLEFR_GET_FEAT command sets these variables.
HOLEFR_GET_FEAT_Variables
| HOLEFR Variables | Description |
| HoleFrRef | Hole Feature Reference number |
| HoleFrType | Hole Type |
| HoleFrCS | Hole CS number |
| HoleFrRevCS | CS number for opposite direction |
| HoleFrThroughType | Though Hole Type |
| HoleFrDia | Overall Diameter |
| HoleFrDiaTop | Diameter at Top of Hole |
| HoleFrDepth | Total Depth |
| HoleFrMidDepth | Mid Depth |
| HoleFrFullDepth | Full Depth |
| HoleFrTopClear | Top Clearance Amount |
| HoleFrBottomClear | Bottom Clearance Amount |
| HoleFrTopZ | Top Z |
| HoleFrBottomZ | Bottom Z |
| HoleFrTop | Top |
| HoleFrBottom | Bottom |
| HoleFrWidth | Width |
| HoleFrAngle | Angle |
| HoleFrTipAngle | Tip Angle |
| HoleFrPosX | Hole Position |
| HoleFrPosY | measured at the |
| HoleFrPosZ | bottom of the hole |
| HoleFrPosTopX | Hole Position |
| HoleFrPosTopY | measured at the |
| HoleFrPosTopZ | top of the hole |
| HoleFrPosAxisX | Axis vector |
| HoleFrPosAxisY | measured from |
| HoleFrPosAxisZ | bottom to top |
