Reference

IMFGDocument - interface



Your Ad Here


Methods

Activate Make this object currently active
Close Close with the option of saving first
GetSaveNCData Get the SaveNC options
InvalidateAll Invalidate the toolpaths and the Part View tree. This will cause the Part View tree to reflect the latest changes
InvalidateToolpaths Invalidate the toolpaths so they are no longer ready for posting
NewWindow Create a new document window
Post Display the NC code in the Results window
Print Print the entire document
PrintFM Print only the specified item. See tagFMPrintType
Save Save the document
SaveAs Save the document under a new name
SaveNC Save the generated NC code to the hard disk. The default file_name is part name. Set create_sub_folder to True to create an additional folder with the same name as the part underneath the specified directory
SaveSTL Save the 3D simulation results as an STL file
SaveView Save the current view as a user view. Four different views can be saved at any one point of time
SetAttribute Set the machining attribute on the document using an id from tagFMAttributeId. If the attribute is a P word, then sub_id identifies which one
SetAttributeStr Set the machining attribute on the document using a string for the attribute id
SetUserAttribute Set the user defined attribute on the feature using the name of the attribute
SetView Set the viewing style. For viewing styles see tagFMViewType
SetViewVector Create a custom view by defining a directional viewing vector. The direction will be calculated from the given start and end points of the vector
Sim2D Run the 2D Shaded simulation
Sim3D Run the 3D Solid simulation. During a gouge event, the SimID can be used as an index into the SimulationGougeDetected event handler and limit the execution of the handler to specific segments. See the macro DrillRetractGougeCheck.bas
SimCommand This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method
SimRapidcut Run the RapidCut Solid simulation
SimToolpath Run the centerline simulation. Set the argument show to True to display the tool animation. If False, only the end results of the simulation are displayed on the screen

Properties

ActiveToolCrib R/W The current active toolcrib 
ActiveToolCribObj R/O This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method 
ActiveWindow R/O The current active document window 
Application R/O The FeatureCAM application object 
Attribute R/O The machining attribute on the operation using an id from tagFMAttributeId. If the attribute is a P word, then sub_id identifies which one 
AttributeStr R/O The machining attribute on the operation using a string for the attribute id 
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" 
Metric R/O True if the dimension units of the object are Metric 
Name R/O The name of the object. This is the same name that shows up in the tree view of FeatureCAM 
Parent R/O The FeatureCAM application object 
PartDocumentation R/O The part documentation 
PartName R/W The part name associated with the setup. This property is available in FMSetup only. 
path R/O The complete path name of where the document is saved on the hard disk. For example "C:\Program Files\FeatureCAM\MyFiles" 
ResultsWindow R/O The Results window object of FeatureCAM. The Resulsts window is the pane on the right side of the main FeatureCAM window and contains the operations list 
Saved R/O True if the latest changes to the document have been saved to the hard disk 
SimMode R/W The current simulation mode. See tagFMSimMode 
ToolboxWindow R/O The Toolbox window object of FeatureCAM. The Toolbox window is the pane on the left side of the main FeatureCAM window and contains the Part View and the Steps 
ToolpathsAreValid R/O True if toolpaths are up-to-date and ready for posting. Toolpaths can be updated by running any one of the simulation methods 
UserAttribute R/O The user defined attribute on the operation using the name of the attribute 

Collections

Operations All the operations in the document 
SelectedOperations The operations that are selected in the operations list 
ToolCribs All the toolcribs in the document 
ToolList The list of all the tools used for the entire part 
ToolMaps All the tool maps in the document 
Windows All the opened document windows 

Return to FeatureCAM Index


Your Ad Here