"NETHook3_0" Create an empty transform project operation Create an empty transform project operation. Final processing. Parameters. The selected entities plus edges. The selected curves. The selected drafting. The selected points. The selected surfaces. The selected meshes. The plane location. The plane view. True if it succeeds, false if it fails. Gets the chains. Null if it fails, else the chains. Free ma meshes. Free all data. Free ma surfaces. Free curve data. Free chains. Loads MA meshes. the selected meshes. Loads MA surfaces. The selected surfaces. Default constructor. Destructor. Loads MA curves. Parameters. The selected eptrs. A projection operation interface. Default constructor. A transform project parameters. Values that represent what format to output projection data. Values that represent how the projection geometry will be created. Values that represent project direction. Values that represent how to project. Create an empty transform roll operation Create an empty transform roll operation. Sets the chains. [in,out] If non-null, the new chains. Sets associated points. [in,out] The first point. [in,out] The second point. True if it succeeds, false if it fails. Sets an alignment. [in,out] The first wpt. [in,out] The second wpt. True if it succeeds, false if it fails. Sets an arc. [in,out] The arc. Sets a level. The level. Sets a color. The color. Sets the parameters. Pointer to the parameters. User is reponsible for any memory deletion Adds completed operation entitys to database. True if it succeeds, false if it fails. A transform roll operation. Constructor. (Optional) True for metric values. A transform roll parameters. Values that represent the roll direction. Values that represent what type of geometry to create. Values that represent how the resulting transform is positioned. Values that represent how the rotation axis is defined. Values that represent the type of transform. Values that represent if the original is a copied or moved. Calls Mastercam help with the given htmlHelpUrl. The Mastercam help url to open. Calls Mastercam help for the given dialog or control. The Mastercam help system component file to open The control or dialog ID that help is being called from. Calls Mastercam help for the given dialog or control. The index of the Mastercam help system component file to open. The control or dialog ID that help is being called from. Initializes a new instance of the HelpManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used to manage the running and execution of external apps. Initializes this object with the given ID. The ID of the operation entity to look up in the Mastercam database. Thrown if the operation ID is not found within the Mastercam Database. XYZ polar coordinates, for the polar type translations method Destination view number at time of creation Destination view origin Destination view matrix Source view number at time of creation Source origin Source matrix Determines if source view is used or not Options in Instances box in UI: 0 = Distance Between, 1 = Total Distance True to zigzag toolpath array PolarData[0] = polar distance, PolarData[1] = angle (degrees) To point, for point to point operations (TranslateMethod.BetweenPoints). From point, for point to point operations (TranslateMethod.BetweenPoints). Distance to move during rectangular translation in X and Y number of steps in X and Y Translates coordinates to Destination Matrix 17-rect, 18-polar, 19-between pts, 20-between views This method commits the current Transformation Operation's settings to the Mastercam database. True if the database commit was successful, else false if not. Initializes a new instance of the TranslateOperation class. The ID of the operation entity to look up in the Mastercam database. Thrown if the operation ID is not found within the Mastercam Database. Constructor. Identifier for the operation. Default constructor. Default constructor. Enum representing method of translation operation. A translate type transform operation. Find all holes on body. Will search for non-feature holes. The body of the solid to search. The options to use in the search. The collection of holes. Gets all holes that are defined as such from the feature tree. the solid geometry. Index in solid tree. If zero, will return all holes The collection of hole(s) in a map Re-find the exit point of the hole(s) using current body geometry Re-find the entry point of the hole(s) using current body geometry Filter on size of hole. Detect holes that not strictly "holes", but are "hole-like" (on sheet bodies etc.) Detect holes that only have a partial boundary. How we will detect the holes. Align through holes to be positively aligned with this direction. Options structure for GetHoles API. Initializes a new instance of the HoleManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. Gets or sets the location of the ending point for drawing this cylinder primitive solid as an angle, in degrees, from the base point. Gets or sets the location of the starting point for drawing this cylinder primitive solid as an angle, in degrees, from the base point. Gets or sets the height of the cylinder, from the base point (specifically, the base point's Y value) to the top of the cylinder. Gets or sets the distance of the outer edge of the cylinder from this cylinder primitive solid's base point. Initializes a new instance of the CylinderSolid class. This constructs a new cylindrical solid object with default parameters. The default parameters of a sphere solid are for a full (360 degree) sphere with the center at the WCS origin, (0.0, 0.0, 0.0), with a radius of 0.5, and with a height of 1.0. Loads the default values for a given solid geometry object. Loads the default values for a given solid geometry object from the solid geometry entity passed in. [in,out] The geometry entity to use as defaults for this solid geometry object. Commits a solid geometry entity to the Mastercam database. [in,out] The solid geometry entity to be committed. [in,out] The solid parameters to initialize the object with. True if the commit was successful; false if not. Initializes a new instance of the CylinderSolid class. Attempts to retrieve a solid geometry entity with the given ID from the Mastercam database and use that to initialize this solid geometry object. If no matching solid geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the solid geometry entity to look up in the Mastercam database. This class is used for working with cylinder shaped primitive solids. This method commits a TaperFormBarrel Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the TaperFormBarrelMillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the TaperFormBarrelMillTool class. Initializes a new instance of the TaperFormBarrelMillTool class. The identifier. This class is for modifying and using TaperFormBarrel Mill tools in Mastercam. This method commits a OvalFormBarrel Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the OvalFormBarrelMill class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the OvalFormBarrelMillTool class. Initializes a new instance of the OvalFormBarrelMillTool class. The identifier. This class is for modifying and using OvalFormBarrel Mill tools in Mastercam. This method commits a LensFormBarrel Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the LensFormBarrelMillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the LensFormBarrelMillTool class. Initializes a new instance of the LensFormBarrelMillTool class. The identifier. This class is for modifying and using LensFormBarrel Mill tools in Mastercam. This method commits a LensBarrel Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the LensBarrelMillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the LensBarrelMillTool class. Initializes a new instance of the LensBarrelMillTool class. The identifier. This class is for modifying and using LensBarrel Mill tools in Mastercam. Range check incoming RGB values (Must be 0-255). The value to be checked. A value guaranteed to be within the valid range. This is a static inequality operator overload for the purposes of comparing these color objects. This is the first mask to compare. This is the second mask to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these color objects. This is the first mask to compare. This is the second mask to compare. True if the two objects are considered equal. This is a static equality method for the purposes of comparing MastercamColor objects. This is the first color to compare. This is the second color to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. Convert this object into a string representation. A text string that represents this object's value. Updates the Mastercam color map described by colors in the supplied collection. The Key is the color index number and the Value is the Color to assign. A collection of Mastercam colors. Updates the Mastercam color map described by the colors in the supplied collection. The Key is the color index number and the Value is the Color to assign. A collection of .NET colors. Gets color RGB of the specified Mastercam color number. The color number index (0-255). [out] A Mastercam color object containing the RGB values. true if it succeeds, false if it fails (the color number was not in range). Gets color RGB of the specified Mastercam color number. Deprecated. Please use the class. The color number index (0-255). The color data, else null if the colorNumber was not in range. Initializes a new MastercamColor from a .NET Color RGB values . The Color used to initialize the RGB values. Gets or sets the Blue component of the color. Gets or sets the Green component of the color. Gets or sets the Red component of the color. A Mastercam RGB color. This class has been deprecated, Please use the class. This method adds a specified sheet object to the current file object. The new nesting sheet object to add to the file. This method adds a specified part object to the current file object. The new nesting part object to add to the file. Gets or sets the array of nesting part objects associated with this file. An Array of parts. Gets or sets the array of nesting sheet objects associated with this file. An Array of sheets. This saves the current nesting file to the path and name specified by the FilePath member variable. True if the file was created and written successfully, else false if not. Thrown if this nesting file object does not have a valid filename and path when this commit attempt is made. This takes a new file name and path and saves the current nesting file to a file at that location and with that name. The file name and path of the new file to output these nesting settings to. True if the file was created and written successfully, else false if not. Initializes a new instance of the NestingFile class. This initializes a default nesting file with no parts or sheets, a null FilePath string, and a default set of nesting parameters. Parameterized Constructor. Takes a path and file name of a nesting file and attempts to construct a NestingFile object based on that file's settings. The construction process will add any parts or sheets read in from the specified as NestingPart and NestingSheet objects to their respective arrays. The nesting file's full path and name with which to construct this NestingFile object. Thrown if an data value is found in the nesting file that doesn't correspond to the appropriate type in it's internal nesting data entry. Gets or sets the path and name of the nesting file object. So long as this is a null string or represents an invalid path, trying to commit changes to the nesting file will result in exceptions. Gets or sets this file's list of nesting parameters. This method loads defaults for this object. This method takes a file stream and reads in all of it's data, loading it into it's sections data. The stream to read nesting section data from. True if the nesting file was read successfully, false if not. The array holding all of the excess strings found out of either of those sections. The array holding all of the part section objects. The array holding all of the sheet section objects. This class is used for working with Mastercam Nesting files. Initializes this object with the given ID. The ID of the operation entity to look up in the Mastercam database. Thrown if the operation ID is not found within the Mastercam Database. Include lead in and out in mirror Angle (in degrees) Reference point for X axis, Y axis and Polar Angle Determines if the original starting point or the first entity should be used Reverses toolpathDirection Reverses cutter comp View number at time of creation Mirror view origin Mirror view matrix Mirror axis end pts in world coords Translates coordinates to Mirror Plane Whether mirroring on X or Y axis or Polar angle etc, check enum This method commits the current Transformation Operation's settings to the Mastercam database. True if the database commit was successful, else false if not. Initializes a new instance of the MirrorOperation class. The ID of the operation entity to look up in the Mastercam database. Thrown if the operation ID is not found within the Mastercam Database. Default constructor. Enum for Mirror Operation Type. A mirror type transform operation. This method takes the ID of a nesting sheet, tries to find the operation in the database matching that sheet ID, and returns a NestingOperation object representing that operation in the database. This is the ID of the sheet to look for in the database. A NestingOperation object if the operation was found in the database, else a null object if not. This method makes a bitmap image file of the specified sheet within the currently opened Mastercam part file. The name and path of the bitmap file to create. This needs to be the number of the sheet to create a bitmap image of. True if the bitmap file was created successfully, else false if not. This method returns the number of nested sheets in the currently opened Mastercam part file. The number of nested sheets in the current file. Initializes a new instance of the NestingManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used to manage nesting settings within the Mastercam environment. Loads the default values for a given surface geometry object from the geometry entity passed in. [in,out] The surface geometry entity to use as defaults for this surface geometry object. Commits a surface geometry entity to the Mastercam database. [in,out] The surface geometry entity to be committed. True if the commit was successful; false if not. Initializes a new instance of the TrimmedSurface class. Attempts to retrieve a surface geometry entity with the given ID from the Mastercam database and use that to initialize this surface geometry object. If no matching geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the surface geometry entity to look up in the Mastercam database. This class is used for working with trimmed surfaces within Mastercam. Due to the complex nature of working with trimmed surfaces, the internal data of a trimmed surface is unavailable in this version of the NET-Hook API. Executes the .NET script file. The (full path) script file. true if it succeeds, false if it fails. Query if a file is .NET script file. This is a simple file extension check. Is the file extension? .csx or .vbx The script file name. true if it is, false if not. Gets the Categories property. This is based off of the concepts in Ribbon Customization Dialog. Inserts a third party ribbon tab as described by ribbonXml. The XML that defines the Tab and its contents. True if it succeeds, false if it fails. Static constructor. A class for the creation of a custom Tab in the Mastercam Ribbon. The backing field for the Selection property. The backing field for the AddIns property. The backing field for the FileTab property. The backing field for the ToolTabs property. The backing field for the MainTabs property. Gets the Selection Category property. Gets the AddIns Category property. Gets the FileTab Category property. Gets the ToolTabs Category property. Gets the MainTabs Category property. The backing field for the LockInWindowSelection property. The backing field for the LockInVectorSelection property. The backing field for the LockInFreehandSelection property. The backing field for the UnselectAll property. The backing field for the SelectAllEntities property. The backing field for the TemporaryCenterPoint property. The backing field for the StandardSelection property. The backing field for the SingleSelection property. The backing field for the SelectSolidFace property. The backing field for the SelectSolidEdge property. The backing field for the SelectSolidBody property. The backing field for the QuickMaskLevelOnly property. The backing field for the QuickMaskLevelAll property. The backing field for the QuickMaskLevel property. The backing field for the QuickMaskColorOnly property. The backing field for the QuickMaskColorAll property. The backing field for the QuickMaskColor property. The backing field for the QuickMaskWireframeOnly property. The backing field for the QuickMaskWireframeAll property. The backing field for the QuickMaskWireframe property. The backing field for the QuickMaskSurfacesOnly property. The backing field for the QuickMaskSurfacesAll property. The backing field for the QuickMaskSurfaces property. The backing field for the QuickMaskSurfaceCurvesOnly property. The backing field for the QuickMaskSurfaceCurvesAll property. The backing field for the QuickMaskSurfaceCurves property. The backing field for the QuickMaskSplinesOnly property. The backing field for the QuickMaskSplinesAll property. The backing field for the QuickMaskSplines property. The backing field for the QuickMaskSolidsOnly property. The backing field for the QuickMaskSolidsAll property. The backing field for the QuickMaskSolids property. The backing field for the QuickMaskResult property. The backing field for the QuickMaskMeshesOnly property. The backing field for the QuickMaskMeshesAll property. The backing field for the QuickMaskMeshes property. The backing field for the QuickMaskPointsOnly property. The backing field for the QuickMaskPointsAll property. The backing field for the QuickMaskPoints property. The backing field for the QuickMaskLinesOnly property. The backing field for the QuickMaskLinesAll property. The backing field for the QuickMaskLines property. The backing field for the QuickMaskLast property. The backing field for the QuickMaskNamedGroup property. The backing field for the QuickMaskGroup property. The backing field for the QuickMaskDraftingOnly property. The backing field for the QuickMaskDraftingAll property. The backing field for the QuickMaskDrafting property. The backing field for the QuickMaskArcsOnly property. The backing field for the QuickMaskArcsAll property. The backing field for the QuickMaskArcs property. The backing field for the LockInPolygonSelection property. The backing field for the SetMasksForSelectingEntities property. The backing field for the InvertSelection property. The backing field for the EndSelection property. The backing field for the ClearAllMasking property. The backing field for the LockInChainSelection property. The backing field for the LockInAreaSelection property. The backing field for the SelectAllEntitiesByTypeMask property. The backing field for the ActivateSolidSelection property. The backing field for the AutocursorTemporaryMidpoints property. The backing field for the AutocursorTangent property. The backing field for the AutocursorRelative property. The backing field for the AutocursorQuadrant property. The backing field for the AutocursorPoint property. The backing field for the AutocursorPerpendicular property. The backing field for the AutocursorOrigin property. The backing field for the AutocursorNearest property. The backing field for the AutocursorMidpoint2Points property. The backing field for the AutocursorLockQuadrant property. The backing field for the AutocursorLockPoint property. The backing field for the AutocursorLockMidpoint2Points property. The backing field for the AutocursorMidpoint property. The backing field for the AutocursorLockMidpoint property. The backing field for the AutocursorLockIntersection property. The backing field for the AutocursorLockFaceCenter property. The backing field for the AutocursorLockEndpoint property. The backing field for the AutocursorLockArcCenter property. The backing field for the AutocursorIntersection property. The backing field for the AutocursorFaceCenter property. The backing field for the AutocursorEndpoint property. The backing field for the AutocursorSettings property. The backing field for the AutocursorArcCenter property. The backing field for the AutocursorAlong property. Gets the LockInWindowSelection Command property. Gets the LockInVectorSelection Command property. Gets the LockInFreehandSelection Command property. Gets the UnselectAll Command property. Gets the SelectAllEntities Command property. Gets the TemporaryCenterPoint Command property. Gets the StandardSelection Command property. Gets the SingleSelection Command property. Gets the SelectSolidFace Command property. Gets the SelectSolidEdge Command property. Gets the SelectSolidBody Command property. Gets the QuickMaskLevelOnly Command property. Gets the QuickMaskLevelAll Command property. Gets the QuickMaskLevel Command property. Gets the QuickMaskColorOnly Command property. Gets the QuickMaskColorAll Command property. Gets the QuickMaskColor Command property. Gets the QuickMaskWireframeOnly Command property. Gets the QuickMaskWireframeAll Command property. Gets the QuickMaskWireframe Command property. Gets the QuickMaskSurfacesOnly Command property. Gets the QuickMaskSurfacesAll Command property. Gets the QuickMaskSurfaces Command property. Gets the QuickMaskSurfaceCurvesOnly Command property. Gets the QuickMaskSurfaceCurvesAll Command property. Gets the QuickMaskSurfaceCurves Command property. Gets the QuickMaskSplinesOnly Command property. Gets the QuickMaskSplinesAll Command property. Gets the QuickMaskSplines Command property. Gets the QuickMaskSolidsOnly Command property. Gets the QuickMaskSolidsAll Command property. Gets the QuickMaskSolids Command property. Gets the QuickMaskResult Command property. Gets the QuickMaskMeshesOnly Command property. Gets the QuickMaskMeshesAll Command property. Gets the QuickMaskMeshes Command property. Gets the QuickMaskPointsOnly Command property. Gets the QuickMaskPointsAll Command property. Gets the QuickMaskPoints Command property. Gets the QuickMaskLinesOnly Command property. Gets the QuickMaskLinesAll Command property. Gets the QuickMaskLines Command property. Gets the QuickMaskLast Command property. Gets the QuickMaskNamedGroup Command property. Gets the QuickMaskGroup Command property. Gets the QuickMaskDraftingOnly Command property. Gets the QuickMaskDraftingAll Command property. Gets the QuickMaskDrafting Command property. Gets the QuickMaskArcsOnly Command property. Gets the QuickMaskArcsAll Command property. Gets the QuickMaskArcs Command property. Gets the LockInPolygonSelection Command property. Gets the SetMasksForSelectingEntities Command property. Gets the InvertSelection Command property. Gets the EndSelection Command property. Gets the ClearAllMasking Command property. Gets the LockInChainSelection Command property. Gets the LockInAreaSelection Command property. Gets the SelectAllEntitiesByTypeMask Command property. Gets the ActivateSolidSelection Command property. Gets the AutocursorTemporaryMidpoints Command property. Gets the AutocursorTangent Command property. Gets the AutocursorRelative Command property. Gets the AutocursorQuadrant Command property. Gets the AutocursorPoint Command property. Gets the AutocursorPerpendicular Command property. Gets the AutocursorOrigin Command property. Gets the AutocursorNearest Command property. Gets the AutocursorMidpoint2Points Command property. Gets the AutocursorLockQuadrant Command property. Gets the AutocursorLockPoint Command property. Gets the AutocursorLockMidpoint2Points Command property. Gets the AutocursorMidpoint Command property. Gets the AutocursorLockMidpoint Command property. Gets the AutocursorLockIntersection Command property. Gets the AutocursorLockFaceCenter Command property. Gets the AutocursorLockEndpoint Command property. Gets the AutocursorLockArcCenter Command property. Gets the AutocursorIntersection Command property. Gets the AutocursorFaceCenter Command property. Gets the AutocursorEndpoint Command property. Gets the AutocursorSettings Command property. Gets the AutocursorArcCenter Command property. Gets the AutocursorAlong Command property. Default constructor. Represents the LockInWindowSelectionCommand. Default constructor. Represents the LockInVectorSelectionCommand. Default constructor. Represents the LockInFreehandSelectionCommand. Default constructor. Represents the UnselectAllCommand. Default constructor. Represents the SelectAllEntitiesCommand. Default constructor. Represents the TemporaryCenterPointCommand. Default constructor. Represents the StandardSelectionCommand. Default constructor. Represents the SingleSelectionCommand. Default constructor. Represents the SelectSolidFaceCommand. Default constructor. Represents the SelectSolidEdgeCommand. Default constructor. Represents the SelectSolidBodyCommand. Default constructor. Represents the QuickMaskLevelOnlyCommand. Default constructor. Represents the QuickMaskLevelAllCommand. Default constructor. Represents the QuickMaskLevelCommand. Default constructor. Represents the QuickMaskColorOnlyCommand. Default constructor. Represents the QuickMaskColorAllCommand. Default constructor. Represents the QuickMaskColorCommand. Default constructor. Represents the QuickMaskWireframeOnlyCommand. Default constructor. Represents the QuickMaskWireframeAllCommand. Default constructor. Represents the QuickMaskWireframeCommand. Default constructor. Represents the QuickMaskSurfacesOnlyCommand. Default constructor. Represents the QuickMaskSurfacesAllCommand. Default constructor. Represents the QuickMaskSurfacesCommand. Default constructor. Represents the QuickMaskSurfaceCurvesOnlyCommand. Default constructor. Represents the QuickMaskSurfaceCurvesAllCommand. Default constructor. Represents the QuickMaskSurfaceCurvesCommand. Default constructor. Represents the QuickMaskSplinesOnlyCommand. Default constructor. Represents the QuickMaskSplinesAllCommand. Default constructor. Represents the QuickMaskSplinesCommand. Default constructor. Represents the QuickMaskSolidsOnlyCommand. Default constructor. Represents the QuickMaskSolidsAllCommand. Default constructor. Represents the QuickMaskSolidsCommand. Default constructor. Represents the QuickMaskResultCommand. Default constructor. Represents the QuickMaskMeshesOnlyCommand. Default constructor. Represents the QuickMaskMeshesAllCommand. Default constructor. Represents the QuickMaskMeshesCommand. Default constructor. Represents the QuickMaskPointsOnlyCommand. Default constructor. Represents the QuickMaskPointsAllCommand. Default constructor. Represents the QuickMaskPointsCommand. Default constructor. Represents the QuickMaskLinesOnlyCommand. Default constructor. Represents the QuickMaskLinesAllCommand. Default constructor. Represents the QuickMaskLinesCommand. Default constructor. Represents the QuickMaskLastCommand. Default constructor. Represents the QuickMaskNamedGroupCommand. Default constructor. Represents the QuickMaskGroupCommand. Default constructor. Represents the QuickMaskDraftingOnlyCommand. Default constructor. Represents the QuickMaskDraftingAllCommand. Default constructor. Represents the QuickMaskDraftingCommand. Default constructor. Represents the QuickMaskArcsOnlyCommand. Default constructor. Represents the QuickMaskArcsAllCommand. Default constructor. Represents the QuickMaskArcsCommand. Default constructor. Represents the LockInPolygonSelectionCommand. Default constructor. Represents the SetMasksForSelectingEntitiesCommand. Default constructor. Represents the InvertSelectionCommand. Default constructor. Represents the EndSelectionCommand. Default constructor. Represents the ClearAllMaskingCommand. Default constructor. Represents the LockInChainSelectionCommand. Default constructor. Represents the LockInAreaSelectionCommand. Default constructor. Represents the SelectAllEntitiesByTypeMaskCommand. Default constructor. Represents the ActivateSolidSelectionCommand. Default constructor. Represents the AutocursorTemporaryMidpointsCommand. Default constructor. Represents the AutocursorTangentCommand. Default constructor. Represents the AutocursorRelativeCommand. Default constructor. Represents the AutocursorQuadrantCommand. Default constructor. Represents the AutocursorPointCommand. Default constructor. Represents the AutocursorPerpendicularCommand. Default constructor. Represents the AutocursorOriginCommand. Default constructor. Represents the AutocursorNearestCommand. Default constructor. Represents the AutocursorMidpoint2PointsCommand. Default constructor. Represents the AutocursorLockQuadrantCommand. Default constructor. Represents the AutocursorLockPointCommand. Default constructor. Represents the AutocursorLockMidpoint2PointsCommand. Default constructor. Represents the AutocursorMidpointCommand. Default constructor. Represents the AutocursorLockMidpointCommand. Default constructor. Represents the AutocursorLockIntersectionCommand. Default constructor. Represents the AutocursorLockFaceCenterCommand. Default constructor. Represents the AutocursorLockEndpointCommand. Default constructor. Represents the AutocursorLockArcCenterCommand. Default constructor. Represents the AutocursorIntersectionCommand. Default constructor. Represents the AutocursorFaceCenterCommand. Default constructor. Represents the AutocursorEndpointCommand. Default constructor. Represents the AutocursorSettingsCommand. Default constructor. Represents the AutocursorArcCenterCommand. Default constructor. Represents the AutocursorAlongCommand. Represents the Selection CustomizationCategory. The backing field for the ThreeDAnnotationFinder property. The backing field for the ControlDefinitionCompareUtility property. The backing field for the TextChain property. The backing field for the Rev2Rev property. The backing field for the Map property. The backing field for the Gear property. The backing field for the FPlot property. The backing field for the FlattenSurf property. The backing field for the FindOverlap property. The backing field for the DXFRescuer property. The backing field for the MCDigitize property. The backing field for the CoonsSurf property. The backing field for the ConsToSpline property. The backing field for the BreakCircles property. The backing field for the BlankDuplicates property. The backing field for the ArcMultiedit property. The backing field for the Arc3D property. The backing field for the CreateBoundary property. The backing field for the RollDie property. The backing field for the Comp3D property. Gets the ThreeDAnnotationFinder Command property. Gets the ControlDefinitionCompareUtility Command property. Gets the TextChain Command property. Gets the Rev2Rev Command property. Gets the Map Command property. Gets the Gear Command property. Gets the FPlot Command property. Gets the FlattenSurf Command property. Gets the FindOverlap Command property. Gets the DXFRescuer Command property. Gets the MCDigitize Command property. Gets the CoonsSurf Command property. Gets the ConsToSpline Command property. Gets the BreakCircles Command property. Gets the BlankDuplicates Command property. Gets the ArcMultiedit Command property. Gets the Arc3D Command property. Gets the CreateBoundary Command property. Gets the RollDie Command property. Gets the Comp3D Command property. Default constructor. Represents the ThreeDAnnotationFinderCommand. Default constructor. Represents the ControlDefinitionCompareUtilityCommand. Default constructor. Represents the TextChainCommand. Default constructor. Represents the Rev2RevCommand. Default constructor. Represents the MapCommand. Default constructor. Represents the GearCommand. Default constructor. Represents the FPlotCommand. Default constructor. Represents the FlattenSurfCommand. Default constructor. Represents the FindOverlapCommand. Default constructor. Represents the DXFRescuerCommand. Default constructor. Represents the MCDigitizeCommand. Default constructor. Represents the CoonsSurfCommand. Default constructor. Represents the ConsToSplineCommand. Default constructor. Represents the BreakCirclesCommand. Default constructor. Represents the BlankDuplicatesCommand. Default constructor. Represents the ArcMultieditCommand. Default constructor. Represents the Arc3DCommand. Default constructor. Represents the CreateBoundaryCommand. Default constructor. Represents the RollDieCommand. Default constructor. Represents the Comp3DCommand. Represents the AddIns CustomizationCategory. The backing field for the Options property. The backing field for the Configuration property. The backing field for the CustomerFeedback property. The backing field for the KnowledgeBase property. The backing field for the Forums property. The backing field for the MastercamU property. The backing field for the LinkAccount property. The backing field for the NetworkLicensing property. The backing field for the CheckForUpdates property. The backing field for the ReleaseNotes property. The backing field for the Learning property. The backing field for the QuickReferenceGuide property. The backing field for the Contents property. The backing field for the WhatsNew property. The backing field for the Print property. The backing field for the ExportFolder property. The backing field for the ImportFolder property. The backing field for the MigrationWizard property. The backing field for the Zip2Go property. The backing field for the SaveSome property. The backing field for the SaveAs property. The backing field for the Save property. The backing field for the Merge property. The backing field for the OpenInEditor property. The backing field for the Open property. The backing field for the New property. The backing field for the CompactAndRepairFile property. The backing field for the AutoSaveBackup property. The backing field for the CheckCurrentFile property. The backing field for the ChangeRecognition property. The backing field for the ProjectFileManager property. Gets the Zip2Go Command property. Gets the WhatsNew Command property. Gets the SaveSome Command property. Gets the SaveAs Command property. Gets the Save Command property. Gets the ReleaseNotes Command property. Gets the QuickReferenceGuide Command property. Gets the ProjectFileManager Command property. Gets the Print Command property. Gets the Options Command property. Gets the OpenInEditor Command property. Gets the Open Command property. Gets the New Command property. Gets the NetworkLicensing Command property. Gets the MigrationWizard Command property. Gets the Merge Command property. Gets the MastercamU Command property. Gets the LinkAccount Command property. Gets the Learning Command property. Gets the KnowledgeBase Command property. Gets the ImportFolder Command property. Gets the Forums Command property. Gets the ExportFolder Command property. Gets the CustomerFeedback Command property. Gets the Contents Command property. Gets the Configuration Command property. Gets the CompactAndRepairFile Command property. Gets the CheckForUpdates Command property. Gets the CheckCurrentFile Command property. Gets the ChangeRecognition Command property. Gets the AutoSaveBackup Command property. Default constructor. Represents the OptionsCommand. Default constructor. Represents the ConfigurationCommand. Default constructor. Represents the CustomerFeedbackCommand. Default constructor. Represents the KnowledgeBaseCommand. Default constructor. Represents the ForumsCommand. Default constructor. Represents the MastercamUCommand. Default constructor. Represents the LinkAccountCommand. Default constructor. Represents the NetworkLicensingCommand. Default constructor. Represents the CheckForUpdatesCommand. Default constructor. Represents the ReleaseNotesCommand. Default constructor. Represents the LearningCommand. Default constructor. Represents the QuickReferenceGuideCommand. Default constructor. Represents the ContentsCommand. Default constructor. Represents the WhatsNewCommand. Default constructor. Represents the PrintCommand. Default constructor. Represents the ExportFolderCommand. Default constructor. Represents the ImportFolderCommand. Default constructor. Represents the MigrationWizardCommand. Default constructor. Represents the Zip2GoCommand. Default constructor. Represents the SaveSomeCommand. Default constructor. Represents the SaveAsCommand. Default constructor. Represents the SaveCommand. Default constructor. Represents the MergeCommand. Default constructor. Represents the OpenInEditorCommand. Default constructor. Represents the OpenCommand. Default constructor. Represents the NewCommand. Default constructor. Represents the CompactAndRepairFileCommand. Default constructor. Represents the AutoSaveBackupCommand. Default constructor. Represents the CheckCurrentFileCommand. Default constructor. Represents the ChangeRecognitionCommand. Default constructor. Represents the ProjectFileManagerCommand. FileTabCategory class definition The backing field for the DraftingSelection property. The backing field for the GeometrySelection property. The backing field for the MeshSelection property. The backing field for the SolidsSelection property. The backing field for the SurfacesSelection property. The backing field for the WireframeSelection property. The backing field for the Router property. The backing field for the Wire property. The backing field for the MillTurn property. The backing field for the Mill property. The backing field for the Lathe property. Gets the DraftingSelection Context property. Gets the GeometrySelection Context property. Gets the MeshSelection Context property. Gets the SolidsSelection Context property. Gets the SurfacesSelection Context property. Gets the WireframeSelection Context property. Gets the Router Context property. Gets the Wire Context property. Gets the MillTurn Context property. Gets the Mill Context property. Gets the Lathe Context property. The backing field for the Tools property. Gets the Tools Tab property. Represents the DraftingSelection Context. The backing field for the Tools property. Gets the Tools Tab property. Represents the GeometrySelection Context. The backing field for the Tools property. Gets the Tools Tab property. Represents the MeshSelection Context. The backing field for the Tools property. Gets the Tools Tab property. Represents the SolidsSelection Context. The backing field for the Tools property. Gets the Tools Tab property. Represents the SurfacesSelection Context. The backing field for the Tools property. Gets the Tools Tab property. Represents the WireframeSelection Context. The backing field for the Toolpaths property. Gets the Toolpaths Tab property. Represents the Router Context. The backing field for the Wirepaths property. Gets the Wirepaths Tab property. Represents the Wire Context. The backing field for the Milling property. The backing field for the Turning property. Gets the Milling Tab property. Gets the Turning Tab property. Represents the MillTurn Context. The backing field for the Toolpaths property. Gets the Toolpaths Tab property. Represents the Mill Context. The backing field for the Routing property. The backing field for the Milling property. The backing field for the Turning property. Gets the Routing Tab property. Gets the Milling Tab property. Gets the Turning Tab property. Represents the Lathe Context. ToolTabsCategory class definition The backing field for the View property. The backing field for the Machine property. The backing field for the Art property. The backing field for the Transform property. The backing field for the Drafting property. The backing field for the Mesh property. The backing field for the ModelPrep property. The backing field for the Solids property. The backing field for the Surfaces property. The backing field for the Wireframe property. The backing field for the Home property. Gets the View Tab property. Gets the Machine Tab property. Gets the Art Tab property. Gets the Transform Tab property. Gets the Drafting Tab property. Gets the Mesh Tab property. Gets the ModelPrep Tab property. Gets the Solids Tab property. Gets the Surfaces Tab property. Gets the Wireframe Tab property. Gets the Home Tab property. MainTabsCategory class definition The backing field for the Position property. The backing field for the Modify property. The backing field for the Regenerate property. The backing field for the Annotate property. The backing field for the Ordinate property. The backing field for the Dimension property. The backing field for the Analyze property. The backing field for the Display property. Gets the Regenerate Group property. Gets the Position Group property. Gets the Ordinate Group property. Gets the Modify Group property. Gets the Display Group property. Gets the Dimension Group property. Gets the Annotate Group property. Gets the Analyze Group property. The backing field for the Mirror property. The backing field for the MoveToOrigin property. The backing field for the Project property. The backing field for the Rotate property. The backing field for the TranslateToPlane property. The backing field for the Translate property. The backing field for the Dynamic property. Gets the TranslateToPlane Command property. Gets the Translate Command property. Gets the Rotate Command property. Gets the Project Command property. Gets the MoveToOrigin Command property. Gets the Mirror Command property. Gets the Dynamic Command property. Default constructor. Represents the MirrorCommand. Default constructor. Represents the MoveToOriginCommand. Default constructor. Represents the ProjectCommand. Default constructor. Represents the RotateCommand. Default constructor. Represents the TranslateToPlaneCommand. Default constructor. Represents the TranslateCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the Position Group. The backing field for the BreakIntoLines property. The backing field for the MultiEdit property. The backing field for the ConvertLegacyNote property. The backing field for the AlignNote property. Gets the MultiEdit Command property. Gets the ConvertLegacyNote Command property. Gets the BreakIntoLines Command property. Gets the AlignNote Command property. Default constructor. Represents the BreakIntoLinesCommand. Default constructor. Represents the MultiEditCommand. Default constructor. Represents the ConvertLegacyNoteCommand. Default constructor. Represents the AlignNoteCommand. Default constructor. Represents the Modify Group. The backing field for the All property. The backing field for the Select property. The backing field for the Associative property. The backing field for the Validate property. The backing field for the Automatic property. Gets the Validate Command property. Gets the Select Command property. Gets the Automatic Command property. Gets the Associative Command property. Gets the All Command property. Default constructor. Represents the AllCommand. Default constructor. Represents the SelectCommand. Default constructor. Represents the AssociativeCommand. Default constructor. Represents the ValidateCommand. Default constructor. Represents the AutomaticCommand. Default constructor. Represents the Regenerate Group. The backing field for the WitnessLine property. The backing field for the Leader property. The backing field for the CrossHatch property. The backing field for the HoleTable property. The backing field for the Note property. Gets the WitnessLine Command property. Gets the Note Command property. Gets the Leader Command property. Gets the HoleTable Command property. Gets the CrossHatch Command property. Default constructor. Represents the WitnessLineCommand. Default constructor. Represents the LeaderCommand. Default constructor. Represents the CrossHatchCommand. Default constructor. Represents the HoleTableCommand. Default constructor. Represents the NoteCommand. Default constructor. Represents the Annotate Group. The backing field for the Parallel property. The backing field for the Align property. The backing field for the Window property. The backing field for the AddToExisting property. The backing field for the Vertical property. The backing field for the Horizontal property. Gets the Window Command property. Gets the Vertical Command property. Gets the Parallel Command property. Gets the Horizontal Command property. Gets the Align Command property. Gets the AddToExisting Command property. Default constructor. Represents the ParallelCommand. Default constructor. Represents the AlignCommand. Default constructor. Represents the WindowCommand. Default constructor. Represents the AddToExistingCommand. Default constructor. Represents the VerticalCommand. Default constructor. Represents the HorizontalCommand. Default constructor. Represents the Ordinate Group. The backing field for the DraftingOptions property. The backing field for the Tangent property. The backing field for the Chained property. The backing field for the Baseline property. The backing field for the Perpendicular property. The backing field for the Parallel property. The backing field for the Angular property. The backing field for the Point property. The backing field for the Circular property. The backing field for the Vertical property. The backing field for the Horizontal property. The backing field for the SmartDimension property. Gets the Vertical Command property. Gets the Tangent Command property. Gets the SmartDimension Command property. Gets the Point Command property. Gets the Perpendicular Command property. Gets the Parallel Command property. Gets the Horizontal Command property. Gets the DraftingOptions Command property. Gets the Circular Command property. Gets the Chained Command property. Gets the Baseline Command property. Gets the Angular Command property. Default constructor. Represents the DraftingOptionsCommand. Default constructor. Represents the TangentCommand. Default constructor. Represents the ChainedCommand. Default constructor. Represents the BaselineCommand. Default constructor. Represents the PerpendicularCommand. Default constructor. Represents the ParallelCommand. Default constructor. Represents the AngularCommand. Default constructor. Represents the PointCommand. Default constructor. Represents the CircularCommand. Default constructor. Represents the VerticalCommand. Default constructor. Represents the HorizontalCommand. Default constructor. Represents the SmartDimensionCommand. Default constructor. Represents the Dimension Group. The backing field for the Chain property. The backing field for the Angle property. The backing field for the Dynamic property. The backing field for the AnalyzeDistance property. The backing field for the AnalyzeEntity property. Gets the Dynamic Command property. Gets the Chain Command property. Gets the Angle Command property. Gets the AnalyzeEntity Command property. Gets the AnalyzeDistance Command property. Default constructor. Represents the ChainCommand. Default constructor. Represents the AngleCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the AnalyzeDistanceCommand. Default constructor. Represents the AnalyzeEntityCommand. Default constructor. Represents the Analyze Group. The backing field for the HideUnhide property. Gets the HideUnhide Command property. Default constructor. Represents the HideUnhideCommand. Default constructor. Represents the Display Group. Default constructor. Represents the Tools Tab. The backing field for the Dimension property. The backing field for the Shapes property. The backing field for the Size property. The backing field for the Position property. The backing field for the Analyze property. The backing field for the Display property. Gets the Size Group property. Gets the Shapes Group property. Gets the Position Group property. Gets the Display Group property. Gets the Dimension Group property. Gets the Analyze Group property. The backing field for the SmartDimension property. Gets the SmartDimension Command property. Default constructor. Represents the SmartDimensionCommand. Default constructor. Represents the Dimension Group. The backing field for the BoundingBox property. Gets the BoundingBox Command property. Default constructor. Represents the BoundingBoxCommand. Default constructor. Represents the Shapes Group. The backing field for the Scale property. Gets the Scale Command property. Default constructor. Represents the ScaleCommand. Default constructor. Represents the Size Group. The backing field for the Mirror property. The backing field for the MoveToOrigin property. The backing field for the Rotate property. The backing field for the TranslateToPlane property. The backing field for the Translate property. The backing field for the Dynamic property. Gets the TranslateToPlane Command property. Gets the Translate Command property. Gets the Rotate Command property. Gets the MoveToOrigin Command property. Gets the Mirror Command property. Gets the Dynamic Command property. Default constructor. Represents the MirrorCommand. Default constructor. Represents the MoveToOriginCommand. Default constructor. Represents the RotateCommand. Default constructor. Represents the TranslateToPlaneCommand. Default constructor. Represents the TranslateCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the Position Group. The backing field for the PointToCurve property. The backing field for the CurveToCurve property. The backing field for the PointToSurface property. The backing field for the CurveToSurface property. The backing field for the SurfaceToSurface property. The backing field for the Chain property. The backing field for the Angle property. The backing field for the Dynamic property. The backing field for the AnalyzeDistance property. The backing field for the AnalyzeEntity property. Gets the SurfaceToSurface Command property. Gets the PointToSurface Command property. Gets the PointToCurve Command property. Gets the Dynamic Command property. Gets the CurveToSurface Command property. Gets the CurveToCurve Command property. Gets the Chain Command property. Gets the Angle Command property. Gets the AnalyzeEntity Command property. Gets the AnalyzeDistance Command property. Default constructor. Represents the PointToCurveCommand. Default constructor. Represents the CurveToCurveCommand. Default constructor. Represents the PointToSurfaceCommand. Default constructor. Represents the CurveToSurfaceCommand. Default constructor. Represents the SurfaceToSurfaceCommand. Default constructor. Represents the ChainCommand. Default constructor. Represents the AngleCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the AnalyzeDistanceCommand. Default constructor. Represents the AnalyzeEntityCommand. Default constructor. Represents the Analyze Group. The backing field for the HideUnhide property. Gets the HideUnhide Command property. Default constructor. Represents the HideUnhideCommand. Default constructor. Represents the Display Group. Default constructor. Represents the Tools Tab. The backing field for the Dimension property. The backing field for the Curves property. The backing field for the Shapes property. The backing field for the Size property. The backing field for the Position property. The backing field for the Layout property. The backing field for the Color property. The backing field for the Modify property. The backing field for the Create property. The backing field for the Analyze property. The backing field for the Display property. Gets the Size Group property. Gets the Shapes Group property. Gets the Position Group property. Gets the Modify Group property. Gets the Layout Group property. Gets the Display Group property. Gets the Dimension Group property. Gets the Curves Group property. Gets the Create Group property. Gets the Color Group property. Gets the Analyze Group property. The backing field for the SmartDimension property. Gets the SmartDimension Command property. Default constructor. Represents the SmartDimensionCommand. Default constructor. Represents the Dimension Group. The backing field for the CurveSliceByPlane property. The backing field for the CurveAllEdges property. The backing field for the CurveOneEdge property. Gets the CurveSliceByPlane Command property. Gets the CurveOneEdge Command property. Gets the CurveAllEdges Command property. Default constructor. Represents the CurveSliceByPlaneCommand. Default constructor. Represents the CurveAllEdgesCommand. Default constructor. Represents the CurveOneEdgeCommand. Default constructor. Represents the Curves Group. The backing field for the TurnProfile property. The backing field for the SilhouetteBoundary property. The backing field for the BoundingBox property. Gets the TurnProfile Command property. Gets the SilhouetteBoundary Command property. Gets the BoundingBox Command property. Default constructor. Represents the TurnProfileCommand. Default constructor. Represents the SilhouetteBoundaryCommand. Default constructor. Represents the BoundingBoxCommand. Default constructor. Represents the Shapes Group. The backing field for the Scale property. Gets the Scale Command property. Default constructor. Represents the ScaleCommand. Default constructor. Represents the Size Group. The backing field for the Mirror property. The backing field for the MoveToOrigin property. The backing field for the Rotate property. The backing field for the TranslateToPlane property. The backing field for the Translate property. The backing field for the Dynamic property. Gets the TranslateToPlane Command property. Gets the Translate Command property. Gets the Rotate Command property. Gets the MoveToOrigin Command property. Gets the Mirror Command property. Gets the Dynamic Command property. Default constructor. Represents the MirrorCommand. Default constructor. Represents the MoveToOriginCommand. Default constructor. Represents the RotateCommand. Default constructor. Represents the TranslateToPlaneCommand. Default constructor. Represents the TranslateCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the Position Group. The backing field for the Disassemble property. Gets the Disassemble Command property. Default constructor. Represents the DisassembleCommand. Default constructor. Represents the Layout Group. The backing field for the ChangeFacet property. The backing field for the ClearAll property. Gets the ClearAll Command property. Gets the ChangeFacet Command property. Default constructor. Represents the ChangeFacetCommand. Default constructor. Represents the ClearAllCommand. Default constructor. Represents the Color Group. The backing field for the TrimToSurfaceSheet property. The backing field for the TrimToPlane property. The backing field for the ModifyMeshFacets property. The backing field for the ExplodeMesh property. The backing field for the Decimation property. The backing field for the Refine property. The backing field for the SmoothArea property. The backing field for the FillHoles property. The backing field for the SmoothFreeEdges property. Gets the TrimToSurfaceSheet Command property. Gets the TrimToPlane Command property. Gets the SmoothFreeEdges Command property. Gets the SmoothArea Command property. Gets the Refine Command property. Gets the ModifyMeshFacets Command property. Gets the FillHoles Command property. Gets the ExplodeMesh Command property. Gets the Decimation Command property. Default constructor. Represents the TrimToSurfaceSheetCommand. Default constructor. Represents the TrimToPlaneCommand. Default constructor. Represents the ModifyMeshFacetsCommand. Default constructor. Represents the ExplodeMeshCommand. Default constructor. Represents the DecimationCommand. Default constructor. Represents the RefineCommand. Default constructor. Represents the SmoothAreaCommand. Default constructor. Represents the FillHolesCommand. Default constructor. Represents the SmoothFreeEdgesCommand. Default constructor. Represents the Modify Group. The backing field for the OffsetMesh property. The backing field for the MeshesFromEntities property. Gets the OffsetMesh Command property. Gets the MeshesFromEntities Command property. Default constructor. Represents the OffsetMeshCommand. Default constructor. Represents the MeshesFromEntitiesCommand. Default constructor. Represents the Create Group. The backing field for the CheckMesh property. The backing field for the Chain property. The backing field for the Angle property. The backing field for the Dynamic property. The backing field for the AnalyzeDistance property. The backing field for the AnalyzeEntity property. Gets the Dynamic Command property. Gets the CheckMesh Command property. Gets the Chain Command property. Gets the Angle Command property. Gets the AnalyzeEntity Command property. Gets the AnalyzeDistance Command property. Default constructor. Represents the CheckMeshCommand. Default constructor. Represents the ChainCommand. Default constructor. Represents the AngleCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the AnalyzeDistanceCommand. Default constructor. Represents the AnalyzeEntityCommand. Default constructor. Represents the Analyze Group. The backing field for the HideUnhide property. Gets the HideUnhide Command property. Default constructor. Represents the HideUnhideCommand. Default constructor. Represents the Display Group. Default constructor. Represents the Tools Tab. The backing field for the Dimension property. The backing field for the Curves property. The backing field for the Shapes property. The backing field for the Size property. The backing field for the Position property. The backing field for the ModelPrep property. The backing field for the Modify property. The backing field for the Create property. The backing field for the Analyze property. The backing field for the Display property. Gets the Size Group property. Gets the Shapes Group property. Gets the Position Group property. Gets the Modify Group property. Gets the ModelPrep Group property. Gets the Display Group property. Gets the Dimension Group property. Gets the Curves Group property. Gets the Create Group property. Gets the Analyze Group property. The backing field for the SmartDimension property. Gets the SmartDimension Command property. Default constructor. Represents the SmartDimensionCommand. Default constructor. Represents the Dimension Group. The backing field for the CurveSliceByPlane property. The backing field for the CurveAllEdges property. The backing field for the CurveOneEdge property. Gets the CurveSliceByPlane Command property. Gets the CurveOneEdge Command property. Gets the CurveAllEdges Command property. Default constructor. Represents the CurveSliceByPlaneCommand. Default constructor. Represents the CurveAllEdgesCommand. Default constructor. Represents the CurveOneEdgeCommand. Default constructor. Represents the Curves Group. The backing field for the TurnProfile property. The backing field for the SilhouetteBoundary property. The backing field for the BoundingBox property. Gets the TurnProfile Command property. Gets the SilhouetteBoundary Command property. Gets the BoundingBox Command property. Default constructor. Represents the TurnProfileCommand. Default constructor. Represents the SilhouetteBoundaryCommand. Default constructor. Represents the BoundingBoxCommand. Default constructor. Represents the Shapes Group. The backing field for the Scale property. Gets the Scale Command property. Default constructor. Represents the ScaleCommand. Default constructor. Represents the Size Group. The backing field for the SolidPosition property. The backing field for the AlignToZ property. The backing field for the Mirror property. The backing field for the MoveToOrigin property. The backing field for the Rotate property. The backing field for the TranslateToPlane property. The backing field for the Translate property. The backing field for the Dynamic property. Gets the TranslateToPlane Command property. Gets the Translate Command property. Gets the SolidPosition Command property. Gets the Rotate Command property. Gets the MoveToOrigin Command property. Gets the Mirror Command property. Gets the Dynamic Command property. Gets the AlignToZ Command property. Default constructor. Represents the SolidPositionCommand. Default constructor. Represents the AlignToZCommand. Default constructor. Represents the MirrorCommand. Default constructor. Represents the MoveToOriginCommand. Default constructor. Represents the RotateCommand. Default constructor. Represents the TranslateToPlaneCommand. Default constructor. Represents the TranslateCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the Position Group. The backing field for the Disassemble property. The backing field for the SimplifySolid property. The backing field for the AddHistory property. The backing field for the RemoveHistory property. The backing field for the FindHoles property. The backing field for the RemoveFillets property. The backing field for the RemoveFaces property. The backing field for the ModifyFillet property. The backing field for the ModifyFeature property. The backing field for the ClearAll property. The backing field for the Move property. The backing field for the PushPull property. Gets the SimplifySolid Command property. Gets the RemoveHistory Command property. Gets the RemoveFillets Command property. Gets the RemoveFaces Command property. Gets the PushPull Command property. Gets the Move Command property. Gets the ModifyFillet Command property. Gets the ModifyFeature Command property. Gets the FindHoles Command property. Gets the Disassemble Command property. Gets the ClearAll Command property. Gets the AddHistory Command property. Default constructor. Represents the DisassembleCommand. Default constructor. Represents the SimplifySolidCommand. Default constructor. Represents the AddHistoryCommand. Default constructor. Represents the RemoveHistoryCommand. Default constructor. Represents the FindHolesCommand. Default constructor. Represents the RemoveFilletsCommand. Default constructor. Represents the RemoveFacesCommand. Default constructor. Represents the ModifyFilletCommand. Default constructor. Represents the ModifyFeatureCommand. Default constructor. Represents the ClearAllCommand. Default constructor. Represents the MoveCommand. Default constructor. Represents the PushPullCommand. Default constructor. Represents the Model Prep Group. The backing field for the TrimToSurfaceSheet property. The backing field for the TrimToPlane property. The backing field for the DraftFaces property. The backing field for the Thicken property. The backing field for the Shell property. The backing field for the OneDistanceChamfer property. The backing field for the ConstantFillet property. Gets the TrimToSurfaceSheet Command property. Gets the TrimToPlane Command property. Gets the Thicken Command property. Gets the Shell Command property. Gets the OneDistanceChamfer Command property. Gets the DraftFaces Command property. Gets the ConstantFillet Command property. Default constructor. Represents the TrimToSurfaceSheetCommand. Default constructor. Represents the TrimToPlaneCommand. Default constructor. Represents the DraftFacesCommand. Default constructor. Represents the ThickenCommand. Default constructor. Represents the ShellCommand. Default constructor. Represents the OneDistanceChamferCommand. Default constructor. Represents the ConstantFilletCommand. Default constructor. Represents the Modify Group. The backing field for the Impression property. The backing field for the Boolean property. The backing field for the SurfacesFromSolids property. Gets the SurfacesFromSolids Command property. Gets the Impression Command property. Gets the Boolean Command property. Default constructor. Represents the ImpressionCommand. Default constructor. Represents the BooleanCommand. Default constructor. Represents the SurfacesFromSolidsCommand. Default constructor. Represents the Create Group. The backing field for the PointToCurve property. The backing field for the CurveToCurve property. The backing field for the PointToSurface property. The backing field for the CurveToSurface property. The backing field for the SurfaceToSurface property. The backing field for the Chain property. The backing field for the Angle property. The backing field for the Dynamic property. The backing field for the AnalyzeDistance property. The backing field for the AnalyzeEntity property. Gets the SurfaceToSurface Command property. Gets the PointToSurface Command property. Gets the PointToCurve Command property. Gets the Dynamic Command property. Gets the CurveToSurface Command property. Gets the CurveToCurve Command property. Gets the Chain Command property. Gets the Angle Command property. Gets the AnalyzeEntity Command property. Gets the AnalyzeDistance Command property. Default constructor. Represents the PointToCurveCommand. Default constructor. Represents the CurveToCurveCommand. Default constructor. Represents the PointToSurfaceCommand. Default constructor. Represents the CurveToSurfaceCommand. Default constructor. Represents the SurfaceToSurfaceCommand. Default constructor. Represents the ChainCommand. Default constructor. Represents the AngleCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the AnalyzeDistanceCommand. Default constructor. Represents the AnalyzeEntityCommand. Default constructor. Represents the Analyze Group. The backing field for the HideUnhide property. Gets the HideUnhide Command property. Default constructor. Represents the HideUnhideCommand. Default constructor. Represents the Display Group. Default constructor. Represents the Tools Tab. The backing field for the Curves property. The backing field for the Shapes property. The backing field for the Size property. The backing field for the Position property. The backing field for the Normals property. The backing field for the Flowline property. The backing field for the Modify property. The backing field for the Create property. The backing field for the Analyze property. The backing field for the Display property. Gets the Size Group property. Gets the Shapes Group property. Gets the Position Group property. Gets the Normals Group property. Gets the Modify Group property. Gets the Flowline Group property. Gets the Display Group property. Gets the Curves Group property. Gets the Create Group property. Gets the Analyze Group property. The backing field for the CurveSliceByPlane property. The backing field for the CurveAllEdges property. The backing field for the CurveOneEdge property. Gets the CurveSliceByPlane Command property. Gets the CurveOneEdge Command property. Gets the CurveAllEdges Command property. Default constructor. Represents the CurveSliceByPlaneCommand. Default constructor. Represents the CurveAllEdgesCommand. Default constructor. Represents the CurveOneEdgeCommand. Default constructor. Represents the Curves Group. The backing field for the TurnProfile property. The backing field for the SilhouetteBoundary property. The backing field for the BoundingBox property. Gets the TurnProfile Command property. Gets the SilhouetteBoundary Command property. Gets the BoundingBox Command property. Default constructor. Represents the TurnProfileCommand. Default constructor. Represents the SilhouetteBoundaryCommand. Default constructor. Represents the BoundingBoxCommand. Default constructor. Represents the Shapes Group. The backing field for the Scale property. Gets the Scale Command property. Default constructor. Represents the ScaleCommand. Default constructor. Represents the Size Group. The backing field for the Mirror property. The backing field for the MoveToOrigin property. The backing field for the Rotate property. The backing field for the TranslateToPlane property. The backing field for the Translate property. The backing field for the Dynamic property. Gets the TranslateToPlane Command property. Gets the Translate Command property. Gets the Rotate Command property. Gets the MoveToOrigin Command property. Gets the Mirror Command property. Gets the Dynamic Command property. Default constructor. Represents the MirrorCommand. Default constructor. Represents the MoveToOriginCommand. Default constructor. Represents the RotateCommand. Default constructor. Represents the TranslateToPlaneCommand. Default constructor. Represents the TranslateCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the Position Group. The backing field for the Orient property. The backing field for the Set property. The backing field for the Change property. Gets the Set Command property. Gets the Orient Command property. Gets the Change Command property. Default constructor. Represents the OrientCommand. Default constructor. Represents the SetCommand. Default constructor. Represents the ChangeCommand. Default constructor. Represents the Normals Group. The backing field for the ReflowUV property. The backing field for the OverflowUV property. The backing field for the EditUV property. Gets the ReflowUV Command property. Gets the OverflowUV Command property. Gets the EditUV Command property. Default constructor. Represents the ReflowUVCommand. Default constructor. Represents the OverflowUVCommand. Default constructor. Represents the EditUVCommand. Default constructor. Represents the Flowline Group. The backing field for the EditSurface property. The backing field for the Untrim property. The backing field for the ThreeFilletBlend property. The backing field for the TwoSurfaceBlend property. The backing field for the FilletToSurfaces property. The backing field for the Extend property. The backing field for the FillHoles property. The backing field for the TrimToCurves property. Gets the Untrim Command property. Gets the TwoSurfaceBlend Command property. Gets the TrimToCurves Command property. Gets the ThreeFilletBlend Command property. Gets the FillHoles Command property. Gets the FilletToSurfaces Command property. Gets the Extend Command property. Gets the EditSurface Command property. Default constructor. Represents the EditSurfaceCommand. Default constructor. Represents the UntrimCommand. Default constructor. Represents the ThreeFilletBlendCommand. Default constructor. Represents the TwoSurfaceBlendCommand. Default constructor. Represents the FilletToSurfacesCommand. Default constructor. Represents the ExtendCommand. Default constructor. Represents the FillHolesCommand. Default constructor. Represents the TrimToCurvesCommand. Default constructor. Represents the Modify Group. The backing field for the SolidsFromSurfaces property. Gets the SolidsFromSurfaces Command property. Default constructor. Represents the SolidsFromSurfacesCommand. Default constructor. Represents the Create Group. The backing field for the PointToCurve property. The backing field for the CurveToCurve property. The backing field for the PointToSurface property. The backing field for the CurveToSurface property. The backing field for the SurfaceToSurface property. The backing field for the Chain property. The backing field for the Angle property. The backing field for the Dynamic property. The backing field for the AnalyzeDistance property. The backing field for the AnalyzeEntity property. Gets the SurfaceToSurface Command property. Gets the PointToSurface Command property. Gets the PointToCurve Command property. Gets the Dynamic Command property. Gets the CurveToSurface Command property. Gets the CurveToCurve Command property. Gets the Chain Command property. Gets the Angle Command property. Gets the AnalyzeEntity Command property. Gets the AnalyzeDistance Command property. Default constructor. Represents the PointToCurveCommand. Default constructor. Represents the CurveToCurveCommand. Default constructor. Represents the PointToSurfaceCommand. Default constructor. Represents the CurveToSurfaceCommand. Default constructor. Represents the SurfaceToSurfaceCommand. Default constructor. Represents the ChainCommand. Default constructor. Represents the AngleCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the AnalyzeDistanceCommand. Default constructor. Represents the AnalyzeEntityCommand. Default constructor. Represents the Analyze Group. The backing field for the HideUnhide property. Gets the HideUnhide Command property. Default constructor. Represents the HideUnhideCommand. Default constructor. Represents the Display Group. Default constructor. Represents the Tools Tab. The backing field for the Dimension property. The backing field for the Shapes property. The backing field for the Size property. The backing field for the Offset property. The backing field for the Position property. The backing field for the Modify property. The backing field for the Create property. The backing field for the Analyze property. The backing field for the Display property. Gets the Size Group property. Gets the Shapes Group property. Gets the Position Group property. Gets the Offset Group property. Gets the Modify Group property. Gets the Display Group property. Gets the Dimension Group property. Gets the Create Group property. Gets the Analyze Group property. The backing field for the Note property. The backing field for the MultiEdit property. The backing field for the SmartDimension property. Gets the SmartDimension Command property. Gets the Note Command property. Gets the MultiEdit Command property. Default constructor. Represents the NoteCommand. Default constructor. Represents the MultiEditCommand. Default constructor. Represents the SmartDimensionCommand. Default constructor. Represents the Dimension Group. The backing field for the BoundingBox property. Gets the BoundingBox Command property. Default constructor. Represents the BoundingBoxCommand. Default constructor. Represents the Shapes Group. The backing field for the Scale property. The backing field for the Stretch property. Gets the Stretch Command property. Gets the Scale Command property. Default constructor. Represents the ScaleCommand. Default constructor. Represents the StretchCommand. Default constructor. Represents the Size Group. The backing field for the Chains property. The backing field for the Entity property. Gets the Entity Command property. Gets the Chains Command property. Default constructor. Represents the ChainsCommand. Default constructor. Represents the EntityCommand. Default constructor. Represents the Offset Group. The backing field for the Roll property. The backing field for the Mirror property. The backing field for the MoveToOrigin property. The backing field for the Project property. The backing field for the Rotate property. The backing field for the TranslateToPlane property. The backing field for the Translate property. The backing field for the Dynamic property. Gets the TranslateToPlane Command property. Gets the Translate Command property. Gets the Rotate Command property. Gets the Roll Command property. Gets the Project Command property. Gets the MoveToOrigin Command property. Gets the Mirror Command property. Gets the Dynamic Command property. Default constructor. Represents the RollCommand. Default constructor. Represents the MirrorCommand. Default constructor. Represents the MoveToOriginCommand. Default constructor. Represents the ProjectCommand. Default constructor. Represents the RotateCommand. Default constructor. Represents the TranslateToPlaneCommand. Default constructor. Represents the TranslateCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the Position Group. The backing field for the RefitSpline property. The backing field for the BreakCircles property. The backing field for the CloseArc property. The backing field for the ChamferEntities property. The backing field for the FilletEntities property. The backing field for the ModifyLength property. The backing field for the JoinEntities property. The backing field for the Divide property. The backing field for the BreakTwoPieces property. The backing field for the TrimToEntities property. The backing field for the DynamicTrim property. Gets the TrimToEntities Command property. Gets the RefitSpline Command property. Gets the ModifyLength Command property. Gets the JoinEntities Command property. Gets the FilletEntities Command property. Gets the DynamicTrim Command property. Gets the Divide Command property. Gets the CloseArc Command property. Gets the ChamferEntities Command property. Gets the BreakTwoPieces Command property. Gets the BreakCircles Command property. Default constructor. Represents the RefitSplineCommand. Default constructor. Represents the BreakCirclesCommand. Default constructor. Represents the CloseArcCommand. Default constructor. Represents the ChamferEntitiesCommand. Default constructor. Represents the FilletEntitiesCommand. Default constructor. Represents the ModifyLengthCommand. Default constructor. Represents the JoinEntitiesCommand. Default constructor. Represents the DivideCommand. Default constructor. Represents the BreakTwoPiecesCommand. Default constructor. Represents the TrimToEntitiesCommand. Default constructor. Represents the DynamicTrimCommand. Default constructor. Represents the Modify Group. The backing field for the Extrude property. Gets the Extrude Command property. Default constructor. Represents the ExtrudeCommand. Default constructor. Represents the Create Group. The backing field for the PointToCurve property. The backing field for the CurveToCurve property. The backing field for the PointToSurface property. The backing field for the CurveToSurface property. The backing field for the SurfaceToSurface property. The backing field for the Chain property. The backing field for the Angle property. The backing field for the Dynamic property. The backing field for the AnalyzeDistance property. The backing field for the AnalyzeEntity property. Gets the SurfaceToSurface Command property. Gets the PointToSurface Command property. Gets the PointToCurve Command property. Gets the Dynamic Command property. Gets the CurveToSurface Command property. Gets the CurveToCurve Command property. Gets the Chain Command property. Gets the Angle Command property. Gets the AnalyzeEntity Command property. Gets the AnalyzeDistance Command property. Default constructor. Represents the PointToCurveCommand. Default constructor. Represents the CurveToCurveCommand. Default constructor. Represents the PointToSurfaceCommand. Default constructor. Represents the CurveToSurfaceCommand. Default constructor. Represents the SurfaceToSurfaceCommand. Default constructor. Represents the ChainCommand. Default constructor. Represents the AngleCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the AnalyzeDistanceCommand. Default constructor. Represents the AnalyzeEntityCommand. Default constructor. Represents the Analyze Group. The backing field for the HideUnhide property. Gets the HideUnhide Command property. Default constructor. Represents the HideUnhideCommand. Default constructor. Represents the Display Group. Default constructor. Represents the Tools Tab. The backing field for the Analyze property. The backing field for the Utilities property. The backing field for the Stock property. The backing field for the Multiaxis property. The backing field for the ThreeD property. The backing field for the TwoD property. Gets the Utilities Group property. Gets the Stock Group property. Gets the Multiaxis Group property. Gets the Analyze Group property. Gets the ThreeD Group property. Gets the TwoD Group property. The backing field for the CheckToolReach property. The backing field for the CheckHolder property. Gets the CheckToolReach Command property. Gets the CheckHolder Command property. Default constructor. Represents the CheckToolReachCommand. Default constructor. Represents the CheckHolderCommand. Default constructor. Represents the Analyze Group. The backing field for the Nesting property. The backing field for the Trim property. The backing field for the ConvertTo5Axis property. The backing field for the ProcessHole property. The backing field for the ToolpathTransform property. The backing field for the MultiaxisLinking property. The backing field for the Probe property. The backing field for the ToolManager property. Gets the Trim Command property. Gets the ToolpathTransform Command property. Gets the ToolManager Command property. Gets the ProcessHole Command property. Gets the Probe Command property. Gets the Nesting Command property. Gets the MultiaxisLinking Command property. Gets the ConvertTo5Axis Command property. Default constructor. Represents the NestingCommand. Default constructor. Represents the TrimCommand. Default constructor. Represents the ConvertTo5AxisCommand. Default constructor. Represents the ProcessHoleCommand. Default constructor. Represents the ToolpathTransformCommand. Default constructor. Represents the MultiaxisLinkingCommand. Default constructor. Represents the ProbeCommand. Default constructor. Represents the ToolManagerCommand. Default constructor. Represents the Utilities Group. The backing field for the StockModel property. The backing field for the StockDisplay property. The backing field for the StockShading property. Gets the StockShading Command property. Gets the StockModel Command property. Gets the StockDisplay Command property. Default constructor. Represents the StockModelCommand. Default constructor. Represents the StockDisplayCommand. Default constructor. Represents the StockShadingCommand. Default constructor. Represents the Stock Group. The backing field for the PortExpert property. The backing field for the BladeExpert property. The backing field for the Multisurface property. The backing field for the Rotary property. The backing field for the Swarf property. The backing field for the Three2AutomaticRoughing property. The backing field for the TriangularMesh property. The backing field for the Flow property. The backing field for the RotaryAdvanced property. The backing field for the Pocketing property. The backing field for the Deburr5Axis property. The backing field for the Unified property. The backing field for the SwarfMilling property. The backing field for the Curve property. Gets the Unified Command property. Gets the TriangularMesh Command property. Gets the Three2AutomaticRoughing Command property. Gets the SwarfMilling Command property. Gets the Swarf Command property. Gets the RotaryAdvanced Command property. Gets the Rotary Command property. Gets the PortExpert Command property. Gets the Pocketing Command property. Gets the Multisurface Command property. Gets the Flow Command property. Gets the Deburr5Axis Command property. Gets the Curve Command property. Gets the BladeExpert Command property. Default constructor. Represents the PortExpertCommand. Default constructor. Represents the BladeExpertCommand. Default constructor. Represents the MultisurfaceCommand. Default constructor. Represents the RotaryCommand. Default constructor. Represents the SwarfCommand. Default constructor. Represents the Three2AutomaticRoughingCommand. Default constructor. Represents the TriangularMeshCommand. Default constructor. Represents the FlowCommand. Default constructor. Represents the RotaryAdvancedCommand. Default constructor. Represents the PocketingCommand. Default constructor. Represents the Deburr5AxisCommand. Default constructor. Represents the UnifiedCommand. Default constructor. Represents the SwarfMillingCommand. Default constructor. Represents the CurveCommand. Default constructor. Represents the Multiaxis Group. The backing field for the Deburr3Axis property. The backing field for the Radial property. The backing field for the Spiral property. The backing field for the Flowline property. The backing field for the Scallop property. The backing field for the HorizontalArea property. The backing field for the Contour property. The backing field for the Blend property. The backing field for the Pencil property. The backing field for the Hybrid property. The backing field for the EqualScallop property. The backing field for the Raster property. The backing field for the Waterline property. The backing field for the AreaRoughing property. The backing field for the MultisurfacePocket property. The backing field for the Plunge property. The backing field for the Parallel property. The backing field for the Project property. The backing field for the Pocket property. The backing field for the DynamicOptirough property. Gets the Waterline Command property. Gets the Spiral Command property. Gets the Scallop Command property. Gets the Raster Command property. Gets the Radial Command property. Gets the Project Command property. Gets the Pocket Command property. Gets the Plunge Command property. Gets the Pencil Command property. Gets the Parallel Command property. Gets the MultisurfacePocket Command property. Gets the Hybrid Command property. Gets the HorizontalArea Command property. Gets the Flowline Command property. Gets the EqualScallop Command property. Gets the DynamicOptirough Command property. Gets the Deburr3Axis Command property. Gets the Contour Command property. Gets the Blend Command property. Gets the AreaRoughing Command property. Default constructor. Represents the Deburr3AxisCommand. Default constructor. Represents the RadialCommand. Default constructor. Represents the SpiralCommand. Default constructor. Represents the FlowlineCommand. Default constructor. Represents the ScallopCommand. Default constructor. Represents the HorizontalAreaCommand. Default constructor. Represents the ContourCommand. Default constructor. Represents the BlendCommand. Default constructor. Represents the PencilCommand. Default constructor. Represents the HybridCommand. Default constructor. Represents the EqualScallopCommand. Default constructor. Represents the RasterCommand. Default constructor. Represents the WaterlineCommand. Default constructor. Represents the AreaRoughingCommand. Default constructor. Represents the MultisurfacePocketCommand. Default constructor. Represents the PlungeCommand. Default constructor. Represents the ParallelCommand. Default constructor. Represents the ProjectCommand. Default constructor. Represents the PocketCommand. Default constructor. Represents the DynamicOptiroughCommand. Default constructor. Represents the 3D Group. The backing field for the Point property. The backing field for the ManualEntry property. The backing field for the StartHole property. The backing field for the AutoDrill property. The backing field for the FBMDrill property. The backing field for the ThreadMill property. The backing field for the HelixBore property. The backing field for the CircleMill property. The backing field for the AdvancedDrill property. The backing field for the ChamferDrill property. The backing field for the BlockDrilling property. The backing field for the Saw property. The backing field for the Ruled property. The backing field for the Lofted property. The backing field for the Revolved property. The backing field for the Swept3D property. The backing field for the Swept2D property. The backing field for the FBMMill property. The backing field for the Engrave property. The backing field for the ModelChamfer property. The backing field for the SlotMill property. The backing field for the BlendMill property. The backing field for the AreaMill property. The backing field for the PeelMill property. The backing field for the Pocket property. The backing field for the DynamicContour property. The backing field for the Face property. The backing field for the DynamicMill property. The backing field for the Drill property. The backing field for the Contour property. Gets the ThreadMill Command property. Gets the Swept3D Command property. Gets the Swept2D Command property. Gets the StartHole Command property. Gets the SlotMill Command property. Gets the Saw Command property. Gets the Ruled Command property. Gets the Revolved Command property. Gets the Point Command property. Gets the Pocket Command property. Gets the PeelMill Command property. Gets the ModelChamfer Command property. Gets the ManualEntry Command property. Gets the Lofted Command property. Gets the HelixBore Command property. Gets the FBMMill Command property. Gets the FBMDrill Command property. Gets the Face Command property. Gets the Engrave Command property. Gets the DynamicMill Command property. Gets the DynamicContour Command property. Gets the Drill Command property. Gets the Contour Command property. Gets the CircleMill Command property. Gets the ChamferDrill Command property. Gets the BlockDrilling Command property. Gets the BlendMill Command property. Gets the AutoDrill Command property. Gets the AreaMill Command property. Gets the AdvancedDrill Command property. Default constructor. Represents the PointCommand. Default constructor. Represents the ManualEntryCommand. Default constructor. Represents the StartHoleCommand. Default constructor. Represents the AutoDrillCommand. Default constructor. Represents the FBMDrillCommand. Default constructor. Represents the ThreadMillCommand. Default constructor. Represents the HelixBoreCommand. Default constructor. Represents the CircleMillCommand. Default constructor. Represents the AdvancedDrillCommand. Default constructor. Represents the ChamferDrillCommand. Default constructor. Represents the BlockDrillingCommand. Default constructor. Represents the SawCommand. Default constructor. Represents the RuledCommand. Default constructor. Represents the LoftedCommand. Default constructor. Represents the RevolvedCommand. Default constructor. Represents the Swept3DCommand. Default constructor. Represents the Swept2DCommand. Default constructor. Represents the FBMMillCommand. Default constructor. Represents the EngraveCommand. Default constructor. Represents the ModelChamferCommand. Default constructor. Represents the SlotMillCommand. Default constructor. Represents the BlendMillCommand. Default constructor. Represents the AreaMillCommand. Default constructor. Represents the PeelMillCommand. Default constructor. Represents the PocketCommand. Default constructor. Represents the DynamicContourCommand. Default constructor. Represents the FaceCommand. Default constructor. Represents the DynamicMillCommand. Default constructor. Represents the DrillCommand. Default constructor. Represents the ContourCommand. Default constructor. Represents the 2D Group. Default constructor. Represents the Toolpaths Tab. The backing field for the Utilities property. The backing field for the Stock property. The backing field for the Wirepaths property. Gets the Wirepaths Group property. Gets the Utilities Group property. Gets the Stock Group property. The backing field for the AutosyncRails property. The backing field for the Nesting property. The backing field for the Trim property. The backing field for the ToolpathTransform property. Gets the Trim Command property. Gets the ToolpathTransform Command property. Gets the Nesting Command property. Gets the AutosyncRails Command property. Default constructor. Represents the AutosyncRailsCommand. Default constructor. Represents the NestingCommand. Default constructor. Represents the TrimCommand. Default constructor. Represents the ToolpathTransformCommand. Default constructor. Represents the Utilities Group. The backing field for the StockDisplay property. The backing field for the StockShading property. Gets the StockShading Command property. Gets the StockDisplay Command property. Default constructor. Represents the StockDisplayCommand. Default constructor. Represents the StockShadingCommand. Default constructor. Represents the Stock Group. The backing field for the ManualEntry property. The backing field for the Collar property. The backing field for the Canned property. The backing field for the Point property. The backing field for the NoCore property. The backing field for the FourAxis property. The backing field for the Contour property. Gets the Point Command property. Gets the NoCore Command property. Gets the ManualEntry Command property. Gets the FourAxis Command property. Gets the Contour Command property. Gets the Collar Command property. Gets the Canned Command property. Default constructor. Represents the ManualEntryCommand. Default constructor. Represents the CollarCommand. Default constructor. Represents the CannedCommand. Default constructor. Represents the PointCommand. Default constructor. Represents the NoCoreCommand. Default constructor. Represents the FourAxisCommand. Default constructor. Represents the ContourCommand. Default constructor. Represents the Wirepaths Group. Default constructor. Represents the Wirepaths Tab. The backing field for the Analyze property. The backing field for the Utilities property. The backing field for the Stock property. The backing field for the Multiaxis property. The backing field for the ThreeD property. The backing field for the TwoD property. Gets the Utilities Group property. Gets the Stock Group property. Gets the Multiaxis Group property. Gets the Analyze Group property. Gets the ThreeD Group property. Gets the TwoD Group property. The backing field for the CheckToolReach property. The backing field for the CheckHolder property. Gets the CheckToolReach Command property. Gets the CheckHolder Command property. Default constructor. Represents the CheckToolReachCommand. Default constructor. Represents the CheckHolderCommand. Default constructor. Represents the Analyze Group. The backing field for the ConvertTo5Axis property. The backing field for the CreateToolplanes property. The backing field for the ToolpathTransform property. The backing field for the ToolManager property. Gets the ToolpathTransform Command property. Gets the ToolManager Command property. Gets the CreateToolplanes Command property. Gets the ConvertTo5Axis Command property. Default constructor. Represents the ConvertTo5AxisCommand. Default constructor. Represents the CreateToolplanesCommand. Default constructor. Represents the ToolpathTransformCommand. Default constructor. Represents the ToolManagerCommand. Default constructor. Represents the Utilities Group. The backing field for the StockModel property. The backing field for the StockDisplay property. The backing field for the StockShading property. Gets the StockShading Command property. Gets the StockModel Command property. Gets the StockDisplay Command property. Default constructor. Represents the StockModelCommand. Default constructor. Represents the StockDisplayCommand. Default constructor. Represents the StockShadingCommand. Default constructor. Represents the Stock Group. The backing field for the PortExpert property. The backing field for the BladeExpert property. The backing field for the Multisurface property. The backing field for the Rotary property. The backing field for the Swarf property. The backing field for the Three2AutomaticRoughing property. The backing field for the TriangularMesh property. The backing field for the Flow property. The backing field for the RotaryAdvanced property. The backing field for the Pocketing property. The backing field for the Deburr5Axis property. The backing field for the Unified property. The backing field for the SwarfMilling property. The backing field for the Curve property. Gets the Unified Command property. Gets the TriangularMesh Command property. Gets the Three2AutomaticRoughing Command property. Gets the SwarfMilling Command property. Gets the Swarf Command property. Gets the RotaryAdvanced Command property. Gets the Rotary Command property. Gets the PortExpert Command property. Gets the Pocketing Command property. Gets the Multisurface Command property. Gets the Flow Command property. Gets the Deburr5Axis Command property. Gets the Curve Command property. Gets the BladeExpert Command property. Default constructor. Represents the PortExpertCommand. Default constructor. Represents the BladeExpertCommand. Default constructor. Represents the MultisurfaceCommand. Default constructor. Represents the RotaryCommand. Default constructor. Represents the SwarfCommand. Default constructor. Represents the Three2AutomaticRoughingCommand. Default constructor. Represents the TriangularMeshCommand. Default constructor. Represents the FlowCommand. Default constructor. Represents the RotaryAdvancedCommand. Default constructor. Represents the PocketingCommand. Default constructor. Represents the Deburr5AxisCommand. Default constructor. Represents the UnifiedCommand. Default constructor. Represents the SwarfMillingCommand. Default constructor. Represents the CurveCommand. Default constructor. Represents the Multiaxis Group. The backing field for the Deburr3Axis property. The backing field for the Radial property. The backing field for the Spiral property. The backing field for the Flowline property. The backing field for the Scallop property. The backing field for the HorizontalArea property. The backing field for the Contour property. The backing field for the Blend property. The backing field for the Pencil property. The backing field for the Hybrid property. The backing field for the EqualScallop property. The backing field for the Raster property. The backing field for the Waterline property. The backing field for the AreaRoughing property. The backing field for the MultisurfacePocket property. The backing field for the Plunge property. The backing field for the Parallel property. The backing field for the Project property. The backing field for the Pocket property. The backing field for the DynamicOptirough property. Gets the Waterline Command property. Gets the Spiral Command property. Gets the Scallop Command property. Gets the Raster Command property. Gets the Radial Command property. Gets the Project Command property. Gets the Pocket Command property. Gets the Plunge Command property. Gets the Pencil Command property. Gets the Parallel Command property. Gets the MultisurfacePocket Command property. Gets the Hybrid Command property. Gets the HorizontalArea Command property. Gets the Flowline Command property. Gets the EqualScallop Command property. Gets the DynamicOptirough Command property. Gets the Deburr3Axis Command property. Gets the Contour Command property. Gets the Blend Command property. Gets the AreaRoughing Command property. Default constructor. Represents the Deburr3AxisCommand. Default constructor. Represents the RadialCommand. Default constructor. Represents the SpiralCommand. Default constructor. Represents the FlowlineCommand. Default constructor. Represents the ScallopCommand. Default constructor. Represents the HorizontalAreaCommand. Default constructor. Represents the ContourCommand. Default constructor. Represents the BlendCommand. Default constructor. Represents the PencilCommand. Default constructor. Represents the HybridCommand. Default constructor. Represents the EqualScallopCommand. Default constructor. Represents the RasterCommand. Default constructor. Represents the WaterlineCommand. Default constructor. Represents the AreaRoughingCommand. Default constructor. Represents the MultisurfacePocketCommand. Default constructor. Represents the PlungeCommand. Default constructor. Represents the ParallelCommand. Default constructor. Represents the ProjectCommand. Default constructor. Represents the PocketCommand. Default constructor. Represents the DynamicOptiroughCommand. Default constructor. Represents the 3D Group. The backing field for the Point property. The backing field for the ManualEntry property. The backing field for the ThreadMill property. The backing field for the HelixBore property. The backing field for the CircleMill property. The backing field for the AdvancedDrill property. The backing field for the ChamferDrill property. The backing field for the Ruled property. The backing field for the Lofted property. The backing field for the Revolved property. The backing field for the Swept3D property. The backing field for the Swept2D property. The backing field for the ModelChamfer property. The backing field for the SlotMill property. The backing field for the BlendMill property. The backing field for the AreaMill property. The backing field for the PeelMill property. The backing field for the Pocket property. The backing field for the DynamicContour property. The backing field for the Face property. The backing field for the DynamicMill property. The backing field for the Drill property. The backing field for the Contour property. Gets the ThreadMill Command property. Gets the Swept3D Command property. Gets the Swept2D Command property. Gets the SlotMill Command property. Gets the Ruled Command property. Gets the Revolved Command property. Gets the Point Command property. Gets the Pocket Command property. Gets the PeelMill Command property. Gets the ModelChamfer Command property. Gets the ManualEntry Command property. Gets the Lofted Command property. Gets the HelixBore Command property. Gets the Face Command property. Gets the DynamicMill Command property. Gets the DynamicContour Command property. Gets the Drill Command property. Gets the Contour Command property. Gets the CircleMill Command property. Gets the ChamferDrill Command property. Gets the BlendMill Command property. Gets the AreaMill Command property. Gets the AdvancedDrill Command property. Default constructor. Represents the PointCommand. Default constructor. Represents the ManualEntryCommand. Default constructor. Represents the ThreadMillCommand. Default constructor. Represents the HelixBoreCommand. Default constructor. Represents the CircleMillCommand. Default constructor. Represents the AdvancedDrillCommand. Default constructor. Represents the ChamferDrillCommand. Default constructor. Represents the RuledCommand. Default constructor. Represents the LoftedCommand. Default constructor. Represents the RevolvedCommand. Default constructor. Represents the Swept3DCommand. Default constructor. Represents the Swept2DCommand. Default constructor. Represents the ModelChamferCommand. Default constructor. Represents the SlotMillCommand. Default constructor. Represents the BlendMillCommand. Default constructor. Represents the AreaMillCommand. Default constructor. Represents the PeelMillCommand. Default constructor. Represents the PocketCommand. Default constructor. Represents the DynamicContourCommand. Default constructor. Represents the FaceCommand. Default constructor. Represents the DynamicMillCommand. Default constructor. Represents the DrillCommand. Default constructor. Represents the ContourCommand. Default constructor. Represents the 2D Group. Default constructor. Represents the Milling Tab. The backing field for the Utilities property. The backing field for the Stock property. The backing field for the PartHandling property. The backing field for the General property. Gets the Utilities Group property. Gets the Stock Group property. Gets the PartHandling Group property. Gets the General Group property. The backing field for the AlignToZ property. The backing field for the ToolManager property. Gets the ToolManager Command property. Gets the AlignToZ Command property. Default constructor. Represents the AlignToZCommand. Default constructor. Represents the ToolManagerCommand. Default constructor. Represents the Utilities Group. The backing field for the StockPreview property. The backing field for the StockModel property. The backing field for the StockDisplay property. The backing field for the StockShading property. Gets the StockShading Command property. Gets the StockPreview Command property. Gets the StockModel Command property. Gets the StockDisplay Command property. Default constructor. Represents the StockPreviewCommand. Default constructor. Represents the StockModelCommand. Default constructor. Represents the StockDisplayCommand. Default constructor. Represents the StockShadingCommand. Default constructor. Represents the Stock Group. The backing field for the SteadyRestPoint property. The backing field for the CenterPoint property. The backing field for the ManualTailstock property. The backing field for the BarFeed property. The backing field for the SteadyRest property. The backing field for the SpindleSync property. The backing field for the SpindleMove property. The backing field for the SpindleClamp property. The backing field for the TurretPark property. The backing field for the TailstockOperations property. The backing field for the StockPull property. The backing field for the Pickoff property. The backing field for the PickoffCutoff property. Gets the TurretPark Command property. Gets the TailstockOperations Command property. Gets the StockPull Command property. Gets the SteadyRestPoint Command property. Gets the SteadyRest Command property. Gets the SpindleSync Command property. Gets the SpindleMove Command property. Gets the SpindleClamp Command property. Gets the PickoffCutoff Command property. Gets the Pickoff Command property. Gets the ManualTailstock Command property. Gets the CenterPoint Command property. Gets the BarFeed Command property. Default constructor. Represents the SteadyRestPointCommand. Default constructor. Represents the CenterPointCommand. Default constructor. Represents the ManualTailstockCommand. Default constructor. Represents the BarFeedCommand. Default constructor. Represents the SteadyRestCommand. Default constructor. Represents the SpindleSyncCommand. Default constructor. Represents the SpindleMoveCommand. Default constructor. Represents the SpindleClampCommand. Default constructor. Represents the TurretParkCommand. Default constructor. Represents the TailstockOperationsCommand. Default constructor. Represents the StockPullCommand. Default constructor. Represents the PickoffCommand. Default constructor. Represents the PickoffCutoffCommand. Default constructor. Represents the Part Handling Group. The backing field for the PatternRepeat property. The backing field for the CannedGroove property. The backing field for the CannedFinish property. The backing field for the CannedRough property. The backing field for the ManualEntry property. The backing field for the Point property. The backing field for the AAxisContourTurning property. The backing field for the BAxisContourTurning property. The backing field for the CustomThread property. The backing field for the PrimeTurning property. The backing field for the ContourRough property. The backing field for the PlungeTurn property. The backing field for the Thread property. The backing field for the DynamicRough property. The backing field for the Groove property. The backing field for the Cutoff property. The backing field for the Face property. The backing field for the PinchTurn property. The backing field for the Drill property. The backing field for the Finish property. The backing field for the Rough property. Gets the Thread Command property. Gets the Rough Command property. Gets the PrimeTurning Command property. Gets the Point Command property. Gets the PlungeTurn Command property. Gets the PinchTurn Command property. Gets the PatternRepeat Command property. Gets the ManualEntry Command property. Gets the Groove Command property. Gets the Finish Command property. Gets the Face Command property. Gets the DynamicRough Command property. Gets the Drill Command property. Gets the Cutoff Command property. Gets the CustomThread Command property. Gets the ContourRough Command property. Gets the CannedRough Command property. Gets the CannedGroove Command property. Gets the CannedFinish Command property. Gets the BAxisContourTurning Command property. Gets the AAxisContourTurning Command property. Default constructor. Represents the PatternRepeatCommand. Default constructor. Represents the CannedGrooveCommand. Default constructor. Represents the CannedFinishCommand. Default constructor. Represents the CannedRoughCommand. Default constructor. Represents the ManualEntryCommand. Default constructor. Represents the PointCommand. Default constructor. Represents the AAxisContourTurningCommand. Default constructor. Represents the BAxisContourTurningCommand. Default constructor. Represents the CustomThreadCommand. Default constructor. Represents the PrimeTurningCommand. Default constructor. Represents the ContourRoughCommand. Default constructor. Represents the PlungeTurnCommand. Default constructor. Represents the ThreadCommand. Default constructor. Represents the DynamicRoughCommand. Default constructor. Represents the GrooveCommand. Default constructor. Represents the CutoffCommand. Default constructor. Represents the FaceCommand. Default constructor. Represents the PinchTurnCommand. Default constructor. Represents the DrillCommand. Default constructor. Represents the FinishCommand. Default constructor. Represents the RoughCommand. Default constructor. Represents the General Group. Default constructor. Represents the Turning Tab. The backing field for the Analyze property. The backing field for the Utilities property. The backing field for the Stock property. The backing field for the Multiaxis property. The backing field for the ThreeD property. The backing field for the TwoD property. Gets the Utilities Group property. Gets the Stock Group property. Gets the Multiaxis Group property. Gets the Analyze Group property. Gets the ThreeD Group property. Gets the TwoD Group property. The backing field for the CheckToolReach property. The backing field for the CheckHolder property. Gets the CheckToolReach Command property. Gets the CheckHolder Command property. Default constructor. Represents the CheckToolReachCommand. Default constructor. Represents the CheckHolderCommand. Default constructor. Represents the Analyze Group. The backing field for the Nesting property. The backing field for the Trim property. The backing field for the ConvertTo5Axis property. The backing field for the ProcessHole property. The backing field for the ToolpathTransform property. The backing field for the MultiaxisLinking property. The backing field for the Probe property. The backing field for the ToolManager property. Gets the Trim Command property. Gets the ToolpathTransform Command property. Gets the ToolManager Command property. Gets the ProcessHole Command property. Gets the Probe Command property. Gets the Nesting Command property. Gets the MultiaxisLinking Command property. Gets the ConvertTo5Axis Command property. Default constructor. Represents the NestingCommand. Default constructor. Represents the TrimCommand. Default constructor. Represents the ConvertTo5AxisCommand. Default constructor. Represents the ProcessHoleCommand. Default constructor. Represents the ToolpathTransformCommand. Default constructor. Represents the MultiaxisLinkingCommand. Default constructor. Represents the ProbeCommand. Default constructor. Represents the ToolManagerCommand. Default constructor. Represents the Utilities Group. The backing field for the StockModel property. The backing field for the StockDisplay property. The backing field for the StockShading property. Gets the StockShading Command property. Gets the StockModel Command property. Gets the StockDisplay Command property. Default constructor. Represents the StockModelCommand. Default constructor. Represents the StockDisplayCommand. Default constructor. Represents the StockShadingCommand. Default constructor. Represents the Stock Group. The backing field for the PortExpert property. The backing field for the BladeExpert property. The backing field for the Multisurface property. The backing field for the Rotary property. The backing field for the Swarf property. The backing field for the Three2AutomaticRoughing property. The backing field for the TriangularMesh property. The backing field for the Flow property. The backing field for the RotaryAdvanced property. The backing field for the Pocketing property. The backing field for the Deburr5Axis property. The backing field for the Unified property. The backing field for the SwarfMilling property. The backing field for the Curve property. Gets the Unified Command property. Gets the TriangularMesh Command property. Gets the Three2AutomaticRoughing Command property. Gets the SwarfMilling Command property. Gets the Swarf Command property. Gets the RotaryAdvanced Command property. Gets the Rotary Command property. Gets the PortExpert Command property. Gets the Pocketing Command property. Gets the Multisurface Command property. Gets the Flow Command property. Gets the Deburr5Axis Command property. Gets the Curve Command property. Gets the BladeExpert Command property. Default constructor. Represents the PortExpertCommand. Default constructor. Represents the BladeExpertCommand. Default constructor. Represents the MultisurfaceCommand. Default constructor. Represents the RotaryCommand. Default constructor. Represents the SwarfCommand. Default constructor. Represents the Three2AutomaticRoughingCommand. Default constructor. Represents the TriangularMeshCommand. Default constructor. Represents the FlowCommand. Default constructor. Represents the RotaryAdvancedCommand. Default constructor. Represents the PocketingCommand. Default constructor. Represents the Deburr5AxisCommand. Default constructor. Represents the UnifiedCommand. Default constructor. Represents the SwarfMillingCommand. Default constructor. Represents the CurveCommand. Default constructor. Represents the Multiaxis Group. The backing field for the Deburr3Axis property. The backing field for the Radial property. The backing field for the Spiral property. The backing field for the Flowline property. The backing field for the Scallop property. The backing field for the HorizontalArea property. The backing field for the Contour property. The backing field for the Blend property. The backing field for the Pencil property. The backing field for the Hybrid property. The backing field for the EqualScallop property. The backing field for the Raster property. The backing field for the Waterline property. The backing field for the AreaRoughing property. The backing field for the MultisurfacePocket property. The backing field for the Plunge property. The backing field for the Parallel property. The backing field for the Project property. The backing field for the Pocket property. The backing field for the DynamicOptirough property. Gets the Waterline Command property. Gets the Spiral Command property. Gets the Scallop Command property. Gets the Raster Command property. Gets the Radial Command property. Gets the Project Command property. Gets the Pocket Command property. Gets the Plunge Command property. Gets the Pencil Command property. Gets the Parallel Command property. Gets the MultisurfacePocket Command property. Gets the Hybrid Command property. Gets the HorizontalArea Command property. Gets the Flowline Command property. Gets the EqualScallop Command property. Gets the DynamicOptirough Command property. Gets the Deburr3Axis Command property. Gets the Contour Command property. Gets the Blend Command property. Gets the AreaRoughing Command property. Default constructor. Represents the Deburr3AxisCommand. Default constructor. Represents the RadialCommand. Default constructor. Represents the SpiralCommand. Default constructor. Represents the FlowlineCommand. Default constructor. Represents the ScallopCommand. Default constructor. Represents the HorizontalAreaCommand. Default constructor. Represents the ContourCommand. Default constructor. Represents the BlendCommand. Default constructor. Represents the PencilCommand. Default constructor. Represents the HybridCommand. Default constructor. Represents the EqualScallopCommand. Default constructor. Represents the RasterCommand. Default constructor. Represents the WaterlineCommand. Default constructor. Represents the AreaRoughingCommand. Default constructor. Represents the MultisurfacePocketCommand. Default constructor. Represents the PlungeCommand. Default constructor. Represents the ParallelCommand. Default constructor. Represents the ProjectCommand. Default constructor. Represents the PocketCommand. Default constructor. Represents the DynamicOptiroughCommand. Default constructor. Represents the 3D Group. The backing field for the Point property. The backing field for the ManualEntry property. The backing field for the StartHole property. The backing field for the AutoDrill property. The backing field for the FBMDrill property. The backing field for the ThreadMill property. The backing field for the HelixBore property. The backing field for the CircleMill property. The backing field for the AdvancedDrill property. The backing field for the ChamferDrill property. The backing field for the Ruled property. The backing field for the Lofted property. The backing field for the Revolved property. The backing field for the Swept3D property. The backing field for the Swept2D property. The backing field for the FBMMill property. The backing field for the Engrave property. The backing field for the ModelChamfer property. The backing field for the SlotMill property. The backing field for the BlendMill property. The backing field for the AreaMill property. The backing field for the PeelMill property. The backing field for the Pocket property. The backing field for the DynamicContour property. The backing field for the Face property. The backing field for the DynamicMill property. The backing field for the Drill property. The backing field for the Contour property. Gets the ThreadMill Command property. Gets the Swept3D Command property. Gets the Swept2D Command property. Gets the StartHole Command property. Gets the SlotMill Command property. Gets the Ruled Command property. Gets the Revolved Command property. Gets the Point Command property. Gets the Pocket Command property. Gets the PeelMill Command property. Gets the ModelChamfer Command property. Gets the ManualEntry Command property. Gets the Lofted Command property. Gets the HelixBore Command property. Gets the FBMMill Command property. Gets the FBMDrill Command property. Gets the Face Command property. Gets the Engrave Command property. Gets the DynamicMill Command property. Gets the DynamicContour Command property. Gets the Drill Command property. Gets the Contour Command property. Gets the CircleMill Command property. Gets the ChamferDrill Command property. Gets the BlendMill Command property. Gets the AutoDrill Command property. Gets the AreaMill Command property. Gets the AdvancedDrill Command property. Default constructor. Represents the PointCommand. Default constructor. Represents the ManualEntryCommand. Default constructor. Represents the StartHoleCommand. Default constructor. Represents the AutoDrillCommand. Default constructor. Represents the FBMDrillCommand. Default constructor. Represents the ThreadMillCommand. Default constructor. Represents the HelixBoreCommand. Default constructor. Represents the CircleMillCommand. Default constructor. Represents the AdvancedDrillCommand. Default constructor. Represents the ChamferDrillCommand. Default constructor. Represents the RuledCommand. Default constructor. Represents the LoftedCommand. Default constructor. Represents the RevolvedCommand. Default constructor. Represents the Swept3DCommand. Default constructor. Represents the Swept2DCommand. Default constructor. Represents the FBMMillCommand. Default constructor. Represents the EngraveCommand. Default constructor. Represents the ModelChamferCommand. Default constructor. Represents the SlotMillCommand. Default constructor. Represents the BlendMillCommand. Default constructor. Represents the AreaMillCommand. Default constructor. Represents the PeelMillCommand. Default constructor. Represents the PocketCommand. Default constructor. Represents the DynamicContourCommand. Default constructor. Represents the FaceCommand. Default constructor. Represents the DynamicMillCommand. Default constructor. Represents the DrillCommand. Default constructor. Represents the ContourCommand. Default constructor. Represents the 2D Group. Default constructor. Represents the Toolpaths Tab. The backing field for the Analyze property. The backing field for the Utilities property. The backing field for the Stock property. The backing field for the Multiaxis property. The backing field for the ThreeD property. The backing field for the TwoD property. Gets the Utilities Group property. Gets the Stock Group property. Gets the Multiaxis Group property. Gets the Analyze Group property. Gets the ThreeD Group property. Gets the TwoD Group property. The backing field for the CheckToolReach property. The backing field for the CheckHolder property. Gets the CheckToolReach Command property. Gets the CheckHolder Command property. Default constructor. Represents the CheckToolReachCommand. Default constructor. Represents the CheckHolderCommand. Default constructor. Represents the Analyze Group. The backing field for the Trim property. The backing field for the ConvertTo5Axis property. The backing field for the ToolpathTransform property. The backing field for the MultiaxisLinking property. The backing field for the ToolManager property. Gets the Trim Command property. Gets the ToolpathTransform Command property. Gets the ToolManager Command property. Gets the MultiaxisLinking Command property. Gets the ConvertTo5Axis Command property. Default constructor. Represents the TrimCommand. Default constructor. Represents the ConvertTo5AxisCommand. Default constructor. Represents the ToolpathTransformCommand. Default constructor. Represents the MultiaxisLinkingCommand. Default constructor. Represents the ToolManagerCommand. Default constructor. Represents the Utilities Group. The backing field for the StockModel property. The backing field for the StockDisplay property. The backing field for the StockShading property. Gets the StockShading Command property. Gets the StockModel Command property. Gets the StockDisplay Command property. Default constructor. Represents the StockModelCommand. Default constructor. Represents the StockDisplayCommand. Default constructor. Represents the StockShadingCommand. Default constructor. Represents the Stock Group. The backing field for the PortExpert property. The backing field for the BladeExpert property. The backing field for the Multisurface property. The backing field for the Rotary property. The backing field for the Swarf property. The backing field for the Three2AutomaticRoughing property. The backing field for the TriangularMesh property. The backing field for the Flow property. The backing field for the RotaryAdvanced property. The backing field for the Pocketing property. The backing field for the Deburr5Axis property. The backing field for the Unified property. The backing field for the SwarfMilling property. The backing field for the Curve property. Gets the Unified Command property. Gets the TriangularMesh Command property. Gets the Three2AutomaticRoughing Command property. Gets the SwarfMilling Command property. Gets the Swarf Command property. Gets the RotaryAdvanced Command property. Gets the Rotary Command property. Gets the PortExpert Command property. Gets the Pocketing Command property. Gets the Multisurface Command property. Gets the Flow Command property. Gets the Deburr5Axis Command property. Gets the Curve Command property. Gets the BladeExpert Command property. Default constructor. Represents the PortExpertCommand. Default constructor. Represents the BladeExpertCommand. Default constructor. Represents the MultisurfaceCommand. Default constructor. Represents the RotaryCommand. Default constructor. Represents the SwarfCommand. Default constructor. Represents the Three2AutomaticRoughingCommand. Default constructor. Represents the TriangularMeshCommand. Default constructor. Represents the FlowCommand. Default constructor. Represents the RotaryAdvancedCommand. Default constructor. Represents the PocketingCommand. Default constructor. Represents the Deburr5AxisCommand. Default constructor. Represents the UnifiedCommand. Default constructor. Represents the SwarfMillingCommand. Default constructor. Represents the CurveCommand. Default constructor. Represents the Multiaxis Group. The backing field for the Deburr3Axis property. The backing field for the Radial property. The backing field for the Spiral property. The backing field for the Flowline property. The backing field for the Scallop property. The backing field for the HorizontalArea property. The backing field for the Contour property. The backing field for the Blend property. The backing field for the Pencil property. The backing field for the Hybrid property. The backing field for the EqualScallop property. The backing field for the Raster property. The backing field for the Waterline property. The backing field for the AreaRoughing property. The backing field for the MultisurfacePocket property. The backing field for the Plunge property. The backing field for the Parallel property. The backing field for the Project property. The backing field for the Pocket property. The backing field for the DynamicOptirough property. Gets the Waterline Command property. Gets the Spiral Command property. Gets the Scallop Command property. Gets the Raster Command property. Gets the Radial Command property. Gets the Project Command property. Gets the Pocket Command property. Gets the Plunge Command property. Gets the Pencil Command property. Gets the Parallel Command property. Gets the MultisurfacePocket Command property. Gets the Hybrid Command property. Gets the HorizontalArea Command property. Gets the Flowline Command property. Gets the EqualScallop Command property. Gets the DynamicOptirough Command property. Gets the Deburr3Axis Command property. Gets the Contour Command property. Gets the Blend Command property. Gets the AreaRoughing Command property. Default constructor. Represents the Deburr3AxisCommand. Default constructor. Represents the RadialCommand. Default constructor. Represents the SpiralCommand. Default constructor. Represents the FlowlineCommand. Default constructor. Represents the ScallopCommand. Default constructor. Represents the HorizontalAreaCommand. Default constructor. Represents the ContourCommand. Default constructor. Represents the BlendCommand. Default constructor. Represents the PencilCommand. Default constructor. Represents the HybridCommand. Default constructor. Represents the EqualScallopCommand. Default constructor. Represents the RasterCommand. Default constructor. Represents the WaterlineCommand. Default constructor. Represents the AreaRoughingCommand. Default constructor. Represents the MultisurfacePocketCommand. Default constructor. Represents the PlungeCommand. Default constructor. Represents the ParallelCommand. Default constructor. Represents the ProjectCommand. Default constructor. Represents the PocketCommand. Default constructor. Represents the DynamicOptiroughCommand. Default constructor. Represents the 3D Group. The backing field for the Point property. The backing field for the ManualEntry property. The backing field for the StartHole property. The backing field for the AutoDrill property. The backing field for the ThreadMill property. The backing field for the HelixBore property. The backing field for the CircleMill property. The backing field for the AdvancedDrill property. The backing field for the ChamferDrill property. The backing field for the Ruled property. The backing field for the Lofted property. The backing field for the Revolved property. The backing field for the Swept3D property. The backing field for the Swept2D property. The backing field for the Engrave property. The backing field for the ModelChamfer property. The backing field for the SlotMill property. The backing field for the BlendMill property. The backing field for the AreaMill property. The backing field for the PeelMill property. The backing field for the Pocket property. The backing field for the DynamicContour property. The backing field for the Face property. The backing field for the DynamicMill property. The backing field for the Drill property. The backing field for the Contour property. Gets the ThreadMill Command property. Gets the Swept3D Command property. Gets the Swept2D Command property. Gets the StartHole Command property. Gets the SlotMill Command property. Gets the Ruled Command property. Gets the Revolved Command property. Gets the Point Command property. Gets the Pocket Command property. Gets the PeelMill Command property. Gets the ModelChamfer Command property. Gets the ManualEntry Command property. Gets the Lofted Command property. Gets the HelixBore Command property. Gets the Face Command property. Gets the Engrave Command property. Gets the DynamicMill Command property. Gets the DynamicContour Command property. Gets the Drill Command property. Gets the Contour Command property. Gets the CircleMill Command property. Gets the ChamferDrill Command property. Gets the BlendMill Command property. Gets the AutoDrill Command property. Gets the AreaMill Command property. Gets the AdvancedDrill Command property. Default constructor. Represents the PointCommand. Default constructor. Represents the ManualEntryCommand. Default constructor. Represents the StartHoleCommand. Default constructor. Represents the AutoDrillCommand. Default constructor. Represents the ThreadMillCommand. Default constructor. Represents the HelixBoreCommand. Default constructor. Represents the CircleMillCommand. Default constructor. Represents the AdvancedDrillCommand. Default constructor. Represents the ChamferDrillCommand. Default constructor. Represents the RuledCommand. Default constructor. Represents the LoftedCommand. Default constructor. Represents the RevolvedCommand. Default constructor. Represents the Swept3DCommand. Default constructor. Represents the Swept2DCommand. Default constructor. Represents the EngraveCommand. Default constructor. Represents the ModelChamferCommand. Default constructor. Represents the SlotMillCommand. Default constructor. Represents the BlendMillCommand. Default constructor. Represents the AreaMillCommand. Default constructor. Represents the PeelMillCommand. Default constructor. Represents the PocketCommand. Default constructor. Represents the DynamicContourCommand. Default constructor. Represents the FaceCommand. Default constructor. Represents the DynamicMillCommand. Default constructor. Represents the DrillCommand. Default constructor. Represents the ContourCommand. Default constructor. Represents the 2D Group. Default constructor. Represents the Routing Tab. The backing field for the Analyze property. The backing field for the Utilities property. The backing field for the Stock property. The backing field for the Multiaxis property. The backing field for the ThreeD property. The backing field for the TwoD property. Gets the Utilities Group property. Gets the Stock Group property. Gets the Multiaxis Group property. Gets the Analyze Group property. Gets the ThreeD Group property. Gets the TwoD Group property. The backing field for the CheckToolReach property. The backing field for the CheckHolder property. Gets the CheckToolReach Command property. Gets the CheckHolder Command property. Default constructor. Represents the CheckToolReachCommand. Default constructor. Represents the CheckHolderCommand. Default constructor. Represents the Analyze Group. The backing field for the Trim property. The backing field for the ConvertTo5Axis property. The backing field for the ToolpathTransform property. The backing field for the MultiaxisLinking property. The backing field for the ToolManager property. Gets the Trim Command property. Gets the ToolpathTransform Command property. Gets the ToolManager Command property. Gets the MultiaxisLinking Command property. Gets the ConvertTo5Axis Command property. Default constructor. Represents the TrimCommand. Default constructor. Represents the ConvertTo5AxisCommand. Default constructor. Represents the ToolpathTransformCommand. Default constructor. Represents the MultiaxisLinkingCommand. Default constructor. Represents the ToolManagerCommand. Default constructor. Represents the Utilities Group. The backing field for the StockModel property. The backing field for the StockDisplay property. The backing field for the StockShading property. Gets the StockShading Command property. Gets the StockModel Command property. Gets the StockDisplay Command property. Default constructor. Represents the StockModelCommand. Default constructor. Represents the StockDisplayCommand. Default constructor. Represents the StockShadingCommand. Default constructor. Represents the Stock Group. The backing field for the PortExpert property. The backing field for the BladeExpert property. The backing field for the Multisurface property. The backing field for the Rotary property. The backing field for the Swarf property. The backing field for the Three2AutomaticRoughing property. The backing field for the TriangularMesh property. The backing field for the Flow property. The backing field for the RotaryAdvanced property. The backing field for the Pocketing property. The backing field for the Deburr5Axis property. The backing field for the Unified property. The backing field for the SwarfMilling property. The backing field for the Curve property. Gets the Unified Command property. Gets the TriangularMesh Command property. Gets the Three2AutomaticRoughing Command property. Gets the SwarfMilling Command property. Gets the Swarf Command property. Gets the RotaryAdvanced Command property. Gets the Rotary Command property. Gets the PortExpert Command property. Gets the Pocketing Command property. Gets the Multisurface Command property. Gets the Flow Command property. Gets the Deburr5Axis Command property. Gets the Curve Command property. Gets the BladeExpert Command property. Default constructor. Represents the PortExpertCommand. Default constructor. Represents the BladeExpertCommand. Default constructor. Represents the MultisurfaceCommand. Default constructor. Represents the RotaryCommand. Default constructor. Represents the SwarfCommand. Default constructor. Represents the Three2AutomaticRoughingCommand. Default constructor. Represents the TriangularMeshCommand. Default constructor. Represents the FlowCommand. Default constructor. Represents the RotaryAdvancedCommand. Default constructor. Represents the PocketingCommand. Default constructor. Represents the Deburr5AxisCommand. Default constructor. Represents the UnifiedCommand. Default constructor. Represents the SwarfMillingCommand. Default constructor. Represents the CurveCommand. Default constructor. Represents the Multiaxis Group. The backing field for the Deburr3Axis property. The backing field for the Radial property. The backing field for the Spiral property. The backing field for the Flowline property. The backing field for the Scallop property. The backing field for the HorizontalArea property. The backing field for the Contour property. The backing field for the Blend property. The backing field for the Pencil property. The backing field for the Hybrid property. The backing field for the EqualScallop property. The backing field for the Raster property. The backing field for the Waterline property. The backing field for the AreaRoughing property. The backing field for the MultisurfacePocket property. The backing field for the Plunge property. The backing field for the Parallel property. The backing field for the Project property. The backing field for the Pocket property. The backing field for the DynamicOptirough property. Gets the Waterline Command property. Gets the Spiral Command property. Gets the Scallop Command property. Gets the Raster Command property. Gets the Radial Command property. Gets the Project Command property. Gets the Pocket Command property. Gets the Plunge Command property. Gets the Pencil Command property. Gets the Parallel Command property. Gets the MultisurfacePocket Command property. Gets the Hybrid Command property. Gets the HorizontalArea Command property. Gets the Flowline Command property. Gets the EqualScallop Command property. Gets the DynamicOptirough Command property. Gets the Deburr3Axis Command property. Gets the Contour Command property. Gets the Blend Command property. Gets the AreaRoughing Command property. Default constructor. Represents the Deburr3AxisCommand. Default constructor. Represents the RadialCommand. Default constructor. Represents the SpiralCommand. Default constructor. Represents the FlowlineCommand. Default constructor. Represents the ScallopCommand. Default constructor. Represents the HorizontalAreaCommand. Default constructor. Represents the ContourCommand. Default constructor. Represents the BlendCommand. Default constructor. Represents the PencilCommand. Default constructor. Represents the HybridCommand. Default constructor. Represents the EqualScallopCommand. Default constructor. Represents the RasterCommand. Default constructor. Represents the WaterlineCommand. Default constructor. Represents the AreaRoughingCommand. Default constructor. Represents the MultisurfacePocketCommand. Default constructor. Represents the PlungeCommand. Default constructor. Represents the ParallelCommand. Default constructor. Represents the ProjectCommand. Default constructor. Represents the PocketCommand. Default constructor. Represents the DynamicOptiroughCommand. Default constructor. Represents the 3D Group. The backing field for the Point property. The backing field for the ManualEntry property. The backing field for the StartHole property. The backing field for the AutoDrill property. The backing field for the ThreadMill property. The backing field for the HelixBore property. The backing field for the CircleMill property. The backing field for the AdvancedDrill property. The backing field for the ChamferDrill property. The backing field for the Ruled property. The backing field for the Lofted property. The backing field for the Revolved property. The backing field for the Swept3D property. The backing field for the Swept2D property. The backing field for the Engrave property. The backing field for the ModelChamfer property. The backing field for the SlotMill property. The backing field for the BlendMill property. The backing field for the AreaMill property. The backing field for the PeelMill property. The backing field for the Pocket property. The backing field for the DynamicContour property. The backing field for the Face property. The backing field for the DynamicMill property. The backing field for the Drill property. The backing field for the Contour property. Gets the ThreadMill Command property. Gets the Swept3D Command property. Gets the Swept2D Command property. Gets the StartHole Command property. Gets the SlotMill Command property. Gets the Ruled Command property. Gets the Revolved Command property. Gets the Point Command property. Gets the Pocket Command property. Gets the PeelMill Command property. Gets the ModelChamfer Command property. Gets the ManualEntry Command property. Gets the Lofted Command property. Gets the HelixBore Command property. Gets the Face Command property. Gets the Engrave Command property. Gets the DynamicMill Command property. Gets the DynamicContour Command property. Gets the Drill Command property. Gets the Contour Command property. Gets the CircleMill Command property. Gets the ChamferDrill Command property. Gets the BlendMill Command property. Gets the AutoDrill Command property. Gets the AreaMill Command property. Gets the AdvancedDrill Command property. Default constructor. Represents the PointCommand. Default constructor. Represents the ManualEntryCommand. Default constructor. Represents the StartHoleCommand. Default constructor. Represents the AutoDrillCommand. Default constructor. Represents the ThreadMillCommand. Default constructor. Represents the HelixBoreCommand. Default constructor. Represents the CircleMillCommand. Default constructor. Represents the AdvancedDrillCommand. Default constructor. Represents the ChamferDrillCommand. Default constructor. Represents the RuledCommand. Default constructor. Represents the LoftedCommand. Default constructor. Represents the RevolvedCommand. Default constructor. Represents the Swept3DCommand. Default constructor. Represents the Swept2DCommand. Default constructor. Represents the EngraveCommand. Default constructor. Represents the ModelChamferCommand. Default constructor. Represents the SlotMillCommand. Default constructor. Represents the BlendMillCommand. Default constructor. Represents the AreaMillCommand. Default constructor. Represents the PeelMillCommand. Default constructor. Represents the PocketCommand. Default constructor. Represents the DynamicContourCommand. Default constructor. Represents the FaceCommand. Default constructor. Represents the DynamicMillCommand. Default constructor. Represents the DrillCommand. Default constructor. Represents the ContourCommand. Default constructor. Represents the 2D Group. Default constructor. Represents the Milling Tab. The backing field for the Utilities property. The backing field for the Stock property. The backing field for the PartHandling property. The backing field for the CAxis property. The backing field for the General property. Gets the Utilities Group property. Gets the Stock Group property. Gets the PartHandling Group property. Gets the General Group property. Gets the CAxis Group property. The backing field for the AlignToZ property. The backing field for the CView property. The backing field for the ToolpathTransform property. The backing field for the ToolManager property. Gets the ToolpathTransform Command property. Gets the ToolManager Command property. Gets the CView Command property. Gets the AlignToZ Command property. Default constructor. Represents the AlignToZCommand. Default constructor. Represents the CViewCommand. Default constructor. Represents the ToolpathTransformCommand. Default constructor. Represents the ToolManagerCommand. Default constructor. Represents the Utilities Group. The backing field for the StockPreview property. The backing field for the StockModel property. The backing field for the StockDisplay property. The backing field for the StockShading property. Gets the StockShading Command property. Gets the StockPreview Command property. Gets the StockModel Command property. Gets the StockDisplay Command property. Default constructor. Represents the StockPreviewCommand. Default constructor. Represents the StockModelCommand. Default constructor. Represents the StockDisplayCommand. Default constructor. Represents the StockShadingCommand. Default constructor. Represents the Stock Group. The backing field for the SteadyRest property. The backing field for the StockAdvance property. The backing field for the Tailstock property. The backing field for the Chuck property. The backing field for the StockTransfer property. The backing field for the PickoffPullCutoff property. The backing field for the StockFlip property. Gets the Tailstock Command property. Gets the StockTransfer Command property. Gets the StockFlip Command property. Gets the StockAdvance Command property. Gets the SteadyRest Command property. Gets the PickoffPullCutoff Command property. Gets the Chuck Command property. Default constructor. Represents the SteadyRestCommand. Default constructor. Represents the StockAdvanceCommand. Default constructor. Represents the TailstockCommand. Default constructor. Represents the ChuckCommand. Default constructor. Represents the StockTransferCommand. Default constructor. Represents the PickoffPullCutoffCommand. Default constructor. Represents the StockFlipCommand. Default constructor. Represents the Part Handling Group. The backing field for the CrossDrill property. The backing field for the CAxisDrill property. The backing field for the FaceDrill property. The backing field for the CrossContour property. The backing field for the CAxisContour property. The backing field for the FaceContour property. Gets the FaceDrill Command property. Gets the FaceContour Command property. Gets the CrossDrill Command property. Gets the CrossContour Command property. Gets the CAxisDrill Command property. Gets the CAxisContour Command property. Default constructor. Represents the CrossDrillCommand. Default constructor. Represents the CAxisDrillCommand. Default constructor. Represents the FaceDrillCommand. Default constructor. Represents the CrossContourCommand. Default constructor. Represents the CAxisContourCommand. Default constructor. Represents the FaceContourCommand. Default constructor. Represents the C-axis Group. The backing field for the PatternRepeat property. The backing field for the CannedGroove property. The backing field for the CannedFinish property. The backing field for the CannedRough property. The backing field for the Point property. The backing field for the ManualEntry property. The backing field for the CustomThread property. The backing field for the PrimeTurning property. The backing field for the ContourRough property. The backing field for the PlungeTurn property. The backing field for the Thread property. The backing field for the DynamicRough property. The backing field for the Groove property. The backing field for the Cutoff property. The backing field for the Face property. The backing field for the Drill property. The backing field for the Finish property. The backing field for the Rough property. Gets the Thread Command property. Gets the Rough Command property. Gets the PrimeTurning Command property. Gets the Point Command property. Gets the PlungeTurn Command property. Gets the PatternRepeat Command property. Gets the ManualEntry Command property. Gets the Groove Command property. Gets the Finish Command property. Gets the Face Command property. Gets the DynamicRough Command property. Gets the Drill Command property. Gets the Cutoff Command property. Gets the CustomThread Command property. Gets the ContourRough Command property. Gets the CannedRough Command property. Gets the CannedGroove Command property. Gets the CannedFinish Command property. Default constructor. Represents the PatternRepeatCommand. Default constructor. Represents the CannedGrooveCommand. Default constructor. Represents the CannedFinishCommand. Default constructor. Represents the CannedRoughCommand. Default constructor. Represents the PointCommand. Default constructor. Represents the ManualEntryCommand. Default constructor. Represents the CustomThreadCommand. Default constructor. Represents the PrimeTurningCommand. Default constructor. Represents the ContourRoughCommand. Default constructor. Represents the PlungeTurnCommand. Default constructor. Represents the ThreadCommand. Default constructor. Represents the DynamicRoughCommand. Default constructor. Represents the GrooveCommand. Default constructor. Represents the CutoffCommand. Default constructor. Represents the FaceCommand. Default constructor. Represents the DrillCommand. Default constructor. Represents the FinishCommand. Default constructor. Represents the RoughCommand. Default constructor. Represents the General Group. Default constructor. Represents the Turning Tab. The backing field for the Viewsheets property. The backing field for the Controller property. The backing field for the Grid property. The backing field for the Display property. The backing field for the Managers property. The backing field for the Toolpaths property. The backing field for the Appearance property. The backing field for the GraphicsView property. The backing field for the Zoom property. Gets the Zoom Group property. Gets the Viewsheets Group property. Gets the Toolpaths Group property. Gets the Managers Group property. Gets the Grid Group property. Gets the GraphicsView Group property. Gets the Display Group property. Gets the Controller Group property. Gets the Appearance Group property. The backing field for the ViewsheetSettings property. The backing field for the RestoreBookmark property. The backing field for the SaveBookmark property. The backing field for the New property. The backing field for the OnOff property. Gets the ViewsheetSettings Command property. Gets the SaveBookmark Command property. Gets the RestoreBookmark Command property. Gets the OnOff Command property. Gets the New Command property. Default constructor. Represents the ViewsheetSettingsCommand. Default constructor. Represents the RestoreBookmarkCommand. Default constructor. Represents the SaveBookmarkCommand. Default constructor. Represents the NewCommand. Default constructor. Represents the OnOffCommand. Default constructor. Represents the Viewsheets Group. The backing field for the RotationPosition property. Gets the RotationPosition Command property. Default constructor. Represents the RotationPositionCommand. Default constructor. Represents the Controller Group. The backing field for the GridSettings property. The backing field for the SnapToGrid property. The backing field for the ShowGrid property. Gets the SnapToGrid Command property. Gets the ShowGrid Command property. Gets the GridSettings Command property. Default constructor. Represents the GridSettingsCommand. Default constructor. Represents the SnapToGridCommand. Default constructor. Represents the ShowGridCommand. Default constructor. Represents the Grid Group. The backing field for the ToolsAndHoldersSettings property. The backing field for the ShowTool property. The backing field for the ShowGnomons property. The backing field for the ShowAxes property. Gets the ToolsAndHoldersSettings Command property. Gets the ShowTool Command property. Gets the ShowGnomons Command property. Gets the ShowAxes Command property. Default constructor. Represents the ToolsAndHoldersSettingsCommand. Default constructor. Represents the ShowToolCommand. Default constructor. Represents the ShowGnomonsCommand. Default constructor. Represents the ShowAxesCommand. Default constructor. Represents the Display Group. The backing field for the RecentFunctions property. The backing field for the Groups property. The backing field for the MultiThreading property. The backing field for the Levels property. The backing field for the Planes property. The backing field for the Solids property. The backing field for the Toolpaths property. Gets the Toolpaths Command property. Gets the Solids Command property. Gets the RecentFunctions Command property. Gets the Planes Command property. Gets the MultiThreading Command property. Gets the Levels Command property. Gets the Groups Command property. Default constructor. Represents the RecentFunctionsCommand. Default constructor. Represents the GroupsCommand. Default constructor. Represents the MultiThreadingCommand. Default constructor. Represents the LevelsCommand. Default constructor. Represents the PlanesCommand. Default constructor. Represents the SolidsCommand. Default constructor. Represents the ToolpathsCommand. Default constructor. Represents the Managers Group. The backing field for the AdvancedToolpathDisplayOptions property. The backing field for the AdvancedDisplay property. Gets the AdvancedToolpathDisplayOptions Command property. Gets the AdvancedDisplay Command property. Default constructor. Represents the AdvancedToolpathDisplayOptionsCommand. Default constructor. Represents the AdvancedDisplayCommand. Default constructor. Represents the Toolpaths Group. The backing field for the ShadingOptions property. The backing field for the MeshFacetEdges property. The backing field for the Backside property. The backing field for the Translucency property. The backing field for the ToggleMaterial property. The backing field for the OutlineShaded property. The backing field for the Wireframe property. Gets the Wireframe Command property. Gets the Translucency Command property. Gets the ToggleMaterial Command property. Gets the ShadingOptions Command property. Gets the OutlineShaded Command property. Gets the MeshFacetEdges Command property. Gets the Backside Command property. Default constructor. Represents the ShadingOptionsCommand. Default constructor. Represents the MeshFacetEdgesCommand. Default constructor. Represents the BacksideCommand. Default constructor. Represents the TranslucencyCommand. Default constructor. Represents the ToggleMaterialCommand. Default constructor. Represents the OutlineShadedCommand. Default constructor. Represents the WireframeCommand. Default constructor. Represents the Appearance Group. The backing field for the SectionView property. The backing field for the Save property. The backing field for the CPlane property. The backing field for the Rotate property. The backing field for the Front property. The backing field for the Isometric property. The backing field for the Top property. Gets the Top Command property. Gets the SectionView Command property. Gets the Save Command property. Gets the Rotate Command property. Gets the Isometric Command property. Gets the Front Command property. Gets the CPlane Command property. Default constructor. Represents the SectionViewCommand. Default constructor. Represents the SaveCommand. Default constructor. Represents the CPlaneCommand. Default constructor. Represents the RotateCommand. Default constructor. Represents the FrontCommand. Default constructor. Represents the IsometricCommand. Default constructor. Represents the TopCommand. Default constructor. Represents the Graphics View Group. The backing field for the Unzoom80 property. The backing field for the UnzoomPrevious50 property. The backing field for the Window property. The backing field for the Fit property. Gets the Window Command property. Gets the UnzoomPrevious50 Command property. Gets the Unzoom80 Command property. Gets the Fit Command property. Default constructor. Represents the Unzoom80Command. Default constructor. Represents the UnzoomPrevious50Command. Default constructor. Represents the WindowCommand. Default constructor. Represents the FitCommand. Default constructor. Represents the Zoom Group. Default constructor. Represents the View Tab. The backing field for the AutomaticToolpathing property. The backing field for the MachineSimulation property. The backing field for the SetupSheet property. The backing field for the Post property. The backing field for the Simulator property. The backing field for the JobSetup property. The backing field for the MachineType property. Gets the Simulator Group property. Gets the SetupSheet Group property. Gets the Post Group property. Gets the MachineType Group property. Gets the MachineSimulation Group property. Gets the JobSetup Group property. Gets the AutomaticToolpathing Group property. The backing field for the ATPOptions property. The backing field for the ATPReports property. The backing field for the ATPCurrentFile property. The backing field for the ATP property. Gets the ATPReports Command property. Gets the ATPOptions Command property. Gets the ATPCurrentFile Command property. Gets the ATP Command property. Default constructor. Represents the ATPOptionsCommand. Default constructor. Represents the ATPReportsCommand. Default constructor. Represents the ATPCurrentFileCommand. Default constructor. Represents the ATPCommand. Default constructor. Represents the Automatic Toolpathing Group. The backing field for the MachineSimulationOptions property. The backing field for the Verify property. The backing field for the Backplot property. The backing field for the Run property. Gets the Verify Command property. Gets the Run Command property. Gets the MachineSimulationOptions Command property. Gets the Backplot Command property. Default constructor. Represents the MachineSimulationOptionsCommand. Default constructor. Represents the VerifyCommand. Default constructor. Represents the BackplotCommand. Default constructor. Represents the RunCommand. Default constructor. Represents the Machine Simulation Group. The backing field for the ClearImageList property. The backing field for the ImageCapture property. The backing field for the Create property. Gets the ImageCapture Command property. Gets the Create Command property. Gets the ClearImageList Command property. Default constructor. Represents the ClearImageListCommand. Default constructor. Represents the ImageCaptureCommand. Default constructor. Represents the CreateCommand. Default constructor. Represents the Setup Sheet Group. The backing field for the Generate property. Gets the Generate Command property. Default constructor. Represents the GenerateCommand. Default constructor. Represents the Post Group. The backing field for the SimulatorOptions property. The backing field for the Simulate property. The backing field for the Verify property. The backing field for the Backplot property. Gets the Verify Command property. Gets the SimulatorOptions Command property. Gets the Simulate Command property. Gets the Backplot Command property. Default constructor. Represents the SimulatorOptionsCommand. Default constructor. Represents the SimulateCommand. Default constructor. Represents the VerifyCommand. Default constructor. Represents the BackplotCommand. Default constructor. Represents the Simulator Group. The backing field for the ToolManager property. The backing field for the Material property. The backing field for the MachineDefinition property. The backing field for the ControlDefinition property. Gets the ToolManager Command property. Gets the Material Command property. Gets the MachineDefinition Command property. Gets the ControlDefinition Command property. Default constructor. Represents the ToolManagerCommand. Default constructor. Represents the MaterialCommand. Default constructor. Represents the MachineDefinitionCommand. Default constructor. Represents the ControlDefinitionCommand. Default constructor. Represents the Job Setup Group. The backing field for the Design property. Gets the Design Command property. Default constructor. Represents the DesignCommand. Default constructor. Represents the Machine Type Group. Default constructor. Represents the Machine Tab. Default constructor. Represents the Art Tab. The backing field for the Size property. The backing field for the Layout property. The backing field for the Offset property. The backing field for the Position property. Gets the Size Group property. Gets the Position Group property. Gets the Offset Group property. Gets the Layout Group property. The backing field for the Scale property. The backing field for the Stretch property. Gets the Stretch Command property. Gets the Scale Command property. Default constructor. Represents the ScaleCommand. Default constructor. Represents the StretchCommand. Default constructor. Represents the Size Group. The backing field for the Distribute property. The backing field for the RectangularArray property. The backing field for the GeometryNesting property. Gets the RectangularArray Command property. Gets the GeometryNesting Command property. Gets the Distribute Command property. Default constructor. Represents the DistributeCommand. Default constructor. Represents the RectangularArrayCommand. Default constructor. Represents the GeometryNestingCommand. Default constructor. Represents the Layout Group. The backing field for the Chains property. The backing field for the Entity property. Gets the Entity Command property. Gets the Chains Command property. Default constructor. Represents the ChainsCommand. Default constructor. Represents the EntityCommand. Default constructor. Represents the Offset Group. The backing field for the Roll property. The backing field for the Mirror property. The backing field for the MoveToOrigin property. The backing field for the Project property. The backing field for the Rotate property. The backing field for the TranslateToPlane property. The backing field for the Translate property. The backing field for the Dynamic property. Gets the TranslateToPlane Command property. Gets the Translate Command property. Gets the Rotate Command property. Gets the Roll Command property. Gets the Project Command property. Gets the MoveToOrigin Command property. Gets the Mirror Command property. Gets the Dynamic Command property. Default constructor. Represents the RollCommand. Default constructor. Represents the MirrorCommand. Default constructor. Represents the MoveToOriginCommand. Default constructor. Represents the ProjectCommand. Default constructor. Represents the RotateCommand. Default constructor. Represents the TranslateToPlaneCommand. Default constructor. Represents the TranslateCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the Position Group. Default constructor. Represents the Transform Tab. The backing field for the Modify property. The backing field for the Regenerate property. The backing field for the Annotate property. The backing field for the Ordinate property. The backing field for the Dimension property. Gets the Regenerate Group property. Gets the Ordinate Group property. Gets the Modify Group property. Gets the Dimension Group property. Gets the Annotate Group property. The backing field for the BreakIntoLines property. The backing field for the MultiEdit property. The backing field for the ConvertLegacyNote property. The backing field for the AlignNote property. Gets the MultiEdit Command property. Gets the ConvertLegacyNote Command property. Gets the BreakIntoLines Command property. Gets the AlignNote Command property. Default constructor. Represents the BreakIntoLinesCommand. Default constructor. Represents the MultiEditCommand. Default constructor. Represents the ConvertLegacyNoteCommand. Default constructor. Represents the AlignNoteCommand. Default constructor. Represents the Modify Group. The backing field for the All property. The backing field for the Select property. The backing field for the Associative property. The backing field for the Validate property. The backing field for the Automatic property. Gets the Validate Command property. Gets the Select Command property. Gets the Automatic Command property. Gets the Associative Command property. Gets the All Command property. Default constructor. Represents the AllCommand. Default constructor. Represents the SelectCommand. Default constructor. Represents the AssociativeCommand. Default constructor. Represents the ValidateCommand. Default constructor. Represents the AutomaticCommand. Default constructor. Represents the Regenerate Group. The backing field for the WitnessLine property. The backing field for the Leader property. The backing field for the CrossHatch property. The backing field for the HoleTable property. The backing field for the Note property. Gets the WitnessLine Command property. Gets the Note Command property. Gets the Leader Command property. Gets the HoleTable Command property. Gets the CrossHatch Command property. Default constructor. Represents the WitnessLineCommand. Default constructor. Represents the LeaderCommand. Default constructor. Represents the CrossHatchCommand. Default constructor. Represents the HoleTableCommand. Default constructor. Represents the NoteCommand. Default constructor. Represents the Annotate Group. The backing field for the Parallel property. The backing field for the Align property. The backing field for the Window property. The backing field for the AddToExisting property. The backing field for the Vertical property. The backing field for the Horizontal property. Gets the Window Command property. Gets the Vertical Command property. Gets the Parallel Command property. Gets the Horizontal Command property. Gets the Align Command property. Gets the AddToExisting Command property. Default constructor. Represents the ParallelCommand. Default constructor. Represents the AlignCommand. Default constructor. Represents the WindowCommand. Default constructor. Represents the AddToExistingCommand. Default constructor. Represents the VerticalCommand. Default constructor. Represents the HorizontalCommand. Default constructor. Represents the Ordinate Group. The backing field for the DraftingOptions property. The backing field for the Tangent property. The backing field for the Chained property. The backing field for the Baseline property. The backing field for the Perpendicular property. The backing field for the Parallel property. The backing field for the Angular property. The backing field for the Point property. The backing field for the Circular property. The backing field for the Vertical property. The backing field for the Horizontal property. The backing field for the SmartDimension property. Gets the Vertical Command property. Gets the Tangent Command property. Gets the SmartDimension Command property. Gets the Point Command property. Gets the Perpendicular Command property. Gets the Parallel Command property. Gets the Horizontal Command property. Gets the DraftingOptions Command property. Gets the Circular Command property. Gets the Chained Command property. Gets the Baseline Command property. Gets the Angular Command property. Default constructor. Represents the DraftingOptionsCommand. Default constructor. Represents the TangentCommand. Default constructor. Represents the ChainedCommand. Default constructor. Represents the BaselineCommand. Default constructor. Represents the PerpendicularCommand. Default constructor. Represents the ParallelCommand. Default constructor. Represents the AngularCommand. Default constructor. Represents the PointCommand. Default constructor. Represents the CircularCommand. Default constructor. Represents the VerticalCommand. Default constructor. Represents the HorizontalCommand. Default constructor. Represents the SmartDimensionCommand. Default constructor. Represents the Dimension Group. Default constructor. Represents the Drafting Tab. The backing field for the Color property. The backing field for the Analyze property. The backing field for the Modify property. The backing field for the Create property. The backing field for the Simple property. Gets the Simple Group property. Gets the Modify Group property. Gets the Create Group property. Gets the Color Group property. Gets the Analyze Group property. The backing field for the ChangeFacet property. The backing field for the ClearAll property. Gets the ClearAll Command property. Gets the ChangeFacet Command property. Default constructor. Represents the ChangeFacetCommand. Default constructor. Represents the ClearAllCommand. Default constructor. Represents the Color Group. The backing field for the CheckMesh property. Gets the CheckMesh Command property. Default constructor. Represents the CheckMeshCommand. Default constructor. Represents the Analyze Group. The backing field for the TrimToChain property. The backing field for the TrimToSurfaceSheet property. The backing field for the TrimToPlane property. The backing field for the ModifyMeshFacets property. The backing field for the ExplodeMesh property. The backing field for the Decimation property. The backing field for the Refine property. The backing field for the SmoothArea property. The backing field for the FillHoles property. The backing field for the SmoothFreeEdges property. Gets the TrimToSurfaceSheet Command property. Gets the TrimToPlane Command property. Gets the TrimToChain Command property. Gets the SmoothFreeEdges Command property. Gets the SmoothArea Command property. Gets the Refine Command property. Gets the ModifyMeshFacets Command property. Gets the FillHoles Command property. Gets the ExplodeMesh Command property. Gets the Decimation Command property. Default constructor. Represents the TrimToChainCommand. Default constructor. Represents the TrimToSurfaceSheetCommand. Default constructor. Represents the TrimToPlaneCommand. Default constructor. Represents the ModifyMeshFacetsCommand. Default constructor. Represents the ExplodeMeshCommand. Default constructor. Represents the DecimationCommand. Default constructor. Represents the RefineCommand. Default constructor. Represents the SmoothAreaCommand. Default constructor. Represents the FillHolesCommand. Default constructor. Represents the SmoothFreeEdgesCommand. Default constructor. Represents the Modify Group. The backing field for the OffsetMesh property. The backing field for the MeshesFromEntities property. Gets the OffsetMesh Command property. Gets the MeshesFromEntities Command property. Default constructor. Represents the OffsetMeshCommand. Default constructor. Represents the MeshesFromEntitiesCommand. Default constructor. Represents the Create Group. The backing field for the Torus property. The backing field for the Cone property. The backing field for the Sphere property. The backing field for the Block property. The backing field for the Cylinder property. Gets the Torus Command property. Gets the Sphere Command property. Gets the Cylinder Command property. Gets the Cone Command property. Gets the Block Command property. Default constructor. Represents the TorusCommand. Default constructor. Represents the ConeCommand. Default constructor. Represents the SphereCommand. Default constructor. Represents the BlockCommand. Default constructor. Represents the CylinderCommand. Default constructor. Represents the Simple Group. Default constructor. Represents the Mesh Tab. The backing field for the Color property. The backing field for the Layout property. The backing field for the Modify property. The backing field for the DirectEditing property. The backing field for the Create property. Gets the Modify Group property. Gets the Layout Group property. Gets the DirectEditing Group property. Gets the Create Group property. Gets the Color Group property. The backing field for the SetFeature property. The backing field for the ClearFeature property. The backing field for the ChangeFace property. The backing field for the ClearAll property. Gets the SetFeature Command property. Gets the ClearFeature Command property. Gets the ClearAll Command property. Gets the ChangeFace Command property. Default constructor. Represents the SetFeatureCommand. Default constructor. Represents the ClearFeatureCommand. Default constructor. Represents the ChangeFaceCommand. Default constructor. Represents the ClearAllCommand. Default constructor. Represents the Color Group. The backing field for the SolidPosition property. The backing field for the AlignToZ property. The backing field for the AlignToFace property. The backing field for the AlignToPlane property. The backing field for the Disassemble property. Gets the SolidPosition Command property. Gets the Disassemble Command property. Gets the AlignToZ Command property. Gets the AlignToPlane Command property. Gets the AlignToFace Command property. Default constructor. Represents the SolidPositionCommand. Default constructor. Represents the AlignToZCommand. Default constructor. Represents the AlignToFaceCommand. Default constructor. Represents the AlignToPlaneCommand. Default constructor. Represents the DisassembleCommand. Default constructor. Represents the Layout Group. The backing field for the SimplifySolid property. The backing field for the AddHistory property. The backing field for the RemoveHistory property. The backing field for the FindHoles property. The backing field for the RemoveFillets property. The backing field for the RemoveFaces property. The backing field for the ModifyFillet property. The backing field for the ModifyFeature property. Gets the SimplifySolid Command property. Gets the RemoveHistory Command property. Gets the RemoveFillets Command property. Gets the RemoveFaces Command property. Gets the ModifyFillet Command property. Gets the ModifyFeature Command property. Gets the FindHoles Command property. Gets the AddHistory Command property. Default constructor. Represents the SimplifySolidCommand. Default constructor. Represents the AddHistoryCommand. Default constructor. Represents the RemoveHistoryCommand. Default constructor. Represents the FindHolesCommand. Default constructor. Represents the RemoveFilletsCommand. Default constructor. Represents the RemoveFacesCommand. Default constructor. Represents the ModifyFilletCommand. Default constructor. Represents the ModifyFeatureCommand. Default constructor. Represents the Modify Group. The backing field for the SplitSolidFaces property. The backing field for the Move property. The backing field for the PushPull property. Gets the SplitSolidFaces Command property. Gets the PushPull Command property. Gets the Move Command property. Default constructor. Represents the SplitSolidFacesCommand. Default constructor. Represents the MoveCommand. Default constructor. Represents the PushPullCommand. Default constructor. Represents the Direct Editing Group. The backing field for the HoleAxis property. Gets the HoleAxis Command property. Default constructor. Represents the HoleAxisCommand. Default constructor. Represents the Create Group. Default constructor. Represents the Model Prep Tab. The backing field for the Drawing property. The backing field for the Modify property. The backing field for the Create property. The backing field for the Simple property. Gets the Simple Group property. Gets the Modify Group property. Gets the Drawing Group property. Gets the Create Group property. The backing field for the Layout property. Gets the Layout Command property. Default constructor. Represents the LayoutCommand. Default constructor. Represents the Drawing Group. The backing field for the TrimToSurfaceSheet property. The backing field for the TrimToPlane property. The backing field for the DraftFaces property. The backing field for the Thicken property. The backing field for the Shell property. The backing field for the OneDistanceChamfer property. The backing field for the ConstantFillet property. Gets the TrimToSurfaceSheet Command property. Gets the TrimToPlane Command property. Gets the Thicken Command property. Gets the Shell Command property. Gets the OneDistanceChamfer Command property. Gets the DraftFaces Command property. Gets the ConstantFillet Command property. Default constructor. Represents the TrimToSurfaceSheetCommand. Default constructor. Represents the TrimToPlaneCommand. Default constructor. Represents the DraftFacesCommand. Default constructor. Represents the ThickenCommand. Default constructor. Represents the ShellCommand. Default constructor. Represents the OneDistanceChamferCommand. Default constructor. Represents the ConstantFilletCommand. Default constructor. Represents the Modify Group. The backing field for the SolidsFromSurfaces property. The backing field for the ManualPattern property. The backing field for the CircularPattern property. The backing field for the RectangularPattern property. The backing field for the Hole property. The backing field for the Impression property. The backing field for the Boolean property. The backing field for the Sweep property. The backing field for the Loft property. The backing field for the Revolve property. The backing field for the Extrude property. Gets the Sweep Command property. Gets the SolidsFromSurfaces Command property. Gets the Revolve Command property. Gets the RectangularPattern Command property. Gets the ManualPattern Command property. Gets the Loft Command property. Gets the Impression Command property. Gets the Hole Command property. Gets the Extrude Command property. Gets the CircularPattern Command property. Gets the Boolean Command property. Default constructor. Represents the SolidsFromSurfacesCommand. Default constructor. Represents the ManualPatternCommand. Default constructor. Represents the CircularPatternCommand. Default constructor. Represents the RectangularPatternCommand. Default constructor. Represents the HoleCommand. Default constructor. Represents the ImpressionCommand. Default constructor. Represents the BooleanCommand. Default constructor. Represents the SweepCommand. Default constructor. Represents the LoftCommand. Default constructor. Represents the RevolveCommand. Default constructor. Represents the ExtrudeCommand. Default constructor. Represents the Create Group. The backing field for the Torus property. The backing field for the Cone property. The backing field for the Sphere property. The backing field for the Block property. The backing field for the Cylinder property. Gets the Torus Command property. Gets the Sphere Command property. Gets the Cylinder Command property. Gets the Cone Command property. Gets the Block Command property. Default constructor. Represents the TorusCommand. Default constructor. Represents the ConeCommand. Default constructor. Represents the SphereCommand. Default constructor. Represents the BlockCommand. Default constructor. Represents the CylinderCommand. Default constructor. Represents the Simple Group. Default constructor. Represents the Solids Tab. The backing field for the Normals property. The backing field for the Flowline property. The backing field for the Modify property. The backing field for the Create property. The backing field for the Simple property. Gets the Simple Group property. Gets the Normals Group property. Gets the Modify Group property. Gets the Flowline Group property. Gets the Create Group property. The backing field for the Orient property. The backing field for the Set property. The backing field for the Change property. Gets the Set Command property. Gets the Orient Command property. Gets the Change Command property. Default constructor. Represents the OrientCommand. Default constructor. Represents the SetCommand. Default constructor. Represents the ChangeCommand. Default constructor. Represents the Normals Group. The backing field for the ReflowUV property. The backing field for the OverflowUV property. The backing field for the EditUV property. Gets the ReflowUV Command property. Gets the OverflowUV Command property. Gets the EditUV Command property. Default constructor. Represents the ReflowUVCommand. Default constructor. Represents the OverflowUVCommand. Default constructor. Represents the EditUVCommand. Default constructor. Represents the Flowline Group. The backing field for the EditSurface property. The backing field for the Split property. The backing field for the Untrim property. The backing field for the ThreeFilletBlend property. The backing field for the ThreeSurfaceBlend property. The backing field for the TwoSurfaceBlend property. The backing field for the FilletToSurfaces property. The backing field for the Extend property. The backing field for the FillHoles property. The backing field for the TrimToCurves property. Gets the Untrim Command property. Gets the TwoSurfaceBlend Command property. Gets the TrimToCurves Command property. Gets the ThreeSurfaceBlend Command property. Gets the ThreeFilletBlend Command property. Gets the Split Command property. Gets the FillHoles Command property. Gets the FilletToSurfaces Command property. Gets the Extend Command property. Gets the EditSurface Command property. Default constructor. Represents the EditSurfaceCommand. Default constructor. Represents the SplitCommand. Default constructor. Represents the UntrimCommand. Default constructor. Represents the ThreeFilletBlendCommand. Default constructor. Represents the ThreeSurfaceBlendCommand. Default constructor. Represents the TwoSurfaceBlendCommand. Default constructor. Represents the FilletToSurfacesCommand. Default constructor. Represents the ExtendCommand. Default constructor. Represents the FillHolesCommand. Default constructor. Represents the TrimToCurvesCommand. Default constructor. Represents the Modify Group. The backing field for the PowerSurface property. The backing field for the Fence property. The backing field for the Offset property. The backing field for the Net property. The backing field for the Draft property. The backing field for the Revolve property. The backing field for the Sweep property. The backing field for the Extrude property. The backing field for the Loft property. The backing field for the FlatBoundary property. The backing field for the SurfacesFromSolids property. Gets the Sweep Command property. Gets the SurfacesFromSolids Command property. Gets the Revolve Command property. Gets the PowerSurface Command property. Gets the Offset Command property. Gets the Net Command property. Gets the Loft Command property. Gets the FlatBoundary Command property. Gets the Fence Command property. Gets the Extrude Command property. Gets the Draft Command property. Default constructor. Represents the PowerSurfaceCommand. Default constructor. Represents the FenceCommand. Default constructor. Represents the OffsetCommand. Default constructor. Represents the NetCommand. Default constructor. Represents the DraftCommand. Default constructor. Represents the RevolveCommand. Default constructor. Represents the SweepCommand. Default constructor. Represents the ExtrudeCommand. Default constructor. Represents the LoftCommand. Default constructor. Represents the FlatBoundaryCommand. Default constructor. Represents the SurfacesFromSolidsCommand. Default constructor. Represents the Create Group. The backing field for the Torus property. The backing field for the Cone property. The backing field for the Sphere property. The backing field for the Block property. The backing field for the Cylinder property. Gets the Torus Command property. Gets the Sphere Command property. Gets the Cylinder Command property. Gets the Cone Command property. Gets the Block Command property. Default constructor. Represents the TorusCommand. Default constructor. Represents the ConeCommand. Default constructor. Represents the SphereCommand. Default constructor. Represents the BlockCommand. Default constructor. Represents the CylinderCommand. Default constructor. Represents the Simple Group. Default constructor. Represents the Surfaces Tab. The backing field for the Modify property. The backing field for the Curves property. The backing field for the Shapes property. The backing field for the Splines property. The backing field for the Arcs property. The backing field for the Lines property. The backing field for the Points property. Gets the Splines Group property. Gets the Shapes Group property. Gets the Points Group property. Gets the Modify Group property. Gets the Lines Group property. Gets the Curves Group property. Gets the Arcs Group property. The backing field for the RefitSpline property. The backing field for the CombineViews property. The backing field for the CloseArc property. The backing field for the Project property. The backing field for the OffsetEntity property. The backing field for the ChamferEntities property. The backing field for the FilletEntities property. The backing field for the ModifyLength property. The backing field for the JoinEntities property. The backing field for the Divide property. The backing field for the BreakTwoPieces property. The backing field for the TrimToEntities property. The backing field for the DynamicTrim property. Gets the TrimToEntities Command property. Gets the RefitSpline Command property. Gets the Project Command property. Gets the OffsetEntity Command property. Gets the ModifyLength Command property. Gets the JoinEntities Command property. Gets the FilletEntities Command property. Gets the DynamicTrim Command property. Gets the Divide Command property. Gets the CombineViews Command property. Gets the CloseArc Command property. Gets the ChamferEntities Command property. Gets the BreakTwoPieces Command property. Default constructor. Represents the RefitSplineCommand. Default constructor. Represents the CombineViewsCommand. Default constructor. Represents the CloseArcCommand. Default constructor. Represents the ProjectCommand. Default constructor. Represents the OffsetEntityCommand. Default constructor. Represents the ChamferEntitiesCommand. Default constructor. Represents the FilletEntitiesCommand. Default constructor. Represents the ModifyLengthCommand. Default constructor. Represents the JoinEntitiesCommand. Default constructor. Represents the DivideCommand. Default constructor. Represents the BreakTwoPiecesCommand. Default constructor. Represents the TrimToEntitiesCommand. Default constructor. Represents the DynamicTrimCommand. Default constructor. Represents the Modify Group. The backing field for the CurveSliceByPlane property. The backing field for the CurveAllEdges property. The backing field for the CurveOneEdge property. Gets the CurveSliceByPlane Command property. Gets the CurveOneEdge Command property. Gets the CurveAllEdges Command property. Default constructor. Represents the CurveSliceByPlaneCommand. Default constructor. Represents the CurveAllEdgesCommand. Default constructor. Represents the CurveOneEdgeCommand. Default constructor. Represents the Curves Group. The backing field for the DoorGeometry property. The backing field for the StairGeometry property. The backing field for the RasterToVector property. The backing field for the ReliefGroove property. The backing field for the TurnProfile property. The backing field for the SilhouetteBoundary property. The backing field for the BoundingBox property. The backing field for the CreateLetters property. The backing field for the Rectangle property. Gets the TurnProfile Command property. Gets the StairGeometry Command property. Gets the SilhouetteBoundary Command property. Gets the ReliefGroove Command property. Gets the Rectangle Command property. Gets the RasterToVector Command property. Gets the DoorGeometry Command property. Gets the CreateLetters Command property. Gets the BoundingBox Command property. Default constructor. Represents the DoorGeometryCommand. Default constructor. Represents the StairGeometryCommand. Default constructor. Represents the RasterToVectorCommand. Default constructor. Represents the ReliefGrooveCommand. Default constructor. Represents the TurnProfileCommand. Default constructor. Represents the SilhouetteBoundaryCommand. Default constructor. Represents the BoundingBoxCommand. Default constructor. Represents the CreateLettersCommand. Default constructor. Represents the RectangleCommand. Default constructor. Represents the Shapes Group. The backing field for the SplineManual property. Gets the SplineManual Command property. Default constructor. Represents the SplineManualCommand. Default constructor. Represents the Splines Group. The backing field for the CircleEdgePoint property. The backing field for the ArcTangent property. The backing field for the Arc3Points property. The backing field for the CircleCenterPoint property. Gets the CircleEdgePoint Command property. Gets the CircleCenterPoint Command property. Gets the ArcTangent Command property. Gets the Arc3Points Command property. Default constructor. Represents the CircleEdgePointCommand. Default constructor. Represents the ArcTangentCommand. Default constructor. Represents the Arc3PointsCommand. Default constructor. Represents the CircleCenterPointCommand. Default constructor. Represents the Arcs Group. The backing field for the LineClosest property. The backing field for the LinePerpendicular property. The backing field for the LineParallel property. The backing field for the LineEndpoints property. Gets the LinePerpendicular Command property. Gets the LineParallel Command property. Gets the LineEndpoints Command property. Gets the LineClosest Command property. Default constructor. Represents the LineClosestCommand. Default constructor. Represents the LinePerpendicularCommand. Default constructor. Represents the LineParallelCommand. Default constructor. Represents the LineEndpointsCommand. Default constructor. Represents the Lines Group. The backing field for the BoltCircle property. The backing field for the PointPosition property. Gets the PointPosition Command property. Gets the BoltCircle Command property. Default constructor. Represents the BoltCircleCommand. Default constructor. Represents the PointPositionCommand. Default constructor. Represents the Points Group. Default constructor. Represents the Wireframe Tab. The backing field for the AddIns property. The backing field for the Analyze property. The backing field for the Display property. The backing field for the Delete property. The backing field for the Organize property. The backing field for the Attributes property. The backing field for the Clipboard property. Gets the Organize Group property. Gets the Display Group property. Gets the Delete Group property. Gets the Clipboard Group property. Gets the Attributes Group property. Gets the Analyze Group property. Gets the AddIns Group property. The backing field for the AddInPathOptions property. The backing field for the CommandFinder property. The backing field for the NETScriptEditor property. The backing field for the RunMastercamAddIn property. Gets the RunMastercamAddIn Command property. Gets the NETScriptEditor Command property. Gets the CommandFinder Command property. Gets the AddInPathOptions Command property. Default constructor. Represents the AddInPathOptionsCommand. Default constructor. Represents the CommandFinderCommand. Default constructor. Represents the NETScriptEditorCommand. Default constructor. Represents the RunMastercamAddInCommand. Default constructor. Represents the Add-Ins Group. The backing field for the PointToCurve property. The backing field for the CurveToCurve property. The backing field for the PointToSurface property. The backing field for the CurveToSurface property. The backing field for the SurfaceToSurface property. The backing field for the Statistics property. The backing field for the TwoDArea property. The backing field for the CheckSolid property. The backing field for the Chain property. The backing field for the Angle property. The backing field for the Dynamic property. The backing field for the AnalyzeToolpath property. The backing field for the AnalyzeDistance property. The backing field for the AnalyzeEntity property. Gets the TwoDArea Command property. Gets the SurfaceToSurface Command property. Gets the Statistics Command property. Gets the PointToSurface Command property. Gets the PointToCurve Command property. Gets the Dynamic Command property. Gets the CurveToSurface Command property. Gets the CurveToCurve Command property. Gets the CheckSolid Command property. Gets the Chain Command property. Gets the Angle Command property. Gets the AnalyzeToolpath Command property. Gets the AnalyzeEntity Command property. Gets the AnalyzeDistance Command property. Default constructor. Represents the PointToCurveCommand. Default constructor. Represents the CurveToCurveCommand. Default constructor. Represents the PointToSurfaceCommand. Default constructor. Represents the CurveToSurfaceCommand. Default constructor. Represents the SurfaceToSurfaceCommand. Default constructor. Represents the StatisticsCommand. Default constructor. Represents the TwoDAreaCommand. Default constructor. Represents the CheckSolidCommand. Default constructor. Represents the ChainCommand. Default constructor. Represents the AngleCommand. Default constructor. Represents the DynamicCommand. Default constructor. Represents the AnalyzeToolpathCommand. Default constructor. Represents the AnalyzeDistanceCommand. Default constructor. Represents the AnalyzeEntityCommand. Default constructor. Represents the Analyze Group. The backing field for the GeometryDisplayOptions property. The backing field for the Blank property. The backing field for the Endpoints property. The backing field for the ArcCenterPoints property. The backing field for the HideUnhide property. Gets the HideUnhide Command property. Gets the GeometryDisplayOptions Command property. Gets the Endpoints Command property. Gets the Blank Command property. Gets the ArcCenterPoints Command property. Default constructor. Represents the GeometryDisplayOptionsCommand. Default constructor. Represents the BlankCommand. Default constructor. Represents the EndpointsCommand. Default constructor. Represents the ArcCenterPointsCommand. Default constructor. Represents the HideUnhideCommand. Default constructor. Represents the Display Group. The backing field for the UndeleteEntity property. The backing field for the Duplicates property. The backing field for the NonAssociative property. The backing field for the DeleteEntities property. Gets the UndeleteEntity Command property. Gets the NonAssociative Command property. Gets the Duplicates Command property. Gets the DeleteEntities Command property. Default constructor. Represents the UndeleteEntityCommand. Default constructor. Represents the DuplicatesCommand. Default constructor. Represents the NonAssociativeCommand. Default constructor. Represents the DeleteEntitiesCommand. Default constructor. Represents the Delete Group. The backing field for the ChangeLevel property. The backing field for the SelectZDepth property. Gets the SelectZDepth Command property. Gets the ChangeLevel Command property. Default constructor. Represents the ChangeLevelCommand. Default constructor. Represents the SelectZDepthCommand. Default constructor. Represents the Organize Group. The backing field for the GlassLevel7 property. The backing field for the GlassLevel6 property. The backing field for the GlassLevel5 property. The backing field for the GlassLevel4 property. The backing field for the GlassLevel3 property. The backing field for the GlassLevel2 property. The backing field for the GlassLevel1 property. The backing field for the PlasticLevel7 property. The backing field for the PlasticLevel6 property. The backing field for the PlasticLevel5 property. The backing field for the PlasticLevel4 property. The backing field for the PlasticLevel3 property. The backing field for the PlasticLevel2 property. The backing field for the PlasticLevel1 property. The backing field for the MetalLevel7 property. The backing field for the MetalLevel6 property. The backing field for the MetalLevel5 property. The backing field for the MetalLevel4 property. The backing field for the MetalLevel3 property. The backing field for the MetalLevel2 property. The backing field for the MetalLevel1 property. The backing field for the SetAll property. The backing field for the SetFromEntity property. The backing field for the ClearColors property. The backing field for the MeshColor property. The backing field for the SurfaceColor property. The backing field for the SolidColor property. The backing field for the WireframeColor property. The backing field for the CPlane2D3D property. The backing field for the LineWidth property. The backing field for the LineStyle property. The backing field for the PointStyle property. The backing field for the EntityAttributes property. Gets the WireframeColor Command property. Gets the SurfaceColor Command property. Gets the SolidColor Command property. Gets the SetFromEntity Command property. Gets the SetAll Command property. Gets the PointStyle Command property. Gets the PlasticLevel7 Command property. Gets the PlasticLevel6 Command property. Gets the PlasticLevel5 Command property. Gets the PlasticLevel4 Command property. Gets the PlasticLevel3 Command property. Gets the PlasticLevel2 Command property. Gets the PlasticLevel1 Command property. Gets the MetalLevel7 Command property. Gets the MetalLevel6 Command property. Gets the MetalLevel5 Command property. Gets the MetalLevel4 Command property. Gets the MetalLevel3 Command property. Gets the MetalLevel2 Command property. Gets the MetalLevel1 Command property. Gets the MeshColor Command property. Gets the LineWidth Command property. Gets the LineStyle Command property. Gets the GlassLevel7 Command property. Gets the GlassLevel6 Command property. Gets the GlassLevel5 Command property. Gets the GlassLevel4 Command property. Gets the GlassLevel3 Command property. Gets the GlassLevel2 Command property. Gets the GlassLevel1 Command property. Gets the EntityAttributes Command property. Gets the CPlane2D3D Command property. Gets the ClearColors Command property. Default constructor. Represents the GlassLevel7Command. Default constructor. Represents the GlassLevel6Command. Default constructor. Represents the GlassLevel5Command. Default constructor. Represents the GlassLevel4Command. Default constructor. Represents the GlassLevel3Command. Default constructor. Represents the GlassLevel2Command. Default constructor. Represents the GlassLevel1Command. Default constructor. Represents the PlasticLevel7Command. Default constructor. Represents the PlasticLevel6Command. Default constructor. Represents the PlasticLevel5Command. Default constructor. Represents the PlasticLevel4Command. Default constructor. Represents the PlasticLevel3Command. Default constructor. Represents the PlasticLevel2Command. Default constructor. Represents the PlasticLevel1Command. Default constructor. Represents the MetalLevel7Command. Default constructor. Represents the MetalLevel6Command. Default constructor. Represents the MetalLevel5Command. Default constructor. Represents the MetalLevel4Command. Default constructor. Represents the MetalLevel3Command. Default constructor. Represents the MetalLevel2Command. Default constructor. Represents the MetalLevel1Command. Default constructor. Represents the SetAllCommand. Default constructor. Represents the SetFromEntityCommand. Default constructor. Represents the ClearColorsCommand. Default constructor. Represents the MeshColorCommand. Default constructor. Represents the SurfaceColorCommand. Default constructor. Represents the SolidColorCommand. Default constructor. Represents the WireframeColorCommand. Default constructor. Represents the CPlane2D3DCommand. Default constructor. Represents the LineWidthCommand. Default constructor. Represents the LineStyleCommand. Default constructor. Represents the PointStyleCommand. Default constructor. Represents the EntityAttributesCommand. Default constructor. Represents the Attributes Group. The backing field for the CopyImage property. The backing field for the Copy property. The backing field for the Cut property. The backing field for the Paste property. Gets the Paste Command property. Gets the Cut Command property. Gets the CopyImage Command property. Gets the Copy Command property. Default constructor. Represents the CopyImageCommand. Default constructor. Represents the CopyCommand. Default constructor. Represents the CutCommand. Default constructor. Represents the PasteCommand. Default constructor. Represents the Clipboard Group. Default constructor. Represents the Home Tab. Represents Ribbon Customization Categories. This is based off of the concepts in Ribbon Customization Dialog. Run the command. Constructor. The application. The command. Represents a command that can be executed from the Ribbon UI. Encapsulates the application and command name, and provides a method to execute the command via the ExternalAppsManager. Used as a base class for all Ribbon commands. Display the Planes list allowing the user to select one. The MCView data for the selected Plane, else null if not selection was made. Updates the plane manager dialog. Gets or sets the current construction depth. Gets or set the plane (view) coordinate display mode. MILL_COORD, LATHE_COORD_X or LATHE_COORD_D. If the setting value is not one of the these valid choices - The setting will default to the MILL_COORD display. 0 = MILL_COORD for Mill coordinates: XYZ 1 = LATHE_COORD_X for Lathe radial coordinates: XZY 2 = LATHE_COORD_D for Lathe diameter coordinates: DZY Gets or sets a value indicating the setting of the 'Set Cplane follow WCS' rule'. true to enable, false to disable. Gets or sets a value indicating the setting of the 'Set Gplane follow WCS' rule'. true to enable, false to disable. Gets or sets a value indicating the setting of the 'Set Cplane to TOP when Gplane is set to ISO rule'. true to enable, false to disable. Gets or sets a value indicating the setting of the 'Cplane follow Gplane rule'. true to enable, false to disable. Gets or sets the current WCS view. Gets or sets the current tool plane view. Gets or sets the current construction plane view. Gets or sets the current graphics view. Gets all of the named planes (views) in the database. True to exclude, false to include the system views. A list of all views. Sets the (other) planes equal to current WCS. Equivalent to selecting 'Planes = WCS' from StatusBar Planes option. This method converts a given set of 3D world coordinates to view coordinates. The world coordinates to convert to view coordinates. The view the input coordinates are being transformed to. If the supplied View does not identify a "valid" defined view, the view used will default to the active construction plane. The converted view coordinates. This method converts a given set of 3D world coordinates to view coordinates. Use this method for transforming coordinates when you have a View 'Number'. (e.g. An Arc Geometry's ) The world coordinates to convert to view coordinates. The view number of the view the input coordinates are being transformed to. If the supplied View Number does not identify a "valid" defined view, the view used will default to the active construction plane. The converted view coordinates. This method converts a given set of 3D world coordinates to view coordinates. Converts the world coordinates assuming the point is to be converted to the current construction plane view. The world coordinates to convert to view coordinates. The converted view coordinates. This method converts a given set of 3D view coordinates to world coordinates. The view coordinates to convert to world coordinates. The view the input coordinates are being transformed from. If the supplied View does not identify a "valid" defined view, the view used will default to the active construction plane. The converted world coordinates. This method converts a given set of 3D view coordinates to world coordinates. Use this method for transforming coordinates when you have a View 'Number'. (e.g. An Arc Geometry's ) The view coordinates to convert to world coordinates. The view number of the view the input coordinates are being transformed from. If the supplied View Number does not identify a "valid" defined view, the view used will default to the active construction plane. The converted world coordinates. This method converts a given set of 3D view coordinates to world coordinates. Converts the view coordinates assuming they're in the current construction plane view. The view coordinates to convert to world coordinates. The converted world coordinates. Query if the origin of the specified ViewType is enabled. (a non-zero origin) Even though GPlane is a ViewType, it does not have an origin. If given ViewType.GPLANE, this will always return false. The type of the view to query (CPLANE, TPLANE or WCSPLANE). True if the origin is a non-zero origin point, false if not. This method determines whether or not the current construction view is 3D or not. True if the current construction view is 3D and false if not. Private Manager Constructor. Made private so as not to allow anyone to create an instance of it. This class handles the interaction and manipulation of Mastercam view settings. Select link plane. The plane IDs to check for linking. The linkable result IDs. A long parent ID. Select a Plane from a list of matching planes relative to the active WCS. Set to true if user cancels from the select plane list. Matrix to match before adding active WCS. Origin in world coordinates to match before adding active WCS. MastercamPlanes object to work in. (Optional) If non-null the MainWnd, (Optional) the parent. return the selected Plane's ID. Select plane from list. Type of the plane. (Optional) the ID of the preselected Plane in the dialog. [in,out] (Optional) If non-null the MainWnd, (Optional) the parent. (Optional) >0 = only Planes parallel with this view will be listed, -1 = parallel to preSelectedPlaneID. (Optional) Opposite, All, Same. return the selected Plane's ID. Select plane from geometry. the MastercamPlanes object to extract a plane from. return the selected Plane's ID. Select plane from list. array of plane ID's to load into list control. (Optional) the ID of the preselected Plane in the dialog. (Optional) If non-null the MainWnd, (Optional) the parent. (Optional) >0 = only Planes parallel with this view will be listed, -1 = parallel to preSelectedPlaneID. (Optional) Opposite, All, Same. return the selected Plane's ID. Select plane from list. (Optional) the ID of the preselected Plane in the dialog. (Optional) If non-null the MainWnd, (Optional) the parent. (Optional) >0 = only Planes parallel with this view will be listed, -1 = parallel to preSelectedPlaneID. (Optional) Opposite, All, Same. return the selected Plane's ID. Gets or sets the location of the ending point for drawing this cone primitive solid as an angle, in degrees, from the base point. Gets or sets the location of the starting point for drawing this cone primitive solid as an angle, in degrees, from the base point. Gets or sets the height of the cone, from the base point (specifically, the base point's Y value) to the top of the cone. Gets or sets the distance of the outer edge of the cone from the center of the cone at the very top of the cone, set by this cone's height value. Gets or sets the distance of the outer edge of the cone from this cone's base point at the base of the cone. Initializes a new instance of the ConeSolid class. This constructs a new conical solid object with default parameters. The default parameters of a conical solid are for a full (360 degree) cone with the center at the WCS origin, (0.0, 0.0, 0.0), with a radius at the base of 0.5 and at the top of 0.0, and with a height of 1.0. Loads the default values for a given solid geometry object. Loads the default values for a given solid geometry object from the solid geometry entity passed in. [in,out] The geometry entity to use as defaults for this solid geometry object. Commits a solid geometry entity to the Mastercam database. [in,out] The solid geometry entity to be committed. [in,out] The solid parameters to initialize the object with. True if the commit was successful; false if not. Initializes a new instance of the ConeSolid class. Attempts to retrieve a solid geometry entity with the given ID from the Mastercam database and use that to initialize this solid geometry object. If no matching solid geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the solid geometry entity to look up in the Mastercam database. This class is used for working with cone shaped primitive solids. This method deletes all duplicates in the current drawing. true for silent (no dialog) operation. This method combines arcs in parallel views. Initializes a new instance of the GeometryInteractionManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used for performing graphics-related tasks and activities. Computes the relative position of stock origin given the corner points of stock and origin in WCS. Also computes the size of bounding box Corner point 1. Corner point 2. View orientation. The origin relative to which the function finds the stock center. Stock origin defined by user. Stock origin defined by user. Stock origin defined by user. Stock origin defined by user. Stock bounding box dimension in X direction. Stock bounding box dimension in Y direction. Stock bounding box dimension in Z direction. Gets a Machine Group. Identifier for the group. If '0' it gets the active Machine Group. Null if it fails, else the machine group. Calculates the Stock Origin and Size. [out] The lower-left point. [out] The upper-right point. The Plane view number. The stock origin location. [in/out] The origin point. [out] Size of the stock. Sets the stock to a all geometry of a specific type. The geometry mask. Identifier for the machine group. True if it succeeds, false if it fails. Sets the stock using the supplied "extents" points. The lower left. The upper right. Identifier for the machine group. True if it succeeds, false if it fails. Sets the stock to a single entity. Identifier for the entity. The geometry mask. Identifier for the machine group. True if it succeeds, false if it fails. Gets common stock data from the given machine group. Data to set. Machine group information to update. True if data was set successfully. Gets common stock data from the given machine group. Data to populate. Machine group information to populate from. Performs the Unselect All action in the *active Machine Group, which zeros out the stock origin and size data. Identifier for the machine group. True if it succeeds, false if it fails. Performs the Unselect All action in the *active Machine Group, which zeros out the stock origin and size data. True if it succeeds, false if it fails. Sets the Mill Stock in the specified Machine Group to a cylindrical bounding box. Identifier for the machine group. True if it succeeds, false if it fails. Sets the Mill Stock in the *active* Machine Group to a cylindrical bounding box. Identifier for the machine group. The cylinder vector. The radius (X) and height (Y) f the cylinder. True if it succeeds, false if it fails. Sets the Mill Stock in the specified Machine Group to a rectangular bounding box. The lower-left corner. The upper-right corner. Identifier for the machine group. True if it succeeds, false if it fails. Sets the Mill Stock in the *active* Machine Group to a rectangular bounding box. The lower-left corner. The upper-right corner. True if it succeeds, false if it fails. Sets the Mill Stock to a STL file. The (full path) file name of the .STL file. True if it succeeds, false if it fails. Sets the Mill Stock to a STL file. The (full path) file name of the .STL file. True if it succeeds, false if it fails. Sets the Mill Stock in the specified Machine Group to All Entities. Identifier for the machine group. True if it succeeds, false if it fails. Sets the Mill Stock in the *active* Machine Group to All Entities. True if it succeeds, false if it fails. Sets the Mill Stock in the specified Machine Group to All Surfaces. Identifier for the machine group. True if it succeeds, false if it fails. Sets the Mill Stock in the *active* Machine Group to All Surfaces. True if it succeeds, false if it fails. Sets the Mill Stock in the specified Machine Group to All Solids. Identifier for the machine group. True if it succeeds, false if it fails. Sets the Mill Stock in the *active* Machine Group to All Solids. True if it succeeds, false if it fails. Sets the Mill Stock in the specified Machine Group to the 2 points. The lower left. The upper right. Identifier for the machine group. True if it succeeds, false if it fails. Sets the Mill Stock in the *active* Machine Group to the 2 points. The lower left. The upper right. True if it succeeds, false if it fails. Sets the Mill Stock in the specified Machine Group to the NCI extents. Identifier for the machine group. True if it succeeds, false if it fails. Sets the Mill Stock in the *active* Machine Group to the NCI extents. True if it succeeds, false if it fails. Sets the stock to a single Solid or Mesh entity in the specified Machine Group. The geometry entity (Solid or Mesh only!). Identifier for the machine group. True if it succeeds, false if it fails. Sets the stock to a single Solid or Mesh entity in the *active* Machine Group. The geometry entity (Solid or Mesh only!). True if it succeeds, false if it fails. Sets the wire stock data in the machine group with the given id if that machine group is a Wire machine group. Stock data to set in the machine group. True if the data was set, or false if the id is invalid or the machine group is not a Wire machine group. Sets the wire stock data in the active machine group if the active machine group is a Wire machine group. Stock data to set in the machine group. True if the data was set, or false if the active machine group is not a Wire machine group. Sets the Mill Stock Data in the specified Machine Group. The stock data to insert into the Machine Group. The ID# of the Machine Group. True if it succeeds, false if it fails. Sets the Mill Stock Data to the *active* Machine Group. The stock data to insert into the Machine Group. True if it succeeds, false if it fails. Gets the wire stock data for the machine group with the given id if that machine group is a Wire machine group. Id of the Wire machine group. Wire stock data, or null if the id is invalid or the machine group is not a Wire machine group. Gets the wire stock data for the active machine group if the active machine group is a Wire machine group. Wire stock data, or null if the active machine group is not a Wire machine group. Gets the Mill Stock Data from the specified Machine Group. The ID# of the Machine Group. null if it fails, else the stock data. Gets the Mill Stock Data from the active Machine Group. null if it fails, else the stock data. A class to manipulate Mill stock data. Gets or sets the stock origin location. Gets or sets the cylindrical stock anchor. A class of Mill stock data. Gets or sets the stock origin location. Gets or sets the entity ID of the single SOlid or Mesh entity when StockShaoe is SolidOrMesh. Gets or sets the collection of stock arcs. Gets or sets the collection of stock lines. Gets or sets the stock color. Gets or sets the line style. Gets or sets the full path name of the STL file. Gets or sets the height diameter of the cylindrical stock. Gets or sets the diameter of the cylindrical stock. Gets or sets a value indicating whether to center the stock on axis. Gets or sets the cylinder stock axis. Gets or sets a value indicating whether the display the stock as a solid, or as wireframe. (true = Solid, false = Wireframe) Gets or sets a value indicating whether to display the stock. Gets or sets the stock origin. Gets or sets the stock size. Gets or sets a value indicating whether to fit screen to the stock. Gets or sets the stock shape. Gets or sets the stock plane ID. Gets or sets the stock plane name. Initializes a new empty default instance of the MillStockData class. Common data for defining stock. Values that represent cylindrical stock anchors. Values that cylinder axis. Values that represent wire stock origin location point. Values that represent stock origin location point. Values that represent stock shapes. Initializes a new instance of the StringUtilityFailedException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the StringUtilityFailedException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the StringUtilityFailedException class. Initializes the exception instance with a default error message. Initializes a new instance of the StringUtilityFailedException class. If non-null, the serailization information. The context. This exception class was created to be thrown if a string conversion utility failed. Initializes a new instance of the LibraryFreeFailedException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the LibraryFreeFailedException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the LibraryFreeFailedException class. Initializes the exception instance with a default error message. Initializes a new instance of the LibraryFreeFailedException class. If non-null, the serialization information. The context. This exception class was created to be thrown if an attempt to free a library failed. Initializes a new instance of the Contour3DSubtypeException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the Contour3DSubtypeException class. If non-null, the message. Initializes a new instance of the Contour3DSubtypeException class. Initializes the exception instance with a default error message. Initializes a new instance of the Contour3DSubtypeException class. If non-null, the serialization information. The context. This exception class was created to be thrown if an app attempts to use 2D chain geometry in a 3D Contour operation. Initializes a new instance of the Contour2DSubtypeException class. Initializes the exception instance with a specified error message and the inner the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the Contour2DSubtypeException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the Contour2DSubtypeException class. Initializes the exception instance with a default error message. Initializes a new instance of the Contour2DSubtypeException class. If non-null, the serialization information. The context. This exception class was created to be thrown if an application attempts to use 3D chain geometry in a 2D Contour operation. Initializes a new instance of the InvalidArrayIndexException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the InvalidArrayIndexException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the InvalidArrayIndexException class. Initializes the exception instance with a default error message. Initializes a new instance of the InvalidArrayIndexException class. If non-null, the serialization information. The context. This exception class was created to be thrown if an attempt was made to access an array item with an invalid index. Initializes a new instance of the NullParameterEditingDialogException class. Initializes the exception instance with a specified error message and the inner exception that caused it. The message. The inner exception. Initializes a new instance of the NullParameterEditingDialogException class. Initializes the exception instance with a specified error message. The message. Initializes a new instance of the NullParameterEditingDialogException class. Initializes the exception instance with a default error message. Initializes a new instance of the NullParameterEditingDialogException class. If non-null, the serialization information. The context. This exception class was created to be thrown if an attempt was made to launch an editing dialog with a null parameter object. Initializes a new instance of the SolidsNotAllowedException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the SolidsNotAllowedException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the SolidsNotAllowedException class. Initializes the exception instance with a default error message. Initializes a new instance of the SolidsNotAllowedException class. If non-null, the information. The context. This exception class was created to be thrown if solids manipulation and creation is not allowed on the current user's system. Initializes the exception instance with a specified error message and the inner exception that caused it. The message. The inner exception. Initializes the exception instance with a specified error message. The message. Initializes the exception instance with a default error message . Initializes a new instance of the InvalidGroupException class. The serialization information. The context. This exception class was created to be thrown if there is no Machine/Toolpath groups and one is required. Initializes a new instance of the InvalidGroupIDException class. Initializes the exception instance with a specified error message and the inner exception that caused it. The message. The inner exception. Initializes a new instance of the InvalidGroupIDException class. Initializes the exception instance with a specified error message. The message. Initializes a new instance of the InvalidGroupIDException class. Initializes the exception instance with a default error message. Initializes a new instance of the InvalidGroupIDException class. The serialization information. The context. This exception class was created to be thrown if an invalid group ID was referenced. Initializes a new instance of the OutputFileNotSpecifiedException class. Initializes the exception instance with a specified error message and the inner the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the OutputFileNotSpecifiedException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the OutputFileNotSpecifiedException class. Initializes a new instance of the OutputFileNotSpecifiedException class. If non-null, the serialization information. The context. This exception class was created to be thrown if an attempt was made to write to a nesting file without first specifying a filename and path. Initializes a new instance of the TypeMismatchException class. Initializes the exception instance with a specified error message and the inner exception that caused it. [in,out] If non-null, the message. [in,out] If non-null, the inner exception. Initializes a new instance of the TypeMismatchException class. Initializes the exception instance with a specified error message. [in,out] If non-null, the message. Initializes a new instance of the TypeMismatchException class. Initializes the exception instance with a default error message. Initializes a new instance of the TypeMismatchException class. If non-null, the serialization information. The context. This exception class was created to be thrown if there was a type mismatch between a NET-Hook entity object and the entity in the Mastercam database. Initializes a new instance of the EntityReadFailedException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the EntityReadFailedException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the EntityReadFailedException class. Initializes the exception instance with a default error message. Initializes a new instance of the EntityReadFailedException class. If non-null, the serialization information. The context. This exception class was created to be thrown if an attempt to read an entity from the Mastercam database failed for some reason. Initializes a new instance of the EntityWriteFailedException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the EntityWriteFailedException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the EntityWriteFailedException class. Initializes the exception instance with a default error message. Initializes a new instance of the EntityWriteFailedException class. If non-null, the information. The context. This exception class was created to be thrown if an attempt to write an entity to the Mastercam database failed for some reason. Initializes a new instance of the EntityInvalidException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the EntityInvalidException class. Initializes the exception instance with a specified error message. [in,out] If non-null, the message. Initializes a new instance of the EntityInvalidException class. Initializes the exception instance with a default error message. Initializes a new instance of the EntityInvalidException class. If non-null, the serialization information. The context. This exception class was created to be thrown if an entity database operation is attempted on an invalid entity that needs to be valid. (ie. deleting an entity that is invalid to begin with for example). Initializes a new instance of the IDNotFoundException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the IDNotFoundException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the IDNotFoundException class. Initializes the exception instance with a default error message. Initializes a new instance of the IDNotFoundException class. If non-null, the information. The context. This exception class was created to be thrown if an entity is supposed to be valid (ie. it exists in the Mastercam database) but the ID cannot be found. Initializes a new instance of the MastercamSystemException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the MastercamSystemException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the MastercamSystemException class. Initializes the exception instance with a default error message. Initializes a new instance of the MastercamSystemException class. If non-null, the information. The context. This is the base Mastercam solids geometry exception class. Initializes a new instance of the OperationException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the OperationException class. If non-null, the message. Initializes a new instance of the OperationException class. Initializes the exception instance with a default error message. Initializes a new instance of the OperationException class. If non-null, the information. The context. This is the base Mastercam solids geometry exception class. Initializes a new instance of the MathException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the MathException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes the exception instance with a default error message. Initializes a new instance of the MathException class. If non-null, the information. The context. This is the base Mastercam Math exception class. Initializes a new instance of the MastercamIOException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the MastercamIOException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the MastercamIOException class. Initializes the exception instance with a default error message. Initializes a new instance of the MastercamIOException class. If non-null, the information. The context. This is the base Mastercam I/O exception class. Initializes a new instance of the SolidException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the SolidException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the SolidException class. Initializes the exception instance with a default error message. Initializes a new instance of the SolidException class. If non-null, the information. The context. This is the base Mastercam solids geometry exception class. Initializes a new instance of the GroupException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the GroupException class. . Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the GroupException class. Initializes the exception instance with a default error message. Initializes a new instance of the GroupException class. If non-null, the information. The context. This is the base Mastercam groups exception class. Initializes a new instance of the NestingException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the NestingException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the NestingException class. Initializes the exception instance with a default error message. Initializes a new instance of the NestingException class. If non-null, the information. The context. This is the base Mastercam nesting exception class. Initializes a new instance of the GeometryException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the GeometryException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the GeometryException class. Initializes a new instance of the GeometryException class. If non-null, the information. The context. This is the base Mastercam geometry exception class. Initializes a new instance of the TypeCasterException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the TypeCasterException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the TypeCasterException class. Initializes the exception instance with a default error message. Initializes a new instance of the TypeCasterException class. If non-null, the information. The context. This is the base Mastercam type casting exception class. This exception is generally thrown if the NET-Hook encounters a Mastercam database type that it doesn't understand and it can't cast to a NET-Hook type. Initializes a new instance of the DatabaseException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the DatabaseException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the DatabaseException class. Initializes the exception instance with a default error message. Initializes a new instance of the DatabaseException class. If non-null, the information. The context. This is the base Mastercam database exception class. Gets or sets the name of the specified exception. Initializes a new instance of the MastercamException class. Initializes the exception instance with a specified error message and the inner exception that caused it. If non-null, the message. If non-null, the inner exception. Initializes a new instance of the MastercamException class. Initializes the exception instance with a specified error message. If non-null, the message. Initializes a new instance of the MastercamException class. Initializes the exception instance with a default error message. Initializes a new instance of the MastercamException class. If non-null, the information. The context. This is the base Mastercam exception class. Gets a string from the managed resources. The name of the resource to retrieve. The string. Gets or sets the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. Gets the cached ResourceManager instance used by this application. The application strings class. Retrieve an entity by its ent_idn. The ent_idn of the entity. [out] The entity. [out] True if successful. The entity by identifier. @par Purpose: return true if active turret is a top turret @param[in] active_turret active turret to test Search for an associative entity in the DB that is "live" and matches the assoc_id. If non-null, the pointer in database to start search from. If non-null, the entity pointer (to the match). If non-null, The pointer to the entity to copy the matching/found entity. The assoc_id value to match (NULL_ID, TP_ID, OP_ID, TL_ID or M_ID). If NULL_ID then will return the next live associative entity. If non-null return search status: true if found an entity else false. @par Purpose: * for v7.0 development only! @par Purpose: store associative ents to db alive and blanked @param[in] e entity to store @param[out] d_ptr database pointer @param[in] id TP_ID, OP_ID, TL_ID or M_ID @param[out] succf true = successful @par Purpose: rewrite associative ents to db, update current operation and tool lists @param[in] e entity to write - calls rewrite_ent() @param[in] time_stamp true - re-stamp entity creation date Gets all TP entities associated with an operation. The operation entity Idn. The operation ent struct to fill. (optional = true) true = if toolpath entity count is mismatched, fix the op to match what was found. Vector of ent_tp structs representing the associated toolpath entities. Gets the ids for an operation's tp entities. The operation's id. A set (excludes duplicates) containing the ids. @defgroup assocvar_ch44 spindle direction @{ @} @defgroup assocvar_ch45 drill pt initial values @{ @} @defgroup assocvar_ch47 TP_CHN types @{ @} @defgroup assocvar_ch62 1013 nci line opcodes - LATHE @{ @} @defgroup assocvar_ch63 3D HMM Toolpath types @{ @} @defgroup assocvar_ch64 2D HMM Toolpath styles @{ @} @defgroup assocvar_ch65 Wirepath types @{ @} @defgroup assocvar_ch66 Agie machine model and control limits @{ @} reference point bits, used with ref_pt_state @} @defgroup assocvar_ch41 material type constants @{ @} @defgroup assocvar_ch42 tool active head/turret and axis motion constants @{ @defgroup assocvar_ch2 Toolpath Regeneration Error Codes @{ @} @defgroup assocvar_ch4 rotary axis (stored in bnci) @{ @} @defgroup assocvar_ch10 contour-pocket change at point codes @{ @} @defgroup assocvar_ch11 Wire change at point codes @{ @} @defgroup assocvar_ch12 Wire control setting codes @{ @} @defgroup assocvar_ch13 Wire control flag codes @{ @} @defgroup assocvar_ch14 maximum number of parameters on an NCI line @{ @} @defgroup assocvar_ch25 coolant states @{ @} @defgroup assocvar_ch37 transform operation types * @warning make sure you update sizeof_operation() in assocnci.c with any new opcodes @{ @} @defgroup assocvar_ch38 1013 nci line opcodes - Wire @{ @} @defgroup assocvar_ch39 cutter compensation constants @{ Cutter compensation direction. @par Purpose: This method checks a group list for a machine group. If none is found, one is created. If bad group pointers are found, they are fixed and reset to valid groups. @param[in] g The group list object to validate a machine group in. @par Purpose: This method sets the current views based on the saved view information stored in a group structure. @param[in] Group The group data that should be used to reset the current view information. @param[in] setActivePlanes true = set the active planes (Cplane, Tplane, WCS) as well @param[in] coordinateDisplay MILL_COORD, LATHE_COORD_X, LATHE_COORD_D or -1 to extract from given machine group. @par Purpose: This virtual method override pops list objects off of the list stacks. @return Returns true if the list objects were popped off the stacks correctly and false if not. @par Purpose: This virtual method override pushes new list objects onto the list stacks. @return Returns true if new list objects were pushed onto the stacks correctly and false if not. @par Purpose: This is the default TpGrpMgr destructor. It empties all of the list stacks upon destruction. @par Purpose: This is the default TpGrpMgr constructor. It initializes the list stacks upon creation. @par Purpose: This virtual method empties all of the list stacks. This method is marked as private because the list stacks should only be emptied when the manager gets destructed. @return A boolean value indicating whether the emptying of the lists stacks was successful or not. This is the manager class's file read group list stack. This is where instances of our file read group lists get stored. This is the manager class's main group list stack. This is where instances of our main group lists get stored. @par Purpose: This class's purpose is to hold and work with instances of the op manager group list classes for the life of a given Mastercam app execution. It also houses the group list stacks themselves, which we use to manage temporary list creation situations (see base TpMgr class declaration for more details). Finally, it holds some utility functions for managing global group related states and for searching lists for machine groups. True to disable regeneration of m_LookupMap in Delete(), false to enable. This is the list class's ID lookup map. When enabled, this map serves to map IDs to their indices within the list. This is the list class's main array object where all of the op_groups are stored. Check and correct if toolpath groups reference geometry groups as their parent (or vice versa). List of groups to chack and correct. A list of group IDs corrected. Copy a list of groups. [in,out] List of groups to copy, will be sorted and maybe IDs will be renumbered. Adds a group freshly read from a file to 'pCurrentGroupList'. Group to add. If non-null, the current group list. List of existing names to prevent duplicates. True if it succeeds, false if it fails. Disables rebuilding of m_LookupMap in DeleteGroupNode(). True to disable, false to enable. True if it succeeds, false if it fails. Query if this object is the global TpGrpList. True if global, false if not. Regenerate m_LookupMap. Free memory at the given pointer. [in,out] If non-null, the group to free. True if it succeeds, false if it fails. Allocate op_group to store in m_MainArray. group to copy into allocated group. nullptr if it fails, else a pointer to an op_group. Removes any null ptrs from m_MainArray and rebuilds m_LookupMap. Return number of nullptr entries removed from m_MainArray. Gets a reference to the underlying lookup map. A reference to the underlying lookup map. Allocates for and adds a copy of the given op_group to m_MainArray. [in,out] The op_group to add. Null if it fails, else a pointer to the copy of the op_group. Deletes all groups. The machine group deletion parameters, ignored if not a machine group. True if it succeeds, false if it fails. Deletes the group and all it's child groups with the given ID. Identifier for the group to delete. True to ignore children, false = delete the child groups. The machine group deletion parameters, ignored if not a machine group. A list of group IDs of deleted groups. Deletes the extra data hanging off machine groups which shouldn't be there in the first place. [in,out] The group to check. If opGroup is a machine group, use these deletion parameters for the extra data hanging off the machine group. True if it succeeds, false if it fails. Gets the identifiers for all the groups. The group IDs in m_MainArray order. Return true if index is within range of m_MainArray. Zero-based index into m_MainArray. Return true if index is within range of m_MainArray. Sets the active operation group in the main Operation Manager )moves the red insert arrow). Will also create a machine group and/or a toolpath if none exists. Identifier for the group to set as active. A group ID of the group set as the active operation group. Writes our groups to the given file. [in,out] The file to write to. True = only write geometry groups, not toolpath groups. True if it succeeds, false if it fails. Reads groups from a file into given TpGrpList. [in,out] The file to read groups from. [in,out] If non-null, a TpGrpList to store groups. True if it succeeds, false if it fails. Transfer the contents of source into our m_MainArray. [in,out] Source to move into out m_MainArray. ListReturnCode::ListOperationOK, ListOperationFailed or ListIndexNotFound. Transfer the contents of m_MainArray to the given target. [in,out] Target for m_MainArray contents. ListReturnCode::ListOperationOK, ListOperationFailed or ListIndexNotFound. Query if this object is empty. True if empty, false if not. Gets the size of m_MainArray. The size of m_MainArray. Destructor. Constructor. Initial size of the underlying container. Default constructor. Compares the Mastercam file's major & minor version number of the file at the given path to our current major version number. The Mastercam source file to check. True to warn of previous version file. Return true if file is okay to read from. Gets an entity by its unique ID number (ent.ent_idn). The entity's ent.ent_idn. Shared ptr to a copy of the entity. Extracts and returns any non-toolpath type groups in the given list of group pointers. [in,out] List of group pointers to look through. List of non-toolpath type group pointers. Sort the group vector by the given list of group pointers. List of group pointers in the desired order. [in,out] List of groups to sort. True if it succeeds, false if it fails. Dumps the given toolpath groups to a file. List of toolpath groups to dump. The file name to write to. Sort group pointers by parent-child hierarchy. The toolpath group pointers to sort. first = true if group sort order is valid, second = true if sort order was updated, third = true if slot numbers were updated. Sort groups by parent-child hierarchy. [in,out] The toolpath groups to sort. first = true if group sort order is valid, second = true if sort order was updated, third = true if slot numbers were updated. Check if the parent groups reside before their children in the vector. Source vector of toolpath group pointers to check. true = make sure any parent groups exist in the passed in source, false = ignore missing parent groups. True to check slot number values in the groups. True if it all parent groups reside before their children, false if not. Makes a unique, unused group name. True if is machine group, false if not. If not empty, the name we'd like to use if not already used. List of existing group names to check for naming conflicts. The next available group name. Create a vector of group pointers from the given vector. [in,out] Reference to list of groups. A list of group pointers to the groups. Sort the given groups by the sort method. [in,out] List of groups. The sort method. True if it succeeds, false if it fails. Sort the given group pointers by the sort method. [in,out] List of group pointers. The sort method. True if it succeeds, false if it fails. Test ourselves Zero-out machine and job setup values in the given group. [in,out] The group to initalize. Dumps all the groups to the given file. The IDs of the groups to dump, empty = dump all groups. The file name to write to. Dumps all the groups to the given file. The file name to write to. Dumps all the groups to the given file. The IDs of the groups to dump, empty = dump all groups. The file name to write to. Dumps a group in detail. The group to dump. If non-null, the entity map, nullptr = make new map. [in,out] The array of strings to fill in. Returns a string of group info with minimal other details. The group to dump. A string of group info with minimal other details. Gets a description for the given group type. Type of the group. The group type description. Check for geometry group type. Type of the group. (Optional) True to warn. True if geometry group type, false if not. Initializes the machine information in all groups that reference the given machine data. Machine pointer to match. The machine entity's ent.ent_idn to match. Returns list of IDs of the updated groups. Gets a pointer to the the first toolpath-type group. true = get ptr to first machine group, false = get ptr to first operation group. A pointer to the the first toolpath-type group, nullptr if none found. Gets a list of operation IDs owned by the group with the given ID. Identifier for the group. True to also check child groups. A list of operation IDs owned by the group with the given ID. Sets the op_group.slot value in each group based on their position in the given list of group IDs. A list of group IDs in tree control order. True if it succeeds, false if it fails. Sort the underlying container in grpList by parent-child hierarchy, reset slot numbers (op_group.slot). [in,out] List of groups to sort. first = true if group sort order is valid, second = true if sort order was updated, third = true if slot numbers were updated. Sort the underlying container in grpList by slot number (op_group.slot). [in,out] List of groups to sort. True if it succeeds, false if it fails. Replaces the given group in our container. The group to replace. Null if it fails (or doesn't exist), else a pointer to a const op_group. Import toolpath groups (excluding machine groups) from an external Mastercam file. Filename of the Mastercam file. List of group IDs in the source file to import. Parent group ID from your current file to be assigned as the parent of the imported groups. True = update global Operation Manager, false = just add to container. A map of old group IDs from the source file and their new group IDs in your current file. Get a list of groups from external file. The Mastercam source file to read from. Type of the groups to return (GROUP_ALL, GROUP_OPERATIONS, etc). (Optional) True to display debug warning if no groups are found. List of groups. Gets pairs of product codes and machine group pointers from the group list. True = return unique pairs in std::vector, false = return all groups. The product codes. Gets the product mask combined from all our machine groups. The product mask. Sort the underlying vector in a TpGrpList by group types (geometry groups, toolpath groups, etc) for 2022 and earlier version files. [in,out] List of groups to sort. Gets group names from a vector of group ptrs. The group ptrs. The group names. Makes group name. True if is machine group, false if not. Name of the requested. List of existing group names to prevent duplicates. A CString. Makes a unique, unused group name. True if is machine group, false if not. If not empty, the name we'd like to use if not already used. (Optional) List of group pointers to check for an existing name, nullptr = check global group list. The next available group name. Queries if a group with the given ID is a parent of a subgroup or toolpath operations. Identifier for the group. True if group is a parent of another or a toolpath operation, false if not. Query if the group with the given ID or any of its parent groups are locked. Identifier for the group. True - check if any parent groups are locked, false - just check the subject group. (Optional) True - check if any child groups are locked, false - just check the subject group. Return group ID of locked group (the subject ID or its locked parent), 0 = not locked. Query if the group with the given ID or any of its parent groups are considered 'hidden'. Identifier for the group. (Optional) true - check if any parent groups are hidden, false - just check the subject group. Return group ID of hidden group (the subject ID or its hidden parent), 0 = not hidden. Collect and return IDs from hidden toolpath groups and operations. first = the hidden group IDs, second = operation IDs owned by the hidden groups. Collect and return IDs from hidden toolpath groups and operations. List of groups to look in. List of operations to look in. first = the hidden group IDs, second = operation IDs owned by the hidden groups. Gets all the IDs of parent groups for the group with the given ID. [in,out] List of groups. Identifier for the group. false = return list in parent-child order, true = return list in proper deletion-order (child-parent order). List of parent group IDs for the group with the given ID. Gets all the IDs of child groups for the group with the given ID. Identifier for the group. false = return list in parent->child order, true = return list in proper deletion-order (child->parent order). List of parent group IDs for the group with the given ID. Gets all the IDs of parent groups for the group with the given ID. [in,out] List of groups. Identifier for the group. false = return list in parent-child order, true = return list in proper deletion-order (child-parent order). List of parent group IDs for the group with the given ID. Gets all the IDs of parent groups for the group with the given ID. Identifier for the group. false = return list in parent-child order, true = return list in proper deletion-order (child-parent order). List of parent group IDs for the group with the given ID. Query if group ID of 'suspectedParentId' is a parent of 'childId'. Identifier for the suspected parent group. Identifier for the child group. True if suspectedParentId is a parent of childId, false if not. Gets a list of group IDs for the given parents or children hierarchy. [in,out] List of groups to look through. Identifier for the subject group. HierarchyDirection::Parents to collect IDs of parent groups, HierarchyDirection::Children to collect IDs of child groups. false = return list in parent->child order, true = return list in proper deletion-order (child->parent order). List of group IDs in hierarchy order. Gets a list of group IDs for the given parents or children hierarchy. Identifier for the subject group. HierarchyDirection::Parents to collect IDs of parent groups, HierarchyDirection::Children to collect IDs of child groups. false = return list in parent->child order, true = return list in proper deletion-order (child->parent order). List of group IDs in hierarchy order. Values that represent hierarchy directions for use in calls to GetHierarchy (). Copies groups from source to target. Groups IDs may be reassigned if they conflict with existing groups in the target list. [in,out] TpGrpList to copy to. Source list of groups to copy. True to sort underlying container by slot number (op_group.slot) after copying. List of pairs (pointer to the newly added group, old group ID as its value may have been reassigned as to not conflict with any existing groups. Copies groups from source to target. Groups IDs may be reassigned if they conflict with existing groups in the target list. Source list of groups to copy. True to sort underlying container by slot number (op_group.slot) after copying. List of pairs (pointer to the newly added group, old group ID as its value may have been reassigned as to not conflict with any existing groups. Gets the next unused, unique group ID. List of groups to look through. The next unused, unique group ID. Gets the next unused, unique group ID. The next unused, unique group ID. Query if group with the given ID is the kind that contains a collection of operations that cannot be deleted, edited or added to. The ID of the group to check. True if the group is a 'collection' group, false if not. Query if group with the given ID is the last remaining machine or toolpath group. List of groups. The ID of the group to check. True if last group, false if not. Query if 'opGroup' is toolpath group (i.e. subgroup of a machine group). The toolpath group to check. True if a toolpath group, false if not. Query if 'opGroup' is machine group. The machine group to check. True to check if machine pointer is not null. True if machine group, false if not. Query if 'grpList' is empty. List of groups. True if empty, false if not. Query if this object is empty. True if empty, false if not. Deletes all toolpath groups. [in,out] List of groups to delete. true = only delete groups that are not referenced by toolpath operations, false = delete all . Deletion parameters (delete machines attached to machine groups, etc). A set of group and subgroup IDs deleted. Deletes all toolpath groups. true = only delete groups that are not referenced by toolpath operations, false = delete all . Deletion parameters (delete machines attached to machine groups, etc). A set of group and subgroup IDs deleted. Deletes the group with the given ID. [in,out] List of groups. Identifier for the group. true = only delete groups that are not referenced by toolpath operations, false = delete all . Deletion parameters (delete machines attached to machine groups, etc). A set of group and subgroup IDs deleted. Deletes the group with the given ID. Identifier for the group. true = only delete groups that are not referenced by toolpath operations, false = delete all . Deletion parameters (delete machines attached to machine groups, etc). A set of group and subgroup IDs deleted. Adds a group to the given list. List of groups to add. Group IDs may be reassigned if they conflict with an existing group. (Optional) >0 = new parent group id OpMgr, else use op_group.parent_grp_idn. List of pairs (pointer to the newly added group, old group ID as its value may have been reassigned as to not conflict with any existing groups. Adds a group to the given list. TpGrpList class to add groups to. List of groups to add. Group IDs may be reassigned if they conflicts with exiting groups in grpList. (Optional) >0 = new parent group id OpMgr, else use op_group.parent_grp_idn. List of pairs (pointer to the newly added group, old group ID as its value may have been reassigned as to not conflict with any existing groups. Searches for the group considered 'active' in the OpMgr's tree control. True to create a new machine and toolpath group if none found. Pointer to the active group. Gets a point to the root group of the group with the given ID. [in,out] List of groups to look through. Identifier for the group. Pointer to the root group, nullptr if group not found. Gets a point to the root group of the group with the given ID. Identifier for the group. Pointer to the root group, nullptr if group not found. Gets the number of groups. The number of groups. Builds a map of group IDs and the IDs of operations that reference them. A map of group IDs and the IDs of operations that reference them. Gets a list of group IDs in slot number order. The list of groups to look through. A list of group IDs in slot number order. Gets a set of group identifiers. A set of group identifiers. Gets copies of all the groups. [in,out] List of groups to look through. (Optional) The sorting method. vector of groups. Gets copies of all the groups. (Optional) The sorting method. vector of groups. Builds and returns a list of const op_group * to all our groups. [in,out] List of groups. (Optional) The sorting method. A list of const op_group * to all our groups. Builds and returns a list of const op_group * to all our groups. (Optional) The sorting method. A list of const op_group * to all our groups. Gets group pointers that pass the mask function. The mask function. (Optional) The sorting method. vector of group pointers. Returns a list of machine (root) group ptrs. true = check if machine pointer in group is valid. A list of machine (root) group ptrs. Gets a point to the group with the given name in the given list (NOT case sensitive). [in,out] List of groups to look through. Name of the group. Pointer to the group, nullptr if group not found. Gets a point to the group with the given name (NOT case sensitive). Name of the group. Pointer to the group, nullptr if group not found. Gets a point to the group with the given ID in the given list. [in,out] List of groups to look through. Identifier for the group. Pointer to the group, nullptr if group not found. Gets a point to the group with the given ID. Identifier for the group. Pointer to the group, nullptr if group not found. Constructor. True to enable all, false to disable all. Default constructor. Class for passing deletion parameters to DeleteExtraData() Values that represent group sorting methods. @par Purpose: This virtual method override pops list objects off of the list stacks. @return Returns true if the list objects were popped off the stacks correctly and false if not. @par Purpose: This virtual method override pushes new list objects onto the list stacks. @return Returns true if new list objects were pushed onto the stacks correctly and false if not. @par Purpose: This is the default TpMatMgr destructor. It empties all of the list stacks upon destruction. @par Purpose: This is the default TpMatMgr constructor. It initializes the list stacks upon creation. @par Purpose: This virtual method empties all of the list stacks. This method is marked as private because the list stacks should only be emptied when the manager gets destructed. @return A boolean value indicating whether the emptying of the lists stacks was successful or not. This is the manager class's main material list stack. This is where instances of our main material lists get stored. @par Purpose: This virtual method override pops list objects off of the list stacks. @return Returns true if the list objects were popped off the stacks correctly and false if not. @par Purpose: This virtual method override pushes new list objects onto the list stacks. @return Returns true if new list objects were pushed onto the stacks correctly and false if not. @par Purpose: This is the default TpOpMgr destructor. It empties all of the list stacks upon destruction. @par Purpose: This is the default TpOpMgr constructor. It initializes the list stacks upon creation. @par Purpose: This virtual method empties all of the list stacks. This method is marked as private because the list stacks should only be emptied when the manager gets destructed. @return A boolean value indicating whether the emptying of the lists stacks was successful or not. This is the manager class's main operation list stack. This is where instances of our main operation lists get stored. @par Purpose: This class's purpose is to hold and work with instances of the op manager operation list classes for the life of a given Mastercam app execution. It also houses the operation list stacks themselves, which we use to manage temporary list creation situations (see base TpMgr class declaration for more details). @par Purpose: This virtual method needs to be overridden in order to pop list objects off of the list stacks. This needs to be handled in the derived classes because the base classes have no idea which list stacks exist in the derived classes. @return Should return true if the list objects were popped off the stacks correctly and false if not. @par Purpose: This virtual method needs to be overridden in order to push new list objects onto the list stacks. This needs to be handled in the derived classes because the base classes have no idea which list stacks exist in the derived classes. @return Should return true if new list objects were pushed onto the stacks correctly and false if not. @par Purpose: This method returns the number of lists in each list stack. @return The return value is the number of lists in the each list stack. @par Purpose: This is the basic TpMgr constructor. Note that the stack depth initializes to zero. @par Purpose: This virtual method needs to be overridden in order to empty out all of the list stacks. Since only the derived classes actually know which lists exist in their class, that cleanup has to be done on their end. @return Should return true if the list stacks were emptied correctly and false if not. This is a running tally of how many lists are on the stacks at any given time. @par Purpose: This class's purpose is to set up an interface for the managing of Mastercam's internal Op Manager lists. The list objects are managed in stacks, which gives Mastercam some flexibility when it has to create new 'main' lists for temporary purposes (temporary databases, file I/O, etc.). In those situations, the list stacks allow us to push new, temporary list objects onto the stacks for use during the duration of the temporary situation. Once no longer needed, we can then pop those temporary lists off the stacks and still be left with our original lists still completely intact. This architecture removes the need to swap memory in and out for temporary lists and still easily accomodates nested temporary list creation situations. Accessor for the Singleton instance of IQuickMaskManager. The singleton. Gets the entities and solid faces "selected" via the SelectAllMask function when enhanced face selection is active. If enhanced face selection is active when SelectAllMask is called, the function will identify selected entities and faces but not change their selected state. Instead, it will collect the entity eptrs and face tags then post an EM_Command event of type GS_QUICK_MASK_ALL. Upon receiving the event, this function should be called to get the eptrs and tags. Once done with processing, the arrays should be emptied. Returned eptrs for all entities except solids. Returned solid face tags. The selection condition of the entities identified in "pEptrs". Select only mask. [in] page index to open. [in,out] If non-null, the selected mask. [in] If non-null, QuickMask dialog manager --> used for mocking purpose. Let it as nullptr for standard cases True if it succeeds, false if it fails. Select all mask. [in] page index to open. [in,out] If non-null, the selected mask. [in] If non-null, QuickMask dialog manager --> used for mocking purpose. Let it as nullptr for standard cases True if it succeeds, false if it fails. Get the selection mask to for selecting entities NOT INCLUDING THE FUNCTION SPECIFIC HARD SELECTION MASK. - chain_sel_mask : chaining specific mask. - one_time_sel_mask_active : user specified mask that is active for life of function. - maintained_sel_mask : user specified mask that is ALWAYS active when maintain_sel_mask == true The current selected mask only. Get the selection mask to use for selecting entities. - chain_sel_mask : chaining specific mask - hard_ent_sel_mask : set by calling function (usually just an ent mask) - one_time_sel_mask_active : user specified mask that is active for life of function - maintained_sel_mask : user specified mask that is ALWAYS active when maintain_sel_mask == true The current selected mask. Check if face color is selected in QuickMask color. The face color. True if it succeeds, false if it fails. Gets s_QmAllEnabled. True if it's enabled, false if not. Gets s_QmOnlyEnabled. True if it's enabled, false if not. Sets s_QmAllEnabled. True to enable, false to disable. Sets s_QmOnlyEnabled. True to enable, false to disable. Gets quick mask active count. The number of active quick mask. Quick mask is active. The QuickMask function index. True if it succeeds, false if it fails. Check mask. [in,out] True if checked. The quick mask function index. Query if 'param' is all mode. The parameter. True if all mode, false if not. Query if 'param' is only mode. The parameter. True if only mode, false if not. Toggle selection by type. The entity mask. Toggle only mask selection by type. The entity mask. Toggle active quickmask. Name of the function. clear all masks. the error code. Executes the QuickMask named group. The parameter. the error code. Executes the QuickMask by specific sel mask. The parameter. The specific selected mask. the error code. Executes the QuickMask level. The parameter. the error code. Executes the QuickMask color. The parameter. the error code. Executes the QuickMask. The parameter. The entity mask. Name of the function. the error code. Interface for QuickMaskManager. @} Element in the displaylist (a double linked list) @defgroup display_list_types Display List Types @{ Marker types Selection Grid Structure Destructor. Constructor. Class to save the current product enable bits, and restore upon destruction. Determines if the operation is in an MT Machine Group. The operation idn. True if an MT Machine, false if not. Determines if the Group Machine is an MT Machine. If non-null, group the TP belongs to. True if an MT Machine, false if not. Determines if the Active Machine is an MT Machine. True if an MT Machine, false if not. Checks whether a milling operation is supported by the current machine. Minimum MT product level needed to run this operation. Minimum Mill product level needed to run this operation for products other than MillTurn. Operation code to check. True if the operation is supported. Set all abandoned tools to the specific machine group. Identifier for the group. Set all abandoned tools to the specific machine group. The group. Restore the toolpath menu. Temporarily manipulated product enable bits so store_ent_assoc () will work saving md components. Restore the saved temporary product bits. Save the current product bits so they can be restored after getting mangled. Set the current graphics view when changing machines. The view number, view number 1-7, or anything else for 'dynamic' Gets the spindle view of the machine and determines if this is a vertical or horizontal machine. The spindle view. Updated to current active machine. True if spindle is in Z direction. True if successful. Get the active machine's floating point precision. The number of significant digits (i.e. placed to the right of the decimal point). Get the MT platform machine for the requested operation. The operation idn. Null if it fails, else a CCNCMachine*. Get the machine for the requested operation. The operation idn. Null if it fails, else a CCNCMachine*. Get the machine for the active toolpath group. Null if it fails, else a CCNCMachine*. Set (allocate) the machine for the requested toolpath group Return a pointer to the new machine. If non-null, toolpath group to get the machine for. Null if it fails, else a CCNCMachine*. Get the machine for the requested toolpath group. If non-null, toolpath group to get the machine for. (Optional) true - make a machine if none yet exists. Null if it fails, else a CCNCMachine*. Restore the state of ProdEnableBits after using SetProdEnableBitsFromMachineType() Change ProdEnableBits based on machine type This is used so tools can be edited when in 'design' mode when defining turrets, or setting up machine tooling Use RestoreProdEnableBitsFromMachineType() to restore the state after using this function. The mt. True, if this machine for the MT platform. True if it succeeds, false if it fails. Values that represent which CCNCMachine-related functions call DebugHistory(). Shows the CCNCMachine count dialog. X3 pre-alpha cnc machine entity translator, entity to update. The ent to process. machine control parameters Initializes the internal factory objects during construction. Wait for user to hit key and then clean up after draw machine. The main level value to restore. The manage levels. The previous toolpath repaint value. If non-null, the dialog. Prepare for drawing machine. If non-null, the dialog. Manage levels during drawing process. Save the machining modes to the database. True if it succeeds, false if it fails. Initialize machining modes from a file MUST be called AFTER all groups, components and axis combinations are in the database, and all ent_idn's are valid. The Mastercam file class object. True if it succeeds, false if it fails. Initialize machining modes from the database MUST be called AFTER all groups, components and axis combinations are in the database, and all ent_idn's are valid. Return the ent_idn of the machining mode entity list ent. A long& Validate the axis combinations, by removing multiple tool, part or tooling components. Return true if components were removed from the axis combination. Save the axis combinations to the database. True if it succeeds, false if it fails. Initialize axis combinations from a file MUST be called AFTER all groups and components are in the database, and all group and component ent_idn's are valid. The Mastercam file class object. True if it succeeds, false if it fails. Initialize axis combinations from the database MUST be called AFTER all groups and components are in the database, and all group and component ent_idn's are valid. Generate copies of mapped axis combinations with tool storage and part holding components in in 'owner' axis combinations. Axis combo list ent idn. Return the ent_idn of the axis combination entity list ent Dflt coolant off command identifier. index 0-MAX_COOLANT_CMDS-1. Return the resource ID for the default 'coolant off' string. Dflt coolant on command identifier. index 0-MAX_COOLANT_CMDS-1. Return the resource ID for the default 'coolant on' string. Dflt coolant command identifier. index 0-MAX_COOLANT_CMDS-1. Return the resource ID for the default 'base' string. Gets wire machine type. The start range. The end range. true if it succeeds, false if it fails. Turn off operation sub program setting. The operation to check. The compatibility data to fill in. Machine/group/operation compatibility flag. Check lathe quick op against the machine. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. Machine/group/operation compatibility flag. Check mt steady rest point op against the machine. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. Machine/group/operation compatibility flag. Check mt steady rest op against the machine. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. Machine/group/operation compatibility flag. Check pinch turn op against the machine. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. Machine/group/operation compatibility flag. Check lathe miscop against the machine. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. Compatibility level for operation. Check axis substitution status against the machine. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. Compatibility level for operation. Check lathe thread cycle status against the machine. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. Compatibility level for operation. Check lathe thread cycle status against the machine. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. Compatibility level for operation. Check an operation's coolant setting against the machine. The operation. Compatibility data to fill in. True if coolant was compatible and no changes need to be made. Check if the lathe tool quadrant is valid for the axis combo. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. true = Compatible, false = Regen required. Check a turning operation's tool change position against the machine. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. Compatibility level for operation. Check a standalone steady rest operation's feed rate against the machine. Standalone steady rest operation. (Optional) If non-null, (Optional) compatibility data to fill in. True if the feed rate is within the minimum and maximum for linear or rotary. False otherwise. Check an operation's feed rate against the machine. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. True if the feed rate is within the minimum and maximum for linear or rotary. False otherwise. Check an operation's spindle speed against the machine. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. True if the spindle speed is with the minimum and maximum. False otherwise. Update the op WCS to use the machine group properties WCS, if necessary.. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. Compatibility level for operation. Check an operation's tool compensation against the machine. The operation. (Optional) If non-null, (Optional) compatibility data to fill in. True if it succeeds, false if it fails. Fill in compatibility data for a missing group. The group class. If non-null, data to fill in. (Optional) axis combination id. Set compatibility data. The compatibility. The error code. If non-null, data to fill in. (Optional) axis combination id. Determine if there is a machine axis combination compatible with the operation parameters This test is used if there is no valid axis combination stored with the operation. The operation to check. The operation compatibility. (Optional) If non-null, (Optional) compatibility data to fill in. Return a pointer to the axis combination that is, or nullptr if none is found. Axis combo is compatible with operation. If non-null, axis combination to check. If non-null, the current operation axis combination. part holding group from op params. tool storage group from op params. The operation to check. (Optional) If non-null, (Optional) the data to fill in. Return true if the machine's axis combination is compatible with the operation, based on operation parameters. Determine if the operation's axis combination is compatible with one of the machine axis combinations. The operation to check. The operation compatibility. (Optional) If non-null, (Optional) compatibility data to fill in. Return a pointer to the axis combination that is, or nullptr if none is found. Add an axis combination to a list, only if it already isn't in the list. If non-null, axis combo to add. list of axis combos. Initialize op info for world/WCS/NC coordinate mapping. axis combination ID. The WCS to use for mapping. If non-null, the tool origin point (world coord). If non-null, the operation to set into for. Gets the set of stream indices that are valid for this machine. A set of integers representing the indices of all valid streams. Op Compatibility Including MT, converting Ops if necessary and supporting Lathe and Mill. The operation. The current compatible value. If non-null, the data. (Optional) check to see if machine is for ops' group. (Optional) True if this object can drop certain lathe ops. (Optional) True if this object can drop certain mill ops. The operation converted to mt with the new current compatible value. Is c axis operation valid for mt. The operation. (Optional) If non-null, (Optional) the data. (Optional) check to see if machine is for ops' group. Compatibility level for operation. Is Lathe op valid for MT. The operation type code. Compatibility level for operation. Is lathe operation compatible with mt. The operation code. Compatibility level for operation. Is Mill op valid for MT. The operation. (Optional) If non-null, (Optional) the data. (Optional) check to see if machine is for ops' group. Compatibility level for operation. Save the reference positions to the database. True if it succeeds, false if it fails. Save ent_idns for all reference positions. Initialize ent_idns for all reference positions. Initialize reference positions from a file. The Mastercam file class object. Unit conversion type. True if it succeeds, false if it fails. Initialize reference positions from the database. Determine if the source for import and drop are MT. The operation to check. True if the operation is in MT machine group. Deletes the current simulation info entity if one is associated with this machine. Update a lathe steady rest component from MGP parameters. The save new component to database. null if it fails, else a CSteadyRestComponent*. Generate a lathe tailstock centre component from MGP parameters, if it doesn't exist. The save new component to database. null if it fails, else the new tailstock center from mg data. Generate a lathe chuck jaws component from MGP parameters, if it doesn't exist. The LH_HEAD or RH_HEAD. The save new component to database. null if it fails, else the new lathe chuck jaws from mg data. Generate a mill/router/wire stock component from MGP parameters, if it doesn't exist. The save new component to database. Generate mill/router/wire fixture component(s) from the previous machine. The save new component to database. Find the part holding component for a mill/router/wire EDM. The include fixtures in search. null if it fails, else the found part holding component. Find the fixed base component from the newly defined lathe MGP components. If non-null, the stocks to search. If non-null, the chuck jaws to search. If non-null, the tailstock centre to search. null if it fails, else the found fixed component. Recursively delete the component entities from the database. If non-null, the component to use. (Optional) the delete geometry also. Delete the Mastercam component geometry (LBDRY, or solid). If non-null, the component to use. Save ent_idns for all groups. Initialize ent_idns for all groups. Import the stations and tl to the aggregate component. file to read from. The Mastercam file class object. Import the stations and tl to the Aggregate component. file to read from. The Mastercam file class object. If non-null, the component to save. Import the stations and tl to the drill block component. file to read from. The Mastercam file class object. Import the stations and tl to the drill block component. file to read from. The Mastercam file class object. If non-null, the component to save. Ent is component. The id of component entity to check. If non-null, the component to check. Return true if the component entity referenced by ent_idn is a currently used machine component. Save ent_idns for all components. If non-null, the component to initialize ent_idns for. Initialize ent_idns for all components. If non-null, the component to initialize ent_idns for. Initialize array of named views from an MD file. The Mastercam file class object. Number of planes added to m_MDFileViews. Initialize component groups from file entities -Component tree must be loaded from the database 1st -Every component must belong to a group. The Mastercam file class object. True if it succeeds, false if it fails. Initialize component groups from database entities -Component tree must be loaded from the database 1st -Every component must belong to a group. True if it succeeds, false if it fails. Fix a steady rest that somehow became disconnected from its component group. This happens in some X2 files. Initialize machine components from file entities. Name of file to read from. The Mastercam file class object. The ent_idn of component entity. True = load machine geometry from the file. Unit conversion type. If non-null, the parent component. True if it succeeds, false if it fails. Adds the components to the machine from component entity map. The name of the file to be read from. The Mastercam file class object. True to load geo. Unit conversion type. The component entity map. The parent component, if null, it is the machine base component. The child component entity ID. True if it succeeds, false if it fails. Convert the parameters to the specified unit system. Type of the unit conversion. Gets unit conversion type. The Mastercam file class object. Unit conversion type. True if it succeeds, false if it fails. Initialize all ent_idns to 0 (except control def entity). Verify view number is valid and warn if it isn't. The view matrix. true = Validate that the matrix is a predefined lathe tool plane view, false = Don't validate. View number of the given matrix. Determines if we can belong to tool path group. true if it belong to a toolpath group, false if not. Sets a name. The value. Gets the name. The name. Gets the flag to indicate if suppressing warning when a MT machine is replaced in job setup. True to suppress warning when a MT machine is replaced in job setup, otherwise false. Sets the flag to indicate if suppressing warning when a MT machine is replaced in job setup. True to suppress warning when a MT machine is replaced in job setup, otherwise false. Gets the flag to indicate if it is allowed to replace a MT machine in job setup. True to allow replacing MT machine in job setup, otherwise false. Sets the flag to indicate if it is allowed to replace a MT machine in job setup. True to allow replacing MT machine in job setup, otherwise false. Gets token defaults map. The token defaults map. Sets token defaults map. The token default map. Restore m_Curface for all turrets. This is done after a MachineWorks session. Back up and set m_Curface = 1 for all turrets. This is done prior to a MachineWorks session. Compute the vector to map a point in machine coordinates to MGP stock view coordinates. The desired vector, MAXREAL if not defined. (Optional) If non-null, (Optional) the component NOT to use to compute vector. The machine 2 mastercam vector. Compute the vector to map a point in MGP stock view coordinates to machine coordinates. The desired vector, MAXREAL if not defined. (Optional) If non-null, (Optional) the component NOT to use to compute vector. The mastercam 2 machine vector. Verify that Master stock has been initialized. Master stock. Return a pointer to the Master stock on the machine. Gets stock view origin. The origin for stock view (world coord.). Return the view origin for the stock view for this machine's group. Return false, if this isn't a group machine. Gets stock view matrix. The 3x3 view matrix. Return the view matrix for the stock view for this machine's group. Return false, if this isn't a group machine. Stock view number. Return the view number for the stock view for this machine's group. Return INVALID, if this isn't a group machine. Stock view. Return a pointer to the stock view from this machine's group. Return nullptr, if this isn't a group machine. Coordinate disp. Return lathe coordinate display state for the machine Cplane. Cplane defined. Return whether or not the Cplane has been defined. Gets the cplane. Return / define the default Cplane for the machine. Get the v_idn's for the named views associated with this machine Don't add duplicate id's This is a re - entrant method - seed it with MachineBase () to do the entire machine If non-null, the current component to get values for. The array of view ids. (Optional) the add system views to the list. Set Cplane, Tplane for a turning operation. The operation to set views for. (Optional) true = update WCS also. True if it succeeds, otherwise false. Set Cplane, Tplane for a milling operation. If non-null, the operation to set tplane for. (Optional) true = force update even current plane is already valid. True if it succeeds, otherwise false. Set the appropriate tool plane for a mill face or cross operation on a lathe. If non-null, the operation to set tplane for. (Optional) true = force update even current plane is already valid. True if it succeeds, otherwise false. Set the appropriate tool plane for a mill rotary axis operation. If non-null, the operation to set tplane for. True if it succeeds, otherwise false. Get the appropriate mill tool plane based on operation X and Z axes. The operation to get tplane for. (Optional) view number relative to the op WCS. A short. Get the appropriate mill tool plane based on operation X and Z axes. The operation to get tplane for. The tool plane view matrix. (Optional) view number relative to the op WCS. Return INVALID as the view number, if the view isn't in the database. Return the CString corresponding to the named view for a turning, or C - axis operation. The operation to get tplane named view for. A CString. Set the appropriate construction plane for a turning operation. If non-null, the operation to set cplane for. True if it succeeds, otherwise false. Set the appropriate tool plane for a turning operation. If non-null, the operation to set tplane for. True if it succeeds, otherwise false. The op tview "named view" is changing so save the new "named view". [in,out] If non-null, the operation to save new tool view "named view" for. The matrix to save in a new plane. The new plane name. [in,out] The new plane. Return true if new "named view" was successfully saved. Get the appropriate turning tool plane based on operation X and Z axes. The operation to get tplane for. (Optional) view number relative to the op WCS. A short. Get the appropriate turning tool plane based on operation X and Z axes. The operation to get tplane for. The tool plane view matrix. (Optional) view number relative to the op WCS. Return INVALID as the view number, if the view isn't in the database. Get the appropriate turning tool plane based on axis combo X and Z axes. If non-null, axis combo to get tplane for. The tool plane view matrix. The view number relative to the op WCS. The WCS view matrix. The WCS origin. Turning plane to generate. Return INVALID as the view number, if the view isn't in the database. Get the appropriate C-axis face op tool plane based on X and Z axis components. Identifier for the axis combination to reference. If non-null, the x coordinate axis. If non-null, the z coordinate axis. The tool plane view matrix. Return INVALID as the view number, if the view isn't in the database. Get the appropriate turning op tool plane based on X and Z axis components. If non-null, the x coordinate axis. If non-null, the z coordinate axis. The view matrix. true = Validate that the matrix is a predefined lathe tool plane view, false = Don't validate. Return INVALID as the view number, if the view isn't in the database. Gets comps that use named view, Return all the components that use a named view. The array of components that use this view. If non-null, the first component to check. named view ID. Wrapped operation named view. The view number (from linear machine axes). Return the CString corresponding to the named view for a C-Axis contour, or drill operation. Cross operation named view. The view number (from linear machine axes). Return the CString corresponding to the named view for a C-Axis cross contour, or drill operation. Face operation named view. op axis combo. The view number (from linear machine axes). Return the CString corresponding to the named view for a C-Axis face contour, or drill operation. Turning operation named view. op axis combo. view number (from linear machine axes). true = Filter using coordinate display. Return the CString corresponding to the named view for a turning operation. Write the ent_idn, UID, mapped status and name for all axis combinations to the ASCII NCI. open NCI file to write to. Return the number of lines written. Write the ent_idn, UID, name for all components to the ASCII NCI. open NCI file to write to. Return the number of lines written. Write the ent_idn, UID, name for a component and all children / siblings to the ASCII NCI. If non-null, component to write the information for. open NCI file to write to. The number of lines written. Make a list of all axis combination entities on the machine. List of axis combinations. Make a post circuit of machine components (Cnc::MachineDef::Component::CMachineComponents) for the operation The circuit starts at the 'base most' axis in the part holding list, works it's way out to the part holding component, then works its way back towards the base along the tool storage component list. operation to get circuit for. ordered array of components' ent_idn's. An int. Make a post circuit of machine components (Cnc::MachineDef::Component::CMachineComponents) for the operation The circuit starts at the 'base most' axis in the part holding list, works it's way out to the part holding component, then works its way back towards the base along the tool storage component list. operation to get circuit for. ordered array of components (Cnc::MachineDef::Component::CMachineComponent). Return number of components in list. Set the operation's data stream from the operations axis combo and machine mode. The operation to update. Use the operation's axis combo to define the active turret for the operation (used for mill ops in lathe). The operation to update. Use the operation's axis combo to define the active spindle for the operation. The operation to update. Find an axis combination based on a lathe tool's active turret and spindle. LH_HEAD, RH_HEAD. UL_TURRET, LL_TURRET. true = If the axis combo isn't found then use the first axis combo. null if it fails, else a CAxisCombination*. Set/clear op.cmn.use_alt_turret_index_pos based on active spindle and whether or not the op's axis combination has a turret that supports an alternate index position. LH_HEAD, RH_HEAD. operation to set the flag in. True if it succeeds, otherwise false. Operation turret indexed spindle. operation to check turret in. Return LH_HEAD or RH_HEAD for the spindle toward which the op's turret is indexed. Operation uses alternate turret index position. operation to check turret in. Return true if op.cmn.use_alt_turret_index_pos is true and the op's axis combination has a turret that supports an alternate index position. Has alternate index position turret. Return true if the machine has a turret that supports an alternate index position. Has alternate index position turret. operation to check turret in. Return true if the op's axis combination has a turret that supports an alternate index position. Has alternate index position turret. axis combination identifier. Return true if this axis combination has a turret that supports an alternate index position. Determine if the axis combination has a b-axis. Axis combo id. true = Axis combo has b-axis, false = Axis combo does not have b-axis. Map the machine reference points for the active axis combination to an operation. operation to map information for. (Optional) true = this is an ID lathe operation. True if it succeeds, otherwise false. Maximum tool spindle rpm. mill operation. (Optional) If non-null, (Optional) axis combination to get position from. Return maximum tool spindle speed. Maximum tool spindle rpm. tool group the tool belongs to. Return maximum tool spindle speed. Maximum tool spindle rpm. If non-null, the tool group. Return maximum tool spindle speed. Maximum tool spindle rpm. If non-null, list of components to check. Return maximum tool spindle speed. Minimum tool spindle rpm. mill operation. (Optional) If non-null, (Optional) axis combination to get position from. Return minimum tool spindle speed. Minimum tool spindle rpm. Group the tool belongs to. Return minimum tool spindle speed. Minimum tool spindle rpm. If non-null, tool group. Return minimum tool spindle speed. Minimum tool spindle rpm. If non-null, list of components to check. Return minimum tool spindle speed. Maximum lathe spindle rpm. lathe operation with active spindle flag. (Optional) If non-null, (Optional) axis combination to get position from. Return maximum spindle speed for right or left spindle. Maximum lathe spindle rpm. lathe tool with active spindle flag. Return maximum spindle speed for right or left spindle. Maximum lathe spindle rpm. The active spindle. Return maximum spindle speed for right or left spindle. Maximum lathe spindle rpm. If non-null, active spindle group. Return maximum spindle speed for right or left spindle. Maximum lathe spindle rpm. If non-null, list of components to check. Return maximum spindle speed for right or left spindle. Minimum lathe spindle rpm. lathe operation. (Optional) If non-null, (Optional) axis combination to get position from. Return minimum spindle speed for right or left spindle. Minimum lathe spindle rpm. lathe tool with active spindle flag. Return minimum spindle speed for right or left spindle. Minimum lathe spindle rpm. The active spindle. Return minimum spindle speed for right or left spindle. Minimum lathe spindle rpm. If non-null, active spindle group. Return minimum spindle speed for right or left spindle. Minimum lathe spindle rpm. If non-null, list of components to check. Return minimum spindle speed for right or left spindle. Get the machine axis combination wire EDM startpoint (3D) for an operation.The WCS Z coordinate is always 0. operation to get point for. start point. (Optional) 0 = world, 1 = tplane, 2 = WCS WRT world origin. (Optional) If non-null, (Optional) axis combination to get position from. Return false, if it can't be found. Get the machine axis combination tool change 3D point for an operation. operation to get point for. tool change point. (Optional) 0 = world, 1 = tplane, 2 = WCS WRT world origin. (Optional) If non-null, (Optional) axis combination to get position from. Return false, if it can't be found. Return the tool axis vector for rotary axis simulation of a milling tool in backplot or verify.The tool axis vector will be assumed parallel to the machine Z axis and thus, does NOT work for right angle heads. The vector returned is WRT the WCS of the operation. operation to check. tool axis vector. The mill tool axis vector. Return rotary direction of the specified rotary axis. The operation must be a milling operation with rotary axis enabled. operation to check. 1 for CW, -1 for CCW, 0 if not found. Rot axis zero angle. operation to check. (Optional) true = return angle in degrees. Return "0 degree" angle of the specified rotary axis wrt 3:00 when looking 'up' the rotary axis. The operation must be a milling operation with rotary axis enabled. Operation rot axis. operation to check. (Optional) return true if Y axis toolpath. Return the rotary axis component for an 'axis substitution' type operation. true if this lathe with 'C' axis in the op axis combination The 'C' axis is assumed to rotate about the WCS X axis, as this is the lathe NC Z axis If pOp = nullptr, check the entire machine true is the axis can be interpolated. (Optional) If non-null, (Optional) operation to checkaxis combinations for. True if the machine has lathe C axis. Is xyz axis lathe. (Optional) If non-null, (Optional) operation to check axis combinations for. Return true if this lathe with X,Y,Z axes in the op axis combination. If pOp = nullptr, check the entire machine. Has z coordinate rotary axis. (Optional) If non-null, (Optional) operation to check axis combinations for. Return true if there is an Z/-Z rotary axis in the op axis combination. If pOp = nullptr, check the entire machine. Has z coordinate linear axis. (Optional) If non-null, (Optional) operation to check axis combinations for. Return true if there is an Z/-Z linear axis in the op axis combination. If pOp = nullptr, check the entire machine. Has y coordinate rotary axis. (Optional) If non-null, (Optional) operation to check axis combinations for. Return true if there is an Y/-Y rotary axis in the op axis combination. If pOp = nullptr, check the entire machine. Has y coordinate linear axis. (Optional) If non-null, (Optional) operation to check axis combinations for. Return true if there is an Y/-Y linear axis in the op axis combination. If pOp = nullptr, check the entire machine. Has x coordinate rotary axis. (Optional) If non-null, (Optional) operation to check axis combinations for. Return true if there is an X/-X rotary axis in the op axis combination. If pOp = nullptr, check the entire machine. Has x coordinate linear axis. (Optional) If non-null, (Optional) operation to check axis combinations for. Return true if there is an X/-X linear axis in the op axis combination. If pOp = nullptr, check the entire machine. Rotary axis. Machine (WCS) axis to get. (Optional) If non-null, (Optional) operation to check axis combinations for. Return the requested rotary axis in the op axis combination. If pOp = nullptr, check the entire machine. Linear axis. Machine (WCS) axis to get. (Optional) If non-null, (Optional) operation to check axis combinations for. Return the requested linear axis in the op axis combination. If pOp = nullptr, check the entire machine. Number rotary axes. (Optional) If non-null, (Optional) operation to check axis combinations for. (Optional) include aggregate heads as rotary axes. Return number of rotary axes on machine in the op axis combination. If pOp = nullptr, check the entire machine. Number linear axes. (Optional) If non-null, (Optional) operation to check axis combinations for. Return number of linear axes on machine in the op axis combination. If pOp = nullptr, check the entire machine. Find all occurrences of components on the machine by component type. Matching components found. First type to check. (Optional) Last component type to check. (Optional) If non-null, (Optional) first component in machine tree to try. Turret group name. operation to check. Return name of turret sub-ass'y for operation. Spindle group name. operation to check. Return name of spindle sub-ass'y for operation. Return on of the following machine / operation compatibility flags. The worst case flag for all of the operations will be returned. op_idns to check. ops' original toolpath groups. (Optional) If non-null, (Optional) compatibility data. Compatibility level for operation. Return on of the following machine / operation compatibility flags. The worst case flag for all of the operations will be returned. operations to check. ops' original toolpath groups. (Optional) If non-null, (Optional) compatibility data. (Optional) check to see if machine is for ops' group. Compatibility level for operation. Return one of the following machine / operation compatibility flags: NOT_COMPATIBLE - machine can't cut (all of) the operation(s) AXES_INCOMPATIBLE - machine doesn't have appropriate axes for the op(s) EDITING_REQUIRED - editing of (some) operation (s) is req'd for machine REGEN_REQUIRED - regen is required for (some of) the operation (s) COMPATIBLE - machine can cut (all of) the operation (s) The worst case flag for all of the operations in the group will be returned. If non-null, group to check. (Optional) If non-null, (Optional) compatibility data. Compatibility level for operation. Get all of the axis combinations compatible with an operation based on opcode alone. operation type to check. (Optional) If non-null, axis combinations found. Return number found. See if all axis combinations belong to at least one machining mode, if machining modes are used. True if all axis combinations belong to at least one machining mode. See if there is an axis combination to perform the simplest operation for this type of machine. True if it has valid axis combination. Find an axis combination with enough axes for the operation based on opcode alone. operation type to check. null if it fails, else a CAxisCombination*. Check if the machine has enough axes for an operation. Operation code or operation data to check. (Optional) If non-null, pointer to valid axis combination, used as output to update axis combo for the operation. Return true if there are enough axes in one of the axis combinations to generate the desired operation typeL. Determine if the operation's axis combination is compatible with one of the machine axis combination. operation to check. operation compatibility. (Optional) If non-null, (Optional) compatibility data to fill in. Return a pointer to the axis combination that is, or nullptr if none is found. Quick check of the opcode against the machine type eg.to prevent a wire op from being dropped on a lathe. operation type to check. (Optional) If non-null, (Optional) compatibility data to fill in. True if operation code is valid for the machine. Initialize an operation's parameters based on machine's rotary axis capabilities. operation to fix. Return true if fixed, false if not, INVALID, if it can't be fixed. Fix rotary axis setting for multi-axis operations. operation to fix. true/false for presence of rot axes. default rotary axis to use. 0 = 3 axis, 1 = 4 axis, 2 = 5 axis. X, Y, Z 4th rotary axis. Return true if fixed, false if not, INVALID, if it can't be fixed. Find a valid axis combination, if one exists and assign it to an operation. operation to validate. True if axis combo for an operation is valid. Test a machine_axis_data array for a specific opcode. operation type to check. axis data map, axis type as key, number of axes as value. (Optional) If non-null, (Optional) compatibility data to fill in. (Optional) axis combination Id. True if enough axes are defined for an operation. Set the X,Y,Z,A,B,C_AXIS entries a machine_axis_data array according to whether or not the axes are present in an array of axis components axis components. axis data map, axis type as key, number of axes as value. Return array of all linear and/or rotary axis components. pointers to axis components. (Optional) include linear axes. (Optional) include rotary axes. Determine if geometry has been defined for the machine axes. If geometry hasn't been defined for any axis, it's assumed that the machine hasn't been set up for simulation. If this is true, the MDI button won't be shown in the stock, chuck, chuck jaws, tailstock, tailstock centre or steady rest component dialogs. True if geometry is defined for all axes. Return array of axis component(s) for input tool storage and part holding groups. tool storage group to check. part holding group to check. pointers to axis components. (Optional) FIXED(ALL), X,Y,Z,A,B,C, (_AXIS). (Optional) true = try negative of axis, if not found (for WCS axes). (Optional) true = search for component with matching machine axis false[default] = search for matching WCS axis. Return a pointer to the steady rest component for the active lathe spindle. null if it fails, else a CSteadyRestComponent*. Return a pointer to the lathe center component for the active lathe spindle. null if it fails, else a CLatheCenterComponent*. Return a pointer to the tailstock component for the active lathe spindle. null if it fails, else a CTailstockComponent*. Return a pointer to the gripper (chuck jaws or collet) component for the active lathe spindle. LH_HEAD or RH_HEAD. null if it fails, else a pointer to the gripper component. Return a pointer to the gripper holder component (collet chuck or chuck) for the active lathe spindle. LH_HEAD or RH_HEAD. null if it fails, else a pointer to the gripper holder component. Return a pointer to the stock component for the active lathe spindle. LH_HEAD or RH_HEAD. null if it fails, else a CStockComponent*. Return either LH_HEAD, RH_HEAD, or INVALID based on location of a component on the machine. unique component id. A short. Return either LH_HEAD, RH_HEAD, or INVALID based on location of a component on the machine. If non-null, component to test. A short. Return either LH_HEAD, RH_HEAD, or INVALID based on location of a component group on the machine. If non-null, component group to test. A short. Active component. Type of the component. (Optional) INVALID, LH_HEAD or RH_HEAD. Return a pointer to the component for the active lathe spindle. Return the first component found if activeSpdl = INVALID. Searches for the first component by identifier. unique component id. Return the component with the specified unique ID. Searches for the first component by identifier. unique component idr. Return the component with the specified unique ID. Steady Rest. If non-null, first group at which to start search. (Optional) make sure group has a steady rest component. Return pointer to steady rest group, or nullptr if non-existent. Tailstock. If non-null, first group at which to start search. (Optional) make sure group has a tailstock component. Return pointer to tailstock group, or nullptr if non-existent. Right spindle default. (Optional) make sure group has a part holding component. Return pointer to right spindle group, or nullptr if non-existent. Left spindle default. (Optional) make sure group has a part holding component. Return pointer to left spindle group, or nullptr if non-existent. Right spindle. (Optional) make sure group has a part holding component. Return pointer to right spindle group, or nullptr if non-existent. Left spindle. (Optional) make sure group has a part holding component. Return pointer to left spindle group, or nullptr if non-existent. Fixed tools. (Optional) make sure group has a tool storage component. Return pointer to fixed tooling group, or nullptr if non-existent. LR tools. (Optional) make sure group has a tool storage component. Return pointer to lower right turret group, or nullptr if non-existent. LL tools. (Optional) make sure group has a tool storage component. Return pointer to lower left turret group, or nullptr if non-existent. UR tools. (Optional) make sure group has a tool storage component. Return pointer to upper right turret group, or nullptr if non-existent. UL tools. (Optional) make sure group has a tool storage component. Return pointer to upper left tools group, or nullptr if non-existent. Tooling group. tooling group type. (Optional) make sure group has a tooling component. Return pointer to appropriate misc. tooling group. Tool storage group. tool storage group type. (Optional) make sure group has a tool storage component. Return pointer to appropriate tool storage group. Part holding group. part holding group type. (Optional) make sure group has a part holding component. Return pointer to appropriate part holding group. Validate coolant settings against the machine. Return true, if the settings were changed. pre-X coolant value. If non-null, X canned text values. True if coolant settings were changed. Return true, if all of the machine group's tools have been setup on the machine as machine components. (Optional) true = test selected operations only. True if it succeeds, otherwise false. Return the tool component used in this operation Return nullptr, if the operation's tool hasn't been set up. id of operation to check. null if it fails, else a CToolComponent*. Return the tool component used in this operation Return nullptr, if the operation's tool hasn't been set up. Operation to check. null if it fails, else a CToolComponent*. Return the tool component used in this operation Return nullptr, if the operation's tool hasn't been set up. operation to check. null if it fails, else a CToolComponent*. Return the tool component that uses the tool with the matching ent_idn. ID of tool entity. null if it fails, else the found tool component. Return on of the following machine / operation compatibility flags. Use this to filter list of operation to be imported from a library - other file. List of groups. operation to check. (Optional) If non-null, (Optional) the group list to check against. Compatibility level for operation. Fix invalid op axis combo id's in the event they get trashed with a best guess from op active spindle and turret. Return on of the following machine / operation compatibility flags. Use this to check operations when switching the group machine or copying operations between machine groups. If non-null, the group machine. operation to check. (Optional) If non-null, (Optional) compatibility data to fill in. (Optional) check to see if machine is for ops' group. Compatibility level for operation. Return on of the following machine / operation compatibility flags. Use this to check operations within the Current Machine. operation to check. (Optional) If non-null, (Optional) compatibility data to fill in. (Optional) check to see if machine is for ops' group. Compatibility level for operation. Add an machining mode to the list. If non-null, machining mode to add. True if it succeeds, otherwise false. Delete machining mode objects. (Optional) delete associated entities also. Delete a single machining mode from the list based on index in the list. index of machining mode to read. (Optional) delete associated entities also. Delete a single machining mode from the list based on index in the list. index of machining mode to read. (Optional) delete associated entities also. Save ent_idns for all machining modes Initialize ent_idns for all machining modes Get an array of data stream indices/channels used on the machine. This includes streams that have axis combo defined and the ones that don't (e.g., standalone stready rest may use a stream that has no axis combo defined.). Array of zero-based defined stream indices. Get an array of data stream indices/channels used on the machine that have axis combo defined to use the stream. array of defined stream indices. true add indexes as zero-based indexes, false add indezes starting from 1. Get all axis combos that match the given stream id. Stream id. Axis combos with matching stream id. Stream index from operation. operation to check. the data stream index (or channel) for a given operation. Return INVALID, if it can't be found. Stream information from mach mode and axis combo. If non-null, pointer to machining mode to match. If non-null, pointer to axis combination to match the data stream information for a given machining mode / axis combination Machining mode from axis combo. If non-null, pointer to axis combination to match a pointer to the first machining mode containing a specific axis combination.Return nullptr if not found. Searches for the first machining modes with axis combo. If non-null, pointer to axis combination to match If non-null, array of machining modes. Machining mode from UID. unique machining mode identifier. (Optional) false = if no axis combo is found from the id number then return the first axis combo. a pointer to a specific machining mode based on its UNIQUE identifier. Machining mode from code. code to match on. a pointer to a specific machining mode based on its code.Return nullptr if not found. Mach mode index from UID. unique machining mode identifier. the index of a specific machining mode based on its UNIQUE identifier.Return INVALID if not found. Machining mode from identifier. ent_idn machining mode identifier. a pointer to a specific machining mode based on its identifier.Return nullptr if not found. Mach mode index from identifier. ent_idn machining mode identifier. the index of a specific machining mode based on its identifier.Return INVALID if not found. Machining mode from index. index of machining mode to read. a pointer to a specific machining mode based on it's index in the array. Return nullptr if not found. Return the number of machining modes defined. The total number of machining modes. Make a default axis combination for the machine, if none exist.The machine must hsve a tool and part holding component group for this to work True if it succeeds, otherwise false. Add an axis combination to the list If non-null, axis combination to add. True if it succeeds, otherwise false. Delete axis combination objects (Optional) delete associated entities also. Delete a single axis combination from the list based on index in the list unique axis combination identifier. (Optional) delete associated entities also. Delete a single axis combination from the list based on index in the list index of axis combination to read. (Optional) delete associated entities also. Save ent_idns for all axis combinations Initialize ent_idns for all axis combinations Mapped axis combo from axis combo UID string. UUID axis combination identifier string. (Optional) include this axis combo's tool storage and part holding components. the mapped axis combination corresponding to an axis combination which is specified by the string version of its UID. Return nullptr if no mapped axis combination exists Mapped axis combo from axis combo UID. UUID axis combination identifier. (Optional) include this axis combo's tool storage and part holding components. the mapped axis combination corresponding to an axis combination which is specified by its UID. Return nullptr if no mapped axis combination exists Mapped axis combo identifier from axis combo identifier. UUID axis combination identifier. (Optional) include this axis combo's tool storage and part holding components. the mapped axis combination ID corresponding to an axis combination which is also specified by its ID. Return 0 if no mapped axis combination exists Mapped axis combo from axis combo identifier. UUID axis combination identifier. (Optional) include this axis combo's tool storage and part holding components. the mapped axis combination corresponding to an axis combination which is also specified by its ID. Return nullptr if no mapped axis combination exists. Gets axis information from axis identifier. ent_idn of axis component. ent_idn of axis combo with this axis (0 = none). true = incremental, false = absolute axis label. incremental or absolute axis label. WCS axis of input axis axis, or INVALID (-1) if not found also return the ent_idn of the first axis combination that uses this axis and the appropriate axis label. Gets axis information from axis identifier. ent_idn of axis component. true = incremental, false = absolute axis label. incremental or absolute axis label. WCS axis of input axis axis, or INVALID (-1) if not found also return the appropriate axis label. Gets diameter output from axis identifier. ent_idn of axis component. true if output is diameter Gets rotary cw output from axis identifier. ent_idn of axis component. true if CW rotary. Gets rotary output from axis identifier. ent_idn of axis component. Return value for rotary output form : -1 = not valid, 0 = continuous, 1 = signed direction 0 - 360, 2 = short distance 0 - 360. Define the list of machine positions machine position list. Return the list of machine positions. The machine positions. Add a machine reference position. machine position list A DWORD_PTR. Return a specific machine position. The UID. The mach position. true if it succeeds, false if it fails. Return WCS axis of input axis axis, or INVALID (-1) if not found also return the ent_idn of the first axis combination that uses this axis and the appropriate axis label. ent_idn of axis component. ent_idn of axis combo with this axis (0 = none) The eComponentAxes. Find all of the axis combinations that contain a specific component. If non-null, machine component to search for. search un-mapped axis combinations. search mapped axis combinations If non-null, list of axis combinations. Return a list of axis combinations that use the input 1-based stream channel. 1-based index (axis combo stream index + 1). list of axis combinations found. Return the index of a specific axis combination based on its 1 - based stream channel 1-based index (axis combo stream index + 1). (Optional) false = if no axis combo is found from the channel then return the first axis combo. null if it fails, else a CAxisCombination*. Return the index of a specific axis combination based on its 1 - based stream channel 1-based index (axis combo stream index + 1). An int. Return specific axis combination based on active turret and active spindle. The active turret. The active spindle. The specific axis combination or nullptr. Return a pointer to a specific axis combination based on its UNIQUE identifier. unique axis combination identifier. (Optional) false = if no axis combo is found from the id number then return the first axis combo. null if it fails, else a CAxisCombination*. Return a pointer to a specific axis combination based on its UNIQUE identifier. unique axis combination identifier. (Optional) false = if no axis combo is found from the id number then return the first axis combo. null if it fails, else a CAxisCombination*. Return the index of a specific axis combination based on its UNIQUE identifier.Return INVALID if not found. unique axis combination identifier. An int. Return a pointer to a specific axis combination based on its identifier. ent_idn axis combination identifier. (Optional) false = if no axis combo is found from the id number then return the first axis combo. null if it fails, else a CAxisCombination*. Return the index of a specific axis combination based on its identifier.Return INVALID if not found. Tent_idn axis combination identifier. An int. Return a pointer to a specific axis combination based on it's index in the array. Return nullptr if not found. index of axis combination to read. null if it fails, else a CAxisCombination*. Determine if we are axis combinations valid. True if axis combinations valid, false if not. Return the number of axis combinations defined. The total number of axis combinations. Return the stream channel # for a machining mode containing a given axis axis ID. machining mode that contains the axis. INVALID, if not the axis or stream can't be found Return the ent_idn of the stream names entity A long& Creates and attach tailstock center tool component. The tool database entity. The error code. null if it fails, else the new and attach tailstock center tool component. Sets tool orient service for a tool component. The tool component. The parent component. The tool database entity. Given an mt reference position name, extract the separate pieces. mt reference position name. type (0 = unknown, 1 = ref position, 2 = home position). data stream. post string recognized by the post. user string customizable for language translation. Get a new password, or disable the password (Optional) If non-null, (Optional) the parent. (Attempt to) unlock the machine definition so it can be saved to the database (Optional) If non-null, (Optional) the parent. Is this machine password protected True if it is password protected. Decode the password into the cnc_machine entity The password. The level. Encode the password into the cnc_machine entity The password. The level. Edit the data stream names (Optional) If non-null, (Optional) the parent window. True if it succeeds, otherwise false. Get a machining mode and macros in the MT Manager. If non-null, selected machining mode. (Optional) If non-null, (Optional) the parent window. The machining mode. Edit the machining modes This does NOT immediately save the machining modes back to the the machine.The members of machModes, must be saved to the machine by the calling module.If they are not saved, the CMachiningMode objects in the array should be freed using delete If non-null, modifiable list of machining modes. (Optional) If non-null, (Optional) the parent window. True if it succeeds, otherwise false. Gets axis combination. operation to get axis combo for. (Optional) If non-null, (Optional) the parent window. The axis combination. Edit reference positions. (Optional) If non-null, (Optional) the parent window. True if it succeeds, otherwise false. Create a new component and insert it at the proper location If non-null, the parent. If non-null, the group. Type of the component to create. (Optional) If non-null, (Optional) the parent window. Display context to indicate where the new component is created. null if it fails, else the new component. Get general parameters. (Optional) If non-null, (Optional) the parent window. (Optional) true if dialog is launched for MillTurn machine. The generate parameters. Return the resource ID's for the View Machine, View Group and View Component bitmaps resource ID's for the 3 bitmaps. Edit parameters (Optional) If non-null, (Optional) the parent window. True if it succeeds, otherwise false. Move group. If non-null, group the source belongs to. If non-null, group the destination belongs to. (Optional) the insert before. True if it succeeds, otherwise false. Gets group ptrs. Null if it fails, else the group ptrs. Swap 2 component groups If non-null, 1st group to swap If non-null, 2nd group to swap. True if it succeeds, otherwise false. Determine if a pointer is a pointer to a component group. If non-null, the pointer. True if a pointer is a pointer to a component group. Determine whether or not a specific component group is part of the machine. group class and type to check. True if a specific component group is part of the machine. Determine whether or not a specific component group is part of the machine group class to check. group type to check. True if a specific component group is part of the machine. Return next component group (after p1stGroup) with the specified type p1stGroup == nullptr->search entire machine compType != nullptr, find group based on specified component type group class to get group type to get. (Optional) If non-null, (Optional) first group at which to start search (Optional) first component type to identify the group. (Optional) first component type to identify the group. (Optional) match on both group and component types. null if it fails, else the group by class and type. Delete a component group, and all of its components from the list If non-null, the group. Delete a component, its lathe TCA boundary and (optionally) all of its descendents from the list If non-null, the component to delete. true = delete the component entity. (Optional) true = delete descendents too. Delete a component and (optionally) all of its descendents from the list If non-null, component to delete. (Optional) true = delete descendents too (Optional) true = delete lathe TCA boundaries. (Optional) true to force delete entity even if the component (for classEnt components) is not attached to the entity (via ent.u.classEnt). Only effective DeleteEntity property set to true. true = Delete geometry. Find the group whose db entity matches the input ent_idn. id of group's database entity. null if it fails, else the found group from ent idn. check groups to see which one a component belongs to. If non-null, the component. null if it fails, else the found components group. Check groups to see if a component is the base component for 1 of them. If non-null, the component. null if it fails, else a Cnc::MachineDef::Component::CComponentGroup*. Add a component group to the end of the list, identify by group class-type initial group class and type. null if it fails, else a Cnc::MachineDef::Component::CComponentGroup*. Add a component group to the end of the list, identify by group class/type initial group class. initial group type. null if it fails, else a Cnc::MachineDef::Component::CComponentGroup*. Inserts a group, identify by initial group class and type. If non-null, reference component group. T = insert before ref group, F = after. initial group class and type. null if it fails, else a Cnc::MachineDef::Component::CComponentGroup*. Inserts a group, identify by initial group class and type. If non-null, reference component group. T = insert before ref group, F = after initial group class. initial group type. null if it fails, else a Cnc::MachineDef::Component::CComponentGroup*. Inserts a group already created. The group to insert. If non-null, reference component group. T = insert before ref group, F = after Inserts a component. If non-null, the parent. If non-null, group to which component will belong. If non-null, parameters for component. true = add to existing children. null if it fails, else a Cnc::MachineDef::Component::CMachineComponent*. Delete the machine entities from the database (Optional) delete geometry also Delete the Mastercam geometry (LBDRY, or solid) associated with the components Also delete the Mastercam solids used to display the components in their machine positions, along with the dependent wireframe geometry Saves the simulation information associated with this machine to the database. Save - rewrite the cnc_machine entity in the database. True if it succeeds, otherwise false. Save - rewrite the control definition in the database. True if it succeeds, otherwise false. Set the axis simulation start positions/angles to be the same as the the initial positions, angles (Optional) true = all, false = update INFINITY only. Initialize a machine from machine entity and components in a file. If ent_idn = 0, the 1st machine in the file will be read in. Filename of the file. (Optional) ID of machine to read. (Optional)true = save entities, false = don't. (Optional) true = load machine geometry from the file. (Optional) true to preserve the entity ids as they are in the file, or false to reset them all to 0. True if succeeded, otherwise false. Initialize a machine from toolpath group info 1st try uses pTpGroup->pg1.machine_ent_idn to load the machine from entities in the database If this fails, and getFromFile = true, try to load the machine from the file : pTpGroup->pg1.machine, and if successful, save it back to the database.. If non-null, toolpath group to initialize from. (Optional) try to load the machine from file. (Optional) the show warnings. True if it succeeds, otherwise false. Initialize a machine from a machine entity and components in the database. If ent_idn = 0, find 1st machine in the database. (Optional) ID of CNC machine entity (Optional) the show warnings. True if it succeeds, otherwise false. Delete the Mastercam solids used to display the components in their machine positions. Deletes all components. Initializes the control from file. True if it succeeds, otherwise false. Initializes the control from database. True if it succeeds, otherwise false. Last group. null if it fails, else a Cnc::MachineDef::Component::CComponentGroup*. Set first group. The group to set as the first one. First group. null if it fails, else a Cnc::MachineDef::Component::CComponentGroup*. Gets stock component. If non-null, the component start. null if it fails, else the stock component. Sets pointer to the machine base/root component. If non-null, the root component. Machine base. null if it fails, else a Cnc::MachineDef::Component::CMachineComponent*. Make a EWAG at the tool storage component for a tool not used in an opt. entity of tool to find component for. null if it fails, else a Cnc::MachineDef::Component::CMachineComponent*. Validates the tool address. entity of tool to check. If non-null, tool storage component to check. a flag indicating whether or not the tool address (station or tool #) are in the valid range for the corresponding tool storage component Operation tool storage component. entity of tool to find component for. (Optional)true - only check selected operations. (Optional) true = Skip a newly created op since the tool isn't really used yet. the tool storage component for a tool used in an op. Operation tool storage component. operation to get component for. the tool storage component for a tool used in an op. Determine if a tool is used > 1 tool storage component. list of tools used in ops. entity of tool to test. (Optional) If non-null, (Optional) list of operations for the tool. (Optional) If non-null, (Optional) list of tool storage comps for the tool. true/false. Check if the given tool can be used with the given op. TL_ID or LTL_ID. tool slot. op parameters. list of used tools. true/false. Return a list of valid axis combos for a tool. TL_ID or LTL_ID. tool slot. list of valid axis combos for the tool. Insert a component initialized from an external file using GenComp() into the tree. File name of the file. If non-null, the parent. If non-null, the group. If non-null, the component. The tree flag. Unit conversion type. True if it succeeds, otherwise false. Delete all Mastercam machine position solids associated with tool spindle component's children and all 'downstream' components. Delete all Mastercam machine position solids associated with turret components and all 'downstream' components. These entities must always be re - created from scratch as the turret orientation will not be known in advance. Delete the Mastercam solids used to display the components in their machine positions, along with the dependent wireframe geometry. If non-null, the component. Update Lathe TCA boundaries from the appropriate components Update the mill/router/wire stock component from MGP parameters. machine group page 3 data to use. Generate components from MGP parameters, if they don't exist True to save components to database. Delete the TCA boundaries for which there are no machine components. Save component and all of its descendents to database as entities. If non-null, the component. (Optional) true = Rewrite to db, rather than save. True if it succeeds, otherwise false. Save component groups to database as entities. (Optional) true = Rewrite to db, rather than save. True if it succeeds, otherwise false. Generate a lathe stock component from MGP parameters, if it doesn't exist. LH_HEAD or RH_HEAD. save new component to database. null if it fails, else the new lathe stock from mg data. Recursively convert all solid component geometry to STL meshes. The algorithm will convert solid components to STL. However, if the STL geometry type is not allowed for a particular component type then it will be skipped. (Optional) If non-null, (Optional) component from which to start search (nullptr for Machine Base) (Optional) flag indicating to use machine component chord tolerance as the tesselation tolerance. (Optional) Tesselation tolerance (used only if useComponentChordTol == false). (Optional) delete original geometry entity after replaced. Recursively convert all solid component geometry to MCO meshes. The algorithm will convert solid components to STL. However, if the STL geometry type is not allowed for a particular component type then it will be skipped. (Optional) If non-null, (Optional) component from which to start search (nullptr for Machine Base) (Optional) flag indicating to use machine component chord tolerance as the tesselation tolerance. (Optional) Tesselation tolerance (used only if useComponentChordTol == false). (Optional) true to convert st ls. (Optional) delete solid after replaced. Find the component whose db entity matches the input ent_idn Non-null component pointer from which to start search. The end_idn value to match during search. null if it fails, else the found component by ent idn. Adjust to bi stable. 'adjust machine to bi-stable position when limits' status. Break rapid rotary. 'break rapid rotary moves' status. Control rotary motion. control rotary motion parameters. Control arc motion. (Optional) true = Use CCNCControl::GetToolMT(). control arc motion parameters CCNCControl::GetArc () - millTurn = false, CCNCControl::GetArcMT () - millTurn = true. Lin ax rapid output. linear axis rapid move control method Control linear motion. (Optional) true = Use CCNCControl::GetToolMT(). control linear motion parameters CCNCControl::GetLinear () - millTurn = false, CCNCControl::GetLinearMT () - millTurn = true. DoFirstStartCloseMultAlt. True if first start close from part is enabled with multiple start alternate thread. DoFirstStartFarMultAlt. True if first start far from part is enabled with multiple start alternate thread. DoAllowThreadMultipleStartsAlt. True if the machine allows multiple start for alternate thread. DoFirstStartCloseMultBox. True if first start close from part is enabled with multiple start box thread. DoFirstStartFarMultBox True if first start far from part is enabled with multiple start box thread. DoAllowThreadMultipleStartsBox True if the machine allows multiple start for box thread. DoFirstStartCloseMultCan True if first start close from part is enabled with multiple start canned thread. DoFirstStartFarMultCan True if first start far from part is enabled with multiple start canned thread. DoAllowThreadMultipleStartsCan True if the machine allows multiple starts for canned thread. DoThreadAlternatePulloff True if the machine allows pull off for alternate thread. DoThreadAlternateMultipleStarts True if the machine allows multiple starts for alternate thread. DoThreadAlternateEqualArea True if the machine allows equal area for alternate thread. DoThreadAlternateEqualDepths True if the machine allows equal depth cuts for alternate thread. DoThreadBoxPulloff True if the machine allows pull off for box thread. DoThreadBoxMultipleStarts True if the machine allows multiple starts for box thread. DoThreadBoxEqualArea True if the machine allows equal area for box thread. DoThreadBoxEqualDepths True if the machine allows equal depth cuts for box thread. DoThreadLonghandPulloff True if the machine allows pull off for long hand thread. DoThreadCanPulloff True if the machine allows pull off for canned thread. Check if the machine allows equal depth cuts for canned thread. True if the machine allows multiple starts for canned thread. DoThreadCanEqualArea True if the machine allows equal area cuts for canned thread. DoThreadCanEqualDepths True if the machine allows equal depth cuts for canned thread. DoLCangrvDwell. True if the machine allows dwell for canned groove. DoLCangrvRghDepths. True if the machine allows rough depth cuts for canned groove. DoLCangrvRghPecks. True if the machine allows rough peck for canned groove. DoLCangrvChamferRads. True if the machine allows radius on chamfer for canned groove. bool DoLCangrvCornerRad (); . True if the machine allows radius on corner for canned groove. DoLCangrvCornerChamfer. True if the machine allows chamfer on corner for canned groove. DoLCangrvWallTaper. True if the machine allows canned groove wall taper. DoCannedRoughUndercut. True if the machine allows lathe canned rough under cut. DoLCannedFinish. True if the machine supports lathe canned finish. DoLCannedThread. True if the machine supports lathe canned thread. DoLCannedGroove True if the machine supports lathe canned groove. DoLCannedPattern. True if the machine supports lathe canned pattern. DoLCannedRough. True if the machine supports lathe canned rough. Control lathe canned cycles. control drilling canned cycle parameters, or nullptr if control isn't defined. Control lathe drill canned cycles. control lathe drilling canned cycle parameters, or nullptr if control isn't defined. Control drill canned cycles. control drilling canned cycle parameters, or nullptr if control isn't defined. Control generate canned cycles. control general canned cycle parameters, or nullptr if control sint' defined Sets control feed information using: CCNCControl::SetFeed () - ctrlFlag = CTRL_SET_TOOL CCNCControl::SetFeedMT () - ctrlFlag = CTRL_SET_MILLTURN Both - ctrlFlag = CTRL_SET_BOTH Information describing the feed. (Optional) indicates what CD params to set True if it succeeds, false if it fails. Adjust arc feedrates. (Optional) true = Use CCNCControl::GetFeedMT(). whether or not to adjust arc feedrates. Control feed information. (Optional) true = Use CCNCControl::GetFeedMT(). control feed rate information using: CCNCControl::GetFeed () - millTurn = false, CCNCControl::GetFeedMT () - millTurn = true. Supports reverse wear component. whether or not the machine supports wear comp in control Supports wear component. whether or not the machine supports wear comp in control. Supports control component. whether or not the machine supports comp in control. Control tool component. control tool compensation parameters, or nullptr if control isn't defined. Define control tool information using: CCNCControl::SetTool () - ctrlFlag = CTRL_SET_TOOL CCNCControl::SetToolMT () - ctrlFlag = CTRL_SET_MILLTURN Both - ctrlFlag = CTRL_SET_BOTH Information describing the tool. (Optional) indicates what CD params to set. True if it succeeds, false if it fails. BOfsAmt. (Optional) true = Use CCNCControl::GetToolMT(). control amount to add to tool number to get back offset TlOfsAmt. (Optional) true = Use CCNCControl::GetToolMT(). control amount to add to tool number to get lathe tool offset DOfsAmt. (Optional) true = Use CCNCControl::GetToolMT(). control amount to add to tool number to get diameter offset. Ofs amount. (Optional) true = Use CCNCControl::GetToolMT(). control amount to add to tool number to get length offset. Adds to the tool register. (Optional) true = Use CCNCControl::GetToolMT(). control flag indicating how tool offsets are related to the tool number.Values are : CTRL_FROM_TOOL, CTRL_ADD, CTRL_FROM_DEFAULTS. Use head for tool. (Optional) true = Use CCNCControl::GetToolMT(). control tool number = head/station number flag. Control tool information. (Optional) true = Use CCNCControl::GetToolMT() control tool information using: CCNCControl::GetTool () - millTurn = false; CCNCControl::GetToolMT () - millTurn = true Sets control NC dialog parameters. values to set True if it succeeds, false if it fails. Control NC dialog. (Optional) get mill settings for a lathe. control NC dialog parameters, or nullptr if control isn't defined. Set the control NC output parameters values to set. True if it succeeds, false if it fails. Sequence number increment. control sequence number increment. Starts sequence number. control start sequence number. Output operation comment. control flag for output of operation comment. Output group comment. control flag for output of group comment. Output group name. control flag for output of group name. Output machine name. control flag for output of machine name. Control NC output. control NC output parameters, or nullptr if control isn't defined Control ent idn. ent_idn for the control definition Machine ent idn. ent_idn for the control definition use coolant to control submerged wire. True to use coolant to control submerged wire. Is any coolant option on the machine enabled?. True if any coolant option is enabled. Is a specific coolant option enabled on the machine. index 0-MAX_COOLANT_CMDS-1. (Optional) True to ignore coolant from post check. True if a specific coolant option is enabled. Use coolant event list. Use event list to activate coolant Use coolant from post, Use coolant commands in post-processor, (provided for backward compatibility) True to use coolant from post. First coolant off shuts off all. 'first coolant off command shuts off all others' status Coolant 'off' command. index 0-MAX_COOLANT_CMDS-1. a 'coolant off' command built from baseTxt + onTxt; nullptr, if idx is invalid, text is "", or base text is "" Coolant 'on' command. index 0-MAX_COOLANT_CMDS-1. a 'coolant on' command built from baseTxt + onText; nullptr, if idx is invalid, text is "", or base text is "" Sets coolant 'off' text. The text. index 0-MAX_COOLANT_CMDS-1. Coolant 'off' text. index 0-MAX_COOLANT_CMDS-1 coolant 'off' text; default resource string if the string is empty; empty string, if idx is invalid, or text is "" (disabled) Sets coolant 'on' text. The text. index 0-MAX_COOLANT_CMDS-1 Coolant on text. index 0-MAX_COOLANT_CMDS-1. coolant 'on' text; default resource string if the string is empty; empty string, if idx is invalid, or text is "" (disabled). Sets coolant base text, 'base' coolant text The text. index 0-MAX_COOLANT_CMDS-1. Coolant base text. The index. 'base' coolant text. default resource string if the string is empty; empty string, if idx is invalid, or text is "" (disabled) Sets coolant button text to appear on Coolant button of tool parameters page The text. Coolant button text. default resource string if the string is empty empty string, the string is "" text to appear on Coolant button of tool parameters page Gets the coolant. coolant parameters Displays a mapped parameters. true if mapped machine display is enabled Number data streams. The total number of data streams. Supports machining modes. whether the machine supports machining modes Is this machine for the MT component library. True if this machine has been created for the MT component library. Sets whether this machine for the MT platform. (Optional) for MT platform value. Check if the machine is a template machine. True if template machine, false if not. Multi-tasking related parameters Is this machine for the MT platform. True if this machine has been created for the MT platform (MT, MT-Lathe, MT-Swiss). Operation inverse time feedrates. inches (INCH_IDX) or mm (MM_IDX). operation min,max inverse time feedrates Operation feed per reverse. inches (INCH_IDX) or mm (MM_IDX). operation min,max feed/rev feedrates Operation feed per minimum. inches (INCH_IDX) or mm (MM_IDX). operation min,max feed/min feedrates Operation feed per minimum. inches (INCH_IDX) or mm (MM_IDX). operation min,max feed/min feedrates Return/Define operation feed rate limits Operation feed rates. inches (INCH_IDX) or mm (MM_IDX). operation feed rates Set machine max feedrate and all axis component max feed rates Used when creating an MD from a V9.pst file.. max. inch/min and mm/min feed rates. Set axis component feed rates from machine values, if required Generic version. Set axis component feed rates from machine values, if required Recursive version. If non-null, the component to set. Use maximum rotary feedrate. whether or not to use machine maximum rotary axis feedrate Use maximum linear feedrate. whether or not to use machine maximum linear axis feedrate Sets maximum rotary axis deg/min feedrate. maximum feed rate to set. Maximum rotary feedrate. maximum rotary axis deg/min feedrate Sets maximum linear feedrate. (rapid traverse rate) maximum feed rate to set. inches (INCH_IDX) or mm (MM_IDX). Sets machine acceleration. machine acceleration (> 0) inches (INCH_IDX) or mm (MM_IDX). Machine acceleration. inches (INCH_IDX) or mm (MM_IDX). machine acceleration value. Sets sync list timing step (sec). timing step (sec, > 0). Synchronises the timing step. sync list timing step (sec). Sets minimum arc feed rate. feed rate to set. Minimum arc feed rate. minimum arc feedrate in machine dynamics Gets the Map high feed dynamic properties to a MACHINE_DYNAMICS structure high feed dynamics properties. Return/Define machine dynamic properties Gets the dynamics. Return/Define machine dynamic properties Turn RTCP support for the machine on/off true or false. false if it can't be supported. Supports rtcp. RTCP support for the machine Sets maximum combined angle before break is required. The angle. (Optional) true = deg, false = rad. Maximum combined rotary angle. (Optional) true = deg, false = rad. the maximum combined angle before break is required. Break rotary combined. 'break combined rotary axis motion' status. Return/Define multi-axis motion control parameters Multi ax motion. multi-axis motion control parameters Sets maximum wire taper angle. The maximum angle. (Optional) true = deg, false = rad. Return/Define wire EDM parameters Maximum wire taper angle. (Optional) true = deg, false = rad. Return maximum wire taper angle. Set toolbar state to a valid value, if not found in user's list Set MT-specific file and paths to valid values, if possible If non-null, group the mach belongs to. Set file and paths to valid values, if possible (Optional) the show warnings. Find a post file in the search paths. The post must either support event lists or not, according to the switch in the machine filled in array of paths to search. The found post file in search paths. Make up the search paths for finding a control definition or post - processor file The following paths are added, in order : -path of current database file -path stored with control definition or post - processor file -path of the current machine definition file -Mastercam install path (current_dir) CD or post-processor file. default path to library file. filled in array of paths to search. Make up the search paths for finding a library file The following paths are added, in order : -path stored with lib file name -path of default library / catalogue -path of current database file -Mastercam install path (current_dir). library file. default path to library file filled in array of paths to search. Sets NC suffix. Full pathname of the file. True if it succeeds, false if it fails. NC suffix. (Optional) 1st try to get control from database rather than object. the NC file extension Sets NC prefix. Full pathname of the file. True if it succeeds, false if it fails. NC prefix. (Optional) 1st try to get control from database rather than object the NC file path Sets nci prefix. Full pathname of the file. True if it succeeds, false if it fails. Nci prefix. (Optional) 1st try to get control from database rather than object. the NCI file path Sets wire auxiliary register chook file. Filename of the file. True if it succeeds, false if it fails. Wire auxiliary register chook file. (Optional) 1st try to get control from database rather than object the wire auxilliary registers C-Hook file Sets misc vals chook file. Filename of the file. True if it succeeds, false if it fails. Misc vals chook file. (Optional) 1st try to get control from database rather than object. the misc. values C-Hook file Sets setup sheet file. Filename of the file. True if it succeeds, false if it fails. Sets up the sheet file. (Optional) 1st try to get control from database rather than object. the setup sheet file Sets post executable file. Filename of the file. True if it succeeds, false if it fails. Posts an executable file. (Optional) 1st try to get control from database rather than object. the post-processor executable file Sets operation dflts file. Filename of the file. inches (INCH_IDX) or mm (MM_IDX). True if it succeeds, false if it fails. Operation dflts file. inches (INCH_IDX) or mm (MM_IDX). (Optional) 1st try to get control from database rather than object. the operation defaults file Sets operation library file. Filename of the file. inches (INCH_IDX) or mm (MM_IDX). True if it succeeds, false if it fails. Operation library file. inches (INCH_IDX) or mm (MM_IDX). (Optional) 1st try to get control from database rather than object. Return the operation library file Define the wire EDM power library file. Filename of the file. inches (INCH_IDX) or mm (MM_IDX) True if it succeeds, false if it fails. Power library file. inches (INCH_IDX) or mm (MM_IDX). (Optional) 1st try to get control from database rather than object. Return the wire EDM power library file Replace the Mastercam directory in the MD-related files with the Mastercam directory token. Replace the Mastercam directory token in the MD-related files with the local Mastercam directory. Holder catalog file. The units. Return the lathe holder catalog file. Inserts a catalog file described by units. The units. Return the lathe insert catalog file. Sets matl library file. Filename of the file. True if it succeeds, false if it fails. Matl library file. Return material library file. Sets tool library file. Filename of the file. inches (INCH_IDX) or mm (MM_IDX) True if it succeeds, false if it fails. Tool library file. inches (INCH_IDX) or mm (MM_IDX) Return tool library file. Control definition file. Return control definition file. Posts the proc file. Return post-processor file. Return user-defined 'replace post' state when the post path is wrong, but a post with the same name is found in the user's default post path path to local copy of post. parent window for dialog. An int. Set the system default to Top or Lathe Z = World Z based on m_Params.dfltLatheWCS. was the previous machine a VTL? True if it succeeds, false if it fails. Adjust a view for the WCS (make relative to world WCS). the plane. True if it succeeds, false if it fails. Define default lathe WCS LATHE_WCS_NO_DFLT,TOP,LATHE_Z_EQ_WORLD_Z. return false, if not a LATHE. DefaultLatheWCS Return default lathe WCS:LATHE_WCS_NO_DFLT, LATHE_WCS_TOP, LATHE_WCS_LATHE_Z_EQ_WORLD_Z. Set the default Cplane for a machine group. True if it succeeds, false if it fails. AutoLoadTools. Return/define whether or not to load tools on the machine when changing machines in the MGP dialog. UseTbState. Return whether or not to use the toolbar state. TbState. Return toolbar state associated with the machine. Returns true if the machine is used as an MTConfig file True if the Machine is used specifically as an MTConfig file, otherwise false Sets the value for IsMTConfigFile The boolean value to set - whether the machine is used as an MT Config file Sets the comment property The string representing the comment GetComment. Return comment to describe the machine. Comment. Return comment to describe the machine. Return VTL status. Return VTL status. Return true if control defines machine as an Mitsubishi. true if it's machine that uses tech power library data, false if not. Return true if control defines machine as a generic tech machine. true if a generic tech machine, false if not. Return true if control defines machine as an Makino. true if Makino machine, false if not. Return true if control defines machine as an Mitsubishi. true if Mitsubishi machine, false if not. Return true if control defines machine as an Agie. true if Agie machine, false if not. Return the imported geometry level. the imported geometry level. Checks if this machine is a simple MT machine. True if this is a simple MT machine. Sets the name of the external machine to use for simulation. The name of the external machine to use for simulation (potentially empty string). Gets the name of the external machine to use for simulation. The name of the external machine or an empty string if intended to use the machine definition. Sets boolean indicating whether or not to use the machine definition for simulation. True if to use machine definition. False otherwise. Gets boolean indicating whether or not to use the machine definition for simulation. True if to use machine definition. False otherwise. Sets the product code of this MT machine. Product code of this MT machine. Gets the product code of this MT machine. Product code of this MT machine. return true, if mdCompId = m_Params.configurationId. component id (guid) to compare. true if it succeeds, false if it fails. Configuration identifier equals. Identifier for the component. true if it succeeds, false if it fails. Define the machine configuration GUID for this machine (initially valid MT only). Identifier for the component. Define the machine configuration GUID for this machine (initially valid MT only). Identifier for the component. Return the machine configuration GUID for this machine (initially valid MT only). the machine configuration GUID. Return pointer to CNC control. A CCNCControl Type. Return machine product type. A Product Type. Sets a machine type. Type of the machine to create. True if it succeeds, false if it fails. Gets the machine type. Returns the code value that identifies the machine type (i.e. MACHINE_LATHE). Return true if MD was created after the specified version. The version to compare the machine to. True if it succeeds, false if it fails. Return true if MD was created before the specified version. The version to compare the machine to. True if it succeeds, false if it fails. Return true if MD was created with the specified version. The version to compare the machine to. True if it succeeds, false if it fails. Sets the current version. Gets the current version. A double. Sets the current parameters. If non-null, machine parameters. Gets the current parameters. If non-null, machine parameters. Gets the current parameters. null if it fails, else a cnc_machine_type*. Define a default control type for a given machine type. A short. Sets flag indicating whether to deletes the db entities when deleting components. true = delete db entities, false = don't. Gets flag indicating whether to deletes the db entities when deleting components. true = delete db entities, false = don't. Write the 'replace post with local copy' state to the registry This value is used if ReadReplacePostFromRegistry () The replace post. REPLACE_PST, PST_TO_NONE, PST_PROMPT Read the 'replace post with local copy' state from the registry This value is used if ReadReplacePostFromRegistry () PST_PROMPT, and sets the initial radio button value in the dialog It is either : REPLACE_PST, PST_TO_NONE Write the 'replace post with local copy' state to the registry. The replace post. REPLACE_PST, PST_TO_NONE, PST_PROMPT Read the 'replace post with local copy' state from the registry. It is one of : REPLACE_PST, PST_TO_NONE, PST_PROMPT. The replace post from registry. Deletes the control described by deleteEntities. (Optional) delete control entities. Initializes the control. (Optional) true = force initialization from file. (Optional) true = force CD initialization from defaults. True if it succeeds, false if it fails. Determines if machine object initialized successfully. true if was initialized successfully else false. Copies the UID described by ID. The identifier. Copies the UID described by ID. The identifier. UID is defined. True if it succeeds, false if it fails. Return true if the unique ID matches the one input. (Optional) ID to compare. Delete all entities that used to be, but are no longer used by this machine. Save all ent_idns to m_EntIdnList array. Sets TP group. (Optional) If non-null, (Optional) group the TP belongs to. null if it fails, else an op_group*. Return pointer to owner toolpath group. null if it fails, else an op_group*. Return pointer to owner toolpath group. null if not owned, else an const pointer to the owner toolpath group. Creates level for component import. The name for the level. Initialize coolant values. Initialize machine dynamics values. Initializes the files. Initializes the comment. Initializes the data. Initializes the UID. Accepts the given visitor. The visitor. Whether the visited object allows to visit its children or not. Destructor. Constructor. Initialize from machine entity and components in a file If ent_idn = 0, the 1st machine in the file will be read in name of file to read from. (Optional) ID of machine to read. (Optional) true = load only the machine parameters. (Optional) true = save entities, false = don't. (Optional) true = load machine geometry from the file. (Optional) True to preserve the entity ids as they are in the file, or false to reset them all to 0. (Optional) Level numbering strategy to apply when importing component geometry. Constructor. Initialize based on a toolpath group. Optionally load the machine into the database from the machine file for the group if it's not already loaded getFromFile states : false = try the database only true = try the database, try the file, if the database fails TRY_FILE_ONLY = try the file only If non-null, pointer to toolpath manager group. (Optional) true = load only the machine parameters. (Optional) try to load the machine from file. (Optional) true = load machine geometry from the file (getFromFile = true). Constructor. Initialize from cnc_machine entity -no machine group affiliation -used for initializing the machine in an MD file The ent_idn of cnc_machine entity. (Optional) true = load only the machine parameters. Constructor. create an 'empty' machine, if required. default machine type. Constructor. Machine type Main machine tool class This class is used to provide an intelligent machine tool database to the rest of the Mastercam modules. The class can be initialized as follows: 1. no initialization - an empty machine tool with or without a machine base is created 2. machine base entity - the machine database will be initialized from a CNC machine entity in the database. 3. toolpath group - the machine database will be initialized from the machine tool information in a toolpath group 4. external file - the machine will be initialized from an external file. As the first CNC machine entity encountered will be used to define the machine, therefore, the file should only contain ONE machine tool. This intended for reading in a machine definition file Setting the paramsOnly parameter in the last 2 constructors to true, is beneficial for quickly loading a machine object when only general parameters are required (paths, coolant, name, etc) and will GREATLY speed up loading time when the machine must be created in a loop. The control definition IS however loaded with the machine definition in this case, as many toolpath parameters reside in the control definition. Once a CCNCMachine object is created, it can be 'interrogated' by the software to provide necessary information, used to update operation information, or used for simulation purposes For example: CCNCMachine theMachine (currentToolpathGroup); if (theMachine.EnoughAxesForOperation (opcode)) ProgramTheOperation(opcode); Tool load error dialog. If non-null, the machine. info for failed tools. If non-null, the parent window. Destructor. Default constructor. Enum class that represent level number configuration when importing geometry. Gets the assoc_id representing the ClassEnt type (i.e. OP_ID). The assoc_id representing the ClassEnt type. Writes/Serializes the entity from a given archive. The archive to write to. true if it succeeds, false if it fails. Sets The name of the external machine to use in simulation. The name of the external machine to use in simulation. Gets the name of the external machine to use in simulation. The name of the external machine to use in simulation. Sets whether or not to use the machine definition in simulation. Whether or not to use the machine definition in simulation. Gets whether or not to use the machine definition in simulation. Whether or not to use the machine definition in simulation. Assignment operator. The left side of the "==" operator. The right side of the "==" operator. True if the objects are the same object or have equivalent properties. False otherwise Finalizes an instance of the MachineSimulationInfo class. Assignment operator. Source object to copy. A shallow copy of this object. Gets the assoc_id representing the ClassEnt type (i.e. OP_ID). The assoc_id representing the ClassEnt type. Writes/Serializes the entity from a given archive. The archive to write to. true if it succeeds, false if it fails. Sets the product code of the machine. Product code of the machine. Gets the product code of the machine. Product code of the machine. Finalizes an instance of the PrivateMachineInfo class. Assignment operator. Source object to copy. A shallow copy of this object. Stores additional information about a machine that should NOT be exposed in the SDK. Interface describing a machine definition component. Creates tool orientation service. Type of the parent component. Tool entity. The newly created tool orientation service. Destructor. Default constructor. Tool orientation service factory. Swap parent component. The new parent component. Computes the default tool orientation - InitXform() for a tool. The tool component. The tool orientation matrix. Plane view ID for tool orientation matrix. Compute the reference point for each insert of a multi-insert tool. The tool component. The map of slot number and corresponding refPt for each insert. Initialize the component's reference point (RefPt()) based on the parent tool holding component. The tool component. The tool entity. Destructor. Initialize the component's machine position (InitPt()) and orientation (InitXform()) based on the parent tool holding component. The tool component. The tool entity. Interface class to provide tool orient service for computing and assisting in modifying the tool component's orientation when assembling the tool and locator components on the machine. Makes a shallow copy of values from another CMachineComponent object, not including values from base classes. This function must not be made public or virtual so that derived types do not attempt to copy from any other type than their own. Source to copy from. Makes a shallow copy of values from another CMachineComponent object, including all base classes. This function must not be made public or virtual so that derived types do not attempt to copy from any other type than their own. Source to copy from. Copies the data content but keeps the original pointers and entity IDs for the parent, child, and siblings so that the original relationships between the components stay the same. This function is added to support the replacement of default component in MT component library. When we drag a component from upper machine tree to the default component tree, if there is already a default component at the drop node, this function will be called to copy the data content for the component but the relationships between components won't be changed. Source component to copy data from. Purpose: Get view to map component on the turret/machine @param[in] pDlg calling dialog, NULL for none @param[in] showAdapters display tool adapters @param[in] showTools display the tools @param[in] showOthers display other child components Edit wireframe geometry for a revolved solid. (Optional) true to blank the chained geometry. true if it succeeds, false if it fails. Purpose: Edit wireframe geometry for an extruded solid Purpose: Edit component parameters @param[in] pParentWnd parent window @param[in] newComp true = newly created component Edit component parameters via dialog. (Optional) If non-null, the parent window. (Optional) true = on creating new component object. (default = false). (Optional) Context for the display. (default = MachineTreeDisplayContext::NotAssigned). true = success and OK button pushed, false = cancel button hit. Purpose: Make string describing the view for component as position on the machine @param[out] viewStr view text string Purpose: Destroy the component position/orientation modeless dialog Over-ride this member in inherited class for a custom dialog Purpose: Create the component position/orientation modeless dialog Over-ride this member in inherited class for a custom dialog @param[in] pCompDlg component dialog window Purpose: Return dialog resource ID for the position/orientation modeless dialog Return 0, if there isn't one Over-ride this member in inherited class for a custom dialog Creates solid geometry dialog. If non-null, the parent window (main component tabbed dialog). Null if it fails, else the raw pointer to a new solid geometry dialog. Creates an array of available chain geometry dialogs. If the component does not support them then the dialog pointers will be null. Parent window. Array of chain geometry dialogs. Creates geo dialog. Create the component parametric geometry modeless dialog Return NULL, if there isn't one. null if it fails, else a pointer to the new geo dialog. Destroys active geometry dialog. Define the pointer to the current component geometry modeless dialog. If non-null, the dialog. Return the pointer to the current component geometry modeless dialog. null if it fails, else a pointer to the appropriate dialog. Return dialog resource ID for the appropriate parametric geometry modeless dialog *Return 0, if there isn't one dialog resource ID. Destroys the additional parameters modeless dialog. Create the component parameters modeless dialog. Return NULL, if there isn't one If non-null, the component dialog. null if it fails, else the new additional parameters dialog. Return dialog resource ID for the component additional parameters modeless dialog Return 0, if there isn't one The resource ID. Purpose: Destroy the component parameters modeless dialog Purpose: Create the component parameters modeless dialog Return NULL, if there isn't one @param[in] pCompDlg component dialog window Purpose: Return dialog resource ID for the component parameters modeless dialog Return 0, if there isn't one Purpose: Get appropriate parameters from component dialog based on the active tab page @param[in] activePg 0, 1, 2 (3, 4) Purpose: Display the appropriate tab dialog May be over-written for specific components @param[in] activePg 0, 1, 2 @param[in] nShow SW_SHOW or SW_HIDE Purpose: Initialize the component definition dialog. Component's backup parameters. (Optional) If non-null, the parent window (Default = nullptr). (Optional) true for new component, false = pre-existing component (Default = false). (Optional) Context for the display. (Default = NotAssigned) Purpose: Initialize array of component definition modeless dialog ID's Modifies the component's tab ID list based on the context. Context for the display. Purpose: Initialize tab ID's for component definition dialog Override in inherited class, if component doesn't have 3 tab pages Purpose: Initialize valid geometry types for this component Override in inherited class, if required Default assumes a parametric geometry definition Gets the allowed geometric types list. Since 2020, we can customize by component types the allowed geometric types. Allowed geometric types list. id's for valid geometry types for this component Purpose: Delete the MC geometry for a component Purpose: Delete the STL geometry for a component Delete the MC solid for an MCSolid. Purpose: Delete the lathe_bdry entity for an extruded or revolved solid Import the required geometry from a file File to read geometry from. The file class, if open use it otherwise open filename. Unit conversion type. True if it succeeds, false if it fails. Visits all solid/pmesh entities associated with the component and sets translucency property in display list./ Display a machine component and all of its descendents in machine position using Mastercam solids. (Optional) true to draw all children (default = true). Draw the component on the screen in component position. Purpose: Make solid entities for this component @param[in] locateOnMachine true = draw in machine position Make a Mastercam component solid from another solid entity. The entity id of the solid to create. The color in which to create the geometry. The level on which to create the geometry. The entity pointer of the solid that has been created. Make a Mastercam component solid from another solid entity. The color in which to create the geometry. The level on which to create the geometry. The entity pointer of the solid that has been created. Make a Mastercam solid from revolve parameters. [in,out] If non-null, the chain to revolve from. [in,out] If non-null, the axis to revolve about. The color to create geometry in. The level to create geometry on. (Optional) The start angle. (Optional) The end angle. A list of. Make a Mastercam solid from extrude parameters. If non-null, the chain to make the extrusion from. The distance to extrude. The extrude direction. The color to create geometry in. The level to create geometry on. The extruded solid eptr. Purpose: Make a Mastercam solid from cone parameters @param[in] pParams solid parameters @param[in] color color to create geometry in @param[in] level level to create geometry on Purpose: Make a Mastercam solid from cylinder parameters @param[in] pParams solid parameters @param[in] color color to create geometry in @param[in] level level to create geometry on Purpose: Make a Mastercam solid from block parameters @param[in] pParams solid parameters @param[in] color color to create geometry in @param[in] level level to create geometry on Purpose: Define initXform transformation matrix based on component type Deletes the solid entities described by solidEntEptrs. The eptrs of the solid entities to delete from the DB. Purpose: Delete all machine position solids for this component Copy component dependent geometry to another component. If non-null, the component to copy geometry to. (Optional) True to copy solids too. Setup transformation matrix for moving a solid to machine position. Transformation matrix. (Optional) True if in machine position. Purpose: Preview the TCA boundaries (go to graphics window...) from the component definition dialog Does nothing in the base class @param[in] pParentWnd parent dialog window Purpose: Draw the TCA boundaries Does nothing in the base class Purpose: Compute the vector to map a point in machine coordinates to MGP stock view coordinates @param[out] v desired vector MAXREAL if no master stock Purpose: Compute the vector to map a point in MGP stock view coordinates to machine coordinates @param[out] v desired vector, MAXREAL if no master stock @param[in] pNoComp component NOT to use to compute vector Delete the lathe TCA boundary for this component. Update the TCA boundaries for the component when MapToComponent() is called Does nothing in the base class. True to move profile into machine position only, otherwise generate profile and move it into machine position. Purpose: Move the X coordinate of the InitPt() by dx. dx is computed from a change in the X position of a LATHE TCA component defined in the local copy of the MD Applies to this component and all children and siblings, after the 1st call @param[in] dx amount to move InitPt() X coordinate @param[in doSiblings do the siblings of this component @param[in] pNoComp component NOT to adjust Make the lathe TCA boundaries for the component. The boundary Manager boundary IDs. The status bar message ID. True to move profile into machine position only, otherwise generate profile and move it into machine position. True if it succeeds, false if it fails. Purpose: Make the lathe TCA boundaries for a component from the silhouette boundary of the solid revolved about the X axis Uses Interfacial module @param[in] bdryIDs Boundary Manager boundary IDs @param[in] msgID status bar message ID Purpose: Make the lathe TCA boundaries for a component that is revolved about the X axis @param[in] bdryIDs Boundary Manager boundary IDs Purpose: Make the lathe TCA boundaries for a cylindrical component that is revolved about the X axis @param[in] bdryIDs Boundary Manager boundary IDs Creates solids from chain geometry. True if it succeeds, false if it fails. Make Mastercam solids from chuck parameters. True if it succeeds, false if it fails. Gets imported geometry level. The imported geometry level. Purpose: Initialize translation vector before setting up the transformation matrix for drawing the component. This can be over-ridden in the inherited component classes @param[in] v translation vector to initialize with, may be ignored Purpose: Initialize rotation matrix before setting up the transformation matrix for drawing the component. This can be over-ridden in the inherited component classes @param[in] rm rotation matrix to initialize with, may be ignored Purpose: See if ALL solid entities for component in machine position already exist If they don't, delete the ones that do Purpose: Make solid entities for this component from primitive, extrude or revolve Purpose: Make a Mastercam solid from revolve parameters @param[in] level level to create geometry on Purpose: Make a Mastercam solid from extrude parameters @param[in] level level to create geometry on Purpose: Make a Mastercam solid cylinder component @param[in] level level to create geometry on Purpose: Make a Mastercam solid black component @param[in] level level to create geometry on Make a Mastercam solid component from a solid entity. The level to create geometry on. True if it succeeds, false if it fails. Purpose: Delete geometry after a geometry display function @param[in] startPos point in database at which to start Purpose: Transform a tp_ent array used as an extrude-revolve profile @param[in,out] bdryEnts array of tp_ents @param[in] numEnts number to tp_ents in array @param[in] pXm transformation matrix global flag to control deletion of geometry for the component when deleting the component, used to control deletion of geometry for machine setup components in the MGP copy of the machine transformation matrix to move component from InitPos() when drawing the machine Saves 3D tool solid eptrs in the eptr list. The tool solids. Gets a const reference to a container of EPTrs to the solid entities representing the component. A const reference to the container of EPTrs to the solid entities representing the component. Gets a non-const reference to a container of EPTrs to the solid entities representing the component. This was added for testing purposes. A non-const reference to the container of EPTrs to the solid entities representing the component. generate the solid in machine position, if not already created should ALWAYS be true, except when setting a component's machine position or view pointers to solids used for drawing the part on the machine true = create the solids in the machine position and orientation Gets created solid level. The created solid level. Cleans the geometry struct so that only the data needed for the specified geo type is persisted. If the geometry type does not use the geometry struct (eg: parametric), the geometry struct is cleared. Sets the ent_idn of related geometry DB entity. Can't set the ent_idn for the following geometry types: PARAMETRIC_GEO, BLOCK_GEO, CYLINDER_GEO The the ent_idn of related geometry DB entity, 0, if none. Gets the ent_idn of related geometry DB entity. The following geometry types do not have associated geometry entities and will return zero: PARAMETRIC_GEO, BLOCK_GEO, CYLINDER_GEO The the ent_idn of related geometry DB entity, 0, if none. Return revolved solid definition. A reference to a revolved_component_def. Return extruded solid definition. A reference to an extruded_component_def. Return cylinder definition. A reference to a cylinder_component_def. Return block definition. A reference to a block_component_def. Return 'solid from STL' definition. A reference to a stl_component_def. Return 'solid from solid' definition. A reference to a solid_component_def. Purpose: Can this component be in the axis combination. If non-null, axis combination to check. True if component can be included in an axis combo, false if not. Purpose: Is this component in the axis combination? @param[in] pAC axis combination to check Purpose: Return true if the machine component was drawn in position on the the machine (RefPt() = InitPos(), InitXform() = Top view Purpose: Add the v_idn for the named view associated with InitXform to the array Don't add duplicate id's @param[in,out] vids array of view ids @param[in] addSystemViews add system views to the list Purpose: Add the v_idn for the named view identified by viewID to the array Don't add duplicate id's @param[in,out] vids array of view ids @param[in] viewID view id to add @param[in] viewMatrix view matrix for view @param[in] addSystemViews add system views to the list Purpose: transformation matrix to put component @ current NC position Transformation matrix to put component on machine @ initial position. A reference to a matrix_33. Transformation matrix to put component on machine @ initial position. A reference to a matrix_33. Purpose: Return previous position of anchor point (world coordinates) Purpose: Return current position of anchor point (world coordinates) Get the coordinates of the component's "anchor point" This is only relevant to several component types. Has several representations based on its component type: Rotary axis = Center of rotation Turret = Center of rotation Tool spindle = point on which tools and tool locators are mounted. The coordinates of the component's "anchor point". (Optional) True = get point coorindates in its "assembled" state else in its unassembled state (off the machine). Get access to the "anchor point" in its un-assembled state (off the machine). This is only relevant to several component types. Has several representations based on its component type: Rotary axis = Center of rotation Turret = Center of rotation Tool spindle = point on which tools and tool locators are mounted. Non-const access to the "anchor point". The transformed position of the components base point in its assembled state (on the machine). A non-const reference to the component's transformed base point in its assembled state (on the machine). The transformed position of the components base point in its assembled state (on the machine). A const reference to the component's transformed base point in its assembled state (on the machine). The position of the component's base point in its "unassembled" state. A non-const reference to the component's base point. The position of the component's base point in its "unassembled" state. A const reference to the component's base point . Purpose: Convert an axis index to an axis vector @param[in] axisIndex index (X_AXIS, Y_AXIS, etc...) @param[out] axisVec resulting axis vector previous position of the anchor point Purpose: Find the 'equivalent' mapped axis component (linear & rotary axes only). This method seems to be not used anymore. @TODO figure out what is this mapped axis, and decide if we can remove it (mxs). (Optional) True to use machine axis. Null if it fails, else a pointer to a CMachineComponent. Purpose: Find first 'parent' component of one of the desired types Recursively search parents, starting with this component's parent Return NULL if none found @param[in] startType first type to check @param[in] endType last component type to check Purpose: Find next component of the desired component type @param[in] compType component type to search for @param[in] checkSiblings check siblings of this component Component specific initialization when read from a file Add specific initialization in the derived class for the component type File name of the file. The Mastercam file class object. True to load geometry from the file. Unit conversion type. True if it succeeds, false if it fails. Purpose: Rewrite this component to the database Resolve relation ptrs to ent identifiers and save to database. The entity data struct representing the component. A bool. Purpose: Save this component to the database Purpose: Retrieve the entity for this component from the database using its unique id @param[out] compEnt component entity @param[int] compEnt component entity Gets attached database entity's idn. The attached database entity's idn. Purpose: Return the ent_idn of the owner machine Purpose: Return current ent_idn info Purpose: Return current const ent_idn info Purpose: Return true if this component uses the input named view @param[in] viewID named view ID This function is called after this component is added to the machine tree. Convert the parameters to the specified unit system. Unit conversion type. Purpose: Convert the (non-parametric) component geometry units, if required. Unit conversion type. Find the component named view and save to database. Save a view to the database The view matrix. Named view ID. If non-null, name of the view. True if it succeeds, false if it fails. Find a named view that matches on view matrix and optionally view name, if one exists, return v_idn of view, or INVALID, if not found. The view matrix. If non-null, name of the view. The found named view. Find a view from the list of views saved in the MD file for the machine that owns this component The view matrix. Named view ID. Null if it fails, else the found view from md file list. Make a view name for the InitXform() matrix for this component. Name of the view. use this to suppress unit conversion in the base class so it can be called at the proper time when reading a component in from a file Deletes the descendents of the given component. true = delete component's corresponding database entities also. (Optional) true = delete lathe TCA boundaries. (Optional) true to force delete entity even if the component (for classEnt components) is not attached to the entity (via ent.u.classEnt). Purpose: Get pointers to descendants of this component (initialize numDescendents to 0 1st!) @param[out] pCompList list of descendants @param[in,out] numDescendents number of descendants Purpose: Count descendants of this component (initialize numCOunted to 0 1st!) @param[in,out] numCounted number of descendants Determines if this component is represented as a decendant of the parent component in the machine tree. Non-null, the parent or root of the search. true if this comonent's Db Id is found while traversing to the leaves from the starting component, else false. Purpose: Return true if this component is a descendent of the input component @param[in] pParent component to test against Purpose: Delete this component from any of the machine's axis combinations. Purpose: Determine whether or not this component is in any of the machine's axis combinations. Optionally fill in an array of axis combinations which contain this component. @param[out] pCompAxisCombos axis combo's which use this group @param[in] deleteIfFound delete from axis combo's if found Purpose: Define owner group for component @param[in] pGroup owner group for component Purpose: Return owner group for component Purpose: Return owner machine for component Purpose: Return const owner machine for component Initialises the component's GUID with given owning machine. Sets the component's owning machine pointer to the given. If non-null, the machine that owns this component. true = check validity and if duplicate. If duplicate then generate a new GUID value. false = skip this. Purpose: Add this component to the machine tree @param[in] pMachine owner machine for component @param[in] pParentComp parent component (NULL for base) @param[in] addToExisting true = add to existing children Purpose: Add this component to the machine tree @param[in] treeFlag defines how to add to tree pointers to components which are attached to the this one pointer to next sibling component attached to pParent pointer to previous sibling component attached to pParent pointer to component to which this one is attached, NULL = machine base (ground) component group to which this component belongs Write the component info to the ASCII NCI 20600 section. Open NCI file to write to. Number of lines written. Purpose: Return pointer to boundary manager Purpose: Flag whether or not to hide this component in MachineWorks simulation Sets chord height tolerance used for tesselating solids for simulation. If the given tolerance values saved is smaller than the minimum allowed then the minimum allowed value will be set. The chord height tolerance value. Gets chord height tolerance used for tessellating solids for simulation. The chord height tolerance value. Return resource string ID for describing component type. The resource string ID. Purpose: Define component translucency @param[in] translucency new component translucency TODO: [Remove] Purpose: Return component translucency TODO: [Remove] Purpose: Define component color @param[in] color new component color Purpose: Return component color Purpose: Return component descriptor for dialog controls Purpose: Add the group name in brackets (without the word group) to a string @param[in/out] string to append the group name to Purpose: Initialize component name Purpose: Return component name (use only to access, not to modify!) Purpose: Define geometry type @param[in] geomType component geometry type Purpose: Return geometry type Checks if component is a misc. component. True if the component is a misc component, otherwise false. Checks if component is a misc. tooling component. True if the component is a misc tooling component, otherwise false. Checks if component is a tool storage component. True if the component is a tool storage component, otherwise false. Checks if component is a part holding component. True if the component is a part holding component, otherwise false. Checks if component is of the requested group class. Component group class. True if the component is of the requested group class, otherwise false. Purpose: Determine if the unique ID is a duplicate of another one on the machine Purpose: Determine if the unique ID is a duplicate of another one on the machine @param[in] pComp component to compare Purpose: Copy the unique identifier @param[out] id ID to return Purpose: Copy the unique identifier @param[out] id ID to return Recursively sets the color of all the children of this component to the color of their associated model. Only sets the color if the associated model is a solid or mesh geometry. Purpose: Return true if the UID matches the one input @param[in] id UID to compare Sets component type. Component type. True if the component type was set, and false otherwise. Gets component type. Component type. Purpose: Return the general solid geometry parameters Purpose: Set current parameters @param[in] pParams component parameters Purpose: Return current parameters @param[out] pParams component parameters Sets geometry type on this component if the type is a valid type value and it is neither a parametric or chain type. Type of the geometry. True if the geometry type was set, and false otherwise. Purpose: Set selected parameters from a machine setup component @param[in] pComp component to set the parameters from Purpose: Return a reference to internal parameter structure Purpose: Returns a constant reference to internal parameter structure Purpose: Map component parameters back to the defaults Purpose: Map geometry parameters back to the defaults @param[out] dfltGeo default solid geometry Purpose: Map default geometry parameters to a component @param[in] dfltGeo default solid geometry Copies the component identifier described by src. Component object possessing the ID to copy. Query if this component object is follows the ClassEnt design. Even though the CMachineComponent derives from the ClassEnt, only the newer components actually implement it properly. The older component types store themselves to the entity using the mach_comp structure in the entity's union. The new components hang off of the entity struct via the u.classEnt member of it's super union. true if ClassEnt, false if not. Internal accept traversal. If non-null, the visitor. Accepts the given visitor. The visitor. Whether the visited object allows to visit its children or not. Purpose: Map solid geometry parameters back to the defaults @param[out] dfltGeo default solid geometry Purpose: Map default solid geometry parameters to a component @param[in] dfltGeo default solid geometry Purpose: Map default parameters to a component Purpose: Restore parameters that backed up at the start of the call to GetFromDflts() and fix anything that may be invalid Purpose: Backup parameters that need to be restored at the end of the call to GetFromDflts() Purpose: Return true if the component was defined in the MGP copy of the machine Purpose: Initalize the unique ID for this component - called from GetFromDflts() for any component Purpose: Save default parameters (called only once per session) Purpose: Initialize default parameters (called only once per session) Gets the assoc_id representing the ClassEnt type (i.e. OP_ID). Override necessary to derive components that don't use the classent mechanism. The assoc_id representing the ClassEnt type. these are parameters that must be backed up before and restored after a call to GetFromDflts() Purpose: Initialize class data on creation @param[in] compType component type @param[in] treeFlag defines how to add to tree control text descriptor for component lathe tool collision avoidance manager TODO: Remove and access the global in the clients lathe project manager TODO: Remove and access the global in the clients lathe boundary manager TODO: Remove and access the global in the clients component parameters Gets a collection filled with the pointers to the component's children. Pointers to the component's children. Gets owning machine. null if no owner, else the owning machine. Gets owning machine. null if no owner, else the owning machine. Gets the next sibling component pointer. null if it fails, else the next sibling component pointer. Sets next sibling component pointer. If non-null, the component pointer. Gets the previous sibling component pointer. null if it fails, else the previous sibling component pointer. Sets previous sibling component pointer. If non-null, the component pointer. Gets the first child component pointer. null if it fails, else the first child component pointer. Sets first child component pointer. If non-null, the component pointer. Gets the parent component pointer. null if it fails, else the parent component pointer. Sets parent component pointer. If non-null, the component pointer. Gets component ID (GUID). The component ID. Gets the component type code. Sets a description string. The new description string to set. Gets the description string. The description string. Sets a description string. The new description string to set. Gets the description string. The description string. Makes a deep copy of this object. A copy of this object. Serialize this object to the given stream. The archive. Visits the stored identifiers of associated entities and updates them via the supplied visitor. The visitor that will update the stored identifiers of associated entities. Visits the identifiers of the entities that this entity is associated to. The visitor that will accept the identifiers of the associated entities. Visits the identifiers used for database entity association and updates them via the supplied visitor. The visitor that will update the stored identifiers that can be used for association. Visit the identifiers used for database entity association that this entity defines. The visitor that will accept identifiers on this entity that can be used for association. Get Version (used in XML serialization). the version Initializes the parameters. This methods is intended to invoke all virtual functions that used to be invoked from the constructor Resets the class ent idn. The reset is not allowed if the classEnt is currently bound to a DB Entity. Copies the contents of the given src. Source to copy from. Default constructor. Copy constructor. Source for the. Purpose: Existing component parameter Constructor @param[in] pMachine owner machine for component @param[in] pGroup owner group for component (NULL for base) @param[in] pParentComp parent component (NULL for base) @param[in] pParams parameters for component @param[in] treeFlag defines how to add to tree Purpose: Default Constructor @param[in] pMachine owner machine for component @param[in] pGroup owner group for component (NULL for base) @param[in] pParentComp parent component (NULL for base) @param[in] compType component type to create @param[in] treeFlag defines how to add to tree Descibes the search condition to use for component search Machine Component Modeling Base Class. all machine components should be sub-classed from this class, or other component classes which have been sub-classed from it Purpose: Save component parameters @param[in] filename name of defaults file @param[in] comp component parameters to initialize @param[in] geo geometry parameters to initialize Initialize component parameters. Type of the component. component parameters to initialize. geometry parameters to initialize. A macro that applies dynamic casting. The derived class. The base base class. Enum represents the machine tree's display context. Update legacy jaws to 2020 version. Machine that contains the jaws to update. This method aims to update the local copy of legacy part file. It will look at the chuck channel depth property and will update the jaws accordingly. Extend jaw geometry "width" of the chuck channel width if required. Jaw map ordered from left to right spindle based on the init pos property. This map contains ptr on jaws whose will be extended. Chuck map ordered from left to right spindle based on the init pos property. This map contains ptr on chucks that provide the channel depth value. Modify a CCNCMachine to make it GMD compliant. The machine to make GMD compliant. The filepath of the new gmd file. TRUE : machine is GMD compliant, FALSE : an issue occurred. Generates a gmd file path. Keep the path but changes the name of the "gmdPathToUpdate" parameter. Gmd file path to update. TRUE : gmd in metric, FALSE in imperial. Knowing about the unit system is required to construct the gmd file name as we have a gmd for each unit system. TRUE : GMD filepath generated correctly, FALSE : an issue occurred Add and fill new groups (Chuck, Chuck Jaws, Default left and right spindle) to a 2019 gmd file. The 2019 gmd filename to update. If empty will be generated. The 2019 lmd filename to look at to extract chuck components. The 2019 default op. filename to look at to extract chuck jaws components . TRUE : gmd in metric, FALSE in imperial. Convert V2019 gmd to V2020. The 2019 inch gmd file name, will be filled if empty. The 2019 metric gmd file name, will be filled if empty. The 2019 lmd file name. The 2019 inch default op file name. The 2019 metric default op file name. TRUE : GMD files converted correctly, FALSE : an issue occurred Makes a shallow copy from another MdClassEnt object. This function must not be made public or virtual so that derived types do not attempt to copy from any other type than their own. Source to copy from. Initialize the unique ID for this component - called from GetFromDflts() for any component. The identifier source I/O. Initialized if NULL. Get the owner machine. Ptr on the owner machine. Set the owner machine. The owner machine. Gets the component's "Assoc" entity type value. The component's "Assoc" entity type value. (see AssocEntityTypes_CH.h) Copies the UID described by ID. The component id type to copy from. I/O. Initialized if NULL. The identifier to copy in. Return true if the ID has been defined (not all 0's) True if it succeeds, false if it fails. Return true if the UID matches the one input. The component id type to compare. I/O. Initialized if NULL The identifier to compare with. True if it succeeds, false if it fails. Get Version (used in XML serialization). the version Finalizes an instance of the ClassEnt class. Initializes a new instance of the MdClassEnt class. (Optional) If non-null, the machine that owns this item. (Optional) If non-null, the UID. Class that provides specific feature for machine component ClassEnt style. The main purpose is to factorize data member and behavior between component groups and components. Defines an alias representing a std::unique_ptr to a IMdClassEnt. Makes a deep copy of this object. A copy of this object. Query if this component object is follows the ClassEnt design. Even though the CMachineComponent derives from the ClassEnt, only the newer components actually implement it properly. The older component types store themselves to the entity using the mach_comp structure in the entity's union. The new components hang off of the entity struct via the u.classEnt member of it's super union. true if ClassEnt, false if not. Destructor. Gets the component's "Assoc" entity type value. The component's "Assoc" entity type value. (see AssocEntityTypes_CH.h) Common classEnt interface for components and component groups. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given component. The component to visit. Visits the given Lathe Center component. The component to visit. Visits the given "guide bushing" component. The component to visit. Visits the given "gang tool holder" component. The component to visit. Visits the given fixture component. The component to visit. Visits the given "drill block" component. The component to visit. Visits the given "jaws" component. The component to visit. Visits the given "chuck" component. The component to visit. Visits the given "collet" component. The component to visit. Visits the given "chuck" component. The component to visit. Visits the given aggregate head component. The component to visit. Visits the given "automated tool changer" (ATC) component. The component to visit. Visits the given machine component (generic). This will be invoked if an component subclass is visited that does not have its own specialize version of this method. The component to visit. Visits the given reference position list. The reference position list to visit. Visits the given reference position list. The reference position list to visit. Visits the given reference position. The reference position to visit. Visits the given axis combo. The axis combo to visit. Destructor. Visits the given machine. The machine to visit. Interface for a visitor class intended for visiting the CNCMachine and its components. We must remember to add and remove Visit abstract methods to corresponding to any changes with the component subclasses Default constructor. Machine definition component factory. Makes a component. The data. An IMdComponentUniquePtr. Destructor. Default constructor. Machine definition component factory. Removes any of the two temporary drawing levels if there are no entities in them. turn off ALL visible levels, except main level. The parameter will go away, once all viewing process will use our viewing services. (Optional) True to backup level state. Get supported group types based on machine type and group class. The machine type. The group class. The group types. Enum describing the levels of compatibility WRT transfering tool and part holding components. Replace Machine Error Code enumeration. Select machine. The machine file. true if it succeeds, false if it fails. Replace MT machine message box. The group. true to force reload. true if it succeeds, false if it fails. Replace machine. The machine file. The group. true to force reload. (Optional) true to mgp settings window. Error Code showing where it failed during Replace. Re load MT machine from file. The group. null if it fails, else a CCNCMachine* with the new MT machine. Process the machine group. The group. true to force reload. Process the machine groups. true to force reload. true if it succeeds, false if it fails. Destructor. Default constructor. update any machines/files that are missing in the MT machine groups. Gets all file types. [in,out] List of types of files supported. Gets the string identifier, which represents the NC Output folder, of the active machine configuration used to program the current part. String representation of the machine configuration NC Output folder. Sets the string identifier, which represents the NC Output folder, of the active machine configuration used to program the current part. String representation of the machine configuration NC Output Folder. Boolean flag for MGP overriding of the machine map. Initializes this object from the given initialise from machine. If non-null, the machine. Initializes this object from the given initialise from machine group. If non-null, group the mach belongs to. Sets the product of the machine. Product code of the machine. Gets the product code of the machine. Product code of the machine. Sets the string identifier, which represents a Guid, of the active machine configuration used to program the current part. String representation of the machine configuration Guid. Sets the string identifier, which represents a Guid, of the active machine configuration used to program the current part. String representation of the machine configuration Guid. Gets the dentifier, which represents a Guid, of the active machine configuration used to program the current part. The machine configuration Guid. Sets file name. Filename of the file. Type of the file. (Optional) true to override. File name. Type of the file. (Optional) full pathname of the adjust file. A CString. Files the given file. Type of the file. (Optional) full pathname of the adjust file. A CSystemFile. Adjust path. Type of the file. A CString. Flags the Machine Group Properties override case. The value. Flags the Machine Group Properties override case. true if mgp overridden, false if not. Clears the file names and GUID in the map. Sets a valid flag to know the map is ready for use. The valid. Gets the valid flag. true if it succeeds, false if it fails. Sets the identifier of the session that manipulates this machine. The session identifier. Gets the identifier of the session that manipulates this machine. The session identifier. Sets machine group Id. Id of the machine group. Gets machine group Id. The machine group Id. Sets a name of the Machine. The name. Gets the name of the Machine. The name. Operator = to copy the Data from one map to another. Destructor. Default constructor. Alias for vector of component Id (i.e GUID) values. Alias for map that maps MdComponentId (key) to the corresponding component's pointer. Return true if the ID matches the one input. If non-null, the UID. The identifier. True if equal, false otherwise. Initalize the unique ID. If non-null, the UID. The identifier. The machine. Indicate if this MDComponentId object is attached to the given component ID struct. component ID object to test if connected. true if attached to this, false if not. Greater-than comparison operator. The right hand side. true if the first parameter is greater than to the second. Less-than comparison operator. The right hand side. true if the first (this) Id is less than the right hand side. Convert this object into a string representation. true = encode the group Id in the string. if this option is enabled then the ComponentId can be fully restored from the resulting string using the FromString method. false = don't encode the group ID in the resulting string. This only allows you to recover the GUID and not the group id when using FromString. A CString that represents this object's ID. Initialises the group from machine. If non-null, the machine. Initialises the TP group identifier directly. Group the identifier the object getting the ID belongs to. Determine if the given string can be parsed into a Guid. Text to check. True if the string can be parsed into a Guid. Serialize this object to the given stream. The archive. Initializes a new instance of the MdComponentId_E class. The identifier string. (Optional) Machine group ID that the component belongs to. Initializes a new instance of the MdComponentId_E class. If non-null, source to copy from. (Optional) If non-null, (Optional) Machine to initialize group ID from. Initializes a new instance of the MdComponentId_E class. Source to copy from. (Optional) If non-null, (Optional) Machine to initialize group ID from. Copy constructor. Source to copy from. Initializes a new instance of the MdComponentId_E class. See if Start up compliance data was sent. True if data was already sent, false otherwise. Sends the compliance data during Mastercam start up. Gets the current part file version. The current part file version. Generate a Mastercam account linking code. LinkCodeError::Success if generation succeeds, otherwise an error code. If successful, a registration code string. Check for a Prototype license or a valid ACC file. False == complain if none available. True if license there is a license for Prototypes, otherwise false. Get the type of SIM currently being used as legacy values, and also put any compliance infringement reason inside it. Output: Reference to a string in which the unique compliance session id will be stored (can be empty). legacy type of License being used (HASP, NETHASP, or WIBU) + (1000 * infringementReason) Creates Code Expert command line arguments that specify the type of license to use. Code Expert licensing command line arguments. Release a CoroPlus license. True if the license was released, false if it wasn't (perhaps not checked out?). Grab a CoroPlus license. (Optional) Warn if none available (default = false). True if license acquired, otherwise false. Release a ProDrill license. True if the license was released, false if it wasn't (perhaps not checked out?). Grab a ProDrill license. (Optional) Warn if none available (default = false). True if license acquired, otherwise false. Check to see if there is a license for the given product The product type as specified by the application enable bits (AEB_MILL, AEB_LATHE, etc.). True if a license for the product was found, otherwise false. Get the url to container info page of web admin." The url to container info page of web admin. Determine if this is a pre-release version of Mastercam. True if pre-release, otherwise false. Free a license if network licensing is active. The program number to free (for network licensing). True if the license was freed, otherwise false. Acquire a NetHasp or CodeMeter license for a C-Hook. The program code to grab. False to complain if it fails. true if the license was acquired. Determines if we are using network licensing. False if we're using a Hasp, otherwise true. Get the current time using various methods. Which time to acquire (see definitions in CodemeterTime). Returned - a time value (number of seconds since January 1, 1970). True if the time was acquired, otherwise false. Return the IP address of the license server (software licenses only). The IP address of the server if we're using software licensing, otherwise an empty string. Return the computer name of the license server (software licenses only). The name of the server if we're using software licensing, otherwise an empty string. Determine whether the current license is a subscription license (software licenses only). True if this is a software subscription license, false if not. Determine whether the current license is an evaluation license (software licenses only). True if this is a software evaluation license, false if not. Determine whether the current license is a borrowed license (software licenses only). True if this is a borrowed software license, otherwise false. Check for a CmAct, CmStick, or CmCloud license. The type of Wibu license we are using. Change the command switches of the license. Called by ATF. The command line switches Run Automated Testing Framework test to check licensing. True if the tests run. Return all pertinent information on Mastercam licensing. The "Help/About" structure to populate. True if all of the info in the structure is valid. Return whether or not a given Mastercam Multi-Axis operation is licensed A TP_OPCODE (see ToolpathOperationCodes_CH.h). Put up warning if not licensed? (optional, default == true). True if available, false if not. Acquire a Mastercam Probing add-on license. True if license is acquired, otherwise false. Return whether or not a license for the Mastercam Probing add-on is available. True if Mastercam Probing add-on is properly licensed. Release the Mastercam Probing add-on license. True if the license was released, false if it wasn't (perhaps not checked out?). Acquire a Tps add-on license. True if license is acquired, otherwise false. Return whether or not a license for the Tps add-on is available. True if Tps add-on is properly licensed. Release the Tps add-on license. True if the license was released, false if it wasn't (perhaps not checked out?). Release the Deburr add-on license. True if the license was released, false if it wasn't (perhaps not checked out?). Acquire a Deburr add-on license. True if license is acquired, otherwise false. Return whether or not a license for the Deburr add-on is available. True if Deburr add-on is properly licensed. Release the APlus add-on license. True if the license was released, false if it wasn't (perhaps not checked out?). Acquire an APlus add-on license. True if license is acquired, otherwise false. Return whether or not a license for the A-Plus add-on is available. True if A-Plus add-on is properly licensed. Return whether or not a Mastercam Multi-Axis operation is available to the current user based on a set of rules defined by Sales which may depend on Operation Type, Product, Product Level, and/or User type. If it fails and 'warnUser' is 'true', it will report the reason to the user. op code may equal 0, in which case it will check for a MultiAxis license without any special rules. A TP_OPCODE (see ToolpathOperationCodes_CH.h). Put up warning if not licensed? (optional, default == true). True if available, false if not. Return whether or not Swarf5AX is available to the current user based on Product and SIM type. Put up warning? (optional, default == true). True if available, false if not. Return whether or not Curve5AX/Drill5AX is available to the current user based on Product and SIM type. Put up warning? (optional, default == true). True if available, false if not. Determine if the UBVS MachSim Lite is available to the current user based on Product and SIM type. (Optional) True to display fail message. True if available, false if not. Determine if the UBVS Verify functionality is available to the current user based on Product and SIM type. True if available, false if not. Determine if the UBVS Backplot functionality is available to the current user based on Product and SIM type. True if available, false if not. Determine if MW's MachSim is available for running. (Optional) True to display fail message. True if available, false if not. After successfully accessing permission to run BladeExpert, and after executing the functionality, release the BladeExpert NetHASP license. This will do nothing if a local HASP is in use. True if the license was released, false if it wasn't (perhaps not checked out?). Acquire a Blade Expert license. True if license is acquired, otherwise false. Return whether or not BladeExpert functionality is available to the current user based on Product and SIM type if true, user has a valid license, he is able to use BladeExpert and if a NetHASP is being used, a license will be checked out. Put up warning? (optional, default == true). True if Blade Expert is properly licensed. After successfully accessing permission to run PortExpert, and after executing the functionality, release the PortExpert NetHASP license. This will do nothing if a local HASP is in use. True if the license was released, false if it wasn't (perhaps not checked out?). Acquire a Port Expert license. True if license is acquired, otherwise false. Return whether or not PortExpert functionality is available to the current user based on Product and SIM type if true, user has a valid license, he is able to use PortExpert and if a NetHASP is being used, a license will be checked out. Put up warning? (optional, default == true). True if Port Expert is properly licensed. Return whether or not the MZX C-Hook is available to the current user based on Product and SIM type if true, user has a valid license, he is able to use MZX. True if MZX C-Hook is available. Return whether or not Art functionality is available to the current user based on Product and SIM type if true, user has a valid license, he is able to use ArtToolpaths. True if Art Toolpaths are properly licensed. Release a previously acquired ART network license. True if the license was released, false if it wasn't (perhaps not checked out?). Check out and Art network license. True if Art license successfully checked-out. Return whether or not Art functionality is available to the current user based on Product and SIM type if true, user has a valid license, he is able to use ArtDesign. False if ART is not accessible. Return whether or not Art functionality is available to the current user based on Product and SIM type if true, we display Art Menu, otherwise we do not display it. False if Art is not available. Return whether or not the Engrave is available to the current user based on Product and SIM type. False if Engrave is not available. Return whether or not the EPS file reader is available to the current user based on Product and SIM type. False if EPS reader is not available. Return whether or not the text chaining is available to the current user based on Product and SIM type. False if TxtChain is not available. Return whether or not the Raster-to-Vector is available to the current user based on Product and SIM type. False if R2V is not available. Get maintenance information - Is it on the SIM? If so, when does it expire? Returned - a formatted character string. Returned - the number of days left until maintenance expires. Pointer to a date/time format string (optional, default = mm/dd/yyyy). True if Maintenance is enabled (if false, all return arguments are meaningless). Check the Mastercam .EXE against the SIM's maintenance date. Put up warning? (optional, default == true). False if maintenance date is older then Mastercam.exe date. Check a .DLL against the SIM's maintenance date. Name of the DLL. Put up warning? (optional, default == true). False if maintenance date has expired. Check what verification functionality is available. False if the sim level is lower than the required level. Check the SIM level against the minimum required Multi-Axis level for Swarf 5 Axis. False if the sim level is lower than the required level. Check the SIM level against the minimum required Multi-Axis level for Curve 5 Axis. This function WILL pop up an error dialog if the product level is not high enough False if the sim level is lower than the required level. Check the SIM level against the minimum required Multi-Axis level for Swarf 5 Axis. False if the sim level is lower than the required level. Check the SIM level against the minimum required Multi-Axis level for Curve 5 Axis. False if the sim level is lower than the required level. Check the SIM level against the minimum required Mill-Turn level. This function WILL pop up an error dialog if the product level is not high enough The minimum level (ProductLevel::Entry). False if the sim level is lower than the required level. Check the SIM level against the minimum required Wire level. This function WILL pop up an error dialog if the product level is not high enough The minimum level (ProductLevel::LatheE or ProductLevelLathe). False if the sim level is lower than the required level. Check the SIM level against the minimum required Lathe level. The minimum level (ProductLevel::LatheE or ProductLevel::Lathe). False if the sim level is lower than the required level. Check the SIM level against the minimum required Wire level. This function WILL pop up an error dialog if the product level is not high enough The minimum level (ProductLevel::Entry or ProductLevel::Level2). False if the sim level is lower than the required level. Check the SIM level against the minimum required Wire level. The minimum level (ProductLevel::Entry or ProductLevel::Level2). False if the sim level is lower than the required level. Return true if the product level is not Entry (Design, Mill level 1, Lathe level 1 and Wire level 2 all qualify). This function WILL pop up an error dialog if the product level is not high enough False if the sim level is lower than the required level. Return true if the product level is not Entry (Design, Mill level 1, Lathe level 1 and Wire level 2 all qualify). False if the sim level is lower than the required level. Check the SIM level against the minimum required level. This function WILL pop up an error dialog if the product level is not high enough The minimum level (1 = Entry, 4-6 = Level 1-3). False if the sim level is lower than the required level. Check the SIM level against the minimum required level. The minimum level (1 = Entry, 4-6 = Level 1-3. The current level. False if the sim level is lower than the required level. Check the SIM level against the minimum required level. The minimum level (1 = Entry, 4-6 = Level 1-3. Returned - The current level. False if the sim level is lower than the required level. Check that the SIM level allows design functions (C-Hooks, create surface, shading, etc.). True if Design is enabled. Check that the SIM level allows design functions (C-Hooks, create surface, shading, etc.). True if Design is enabled. Return true if the specified MT user level is currently enabled one of: MT_USER_ADMIN, MT_USER_DEVELOPER, MT_USER_CONSUMER. The user type to check for. True if MT user level is MT_USER_ADMIN, MT_USER_DEVELOPER, or MT_USER_CONSUMER. Makes sure that the access code for the given file checks out. Access code file name. Product number imbedded in the access code. True to prompt for an access code. True if it's a good access code file for a given SIM, otherwise false. Check that the Probing add-on is enabled on the SIM. Probing is allowed if we're in Mill or Router, and there is a Probe license Put up warning dialog? (optional, default == false). true if Probing is enabled on the SIM. Check that the 5-Axis add-on is enabled on the SIM. MultiAxis is allowed if we're in Mill, Router, or Lathe and there is a MultiAxis license Put up warning dialog? (optional, default == false). true if 5-Axis is enabled on the SIM. Check that the customer is currently using a Local NetHASP. true if the customer is currently using a Local NetHASP (Note that this now ALWAYS returns false). Determines the type of user this SIM has been set up for. the user type (of types INDUSTRIAL, EDUCATIONAL, DEALER, etc,). Determines the type of user this license has been set up for. the user type (see the LicenseUserType enum for values). Determine the current version of the DESIGN product. Version number - V_X unless it's a really old SIM; 0 if it is not enabled. Determine the current version of the ART product. Version number - V_X unless it's a really old SIM; 0 if it is not enabled. Determine the current version of the ROUTER product. Version number - V_X unless it's a really old SIM; 0 if it is not enabled. Determine the current version of the WIRE product. Version number - V_X unless it's a really old SIM; 0 if it is not enabled. Determine the current version of the LATHE product. Version number - V_X unless it's a really old SIM; 0 if it is not enabled. Determine the current version of the MILL product. Version number - V_X unless it's a really old SIM; 0 if it is not enabled. Determine whether the current SIM will allow us to run Art. true if it can be run; false if not. Determine whether the current SIM will allow us to run Router. true if it can be run; false if not. Determine whether the current SIM will allow us to run Mill-Turn. true if it can be run; false if not. Determine whether the current SIM will allow us to run Lathe. true if it can be run; false if not. Determine whether the current SIM will allow us to run Wire. true if it can be run; false if not. Determine whether the current SIM will allow us to run Mill. true if it can be run; false if not. Determine whether the current SIM will allow us to run Design. true if it can be run; false if not. Get the highest Art product level available on the current SIM. Art product level (of types ProductLevel::Entry, ProductLevel::Level1). Get the highest Router product level available on the current SIM. Router product level (of types ProductLevel::Entry, ProductLevel::Level2D, ProductLevel::Level3D). Get the highest Mill-Turn product level available on the current SIM. The Mill-Turn product level level. Get the highest Lathe product level available on the current SIM. Lathe product level (of types ProductLevel::Entry, ProductLevel::Level1). Get the highest Wire product level available on the current SIM. Wire product level (of types ProductLevel::Entry, ProductLevel::Level2). Get the highest Mill product level available on the current SIM. Mill product level (of types ProductLevel::Entry, ProductLevel::Level2D, ProductLevel::Level3D). Check if the SIM is 'timed', and if so, how many days remain? Number of days until expiration. true if the SIM is 'timed', otherwise false. Get the type of license currently being used. type of License being used (see the LicenseType enum for values). Get the type of SIM currently being used as legacy values. legacy type of License being used (HASP, NETHASP, or WIBU). Get the application enable bits for the active machine. The application enable bits. Return SIM version and level information 0: Milling version number 1: Milling level (1 = entry, 4 - 6 = level 1 - 3) 2: Lathe version number 3: Lathe level (0 = level 1, 1 = entry) 4: Wire EDM version number 5: Wire EDM level (1 = entry, 2 = level 2) 6: Solids version number 7: Solids level (0) 8: Design version number 9: User type (INDUSTRIAL, EDUCATIONAL, DEALER, etc) 10: Start date (0 for no time limit) 11: End date (0 for no time limit) Returned - The 12-element vector containing levels and versions. For a software license, return the Customer Name in the COLI field. The customer name. For a software license, return the Customer Id in the COLI field, otherwise return the license number. The customer number or license number. Determines the license number of the license we are using. The license number. Defines an alias representing a std::unique_ptr to a IMdComponent. Defines an alias representing a std::shared_ptr to a IMdComponent. Defines an alias representing a vector of IMdComponent raw pointers. Gets attached database entity's idn. The attached database entity's idn. Gets owning machine. null if no owner, else the owning machine. Gets owning machine. null if no owner, else the owning machine. Gets a collection filled with the pointers to the component's children. Pointers to the component's children. Gets the next sibling component pointer. null if it fails, else the next sibling component pointer. Sets next sibling component pointer. If non-null, the component pointer. Gets the previous sibling component pointer. null if it fails, else the previous sibling component pointer. Sets previous sibling component pointer. If non-null, the component pointer. Gets the first child component pointer. null if it fails, else the first child component pointer. Sets first child component pointer. If non-null, the component pointer. Gets the parent component pointer. null if it fails, else the parent component pointer. Sets parent component pointer. If non-null, the component pointer. Gets component ID (GUID). The component ID. Gets the component type code. The component type. Sets a description. The name. Gets the description. The description. Sets a name. The name. Destructor. Gets the name. The name. Interface describing a machine definition component. Get a list of center tools used in tailstock operations. The center tools used. Gets tools used. The populated collection of tools used data. True to check selected operations. List of identifiers for the selected operations. true if it succeeds, false if it fails. Get a list of tools used in operations. Note: Tools used in dirty xform ops are not counted. Note: Tools used in fbm op are not counted since fbm has no toolpath. List of tools used. Check if the given tool is in the tool list. I: If non-null, machine group to check. I: The tool entity to load. I: true - only check selected operations. I: True to include, false to exclude ghosted operations. True if the tool is used, false if not. Add tool to the list, if it's not already in the list. The tool used to add. Initialize the tool list. Class to hold tool used list. Query if the operation mapped by this instance uses any of the specified tool slots. The slots. True if it succeeds, false if it fails. Query if hte operation mapped by this instance uses the specified tool slot. The slot. True if it succeeds, false if it fails. Equality operator. The right hand side. True if the parameters are considered equivalent. Initialises this object. Default constructor. Class to hold tool used info. Reloads the Token Map. Inserts entry into the map. Map key which is the name of the token subfunction. The token item. Clears this map to its blank/initial state. Gets the size. The size. Sets successful receive flag on all. true to successfull read from code expert. Gets CString/State token value out of token map/dictionary. Key string identifying token token state/string value. true/false = success/token not found or bad value type. Gets double token value out of token map/dictionary. Key string identifying token token double value. true/false = success/token not found or bad value type. Gets integer token value out of token map/dictionary. Key string identifying token token integer value. true/false = success/token not found or bad value type. Gets bool token value out of token map/dictionary. Key string identifying token token bool value. true/false = success/token not found or bad value type. Finalizes an instance of the TokenDefaultsMap class. Initializes a new instance of the TokenDefaultsMap class. Map of token request objects which will be filled through a query to CodeExpert. Checks if position unique identifier exists in list. The machine position with the GUID to check. true if it succeeds, false if it fails. Try to parse and interpret the X7 reference position name into X8 reference position properties. Will attempt to delete the entity from the database if fails to create a valid newer type machine position The mach position. The mach position ent. True to delete the invalid entity. Unit conversion type. Initialize the list of reference positions from an open file (X7 and older versions). The first machine position in the list. The file. Unit conversion type. Initialize the list from an open file (current version). List of machine position entities. The (open) file information. Unit conversion type. Initialize the list from the database (X7 and older versions). The first machine position. Initialize the list from the database (current version). List of machine position entities. Find a position from the list by unique ID. The unique ID for the position The (unmodifiable) position found. Find a position from the list by listId. List id for the position. The (modifiable) position found. Find a position from the list by listId. List id for the ent. The (unmodifiable) position found. Find a position from the list by entId. Entity id for the position. The (modifiable) position found. Find a position from the list by entId. Entity id for the ent. The (unmodifiable) position found. Finds the next unique list identifier. The next unique list identifier. Returns a const iterator to the end of the embedded position vector. This allows us to use the range base for directly on this class. Const iterator to the end of the embeded position vector. Returns a const iterator to the beginning of the embedded position vector. This allows us to use the range base for directly on this class. Const iterator to the beginning of the embeded position vector Save the entity id's . List of identifiers for the entitiess. Initialises the entity id's to 0. Initialize the list from an open file. Entity id for the list. The (open) file information. Unit conversion type. Saves the list to the database. The entity id list entity id if it succeeds, 0 otherwise. Initialize the list from the database. Entity id for the list. Update a position in the list. index for the position to update. The new machine position parameters. true if the position is in the list, false if it isn't. Update a position in the list. List id for the position to update. The new machine position parameters. true if the position is in the list, false if it isn't. Update a position in the list. Entity id for the position to update. The new machine position parameters. true if the position is in the list, false if it isn't. Delete all positions from the list. Delete the entities too. Delete entities for all positions in the list. Deletes all positions using the axis combination. The axis combination component ID. Delete a position by list id. List identifier for the position to delete. true = delete the entity also. true if the position is in the list, false if it isn't. Delete a position by entity id. Identifier for the position to delete. true = delete the entity also. true if the position is in the list, false if it isn't. Delete a position by index. Zero-based index of the position to delete. true = delete the entity also. true if the position is in the list, false if it isn't. Adds a position to the list. If the GUID of the machine position being added has a match in the current list then a new unique GUID will be assigned to the newly added position. The machine position. The list id of position added to the list. Gets the home position in the list for a given axis combo. Identifier for the axis combo. The home position found. true if it succeeds, false if it fails. Gets a position. Unique identifier. The machine position. true if the position is in the list, false if it isn't. Gets a position by list id. List id for the position. The machine position. true if the position is in the list, false if it isn't. Gets a position by entity id. Entity id for the position. The machine position. true if the position is in the list, false if it isn't. Queries if a given position exists. Entity id for the position. true if the position is in the list, false if it isn't. Get a position from the list by index. Zero-based index of the position in the list. The mach position. true if it succeeds, false if the index is invalid. Return the number of machine positions defined. The number of machine positions defined. Determines if this list has a position that uses the input axis combination. The axis combination to check. true if it does, false otherwise. Determines if this a list from an MGP machine. true if this a list from an MGP machine, false otherwise. Sets a machine for this list. The machine to use. Destructor. Initializes a new instance of the MachinePositionList class. If non-null, the machine object to which the MachinePositions refer to. Initializes a new instance of the MachinePositionList class. Source for the. Initializes a new instance of the MachinePositionList class. Class to manage a list of machine positions. Update an axis combination from an X7 axis combination. The X7 axis combination. The current version axis combination. X7 data format converters for X8 (2014? 2015?) data Update a machine position from an X7 machine position. The X7 machine position. The current version machine position. Identifier for the list. The machine to which this position belongs. position data for axis Update an axis position from an X7 axis position. The X7 axis position. The current version axis position. Update the source from an X7 data source. The X7 data source. The current version source. Initalize the unique ID for this machine position. Inequality operator. position to compare. true if the parameters are not considered equivalent. Equality operator. position to compare. true if the parameters are considered equivalent. Assignment operator. The position. Determine if we can be delete this reference position from its list. true if it can be deleted, false if not (i.e it's used in an operation). Restore data in this position with data from parameter. The position to use for restoring the data. Makes new copy with new unique identifier. The new duplicate position. Query if this object is valid. Determines if object content is complete and valid. true if valid, false if not. Determine available axes in the axis combo (X,Y,Z,B only). X axis exists in axis combo. Y axis exists in axis combo. Z axis exists in axis combo. B axis exists in axis combo. Map this machine position to an operation reference point. The operation with the reference point. true = entry, false = retract. Save the machine position entity to the database. true if the entity was saved, false otherwise. Initialize from a X7 version of the machine_position structure. This structure is used in pre-Sept 2013 'X8' files. The X7 machine position. Parse a x7 reference position name for type and sets appropriate axis combo. Position name. true if it succeeds, false if it fails. Define the machine position from an entity in a file. Identifier for the entity. The (open) file information. Unit conversion type. true if the entity was read in, false otherwise. Define the machine position from a database entity. Identifier for the entity. true if the entity was read in, false otherwise. Delete the machine position entity from the database. true if the entity was deleted, false otherwise. Convert the parameters to the specified unit system. Unit conversion type. Return the axis position type. The axis (X_AXIS, Y_AXIS, etc.). . Return the axis coordinate value. The axis (X_AXIS, Y_AXIS, etc.). The axis coordinate value. Sets axis position. The information for the axis. The axis (X_AXIS, Y_AXIS, etc.). Return the information for a specific axis. The axis (X_AXIS, Y_AXIS, etc.). The information for the axis. Gets axis positions. The axis positions. Sets the module in which this position was defined (machine vs job setup).. The source (machine or job setup). Return the module in which this position was defined (machine vs job setup). The source (machine or job setup). Sets a value indicating whether this machine position is the default reference return position for its associated stream. Value indicating whether this machine position is the default reference return position for its associated stream. Gets a value indicating whether this machine position is the default reference return position for its associated stream. Value indicating whether this machine position is the default reference return position for its associated stream. Sets the NC output generated for this reference position. the NC output generated for this reference position. Gets the NC output generated for this reference position. the NC output generated for this reference position. Sets the reference position type. The reference position type. Return the reference position type. The reference position type. Sets the comment for this machine position. The comment. Return the comment for this machine position. The comment for this machine position. Sets the name of this machine position. The name. Return the name of this machine position. The name of this machine position. Set the unique ID of the machine position from string. The string of unique ID. Copy the unique ID to id. The unique ID. Return true if the unique ID has been defined (not all 0's). true if the unique ID has been defined. Return true if the unique ID matches the one to test. The identifier to compare. true if the unique ID matches the one to test, false otherwise. Gets the axis combination. The axis combination for this position or NULL if it fails. Gets the axis combo entity id. The axis combo entity id. Sets axis combination unique id. The axis combination entity id. Sets axis combination unique id. The axis combination unique id. Gets the axis combo unique id. The axis combo unique id. Sets the list id for this position. List id for this position. Gets list id for this position. The list id for this position. Sets the entity id for this position. Entity id for this position. Gets entity id for this position. The entity id for this position. Sets the machine. The machine. Gets the machine. The machine for this position. Sets the parameters. The position. Return the machine position structure. the machine position structure. Destructor. 'From database' Constructor. machine for this position. ID of entity to initialize from. Parameter Constructor. machine for this position. (Optional) position to initialize from. Copy Constructor. position to initialize from. Default Constructor. Machine Position Class <br> A machine position consists of the following parameters:<br> - name<br> - comment<br> - type<br> - source definition module (machine vs job setup)<br> - an axis combination<br> - coordinate for each axis in the axis combination (or no motion flag) Used for: - absolute machine axis positioning - axis retraction (ex. G28) and home position moves 0-based index of data stream for this axis combination list of null tool change event lists list of tool change retract event lists list of tool change approach event lists unique identifier for related mapped axis combination unique identifier for this axis combination ent_idn for wire upper guide group component list ent_idn for wire upper guides ent_idn for lists of components (this list is stored in the database as an ent_idn_list) Reference points (1st array: OD/ID. 2nd Array: Inch, mm. 3rd Array: Entry, retract) Tool change (V9 home) position (inch, mm) Axis combination name Machine position type and method of positioning (actual position vs mach ref pt) (it can be used more universally for other things) Positions (coordinates + method of getting there) for all axes X7 axis positions. Axis coordinate unit conversion flags @par Purpose: determines if the safezone is okay to draw and then sets the setup.safezone_draw flag @param[in] calc_lines true = recalc safezone geometry in setup @param[in] grp_idn group id # (default = 0) @return true if safezone is okay to draw; false if not @par Purpose: determines if the stock is okay to draw and then sets the setup.stock_draw flag @param[in] calc_lines true = recalc stock line end pts in setup @param[in] pMachineGroup group @return true if stock is okay to draw; false if not Free setup sheet captures. Sets up the sheet capture screen. The caption. Name of the file. Use color. success. Write bmp files containing images of given lathe tool pointer to lathe tool. create bmp file of tool bitmap (y/n). name of bmp file written. create bmp file of tool holder (y/n). name of bmp file written. create bmp file of tool insert (y/n). name of bmp file written. color image (y/n). True if it succeeds, false if it fails. Write bmp files containing images of given mill tool pointer to mill tool (supply pTool or pOperation but not both). pointer to mill operation (supply pTool or pOperation but not both). create bmp file of 3d tool image (y/n). name of bmp file written. create bmp file of 2d tool image (y/n). name of bmp file written. create bmp file of tool type (y/n). name of bmp file written. color image (y/n). True if it succeeds, false if it fails. Write bmp file containing image of given operation pointer to operation. name of bmp file written. A Setup sheet view modes enumeration value. color image (y/n). True if it succeeds, false if it fails. Gets tool or material rpx filename. true if tool report. Current product. Report style. Rpx filename. Executes the 'material report for selected ops' operation. The resulting XML files. True if it succeeds, false if it fails. Executes the 'tool report for selected ops' operation. The resulting XML files. True if it succeeds, false if it fails. Gets the extents data for an operation. Pointer to operation to be processed. The extents data. Executes the setup sheet on selected operations without user interface using a defined rpx. [in,out] The XML files. [in,out] The rpx files. [in,out] Report names. true if it succeeds, false if it fails. An "operation extents data" package. Values that represent setup sheet view modes. Values that represent setup sheet report styles. Values that represent tool sort order. Executes an Offset Chains operation. The chains. The offset parameters. The list of the database eptrs of the result geometry. true if it succeeds, else false if not. Default constructor. Offset Chains parameters. Values that represent method of fillet modification. Values that represent direction of translation. Values that represent method of calculating depth. Values that represent method of translating. Executes a Break Many Pieces operation. The list of selected eptrs to break into many pieces. The break many pieces parameters. The list of the new database eptrs created by this operation. The list eptrs that the operation had errors breaking into many pieces. true if it succeeds, else false if not. Constructor. Metric flag. The tolerance. Parameters class. Values that represent the action to take on the selected curves after they are broken. Values that represent method for segments. @par Purpose: extract pts in world coordinates from any nci line @param[in] n ptr to nci line @param[in] view_n current tool view # @param[in] torg current tool origin pt (view coords) @param[out] wep1 nci point in world coords @param[out] wcpt nci arc center in world coords @param[out] n_pts number of pts found @par Purpose: for a few selected fields we can update the binary nci directly without requiring a regeneration of the operation. Test for these minimal changes and update if we can. @return return true if nci updated and a regen is not required @param[in] old_op operation before edit @param[in] new_op operation after edit @param[in] called_from_opmgr true = called from OpMgr @par Purpose: this method gets the internal stretching flag. @return value of internal stretching flag @par Purpose: this method sets the internal stretching flag. @param[in] value desired setting for internal stretching flag Do the "transform - move to origin" action. The "from point" (world coordiantes). (optional) True to move all entities, false to move only currently selected entitites. MC_NOERROR or MC_ERROR return code. Updates the new tool data from the old tool data. The input. The output. Updates the new tool data from the old tool data. The input. The output. Converts a new tool into an old tool. The input. The given data converted to an old. Converts a new tool into an old tool. The input. The given data converted to an old. Gets a pointer to the internal tool system. The internal tool system. Backfills tools as needed. To be used when loading a part file and the database tool list is inconsistent with the database TlMgr. Query if 'assemblySlot' is assembly used by multi threaded ops. The assembly slot. true if assembly used by multi threaded ops, false if not. Searches existing tool storage bins for corrupted slots. (optional) [in] If true, a message will be displayed regardless of search outcome. True if the tool storage mechanisms are corruption-free Assigns the specified assembly's holder to the provided operation. The assembly who's tool holder is to be assigned. The operation to have tool holder information assigned to it. true if assembly slot changed. true if it succeeds, false if it fails. Assigns the specified lathe tool to the provided operation. The lathe tool to be assigned. The operation to have tool information assigned to it. Flag specifying how to initialize the operation tool offsets. 0 - from the tool, 1 - from the configuration. true to initialize the operation tool station. true to set the step/peck/coolant values from the tool. Flag specifying how to recalculate the feeds/speeds. 0 - From the workpiece material, 1 - From the tool, 2 - From defaults. true if it succeeds, false if it fails. Assigns the specified holder to the provided operation. The tool holder to be assigned. The operation to have tool holder information assigned to it. true if assembly slot changed. true if it succeeds, false if it fails. Warning on modfiy tool used in multi thread ops. (Optional) The parent. Warning on duplicate mill tool numbers. The tool number. The slot. true to check mill. The group idn. Warning on duplicate mill tool numbers. The tool number. The slot. The group idn. Prompts the user to select a tool assembly from the tools in the tool library referenced by the provided machine definition. Output parameter that will be filled in with the selected result. If non-null, the machine containing the library to select a tool from. (Optional) If non-null, the parent. True if a tool assembly was selected. False otherwise. Prompts the user to select a tool assembly from the tools in the current Mastercam part file. Output parameter that will be filled in with the selected result. If non-null, the machine to select a tool from. (Optional) If non-null, the parent. True if a tool assembly was selected. False otherwise. Launches the holder designer to allow users to edit the given holder assembly. The result of the holder designer, if successful, will be placed in the input parameter "holderAssemblyToEdit". The holder assembly to edit. (Optional) If non-null, the parent. true if it succeeds, false if it fails. Launches the holder designer panel to allow users to create a new holder assembly. The function passed in should handle a completed 3D tool and do with it whatever the client prefers. This workflow supports OK/New from the holder designer, so a series of holder assemblies can be created without exiting the holder designer. The commit function to use when if/when the user selects OK/New in the holder designer. (Optional) If non-null, the parent. Launches the holder designer panel to allow users to create a new holder assembly. The result of the holder designer, if successful, will be placed in the input parameter "spResult". The result. (Optional) If non-null, the parent. true if it succeeds, false if it fails. Launches the insert designer to allow users to edit the given insert. The result of the insert designer, if successful, will be placed in the input parameter "insertToEdit". The insert to edit. (Optional) If non-null, the parent. true if it succeeds, false if it fails. Launches the insert designer panel to allow users to create a new insert. The function passed in should handle a completed insert and do with it whatever the client prefers. This workflow supports OK/New from the insert designer, so a series of inserts can be created without exiting the insert designer. The commit function to use when if/when the user selects OK/New in the insert designer. (Optional) If non-null, the parent. Launches the insert designer panel to allow users to create a new insert. The result of the insert designer, if successful, will be placed in the input parameter "spResult". The result. (Optional) If non-null, the parent. true if it succeeds, false if it fails. Launches the mill tool assembly designer to allow users to edit the given assembly. The result of the mill tool assembly designer, if successful, will be placed in the input parameter "spAssemblyToEdit". [in,out] The assembly to edit. (Optional) True if read only. [in,out] (Optional) If non-null, the parent. (Optional) From library. true if it succeeds, false if it fails. Launches the mill tool assembly designer panel to allow users to create a new mill assembly. The function passed in should handle a completed assembly and do with it whatever the client prefers. This workflow supports OK/New from the mill tool assembly designer, so a series of assemblies can be created without exiting the mill tool assembly designer. The commit function to use when if/when the user selects OK/New in the mill tool assembly designer. (Optional) If non-null, the parent. Creates a new mill assembly. The result. (Optional) If non-null, (Optional) the parent. true if it succeeds, false if it fails. Retrieves the next available tool number among all used tools within the specified machine group. I/O: The tool number. Identifier for the machine group. Identifier for the operation exclude. (Optional) the active turret. Retrieves the next available tool number among all tools within the specified machine group. I/O: The tool number. (Optional) identifier for the machine group. (Optional) identifier for the operation exclude. Retrieves the next available tool slot number among all tools within the current Mastercam part tool list. The slot. (Optional) true to in mill. (Optional) Additional used slots to consider. Deletes all tools that exist within the specified machine group number. The machine group number. Replaces the contents of "destination" with all tool data from the current Mastercam part tool list. Destination for the tool data from the current Mastercam part tool list. true if it succeeds, false if it fails. Replaces the tool data in the current Mastercam part tool list with all tool data existing within the input parameter "source". Tool data to be used to replace the data within the current Mastercam part tool list. true if it succeeds, false if it fails. Creates a copy of the lathe tool at the specified slot number and puts it into the specified machine group. If "checkForExisting" is passed a value of "true", the user will be prompted to decide on whether to add the tool anyways if a similar tool assembly has been located. Source slot. true to check for existing. Identifier for the new machine group. The use existing. The new copy. Creates a copy of the tool assembly at the specified slot number. If "checkForExisting" is passed a value of "true", the user will be prompted to decide on whether to add the tool anyways if a similar tool assembly has been located. Source slot. true to check for existing. The use existing. The new copy. Creates a copy of the mill tool at the specified slot number and puts it into the specified machine group. If "checkForExisting" is passed a value of "true", the user will be prompted to decide on whether to add the tool anyways if a similar tool assembly has been located. Source slot. true to check for existing. Identifier for the new machine group. The use existing. The new copy. Creates a copy of the tool assembly at the specified slot number. If "checkForExisting" is passed a value of "true", the user will be prompted to decide on whether to add the tool anyways if a similar tool assembly has been located. Source slot. true to check for existing. The use existing. The new copy. Creates a copy of the tool assembly at the specified slot number and puts it into the specified machine group. If "checkForExisting" is passed a value of "true", the user will be prompted to decide on whether to add the tool anyways if a similar tool assembly has been located. Source slot. true to check for existing. Identifier for the new machine group. The use existing. The new copy. Creates a copy of the tool assembly at the specified slot number. If "checkForExisting" is passed a value of "true", the user will be prompted to decide on whether to add the tool anyways if a similar tool assembly has been located. Source slot. true to check for existing. The use existing. The new copy. Deletes all lathe tools and mill assemblies from the main part tool list. Input parameter allows control over whether or not to delete entities from Mastercam database as well as Part tool list. Doing so will put the two lists out of sync and should only be attempted if that action is intended. If not, call the parameterless version. true to delete from the Mastercam database too. true if it succeeds, false if it fails. Updates the tool assembly referenced by the slot information stored within the input entity. The input. (Optional) Assembly Changed Processor automation options, nullptr indicates no Assembly Changed Processing. true if it succeeds, false if it fails. Updates the tool assembly referenced by the slot information stored within the input LATHETOOL. The input. (Optional) Assembly Changed Processor automation options, nullptr indicates no Assembly Changed Processing. true if it succeeds, false if it fails. Updates the tool assembly referenced by the slot information stored wtihin the input tp_tool. The input. (Optional) Assembly Changed Processor automation options, nullptr indicates no Assembly Changed Processing. true if it succeeds, false if it fails. Updates the tool assembly referenced by the slot information stored within the input tool. The sp input. (Optional) Assembly Changed Processor automation options, nullptr indicates no Assembly Changed Processing. true if it succeeds, false if it fails. Retrieves a set of all lathe tool assembly IDs from the current Mastercam part list. The assembly IDs. Retrieves a set of all mill tool assembly IDs from the current Mastercam part list. The assembly IDs. Searches for the Tool ID corresponding to the slot specified by the input parameter "slot". The slot. (Optional) true if slot is mill. The found identifier from slot. Queries if an item exists within the Mastercam part tool list matching the provided set of search parameters. The search tool. true to issue a warning to the user if an item is found. true to ignore tool numbers when searching. Identifier for the machine group. true if it succeeds, false if it fails. Queries if an item exists within the Mastercam part tool list matching the provided set of search parameters. The search tool. true to issue a warning to the user if an item is found. true to ignore tool numbers when searching. Identifier for the machine group. true if it succeeds, false if it fails. Queries if an item exists within the Mastercam part tool list matching the provided set of search parameters. The search settings. Options for controlling the search. true if it succeeds, false if it fails. Queries if an item exists within the Mastercam part tool list matching the provided set of search parameters. Options for controlling the search. Identifier for the machine group. true if it succeeds, false if it fails. Queries if an item exists within the Mastercam part tool list matching the provided set of search parameters. Options for controlling the search. true if it succeeds, false if it fails. Queries if an item exists within the Mastercam part tool list at the specified slot number. The slot. true if slot is mill. (Optional) True to check the database in addition to checking the tool list. true if an item exists, false if not. Queries if an item exists within the Mastercam part tool list at the specified ID. The identifier. true if an item exists, false if not. Attempts to locate the tool that pairs with the database entity associated to the given ent IDN. If an item is found, the input parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in storage. The entity IDN to search for. The result. true if it succeeds, false if it fails. Attempts to locate a tool assembly matching the provided set of search parameters. This version of 'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in storage. The search settings. Options for controlling the search. The result. true if it succeeds, false if it fails. Attempts to locate a tool assembly matching the provided set of search parameters. This version of 'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in storage. Options for controlling the search. Identifier for the machine group. The result. true if it succeeds, false if it fails. Attempts to locate a tool assembly matching the provided set of search parameters. This version of 'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in storage. Options for controlling the search. The result. true if it succeeds, false if it fails. Attempts to locate a lathe tool assembly in the part tool list matching the the given lathe tool. The tool to search for. true to display a duplicate tool warning message. true to ignore tool number when checking to see if the tool exists. Identifier for the machine group. The result tool. true if it succeeds, false if it fails. Attempts to locate a lathe tool assembly in the part tool list matching the the given lathe tool. The tool to search for. true to display a duplicate tool warning message. true to ignore tool number when checking to see if the tool exists. Identifier for the machine group. The result tool. true if it succeeds, false if it fails. Attempts to locate a legacy lathe tool corresponding to the slot number specified at input parameter "slot". The slot. The result. true if it succeeds, false if it fails. Attempts to locate the Mastercam database entity corresponding to the slot number specified at input parameter "slot". Depending on the parameter "slotIsMill", only mill or lathe entities will be considered. The slot. true if slot is mill. The result. true if it succeeds, false if it fails. Attempts to locate a similar assembly to the input parameter "similarAssembly". This version of 'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in storage. The similar assembly. Identifier for the machine group. The result. true if it succeeds, false if it fails. Adds the given tool to the machine group at the given ID. The tool to add. The machine group idn used to search for duplicates or NULL_ID to ignore groups. (Optional) true to suppress tool number warning. true if it succeeds, false if it fails. Adds the given tool to the specified machine group. The tool to add. The machine group idn used to search for duplicates or NULL_ID to ignore groups. True to suppress tool number warning. true if it succeeds, false if it fails. Creates a 'dummy' tool based on parameters contained within the provided operation structure. The input to add. true if it succeeds, false if it fails. Adds the provided item to the current part's main tool list. An open slot number will be determined and assigned to the item as it is added to the part tool list. If the add is successful, the input parameter's slot number will be updated to reflect how it was stored. This slot number can be used to access and/or update the item from the main tool list. The item to add to the current part's main tool list. The entity should be defined with the assoc_id indicating whether the tool is mill, lathe, or 3D. true if it succeeds, false if it fails. Adds the provided item to the current part's main tool list. An open slot number will be determined and assigned to the item as it is added to the part tool list. If the add is successful, the input parameter's slot number will be updated to reflect how it was stored. This slot number can be used to access and/or update the item from the main tool list. The item to add to the current part's main tool list. true if it succeeds, false if it fails. Adds the provided item to the current part's main tool list. An open slot number will be determined and assigned to the item as it is added to the part tool list. If the add is successful, the input parameter's slot number will be updated to reflect how it was stored. This slot number can be used to access and/or update the item from the main tool list. The item to add to the current part's main tool list. true if it succeeds, false if it fails. Adds the provided item to the current part's main tool list. An open slot number will be determined and assigned to the item as it is added to the part tool list. If the add is successful, the input parameter's slot number will be updated to reflect how it was stored. This slot number can be used to access and/or update the item from the main tool list. The item to add to the current part's main tool list. true if it succeeds, false if it fails. Initializes the Mastercam part tool manager's tool container. This function is only called during Mastercam database initialization and should not be called otherwise. This only initializes the TlMgr container and will potentially corrupt the tool system if called otherwise. Retrieves a const instance of the part tool manager's TlMgr container. The const TlMgr to be used for direct queries. Loads the part tool manager data from the Mastercam database entity specified. This function is called when the Mastercam database is spun up with an existing file. Do not call this unless you know what you are doing. The Mastercam database entity pointer. Internal Interface for managing the tools stored within the current part. Functions defined in this interface perform all necessary operations to maintain the set of tools contained within the internal TlMgr as well as the set of tools contained within the Mastercam database. Declares the TlCompConfigurationStationary type and its shared_ptr/unique_ptr aliases. Declares the TlCompConfiguration type and its shared_ptr/unique_ptr aliases. Declares the TlSetupConfiguration type and its shared_ptr/unique_ptr aliases. Declares the TlConfiguredToolAssembly type and its shared_ptr/unique_ptr aliases. Gets tl manager. The tl manager. Gets the single instance of the IToolDataImporterManager interface. The IToolDataImporterManager single instance. Import the contents from the specified file into the specified context. Full pathname of the file to import. The context to import data through. True if it succeeds, false if it fails. Launches the user interface operation for this importer. The context from which it has been launched. Handle of the parent. True if it succeeds, false if it fails. Queries the importer on whether or not it will provide a interface for the user. If an interface is not provided, and an interface is desired, a value of 'false' should be returned. Mastercam will supply an interface in this case when one is supported. True to put the responsibility for any user interaction within this importer. False to let Mastercam handle the user interface responsibility. Retrieves a set of possible file types that can be imported by this importer. The import file types. The IToolDataImporter interface. Adds a series of imported items to the specified library. Only tool libraries are supported at this time. Full pathname of the library file. The imported items. True if it succeeds, false if it fails. Adds a series of imported items to the part list in the machine group determined by the context from which the importer was launched from. Only mill tools and mill tool assemblies are supported at this time. The imported items. True if it succeeds, false if it fails. Adds a series of imported items to the context from which the importer was launched from. The imported items. True if it succeeds, false if it fails. Gets the source operation identifier if importing into a toolpath operation. The identifier of the source toolpath operation if importing into a toolpath operation context, or nullopt if not in the context of a toolpath. Gets the logger. A reference to an IToolDataImportLogger. A tool data import context. Retrieves the localized name of this data importer. The name. A data importer. Creates a new new instance of the ITlAssemblyItemFactory interface. The new ITlAssemblyItemFactory instance. Creates a lathe center. True to create the item in metric units. The new lathe center. Creates an adaptive item. True if metric. The new adaptive item. Creates a turn holder. True if metric. The new turn holder. Creates threading insert. The insert style. Type of the thread. True for the created insert to have metric values. The new threading insert. Creates a grooving insert using the passed in style and metric flag. The style. True for the created insert to have metric values. The new grooving insert. Creates a turning boring insert using the passed in shape code and metric flag. The shape code. True for the created insert to have metric values. The new turn insert. Creates a lathe tool using the values from the legacy tool. The old tool. The new lathe tool. Creates a mill holder based on the input metric flag. True for the created holder to have metric values. The new mill holder. Creates a mill tool using the values from the legacy tool. The old tool. The new mill tool. Creates a mill tool using the passed in type and metric flag. The type. true for the created mill tool to have metric values. The new mill tool. Factory service class providing functionality for creating instances of the classes TlToolMill, TlHolder, and TlToolLathe. Creates a new new instance of the ITlAssemblyFactory interface. The new ITlAssemblyFactory instance. Creates a new TlAssemblyPtr from the parameters in the specified operation. The operation. A TlAssemblyPtr. Creates a new TlAssemblyPtr from the old tool. The old tool. A TlAssemblyPtr. Creates a new TlAssemblyPtr from the given tool. The tool. A TlAssemblyPtr. Creates a new TlAssemblyPtr based on the tool type and metric flag. Type of the tool. true if this object is metric. A TlAssemblyPtr. Factory service class providing functionality for creating instances of class TlAssembly. Gets a pointer to the global tool system. The tool system. Defines an alias representing zero-based index of the tool system. Query if the main part tool list is empty. true if empty, false if not. Assigns the specified lathe tool to the provided operation. The lathe tool to be assigned. The operation to have tool information assigned to it. Flag specifying how to initialize the operation tool offsets. 0 - from the tool, 1 - from the configuration. true to initialize the operation tool station. true to set the step/peck/coolant values from the tool. Flag specifying how to recalculate the feeds/speeds. 0 - From the workpiece material, 1 - From the tool, 2 - From defaults. true if it succeeds, false if it fails. Assigns the specified tool holder to the provided operation. The tool holder to be assigned. The operation to have tool holder information assigned to it. true if it succeeds, false if it fails. Assigns the specified tool to the provided operation. The tool to be assigned. The operation to have tool assembly information assigned to it. Flag specifying how to initialize the operation tool offsets. 0 - from the tool, 1 - from the configuration. true to initialize the operation tool station. true to set the step/peck/coolant values from the tool. Flag specifying how to recalculate the feeds/speeds. 0 - From the workpiece material, 1 - From the tool, 2 - From defaults. true to always lock feedrates. true if it succeeds, false if it fails. Assigns the specified tool assembly to the provided operation. The tool assembly to be assigned. The operation to have tool assembly information assigned to it. Flag specifying how to initialize the operation tool offsets. 0 - from the tool, 1 - from the configuration. true to initialize the operation tool station. true to set the step/peck/coolant values from the tool. Flag specifying how to recalculate the feeds/speeds. 0 - From the workpiece material, 1 - From the tool, 2 - From defaults. true to always lock feedrates. true if it succeeds, false if it fails. Launches the Classic Tool Manager Dialog. True to launch the lathe tool manager. False to launch the mill tool manager. (Optional) If non-null, the parent. true if it succeeds, false if it fails. Prompts the user to select a cutting parameter from the current tool component library. The current tool library is the library set within the active machine definition. IsoGroup and ToolDiameter parameters exist to provide initial filtering functionality. Output parameter that will be filled in with the selected result. ISO group that the current workpiece material belongs to. The diameter of the current tool being used. (Optional) If non-null, the parent. True if a cutting parameter was selected. False otherwise. Prompts the user to select a lathe tool assembly from the current tool component library. The current tool library is the library set within the active machine definition. Output parameter that will be filled in with the selected result. (Optional) If non-null, the parent. True if a lathe tool assembly was selected. False otherwise. Prompts the user to select a tool assembly from the current tool component library. The current tool library is the library set within the active machine definition. Output parameter that will be filled in with the selected result. (Optional) If non-null, the parent. True if a tool assembly was selected. False otherwise. Prompts the user to select a lathe tool assembly from the tools in the current Mastercam part file. Output parameter that will be filled in with the selected result. (Optional) If non-null, the parent. True if a lathe tool assembly was selected. False otherwise. Prompts the user to select a tool assembly from the tools in the current Mastercam part file. Output parameter that will be filled in with the selected result. (Optional) If non-null, the parent. True if a tool assembly was selected. False otherwise. Launches the Save to Level panel to save the mill geometry to levels. The selected objects. (Optional) If non-null, (Optional) the parent. True if it succeeds, false if it fails. Saves a geometry to level. The selected objects. (Optional) If non-null, (Optional) the parent. True if it succeeds, false if it fails. Saves a geometry to level. The selected tools. (Optional) If non-null, (Optional) the parent. True if it succeeds, false if it fails. Saves the tools to library. The items to save. Options for controlling the operation. (Optional) If non-null, (Optional) the parent. A SaveToLibResult. Values that represent library tabs. A save to library parameters. Encapsulates the result of a save to library. Launches the select insert definition panel to allow users to choose the active definition for their tool. The multi-definition tool. The result slot. (Optional) If non-null, (Optional) the parent. (Optional) The initially selected slot. True if it succeeds, false if it fails. Launches the select insert definition panel to allow users to choose the active definition for their tool. The multi-definition tool. The result slot. (Optional) If non-null, (Optional) the parent. (Optional) The initially selected slot. True if it succeeds, false if it fails. Launches the tool designer to allow users to edit the given 3D tool. The result of the tool designer, if successful, will be placed in the input parameter "toolToEdit". The 3D tool assembly to edit. True to hide the parent window before launching the tool designer. (Optional) If non-null, the parent. (Optional) The initially selected slot. true if it succeeds, false if it fails. Launches the GAF Projection editing feature to edit the projections of the assembly provided at the input parameter "spResult". If the assembly is successfully edited, and the input parameter "updatePart" is set to true, the assembly will be updated in the Mastercam part tool list. If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly has changed" dialog will be presented to the user. In the event that the user selects "create new assembly" at that dialog, the newly created assembly will be in parameter "spResult". The result. true to update part. (Optional) If non-null, the parent dialog to suspend. true if the assembly has changed, false otherwise. Launches the holder wizard to edit the holder of the assembly provided at the input parameter "spResult". If the holder is successfully edited, and the input parameter "updatePart" is set to true, the holder will be updated in the Mastercam part tool list. If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly has changed" dialog will be presented to the user. In the event that the user selects "create new assembly" at that dialog, the newly created assembly will be in parameter "spResult". The result. true to update part. (Optional) If the holder is a composite holder, the index of the holder to edit. (Optional) If non-null, the parent. true if it succeeds, false if it fails. Launches the tool wizard to edit the tool of the assembly provided at the input parameter "spResult". If the tool is successfully edited, and the input parameter "updatePart" is set to true, the tool will be updated in the Mastercam part tool list. If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly has changed" dialog will be presented to the user. In the event that the user selects "create new assembly" from that dialog, the newly created assembly will be in parameter "spResult". [in,out] The result. true to update part. (Optional) true to start on the last page (properties page) of the wizard. (Optional) true to present the editor in read-only mode. [in,out] (Optional) If non-null, the parent. (Optional) From library. true if it succeeds, false if it fails. Launches the mill assembly panel to edit the assembly provided at the input parameter "spAssembly". If the assembly is successfully edited, and the input parameter "updatePart" is set to true, the assembly will be updated in the Mastercam part tool list. If the part list is updated after an edit, and the relevant assembly is used in operations, the "assembly has changed" dialog will be presented to the user. In the event that the user selects "create new assembly" from that dialog, the newly created assembly will be in parameter "spAssembly". [in,out] The assembly. True to update part. (Optional) True if read only. [in,out] (Optional) If non-null, the parent. (Optional) From library. true if it succeeds, false if it fails. Launches the edit holder wizard to allow users to modify existing holders. The result of the edit holder wizard, if successful, will be placed in the input parameter "spResult". The result. (Optional) true to present the editor in read-only mode. (Optional) If non-null, the parent. true if it succeeds, false if it fails. Launches the edit tool wizard to allow users to modify existing tools. The result of the edit tool wizard, if successful, will be placed in the input parameter "spResult". [in,out] The result. (Optional) true to start on the last page (properites page) of the wizard. (Optional) true to present the editor in read-only mode. [in,out] (Optional) If non-null, the parent. (Optional) From library. true if it succeeds, false if it fails. Launches the appropriate editor for the given lathe tool. The result of the tool editor, if successful, will be placed in the input parameter 'spToolToEdit'. The tool to edit. The parameters for controlling the operation. True if it succeeds, false if it fails. Parameters for controlling behavior when editing a lathe tool. Launches the tool designer panel to allow users to create a new 3D tool assembly. The function passed in should handle a completed 3D tool and do with it whatever the client prefers. This workflow supports OK/New from the tool designer, so a series of 3D tools can be created without exiting the tool designer. The commit function to use when if/when the user selects OK/New in the tool designer. True to hide the parent window before launching the tool designer. If non-null, the parent. Launches the tool designer panel to allow users to create a new 3D tool assembly. The result of the tool designer, if successful, will be placed in the input parameter "spResult". The result. True to hide the parent window before launching the tool designer. If non-null, the parent. true if it succeeds, false if it fails. Launches the create new lathe center wizard to allow users to create their desired lathe centers. The result of the create new lathe center wizard, if successful, will be placed in the input parameter "spResult". The result. Identifier for the machine group. If non-null, the parent window to minimize. true if it succeeds, false if it fails. Launches the create lathe tool dialog to allow users to create their desired tools. The result of the create lathe tool dialog, if successful, will be placed in the input parameter "spResult". The result. Identifier for the machine group, send in NULL_ID for a library tool. (Optional) If non-null, the parent. true if it succeeds, false if it fails. Launches the legacy create lathe tool dialog to allow users to create their desired tools. The result of the create lathe tool dialog, if successful, will be placed in the input parameter 'spResult'. The result. Identifier for the machine group, send in NULL_ID for a library tool. If non-null, the parent. True if it succeeds, false if it fails. Launches the create new holder wizard to allow users to create their desired holders. The result of the create new holder wizard, if successful, will be placed in the input parameter "spResult". The result. (Optional) If non-null, the parent. true if it succeeds, false if it fails. Launches the create new tool wizard to allow users to create their desired tools. The result of the create new tool wizard, if successful, will be placed in the input parameter "spResult". The result. (Optional) The initial tool type. (Optional) If non-null, the parent. true if it succeeds, false if it fails. Launches the create new mill assembly panel. The result of the create new mill assembly panel, if successful, will be placed in the input parameter "spAssembly". The assembly. (Optional) If non-null, the parent. True if it succeeds, false if it fails. Deletes all lathe tools and mill assemblies from the main part tool list. true if it succeeds, false if it fails. Deletes a lathe tool from the main part tool list with slot identification information matching the input parameter "slot". The slot number of the tool to delete. true if it succeeds, false if it fails. Deletes a mill tool from the main part tool list with slot identification information matching the input parameter "slot". The slot number of the tool to delete. (Optional) True if the user should be warned before deleting a tool used by operations. (Optional) True to delete the tool if the warning is suppressed and it is a used tool. (Optional) The parent window pointer to be given to the warning dialog (should it be launched). This parameter should only be used if "true" was passed into the parameter "warnIfUsed". true if it succeeds, false if it fails. Deletes an item from the main part tool list with identification information matching the input parameter "id". The identification number of the tool to delete. (Optional) True if the user should be warned before deleting a tool used by operations. (Optional) True to delete the tool if the warning is suppressed and it is a used tool. (Optional) The parent window pointer to be given to the warning dialog (should it be launched). This parameter should only be used if "true" was passed into the parameter "warnIfUsed". true if it succeeds, false if it fails. Updates the lathe tool in the internal tool list that corresponds to the given lathe tool interface instance. The lathe tool. (Optional) Assembly Changed Processor automation options, nullptr indicates no Assembly Changed Processing. True if it succeeds, false if it fails. Updates the tool assembly referenced by the slot information stored within the input tool. The input tool. (Optional) Assembly Changed Processor automation options, nullptr indicates no Assembly Changed Processing. true if it succeeds, false if it fails. Updates an item in the main part tool list with the input parameter data. The input parameter's identification information must match an existing item in the main part tool list. The input. (Optional) Assembly Changed Processor automation options, nullptr indicates no Assembly Changed Processing. true if it succeeds, false if it fails. Updates an item in the main part tool list with the input parameter data. The input parameter's identification information must match an existing item in the main part tool list. If the assembly is successfully updated, and the input parameter "pAutomationParams" is specified, the Assembly Changed Processor will be invoked to update all toolpath operations using the tool that is updated, in accordance with the options specified in "pAutomationParams". The tool assembly to update. (Optional) Assembly Changed Processor automation options, nullptr indicates no Assembly Changed Processing. true if tool updated, false if failure. Indicates an offset warning has occurred. The created assembly (only populated if the user selected CreateNewAssembly via UI or AutomationMode = AssemblyChangedResult::CreateNewAssembly). Cancel Changes. Create a new assembly. Update all assemblies. Automation Mode to use, if Automate = true. Automate Assembly/Tool Changed Processor UI prompts. Note: The automation parameters include this automation flag so that the caller may capture a reference to a created assembly or if an offset warning has occurred, even when automation is off and the user is prompted via the UI for how to handle AssemblyChanged decisions. IToolSystem::Update(...) automation parameters. Queries if any lathe tools in the tool system satisfy the given predicate. The predicate to evaluate against. True if any lathe tools satisfy the given predicate. Queries if any mill tool assemblies in the tool system satisfy the given predicate. The predicate to evaluate against. True if any mill tool assemblies satisfy the given predicate. Searches for matching lathe tools in the tool manager. The predicate parameter will be executed on all 3d tools and legacy lathe tools. Items that result in a value of 'true' when passed into the predicate will be added to the result set. A function predicate used to select all matching lathe tools from the Mastercam part tool list. The result set. Searches for matching mill tools in the tool manager. The predicate parameter will be executed on all mill tools. Items that result in a value of 'true' when passed into the predicate will be added to the result set. A function predicate used to select all matching mill tools from the Mastercam part tool list. The result set. Searches for the first item for which predicate 'pred' returns true. A function predicate used to select the appropriate tool from the Mastercam part tool list. This function parameter will be executed on each tool in the list until a value of "true" is returned. true if it succeeds, false if it fails. Searches for the first item for which predicate 'pred' returns true. A function predicate used to select the appropriate tool from the Mastercam part tool list. This function parameter will be executed on each tool in the list until a value of "true" is returned. The result or nullptr if not found. Constructs a list of all lathe tools from the main part tool list. The result list is composed of smart pointers to interfaces that wrap the items from the internal tool list. A set of all lathe tools in the main part tool list. Constructs a list of all items of type TlToolAssembly from the main part tool list. The result list is composed of non-modifiable smart pointers that directly point to the items from the internal tool list. If changes are desired to any individual item in the result set, the "Clone" method should be called on the item to create a deep copy to work with. A set of all items in the main part tool list of type TlToolAssembly. Constructs a list of all items of type TlToolLathe from the main part tool list. The result list is composed of non-modifiable smart pointers that directly point to the items from the internal tool list. If changes are desired to any individual item in the result set, the "Clone" method should be called on the item to create a deep copy to work with. A set of all items in the main part tool list of type TlToolLathe. Constructs a list of all items of type TlAssembly from the main part tool list. The result list is composed of non-modifiable smart pointers that directly point to the items from the internal tool list. If changes are desired to any individual item in the result set, the "Clone" method should be called on the item to create a deep copy to work with. A set of all items in the main part tool list of type TlAssembly. Attempts to locate the lathe tool with a slot number matching the input parameter "slot". If an item is found, the input parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in storage. The slot. The result. true if it succeeds, false if it fails. Attempts to locate the item with an ID matching the passed in identifier. If an item is found, the input parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in storage. The identifier. The result. true if it succeeds, false if it fails. Attempts to locate a 3D tool corresponding to the slot number specified at input parameter "slot". Because 3D tools live in both the mill and lathe tool lists, input parameter "slotIsMill" is used to determine whether to look for the tool from the lathe slot list or the mill slot list. The slot. The result. true if it succeeds, false if it fails. Attempts to locate the item with an ID matching the passed in indentifier. If an item is found, the input parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in storage. The identifier. The result. true if it succeeds, false if it fails. Attempts to locate the item with a slot number matching the input parameter "slot". If an item is found, the input parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in storage. The slot. The result. true if it succeeds, false if it fails. Attempts to locate the item with an ID matching the passed in indentifier. If an item is found, the input parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in storage. The identifier. The result. true if it succeeds, false if it fails. Attempts to locate the item with a slot number matching the input parameter "slot". If an item is found, the input parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in storage. The slot. The result. true if it succeeds, false if it fails. Attempts to locate the item with an ID matching the passed in indentifier. If an item is found, the input parameter "spResult" will be updated with a deep copy of the located item. This version of 'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in storage. The identifier. The result. true if it succeeds, false if it fails. Prepares the provided item using the settings in the specified machine group, and then adds the item to the specified machine group. If not suppressed, this function will warn the user of any similar items that already exist within the specified machine group. If the add is successful, the input parameter will updated to reflect adjusted slot number, tool number, tool offsets, and potentially station number. The sp input. Identifier for the machine group. A value of 'NULL_ID' will add the tool to the active machine group. (Out) True if the user cancelled the operation. (Optional) true to warning on similar tools. (Optional) true to add if similar exists. (Optional) true to initialize offsets. (Optional) true to suppress tool number warning. (Optional) true to add copy to name if similar tool. true if it succeeds, false if it fails. Prepares the provided item using the settings in the specified machine group, and then adds the item to the specified machine group. If not suppressed, this function will warn the user of any similar items that already exist within the specified machine group. If the add is successful, the input parameter will updated to reflect adjusted slot number, tool number, tool offsets, and potentially station number. The sp input. Identifier for the machine group. A value of 'NULL_ID' will add the tool to the active machine group. (Out) True if the user cancelled the operation. (Optional) true to warning on similar tools. (Optional) true to add if similar exists. (Optional) true to initialize offsets. (Optional) true to suppress tool number warning. (Optional) true to add copy to name if similar tool. true if it succeeds, false if it fails. Adds the provided item to the current part's main tool list. An open slot number will be determined and assigned to the item as it is added to the part tool list. If the add is successful, the input parameter's slot number will be updated to reflect how it was stored. This slot number can be used to access and/or update the item from the main tool list. The item to add to the current part's main tool list. true if it succeeds, false if it fails. Adds the provided item to the current part's main tool list. All definitions defined for the given 3D tool assembly will have a unique slot number assigned to them prior to adding to the tool list. The item to add to the current part's main tool list. True if it succeeds, false if it fails. Adds the provided item to the current part's main tool list. An open slot number will be determined and assigned to the item as it is added to the part tool list. If the add is successful, the input parameter's slot number will be updated to reflect how it was stored. This slot number can be used to access and/or update the item from the main tool list. The item to add to the current part's main tool list. true if it succeeds, false if it fails. Adds the provided item to the current part's main tool list. An open slot number will be determined and assigned to the item as it is added to the part tool list. If the add is successful, the input parameter's slot number will be updated to reflect how it was stored. This slot number can be used to access and/or update the item from the main tool list. The item to add to the current part's main tool list. true if it succeeds, false if it fails. Interface into the main Mastercam tool system. A base tooling interface for the implicit standardization of special member functions. Protected constructor to avoid deleting the implicit constructor in derived types, virtual destructor to be implicitly carried forth by derived types, and deleted copy and move constructor or assignment operators to prevent unintentional object slicing. Allows external areas of the application to quickly and easily get a pointer to the current viewsheet tab control. A pointer to the viewsheet tab control. Update the view using a viewsheet ID. Given a viewsheet's unique ID, finds its entry in the viewsheet map, and update the view with the appropriate settings. The zero-based unique ID of the viewsheet data to update. (Optional) True to force view update. Re-arrange group members to match their tab order. The group identifier. Add the given sheet to a group, or remove it from a group, as appropriate. Zero-based index of the tab. Ungroup the selected viewsheets. If the given tab is a group member, ungroup it. The zero-based index of the tab to ungroup. True if the given tab was ungrouped, otherwise false. Expand/Collapse the group for the given tab (if it's a group tab). The zero-based index of the tab to act on. True if the given tab index is a group tab, otherwise false. True if the given tab index is the active group, otherwise false. Set or clear a tab group indicator. Zero-based index of the tab. Save the index of the most recent active tab. Zero-based index of the tab. Saves a current viewsheet values. The viewsheet data to save. (Optional) true if check for changed, false does not flag a database change. Remove viewsheet information for the given ID from the map. The viewsheet identifier. True if the map entry was removed, false if it didn't exist. Remove a viewsheet member from a group. The viewsheet identifier. The group identifier. True if this viewsheet is being deleted, false if it's simply being ungrouped. True if the viewsheet was removed, false if the group is bad or the viewsheet is not a member. Make a workspace key for viewsheets. (Optional) true to use 'CNC Software', false for 'CNC SOFTWARE' (default = true). The name of the workspace key. Add all selected viewsheets to a viewsheet group. (Optional) The group ID to add the members to. If zero, a new group and a new tab will be created (default = 0). Given a viewsheet, get its viewsheet type (single, group, member, etc.). Pointer to a specific viewsheet tab. The viewsheet type (single, group, or member). Given a tab index, get the viewsheet type (single, group, or member) for that index. Zero-based index of the viewsheet's tab. The viewsheet type (single, group, or member). Gets a set of all currently used viewsheet names, visible or not. Set of all currently used viewsheet names. Gets a set of all viewsheet names that are in collapsed groups (not currently visible). Set of all viewsheet names in collapsed groups. Given a viewsheet ID, return the tab index of that viewsheet. The viewsheet identifier. The sheet tab index if the tab exists, or -1 if not. Get the most recent active tab's index. The old tab index. Gets number of viewsheets. The number viewsheets. Get a new, unique viewsheet identifier. The new viewsheet identifier. Add viewsheet tabs for members of the given group. The group identifier. Verify the list of Levels match. The first level list. The second level list. true if it succeeds, false if it fails. Delete the viewsheet tab for the given viewsheet ID. The viewsheet identifier. (Optional) True if deleting a temporary sheet (default = false). (Optional) If true, allow even the last viewsheet to be deleted (default = false). True if the specified sheet was deleted, otherwise false. Create a viewsheet name. The viewsheet type. Base name to start with (can be empty). True to force a unique name. The created name. Create a viewsheet name. (Optional) The viewsheet type (default = single). (Optional) Base name to start with. (Optional) True to force a unique name. The created name. Copies a single or member viewsheet (but not a group) using the given name. The identifier of the viewsheet to copy (NOT the tab index). (Optional) A name to assign to the copy. If null, a version of the original viewsheet name will be used (default = null). (Optional) The tab index for this viewsheet's tab. If less than 0, the copy will be placed right after the original (default = -1). (Optional) If this is a group member, The group identifier (default = 0). The viewsheet ID for the newly created viewsheet, or 0 if creation fails. Create copies of the selected viewsheets. Remove the viewsheet tabs belonging to the given group. The group identifier. Add a viewsheet tab to the tab control. The viewsheet identifier. The viewsheet type (group, single, or member). The viewsheet name. The index of the tab to insert after. True if is this tab has a bookmark, otherwise false. (Optional) True to make this the active tab (default = true). (Optional) True to skip saving settings for the active tab. This should be set to true when reading a part file (default = false). Add a viewsheet to the information map. The viewsheet identifier. The viewsheet type (group, single, or member). The viewsheet name. (Optional) If this is a group member, identifier for the parent (default = 0). (Optional) True if this is a merged viewsheet (default = false). Add a viewsheet to a viewsheet group. The viewsheet identifier. The identifier for the parent. True if the member is added, false if the group doesn't exist. Values that represent different viewsheet icons. Button up message handler for the right-mouse button. Right mouse button click flags. The screen coordinates of where the mouse click took place. Button down message handler for the right-mouse button. Right mouse button click flags. The screen coordinates of where the original mouse click took place. Pre-translate messages before they are processed by the main message loop. If non-null, the message to process. True if it succeeds, false if it fails. Executes the rename tab action. Zero-based index of the tab to rename. The new name. true if it succeeds, false if it fails. Button up message handler for the left-mouse button. Left mouse button click flags. The screen coordinates of where the original mouse click took place. Button down message handler for the left-mouse button. Left mouse button click flags. The screen coordinates of where the original mouse click took place. This double-click message handler for the left-mouse button is used to to restore a bookmark. Left mouse button click flags. The screen coordinates of where the original mouse click took place. This is an overridden virtual method that we use to do our viewsheet tab control initialization stuff in. The input structure containing all of the class creation info. Message handler used to enable or disable some options on the right-mouse menu depending on which items in the control were clicked on and whether or not those viewsheets have bookmark data associated with them yet. Pointer to the control that's displaying the context menu (in this case, this tab control). The screen coordinates of where the right click menu will be originating from (and where the right-click took place). Message handler used to hook our right-mouse menu options. We catch each of the commands that can be sent out of that menu and run the appropriate member function as a result. The low order word of this value contains the resource ID of the menu option that was chosen. Unused. Whatever the base class method returns after we've handled our own right-click mouse menu options. Select a custom group text color. This is an overridden function to trap when the active tab is about to change. This notification is important because the current viewsheet, the one that's about to be deactivated, needs to save off a snapshot of the current view settings for use the next time it's selected. The zero-based tab index of the new tab to activate. TRUE if it succeeds, FALSE if it fails. This method updates the view, etc. depending on the state of the viewsheet tab control. If it's supposed to force a view update, then the view will be updated no matter what. If not, it will run some checks to determine if it thinks the view needs to be updated or not and act accordingly. Setting "forceViewUpdate" to true causes the graphics to be regenerated if the "in_file_get" global is false. True to force viewsheet update. This method updates the view, etc. depending on the state of the viewsheet tab control. It doesn't force a view update if it doesn't need to - for example, if the selected tab hasn't changed since the last view update then it won't update the view again. (Sort of like a repaint instead of a regen). Updates the view. This is where the magic happens! This member function takes a sheet's index, finds its entry in the viewsheet entries array, and updates the view with the appropriate settings. It also either repaints or rebuilds the graphics screen completely based on whether or not there have been any changes to the level information as a result of updating the view. Note that setting "forceViewUpdate" to true causes the graphics to be regenerated if the "in_file_get" global is false. The zero-based tab index of the sheet to update. (Optional) True to force view update. For X8 and older part files, switch levels from invisible to visible. Shows the viewsheet settings dialog. Set the unique ID of the last active group tab. New value for the last active group tab's ID. Set the unique ID of the last active non-group tab. New value for the last active tab's ID. Enables or disables the use of multiple viewsheets. True to enable multiple viewsheets, and false to disable. Set the index of the active tab. The second parameter is used during file/open to set both the old tab and the active tab. Zero-based index of the tab. (Optional) If true, set the old tab index also (default = false). Saves the worksheet states. A series of worksheet states to be restored later. Save new viewsheet entry for pre-X4 files. This function should only be called from the one place it is called from now. Included for compatibility with pre X4 files. This method takes a snapshot of the current view settings and stores all of the information to the currently active viewsheet. (Optional) true if check for changed. This method saves a view 'bookmark' for a specified viewsheet. This allows the user to save off a copy of the the view settings at a given point, change the view, and then reload the old view settings from the bookmark. The zero-based tab index of the viewsheet to save a bookmark on. Saves the active viewsheet for TempDB. An the active viewsheet. Information to be saved as part of the temporary database. Restores a viewsheet's view settings to a previously saved bookmark of view settings. If it's the currenttly active viewsheet then it also updates the view. Setting "forceViewUpdate" to true causes the graphics to be regenerated if the "in_file_get" global is false. The zero-based index of the viewsheet to restore a bookmark on. (Optional) true to force view update. Restore active viewsheet for TempDB. The zero-based tab index of the sheet to make active. Rename sheet. The zero-based tab index of the sheet to rename. Name of the new viewsheet. Rename sheet. The zero-based tab index of the sheet to rename. Removes a viewsheet group and and converts all of its members to single sheets. Zero-based index of the group's tab. The identifier for the group to remove. If true, ask about deleting group members. If false, keep them. True if the group was removed, false if any problems. This function is called when a new tab has been selected. It checks to make sure it's not the currently selected tab on the control already, makes sure it's a valid index, and then updates the view accordingly. The zero-based tab index of the selected sheet. See if the given tab is an expanded group. Pointer to a viewsheet tab. True if this is a group and it's expanded, otherwise false. See if the given tab is an expanded group. Zero-based index of the tab. True if this is a group and it's expanded, otherwise false. Return true if the viewsheet is in renaming mode. True if we are renaming. Add a group tab and tabs for all its members. The viewsheet ent containing group and viewsheet info. Identifier for the group. [I/O] The tab index for this tab. Initializes all tabs for a newly opened file. Initialize the active tab for a newly opened file. Zero-based index of the active tab that was saved in the file. Initializes the viewsheet control and internal array. This is to be used when a new file is created or on startup, for example. Provided so other processes can get information about the current viewsheets in the control. It's mostly used in saving off the current database, as viewsheet information has to be stored with the part file in those situations and access is needed to the array. Returned array of viewsheets items. (Optional) True to save current settings. The number of viewsheet items. Gets viewsheet information. The 0-based index of a viewsheet tab. null if it fails, else viewsheet info for the given tab. Given a viewsheet ID, return viewsheet information. The ID of a viewsheet. null if it fails, else viewsheet info for the given ID. Calculate the window's tab height. The tab height. Gets sheet name. The zero-based tab index. The sheet name for the sheet number. Gets a viewsheet with the given name. The viewsheet name. null if it fails, else the viewsheet of the name passed in. Gets a viewsheet tab. The 0-based index of a viewsheet tab. null if it fails, else the viewsheet tab of the index passed in. Gets number of viewsheets. The number viewsheets. Get the unique ID of the active group tab. The unique ID value for the most-recent active group tab. Get the unique ID of the last active tab non-group tab. The unique ID value for the most-recent active non-group tab. Gets a list of group members. The 0-based index of a viewsheet tab. A vector of group member IDs if this is a group. An empty vector otherwise. Get the group color for the given tab. Zero-based index of the tab. An index into the Mastercam color table for this group. Gets a value indicating whether the use of multiple viewsheets is enabled. True if viewsheets are currently enabled. This is an overridden function to trap when the active tab has changed. When this message comes in, we know that the tab selection has changed on the control and the screen settings need to be updated. The zero-based tab index of the newly activated tab. Enables the in place edit for the viewsheet name. true to enable, false to disable. This is a testing method to determine if the specified sheet, identified by it's tab index in the tab control, has any bookmark data associated with it yet. The zero-based tab index of the viewsheet to query. True if the specified sheet has a bookmark saved for it, and false if it doesn't. Deletes a viewsheet. If it's the currently active tab, it then sets the first tab in the control as the currently active one and updates the view. The zero-based tab index of the viewsheet to delete. (Optional) If true, only delete the tab, and not the underlying data (default = false). (Optional) True if deleting a temporary sheet (default = false). (Optional) If true, allow even the last viewsheet to be deleted (default = false). (Optional) When deleting a group tab, ask about deleting group members, (default = true). (Optional) The parent viewsheet number to go back to. True if the specified sheet was deleted, otherwise false. Deletes the bookmark for the specified viewsheet. The zero-based tab index of the viewsheet to delete a bookmark on. Deletes all viewsheets. This method deletes all of the viewsheet entry items from the internal array, empties the array, and then removes all of the tabs from the tab control. This REALLY needs to be followed up with a call to CreateNewSheet (), as this will leave the viewsheet control and array completely empty, and it's never supposed to be completely empty. Create a new viewsheet. The name for the new sheet. (Optional) the type of viewsheet to create (default = ViewsheetType::Single). (Optional) true to save a bookmark on the new sheet (default = false). true if the viewsheet is created, otherwise false. Creates a new viewsheet with multiple levels (called by importers, not Mastercam). The name for the new sheet. Identifier for the plane. The matrix. Number of levels. Array of levels. Creates a new viewsheet (called by importers, not by Mastercam). The name. Identifier for the plane. The matrix. The level number. Creates a new viewsheet based off of the currently selected one. (Optional) True to start the rename process (default = true). (Optional) The type of viewsheet to create (default = ViewsheetType::Single) (Optional) The name of the viewsheet (default = nullptr). (Optional) The location of the new tab (default = -1) (Optional) If this viewsheet is a group member, the parent ID (default = 0) (Optional) For groups, true to display the new group dialog (default = false). the unique viewsheet ID of the sheet just created. Create the image list of icons used by the tabs. Copies the given viewsheet using the given name. The zero-based tab index of the sheet to copy. The original name, used to create a new unique variation. (Optional) True to place copy at the end, false to place it after the original (default). The zero-based index of the new copied sheet with the given name. Creates a copy of a viewsheet. The zero-based tab index of the sheet to copy. The zero-based tab index of the new copied sheet. Calculates the tab's inplace rename rectangle. The rectangle edit on the viewsheet tab. Destructor. The destructor frees all of the dynamically allocated viewsheet entries from the array and empties the array. Default constructor. The default constructor initializes the viewsheet array, initializes default values for member variables, and loads all the strings it uses so that it doesn't run into resource problems later. Creates a new ViewSheet. [in/out] The name used for the new ViewSheet. true to save bookmark on the new ViewSheet. ViewSheet names must be unique, so the name you get make may be different than you supplied. The index# of the new sheet (tab) if it succeeds, 0 if it fails. Sets the shared scroll flag. True to enable shared scroll, false otherwise. Set the scroll flag. True to enable scroll, false otherwise. Rename the Tab. Tab Number. Tab Name. True if Rename Allowed. Pre subclass window. Executes the set font action. The wParam field of the message. The lParam field of the message. A LRESULT. Called when this window is created. The create structure. An int. Destructor. Default constructor. User interface tab control. Destroys the window. True if it succeeds, false if it fails. Set the viewsheet type for this tab. The new viewsheet type (Group, Member, or Single). Get the viewsheet type for this tab (Group, Member, or Single). The viewhseet type (Group, Member, or Single). Get the viewsheet identifier for this tab. The viewsheet identifier. Destructor. Constructor. Check plane Id/matrix information. Identifier for the plane. The 3x3 matrix. Type of the plane (CPLANE, TPLANE, GPLANE, WCSPLANE). True if updated, false if not. Fill in viewsheet data from a worksheet entity. The database worksheet entity to copy from . true if we are populating a bookmark, otherwise false. Use the viewsheet data to update which planes have the 'displayed' property set in the global planes list. Set the 'merged' flag for a viewsheet. True for a merged viewsheet, otherwise false. Query if this object is a merged viewsheet. True if merged viewsheet, otherwise false. Update the viewsheet data with plane IDs of displayed planes. The list of plane IDs to populate. true if displayed planes have changed, otherwise false. Set or clear the worksheet's "tailstock" parameter. true to set, false to clear. (Optional) true to set value in bookmark data, false to set viewsheet data. the prior value. Set or clear the worksheet's "stock show" parameter. true to set, false to clear. (Optional) true to set value in bookmark data, false to set viewsheet data. the prior value. Add a level to a worksheet entry. Level number to add to the Worksheet Validate planes for worksheet entry. The worksheet database entity. Sets the work sheet plane for this worksheet entry. Which plane type to set. The plane ID. Use the viewsheet data to update the global stock display settings. Update the viewsheet data with stock display settings. The viewsheet data to update. true if values have changed, otherwise false. Use the viewsheet data to update the global section view display settings. Update the viewsheet data with section view display settings. The viewsheet data to update. true if values have changed, otherwise false. Use the viewsheet data to update the global advanced toolpath display settings. Update the viewsheet data with advanced toolpath display settings. The viewsheet data to update. true if values have changed, otherwise false. Use the viewsheet data to update which planes are selected in the global planes list. Update the viewsheet data with plane IDs of selected planes. The list of plane IDs to populate. true if selected planes have changed, otherwise false. Use the viewsheet data to update which planes are section view planes in the global planes list. Update the viewsheet data with plane IDs of planes marked as section-views. The list of plane IDs to populate. true if section view planes have changed, otherwise false. Saves bookmark information from the database entity to the bookmark member variable. The worksheet database entity. Sets visible level information. True to check for graphics change. Saves visible levels to the worksheet data. The visible levels list. true if the visible levels have changed, false if not. Set the viewsheet type (single or member). The viewsheet type (single or member). True if the type was changed, false if an illegal type was passed in. Get the viewsheet type. The viewsheet type (single or member). Set the viewsheet name. The new name. Get the viewsheet name. The viewheet name. Set the group identifier. The group identifier for this group. Set the panel identifier. The panel identifier for this viewsheet. Indicate whether or not this viewsheet has valid bookmark data. True to set bookmark indicator, false to clear. Indicate whether or not this viewsheet has valid bookmark data. True if this viewsheet has valid bookmark data, otherwise false. Gets the group identifier for this viewsheet. The group identifier, or zero if this viewsheet doesn't belong to a group. Gets the panel identifier. The unique viewsheet panel identifier. Gets the identifier. The unique viewsheet identifier. Check 2 viewsheet info objects for equality. The viewsheet object to compare against. True if the objects are equal, otherwise false. Assignment operator. The object. A deep copy of this object. serialize a viewsheet object. the destination/source archive object. Destructor. Copy constructor. The viewsheet object to copy. Constructor for a viewsheet using a database entity. The database entity. The viewsheet identifier. (Optional) True if this is a merged viewsheet (default = false). Constructor with parameters. The viewsheet identifier. The viewsheet type (group, single, or member). Used by the panel to identify this viewsheet. The viewsheet name. (Optional) If this is a group member, identifier for the parent (default = 0). (Optional) True if this is a merged viewsheet (default = false). (Optional) True if this is the active viewsheet (default = false). Default constructor. A class to hold information about a single viewsheet. Change a level number in the viewsheet data. The old level number. The new level number. Check planes for invalid or corrupt entries. Virtual destructor. Default constructor. Structure to hold information stored for a viewsheet. Parasolid cleanup. Delete the Mastercam Color attributes attached to all the faces and edges of a solid body. The Parasolid tag of the solid body. Returns true if successful. Delete all the Mastercam Color attributes attached to a solid entity. The Parasolid tag of the entity. (Optional) True to update SldEnt information. Returns true if successful. Check if face color is selected in QuickMask color. The face tag. True if it succeeds, false if it fails. Called when the display mode changes to regenerate all selected and highlighted tags. Gets the type of the specified edge. Edge tag to check. L_ID, A_ID, NB_ID or 0 if error. Gets the type of the specified tag. Tag to check. Tag type: SLD_BODY, SLD_FACE, SLD_EDGE, SLD_LOOP, or SLD_NONE if error. Removes all highlight edges from the display list. Removes highlight edges from the display list. Tag of edge(s). If true, edge is selected; if false, highlighted. Adds highlight edges to the display list. Tag of edge(s). Type of edge. If true, edge is selected; if false, highlighted. Loop convexity Edge type returns the PK Face tag which matches the midpoints. mid point. Number of face tags to search. List of face tags to search. Any warnings if no success? Optional returned UV location on Face's surface. returns the PK Edge tag which matches the input start, end, and midpoints. If an edge/color map is specified, the color is changed for any edge tag found in the map. start point. mid point. end point. Number of edge tags to search. List of edge tags to search. is the edge the reverse of the 3 points. Renders a set of Parasolid tags using the specified render type. If an edge/color map is specified, the color is changed for any edge tag found in the map. The tag IDs. Render type. @par Purpose: Find the Parasolid Kernel Face tags associated with a solid entity @return number of faces on solid body @param[in] solid db pointer of solid entity @par Purpose: Free up memory allocated by Parasolid kernel @param[in] ptr memory location allocated but ps_solid_ask_edges() or ps_solid_ask_faces() Replaces tags in the select no pick tag array with the ones provided. Array of tags to use as select no pick tags. Removes all entries from the select no pick tag array. Replaces tags in the select only pick tag array with the ones provided. Eptr of solid whoes faces are to be added to the select only pick tag array. Removes all entries from the select only pick tag array. Find the minimum distance between a point and a solid body point in world coordinates Parasolid tag of a solid body minimum distance between the two if successful returns true if minimum distance was found Tests ps clash. The test body. The test bodies. The clash bodies. True for no warnings. (Optional) True for all clashes. Clash type (CLASH_ERROR/NO_INTERSECT/ALL_ABUT/INTERSECT) Ps face to mach model. The ps tag. The clean offset code. The surf tolerance. The ps behaviour. [in,out] If non-null, the fp. [in,out] If non-null, the tmat. [in,out] The ur. [in,out] The ll. [in,out] If non-null, true if interrupted. The first value in the pair is the number of triangles. User may pass the required "behaviour" version. If user requires the latest behaviour set behaviour =0. The behaviour actually used is in returned as the second value in the pair. This should be stored so that any operations can be regenerated consistently. A std::pair<int,int> This function will take the edgeTag and adds this tag along with all tangent edges to the tangents array if they do not already exist in the array. The edge tag. The array of tangent edges. (Optional) The angle tolerance in radians. Analyze the base sheet and path chain and report any problem in input. Transform the given sheet to position at appropriate end of the path chain. Also create the parasolid curves for the mastercam path chain. The sheet body to sweep. This body is also repositioned. If non-null, the path chain used for sweeping. The view number for path chain. The number of number of Parasolid curves for path. If non-null, the Parasolid curves for path. An error code. Sweep the given sheet body along the path chain curves to create a solid swept body (Mastercam v8). Operation Index of the solid operation. Input sheet to output solid body. If non-null, the path used for sweeping. The path chain view number. An error code. Ps create torus. A variable-length parameters list containing tparams. The currentopuid. (Optional) The version. An int. Ps create sphere. A variable-length parameters list containing sparams. The currentopuid. (Optional) The version. An int. Ps create cylinder. A variable-length parameters list containing cparams. The currentopuid. (Optional) The version. An int. Ps create cone. A variable-length parameters list containing cparams. The currentopuid. (Optional) The version. An int. Solids primitives. A variable-length parameters list containing bparams. The currentopuid. (Optional) The version. An int. Parasolid solid/face tag to Mastercam mesh. The Parasolid solid/face tag. The mesh tolerance. The draw color. The eptr for the newly created mesh entity. True if it succeeds, false if it fails. Parasolid solid/face tags to triangles. The Parasolid solid/face tags. The mesh tolerance. True if it succeeds, false if it fails. The triangle data returned from PsTagsToTriangles (). Parasolid edge to Mastercam curve structure. The Parasolid edge tag. The emask. The returned entity structure. (Optional) True to calculate maximum curvature. (Optional) The curve tolerance (defaults to tol). (Optional) True to use deprecated method to increase speed. WARNING: Do not set to true if entity will be stored in database! True if it succeeds, false if it fails. Parasolid edge to Mastercam curve. The Parasolid edge tag. The returned entity pointer. The draw color. (Optional) The curve tolerance (defaults to tol). True if it succeeds, false if it fails. Chain to Parasolid curves. If non-null, the chain. True to flatten chain. True to orient curves to chain. The chain view number. The number of curves created. If non-null, the Parasolid curves. If non-null, the Mastercam curves. True if filler line was added. True if it succeeds, false if it fails. Boolean intersection. Zero-based index of the operation. Number of base solids. [in,out] If non-null, the base solids. Number of tools. [in,out] If non-null, the tools. True to allow, false to suppress disjoint bodies. [in,out] If non-null, number resulting of bodies. [in,out] If non-null, the resulting bodies. [in,out] If non-null, true to disjoint failure. The operation version number. (Optional) True if bulletin board already started. (Optional) True if merge imprinted. True if it succeeds, false if it fails. Boolean cut. Zero-based index of the operation. Number of base solids. [in,out] If non-null, the base solids. Number of tools. [in,out] If non-null, the tools. True to allow, false to suppress disjoint bodies. [in,out] If non-null, number of resulting bodies. [in,out] If non-null, the resulting bodies. [in,out] If non-null, true to disjoint failure. The operation version number. (Optional) True if bulletin board already started. (Optional) True if merge imprinted. True if it succeeds, false if it fails. Boolean union. Zero-based index of the operation. Number of base solids. [in,out] If non-null, the base solids. Number of tools. [in,out] If non-null, the tools. True to allow, false to suppress disjoint bodies. [in,out] If non-null, number of bodies. [in,out] If non-null, the resulting bodies. [in,out] If non-null, true to disjoint failure. The operation version number . (Optional) True if bulletin board already started. (Optional) True to use the mergeImprinted option. True if it succeeds, false if it fails. Chains to wire bodies. Zero-based index of the operation within the operation file. If non-null, the wire body. Number of body chains. If non-null, the body chains. True to orient the Parasolid curves in the direction of the chain. (Optional) If non-null, (Optional) returns the wire edges. TRUE if successful, FALSE if not. Chains to sheet bodies. Zero-based index of the operation. The Parasolid tag of the sheet created. Number of chains. If non-null, the chains defining the sheet. True to orient curves to chains. The view number of chains. True if it succeeds, false if it fails. Parasolid fillet. Zero-based index of the operation. The solid body. The radius. Type of the overflow. Check resulting blend. True if mitered. True to propagate. Number of edges. [in,out] If non-null, the edges. The version. (Optional) True if bulletin board already started. True if it succeeds, false if it fails. Get the currently selected and highlghted solid items. The selected tags. The highlighted tags. Gets the parent body tag. The tag. The body tag. Calls Parasolids to check for bodies, faces, and/or edges at the specified screen position. Screen position at which to look for hits. Search from back (reverse direction). Type of hits to search for SLD_EDGE, SLD_FACE, SLD_BODY. Array of solid bodies to be searched. Maximum number of hits to return. Returned hit data. (Optional) If true, do custom masking check. (Optional) If true, do color check if masking on color. The number of returned hits. //// Solid-modeling utilities... [in,out] If non-null, the dir. [in,out] If non-null, the name. The SOLID file format version (not the parasolid schema version). True to text format. An int. Does the given tag's type match the given Parasolid type? The tag. Parasolid type to check against (PK_CLASS_assembly, PK_CLASS_body, PK_CLASS_face, PK_CLASS_edge, PK_CLASS_loop, PK_CLASS_vertex). True if the tag's type matches, false otherwise. Defines an alias representing the solid pattern tool data. Solid pattern tool data. Defines an alias representing the sld pattern manual transaction vector. Solid Pattern operation parameters. A solid point input based on a positionon a solid edge. Primitive solid torus operation parameters Primitive solid shpere operation parameters Primitive solid cylinder operation parameters Primitive solid cone operation parameters Primitive solid block operation parameters Primitive solid operation parameters Primitive solid torus operation parameters Primitive solid shpere operation parameters Primitive solid cylinder operation parameters Primitive solid cone operation parameters Primitive solid block operation parameters Typedef for vector of SLD_EXT_CHAIN_DATA. Defines an alias representing a solid change at point vector. Defines an alias representing a solid change at point pointer. The selected solid entity type used in SldAssocOneSel. Solid one pick association type. Solid blend convexity TBD KJC: We will need to move this back to SolidsDialogBase.h once the asynchronous preview in the solids applications is corrected. Defines for Mastercam event loop message processing Gets ps version singleton. The ps version singleton. Gets supported ps versions. The supported ps versions. Gets supported ps versions double. The supported ps versions double. Gets supported ps versions string. The supported ps versions string. Gets current ps version string. The current ps version string. Defaulted destructor. Gets current ps version. The current ps version. @par Purpose: Unhilight the entity edges @param[in] entity Entity for which edges are unhilighted @param[out] selected Selected flag @} @par Purpose: Hilight the entity edges @param[in] entity Entity for which edges are hilighted @param[out] selected Selected flag @param[out] draw Draw flag @par Purpose: Get the vertices which are on either end of an edge, given the edge tag @param[in] edge Parasolid edge tag @param[out] vertex0 Parasolid vertex tag at one end of the edge @param[out] vertex1 Parasolid vertex tag at the other end of the edge @par Purpose: Get the faces which are on either side of an edge, given the edge tag @param[in] edge Parasolid edge tag @param[out] face0 Parasolid face tag on one side of the edge @param[out] face1 Parasolid face tag on other side of the edge @par Purpose: Get the XYZ position at a Parasolid vertex, given the vertex tag @param[in] tag vertex tag @param[out] pt XYZ location (world coordinates) of the vertex @par Purpose: Create Mastercam entities from a Parasolid body, face, or edge tag @return number of entities created @param[in] tag Parasolid body, face, or edge tag @param[out] eptrs pointer to memory to hold Mastercam entity pointres. This function will allocate that memory. Use free() to free up the memory when finished with it. This pointer call also be NULL, or not used. In that case only the number of entities which would be created is returned. Find the number edge tags for the given face. The face tag. The number of edge tags. Find the number edge tags for the given face. The face tag. Array to which edge tags are added. The number of edge tags added to the array. Find the number of edge tags for the given solid body. The solid body tag. The number of edge tags. Find the edge tags for the given solid body. The solid body tag. Array to which edge tags are added. The number of edge tags added to the array. Find the number of edge tags for the given solid entity. The solid db pointer. The number of edge tags. Find the edge tags for the given solid entity. The solid db pointer. Array to which edge tags are added. The number of edge tags added to the array. Find the number of face tags for the given solid body. The solid body tag. The number of face tags. Find the face tags for the given solid body. The solid body tag. Array to which face tags are added. The number of face tags added to the array. Find the number of face tags for the given solid entity. The solid db pointer. The number of face tags. Find the face tags for the given solid entity. The solid db pointer. Array to which face tags are added. The number of face tags added to the array. @par Purpose: Find the db pointer associated with the Parasolid tag on a solid body @return db pointer of solid entity or null_eptr if not found @param[in] body Parasolid tag belonging to a solid body @par Purpose: Query to ask if a Parasolid tag is a vertex @return true if the tag is a vertex, false otherwise @param[in] tag Parasolid tag @par Purpose: Query to ask if a Parasolid tag is a face @return true if the tag is a face, false otherwise @param[in] tag Parasolid tag @par Purpose: Query to ask if a Parasolid tag is an edge @return true if the tag is an edge, false otherwise @param[in] tag Parasolid tag @par Purpose: Query to ask if a Parasolid tag is a solid body @return true if the tag is a body, false otherwise @param[in] tag Parasolid tag Destroys the Viewsheet entity. Create a Viewsheet entity. True to delete any existing viewsheet entity. The Viewsheet entity pointer, or nullptr if creation fails. Return a pointer to the Viewsheet entity. The Viewsheet entity pointer, or nullptr if it doesn't exist. Find the position in the vector of the given viewsheet. The name of the viewsheet to search for. The vector index if found, or -1 if not found. Find the position in the vector of the given viewsheet. The viewsheet ID to search for. The vector index if found, or -1 if not found. Search all Viewsheet groups for the given panel ID. The panel ID to search for. True if found, otherwise false. Find the position in the vector of the given group. The ID of the group to search for. The vector index if found, or -1 if not found. Find the position in the vector of the given group. The name of the group to search for. The vector index if found, or -1 if not found. Check a Viewsheet name for existence If a name is passed in and it is unique, the same name will be returned. If a name is passed in and it already exists, the same name with a (nnn) suffix will be returned. If no name is passed in, the default name (Viewsheet) will be returned. If no name is passed in, the default name already exists, and the 'forceUnique' flag is set, the default name with a '-n' suffix will be returned. The name to check. Can be null or empty, which will provide a default name. True to provide a name variant if the passed in name exists. The same name passed in if it's unique, or a (nnn) if it doesn't Check a Viewsheet group name for existence If a name is passed in and it is unique, the same name will be returned. If a name is passed in and it already exists, the same name with a (nnn) suffix will be returned. If no name is passed in, the default name (Group) will be returned. If the default name already exists, the default name with a '-n' suffix will be returned. The name to check. Can be null or empty, which will provide a default name. The same name passed in if it's unique, or a dash-variant if it doesn't Rearrange root group members to align with the tab order. The tab order. Zero-based index of the active tab. Move a group from one parent to another one. The group ID of the group being moved. The group ID of the group it's being moved to. True if the move was successful, otherwise false. Set the last active tab Id. New active tab. Clear Selected and Active state of all viewsheets. True to do groups. True to do info. Set the active group or viewsheet. Identifier for the group or viewsheet to set. MemberType (Group or Viewsheet). True if a matching id for the given type was found, otherwise false. Save all current viewsheets and groups (used when merging). Restore saved viewsheets and groups. Removes the given viewsheet. Identifier for the viewsheet. True if the viewsheet was removed, false if bad ID. Remove any empty groups. True if any empty groups were found, otherwise false. Merge viewsheet information from an incoming file. The viewsheet ent to merge. See if a given group name exists. The name to check. Identifier for the group to exclude in the check. True if name exists, false if not. Get all viewsheet names. A vector viesheet names. Get the viewsheet information for a given panel ID. The panel ID for the viewsheet. The viewsheet information, or nullptr if bad ID. Get the viewsheet information for a given ID. Identifier for the viewsheet. The viewsheet information, or nullptr if bad ID. Get the next unused viewsheet ID. The next identifier. Gets the next panel identifier. The next panel identifier. Return a copy of a group. Zero-based index of the group in the vector. A copy of the group, or an empty group for invalid indexes. Gets a const Viewsheet group pointer from the underlying vector. Name of the group (not case sensitive). Null if it fails, else the Viewsheet group pointer. Gets a const Viewsheet group pointer from the underlying vector. Index [0..n] of the desired group. Null if it fails, else the Viewsheet group pointer. Gets group member information by panel identifier. Identifier for the panel. The group member information if found, or any empty struct if not. Gets a const Viewsheets group pointer from the collection using a Panel ID. Panel identifier for the group. Null if it fails, else the Viewsheet group pointer. Gets a const Viewsheet group pointer from the collection using a Group ID. Identifier for the group. Null if it fails, else the Viewsheet group pointer. Return the number of viewsheets. The viewsheet count. Return the number of groups. The group count. Find the active viewsheet. The active viewsheet ID, or -1 if there isn't one. Find the active group (if there is one). The active group ID, or -1 if there isn't one. Check for any viewsheets. True if there are no viewsheets, otherwise false. Check for any viewsheet groups. True if there are no viewsheet groups, otherwise false. Remove all viewsheets and viewsheet groups. (Optional) True to remove the hidden Root group, too (default = false). Remove all viewsheet groups. (Optional) True to remove the hidden Root group, too (default = false). Remove a given group by name. Name of the group to remove. True if group is removed, otherwise false (perhaps reserved group?). Remove a given group. Identifier for the group to remove. True if group is removed, otherwise false (perhaps reserved group?). Check for a reserved group. Identifier for the group. True if reserved group (root group), otherwise false. Return the viewsheet ID of the last active tab. Get all group names. (Optional) True to include the 'root' group, false to exclude it. A vector group names. Get all group identifiers. True to include the 'root' group, false to exclude it. A vector all group IDs. Add a viewsheet or group from an older version part file. Information describing the viewsheet or group. (Optional) True to force a unique name. Add a viewsheet. The new viewsheet. (Optional) True to force a unique name. A const ViewsheetInfoPtr if success, nullptr if failure. Add a new group. Unique panel ID. Unigue group ID. Parent group ID, or 0 if no parent. Color index. True if group is expanded. True if group is hidden. True if group is locked. True if group is selected. The name of the group. A const pointer to the newly added group. Add a new group. The group to add. A const pointer to the newly added group. Add default Viewsheet root group. True if root group is added, false if it already exists. Query if 'obj' is equal. The object. True if equal, false if not. Inequality operator. The object. True if the parameters are not considered equivalent. Equality operator. The object. True if the parameters are considered equivalent. Assignment operator. The object. A deep copy of this object. Return the entity type (for the ClassEnt) Return the entity type. - serialize the Viewsheet group entity. the destination/source archive object. destructor. Copy constructor. The object. Constructor. The group and viewsheet pointers. ViewsheetEnt class. @par Purpose: Make NURB Spline(s) from chains @param[in] chains Chains to make NURB spline(s) from @param[in] max_error Tolerance (only applies to higher than cubic curves) @param[in] disp_orig Keep(0), Blank(1), Delete originals(2), or Move to a new level @param[in] disp_level New level if disp_orig == 3 @param[in] color Color of new NURB spline(s) @param[in] level Level of new NURB spline(s) @param[out] succf true indicates successful creation @param[out] newEptrArray The array of new eptrs created @param[in] squash (optional) true to squash to Cplane Suspend operation manager refresh until this is destroyed. An operation manager refresh object that contains the operation IDs to refresh in the main Operation Manager. Return true if operation exists in the database maps. Identifier for the operation. True if it exists, false if not. Pointer to operation info to use to refresh the main OpMgr. If this exists it means that DatabaseUpdate() will not call the OpMgr to update. Reference to an OpMgrRefreshMap that we'll use to update the main OpMgr when this goes out of scope. Disables the refresh. True to disable, false to enable. Preturn previous value of m_RefreshDisabled. map of operation ID's and the number of times TpPartOpList::DatabaseUpdate() was called for each operation while the OpMgr update was suspended. Destructor. Constructor. [in,out] Reference to an OpMgrRefreshMap that we'll use to update the main OpMgr when this goes out of scope. Class that contains operation information used to compare and see if the main OpMgr requires an update. Replaces the operation with the given ID in the refresh map m_RefreshMap. Identifier for the operation. True if it succeeds, false if it fails. Removes the operation with the given ID from the refresh map m_RefreshMap. The operation Identifier to remove. Adds the operation with the given ID to the refresh map m_RefreshMap. Identifier for the operation. True if it succeeds, false if it fails or operation already exists in the map. Destructor. Constructor. Name of our current file. [in,out] Reference to main Operation Manager we'll be refreshing. [in,out] Reference to operation list. Constructor. The operation. Default constructor. Inequality operator. The object. True if the parameters are not considered equivalent. Equality operator. The object. True if the parameters are considered equivalent. Query if 'obj' is equal. The object. True if equal, false if not. Constructor. the operation. A class containing all the operation parameters whose values are displayed in the tree control. Information about the operation to compare when refreshing the OpMgr. Class to keep track of which operations need to be refreshed in the OpMgr when the OpMgr's updates are temporarily suspend. First operation index using the 3D tool specified by the given identifier. Identifier for the tool. (Optional) Identifier for an operation to exclude. An INT_PTR to the first operation using the 3D tool. First operation using the 3D tool specified by the given identifier. Identifier for the tool. (Optional) Identifier for an operation to exclude. Null if it fails, else a pointer to the first operation using the 3D tool. Sort the given IDs by container order. The operation IDs to sort. std::vector of sorted operation IDs. Updates the list and database. The operation entity. True to update time stamp. (Optional) True to update x coordinate form. (Optional) Pointer to EntityMap containing current db info used for dependent operations. True if it succeeds, false if it fails. Database update. The operation entity. True to update time stamp. (Optional) True to update dependents. (Optional) Pointer to EntityMap containing current db info used for dependent operations. True if it succeeds, false if it fails. Fix operation slot numbers when hidden groups exist. List of groups we belong to. True to sort list the underlying container by ascending slot number. True to update operation entities in the current database. IDs of operations that were updated. Sort ascending by operation.slot number. True if it succeeds, false if it fails. Sort a vector of operation pointers. [in,out] [in,out] If non-null, the operation ptrs. The sorting less-than function. The include mask function. True if it succeeds, false if it fails. Gets the next available absolute value frome the given list of long values. List of used operation IDs. The next absolute long value. List Return Code types Check if operation contains surface TP ents. Identifier for the operation. True if it does, false if not. Gets operation surface counts for the operation. Identifier for the operation. The operation surface counts. Test opcode to see if surface operation code requires geometry branches in the Operation Manager. The operation code to test. True if operation type requires geometry branches in the OpMgr. Increment our counts for the given tpEnt. The toolpath entity to check. True if any count was incremented, false if not. Query if all counts are zero. True if empty, false if not. Query if 'obj' is equal. The object. True if equal, false if not. List of surface-entity-type counts. This method is called from within PreTranslateMessage when the WM_KEYDOWN message is sent for the VK_RETURN key. TRUE if the message should be considered as handled, and FALSE otherwise. @par Purpose: Message mapped to when the focus is changed to some other window @param pNewWnd The new window in focus @par Purpose: Message mapped to when the value is selected @param pCmdUI User interface command information @par Purpose: Message mapped to when the value is deleted @param pCmdUI User interface command information @par Purpose: Message mapped to when the value is cut @param pCmdUI User interface command information @par Purpose: Message mapped to when the value is copied @param pCmdUI User interface command information @par Purpose: Message mapped to when the right mouse button is pressed @param[in] nFlags Flags for event @param[in] point Point of mouse coordinates Executes the input validation operation. True to display errors. true if OK, false if not. Destructor @par Purpose: Intercepts the message from pressing enter @param pMsg the message @return the return value of PreTranslateMessage in the parent class Sets the "xyz popup" flag. (Optional) true to select the abbreviated popup, false to select the full popup. Gets the value of the "xyz popup" flag. true if we're using the abbreviated popup, false if we're using the full popup (default). @par Purpose: End the selection cue @param[in] mode selection mode used @param[in] nObjs number of entities selected @param[in] pnts array of points @param[in] eptrs entity database pointers to any selected objects @param[in] tvals any selected t-values @param[out] ctext what the text is turned into @param[out] maxChars maximum number of characters for 'ctext' @par Purpose: Initialize the MCReal @param[in] val The initial value of the real @param[in] minv The minimum allowed value for the real @param[in] maxv The maximum allowed value for the real @param[in] useSelCue Use selection cue? @param[in] isAngle Is this an angle? (true = converts degrees to radians and radians to degrees automatically) @param[in] nDec Number of decimal places, -1 = use system default @par Purpose: Initialize the MCReal @param[in] val The initial value of the real @param[in] minv The minimum allowed value for the real @param[in] maxv The maximum allowed value for the real @param[in] nDec Number of decimal places, -1 = use system default @par Purpose: Sets the value of the edit box @param[in] val The value to set it to @return true if value is within min and max limits @par Purpose: Sets m_forced_precision value @param[in] prec The >0 value to set it to @return previous value of m_forced_precision @par Purpose: Gets the value of m_PlaneType @return the value of m_PlaneType @par Purpose: Sets the value of the m_PlaneType so the calls to world_to_view(), etc respect the correct plane @param[in] planeType The value to set it to (CPLANE, TPLANE, GPLANE, WCSPLANE or UNDEFPLANE for world coordinates @return previous value of m_PlaneType @par Purpose: Expanded Constructor @param[in] val The initial value of the real @param[in] minv The minimum allowed value for the real @param[in] maxv The maximum allowed value for the real @param[in] useSelCue Use selection cue? @param[in] isAngle Is this an angle? (true = converts degrees to radians and radians to degrees automatically) @param[in] nDec Number of decimal places, -1 = use system default @par Purpose: Simple Constructor @param[in] val The initial value of the real @param[in] minv The minimum allowed value for the real @param[in] maxv The maximum allowed value for the real @param[in] nDec Number of decimal places, -1 = use system default @par Purpose: Default constructor The MCReal class is the CEdit for floats and doubles. It supports advanced editing features @par Purpose: Does what needs to be done at the end of the selection cue. @param[in] mode The mode @param[in] nObjs Number of objects @param[in] pnts Array of points @param[in] eptrs List of eptrs @param[in] tvals List of corrosponding t values @param[out] value The value selected by the user @return true if successful Values that represent the valid modes of SelectionCue requests. REFACTOR: THE ORDER OF THIS ENUM MUST NOT CHANGE! It is tied to code in MCEdit::SelectionCue (), which in turn gets you to Interfaces\Core\CommonResIDs.h and the range IDS_SELCUE_X through IDS_SELCUE_TAP_TABLE. Very, very brittle mechanism. B - Tap tables... Q - Quick drill tables... H - Diameter of a Solid Hole W - Angle of an Arc P - Angle between two points T - Angle between two lines O - Angle of a line Angle menu S - Distance between two points L - Length of an Entity D - Diameter of an Arc R - Radius of an arc Z - Z coordinate of a point Y - Y coordinate of a point X - X coordinate of a point None specified Round value to number of digits. Value to round. Number of digits. Rounded value. Executes the input validation operation. True to display errors. true if OK, false if not. Sets data tip override text. Override text. Sets data tip override enabled. Override enabled. A safe version of CEdit::GetLine (). CEdit:GetLine () is notoriously dangerous to use. It requires that the size of the buffer being used be at least sizeof (WORD) in length. It is easy to forget this, thus causing crashes at runtime under certain circumstances (i.e. there is no text). This method simply returns a CString with the Line. (Optional) zero-based number of the line for a multi-line Edit. The text of the line at index. It returns an empty string if index is out of range. Does this tooltip contain override. True if tooltip contains override. Sets override text (this text overrides text from control) Override text. Sets override enabled Override enabled. MALLOC Definition CALLOC Definition REALLOC Definition FREE Definition @par Purpose: This method displays the memory allocation dialog. @par Purpose: This method frees the allocated memory. In the process, it removes the entry from the array that tracks memory. @param[in] module_name module name @param[in] line_n line number @param[in] ptr pointer to free @par Purpose: This method re-allocates memory using realloc. In the process it tracks the memory allocation using the Memory Manager. @param[in] module_name module name @param[in] line_n line number @param[in] ptr old pointer @param[in] size new size @param[out] cmtID resource ID for allocation comment. @par Purpose: This method allocates memory using calloc. In the process it tracks the memory allocation using the Memory Manager. @return pointer value or NULL (failure) @param[in] module_name module name @param[in] line_n line number @param[in] nelem number of elements @param[in] size size of each element @param[out] cmtID resource ID for allocation comment. @par Purpose: This method allocates memory using malloc. In the process it tracks the memory allocation using the Memory Manager. @return pointer value or NULL (failure) @param[in] module_name module name @param[in] line_n line number @param[in] size requested data size @param[out] cmtID resource ID for allocation comment. Check on the processing of any multi-threaded operations. Forces an update to the displayed Statusbar's Selected Entities Count. This is to be called externally (CHook) to force the Selected Enties Count to be updated on the status bar. Query if ManagedUI has been Initialized. NOTE: CAN BLOCK as required due to the std::async. true if initialized, false if not. Gets the count of the Mastercam processes running. The count of running executables. Allows setting of workspace file name from outside of Mastercam.exe. Filename of the workspace file. Updates the application directories described by userDirectory and the AppDirID enumeration. Pathname of the user directory. This interface provides access to application-level data and functions for Mastercam. Solid/face to STL. The tag of the solid or face to write to STL file. The chordal error tolerance. The output stream to write the STL mesh data to. True for ASCII format, false for Binary. If non-null, the transformation matrix. True if process was interrupted. An int. Solid/face to STL. The tag of the solid or face to write to STL file. The chordal error tolerance. The file object. True for ASCII format, false for Binary. If non-null, the transformation matrix. True if process was interrupted. An int. Clear the face color from as solid face. The Parasolid ID of the solid face. true if successful. Sets the color of solid face. The Parasolid ID of the solid face. The color to set the face to. true if successful. Returns color of solid face. The Parasolid ID of the solid face. The color of the solid face. Whether the face color was found and if so what it is based upon. Return values for SldGetFaceColor @par Purpose: Refresh the History Tree item for a solid @return true if successful @param[in] solid solid's database entity pointer @par Purpose: Select a solid body, face or tag. If only selecting bodies, and there is only one body to choose from, it will be grabbed automatically @return parasolid Tag of selected element @param[in] type_mask combination of SLD_BODY, SLD_FACE, and SLD_EDGE @param[in] msg prompt string @param[out] solid_eptr database pointer of solid entity which owns that element @param[out] opIndex operation index of solid feature which owns that element? @param[out] escHit did the user hit 'Escape'? @par Purpose: Convert solid tags to solid, curves, or surfs. @param[in] nTags # of input tags @param[in] xtTags input tags @param[in] scfac scale @param[in] make_solids generate solids? @param[in] make_surfaces generate surfaces? @param[in] make_curves generate curves? @par Purpose: Add the solid to mastercam @return true if successful @param[in] body the new body's tag @param[out] sldEptr returns the imported solid's database entity pointer (optional parameter) @par Purpose: Create a new solid primitive @return The db pointer to the new solid (null_eptr on failure) @param[in] params solid primitive paramters @param[in] descriptor descriptor or name @par Purpose: Select all visible solid bodies as input to a surface toolpath operation @return Not currently used (always returns true) @par Purpose: Get the description field (name) of a solid @return The string containing the description (name) @param[in] solid The db pointer to a Mastercam solid @par Purpose: Set the description field (name) of a solid @return true = solid was updated successfully @param[in] solid The db pointer to a Mastercam solid @param[in] desc The description (name) to be used @par Purpose: Have user select a single solid body (get both ent, and tag) @return The Parasolid tag belonging to the Mastercam solid body (NULTAG if failed) @param[in] csmsg Prompt to be displayed @param[out] entity Mastercam solid entity @param[out] retVal Return value (NULL gets ignored) @par Purpose: Runs a solid entity selection, getting both the entity and the tag. Created as a non-MFC alternative to the original function. @return The parasolid tag belonging to the Mastercam solid body (NULTAG if failed). @param[in] pCharMsg The message prompt to be displayed during selection. (NULL forces a default) @param[out] entity The pointer to the selected solids entity. @par Purpose: Find the Parasolid tag for a given Mastercam solid @return The Parasolid tag belonging to the Mastercam solid body @param[in] solid The db pointer to a Mastercam solid @par Purpose: Create a Mastercam solid entity from a Parasolid solid entity @return The db pointer of the newly added solid @param[in] tag The Parasolid ID of the solid body to be added to the Mastercam database @param[in] blank The blank flag Unbend solid. Identifier for the planar face. The body. True if it succeeds, false if it fails. Gets solid vector. The solid vector. @par Purpose: Find the number of solids in the database @return The number of solids @par Purpose: Find the number of visible solids (on a visible level, not blanked, etc.) @return The number of visible solids @par Purpose: Regenerate all solids @param[in] force_regen true = Regenerate even when solid is not marked as dirty or invalid @par Purpose: Regenerate a solid's operations @param[in] solid db pointer to the solid @param[in] force_regen true = Regenerate even when solid is not marked as dirty or invalid @par Purpose: Adjust the minimum and maximum cooridinates to include the specified solid @param[in] s Mastercam solid ent structure of the solid @param[in,out] minx minimum value of x in world view @param[in,out] maxx maximum value of x in world view @param[in,out] miny minimum value of y in world view @param[in,out] maxy maximum value of y in world view @param[in,out] minz minimum value of z in world view @param[in,out] maxz maximum value of z in world view @par Purpose: Adjust the minimum and maximum X, and Y components to include the specified solid @param[in] s Mastercam solid ent structure of the solid @param[in,out] minx minimum value of x in current graphics view @param[in,out] maxx maximum value of x in current graphics view @param[in,out] miny minimum value of y in current graphics view @param[in,out] maxy maximum value of y in current graphics view @par Purpose: Delete the solid associated with this Mastercam solid entity @param[in,out] entity given entity @param[in] noDb true = do not update psID of entity in databse once deleted @par Purpose: posts operations @param[in] p ptr to post settings, NULL to call post dialog @param[in] pst_name new post name @param[in] dest_name destination NC directory @param[in] call_dialog true = display dialog @param[in] disable_post_pb turns off the post pushbutton Pointer to the Planes follow rules (Cplane follows WCS, etc). Return pointer to plane manager bar. Return pointer to plane manager bar, nullptr if error. Return true if running debug version. Return true if running debug version. Return true if running 32 bit version. Return true if running 32 bit version. Values that represent follow rules masks. Apply follow rules after Cplane changes. The previous Cplane before it was changed. true if it succeeds, false if it fails. Saves follow rules to the registry. Reads the follow rules from the workspace. true if it succeeds, false if it fails. Get value of 'Display Status Relative to WCS'. return true if enabled, false if disabled. Enable or disable 'Set Display Status Relative to WCS' rule. true - enable, false - disable. returns previous setting. Get value of 'Tplane follow Cplane'. return true if enabled, false if disabled. Enable or disable 'Set Tplane follow Cplane' rule. true - enable, false - disable. returns previous setting. Get value of 'Cplane follow WCS'. return true if enabled, false if disabled. Enable or disable 'Set Gplane follow WCS' rule. true - enable, false - disable. returns previous setting. Get value of 'Set Gplane follow WCS'. return true if enabled, false if disabled. Enable or disable 'Set Gplane follow WCS' rule. true - enable, false - disable. returns previous setting. Get value of 'Set Cplane to TOP when Gplane is set to ISO rule'. return true if enabled, false if disabled. Enable or disable 'Set Cplane to TOP when Gplane is set to ISO rule'. true - enable, false - disable. returns previous setting. Get value of 'Cplane follow Gplane rule'. return true if enabled, false if disabled. Enable or disable 'Cplane follow Gplane rule'. true - enable, false - disable. returns previous setting. Applies the follow rules to the active plane type after the plane has changed. Type of the plane . (Optional) the previous plane to detect changes. true if it succeeds, false if it fails. Destructor. Constructor. A reference to a MastecamPlanes object. unselect all the geometry collected m_EptrArray. return # of entities unselected. select a geometry entity for plane creation. the resource ID of the message to display. geometry entity to fill in with the selection. (Optional) geometry selection mask. return true if successful. select a geometry entity for plane creation. the message to display. geometry entity to fill in with the selection. (Optional) geometry selection mask. return true if successful. copy the geometry selection t valuesinto tVal. the p_2d type to copy the values into. copy the geometry selection point values into selPt. the p_3d type to copy the values into. Initialize the SelectPlaneGeometry class. standard destructor. Default constructor. Defines an alias representing the plane by geometry pointer. Class to select geometry for Plane construction and unselect geometry on destruction. display the 8 options, select one and update the given plane's matrix and transform info. attempt to use the active CPLANE, TPLANE or WCSPLANE otherwise the first parallel plane with the same Z direction found in Planes. [in,out] the Plane to update. [in,out] Dialog's parent window. return true if selected. Rotate the given plane from the Rotate dialog results. List of selected Plane IDs. MastercamPlanes object to which it will or does belong. true = update refPlanes, false = just edit thePlane. plane type (CPLANE, TPLANE, GPLANE or WCSPLANE) Parent window return true if successful. Rotate the given plane from the Rotate dialog results. the Plane to rotate. MastercamPlanes object to which it will or does belong. true = update refPlanes, false = just edit thePlane. plane type (CPLANE, TPLANE, GPLANE or WCSPLANE) Parent window return true if successful. Create or edit a plane from the Dynamic dialog results. the defined Plane if successful. MastercamPlanes object to which it will belong. App data to init and fill in with dialog results. true = update refPlanes, false = just edit thePlane. plane type (CPLANE, TPLANE, GPLANE or WCSPLANE) return true if successful. Create a plane from the Select Normal dialog results. the defined Plane if successful. MastercamPlanes object to which it will belong. plane type (CPLANE, TPLANE, GPLANE or WCSPLANE) The pre-selected matrix choice (0-7) other wise matrix chooser dialog will be presented. Dialog's parent window. graphics plane 'rotate incremental' value from the Select Normal results. graphics plane 'rotate angle' value from the Select Normal results. (Optional) true = diaply sketcher bar. return true if successful. Select a face on a solid to define a non-associated Plane. the defined non-associative Plane if successful. MastercamPlanes object to which it will belong. plane type (CPLANE, TPLANE, GPLANE or WCSPLANE) The pre-selected matrix choice (0-7) other wise matrix chooser dialog will be presented. Dialog's parent window. return true if successful. Select a face on a solid to define an associated Plane. [in,out] the defined Plane associated to the solid face if successful. MastercamPlanes object to which it will belong. plane type (CPLANE, TPLANE, GPLANE or WCSPLANE) [in,out] Dialog's parent window. return true if successful. Select geometry to define a Plane. [in,out] the defined Plane if successful. plane type (CPLANE, TPLANE, GPLANE or WCSPLANE) [in,out] Dialog's parent window. return true if successful. destructor. Default constructor. Class to define a Plane by geometry selection Load up a CNormalVwDlg with the default 8 matrices based on the given matrix at the given origin and select one. 3x3 matrix used as the basis of the default 8 Cnc::Globals::Planes::GetPlanes (). P3D in world coordinates used as the origin of the default 8 Cnc::Globals::Planes::GetPlanes (). Dialog's parent window. return array index of selection, -1 for error. Load up a CNormalVwDlg with the given array of Planes and select one. Array of Planes to load and select from. reference to Plane to fill in with selection. Dialog's parent window. return array index of selection, -1 for error. destructor. Default constructor. Default constructor. Information about the choice made. Class to display matrix selection. The "default 8" Planes: Plane[0] = "base" Plane Plane[1] = base Plane rotated 90 degrees about Z Plane[2] = base Plane rotated 180 degrees about Z Plane[3] = base Plane rotated 270 degrees about Z Plane[4] = "flipped" base Plane rotated 180 degrees about Y axis (base plane flipped Z direction) Plane[5] = "flipped" base Plane rotated 90 degrees about Z Plane[6] = "flipped" base Plane rotated 180 degrees about Z Plane[7] = "flipped" base Plane rotated 270 degrees about Z Debug string level - 0 = no debug messages, 1 = show dialog, 2 = Mastercam event log. The message. Temporarily override m_DebugLevel. [in,out] (Optional) If non-null, the parent window. Pushes cache info to the front of m_Cache. Cache info. True if it succeeds, false if it fails. Searches for the first match for the given constant findPrm. The reference to our planes. The search parameters. The call counter for a debug message. pointer to match, nullptr if none found. Output a debug-only string. The message to output. Initializes this object. Default constructor. Default constructor. The cache data. Cache of previous search parameters and results for our Find() function. Builds m_FindMatrixCache from the contents of this. Size of m_FindMatrixCache. Clears m_FindMatrixCache and m_FindPrmCache. Which caches to clear and whether to rebuild the system matrix cache. Values that represent clear cache modes use in ClearFindCaches(). Clears the contents of m_Planes, m_FindMatrixCache and m_FindPrmCache. (Optional) True to clear groups, false otherwise. Check plane, return true if running Solid Works if we should skip. The plane to check. True if we should ignore in search. Convert old-style 'relative' plane to a regular plane with an added transformation. The relative plane to convert. true if plane converted. When reading in files with non-English languages the reserved planes often have names that do no jive with the reserved names in an English resource file. Compare the given plane against our reserved planes and update the name if it's found to have this condition and return a true if the plane has been updated. the plane to check. true if it was changed, false if no change. Force proper case names if old uppercase names are found in reserved planes. the plane to check. true if name was updated, false if not. Some lathe planes are reserved for Cplane use only. Make sure the lathe plane we need does not violate this rule. The plane type it will be used for (CPLANE, WCSPLANE, etc) The coordinate display mode. Identifier for the plane. Pointer to plane to use as lathe plane. Searches for the first reserved plane pointer. The matrix to match. The origin world coordinates, nullptr if you don't care. The active plane we plane on using it for (Tplane's and WCS's have special rules). The coordinate display mode. true = create and add if needed. Return const pointer to reserved plane that matches matrix and coordinate display. Updated ONLY the m_Gplane and m_GviewNo member variables in CGraphicsView to the current graphics view from in here. Copy the active planes into this. The active planes. Build a work offset map. object containing work offset map. toolpath operation ID to exclude from map. return size of work offset map built inside of woffUtil. lock the Plane (no edits allowed) with this ID. Identifier for the plane. Return planes update code PlanesUpdated::Updated if successfully unlocked or PlanesUpdated::NotUpdated. Compare changes in a plane to determing whether the Plane Manager should be refreshed. The old plane. The new plane. A PlanesUpdated type if a plane manager update is warranted, PlanesUpdated::NotUpdated if no refresh of the Plane Manager is needed. Temporarily intialize underlying map data with just the reserved matrices and planes as if we initialized a new Mastercam file. (Optional) Type of the coordinate display (Mill, LatheX or LatheD). If not defined the coordinate display type within this will be used. A ResetMapData unique pointer. Map data will be restored with this goes out of scope. Destructor - restore data saved in constructor. Constructor. [in,out] A reference to a MastercamPlanes class to initialize/restore. Type of the coordinate display (Mill, LatheX or LatheD). Class to temporarily intialize underlying map data with just the reserved matrices and planes as if we initialized a new Mastercam file. Cast a void pointer as a MastercamPlanes object, make sure m_FindMatrixCache is built. If non-null, a void pointer that will be cast. nullptr if it fails, else a pointer to the MastercamPlanes. Sets debug level. The debug level (0 = no debug messages, 1 = show dialog, 2 = Mastercam event log). Previous value if set successfully, -1 on error. Gets value of m_DebugLevel. Value of m_DebugLevel. Saves the given active plane and restores then upon destruction. CPLANE, TPLANE, WCS or GPLANE. An operation view. Plane ID or matrix/origin pair has priority. A std::unique_ptr to a SaveRestoreActivePlanes class,. Saves the given active plane and restores then upon destruction. CPLANE, TPLANE, WCS or GPLANE. The plane ID to set the active plane to. A std::unique_ptr to a SaveRestoreActivePlanes class,. Saves the given active plane and restores then upon destruction. CPLANE, TPLANE, WCS or GPLANE. The plane to set the active plane to. A std::unique_ptr to a SaveRestoreActivePlanes class,. Saves the given active planes and restores then upon destruction. CPLANE, TPLANE, WCS or GPLANE. The matrix to set. The originn in world coordinates to set. Mill, LatheX or LatheD. A std::unique_ptr to a SaveRestoreActivePlanes class,. Saves the given active planes and restores then upon destruction. (Optional) CPLANE, TPLANE, WCS or GPLANE. UNDEFPLANE == all 4. (Optional) True to disable a Planes Manager list update upon destruction. A std::unique_ptr to a SaveRestoreActivePlanes class. Saves the currently active planes before setting any new ones. (Optional) CPLANE, TPLANE, WCS or GPLANE. UNDEFPLANE == all 4. Return true if the given plane is one that will be restored but is different than what we have saved to restore. The plane to compare. True if plane has been saved to be restored but is different. Disables the update of the plane manager when this goes out of scope. Disables the restoration of the saved active planes. Restores the saved active planes in m_RestoreThese. Destructor. Constructor. A MastercamPlanes reference. CPLANE, TPLANE, WCS or GPLANE. The plane to set the active plane with. Constructor. A MastercamPlanes reference. CPLANE, TPLANE, WCS or GPLANE. The matrix to set. (Optional) The origin in world coordinates to set, nullptr = use current. (Optional) Mill, LatheX or LatheD, nullptr = use current. Constructor. A MastercamPlanes reference. (Optional) CPLANE, TPLANE, WCS or GPLANE. UNDEFPLANE == all 4. Check coordinate display in plane so that the standard mill planes (Top thru Trimetric) can never be set to Lathe D or Lathe X, and any standard lathe plane can never be set to mill. The plane to check. true if was corrected, false if not. Select a plane in the planes manager that's hooked to this. Identifiers for the planes to select. Returns const plane ptr to what's selected in the plane manager that's hooked to this. const plane ptr to what's selected in the plane manager that's hooked to this. Updates the plane manager dialog. The planes update code. The plane IDs to update, empty set = reload list control. true if it succeeds, false if it fails. Updates the plane manager dialog. The planes update code. true if it succeeds, false if it fails. Enables the updating of the list control in the plane manager. Value will be restored upon the destruction of the PlanesMgrBarUpdate object. (Optional) true to update/refresh Plane Manager on destruction. A shared ptr to a PlanesMgrBarUpdate object. Disables the updating of the list control in the plane manager. Value will be restored upon the destruction of the PlanesMgrBarUpdate object. (Optional) true to update/refresh Plane Manager on destruction. A shared ptr to a PlanesMgrBarUpdate object. Sets the value of m_UpdateOnDestruction. True to enable, false to disable. True if it succeeds, false if it fails. Destructor. Constructor. [in,out] ptr tp the global planes manager bar. true = enable update, false = disable update. const reference to a MastercamPlanes object to copy it's named planes into m_PlanesOnEntry. True to reload list control on destruction. Copy the contenst of planesPtrArray into planeMap. Array of plane pointers to copy. Return plane map. Copy the contenst of planesArray into planeMap. Vector of planes to copy. Return plane map. Remove a plane from the map by its ID. ID of the plane to remove. Return true if plane found and removed. Update a Plane in the map. the Plane to update. Return true if plane found and updated. Add a Plane to the map. the Plane to add. first = return system matrix pointer, true if added, false if existing found. Add a Plane to the map. the Plane to add. Return true if plane added. copy map into m_Planes. The map to copy. Size of m_Planes. 2021 - Repair duplicate system matrices. A set of system matrix IDs that were removed. Gets the map. The map. Sets scratch view. the scratch plane to set. The source plane to set it to. The previous value. Sets scratch view. the scratch plane to set. The matrix to set it to. The previous value. Sets scratch view. the scratch plane to set. The plane containing the matrix to set it to. The previous value. Sets scratch view. the scratch plane to set. The plane containing the matrix to set it to. The previous value. Gets scratch view no. The scratch view number. (Optional) true to create new if an existing matrix not found. The scratch view no. Gets scratch view no. The scratch view number. (Optional) true to create new if an existing matrix not found. The scratch view no. Gets scratch matrix by view #. The scratch view number. (Optional) true to create new if an existing matrix not found. The scratch view. Gets scratch view by view #. The scratch view number. The scratch view. Sets m_MouseView. The matrix to set. Previous value. Sets m_MouseView. The matrix to set. Previous value. Gets mouse view no. The mouse view no. Gets mouse view matrix. Shared pointer to the mouse view. Gets ptr to mouse view. const pointer to the mouse view. Get a plane work's offset. Identifier for the plane. The plane's work offset (-1 for 'automatic'). Get a plane's section view state. Identifier for the plane. True if the plane is a section view plane, false if it's not. Get a plane's name. Identifier for the plane. The plane's name. Get a plane's origin. Identifier for the plane. The plane's origin. Get a plane's matrix. Identifier for the plane. The plane's matrix. Get a plane's locked state. Identifier for the plane. True if the plane is locked, false if it's not. Get a plane's coordinate display. Identifier for the plane. The plane's coordinate display. Get a plane's comment. Identifier for the plane. The plane's comment (might be empty if there is no comment). Get a plane's color. Identifier for the plane. The plane color. Gets operations that use the given plane. List of operations to look thru. The plane the operation may be referencing. True to just check for a matrix or origin origin change. List of operation IDs that use the given plane. Return true if the named planes at the given ID's are linked to any other plane. The ID's of named planes to check, empty for all named planes. true if any planes have links, false if not. Rotates an existing non-reserved, non-locked plane. Identifier for the named plane. The axis to rotate about (X=0, Y=1, Z=2). The rotation angle in degrees. Return planes update code. Convert a point in plane coordinates to world coordinates (map from plane's view, add the plane origin). the plane. The point in plane coordinates. P3D in world coordinates. Convert a point in world coordinates to active plane coordinates (map to plane's view, subtract the plane origin). WCSPLANE, TPLANE, CPLANE or GPLANE. The point in world coordinates. P3D of world point relative to the active plane's view and origin. Convert a point in plane coordinates to world coordinates (map from plane's view, add the plane origin). the plane. The point in plane coordinates. P3D of world point relative to the plane's view and origin. Convert a point in world coordinates to plane coordinates (map to plane's view, subtract the plane origin). the plane. The point in world coordinates. P3D of world point relative to the plane's view and origin. Returns the SystemMatrix ID as a short that matches the matrix m33. The plane containing matrix to match. (Optional) true to create new SystemMatrix plane if no match found. The view no. Returns the SystemMatrix ID as a short that matches the matrix m33. The matrix to match. (Optional) true to create new SystemMatrix plane if no match found. The view no. Returns the SystemMatrix ID that matches the matrix m33. The plane containing matrix to match. (Optional) true to create new SystemMatrix plane if no match found. The view no. Returns a const pointer to an existing system matrix with the given ID. The view ID. const pointer to an existing system matrix, nullptr if none found. Returns the SystemMatrix ID that matches the matrix m33. The matrix to match. (Optional) true to create new SystemMatrix plane if no match found. The view no. Gets the view number of a reserved matrix type. reserved matrix type. The view matrix. Get the matrix defined as ReservedPlanes::TypeID::Top. The view matrix. Gets the view matrix of a reserved matrix type. The top view matrix. Gets view matrix from a SystemMatrix by its ID (viewNo). The view no. (Optional) true for debug warning if view not found. the matrix_33 found with the given view number. Gets the value of mTemporary. the value of mTemporary. Sets m_Temporary so all added planes from this point on will be marked as temporary and removed on a file/save. true for on. previous value of m_Temporary. Gets the version. The version. Check to see if we should skip matching on lathe Cplanes because of plane type and coordinate display. The plane type (PlaneType::CPLANE, etc). true if we should skip, false if not. Call CGraphicsView.cpp::SetPlane() ONLY from DbFile.cpp::get_db() the plane. true if it succeeds, false if it fails. Temporarily sets the db state in this. Db state will be restored upon destruction. State of the database. A unique ptr to a SetRestoreDbState class. Destructor. Constructor. State of the database. Reference to a MastercamPlanes object. Class to set and restore our m_DbState. Returns const reference to m_DbState. const reference to m_DbState. Relying on the global in_file_get is unreliable, so set our own m_InGetDb. State of the database. previous value of m_DbState. Sort given array of planes by name. [in,out] Array to sort. True = sort ascending, false = descending. # of planes in planesArray. Returns a map of solid entity IDs (ent.ent_idn) and solid selection IDs. List of plane IDs to look in, empty for all. Null if it fails, else the plane ptrs referencing solids. Collect all the planes in this that match the given IDs in planeIDs. Array of plane ID's to match. (Optional) True to include, false to exclude planes marked as temporary. # of planes found and copyied into planesArray. Collect pointers to all the planes in this. The plane class. (Optional) True to include, false to exclude planes marked as temporary. # of planes found and copyied into planesArray. Collect pointers to all the planes in this. (Optional) True to include, false to exclude planes marked as temporary. vector of const Plane pointers. Collect and return copies of all the named planes in this. (Optional) True to include, false to exclude planes marked as temporary. # of planes found and copyied into planesArray. Collect all the planes referencing geometry ID's. Array of entity ID's. vector of planes that reference given geometry IDs in entIDs. Validate all view sheets plane info, create new Planes and assign as needed. (Optional) true = create a new Plane if needed. (Optional) true = check for matching Plane first before creating a new one. (Optional) pointer to change flag; will be set to type of change that occured (PLANES_COMPARE_SAME, PLANES_COMPARE_CHANGED, PLANES_COMPARE_REMOVED, PLANES_COMPARE_MATCH_SUPPLIED) return # of operation whose Plane assignments were changed. Validate an view_ent, create new Plane and assign to view_ent if needed. The op_view to validate. The database view map. (Optional) true = create a new Plane if needed. (Optional) true = check for matching Plane first before creating a new one. (Optional) pointer to change flag; will be set to type of change that occured (PLANES_COMPARE_SAME, PLANES_COMPARE_CHANGED, PLANES_COMPARE_REMOVED, PLANES_COMPARE_MATCH_SUPPLIED) return Plane assigned to view_ent. Update all the drafting entities that use. Reference to plane. A set of drafting entity IDs (ent.ent_idn) that were updated. Validate all 3 op_view's in all operations, create new Planes and assign as needed. Plane ID or matrix/origin pair has priority. return ID's of operation whose Plane assignments were changed. Validate all 3 op_view's in the operation, create new Planes and assign as needed. [in,out] The operation to validate its WCS, Tplane and Cplane op_view's. Plane ID or matrix/origin pair has priority. Which planes had their matrix/origin changed. Validate an op_view, create new Plane and assign to op_view if needed. Plane ID or matrix/origin pair has priority. [in,out] The op_view to validate. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) (Optional) true = create a new Plane if needed. (Optional) true = check for matching Plane first before creating a new one. return true if op_view's matrix or origin changed. Validate planes stored in groups, create new Planes and assign as needed. Plane ID or matrix/origin pair has priority. return # of groups updated. Check a machine group's plane assignments. [in,out] The machine group to check. Plane ID or matrix/origin pair has priority. (Optional) true = create a new Plane if needed. [in,out] (Optional) pointer to change flag; will be set to type of change that occured (PLANES_COMPARE_SAME, PLANES_COMPARE_CHANGED, PLANES_COMPARE_REMOVED, PLANES_COMPARE_MATCH_SUPPLIED) returns true if plane assigned to grpView is valid. Validate an grpView, create new Plane and assign to grpView if needed. Plane ID or matrix/origin pair has priority. The grpView to validate. (Optional) true = create a new Plane if needed. (Optional) pointer to change flag; will be set to type of change that occured (PLANES_COMPARE_SAME, PLANES_COMPARE_CHANGED, PLANES_COMPARE_REMOVED, PLANES_COMPARE_MATCH_SUPPLIED) returns true if plane assigned to grpView is valid. Check reserved plane info, create new if instructed. The plane to check. (Optional) true = create a new Plane if needed. (Optional) pointer to change flag; will be set to type of change that occured (PLANES_COMPARE_SAME, PLANES_COMPARE_CHANGED, PLANES_COMPARE_REMOVED, PLANES_COMPARE_MATCH_SUPPLIED) return true if plane is a reserved plane with all valid data. Check a plane's matrix and origin, find matching or create new if instructed. The plane to check. (Optional) true = set ID to 0 if plane with the same ID does not exist. (Optional) if plane is reserved, validiate data for current db. (Optional) true = create a new Plane if needed. (Optional) true = check for matching Plane first before creating a new one. (Optional) true = check for parallel Plane first before creating a new one. (Optional) pointer to change flag; will be set to type of change that occured (PLANES_COMPARE_SAME, PLANES_COMPARE_CHANGED, PLANES_COMPARE_REMOVED, PLANES_COMPARE_MATCH_SUPPLIED) return true if valid plane. Check for supporting matrices for named planes. Return number of system matrices added. Adds standard matrices to this if they don't already exist. Gets const reference to the standard 20 matrices. The standard matrices. Build a named plane by a reserved name, return array index if it already exists. the name to check/build. the Plane to build. return 1 if it already exists, 0 if not, -1 for error. Build a named plane by a reserved ID, return array index if it already exists. the ID to check/build. [in,out] the Plane to build. return 1 if it already exists, 0 if not, -1 for error. Build a named plane by a reserved plane class, return array index if it already exists. Reserved plane info. [in,out] the Plane to build. return 1 if it already exists, 0 if not, -1 for error. Build a system matrix by a reserved plane class, return array index if it already exists. reserved plane info. the PlaneBase class to build. return 1 if it already exists, 0 if not, -1 for error. Return code for BuildReservedPlane() Remove all reserved planes from this. true = first check if any reserved planes are used before deleting them. Return planes update code PlanesUpdated::Updated or PlanesUpdated::NotUpdated. Return ID of reserved plane with the given name. the Plane name to check. Return reserved ID of reserved plane with the given name. Gets lathe tplane names map. The lathe tplane names map. Updates the reserved names of this to the contents of obj. the planes to copy reserved names from. Return name of reserved plane with the given ID. Reserved ID of plane. Return name of reserved plane with the given ID. Collect all the reserved Plane names into the given CStringArray. [in,out] Array to copy plane names into. The plane class. Return # of names collected into array. return true if the plane name is a default one. the Plane name to check. true = same name, but upper/lower case mismatch. return true if the plane name is a default one. return true if the plane ID is a default one. the Plane ID to check. return true if the plane ID is a default one. return true if the plane ID is a default one. the Plane ID to check. return true if the plane ID is a default one. remove any the 3 attributes (Plane.m_ID, Plane.m_Name or Plane.m_Reserved) that define a plane as 'reserved'. the Plane to check. return members cleared (RESERVED_FLAG, RESERVED_ID or RESERVED_NAME) return true if the plane contains a reserved ID, a reserved name or has its m_Reserved member variable set. the Plane to check. return true if the plane is a default one. return true if the plane contains a reserved ID, a reserved name or has its m_Reserved member variable set. the Plane to check. which data members are considered reserved (RESERVED_FLAG, RESERVED_ID, RESERVED_NAME) (Optional) true = return on the first violation instead of testing all 3. return true if the plane is a default one. return true if the reserved plane's ID and name are set correctly. the Plane to check. The undef members. return true if the reserved plane's ID matches the reserved name. return the number of default planes that were built for this. The reserved limit. Return ID of reserved plane. Lathe_Z_Equals_World_Z, etc. return view number, 0 if error. Return ID of reserved plane. the plane name. return view number, 0 if error. Collect all reserved plane info that matches the given parameters. A pointer to a 3x3, nullptr = all. A pointer to the coordinate display type, nullptr = all. [in,out] (Optional) A pointer to a bool, true = VTL only, false = non-VTL, nullptr = all. std::vector matching reserved plane info. Get copy of reserved Plane by name. the plane name. the plane ID if it already has been added and exists. return copy of reserved plane. Get copy of reserved Plane by long ID. ReservedPlanes::TypeID::Front, RESERVED_ID_CAXIS_UPPER_LEFT, etc. [in,out] the plane to fill in if it already has been added and exists. return copy of reserved plane. Get copy of special lathe Tplane info by ID. ReservedPlanes::TypeID::Front, RESERVED_ID_CAXIS_UPPER_LEFT, etc. [in,out] the plane to fill in if it already has been added and exists. return copy of reserved plane. Get copy of reserved Plane by ID. ReservedPlanes::TypeID::Front, RESERVED_ID_CAXIS_UPPER_LEFT, etc. [in,out] the plane to fill in if it already has been added and exists. return copy of reserved plane. build a list of the first 7 (or 11 for lathe) plane names. AEB_MILL, AEB_LATHE, AEB_MT or a combination of all. true = save work offset, color and comment from existing. The rebuild mode. Update coordinate mode in graphics area. (Optional) List of names of the init reserved. (Optional) true = make sure they're not used before deleting old ones. return # of names in m_ReservedNames. build a list of the first 7 (or 11 for lathe) plane names. CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD. true = save work offset, color and comment from existing. The rebuild mode. Update coordinate mode in graphics area. (Optional) List of names of the init reserved. (Optional) true = make sure they're not used before deleting old ones. return # of names in m_ReservedNames. Count the number of matching work offsets. Work offset value to look for. The 3x3 matrix to match. The origin pt in world coordinates to match. # of matching work offsets found. Collect all the work offset info nodes. Array to copy work offset info nodes into. Size of wNodeArray. Collect all the work offset info nodes used with the given work offset value. Work offset value to look for. Array to copy work offset info nodes into. (Optional) Exclude the operation with this ID from the search. Size of wNodeArray. Return true if work offset value is already being used with a matrix and origin other than the given ones. Work offset value to look for. The 3x3 matrix to match. The origin pt in world coordinates to match. (Optional) Exclude the operation with this ID from the search. true if work offset value is already being used with a matrix and origin other than the given ones. Get the matching work offset or calculate the next unused work offset value if a matching one is not found. The 3x3 matrix to match. The origin pt in world coordinates to match. (Optional) First valid work offset value. (Optional) number to increment work offset value until an unused value is found. return matching or new unique work offset value. Calculate the next unused work offset value. (Optional) First valid work offset value. (Optional) number to increment work offset value until an unused value is found. return matching work offset value, -1 (WOFF_OFF) if none found. Return work offset value stored in Planes, operations or binary NCI that matches given matrix and origin. The 3x3 matrix to match. The origin pt in world coordinates to match. (Optional) Exclude the operation with this ID from the search. return matching work offset value, -1 (WOFF_OFF) if none found. Return work offset value stored in Planes, operations or binary NCI that matches matrix and origin in the given plane. The plane to match. (Optional) Exclude the operation with this ID from the search. return matching work offset value, -1 (WOFF_OFF) if none found. Validate tool plane assigned to the operation. the operation containing the toolplane to check. return true if validation completed successfully. Create a unique plane name when build lathe specific planes. The base name. The next unique name. Return true if successful. Check to see if tool plane is not used anywhere other than the given operation and can be deleted. operation that contains the tool plane to check. set to true if tool plane can be deleted. return false for error, true if plane found. Compare parameters within the operation's views, return true if any have changed. the operation to check its WCS plane, tool plane and construction plane. The matrix. Return true if any has changed from what's store in this. Find a lathe tplane named view that matches what is needed. name substring filter to match. op_view containing matrix and origin to match. matching Plane on success, zero plane (plane with an ID of 0) if no match found. Given a view number get the vtl view number, it might be different. View number. Vtl view number. Given a vtl view number get the view number, it might be different. Potential vtl view number. View number. Recalculate a relative Plane. The plane to recalculate. true = plane is linked to another. overwrite a Plane in the array. the Plane's to overwrite with (ID's must match) (Optional) if !nullptr, mark all dependent toolpath operations dirty. Return planes update code PlanesUpdated::Updated or PlanesUpdated::NotUpdated. Get const Plane's parent reference. the Plane's ID. const Plane reference. temporary for debug only. the plane. true if it succeeds, false if it fails. Gets a list of plane IDs that the given plane IDs can link to without conflict. The plane IDs to check for linkable candidates. List of plane IDs the given IDs can link to without conflict. Gets a set of linkable plane IDs from the given plane ID. Identifier for the plane. The linkable plane IDs. Remove link from dependent plane. Identifiers for the planes to unlink. Number of planes unlinked. Makes one plane dependent on another. Identifier for the parent plane. Identifier for the plane to be linked. True if it succeeds, false if it fails. Sort a list of plane IDs by regeneration order. The plane IDs to sort. A copy of the list of plane IDs sorted sorted by regeneration order. Gets the regeneration order for all the named planes. List of named plane ID's in the regeneration order. collect the array locations of all the planes that link to the given plane. A valid plane ID to look for links. The dependency direction: Parents (linked) or Children (linked to). (Optional) Maximum number of plane IDs to return, 0 = all linked IDs found. (Optional) True for direct (parent/child) only, false to allow indirect (grandparents, grandchildren, etc). vector of dependent plane IDs. Values that represent dependency direction. return true if the plane can be edited (not reserved, etc) the Plane to check. check locked state, if locked do not allow editing. true if the plane can be edited. Apply a transformation matrix to planes that reference the given geometry entity IDs (ent.ent_idn). The IDs of the geometries to manage. The transformation matrix to apply. If true, the transform is only applied if the plane is associated in origin or in orientation (Optional) If non-null, the geometry map, otherwise it will make one (i.e. expensive). A set of plane IDs successfully updated. Apply a transformation matrix to planes. The IDs of the named planes to manage. The transformation matrix to apply. if true, the transform is only applied if the plane is associated in origin or in orientation. [in,out] If non-null, the geometry map, otherwise it will make one (expensive). A set of plane IDs successfully updated. Regenerate planes that reference the given geometry entity IDs (ent.ent_idn). The IDs of the named planes to regenerate. (Optional) If non-null, the geometry map, otherwise it will make one (i.e. expensive). A set of plane IDs successfully regenerated. Regenerate planes. The IDs of the named planes to regenerate. true = also regenerate any dependents. true = save the matrix and origin. [in,out] If non-null, the geometry map, otherwise it will make one (expensive). (Optional) false = Doesn't generate warning message for bad planes. A set of plane IDs successfully regenerated. Gets plane description. The plane. (Optional) The relative to wcs. The plane description. get the plane with the given ID's description. ID of plane to get. display accuracy for origin coordinates. (Optional) ID if origin to get. (Optional) type of origin description (-1=origin in view coords, 0=no origin, 1=origin in world coords) (Optional) make description relative to pRelativeToWcs. return Plane description. Gets a plane name. Identifier for the plane. Plane name format. True to add new line characters between the linked plane names if there are any. The plane name. Values that represent the plane name format returned by GetPlaneName(). get the active coordinate display description. (Optional) CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD. return description. return a copy of plane with the given name relative to the active WCS (WCS is subtracted) Name of the Plane to subtract the WCS from. return copy of the plane relative to the active WCS. return a copy of plane with the given ID relative to the active WCS (WCS is subtracted) ID of the Plane to subtract the WCS from. return copy of the plane relative to the active WCS. return a copy of the given plane relative to the active WCS (WCS is subtracted) the Plane to subtract the WCS from. return copy of the plane relative to the active WCS. Return true if active Plane is a reserved Plane. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) Return true if active Plane is a reserved Plane. Return true if active origin is from a reserved Plane. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) Return true if active origin is from a reserved Plane. Return true if active origin is on (other than 0,0,0) the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) return true if origin for plane type is something other than X0 Y0 Z0. Return true if active origin is on (other than 0,0,0) the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to fill in with origin info. (Optional) tolerance to determine if on, else uses P3DS.GetTol () (Optional) scale factor to determine if on, else uses 1.0. return true if origin for plane type is something other than X0 Y0 Z0. Return true if active origin is on (other than 0,0,0) the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) P3DS to fill in with origin info. (Optional) tolerance to determine if on, else uses P3DS.GetTol () (Optional) scale factor to determine if on, else uses 1.0. return true if origin for plane type is something other than X0 Y0 Z0. Get the plane name of an active plane. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) return plane name. Get copy of the 3x3 matrix used in active plane. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) return copy of the 3x3 matrix used in active plane. Get copy of point in p_3d format in world coordinates used in active origin. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to fill in. (Optional) return in world coordinates relative to the active WCS. return true if successful. get copy of active origin in world coordinates relative to the active WCS. The active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) (Optional) true = return in world coordinates relative to the active WCS, false = in world coordinates. (Optional) true = return GPLANE origin, false = return (0., 0., 0.) for GPLANE. return a copy of the active system origin. get copy of active origin in world or view coordinates. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to fill in. (Optional) the view # the coordinates should be in, -1 for whichPlane's view #. return true if successful. get copy of active origin in view coordinates. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) (Optional) the view # the coordinates should be in, -1 for whichPlane's view #. return copy of active origin in world or view coordinates. subtract the active origin from the given p_3d. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to subtract the origin from. p_3d to output new values to. the view # the coordinates should be in, -1 for whichPlane's view #. subtract the active origin from the given p_3d. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to subtract the origin from. Replaced with result the view # the coordinates should be in, -1 for whichPlane's view #. subtract the active origin from the given p_3d. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to subtract the origin from. (Optional) p_3d to output new values to; if nullptr, output to pIN. (Optional) the view # the coordinates should be in, -1 for whichPlane's view #. add the active origin to the given p_3d. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to add the origin to. p_3d to output new values to. the view # the coordinates should be in, -1 for whichPlane's view #. add the active origin to the given p_3d. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to add the origin to. Replaced with result. the view # the coordinates should be in, -1 for whichPlane's view #. add the active origin to the given p_3d. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to add the origin to. (Optional) p_3d to output new values to; if nullptr, output to pIN. (Optional) the view # the coordinates should be in, -1 for whichPlane's view #. subtract the active origin from the given p_3d. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to subtract the origin from. p_3d to output new values to. subtract the active origin from the given p_3d. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to subtract the origin from. Replaced with result. subtract the active origin from the given p_3d. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to subtract the origin from. (Optional) p_3d to output new values to; if nullptr, output to pIN. add the active origin to the given p_3d. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to add the origin to. p_3d to output new values to. add the active origin to the given p_3d. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to add the origin to. Replaced with result. add the active origin to the given p_3d. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) p_3d to add the origin to. (Optional) p_3d to output new values to; if nullptr, output to pIN. Get ID of Plane used in active origin. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) ID Plane used in active origin. Get pointer to Plane used in active origin. the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE) pointer to Plane used in active origin. return true if the active Plane's origin is locked. the active plane to check (CPLANE, TPLANE, GPLANE, WCSPLANE) (Optional) true = display locked warning. return true if the active Plane's origin is locked. return true if the active Plane's matrix is locked. the active plane to check (CPLANE, TPLANE, GPLANE, WCSPLANE) (Optional) true = display locked warning. return true if the active Plane's matrix is locked. Unlock the WPLANE, TPLANE, CPLANE or GPLANE matrix. the active origin to set (CPLANE, TPLANE, GPLANE, WCSPLANE) return true if successful. Lock the WPLANE, TPLANE, CPLANE or GPLANE matrix. the active origin to set (CPLANE, TPLANE, GPLANE, WCSPLANE) return true if successful. Unlock the WPLANE, TPLANE or CPLANE origin. the active origin to set (CPLANE, TPLANE, WCSPLANE) return true if successful. Lock the WPLANE, TPLANE or CPLANE origin. the active origin to set (CPLANE, TPLANE, WCSPLANE) return true if successful. Set the given active plane and/or origin's lock state. the active Plane type to set (CPLANE, TPLANE, WCSPLANE or GPLANE) -1 to unlock, 1 to lock, 0 to skip. -1 to unlock, 1 to lock, 0 to skip. return true if successful. Get the given active plane and/or origin's lock state. the active Plane type to set (CPLANE, TPLANE, WCSPLANE or GPLANE) returns the lock state (SystemPlanes::LOCK_ORIGIN_ON, etc) Removes the a plane from the map without any usage check. Identifier for the plane. Returns true if succesfully removed. Used only in SaveRestoreActivePlanes::Restore() Set the previous active plane. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) The point. Set the previous active plane. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) The third m 3. Check the active plane assignments. Create planes if necessary. True to create new and add new supporting matrices. # of planes added. Checks if given planeID is the Quick Cplane ID since the Quick Cplane cannot be used as the Tplane or WCS in active planes or assigned to toolpath operations. If it is, a plane with a matching matrix/origin will be searched for but if not found a new plane will be created with the same matrix/origin as the Quick Cplane. Identifier for the plane (or a newly created one). Pointer to the plane at planeID. Removes the Quick Cplane. Sets the value of m_QuickCplaneID. Identifier for the plane. Previous value of m_QuickCplaneID. Gets the value of m_QuickCplaneID. the value of m_QuickCplaneID. Sets m_ActivePlanes.m_NotifyUserApp to send messages when active matrix or origin changes. true to notify, false to not. Previous value of m_ActivePlanes.m_NotifyUserApp. Select a Plane gnomon from the graphics screen. (Optional) CWnd * to a window to hide and then restore. (Optional) the planes to select from (all, (the default) displayed, or selected) Plane ID of selected icon. Values that represent the planes to select a plane from. Choices are all planes, planes currently selected in the planes manager, or planes with their 'display' property set. Query if 'name' is status bar plane label found in m_StatusBarPlaneLabels. The name. true if status bar plane label, false if not. Return true if we're spinning the gview. m_CurrentDB must == true. true if gview spinning, false if not. Get constant ptr to active plane. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) constant ptr to active plane. return view # of previously active plane type. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) return view # of previously active plane. Set the previous active plane. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) The plane to set. (Optional) pointer to graphics viewport info. Get copy of the previously active origin. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) copy of the previously active origin. Get copy of the previously active matrix. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) copy of the previously active matrix. Get the previous active plane. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) graphics viewport info. copy of the previously active Plane. Get copy of the previously active matrix and origin. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) copy of the previously active Plane. return the depth of the given point relative to the requested active plane origin. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) The point. the depth of the given point in the active plane relative to the active origin. Get the ID of the active plane. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) the ID of the active plane. Gets active plane name. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) make matrix and origin relative to the active WCS, search for matching plane and return "UNDEFINED" if no match found. The active plane name or the matching one if relativeToWcs == true. return a copy of the active system Plane. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) (Optional) make matrix and origin relative to the active WCS. return a copy of the active system Plane. Get the active view number per system plane type. which system plane you want (CPLANE, TPLANE, GPLANE, WCSPLANE) which unit vector (X, Y or Z) the active unit vector per system plane type. Get the active view number per system plane type. which system plane you want (CPLANE, TPLANE, GPLANE, WCSPLANE) the active view number per system plane type. Set active system planes object with another. another SystemPlanes to set this active to. Get a copy of the system plans object. copy of the system plans object. set active Plane and origin from given plane. the active Plane type (CPLANE, TPLANE, GPLANE, WCSPLANE) Plane to set the active plane to. return Plane ID set (>0 = valid Plane ID, 0 = unnamed plane, -1 = error) set active Plane and origin from plane ID. the active Plane type (CPLANE, TPLANE, GPLANE, WCSPLANE) valid Plane ID to set the active plane to. return Plane ID set (>0 = valid Plane ID, 0 = unnamed plane, -1 = error) set active Plane and origin with matrix and current active origin. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) 3x3 matrix to set. return Plane ID set (>0 = valid Plane ID, 0 = unnamed plane, -1 = error) set active Plane with reserved plane ID and origin mode. the active Plane type (CPLANE, TPLANE, GPLANE, WCSPLANE) valid reserved plane type to set the active plane to. return Plane ID set (>0 = valid Plane ID, 0 = unnamed plane, -1 = error) set active Plane with matrix and origin with point. the Plane type (CPLANE, TPLANE, WCSPLANE, GPLANE) 3x3 matrix to set. origin point in world coordinates to set. return Plane ID set (>0 = valid Plane ID, 0 = unnamed plane, -1 = error) set active Plane to another active plane. which active plane to set (CPLANE, TPLANE, GPLANE or WCSPLANE) which active plane to set from (CPLANE, TPLANE, GPLANE or WCSPLANE) return plane ID used to set system plane. set active Plane with a group's group_view. which active plane to set (CPLANE, TPLANE or WCSPLANE) the group view containing the assigned Plane info. (Optional) Plane ID or matrix/origin pair has priority. return plane ID used to set system plane. set active Plane with a toolpath operation's op_view. which active plane to set (CPLANE, TPLANE or WCSPLANE) the operation view containing the assigned Plane info. (Optional) Plane ID or matrix/origin pair has priority. return plane ID used to set system plane. set 3 active Planes with a toolpath operation (CPLANE, TPLANE and WCSPLANE. toolpath operation that contains WCS, tplane & cplane. (Optional) Plane ID or matrix/origin pair has priority. return # of system planes set. check if a plane is active in any of the 4 system planes (CPLANE, TPLANE, GPLANE or WCSPLANE) the ID of the plane to check. list of plane types where the given plane ID is active. check if a plane is active as a view or origin. the ID of the plane to check. the active plane type to check (CPLANE, TPLANE, GPLANE or WCSPLANE) return true if active. set all active views and origins to TOP if none are set. repaint the active plane info on the status bar. return true if successful. return viewport # (0-3) from graphic ptr. graphics ptr. return viewport # (0-3) ptr references, -1 if not found. Returns a list of strings describing the plane compare masks (PLANES_COMPARE_CHANGED, etc). The plane that we changed. The long value to test. Strings describing the plane compare masks. Convert a UsageStringArray to a CStringArray, write to file and display in editor. The string array to write and display. True to edit file. A CString with the output file name. Fix separator strings in usage strings. The array that contains separator strings. The separator string that replace the separator markers. Builds a string array of matrix usage. Matrix IDs to collect. The string array to fill in. The separator character to fill a string with between each view description. The size of strArray. Gets the entity description. The entity to build a description of. (Optional) The file position of the entity, -1 to exclude from description. (Optional) The entity size, -1 to exclude from description. The entity description. Gets the bare entity description without appending ent idn information. The entity to build a description of. The entity description. Removes an unused system matrix by its ID. Identifier for the matrix. (Optional) The matrix map. True if it succeeds, false if it fails. Removes all unused system matrices. std::set of the system matrix IDs removed. Removes all unused Named Cnc::Globals::Planes::GetPlanes (). std::set of the named Plane IDs removed. Defines an alias representing the matrix map. Builds m_MatrixMap. Reference to a MastercamPlanes object. True = just the used matrices, false = all matrices. reference to m_Map. Constructor for usage info. Matrix and/or view number usage source. (Optional) Identifier for the entity (ent.ent_idn). (Optional) The ent's database pointer. (Optional) Number of bytes to the view number data. (Optional) The number of bytes for the view number data (short = 2, long = 4). Values that represent matrix and/or view number usage sources. Class that containts information about instances of PlaneClass::SystemMatrix usage. Class to determine PlaneClass::SystemMatrix usage in a MastercamPlanes object. Gets time of day string. The time of day string. Copy reserved plane IDs from planeIDs that are incompatible with the current file. (example: reserved lathes planes that are in a file with only a mill machine group). (Optional) The plane IDs to check, nullptr to check all plane IDs. The incompatible product plane i ds. Builds set of operation info that reference plane ID's. The plane IDs to search for. Exclude these operation IDs from processing. (Optional) maximum # of ID's to collect, 0 to collect all IDs. (Optional) Shared ptr to an OpBnciMap. size of planeUsage. Builds set of group info that reference plane ID's. The plane IDs to search for. (Optional) the maximum size of planeUsage. std::set of PlaneUsageInfo. Check named planes marked as temporary for usage. If they're used, update planes if fixThem == true. True to set the plane's temporary flag to false (and make them permanent). The usage map, nullptr = read usage. A list of named plane ID's marked as temporary but are used. Detect if named planes with the given IDs are used somewhere other than in the operation with the given ID. List of identifiers for the planes. Exclude these operation IDs from processing. (Optional) If non-null, the plane usage strings. (Optional) Shared ptr to an OpBnciMap. List of plane IDs that are used somewhere other than in the operation. Get usage mask if plane is used and cannot be deleted. ID of plane to remove. (Optional) ignore this usage from results. (Optional) exclude this operation from the search. (Optional) snapshot of Mastercam file to limit to only 1 pass thru the db. (Optional) Maximum # of groups or operationss to check, 0 = check all. return usage mask if Plane is being used, PLANE_USED_NONE if not used. Get usage mask if Plane is active or used in an operation or group. ID of plane to remove. set of usage info for each ID in planeIDs. (Optional) ignore this usage from results. (Optional) Identifier for the exclude this operation. (Optional) snapshot of Mastercam file to limit to only 1 pass thru the db. (Optional) Maximum # of groups or operationss to check, 0 = check all. return usage mask if Plane is being used, PLANE_USED_NONE if not used. determine if a given Plane is used in solid operations. the Plane's ID. [in,out] the solid eptrs that are using the plane. (Optional) Maximum # of solids to check, 0 = check all. return usage mask if Plane is being used, PLANE_USED_NONE if not used. determine if a given Plane is used in drafting. the Plane's ID. [in,out] the solid eptrs that are using the plane. (Optional) Maximum # of drafting entities to check, 0 = check all. return usage mask if Plane is being used, PLANE_USED_NONE if not used. Build map of plane info used in view sheets. The map. determine if a given Plane is used in any viewsheet. the Plane's ID. set of usage info for each ID in planeIDs. CString array to fill in with viewsheet names if used. return usage mask if Plane is being used, PLANE_USED_NONE if not used. determine if a given Plane is used in any operation. the Plane's ID. exclude this operation from the search. set of usage info for each ID in planeIDs. current Mastercam file info. (Optional) Maximum # of operations to check, 0 = check all operations. return usage mask if Plane is being used, PLANE_USED_NONE if not used. determine if a given Plane is used in any operation group. the Plane's ID. set of usage info for each ID in planeIDs. (Optional) Maximum # of groups to check, 0 = check all groups. return usage mask if Plane is being used, PLANE_USED_NONE if not used. determine if a given Plane is used in any active system plane (WCS, Cplane, Tplane or WCS) the Plane's ID. return usage mask if Plane is being used, PLANE_USED_NONE if not used. Swap an old plane ID with a new ID in all info in memory and entities in the database (except the plane itself) that have plane IDs embedded in them. Old plane ID. New plane ID. Create/display planes report for the planes with the given IDs. The ID's of the plane(s) to report on, empty for all. True to display report in default text editor. A CString representing the temporary output file the report was written to. return true if Planes are active or used in any way. array of Plane IDs to report about. (Optional) Ignore this usage from results. (Optional) Shared ptr to an OpBnciMap. (Optional) ptr to string array to get usage info strings. (Optional) 1=show message box if used, 2=show message always, 0=don't show message box. (Optional) pointer to parent window. A map of plane usage <long, long> (plane ID, usage mask). Get plane usage masks. ID of single Plane to report about. (Optional) ignore this usage from results. (Optional) Shared ptr to an OpBnciMap. (Optional) ptr to string array to get usage info strings. (Optional) 1=show message box if used, 2=show message always, 0=don't show message box. (Optional) pointer to parent window. return plane usage masks. Create a plane usage text file. True to display the file in your default editor. (Optional) Ignore this usage from results. Full path of file name created if successfull, empty string if failure. Defines an alias representing a std::set of PlaneUsageInfo types. Extracts the operation or group IDs from the usage set. Identifier for the plane. Set of the PlaneUsageInfo. Set of opereration or group IDs. Appends more info to m_Info. The information to append. The index of the first appended element. Gets a set if operation or group IDs. (Optional) Type of the identifier to match. set of InfoID's. Gets the usage for the plane at m_ID. Identifier to match. The usage. Less-than comparison operator. The object. true if the first parameter is less than the second. Constructor. Identifier for the plane. Type of the usage. Values that represent whether the contents of m_IDsAndMasks are opertion or group ID's. Constructor. Identifier for the operation or group. The usage mask. If non-null a pointer to the long data. The offset address of where the data resides in the structure. Constructor. Identifier for the operation or group. The usage mask. If non-null a pointer to the short data. The offset address of where the data resides in the structure. Equality operator. The object. True if the parameters are considered equivalent. Copy constructor. The object. Constructor. (Optional) The ID type. (Optional) Identifier for the operation or group. Values that represent the information ID types. The info identifier. Class respresenting individual plane usage data. Gets the value pointed to by m_Pointer. A long value pointed to by m_Pointer. Sets the value pointed to by m_Pointer. The new value. true if it succeeds, false if it fails. Returns the size of the data at m_Pointer. sizeof long or short data type pointed to by m_Pointer, 0 for error. Constructor for long pointer type. If non-null, pointer to the long value. Constructor for short pointer type. If non-null, pointer to the short value. Values that represent what type of pointer m_Pointer really is. Plane ID's are long data types (for now), but there are many places in old code where they're stored as a short. This class exists for that puprpose. Values that represent PLANE_USAGE_MESSAGE_BOX parameter in PlaneUsage (). Get a pointer to a system matrix by matching a matrix in the m_FindMatrixCache. The matrix to match. System matrix pointer and tolerance used, null ptr if not found in m_Planes. Searches for the first parallel. The plane class (NamedPlane or SystemMatrix). 3x3 matrix to match. True to find view with same vector direction. (Optional) The match tolerance. ID of the fisrt matching parallel NamedPlane or SystemView. Creates and returns an OpBnciMap using the operation IDs and bnci gcodes contained in spInFile. Pointer to an IInterrogateMastercamFile. An OpBciMap needed for planes. Builds and returns an OpBciMap needed for planes by using the global bnci cache. The gcode mask for planes info. An OpBciMap needed for planes. Compares the contents of the two MastercamPlanes classes, merges our planes into the target if requested, returns a list of ComparisonData. The object to compare to / merge into. (Optional) Source IDs of planes to merge, empty set to add all, nullopt to just compare. A list of comparison data. MastercamPlanes comparison data for the Compare() function below. Builds and returns an OpBciMap needed for planes. An OpBciMap needed for planes. Gets the gcode mask needed to load the correct NCI lines for planes for use with CInterrogateMastercamFile . The gcode mask. Make and return a pointer to a TemporaryStart class. This will set us into "mark all new planes as temporary" mode. Temporary planes will be removed when this goes out of scope. The plane class (PlaneType::SystemMatrix and PlaneType::NamedPlane types only). A std::unique_ptr to a TemporaryStart class. Get update status bar flag value of m_UpdateStatusBar. Set update status bar flag true to update the status bar with planes info. previous value of m_DrawGnomon. Regenerate and return a Plane defined with associated geometry by its ID. ID of plane to regenerate and return. (Optional) true - regenerate even if clean. copy of regenerated Plane. Returns first ID that does not exist in the map (i.e. 1,2,4,5... would return a 3). The plane class (SystemMatrix or NamedPlane). The first ID that's not used in the middle of the range. get the next unique Plane ID. The plane class. [in,out] true = a gap in ID numbering was found and returned. return the next unique Plane ID. get the highest ID value in the array. The plane class. return the highest ID value in the array. Ensure the Plane name is unique. the Plane name. (Optional) exclude the plane with this ID from the search. Return true if name altered. Extract the MastercamPlanes class from an external Mastercam file. The Mastercam file name. unique_ptr to a MastercamPlanes class from its ClassEnt. Erase one or all planes. (Optional) IconDrawMode::Erase = -2, IconDrawMode::Native = -1, IconDrawMode::Given = 0 or valid planeID. Draw one or all planes. The color to draw the planes in (per IconDrawMode) IconDrawMode::Erase = -2, IconDrawMode::Native = -1, IconDrawMode::Given = 0 or valid planeID to highlight in BR_WHITE. (Optional) Plane ID to draw or 0 for all planes. Rip through the database and update ent.vw_refs on all geometry entities. # of entities updated in db. Build a set of geometry entities used in Planes and that have ent.vw_refs > 0. set of ent.ent_idn's to find. return vector of matching entities copied into the array. Scale origins on all planes in this. the scale factor. Return planes update code PlanesUpdated::Updated or PlanesUpdated::NotUpdated. Collect all the geometry IDs use in all the planes. Plane ID to match, 0 for all planes. return set of geometry IDs referenced by named planes. Collect all the plane IDs in that are marked dirty. set of Plane IDs. returns a set of PlaneID's that are marked as displayed planes. A set of PlaneID's that are marked as displayed planes. returns a set of PlaneID's that are marked as being used as sectionviews. A set of PlaneID's that are marked as being used as sectionviews. Gets a set of system matrix IDs. The system matrix IDs. Collect all plane IDs of a given class. The plane class (NamedPlane, SystemMatrix, etc.). True to include temporary planes, otherwise false. A set of PlaneIDs for the given class. Collect all the plane IDs in this. (Optional) True to include, false to exclude planes marked as temporary. return a vector named plane IDs contained in m_Planes. initialize view (s) in toolpath operation. the operation to init. (Optional) which operation view to inti (CPLANE, TPLANE, WCSPLANE or UNDEFPLANE for all 3. return true if successful. Return the view # from the operation view. the operation view to check. the view # from the operation view. return value of m_CurrentDB member variable. true if it succeeds, false if it fails. Set the m_CurrentDB member variable. value to set m_CurrentDB to. previous value of m_CurrentDB. get ID of last added Plane. ID of last added Plane. Get # of Planes of type PlaneClass. The plane class. (Optional) True to include, false to exclude planes marked as temporary. # of Cnc::Globals::Planes::GetPlanes (). create a Plane relative to an existing Plane. ID of Plane to copy/rotate. relative type (RelativeType::Front, etc) True to link to parent. (Optional) The coordinate display mode, DISPLAY_UNDEFINED_COORD to maintain source. pointer to new Plane. copy a single Plane by its ID. ID of Plane to copy. (Optional) The coordinate display mode, DISPLAY_UNDEFINED_COORD to maintain source. pointer to new Plane. Copies the system matrices from this into refPlanes filtering out duplicates. The target object. Number of system matrices added to refPlanes. copy multiple Planes by their IDs. [in,out] array of Plane IDs to copy. [in,out] array of newly created Plane IDs. (Optional) The coordinate display mode, DISPLAY_UNDEFINED_COORD to maintain source. Return planes update code PlanesUpdated::Updated or PlanesUpdated::NotUpdated. Clears the temporary plane state in matching planes described by planeClass. (Optional) the plane class. Return planes update code PlanesUpdated::Updated or PlanesUpdated::NotUpdated. remove all the Planes marked as temporary (m_Temporary == true) The plane class to match, Undefined will match all. Return set of plane IDs that were removed. remove all the Planes, rebuild default Cnc::Globals::Planes::GetPlanes (). Return planes update code PlanesUpdated::Updated or PlanesUpdated::NotUpdated. remove multiple Planes by their IDs. array of Plane IDs to remove. true = update the ent.vw_refs in geometry entities in the db. (Optional) If non-null, a usage map, else the function will make it's own (expensive) Return set of plane IDs that were removed. Searches for the first view whose k vector is orthogonal to the given vector. the z component to match. [in,out] The view no. true to favor view no. true = use first matching matrix found, false = use best match. The match tolerance. return const ptr to existing plane if successful, nullptr on error. Find or add a base Plane definition with the given matrix. the Z component to match. true = use first matching matrix found, false = use best match. True to find view with same vector direction. true to add new base plane if an existing matrix not found. True to accept closest match within default PLANE_TOL. The match tolerance. return const ptr to existing plane if successful, nullptr on error. Find or add a base Plane definition with the given matrix. the matrix to add. return const ptr to existing plane if successful, nullptr on error. Find or add a base Plane definition with the given matrix. the matrix to add. True to create new if an existing not found. return const ptr to existing plane if successful, nullptr on error. Gets a ptr to a SystemMatrix by its ID. The SystemMatrix ID. Pointer to the SystemMatrix, nullptr if it does not exist. Searches for the first closest matching named plane with parameter priorities. The matching matrix to match - you have to at least match this. The origin to match. The work offset to match. The coordinate display to match. [in,out] Value will be set to the parameters it did not match. null if it fails, else the closest matching plane. Collect pointers to all the planes that pass the predicate function. The include mask function. List of plane pointers that match. return constant ptr to a named Plane by its name. a valid Plane name. (Optional) true = ignore case. (Optional) True to include, false to exclude planes marked as temporary. (Optional) Exclude the plane with this ID from the search. return constant ptr to a named Plane. Return const pointer to first plane that matches coordinate display mode, matrix and optional origin. The coordinate display mode. 3x3 matrix to match. origin in world coordinates. (Optional) which active system plane we intend to use the match for (CPLANE, TPLANE, etc) or UNDEFPLANE to ignore. null if it fails, else the found plane pointer. Return const pointer to first named plane that matches given matrix. 3x3 matrix to match. Return const pointer to first named plane that matches given matrix. Return const pointer to first plane that matches given matrix, origin and work offset. 3x3 matrix to match. Origin in world coordinates to match. The work offset to match. Return const pointer to first named plane that matches given matrix, origin and work offset. Return const pointer to first plane that matches given matrix and origin. 3x3 matrix to match. Origin in world coordinates to match. Return const pointer to first named plane that matches given matrix and origin. Find for the first matching NamedPlane or SystemMatrix. The plane class (NamedPlane or SystemMatrix). The matrix to match. true = create new if no match found. The plane ID of the matching plane. Searches for the first parallel system matrix. 3x3 matrix to match. true = find plane with same Z vector direction. The match tolerance. Return const pointer to first system matrix that is parallel to the given matrix. Searches for the first parallel named plane. 3x3 matrix to match. true = find plane with same Z vector direction. The match tolerance. Return const pointer to first named plane that is parallel to the given matrix. Find for the first matching NamedPlane or SystemMatrix, add a new one if none found. The search parameters. (Optional) Maximum number of matches. Pairs of PlaneID's and the matrix match tolerances of matching SystemMatrix or NamedPlane types. Return iterator to the first instance of a class of Plane (NamedPlane or SystemMatrix). The plane class (NamedPlane or SystemMatrix). (Optional) True to include, false to exclude planes marked as temporary. const_iterator to the first instance found in m_Planes. Return iterator plane ID in m_Planes Identifier for the plane. A PlaneMap::const_iterator. Equality operator. The search parameters. True if the search parameters are considered equivalent. Copy constructor. The search parameters. Constructor. The plane class (NamedPlane or SystemMatrix). (Optional) Pointer to plane's matrix. (Optional) Pointer to plane's origin in world coordinates. (Optional) Pointer to coordinate display mode. (Optional) Pointer to parallel mask. (Optional) Pointer to plane type (CPLANE, TPLANE, GPLANE or WCS). (Optional) If non-null, (Optional) the work offset. (Optional) Pointer to pair of Plane name to match, true = ignore case. (Optional) If non-null, the axis that is aligned. (Optional) The match tolerance. Class containing parameters for find functions. Parallellism matrix masks for find functions. Add "added plane" message to event log. The plane we added. add a base Plane definition by matrix. the Plane to add. (Optional) The requested view number. If already taken, a new unique view # will be assigned. 0 = assign next highest. first = pointer to system matrix, nullptr if error, second = true if added, false if already exists. add up to 2 SYstemMatrix definitions, one for the PlaneBase::m_33 and one for PlaneBase::m_33 * Plane::m_Transform. [in,out] the Named Plane containing Matrix33's to add. return pair of system matrix pointers to system matrices. add a base Plane definition. [in,out] the Plane to add. first = pointer to system matrix, nullptr if error, second = true if added, false if already exists. add a Plane definition. [in,out] the Plane to add. (Optional) true to update plane manager. return pointer to named plane, nullptr if error. update an existing Plane definition. the Plane to update. (Optional) if !nullptr, mark all dependent toolpath operations dirty. (Optional) check locked state, if locked do not allow editing. Return planes update code PlanesUpdated::Updated or PlanesUpdated::NotUpdated. unlock the named Plane (edits allowed) with this ID. Identifier for the plane. Return planes update code PlanesUpdated::Updated if successfully unlocked or PlanesUpdated::NotUpdated. lock the named Plane (no edits allowed) with this ID. Identifier for the plane. Return planes update code PlanesUpdated::Updated if successfully locked or PlanesUpdated::NotUpdated. lookup plane by its name, return its ID. the plane name. return Plane ID using name, 0 if not found. Gets const ptr to the commonly used top plane. nullptr if it fails (which it never should). return constant ptr to a Plane. the Plane ID. return constant ptr to a PlaneBase. return constant ptr to a Plane. the reserved plane type. return constant ptr to a Plane. return constant ptr to a named Plane. the Plane ID. return constant ptr to a named Plane. select a new origin for a Plane used in an op_view. The toolpath operation that contains the op_view. which op_view to select a new origin for (CPLANE, TPLANE or WCSPLANE) The Mastercam plane selected to use for the op_view. look for a matching plane. Add plane to this if it needs to be created. (Optional) Parent window for dialog. (Optional) snapshot of Mastercam file to limit to only 1 pass thru the db. return true if origin selected and everything is okay. go thru all the planes, set matching entity ID's to 0. array of ID's to match and remove. (Optional) ptr to snapshot of current Mastercam file to limit to only 1 pass thru the db. If nullptr, system will have to read thru the db for each plane. Return planes update code. go thru all the planes, swap new geometry entity ID for old. the old entity ID to match. the new entity ID to replace the old ID with. (Optional) ptr to snapshot of current Mastercam file to limit to only 1 pass thru the db. If nullptr, system will have to read thru the db for each plane. Return planes update code. return appropriate coordinate display plane mask for the active coordinate display value. The coordinate display mask. return coordinate display value (CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD) The coordinate display. Set the plane's coordinate display mode. CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD. Update coordinate mode in graphics area. return previous value, -1 if invalid coordinateDisplay. Validate the coordinate display mode (check for parallel X&Y with active WCS for lathe modes) CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD. return true if valid. make sure it's a valid view number. the long integer representation of a plane ID. (Optional) true to display warning. return true if valid. Update the viewsheet's plane ID's and matrices. (Optional) UNDEFPLANE = all or CPLANE, TPLANE, GPLANE or WCSPLANE. (Optional) The viewsheet #, -1 for the current. Values that represent how a plane was appended. Copy MastercamPlanes object to this. MastercamPlanes object to copy. return this. Addition assignment operator. The object. The result of the operation. equality operator. MastercamPlanes object to compare. return true if equal. Inequality operator. Compare only the planes, not any other member variables MastercamPlanes object to compare. return true if not equal. assignment operator for use with MastercamPlanes. The object. A shallow copy of this object. assignment operator for use with PlaneMap. the map. A shallow copy of this object. copy constructor. The object. serialize this. the destination/source archive object. Zero out member variables. (Optional) the current database. Return the entity type (for ClassEnt) Return the entity type. destructor. Default constructor. (Optional) the current database. Removes the temporary planes from m_RefPlanes. True to disable delete on destruction, false to enable. Update code. Disables the deletion of temporary planes in the destructor. true to disable, false to enable. previous value of m_DisableDelete. Destructor. Constructor. The referenced MastercamPlanes object. (Optional) the plane class. TemporaryStart class used when to temporarily change the referenced MastercamPlanes object's m_Temporary value so it will mark all planes created/added as temporary from instantiation on. All temporary planes will be cleaned out upon destruction. Gets the value of m_BnciRestored. the value of m_BnciRestored. Gets the database state description for debug. The description. Gets the value of m_State. the value of m_State. Return true if the db is currently loading a file. (Optional) If non-null, a pointer to the global in_file_get to also check. true if the db is currently loading a file. Return true if the db is in a state where reading or writing to the binary NCI is safe. true if we can read/write nci, false is not. Assignment operator. The object. A shallow copy of this object. Constructor. (Optional) state of the database, 0=ready, 1=start up, 2=building view map, 3=reading file (Optional) true if the binary nci is fully restored. The current database state if m_CurrentDB == true. if m_CurrentDB == true, the current state of your db. Let our friends have their way with us. PlanesFollowRules enforces the 'Cplane follows Gview' type rules. Clears this object to its blank/initial state. Collect all nci-nodes that have matrices/origins different from the assigned plane. This occurs with lathe and rotary axis operations. Assign the work offset value based on parameter settings in m_BuildPrm. The node to assign a work offset value to. Check build parameters include/exclude mask for the given operation ID when building m_Map. Operation ID to check. Return true if operation should be skipped. Check for matching work offset value in m_Map whose matrix and origin do not match the given one. Work offset node to compare. Return true if conflict. Return copy of matching work offset from m_Map that's already in use. Work offset value to match. Matrix33 to match. Origin in world coordinates to match. Return copy of matching work offset which contains source info. Return return work offset numbering mode from nesting parameters. Reference to a mode value. May be corrected/updated. True - match existing workoffset matrix/origins. return mode. Add node to m_Map (check for duplicate matrices) The node to add. Return true if added, false if not added (or duplicate found) Copies all nodes from m_AllNodes that match work offset #, matrix and origin in world coordinates. true to test for matching work offset to matchOnWorkOffsetNo, false = change all in woffArray. The work offset # to match. The matrix to match. The origin in world coordinates to match. Vector to fill inwith matching work offset nodes. Size of woffArray. Gets const reference to m_AllNodes. const reference to m_AllNodes. Gets const reference to m_Map. const reference to m_Map. Return const reference to array of NCI gcodes related to work offset calculations. The gcode mask. return const reference to m_BuildPrm. const reference to m_BuildPrm. Number any undefined work offsets in the map per the numbering rules in buildPrm. Return number of workoffset values updated. Dump the contents of m_Map. size of the map. Return size of the map. size of the map. Create and add work offset nodes to m_Map from the given NCI lines (1013, 1014, 1016 and 1027) Reference to a CBnciReadWrite containing the required NCI lines. Reference to the NCI's owner operation. (Optional) Ptr to an array to save the newly added nodes since m_Map inserts them unordered. (Optional) ID of NCI's owner machine group (0 to detect from theOp) Return # of work offset nodes added. Create and add work offset nodes to m_Map from the given operations. Reference to array of operations. (Optional) the planes. Return # of work offset nodes added. Create and add work offset nodes to m_Map from the given planes. Reference to MastercamPlanes object. Return # of work offset nodes added. Set the build parameters. What to build and numbering rules. Build the array of work offset nodes from an operation array, planes array and binary NCI file. What to build and numbering rules. an array of toolpath operations. a MastercamPlanes object. a file ptr to an open binary NCI file. Returns size of map. Build the array of work offset nodes from a CInterrogateMastercam object. What to build and numbering rules. reference to a CInterrogateMastercam. Returns size of map. Toolpath operation IDs to exclude from work offset match. Array of operation IDs. Returns size of m_OpIDsExcludeMatching mask. Toolpath operation IDs to exclude. Array of operation IDs. Returns size of m_OpIDsExclude mask. Toolpath operation IDs to include (exclusive) Array of operation IDs. Returns size of m_OpIDsInclude mask. Copy operator. The object. A shallow copy of this object. Default constructor. (Optional) UseNciCache::Yes to use NCI cache, :No = read from disk. (Optional) (SourcePlanes | SourceOperations | SourceNci) (Optional) true - add workoffsets with a -1 value (undefined) to the map. (Optional) true - number any undefined work offsets. (Optional) When numbering undefined work offsets, first match existing. (Optional) allow conflicting work offsets to be added to the map. (Optional) Starting work offset value. (Optional) Amount to increment work offset when numbering. (Optional) Debug - dump map to a dialog and display. Work offset value matching mode. work offset source flags. Where to look for work offsets and numbering rules for BuildWorkOffsetMap() Return return work offset numbering mode from nesting parameters. operation nesting parameters. return mode. Return return work offset numbering mode from transform parameters. operation transform parameters. return mode. return first work offset node in map if work offset value is already being used somewhere with a different matrix and origin. work offset value to match. the 3x3 matrix to match. the origin point to match. (Optional) do not check the operation with this ID. return copy of the matching work offset node. return work offset node that matches given work offset value, matrix and origin. work offset value to match. the 3x3 matrix to match. the origin point to match. an operation array to look thru. a Planes array to look thru. an open Mastercam file ptr to look thru. (Optional) do not check the operation with this ID. return copy of the matching work offset node. Build map and get the work offset assignment at a binary NCI file position. binary NCI file position of a 1016 line. work offset node to copy matching node into. return true if node found and successful. Return the assigned work offset number that matched a 3x3 martix and origin point. m_Map must have already been built via BuildWorkOffsetMap() the 3x3 matrix to match. the origin point to match. array to fill in with matches. (Optional) the machine group ID to match, 0 for all. return size of nodeArray. Collect all the existing work offset assignments for the given work offset # from m_AllNodes. work offset value to match. array to copy work offset nodes into. return # of work offset nodes collected into array. Collect all the existing work offset assignments for the given work offset # from m_Map. work offset value to match. Machine group ID to match, 0 for all. array to copy work offset nodes into. return # of work offset nodes collected into array. Build map and collect all the existing work offset assignments for the given work offset #. work offset value to match. Machine group ID to match, 0 for all. operation array to search for work offset values. MastercamPlanes object to search for work offset values. file pointer to open Mastercam binary NCI file to search for work offset values. array to copy work offset nodes into. (Optional) do not check the operation with this ID. return # of work offset nodes collected into array. Calculate the next work offset # m_Map must have already been built via BuildWorkOffsetMap() Machine group ID to match, 0 for all. start work offset value. value to increment work offset. next available work offset value. Build map and calculate the next work offset #. Machine group ID to match, 0 for all. start work offset value. value to increment work offset. operation array to search for work offset values. MastercamPlanes object to search for work offset values. file pointer to open Mastercam binary NCI file to search for work offset values. (Optional) do not check the operation with this ID. next available work offset value. Return the assigned work offset number that matched a 3x3 martix and origin point. m_Map must have already been built via BuildWorkOffsetMap() the 3x3 matrix to match. the origin point to match. only match on work offset values that were not assigned before being added to the map. return the work offset value assigned to the match even if it conflict with others in the map. the machine group ID to match. return the matching work offset #. Build map and return the assigned work offset number that matched a 3x3 martix and origin point. the 3x3 matrix to match. the origin point to match. an operation array to look thru. a Planes array to look thru. an open Mastercam file ptr to look thru. only match on work offset values that were not assigned before being added to the map. return the work offset value assigned to the match even if it conflict with others in the map. do not check the operation with this ID. return the matching work offset #. Gets const reference to m_OpIDsUpdated. const reference to m_OpIDsUpdated. Updates the operation's Tplane, WCS and Cplane work offset values. true to just query (just collect the affected operation IDs, don't actually update the db). true to test for matching old work offset no, false = change all in woffArray. the operation to update. The old woff number. The new woff number. Matrix33 to match. Origin in world coordinates to match. identifier for the plane, if (planeID > 0) op_view.m_PlaneID must match before work offset is updated. true - also update any dependent operations of the given operation. true to show tree control of edited operation. OperationUpdated mask if the operation's Tplane was updated. collect an array of all toolpath operations from the current db. return vector of operations. Change a plane's work offset. true to just query (just collect the affected operation IDs, don't actually update the db). true to test for matching old work offset no, false = change all in woffArray. Identifier for the plane. The old woff no. The new woff number. ptr to parent window to prompt user to proceed, nullptr = no prompt. true to show tree control of edited operation. return the number of substitutions that occured. update a work offset value in a MastercamPlanes object, toolpath operation and binary nci file. true to just query (just collect the affected operation IDs, don't actually update the db). true to test for matching old work offset no, false = change all in woffArray. The old work offset value. The new work offset value. The 3x3 matrix to match. The origin in world coordinates to match. Array of work offset nodes to update. true to show tree control of edited operation. return the number of substitutions that occured. Shows the tree control of updated operations. The operation IDs to show. The old work offset #. The new woork offset #. The message, empty for default. Collect work offset usage, dump to editor. (Optional) Filename of the external file, empty for current db. Gets work offset usage info. (Optional) Filename of the external file, empty for current db. Map of work offset usage info. destructor. Defines an alias representing the pair to insert into the Map type. Defines an alias representing the map type. Constructor. (Optional) The MastercamPlanes reference. work offset assignment modes in transform toolpath operation parameters. Values that represent sources of work offset values. Work offset assignment info/usage. Work offset usage information. Allow NCIToIOF to access a private function. Defines an alias representing array of work offset info nodes. WorkOffsetUtil utility class to collect, calculate and assign work offset assignments from Planes, operations and NCI. You can never have too many friends. Return true if machine ID in m_Key is valid. true if m_Key.m_MachineGroupID is valid. Return true if node type requires a valid machine ID in its m_Key. Return true if node type requires a valid machine ID in its m_Key. return a description of the work offset node's contents. String array to fill in with description. The description. Default destructor. Default constructor. Less-than operator for map insertion. The object. true if this is less than obj. Not-equal comparison operator. The object. true if the parameters are not considered equivalent. Equality comparison operator. The object. true if the parameters are considered equivalent. Default constructor. (Optional) the woff no. (Optional) identifier for the machine group. Key for m_Map. MapKey::m_MachineGroupID must be valid for all node types except NodeType::Plane. How was the Work offset value assigned? Work offset source. WorkOffsetNode class defines single work offset instance harvested from either an operation, Plane or NCI line. Used in work offset detection and value calculations. forward declaration. Mastercam Planes class. Return array index of a valid previous move. The index start. The index limit. true to sos moves. The valid previous move. Initialises this object. Identifier for the operation. Gets nci product type from an operation. Identifier for the operation. NCI_MILL_TYPE, NCI_LATHE_TYPE or NCI_WIRE_TYPE. Converts and copies the contents of m_BnciLines into a CArray. [in,out] The array to copy the nci lines into. A set of nci line's gcodes to include, nullptr = all. return size of nciArray. Gets const reference to the vector that contains all the NCI. const reference to m_BnciLines. Copies the bnci line from bnci sptr into bnciLine. Shared ptr to the bnci line. Target bnci line structure. The number of bytes copied into bnciLine. Makes a nci pointer to the current size of the gcode type. The gcode line. (Optional) Type of the bnci 9NCI_MILL_TYPE, NCI_LATHE_TYPE, NCI_WIRE_TYPE). ptr to new bnci line. Makes a nci pointer and copies contents of bnciLine. The bnci line. ptr to copied line Test if a move is along the tool axis only. The index into m_BnciLines array. Will be set to true if move is a retract move. true if along vector move, false if not. Test if bnci line at index is an arc move. The index into m_BnciLines array. (Optional) If non-null, set to feed rate field. true if arc move, false if not. Test if bnci line at index is a Z move. The index into m_BnciLines array. Will be set to true if move is a retract move. true if zmove, false if not. Return gcode value if gcode == 1000, 1001 or 1002, 0 for no match. The gcode to test. The valid tool change gcode, 0 if not. Return true if array index is valid. The index. (Optional) true to display debug warning. true if array index is valid, false if it fails. Query if this object containst any NCI lines. True if empty, false if not. Empty contents of m_BnciLines array. # of elements removed. Move an element in the list from indexFrom to indexTo. Index where the line is to be moved from. Index where the line is to be moved to. Empty contents of m_BnciLines array. # of elements removed. like CArray::RemoveAt() The index. (Optional) number of elements to remove. Copy the array of bnci lines into m_BnciLines. The array to copy. Array of gcodes to copy. Array of gcodes to exclude. Size of m_BnciLines. Copy the array of bnci lines into m_BnciLines. The array to copy. Size of m_BnciLines. Append a line to the end of m_BnciLines. The bnci line to add. Array append location. Append a line to the end of m_BnciLines. The bnci line to add. Array append location. Append a line to the end of an array. The bnci line to append. The array to append it to. Array append location. Insert a line into the array. The array index. The bnci line. Array insert location. Removes the NCI lines between the NCI_IGNORE_START and NCI_IGNORE_END markers. Remaining size of m_BnciLines. Remove any gcode lines that are < 0 from the array (NCI_BIN_CTOUR_SECT, etc) (Optional) list of negative gcode lines to keep. Remaining size of m_BnciLines. Remove any matching gcode lines from the array. An array of gcodes to match. Remaining size of m_BnciLines. Update a bnci line in the array (must be same gcodes) The array index. If non-null, the ptr to bnci line to set. An INT_PTR. Update a bnci line in the array (must be same gcodes) The array index. The bnci line to set. array index if succf, -1 if error. Return a const bnci line ptr from the array. The index. null if it fails, else the constant pointer. Return a bnci line ptr from the array. The array index. a pointer to the bnci line in the array, nullptr on error. Inserts the start and end of section lines in the underlying array. True if it succeeds, false if it fails. Return the end-of-section bnci line for the section. The bnci line to fill in with eos. size of bnci line, 0 for error. Return the start-of-section bnci line for the section. The bnci line to fill in with sos. The size of bnci line, 0 for error. Get a bnci line from the array. The array index. The bnci line to fill in. return size of bnci line, 0 for error. Return a bnci line from the secified inden in the array. The array index. a copy of the bnci line from the array. Build an array of nci_bin pointers pointing to matching gcode lines in the member array m_BnciLines. Array of gcode to match. Array of bnci ptrs to fill in. Number of lines found. Build an array of nci_bin pointers pointing to matching gcode lines in the member array m_BnciLines. Array of gcode to match. Array of bnci ptrs to fill in. Number of lines found. Build an array of nci_bin pointers pointing to matching gcode lines in the member array m_BnciLines. gcode to match. Array of bnci ptrs to fill in. Number of lines found. Gather lines with matching gcodes from the array. The array of gcodes to match. The array to stuff nci lines into. (Optional) the start index of array, -1 for all. (Optional) the end index of array, -1 for all. (Optional) total # of matching gcode lines to look for, 0 for all. return # of matching gcode bnci lines. Gather lines with matching gcodes from the array. gcode to match. array to stuff nci lines into. (Optional) start index of array, -1 for all. (Optional) end index of array, -1 for all. (Optional) total # of matching gcode lines to look for, 0 for all. The # of matching gcode bnci lines. Return # of matching gcode bnci lines in array. The gcodes to match. # of matching gcode bnci lines. Return a set of gcodes that exist in m_spBnciRW. return gcodes. Return # of matching gcode bnci lines in array. The gcode to match. return # of matching gcode bnci lines. Return upper bound of array. The upper bound. Get size of array. The size. Rewrite an existing nci line to the binary nci. The bnci line to rewrite. (Optional) true = check before writing that the NCI line being overwritten is of the same gcode. file position of where the NCI line was written, -1 = error. Get array index of the next matching gcode line. the gcodes to match. current index in array (search will start on the next line). SearchDirection::Backward = go backwards thru array, SearchDirection::Forward = go forwards. (Optional) 1 = find first matching gcode, 0 = find first non-matching gcode. array index of the matching gcode line, -1 if not found. Write the NCI section to any operation. ID of operation to write to. true - don't write the NCI_BIN_SOS nci line, false - write it. true - don't write the NCI_BIN_EOS nci line, false - write it. # of bnci lines written. Rewrite the array to the binary nci file. false = append new section, true = overwrite existing (must be same size). true - don't write the NCI_BIN_SOS nci line, false - write it. true - don't write the NCI_BIN_EOS nci line, false - write it. # of bnci lines rewritten. Return total size of all nci lines in the array. The section size. Builds a map by operation ID of all the start and end of section NCI lines. The map. Reads the last dirty section for the given operations and restores them as valid. Identifiers for the operation. True to show, false to hide the success dialog. List of IDs of operations that were restored. Read all the bnci lines in an operation's nci section. first bnci file position to read from. last bnci file position to read from. array of gcodes to match. (Optional) maximum # of lines to read. # of lines in array. Read all the bnci lines in an operation's nci section. ID of operation to read. true to try and use the cache of NCI lines in Planes. (Optional) maximum # of lines to read. # of lines in array. Read only the bnci lines that match the gcodMask in an operation's nci section. ID of operation to read. true to try and use the cache of NCI lines in Planes. set of gcodes to match. (Optional) maximum # of lines to read. # of lines in array. Read and return the bnci line at the file position. (Optional) the file position. bnci line read; .fpos == -1 on error. Set the file ptr to the desired bnci. If non-null, the open file. previous file ptr. Query if 'obj' contains equal contents to this. The object to compare. true if equal contents, false if not. Query if 'obj' is equal to this. The object to compare. true if the parameters are considered equivalent. Inequality operator. The object. true if the parameters are not considered equivalent. Equality operator. The object. true if the parameters are considered equivalent. Array indexer operator for m_BnciLines. The index. The indexed value. Destructor. Constructor. Identifier for the operation. Default constructor. Defines an alias representing an array of constant bnci line ptrs. Defines an alias representing an array of bnci line ptrs. Defines an alias representing a const bnci line pointer. Defines an alias representing a bnci line pointer. Values that represent array search direction. A binary NCI utility class. Executes the 'window resumed' action. The wParam field of the message. The lParam field of the message. A LRESULT. Executes the 'show window' action. True to show, false to hide. The status. Executes the 'help' action. Executes the 'help information' action. If non-null, information describing the help. True if it succeeds, false if it fails. Translates all messages before they are processed by the main message loop. If non-null, the message. True if it succeeds, false if it fails. Exchanges data to/from the controls in this dialog. If non-null, an object that manages the data exchange operation. Initializes this dialog and the controls within it. True if it succeeds, false if it fails. Destroys the window. True if it succeeds, false if it fails. This method launches a help dialog for the specified property sheet. The resource id of the page making the call to the help dialogs. Will terminate MC interaction so that RunWithMCInteraction returns IDCANCEL. Will terminate MC interaction so that RunWithMCInteraction returns IDOK. Will pause MC interaction so that RunWithMCInteraction. Will pause MC interaction so that RunWithMCInteraction. Determine if dialog was run by DoModal or RunWithMCInteraction. True if dialog allows MC interaction. Creates and displays dialog allowing view changes but no FT commands or selection. The returned value of the optional check box. If non-null, the mc event mediator used to configure and delagate event handling. IDOK or IDCANCEL. Creates and displays dialog allowing view changes but no FT commands or selection. The returned value of the optional check box. IDOK or IDCANCEL. Creates and displays dialog allowing view changes but no FT commands or selection. IDCANCEL or IDOK. This method initializes the automatic tool tips. Standard destructor. Constructor when using optional check box next to the OK button. The pointer of the string to use as the window caption. If non-null, the CWnd pointer to the parent dialog that this dialog was called from. ID for an optional check box added at runtime. Text string for an optional check box added at runtime. Constructor when using optional check box next to the OK button. The resource id of the string to use as the window caption. If non-null, the CWnd pointer to the parent dialog that this dialog was called from. ID for an optional check box added at runtime. Text string for an optional check box added at runtime. Standard resource string constructor. The string to use as the window caption. (Optional) If non-null, (Optional) the CWnd pointer to the parent dialog that this dialog was called from. (Optional) Zero-based index of the initial page to be selected (default = 0). Standard resource string constructor. The resource id of the string to use as the window caption. (Optional) If non-null, (Optional) the CWnd pointer to the parent dialog that this dialog was called from. (Optional) Zero-based index of the initial page to be selected (default = 0). MCPropertySheet dialog base class. Contains a semi-customizable event loop which the default will allow the Modal dialog to allow Mastercam toplevel functions (i.e. zoom window, rotate view). Destructor. Constructor. disable upon instantiation, enable upon destruction. Initializes the member variables common to all constructors. Query if 'ctrlId' is a default button. Identifier for the control. The control's tool tip. True if default button, false if not. Sets the value of the optional check box. True to set, false to clear. Gets the value of the optional check box. the value of the checkbox, or false if the check box is not displayed. Constructor when using optional check box next to the OK button. Pointer of the string to use as the property sheet caption. CWnd pointer to the dialog's parent. ID for a check box added at runtime. Text string for a check box added at runtime. Constructor when using optional check box next to the OK button. Pointer of the string to use as the property sheet caption. CWnd pointer to the dialog's parent. ID for a check box added at run-time. Text string for a check box added at run-time. detachable bars support how far the mouse is moved after NcLBtnDown before the bar becomes floating This class is responsible for: - knowledge about all commands - images for all commands - command categories - default toolbars @} @defgroup mcproppage_help MCPropPage Help @{ @par Purpose: Initializes automatic tool tips for the page. @par Purpose: Class destructor. @par Purpose: Class constructor. @param[in] nIDTemplate Dialog resource ID @param[in] nIDCaption Caption resource ID @param[in] helpID Mastercam Help ID Handler for the WM_RBUTTONDOWN command. Indicates whether various virtual keys are down. Specifies the x and y coordinates of the cursor. These coordinates are always relative to the upper-left corner of the window. Query if 'ctrlId' is a default button. Identifier for the control. The control's tool tip. True if default button, false if not. Call Create to create a modeless dialog box using a dialog-box template from a resource. Contains a null-terminated string that is the name of a dialog-box template resource. (Optional) Points to the parent window object (of type CWnd) to which the dialog object belongs. If it is NULL, the dialog object's parent window is set to the main application window. Both forms return nonzero if dialog-box creation and initialization were successful; otherwise 0. Call Create to create a modeless dialog box using a dialog-box template from a resource. Contains the ID number of a dialog-box template resource. (Optional) Points to the parent window object (of type CWnd) to which the dialog object belongs. If it is NULL, the dialog object's parent window is set to the main application window. Both forms return nonzero if dialog-box creation and initialization were successful; otherwise 0. Handler for the WM_RBUTTONDOWN command. Indicates whether various virtual keys are down. Specifies the x and y coordinates of the cursor. These coordinates are always relative to the upper-left corner of the window. Sets user interface control strings. Tooltip of default OK button. Tooltip of default Cancel button. Tooltip of default Apply button. Tooltip of default Help button. Show or hide a dialog control. The dialog item ID. The 'show' command. See the CWnd version of this call for details. TRUE if it succeeds, otherwise FALSE. Sets a dialog control's position. The dialog item ID. The window insert after. The new x coordinate. The new y coordinate. The new width. The new height. Window flags. See the CWnd version of this call. TRUE if position is set, otherwise FALSE. Gets the registry key name for the window positions. The registry key name for window positions. Callback used by EnumDisplayMonitors to enumerate each monitor. Monitor rectangle. TRUE = Continue enumerating monitors, FALSE = Cancel enumerating monitors. Sets the text of a dialog control. The dialog item ID. The string to set the text to. Check if a dialog control is visible. The dialog item ID. TRUE if the control is visible, otherwise FALSE. Check if a dialog control is enabled. The dialog item ID. TRUE if the control is enabled, otherwise FALSE. Gets the dialog control's text length. The dialog item ID. The window text length. Gets the dialog control's text. The dialog item ID. The string to copy the window text to. Gets the dialog control's text. The dialog item ID. Buffer for string data. Number of characters the buffer can hold. The number of characters copied. Get the dialog control's rectangle. The dialog item ID. pointer to the rectangle structure to receive the values. Enables or disables the dialog control window. The dialog item ID. (Optional) TRUE to enable, FALSE to disable. Call Create to create a modeless dialog box using a dialog-box template from a resource. Contains a null-terminated string that is the name of a dialog-box template resource. (Optional) Points to the parent window object (of type CWnd) to which the dialog object belongs. If it is NULL, the dialog object's parent window is set to the main application window. Both forms return nonzero if dialog-box creation and initialization were successful; otherwise 0. Call Create to create a modeless dialog box using a dialog-box template from a resource. Contains the ID number of a dialog-box template resource. (Optional) Points to the parent window object (of type CWnd) to which the dialog object belongs. If it is NULL, the dialog object's parent window is set to the main application window. Both forms return nonzero if dialog-box creation and initialization were successful; otherwise 0. Call this member function to invoke the modal dialog box and return the dialog-box result when done. An int value that specifies the value of the nResult parameter that was passed to the CDialog::EndDialog member function, which is used to close the dialog box. The return value is -1 if the function could not create the dialog box, or IDABORT if some other error occurred, in which case the output window will contain error information from GetLastError. Query if 'ctrlId' is a default button. Identifier for the control. The control's tool tip. True if default button, false if not. Common initialization. Call this method to enable or disable layout management for a dialog box. If you specify a custom layout manager (pRTC), it must be derived from CBCGPControlsLayout or one of its descendants. TRUE - enable layout management, FALSE - disable layout management. A pointer to a runtime class information of custom layout manager. TRUE - display resize box; FALSE - don't display resize box. This method has effect only under Windows Vista with the Aero theme enabled. Call EnableAero to display "Aero Glass" either on the whole dialog, or on some edges. To enable glass for the whole dialog, just set _BCGPMARGINS::cyTopHeight to the height of the client area.See the SkinnedDialog sample for more info. Specifies the margins for the "glass" areas. Automatically subclasses all hosted controls in order to take advantage of Visual Manager themes and the "Aero Glass" technology. TRUE - enables Visual Manager theme support for hosted controls. FALSE - disables Visual Manager theme support for hosted controls. If TRUE, the non-client area of dialog will be displayed using the current Visual Style List of controls that shouldn't be subclassed. Call this function with bEnable TRUE to automatically subclass all hosted controls in order to take advantage of Visual Manager themes and the "Aero Glass" technology. Constructs the object Specifies a dialog template resource name . A pointer to the parent window Constructs the object Specifies the dialog template resource ID. A pointer to the parent window Constructs the object The CBCGPDialog class extends the functionality of the CDialog class. It allows to define a background image or color for the dialog box window and handles all the palette an transparency issues. To take advantage of CBCGPDialog features you just need to derive your dialog class from the CBCGPDialog class instead of CDialog class. When you call SetBackgroundImage method and pass HBITMAP as the image handle, the CBCGPDialog object will take ownership over the image and delete it only if the m_bAutoDestroyBmp flag is TRUE. The current background image will be deleted if you call the SetBackgroundImage again or by OnDestroy message handler. Images loaded from the resource file are always destroyed automatically. Calculate the frame length based on current children. Handle BN_CLICKED message. true if handled, false otherwise. Is control a child of this rollup button. Child control ID. True if child, false otherwise Add a child control to this rollup button. Child control ID. Calculate frame rectangle (if expanded). Frame rectangle to draw in client coord of parent dialog. True if successful, false otherwise Force children to be painted. Get length of frame for this button. Length of frame for this button. Get expanded state of button. Set expanded state of button. True to expand, false otherwise. Rollup button destructor. Rollup button constructor. Gets saved window text. The text. Sets saved window text. The text. (Optional) True to overwrite, false to preserve the existing. Sets tooltip from saved window text. (Optional) True to must have bar. Calculates the window text and tooltip text. The text to parse. The window text. The tooltip text. True if it succeeds, false if it fails. Sets up the window's tooltip text. Overrides the default BCG DoDrawItem function. This was necessary to address a contrast issue with Windows 11 where checkbox-style buttons did not appear visually different when checked. If non-null the device-constext. The client rectangle. The item state. Overrides the default BCG OnDraw function. If non-null, the device-context. The rectangle. The state. Read standard UI Font information from the Registry. The active Registry object for reading. The font Registry key. A reference to a LOGFONTW structure. True if it succeeds, false if it fails. Automation provider factory. The window to be Automated. AutomationId for the window. An IAutomationProvider. Helper for the WM_GETOBJECT message. Sent by both Microsoft Active Accessibility and Microsoft UI Automation to obtain information about an accessible object contained in a server application. Provides additional information about the message and is used only by the system. Servers pass dwFlags as the wParam parameter in the call to LresultFromObject when handling the message. Object identifier. This value is one of the object identifier constants or a custom object identifier. A server application must check this value to identify the type of information being requested. Before comparing this value against the OBJID_ values, the server must cast it to DWORD; otherwise, on 64- bit Windows, the sign extension of the lParam can interfere with the comparison. The window to be automated. The automation provider. If the window or control does not need to respond to this message, it should pass the message to the base class function; otherwise, the window or control should return a value that corresponds to the request specified by dwObjId. Queries if the developer mode is active. Uses the IsDeveloperModeEnabled registry value under the main HKCU key. True if the developer mode is active, false if not. Gets a value indicating whether UI Automation Testing is enabled. Uses the IsUIAUtomationTestinEnabled registry value under the main HKCU key. true if active, false if not.. Sets UIA ControlType. The new value. Gets UIA ControlType. Sets UIA AutomationId. The new value. Gets UIA AutomationId. Destructor. Microsoft UIA Automation Provider abstraction. @par Purpose: Calls Mastercam help with the given htmlHelpUrl. @param[in] htmlHelpURL The Mastercam help url to open @par Purpose: Calls Mastercam help for the given dialog or control. @param[in] helpFileName The Mastercam help system component file to open @param[in] hlpID The control or dialog ID that help is being called from @defgroup helpvals Mastercam help system components @{ @} @par Purpose: Calls Mastercam help for the given dialog or control. @param[in] exe_dll_index The index of the Mastercam help system component file to open @param[in] hlpID The control or dialog ID that help is being called from Open a document. Name of the document to be opened True if open successful, false otherwise. @par Purpose: Creates a new, empty document @return true if document successfully created, otherwise false @param[in] silently if true, issue no prompts @par Purpose: Show or clear a previous version file warning message for the current document (Mastercam only). @param[in] value true to have the message displayed, false to have it removed (if it's there) @par Purpose: Sets the document's "merge" flag. @param[in] isMerge true to set the flag, which will trigger 'Save As' dialog upon 'Save' operation. @par Purpose: Gets the document's "merge" flag. @return true if the user merged into the current file (and hasn't saved yet), otherwise false. @par Purpose: Checks the current document for changes @return false if the document was dirty and the user canceled the save/don't save message, otherwise true. @par Purpose: Post ID_FILE_PRINT_DIRECT message to initiate printing @return false if there is no mainframe or view, otherwise true @par Purpose: Call OnFilePrint() to print current document @par Purpose: Update the document's file name to the geo_filename global value @par Purpose: Set the extension of the given file name to .mcam or .emcam @param[in] cs pointer to a CString object containing the name to update @par Purpose: Check with the SIM to make sure the product level is high enough to run the given operation @return true if Router is supported at the given product level; false if not @param[in] min_prod_level specifies the Router SIM level to compare against (NULL checks against the highest level the SIM allows) @param[in] opcode specifies a specific operation opcode to check for compatability with (NULL checks against current op) @par Purpose: Check with the SIM to make sure the product level is high enough to run the given operation @return true if Wire is supported at the given product level; false if not @param[in] min_prod_level specifies the Wire SIM level to compare against (NULL checks against the highest level the SIM allows) @param[in] opcode specifies a specific operation opcode to check for compatability with (NULL checks against current op) @par Purpose: Check with the SIM to make sure the product level is high enough to run the given operation @return true if Lathe is supported at the given product level; false if not @param[in] min_prod_level specifies the Lathe SIM level to compare against (NULL checks against the highest level the SIM allows) @param[in] opcode specifies a specific operation opcode to check for compatability with (NULL checks against current op) @par Purpose: Check with the SIM to make sure the product level is high enough to run the given operation @return true if Mill is supported at the given product level; false if not @param[in] min_prod_level specifies the Mill SIM level to compare against (NULL checks against the highest level the SIM allows) @param[in] opcode specifies a specific operation opcode to check for compatability with (NULL checks against current op) @par Purpose: Check with the SIM to make sure the product level is high enough to run the given operation @return true if Multiax is supported at the given product level; false if not @param[in] min_prod_level specifies the Multiax SIM level to compare against (NULL checks against the highest level the SIM allows) @param[in] opcode specifies a specific operation opcode to check for compatability with (NULL checks against current op) @par Purpose: Store a machine definition entity to the database @param[in] pEnt entity to store @param[out] dbPtr database to entity @param[in] assoc_id associative id @par Purpose: Store a machine definition entity to the database @return true if the current machine matches the given type; false if not @param[in] type eMachineTypes type to compare the current machine to Legacy structure to provide information about NetHasp licenses. Legacy structure to provide information about Hasp licenses. Values that represent the reasons why the IsSIMPresent() check might fail. Inform the Levels Manager that a new entity has been added to the database. The entity that has been added. Sets the Level "name" of the specified level. Note: If the level number does not exist, it will be created. The level number. The new level name. False if the name had to be truncated, otherwise true. Retrieve the LevelName of a level. The level number. The level name (empty if non-existent level). Gets the number of the level with the specified name Level names are not required to be unique and this function only returns the first match found. The name of the level. The number of the level. -1 if the specified name is not found. Return a list of active levels, visible or not. A list of levels. Return a list of visible levels. The visible levels. Sets a given level's visibility. The level number. True to make the level visible, false for not-visible. @} @} A macro that defines maximum level number allowed. Determines whether a given level is currently visible. Number of the level to check. True if level visible, false if not. Sets config UseGradientBkgnd. new value for the setting previous value of the setting True if we are configured for a gradient background, otherwise false. current value of the setting @} @defgroup gr_grp8 Graphics View Settings @{ @defgroup gr_grp9 Graphics Background Gradient Defines @{ @} @} @defgroup gr_grp7 Curve Chordal Settings @{ @} @defgroup gr_grp6 Graphics Precision Settings @{ @par Purpose: Sets the density of drawn surfaces. @param[in] density Surface density. @return The previous surface density. @} @par Purpose: Gets the density of drawn surfaces. @return Surface density. @par Purpose: Sets whether or not surfaces are to be drawn using the backface color. @param[in] backDraw If true, draw the backface color. @return The previous draw backface color state. @par Purpose: Checks if surfaces are being drawn using the backface color. @return If true, the backface color is drawn. @par Purpose: Set the color used to draw the backface of a surface. @param[in] color Backface color. @return The previous backface color. @} @defgroup gr_grp4 Surface Settings @{ @defgroup gr_grp5 Surface Backface Settings @{ @par Purpose: Get the color used to draw the backface of a surface. @return Backface color. @} @defgroup gr_grp1 Color Defines and Variables @{ @defgroup gr_grp2 Color Defines @{ @} @defgroup gr_grp0 Graphics Variables @{ Gets the manager of modules for the Mastercam Function Table. The function table module manager. @par Purpose: Get function name from keymap @return Function name for given keymap @param[in] keymap Keymap @par Purpose: Get keymap from function name @return Keymap for given function name @param[in] function Function name @par Purpose: Get right click flag for the last FT function executed @return true = Right clicked @note Works with RIGHT_MOUSE FT flag @par Purpose: Determine if a FT function is inline @return true = Inline? @param[in] appName Application name @param[in] entryName Entry point (command) name @par Purpose: Set a FT function checked state @return true = Set okay @param[in] appName Application name @param[in] entryName Entry point (command) name @param[in] checked function table entry checked? @par Purpose: Determine if a FT function is checked @return true = Retrieved okay @param[in] appName Application name @param[in] entryName Entry point (command) name @param[out] checked function table entry checked? @par Purpose: Set a FT function is enabled or disabled @return true = Set okay @param[in] appName Application name @param[in] entryName Entry point (command) name @param[in] enabled function table entry enabled? @par Purpose: Determine if a FT function is enabled @return true = Retrieved okay @param[in] appName Application name @param[in] entryName Entry point (command) name @param[out] enabled function table entry enabled? @par Purpose: Set the parameter value passed to a FT function @return true = Retrieved okay @param[in] appName Application name @param[in] entryName Entry point (command) name @param[in] param New parameter value @par Purpose: Run a FT function @return true = Command Posted @param[in] appName Application name @param[in] entryName Entry point (command) name @par Purpose: Get the Function Table index of the specified function @return Index of command in function table (-1 if not found) @param[in] appName Application name @param[in] entryName Entry point (command) name Gets speed feed menu items. The speed feed menu items. @} @defgroup Function Table command ID range @{ @} @defgroup CPP_ent_sigs CPP entry signatures @{ Executes the specified function in a C-Hook. Filename of the C-hook. chook_prefix assumed if path not specified. Extension forced to "dll". Name of the function. (Optional) The parameter to pass to the function. (Optional) true to report error. (Optional) If non-null, the MC_RETURN code from the C-Hook. true if it succeeds, false if it fails. Executes the m_main function in a C-Hook. Filename of the C-hook. chook_prefix assumed if path not specified. Extension forced to "dll". (Optional) true to report error. (Optional) If non-null, the MC_RETURN code from the C-Hook. true if it succeeds, false if it fails. @} @defgroup return_codes UI return codes * * @note If you do not post the MC_EXTENSION_CMD_MSG message you don't have to worry about handling MC_EXTENSION_CMD. * * @{ Gets the context mask. The context mask. Destructor. Constructor. The context mask of allowed FT types. The FT lock down class. @defgroup mask_types Message mask types * @{ @} Returns Windows messages of a specific type depending on the given mode. Best when used in a loop of some sort which can parse all of the messages of a given type until no longer needed. Specifies the mask applied to the messages which get returned. Fills the user-created UINT with the message to be returned. Fills the user-created WPARAM with the wparam of the message being returned. Fills the user-created LPARAM with the lparam of the message being returned. (Optional) Function which specifies optional work to perform while the message pump is idle. Type of message being passed back. Stops a Modal Ribbon session. The token returned from StartModalRibbon. True if the call was valid, false otherwise. Starts a Modal Ribbon session. The ribbon XML. A token for the new Modal State. This token will be passed to StopModalRibbon. Inserts 3rd Party Ribbon Tabs described by pRibbonXml. The Ribbon XML as a string. true if it succeeds, false if it fails. @par Purpose: Insert chook menu before help menu @return true if inserted successfully @param[in] menuArray Array of menu specifiers @par Purpose: Allow changing the mode (application enable bits) from a DLL. @param[in] newMode The new mode (AEB_DESIGN, AEB_MILL, AEB_LATHE, etc.). @} @par Purpose: Get a pointer to the MCDialogBar that corresponds to the given parameters. @return Pointer to MCDialogBar that corresponds to given parameters, NULL if not found. @param[in] dialogBarType MCDialogBarType enum @param[in] dialogBarId ID of dialog bar to retrieve. Only used if dialogBarType is MC_EXTERNALBAR. @defgroup enum_parameters UI dialog bar enum types * @{ @par Purpose: Remove the given dialog bar from Mastercam. @return True if successful, false otherwise. @param[in] dialogBarId ID of MCDialogBar to remove. @par Purpose: Remove the given dialog bar from Mastercam. @return True if successful, false otherwise. @param[in] pDialogBar Pointer to MCDialogBar to remove. @par Purpose: Add the given dialog bar to Mastercam. @return ID of the dialog bar added to Mastercam if successful, -1 if failure. @param[in] pDialogBar Pointer to MCDialogBar to add. @par Purpose: Resets the current entity attribute settings to the previous attribute settings. @param[in] in_converter true if this call is coming from a converter; false otherwise @par Purpose: Restores the old entity attribute settings. @param[in] in_converter true if this call is coming from a converter; false otherwise @par Purpose: Disables the current entity attribute settings. @param[in] in_converter true if this call is coming from a converter; false otherwise @par Purpose: Modifies the data of a given entity. @return true if the data modification was succesful; false otherwise @param[in] entity pointer to the entity to modify @param[in] data pointer to an ea_type variable which holds adjustment data @par Purpose: Converts an ent variable's id to an Ent Attribute type @return ent id's corresponding Ent Attribute type (EA_POINT, EA_LINE, etc.) @param[in] id ent variable's id to convert @} @par Purpose: Runs the Entity Attribute Manager dialog @return true if the user closed the dialog by hitting 'OK'; false if they didn't @param[in] pWnd CWnd pointer of this dialog's parent, calling window @param[in,out] in_converters specifies if this is in the middle of a converter function @param[in,out] data entity attribute data to set initially; returns new entity attribute data @param[in] hide id to memory table item @defgroup ea_types Entity Attribute Variables @{ @par Purpose: Return the state of the on screen 2d/3d option @return true = 3d, false = 2d @par Purpose: Checks to see if a chain is in a given view @return 0 if successful, 1 if there was a depth-related error with the entities, -1 if there was some other error @param[in] chain chain to look at (entities must be flat) @param[in] view view number of the view we're checking against @param[out] depth Z coordinate of entities relative to "view" @param[in] showWarningIfNotFlat Show user a warning message if the Chain is not flat? @par Purpose: Gets the view number of the view all of the chained entities are in. @note entities in parallel view are allowed. @return true if a valid view number has been returned; false if not @param[in] chain chain of entities to look at (entities must be flat) @param[out] view view number of the view all entities are in @param[out] depth Z coordinate of entities relative to "view" @param[in] showWarningIfNotFlat Show user a warning message if the Chain is not flat? Removes level if it has no entities. @par Purpose: Non-MFC version for NETHooks. Prompts for a level number @return true if a level has been selected; false if not @param[in] allow_zero flag indicating if the user is to be allowed to input a level of zero @param[in,out] level initial selection dialog level value; new level value on return @par Purpose: Prompts for a level number @return true if a level has been selected; false if not @param[in] pParent pointer to parent window @param[in] allow_zero flag indicating if the user is to be allowed to input a level of zero @param[in,out] level initial selection dialog level value; new level value on return Gets the opacity of dimmed wireframe. Opacity [0, 100]. Get the spaceball view snapping attraction value. Returns the value. Get the view snap angle tolerance. Returns the value. Set whether view transitions are allowed to be animated. Returns the previous value. Reports whether view snapping is allowed. Returns true if allowed. Reports whether view transitions are allowed to be animated. Returns true if allowed. Set whether zoom / fit is allowed to be animated. Returns the previous value. Reports whether zoom / fit is allowed to be animated. Returns true if allowed. Get the view-to-view and zoom / fit animation delay value. Returns current value of the animation delay, 0 for off. Set the view-to-view and zoom / fit animation delay value. Set the state of the "draw hidden wireframe as dashed" flag. True to set, false to unset. Get the state of the "draw hidden wireframe as dashed" flag. True if set, false otherwise. Get the number of preset lighting environments. Returns the number of available light scenes. Get which OpenGL light scene mode is in use. Returns the current light mode index. Set which OpenGL light scene mode to use. Out of range requests are ignored. The requested mode index. Prevents updating graphics before startup tasks are complete. Toggle the surface backside shading on/off and udpate the graphics. Performs an animated screen unzoom by the scale amount. The scale factor. Executes the screen fit unzoom action. (Optional) The scale factor. Executes the screen unzoom previous action. Not used. Executes the screen unzoom action. Not used. Edit the given group properties. @param[in] not_used Not used @par Purpose: Open the specified file. @return true if open successfully @param[in] wait Wait for the new process to terminate before returning? @param[in] filen Name of file to open. @param[in] params String that contains the application parameters. @param[in] dirname String that specifies the name of the working directory. Indicate if the plane specified in config has been set yet. true to indicate the plane has been set, otherwise false. Removes the GAF object(s) of the specified entity from the display list. The entity. True if deleted; false if not in display list. Updates the GAF object(s) of the specified entity in the display list. Entity to update. True if successful, false if GAF object(s) not found in display list. Adds the GAF object(s) of the specified entity to the display list using the specified color. The entity. The drawing color. Adds the GAF object(s) of the specified entity to the display list. The entity. Adds the (full path) file name to the Recent Open File MRU. Full pathname of the file. Clears the list of file names in Recent Open File MRU. Gets the list of file names in Recent Open File MRU. The file names in the MRU. @par Purpose: This method enables silent exit mode for the life of the current Mastercam instance. @par Purpose: This method returns whether or not the current operating system is Windows 8 @return true if Win8, false if otherwise @par Purpose: This method returns whether or not the current operating system is Windows 7 @return true if Win7, false if otherwise @par Purpose: This method returns whether or not the current operating system is Windows Vista @return true if Vista, false if otherwise @par Purpose: This method returns whether or not the current operating system is Windows XP @return true if WinXP, false if otherwise @par Purpose: Write text to the Status bar @return none @param[in] statustxt message to display @par Purpose: Returns the pointer to the current (active) graphics view. @par Purpose: Returns the number of graphics views. @par Purpose: calls the function to close a universal MCDialog in the function panel @par Purpose: calls the function to open a universal MCDialog in the function panel @par Purpose: return the pointer to the FunctionPanel, for use in setting the parent of modal and modeless dialogs @par Purpose: return the pointer to the Mastercam CWnd, for use in setting the parent of modal and modeless dialogs @par Purpose: Updates the bounding box for CHook generated graphics. This function should be called in response to an MCEVENT_MINMAX event. Note: Since an event is generated for each graphics repaint, a caller to this function should maintain their min/max values so they need not be recalculated for each event. Failure to do this may cause serious degredation in the graphics performance. @param[in] minX Minimum X value. @param[in] minY Minimum Y value. @param[in] minZ Minimum Z value. @param[in] maxX Maximum X value. @param[in] maxY Maximum Y value. @param[in] maxZ Maximum Z value. @par Purpose: Checks for keyboard to see if the specified key has been pressed. @return whether the key hit is in the message queue @param[in] key the key code @par Purpose: Gets the current graphics view # @return the current graphics view # @par Purpose: This method gets the global variable: levname. @return true if it returns a valid level name; false if not @param[in] leveln level number @param[in] maxLen maximum length of the ptr char array being passed in @param[out] ptr array to hold the level name @par Purpose: This method computes the lower left and upper right corner and the clipping and select parameters. @param[in] center center point @param[in] height height @par Purpose: This method runs the select level dialog. @return true if a level has been selected; false if not @param[in] pParent pointer to parent window @param[in] allow_zero true = allow input of level zero @param[in] select_off true = disable select button @param[out] *level selected level @par Purpose: This method sets the select bits corresponding to the select bits that are set in set_pattern. Clear the select bits corresponding to the select bits that are set in clr_patter. Select the entities that match sel_mask and ent_mask. NOTE: this version uses the data base instead of the display list. @param[in] set_pattern bits to set in .sel of matching entities. @param[in] clr_pattern bits to clear in .sel of matching entities. @param[in] clr_ptn_unmatched bits to clear in .sel of non-matching entities. @param[in] sel_mask .sel field defining matching entities @param[in] ent_mask matches .id fields of entities to process @param[in] draw true = draw entities after chaning .sel @param[in] add_undo flag indicating whether this database op should be added to the undo stack @par Purpose: This method sets the select bits according to set_pattern. It clears the select bits that are set in clr_pattern. It selects the entities that match sel_mask, and ent_mask @param[in] set_pattern bits to set in .sel of matching entities @param[in] clr_pattern bits to clear in .sel of matching entities @param[in] clr_ptn_unmatched bits to clear in .sel of non-matching entities. @param[in] sel_mask .sel field defining matching entities @param[in] ent_mask matches .id fields of entities to process @param[in] draw draw entities after changing .sel bits @param[in] add_undo flag indicating whether this database op should be added to the undo stack @par Purpose: This method shows/hides a child dialog within a child/parent relationship @return unused @param[in] dialogCWnd the dialog CWnd ptr @param[in] show true to show the dialog; false to hide it @par Purpose: This method maps a 2d cursor point to a 3d point. @return true if the point was mapped successfully; false if not @param[in] pt_2d the 2d point to be mapped @param[in] sketch_view the view number @param[in] sketch_depth the sketch depth @param[out] world_pnt 3d value of the newly mapped point @param[in] disp_err flag indicating whether or not to display error messages (default = true) @par Purpose: Non-MFC wrapper for color selection dialog. @return true if a new color was selected; false if not @param[in,out] color sets dialog to this color on construction; returns selected color on destruction @param[in] showBackgroundColorWarning flag allowing or denying the display of the color equals background color warning (default = show) @par Purpose: Wrapper for color selection dialog. @return true if a new color was selected; false if not @param[in] pParent pointer to the CWnd parent of this dialog @param[in,out] color sets dialog to this color on construction; returns selected color on destruction @param[in] select_enabled flag for the use of the selection button on the color dialog (default = true) @param[in] showBackgroundColorWarning flag allowing or denying the display of the color equals background color warning (default = show) @par Purpose: chook callback to add extents to the current fit. @param[in] min_x min x of added extents @param[in] min_y min y of added extents @param[in] max_x max x of added extents @param[in] max_y max y of added extents @par Purpose: This method reverses the effects of the zoom function. It will perform n-i iterations times. @param[in] noOverlays Optional flag to prevent screen overlays from affecting the fit. No-op called by Tool Manager. Restore lost ability for Mastercam to get a time slice while Tool Manager runs. @par Purpose: This method executes a DOS command. @param[in] cmdstr the command string @param[in] echo true, if command should echo, else, false. @param[in] wait true, if Mastercam should wait until command has completed. @param[in] unused Marks an entity as unselected. Pointer to entity. Marks an entity as unselected. Entity eptr. Marks an entity as selected. Pointer to entity. Marks an entity as selected. Entity eptr. @par Purpose: Repaints and cleans a given point. @param[in] ch -- unused -- @param[in] pnt point to be cleaned This method repaints the graphic viewport(s). By default, this function updates the graphics via the message queue. When an app requires a repaint, try this first. If the the graphics don't appear to update correctly, then try passing "immediate" as true. One may be tempted to always specify immediate repaints, but that is not recommended. Immediate repaints can slow an app down, depending on what it's doing. (Optional) true: do immediate repaint. it will bypass the message queue and repaint graphics screen immediately. false: do update via message. @par Purpose: This method converts user units (inches or mm) to screen units (pixels). @param[in] pt a 2d point in user units @param[out] scrn_pt a point in screen units @par Purpose: This method converts screen units (pixels) to user units (inches or mm). @param[in] scrn_pt screen point in pixels @param[out] pt point in user units Enqueue a future view setup. Updates the graphics immediately after, so view will be presented as soon as possible. The view matrix. The view center. The view height. Gets current view setup. [out] The view matrix. [out] The view center. [out] The view height. true if it succeeds, false if it fails. Puts the width of the viewport. The new value. Puts the height of the viewport. The new value. Puts the work center. A 2D point specifying the work center of the viewport. Gets the width of the viewport. The current width. Get the height of the viewport. The current height. Gets the work center. A 2D point specifying the work center of the viewport. @par Purpose: Returns the current viewport configuration @return Refer to Viewport Configurations defines World to view. The point in world. The view. The point in view. @par Purpose: This method maps world coordinates to view coordinates. Assumes that the view coordinate axes are mutually orthogonal. @param[in] pt_world a 3d point in world coordinates to be mapped @param[in] view the view number of the view to map to @param[out] pt_view the resulting 3d point in view coordinates View to world. The point in view. The view. The point in world. true if it succeeds, false if it fails. @par Purpose: This method maps view coordinates to world coordinates Return true if successful @param[in] pt_view a 3d point in view coordinates to be mapped @param[in] view the view number of the view to map to @param[out] pt_world the resulting 3d point in world coordinates @par Purpose: this method, map an arc into a parallel view (change start angle and view number) @param[out] *e arc to map to a new view @param[in] new_view_n view number of the new view to change to @par Purpose: this method, map an arc into a parallel view (change start angle and view number) @param[out] arc arc to map to a new view @param[in] new_view_n view number of the new view to change to @par Purpose: this method, given a view number, return the view matrix (returns false if v_no > n_views) @return true if succesful; false if the v_no requested is greater than the number of views @param[in] v_no the view number to look up @param[in] v_mat the view matrix corresponding to the given view number @par Purpose: This method computes the endpoints of a 3d arc @param[in] arc the arc to analyze @param[out] ep1 the endpoint corresponding to sa (first endpoint) @param[out] ep2 the endpoint corresponding to sa_sw (second endpoint) @par Purpose: This method translates a translation matrix from view coordinates to world coordinates @param[in] x_m_v matrix in view coordinates to transform @param[out] *x_m transformed matrix in world coordinates Translate a transformation matrix from one view to another. The transformation matrix. The view number. The resulting matrix. @par Purpose: This method finds a view whose k vector matches the given vector @param[in] v the p_3d to match to a view @param[out] *view_n the view number of the view matching the given p_3d @param[out] *succf loads user-created bool with the result of the function; true if it was successful, false if not @par Purpose: This method finds a view whose k vector is parallel to the given vector @param[in] v the p_3d to match to a view @param[out] *view_n the view number of the view matching the given p_3d @param[in] make_new_view a flag indicating whether a new view should be made in case a matching one isn't found @param[out] *succf loads user-created bool with the result of the function; true if it was successful, false if not @par Purpose: This method finds a view that matches a given 3x3 matrix. If the view is not found, and make_new_view is true, make a new view @param[in] v_m the matrix to match to a view @param[out] *view_n the view number of the view matching the given matrix @param[in] make_new_view a flag indicating whether a new view should be made in case a matching one isn't found @param[out] *succf loads user-created bool with the result of the function; true if it was successful, false if not @par Purpose: This function changes the name of an operation or machine group, both in the operations manager and the database @param[in] grp_idn The ID of the group whose name is to be updated @param[in] newGroupName The new name of the group @return True if the name was changed successfully; false if not Gets color blue value. The color. The color blue value. Gets color green value. The color. The color green value. Gets color red value. The color. The color red value. Gets color reference. The color. The color reference. Gets the product code of the active machine group. Product code (PRODUCT_NONE if fails to get group). @par Purpose: This function gets and returns a group list pointer for the currently active machine group @param[in] create_one true if you want this call to create an active machine group if there currently isn't one (default = true) @return A group list pointer to the currently active machine group Checks if the graphics pipeline is using glow highlighting. Glow highlighting is disabled when the GDI pipe is used for printing. If "effective" is true, the returned state is always "disabled" if GDI printing is active. If "effective" is false, the state of the glow highlighting flag is returned. Optional flag to control whether or not the effective state is returned. If true, enabled; if false, disabled. Checks if dashed wireframe highlighting is enabled. If true, enabled; if false, disabled. Disable moving associated entities dialog. True to move associated entities. @par Purpose: Scales either from metric to english or from english to metric @param[in] e2m true if the entities are to be scaled to metric; false if they're to be scaled to English @param[in] eptr The mark from which to check for scalable entities @param[in] b4eptr true if we're to check the entities before the eptr; false if we're to check the ones after @param[in] prmpt true if the user is to be prompted as to whether or not there should be any scaling done @param[in] onlyXMTSolids Flag to control whether or not only XMT solids are processed @par Purpose: Checks to see if there is anything to scale, and if the user wants to @param[in] e2m true if the entities are to be scaled to metric; false if they're to be scaled to English @param[in] eptr The mark from which to check for scalable entities @param[in] b4eptr true if we're to check the entities before the eptr; false if we're to check the ones after @param[in] prmpt true if the user is to be prompted as to whether or not there should be any scaling done @return true if there are entities to be scaled @par Purpose: Prompt for a scale transformation @param[in] scaleXYZ true if you wish to scale each vector seperately; false if not @param[out] x_m The resulting scaled transformation matrix @param[out] scFac The scale factor(s) - 3 doubles if scaleXYZ; 1 double if !scaleXYZ @param[out] sel_pt The point to scale about @param[out] succf true if the user chose a translation successfully; false if not @par Purpose: Prompt for the translation transformation matrix @param[out] x_m The resulting translation transformation matrix @param[out] from_pt The 'from' pt @param[out] to_pt The 'to' pt @param[out] from_view_n The 'from' view @param[out] to_view_n The 'to' view @param[out] succf true if the user chose a translation successfully; false if not @par Purpose: Ask for a rotation. @param[out] x_m The resulting rotation matrix @param[out] angDegs The resulting angle of rotation @param[out] sel_pt The point to rotate about @param[out] succf true if the user chose a rotation successfully; false if not @par Purpose: Ask for the transformation (e.g. mirror line, translation points, etc). This matrix can then be passed to xform_setup() prior to xform_store_ent() or any of the *_silent() functions. @param[out] x_m The resulting transformation matrix @param[out] p1 One end of the 'line' to mirror about @param[out] p2 Other end of the 'line' to mirror about @param[out] succf true if the user chose a transformation and the transformation matrix was created successfully; false if not @par Purpose: Transform any entity according to x_m_cur and xformation (set by xform_setup) and store it in database @param[in,out] entity entity to transform @param[out] succf true if transformation ok @param[out] pSldDuplicatedGeom (optional) Wireframe eptrs duplicated by solid transformation (added to) @param[in] draw (optional) if true, draw (default); if false don't draw @par Purpose: Transform any entity according to xm and xt @param[in,out] entity entity to transform @param[in] xm transformation matrix @param[in] xt transformation type (M_xform, etc.) @return succf true if transformation ok @par Purpose: Free up some memory which xform_store_ent() needs @par Purpose: Get last set of matrices used by xform @param[out] xma Array of matrices (world) @return type M_xform, R_xform, S_xform, T_xform @par Purpose: Free xform matrix array. @param[in] xm matrix (world) @par Purpose: Add a matrix to the xform matrix array. @param[in] xm matrix (world) @par Purpose: Set static variable rot_angle (used by xform_ent and xform_arc) Used to rotate arcs within parallel views (set to MAXREAL to disable) Should be called after xform_setup (xm, R_xform) @param[in] angle New rotation angle @param[in] rads Angle in radians (otherwise, degrees) @return true if a rotation angle was created; false if MAXREAL was used @par Purpose: Set static variables x_m_cur and xformation (used by xform_line and xform_arc, for example) @param[in] new_xm New transformation matrix @param[in] new_xtype New transformation type (M_xform, etc.) @par Purpose: Scales an entity, without any prompts or messages to the user @param[in] eptr eptr of entity, if null_eptr - use existing selected ents @param[in] init_xf true = init the transformation matrix @param[in] copy true = copy, false = rotate existing @param[in] ref_pt scaling pt (world coordinates) @param[in] scale scale factor @param[out] succf true = ok @par Purpose: Rotate a single entity (THAT HAS NO ASSOC WITH OTHER ENTITIES) without making any noise @param[in] eptr eptr of entity, if null_eptr - use existing selected ents @param[in] init_xf true = init the transformation matrix @param[in] copy true = copy, false = rotate existing @param[in] rpt rotation pt (world coordinates) @param[in] ra rotation angle in degrees @param[in] view_n view to rotate in @param[out] succf true = ok @par Purpose: Mirror an entity without making any noise @param[in] eptr eptr of entity, if null_eptr - use existing selected ents @param[in] init_xf true = init the transformation matrix @param[in] copy true = copy, false = mirror existing @param[in] pts two end points of the mirror axis (world coordinates) @param[in] view_n view to rotate in @param[out] succf true = ok @param[in] onCplane (Optional) true = geometry on Cplane. False = geometry on given view @par Purpose: Translate an entity without making any noise @param[in] eptr eptr of entity, if null_eptr - use existing selected ents @param[in] init_xf true = init the transformation matrix @param[in] copy 0 = move existing, 1 = copy, 2 = join @param[in] from_pt from pt (world coordinates) @param[in] to_pt destination pt (world coordinates) @param[in] from_view_n from view @param[in] to_view_n destination view @param[out] succf true = ok @param[in] draw (optional) if true, draw (default); if false, don't draw Executes the is cutting item operation. True if it succeeds, false if it fails. Executes the is similar operation. The other tool. Identifier for the machine group. The compare mode. true if it succeeds, false if it fails. Resets all identifiers associated to this object. The map of old IDs to new IDs. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Determines if the other tool is similar enough to be considered a duplicate. The other. (Optional) identifier for the machine group to aid in the comparison. (Optional) the compare mode. true if similar, false if not. Sets operation tool information. The information. Gets the operation tool information. The operation tool information. Copy operator. The right hand side. A deep copy of this object. Copy constructor. A deep copy of this object Resets all identifiers associated to this object. The map of old IDs to new IDs. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Converts the object to the specified units. True to convert to metric, false to convert to inch. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Converts the object to the specified units. True to convert to metric, false to convert to inch. A tool assembly item deserialization implementation. Executes the is cutting item operation. True if it succeeds, false if it fails. Executes the set stored profile action. Executes the get profile operation. A TlProfileResult. Executes the convert units operation. True to convert to metric, false to convert to inch. Resets all identifiers associated to this object. The map of old IDs to new IDs. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Updates the connection with the matching identifier on this item with the specified connection data. The connection. True if it succeeds, false if it fails. Attempts to get a pointer to the connection on this item with the specified identifier. Identifier for the connection. Null if it fails, else the connection pointer. Converts the object to the specified units. True to convert to metric, false to convert to inch. Query if this tool assembly item is a cutting item. True if this assembly item is a cutting item, false if not. Generates the profile of this item. If the item is a parametric item, a parametric profile will be generated. Otherwise, the item's stored custom profile will be retrieved in the form of a TlProfileResult instance. The profile result. Removes the operation group described by opGroup. Group the operation belongs to. true if it succeeds, false if it fails. Adds an operation group. Group the operation belongs to. true if it succeeds, false if it fails. Sets the stored profile of the item using the given profile. The passed in profile is assumed to be in the specified units, as it will be scaled as necessary before being set as the stored profile. The profile in system units to be set as the stored profile of this item. True if the profile passed in is in Metric units. Sets the stored profile of the item using the given profile. The passed in profile is assumed to be in the specified units, as it will be scaled as necessary before being set as the stored profile. The profile in system units to be set as the stored profile of this item. True if the profile passed in is in Metric units. Gets a scaled version of the stored internal profile in the desired units. true to get profile in metric. The stored profile. Gets a scaled version of the stored internal profile in the desired units. true to get profile in metric. The stored profile. Gets the operation groups. The operation groups. Move assignment operator. The right hand side. A reference to this object. Assignment operator. The right hand side. A reference to this object. Move constructor. The other. Copy constructor. The other. Default constructor. Resets all identifiers associated to this object. The map of old IDs to new IDs. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Clears this object to its blank/initial state. Deletes the connection described by ID from the map. The Identifier of the connection to delete. True if it succeeds, false if it fails. Gets a const pointer to the connection described by id. The identifier. Null if it fails, else the connection pointer. Adds the connection described by value to the map or updates the existing item if a connection with the same identifier already exists. The value to add or update. True if it succeeds, false if it fails. Query if this object is empty. True if empty, false if not. Gets the size. The size. Gets the end iterator. The end iterator. Gets the begin iterator. The begin iterator. Sets the item pointer. The item . Resets all identifiers associated to this object. The map of old identifiers to new identifiers. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Gets the file data binary size. The file data binary size. Sets the file data using the path to the Parasolid transmit (.x_b) file. Full pathname of the file. Must be a Parasolid transmit (.x_b) file. A connection deserialization implementation. Executes the reset IDs operation. The map of old IDs to new IDs. Executes the is equal operation. The right hand side. True if it succeeds, false if it fails. Serialize this object to the given stream. The archive. Converts the object to the specified units. True to convert to metric, false to convert to inch. Sets the item pointer. The item . Gets the item pointer. The item pointer. Gets a value indicating whether the scalar values in this connection are metric. True if metric, false if inch. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Sets the translation portion of the locator, scaling the input value if necessary. The value. True if the value is in metric. Sets the translation portion of the locator assuming that the value is in system units. The value. Gets the translation portion of the locator in the specified units. True to get the translation portion in metric. The translation portion of the locator. Gets the translation portion of the locator in system units. The translation portion of the locator. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. The linearization constant. The profile segments in order from bottom up. A TlProfile deserialization implementation. Executes the operation to reset identifiers. The changed identifiers. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Splits segment into profiles. The sp segment. The sp lower profile. The sp lower last segment. The sp upper profile. The sp upper last segment. The value. The tolerance. Splits segment into profiles. The sp segment. The sp lower profile. The sp lower last segment. The sp upper profile. The sp upper last segment. The value. The tolerance. Adds a segment to profile. The sp segment. The sp profile. The sp last segment. The tolerance. Query if 'segment' is segment an arc crossing 360. The segment. true if segment an arc crossing 270, false if not. Query if 'segment' is segment an arc crossing 270. The segment. true if segment an arc crossing 270, false if not. Query if 'segment' is segment an arc crossing a specified angle. The segment. true if segment an arc crossing angle, false if not. Query if 'segment' is segment an arc crossing a specified angle. The segment. true if segment an arc crossing angle, false if not. Segment completely below x coordinate value. The sp segment. The value. The tolerance. true if it succeeds, false if it fails. Segment completely below y coordinate value. The sp segment. The value. The tolerance. true if it succeeds, false if it fails. Splits arc at angle. The segment. The angle. Results of the arc split. Comparison tool for points. The first value. The second value. The tolerance. true if the two points are equal within system tolerance. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Scales the current profile from Inch to Metric or vise versa if needed. True if the profile is currently in metric units. True to scale the profile to metric units if needed. Transforms the current profile by the given transformation. The transformation. Type of the transformation. Scales the current profile. The scale factor. Trims any overhang at the end of the profile. This essentially removes horizontal overlapping segments at the end of the profile and replaces it with a single trimmed horizontal line segment. Trim or extend to y coordinate value. The value. Extend to y coordinate value. The value. Trim to y coordinate value. The value. true to keep lower portion, false to keep the upper portion. Trim to x coordinate value. The value. true to keep lower portion, false to keep the upper portion. Splits the current profile at the specified y coordinate value. The value. The lower portion profile result. The upper portion profile result. (Optional) True to add horizontal connectors. Splits the current profile at the specified x coordinate value. The value. The lower portion profile result. The upper portion profile result. Translates the entire profile, so that the lowest point of the profile is at Y=0. Looks at the endpoints of each segment to determine the amount to translate. Translates the entire profile so that the lowest point of the profile is at Y = 'value'. The value. Adds horizontal connectors to the start and endpoint of the profile. If the point is already at y=0, then no connector is added/needed. Linearizes this profile into strictly line segments. (Optional) The chordal deviation tolerance. Sorts the profile. true if it succeeds, false if it fails. Cleanup zero length segments. Determines if we have any line segments on the Y axis. true if it succeeds, false if it fails. Validates the profile quadrant. true if it succeeds, false if it fails. Swap the segments at index1 and index2. The first index. The second index. (Optional) true to reverse direction of the resulting index1 segment. true if it succeeds, false if it fails. Adds a segment to the top of profile. The rest of the profile remains unchanged. The passed in segment should have coordinates relative to the profile we're adding it to. The segment. adds a segment to the bottom of a profile, and pushes everything else up to accomadate it. New segment to add - should be constructed from origin. Will be translated down if profile is below x axis Gets the number of profile segments with height. (Optional) true to only get the segments with height. The number of profile segments with height. Provides const reference to profile segment array. const reference to profile segments array. Gets all the profile segments as a const vector of const TlProfileSegmentPtr objects (does not clone segments!). This function returns the profile segments in reverse order to mimick the TlHolderSegments. (Optional) true to only get the segments with height. The profile from the top down. Gets the segment at the specified index. Zero-based index of the segments. The segment. Clears the profile. Sets calculate tolerance. The value. Gets calculate tolerance. The calculate tolerance. Gets segment count. The segment count. Gets internal maximum y coordinate. The internal maximum y coordinate. Maximum y coordinate of this profile. The maximum y coordinate. Minimum y coordinate of this profile. the minimum y coordinate. Maximum x coordinate of this profile. The maximum X coordinate. Minimum x coordinate of this profile. the minimum X coordinate. True length of profile in Y, including section below X axis said length Height of profile at top as measured from X axis said height Checks to see if this profile is empty true if empty, else false Query if this object is a closed loop profile. Does not need segments to be in any specific direction or order. true if closed loop, false if not. Cast that converts the given to a vector. Type of the prof ent. The result of the operation. Cast that converts the given to a vector. Type of the tl profile ent. The result of the operation. Assignment operator. The right hand side of the assignment operation. A deep copy of this object. Copy Constructor. The profile. Constructor to create a TlProfile from a vector of profile segments. The profile. Constructor to create a TlProfile from a vector of profile segments. The profile. Default constructor. Creates an empty profile. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Executes the trim at x coordinate value operation. The value. true to keep lower segment. A TlProfileSegmentPtr. Executes the trim at y coordinate value operation. The value. true to keep lower segment. A TlProfileSegmentPtr. Query if this object is coincident with the Y axis. true if coincident with y axis, false if not. Sets to old segment. The result. Sets to old segment. The result. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Gets scaled segment. The scale factor. The scaled segment. Scales this segment. The scale factor. Gets rotated segment. The radians. The about point. The rotated segment. Gets rotated segment. The radians. The rotated segment. Rotates this object about the passed in point. The radians. The about point. Rotates this object. The radians. Gets mirrored segment. true to about y coordinate axis. The mirrored segment. Mirrors. true to mirror about the Y axis, false to mirror about the X axis. Gets translated segment. The delta x coordinate. The delta y coordinate. The translated segment. Translates the segment in 2space. The change to make in X. The change to make in Y. Gets transformed segment. The transformation. Type of the transform. The transformed segment. Transforms the current segment by the given transformation. The transformation. Type of the transform. Gets reversed segment. The reversed segment. Validates the quadrant. true if it succeeds, false if it fails. Reverses the segment. Trim at x coordinate value. The x coordinate. (Optional) true to keep lower segment. A TlProfileSegmentPtr. Trim at y coordinate value. The y value to trim to. (Optional) true to keep the lower segment. A TlProfileSegmentPtr. Determines if the current segment x coordinate value. The value. true if it succeeds, false if it fails. Determines whether a given segment would have to be trimmed to stay under Y. Y value to stay under. true if it needs trimming, else false. Sets calculate tolerance. The value. Gets calculate tolerance. The calculate tolerance. Query if this object is coincident with the Y axis. true if coincident with y axis, false if not. Gets maximum width. The maximum width. Gets top width. The top width. Gets bottom width. The bottom width. Height of segment. said height. Gets the length of this profile segment. The length. Gets the end endpoint of this segment. The end endpoint. Gets the start endpoint of this segment. The start endpoint. Lowest point contained in segment. Lowest point contained in segment. Minimum x coordinate. A double. Highest point contained in segment. Highest point contained in segment. Maximum x coordinate. A double. Conversion function. (Optional) The chordal deviation tolerance. vector of TlProfileLineSegmentPtr representing this object, linearized. Cast that converts the given profile segment to a TlProfileEnt. The result of the operation. Conversion operator. prof_ent representing this object. Constructor. The segment. Default constructor. Values that represent the various possible transformations for a segment. A TlObject deserialization implementation. Executes the accept visitor operation. The visitor. Executes the accept visitor operation. The visitor. Executes the clone operation. A TlObjectPtr. The identifier. Executes the slot changed action. Executes the reset ids operation. The map of IDs that have been changed. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Resets all identifiers associated to this object. The map of IDs that have been changed. Resets all identifiers associated to this object. Method to accept an instance of the IConstTlClassVisitor interface in an implementation of the Visitor design pattern. The IConstTlClassVisitor interface allows read only access to the Tl class instance based off of the implementation of the interface. The visitor interface instance. Method to accept an instance of the ITlClassVisitor interface in an implementation of the Visitor design pattern. The ITlClassVisitor interface allows for changes to be made to the Tl class instance based off of the implementation of the interface. The visitor interface instance. Sets an identifier. The identifier. true if it succeeds, false if it fails. Sets an identifier. The identifier. true if it succeeds, false if it fails. Sets slot directly with no side affects. This special accessor is needed because m_Slot is actually serialized out in the TlToolAssembly class. This will be resolved eventually. The new slot number. Gets the identifier. The identifier. Less-than comparison operator. The other. true if the first parameter is less than the second. Inequality operator. The right hand side. true if the parameters are not considered equivalent. comparison operator. The other. true if objects are the same Makes a deep copy of this object. null if it fails, else a copy of this object. Move assigment operator. The other. A shallow copy of this object. Assignment operator. The other. A shallow copy of this object. Move constructor. The other. Copy constructor. The other tl object. Default constructor. Checks whether an operation with the given operation code does not planes. Operation code to check. True if the operation with the given operation code does not planes. Checks whether an operation with the given operation is a transform operation. Operation code to check. True if the operation with the given operation is a transform operation. Gets the operation codes which represent transform operations. Operation codes which represent transform operations. Makes a helix. If non-null, the sp eptr. If non-null, the sp eptr. The helix center. (Optional) If non-null, the nurb struct filled up on output. Return code - 0 = ok, 1 = error Makes a Spiral. The spiral parameters. The array of spiral splines. The spiral center. Return code - 0 = ok, 1 = error Creates helix ent without storing it in the database. Options for controlling the helix. The base point. The nurb struct. true if it succeeds, false if it fails. Creates helix ent and store it in the database. Options for controlling the helix. The base point. The helix eptrs. true if it succeeds, false if it fails. Creates spiral ents and store it in the database. Options for controlling the spiral. The base point. The spiral splines. true if it succeeds, false if it fails. @par Purpose: Reads the "Prompt when switching system units" setting from the registry @returns The value if it is found in the registry, or TRUE if it's not. @par Purpose: Writes the "Prompt when switching system units" setting to the registry. @param[in] wantPrompt True to prompt, otherwise FALSE. @par Purpose: Frees all of the memory being used by the variable registry @par Purpose: Unregisters a variable (both english and metric) @param[in] var variable to un-register @par Purpose: Unregisters a metric measurement system variable @param[in] var metric variable to un-register @par Purpose: Unregisters an english measurement system variable @param[in] var english variable to un-register @par Purpose: Resets the values of a previously registered variable @param[in] var variable to reset @par Purpose: Registers a variable @param[out] var pointer to the registered variable @param[in] metric_default metric value to set this variable to @param[in] english_default english value to set this variable to @par Purpose: Registers an metric measurement system variable @param[out] var pointer to the registered variable @param[in] default_value value to set this variable to @par Purpose: Registers an english measurement system variable @param[out] var pointer to the registered variable @param[in] default_value value to set this variable to @par Purpose: Resets the value of a previously registered variable @param[in] var pointer to the register variable to reset the value for @param[in] new_value new value to set this variable to @param[in] value_is_metric true if the variable is a metric variable; false if not @par Purpose: Pops a dialog prompting the user to change their current configuration @param[in] new_metric true if the measurement system is to be set to metric; false, and it's set to english @param[in] type_of_chg 0=show dialog, 1=units only, 2=all settings @param[in] regen true if the user selected to regenerate solids as a result; false if not @par Purpose: Reloads the current configuration file @param[in] forFileNew (Optional) true if we're reloading for file/new, otherwise false (the default) @par Purpose: Sets the working measurement system to metric @param[in] regen true if the user selected to regenerate solids as a result; false if not @par Purpose: Sets the working measurement system to english @param[in] regen true if the user selected to regenerate solids as a result; false if not @par Purpose: Sets the working measurement system @param[in] new_metric true if the measurement system is to be set to metric; false, and it's set to english @param[in] regen true if the user selected to regenerate solids as a result; false if not Convert value from Inch to Millimeters. The value in inches. The value in millimeters. Convert value from Millimeters to Inch. The value in millimeters. The value in inches. Checks if the working measurement system is metric. True if the system is metric; false if it is not. Checks if the working measurement system is NOT metric. True if the system is not metric; false if it is. Checks if the working measurement system is english. True if the system is english; false if it is not. @defgroup PockBound_Error_Codes Pocket Boundary Error Code Types @{ @} Checks if the working measurement system is NOT english. True if the system is not english; false if it is. Purpose: Calculates the direction and area of a pocket boundary @param[in] b The pocket boundary to examine @param[out] area The area of the input pocket boundary @returns true if the pocket is counter-clockwise, false if it's clockwise @par Purpose: Free a pocket boundary @param[in] b The pocket boundary to free @par Purpose: Free a linked list of pocket boundaries @param[in] b The list of pocket boundaries to free Test for duplicate pocket boundaries. Pocket boundary 1. Pocket boundary 2. Tolerance. Return true if all endpoints are duplicate. Purpose: Set the .pock_n (starting at 0) and .isl flags in pocket boundaries according to how boundaries are nested. @param[in] b_chnd boundaries used to check illegal pockets @param[in] delete_bad delete bad boundaries by checking against b_chnd @param[in] use_inters add intersecting islands to pocket boundary @param[in] lin_tol linearization tolerance (for dealing with boundaries that have a shared edge) @param[in,out] bounds boundaries with .pock_n and .isl set @param[out] n_pocks number of pockets Purpose: Converts a chain to a pocket boundary @param[in] chain The chained geometry to convert @param[in] lin_tol The linearization tolerance to use when converting @param[out] b The output pocket boundary @param[in] ViewNumber The output view number (0 = use current construction plane) @returns A standard pocketing error code (POCK_OK, etc.) Gets the graphic object associated with the selection object identified by the specified event. Selection object events are EM_SelObjSelect, EM_SelObjStart, EM_SelObjDrag, EM_SelObjEnd, and EM_SelObjButton. Event object containing a selection object event. Graphic object (invalid if wrong type of event or selection object not found). * @par Purpose: * Read the cursor position immediately and check for function keys (AutoCursor on) * * @param[in] cs Prompt string to display while waiting for the event ("*" to not display the prompt window) * @param[out] m_pos cursor position * @param[out] lbd true = left button down (drag events) * @param[out] click true = right button down (sketched a point) * @param[out] ch key pressed * @param[out] m_pt auto cursor point * @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not * @return The return code, of the MC_RETURN type, of the function @par Purpose: Read the cursor position immediately and check for function keys (AutoCursor off) @param[in] cs Prompt string to display while waiting for the event ("*" to not display the prompt window) @param[out] m_pos cursor position @param[out] lbd true = left button down (drag events) @param[out] click true = right button down (sketched a point) @param[out] ch key pressed @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function Select points graphically. Prompt to display to the user while waiting for point selection. True to allow, false to disallow sketch points. [in,out] The selected points. Any points provided to this function will be preselected. True if The user pressed Enter or clicked "End Selection" (could have selected zero points); false if the user pressed Esc. Select a single point graphically. Prompt to display to the user while waiting for point selection. True to exit immediately upon selection; false to wait for user to press "End Selection" button. True to allow, false to disallow a sketch point. [in,out] The selected point. If the parameter has a value when passed in, it will be preselected. True unless the user pressed Escape; note does not necessarily mean that a point has been selected. @par Purpose: Same as select_ents but ents are returned in order of selection. @param[out] idns Container containing entity id numbers of the selected entities @param[in] prompt Prompt string to display while waiting for the event ("*" to not display the prompt window) @param[in] entMask A combination of entity mask bit flag types for limiting selection (ie, L_ID, A_ID, SPLINE_ID, etc. 0 for default) @param[in] preSel A preselection flag value, of the MC_PRESEL type @param[in] bUseDL Flag that indicates use of display list or database when searching for selected ents. @param[in] bUpdate Flag that indicates to update idn array after each selection. @return The return code, of the MC_RETURN type, of the function Wait for the user to select a series of entities. Prompt string to display while waiting for the event ("*" to not display the prompt window) A combination of entity mask bit flag types for limiting selection (ie, L_ID, A_ID, SPLINE_ID, etc. 0 for default) Fills a provided bool with a true if the event was returned successfully; false if not (Optional) A preselection flag value, of the MC_PRESEL type (Optional) If non-null, the selected eptrs. (Optional) Flag that indicates use of display list or database when searching for selected ents. The return code, of the MC_RETURN type, of the function. Select ent discard commands. The create struct. [in,out] If non-null, the entity. [in,out] If non-null, the eptr. [in,out] The selected point. [in,out] If non-null, a double to process. The bit mask. The ent mask. The color. [in,out] If non-null, true to succf. An int. @} @par Purpose: Wait for the user to select an entity. @param[in] cs Prompt string to display while waiting for the event ("*" to not display the prompt window) @param[out] entity A pointer to the structure of the entity the user selected @param[out] eptr The eptr of the selected entity @param[out] sel_pt The position of the cursor upon entity selection, in view coordinates @param[out] t A pointer to the selected entity's t value (or values, depending on the entity type) @param[in] smask A combination of selection bit flag types for limiting selection (ie, ALIVE_BIT, etc. 0 for default) @param[in] emask A combination of entity mask bit flag types for limiting selection (ie, L_ID, A_ID, SPLINE_ID, etc. 0 for default) @param[in] s_color The integer value of the color to use for selected entities @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function @par Purpose: Reads the cursor position upon a user sketching a point @param[in] cs Prompt string to display while waiting for the integer event ("*" to not display the prompt window) @param[out] cursor_pos The cursor position, in view coordinates @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function @par Purpose: Wait for and then get user input of a polygon selection. The polygon selection is snappable on existing points. @param[in] cs Prompt string to display while waiting for the integer event ("*" to not display the prompt window) @param[out] corners The polygon corners beeing selected. In world coordinates @param[out] pSuccf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function @par Purpose: Wait for and then get user input of a window selection. The window selection is snappable on existing points. @param[in] cs Prompt string to display while waiting for the integer event ("*" to not display the prompt window) @param[out] corner1 The first corner beeing selected. In world coordinates @param[out] corner2 The second corner beeing selected. In world coordinates @param[out] pSuccf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function @par Purpose: Wait for and then get user input of a sketcher point being selected @param[in] cs Prompt string to display while waiting for the integer event ("*" to not display the prompt window) @param[out] pt_option Any point entry code values returned by the point selection (ie, PEC_SKETCH, PEC_ENDPOINT, etc.) @param[out] wpt The point selected by the user, in world coordinates @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function @par Purpose: Wait for and then get user input of a sketcher point being selected, projected onto the construction plane @param[in] cs Prompt string to display while waiting for the integer event ("*" to not display the prompt window) @param[out] pt_option Any point entry code values returned by the point selection (ie, PEC_SKETCH, PEC_ENDPOINT, etc.) @param[out] cpt The point selected by the user, projected onto the construction plane @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function @par Purpose: Wait for and then get user input of an integer, within the provided min and max constraints @param[in] cs Prompt string to display while waiting for the integer event ("*" to not display the prompt window) @param[in] minv Minimum value constraint on the input @param[in] maxv Maximum value constraint on the input @param[out] v Integer passed back upon some sort of user input @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function @par Purpose: Wait for and then get user input of an integer @param[in] cs Prompt string to display while waiting for the integer value event ("*" to not display the prompt window) @param[out] v Integer passed back upon some sort of user input @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function @par Purpose: Wait for and then get user input of a real, within the provided min and max constraints, with the dialog positioned near a given point @param[in] cs Prompt string to display while waiting for the real value event ("*" to not display the prompt window) @param[in] minv Minimum value constraint on the input @param[in] maxv Maximum value constraint on the input @param[in] pt Point where the dialog will be positioned beside @param[out] v Real passed back upon some sort of user input @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not @param[out] pOffset (Optional) Pointer to pixel offset of dialog from "pt". Default is (20, 20) - right 20, down 20. @return The return code, of the MC_RETURN type, of the function @par Purpose: Wait for and then get user input of a real, within the provided min and max constraints @param[in] cs Prompt string to display while waiting for the real value event ("*" to not display the prompt window) @param[in] minv Minimum value constraint on the input @param[in] maxv Maximum value constraint on the input @param[out] v Real passed back upon some sort of user input @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function @par Purpose: Wait for and then get user input of a real @param[in] cs Prompt string to display while waiting for the real value event ("*" to not display the prompt window) @param[out] v Real passed back upon some sort of user input @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function @par Purpose: Wait for a user input of a keyboard "space" hit @param[in] cstr Prompt string to display while waiting for the angle event (default is NULL) @return The return code, of the MC_RETURN type, of the function @par Purpose: Wait for and then get user input of an angle @param[in] cs Prompt string to display while waiting for the angle event ("*" to not display the prompt window) @param[out] v Angle passed back upon some sort of user input @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function @par Purpose: Wait for and then get user input of a string @param[in] cs Prompt string to display while waiting for the string event ("*" to not display the prompt window) @param[out] return_array The allocated array that will be filled with the string entered by the user @param[in] array_size The size of the TCHAR array allocated to recieve the resulting string @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function @par Purpose: Wait for and then get user input of a string @param[in] cs Prompt string to display while waiting for the string event ("*" to not display the prompt window) @param[out] str String passed back upon some sort of user input @param[out] succf Fills a provided bool with a true if the event was returned successfully; false if not @return The return code, of the MC_RETURN type, of the function @} Wait for and then get some sort of user input event. Prompt string to display while waiting for the event ("*" to not display the prompt window). Event data passed back upon some sort of user input. A combination of event mode bit flags for limiting input types (ie, EM_Select, EM_Point, etc.). A combination of entity mask bit flag types for limiting selection (ie, L_ID, A_ID, SPLINE_ID, etc. 0 for default). A combination of selection bit flag types for limiting selection (ie, ALIVE_BIT, etc. 0 for default). Fills a provided bool with a true if the event was returned successfully; false if not. (Optional) Function which specifies optional work to perform while the message pump is idle. This function should do minimal processing in most cases to avoid slowing down the application loop. The return code, of the MC_RETURN type, of the get_event function. @defgroup pre_sel_grp1 Preselection Bit Flag Values * @{ Are the select params dirty? True if select params are dirty, false if not. Sets select params dirty flag. Select params dirty flag. @par Purpose: This will free and redraw any point if necessary @param[in] pnt The point to clean @par Purpose: If the entity was not previously selected, this will clean the select bit and redraw the entity if necessary @param[in] entity The entity to clean @par Purpose: If the solid item was not previously selected, this will clean the item and redraw it if necessary @param[in] tag The tag of the solid item (body/face/edge) @par Purpose: If the eptr was not previously selected, this will clean the select bit and redraw the entity if necessary @param[in] eptr The eptr of the entity to clean Query if this event is cleaned. True if cleaned, false if not. Determines if we can hover notifications enabled. True if it succeeds, false if it fails. Enables the hover notifications. True to enable, false to disable. Removes all notify filter items. Adds a notify filter item. Notify filter item identifier. Removes a notify filter item. Notify filter item identifier. Does notify filter item exist in notify filter? Notify filter item identifier. True if it exists. Queries if the notify filter is active (size > 0) True if the notify filter is active, false if not. Setup fill drag. Search items (EM_Point/EM_Select/EM_SldBody/EM_SldFace/EM_SldEdge) (Optional) Visibility mask (-1=All Visible, 0=Everything). (Optional) Entity mask (EM_Select). Gets fill drag valid items mask. The fill drag valid items mask. Gets fill drag results mask. The fill drag results mask. Gets status of item in fill drag valid mask. Item to look for in valid mask. True if item in valid mask. Gets status of item in fill drag results. Item to look for in results. True if item in results. Sets fill drag valid items mask. The valid items mask. Sets fill drag results mask. The fill drag results mask. Gets fill drag visibility mask. The fill drag visibility mask. Gets fill drag entity mask. The fill drag entity mask. Gets fill drag event mode. The fill drag event mode. @par Purpose: Check if two events share the same item (entity or solid tag) @param[in] item The MCEvent to compare @return true if the events share the same item; false if not @par Purpose: Check if two point events share the location @param[in] item The MCEvent to compare @param[in] 3d true = CPlane, false = World @return true if the events share the location; false if not @par Purpose: Modify highlight of solid selection @param[in] enable true Add highlight, false Remove highlight @par Purpose: Copies MCEvent into another one @param[in] source The MCEvent to copy Copy constructor. The object. @par Purpose: Save selection and highlight states to event @par Purpose: Set selection and highlight states to before event status @param[in,out] pEntity entity (EM_Select only) @param[in] getEntity get entity from database (EM_Select only) @param[in] putEntity put entity to database (EM_Select only) @par Purpose: This will free and redraw anything that was used in this event type @par Purpose: Allocates memory for and copies the contents of the internal eptr array @param[out] ptr The output database entity pointer list @param[out] num The number of items output in the database entity pointer list @return True if the list was allocated and copied successfully; false if not @par Purpose: Fills the internal eptrArray with all entities matching a bit field @param[in] bits The active bit field with which to get entities @return The number of entities filled @par Purpose: Filter the internal eptrArray by entity id and selection mask @param[in] emask entity mask (L_ID, etc) @param[in] smask selection mask (SELECT_BIT, etc) @par Purpose: This method sets the select bits according to set_match. It clears the select bits that are set in clr_match. @param[in] set_match bits to set in .sel of selected entities @param[in] clr_match bits to clear in .sel of selected entities @param[in] clr_unmatched bits to clear in .sel of non-selected entities @param[in] draw true if the entities are to be redrawn Sets up the mesh facet event. The Mesh eptr. The facet index. The current position. The wParam field of the message. The lParam field of the message. @par Purpose: Sets up a selection object event @param[in] emode Event mode @param[in] selIdx Index of selection object @param[in] item selection item @return true if the event could be set up correctly @par Purpose: Sets up a triple-click event @param[in] cur_pos The initial cursor position @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a double-click event @param[in] cur_pos The initial cursor position @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a drag event @param[in] cur_pos The initial cursor position @param[in] lbd The initial left-button-down state @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a multiple-input event @param[in] wp The wParam value @param[in] lp The lParam value @return true if the multiple-input event could be set up correctly @par Purpose: Sets up a windowing event @param[in] cip1 The first corner @param[in] cip2 The second corner @param[in] rect The CRect boundaries @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a vector event @param[in] vertices The vertices of the polygon @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a polygon event @param[in] vertices The vertices of the polygon @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a function panel event @param[in] cmd The command ID to set the event up for @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a notify event @param[in] cmd The command ID to set the event up for @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a command event @param[in] cmd The command ID to set the event up for @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a key up event @param[in] key The key value to set the event up for @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a key event @param[in] key The key value to set the event up for @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a sketching event @param[in] ap An initial auto-cursor point @param[in] cur_pos The initial cursor position @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a solid event @param[in] hit The initial parasolid hit structure @param[in] cur_pos The initial cursor position @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a selection event @param[in] e An initial entity @param[in] t Initial t values @param[in] cur_pos The initial cursor position @param[in] selb4 true if the entity was previously selected @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a selection event @param[in] eptr An initial entity's eptr @param[in] t Initial t values @param[in] cur_pos The initial cursor position @param[in] selb4 true if the entity was previously selected @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a point event @note For a pmesh point, the 1st tag is the facet index; the 2nd tag is the node index [0, 2]. @param[in] ap An initial auto-cursor point @param[in] cur_pos The initial cursor position @param[in] tags Solid/pmesh tag(s) associated with the point ({0, 0} if none) @param[in] wp The wParam value @param[in] lp The lParam value @par Purpose: Sets up a point event @param[in] ap An initial auto-cursor point @param[in] cur_pos The initial cursor position @param[in] wp The wParam value @param[in] lp The lParam value Sets the point members - does not set m_ap. The world point. Gets second param select value. The second param select value. Gets first param select value. The first param select value. Sets param selection values. The first param select value. The second param select value. (Optional) True to dirty param select flag. @par Purpose: Frees all the memory associated with the current event @par Purpose: Set solid pick member @par Purpose: Get solid pick mask setting for type @par Purpose: Standard destructor @par Purpose: Standard constructor Alternate constructor. The pattern method. The Boolean type. The pattern type. The view matrix. Default constructor. Solid Patern operation parameters Alternate constructor. The fillet type. The hold line type. The radius. The width. The ratio. True to propagate along tangencies. True if curvature continuous. Default constructor. Alternate constructor. The method. The plane identifier. The plane point. The plane normal. The surf eptr. True to reverse surface. True to parent surface. True to associated to plane. Default constructor. Solid Trim operation parameters Solid Trim operation parameters for X6 - X7 Solid Trim operation parameters Alternate constructor. The draft method. The plane identifier. The draft angle. The draft direction. The plane to use when method = SLD_DRAFTFACE_CPLANE. True to propagate along tangencies. True to reverse normal flag. True to associated to new plane. Default constructor. Solid Draft Face operation parameters Alternate constructor. The creation type. The body eptr. Default constructor. Solid Sweep operation parameters (pre-v2018) Alternate constructor. The creation type. The body. The alignment. The direction locking. The twist type. The twist angle. Default constructor. Solid Sweep operation parameters Alternate constructor. The solid body. The thinwall parameters. Default constructor. Solid Shell operation parameters Alternate constructor. The thinwall parameters. True to flip flag. Default constructor. Solid Thicken operation parameters Alternate constructor. The creation type. The body eptr. True to create a ruled surface. Default constructor. Solid Loft operation parameters Primitive solid operation parameters Primitive solid torus operation parameters Primitive solid shpere operation parameters Primitive solid cylinder operation parameters Primitive solid cone operation parameters Primitive solid block operation parameters Solid Loop selection structure Alternate constructor. The chamfer method. The distance 1. The distance or angle 2. True to miter corners. True to propagate along tangencies. Default constructor. Solid Chamfer operation parameters Solid Selection 'Hit' structure Alternate constructor. The creation type. The body. The axis eptr. The axis parameter. The start angle. The end angle. True to reverse direction. The thinwall parameters. True to flip outward direction. Default constructor. Solid Revolve Parameters Alternate constructor. The creation type. The body eptr. The distance method. The distance. The direction. True to use local Boolean for boss/cut. True to reverse direction. True to extrude in both directions. True to split draft. The draft parameters. The thinwall parameters. True to draft endpoints of open chains. True to flip outward direction. Default constructor. Solid Extrude Parameters Alternate constructor. True to do thin wall. The thick method. The thickness. The thickness out. Default constructor. Solid Thinwall Parameters - used in Solid Extrude, Revolve, etc. Alternate constructor. True to draft while extruding. True to draft outward. The draft angle. Default constructor. Solid Draft Parameters - used in Solid Extrude Parameters Defines an alias representing a vector of the solid fillet variable radius instance vector. Defines an alias representing the solid fillet variable radius instance vector. Constructor to initialize struct. A solid fillet variable radius instance. Solid Fillet Parameters - used in Solid Fillet functionality @} @defgroup draft_methods Draft methods * @{ @} @defgroup solid_trim_methods Solid Trim operation methods * @{ @} @defgroup solid_fillet_methods Solid Fillet methods * @{ @} @defgroup solid_fillet_overflow_methods Solid Fillet Overflow methods * @{ @} @defgroup face_face_fillet_types Solid Face-Face Fillet methods * @{ @} @defgroup face_face_fillet_holdline_types Solid Face-Face Fillet HoldLine types * @{ @} @} @defgroup sweep direction locking options * @{ @} @defgroup sweep direction locking options * @{ @} @defgroup sweep alignment options * @{ @} @defgroup pattern_type patterning method * @{ @} @defgroup boolean_operations Method for specifying boolean operation * @{ @par Purpose: Finds the determinant of the matrix @param[in] p1 point 1 @param[in] p2 point 2 @param[in] p3 point 3 @return The determinant of the matrix @par Purpose: Reverse array of 3D points from start index to stop index @param[in] num number to be reversed @param[in,out] pArray array being reversed @par Purpose: Reverse array of 2D points from start index to stop index @param[in] num number to be reversed @param[in,out] pArray array being reversed @par Purpose: Reverse array of reals from start index to stop index @param[in] num number to be reversed @param[in] dim number per index @param[in,out] array array being reversed @par Purpose: Find the unit normal to two vectors @param[in] tu the tangent in U direction @param[in] tv the tangent in V direction @param[out] norm normal @param[in] zeroToler optional - The tolerance to compare for close to zero length result. global variable "tol" (5.e-5) by default (historically) @return Error code UnitNormal error codes. @par Purpose: Finds curvature from first and second derivatives. @note This is the real geometric curvature ie the radius of curvature is its reciprocal. This is not the same as the 'parametric curvature'which can be used more efficiently for chord height checks. @param[in] v first derivative = V @param[in] a second derivative = A @return The curvature value @return true = pt lies on ent @param[in] pt a 2d point @param[in] entity a 2d entity @param[in] loc_tol maximum distance point may lie beyond entity @par Purpose: Determine whether a point actually lies on an entity. @return true = pt lies on ent @param[in] pt a 2d point @param[in] entity a 2d entity @par Purpose: like ints_on_gt except intersection may lie beyond end of entity by loc_tol @param[in] ent1 entity 1 to intersect @param[in] ent2 entity 2 to intersect @param[in] bias_pt bias point @param[out] inters The intersection(s) that lie on both entities @param[out] n_inters Number of intersections found @param[in] loc_tol max. distance between ent1 and ent2 @param[out] succf true = ent1 and ent2 intersect @par Purpose: Find the intersection of two entities, insuring that the intersection lies on both entities @param[in] ent1 entity 1 to intersect @param[in] ent2 entity 2 to intersect @param[in] bias_pt bias point @param[out] inters The intersection(s); that lie on both entities @param[out] n_inters Number of intersections found @param[in] loc_tol max. distance between ent1 and ent2 @param[out] succf true = ent1 and ent2 intersect @par Purpose: Finds the intersection points of two circles whose center and radius are specified by arc1 and arc2. Returns the intersection points in p1 and p2. Sets succf to false if the circles are concentric or do not intersect. Allows for tangent circles (to within a distance of loc_tol); @par Globals: [in]loc_tol maximum allowable distance between arc1 and arc2 @param[in] arc2 second arc to intersect @param[out] p1 intersection point @param[out] p2 intersection point @param[out] succf true = arc1 and arc2 intersect @param[in] arc1 first arc to intersect @par Purpose: Find the intersections of a 2d line and a 2d arc @param[in] line The line to intersect @param[in] arc The arc to intersect @param[out] p1 The first intersection point @param[out] p2 The second intersection point @param[out] succf true = p1 and p2 are valid @par Purpose: Break an arc into points that lie on the endpoints or quadrants and put them in forward or reverse order @param[in] arc The arc to break @param[in] n_pieces Number of pieces to break arc into @param[in] reversed true = put points in reverse order @param[out] points Array of points where the arc was broken @param[out] n_points Number of points in the points array @par Purpose: Solves the equation Ax = b, or x[1] a1 + x[2] a2 = b, where a1, a2 and b are vectors @param[in] a1 column 1 of matrix @param[in] a2 column 2 of matrix @param[in] b column vector on right hand side of equation @param[out] x solution of x1[1] * a1 + x[2] * a2 = b @param[out] succf true = a1 and a2 are not parallel @par Purpose: Determines whether a point lies on a line @param[in] pt a 2d point @param[in] line a 2d line @return true = point is near the line @par Purpose: Find the distance from a point to a line. If the projection of the point lies off the line, find the distance from the point to the nearest endpoint. Return false if the distance is greater than or equal to max_dist. @param[in] pt a 2d point @param[in] line a 2d line @param[in] max_dist @param[out] dist @param[out] succf @par Purpose: Determines whether a point lies on a line @return true = pt lies between line's endpoints @param[in] pt the 2d point in question @param[in] line the 2d line in question @par Purpose: Determines whether a point lies on a line. @note Identical to pt_on_line except with pt_on_line2 a point that lies on the endpoint of the line is considered to lie on the line. @return true = pt lies on the line @param[in] pt the 2d point in question @param[in] line the 2d line in question @par Purpose: Create an arc that passes through two points and is tangent thru a vector passing thru the 1st pt @par Purpose: Create an arc that passes through three points @param[in] p1 point 1 on arc @param[in] p2 point 2 on arc @param[in] p3 point 3 on arc @param[out] arc a 2d arc @param[out] valid_arc true = arc is valid Constructs an arc that may have a negative sweep. The advantage is that there is no need for a "reversed" flag. First endpoint. Second endpoint. Center point of the arc. True if arc portion desired is clockwise from start_pt to end_pt (arc sweep will be negative in this case). Maximum deviation between r1 and r2. General system tolerance. Output arc. True if the arc was successfully created, and false otherwise. @par Purpose: Construct an arc that may have a negative sweep. The advantage is that there is no need for a "reversed" flag @param[in] pt1 Endpoint 1 @param[in] pt2 Endpoint 2 @param[in] center Centerpoint of the arc @param[in] cw Arc portion desired is clockwise from start_pt to end_pt (arc sweep will be negative in this case) @param[in] loc_tol Tolerance @param[out] arc The arc that's created @param[out] succf true = Success; false = Failed Constructs an arc from the given start point, end point, center point, and arc direction. Start point. End point. Center point. True if arc portion desired is clockwise from start_pt to end_pt (note that this method always returns and arc with a positive sweep though). Maximum deviation between r1 and r2. General system tolerance. Output arc. True if it succeeds, false if it fails. @par Purpose: Given the end point, center, and direction of a circle (360 degree arc);, reconstruct it @param[in] end_pt final point @param[in] center center @param[in] cw true = CW @param[in] min_radius minimum arc radius @param[out] arc the arc @param[out] succf true if arc radius >= min_radius @par Purpose: Given the start point, end point, center, and direction of an arc, reconstruct it @param[in] start_pt Start point @param[in] end_pt End point @param[in] center Centerpoint of the arc @param[in] reversed Reversed? @param[out] arc The arc that's created @param[out] succf true = Success; false = Failed @par Purpose: Find twice the area of a polygon (trapezoid) defined by p1, p2 and two vertical lines. @param[in,out] area Adds the area found to this number @param[in] p1 Endpoint of first vertical line @param[in] p2 Endpoint of second vertical line @par Purpose: Get the endpoints of a line or arc. @param[in] g The line or arc to calculate the endpoints of @param[out] pt The endpoints @return Unused (returns 0) @par Purpose: Get an endpoint of a line or arc , or return the location of an entity point @param[in] ent2 The line or arc @param[in] is_near true returns the near endpoint, false returns the far endpoint @param[out] ep The resulting endpoint @return 0 is successful; 1 if the entity was not of one of the given types @par Purpose: Convert parameter value to point on an arc. @param[in] t The parameter input @param[in] a The arc from which to calculate our point @param[out] p The point on the arc represented by the inputs @par Purpose: Convert a parameter value to point on a line. @param[in] t The parameter input @param[in] l The line from which to calculate our point @param[out] p The point on the line represented by the inputs Offsets a 2d line. Line to offset. Offset distance. Point to offset line towards. Resulting line which was offset. General system tolerance. True if the bias does not lie on the line. @par Purpose: Offset a 2d line @param[in] line The line to offset @param[in] dist The distance to offset line @param[in] bias A point to offset line towards @param[out] line1 line offset by dist @param[out] succf true if bias does not lie on line @par Purpose: Find the "intersection" (the point on each line closest to the other line); of two 3d lines @param[in] line1 The first line to intersect @param[in] line2 The second line to intersect @param[out] inters1 The point on line1 closest to line2 @param[out] inters2 The point on line2 closest to line1 @param[out] succf Success/Fail @par Purpose: Finds the point of projection of a point in space onto a plane. @param[in] N The plane's normal @param[in] plane_pt Any point in the plane @param[in] point The point to project @param[out] inters The intersection of the line and the plane @param[out] t The parameter value corresponding to inters @param[out] succf Success/Fail @par Purpose: Finds the intersection of a line and a plane @param[in] N The plane's normal @param[in] plane_pt Any point in the plane @param[in] line The line to intersect @param[out] inters The intersection of the line and the plane @param[out] t The parameter value corresponding to inters @param[out] succf Success/Fail Finds an intersection point of two 2d lines if one exists. First line. Second line. Intersection point. Resulting parameter value. Resulting parameter value. General system tolerance. True if an intersection point was found, and false otherwise. @par Purpose: Intersect two 2d lines @param[in] l1 The first line @param[in] l2 The second line @param[out] inters The intersection point @param[out] t1 parameter value @param[out] t2 parameter value @param[out] succf Success/Fail @par Purpose: Find the t parameter on a 2d line or arc given a point @param[out] t The parameter corresponding to the "projected" point @param[in] pt The point to "project" @param[in] ent_gt The entity to "project" onto @par Purpose: Find the t parameter on an arc given a point @param[out] t The parameter value corresponding to the projected point @param[in] pt The point to "project" @param[in] arc The arc to "project" onto Finds the t parameter value on a 2d line given a point. Point to project. Line to project onto. General system tolerance. Parameters corresponding to the projected point. @par Purpose: Find the t parameter on a 2d line given a point @param[out] t The parameter corresponding to the projected point @param[in] pt The point to "project" @param[in] line The line to "project" onto @par Purpose: Project a point onto a line or arc @param[in] pt The point to project @param[in] gen_obj The line or arc to project onto @param[out] pr_pt The projected point @param[out] succf Success/Fail @par Purpose: Project a 2d point onto a 2d arc @param[in] pt The point to project @param[in] arc The arc to project onto @param[out] pr_pt The projected point @param[out] succf True if length (pt - arc center); > tol @par Purpose: Project a 3d point onto a 3d line @param[in] pt The point to project @param[in] line The line to project onto @param[out] proj_pt The projected point @param[out] t The parameter (0 = line->e1, 1 = line->e2); @param[out] succf True if line length > tol @par Purpose: Form a 3d line from its 3d endpoints @param[out] line Endpoints are set to p1 and p2 @param[in] p2 Point 2 @param[in] p1 Point 1 @par Purpose: Form a 2d line from its 2d endpoints @param[out] line Endpoints are set to p1 and p2 @param[in] p2 Point 2 @param[in] p1 Point 1 @par Purpose: Extract the x, y components from a 2d vector @param[in] vector vector @param[out] x x output @param[out] y y output @par Purpose: Given a 2d vector, rotate it 90 degrees. @param[in] vector original vector @return left hand vector @par Purpose: Given a 2d vector, rotate it -90 degrees. @param[in] vector original vector @return right hand vector @par Purpose: Restrict an angle between two values by adding or subtracting two pi @param[in] min_angle minimum angle allowed (radians); @param[in] max_angle maximum angle allowed (radians); @param[out] angle angle forced @par Purpose: Rotate a 2d point about another 2d point given the cosine and sine of the rotation angle @param[in] pt The point to rotate @param[in] center The point to rotate about @param[in] cos_t cos (rotation angle); @param[in] sin_t sin (rotation angle); @param[out] rotated_pt The rotated point @par Purpose: Return the length of a 2d line or 2d arc @return The length of the line or arc @param[in] ent The 2d line or arc to calculate the length of @par Purpose: Copy a 3d point @param[out] pt_out The array to copy to @param[in] pt_in The array to copy from Measures the amount of overlap (within given radius) between two line segments in 3D wrt the first line segment (A). I: The first end-point of line segment A. I: The second end-point of line segment A. I: The first end-point of line segment B. I: The second end-point of line segment B. I: The maximum overlap radius. O: The first parameter of the overlap interval (corresponding to line segment A). O: The second parameter of the overlap interval (corresponding to line segment A). True if overlap is detected. @par Purpose: Find the point rotated about a point and a unit directional vector @param[in] pt 3d point @param[in] pt0 fixed point @param[in] axis unit axial vector @param[in] angle angle of rotation in radians @return rotated 3d point @par Purpose: Find the components of one vector rotated about a unit directional vector @param[in] v 3d vector @param[in] axis unit axial vector @param[in] angle angle of rotation in radians @return rotated 3d vector @par Purpose: Determine if two 3d vectors are parallel @param[in] v1 First vector @param[in] v2 Second vector @return true = parallel, false = non-parallel @par Purpose: Find the components of one vector w.r.t. a unit vector @param[in] v first 3d vector @param[in] u unit 3d vector @param[out] perpUVec component of V perpendicular to U @param[out] dirUVec component of V in direction of U @par Purpose: Form a 3d vectors from its x, y, z components @param[in] x x component @param[in] y y component @param[in] z z component @param[out] pt components set to x, y, and z @par Purpose: Form a 2d vector from its x, y components @param[out] vector components set to x and y @param[in] x x component @param[in] y y component @par Purpose: Find the angle formed by two 3d vectors @param[in] vec1 first 3d vector @param[in] vec2 second 3d vector @return Angle formed by the vectors (radians); @par Purpose: Find the angle formed by a 2d vector @param[in] vec a 2d vector @return Angle, in radians, formed by vec (equivalent to [0,360] degrees) @par Purpose: Copy a 2d point @param[out] pt_out The array to copy to @param[in] pt_in The array to copy from @par Purpose: Copy a 2d point @param[out] pt_out The array to copy to @param[in] pt_in The point to copy from @par Purpose: Project a 2d point onto a line @param[in] pt The point to project @param[in] line The line to project onto @param[out] pr_pt The projected point @param[out] t The parameter (0 to 1); @param[out] succf true if line has non-zero length @par Purpose: Determines whether a point lies on a line @return true = pt lies between line's endpoints @param[in] pt the 2d point in question @param[in] line the 2d line in question @par Purpose: Find the intersection points of two circles whose center and radius are specified by arc1 and arc2. Return the intersection points in p1 and p2. Set succf to false if the circles are concentric or do not intersect. Allow for tangent circles (to within a distance of tol); @param[in] arc1 first 2d arc to intersect @param[in] arc2 second 2d arc to intersect @param[in] loc_tol maximum allowable distance between arc1 and arc2 @param[out] p1 first intersection @param[out] p2 second intersection @param[out] succf true = p1 and p2 are valid @par Purpose: Offset a 2d line @param[in] line The line to offset @param[in] dist The distance to offset line @param[in] bias A point to offset line towards @param[out] line1 line offset by dist @param[out] succf true if bias does not lie on line @par Purpose: New version of gp_ints with the input loc_tol Find the intersection of a line or arc with a line or arc. @param[in] object1 2d line or arc @param[in] object2 2d line or arc @param[in] bias_pt bias point @param[in] loc_tol max distance between object1 and object2 @param[out] near_inters intersection closest to bias_pt @param[out] far_inters intersection furthest from bias_pt @param[out] succf true = object1 and object2 intersect @par Purpose: Determine whether a point is within loc_tol of a finite arc, based on a distance and angle test. @return pt lies on arc @param[in] pt a 2d point @param[out] arc a 2d arc @param[in] loc_tol local tolerance for closeness @par Purpose: Determine whether a point actually lies on an entity. @return true = pt lies on ent @param[in] pt a 2d point @param[in] entity a 2d entity @par Purpose: This method computes the endpoints of a 3d arc @param[in] arc the arc to analyze @param[in] mat An nxm matrix @param[out] ep1 the endpoint corresponding to sa (first endpoint) @param[out] ep2 the endpoint corresponding to sa_sw (second endpoint) @par Purpose: Find the endpoints of a 2d arc @param[in] arc a 2d arc @param[out] p1 the endpoint corresponding to sa @param[out] p2 the endpoint corresponding to sa + sw @par Purpose: Find the t parameter on a 2d line given a point @param[out] t The parameter corresponding to the projected point @param[in] pt The point to "project" @param[in] line The line to "project" onto @par Purpose: New version of la_ints. Finds the intersections of a line and an arc @param[in] line a 2d line to intersect @param[in] arc a 2d arc to intersect @param[in] loc_tol maximum allowable distance between line and arc @param[out] p1 first intersection @param[out] p2 second intersection @param[out] succf true = p1 and p2 are valid @par Purpose: Intersect two 2d lines @param[in] l1 The first line @param[in] l2 The second line @param[out] inters The intersection point @param[out] t1 parameter value @param[out] t2 parameter value @param[out] succf Success/Fail Set the default parts folder for current version part files. The new default folder. Return the default folder for current version part files, as listed in config. The default parts folder. Calculates an ellipse in world(top) plane. The X axis radius. The Y axis radius. The start angle in degrees. The end angle in degrees. The rotation angle in degrees. The center point in world coordinates. The resulting entity (not stored) . true if it succeeds, false if it fails. @par Purpose: Create geometry from a drafting entity (note, dimension, witness, or leader). @param[in] entity drafting entity @note new entities will have current construction color, level, style @par Purpose: Calculate a vector from the arrowhead tip to a point along arrow's leader line. @param[in] wl witness leader line to use @param[in] view view number of the current view @param[out] vv the resulting line, in view coordinates @note Depth: DfCIRCULAR = arc[Z] (in view), DfLEADER = 0.0 @return true if vector was created successfully; false if not Initializes (all zero) letters data structure. The letters data. The letters data. Calculate font number from letters id. The letters id. The font number. Calculate letters mode from letters id. The letters id. The letters mode. @defgroup draft_ch2 Arrow Defines @{ @} Letters modes. @par Purpose: Frees any memory that was allocated for the entity. @param[in] entity entity to free alllcations from @param[in] purge should only be set to true when called by database cleanup @note This function must be called when an entity is no longer needed anytime \n an entity is aquired via read_ent() or read_ent_from_disk() and the entity \n is not stored in the database via store_ent(). @par Purpose: Compare array size to array allocated, inform user if too big. @return returns true => OK false=> required size could not be allocated\n message sent to user if false @param[in] entity entity to check @par Purpose: Return True if bit in entity.sel is ON. False if OFF. @param[in] sel The sel short @param[in] sel_bit The selection bit to check @return true = bit in entity.sel is on @par Purpose: Return True if bit in entity.sel is OFF. False if ON. @param[in] sel The sel short @param[in] sel_bit The selection bit to check @return true = bit in entity.sel is off @par Purpose: Set bit in entity.sel OFF. @param[in,out] sel The sel short @param[in] sel_bit The sel bit to turn off @par Purpose: Set bit in entity.sel ON. @param[in,out] sel The sel short @param[in] sel_bit The sel bit to turn on @par Purpose: Return True if bit in entity.sel is OFF. False if ON. @param[in,out] entity The entity to modify @param[in] sel_bit The sel bit check @return true = bit in entity.sel is off @par Purpose: Return True if bit in entity.sel is ON. False if OFF. @param[in,out] entity The entity to modify @param[in] sel_bit The sel bit check @return true = bit in entity.sel is on @par Purpose: Set bit in entity.sel OFF. @param[in,out] entity The entity to modify @param[in] sel_bit The sel bit to turn off @par Purpose: Set bit in entity.sel ON. @param[in,out] entity The entity to modify @param[in] sel_bit The sel bit to turn on @par Purpose: Allocate RAM for spline coefficients @par Globals: [in] spline_data_ptr_index to 0 or 1 @param[in] required if !0 then it is the required size needed to allocate @param[out] sp sp.c_ptr set to spline_data_ptr [1] or spline_data_ptr [2] @par Purpose: Allocate RAM for surface array pointers @par Globals: [in] spline_data_ptr_index to 0 or 1 @param[in] required if !0 then it is the required size needed to allocate @param[out] psf surf.s_ptr set to surf_data_ptr [0] or surf_data_ptr [1] @par Purpose: Allocate RAM for nurbs data @par Globals: [in] spline_data_ptr_index to 0 or 1 @param[in] required if !0 then it is the required size needed to allocate @param[out] pnb set nb.c_ptr to spline_data_ptr [0] or spline_data_ptr [1] @par Purpose: Return the number of bytes used by one entity @param[in] entity entity to be checked @param[in] code 1=>base entity 2=>arrays 3=>base plus arrays @par Purpose: Calculate and return the ent.eptr.arMax value for varaible length data in an entity @param[in] arBytes Number of bytes we need @par Purpose: This is a shortcut to terminate the current Undo transaction (if one is active) and start a new transaction.. @par Purpose: Inquire if logging of undoable changes is enabled. @return Returns true if logging of undoable changes is enabled. @par Purpose: Disables logging of undoable changes in the active Undo transaction. @return true if undo was disabled successfully @par Purpose: Enables logging of undoable changes in the active Undo transaction. @note This is only required if undo_disable ahs been called while an Undo transaction is active. @return true if undo was enabled successfully @enum UndoSpecialWhat * Defines possible values of what_happened in put_special_undo() @par Purpose: Starts a new Delete undo transaction. The transaction is completed by calling UndoTransCommit() or UndoTransTerminate(). @return true if the Undo Transaction was started successfully @par Purpose: Ends a Xform undo transaction. @param[in] moving are we moving geometry vs. copying @return true if an Undo Transaction was committed. @par Purpose: Pops the last transaction off of the Redo Stack. @par Purpose: Redoes the last transaction event. @param[in] notifyUserApp Notifies user applications via MCEVENT_REDO @return true if the transaction was redone successfully. @par Purpose: Undoes the last transaction event. @param[in] notifyUserApp Notifies user applications via MCEVENT_UNDO @param[in] silentGraphics (optional) true = don't update graphics, false = default @return true if the transaction was undone successfully. @par Purpose: Starts a new Xform undo transaction. The transaction is completed by calling UndoXformTransCommit() or UndoTransTerminate(). @return true if the Undo Transaction was started successfully. Queries if the UndoEventActive is true and if the current undo is a transform undo. True if UndoEventActive is active and transform, false if not. Queries if the UndoEventActive is true. True if UndoEventActive is active, false if not. @par Purpose: Query to see if an Undo transaction is currently active. @return Returns true if Undo transaction is currently active @par Purpose: Ends the undo transaction, removes it from the undo stack, and rolls back any changes that were made to the database during this transaction. @par Purpose: Ends the undo transaction and keeps it on the undo stack. If the transaction was initiated by UndoSolidTransStart() the database changes will be maintained but the transaction will be removed from the undo stack. @file DbUndo_CH.h * Unlimited Undo/Redo functions. * Unlimited Undo/Redo requires several new functions, some of which * replace old V9 functions. Some of the old V9 functions have been * retained but in most cases they do something slightly different. * Please refer to "Unlimited Undo-Redo API.doc" for more detailed * documentation on the use of these functions. @par Purpose: Starts a new undo transaction. The transaction is completed by calling UndoTransCommit() or UndoTransTerminate(). @return true if the Undo Transaction was started successfully @par Purpose see if an arc connects to an existing arc and join them if possible @param[in,out] testArc The arc to see if it connects to another arc @param[in] retEptr The eptr of the new arc if it does connect @return true = the arc connected to another arc @par Purpose Fills out entries (.t1, .t2, .e1, .e2, .max_curv) in sp and puts it in the database. @param[in] sp The spline to put in the database @param[in] n_segs The number of spline segments @param[in] color The spline's color @param[in] level The spline's level @param[in] closed1 True if the spline is closed @param[in] blank The set blank bit flag @param[out] d_ptr The entity creation number @par Purpose: Add a surface to the database. @param[in] psf surface to be stored @param[in] color make it this color @param[in] level put it on this level @param[in] blank set blank bit flag @param[out] d_ptr location in db @par Purpose: Fill out entries in nurbs record and add to database. @param[in] nb nurbs to be stored @param[in] color make it this color @param[in] level put it on this level @param[in] att give it these attributes @param[in] blank set blank bit flag @param[out] d_ptr location in db @param[in] checkKnots true to check and fix knot sequence problems if found Copies an entity (except ClassEnt) by making a shallow copy of the ent structure and points that copy to a shallow copy of the entity's variable length auxiliary data buffer which allows the buffer to be independent of database allocation. Note that the entity copy is shallow (except the new auxiliary buffer allocation) so depending on the use case, the entity copy may need to be further modified if it need to point to other resources (associated entities, etc.). For example, creating a copy of a trim surface does NOT create a copy of the base surface and the shallow copy of the trim surface still points to the same base surface as the original. Entity to copy. Copy of the entity, or null if the input entity is a ClassEnt. Ent-based entity data together with a buffer which stores the entity's variable length auxiliary data. @par Purpose Inquire whether "SaveSome" is the current state of File/Save @return true = File/Save will do a "SaveSome" @par Purpose Set whether or not "SaveSome" is to be the current state of "File/Save" @par Purpose Indicate whether the database has changed @return true = database has changed @par Purpose * Mark the database as having changed. See has_db_changed @par Purpose * Set an internal variable indicating that the database has not been modified @par Purpose: Rewrite an entity to the database (ram or disk) @param[in] entity The entity @param[in] sysFlags Optional flags to permit writing of "system level data" (zero by default) @par Purpose: Fill out an entity record given a database pointer @param[in] ptr The database pointer @param[out] entity The entity Opens the specified file up as the current session, invokes the supplied action, saves the file, and restores the current session. This function will set the current application states to be reflective of the specified file, and so the supplied action should call functions as if working with the current part file. The changes will be saved out when the action completes. Global variable states (i.e. main_level) should be locally cached before being accessed within the supplied action. If the supplied filepath points to a file that is not a valid Mastercam part file, this function will do nothing. The function should return a value indicating whether the file should be saved after the action concludes, allowing the avoidance of saving partial changes if something goes wrong during the action. Full pathname of the part file to modify. The action. (Optional) True to issue a warning to the user if the file is not a current version part file. True if it succeeds, false if it fails. Opens the specified file up as the current session, invokes the supplied action, and restores the current session. This function will set the current application states to be reflective of the specified file, and so the supplied action should call functions as if working with the current part file. The changes will NOT be saved out when the action completes. Global variable states (i.e. main_level) should be locally cached before being accessed within the supplied action. If the supplied filepath points to a file that is not a valid Mastercam part file, this function will do nothing. Full pathname of the part file to read. The action. True if it succeeds, false if it fails. Iterate over the given part file until the end of the file is reached or the supplied processor function returns false on the 'continueIteration' parameter. This function replaces the conventional approach of reading entities by entities in the part file. Loaded entities will be handed to the supplied processor, and then will be cleaned up before the iteration continues. In the function being supplied, iteration can be discontinued or allocation freeing can be prevented should the loaded entities need to be captured for ownership elsewhere. The MCFile instance. Must be opened prior to calling this function. The function to be used to process entities in the file and communicate back how to proceed. Encapsulates the result of an iteration processor. @par Purpose: loop through all entities in the database to find anything on a level @param[in] chkvis If true, checks if entity is visible @param[in] ptr The database pointer @param[in] found_ptr The pointer to the entity @param[in] entity The entity @param[out] succf true if entity is found @par Purpose: Get the next "ALIVE" entity from the database @param[in] chkvis If true, checks if entity is visible @param[in] ptr The database pointer @param[in] found_ptr The pointer to the entity @param[in] entity The entity @param[in] sel_mask The selection mask @param[in] ent_mask The entity mask @param[out] succf true if entity is found Rewrite the .sel and .id field of an entity to the database. The pointer to the entity. @par Purpose: Write the .sel and .id field of an entity to the database (ram or disk) given the entity and a pointer @param[in] entity The entity @param[in] ptr Pointer to where the entity is stored in the database Chokepoint for gr_back_color. Pointer to ent structure. Pointer to ent in database list. New selection bits. New entity level. New attributes. Flag pointer indicating success of operation. @par Purpose: Save any type of entity in the database @param[in] entity The entity @param[out] d_ptr Database pointer where entity is written to @param[in] new_sel New selection bits @param[in] new_color New entity color @param[in] new_level New entity level @param[in] new_attrib New attributes @param[out] succf true = Success; false = Failed @param[in] draw (optional) true = draw entity (default); false = don't draw entity @par Purpose Adjust entity attributes to current global settings @param[in,out] entity Attributes set to global attributes @return true = entity changed Resets state of static objects in the DLL. For example, the color registry used by stock model is reset here. The color key registry allows stock-model operations to change the color without having to regenerate them. This call should be made when creating a brand new blank part. @par Purpose * Initialize database @par Purpose Is the entity pointer valid? @param[in] eptr The entity pointer @param[in] allow_deleted If true, consider entities in the deleted stack to be valid. @return true = eptr is valid. Query if drafting 'entity' is using GAF style text. The entity. True if using GAF style text, false if not. Gets the leaders from label. The label. The leaders. True to return only valid leaders. Gets annotation data from entity. The entity. True if annotation, false if not. Query if 'entity' is annotation. The entity. Return true if pointer failure. True if annotation, false if not. @par Purpose: Fetch entity using entity pointer @return 0=>OK 1=>null ent * @param[in] eptr entity pointer @param[out] entity found entity Get a visible, unmasked (not excluded by the level mask) entity according to sel_mask and ent_mask, and optionally color, level or style. If sel_method is 1, only sel_mask and ent_mask are used. If sel_methodis 2, sel_mask, ent_mask and color are used. If sel_method is 3, sel_mask, ent_mask and level are used. If sel_method is 4, sel_mask, ent_mask, and style are used. @param[in] s The selection mask @param[in,out] ptr The current position in the database @param[out] found_ptr The pointer to entity @param[out] entity The entity @param[in] sel_mask The selection mask @param[out] succf true if entity found Get the next visible unmasked entity from the database. If an entity is found, found_ptr will point to the entity and ptr will point to the next position in the database. If the end of the database is reached, succf is returned as false. @verbatim The selection mask, sel_mask, is defined as any combination of the following bits: #define ALIVE_BIT 1 bit 0 - cleared when entity is deleted ... The entity mask ent_mask is defined as any combination of the following bits: #define P_ID 1 Point (bit 0) ... If entity->id is set to DB_ID, then entity->db_fn is defined as follows: #define V_MATRIX_FN 0 View matrix ... Surface types: #define NB_SURF 0 NURBS surface ... @endverbatim @param[in,out] ptr Current position in the database @param[in] sel_mask Mask for sel bits @param[in] ent_mask Entity mask @param[out] found_ptr Points to the next entity in the database @param[out] entity Points to an entity with matching sel and id bits (All the sel bits must match, but only one of the id bits must match) @param[out] succf True if entity found. False if end of database reached @note ptr must be set to the beginning of database on the first call @par Purpose: Save the database to an opened file @param[in] f opened file @param[in] just_hdr just write the header info @param[out] succf true = successful @param[in] educ (optional) true = saving EMCX file, false = saving MCX file @param[in] reset_db_changed (optional) true = allow db_changed to be reset. This should only be set to false when called from save_temp_db(). Merge an opened file into the (existing) database (Level visibility in the incoming file will be ignored, and level descriptors will only be brought in to those levels which currently have no descriptor. The entity attributes (ENT_ATTR_FN) will also be ignored [in] The file. [in] Post warning if file contains entities in graphics background color. [in] true = perform GE3 file cleanup. [in] check metric flag, switch cfg and/or scale. [in] [0]=color, [1]=level, [2]=linestyle, [3]=pointstyle [4]=linewidth. [out] true = error storing in the database. [in] (optional) true = merging EMCX file, false = merging MCX file. [in] (optional) true = suppress showing the "Associative entities will not be merged" warning. [in] (Optional) Pointer to FileMergeOptions structure to control unit dialog displayed when merging. [out] (Optional) The merged levels and names. @par Purpose: Read an opened file into the database @param[in] post_invis_ent_warn Post warning if file contains entities in graphics background color @param[in] f The file @param[in] read_screen_info true = read screen scale @param[in] perform_cleanup true = perform GE3 file cleanup (delete duplicates, try to fix bad associations, dont bring in entities using unfixable assocs., remove colinear trim surf boundary pts) @param[in] check_units check metric flag, switch cfg and/or scale @param[out] succf true = error storing in the database @param[in] educ (optional) true = getting EMCX file, false = getting MCX file @param[in] showWarnings (optional) true = show warning messages, false = skip them (the default) Indicates if we are currently in directory Import/Export mode. True if state is currently ImportDir or ExportDir. Clears both the message log and the message prompt. Clears any text in the message log. Clears the message prompt. Emulate printf functionality to the message log. This function should be used for debugging only. Printf style format string. Variables argument list Send a new-line string to the message log. Send a character to the message log. The character to write. Send a real number to the message log. Assume at least one place before the decimal point. The value to send. Number of decimal places to include. Send a string with a new-line at the end to the message log. The message string to write. Send an integer value to the message log. The value to send. Number of digits. Send a long integer value to the message log. The value to send. Number of digits. Defines the file_exist as file_exists() Send a string without a carriage return or line feed at the end to the message log. The message string to write. This method determines if the path is an existing file. Name of the file to check for. (Optional) True to warn if the file does not exist (default = false). True if the file exists. False if it doesn't exist or is a directory. This method reads a single from an MBCS text file and replaces the new line with a null character. Returned = Null-terminated string read from the file. The maximum number of characters to read. The file pointer. True if successful read, otherwise false. This method reads a single from a file and replaces the new line with a null character. Returned = Null-terminated string read from the file. The maximum number of characters to read. The file pointer. True if successful read, otherwise false. This method calls fclose and then marks the file allocation record as dead if the record is found in our array. The file pointer to close. 0 if successful, otherwise the error code from fclose(). Tries to open a file using the passed SysFile and displays error if unsuccessful Reference to a SysFile object. The prefix (path) to insert. The name of the file to open. The file open mode. True if it succeeds, false if it fails. Open the given file and display an error if it doesn't open The caller's file name. The caller's line number. The path to the file. The name of the file to open. The file mode (reading, writing, etc.). Returned - true if the file opened, otherwise false. Null if it fails, else a pointer to a FILE. Call the FileList dialog to display the contents of the given file. The name of the file to display. (Optional) The title string for the dialog (default == nullptr will display the name of the file in the title). (Optional) The dialog's parent window (default == nullptr). This method calls the default editor to begin editing the passed file. Name of the file to edit. (Optional) True to wait until the editor closed (default = false). Perform a file/save operation. This method is usually called from the SaveFile() interface. It may be called directly to bypass the File/Save dialog. MUST be complete path to the file. Pointer to the dialog's parent window. (Optional) Check for Machine Def in the database and prompt user if required (default = true). (Optional) See if we're about to overwrite an existing file (default = true). True if the file saves successfully, otherwise false. Perform a file/save operation. This method is usually called from the SaveFile() interface. It may be called directly to bypass the File/Save dialog. MUST be complete path to the file. Pointer to the dialog's parent window. (Optional) Check for Machine Def in the database and prompt user if required (default = true). (Optional) See if we're about to overwrite an existing file (default = true). True if the file saves successfully, otherwise false. Perform a File/Save operation, first displaying the File/Save dialog. MUST be complete path to the file. Pointer to the dialog's parent window. (Optional) True == get the file name, but don't save the file (default = false). True if OK, otherwise false. This function displays the file open or file save dialog. It does not open the file, it simply populates the OPENFILENAME param and returns 1 if OK is clicked, or 2 if cancel is clicked. True to display the 'Open' dialog. False to display the 'Save' dialog. Pointer to OPENFILENAME structure. (Optional) Custom string to display in the static text control to the left of the folder browser combo box (default == nullptr). (Optional) Any special behavior for the file open dialog. 1 if OK clicked, 2 if CANCEL clicked. Display the File/Open dialog and open the selected file. This method performs the file open operation. It is usually called from the OpenFile() interface method. However, it can be called directly to bypass the File/Open dialog. [in] MUST be complete path to file [in] merge flag [in] open as flag. true = open as text, else false (default). [in] check incoming files units and put up a dialog if they differ from the current units (0=no check, 1=always check, 2=opposite of 'merge' flag) [in] if 'merge' and !'astext' and a level is currently non-visible but it is visible in the incoming file, turn it on (default = true) [out] (Optional) (may be null) if provided, will return true is used aborted file open due to current file state (default = nullptr) [in] (Optional) Pointer to FileMergeOptions structure to control unit dialog displayed when merging [out] (Optional) The merged files levels and names. true, if OK, else, false. Executes the file open operation without any 'switch units' dialog. True == switch units if required, without prompting. The name of the file to open. True if it succeeds, false if it fails. File merge options. This SDK method performs the file open operation, first displaying the File/Open dialog. MUST be complete path to the file. Pointer to the parent window. (Optional) True == get file name, but don't open the file (default = false). 1 == success, 0 if file could not be opened, -1 if cancel hit. This SDK method performs the file open operation, first displaying the File/Open dialog. MUST be complete path to the file. The maximum characters pFile name can hold (including null). Pointer to the parent window. (Optional) True == get file name, but don't open the file (default = false). 1 == success, 0 if file could not be opened, -1 if cancel hit. Attempts to read and validate the educational header info from the file. True if header validated, false otherwise. Gets the unit system of the opened part file. The result flag. True if it succeeds, false if not open. Gets the Mastercam file version. Returned file bit size: 0 = 32 bit; 1 = 64 bit. Version of the part file, or no value if the information could not be extracted. Gets the current version header. Current version header. Default constructor. Mastercam File I/O class. This class should be used for all file I/O operations on a Mastercam format file. It maintains information about the file and how it is to being accessed. Much of this information had been maintained in global variables prior to implementation of this class. This class could be used to access files in other formats. @defgroup assocvar_ch15 nci line types @{ @} Reads the Mastercam file version of the input when it is open. Reads the educational status of the input when it is open. Attempts to read and validate the educational header info from the file. True if header validated, false otherwise. Checks if the specified file is a Mastercam file. File path. If TRUE, file must exist. Version number if Mastercam file, else 0. Note that a return of 10 could be X, X2, X3, or X4 etc. Gets the unit system of the opened part file. The returned units flag - true if Metric, false if U.S. True if it succeeds, false if not open. Gets the Mastercam file version. Returned file bit size: 0 = 32 bit; 1 = 64 bit. Version of the part file, or no value if the information could not be extracted. Gets the current version header. Current version header. Helper function for overloaded Open functions that actually does the open. Fully qualified file name to open. Type of access permitted. Type of sharing allowed. Refer to help for _tfsopen for possible values for mode and shFlag. shFlag is optional and defaults to _SH_DENYNO. Returns true if the file opened successfully or if the same file name is already open. Returns false if a different file is currently open or if the open fails. Initializes member variables to default values. A constructor must pass true for "constructor" to prevent the virtual function "CurrentVersion" from being called (to get the major and minor version numbers). When "constructor" is true, both m_VersionMajor and m_VersionMinor are set to zero. Optional flag to indicate we are called from a constructor. Copies the version information from another MCFile object. This method is primarily used to carry version information for BNCI files that do not have version info contained within the file data. The instance to version info from copy. Gets a const reference to m_DumpParameters. Return a const reference to m_DumpParameters. Sets all the dump parameters. Set all dump parameters to this value. return previous value of dump parameters. Sets dump parameters. The dump parameters. return previous value of dump parameters. Makes a set/restore file dump globals. The dump parameters all set to this value. A std::unique_ptr<SetRestoreFileDumpGlobals> Makes a set/restore file dump globals. The dump parameters. A std::unique_ptr<SetRestoreFileDumpGlobals> Destructor. Constructor. dump parameters. [in,out] The reference to an mcfile. Class to set and restore our FileDumpGlobals. Constructor. (Optional) Set all parameters to this value. Dump parameters. Gets the current state of the flag that controls whether general entity allocations will be dumped when these entities are read. Gets the current state of the flag that controls whether groups will be dumped when they are read. Gets the current state of the flag that controls whether the history entity will be dumped when it is read. Gets the current state of the flag that controls whether the file lock history entity will be dumped when it is read. Gets the current state of the flag that controls whether worksheets will be dumped when they are read. Gets the current state of the flag that controls whether levels will be dumped when they are read. Gets the current state of the flag that controls whether font entities will be dumped when they are read. Gets the current state of the flag that controls whether the descriptor entity will be dumped when it is read. Gets the current state of the flag that controls whether the bitmap entity will be dumped when it is read. Gets the current state of the flag that controls whether the memory table being read from the file should be merged into the existing memory table. Gets the current state of the flag that controls whether the memory table should be skipped when reading the file. Gets the current state of the flag that controls whether the memory table should be read from the file. Gets the current state of the flag that controls whether polygonal mesh data should be read from the file. Gets the current state of the flag that controls whether the file is being saved as 32 bit. Files are always saved as the bit size of the version of Mastercam doing the save. Gets the major version number that the file will be saved as. This value will be 0 for the current version. By default the file will be saved as the current version. If the file is to be saved as a previous version the the application will need to set this using SetSaveAsVersion. Gets the unit system of the currently open file. True if Metric, false if U.S. Gets the version of the currently open file. Version of the currently open file. Gets the major version number of the currently open file. Major version of the currently open file. Gets the type of the currently open file. Currently this is not set automatically by this class nor is it saved in the file. The application accessing the file must set it using SetMastercamFileType. Gets the fully qualified name of the currently open file. If file is not open, a empty string will be returned. Returns true if the stream is directed to standard output. Returns true if the file being read was saved by a 32 bit version of Mastercam. Returns true if the file being read is a previous version of Mastercam or if the file is being written as a previous version. Returns true if the file being read is an Educational file. Sets the value of the file pointer to the beginning of the file if true, even EMCX files will position to zero. For Educational files, the position will actually be set to the first position after the encrypted header, unless the override parameter is passed. True if successful, false if file not open. Moves the file pointer to a specified location. Number of bytes from origin. Initial position. Refer to help for fseeki64 for possible values for origin. This function is designed to handle files greater than 2GB in length, but it also works with a long parameter for files less than 2GB. For Educational files, if the seek would result in positioning to the beginning of the file, the position will actually be set to the first position after the encrypted header. Returns 0 if successful, otherwise returns a nonzero value. Synchronises this object to its attached stream. Attaches MCFile object to the given iostream at its current position. iostream to attach to. Part file version of the stream we are attaching to. True if the file contains 32bit contents. Attaches MCFile object to the given binary stream at its current position. BinaryStream to attach to. Opens the specified fileName using the read/write mode and the shFlag (sharing) option. Fully qualified file name to open. Type of access permitted. Type of sharing allowed. Refer to help for _tfsopen for possible values for mode and shFlag. shFlag is optional and defaults to _SH_DENYNO. Returns true if the file opened successfully or if the same file name is already open. Returns false if a different file is currently open or if the open fails. Opens the specified fileName in filePath using the read/write mode and the shFlag (sharing) option. Path where fileName is located. File name to open in filePath. Type of access permitted. Type of sharing allowed. Refer to help for _tfsopen for possible values for mode and shFlag. shFlag is optional and defaults to _SH_DENYNO. Returns true if the file opened successfully or if the same file name is already open. Returns false if a different file is currently open or if the open fails. Standard destruction, but also closes the file if it is still open. Constructs the class and initializes member variables to default values. This base class constructor sets both m_VersionMajor and m_VersionMinor to zero. Mastercam File I/O base class. Gets minor component of a part file version. This is somewhat hidden because we don't want people to think comparing minors is OK. People should do comparisons on the "PartFileVersion" Minor component of a part file version. Less-than-or-equal comparison operator. Other instance to compare. True if the this instance is less or equal to the other instance. Greater-than-or-equal comparison operator. Other instance to compare. True if the this instance is grater than or equal to the other instance. Inequality operator. Other instance to compare. True if the this instance is not equal to the other instance. Equality operator. Other instance to compare. True if the this instance equal to the other instance. Greater-than comparison operator. Other instance to compare. True if the this instance is grater than the other instance. Less-than comparison operator. Other instance to compare. True if the this instance is less than the lhs instance. Gets the major component of the part file version. Minor component of the part file version is NOT exposed like this purposefully. Major component of the part file version. Constructor. The major. The minor. A (Major, Minor) part file version representation. Deletes an entity, optionally warning the user if a toolpath references it. If "delTpRefs" is passed as PromptUser, it will be returned as DeleteEnt or SkipEnt - depending on how the user responded. If DeleteEnt or SkipEnt is passed, the same value is returned. As an alternative, you can call DeleteEntity if you are passing "delTpRefs" as DeleteEnt. The entity. True to draw. True to blank entity. True to delete the toolpath references. Toolpath reference warning option. (Optional) True to purge. (Optional) True to update levels. True if it succeeds, false if it fails. Deletes an entity. Calling this function is the equivalent of calling DeleteEntityWarn with "tpRefWarn" passed as DeleteEnt. The entity. True to draw. True to blank entity. True to delete the toolpath references. (Optional) True to purge. (Optional) True to update levels. True if it succeeds, false if it fails. Options for deleting an entity with an associated toolpath. * @par Purpose: * Convert a chain to a ctour_array, optionally breaking the first * entity * @param[in] chain chain to convert * @param[out] rel_depth Depth of the first point in the contour * relative to the construction plane * @param[out] ctour 2d form of the chained contour * @param[in] view_n view number for ctour * @param[in] max_chain maximum number of elements in ctour * @param[in] low_index starting index for ctour * @param[out] n_pts number of points in ctour * @param[out] view_match (false for 3D Contour) * @param[in] s_nb_allowed Chaining of splines and NURBS allowed * @param[in] l_tol Curve linearization tolerance * @param[in] ct_3d Contour is 3D (ctour_rec ent_ptr used) * @param[in] splitFirst split the first entity * @param[in] restoreSplitCircle restores a split circle if one was created * @param[out] succf false if chain allocation exceeded @par Purpose: Convert a chain to a ctour_array, optionally breaking the first entity @param[in] chain chain to convert @param[out] rel_depth Depth of the first point in the contour relative to the construction plane @param[out] ctour 2d form of the chained contour @param[in] view_n view number for ctour @param[in] max_chain maximum number of elements in ctour @param[in] low_index starting index for ctour @param[out] n_pts number of points in ctour @param[out] view_match (false for 3D Contour) @param[in] s_nb_allowed Chaining of splines and NURBS allowed @param[in] l_tol Curve linearization tolerance @param[in] ct_3d Contour is 3D (ctour_rec ent_ptr used) @param[out] succf false if chain allocation exceeded @par Purpose: Returns the point stored at the given index in the spline_nodes2 buffer Only use this if you are sure that the index is less than max_n_spline_pts @param[in] index index in the buffer at which to get the point @return the point at the given index @par Purpose: Returns the point stored at the given index in the spline_nodes2 buffer @param[in] index index in the buffer at which to get the point @param[out] pt point stored at the specified index @return false if the specified index is greater than max_n_spline_pts @par Purpose: Stores a point at the given index in the spline_nodes2 buffer If the index is greater than max_n_spline_pts the buffer will be reallocated @param[in] index index in the buffer at which to store the point @param[in] pt point to store at the specified index @return false if reallocation is required but unsuccessful @par Purpose: Returns a pointer to the current spline_nodes2 buffer @par Purpose: Returns the point stored at the given index in the spline_nodes1 buffer Only use this if you are sure that the index is less than max_n_spline_pts @param[in] index index in the buffer at which to get the point @return the point at the given index @par Purpose: Returns the point stored at the given index in the spline_nodes1 buffer @param[in] index index in the buffer at which to get the point @param[out] pt point stored at the specified index @return false if the specified index is greater than max_n_spline_pts @par Purpose: Stores a point at the given index in the spline_nodes1 buffer. If the index is greater than max_n_spline_pts the buffer will be reallocated @param[in] index index in the buffer at which to store the point @param[in] pt point to store at the specified index @return false if reallocation is required but unsuccessful @par Purpose: Returns a pointer to the current spline_nodes1 buffer @par Purpose: @param[in] allocate Optional allocate flag to have the function allocate memory if necessary Returns the maximum number of spline segments (max_n_spline_pts - 1) that can be stored in the current allocation @par Purpose: Reallocates the spline buffers for the specified number of points (same as AllocateMemNPts()) @param[in] npts number of spline points to allocate @return true if reallocation was successful @par Purpose: @param[in] allocate Optional allocate flag to have the function allocate memory if necessary Returns the maximum number of spline points that can be stored in the current allocation @par Purpose: Reallocates the spline buffers (spline_nodes1 and spline_nodes2) for the specified number of points @param[in] npts number of spline points to allocate @return true if reallocation was successful Increase spline buffers, if required. The nurb. True if it succeeds, false if it fails. Increase spline buffers, if required. The number of required points. True if it succeeds, false if it fails. This method adds a rectangle to the database. Location of the lower left corner of the rectangle. Location of the upper right corner of the rectangle. A pointer that will reference the newly created entities. An integer that will represent the number of newly created entities. @par Purpose: Create a surface from 4 3D positions @param[in] nodes 3D positions @param[out] surf_ent output surface @par Purpose: Convert any surface to a NURB surface @return 0 = no errors @param[in] psf input surface @param[out] surf_ent output surface @defgroup cdefs_grp1 NotifyUserApp() Notify Events @{ @} @defgroup cdefs_grp2 get_event() Event Mode Bit Flags @{ @} @par Purpose: Convert any revolved surface to a NURB surface @return 0 = no errors @param[in] prev input surface @param[in] curve_ent edge curve entity @param[out] nbs output surface Find a point on the first or last entity in a chain with specified tVal modifier. I: chain. I: true for first entity. false for last entity. I: the modifier value. O: the point on the entity at the modifier value. O: the derivative vector at the point. true if the output values were set. false on failure. @par Purpose: copies a linked list of chains into a second, new chain @param[in] old_chains chains to copy chain data from @param[out] new_chains newly allocacated chain holding the copied chain data @par Purpose: copies one chain into a second, new chain @param[in] old_chain chain to copy chain data from @param[out] new_chain newly allocacated chain holding the copied chain data @par Purpose: converts a chain to a series of eptrs @param[in] chain chain to parse @param[in] validate_eptrs true = make sure eptrs are valid @param[out] eptrs alloc'd array of curve eptrs @param[out] n_eptrs size of array @par Purpose: Returns associated solid ptrs from given list of chains @param[in] chains chains @param[out] solidPtrs vector of solid pointers (no duplicates) @param[out] solidOpIndex vector of solid operation index in database @par Purpose: Sorts the list of chain in decreasing z level. @param[in] chain chain @par Purpose: Determine if passed in chain is Clockwise or Counter-Clockwise. @return short chain direction CHAIN_INVALID(-2), CHAIN_DIR_CW(0), CHAIN_DIR_CCW(1) @param[in] chain chain @param[in] view_n current view @par Purpose: Get the next curve in a chain. If "wrap around" is specified, chain is closed and the current entity is the last entity in the chain, return the first curve in the chain. @return next curve in chain (NULL for none) @param[in] chain chain @param[in] ce current chain entity @param[in] wrap_around get first curve if current entity is at last curve @par Purpose: Get the previous curve in a chain. If "wrap around" is specified, the chain is closed and the current entity is the first curve in the chain, return the last entity in the chain. @return previous chain entity (NULL for none) @param[in] chain chain @param[in] ce current chain entity @param[in] wrap_around get last curve if current entity is at start of chain @par Purpose: Return the last curve in a chain @return first curve in a chain @param[in] chain chain @par Purpose: Get chains from a Mastercam file @param[in] prompt flag specifying if the user is to be prompted for a file name @param[in] filename name of the file to get the chains from @param[out] new_chains the chains found in the file @param[out] pNotes the notes found in the file @return error code (CHAIN_OK, CHAIN_INVALID) @par Purpose: optimize sort of closed chains. Group inner to outer closed chains. before moving to next group of closed chains. @param[in,out] chains linked list of chains @par Purpose: optimize sort of closed chains. Group outer to inner closed chains. before moving to next group of closed chains. @param[in,out] chains linked list of chains @par Purpose: sort closed chains from outside to inside. @param[in,out] chains linked list of chains @par Purpose: sort closed chains from inside to outside. This is needed for water cutting, since an inner boundary can't be cut after its parent boundary has been cut since the part will have dropped out @param[in,out] chains linked list of chains @par Purpose: find the length of a chain @return length of all entities in a chain @param[in] chain the chain to measure @par Purpose: free chain memory for a linked list of chains. @param[in] chains linked list of chains @par Purpose: Free a linked list of CHAIN_ENT structures and one CHAIN structure. @param[in] chain one chain @par Purpose: Chain previously selected entities using TEMP2_BIT @return CHAIN_ESC = user backed out, CHAIN_OK = user didn't back out @param[out] new_chains chained contours @param[in] only_closed true = collect just closed chains, false = all ents @param[in] no_pts true = remove chain pts, false = keep them check_chain_tp_refs @par Purpose: Check chain entities to see if any are referenced by toolpath entities. @param[in] c Chain which faces obliteration @param[in] disp_warn true = display warning if toolpath references found @param[out] ref_found true = toolpath references found @param[out] dont_doit true = user wants to cancel operation @par Purpose: Get one chain from the user @param[in] msg_id message number of string table @param[out] chains chained contours @param[in] rsrc_handle resource that contains the message @param[in] preserveSelection Do we keep the current selections? @return error code (CHAIN_OK, CHAIN_ESC) @par Purpose: Get one chain from the user @param[in] msg_id message number of string table @param[out] chains chained contours @param[in] preserveSelection Do we keep the current selections? @return error code (CHAIN_OK, CHAIN_ESC) @par Purpose: Get one chain from the user @param[in] msg prompt message @param[out] chains chained contours @param[in] preserveSelection Do we keep the current selections? @return error code (CHAIN_OK, CHAIN_ESC) @par Purpose: Chaining for saw. Display the chain menu: @param[out] chains chained contours @par Purpose: Chaining with points. Display the chain menu: @param[in] msg_id message number of string table @param[out] chains chained contours @param[in] rsrc_handle resource that contains the message @return error code (CHAIN_OK, CHAIN_ESC) @par Purpose: Chaining with points. Display the chain menu: @par Chaining method: Chain\n Window\n Area\n Single\n Section\n Point\n [Solids]\n Last\n Unselect\n Done\n @param[in] msg_id message number of string table @param[out] chains chained contours @return error code (CHAIN_OK, CHAIN_ESC) @par Purpose: Chaining with points. Display the chain menu: @param[in] msg prompt message @param[out] chains chained contours @par Purpose: Main chaining function. Display the chain menu: @param[in] msg_id message number of string table @param[out] chains chained contours @param[in] rsrc_handle resource that contains the message @return error code (CHAIN_OK, CHAIN_ESC) @par Purpose: Main chaining function. Display the chain menu: @par Chaining method: Chain\n Window\n Area\n Single\n Section\n [Solids]\n Last\n Unselect\n Done\n @param[in] msg_id message number of string table @param[out] chains chained contours @return error code (CHAIN_OK, CHAIN_ESC) @par Purpose: Main chaining function. Display the chain menu: @param[in] msg prompt message @param[out] chains chained contours @par Purpose: reverse a chain @param[in,out] chain chain to reverse @par Purpose: return the last chain a linked list of chains @param[in] chains linked list of chains @param[out] last_chain last chain in the list Move cur_chain from chains to sorted_chains. Do not deallocate the pocket boundary while unlinking the chain. @param[in,out] first_chain first chain in linked list @param[in] chain chain to unlink @param[in] sel_bit .sel bit to toggle @param[in] free_pock_bnd free pocket boundary @param[in] unselect unselect chain @param[in] draw true = draw when unselecting @par Purpose: append a linked list of chains to the end of a linked list of chains @param[in,out] chains linked list of chains @param[in] new_chains new chains @par Purpose: Add a chain entity to the end of a chain. The chain entity is reallocated. @param[in,out] chains linked list of chains @param[in] new_chain new chain @par Purpose: Add a chain entity to the end of a chain. The chain entity is reallocated. @return error code (CHAIN_OK, CHAIN_MEM_ERR) @param[in,out] chain chain @param[in] ce chain entity to add @param[in,out] last_ce last chain entity in the chain @par Purpose: add a chain entity to start or end of a chain @param[in] new_ent entity to add to chain @param[in] ep_n endpoint number to save in new chain entity @param[in] add_to_end true = add entity to end of chain, false = add to start of chain @param[in] sel_bit .sel bit to flip (TEMP_BIT or SELECT_BIT) @param[in,out] chain chain @param[in,out] ce last (or first) entity in the chain @param[in] fbm_type FBM curve type (-1 if not FBM curve) @return error code (CHAIN_OK, CHAIN_MEM_ERR) @par Purpose: deallocate data structures and .sel bits used for chaining This function does not call free_chain_mem, becuase it shouldn't be called the chain is no longer needed. @param[in] chains linked list of chains. @param[in] hash hash table @par Purpose: initialize data structures and set .sel bits for chaining. Called prior to select_and_append_chains, for example. @return error code (0 = ok, -1 = memory allocation error) @param[in,out] chains linked list of chains. @param[in,out] hash hash table for finding endpoints Bits to clear in prep. for chaining @param[in] clear_sel_bits @par Purpose: Free all memory blocks that were allocated with chain_malloc @par Purpose: determine whether a chain contains exactly one point @return true = pChain is only a single point @param[in] pChain chain to test @par Purpose: unselect all entites that are part of a chain (clear SELECT_BIT in the .sel field) @param[in] chain chain @param[in] draw draw entities after unselecting @param[in] sel_bit .sel bit to toggle @par Purpose: Unselect a linked list of chains @param[in] chains linked list of chains @param[in] draw draw entities after unselecting @param[in] sel_bit .sel bit to toggle @par Purpose: Get the last entity in a chain @param[in] pChain The chain @param[out] pEntity The entity @param[out] reversed The entity chained in the opposite direction of creation? @par Purpose: Get the first entity in a chain @param[in] pChain The chain @param[out] pEntity The entity @param[out] reversed The entity chained in the opposite direction of creation? @par Purpose: Return the first curve in a chain @return first curve in a chain @param[in] chain chain @par Purpose: determine whether a chain contains 3d entities relative to the given view @param[in] chain chained entities @param[out] chain_3d true = chain is 3D @param[out] chain_has_curve true = chain contains spline(s)/curve(s) @par Purpose: Get the last entity (any type of entity) in a chain @return last entity in the chain @param[in] chain chain @par Purpose: count the number of syncs in a chain @return number syncs with at least one curve entity @param[in] chain chain @param[out] end_of_chain END_OF_CHAIN id found @par Purpose: Count the number of non-empty chains in a linked list @return number of non-empty chains @param[in] pChains linked list of chains @par Purpose: Draw an arrow in the direction of the last chain in the list @param[in] chain a chain @par Purpose: Draw a linked list of chains and set the .sel field @param[in] chain linked list of chains @par Purpose: Draw a chain and set the .sel field @param[in] chain a chain @param[in] bit bit to toggle @par Purpose: Draw a linked list of chains @param[in] chains linked list of chains @param[in] color color @par Purpose: Draw a chain @param[in] chain a chain @param[in] color color @par Purpose: Return the depth of the first entity in a chain @param[in] pChain chain @param[out] pDepth depth @param[out] pOk depth is valid @par Purpose: Get the endpoint of a chain by number @param[in] pChain chain @param[in] chain_ep_n 0 = start of first entity, 1 = end of last entity @param[out] ep endpoint @defgroup chain_ch1 Chain geometry modes @{ @} @defgroup chain_ch2 Chain direction @{ @} @defgroup chain_ch3 Chain sync options @{ @} @defgroup chain_ch4 Chaining error constants @{ @} Values that represent the different solid chain selection. @} Sort points according to the method specified by options.sort_method. Number of window points to sort. Window points to sort. The collection of options controlling the sort method. Optional variable to return whether or not a change was actually made to the order. True if it succeeds, false if it fails. @defgroup chain_sort Window Point Structure @{ Reverse the order of drill points in an operation. This will turn OFF the sorting in the operation. Identifier for the operation. true if it succeeds, false if it fails. Sort the drill points in an operation. The desired sort style must be set in sort_method of the operation! Identifier for the operation. true if it succeeds, false if it fails. @par Purpose: Return a point, selected entity, input method and t values @param[out] pt_option point entry method @param[out] pnt 3D point in world coordinates @param[in] create_pt true = create pt ent if undefined type @param[in] sketch_view if 0, use CONSTR_VIEW_N @param[in] sketch_depth if 0, use constr_depth @param[in] sld_assoc true = allow solid assoc points @param[out] sel_ent entity used in pt selection @param[out] tval t values used in pt selection @param[out] valid_point true = successful @param[in] msg select prompt @param[in] disableDrawingCreatedPt true = disable drawing of created point @param[in] allowSelectionOfTempPt true = allow selection of temporary point, false = do not allow selection of temporary point @par Purpose: create and add a p_3d to the database @param[in] pt pt to add @param[out] pt_ent pt entity @param[out] succf true, if successful, otherwise false Drill options @par Purpose: display the autodrill parameter dialog @return unused *@defgroup drill_srt_methods Drill Sorting Method Defines * @{ @} *@defgroup filter depth Defines * @{ @} @par Purpose: collect drill params and points, write to db, process nci section @return unused @param[in] unused unused * @par Purpose: * Display the options dialog, set options * * @param[in] pwnd parent window pointer * @param[in,out] hash hash table * @param[out] sect_ang_on true = section angle check box on * @return error code (CHAIN_OK, CHAIN_MEM_ERR) @par Purpose: This function saves the graphics screen to a bitmap object. It then converts the bitmap object to a Device Independent Bitmap. @return true if successful; false if not Make a cylindrical bounding box given the passed in parameters and all selected geometry. The parameters of the cylindrical bounding box to create. The radius of the resulting cylindrical bounding box. The height of the resulting cylindrical bounding box. The center point of the resulting cylindrical bounding box. The axis vector of the resulting cylindrical bounding box. The eptrs of the newly created geometry for the cylindrical bounding box. (Optional) If true, forces a repaint after creating the bounding box. (Optional) If true, search the Display List, else search the database. True if it succeeds, false if it fails. Make a rectangular bounding box given the passed in parameters and all selected geometry. The parameters of the rectangular bounding box to create. The resulting 3 dimensional min and maxes of the box. The eptrs of the newly created geometry for the rectangular bounding box. (Optional) If true, forces a repaint after creating the bounding box. (Optional) If true, search the Display List, else search the database. True if it succeeds, false if it fails. Makes bounding box from chain. The chain to derive a bounding box of. The size of the margin to add to the outer dimensions of the bounding box. Array holding the dimensions of the resulting bounding box. (Optional) True = warns user that chain is not flat. True if it succeeds, false if it fails. Prompt for entities and return their bounding box. The minmax (minX, maxX, minY, maxY, minZ, maxZ) True if it succeeds, false if it fails. Bounding Box params. @par Purpose: set the fillet angle to a specific value according to corner type specified in num. @param[in] num 0 = NONE, 1 = SHARP, 2 = ALL @param[out] fil_ang fillet angle @par Purpose: Determine whether a closed contour was chained in the clockwise or counterclockwise direction @param[in] ctour The contour to analyze. Must be closed. @param[in] n_pts Number of points in ctour @param[out] direction 1 = ccw, -1 = cw @param[out] succf true if the direction was found successfully; false if not @par Purpose: Take the information in ctour_info, offset it, and put it into cc_info @param[in,out] ctour_info contour information structure @param[out] cc_info resulting cutter comp information @param[in] low_index base index of the contour described in the ctour_info variable @param[in] n_pts number of points in the contour @param[in] n_discarded - unused - @param[in] signed_ofst_dist the offset value to be used @param[in] cutter_orient 'L' to offset to the left; 'R' to offset to the right @param[in] do_self_inters true if the function is to find self intersections @param[out] succf true if the information was loaded into cc_info successfully; false if not Applies the specified operation cutting data to the given operation. Cutting data parameters to be applied to the operation. The result to apply cutting data to. Retrieves available cutting data from the specified toolpath operation. The operation to retrieve cutting data from. The operation cutting data. A set of operation cutting data. Sets local operation. The new value. Gets local operation. The local operation. Make a list of operations from an external file. Ignored. Operations Filename of the file. If non-null, list of groups that operations belong to. If non-null, list of operations. Ignored. The allocations. @par Purpose: restore the bnci for the op from the .mc8 file @param[in] op_ids operation ids to restore, NULL for all ops @param[in] n_op_ids # of ids in array @param[in] path active mastercam file (usually geo_filename) @return true if the bnci was restored successfully; false if not @par Purpose: find the first toopath entity in an operation @param[in] opIdn operation id number @param[out] pFirstTpEnt 1st toolpath ent found that belongs to op @param[out] pSuccf true = successful @par Purpose: get all info on operation @param[in] op_idn id number of the operation to get information for @param[in] oplist pointer to an operation list to look in @param[out] info fills a user-created op_information variable with the appropriate operation info @par Purpose: change nci path in all operations that match nci @param[in] op current operation @param[in] new_nci_name new nci path @param[in] select_flag true = use select flag @param[in] ask true = ask "Update all operations... " @par Purpose: make the operation description @param[in] op operation @param[in] add_comment true - append the operation comment @param[out] str ptr to destination string @param[in] sz_str max size of str Run a function in a C-Hook DLL. Name of the CHook. Name of the function. The parameter to pass to the function being called. (Optional) If non-null, (Optional) the ret value. True if it succeeds, false if it fails. @par Purpose: Run a function in a C-Hook DLL @param[in] chook_name The name of the C-Hook DLL (no path) @param[in] func_name The name of the function to be executed in the DLL (if empty, runs 'm_main') @param[out] succf true = all is ok @return Purpose: compares two operations in memory for any differences @param[in] opA ptr to operation #1 @param[in] opB ptr to operation #2 @param[in] mode 0 = compare all, 1=compare just important stuff @param[in] warn true = display warning (for debugging only) @return return 0 for equal, non-zero if different Prompt "Keep operation?" with operation description. true if the new operation was added, false if escape or cancel was hit. Identifier for the operation. (Optional) the resource handle for the dialog's title. (Optional) the resource ID for the dialog's title. (Optional) True if multiaxis. true = operation saved and dependent ops marked dirty, false = operation deleted (or does not exist). Prompt "Keep operation?" with operation description. Identifier for the operation. (Optional) true = just delete the operation with no prompt. (Optional) The dialog title, nullptr = "Keep operation?". (Optional) True if multiaxis. true = operation saved and dependent ops marked dirty, false = operation deleted (or does not exist). returns value of static InEditOperation. The in edit operation. @par Purpose: run appropriate dialog for operation type (op->opcode), @param[in,out] op operation to edit @param[in] update_db true = update current db, false=just call dialog @param[out] succf true = successful @param[in] pParentWnd CWnd pointer to the parent dialog which called this function (default = NULL) @param[out] pReturn return value from the DoModal call to the op's dialog (default = NULL) @param[in] StartPage page to launch operation edit dialog to @return # of ops successfully imported @par Purpose: run appropriate dialog for operation type (op->opcode), in a CHook SDK-friendly fashion @param[in,out] op operation to edit @param[in] update_db true = update current db, false=just call dialog @param[out] redo_idn if op is redone - this will be set to the new op id # @param[out] succf true = successful @return # of ops successfully imported Operation supports arc feed override. The operation. true if it supports arc feed override, false if not. Operation is HST 2D with a style that supports finish passes. Finish passes may or may not be enabled but style does allow. The operation. true if it is HST 2D and has finish pass support, false if it is not HST 2D or style does not support. Operation is plunge/retract direction capable. This is the plunge and/or retract direction found in classic surface toolpaths (3-axis, 4-axis, 5-axis). The operation code. true if it is compatible, false if not. Operation is associative linking parameter point compatible. WEB, 10/17/2016. The operation code. true if it is compatible, false if not. Indicates that a holemaking operation is not capable of evaluating tip compensation on a tool with a corner radius. The operation code. True if the operation is holemaking and it is not capable of evaluating tip compensation on a tool with a corner radius. @par Purpose: determines if the given op is set to tip comp @param[in] op The operation to check @return A pointer to the tip comp bool, true if set to tip comp, false if set to center comp Determines if the given op does not have/require tool info. The operation. True to include non-assoc toolpath operations in this evaluation. True if it succeeds, false if it fails. @par Purpose: determines if the given op is an C-Hook operation @param[in] opcode operation opcode @return true if the op is a C-Hook type operation; false if it isn't @par Purpose: determines if the given op is an manual entry operation @param[in] opcode operation opcode @return true if the op is an manual entry type toolpath; false if it isn't Determines whether the given op supports the workholding component. The opcode. True if the given op supports workholding, otherwise false. @par Purpose: determines if the given op is a multi-surface toolpath (3-,4-, or 5-axis) @param[in] opcode operation opcode @return true if the op is a multi-surface type toolpath; false if it isn't. The opcode. (Optional) True to drill check too. False to only check true msurf operations. True if it succeeds, false if it fails. @par Purpose: determines if the given op is an FBM operation @param[in] opcode operation opcode @return true if the op is an FBM operation; false if it isn't @par Purpose: determines if the given op is a point based toolpath @param[in] opcode operation opcode @return true if the op is a point based toolpath; false if it isn't Operation is 2D mill. The Operation types in the HSTChainBasedPage The opcode. True if it succeeds, false if it fails. Determines if the operation type indicated by the opcode is a holemaking operation. All holemaking operations are multi-axis. The opcode. True if the toolpath indicated by opcode is a holemaking toolpath. @par Purpose: determines if the given op is a drill or c-axis drill toolpath @param[in] opcode operation opcode @return true if the op is a drill or c-axis drill toolpath; false if it isn't @par Purpose: determines if the given op is a multi-surface toolpath (3-5axis) or chook @param[in] opcode operation opcode @return true if the op is a multi-surface type toolpath; false if it isn't Determines if the given operation is a shild of a Process Hole toolpath. The operation. True if toolpath is a process hole child. Determines if the given operation is capable of oututing multi-axis moves. Includes 2D holemaking when the tool axis control is set to 4 or 5 axis. The operation. True if toolpath is multi-axis. Determines if the given op is a multi-axis toolpath. The opcode. True if the op is a multi-axis type toolpath, false if it isn't. Determines if the given op is a Moduleworks multi-axis toolpath. The opcode. True if the op is a Moduleworks multi-axis type toolpath, false if it isn't. Operation is mw 3 ax. The opcode. True if it succeeds, false if it fails. Determines if the given op is a Moduleworks toolpath. The opcode. True if the op is a Moduleworks toolpath, false if it isn't. Determines if the given operation is capable of outputing multi-axis moves. Includes 2D holemaking when the tool axis control is set to 4 or 5 axis. The operation. True if it succeeds, false if it fails. @par Purpose: determines if the given op is a multi-axis toolpath 10/29/2018 - this function no longer includes 5Ax drill and circle mill because holemaking operations can now either be 5 axis or locked to 3 axis. The opcode alone is not sufficient to determine which. Use opIsMultiaxCapable (operation) instead. @param[in] opcode operation opcode @return true if the op is a multi-axis type toolpath; false if it isn't @par Purpose: determines if the given op is a router toolpath @param[in] opcode operation opcode @return true if the op is a router type toolpath; false if it isn't @par Purpose: determines if the op is a stock transfer @param[in] opcode operation opcode @return true if the op update the lathe stock boundary; false if it doesn't @par Purpose: determines if the given op is stock transfer, flip or advance @param[in] opcode operation opcode @return true if the op is a stock transfer; false if it isn't @par Purpose: determines if the given op is a lathe toolpath @param[in] opcode operation opcode @return true if the op is a lathe type toolpath; false if it isn't @par Purpose: determines if the given op is a wire toolpath @param[in] opcode operation opcode @return true if the op is a wire type toolpath; false if it isn't @par Purpose: determines if the given op is an old toolpath type @param[in] opcode operation opcode @return true if the op is a old toolpath type; false if it isn't @par Purpose: determines if the given op is a fbm type toolpath @param[in] opcode operation opcode @return true if the op is a fbm type toolpath; false if it isn't @par Purpose: determines if the given op is a milling type toolpath @param[in] opcode operation opcode @return true if the op is a milling type toolpath; false if it isn't Validates if an operation type is supported by MillTurn. The operation code. True = The operation is supported by MillTurn, else False. @par Purpose: delete all operations and/or tools @param[in] ops true - delete all operations @param[in] tls true - delete all tools @param[in] job true - init the job setup @param[in] silent true - don't ask, don't tell @param[out] succf true - all went well @par Purpose: initialize the toolpath entity ptr @param[in] e selected entity to point to @param[in] ent_id toolpath entity type (P_ID, L_ID, etc) @param[in] tp_id toolpath point type (points only) GRID, BOLT, etc @param[in] entry_method point entry method used @param[in] pt point value selected (if tp_id == P_ID) @param[in] tval point t value used @param[in] op current operation @param[out] tp ptr to toolpath ent to initialize @par Purpose: add an stl file to an operation @param[in] op the operation to be added to @param[in] pathstl the path of the stl file to add @par Purpose: set the graphics view to a numbered view @param[in] n numbered view to set the graphics view to @defgroup pt_mgr_def Point Manager modes * @{ @} @par Purpose: function to gather drill points for an existing operation - toolpath point entities are added to db @param[in] op_idn existing operation id number @param[in] mode PTMGR_MENU, PTMGR_ADD, PTMGR_DELETE, etc @param[in] stay_in_menu true = stay in point manager menu for more selections @param[out] succf drill point operations successful @par Purpose: function to gather/edit chains for an existing operation - chain boundary entities are added/delete/edited to db @param[in] pCMI chain manager instructions @param[in] chainType type of chains to use - 0 = all @param[out] pSuccf chain boundary operations successful @param[in] customChainType specifies type when chainType == CHN_TP_THIRDPARTY *@defgroup chn_mgr_def Chain Manager Modes * @{ @} Chain Manager Info @defgroup tl_mgr_defs Tool Manager Modes * @{ @} @defgroup op_mgr_defs Operation Manager Modes * @{ @} @par Purpose: function to add/get/delete/edit/regen operations in the current db @param[in,out] op pointer to operation - make sure op->op_idn is set for read access @param[in] mode OPMGR_ADD, OPMGR_EDIT, etc @param[out] eptr db pointer to operation entity @param[out] succf operation manager successful @defgroup mtl_mgr_defines Material Manager Modes * @{ @} @par Purpose: function to add/get/delete/edit materials in the current db @param[in,out] matl pointer to material - make sure matl->name is set for read access @param[in] mode MTLMGR_ADD, MTLMGR_EDIT, etc @param[out] eptr db pointer to material entity @param[out] succf tool manager successful @defgroup bin_nci_funcs binary nci functions * @{ @} @par Purpose: binary nci functions @param[in] op_idn existing operation id @param[in] mode NCIMGR_RD, NCIMGR_WR, etc. @param[in,out] n pointer to nci line structure @param[out] fpos current file position in binary nci file @param[out] succf true = nci manager successful @par Purpose: retrieve or free COPIES of linked lists of operations, tools or material lists from libraries or the current database @param[in] lib_type listitem type (LTL_ID) @param[in] lib_name library name or "" (null string) for current database @param[in] mode LSTMGR_GET or LSTMGR_FREE @param[in,out] list_ptr pointer to alloc'd linked list of items Notifies toolpaths that a surface entity has changed levels so that they can be marked dirty on broken toolpath - level associativity. (1) This function assumes that the entity either has already been modified or is scheduled to be modified by the upstream code. Any toolpaths referencing the input levels are automatically assumed to be in need of updating (all surfaces entities from a referenced level are implied to be toolpath inputs) (2) This is a much simplified version of 'validate_toolpath' Levels marked for regen. True if it succeeds, false if it fails. Check toolpath entities in all operations to ensure the referenced geometry still exists, mark operations dirty if needed. True if it succeeds, false if it fails. @par Purpose: deletes any type of toolpath entity and keeps things kosher @param[in] e toolpath entity to delete @param[in] succf true = delete went ok @param[in] markDependentOps true/false @param[in] purge true/false TP delete all. The operation idn. (Optional) True to omit VS2L values. (Optional) True to omit Advaned Drill hole segments. @par Purpose: returns the buffering (aka memory blocking) size @param[in] n_bytes_desired bytes to allocate @par Purpose: Wrapper for discard_all @par Purpose: Get all possible toolpath allocation for NC functions such as surface machining @param[out] num_bytes number of bytes allocated @param[out] ptr pointer to toolpath allocation memory @par Purpose: returns the buffering (aka memory blocking) size @par Purpose: return middle t value on entity @return middle t value on given entity @param[in] entity given entity @par Purpose: return maximum t value on entity @return maximum t value on given entity @param[in] entity given entity @par Purpose: return minimum t value on entity @return minimum t value on given entity @param[in] entity given entity @par Purpose: decide if two 2d points are equal @return true = points are equal @param[in] p1 first point @param[in] p2 second point @par Purpose: decide if two 3d points are equal @return true = points are equal @param[in] p1 first point @param[in] p2 second point @par Purpose: test two 2d bounding boxes (probably part of a pock_chn record) overlap @return true = bounding boxes overlap @param[in] b0 2d bounding box @param[in] b1 2d bounding box @param[in] ovlp overlap distance @par Purpose: Find the minimum and maximum x and y values on a 2d line or arc @param[out] bbox bounding box @param[in] e 2d entity @par Purpose: Convert a list of numbers read from an NCI file into a 3d line or 3d arc @param[in] g 0 = rapid, 1 = linear, 2 = arc cw, 3 = arc ccw @param[in] tl_vw_n Tool view @param[in] n_reals Number of entries in reals @param[in] prev_pt Previous point read from the NCI file @param[out] cc Cutter compensation in control @param[out] feedrate Feedrate @param[out] reversed True if entity is a CW arc @param reals @param[in] loc_tol @param entity @param[out] prev_pt_valid @param[out] succf @par Purpose: Intersect two 3d lines, arcs, or spline. If 2d construction used, project both lines to the construction plane and find the the t parameters of the 2d intersection. If 3d construction used, check that the entities actually intersect in 3d space. @param[in] entities Two entities (lines, arc or splines) @param[in] sel_t t parameters used to select entities @param[out] t2 @param[out] t t parameters of intersection on entities @param[out] succf true if entities intersect @param[out] t2_succf @par Purpose: Project a 3d point onto an entity (useful for breaking splines into two pieces ) @param[in] entity The selected entity (line, arc or spline) @param[in] break_pt Point to project onto entity @param[in] view 0 = use 3d projection, >0 = use 2d projection @param[in] t_sel Value of t at which entity was selected @param[out] proj_pt The projection of break_pt onto entity @param[out] t The value of t corresponding to proj_pt @param[out] succf True if break point found @param[in] limit_osc True to use a new meathod which limits oscillations (false by default) @par Purpose: Find the t parameter given a 2d point @note The value of t is only approximate for arcs and splines @param[out] t Resulting t value @param[in] entity ent we're finding the t for @param[in] old_t The old t value @param[in] pt 2D point we're testing for @param[in] view view number of the view to project the entity onto @param[in] bSearchCrv Flag for global search (set to true if input guess parameter is unknown) (default = false) @par Purpose: Find the tangent of a line, arc or spline given the t parameter @param[out] tan_v The tangent @param[in] t parameter value @param[in,out] entity a 3d entity @param[in] bGlobalDerivs flag for global deriv magnitude - default = false @par Purpose: Find a point on a line, arc or spline given the t parameter @param[out] pt A point on entity @param[in] t parameter value (0:1) @param[in] entity 3d entity @par Purpose: Find a point on a 2d line or arc given the t parameter @param[in] e 2d line or arc @param[in] t parameter value @param[out] t_v tangent vector, unit length @par Purpose: Find a point on a 2d line or arc given the t parameter @param[in] e 2d line or arc @param[in] t parameter value @param[out] pt A point on the line or arc @par Purpose: Find the nearest point on a line from a point. Returns the distance to that point. @param[in] point point to check distance from @param[in] line a 3d line @param[out] nearPt the nearest point @param[in] infline true for infinite line @par Purpose: Find the distance from a point to a 3d line @param[in] pt a 3d point @param[in] line a 3d line @param[out] dist distance from pt to line @par Purpose: Convert a 2d arc (a) to a 3d arc (a_3d) @param[out] arc The 3d arc @param[in] view Arc view @param[in] depth Depth of arc center point relative to view @param[in] a2 The 2d arc @par Purpose: Convert a 2d line to a 3d line (l_3d) @param[out] line The 3d line @param[in] view Arc view @param[in] depth Depth of arc center point relative to view @param[in] l2 The 2d line @par Purpose: Convert a 3d entity to a 2d entity @param[out] ent_gt The 2d entity @param[in] view The view to project entity into @param[in] entity The 3d entity @par Purpose: Make a view matrix given its k component @param[in] k_c k component to use @param[out] view resuling view matrix @param[out] succf true if view matrix was created successfully; false if not @par Purpose: Map view coordinates to world coordinates @param[in] pt point in view coords/point in world coords @param[in] view A view number @par Purpose: Map view coordinates to world coordinates @param[in] pt point in view coords/point in world coords @param[in] view A view number @par Purpose: Map coordinates from one view to another @param[in] pt_in A 3d point in view coordinates @param[in] from_view_n A view number @param[in] to_view_n A different view number @param[out] pt_out A 3d point in the new view coordinates @par Purpose: Map world coordinates to a 2d point relative to a give view. @param[in] pt_world A 3d point in world coordinates @param[in] view A view matrix @param[out] pt_view A 2d point in view coordinates @par Purpose: Map world coordinates to a 2d point relative to a give view. @param[in] pt_world A 3d point in world coordinates @param[in] view A view number @param[out] pt_view A 2d point in view coordinates @par Purpose: Project a 3d point (world coordinates) onto the isometric axes (graphics view coordinates) Global inputs: x_iso_axis, y_iso_axis @param[in] pt a 3d point @param[out] proj_pt a 2d point expressed in user units @par Purpose: Finds the length of a point, line, arc or spline. @param[in] entity the entity to measure @param[out] length the length of entity Wire Miscellaneous Data Structure @defgroup thread_point_cut_types thread point cut types @{ @} Thread Point Record Structure @} @defgroup gen_nc_params General NC Parameters @{ @} @} @defgroup ncvars_display_parameters NC Global Display Parameters @{ @} @defgroup rot_group Rotary Axis Globals @{ @defgroup contour_ncvars Contour Globals @{ Wire Auxiliary Register Data Structure Wire Auxiliary Register Pass Structure Place marker type Cutter Comp Record Structure @defgroup post_return_modes Post Return Modes @{ @} @defgroup wire_aux_reg_data Wire auxiliary register data @{ @} @defgroup wire_aux_reg_flags Wire auxillary register flags @{ @} Contour Record Structure Get a vector of file pointers and names of files that are currently open. a vector of file pointers and names of files that are currently open. Get the current size of the SysFile Open-Close Log. The size the SysFile Open-Close Log. Clears the SysFile Open-Close Log. The size the SysFile Open-Close Log was before it was cleared. Return the contents of the file open/close log in a CStringArray. Log entry for SysFileOpenCloseLog. Updates the internal file position tracking from the current buffer information. Count how many bytes in a wide string. If the file was opened in TEXT mode, all new-lines (\n) will be counted as 4 bytes, since they will be written to the disk as wide-character \r\n. The wide string to inspect. The number of bytes in the string. Count how many bytes in a narrow UTF-8 or MBCS string. If the file was opened in TEXT mode, all new-lines (\n) will be counted as 2 bytes, since they will be written to the disk as \r\n. The narrow string to inspect. The number of bytes in the string. Helper function for overloaded Open functions that actually does the open. Fully qualified file name to open. Type of access permitted. Type of sharing allowed. Refer to help for _tfsopen for possible values for mode and shFlag. shFlag is optional and defaults to _SH_DENYNO. Returns true if the file opened successfully or if the same file name is already open. Returns false if a different file is currently open or if the open fails. Verifies that the file is really open. Initializes member variables to default values. A constructor must pass true for "constructor" to prevent the virtual function "CurrentVersion" from being called (to get the major and minor version numbers). When "constructor" is true, both m_VersionMajor and m_VersionMinor are set to zero. Optional flag to indicate we are called from a constructor. Update the file size based upon the current position. Returns the current file size. The current file size. Returns the current file position. The current file position. Update the current file position. The new position (absolute or relative, based upon origin). The origin (SEEK_SET or SEEK_CUR). Set the file size to the given value. the new size of the file. Set the file size based upon the file contents. Handle to the open file to check. Destructor. Constructor. Class to hold the current file size and file position. Create and return a unique ptr to a SaveRestoreFilePosition class. (Optional) The file position to set this to. (Optional) Initial position. A std::unique_ptr to a SaveRestoreFilePosition class. Disables the restoring of the file's position in the destructor. A FILE_POS. Gets value of m_SetFposSuccess. value of m_SetFposSuccess. Destructor. Constructor. The system file (this!) (Optional) The file position to set the file pointer to. (Optional) Initial position. Class to save the current file position and restore upon destruction. Returns the encoding for the current file. The mode. Specifies what type of file we are reading/writing. Gets the fully qualified name of the currently open file. If file is not open, a empty string will be returned. Returns true if the file pointer is currently at end of file. Returns true if the file is currently open. Get error code for the last error that occurred. Use _tcserror_s to get a text message for the error number returned. Use clearerr to reset the error. If no error has occurred, returns 0. Otherwise, returns a nonzero value. Write a wide-string to file. The terminating null is not written. Pointer to string to be written. Returns non negative number if no error, else returns EOF. Read a wide-string from file. Reads characters from the current file position to and including the first newline character, to the end of the stream, or until the number of characters read is equal to n - 1, whichever comes first. The result stored in str is appended with a null character. The newline character, if read, is included in the string. Pointer to buffer for line. Must be large enough to hold n characters Maximum number of characters to read. If no error has occurred, returns str. Otherwise, returns NULL. Read one wide-string line from file and replace the new line with a null character. Pointer to buffer for line. Must be large enough to hold n characters Maximum number of characters to read. If no error has occurred, returns str. Otherwise, returns NULL. Print wide-string formatted data to file. Refer to fprint_s help for format string specification . Pointer to format string. Optional arguments. Returns the number of characters written or negative number if error occurred. Write a narrow string to file. The terminating null is not written. Pointer to string to be written. Returns non negative number if no error, else returns EOF. Read a string from an ASCII file. Reads narrow characters from the current file position to and including the first newline character, to the end of the stream, or until the number of characters read is equal to n - 1, whichever comes first. The result stored in str is appended with a null character. The newline character, if read, is included in the string. Pointer to buffer for line. Must be large enough to hold n characters Maximum number of characters to read. If no error has occurred, returns str. Otherwise, returns NULL. Read one line from an ASCII file and replace the new line with a null character. Pointer to buffer for line. Must be large enough to hold n characters Maximum number of characters to read. If no error has occurred, returns str. Otherwise, returns NULL. Print formatted data to file (narrow strings always). Refer to fprint_s help for format string specification . Pointer to format string. Optional arguments. Returns the number of characters written or negative number if error occurred. Write a narrow string to file. The terminating null is not written. Pointer to string to be written. Returns non negative number if no error, else returns EOF. Read a narrow string from file, convert to wide if appropriate. Reads characters from the current file position to and including the first newline character, to the end of the stream, or until the number of characters read is equal to n - 1, whichever comes first. The result stored in str is appended with a null character. The newline character, if read, is included in the string. Pointer to buffer for line. Must be large enough to hold n characters Maximum number of characters to read. If no error has occurred, returns str. Otherwise, returns NULL. Read one narrow line from file, convert to wide if appropriate, replace '\n' with '\0'. Pointer to buffer for line. Must be large enough to hold n characters Maximum number of characters to read. If no error has occurred, returns str. Otherwise, returns NULL. Write a string to file. The terminating null is not written. Pointer to string to be written. Returns non negative number if no error, else returns EOF. Read a string from file. Reads characters from the current file position to and including the first newline character, to the end of the stream, or until the number of characters read is equal to n - 1, whichever comes first. The result stored in str is appended with a null character. The newline character, if read, is included in the string. Pointer to buffer for line. Must be large enough to hold n characters Maximum number of characters to read. If no error has occurred, returns str. Otherwise, returns NULL. Read one line from file and replace the new line with a null character. Pointer to buffer for line. Must be large enough to hold n characters Maximum number of characters to read. If no error has occurred, returns str. Otherwise, returns NULL. Print formatted data to file. Refer to fprint_s help for format string specification . Pointer to format string. Optional arguments. Returns the number of characters written or negative number if error occurred. Flushes any Stream I/O buffers associated with the file. Returns 0 if the buffer was successfully flushed. The value 0 is also returned in cases in which the file is open for reading only. A return value of EOF indicates an error. Sets the value of the file pointer to the beginning of the file For Educational files, the position will actually be set to the first position after the encrypted header. True if successful, false if file not open. Obtains the current logical length of the file in bytes This function should be used for files greater than 2GB in length. The length of the file Changes the length of the file. Desired length of the file in bytes. This value can be larger or smaller than the current length of the file. The file will be extended or truncated as appropriate. True if file length was set successfully. Sets the file length to the current file pointer. A flush is performed first to ensure the current file pointer is updated. True if file was truncated successfully. Gets the current position of the file pointer. If the file is not open 0 is returned, otherwise the current file position. Gets the current position of the file pointer using an ftell() call. This function should NOT be used for text files as it can give wrong results, and should be used sparingly for binary files because it is slow. Use GetFilePosition () instead, which caches the current file position, making it much faster. If the file is not open 0 is returned, otherwise the current file position. Gets the current position of the file pointer. This function should be used for files greater than 2GB in length. If the file is not open 0 is returned, otherwise the current file position. Gets the current position of the file pointer. This function is only reliable on files less than 2GB in length. If the file is not open 0 is returned, otherwise the current file position. Moves the file pointer to a specified location. Number of bytes from origin. Initial position. Refer to help for fseeki64 for possible values for origin. This function is designed to handle files greater than 2GB in length, but it also works with a long parameter for files less than 2GB. For Educational files, if the seek would result in positioning to the beginning of the file, the position will actually be set to the first position after the encrypted header. Returns 0 if successful, otherwise returns a nonzero value. Attempts to write count items of size bytes from buffer to the currently open file. Pointer to the user-supplied buffer that contains the data to be written to the file. Item size in bytes. Maximum number of items to be written. The number of full items actually written, which may be less than count if an error occurs. Attempts to write count bytes from buffer to the currently open file. Pointer to the user-supplied buffer that contains the data to be written to the file. The maximum number of bytes to be transferred from the buffer. For text-mode files, carriage return–linefeed pairs are counted as single characters. The number of bytes actually written. Attempts to read count items of size bytes from the currently open file into buffer. Pointer to the user-supplied buffer that is to receive the data read from the file. Item size in bytes. Maximum number of items to be read. The number of full items actually read, which may be less than count if an error occurs or if the end of the file is encountered before reaching count. Attempts to read count bytes from the currently open file into buffer. Pointer to the user-supplied buffer that is to receive the data read from the file. The maximum number of bytes to be read from the file. For text-mode files, carriage return–linefeed pairs are counted as single characters. The number of bytes actually read. The return value could be less than count if an error or end of file encountered. Closes the currently open file and resets member variables to default values. A flush is performed before closing to ensure all buffers are written. The result of a GetLastError() call. Error codes are defined in winerror.h. Opens the specified fileName using the read/write mode and the shFlag (sharing) option. Fully qualified file name to open. Type of access permitted. Type of sharing allowed. Refer to help for _tfsopen for possible values for mode and shFlag. shFlag is optional and defaults to _SH_DENYNO. Returns true if the file opened successfully or if the same file name is already open. Returns false if a different file is currently open or if the open fails. Opens the specified fileName in filePath using the read/write mode and the shFlag (sharing) option. Path where fileName is located. File name to open in filePath. Type of access permitted. Type of sharing allowed. Refer to help for _tfsopen for possible values for mode and shFlag. shFlag is optional and defaults to _SH_DENYNO. Returns true if the file opened successfully or if the same file name is already open. Returns false if a different file is currently open or if the open fails. Standard destruction, but also closes the file if it is still open. Constructs the class and initializes member variables to default values. Mastercam File I/O base class. Queries if the database is considered empty, ignoring the GroupListEnt's that are now always there. Use instead of db_start == nullptr. True if the database is considered empty, false if not. Sets the given value. The Value to set. double operator overload. The depth value. Assignment operator overload. Depth value to assign. The new depth value. Constructor. Optional value. Simple class which allows special handling when the construction depth is set. Gets selection distance. The selection distance. selection variables Gets a reference to the global variable 'current_version' representing the version of the current Mastercam session. The version of the current Mastercam session. Gets a reference to the global variable 'pNciBinFileClass' representing the pointer to the file class for binary nci. All of the bnci functions are implemented to use pNciBinFileClass and will also swap with pointers to other instances of the SysFile class. pNciBinFileClass replaces what used to be fnci_bin. The pointer to file class for binary nci. Gets a reference to the global variable 'TpMainOpMgr' representing the main operations list manager. The main operations list manager. Gets a reference to the global variable 'TpMainGrpMgr' representing the main groups list manager. The main groups list manager. Gets a reference to the global variable 'TpMainMatMgr' representing the main materials list manager. The main materials list manager. Gets a reference to the global variable 'db_end' representing the ending address of the database linked list. The ending address of the database linked list. Gets a reference to the global variable 'db_start' representing the starting address of the database linked list. The starting address of the database linked list. @} @par Purpose: This class's purpose is to hold and work with instances of the op manager material list classes for the life of a given Mastercam app execution. It also houses the material list stacks themselves, which we use to manage temporary list creation situations (see base TpMgr class declaration for more details). Selection Mask Type Selection Mask depth comparisons Selection Mask length and diameter comparisons Macro for allocating an ent structure instead of having it on the stack. Macro for allocating an ent structure array instead of having it on the stack. @defgroup sel_mask_types Selection Mask @{ @defgroup sel_mask_surf_types Selection Mask - Surface Types /** @{ @} @defgroup sel_mask_draft_types Selection Mask - Drafting Types @{ @} @defgroup Solid Types @{ @} @defgroup selection_mask__max Selection Mask - Max @{ @} Conversion assignment operator. The toolpath entity in 'ent' form. A reference to this instance. Conversion constructor. The toolpath entity in 'ent' form. Create struct that matches the legacy ent_tp structure. We use a struct instead of using or typedef in order to preserve the existing use of forward declarations. Create struct that matches the legacy ent structure. We use a struct instead of using or typedef in order to preserve the existing use of forward declarations. A streamlined entity union used to store toolpath entity information only. The union portion of the Entity. Contains the data for the specific type actually stored in the entity, as indicated by the entity's id and assoc_id. A type that is used to just contain the "header" portion of the ent structure. An empty struct that allows us to construct an "ent header". DBvars_CH.h @defgroup controldb_ch1 Control component union type @{ @} @defgroup controldb_ch2 Control post union type @{ @} @defgroup controldb_ch3 Control type defines @{ @} @defgroup controldb_ch5 Control class access types @{ @} @defgroup controldb_ch6 File status @{ @} @defgroup controldb_ch7 Pop menu selections @{ @} @defgroup controldb_ch8 CNCControl errors @{ @} @defgroup controldb_ch10 CNCControl file @{ @} @defgroup controldb_ch11 Multiple selection defines @{ @defgroup controldb_ch12 Control init option option @{ @} @defgroup controldb_ch13 Control misc option @{ @} @defgroup controldb_ch14 Control drill option @{ @} @defgroup controldb_ch15 snAddToToolRegister @{ @} @defgroup controldb_ch16 snTransOperParams @{ @} @defgroup controldb_ch17 snWorkOffsetNumberTPlane @{ @} @defgroup controldb_ch18 snWorkCoordinate @{ @} @defgroup controldb_ch19 snGetHomePosition @{ @} @defgroup controldb_ch20 snRapidDestination... @{ @} @defgroup controldb_ch21 snXYlinPlaneControl...\nsnXYbreakArc... @{ @} @defgroup controldb_ch22 snMoveEndOption @{ @} @defgroup controldb_ch23 snXYcenterType... @{ @} @defgroup controldb_ch24 snHelixType @{ @} @defgroup controldb_ch25 snThreeAxisFeed, snFourAxisFeed, snFourAxisRotFeed, snFiveAxisFeed, snFiveAxisRotFeed @{ @} @defgroup controldb_ch26 snInverseFeed @{ @} @defgroup controldb_ch27 snArcCheckEndPointType @{ @} @defgroup controldb_ch28 snSubLocationInNC @{ @} @defgroup controldb_ch30 snThreadType @{ @} @defgroup controldb_ch31 snLeadInType, snLeadOutType @{ @} @defgroup controldb_ch32 snRevPosCornerType..., snAuxRevPosReg1... @{ @} @defgroup controldb_ch33 snAuxRevModReg1 @{ @} @defgroup controldb_ch34 snReturnDrill @{ @} @defgroup controldb_ch35 snInitAbsoluteMatching @{ @} @defgroup controldb_ch36 snRefAbsoluteMatching - snDepthAbsoluteMatching @{ @} @} UBVS control values. Control Post ID. Control Component. Control Base ID. Control link ent_idn. Wire NC path values. Wire nocore. Wire 4 axis. Wire reverse auxiliary. Wire reverse. Wire corners. Wire cuts. Wire leads. Machine Cycles. Lathe canned cycles. Drill cycles. General canned cycle. General NC path values. Subprograms. Cutter compensation. Feed. Rotary. Arc. Linear. Tool. Work system. NC Output. NC Dialog Wire. NC Dialog Lathe. NC Dialog Router. NC Dialog Mill. Post file list element. Files Common Communication. Tolerances Tolerance settings for posting, 'var' are MP variables. @} @} @defgroup pass-specific_data PASS-SPECIFIC DATA @{ @defgroup non-pass-specific_data NON-PASS-SPECIFIC DATA @{ Wire change at point structure Wire control settings change structure Wire control flag change structure event entity feed type event feed rate event part rotary axis master event part spindle speed master event stock transfer event tool change event macro event axis clamp event quill event steady rest advance/retract event axis place holder event axis motion event coolant place holder event coolant event hidden tool change marker event sync event manual entry event bar feed event spindle move event (part spindle) tool grip length move event tool clearance move event tool linear move event part spindle grip length move event part spindle clearance move event chuck open/close event tool offset event tool stage event tool call event tool spindle orientation event part spindle orientation event tool spindle speed clamp event part spindle speed clamp event tool spindle speed event part spindle speed event dwell event custom event (canned text) tool spindle rpm/css tool spindle event with states part spindle direction event part spindle rpm/css part spindle event with states select event select event comment output event bar puller open/close tool table event event with multiple states, like on/off part spindle event simple event For tool item id For MT machine position data event list header event View Entity Structure. WCS Information Structure. @defgroup block_types Block Types @{ @} @defgroup head_types Head Types @{ @} lathe tool types for tp_ent type Named View Associative Geometry Selections. Tool station. Tool block component parameters. Tool heads Tool head component parameters. @} @par Purpose: Sets the main level number global "main_level". Note: unless temporarily set and restored, do not set "main_level" directly, use this function instead! @param[in] level level number @defgroup math_varuables math variables * * initialized in this module Maximum number of views Defines an alias representing list of leaders. 5ax abbreviated nci entity - definition @} nci entity - definition mill nci - mark start/end of NCI display section mill nci - contour start section marker (used in contour temp file) mill nci - pocket start/end keep tool down move marker (used in pocket temp file) mill nci - pocket start section marker (used in pocket temp file) wire nci - nocore start section marker (used in pocket temp file) mill nci - mark start/end of cut/pass nci - part info nci - sheet change marker start of operation output for the post Note: The start of transform op is not marked but the start of transformed ops within the transform op are marked. mill nci - end of operation's nci section @} @defgroup nci_start nci - start of operation's nci section @{ event bnci - unused event bnci - unused event bnci - unused event bnci - unused event bnci - unused event bnci - unused event bnci - unused event bnci - unused event bnci - unused event bnci - unused event bnci - unused event bnci - unused event bnci - unused event bnci - unused event bnci - unused event bnci - unused event bnci - feed type event bnci - feed rate event bnci - tool spindle rpm/css event bnci - part spindle rpm/css event bnci - work shift select event bnci - work offset select event bnci - drill cancel event bnci - drill reference event bnci - axis clamp select event bnci - rtcp select event bnci - reference return select event bnci - polar cylinder select event bnci - cutter comp select event bnci - plane select event bnci - abs/inc select event bnci - unit select event bnci - motion select event bnci - comment output event bnci - tool table event bnci - tool stage event bnci - tool call event bnci - tool offset event bnci - a axis motion place holder event bnci - tool change approach place holder event bnci - b axis motion place holder event bnci - axis motion place holder event bnci - tool change event list end event bnci - tool change event list start event bnci - stock transfer event bnci - custom (canned text) event bnci - manual entry event bnci - join token This is only used in the toolpath simulation, it is not passed to the post event bnci - macro end event bnci - macro start event bnci - macro else event bnci - transform subprogram marker event bnci - join event bnci - hidden part rotary axis master event event bnci - part rotary axis master event event bnci - hidden part spindle speed master event event bnci - part spindle speed master event event bnci - hidden tool change marker event event bnci - sync event event bnci - part spindle stock grip length move event bnci - part spindle stock clearance move event bnci - part spindle advance/retract event bnci - bar puller stock grip length move event bnci - bar puller stock clearance move event bnci - tool linear 3d (mill) event bnci - tool stock clearance move 2d (lathe) event bnci - tool linear 2d event bnci - bar feed event bnci - bar feed lock/unlock event bnci - steady rest advance/retract event bnci - steady rest roller lock/unlock event bnci - steady rest pin advance/retract event bnci - steady rest open/close event bnci - tailstock quill retract event bnci - tailstock quill advance event bnci - tailstock quill lock/unlock event bnci - tailstock retract event bnci - tailstock advance event bnci - tailstock pin advance/retract event bnci - tailstock lock/unlock event bnci - axis motion event bnci - dwell event bnci - tool spindle air blast on/off event bnci - tool spindle orient event bnci - tool spindle speed clamp event bnci - tool spindle live spindle enable/disable event bnci - tool spindle direction with coolant event bnci - tool spindle direction event bnci - tool spindle speed event bnci - part spindle rpm from css event bnci - part spindle air blast on/off event bnci - part orient event bnci - part spindle sync on/off event bnci - part spindle speed clamp event bnci - part spindle mill axis enable/disable event bnci - part spindle direction with coolant event bnci - part spindle direction event bnci - part spindle speed event bnci - part catcher advance/retract event bnci - eject pin advance/retract event bnci - bar puller open/close event bnci - chuck open/close event bnci - retract coolant place holder event bnci - approach coolant place holder event bnci - coolant event bnci - program stop event bnci - event list header event event bnci - tool change retract event list event bnci - tool change approach event list @defgroup custom ops event bnci lines @{ event bnci - custom op event list nesting nci - miscellaneous parameters #2 nesting nci - miscellaneous parameters #1 wire nci - Agie data wire nci - stock to leave lathe nci - tool definition - custom tool geometry file name lathe nci - tool definition - tool holder parameters lathe nci - tool definition - tool holder name lathe nci - tool definition - drilling tool parameters (cutting) lathe nci - tool definition - drilling tool parameters (geometry) lathe nci - tool definition - grooving/parting insert parameters lathe nci - tool definition - threading insert parameters lathe nci - tool definition - general turning/boring insert parameters lathe nci - tool definition - tool insert general parameters lathe nci - tool definition - tool insert name lathe nci - tool definition - tool geometric parameters lathe nci - tool definition - tool general cutting parameters lathe nci - tool definition - tool programming parameters multiaxis comp in control value mill nci - matl comment mill nci - matl name mill nci - wcs comment mill nci - wcs name mill nci - tpln comment mill nci - tpln name mill nci - cpln comment mill nci - cpln name mill nci - tool definition - custom parameters mill nci - tool definition - head parameters mill nci - tool definition - holder parameters mill nci - tool definition - mill type tool specific parameters mill nci - tool definition - drill type tool specific parameters mill nci - tool definition - tool parameters mill nci - tool definition - chuck name lathe nci - tool definition - manufacturer mill nci - tool definition - manufacturer lathe nci - tool definition - tool comment (name) mill nci - tool definition - tool comment lathe nci - tool definition - mc7 path for custom tool geometry mill nci - tool definition - mc7 path for tool reference mill nci - operation parameters tool inspection comment machine group name machine group comment machine name lathe nci - version, date and geometry file name mill nci - version, date and geometry file name mill nci - miscellaneous int - make sure mill/lathe/wire stay same size! mill nci - miscellaneous reals - make sure mill/lathe/wire stay same size! lathe nci - construction plane 3x3 matrix lathe nci - stock description Mill/Router nci - Multi head, block, station info part 2 Mill/Router nci - Multi head, block, station info part 1 -block tools/drills/aggregates wire - canned text lathe - canned text lathe nci - working coordinate system mill nci - working coordinate system mill - canned text mill nci - stock description mill nci - stock description All but wire nci - end of sub program section. This structure must match the types from nci_mill_1018 because code uses these interchangeably. See comments with nci_mill_1018. All but wire nci - start of sub program section. The structure is context and process dependent. See comments. mill nci - construction plane 3x3 matrix wire nci - associative params - make sure mill/lathe/wire stay same size! lathe nci - associative params - make sure mill/lathe/wire stay same size! mill nci - associative params - make sure mill/lathe/wire stay same size! wire nci - subroutine parameters lathe nci - tool plane 3x3 matrix mill nci - tool plane 3x3 matrix wire nci - miscellaneous params - make sure mill/lathe/wire stay same size! lathe nci - miscellaneous params - make sure mill/lathe/wire stay same size! mill nci - miscellaneous params - make sure mill/lathe/wire stay same size! wire nci - miscellaneous int - make sure mill/lathe/wire stay same size! lathe nci - miscellaneous int - make sure mill/lathe/wire stay same size! mill nci - miscellaneous int - make sure mill/lathe/wire stay same size! wire nci - miscellaneous reals - make sure mill/lathe/wire stay same size! lathe nci - miscellaneous reals - make sure mill/lathe/wire stay same size! mill nci - miscellaneous reals - make sure mill/lathe/wire stay same size! wire nci - control settings change wire nci - wirepath length wire nci - operation comment lathe nci - operation comment mill nci - operation comment wire nci - comment (manual entry) lathe nci - comment (manual entry) mill nci - comment (manual entry) wire nci - cancel cutter comp in control lathe nci - cancel cutter comp in control mill nci - cancel cutter comp in control wire nci - end of file lathe nci - end of file mill nci - end of file wire nci - start of nci file and/or tool change lathe nci - start of nci file and/or tool change mill nci - start of nci file and/or tool change for rent alternate turret position flag (turret lathe) tool number tool station number ATC tool pocket, turret index position, gang tool = station ent_idn of tool changer component tool changer type: ATC_COMPONENT, TURRET_COMPONENT, MT_TURRET_COMPONENT, GANG_TOOL_COMPONENT nci enhanced tool change information lathe nci - axis combination MT steady rest (standalone) operation turret operation tailstock operation spindle sync operation spindle advance/retract operation chuck clamp/unclamp operation bar feed operation bar feeder on/off bar puller open/close lathe nci - miscops custom integer parameters lathe nci - miscops custom real parameters lathe nci - turret park operation - obsolete lathe nci - steady rest position operation lathe nci - tailstock position operation lathe nci - chuck clamp/un-clamp, reposition operation lathe nci - stock bar feed operation lathe nci - stock flip operation lathe nci - stock transfer operation lathe nci - start of threading cycle lathe nci - threading cycle wire nci - canned cycle point position mill nci - canned cycle point position nci - drill block parameters wire nci - start canned cycle lathe nci - start canned cycle lathe nci - custom drill parameters mill nci - custom drill parameters mill nci - start canned cycle wire nci - cancel canned cycle lathe nci - cancel canned cycle mill nci - cancel canned cycle wire nci - 4axis direct arc XY or UV move (gcodes 22, 23, 32, 33) wire nci - 4axis direct linear XY or UV move (gcodes 20, 21, 30, 31) wire nci - 4axis longhand Lathe nci 5 axis move. mill nci - 5 axis move wire nci - dwell mill nci - dwell mill nci - dwell wire nci - arc feed move lathe nci - arc feed move mill nci - arc feed move lathe nci - linear feed move mill nci - linear feed move wire nci - rapid or feed move (depends on gcode 0 or 1) mill nci - rapid move for linked lists of operation entities Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. Equality operator. The first instance to compare. The second instance to compare. true if the parameters are considered equivalent. operation parameter definition * @note If a operation member is added between version and u and the new * member is not supposed to be part of the operation header, the define * below must be changed to use the new member in place of u. operation parameters - multiaxes smoothing parameters For Override Arc Feedrate on Arc Filter / Tolerance page. For arc fit parameters on linking page. operation parameters - Feedrate optimization operation parameters - common rotary parameters c-axis = polar conversion (3 axis) y-axis = toolplane positioning (rotary positioning) operation parameters - common toolpath display parameters operation parameters - contour lead in-out parameters operation parameters - contour entry-exit parameters operation parameters - home position operation parameters - pocket and contour multi cuts operation parameters - pocket and contour depth cuts operation parameters - tool and construction planes operation parameters - cutter comp operation parameters - cutter comp in control operation parameters - cutter comp in computer operation parameters - toolpath filter settings operation parameters - more room operation events operation parameters - canned text auxiliary file name - mill:msurf recut file, wire:material library operation parameters - common parameters for all mill operation types Values that represent the offsets of the bits in the bitmask, op_common.graphicalPreviewFlags. Values that represent reference point types. operation parameters - database info Lathe b-axis contour turning parameters. Lathe b-axis contour turning angle control parameters. Lathe b-axis contour turning depth parameters. Lathe b-axis contour turning advanced parameters. MT steady rest point parameters. MT steady rest parameters. Given a linked components ids struct count the number of non-zero ids. Linked component ids struct. Linked component ids count. Equality operator. The right hand side. true if the parameters are considered equivalent. Component ids of linked components. Steady rest POCO move/operation types. Thread custom parameters. Thread custom common rough and finish parameters. Thread custom retract motion parameters. Thread custom tool inspection parameters. Thread custom allowance parameters. Thread custom multi-start parameters. Thread custom finish parameters. Thread custom finish depth parameters. Thread custom rough parameters. Thread custom rough depth parameters. Thread custom rough step parameters. Thread custom shape parameters. Thread custom parametric shape parameters. Thread Custom toolpath parametric trapezoidal shape parameters. Thread Custom toolpath parametric rope shape parameters. Thread Custom toolpath parametric buttress shape parameters. Thread Custom toolpath parametric square shape parameters. Lathe thread overcut parameters. Lathe thread acceleration clearance parameters. Lathe thread pitch parameters. Lathe entry and exit parameters. Lathe entry or exit parameters. Lathe feed rate parameters. Lathe stock to leave parameters. Lathe stock to leave parameters struct. Values that represent parametric groove shape types. Values that represent thread acceleration clearance type. Values that represent multi start cut order types. Values that represent lathe distance types. Values that represent lathe spindle speed types. Values that represent tool inspection locations. Values that represent thread custom cut order. Values that represent thread custom rough depth types. Values that represent thread custom rough step types. Values that represent thread pitch types. Values that represent thread orientations. Operation parameters - stock model. Defines an alias representing the plane pointer. Map definition for this plane's associated entity information. Gets the associated entity information contained in this plane. (Optional) True to warn for bad solid data. The associated entity information. Constructor. Origin or Matrix. Information describing the associated entity. Inequality operator. The object to compare. True if the parameters are not considered equivalent. Equality operator. The object to compare. True if the parameters are considered equivalent. Information about the plane's associated entity links. Calculate the transformation matrix between given matrix and origin and TOP and transform this plane by that amount. 3x3 matrix to subtract from this. Point in world coordinates to subtract from this. Calculate the transformation matrix between given plane and TOP and transform this plane by that amount. Plane to subtract from this. Calculate the transformation matrix between TOP and given matrix and origin and transform this plane by that amount. 3x3 matrix to add to this. Point in world coordinates to add to add to this. Calculate the transformation matrix between TOP and given plane and transform this plane by that amount. Plane to add to this. Calculate the transformation matrix between TOP and given matrix and origin and transform this plane by that amount. 3x3 matrix to add to this. Point in world coordinates to add to add to this. True to add, false to subtract. True if it succeeds, false if it fails. Inverse transform matrix and origin. The transform. The 3x3 matrix. The world origin point. Calculate the transformation matrix between to views and origins. Source view. Source origin in world coordinates. Destination view. Destination origin in world coordinates. transformation matrix. See if m_CreationMethod requires geometry. true if it it does, false if it doesn't. Initialize an op_view to the contents of this plane. op_view to initialize. A reference to a MastercamPlanes objcet to get the view # from. true = set op_view.woff_n, false = maintain current op_view.woff_n value. return true if successful. Check our parameters. A reference to a MastercamPlanes object to get the view #'s from. (Optional) Ignore these parameters. (Optional) The geometry map. Return pair, first=Error code mask, second=true=plane was updated. set m_RegenErrors from constructor values. returns true if okay. create and draw the Plane's icon in the screen background color. Create and draw the Plane's gnomon in its native color. true to include the plane name. (Optional) true if plane planel active and plane selected (default = false). (Optional) true to draw as enabled; false to draw as disabled (default = true). Create a PlaneGnomon for this plane in m_spGnomon. true to single instance. true if it succeeds, false if it fails. Return const pointer to m_spGnomon. The gnomon pointer. set regeneration errors. error mask to add. return previous error values. Regenerate if we're a linked plane. A reference to a MastercamPlanes object to get our parent plane we're linked to. True = dont update origin or matrix. True if it succeeds, false if it fails. Regenerates us to our associated entities. A reference to a MastercamPlanes object to get the view #'s from. True = dont update origin or matrix. (Optional) Pointer to a geometry map. If nullptr, we'll create one but it's expensive to do so. [0] = true if matrix updated [1] = true if origin updated [2] = additional transformation applied. Compares the given origin with our m_Origin to detect changes. The origin to compare with m_Origin. The comparison information. Values that represent plane origin information. Determines if we should NOT apply any additional transformation to the origin during regneration. True if origin should have any additional transformation stored in m_Transform applied when being regenerated, false if it should. Regenerates us to our associated geometry. A reference to a MastercamPlanes object to get the view #'s from. True = dont update origin or matrix. (Optional) Pointer to a geometry map. (Optional) True = Remove plane's associativity if it's not valid. True if it succeeds, false if it fails. Get's the largest difference of any of the coordinates in the matrix or origin. The matrix to compare ours with. The origin to compare ours with. A pair with first = the largest difference, second = difference position in the origin or matrix. Calls DebugPlaneStr() with the difference of this plane's matrix/origin with the given ones. The matrix to compare ours with. The origin to compare ours with. True to show the debug dialog, false to not. True if there is a difference, false if not. Calls DebugPlaneStr() with this plane's name. The message. Allocates for a plane based on type. The plane class (SystemMatrix, NamedPlane, etc). (Optional) ptr to plane to copy. Base class ptr to newly allocated plane. Convert a point in plane coordinates to world coordinates (map from plane's view, add the plane origin). The point in plane coordinates. P3D of world point relative to the plane's view and origin. Convert a point in world coordinates to plane coordinates (map to plane's view, subtract the plane origin). The point in world coordinates. P3D of world point relative to the plane's view and origin. Return value of m_Temporary. true if it succeeds, false if it fails. Set m_Temporary. if true, temporary plane will not be listed in Planes Manager and will be deleted on file/save. return previous value. Gets the lparam. Return value of m_Lparam. Set optional user value. value to set. Previous value. Increment or decrement ent.vw_refs in associated entities. Should only be called if in the current db. true = increment, false = decrement. return # of entities updated. Increment or decrement ent.vw_refs in associated entities. Should only be called if in the current db. true = increment, false = decrement. reference to geometry entities eptr/ID map, NULL will create one if regenerate is set to true. return # of entities updated. Gets constructor method. The constructor method. return CString of m_RegenErrors. The regen error string. return value of m_RegenErrors. The regen errors. Call up dialog to define new origin point for this plane. true = ask to associate with new geometry, false = do it. Erase plane icon on dialog startup, draw icon on dialog exit. true if we are editing an existing plane. False otherwise. [in,out] (Optional) CWnd to parent window of dialog. editingExistingPlane is only relevant if askToAssociateWithNewGeometry is true returns a pair: first = OriginSelection type, second = if Plane.m_Transform was updated. swap old entity ID for new ID. the old entity ID. the new entity ID. true = mark plane dirty if any ID's were swapped. returns # of ID's swapped. Erase the Plane's from the graphics window. Create and draw the Plane's wireframe icon in its native color. (Optional) true to force drawing (ignore m_DisplayMode). (Optional) true to include the plane name (default = true). (Optional) true if plane planel active and plane selected (default = false). (Optional) true to draw as enabled; false to draw as disabled (default = true). Convert this plane to an X6 op_view structure without overriding the op_view's work offset value. reference to X6 op_view structure to fill in. A reference to a MastercamPlanes object to get the view # from. true if it succeeds, false if it fails. Convert this plane to an X6 op_view structure. reference to X6 op_view structure to fill in. A reference to a MastercamPlanes object to get the view # from. true if it succeeds, false if it fails. Convert this plane to an X6 group_view structure. reference to X6 group_view structure to fill in. Convert this plane to an X6 view_ent structure. reference to X6 view_ent structure to fill in. A reference to a MastercamPlanes object to get the view # from. Convert this plane to an X6 view_ent structure. reference to prm_xform_view structure to fill in. remove association between a plane and any entity. Remove geometry association for the origin, matrix or both. True to delete from associated ent (Solid or mesh), false just zero out association info in this plane. (Optional) True to reset the extra transform information. True if it succeeds, false if it fails. Removes any link to another plane. The previous link (plane ID). validate relative plane type. relative plane (RelativeType::Front, etc) return true if relative type is valid. Validate coordinate display mask (lathe or mill). coordinate display mask type. return true if valid. Validate coordinate display type. coordinate display type. return true if valid. return true if the plane can be edited (not reserved, etc) the Plane to check. true = check if lock is on. true if the plane can be edited. Compare oldPlane against newPlane to determine if the change can affect a toolpath operation. New plane values. true if a member variable's change will affect a toolpath operation, false if it won't. Compare given plane to this, return true if differences are great enough to require a regeneration of this plane (i.e. matrix or origin changed, but not name, etc). The plane to compare. Returns mask (COMPARISON_MATRIX, etc). Check if this plane is parallel to given view #. SystemMatrix to compare with this. [in,out] reference to bool will be set to true if Z component is in the opposite direction. (Optional) true = allow opposite Z component check, false = all opposite Z component views are ignored. Return true if parallel. Check if entity ID is used in this plane. Entity IDs to check for. return true if any entity ID in the given set is associated with this plane. Check validity of plane type. PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE. (Optional) debug only warning. Return false if any other value was given in whichPlane. Get plane ID of the plane this plane is linked to. Return the ID of the plane this plane is linked (dependent) to, 0 if not linked. get the Plane's linking info (RelativeType::Front, etc), transform data The linking info. return true if we are associated to geometry. What type of association are you checking?. true if association found, false if not. Query if this object contains lathe coordinate display. true if lathe coordinate display, false if not. return true if this plane is a reserved plane, false if it is not. return true if this plane is a reserved plane, false if it is not. validate Plane creation method. int representing creation method (CreationMethod::ThreePoints, etc) returns true if valid. Return true if this plane is TOP at an origin of X0 Y0 Z0. true if top at zero, false if not. Return true if this plane's matrix and origin match given plane's matrix and origin. a plane to compare this to. (Optional) true = debug only warning if not equal. return true if equal within plane tolerance. Return true if this plane's matrix and origin match given matrix and origin. 3x3 matrix to compare. origin point in world coordinates to compare. (Optional) true = debug only warning if not equal. return true if equal within plane tolerance. calculate 3D intersection point within the given view for 2 entities. view to calculate intersection in. entity 1 of 2. entity 2 of 2. 2D selection point near entity 1. 2D selection point near entity 2. 2D t value point for entity 1. calculated intersection point. returns true if parallel. determine if the 2 given lines are parallel. line 1 of 2. line 2 of 2. returns true if parallel. determine the normal of the plane for two 3d lines. reject these lines (return false) if they do not lie in the same plane. line 1 of 2. line 2 of 2. normal of the plane that line0 and line1 lie in. returns true if flat. calculate a 3x3 matrixm view # and intersection point from 2 lines. line 1 of 2. line 2 of 2. calculated 3x3 matrix. calculated intersection point. returns true if successful. calculate a 3x3 matrix from 2 lines. line 1 of 2. line 2 of 2. calculated 3x3 matrix. returns true if successful. convert 3 points into 2 lines and calculate a 3x3 matrix and an intersection point. point 1 of 3. point 2 of 3. point 3 of 3. calculated 3x3 matrix. calculated intersection point. returns true if successful. rotate a Matrix33 about an axis by degrees. rotation amount in degrees. the X, Y or Z axis to rotate about. the Matrix33 to rotate. returns true if successful. rotate a Matrix33 by relative type. A reference to a MastercamPlanes object to get the view #'s from. [in,out] the Matrix33 to rotate. the relative type (RelativeType::Front, etc) returns true if successful. Multiply this plane's matrix by the given matrix. a Matrix33 object to multiple this by. Multiply two 3x3 matrices. a Matrix33 object. a Matrix33 object. the destination Matrix33 object ( m1 * m2) Sets new matrix, origin and transform after removing old transform. The Plane's new 3x3 matrix. The Plane's new origin point in world coordinates. returns true if successful. Transform this plane by the given transformation matrix. valid transformation matrix. transform plane origin too. If true, the transform is only applied if the plane is associated in origin or in orientation. (optional) if true, result matrix is initial plane matrix * transformation matrix. Otherwise, result matrix is transformation matrix * initial plane matrix. True if it succeeds, false if it fails. Rotates an existing non-reserved, non-locked plane. The axis to rotate about (X=0, Y=1, Z=2). The rotation angle in degrees. true if it succeeds, false if it fails. Transform this plane by a relative plane. A reference to a MastercamPlanes object to get the view #'s from. RelativeType::Front, RelativeType::Back, etc. Calculate the transformation matrix between to views and origins for bnci purposes. Source view. Source origin in world coordinates. Destination view. Destination origin in world coordinates. [in,out] Reference to transformation matrix to fill in. Return true if calculation successful and contents of xm is valid. Transform this for bnci purposes. The transformation. True to do origin. True if it succeeds, false if it fails. Calculate the transformation matrix between to views and origins. Source view. Source origin in world coordinates. Destination view. Destination origin in world coordinates. Return transformation matrix. Transform a matrix and origin. The transform. [in,out] The matrix to transform. [in,out] The world origin point to transform. (optional) if true, result matrix is initial plane matrix * transformation matrix. Otherwise, result matrix is transformation matrix * initial plane matrix. Sets the values in m_Link. Information describing the dependency. Previous value of m_Link. Inverse transform by m_Transform. Previous value of m_Transform. Sets our transform in m_Transform. The transformation matrix. Previous value of m_Transform. Initializes the m_Transform. (Optional) Which parts of the additional transformation do you want to initialize? Default = both matrix and origin. Previous value of m_Transform. Copy data that can be changed in a reserved Plane. The plane to copy from. Set plane's dirty flag. true = dirty (requires regneration), false = clean. return previous value. Sets coordinate display for all constructors. This will be the default coordinate display value assigned to the Plane's upon instantiation. CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD. true if it succeeds, false if it fails. Set the plane's coordinate display mode. CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD. return previous value, -1 if invalid coordinateDisplay. set the Plane's ouput comment to NCI mode. true = ouput Plane's comment to NCI. returns previous value. set the Plane's comment string. a comment. returns previous value. set display (whether it will be drawn) to on or off. 1 = on, 0 = off. returns previous value. set the Plane's origin. the Plane's new origin in world coordinates. true = remove info to associated geometry. returns previous value. set the Plane's origin. the Plane's new origin in world coordinates. returns previous value. Values that represent the return value of SelectOriginPoint (). set the Plane's 3x3 matrix (m_33) the Plane's new 3x3 matrix. returns true if successful. Set the plane type. PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE. Return previous value. set Plane relative to a WCS. a Plane ID (whatever the active WCS was at the time of setting) returns previous value. set the Plane's color. the Plane's color. returns previous value. set the Plane's work offset value. the Plane's work offset value. returns previous value. set the Plane's name. the Plane's name. returns true if successful. set the Plane's points and selected entity info used in it's definition. array of point info. returns size of array. set the unique ID of the plane. the new ID. (Optional) Info of the dependent parent plane. return the previous value of the ID. set the version. The version. return the previous version value. set selected flag. true = selected. return previous value of selected flag. set the creation method. int representing creation method (CreationMethod::ThreePoints, etc) returns previous value. Sets the value of m_SectionView. true = used as a section view. The previous value of m_SectionView. Casts the Plane pointer from a PlaneBasePtr to a Plane * if the class is PlaneClass::NamedPlane. The base. nullptr if it fails, else a valid Plane *. Casts the Plane pointer from a PlaneBasePtr to a Plane * if the class is PlaneClass::NamedPlane. The base. nullptr if it fails, else a valid Plane *. return the value of the 'dirty-needs regeneration' flag. return the value of the 'dirty-needs regeneration' flag. return true if coordinate display and mask match value (CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD) plane coordinate display filter (COORD_MASK_MILL, COORD_MASK_LATHE_X, COORD_MASK_LATHE_D or COORD_MASK_ALL) return true if coordinate display and mask match value. get the active coordinate display description. CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD. return description. Gets coordinate display mask from the coordinate display value of this. The coordinate display mask. return correct mask value for coordinate display value (CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD) The coordinate display. The coordinate display mask. return coordinate display value (CoordinateDisplayType::Mill, CoordinateDisplayType::LatheX or CoordinateDisplayType::LatheD) The coordinate display. return icon display mode (0=off, 1=on) The display mode. return comment output to NCI value. return comment output to NCI value. get the Plane's comment string. returns the Plane's comment string. Collect all the entity ID's used to make the Plane's origin. returns ID's collected in set. Collect all the entity ID's used to make the Plane's matrix. returns ID's collected in set. Collect all the entity ID's used to make the Plane. returns ID's collected in set. get the Plane's color. returns the Plane's color. get the Plane's work offset value. returns the Plane's work offset value. get a description of the Plane into a CStringArray. A reference to a MastercamPlanes object to get the view #'s from. # of places behind the decimal point. CStringArray to stuff description into. return size of strArray. Returns the view # of the plane's matrix. A reference to a MastercamPlanes object to get the view #'s from. The view number. get a description of the Plane. A reference to a MastercamPlanes object to get the view #'s from. return Plane description. get a description of the Plane. A reference to a MastercamPlanes object to get the view #'s from. machine type (MILL_MACHINE, LATHE_MACHINE, etc) plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE) (Optional) type of origin description (-1=origin in view coords, 0=no origin, 1=origin in world coords) return Plane description. get a description of the given Plane type. the plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE, PlaneType::WCSPLANE) return Plane type description. get a description of the Plane type. return Plane type description. Convert an int to a PlaneType. int type of the plane. PlaneType. Convert PlaneType to an int for use as an array index. Type of the plane. int. collect the 4 Plane types. The 4 types in CPLANE, TPLANE, GPLANE and WCS order. return selected flag. return selected flag. get both the origin geometry and the geometry entities used to create the Plane. array to copy the origin geometry into. array to copy the geometry into. entity ID-eptr map to look thru and find and extract entity from db with. ID's entities that could not be found in geomMap. returns true if any geometry was collected. get the geometry entities used to create the Plane. array to copy the geometry into. entity ID-eptr map to look thru and find and extract entity from db with. ID's entities that could not be found in geomMap. returns # of entities copied into the array. get the Plane's point' origin geometry entity. array to copy the geometry into. entity ID-eptr map to look thru and find and extract entity from db with. ID's entities that could not be found in geomMap. returns true if entity successfully retrieved form db. get the Plane's points and selected entity info used in it's definition. (Optional) True to include all 3 m_MatrixPoints[3], false for only one associated to geometry. Plane's points and selected entity info used in it's definition. read thru the current db and return a P_ID entity that matches the given origin. origin in world coordinates. The point ent. return geometry entity ID if successful. return the Plane's origin in the Plane's view coordinates. p_3d type to copy origin into. return true if successful. return the Plane's origin in the Plane's view coordinates. The origin view coordinates. Get the Plane's origin in world coordinates. p_3d type to copy origin into. return true if successful. return the Plane's origin in world coordinates. The origin world coordinates. Gets the value in m_Transform. the value in m_Transform. get the Plane's origin. returns the Plane's origin. return Plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE) return Plane type. return the Plane's relative-to-a-WCS-Plane-ID. return the Plane's relative-to-a-WCS-Plane-ID. Gets creation method description. The creation method description. return the creation method. returns the creation method. Gets the value of m_SectionView. The value of m_SectionView. Query if 'thePlane' is equal. the plane to compare to this. The string to fill in with the name of the non-matching member variable. true if equal, false if not. compare this to another plane. The object. true if the first parameter is less than the second. compare this to an group_view structure. The object. true if the parameters are considered equivalent. compare this to an op_view structure. The object. true if the parameters are not considered equivalent. compare this to a Matrix33 object. The object. true if the parameters are considered equivalent. compare this to an group_view structure. The object. true if the parameters are considered equivalent. compare this to an op_view structure. The object. true if the parameters are considered equivalent. comparison operator. The object. true if the parameters are considered equivalent. comparison operator. The object. true if the parameters are not considered equivalent. subtraction-assignment operator. The third m 3. The result of the operation. subtraction-assignment operator. The object. The result of the operation. addition-assignment operator. The third m 3. The result of the operation. addition-assignment operator. The object. The result of the operation. Assignment operator. The plane base raw pointer. A shallow copy of this object. Assignment operator. The plane base shared pointer. A shallow copy of this object. assignment operator. The object. A shallow copy of this object. assignment operator. The object. A shallow copy of this object. assignment operator. The object. A shallow copy of this object. copy constructor. The object. destructor. zero out all member variables that determine if a Plane is 'reserved'. zero out all member variables. Constructor. The plane. Constructor. The plane. parameteritized constructor for a normal. the normal. plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE) will be set to point entry method (PEC_CENTER, PEC_INTERSECT, etc) or 0 for failure. parameteritized constructor for a normal. the normal. plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE) will be set to point entry method (PEC_CENTER, PEC_INTERSECT, etc) or 0 for failure. if true, the matrix of the new plane is set based on the normal) parameteritized constructor for an entity array. It figures out the appropriate constructor to call based on the number of entities it contains. A reference to a MastercamPlanes object to get the view #'s from. array of entities. location from original selection. line endpoint t value. plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE) will be set to point entry method (PEC_CENTER, PEC_INTERSECT, etc) or 0 for failure. if true, the matrix of the new plane is set based on the reference entities) parameteritized constructor for a single entity types that contain their own matrix or normal info (like arcs) A reference to a MastercamPlanes object to get the view #'s from. single entity (arc, spine, nurb, surface, cross-hatch, etc. location from original selection. line endpoint t value. plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE) will be set to point entry method (PEC_CENTER, PEC_INTERSECT, etc) or 0 for failure. if true, the matrix of the new plane is set based on the reference entity) parameteritized constructor for 3 point entities. A reference to a MastercamPlanes object to get the view #'s from. point entity lying on the X axis. point entity lying on the Y axis. point entity defining Z axis and origin. line endpoint t value. plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE) will be set to 1 for successful intersection, 2 for successful endpoint, or 0 for failure. parameteritized constructor for 2 line entities. A reference to a MastercamPlanes object to get the view #'s from. line entity defining X axis. line entity defining Y axis. line endpoint t value. plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE) will be set to point entry method (PEC_CENTER, PEC_INTERSECT, etc) or 0 for failure. parameteritized constructor. Mastercam op_view type. plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE) parameteritized constructor. Mastercam group_view type. plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE) Constructor. Mastercam view entity. parameteritized constructor. 3x3 matrix. plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE) parameteritized constructor. 3x3 matrix. Plane origin in world coordinates. plane type (PlaneType::CPLANE, PlaneType::TPLANE, PlaneType::GPLANE or PlaneType::WCSPLANE) Default constructor. serialize this. the destination/source archive object. Validates this object, zero-out if not. True if it succeeds, false if it fails. Query if this object is valid. True if valid, false if not. Inequality operator. The object. True if the parameters are not considered equivalent. Equality operator. The object. True if the parameters are considered equivalent. Constructor. Identifier for the parent plane. Type of the relative (RelativeType::Off, RelativeType::Front, etc.) Constructor. Type of the relative. Class containing plane dependency to another plane info. Constructor method (saved in m_ConstructorMethod). used when searching for matching planes. comparison values to determine whether a regeneration of the plane is required. Values that represent whether the origin and/or matrix is associated to geometry. Plane icon drawing modes. relative plane types. Plane creation methods. Sets the value of m_QuickCplaneID. Identifier for the plane. Previous value of m_QuickCplaneID. Gets the value of m_QuickCplaneID. the value of m_QuickCplaneID. Gets status bar plane label from m_StatusBarPlaneLabels using an int. Type of plane in int form. The status bar plane label. Gets status bar plane label from m_StatusBarPlaneLabels. Type of plane. The status bar plane label. Query if 'coordinateDisplay' is lathe coordinate display. The coordinate display. true if lathe coordinate display, false if not. Gets viewport information. The viewport information. Sets viewport information. Information describing the vp. Returns previous value Gets the lock status for the given plane CPLANE, TPLANE, WCS or GPLANE. The lock. Sets a lock on the given plane CPLANE, TPLANE, WCS or GPLANE. LOCK_ALL_OFF, LOCK_ORIGIN or LOCK_MATRIX. return previous value. Gets the previous matrix/origin pair. CPLANE, TPLANE, WCS or GPLANE. The previous matrix/origin pair. Set m_Previous[] matrix/origin pairs. CPLANE, TPLANE, WCS or GPLANE. The matrix to set. The origin in world coordinates. return previous value. Gets plane identifier. CPLANE, TPLANE, GPLANE or WCSPLANE The plane ID for the requested active plane. Set m_PlaneIDs[]. The which plane. plane ID to set. The view no of the plane's matrix to set in m_CacheViewNos. return previous value. return m_UnnamedOrigin. const reference to m_UnnamedOrigin. Set m_UnnamedOrigin. origin to set. return previous value. return a Matrix33. Copy of m_UnnamedM33. Set m_UnnamedM33. matrix to set. return previous value. Values that represent PLANE_LOCK. Initialises the status bar plane labels in m_StatusBarPlaneLabels. size of m_StatusBarPlaneLabels. Zero out member variables. (Optional) Initialize 4 system planes to this valid ID, or -1 to preserve the follow-rules. assignment operator. The object. A shallow copy of this object. serialize this. the destination/source archive object. copy constructor. The object to copy. destructor. Default constructor. SystemPlanes class contains current system construction, tool, WCS and graphics planes Sets current graphics view information. true if it succeeds, false if it fails. Destructor. Default constructor. Defines an alias representing the plane base class pointer. Information about the active viewport. Convert an MBCS string to a wide string. The archive. If non-null, the wide character buffer. The number of characters converted. Correct imperfect matrix in m_33. first = matrix is valid, second = values were adjusted to make valid. set the Plane's 3x3 matrix (m_33) the Plane's new 3x3 matrix. returns true if successful. Validate plane class. The plane class. true for warning. true if valid, false if not. Return value of m_Temporary. true if it succeeds, false if it fails. Set m_Temporary. if true, temporary plane will not be listed in Planes Manager and will be deleted on file/save. return previous value. Builds and returns system matrix name. The identifier. The system matrix name. Enforce naming rules for this Plane's name. The name to check and alter. return true if name has been altered. set the Plane's name. the Plane's name. returns true if successful. set Plane lock's state. true to lock, false to unlock. Previous value. set Plane as reserved (uneditable and unmovable) true = reserved. returns previous value. return Plane lock's state. return Plane lock's state. Sets the tolerance for the plane. the new tolerance. The old tolerance. return Plane tolerance value. The tolerance. get the Plane's name. returns the Plane's name. return true if the the Plane is a reserved Plane. return true if the the Plane is a reserved Plane. get the Plane's 3x3 matrix (m_33) 3x3 matrix to fill in. get the Plane's 3x3 matrix (m_33) returns the Plane's 3x3 matrix. get the Plane's 3x3 matrix (m_33) reference returns the Plane's 3x3 matrix. set the unique ID of the plane. Identifier for the plane. returns the previous value. get the value of m_ID's m_ID. returns the value of m_ID's m_ID. get the value of m_ID's m_ID. returns the value of m_ID's m_ID. get the unique ID of the plane. returns the plane ID. Sets value of m_GUID. New value. Previous value. Return value of m_GUID. Return value of m_GUID. set the version. The version. return the previous version value. return the version. return the version. Query if 'obj' is equal. The object. The string to fill in with the name of the non-matching member variable. true if equal, false if not. Return reference to X, Y or Z component of m_33. The X, Y or Z axis (0, 1 or 2). const reference to X, Y or Z axis. compare this to another plane. The object. true if the first parameter is less than the second. compare this to a Matrix33 object. The object. true if the parameters are considered equivalent. comparison operator. The object. true if the parameters are considered equivalent. compare this to an op_view structure. The object. true if the parameters are not considered equivalent. compare this to an op_view structure. The object. true if the parameters are considered equivalent. comparison operator. The object. true if the parameters are not considered equivalent. assignment operator. The object. A shallow copy of this object. assignment operator. The object. A shallow copy of this object. assignment operator. The object. A shallow copy of this object. Sets the class. The plane class. Previous value. Gets the class. The class. serialize this. the destination/source archive object. destructor. Copy constructor. The object. parameteritized constructor. 3x3 matrix. Identifier for the plane. The name. parameteritized constructor. 3x3 matrix. Default constructor. A macro that defines plane base version. Mastercam PlaneBase definition Multiply a 4D vector by a 4x3 matrix. 4D Vector. 4x3 Matrix. Resulting 3D vector. Multiply a 4x3 matrix by a 4D vector. 4x3 Matrix. 4D Vector. Resulting 3D vector. Multiply (and assign) a 3x3 matrix by another. Matrix 1. Matrix 2. Reference to mat1. Multiply two 3x3 matrices. Matrix 1. Matrix 2. Resulting matrix. Multiply (and assign) a 3D vector by a 3x3 matrix. Matrix. Vector. Reference to vec. Multiply a 3D vector by a 3x3 matrix. Matrix. Vector. Resulting vector. Multiply a 3D vector by a 3x3 matrix. Matrix. Vector. Resulting vector. Gets the description. The description. Query if this object is valid. true to warn. true if valid, false if not. Sets an identifier. Identifier for the. . Gets the identifier. The identifier. Gets the identifier. The identifier. Sets the class type. the class. previous value. Gets the class type. The class type. Sets the GUID identifier. Unique identifier. Previous value. Gets the GUID identifier. The identifier. Gets the version. The version. Inequality operator. The object. true if the parameters are not considered equivalent. Equality operator. The object. true if the parameters are considered equivalent. Greater-than comparison operator. The object. true if the first parameter is less than the second. Less-than comparison operator. The object. true if the first parameter is less than the second. Assignment operator for a long. Will create a NamedPlane type ID. Identifier for the plane. A shallow copy of this object. Assignment operator. The object. A shallow copy of this object. serialize this. the destination/source archive object. Destructor. Constructor. A view entity. Constructor. A group view. Constructor. An operation view. Identifier for the plane. (Optional) The plane class. Constructor. The view no. Constructor. Identifier for the plane. the plane class type. Copy constructor. The object. Default constructor. (Optional) the plane class. A macro that defines a null plane ID. The plane identifier ( plane class undefined) Plane ID map key. Assignment operator. The view no. A shallow copy of this object. Greater-than-or-equal comparison operator. The view no. true if the first parameter is less than or equal to the second. Greater-than comparison operator. The view no. true if the first parameter is greater than to the second. Less-than-or-equal comparison operator. The view no. true if the first parameter is less than or equal to the second. Less-than comparison operator. The view no. true if the first parameter is less than the second. Inequality operator. The object. true if the parameters are not considered equivalent. Equality operator. The view no. true if the parameters are considered equivalent. Destructor. Copy constructor. The object. Constructor. The view no. Constructor. The view no. Constructor. Query if this object is valid. true if valid, false if not. Query if this object is viewport view. true if scratch view, false if not. Query if this object is scratch view. true if scratch view, false if not. Query if 'viewType' is scratch view type. Type of the view. True if scratch view type, false if not. Gets short view no. The short view no. Gets view no. The view no. Greater-than-or-equal comparison operator. The view no. true if the first parameter is less than or equal to the second. Greater-than comparison operator. The view no. true if the first parameter is greater than to the second. Less-than-or-equal comparison operator. The view no. true if the first parameter is less than or equal to the second. Less-than comparison operator. The view no. true if the first parameter is less than the second. Inequality operator. The object. true if the parameters are not considered equivalent. Inequality operator. The view no. true if the parameters are not considered equivalent. Equality operator. The view no. true if the parameters are considered equivalent. Equality operator. The view no. true if the parameters are considered equivalent. Assignment operator. The view no. A shallow copy of this object. Destructor. Copy constructor. The object. Constructor. The view no. Constructor. The view no. Constructor. The view no. Constructor. The view no. Constructor. Class to be used as view number parameter instead of a short. Values that represent the 'scratch view' types. Tokenize the NCI strings. The delimiter. The first string. The second string. The first array. The second array. An INT_PTR. Makes both NCI strings the same length. The first NCI string. The second NCI string. Mark start of the NCI lines. The first NCI string. The first indx. The second NCI string. The second indx. true if it succeeds, false if it fails. Mark the differences in the NCI lines as compared to one another. The first NCI string. The second NCI string. An number of differences marked. Format the NCI line. The binary NCI line. The string to format. Compares NCI of the 3 states to the given nci accuracy. The comparison parameters. Destructor. Default constructor. Constructor. (Optional) the nci accuracy. (Optional) If non-null, list of strings for the report trailer. Comparison parameters. Utility class to compare NCI of previous version files in 3 states: 1 - from disk before file is read in 2 - from disk immediately after file is read in 3 - after regeneration Reports on operation's matrix/origin values. the operation. Dump the contents of a CStringArray to a file and display in the default editor. The array to dump. True to add time of day string on first line. [in,out] Filename of the file. true to edit file. Empties s_spIInterrogateMastercamFile. Loads s_spIInterrogateMastercamFile. Returns s_spIInterrogateMastercamFile. Gets a copy of the entity with the given ent.ent_idn value from m_spEntityMap. Entity type info of the entity to retrieve. the ent. true if the entity was found and copied into theEnt. Return true if all the operations that exist in our current database are loaded. true if all the operations that exist in our current database are loaded. Removes the contents of m_OpGroup, m_OtherGroups and m_GroupGeometry. Copies the groups from an external file into m_OpGroups and m_OtherGroups. Filename of the external Mastercam file. Copies the groups from our current db into m_OpGroups and m_OtherGroups. Adds the contents of the given group list to m_OpGroup and m_OtherGroups. List of groups. Setter for the start of bnci fpos of the source file The bnci fpos for the source file Getter for the start of bnci fpos of the source file Returns long. Preset masks and loads this object with plane info from an external Mastercam file. Mastercam file name. operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) for planes. Preset masks and loads this object with plane info from the current db. Number of planes loaded. Preset masks and loads this object with operations and their NCI from an external Mastercam file. Filename of the Mastercam file. operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) true if it succeeds, false if it fails. Preset masks and loads this object with operations and their NCI from the current db. true if it succeeds, false if it fails. Preset masks and loads this object with just the operations whose IDs match ones in the given opIDs parameter and their toolpath entities from an external Mastercam file. Filename of the Mastercam file. The IDs of operations to load. operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) true if it succeeds, false if it fails. Preset masks and loads this object with just the operations whose IDs match ones in the given opIDs parameter and their toolpath entities from the current db. The IDs of operations to load. Operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) true if it succeeds, false if it fails. Preset masks and loads this object with just operations and toolpath entities from the current db. true if it succeeds, false if it fails. Preset masks and loads this object with just operations and TP_OPID type toolpath entities from an external Mastercam file. TP_OPID type toolpath entities are typically used in transform and nesting operations. Mastercam file name. operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) for dependencies. Preset masks and loads this object with just operations and TP_OPID type toolpath entities from the current db. TP_OPID type toolpath entities are typically used in transform and nesting operations. true if it succeeds, false if it fails. Preset masks and loads this object with just the operations from the current db. Filename of the Mastercam file. operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) The number of operations loaded. Preset masks and loads this object with just the operations from the current db. The number of operations loaded. Loads this object using the current db. true if it succeeds, false if it fails. Loads this object using the given mcx file name. Filename of the Mastercam file. Operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) The IDs of the operations to load, empty = all. Collect only these types of toolpath entities, empty = all. (Optional) What are we loading for? true if it succeeds, false if it fails. Tests operation code against masks before loading NCI into an operation. The operation code. true if the test passes, false if the test fails. Tests operation code against masks before loading into m_Operations. The operation code. true if the test passes, false if the test fails. Tests tp_net against masks before loading into m_Operations.m_TpEnts. The entity info. true if the test passes, false if the test fails. Tests operation against masks before loading into m_Operations. The entity info. true if the test passes, false if the test fails. Tests tool against masks before loading into m_Tools. The entity. true if the test passes, false if the test fails. Tests view_ent against masks before loading into m_pPlanes. The entity. true if the test passes, false if the test fails. Tests planes against masks before loading into m_pPlanes. The entity. true if the test passes, false if the test fails. Tests geometry against masks before loading into m_Geometry. The entity info. true if the test passes, false if the test fails. Validate operation iterator from m_Operations (since m_Operations is public). The iterator. true if valid, false if not. Initializes the bnci extents. Return true if dependent operation types exist in m_Operaitons. Return true if dependent operation types exist in m_Operaitons. Builds a vector of all the eptrs in this. A shared ptr to a vector of eptrs in this. Sets m_Masks. The masks to set. Gets entity map. The entity map. Gets the planes. The planes. Setter for rectangle center p-3d point Getter for rectangle center Returns p_3d Setter for rectangle's upper right corner p-3d point Getter for rectangle's upper right corner Returns p_3d Setter for rectangle's lower left corner p-3d point Getter for rectangle's lower left corner Returns p_3d Gets a refrence to m_Masks. Reference to m_Masks. Gets bad TP geometry reference ids. The bad TP geometry reference ids. Getter for array of toolpath entities that have no parent operation Returns CFposEntArray reference Getter for array of geometry entity copies referenced by operations from the source file Returns CFposEntArray reference Getter for Map of operation copies from the source file Returns OpMap Gets Op groups. The Op groups. Gets const reference to m_LoadCode. const reference to m_LoadCode. Swap the entity ptrs. The map geometry entity ID, pair of old eptr and new eptr. true to rewrite the entities to the current database. true to mark affected toolpath operations dirty. Number of substitutions that occurred. Removes the operation described by opID from the map m_Operations. Identifier for the operation. true if it succeeds, false if it fails. Adds (and replaces if needed) an operation to the map m_Operations. true if entity is from an external file, false for the current db. The operation entity. operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) An OpMap::iterator where the operation was added. Returns a vector of all the operations' IDs in order of the global Operation Manager. A vector of all the dependent operations' IDs. Gets the file name of what's loaded. The file name. Sets the contents of m_MaskNciOpcodes to filter which operation's NCI is loaded when calling load functions. The TP_OPCODE mask. Size of m_MaskNciOpcodes array after setting. Sets the contents of m_MaskOpcodes to filter which operations are loaded when calling load functions. The TP_OPCODE mask. Size of m_MaskOpcodes array after setting. Gets geometry entity pointer. Identifier for the ent. The geometry entity pointer. Gets operation pointer by identifier. Identifier for the operation. null if it fails, else the operation pointer by identifier. Gets library operation pointer by identifier. Identifier for the operation. null if it fails, else the library operation pointer by identifier. Returns a vector of toolpath entities stored under the operation. Identifier for the operation. The operation ent to fill in. Collect only these types of toolpath entities, empty = all. The toolpath entities. Query if this object was loaded from an external file. true if external file, false if not. Query if this object is loaded (returns value of m_Loaded). true if loaded, false if not. Calculates the extents of the bnci in this object. (Optional) true to relative wcs. (Optional) true to adjust to TOS. (Optional) true to delete the tool radius from "Z". (Optional) true to include the end of rapids in extents calc. true if it succeeds, false if it fails. Preset masks and loads this object with operations and their NCI from and external Mastercam file. Filename of the external Mastercam file. List of NCI gcodes to include, empty gcodeMask = all NCI lines. operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) (Optional) the include operation ids. (Optional) the exclude operation ids. true if it succeeds, false if it fails. Preset masks and loads this object with operations and their NCI from the current db from just the operations whose IDs match ones in the given pIncludeOpIDs parameter and not ones whose ID's match ones in the given pExcludeOpIDs parameter. true = attempt to use NCI cache in global Cnc::Globals::Planes::GetPlanes (). List of NCI gcodes to include, empty gcodeMask = all NCI lines. (Optional) the include operation ids. (Optional) the exclude operation ids. true if it succeeds, false if it fails. Preset masks and loads this object with work offset information from just the operations whose IDs match ones in the given includeOpIDs parameter and not ones whose ID's match ones in the given excludeOpIDs parameter. true = use NCI cache, false = read from disk. The operations to include. The operations to exclude. true if it succeeds, false if it fails. Preset masks and loads this object for just the 1 operation from the current db. Identifier for the operation. true to include NCI, false to exclude NCI. (Optional) if (includeNci == true), ptr to NCI gcode mask, nullptr to read in all. pointer to operation, null if it fails. Initializes the masks. Transfers the contents described by spInFile. ptr to snapshot of current Mastercam file. Empties this object. Destructor. Default constructor. Utility class to collect entities and info of the current db or an external Mastercam file. Preset masks and loads this object with just the operations whose IDs match ones in the given opIDs parameter and their toolpath entities from an external Mastercam file. ptr to snapshot of current Mastercam file. Filename of the Mastercam file. operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) The IDs of operations to load. Collect only these types of toolpath entities, empty = all. true if it succeeds, false if it fails. Loads an interrogate. ptr to snapshot of current Mastercam file. The operation ids. The TP mask. (Optional) The load code. True if it succeeds, false if it fails. Loads an interrogate. ptr to snapshot of current Mastercam file. Filename of the mcx file. The ent allocation. (Optional) The load code. True if it succeeds, false if it fails. Loads interrogate file. ptr to snapshot of current Mastercam file. (Optional) The load code. True if it succeeds, false if it fails. Builds and loads an IInterrogateMastercamFile class containing info from your current file. Entity masks. A std::shared_ptr<IInterrogateMastercamFile> Builds and loads an IInterrogateMastercamFile class containing info from your current file. (Optional) The load code (to preset m_Masks). A std::shared_ptr<IInterrogateMastercamFile> Loads. ptr to snapshot of current Mastercam file. The operation i ds. The TP mask. (Optional) The load code. A std::pair<bool,std::shared_ptr<IInterrogateMastercamFile>> Loads. ptr to snapshot of current Mastercam file. The operation i ds. The TP mask. (Optional) The load code. A std::pair<bool,std::shared_ptr<IInterrogateMastercamFile>> Loads. ptr to snapshot of current Mastercam file. Filename of the mcx file. The ent allocation. (Optional) The load code. A std::pair<bool,std::shared_ptr<IInterrogateMastercamFile>> Loads the given load code. ptr to snapshot of current Mastercam file. (Optional) The load code to load. A std::pair<bool,std::shared_ptr<IInterrogateMastercamFile>> Builds and loads an IInterrogateMastercamFile class containing info from your current file. Entity masks. A std::pair<bool,std::shared_ptr<IInterrogateMastercamFile>> Builds and loads an IInterrogateMastercamFile class containing info from your current file. Entity masks. A std::shared_ptr<IInterrogateMastercamFile> Default constructor. Destructor. Builds and loads an IInterrogateMastercamFile class containing info from your current file. The load code (preset m_Masks). A std::shared_ptr<IInterrogateMastercamFile> Creates collection of entities and info of current db or external Mastercam files. Constructor. pointer to an eptr in the entity. ent.ent_idn of entity that eptr resides in. ent.ent_idn of entity that m_pEptr points to. Entity information for MapEptrs Gets entity map. The entity map. Gets the planes. The planes. Setter for rectangle center p-3d point Getter for rectangle center Returns p_3d Setter for rectangle's upper right corner p-3d point Getter for rectangle's upper right corner Returns p_3d Setter for rectangle's lower left corner p-3d point Getter for rectangle's lower left corner Returns p_3d Gets a const reference to m_Masks. const reference to m_Masks. include/exclude masks for loading. Gets bad TP geometry reference ids. The bad TP geometry reference ids. Getter for array of entities without references from the source file Returns CFposEntArray reference Getter for array of geometry entity copies referenced by operations from the source file Returns CFposEntArray reference Getter for Map of operation copies from the source file Returns OpMap Gets Op groups. The Op groups. Gets const reference to m_LoadCode. const reference to m_LoadCode. Swap the entity ptrs. The map geometry entity ID, pair of old eptr and new eptr. true to rewrite the entities to the current database. true to mark affected toolpath operations dirty. Number of substitutions that occurred. Removes the operation described by opID from the map m_Operations. Identifier for the operation. true if it succeeds, false if it fails. Adds (and replaces if needed) an operation to the map m_Operations. true if entity is from an external file, false for the current db. The operation entity. operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) An OpMap::iterator where the operation was added. Defines an alias representing the operation map pointer. Defines an alias representing the operation map (operation ID, copy of operation). Returns a vector of all the operations' IDs in order of the global Operation Manager. A vector of all the dependent operations' IDs. Gets the file name of what's loaded. The file name. Sets the contents of m_MaskNciOpcodes to filter which operation's NCI is loaded when calling load functions. The TP_OPCODE mask. Size of m_MaskNciOpcodes array after setting. Sets the contents of m_MaskOpcodes to filter which operations are loaded when calling load functions. The TP_OPCODE mask. Size of m_MaskOpcodes array after setting. Gets geometry entity pointer. Identifier for the ent. The geometry entity pointer. Gets operation pointer by identifier. Identifier for the operation. null if it fails, else the operation pointer by identifier. Gets library operation pointer by identifier. Identifier for the operation. null if it fails, else the library operation pointer by identifier. Returns a vector of toolpath entities stored under the operation. Identifier for the operation. The operation ent to fill in. Collect only these types of toolpath entities, empty = all. The toolpath entities. Query if this object was loaded from an external file. true if external file, false if not. Query if this object is loaded (returns value of m_Loaded). true if loaded, false if not. Calculates the extents of the bnci in this object. (Optional) true to relative wcs. (Optional) true to adjust to TOS. (Optional) true to delete the tool radius from "Z". (Optional) true to include the end of rapids in extents calc. true if it succeeds, false if it fails. Preset masks and loads this object with operations and their NCI from and external Mastercam file. Filename of the external Mastercam file. List of NCI gcodes to include, empty gcodeMask = all NCI lines. operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) (Optional) the include operation ids. (Optional) the exclude operation ids. true if it succeeds, false if it fails. Preset masks and loads this object with operations and their NCI from the current db from just the operations whose IDs match ones in the given pIncludeOpIDs parameter and not ones whose ID's match ones in the given pExcludeOpIDs parameter. true = attempt to use NCI cache in global Cnc::Globals::Planes::GetPlanes (). List of NCI gcodes to include, empty gcodeMask = all NCI lines. (Optional) the include operation ids. (Optional) the exclude operation ids. true if it succeeds, false if it fails. Preset masks and loads this object with work offset information from just the operations whose IDs match ones in the given includeOpIDs parameter and not ones whose ID's match ones in the given excludeOpIDs parameter. true = use NCI cache, false = read from disk. The operations to include. The operations to exclude. true if it succeeds, false if it fails. Preset masks and loads this object for just the 1 operation from the current db. Identifier for the operation. true to include NCI, false to exclude NCI. (Optional) if (includeNci == true), ptr to NCI gcode mask, nullptr to read in all. pointer to operation, null if it fails. Loads this object using the given mcx file name. Filename of the Mastercam file. operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) The IDs of the operations to load, empty = all. Collect only these types of toolpath entities, empty = all. (Optional) What are we loading for? true if it succeeds, false if it fails. Initializes the masks. Transfers the contents described by spInFile. ptr to snapshot of current Mastercam file. Empties this object. Destructor. Utility class to collect entities and info of the current db or an external Mastercam file. Initializes the bnci extents. Reads the operation's nci section from fposStartOfSection thru fposEndOfSection into m_spBnciRW. [in,out] If non-null, the open file. The file position to start reading. The file end position of the last line to read. The gcode mask. The number of lines read into m_spBnciRW. Reads the operation's nci section into m_spBnciRW. true = attempt to use NCI cache in global Cnc::Globals::Planes::GetPlanes (). (Optional) The gcode mask. The number of lines read into m_spBnciRW. Calculates the bnci extents. (Optional) true to relative wcs. (Optional) true to adjust to TOS. (Optional) true to delete the tool radius from "Z". (Optional) true to include the end of rapids in extents calc. true if successful. Free the operation's varaible length data. Empties this object. Gets a ptr to the operation. null if it fails, else the operation pointer. Destructor. Constructor. true if entity is from an external file, false for the current db. The operation entity. operation's variable length data mode (DontLoad, LoadAndFree, LoadAndKeep) Copy constructor. The object. Default constructor. Values that represent how to load operations' variable length data when interrogating external Mastercam files. A toolpath operation's entity, associated toolpath entities and NCI information. Sets value of m_UseMultiMap. true = allow duplicate keys in m_Map, false = ensure unique keys (like std::map). Previous value of m_UseMultiMap. Adds theEntity to m_Map. The map key. true if entity is from an external file, false for the current db. the entity. A MapType::iterator to the item added. Assignment operator. Source for the object. A shallow copy of this object. Copy constructor. The object. Destructor. Defines an alias representing type of the map. Default constructor. Array of entity information. Defines an alias representing type of the byte. Copies the critical depths from m_CriticalDepths to theEnt. the entity to copy to. true to just zero out the ent. true if it succeeds, false if it fails. Allocate memory to house the entity. The entity size. nullptr if it fails, else an ent*. Initializes this object. Gets const reference to m_FormulaeFile. const reference to m_FormulaeFile. Gets const reference to m_CriticalDepths. const reference to m_CriticalDepths. Gets a copy of the ent defined in m_spBlock. the entity to fill in. (Optional) true to copy variable length parameters (critical depths, formulae file, etc.). Size of entity if successful, 0 or -1 on failure. Returns an ent* to m_spBlock. Returns an ent* to m_spBlock. Gets the size of theEnt. the entity. The ent size. Gets the entity stored in m_spBlock from the current database. The entity to fill in. Size of entity if successful, 0 or -1 on failure. Replaces the given entity in m_spBlock. The entity. Size of entity if successful, 0 or -1 on failure. Allocate memory and copy entity in member variable. true if entity is from an external file, false for the current db. The entity to attach. Size of entity if successful, 0 or -1 on failure. Destructor. Default constructor. Entity information. Ensure the group name is unique. [in,out] the group name. Return true if name altered. Gets pointer to the group by its ID. Identifier for the group. Null if it fails, else the pointer by identifier. Gets the next unique identifier. The next unique identifier. Resets the invalid parent group identifiers in groups. Clears the select bits in groups' entities or all entities in the db. The IDs of the groups that contain the entities to clear the select bits from. Empty = clear the SELECT_BIT from all entities in the db. True to redraw the entities. Visits the stored identifiers of associated entities and updates them via the supplied visitor. The visitor that will update the stored identifiers of associated entities. Visits the identifiers of the entities that this entity is associated to. The visitor that will accept the identifiers of the associated entities. Removes any IDs of entities that no longer exist in the db from the groups. List of IDs for groups to check, empty to check all groups. Number of entity IDs removed. Appends another GroupListEntity to this. The GroupListEntity that contains the groups we want to append. A map of source group ID's and the actual group IDs they were assigned if any conflicts with existing groups were found. Makes entity map using all the entity ids (ent.ent_idn) from all the group in this. Identifiers for the groups that contain the entities you want to make a map of. True to save a copy of the entity in the EntityMap. A std::shared_ptr<EntityMap> Remove ALL entity ID's from our groups with the given IDs. List of group IDs to remove from. Gets a map of group IDs and the entities that belong to them from the given entIds. List of identifiers (ent.ent_idn) for the entities. Map of group IDs and the entities that belong to them from the given entIds. Build and return a list of entity eptrs (ent.eptr) from the current db referenced by the groups. List of identifiers for the groups. List of entity eptrs (ent.eptr) from the current db referenced by the groups. Build and return a list of entities from the current db referenced by the groups. List of identifiers for the groups. The entities. Sets the ent.sel value on entities from groups in the current db. The IDs of the groups to collect entities from. Select bits to clean in ent.sel (except ALIVE_BIT). Select bits to set in ent.sel (except ALIVE_BIT). True to also draw the entities. A list of eptrs of the entities in these groups that changed. Adds a group to the underlying container. [in,out] The group to add. const pointer to the newly added group, nullptr if failed. Adds a group to the underlying container. [in,out] The group to add. const pointer to the newly added group, nullptr if failed. Gets group list type. The group list type. Gets all the child group identifiers of the group with the given ID. Identifier for the parent group. The child group identifiers. Gets all the parent group identifiers of the group with the given ID. Identifier for the group. The parent group identifiers. Attempt to cast a BaseGroup pointer to a ToolpathGroup pointer (group type is checked). pointer to a BaseGroup. Null if it fails, else a pointer to a const ToolpathGroup. Attempt to cast a BaseGroup pointer to a GeometryGroup pointer (group type is checked). pointer to a BaseGroup. Null if it fails, else a pointer to a const GeometryGroup. Make a copy of any type of group and return a shared_ptr to a BaseGroupPtr. The group to copy. A BaseGroupPtr. Adds the standard system GROUP and RESULT groups. Gets a const toolpath group pointer from the underlying map. Name of the group (not case sensitive). Null if it fails, else the geometry group pointer. Gets a const toolpath group pointer from the underlying map. Identifier for the group. Null if it fails, else the toolpath group pointer. Queries if a given name exists. The name to check. Identifier for the group to exclude in the check. True to warn of existing name. True if name exists, otherwise false. Gets a const geometry group pointer from the underlying map. Name of the group (not case sensitive). Null if it fails, else the geometry group pointer. Gets a const geometry group pointer from the underlying map. Identifier for the group. Null if it fails, else the geometry group pointer. Unhighlight the entities referenced by the groups with the given IDs in our current db. The IDs of the groups to unhighlight. Highlight the entities referenced by the groups with the given IDs in our current db. The IDs of the groups to highlight. true = first unhighlight all entities, false = append to current highlightment. Unelect the entities referenced by the groups with the given IDs in our current db. The IDs of the groups to unselect. True to draw the entity. Select the entities referenced by the groups with the given IDs in our current db. The IDs of the groups to select. true = first unselect all entities, false = append to current selections. True to draw the entity. Swap entity identifiers in the given groups. List of group IDs to swap entity IDs in. old entity ID to remove. new entity ID to replace the old one with. set of IDs of groups updated. Swap entity identifiers in the given groups. List of group IDs to swap entity IDs in. Map of old and new entity IDs to swap in groups. set of IDs of groups updated. Removes the entity identifiers that are NOT in the given EntityMap. The entity map that contains valid entities. True to delete any groups that become empty . Total number of ent.ent_idn removed the groups. Remove entity ID's from our groups with the given IDs. List of group IDs to remove from. List of identifiers for the entities (ent.ent_idn) to remove from the groups. (Optional) True to delete the group if it's now empty. Total number of ent.ent_idn removed the groups. Adds entities from our db by their matching select bit (ent.sel) to the groups with the given IDs. List of group IDs to add to. The select bits (SELECT_BIT, GROUP_BIT, etc). Total number of ent.ent_idn added to the groups. Adds entity ID's to groups with the given IDs. List of group IDs to add to. List of identifiers for the entities (ent.ent_idn) to add to the groups. Total number of ent.ent_idn added to the groups. Gets a set of group IDs that reference the given eptrs. List of eptrs (ent.eptr) for the entities. Set of group IDs that reference the given eptrs. Gets a set of group IDs that reference the given entIds. List of identifiers (ent.ent_idn) for the entities. Set of group IDs that reference the given entIds. Gets the root group pointer of the group with the given ID. Identifier for the group. Null if it fails, else a const pointer to the root group. Build and return a list of group IDs in this. List of group IDs in this. Build and return a list of entity IDs (ent.ent_idn) from the current db referenced by the groups. List of identifiers for the groups. List of entity IDs (ent.ent_idn) from the current db referenced by the groups. Returns a list of group IDs that have the same contents as other groups. The duplicate group identifiers. Removes extra groups that contain the same references. IDs of groups removed. Removes all groups that do not contain any entity IDs. (Optional) True to check parent identifiers. IDs of groups removed. Removes groups with the given IDs. IDs of the groups to remove. (Optional) The delete option. IDs of groups removed. Replaces the given group. The group. const iterator of group in map. Query if this object is empty. True if empty, false if not. Empties this object. Gets a reference to the underlying map. The map. Gets a constant reference to the underlying map. The map. Query if 'obj' is equal. The object. True if equal, false if not. Inequality operator. The object. True if the parameters are not considered equivalent. Equality operator. The object. True if the parameters are considered equivalent. Assignment operator. The object. A shallow copy of this object. Return the entity type (for ClassEnt) Return the entity type. - serialize this. the destination/source archive object. Constructor. The object. destructor. Constructor setting the group type. (Optional) Type of the group list. GroupListEntity class. Appends another GroupListEntity to this. The GroupListEntity that contains the groups we want to append. A map of source group ID's and the actual group IDs they were assigned if any conflicts with existing groups were found. Remove ALL entity ID's from our groups with the given IDs. List of group IDs to remove from. Gets a map of group IDs and the entities that belong to them from the given entIds. List of identifiers (ent.ent_idn) for the entities. Map of group IDs and the entities that belong to them from the given entIds. Build and return a list of entity eptrs (ent.eptr) from the current db referenced by the groups. List of identifiers for the groups. List of entity eptrs (ent.eptr) from the current db referenced by the groups. Build and return a list of entities from the current db referenced by the groups. List of identifiers for the groups. The entities. Sets the ent.sel value on entities from groups in the current db. The IDs of the groups to collect entities from. Select bits to clean in ent.sel (except ALIVE_BIT). Select bits to set in ent.sel (except ALIVE_BIT). True to also draw the entities. A list of eptrs of the entities in these groups that changed. Adds a group to the underlying container. [in,out] The group to add. const pointer to the newly added group, nullptr if failed. Adds a group to the underlying container. [in,out] The group to add. const pointer to the newly added group, nullptr if failed. Gets group list type. The group list type. Gets all the child group identifiers of the group with the given ID. Identifier for the parent group. The child group identifiers. Gets all the parent group identifiers of the group with the given ID. Identifier for the group. The parent group identifiers. Adds the standard system GROUP and RESULT groups. Gets a const toolpath group pointer from the underlying map. Name of the group (not case sensitive). Null if it fails, else the geometry group pointer. Gets a const toolpath group pointer from the underlying map. Identifier for the group. Null if it fails, else the toolpath group pointer. Queries if a given name exists. The name to check. Identifier for the group to exclude in the check. True to warn of existing name. True if name exists, otherwise false. Gets a const geometry group pointer from the underlying map. Name of the group (not case sensitive). Null if it fails, else the geometry group pointer. Gets a const geometry group pointer from the underlying map. Identifier for the group. Null if it fails, else the geometry group pointer. Unelect the entities referenced by the groups with the given IDs in our current db. The IDs of the groups to unselect. True to draw the entity. Select the entities referenced by the groups with the given IDs in our current db. The IDs of the groups to select. true = first unselect all entities, false = append to current selections. True to draw the entity. Swap entity identifiers in the given groups. List of group IDs to swap entity IDs in. old entity ID to remove. new entity ID to replace the old one with. set of IDs of groups updated. Swap entity identifiers in the given groups. List of group IDs to swap entity IDs in. Map of old and new entity IDs to swap in groups. set of IDs of groups updated. Remove entity ID's from our groups with the given IDs. List of group IDs to remove from. List of identifiers for the entities (ent.ent_idn) to remove from the groups. (Optional) True to delete the group if it's now empty. Total number of ent.ent_idn removed the groups. Adds entities from our db by their matching select bit (ent.sel) to the groups with the given IDs. List of group IDs to add to. The select bits (SELECT_BIT, GROUP_BIT, etc). Total number of ent.ent_idn added to the groups. Adds entity ID's to groups with the given IDs. List of group IDs to add to. List of identifiers for the entities (ent.ent_idn) to add to the groups. Total number of ent.ent_idn added to the groups. Gets a set of group IDs that reference the given eptrs. List of eptrs (ent.eptr) for the entities. Set of group IDs that reference the given eptrs. Gets a set of group IDs that reference the given entIds. List of identifiers (ent.ent_idn) for the entities. Set of group IDs that reference the given entIds. Gets the root group pointer of the group with the given ID. Identifier for the group. Null if it fails, else a const pointer to the root group. Build and return a list of group IDs in this. List of group IDs in this. Build and return a list of entity IDs (ent.ent_idn) from the current db referenced by the groups. List of identifiers for the groups. List of entity IDs (ent.ent_idn) from the current db referenced by the groups. Returns a list of group IDs that have the same contents as other groups. The duplicate group identifiers. Removes extra groups that contain the same references. IDs of groups removed. Removes all groups that do not contain any entity IDs. (Optional) True to check parent identifiers. IDs of groups removed. Removes groups with the given IDs. IDs of the groups to remove. (Optional) The delete option. IDs of groups removed. Values that represent delete options for the Remove() function. Replaces the given group. The group. const iterator of group in map. Query if this object is empty. True if empty, false if not. Empties this object. Gets a reference to the underlying map. The map. Gets a constant reference to the underlying map. The map. Query if 'obj' is equal. The object. True if equal, false if not. Inequality operator. The object. True if the parameters are not considered equivalent. Equality operator. The object. True if the parameters are considered equivalent. Assignment operator. The object. A shallow copy of this object. Return the entity type (for ClassEnt) Return the entity type. - Destructor. IGroupListEntity class. Gets the assoc_id representing the ClassEnt type (OP_ID, etc). The assoc_id representing the ClassEnt type. Gets the entity id representing the ClassEnt type (ASSOC_ID, N_ID, etc). The entity id representing the ClassEnt type. Adds a derived class. Identifier for the ent. Identifier for the associated. The function. true if it succeeds, false if it fails. Adds/Sets the default constructor to the ClassEnt class factory. If an unknown ClassEnt type is encountered while deserialization, this constructor will be invoked to contain the unknown typed entity. The default constructor function. true if it succeeds, false if it fails. Creates the ClassEnt object instance and deserializes it from the file. The file to read from. The entity. The bytes. null if it fails, else the new from file. Get Version (used in XML serialization). the version Reads/Deserializes entity from the given file. The file to read from. Size of the block in bytes containing the entity. true if it succeeds, false if it fails. Writes/Serializes entity to the given file. The file to write to. true if it succeeds, false if it fails. Gets buffer size. the buffer size is the memory footprint that the entity takes in the serialized form. The buffer size. Gets the ent_idn of the Mastercam entity that is represented by this instance. The Mastercam entity ent_idn value. Determines if we can detach from database. true if it succeeds, false if it fails. Detach from database. The entity idn. true if it succeeds, false if it fails. Detach from supplied entity. The entity. true if it succeeds, false if it fails. Attach to supplied entity. The entity. entity idn or -1. Attach to entity and update database. The entity. entity idn or -1. Attach to entity and store in database. entity idn or -1. Visits the stored identifiers of associated entities and updates them via the supplied visitor. The visitor that will update the stored identifiers of associated entities. Visits the identifiers of the entities that this entity is associated to. The visitor that will accept the identifiers of the associated entities. Visits the identifiers used for database entity association and updates them via the supplied visitor. The visitor that will update the stored identifiers that can be used for association. Visit the identifiers used for database entity association that this entity defines. The visitor that will accept identifiers on this entity that can be used for association. Finalizes an instance of the ClassEnt class. Initializes a new instance of the ClassEnt class. Base class providing a more object oriented approach to Mastercam entities. Reads/Deserializes entity from the given file. The file to read from. Size of the block in bytes containing the entity. true if it succeeds, false if it fails. Writes/Serializes the entity from a given archive. The archive to write to. true if it succeeds, false if it fails. Writes/Serializes entity to the given file. The file to write to. true if it succeeds, false if it fails. Gets buffer size. the buffer size is the memory footprint that the entity takes in the serialized form. The buffer size. Gets the ent_idn of the Mastercam entity that is represented by this instance. The Mastercam entity ent_idn value. Determines if we can detach from database. true if it succeeds, false if it fails. Detach from database. The entity idn. true if it succeeds, false if it fails. Detach from supplied entity. The entity. true if it succeeds, false if it fails. Attach to supplied entity. The entity. entity idn or -1. Attach to entity and update database. The entity. entity idn or -1. Attach to entity and store in database. entity idn or -1. An interface representing a class entity. Visits the stored identifiers of associated entities and updates them via the supplied visitor. The visitor that will update the stored identifiers of associated entities. Visits the identifiers of the entities that this entity is associated to. The visitor that will accept the identifiers of the associated entities. Visits the identifiers used for database entity association and updates them via the supplied visitor. The visitor that will update the stored identifiers that can be used for association. Visit the identifiers used for database entity association that this entity defines. The visitor that will accept identifiers on this entity that can be used for association. An interface representing a class entity. Initializes this object. Query if this object is machine group. True if machine group, false if not. Query if this object is toolpath group. True if toolpath group, false if not. Maps this into an op_group structure. [in,out] The target op_group to map into. Query if 'obj' is equal. The object. True if equal, false if not. Inequality operator. The object. True if the parameters are not considered equivalent. Equality operator. The object. True if the parameters are considered equivalent. Assignment operator. The object. A shallow copy of this object. Constructor. A base group class. Constructor. The old style group structure. Copy constructor. The object. serialize this. the destination/source archive object. destructor. Constructor. The group name. Identifier for the parent. True to set as hidden. (Optional) ID of the group. Default constructor. @defgroup dbvars_ch4 Surface IDs * @note used in surface header f.type 0 - 15 @{ @} @defgroup dbvars_ch1 Sel bit constants @{ @} @defgroup dbvars_ch5 file types (used with FILE_ID, PMESH_ID, and STOCK_ID entities) @{ @} @defgroup dbvars_ch7 Entity ID masks @{ @} @defgroup dbvars_ch8 'task' values for file i/o * 'task' values for file input/output (see especially dbutil.c) @{ @} @defgroup dbvars_ch9 product codes @{ @} ToolpathGroup class. Query if origin corner is top or bottom corner. The origin corner. True if origin corner is Top, false if it's Bottom. @par Purpose: Initializes a new group to whatever parameters are passed in. @param[in] gpl the group to be initialized @param[in] name new group name @param[in] parent_idn parent group id # @param[in] hidden true = if you want group marked hidden @param[in] type type of group @param[in] product PRODUCT_MILL, PRODUCT_LATHE, PRODUCT_ROUTER, PRODUCT_WIRE, or PRODUCT_MT @par Purpose: add a new group (empty) to the list @param[in] name new group name @param[in] parent_idn parent group id # @param[in] hidden true = if you want group marked hidden @param[in] type type of group @param[in] product PRODUCT_MILL, PRODUCT_LATHE, PRODUCT_ROUTER, PRODUCT_WIRE, or PRODUCT_MT @param[in] move_insert_arrow move insert arrow after group in opmgr @param[out] succf true = group added @returns A pointer to the group newly added to the list @} @defgroup groups_ch3 PRODUCT_LATHE and PRODUCT_MT parameters @{ @} @defgroup groups_ch2 PRODUCT_MILL, PRODUCT_ROUTER, PRODUCT_WIRE parameters @{ @defgroup groups_ch1 common parameters @{ @note group_pg2 is meaningless without the * product type, which is in the op_group machine group tool settings machine group file settings MCExtensions lathe machine parameters Tplane Z information for MCExtensions lathe machine parameters used with the MT Platform machines. Turn profile parameters entity map structure advanced tool options structure steady rest structure (v9) tailstock structure (v9) chuck jaw structure (v9) round bar stock (with optional hole) structure How to compute Tplane Z coordinate for MT Platform lathe MCExtensions extended data. Values that represent MT JobSetup Work Types. (Note: LATHE_WORK_BAR / CHUCK deprecated old values). The base group pointer. Initializes this object. Query if this object is geometry group. True if geometry group, false if not. Query if this object is system group. True if system group, false if not. Query if 'obj' is equal. The object. True if equal, false if not. Inequality operator. The object. True if the parameters are not considered equivalent. Equality operator. The object. True if the parameters are considered equivalent. Assignment operator. The object. A shallow copy of this object. Constructor. A base group class. Constructor. The old style group structure. destructor. serialize this. the destination/source archive object. Constructor. The group name. Identifier for the parent. True to set as hidden. (Optional) Requested ID to assign to the new group. Will be reassigned if found to conflict with existing groups. Default constructor. The base group pointer. GeometryGroup class. Initializes this object. Type of group. Requested ID to assign to the new group. Will be reassigned if found to conflict with existing groups. Gets the name. The name. Gets the type. The type. Unhighlight entities. Highlight entities from this group in the current db. true = first unhighlight all entities, false = append to current highlightment. Pointer to an entity map, nullptr = we'll create our own (expensive). Unselect entities from this group in the current db. True to draw the entity. Pointer to an entity map, nullptr = we'll create our own (expensive). A list of eptrs of unselected entities. Select entities from this group in the current db. True to first clear any currently selected entities, false to add to selected entities. True to draw the entity. Pointer to an entity map, nullptr = we'll create our own (expensive). A list of eptrs of selected entities. Sets the ent.sel value on entities from this group in the current db. Select bits to clean in ent.sel (except ALIVE_BIT). Select bits to set in ent.sel (except ALIVE_BIT). True to also draw the entity. Pointer to an entity map, nullptr = we'll create our own (expensive). A list of eptrs of the entities in this group that changed. Swap entity identifiers (like we need to do when geometry transform occurs). Map of old and new entity IDs to swap in groups. Number of IDs swapped. Remove entity ID's to our group. List of identifiers for the entities (ent.ent_idn). Number of IDs remaining in m_EntIds. Adds entity ID's to our group. List of identifiers for the entities (ent.ent_idn). Number of IDs added (filters out duplicates). Assignment operator. The object. A shallow copy of this object. Maps this into an op_group structure. [in,out] The target op_group to map into. Query if 'obj' is equal. The object. True if equal, false if not. Inequality operator. The object. True if the parameters are not considered equivalent. Equality operator. The object. True if the parameters are considered equivalent. Constructor. The old style group structure. Copy constructor. The object. serialize this. the destination/source archive object. destructor. Constructor. Type of the group. The group name. Identifier for the parent group. True to set as hidden. (Optional) Requested ID to assign to the new group. Will be reassigned if found to conflict with existing groups. Constructor. (Optional) The group name. (Optional) Requested ID to assign to the new group. Will be reassigned if found to conflict with existing groups. BaseGroup class. Read through our database, build and return a shared_ptr to an EntityMap class. (Optional) The entity type mask (ent.ent_id like ALL_ENTITIES_MASK, PLASNB_MASK, L_ID, etc). (Optional) The selection bit mask (SELECT_BIT, GROUP_BIT, etc). (Optional) Memory management method when making a copy of the entity. A shared_ptr to an EntityMap class. Read through an external Mastercam file, build and return a shared_ptr to an EntityMap class. Full path of an existing Mastercam file. The include mask function. Load parameters. A shared_ptr to an EntityMap class. Read through our database, build and return a shared_ptr to an EntityMap class. The include mask function. (Optional) Pointer to load parameters. A shared_ptr to an EntityMap class. Query if this object contains an entity copy. True if empty, false if not. Query if this object is any kind of chain entity. True if chain entity, false if not. Query if this object is chain boundary. True if chain boundary, false if not. Query if this object is chain header. True if chain header, false if not. Query if this object represents a toolpath entity. True if toolpath entity, false if not. Query if this object represents an operation entity. True if operation entity, false if not. Inequality operator. The object. True if the parameters are not considered equivalent. Equality operator. The object. True if the parameters are considered equivalent. Query if 'obj' is equal. The object. True if equal, false if not. Gets a const ent pointer directly into the variable length buffer and the buffer size. Returns a const ent* and the buffer size. The buffer size is also returned as insurance so any caller is aware that it may not be a full-sized entity at the pointer so don't dereference the returned pointer and do an "ent myEntity = *pEnt;". Copies a full-sized entity from the variable-length buffer. first = a full-sized copy of the entity, second = true if successful. Copies a full-sized entity from the variable-length buffer. The entity to fill in. Return true if successful, false if not. Default constructor. Constructor. ent.ent_idn value of the entity. (Optional) ent.id value of the entity. (Optional) ent.assoc_id value of the entity. (Optional) ent.eptr value of the entity. Inequality operator. The object. True if the parameters are not considered equivalent. Equality operator. The object. True if the parameters are considered equivalent. Query if 'obj' is equal. The object. True if equal, false if not. Chain specific toolpath entitiy information. Information from the toolpath entity. Inequality operator. The object. True if the parameters are not considered equivalent. Equality operator. The object. True if the parameters are considered equivalent. Query if 'obj' is equal. The object. True if equal, false if not. Information about the operation entity. Gets a full-sized copy of the entity. A full-sized copy of the entity, true if successful. Gets the entity from the variable-length buffer. The entity to fill in. Return true if successful, false if not. Initializes this object with the given entity. The entity to copy. Query if this object is empty. True if empty, false if not. Assignment operator. The object. A shallow copy of this object. Constructor. The entity to copy. Default constructor. Container class of MC_BYTES to house the true size of the entity and not the largest. Information about the entity. Equality operator. The object. True if the parameters are considered equivalent. Values that represent desired sort order when calling GetData(). Values that represent how to handle copying of entities and their variable length data. Parameters to pass to MakeEntityMap(). Query if 'typeID' is lathe Tplane. Identifier for the type. true if lathe Tplane, false if not. Adds a reserved name by resource ID to m_Names. The reserved name. The reserved type ID. The resource ID of the reserved name. true if it succeeds, false if it fails. Adds a reserved name by resource ID to m_Names. The resource ID of the reserved name. The reserved type ID. true if it succeeds, false if it fails. Builds the lathe Tplane name map. true to first clear m_Names and m_LatheNames to force reload. size of m_LatheNames. Builds the reserved name map. true to first clear m_Names and m_LatheNames to force reload. size of m_Named. Build the array of hard-coded matrices. Size of array m_StandardMatrices. Query if the long 'typeID' is a valid Iso type. Identifier for the type. true if lathe tplane, false if not. Warning that a special lathe tplane is set as reserved. Identifier for the plane. true if being set as reserved. return true if the plane ID is a reserved lathe construction plane ID. the Plane ID to check. return true if the plane ID is a default one. Return true if the ID is one of the first standard plane ID's. the Plane ID to check. true to include Lathe_Z_Equals_World_Z. true if one of the first standard, false if not. Query if 'typeID' is VTL type. Identifier for the type. True if a VTL type, false if not. Query if the long 'typeID' is a valid lathe TypeID. Identifier for the type. true if lathe tplane, false if not. Query if the long 'typeID' is a valid lathe Tplane TypeID. Identifier for the type. true if lathe tplane, false if not. Gets lathe names. The lathe names. Gets the names. The names. Gets const reference to m_StandardMatrices. The standard matrices. Gets constant reference to m_LathePlaneMap. The map. Gets constant reference to the map. The map. Gets the size of m_Map. The size. Builds the map m_Map. AEB_MILL, AEB_LATHE, AEB_MT or a combination of all. true to first clear m_Names and m_LatheNames to force reload. Size of map. Gets a pointer to a reserved plane with the matching class and matrix. PlaneClass::SystemMatrix or PlaneClass::NamedPlane. Matrix to match. null if it fails, else the pointer. Sets a reserved plane name. New name of the reserved plane. Identifier for the reserved plane type. true if it succeeds, false if it fails. Gets a name by TypeID. Identifier for the type. The name. Gets a pointer to a reserved plane with the matching name (not case sensitive). Name to match. null if it fails, else the pointer. Gets a pointer to a kinda-reserved super special lathe Tplane with the matching type ID. Identifier for the type. null if it fails, else the pointer. Gets a pointer to a reserved plane with the matching type ID. Identifier for the type. null if it fails, else the pointer. Gets a pointer to the reserved info. Identifier for the resource. null if it fails, else the pointer. Query if 'name' is reserved name. The name. set to true = same name, but the case is mismatched. true if reserved name, false if not. Casts a TypeID identifier to a long. Identifier for the type. true for debug warning. A long, 0 if invalid type. Query if 'longType' is valid TypeID. TypeID as a long. true for debug warning. true if valid type, false if not. Query if 'resType' is system matrix identifier. Identifier for the resource. true if system matrix identifier, false if not. Return copy of hard-coded matrices if within range. Array index in m_StandardMatrices. The standard matrix. Assignment operator. The object. A shallow copy of this object. Defines an alias representing the reserved plane map. Defines an alias representing the reserved plane pair. Defines an alias representing list of names of the reserved planes. Defines an alias representing the reserved name pair. Defines an alias representing list of names of the lathe tplanes. Copy constructor. The object. Constructor. Identifier for the type. The name. (Optional) identifier for the resource ID. Information about the name. Named view constructor. Identifier for the resource. The matrix. The product. The coordinate display. true to place holder. SystemMatrix constructor. Identifier for the resource. The matrix. Default constructor. Information about the reserved plane. Reserved ID's for standard planes that are non-editable. Destructor. Default constructor. A to create and maintain the reserved planes. Sets the color of the plane. Plane color. Return true if Set () was called and the gnomon contains valid info. true if valid, false if not. Sets the origin of the gnomon. Origin. Initialize this gnomon to the given parameters. a Mastercam Plane. true to enable, false to disable. true if it succeeds, false if it fails. Get the plane ID of this gnomon. The identifier. erase the Plane gnomon; free the memory. (Optional) true = repaint. draw the Plane gnomon. (Optional) true to include the plane name (default = true). (Optional) true if plane planel active and plane selected (default = false). (Optional) true to draw as enabled; false to draw as disabled (default = true). Destructor. parameterized constructor. the plane. true to single instance. Default constructor. A plane select gnomon. Mastercam PlaneGnomon definition to be used for drawing plane gnomons. Dumps this to the given CStringArray and returns the size. The size of the CStringArray. return CString of m_RegenErrors. The regen errors. The regen error string. return value of m_RegenErrors. The regen errors. remove associated entity links if we're acting on the current database. True to delete from associated ent, false just zero out associated ent info in this plane. True if it succeeds, false if it fails. Sets the associated entity information in our point. The creation method (PEC_SLD_FACE, PEC_SLD_POINT or PEC_MESH_FACET). The associated entity id number and face/facet selection id. True if it succeeds, false if it fails. Gets associated entity information embedded in this. (Optional) True to warn for bad entity data. a treasure trove of information, nullptr if this point does not reference a solid face or end point. Collect copies of the geometry used to define this PlanePoint. Array to copy geometry entities into. entity ID and eptr so we don't have to read thru the db. ID's entities that could not be found in geomMap. return # of entities copied into array. Swap the associated geoemtry entity ID's. old entity ID. new entity ID. # of IDs swapped. set the tvalue CAD entry values. array of 2 doubles represeting tvalues into. get the tvalue CAD entry values. array of 2 doubles to insert tvalues into. set the tvalue CAD entry values. array of 2 doubles represeting tvalues into. get the tvalue CAD entry values. array of 2 doubles to insert tvalues into. Query if 'creationMethod' is a PEC_MESH_FACET, PEC_SLD_FACE or PEC_SLD_POINT. The creation method. True if associative creation method, false if not. Query if 'creationMethod' is a PEC_MESH_FACET. The creation method. True if mesh creation method, false if not. Query if 'creationMethod' is a PEC_SLD_FACE or PEC_SLD_POINT. The creation method. True if solid creation method, false if not. Gets creation method description. The creation method. The creation method description. Query if this point is snap point method. True if snap point method, false if not. get the point CAD entry method. returns method if successful. set the point CAD entry method. MC_BYTE representing CAD creation method (PEC_ORIGIN, etc) returns true if successful. validate creation method. MC_BYTE representing CAD creation method (PEC_ORIGIN, etc) returns true if valid. validate creation method. MC_BYTE representing CAD creation method (PEC_ORIGIN, etc) returns true if valid. Gets the number of valid entity ID's in m_EntityIDs. The number of valid entity ID's in m_EntityIDs. set up to two entity ID's that P3D is created with. the Entity IDs to set. Previous values. return two entity ID's that P3D was created with. return entity ID's that P3D was created with. convert a P3D to a Mastercam assoc_pt. the Mastercam assoc_pt to convert into. convert a P3D to a Mastercam p3d. the Mastercam p_3d to convert into. return the P3D m_Point member variable in view coordinates. the Mastercam view to convert point from world coordinates into. return the P3D m_Point member variable in view coordinates. return the P3D m_Point member variable in world coordinates. The point in world coordinates. set the origin's Z value in world coordinates. the value to set Z to. return the previous Z value. set the origin's Y value in world coordinates. the value to set Y to. return the previous Y value. set the origin's X value in world coordinates. the value to set X to. return the previous X value. initialize and set P3D m_Point member variable. Source point. true to initialise. . Sets this point to a Mastercam event. The event. MCEvent data containing selection information. [in,out] True if the event is solid face, false if not. [in,out] True if the event is wireframe, false if not. [in,out] The matrix of the selected solid face. [out] The origin point of the entity --> Center of the entity. [in, out] The clicked point on the entity. the one used as the origin of the plane. [in,out] If false, we don't try to associate the plane with any entity old and new solid link info. set the version. the version number. return the previous version value. return the version. The version. recalculate the point position. The third m 3. entity ID and eptr map so it does not have to read thru the db to find geometry entities. (Optional) True if parent plane is dynamically associated. return true if successful. recalculate the point position. The third m 3. (Optional) True if parent plane is dynamically associated. return true if successful. serialize this. the destination/source archive object. subscript operator. The index. The indexed value. zero out all member variables. comparison operator. The object. true if the parameters are considered equivalent. comparison operator. The object. true if the parameters are not considered equivalent. assignment operator using Mastercam aPoint. The point. A shallow copy of this object. assignment operator using Mastercam assoc_pt. The point. A shallow copy of this object. assignment operator. The object. A shallow copy of this object. copy constructor. The object to copy. destructor. Constructor for solid face or solid point. The creation method (PEC_SLD_FACE, PEC_SLD_POINT or PEC_MESH_FACET). The origin point in world coordinates. The solid link (solid entity's ent.ent_idn and solid selection id. parameteritized constructor. the origin point in world coordinates. parameteritized constructor. unique entity ID (ent.en_idn) unique entity ID (ent.en_idn) MC_BYTE defining CAD creation method (PEC_ORIGIN, etc) tValues from CAD creation. the origin point in world coordinates. Default constructor. make Plane a friend. Forward declaration. A plane. A macro that defines no work offset. Mastercam Plane definition Inequality operator. The object to compare. True if the parameters are not considered equivalent. Equality operator. The object to compare. True if the parameters are considered equivalent. Default constructor. Query if this object is valid. True if valid, false if not. Inequality operator. The object. True if the parameters are not considered equivalent. Equality operator. The object. True if the parameters are considered equivalent. Less-than comparison operator. The object to compare with us. True if the first parameter is less than the second. Constructor. (Optional) The associated entity's ent.ent_idn. (Optional) The selection ID within the entity. (Optional) The selection ID or the snapped point within the entity. (Optional) Identifier for the plane. The map key containing the associated entity's ent.ent_idn and the associated selection ID. Information about any specific entity associated with this point (currently solids and meshes). error code applied in validation and regeneration. PlanePoint class defines a point entity used in creating a Plane. A plane contains up to 4 PlanePoint's: 1 for the origin and up to 3 to define the 3 axes. Defines an alias representing array of matrix choices. Base matrix in [0], CCW 90, 180, 270, CW 0, 90, 180, 270 Determines if transform matrix and origin are Top @ 0,0,0. True if it transform data doesn't result in any transformation, false if it does. convert this to a Mastercam x_matrix. valid X component. return value of m_r member variable. . return value of m_33 member variable. The 33. comparison operator. The object. true if the parameters are considered equivalent. comparison operator. The object. true if the parameters are not considered equivalent. assignment operator. The object. A shallow copy of this object. Initialize member variables. subscript operator - return XCOORD, YCOORD or ZCOORD. The index. The indexed value. serialize this. the destination/source archive object. construct from 3 P3D's. valid X component. valid Y component. valid Z component. valid T component. assignment operator using Mastercam's x_matrix. The object. A shallow copy of this object. construct from matrix_33. the Mastercam x_matrix to copy from. construct from matrix_33. the Matrix33 to copy from. the P3D to copy from. copy constructor. The object to copy. destructor. Default constructor. Test matrix's components to see if they're all of zero value (like someone did a memset(0). True to display debug warning. True if all zero, false if not. Check dot product of given Matrix33. The Matrix33 to check. MatrixError::None for no error, MatrixError::DotProduct for bad dot product,. Check dot product of this. (Optional) the warning. MatrixError::None for no error, MatrixError::DotProduct for bad dot product, MatrixError::DotProductOrthoNormalize for bad dot product that can be correct by re-orthonormalizing option to ASSERT. true if the operation was a success, false if it failed. convert a P3D in view coordinates to view coordinates in a different view. the P3D in view coordinates to convert. the view the point resides in. the destination view. return new pt. convert thePt in view coordinates to world coordinates then subtract wSubPt. the P3D in view coordinates to convert. the point to subtract in world coords. return new pt. convert thePt in view coordinates to world coordinates then add wAddPt. the P3D in view coordinates to convert. the point to add in world coords. return new pt. add wAddPt from thePt, convert thePt to view coordinates. the P3D in world coordinates to convert. point in world coordinates to subtract. return new pt. subtract wSubPt from thePt, convert thePt to view coordinates. the P3D in world coordinates to convert. point in world coordinates to subtract. return new pt. Multiply a 3x3 matrix by a 3 element vector. A column vector. Result. Convert a point from view coordinates in the given matrix coordinates to world. The point in view coordiantes. A point in world coordinates. Convert a point from world coordinates into given matrix coordinates. The point in world coordinates. A point in view coordinates. check and correct bad matrix if needed. true = use MakeViewK() if all else fails. (Optional) true = show debug warning if invalid. return true if valid. re-orthonormalize via Gram-Schmidt algorithm. (Optional) Which axis (X, Y or Z) is priority. Z is the default). true if it passes dot product check, false if it fails. correct bad matrix_33 type. [in,out] The matrix to fix. true = use MakeViewK() if all else fails. (Optional) Which axis (X, Y or Z) is priority. Z is the default). first = matrix is valid, second = values were adjusted to make valid. correct bad matrix. true = use MakeViewK() if all else fails. (Optional) Which axis (X, Y or Z) is priority. Z is the default). first = matrix is valid, second = values were adjusted to make valid. Gets the dirty. return value of m_Dirty. set value m_Dirty. true=dirty, false=clean. return previous value. calculate the axis rotation angle from this with to the m33. Matrix33 to compare to. return P3D of axis rotations in radians. Convert this with a given k component. k component. return true if successful. Multiply two 3x3 matrices. a Matrix33 object. return result. return CString of coordinate values. (Optional) number of places behind the decimal point. The formatted string. set the tolerance. the tolerance. . Sets our tolerance to tight GetTightTol (). Return the previous value of m_Tol. Gets the tightest tolerance. The tight tolerance. return value of m_Tol. This matrix's tolerance. Builds and returns a set of tolerances we use to match matrices when searching. The maximum tolerance. The match tolerances. set this to TOP. zero out all member variables. Gets the X, Y or Z component. The X, Y or Z component. The component. set value of Z component. new XCOORD value of Z component. new YCOORD value of Z component. new ZCOORD value of Z component. return previous Z component. set value of Z component. new Z component value. return previous Z component. return P3D Z component. The z coordinate. set value of Y component. new XCOORD value of Y component. new YCOORD value of Y component. new ZCOORD value of Y component. return previous Y component. set value of Y component. new Y component value. return previous Y component. return P3D Y component. The y coordinate. set value of X component. new XCOORD value of X component. new YCOORD value of X component. new ZCOORD value of X component. return previous X component. set value of X component. new X component value. return previous X component. return P3D X component. The x coordinate. rotate a Matrix33 about an axis by degrees. the X, Y or Z axis to rotate about. rotation amount in degrees. return true if successful. Flip this matrix's Z axis about its X axis. return true if successful. Flip this matrix's Z axis about its Y axis. return true if successful. Flip this matrix by an axis. XCOORD, YCOORD or ZCOORD. (Optional) if flipping Z axis, rotate about X or Y axis. return true if successful. Return true if all values in this are valid. (Optional) true = debug only warning. (Optional) true = ignore m_Dirty value and check values. [in,out] (Optional) If non-null, (Optional) the matrix error. Return true if matrix is mathematically correct. test Matrix33 for 'left-handed' defintion. (Optional) the warning. returns true if invalid values exist within m33. convert Matrix33 to matrix_33. the destination matrix_33. return true if Matrix33 is parallel with given Matrix33. 3x3 matrix to compare to this. set to true if component is in the opposite direction. (Optional) The axis to check. (Optional) The dot tolerance. return true if Matrix33 is parallel with given Matrix33. Gets parallel information of this compared to m33. The matrix to compare to this. (Optional) The parallel axis (XCOORD, YCOORD or ZCOORD). (Optional) The dot tolerance. The parallel information. align axis of this to given matrix's axis. 3x3 matrix to align axis to. X, Y or Z axis to align. true if it succeeds, false if it fails. return true if ALL view axes are aligned. The matrix to compare. true if axis aligned, false if not. return true if the requested axis is aligned with given axis. The matrix to compare. The axis no (XCOORD, YCOORD or ZCOORD). Allow opposite direction comparison. true if axis aligned, false if not. serialize this. the destination/source archive object. Return true if ortho-normalized Matrix33 is equal within a tolerance. another Matrix33 to compare this with. (Optional) match tolerance. Return true if equal. For debugging only - build and return a vector of 3 strings with the difference in each of the vectors. The matrix to compare with this. Accuracy of double format in string. Normalize matrices before calculating difference. (Optional) If not null, output debug strings to VS output window. Vector of strings with the difference in each vector. Query if 'obj' is exactly equal (double == double). The matrix to compare to. True if exactly equal, false if not. Query if this object is an identity matrix (top). True if identity, false if not. Return true if Matrix33 is equal within a tolerance. Another Matrix33 to compare this with within the minimum of each objects tolerance. Match tolerance. Return true if equal within tolerance. Greater-than comparison operator. Use for std::map when a key. The matrix to compare. true if the first parameter is greater than to the second. Less-than comparison operator. Use for std::map when a key. The matrix to compare. true if the first parameter is less than the second. comparison operator. The matrix to compare. true if the parameters are not considered equivalent. comparison operator. The matrix to compare. true if the parameters are considered equivalent. comparison operator. The object. true if the parameters are considered equivalent. comparison operator. The object. true if the parameters are not considered equivalent. assignment operator using a matrix_33. The third m 3. A shallow copy of this object. assignment operator. The object. A shallow copy of this object. subscript operator - return XCOORD, YCOORD or ZCOORD. The index. The indexed value. subscript operator - return XCOORD, YCOORD or ZCOORD. The index. The indexed value. construct from a_3d. arc info. construct from 3 P3D's. k component. construct from 3 P3D's. valid X component. valid Y component. valid Z component. construct from matrix_33. the matrix_33 to copy from. copy constructor. The object to copy. destructor. Default constructor. Default constructor. Information about the parallelism of a compared matrix. Values that represent invalid components of a Matrix33. Constructs a Matrix33 object to be used instead of Mastercam's matrix_33 return the 3D distance between a P3D and a L3D. the point. the line. return the distance between to P3D's. convert and return this L3D in l_3d format. object converted to a l 3D. get point #2 of this L3D. the p_3d to copy it into. get point #2 of this L3D. the p_3d to copy it into. get point #2 of this L3D. The point 2. set point #2 of this L3D. The second point. return previous value. get point #1 of this L3D. the p_3d to copy it into. get point #1 of this L3D. the p_3d to copy it into. get point #1 of this L3D. The point 1. set point #1 of this L3D. The first point. return previous value. serialize this. the destination/source archive object. comparison operator. The object. true if the parameters are considered equivalent. comparison operator. The object. true if the parameters are not considered equivalent. assignment operator using a l_3d. The object. A shallow copy of this object. assignment operator. The object. A shallow copy of this object. copy constructor. The object. copy constructor. The object. parameteritized constructor from 2 P3D's. The first point. The second point. destructor. Default constructor. Constructs a L3D object to be used instead of Mastercam's l_3d set relative WCS ID. Identifier for the relative wcs. return previous value. return relative WCS ID. The relative wcs identifier. set parent plane ID. Identifier for the plane. return previous value. return parent plane ID. The plane identifier. assignment operator for plane ID. Identifier for the plane. A shallow copy of this object. assignment operator for P3D. The point. A shallow copy of this object. destructor copy constructor. The object. construct from P3D and a plane ID. The point. (Optional) identifier for the plane. Mastercam P3DS definition (same as P3D, but contains parent Plane ID and m_RelativeWcsID). For debugging only - build and return a string with the difference. The P3D to compare with this. Accuracy of double format in string. Vector of strings with the difference in each vector. return the 3D distance between to P3D's. point #2 of 2. (Optional) return 2D distance instead of 3D. return the distance between to P3D's. return CString of coordinate values. (Optional) number of places behind the decimal point. The formatted string. return the angle formed by two 3d vectors. P3D representing a vector. return the angle in radians between v2 and this. apply a scalar to the values. the scalar. ### return scaled P3D or this. negative of a 3D vector. return the negative of a 3D vector. Find the cross product (vector product) of this and the given vector. the 2nd vector. return the cross product. Find the dot product (scalar product) of this and the given vector. the 2nd vector. return the dot product. normalize and return the vector. . Determine if vector is parallel to this. The second P3D. true if it succeeds, false if it fails. calculate and return the length of the vector. . find the linear combination of two 3d vectors. The fac. The first point. The fac. The second point. return the combination. get the values in p_3d format. the destination p_3d. zero out all member variables. set value of tolerance. new tolerance value. return previous value of tolerance. return tolerance value. The tolerance. set XCOORD, YCOORD and ZCOORD values. new XCOORD component value. new YCOORD component value. new ZCOORD component value. Gets a const pointer to the X, Y or Z component. The X, Y or Z component. The const pointer, nullptr if invalid XYorZ value. Gets the X, Y or Z component. The X, Y or Z component. The component. set value of ZCOORD component. new ZCOORD component value. return previous value of ZCOORD component. return ZCOORD component. return XCOORD component. set value of YCOORD component. new YCOORD component value. return previous value of YCOORD component. return YCOORD component. return YCOORD component. set value of XCOORD component. new XCOORD component value. return previous value of XCOORD component. return XCOORD component. return XCOORD component. serialize this. the destination/source archive object. Query if 'obj' is exactly equal (double == double). The P3D to compare to. True if exactly equal, false if not. Return true if P3D is equal within a tolerance. another P3D to compare this with. match tolerance. Return true if equal. subscript operator. The index. The indexed value. subscript operator. The index. The indexed value. Greater-than comparison operator. The object. true if the first parameter is greater than to the second. Less-than comparison operator. Use in std::map as a key. The object. true if the first parameter is less than the second. comparison operator. The object. true if the parameters are considered equivalent. comparison operator. The object. true if the parameters are not considered equivalent. comparison operator. The object. true if the parameters are not considered equivalent. assignment operator using a const a p_3d. The point. A shallow copy of this object. assignment operator using a const double * pointing to a p_3d. The object. A shallow copy of this object. assignment operator. The object. A shallow copy of this object. addition-assignment operator. The object. The result of the operation. subtraction-assignment operator. The object. The result of the operation. copy constructor. The object. destructor. construct from XCOORD, YCOORD & ZCOORD. The xval. The yval. The zval. construct from p_3d. The point. parameteritized constructor from double ptr pointing to a double[3]. The double. Default constructor. Mastercam P3D definition. Return value for Set() and Replace() Values that represent CoordinateDisplayType. Values that represent class of plane. Plane types. Gets the last identifier, 0 on error. The last identifier. Query if 'obj' is equal contents to this. The object to compare. true if equal contents, false if not. Returns reference to m_ExcludeIDs. reference to m_ExcludeIDs. Query if this object has excluded operation IDs. true if excluded operation IDs exist, false if not. Add the given ID to the exclude mask (exclude this ID from being added to or existing in the array. Any existing matching ID's will be removed from the array. The ID to exclude. (Optional) first empty exclude mask. Removes all instances of the ID from the array. The ID to remove. Size of array. Sets new size of array. The new size. Size of array. Gets value of m_AllowNegatives. value of m_AllowNegatives. Gets value of m_AllowDuplicates. value m_AllowDuplicates. Sets m_AllowDuplicates and removed duplicate IDs from the array. true to allow, false to deny duplicates. (Optional) true to ensure contents are unique. Previous value of m_AllowDuplicates. Gets sort mode. The sort mode. Sorts the array per the given sort mode. (Optional) the sort mode. Use this member function to copy the elements of one array to another. Source of the elements to be copied to an array. Returns true if successful. Appends the given set to this. Source of the elements to be appended to an array. The index of the first appended element. Appends the array of long ID's at pOpIDs. The ptr to the operation IDs. The number operation IDs. The index of the first appended element. Appends the given array to this. Source of the elements to be appended to an array. The index of the first appended element. Adds the ID to the array. the identifier to add. . Query if this object is empty. true if empty, false if not. Assignment operator. The object to copy. A shallow copy of this object. Assignment operator. The object to copy. A shallow copy of this object. Assignment operator. The object. A shallow copy of this object. Destructor. Constructor that accepts a set of longs. std::set of longs. Constructor that accepts a set of longs. std::set of longs. Copy constructor. The object. Constructor. (Optional) allow duplicates IDs in the array. (Optional) the sort mode. A std::vector of long data types used for operation ID's. Defines an alias representing the solid hole axis data change vector. Solid hole axis data change item. Solid hole axis data change status. Defines an alias representing options for controlling the detect hole axis. Output data for a single cylindrical "hole" from SDetectSelectHoleAxis function. Solid Detection - conical face structure Solid Detection - cylindrical face structure @defgroup Contour_Types Contour types @{ @} @defgroup Pocket_Types Pocket types @{ @} V9 Solids drill detection parameters probe toolpath parameters. A probe parameter. toolpath nesting parameters. solid drill toolpath parameters. Solid drill detection parameters. automatic drilling parameters trimmed toolpath parameters. manual entry parameters. chook operation. Values that represent dependency modes in CHook operations. coons parameters. swept 3D parameters. swept 2D parameters. lofted parameters. revolved parameters. ruled parameters. helix bore parameters. slotmill parameters. thread mill parameters. operation parameters - ADV 5 axis. Declarations in 3rd party package: const int mcamParamsManager::MPM_MAX_CHOOK_PARAMS=470; const int mcamParamsManager::MPM_MAX_FURTHER_CHOOK_PARAMS=(147+8+13); const int mcamParamsManager::MPM_MAX_V8_PAD_PARAMS=250; const int mcamParamsManager::MPM_MAX_V8_PADX_PARAMS=28; operation parameters - circle 5axis specific parameters. circmill parameters. operation parameters - Port 5 axis. operation parameters - slice 5 axis. no longer used but leave to retrieve values from older .mc9 files operation parameters - Msurf 5 axis. Box Pattern data. Sphere Pattern data. Support structures for Msurf 5 axis Cylinder Pattern data. operation parameters - swarf 5 axis. @} @defgroup cc5dlg_parameters1 CC5dlg parameters @{ operation parameters - curve 5 axis. @} @defgroup cm5dlg_parameters4 CM5dlg parameters @{ operation parameters - surface finish 4 axis. @} @defgroup cm5dlg_parameters1 CM5dlg parameters @{ operation parameters - surface finish flowline 5 axis. Exit_Blend Parameters. Point generators. multiaxis oscillate settings. multiaxis overlap settings multiaxis entry and exit. multiaxis entry or exit. operation parameters - surface hmm. This structure is written and read from disk. Practices to follow when adding new parameters: 1. Look for "gaps" between data members that result from data alignment and will not change the alignment of subsequent data members. 2. Look for data members named pad_short, pad_int, etc. These are memory pads that are no longer used if you fail to find a "gap" in the structure. 3. Backward compatibility may need to be addressed after adding or modifying a data member as follows: a. Edit INTERFACES\GUI\ChkSIM_E.h and pump up the minor version - V20XX_MINOR - and add a new one V20XX_'whatever describes the change' set to the old minor version, b. older versions are handled by editing files MastercamX\\MCPrvVerFile\\V20XXTentToV20XY.cpp, and b. minor versions are handled by editing the file MCCore\\DbLoIO.cpp. Padding, from structure packing alignment or "unused" padding variables, can be expected to be zeroed out, and, thus, the newly introduced variable that was squeezed into an existing gap in the structure will also be zeroed out. In this case, there's no need to bump-up the minor version. But, if the new data members require special initialization, (3) will be needed. For examples on how this could be done, you may want to look at revision 196292 where the data members limitXYOption and includeStockXY were introduced. A helpful tool to identify alignment gaps are the compiler flags /d1reportSingleClassLayoutXXX and /d1reportAllClassLayout. They provide a memory layout of the structure with the available memory identified as 'alignment memory'. operation parameters - surface finish constant scallop. operation parameters - surface finish shallow. operation parameters - surface finish steep. operation parameters - surface finish leftover. operation parameters - surface finish pencil. operation parameters - surface finish contour. operation parameters - surface finish flowline. operation parameters - surface finish blend. operation parameters - surface finish project. operation parameters - surface finish radial. operation parameters - surface finish parallel. operation parameters - surface rough plunge. operation parameters - surface rough pocket. operation parameters - surface rough rest mill. operation parameters - surface rough contour. operation parameters - surface rough flowline. operation parameters - surface rough project. operation parameters - surface rough radial. operation parameters - surface rough parallel. operation parameters - surface operation's limit settings. operation parameters - surface operation's roughing settings. operation parameters - surface operation's depth settings. operation parameters - surface high speed parameters. operation parameters - surface operation's direction settings. operation parameters - surface operation's edge settings. operation parameters - surface operation's gap settings. operation parameters - common parameters for all surface operations. operation parameters - model chamfering. operation parameters - 2D toolpaths hmm. A collection of link lead motions and other data for first/last leads. Initialize link lead motion to the defaults. Inequality operator. The right hand side of the structure to test against. True if the structures are not considered equivalent. Equality operator. The right hand side of the structure to test against. True if the structures are considered equivalent. A prm hmm link lead motion. Facing. Pocket. Note: if you increase the size of prm_pocket, adjust padding at end of prm_srf_rgh_pocket, too. HEM parameters. Thinwall pocket. High speed pocket options. Open pockets. Pocket remachining. operation parameters - pocket specific parameters. operation parameters - pocket specific parameters. operation parameters - pocket specific parameters. operation parameters - pocket specific parameters. operation parameters - pocket specific parameters. Custom operation parameters. lathe park turret operation. turret operation. center point operation. tailstock operation. spindle sync operation Exact rotary direction types. Exact rotary type as in values that explicitly state the rotary direction. A different way to specify rotary (or spindle) direction is to say "shortest", but that should have its own enumeration to clearly differentiate between usages. Spindle sync operation types. spindle advance/retract operation Spindle move operation types. chuck clamp/unclamp operation. bar feed operation. miscop axis motion description. lathe steady rest position operation. lathe tailstock position operation. lathe chuck clamp/un-clamp operation. lathe stock bar feed operation. lathe stock flip operation. lathe stock transfer operation. lathe pattern repeat toolpath. lathe canned finish toolpath. lathe canned rough toolpath. lathe point toolpath parameters. lathe thread toolpath parameters. lathe thread cut parameters. lathe thread shape parameters. lathe plunge and turn toolpath parameters. lathe plunge and turn finish parameters. lathe plunge and turn rough parameters. lathe groove toolpath parameters. lathe groove finish parameters (not used with 2 boundary groove) lathe groove rough parameters. lathe groove roughing step removal parameters. Lathe groove rough rib cutting parameters. Lathe groove rough rib cutting rib width. Lathe groove rough cut direction. lathe groove rough multiple depth cut parameters. lathe groove shape parameters (not used with 2 boundary groove) Lathe groove geometry type. clearance cut lathe cutoff toolpath parameters. lathe cutoff toolpath feed speed parameters. lathe cutoff toolpath canned text parameters. lathe corner parameters. dwell parameters retract parameters peck parameters lathe peck/dwell parameters. lathe pinch turn operation. Lathe pinch turn sync type. Lathe pinch turn pinch type. Lathe pinch turn dwell type. Lathe pinch turn first cut. Lathe prime turning parameters. Lathe prime turning finish parameters. Lathe prime turning finish strategies. Lathe prime turning rough parameters. Lathe prime turning rough strategies. Lathe prime turning common parameters for rough and finish. Feed rate and spindle speed parameters, used by prime turning finish. Feed rate and spindle speed parameters, used by prime turning rough. lathe contour rough toolpath parameters. lathe dynamic rough toolpath parameters. lathe rough toolpath parameters. Lathe semi finish feed/speed parameters. lathe pinch turn parameters. lathe finish toolpath parameters Lathe cut direction. lathe finish down cutting parameters lathe corner break parameters. lathe face toolpath parameters. Lathe secondary feed/speed parameters. lathe face corner parameters. lathe plunge parameters. lathe entry/exit parameters. individual lathe entry/exit parameters. lathe drill toolpath parameters. Process hole toolpath parameters. Chamfer drill toolpath parameters. Toolpath parameters for a Advanced Drill operation. operation parameters - drilling specific parameters Process hole linking options. Process hole linking options. Process hole sorting options. multiaxis trim to stock settings. Lathe chip break parameters. lathe tool inspection parameters. Minimum tilt parameters. Axis limit property page. multiaxis axis limit. operation parameters - contour specific parameters. Please note: if you change prm_contour, please adjust other structures (such as prm_2d_hmm and prm_chamfer) which include it. Contour oscillate. Tab parameters. router common parameters. Extend/shorten contour. Contour ramp. Contour chamfer. @defgroup operation_parameters_common_contour_and_pocket_parameters operation parameters - common contour and pocket parameters * @note get rid of this pathetic data structure for version 9. * Move finish_all to op_multi_cuts. Use op_common.cmp_to_tip @{ Contour pocket. Contour remachining. operation parameters - xform toolpath. operation parameters - xform toolpath misc ops. operation parameters - xform-translate (linear array) toolpath. operation parameters - xform-rotate toolpath. operation parameters - xform-mirror toolpath. operation parameters - xform-view info. operation parameters - safe link. A 5 safety zone. Block safety zone anchor points. Cylinder safety zone anchor points. Values that represent safety zone wrap types. Values that represent safety zone link tool options. Values that represent safety zone types. wire 4axis wirepath parameters. wire point wirepath parameters. wire nocore wirepath parameters. wire canned cycle wirepath parameters. wire contour wirepath parameters. Wire tab parameters. wire window chain sorting parameters. wire entry/exit parameters. wire common parameters. operation parameters - miscellaneous integers and reals. toolpath entity definition. If a tp_entity member is added between flag and u and the new member is not supposed to be part of the tp_entity header, the define below must be changed to use the new member in place of u. toolpath entity - Stock Model Result entity. toolpath entity - FBM zone control entity. toolpath entity - FBM chain control entity. toolpath entity - FBM chain boundary entity. operation id entity. assoc info. toolpath entity - Nesting group info. toolpath entity - Nesting Group entity. toolpath entity - Nesting Part operation id # entity. toolpath entity - Nesting Part entity. toolpath entity - Nesting Sheet entity. toolpath entity - Router tab entity. CHook Toolpath Structure. group entity. Information about the 3D HST variable stock group. HST surface type. surface entity - surface info toolpath drilled hole feature. toolpath entity - arc from solid information. V8 SDetect Drill Geometry Structure. Drill hole segments used by the Advanced Drill toolpath for creating deep hole drilling operations. Advanced Drill ordered item type. Peck type. Spindle direction. toolpath entity - drilling point from solid information. toolpath entity - 5axis position information. toolpath entity - drilling point information. Linking parameters associative point type enumeration. toolpath entity - drilling grid information. toolpath entity - drilling bolt circle information. toolpath entity - manual entry. toolpath entity - chain control entity. toolpath entity - chain boundary entity. toolpath entity - modify chain information. toolpath entity - thread cut entity (Used in Wire only) toolpath entity - chain sync entity. toolpath entity - chain boundary entity. Lathe secondary feed/speed location type. Lathe feed from types. Lathe feed rate types. Lathe entry/exit feed rate mode. Lathe entry/exit mode. Defines an alias representing the gcode mask. Values that represent nci gcodes. for linked lists of head tool entities. Information about the block tool. for linked lists of lathe tool entities for linked lists of mill tool entities Tool reference information. holder segment definition. tool definition. tool parameters - Multi tool head specific -block tools/drills/aggregates. tool parameters - drill specific. tool parameters - mill specific. operation parameters - common tool parameters for all operation types. Maximum number of components in an axis combination that can be handled by the post axis combo information in an MP friendly format data stream names machine supports event-based programming - post must match version number major.minor starting with 11.2 (X2 MR2) automatically load tools when changing MGP machines does the machine support RTCP unique identifier for this machine default construction plane maximum wire taper angle (deg) holder catalog file insert catalog file ent_idn of list of machining modes ent_idn of list of axis combination entities ent_idn of of list of machine reference positions ent_idn of 1st component group entity ent_idn of machine base component entity ent_idn of related control definition ent_idn for the cnc machine entity (this one!) use the toolbar state name of tool bar state to load with machine comment to describe the machine material library file (inch, mm) tool library files (inch, mm) post-processor file control definition file coolant toolpath operation feedrate limits - inch, mm / min, deg/min, 1/sec global maximum machine axis feedrates for rent Machine simulation info entity id. MT .machine configuration GUID - gets assigned when the machine is loaded into a machine group macro event lists event defaults event list machine dynamics information for high-feed machining and operation timing calculations multi-axis motion control lathe default WCS - 0 = none, 1 = top, 2 = LATHEZ=WORLDZ Is this a VTL? (lathe only) machine type (mill, lathe, router, wire EDM currently supported) @} CNC machine definition machine motion acceleration value @} @defgroup dynamic information NOT for high-feed @{ timing increment for MATSS sync-list cornering acceleration corner radius feedrate to slow down to at sharp corners minimum change in direction to slow down to min_corner_fr segment length as % of tool diameter apply acceleration maximum feedrate change per block look-ahead as a percentage of tool diameter @defgroup parameters taken from HighFeed_E.h @{ maximum change in feedrate to recombine segments (%) Machine dynamic parameters maximum combined angle before break is required break combined rotary axis motion @defgroup cnc_machine_parameters CNC machine parameters @{ Multi-axis motion control ent_idns of this and related entities in database\n ent_idns.thisEnt is used as the group reference stored with operations ent_idn for 1st component in group ent_idn for 1st component group parameters entity in the list ! DEPRECATED ! Old Component group definition. Since 2020, replaced by CComponentGroup class members. ent_idns of this and related entities in database specific group type (UL_TOOLS_GROUP, etc.) general component group class (PART_HOLDING_GROUP_TYPE, etc.) Component group parameters @brief Component group parameters A linked list of these parameters is stored with a component group. This allows a group to have the parameters of more than one group type. For example, a component group can have both turret and spindle parameters. The turret and spindle specific parameters are stored in different entries in the list component type specific parameters geometry definition parameters (non-component specific) type of geometry used to define the component ent_idn of owner machine ent_idns of this and related entities in database current position of anchorPt (world coordinates) = anchorPt position on the machine at start of program most of the time... [REMOVE] transformation matrix to put component @ current NC position = initXform initially [REMOVE] color to draw component type of component (machine base, chuck, turret, etc) component group id @} CNC machine component parameters aggregate head parametric geometry definition work offset number tool length tilt angle machine view angle X,Y,Z station position X,Y,Z block anchor position tool change type Orientation axis Aggregate type station/block number Aggregate head component parameters turret face number on which this gang is installed (if any...) angle of slant bed that gang is installed on used for determining tool alignment in tool location components min./max. spindle speed for live tools Gang tool component parameters flags for applying the stickout values default 'stickout' lengths for auto tooling the turret slant angle (deg.) - used for computing the axis of rotation and indexed tool vectors min./max. spindle speed for live tools turret parametric geometry definition CW, CCW, OPTIMIZE number of tool stations defined time to index between adjacent faces (sec.) defines direction of tools in indexed position must be perpendicular to rotaryAxis axis of turret rotation defines CW/CCW direction for auto-face numbering Turret component parameters Tool spindle component parameters This also applies to the turning tool device that works on machines that use an ATC for turning tools 'standard' geometry types are supported @} @defgroup multi_tool_component_types Multi-tool component types @{ Automatic tool changer (ATC) component parameters tool change kinematic simulation is not currently supported, this component is necessary: to provide tool change times so machine simulation knows where to send the tools for a tool change 'standard' geometry types are supported. Tool component type X,Y,Z spacing for the stations Multi-head piggyback component parameters X,Y,Z spacing for the stations Multi-head head component parameters station geometry definition station geometry type block geometry definition block geometry type X,Y,Z position for the stations X,Y,Z block Anchor position station/block number Router drill block station component parameters guide geometry Wire lower guide component type guide geometry align guide vertically with lower guide at home position thread time (sec) Wire upper guide component type geometry wire guide geometry type for rent allow fixed (Lathe) drilling tools at this location allow live (Mill) tools at this station allow fixed (Lathe) tools at this location (NOT lathe drills!) allow face tools at this location allow cross tools at this location use this locator for any tool, irregardless of the tool station # tool station number to match on use this locator for all turret index or gang tool positions reference point on tool for this locator method by which the user defined the tool transformation view tool transformation matrix named view v_idn use the stickout value stickout length for the tool gang tool position ID for a tool turret face number for a tool ATC pocket for a tool position and orientation tool for this location used for pre-defined tool position and orientation for spindles, turrets, and gangs @} @defgroup single_tool_component_types Single tool component types @{ Steady rest component parameters Steady rest structure (X) Tailstock component parameters Tailstock structure (X) Centre component parameters (live or dead centre, no taper is modelled) This is a special component added directly from the MGP stock setup page @} @defgroup programmable_misc_tooling_component_types Programmable misc tooling component types @{ Centre component geometry (live or dead centre, no taper is modelled) Guide bushing component parameters parametric geometry definition Collet component parameters - not implemented currently in Mastercam X Chuck component parameters Chuck geometry type Chuck jaw(s) component This is a special component added directly from the MGP stock setup page Chuck jaw stock stickout Chuck jaw geometry Machine vise component parameters - not implemented currently in Mastercam X @} @defgroup work_holding_comp_types Work Holding Component Types @{ Machine vise jaw component parameters - not implemented currently in Mastercam X Wire EDM table component parameters Round table component parameters - not implemented currently in Mastercam X Rectangular table component parameters Rectangular table geometry - not implemented currently in Mastercam X T slot parameters - not implemented currently in Mastercam X disable feedrate programming for axis motion events simulation startup axis angle min/max rotational travel limits (deg.) maximum feedrate (deg/min) maximum angular move before breaking use chordal deviation to determine when to break break rotary move signed continuous, signed direction (0-360 deg), shortest direction (0 - 360 deg) must divide evenly into 360 is this an indexing axis? rotational reposition limits (deg) angle of rotation for nutated axis, right hand rule (degrees) axis of rotation for axis out of plane (WCS axis!)\n * X_AXIS, Y_AXIS, Z_AXIS\n * NEG_X_AXIS, NEG_Y_AXIS, NEG_Z_AXIS\n nutated machine axis true = CW is +ive direction for this axis axis '0 deg' vector WRT machine axes lies in plane perpendicular to axis of rotation axis of rotation wrt machine linear axes rotary axis to drive on the machine: A_AXIS, B_AXIS, C_AXIS, MACRO_AXIS Rotary axis component parameters disable feedrate programming for axis motion events max. feed rates (rapid traverse rates) axis to drive on the machine: X_AXIS, Y_AXIS, Z_AXIS, MACRO_AXIS [0] = parameters for the physical axis direction on the machine [1] = parameters for the programmed direction of machine motion for this axis, which may be in combination with other linear axes, if the machine axes are non-orthogonal Linear axis component parameters simulation startup axis position min/max linear travel limits (in/mm) measured along axis direction from zeroPos angle of rotation for tilt, right hand rule (degrees) axis of rotation for axis out of plane (WCS axis!)\n * X_AXIS, Y_AXIS, Z_AXIS\n * NEG_X_AXIS, NEG_Y_AXIS, NEG_Z_AXIS\n tilt the axis base axis direction WRT the WCS: X_AXIS, Y_AXIS, Z_AXIS NEG_X_AXIS, NEG_Y_AXIS, NEG_Z_AXIS generic axis component parameters The actual axis direction vector is computed by taking the wcsAxis vector direction and rotating it about the tiltAxis by rotAngle travel limits Axis feed rates General fixture component parameters Machine base component parameters Miscellaneous component parameters round barstock geometry with stock margins other stock types defined using standard solid types Stock component type @} @defgroup generic_comp_types Generic Component Types @{ Round bar stock (with optional hole) structure (X) Cylinder with a hole in it (revolved component) Other specialized geometry geometry definitions Filleted polygon 'Standard' solid component definition defaults Parameters for a component definition from a revolved profile Parameters for a component definition from an extruded profile Parameters for a component definition from a cylinder Parameters for a component definition from a block Parameters for a component definition from a STL entity Component Geometry Definitions Component geometry will provide the backbone for machine simulation in future releases of Mastercam. It will also enable graphical descriptions of CNC machines, currently provided via post-processor variables Component geometry is NOT supported in the current version of Mastercam @defgroup component_geometry_definitions Component Geometry Definitions @{ Parameters for a component definition from a solid entity Component group types - These are used to tell the machine tool the specific purpose(s) of a group of components. @par Rules: - A component group may have multiple types simultaneously. - A machine may only have 1 of each component group type. Lathe-specific miscellaneous tooling groups Miscellaneous tooling component groups These groups contain auxiliary machine automation, not related to holding/driving the part or tool Mill-specific miscellaneous tooling groups Wire-specific tool storage groups Router-specific tool storage groups Lathe-specific tool storage groups Cutting tool storage component groups Mill-specific tool storage groups Wire-specific part holding groups Router-specific part holding groups Lathe-specific part holding groups Mill-specific part holding groups 'closed loop' tool storage device (carousel, turret, chain ATC) index methods. Rotary axis positioning types. Component motion types defines vector motion along or rotational motion about a machine axis. Tool location positions on the back of a tool holder. This is used for the legacy tool locator, not for MT tool locator. The legacy tool locator is converted to MT tool locator when loading the file. Tool orientations in a tool location component. This is used for the legacy tool locator, not for MT tool locator. The legacy tool locator is converted to MT tool locator when loading the file. Component geometry types Component geometry may be defined using one of the following methods: - component-specific parametric geometry - solid block or cylinder - extruded or revolved (360 deg only) profile - Mastercam solid entity Component geometry definition is NOT supported in the current version of Mastercam. Machine type group view structure Type codes for the machine components. Used to identify variables in the above enum. misc. tooling components, ATC included as tool components only hold tools while cutting Multi-cutting tool components Single tool holding components Work holding components (tables included, as the part can sit on a table) Generic components Components marked with an * aren't available currently in X2 Multi-tasking machining mode Multi-tasking data stream information for a machining mode ent_idn for lists of components (this list is stored in the database as an ent_idn_list) component lists for this axis combination - each list consists of components from 1 component group - one list is for the tool holding components - the other is for the part holding components - miscop operations (ex. tailstock advance) may only require one list - this list should be the first one ent_idns of component groups to which all components belong Tool change (V9 home) position (inch, mm) Axis combination name @par Machining mode axis combination @note Rules: - Any 'cutting' toolpath operation requires the interaction of 2 component groups and their components, hence 2 component lists. - Only one of each linear axis + 2 different rotary axes are allowed. - Tool and part holding components must NOT be stored in the same component list. (Each list must have one or the other.) event list information Machine reference position type and method of positioning Reference position source (how it was created) Type of reference position The next 2 members are used for axis combination reference POINTS and home position only. array of data stream names Alias for vector of tp_ents (boundary geometry). Alias for shared_ptr to a vector of tp_ents (boundary geometry). Alias for unique_ptr to a vector of tp_ents (boundary geometry). @par Multi-tasking data stream parameters @note MAX_DATA_STREAMS is defined in AssocTyp_ch.h data stream name Equality operator. The first instance to compare. The second instance to compare. True if the parameters are considered equivalent. Fillet information. lathe component boundary. Lathe tool definition. @} for linked lists of material entities LATHE TOOL GENERAL HOLDER MENU CONFIGURATION DRILLING TOOL MENU CONFIGURATION GROOVING/PARTING INSERT MENU CONFIGURATION THREADING INSERT MENU CONFIGURATION GENERAL TURNING / BORING INSERT MENU CONFIGURATION LATHE TOOL TYPE MENU CONFIGURATION CONFIGURATION FOR DIMENSIONED BITMAP CONFIGURATION INFO FOR A LIST VIEW OR DROPDOWN @defgroup ltooldef_ch2 LIMITS @{ @} @defgroup ltooldef_ch7 DRILLING TYPES @{ @} @defgroup ltooldef_ch8 TAP TYPES @{ @} @defgroup ltooldef_ch9 TOOL COMPENSATION TYPES @{ @} FLOATING POINT EDIT BOX LIMITS, DEFAULTS A lathe tool definition. Lathe feed rate and units. Custom lathe tool. Generic tool holder. All units always in inches! Lathe insert/drilling tool definition. All units always in inches! Lathe drilling tool definition. All units always in inches! Grooving/Parting insert. All units always in inches! Threading insert. All units always in inches! General turning/boring insert. All units always in inches! CArchive read operator overload for the TlID class. The archive. The identifier. The archive. CArchive write operator overload for the TlID class. The archive. The identifier. The adjusted archive. Unique identifier. Identifier for the empty tlid. GUID casting operator. CString casting operator. Less-than comparison operator. The other. true if the first parameter is less than the second. Greater-than comparison operator. The other. true if the first parameter is greater than to the second. Inequality operator. The other. true if the parameters are not considered equivalent. Equality operator. The other. true if the parameters are considered equivalent. Inequality operator. The other. true if the parameters are not considered equivalent. Equality operator. The other. true if the parameters are considered equivalent. Assignment guid operator. Unique identifier. A shallow copy of this object. Assignment string operator. Unique identifier for the string. A shallow copy of this object. Convert this object into a string representation. This object as a CString. Parameterized blob constructor. The BLOB. The blobsize. Parameterized byte guid constructor. Unique identifier. Parameterized string constructor. Unique identifier for the string. Parameterized string constructor. Unique identifier for the string. Default constructor. Class representing a tool identifier in the form of a GUID (Globally unique identifier) Values that represent custom coolant positions. Values that represent custom coolant states. Values that represent standard coolant statuses. Values that represent tool orientation states. Values that represent holder tool types. Values that represent insert materials. Values that represent coolant approach forces. Values that represent coolant approach outputs. Values that represent coolant approach types. Values that represent component types. Values that represent turn holder types. Values that represent 3D Tool Assembly types. Values that represent spindle speed units. Values that represent tool library feed speed units. Values that represent tool library active turrets. Values that represent tool library active spindles. Values that represent tool compensation positions states. Values that represent tool library compensation types. Defined methods for calculating the profile from the 3D model. Values that represent the insert definition. Values that represent the handedness of a tool or tool item. Values that represent tool graphics file formats. Values that represent the different Thread Shapes. Values that represent the different shank types on tools. Values that represent the different tool types that Mastercam supports. Enumeration representing the Holder Lower Connection Type. Helix type for router tools Enumeration for spindle directions. Enumeration representing the Tool Display Type Enumeration that represent TlCornerType. Enumeration for source of cut params. Enumeration for cut quality. Enumeration for radius types Enumeration for different hardness scales. Enumeration representing the different material ISO Group Values. Enumeration for different material groups. Values that represent the different Lathe Live Center taper styles. Values that represent the different Lathe Live Center point styles. @defgroup assocvar_ch26 tool radius types @{ @} @defgroup assocvar_ch27 canned cycle types @{ @} @defgroup assocvar_ch3 mill cutter capabilities @{ @} @defgroup ltooldef_ch3 LATHE TOOL TYPES @{ @} @defgroup ltooldef_ch4 CUSTOM GEOMETRY TOOL TYPES @{ @} @defgroup ltooldef_ch5 THREAD INSERT TYPES @{ @} @defgroup ltooldef_ch6 THREAD TYPES @{ @} Enumeration representing the Holder Upper Connection Type. Declares the TlLatheDefinition type and its shared_ptr/unique_ptr aliases. Declares the TlCuttingConfigurationGrooving type and its shared_ptr/unique_ptr aliases. Declares the TlCuttingConfigurationThreading type and its shared_ptr/unique_ptr aliases. Declares the TlCuttingConfigurationTurningBoring type and its shared_ptr/unique_ptr aliases. Declares the TlCuttingConfiguration type and its shared_ptr/unique_ptr aliases. Declares the TlAssemblyConfiguration type and its shared_ptr/unique_ptr aliases. Declares the TlAssemblyComponentTree type and its shared_ptr/unique_ptr aliases. Declares the TlAssemblyAdaptiveItem type and its shared_ptr/unique_ptr aliases. Declares the TlAssemblyTurnHolder type and its shared_ptr/unique_ptr aliases. Declares the TlAssemblyInsert type and its shared_ptr/unique_ptr aliases. Declares the TlAssemblyComponent type and its shared_ptr/unique_ptr aliases. Declares the TlToolAssemblyLatheDefView type and its shared_ptr/unique_ptr aliases. Declares the TlToolAssemblyLatheDefView type and its shared_ptr/unique_ptr aliases. Declares the TlHolderAssembly type and its shared_ptr/unique_ptr aliases. Declares the TlToolAssembly type and its shared_ptr/unique_ptr aliases. Declares the TlAdaptiveItem type and its shared_ptr/unique_ptr aliases. Declares the TlTurnHolder type and its shared_ptr/unique_ptr aliases. Declares the TlBoundaryGenerationParams type and its shared_ptr/unique_ptr aliases. Declares the TlConnectionMap type and its shared_ptr/unique_ptr aliases. Defines an ID referencable map of connections. Declares the TlConnection type and its shared_ptr/unique_ptr aliases. A connection between tool components. Declares the TlGraphicsFileCollection type and its shared_ptr/unique_ptr aliases. Class representing a collection of tool graphics files. Declares the TlGraphicsFile type and its shared_ptr/unique_ptr aliases. Class representing a tool graphics file in memory. Declares the TlAccessoryCollection type and its shared_ptr/unique_ptr aliases. Class representing a collection of tool accessory items. Declares the TlAccessory type and its shared_ptr/unique_ptr aliases. The tl accessory class for assembly accessory items. Declares the TlLocator type and its shared_ptr/unique_ptr aliases. A class that provides standard tool class behavior on top of wrapping a transformation matrix. Declares the TransformationMatrixColumn type and its shared_ptr/unique_ptr aliases. Declares the TransformationMatrix type and its shared_ptr/unique_ptr aliases. Declares the TlXMLNode type and its shared_ptr/unique_ptr aliases. Declares the TlManufacturer type and its shared_ptr/unique_ptr aliases. Class representing a tool manufacturer. Declares the TlOpType type and its shared_ptr/unique_ptr aliases. Declares the TlOpGroup type and its shared_ptr/unique_ptr aliases. Declares the TlHolemakingOpParams type and its shared_ptr/unique_ptr aliases. Declares the TlProfileArcSegment type and its shared_ptr/unique_ptr aliases. Declares the TlProfileLineSegment type and its shared_ptr/unique_ptr aliases. Declares the TlProfileSegment type and its shared_ptr/unique_ptr aliases. Class representing a segment on a 2d profile. Declares the TlProfile type and its shared_ptr/unique_ptr aliases. Class representing a 2D profile comprised of instances of the TlProfileSegment class. Declares the TlMgr type and its shared_ptr/unique_ptr aliases. Declares the TlHolderLatheLiveCenter type and its shared_ptr/unique_ptr aliases. Declares the TlHolderLatheTurning type and its shared_ptr/unique_ptr aliases. Declares the TlHolderLatheThreading type and its shared_ptr/unique_ptr aliases. Declares the TlHolderLatheGrooving type and its shared_ptr/unique_ptr aliases. Declares the TlHolderLatheDrill type and its shared_ptr/unique_ptr aliases. Declares the TlHolderLatheBoring type and its shared_ptr/unique_ptr aliases. Declares the TlHolderLathe type and its shared_ptr/unique_ptr aliases. Declares the TlInsertTurningBoring type and its shared_ptr/unique_ptr aliases. Declares the TlInsertThreading type and its shared_ptr/unique_ptr aliases. Declares the TlInsertLatheDrill type and its shared_ptr/unique_ptr aliases. Declares the TlInsertGrooving type and its shared_ptr/unique_ptr aliases. Declares the TlInsert type and its shared_ptr/unique_ptr aliases. Declares the TlCutParam type and its shared_ptr/unique_ptr aliases. Declares the TlToolType type and its shared_ptr/unique_ptr aliases. Declares the TlToolGroup type and its shared_ptr/unique_ptr aliases. Declares the TlWorkMaterial type and its shared_ptr/unique_ptr aliases. Declares the TlHolderTreeNode type and its shared_ptr/unique_ptr aliases. Declares the TlHolderComposite type and its shared_ptr/unique_ptr aliases. Declares the TlToolBarrelMill type and its shared_ptr/unique_ptr aliases. Declares the TlToolFeedMill type and its shared_ptr/unique_ptr aliases. Declares the TlToolThreading type and its shared_ptr/unique_ptr aliases. Declares the TlToolReamer type and its shared_ptr/unique_ptr aliases. Declares the TlToolLatheCustom type and its shared_ptr/unique_ptr aliases. Declares the TlToolLatheISO type and its shared_ptr/unique_ptr aliases. Declares the TlToolLathe type and its shared_ptr/unique_ptr aliases. Declares the TlToolEndmill type and its shared_ptr/unique_ptr aliases. Declares the TlToolSlotMill type and its shared_ptr/unique_ptr aliases. Declares the TlToolDrill type and its shared_ptr/unique_ptr aliases. Declares the TlToolCenterDrill type and its shared_ptr/unique_ptr aliases. Declares the TlToolCounterBore type and its shared_ptr/unique_ptr aliases. Declares the TlToolBoring type and its shared_ptr/unique_ptr aliases. Declares the TlTool type and its shared_ptr/unique_ptr aliases. The base tool class. This class contains data and functions that are common to every tool. Declares the TlAssemblyItem type and its shared_ptr/unique_ptr aliases. Class representing a tool assembly item. Declares the TlObject type and its shared_ptr/unique_ptr aliases. Base class for all tool class objects. Declares the ILToolDrillCutParams type and its shared_ptr/unique_ptr aliases. Declares the ILToolTurnBoreCutParams type and its shared_ptr/unique_ptr aliases. Declares the ILToolThreadCutParams type and its shared_ptr/unique_ptr aliases. Declares the ILToolGrooveCutParams type and its shared_ptr/unique_ptr aliases. Declares the ILToolCutParams type and its shared_ptr/unique_ptr aliases. Declares the IMTool type and its shared_ptr/unique_ptr aliases. Declares the I3dLTool type and its shared_ptr/unique_ptr aliases. Declares the ILTool type and its shared_ptr/unique_ptr aliases. Declares the ITool type and its shared_ptr/unique_ptr aliases. Defines an alias representing A constant iterator through a TlIDList. Defines an alias representing a vector of type TlID. POINTER TO MEMFILESTRUCT STRUCTURE MEMORY FILE BUFFER INFORMATION DISK FILE INFORMATION WIN32 FILE INFORMATION ent_list_idn memory pointer info setup and stock definition. Position of the cylinder origin with respect to the cylinder shape. This value must be a single byte to fit in as a replacement in the group structure. Position of the rectangle origin with respect to the rectangle shape. Note that the face names in the value names are labeled as viewed in 3d space in Mastercam with corresponding plane names, not with respect to any static image used anywhere in the UI. Origin corner for stock setup box safety zones. mc7 associative file header definition. Wire change at point header. Wire power set settings. Wire power set pass settings. A draw entity (Wire only). A draw arc (Wire only). A draw line (Wire only). A draw point (Wire only). Miscellaneous set data. Miscellaneous pass set data. wire new power set parameters. wire new power pass parameters. wire Agie parameters. Positions (coordinates + method of getting there) for all axes Axis coordinate Axis coordinate types The next 2 members are used for axis combination reference POINTS and home position only. Single value to store group class and type for a set of component group parameters The value is represented as: (100000 x group class) + group type. Machine component unique identifier use coolant to control submerged wire use event list to activate coolant use coolant commands in post-processor (provided for backward compatibility) 1st 'coolant off' command shuts off ALL coolant commands on the machine coolant button text for tool page 'coolant off' interface display text 'coolant on' interface display text 'base' coolant interface display text Coolant. An operation events coolant. @defgroup assocvar_ch40 tool types @{ @} MT work type MT prototype version material definition. lathe specific material specs. @defgroup material_structures Material Structures @{ mill specific material specs. Art Associative Entry. @} profile entity type Database List Entity polygonal mesh entity as it appears in a file (difference is data_index). polygonal_mesh (enhanced file_ent with persistant DB storage, smart memory usage, masking, selection, etc.) file entity (when e.id = FILE_ID, data is in e.u.f) Bitmap type. Description type. File Lock History Type. File Lock History Structure. File Lock Type. History Type. A history structure. Version Header. Relative density (used in NCS files only) structure for dimensions. Union padding for v8 types. Dimension parameters. structure for tangent dimensions. structure for linear dimensions. structure for point dimensions. structure for ordinate dimensions. structure for circular dimensions (rad/dia) structure for angular dimensions. structure for linear dimensions. structure for notes. structure for dimension text. structure for leaders and witness lines. circular leader. structure for standard non_assoc points. A point. A selected entity. A hatch style. Fonts Type. Font style. @note If a copious_data member is added between lathe_bdry_valid and pad1 and the new member is not supposed to be part of the copious_data header, the define below must be changed to use the new member in place of pad1. Copius Data structure. Data structure for font attributes. @defgroup draft_ch3 Drafting Types @{ @defgroup draft_ch5 Linear Drafting Types @{ @} @defgroup draft_ch6 Circular Drafting Types @{ @} @defgroup draft_ch7 Ordinate Drafting Types @{ @} @} The worksheets structure. The level structure. Structure to hold names of levels. Visible levels. Screen Information Type. View Matrix Type. Relief Information Type. Art Bounding Box. A CHAIN is a single chain or the start of a linked list of chains. A chain ent entity. Values that represent chain entity Identifiers. A chain hash. @defgroup chain_data_structures Chain Data Structures @note END_OF_CHAIN is used only for manual sync (only at the end of the first chain). Normally, the end of chain is determined from next == NULL. Information about the chain hash. Cone definition structure that corresponds to Parasolid's cone structure. To convert to Mastercam units one simply uses mastercamValue = PS2MC (parasolidValue) for a value like the radius, or PS2MCPT3D (parasolidPoint, mastercamPoint) for point values. No conversion is required for unit vectors like the axis and ref_direction or for an angular value. Cylinder definition structure that corresponds to Parasolid's cylinder structure. To convert to Mastercam units one simply uses mastercamValue = PS2MC (parasolidValue) for a value like the radius, or PS2MCPT3D (parasolidPoint, mastercamPoint) for point values. No conversion is required for unit vectors like the axis and ref_direction or for an angular value. This corresponds to Parasolid's plane structure and to STEP's axis2_placement structure. Solid Pocket detection Data. Solid Drill detection Data. Solid. Solid data header for storing .x_t in partfile. Surface Entity Type. Trimmed Surface. Offset Surface. Plane. Fillet. Draft Surface. Revolved Surface. Loft Surface. NURBS Surface. piecewise polynomial surface. A surface entity header. composite curve. Curve ON Surface. @note If a spline member is added between pad and ent_ptr and the new member is not supposed to be part of the spline header, the define below must be changed to use the new member in place of ent_ptr. NURBS Spline. Parametric spline. Entity Attribute Type. EA Type. misc. list of entities by ent_idn. ent_idns for machine components and component groups in the database Attribute structure. pocket boundary. This is the central data structure used by pocketing. All boundaries and islands can be expressed in this structure. It is a linked list. @defgroup pock_data_structures Pocket Data Structures @{ pointer to art data Homogeneous matrix. pointer to art data. Serializes this object's data to (or from) an archive. Reference to archive. Gets the runtime class ID of this object. Class runtime ID. Gets the class name of this object. Class name. Destructor. Constructor. Base object for classes requiring serialization support. \ingroup GafBase @{ Values that represent toolpath entity types (for ent.u.tp.tp_id when ent.id == ASSOC_ID and ent.assoc_id == TP_ID). Values that represent associative entity types (for ent.assoc_id when ent.id == ASSOC_ID). Convert a p_4d reference to a p_3d reference. 4D point to convert. p_3d reference. Convert a p_3d reference to a p_2d reference. 3D point to convert. p_2d reference. Convert a double pointer to a p_4d reference. Double pointer to convert. p_4d reference. Convert a constant double pointer to a constant p_4d reference. Double pointer to convert. Constant p_4d reference. Convert a double pointer to a p_3d reference. Double pointer to convert. p_3d reference. Convert a constant double pointer to a constant p_3d reference. Double pointer to convert. Constant p_3d reference. Convert a double pointer to a p_2d reference. Double pointer to convert. p_2d reference. Convert a constant double pointer to a constant p_2d reference. Double pointer to convert. Constant p_2d reference. Inequality operator overload for 4D point. The comparison is done using the tolerance MTOL. Call Equal to compare two points using a caller specified tolerance. First point to compare. Second point to compare. True if the points are not equal withing MTOL, false otherwise. Equality operator overload for 4D point. The comparison is done using the tolerance MTOL. Call Equal to compare two points using a caller specified tolerance. First point to compare. Second point to compare. True if the points are equal withing MTOL, false otherwise. Inequality operator overload for 3D point. The comparison is done using the tolerance MTOL. Call Equal to compare two points using a caller specified tolerance. First point to compare. Second point to compare. True if the points are not equal withing MTOL, false otherwise. Equality operator overload for 3D point. The comparison is done using the tolerance MTOL. Call Equal to compare two points using a caller specified tolerance. First point to compare. Second point to compare. True if the points are equal withing MTOL, false otherwise. Inequality operator overload for 2D point. The comparison is done using the tolerance MTOL. Call Equal to compare two points using a caller specified tolerance. First point to compare. Second point to compare. True if the points are not equal withing MTOL, false otherwise. Equality operator overload for 2D point. The comparison is done using the tolerance MTOL. Call Equal to compare two points using a caller specified tolerance. First point to compare. Second point to compare. True if the points are equal withing MTOL, false otherwise. Computes the cross product of two 3D "vectors". First vector. Second vector. Cross product. Computes the cross product of two 2D "vectors". First vector. Second vector. Cross product. Computes the dot product of two 4D "vectors". First vector. Second vector. Dot product. Computes the dot product of two 3D "vectors". First vector. Second vector. Dot product. Computes the dot product of two 2D "vectors". First vector. Second vector. Dot product. Computes the distance squared between two 4D points. First point. Second point. Distance squared. Computes the distance squared between two 3D points. First point. Second point. Distance squared. Computes the distance squared between two 2D points. First point. Second point. Distance squared. Computes the distance between two 4D points. First point. Second point. Distance. Computes the distance between two 3D points. First point. Second point. Distance. @} Computes the distance between two 2D points. First pnt. Second pnt. Distance. 3D line, point or arc @} Defines an alias representing the matrix 44. Transformation matrix Array indexer operator. The index. The indexed value. Array indexer operator. The index. The indexed value. 4x3 matrix. Constructor. row 0 column 0. row 0 column 1. row 0 column 2. row 1 column 0. row 1 column 1. row 1 column 2. row 2 column 0. row 2 column 1. row 2 column 2. Constructor. X axis (row 0). Y axis (row 1). Z axis (row 2). Constructor. Math Library-style matrix to copy. Constructor. Matrix to copy. Default constructor. 3x3 matrix (initialized). By default, the matrix is initialized to the identity matrix. Transposes this matrix. Reference to this matrix. Returns a matrix that is the transpose of this matrix. Transposed matrix. Checks if this object is the identity matrix. True if identity matrix, false if not. Sets this object to the identity matrix. Array indexer operator overload. The index. The indexed value. Array indexer operator overload. The index. The indexed value. Operator (Cnc::Math::Matrix33) overload. This object converted to a Math Library-style matrix. Assignment operator overload. Math Library-style matrix to copy. A reference to this object. @} @defgroup matrix_types Matrix Types @{ 3x3 matrix. 2D line, point or arc 3D Arc 2D Arc 3D Line 2D Line Assignment operator overload. Point to copy. A reference to this object. Constructor. 3D point. w value. Constructor. X/Y/Z/W values. Constructor. X value. Y value. Z value. W value. Constructor. Math Library-style vector to copy. Constructor. Point to copy. Default constructor. 4D point (initialized). By default, the point is initialized to (0., 0., 0., 0.). Multiplication operator overload for "scale * p_4d". Value to multiply by. 4D point to scale. A point which contains the result of the multiplication. Gets a normalized (unitized) copy of this "vector". Normalized "vector". Normalizes (unitizes) this "vector". A reference to this "vector". Gets the length squared of this "vector". Vector length squared. Gets the length of this "vector". Vector length. Division assignment operator overload. There is no check to insure "scale" is not zero. Value to divide this point by. A reference to this point. Division operator overload. There is no check to insure "scale" is not zero. Value to divide by. A point which contains the result of the division. Multiplication assignment operator overload. Value to multiply this point by. A reference to this point. Multiplication operator overload. Value to multiply by. A point which contains the result of the multiplication. Subtraction assignment operator overload. Point to subtract from this point. A reference to this point. Subtraction operator overload. Point to subtract. A point which contains the result of the subtraction. Unary minus operator overload. A point which contains this point negated. Addition assignment operator overload. Point to add to this point. A reference to this point. Addition operator overload. Point to add. A point which contains the result of the addition. Less than operator overload. Point to compare against. True if this point is less than specified point, false otherwise. Gets a double "array" pointer to this object. Double pointer to this object. Gets a double "array" pointer to this object. Double pointer to this object. Converts this object to a 3D point. 3D point. Sets the X/Y/Z components of this object to the specified values. 3D point. Sets this object to the specified values. 3D point. W value. Sets this object to the specified values. X/Y/Z/W values. Sets this object to the specified values. X value. Y value. Z value. W value. Sets this object to (0., 0., 0., 0.). Array indexer operator overload. The index. The indexed value. Array indexer operator overload. The index. The indexed value. Operator (Cnc::Math::Vector4D) overload. This object converted to a math. Assignment operator overload. Point to copy. A reference to this object. 4D point. Assignment operator overload. Point to copy. A reference to this object. Constructor. 2D point. Z value. Constructor. X/Y values. Z value. Constructor. X/Y/Z values. Constructor. X value. Y value. Z value. Constructor. Math Library-style vector to copy. Constructor. Point to copy. Default constructor. 3D point (initialized). By default, the point is initialized to (0., 0., 0.). Multiplication operator overload for "scale * p_3d". Value to multiply by. 3D point to scale. A point which contains the result of the multiplication. Gets a normalized (unitized) copy of this "vector". Normalized "vector". Normalizes (unitizes) this "vector". A reference to this "vector". Gets the length squared of this "vector". Vector length squared. Gets the length of this "vector". Vector length. Division assignment operator overload. There is no check to insure "scale" is not zero. Value to divide this point by. A reference to this point. Division operator overload. There is no check to insure "scale" is not zero. Value to divide by. A point which contains the result of the division. Multiplication assignment operator overload. Value to multiply this point by. A reference to this point. Multiplication operator overload. Value to multiply by. A point which contains the result of the multiplication. Subtraction assignment operator overload. Point to subtract from this point. A reference to this point. Subtraction operator overload. Point to subtract. A point which contains the result of the subtraction. Unary minus operator overload. A point which contains this point negated. Addition assignment operator overload. Point to add to this point. A reference to this point. Addition operator overload. Point to add. A point which contains the result of the addition. Less than operator overload. Point to compare against. True if this point is less than specified point, false otherwise. Gets a double "array" pointer to this object. Double pointer to this object. Gets a double "array" pointer to this object. Double pointer to this object. Converts this object to a 2D point. 2D point. Sets the X/Y components of this object to the specified values. X/Y value. Sets the X/Y components of this object to the specified values. X value. Y value. Sets the X/Y components of this object to the specified values. 3D point. Sets the X/Y components of this object to the specified values. 2D point. Sets this object to the specified values. 2D point. Z value. Sets this object to the specified values. X/Y values. Z value. Sets this object to the specified values. X/Y/Z value. Sets this object to the specified values. X value. Y value. Z value. Sets this object to (0., 0., 0.). Array indexer operator overload. The index. The indexed value. Array indexer operator overload. The index. The indexed value. Operator (Cnc::Math::Vector3D) overload. This object converted to a math. Assignment operator overload. Point to copy. A reference to this object. Assignment operator overload. Point to copy. A reference to this object. Constructor. X/Y values. Constructor. X value. Y value. Constructor. Math Library-style vector to copy. Constructor. Point to copy. Default constructor. 2D point (initialized). By default, the point is initialized to (0., 0.). Multiplication operator overload for "scale * p_2d". Value to multiply by. 2D point to scale. A point which contains the result of the multiplication. Gets a normalized (unitized) copy of this "vector". Normalized "vector". Normalizes (unitizes) this "vector". A reference to this "vector". Gets the length squared of this "vector". Vector length squared. Gets the length of this "vector". Vector length. Division assignment operator overload. There is no check to insure "scale" is not zero. Value to divide this point by. A reference to this point. Division operator overload. There is no check to insure "scale" is not zero. Value to divide by. A point which contains the result of the division. Multiplication assignment operator overload. Value to multiply this point by. A reference to this point. Multiplication operator overload. Value to multiply by. A point which contains the result of the multiplication. Subtraction assignment operator overload. Point to subtract from this point. A reference to this point. Subtraction operator overload. Point to subtract. A point which contains the result of the subtraction. Unary minus operator overload. A point which contains this point negated. Addition assignment operator overload. Point to add to this point. A reference to this point. Addition operator overload. Point to add. A point which contains the result of the addition. Less than operator overload. Point to compare against. True if this point is less than specified point, false otherwise. Gets a double "array" pointer to this object. Double pointer to this object. Gets a double "array" pointer to this object. Double pointer to this object. Converts this object to a 3D point. 3D point. Sets this object to the specified values. X/Y values. Sets this object to the specified values. X value. Y value. Sets this object to (0., 0.). Array indexer operator overload. The index. The indexed value. Array indexer operator overload. The index. The indexed value. Operator (Cnc::Math::Vector2D) overload. This object converted to a math. Assignment operator overload. Point to copy. A reference to this object. 2D point. @defgroup Points_Lines_Arcs Point, Line, and Arc Types @{ 3D point. @} @defgroup math_varuables math variables * * initialized in this module @{ System Tolerance Write formatted (CString::FormatMessage style) data to a CString. String resource identifier that contains the format-control string. The formatted string. Write formatted (printf style) data to a CString. String resource identifier that contains the format-control string. The formatted string. A pointer to an ID2D1BitmapRenderTarget object. Retrieves the bitmap for this render target. The returned bitmap can be used for drawing operations. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. When this method returns, contains the valid bitmap for this render target. This bitmap can be used for drawing operations. Returns ID2D1BitmapRenderTarget interface Pointer to an ID2D1BitmapRenderTarget interface or NULL if object is not initialized yet. Returns ID2D1BitmapRenderTarget interface Pointer to an ID2D1BitmapRenderTarget interface or NULL if object is not initialized yet. Detaches render target interface from the object Pointer to detached render target interface. Attaches existing render target interface to the object Existing render target interface. Cannot be NULL Constructs a CBitmapRenderTarget object. A pointer to an ID2D1DCRenderTarget object. Returns ID2D1DCRenderTarget interface Pointer to an ID2D1DCRenderTarget interface or NULL if object is not initialized yet. Returns ID2D1DCRenderTarget interface Pointer to an ID2D1DCRenderTarget interface or NULL if object is not initialized yet. Binds the render target to the device context to which it issues drawing commands If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The device context to which the render target issues drawing commands The dimensions of the handle to a device context (HDC) to which the render target is bound Creates a CDCRenderTarget. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The rendering mode, pixel format, remoting options, DPI information, and the minimum DirectX support required for hardware rendering. Detaches render target interface from the object Pointer to detached render target interface. Attaches existing render target interface to the object Existing render target interface. Cannot be NULL Constructs a CDCRenderTarget object. ID2D1DCRenderTarget wrapper. A pointer to an ID2D1HwndRenderTarget object. Changes the size of the render target to the specified pixel size If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The new size of the render target in device pixels Indicates whether the HWND associated with this render target is occluded. A value that indicates whether the HWND associated with this render target is occluded. Returns the HWND associated with this render target. The HWND associated with this render target. Returns ID2D1HwndRenderTarget interface. Pointer to an ID2D1HwndRenderTarget interface or NULL if object is not initialized yet. Returns ID2D1HwndRenderTarget interface. Pointer to an ID2D1HwndRenderTarget interface or NULL if object is not initialized yet. Re-creates a render target associated with the window If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The HWND associated with this render target Creates a render target associated with the window If the method succeeds, it returns TRUE. Otherwise, it returns FALSE The HWND associated with this render target Detaches render target interface from the object Pointer to detached render target interface. Attaches existing render target interface to the object Existing render target interface. Cannot be NULL Constructs a CHwndRenderTarget object from HWND. The HWND associated with this render target ID2D1HwndRenderTarget wrapper. A pointer to CD2DTextFormat object that contains a default text format. A list of pointers to CD2DResource objects. A pointer to an ID2D1RenderTarget object. Verifies CD2DResource object validity; creates the object if it didn't already exist. Pointer to CD2DResource object. TRUE is object if valid; otherwise FALSE. Removes the last axis-aligned clip from the render target. After this method is called, the clip is no longer applied to subsequent drawing operations. Removes the last axis-aligned clip from the render target. After this method is called, the clip is no longer applied to subsequent drawing operations. The size and position of the clipping area, in device-independent pixels. The antialiasing mode that is used to draw the edges of clip rects that have subpixel boundaries, and to blend the clip with the scene contents. The blending is performed once when the PopAxisAlignedClip method is called, and does not apply to each primitive within the layer. Sets the render target's drawing state to that of the specified ID2D1DrawingStateBlock. The new drawing state of the render target. Saves the current drawing state to the specified ID2D1DrawingStateBlock. When this method returns, contains the current drawing state of the render target. This parameter must be initialized before passing it to the method. Executes all pending drawing commands. Contains the tag for drawing operations that caused errors or 0 if there were no errors. This parameter is passed uninitialized. Contains the tag for drawing operations that caused errors or 0 if there were no errors. This parameter is passed uninitialized. Stops redirecting drawing operations to the layer that is specified by the last PushLayer call. Adds the specified layer to the render target so that it receives all subsequent drawing operations until PopLayer is called. The content bounds, geometric mask, opacity, opacity mask, and antialiasing options for the layer. The layer that receives subsequent drawing operations. Creates a new bitmap render target for use during intermediate offscreen drawing that is compatible with the current render target . If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. When this method returns, contains the address of a pointer to a new bitmap render target. This parameter is passed uninitialized. The desired size of the new render target in device-independent pixels if it should be different from the original render target, or NULL. For more information, see the Remarks section. The desired size of the new render target in pixels if it should be different from the original render target, or NULL. For more information, see the Remarks section. The desired pixel format and alpha mode of the new render target, or NULL. If the pixel format is set to DXGI_FORMAT_UNKNOWN or if this parameter is null, the new render target uses the same pixel format as the original render target. If the alpha mode is D2D1_ALPHA_MODE_UNKNOWN or this parameter is NULL, the alpha mode of the new render target defaults to D2D1_ALPHA_MODE_PREMULTIPLIED. For information about supported pixel formats, see Supported Pixel Formats and Alpha Modes. A value that specifies whether the new render target must be compatible with GDI. Applies the specified transform to the render target, replacing the existing transformation. All subsequent drawing operations occur in the transformed space. The transform to apply to the render target. Applies the specified transform to the render target, replacing the existing transformation. All subsequent drawing operations occur in the transformed space. The transform to apply to the render target. Applies the specified transform to the render target, replacing the existing transformation. All subsequent drawing operations occur in the transformed space. The transform to apply to the render target. Retrieves the render target's current text rendering options. When this method returns, textRenderingParamscontains the address of a pointer to the render target's current text rendering options. Specifies text rendering options to be applied to all subsequent text and glyph drawing operations. The text rendering options to be applied to all subsequent text and glyph drawing operations; NULL to clear current text rendering options. Gets the current antialiasing mode for text and glyph drawing operations. Current antialiasing mode for text and glyph drawing operations. Specifies the antialiasing mode to use for subsequent text and glyph drawing operations. The antialiasing mode to use for subsequent text and glyph drawing operations. Retrieves the current antialiasing mode for nontext drawing operations. Current antialiasing mode for nontext drawing operations. Sets the antialiasing mode of the render target. The antialiasing mode applies to all subsequent drawing operations, excluding text and glyph drawing operations. The antialiasing mode for future drawing operations. Paints the interior of the specified mesh. The mesh to paint. The brush used to paint the mesh. Draws the specified glyphs. The origin, in device-independent pixels, of the glyphs' baseline. The glyphs to render. The brush used to paint the specified glyphs. A value that indicates how glyph metrics are used to measure text when it is formatted. The default value is DWRITE_MEASURING_MODE_NATURAL. Paints the interior of the specified geometry. The geometry to paint. The brush used to paint the geometry's interior. The opacity mask to apply to the geometry;NULL for no opacity mask. If an opacity mask (the opacityBrush parameter) is specified, brush must be an ID2D1BitmapBrush that has its x- and y-extend modes set to D2D1_EXTEND_MODE_CLAMP. For more information, see the Remarks section. Draws the outline of the specified geometry using the specified stroke style. The geometry to draw. The brush used to paint the geometry's stroke. The thickness of the geometry's stroke. The stroke is centered on the geometry's outline. The style of stroke to apply to the geometry's outline, or NULL to paint a solid stroke. Draws the formatted text described by the specified IDWriteTextLayout object. The bitmap to render. The size and position, in device-independent pixels in the render target's coordinate space, of the area to which the bitmap is drawn. If the rectangle is not well-ordered, nothing is drawn, but the render target does not enter an error state. A value between 0.0f and 1.0f, inclusive, that specifies an opacity value to apply to the bitmap; this value is multiplied against the alpha values of the bitmap's contents. The interpolation mode to use if the bitmap is scaled or rotated by the drawing operation. The size and position, in device-independent pixels in the bitmap's coordinate space, of the area within the bitmap to draw. Draws the formatted text described by the specified IDWriteTextLayout object. The point, described in device-independent pixels, at which the upper-left corner of the text described by textLayout is drawn. The formatted text to draw. Any drawing effects that do not inherit from ID2D1Resource are ignored. If there are drawing effects that inherit from ID2D1Resource that are not brushes, this method fails and the render target is put in an error state. The brush used to paint any text in textLayout that does not already have a brush associated with it as a drawing effect (specified by the IDWriteTextLayout::SetDrawingEffect method). A value that indicates whether the text should be snapped to pixel boundaries and whether the text should be clipped to the layout rectangle. The default value is D2D1_DRAW_TEXT_OPTIONS_NONE, which indicates that text should be snapped to pixel boundaries and it should not be clipped to the layout rectangle. Draws the specified text using the format information provided by an IDWriteTextFormat object. A pointer to an array of Unicode characters to draw. The size and position of the area in which the text is drawn. The brush used to paint the text. An object that describes formatting details of the text to draw, such as the font, the font size, and flow direction. A value that indicates whether the text should be snapped to pixel boundaries and whether the text should be clipped to the layout rectangle. The default value is D2D1_DRAW_TEXT_OPTIONS_NONE, which indicates that text should be snapped to pixel boundaries and it should not be clipped to the layout rectangle. A value that indicates how glyph metrics are used to measure text when it is formatted. The default value is DWRITE_MEASURING_MODE_NATURAL. Applies the opacity mask described by the specified bitmap to a brush and uses that brush to paint a region of the render target. The position and radius, in device-independent pixels, of the ellipse to paint. The brush used to paint the region of the render target specified by destinationRectangle. The type of content the opacity mask contains. The value is used to determine the color space in which the opacity mask is blended. The region of the render target to paint, in device-independent pixels. The region of the bitmap to use as the opacity mask, in device-independent pixels. Draws a line between the specified points using the specified stroke style. The start point of the line, in device-independent pixels. The end point of the line, in device-independent pixels. The brush used to paint the line's stroke. A value greater than or equal to 0.0f that specifies the width of the stroke. If this parameter isn't specified, it defaults to 1.0f. The stroke is centered on the line. The style of stroke to paint, or NULL to paint a solid line. Paints the interior of the specified ellipse. The position and radius, in device-independent pixels, of the ellipse to paint. The brush used to paint the interior of the ellipse. Draws the outline of the specified ellipse using the specified stroke style. The position and radius of the ellipse to draw, in device-independent pixels. The brush used to paint the ellipse's outline. The thickness of the ellipse's stroke. The stroke is centered on the ellipse's outline. The style of stroke to apply to the ellipse's outline, or NULL to paint a solid stroke. Paints the interior of the specified rounded rectangle. The dimensions of the rounded rectangle to paint, in device independent pixels. The brush used to paint the interior of the rounded rectangle. Draws the outline of the specified rounded rectangle using the specified stroke style. The dimensions of the rounded rectangle to draw, in device-independent pixels. The brush used to paint the rounded rectangle's outline. The width of the rounded rectangle's stroke. The stroke is centered on the rounded rectangle's outline. The default value is 1.0f. The style of the rounded rectangle's stroke, or NULL to paint a solid stroke. The default value is NULL. Paints the interior of the specified rectangle. The dimension of the rectangle to paint, in device-independent pixels. The brush used to paint the rectangle's interior. Draws the outline of a rectangle that has the specified dimensions and stroke style. The dimensions of the rectangle to draw, in device-independent pixels The brush used to paint the rectangle's stroke A value greater than or equal to 0.0f that specifies the width of the rectangle's stroke. The stroke is centered on the rectangle's outline. The style of stroke to paint, or NULL to paint a solid stroke. Clears the drawing area to the specified color. The color to which the drawing area is cleared. Converts GDI color and alpha values to the D2D1_COLOR_F object. RGB value. Alpha value. D2D1_COLOR_F value. Ends drawing operations on the render target and indicates the current error state and associated tags. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. Initiates drawing on this render target. Detaches render target interface from the object Pointer to detached render target interface. Attaches existing render target interface to the object Existing render target interface. Cannot be NULL Gets the maximum size, in device-dependent units (pixels), of any one bitmap dimension supported by the render target The maximum size, in pixels, of any one bitmap dimension supported by the render target Indicates whether the render target supports the specified properties TRUE if the specified render target properties are supported by this render target; otherwise, FALSE The render target properties to test Specifies a label for subsequent drawing operations. A label to apply to subsequent drawing operations. A label to apply to subsequent drawing operations. Gets the label for subsequent drawing operations. Contains the first label for subsequent drawing operations. This parameter is passed uninitialized. If NULL is specified, no value is retrieved for this parameter. Contains the second label for subsequent drawing operations. This parameter is passed uninitialized. If NULL is specified, no value is retrieved for this parameter. Returns the size of the render target in device pixels The size of the render target in device pixels Retrieves the pixel format and alpha mode of the render target The pixel format and alpha mode of the render target Returns the render target's dots per inch (DPI) The render target's dots per inch (DPI). Sets the dots per inch (DPI) of the render target. A value greater than or equal to zero that specifies the horizontal/verticalDPI of the render target. Returns the size of the render target in device-independent pixels The current size of the render target in device-independent pixels Returns ID2D1RenderTarget interface Pointer to an ID2D1RenderTarget interface or NULL if object is not initialized yet. Returns ID2D1RenderTarget interface Pointer to an ID2D1RenderTarget interface or NULL if object is not initialized yet. Checks resource validity TRUE if resource is valid; otherwise FALSE. Deletes one or more resources If the method succeeds, it returns TRUE. Otherwise, it returns FALSE If bDeleteResources is TRUE, all resources located in m_lstResources will be automatically destroyed. The destructor. Called when a render target object is being destroyed. Constructs a CRenderTarget object. ID2D1RenderTarget wrapper. A pointer to an ID2D1Mesh. Checks resource validity TRUE if resource is valid; otherwise FALSE. Destroys a CD2DMesh object. Creates a CD2DMesh. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. Opens the mesh for population. A pointer to an ID2D1TessellationSink that is used to populate the mesh. Returns ID2D1Mesh interface Pointer to an ID2D1Mesh interface or NULL if object is not initialized yet. Returns ID2D1Mesh interface Pointer to an ID2D1Mesh interface or NULL if object is not initialized yet. Detaches resource interface from the object Pointer to detached resource interface. Attaches existing resource interface to the object Existing resource interface. Cannot be NULL The destructor. Called when a D2D mesh object is being destroyed. Constructs a CD2DMesh object. A pointer to the render target. Indicates that the object will be destroyed by owner (pParentTarget). ID2D1Mesh wrapper. A pointer to an ID2D1GeometrySink. Specifies stroke and join options to be applied to new segments added to the geometry sink. Stroke and join options to be applied to new segments added to the geometry sink. Specifies the method used to determine which points are inside the geometry described by this geometry sink and which points are outside. The method used to determine whether a given point is part of the geometry. Closes the geometry sink Nonzero if successful; otherwise FALSE. Creates a sequence of lines using the specified points and adds them to the geometry sink. An array of one or more points that describe the lines to draw. A line is drawn from the geometry sink's current point (the end point of the last segment drawn or the location specified by BeginFigure) to the first point in the array. if the array contains additional points, a line is drawn from the first point to the second point in the array, from the second point to the third point, and so on. An array of a sequence of the end points of the lines to draw. Creates a line segment between the current point and the specified end point and adds it to the geometry sink. The end point of the line to draw. Adds a sequence of quadratic Bezier segments as an array in a single call. An array of a sequence of quadratic Bezier segments. Creates a quadratic Bezier curve between the current point and the specified end point. A structure that describes the control point and the end point of the quadratic Bezier curve to add. Creates a sequence of cubic Bezier curves and adds them to the geometry sink. An array of Bezier segments that describes the Bezier curves to create. A curve is drawn from the geometry sink's current point (the end point of the last segment drawn or the location specified by BeginFigure) to the end point of the first Bezier segment in the array. if the array contains additional Bezier segments, each subsequent Bezier segment uses the end point of the preceding Bezier segment as its start point. Creates a cubic Bezier curve between the current point and the specified end point. A structure that describes the control points and end point of the Bezier curve to add. Adds a single arc to the path geometry The arc segment to add to the figure Ends the current figure; optionally, closes it. A value that indicates whether the current figure is closed. If the figure is closed, a line is drawn between the current point and the start point specified by BeginFigure. Starts a new figure at the specified point. The point at which to begin the new figure. Whether the new figure should be hollow or filled. Returns ID2D1GeometrySink interface Pointer to an ID2D1GeometrySink interface or NULL if object is not initialized yet. Returns ID2D1GeometrySink interface Pointer to an ID2D1GeometrySink interface or NULL if object is not initialized yet. Checks geometry sink validity TRUE if geometry sink is valid; otherwise FALSE. The destructor. Called when a D2D geometry sink object is being destroyed. Constructs a CD2DGeometrySink object from CD2DPathGeometry object. An existing CD2DPathGeometry object. ID2D1GeometrySink wrapper. A pointer to an ID2D1PathGeometry. Retrieves tthe number of figures in the path geometry. Returns the number of figures in the path geometry. Retrieves the number of segments in the path geometry. Returns the number of segments in the path geometry. Copies the contents of the path geometry to the specified ID2D1GeometrySink. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The sink to which the path geometry's contents are copied. Modifying this sink does not change the contents of this path geometry. Retrieves the geometry sink that is used to populate the path geometry with figures and segments. A pointer to the ID2D1GeometrySink that is used to populate the path geometry with figures and segments. Detaches resource interface from the object Pointer to detached resource interface. Attaches existing resource interface to the object Existing resource interface. Cannot be NULL Destroys a CD2DPathGeometry object. Creates a CD2DPathGeometry. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. Constructs a CD2DPathGeometry object. A pointer to the render target. Indicates that the object will be destroyed by owner (pParentTarget). ID2D1PathGeometry wrapper. A pointer to an ID2D1Geometry. Widens the geometry by the specified stroke and writes the result to an ID2D1SimplifiedGeometrySink after it has been transformed by the specified matrix and flattened using the specified tolerance. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The amount by which to widen the geometry. The style of stroke to apply to the geometry, or NULL. The transform to apply to the geometry after widening it. The ID2D1SimplifiedGeometrySink to which the widened geometry is appended. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution. Creates a set of clockwise-wound triangles that cover the geometry after it has been transformed using the specified matrix and flattened using the specified tolerance. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The transform to apply to this geometry, or NULL. The ID2D1TessellationSink to which the tessellated is appended. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution. Creates a simplified version of the geometry that contains only lines and (optionally) cubic Bezier curves and writes the result to an ID2D1SimplifiedGeometrySink. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. A value that specifies whether the simplified geometry should contain curves. The transform to apply to the simplified geometry. The ID2D1SimplifiedGeometrySink to which the simplified geometry is appended. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution. Computes the outline of the geometry and writes the result to an ID2D1SimplifiedGeometrySink. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The transform to apply to the geometry outline. The ID2D1SimplifiedGeometrySink to which the geometry transformed outline is appended. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution. Determines whether the geometry's stroke contains the specified point given the specified stroke thickness, style, and transform. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The point to test for containment. The thickness of the stroke to apply. The style of the stroke to apply. The transform to apply to the stroked geometry. When this method returns, contains a boolean value set to TRUE if the geometry's stroke contains the specified point; otherwise, FALSE. You must allocate storage for this parameter. The numeric accuracy with which the precise geometric path and path intersection is calculated. Points missing the stroke by less than the tolerance are still considered inside. Smaller values produce more accurate results but cause slower execution. Indicates whether the area filled by the geometry would contain the specified point given the specified flattening tolerance. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The point to test. The transform to apply to the geometry prior to testing for containment. When this method returns, contains a bool value that is TRUE if the area filled by the geometry contains point; otherwise, FALSE. You must allocate storage for this parameter. The numeric accuracy with which the precise geometric path and path intersection is calculated. Points missing the fill by less than the tolerance are still considered inside. Smaller values produce more accurate results but cause slower execution. Gets the bounds of the geometry after it has been widened by the specified stroke width and style and transformed by the specified matrix. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The amount by which to widen the geometry by stroking its outline. The style of the stroke that widens the geometry. A transform to apply to the geometry after the geometry is transformed and after the geometry has been stroked. When this method returns, contains the bounds of the widened geometry. You must allocate storage for this parameter. The maximum bounds on the distance between points in the polygonal approximation of the geometries. Smaller values produce more accurate results but cause slower execution. Retrieves the bounds of the geometry. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The transform to apply to this geometry before calculating its bounds. When this method returns, contains the bounds of this geometry. If the bounds are empty, this will be a rect where bounds.left is greater than bounds.right. You must allocate storage for this parameter. Calculates the point and tangent vector at the specified distance along the geometry after it has been transformed by the specified matrix and flattened using the specified tolerance. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The distance along the geometry of the point and tangent to find. If this distance is less then 0, this method calculates the first point in the geometry. If this distance is greater than the length of the geometry, this method calculates the last point in the geometry. The transform to apply to the geometry before calculating the specified point and tangent. The location at the specified distance along the geometry. If the geometry is empty, this point contains NaN as its x and y values. When this method returns, contains a pointer to the tangent vector at the specified distance along the geometry. If the geometry is empty, this vector contains NaN as its x and y values. You must allocate storage for this parameter. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution. Calculates the length of the geometry as though each segment were unrolled into a line. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The transform to apply to the geometry before calculating its length. When this method returns, contains a pointer to the length of the geometry. For closed geometries, the length includes an implicit closing segment. You must allocate storage for this parameter. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution. Computes the area of the geometry after it has been transformed by the specified matrix and flattened using the specified tolerance. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The transform to apply to this geometry before computing its area. When this method returns, contains a pointer to the area of the transformed, flattened version of this geometry. You must allocate storage for this parameter. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution. Describes the intersection between this geometry and the specified geometry. The comparison is performed using the specified flattening tolerance. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The geometry to test. The transform to apply to inputGeometry. The maximum bounds on the distance between points in the polygonal approximation of the geometries. Smaller values produce more accurate results but cause slower execution. Combines this geometry with the specified geometry and stores the result in an ID2D1SimplifiedGeometrySink. If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The geometry to combine with this instance. The type of combine operation to perform. The transform to apply to inputGeometry before combining. The result of the combine operation. The maximum bounds on the distance between points in the polygonal approximation of the geometries. Smaller values produce more accurate results but cause slower execution. Checks resource validity TRUE if resource is valid; otherwise FALSE. Destroys a CD2DGeometry object. Returns ID2D1Geometry interface Pointer to an ID2D1Geometry interface or NULL if object is not initialized yet. Returns ID2D1Geometry interface Pointer to an ID2D1Geometry interface or NULL if object is not initialized yet. Detaches resource interface from the object Pointer to detached resource interface. Attaches existing resource interface to the object Existing resource interface. Cannot be NULL The destructor. Called when a D2D geometry object is being destroyed. Constructs a CD2DGeometry object. A pointer to the render target. Indicates that the object will be destroyed by owner (pParentTarget). ID2D1Geometry wrapper. A pointer to an IDWriteTextLayout. Gets the locale name of the text at the specified position. CString object that contains the current locale name. The position of the text to inspect. The range of text that has the same formatting as the text at the position specified by currentPosition. This means the run has the exact formatting as the position specified, including but not limited to the locale name. Copies the font family name of the text at the specified position. CString object that contains the current font family name. The position of the text to examine. The range of text that has the same formatting as the text at the position specified by currentPosition. This means the run has the exact formatting as the position specified, including but not limited to the font family name. Sets the locale name for text within a specified text range If the method succeeds, it returns TRUE. Otherwise, it returns FALSE A null-terminated locale name string Text range to which this change applies Sets null-terminated font family name for text within a specified text range If the method succeeds, it returns TRUE. Otherwise, it returns FALSE The font family name that applies to the entire text string within the range specified by textRange Text range to which this change applies Returns IDWriteTextLayout interface Pointer to an IDWriteTextLayout interface or NULL if object is not initialized yet. Returns IDWriteTextLayout interface Pointer to an IDWriteTextLayout interface or NULL if object is not initialized yet. Checks resource validity TRUE if resource is valid; otherwise FALSE. Destroys a CD2DTextLayout object. Creates a CD2DTextLayout. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. Re-creates a CD2DTextLayout. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. The destructor. Called when a D2D text layout object is being destroyed. Constructs a CD2DTextLayout object. A pointer to the render target. A CString object that contains the string to create a new CD2DTextLayout object from. A CString object that contains the format to apply to the string. The size of the layout box. Indicates that the object will be destroyed by owner (pParentTarget). IDWriteTextLayout wrapper. A pointer to an IDWriteTextFormat. Gets a copy of the locale name. CString object that contains the current locale name. Gets a copy of the font family name. CString object that contains the current font family name. Returns IDWriteTextFormat interface Pointer to an IDWriteTextFormat interface or NULL if object is not initialized yet. Returns IDWriteTextFormat interface Pointer to an IDWriteTextFormat interface or NULL if object is not initialized yet. Checks resource validity TRUE if resource is valid; otherwise FALSE. Destroys a CD2DTextFormat object. Creates a CD2DTextFormat. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. Re-creates a CD2DTextFormat. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. The destructor. Called when a D2D text format object is being destroyed. Constructs a CD2DTextFormat object. A pointer to the render target. A CString object that contains the name of the font family. The logical size of the font in DIP ("device-independent pixel") units. A DIPequals 1/96 inch. A value that indicates the font weight for the text object. A value that indicates the font style for the text object. A value that indicates the font stretch for the text object. A CString object that contains the locale name. A pointer to a font collection object. When this is NULL, indicates the system font collection. Indicates that the object will be destroyed by owner (pParentTarget). IDWriteTextFormat wrapper. A pointer to an ID2D1RadialGradientBrush. The center, gradient origin offset, and x-radius and y-radius of the brush's gradient. Retrieves the y-radius of the gradient ellipse The y-radius of the gradient ellipse. This value is expressed in the brush's coordinate space Retrieves the x-radius of the gradient ellipse The x-radius of the gradient ellipse. This value is expressed in the brush's coordinate space Retrieves the offset of the gradient origin relative to the gradient ellipse's center The offset of the gradient origin from the center of the gradient ellipse. This value is expressed in the brush's coordinate space Retrieves the center of the gradient ellipse The center of the gradient ellipse. This value is expressed in the brush's coordinate space Specifies the y-radius of the gradient ellipse, in the brush's coordinate space The y-radius of the gradient ellipse. This value is in the brush's coordinate space Specifies the x-radius of the gradient ellipse, in the brush's coordinate space The x-radius of the gradient ellipse. This value is in the brush's coordinate space Specifies the offset of the gradient origin relative to the gradient ellipse's center The offset of the gradient origin from the center of the gradient ellipse Specifies the center of the gradient ellipse in the brush's coordinate space The center of the gradient ellipse, in the brush's coordinate space Returns ID2D1RadialGradientBrush interface Pointer to an ID2D1RadialGradientBrush interface or NULL if object is not initialized yet. Returns ID2D1RadialGradientBrush interface Pointer to an ID2D1RadialGradientBrush interface or NULL if object is not initialized yet. Detaches resource interface from the object Pointer to detached resource interface. Attaches existing resource interface to the object Existing resource interface. Cannot be NULL Destroys a CD2DRadialGradientBrush object. Creates a CD2DRadialGradientBrush. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. The destructor. Called when a D2D radial gradient brush object is being destroyed. Constructs a CD2DLinearGradientBrush object. A pointer to the render target. A pointer to an array of D2D1_GRADIENT_STOP structures. A value greater than or equal to 1 that specifies the number of gradient stops in the gradientStops array. The center, gradient origin offset, and x-radius and y-radius of the brush's gradient. The space in which color interpolation between the gradient stops is performed. The behavior of the gradient outside the [0,1] normalized range. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget). ID2D1RadialGradientBrush wrapper. A pointer to an ID2D1LinearGradientBrush. The start and end points of the gradient. Retrieves the ending coordinates of the linear gradient The ending two-dimensional coordinates of the linear gradient, in the brush's coordinate space Retrieves the starting coordinates of the linear gradient The starting two-dimensional coordinates of the linear gradient, in the brush's coordinate space Sets the ending coordinates of the linear gradient in the brush's coordinate space The ending two-dimensional coordinates of the linear gradient, in the brush's coordinate space Sets the starting coordinates of the linear gradient in the brush's coordinate space The starting two-dimensional coordinates of the linear gradient, in the brush's coordinate space Returns ID2D1LinearGradientBrush interface Pointer to an ID2D1LinearGradientBrush interface or NULL if object is not initialized yet. Returns ID2D1LinearGradientBrush interface Pointer to an ID2D1LinearGradientBrush interface or NULL if object is not initialized yet. Detaches resource interface from the object Pointer to detached resource interface. Attaches existing resource interface to the object Existing resource interface. Cannot be NULL Destroys a CD2DLinearGradientBrush object. Creates a CD2DLinearGradientBrush. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. The destructor. Called when a D2D linear gradient brush object is being destroyed. Constructs a CD2DLinearGradientBrush object. A pointer to the render target. A pointer to an array of D2D1_GRADIENT_STOP structures. A value greater than or equal to 1 that specifies the number of gradient stops in the gradientStops array. The start and end points of the gradient. The space in which color interpolation between the gradient stops is performed. The behavior of the gradient outside the [0,1] normalized range. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget). ID2D1LinearGradientBrush wrapper. A pointer to an array of D2D1_GRADIENT_STOP structures. The behavior of the gradient outside the [0,1] normalized range. The space in which color interpolation between the gradient stops is performed. Array of the D2D1_GRADIENT_STOP structures. Destroys a CD2DGradientBrush object. The destructor. Called when a D2D gradient brush object is being destroyed. Constructs a CD2DGradientBrush object. A pointer to the render target. A pointer to an array of D2D1_GRADIENT_STOP structures. A value greater than or equal to 1 that specifies the number of gradient stops in the gradientStops array. The space in which color interpolation between the gradient stops is performed. The behavior of the gradient outside the [0,1] normalized range. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget). The base class of CD2DLinearGradientBrush and CD2DRadialGradientBrush classes. Bitmap brush properties. Stores a pointer to an ID2D1BitmapBrush object. Stores a pointer to a CD2DBitmap object. Initializes the object A pointer to the bitmap brush properties. Destroys a CD2DBitmapBrush object. Creates a CD2DBitmapBrush. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. Gets the interpolation method used when the brush bitmap is scaled or rotated The interpolation method used when the brush bitmap is scaled or rotated Gets the method by which the brush vertically tiles those areas that extend past its bitmap A value that specifies how the brush vertically tiles those areas that extend past its bitmap Gets the method by which the brush horizontally tiles those areas that extend past its bitmap A value that specifies how the brush horizontally tiles those areas that extend past its bitmap Specifies the bitmap source that this brush uses to paint The bitmap source used by the brush Specifies the interpolation mode used when the brush bitmap is scaled or rotated The interpolation mode used when the brush bitmap is scaled or rotated Specifies how the brush vertically tiles those areas that extend past its bitmap A value that specifies how the brush vertically tiles those areas that extend past its bitmap Specifies how the brush horizontally tiles those areas that extend past its bitmap A value that specifies how the brush horizontally tiles those areas that extend past its bitmap Gets the bitmap source that this brush uses to paint Pointer to an CD2DBitmap object or NULL if object is not initialized yet. Returns ID2D1BitmapBrush interface Pointer to an ID2D1BitmapBrush interface or NULL if object is not initialized yet. Returns ID2D1BitmapBrush interface Pointer to an ID2D1BitmapBrush interface or NULL if object is not initialized yet. Detaches resource interface from the object Pointer to detached resource interface. Attaches existing resource interface to the object Existing resource interface. Cannot be NULL The destructor. Called when a D2D bitmap brush object is being destroyed. Constructs a CD2DBitmapBrush object from file. A pointer to the render target. Pointer to a null-terminated string that contains the name of file. Destination size of the bitmap. A pointer to the extend modes and the interpolation mode of a bitmap brush. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget). Constructs a CD2DBitmapBrush object from resource. A pointer to the render target. The resource ID number of the resource. Pointer to a null-terminated string that contains the resource type. Destination size of the bitmap. A pointer to the extend modes and the interpolation mode of a bitmap brush. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget). Constructs a CD2DBitmapBrush object. A pointer to the render target. A pointer to the extend modes and the interpolation mode of a bitmap brush. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget). ID2D1BitmapBrush wrapper. Brush solid color. Stores a pointer to an ID2D1SolidColorBrush object. Destroys a CD2DSolidColorBrush object. Creates a CD2DSolidColorBrush. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. Retrieves the color of the solid color brush The color of this solid color brush Specifies the color of this solid color brush The color of this solid color brush Returns ID2D1SolidColorBrush interface Pointer to an ID2D1SolidColorBrush interface or NULL if object is not initialized yet. Returns ID2D1SolidColorBrush interface Pointer to an ID2D1SolidColorBrush interface or NULL if object is not initialized yet. Detaches resource interface from the object Pointer to detached resource interface. Attaches existing resource interface to the object Existing resource interface. Cannot be NULL The destructor. Called when a D2D solid brush object is being destroyed. Constructs a CD2DSolidColorBrush object. A pointer to the render target. The red, green, and blue values of the brush's color. The opacity of the brush's color. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget). Constructs a CD2DSolidColorBrush object. A pointer to the render target. The red, green, blue, and alpha values of the brush's color. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget). ID2D1SolidColorBrush wrapper. Brush properties. Stores a pointer to an ID2D1Brush object. Gets the current transform of the render target When this returns, contains the current transform of the render target. This parameter is passed uninitialized Applies the specified transform to the render target, replacing the existing transformation. All subsequent drawing operations occur in the transformed space The transform to apply to the render target Gets the degree of opacity of this brush A value between zero and 1 that indicates the opacity of the brush. This value is a constant multiplier that linearly scales the alpha value of all pixels filled by the brush. The opacity values are clamped in the range 0 to 1 before they are multiplied together Sets the degree of opacity of this brush A value between zero and 1 that indicates the opacity of the brush. This value is a constant multiplier that linearly scales the alpha value of all pixels filled by the brush. The opacity values are clamped in the range 0 to 1 before they are multiplied together Destroys a CD2DBrush object. Returns ID2D1Brush interface Pointer to an ID2D1Brush interface or NULL if object is not initialized yet. Returns ID2D1Brush interface Pointer to an ID2D1Brush interface or NULL if object is not initialized yet. Checks resource validity TRUE if resource is valid; otherwise FALSE. Detaches resource interface from the object Pointer to detached resource interface. Attaches existing resource interface to the object Existing resource interface. Cannot be NULL The destructor. Called when a D2D brush object is being destroyed. Constructs a CD2DBrush object. A pointer to the render target. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget). ID2D1Brush wrapper. Initializes the object Creates a CD2D_BRUSH_PROPERTIES structure The transformation to apply to the brush The base opacity of the brush. The default value is 1.0. Creates a CD2D_BRUSH_PROPERTIES structure The base opacity of the brush. The default value is 1.0. Creates a CD2D_BRUSH_PROPERTIES structure D2D1_BRUSH_PROPERTIES wrapper. TRUE if m_hBmpSrc should be destroyed; otherwise FALSE. Source bitmap handle. Bitmap destination size. Botmap file path. Resource type. Bitmap resource ID. Stores a pointer to an ID2D1Bitmap object. Destroys a CD2DBitmap object. Creates a CD2DBitmap. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. Initializes the object Returns ID2D1Bitmap interface Pointer to an ID2D1Bitmap interface or NULL if object is not initialized yet. Returns ID2D1Bitmap interface Pointer to an ID2D1Bitmap interface or NULL if object is not initialized yet. Checks resource validity TRUE if resource is valid; otherwise FALSE. Copies the specified region from memory into the current bitmap If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. The data to copy The stride, or pitch, of the source bitmap stored in srcData. The stride is the byte count of a scanline (one row of pixels in memory). The stride can be computed from the following formula: pixel width * bytes per pixel + memory padding In the current bitmap, the upper-left corner of the area to which the region specified by srcRect is copied Copies the specified region from the specified render target into the current bitmap If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. The render target that contains the region to copy In the current bitmap, the upper-left corner of the area to which the region specified by srcRect is copied The area of renderTarget to copy Copies the specified region from the specified bitmap into the current bitmap If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. The bitmap to copy from In the current bitmap, the upper-left corner of the area to which the region specified by srcRect is copied The area of bitmap to copy Return the dots per inch (DPI) of the bitmap The horizontal and vertical DPI of the bitmap. Retrieves the pixel format and alpha mode of the bitmap The pixel format and alpha mode of the bitmap. Returns the size, in device-dependent units (pixels), of the bitmap The size, in pixels, of the bitmap.. Returns the size, in device-independent pixels (DIPs), of the bitmap The size, in DIPs, of the bitmap. Detaches resource interface from the object Pointer to detached resource interface. Attaches existing resource interface to the object Existing resource interface. Cannot be NULL The destructor. Called when a D2D bitmap object is being destroyed. Constructs a CD2DBitmap object. A pointer to the render target. Indicates that the object will be destroyed by owner (pParentTarget). Constructs a CD2DBitmap object from HBITMAP. A pointer to the render target. Handle to the bitmap. Destination size of the bitmap. Indicates that the object will be destroyed by owner (pParentTarget). Constructs a CD2DBitmap object from file. A pointer to the render target. Pointer to a null-terminated string that contains the name of file. Destination size of the bitmap. Indicates that the object will be destroyed by owner (pParentTarget). Constructs a CD2DBitmap object from resource. A pointer to the render target. The resource ID number of the resource. Pointer to a null-terminated string that contains the resource type. Destination size of the bitmap. Indicates that the object will be destroyed by owner (pParentTarget). ID2D1Bitmap wrapper. Stores a pointer to an ID2D1Layer object. Destroys a CD2DLayer object. Creates a CD2DLayer. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. Detaches resource interface from the object Pointer to detached resource interface. Attaches existing resource interface to the object Existing resource interface. Cannot be NULL Returns ID2D1Layer interface Pointer to an ID2D1Layer interface or NULL if object is not initialized yet. Returns ID2D1Layer interface Pointer to an ID2D1Layer interface or NULL if object is not initialized yet. Checks resource validity TRUE if resource is valid; otherwise FALSE. Returns the size of the render target in device-independent pixels The current size of the render target in device-independent pixels The destructor. Called when a D2D layer object is being destroyed. Constructs a CD2DLayer object. A pointer to the render target. Indicates that the object will be destroyed by owner (pParentTarget). ID2D1Layer wrapper. Pointer to the parent CRenderTarget) Resource will be destoyed by owner (CRenderTarget) Checks resource validity TRUE if resource is valid; otherwise FALSE. Destroys a CD2DResource object. Creates a CD2DResource. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. Re-creates a CD2DResource. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target. Check auto destroy flag. TRUE if the object will be destroyed by its owner; otherwise FALSE. The destructor. Called when a D2D resource object is being destroyed. Constructs a CD2DResource object. A pointer to the render target. Indicates that the object will be destroyed by owner (pParentTarget). An abstract class, which provides a interface for creating and managing D2D resources such as brushes, layers and texts. Constructs a CD2DEllipse from CD2DPointF and CD2DSizeF objects. The center point of the ellipse. The X-radius and Y-radius of the ellipse. Constructs a CD2DEllipse object from D2D1_ELLIPSE object. source ellipse Constructs a CD2DEllipse object from D2D1_ELLIPSE object. source ellipse Constructs a CD2DEllipse object from CD2DRectF object. source rectangle D2D1_ELLIPSE wrapper Constructs a CD2DRoundedRect object from D2D1_ROUNDED_RECT object. source rectangle Constructs a CD2DRoundedRect object from D2D1_ROUNDED_RECT object. source rectangle Constructs a CD2DRoundedRect object from CD2DRectF object. source rectangle radius size D2D1_ROUNDED_RECT wrapper Converts CD2DRectU to CRect object. Current value of D2D rectangle. Returns a Boolean value that indicates whether an expression contains no valid data (Null). TRUE if rectangle's top, left, bottom, and right values are all equal to 0; otherwise FALSE. Constructs a CD2DRectU object from four UINT32 values. source left coordinate source top coordinate source right coordinate source bottom coordinate Constructs a CD2DRectU object from D2D1_RECT_U object. source rectangle Constructs a CD2DRectU object from D2D1_RECT_U object. source rectangle Constructs a CD2DRectU object from CRect object. source rectangle D2D1_RECT_U wrapper Converts CD2DRectF to CRect object. Current value of D2D rectangle. Returns a Boolean value that indicates whether an expression contains no valid data (Null). TRUE if rectangle's top, left, bottom, and right values are all equal to 0; otherwise FALSE. Constructs a CD2DRectF object from four FLOAT values. source left coordinate source top coordinate source right coordinate source bottom coordinate Constructs a CD2DRectF object from D2D1_RECT_F object. source rectangle Constructs a CD2DRectF object from D2D1_RECT_F object. source rectangle Constructs a CD2DRectF object from CRect object. source rectangle D2D1_RECT_F wrapper Converts CD2DSizeU to CSize object. Current value of D2D size. Returns a Boolean value that indicates whether an expression contains no valid data (Null). TRUE if width and height are empty; otherwise FALSE. Constructs a CD2DSizeU object from two UINT32 values. source width source height Constructs a CD2DSizeU object from D2D1_SIZE_U object. source size Constructs a CD2DSizeU object from D2D1_SIZE_U object. source size Constructs a CD2DSizeU object from CSize object. source size D2D1_SIZE_U wrapper Converts CD2DSizeF to CSize object. Current value of D2D size. Returns a Boolean value that indicates whether an expression contains no valid data (Null). TRUE if width and height are empty; otherwise FALSE. Constructs a CD2DSizeF object from two FLOAT values. source width source height Constructs a CD2DSizeF object from D2D1_SIZE_F object. source size Constructs a CD2DSizeF object from D2D1_SIZE_F object. source size Constructs a CD2DSizeF object from CSize object. source size D2D1_SIZE_F wrapper Converts CD2DPointU to CPoint object. Current value of D2D point. Constructs a CD2DPointU object from two UINT32 values. source X source Y Constructs a CD2DPointU from object D2D1_POINT_2U object. source point Constructs a CD2DPointU from object D2D1_POINT_2U object. source point Constructs a CD2DPointU object from CPoint object. source point D2D1_POINT_2U wrapper Converts CD2DPointF to CPoint object. Current value of D2D point. Constructs a CD2DPointF object from two FLOAT values. source X source Y Constructs a CD2DPointF object from D2D1_POINT_2F object. source point Constructs a CD2DPointF object from D2D1_POINT_2F object. source point Constructs a CD2DPointF object from CPoint object. source point D2D1_POINT_2F wrapper Calls the transition library to create encapsulated transition COM object. This method also can set initial value and initial velocity to be applied to an animation variable, which is associated with this transition. For this purpose you have to call SetInitialValue and SetInitialVelocity before the framework creates the encapsulated transition COM object (it happens when you call CAnimationController::AnimateGroup). A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions. Sets an initial velocity, which will be applied to an animation variable associated with this transition. Sets an initial value, which will be applied to an animation variable associated with this transition. Constructs a custom transition object. A pointer to custom interpolator. Stores the initial velocity. Stores the initial value. Specifies whether the initial velocity was specified with SetInitialVelocity. Specifies whether the initial value was specified with SetInitialValue. Stores a pointer to a custom interpolator. Implements custom transition. The CCustomTransitions class allows developers to implement custom transitions. It's created and used as a standard transition, but its constructor accepts as parameter a pointer to a custom interpolator. Perform the following steps to use custom transitions: 1. Derive a class from CCustomInterpolator and implement at least InterpolateValue method. 2. Ensure that the lifetime of custom interpolator object must be longer than duration of animation where it's used. 3. Instantiate (using operator new) a CCustomTransition object and pass a pointer to custom interpolator in the constructor. 4. Call CCustomTransition::SetInitialValue and CCustomTransition::SetInitialVelocity if these parameters are required for custom interpolation. 5. Pass the pointer to custom transition to AddTransition method of animation object, whose value should be animated with the custom algorithm. 6. When the value of animation object should change Windows Animation API will call InterpolateValue (and other relevant methods) in CCustomInterpolator. Gets the interpolator's dependencies. If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the GetDependencies method. Output. Aspects of the interpolator that depend on the initial value passed to SetInitialValueAndVelocity. Output. Aspects of the interpolator that depend on the initial velocity passed to SetInitialValueAndVelocity. Output. Aspects of the interpolator that depend on the duration passed to SetDuration. Interpolates the velocity at a given offset If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the InterpolateVelocity method. The offset from the start of the transition. The offset is always greater than or equal to zero and less than or equal to the duration of the transition. This method is not called if the duration of the transition is zero. Output. The velocity of the variable at the offset. Interpolates the value at a given offset If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the InterpolateValue method. The offset from the start of the transition. The offset is always greater than or equal to zero and less than the duration of the transition. This method is not called if the duration of the transition is zero. Output. The interpolated value. Gets the final value to which the interpolator leads. If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the GetFinalValue method. Output. The final value of a variable at the end of the transition. Gets the interpolator's duration. If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the GetDuration method. Output. The duration of the transition, in seconds. Sets the interpolator's duration If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the SetDuration method. The duration of the transition. Sets the interpolator's initial value and velocity. If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the SetInitialValueAndVelocity method. The value of the variable at the start of the transition. The velocity of the variable at the start of the transition. Creates an instance of CInterpolatorBase and stores a pointer to custom interpolator, which will be handling events. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to custom interpolator.Output. Contains a pointer to instance of CInterpolatorBase when the function returns. Stores a pointer to custom interpolator, which will be handling events. A pointer to custom interpolator. Constructs the CInterpolatorBase object. Implements a callback, which is called by Animation API when it needs to calculate a new value of animation variable. This handler is created and passed to IUIAnimationTransitionFactory::CreateTransition when a CCustomTransition object is being created as a part of animation initialization process (started by CAnimationController::AnimateGroup). Usually you don't need to use this class directly, it just routs all events to a CCustomInterpolator-derived class, whose pointer is passed to constructor of CCustomTransition. Gets the interpolator's dependencies. Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. Output. Aspects of the interpolator that depend on the initial value passed to SetInitialValueAndVelocity. Output. Aspects of the interpolator that depend on the initial velocity passed to SetInitialValueAndVelocity. Output. Aspects of the interpolator that depend on the duration passed to SetDuration. Interpolates the velocity at a given offset Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. The offset from the start of the transition. The offset is always greater than or equal to zero and less than or equal to the duration of the transition. This method is not called if the duration of the transition is zero. Output. The velocity of the variable at the offset. Interpolates the value at a given offset. Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. The offset from the start of the transition. The offset is always greater than or equal to zero and less than the duration of the transition. This method is not called if the duration of the transition is zero. Output. The interpolated value. Gets the final value to which the interpolator leads. Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. Output. The final value of a variable at the end of the transition. Gets the interpolator's duration. Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. Output. The duration of the transition, in seconds. Sets the interpolator's duration. Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. The duration of the transition. Sets the interpolator's initial value and velocity. The basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. The value of the variable at the start of the transition. The velocity of the variable at the start of the transition. Initializes duration and final value. The duration of the transition. The final value of a variable at the end of the transition. Constructs a custom interpolator object and initializes duration and velocity to specified values. The duration of the transition. Constructs a custom interpolator object and sets all values to default 0. Use CCustomInterpolator::Init to initialize duration and final value later in the code. The interpolated velocity. The interpolated value. The velocity of the variable at the start of the transition. The value of the variable at the start of the transition. The final value of a variable at the end of the transition. The duration of the transition. Implements a basic interpolator. Derive a class from CCustomInterpolator and override all necessary methods in order to implement a custom interpolation algorithm. A pointer to this class should be passed as a parameter to CCustomTransition. Calls the transition library to create encapsulated transition COM object. TRUE if transition is created successfully; otherwise FALSE. A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions. The period of oscillation of the sinusoidal wave in seconds. The duration of the transition. Constructs a transition object. The duration of the transition. The period of oscillation of the sinusoidal wave in seconds. Encapsulates a sinusoidal-velocity transition, with an amplitude determined by the animation variable's initial velocity.. The value of the animation variable oscillates around the initial value over the entire duration of a sinusoidal-range transition. The amplitude of the oscillation is determined by the animation variable's velocity when the transition begins. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect. Calls the transition library to create encapsulated transition COM object. TRUE if transition is created successfully; otherwise FALSE. A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions. The slope at the start of the transition. The period of oscillation of the sinusoidal wave in seconds. The value of the animation variable at a peak of the sinusoidal wave. The value of the animation variable at a trough of the sinusoidal wave. The duration of the transition. Constructs a transition object. The duration of the transition. The value of the animation variable at a trough of the sinusoidal wave. The value of the animation variable at a peak of the sinusoidal wave. The period of oscillation of the sinusoidal wave in seconds. The slope at the start of the transition. Encapsulates a sinusoidal-range transition, with a given range of oscillation. The value of the animation variable fluctuates between the specified minimum and maximum values over the entire duration of a sinusoidal-range transition. The slope parameter is used to disambiguate between the two possible sine waves specified by the other parameters. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect. Calls the transition library to create encapsulated transition COM object. TRUE if transition is created successfully; otherwise FALSE. A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions. The duration of the transition. Constructs a reversal transition object and initializes its duration. The duration of the transition. Encapsulates a reversal transition. A reversal transition smoothly changes direction over a given duration. The final value will be the same as the initial value and the final velocity will be the negative of the initial velocity. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect. Calls the transition library to create encapsulated transition COM object. TRUE if transition is created successfully; otherwise FALSE. A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions. The acceleration of the animation variable during the transition. The velocity of the animation variable at the end of the transition. The value of the animation variable at the end of the transition. Constructs a parabolic-acceleration transition and initializes it with specified parameters. The value of the animation variable at the end of the transition. The velocity of the animation variable at the end of the transition. The acceleration of the animation variable during the transition. Encapsulates a parabolic-acceleration transition. During a parabolic-acceleration transition, the value of the animation variable changes from the initial value to the final value ending at a specified velocity. You can control how quickly the variable reaches the final value by specifying the rate of acceleration. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect. Calls the transition library to create encapsulated transition COM object. TRUE if transition is created successfully; otherwise FALSE. A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions. The value of the animation variable at the end of the transition. The maximum duration of the transition. Constructs a smooth-stop transition and initializes its maximum duration and final value. The maximum duration of the transition. The value of the animation variable at the end of the transition. Encapsulates a smooth-stop transition. A smooth-stop transition slows down as it approaches a given final value, and reaches it with a velocity of zero. The duration of the transition is determined by the initial velocity, the difference between the initial and final values, and the specified maximum duration. If there is no solution consisting of a single parabolic arc, this method creates a cubic transition. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect. Calls the transition library to create encapsulated transition COM object. TRUE if transition is created successfully; otherwise FALSE. A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions. The value of the animation variable at the end of the transition. The absolute value of the variable's velocity. Constructs a linear-speed transition object and initializes it with speed and final value. The absolute value of the variable's velocity. The value of the animation variable at the end of the transition. Encapsulates a linear-speed transition. During a linear-speed transition, the value of the animation variable changes at a specified rate. The duration of the transition is determined by the difference between the initial value and the specified final value. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect. Calls the transition library to create encapsulated transition COM object. TRUE if transition is created successfully; otherwise FALSE. A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions. The value of the animation variable at the end of the transition. The duration of the transition. Constructs a linear transition object and initializes it with duration and final value. The duration of the transition. The value of the animation variable at the end of the transition. Encapsulates a linear transition. During a linear transition, the value of the animation variable transitions linearly from its initial value to a specified final value. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect. Calls the transition library to create encapsulated transition COM object. TRUE if transition is created successfully; otherwise FALSE. A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions. The value of the animation variable at the end of the transition. Constructs a transition object and initializes its final value. The value of the animation variable at the end of the transition. Encapsulates an instantaneous transition. During an instantaneous transition, the value of the animation variable changes instantly from its current value to a specified final value. The duration of this transition is always zero. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect. Calls the transition library to create encapsulated transition COM object. TRUE if transition is created successfully; otherwise FALSE. A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions. The amount of time by which to hold the variable at its final value. The value of the animation variable at the end of the transition. The amount of time by which to delay the instantaneous switch to the final value. Constructs a discrete transition object and initializes its parameters. The amount of time by which to delay the instantaneous switch to the final value. The value of the animation variable at the end of the transition. The amount of time by which to hold the variable at its final value. Encapsulates a discrete transition. During a discrete transition, the animation variable remains at the initial value for a specified delay time, then switches instantaneously to a specified final value and remains at that value for a given hold time. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect. Calls the transition library to create encapsulated transition COM object. TRUE if transition is created successfully; otherwise FALSE. A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions. The velocity of the variable at the end of the transition. The value of the animation variable at the end of the transition. The duration of the transition. Constructs a transition object and initializes its parameters. The duration of the transition. The value of the animation variable at the end of the transition. The velocity of the variable at the end of the transition. Encapsulates a cubic transition. During a cubic transition, the value of the animation variable changes from its initial value to a specified final value over the duration of the transition, ending at a specified velocity. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect. Calls the transition library to create encapsulated transition COM object. TRUE if transition is created successfully; otherwise FALSE. A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions. The duration of the transition. Constructs a transition object and initializes its duration. The duration of the transition. Encapsulates a constant transition. During a constant transition, the value of an animation variable remains at the initial value over the duration of the transition. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect. Calls the transition library to create encapsulated transition COM object. TRUE if transition is created successfully; otherwise FALSE. A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions. The ratio of the time spent decelerating to the duration. The ratio of the time spent accelerating to the duration. The value of the animation variable at the end of the transition. The duration of the transition. Constructs a transition object. The duration of the transition. The value of the animation variable at the end of the transition. The ratio of the time spent accelerating to the duration. The ratio of the time spent decelerating to the duration. Implements an accelerate-decelerate transition. During an accelerate-decelerate transition, the animation variable speeds up and then slows down over the duration of the transition, ending at a specified value. You can control how quickly the variable accelerates and decelerates independently, by specifying different acceleration and deceleration ratios. When the initial velocity is zero, the acceleration ratio is the fraction of the duration that the variable will spend accelerating; likewise with the deceleration ratio. If the initial velocity is non-zero, it is the fraction of the time between the velocity reaching zero and the end of transition. The acceleration ratio and the deceleration ratio should sum to a maximum of 1.0. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect. Handles events that occur when the rendering frame rate for an animation falls below the minimum desirable frame rate. S_OK if the method succeeds; otherwise E_FAIL. Handles events that occur after an animation update is finished. S_OK if the method succeeds; otherwise E_FAIL. Handles events that occur before an animation update begins. S_OK if the method succeeds; otherwise E_FAIL. Stores a pointer to animation controller to route events. A pointer to animation controller, which will receive events. Creates an instance of CAnimationTimerEventHandler callback. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to animation controller, which will receive events. Output. If the method succeeds it contains a pointer to COM object that will handle animation timer events. Implements a call back, which is called by Animation API when timing events occur. This event handler is created and passed to IUIAnimationTimer::SetTimerEventHandler when you call CAnimationController::EnableAnimationTimerEventHandler. Handles OnStoryboardUpdated events, which occur when a storyboard is updated S_OK if the method succeeds; otherwise E_FAIL. A pointer to storyboard, which was updated. Handles OnStoryboardStatusChanged events, which occur when a storyboard's status changes S_OK if the method succeeds; otherwise E_FAIL. A pointer to storyboard whose status has changed. Specifies new storyboard status. Specifies previous storyboard status. Stores a pointer to animation controller to route events. A pointer to animation controller, which will receive events. Creates an instance of CAnimationStoryboardEventHandler callback. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to animation controller, which will receive events. Output. If the method succeeds it contains a pointer to COM object that will handle storyboard events. Constructs a CAnimationStoryboardEventHandler object. Implements a callback, which is called by Animation API when storyboard's status is changed or storyboard is updated. This event handler is created and passed to IUIAnimationStoryboard::SetStoryboardEventHandler method, when you call CAnimationController::EnableStoryboardEventHandler. Called when a value of an animation variable has changed. S_OK if the method succeeds; otherwise E_FAIL. The storyboard that is animating the variable. The animation variable that was updated. The new rounded value. The previous rounded value. Stores a pointer to animation controller to route events. A pointer to animation controller, which will receive events. Creates an instance of CAnimationVariableIntegerChangeHandler callback. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to animation controller, which will receive events. Output. If the method succeeds it contains a pointer to COM object that will handle variable integer change events. Constructs a CAnimationVariableIntegerChangeHandler object. Implements a call back, which is called by Animation API when the value of an animation variable changes. This event handler is created and passed to IUIAnimationVariable::SetVariableIntegerChangeHandler method, when you call CAnimationVariable::EnableIntegerValueChangedEvent or CAnimationBaseObject::EnableIntegerValueChangedEvent (which enables this event for all animation variables encapsulated in an animation object). Called when a value of an animation variable has changed. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. The storyboard that is animating the variable. The animation variable that was updated. The new value. The previous value. Stores a pointer to animation controller to route events. A pointer to animation controller, which will receive events. Creates an instance of CAnimationVariableChangeHandler object. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to animation controller, which will receive events. Output. If the method succeeds it contains a pointer to COM object that will handle variable change events. Constructs a CAnimationVariableChangeHandler object. Implements a call back, which is called by Animation API when the value of an animation variable changes. This event handler is created and passed to IUIAnimationVariable::SetVariableChangeHandler method, when you call CAnimationVariable::EnableValueChangedEvent or CAnimationBaseObject::EnableValueChangedEvent (which enables this event for all animation variables encapsulated in an animation object). Called when a status of animation manager has changed. Current implementation always returns S_OK; New status. Previous status. Stores a pointer to animation controller to route events. A pointer to animation controller, which will receive events. Creates an instance of CAnimationManagerEventHandler object. If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to animation controller, which will receive events. Output. If the method succeeds it contains a pointer to COM object that will handle status updates to an animation manager. Constructs a CAnimationManagerEventHandler object. Implements a callback, which is called by Animation API when a status of animation manager changed. This event handler is created and passed to IUIAnimationManager::SetManagerEventHandler method, when you call CAnimationController::EnableAnimationManagerEvent. A helper that cleans up the group. This method removes all transitions and keyframes from the specified group. A pointer to animation group to clean. Called by the framework when an animation for the specified group has just been scheduled. The default implementation removes keyframes from the specified group and transitions from animation variables that belong to the specified group. Can be overridden in a derived class to take any additional actions upon animation schedule. A pointer to an animation group, which has been scheduled. Called by the framework when the rendering frame rate for an animation falls below a minimum desirable frame rate. This method is called if you enable timer event handlers using EnableAnimationTimerEventHandler. It can be overridden in a derived class to take application-specific actions. The minimum desirable frame rate is specified by calling IUIAnimationTimer::SetFrameRateThreshold. The current frame rate in frames per second. Called by the framework after an animation update is finished. This method is called if you enable timer event handlers using EnableAnimationTimerEventHandler. It can be overridden in a derived class to take application-specific actions. Called by the framework before an animation update begins. This method is called if you enable timer event handlers using EnableAnimationTimerEventHandler. It can be overridden in a derived class to take application-specific actions. Called by the framework to resolve scheduling conflicts. Should return TRUE if storyboard owned by pGroupNew has priority. Should return FALSE if storyboard owned by pGroupScheduled has priority. This method is called if you enable priority comparison events using CAnimationController::EnablePriorityComparisonHandler and specify UI_ANIMATION_PHT_COMPRESS. It can be overridden in a derived class to take application-specific actions. Read Windows Animation API documentation for more information about Conflict Management (http://msdn.microsoft.com/en-us/library/dd371759(VS.85).aspx). The group that owns the currently scheduled storyboard. The group that owns the new storyboard that is in scheduling conflict with the scheduled storyboard owned by pGroupScheduled. The potential effect on pGroupNew if pGroupScheduled has a higher priority. Called by the framework to resolve scheduling conflicts. Should return TRUE if storyboard owned by pGroupNew has priority. Should return FALSE if storyboard owned by pGroupScheduled has priority. This method is called if you enable priority comparison events using CAnimationController::EnablePriorityComparisonHandler and specify UI_ANIMATION_PHT_TRIM. It can be overridden in a derived class to take application-specific actions. Read Windows Animation API documentation for more information about Conflict Management (http://msdn.microsoft.com/en-us/library/dd371759(VS.85).aspx). The group that owns the currently scheduled storyboard. The group that owns the new storyboard that is in scheduling conflict with the scheduled storyboard owned by pGroupScheduled. The potential effect on pGroupNew if pGroupScheduled has a higher priority. Called by the framework to resolve scheduling conflicts. Should return TRUE if storyboard owned by pGroupNew has priority. Should return FALSE if storyboard owned by pGroupScheduled has priority. This method is called if you enable priority comparison events using CAnimationController::EnablePriorityComparisonHandler and specify UI_ANIMATION_PHT_CONCLUDE. It can be overridden in a derived class to take application-specific actions. Read Windows Animation API documentation for more information about Conflict Management (http://msdn.microsoft.com/en-us/library/dd371759(VS.85).aspx). The group that owns the currently scheduled storyboard. The group that owns the new storyboard that is in scheduling conflict with the scheduled storyboard owned by pGroupScheduled. The potential effect on pGroupNew if pGroupScheduled has a higher priority. Called by the framework to resolve scheduling conflicts. Should return TRUE if storyboard owned by pGroupNew has priority. Should return FALSE if storyboard owned by pGroupScheduled has priority. This method is called if you enable priority comparison events using CAnimationController::EnablePriorityComparisonHandler and specify UI_ANIMATION_PHT_CANCEL. It can be overridden in a derived class to take application-specific actions. Read Windows Animation API documentation for more information about Conflict Management (http://msdn.microsoft.com/en-us/library/dd371759(VS.85).aspx). The group that owns the currently scheduled storyboard. The group that owns the new storyboard that is in scheduling conflict with the scheduled storyboard owned by pGroupScheduled. The potential effect on pGroupNew if pGroupScheduled has a higher priority. Called by the framework when storyboard has been updated. This method is called if you enable storyboard events using CAnimationController::EnableStoryboardEventHandler. It can be overridden in a derived class to take application-specific actions. A pointer to a group that owns the storyboard. Called by the framework when storyboard status has changed. This method is called if you enable storyboard events using CAnimationController::EnableStoryboardEventHandler. It can be overridden in a derived class to take application-specific actions. A pointer to an animation group that owns the storyboard whose status has changed. Specifies the new status. Specifies the previous status. Called by the framework when integer value of animation variable has changed. This method is called if you enable animation variable events with EnableIntegerValueChangedEvent called for a specific animation variable or animation object. It can be overridden in a derived class to take application-specific actions. A pointer to an animation group that holds an animation object whose value has changed. A pointer to an animation object that contains an animation variable whose value has changed. A pointer to an animation variable. Specifies new value. Specifies previous value. Called by the framework when value of animation variable has changed. This method is called if you enable animation variable events with EnableValueChangedEvent called for a specific animation variable or animation object. It can be overridden in a derived class to take application-specific actions. A pointer to an animation group that holds an animation object whose value has changed. A pointer to an animation object that contains an animation variable whose value has changed. A pointer to an animation variable. Specifies new value. Specifies previous value. Called by the framework in response to StatusChanged event from animation manager. This method is called if you enable animation manager events with EnableAnimationManagerEvent. It can be overridden in a derived class to take application-specific actions. The default implementation updates a related window if it has been set with SetRelatedWnd. New animation manager status. Previous animation manager status. Called by the framework right before the animation is scheduled. This call is routed to related CWnd and can be overridden in a derived class to perform any additional actions before the animation starts for the specified group. A pointer to an animation group whose animation is about to start. Called by the framework to clean up the group when animation has been scheduled. This method removes all transitions and keyframes from the specified group, because they are not relevant after an animation has been scheduled. Specifies GroupID. Schedules an animation. TRUE if animation was scheduled successfully. FALSE if storyboard has not been created, or other error occurs. You must call AnimateGroup with parameter bScheduleNow set to FALSE prior ScheduleGroup. You can specify the desired animation time obtained from IUIAnimationTimer::GetTime. If the time parameter is 0.0, the animation is scheduled for the current time. Specifies animation Group ID to schedule. Specifies time to schedule. Prepares a group to run animation and optionally schedules it. TRUE if animation was successfully scheduled and run. This method does the actual work creating storyboard, adding animation variables, applying transitions and setting keyframes. It's possible to delay scheduling if you set bScheduleNow to FALSE. In this case the specified group will hold a storyboard that has been set up for animation. At that point you can setup events for the storyboard and animation variables. When you actually need to run the animation call CAnimationController::ScheduleGroup. Specifies GroupID. Specifies whether to run animation right away. Finds animation object containing a specified animation variable. TRUE if object was found; otherwise FALSE. Called from event handlers when it's required to find an animation object from incoming animation variable. A pointer to animation variable. Output. Contains a pointer to animation object or NULL. Output. Contains a pointer to animation group that holds the animation object, or NULL. Finds an animation group by its storyboard. A pointer to animation group if succeeds, or NULL if no group plays the specified storyboard. This method is usually called from event handlers to find a group by pointer to storyboard that comes as a parameter to an event handler. A pointer to a storyboard. Finds an animation group by its Group ID. A pointer to animation group or NULL if the group with specified ID is not found. Use this method to find an animation group at runtime. A group is created and added to the internal list of animation groups when a first animation object with particular GroupID is being added to animation controller. Specifies a GroupID. Adds a keyframe to group. TRUE if the function succeeds; otherwise FALSE. Usually you don't need to call this method, use CAnimationController::CreateKeyframe instead, which creates and adds the created keyframe to a group automatically. Specifies Group ID. A pointer to a keyframe. Creates a keyframe that depends on other keyframe with optional offset in seconds and adds it to the specified group. A pointer to newly created keyframe if the function succeeds. You can store the returned pointer and base other keyframes on the newly created keyframe (see the second overload). It's possible to begin transitions at keyframes - see CBaseTransition::SetKeyframes. You don't need to delete keyframes created in this way, because they are deleted automatically by animation groups. Be careful when creating keyframes based on other keyframes and transitions and avoid circular references. Specifies Group ID for which keyframe is created. A pointer to base keyframe for this keyframe. Offset in seconds from the base keyframe specified by pKeyframe. Creates a keyframe that depends on transition and adds it to the specified group. A pointer to newly created keyframe if the function succeeds. You can store the returned pointer and base other keyframes on the newly created keyframe (see the second overload). It's possible to begin transitions at keyframes - see CBaseTransition::SetKeyframes. You don't need to delete keyframes created in this way, because they are deleted automatically by animation groups. Be careful when creating keyframes based on other keyframes and transitions and avoid circular references. Specifies Group ID for which keyframe is created. A pointer to transition. Keyframe will be inserted to storyboard after this transition. Removes transitions from animation objects that belong to the specified group. The group loops over its animation objects and calls ClearTransitions(FALSE) for each animation object. This method is called by the framework after animation has been scheduled. Specifies Group ID. Removes all animation groups from animation controller. All groups will be deleted, their pointer, if stored at the application level, must be invalidated. If CAnimationGroup::m_bAutodestroyAnimationObjects for a group being deleted is TRUE, all animation objects that belong to that group will be deleted; otherwise their references to parent animation controller will be set to NULL and they can be added to another controller. Removes an animation group with specified ID from animation controller. This method removes an animation group from the internal list of groups and deletes it, therefore if you stored a pointer to that animation group, it must be invalidated. If CAnimationGroup::m_bAutodestroyAnimationObjects is TRUE, all animation objects that belong to that group will be deleted; otherwise their references to parent animation controller will be set to NULL and they can be added to another controller. Specifies animation group ID. Remove an animation object from animation controller. Removes an animation object from animation controller and animation group. Call this function if a particular object should not be animated anymore, or if you need to move the object to another animation controller. In the last case bNoDelete must be TRUE. A pointer to an animation object. If this parameter is TRUE the object will not be deleted upon remove. Adds an animation object to a group that belongs to the animation controller. A pointer to existing or new animation group where pObject has been added if function succeeds; NULL if pObject has already been added to a group that belongs to another animation controller. Call this method to add an animation object to the animation controller. An object will be added to a group according to object's GroupID (see CAnimationBaseObject::SetID). The animation controller will create a new group if it's the first object being added with the specified GroupID. An animation object can be added to one animation controller only. If you need to add an object to another controller, call RemoveAnimationObject first. If you call SetID with new GroupID for an object that has been already added to a group, the object will be removed from the old group and added to another group with specified ID. A pointer to an animation object. Establishes a relationship between animation controller and a window. If a related CWnd object is set, the animation controller can automatically update it (send WM_PAINT message) when the status of animation manager has changed or timer post update event has occurred. A pointer to window object to set. Tells whether at least one group is playing animation. TRUE if there is an animation in progress for this animation controller; otherwise FALSE. Checks status of animation manager and returns TRUE if the status is UI_ANIMATION_MANAGER_BUSY. Directs the animation manager to update the values of all animation variables. Calling this method advances the animation manager to current time, changing statuses of storyboards as necessary and updating any animation variables to appropriate interpolated values. Internally this method calls IUIAnimationTimer::GetTime(timeNow) and IUIAnimationManager::Update(timeNow). Override this method in a derived class to customize this behavior. Sets or releases a handler for timing events and handler for timing updates. TRUE if handlers were successfully set or released; FALSE if this method is called for a second time without releasing the handlers first, or if any other error occurs. When the handlers are set (enabled) Windows Animation API calls OnAnimationTimerPreUpdate, OnAnimationTimerPostUpdate, OnRenderingTooSlow methods. You need to enable animation timers to allow Windows Animation API update storyboards. Otherwise you'll need to call CAnimationController::UpdateAnimationManager in order to direct the animation manager to update the values of all animation variables. Specifies whether to set or release the handlers. Specifies idle behavior for timer update handler. Sets or releases a handler for storyboard status and update events. TRUE if the handler was successfully set or released; FALSE if the specified animation group is now found or animation for the specified group has not been initiated and its internal storyboard is NULL. When a handler is set (enabled) Windows Animation API calls OnStoryboardStatusChanges and OnStoryboardUpdated virtual methods. A handler must be set after CAnimationController::Animate has been called for the specified animation group, because it creates encapsulated IUIAnimationStoryboard object. Specifies Group ID. Specifies whether to set or release a handler. Sets or releases the priority comparison handler to call to determine whether a scheduled storyboard can be cancelled, concluded, trimmed or compressed. TRUE if the handler was successfully set or released. When a handler is set (enabled) Windows Animation calls the following virtual methods depending on dwHandlerType: OnHasPriorityCancel, OnHasPriorityConclude, OnHasPriorityTrim, OnHasPriorityCompress. dwHandler can be a combination of the following flags: UI_ANIMATION_PHT_NONE - release all handlers UI_ANIMATION_PHT_CANCEL - set Cancel comparison handler UI_ANIMATION_PHT_CONCLUDE - set Conclude comparison handler UI_ANIMATION_PHT_COMPRESS - set Compress comparison handler UI_ANIMATION_PHT_TRIM - set Trim comparison handler UI_ANIMATION_PHT_CANCEL_REMOVE - remove Cancel comparison handler UI_ANIMATION_PHT_CONCLUDE_REMOVE - remove Conclude comparison handler UI_ANIMATION_PHT_COMPRESS_REMOVE - remove Compress comparison handler UI_ANIMATION_PHT_TRIM_REMOVE - remove Trim comparison handler A combination of UI_ANIMATION_PHT_ flags (see remarks), which specifies what handlers to set or release. Sets or releases a handler to call when animation manager's status changes. TRUE if the handler was successfully set or released. When a handler is set (enabled) Windows Animation calls OnAnimationManagerStatusChanged when animation manager's status changes. Specifies whether to set or release a handler. Returns a keyframe that identifies start of storyboard. A pointer to base keyframe, which identifies start of storyboard. Obtain this keyframe to base any other keyframes or transitions on the moment in time when a storyboard starts. Tells whether animation controller is valid. TRUE if animation controller is valid; otherwise FALSE. This method returns FALSE only if Windows Animation API is not supported on the current OS and creation of animation manager failed because it's not registered. You need to call GetUIAnimationManager at least once after initialization of COM libraries to cause setting of this flag. A pointer to IUIAnimationTransitionFactory interface or NULL, if creation of transition library failed. A pointer to IUIAnimationTransitionFactory or NULL, if creation of transition factory failed. If current OS does not support Windows Animation API, this method returns NULL and after that all subsequent calls on CAnimationController::IsValid return FALSE. Provides access to encapsulated IUIAnimationTimer object. A pointer to IUIAnimationTimer interface or NULL, if creation of animation timer failed. If current OS does not support Windows Animation API, this method returns NULL and after that all subsequent calls on CAnimationController::IsValid return FALSE. Provides access to encapsulated IUIAnimationTransitionLibrary object. A pointer to IUIAnimationTransitionLibrary interface or NULL, if creation of transition library failed. If current OS does not support Windows Animation API, this method returns NULL and after that all subsequent calls on CAnimationController::IsValid return FALSE. Provides access to encapsulated IUIAnimationManager object. A pointer to IUIAnimationManager interface or NULL, if creation of animation manager failed. If current OS does not support Windows Animation API, this method returns NULL and after that all subsequent calls on CAnimationController::IsValid return FALSE. You may need to access IUIAnimationManager in order to call its interface methods, which are not wrapped by animation controller. The destructor. Called when animation controller object is being destroyed. Constructs an animation controller. A keyframe that represents start of storyboard. A list of animation groups that belong to this animation controller. A pointer to a related CWnd object, which can be automatically redrawn when the status of animation manager has changed, or post update event has occurred. Can be NULL. Stores a pointer to Transition Factory COM object. Stores a pointer to Animation Timer COM object. Stores a pointer to Transition Library COM object. Stores a pointer to Animation Manager COM object. Specifies whether an animation controller is valid or not. This member is set to FALSE if current OS does not support Windows Animation API. Implements the animation controller, which provides a central interface for creating and managing UI animations. The CAnimationController class is the key class that manages animations. You may create one or more instances of animation controller in an application and, optionally, connect an instance of animation controller to a CWnd object using CAnimationController::SetRelatedWnd. This connection is required to send WM_PAINT messages to the related window automatically when animation manager status has changed or animation timer has been updated. If you do not enable this relation, you must redraw a window that displays an animation manually. For this purpose you can derive a class from CAnimationController and override OnAnimationManagerStatusChanged and/or OnAnimationTimerPostUpdate and invalidate one or more windows when necessary. Specifies how to destroy animation objects. If this parameter is TRUE, animation objects will be destroyed automatically when the group is destroyed. Otherwise animation objects must be destroyed manually. The default value is FALSE. Set this value to TRUE only if all animation objects that belong to group are allocated dynamically with operator new. Specifies how to clear transitions from animation objects that belong to group. If this member is TRUE, transitions are removed automatically when an animation has been scheduled. Otherwise you need to remove transitions manually. Specifies how to destroy keyframes. If this value is TRUE, all keyframes are removed and destroyed; otherwise they are removed from the list only. The default value is TRUE. Points to animation storyboard. This pointer is valid only after call on Animate. Contains a list of keyframes. Contains a list of animation objects. Directs all animation objects that belong to group automatically destroy transitions. Set this value to FALSE only if you allocate transitions on the stack. The default value is TRUE, therefore it's highly recommended to allocate transition objects using operator new. Specifies how to destroy transitions. Schedules an animation at the specified time. TRUE if the method succeeds; FALSE if the method fails or if Animate has not been called with bScheduleNow set to FALSE. Call this function to schedule an animation at the specified time. You must call Animate with bScheduleNow set to FALSE first. A pointer to animation timer. Specifies time to schedule the animation. Animates a group. TRUE if the method succeeds; otherwise FALSE. This method creates an internal storyboard, creates and applies transitions and schedules an animation if bScheduleNow is TRUE. If bScheduleNow is FALSE, you need to call Schedule to start animation at the specified time. Finds an animation object that contains the specified animation variable. A pointer to animation object, or NULL if animation object is not found. A pointer to animation variable. Removes and optionally destroys all keyframes that belong to an animation group. If m_bAutodestroyKeyframes member is TRUE then keyframes are removed and destroyed, otherwise keyframes are just removed from the internal list of keyframes. Removes transitions from animation objects that belong to an animation group. If m_bAutoclearTransitions flag is set to TRUE, this method loops over all animation objects that belong to the group and calls CAnimationObject::ClearTransitions(FALSE). Applies transitions to animation objects. This method ASSERTS in debug mode if storyboard has not been created. It creates all transitions first, then adds "static" keyframes (keyframes that depend on offsets), adds transitions that do not depend on keyframes, adds keyframes depending on transitions and other keyframes, and at last adds transitions that depend on keyframes. Returns GroupID. A group identifier. The destructor. Called when an animation group is being destroyed. Constructs an animation group. A pointer to animation controller that creates a group. Specifies GroupID. A helper that creates COM transition objects. TRUE is the method succeeds, otherwise FALSE. A helper that adds transitions to a storyboard. A pointer to a storyboard COM object. Specifies whether this method should add to the storyboard transitions that depend on other keyframes. A helper that adds keyframes to a storyboard. A pointer to a storyboard COM object. Specifies whether this method should add to the storyboard keyframes that depend on other keyframes. A pointer to animation controller this group belongs to. A unique identifier of animation group. Implements an animation group, which combines an animation storyboard, animation objects and transitions to define an animation. Animation groups are created automatically by animation controller (CAnimationController) when you add animation objects using CAnimationController::AddAnimationObject. An animation group is identified by GroupID, which is usually taken as a parameter to manipulate animation groups. The GroupID is taken from the first animation object being added to a new animation group. An encapsulated animation storyboard is created after you call CAnimationController::AnimateGroup and can be accessed via public member m_pStoryboard. Puts the encapsulated animation variables into a list. When the function returns, it contains pointers to four CAnimationVariable objects representing coordinates of rectangle. Specifies whether the rectangle has fixed size. If this member is true, then the size of rectangle is fixed and right and bottom values are recalculated each time the top-left corner is moved according to the fixed size. Set this value to TRUE to easily move the rectangle around the screen. In this case transitions applied to right and bottom coordinates are ignored. The size is stored internally when you construct the object and/or call SetDefaultValue. By default this member is set to FALSE. Adds transitions for left, top, right and bottom coordinates. Call this function to add the specified transitions to the internal list of transitions to be applied to animation variables for each rectangle sides. When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied (added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup. If you don't need to apply a transition to one of the rectangle sides, you can pass NULL. Specifies transition for the left side. Specifies transition for the top side. Specifies transition for the right side. Specifies transition for the bottom side. Converts a CAnimationRect to RECT. Current value of animation rectangle as RECT. This function internally calls GetValue. If GetValue for some reason fails, the returned RECT will contain default values for all rectangle coordinates. Assigns rect to CAnimationRect. It's recommended to do that before animation start, because this operator calls SetDefaultValue, which recreates the underlying COM objects for color components if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. The new value of animation rectangle. Provides access to CAnimationVariable representing bottom coordinate. A reference to encapsulated CAnimationVariable representing bottom coordinate. You can call this method to get direct access to underlying CAnimationVariable representing the bottom coordinate. Provides access to CAnimationVariable representing right coordinate. A reference to encapsulated CAnimationVariable representing right coordinate. You can call this method to get direct access to underlying CAnimationVariable representing the right coordinate. Provides access to CAnimationVariable representing top coordinate. A reference to encapsulated CAnimationVariable representing top coordinate. You can call this method to get direct access to underlying CAnimationVariable representing the top coordinate. Provides access to CAnimationVariable representing left coordinate. A reference to encapsulated CAnimationVariable representing left coordinate. You can call this method to get direct access to underlying CAnimationVariable representing the left coordinate. Returns current value. TRUE, if the current value was successfully retrieved; otherwise FALSE. Call this function to retrieve the current value of animation rectangle. If this method fails or underlying COM objects for left, top, right and bottom have not been initialized, rect contains default value, which was previously set in constructor or by SetDefaultValue. Output. Contains the current value when this method returns. Returns the default values for rectangle's bounds. A CRect value containing defaults for left, right, top and bottom. Call this function to retrieve default value, which was previously set by constructor or SetDefaultValue. Sets default value. Use this function to set a default value to animation object. This methods assigns default values to rectangle's bounds. It also recreates underlying COM objects if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Specifies new default values for left, top, right and bottom. Constructs an animation rect object. The object is constructed with specified coordinates of each side, Object ID and Group ID. They can be changed later at runtime using SetDefaultValue and SetID. Specifies coordinate of left bound. Specifies coordinate of top bound. Specifies coordinate of right bound. Specifies coordinate of bottom bound. Specifies Group ID. Specifies Object ID. Specifies user-defined data. Constructs an animation rect object. The object is constructed with specified top-left corner coordinates and size of rectangle, Object ID and Group ID. They can be changed later at runtime using SetDefaultValue and SetID. Coordinate of top-left corner. Size of rectangle. Specifies Group ID. Specifies Object ID. Specifies user-defined data. Constructs an animation rect object. The object is constructed with specified rect coordinates, Object ID and Group ID. They can be changed later at runtime using SetDefaultValue and SetID. Specifies default rectangle. Specifies Group ID. Specifies Object ID. Specifies user-defined data. Constructs a CAnimationRect object. The object is constructed with default values for left, top, right and bottom, Object ID and Group ID, which will be set to 0. They can be changed later at runtime using SetDefaultValue and SetID. Specifies initial size of animation rectangle. The encapsulated animation variable that represents Bottom bound of animation rectangle. The encapsulated animation variable that represents Right bound of animation rectangle. The encapsulated animation variable that represents Top bound of animation rectangle. The encapsulated animation variable that represents Left bound of animation rectangle. Implements the functionality of a rectangle whose top, left, right and bottom sides can be animated. The CAnimationRect class encapsulates four CAnimationVariable objects and can represent in applications a rectangle. To use this class in application, just instantiate an object of this class, add it to animation controller using CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to left, right top and bottom coordinates. Puts the encapsulated animation variables into a list. When the function returns, it contains pointers to three CAnimationVariable objects representing red, green and blue components. Adds transitions for Red, Green and Blue components. Call this function to add the specified transitions to the internal list of transitions to be applied to animation variables representing color components. When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied (added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup. If you don't need to apply a transition to one of the color components, you can pass NULL. Transition for Red component. Transition for Green component. Transition for Blue component. Converts a CAnimationColor to COLORREF. Current value of animation color object as COLORREF. This function internally calls GetValue. If GetValue for some reason fails, the returned COLORREF will contain default values for all color components. Assigns color to CAnimationColor. It's recommended to do that before animation start, because this operator calls SetDefaultValue, which recreates the underlying COM objects for color components if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Specifies new value Animation Color. Provides access to CAnimationVariable representing Blue component. A reference to encapsulated CAnimationVariable representing Blue component. You can call this method to get direct access to underlying CAnimationVariable representing Blue component. Provides access to CAnimationVariable representing Green component. A reference to encapsulated CAnimationVariable representing Green component. You can call this method to get direct access to underlying CAnimationVariable representing Green component. Provides access to CAnimationVariable representing Red component. A reference to encapsulated CAnimationVariable representing Red component. You can call this method to get direct access to underlying CAnimationVariable representing Red component. Returns current value. TRUE, if the current value was successfully retrieved; otherwise FALSE. Call this function to retrieve the current value of animation color. If this method fails or underlying COM objects for color components have not been initialized, color contains default value, which was previously set in constructor or by SetDefaultValue. Output. Contains the current value when this method returns. Returns the default values for color components. A COLORREF value containing defaults for RGB components. Call this function to retrieve default value, which was previously set by constructor or SetDefaultValue. Sets default value. Use this function to set a default value to animation object. This methods assigns default values to color components of animation color. It also recreates underlying COM objects if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Specifies new default values for red, green and blue components. Constructs an animation color object. The object is constructed with specified values for RGB components, Object ID and Group ID. They can be changed later at runtime using SetDefaultValue and SetID. Specifies default color. Specifies Group ID. Specifies Object ID. Specifies user-defined data. Constructs a CAnimationColor object. The object is constructed with default values for red, green, blue, Object ID and Group ID, which will be set to 0. They can be changed later at runtime using SetDefaultValue and SetID. The encapsulated animation variable that represents Blue component of animation color. The encapsulated animation variable that represents Green component of animation color. The encapsulated animation variable that represents Red component of animation color. Implements the functionality of a color whose red, green and blue components can be animated. The CAnimationColor class encapsulates three CAnimationVariable objects and can represent in applications a color. For example, you can use this class to animate colors of any object on the screen (like text color, background color etc). To use this class in application, just instantiate an object of this class, add it to animation controller using CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to Red, Green and Blue components. Puts the encapsulated animation variables into a list. When the function returns, it contains pointers to two CAnimationVariable objects representing the width and height. Adds transitions for Width and Height. Call this function to add the specified transitions to the internal list of transitions to be applied to animation variables for Width and Height. When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied (added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup. If you don't need to apply a transition to one of dimensions, you can pass NULL. A pointer to transition for Width. A pointer to transition for Height. Converts a CAnimationSize to a CSize. Current value of animation size as CSize. This function internally calls GetValue. If GetValue for some reason fails, the returned size will contain default values for Width and Height. Assigns szSrc to CAnimationSize. Assigns szSrc to CAnimationSize. It's recommended to do that before animation start, because this operator calls SetDefaultValue, which recreates the underlying COM objects for Width and Height if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Refers to CSize or SIZE. Provides access to CAnimationVariable representing Height. A reference to encapsulated CAnimationVariable representing Height. You can call this method to get direct access to underlying CAnimationVariable representing Height. Provides access to CAnimationVariable representing Width. A reference to encapsulated CAnimationVariable representing Width. You can call this method to get direct access to underlying CAnimationVariable representing Width. Returns current value. TRUE, if the current value was successfully retrieved; otherwise FALSE. Call this function to retrieve the current value of animation size. If this method fails or underlying COM objects for Width and Size have not been initialized, szValue contains default value, which was previously set in constructor or by SetDefaultValue. Output. Contains the current value when this method returns. Returns the default values for Width and Height. A CSize object containing default values. Call this function to retrieve default value, which was previously set by constructor or SetDefaultValue. Sets default value. Use this function to set a default value to animation object. This methods assigns default values to Width and Height of animation size. It also recreates underlying COM objects if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Specifies new default size. Constructs an animation size object. The object is constructed with specified values for width, height, Object ID and Group ID. They can be changed later at runtime using SetDefaultValue and SetID. Specifies default size. Specifies Group ID. Specifies Object ID. Specifies user-defined data. Constructs an animation size object. The object is constructed with default values for width, height, Object ID and Group ID, which will be set to 0. They can be changed later at runtime using SetDefaultValue and SetID. The encapsulated animation variable that represents height of animation size. The encapsulated animation variable that represents width of animation size. Implements the functionality of a size object whose dimensions can be animated. The CAnimationSize class encapsulates two CAnimationVariable objects and can represent in applications a size. For example, you can use this class to animate a size of any two dimensional object on the screen (like rectangle, control etc). To use this class in application, just instantiate an object of this class, add it to animation controller using CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to Width and/or Height. Puts the encapsulated animation variables into a list. When the function returns, it contains pointers to two CAnimationVariable objects representing the X and Y coordinates. Adds transitions for X and Y coordinates. Call this function to add the specified transitions to the internal list of transitions to be applied to animation variables for X and Y coordinates. When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied (added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup. If you don't need to apply a transition to one of coordinates, you can pass NULL. A pointer to transition for X coordinates. A pointer to transition for Y coordinate. Provides access to CAnimationVariable for Y coordinate. A reference to encapsulated CAnimationVariable representing Y coordinate. You can call this method to get direct access to underlying CAnimationVariable representing Y coordinate. Provides access to CAnimationVariable for X coordinate. A reference to encapsulated CAnimationVariable representing X coordinate. You can call this method to get direct access to underlying CAnimationVariable representing X coordinate. Converts a CAnimationPoint to a CPoint. Current value of CAnimationPoint as CPoint. This function internally calls GetValue. If GetValue for some reason fails, the returned point will contain default values for X and Y coordinates. Assigns ptSrc to CAnimationPoint. Assigns ptSrc to CAnimationPoint. It's recommended to do that before animation start, because this operator calls SetDefaultValue, which recreates the underlying COM objects for X and Y coordinates if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Refers to CPoint or POINT. Returns current value. TRUE, if the current value was successfully retrieved; otherwise FALSE. Call this function to retrieve the current value of animation point. If this method fails or underlying COM objects for X and Y coordinates have not been initialized, ptValue contains default value, which was previously set in constructor or by SetDefaultValue. Output. Contains the current value when this method returns. Returns the default values for X and Y coordinates. A point containing default value. Call this function to retrieve default value, which was previously set by constructor or SetDefaultValue. Sets default value. Use this function to set a default value to animation object. This methods assigns default values to X and Y coordinates of animation point. It also recreates underlying COM objects if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Specifies the default point value. Constructs CAnimationPoint object. Constructs CAnimationPoint object with specified properties. Specifies default point coordinates. Specifies Group ID. Specifies Object ID. Specifies user-defined data. Constructs CAnimationPoint object. Constructs CAnimationPoint object with default properties: default point coordinates, Group ID and Object ID are set to 0. The encapsulated animation variable that represents Y coordinate of animation point. The encapsulated animation variable that represents X coordinate of animation point. Implements the functionality of a point whose coordinates can be animated. The CAnimationPoint class encapsulates two CAnimationVariable objects and can represent in applications a point. For example, you can use this class to animate a position of any object on the screen (like text string, circle, point etc). To use this class in application, just instantiate an object of this class, add it to animation controller using CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to X and/or Y coordinates. Puts the encapsulated animation variable into a list. When the function returns, it contains a pointer to CAnimationVariable representing the animated value. Adds a transition to be applied to a value. Call this function to add a transition to internal list of transitions to be applied to an animation variable. When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied (added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup. A pointer to transition object. Provides access to encapsulated animation variable. A reference to encapsulated animation variable. Use this method to access the encapsulated animation variable. From CAnimationVariable you get access to underlying IUIAnimationVariable object, whose pointer can be NULL if animation variable has not been created. Assigns an INT32 value to CAnimationValue. Assigns an INT32 value to CAnimationValue. This value is set as a default value for encapsulated animation variable. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Specifies the value to be assigned to Animation Value. Assigns a DOUBLE value to CAnimationValue. Assigns a DOUBLE value to CAnimationValue. This value is set as a default value for encapsulated animation variable. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Specifies the value to be assigned to Animation Value. Provides conversion between CAnimationValue and INT32. Current value of Animation Value as integer. Provides conversion between CAnimationValue and INT32. This method internally calls GetValue and doesn't check for errors. If GetValue fails, the returned value will contain a default value previously set in constructor or with SetDefaultValue. Provides conversion between CAnimationValue and DOUBLE. Current value of Animation Value. Provides conversion between CAnimationValue and DOUBLE. This method internally calls GetValue and doesn't check for errors. If GetValue fails, the returned value will contain a default value previously set in constructor or with SetDefaultValue. Retrieves the current value. TRUE if the current value was retrieved successfully; otherwise FALSE. Call this function to retrieve the current value. This implementation calls the encapsulated COM object, and if the call fails, this method returns the default value that was previously set in constructor or with SetDefaultValue. Output. When the function returns it contains a current value of animation variable. Retrieves the current value. TRUE if the current value was retrieved successfully; otherwise FALSE. Call this function to retrieve the current value. This implementation calls the encapsulated COM object, and if the call fails, this method returns the default value that was previously set in constructor or with SetDefaultValue. Output. When the function returns it contains a current value of animation variable. Sets default value. Use this method to set a default value. A default value is returned to application when animation has not been started and/or underlying COM object has not been created. If the underlying COM object encapsulated in CAnimationVarible was already created, this method recreates it, therefore you might need to call EnableValueChanged/EnableIntegerValueChanged methods again. Specifies the default value. Constructs a CAnimationValue object. Constructs CAnimationValue object with specified properties. Specifies default value. Specifies Group ID. Specifies Object ID. specifies user-defined data. Constructs a CAnimationValue object. Constructs CAnimationValue object with default properties: default value, Group ID and Object ID are set to 0. The encapsulated animation variable that represents animation value. Implements the functionality of animation object with one value. The CAnimationValue class encapsulates a single CAnimationVariable object and can represent in applications a single animated value. For example, you can use this class for animated transparency (fade effect), angle (to rotate objects), or for any other case when you need to create an animation depending on a single animated value. To use this class in application, just instantiate an object of this class, add it to animation controller using CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to the value. Establishes relationship between animation variables, contained in an animation object, and their container. This is a helper that can be used to establish relationship between animation variables, contained in an animation object, and their container. It loops over animation variables and sets a back pointer to a parent animation object to each animation variable. In the current implementation the actual relationship is established in CAnimationBaseObject::ApplyTransitions, therefore back pointers are not set until you call CAnimationGroup::Animate. Knowing the relationship may be helpful when you processing events and need to get a parent animation object from CAnimationVariable (use CAnimationVariable::GetParentAnimationObject). Collects pointers to contained animation variables. This is a pure virtual method that must be overridden in a derived class. An animation object, depending on its type, contains one or more animation variables. For example, CAnimationPoint contains two variables, for X and Y coordinates respectively. The base class CAnimationBaseObject implements some generic methods, which act on a list of animation variables: ApplyTransitions, ClearTransitions, EnableValueChangedEvent, EnableIntegerValueChangedEvent. These methods call GetAnimationVariableList, which is filled in a derived class with actual animation variables contained in a particular animation object, then loop over the list and perform necessary actions. If you create a custom animation object, you must add to lst all animation variables contained in that object. A list that must be filled with animation variables contained in an animation object. Determines whether an animation object contains a particular animation variable. TRUE if the animation variable is contained in the animation object; otherwise FALSE. This method can be used to determine whether an animation variable specified by pVariable is contained within an animation object. An animation object, depending on its type, may contain several animation variables. For example, CAnimationColor contains three variables, one for each color component (red, green and blue). When a value of animation variable has changed, Windows Animation API sends ValueChanged or IntegerValueChanged events (if enabled), and the parameter of this event is a pointer to interface IUIAnimationVariable of animation variable. This method helps to obtain a pointer to animation from a pointer to contained COM object. A pointer to animation variable. Sets up Integer Value Changed event handler. If the Integer Value Changed event handler is enabled, you can handle this event in CAnimationController::OnAnimationIntegerValueChanged method, which should be overridden in a CAnimationController-derived class. This method is called every time the animation integer value has changed. A pointer to a parent controller. Specifies whether to enable, or disable Integer Value Changed event. Sets up Value Changed event handler. If the Value Changed event handler is enabled, you can handle this event in CAnimationController::OnAnimationValueChanged method, which should be overridden in a CAnimationController-derived class. This method is called every time the animation value has changed. A pointer to a parent controller. Specifies whether to enable, or disable Value Changed event. Removes all related transitions. Removes all related transitions and destroys them if bAutodestroy or m_bAutodestroyTransitions flag is TRUE. Transitions should be destroyed automatically only if they are not allocated on the stack. If the above flags are FALSE, transitions are just removed from the internal list of related transitions. Specifies whether to destroy transition objects automatically, or just remove them from the related list. Adds transitions to storyboard with encapsulated animation variable. TRUE if transitions were added successfully. Adds related transitions, that have been added with AddTransition (overloaded methods in derived classes), to storyboard. A pointer to a storyboard. With FALSE this method adds only those transitions that do not depend on keyframes. Tells whether related transition are destroyed automatically. If TRUE, related transitions are destroyed automatically; if FALSE, transition objects should be deallocated by calling application. By default this flag is TRUE. Set this flag only if you allocated transition on the stack and/or transitions should be deallocated by the calling application. Sets a flag that orders to automatically destroy transitions. Set this flag only if you allocated transition objects using operator new. If for some reason transition objects are allocated on the stack, the auto destroy flag should be FALSE. By default this flag is TRUE. Specifies the auto destroy flag. Returns user defined data. A value of custom data. Call this method to retrieve the custom data at runtime. The returned value will be 0 if it was not explicitly initialized in constructor or with SetUserData. Returns current Group ID. Current Group ID. Use this method to retrieve Group ID. It's 0 if Group ID has not been set explicitly in constructor or with SetID. Returns current Object ID. Current Object ID. Use this method to retrieve Object ID. It's 0 if Object ID has not been set explicitly in constructor or with SetID. Detaches an animation object from parent animation controller. This method is used internally. Sets user-defined data. Use this method to associate a custom data with an animation object. This data may be retrieved later at runtime by GetUserData. Specifies the custom data. Sets new IDs. Allows to change Object ID and Group ID. If the new Group ID differs from the current ID, an animation object is moved to another group (a new group will be created, if necessary). Specifies new Object ID. Specifies new Group ID. Creates transitions associated with an animation object. TRUE if transitions were created successfully; otherwise FALSE. Loops over list of animation variables encapsulated in a derived animation object and creates transitions associated with each animation variable. The destructor. Called when an animation object is being destroyed. Constructs an animation object. Constructs an animation object with specified Object ID and Group ID. Specifies Group ID. Specifies Object ID. User-defined data, which can be associated with animation object and retrieved later at runtime. Constructs an animation object. Constructs an animation objects and assigns default Object ID (0) and Group ID (0). A pointer to the parent animation controller. Specifies whether related transitions should be automatically destroyed. Stores user-defined data. Specifes the Object ID of the animation object. Specifies the Group ID of the animation object. The base class for all animation objects. This class implements basic methods for all animation objects. An animation object can represent a value, point, size, rectangle or color in an application, as well as any custom entity. Animation objects are stored in animation groups (see CAnimationGroup). Each group can be animated separately and can be treated as an analogue of storyboard. An animation object encapsulates one or more animation variables (see CAnimationVariable), depending on its logical representation. For example, CAnimationRect contains four animation variables - one variable for each side of rectangle. Each animation object class exposes overloaded AddTransition method, which should be used to apply transitions to encapsulated animation variables. An animation object can be identified by Object ID (optionally) and by Group ID. A Group ID is necessary in order to place an animation object to correct group, but if a Group ID is not specified, an object is placed in the default group with ID 0. If you call SetID with different GroupID, an animation object will be moved to another group (a new group is created if necessary). Specifies whether related transition objects should be deleted. Set this value to TRUE to force deletion of transition objects when they are being removed from the internal list of transitions. If this value is FALSE the transitions should be deleted by calling application. The list of transitions is always cleared after an animation has been scheduled. The default value is FALSE. Returns default value. The default value. Use this function to obtain default value of animation variable. The default value can be set in constructor or by SetDefaultValue method. Enables or disables the IntegerValueChanged event. When ValueChanged event is enabled, the framework calls virtual method CAnimationController::OnAnimationIntegerValueChanged. You need to override it in a class derived from CAnimationController in order to process this event. This method is called every time the integer value of animation variable is changed. A pointer to parent controller. TRUE - enable event, FALSE - disable event. Enables or disables the ValueChanged event. When ValueChanged event is enabled, the framework calls virtual method CAnimationController::OnAnimationValueChanged. You need to override it in a class derived from CAnimationController in order to process this event. This method is called every time the value of animation variable is changed. A pointer to parent controller. TRUE - enable event, FALSE - disable event. Adds transitions from the internal list to storyboard. This method adds transitions from the internal list to storyboard. It's called from the top level code several times to add transitions that do not depend on keyframes and add transitions that depend on keyframes. If the underlying animation variable COM object has not been created, this method creates it at this stage. A pointer to parent animation controller. A pointer to storyboard. TRUE, if this method should add transitions that depend on keyframes. Clears transitions. This method removes all transitions from the internal list of transitions. If bAutodestroy is TRUE, or m_bAutodestroyTransitions is TRUE, then transitions are deleted. Otherwise the caller should deallocate the transition objects. Specifies whether this method should delete transition objects. Adds a transition. This method is called to add a transition to the internal list of transitions to be applied to the animation variable. This list should be cleared when an animation has been scheduled. A pointer to a transition to add. Returns the current value of animation variable. S_OK if the value was obtained successfully, or underlying animation variable has not been created. Otherwise HRESULT error code. This method can be called to retrieve the current value of animation variable. If the underlying COM object has not been created, dblValue will contain a default value, when the function returns. The current value of the animation variable. Returns the current value of animation variable. S_OK if the value was obtained successfully, or underlying animation variable has not been created. Otherwise HRESULT error code. This method can be called to retrieve the current value of animation variable. If the underlying COM object has not been created, dblValue will contain a default value, when the function returns. The current value of the animation variable. Creates all transitions to be applied to this animation variable. TRUE if transitions were created successfully; otherwise FALSE. This method is called by the framework when it needs to create transitions that have been added to the variable's internal list of transitions. A pointer to transition library. A pointer to transition factory. Creates the underlying animation variable COM object. TRUE if the animation variable was successfully created; otherwise FALSE. This method creates the underlying animation variable COM object and sets its default value. A pointer to animation manager. Sets default value and releases IUIAnimationVariable COM object. Use this method to reset the default value. This method releases the internal IUIAnimationVariable COM object, therefore when animation variable is recreated, the underlying COM object gets the new default value. The default value is returned by GetValue if the COM object representing the animation variable is not created, or if the variable has not been animated. Specifies the new default value. Returns a pointer to IUIAnimationVariable COM object. A valid pointer to IUIAnimationVariable COM object, or NULL if animation variable was not created, or can't be created. Use this function to access the underlying IUIAnimationVariable COM object and call its methods directly if needed. Returns the parent animation object. A pointer to parent animation object, if relationship was established, otherwise NULL. This method can be called to retrieve a pointer to a parent animation object (a container). The destructor. Called when a CAnimationVariable object is being destroyed. Constructs an animation variable object. Constructs an animation variable object and sets its default value. A default value is used when a variable is not animated, or can't be animated. Specifies the default value. Sets the relationship between an animation variable and an animation object. This method is called internally to establish one-to-one relationship between an animation variable and an animation object that encapsulates it. A pointer to an animation object that contains this variable. A pointer to an animation object that encapsulates this animation variable. Contains a list of transitions that animate this animation variable. Specifies the default value, which is propagated to IUIAnimationVariable. Stores a pointer to IUIAnimationVariable COM object. NULL if the COM object has not been created yet, or if creation failed. Represents an animation variable. The CAnimationVariable class encapsulates IUIAnimationVariable COM object. It also holds a list of transitions to be applied to the animation variable in a storyboard. CAnimationVariable objects are embedded to animation objects, which can represent in an application an animated value, point, size, color and rectangle. Adds a keyframe to storyboard at offset. TRUE, if keyframe was added successfully. This function is called by the framework to add a keyframe to storyboard at offset. A pointer to a storyboard. Specifies whether to add a keyframe this keyframe depend on recursively. Adds a keyframe to storyboard after transition. TRUE, if keyframe was added successfully. This function is called by the framework to add a keyframe to storyboard after transition. A pointer to a storyboard. Specifies whether to add a transition recursively. Adds a keyframe to a storyboard. TRUE, if keyframe was added successfully. This method adds a keyframe to storyboard. If it depends on other keyframe or transition and bDeepAdd is TRUE, this method tries to add them recursively. A pointer to a storyboard. Specifies whether to add keyframe or transition recursively. Returns an offset from other keyframe. An offset in seconds from other keyframe. This method should be called to determine an offset in seconds from other keyframe. Returns a pointer to a keyframe this keyframe depends on. A valid pointer to keyframe, or NULL if this keyframe does not depend on other keyframe. This is an accessor to a keyframe this keyframe depends on. Returns a pointer to a transition this keyframe depends on. A valid pointer to transition, or NULL if this keyframe does not depend on transition. This is an accessor to a transition this keyframe depends on. Constructs a keyframe that depends on other keyframe. The constructed keyframe will represent a moment in time within a storyboard, which has a specified offset from pKeyframe. A pointer to keyframe. Offset, in seconds, from keyframe specified by pKeyframe. Constructs a keyframe that depends on a transition. The constructed keyframe will represent a moment in time within a storyboard when the specified transition ends. A pointer to a transition. Stores a pointer to an existing keframe. This keyframe is added to storyboard with m_offset to the existing keyframe. Specifies offset of this keyframe from a keyframe stored in m_pExistingKeyFrame. Stores a pointer to transtion that begins at this keyframe. Represents an animation keyframe. This class implements an animation keyframe. A keyframe represents a moment in time within a storyboard and can be used to specify the start and end times of transitions. A keyframe may be based on other keyframe and have an offset (in seconds) from it, or may be based on a transition and represent a moment in time when this transition ends. Adds a keyframe to storyboard. TRUE if keyframe was added to storyboard successfully; otherwise FALSE. This method is called to add a keyframe to storyboard. A pointer to a storyboard. If this parameter is TRUE and the keyframe being added depends on some other keyframe or transition, this method tries to add this keyframe or transition to storyboard first. Specifies whether the keyframe should be added to storyboard at offset, or after transition. TRUE if the keyframe should be added to storyboard at some specified offset. FALSE if the keyframe should be added to storyboard after some transition. Specifies whether the keyframe should be added to storyboard at offset. The offset or transition must be specified in a derived class. Tells whether a keyframe has been added to storyboard. TRUE if a keyframe is added to a storyboard; otehrwise FALSE. In the base class IsAdded always returns TRUE, but it's overridden in derived classes. Returns the underlying keyframe value. A current keyframe. The default value is UI_ANIMATION_KEYFRAME_STORYBOARD_START. This is an accessor to the underlying keyframe value. Constructs a keyframe object. Specifies whether this keyframe should be added to storyboard at an offset from another existing keyframe, or at the end of some transition. Specifies whether this keyframe has been added to a storyboard. Represents a Windows Animation API keyframe. When a keyframe is not initialized it is set to the predefined value UI_ANIMATION_KEYFRAME_STORYBOARD_START. Implements basic functionality of keyframe. Encapsulates UI_ANIMATION_KEYFRAME variable. Serves as a base class for any keyframe implementation. A keyframe represents a moment in time within a storyboard and can be used to specify the start and end times of transitions. There are two types of keyframes - keyframes added to storyboard at the specified offset (in time), or keyframes added after specified transition. Because durations of some transitions can't be known before animation starts, the actual values of some keyframes are determined at runtime only. Because keyframes may depend on transitions, which in their turn depend on keyframes, it's important to prevent infinite recursions when building keyframe chains. Specifies whether a transition has been added to a storyboard. A pointer to an animation variable, which is animated with the transition stored in m_transition. Stores a pointer to the keyframe that specifies the end of the transition. Stores a pointer to the keyframe that specifies the beginning of the transition. Stores a pointer to IUIAnimationTransition. NULL if a COM transition object has not been created. Stores the transition type. Adds a transition to a storyboard. TRUE, if transition was successfully added to a storyboard. Applies the transition to the related variable in the storyboard. If the start keyframe was specified, the transition begins at that keyframe. If the end keyframe was specified, the transition begins at the start keyframe and and stops at the end keyframe. If the transition was created with a duration parameter specified, that duration is overwritten with the duration of time between the start and end keyframes. If no keyframe was specified, the transition is appended to the transition added most recently to the variable. A pointer to storyboard, which will animate the related variable. Adds a transition to a storyboard. TRUE, if transition was successfully added to a storyboard. Applies the transition to the related variable in the storyboard. If this is the first transition applied to this variable in this storyboard, the transition begins at the start of the storyboard. Otherwise, the transition is appended to the transition added most recently to the variable. A pointer to storyboard, which will animate the related variable. Returns a pointer to related variable. A valid pointer to animation variable, or NULL if an animation variable has not been set by SetRelatedVariable. This is an accessor to related animation variable. Establishes a relationship between animation variable and transition. Establishes a relationship between animation variable and transition. A transition can be applied only to one variable. A pointer to related animation variable. Returns start keyframe. A valid pointer to a keyframe, or NULL if a transition should not be inserted between keyframes. This method can be used to access a keyframe object that was previously set by SetKeyframes. It's called by top level code when transitions are being added to storyboard. Returns start keyframe. A valid pointer to a keyframe, or NULL if a transition should not start after a keyframe. This method can be used to access a keyframe object that was previously set by SetKeyframes. It's called by top level code when transitions are being added to storyboard. Tells whether a transition has been added to a storyboard. Returns TRUE if a transition has been added to a storyboard, otherwise FALSE. This flag is set internally when the top level code adds transitions to storyboard. Sets keyframes for a transition. This method tells the transition to start after specified keyframe and, optionally, if pEnd is not NULL, end before the specified keyframe. If the transition was created with a duration parameter specified, that duration is overwritten with the duration of time between the start and end keyframes. A keyframe that specifies the beginning of the transition. A keyframe that specifies the end of the transition. Returns a pointer to underlying COM transition object. A valid pointer to IUIAnimationTransition or NULL if underlying transition can't be created. It's an accessor method to underlying COM transition object. It doesn't instantiates the underlying IUIAnimationTransition COM object if it wasn't created. Returns a pointer to underlying COM transition object. A valid pointer to IUIAnimationTransition or NULL if underlying transition can't be created. This method returns a pointer to underlying COM transition object and creates it if necessary. A pointer to transition library, which creates standard transitions. It can be NULL for custom transitions. A pointer to transition factory, which creates custom transitions. It can be NULL for standard transitions. Creates a COM transition. TRUE if a transition COM object was created successfully; otherwise FALSE. This is a pure virtual function that must be overridden in a derived class. It's called by the framework to instantiate the underlying COM transition object. A pointer to transition library, which creates standard transitions. It can be NULL for custom transitions. A pointer to transition factory, which creates custom transitions. It can be NULL for standard transitions. Returns transition type. One of TRANSITION_TYPE enumerated values. This method can be used to identify a transition object by its type. The type is set in a constructor in a derived class. Releases encapsulated IUIAnimationTransition COM object. This method should be called from a derived class's Create method in order to prevent IUITransition interface leak. The destructor. Called when a transition object is being destroyed. Constructs a base transtion object. Defines the transition types currently supported by the MFC implementation of Windows Animation API. A transition type is set in the constructor of specific transition. For example, CSinusoidalTransitionFromRange sets its type to SINUSOIDAL_FROM_RANGE. Represents a basic transition. This class encapsulates IUIAnimationTransition interface and serves as a base class for all transitions. Detect mesh collision. The mesh 1 eptr. The mesh 2 eptr. (Optional) If non-null, vector of boundary point vectors. A MESH_COLLISION. Values that represent mesh collisions. Creates curves on all mesh edges. The mesh eptr. True to add undo capability, false otherwise. True to fit arcs, false otherwise. Returned array of curve eptrs. The edge tolerance. True if it succeeds, false if it fails. This method adds a polygon to the database. Structure storing desired parameters of the polygon. Location of the desired center of the polygon in world coordinates. A boolean indicating whether the polygon should be stored. An array of pointers indicating the location of the created entities. (Optional) the entities if not stored. Returns a short indicating the number of entities created. Structure used to store information relating to a polygon. The number of the polygon's sides. The length of the polygon's radius. A boolean indicating whether or not the size of the polygon's radius is fixed. A boolean indicating whether the polygon will have fillets. The rotation of the polygon. A boolean indicates that the radius is measured to the corners if true, to the midpoints if false. Indicates whether a trimmed surface is added to the polygon. A boolean indicating whether or not a point will be created at the center. A boolean indicating whether or not all of the dialog options are being viewed. Assignment operator overload. Object to copy. A reference to this object. Checks if the display list is being used to find entities. True if using the display list; False if using the database. Gets an entity from either the display list or the database and bumps the internal pointer to the next one. Entity read from display list or database. True if successful; false if no more entities. Initializes the internal pointer to point to the first entity as well as the selection and entity masks. Only visible entities that match the specified selection and entity masks as well as the global "mask_level" are returned by GetEnt. Selection mask (ALIVE_BIT, GROUP_BIT, etc.). Entity mask (P_ID, L_ID, etc.). Force function to use database, not display list. (Optional) Destructor. Constructor. Display List/Database Position. This class allows a caller to cycle though all entities in either the display list or the database. Start by calling Rewind to reset the internal state to point to the first entity and specify the selection and entity masks. Next, call GetEnt to get an entity and bump the internal pointer to the next one. Continue calling GetEnt until no entities remain. Select some faces and save the surface entity data. If enhanced face selection is used, the return value is a status: -1 = okay, 0 = error. Prompt. Enhanced face selection entity mask or zero for normal solids selection. Number of faces saved as surfaces or enhanced face selection status. Write solid faces to temporary file. Bodies (all faces) Faces. Number in temp file. @par Purpose: Select some faces and save the surface entity data @return Number of surfs selected @param[in] sld_eptr pointer to solid @param[in] toolp_id toolpath id @param[in] chkSurfFlag allow check surface selection @param[in] use_vis_test use visibility test @param[out] n_chksrf number of check surfaces selected @param[out] n_gougesrf number of gouge surfaces selected @param[in] perf_toler preferred tolerance @param[out] trim_failure true: one or more surfaces failed to trim @param[in,out] active true/false @param[out] wholeBodySelected true=the entire solid body was selected (body pick), false=individual faces were selected (face pick) @param[in] addSurfs true: add surfs to tmp file; false: don't add surfs to tmp file @param[in] dirtyDisplayList true: dirty solids display list; false: don't dirty solids display list Convert solid tag's edges to Mastercam wireframe entities. The solid tag (body, face, or edge). The Mastercam eptrs created. Only include open edges (surfaces and sheet bodies). (Optional) include outer, inner, or both types of loop edges (solid body or face). Get the Solid Temp File Data Version. The Solid Temp File Data Version. Solid curve all edges - types of loops for which to generate wireframe. * * @par Purpose: Helper function used by surf_sel_bits_MM() and surf_sel_bits_c5_MM() (B-08741/B-09168) * * @return true if successful * * @param[in] sld_eptr pointer to solid * @param[in] toolp_id toolpath id * @param[in] use_vis_test use visibility test * @param[out] *wholeBody, whole solid body selected * @param[out] *bodyTag, solid body tag *@param[out] *nChkSrf, number of check faces *@param[out] *nGougeSrf, number of gouge faces * @param[out] arr tp sld face info * @par Purpose: Make all faces in temporary solid surface file invisible @retirm number of faces hidden @par Purpose: Make faces in temporary solid surface file invisible @retirm number of faces hidden @param[in] driveSurfs hide T- drive surfaces F- check surfaces @par Purpose: Remove set of surfaces from solid surfs temp file @param[in] set_no set number @par Purpose: Get file position in solid surfs temp file @return file position @par Purpose: Set file position in solid surfs temp file @param[in] file_pos file position @par Purpose: Find the extremes of ents in solid temp file @return true if successful @param[in] dir direction vector @param[out] maxz Max Z in direction @param[out] maxPt One pt (of possibly many) at max Z @param[out] minz optional - may be NULL) Min Z in direction @param[out] minPt optional - may be NULL) One pt at min Z @par Purpose: Select some faces and save the surface entity data @return Number of surfs selected @param[in] sld_eptr pointer to solid @param[in] toolp_id toolpath id @param[in] chkSurfFlag allow check surface selecton @param[in] use_vis_test use visibility test @param[out] n_chksrf number of check surfaces selected @param[out] n_gougesrf number of gouge surfaces selected @param[in] perf_toler prefered tolerance @param[out] trim_failure true: one or more surfaces failed to trim @param[in,out] active true/false @param[out] wholeBodySelected true=the entire solid body was selected (body pick), false=individual faces were selected (face pick) @par Purpose: Select some faces and save the surface entity data @return Number of surfs selected @param[in] sld_eptr pointer to solid @param[in] toolp_id toolpath id @param[in] chkSurfFlag allow check surface selecton @param[in] use_vis_test use visibility test @param[out] n_chksrf number of check surfaces selected @param[in] perf_toler prefered tolerance @param[out] trim_failure true: one or more surfaces failed to trim @param[in,out] active true/false @par Purpose: Return count ents in solid surfs temp file @return number of selected ents in temp file @param[in] set_no selection set to count @par Purpose: draw a chain temp file edge @param[in] eptr pointer to entity to draw @param[in] local_color color @par Purpose: highlight the selected faces based on surface usage (drive, project,...) @return number of surfaces highlighted @param[in] set_on true = highlight, false = unhighlight @param[in] srfType DRIVE_FLAG, PROJECT_FLAG, ..., CHECK_SURF_FLAG, or 0 for drive surfaces @par Purpose: highlight the selected faces @param[in] set_on true = highlight, false = unhighlight @par Purpose: Select a face and save the surface entity data @return true if successful @par Purpose: Read the surface entity data for the next face without checking for selectability @return true if successful @param[out] entity entity to fill out @par Purpose: Save the surface entity data for all visible solid faces @param[in] visibleOnly true = visible solids only (default), false = all solids @return Number of faces saved as surfaces @par Purpose: Select some faces and save the surface entity data @return Number of faces saved as surfaces @param[in] msg Selection prompt @par Purpose: Select some faces and save the surface entity data. A non-MFC alternative to the original function. @return Number of faces saved as surfaces @param[in] pCharMsg Selection prompt @par Purpose: Read a certain entity from the file of selected faces or chains @return true if successful @param[in] input_ptr entity to fetch @param[out] entity entity to fill out @par Purpose: Read the surface entity data for the next faces @return true if successful @param[out] ret_header header @par Purpose: Read the surface entity data for the next face without checking for selectability (and pointer to solid) @return true if successful @param[out] entity entity to fill out @param[out] solid_eptr pointer to solid @param[out] face_index face index @par Purpose: Read the surface entity data for the next 'visible' selected face (and pointer to solid) @return true if successful @param[out] entity entity to fill out @param[out] solid_eptr pointer to solid @param[out] face_index face index @par Purpose: Read the next surface entity from the file of selected faces @return true if successful @param[out] entity entity to fill out @par Purpose: Close the file containing the selected chain entities @par Purpose: Close the file containing the selected face surface entities Solid allow highlight temporary file. true to allow. Old highlight temporary file state. @par Purpose: Check if the file containing the selected face surface entities exists @return true if file exists @par Purpose: Check if any solid temp file exists @return true if file exists @} @par Purpose: Rewind the file containing the selected face surface entities @defgroup gr_grp8 Graphics View Settings @{ Project geometry. If non-null, the input. If non-null, options for controlling the project. If non-null, the view. True if it succeeds, false if it fails. Roll chains. The chains to be processed. Options for controlling the roll. The arc. True if it succeeds, false if it fails. Offset Chains. The chains to be processed. Options for controlling the offset. [out] A list of the resulting "new" geometry. True if it succeeds, false if it fails. Offset a single Chain. The chain to be processed. Options for controlling the offset. [out] A list of the resulting "new" geometry. True if it succeeds, false if it fails. Break many pieces. The geometry to be processed. This geometry must already have been committed to Mastercam's database! Options for controlling the break. [out] A list of the resulting "new" geometry. [out] A list of geometries where errors occurred (if any). True if it succeeds, false if it fails. Executes the "transform - move to origin" action. The "from point" (world coordinates).. True to move all entities, false move just the selected entities. True if it succeeds, false if it fails. Perform a "silent" Combine Views operation on the active database. Move 'grouped' geometry to level. The type(s) of selection groups to search for. The target Level# (move "to"). This method resets the Level# of all current entities that match the specified Group Type; Result and/or Group. This only affects geometry that is already committed to Mastercam's database! It does NOT effect the state of any NET-Hook side geometry objects. That is why it can be "fast". The number of entities that were copied, or -1 if the specified level# was not valid. Move all selected geometry to a level. This method resets the Level# of all currently 'selected' entities to the specified destination level. This only affects geometry that is already committed to Mastercam's database! It does NOT effect the state of any NET-Hook side geometry objects. That is why it can be "fast". The target Level# (move "to" level). Clear the 'selection' on the entities when done? The number of entities that were copied, or -1 if the specified level# was not valid. Copy all selected geometry to a level. This method does an "in-place" XForm translate on ALL selected entities (regardless of their Level) which makes copies and then scans the database for all RESULT GROUP entities and resets their Level# to the specified destination level. This only affects geometry that is already committed to Mastercam's database! It does NOT effect the state of any NET-Hook side geometry objects. That is why it can be "fast". The target Level# (copy "to"). Clear the 'selection' on the entities when done? The number of entities that were copied, or -1 if the specified level# was not valid. XForm-Scale all of the 'selected' geometry entities. NOTE! Any Geometry objects that get altered will NOT be reflected in that entity's data "on the NET-Hook side" if that entity's data is being held in a NET-Hook Geometry object! You can use to retrieve the result of the XForm operation. If there was no 'selected' geometry found to be XForm'd, the return result will be 'true'. Note that all 'selections' will be cleared by the XForm operation. The scale origin point (in world coordinates). The scaling factor. true to copy, else false to move. true if it succeeds, false if it fails. XForm-Mirror all of the 'selected' geometry entities. NOTE! Any Geometry objects that get altered will NOT be reflected in that entity's data "on the NET-Hook side" if that entity's data is being held in a NET-Hook Geometry object! You can use to retrieve the result of the XForm operation. If the supplied view is null, the active Construction View will be used. If there was no 'selected' geometry found to be XForm'd, the return result will be 'true'. Note that all 'selections' will be cleared by the XForm operation. The axis to mirror about. The view. true to copy, else false to move. true if it succeeds, false if it fails. XForm-Rotate all of the 'selected' geometry entities. The rotation origin point (in world coordinates). The rotation angle. The view. true to copy, else false to move. NOTE! Any Geometry objects that get altered will NOT be reflected in that entity's data "on the NET-Hook side" if that entity's data is being held in a NET-Hook Geometry object! You can use to retrieve the result of the XForm operation. If the View is null, the active Construction View will be used. If there was no 'selected' geometry found to be XForm'd, the return result will be 'true'. Note that all 'selections' will be cleared by the XForm operation. true if it succeeds, false if it fails. XForm-Translate all of the 'selected' geometry entities. NOTE! Any Geometry objects that get altered will NOT be reflected in that entity's data "on the NET-Hook side" if that entity's data is being held in a NET-Hook Geometry object! You can use to retrieve the result of the XForm operation. If a supplied view is null, the active Construction View will be used. If there was no 'selected' geometry found to be XForm'd, the return result will be 'true'. Note that all 'selections' will be cleared by the XForm operation. The 'from' point (in world coordinates). The 'to' point (in world coordinates). The 'from' view. The 'to' view. true to copy, else false to move. true if it succeeds, false if it fails. Join entities. [in,out] The lines to be joined. The lines are passed 'by reference' as the lines in the array will be altered. Some lines will be deleted and others will be altered by the join. The number of joins that were made (or -1 on error). Join arcs entities. [in,out] The arcs to be joined. The arcs are passed 'by reference' as the arcs in the array will be altered. Some arcs will be deleted and others will be altered by the join. The number of joins that were made (or -1 on error). Break an Arc at its midpoint. [in,out] The arc to break. The 2nd half of the arc, else null if it fails. Break a Line at its midpoint. [in,out] The line to break. The 2nd half of the line, else null if it fails. Fillet a chain. The chain to be filleted. The fillet creation parameters settings for controlling the operation. [out] The fillet arcs that were created. [out] Did re-filleting occur? True if it succeeds, false if it fails. Fillet a chain. The chain to be filleted. The fillet radius. The color# to be used for the fillet(s). The level# to place the fillet(s) on. The type of the fillet direction An array of the fillet (arcs) that were created. Fillet a chain. If you pass '-1' for Color and/or Level the active "main" Color and/or Level will be used. The chain to be filleted. The fillet radius. The color# to be used for the fillet(s). The level# to place the fillet(s) on. An array of the fillet (arcs) that were created. Fillet a chain. The chain to be filleted. The fillet radius. true if it succeeds, false if it fails. Create a Fillet between two entities. GeomCurve1 and GeomCurve1 can be either lines and/or arcs. If you pass '-1' for Color and/or Level the active "main" Color and/or Level will be used. The first geometry entity. The second geometry entity. The fillet radius. The color# to be used for the fillet. The level# to place the fillet on. true to trim the supplied geometry to the fillet. The fillet (arc) that was created, else null if it fails. Create a Fillet between two entities. GeomCurve1 and GeomCurve1 can be either lines and/or arcs. The first geometry entity. The second geometry entity. The radius of the fillet. true to trim the supplied geometry to the fillet. True fillet was successfully created, else false if it fails. Break an 'curve' entity (line or arc) at its midpoint (worker method). [in,out] The geometry entity to be broken. The 2nd half of the entity, else null if it fails. Fillet a chain (worker method). The chain to be filleted. The fillet radius. The color# to be used for the fillet. The level# to place the fillet on. [out] The fillets that were created. The fillet direction type. true if it succeeds, false if it fails. Create a Fillet between two entities (worker method). GeomCurve1 and GeomCurve1 can be either lines and/or arcs. The first geometry entity. The second geometry entity. The radius of the fillet. The color# to be used for the fillet. The level# to place the fillet on. true to trim the supplied geometry to the fillet. [out] The fillet that was created. true if fillet was successfully created, else false if it fails Join entities (worker method). [in,out] The geometry to be joined. The array of entities must contains either all lines or all arcs! The number of joins that were made (or -1 on error). Private Manager Constructor. Made private so as not to allow anyone to create an instance of it. This class is used for performing graphics-related tasks and activities. Handles the common code for internally creating the bounding box. The common data needed to construct this cylindrical bounding box. The cylindrical data needed to construct this cylindrical bounding box. The geometry to be bounded (null to do all geometry). [out] The Cylinder Point. [out] The Cylinder Vector. [out] The Cylinder Radius (X) and Height (Y). The new bounding box geometry. Handles the common code for internally creating the bounding box. The common data needed to construct this rectangular bounding box. The rectangular data needed to construct this rectangular bounding box. The geometry to be bounded (null to do all geometry). [out] The lower-left corner of the box extents. [out] The upper-right corner of the box extents. The new bounding box geometry. Creates all edge curves on the selected Surfaces and/or Solids and/or Polygonal Meshes. It is OK if more than Surfaces are in the selection, this method will ignore any non-Surface/Solid/PMesh entities. The tolerance (Maximum allowable gap between open edges). The break angle. (Not used on PMesh type entities). The mesh edge angle. (Only used on PMesh type entities). true to fit arcs and lines, false for splines true to only do the open edges. nullptr if it fails, else the new edge curves. Creates all edge curves on the selected Surfaces and/or Solids and/or Polygonal Meshes. It is OK if more than Surfaces or Solids are in the selection, this method will ignore any non-Surface/Solid/PMesh entities. This method used the current system tolerance. The break angle. (Not used on PMesh type entities). The mesh edge angle. (Only used on PMesh type entities). true to fit arcs and lines, false for splines true to only do the open edges. nullptr if it fails, else the new edge curves. Creates a cylindrical boundary box - Either around All geometry or the specified geometry entities. Because the bounding box mechanism makes use of the Mastercam selection mechanism, any selected geometry may be marked as unselected upon completion of the bounding process. The common data needed to construct this cylindrical bounding box. The cylindrical data needed to construct this cylindrical bounding box. The entities that the bounding box will surround. If this is NULL, it will process ALL geometry! [out] The cylinder point position. [out] The cylinder vector. [out] The radius (X) and the height (Y) of the cylinder. An array containing the newly created boundary geometry if successful, else a null reference if not. Creates a cylindrical boundary box around the specified entities. Because the bounding box mechanism makes use of the Mastercam selection mechanism, any selected geometry may be marked as unselected upon completion of the bounding process. The common data needed to construct this cylindrical bounding box. The cylindrical data needed to construct this cylindrical bounding box. The entities that the bounding box will surround. An array containing the newly created boundary geometry if successful, else a null reference if not. Creates a cylindrical boundary box. Because the bounding box mechanism makes use of the Mastercam selection mechanism, any selected geometry may be marked as unselected upon completion of the bounding process. The common data needed to construct this cylindrical bounding box. The cylindrical data needed to construct this cylindrical bounding box. An array containing the newly created boundary geometry if successful, else a null reference if not. Creates a rectangular boundary box around the specified entities. Because the bounding box mechanism makes use of the Mastercam selection mechanism, any selected geometry may be marked as unselected upon completion of the bounding process. The common data needed to construct this rectangular bounding box. The rectangular data needed to construct this rectangular bounding box. The entities that the bounding box will surround. [out] The lower-left corner of the bounding box. [out] The upper-right corner of the bounding box. An array containing the newly created boundary geometry if successful, else a null reference if not. Creates a rectangular boundary box around the specified entities. Because the bounding box mechanism makes use of the Mastercam selection mechanism, any selected geometry may be marked as unselected upon completion of the bounding process. The common data needed to construct this rectangular bounding box. The rectangular data needed to construct this rectangular bounding box. The entities that the bounding box will surround. An array containing the newly created boundary geometry if successful, else a null reference if not. Creates a rectangular boundary box around all geometry in the part file. Because the bounding box mechanism makes use of the Mastercam selection mechanism, any selected geometry may be marked as unselected upon completion of the bounding process. The common data needed to construct this rectangular bounding box. The rectangular data needed to construct this rectangular bounding box. An array containing the newly created boundary geometry if successful, else a null reference if not. Creates Parametric Spline from a chain. This is Mastercam's Create Spline - Curves Spline functionality. The chain. The maximum error deviation allowed. The original curves disposition. The original curves disposition level. The Parametric Spline if it succeeds, else a null reference if it fails. Creates NURBS Spline from a chain. This is Mastercam's Create Spline - Curves Spline functionality. The chain. The maximum error deviation allowed. The original curves disposition. The original curves disposition level. The NURBS Spline if it succeeds, else a null reference if it fails. Creates a 3D helix in the current construction plane. The data needed to construct the helix. An array of NURBS curve geometry objects representing the helix if successful, else a null array reference if not. Creates a 3D spiral in the current construction plane. The data needed to construct the spiral. An array of NURBS curve geometry objects representing the spiral if successful, else a null array reference if not. Creates 2D ellipse geometry in the current construction plane. The point representing the center of the 2D ellipse. The distance from the center of the ellipse to the edge of the ellipse along the X axis. The distance from the center of the ellipse to the edge of the ellipse along the Y axis. The degree to which the ellipse is rotated around it's center point. An arc geometry object representing the new ellipse if successful, else a null reference if not. In the case of an unsuccessful geometry creation, check the CreationReturnCode flag to see why the creation process failed. Creates a polygon in the current construction plane. The data needed to construct the polygon. An array of line geometry objects representing the polygon if successful, else a null reference if not. In the case of an unsuccessful geometry creation, check the CreationReturnCode flag to see why the creation process failed. Creates a rectangle with filleted corners in the current construction plane. The lower left corner of the rectangle. The upper right corner of the rectangle. The fillet radius. An array of the geometry objects of the rectangle and fillets if successful, else a null reference if not. Creates a rectangle in the current construction plane. The lower left corner of the rectangle. The upper right corner of the rectangle. An array of line geometry objects of the rectangle if successful, else a null reference if not. Initializes a new instance of the GeometryCreationManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used for performing geometry related tasks. The manual entry code. The save method. The source type. This variable stores the text to be commited to the manual entry operation in the Mastercam database. Gets or sets the manual entry gcode. Gets or sets the save method. This property should be set only if the Source is set as File. Gets or sets the source type. Gets or sets the operation's text. This method commits the current manual entry operation's settings to the Mastercam database. True if the database commit was successful, else false if not. This method commits the current manual entry operation's settings to the Mastercam database. Thrown when an Identifier Not Found error condition occurs. True if the database commit was successful, else false if not. Loads the default values for a given operation object from the operation structure passed in. [in,out] The operation structure to use as defaults for this operation object. Initializes a new instance of the ManualEntryOperation class. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Initializes a new instance of the ManualEntryOperation class. Save to post Save to MCAM file Enumeration for the save method. From given file From Observation Enumeration for the source type. NCI Comment as Code NCI Comment ON NCI Comment NCI Comment OFF Enumeration for the manual entry code. This class is representing a ManualEntry operation. Map canned text coolant commands into operation canned text array. The operation canned text parameters. The coolant commands. Gets coolant option label. Zero-based index of the coolant option (0-9). True to append the "On" label to the end of the string. True to append the "Off" label to the end of the string. The label. The machine. True if it succeeds, false if it fails. Queries if any coolant option is enabled. The state to indicate v9 post's control flags. The canned text. The machine. True if any coolant option is enabled, false if not. Query if any coolant is enabled in canned text. The canned text. The machine. True if any coolant in canned text, false if not. Query if coolant is in canned text. The canned text. True if it succeeds, false if it fails. Query if the machine is using v 9 post. The machine. True if using v 9 post, false if not. Checks if the given option is a canned coolant option [-120, -101]. Option to check. True if the option is a canned coolant option. Convert the given canned text option into a canned coolant option if it is a coolant option. Canned text option to convert. Coolant option definition or no value if the canned text option does not represent a coolant option. Transforms an individual canned coolant option and its position into a canned text option. Coolant option. Coolant option position. Canned text option representation of a canned coolant option. Initializes a new instance of the CannedCoolantOption class. Coolant option identifier. Coolant option position. Canned coolant option decoded from canned text. Indicies used within canned text. This method commits any changes to this Nesting operation to the Mastercam database. True if the database commit was successful, else false if not. Loads the default values for a given operation object from the operation passed in. [in,out] The operation to use as defaults for this operation object. Commits an operation to the Mastercam database. The operation to be committed. True if the commit was successful, else false if not. Initializes a new instance of the NestingOperation class. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Initializes a new instance of the NestingOperation class. This creates a new nesting toolpath operation with default settings. This class is a class used for working with Nesting operations in the Mastercam database. Initializes this object with the given ID. The ID of the operation entity to look up in the Mastercam database. Thrown if the operation ID is not found within the Mastercam Database. Start angle in degrees Options in instances box in UI: 0 = Angle Between, 1 = Total Sweep View number at time of creation Rotational view origin Rotational view matrix Rotational Angle in degrees Rotation point in world coords Number of steps in X and Y Translates coordinates to Rotate Plane 14 = rotate around origin, 15 = rotate around a point This method commits the current Transformation Operation's settings to the Mastercam database. True if the database commit was successful, else false if not. Initializes a new instance of the RotateOperation class. The ID of the operation entity to look up in the Mastercam database. Thrown if the operation ID is not found within the Mastercam Database. Default constructor. Enum for Rotation Format. A rotate type transform operation. Query if 'convertedContentFileName' is valid content name. The converted archive. True if valid content name, false if not. Converts a string to a lowercase. The string to lowercase. StringToLower as a std::wstring. Extract and copy PST files, probe files, MachSim files, and others. Unused. MC_NOERROR always. Creates a new instance of the IArchiveCreatorService interface. The new Archive Creator Service instance. Removes the Zip2GoFiles required by or generated by Zip2Go. Filename, no extension, of the key Mastercam file. Gets Zip2Go communication path file name. The Zip2Go communication path file name. Call Zip2Go edit silently. True for content file, false for Zip/Z2G. True if it succeeds, false if it fails. Writes instruction commands to a text file for communication to Zip2Go. True to write commands for a content file, False for a zip file. Sets Zip path. Full pathname of the actual file. Zip path for the file. Sets Content path. Full pathname of the actual file. Content path for the file. Processes the Mastercam Part file for dependencies based on selected options. Filename of the part. The selected machine groups. The selected file types. A std::vector<std::tuple<std::wstring,std::wstring,std::wstring>> of dependent files Queue instruction commands to modify the archive. The instruction commands with their file paths. Queue Mastercam part command for processing. Full pathname of the file. Filename of the file. Queue name of the archive as a command for processing. The file path source. The file path destination. Gets the Mastercam Part file's display path. The part display path. Destructor. Creates an archive file. The archive file. (Optional) Mode Create, Edit, Backup. ZipToGo File Type enumeration. Values that represent zip to go machine groups enumeration. An interface to create Content and Zip files. Extracts the content file package described by contentFileName. Filename, including path, of the content file to be extracted. True if it succeeds, false if it fails. Creates content file package. Filename, including path, of the content file to be created. A collection of files with paths to be added to the content file or just the Mastercam part file. True if it succeeds, false if it fails. Initializes a new instance of the ArchiveManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. Manager for archives. This class cannot be inherited. Initializes this object with the given ID. The ID of the operation entity to look up in the Mastercam database. Thrown if the operation ID is not found within the Mastercam Database. Transform the WCS Determines if tool origin must be shifted Makes subprograms output labels Translate nci coords or leave tool plane intact Whether new operations should be generated or simply modify old ones Should new planes be created for transformed toolplanes? Should subprogramming be handled incrementally or not Determines operation type grouping. Determines if original instances are skipped. To post source operations or not Detemines if a unique sub program number is used for 'clump' option If work offsets are matched in named views and ops End number work offsets with this number Start number work offsets with this number Represents the current work offset mode. Determines if the source operation is deleted after calculations are done Determines the transform operation's source location Determines if comments are removed Determines how Work Offsets are derived The operation range end The operation range start The type of transformation operation used The miscellaneous doubles The miscellaneous integers Determines if Miscellaneous variables are enabled or not. Misc variables are used for things like lathe's 911 and 912 lines This method commits the current Transformation Operation's settings to the Mastercam database. True if the database commit was successful, else false if not. This method commits the current transformation operation's settings to the Mastercam database. Thrown when an Identifier Not Found error condition occurs. True if the database commit was successful, else false if not. Initializes a new instance of the TransformOperation class. Attempts to populate with information on the operation with this ID from the Mastercam Database. Thrown if the operation ID is not found within the Mastercam Database. Initializes a new instance of the TransformOperation class. Values that represent the 3 work offsets modes: 0-offsets at post time, 1-maintain source ops, 2-assign Values that represent the 3 transformation types, 8 = Mirror, 13 = Rotate, 16 = Translate Sets general properties. [in/out] The C++ operation. Base class for all transformation operations. Loads the default values for a given surface geometry object from the geometry entity passed in. [in,out] The surface geometry entity to use as defaults for this surface geometry object. Commits a surface geometry entity to the Mastercam database. [in,out] The surface geometry entity to be committed. True if the commit was successful; false if not. Initializes a new instance of the PiecewisePolynomialSurface class. Attempts to retrieve a surface geometry entity with the given ID from the Mastercam database and use that to initialize this surface geometry object. If no matching geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the surface geometry entity to look up in the Mastercam database. This class is used for working with piecewise polynomial surfaces within Mastercam. Due to the complex nature of working with piecewise polynomial surfaces, the internal data of a piecewise polynomial surface is unavailable in this version of the NET-Hook API. Gets or sets this surface's base surface geometry. Gets or sets the offset distance from this surface's base surface. Gets or sets the vector representing the direction of this surface's normal vector. Loads the default values for a given surface geometry object from the geometry entity passed in. [in,out] The surface geometry entity to use as defaults for this surface geometry object. Commits a surface geometry entity to the Mastercam database. [in,out] The surface geometry entity to be committed. True if the commit was successful; false if not. Initializes a new instance of the OffsetSurface class. Attempts to retrieve a surface geometry entity with the given ID from the Mastercam database and use that to initialize this surface geometry object. If no matching geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the surface geometry entity to look up in the Mastercam database. This class is used for working with offset surfaces within Mastercam. This method writes a double value to the Mastercam prompt display area. The double value to output to the prompt display. This method writes an integer value to the Mastercam prompt display area. The integer to output to the prompt display. This method writes a string to the Mastercam prompt display area. The text string to output to the prompt display. This method clears the Mastercam prompt display area. Initializes a new instance of the PromptManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used for adding and removing information to the Mastercam prompt display area. This method reads information from a cell in the currently open Microsoft Excel file. The identifier for the cell to write information to. The general Object to be read into from the specified cell. True if the data was read and stored to the specified Value parameter correctly, else false if not. This method reads information from a cell in the currently open Microsoft Excel file. The identifier for the cell to write information to. The double object to be read into from the specified cell. True if the data was read and stored to the specified Value parameter correctly, else false if not. This method reads information from a cell in the currently open Microsoft Excel file. The identifier for the cell to write information to. The integer object to be read into from the specified cell. True if the data was read and stored to the specified Value parameter correctly, else false if not. This method reads information from a cell in the currently open Microsoft Excel file. The identifier for the cell to write information to. The string object to be read into from the specified cell. The maximum number of characters for the string object True if the data was read and stored to the specified Value parameter correctly, else false if not. This method writes information to a cell in the currently open Microsoft Excel file. The identifier for the cell to write information to. The double value to be written into the specified cell. This method writes information to a cell in the currently open Microsoft Excel file. The identifier for the cell to write information to. The integer value to be written into the specified cell. This method writes information to a cell in the currently open Microsoft Excel file. The identifier for the cell to write information to. The String object to be written into the specified cell. This method saves the currently open Microsoft Excel file. The full name and path for the Microsoft Excel file to save. This method closes the currently open Microsoft Excel file. This method opens a Microsoft Excel file for editing. The full name and path for the Microsoft Excel file to open. True if the file was opened correctly, else false if not. Initializes a new instance of the ExcelFileManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is provided as a utility for working with Microsoft Excel files. This is a static inequality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first line to compare. This is the second line to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first line to compare. This is the second line to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this math object to another one. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. [in,out] This is the line to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first line to compare. This is the second line to compare. True if the two objects are considered equal. Gets or set the specified endpoint of this Line2D. This is the bracket operator overload so that the points within this line can be accessed via an array-like interface. The index used within the brackets must be either 0 or 1 to access either the first or the second endpoint. Thrown if an index is passed in that is out of the allowed range. Converts this object into a string representation. A text string that represents this object. Gets or sets the second endpoint of the specified line object. Gets or sets the first endpoint of the specified line object. Initializes a new instance of the Line2D class. This construction method takes two 2D points and constructs a line object from them. The point to become the first endpoint. The point to become the second endpoint. "Converts" this NET-Hook type to the corresponding Mastercam math type. [out] The Mastercam math type. Initializes a new instance of the Line2D class. The Mastercam 2D line geometry data. This class is used as a mathematical representation of a 2D Line. Posts a DialogResult message to the event queue. You can then capture this "command" message in your GetEvent loop, allowing you to detect when the modeless dialog is closing, so that you can (optionally) end the GetEvent loop. The type of DialogResult to be sent. true if it succeeds, false if it fails. Posts a DialogResult.Cancel message to the event queue. queue. You can then capture this "command" message in your GetEvent loop, allowing you to detect when the modeless dialog is closing, so that you can (optionally) end the GetEvent loop. true if it succeeds, false if it fails. Posts a DialogResult.OK message to the event queue. queue. You can then capture this "command" message in your GetEvent loop, allowing you to detect when the modeless dialog is closing, so that you can (optionally) end the GetEvent loop. true if it succeeds, false if it fails. Initializes a new instance of the ModelessDialog class. You can derive your Form from this to 'automatically' setup the TabHandler. This class is used to manage the handling of Tab Keys in a Modeless Dialog. The instance of the ModelessDialogTabs class. ModelessDialogTabs is defined in the ModelessDialogTabHandler.dll Initializes a new instance of the ModelessDialogTabsHandler class. You pass your (Windows) Form to this constructor and it will enable the proper handling of the tab key navigation for the dialog. The Dialog (Form) to be have its tab navigation handled. This class is used to manage the handling of Tab Keys in a Modeless Dialog. Initialize database. If true, we're doing a full initialization (e.g. File New, File Open). Save any type of entity in the database without drawing it. The pointer to the entity. The entity selection bits. The entity level. The entity attributes. true = Success; false = Failed. Save any type of entity in the database. The pointer to the entity. The entity selection bits. The entity color. The entity level. The entity attributes. true = Success; false = Failed. Sets and/or clears the selection bit(s) of an entity. Call this function to set or clear an entity's selection bits. If the state of either ALIVE_BIT or BLANK_BIT changes, the database will be dirtied. The argument "mask" identifies which bits are to be modified whereas "sel" contains the values of those bits. Examples: WriteEntSel (eptr, SELECT_BIT, SELECT_BIT) // Set SELECT_BIT WriteEntSel (eptr, SELECT_BIT, 0) // Clear SELECT_BIT WriteEntSel (eptr, SELECT_BIT | TEMP_BIT, TEMP_BIT) // Set TEMP_BIT and clear SELECT_BIT Entity eptr. Mask of selection bits to set and/or clear. Value of selection bits identified by mask. Iterate over the given part file until the end of the NCI section is reached or the supplied processor function returns false on the 'continueIteration' parameter. Replicates behavior of lib_read_ent loops that stop iteration at the start of the NCI section. This function replaces the conventional approach of reading entities by entities in the part file. Loaded entities will be handed to the supplied processor, and then will be cleaned up before the iteration continues. In the function being supplied, iteration can be discontinued or allocation freeing can be prevented should the loaded entities need to be captured for ownership elsewhere. The MCFile instance. Must be opened prior to calling this function. The function to be used to process entities in the file and communicate back how to proceed. Reads an entity from a file. The file. The entity. A result value (see ReadEntityResult definitions). Fetch the total number of bytes for the entity at the current file position. The open part file. Returned - the total in bytes. A result value (see ReadEntityResult definitions). Writes an entity to a file. The file. The entity. (Optional) Error code (0=Success, 1=GeneralError, 2=MemoryError, 3=EndOfFile) True if it succeeds, false if it fails. Invokes the current set of callbacks after the temporary database has been restored. Adds the specified function to the list of functions to be invoked after the temporary database has been restored. The callback to be invoked after the temporary database has been restored. An instance to a RAII scope object that will remove the function from the list on destruction. A temporary database restore callback scope. Restore temporary database. *** Use GetOpMgrUIService ()->RestoreTempDb (tempDbFileName); *** Filename of the temporary file. True if it succeeds, false if it fails. Saves the temporary database. *** Use tempDbFileName = Cnc::Db::TempDb::Save (); *** A string of the temporary file name, empty string if unsuccessful. Build a full path with a GUID file name in the current temporary directory. The file extension. A std::wstring (ex. "C:\MyMastercamTempDirectory\SomeRandomGUID.mcam"). Dumps a temporary database time log to a text file and display in your editor. True to dump editor, false to debug output window. Clears temporary database time log. Returns true if any temporary database is active with in any of the given states. The temporary db states to check for. True if active, false if not. Makes temporary database state timer. TempDb state's time will update upon destruction. The TempDb state we want to update. A shared_ptr to the TempDb state timer. Sets reading temporary database. True to on. True if it succeeds, false if it fails. Gets reading temporary database. True if it succeeds, false if it fails. Gets restoring temporary database. True if it succeeds, false if it fails. Cast the DB_LIST_ENT::eptr member to the contained ent. This function is intended to encapsulate the intentional reinterpret_cast of the DB_LIST_ENT::eptr member to flag and easily find the core database code that legitimately needs to do this because we will need to revisit this as we continue the redefinition of DB_LIST_ENT_PTR. Database node to cast from. DB_LIST_ENT::eptr cast to the contained ent. Creates an observer of the current database. The new observer of the current database. Gets the current database repository provided that the current database has been allocated. Null if it fails, else the current repository. Fills in the contents of ent from the given database pointer. Calling this function with allowDeleted set to true must NOT be routine and should only be used where justified. Ent instance to populate. Database pointer to fill in from. (Optional) True to allow deleted entities. Result of the operation. Values that represent the result of the FillInEnt function. Collect geometry stored relative to prevDbEnd. Previous end of database. Eptrs to newly stored entities. (Optional) Filter by entity type (0=all) (Optional) Filter by selection bit (0=all) (Optional) Filter by visibility. Shift "CAP" vertical alignment from "1" to "4" WAS = 0=TOP / 1=CAP / 2=HALF / 3=BASE / 4=BOTTOM NOW = 0=TOP / 1=HALF / 2=BASE / 3=BOTTOM / 4=CAP Old vertical alignment (CAP was "1") New vertical alignment (CAP now "4"). Validate eptrs within TP_EPTRS toolpath entity. The TP_EPTRS toolpath entity. True to check only pointer and count not actual eptrs. Free the allocation of memory in the global historyEnt entity. Gets access to the global variable 'descr_info' representing the current session file description information. The the current session file bitmap information. Gets access to the global variable 'bitmap_info' representing the current session file bitmap information. The the current session file bitmap information. Gets access to the global variable 'pTheRealNciBinFileClass' representing the real nci bin file class instance. The const ptr to NciBinFileClass for comparison. Gets access to the global MMF Manager instance. DBTODO: Embed a MMF manager in database for use by DB entites such as DbSTLMesh A reference to an UtMMFDataMgr. Gets a reference to the global variable 'cur_op_ptr' representing the current operation database pointer. The current operation database pointer. Gets a reference to the global variable 'cur_ent_idn' representing the current entity id number. The current entity id number. Reinitialize the current closet. True if it succeeds, false if it fails. Get end of current closet. End of current closet. Get start of current closet. Start of current closet. Clear all solid tag references in current closet. (Optional) The tag to clear. Find a solid tag in the current closet. Solid tag. Entity mask. Entities. true if it succeeds, false if it fails. Searches for the first entity at selection point. The selection point. The entity. The selection "t" parameters ([1]=curve(T), [2]=surface(UV). (Optional) The entity to skip. True if it succeeds, false if it fails. Find entity pointer in current closet. Entity pointer to search for. true, if successful. Store edge in current closet. The event object. The ent mask. true, if successful. Store entity in current closet. The entity. true, if successful. Store edge or face in current closet. The event object (edge=m_eptr, face=m_eptrArray). The entity mask. true, if successful. Store edge in current closet. The edge tag. The entity mask. The entity. (Optional) True to overwrite entity if tag already exists. True if it succeeds, false if it fails. Store face in current closet. The face tag. The surfaces. (Optional) True to overwrite entity if tag already exists. true, if successful. Closet store spline. The spline. Number of segments. True if closed. Pointer to spline. Closet store trim surface. The base surface (must be NURBS). The trim surface. Pointer to trim surface. Stores NURBS surface in current closet. The surface. Pointer to surface. Translate closet entity. The closet entity. The from point in world coordinates. The to point in world coordinates. (Optional) The from view (0=Top). (Optional) The to view (0=From). Xform entity stored in current closet. Destructor. Default constructor. Closet. Deactivate database. Initializes the database. true if it succeeds, false if it fails. Stores an entity. Entity. (Optional) The edge or face tag. true if it succeeds, false if it fails. Stores an edge. Edge tag. Entity mask. Entity. (Optional) True to overwrite entity if tag already exists. true if it succeeds, false if it fails. Stores a face. Face tag. Surfaces. (Optional) True to overwrite entity if tag already exists. True if it succeeds, false if it fails. Searches for the first eptr. Eptr. true if it is found. Searches for the tag. Tag. Entity mask. Entities. true if found. Clear all solid tag references. (Optional) The tag to clear. Gets the end of this closet. End of closet. Gets the start of this closet. Start of closet. Flip surface normal. Eptr. true if flipped. Map arc to standard view. Eptr. Search for standard view pointing towards user then standard views. true if it mapped. Searches for the first entity at selection point. The selection point. The entity. The selection "t" parameters ([1]=curve(T), [2]=surface(UV). (Optional) The entity to skip. True if it succeeds, false if it fails. Fill in entity. Entity. Eptr. true to allow, false to deny deleted. true if it succeeds, false if it fails. Eptr valid. Eptr. true to allow, false to deny deleted. true if it is valid. Reinitializes the database. true if it succeeds, false if it fails. Destructor. Default constructor. Closet Item. Takes the data from an unmanaged Mastercam 'tp_holder' structure and loads it into the managed 'ToolHolder::Holder' object. The Mastercam 'tp_holder' struct containing the holder data to transfer. The managed ToolHolder::Holder to be filled in. true if it succeeds, false if it fails. Retrieve the (HST-style) Mill Tool Holder from the specified operation. The ID of the operation to read from. [out] The filled in Holder object. true if a Holder was found in the Operation, else false. Initializes a new instance of a Holder structure. The maximum diameter of the holder. Overall height of the holder. Name of the holder library. Name of the holder. The list of holder segments. The number of segments in the holder. A (Mill) Holder. The height of the segment. The lower diameter of the segment. The upper diameter of the segment. A HolderSegment (a triplet of double values). Private Constructor. So as not to allow anyone to create an instance of this class. This class handles (HST style) Tool Holder object interaction between the NET-Hook operation objects and Mastercam operations. Given two holders, returns two if they are identical, false otherwise. A reference to the first holder. A reference to the second holder. True if it succeeds, false if it fails. Given new data to store in the holder, attaches all the data and setups up the holder correctly. The IDN of the holder to modify. Source for the holder data. true if it succeeds, false if it fails. Given new data to store in the holder, attaches all the data and setups up the holder correctly. The IDN of the holder to modify. Pointer to the segment data for the holder. The total size of holderData. Pointer to the library name. The number of characters in the library name. Pointer to the holder name. The number of characters in the holder name. True if it succeeds, false if it fails. Given an ent_idn, returns true if the holder exists, false otherwise. The holder idn. true is the holder exists, false otherwise. Given a ent_idn, retrieves the tp_holder for this holder. For more details on the holder profile (holder data), read information at the top of TlHolder_CH.h (in particular about holderEntity.u.holder.holder_ptr_numsegs and triplets at holderEntity.u.holder.holder_ptr) The holder idn. The holder. true if a matching holder entity was found, false otherwise. Given a ent_idn, retrieves the entity for this holder. For more details on the holder profile (holder data), read information at the top of TlHolder_CH.h (in particular about holderEntity.u.holder.holder_ptr_numsegs and triplets at holderEntity.u.holder.holder_ptr) The holder idn. The holder entity. true if a matching holder entity was found, false otherwise. Creates a new holder entity and stores it in the database. Source for the holder data. The ent_idn of the newly-created holder. Creates a new holder entity and stores it in the database. Source for the holder data. The ent_idn of the newly-created holder. Creates a new holder entity and stores it in the database. The ent_idn of the newly-created holder. Creates a new holder entity and stores it in the database. The library name to initialize this holder with. The length of the holder_lib string. The name of the holder. The length of the holder_name string. The ent_idn of the newly-created holder. Sets the number of segements for the holder and creates the needed memory to store the segments. This function clears out the currently allocated memory. The ent_idn of the holder to modify. The number of segments this holder has. True if it succeeds, false if it fails. Sets the holder name for the holder. This function clears out the currently allocated memory. The ent_idn of the holder to modify. The new holder name as a CString. True if it succeeds, false if it fails. Sets the holder name for the holder. This function clears out the currently allocated memory. The ent_idn of the holder to modify. A pointer to the buffer holding the new holder name. The number of characters in the holder name. True if it succeeds, false if it fails. Sets the holder name for the holder. This function clears out the currently allocated memory. The ent_idn of the holder to modify. The library name as a CString. True if it succeeds, false if it fails. Sets the library name for the holder. This function clears out the currently allocated memory. The ent_idn of the holder to modify. A pointer to the buffer holding the new library name. The number of characters in the library name. True if it succeeds, false if it fails. Creates a local copy of the holder entity at the specified IDN. The holder idn. A holder allocation that cleans itself up on destruction or std::nullopt if there is no database holder. Creates a new holder with COPIES of the old holder data in the database. The IDN of the database holder to copy. The new entity IDN in the database. Creates a legacy tp_holder allocation from the given holder segments, library name, and holder name. The segments. Name of the library. Name of the holder. The new holder allocation. Creates a copy of the specified holder. The holder to copy. Information describing the segment. Size of the segment data. Name of the library. Size of the library name. Name of the holder. Size of the holder name. The new holder allocation copy. Creates a copy of the specified holder. The holder to copy. The new holder allocation copy. Allocate new memory for the given holder. The holder. Size of the buffer. The allocator. Allocate new memory for the given holder. The holder. The allocator. Gets buffer size for the specified holder instance. The holder. The buffer size. A tp_holder allocation for use in managing legacy tool holders and their variable length memory. Gets or sets the location of the ending point for drawing this torus primitive solid as an angle, in degrees, from the base point. Gets or sets thee location of the starting point for drawing this torus primitive solid as an angle, in degrees, from the base point. Gets or sets the distance of the inner edge of the torus from this torus primitive solid's base point. Gets or sets the distance of the outer edge of the torus from this torus primitive solid's base point. Initializes a new instance of the TorusSolid class. This constructs a new torus solid object with default parameters. The default parameters of a torus solid are for a full (360 degree) torus with the center at the WCS origin, (0.0, 0.0, 0.0), with a major radius of 0.5 and a minor radius of 0.25. Loads the default values for a given solid geometry object. Loads the default values for a given solid geometry object from the solid geometry entity passed in. The geometry entity to use as defaults for this solid geometry object. Commits a solid geometry entity to the Mastercam database. The solid geometry entity to be committed. The solid parameters to initialize the object with. True if the commit was successful; false if not. Initializes a new instance of the TorusSolid class. Attempts to retrieve a solid geometry entity with the given ID from the Mastercam database and use that to initialize this solid geometry object. If no matching solid geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the solid geometry entity to look up in the Mastercam database. This class is used for working with torus shaped primitive solids. Sets an operation flag. Identifier for the operation. The on/off state to set. The flag to set. True if it succeeds, false if it fails. Gets the state of an operation flag. Identifier for the operation. The flag to query. The on/off state of the specified flag. Values that represent operation status 'flag' types. This method un-registers a variable. The variable to un-register. This method un-registers a English variable. The variable to un-register. This method un-registers a Metric variable. The variable to un-register. This method resets a variable to a new value. The variable to reset. The new value to store with the variable. True if the value is to be stored as the Metric value, else false if it's to be stored to the English value. This method registers a new Metric variable. The variable to register. The default value for this Metric variable. This method registers a new English variable. The variable to register. The default value for this English variable. This method registers a new variable. The variable to register. The default Metric value for this variable. The default English value for this variable. This method refreshes a specified variable. The variable to refresh. This method frees the current Mastercam variable registry. Initializes a new instance of the RegistryVariableManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used for working with Mastercam registry variables. This method is for retrieving the most recently installed version of Mastercam. A string containing the most recently installed version of Mastercam's name. This method gets the registry path and key name for the instance of Mastercam currently running. The string value of the registry path and name for the currently running instance of Mastercam. Initializes a new instance of the RegistryManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class provides the methods for working with the general parameters of the registry. Select all entities matching the supplied type 'mask'. These selections are additive, meaning this selection will be added to any current selections. The selection mask. This method sets all of the geometry in the current file as unselected. This method sets all of the geometry in the current file as selected. Prompts to user to select a window. This gets the corners of the sketched window, it does not select any geometry. The prompt text. [out] The first corner point. [out] The second corner point. True if it succeeds, false if it fails. Window selection using a program defined window. The geometry mask to use during geometry selection. The type of box selection to be performed. The first corner of the window. The second corner of the window. True if it succeeds, false if it fails. This method asks the user to box select some geometry. This method might best be used with the SearchManager::GetGeometry method when combined with selection flags that will return all of the geometry that was box selected in this step by the user. The text to display to the user as they're selecting the geometry. The geometry mask to use during geometry selection. The type of box selection to be performed. True if the box selection was successful and false if not. This method asks the user to select multiple geometry items. The text to display to the user as they're selecting the geometry. The geometry mask to use during geometry selection. An array containing all of the geometry selected geometry items. This method asks the user to select a geometry item. The text to display to the user as they're selecting the geometry. The geometry mask to use during geometry selection. A handle to the selected geometry item if successful, or a null value if not. Ask the user to select a point or point position on an entity. The main purpose of this method is to allow user selection for the creation of Associative Points. As some PointMasks are not usable for the creation of an AssociativePoint (Intersect, Sketch, etc.), the PostMask returned will be PointMask::PointGeometry for those "invalid" cases. In these cases'allowCreatePoint = true' must be set for a Point entity to be created and assigned to the Geometry out value. The prompt text to display. True to allow creating a point if needed. True to allow selection on Solids. [out] If non-null, the associated geometry entity that was selected. [out] Type of the point pick (See remarks!). [out] The point in world coordinates. [out] The 'T' values of the pick location. true if it succeeds, false if it fails. Ask the user to select a point or point position on an entity. The main purpose of this method is to allow user selection for the creation of Associative Points. As some PointMasks are not usable for the creation of an AssociativePoint (Intersect, Sketch, etc.), the PostMask returned will be PointMask::PointGeometry for those "invalid" cases. In these cases'allowCreatePoint = true' must be set for a Point entity to be created and assigned to the Geometry out value. The prompt text to display. True to allow creating a point if needed. True to allow selection on Solids. [out] If non-null, the associated geometry entity that was selected. [out] Type of the point pick (See remarks!). [out] The point in world coordinates. true if it succeeds, false if it fails. This method asks the user to select or create a point. The text to display to the user as they're selecting the point. The point mask to use during point selection creation. Use the PointMask Null value if no point masking is to be used. This should be a valid point object which will be set to the returned point coordinates if successful. True if the point was selected or created successfully, else false if not. This method sets the chaining flag in all visibly selected geometry. This method clears the chaining flag in all of a part's geometry. Sets the chaining flag in all matching geometry. The entity mask to match on. Sets the chaining flag in all of the part's geometry. Initializes a new instance of the SelectionManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class handles the interaction of geometry selection. Initializes a new instance of the TypeLibrary class. Private Constructor. Made private so as not to allow anyone to create an instance of it. Type library. This type library is used to hold GUIDs of class types that we'll need for comparison purposes in the API. These GUIDs are used for type comparison purposes; generally, they're used in downcasting handles to class objects. For performance purposes, if the GUID is not used in the API it's not included in the TypeLibrary class. This method saves this object's cutter comp settings to the operation data member passed in. [in,out] The operation data member to load with cutter comp settings. This method saves this object's finish settings to the operation data member passed in. [in,out] The operation data member to load with finish settings. This method saves this object's rough/finish settings to the operation data member passed in. [in,out] The operation data member to load with rough/finish settings. This method saves this object's (basic) Cut Parameters settings to the operation data member passed in. The operation data member to load with cut parameters settings. This method loads this object's cutter comp settings from the operation data member passed in. [in,out] The operation data member to load it's cutter comp settings from. This method loads this object's finish settings from the operation data member passed in. [in,out] The operation data member to load it's finish settings from. This method loads this object's lead-in/lead-out settings from the operation data member passed in. [in,out] The operation data member to load it's lead-in/lead-out settings from. This method loads this object's (basic) Cut Parameters settings from the operation data member passed in. [in,out] The operation data member to load it's cut parameters settings from. The cutter comp settings to be used in this contour operation. Gets or sets the multi passes parameter data to be used in this thread mill operation. Gets or sets the lead-in lead-out parameter data to be used in this thread mill operation. Gets or sets the (basic) cut parameter data to be used in this thread mill operation. This method commits the current Thread Mill operation to the Mastercam database. true to update any points assigned to the operation. If you know that you've not altered the points used by this operation, you may wish to used this >.Commit(false). True if the database commit was successful and false if not. This method commits the current Thread Mill bore operation to the Mastercam database. This commit also updates any the points used by this operation. If you know that do not want the points touched during the commit, you may wish to use the .Commit(false) method overload. True if the database commit was successful and false if not. Initializes a new instance of the ThreadMillOperation class. This creates a new Thread Mill operation with default settings. Commits the operation. true to include, false to exclude touching the points during the commit. true if it succeeds, false if it fails. Initializes a new instance of the ThreadMillOperation class. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Loads the default values for a given operation object from the operation structure passed in. [in,out] The operation structure to use as defaults for this operation object. Loads the default values for a given operation object. This class is used for working with Thread Mill toolpath operations. Gets or sets a value indicating the state of the Helical Entry/Exit At Bottom Of Thread option. Gets or sets a value indicating the state of the Helical Entry/Exit At Top Of Thread option. Gets or sets a value indicating the state of the Perpendicular Entry option. Gets or sets a value indicating the state of the Start At Center option. Gets or sets the ExitLineLength value. Gets or sets the EntryLineLength value. Gets or sets the EntryExitArcClearance value. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the Thread Mill Lead-In Lead-Out specific parameters. Gets or sets the inside/outside type value. Gets or sets the left or right hand thread option. Gets or sets the thread direction. Gets or sets the Linearize Helixes value. Gets or sets a value indicating whether to linearize helixes. Gets or sets the taper angle value. Gets or sets the thread start angle value. Gets or sets the thread over-cut allowance value. Gets or sets the thread diameter value. Gets or sets the thread pitch value. Gets or sets the number of active teeth value. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the (basic) Cut Parameter data needed to set up a Thread Mill operation. An enumeration that represent the "hand" of the thread. Specifies left hand thread. Specifies right hand thread. An enumeration that represent the cutting direction. Specifies cutting direction. Specifies cutting direction. An enumeration that represent the location of the thread . Specifies an outside diameter thread. Specifies an inside diameter thread. This method load this object's break through settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with break through settings. This method load this object's depth cuts settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with depth cuts settings. This method loads this object's transitions page settings from the operation data member passed in. [in,out] The operation data member to load it's transitions page settings from. This method loads this object's semi-finish settings from the operation data member passed in. [in,out] The operation data member to load it's semi-finish settings from. This method loads this object's finish settings from the operation data member passed in. [in,out] The operation data member to load it's finish settings from. This method loads this object's finishing settings from the operation data member passed in. [in,out] The operation data member to load it's finishing settings from. This method loads this object's helix entry settings from the operation data member passed in. [in,out] The operation data member to load it's helix entry settings from. This method loads this object's roughing settings from the operation data member passed in. [in,out] The operation data member to load it's roughing settings from. This method loads this object's cutter comp settings from the operation data member passed in. [in,out] The operation data member to load it's cutter comp settings from. This method loads this object's (basic) Cut Parameters settings from the operation data member passed in. [in,out] The operation data member to load it's cut parameters settings from. This method saves this object's break through settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with break through settings. This method saves this object's depth cuts settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with depth cuts settings. This method saves this object's transitions page settings to the operation data member passed in. [in,out] The operation data member to load with transitions page settings. This method saves this object's semi-finish settings to the operation data member passed in. [in,out] The operation data member to load with semi-finish settings. This method saves this object's helix finish settings to the operation data member passed in. [in,out] The operation data member to load with finish settings. This method saves this object's finishing settings to the operation data member passed in. [in,out] The operation data member to load with finishing settings. This method saves this object's helix entry settings to the operation data member passed in. [in,out] The operation data member to load with helix entry settings. This method saves this object's helix roughing settings to the operation data member passed in. [in,out] The operation data member to load with roughing settings. This method saves this object's cutter comp settings to the operation data member passed in. [in,out] The operation data member to load with cutter comp settings. This method saves this object's (basic) Cut Parameters settings to the operation data member passed in. The operation data member to load with cut parameters settings. Gets or sets the data structure contains the CircleMill Helix Entry parameters used in this operation. Gets or sets the data structure that contains the CircleMill Finish (groupbox) parameters used in this operation. Gets or sets the data structure that contains the CircleMill Semi-Finish (groupbox) parameters used in this operation. Gets or sets the data structure that contains the CircleMill Finishing (page) parameters used in this operation. Gets or sets the Roughing settings used in this operation. Gets or sets the Break Through settings used in this operation. Mastercam X7 Gets or sets the Depth Cut Through settings used in this operation. The cutter comp settings to be used in this contour operation. Gets or sets the (basic) cut parameter data to be used in this circle mill operation. This method commits the current Circle Mill operation to the Mastercam database. True if the database commit was successful and false if not. Initializes a new instance of the CircleMillOperation class. This creates a new contour toolpath operation with default settings. Loads the default values for a given operation object from the operation structure passed in. [in,out] The operation structure to use as defaults for this operation object. Initializes a new instance of the CircleMillOperation class. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Loads the default values for a given operation. This class is used for working with Circle Mill toolpath operations. Gets or sets the Transitions page parameters (sub-page of Finishing). Gets or sets a value indicating the state of the 'Keep Tool Down' option (true/false) Gets or sets a value indicating the state of 'finish passes at ?' option. true = write the finish pass at all depths. false = write finish pass at final depth. Gets or sets the Finish (groupbox) settings used in this circle mill operation. Mastercam X7 Gets or sets the Semi-Finish (groupbox) settings used in this circle mill operation. Mastercam X7 Gets or sets a value indicating the state of enable Finishing settings. Finishing page enable/disable. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the Circle Mill specific FinishingParams parameters. Gets or sets the (Finish) spindle speed value. Gets or sets a value indicating the state of the (Finish) spindle speed override option. (true/false). Gets or sets the (Finish) feedrate value. Gets or sets a value indicating the state of the (Finish) feedrate override option. (true/false). Gets or sets the spacing used during the (Finish) passes. Gets or sets the number of (Finish) passes. Gets or sets a value indicating the state of enable the Finish option. (true/false). Finish (sub) groupbox. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the Circle Mill specific FinishingParams parameters. Gets or sets the (Semi-Finish) spindle speed value. Gets or sets a value indicating the state of the (Semi-Finish) spindle speed override option. (true/false). Gets or sets the (Semi-Finish) feedrate value. Gets or sets a value indicating the state of the (Semi-Finish) feedrate override option. (true/false). Gets or sets the spacing used during the (Semi-Finish) passes. Gets or sets the number of (Semi-Finish) passes. Gets or sets a value indicating the state of Enable the Semi-Finish settings? (true/false). Semi-Finishing (sub) groupbox. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the Circle Mill specific SemiFinishParams parameters. Gets or sets the lead-in/out overlap distance. Finishing-Transitions page. Gets or sets a value indicating the state of the 'do perpendicular entry' option. (true/false). Finishing-Transitions page. Gets or sets a value indicating the state of the 'Start at center' option. (true/false). Finishing-Transitions page. Gets or sets the entry/exit sweep angle. Finishing-Transitions page. Gets or sets a value indicating the state of the Lead-In/Out settings enabled? (true/false). Finishing-Transitions page. Gets or sets the high-speed transition angle value. Finishing-Transitions page. Gets or sets a value indicating the state of the 'high-speed entry' mode (true/false). Finishing-Transitions page. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the Circle Mill specific Transitions page parameters. Gets or sets the amount the stock leave on walls and floors. Gets or sets the circle diameter (used when circles are defined by points). Gets or sets the start angle value. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the (basic) Cut Parameter data needed to set up a CircleMkll operation. If the HelicalEntry.Enabled value is set to true, the parameters in this object will specify how the helical entry is to be set up. Gets or sets the absolute step-over distance to use while roughing. Gets or sets a value indicating the state of the 'Roughing enabled' option. (true/false). Enable/disable the entire Roughing page. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for using roughing in a Circle Mill operation. This method commits the current engrave operation to the Mastercam database. True if the database commit was successful and false if not. Initializes a new instance of the EngraveOperation class. This creates a new engrave toolpath operation with default settings. Loads the default values for a given operation object from the operation structure passed in. [in,out] The operation structure to use as defaults for this operation object. Initializes a new instance of the EngraveOperation class. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Loads the default values for a given operation object. This class is used for working with engrave toolpath operations. This method saves this object's cutter comp settings to the operation data member passed in. [in,out] The operation data member to load with cutter comp settings. This method saves this object's finish settings to the operation data member passed in. [in,out] The operation data member to load with finish settings. This method saves this object's rough/finish settings to the operation data member passed in. [in,out] The operation data member to load with rough/finish settings. This method saves this object's (basic) Cut Parameters settings to the operation data member passed in. The operation data member to load with cut parameters settings. This method loads this object's cutter comp settings from the operation data member passed in. [in,out] The operation data member to load it's cutter comp settings from. This method loads this object's finish settings from the operation data member passed in. [in,out] The operation data member to load it's finish settings from. This method loads this object's rough/finish settings from the operation data member passed in. [in,out] The operation data member to load it's rough/finish settings from. This method loads this object's (basic) Cut Parameters settings from the operation data member passed in. [in,out] The operation data member to load it's cut parameters settings from. Gets or sets the cutter comp settings to be used in this helix bore operation. Gets or sets the rough/finish parameter data to be used in this helix bore operation. Gets or sets the (basic) cut parameter data to be used in this helix bore operation. This method commits the current Helix Bore operation to the Mastercam database. true to update any points assigned to the operation. If you know that you've not altered the points used by this operation, you may wish to used this >.Commit(false). True if the database commit was successful and false if not. This method commits the current Helix Bore operation to the Mastercam database. This commit also updates any the points used by this operation. If you know that do not want the points touched during the commit, you may wish to use the .Commit(false) method overload. True if the database commit was successful and false if not. Initializes a new instance of the HelixBoreOperation class. This creates a new helix bore toolpath operation with default settings. Loads the default values for a given operation object from the operation structure passed in. [in,out] The operation structure to use as defaults for this operation object. Commits the operation. true to include, false to exclude touching the points during the commit. true if it succeeds, false if it fails. Initializes a new instance of the HelixBoreOperation class. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Loads the default values for a given operation object. This class is used for working with helix bore toolpath operations. Gets or sets the maximum tolerance to use if arc moves are not output by the operation. Gets or sets the a value indicating the state of the 'Output arc moves for helix' option. Gets or sets the Finish (groupbox) settings used in this helix bore operation. Mastercam X7 Gets or sets the final depth feedrate to use while roughing. Gets or sets the amount of step-over to use while roughing. Gets or sets the number of roughing passes used. Gets or sets the pitch angle to be used while roughing for this operation. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the Slot Mill RoughFinish specific parameters. Gets or sets the spindle speed to use while finishing. Gets or sets the feedrate to use while finishing. Gets or sets the amount of step-over to use while finishing. Gets or sets the pitch angle to be used while finishing for this operation. Gets or sets the finish method used for this operation. Gets or sets a value indicating the state of the Finish option (checkbox). This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the Helix Bore specific Finish parameters. Gets or sets the amount the stock leave on walls and floors. Gets or sets the overlap length. Gets or sets a value indicating the on/off state of the perpendicular entry option. Gets or sets a value indicating the on/off state of the start at center option. Gets or sets the entry/exit sweep angle. Gets or sets the circle diameter (used when circles are defined by points). Gets or sets the start angle value. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the (basic) Cut Parameter data needed to set up a CircleMkll operation. This enumeration specifies the different finish methods available in a Helix Bore operation. Generate a single circular cut at the bottom of the hole. Generate the helix from top to bottom. Generate the helix from bottom to top. This method saves this object's depth cuts settings to the operation data member passed in. [in,out] The operation data member to load with depth cuts settings. This method saves this object's cutter comp settings to the operation data member passed in. [in,out] The operation data member to load with cutter comp settings. This method saves this object's (basic) cut parameter settings to the operation data member passed in. [in,out] The operation data member to load with cut parameter settings. This method load this object's depth cuts settings from the operation data member passed in. [in,out] The operation data member to load with depth cuts settings. This method loads this object's cutter comp settings from the operation data member passed in. [in,out] The operation data member to load it's cutter comp settings from. This method loads this object's (basic) cut parameters settings from the operation data members passed in. [in,out] The operation data member to load it's cut parameter settings from. Gets or sets the Depth Cuts settings used in this operation. Gets or sets the cutter comp settings to be used in this operation. Gets or sets the (basic) cut parameter settings to be used in this operation. This method commits the current Facing operation to the Mastercam database. true to update any chains assigned to the operation. If you know that you've not altered the chains used by this operation, you may wish to used this >.Commit(false). True if the database commit was successful and false if not. This method commits the current Facing operation to the Mastercam database. This commit also updates any the chains used by this operation. If you know that do not want the chains touched during the commit, you may wish to use the .Commit(false) method overload. True if the database commit was successful and false if not. Initializes a new instance of the FacingOperation class. This creates a new facing toolpath operation with default settings. Loads the default values for a given operation object from the operation structure passed in. [in,out] The operation structure to use as defaults for this operation object. Commits the operation. true to include, false to exclude touching the chains during the commit. true if it succeeds, false if it fails. Initializes a new instance of the FacingOperation class. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Loads the default values for a given operation object. This class is used for working with facing toolpath operations. Gets or sets the amount the stock leave on walls and floors. Gets or sets the feedrate to use between cuts (if enabled). Gets or sets the a value indicating the state of the 'Feedrate between cuts' option (checkbox). Gets or sets the 'Move Between Cuts' method. (ZigZag ONLY). Gets or sets the roughing angle. Gets or sets a value indicating the state of the Auto Angle option (checkbox). Gets or sets a value indicating the state of the 'Reverse direction on last pass' option. Gets or sets a value indicating the state Climb/Conventional cut direction option. Gets or sets the maximum of step-over to use. Gets or sets the general starting location. Gets or sets the exit distance. Gets or sets the approach distance. Gets or sets the 'along' direction overlap. Gets or sets the 'across' direction overlap. Gets or sets the cut 'style' to be used. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the Facing specific parameters. This enumeration specifies the "general start location" to be used for the Facing operation. * When the Facing Style is set to 'Dynamic'. This enumeration specifies the different "motion between cuts" options available in a facing operation. Generate rapid moves between each cut. Generate linear feed moves between each cut. Generate 180 degree arc moves between each cut. This enumeration specifies the different cut style methods available in a Facing operation. Generate motion that cuts from the outside to the inside (Constant Engagement). Generate one-way motion in a single direction. As defined by the selected cutting direction: Climb or Conventional. Generate motion that creates a single pass down the center. Generate zig-zag back and forth motion. This method load this object's tabs settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with tabs settings. This method load this object's smoothing settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with smoothing settings. This method load this object's arc filter settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with arc filter settings. This method loads this object's 'tolerance distribution' settings (from the Arc Filter / Tolerance page) from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with tolerance settings. This method load this object's break through settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with break through settings. This method load this object's depth cuts settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with depth cuts settings. This method load this object's multi-pass settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with multi-pass settings. This method load this object's lead-on/out settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with lead-in/out settings. This method loads this object's 'Adjust end of contour'' settings from the operation data member passed in. Mastercam X7. The operation data member to load with lead-in/out entry settings. This method loads this object's 'Adjust start of contour'' settings from the operation data member passed in. Mastercam X7. The operation data member to load with lead-in/out entry settings. This method load this object's lead-on/out 'exit' settings from the operation data member passed in. Mastercam X7. The operation data member to load with lead-in/out exit settings. This method loads this object's lead-on/out 'entry' settings from the operation data member passed in. Mastercam X7. The operation data member to load with lead-in/out entry settings. This method loads this object's oscillation settings from the operation data member passed in. [in,out] The operation data member to load it's oscillation settings from. This method loads this object's re-machining settings from the operation data member passed in. [in,out] The operation data member to load it's re-machining settings from. This method loads this object's ramp settings from the operation data member passed in. [in,out] The operation data member to load it's ramp settings from. This method loads this object's chamfer settings from the operation data member passed in. [in,out] The operation data member to load it's chamfer settings from. This method loads this object's cutter comp settings from the operation data member passed in. [in,out] The operation data member to load it's cutter comp settings from. This method loads this object's (basic) Cut Parameters settings from the operation data member passed in. [in,out] The operation data member to load it's cut parameters settings from. This method saves this object's 'tabs' settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with tabs settings. This method saves this object's 'smoothing' settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with smoothing settings. This method saves this object's 'arc filter' settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with arc filter settings. This method saves this object's 'tolerance distribution' settings (from the Arc Filter / Tolerance page) to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with tolerance settings. This method saves this object's break through settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with break through settings. This method saves this object's depth cuts settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with depth cuts settings. This method saves this object's multi-pass settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with multi-pass settings. This method saves this object's lead-on/out settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with lead-in/out settings. This method saves this object's 'Adjust end of contour' settings from the operation data member passed in. Mastercam X7. [in,out] The operation data member to load with adjust end of contour settings. This method saves this object's 'Adjust start of contour' settings from the operation data member passed in. Mastercam X7. [in,out] The operation data member to load with adjust start of contour settings. This method saves this object's (lead-in/out) Exit settings to the operation data member passed in. [in,out] The operation structure to use as defaults for this operation object. This method saves this object's (lead-in/out) Entry settings to the operation data member passed in. [in,out] The operation structure to use as defaults for this operation object. This method saves this object's oscillation settings to the operation data member passed in. [in,out] The operation data member to load with oscillation settings. This method saves this object's re-machining settings to the operation data member passed in. [in,out] The operation data member to load with re-machining settings. This method saves this object's ramp settings to the operation data member passed in. [in,out] The operation data member to load with ramp settings. This method saves this object's chamfer settings to the operation data member passed in. [in,out] The operation data member to load with chamfer settings. This method saves this object's cutter comp settings to the operation data member passed in. [in,out] The operation data member to load with cutter comp settings. This method saves this object's (basic) Cut Parameters settings to the operation data member passed in. The operation data member to load with cut parameters settings. Gets or sets the internal contour sub-type member. Gets or sets the Tabs settings used in this contour operation. Mastercam X7 Gets or sets the Smoothing settings used in this contour operation. Mastercam X7 Gets or sets the Arc Filter settings used in this contour operation. Mastercam X7 Gets or sets the Tolerance Distribution settings used in this operation. Arc Filter / Tolerance page Gets or sets the Break Through settings used in this contour operation. Mastercam X7 Gets or sets the Depth Cuts settings used in this contour operation. Mastercam X7 Gets or sets the Multi-Passes settings used in this contour operation. Mastercam X7 Gets or sets the Lead-In/Out settings used in this contour operation. Mastercam X7 The Exit (sub-data of Lead-In/Out) settings used in this contour operation. Mastercam X7 The Entry (sub-data of Lead-In/Out) settings used in this contour operation. Mastercam X7 The Oscillation data to be used in this contour operation if the toolpath gets set to an oscillation contour subtype. The Re-Machining data to be used in this contour operation if the toolpath gets set to a re-machining contour subtype. The Ramp settings to be used in this contour operation if the toolpath gets set to a ramp contour subtype. The Chamfer settings to be used in this contour operation if the toolpath gets set to a chamfer contour subtype. The cutter comp settings to be used in this contour operation. Gets or sets the (basic) cut parameter data to be used in this contour operation. This is the contour subtype being used in the current contour toolpath operation. Trying to assign a 2D subtype to a contour operation with 3D chain geometry will result in an exception, and vice-versa. Use the ChainManager::IsChain2D() method to ensure you assign the appropriate contour subtypes. This method takes the array passed in and copies it's contents into the internal chain array for this operation. If 2D chain geometry is passed in and the contour operation has a 3D subtype it will be automatically updated to a Basic2D subtype and vice-versa. The array of new chains. This method examines whether or not a contour subtype is a valid 3D subtype. The contour subtype value to test. True if the subtype is a valid 3D subtype, else false if not. This method examines whether the contour subtype in the current operation is a valid 3D subtype. True if the subtype is a valid 3D subtype, False if not. This method examines whether or not a contour subtype is a valid 2D subtype. The contour subtype value to test. True if the subtype is a valid 2D subtype, else false if not. This method examines whether the contour subtype in the current operation is a valid 2D subtype. True if the subtype is a valid 2D subtype, else false if not. This method commits the current Contour operation to the Mastercam database. true to update any chains assigned to the operation. If you know that you've not altered the chains used by this operation, you may wish to used this >.Commit(false). True if the database commit was successful and false if not. This method commits the current Contour operation to the Mastercam database. This commit also updates any the chains used by this operation. If you know that do not want the chains touched during the commit, you may wish to use the .Commit(false) method overload. True if the database commit was successful and false if not. Initializes a new instance of the ContourOperation class. This creates a new contour toolpath operation with default settings. Loads the default values for a given operation object from the operation structure passed in. [in,out] The operation structure to use as defaults for this operation object. Commits the operation. true to include, false to exclude touching the chains during the commit. true if it succeeds, false if it fails. Initializes a new instance of the ContourOperation class. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Loads the default values for a given operation object. This class is used for working with contour toolpath operations. Gets or sets the maximum distance between tabs (for auto tab). Gets or sets a value indicating the tab distance mode: true = auto tab by distance, false = auto tab by # tabs. (only used if AutomaticPosition is set = true) Gets or sets a value indicating if the tabs should be cut-off on the first finish pass. Gets or sets a value indicating the tab cut-off type - (None, AfterAll, AfterEach, SeparateOp). Gets or sets a value indicating the to 'Overwrite tab edit changes'. Gets or sets a value indicating the to 'Tab All'. Gets or sets the Y dimension of maximum size shape to tab. Gets or sets the X dimension of maximum size shape to tab. Gets or sets a value indicating to use points on the chain for start and tab positions. Gets or sets a value indicating to use the Feed Plane for full height tabs. Gets or sets a value indicating to use the Advanced Auto Tab Positioning. Gets or sets the Ramp Angle to use for the tab entry/exit mode = Ramp. Gets or sets the Arc Radius to use for the tab entry/exit mode = Arc. Gets or sets a value indicating the tab entry/exit mode - (Vertical or Ramp). Gets or sets a value indicating the (manual) tab position option - (Start, Midpoint, End). Gets or sets a value indicating the selection state of the Tab Motion (full or partial) option. Gets or sets the Tab Thickness. Gets or sets the Tab Width. Gets or sets a the number of tabs (for auto tabs). Gets or sets a value indicating the on/off state of the Automatic option. Gets or sets a value indicating the on/off state of the Tabs (checkbox). This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for Tabs in a Contour operation. This enumeration specifies the different Tab Cut-Off settings of a contour toolpath operation. This enumeration specifies the different Tab Entry/Exit settings of a contour toolpath operation. This enumeration specifies the different Tab Position settings of a contour toolpath operation. Gets or sets the Taper Wall Angle (If Tapered Walls is enabled). Gets or sets a value indicating the on/of state of the Taper Walls option (checkbox). Gets or sets a value indicating the Depth Cut Order mode. true = 'by depth', else false = 'by contour'. Gets or sets a value indicating the Subprogram Incremental/Absolute setting If true, incremental subprograms will be used, else false for absolute subprograms. Gets or sets a value indicating the on/off state of the Subprogram option (checkbox). Gets or sets a value indicating the on/off state of the Keep Tool Down option. If true, the operation will generate a toolpath where the tool is kept down. Gets or sets the finishing step value to use. Gets or sets the number of finishing cuts to make. Gets or sets the maximum roughing step value. Gets or sets a value indicating the on/off state of the depth Cuts (checkbox). This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for Depth Cuts in a Contour operation. Gets or sets a value indicating the on/off state of the 'Keep Tool Down' option. If true, the operation will generate a toolpath where the tool is kept down. Gets or sets a value indicating whether to do finish passes at the final depth. true = final depth, else false = all depths Gets or sets the finish cut spacing. Gets or sets the number of finish cuts. Gets or sets the rough cut spacing. Gets or sets the number of rough cuts. Gets or sets a value indicating if the Multi-Passes parameters page is enabled. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to set up the Multi-Passes gage on a Contour operation. Mastercam X7. Gets or sets the oscillation distance to use in this oscillation contour toolpath operation. Gets or sets the maximum depth value to use in this oscillation contour toolpath operation. Gets or sets the type of oscillation movement used in this oscillation contour toolpath operation. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to set up Oscillation in a Contour operation. This enumeration specifies the different rules for how an NC file name is found and created. A parabolic, high-speed oscillation movement. A linear oscillation movement. Gets or sets a value indicating whether or not to display the stock during the generation of this contour toolpath. Gets or sets the tolerance value to use in this Re-machining Contour operation. Gets or sets the re-machining clearance value to use in this Re-machining Contour operation. Gets or sets the diameter of the roughing tool to use for remaining stock computation. Note that this value is only used if the RemainingStockMethod type is set to RoughingToolDiameter. Gets or sets the method for computing remaining stock in a re-machining contour operation. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to set up a Contour Re-machining operation. Gets or sets a value indicating whether to incorporate a pass at the final depth in this ramp contour operation. Note that this value is only used if the MotionType type is set to DepthMotion. Gets or sets a value indicating whether to use one way ramping for open contours in this ramp contour operation. Note that this value is only used if the MotionType type is set to DepthMotion or AngleMotion. Gets or sets the depth value to use for the ramp contour operation. Note that this value is only used if the MotionType type is set to DepthMotion or PlungeMotion. Gets or sets the angle to use for the ramp contour operation. Note that this value is only used if the MotionType type is set to AngleMotion. Gets or sets the type of ramp motion to use in the ramp contour operation. Gets or sets the value that specifies the tolerance used for linearizing the helixes. If the LinearizeHelixes flag is on. Gets or sets a value indicating whether or not to linearize helixes in the ramp toolpath. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to set up a Contour Ramp operation. This enumeration specifies the different types of ramp motion used in 2D Contour toolpath. Use plunge motion in a Contour Ramp toolpath. Use depth motion in a Contour Ramp toolpath. Use angled motion in a Contour Ramp toolpath. Gets or sets the depth value to use if the contour operation's tool is an end mill. Gets or sets the amount of offset to be taken into consideration due to the size of the tool tip. Gets or sets the width of the chamfer to put be applied via toolpath. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to set up a Contour Chamfer operation. Gets or sets the amount the stock leave on walls and floors. Gets or sets the 'Max Depth Variance' setting. Gets or sets the External Corner Break Radius. Gets or sets the Internal Corner Rounding Radius. Gets or sets a value indicating the on/off state of the Infinite Look Ahead option. Gets or sets the contour subtype being used in the current contour toolpath operation. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the (basic) Cut Parameter data needed to set up a Contour operation. This enumeration specifies the different sub-types of a contour toolpath operation. A 2D oscillating contour operation. A 2D re-machining contour operation. A 2D ramp motion contour operation. A 3D chamfer contour operation. A 2D chamfer contour operation. A basic 3D contour operation. A basic contour operation (2D or 3D). This method load this object's high-speed settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with high-speed settings. This method load this object's break through settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with break through settings. This method load this object's depth cuts settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with depth cuts settings. This method loads this object's open pocket settings from the operation data member passed in. [in,out] The operation data member to load it's open pocket settings from. This method loads this object's re-machining settings from the operation data member passed in. [in,out] The operation data member to load it's re-machining settings from. This method loads this object's facing settings from the operation data member passed in. [in,out] The operation data member to load it's facing settings from. This method loads this object's (finishing) Lead-In/Out settings from the operation data member passed in. [in,out] The operation data member to load it's (finishing) Lead-In/Out settings from. This method loads this object's finishing exit settings from the operation data member passed in. [in,out] The operation data member to load it's finishing exit settings from. This method loads this object's finishing entry settings from the operation data member passed in. [in,out] The operation data member to load it's finishing entry settings from. This method loads this object's finishing settings from the operation data member passed in. [in,out] The operation data member to load it's finishing settings from. This method loads this object's roughing entry motion settings from the operation data member passed in. [in,out] The operation data member to load it's roughing entry motion settings from. This method loads this object's roughing entry (ramp) motion settings from the operation data member passed in. [in,out] The operation data member to load it's roughing entry (ramp) motion settings from. This method loads this object's roughing entry (helix) motion settings from the operation data member passed in. [in,out] The operation data member to load it's roughing entry (helix) motion settings from. This method loads this object's roughing settings from the operation data member passed in. [in,out] The operation data member to load it's roughing settings from. This method loads this object's (basic) Cut Parameters settings from the operation data member passed in. [in,out] The operation data member to load it's cut parameters settings from. This method saves this object's high-speed settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with high-speed settings. This method saves this object's break through settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with break through settings. This method saves this object's depth cuts settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with depth cuts settings. This method saves this object's open pocket settings to the operation data member passed in. [in,out] The operation data member to load with open pocket settings. This method saves this object's re-machining settings to the operation data member passed in. [in,out] The operation data member to load with re-machining settings. This method saves this object's facing settings to the operation data member passed in. [in,out] The operation data member to load with facing settings. This method saves this object's (finishing) Lead-In/Out settings to the operation data member passed in. [in,out] The operation data member to load with (finishing) Lead-In/Out settings. This method saves this object's finishing exit settings to the operation data member passed in. [in,out] The operation data member to load with finishing exit settings. This method saves this object's finishing entry settings to the operation data member passed in. [in,out] The operation data member to load with finishing entry settings. This method saves this object's finishing settings to the operation data member passed in. [in,out] The operation data member to load with finishing settings. This method saves this object's roughing entry motion settings to the operation data member passed in. [in,out] The operation data member to load with roughing entry motion settings. This method saves this object's roughing entry (ramp) motion settings to the operation data member passed in. [in,out] The operation data member to load with roughing entry (ramp) motion settings. This method saves this object's roughing entry (helix) motion settings to the operation data member passed in. [in,out] The operation data member to load with roughing entry (helix) motion settings. This method saves this object's roughing settings to the operation data member passed in. [in,out] The operation data member to load with roughing settings. This method saves this object's (basic) Cut Parameters settings to the operation data member passed in. [in,out] The operation data member to load with cut parameters settings. Gets or sets the (Roughing page) Trochoidal Cuts settings used in this pocket operation. Mastercam X7 Gets or sets the Break Through settings used in this pocket operation. Mastercam X7 Gets or sets the Depth Cuts settings used in this pocket operation. Mastercam X7 Gets or sets the (Finish) Lead-In/Out settings used in this pocket operation. Mastercam X7 Gets or sets the Finish settings used in this pocket operation. Mastercam X7 Gets or sets the Roughing Entry Motion used in this pocket operation. Mastercam X7 Gets or sets the Roughing settings used in this pocket operation. Mastercam X7 Gets or sets the open pocket data to be used in this pocket operation if the toolpath is set to an open pocket subtype. Gets or sets the re-machining data to be used in this pocket operation if the toolpath is set to a re-machining pocket subtype. Gets or sets the facing data to be used in this pocket operation if the toolpath is set to a facing pocket subtype. Gets or sets the (basic) cut parameter data to be used in this pocket operation. This method commits the current Pocket operation to the Mastercam database. true to update any chains assigned to the operation. If you know that you've not altered the chains used by this operation, you may wish to used this >.Commit(false). True if the database commit was successful and false if not. This method commits the current Pocket operation to the Mastercam database. This commit also updates any the chains used by this operation. If you know that do not want the chains touched during the commit, you may wish to use the .Commit(false) method overload. True if the database commit was successful and false if not. Initializes a new instance of the PocketOperation class. This creates a new pocketing toolpath operation with default settings. Loads the default values for a given operation object from the operation structure passed in. [in,out] The operation structure to use as defaults for this operation object. Commits the operation. true to include, false to exclude touching the chains during the commit. true if it succeeds, false if it fails. Initializes a new instance of the PocketOperation class. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Loads the default values for a given operation object. This class is used for working with pocketing toolpath operations. Gets or sets the Corner Smoothing Radius to use on the Trochoidal cuts . Gets or sets the Loop Spacing of the Trochoidal cuts . Gets or sets the Loop Radius of the Trochoidal cuts . Gets or sets a value indicating the on/off state of the Trochoidal Cuts option. 0=Off, 1=Full material only, or 2=Entire pocket This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for Trochoidal Cuts settings in a Pocket operation. Only used with the Pocket 'High-Speed' cutting method. Gets or sets the (Finishing) Lead-In/Out Exit settings. Gets or sets the (Finishing) Lead-In/Out Entry settings. Gets or sets the Overlap distance. Gets or sets a value indicating if the Lead In/Out parameters page is enabled. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to set up the Lead-In/Out on a Pocket operation. Mastercam X7 Gets or sets the Thin Wall settings for the Pocket. Only used if both of these options are enabled: Machine finish passes only at final depth, and Machine finish pass after roughing all pockets. Gets or sets the Override Spindle Speed. Gets or sets the Override Feedrate. Gets or sets a value indicating the on/off state of the 'Spindle Speed Override' option (checkbox). Gets or sets a value indicating the on/off state of the 'Feedrate Override' option (checkbox). Gets or sets a value indicating the on/off state of the 'Machining finish pass after roughing all pockets' option (checkbox). Gets or sets a value indicating the on/off state of the 'Machining finish passes only at final depth' option (checkbox). Gets or sets a value indicating the type of Cutter Compensation to use on the finish pass. Gets or sets a value indicating the on/off state of the 'Optimize cutter comp in control' option (checkbox). Gets or sets a value indicating the on/off state of the 'Keep tool down' option (checkbox). Gets or sets a value indicating the on/off state of the 'Start finish pass at closest entity' option. Gets or sets a value indicating the on/off state of the 'Finish outer boundary' option. Gets or sets the number of spring passes. Gets or sets the finish pass spacing. Gets or sets the number of finish passes. Gets or sets a value indicating the on/off state of the Finish Cuts (checkbox). This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for Finishing (page) settings in a Pocket operation. Gets or sets a value indicating the state of the 'Climb / Conventional' setting. true = climb cut, else false = conventional Gets or sets the number of finish passes. Gets or sets a value indicating the on/off state of the Thin Wall option (checkbox). This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for Finishing (page) Thin Wall settings in a Pocket operation. Gets or sets the 'Tolerance for remachining and constant overlap spiral'. Gets or sets a value indicating the on/off state of the 'Minimize tool burial' option (checkbox). Gets or sets a value indicating the on/off state of the 'Display stock for constant overlap spiral' option. Gets or sets a value indicating the on/off state of the 'Spiral inside to outside' option. Gets or sets the roughing angle. Gets or sets the rough step-over distance. Gets or sets a value indicating the Cutting Method. Gets or sets a value indicating the on/off state of the Rough Cuts (checkbox). This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for Roughing (page) settings in a Pocket operation. Gets or sets the Ramp Entry settings used for the pocket roughing entry. Only valid of the EntryMode is 'Ramp'. Gets or sets the Helix Entry settings used for the pocket roughing entry. Only valid of the EntryMode is 'Helix'. Gets or sets the Entry Motion option setting used for the pocket roughing entry. Off, Ramp or Helix. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for the rough entry motion of a pocket operation. Gets or sets a value indicating which feedrate to use for the entry motion. If true, then use the plunge rate, else use the regular feedrate. Gets or sets a value indicating whether to 'Save the skipped boundary' if all entry attempts fail. Gets or sets a value indicating specifies what to do if the helical entry fails. If true, then plunge, else skip the entry altogether. Gets or sets a value indicating the state of the 'Ramp from entry point' option. Gets or sets a value indicating the state of the 'Align ramp with entry point' option. Gets or sets the'Additional slot width' value. Gets or sets the 'XY angle' value. Gets or sets a value indicating the state of the 'Auto angle' option. Gets or sets the ramp entry's plunge zag angle. Gets or sets the ramp entry's plunge zig angle. Gets or sets the Z clearance to be used in the helical entry. Gets or sets the XY clearance to be used in the helical entry. Gets or sets the maximum length to be used in the ramp entry. Gets or sets the minimum length to be used in the ramp entry. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for the rough entry motion of a pocket operation. Gets or sets a value indicating which feedrate to use for the entry motion. If true, then use the plunge rate, else use the regular feedrate. Gets or sets a value indicating whether to 'Save the skipped boundary' if all entry attempts fail. Gets or sets a value indicating specifies what to do if the helical entry fails. If true, then plunge, else skip the entry altogether. Gets or sets a value indicating the 'Direction' (CW or CCW) . Gets or sets the minimum boundary length (for follow boundary). Gets or sets a value indicating the state of the 'On failure only' option (Follow boundary). Gets or sets a value indicating the state of the 'Follow boundary' option. Gets or sets a value indicating the state of the 'Center on entry point' option. Gets or sets the maximum tolerance uses if arc moves are not output by the operation. Gets or sets a value indicating the state of the 'Output arc moves' option. Gets or sets the helical entry's plunge angle. Gets or sets the Z clearance to be used in the helical entry. Gets or sets the XY clearance to be used in the helical entry. Gets or sets the maximum radius to be used in the helical entry. Gets or sets the minimum radius to be used in the helical entry. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for the rough entry motion of a pocket operation. Gets or sets the Taper Angle on Islands (If Tapered Walls is enabled). Gets or sets the Taper Angle on Walls (If Tapered Walls is enabled). Gets or sets a value indicating the on/of state of the Taper Walls option (checkbox). Gets or sets a value indicating the Depth Cut Order mode. true = 'by depth', else false = 'by contour'. Gets or sets a value indicating the Subprogram Incremental/Absolute setting If true, incremental subprograms will be used, else false for absolute subprograms. Gets or sets a value indicating the on/off state of the Subprogram option (checkbox). Gets or sets a value indicating the on/off state of the Use Island Depths option. Gets or sets a value indicating the on/off state of the Keep Tool Down option. If true, the operation will generate a toolpath where the tool is kept down. Gets or sets the finishing step value to use. Gets or sets the number of finishing cuts to make. Gets or sets the maximum roughing step value. Gets or sets a value indicating the on/off state of the depth Cuts (checkbox). This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for Depth Cuts in a Pocket operation. Gets or sets a value indicating whether to use standard pocketing for any closed chains in this open pocket operation. Gets or sets a value indicating whether to use the open pocket cutting method. Gets or sets the distance to use for overlaps in pocket passes. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to set up a Pocket Open operation. Gets or sets the a value indicating whether or not to display the stock during the generation of this pocket toolpath. Gets or sets the a value indicating whether or not to machine completely finish passes in this pocket toolpath. Gets or sets a value indicating whether or not to apply entry and exit curves to roughing passes. Gets or sets the re-machining clearance value to use in this Re-machining Pocket operation. Gets or sets the diameter of the roughing tool to use for remaining stock computation. Note that this value is only used if the RemainingStockMethod type is set to RoughingToolDiameter. Gets or sets the parameter that specifies the method for computing remaining stock in a re-machining pocket operation. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to set up a Pocket Re-machining operation. Gets or sets the amount of stock above any islands. Note that this value is only used if the PocketSubtye value is set to IslandFacing. Gets or sets the amount of exit distance to apply to this facing or island facing toolpath operation. Gets or sets the amount of approach distance to apply to this facing or island facing toolpath operation. Gets or sets the amount of overlap to use in this facing or island facing toolpath operation. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to set up a Pocket facing toolpath operation. Gets or sets the amount the stock leave on walls and floors. Gets or sets a value indicating the state of the 'Create additional finish operation' option. Gets or sets the 'Linearization Tolerance' settings. Gets or sets a value indicating the state of the 'Roll Cutter Around Corners setting. Gets or sets a value indicating the state of the 'Tip Comp' (Tip or Center). true = comp to tip, else comp to center Gets or sets a value indicating the Machine Direction (Climb or Conventional). Gets or sets the pocket subtype being used in the current pocket toolpath operation. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the (basic) Cut Parameter data needed to set up a Pocket operation. This enumeration specifies the different types of Roughing - Helix Entry Motion directions. Roughing - Entry Motion = CCW Helix. Roughing - Entry Motion = CW Helix. This enumeration specifies the different types of Roughing - Entry Motion in a pocket operation. Roughing - Entry Motion = Off. Roughing - Entry Motion = Ramp. Roughing - Entry Motion = Helix. This enumeration specifies the different sub-types of a pocket toolpath operation. An open pocket toolpath operation. A re-machining pocket toolpath operation. An island facing pocket toolpath operation. A facing pocket toolpath operation. A standard pocket toolpath operation. Gets the length of the Spline curve. In order to retrieve this information the Spline entity MUST be Committed to Mastercam's database. (If that cannot be done, this will return a value of -1.0) Gets the number of segments in the Spline curve. In order to retrieve this information the spline entity MUST be Committed to Mastercam's database. (If that cannot be done, this will return a value of 0) In Mastercam when you Analyze a Parametric Spline entity the 'Nodes' value displayed is this data + 1. Gets the maximum curvature of the Spline curve. In order to retrieve this information the Spline entity MUST be Committed to Mastercam's database. (If that cannot be done, this will return a value of -1.0) Gets the degree of the Spline curve. In order to retrieve this information the Spline entity MUST be Committed to Mastercam's database. (If that cannot be done, this value will be -1.) Gets a value indicating if the Spline curve is 'closed' (endpoints are equal). Gets or sets the list of node points used to create the parametric Spline curve. These are the user supplied points used at the time creation of the Spline Curve. If the entity was NOT "user created" (it was "pulled" from Mastercam's database), this list will be empty! Gets the last point in the current parametric Spline curve. Gets the first point in the current parametric Spline curve. Gets the Spline data associated with this SplineGeometry. Initializes a new instance of the SplineGeometry class. Creates a new SplineGeometry object based off of the supplied list of points. The point data to create this SplineGeometry object. Initializes a new instance of the SplineGeometry class. Creates a new SplineGeometry object based off of the values in the specified spline math object. The spline data to create this SplineGeometry object. Initializes a new instance of the SplineGeometry class. Creates new spline geometry with default values - 2 node points - one at (0,0,0) and one at (1,0,0) and in the current construction view. Gets the entity from Mastercam's database. [out] The entity. true if it succeeds, false if it fails. The method does the actual creation of the Spline Entity. The node points of the Spline. [out] The spline entity. True if it succeeds, else false. LoadDefaults (Override) This handles the loading of defaults from a Mastercam entity. The entity to load the object's default values from. Commit (Override) This handles the committing of the object's data to the Mastercam database. The entity that will hold all the data being sent to the Mastercam database. Initializes a new instance of the SplineGeometry class. Creates a new object from the ID of an entity in the Mastercam database. The ID of the Mastercam entity to create the new object from. This class is used for working with spline curve geometry within Mastercam. Checks whether the given database pointer is considered not deleted (it must be valid to be not deleted). Database pointer to check. True if the database pointer is considered not deleted, or false if it is deleted or invalid. Gets the previous eptr. The eptr. The previous eptr. Gets the next eptr. The eptr. The next eptr. Traverses the database linked list forward starting from the given database pointer. This replaces direct access to DB_LIST_ENT::next. New code should NOT be taking dependency on internal database order. This should only be used to support existing code and concepts which already depend on the order. Database pointer from which the traversal will start. Selection bit mask to decide which entities are processed (all specified bits must be set), or no value if selection bits should be ignored. Entity type mask to decide which entities are processed, or no value if all entity types should be processed. Function which processes the entities and determines the traversal result. Traverses the database linked list backward starting from the given database pointer. This replaces direct access to DB_LIST_ENT::prev. New code should NOT be taking dependency on internal database order. This should only be used to support existing code and concepts which already depend on the order. Database pointer from which the traversal will start. Selection bit mask to decide which entities are processed (all specified bits must be set), or no value if selection bits should be ignored. Entity type mask to decide which entities are processed, or no value if all entity types should be processed. Function which processes the entities and determines the traversal result. Result of a traversal operation. @par Purpose: Read an open STL file and create lines @param[in] fp Pointer to the open STL file @param[in] fname Name of the open STL file @param[out] interrupted true if the read was interrupted by the user @param[in] scaleFactor (Optional) scale factor (default = 1.0). Write STL stream. The error tolerance. Stream to write data to. The entities. Set to true if the data is to be written in ASCII text. Write STL stream. The error tolerance. Stream to write data to. The entities. Set to true if the data is to be written in ASCII text. Set to true to output STL relative to CPlane view and origin (false is world coordinates). True to show, false to hide the ok if not. True if ok if blanked. @par Purpose: Write the database to an open STL file @param[in] err_tol error tolerance value @param[in] f Pointer to the open STL file @param[in] fname Name of the open STL file @param[in] ent_idn Specific entity to output or if '0', output all, or if '-1', output only selected entities @param[in] ascii_data Set to true if the data is to be written in ASCII text @param[in] silent Set to true if no warnings, progress reports, or messages are to be presented to the user This outputs to world coordinates. @par Purpose: Write the database to an open STL file @param[in] err_tol error tolerance value @param[in] f Pointer to the open STL file ( Must be opened for binary writing if ascii_data == false) @param[in] fname Name of the open STL file @param[in] ent_idn Specific entity to output or if '0', output all, or if '-1', output only selected entities @param[in] ascii_data Set to true if the data is to be written in ASCII text @param[in] silent Set to true if no warnings, progress reports, or messages are to be presented to the user @param[in] use_wcs Set to true to output STL relative to CPlane view and origin (false is world coordinates) @param[in] okIfNotVisible Set to true if solid is not currently on a visible level @param[in] okIfBlanked Set to true if solid/surf/pmesh is blanked Gets the full path of a Mastercam registry sub key. Sub key path. Full path of a Mastercam registry sub key. Perform a file/save operation. This method is usually called from the SaveFile() interface. It may be called directly to bypass the File/Save dialog. Internal implementation of CFile_DoFileSave function available in the SDK with an additional parameter isSavingMainFile which is not intended to be exposed since it should only be set to true when saving from the root level UI functions in Mastercam. MUST be complete path to the file. Pointer to the dialog's parent window. Check for Machine Def in the database and prompt user if required (default = true). See if we're about to overwrite an existing file (default = true). True if saving the main file session through File->Save or File->Save As. True if the file saves successfully, otherwise false. Perform a File/Save operation, first displaying the File/Save dialog. Internal implementation of SaveFile function available in the SDK with an additional parameter isSavingMainFile which is not intended to be exposed since it should only be set to true when saving from the root level UI functions in Mastercam. MUST be complete path to the file. Pointer to the dialog's parent window. True == get the file name, but don't save the file (default = false). True if saving the main file session through File->Save or File->Save As. True if OK, otherwise false. Look to see if a SolidWorks file contains Mastercam data saved by MCforSW. Full path to SolidWorks file. true if SolidWorks file contains Mastercam data, false otherwise. Are we currently reading Mastercam part info from a SolidWorks file?. True if we are, otherwise false. Sets the 'replace machine warning dialog' flag. True to set, false to clear. Should we show the 'replace machine warning' dialog in import? True if we should, false if we should not. Sets the 'replace machine Y/N dialog' flag. True to set, false to clear. Should we show the 'replace machine Y/N' dialog in import? True if we should, false if we should not. Sets the 'show axis combo dialog in import' flag. True to set, false to clear. Should we show the 'axis combo' dialog in import? True if we should, false if we should not. Sets 'in directory import export' value. Must be ImportDir, ExportDir, or Neither. Gets 'in directory import export' value. ImportDir, ExportDir, or Neither. Prompt for the name of a Mesh file (.STL, .3MF, .OBJ, .AMF). if true, prompt for a file to open, if false, prompt for a file to save. default file name (or an empty string to allow use of previously selected filename. true if a file was successfully chosen, false otherwise. Copy any missing or updated add-on files to 'Shared Defaults' folder. Opens the file at fileName, returns a pointer to an AutoCloseFile class which will close the file when it goes out of scope. Full path of file name to open. Type of access permitted. (Optional) file position to set file pointer once open. (Optional) SEEK_SET, etc. (Optional) Type of sharing allowed. A std::shared_ptr<AutoCloseFile> Return the value of m_OpenSuccessful. Return the value of m_OpenSuccessful. Destructor. Constructor. Full path of file name to open. Type of access permitted. (Optional) file position to set file ptr once open. (Optional) SEEK_SET, etc. Type of sharing allowed. Class to open the file and close upon destruction of this class. Backup a file to a sub-folder. Full path to the file. (Optional) name of the sub-folder. If missing, a default name will be used. (Optional) if true (the default), no need to tell the user what we're doing. (Optional) Parent who will own the message box (if we display one). (Optional) If non-zero, use this version instead of inspecting the given file (default = 0). true if a backup copy was made, otherwise false. Sets the current working directory. New working directory. Gets the current working directory. The current working directory. Display the File Editor selection dialog box. True if user picks an editor, false if they cancel. Compare two text files. This function is used in ATF testing. The first file name. The second file name. -1 = fileName1 not found, -2 = fileName2 not found, 0 = identical, otherwise the line number of the first failure. Compare two part files. This function is used in ATF testing. File name of the current file. File name of the baseline file. The compare options. -2 --> Couldn't find baselineFileName -1 --> Couldn't find currentFileName 0 --> Failure... importing currentFileName does not match baseline MCX file. 1 --> Success... importing currentFileName matches baseline MCX file. Options for Compare two part files. Given a file name with an old extension, return the equivalent current-version extension. The input string may be just the extension, with or without the '.', or may be a fully qualified file name with an extension. If there is no '.' in the string, the entire string will be assumed to be an extension unless it contains a '/', '\', or ':'. Output: The output extension will be preceded by '.'. Extension or file name with an older Mastercam extension. The current version extension, preceded by a '.'. Free the previously allocated SolidWorks wizard hole data. The data buffer to free. Provide access to the GetSolidWorksWizardHoleData() function inside ImportExport\MCSolidWorks.Dll. ImportExport\MCSolidWorks.Dll extern "C" void __declspec( dllexport ) GetSolidWorksWizardHoleData( HINSTANCE *hInstRes, TCHAR *swPartFile, BOOL *foundSW, struct wizHole **firstHole); Name of the SolidWorks file. Returned - True if SolidWorks call completes. Wizard hold data. Gets the list of communications package names from the registry. List of communication package friendly names. List of communication package programs. List of start-in paths. (Optional) List of send arguments (default = nullptr). (Optional) List of receive arguments (default = nullptr). (Optional) List of setup arguments (default = nullptr). (Optional) List of prompts (default = nullptr). The number of entries. Get the list of setup-sheet names from the registry. List of setup-sheet friendly names. List of setup-sheet programs. List of start-in paths. The number of entries. Get the list of editor names from the registry. List of editor friendly names. List of editor programs. List of start-in paths. The number of entries. Open a file or list of files in an editor. This method calls the default editor to begin editing the passed file(s). The list is checked to see if it has file names. This function is only called after posting. The post setncstr function populates EditorSettings. The pFileName parameter is the passed NC file to open if NOT using EditorSettings. The file 'wait' parameter is true on send to machine from batch, false from bug1$ launch in MPXRunMain. The default file to edit. (Optional) True to wait until the editor closes (default = false). Run the wire display generator for the given operation. The operation to generate NCI for. True if successful generation, otherwise false. Call the setup_sheet function. Counts the number of entities of type SS_POINTS in the display list. The total number of visible entities of type SS_POINTS. Counts the number of entities of a given type in the display list. One of the SS_ defines used by screen_statistics(); e.g., SS_POINTS . The total number of visible entities of the given type. Generate a temporary file name for ram saver cleanup. The ram saver cleanup file name. Reduce RAM requirements. Reduce the RAM requirements of the currently open MC File by compressing the file to eliminate unused areas caused by deleted entities, and to re-initialize the display list. It can optionally perform the integrity/efficiency checker to check the validity of all associations and delete duplicate geometry. Gets a filename and returns its components. I/O: The prefix. I/O: The name of the file. I/O: The suffix (extension). Handle to the parent window. True if the file exists, otherwise false. Gets a filename and returns its components. I/O: The prefix. The path number of characters (NOT number of bytes). I/O: The name of the file. The file name number of characters (NOT number of bytes). I/O: The suffix (extension). The extension number of characters (NOT number of bytes). Handle to the parent window. True if the file exists, otherwise false. Set up two message strings that normally go to a message box for output to the LOG file. The message text for the message box. The title for the message box. Write a string (plus a new-line) to an open file. Handle to the open file to write to. The string to write. Write a string to an open file. Reference to an open MCFile object. The string to write. Write a string to an open file. Handle to the open file to write to. The string to write. Write a string to an open file. Handle to the open file to write to. The string to write. Given a message resource id, write that message (plus a new-line) to an open file. Handle to the open file to write to. Identifier for the message. (Optional) Resource handle of the resource (default == nullptr). Given a message resource id, write that message to an open file. Reference to an open MCFile object. Identifier for the message. (Optional) Resource handle of the resource (default == nullptr). Given a message resource id, write that message to an open file. Handle to the open file to write to. Identifier for the message. (Optional) Resource handle of the resource (default == nullptr). Write a real number to an open file. Assume at least one place before the decimal point. Reference to an open MCFile object. The value to write. Number of decimal places to include. Write a real number to an open file. Assume at least one place before the decimal point. Handle to the open file to write to. The value to write. Number of decimal places to include. Given a message resource id, write that message (plus a new-line) to the message log. Identifier for the message. (Optional) Resource handle of the resource (default == nullptr). Given a message resource id, write that message to the message log. Identifier for the message. (Optional) Resource handle of the resource (default == nullptr). Set where the local static msg_log_dest is set to. The message destination (None, Screen, File, or Both). Return where the local static msg_log_dest is set to. The message log destination (None, Screen, File, or Both). Set up local static msg_log_hdr for optional header message written before each LOG file write. The message header string ("" if no message desired). Set up local static msg_log_dest and msg_log_fname (only if msg_destination is legal value). The message destination (None, Screen, File, or Both). Full path for the desired LOG file. Write a message to the message log file. The message text. Clears both the message log and the message prompt. Clear the status line/message prompt. Refresh the status line/message prompt. Extract the extension from a path, but all-digits don't count as an extension. Name of the file to check. For 'test.mcam', return '.mcam'. For 'test.mcam.123', also return .mcam. Get version information for the given DLL. [OUT] If successful, the version numbers, product numbers, company, copyright, etc. (Optional) If true, include any update number e.g. '(22.0.23914.0) Update 1' (default = false). (Optional) The name of the DLL to check (default = nullptr, which checks Mastercam.dll). True if the structure is filled in, false if the file doesn't exist or couldn't be accessed. Check for the existence of a path. If the path does not exist, the user may be asked to create it. The path prefix. The size of the pPrefix buffer in characters (NOT bytes). The default directory. True to display an error and allow user to create the directory. See if the given file exists. I/O: Name of the file to check (possibly modified). The size of the pFileName buffer in characters (NOT bytes). A prefix to add when looking for the file. A possible default name to use when looking for the file. A second possible default name to use when looking for the file. A suffix to add when looking for the file. True if "none" is an acceptable file name. The owner of any displayed message box. True if a file with the given name, or some combination thereof exists. This method gets the file name and extension from a path string. I/O: File name of the file (possibly modified). The size of the pFileName buffer in characters (NOT bytes). The default file name if the passed in name is empty. I/O: The file extension to extract from the file. The size of the pExt buffer in characters (NOT bytes). This method gets the file name from a path string. I/O: File name of the file (possibly modified). The size of the pFileName buffer in characters (NOT bytes). The default file name if the passed in name is empty. The default file extension to add. This method gets the number of days the file has existed. The name of the file to check. The file age in days, or -1 if error. Display the 'Browse for Folder' Windows' dialog. Handle to the parent window. Path to start browsing from. The title and/or prompt text to use for the dialog. (Optional) If true (default), the user will be able to enter a directory name. (Optional) If true (default), user can create new directories. (Optional) Additional flags passed to SHBrowseForFolder in BROWSEINFO structure. The directory selected by the user. Empty string if dialog was cancelled. Check if it's okay to save with a Mastercam Learning Edition license. True if okay to save, otherwise false. Class OKToSaveInDemoEnabler automatically enables ability to save files from within DEMO ... and disables it when it goes out of scope should be used in places where, for example, STL files are written temporarily. Use the given SysFile object to open the specified Mastercam part file. The SysFile object. The name of the file to open. Part file version number if opened successfully. Returned - True if this is an educational part file, false if industrial part file. True if successful open, otherwise false. Check for a Mastercam part file version X to X4 (perhaps early X5). Name of the Mastercam file to examine. True if version pre-X5 file, false if not. Check for a '.tooldb' file extension. Full path name of the file. True if name contains a '.tooldb' file extension, otherwise false. Check for a '.power' file extension. Full path name of the file. True if name contains a '.power' file extension, otherwise false. Check for a Mastercam part file (industrial or educational) extension. Full path name of the file. True if Mastercam part file extension, otherwise false. Check for a Mastercam Educational part file extension (.emcam, .emcx-9, .emcx-8, etc.). Full path name of the file. True if Mastercam Educational part file extension, otherwise false. Check for a Mastercam part file extension (.mcam, .mcx-9, .mcx-8, etc.). Full path name of the file. True if Mastercam industrial part file extension, otherwise false. Get the units from a Mastercam file. An MCFile object. The file MUST be opened already. Returned - True if the units in the file are metric. True if the file exists and is a Mastercam file, otherwise false. Get the units from a Mastercam file. The file to examine. Returned - True if the units in the file are metric. True if the file exists and is a Mastercam file, otherwise false. Gets whether the Mastercam file is genuine. Name of the Mastercam file to examine. true, if OK and false if file has been saved with a compliance infringement. Get the Mastercam file version from a MC file or a SW document containing MC data. An MCFile object. The file MUST be opened already. (Optional) If non-null MC32 or MC64 will be returned (default == nullptr). Version of the part file, or no value if the file is not a part file. Get the Mastercam file version from a MC file or a SW document containing MC data. The file to examine. (Optional) If non-null MC32 or MC64 will be returned (default == nullptr). Version of the part file, or no value if the file could not be opened or is not a part file. Determine if the given file is a Mastercam file, based on its extension. Full pathname of the file. (Optional) True to check if the file exists. 0 if the file does not exist, or is not a Mastercam file, otherwise the version number. This method determines if the path is an existing folder. Name of the folder to check for. (Optional) True to warn if the folder does not exist (default = false). True if the folder exists. False if it doesn't exist or is a file. Get the size of a file. File name of the file. The file size in bytes. This method returns the file's last-accessed time as a string. File name of the file. Returned - the time, formatted in a string. The size of the string (in characters, NOT bytes). Describes the format to use: 0 == Day/Monty/Year, 1 == Month/Day/Year. True if time obtained, otherwise false. Get a file's last-accessed time. File name of the file. Returned - a filled-in __time32_t structure. True if time info was obtained, otherwise false. This method returns the file's last-modified time as a string in DMY format. File name of the file. Returned - the time, formatted in a string. The size of the string (in characters, NOT bytes). True if time obtained, otherwise false. This method returns the file's last-modified time as a string. File name of the file. Returned - the time, formatted in a string. The size of the string (in characters, NOT bytes). Describes the format to use: 0 == Day/Monty/Year, 1 == Month/Day/Year. True if time obtained, otherwise false. Get a file's last-modified time. File name of the file. Returned - a filled-in __time32_t structure. True if time info was obtained, otherwise false. This method returns the file's creation time as a string. File name of the file. Returned - the time, formatted in a string. The size of the string (in characters, NOT bytes). Describes the format to use: 0 == Day/Monty/Year, 1 == Month/Day/Year. True if time obtained, otherwise false. Get a file's creation time. File name of the file. Returned - a filled-in __time32_t structure. True if time info was obtained, otherwise false. Verify the given extension matches the extension of the give file. The file to check. The suffix to check against. True if there is a match, otherwise false. This method replaces the extension of a file given a file path. The file path The size of the file path (in characters, NOT bytes). The new extension. True if the extension is set/replaced, otherwise false. Get the file name of a file within a path. The full path of the file. Returned - The file name. The size of the name string above (in characters, NOT bytes). True to remove the file extension from the name. The index where the name begins, or -1 if not found. Get the prefix of a file within a full path. Full path to the file. Returned - the prefix portion of the path (WITHOUT the trailing backslash). The size of prefix string in characters (not bytes). Index where the prefix ends (final backslash), or -1 if no prefix. Get the extension (suffix) of a file. The name of the file to check. Returned - The extension (WITHOUT the '.'). The size of extension string in characters (not bytes). The index where the suffix begins in pFileName, or -1 if no extension found. Compare a file's extension to the given extension. Don't worry about the '.' or case. File name of the file to check. The extension to compare to. True to warn if the extensions are not the same. The result of the compare (0 == same, -1 or 1 == different). Increment digit characters in a file name after a delimiter. [I/O] the name to increment. [I/O] the delimiter to use (if empty, default delimiter is returned). If true, look for existing number in the passed-in name. [O] - set to true if the file exists. (Optional) the starting value to use for the first file (default = 1). (Optional) the increment value to use for subsequent files (default = 1). True if a file name was successfully generated, otherwise false. Rename a file. Name of the file to rename. The new name for the file. If true, overwrite any existing file without asking, false to ask the user first. True if the rename succeeds, otherwise false. Check a string for illegal path characters. Full pathname to check - may be updated if substitution character is included. (Optional) Returned - The positions of any bad characters in the original string. (Optional) The substitute character for any bad characters found (default == nullptr). The number of bad characters found. Exported function to force a SolidWorks configuration. The SolidWorks configuration name. Exported function to select a SolidWorks configuration. The SolidWorks file name. The SolidWorks configuration name. Returned - set to true to on a cancel. This function displays the file open or file save dialog. It does not open the file, it simply populates the OPENFILENAME param and returns 1 if OK is clicked, or 2 if cancel is clicked. Pointer to the parent window. True to display the 'Open' dialog. False to display the 'Save' dialog. Pointer to OPENFILENAME structure. (Optional) Custom string to display in the static text control to the left of the folder browser combo box (default == nullptr). 1 if OK clicked, 2 if CANCEL clicked. Use std::filesystem to recursively copy a folder and all its files and sub-folders. Source folder. Destination folder. (Optional) True to overwrite existing files, false to skip them. (Optional) True to remove read-only flags on destination files. True if it the copy succeeds, otherwise false. Copy one file to another. Specifies the source file. Specifies the destination file. Pointer to a bool to receive the result status. Delete a file. Path to the file (may be empty or nullptr). The name of the file. May contain a full path. 0 if the file was deleted, otherwise an error code. Prompts for a file to open and opens it in the specified mode using SysFile Reference to a SysFile object to use for opening the file. Returned - File name or full path name (with directory and extension). The file open mode. The parent owner of the dialog. True if user chose a file and it opened, otherwise false. Prompt to open a file and track its file handle. Instead of calling this function directly, use the PROMPT_OPEN_FILE_TRACK macro, which will automatically provide the file and line number information. The caller's source file. The caller's line number. Returned - The name of the file to open, selected by the user. Specifies opening the file for reading or writing. Returned - true if the file opened, otherwise false. The parent window for the prompt dialog. A valid file pointer if the call succeeds, or nullptr if it fails. Truncate a file. The file handle. Open a file and track its file handle. The caller's file name. The caller's line number. Name of the file to open. File open mode (reading, writing, etc.). Null if it fails, else a pointer to a FILE. Use the VistaOpenExternalFile routine to prompt the user for a file name True to prompt for a text file, false to prompt for all file types. Pointer to the OPENFILENAME structure containing information for the open dialog. 1 = OK clicked, 2 - CANCEL clicked. Gets a foreign application name, based on the given file type. This method scans the registry for 'foreign' file extensions. If found, the appropriate 'App' name (the import/export .DLL) is returned, as well as the folder name from which the .DLL wants to be launched (there are usually other .DLLs there). File extension (e.g. ".DWG"). "Import" or "Export". Returned - The name of the application, if found (e.g. "DWGIN"). Returned - The launch folder relative to the Mastercam install path (e.g. "COMMON\ACADDATA"). (Optional) Filename of the file. Doesn't seem to be used. True if the information is filled in, otherwise false. Call "OpenAsText" or "OurShellExecute" to open the given file. Filename of the file. MUST be a complete path to the file. (Optional) True to call the "OpenAsText" routine, false to call an external program (default = false). (Optional) True to wait until the external program completes (default = false). True if the external program is successfully invoked. This method displays the File/Open dialog and schedules the an external program to open the file. It will use the 'Auto/Text' switch to decide whether to open the file in its associated program or in the current text editor. Initial name for the File/Open dialog. Parent window to use for the File/Open dialog. True if the user chooses a file and we are able to pass it to the external program, otherwise false. Recursively remove a directory and all of its files. Pathname of the directory. True if the directory was removed, otherwise false. Invoke a Windows' shell operation to delete the given file. Name of the file to remove. True if the shell operation succeeds, otherwise false. Exported function to let CAD file importers know if we are merging. True if merging, false if not. Schedule the default editor with the given file name. Full pathname of the file. True to wait until the editor closes. True if the editor was successfully scheduled, otherwise false. Gets editor path. Returned - The directory where the executable resides. Returned - The name of the executable. Returned - The executable's command line arguments. Returned - True if the editor can only handle a single file (like Notepad). (Optional) True to use default the default editor as specified in config (default = true). True if an editor can be located, otherwise false. Get default CodeExpert information. Returned - The directory where CodeExpert resides. Returned - The CodeExpert exe name. Returned - The CodeExpert command line arguments. True if CodeExpert exe is found, otherwise false. Get the default data paths from the config file for the given file type. Specifies the extension. The corresponding data path, or nullptr if no data path for the specified type. FT call for UpdateFolder function (defined in UpdateFolder.cpp). Not used. A zero if the user cancels, otherwise 1. FT call for setup_sheet command (defined in File.cpp). (Optional) Unused FT parameter. MC_NOERROR always. FT call to display counts and types for visible entities (defined in File.cpp). (Optional) Unused FT parameter. 0 always. FT call to import or export a directory of files. The direction: 0= Import, 1= Export. Zero if fail/cancel, 1 if we did the import or export. FT call to CreateZipToGoWizard (defined in ZipToGoWizardApp.cpp). Not used. A zero if the user cancels, otherwise 1. Get or sets the width of the block primitive solid along it's Z axis. Get or sets the width of the block primitive solid along it's Y axis. Get or sets the width of the block primitive solid along it's X axis. Initializes a new instance of the BlockSolid class. This constructs a new block solid object with default parameters. The default parameters of a block solid are for a 1" x 1" x 1" cube, with the center at the WCS origin, (0.0, 0.0, 0.0). Loads the default values for a given solid geometry object. Loads the default values for a given solid geometry object from the solid geometry entity passed in. The geometry entity to use as defaults for this solid geometry object. Commits a solid geometry entity to the Mastercam database. The solid geometry entity to be committed. The solid parameters to initialize the object with. True if the commit was successful; false if not. Initializes a new instance of the BlockSolid class. Attempts to retrieve a solid geometry entity with the given ID from the Mastercam database and use that to initialize this solid geometry object. If no matching solid geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the solid geometry entity to look up in the Mastercam database. This class is used for working with block shaped primitive solids. Removes the specified associated point. The toolpath operation. true to set Incremental, else false to set to Absolute when associative point mode is cleared. Type of the associated point to be removed. true if an associative point of the requested type was deleted from the operation, false if not. Searches for an associative point of the specified type. The toolpath operation. Type of the associated point to search for. The data package for the associative point. Adds an associated point to the linking parameters of an operation. The toolpath operation. The associative point. The type of the associated point. true an associative point of the requested type was successfully add to the operation, false if not. Adds an associated point to the linking parameters of an operation. The toolpath operation. The entity to be associated. The point option (see: Point Entry Codes). Type of the associated point. true an associative point of the requested type was successfully add to the operation, false if not. The Toolpath Entities class is used for managing toolpath entities in Operations. Initializes a new instance of the NestingSheet class. This initializes all of the nesting item objects to their default values. Commits the NestingSheet. The initialized stream to output to. This class is used to work with sheet sections in a Mastercam nesting file. Searches for the first matching associative entity. If non-null, the DB pointer to start search from. If non-null, the DB pointer to search ended on. If non-null, receives a copy the matching entity data, else nullptr if just checking for existence of entity. Predicate that returns true if entity meets search criteria. True if it found a match, false if it failed to find matching entity. Searches for the first associative entity with an assoc_id value that is contained in the given set. If non-null, the DB pointer to start search from. If non-null, the DB pointer to search ended on. If non-null, receives a copy the matching entity data, else nullptr if just checking for existence of entity. List of identifiers for the associated entity type ids. If the set is empty then it will return the first assoc_ent entity it encounters. True if it found a match, false if it failed to find matching entity. Store associative ents to db alive and blanked The pointer to the entity. TP_ID, OP_ID, TL_ID or M_ID true = Success; false = Failed. Purpose: get an associative entity via it's ID, but without filtering on the ALIVE_BIT selection flag (This is useful if you want to try and find, for example, an operation that's been marked as deleted) If non-null, the pointer in DB to start search from. If non-null, the pointer the matching/found entity. If non-null, the pointer to copy found entity's data to. The assoc_id to match else if NULL_ID return next associative DB entity. If non-null return search status: true = matching entity found else false. Deletes the old entity - reassociates toolpaths to new entity. The old entity. The new entity. True if toolpath entity changed. Deletes the old entities - reassociates toolpaths to new entities. List of old/new eptrs and entity IDs. True if toolpath entity changed. Swap old for new eptrs and entity IDs in toolpath entities. List of old/new eptrs and entity IDs. True to add to undo stack. (Optional) Pointer to file info, nullptr = load one up. (Optional) True to mark owner operations dirty and update Operation Manager. (Optional) True to update toolpath reference count. True if toolpath entity changed. Constructor. (Optional) The old eptr (ent.eptr). (Optional) The new eptr (ent.eptr). (Optional) The old entity # (ent.ent_idn). (Optional) The new entity # (ent.ent_idn). Structure containing old/new ent.eptr and ent.ent_idn to pass to tp_change_eptr(). Is entity assoc to toolpath or view. The entity. True if assoc to toolpath or view.. get an operation and all its chain entities. operation number to get (0 = don't get operation and use op_ent). If non-null, the operation ent. chain type wanted 0 = all, 1 = drive, 2 = tool axis. ptr to alloced list of toolpath ents. number of toolpath entities found. true = successful. (Optional) An addtional code for third parties to identify their chains with. (Optional) ptr to an entity map containing entity copies, nullptr - we'll make one (i.e. could be expensive). Gets or sets the block ID number being used in the current block drilling operation. Gets or sets the block drill library name used in the current block drilling operation. Gets or sets the value of the break through depth to be used in the current block drilling operation. Gets or sets the value of the finishing amount to be used in the current block drilling operation. Gets or sets the value of the roughing amount to be used in the current block drilling operation. This method commits the current Block Drill operation to the Mastercam database. true to update any points assigned to the operation. If you know that you've not altered the points used by this operation, you may wish to used this >.Commit(false). True if the database commit was successful and false if not. This method commits the current Block Drill operation to the Mastercam database. This commit also updates any the points used by this operation. If you know that do not want the points touched during the commit, you may wish to use the .Commit(false) method overload. True if the database commit was successful and false if not. Initializes a new instance of the BlockDrillOperation class. This creates a new block drill toolpath operation with default settings. Loads the default values for a given operation object from the operation passed in. The operation structure to use as defaults for this operation object. Commits the operation. true to include, false to exclude touching the points during the commit. true if it succeeds, false if it fails. Initializes a new instance of the BlockDrillOperation class. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Loads the default values for a given operation object. This method takes a block drill library name and gets a block drill. The path and name of the block library file to get the tool from. [out] The tool found, if one was found. True if a block drill was found; else false if not. This class is used for working with block drilling toolpath operations. Accessor for the Singleton instance of ILevelsManagerInternalEngine. The singleton. Ungroup selected levels. True if levels were ungrouped, otherwise false. Set the 'ignore blanked entities' in count property. True to set, false to clear. Expand each level in the given list. The list of levels to expand. The actual number of levels expanded. Expand each group in the given list. The list of groups to expand. The actual number of groups expanded. Set 'Arrow keys select main level' property. True to set, false to clear. Set the 'active level always visible' property. True to set, false to clear. Scan all entities and map one level number to another. The old level number. The new level number. Update any changed entity counts in the Levels Manager tree. Called when a tree item is changed to clear selected data calculation. Move entity to specified level (and it's blanked parent surfaces) The entity. The new level. True if it succeeds, false if it fails. Add the given groups and/or levels to a group. Passing a 0 for the group id will prompt for a new group. Passing the id of an existing group will add selected levels to that group. A list of groups IDs to add to the group (can be empty). A list of level IDs to add to the group (can be empty). (Optional) The ID of a group to add to (default = 0 for none). The group number if successfully grouped, otherwise 0. Get all levels from the currently selected groups. The list of selected levels to populate. Get currently selected levels. The vector of selected levels to populate. (Optional) If true, make the selected levels visible (default = false). Get level names from a file. File containing the level names (usually a .CSV file). True if any levels were fetched, false if there were file problems. Get a list of currently expanded levels. returned - a list of expanded levels by level number. Get a list of currently expanded groups. returned - a list of expanded groups by group ID. Sets the given level as "visible", and all other levels not visible. The level to set visible. Determine if any levels belong to a group (the root group doesn't count). True if any levels are grouped, otherwise false. Update levels data ent. Checks if the graphic display needs to be updated for entity summary highlight. (Optional) True to force display update even if focus or active state did not change. Update the counts for the given entity on the given level. The entity to inspect. The number of the level to update. The count to add or subtract. Ungroup give selection. The items to ungroup. True if items were ungrouped, otherwise false Applies Toggles visibility command to the selectedItems. Information about the selected tree items. Removes levels manager sort. Sets use large tool bar icons. True to use large icons. True if it succeeds, false if it fails. Set tree item collection. The group tree item collextion. The level tree item collextion. The entity summary tree item collextion. Callback to be used to pause or unpause an observer. Callback take 2 params : - LevelObserver : The observer to pause/unpause . - bool : true to pause, false to unpause It returns a bool with the initial state of pause The callback. Mark level data dirty so will reload on next update. Set or clear the "has focus" property. True to set, false to clear. Sets the font attributes. Set the entity counts for each level. Sets edit type (cut, copy, paste). Type of the edit. Sets the default font attributes. Callback to be used to create levels handlers when a level is created. The callback. Callback to be used to create groups handlers when a group is created. [in,out] The callback. Callback to be used to create entites handlers when an entity is created. The callback. Reorders the data to match the order of the tree items. Save the panel's settings. Save the level names to a file. True if the levels were saved, false if the file could not be created. Reset the visible status of each level to when the file was first opened. Notification handler for the OnlyActiveLevelVisible property changed. Notification handler for the IgnoreBlankedEntities property changed. Notification handler for the ArrowKeysSetActiveLevel property changed. Notification handler for the AllLevelsOn property changed. Notification handler for the AllLevelsOff property changed. Notification handler for the ActiveLevelAlwaysVisible property changed. Execute handler for the ToggleGroupExpansion command. Execute handler for the ToggleExpansion command. Execute handler for the PasteEntities command. Execute handler for the MoveSelectedEntities command. Execute handler for the MakeActive command. The level tree item which launched the Command. Execute handler for the ILevelTreeItem.Renumber command. The level tree item which launched the Command. Execute handler for the ILevelTreeItem.Rename command. The level tree item which launched the Command. Execute handler for the LevelNameChanged property change. The level tree item changed. Execute handler for the LevelNumberChanged property change. The level tree item changed. Execute handler for the IsVisibleChanged property change. The level tree item changed. Execute handler for the IsSelectedChanged property change. The level tree item changed. Execute handler for the IsExpandedChanged property change. The level tree item changed. Execute handler for the IsActiveLevelChanged command. Execute handler for the ILevelTreeGroup.Rename command. The group which launched the Command. Handler for the Name.Value PropertyChanged event. The group tree item. Handler for the IGroupTreeItem.IsSelected PropertyChanged event. The group tree item. Handler for the IsExpanded PropertyChanged event. The group tree item. Handler for the IGroupTreeItem.AggregateVisibility.Value PropertyChanged event. The group tree item. Handler for the IEntitySummaryTreeItem.IsSelected PropertyChanged event. The tree item. Execute handler for the GroupSelectedLevels command. Execute handler for the GroupSelectedLevels command. Execute handler for the EntityCountChanged command. Execute handler for the DeleteSelected command. Execute handler for the DeleteGroup command. Group the focused belongs to. Execute handler for the CutEntities command. Execute handler for the CopySelectedEntities command. Execute handler for the CopyEntities command. On Clearing of the Data for the levels manager. Moves a PVL Group entity data item. Type of the member. Identifier for the item. Identifier for the newparent. -1 to add to the bottom or zero-based index of the move to. Makes selection propagation suppressor. The service will not propagate selection for the scope of the return value. A object to hold suppression state the scope of its lifetime. Load the panel's settings. (Optional) True to load font settings. Create a list of Levels and call the report routin. The menu pick (All, Selected, or Visible). Import level names from the given file (drag-and-drop support). File containing the level names (usually a .CSV file). If empty, we'll prompt. True if any levels were fetched, false if there were file problems. Group selected levels. Passing an invalid group id will prompt for a new group. Passing the id of an existing group will add selected levels to that group. (Optional) The ID of a group to add to (default = 0 for none). The group number if successfully grouped, otherwise 0. Gets focus item. The focus item or null if none. Gets the "ignore blanked entities in count" setting. True if the setting is active, otherwise false. Gets a flat list of groups as a pair with the groupId and name. The all Groups as a Id and Name pair. Gets group name. Identifier for the group. The group name. Gets if we are deleting from the level manager. True if we are deleting from the level manager. Gets the "Arrow keys set active level" setting. True if the setting is active, otherwise false. Find the LevelTreeItem for a given number. The level number. A pointer to the level tree item if found, otherwise nullptr. Searches for the group that contains the LevelNumber and returns a pair with the groupId and name. The level number. The found group Id and Name pair. Searches for the group that matches Id and returns a pair with the groupId and name. Id of the group. The found group Id and Name pair. Searches for the first group that matches name and returns just the levels in that group. Id of the group. The found group levels in group of Id. Update for an entity being added to the database. The entity being added. Enable refresh and reload to refresh the Levels Manager list. If true, the list will be reloaded. If true, the level state will be saved to allow reset. True if from Idle. True to force an immediate update. Dumps the levels report. Destroys the ManagedUI Panel. De-select all selected items in the tree. (Optional) The tree item to skip, and keep selected. Selection data. A reference to a GroupTreeSelectionData. Clear Level manager selection. Creates the ManagedUI Panel. Create the Levels Manager Tree. (Optional) True to reselected the CurrentSelection items. True if the Levels service is running, otherwise false. Copy tree item. Type of the member. Identifier for the item. Identifier for the newparent. Zero-based index of the move to. Change entity information to match level information, and redraw if needed. (Optional) pointer to saved level data. If null current level data will be used. Determine if we can ungroup selected command. True if we can ungroup selected command, false if not. Determines if ToggleVisibility command can be applied to the given selected tree item information. Information about the selected tree items. True if the command can execute. CanExecute handler for the ToggleGroupExpansion command. True if the command can execute. CanExecute handler for the ToggleExpansion command. True if the command can execute. CanExecute handler for the ReportVisible command. True if the command can execute. CanExecute handler for the ReportSelected command. True if the command can execute. CanExecute handler for the ReportAll command. True if the command can execute. CanExecute handler for the RefreshLevelsList command. True if the command can execute. CanExecute handler for the PasteEntities command. True if the command can execute. CanExecute handler for the MoveSelectedEntities command. True if the command can execute. CanExecute handler for the MakeActive command. The level tree item which launched the Command. True if the command can execute. CanExecute handler for the ILevelTreeItem.Renumber command. The level tree item which launched the Command. True if the command can execute. CanExecute handler for the ILevelTreeItem.Rename command. The level tree item which launched the Command. True if the command can execute. CanExecute handler for the ImportNamedLevels command. True if the command can execute. CanExecute handler for the CanRename command. The level group which launched the Command. True if the command can execute. CanExecute handler for the GroupSelectedLevels command. True if the command can execute. CanExecute handler for the GroupSelected command. True if the command can execute. CanExecute handler for the ExportNamedLevels command. True if the command can execute. Group the focused belongs to. True if the command can execute. CanExecute handler for the DeleteGroupAndLevels command. True if the command can execute. CanExecute handler for the CopySelectedEntities command. True if the command can execute. CanExecute handler for the ClearUnnamedEmptyLevels command. True if the command can execute. CanExecute handler for the ClearSelectedEmptyLevels command. True if the command can execute. CanExecute handler for the ClearAllEmptyLevels command. True if the command can execute. Allow user to select geometry to set the new active level. Destructor. The Levels manager internal engine only exposed in the _E header. Accessor for the Singleton instance of ILevelsManagerEngine. The singleton. Ungroup levels. List of levels to ungroup. True if levels were ungrouped, otherwise false Set selected levels in the tree. A list of levels to select in the tree. True to clear all current selections first. True to make sure those levels are visible. The number of tree items selected. Set a selected level in the tree. The level to select in the tree. True to clear all current selections first. True to make sure that level is visible. True if the level was selected, otherwise false. Set the 'only active visible' property. True to set, false to clear. Set or clear a level's "visible" state. The level number. (Optional) True to set the state to visible, false to set it not visible. Update which levels are visible in the global list and in the tree. A list of levels to make visible. Set a level's name and update the tree. The level number. The new name for the level. True if the name was successfully changed, otherwise false. Set the state of "all-on" mode. The new state The previous state. Set the state of "all-off" mode. The new state The previous state. Select/deselect all entities on the given levels. If true the entities are to be selected, otherwise they are unselected. Reload the level information in the panel. True to force an immediate update. Purge empty levels. True to purge selected empty levels, false to purge all empty levels. (Optional) True to purge unnamed levels. False doesn't check name. True if any levels were purged, otherwise false. Add levels to a named group. Passing an empty name will prompt for a new group. Passing a name that does not exist will create a new group with that name. Passing the name of an existing group will add selected levels to that group. The name of the group, which maybe updated. The group number if successfully grouped, otherwise 0. Add levels to a named group. Passing an empty name will prompt for a new group. Passing a name that does not exist will create a new group with that name. Passing the name of an existing group will add selected levels to that group. A list of groups IDs to add to the group (can be empty). A list of level IDs to add to the group (can be empty). The name of the group, which maybe updated. The group number if successfully grouped, otherwise 0. Gets the "Only Active level is visible" setting. True if the setting is active, otherwise false. Find the level number for a given level name. Name of the level to search for. The level number if a match is found, otherwise 0. Return the state of "all-on" mode. True if in all-on mode, otherwise false. Return the state of "all-off" mode. True if in all-off mode, otherwise false. Return Mastercam's active level. The active level. Gets the "Active level is always visible" setting. True if the setting is active, otherwise false. Dumps all the levels to the given file. The file name to write to. True if it succeeds, false if it fails. De-select specified levels in the tree. The list of level numbers to de-select. The actual number of levels that were de-selected. Delete the given level. The level number. (Optional) True to reload tree. True if the level existed and was deleted, otherwise false. Delete entities on all selected levels. True if something was deleted, false if no levels were selected. Delete a group and perhaps the levels belonging to that group. Group ID. True to remove the group's levels as well. True if the group was successfully deleted, otherwise false. Change a level number. The old level number. The new level number. True if level number was changed, otherwise false. Set active level by number; add a level if it doesn't exist. The level number. Add a new level to the global list. (Optional) True to trigger the rename level after adding. (Optional) Name of the level, which maybe updated. The level number of the added level, 0 for failure. Add a new group. The group id of the added group, 0 for failure. Destructor. Public Levels Manager Engine interface. Set the main level. Add it if it doesn't exist The new main leve. Set entity counts for all levels. Load the Level Manager's image on a given button pointer to the UIBitmapButton control Add a level to a level group (if appropriate). The level number of the level to add. (Optional) The group ID (default = 0, which will add to the root group). Adds a node to the levels map. This method should be the only place that calls "new LevelNode ()" The node. Deletes all of the stored levels. Gets node by name. Avoid usage: O (n). The level name. null if it fails, else the node by name. Gets existing LevelNode from map keyed by level number. The level. nullptr if it does not exist, else a pointer to the LevelNode. Ensures that a level has a bitmask position. The level. Gets empty level name. The empty level name. Check the length of the given name and truncate if it is too long. The name. The name passed in if it will fit, a truncated version if it won't. Combine a level name and level set name into a single string. The level name. The level set name. True if the name fit, false if we had to truncate. The combined name, separated and size checked. Separate a complex level name into component level name and level set. Name could be 'Level', or '~~~LevelSet', or 'Level~~~LevelSet'. The combo name to split apart. The level name and level set names. Each could be empty. Get a copy of a level node. The level number. The level node (will be empty if the level does not exist). Restore a previously saved copy of the level data. The previously saved level data. Gather level numbers into an unordered set. (Optional) true to only get visible levels. The unordered set of level numbers. Gets first-in-first-out (creation-ordered) level numbers. This method first sorts the levels by the order they were created in, so is slower than GetSortedLevelNumbers (). (Optional) true to only get visible levels. A vector of levels. Gets a vector of defined level numbers as integers. A vector of level numbers. Gets a sorted vector of level numbers as integers. The levels are already sorted, so this is the fastest way to get a list of all level numbers. (Optional) true to only get visible levels. A vector of levels. Determines the maximum level number used. Max level number encountered or -1 for error. Get the 'level set' name. This method is provided only for compability with older part files to convert legacy 'level set' names to group names. The level number. The level set name. Clears all 'level set' names. This method is provided to clear all legacy 'level set' names from legacy part files once they have been converted to group names. Gets a level's bit position in the bitmask. The level. Zero-based index of the bit or UT_LEVELIDX_NONE if level is non-positive or not found. Return the level data's map. The level map. Clears the 'visibility changed' flag. See if any levels have changed visibilty since clearVisibilityChangedFlag() last called. True if visibility has changed, otherwise false. Delete a level. The level number. True if the level was deleted, false if it did not exist. Make a copy of the global level list. [in,out] Copy of global level data. Sets all levels in the map visible. Find the next available level number. (Optional) The starting number. The next unused level number. See if a given level exists. The name of the level to check. True if the level exists, otherwise false. See if a given level exists. The level number to check. True if the level exists, otherwise false. Given a name find the level number that corresponds to it. The level name. The level number if found, otherwise -1. Set all levels visibility property. This method walks the display list, adding any missing levels to the global list. The active level is not affected. True to make all levels visible, false to make all levels not visible. Return a list of named levels. The list of named levels. Return the number of named levels. The total number of levels that have names. Return a list of visible levels. The list of visible levels. Return the number of visible levels. The total number of visible levels. See if a level is visible. The level name. True if visible, false if not visible. See if a level is visible. The level number. True if visible, false if not visible. Set a level's 'expanded' property. The level name. True to expand, false to collapse. Set a level's 'expanded' property. The level number. True to expand, false to collapse. See if a level is expanded. The level name. True if expanded, false if not visible. See if a level is expanded. The level number. True if expanded, false if not visible. Resets the entity count of one or all levels. (optional) Negative number for all levels, otherwise which level to reset the count of. Get the entity count for a level. The level. The entity count. Update the counts for the given entity on the given level. The entity to inspect. The number of the level to update. The count to add or subtract. Renumber a level. The old level number. The new level number. False if the new level already exists or the old level did not exist, otherwise true. Add a level or update it's name/visibility. If the level does not exist it will be added. The level number. The level name. True if the level is visible, false if it's not visible. Set a level's visibility. Name of the level. True if the level is visible, false if it's not visible. (Optional) True to add the level if it does not exist (default = true). An int value representing the level that matches the name. Set a level's visibility. Level number of the level. True if the level is visible, false if it's not visible. (Optional) True to add the level if it does not exist (default = true). Get the name for the given level. The level number to fetch the name for. [I/O] buffer that receives name - should be at least NAME_LENGTH_MAX characters. Size of the buffer in characters (not bytes). True if the level exists, otherwise false. Get the name for the given level. The level number to fetch the name for. The name of the level (may be empty). Set a level name. If the level does not exist, it will be created. The level number to set. The name to set. Get the level number for the given index. Zero-based index in the map. The level number if the index is valid, otherwise -1. Remove all levels, set the active level number to '1'. Return the number of levels in the map, visible or not, used or not. The current number of levels. Virtual destructor. Default constructor. Holds information about the level data (names, numbers, entity counts, etc.). Defines an alias representing the level map. Set a level's visibility status. True if the level is visible, otherwise false. Set a level's count for a specific entity category. Entity category to set the count for. The count. Set a level's name. The level name. Set a level's number. The level number. Set a level's expanded status. True if the level is expanded, otherwise false. Set a level's entity count. The entity count. Set a level's creation order. The creation order. Return the level's visibility status. True if the level is visible, otherwise false. Return the level's name. The level's name. Return a level's level number. The level number. Return the level's expanded status. True if the level is expanded, otherwise false. Return the level's entity count. The level's entity count. Return the level's creation order value. The level's creation order value. Return the level's count for all entity categories. A map of entity category counts. Return the level's count for a given entity category. Entity category to get the count for. The count for the requested entity category. Clear the counts for all entity types for this level. Adjust the count for a specific entity type. The entity to inspect. The value to add or subtract to the count. Entity Category enum class. Assignment operator. The object. A deep copy of this object. Destructor. Copy constructor. The object. Default constructor. Level node class. Gets Group that contains the level number. The number of the level. A group id/name pairs on success, Empty if it fails to find any groups. Gets Group from Group Id. The Id of the group. A group id/name pairs on success, Empty if it fails to find any groups. Gets level numbers from within a group of a given an Id. The Id of the group. A list level numbers on success, Empty List if it fails to find the group name. Gets the level groups. A list of groups id/name pairs on success, Empty List if it fails to find any groups. Gets group name. Id of the group. The group name on success, empty string on failure. Dumps Levels to an XML. Filename of the output file. True if it succeeds, false if it fails. Ungroup some or all levels. List of levels to ungroup. Can be empty if 'allLevels' is true. True if levels were ungrouped, otherwise false Set selected levels in the tree. A list of levels to select in the tree. True to clear all first. True to make sure those levels are visible. The number of tree items selected. Set a selected level in the tree. The level to select in the tree. True to clear all first. True to make sure that level is visible. True if the level was selected, otherwise false. Set the 'all on' property. True to set, false to clear. Set the 'all off' property. True to set, false to clear. Select/deselect all entities on the given levels. If true the entities are to be selected, otherwise they are unselected. Reload most level information in the panel. True to force immediate update. Purge empty levels. True to purge selected empty levels, false to purge all empty levels. True if any levels were purged, otherwise false. Find the level number for a given level name. Name of the level to search for. The level number if a match is found, otherwise 0. Return the state of "all-on" mode. True if in all-on mode, otherwise false. Return the state of "all-off" mode. True if in all-off mode, otherwise false. Return Mastercam's active level. The active level. Gets the "Active level is always visible" setting. True if the setting is active, otherwise false. De-select specified levels in the tree. The list of level numbers to de-select. The actual number of levels that were de-selected. Delete entities on all selected levels. True if something was deleted, false if no levels were selected. Delete a group and perhaps the levels belonging to that group. Group ID. True to remove the group's levels as well. True if the group was successfully deleted, otherwise false. Change a level number. The old level number. The new level number. True if level number was changed, otherwise false. Add levels to a named group. Passing an empty name will prompt for a new group. Passing a name that does not exist will create a new group with that name. Passing the name of an existing group will add selected levels to that group. The name of the group. The group number if successfully grouped, otherwise 0. Set active level by number; add a level if it doesn't exist. The level number. Add a new level to the global list. Name of the level. The name. The level number of the added level, 0 for failure. Add a new group. The group id of the added group, 0 for failure. Add groups and/or levels to a named group. Passing an empty name will prompt for a new group. Passing a name that does not exist will create a new group with that name. Passing the name of an existing group will add selected levels to that group. A list of groups IDs to add to the group (can be empty). A list of level IDs to add to the group (can be empty). The name of the group. The group number if successfully grouped, otherwise 0. This method replaces all draft entities with lines. The level number of the level to process. Gets the number of entities on all used levels. True to include, false to exclude the blanked entities. A dictionary collection were the Key is the level number and the Value is the number of entities on that level. Count the number of entities on a level. If you are calling this method multiple times to get the number of entities for multiple levels, you may want to use The level number. True to include, false to exclude the blanked entities. The number of entities on the level. Does the specified level have any entities? This is a "quick" search, as it does not look to see "how many" entities the level has. Once a single entity is found on this level, it returns 'true'. The level number. true if there are any entities on the level, false if not. Deletes the levels described by levelName. The level will deleted only... If it contains no geometry entities and it is not the "main" level. The name of the level (multiple levels can have the same name). The number of levels that were deleted. (-1 if an empty level name was supplied) Deletes the level described by levelNumber. The level will deleted only... If it contains no geometry entities and it is not the "main" level. The level number. true if it succeeds, false if it fails. This method returns an array of level numbers representing each level that has a Level name associated with it. An array containing the IDs of all of the levels that have level names. This method gets the Level Number(s) that have the Level name. Since there is no restriction on Level "names" unique, there can be multiple matches. The Level name to match. An array containing the IDs of all of the matching levels. This method gets the Level name of a given level. The level number of the level whose name is to be retrieved. The name of the specified level. This method sets the Level name of a given level. The number of the level whose level name is to be changed. The new name of the specified level. The length of the level name cannot exceed 295 characters. True if the name was set without modification. False if the name was truncated. This method returns an array of level numbers representing each level that has any geometry on it. An array containing the IDs of all of the levels that have geometry. This method returns an array of level numbers representing each currently active levels within Mastercam. An array containing the IDs of all of the currently active levels. This method returns an array of level numbers representing each currently visible levels within Mastercam. An array containing the IDs of all of the currently visible levels. This method sets the visibility of a given level within Mastercam. If the specified level number does not already exist, it will be created. If the Level being turned OFF is the Main level, it will be set invisible even if the "Make main level always visible" option is checked in the Level Manager. The number of the level to have it's visibility set. Whether or not the specified level should be visible. True if the level visibility was set successfully and false if not. Sets visible levels. The visible levels. This method sets the visibility of level(s) within Mastercam. Since there is no restriction on Level "names" being unique, there can be multiple matches when selecting "by name"! If the Level being turned OFF is the Main level, it will be set invisible even if the "Make main level always visible" option is checked in the Level Manager. The name of the Level to have it's visibility set. Whether or not the specified level should be visible. The number of levels that were affected. This method checks to see if a given level is currently visible within Mastercam. This is the number of the level to check for visibility. True if the level if currently visible and false if not. Sets the Main (active) level within Mastercam. If the specified level number does not already exist, it will be created. The number of the level to set as the active Main level. true if is succeeds, false if it fails to set the level. Sets the main (active) level within Mastercam. There can be multiple levels with the specified "name". *If that is the case, this function sets the first matching level found to be the Main Level.* If the specified level number does not already exist, it will be created. The name of the level to set as the active Main level. The number of the level that was set has the Main level, or -1 if no level with the specified name was found. Gets the level number of the current Main Level. The number of the Main (active) level that is set in Mastercam. Sets the on/off state of the 'Only Active level is visible' setting. True to enable, or false to disable the setting. Gets the on/off state of the 'Only Active level is visible' setting. True if the option is enabled (checked) or false if not. Sets the on/off state of the 'Active level is always visible' setting. True to enable, or false to disable the setting. Gets the on/off state of the 'Active level is always visible' setting. True if the option is enabled (checked) or false if not. Refreshes the Level Manager dialog data display. Changes your NET-Hook makes to the levels data may not be reflected in the Level Manager pane until you tell it to refresh itself. Initializes a new instance of the LevelsManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used to work with entity levels within Mastercam. Marshals the Event data package from native to managed format. [in] The native event data. [out] The managed event data. A pointer to the native Mastercam MCEvent. The (managed) event data. Cleans (resets) the data int the event. Gets an event. Prompt string to display while waiting for the event. Pass an empty string ("") to not display the prompt window. [out] The Event data passed back to the caller upon some sort of user input. A combination of event mode flags for limiting input types - (Select, Point, etc). A combination of geometry mask flag types for limiting selection. A combination of selection mask flag types for limiting selection. An MCamReturn.NoErrors result if the event was successfully returned, else false... Finalizes an instance of the McUIEvent class. Initializes a new instance of the McUIEvent class. This class is used to manage the get_event process from Mastercam. Gets the window corner points (view coordinates). Gets the window corner points (screen coordinates). Gets the list of entity database pointers (DB_LIST_ENT_PTR) for the selected entities. Gets the list of Chains. Gets the solid selection data. Gets the solid pick mask at time of the event. Gets the command lParam. Gets the command wParam. Gets the command id of menu or button or 'other' type of command. Gets a value indicating the is a shift key down (all events). Gets a value indicating the is a control key down (all events). Gets a value indicating if this is a right button down. Gets a value indicating if this is a left button down (drag events). Gets the state the event was executed in. Gets the key code. Gets the point projected into cplane (view coordinates). Gets the point projected into cplane (world coordinates). Gets the point (in view coordinates). Gets the point (in world coordinates). Gets the point selection method. Gets the point (aPoint) data. Gets the cursor position. Gets the selected point position. Gets a value indicating if the selection was previously selected. Gets the selected entity's database pointer (DB_LIST_ENT_PTR). Gets the 't' values of the selection point. Gets the Event type (EM_Point, EM_Vector, etc). Finalizes an instance of the UIEventData class. Initializes a new instance of the UIEventData class. UIEventData class. A managed representation of Mastercam's 'MCEvent' data package. The Mastercam entity pointer (DB_LIST_ENT_PTR) The (view) depth of the hit point. The distance from selection point. The selection point on entity. The Parasolid tag of owning body if it exists. The Parasolid tag of selected entity. The type of entity; SLD_FACE, SLD_EDGE, SLD_BODY. Initializes a new instance of the psHitData class. Gets the type of the entity data (SLD_FACE=1, SLD_EDGE=2, SLD_BODY=4, SLD_LOOP=8). The Parasolid tag of selected entity. The Parasolid tag of owning body (if it exists) The selection point (coordinates) on entity The distance from selection point on entity. The (view) depth of the hit point. The Mastercam entity pointer (DB_LIST_ENT_PTR) of the entity. Gets the Mastercam entity pointer (DB_LIST_ENT_PTR) of the entity. Gets the (view) depth of the hit point. Gets the distance from selection point on entity. Gets the selection point (coordinates) on entity. Gets the Parasolid tag of owning body (if it exists). Gets the Parasolid tag of selected entity. Gets the type of the entity data (SLD_FACE, SLD_EDGE, SLD_BODY). psHitData class A managed representation of Mastercam's 'psHit' structure. Rectangular vector (view coordinates) Relative point (world coordinates) Is it relative? The second entity. Selected entities (2 for intersection) Point in world coordinates. Values, Center, Endpoint, ... Initializes a new instance of the aPointData class. The identifier. The point. The first entity. The second entity. true if relative. The reference point. The xyz vector. Gets a the Rectangular vector (view coordinates). Gets the Relative point (world coordinates). Gets a value indicating if the Point is relative to point. Gets the selected entity #2 (2 for intersection). Gets the selected entity #1 (2 for intersection). Gets the Point (in world coordinates). Gets the identifier - Values, Center, Endpoint .... aPointData class. A managed representation of Mastercam's 'aPoint' structure. The selected entity's database pointer (DB_LIST_ENT_PTR). Initializes a new instance of the entData class. The selected entity's database pointer. The first 't' value. The second 't' value. Gets or sets the selected entity's 't' values. Gets selected entity's database pointer (DB_LIST_ENT_PTR). entData class. A managed representation of Mastercam's 'eSel' structure. Initializes a new instance of the sPoint class. The x coordinate. The y coordinate. Gets or sets the y-coordinate of the point. Gets or sets the x-coordinate of the point. sPoint class. A managed representation of Mastercam's 'ip' structure. Flags for specifying event options. An enum constant representing the 'disallow use of auto-cursor bar' option. An enum constant representing the 'allow key release (Shift and Ctrl only)' option. An enum constant representing the 'Allow right mouse button down/up events' option. An enum constant representing the 'allow left mouse button down/up events' option. An enum constant representing the 'allow dragging with left button down' option. An enum constant representing the 'allow notify events' option. An enum constant representing the 'allow solid edge selection' option. An enum constant representing the 'allow solid face selection' option. An enum constant representing the 'allow solid body selection' option. An enum constant representing the 'allow double click events' option. An enum constant representing the 'allow command events' option. An enum constant representing the 'allow drag (mouse move)' option. An enum constant representing the 'allow window vector selection' option. An enum constant representing the 'allow window polygon selection' option. An enum constant representing the 'allow window selection' option. An enum constant representing the 'allow multiple entities' option. An enum constant representing the 'allow keypress' option. An enum constant representing the 'allow sketched entry' option. An enum constant representing the 'allow entity selection' option. An enum constant representing the 'allow point entity' option. An enum constant representing the none option. Query if Mastercam is running under an evaluation license (software licenses only). true if evaluation license, false if not. This method returns the currently active product level. The product level Mastercam is running. This method returns the currently active "user" type. The user type Mastercam is running in. This method returns the currently active "product" type in Mastercam. The product mode Mastercam is currently in. Note that this does not return information regarding any active machines, but rather information regarding the product itself and could include modes, such as Drafting and Design. Gets the serial number from the Mastercam license. The Serial number. Writes the active configuration to a configuration file. The (full path) name of the Config file. true if it succeeds, false if it fails. Reads configuration file. The (full path) name of the Config file. true to repaint graphics. true if it succeeds, false if it fails. This method is used for changing Inch / Metric configuration in the system. True and the system is changed to Metric, else false and the system is changed to Inch. How the settings are to be changed. You can display the standard Units Changing dialog to ask the user, or... Set the option you want "silently". True regenerate any Solids with the new settings. This method reloads the configuration file. Gets the active Configuration filename. Finalizes an instance of the Configuration class. Initializes a new instance of the Configuration class. This class is used for various Mastercam configuration items. Checks if black/white mode is being forced. If true, black/white mode is being forced. Gets the print setup data. Print setup date. Sets the print setup data. Print setup date. Gets the page setup data. Page setup date. Sets the page setup data. Page setup date. Gets the "in print preview" flag. In print preview flag. Sets the "in print preview" flag. In print preview flag. Previous flag state. Gets the "in black/white" flag. In black/white flag. Sets the "in black/white" flag. In black/white flag. Previous flag state. Gets the "in page setup" flag. In page setup flag. Sets the "in page setup" flag. In page setup flag. Previous flag state. Gets the "in hardcopy" flag. In hardcopy flag. Sets the "in hardcopy" flag. In hardcopy flag. Previous flag state. Determine if the entity should be auto highlighted according to Cnc::Globals::Graphics::SetAutoHighlightFilter. The entity to check. True if entity should be highlighted, false if not. Gets the "show I-beam" master switch. If true, display the I-beam. Sets the "show I-beam" master switch. If true, display the I-beam. Previous show state. Gets the "show line axes" flag. If true, display line axes. Sets the "show line axes" flag. If true, display line axes. Previous show state. Gets the "show level name" flag. If true, display level name. Sets the "show level name" flag. If true, display level name. Previous show state. Gets the "display WCS axes" flag. If true, display axes; if false, don't display axes. Sets the "display WCS axes" flag. If true, display axes; if false, don't display axes. Previous flag state. Gets the "display viewport axes" flag. This flag actually controls the display of the view gnomon or cube, view name, and I-beam. If true, display axes; if false, don't display axes. Sets the "display viewport axes" flag. This flag actually controls the display of the view gnomon or cube, view name, and I-beam. If true, display axes; if false, don't display axes. Previous flag state. Gets the "view cube relative to WCS" flag. If true, relative to WCS; if false, equal to world. Sets the "view cube relative to WCS" flag. If true, relative to WCS; if false, equal to world. Previous flag state. Gets the display text scale for the view name and I-beam scale. Text scale [1., 5.]. Sets the display text scale for the view name and I-beam scale. Text scale [1., 5.]. Previous scale. Gets the view cube text scale. Text scale [1., 2.]. Sets the view cube text scale. Text scale [1., 2.]. Previous scale. Gets the corner gnomon scale. Gnomon scale [1., 5.]. Sets the corner gnomon scale. Gnomon scale [1., 5.]. Previous scale. Gets the view cube scale. Cube scale [1., 5.]. Sets the view cube scale. Cube scale [1., 5.]. Previous scale. Gets the view gnomon scale. Gnomon scale [1., 5.]. Sets the view gnomon scale. Gnomon scale [1., 5.]. Previous scale. Gets the view cube opacity. Cube opacity [0, 100]. Sets the view cube opacity. Cube opacity [0, 100]. Previous opacity. Gets which view widget is currently displayed. VIEW_GNOMON or VIEW_CUBE. Sets which view widget is currently displayed. Widget type: VIEW_GNOMON or VIEW_CUBE. Previous type. This method executes a run_FT_command to the Mastercam application. This allows for running many Mastercam commands via a Function Table command (string) as if the user had selected it via the UI. Execution of the NET-Hook Add-In is paused until the called function returns.See the Mastercam.FT file for available commands. The command to be run. This method executes a run_FT_command to the specified application. This allows for running commands via a Function Table command (string) as if the user had selected it via the UI. Execution of the NET-Hook Add-In is paused until the called function returns. The name of the application to receive the command. The command to be run. This method executes a post_FT_command to the Mastercam application. This allows for running many Mastercam commands via a Function Table command (string) as if the user had selected it via the UI. This is a "fire and forget", which means that the NET-Hook Add-In does not pause execution and wait for the called function to complete.See the Mastercam.FT file for available commands.Some example commands:OnPlanesTopOnPlanesFrontOnPlanesBackOnPlanesBottomOnPlanesEqualsWcsAnd many more... The command to be run. This method executes a post_FT_command to the specified application. This allows for running commands via a Function Table command (string) as if the user had selected it via the UI. This is a "fire and forget", which means that the NET-Hook Add-In does not pause execution and wait for the called function to complete. The name of the application to receive the command. The Function Table command to be run. This method runs an external command prompt command string. The command string to run in the command prompt. Whether to wait for the command prompt to return before continuing. This method runs a .NET (.csx or .vbx) Script. *NOTE* - This "preview" functionality is only available in Mastercam X8! The additional required .NET Scripting support DLLs are must be available. The full path and file name of the Script to run. False if the script file could not be found or executed, True otherwise. Initializes a new instance of the ExternalAppsManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used to manage the running and execution of external apps. Gets or sets the current post processor arguments in Mastercam. Initializes a new instance of the PostingManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used for working with Mastercam post processor settings. It allows for passing (3) string variables from a Post Processor to a NET-Hook, and also passing (3) values back from the NET-Hook to the Post. Gets or sets the third post processor argument. Gets or sets the second post processor argument. Gets or sets the first post processor argument. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to represent a polygon. @par Purpose: get the tp-configurable ridge test (internal sharp corner test) setting @param[out] flag the ridge test setting (true-do test, false-do not do test) @par Purpose: find base surface pointer and accumulate any offset @param[in] ptrent pointer to selected (offset/trim/base)srf @param[out] offdis_out total offset from base surface @param[out] ptrbas_out pointer to base surface @param[out] basesrf_out the base surface @param[out] bas_ent_out the base ent Determines the appropriate icon size for the given window's font. The window. 16, 24 or 32. Gets ptr to the the global operation manager tree control. (Optional) true to display debug warning on failure. null if it fails, else the operation manager tree control. Gets temporary database information stored in m_TempDbInfoArray. The temporary database information. Appends the debug menu to the end of the context mennu. [in,out] The menu to add the debug menu to. Move insert arrow item before hItem. Handle of the item to move before. [in,out] list of tree items, nullptr if you want to read the items from the tree. Call UITreeCtrl::EnsureVisible() after positioning the arrow. (Optional) select the insert items after it's moved. The handle of the tree item. Move insert arrow item before or after a group or operation branch. Identifier for the group or operation (>0 = op ID, <0 group ID. -1 = before, 1 = after. Call UITreeCtrl::EnsureVisible() after positioning the arrow. (Optional) select the insert items after it's moved. The handle of the insert arrow item. Move insert arrow item. Move down (> 0) or up (< 0) number of items in the tree. Call EnsureVisible() after positioning the arrow. (Optional) select the insert items after it's moved. The handle of the insert arrow item. Move insert arrow item. move insert item after this item. [in,out] list of tree items, nullptr if you want to read the items from the tree. call UITreeCtrl::EnsureVisible() after positioning the arrow. (Optional) select the insert items after it's moved. The handle of the insert arrow item. Select the dependents of the given operations. on, off or toggle. Executes the itemexpanded action. [in,out] The TV item. Gets item by handle from m_spAllItems. The handle to find in the array. the item info if found. If non-null the source items to look thru, else build and use m_spAllItems. return true if found, false if not. Loads the operations. The branch map containing whether the branches are expanded or collapsed. List of operation IDs of operations considered hidden by their owner group. Loads the groups. The branch map containing whether the branches are expanded or collapsed. List of group IDs of groups marked hidden. Gets selected information into m_SelectedInfo. (Optional) If non-null, source for the items. true if m_SelectedInfo initialized, false if it fails. Enables/Disables Group tree items based on the current product. The machine group product types to enable. (Optional) true = also enable all machine groups with products enabled on the sim. Build a list of product codes based on sim license and ProdEnableBits() A set of product codes. Add a library operation. Calls edit_operation directly. Created for hole-making in order to bypass the point selection panel. The operation code The uninitialized operation to be added. Create an operation ependency report. True = output just selected operations. Dumps an item array to a temporary file. Array of items. Format group branch text including the group comment. Identifier for the group. Name of the group. The formatted group branch text. Edit a Group using the EditGroupPropertiesDlg. Identifier for the group. The page of the Edit Group Properties Dialog to display. true to create a new group. Appends a group machine description to treeString. The tree string to append to. The op_group containing the Machine. Gets the collection of sub-Tree Items to drag for the given HTREEITEM. Handle of the parent Tree Item to drag. Source array of all possible Tree Items to drag. Target array of Tree Items found to actually drag. The drag items. Select a range of operations. The first operation ID in the range. The last operation ID in the range. True to select dependents as well. True if it succeeds, false if it fails. Initializes the TV item. If non-null, the TV. If non-null, the operation. The branch type. (Optional) If non-null the surface counts, null = create new EntityCounts. Loads the tree. true = save insert arrow location. The branch map containing whether the branches are expanded or collapsed. Updates the current machine group idn. Set the slot # in toolpath groups based on tree order. True if it succeeds, false if it fails. Sort operation identifiers by regeneration order. List of operation identifiers to sort. True to reverse order (i.e. deletion order). Pointer to file info, nullptr will create one (expensive). True if it succeeds, false if it fails. Builds a list of post text for the given machine group. Identifier for the machine group. True to force loading. True if it succeeds, false if it fails. Creates machine group. The product PRODUCT_MILL, PRODUCT_LATHE, PRODUCT_ROUTER, or PRODUCT_WIRE. Remove bad characters from the group name (':' is not allowed) . The suggested group name. true = truncate at first instance of ':' which denotes the start of the group comment, false = swap with a hyphen '-'. The corrected group name. Makes a toolpath group. Name of the group. Nullptr if it fails, else a pointer to an op_group. Determines if we are in restore temporary database. true if we are, false otherwise. Build and returns a vector of operation ID's in proper regeneration order. A vector of already selected operation IDs to find dependents for. The mask to search for operation IDs. If non-null, current file info. vector of operation ID's in proper regeneration order. Values that represent regeneration mask to pass to GetRegenOpIDs(). Set the slot # in operations based on tree order. True to sort opList in the OpMgr order. True if it succeeds, false if it fails. Move an operation in the tree. Identifier for the operation to move. Identifier for the target (>0 = operation, <0 = group). -1 = before, 1 = after. Call UITreeCtrl::EnsureVisible() after positioning the arrow. true if it succeeds, false if it fails. Create a class that will call Refresh() and will refresh operations upon destruction. (Optional) the operation IDs to refresh, nullptr for all operations and their children. A std::unique_ptr. Pop-up dialog warning the user that dirty operations are selected. An int relflective of the dialog's selected radio button. Initializes the file name for an NCI Path. Name of the which. [in,out] If non-null, filename of the file. (Optional) The group idn. True if it succeeds, false if it fails. Restore temporary database. Filename of the temporary file. True if it succeeds, false if it fails. Saves the temporary database. A string file name for the saved database. Executes an arrow key action in the Op Manager tree. The key (VK_UP, VK_DOWN, VK_LEFT, or VK_RIGHT). (Optional) true if this came from a keypress, not a button click (default is false). Posts the selected operations. Adds a group item. If non-null, the gpl. If non-null, the operation. If non-null, the ogi. The handles of the added tree items. Adds an operation item. If non-null, the operation. True = add operation after the red arrow. True to refresh all operations, not just this one (expensive). An INT_PTR. Deletes the operation by identifier from the current db. Identifier for the operation. True to mark dependent operations dirty. True to sort global operation list after delete. (Optional) Pointer to file info. (Optional) True to update toolpath images (solids manager). first = list of deleted group IDs, second = list of deleted operation IDs. Get the id of the last operation in a previous toolpath group. Uses a recursive search to search all sub-groups. The DB id of the operation found or LONG_MAX if none found. Updates the plane names in the branches. the plane. Redraws the "only selected toolpaths" and "only associative geometries" options Select a single operation. The operation ID to select. True to select dependents as well. True to hard select (invoked an OnSelChanged()) . True to first clear any selections, false to append selections. True if it succeeds, false if it fails. Select all dirty operations. True to select dependents as well. Select all to operations. Type of the selection (off/on/toggle). Gets a pointer to the selected group. true to use insert arrow to determine the selected group, false = use tree's highlighted item. Null if it fails, else a pointer to the selected group. Update system parameters that change with the active machine group. True to update lathe stock boundaries. (Optional) If non-null, the machine gpl vs the active group. (Optional) True - being called from DbProcess (i.e. reading in a file). (Optional) True - skip checking if machine group changed. Show or hide the lathe boundaries at the current insert arrow position, if any. Current machine group. (Optional) If true, repaint the graphics. Gets pointer to active machine group. null if it fails, else the machine group. Refresh group with the ID. Identifier for the group. An array index, -1 for error. Remove and re-add the operation and all its child items. The operation to replace. True to refresh all, not just one. true if it succeeds, false if it fails. Compare old/new versions of the same operation, call the appropriate refresh or replace function. The operation before the change. The same operation after the change. True to refresh all, not just one. true if it succeeds, false if it fails. Refresh operation with the ID. Identifier for the operation. An array index, -1 for error. Gets group TV item by ID. Group ID.. Source for the items, nullptr to reference m_spAllItems. [in,out] the group's TV_ITEM. Array index of op's branch, -1 for error. Gets operation TV item. The operation ID. Source for the items, nullptr to reference m_spAllItems. [in,out] The operation's TV_ITEM. Array index of op's branch, -1 for error. Loads all branch items into m_spAllItems. Size of array in m_spAllItems. Destructor. Constructor. [in,out] Manager for operations. Class that will call Refresh () upon destruction Destructor. Default constructor. Operations Manager Tree Control Does way to many things, needs to be refactored into Business Logic and User Interface components. Unselect operations. The operation IDs to select. Select a group of operations. Handle of the group. True to select dependents as well. Gets selected TV item. If non-null, the TV selected. If non-null, (Optional) the HtreeItemMap map. Index of the selected TV item, -1 if not found. Sets the value of m_HideGroupsAndOperations. The previous value of m_HideGroupsAndOperations. Read through the operation list, return true if any operation is owned my a hidden group. True if an operation that is owned by a hidden group is found, false if no groups are marked as hidden. Read through the group list, return true if any group is marked as hidden. True if a hidden group was found, false if no groups are marked as hidden. Initialises the operation text. the operation. The index. A CString. Gets the branch items in the tree. [in,out] Target array to copy items into. size of theItems array. Gets all the items under a group. Handle for the item. [in,out] Target for the items. specifies the types of item, 0 for all. The items under group. Gets operation or group item that owns the highlighted item into a TV_ITEM_INFO. [in,out] The highlighted item. [in,out] (Optional) If non-null, (Optional) the HtreeItemMap map. true if found, false if not. Check if item is hidden. Handle of the item. The item that needs to be expanded. true if hidden, false if visible. Fills in an array of parent items, root item at the top. Handle of the start item. [in,out] The parent items. [in,out] The number of collapsed items. Number of parent items in parentItems. Sets the item in the tree. [in,out] ptr to the TV_ITEM to set. [in,out] If non-null, source for the items. [in,out] If non-null, the HtreeItemMap map. true if it succeeds, false if it fails. Gets the arrow item. [in,out] The arrow item. array index of arrow item -1 if not found. Builds branch information map from the group and operation list stored in this tree. The map to fill in. Branch type mask. Size of expandedMap. Gets the parent group or operation items for any item. Handle of the child item. Type of the branch (TV_GROUP or TV_OPERATION). Map of HTREEITEMs and array indices into m_spAllItems. list of tree items, nullptr if you want to read the items from the tree. Group or toolapth parent item found. Handle to parent group or operation item. Gets the next item in tree. The current item. [in,out] The indent change. The next item in tree. Builds a map of HTREEITEM's and their array location. The items. The map. sizeof map. Removes entries in m_spAllItems by HTREEITEM value so we don't have to call the expensive BuildAllItems(). Set of branch items' handles to remove . Number of items found and removed from m_spAllItems. Gets operations' branch items. List of identifiers for the operations. True to return list of items in deletion order. list of tree items, nullptr if you want to read the items from the tree. The group branch items. Gets groups' branch items and any of its child items for the given group ID. List of identifiers for the groups. List will be updated if subgroups are asked for and found. True to include child groups, false to not. True to return list of items in deletion order. list of tree items, nullptr if you want to read the items from the tree. The group branch items. Deletes the operation by identifier from the current db. Identifier for the operation. True to mark dependent operations dirty. True to sort global operation list after delete. (Optional) Pointer to file info. (Optional) True to update toolpath images (solids manager). first = list of deleted group IDs, second = list of deleted operation IDs. Deletes the operations in the buffers described by typeMask from the current db. (Optional) The buffer type mask. first = IDs of groups deleted, second = IDs of operations deleted. Expand operations and/or groups. true to expand, false to collapse. -1 = groups, 1 = operations, 0 = both. Sets the values of m_DumpCurRemoveEntityId and m_DumpExtRemoveEntityId. The previous values of m_DumpCurRemoveEntityId and m_DumpExtRemoveEntityId. Gets the values of m_DumpCurRemoveEntityId and m_DumpExtRemoveEntityId. The values of m_DumpCurRemoveEntityId and m_DumpExtRemoveEntityId. Sets the values of m_DumpCurExpanded and m_DumpExtExpanded. The previous values of m_DumpCurExpanded and m_DumpExtExpanded. Gets the values of m_DumpCurExpanded and m_DumpExtExpanded. The values of m_DumpCurExpanded and m_DumpExtExpanded. Gets the value of m_HideGroupsAndOperations. The value of m_HideGroupsAndOperations. Hides hidden groups and operations from the tree list. True to remove hidden groups and operations from the tree, false to show. True to force reload of tree. first = previous hide value, second = true mean tree was reloaded. Loads operation manager image list. Loads the tree. true = save insert arrow location. (Optional) TVE_COLLAPSE, TVE_EXPAND or 0 for what the op_group.expanded is already set to. (Optional) TVE_COLLAPSE, TVE_EXPAND or 0 for what the operation.db.expanded already set to. (Optional) TVE_COLLAPSE, TVE_EXPAND or 0 for what the operation.db.geometry_expanded is already set to. Gets item by handle from m_spAllItems. The handle to find in the array. the item info if found. (Optional) if not found in pSource, do it the hard way with the standard GetItem(). (Optional) If non-null the source items to look thru, else build and use m_spAllItems. Array index if found, -1 on error. Removes the operation branches for opID, but not from the underlying array or current database. Identifiers for the operation. Number of branches removed. Refresh the selected operations. Refreshes the items of the given operation IDs. The operation IDs to refresh. Gets the group IDs in tree order. true = include hidden groups (and reload tree if necessary), false = just the groups listed in the tree control. The group IDs in tree order. Gets a list of operation identifiers from tree in tree order. true = include operations (and reload tree if necessary), false = just the operations listed in the tree control. The operation identifiers from the tree in tree order. Gets the arrow item. The arrow item. Array index into m_spAllItems of the arrow item. Refresh all the branch items. Builds branch information map from this tree control. The map to fill in. Branch type mask. Size of expandedMap. return true if refresh is enabled. true = refresh is enabled. Create a class that will set m_EnableRefresh and restore the previous value upon destruction. The enable refresh state. A std::unique_ptr. Create a class that will call BuildAllItems() upon destruction. A std::unique_ptr Create a class that will disable redraw and refresh and then re-enable upon destruction. True to disable redraw. True to disable refresh. A std::unique_ptr. Gets a reference to the OperationsArray child object. The operations array reference. Returns a const raw ptr to the ITEMARRAY in m_spAllItems. const raw ptr to the ITEMARRAY in m_spAllItems. Defines an alias representing a map of HTREEITEM and array indices into an ITEMARRAY. Defines an alias representing a map with branch info. Values that represent mouse buttons. Set refresh state and restore previous upon destruction. Disables the rebuild on destruction. Destructor. Constructor. [in,out] Manager for operations. Class that will call BuildAllItems upon destruction to keep m_spAllItems up to date with the tree. Assignment operator. The object. A shallow copy of this object. Copy constructor. The object. Default constructor. Information describing the selected item. Enables/disables redraw and refresh of tree. True to enable, false to disable the redraw. True to enable, false to disable the refresh. Destructor. Constructor. The operation manager tree. True to disable redraw. True to disable refresh. Disables redraw and refresh states of tree. Less-than comparison operator. The object. true if the first parameter is less than the second. Constructor. Type of the branch. The group or operation ID of the branch. The map key. Constructor. The branch handle. true if expanded. Values that represent branch types. Fills in a map with expanded states of group and operation branches. The map to fill in. The size of expandedMap. Assignment operator. The object. A shallow copy of this object. Assignment operator. The object. A shallow copy of this object. Copy constructor. The object. Destructor. Default constructor. Machine group info to compare for any changes. class to contain machine groups' custom post text. Mark any solid check or drive surfaces as such. The solid entityn. The id of the toolpath operation. True if we want to show check surfaces. True if we want to show drive surfaces. The mastercam color index to draw drive surfaces with. Loads machine group's post text into m_spGroupPostText. List of identifiers for the groups. True if it succeeds, false if it fails. Assign standard image IDs. If non-null, the identifiers. The image cx. Sets the views in the group from the active system views. [in,out] If non-null, the group. Prepare check drive display. Erases any temporarily stored check and drive display information. Checks if a wireframe entity is being shown as highlighted geometry. True if shown, false otherwise. Gets stock model in file. The stock model in file. Get the stock model size. Identifier for the operation. number of triangles (or 0). data size (triangles and nodes) (or 0). true if it succeeds, false if it fails. Loads stock model in file m_spStockModelInFile. true if it succeeds, false if it fails. if one pinch turn op is cut then automatically cut the other pinch op. Array of Operationd Ids to match. Remove BackupOps that match the given predicate. Predicate to apply to every BackupUp. Gets a reference to the m_RegenNEST collection. The a reference to m_RegenNEST. Gets a reference to the m_RegenMORE collection. The a reference to m_RegenMORE. Gets surface entity counts for an operation. The operation's ID. The surface entity counts for the operation. Check surface operation to see if it has geometry branches. The operation. (Optional) If non-null the surface counts, null = call GetSurfaceEntityCounts(). true if geometry branches are needed, false if not. Adds group ID with NC prefix and suffix to m_NcSuffixMap. Identifier for the group. true if it succeeds, false if it fails. Sets flag to indicate the op manager tree is used for editing defaults file from control definition dialog. True if it is editing defaults from control definition manager, otherwise false. Query if this op manager tree is inside operation defaults dialog in the control definition dialog. True if it is editing operation defaults file from control definition, false if not. Adds an operation to the add ops list. Non-null pointer to the operation to add. The operation list buffer. The index of the added item. Move operations from the delete or cut operations buffer back into the global operation list so they can really be deleted from the db. List of identifiers for the operations move out of the buffer. Reference to delete or cut buffer info. List of buffered operations. first = list of group IDs that were created to own the unbuffered operations in case those groups were deleted after the operations were moved into the buffer, second = list of operation IDs moved from the buffer back into the global operation list. Deletes the operations from the given buffer from the db. Reference to the buffer containing the operations to permanently delete. The operations to delete. first = list of deleted group IDs, second = list of deleted operation IDs. Gets a map of Group Ids to op_group pointers. The map. Deletes the operations in the buffers described by typeMask from the current db. The buffer type mask. first = IDs of groups deleted, second = IDs of operations deleted. Move operations from the delete or cut operations buffer back into the global operation list so they can really be deleted from the db. List of identifiers for the operations move out of the buffer. The buffer type mask. first = list of group IDs that were created to own the unbuffered operations in case those groups were deleted after the operations were moved into the buffer, second = list of operation IDs moved from the buffer back into the global operation list. Deletes the operation described by opId. Identifier for the operation. True if it succeeds, false if it fails. Executes an action each on the given item and all of its siblings and children. Handle of the tree item from which the iteration should begin. Function to execute on each item. The first parameter is the handle to the current item and the second parameter specifies whether iteration should continue. True if the iteration should continue, and false otherwise. Sets the redraw state of the tree control. Set to false to disable redraw, true to allow redraw. Executes an action on every item contained in this tree. Function to execute on each item. The first parameter is the handle to the current item and the second argument specifies whether execution should continue. Ensures that the given item is visible. Handle of the item to be made visible. TRUE if it succeeds, FALSE if it fails. @par Purpose: export operations with all their assoc geometry to an external file @param[in] fname destination file to open @param[in] op_ids op numbers to export @param[in] grpname name of group to export it under @param[in] just_op true = export just the operation - no geometry @param[in] no_duptool_chk true do not check for similar tools in destination library @param[out] succf true = operation added to current db @par Purpose: import operations with all their assoc geometry from an external file @param[in] fname source file to open and search @param[in] pOrigin_pt predefined origin pt, NULL to call point_proc() @param[in,out] op_ids op numbers to import, list will be update to new id's @param[in] n_ops # of operations in list @param[in] just_op true = import just the operation - no geometry @param[in] get_groups 0 = don't import op groups, 1=import op groups, -1=ask @param[in] calc_fs true = recalc speed and feed to current material @param[in] assign_views true = use system views, false=use views stored with op @param[in] duptool_chk check for similar tools @param[in] expand_ops true = expand new operation in operation manager @param[out] succf true = operation found and added to current db @param[in] display true = display debug progess messages @par Purpose: import all operations with all their assoc geometry from an external file @param[in] fname source file to open and search @param[in] pOrigin_pt predefined origin pt, NULL to call point_proc() @param[out] op_ids op ids that were to imported @param[in] just_op true = import just the operation - no geometry @param[in] get_groups 0=don't import op groups, 1=import op groups, -1=ask @param[in] calc_fs true = recalc speed and feed to current material @param[in] assign_views true = use system views, false = use views stored with op @param[in] duptool_chk check for similar tools @param[in] expand_ops true = expand new operation in operation manager @param[in] display true = display debug progess messages @param[out] succf true = operation found and added to current db operation parameters - common tool parameters for all operation types Gets or sets a value that represents the Mastercam's external flag for whether or not the screen is in print preview mode. Gets or sets a value that represents Mastercam's external global variable for whether or not the screen is in 'Hardcopy' mode. Gets or sets a value indicating the visibility of the display of toolpath information in the viewports. Gets or sets a value indicating the visibility of the WCS axes in the lower right-hand corner of the graphics window / viewport. Gets or sets a value indicating the visibility of the view axes in the lower left-hand corner of the graphics window / viewport. Clears all Group and/or Result color markings. The mask defining which color markings are to be cleared. This method forces user input focus to the Mastercam graphics window / viewport. This method updates the screen using Mastercam's internal display list. true: do immediate update. it will bypass the message queue and repaint graphics screen immediately. false: do update via message. true: forces a repaint of the active graphics view by rebuilding the geometry entities. This only occurs if "immediate" param is false. This method repaints the screen using Mastercam's internal display list. If true, then Mastercam will first fully regenerate the internal display list before repainting the screen. This method repaints the screen using Mastercam's internal display list. Performs an animated screen unzoom by the scale amount. The scale factor. This method calls Mastercam's internal 'Fit then Unzoom' functionality. The scale factor. The does Fit Screen followed an Unzoom (using the specified scale factor) This method calls Mastercam's internal 'Fit then Unzoom' functionality. The does Fit Screen followed an Unzoom (using a scale factor of 0.8) This method calls Mastercam's internal 'UnZoom Previous' function. This method calls Mastercam's internal 'UnZoom' function. This method fits the screen dimensions make visible all of the chains passed in to this method. The array of all the chains that should be visible after the screen fitting is complete. This value will be added to the outer extents of the chains passed in order to serve as a margin for the viewport. This method fits the screen dimensions to a set of specified coordinate values. This should be the point whose 2D coordinate values will become the center of the viewport. This should be the value to become the height of the viewport. This method fits the screen dimensions to a set of specified coordinate values. This should be the point whose 2D coordinate values will become the coordinates of the upper left-hand corner of the viewport. This should be the point whose 2D coordinate values will become the coordinates of the lower right-hand corner of the viewport. This method fits the screen dimensions to a set of specified coordinate values. This should be the x value of the point to become the new upper left-hand corner of the viewport. This should be the y value of the point to become the new upper left-hand corner of the viewport. This should be the x value of the point to become the new lower right-hand corner of the viewport. This should be the y value of the point to become the new lower right-hand corner of the viewport. This method fits the screen dimensions to make all of the geometry in the file visible. Initializes a new instance of the GraphicsManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used for performing graphics-related tasks and activities. Convert view mode. The operation view mode. The view converted mode. Executes the setup sheet on selected operations without user interface. The resulting XML files. true if it succeeds, false if it fails. Executes the setup sheet on selected operations without user interface. The resulting XML files. true if it succeeds, false if it fails. Run a setup sheet run for selected operations with no UI. strings to use instead of dialog items (Programmer, etc), this is a key/value pairing rpx templates. generate automatic images (y/n). generate automatic operation images (bAnyImages must be true). generate color images (bAnyImage or bOpImages must be true). A Setup sheet view modes enumeration value, 0=WCS, 1=TPLANE, 2=Isometric relative to WCS, 3=Isometric (WORLD). display results in viewer (y/n). write PDF files (bUseViewer must be false). list xml written. (optional) write ALL of the XML data? true if it succeeds, false if it fails. Run a setup sheet run for selected operations with no UI. strings to use instead of dialog items (Programmer, etc), this is a key/value pairing rpx templates. generate automatic images (y/n). generate automatic operation images (bAnyImages must be true). generate color images (bAnyImage or bOpImages must be true). A Setup sheet view modes enumeration value, 0=WCS, 1=TPLANE, 2=Isometric relative to WCS, 3=Isometric (WORLD). display results in viewer (y/n). write PDF files (bUseViewer must be false). list xml written. (optional) write ALL of the XML data? true if it succeeds, false if it fails. Run a setup sheet run for selected operations with no UI. strings to use instead of dialog items (Programmer, etc). rpx templates. generate automatic images (y/n). generate automatic operation images (bAnyImages must be true). generate color images (bAnyImage or bOpImages must be true). A Setup sheet view modes enumeration value,0=WCS, 1=TPLANE, 2=Isometric relative to WCS, 3=Isometric (WORLD). display results in viewer (y/n). write PDF files (bUseViewer must be false). list xml written. (optional) write ALL of the XML data? true if it succeeds, false if it fails. Run a setup sheet run for selected operations with no UI. strings to use instead of dialog items (Programmer, etc). rpx templates. generate automatic images (y/n). generate automatic operation images (bAnyImages must be true). generate color images (bAnyImage or bOpImages must be true). A Setup sheet view modes enumeration value,0=WCS, 1=TPLANE, 2=Isometric relative to WCS, 3=Isometric (WORLD). display results in viewer (y/n). write PDF files (bUseViewer must be false). list xml written. (optional) write ALL of the XML data? true if it succeeds, false if it fails. Run the material list [out] List of XML files that were written. True if successful, false if not. Run the tool list [out] List of XML files that were written. True if successful, false if not. Run the setup sheet bypassing the usual dialog. Strings to use instead of dialog items (Programmer, etc) MUST be a list of 8 items! The list of rpx templates to be used. Count MUST equal the number of Machine Groups in the file! Generate automatic images (y/n). Generate automatic operation images (anyImages must be true). Generate color images (anyImages or opImages must be true). 0=WCS, 1=TPLANE, 2=Isometric relative to WCS, 3=Isometric (WORLD). Display results in viewer (y/n). Write PDF files? (useViewer must be false). [out] List of XML files that were written. True to write ALL the XML data. True if successful, false if not. Run the setup sheet bypassing the usual dialog. Strings to use instead of dialog items (Programmer, etc) MUST be a list of 8 items! The list of rpx templates to be used. Count MUST equal the number of Machine Groups in the file! Generate automatic images (y/n). Generate automatic operation images (anyImages must be true). Generate color images (anyImages or opImages must be true). 0=WCS, 1=TPLANE, 2=Isometric relative to WCS, 3=Isometric (WORLD). Display results in viewer (y/n). Write PDF files? (useViewer must be false). [out] List of XML files that were written. True to write ALL the XML data. True if successful, false if not. Run the setup sheet bypassing the usual dialog. Strings to use instead of dialog items (Programmer, etc) MUST be a list of 8 items! The list of rpx templates to be used. Count MUST equal the number of Machine Groups in the file! Generate automatic images (y/n). Generate automatic operation images (anyImages must be true). Generate color images (anyImages or opImages must be true). 0=WCS, 1=TPLANE, 2=Isometric relative to WCS, 3=Isometric (WORLD). Display results in viewer (y/n). Write PDF files? (useViewer must be false). [out] List of XML files that were written. True if successful, false if not. Initializes a new instance of the ReportManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used to manage the running and execution of external apps. Gets or sets the geometry object representing the base curve geometry for this revolved surface. Gets or sets the line object of the axis of revolution for this revolved surface. Gets or sets the ending angle of the revolved surface's drawing in radians. Gets or sets the starting angle of the revolved surface's drawing in radians. Gets or sets the origin of the axis line. Gets or sets the axis vector. Loads the default values for a given surface geometry object from the geometry entity passed in. [in,out] The surface geometry entity to use as defaults for this surface geometry object. Commits a surface geometry entity to the Mastercam database. [in,out] The surface geometry entity to be committed. True if the commit was successful; false if not. Initializes a new instance of the RevolvedSurface class. Attempts to retrieve a surface geometry entity with the given ID from the Mastercam database and use that to initialize this surface geometry object. If no matching geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the surface geometry entity to look up in the Mastercam database. This class is used for working with revolved surface geometry in Mastercam. This method saves this object's 'smoothing' settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with smoothing settings. This method saves this object's 'arc filter' settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with arc filter settings. This method saves this object's 'tolerance distribution' settings (from the Arc Filter / Tolerance page) to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with tolerance settings. This method saves this object's break through settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with break through settings. This method saves this object's depth cuts settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with depth cuts settings. This method saves this object's cutter comp settings to the operation data member passed in. [in,out] The operation data member to load with cutter comp settings. This method saves this object's rough/finish settings to the operation data member passed in. [in,out] The operation data member to load with rough/finish settings. This method saves this object's (basic) cut parameter settings to the operation data member passed in. [in,out] The operation data member to load with cut parameter settings. This method load this object's smoothing settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with smoothing settings. This method load this object's arc filter settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with arc filter settings. This method loads this object's 'tolerance distribution' settings (from the Arc Filter / Tolerance page) from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with tolerance settings. This method load this object's break through settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with break through settings. This method load this object's depth cuts settings from the operation data member passed in. X7 [in,out] The operation data member to load with depth cuts settings. This method loads this object's cutter comp settings from the operation data member passed in. [in,out] The operation data member to load it's cutter comp settings from. This method loads this object's rough/finish settings from the operation data member passed in. [in,out] The operation data member to load it's rough/finish settings from. This method loads this object's (basic) cut parameter settings from the operation data member passed in. [in,out] The operation data member to load it's cut parameter settings from. Gets or sets the Smoothing settings used in this contour operation. Mastercam X7 Gets or sets the Arc Filter settings used in this contour operation. Mastercam X7 Gets or sets the Tolerance Distribution settings used in this operation. Arc Filter / Tolerance page Gets or sets the Break Through settings used in this operation. Mastercam X7 Gets or sets the Depth Cut Through settings used in this operation. Gets or sets the cutter comp settings to be used in this operation. Gets or sets the rough/finish settings to be used in this operation. Gets or sets the (basic) cut parameter settings to be used in this operation. This method takes the array passed in and copies it's contents into the internal chain array for this operation. The array of new chains. This method commits the current Slot Mill operation to the Mastercam database. true to update any chains assigned to the operation. If you know that you've not altered the chains used by this operation, you may wish to used this >.Commit(false). True if the database commit was successful and false if not. This method commits the current Slot Mill operation to the Mastercam database. This commit also updates any the chains used by this operation. If you know that do not want the chains touched during the commit, you may wish to use the .Commit(false) method overload. True if the database commit was successful and false if not. Initializes a new instance of the SlotMillOperation class. Loads the default values for a given operation object from the operation structure passed in. The operation structure to use as defaults for this operation object. Commits the operation. true to include, false to exclude touching the chains during the commit. true if it succeeds, false if it fails. ID Lookup Constructor. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Loads the default values for a given operation object. This class is used for working with slot mill toolpath operations. Gets r sets a value indicating the state of the 'Keep tool down' option. (true/false). Gets or sets the spacing of Finish Passes. Gets or sets the number of Finish Passes. Gets or sets the Roughing step-over distance. Gets or sets the Helix Tolerance for the Ramp Entry. Gets or sets the Plunge Angle for the Ramp Entry. Gets or sets a value indicating the state of the 'Output Helixes As Arcs' option. Gets or sets a value indicating the state of the 'Ramp Entry' option. Enable/disable the Ramp Entry (groupbox) options. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the Slot Mill Rough/Finish specific parameters. Gets or sets the amount the stock leave on walls and floors. Gets or sets this is the Entry Overlap amount setting in the current slot mill operation. Gets or sets a value indicating the Perpendicular Entry setting in the current slot mill operation. Gets the entry/exit arc sweep setting in the current slot mill operation. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the Slot Mill Rough/Finish specific parameters. Utility function that compresses the database. true if it succeeds, false if it fails. Display the browse for tool library to save or append dialog. Full path of the library file. Used as the start location of the dialog, and then used to return the selected library path. (Optional) HWnd of the parent. true if it succeeds, false if it fails. Display the browse for tool library to save dialog. Full path of the library file. Used as the start location of the dialog, and then used to return the selected library path. (Optional) HWnd of the parent. true if it succeeds, false if it fails. Display the browse for tool library to open dialog. Full path of the library file. Used as the start location of the dialog, and then used to return the selected library path. (Optional) HWnd of the parent. true if it succeeds, false if it fails. Queries if the library has been migrated. If it has, callers should call "GetLibraryPath" to retrieve an updated library path. true if the library has been migrated, false if not. Query if the library is updated. The library must be opened to perform this functionality. true if updated, false if not. Query if this object is open. true if open, false if not. Gets the full library path including the filename. The library must be opened to perform this functionality. The library path. Gets library filename including the extension. The library must be opened to perform this functionality. The library filename. Gets the library data version. The library must be opened to perform this functionality. The library data version. Gets the library schema version. The library must be opened to perform this functionality. The library schema version. Performs a batch of changes including the addition of items, deletion of items, and the update of items. The items to add. The items to delete. The items to update. true if it succeeds, false if it fails. Deletes all items in the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlCutParams from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlToolGrades from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlManufacturers from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlToolTypes from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlToolGroups from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlMaterials from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlOpTypes from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlOpGroups from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlHolderLathes from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlInserts from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlHolders from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlToolLathes from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlToolMills from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlTools from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlAssemblies from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes the given lathe tools from the library. The library must be opened to perform this functionality. The items to delete. true if it succeeds, false if it fails. Deletes the given lathe tool from the library. The library must be opened to perform this functionality. The item to delete. true if it succeeds, false if it fails. Deletes the given items from the library. The library must be opened to perform this functionality. The items to delete. true if it succeeds, false if it fails. Deletes the given item from the library. The library must be opened to perform this functionality. The item to delete. true if it succeeds, false if it fails. Updates the given lathe tools in the library. The items must already exist in the library. The library must be opened to perform this functionality. The items to update. true if it succeeds, false if it fails. Updates the given lathe tool in the library. The item must already exist in the library. The library must be opened to perform this functionality. The item to update. true if it succeeds, false if it fails. Updates the given items in the library. The items must already exist in the library. The library must be opened to perform this functionality. The items to update. true if it succeeds, false if it fails. Updates the given item in the library. The item must already exist in the library. The library must be opened to perform this functionality. The item to update. true if it succeeds, false if it fails. Gets all lathe tools from the library. The library must be opened to perform this functionality. The vector of resulting items. true if it succeeds, false if it fails. Gets all lathe tools from the library. The library must be opened to perform this functionality. The manager to get all items to. true if it succeeds, false if it fails. Gets all connections from the library. The library must be opened to perform this functionality. The vector of resulting items. true if it succeeds, false if it fails. Gets all items from the library. Does not includes default assemblies (tools not in an assembly). The library must be opened to perform this functionality. The vector of resulting items. true if it succeeds, false if it fails. Gets all items from the library. Does not includes default assemblies (tools not in an assembly). The library must be opened to perform this functionality. The manager to get all items to. true if it succeeds, false if it fails. Gets all TlCutParams from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlToolGrades from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlManufacturers from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlToolTypes from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlToolGroups from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlMaterials from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlOpTypes from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlOpGroups from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlTurnHolders from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlTurnHolders from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlHolderLathes from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlInserts from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlHolders from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlToolLathes from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlToolMills from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlTools from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlTools from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all mill tools from the library. The library must be opened to perform this functionality. The manager to get all items to. true if it succeeds, false if it fails. Gets all TlAssemblies from the library. The library must be opened to perform this functionality. The resulting items. True to locally convert mill tools that are not in an assembly into an assembly with a default holder, and include them in the resulting items. true if it succeeds, false if it fails. Retrieves a specific object from the library associated to the specified identifier. The identifier. The result instance. True if it succeeds, false if it fails. Adds a vector of lathe tools to the library. The library must be opened to perform this functionality. The items to add. true if it succeeds, false if it fails. Adds a lathe tool to the library. The library must be opened to perform this functionality. The item to add. True if it succeeds, false if it fails. Adds the contents of a TlMgr to the library. The library must be opened to perform this functionality. The TlMgr to add. true if it succeeds, false if it fails. Adds a vector of TlObjectPtrs to the library. The library must be opened to perform this functionality. The items to add. true if it succeeds, false if it fails. Adds a TlObject item to the library. The library must be opened to perform this functionality. The item to add. true if it succeeds, false if it fails. Gets filter string. true if wire machine. The filter string. Creates new library at the specified libraryPath. The library file path, including the filename. true if it succeeds, false if it fails. Creates a backup up the opened library. Auto-generates backup filename, and places it in the same location as the opened library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Updates the library. The library must be opened to perform this functionality. (Optional) true to create a backup of the pre-updated library. true if it succeeds, false if it fails. Closes the library. Opens the specified library. Will create the library if it does not exist. Full pathname of the library file to open. true to update the library to the latest schema version. (Optional) true to create a backup of the pre-updated library. true if it succeeds, false if it fails. Destructor. Constructor. The tool library system class. Display the browse for tool library to save or append dialog. Full path of the library file. Used as the start location of the dialog, and then used to return the selected library path. (Optional) HWnd of the parent. true if it succeeds, false if it fails. Display the browse for tool library to save dialog. Full path of the library file. Used as the start location of the dialog, and then used to return the selected library path. (Optional) HWnd of the parent. true if it succeeds, false if it fails. Display the browse for tool library to open dialog. Full path of the library file. Used as the start location of the dialog, and then used to return the selected library path. (Optional) HWnd of the parent. true if it succeeds, false if it fails. Utility function that compresses the database. true if it succeeds, false if it fails. Queries if the library has been migrated. If it has, callers should call "GetLibraryPath" to retrieve an updated library path. true if the library has been migrated, false if not. Query if the library is updated. The library must be opened to perform this functionality. true if updated, false if not. Query if this object is open. true if open, false if not. Gets the full library path including the filename. The library must be opened to perform this functionality. The library path. Gets library filename including the extension. The library must be opened to perform this functionality. The library filename. Gets the library data version. The library must be opened to perform this functionality. The library data version. Gets the library schema version. The library must be opened to perform this functionality. The library schema version. Performs a batch of changes including the addition of items, deletion of items, and the update of items. The items to add. The items to delete. The items to update. true if it succeeds, false if it fails. Deletes all items in the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlCutParams from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlToolGrades from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlManufacturers from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlToolTypes from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlToolGroups from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlMaterials from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlOpTypes from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlOpGroups from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlHolderLathes from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlInserts from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlHolders from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlToolLathes from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlToolMills from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlTools from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes all TlAssemblies from the library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Deletes the given lathe tools from the library. The library must be opened to perform this functionality. The items to delete. true if it succeeds, false if it fails. Deletes the given lathe tool from the library. The library must be opened to perform this functionality. The item to delete. true if it succeeds, false if it fails. Deletes the given items from the library. The library must be opened to perform this functionality. The items to delete. true if it succeeds, false if it fails. Deletes the given item from the library. The library must be opened to perform this functionality. The item to delete. true if it succeeds, false if it fails. Updates the given lathe tools in the library. The items must already exist in the library. The library must be opened to perform this functionality. The items to update. true if it succeeds, false if it fails. Updates the given lathe tool in the library. The item must already exist in the library. The library must be opened to perform this functionality. The item to update. true if it succeeds, false if it fails. Updates the given items in the library. The items must already exist in the library. The library must be opened to perform this functionality. The items to update. true if it succeeds, false if it fails. Updates the given item in the library. The item must already exist in the library. The library must be opened to perform this functionality. The item to update. true if it succeeds, false if it fails. Gets all lathe tools from the library. The library must be opened to perform this functionality. The vector of resulting items. true if it succeeds, false if it fails. Gets all lathe tools from the library. The library must be opened to perform this functionality. The manager to get all items to. true if it succeeds, false if it fails. Gets all connections from the library. The library must be opened to perform this functionality. The vector of resulting items. true if it succeeds, false if it fails. Gets all items from the library. Does not includes default assemblies (tools not in an assembly). The library must be opened to perform this functionality. The vector of resulting items. true if it succeeds, false if it fails. Gets all items from the library. Does not includes default assemblies (tools not in an assembly). The library must be opened to perform this functionality. The manager to get all items to. true if it succeeds, false if it fails. Gets all TlCutParams from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlToolGrades from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlManufacturers from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlToolTypes from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlToolGroups from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlMaterials from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlOpTypes from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlOpGroups from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlTurnHolders from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlTurnHolders from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlHolderLathes from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlInserts from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlHolders from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlToolLathes from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlToolMills from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlTools from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all TlTools from the library. The library must be opened to perform this functionality. The resulting items. true if it succeeds, false if it fails. Gets all mill tools from the library. The library must be opened to perform this functionality. The manager to get all items to. true if it succeeds, false if it fails. Gets all TlAssemblies from the library. The library must be opened to perform this functionality. The resulting items. True to locally convert mill tools that are not in an assembly into an assembly with a default holder, and include them in the resulting items. true if it succeeds, false if it fails. Retrieves a specific object from the library associated to the specified identifier. The identifier. The result instance. True if it succeeds, false if it fails. Adds a vector of lathe tools to the library. The library must be opened to perform this functionality. The items to add. true if it succeeds, false if it fails. Adds a lathe tool to the library. The library must be opened to perform this functionality. The item to add. True if it succeeds, false if it fails. Adds the contents of a TlMgr to the library. The library must be opened to perform this functionality. The TlMgr to add. true if it succeeds, false if it fails. Adds a vector of TlObjectPtrs to the library. The library must be opened to perform this functionality. The items to add. true if it succeeds, false if it fails. Adds a TlObject item to the library. The library must be opened to perform this functionality. The item to add. true if it succeeds, false if it fails. Creates a backup up the opened library. Auto-generates backup filename, and places it in the same location as the opened library. The library must be opened to perform this functionality. true if it succeeds, false if it fails. Updates the library. The library must be opened to perform this functionality. (Optional) true to create a backup of the pre-updated library. true if it succeeds, false if it fails. Closes the library. Opens the specified library. Will create the library if it does not exist. Full pathname of the library file to open. true to update the library to the latest schema version. (Optional) true to create a backup of the pre-updated library. true if it succeeds, false if it fails. A tool library system interface. @par Purpose: Inspect contents of a text file to determine MBCS or some type of Unicode @param[in] lpFile Name of file to inspect @return true if BOM detected, or some other Unicode indicators, otherwise false @par Purpose: Convert an MBCS string to a wide string. @param[in,out] lpDest Output: The wide character buffer. @param[in] lpSrc Pointer to the MBCS string. @param[in] maxChars The maximumn number of wide characters the destination can hold. Must include the null terminator. @return The number of characters converted. * @par Purpose: # Reduces a string to an array of double numbers. * * @param[in] s1 A double number string (0. -3.2 .5) * @param[in] size_reals The maximum number of reals. * @param[out] reals The real numbers. * @param[out] n_elements The number of entries in reals. @par Purpose: Safe version of add_prefix_suffix. @param[in,out] filename the file name. @param[in] filename_length size of filename buffer. @param[in] prefix the prefix. @param[in] suffix the suffix. @param[out] filename file name with prefix and suffix. @par Purpose: This method adds a prefix to a filename if ':' or '\\' are not present. It also adds a suffix if '.' is not found. @param[in,out] filename the file name. @param[in] prefix the prefix. @param[in] suffix the suffix. @param[out] filename file name with prefix and suffix. @par Purpose: reduces a string containing a filename into the path, name and extension of the filename; filename is unaffected @param[in] fileName The complete file name (C:\\my mcam2019\\parts\\Design\\part.mcam) @param[out] prefix Path to the file (C:\\my mcam2019\\parts\\Design\\) @param[in] prefixCount prefix number of characters (NOT number of bytes) @param[out] name Name (part) @param[in] nameCount name number of characters (NOT number of bytes) @param[out] ext Extension (.mcam) @param[in] extCount extension number of characters (NOT number of bytes) @par Purpose: Insert a string into another string @param[in] prefix The string that acts as the prefix to string s @param[in,out] s The string that acts as the end of our composed string; returns the newly composed string @par Purpose: Insert a character into a string @param[in] c The character to insert @param[in,out] s The string to insert the character into @param[in] pos The position within the string to insert the character @par Purpose: Delete spaces from a string @param[in,out] lst The string to remove spaces from @par Purpose: Tests for a character in a string @param[in] s The string to test with @param[in] c The character to test for @return true if c is in string s; false if not @par Purpose: Safe version of build_filename. @param[in,out] filename Input: the string representing the new file name. Output: the filename with the full path and extension. @param[in] filename_length Size of filename buffer. @param[in] prefix The prefix for the new filename @param[in] suffix The suffix for the new filename @par Purpose: Extract name, add prefix and suffix. @param[in,out] filename Input: the string representing the new file name. Output: the filename with the full path and extension. @param[in] prefix The prefix for the new filename @param[in] suffix The suffix for the new filename @par Purpose: Parse and compact any string with multiple fields. changes newline to null, removes preceding and trailing white space, leaves only 1 space in between fields, removes trailing 0's from fields determined to be reals (decimal '.' exists in field) @param[in,out] str text string before/after compacting @par Purpose: Strip trailing zeros from a text string. @param[in,out] str text string before/after stripping trailing zeros Defines streq to be the opposite of the results of strcmp Defines streqi to be the opposite of the results of strcmpi @par Purpose: This method parses a string, performs math, and returns the calculated value. @param[in] lstr the string to parse. @param[out] succf true, if OK, else, false. @return the result of the calculation. Gets lathe holder list registry key name. The lathe holder list registry key name. Gets insert list registry key name. The insert list registry key name. Gets lathe lib tool list registry key name. The lathe tool list registry key name. Gets lathe part tool list registry key name. The lathe tool list registry key name. Query if the tool at the given slot number is a prime turning tool. The lathe tool slot number to search at. True if the tool at the given slot number is a prime turning tool, false if not. fix corrupt operation assembly identifier. [in,out] The operation. true if it succeeds, false if it fails. Refreshes the tool's profile data from the tool geometry source. The tool. True if tool is from library. This will influence where the profile is searched for when it cannot be found from file or level. Refreshes the tool's profile data from the tool geometry source. The tool. True if tool is from library. This will influence where the profile is searched for when it cannot be found from file or level. Stores a profile within the input tool. The tool. (Optional) true to warn about a custom tool's bad source profile. true if it succeeds, false if it fails. Validate tool profile. The newtool. Fix lollipop corner radius. The current operation. true if it succeeds, false if it fails. Recaclulates feeds and speeds based on work material settings. True if this is a drill tool, otherwise false. Flute Count. TlToolMaterialID in Mastercam _GUID format. Cutting Diameter. Feed rate. Plunge rate. Retract rate. Spindle speed. The feed percentage. The sfm percentage. The spindle rot. Type of the tool. true if this object is metric. The thds. true if feeds and speeds were successfuly recalculated. Query if the tool definition corresponding to the given slot number is being used by any toolpath operations. The tool definition slot. True if the slot is tied to a milling tool definition, false for lathe. (Optional) The operation identifier to exclude when searching. For use when checking from within the parameters of an existing operation. True if the specified tool definition is used by operations, false if not. Creates a localized string representing the given milling tool type. Type of the tool. The tool type text. Given two old lathe tools, compare them to find if they are equal. The first lathe tool. The second lathe tool. true if the lathe tools are equal. Given two old inserts, compare them to find if they are equal. The first insert. The second insert. true if the inserts are equal. Given two old holders, compare them to find if they are equal. The first holder. The second holder. true if the holders are equal. Initializes a new instance of the UndefinedTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the UndefinedTool class. Initializes a new instance of the UndefinedTool class. The identifier. This class is for identifying and using Undefined tools in Mastercam. This method commits a Barrel Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs true if it succeeds, false if it fails. Initializes a new instance of the BarrelMillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the BarrelMillTool class. Initializes a new instance of the BarrelMillTool class. The identifier. This class is for modifying and using Barrel Mill tools in Mastercam. This method commits a Thread Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs true if it succeeds, false if it fails. Initializes a new instance of the ThreadMillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the ThreadMillTool class. Initializes a new instance of the ThreadMillTool class. The identifier. This class is for modifying and using Thread Mill tools in Mastercam. This method commits a HighSpeed Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs true if it succeeds, false if it fails. Initializes a new instance of the FeedMillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the FeedMillTool class. Initializes a new instance of the FeedMillTool class. The identifier. This class is for modifying and using HighFeed Mill tools in Mastercam. This method commits a BradPointDrillTool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, else false if it fails. Initializes a new instance of the BradPointDrillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the BradPointDrillTool class. Initializes a new instance of the BradPointDrillTool class. The identifier. This class is for modifying and using Brad Point Drill tools in Mastercam. This method commits a Engrave tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the EngraveTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the EngraveTool class. Initializes a new instance of the EngraveTool class. The identifier. This class is for modifying and using Engrave tools in Mastercam. This method commits a Block Drill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, else false if it fails. Initializes a new instance of the BlockDrillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the BlockDrillTool class. Initializes a new instance of the BlockDrillTool class. The identifier. This class is for modifying and using Router Block Drill tools in Mastercam. This method commits a End Mill Bullnose tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the EndMillBullnoseTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the EndMillBullnoseTool class. Initializes a new instance of the EndMillBullnoseTool class. The identifier. This class is for modifying and using End Mill Bullnose tools in Mastercam. This method commits a Lollipop Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the LollipopMillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the LollipopMillTool class. Initializes a new instance of the LollipopMillTool class. The identifier. This class is for modifying and using Lollipop Mill tools in Mastercam. This method commits a Tapered Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the TaperedMillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the TaperedMillTool class. Initializes a new instance of the TaperedMillTool class. The identifier. This class is for modifying and using Tapered Mill tools in Mastercam. This method commits a Dove Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the DoveMillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the DoveMillTool class. Initializes a new instance of the DoveMillTool class. The identifier. This class is for modifying and using Dove Mill tools in Mastercam. This method commits a Radius Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the RadiusMillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the RadiusMillTool class. Initializes a new instance of the RadiusMillTool class. The identifier. This class is for modifying and using Radius Mill tools in Mastercam. This method commits a Slot Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the SlotMillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the SlotMillTool class. Initializes a new instance of the SlotMillTool class. The identifier. This class is for modifying and using Slot Mill tools in Mastercam. This method commits a Face Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the FaceMillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the FaceMillTool class. Initializes a new instance of the FaceMillTool class. The identifier. This class is for modifying and using Face Mill tools in Mastercam. This method commits a Chamfer Mill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the ChamferMillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the ChamferMillTool class. Initializes a new instance of the ChamferMillTool class. The identifier. This class is for modifying and using Chamfer Mill tools in Mastercam. This method commits a End Mill Spherical tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the EndMillSphericalTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the EndMillSphericalTool class. Initializes a new instance of the EndMillSphericalTool class. The identifier. This class is for modifying and using End Mill Spherical tools in Mastercam. This method commits a Counter Sink tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the CounterSinkTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the CounterSinkTool class. Initializes a new instance of the CounterSinkTool class. The identifier. This class is for modifying and using Counter Sink tools in Mastercam. This method commits a Counter Bore tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the CounterBoreTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the CounterBoreTool class. Initializes a new instance of the CounterBoreTool class. The identifier. This class is for modifying and using Counter Bore tools in Mastercam. This method commits a Simple Bore tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, else false if it fails. Initializes a new instance of the BoreTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the BoreTool class. Initializes a new instance of the BoreTool class. The identifier. This class is for modifying and using Simple Bore tools in Mastercam. This method commits a Reamer tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the ReamerTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the ReamerTool class. Initializes a new instance of the ReamerTool class. The identifier. This class is for modifying and using Reamer tools in Mastercam. This method commits a Left-Hand Tap tool to the Mastercam database . Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the TapLHTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the TapLHTool class. Initializes a new instance of the TapLHTool class. The identifier. This class is for modifying and using Left-Hand Tap tools in Mastercam. This method commits a Right-Hand Tap tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the TapRHTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the TapRHTool class. Initializes a new instance of the TapRHTool class. The identifier. This class is for modifying and using Right-Hand Tap tools in Mastercam. This method commits a Spot Drill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the SpotDrillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the SpotDrillTool class. Initializes a new instance of the SpotDrillTool class. The identifier. This class is for modifying and using Spot Drill tools in Mastercam. This method commits a Center Drill tool to the Mastercam database. true if it succeeds, false if it fails. Initializes a new instance of the CenterDrillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the CenterDrillTool class. Initializes a new instance of the CenterDrillTool class. The identifier. This class is for modifying and using Center Drill tools in Mastercam. Gets the list of Part History time-stamps. If successful, the list of part history timestamps from newest to oldest, else an empty list if no history data was found. Set the 'select' bit ON all entities on the specified level. This only affects geometry that is already committed to Mastercam's database! It does NOT effect the state of any .NET geometry objects. That is why it can be "fast". The Level# to select all geometry. true to clear existing selection before doing the new selection. The number of entities found and set as 'selected'. This method is used to determine if there are any specified toolpath groups in the current Mastercam part file. While the 'GetGroups' search manager methods can be used to determine if any toolpath groups exist, this method can be an order of magnitude faster than actually searching for all of the matching toolpath groups and returning them. The name of the groups to look for. The object representing the Mastercam group that is the parent of all the subgroups to look for. The type of machine all of the returned groups should come from. A boolean flag indicating whether there are any toolpath groups in the current part file with the matching parameters. This method is used to determine if there are any specified toolpath groups in the current Mastercam part file. While the 'GetGroups' search manager methods can be used to determine if any toolpath groups exist, this method can be an order of magnitude faster than actually searching for all of the matching toolpath groups and returning them. The type of machine all of the returned groups should come from. A boolean flag indicating whether there are any toolpath groups in the current part file with the matching parameters. This method is used to determine if there are any specified toolpath groups in the current Mastercam part file. While the 'GetGroups' search manager methods can be used to determine if any toolpath groups exist, this method can be an order of magnitude faster than actually searching for all of the matching toolpath groups and returning them. The object representing the Mastercam group that is the parent of all the subgroups to look for. A boolean flag indicating whether there are any toolpath groups in the current part file with the matching parameters. This method is used to determine if there are any specified toolpath groups in the current Mastercam part file. While the 'GetGroups' search manager methods can be used to determine if any toolpath groups exist, this method can be an order of magnitude faster than actually searching for all of the matching toolpath groups and returning them. The name of the groups to look for. A boolean flag indicating whether there are any toolpath groups in the current part file with the matching parameters. This method is used to determine if there are any specified toolpath groups in the current Mastercam part file. While the 'GetGroups' search manager methods can be used to determine if any toolpath groups exist, this method can be an order of magnitude faster than actually searching for all of the matching toolpath groups and returning them. A boolean flag indicating whether there are any toolpath groups in the current part file with the matching parameters. This method is used to determine if there are any specified toolpath operations in the current Mastercam part file. While the 'GetOperations' search manager methods can be used to determine if any toolpath operations exist, this method can be an order of magnitude faster than actually searching for all of the matching toolpath operations and returning them. The type of toolpath operation to look for or Undefined to ignore toolpath type. The ID of the group to look for toolpath operations in or -1 to ignore groups. True if the search is only to look for operations that are selected in the Toolpath Manager and false to ignore selection status. A boolean flag indicating whether there are any toolpath operations in the current part file with the matching parameters. This method is used to determine if there are any specified toolpath operations in the current Mastercam part file. While the 'GetOperations' search manager methods can be used to determine if any toolpath operations exist, this method can be an order of magnitude faster than actually searching for all of the matching toolpath operations and returning them. True if the search is only to look for operations that are selected in the Toolpath Manager and false to ignore selection status. A boolean flag indicating whether there are any toolpath operations in the current part file with the matching parameters. This method is used to determine if there are any specified toolpath operations in the current Mastercam part file. While the 'GetOperations' search manager methods can be used to determine if any toolpath operations exist, this method can be an order of magnitude faster than actually searching for all of the matching toolpath operations and returning them. The ID of the group to look for toolpath operations in. A boolean flag indicating whether there are any toolpath operations in the current part file with the matching parameters. This method is used to determine if there are any specified toolpath operations in the current Mastercam part file. While the 'GetOperations' search manager methods can be used to determine if any toolpath operations exist, this method can be an order of magnitude faster than actually searching for all of the matching toolpath operations and returning them. The type of toolpath operation to look for. A boolean flag indicating whether there are any toolpath operations in the current part file with the matching parameters. This method is used to determine if there are any toolpath operations that "use a tool" the current Mastercam part file. This will exclude non-tool operations such as Stock Model. Meaning if only "non tool" operations exist in the tree, this will return false. While the 'GetOperations' search manager methods can be used to determine if any toolpath operations exist, this method can be an order of magnitude faster than actually searching for all of the matching toolpath operations and returning them. A boolean flag indicating whether there are any toolpath operations in the current part file that use a tool. This method is used to determine if there are any operations in the current Mastercam part file. See the related While the 'GetOperations' search manager methods can be used to determine if any toolpath operations exist, this method can be an order of magnitude faster than actually searching for all of the matching toolpath operations and returning them. NOTE! This will return true if anything other than Machine Groups exist in the Toolpath Manager's list. This includes Stock Model operations! A boolean flag indicating whether there are any toolpath operations in the current part file. This method is used to determine if there are any specified Mill tools in the current Mastercam part file. While the 'GetTools' search manager methods can be used to determine if any Mill tools exist, this method can be an order of magnitude faster than actually searching for all of the matching Mill tools and returning them. The type of tool to look for or an Undefined tool to look for all tools. The ID of the machine group to look for tools in or -1 to look throughout all machine groups. A boolean flag indicating whether there are any Mill tools in the current part file with the matching parameters. This method is used to determine if there are any specified Mill tools in the current Mastercam part file. While the 'GetTools' search manager methods can be used to determine if any Mill tools exist, this method can be an order of magnitude faster than actually searching for all of the matching Mill tools and returning them. The ID of the machine group to look for tools in. A boolean flag indicating whether there are any Mill tools in the current part file with the matching parameters. This method is used to determine if there are any specified Mill tools in the current Mastercam part file. While the 'GetTools' search manager methods can be used to determine if any Mill tools exist, this method can be an order of magnitude faster than actually searching for all of the matching Mill tools and returning them. The type of tool to look for. A boolean flag indicating whether there are any Mill tools in the current part file with the matching parameters. This method is used to determine if there are any specified Mill tools in the current Mastercam part file. While the 'GetTools' search manager methods can be used to determine if any Mill tools exist, this method can be an order of magnitude faster than actually searching for all of the matching Mill tools and returning them. A boolean flag indicating whether there are any Mill tools in the current part file. This method is used to determine if there is any specified surface geometry in the current part file. While the 'GetSurfaceGeometry' search manager methods can be used to determine if any surface geometry exists, this method can be an order of magnitude faster than actually searching for all of the matching surface geometry and returning it. The selection status of the surface geometry to look for. The number of the level to search for surface geometry on. A boolean flag indicating whether there is any surface geometry in the current part file with the matching parameters. This method is used to determine if there is any specified surface geometry in the current part file. While the 'GetSurfaceGeometry' search manager methods can be used to determine if any surface geometry exists, this method can be an order of magnitude faster than actually searching for all of the matching surface geometry and returning it. The selection status of the surface geometry to look for. A boolean flag indicating whether there is any surface geometry in the current part file with the matching parameters. This method is used to determine if there is any specified surface geometry in the current part file. While the 'GetSurfaceGeometry' search manager methods can be used to determine if any surface geometry exists, this method can be an order of magnitude faster than actually searching for all of the matching surface geometry and returning it. The number of the level to search for surface geometry on. A boolean flag indicating whether there is any surface geometry in the current part file with the matching parameters. This method is used to determine if there is any specified surface geometry in the current part file. While the 'GetSurfaceGeometry' search manager methods can be used to determine if any surface geometry exists, this method can be an order of magnitude faster than actually searching for all of the matching surface geometry and returning it. A boolean flag indicating whether there is any surface geometry in the current part file. This method is used to determine if there is any specified solid geometry in the current part file. While the 'GetSolidGeometry' search manager methods can be used to determine if any solid geometry exists, this method can be an order of magnitude faster than actually searching for all of the matching solid geometry and returning it. The selection status of the solid geometry to look for. The number of the level to search for solid geometry on or -1 to ignore the level. A boolean flag indicating whether there is any solid geometry in the current part file with the matching parameters. This method is used to determine if there is any specified solid geometry in the current part file. While the 'GetSolidGeometry' search manager methods can be used to determine if any solid geometry exists, this method can be an order of magnitude faster than actually searching for all of the matching solid geometry and returning it. The selection status of the solid geometry to look for. A boolean flag indicating whether there is any solid geometry in the current part file with the matching parameters. This method is used to determine if there is any specified solid geometry in the current part file. While the 'GetSolidGeometry' search manager methods can be used to determine if any solid geometry exists, this method can be an order of magnitude faster than actually searching for all of the matching solid geometry and returning it. The number of the level to search for solid geometry on. A boolean flag indicating whether there is any solid geometry in the current part file with the matching parameters. This method is used to determine if there is any specified solid geometry in the current part file. While the 'GetSolidGeometry' search manager methods can be used to determine if any solid geometry exists, this method can be an order of magnitude faster than actually searching for all of the matching solid geometry and returning it. A boolean flag indicating whether there is any solid geometry in the current part file. This method is used to determine if there is any specified geometry in the current part file. While the 'GetGeometry' search manager methods can be used to determine if any geometry exists, this method can be an order of magnitude faster than actually searching for all of the matching geometry and returning it. The types of geometry to look for. The selection status of the geometry to look for. The number of the level to search for geometry on or -1 to ignore the level. A boolean flag indicating whether there is any geometry in the current part file with the matching parameters. This method is used to determine if there is any specified geometry in the current part file. While the 'GetGeometry' search manager methods can be used to determine if any geometry exists, this method can be an order of magnitude faster than actually searching for all of the matching geometry and returning it. The selection status of the geometry to look for. A boolean flag indicating whether there is any geometry in the current part file with the matching parameters. This method is used to determine if there is any specified geometry in the current part file. While the 'GetGeometry' search manager methods can be used to determine if any geometry exists, this method can be an order of magnitude faster than actually searching for all of the matching geometry and returning it. The types of geometry to look for. A boolean flag indicating whether there is any geometry in the current part file with the matching parameters. This method is used to determine if there is any specified geometry in the current part file. While the 'GetGeometry' search manager methods can be used to determine if any geometry exists, this method can be an order of magnitude faster than actually searching for all of the matching geometry and returning it. The number of the level to search for geometry on. A boolean flag indicating whether there is any geometry in the current part file with the matching parameters. This method is used to determine if there is any specified geometry in the current part file. While the 'GetGeometry' search manager methods can be used to determine if any geometry exists, this method can be an order of magnitude faster than actually searching for all of the matching geometry and returning it. A boolean flag indicating whether there is any geometry in the current part file. Retrieves a 'system' view. The SystemPlaneType that identifies the view to be retrieved. The Mastercam::Database::MCView object of the 'system' view that was asked for. This method is used to get objects for all of the views found in the current Mastercam part file with a matching view category. The view number of the views to look for. An array of MCView objects representing all of the appropriate views found in the current Mastercam part file's database. If the supplied View Number does identify a "valid" defined view, the array returned will be empty. This method is used to get objects for all of the views found in the current Mastercam part file. An array of Mastercam::Database::MCView objects representing all of the appropriate views found in the current Mastercam part file's database. Gets the file descriptor from an 'external' file. This will not work for old 32-bit Mastercam part files. The full path to the Mastercam file to interrogate. [out] The file descriptor text. True if it succeeds, false if it fails (file does not exist or is not a valid Mastercam file. Gets a list of the tools in an 'external' file. The (full path) name of the file to interrogate. [in] If non-null, the tools. True if successful, else false if the file was not found or could not be opened. Gets a list of all of the groups and/or operations in an 'external' file. The (full path) name of the file to interrogate. [out] If non-null, A list of ExternalGroupsFileData, describing the (Machine/Toolpath) Groups in the file. [out] If non-null, A list of ExternalOpsFileData, describing the Toolpath Operations in the file. True if successful, else false if the file was not found or could not be opened. This method is used to get objects for all of the groups found in the operations manager in the current Mastercam part file that match the specified input criteria. The name of the groups to look for. The object representing the Mastercam group that is the parent of all the subgroups to look for. The type of machine all of the returned groups should come from. GroupName and Parent are filters and either (or both) can be null if desired. An array of Group objects representing all of the appropriate operation groups found in the current Mastercam part file's database. This method is used to get objects for all of the groups found in the operations manager in the current Mastercam part file of a specified machine type. The type of machine all of the returned groups should come from. An array of Group objects representing all of the appropriate operation groups found in the current Mastercam part file's database. This method is used to get objects for all of the groups found in the operations manager in the current Mastercam part file with a specified parent group. The object representing the Mastercam group that is the parent of all the subgroups to look for. An array of Group objects representing all of the appropriate operation groups found in the current Mastercam part file's database. This method is used to get objects for all of the groups found in the operations manager in the current Mastercam part file with a matching name. The name of the groups to look for. An array of Group objects representing all of the appropriate operation groups found in the current Mastercam part file's database. This method is used to get objects for all of the groups found in the operations manager in the current Mastercam part file. An array of Group objects representing all of the appropriate operation groups found in the current Mastercam part file's database. Gets operation data for the specified operation. The identifier for the operation. The OpData for the operation if successful, else null. Retrieves a list of OpData objects, one for each toolpath operation. A list of OpData objects, one for each operation. Retrieves the IDs of the operations in the Toolpath Manager. Note that this can get IDs of types of operations that may not supported as a NET-Hook API "Operation" type object. True to process all operations. False to process just the selected operations. The list of operations IDs. This method is used to retrieve all of the operations nested within a parent Nesting operation. The parent Nesting operation to retrieve all of it's child nested ops from. An array of Operation objects representing all of the appropriate toolpath operations found to be child operations of the parent Nesting op. Note that all of the returned Operation objects can be down-cast to their appropriate derived operation types. This method searches for an operation that matches the unique operation identifier passed in. The unique operation identifier to search for in the current Mastercam database. An operation object representing the operation with the matching identifier or a null handle if no matching operation could be found. This method is used to get objects for all of the toolpath operations that match the given input criteria in the current Mastercam part file. The type of toolpath operation to look for or Undefined to ignore toolpath type. The ID of the group to look for toolpath operations in or 1 to ignore groups. True if the search is only to look for operations that are selected in the Toolpath Manager and false to ignore selection status. The tool object being used in operations to be found or a null object to ignore the tool being used. An array of Operation objects representing all of the appropriate toolpath operations found in the current Mastercam part file's database. Note that all of the Operation objects can be down-cast to their appropriate derived operation types. This method is used to get objects for all of the toolpath operations of a given selection status in the current Mastercam part file. True if the search is only to look for operations that are selected in the Toolpath Manager and false to ignore selection status. An array of Operation objects representing all of the appropriate toolpath operations found in the current Mastercam part file's database. Note that all of the Operation objects can be down-cast to their appropriate derived operation types. This method is used to get objects for all of the toolpath operations in a given group in the current Mastercam part file. The tool object being used in operations to be found. An array of Operation objects representing all of the appropriate toolpath operations found in the current Mastercam part file's database. Note that all of the Operation objects can be down-cast to their appropriate derived operation types. This method is used to get objects for all of the toolpath operations in a given group in the current Mastercam part file. The ID of the group to look for toolpath operations in. An array of Operation objects representing all of the appropriate toolpath operations found in the current Mastercam part file's database. Note that all of the Operation objects can be down-cast to their appropriate derived operation types. This method is used to get objects for all of the toolpath operations of a given type in the current Mastercam part file. The type of toolpath operation to look for. An array of Operation objects representing all of the appropriate toolpath operations found in the current Mastercam part file's database. Note that all of the Operation objects can be down-cast to their appropriate derived operation types. This method is used to get objects for all of the toolpath operations in the current Mastercam part file. An array of Operation objects representing all of the appropriate toolpath operations found in the current Mastercam part file's database. Note that all of the Operation objects can be down-cast to their appropriate derived operation types. Gets mill tool from slot number. The mill slot number. nullptr if it fails, else the mill tool. This method is used to get objects for all of the tools in the current Mastercam part file that match the specified input criteria. The type of tool to look for or an Undefined tool to look for all tools. The ID of the machine group to look for tools in or -1 to look throughout all machine groups. An array of Tool objects representing all of the appropriate tools found in the current Mastercam part file's database. Note that all of the Tool objects can be down-cast to their appropriate derived tool types. This method is used to get objects for all of the tools in the current Mastercam part file that are used in a given machine group. The ID of the machine group to look for tools in. An array of Tool objects representing all of the appropriate tools found in the current Mastercam part file's database. Note that all of the Tool objects can be down-cast to their appropriate derived tool types. This method is used to get objects for all of the tools in the current Mastercam part file that match the specific type. The type of tool to look for. An array of Tool objects representing all of the appropriate tools found in the current Mastercam part file's database. Note that all of the Tool objects can be down-cast to their appropriate derived tool types. This method is used to get objects for all of the tools in the current Mastercam part file. An array of Tool objects representing all of the appropriate tools found in the current Mastercam part file's database. Note that all of the Tool objects can be down-cast to their appropriate derived tool types. This method is used to get objects for all of the surface geometry that meet the multiple input criteria in the current Mastercam part file. The selection status of the surface geometry to look for. The number of the level to search for surface geometry on. An array of SurfaceGeometry objects representing all of the appropriate surface geometry found. Note that all of the SurfaceGeometry objects can be down-cast to their appropriate derived surface geometry types. This method is used to get objects for all of the surface geometry that meet the input selection status criteria in the current Mastercam part file. The selection status of the surface geometry to look for. An array of SurfaceGeometry objects representing all of the appropriate surface geometry found. Note that all of the SurfaceGeometry objects can be down-cast to their appropriate derived surface geometry types. This method is used to get objects for all of the surface geometry on a given level in the current Mastercam part file. The number of the level to search for surface geometry on. An array of SurfaceGeometry objects representing all of the appropriate surface geometry found. Note that all of the SurfaceGeometry objects can be down-cast to their appropriate derived surface geometry types. This method is used to get objects for all of the surface geometry in the current Mastercam part file. An array of SurfaceGeometry objects representing all of the appropriate surface geometry found. Note that all of the SurfaceGeometry objects can be down-cast to their appropriate derived surface geometry types. This method is used to get objects for all of the solid geometry that meets the combination of search criteria in the current Mastercam part file. The selection status of the solid geometry to look for. The number of the level to search for solid geometry on or -1 to ignore the level. An array of SolidGeometry objects representing all of the appropriate solid geometry found. Note that all of the SolidGeometry objects can be down-cast to their appropriate derived solid primitive types. Thrown if an unknown solid primitive type is encountered. This method is used to get objects for all of the solid geometry with specific selection settings in the current Mastercam part file. The selection status of the solid geometry to look for. An array of SolidGeometry objects representing all of the appropriate solid geometry found. Note that all of the SolidGeometry objects can be down-cast to their appropriate derived solid primitive types. Thrown if an unknown solid primitive type is encountered. This method is used to get objects for all of the solid geometry on a given level in the current Mastercam part file. The number of the level to search for solid geometry on. An array of SolidGeometry objects representing all of the appropriate solid geometry found. Note that all of the SolidGeometry objects can be down-cast to their appropriate derived solid primitive types. Thrown if an unknown solid primitive type is encountered. This method is used to get objects for all of the solid geometry in the current Mastercam part file. An array of SolidGeometry objects representing all of the appropriate solid geometry found. Note that all of the SolidGeometry objects can be down-cast to their appropriate derived solid primitive types. Thrown if an unknown solid primitive type is encountered. Gets all of the geometry in the active 'Result'. An array of Geometry objects representing all of the appropriate Geometry found. Gets all of the geometry in the active 'Group'. An array of Geometry objects representing all of the appropriate Geometry found. Gets all of the currently 'Selected' geometry. An array of Geometry objects representing all of the appropriate Geometry found. Get the geometry objects with a combination of settings in the current part file. Note that all of the 'base' Geometry objects can be down-cast to their appropriate derived types. The types of geometry to look for. The selection status of the geometry to look for. The number of the level to search for geometry on or -1 to ignore the level. The color number to match on, or -1 for no color restriction. An array of Geometry objects representing all of the appropriate Geometry found. This method is used to get objects for geometry with any combination of settings in the current Mastercam part file. The types of geometry to look for. The selection status of the geometry to look for. The number of the level to search for geometry on or -1 to ignore the level. An array of Geometry objects representing all of the appropriate Geometry found. Note that all of the Geometry objects can be down-cast to their appropriate derived types. This method is used to get objects for geometry with specific selection settings in the current Mastercam part file. The selection status of the geometry to look for. An array of Geometry objects representing all of the appropriate Geometry found. Note that all of the Geometry objects can be down-cast to their appropriate derived types. This method is used to get objects for geometry of specific types in the current Mastercam part file. The types of geometry to look for. An array of Geometry objects representing all of the appropriate Geometry found. Note that all of the Geometry objects can be down-cast to their appropriate derived types. This method is used to get objects for the geometry on a given level in the current Mastercam part file. The number of the level to search for geometry on. An array of Geometry objects representing all of the appropriate Geometry found. Note that all of the Geometry objects can be down-cast to their appropriate derived types. This method is used to get objects for all of the geometry in the current Mastercam part file. An array of Geometry objects representing all of the appropriate Geometry found. Note that all of the Geometry objects can be down-cast to their appropriate derived types. Tool caster. [in,out] If non-null, the op_tool_info data for the Tool. [in,out] If non-null, the tp_tool data for the Tool. null if it fails, else the initialized Tool. Gets all geometry match the specified bit mask. The selection mask. SELECT_BIT, GROUP_BIT, RESULT_BIT, etc. An array of Geometry objects representing all of the appropriate Geometry found. Initializes a new instance of the SearchManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used for retrieving entities from the Mastercam database based on different combinations of settings. Gets or sets the ID of the parent (toolpath) group. Gets or sets the operation tool. If Mastercam is in Design mode (No Machine Groups), this tool data will be null. Gets or sets the operation code. Gets or sets the slot# of the operation. Gets or sets the operation ID. Gets or set the name. An external ops data package. Gets or sets the slot# of the group. Gets or sets the ID of the parent group. If the this property value is '0', this is a Machine Group. Gets or sets the group ID. Gets or sets the group comment. Only Machine Groups have a "comment". If the group is a Toolpath Group, this will be an empty string. Gets or sets the group name. The data for groups from an external file. An enumeration listing the different methods of changing the Metric configuration setting within Mastercam. This is the option for changing all of the settings. This is the option for only changing the units. This is the option for showing the dialog first and letting the user choose the method. Calculate the new-style coolant value. The Coolant item index; (Coolant1, Coolant2, etc). The Coolant state: (On/Off/Ignore). The Coolant On/Off position setting: (Before/With/After). [in/out] The coolant parameters. Retrieve the new-style coolant setting from an operation. The ID of operation to interrogate. The coolant settings. Load the data into this OpData class. The ID of operation to interrogate. Gets a value indicating whether or not the data in this OpData object is "valid". Gets the identifier of the Machine Group this operation is in. Gets the identifier of the Toolpath Group this operation is in. Gets the path name of the NCI (NC) output file. Gets the name of the WCS plane referenced in the operation. Gets the name of the Construction plane referenced in the operation. Gets the name of the Tool plane referenced in the operation. Gets the identifier of the WCS plane referenced in the operation. Gets the identifier of the Construction plane referenced in the operation. Gets the identifier of the Tool plane referenced in the operation. Gets a value indicating whether this object is transform operation. Gets or sets a value indicating whether this operation is 'ghosted' (no posting). Gets or sets a value indicating whether this operation is 'visible'. Gets or sets a value indicating whether this operation is 'locked'. Gets or sets a value indicating whether this operation is 'dirty'. Gets or sets a value indicating whether this operation is 'selected'. The coolant settings in the operation. Note that there are two styles of coolant and the CoolantParam returned contains both. See the comment on the 'UseValuesFromPost' property of the CoolantParams class for details. Gets the name (comment text) of the operation. If the user has not entered any comment this will be an empty string! Gets the identifier for the tool material. This is only valid for Mill/Router operations. Gets the Retract rate. Gets the Plunge rate. If this is a Lathe operation, a negative value means it is inches/rev. or mm/rev. Gets the Feed rate. If this is a Lathe operation, a negative value means it is inches/rev. or mm/rev. Gets a value indicating whether the Spindle Speed is CSS or not. (Lathe) Gets the maximum spindle speed. (Lathe only) Gets the spindle speed. (Positive value = CW spindle direction, Negative = CCW spindle direction). Gets the tool slot number in the local tool list. The value can be '0' if the operation does not use a tool. i.e. The operation is a Manual Entry or Transform operation. Gets the tool length offset number. If this is a Mill operation, this is the Length Offset. If this is a Lathe operation, this is the Offset. Gets the tool offset number. If this is a Mill/Router type operation, this is the Diameter Offset. If this is a Lathe operation, this is will be '0'. Gets the tool number. The value can be '0' if the operation does not use a tool. i.e. The operation is a Manual Entry or Transform operation. Gets the program number. To set this use OperationsManager.SetProgramNumber Gets the operation code. See the "TP_CODE" enumeration in ToolpathOperationCodes_CH.h in the Mastercam C-Hook SDK for equating this value to a specific operation type identifier. (i.e. 1 = TP_CONTOUR) Gets the identifier of the operation. Gets a value indicating the 'product type' of this operation. Initializes a new instance of the OpData class. Check the "IsValid" flag in the OpData to see that the operation with the requested ID was found and processed. Identifier for the operation to query. Values that represent tool materials. Gets the list of materials in the current machine group. A list of material names. Sets the stock plane in the specified machine group. The machine group to query. The view data for the plane to set as the Stock Plane. The ViewID property of this view is used to identify the (already existing) Plane in Mastercam to be set as the Stock Plane. True if it succeeds, false if it fails. Sets the stock plane in the active machine group. The view data for the plane to set as the Stock Plane. The ViewID property of this view is used to identify the (already existing) Plane in Mastercam to be set as the Stock Plane. True if it succeeds, false if it fails. Gets the stock plane in the specified machine group. The machine group to query. The view data for the stock plane if successful, else null. Gets the stock plane in the active machine group. The view data for the stock plane if successful, else null. Sets machine group comment. The (machine) group. The comment string. true if it succeeds, false if it fails. Gets the comment from a machine group properties (files page). The (machine) group. The comment string, else an empty string it is fails. Gets toolpath output folder for the specified Group. If the supplied group is not a Machine Group (e.g. a Toolpath or Operation Group), this method will attempt to retrieve the data from the Machine Group that contains the supplied group. The group. The toolpath output folder, else an empty string it is fails. Sets the "toolpath directory" path in all of the Machine Groups. The path of the folder. true if it succeeds, false if it fails. Sets the "toolpath directory" path in a Machine Group. The (machine) group. The path of the folder. true if it succeeds, false if it fails. Gets the coolant label strings from the Machine Definition. These strings are defined in the Machine Definition (Coolant commands tab page). This overload of GetCoolantLabelStrings retrieves from the "active" Machine Group. [out] A list of coolant "event" strings. [out] A list of coolant "enable" strings. [out] A list of coolant "off" strings. true if it succeeds, false if it fails. Gets the coolant label strings from the Machine Definition. These strings are defined in the Machine Definition (Coolant commands tab page). This looks up the Machine for the specified Operation, unlike the other overload of GetCoolantLabelStrings which retrieves from the "active" Machine Group. The operation. [out] A list of coolant "event" strings. [out] A list of coolant "on" strings. [out] A list of coolant "off" strings. true if it succeeds, false if it fails. Gets the "description" in the Machine in the specified Machine Group. The group the machine belongs to. The new description string (120 characters max). True if it succeeds, false if it fails. Sets the "description" in the active Machine Definition. The new description string (120 characters max). True if it succeeds, false if it fails. Gets the "description" in the Machine in the specified Machine Group. The group the machine belongs to. The description string if successful, else an empty string if not. Gets the "description" in the active Machine Definition. The description string if successful, else an empty string if not. Gets the name of Machine referenced in the supplied Machine Group. The group the machine belongs to. empty string if it fails, else the name of the machine. Gets the name of Machine referenced in the currently active Machine Group. empty string if it fails, else the name of the current machine. This method is used for determining the product type of the currently active machine group. The product type of the currently active machine group. This method creates a new default Router machine group. true if it succeeds, false if it fails. This method creates a new default Lathe machine group. true if it succeeds, false if it fails. This method creates a new default Wire machine group. true if it succeeds, false if it fails. This method creates a new default Mill machine group. true if it succeeds, false if it fails. This method is used for determining whether the current machine group is a Router machine. True is the currently active machine is a Router machine, else false if not. This method is used for determining whether the current machine group is a Lathe machine. True is the currently active machine is a Lathe machine, else false if not. This method is used for determining whether the current machine group is a Wire machine. True is the currently active machine is a Wire machine, else false if not. This method is used for determining whether the current machine group is a Mill machine. True is the currently active machine is a Mill machine, else false if not. This method creates a new machine group of the specified product type and using the specified Machine Definition. The type of machine group to create. The full path the Machine Definition file. true if it succeeds, false if it fails. This method creates a new machine group of the specified product type. The type of machine group to create. true if it succeeds, false if it fails. This method is used for determining whether the current machine group is of a given type. The product type to check the currently active machine against. True is the currently active machine is of the specified product type, else false if not. Retrieves the coolant label strings from a Machine Definition. A pointer to the Machine to retrieve the text strings from. [out] A list of coolant "event" strings. [out] A list of coolant "enable" strings. [out] A list of coolant "off" strings. true if it succeeds, false if it fails. Initializes a new instance of the MachineDefManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. Manager for Machine Groups. This class is used primarily for determining active machines and creating new machine groups - more specific groups functionality can be achieved by working through the class. Sets an object in the save at the specified id. Pass an empty object to remove an element from the list. Calls to set a pre-existing element will overwrite and return success. The GUID identifier for the data block. The object. True if it succeeds, false if it fails (only occurs if trying to remove a non-existent element). Gets the specified data block from the save. The GUID identifier for the data block. True if information exists for the specified id, else false. Initializes a new instance of the dbThirdPartyDataSaver class. The serializer that will be used to encode and decode data. An instance class used to save data directly to a Mastercam .part file. The object type loaded and saved by this accessor. Checks if the save conatins a specified element. The GUID identifier for the element. True if the specified data block exists in the save. A helper class exposing methods auxiliary to ThirdPartyData. A function that serializes an object to be saved to the a Mastercam .part file The object to be serialized The serialized bytes A function that deserializes a bytes to be used as an object The bytes to be deserialized The deserialized object A class to handle serialization for third-party information stored to Mastercam .part files The object type loaded and saved by this accessor. Gets a third party data handler instance for the current part database repository. Do not hold onto object for any duration where the active database might change, just call GetIThirdPartyDataMap() in a narrow scope as needed. Null if it fails, else a unique_ptr to a third party data handler instance. Checks if the map conatins the specified element (data block). The GUID identifier for the data block. True if the specified data block exists in the map. Sets a data block in the map at the specified id. Pass an empty data block to remove an element from the list. Calls to set a pre-existing element will overwrite and return success. The GUID identifier for the data block. The data block. True if it succeeds, false if it fails (only occurs if trying to remove a non-existent element). Gets the specified data block from the map. The GUID identifier for the data block. The found data block (empty if not found). True if the datablock exist for the specified id, else false. A Third Party Data Map Interface. This allows Third Party developers to persist binary data blocks in the Mastercam database. Deletes the posting arguments. Opens create reports registry key. The registry HKey. True if it succeeds, false if it fails. Gets reports registry key. The parent key. The reports key. Determines if we should ask about opening PDFs after extracting them from a content file. True if we should ask, false if we should not. Indicates if we should ask about opening PDFs after extracting them from a content file. True if we should ask to open PDFs extracted from a content file. Initializes a new instance of the NestingPart class. This initializes all of the nesting item objects to their default values. Commits. The initialized stream to output to. This class is used to work with part sections in a Mastercam nesting file. A deserialization implementation. Refresh the positioning limits from current tool and holder profiles. Gets the full profile of the tool. True to get profile in metric. The tool profile result. Gets the full profile of the entire holder assembly. True to get profile in metric. The holder profile result. Executes the set main holder action. Executes the set main tool action. Executes the slot changed action. Resets all identifiers associated to this object. The map of old IDs to new IDs. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Updates the assembly item described by item. The item. Gets the assembly item pointer. Identifier for the item to get. The assembly item pointer, or nullptr if the item is not found. Sets the main holder as null. This special "Set" overload is necessary because TlHolder has a bool constructor, making a call to "SetMainHolder" ambiguous if a nullptr is passed in. The nullptr value. Gets machine side connection type. The machine side connection type. Removes the assembly components. true if it succeeds, false if it fails. Sets the station per configuration. true if it succeeds, false if it fails. Sets the offsets per configuration. true if it succeeds, false if it fails. Sets as default assembly. The value. true if it succeeds, false if it fails. Sets tool number. The tool number. Group the machine belongs to. Gets the profile of the entire holder assembly from the perspective of an external client. If a portion of the holder assembly exists contained within the tool (e.g., facemill arbor), that portion will be truncated from the result. (Optional) True to get profile in metric. The holder profile result. Gets the Assembly Gauge length The Gauge Length Gets the distance between the top of the tool and the bottom of the holder. This value is equivalent to tool length - tool machine side connection height, and represents the positioning distance between the top of the tool and the parent holder's workpiece side connection. (Optional) True to get value in metric. The component CScalar value. Gets the stick-out of the tool from the holder. This value is equivalent to the tool's machine side connection height. It represents the distance from the bottom of the holder to the bottom of the tool. In the case of the holder being inside the tool (e.g. facemill arbor), this value will be the distance between the bottom of the internal holder and the bottom of the tool. Tool projection in that case will represent the full length of the tool. (Optional) True to get value in metric. The stick-out of the tool with respect to the bottom of the parent holder. Updates the tool machine side connection height. The value. (Optional) True if the value is metric. Gets the maximum tool machine side connection height. (Optional) True to get value in metric. The maximum tool machine side connection height. Gets the minimum tool machine side connection height. (Optional) True to get value in metric. The minimum tool machine side connection height. Gets tool machine side connection height. (Optional) True to get value in metric. The tool machine side connection height. Updates the tool projection. The value. (Optional) True if the value is metric. Gets the maximum tool projection value. (Optional) True to get the value in metric. The calculated tool projection minimum. Gets the minimum tool projection value. (Optional) True to get the value in metric. The calculated tool projection minimum. Gets the Tool Projection. (Optional) True to get the value in metric. The tool projection. Gets the max diameter of entire assembly The max diameter of entire assembly Gets the total length of all holders The total length of holders Gets the mill tool. The mill tool. Determines if the assembly supports thru coolant. true if thru coolant is supported, false if not. Determines if the other tool assembly is similar enough to be considered a duplicate. The other tool assembly. (Optional) identifier for the machine group. true if similar, false if not. Class representing a mill tool assembly. Declares the TlAssembly type and its shared_ptr/unique_ptr aliases. Defines an alias representing the tl assembly entry. A deserialization implementation. Executes the get profile operation. A TlProfileResult. Executes the on set stored profile operation. Makes a segment. The segment. (Optional) height of the bottom. (Optional) the color. A TlProfileSegmentPtr. Convert profile segment to holder segment. The profile segment. The holder segment. Resets all identifiers associated to this object. The map of old IDs to new IDs. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Makes holder segments from profile. The profile. A vector of TlHolderSegment. Makes profile from holder segments. The holder segments. A TlProfilePtr. Gets the length of the holder (max y value - min y value). The length. Gets the total Height of the Holder (from y=0 to the holder's max y value). The Height of the Holder. Query if this object is default holder. true if default holder, false if not. Gets the segments segments to define the holder Gets the segments. The segments. Adds a segment. Width of the top. Width of the bottom. The height. true if it succeeds, false if it fails. Deletes all segments. true if it succeeds, false if it fails. Copy operator. The right hand side. A deep copy of this object. Copy constructor. A deep copy of this object Parameterized constructor. true if this object is metric. Default constructor. Class representing a mill tool holder. Declares the TlHolder type and its shared_ptr/unique_ptr aliases. comparison operator. The other. true if objects are the same Class representing an old-style holder segment in the form of a top width, a bottom width, and a height. Declaration of private deserialization implementation class. Executes the 'tool length changed' action. Clean up tools that were created badly in older versions. True if called from a pre-X8 serialization version True if called from a pre-X9 serialization version Executes the get profile operation. A TlProfileResult. Old Holder Attributes Executes the set profile parameters operation. Options for controlling the operation. Executes the get profile parameters operation. The result profile parameters. Executes the is similar operation. The other tool. Identifier for the machine group. The compare mode. true if it succeeds, false if it fails. Resets all identifiers associated to this object. The map of old IDs to new IDs. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Sets profile parameters. Options for controlling the operation. Gets the profile parameters. (Optional) True to specifically get parameters in metric, false in inch. The profile parameters. Convenience only - No backing field on TlToolMill The corner radius. Convenience only - No backing field The corner radius. Sets fbm was metric. true to value. This is here to support a hack in FBM. Adjust length for stickout. The value. (Optional) True if value is metric. Resets the projection values. Sets a tool material code. The code. Name of the matl. Gets the tool material code. The tool material code. Sets a canned text coolant. The coolant. Gets the canned text coolant data The canned text coolant data Sets a pre x coordinate coolant. The coolant. Gets the PreX style coolant values (off/flood/mist/spindle). Tthe PreX style coolant values Sets the legacy holder data. The top. The height. Sets the mastercam type of this tool. The value. Sets mc tool type. The value. Returns the mastercam type of this tool. The Mastercam type of this tool. Returns a list of the IDs of the op type this tool supports The list of op type IDs support by this tool Adds a supported tool type ID for this tool. true if the ID was successfully set, false otherwise Adds a supported op type ID for this tool. true if the ID was successfully set, false otherwise Sets the TlToolMill properties located within op_tool_info true of the setting was successful Gets operation tool information. The operation tool information. Default constructor. Creates an empty tool. The base mill tool class. This class contains data and functions that are common to every mill tool. Declares the TlToolMill type and its shared_ptr/unique_ptr aliases. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Class representing a custom user-defined tool grade. Declares the TlToolGrade type and its shared_ptr/unique_ptr aliases. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Class defining Milling Tool Operation Parameters. Declares the TlMillingOpParams type and its shared_ptr/unique_ptr aliases. A TlOpParams deserialization implementation. Resets all identifiers associated to this object. The map of old IDs to new IDs. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Sets canned text coolant. The value. Sets pre x coordinate coolant. The value. Class defining Tool Operation Parameters. Declares the TlOpParams type and its shared_ptr/unique_ptr aliases. Decrunches the values from the inputed coolant vector [in] The initial coolant vector to decrunch. Decrunched coolant vector. Converts the inputted coolant value to a Time index (0, 1, 2). The value to convert from. Coolant Timing state (BEFORE, WITH, AFTER). Converts the inputted coolant value to a State index (0, 1, 2). The value to convert from. Coolant State (ON, OFF, IGNORE). Calculates the appropriate value for the given Index, state and time. [in] field index used in calculations. [in] state of the field. [in] timing state of the field. Result value based off of input. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. A serialization implementation forward declaration. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Converts the inputted value into an enumeration value. The value. The given data converted to a custom coolant position. Converts the inputted value into an enumeration value. The value. The given data converted to a custom coolant state. Converts the inputted standard coolant status value into an enumeration value. The value. The given data converted to an old style status. Updates from canned txt coolant described by coolant. The coolant. Converts this coolant object into the canned txt coolant shorts that Mastercam uses in machine definitions and posts. The result of the operation. Parameterized Constructor. The old style coolant flag to update from. Parameterized Constructor. The coolant vector to update from. Class representing a collection of tool coolant settings. Declares the TlCoolant type and its shared_ptr/unique_ptr aliases. Sets code from identifier. Sets identifier from code. Executes the query to find out if 'other' is equal. The other. true if equal, false if not. Query if 'testID' is a valid material identifier. Identifier for the test. true if identifier a valid material identifier, false if not. Query if this object is user 2. true if user 2, false if not. Query if this object is user 1. true if user 1, false if not. Query if this object is ceramic. true if ceramic, false if not. Query if this object is tin coated. true if tin coated, false if not. Query if this object is carbide. true if carbide, false if not. Query if this object is high speed steel. true if high speed steel, false if not. Query if this object is defined material. true if defined material, false if not. Query if this object is known material. true if known material, false if not. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Sets an identifier. The identifier. true if it succeeds, false if it fails. Sets an identifier. The identifier. true if it succeeds, false if it fails. Paramiterized constructor. Material ID to set the code based off of.Will only work for Mastercam known ids Paramiterized constructor. Material code to set the ID based off of. Default constructor. Class representing a tool material. Declares the TlToolMaterial type and its shared_ptr/unique_ptr aliases. Serializes this class instance. If the referenced CArchive is writing data out, this class is written out to the archive. If the referenced CArchive is reading data in, this class is read in from the archive. The archive. Sets a commercial name. The name. true if it succeeds, false if it fails. Gets the commercial name. The commercial name. Class representing a basic material. Declares the TlMaterial type and its shared_ptr/unique_ptr aliases. This method is used to determine if an Undo transaction is currently active. True if there is an Undo transaction currently active, else false if not. This method resets the current transaction and restarts it. This method cancels an undo transaction and rolls back any changes that have occurred. This method commits a completed transaction to Mastercam's Undo stack. This method starts an undo transaction. All database transactions from this point forward will be undo-able. true if it succeeds, else false if it fails. Initializes a new instance of the UndoManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used to manage Undo transactions in Mastercam. Gets or sets the object representation of the second tangency curve. Gets or sets the object representation of the first tangency curve. Gets or sets the center curve for this FilletSurface object. Loads the default values for a given surface geometry object from the geometry entity passed in. [in,out] The surface geometry entity to use as defaults for this surface geometry object. Commits a surface geometry entity to the Mastercam database. [in,out] The surface geometry entity to be committed. True if the commit was successful; false if not. Initializes a new instance of the FilletSurface class. Attempts to retrieve a surface geometry entity with the given ID from the Mastercam database and use that to initialize this surface geometry object. If no matching geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the surface geometry entity to look up in the Mastercam database. This class is used for working with fillet surfaces within Mastercam. Accessor for the Singleton instance of IPlanesManagerEnginePtr. The singleton. Unlinks the planes described by planeIDs. True to unlink selected linked planes, false to unlink all linked planes. The number of planes that were unlinked. Ungroup the given planes. A set of planes to ungroup (ignored if 'allPlanes' is set). True if any planes were grouped, otherwise false. Toggle the 'lock' attribute on certain planes. The list of plane IDs. An empty list will use selected planes. The number of planes actually unlocked. Use the given list to set the planes in the list control as selected planes. The ID array of planes to be set as selected. True to clear all first. If true, draw the plane's gnomon. The number of planes selected. Select multiple planes in the planes tree. Set of PlaneIDs to select. True to clear all current selections first. True to draw planes gnomon. The number of planes selected. Select a single plane in the planes tree. Plane ID of the plane to select. True to clear all current selections first. True to draw planes gnomon. Set the "refresh enabled" property. True to enable refreshing the planes list, false to disable. The prior value. Set a plane's work offset (use -1 for 'automatic'). Use -1 to set the work offset to 'automatic'. Identifier for the plane. The new work offset. True if the work offset was successfully updated, otherwise false. Set a plane's section view status. Identifier for the plane. True if this is a section view plane, false if it's not. True if the section view status was successfully updated, otherwise false. Set a plane's origin. Identifier for the plane. The new origin. True if the origin was successfully changed, otherwise false. Set a plane's name. Identifier for the plane. New name for the plane. True if the name was successfully changed, otherwise false. Set a plane's matrix. Identifier for the plane. The new matrix. True if the matrix was successfully updated, otherwise false. Set a plane's locked state. Identifier for the plane. True to lock the plane, false to unlock it. True if the lock state was successfully changed, otherwise false. Set the "displayed" state of the given plane. ID of the plane to update. True to set, false to clear. Set a plane's coordinate display. Identifier for the plane. The new coordinate display. True if the coordinate display was successfully changed, otherwise false. Set a plane's comment. Identifier for the plane. [in,out] The new comment. True if the comment was changed, otherwise false. Sets plane color. A list of Plane IDs to update. Index of the color to set all planes too. True if it succeeds, false if it fails to set color for any plane. Remove any empty groups. True any groups were removed, otherwise false. Refresh planes list. The reason why we need a refresh. (Optional) If true, draw the plane's gnomon. Link dependent planes. [in,out] A list of Plane IDs to to link. (Optional) ID of parent plane to link to (default == 0 will prompt). True if any planes are linked, otherwise false. Add planes to a named group. Passing an empty name will prompt for a new group. Passing a name that does not exist will create a new group with that name. Passing the name of an existing group will add selected planes to that group. The name of the group. The group number if successfully grouped, otherwise 0. Group the given planes. A set of groups to group. A set of planes to group. If non-zero, add selected planes to this group. The group id of the group, 0 for failure. Add planes to a named group. Passing an empty name will prompt for a new group. Passing a name that does not exist will create a new group with that name. Passing the name of an existing group will add selected planes to that group. A list of groups IDs to add to the group (can be empty). A list of planes IDs to add to the group (can be empty). The name of the group. The group number if successfully grouped, otherwise 0. Gets the World Coordinates setting. True if it's set, false if not. Gets the plane's work offset propety. Identifier for the plane. The work offset. Get a unique work offset for the given planes. The selected planes to examine. Gets the plane's section view property. Identifier for the plane. True if it section view is on, false if not. Gets the plane's ID for a plane with the given name. Name of the plane. The plane identifier if found, otherwise 0. Gets the plane's origin property. Identifier for the plane. [I/O] The plane's origin values. True if the origin point was retrieved, otherwise false. Gets the plane's name property. Identifier for the plane. The name. Gets the plane's matrix property. Identifier for the plane. [I/O] The plane's matrix values. True if the matrix was retrieved, otherwise false. Gets the plane's "list only associated plane" property. True if list only associated plane is active, otherwise false. Gets the plane's locked property. Identifier for the plane. True is locked, false if not. Gets the plane's display mode property. Identifier for the plane. True if displayed, false if not. Gets the plane's coordinate dislpay property. Identifier for the plane. The coordinate dislpay. Gets the plane's comment property. Identifier for the plane. The comment. Gets the plane's color property. Identifier for the plane. The color. Duplicate the given named plane. Name of the plane to duplicate. The id of the duplicated plane. Duplicate the given plane. The id of the plane to duplicate. The id of the duplicated plane. Dumps all the planes to the given file. [in,out] The file name to write to. True if it succeeds, false if it fails. Deletes the specified planes. A set of IDs for the planes to delete. True if any planes were deleted, otherwise false. Deletes the specified planes. A plane ID to delete. True if the plane was deleted, otherwise false. Delete the given group. Identifier for the group. True if the planes in this group are being removed as well. True if the group is deleted, otherwise false. Adds a new plane. The matrix 33. The origin. The Plane Type. True to update plane manager. The Plane Id long. Add a new group. The group id of the added group, 0 for failure. Default virtual destructor. Public Planes Manager Engine interface. Convert a managed plane reason to a Mastercam equivalent. The reason in managed space. The converted reason. Convert a collection of plane IDs to an equivalent managed list. The managed list of Plane IDs. The list out. Convert a managed collection of plane IDs to a set we can send to the Planes Manager service. The managed list of Plane IDs. A corresponding set of long ids. Dumps Planes to an XML. Filename of the output file. True if it succeeds, false if it fails. Unlinks the planes described by planeIDs. True to unlink selected linked planes, false to unlink all linked planes. The number of planes that were unlinked. Ungroup the given planes. A set of planes to ungroup (ignored if 'allPlanes' is set). True if it succeeds, false if it fails. Toggle the 'lock' attribute on certain planes. The list of plane IDs. An empty list will use selected planes. The number of planes actually unlocked. Select multiple planes in the planes tree. Set of PlaneIDs to select. True to clear all current selections first. True to draw planes gnomon. The number of planes selected. Select a single plane in the planes tree. Plane ID of the plane to select. True to clear all current selections first. True to draw planes gnomon. Set the "refresh enabled" property. True to enable refreshing the planes list, false to disable. The prior value. Set a plane's work offset (use -1 for 'automatic'). Use -1 to set the work offset to 'automatic'. Identifier for the plane. The new work offset. True if the work offset was successfully updated, otherwise false. Set a plane's section view status. Identifier for the plane. True if this is a section view plane, false if it's not. True if the section view status was successfully updated, otherwise false. Set a plane's name. Identifier for the plane. New name for the plane. True if the name was successfully changed, otherwise false. Set a plane's origin. Identifier for the plane. The new origin. True if the origin was successfully changed, otherwise false. Set a plane's matrix. Identifier for the plane. The new matrix. True if the matrix was successfully updated, otherwise false. Set a plane's locked state. Identifier for the plane. True to lock the plane, false to unlock it. True if the lock state was successfully changed, otherwise false. Toggle the "displayed" state of the given plane. ID of the plane to update. True to set, false to clear. Set a plane's coordinate display. Identifier for the plane. The new coordinate display. True if the coordinate display was successfully changed, otherwise false. Set a plane's comment. Identifier for the plane. The new comment. True if the comment was changed, otherwise false. Sets plane color. A list of Plane IDs to update. Index of the color to set all planes too. True if it succeeds, false if it fails to set color for any plane. Remove any unused groups. True if any unused groups were removed, otherwise false. Refresh planes tree. The reason why we need a refresh. If true, draw the plane's gnomon. Link dependent planes. A list of Plane IDs to to link. ID of parent plane to link to (0 will prompt). True if any planes are linked, otherwise false. Gets the World Coordinates setting. True if it's set, false otherwise. Get a unique work offset for the given planes. The selected planes to examine. Get the plane work's offset property. Identifier for the plane. The plane's work offset (-1 for 'automatic'). Get the plane's section view state property. Identifier for the plane. True if the plane is a section view plane, false if it's not. Get the plane's name property. Identifier for the plane. The plane's name. Get the plane's origin property. Identifier for the plane. [I/O] The plane's origin values. The plane's origin. Get the plane's matrix property. Identifier for the plane. [I/O] The plane's matrix values. True if the matrix was retrieved, otherwise false. Get the plane's locked property. Identifier for the plane. True if the plane is locked, false if it's not. Return the plane identifier for a plane with the given name. Name of the plane. The plane identifier if found, otherwise 0. Gets the display mode property. Identifier for the plane. True if displayed, false if not. Get the plane's coordinate system property. Identifier for the plane. The plane's coordinate system. Get the plane's comment property. Identifier for the plane. The plane's comment (might be empty if there is no comment). Get the plane's color property. Identifier for the plane. The plane color. Gets the "list only associated plane" setting. True if list only associated plane is active, otherwise false. Duplicate the given named plane. Name of the plane to duplicate. The id of the duplicated plane. Duplicate the given plane. PlaneID of the plane to duplicate. The PlaneID of the duplicated plane. Deletes the specified planes. A set of plane IDs for the planes to delete. True if any planes were deleted, otherwise false. Delete the given group. Identifier for the group. True if the planes in this group are being removed as well. True if the group is deleted, otherwise false. Add planes to a named group. Passing an empty name will prompt for a new group. Passing a name that does not exist will create a new group with that name. Passing the name of an existing group will add selected planes to that group. The name of the group. The group number if successfully grouped, otherwise 0. Add groups and/or planes to a named group. Passing an empty name will prompt for a new group. Passing a name that does not exist will create a new group with that name. Passing the name of an existing group will add selected planes to that group. A list of groups IDs to add to the group (can be empty). A list of plane IDs to add to the group (can be empty). The name of the group. The group number if successfully grouped, otherwise 0. Add new plane and add it to the list. 3x3 matrix. Plane origin in world coordinates. plane type (PlaneCreationType::CPlane, PlaneCreationType::TPlane, PlaneCreationType::GPlane or PlaneCreationType::WCSPlane) True to update plane manager. The new plane ID. returns 0 if it failed. Add a new group. The group id of the added group, 0 for failure. Plane types. Values that represent a reason why the planes list was updated. Values that represent the a sorting order (Ascending or Descending). Initializes a new instance of the PlanesManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used to work with entity levels within Mastercam. Loads the default values for a given surface geometry object from the geometry entity passed in. [in,out] The surface geometry entity to use as defaults for this surface geometry object. Commits a surface geometry entity to the Mastercam database. [in,out] The surface geometry entity to be committed. True if the commit was successful; false if not. Initializes a new instance of the LoftedSurface class. Attempts to retrieve a surface geometry entity with the given ID from the Mastercam database and use that to initialize this surface geometry object. If no matching geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the surface geometry entity to look up in the Mastercam database. This class is used for working with lofted surfaces within Mastercam. Due to the complex nature of working with lofted surfaces, the internal data of a lofted surface is unavailable in this version of the NET-Hook API. Loads the default values for a given surface geometry object from the geometry entity passed in. [in,out] The surface geometry entity to use as defaults for this surface geometry object. Commits a surface geometry entity to the Mastercam database. [in,out] The surface geometry entity to be committed. True if the commit was successful; false if not. Initializes a new instance of the NURBSSurface class. Attempts to retrieve a surface geometry entity with the given ID from the Mastercam database and use that to initialize this surface geometry object. If no matching geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the surface geometry entity to look up in the Mastercam database. This class is used for working with NURBS surfaces within Mastercam. Due to the complex nature of working with NURBS surfaces, the internal data of a NURBS surface is unavailable in this version of the NET-Hook API. Gets or sets the location of the ending point for drawing this sphere primitive solid as an angle, in degrees, from the base point. Gets or sets the location of the starting point for drawing this sphere primitive solid as an angle, in degrees, from the base point. Gets or sets the distance of the outer edge of the sphere from this sphere primitive solid's base point. Initializes a new instance of the SphereSolid class. This constructs a new spherical solid object with default parameters. The default parameters of a sphere solid are for a full (360 degree) sphere with the center at the WCS origin, (0.0, 0.0, 0.0), and with a radius of 0.5. Loads the default values for a given solid geometry object. Loads the default values for a given solid geometry object from the solid geometry entity passed in. The geometry entity to use as defaults for this solid geometry object. Commits a solid geometry entity to the Mastercam database. The solid geometry entity to be committed. The solid parameters to initialize the object with. True if the commit was successful; false if not. Initializes a new instance of the SphereSolid class. Attempts to retrieve a solid geometry entity with the given ID from the Mastercam database and use that to initialize this solid geometry object. If no matching solid geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the solid geometry entity to look up in the Mastercam database. This class is used for working with sphere shaped primitive solids. Gets or sets the name of the solid entity. Note that if the solid has the default "Solid" name, this Name will be empty!. Gets or sets the vector representing the Z axis for the specified solid primitive object. Gets or sets the vector representing the Y axis for the specified solid primitive object. Gets or sets the vector representing the X axis for the specified solid primitive object. Gets or sets the base point for the specified solid primitive object. This handles the committing of changes to a Solid object to the Mastercam database. True if the object was committed successfully, else false if not. Thrown if for some reason this object is supposed to be valid but the geometry is no longer in the Mastercam database. Thrown if an unknown solid primitive type is encountered. Loads a passed in solid parameters structure with this solid object's current settings. [out] The parameter structure to load with this object's current settings. True if the solid parameters could be stored and passed back successfully, false if not. Commits a geometry entity to the Mastercam database. The geometry entity to be committed. The solid parameters to commit the geometry entity with. True if the commit was successful; false if not. Initializes a new instance of the SolidGeometry class. Attempts to retrieve a geometry entity with the given ID from the Mastercam database and use that to initialize this solid geometry object. If no matching geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the geometry entity to look up in the Mastercam database. Initializes a new instance of the SolidGeometry class. All members are given default values. This class handles the interaction between the NET-Hook and Mastercam for Solid geometry objects. This is a static inequality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first arc to compare. This is the second arc to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first arc to compare. This is the second arc to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this math object to another one. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. [in,out] This is the arc to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first arc to compare. This is the second arc to compare. True if the two objects are considered equal. Converts this object into a string representation. A text string that represents this object. Gets or sets the location of the ending point of this arc, an angle, in degrees, from the (3 O'Clock) base point. Gets or sets the location of the starting point of this arc, an angle, in degrees, from the (3 O'Clock) base point. Gets or sets the radius of this arc. Gets or sets the center point of this arc. Initializes a new instance of the Arc2D class. This takes all of the necessary data to construct this arc object. The center point of the arc to be created. The radius (distance from the center point to the outer edge of the arc) of the arc to be created. The angle in degrees, from the origin, from which the arc starts. The angle in degrees, from the origin, from which the arc ends. "Converts" this NET-Hook type to the corresponding Mastercam math type. [out] The Mastercam math type. Initializes a new instance of the Arc2D class. The Mastercam 2D arc geometry data. This class is used as a mathematical representation of a 2D Arc. Converts this object into a string representation. A text string that represents this object. Gets or sets the second endpoint in this LineGeomtryobject. Gets or sets the first endpoint in this LineGeomtry object. Gets or sets the 3D line data associated with this Geometry object. Initializes a new instance of the LineGeometry class. Takes two 3D point objects and creates a line geometry object between the two points in 3D space. You must the LineGeometry object for it to be created in Mastercam's geometry database. The first endpoint of the line in 3D space. The second endpoint of the line in 3D space. Initializes a new instance of the LineGeometry class. Creates a new LineGeometry object based off of the values in the specified line math object. You must the LineGeometry object for it to be created in Mastercam's geometry database. The 3D line data to create the line geometry with. Initializes a new instance of the LineGeometry class. Creates new line geometry with default values - The first endpoint at (-1.0, 0.0, 0.0) and the second at (1.0, 0.0, 0.0) You must the LineGeometry object for it to be created in Mastercam's geometry database. LoadDefaults (Override). This handles the loading of defaults from a Mastercam entity. [in,out] The entity to load the object's default values from. Commit (Override). This handles the committing of the object's data to the Mastercam database. [in,out] The entity that will hold all the data being sent to the Mastercam database. true if it succeeds, false if it fails. Initializes a new instance of the LineGeometry class. Creates a new object from the ID of an entity in the Mastercam database. The ID of the Mastercam entity to create the new object from. This class provides methods for creating, editing, and otherwise working with line geometry within Mastercam. Gets all groups in the active Operation Manager list. [out] The list of groups. true to only select Machine Groups. The number of groups in the list (-1 = error). Gets the name of active group. The active group contains the 'red arrow' insertion point marker. empty string if it fails, else the name. Searches for a Group "by ID". The group ID number to search for. The found group, else null if it fails to find a match. Searches for a Group "by name". The name of the to search for. The found group, else null if it fails to find a match. Make the given Group object the currently active group in Mastercam. The Group object to make active in Mastercam. True if the group was set as active successfully. Retrieves the "name" of the Machine Definition referenced in a Machine Group. The Machine Group to be queried. If the Group is valid and is a Machine Group, the "name" of the Machine Definition referenced in the Machine Group, else an empty string. Retrieves the "name" of the Machine Definition referenced in the 'active' Machine Group. The "name" of the Machine Definition referenced in the Machine Group, else an empty string. Returns a group object representing the active, root machine group. A group object for the active machine group, else null if one does not exists Returns a group object representing the active group. This could a a Machine or a Toolpath Group. A group object for the active group, else null if one does not exists Deletes a Mastercam group. A reference to the group object being deleted. It should get set to a null value if the deletion was successful. true if it succeeds, false if it fails. Sets the Machine to be used in a Machine Group. The Machine Group to be altered. The (full path) name of the machine definition to use. true if it succeeds, false if it fails. Sets the Machine to be used in the 'active' Machine Group. The (full path) name of the machine definition to use. true if it succeeds, false if it fails. This method creates and returns a newly created Group object within the currently specified parent group. If NewGroupName is null or an empty string, Mastercam will auto generate a name for the group. If you specify a name that is already used, the creation will fail. The parent group the new group belongs to. The name of the new group being created. The newly created group object, else null if failed. This method creates and returns a newly created Group object within the currently specified parent group. The parent group the new group belongs to. The newly created group object, else null if it failed. This method finds the group list pointer that corresponds to a given group name. The group name to search for. The corresponding group list pointer if it was found, else NULL if not. This method finds the group list pointer that corresponds to a given group number ID. The group number ID to search for. The corresponding group list pointer if it was found, else NULL if not. Initializes a new instance of the GroupManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used to work with and manage Mastercam groups and NET-Hook group objects. This class is used to work with and manage Mastercam groups and NET-Hook group objects. This method calculates the distance between two 3D points. The first point to perform the operation with. The second point to perform the operation with. The distance between the two input points. This method calculates the length of a 3D vector or the distance of a 3D point from the origin. The point to perform the operation with. The length of the input vector. This method performs a dot product on two 3D points. The first point to perform the operation with. The second point to perform the operation with. The dot product value of the two input points. This method performs a cross product on two 3D points. The first point to perform the operation with. The second point to perform the operation with. A new point representing the cross product between the two input points. This method performs a rotation operation on a 3D point. The point to be rotated. The point to anchor the rotation operation from. The vector representing the axis to perform the rotation around. The value of the angle, in radians, to perform the rotation operation with. A new point representing the rotation operation on the input point. This method performs a rotation operation on a 3D point. The point to be rotated. The vector representing the axis to perform the rotation around. The value of the angle, in radians, to perform the rotation operation with. A new point representing the rotation operation on the input point. The anchor point for the rotation operation in this method is assumed to be the origin; in other words, the point (0.0, 0.0, 0.0). This method performs a vector normalize operation on a 3D vector. The vector to be normalized. A new point representing the "normalized" unit vector of the input vector. This method performs a scaling operation on a 3D point. The point to be scaled. The value to scale the input point by. A new point representing the input point after it's been appropriately scaled. This method performs a linear combination on two 3D points. The first point to perform the operation with. The value with which to scale the first point. The second point to perform the operation with. The value with which to scale the second point. A new point representing the linear combination of the two input points. This method performs vector subtraction on two 3D points. The first point to perform the operation with. The second point to perform the operation with. A new point representing the vector subtraction of the two input points. This method performs vector addition on two 3D points. The first point to perform the operation with. The second point to perform the operation with. A new point representing the vector addition of the two input points. This method calculates the distance between two 2D points. The first point to perform the operation with. The second point to perform the operation with. The distance between the two input points. This method calculates the degree value of a given angle in radians. The angle value in radians to be converted to degrees. The angle value in degrees. This method calculates the radian value of a given angle in degrees. The angle value in degrees to be converted to radians. The angle value in radians. This method calculates the angle of a 2D vector about the origin in radians. The point to perform the operation with. The angle of the input vector. This method calculates the angle of a 2D vector about the origin in degrees. The point to perform the operation with. The angle of the input vector. This method calculates the length of a 2D vector or the distance of a 2D point from the origin. The point to perform the operation with. The length of the input vector. This method performs a dot product on two 2D points. The first point to perform the operation with. The second point to perform the operation with. The dot product value of the two input points. This method performs a cross product on two 2D points and returns the resulting Z component. The first point to perform the operation with. The second point to perform the operation with. The Z component of the cross product operation. This method performs a rotation operation on a 2D point. The point to be rotated. The point to anchor the rotation operation from. The value of the cosine to perform the rotation operation with. The value of the sine to perform the rotation operation with. A new point representing the rotation operation on the input point. This method performs a vector normalize operation on a 2D vector. The vector to be normalized. A new point representing the "normalized" unit vector of the input vector. This method performs a scaling operation on a 2D point. The point to be scaled. The value to scale the input point by. A new point representing the input point after it's been appropriately scaled. This method performs a linear combination on two 2D points. The first point to perform the operation with. The value with which to scale the first point. The second point to perform the operation with. The value with which to scale the second point. A new point representing the linear combination of the two input points. This method performs vector subtraction on two 2D points. The first point to perform the operation with. The second point to perform the operation with. A new point representing the vector subtraction of the two input points. This method performs vector addition on two 2D points. The first point to perform the operation with. The second point to perform the operation with. A new point representing the vector addition of the two input points. Initializes a new instance of the VectorManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class handles vector operations between different mathematical objects. Move operation. The identifier of the operation to be moved. The identifier of the operation to move target location. The (before/after) mode. The identifier of the target toolpath group. true if it succeeds, false if it fails. Selects or unselects the specified operations in the Toolpath Manager. The array of operations to set the selection state on in the Toolpath Manager. If true, then whenever a Nesting operation has been marked as selected/unselected, all of it's child operations will also be marked as selected/unselected. true to select, false to unselect the Operations. All operations selection/un-selection. true to select, false to unselect the Operations. This method actually initiates the posting process in Mastercam. The destination path of the NC output file. Whether or not the editor should be opened to edit the NC file on completion. Whether or not an NCI file should also be output. Whether or not the editor should be opened to edit the NCI file on completion. Gets or sets the name of the post processor file being used in the current machine group. Gets or sets the name of the block drilling library file being used in the current machine group. Get or sets the name of the tool library file being used in the current machine group. Gets or sets the name of the currently active machine. [Deprecated("Please use the GroupManager.GetMachineNameInGroup and GroupManager.SetMachineInGroup methods.")] Gets or sets the stock size in the current machine group. Gets or sets the origin point of the stock for the current machine group. Gets or sets a value indicating whether or not the Toolpath Manager can refresh itself at it's own discretion. Gets or sets the name of the materials file being used in the current machine group. Gets or sets a value indicating the current NC file naming rules in the current Mastercam configuration. Gets or sets a value indicating whether or not the NC file path prompt is to be displayed. Sets the program name in the operations. The name to assign to the operations. True to process all operations. False to process just the selected operations. The number of operation that were altered. Gets the program name in the operations. True to process all operations. False to process just the selected operations. A dictionary collection, the Key being the Operation ID# and the Value being the Program Name. Sets the program number in the operations. The program number value to assign. True to process all operations. False to process just the selected operations. Retrieve the "operation extents data" for the specified operation. If the operation is of a type that has no NCI data. i.e. Stock Model, etc., the return will null. Identifier for the operation. Nullptr if it fails, else the operation extents data. Calculates the cycle time of the selected operations. Note that this assumes the operation is not in a 'dirty' state! This does not regenerate the operation if it is 'dirty', and the time returned will be 0.0 The time (in seconds) that's returned in the "raw" time of the operations. Any additional time (for tool changes, etc.) would need to be added to this if desired. You can use the functionality in the .NET Framework's TimeSpan to format the time as desired. See the related CalcCycleTime functionality in the Operation class. True to process all operations. False to process just the selected operations. The calculated cycle time (in seconds). Calculates the cycle time of the selected operations. Note that this assumes the operation is not in a 'dirty' state! This does not regenerate the operation if it is 'dirty', and the time returned will be 0.0 The time (in seconds) that's returned in the "raw" time of the operations. Any additional time (for tool changes, etc.) would need to be added to this if desired. You can use the functionality in the .NET Framework's TimeSpan to format the time as desired. See the related CalcCycleTime functionality in the Operation class. ID of operation to search for. The calculated cycle time (in seconds). This method clears the Toolpath Manager's deleted ops buffer. Deleting an operation may not always completely clear that operation from the database, which can result in a file being marked as dirty and needing saving even though it may have already been saved. Clearing the deleted operations buffer can resolve this, but will also result in making the deletion of any operations non-undoable. This begins the nesting process in the current file. The path and name of the nesting *.ini file to use in the nesting process. This should be true if the nesting process is supposed to skip the displaying of the nesting dialog before it starts. True if the nesting went successfully, else false if not. This method posts the currently selected operations from the Operations Manager. This should be specified if the NC file is to be output to a file path and name different than the default. This flag indicates whether the NC file is to be opened by the default editor after the posting process is complete. This flag indicates whether or not an NCI file is created for the operations during the posting process. This flag indicates whether the NCI file is to be opened by the default editor after the posting process is complete. This method posts a subset of operations from the Operations Manager. The operations to post. This should be specified if the NC file is to be output to a file path and name different than the default. This flag indicates whether the NC file is to be opened by the default editor after the posting process is complete. This flag indicates whether or not an NCI file is created for the operations during the posting process. This flag indicates whether the NCI file is to be opened by the default editor after the posting process is complete. This method posts a subset of operations from the Operations Manager. Note that this method will disallow the editing of the NCI upon posting. The operations to post. This should be specified if the NC file is to be output to a file path and name different than the default. This flag indicates whether the NC file is to be opened by the default editor after the posting process is complete. This flag indicates whether or not an NCI file is created for the operations during the posting process. This method posts a subset of operations from the Operations Manager. Note that this method will not create an associated NCI file by default. The operations to post. This should be specified if the NC file is to be output to a file path and name different than the default. This flag indicates whether the NC file is to be opened by the default editor after the posting process is complete. This method posts a subset of operations from the Operations Manager. Note that this method will post to the default posting directory, will not create an associated NCI file, and will disallow the editing of the subsequent NC file by default. The operations to post. This should be specified if the NC file is to be output to a file path and name different than the default. This method posts a subset of operations from the Operations Manager. Note that this method will post to the default posting directory, will not create an associated NCI file, and will disallow the editing of the subsequent NC file by default. The operations to post. This method posts all of the operations in the Toolpath Manager. This should be specified if the NC file is to be output to a file path and name different than the default. This flag indicates whether the NC file is to be opened by the default editor after the posting process is complete. This flag indicates whether or not an NCI file is created for the operations during the posting process. This flag indicates whether the NCI file is to be opened by the default editor after the posting process is complete. This method posts all of the operations in the Toolpath Manager. Note that this method will disallow the editing of the NCI upon posting. This should be specified if the NC file is to be output to a file path and name different than the default. This flag indicates whether the NC file is to be opened by the default editor after the posting process is complete. This flag indicates whether or not an NCI file is created for the operations during the posting process. This method posts all of the operations in the Toolpath Manager. Note that this method will not create an associated NCI file by default. This should be specified if the NC file is to be output to a file path and name different than the default. This flag indicates whether the NC file is to be opened by the default editor after the posting process is complete. This method posts all of the operations in the Toolpath Manager. Note that this method will not create an associated NCI file and will disallow the editing of the subsequent NC file by default. This should be specified if the NC file is to be output to a file path and name different than the default. This method posts all of the operations in the Toolpath Manager. Note that this method will post to the default posting directory, will not create an associated NCI file and will disallow the editing of the subsequent NC file by default. This method selects all of the specified operations in the Toolpath Manager. The array of operations to select in the Toolpath Manager. If true, then whenever a Nesting operation has been marked as selected, all of it's child operations will also be marked as selected. This method selects all of the specified operations in the Toolpath Manager. Note that by default children operations of selected ops will not have their selection status altered. The array of operations to select in the Toolpath Manager. This method selects all of the operations in the Toolpath Manager. This method unselects the specified operations in the Toolpath Manager. The array of operations to unselect in the Toolpath Manager. If true, then whenever a Nesting operation has been marked as unselected, all of it's child operations will also be marked as unselected. This method unselects the specified operations in the Toolpath Manager. Note that by default children operations of selected ops will not have their selection status altered. The array of operations to unselect in the Toolpath Manager. This method unselects all of the operations in the Toolpath Manager. This method generates a setup sheet from the selected operation(s). This method forces the update the Toolpath Manager tree. You usually will not need to force the toolpath tree to be rebuilt, unless you have programmatically moved operations. True to force the rebuild of the toolpath operations tree. This method refreshes and updates the Toolpath Manager. This method exports operations to file. Use the GetOperationID() member method of your Operations(s) to get their IDs. The full pathname of the file. The name of the group. The list of operation IDs to be exported. true to just export the operations, no geometry. true to duplicate tool check (default = false). true if it succeeds, false if it fails. This method imports ALL of the operations from an existing Mastercam file. Since all of the operations are being imported, the OperationName and OperationID "which operation to import indicators" items in the ImportOptions are not used. The settings to be used for the import operation. The list of operation IDs for the operations that were imported. This method imports an operation from an existing Mastercam file. The settings to be used for the import operation. A handle to the imported operation if successful, else a null if not. Exports the current Stock Model to an STL file. Identifier for the operation. Full Unqualified Path including name and ending (.stl) for the file to export. True if it succeeds, false if it fails Gets a value indicating whether the name match on the Operation Name is case sensitive or not. The name matching search is case sensitive by default. Gets a value indicating whether the feeds and speed should be calculated. This is equivalent to checking "calculate speeds and feeds" option on the Tools Setting page of the active Machine Group. Gets or sets a value indicating whether or not to check to see if a "matching" tool already exists in the part file and if found use it. When duplicate tool check is enabled (and it is by default) we do NOT check these items: Tool number, Tool Diameter Offset number and Tool Length Offset number. Gets or sets a value indicating whether any associated operation (toolpath) groups will also be imported with the operation. Gets or sets a value indicating whether any associated geometry will also be imported with the operation. Gets or sets a value indicating whether the imported operation will have its views reset to the current system view on import. Gets or sets the operation ID of the operation to import (if not importing "by name"). Gets or sets the name of the operation to import (if OperationID = 0). Gets or sets the full pathname of the file to import from. Initializes a new instance of the ImportOptions class. The full pathname of the file to import from. The identifier of the operation to be imported. Initializes a new instance of the ImportOptions class. The full pathname of the file to import from. The name of the operation to be imported. Initializes a new instance of the ImportOptions class. An package of settings used for Importing Operations from an external file. Copies data from one operation to another operation. The source operation. The target operation. What data is to be copied? If a 'geometry' mode is specified - true to replace the geometry in the target operation, else the geometry from the source will be added to the target. true if it succeeds, false if it fails. Move an operation to another toolpath group. You will need to call InitOperationsManagerTree() after this to update the toolpath tree on-screen display. This does not support moving operations to a different Machine Group! The source operation. The target toolpath group. true if it succeeds, false if it fails. Move an operation relative to another operation. You will need to call InitOperationsManagerTree() after this to update the toolpath tree on-screen display. This does not support copying operations to a different Machine Group! The source operation. The target operation. The move (before/after) location relative to the targetOp. true if it succeeds, false if it fails. Copy an operation relative to another operation. You will need to call InitOperationsManagerTree() after this to update the toolpath tree on-screen display. This does not support copying operations to a different Machine Group! The source operation. The target operation. The copy (before/after) location relative to the targetOp. The ID of the new operation copy (0 = error). Copy an operation to another toolpath group. You will need to call InitOperationsManagerTree() after this to update the toolpath tree on-screen display. This does not support copying operations to a different Machine Group! The source operation. The toolpath group to copy the operation to. The ID of the new operation copy (0 = error). Initializes the operations manager (toolpaths) tree. To see the result of copy/ move operations "on screen", we need to reload the tree with the updated list of operations! Do this call after you've completed your copying/moving. Values that represent what data is to be copied. Values that represent move operation locations. Values that represent copy operation locations. Initializes a new instance of the OperationsManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used for working with toolpath operations in Mastercam. Gets or sets the Default Program Number in a machine group. Gets the unique ID of this group in Mastercam. Gets or sets the current Group's name. Changing this property may require an update to the Toolpath Manager using the OperationsManager.RefreshOperations() method. Gets or sets the sequential tool numbering flag in a machine group. Sets the toolpath directory. The full path to the folder. True if it succeeds, false if it fails. (The folder does not exist or this Group is not a Machine Group). Gets the toolpath directory. The toolpath directory, else an empty string is this Group is not a Machine Group. This method is used to determine whether or not a Mastercam group is a Geometry group. True if this group object is a geometry group , else false if not. This method is used to determine whether or not a Mastercam group is a Machine group. True if this group object is a machine group , else false if not. This method is used to determine whether or not a Mastercam group is a Toolpath group. True if this group object is a toolpath group , else false if not. This method is used to get a group's parent. A new group object for this group's parent group or a null value if this group has no parent. This method tried to find a group name to match a group ID value given as input. The ID of the group in Mastercam to look for. The name of the matching group if one was found, else a null object reference if not. This method tries to find a group ID value to match a group name given as input. The name of the group in Mastercam to look for. The ID of the matching group if one was found, else -1 if not. This method validates whether or not a group ID value actually corresponds to a group in Mastercam. The ID of the group in Mastercam to try and validate. True if a matching group was found; false if not. The name of this group in Mastercam. The ID of this group in Mastercam. Deletes this group and all of it's subgroups from Mastercam. true if it succeeds, false if it fails. Initializes a new instance of the Group class. Initializes a group object to match the group name passed in. The name of the Mastercam group to initialize this object from. Initializes a new instance of the Group class. Initializes a group object to match the group ID passed in. The ID of the Mastercam group to initialize this object from. This class is used to work with Mastercam groups. This method commits a Drill tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the DrillTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the DrillTool class. Initializes a new instance of the DrillTool class. The identifier. This class is for modifying and using Drill tools in Mastercam. This method takes an "native" eptr of an entity ID supplied in NET type IntPtr form and tries to cast it down to a Geometry object. A Mastercam "native" DB_LIST_ENT_PTR of an entity in IntPtr format to try to find and cast down to a Geometry object. A Geometry object representing the database entity whose ID was passed in. This method takes an "native" eptr of an entity ID supplied in NET type IntPtr form and tries to cast it down to a Geometry object. A Mastercam "native" DB_LIST_ENT_PTR of an entity in IntPtr format to try to find and cast down to a Geometry object. A Geometry object representing the database entity whose ID was passed in. This method takes a view structure and tries to cast it down to an MCView object. The view structure to try and find and cast down to an MCView object. A MCView object representing the view structure passed in. This method takes a view ID and tries to cast it down to an MCView object. The view ID to try and find and cast down to an MCView object. A MCView object representing the view ID passed in. This method takes a tool structure and tries to cast it down to a Tool object. The tool structure to try to find and cast down to a Tool object. A Tool object representing the tool structure passed in. This method takes a tool ID and tries to cast it down to a Tool object. The tool ID to try and find and cast down to a Tool object. A Tool object representing the tool ID passed in. This method takes an operation structure and tries to cast it down to an Operation object. The operation structure to try to find and cast down to an Operation object. An Operation object representing the operation structure passed in. This method takes an operation ID and tries to cast it down to an Operation object. The operation ID to try to find and cast down to an Operation object. An Operation object representing the operation ID passed in. This method takes an entity structure and tries to cast it down to a Geometry object. The entity structure to try to cast down to a Geometry object. A Geometry object representing the database entity passed in. This method takes an entity eptr and tries to cast it down to a Geometry object. The entity eptr to try to find and cast down to a Geometry object. A Geometry object representing the database entity whose eptr was passed in. This method takes an entity ID and tries to cast it down to a Geometry object. The entity ID to try to find and cast down to a Geometry object. A Geometry object representing the database entity whose ID was passed in. This method takes an entity structure and tries to cast it down to a Surface object. The entity structure to try to cast down to a Surface object. A Surface object downcast to a Geometry object handle. This method takes an entity structure and tries to cast it down to a Solids object. The entity structure to try to cast down to a Solids object. A Solids object downcast to a Geometry object handle. Initializes a new instance of the Typecaster class. Private Constructor. Made private so as not to allow anyone to create an instance of it. Gets or sets the values of the (10) additional 'custom' parameters. Gets or sets or set a value indicating if the (10) additional 'custom' parameters are to be used. Gets or sets the additional Break Through distance. Gets or sets the Bore Shift distance. Gets or sets the Dwell time. Gets or sets the Chip Break retraction distance. Gets or sets the Peck Clearance. Gets or sets the Subsequent Peck increment. Gets or sets the First Peck increment. This method commits the current Drill operation to the Mastercam database. true to update any points assigned to the operation. If you know that you've not altered the points used by this operation, you may wish to used this >.Commit(false). True if the database commit was successful and false if not. This method commits the current Drill operation to the Mastercam database. This commit also updates any the points used by this operation. If you know that do not want the points touched during the commit, you may wish to use the .Commit(false) method overload. True if the database commit was successful and false if not. Initializes a new instance of the DrillOperation class. This creates a new drilling toolpath operation with default settings. Loads the default values for a given operation object from the operation structure passed in. [in,out] The operation structure to use as defaults for this operation object. Commits the operation. true to include, false to exclude touching the points during the commit. true if it succeeds, false if it fails. Initializes a new instance of the DrillOperation class. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Loads the default values for a given operation object. This class is used for working with drilling toolpath operations. Gets or sets the individual custom parameter values. There are 10 values in the array, accessed as usual - zero-based. Initializes a new instance of the DrillCustomParameters class. Drill Cycle operation custom parameter values. Gets or sets the type of drill cycle being used in this drill-based operation. Gets or sets the drill point sorting method being used in this drill-based operation. Gets or sets the Array list that holds all of the drill points being used in this drill- based operation. This property performs a deep copy of all of the elements passed in whenever an assignment is done as Mastercam does not allow the sharing of drill points between operations. That means that you may have to retrieve the handle to the new DrillPoint ArrayList after an assignment. Reverse the drill points in the operation. The SortMethod in the operation will be set to "OFF" after the reverse. true if it succeeds, false if it fails. Copies the drill points from another drill operation into this operation. The operations must already have been Committed for this to work! The source operation the points are to be copied from. true to replace the points in the current operation, else add them to the points already in the target operation. true if it succeeds, false if it fails. This method commits the current point-based operation's settings to the Mastercam database. True = also update the Drill Points, True if the database commit was successful, else false if not. This method commits the current point-based operation's settings to the Mastercam database. True if the database commit was successful, else false if not. This method retrieves the drill points from a given operation structure, from Mastercam's database. The identifier of the operation to retrieve the drill points from. The list of DrillPoints in the operation. Loads the default values for a given operation object from the operation structure passed in. [in,out] The operation structure to use as defaults for this operation object. Commits an operation to the Mastercam database. The operation to be committed. True = also update the Drill Points, else do everything except the Drill Points. True if the commit was successful, else false if not. Commits an operation to the Mastercam database. The operation to be committed. True if the commit was successful, else false if not. Initializes a new instance of the DrillBasedOperation class. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Initializes a new instance of the DrillBasedOperation class. This creates a new drill-based toolpath operation with default settings. The array of drill points being used in this operation. Adds the Drill Points to Operation. The new drill points. The operation. The number of points successfully added. Gets point based toolpath entities referenced by the operation. Identifier for the operation. The list to toolpath entities. The point based toolpath entities. This method creates an arc entity and stores it in the database. The point value to initialize this arc entity with. The radius of the arc value to initialize this arc entity with. The starting angle of the arc value to initialize this arc entity with. The sweep angle of the arc value to initialize this arc entity with. The view number the arc was created in. The entity created for this arc entity, assuming it was successful. True if the arc entity was created successfully; false if not. This method updates the drill points in the given operation structure. The operation to load the drill points into. This is the first update of the operation. The number of points in the Operation. This class is an intermediary class used in working with drill-based toolpath operations. The Window Handle. Sends an Escape key press to Mastercam (if it has the focus). Sets the input focus to Mastercam. This is something you would normally do not need to do. A situation when you would is... Your add-in is running a modeless dialog. You allow the user to select some entities via some action from your dialog. You are not hiding your dialog during this process. Now is when you will need this to set the focus to Mastercam. True if it succeeds to send the set focus request, false if not. Gets the handle to the window represented by the implementer. Initializes a new instance of the WindowWrapper class. The handle. Gets the Mastercam window handle. Wrapped as an IWin32Window for use with .NET forms. The Mastercam main window handle, else nullptr if it fails. This class implements the IWin32Window interface. You can use this as the parent of a modeless dialog. So when you hide/show your modeless dialog, when you reshow it, it pops up on top of Mastercam. This is a static inequality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first spline to compare. This is the second spline to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first Spline to compare. This is the second Spline to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this math object to another one. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. [in,out] This is the spline to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first Spline to compare. This is the second Spline to compare. True if the two objects are considered equal. Initializes a new instance of the Spline class. This takes all of the necessary pieces of data to construct this spline object and creates it with those values. The points of the spline to be created. The (user supplied) list of Node Points used to generate the Spline Curve. The second endpoint of the curve object. The first endpoint of the curve object. Initializes a new instance of the Spline class. The Mastercam spline geometry data. This class is used as a mathematical representation of a Spline. Resolve assemblies. Handles the assembly resolve. If non-null, the sender. If non-null, the arguments. nullptr if it fails, else an Assembly^. Allows the NET-Hook to shutdown Mastercam, if... true if EnableSilentShutdownMode is enabled and it succeeds, else false. Allows the NET-Hook to shutdown Mastercam, if... true if EnableSilentShutdownMode is enabled and it succeeds, else false. Retrieves the flag for the most recent mouse click. See The last mouse click type; RightClick or LeftClick // Test for this in the main 'Run' method of the NET-Hook. bool rightClick = (NetHook3App.GetLastMouseClick() == MCamMouseClickType.RightClick); if (rightClick) // Do something special if the user right-clicked on our toolbar icon... { System.Diagnostics.Debug.WriteLine("My NET-Hook: RIGHT Mouse Button Clicked!"); } Retrieves the flag for the most recent mouse click. See The last mouse click type; RightClick or LeftClick // Test for this in the main 'Run' method of the NET-Hook. bool rightClick = (NetHook3App.GetLastMouseClick() == MCamMouseClickType.RightClick); if (rightClick) // Do something special if the user right-clicked on our toolbar icon... { System.Diagnostics.Debug.WriteLine("My NET-Hook: RIGHT Mouse Button Clicked!"); } Overrideable. This method should return the version of the NET-Hook library the app was targeted to. The Mastercam version#. A MCamReturn return type code. Overrideable. This method should return the version of the NET-Hook library the app was targeted to. The Mastercam version#. A MCamReturn return type code. Overrideable. This method handles any multi-thread operation state changes that took place in Mastercam's execution environment. The operation ID whose state has changed. State of the operation. A return type code. Overrideable. This method handles any multi-thread operation state changes that took place in Mastercam's execution environment. The operation ID whose state has changed. State of the operation. A return type code. Overrideable. This method handles any notifications or event flags sent from the main Mastercam application. The event value representing the event that took place in Mastercam's execution environment. A return type code. Overrideable. This method handles any notifications or event flags sent from the main Mastercam application. The event value representing the event that took place in Mastercam's execution environment. A return type code. Overrideable. This method is executed just before a NET-Hook add-on is to be unloaded, and can be used to perform app-specific cleanup. The parameter (optional). A MCamReturn return type code. Overrideable. This method is executed just before a NET-Hook add-on is to be unloaded, and can be used to perform app-specific cleanup. The parameter (optional). A MCamReturn return type code. Overrideable. This method is executed after a NET-Hook add-on has been loaded and serves as the main execution loop for NET-Hook apps. The parameter (optional). A MCamReturn return type code. Overrideable. This method is executed after a NET-Hook add-on has been loaded and serves as the main execution loop for NET-Hook apps. The parameter (optional). A MCamReturn return type code. Overrideable. This method is executed when a NET-Hook add-on is first loaded. The parameter (optional) A MCamReturn return type code. Overrideable. This method is executed when a NET-Hook add-on is first loaded. The parameter (optional) A MCamReturn return type code. Sets the number formating we'll be using in the add-on. We need to have the decimal separator to be the '.', no matter what the culture setting. Sets the number formating we'll be using in the add-on. We need to have the decimal separator to be the '.', no matter what the culture setting. The Mastercam .NET User Application default application class. Creating an application class which derives from this class is one way of creating a valid NET-Hook add-on. There is a default implementation for each method that will work, overloading the Run method is required in order to get your NET-Hook add-on to be executable. The Mastercam .NET User Application default application class. Creating an application class which derives from this class is one way of creating a valid NET-Hook add-on. There is a default implementation for each method that will work, overloading the Run method is required in order to get your NET-Hook add-on to be executable. Provides a method to notify Mastercam of the NET-Hook version this add-on was compiled with. This should always return a Mastercam.App.Types.MCamDefines.NetHookLibraryVersion version number. The Mastercam version# (supplied by The Mastercam App). The version#. Provides a method to notify Mastercam of the NET-Hook version this add-on was compiled with. This should always return a Mastercam.App.Types.MCamDefines.NetHookLibraryVersion version number. The Mastercam version# (supplied by The Mastercam App). The version#. Used to notify the NET-Hook of any Mastercam multi-thread operation state changes during its execution. The operation ID whose state has changed. State of the operation. Always return the MCamReturn NoErrors code. Used to notify the NET-Hook of any Mastercam multi-thread operation state changes during its execution. The operation ID whose state has changed. State of the operation. Always return the MCamReturn NoErrors code. Used to notify the NET-Hook of any Mastercam events during its execution. The event value representing the event that took place in Mastercam's execution environment. Always return the MCamReturn NoErrors code. Used to notify the NET-Hook of any Mastercam events during its execution. The event value representing the event that took place in Mastercam's execution environment. Always return the MCamReturn NoErrors code. Used to cleanup any app-specific data before unloading a NET-Hook add-on. The parameter (optional) A MCamReturn return type code. Used to cleanup any app-specific data before unloading a NET-Hook add-on. The parameter (optional) A MCamReturn return type code. Used as the main entry point for a running the NET-Hook add-on. The parameter (optional) You can pass in an integer value to your Run method, when using a Function Table (.FT) file. A MCamReturn return type code. Used as the main entry point for a running the NET-Hook add-on. The parameter (optional) You can pass in an integer value to your Run method, when using a Function Table (.FT) file. A MCamReturn return type code. Used to initialize data when the NET-Hook add-on is loaded. The parameter (optional). A MCamReturn return type code. Used to initialize data when the NET-Hook add-on is loaded. The parameter (optional). A MCamReturn return type code. The Mastercam .NET User Application interface definition. Creating an application class which implements this interface is one way of creating a valid NET-Hook add-on. Providing definitions for all of the interface methods for the necessary framework to create and run NET-Hook add-ons successfully. The Mastercam .NET User Application interface definition. Creating an application class which implements this interface is one way of creating a valid NET-Hook add-on. Providing definitions for all of the interface methods for the necessary framework to create and run NET-Hook add-ons successfully. Mastercam multi-threaded operation states. Mastercam multi-threaded operation states. Operation processing was stopped. Operation processing was stopped. Operation processing failed. Operation processing failed. Operation processed successfully. Operation processed successfully. Mastercam App event codes and notifications. Mastercam App event codes and notifications. Called after a view sheet group is removed. Called after a view sheet group is removed. Called after a new view sheet group is added. Called after a new view sheet group is added. Called after a view sheet is renamed. Called after a view sheet is renamed. Called after the active view sheet is changed. Called after the active view sheet is changed. Called after a view sheet is removed. Called after a view sheet is removed. Called after a new view sheet is added. Called after a new view sheet is added. Called after nesting fails. Called after nesting fails. Called after nesting is successfully completed. Called after nesting is successfully completed. Called before nesting starts. Called before nesting starts. Called when Mastercam is ready. Called when Mastercam is ready. Called after the setup sheet is generated. Called after the setup sheet is generated. Called right before the setup sheet is about to be made. Called right before the setup sheet is about to be made. Called whenever the selection state of the operations has changed. Called whenever the selection state of the operations has changed. Called when a dialog bar needs to be re-attached Called when a dialog bar needs to be re-attached Called when a dialog bar needs to be detached Called when a dialog bar needs to be detached Called immediately after posting a file Called immediately after posting a file Called immediately before posting a file Called immediately before posting a file Called after SelectAllMask (Ctrl-A) Called after SelectAllMask (Ctrl-A) Called after a workspace is saved Called after a workspace is saved Called before a workspace is saved Called before a workspace is saved Called after a workspace is loaded Called after a workspace is loaded Called before a workspace is loaded Called before a workspace is loaded Level Manager: Called when graphics changes Level Manager: Called when graphics changes Status Bar Item: Active plane info display relative to WCS yes/no Status Bar Item: Active plane info display relative to WCS yes/no Called just before a part file is opened (X7) Called just before a part file is opened (X7) Called just after xform has finished transforming all instance of all entities. Called just after xform has finished transforming all instance of all entities. Called just before xform starts transforming all instances of all entities. Called just before xform starts transforming all instances of all entities. Called prior to exiting from Mastercam Called prior to exiting from Mastercam Called prior to running any application function Called prior to running any application function Called after exiting config Called after exiting config Called before entering config Called before entering config Called before database init executes Called before database init executes Called after exiting config Called after exiting config Called before entering config Called before entering config Generating graphics min/max Generating graphics min/max Screen repaint (back buffer) Screen repaint (back buffer) [DEPRECATED use RepaintBackBuffer] Screen repaint (back buffer) [DEPRECATED use RepaintBackBuffer] Screen repaint (back buffer) Solid History selection made Solid History selection made Status Bar Item: tool plane Status Bar Item: tool plane Status Bar Item: construction plane Status Bar Item: construction plane Status Bar Item: graphics view Status Bar Item: graphics view Status Bar Item: work coordinate system Status Bar Item: work coordinate system Status Bar Item: line width Status Bar Item: line width Status Bar Item: line style Status Bar Item: line style Status Bar Item: point style Status Bar Item: point style Status Bar Item: group Status Bar Item: group Status Bar Item: attributes Status Bar Item: attributes Status Bar Item: construction depth Status Bar Item: construction depth Status Bar Item: level Status Bar Item: level Status Bar Item: color Status Bar Item: color Status Bar Item: 2d/3d Status Bar Item: 2d/3d Undo Undo Exit tools preferences Exit tools preferences Enter tools preferences Enter tools preferences File open File open File save File save File save File save File new File new Screen fit Screen fit Screen repaint Screen repaint Mastercam App function return codes. Mastercam App function return codes. Request that the add-on be unloaded by Mastercam. A NET-Hook is never really unloaded until Mastercam exits. Request that the add-on be unloaded by Mastercam. A NET-Hook is never really unloaded until Mastercam exits. The function encountered an error and is no longer executing. The function encountered an error and is no longer executing. The function exited and is no longer executing. The function exited and is no longer executing. The function ended by the user hitting the escape key, therefore stopping the function's execution. The function ended by the user hitting the escape key, therefore stopping the function's execution. The function returned with no errors. This generally means that the function executed successfully. The function returned with no errors. This generally means that the function executed successfully. Mastercam App mouse click type codes. Mastercam App mouse click type codes. The code representing a right mouse click. The code representing a right mouse click. The code representing a left mouse click. The code representing a left mouse click. A null / error value. A null / error value. The Mastercam NET-Hook API library version numbers. The Mastercam NET-Hook API library version numbers. NET-Hook API library version number. NET-Hook API library version number. This runs the edit common parameters dialog box on the operations passed in via the array parameter. [in,out] This is the array of operations to edit via the edit common parameters dialog. The return type value corresponding to the button the user pushed. This displays either the edit drill points dialog box for drill operations, or the edit chains dialog box for chain-based operations. [in,out] This is the operation object to have it's geometry edited by the user. The return type value corresponding to the button the user pushed. This displays the edit operation dialog box for the operation object passed in. [in,out] This is the operation object to be edited by the user. The return type value corresponding to the button the user pushed. This displays the tool edit dialog box for the tool object passed in. [in,out] This is the tool object to be edited by the user. The return type value corresponding to the button the user pushed. This launches the Mill tool manager dialog. This displays a dialog box used to prompt the user for a string value. The maximum length of the string to be passed back is the system's MAX_PATH value. The prompt text to be displayed to the user. [in,out] This is a string value, passed back (by reference), of the text the user entered at the prompt. The return type value corresponding to the button the user pushed. This displays a dialog box used to prompt the user to choose a color. [in,out] This is the color number value, passed back (by reference) to the caller, that represents the color chosen by the user. True to show (if needed), false to hide the background color warning. The return type value corresponding to the button the user pushed. This displays a dialog box used to prompt the user to choose a color. [in,out] This is the color number value, passed back (by reference) to the caller, that represents the color chosen by the user. The return type value corresponding to the button the user pushed. This displays a dialog box used to prompt the user for a double value. The text to be displayed in the dialog. This is a double value that serves as a lower bound for whatever value the user chooses to enter as their number. This is a double value that serves as an upper bound for whatever value the user chooses to enter as their number. [in,out] This is the double value passed back (by reference) to the caller. The return type value corresponding to the button the user pushed. This displays a dialog box used to prompt the user for a double value. The text to be displayed in the dialog. [in,out] This is the double value passed back (by reference) to the caller. The return type value corresponding to the button the user pushed. This displays a dialog box used to prompt the user for a 16-bit integer. The text to be displayed in the dialog. This is the integer value that serves as a lower bound for whatever value the user chooses to enter as their number. This is the integer value that serves as an upper bound for whatever value the user chooses to enter as their number. [in,out] This is the integer value passed back (by reference) to the caller. The return type value corresponding to the button the user pushed. This displays a dialog box used to prompt the user for a 16-bit integer. The text to be displayed in the dialog. [in,out] This is the integer value passed back (by reference) to the caller. The return type value corresponding to the button the user pushed. This displays a dialog box used to prompt the user for an angle value. The text to be displayed in the dialog. [in,out] This is the angle value passed back (by reference) to the caller. The return type value corresponding to the button the user pushed. This displays a dialog box for exception handling purposes, containing the specified text, title, and an OK button. The MastercamException object that was caught and needs to be presented to the user. This displays a dialog box for error reporting purposes, containing the specified text, title, and an OK button. The text to be displayed in the dialog. The text to be displayed as the dialog's title. This displays a dialog box for message purposes, containing the specified text, title, and an OK button. The text to be displayed in the dialog. The text to be displayed as the dialog's title. This displays a dialog box with specified text, a title, a Yes button, a No button and a Cancel button. The text to be displayed in the dialog. The text to be displayed as the dialog's title. The return type value corresponding to the button the user pushed. This displays a dialog box with specified text, a title, a Yes button and a No button. The text to be displayed in the dialog. The text to be displayed as the dialog's title. The return type value corresponding to the button the user pushed. This displays an unhandled exception dialog box. The text to be displayed in the dialog. The text to be displayed as the dialog's title. Initializes a new instance of the DialogManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class handles common dialogs usable for NET-Hook to NET-Hook User interaction. Performs a Save As for a library file. The name and path of the library file to save. If true, then a thumbnail image will be saved along with the file. True if the save was successful, else false if not. Performs a Save on a library file. If true, then a thumbnail image will be saved along with the file. True if the save was successful, else false if not. Tests a file to see if it's a library file or not. The name and path of the file to check as to whether or not it's a library file. True if the file is a library file, else false if not. Gets the Mastercam part file extension based on the user's installed version information. Gets or sets the currently opened file's name. 'get' retrieves the active file name from Mastercam. If it is a new (unsaved) file, this will be the "default" name, as defined in System-Configuration - Start/Exit page - "Default Mastercam file name", and it will just that "name" with no path. Remove a single file entry from the Recent Open Files List. The (full path) name of the file to remove. True if it succeeds (a match was found and removed), false if it fails. Add the list of file entries to the Recent Open Files List. A list of the (full path) name of the files to add. Add a file entry to the Recent Open Files List. The (full path) name of the file to add. Clears Mastercam's Recent Open Files List. Gets the file name entries in the Recent Open Files List. A list of filename entries from the Recent Open Files List. Writes out a STL file. The full path filename of the file to write to. Specific entity to output or if '0' to output all, or if '-1' to output only 'selected' entities. The tolerance (0 = use the current system tolerance). true to output in ASCII text format, else false for a binary STL. true to set for no warnings, progress report of message are to presented to the user. true to output the data relative to the WCS, else false for world coordinates. true to allow if then entity is not on a currently visible level. true to allow if the entity is currently blanked. A 'true' result from this function does NOT necessarily mean that everything worked OK! true if it succeeds (the file was successfully opened), false if it fails. This method prints the active Mastercam view directly, without displaying the Mastercam Print dialog. Note that while the method may return true because the file was sent to the OS level to be printed, that does not necessarily mean that the file was printed successfully. True if the view was successfully sent for printing, else false if not. This is used to open the File Print dialog within Mastercam. This is used to save the currently opened file. If true, then a thumbnail image will be saved along with the file. True if the file was saved successfully, else false if not. This is used to save the currently opened file. The default behavior with this method is to not save a thumbnail image along with the file. True if the file was saved successfully, else false if not. This is used to 'save some' of the currently opened file to a new path and file name. This is the full, backslash-delimited path of the new Mastercam file you wish to create. If this is an empty string the standard Save As dialog will be displayed, allowing the user to select the output of the SaveSome operation. If true, then a thumbnail image will be saved along with the file. True if the new file was created successfully, else false if not. This is used to save the currently opened file to a new path and file name. This is the full, backslash-delimited path of the new Mastercam file you wish to create. If true, then a thumbnail image will be saved along with the file. True if the new file was created successfully, else false if not. This is used to save the currently opened file to a new path and file name. The default behavior with this method is to not save a thumbnail image along with the file. This is the full, backslash-delimited path of the new Mastercam file you wish to create. True if the new file was created successfully, else false if not. This is used to prompt the user to save the currently opened file to a new name and path. This is the full, backslash-delimited path of 'default' name you want to appear on the SaveAs dialog. The full path and file name of the new file if the user successfully chose one, else a null value if not. This is used to prompt the user to save the currently opened file to a new name and path. The full path and file name of the new file if the user successfully chose one and a null value if not. Saves a snapshot of the graphics screen to a bitmap file. The full path of the bitmap file you wish to create. If true, produce a color image, else just black on white. true to show, false to hide the view axes. true to show, false to hide the WCS axes. True if the bitmap file was created successfully and false if not. This is used to save the graphics view of the currently opened file to a (full size) bitmap file. The full path of the bitmap file you wish to create. If true, produce a color image, else just black on white. True if the bitmap file was created successfully and false if not. This is used to save the graphics view of the currently opened file to a bitmap file. This should be the full, backslash-delimited path of the bitmap file you wish to create. True = Generate a 256x256 "thumbnail" bitmap, else capture a full-size graphics screen image. True if the bitmap file was created successfully, else false if not. This is used to save the graphics view of the currently opened file to a bitmap file. This should be the full, backslash-delimited path of the bitmap file you wish to create. True if the bitmap file was created successfully, else false if not. Perform a File Merge Pattern operation. This allows for setting the "Levels" and "Setting" options via the supplied FileMergePatternOptions. The (full path) of the file to be merged in. The options for controlling the merge. True if it succeeds, false if it fails. This is used to close the current file and open a new file within Mastercam. If true, then the user will be prompted as to whether they want to save the current file before opening the new one. [in,out] This should be the full, backslash- delimited path of the file to open. If true, then instead of opening the new file outright it will instead have it's contents merged with the currently open file. If true, then instead of opening the specified file as a Mastercam file it will be opened with the Mastercam editor as a text-based file. True if the current file was closed and the new file was opened successfully , else false if not. This is used to close the current file and open a new file within Mastercam. If true, then the user will be prompted as to whether they want to save the current file before opening the new one. [in,out] This should be the full, backslash- delimited path of the file to open. If true, then instead of opening the new file outright it will instead have it's contents merged with the currently open file. True if the current file was closed and the new file was opened successfully, else false if not. This is used to close the current file and open a new file within Mastercam. If true, then the user will be prompted as to whether they want to save the current file before opening the new one. [in,out] This should be the full, backslash- delimited path of the file to open. True if the current file was closed and the new file was opened successfully. else false if not. This is used to close the current file and open a new file within Mastercam. By default this method will not prompt the user to save their current file nor will it save the current part file before opening the new one. This should be the full, backslash-delimited path of the file to open. True if the current file was closed and the new file was opened successfully and false if not. This is used to prompt the user to select a file to open within Mastercam. true to get file name only The file is NOT opened, just the selected filename is returned. nullptr if it fails, else the ful path of the file that was selected. This is used to prompt the user to select a file to open within Mastercam. The full path of the opened file if the user successfully chose a file to open and a null value if not. This is used to close the current file and open a new file within Mastercam. If this is set to true and the current file has unsaved changes in it, the user will be prompted to save off those changes before the new file is created. If true, then instead of actually creating a brand new file, the current file will just be re-initialized. True if the current file was closed and the new file was opened successfully, else false if not. This is used to close the current file and open a new file within Mastercam. If this is set to true and the current file has unsaved changes in it, the user will be prompted to save off those changes before the new file is created. True if the current file was closed and the new file was opened successfully, else false if not. This is used to close the current file and open a new file within Mastercam. By default, this method will not prompt the user to save their current file, nor will it save the current file before closing it. True if the current file was closed and the new file was opened successfully, else false if not. Gets the product and version of the Mastercam.exe file. Returns product and version if successful, else nullptr if it fails. Gets the version of the Mastercam.exe file. Returns version if successful, else nullptr if it fails. Gets the product name of the Mastercam.exe file. Returns product name if successful, else nullptr if it fails. Sets the file descriptor. This does not save the change "to disk". You make this change permanent using an API save method such as these, or just save the file via Mastercam's user interface. Mastercam.IO.FileManager.Save(); Mastercam.IO.FileManager.SaveAs(...); The new file descriptor text. Gets the file descriptor. The file descriptor text in the active part file. Gets the major version number of a Mastercam type file. The returned "major" version number denotes: 16 = Mastercam X7, 17 = Mastercam X8, 18 = Mastercam X9, 19 = Mastercam 2017, 20 = Mastercam 2018, Etc. The full path of the file to be queried. The major version if successful, else 0 if it fails (not a Mastercam file?). Import an NCI file to create new operation(s). The full path name of the NCI file to import. A list of the operation IDs of the imported operations. Initializes a new instance of the FileManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class handles file interactions between the NET-Hook and Mastercam. Display the Mastercam event log. This method saves the contents of the Mastercam event logger as a comma delimited file or xml file. If the event logger is not currently running calling this method does nothing. This is the filename of the log to save to disk. This is the file type: comma delimited (CSV) or XML. Gets the current event logging state. The log report action. Sets the global event logging state for the current session. The new action. This method allows you to assign a severity level icon and write a message to the Mastercam event logger. This is the level of severity: Information, Warning, or Error. This should be the fullpath to the current file. (it can be null). This is the text message to output to the log. True if the method was set successfully, false if not. Initializes a new instance of the EventManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used to work with and manage Mastercam event logging. Gets the length of the NURBSCurve object. In order to retrieve this information the NURBSCurve entity MUST be Committed to Mastercam's database. (If that cannot be done, this will return a value of -1.0) Gets a value indicating if the NURBSCurve is 'uniform'. Gets a value indicating if the NURBSCurve is 'periodic'. Gets a value indicating if the NURBSCurve is 'non-rational'. Gets a value indicating if the NURBSCurve is 'closed' (endpoints are equal). Gets a value indicating if the NURBSCurve is 'planar'. Gets the dimension of the NURBSCurve. In order to retrieve this information the NURBSCurve entity MUST be Committed to Mastercam's database. (If that cannot be done, this value will be -1.) Gets the degree of the NURBSCurve. In order to retrieve this information the NURBSCurve entity MUST be Committed to Mastercam's database. (If that cannot be done, this value will be -1.) Gets the number of knots in the NURBSCurve. In order to retrieve this information the NURBSCurve entity MUST be Committed to Mastercam's database. (If that cannot be done, this value will be -1.) Gets the number of knots in the NURBSCurve. In order to retrieve this information the NURBSCurve entity MUST be Committed to Mastercam's database. (If that cannot be done, this value will be -1.) Gets the Normal the NURBSCurve. If curve is planar, this is the normal to plane of curve. In order to retrieve this information the NURBSCurve entity MUST be Committed to Mastercam's database. (If that cannot be done, the values of this point will be all zeros.) Gets the maximum curvature of the NURBSCurve. In order to retrieve this information the NURBSCurve entity MUST be Committed to Mastercam's database. (If that cannot be done, this will return a value of -1.0) Gets the list of Knots in the NURBS Curve. In order to retrieve this information the NURBSCurve entity MUST be Committed to Mastercam's database. (If that cannot be done, this will return an empty list). Gets the list of Control Points of the NURBS Curve. These are the Control Points in the actual NURBS Curve geometry object, NOT the user supplied points used at the time creation of the NURBS Curve! Gets or sets the list of points used to create the NURBS Curve object. These are the user supplied points used at the time creation of the NURBS Curve. These are NOT the Control Points of the actual NURBS Curve entity! If the entity was NOT "user created" (it was "pulled" from Mastercam's database), this list will be empty! Gets the last point in the current NURBS curve object. Gets the first point in the current NURBS curve object. Gets the NURBSCurve data associated with this NURBSCurveGeometry object. Initializes a new instance of the NURBSCurveGeometry class. Creates a new NURBSCurveGeometry object based off of the supplied list of points. The point data to create this NURBSCurveGeometry object with. Initializes a new instance of the NURBSCurveGeometry class. Creates a new NURBSCurveGeometry object based off of the values in the specified NURBSCurve math object. The NURBSCurve data to create this NURBSCurveGeometry object with. Initializes a new instance of the NURBSCurveGeometry class. Creates new NURBS Curve geometry with default values - 2 node points - one at (0,0,0) and one at (1,0,0) and in the current construction view. Gets the entity from Mastercam's database. [out] The entity. true if it succeeds, false if it fails. The method does the actual creation of the NURBS Curve Entity. The node points of the NURBSCurve. [out] The Mastercam NURBSCurve entity. True if it succeeds, else false. LoadDefaults (Override) This handles the loading of defaults from a Mastercam entity. The entity to load the object's default values from. Commit (Override) This handles the committing of the object's data to the Mastercam database. The entity that will hold all the data being sent to the Mastercam database. Initializes a new instance of the NURBSCurveGeometry class. Creates a new object from the ID of an entity in the Mastercam database. The ID of the Mastercam entity to create the new object from. This class is used for working with NURBS curve geometry within Mastercam. This is a static inequality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first spline to compare. This is the second spline to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first Spline to compare. This is the second Spline to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this math object to another one. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. [in,out] This is the spline to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first Spline to compare. This is the second Spline to compare. True if the two objects are considered equal. Initializes a new instance of the NURBSCurve class. This takes all of the necessary pieces of data to construct this NURBS Curve object, and creates it with those values. The points of the NURBS Curve to be created. The (user supplied) list of Node Points used to generate the NURBS Curve. Gets or sets the second endpoint of the curve object. Gets or sets the first endpoint of the curve object. Initializes a new instance of the NURBSCurve class. The NURBS curve geometry. This class is used as a mathematical representation of a NURBS Curve. Convert a Managed ViewSheetData package to the native format. The managed representation of the ViewSheetData. The resulting unmanaged representation of the ViewSheetData. true if it succeeds, false if it fails. Initializes a new instance of the ViewSheets class. Private Constructor. Sets the current state for all "Save to ViewSheets" settings. The is equivalent to Enable/Disable All. The desired on/off state for all settings. A ViewSheetSettings with the requested state, else null if it fails. Sets the current "Save to ViewSheets" settings. The options for controlling the operation. true if it succeeds, false if it fails. Gets the current "Save to ViewSheets" settings. [out] The options for controlling the save operation. true if it succeeds, false if it fails. Displays the ViewSheet settings dialog. Query if 'name' is valid name (not already used). The name to check. true if the name is valid, false if not. Creates a copy of the specified ViewSheet. The (zero-based list) index of the ViewSheet to be copied. The (zero-based list) index of the new ViewSheet, else -1 if failed. Sets the bookmark data package for the specified ViewSheet. The (zero-based list) index of the ViewSheet. [out] The data package for the bookmark. true if it succeeds, false if it fails. Gets the data bookmark package for the specified ViewSheet. The (zero-based list) index of the ViewSheet. [out] The data package for the bookmark. true if it succeeds, false if it fails. Sets the data package for the specified ViewSheet. The (zero-based list) index of the ViewSheet. The data package. true if it succeeds, false if it fails. Gets the data package for the specified ViewSheet. The (zero-based list) index of the ViewSheet. [out] The data package. true if it succeeds, false if it fails. Rename a ViewSheet. ViewSheet names must be unique! The (zero-based list) index of the ViewSheet. The new name for the specified ViewSheet. true if it succeeds, false if it fails (invalid index or invalid name). Deletes the bookmark on a ViewSheet. The (zero-based list) index of the ViewSheet. true if it succeeds, false if it fails (invalid index). Query if a ViewSheet has bookmark. The (zero-based list) index of the ViewSheet to be copied. true if it does, false if it not. Restore bookmark. The (zero-based list) index of the ViewSheet to be copied. true if it succeeds, false if it fails. Saves a bookmark on a ViewSheet. The (zero-based list) index of the ViewSheet. true if it succeeds, false if it fails (invalid index). Gets the name of a ViewSheet. The (zero-based list) index of the ViewSheet. The name is successful, else an empty string if not. Gets the index of a ViewSheet. The name to search for. (case sensitive!) The (zero-based list) index of the ViewSheet if found, else -1 Sets the active ViewSheet. The (zero-based list) index of the ViewSheet. true if it succeeds, false if it fails. Gets the index of the active ViewSheet. The (zero-based list) index of the active ViewSheet. Deletes a ViewSheet. The (zero-based list) index of the ViewSheet. true if it succeeds, false if it fails (invalid index). Creates a new ViewSheet. ViewSheet names must be unique! The name for the ViewSheet. true if it succeeds, false if it fails. Creates a new ViewSheet. true if it succeeds, false if it fails. Gets the ViewSheets count. The number of ViewSheets in the list. Sets the enabled state of ViewSheets in the Mastercam session The on/off state to set. Get the enabled status of ViewSheets in the Mastercam session. true if the are enabled, else false if not. Gets a or sets value indicating whether the multiple view sheets are enabled. Initializes a new instance of a ViewSheetSettings. The native unmanaged data used to initialize the managed. Initializes a new instance of a ViewSheetSettings. When checked, save spaceball position When checked, save display mode settings When checked, save stock display settings When checked, save advanced toolpath display settings When checked, save selected planes When checked, save section view settings Auto restore bookmark settings? Save the Surface Density setting? Save the Line width? Save the Point style? Save the Line style? Save the Active level? Save the Color setting? Save the WCS Plane? Save the Construction Z Depth? Save the Construction Planes? Save the Tool Planes? Save the section view planes? Save the Graphic View? Save the 2D/3D construction mode setting? The "Save to ViewSheets" settings. Each represents the on/off state of the checkbox options. Initializes a new instance of a ViewSheetDataPackage. The "native" data to convert into a managed package. Initializes a new instance of a ViewSheetDataPackage. True to omit internal edges True to omit smooth edges Angle in degrees of radial hatching on primitive The color of edges when in outline mode Alternative hidden color Render color Dim percent (0 - 100) Combination of HIDDEN_NOSHOW, HIDDEN_DIMMED, HIDDEN_DASHED 1 = Course, 10 = Fine RENDER_WIRE, RENDER_HIDDEN, RENDER_SHADE, RENDER_OUTLINED. Holds viewsheet's copy of pCurrentGraphicsView->m_CurrentRenderMode. Holds viewsheet's copy of global gl_fulltime_translucent flag. keeps track of which stock display types get saved True if stock display is enabled, otherwise false. Keeps track of which section view types get saved in the viewsheet True if section view is enabled, otherwise false. Keeps track of which advanced toolpath display types get saved in the viewsheet True if advanced toolpath display is enabled, otherwise false. List of plane IDs for planes that are currently selected Spaceball rotation point List of plane IDs for planes that have section property set WCS Plane ID# Graphics (view) Plane ID# Tool Plane ID# Construction Plane ID# The active level number Surface Density setting List of (visible) level numbers Line width setting Construction Z depth Graphics viewport height Graphics viewport center point WCS matrix Graphics Plane (view) matrix Tool Plane matrix Construction Plane matrix Solids color Surface color Wireframe color Construction Mode; true = 3D, false = 2D A ViewSheet data package. This class is used to work with and manage Mastercam ViewSheets. Pointer to Mastercam's work (view) sheet tab control class. Query if 'index' is a valid index. Zero-based index of the list of ViewSheets to check. true if valid index, false if not. Creates a copy of a ViewSheetData class. The data to be copied for the ViewSheet. The resulting copy. Initialized this object. true if it succeeds, false if it fails. Initializes a new instance of the ViewSheets class. Private Constructor. Displays the ViewSheet settings dialog. Query if 'name' is name valid (not already used). The name to check. (Optional) true to do a case sensitive match. true if the name is valid, false if not. Query if a ViewSheet has bookmark. The (zero-based list) index of the ViewSheet to be copied. true if it does, false if it not. Restore bookmark. The (zero-based list) index of the ViewSheet to be copied. true if it succeeds, false if it fails (invalid index). Creates a copy of the specified ViewSheet. The (zero-based list) index of the ViewSheet to be copied. The (zero-based list) index of the new ViewSheet, else -1 if failed. Sets the data package for the specific ViewSheet. The (zero-based list) index of the ViewSheet. [in] The data package. (Optional) true to update the bookmark data. true if it succeeds, false if it fails. Gets the data package for the specific ViewSheet. The (zero-based list) index of the ViewSheet. [out] The data package. (Optional) true to retrieve the bookmark data. true if it succeeds, false if it fails. Gets the name of a ViewSheet. The (zero-based list) index of the ViewSheet. The name is successful, else and empty string if not. Rename a ViewSheet. ViewSheet names must be unique! The (zero-based list) index of the ViewSheet. The new name for the specified ViewSheet. true if it succeeds, false if it fails (invalid index or invalid name). Gets the index of a ViewSheet. The name to search for. (Optional) true to do a case sensitive match. The (zero-based list) index of the ViewSheet if found, else -1 Deletes the bookmark on a ViewSheet. The (zero-based list) index of the ViewSheet. true if it succeeds, false if it fails (invalid index). Saves a bookmark on a ViewSheet. The (zero-based list) index of the ViewSheet. true if it succeeds, false if it fails (invalid index). Sets the active ViewSheet. The (zero-based list) index of the ViewSheet. true if it succeeds, false if it fails. Gets the index of the active ViewSheet. The index of the active ViewSheet. Deletes a ViewSheet. The (zero-based list) index of the ViewSheet. true if it succeeds, false if it fails (invalid index). Creates a new ViewSheet. The name for the ViewSheet. true if it succeeds, false if it fails (name already used?). Creates a new ViewSheet. true if it succeeds, false if it fails. Gets the number if ViewSheets. The number sheets. Sets the enabled state of ViewSheets. true to enable, false to disable. Query if ViewSheets are enabled. true if it they are, false if not. This class is an "unmanaged" wrapper around Mastercam's ViewSheets. This is a static inequality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first point to compare. This is the second point to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first point to compare. This is the second point to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this math object to another one. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the point to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first point to compare. This is the second point to compare. True if the two objects are considered equal. Get or sets the specified coordinate of this Point2D. This is the bracket operator overload so that the X, Y values within this point can be accessed via an array-like interface. The index used within the brackets must be either 0 or 1 to access either the X or Y value within this Point2D. Thrown if an index is passed in that is out of the allowed range. This is the dot product method so that two points can have their dot product calculated. This is the first point in the dot product operation. This is the second point in the dot product operation. The value of the dot product between the two input points. This is the dot product operator overload so that two points can have their dot products calculated using an intuitive, mathematical method. This is the first point in the dot product operation. This is the second point in the dot product operation. The value of the dot product between the two input points. This is the subtraction method so that two points can be subtracted from one another. This is the point that will be subtracted from. This is the point whose values will be subtracted. A new point representing the vector subtraction of the two input points. This is the subtraction operator overload so that two points can be subtracted from one another. This is the point that will be subtracted from. This is the point whose values will be subtracted. A new point representing the vector subtraction of the two input points. This is the addition method so that two points can be added. This is the first point in the point addition operation. This is the second point in the point addition operation. A new point representing the vector addition of the two input points. This is the addition operator overload so that two points can be added using an intuitive, mathematical method. This is the first point in the point addition operation. This is the second point in the point addition operation. A new point representing the vector addition of the two input points. Convert this object into a string representation. A text string that represents this object. Gets or sets the Y value of the point object. Gets or sets the X value of the point object. Initializes a new instance of the Point2D class. This construction method takes an X and a Y value and constructs a point object from them. The value to become this point's X value. The value to become this point's Y value. "Converts" this NET-Hook type to the corresponding Mastercam math type. [in,out] The Mastercam math type. Initializes a new instance of the Point2D class. The Mastercam 2D point geometry data. This class is used as a mathematical representation of a 2D Point. The operator overloads in this class utilize the VectorManager class for their operations. The internal drill point name member. The internal arc geometry handle member. The internal jump height member. The internal depth value member. The internal point data member. Initializes a new instance of the DrillPoint class. The arc geometry data used to initialize the newly created drill point. Initializes a new instance of the DrillPoint class. The point geometry data used to initialize the newly created drill point. Initializes a new instance of the DrillPoint class. Takes a point object and an arc object and stores them in the newly created drill point. The point in 3D space to set the new drill point to. The arc geometry object handle to store in the drill point. Initializes a new instance of the DrillPoint class. Takes a point object and some parameters and stores them all in the newly created drill point. The point in 3D space to set the new drill point to. The depth value to initialize the drill point to. The jump height value to initialize the drill point to. Initializes a new instance of the DrillPoint class. Takes a point object and stores it in the newly created drill point. The point in 3D space to set the new drill point to. Initializes a new instance of the DrillPoint class. Gets or sets the optional 'name' for this drill point. Gets or sets the reference to arc geometry if the drill point is arc-based. Be sure to check this is not NULL before accessing its data! As not all DrillPoints have an associated Arc. Gets or sets the jump height value for the given drill point. If not explicitly set, this value will be initialized to -1.0E+38 Gets or sets the depth value for the given drill point. If not explicitly set, this value will be initialized to 1.0E+38 Gets or sets the point data for the given drill point. Initializes a new instance of the DrillPoint class. The drill point to be copied. The ID of the operation this DrillPoint belongs to. The ID of the operation this drill point is tied to. The ID of the geometry entity this drill point is tied to. The ID of the toolpath entity this drill point is tied to. The drill point class is used to provide drill-based operations with the data necessary to specify which points in 3D space are to be drilled and how they are to be drilled. Right-handed permutations. Get a CM::Transform3D describing the given Mastercam plane. Plane from which to extract the transformation matrix. Plane transform. Get a CM::Transform3D describing the Mastercam Plane matrix. The PlaneId. Plane transform. Get a CM::Transform3D describing the current Mastercam view plane. View plane transform. Get a CM::Transform3D describing the current Mastercam WCS matrix plane. WCS plane transform. Get a CM::Transform3D describing the current Mastercam tool plane. Tool plane transform. Get a CM::Transform3D describing the current Mastercam construction plane. (Optional) Optional flag to apply construction depth. Construction plane transform. Get a CM::Transform3D describing a Mastercam style matrix and origin. The view matrix. (Optional) The origin. A CM::Transform3D. Get a CM::Transform3D describing a Mastercam Planes style matrix and origin. The view matrix. (Optional) The origin. A CM::Transform3D. Get a Mastercam Planes style matrix and origin from a given CM::Transform3D object. A transform. The requested components. Get a Mastercam style matrix and origin from a given CM::Transform3D object. A transform. The requested components. Gets exit point. The lowest position on the hole axis where the hole leaves the solid face (if it does leave a face). True if it succeeds, false if there is no exit point. Check if the hole contains the given face tag. Tag of face to check for. Returns true if found in hole segments. Clone a new hole defintion with an applied transform. The transform. A copy of this object. Clone a new hole defintion. Get the collection of segments that comprise the hole. Returns the collection of pointers to segments. Get the edge treatment status. Returns edge treatment state. Is it a blind hole, i.e. its depth stops within the body. Returns true if is blind. Get the type of hole. Returns type. Get the depth of the hole. Measures the depth of the hole (Entry point to Bottom). Returns depth. Get the hole entry point. Point will be on the axis at the highest point of the hole. Returns the 3D point. Get the hole maximal bottom point. In the case of a through hole, this may not be the same as the exit point. Returns the 3D point. Get the hole axis origin. Where the hole is defined from - can be anywhere along the axis. Returns the 3D point. Get the hole axis reference direction. This is perpendicular to the hole axis. Returns the axis reference vector. Get the hole axis. The axis points out of the top of the hole. Returns the axis vector. Creates a .NET hole definition using it's C++ counterpart. The first parameter. Represents a hole in a solid. Get the segment index. The index starts from 0 (top/entry) Returns the index. Get the segment associated face tag, if there is one. Returns the face tag. Get the segment blend radius, if a blend type. Otherwise zero. Returns the blend radius. Get the segment end position distance from the hole axis Returns the distance. Get the segment start position distance from the hole axis Returns the distance. Get the segment end position on the hole axis Returns the 3D point. Get the segment start position on the hole axis Returns the 3D point. Creates a .NET hole segment definition using it's C++ counterpart. The first parameter. Represents a hole segment. Creates a reversed clone of the supplied hole. The hole to reverse. The new reverse hole. Gets all holes that are associated with the given face(s). Tags of Solid faces. Pointer to options structure. If null will use defaults. The collection of holes Find all holes on body. Will search for non-feature holes. Tag of body in the Feature tree. Pointer to options structure. If null will use defaults. The collection of holes Gets all holes that are defined as such from the feature tree. eptr to solid entity. (optional) Index in solid tree. If not supplied, will return all holes The collection of hole(s) in a map Options structure for GetHoles API. Enum for choosing which detection method to use. Get the edge treatment status. Returns edge treatment state. Is it a blind hole, i.e. its depth stops within the body. Returns true if is blind. Gets the name of the hole. The name. Gets fit type. The fit type. Gets the hole sub type. The sub type. Get the type of hole. Returns type. Get the depth of the hole. Measures the depth of the hole (Entry point to Bottom). Returns depth. Check if the hole contains the given face tag. Tag of face to check for. Returns true if found in hole segments. Get the collection of segments that comprise the hole. Returns the collection of pointers to segments. The lowest position on the hole axis where the hole leaves the solid face (if it does leave a face). Returns the 3D point. Get the hole entry point. Point will be on the axis at the highest point of the hole. Returns the 3D point. Get the hole maximal bottom point. In the case of a through hole, this may not be the same as the exit point. Returns the 3D point. Get the hole axis origin. Where the hole is defined from - can be anywhere along the axis. Returns the 3D point. Get the hole axis reference direction. This is perpendicular to the hole axis. Returns the axis reference vector. Get the hole axis. The axis points out of the top of the hole. Returns the axis vector. Clone a new hole defintion with an applied transform. Clone a new hole defintion. The hole definition interface class Edge treatment setting Values that represent the hole fit type. Values that represent the hole style sub type. Threaded Countersink Counterbore Simple The hole type Get the segment index. The index starts from 0 (top/entry) Returns the index. Get the segment associated face tag, if there is one. Returns the face tag. Get the segment blend radius, if a blend type. Otherwise zero. Returns the blend radius. Get the segment end position distance from the hole axis Returns the distance. Get the segment start position distance from the hole axis Returns the distance. Get the segment end position on the hole axis Returns the 3D point. Get the segment start position on the hole axis Returns the 3D point. Get the type of hole segment Returns the type. Hole segment interface class Hole segment types Attempt to retrieve a localized text string from the error tree. (Optional) True to fallback to the text contained in this error if no localized text found. The localized text if found, otherwise std::nullopt. Gets a value indicating if the text message is localized or not. True if localized, false if not. Gets the error code type information. The type_info for the error code. Gets the code. The code. Sets the inner error. The inner error. Gets the inner error. Null if it fails, else the inner error. Gets the exception. The exception, or null if there is none. Gets the text. The text. Constructor. The error code. The text. True if the text is localized, false if not. The exception. The inner error. The type information of the error code to store. The error base class. Moves the contained error out of the exception. A unique pointer to the contained exception. Get a pointer to the error object this exception is based on, if applicable. nullptr if no error, else a pointer to the error. Constructor. The message. A wrapper for throwing a result as an exception. Throw results can be either successful or error. This leads to a copy being performed of pertinent fields in the error, if applicable. Values that represent core error codes. Destructor. Moves the contained error from the given result. A unique pointer to the contained error from the result object. A result base class. A simple index with a safety marker. Possible orientations between two vectors. Create letters using modeless dialog. Check letter geometry file exist. letter to open. letter prefix. allow lower to upper case conversion. display not found warning. name of file with path and extension. true if it succeeds, false if it fails. Creates geometric letters without user input of any sort. The letters data needed to create the letters. The starting point. Chains if method is on curve". Add undo start/end. true if it succeeds, false if it fails. Gets display of TrueType load errors. Display of TrueType load errors. Sets display of TrueType load errors. Display of TrueType load errors. Display TrueType load error. (Optional) Name of the font. Display TrueType load error. Name of the font. (Optional) Dialog parent. Display TrueType load error. The caption. The message. Name of the font. Don't display again. (Optional) Dialog parent. Gets database double byte character. String to process. The database double byte character. Get the number of TrueType fonts. The number of TrueType fonts. Query if a TrueType font has been loaded. The font number. True if font there, false if not. Gets TrueType font data (copies name pointer - do not free) The font number. The font data. True if it succeeds, false if it fails. Prompt user to select a truetype font and adds it to font list. Parent window. Font number of selected. True if it succeeds, false if it fails. Is font Single Stroke Open Curve font. Font number. True if it succeeds, false if it fails. Is font Single Stroke Open Curve font. Font name. True if it succeeds, false if it fails. Get font string. Font number. Font string. (Optional) True to convert to uppercase. (Optional) True to add character set. True if it succeeds, false if it fails. Resets the TrueType font access settings. Remove TrueType fonts added by user. Gets default TrueType font name. The default TrueType font name. Gets diameter strings for combo box. Diameter strings - in order. Convert arrow parameters to arrow style. Arrow index from combobox (0-7) True if filled. Arrow style (0-11) Convert arrow style to arrow parameters. The arrow style (0-11) True if arrow style is filled. True to enable, false to disable the filled checkbox. True to enable, false to disable the width edit field. True to enable, false to disable the height edit field. Arrow index to combobox (0-7) Gets the hatch patterns The hatch patterns. Sets the hatch patterns The hatch patterns. Writes the custom hatch patterns to disk. Gets drafting regen mark. regen mark Sets drafting regen mark. . Gets drafting regen disabled reference. regen disabled Gets drafting regen disabled. regen disabled Sets drafting regen disabled. . Gets drafting regen auto. regen auto Sets drafting regen auto. . Gets drafting regen ASAP. regen ASAP Sets drafting regen ASAP. . Gets drafting baseline Y offset. baseline Y offset. Sets drafting baseline Y offset. new value. Gets drafting baseline X offset. baseline X offset. Sets drafting baseline X offset. new value. Gets drafting baseline automatic. baseline automatic setting. Sets drafting baseline automatic. new value. Gets drafting auto greeking. Auto greeking setting. Sets drafting auto greeking. new value. Gets drafting assoc disabled reference. assoc disabled Gets drafting assoc disabled. assoc disabled Sets drafting assoc disabled. . Gets drafting assoc. Assoc. Sets drafting assoc. new value. Removes the drag entity GrTemp item. Dirty graphics of drafting live/drag entity. Displays the dimension factor dialog. Height of the dimension text. The values. The parent. True if it succeeds, false if it fails. Sets 'pm' variables from drafting globals. The variables to set. (Optional) Font mode. Values that represent SetPm font modes. Initializes this object. True to metric. Queries if a given truetype font has been loaded. The font number. Check fonts. Set entity from this object. The note. True if it succeeds, false if it fails. Set this object from entity. The note. True if it succeeds, false if it fails. Get fa and wl from this object. Font attributes. Leader. True if GAF style. Set this object from fa and wl. Font attributes. Leader. True if GAF style. Sets object from structure. The font attributes. True if GAF style. Gets the font attributes. The font attributes. True if GAF style. Equality operator. The object. True if the parameters are considered equivalent. Assignment operator. Source for the object. A shallow copy of this object. Destructor. Default constructor. (Optional) True for metric defaults. Note parameters class. Initializes this object. True to metric. Queries if a given truetype font has been loaded. The font number. Check fonts. Checks HVP angle. Calculates the HVP orientation angle. DfHORIZONTAL or DfVERTICAL. Set this object from dimension. The dimension. True if it succeeds, false if it fails. Sets object from structure. The font attributes. True if GAF style. Gets the font attributes. The font attributes. True if GAF style. Equality operator. The object. True if the parameters are considered equivalent. Assignment operator. Source for the object. A shallow copy of this object. Destructor. Default constructor. (Optional) True for metric defaults. Dimension parameters class. Loads parameters from file (just first time). True if it succeeds, false if it fails. Gets dirty. True if dirty. Sets dirty. New value. Loads a message. True if successful. (Optional) True to display warning. Saves a message. True if successful. (Optional) True to display warning. Calculates the filename. The calculated filename. Gets valid flag from file. True if parameters exist in file and are marked valid. Saves valid flag to file. True if valid. True if it succeeds, false if it fails. Reads parameter from configuration file. The configuration line to parse (QNUM. KEY? VALUE) The configuration question number. True if it succeeds, false if it fails. Writes a parameter to configuration file. The configuration file. The configuration question number. (Optional) The question text. True if it succeeds, false if it fails. Searches for configuration question. The configuration question number. True if it succeeds, false if it fails. Loads parameters from file. (Optional) Display warning on failure. True if it succeeds, false if it fails. Saves parameters to file. (Optional) Display warning on failure. True if it succeeds, false if it fails. Removes all parameters. Removes all parameter pointers. Removes all parameter references. Adds a single parameter pointer. Pointer to parameter. Adds a single parameter reference. Pointer to parameter. Destructor. Adds multiple parameter references - must be one or more before "nullptr" The version. This method accepts a variable number of arguments. The last argument must be nullptr. Default constructor. The default section. The version (1 or greater). Default constructor. Default parameters class. Read from configuration file. Line to parse (QNUM. KEY? VALUE) True if it succeeds, false if it fails. Write to configuration file. The file. The text. True if it succeeds, false if it fails. Load from file. Name of the file. True if it succeeds, false if it fails. Save to file. Name of the file. True if it succeeds, false if it fails. Cast that converts given to type. The result of the operation. Destructor. Assignment operator. The value. A shallow copy of this object. Default constructor. The section. The key. The value. Base class. Default constructor. String templated class. Read from configuration file. Line to parse (QNUM. KEY? VALUE) True if it succeeds, false if it fails. Write to configuration file. The file. The text. True if it succeeds, false if it fails. Load from to file. Name of the file. True if it succeeds, false if it fails. Save to file. Name of the file. True if it succeeds, false if it fails. Cast that converts given to type. The result of the operation. Destructor. Assignment operator. The value. A shallow copy of this object. Default constructor. The section. The key. The value. Base class. Default constructor. Double templated class. Constructor. The reference. Default constructor. Smart pointer of type IDefaultValue class. Default value reference. Gets the configuration question. The configuration question or -1. Read from configuration file. Line to parse (QNUM. KEY? VALUE) True if it succeeds, false if it fails. Write to configuration file. The file. The text. True if it succeeds, false if it fails. Load from file. Name of the file. True if it succeeds, false if it fails. Save to file. Name of the file. True if it succeeds, false if it fails. Default value interface. Returns the currently set config filename (full path) The current configuration filename. Gets parameter configuration number. The parameter. The parameter configuration number. Gets values from configuration from configuration question. Line to parse. The require question number. The string answer. The number answer. The double answer. True if it succeeds, false if it fails. Convert aPoint to aPoint assoc with construction plane origin. The aPoint. True if it succeeds, false if it fails. Point on arc at angle. The arc. The angle in degrees. The point in world coordinates. Get associated solid edge tag from aPoint. The aPoint. (Optional) The solid identifier. (Optional) The selection identifier. Edge tag or 0. Validate aPoint tag type. The aPoint id (type). The sld tag. True if it succeeds, false if it fails. @par Purpose: Initialize an aPoint @param[out] apt aPoint to initialize @par Purpose: Initialize an aPoint's entity selection fields @param[out] apt aPoint to set @param[in] index entity field to set [0] or [1] @param[in] entity entity to use @param[in] t selection "t" value to use @par Purpose: Regenerate an Apoint and return a 3d point in view coordinates @param[in] apt aPoint to use @param[in] view view to use @param[in] depth depth in view @param[out] vpt 3d point in view coordinates @param[out] wpt 3d point in world coordinates @par Purpose: Copy two aPoints @param[out] dpt destination aPoint @param[in] spt source aPoint Initialize aPoint in view coordinates. aPoint. View number. Point in view coordinates. . Method (PEC_CENTER, etc) (Optional) Solid edge tag for assoc. (Optional) Associative - plane id (PEC_ORIGIN) or selection id (edge) Initialize aPoint in world coordinates. aPoint. Point in world coordinates. Method (PEC_CENTER, etc) (Optional) Solid edge tag for assoc. (Optional) Associative - plane id (PEC_ORIGIN) or selection id (edge) This method is used to create letters in the current Mastercam part file. The letter creation settings to use. True if the letters were created successfully, else false if not. Releases the true type described by InternalData. Information describing the internal. True if it succeeds, false if it fails. Initializes the true type. Information describing the internal. True if it succeeds, false if it fails. Creates and returns the appropriate font prefix string for Mastercam letter creation. The letter creation settings to use. A string representing the appropriate font prefix for letter creation based on the given font mode. Initializes a new instance of the LetterCreationManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used for performing graphics-related tasks and activities. Gets or sets the meshes. Gets or sets the surfaces. Gets or sets the points. Gets or sets the drafting. Gets or sets the curves. Gets or sets the the 2D geometry. A class to represent all geometry required by a transform project operation. Gets or sets the surf step chord development tolerance. Gets or sets a value indicating whether to use metric. Gets or sets the level. Gets or sets the color. Gets or sets a value indicating whether this object use new attribute level. Gets or sets a value indicating whether this object use new attribute color. Gets or sets a value indicating whether to automatic preview. Gets or sets the format to use. Gets or sets a value indicating whether to output to file. Gets or sets the line length. Gets or sets a value indicating whether to project line direction. Gets or sets a value indicating whether to project lines. Gets or sets a value indicating whether to project points. Gets or sets a value indicating whether the points lines is enabled. Gets or sets the project creation method by. Gets or sets the join tolerance. Gets or sets a value indicating whether to join results. Gets or sets the maximum distance. Gets or sets a value indicating whether this object use maximum distance. Gets or sets a value indicating whether the find multiples. Gets or sets the direction. Gets or sets the tolerance. Gets or sets the distance. Gets or sets the method to project by. Gets or sets the result method. Values that represent what format to output projection data. Values that represent how the projection geometry will be created. Values that represent project direction. Values that represent how to project. Values that represent resulting project geometry. Gets or sets the output color. Gets or sets the output level. Gets or sets the result geometry type. Gets or sets the associated to point. Gets or sets the associated from point. Gets or sets the alignment to point. Gets or sets the alignment from point. Gets or sets a value indicating whether to use alignment points. Gets or sets a value indicating whether to use associated points. Gets or sets the cylinder angle. Gets or sets the degree tolerance. Gets or sets the radius. Gets or sets the direction. Gets or sets the axis. Gets or sets the mode. Gets or sets the method. Values that represent what type of geometry to create in a roll transform. Rotate along the X-axis Create points Create lines and arcs Values that represent the roll direction. Roll/Unroll in the counterclockwise direction Roll/Unroll in the clockwise direction Values that represent how the rotation axis is defined for roll transformations. Rotate along the X-axis Rotate along the X-axis Values that represent the roll mode. Roll the selected geometry Roll the selected geometry Values that represent if the original is a copied or moved. Moves the original entities Copies the original entities Gets or sets a value indicating whether to separate each instance on a different level. Gets or sets the level to place the new geometry on (if UseNewAttributes = true). Gets or sets the color to create the new geometry in (if UseNewAttributes = true). Gets or sets a value indicating whether to use the specified Level attribute. Gets or sets a value indicating whether to use the specified Color attribute. Gets or sets the maximum depth value. Gets or sets the tolerance value. Gets or sets a value indicating whether infinite look ahead should be used. Gets or sets the corner style (Sharp/All) option. Gets or sets a value indicating whether the corners should be modified. Gets or sets the offset direction option. Gets or sets the offset style (Incremental or Absolute) option. Gets or sets the offset angle value (value is in degrees). Gets or sets the offset depth value. Gets or sets the offset distance value. Positive Distance = Offset to the right of the Chain. Negative Distance = Offset to the left of the Chain. Gets or sets the number of offset instances to create. Gets or sets the Move/Copy/Join/Slot result option. Initializes a new instance of the OffsetChainParameters class. The parameters used for Offset Chains. Values that represent method of fillet modification for Offset Chain. Creates arcs at all corners to connect the entities when offsetting the boundary outward. Creates arcs at sharp corners to connect the entities when offsetting the boundary outward. Values that represent direction of translation for Offset Chain. Translate towards both sides. Translate towards opposite side. Translate towards defined side. Values that represent method of calculating depth for Offset Chain. Calculates offset depth relative to the actual depth of the entities in the boundary. Calculates offset depth relative to the construction plane. Values that represent method of translating for Offset Chain. Transforms a copy of the selected entities to a new position in to create a slot and maintains the position of the original entities. Copies the original entities and creates geometry between them. Copies the original entities. Moves the original entities. Gets or sets the post break (Delete/Keep/Blank) option. Gets or sets the rounded distance value. Gets or sets the exact distance value. Gets or sets the tolerance value. Gets or sets the number of pieces to break the entity into. Gets or sets the Number/Tolerance/ExactDistance/RoundedDistance option. Gets or sets a value indicating whether to create curves or lines. True for curves, false for lines. Initializes a new instance of the BreakManyPiecesParameters class. Metric flag. The tolerance. Initializes a new instance of the BreakManyPiecesParameters class. The parameters used for Break Many Pieces. Values that represent the segmentation methods for Break Many Pieces. This is used with the GeometryManipulationManager.BreakManyPieces method. Specifying to allow change of the entered Number and/or Distance values so that the function creates segments of all equal lengths. Specifying to create segments of the exact length specified in the Distance field. Specifying the chord height tolerance you want to use when breaking an arc or spline. Specifying the number of new arc or line segments you want to create by breaking the entity. Values that represent the post break action to take for Break Many Pieces. This is used with the GeometryManipulationManager.BreakManyPieces method. Specifying to blank the original curves. Specifying to keep the original curves. Specifying to delete the original curves. Values that represent original curves dispositions. This is used with the GeometryCreationManager::CreateNURBSSplineFromChain method. An enum representing the option to move the original curves to the specified level. An enum representing the option to delete the original curves. An enum representing the option to blank the original curves. An enum representing the option to keep the original curves. Gets or sets the extra amount to expand the bounding box along the +Z axis. Gets or sets the extra amount to expand the bounding box along the -Z axis. Gets or sets the extra amount to expand the bounding box along the +Y axis. Gets or sets the extra amount to expand the bounding box along the -Y axis. Gets or sets the extra amount to expand the bounding box along the +X axis. Gets or sets the extra amount to expand the bounding box along the -X axis. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to create a rectangular bounding box. Gets or set a value indicating if the cylinder will be created in such a way that it will be centered along it's primary axis. Gets or sets the direction to lay the lengthwise axis of the bounding cylinder to be created. Gets or sets the extra amount to expand the +length of the bounding cylinder. Gets or sets the extra amount to expand the -length of the bounding cylinder. Gets or set the extra amount to expand the radius of the bounding cylinder. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to create a cylindrical bounding box. This class represents the data needed to indicate a 3-dimensional axis for cylindrical bounding box creation. The X axis. The Y axis. The Z axis. Gets or sets a value indicating the option to make the bounding box a solid. Only available for 3D geometries. Gets or set a value indicating the option to create a point at the center of the bounding box. Gets or sets a value indicating the option to create points at the corners or the extents of the bounding box. Gets or sets a value indicating the option to create a closed boundary of lines/arcs. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to create a bounding box. Name of the true type font. Gets or sets the font folder containing the Mastercam files for the "other' font option. Note that is used only when the FontMode is set to 'MastercamOther'. Gets or sets the anchor point of the letters to be created if the font alignment is horizontal or vertical -or- The center point of the curve if the letters are to be created on a curve. Gets or sets the distance between letters in screen units. Gets or sets the radius from the starting point if the letters are to be created on a curve. Gets or sets the height in screen units of the letters to be created. Gets or sets the text font alignment of the letters. Gets or sets the name of the TrueType font to use in creating these letters. Gets or sets the font type to use in creating these letters. Gets or sets the text to be turned into letters. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to create letters in the current file. This class represents the different types of fonts that can be used during letter creation.. TrueType font. Drafting Dayville font. Drafting Palatino font. Drafting Old English font. Drafting Hartford font. Drafting Swiss font. Drafting European font. Drafting Roman font. Drafting Stick font. Mastercam Other font. Mastercam Slant font. Mastercam Roman font. Mastercam Block font. Mastercam Box font. This class represents the different font alignment types when creating letters. Note that the Horizontal alignment option is the only one available when using the Drafting font modes. Positing the letters on the bottom of a curve around a center point. Note that this alignment option is only available when using one of the Mastercam font modes. Positing the letters on the top of a curve around a center point. Note that this alignment option is only available when using one of the Mastercam font modes. Vertical letter positioning. Note that this alignment option is only available when using one of the Mastercam font modes. Horizontal letter positioning. This class represents the data needed to indicate the endpoints of a curve. The second endpoint of a curve. The first endpoint of a curve. Gets or sets the whether the helix is to rotate clockwise from the basepoint or not. Gets or sets the number of degrees to which the helix is rotated about the center point. Gets or sets the pitch of the helix to be created. Gets or sets the angle from the base of the helix to the top of the helix. Gets or sets the number of helical revolutions. Gets or sets the radius from the center point to the starting point of the helix. Gets or sets the center point of the helix. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to represent a helix. Gets or sets a value indicating whether the spiral is to rotate clockwise from the basepoint or not. Gets or sets the center point of the spiral. Gets or sets the number of revolutions in the spiral. Gets or sets the radius from the center point of the spiral to it's start point. The spiral's start point is the point dictated by it's lower/inner pitch point. Gets or sets the upper vertical pitch of the spiral. Gets or sets the lower vertical pitch of the spiral. Gets or sets the outer horizontal pitch of the spiral. Gets or sets the inner horizontal pitch of the spiral. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to represent a spiral. Gets or sets a value indicating whether a point will be created at the center of the polygon. Gets or sets a value indicating whether the polygon has a trimmed surface. Gets or sets a value indicating whether the radius is measured from the center to the corners. Otherwise, it is measured from the center to the midpoints of the sides. Gets or sets the number of degrees to which the polygon is rotated about the center point. Gets or sets the radius of fillets. Gets or sets the distance between the center and either the corners or edges' midpoints. Gets or set the number of sides in the polygon. Gets or sets the location of center point of the polygon (world coordinates.) This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to represent a polygon. Initializes a new instance of the FilletChainsParams class. This class represents the options and data needed for creating fillets on a chain. This enum specifies the different possible fillet 're-fillet' options available when creating fillets. Will do re-filleting and will not deleted the existing fillets. Ask user before re-filleting of existing fillets in the chain. Do re-filleting of existing fillets in the chain. Do not re-fillet existing fillets in the chain. This enum specifies the different possible fillet 'style' options available when creating fillets. Create an clearance fillet. Create an circle fillet. Create an inverse fillet. Create a normal fillet. This enum specifies the different possible fillet 'direction' options available when creating fillets. Any direction (CCW or CCW) CW (or negative) CCW (or positive) Gets or sets the object representing this draft surface's generating curve geometry. Gets or sets the sine of the drive line's angle. Gets or sets the vector of the drive line for this draft surface. Loads the default values for a given surface geometry object from the geometry entity passed in. [in,out] The surface geometry entity to use as defaults for this surface geometry object. Commits a surface geometry entity to the Mastercam database. [in,out] The surface geometry entity to be committed. True if the commit was successful; false if not. Initializes a new instance of the DraftSurface class. Attempts to retrieve a surface geometry entity with the given ID from the Mastercam database and use that to initialize this surface geometry object. If no matching geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the surface geometry entity to look up in the Mastercam database. This class is used for working with draft surface geometry in Mastercam. Gets or sets the center point for the current surface. Gets or sets the check surface flags for the given surface object. Gets or sets the lowest max curvature of the surface. Gets or sets the highest max curvature of the surface. Gets or sets the max curvature of the surface along V. Gets or sets the max curvature of the surface along U. Gets or sets the radius of the surface, from center to outer edge. Gets or sets the maximum Z value. Gets or sets the minimum Z value. Gets or sets the maximum Y value. Gets or sets the minimum Y value. Gets or sets the maximum X value. Gets or sets the minimum X value. Gets or sets the maximum V value. Gets or sets the minimum V value. Gets or sets the maximum U value. Gets or sets the minimum U value. Gets or sets a value indicating if the surface has a bad high V value. Gets or sets a value indicating if the surface has a bad low V value. Gets or sets a value indicating if the surface has a bad high U value. Gets or sets a value indicating if the surface has a bad low U value. Gets or sets a value indicating if the surface is bad for whatever reason. Gets or sets a value indicating if the surface is ready / complete. False indicates there is further processing to be done to it. Gets or sets a value indicating if the surface moves from high to low in V. Gets or sets a value indicating if the surface moves from high to low in U. Gets or sets a value indicating if the surface moves along the V. Gets or sets a value indicating the normal off the surface is reversed. Gets or sets a value indicating if the V is closed. Gets or sets a value indicating if the U is closed. Gets or sets a value indicating the shading values for the surface geometry. Gets or sets the density of the surface geometry. Loads the default values for a given surface geometry object from the geometry entity passed in. [in,out] The geometry entity to use as defaults for this surface geometry object. Commits a surface geometry entity to the Mastercam database. The surface geometry entity to be committed. True if the commit was successful, false if not. Initializes a new instance of the abstract class. ID Lookup Constructor. Attempts to retrieve a geometry entity with the given ID from the Mastercam database and use that to initialize this surface geometry object. If no matching geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the geometry entity to look up in the Mastercam database. Loads the default values for a given surface geometry object. This class handles the interaction between the NET-Hook and Mastercam for Surface geometry objects. Loads the default values for a given mesh geometry object from the geometry entity passed in. [in,out] The mesh geometry entity to use as defaults for this mesh geometry object. Commits a mesh geometry entity to the Mastercam database. [in,out] The mesh geometry entity to be committed. True if the commit was successful; false if not. Initializes a new instance of the MeshGeometry class. Attempts to retrieve a mesh geometry entity with the given ID from the Mastercam database and use that to initialize this mesh geometry object. If no matching geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the mesh geometry entity to look up in the Mastercam database. This class is used for working with Polygonal Mesh entities within Mastercam. Gets or sets the special rendering properties for this Mesh. Gets a value indicating the "use type" of this mesh in an operation; (Comp, Drive, Check). Gets a value indicating if the Min/Max Points are valid, or not. Gets the maximum point of 3D extents (after any transformations). Gets the minimum point of 3D extents (after any transformations). Gets the index in the polygonal_mesh database map (-1 = not valid). Gets the type of the Mesh geometry. Loads the default values for a given Mesh geometry object from the geometry entity passed in. [in,out] The geometry entity to use as defaults for this Mesh geometry object. Commits a Mesh geometry entity to the Mastercam database. The Mesh geometry entity to be committed. True if the commit was successful, false if not. Initializes a new instance of the MeshGeometry class. ID Lookup Constructor. Attempts to retrieve a geometry entity with the given ID from the Mastercam database and use that to initialize this Mesh geometry object. If no matching geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the geometry entity to look up in the Mastercam database. Loads the default values for a given Mesh geometry object. This class handles the interaction between the NET-Hook and Mastercam for Mesh geometry objects. Note that this type of entity is not user construct-able. This is for interacting with Polygonal Mesh entities that already exist in Mastercam's database. This method commits a End Mill Flat tool to the Mastercam database. Thrown when an identifier not found error condition occurs. true if it succeeds, false if it fails. Initializes a new instance of the EndMillFlatTool class. The tool diameter. The corner radius. The Tool #. The length offset register. The diameter offset register. The over-all length. Length of the flute. Length of the shoulder. The name of the tool Initializes a new instance of the EndMillFlatTool class. Initializes a new instance of the EndMillFlatTool class. The identifier. This class is for modifying and using End Mill Flat tools in Mastercam. This method takes the array of Chain(s) passed in and copies its contents into the internal chain array for this operation. The new chains. This method retrieves the Chains in this operation. An array containing the Chain(s) in the operation. This method commits the current chain-based operation's settings to the Mastercam database. True = also update the Chains, else only do everything except the Chains. True if the database commit was successful, else false if not. This method commits the current chain-based operation's settings (including chains) to the Mastercam database. True if the database commit was successful, else false if not. This array holds all of the chains being used in this operation. Loads the default values for a given operation from the operation structure passed in. [in,out] The operation data to use as defaults for this operation. Commits an operation to the Mastercam database. The operation to be committed. True = also update the Chains, else do everything except the Chains. True if the commit was successful; false if not. Commits an operation to the Mastercam database. The operation to be committed. True if the commit was successful; false if not. Initializes a new instance of the ChainBasedOperation class. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. Initializes a new instance of the ChainBasedOperation class. This creates a new chain based toolpath operation with default settings. This method updates all of the chains in the current chain based operation object. This method retrieves all of the chains assigned to the current chain based operation object. This class is an intermediary class used in working with chain-based toolpath operations. Determines if two Chains are equal. "equal" meaning that both Chains reference the same geometry entities, if the same order. The first chain to compare. The second chain to compare. true if the are, false if they are not. This method simply retrieve the Chains in the specified operation. The operation to be queried. [out] This is a reference to an array of Chain objects retrieved. This specifies which types of chains are to be used during the management process. See for more details. True if the management function requested was successful, else false if not. Gets the chains comparer for the specified 'type' and 'order'. Type of the sort. The sort order. This member function is a multi-function management tool for working with Chains. This is the operation that is involved in the chain management process. [in,out] This is a reference to an array of Chain objects, modifying them as the chain management process dictates. This flag specifies what chain management functionality is to be utilized. See for more details. This specifies which types of chains are to be used during the management process. See for more details. True if the management function requested was successful, else false if not. Checks the chains in an Operation to see if they all lie in the same Z plane. The operation to examine to see if it's chains all lie in the same Z plane. True if all of the chains lie in the same Z plane; false if not. This method frees the memory used in internal chain structures in an array. The chain structure array to free. Gets or sets the 'chaining tolerance' which represents the tolerance value for how closely Mastercam matches distances for the purposes of chaining. Chain end process. [in,out] If non-null, the process. Chain begin process. Null if it fails, else a pointer to a void. Get the solid chains that were selected. The list of chains that were found. Inits the solid chain selection in the chain manager. Determines if two Chains are equal. "equal" meaning that both Chains reference the same geometry entities, if the same order. The first array of chains to compare. The second array of chains to compare. true if the are, false if they are not. Checks an array of chains to see if they all lie in the same Z plane. The array of chains the method will examine to see if they're all in the same Z plane. True if all of the chains lie in the same Z plane; false if not. Orient open chains. Orients the open chain by the first/last entity ID of the Chain, but making sure the ID of the first is before (less than) the last ID in the Chain. If the Chain consists of only one entity, it makes sure that the first endpoint of that entity is the start of the Chain. The intent here is to try to recover the data chain order in sending system. (DXF file for example) [in, out] The chains to be oriented. The number of chains that were oriented. Sort chains. The array of s to be sorted. What data of the Chain are we sorting on?. The sort order; Ascending or Descending. If the supplied array contains 0 or 1 chain, no sort is performed. true if it sorted anything, false if not. Re-Links the linked list of Chains. If an array of Chains has been sorted or reordered in any way, we need to make sure the that (native) links in the list are properly set. The array of s. Prompts the user to create and select a number of chains, which are then applied to the specified Operation object. The Operation object to apply the user-created chains to. An array of objects, representing those chains the user created for the operation. Creates and returns chains around each of the geometry objects passed in. The array of Geometry objects to chain. An array of objects, one for each chain around the input geometry. Chains all of the selected geometry in the part file. If true, only closed chains will be returned. An array of objects, one for each chain around selected geometry. Chains all of the selected geometry in the part file. An array of objects, one for each chain around selected geometry. Chains all of the geometry in the part file, taking into consideration the specified of parameters. If true, only closed chains will be returned. If true, only geometry at Z depth zero will be chained. If a valid view object is passed in, only geometry in this view at Z0 will be chained*. Please note! Specifying a (non-null) view in essence sets the "only Z depth zero" mask to be true in addition to the view restriction. The that indicates the chaining direction.. If a non-null value, only geometry on the level with a Level name matching this value will be chained. Note! Since there is no restriction on Level names being unique, there can be multiple matches when selecting levels "by name". If there are multiple levels that match the supplied LevelNameToChain - ALL of those Level numbers will be processed! Passing a false, default, or null value for any of these parameters will omit that parameter when searching for geometry to chain. An array of Chain objects matching the given parameters. Chains all of the geometry in the part file, taking into consideration the specified parameters. If true, only closed chains will be returned. If true, only geometry at Z depth zero will be chained. The view to restrict the chain search to. Note! If a valid view object is passed in, only geometry in this view at Z0 will be chained. Specifying a (non-null) view in essence sets the "only Z depth zero" mask to be true in addition to the view restriction. The that indicates the chaining direction. If not null, an array of level numbers to match on to be chained. An array of Chain objects matching the given parameters. Passing a false, default, or null value for any of these parameters will omit that parameter when searching for geometry to chain. Chains all of the geometry in the part file, taking into consideration the specified parameters. If true, only closed chains will be returned. If true, only geometry at Z depth zero will be chained. The view to restrict the chain search to. Note! If a valid view object is passed in, only geometry in this view at Z0 will be chained. Specifying a (non-null) view in essence sets the "only Z depth zero" mask to be true in addition to the view restriction. The that indicates the chaining direction. If greater than 0, only geometry on the matching level number will be chained. An array of Chain objects matching the given parameters. Passing a false, default, or null value for any of these parameters will omit that parameter when searching for geometry to chain. Chains all of the geometry in the part file, taking into consideration the specified parameters. If a non-null value, only geometry on the level with a name matching this value will be chained. NOTE! Since there is no restriction on Level names being unique, there can be multiple matches when selecting levels "by name". If there are multiple levels that match the supplied LevelNameToChain - ONLY the first one found will be processed! An array of Chain objects matching the given parameters. Chains all of the geometry in the part file, taking into consideration a number of parameters. If greater than 0, only geometry on the level matching this value will be chained. An array of Chain objects matching the given parameters. Chains all of the geometry in the part file, taking into consideration the specified parameters. Indicates the direction (CW or CCW) that all chains should created in. An array of Chain objects matching the given parameters. Chains all of the geometry in the part file, taking into consideration the specified parameters. The view to restrict the chain search to. Note! If a valid view object is passed in, only geometry in this view at Z0 will be chained. Specifying a (non-null) view in essence sets the "only Z depth zero" mask to be true in addition to the view restriction. An array of Chain objects matching the given parameters. Chains all of the geometry in the part file, taking into consideration the specified parameters. If true, only closed chains will be returned. If true, only geometry at Z depth zero will be chained. An array of Chain objects matching the given parameters. Chains all of the geometry in the part file. An array of Chain objects. Prompts the user to pick any number of chains. The text displayed to the user when they are prompted to pick the chains. If true, then the user-driven chaining dialog will return any chained points as well as boundary chains. Returns an array Chain objects if successful, else null if not. Prompts the user to pick any number of chains. The text displayed to the user when they are prompted to pick the chains. Returns an array Chain objects if successful, else null if not. This method by default does not return chained points. Prompts the user to pick a single chain around some geometry. The text displayed to the user when they are prompted to pick a chain. Returns a Chain object if successful, else null if not. This method takes an array of chains and modifies them so that they all begin with the longest side of their chain geometry. This only alters the "closed" chains! [in,out] The array of chains to re-order. Gets the geometry (in chain order) that is referenced in a chain. The chain to interrogate. The returned geometry are "new" objects. If you created geometry and then created the Chain using that geometry, the geometry items returned by this method are not the same objects. Also note that "Chain order" is the order of the geometry items in the Chain. It does not necessarily mean that the endpoints of each geometry item necessarily aligns to the next geometry object in the returned list. The list of geometry referenced in the chain. Values that represent the 'type' of the sort (what data in a Chain to sort on). Values that represent the a sorting order (Ascending or Descending). Initializes a new instance of the ChainManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. The Chain Manager class is used for creating, freeing, modifying, and otherwise managing Chain objects. Compare two Chains by database entity id - descending. The first Chain to compare. The second Chain to compare. 0 if equal, 1 if Chain 1 (first) entity ID < Chain 2 (first) entity ID, -1 if Chain 1 (first) entity ID > Chain 2 (first) entity ID. A sort chains by database order descending comparer. Compare two Chains by database entity id - ascending. The first Chain to compare. The second Chain to compare. 0 if equal, 1 if Chain 1 (first) entity ID > Chain 2 (first) entity ID, -1 if Chain 1 (first) entity ID < Chain 2 (first) entity ID. A sort chains by database order ascending comparer. Compare two Chains by perimeter (length) - descending. The first Chain to compare. The second Chain to compare. 0 if equal, 1 if Chain 1 length < Chain 2 length, -1 if Chain 1 length > Chain 2 length. A sort chains by perimeter descending comparer. Compare two Chains by perimeter (length) - ascending. The first Chain to compare. The second Chain to compare. 0 if equal, 1 if Chain 1 length > Chain 2 length, -1 if Chain 1 length < Chain 2 length. A sort chains by perimeter ascending comparer. Compare two Chains by area - descending. The first Chain to compare. The second Chain to compare. 0 if equal, 1 if Chain 1 area > Chain 2 area, -1 if Chain 1 area < Chain 2 area. A sort chains by area descending comparer. Compare two Chains by area - ascending. The first Chain to compare. The second Chain to compare. 0 if equal, 1 if Chain 1 area > Chain 2 area, -1 if Chain 1 area < Chain 2 area. A sort chains by area ascending comparer. Gets the identifier of the first entity in this Chain. Gets a value indicating if the Chain contains any Spline(s). Gets the view of this chain. Gets the perimeter (length) of this chain. Gets the number of 'curves' (entities) in the this chain. Gets the depth below (or above) the Z plane of this chain. Gets a value indicating whether the chain is flat. Gets a value indicating whether the chain is a closed chain. Gets the area within the chain, assuming it's closed. Gets or sets the direction of the chain. Offset the 3D Chain (contour). The The offset distance. The mode. The Z depth. The depth mode; true=Incremental or false=Absolute. The linearization tolerance. Use infinite look ahead?. The "offset" Chain, else null if failed. Offset the 2D Chain (contour). The The offset distance. The mode. The Z depth. The depth mode; true=Incremental or false=Absolute. The linearization tolerance. Use infinite look ahead?. The "offset" Chain, else null if failed. Offset the 2D Chain (contour). The The offset distance. The mode. The Z depth. The depth mode; true=Incremental or false=Absolute. The linearization tolerance. Use infinite look ahead?. Used color Target level. The "offset" Chain, else null if failed. The Mastercam chain type data being used in this chain object. Initializes a new instance of the Chain class. The Mastercam type constructor. This constructor takes a pointer to a Mastercam chain and creates a chain object from it. The pointer to the Mastercam chain to base the chain object off of. This is the database ID of the first 'curve' entity in the chain object. This flag indicates if the Chain contains any Spline(s). This is the view of the chain, as calculated upon creation of the chain object. This is the perimeter (length) of the chain, as calculated upon creation of the chain object. This is the Z-Depth of the chain object as calculated upon creation of the chain object. This indicates whether or not the chain is flat as calculated upon creation of the chain object. This is the area of the chain, as calculated upon creation of the chain object. This is the saved chain direction data. It's kept internally so that we don't have to constantly re-access the GetDirection method. Note that the direction value should only ever be updated when the associated property's set is called and when the chain object is first created. Gets the database ID of the first entity in chain. The id of first entity in chain. Calculates the is Chain is 3D. The view the Chain is in. [out] Is the CHain 3D?. [out] Does the Chain contains any Splines? true if it succeeds, false if it fails. Calculates the area and perimeter of the Chain. The view the Chain is in. [out] The area enclosed by the Chain. [out] The perimeter (length). true if it succeeds, false if it fails. Convert a Geometry Type to an Entity. [in] The Geometry Type data (2D line or 2D arc). The view number of the new entity. The Z depth of the new entity. [out] The new entity (3D line or 3D arc). Save off the entities in the offset boundary. The pock_bound to process. The Z depth of the new Chain. The new operation id number. Calculate the offset contour depth. The Z depth of the chain. The Z offset to be applied. True = the Z depth is incremental, else it's absolute. The (possibly) new Z depth. Performs a 3D 'offset contour' operation. The chain being offset. The offset side ('L' or 'R'). The number of copies. The radius. The roll around corner mode (1 = none, 2 = sharp, 3 = all). The offset z coordinate. true for incremental z coordinate. The linearization tolerance. Use infinite look ahead? [out] The new "offset" chain. True if the offset succeeded, else false. Performs a 2D 'offset contour' operation. The chain being offset. The offset side ('L' or 'R'). The number of copies. The radius. The roll around corner mode (1 = none, 2 = sharp, 3 = all). The offset z coordinate. true for incremental z coordinate. The linearization tolerance. Use infinite look ahead? [out] The new "offset" chain. Used color. Target level. True if the offset succeeded, else false. This method breaks a contour into individual lines. The name and path of the boundary data file to use. The data of the chain being broken. The chaining tolerance to use during the breaking process. [out] The number of points being output by the breaking process. True if the contour was broken successfully, else false if not. This method returns the direction of the specified chain object. The direction of the chain object. The Chain class is used for passing and modifying Mastercam chains between operations. Note that Chain objects cannot be user created via a constructor. See the class for information about creating chains. This method loads this object's rotary axis values from the operation data member passed in. [in,out] The operation data member to load it's rotary axis values from. This method loads this object's coolant settings from the operation data member passed in. [in,out] The operation data member to load it's coolant settings from. This method loads this object's misc values from the operation data member passed in. [in,out] The operation data member to load it's misc values from. This method load this object's reference point settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with reference point settings. This method load this object's home position settings from the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with home position settings. This method loads this object's linking parameters from the operation data member passed in. [in,out] The operation data member to load it's linking parameters from. This method saves this object's 'rotary axis' settings to the operation data member passed in. Mastercam X7. The operation data member to load with rotary settings. This method saves this object's 'coolant' settings to the operation data member passed in. Mastercam X7. The operation data member to load with coolant settings. This method saves this object's 'misc values' settings to the operation data member passed in. Mastercam X7. The operation data member to load with misc values settings. This method saves this object's 'reference point' settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with reference point settings. This method saves this object's 'home position' settings to the operation data member passed in. Mastercam X7 [in,out] The operation data member to load with home position settings. This method saves this object's 'linking parameters' settings to the operation data member passed in. Mastercam X7. The operation data member to load with linking parameters settings. The tool in the operation. true if the operation is considered 'dirty'. Gets or sets the operation's output NCI name. When setting the name, do not specify a path! If the name being set fails these checks, the name will not be changed. The name must be a file name with no path characters. (i.e. ':', '\', '\\') And these additional characters are not allowed. '/', '"', '*', '<', '>', '|', '?' Gets or sets a value indicating whether to display the toolpath. The operation must already exist in the Toolpath Manager. You do not need to .Commit() the operation after setting this option! The operation will be automatically updated if the on/off state of this option is changed. True if display toolpath, false if not. Gets the database Time Stamp for this operation. The operation must have already been committed to Mastercam's database for this to be valid! If not, the DateTime returned is the "dawn of time" for a .NET DateTime - (midnight), January 1, 0001 You can check for this by comparing the TimeStamp to .NET DateTime.MinValue Gets or sets the Rotary Axis settings used in this operation. Mastercam X7 Gets or sets a value indicating whether this operation uses "old-style coolant" (from post processor). A .Commit() of the Operation must have been already been done for this to be valid! Gets or sets the Coolant settings used in this operation. Mastercam X7 The Misc Values settings used in this operation. Mastercam X7 Gets or sets the Reference Points in this operation. Mastercam X7 Gets or sets the Home Position settings used in this operation. Mastercam X7 Gets or sets the Linking Parameters settings used in this operation. Mastercam X7 Gets a value indicating the 'dirty' status of the operation in the Operations Manager, which indicates whether or not the operation needs to be regenerated. Gets or sets a value indicating whether or not this operation is using a specified WCS object. Gets or sets the WCS of this operation object. Gets or sets a value indicating whether or not this operation is to use the construction plane. Gets or sets the construction plane this operation is set to work in. Gets or sets a value indicating whether or not this operation is to use the tool plane. The tool plane this operation is set to work in. Gets or sets the Tool object to be used with this operation. Gets or sets the operation's Program Number. Gets or sets the operation's name (comment). Gets or sets a value indicating this operation's 'selected' status in the Operation Manager. Gets or sets a value indicating if posting is currently enabled for this operation. Gets or sets a value indicating if tool display is on or off for this operation. Gets or sets a value indicating if the operation is locked or not. Gets or sets a value indicating whether or not the operation is to be output to a batch. Gets or sets a value indicating if this operation is set to force tool changes or not. Gets or sets the retract rate for this operation's tool. Gets or sets the plunge rate for this operation's tool. Gets or sets the feed rate for this operation's tool. Gets or sets the spindle speed for this operation's tool. Gets or sets the diameter offset value of this operation. Gets or sets the length offset value of this operation. Gets or sets the group number identifying which Mastercam group this operation belongs to. This operation's type. Loads the default values for a given operation object. Calculates the cycle time of the operation Note that this assumes the operation is not in a 'dirty' state! This does not regenerate the operation if it is 'dirty', and the time returned will be 0.0 The time (in seconds) that's returned in the "raw" time of the operations. Any additional time (for tool changes, etc.) would need to be added to this if desired. You can use the functionality in the .NET Framework's TimeSpan to format the time as desired. See the related CalcCycleTime functionality in the OperationsManager class. The calculated cycle time (in seconds). Sets the 'selected' state of the operation without the need to call a .Commit() on the operation True to set as selected, false to mark as unselected. True if it succeeds, false if it fails (the operation was not found in Mastercam's database). Gets the maximum Z coordinate (from the binary NCI) of the operation's toolpath. If this fails, which will occur if the operation's toolpath is 'dirty'. The value returned will be the maximum value allowed in a Double. (Double::MaxValue) The maximum z coordinate. Gets the minimum Z coordinate (from the binary NCI) of the operation's toolpath. If this fails, which will occur if the operation's toolpath is 'dirty'. The value returned will be the minimum value allowed in a Double. (Double::MinValue) The minimum z coordinate. Gets the maximum and minimum Z coordinates (from the binary NCI) of the operation's toolpath. If this fails, which will occur if the operation's toolpath is 'dirty'. The values returned will be the maximum and minimum values allowed in a Double. (Double::MaxValue and Double::MinValue) [out] The maximum Z coordinate. [out] The minimum Z coordinate. true if it succeeds, false if it fails. Mark's the operation object as 'dirty' in the Operations Manager, indicating that it needs to be regenerated. Assign mill tool to operation by slot number. The slot number. true if it succeeds, false if it fails. Gets the unique database identifier for the current Mastercam operation. The operation identifier. Posts the current operation object. The path to output the NC file to upon completion of the posting process. This flag indicates whether the NC file is to be opened by the default editor after the posting process is complete. This flag dictates whether or not an NCI file is created for the operation during the posting process. This flag indicates whether the NCI file is to be opened by the default editor after the posting process is complete. True if the operation was successfully posted, else false if not. Posts the current operation object. Note that this method will disallow the editing of the NCI upon posting. The path to output the NC file to upon completion of the posting process. This flag indicates whether the NC file is to be opened by the default editor after the posting process is complete. This flag dictates whether or not an NCI file is created for the operation during the posting process. True if the operation was successfully posted, else false if not. Posts the current operation object. Note that this method will not create an associated NCI file by default. The path to output the NC file to upon completion of the posting process. This flag indicates whether the NC file is to be opened by the default editor after the posting process is complete. True if the operation was successfully posted, else false if not. Posts the current operation object. The path to output the NC file to upon completion of the posting process. True if the operation was successfully posted, else false if not. Note that this method will not create an associated NCI file and will disallow the editing of the subsequent NC file by default. Posts the current operation object. True if the operation was successfully posted, else false if not. Note that this method will post to the default posting directory, will not create an associated NCI file, and will disallow the editing of the subsequent NC file by default. Regenerates the current operation object. True if the operation was successfully regenerated, else false if not. Displays either the Edit Drill Points or the Edit Chains dialog to the user in order to edit this operation object's geometry. True if the operation geometry was successfully updated, else false if not. Displays the Edit Operation dialog to the user in order to edit this operation object. True if the operation was successfully updated, else false if not. Updates the current operation object with any changes that have been made to the version in the Mastercam database. True if the operation was successfully updated, else false if not. Deletes the current operation object from the Mastercam database. True if the operation was successfully deleted from the Mastercam database and false if not. Note that once the operation object has been deleted from the Mastercam database it will still exist locally, and can be re-committed at a later time. This exception will be thrown if the object being deleted is already marked as an Invalid, indicating that it doesn't exist in the Mastercam database anyway. Thrown if for some reason this object is supposed to be valid but the entity is no longer in the Mastercam database. Thrown if Mastercam is unable to write the entity changes to the database for some reason. Validates whether or not the current operation object is a valid Mastercam database entry yet. True if the operation is already in the Mastercam database, else false if not. Takes the current operation object and commits it to the Mastercam database. true to include, false to exclude the geometry. True if the operation was successfully committed, else false if not. Thrown if for some reason this object is supposed to be valid but the entity is no longer in the Mastercam database. Thrown if Mastercam is unable to write the entity changes to the database for some reason. Takes the current operation object and commits it to the Mastercam database. True if the operation was successfully committed, else false if not. Thrown if for some reason this object is supposed to be valid but the entity is no longer in the Mastercam database. Thrown if Mastercam is unable to write the entity changes to the database for some reason. Initializes a new instance of the abstract class. All members are given default values. Sets the coolant data. Index of the data item. The coolant (On/Off) state. The coolant (Before/With/After) position data. Calculate the X-style coolant value to be used in the operation's canned text. Index of the Coolant type. The Coolant item index. A value to be place into the canned text array. Updates the tool in operation described by Operation. [in,out] The operation. true if it succeeds, false if it fails. Initializes a Mastercam operation structure with default values. [out] The operation structure to be initialized. Loads the default values for a given operation object from the operation structure passed in. The operation structure to use as defaults for this operation object. Retrieves an operation structure from the Mastercam database. [out] The operation structure to be retrieved. True if the operation structure was retrieved from the database successfully, false if not. Deletes an operation structure from the Mastercam database. The operation structure to be deleted. True if the operation structure was deleted from the database successfully, false if not. Validates that a given operation structure is already in the Mastercam database. The operation structure to be validated. True if the operation structure is already in the database, false if not. Commits an operation structure to the Mastercam database. The operation structure to be committed. True if the commit was successful, false if not. ID Lookup Constructor. Attempts to retrieve an operation entity with the given ID from the Mastercam database and use that to initialize this operation object. If no matching operation entity is found in the Mastercam database, the object is initialized to default values. The ID of the operation entity to look up in the Mastercam database. The NCI "name" of the operation. Updates a Mastercam op_view structure from a Mastercam view_ent structure. Information describing the operation view. Information describing the view. Runs the chain manager dialog for the given operation. Type of the operation. True if the chain manager dialog returned a successful completion value, false if not. Runs the drill point manager dialog for the given operation. True if the drill point manager dialog returned a successful completion value, false if not. This class is used for modifying and creating toolpath operations in Mastercam. Gets the Common Tool Plane Origin (in view). Gets the ID of the Common Tool Plane. Gets the Common WCS Origin (in view). Gets the ID of the Common WCS Plane. Gets the Tool Plane Maximum Point. Gets the Tool Plane Minimum Point. Gets the WCS Maximum Point. Gets the WCS Minimum Point. Gets the World Maximum Point. Gets the World Minimum Point. Gets a flag indicating if the calculated min/max travel data is "valid". Gets a flag indicating if the data is "valid" - Was an operation with the supplied ID found? Gets or sets the "old" style (Flood/Mist/Thru-Tool) coolant setting. NOTE! This is only valid if is true. Gets or sets a list of the coolant 'position' settings (Before/With/After). NOTE! This is only valid if is NOT true. Gets or sets a list of the coolant 'state' settings (On/Off/Ignore). NOTE! This is only valid if is NOT true. Gets or sets a value indicating the state of the Machine Definition 'Coolant Mode' option. If true, the "Support coolant using value in post processor" is checked, else false. If true, the active coolant mode is the "old style" - see CoolantMode. If false the active coolant mode is the "new style" - see CoolantParams. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. Initializes a new instance of the CoolantParams class. The state to initialize all coolants to. The position settings to initialize all coolants to. Initializes a new instance of the CoolantParams class. All states are initialized to CoolantStateType::Ignore All positions are initialized to CoolantPositionType::Before This class represents the data needed for Coolant in an operation. The list of Coolant (Before/With/After) Positions. Gets or sets the individual coolant Before/With/After position "by CoolantType name". Gets or sets the individual coolant Before/With/After position "by index". There are 10 coolant position "slots" in the zero-based array. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. Initializes a new instance of the CoolantState class. The position to initialize the coolants to. Initializes a new instance of the CoolantPosition class. All positions are initialized to CoolantPositionType::Before This class represents the data needed for the Before/With/After position of the coolant in an operation. The list of Coolant (On/Off/Ignore) States. Gets or sets an individual coolant On/Off/Ignore state "by CoolantType name". Gets or sets an individual coolant On/Off/Ignore state "by index". There are 10 coolant state "slots" in the zero-based array. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. Initializes a new instance of the CoolantState class. The state to initialize the coolants to. Initializes a new instance of the CoolantState class. All states are initialized to CoolantStateType::Ignore This class represents the data needed for the On/Off/Ignore state of the coolant in an operation. Coolant indices used to define coolant within canned text An enumeration that specifies the different Coolant "positions". Coolant Position - After Coolant Position - With Coolant Position - Before An enumeration that specifies the different Coolant "states". Coolant State - Ignore Coolant State - Off Coolant State - On An enumeration that specifies the (10) different Coolant "types". The 10th of 10 possible coolants. The 9th of 10 possible coolants. The 8th of 10 possible coolants. The 7th of 10 possible coolants. The 6th of 10 possible coolants. The 5th of 10 possible coolants. The 4th of 10 possible coolants. The 3rd of 10 possible coolants. (usually "Tool') The 2nd of 10 possible coolants. (usually 'Mist') The 1st of 10 possible coolants. (usually 'Flood') Gets or sets the unroll tolerance. Gets or set a value indicating whether the UnRroll option is enabled. Gets the zero angle for the Rotary Axis. Gets or sets the axis being substituted. Gets or set the Rotary Axis direction: (CCW or CW). Gets or sets the Rotary Axis diameter. Gets or sets the Rotary Axis. Gets or sets the type of RotaryAxis. Gets or sets a value indicating whether Rotary is enabled. This is an 'internal' setting that does not appear on the dialogs! Its setting is based on the RotaryAxis.Type value. If Type != RotaryAxisPositionType.None, then Enabled = true, else it is false. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. Drill Cycle operation custom parameter values. An enumeration that specifies the Rotary Axis Substitution "rotate ? axis" option. Rotary axis substitution of the Y axis. Rotary axis substitution of the X axis. An enumeration that specifies the Rotary Axis direction. Rotation direction = CW. Rotation direction = CCW. An enumeration that specifies the Rotary Axis "rotate about ? axis" options. Rotation about the Z axis. Rotation about the Y axis. Rotation about the X axis. An enumeration that specifies the different Rotary Axis rotation types. Rotary axis - 3 axis. Rotary axis positioning. Rotary axis substitution. No rotary axis. An enumeration that specifies the different rules for how an NC file name is found and created. Use an entirely user-defined NC file name. Use the same name for the NC file that was used in the last modified operation. Use the name of the current toolpath group as the name of the NC file. Use the current machine's name as the name of the NC file. Use the existing current part file's name as the name of the NC file. An enumeration that specifies the different rules for how an NC file name is found and created. Use the roughing tool diameter to compute the remaining stock. Use only the previous operation to compute the remaining stock. Use all previous operations to compute the remaining stock. Gets or sets the Spindle speed (override) value. Gets or sets the Feed rate (override) value. Gets or sets a value indicating the on/off state of the Override 'Spindle speed' option. Gets or sets a value indicating the on/off state of the Override 'Feed rate' option. Gets or sets the Finish - Number of Spring Passes value. Thread Mill operation. Gets or sets the Finish - Step Over Spacing value. Gets or sets the Finish - Number of Passes value. Gets or sets the Rough - Step Over Spacing value. Gets or sets the Rough - Number of Passes value. Gets or sets a value indicating the on/off state of the Multi Pass options. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the Multi Passes specific parameters. Gets or sets the (10) Misc. Reals. Gets or sets the (10) Misc. Integers. Gets or sets a value indicating the whether to use the values defined in the active Post Processor. If true, then the integers/reals on the Misc Values page are disabled. true if use values from post, false if not. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. Initializes a new instance of the MiscValuesParams class. The MiscValuesParams to initialize the new object with. Initializes a new instance of the MiscValuesParams class. This class represents the data needed for the Misc. Values in an operation. The list of Misc. Real values. Gets or sets the individual Misc. Real values. There are 10 values in the array, accessed as usual - zero-based. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. Initializes a new instance of the MiscReals class. This class represents the data needed for the Misc Reals in an operation. The list of Misc. Integer values. Gets or sets the individual Misc. Integer values. There are 10 values in the array, accessed as usual - zero-based. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. Initializes a new instance of the MiscIntegers class. This class represents the data needed for the Misc Integers in an operation. Gets or sets a value indicating the on/off state of the 'Shift Points Randomly' option. Gets or sets a value indicating the on/off state of the 'Minimize number of points' option. Gets or sets a value indicating the on/off state of the 'Present arcs as line segments' option. Gets or sets the Segment Length value. Gets or sets a value indicating the on/off state of the 'Use fixed segment length' option. Gets or sets a value indicating the on/off state of the 'Smoothing Settings' option. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for Arc Filter Smoothing in an operation. Gets or sets the Tolerance factor. Only used if ReduceToleranceType is = 1 or 2 Gets or sets a value indicating selected Tolerance type. Gets or sets a value indicating the on/off state of the 'One way filtering' option. Gets or sets a value indicating the on/off state of the 'Create Arcs in YZ' option. Gets or sets a value indicating the on/off state of the 'Create Arcs in XZ' option. Gets or sets a value indicating the on/off state of the 'Create Arcs in XY' option. Gets or sets the Maximum Arc Radius value. Gets or sets the Minimum Arc Radius value. Gets or sets a value indicating the on/off state of the 'Line/Arc Filter settings' option. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for using Line/Arc Filtering in an operation. Gets the Total Tolerance value. This is CutTolerance + LineArcTolerance + SmoothingTolerance Gets or sets the Smoothing Tolerance value. Gets or sets the Line/Arc Tolerance value. Gets or sets the Cut Tolerance value. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for using Tolerance Distribution used with Line/Arc Filtering in an operation. An enumeration that specifies the different tolerance rules for line/arc filtering. Tighten Arc Filtering tolerance. Tighten Line Filtering tolerance. Use maximal tolerance value for both: Line and Arc. Gets or sets the "retract" Reference Point data. Gets or sets the "approach" Reference Point data. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for using break through in an operation. Gets or sets the Approach or Retract point coordinates. Gets or sets a value indicating the state of Z axis enabled (checkbox) option for this Reference Point. Gets or sets a value indicating the state of Y axis enabled (checkbox) option for this Reference Point. Gets or sets a value indicating the state of X axis enabled (checkbox) option for this Reference Point. Gets or sets a value indicating the state of the absolute/incremental (checkbox) option for this Reference Point. Gets or sets a value indicating the on/off state of the Approach Reference Point (checkbox). This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for a (approach/retract) reference point in an operation. Gets or sets the Home Position point. Gets or sets a value indicating the on/off state of the Home Position. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for using bHome Positions in an operation. Gets or sets the distance below the bottom of the stock to break through. Gets or sets a value indicating the on/off state of the BreakThrough option (checkbox). This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for using break through in an operation. Gets or sets the amount of stock to leave on floors. Gets or sets the amount of stock to leave on walls. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for stock to leave (walls/floors) in an operation. Many operation have these common settings parameter settings. Gets or sets the 'Adjust end of contour' settings. Contour operation. Gets or sets the 'Adjust start of contour' settings. Contour operation. Gets or sets a value indicating if Gouge Check is enabled. Contour operation. Gets or sets a value indicating the 'Enter/Exit at midpoint in closed contours' option is enabled. Contour operation. Gets or sets the Exit settings of the Lead In/Out settings. Gets or sets the Entry settings of the Lead In/Out settings. Gets or sets a value indicating if the Lead In/Out parameters page is enabled. Gets or sets the Overlap distance. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to set up the Lead-In/Out on a Mastercam X7 Gets or sets a value indicating (depending on Entry or Exit settings) whether to - Entry settings = Plunge after first move. Exit settings = Retract before last move. Gets or sets the 'override' feedrate value. Gets or sets a value indicating whether the 'Override feed rate' option is enabled. Gets or sets a value indicating whether to 'Enter on first' or 'Exit on last' Only. Entry settings = Enter on first depth cut only. Exit settings = Exit on last depth cut only. Gets or sets a value indicating whether the 'Use point depth' option is enabled. Gets or sets a value indicating whether the 'Use Entry/Exit Point' option is enabled. Gets or sets a value indicating whether this option is enabled: Enter on first depth cut only. Exit on last depth cut only. Gets the Helix height. Gets or sets the arc sweep angle. Gets or set the entry/exit arc radius. Gets or sets the ramp height. Gets or sets the length of the entry/exit line. Gets or sets a value indicating the state of the Perpendicular/Tangent option. true = Perpendicular is enabled, else false = Tangent Gets or sets a value indicating if the Lead In/Out options are enabled. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to set up the Entry/Exit settings for a Contour or Pocket operation. Mastercam X7 Gets or sets the length of the contour extend/shorten. Gets or sets a value indicating if the contour should be extended or shortened. true = Extend, else false = Shorten Gets or sets a value indicating if Adjust Start/End of Contour is enabled. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed to set up the Entry/Exit on a Pocket operation. Mastercam X7 Gets or sets a value indicating the state of 'incremental' subprograms option. true = incremental, else false = absolute subprograms. Gets or sets a value indicating the state of 'subprograms' will be used option. Gets or sets a value indicating the state of the 'keep tool down' option. Gets or sets the finishing step value to use. Gets or sets the number of finishing cuts to make. Gets or sets the maximum roughing step value to use. Gets or sets a value indicating the state of the 'Depth Cuts enabled' option. (true/false). Enable/disable the entire 'Depth Cuts' page. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for depth cuts in an operation. SlotMill, CircleMill and Facing toolpaths have common parameter settings. Gets or sets a value that indicates what to do if the helical entry fails. If true, then a plunge, else skip the entry is skipped altogether. Gets or sets the maximum tolerance uses if arc moves are not output by the operation. Gets or sets a value indicating the state of the 'Output arc moves' option. Gets or sets the helical entry's plunge angle. Gets or sets the Z clearance to be used in the helical entry. Gets or sets the XY clearance to be used in the helical entry. Gets or sets the maximum radius to be used in the helical entry. Gets or sets the minimum radius to be used in the helical entry. Gets or sets a value indicating the state of the 'Helical Entry enabled' option. (true/false). Enable/disable the entire Helical Entry (group). This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for the helical entry option used in toolpath roughing. Gets or sets a value indicating the Cutter Compensation 'tip comp' setting (Tip or Center) to be used in the operation. true if component to tip, false if not. Gets or sets a value indicating the Cutter Compensation 'optimize comp in control' setting (Tip or Center) to be used in the operation. This is only valid when Comp in COntrols is active. true if optimize is on, else false if not. Gets or sets a value indicating the Cutter Compensation 'roll around corners' setting (None, Sharp, All) to be used in the operation. The component roll. Gets or sets a value indicating the direction (side) of the Cutter Compensation (Right, Left, Auto) to be used in the operation. The component direction. Gets or sets a value indicating the type of Cutter Compensation (Computer, Control, Wear, Reverse Wear) to be used in the operation. The type of the component. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for the helical entry option used in toolpath roughing. Gets or sets a value indicating if rapid retract is on. Gets the depth associative point. To remove this associative point, set this to null. If DepthAssociative is false, or an associated Retract point has not been set, this could be a NULL value. Be sure to check for that before accessing the value returned! Gets or sets a value indicating if the depth plane is associative or not. Gets or sets a value indicating if depth is to be used incrementally or not. Gets or sets the top of stock associative point. To remove this associative point, set this to null. If TopStockAssociative is false, or an associated Retract point has not been set, this could be a NULL value. Be sure to check for that before accessing the value returned! Gets or sets a value indicating if the top of stock is associative or not. Gets or sets a value indicating if the top of stock is to be used incrementally or not. Gets or sets the feed plane associative point. To remove this associative point, set this to null. If FeedPlaneAssociative is false, or an associated Retract point has not been set, this could be a NULL value. Be sure to check for that before accessing the value returned! Gets or sets a value indicating if the feed plane is associative or not. Gets or sets a value indicating if the feed plane is to be used incrementally or not. Gets or sets the retract associative point. To remove this associative point, set this to null. If RetractAssociative is false, or an associated Retract point has not been set, this could be a NULL value. Be sure to check for that before accessing the value returned! Gets or sets a value indicating if the retract is associative or not. Gets or sets a value indicating if retract is to be used incrementally or not. Gets or sets a value indicating if retract is on or not. Gets or sets the clearance associative point. To remove this associative point, set this to null. If ClearanceAssociative is false, or an associated Retract point has not been set, this could be a NULL value. Be sure to check for that before accessing the value returned! Gets or sets a value indicating if the clearance is associative or not. Gets or sets a value indicating if clearance is to be used incrementally or not. Gets or sets a value indicating whether or not clearance is only used on at the start and end of this operation. Gets or sets a value indicating whether or not clearance is turned on in this operation. The depth value for this operation. Gets or sets the top of stock height for this operation. Gets or sets the feed plane height for this operation. Gets or sets the retract height for this operation. Gets or sets the clearance value for this operation. This is a static inequality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this object to another one. This is the object to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing two objects. This is the first object to compare. This is the second object to compare. True if the two objects are considered equal. This class represents the data needed for the Linking Parameters in an operation. Initializes a new instance of the AssociativePoint class. This method is for internal use by the NET-Hook API. The database ID of the geometry entity. The Point Entry Code. The point position coordinates. nullptr if it fails, else the new associative point. This class is for internal use by the NET-Hook API for creating Associative Points. Gets the database ID of the associative entity. If this ID is 0, the Associative Point is NOT valid. Gets the point position coordinates. Gets the type of the point entry code. Gets the referenced entity of the associative point. This may be a null value, so be sure to check for that before accessing the value returned! Initializes a new instance of the AssociativePoint class. The geometry entity. The Point Entry Code. The point position coordinates. Initializes a new instance of the AssociativePoint class. The Point geometry entity. Values that represent linking associative point types. A point representing the second endpoint of a geometry entity. A point representing the first endpoint of a geometry entity. An arc center point. An entity. A quadrant point on an arc or circle. A point entity. The midpoint of a line or arc entity. An endpoint. A center point. No specific point type. Values that represent Point Entry Codes. This class is used for creating and querying Associative Points used in operation linking parameters. Convert this object into a string representation. A text string that represents this object. Gets or sets the 3D point data associated with this PointGeometry object. Initializes a new instance of the PointGeometry class. You must the PointGeometry object for it to be created in Mastercam's geometry database. The x coordinate value of the point geometry being created. The y coordinate value of the point geometry being created. The z coordinate value of the point geometry being created. Initializes a new instance of the PointGeometry class. You must the PointGeometry object for it to be created in Mastercam's geometry database. The 3D point coordinate data to create the point geometry with. Initializes a new instance of the PointGeometry class. Creates a new point geometry object with a default location of (0,0,0). You must the PointGeometry object for it to be created in Mastercam's geometry database. LoadDefaults (Override). [in,out] The entity to load the object's default values from. Commit (Override). [in,out] The entity that will hold all the data being sent to the Mastercam database. true if it succeeds, false if it fails. Initializes a new instance of the PointGeometry class. Creates a new object from the ID of an entity in the Mastercam database. The ID of the Mastercam entity to create the new object from. Provides a mechanism for creating, editing, and deleting point geometry within Mastercam. Converts this object into a string representation. A text string that represents this object. Gets the second endpoint of this ArcGeometry object. Gets or sets the first endpoint of this ArcGeometry object. Gets the 3D arc data associated with this ArcGeometry object. The view number of this ArcGeometry object. The view number. The view of this ArcGeometry object. Initializes a new instance of the ArcGeometry class (Arc by 3 points). You must the ArcGeometry object for it to be created in Mastercam's geometry database. The first point. The second point. The third point. Initializes a new instance of the ArcGeometry class. You must the ArcGeometry object for it to be created in Mastercam's geometry database. The view to create this arc geometry in. The value of the center point of the arc geometry to be constructed. The radius of the arc geometry being created. The angle in degrees, from the origin, from which the arc starts. The angle in degrees, from the origin, from which the arc ends. Initializes a new instance of the ArcGeometry class. You must the ArcGeometry object for it to be created in Mastercam's geometry database The view number to create this arc geometry in. If the supplied View Number does identify a "valid" defined view, the view used will default to the active construction plane. The value of the center point of the arc geometry to be constructed. The radius of the arc geometry being created. The angle in degrees, from the origin, from which the arc starts. The angle in degrees, from the origin, from which the arc ends. Initializes a new instance of the ArcGeometry class. Creates a new ArcGeometry object based off of the values in the specified arc math object. You must the ArceGeometry object for it to be created in Mastercam's geometry database. The 3D arc data to create this ArcGeometry object with. Initializes a new instance of the ArcGeometry class. Creates new arc geometry with default values - A radius of 1.0, a start angle of 0.0, an end angle of 360.0, a center point at the origin (0.0, 0.0, 0.0) and in the current construction view. You must the ArcGeometry object for it to be created in Mastercam's geometry database. The view of this arc geometry object stored in the database. The internal view number of this arc geometry object stored in the database. LoadDefaults (Override). This handles the loading of defaults from a Mastercam entity. [in,out] The entity to load the object's default values from. Commit (Override). This handles the committing of the object's data to the Mastercam database. [in,out] The entity that will hold all the data being sent to the Mastercam database. true if it succeeds, false if it fails. Initializes a new instance of the ArcGeometry class. Creates a new object from the ID of an entity in the Mastercam database. The ID of the Mastercam entity to create the new object from. This class provides methods for creating, editing, and otherwise working with arc geometry within Mastercam. The second endpoint in the given curve geometry object. The first endpoint in the given curve geometry object. Default Constructor. All members are given default values. Initializes a new instance of the abstract class. Mastercam Database Constructor. Creates a new object from the ID of an entity in the Mastercam database. The ID of the Mastercam entity to create the new object from. This class handles the interaction between the NET-Hook and Mastercam for complex curve geometry objects. Gets or sets the point style attribute of the current geometry object. Gets or sets the pen style value of the current geometry object. Gets or sets the line style attribute of the current geometry object. Gets or sets the line width value (1-5) of the current geometry object. Even though this is floating point value, only the integer part is used. Gets or sets the level the current geometry object is on. Gets or sets the color value (0-255) of the geometry object. True if the current geometry object has been marked as blanked, else false if not. Note that should you change the Blanked flag on an existing Geometry object and re-commit it, you may have to fully regenerate the graphics view in order to see the changed setting take effect. See GraphicsManager.Repaint() for details. True if the current geometry object is selected, else false if not. Retrieves an entity by it entity ID#. This is intended for use with add-in projects that utilize an interop (C++/CLR) component. Identifier for the entity. A Geometry object if successful, else null if not. Gets the unique database identifier for the entity. The identifier. Updates the current geometry entity object with any changes that have been made to the version in the Mastercam database. True if the entity was successfully updated, else false if not. Validates whether or not the current geometry entity object is a valid Mastercam database entry yet. True if the entity is already in the Mastercam database, else false if not. Deletes the geometry entity object from the Mastercam database. It does not delete any referenced items associated to this geometry entity. See the method override that allows for handling associated items if needed. Note that once the entity object has been deleted from the Mastercam database it will still exist locally, and can be re-committed at a later time. True if the entity was successfully deleted from the Mastercam database and false if not. This exception will be thrown if the object being deleted is already marked as an Invalid, indicating that it doesn't exist in the Mastercam database anyway. Thrown if for some reason this geometry object is supposed to be valid but the geometry is no longer in the Mastercam database. Deletes the geometry entity object from the Mastercam database and optionally any referenced items associated to this geometry entity. If this entity is referenced by a Toolpath, Solid, and/or Plane, those "associated" items will be permanently altered. Note that once the entity object has been deleted from the Mastercam database it will still exist locally, and can be re-committed at a later time. This exception will be thrown if the object being deleted is already marked as an Invalid, indicating that it doesn't exist in the Mastercam database anyway. Thrown if for some reason this geometry object is supposed to be valid but the geometry is no longer in the Mastercam database. true to also delete any referenced items. True if the entity was successfully deleted from the Mastercam database and false if not. Takes the current geometry entity object and commits it to the Mastercam database. True if the entity was successfully committed, else false if not. Thrown if for some reason this geometry object is supposed to be valid but the geometry is no longer in the Mastercam database. Thrown if Mastercam is unable to write the geometry entity to the database for some reason. Copies the current geometry object and then performs a scaling transform on the new geometry. The point of origin for the scaling transformation. The scale factor. The newly copied and scaled geometry object. Performs a scaling transform on the geometry object. The point of origin for the scaling transformation. The scale factor. true if it succeeds, false if it fails. Copies the current geometry object and then performs a non-uniform scaling transform on the new geometry. The point of origin for the scaling transformation. The scale factors (0.5 = 50%) The newly copied and scaled geometry object. Performs a non-uniform scaling transform on the geometry object. The point of origin for the scaling transformation. The scale factors (0.5 = 50%) true if it succeeds, false if it fails. Copies the current geometry object and then performs a rotation transform on the new geometry. The point of origin for the rotation transformation. The rotation angle. The View the rotation transform is to take place in. The newly copied and rotated geometry object. Performs a rotation transform on the geometry object. The point of origin for the rotation transformation. The rotation angle. The View the rotation transform is to take place in. True if the rotation was completed successfully. else false if not. Copies the current geometry object and then performs a mirror transform on the new geometry. The line that defines the axis geometry is to be mirrored over. The View the mirroring transform is to take place in. The newly copied and mirrored geometry object. Performs a mirror transform on the current geometry object. The line that defined the axis the geometry is to be mirrored over. The View the mirroring transform is to take place in. True if the mirror was completed successfully. else false if not. Copies the current geometry object and then performs a translation transform on the new geometry. Note that with this method, the current geometry object will not be modified. The starting point of the translation. The ending point of the translation. The View the translation starts in. The View the translation is to end in. The newly copied and translated geometry object. Performs a translation transform on the current geometry object. The starting point of the translation. The ending point of the translation. The View the translation starts in. The View the translation is to end in. True if the translation was completed successfully. else false if not. Performs a scaling transform on the current geometry object. The point of origin for the scaling transformation. The scale factor. true to do make the result a copy, else do a move. The newly copied (if Copy is true) and rotated geometry object . Performs a non-uniform scaling transform on the current geometry object. The point of origin for the scaling transformation. The scale factors (0.5 = 50%) true to do make the result a copy, else do a move. The newly copied (if Copy is true) and rotated geometry object . Performs a rotation transform on the current geometry object. The point of origin for the rotation transformation. The rotation angle. The View the mirroring transform is to take place in. true to do make the result a copy, else do a move. The newly copied (if Copy is true) and rotated geometry object . Performs a mirror transform on the current geometry object. The line that defines the axis geometry is to be mirrored over. The View the mirroring transform is to take place in. true to do make the result a copy, else do a move. [out] The result (true if successful, else false if errors occurred). The newly copied (if Copy is true) and rotated geometry object . Performs a translation transform on the current geometry object. The starting point of the translation. The ending point of the translation. The View the translation starts in. The View the translation is to end in. true to do make the result a copy, else do a move. The newly copied (if Copy is true) and rotated geometry object . Loads the default values for a given geometry object from the geometry entity passed in. [in,out] The geometry entity to use as defaults for this geometry object. Retrieves a geometry entity from the Mastercam database. [in,out] The geometry entity to be retrieved. True if the geometry entity was retrieved from the database successfully; false if not. Validates that a given geometry entity is already in the Mastercam database. The geometry entity to be validated. True if the geometry entity is already in the database; false if not. Deletes a geometry entity from the Mastercam database. The geometry entity to be deleted. True to include associated items (Toolpath, Solid and/or Plane). True if the geometry entity was deleted from the database successfully, false if not. Commits a geometry entity to the Mastercam database. The geometry entity to be committed. True if the commit was successful, false if not. Initializes a new instance of the abstract class. Attempts to retrieve a geometry entity with the given ID from the Mastercam database and use that to initialize this geometry object. If no matching geometry entity is found in the Mastercam database, the object is initialized to default values. The ID of the geometry entity to look up in the Mastercam database. Initializes a new instance of the abstract Geometry class. All members are given default values. Loads the default values for a given geometry object. This class handles all of the interaction for Geometry objects within Mastercam. This is a static inequality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first line to compare. This is the second line to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first line to compare. This is the second line to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this math object to another one. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the line to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first line to compare. This is the second line to compare. True if the two objects are considered equal. Gets or sets the specified endpoint of this Line3D. This is the bracket operator overload so that the points within this line can be accessed via an array-like interface. The index used within the brackets must be either 0 or 1 to access either the first or the second endpoint. Thrown if an index is passed in that is out of the allowed range. Converts this object into a string representation. A text string that represents this object. Gets or sets the second endpoint of the specified line object. Gets or sets the first endpoint of the specified line object. Initializes a new instance of the Line3D class. This construction method takes two 3D points and constructs a line object from them. The point to become the first endpoint. The point to become the second endpoint. "Converts" this NET-Hook type to the corresponding Mastercam math type. [out] The Mastercam math type. Initializes a new instance of the Line3D class. The Mastercam 3D line geometry data. This class is used as a mathematical representation of a 3D Line. This is a static inequality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first arc to compare. This is the second arc to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first arc to compare. This is the second arc to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this math object to another one. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. [in,out] This is the arc to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first arc to compare. This is the second arc to compare. True if the two objects are considered equal. Converts this object into a string representation. A text string that represents this object. Gets or sets the location of the ending point of this arc, an angle, in degrees, from the (3 O'Clock) base point. Gets or sets the location of the starting point of this arc, an angle, in degrees, from the (3 O'Clock) base point. Gets or sets the radius of this arc. Gets or sets the center point of this arc. Initializes a new instance of the Arc3D class. This takes all of the necessary data to construct this arc object . The center point of the arc to be created. The radius (distance from the center point to the outer edge of the arc) of the arc to be created. The angle in degrees, from the origin, from which the arc starts. The angle in degrees, from the origin, from which the arc ends. "Converts" this NET-Hook type to the corresponding Mastercam math type. [out] The Mastercam math type. Initializes a new instance of the Arc3D class. The arc geometry. This class is used as a mathematical representation of a 3D Arc. The internal view comment data member. The internal view name data member. The internal view work offset number data member. The internal view number data member. The internal view origin data member. The internal view matrix data member. Validates that the view name member is valid. If not, it iterates through names until it finds a valid one. Initializes a Mastercam view structure with default values. The view structure to be initialized. Loads the default values for a given view object from the view structure passed in. The view structure to use as defaults for this view object. Retrieves an view structure from the Mastercam database. The view structure to be retrieved. True if the view structure was retrieved from the database successfully; false if not. Deletes a view structure from the Mastercam database. Note that trying to delete locked system views will fail and return a false return code. The view structure to be deleted. True if the view structure was deleted from the database successfully; false if not. Validates that a given view structure is already in the Mastercam database. The view structure to be validated. True if the view structure is already in the database; false if not. Commits a view structure to the Mastercam database. Note that trying to commit locked system views will fail and return a false return code. The view structure to be committed. True if the commit was successful; false if not. ID Lookup Constructor. Attempts to retrieve a view entity with the given ID from the Mastercam database and use that to initialize this view object. If no matching view entity is found in the Mastercam database, the object is initialized to default values. The ID of the view entity to look up in the Mastercam database. Loads the default values for a given view object. Gets the a value indicating if the view is "in use" by the system and thus cannot be deleted. "In Use" could mean that it is the current CPlane,TPlane, WCS, etc. Gets the a value indicating if the view object is a locked ("reserved") system view. Gets the ID of the view object. To be used in certain API methods that require view IDs. Gets the view number of the current view object. Gets ot sets the comment on the current view object. Maximum length is 255 characters. Gets or sets the name of the current view object. Note that a changed view name may not exactly match the supplied text string if the name used does not meet the view name eligibility requirements. See the method documentation for a more details. Gets or sets the work offset number of this view object. Gets or sets the origin of this view object. Gets or sets the view matrix of this view object. Tests to see if a string can be used as a possible view name. This utility function is designed to test possible view names since view names have to be unique amongst views, case-insensitive. They also have to be 40 characters or less. The view name to be checked. true if view name is okay, false if not. Updates the current view object with any changes that have been made to the version in the Mastercam database. True if the view was successfully updated, else false if not. Deletes the current view object from the Mastercam database. Note that once the view object has been deleted from the Mastercam database it will still exist locally, and can be re-committed at a later time. Also note that trying to delete locked system views will fail and will return a false return code. True if the view was successfully deleted from the Mastercam database, else false if not. Validates whether or not the current view object is a valid Mastercam database entry yet. True if the view is already in the Mastercam database, else false if not. Takes the current view object and commits it to the Mastercam database. Note that trying to commit locked system views will fail and return a false return code. True if the view was successfully committed, else false if not. Takes the current view object and cuts it's ties with the current Mastercam database. This makes the view invalid, like a newly created view object. Once you've called this, the view object will be an entirely independent object. As such, it can be committed to the current database as an entirely new object or committed to an entirely new database. This also means that the Delete and Regenerate methods will fail until the object has been re-committed to a database. Default Constructor. All members are given default values. This class is used for modifying and creating view entities in Mastercam. Initializes a new instance of the Matrix3D class. This construction method takes three 3D points as row values and constructs a matrix object from them. The data to construct the first row with. The data to construct the second row with. The data to construct the third row with. This is a static inequality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first matrix to compare. This is the second matrix to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first matrix to compare. This is the second matrix to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this math object to another one. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. [in,out] This is the matrix to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first matrix to compare. This is the second matrix to compare. True if the two objects are considered equal. Gets or sets the specified value within this Matrix3D. This is the bracket operator overload so that individual values within this matrix can be accessed via an array-like interface. Note that the syntax for this operator is - Read: var myValue = matrix[row#, col#]; Write: matrix[row#, col#] = myValue; The row and col values within the brackets must be either 0, 1 or 2 to access the specific data "cell" of the matrix. Thrown if an index is passed in that is out of the allowed range. Gets or sets the specified row of this Matrix3D. This is the bracket operator overload so that the data rows within this matrix can be accessed via an array-like interface. The index used within the brackets must be either 0, 1 or 2 to access the specific row. Thrown if an index is passed in that is out of the allowed range. Gets or sets the 3D point object that represents the third row within the matrix. Gets or sets the 3D point object that represents the second row within the matrix. Gets or sets the 3D point object that represents the first row within the matrix. "Converts" this NET-Hook type to the corresponding Mastercam math type. [in,out] The Mastercam matrix. "Converts" this NET-Hook type to the corresponding Mastercam math type. [in,out] The Mastercam matrix. Initializes a new instance of the Matrix3D class. The Mastercam 3x3 matrix data. This class is used as a mathematical representation of a 3x3 Matrix. This is a static inequality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first point to compare. This is the second point to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these math objects. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the first point to compare. This is the second point to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this math object to another one. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. This is the point to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing these math objects. This is the first point to compare. This is the second point to compare. Note that the comparison is done with respect to the internal Mastercam value, so small differences between two objects that are less than the tolerances will still be considered equal. True if the two objects are considered equal. Get or sets the specified coordinate of this Point3D. This is the bracket operator overload so that the X, Y, and Z values within this point can be accessed via an array-like interface. The index used within the brackets must be either 0, 1, or 2 to access either the X, Y, or Z value within this Point3D. Thrown if an index is passed in that is out of the allowed range. This is the dot product method so that two points can have their dot products calculated. This is the first point in the dot product operation. This is the second point in the dot product operation. The value of the dot product between the two input points. This is the dot product operator overload so that two points can have their dot products calculated. This is the first point in the dot product operation. This is the second point in the dot product operation. The value of the dot product between the two input points. This is a cross product method so that two points can have their cross product calculated. This is the first point in the cross product operation. This is the second point in the cross product operation. The cross product between the two input points. This is the cross product operator overload so that two points can have their cross product calculated. This is the first point in the cross product operation. This is the second point in the cross product operation. The cross product between the two input points. This is a subtraction method so that two points can be subtracted from one another. This is the point that will be subtracted from. This is the point whose values will be subtracted. A new point representing the vector subtraction of the two input points. This is the subtraction operator overload so that two points can be subtracted from one another. This is the point that will be subtracted from. This is the point whose values will be subtracted. A new point representing the vector subtraction of the two input points. This is an addition method so that two points can be added. This is the first point in the point addition operation. This is the second point in the point addition operation. A new point representing the vector addition of the two input points. This is the addition operator overload so that two points can be added using an intuitive, mathematical method. This is the first point in the point addition operation. This is the second point in the point addition operation. A new point representing the vector addition of the two input points. Convert this object into a string representation. A text string that represents this object. Gets or sets the Z value of the point object. Gets or sets the Y value of the point object. Gets or sets the X value of the point object. Initializes a new instance of the Point3D class. The value to become this point's X value. The value to become this point's Y value. The value to become this point's Z value. "Converts" this NET-Hook type to the corresponding Mastercam math type. [in,out] The Mastercam math type. "Converts" this NET-Hook type to the corresponding Mastercam math type. [out] The Mastercam math type. "Converts" this NET-Hook type to the corresponding Mastercam math type. [out] The Mastercam math type. Initializes a new instance of the Point3D class. The vector. Initializes a new instance of the Point3D class. The Mastercam 3D point geometry data. Initializes a new instance of the Point3D class. The Mastercam 3D point geometry data. This class is used as a mathematical representation of a 3D Point. The operator overloads in this class utilize the VectorManager class for their operations. Gets or sets a value indicating whether the construction mode is set to 3D. true if the construction view is 3D, else, false if it is set to 2D. Gets or sets the Gradient Background 'direction' setting within Mastercam. Changing the this setting may need to be followed by a graphics repaint in order to take effect. Valid settings are: 0 = GRADIENT_NONE (Use the Graphics background color) 1 = GRADIENT_HORIZONTAL 2 = GRADIENT_VERTICAL 3 = GRADIENT_DIAGONAL Gets or sets the Gradient Background 'ending' color within Mastercam. Changing the this setting may need to be followed by a graphics repaint in order to take effect. Note there is more colors data available in the class. The color# (0-255) of the gradient background start. Gets the Gradient Background 'starting' color within Mastercam. Note that this setting is now the same as BackgroundColor. Changing the this setting may need to be followed by a graphics repaint in order to take effect. Note there is more colors data available in the class. The color# (0-255) of the gradient background start. Gets or sets the Graphics Screen Background color within Mastercam. Note that this setting is now the same as GradientBackgroundStartColor. Changing the current background color may need to be followed by a graphics repaint in order to take effect. Note there is more colors data available in the class. Gets the active 'Default Plane Color' (for new Planes) within Mastercam. Note there is more colors data available in the class. The color# (0 - 255). Gets or sets the active 'Axis Color' within Mastercam. Note there is more colors data available in the class. The color# (0 - 255). Gets or sets the active 'Live Entity Color' within Mastercam. Note there is more colors data available in the class. The color# (0 - 255). Gets or sets the active 'Select Color' within Mastercam. Note there is more colors data available in the class. The color# (0 - 255). Gets or sets the active 'Result Color' within Mastercam. Note there is more colors data available in the class. The color# (0 - 255). Gets or sets the active 'Group Color' within Mastercam. Note there is more colors data available in the class. The color# (0 - 255). Gets or sets the active 'Solids Color' within Mastercam. Note there is more colors data available in the class. The color# (0 - 255). Gets or sets the active 'Surface Edge Color' within Mastercam. Note there is more colors data available in the class. The color# (0 - 255). Gets or sets the active 'Surface Front Color' within Mastercam. Note there is more colors data available in the class. The color# (0 - 255). Gets or sets the active 'Wireframe' geometry color within Mastercam. Note there is more colors data available in the class. The color# (0 - 255). Gets or sets the current import Polylines as Nurbs value within Mastercam. Gets the current Curve Chordal Deviation used within Mastercam. Gets the current system tolerance used within Mastercam. Gets or sets the metric flag within Mastercam. Gets or sets the currently active "main" geometry level within Mastercam. Gets the location of the temp directory Mastercam is using. Gets the user files directory from Mastercam. Gets the shared user directory from Mastercam. Gets the main directory (install or working dir) from Mastercam. Gets the exe directory where Mastercam.exe is running. Gets the current file directory within Mastercam. Gets or sets the property the current line width within Mastercam. Valid settings are: 1 - 5 Gets or sets the current line style type within Mastercam. Gets or sets the current point style type within Mastercam. Initializes a new instance of the SettingsManager class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class is used to modify common settings within the Mastercam environment. Gets the Recent Colors list for a specific "named" color. The ID of the "named" color. A list of the recent color indexes. Adds a ColorIndex to the Recent Colors list for a specific "named" color. The ID of the "named" color. The new index value. Sets the index for a specific "named" color. The ID of the "named" color. The new index value. Gets the index for a specific "named" color. The ID of the "named" color. The index if the specified color. Sets the Color data at a specific index. Zero-based index of the color (0-255). The (RGB) Color data to set for the color at this index. Gets the Color data at a specific index. Zero-based index of the color (0-255). The Color data for the color at this index. Gets the count of entries in the Color Table. The count. IDs for all of the "named" colors in the system. Initializes a new instance of the Colors class. Private Constructor. Made private so as not to allow anyone to create an instance of it. This class handles the manipulation of Mastercam Color settings. Accessor for the Singleton instance of IColorTableManager. The singleton. Gets the Recent Colors list for a specific ColorId. Id of the color. Adds a ColorIndex to the Recent Colors list for a specific ColorId. Id of the color. The new value. Sets the ColorIndex for a specific ColorId. Id of the color. The new value. Gets color index. The color. The color index. Gets the ColorIndex for a specific ColorId. Id of the color. The value. Sets the Color at a specific index. Zero-based index of the color. The color. Gets the Color at a specific index. Zero-based index of the color. The color at index. Gets count of entries in the Color Table. The count. Ids for all named colors in the system. Destructor. Interface for ColorTableManager. True to mark the merged data as a "result" group. The Offset Levels by value. The Merge Levels options. True to set to the active Construction Plane, else false to used incoming plane. True to set to the active Line Width, else false to used incoming width. True to set to the active Point Style, else false to used incoming style. True to set to the active Line Style, else false to used incoming style. True to set to the main color, else false to used incoming color. Initializes a new instance of the FileMergePatternOptions class. Values that represent the Merge Levels options when doing a FileMerge. Specifies the offset levels by mode. Specifies the merged file levels mode. Specifies the active level mode. Values that represent View (aka. Plane) types. This enumeration specifies the types of file ext to save the contents of the event logger to disk. > Comma Delimited (CSV) file XML file. This enumeration specifies the types of message logging used by the event logger. > Log a message and display a message box. Log a message only. This enumeration specifies the types of message severities used by the event logger. m> An event to be logged with a error notification. An event to be logged with a warning notification. An event to be logged with an informational notification. This enumeration specifies the different gradient background options in Mastercam. The gradient background is on and set to a diagonal gradient. The gradient background is on and set to a vertical gradient. The gradient background is on and set to a horizontal gradient. Gradient background is off (use the background color only). This enumeration specifies the different types of Mastercam graphics views. A trimetric graphics view. A 'reverse' isometric graphics view. An isometric graphics view, which looks at the part from a combined view of the top, front, and left sides. A graphics view looking leftward from the left side of the WCS. A graphics view looking rightward from the right side of the WCS. A graphics view looking up from the bottom of the WCS. A graphics view looking backwards from the back of the WCS. A graphics view looking forward from the front of the WCS. A graphics view looking down from the top of the WCS. This enumeration which specifies the different types of Mastercam "reserved" (system) Cnc::Globals::Planes::GetPlanes (). The Trimetric plane. The 'reverse' Isometric plane. An Isometric plane, which looks at the part from a combined view of the top, front, and left sides. The Left side plane, looking leftward from the left side of the WCS. The Right side plane, looking rightward from the right side of the WCS. The Bottom plane, looking up from the bottom of the WCS. The Back plane, looking backwards from the back of the WCS. The Front plane, looking forward from the front of the WCS. The Top plane, looking down from the top of the WCS.. This enumeration specifies the different types of a QuickMask selection mode. Used with SelectGeometryByMask(QuickMaskType Mask) Select all Meshes. This requires the user to select the Named Group. Select all entities in the active Xform Result. Select all entities in the active Xform Group. This requires the user to select the Level. This requires the user to select the Color. Select all Wireframe type geometry. Select all Solids. Select all Surfaces. Select all SurfaceCurves. Select all Splines. Select all Arcs. Select all Lines. Select all Points. This enumeration specifies the different types of pre-selection within Mastercam. Use only preselected geometry. Use preselected geometry. Clear all preselected geometry. Don't use pre-selection at all. This enumeration specifies the different box selection modes within Mastercam. Select only geometry completely outside of the box. Select only geometry outside of and intersecting the box. Select only geometry intersecting the box. Select geometry only completely within and intersecting the box. Select only geometry completely within the box. This enumeration specifies the different types of points within Mastercam. A point representing the second endpoint of some geometry. A point representing the first endpoint of some geometry. A grid point. A bolt-circle point. An arc point. Any point entity. A point with valid values. A sketcher point. A point on a quad. A relative point. A last point. Simple point geometry. A midpoint. An intersection point. An endpoint. A center point. An origin point. No specific point type. This enumeration specifies the different line geometry styles within Mastercam. A line style where there are multi-directional grooves along the line. A phantom line style. A center-line line style. A line style where the line is hidden. A solid line style. This enumeration specifies the different styles of point geometry available in Mastercam. A wire cut point. A wire thread point. A square shaped point. A circle shaped point. An X shaped point. A cross shaped point. A simple dot shaped point. A star shaped point. This enumeration specifies the different return types of dialogs within Mastercam. Dialog returned because the no button was pushed. Dialog returned because the yes button was pushed. Dialog returned because the okay button was pushed. Dialog returned because the cancel button was pushed. Clears the mastercam event log. Saves the Mastercam event log file. Name of the file to save. Type of the file to save, XML (default) or CSV. Saves the Mastercam event log file to disk. The name of the file to save. The type of the file to save, xml (default) or comma delimited. Send MCLogr a message to have it show the Mastercam event log file. Values that represent the type of file to save the event log to disk. Interface for IMathObject3D. Interface for IMathObject2D. Interface for IMathObjectBase. The tip angle on the tool (if applicable). The diameter of the tool. The corner radius on the tool (if applicable). The (overall) length of the tool. The length of the shoulder of the tool. The length of the flutes on the tool. The chuck (description) on the tool. The manufacturers tool code data on the tool. The name (description) on the tool. The material SFM percentage value. The spindle rotation direction. 0 = CW or 1 = CCW The slot # of the tool. The pilot diameter on the tool (if applicable). The tool type identifier. The taper length on the tool (if applicable). The should diameter of the tool (if applicable). The shank diameter of the tool (if applicable). The tool holder length. The tool holder diameter. The tool display mode. The number of flutes on the tool (if applicable). The radius type on the tool (if applicable). The level number of the tool profile (if applicable). Attributes specific to drill type tools. Attributes specific to mill type tools. Tool parameters that are 'Drill type' tool specific. Use the property to determine if this data is "active". The data structure containing these Drill type tool only values. Gets or sets the Tool parameters that are 'Mill type' tool specific. Use the property to determine if this data is "active". The data structure containing these Mill type tool only values. The Drill Tool 'shift' value (% of tool diameter shift value (for fine boring). The Drill Tool 'root_dia' value (tap: root of threads). The Drill Tool 'angle' value (spot: shoulder angle). The Drill Tool 'dwell' value (pre-stored dwell in seconds). The Drill Tool 'chip_break' value (% of tool diameter). The Drill Tool 'peck_clr' value (% of tool diameter). The Drill Tool 'peck2' value (% of tool diameter). The Drill Tool 'peck1' value (% of tool diameter). The Drill 'cycle' type. Tool parameters that are 'Drill type' tool specific. Use the property to determine if this data is "active". Thread mill : thread face angle (usually 1/2 included angle). Thread mill : root diameter of threads. Chamfer mill: diameter at tip of tool. All mills: % of tool diameter for Z step-over in finishing. All mills: % of tool diameter for XY step-over in finishing. All mills: % of tool diameter for Z step-over in roughing. All mills: % of tool diameter for XY step-over in finishing. All mills: capable of ROUGH, FINISH or BOTH Tool parameters that are 'Mill type' tool specific. Use the property to determine if this data is "active". Gets or sets a value indicating whether the values are Metric. Gets or sets the Threads per inch or thread pitch (mm). Gets or sets the Holder Length for the tool. Cannot be less than zero!. Gets or sets the Holder Diameter for the tool . Cannot be less than zero!. Gets or sets the Shank Diameter for the tool. Cannot be less than zero!. Gets or sets the portion of tool length that is tapered, beginning at top of shoulder and proceeding up. Cannot be less than zero!. Gets or sets the Shoulder Diameter for the tool. Cannot be less than zero!. Gets or sets the Level Number for the tool profile. Cannot be less than one!. Gets or sets the tool's Tip Angle. Cannot be less than zero!. Gets or sets the number of flutes on the tool. Cannot be less than zero!. Gets or sets the ToolRadiusType; None, Corner or Full. Gets or sets the spindle RPM. Gets or sets the retract feedrate. Gets or sets the plunge feedrate. Gets or sets the feedrate. Gets the tool's Type ID code . Gets or sets the Chuck (comment string). Maximum length of 120 characters. Gets or sets the Mfg's tool code (comment string). Maximum length of 120 characters. Gets or sets the custom tool reference file. Gets or sets the tool display mode: auto=0, file=1, level=2, custom stored=3. Gets or sets the pilot diameter: <=0.0 center cutting, > 0 required 'pre-drilled' hole. Cannot be less than zero!. Gets or sets the percentage of material feed per tooth/rev value. (for feed calc.) Gets the percentage of material sfm value. (for feed calc.) Gets the Spindle rotation direction: 0 = CW or 1 = CCW Gets the Internal tool ID# Gets or sets the tool Material: HSS, CAR, etc. (see assocvar.h) Gets or sets the Coolant Mode; Off, Flood, Mist, Tool (Spindle). Gets or sets the "name" of the tool. Maximum length of 120 characters. Gets or sets the shoulder length of the tool. Gets or sets the flute length of the tool . Gets or sets the (over-all) length of the tool (NOT including the holder). Gets or sets the diameter offset register of the tool. Gets or sets the length offset register of the tool. Gets or sets the tool number. Gets or sets the corner radius of the current tool. Cannot be less than zero!. Gets or sets the tool diameter. Must be greater than zero!. Gets a value indicating if this tool a "Mill type" tool. Use to determine if the data is "active". true if this object is mill type tool, false if not. Gets a value indicating if this tool a "Drill type" tool. Use to determine if the data is "active". true if this object is drill type tool, false if not. Launches the dialog to allow a user to edit the current tool object. True if the tool was successfully edited and false if not. Updates the current tool object with any changes that have been made to the version in the Mastercam database. True if the tool was successfully updated and false if not. Deletes the current tool object from the Mastercam database. Note that once the tool object has been deleted from the Mastercam database it will still exist locally, and can be re-committed at a later time. True if the tool was successfully deleted from the Mastercam database and false if not. This exception will be thrown if the object being deleted is already marked as an Invalid, indicating that it doesn't exist in the Mastercam database anyway. Thrown if for some reason this object is supposed to be valid but the entity is no longer in the Mastercam database. Thrown if Mastercam is unable to write the entity changes to the database for some reason. Validates whether or not the current tool object is a valid Mastercam database entity. True if the tool is already in the Mastercam database and false if not. Takes the current tool object and commits it to the Mastercam database. True if the tool was successfully committed and false if not. Thrown if for some reason this object is supposed to be valid but the entity is no longer in the Mastercam database. Thrown if Mastercam is unable to write the entity changes to the database for some reason. Makes sure the data is "valid" for the various tool types before Committing. Is this tool a "Drill type" tool? Used to determine if the data is "active". true or false. Is this tool a "Mill type" tool? Used to determine if the MillToolAttributes data is "active". true or false. Uploads the current object's settings to this Mastercam type. The tool object to upload object settings to. Loads the current object's settings from this Mastercam type. The tool object to load object settings from. Initializes a Mastercam tool structure with default values. The tool structure to be initialized. Loads the default values for a given tool object from the tool structure passed in. The tool structure to use as defaults for this tool object. Retrieves a tool structure from the Mastercam database. The tool structure to be retrieved. True if the tool was retrieved from the database successfully; false if not. Deletes a tool structure from the Mastercam database. The tool structure to be deleted. True if the tool was deleted from the database successfully; false if not. Validates that a given tool structure is already in the Mastercam database. The tool structure to be validated. True if the tool is already in the database; false if not. Commits a tool structure to the Mastercam database. The tool structure to be committed. True if the commit was successful; false if not. ID Lookup Constructor. Attempts to retrieve a tool with the given ID from the Mastercam database and use that to initialize this tool object. If no matching tool is found in the Mastercam database, the object is initialized to default values. The ID of the tool to look up in the Mastercam database. Initialize a new Tool object All members are initialized to the values passed in. The tool diameter value to initialize this object to. The tool corner radius value to initialize this object to. The tool number to initialize this object to. The tool length offset value to initialize this object to. The tool diameter offset value to initialize this object to. The tool length to initialize this object to. The tool flute length value to initialize this object to. The tool shoulder length value to initialize this object to. The tool name to initialize this object to. The tool Type ID code. Initialize a new Tool object. All members are given default values. Identifier for the tool type. Loads the default values for a given tool object. Identifier for the tool type. Loads the default values for a given tool object. This class handles Tool object interaction between the NET-Hook operation objects and Mastercam operations. This member represents the view ID of this entity in the Mastercam database if it's a view object. This member represents the operation ID of this entity in the Mastercam database if it's an operation object. This member represents the tool ID of this entity in the Mastercam database if it's a tool object. This member represents the geometry ID of this entity in the Mastercam database if it's a geometry object. This member specifies what type of entity this object is. This member dictates whether this entity is considered 'valid' or not. (ie. whether or not it's already in the Mastercam database). Loads the default values for a given database entity object. Abstract Declaration. Initializes a new instance of the abstract class. Attempts to retrieve an entity of the given type with the given ID from the Mastercam database and use that to initialize this object. If no matching entity is found in the Mastercam database, the object is initialized to default values. The ID of the entity to look up in the Mastercam database. The type of entity to look up and initialize this object to. Initializes a new instance of the abstract Entity class. Attempts to retrieve an entity of the given type with the given ID from the Mastercam database and use that to initialize this object. If no matching entity is found in the Mastercam database, the object is initialized to default values. The ID of the entity to look up in the Mastercam database. The type of entity to look up and initialize this object to. Initializes a new instance of the abstract Entity class. Attempts to retrieve an entity with the given ID from the Mastercam database and use that to initialize this object. The ID of the entity to look up in the Mastercam database. Retrieves a view structure from the database based on this object's ID. [out] The view structure that receives the resulting view data found in the database. True if the entity was found successfully; false if not. Retrieves an operation structure from the database based on this object's ID. [out] The operation structure that takes all of the data if a matching entity was found in the database. True if the entity was found successfully; false if not. Retrieves a tool structure from the database based on this object's ID. [in,out] The tool structure that takes all of the data if a matching entity was found in the database. True if the entity was found successfully; false if not. Retrieves an entity from the database based on this object's ID. [out] The entity structure that takes all of the data if a matching entity was found in the database. True if the entity was found successfully; false if not. Returns the eptr of this object if it happens to be a geometry object. The eptr of this object if it's of the right type; a NULL value if it's the wrong type. Returns the ID of this object if it happens to be a geometry object. The ID of this object if it's of the right type; a NULL value if it's the wrong type. Returns the ID of this object if it happens to be a tool object. The ID of this object if it's of the right type; a -1 if it's the wrong type. This flag specifies the entity type for the current entity object. Gets the database Time Stamp for this entity. The entity must have already been committed to Mastercam's database for this to be valid! If not, the DateTime returned is the "dawn of time" for a .NET DateTime - (midnight), January 1, 0001. You can check for this by comparing the TimeStamp to the .NET DateTime.MinValue. Updates the current entity object with any changes that have been made to the version in the Mastercam database. True if the entity was successfully updated, else false if not. Deletes the current entity object from the Mastercam database. True if the entity was successfully deleted from the Mastercam database and false if not. Note that once the entity object has been deleted from the Mastercam database it will still exist locally, and can be re-committed at a later time. Validates whether or not the current entity object is a valid Mastercam database entry yet. True if the entity is already in the Mastercam database, else false if not. Takes the current entity object and commits it to the Mastercam database. True if the entity was successfully committed, else false if not. Takes the current entity object and cuts it's ties with the current Mastercam database. This makes the entity invalid, like a newly created entity object. Once you've called this, the entity object will be an entirely independent object. As such, it can be committed to the current database as an entirely new object or committed to an entirely new database. This also means that the Delete and Regenerate methods will fail until the object has been re- committed to a database. Initializes a new instance of the abstract Entity class. This is the base class for all database entities. It's methods provide generic access to database objects. Enum for choosing which detection method to use. Values that represent hole segment types. Edge treatment setting for hole definition. Types of holes. Mask flags for selecting a Solid; Body, Face, or Edge. The Min/Max allowable Level# in Mastercam. The settings for the 'CapableOf' parameter of a Mill type tool. See "Mastercam.Database.Tool.MillToolSpecificAttribs"for the parameters that are Mill "type" tool specific. capable of finishing only capable of roughing only capable of roughing and finishing The Coolant 'types' that can be assigned in a Tool. This is a static inequality operator overload for the purposes of comparing these math objects. This is the first mask to compare. This is the second mask to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these math objects. This is the first mask to compare. This is the second mask to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this mask object to another one. [in,out] This is the mask to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing mask objects. This is the first mask to compare. This is the second mask to compare. True if the two objects are considered equal. Gets or sets the Result entities flag. Gets or sets the Group entities flag. Gets or sets the Group and Result entities flag. Initializes a new instance of the GroupSelectionMask class. Sets all of the geometry type flags to the respective boolean values passed in. The value to set the Group entities flag to. The value to set the Result entities flag to. Initializes a new instance of the GroupSelectionMask class. Sets the selection type flags so that it would either return all geometry or no geometry. The boolean value representing the whether the mask should allow all geometry or no geometry types. Used to output the Mastercam bit value representing this object's internal data. A short value with the corresponding bits set to act as a Mastercam (entity) Group selection Mask. A masking type used for indicating Group and/or Result selection flags. This is a static inequality operator overload for the purposes of comparing these math objects. This is the first mask to compare. This is the second mask to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these math objects. This is the first mask to compare. This is the second mask to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this mask object to another one. [in,out] This is the mask to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing mask objects. This is the first mask to compare. This is the second mask to compare. True if the two objects are considered equal. Gets or sets the Blanked entities flag. Gets or sets the Selected entities flag. Gets or sets the All entities flag. Initializes a new instance of the SelectionMask class. Sets all of the geometry type flags to the respective boolean values passed in. The value to set the All Alive entities flag to. The value to set the Selected entities flag to. The value to set the Blanked entities flag to. Initializes a new instance of the SelectionMask class. Sets the selection type flags so that it would either return all geometry or no geometry. The boolean value representing the whether the mask should allow all geometry or no geometry. Used to output the Mastercam bit value representing this object's internal data. A short value with the corresponding bits set to act as a Mastercam selection Mask. A masking type used for indicating any combination of selection flags. This is a static inequality operator overload for the purposes of comparing these math objects. This is the first mask to compare. This is the second mask to compare. True if the two objects are considered not equal. This is a static equality operator overload for the purposes of comparing these math objects. This is the first mask to compare. This is the second mask to compare. True if the two objects are considered equal. This is an equality method for the purposes of comparing this mask object to another one. This is the mask to compare against. True if the two objects are considered equal. This is a static equality method for the purposes of comparing mask objects. This is the first mask to compare. This is the second mask to compare. True if the two objects are considered equal. Gets or sets the Polygonal Mesh geometry flag. Gets or sets the Solids geometry flag. Gets or sets the Surfaces geometry flag. Gets or sets the NURBS Splines geometry flag. Gets or sets the Parametric Splines geometry flag. Gets or sets the Arcs geometry flag. Gets or sets the Lines geometry flag. Gets or sets the Points geometry flag. Initializes a new instance of the GeometryMask class. Sets all of the geometry type flags to the respective boolean values passed in. true for points. true for lines. true for arcs. true for parametric type splines. true for nurbs type splines. true for surfs. true for solids. true for polygonal meshes. Initializes a new instance of the GeometryMask class. Sets all of the geometry type flags to the same boolean value. The boolean value to set the geometry flags to. Used to output the Mastercam bit value representing this object's internal data. A long value with the corresponding bits set to act as a Mastercam geometry Mask. A masking type used for indicating any combination of geometry types. Values that represent the (10) custom parameter values on a Drill type operation . This enum specifies the different types of Drill Cycles. Misc. (style2) cycle. Misc. (style1) cycle. Bore (style2) cycle. Bore (style1) cycle. Tapping cycle. Chip Break Drilling cycle. Peck Drilling cycle. Standard Drill cycle. Values that represent a tool's Radius Type; None, Corner, Full . For Mill/Router type tools. The types of tools that can be used in an operation. The types of operations used in NET-Hook API High Speed 3D machining (Optirough, Area Rough). High Speed 2D machining (Peel Mill, Core Mill). Mill-Turn Steady Rest point. Mill-Turn Steady Rest. Mill-Turn Center Tool Point. Mill-Turn Turret Park. Mill-Turn TailStock Advance/Retract. Mill-Turn Spindle Sync. Mill-Turn Spindle Advance/Retract. Mill-Turn Spindle Clamp/UnClamp. Mill-Turn Simple Bar Feed. Router Surface Rough Pocket. Router Circle Mill. Router Pocket. Router Contour. Lathe SteadyRest position. Lathe TailStock position. Lathe chuck clamp/un-clamp. Lathe Bar Feed. Lathe Stock Flip. Lathe Stock Transfer. Lathe C-Hook. Lathe Canned Groove finish. Lathe Canned Groove Rough. Lathe Pattern Repeat. Lathe Canned Rough. Lathe Canned Finish. Model Chamfer. Saw tool path for mill/router. Process Hole. Chamfer Drill. Advanced Drill. Wire Contour - Agie Collar. Wire Merged in ASCII NCI. Wire Associative Trimmed. Wire v7-not available, v8-mirror, rotate, translate. Wire 4-Axis. Wire Point. Wire Manual Entry. Wire No Core (pocket). Wire Canned (drill). Wire Contour. Lathe Prime Turning. Lathe Contour Rough. Lathe Dynamic Rough. Lathe Merged in ASCII NCI. Lathe Manual Entry. Lathe Plunge Roughing. Lathe Cutoff. Lathe Facing. Lathe Point. Lathe non-associtive drilling. Lathe Threading. Lathe Finishing. Lathe Roughing. Lathe Roughing. 5-Axis Roll Die. 5-Axis Swarf. Merged in ascii nci. Multi-surface finish 4 axis. Multi-surface finish 5 axis flowline. Multi-surface rough plunge. Multi-surface finish constant scallop. Multi-surface finish shallow. Multi-surface finish steep. Multi-surface finish leftover stock. Multi-surface finish pencil trace. Non-associative pocketing. Non-associative drilling. Non-associative contour. Project toolpath onto a surface. Project toolpath onto a cross section. Project toolpath onto a cone. Project toolpath onto a sphere. Project toolpath onto a cylinder. Project toolpath onto a plane. 5-Axis curve. 5-Axis drilling. Lofted. Coons. Swept 3D. Swept 2D. Letters. Revolved. Ruled. Trimmed. Multi-surface finish contour. Multi-surface finish flowline. Multi-surface finish project. Multi-surface finish radial. Multi-surface finish parallel. Multi-surface rough pocket. Multi-surface rough contour. Multi-surface rough flowline. Multi-surface rough project. Multi-surface rough radial. Multi-surface rough parallel. Multi-surface finish blend. v7-linear array, v8-mirror, rotate, translate. C-Hook created operation. Point. A manual entry operation. A (mill) Facing milling operation. Thread mill. Slot mill. Engrave. Circle mill. Helix bore. Nesting onionskin operation. Associative nesting container operation. Router Multi drill. Pocket. Drill. Contour. An undefined or unknown operation type. The types of machining direction that be applied to an operation. Climb cutting direction. Conventional cutting direction. The types of cutter compensation corner rolling that can be applied to an operation. Cutter compensation corner rolling for all corners in the operation. Only sharp cutter compensation corner rolling in the operation. No cutter compensation rolling in the operation. The direction of cutter compensation that can be applied to an operation. The value returned if an error occurred while determining the cutter compensation type. An invalid cutter compensation type. Automatic cutter compensation. Right-hand cutter compensation. Left-hand cutter compensation. The type of cutter compensation that can be applied to an operation. The value returned if an error occurred while determining the cutter compensation type. No adjustment for wear, no output compensation codes. Same as wear, except the wear value is positive. Mastercam calculates compensation, and outputs G41/G42 codes. The control will calculation compensation. Mastercam will automatically calculate compensation. The different methods of sorting drill points in a drill-based operation. zig z plus, counter-clockwise zig z minus, counter-clockwise zig z plus, clockwise zig z minus, clockwise z plus, counter-clockwise z minus, counter-clockwise z plus, clockwise z minus, clockwise counter-clockwise, zig z plus counter-clockwise, zig z minus counter-clockwise, z plus counter-clockwise, z minus clockwise, zig z plus clockwise, zig z minus clockwise, z plus clockwise, z minus rotate zig plus, counter-clockwise rotate zig minus, counter-clockwise rotate zig plus, clockwise rotate zig minus, clockwise counter-clockwise around z, rotate plus counter-clockwise around z, rotate minus counter-clockwise, rotate plus counter-clockwise, rotate minus clockwise, zig rotate plus clockwise, zig rotate minus clockwise, rotate plus clockwise, rotate minus point to point y zig minus, x minus y zig minus, x plus y zig plus, x minus y zig plus, x plus y minus, x minus y minus, x plus y plus, x minus y plus, x plus x zig minus, y minus x zig minus, y plus x zig plus, y minus x zig plus, y plus x minus, y minus x minus, y plus x plus, y x plus, y plus Sorting off The different methods of cutting a pocketing toolpath. High Speed cutting. One-Way cutting. True Spiral cutting. Morph Spiral Parallel Spiral (with Clean Corners) Parallel Spiral Constant Overlap Spiral cutting. Zig-Zag cutting. The different types of chains that can be used by Chain Manager methods. Only curve-based chains. Only chains within the tool containment boundary. Only chains on the tool axis. Only drive chains. All chains. The different pieces of functionality that the Chain Manager method can perform. Returns an array of the given operation's chains. Launches the dialog to let the user change the starting point in the chain. Launches the dialog to let the user change parameters at a given point in the operation. Flips the cutter compensation direction in all of the chains in the specified Operation object. Launches the dialog to let the user replace all of the given chains in a specified Operation. Launches the dialog to let the user replace one or more chains. Reverses all of the chains in the specified Operation object. Deletes all of the chains from the specified Operation object. Adds chains from the passed in array of Chain objects to the specified Operation object. Displays the chaining dialog for the given Operation object. The 'offset side' modes available when offsetting a Chain. Offset to the Right side. Offset to the Left side. The 'roll corner' modes available when offsetting a Chain. Roll all corners. Only roll sharp corners. Do not roll any corners. The different possible directions a chain can be created in. A chain with a counter-clockwise direction. A chain with a clockwise direction. A chain with an undefined direction, or a chain where the direction could not be determined. The different product Levels that Mastercam can be in at any given time Mastercam Mill-Turn 2 machine mode. Mastercam Mill-Turn 1 machine mode. Mastercam Wire level. Mastercam Lathe 1 level. Mastercam Lathe Entry level. Mastercam Router 3D level. Mastercam Router 2D level. Mastercam Router Entry level. Mastercam Mill 3D level. Mastercam Mill 2D level. Mastercam Mill Entry level. Indicates an error or bad product level value. The different user types that Mastercam can be running as. Demo-HLE user. Dealer user. Educational user. Industrial user. Indicates an error or bad user type value. The different product modes that Mastercam can be in at any given time Mastercam Mill-Turn machine mode. Mastercam Wire machine mode. Mastercam Lathe machine mode. Mastercam Router machine mode. Mastercam Mill machine mode. Mastercam Design mode. Mastercam Draft mode. Indicates an error or bad product type value. A collection of commonly used Mastercam geometry mask permutations. All geometry types, omitting Solid types. All geometry types. No entity types at all. The different types of base database entities types represented in the API. Mastercam view type. Mastercam geometry type. Mastercam tool type. Mastercam operation type. Initializes a new instance of the NestingParam class. This initializes all of the nesting item objects to their default values. This class is used to work with all of the settings within the parameters section of a nesting file. An array storing all of the strings that this nesting section object couldn't create parameters for. The array of parameter members stored in this section. Reads in and creates parameters from an entire section of a nesting file. The stream to read data and extract parameters from. A string representing the header for this particular section. Reinitializes all of the parameters in this section to their default values. Commits all of the parameters in this section to the given stream. [in,out] The stream to output all of the parameter's data to. Standard Default Constructor. Where applicable, this stores the number of the specified section. This class serves as the base class for nesting sections. This is the data object stored within this nesting parameter . This is the overridden definition for the method to take a string from a nesting file and convert it to input for this parameter. Thrown when a type mismatch error condition occurs. The String object input for this parameter. True if the nesting data was stored successfully; false if not. This is the overridden definition for the method to initialize the parameter to it's default value. This is the overridden definition for the method to output the name of this nesting parameter. The String object representing the name of this parameter. This is the overridden definition for the method to output the nesting data string to the nesting file. The String object to write out to the nesting file. This method is used to set the data object in this parameter. The data object to set this parameter to. This method is used to return the data object in this parameter. The data object stored within this parameter. Initializes a new instance of the NestingItem class. Takes an object of the necessary type as initial input as well as a String object representing the output name. The data object to initialize this parameter with. The String object representing the name of this parameter. The string representing the name of this parameter. The default value for this parameter. This class serves as the intermediary class for nesting parameters. This is the virtual declaration for the method to take a string from a nesting file and convert it to input for this parameter. The String object input for this parameter. True if the nesting data was stored successfully; false if not. This is the virtual declaration for the method to initialize the parameter to it's default value. This is the virtual declaration for the method to output the name of this nesting parameter. The String object representing the name of this parameter. This is the virtual declaration for the method to output the nesting data string to the nesting file. The String object to write out to the nesting file. Initializes a new instance of the abstract class. This class serves as the base class for nesting parameters.