Reference

FMDocument - object



Your Ad Here


Description

Represents a FeatureCAM part document object

Interfaces

IFMDocument

Methods of IFMDocument

Activate Make this object currently active
AddBoss This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method
AddCircleCenterRadius Create a circle using a center point and a radius
AddCurveOffsetFromCurve Create a curve that is an offset of the specified curve. The argument other_side tells FeatureCAM the offset direction
AddHole This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method
AddLayer Add a layer to the FeatureCAM document
AddLine2Points Create a line using 2 points
AddModel Add a model using an SCL command
AddPocket This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method
AddPoint Create a point
AddPointProjectedToSurface Create a new point that is the result of projecting the given point onto the given surface
AddSetup Add a setup to the FeatureCAM document
AddUCS Add a UCS to the FeatureCAM document
AddValue Add a Value object
AFR Automatic feature recognition
Close Close with the option of saving first
CreateCurvePtList Create an empty FMCurvePtList object
Export Export a file of type tagFMImportType
GetSaveNCData Get the SaveNC options
Hide Hide all objects of type tagFMShowHideType
Import Import a file of type tagFMImportType into FeatureCAM. The file name must include the complete path name for example "C:\Data\Sample.CATPart"
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
RecognizeFeatures Recognize features in the document of type tagFMFeatRecogType. If any, then FeatureCAM will create those features
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
Select Select or deselect a model
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
ShadeSelected Shade the selected models
Show Show all objects of type tagFMShowHideType
ShowNormalsSelected Display the normals for the selected surfaces in the model
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
SimMachine Run the full machine shaded simulation
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
Undo Undo last action. Can be called multiple times to undo more than one action
UnShadeAll Unshade all the models
UnShadeSelected Unshade the selected models
UnShowNormalsSelected Hide the normals for the selected surfaces in the model
ValidateHoleDimensions Check that the given dimensions are valid for a hole of type tagFMHoleType. Return an error if the values are invalid
XFormReflect Reflect the selected models
XFormRotate Rotate the selected models
XFormScale Scale the selected models
XFormToUcs Transform the selected models to a given UCS
XFormTranslate Translate the selected models

Properties of IFMDocument

ActiveLayer R/W The current active layer in the window 
ActiveSetup R/O The active setup in the FeatureCAM document 
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 
ActiveUcs R/O The active UCS in the FeatureCAM document 
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 
DraftHiddenLine R/W The display mode for solid drafting. True if hidden line mode is turned on 
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" 
HiddenLine R/W The display mode for solids. True if hidden line mode is turned on 
Metric R/O True if the dimension units of the object are Metric 
Model R/O Lookup a model by name 
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 
PartLibrary R/O The part library saved in the location specified by path. If the library doesn't exist, set create_if_not_found to create the part library 
PartLibraryMRU R/O The list of names of the last 10 part libraries that were opened 
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 
ShadedSurfaces R/W The display mode for solids. True if shaded is turned on 
SimMode R/W The current simulation mode. See tagFMSimMode 
Stock R/O The stock object in the current FeatureCAM document 
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 
Turning2DView R/W The display mode for turning. True if 2D line drawing mode is turned on 
UserAttribute R/O The user defined attribute on the operation using the name of the attribute 

Collections of IFMDocument

curves All the curves in the FeatureCAM document 
Dimensions All the dimensions in the FeatureCAM document 
Features All the features in the FeatureCAM document 
Geometry All the geometry in the FeatureCAM document 
Layers All the layers in the FeatureCAM document 
Models All the models in the FeatureCAM document 
Operations All the operations in the document 
Selected The collection of the currently selected models. The list can then be indexed by an index number or the name of the model 
SelectedOperations The operations that are selected in the operations list 
Setups All the setups in the FeatureCAM document 
Solids All the solids in the FeatureCAM document 
Surfaces All the surfaces in the FeatureCAM document 
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 
UCSs All the UCSs in the FeatureCAM document 
Windows All the opened document windows 
ZSliceSolid Show a slice of the solid specified by the argument solid. The slice is located at depth zLevel 

Return to FeatureCAM Index


Your Ad Here