| Name |
Description |
| Activate |
Make this object currently active |
| Add |
Add a part and setup to the multiple fixture document |
| Add |
Add a new toolbar with a title specified by name. The arguments position and temporary are not used |
| Add |
Add a new control. The type argument is not used. To create a default macro button leave the ID argument blank, otherwise specify the control id. If the new control is a macro button then specify the name of the macro in the Parameter argument |
| AddAngleDimension |
Create dimension information for an angle between 2 lines |
| AddAnnotationDimension |
Create an annotation |
| AddArc |
Add an arc between the last point in the list and the new X,Y,Z point |
| AddArcCenterRadiusStartEndAngle |
Create an arc using a center point, a radius, and the star and end angles |
| AddArcCenterStartPtEndPt |
Create an arc using 3 points |
| AddArcMove |
Add a toolpath arc move from the current tool location to the new x,y,z location. The A,B angle arguments are for 4-axis and 5-axis machines |
| AddArcMove2 |
Same as AddArcMove but with the option to apply the arc move to simulation only. If sim_only is set to True then no actual toolpath will be genereated for this move |
| AddAttributeDefinition |
Add a new attribute to the operation |
| AddAttributeDefinition2 |
Add an attribute to the operation from an existing list of attributes. See tagFMAttributeId |
| AddBarFeed |
Create a bar feed feature |
| AddBore |
Create a bore feature |
| AddBore |
Add a bore operation to the feature |
| AddBore2 |
Add a bore operation to the feature |
| AddBoss |
Create a boss feature |
| AddBoss |
This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| AddChamfer |
Add a chamfer operation to the feature |
| AddChamfer2 |
Add a chamfer operation to the feature |
| AddCircleCenterRadius |
Create a circle using a center point and a radius |
| AddCircularDimension |
Create dimension information for the radius or diameter of a circle |
| AddConfiguration |
Add the configuration with the given name to the collection |
| AddCounterBore |
Add a counter bore operation to the feature |
| AddCounterBore2 |
Add a counter bore operation to the feature |
| AddCounterSink |
Add a counter sink operation to the feature |
| AddCounterSink2 |
Add a counter sink operation to the feature |
| AddCrossSectionArc |
An arc drawing tool to draw the cross-section of the feature in the XZ plane |
| AddCrossSectionLinear |
A line drawing tool to draw the cross-section of the feature in the XZ plane. The line start point is the feature location and the end point is set by the X,Z arguments. See Example.bas |
| AddCurveFromPtList |
Generate a curve from the list of points. Set the argument closed to True if the curve should be drawn as a closed curve |
| AddCurveOffsetFromCurve |
Create a curve that is an offset of the specified curve. The argument other_side tells FeatureCAM the offset direction |
| AddCurveOffsetFromCurve2 |
Create a curve that is an offset of the specified curve with the option to eliminate self-intersections |
| AddCurveProjectedToSurface |
Create a curve by projecting the specfied curve onto a surface |
| AddCutoff |
Create a cutoff feature |
| AddCutterComp |
Add a toolpath cutter comp move |
| AddCylinderMatchLevel |
Add a cylinder diameter and depth to allow this UDF to be matched in AFR |
| AddDataDefinition |
Add a new attribute to the feature |
| AddDimensionsTurnGroove |
Create a turned groove feature from dimensions |
| AddDistDimension |
Create dimension information based on distance |
| AddDrill |
Add a drill operation to the feature. Use this operation for pilot drilling too. Note that the drilling operation looks downstream to find a ream operation. If it finds one, then the drill tool selection will choose a drill size to match the ream size |
| AddDrill2 |
Add a drill operation to the feature. Use this operation for pilot drilling too. Note that the drilling operation looks downstream to find a ream operation. If it finds one, then the drill tool selection will choose a drill size to match the ream size |
| AddFeature |
Add an existing feature to the setup using the feature name |
| AddFM |
Make a new .fm document of the specified setup type and units. The new document window will open up in FeatureCAM |
| AddFolder |
Add a sub folder to the part library folder |
| AddGeomCircle |
A circle drawing tool to define the shape of the feature. The specified center point is relative to the position of the feature set by FMFeature.SetFeatureLocation. This method can be used in combination with other AddGeom methods |
| AddGeomLinear |
A line drawing tool to define the shape of the feature. The specified location values are relative to the position of the feature set by FMFeature.SetFeatureLocation. This method can be used in combination with other AddGeom methods |
| AddHole |
Create a hole feature |
| AddHole |
This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| AddHoleMatchLevel |
Add a hole diameter and depth to allow this UDF to be matched in AFR |
| AddLayer |
Add a layer to the FeatureCAM document |
| AddLine2Points |
Create a line using 2 points |
| AddLinearMove |
Add a toolpath linear move from the current tool location to the new x,y,z location. The A,B angle arguments are for 4-axis and 5-axis machines |
| AddLinearMove2 |
Same as AddLinearMove but with the option to apply the linear move to simulation only. If sim_only is set to True then no actual toolpath will be generated for this move |
| AddLinearPattern |
Create a linear pattern of the feature specified in the first argument |
| AddLoadModuleForTest |
This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| AddMF |
Make a new multiple fixture document. The new document window will open up in FeatureCAM |
| AddMill |
Add a milling operation to the feature |
| AddModel |
Add the given model to the folder |
| AddModel |
Add a model using an SCL command |
| AddModel |
Add a model object to this FeatureCAM layer |
| AddPocket |
Create pocket feature |
| 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 |
| AddPoint |
Add a new point to the Point list table. By default FeatureCAM will insert the new point to the end of the list. The argument insert_at specifies where in the table the point will be added. The first row in the table has an index of 0 |
| AddPointListPattern |
Create a point list pattern of the feature specified in the first argument |
| AddPointProjectedToSurface |
Create a new point that is the result of projecting the given point onto the given surface |
| AddPointsFromCurve |
Generate a set of points based on the given curve and add the new points to the end of the Point list table |
| AddPostedText |
Add text that will appear in the posted NC code when the operation is executed. The CNC post file has to be formatted to print UDF text |
| AddProcessOper |
Add a milling operation of type tagFMSurfaceMillProcessType. Set isRough to True to create a rough pass |
| AddProfileFace |
Create a face feature from a curve |
| AddProfileGroove |
Create a groove feature from a curve |
| AddProfileTurnGroove |
Create a turned groove feature from a curve |
| AddPt |
Add a point to the list |
| AddPtRelative |
Add a point that's an offset from the last point in the list |
| AddRadialPattern |
Create a radial pattern of the feature specified in the first argument |
| AddRapidMove |
Add a toolpath rapid move from the current tool location to the new x,y,z location. The A,B angle arguments are for 4-axis and 5-axis machines |
| AddRapidMove2 |
Same as AddRapidMove but with the option to apply the rapid move to simulation only. If sim_only is set to True then no actual toolpath will be generated for this move |
| AddReam |
Add a ream operation to the feature |
| AddReam2 |
Add a ream operation to the feature |
| AddRectPattern |
Create a rectangular pattern of the feature specified in the first argument |
| AddSelected |
Add the selected object in the FeatureCAM document to the folder. If there is only 1 object selected, it will be added as a single model. If there are more than 1 objects selected, they will be added as a stream |
| AddSetup |
Add a setup to the FeatureCAM document |
| AddSide |
Create a side feature |
| AddSolidCombine |
Combine two solids into a single solid |
| AddSolidCube |
Create a solid cube. (x1,y1,z1) are the lower left coordinates of the solid cube |
| AddSolidExtrude |
Create an extruded solid using either an extrude curve or surface. Specify the vector of the extrusion. If the solid type is eNST_AsBase then the argument solidToCutOrAdd is ignored |
| AddSolidLofted |
Create a lofted solid from a series of curves. Specify if this is a closed lofted solid. If the solid type is eNST_AsBase then the argument solidToCutOrAdd is ignored |
| AddSolidOffset |
Create a solid offset by offseting the faces of the specified solid |
| AddSolidRevolve |
Create a revolved solid by revolving a curve around an axis. If the axis type is eSRAT_CustomLine then specify custom_line |
| AddSolidStock |
Create a base solid from stock dimensions |
| AddSolidSweep |
Create a swept solid. Specify the curve and axis of sweeping. The axis must be a planar curve. If the solid type is eNST_AsBase then the argument solidToCutOrAdd is ignored |
| AddSplineCurveFromPtList |
Generate a spline curve from the list of points |
| AddSpotDrill |
Add a spot drill operation to the feature. Pass the full depth and diameter of the hole. The operation takes care of everything else. Set the eAID_SpotDepth attribute on the feature if you want to control the depth of the spot drill operation |
| AddSpotDrill2 |
Add a spot drill operation to the feature. Pass the full depth and diameter of the hole. The operation takes care of everything else. Set the eAID_SpotDepth attribute on the feature if you want to control the depth of the spot drill operation |
| AddSubspindle |
Create a subspindle feature |
| AddSurfaceMill |
Create a surface milling feature |
| AddTap |
Add a tap operation to the feature |
| AddTap2 |
Add a tap operation to the feature |
| AddTextDimension |
Create a text label |
| AddThreadMill |
Add a thread milling operation to the feature |
| AddThreadMilling |
Create a thread mill feature |
| AddThreadMillingStd |
Create a thread mill feature from a standard thread. Specify the name of the standard thread in the argument threadName |
| AddThreadMillStd |
Add a thread milling operation to the feature |
| AddToAllFaces |
Add a fixture to all the faces of the tombstone |
| AddTool |
Add the given tool to the tool crib |
| AddToolCrib |
Add a new empty tool crib. To save the new crib, first add tools to the crib by calling the AddTool method from the FMToolCrib class then call SaveCrib |
| AddTools |
Add the given tool collection to the tool crib |
| AddToSingleFace |
Add a fixture object to the tombstone face specified by angleOfFace |
| AddTSF |
Make a new tombstone document. The document window will open up in FeatureCAM |
| AddTurn |
Create a turn feature |
| AddTurnFace |
Create a turned face feature |
| AddTurnHole |
Create a turned hole feature |
| AddTurnThreadMove |
Add a toolpath turn thread move from the current tool location to the new x,z location |
| AddUCS |
Add a UCS to the FeatureCAM document |
| AddUserDefinedFeature |
Create a user defined feature |
| AddUserOperation |
Add a user defined operation to the feature |
| AddValue |
Add a Value object |
| AddWireEDM |
Create a wire EDM feature |
| AFR |
Automatic feature recognition |
| AFRBeforeCreateFlags |
Set the flags to indicate that this feature requires more work on it after it is created as a FeatureCAM object |
| Align |
Align the UCS using one of the alignment types defined by tagFMUcsAlignType |
| 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. |
| BoundingBox |
Returns the minimum and maximum coordinates of the bounding box for the object. The coordinates are aligned to coordinate_system. If empty, the coordinates are then aligned to FeatureCAM's World or Stock coordinate system |
| CalculatedDrillDiameter |
Calculate the drill diameter of the tap tool using FeatureCAM's formulas |
| CallSimEvents |
method CallSimEvents |
| Close |
Close all the documents in FeatureCAM |
| Close |
Close with the option of saving first |
| Copy |
Make a copy of the control and place it on the target toolbar |
| CopyAttributes |
Copy attributes from the model to the specified target_model in the FeatureCAM document |
| CopyConfiguration |
Copy attributes from the given source configuration to the current configuration object |
| CopyPartLibraryAttributes |
Copy the attributes of the feature from the part library |
| CopyTool |
Create a copy of the tool and give it the name newName |
| CreateAnnotationText |
Called when an annotaion text object is created. The annotated text object can be modifed through the argument text |
| CreateCurvePtList |
Create an empty FMCurvePtList object |
| DefaultConfiguration |
Copy attributes from the default FeatureCAM configuration to the current configuration object |
| Delete |
Delete this object with the option of invalidating the toolpaths |
| Delete |
Delete this object |
| DeleteMaterial |
Delete all feed/speed and cutting data values for the material with the given name. This will remove the material from the database |
| DeleteProcessOper |
Delete a milling operation where order is the operation line number in the Surface Milling Properties dialog. The first operation has an order of 1 |
| DeleteTool |
Delete the tool from the tool crib |
| DelPoint |
Delete the point whichPoint from the Point list table. The point cannot be deleted if it is the only point in the Point list table |
| DisplayFeatureProperty |
|
| DistanceFromPt |
Return the shortest distance from the point to the curve |
| 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 |
| DoSomething |
method DoSomething |
| DrillFeedSpeed |
Return the feed and speed values for the operation. This method is valid only for drilling operations |
| Edit |
This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| Execute |
Execute the FeatureCAM command associated with the control |
| Exit |
Exit and shutdown FeatureCAM |
| Export |
Export a file of type tagFMImportType |
| Export |
This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| Export |
Export the configuration to a .cdb file. The file name must include the complete path of where the .cdb file will be saved. If the argument overwrite_file is True and the filename already exists, FeatureCAM will overwrite the existing file |
| FindControl |
Find a specific control in the toolbars. Type argument isn't used. The argument ID is the button ID or the name of the button. Set the argument Visible to True to search only the toolbar buttons that are visible |
| FindFile |
Show the Open dialog box allowing the user to choose a file to open. True is returned if the file opens successfully |
| Finished |
Removes the progress bar |
| GetAngles |
Get the start and end angles of this revolved solid design feature |
| GetArg |
Get the value of a specific dimension in the user defined feature. The dimensions of the feature are numbered starting with 0 and are sorted in the order that they were added to the feature |
| GetArgDefinition |
Get the name and data type of the dimension whose order number is specified by the argument which |
| GetArgument |
Get the data of an attribute for the operation specified by the argument which. The operation arguments are numbered starting with 0 |
| GetAttributeDefinition |
Get the data of the operation attribute specified by the argument which. The operation attributes are numbered starting with 0 |
| GetAxis |
Get the axis line that the curve revolves around |
| GetCenter |
The x,y,z location of the center point of the operation |
| GetCurves |
Get the series of curves that make up this lofted solid design feature |
| GetCutLength |
The cut length of the wire EDM operation. |
| GetData |
Get the data of the feature attribute specified by the argument which. The feature attributes are numbered starting with 0 |
| GetDataDefinition |
Get the data of the feature attribute specified by the argument which. The feature attributes are numbered starting with 0 |
| GetDimensions |
Get the coordinates of the corners for this solid design feature. (x1,y1,z1) are the lower left coordinates of the solid cube |
| GetDimensions |
Get the dimensions of the stock |
| GetDirection |
Get the coordinates of the direction vector |
| GetDistance |
Get the the vector of the extrude |
| GetEndPoint |
Get the end point of the wire EDM feature. The indexes start at 0 |
| GetEndpoints |
Get the start and end points of the curve |
| GetEndpoints |
This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| GetEndpoints |
Get the start and end points of the circle. Endpoints do not exist for a full circle |
| GetEndpoints |
Get the start and end points of the line. The argument is_clipped is False if the point is infinite |
| GetEndpoints2 |
Get the start and end points of the line. The argment is_clipped is False if the point is infinite |
| GetFeatureLocation |
Get the location of the feature |
| GetFeatureType |
Get the type of the feature. Feature types are identified by eFMAttributeFeatureType |
| GetInfoForA1ToolCopy |
This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| GetLastPt |
Get the last X,Y,Z point that was added to the list |
| GetLayerVisible |
True if the layer vLayer is visible |
| GetLine |
Get a specific line string from the results window. Line numbers start at 0 |
| GetLocation |
Get the x,y,z location of the object |
| GetMachineSimLocation |
Get the machine simulation location |
| GetMillPostOptions |
Get the post options for Milling |
| GetMillPostOptions2 |
Get the post options for Milling |
| GetNormal |
Get the normal of the circle |
| 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 |
| GetOperationType |
Return the type of operation and the type of feature that the operation is assigned to. For operation and feature types see tagFMAttributeOperationType and tagFMAttributeFeatureType respectively |
| GetPoint |
Get the X,Y,Z and Angle values for the given point. The argument whichPoint corresponds to the row number in the Point list table starting with 0 |
| GetProcessOperList |
The list of operations used for milling the feature. For each operation it will return the type from tagFMSurfaceMillOperationType, True if it is a rough pass and True if it is excluded/turned off. See the macro SurfaceMillFeatureTest.bas |
| 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 |
| GetSaveNCData |
Get the SaveNC options |
| GetSingleBlockInfo |
Get the information of the Single Block stock configuration. The information is only available if the IsSingleBlock returns True |
| GetStartPoint |
Get the start point of the wire EDM feature. The indexes start at 0 |
| GetStartPoints |
The start points of the wire EDM operation. For 2-axis, a point for each curve. For 4-axis, upper point and then lower |
| GetTurnPostOptions |
Get the post options for Turning |
| GetVariableTaper |
Get the variable taper of the wire EDM feature. The indexes start at 0 |
| GetVectors |
Get the X, Y and Z vectors for the UCS using the stock coordinate system |
| GetWirePostOptions |
Get the post options for Wire EDM |
| Help |
Display the help topic specified by the argument HelpContextId in the help file HelpFile |
| Hide |
Hide all objects of type tagFMShowHideType |
| 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 |
| Import |
Import the configuration file into FeatureCAM. The file name must include the complete path and have a cdb extension. For example "C:\Data\Configuration1.cdb" |
| Import |
Import a file of type tagFMImportType into FeatureCAM. The file name must include the complete path name for example "C:\Data\Sample.CATPart" |
| Import |
This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| Increment |
Increment the position of the progress bar by 1 |
| 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 |
| isMetric |
Returns True if the units of the post is Metric |
| IsPlanar |
Return True if the object is planar |
| Item |
Return the nth document in the collection |
| Item |
Return the nth object in the collection |
| Item |
Return the nth operation in the collection |
| Item |
The nth tool holder in the collection |
| Item |
The nth tool in the collection |
| Item |
Return the nth FMGeom object in the collection |
| Item |
Return the nth setup in the collection |
| Item |
Return the nth UCS in the collection |
| Item |
The nth layer in the collection |
| Item |
Return the nth object in the collection where the index starts at 1 |
| Item |
Return the nth setup in the collection |
| Item |
Return the nth setup in the collection |
| Item |
Return the nth fixture object in the collection |
| Item |
The nth toolbar in the collection |
| Item |
The nth control in the collection |
| Item |
The nth configuration in the collection |
| Item |
Return the nth crib in the collection |
| Item |
The nth entry in the tool mapping dialog |
| Item |
Return the nth window in the collectiong for example "FM1:1" |
| LoadCNC |
Load a CNC file |
| LoadedParts |
Returns the complete path name and total number of the .fm files being used in the multiple fixture document. These files are listd under Parts List in the Multiple Fixtures dialog |
| LoadedSetups |
Returns the name of all the setups in the specified .fm file. The file name must include the complete path name for example "C:\Data\FM1.fm" |
| LoadPart |
Load a part into the multiple fixture document. Specify the complete path name of the .fm file |
| Location |
The fixture offset location on the tombstone. XOffset is distance from the right edge, YOffset is distnace from the top edge, and Zoffset is distance from tombstone face |
| MakeCurveFromModel |
Create a curve from the given model object |
| MakeLine2Points |
Create a line using 2 points |
| MakeTempCurve |
This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| MapSetupToWorld |
Convert the given X,Y,Z points from setup coordinates to world coordinates |
| MapWorldToSetup |
Convert the given X,T,Z points from world coordiantes to setup coordinates |
| MillFeedSpeed |
Return the feed and speed values for the operation. This method is valid only for milling operations |
| 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 |
| Move |
Move the control from the current toolbar to the target toolbar |
| MoveTool |
Called when the simulation is about to move the tool, giving the handler the opportunity to provide alternative movements |
| NewWindow |
Create a new document window |
| OnConnect |
Called when an Addin is loaded. This can be used so that toolbar buttons can be created for example |
| OnConnect |
|
| OnDisConnect |
Called when an Addin is unloaded. This can be used so that toolbar buttons can be removed for example |
| Open |
Open the document specified by the argument filename |
| OverrideFeed |
Override the feed rate for the operation |
| OverrideSpeed |
Override the speed rate for the operation |
| OverrideTool |
Override the tool for the operation |
| PartCompareReset |
Reset the Part Compare simulation options to default values |
| Paste |
Paste the model into the ActiveDocument. The reference location and offset location can be set |
| Post |
Display the NC code in the Results window |
| PostNCCreate |
Called when posting is done, giving the handler the opportunity to change the NC code |
| 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 |
| 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 |
| ReorderProcessOper |
Change the order of operations by moving the operation with the order of old_order up/down the list and places it at the order of new_order |
| reset |
Reset the values of the object to their default values |
| ResetCutSides |
Reset the machining side of all surfaces to the FeatureCAM defaults |
| ReSize |
This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| reverse |
Reverse the direction of the curve |
| RevolveCurveEndsOnAxis |
True if revolve curve ends on axis |
| RunTestMacro |
internal use only |
| Save |
Save the document |
| SaveAs |
Save the document under a new name |
| SaveCrib |
Save the tool crib |
| 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 |
| SavePreviewPictureAsFile |
Save the preview picture for the FeatureCAM document as a PNG image file. The complete path name should be specified, for example "C:\MyPictures\preview.png". File name extenstions other than PNG will be ignored |
| 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 |
| SaveViewAsFile |
Save the current view as a .png image file. If the complete path name of the file is not specified, FeatureCAM will store the image in the same location that the macro is saved in |
| Select |
Select or deselect a model |
| Select |
Select or deselect this object |
| SelectLine |
Select a specific line in the results window. The selected line will be highlighted |
| SetAngle |
Set the angle of rotation for the first feature in the pattern |
| SetAngles |
Set the start and end angles of this revolved solid design feature |
| SetArg |
Set the value of a specific dimension in the user defined feature. The argument which indicates the order number of the dimension. The dimensions of the feature are numbered starting with 0 and are sorted in the order that they were added to the feature |
| 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 |
| SetAxis |
Set the axis line that the curve revolves around |
| SetAxis |
Set the axis curve that the sweep follows |
| SetBottomRadius |
Set the bottom radius of the feature |
| SetCenter |
Set the coordinates of the center point |
| SetCenter |
Set the coordinates of the center point |
| SetChamfer |
Set the chamfer of the feature |
| SetCheckSurfaces |
Set the boundary surfaces that will be avoided during milling |
| SetClosed |
Set to true to close the lofted solid by connecting the first and last curves |
| SetCrossSectionCurve |
Set the curve that defines the shape of the wall of the boss feature |
| SetCurve |
The curve that defines the shape of the extrude. The curve must be planar |
| SetCurveAtBottom |
Set to True to place the curve at the bottom of the groove feature |
| SetCurves |
Set the series of curves that make up this lofted solid design feature. A minimum of 2 curves is requried |
| SetCutSide |
Set the side of the curve that will be cut |
| SetCutSide |
Set the side of the surface that will be cut |
| SetDepth |
Set the depth of the feature |
| SetDiameter |
Set the diameter of the thread mill feature |
| SetDimensions |
Set the coordinates of the corners for this solid design feature. (x1,y1,z1) are the lower left coordiantes of the solid cube |
| SetDimensions |
Set the dimensions of the stock. |
| SetDistance |
Set the the vector of the extrude |
| SetDraftAngle |
Set the draft angle of the feature |
| SetDraftAngle |
Set the draft angle for the walls of the surface |
| SetEnabled |
Set to True to activate the setup |
| SetEndPoint |
Set the end point of the wire EDM feature. The indexes start at 0 |
| SetEndpoints |
Set the start and end points of the line |
| SetEndpoints |
This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| SetEndpoints |
Set the start and end points of the line. Set the argument clip_pt to False to make the point infinite |
| SetFeatureLocation |
Set the location of the feature |
| SetFeedDirection |
Set the direction of tool movement on the feature. True will set the direction to Positive and False will set the direction to Negative |
| SetFinishTolerance |
Set the finish tolerance |
| SetFixtureID |
The fixture ID of the setup |
| SetFixtureID |
Set the Fixture ID for the setup |
| SetFlipSides |
Set to True to check the Flip side to Cut checkbox which will reverse the side of the curve the cut is on |
| SetGrooveAngle |
Set the angle of orientation of the feature |
| SetHeight |
Set the height of the boss feature |
| SetID |
Set the argument ID to True or 1 if the turned groove feature is an inner diameter groove |
| SetIDOD |
Set to True to make the groove feature an ID/OD groove |
| SetInitialAngle |
Set the angle of rotation for the first feature in the pattern |
| SetInnerDiameter |
Set the inner diameter of the feature |
| SetIslands |
Set the curve(s) that define the region of the pocket feature to avoid |
| SetIsLeftHand |
Set the direction of the thread. True for a left hand thread |
| SetIsODThread |
Set the type of thread. True for an outer diameter thread |
| SetLayerVisible |
True if the layer vLayer is visible |
| SetLeftAngle |
Set the left wall angle of the feature |
| SetLeftChamfer |
Set the left chamfer of the feature |
| SetLeftRadius |
Set the left bottom radius of the feature |
| SetLocalOffset |
Set to True to check the local offset checkbox in the pattern properties dialog |
| SetLocation |
Set the x,y,z location of the object |
| SetLocation |
Set the x,y,z location of the object |
| SetLocation |
Set the x,y,z location of the object |
| SetLocation |
Set the x,y,z location of the object |
| SetMachineSimLocation |
Set the machine simulation location |
| SetMatchPoints |
Set the match point(s) of the wire EDM feature. The indexes start at 0 |
| SetMillPostOptions |
Set the post options for Milling |
| SetMillPostOptions2 |
Set the post options for Milling |
| SetNumber |
Set the number of features in the pattern |
| SetObject |
Set the feature to repeat in the pattern |
| SetOffset |
Set the offset distance. A negative distance will offset the faces into the solid |
| SetOrder |
The order of the setup in the process plan |
| SetOuterDiameter |
Set the outer diameter of the feature |
| SetPartDominant |
Set to True to make the multiple fixture document be part dominant |
| SetPartSurfaces |
Set the surfaces of the feature that will be milled |
| SetPitch |
Set the pitch of the thread mill feature |
| SetPoint |
Overwrite the specific point whichPoint with the new values. The argument whichPoint corresponds to the row number in the Point list table starting with 0 |
| SetPreviewPicture |
Set the current contents of the FeatureCAM graphics window as the preview picture for the FeatureCAM document. This image will be used when previewing the file in the Open File dialog and will be used until it is set again |
| SetProfileCurve |
Set the curve that defines the shape of the feature |
| SetProfileCurves |
This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| SetProfileCurves2 |
Set the curves that define the shape of the boss feature. Set ordered to True to tell FeatureCAM to cut the curves during the finish pass in the order that they were added to the boss feature |
| SetRelativePosition |
Set to True to check the Relative Position checkbox in the pattern properties dialog |
| SetRightAngle |
Set the right wall angle of the feature |
| SetRightChamfer |
Set the right chamfer of the feature |
| SetRightRadius |
Set the right bottom radius of the feature |
| SetRoughTolerance |
Set the rough tolerance |
| SetRowNumber |
Set the number of rows of features in the pattern |
| SetRowSpacing |
Set the space between the rows in the pattern |
| SetSetupName |
Set the name of the setup |
| SetSimple |
Set to True to cut the groove feature with a single pass along the curve |
| SetSingleBlockInfo |
Set the information for the Single Block stock configuration. The information can be set only if IsSingleBlock returns True |
| SetSolidType |
Set the type of this solid design feature. See tagFMNewSolidType |
| SetSpacing |
Set the space between the features in the pattern |
| SetSpacingAngle |
Set the space in angles between the features in the pattern |
| SetStandardThread |
Get the thread dimensions from a standard thread. Specify the name and type of thread from which the dimensions will be copied |
| SetStartPoint |
Set the start point of the wire EDM feature. The indexes start at 0 |
| SetStartPoint |
Set the starting point of the curve |
| SetStockCurve |
Set the curve that defines the shape of the stock. The default is set to stock boundary |
| SetSweepFromOtherEnd |
Set to true to check the 'Sweep from other end' checkbox in the Swept Solid dialog |
| SetTaperAngle |
Set the taper angle of the feature. For a Thread Milling feature this option is available if FMThreadMilling.Tapered is True |
| SetTaperMode |
Set the taper mode of the wire EDM feature |
| SetTaperRegister |
Set the taper register of the wire EDM feature |
| SetTaperType |
Set the taper type of the wire EDM feature |
| SetThickness |
Set the thickness of the feature |
| SetThreadHeight |
Set the thread height of the thread mill feature |
| SetThreadLength |
Set the thread length of the thread mill feature |
| SetThrough |
Set to True to model the groove feature with a bottom |
| SetTurnPostOptions |
Set the post options for Turning |
| SetupActivate |
Called when a setup is activated |
| SetUserAttribute |
Set the user defined attribute on the feature using the name of the attribute |
| SetVariableTaper |
Set the variable taper of the wire EDM feature. The indexes start at 0 |
| SetVectors |
Set the X, Y and Z vectors for the UCS using the stock coordinate system |
| 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 |
| SetWidth |
Set the width of the feature |
| SetWirePostOptions |
Set the post options for Wire EDM |
| ShadedReset |
Reset the 2D/3D Shaded simulation options to default values |
| ShadeSelected |
Shade the selected models |
| 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 |
| Show |
Show all objects of type tagFMShowHideType |
| ShowNormalsSelected |
Display the normals for the selected surfaces in the model |
| ShowProgressBar |
Display the progress bar |
| 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 |
| Sim3DNoUpdate |
Run the 3D simulation but do not pause on gouge or show the toolpath during simulation. For description on SimID see MFGDocument.Sim3D |
| SimCommand |
This property/method is no longer in use. FeatureCAM will continue to recognize and run older macros that use this property/method |
| SimCutMove |
Simulate a cut move |
| SimCutRotate |
Simulate a rotational cut move |
| SimIgnoreClashes |
Either ignore all clashes or restore clash detection in machine simulation |
| SimInit |
Initialize machine simulation |
| SimMachine |
Run the full machine shaded simulation |
| SimPerformCut |
Perform the simulation cut |
| SimRapidcut |
Run the RapidCut Solid simulation |
| SimRotate |
Rotate a solid without cutting in machine simulation |
| SimSetPosition |
Set the simulation position |
| SimSetVisibility |
Set the a solid's visibility in machine 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 |
| SimulationGougeDetected |
Called when a simulation gouge is detected |
| SimUpdateGraphics |
Update the simulation graphics |
| SmoothReduce |
Smooth the curve using the approximation method specified by the type argument. The third argument splineDegree is ignored if the type argument is set to eCSRT_ArcLineApprox |
| SmoothReduce |
Smooth the curve using the approximation method specified by the type argument. The third argument splineDegree is ignored if the type argument is set to eCSRT_ArcLineApprox |
| SortPoints |
Sort the points in the Point list table using the sorting method sortType. See tagFMPointListSortType for a list of sorting types |
| spindle |
Animate a spindle action during machine simulation |
| StockMaterialChanged |
Called when the stock material has been changed |
| TapFeedSpeed |
Return the feed and speed values for the operation. This method is valid only for tapping operations |
| ThreadMillFeedSpeed |
Return the feed and speed values for the operation. This method is valid only for thread milling operations |
| ToolChange |
Animate a tool change during machine simulation |
| TurnFeedSpeed |
Return the feed and speed values for the operation. This method is valid only for turn type operations |
| Undo |
Undo last action. Can be called multiple times to undo more than one action |
| 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 |
| UnShadeAll |
Unshade all the models |
| UnShadeSelected |
Unshade the selected models |
| UnShowNormalsSelected |
Hide the normals for the selected surfaces in the model |
| Update |
Modify the attributes and dimensions of the hole feature. If an argument is left empty, then the current value of that dimension will remain the same. Using this method is the only way that the dimensions of an existing hole feature can be changed |
| Update |
Modify the attributes and dimensions of the bar feed feature. If an argument is left empty, then the current value of that dimension will remain the same. Using this method is the only way that the dimensions of an existing bar feed feature can be 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 |
| ValidateHoleDimensions |
Check that the given dimensions are valid for a hole of type tagFMHoleType. Return an error if the values are invalid |
| WireReset |
Reset the Wire simulation options to default values |
| 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) |
| 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 |