|
Represents the FeatureCAM program as a whole |
| IApplication |
| CreateAnnotationText | Called when an annotaion text object is created. The annotated text object can be modifed through the argument text |
| DocumentActivate | Called when a .FM document is activated and brought up to the front of all the other document windows |
| DocumentActivate2 | Called when a FeatureCAM document is activated and brought up to the front of all the other document windows. This handler applies to all FetureCAM document types |
| DocumentBeforeClose | Called when a .FM document is about to be closed |
| DocumentBeforeClose2 | Called when a FeatureCAM document is about to be closed. This handler applies to all FeatureCAM document types |
| DocumentBeforePrint | Called when a .FM document is about to be printed |
| DocumentBeforePrint2 | Called when a FeatureCAM document is about to be printed. This handler applies to all FeatureCAM document types |
| DocumentBeforeSave | Called when a .FM document is about to be saved |
| DocumentBeforeSave2 | Called when a FeatureCAM document is about to be saved. This handler applies to all FeatureCAM document types |
| DocumentDeactivate | Called when a .FM document is deactivated and sent behind other document windows |
| DocumentDeactivate2 | Called when a FeatureCAM document is deactivated and sent behind other document windows |
| DocumentNew | Called when a new .FM is created. The new document is passed into the event |
| DocumentNew2 | Called when a new FeatureCAM document is created. This handler applies to all FeatureCAM document types |
| DocumentOpen | Called when a .FM document is opened. The newly opened document is passed into the event |
| DocumentOpen2 | Called when a FeatureCAM document is opened. This handler applies to all FeatureCAM document types |
| HoleRecogAfterCreate | Called after a hole is created during the feature recognition process |
| HoleRecogBeforeCreate | Called before a hole is created during the feature recognition process |
| HoleRecogBeforeCreate2 | Same as HoleRecogBeforeCreate event handler with the addition of the flags argument. Set the flags argument to indicate that the hole requires attention later. Call AFRBeforeCreateFlag to check if this flag was set |
| MillFeedSpeed | Called when feed/speed is computed by FeatureCAM. The default feed/speed values computed from the standard FeatureCAM database are passed to this handler. To override those values, set use_new_values to True and set the desired feed and speed values |
| PostNCCreate | Called when posting is done, giving the handler the opportunity to change the NC code |
| SetupActivate | Called when a setup is activated |
| SimulationGougeDetected | Called when a simulation gouge is detected |
| StockMaterialChanged | Called when the stock material has been changed |
| UserFeatureVerify | Called when the user changes the parameters of a user defined feature. This handler provides the decomposition and geometric representation for a UDF |
| UserOperationDefaultTool | Called when a user defined operation is decomposed, and when FeatureCAM needs to locate the default tool for the operation. This handler provides the automatic tool selection capability for a UDO |
| UserOperationFeedSpeed | Called when a user defined operation is decomposed, and when FeatureCAM needs to locate the default feed/speed for the operation. This handler provides the automatic feed/speed capability for a UDO |
| UserOperationToolPath | Called when the toolpath is about to be computer for a user defined operation |
| Activate | Make this object currently active |
| AddLoadModuleForTest | This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| Arrange | Arrange the opened FeatureCAM windows in a specific fashion. See tagFMWindowArrange |
| AttributeFlags | Return the feature and operation type that utilize the attribute specified by attr_id. |
| DisplayFeatureProperty | |
| Exit | Exit and shutdown FeatureCAM |
| FindFile | Show the Open dialog box allowing the user to choose a file to open. True is returned if the file opens successfully |
| GetMillPostOptions | Get the post options for Milling |
| GetMillPostOptions2 | Get the post options for Milling |
| GetOpenFilename | Show the Open dialog box with the optional file filters, titles, and button texts specified by the arguments. The filename and path are returned from this method call. Does not actually open the file |
| GetSaveAsFilename | Show the Save As dialog box with the optional file filters, titles and button texts specified by the arguements. The filename and pathe are retuned from this method call. Does not actually save the file |
| GetTurnPostOptions | Get the post options for Turning |
| GetWirePostOptions | Get the post options for Wire EDM |
| Help | Display the help topic specified by the argument HelpContextId in the help file HelpFile |
| LoadCNC | Load a CNC file |
| RegisterBasicDllEntryPoint | Same as RegisterDLLEntryPoint but for a Visual Basic DLL |
| RegisterDllEntryPoint | For a C++ DLL addin, the DLL calls this method to tell FeatureCAM what public functions are available to the user in the DLL. The entry point can be assigned to a toolbar button or executed directly from the Run Macro dialog. See DllAddinGuide.pdf |
| RegisterUserFeature | Create a new user defined feature. Each user defined feature must have a unique name. The root_name is the name that the feature gets when it is created. The created features are named root_name1, root_name2...etc. |
| RegisterUserOperation | Create a new user defined operation. Each user defined operation must have a unique registered_name |
| RunTestMacro | internal use only |
| SetMillPostOptions | Set the post options for Milling |
| SetMillPostOptions2 | Set the post options for Milling |
| SetTurnPostOptions | Set the post options for Turning |
| SetWirePostOptions | Set the post options for Wire EDM |
| ShellAndWait | Start running the indicated program and wait for it to finish. If the program requires a set of parameters, they can be specified in arguments. The method returns True if the program was executed successfully, and False otherwise |
| ShowProgressBar | Display the progress bar |
| UnloadMacroFile | internal use only |
| UnRegisterDllEntryPoint | When the DLL is unloaded, it must call UnRegisterDllEntryPoint to tell FeatureCAM that the DLL methods are no longer available to the user |
| WritePerfLog | Create a FeatureCAM performance log file containing the following data: Wall Time, Task Title, User time (sec.ms), VM Size(KB), Peak VM(KB), Peak Memory Usage(PeakWorkingSetSize KB),Memory Usage(WorkingSetSize KB),PageFaultCount, Kernel Time (sec.ms) |
| ActiveDocument | R/O | The current active FeatureCAM document |
| ActivePrinter | R/W | This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| Application | R/O | The FeatureCAM application object |
| DecimalPlacesEnglish | R/W | The number of decimal places used throughout FeatureCAM when representing numbers in the English system |
| DecimalPlacesMetric | R/W | The number of decimal places used throughout FeatureCAM when representing numbers in the Metric system |
| DongleFlags | R/O | The module options that are set on the dongle |
| EnableEvents | R/W | True if events are called for any FeatureCAM model object that supports events |
| FSDatabase | R/O | The feed speed database associated with the current FeatureCAM session |
| FullName | R/O | The name of the document and the complete path name of where the document is saved on the hard disk. For example "C:\Program Files\FeatureCAM\MyFiles\FM1.fm" |
| GeomServer | R/O | The GeomServer object used to generate the temporary geom objects |
| InstallPath | R/O | The FeatureCAM installation folder, such as "C:\Program Files\FeatureCAM" |
| InterfaceFlags | R/W | The interface options that the user has chosen in the Evaluation Options dialog |
| LastError | R/O | The error generated by the last API call, if any |
| MDIMaxHeight | R/O | The maximum height of the available graphic window space |
| MDIMaxWidth | R/O | The maximum width of the available graphic window space |
| Name | R/O | The name of the object. This is the same name that shows up in the tree view of FeatureCAM |
| OperatingSystem | R/O | The name and version of the operating system |
| Parent | R/O | The FeatureCAM application object |
| path | R/O | The complete path name of where the document is saved on the hard disk. For example "C:\Program Files\FeatureCAM\MyFiles" |
| SimOptions | R/O | The current simulation options |
| UserControl | R/O | True if the current FeatureCAM session was started by a user. False if the FeatureCAM session was started programmatically |
| Version | R/O | The version of FeatureCAM, such as "11.5.0.0" |
| Visible | R/W | True if the object is visible |
| WindowHeight | R/W | The height of the window |
| WindowLeft | R/W | The location of the left edge of the window which is the number of pixels from the left edge of the screen |
| WindowTop | R/W | The locatio of the top edge of the window which is the number of pixels from the top edge of the screen |
| WindowWidth | R/W | The width of the window |
| CommandBars | The list of all toolbars in the current FeatureCAM session. Custom buttons can then be added to the toolbars. |
| Configurations | The list of configurations in the current FeatureCAM session |
| Documents | All the open documents in the current FeatureCAM session |