"CHookAPI"

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.

Manager which offers a list of static methods to handle the chaining.

The (user supplied) list of Node Points used to generate the NURBS Curve.

The second endpoint of the curve object.

The first endpoint of the curve object.

This is a static inequality operator overload for the purposes of comparing these 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. The first NURBSCurve 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.

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. The first NURBSCurve to compare. True if the two objects are considered equal.

This is a static equality method for the purposes of comparing these 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. The first NURBSCurve to compare. The second NURBSCurve to compare. True if the two objects are considered equal.

Get the list of Node Points used to generate the NURBS Curve.

The list of Node Points used to generate the NURBS Curve.

Get the second endpoint of the curve object.

The second endpoint of the curve object.

Get the first endpoint of the curve object.

The first endpoint of the curve object.

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.

Initializes a new instance of the NURBSCurve class.

The Mastercam NURBS Curve geometry.

This class is used as a mathematical representation of a NURBS Curve.

Initializes a level memory and set the new active main level.

This remembers the current active Main level. It then sets the level number supplied as the new active Main level. When this LevelMemory goes out of scope, its destructor will automatically restore the active Main level setting back to the original level The level to set as the new active Main level. If successful, a pointer to the LevelMemory class, else null if the suppled level was not valid.

This method replaces all draft entities with lines.

The level number to restrict the search for drafting entities. (-1 = no level restriction.)

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.

Queries if the specified level has 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.

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.

Returns a list of level numbers representing each level that has a Level name associated with it.

A list containing the level numbers of all of the levels that have level names.

Gets the Level Number(s) that have the Level name.

Since there is no restriction on Level "names" being unique, so there can be multiple matches! The Level name to match. An array containing the IDs of all of the matching levels.

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.

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 name was successfully set. This will be false if the name was truncated. The length of the level name cannot exceed 295 characters.

Returns an list of level numbers of each level that contains any geometry on it.

A list containing the level numbers of all of the levels that have geometry.

Returns an list of level numbers representing each currently active levels within Mastercam.

A list containing the level numbers of all of the currently active levels.

Returns an list of level numbers of each currently visible level within Mastercam.

A list containing the level numbers of all of the currently visible levels.

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 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.

Sets the Main level within Mastercam.

If the specified level number does not already exist, it will be created. This is the number of the level to set as the active Main level. False if the supplied LevelNumber is less than '1' or greater than the maximum allowed Level number value.

Takes a name of the level to be made active and sets it as the 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.

Retrieves the level number of the current Main Level.

The number of the Main 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 'Make main levels always visible' setting in the Level Manager.

True to enable, or false to disable the setting.

Retrieves the on/off state of the 'Make main levels always visible' setting in the Level Manager.

True if the option is enabled (checked) or 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.

Constructs an instance of the LevelsManager.

Finalizes an instance of the ILevelsManager.

Refreshes the Level Manager dialog data display.

If the Levels Manager dialog is visible (in a modeless state), any change to the levels data will not be reflected in the dialog until you tell it to refresh itself.

Delete Assignment operator.

Delete move operator.

Delete copy constructor.

Delete move-copy constructor.

This class is used to work with entity levels within Mastercam.

Gets the Levels Manager.

A pointer to the singleton instance of the Levels Manager.

Initializes a level memory and set the new active main level.

This remembers the current active Main level. It then sets the level number supplied as the new active Main level. When this LevelMemory goes out of scope, its destructor will automatically restore the active Main level setting back to the original level The level to set as the new active Main level. If successful, a pointer to the LevelMemory class, else null if the suppled level was not valid.

This method replaces all draft entities with lines.

The level number to restrict the search for drafting entities. (-1 = no level restriction.)

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.

Queries if the specified level has 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.

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.

Returns an list of level numbers representing each level that has a name associated with it.

An list containing the level numbers of all of the levels that have level names.

Gets the Level Number(s) that have the Level name.

Since there is no restriction on Level "names" unique, so there can be multiple matches! The Level name to match. An array containing the IDs of all of the matching levels.

Gets the Level name of a given level.

The number of the specified level. The name of the specified level.

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 name was successfully set. This will be false if the name was truncated. The length of the Level name cannot exceed 295 characters.

Returns an list of level numbers of each level that has any geometry on it.

An list containing the level numbers of all of the levels that contain any 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.

Gets a list of the level numbers of each currently visible levels within Mastercam.

An array containing the IDs of all of the currently visible levels.

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 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.

Sets the Main level within Mastercam.

If the specified level number does not already exist, it will be created. This is the number of the level to set as the active Main level. False if the supplied level number is less than '1' or greater than the maximum allowed Level number value.

Sets the level with the specified name as the 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. This is 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.

Retrieves the level number of the current Main Level.

The number of the Main 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 'Make main levels always visible' setting in the Level Manager.

True to enable, or false to disable the setting.

Retrieves the on/off state of the 'Make main levels always visible' setting in the Level Manager.

True if the option is enabled (checked) or false if not.

Deletes all the levels with the matching level name.

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 by level number.

The level will be 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.

Finalizes an instance of the ILevelsManager.

Refreshes the Level Manager dialog data display.

If the Levels Manager dialog is visible (in a modeless state), any change to the levels data will not be reflected in the dialog until you tell it to refresh itself.

This class is used to work with levels within Mastercam.

The saved status of the database 'dirty or not' when we were instantiated.

The saved level number that we restore back to.

Restores (recalls) the active Main level from the Level Memory.

Initializes a level memory and set the new active main level.

This remembers the current active Main level. It then sets the level number supplied as the new active Main level. When this LevelMemory goes out of scope, its destructor will automatically restore the active Main level setting back to the original level The level to set as the new active Main level. True if it succeeds, false if it fails.

Initializes a new instance of the LevelMemory class.

Finalizes an instance of the LevelMemory class.

Delete Assignment operator.

Delete move operator.

Delete copy constructor.

Delete move-copy constructor.

Constructs and returns a Level Memory.

A pointer to the instance of the Level Memory.

Finalizes an instance of the LevelMemory.

Initializes a level memory and set the new active main level.

This remembers the current active Main level. It then sets the level number supplied as the new active Main level. When this LevelMemory goes out of scope, its destructor will automatically restore the active Main level setting back to the original level The level to set as the new active Main level. True if it succeeds, false if it fails.

The location of the ending point of this arc, an angle, in degrees, from the (3 O'Clock) base point.

The location of the starting point of this arc, an angle, in degrees, from the (3 O'Clock) base point.

The radius of this arc.

The center point of this arc.

This is a static inequality operator overload for the purposes of comparing these 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. The arc to compare with the current one.. True if the two objects are considered not equal.

This is a static equality operator overload for the purposes of comparing these 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. The arc to compare with the current one.. True if the two objects are considered equal.

This is a static equality method for the purposes of comparing these 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. The first arc to compare. The second arc to compare. True if the two objects are considered equal.

Converts this object into a string representation.

(Optional) The maximum number of digits to the right of the decimal point. A text string that represents this object.

"Converts" this Arc2D type to the corresponding Mastercam type.

[out] The Mastercam type.

Gets the location of the ending angle of the arc.

The location of the ending angle of the arc.

Gets the location of the starting angle of the arc.

The location of the starting angle of the arc.

Gets the radius of the arc.

The radius of the arc.

Get the center point.

The center point of the arc.

Initializes a new instance of the Arc2D class.

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.

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.

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 normal 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.

[in] The first point to perform the operation with. [in] 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.

[in] 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.

[in] The point to perform the operation with. The angle of the input vector.

This method performs a cross product on two 2D points and returns the resulting Z component.

[in] The first point to perform the operation with. [in] 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.

[in] The point to be rotated. [in] 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.

[in] The vector to be normalized. A new point representing the normal vector of the input vector.

This method calculates the length of a 2D vector or the distance of a 2D point from the origin.

[in] The point to perform the operation with. The length of the input vector.

This method performs a dot product on two 2D points.

[in] The first point to perform the operation with. [in] The second point to perform the operation with. The dot product value of the two input points.

This method performs a scaling operation on a 2D point.

[in] 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.

[in] The first point to perform the operation with. The value with which to scale the first point. [in] 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.

Constructor an instance of the VectorManager.

Clean-up an instance of the VectorManager.

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.

Delete Assignment operator.

Delete move operator.

Delete copy constructor.

Move copy constructor.

This class handles vector operations between different mathematical objects.

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.

Computes the lower left and upper right corner and the clipping and select parameters.

The center. The height.

Save an opened file to the database

The file to save. Whether to just write header info. Output indicating whether operation was successful.

Opens the file and returns the result.

The file. The name. True if it succeeds, false if it fails.

Abstract function that saves the graphics screen to a bitmap object. It then converts the bitmap object to a Device Independent Bitmap.

True if it succeeds, false if it fails.

Abstract - Free setup sheet captures.

Abstract - Capture screen using Setup-sheet functions.

The caption. Filename of the file. (Optional) True to color. True if it succeeds, false if it fails.

Abstract - 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.

Abstract - 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.

Abstract - 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.

Abstract - Gets tool or material rpx filename.

true if tool report. Current product. Report style. Rpx filename.

Abstract - Executes the 'material report for selected ops' operation.

The resulting XML files. True if it succeeds, false if it fails.

Abstract - Executes the 'tool report for selected ops' operation.

The resulting XML files. True if it succeeds, false if it fails.

Abstract - Gets the extents data for an operation.

Pointer to operation to be processed. The extents data.

Abstract - 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.

Abstract - Executes the setup sheet on selected operations without user interface.

The resulting XML files. true if it succeeds, false if it fails.

Abstract - 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. 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.

Abstract save the screen to bitmap file.

If non-null, filename of the file. (Optional) True to thumbnail. True if it succeeds, false if it fails.

This method performs the file open operation, first displaying the File/Open dialog.

The method provides a wrapper around the global OpenFile function in MFile_CH and allows the mocking of it. [in/out] MUST be complete path to file. [in] Pointer to the parent window. [in] True= get the filename but don't open the file. Code (1 if OK, 0 if file could not be opened, -1 if cancel hit).

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.

The method provides a wrapper around the global DoFileOpen function in MFile_CH and allows the mocking of it. [in] MUST be complete path to file. [in] merge flag. [in] open as flag. true= open as text, else, false [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=NULL). [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.

Creates a new, empty document.

The method provides a wrapper around the global NewDocument function in MastercamDoc_CH and allows the mocking of it. [in] If true, issue no prompts. True if document successfully created, otherwise false.

Sets the current file name.

The full pathname of the file.

Gets current file name.

The current file name.

Gets the Mastercam part file extension based on the user's installed version information.

The part extension.

Query if the current database is 'dirty'. (Has unsaved changes).

True if the file dirty, false if not.

Performs a Save As for a library file.

The full path name 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 type file or not.

The full path name 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.

This prints the active Mastercam view without displaying the Mastercam Print dialog.

Note that while the method may return true because the file was sent to the OS 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 opens the File Print dialog within Mastercam.

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 the data in the active database to 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.

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. The color number of the background color. 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.

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. 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.

Saves 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. True if the bitmap file was created successfully and false if not.

Saves the graphics view of the currently opened file to a bitmap file.

The full path of the bitmap file you wish to create. True = Generate a 256x256 "thumbnail" bitmap, else capture a full-size graphics screen image. The color number of the background color. True if the bitmap file was created successfully, else false if not.

Saves the graphics view of the currently opened file to a bitmap file.

The full 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.

Saves the graphics view of the currently opened file to a bitmap file.

The full 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.

The (full path) of the file to be merged into the database. The options for controlling the merge. True if it succeeds, false if it fails.

Saves the current 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.

Saves the current 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.

Does a 'save some' of the data in the current file to a new file. Note: The data that is saved are the 'selected' entities!

The full path of the new 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 saves the current file to a new path and file name.

The full path of the new 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 saves the current 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. The full path of the new file you wish to create. True if the new file was created successfully, else false if not.

Prompt the user to save the currently opened file to a new name.

The full path and file name of the new file if the user successfully chose one else an empty string value if not.

This closes 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] The full 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 loses 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] The full 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.

Closes 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] The full 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 closes 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. The full 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 prompts 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 closes 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 closes 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.

Initializes a new instance of the FileManager class.

Finalizes an instance of the FileManager.

This closes 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.

Delete assignment operator.

Delete move operator.

Delete copy constructor.

Delete move constructor.

This class is used to work with files within Mastercam.

Gets the File Manager.

A pointer to the singleton instance of the File Manager.

Sets the current file name.

The full pathname of the file.

Gets current file name.

The current file name.

Gets the Mastercam part file extension based on the user's installed version information.

The part extension.

Query if the current database is 'dirty' (Has unsaved changes).

True if the file dirty, false if not.

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.

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 type 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.

Writes out the data in the active database to 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 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 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 opens the File Print dialog within Mastercam.

Saves a snapshot of the graphics screen to a bitmap file.

The full path name of the bitmap file you wish to create. If true, produce a color image. The color number of the background color. 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.

Saves a snapshot of the graphics screen to a bitmap file.

The full path name of the bitmap file you wish to create. If true, produce a color image. 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.

Saves the graphics view of the currently opened file to a (full size) bitmap file.

The full path name of the bitmap file you wish to create. If true, produce a color image. True if the bitmap file was created successfully and false if not.

Saves the graphics view of the currently opened file to a bitmap file.

The full path name of the bitmap file you wish to create. True = Generate a 256x256 "thumbnail" bitmap, else false to capture a full-size graphics screen image. The color number of the background color. True if the bitmap file was created successfully, else false if not.

Saves the graphics view of the currently opened file to a bitmap file.

The full path name of the bitmap file you wish to create. True = Generate a 256x256 "thumbnail" bitmap, else false to capture a full-size graphics screen image. True if the bitmap file was created successfully, else false if not.

Saves the graphics view of the currently opened file to a bitmap file.

The full path name 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.

The (full path) of the file to be merged into the database. The options for controlling the merge. True if it succeeds, false if it fails.

This saves the current 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 saves the current 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.

Does a 'save some' of the data in the current file to a new file. Note: The data that is saved are the 'selected' entities!

This is the full path name of the new 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.

Saves the current file to a new file name.

This is the full path name of the 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.

Saves the current file to a new file name.

The default behavior with this method is to not save a thumbnail image along with the file. This is the full path name of the new file you wish to create. True if the new file was created successfully, else false if not.

Prompt the user to save the currently opened file to a new name and path.

The full path name of the new file if the user successfully chose one else an empty string value if not.

Opens 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] The full path name 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, the specified file will be opened with the Mastercam editor as a text-based file. True if the new file was opened successfully, else false if not.

Opens a file into within Mastercam.

If true, the user will be prompted as to whether they want to save the current file before opening the new one. [in,out] The full path name 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.

Opens 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] The full path name of the file to open. True if the new file was opened successfully, else false if not.

Prompts the user to select a file to open 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. The full path name of the file to open. True if the new file was opened successfully, else false if not.

Prompts the user to select a file to open within Mastercam.

The full path name of the opened file if the user chose a file to open, else an empty string value if not.

Closes any the current file and initializes Mastercam to a new file state.

If this is set to true and the current file has unsaved changes in it, the user will be prompted to save those changes before the new file is initialized. If true, then instead of actually creating a brand new file, the current file will just be re-initialized. True if successful, else false if not.

Closes any the current file and initializes Mastercam to a new file state.

If this is set to true and the current file has unsaved changes in it, the user will be prompted to save those changes before the new file is initialized. True if successful, else false if not.

Finalizes an instance of the IFileManager.

Closes any current file and initializes Mastercam to a new file state.

This method will not prompt the user to save the current file, nor will it save the current file before closing it. True if successful, else false if not.

This class is used to work with files within Mastercam.

Counts the number of solid or point or note or other chains.

The chains. The ChainKind to count. The number of chains of the specified kind.

Delete chains entities and free the memory allocated for the input chains.

Pointer to the chain, nullptr on output

Chain only solids (wireframe chaining disabled).

PLM, 8/31/2017. [in,out] If non-null, the chains. CHAIN_ESC = user backed out, CHAIN_OK = user didn't back out

Retrieves data about the chains which match the given information.

The operation idn to match. The chain type (TP_CHN_ALL, TP_CHN_DRIVE, etc) to match. The type code to match when TP_CHN_THIRDPARTY is used. The workspace entities chained in matching chains. The Parasolid solid edge tag ids chained in matching chains.

Chain previously selected entities using TEMP2_BIT.

Approx start search point. The resulting chains. CHAIN_ESC = user backed out, CHAIN_OK = user didn't back out.

Chains out from given entity.

Structure for searching a chain. The entity to chain out from. Indicates where on the entity it was selected. The sel bit to flip (TEMP_BIT or SELECT_BIT). The chains formed. CHAIN_MEM_ERR = memory allocation error, 0 = ok.

build a chain from one entity by searching forward and backward.

structure for searching a chain. selected entity. selection parameter. sel bit to flip (TEMP_BIT or SELECT_BIT). true = set chain direction from global chain_direction. true = only add entities in forward direction (for chain_auto). true = don't chain past end point. End point (Last point of old chain for regeneration). [in,out] linked list of chains. (Optional) True if should ignore non-tangent branches (false by default). (Optional) True if arrows should be drawn. -1 = memory allocation error, 0 = ok

Determine whether the chains lie within the given plane.

Any chain that ignore_depth is set for then arcs and lines do not all need to line at same depth as long as each line or arc itself with flat (with depth defined by given orientation) according to chainPlaneTol. Otherwise all points on the geometry must be within chainPlaneTol of eachother in the given orientation. Chains to check. View number of orientation to check the geometry with. Chain plane tolerance (see remarks). If all chain data varies by no more than chainPlaneTol in the 2d orientation given. Returns true if a spline or nurb is used in any of the chains.

Legacy function to check if the chains all lie in the given plane.

Uses the global chain_plane_tol value to call CheckChains3dInView. Chains to check. If all chain data varies by no more than chainPlaneTol in the 2d orientation given. Returns true if a spline or nurb is used in any of the chains. View number of orientation to check the geometry with.

Calculates the number curves (entities) in the chain. Ignores sync and branch information.

The chain. The number of entities in the chain.

Purpose: Count the number of non-empty type chains in a linked list

The chn type (e.g. TP_CHN_DRIVE or TP_CHN_TCB etc.). The chains to check. The total number of type chains.

Chain from entity.

Database pointer to selected entity. Parameter of selected entity. Hash table. Do draw direction arrow. The mode (Full/Single/Section). Linked list of chains/. (Optional) True to pop up construction plane warnings if necessary. (Optional) True to ignore branches that are not tangent. (Optional) True to only extend in chain direction; False to extend in both directions. Chaining error code.

Chains to eptr array.

The chains. Array of eptrs. (Optional) True to validate. (Optional) True to clear array.

Chain to eptr array.

The chain. Array of eptrs. (Optional) True to validate. (Optional) True to clear array.

Is eptr used in chains.

The chains. The eptr. True if it succeeds, false if it fails.

Contour to geometry.

Arguments for the function True if it succeeds, false if it fails.

Destructor

Constructor.

True if got first endpoints. The first entity, first endpoint. The first entity, second endpoint. The last entity, first endpoint. The last entity, second endpoint. The resulting entities.

Argument helper class to pass to CtourToGeometry, so you adon't have to pass the 20+ arguments to the function.

Value used to mark inserted items (bp_tag) in connect_3d_moves.

Connects a 3D moves.

Contour. Depth. Number of points. Maximum points. Maximum depth variance. Incremental depth. Offset distance. True if successful (Optional) True to mark inserted records (bp_tag).

Gets the associations map.

The associations map.

Assignment operator.

Source for the object. A shallow copy of this object.

Destructor.

Copy constructor.

The object.

Default constructor.

Xform Associativity Record

Ends this object.

Remove all assoc data.

Un blank and delete.

Reassign references.

Removes the solid items.

Removes the not group described by mask.

The mask.

Find all matching new and replace them.

The find eptr. The find idn. The new eptr. The new idn. True if it succeeds, false if it fails.

Find all matching old and replace their new.

The find eptr. The find idn. The new eptr. The new idn. True if it succeeds, false if it fails.

Adds record (if assoc found or addEmpty).

The old eptr. The new eptr. The old idn. The new idn. (Optional) True if idns were swapped. True if added.

Gets associativity type.

The associativity bit. True if type exists.

Removes the given mask.

The mask to remove.

Loads the given mask.

The mask to load.

Destructor.

Default constructor.

(Optional) Load in constrctor mask.

Xform Associativity Class.

Defines an alias representing the assoc maps unique pointer.

Defines an alias representing the assoc maps shared pointer.

Update entity 'refs' in database.

The entities to process. Number of entities modified.

Eptr to entity idn.

The eptr. The idn.

Gets associated surfaces.

Surface map. Cons map. (Optional) True to initialize maps.

Gets associated groups.

Map of references. (Optional) True to initialize map.

Gets associated job setup.

Set of idns. (Optional) True to initialize set.

Gets associated toolpath.

Map of references. (Optional) True to initialize map.

Adds to sets.

Set of eptrs. Set of idns. Eptr to add. Idn to add.

Removes from map.

The entity. The map. True if it succeeds, false if it fails.

Gets idns from map.

The entity idn to match. The map. The idns.

Gets keys from map.

The map key to match. The map. The idns.

Eptr map to idn map.

The eptr map. The idn map.

Check if entity is used by other entities.

The entity idn to match. The assoc map. The current bits. The idn bit. Current bit or Current bit plus idnBit if used.

Check if entity is used by other entities.

The map key to match. The idn map. The ass bits. The idn bit. Current bit or Current bit plus idnBit if used.

Adds to idn map.

The key. The identifier. The map. True if it succeeds, false if it fails.

Exists in idn map.

The key. The identifier. The map. True if it succeeds, false if it fails.

Get solid association tags (maps: key = solid.ent_idn, second = tags)

The drafting tags. The plane tags. The toolpath tags. True if it succeeds, false if it fails.

Get solid association pairs.

The drafting pairs. The plane pairs. The toolpath pairs. True if it succeeds, false if it fails.

Remove all assoc data.

Queries if given associations exists.

The mask to check. Mask of existing.

Is dependent.

The entity. Type of the associativity (D_ASSOC/F_ASSOC/S_ASSOC). True if solid dependent on curve, false if not.

What is tag assoc to.

The tag. Assoc bits - T_ASSOC, etc.

Idn to entity eptr.

The idn. The eptr.

Gets entity from entity idn.

The entity idn. The entity. True if it succeeds, false if it fails.

Removes eptr from all maps.

The entity. True if it succeeds, false if it fails.

Removes eptr from all maps.

The entity. True if it succeeds, false if it fails.

Is tag used to solid association.

The tag. Associated drafting entities. Associated planes. Associated toolpath operations. True if it succeeds, false if it fails.

Is entity associated.

The entity idn. (Optional) True to include, false to exclude if item is parent (is map key) Assoc bits - T_ASSOC, etc.

Is entity associated.

The entity idn. (Optional) The mask to check. True if it succeeds, false if it fails.

Gets geometry associated with entity.

The entity. The mask (D_ASSOC, etc). The entities. Associativity found.

Gets tags associated with drafting.

The entity. The tags.

Gets geometry associated with group.

Identifier for the group. The ents.

Gets groups associated with entity.

The entity. List of identifiers for the groups.

Gets geometry associated with plane.

Identifier for the plane. The ents. The tags.

Gets planes associated with entity.

The entity. List of identifiers for the planes.

Gets geometry associated with operation.

Identifier for the operation. The ents. The tags.

Gets operations associated with entity.

The entity. List of identifiers for the operations.

Removes the given mask.

The mask to remove.

Loads the given mask.

The mask to load.

Destructor.

Default constructor.

(Optional) Load in constrctor mask.

Associativity Maps Class.

@par Purpose: Store a pocket boundary @param[in] bound pocket boundary linked list @param[in] view_n view to store in @param[in] color color to store in @param[in] level level to store in

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.

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.

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.

Query if the last entity in the chain is flipped.

True if first entity flipped, false if not.

Query if the first entity in the chain is flipped.

True if first entity flipped, false if not.

Gets the last entity in the chain.

The ent_id of the entity.

Gets the end point position of the chain.

The end point.

Gets the start point position of the chain.

The start point.

Gets entities in the chain.

The chain entities.

Gets the tolerance value

Gets the identifier of the first entity in this Chain.

Gets a value indicating if the Chain contains any Spline(s).

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.

Sets a value indicating whether the chain is flat.

Gets a value indicating whether the chain is flat.

Sets a value indicating whether the chain is a closed chain.

Gets a value indicating whether the chain is a closed chain.

Gets the area within the chain, assuming it's closed.

Sets the direction type of the chain.

Gets the direction type 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 side 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.

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.

The first entity in the chain is flipped.

The last entity in the chain

The end point position of the chain..

The start point position of the chain..

Entities in the chain.

The last entity in the chain is flipped.

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 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 indicates whether or not the chain is a closed chain.

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 start or end point of a chain entity.

The Chain Entity. True to get the first endpoint, false to get the second. The point.

Gets the database ID of the first entity in chain.

The id of first entity in chain.

This method returns the direction of the specified chain object.

The direction of the chain object.

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.

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 is chain closed.

The view the Chain is in. 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.

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. 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.

The Chain class is used for passing and modifying Mastercam chains between operations.

Note that Chain objects cannot be user created via a constructor.

Initializes a new instance of the Chain class.

Smart pointers to Engine objects

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.

Gets the identifier of the first entity in this Chain.

Gets a value indicating if the Chain contains any Spline(s).

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.

Sets a value indicating whether the chain is flat.

Gets a value indicating whether the chain is flat.

Sets a value indicating whether the chain is a closed chain.

Gets a value indicating whether the chain is a closed chain.

Gets the area within the chain, assuming it's closed.

Sets the direction type of the chain.

Destructor.

Gets the direction of the chain.

This class handles all of the interaction for Chain objects within Mastercam.

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).

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.

Merge options - Controls how (inch/metric) units differences are handled, and if to suppress the "associated entities will not be merged" warning dialog.

True to check the (inch/metric) units of the incoming data against the active setting. This only applies if the incoming data is a Mastercam type file.

If true and the units do not match, the File-Merge "units dialog" will be displayed, giving the user the option of scaling the incoming data, or not.

True to mark the merged data as a "result" group.

True to force the merged levels to be set a visible.

The Offset Levels by value.

The Merge Levels options.

True to set to the active Line Width, else false to use incoming width.

True to set to the active Point Style, else false to use incoming style.

True to set to the active Line Style, else false to use incoming style.

True to set to the main color, else false to use incoming color.

Initializes a new instance of the FileMergePatternOptions class.

A class containing the file merge pattern options.

Declares IO Types for File_Merge functionality.

Values that represent the Merge Levels option when doing a FileMerge.

Specifies the offset levels by mode. Offset the incoming levels by this factor.

Specifies the merged file levels mode. Merge into the levels in the incoming data.

Specifies the active level mode. Place all incoming data on the active main level.

Values that represent View (aka. Plane) types.

Working Coordinate System plane.

Graphics view.

Tool plane.

Construction plane.

Undefined plane.

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.

This enumeration specifies the different types of Mastercam graphics views.

This enumeration which specifies the different types of Mastercam "reserved" (system) Cnc::Globals::Planes::GetPlanes ().

The Trimetric plane.

A trimetric graphics view.

The 'reverse' Isometric plane.

A 'reverse' isometric graphics view.

An Isometric plane, which looks at the part from a combined view of the top, front, and left sides.

An isometric graphics view, which looks at the part from a combined view of the top, front, and left sides.

The Bottom plane, looking up from the bottom of the WCS.

A graphics view looking up from the bottom of the WCS.

The Back plane, looking backwards from the back of the WCS.

A graphics view looking backwards from the back of the WCS.

The Front plane, looking forward from the front of the WCS.

A graphics view looking forward from the front of the WCS.

The Top plane, looking down from the top of the WCS..

A graphics view 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.

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.

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.

Declares the IO Types Enumerations classes.

We use the macro PUBLIC_ENUM so we can use those enum in the C-Hook API and in the NET-Hook API

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.

Wait for the user to select a series of entities.

This method exists in order to isolate calls to global selectEnts (...) and allow the mocking of it. 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.

Wait for the user to select an entity. This method exists to isolate call to global select_ent (...) and allow the mocking of it.

Prompt string to display while waiting for the event ("*" to not display the prompt window). A pointer to the structure of the entity the user selected. The eptr of the selected entity. The position of the cursor upon entity selection, in view coordinates. A pointer to the selected entity's t value (or values, depending on the entity type). A combination of selection bit flag types for limiting selection (ie, ALIVE_BIT, etc. 0 for default). A combination of entity mask bit flag types for limiting selection (ie, L_ID, A_ID, SPLINE_ID, etc. 0 for default). The integer value of the color to use for selected entities. Fills a provided bool with a true if the event was returned successfully; false if not. The return code, of the MC_RETURN type, of the function.

Wait for and then get user input of a sketcher point being selected.

The method is there to isolate a call to the global point_proc_assoc (...) function and allow the mocking of it. The maximum number of parameters (mocking) is 10, reason why the body of this method calls the last two parameters as hard coded style... [in] Prompt string to display while waiting for the integer event ("*" to not display the prompt window). [out] 3D point in world coordinates. [in] true = create pt ent if undefined type. [in] if 0, use CONSTR_VIEW_N. [in] if 0, use constr_depth. [in] true = allow solid assoc points. [out] entity used in pt selection. [out] t values used in pt selection. [out] true = successful. [in] select prompt. Return a point, selected entity, input method and t values.

Wait for and then get user input of a sketcher point being selected.

The method is there to isolate a call to the global point_proc (...) function and allow the mocking of it. [in] Prompt string to display while waiting for the integer event ("*" to not display the prompt window). [out] Any point entry code values returned by the point selection (ie, PEC_SKETCH, PEC_ENDPOINT, etc.). [out] The point selected by the user, in world coordinates. [out] Fills a provided bool with a true if the event was returned successfully; false if no. The return code, of the MC_RETURN type, of the function.

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 the chaining flag in all visibly selected geometry.

This method clears the chaining flag in all of a part's geometry.

Sets all of the matching geometry in the current file as unselected.

The geometry mask.

Sets all of the matching geometry in the current file as unselected.

The geometry mask.

Sets all the matching geometry in the current file as selected.

The geometry mask.

Sets all the matching geometry in the current file as selected.

The geometry mask.

Sets all of the geometry in the current file as unselected.

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.

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 (box) selection using a program defined window.

This method is used with the SearchManager::GetGeometry method. When combined with selection flags that method will return the geometry that was selected in this step. 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.

Window (box) selection using a program defined window to select geometry.

This method is used with the SearchManager::GetGeometry method. When combined with selection flags that method will return the geometry that was selected in this step. The geometry mask to use during geometry selection. The first corner of the window. The second corner of the window. (Optional) The type of box selection to be performed. True if it succeeds, false if it fails.

Prompts the user to window (box) select some geometry.

This method is used with the SearchManager::GetGeometry method. When combined with selection flags that method will return the geometry that was selected in this step. The text to display to the user as they're selecting the geometry. The geometry mask to use during geometry selection. (Optional) The type of box selection to be performed. True if the box selection was successful and false if not.

Prompts the user to window (box) select some geometry.

This method is used with the SearchManager::GetGeometry method. When combined with selection flags that method will return the geometry that was selected in this step. The text to display to the user as they're selecting the geometry. The geometry mask to use during geometry selection. (Optional) The type of box selection to be performed. True if the box selection was successful and false if not.

Prompts 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. A list containing all of the selected geometry items.

Prompts 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. A list containing all of the selected geometry items.

Prompts the user to select a single geometry item.

The text to display to the user as they're selecting the geometry. The geometry mask to use during selection. [out] The selected entity. True if it succeeds, false if it fails.

Prompts the user to select a single geometry item.

The text to display to the user as they're selecting the geometry. The geometry mask to use during selection. [out] The selected entity. True if it succeeds, false if it fails.

Prompts 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 entity out value. The prompt text to display. True to allow creating a point entity if needed. True to allow selection on Solids. [out] The associated geometry entity that was selected. [out] Type of the point pick (See remarks!). [out] The point in world coordinates. [out] (Optional) The double[2] 'T' values of the pick location. true if it succeeds, false if it fails.

Prompts 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 entity out value. The prompt text to display. True to allow creating a point entity if needed. True to allow selection on Solids. [out] The associated geometry entity that was selected. [out] Type of the point pick (See remarks!). [out] The point in world coordinates. [out] (Optional) The double[2] 'T' values of the pick location. true if it succeeds, false if it fails.

Prompts the user to select a point position.

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. [out] The selected point coordinates if successful. True if the point was selected or created successfully, else false if not.

Constructs an instance of the SelectionManager.

Finalizes an instance of the ISelectionManager.

Prompts the user to select a point position.

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. [out] The selected point coordinates if successful. True if the point was selected or created successfully, else false if not.

Delete Assignment operator.

Delete move operator.

Delete copy constructor.

Delete move-copy constructor.

This class is used to work with selection within Mastercam.

Gets the Selection Manager.

A pointer to the singleton instance of the Selection Manager.

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 the chaining flag in all visibly selected geometry.

This method clears the chaining flag in all of a part's geometry.

Sets all of the matching geometry in the current file as unselected.

The geometry mask.

Sets all of the matching geometry in the current file as unselected.

The geometry mask.

Sets all the matching geometry in the current file as selected.

The geometry mask.

Sets all the matching geometry in the current file as selected.

The geometry mask.

Sets all of the geometry in the current file as unselected.

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.

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.

Performs window (box) selection using a program defined window.

This method is used with the SearchManager::GetGeometry method. When combined with selection flags that method will return the geometry that was selected in this step. The geometry mask to use during geometry selection. The first corner of the window. The second corner of the window. (Optional) The type of box selection to be performed. True if it succeeds, false if it fails.

Performs window (box) selection using a program defined window to select geometry.

This method is used with the SearchManager::GetGeometry method. When combined with selection flags that method will return the geometry that was selected in this step. The geometry mask to use during geometry selection. The first corner of the window. The second corner of the window. (Optional) The type of box selection to be performed. True if it succeeds, false if it fails.

Prompts the user to window (box) select some geometry.

This method is used with the SearchManager::GetGeometry method. When combined with selection flags that method will return the geometry that was selected in this step. The text to display to the user as they're selecting the geometry. The geometry mask to use during geometry selection. (Optional) The type of box selection to be performed. True if it succeeds, false if it fails.

Prompts the user to window (box) select some geometry.

This method is used with the SearchManager::GetGeometry method. When combined with selection flags that method will return the geometry that was selected in this step. The text to display to the user as they're selecting the geometry. The geometry mask to use during geometry selection. (Optional) The type of box selection to be performed. True if the box selection was successful and false if not.

Prompts the user to select multiple geometry items.

This method retrieves a list of pointers to (base) Geometry type objects. If we wish to get to the data of a specific type of geometry (e.g. point, line, arc). We must down-cast to those specific derived types. This demonstrates retrieving the specific geometry types and gathering them up in separate lists by type. std::vector<IPointGeometrySPtr> points; std::vector<ILineGeometrySPtr> lines; std::vector<IArcGeometrySPtr> arcs; // spGeomList here is what AskForMultipleGeometry returned to us. for (const auto &ptr : spGeomList) { switch (ptr->GetGeometryType ()) { case P_ID: points.push_back(std::dynamic_pointer_cast<IPointGeometry> (ptr)); break; case L_ID: lines.push_back(std::dynamic_pointer_cast<ILineGeometry> (ptr)); break; case A_ID: arcs.push_back(std::dynamic_pointer_cast<IArcGeometry> (ptr)); break; } } } The text to display to the user as they're selecting the geometry. The geometry mask to use during geometry selection. A list containing all of the selected geometry items.

Prompts 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. A list containing all of the selected geometry items.

Prompts the user to select a single geometry item.

This method retrieves a pointer to a (base) Geometry type object. If we wish to get to the data of a specific type of geometry (e.g. point, line, arc). We must down-cast to those specific derived types. This demonstrates down-casting to the specific geometry type. IPointGeometrySPtr point; ILineGeometrySPtr line; IArcGeometrySPtr arc; switch (ptr->GetGeometryType ()) { case P_ID: point = std::dynamic_pointer_cast<IPointGeometry> (ptr); break; case L_ID: line = std::dynamic_pointer_cast<ILineGeometry> (ptr); break; case A_ID: arc = std::dynamic_pointer_cast<IArcGeometry> (ptr); break; } The text to display to the user as they're selecting the geometry. The geometry mask to use during geometry selection. [out] The selected entity. True if it succeeds, false if it fails.

Prompts the user to select a single geometry item.

The text to display to the user as they're selecting the geometry. The geometry mask to use during geometry selection. [out] The selected entity. True if it succeeds, false if it fails.

Prompts the user to select a point position 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 entity out value. The text to display to the user as they're selecting the geometry. True to allow creating a point entity if needed. True to allow selection on Solids. [out] The associated geometry entity that was selected. [out] Type of the point pick (See remarks!). [out] The point in world coordinates. [out] (Optional) The double[2] 'T' values of the pick location. true if it succeeds, false if it fails.

Prompts the user to select a point position 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 entity out value. The text to display to the user as they're selecting the geometry. True to allow creating a point entity if needed. True to allow selection on Solids. [out] The associated geometry entity that was selected. [out] Type of the point pick (See remarks!). [out] The point in world coordinates. [out] (Optional) The double[2] 'T' values of the pick location. true if it succeeds, false if it fails.

Prompts the user to select a point position.

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. [out] The selected point coordinates if successful. True if the point was selected or created successfully, else false if not.

Finalizes an instance of the ISelectionManager.

Prompts the user to select a point position.

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. [out] The selected point coordinates if successful. True if the point was selected or created successfully, else false if not.

This class is used to work with selection within Mastercam.

Gets the Vector Manager.

A pointer to the singleton instance of the Vector Manager.

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 normal 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.

[in] The first point to perform the operation with. [in] 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.

[in] 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.

[in] The point to perform the operation with. The angle of the input vector.

This method performs a cross product on two 2D points and returns the resulting Z component.

[in] The first point to perform the operation with. [in] 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.

[in] The point to be rotated. [in] 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.

[in] The vector to be normalized. A new point representing the normal vector of the input vector.

This method calculates the length of a 2D vector or the distance of a 2D point from the origin.

[in] The point to perform the operation with. The length of the input vector.

This method performs a dot product on two 2D points.

[in] The first point to perform the operation with. [in] The second point to perform the operation with. The dot product value of the two input points.

This method performs a scaling operation on a 2D point.

[in] 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.

[in] The first point to perform the operation with. The value with which to scale the first point. [in] 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.

Clean-up an instance of the IVectorManager.

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.

This class handles vector operations between different mathematical objects.

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.

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.

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.

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.

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.

Constructs an instance of the OperationManager.

Finalizes an instance of the IOperationManager.

Gets the ID of the highlighted operation in toolpath manager tree.

The ID of the operation if an operation branch is highlighted in the tree, else 0.

Delete Assignment operator.

Delete move operator.

Delete copy constructor.

Delete move-copy constructor.

This class provides utility funtions on the Operation Manager.

Gets the Operation Manager.

A pointer to the singleton instance of the Operation Manager.

Finalizes an instance of the IOperationManager.

Gets the ID of the highlighted operation in toolpath manager tree.

The ID of the operation if an operation branch is highlighted in the tree, else 0.

This class provides some utitlity functions on the Operation Manager.

Gets string from GUI resource file.

The resource id. The string.

Merge solids history tree with a layout.

The layout. True if it succeeds, false if it fails.

Sets solids history tree with a layout.

The layout. True if it succeeds, false if it fails.

Gets solid tree layout.

The history tree layout if the UI history tree exist, else nullptr.

Sets merging pre 2023 file.

True if is pre 2023 file, false if not.

Sets old identifier numbers.

The old identifier numbers.

Sets solids from file.

The value.

Gets solids from file.

The solids from file.

Gets the renaming flag.

True if renaming.

Gets the merging flag.

True if merging.

Sets the merging flag.

True if merging.

Hilite selected.

True to hilite.

Clears the selected operation highlight.

Gets layout codes.

The layout codes.

Sets solid tree layout.

The hist tree ent.

Gets solid tree layout.

The history tree entity. (Optional) True to exclude, false to include the toolpath ops. True if it succeeds, false if it fails.

Gets the last sibling.

The last sibling.

History tree dialog get selected solids.

The solid bodies.

History tree dialog get group position.

The solid. Handle of the group. Handle of the sibling. Handle of the solid item.

History tree dialog set solid position.

The solid. The solid position. The group position. Name of the group. True if group expanded. Identifier for the group.

Refresh solid.

The solid. (Optional) True to skip add on remove failure. True if it succeeds, false if it fails.

History tree dialog get solid position.

The solid. The solid position. The group position. Name of the group. The group expanded state. Identifier for the group.

Sets a redraw.

True to redraw.

Query if this object is enabled.

True if enabled, false if not.

Resets this object.

Enables this object.

Disables this object.

Select solid.

The solid eptr. True to select, false to deselect.

Clears the selection.

History tree get first selected operation.

the solid. zero-based index of the operation. True if it succeeds, false if it fails.

Gets the first selection.

The solid. Zero-based index of the operation. True if it succeeds, false if it fails.

Select operation.

The solid. Zero-based index of the operation. (Optional) True to reset selections.

Updates the stop.

The solid. The newidx.

Removes the stop described by solid.

The solid.

Removes the operation.

The solid. Zero-based index of the operation.

Updates all toolpath images.

Retrieve a Group from the Solids Manager History Tree by name.

Group name. (Optional) Group to begin searching in. The group.

Create a Group in the Solids Manager History Tree.

New group name. (Optional) parent of the new group (or null). (Optional) Group to insert the new group after (or null). The group.

Empty tree control.

Expand solid.

The solid. (Optional) True to expand. (Optional) Handle of the solid item.

Query if this object is alive.

True if alive, false if not.

Suppress tool.

The tool pointer. True to to suppress.

Sets operation name.

The solid. Zero-based index of the operation. The name.

Sets operation image.

The solid. Zero-based index of the operation. True if suppressed.

Sets operation flags.

The solid. Zero-based index of the operation. True if is dirty, false if not. True if is invalid, false if not.

Adds a stop.

The solid. Zero-based index of the. (Optional) Handle of the solid item.

History tree update stop operation.

The solid. Zero-based index of the.

Updates the ops.

The solid. The old indeces. The new indeces.

History Tree Dialog add operation.

The solid. The operation index. (Optional) Handle of the solid item. (Optional) True if new operation.

Adds a tool solid.

The solid. The after solid. Zero-based index of the operation. (Optional) The solid tree position. (Optional) The solid group tree position. (Optional) Identifier for the solids group tree. (Optional) Name of the solids group tree. (Optional) True if solids group tree expanded.

Removes the solid.

The solid. (Optional) The previous solid. True if it succeeds, false if it fails.

Adds a solid to end of this solids group to 'after'.

The solid. [in,out] The after. [in,out] If non-null, the group.

Adds a solid.

The solid. The solid item. (Optional) The after solid. (Optional) Handle of the group. (Optional) Handle of the after tree item. (Optional) The solid tree position. (Optional) The solid group tree position. (Optional) Identifier for the solids group tree. (Optional) Name of the solids group tree. (Optional) True if solids group tree expanded.

Executes the 'keymap' operation.

The create struct. True if it succeeds, false if it fails.

Clears the cached tree.

Sets the cached tree.

Sets the hist tree layout.

The value.

Gets the hist tree layout.

The hist tree layout.

Clears the items.

Adds an item.

The indent. The idn. The type. The operation idex. True if is expanded, false if not. The description.

Return the entity type (for ClassEnt)

Return the entity type. -

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.

destructor.

Default constructor.

A representation of a history tree item.

Mastercam History Tree entity class.

Destructor.

Constructor.

By default, instantiating an MCWaitCursor object turns on the wait cursor. When the object goes out of scope, the normal cursor is displayed. When multiple, "nested" instantiations occur, the normal cursor is not displayed until all objects go out of scope. By passing "enable" as false, this class will turn off the wait cursor (if currently displayed) and prevent any "nested" instantiations from turning it on. The wait cursor will be prevented from being turned on until the object that turned it off goes out of scope. (Optional) If false, dont't display the wait cursor.

Copies the EA type entry into the data array.

Index of EA type (EA_POINT, EA_LINE, etc). EA type entry.

Displays the Entity Attributes Manager dialog.

The parameter (not used). 1 = User exited dialog with OK, 0 = exited with Cancel button.

Remove boundary from Graphics view.

Checks if a polygonal mesh is in use by the GAF.

Polygonal mesh ID. True if in use, false otherwise.

Draws either a start or a end direction for the given entity.

The entity to draw the arrow for. True to draw, false to erase. (Optional) True (default) for start arrow. False for end arrow. (Optional) Output start point (returned if start, no draw on match if !start). (Optional) If specified and true then use YELLOW color. (Optional) If = 0 use static arrows. Otherwise id for selectable arrow. (Optional) True if cursor should be moved to base of arrow for drag function.

Draws direction and side arrows at the point on the entity specified by the tVal.

Uses info about the op for side arrow. The entity to draw the arrow for. The parameter to draw the arrow at. True to draw, false to erase. (Optional) True (default) for start arrow. False for end arrow. (Optional) True if chain direction is opposite entity direction. False (default) if chain direction same as entity direction. (Optional) True to draw direction and side arrow. False (default) just to draw direction arrow. (Optional) Output start point (returned if start, no draw on match if !start). (Optional) If specified and true then use YELLOW color. (Optional) If >= 0 then the id to use to make the arrow selectable. (Optional) True if cursor should be moved to base of arrow for drag function.

Searches the display list for an autocursor position at the specified cursor position and sets the fast data object appropriately.

Cursor position. Event modes. Entity mask. Fast data object. Returned point entry mode. If true, don't include temporary points (repaint and GrTemp points). Set to true if autocursor position is a temporary center point. Set to true if autocursor position is a temporary midpoint.

Restore the backup stock boundaries, left/right and graphics.

Display any list of deferred message box messages and reset.

(Optional) The description. If omitted, "There were one or more errors or warnings encountered." will be used. (Optional) The caption. If omitted, "Errors or Warnings" will be used.

Initialize a list of deferred messages.

Get Planes origin world/view coordinates setting.

Returns true if user wants world coordinates, and false if the user wants view coordinates.

Adjusts the given plane to be with respect to the current WCS.

Plane to adjust.

Gets the current GPlane matrix.

GPlane matrix.

This method rotates the graphics view top_in, top_out, right_in, or right_out by some multiple of the current 'rotate' factor.

Amount to rotate right. Amount to rotate top.

Sets the size and position of the view cube.

The size specifies the "desired" width and height of the cube proper. However, since the arrows and labels extend past the cube, the cube size is reduced to prevent the arrows and labels from being obscured by the overlay controls. The reduced cube is a little less than 1/2 the specified size. If the overlays are translucent, it may be okay for the labels and possibly the arrows to extend into the overlay region. To do so, specify an "adjust" value greater than 1. Cube size (pixels). X position of center of cube (pixels). Y position of center of cube (pixels). (Optional) Factor for adjusting cube size: GT 1. to increase; LT 1. to decrease.

Marks all of the specified entities as hidden.

A sorted vector of eptrs.

Finds all currently hidden entities.

A sorted vector of eptrs.

Shows the manager bar.

The bar type to show. (Optional) True to show, false to hide. True if previously visible, false if not previously visible.

Checks if the graphics are being repainted.

If true, the graphics are being repainted.

Determine foreground color.

A COLORREF.

Animates the transition from the starting view matrix to the ending view matrix.

Starting view matrix. Ending view matrix. Position about which the transform is performed.

Animates the transition (rotations and zoom) from the current view to another.

Plane matrix that represents the target view.

Checks if it's okay to highlight an entity.

True if okay to highlight, otherwise false.

Issues messages making it appear as though the mouse has moved.

Call this function when a mouse move is required to update the graphics viewport correctly. It works by moving the cursor one pixel then moving it back that one pixel.

Gets the names of files from last drag and drop operation.

Names of files from last drag and drop operation. True if it succeeds, false if it fails.

Fit screen to current wireframe manager objects.

Dirties the specified display list entry.

Display list entry.

Dirties the specified entity's display list entry.

Pointer to entity.

Dirties the specified entity's display list entry.

Entity eptr.

Dirties the display list entities.

The "view dirty" flag indicates that view dependent wireframe entities (namely drafting entities) should be checked to determine if view conditions are suitable for displaying the entities. (Optional) If true, set the "view dirty" flag.

Should drafting entity be processed in this graphics view.

The entity. The view. true, process in this view. false, do not process in this view.

Enables/Disables the most recent dlg within the function panel.

(Optional) Enable or Disable. Returns the previous enabled state of the panel. Zero if previously enabled, non-zero if previously disabled.

Sets the global "pen_width" value based on the hardcopy settings and specified width and color.

Line width. Line color. Previous pen width.

Enables/disables glow highlighting.

If true, enable; if false, disable.

Sets the opacity of dimmed wireframe.

Opacity [0, 100].

Sets the opacity of dimmed wireframe.

Opacity [0, 100].

Enables/disables dashed wireframe highlighting.

If true, enable; if false, disable.

Resets render highlight properties for GAF solids.

Initiailzes stipple data for GAF graphics.

Sets whether or not the wireframe lines are sorted.

Use this call to turn off sorting when building the display list during a file load. If true, the lines are sorted. Previous sort state.

Executes the file save dialog operation.

(Optional) true to force the "File/SaveAs" dialog instead of "File/Save. false if user clicked Cancel or save operation failed, otherwise true

Combine views.

True to output text. An int count of views removed.

Hist tree dialog refresh solid.

The solid. (Optional) True to skip add on remove failure. True if it succeeds, false if it fails.

Re-initializes the main graphics view's OpenGL rendering context.

Draw automatic highlight on entity.

The face tag is recognized only when solids are being highlighted by faces. The entity. (Optional) Tag of solid face to highlight. True if it succeeds, false if it fails.

Highlights the closest entity to the given screen location (within sel_dist).

Cursor position. Selection mask. Selection bits. Event mode flags. True if it succeeds, false if it fails.

Gets the current clipping bounds in View Coordinates.

X minimum. Y minimum. X maximum. Y maximum.

Gets geo filename.

The geo filename.

Gets the bounding rectangle of the specified surface.

The surface header. The VC bounding box (invalid if error).

Adds an entity to the display list.

The entity to add. Display list pointer (nullptr if error).

Enables/disables redraw and refresh of operation manager tree.

True to enable, false to disable the redraw. True to enable, false to disable the refresh.

Destructor.

Constructor.

True to disable redraw. True to disable refresh.

Disable operation manager tree class.

Set operation parameters to associated machine parameters.

The operation idn. (Optional) true to update axis combo. true if successful, false otherwise.

Set operation parameters to associated machine parameters.

Group the machine belongs to. The machine. Operation to update. True to update the progrma number. (Optional) True to update axis combo.

Set operation parameters to associated machine parameters.

The control. Operation to update.

Set operation parameters to associated machine parameters.

Operation to update. (Optional) true to update axis combo. true if successful, false otherwise.

Create an operation group.

The edit_properties feature will only work of the machine is not an MT machine. This is because the machine must be properly loaded and initialized before the JobSetup data and dialog can make available. The group name. The product code. (Optional) The parent group idn. (Optional) True = if non-MT then launch edit dialog properties. (Optional) True to use insert arrow. Null if it fails, else a pointer to an op_group.

Query if OpMgr's red insert arrow resides in a locked group.

(Optional) True to also check parent groups. True if OpMgr's red insert arrow resides in a locked group, false if not.

Fits the screen to the specified bounding rectangle.

The VC bounding rectangle.

Given the bounding rectangle, adjust the screen dimensions (wk_center and wk_height) and plotter dimensions (plot_scale, plot_x_offset, and plot_y_offset) so the picture fits perfectly.

The VC bounding rectangle.

Gets automatic highlight entity.

The entity. The selection values. The point on entity. True to erase. True if it succeeds, false if it fails.

Displays a warning message in upper right corner of graphics screen.

Window starts expanded if "wait" is negative or "text" is a single line. The text. (Optional) The number of seconds to display the warning window.

Given a list of visible levels, turn on those levels and turn off all other levels.

The list of visible levels.

Get a list of all currently visible levels.

A list of visible levels.

This method handles a request for real input modally.

Pointer to prompt string. Initial value. Minimum value. Maximum value. Point where the dialog will be positioned beside. Returned "real" value input by user. Returned success flag. (Optional) Pointer to offset of dialog from "pt". Default is (20, 20) - right 20, down 20. Mastercam error code (MC_NOERROR, etc.).

This method handles a request for real input modally but uses a single character representing a double (e.g. '9') as the starting input.

Pointer to prompt string. Initial value as a char. Minimum value. Maximum value. Output: Returned "real" value input by user. Output: Returned success flag. Mastercam error code (MC_NOERROR, etc.).

Sets the color of the repaint points.

Mastercam color.

Gets a vector of all of the repaint points.

Repaint points.

Gets the repaint point at the specified index.

Point index. Point at specified index or (0., 0., 0.) if invalid index.

Gets the number of repaint points.

Number of points.

Clears the repaint points.

Removes all occurrences of a repaint point.

The point in world coordinates. True if it succeeds, false if it fails.

Adds a repaint point.

The point in world coordinates. (Optional) True to allow, false to deny duplicates. True if it succeeds, false if it fails.

Adds a repaint point.

Pushes a new set of repaint points on the stack.

(Optional) If true, current points are copied to new repaint points; if false, new repaint points are empty.

Fit version 2.

(Optional) If non-zero, only entities with a matching selection bit are fitted. (Optional) True to repaint the graphics. (Optional) True to fit to screen. (Optional) True to prevent screen overlays from affecting the fit.

Fit currently displayed entities to device-context.

The DC (window). (Optional) The graphics view. (Optional) The background color.

Fit currently displayed entities to device-context.

The graphics view. The background color. The geometry color. The DC (window). The percentage to adjust fitting. The mode (Fit/Draw/Both). The minimum X coordinate. The maximum X coordinate. The minimum Y coordinate. The maximum Y coordinate. (Optional) If non-null, (Optional) state of the graphics.

Values that represent fit DC modes.

Initialize database.

(Optional) If true, we're doing a File New. (Optional) If true, show warnings. (Optional) If true, we're doing a full initialization (e.g. File New, File Open). (Optional) True to prompt to save.

Checks for current database changed. If so, starts the File/Save process.

False will prompt user if they wish to save, true assumes yes. True will allow saving to file (argument from init_db) True will always do a File/SaveAs instead of a File/save true if save happened, false if user cancelled

Add a file name to a recent file list.

The name of the file to save in the MRU. (Optional) alternate registry key name if not saving in default location.

Force a redraw to the externally set off screen target.

Used for creating thumbnails or copying the screen to the clipboard. RBGA pixel data is returned if all goes well, otherwise the vector is zero length. Optional pixel rescaling value, default is 1. Optional flag to do special thumbnail scaling, default is false. Optional width of DC image. Optional height of DC image. Vector of result fbo pixels, resized to 0 elements if error.

This function immediately repaints the overlay display lists only.

Call RepaintGraphics to repaint all display lists.

Restores the cursor state.

Cursor state obtained via SaveCursor.

Saves the cursor state.

Cursor state.

Freezes the graphics viewport by preventing it from being repainted.

Call this function to prevent changes to the viewport during certain execution sequences, such as using the temporary database. If, for some reason, a sequence causes the viewport to be cleared or otherwise modified in some way, set "capture" to true. When true, the viewport is captured as a BMP and subsequently copied back to the viewport for repaints. If the global rebuild_in_repaint is true for a repaint at any time the viewport is frozen, it will be set true when the viewport is repainted when thawed. If true, freeze the viewport; if false, thaw and repaint the viewport. (Optional) If true, capture the screen and use it for repaints.

Updates the geometry display color.

Builds the display list.

Check if view matrices are parallel.

First matrix. Second matrix. true = parallel but Z are opposite. true = Views are parallel.

Views parallel.

Number of first view. Number of second view. True if Z are opposite. True if views are parallel. Cursor state for SaveCursor/RestoreCursor

Updates configuration questions.

The parent window for any message boxes. The low question. The high question. True if it succeeds, false if it fails.

Reads the "automatic restart after crash" setting from the registry.

The value if it is found in the registry, or TRUE if it's not.

Writes the "automatic restart after crash" setting to the registry.

True to attempt restart, otherwise FALSE.

Check the regen subfolder when the temp folder changes.

Previous root of the temporary folder. true if the regen folder was changed, otherwise false.

Force "End Selection" button enabled.

True to force button enabled. Previous setting.

Force "Clear Selection" button enabled.

True to force button enabled. Previous setting.

Values that represent the different GS_SLD_BUTTON types.

Repaint only the groups.

List of identifiers for the groups.

Executes the screen fit to point action.

The center point to fit to.

Executes the screen fit action.

The z depth.

Repaint graphics with hidden draw result.

Set up the render_cfg for shaded outline mode.

Whether or not to repaint the graphics immediately.

Set up the render_cfg for dimmed wire mode.

Whether or not to repaint the graphics immediately.

Set up the render_cfg for hidden wire mode.

Whether or not to repaint the graphics immediately.

Cause surface and solid display lists to be recomputed and optionally displayed.

Whether or not to repaint the graphics immediately.

Sets current render mode.

The new mode.

Gets current render mode.

The current render mode.

Gets the state of section view display.

True if Active.

Sets state of section view display.

True to activate. Previous value.

Menu access function to call toggleSurfaceBacksideShading.

Gets the solid entity from a body tag.

The body tag. The solid entity.

Adds a body and face tags to selections.

The body tags. The face tags. List of types of the bodies. List of types of the faces. True if it succeeds, false if it fails.

Clears the global toolpath arrays.

Forces the graphic regeneration of solids marked as dirty.

Gets current lathe body tag.

The file global CurrentLatheBodyTag.

Sets current lathe body tag to be used in ValidateTurningTesselationTolerance.

The file global CurrentLatheBodyTag.

Validates that a spun profile can be created for the given turning tessellation tolerance and CurrentLatheBodyTag.

The turning tess tolerance. The Parasolid version. True if it succeeds, false if it fails.

Remove a solid from the list of new solid ents that have been loaded by a CAD File Importer.

Pointer to a Solid. true if the solid was found and removed form the list, false otherwise.

Set the Name and Solid Group of a newly imported Solid.

The Mastercam Solid entity. The name in the incoming CAD file, with '|' characters separating assemblies/sub-assemblies/parts.

Compare 2 Parasolid faces for coincidence.

tag of first Parasolid face. tag of second Parasolid face. true if the faces are coincident, false otherwise.

Regenerate associated one operation(s)

The solid body or null_eptr for all. True if all successful.

Get toolpath tags.

The tags.

Get SldAssocOneOp selection ids.

List of SldAssocOneOp selection ids.

Gets solid name.

The method extends sld_get_description in order to get the default name if the solid is not named yet. The Source eptr of solid from which to get the name. The name of the solid.

Sets solid tangent selection tolerance.

The tolerance must be in the range 0.0 smaller or equal to tol smaller than 90.0 degrees. Any value outside the allowable range is ignored. The new value (radians). The previous tangent selection tolerance (radians).

Gets solid tangent selection tolerance.

The tolerance is in the range 0.0 smaller or equal to tol smaller than 90.0 degrees. The solid tangent selection tolerance (radians).

Solid-edge-type specific highlight color associated with active theme..

Returns hightcolor color (as index).

Highlight color associated with active theme..

Returns hightcolor color (as index).

Solid-edge-type specific select color associated with active theme.

Returns select color for given edge type (as index).

Select color associated with active theme..

Returns select color (as index).

Style associated with active theme.

Returns line style (LINESTYLE_*).

Line width associated with active theme.

Returns line width as double (pixel).

True iff active theme is chaining.

Returns true iff chaining theme is active.

Active theme type.

Returns the theme type that is active.

Set the current theme.

The theme type to switch to. true (default) if need to reset graphics. Returns theme type being replaced.

Destructor.

Static instance of class that maintains the current state.

Constructor - utility access only.

Check if solid face is based on or related to a wireframe chain.

The solid face tag. True if solid's base operation is associated to a chain. True if any operation in the solid is associated to a chain. True if the operation that created this face is associated to a chain.

Find matching circular edges.

Tag of source edge. Arc to match. Matching edges. True if it succeeds, false if it fails.

Gets the selected solids tag(s).

The selected Parasolids tag #1. The selected Parasolids tag #2. The type of the tags - SLD_NONE if both tags are zero.

Sets the specified tag(s) as the selected solids tag(s).

Call this function with no arguments to clear out the selected tags. (Optional) Type of the selected tag(s). (Optional) The selected Parasolids tag #1. (Optional) The selected Parasolids tag #2. True if either tag has changed, false otherwise.

Checks all solid entities to ensure the select bit is set only for those that match one of the specified tags.

Body tags.

Gets the currently selected bodies and faces.

Body tags. Face tags.

Sets the currently selected bodies and faces to the specified tags.

Body tags. Face tags.

Activates solids selection.

Enhanced face selection entity mask or zero for normal solids selection.

Creat a solid temp file of the faces in array.

[in,out] The selected faces. (optional) Flag for closing the current temp file. (Optional) True to highlight faces.

See if all faces of the body in selected faces array.

The body tag. The selected faces. True if all the body's faces are, false if not.

Add or remove windowed faces in array.

Set of ips defining window on graphics screen. The array of selected faces. true if selFaces was changed, false if it was not.

Add or remove all faces of the solid body faces in selection array.

The body tag. The array of selected faces. true if selFaces was changed, false if it was not.

Add or remove array of tags in selection array.

The array of new tags. The array of selected tags. true if selTags was changed, false if it was not.

Add or remove tag in array.

The tag. The array of selected tags. true if selTags was changed, false if it was not.

Deletes the solid plane association information from the solid.

Solid entity identification number Selection identifier for the plane face/point within the solid. true if deletion was done, false if not.

Gets the edge tolerance of a solid edge.

Solid tag. The edge tolerance value.

Check if a solid descriptor is already in use and if so, append a number so it will be unique.

[in,out] The proposed solid name. (Optional) If we are making surfs need to make sure level names are unique.

Create curves from the provided set of faces that do not contain edges shared by multiple faces.

The solid faces. The Mastercam eptrs of any curves created. true to include only open edges (on sheet bodies). Include outer, inner, or both types of loop edges (solid body or face).

Gets the auto-highlight face.

Tag of the face to highlight.

Sets the auto-highlight face.

Tag of the face to highlight.

Select solid faces and bodies using the face or body ID number. Similar to sld_sel_solid_surfs this function but takes an existing list of faces to select rather than opening a selection screen.

[in,out] The faces to be selected. [in,out] The bodies to be selected..

Deletes the data within a body face structure array described by bodyStructs.

Array of body structs for which data is to be deleted.

Generates a body face structure array.

Use the DeleteBodyFaceStructArray () function to delete data within returned bodyStructs array. The selected bodies. The selected faces. Array of body structs.

Convert selected solid enities to Mastercam ents.

Conversion parameters. Array of selected solid bodies. Array of selected solid faces. Array of selected solid edges. Array of newly created Mastercam entity eptrs. Array of entity colors. Array of entity levels. Set to true if operation was interrupted. Indicates whether to use the untrimmed surface level dialog, or skip past it.

Converts a parasolids transform to a mastercam transformation matrix.

The parasolids transform to convert from. The mastercam matrix to convert to. true if it succeeds, false if it fails.

Updates the associative plane ID in all solid operations that use it, leaving plane information (matrix and normal) unchanged.

Old plane identifier. New plane identifier. true if any updates were made, false if none.

Is plane used by single solid.

ID of the plane. True if plane is used by a single solid, false otherwise.

Gets a map of plane IDs, eptrs and solid indices used in solids.

The MastercamPlanes object to extract all the plane ID's from. The map.

Gets plane usage in solids.

The solid eptrs that get stored in the eptrArray parameter contain the 'absolute target' solids and NOT tool eptrs. ID of the plane. [in,out] Array of solid eptrs that are using the plane. (Optional) Maxismum number of eptr to be collected into eptrArray. True if the plane is being used by solids.

Updates any solid operations, using the given plane, so that the operation's plane parameters reflect that of the given plane.

ID of the plane. The normal of the original named plane. @par Purpose: Look for unassigned toolpath operations of requested type in this solid and assign them to the given sld_opid @return true if successful @param[in] sldEptr solid used in solid operation @param[in] toolp_type Surface type - Drive(2) DRIVE_FLAG or Check(4) CHECK_SURF_FLAG @param[in] sld_opid Solid op ID to reset @par Purpose: Turn off toolpath assignment so that toolp op may be reselected @param[in] sld_eptr solid used in solid operation @param[in] sld_opid Solid op ID to reset @param[in] surfFlag flag for surface type @par Purpose: Complete solid surface temporary arrays and temp files after selection @return true if solid selection modified @par Purpose: Initialize the solid surface temporary arrays and temp files to prepare for selection @return true if successful @param[in] op_idn operation used for initialization @param[in] srfType Surface type flag - Drive(2) DRIVE_FLAG or Check(4) CHECK_SURF_FLAG @par Purpose: Assign solid operation IDs to the solid operations @return true if successful @param[in] toolp_type solid operation type @param[in] solid_ent solid entity used in the operation @param[out] sld_opid solid operation ID assigned @param[in] chkSurfFlag flag for check surfaces @par Purpose: Add all select solid body (mcEnts) to the toolpath selection list @param[in] ignoreNonVisibleEnts true- skip over non visible solids @param[in] resetSurfType true- clear prev surf type flag on already selected solids @par Purpose: Initialize foer solid surface selection @param[in] srfType Surface type - Drive(2) DRIVE_FLAG or Check(4) CHECK_SURF_FLAG

Sets the given variables with the lathe parameteres of the specified operation.

The eptr to get the solid op from. The id of the solid op. The parameter structure to set. The variable to set with the operation's Parasolid session behavior to use. True if it succeeds, false if it fails.

Get the normal vector of a flat face and the face tag. Note: The face tag is temporary, not permanent. It can be used for selection highlighting but not stored in the database.

The normal vector. The point. The face. If non-null, the canceled flag. (Optional) true to disable, false to enable the general selection bar. (Optional) The custom prompt. true if it succeeds, false if it fails.

Get the normal vector of a flat face.

The normal vector. The point. If non-null, the canceled flag. (Optional) true to disable, false to enable the general selection bar. (Optional) The custom prompt. true if it succeeds, false if it fails.

Get the solid faces located in a window

The mode : 1: inside, 2: in + intr, 3: intersect, 4: out+intr, 5=out Lower left corner. Upper right corner. true = all faces must come from one body. Body that faces must come from (Optional - may be NULTAG). [out] Array of selected faces.

Get the solid edges located in a window

The mode : 1: inside, 2: in + intr, 3: intersect, 4: out+intr, 5=out Lower left corner. Upper right corner. true = all faces must come from one body. Body that faces must come from (Optional - may be NULTAG). [out] Array of selected edges.

Extracts the specified lathe profile chains information from the TP ents.

Identifier in the database for the solid history file. Identifier in the solid history file for the chain. The chain data to fill. (Optional) If not null, the flag to set if there TP data that could not be formed into chain data. True if it succeeds, false if it fails.

Loop to chain.

The tag of loop to be converted. Information describing the direction & partial loop edge. The list of edges to add to. The list of curves to add to. The list of start points to add to. The list of number of curves per chain. (Optional) True to create Mastercam Geometry. True if it succeeds, false if it fails.

Gets highest unused level.

The highest unused level.

This should only be used to import Parasolid tags into Mastercam via File::Open and File::Merge of a non-Mastercam CAD file importer. Use sld_convert_tags_to_mc_ents() or sld_convert_CArray_tags_to_mc_ents() from within Mastercam

The solid tags read into kernel. Additional scale factor to apply. If true, create solid entities. If true, create surface entities. If true, create wireframe entities. If true, heal the body with BodyShop. If true, attempt to create Mastercam hole features. Color to assign to each tag (or NULL for none). Optional name to apply to new solid entities. Incoming Filename (it will be applied to the Solid(s) if no solidName is given. The number of solid tags added to the Parasolid kernel.

Read Parasolid transmit file data into Parasolid kernel.

If non-null, filename of the transmit file. The solid tags read into kernel. The number of solid tags added to the Parasolid kernel.

Read Parasolid transmit file data into Parasolid kernel.

If non-null, filename of the transmit file. The solid tags read into kernel. The bounding box minimum point. The bounding box maximum point. The number of solid tags added to the Parasolid kernel.

Gets solid toolpath operation hole face center lines.

The sld eptr. Identifier for the toolp. The data. Options for controlling the axis. (Optional) True to ignore orientation. True if it succeeds, false if it fails.

Gets the bounding rectangle of a solid mapped to the current view.

The solid. The VC bounding rectangle.

Gets the bounding box of all solids.

The WC bounding box.

Gets the bounding box of a solid.

The solid. The WC bounding box.

Gets the bounding box of a solid mapped to a view.

The solid. The view number. The VC bounding box.

Gets the bounding box of a solid mapped to a view.

The solid. The view matrix. The VC bounding box.

Creates geometric DB entities at the intersection of the plane and the solids/surfaces.

The list of solids is internal and is filled when calling sld_prep_face_for_slice. The plane's origin point. The plane's normal vector (i.e. Z). Slice spacing for multiple slices. The list of eptr to the new curves entities on the intersection that were created. (Optional) Set of plane points and normals where slices are made. True if it succeeds, false if it fails.

Pre-populates the internal data required to invoke the sld_extract_curves_on_plane function.

The size of the body index list. The body index list. The size of the face list. The face index list/array. (Optional) Surface type

Restore rollback state of the solid after rolled by SldRollToolp.

Used for drill tool paths which are modified outside of the solid operation. The solid eptr. Identifier for the solid tool path operation. Zero-based roll index at time of call to SldRollToolp.

Rollback to tool path operation for modification.

Used for drill tool paths which are modified outside of the solid operation. The solid eptr. Identifier for the solid tool path operation. Zero-based index of the original roll back state used in SldUnrollToolP. True if it succeeds, false if it fails.

Sld delete orphan toolpaths.

(Optional) A loaded IInterrogateMastercamFile class.

Sets the solids select outer cliff action.

Sets the solids select outer loop action.

Sets the solids select inner wall action.

Sets the solids select inner cliff action.

Sets the solids unselect previous branch action.

(Optional, ignored) the command. MC_NOERROR.

Sets the solids select linked edges action.

(Optional, ignored) the command. MC_NOERROR.

Sets the solids select advance branch action.

(Optional, ignored) the command. MC_NOERROR.

Sets the solids select alternate branch action.

(Optional, ignored) the command. MC_NOERROR.

Sets the solids select activate all/single action.

(Optional, ignored) the command. MC_NOERROR.

Regenerates a single solid.

This function is distinct from sld_regen_solid (Solids_CH.h) because the markDependentOpsAsDirty argument should not be available externally. Database pointer to the solid to regenerate. True to regenerate even when solid is not marked as dirty or invalid. True to mark dependent toolpath operations as dirty. This should be set to true in all cases other than database reading.

Regenerates all solids.

This function is distinct from sld_regen_solids (Solids_CH.h) because the markDependentOpsAsDirty argument should not be available externally. True to regenerate even when solid is not marked as dirty or invalid. True to mark dependent toolpath operations as dirty. This should be set to true in all cases other than database reading.

Solids tree regen all command.

(Optional) unused parameter. An error code.

Convert surface entity to sheet solid entity.

Surface Entity. Sheet Solid Entity.

Modify a solid primitve used as a preview in bounding box and maintain selected face tag information.

The solid primitive paramters. The solid primitive eptr. The face tag to track.

Returns the Data0 face sequence number for a primitive solid face.

The face tag. The primitive face sequence number.

Save solids.

[in,out] A MCFile to process. True to save with mask. [in,out] The added solid ent identifier.

Add faceTag and all tangent faces to passed array.

The face tag. From body tag. The selected faces. (Optional) True to only select from one solid body. (Optional) The angular tolerance in radians (angle between face normals).

Add edgeTag and all tangent edges to passed arrays.

The edge tag. From body tag. The selected edges. (Optional) If non-null, (Optional) the edge references. (Optional) True to prompt for references. (Optional) True if selection must come from one body. (Optional) The angular tolerance in radians.

Does multiple sld_pick() and adds selected bodies, faces, and edges to arrays.

On entry, pSelBodes, pSelFaces, and pSelEdges. Pointer to currently selected body tags (updated on return). Pointer to currently selected face tags (updated on return). Pointer to currently selected edge tags (updated on return). If true, all currently selected tags are from one body. Prompt if only one body selected. Prompt if more than one body selected. Pointer to returned flag indicating user has canceled out of the selection. If true, the General Selection bar will be disabled during selection. If true, all selections must be from one body. Enhanced face selection entity mask or zero for normal solids selection. (Optional) True to allow hist tree selection. (Optional) Solid in hist tree selected. (Optional) If true, use edge highlighting for faces and bodies. True if successful (even if nothing selected), false if there's a get_event error (i.e. unsolicited event such as MC_EXITFUNC).

Get cylinder face radius.

The face. The radius. The location. The axis. True if it succeeds, false if it fails.

Test solid face to see if it is a cylinder.

The face tag. The radius in Parasolid units if face is a cylinder. The convexity if face is a cylinder. true if face is a cylinder.

Select solid bodies, faces, and/or edges at a specified screen position.

Screen position at which to look for hits. Type of hits to search for SLD_EDGE, SLD_FACE, SLD_BODY. Returned hit data. (Optional) If true, check if hit positions are hidden by any shaded entities. (Optional) If true, do color check if masking on color. (Optional) Mask of edge types (ignored unless SLD_EDGE specified). The number of hits returned.

Identify solids at screen position.

The screen position. The solid hit. (Optional) True to repaint. (Optional) True to update selection. (Optional) Ignore this tag. Number of hits or Zero.

Get center point of a solid face.

Tag of solid face. The center point in world coordinates. True if it succeeds, false if it fails.

Get the world coordinates of a circular edge's quadrant based on given paramter value.

The circular edge tag. The normalized parameter value for quadrant on given edge. World coordinate of quadrant. True if it succeeds, false if it fails.

Get the world coordinates of the closest circular edge quadrant to the cursor.

The screen position. Solid body to find circular edge quadrant on. World coordinate of quadrant. Calculated normalized parameter values for quadrant point on circular edge. True if it succeeds, false if it fails.

Point on edge from percentage.

The edge tag. The percentage (0-100). The point. True if it succeeds, false if it fails.

Point on face from percentage.

The face tag. The u percentage (0-100). The v percentage (0-100). The point. (Optional) True, point must be within face boundary. True if it succeeds, false if it fails.

Get the solid under the current cursor position

Pick position. Selection mask (see 3dvars.h). Sel bits to look for. Solid type (SLD_BODY or SLD_EDGE). If true, do pick as though display mode is shaded/shaded outlined. [out] Solid entity pointer, if successful. [out] Pick point, if successful. True if a solid is found, false if not.

Deletes all solids as part of initializing the database.

(Optional) If true, we're doing a full initialization (e.g. File New, File Open).

Gets the operations file associated with the specified solid entity.

Solid entity. Pointer to ops file or nullpter if error.

Find the normal at the point on the given face.

The face tag. The point. The normal. (Optional) If non-null, the calculated direction matrix. True if it succeeds, false if it fails.

Find the normal at center of given face.

PS tag of face. center of face. face normal at center of face. (Optional) If non-null, the calculated direction matrix. returns true if normal and center found.

Check solid bodies with no user interface.

Vector on solid bodies. Number of faults. True if all bodies load and all checks are successful.

Set solid chain info so it can be used by the chaining interface.

Container for face, loop and edge chains. (Optional) True if should clear existing chains before appending the new ones. Returns false if data not found to be consistent and therefore not set.

Get solid chain information from the chaining interface.

Container for face, loop and edge chains.

Check solid match.

The first entity. The second entity. The check entity attribute bits. True to compare toolpath operations. The item string when no match. (Optional) True to skip tool bodies. True if it succeeds, false if it fails.

Generates array of solids that reference any curve.

The eptr of the curve. The list of solid that reference curve.

List all solid dependencies.

The list of solid dependencies (eptrs).

Gets drafting associativity references.

Map of references. (Optional) True to initialize map.

Get solid dependencies.

If non-null, the solid entity. The solid dependencies (eptrs). (Optional) True to get hidden dependencies.

Transform a solid.

If non-null, the solid entity. The transformation type. The transformation matrix. Use original attributes when true. Copy toolpath operations when true. Keep entity idn when true. This is a move (not copy) when true. This is final (not preview) when true. (Optional) If non-null, the duplicated wireframe geometry eptrs (added to). (Optional) True to delete the AssocOne operation if moving solid. A bool.

Saves a brick.

The body. A std::string.

Compare to file.

The tolerance. The filepath. The body. A CompareSldToFileRes.

List solids.

A list of.

Searches through a list of eptrs to find out if any are suppressed/rolled back solids.

(Optional) The set of eptrs to look through. If null, then looks through all solid eptrs (Optional) The number of eptrs. true if a suppressed/rolled back solid is found, false otherwise.

Searches through a list of eptrs to find out if any are dirty solids.

(Optional) The set of eptrs to look through. If null, then looks through all solid eptrs (Optional) The number of eptrs. true if a dirty solid is found, false otherwise.

inquire if a solid body INTERSECTS a polyline.

the solid entity Polygon points. Number of polygon points. True if it intersects, false if not

Inquire if a solid body INTERSECTS a polygon

the solid entity Polygon points Number of polygon points polygon is rectangular. True if it intersects, false if not.

Inquire if a solid body is IN a polygon

the solid entity Polygon points Number of polygon points polygon is rectangular. True if it is in, false if not.

Explode hole.

The solid. The opidx. True if it succeeds, false if it fails.

Force solids into the History Tree by position.

Draws all of the solids in the solids EPTRARRAY.

Make a copy of a solid.

Source eptr of solid to be copied. If non-null, the eptr of the resulting copy. Duplicate mc geometry when true. Remove toolpath operations when true. Keep the enitty idn when true. (Optional) true to update reference points. (Optional) If non-null, the duplicated wireframe geometry eptrs (added to). (Optional) True to regenerate solid. (Optional) True to delete the AssocOne operation when deleting.

Record old/new eptr data and update solid eptrs if requested.

The oldeptr. Pointer to the new entity. (Optional) set to true to only add to the old and new eptr lists.

Solids loading file function.

The file loading flag. (Optional) The draw flag. (Optional) The full pathname of the file that was just loaded. This is only used when the file loading flag is false and it is used to re-attach associative planes.

When true, drawn wireframe is for solid outlines

Get the first visible solid entity

(Optional) If non-null, the solids eptr. The solid tag.

Updates the select state of specified entities and faces.

If any entity or face select states change, a repaint is performed. On return, the new eptr and face arrays will be empty. Vector of newly selected entity eptrs. Array of newly selected face tags. Array of currently selected face tags. Entity selection condition. If true, only the faces are selected. If false, eptrs AND faces are selected. True if the array of selected face tags has changed, false otherwise.

A solid convert to Mastercam entities parameters.

Values that represent compare sld to file results.

Solid surface toolpath utilization opCodes.

Solid to surface conversion color handling flag values.

Intersect a set of planes with a set of bodies and return the MC curves

The set of planes to intersect. Set of body tags to intersect. Tolerance to intersect body with. A set of mastercam curve eptrs and their planes.

Intersect a set of planes with a set of faces and return the MC curves

The set of planes to intersect. Set of face tags to intersect. Tolerance to intersect body with. A set of mastercam curve eptrs and their planes.

Generate a set of planes contained within an axis aligned box.

Initial plane to start from. The spacing between planes to fit in box. The tween planes to fit in box. (Optional) True to ensure start plane in box. The axis aligned box of the topologies.

Find the box that contains all the topologies

List of topols to be boxed. The axis aligned box of the topologies.

Sets the default mesh back color.

The new color.

Gets the default mesh back color.

The current mesg back color.

Sets the default mesh edge color.

The color.

Gets the default mesh edge color.

The color.

Sets the default mesh color.

The color.

Gets a pointer to the default mesh color.

Pointer to the default mesh color.

Gets the default mesh color.

The color.

Generate a MCO file from the specified MCO database entity.

I - MCO filename. I - MCO entity eptr. I - Alpha rendering value used to specify translucency, 0x00 = transparent, 0xFF = opaque. Success.

Generate a MCO file from the specified STL database entity.

I - MCO filename. I - STL entity eptr. I - Alpha rendering value used to specify translucency, 0x00 = transparent, 0xFF = opaque. Success.

Writes the specified polygonal mesh to a file.

Output file. Mesh index. (Optional) If true, write double data (STL only). True if successful, otherwise false.

Create an STL or IFF Mesh entity from a stream.

I - Input file pointer. I - Number of bytes to read. I - STL_FILE/IFF_FILE/MCO_FILE. Index of MMF data entry.

Create IFF Mesh entities by loading a IFF file.

I - Full path name of IFF file. I - Transformation to apply to IFF data. O - Ids of created entities. I - T = output drive and check facets separately. true if entity created, otherwise false.

Create IFF Mesh entity by loading a IFF file.

I - Full path name of IFF file. I - Transformation to apply to IFF data. O - Id of created entity. I - type of entity (= STOCK_ID by default) true if entity created, otherwise false.

Create MCO Mesh entity by loading a MCO file.

I - Full path name of MCO file. I - Transformation to apply to MCO data. O - Id of created entity. The entity id (PMESH_ID, STOCK_ID, etc.) true if entity created, otherwise false.

Create STL Mesh entity by loading a STL file.

I - Full path name of STL file. I - Transformation to apply to STL data. O - Id of created entity. true if entity created, otherwise false.

Set 'refs' count in entity.

Number of references. The entity. True if refs modified.

Set 'refs' count in entity.

Number of references. The entity. True if refs modified.

Updates the RegenRequired setting in all drafting entities.

(Optional) True to regenerate.

Updates the RegenRequired setting in any drafting entities associated with this entity.

Check for drafting entities associated with this entity (null_eptr = update all) (Optional) True to regenerate.

Adds to the solid selection pairs.

Identifier for the solid. Identifier for the selection. The pairs.

Defines an alias representing a vector of entity idn and selection pairs.

Defines an alias representing the entity idn and selection pairs.

Defines an alias representing a vector of solid idn and selection ids pairs.

Defines an alias representing the solid idn and selection ids.

Defines an alias representing a set of selection ids.

Read from memory mapped file (security enhanced version).

Pointer to buffer. Size of buffer (bytes). Size of element to read. Number of elements to read. Pointer to mem map file struct. Number of elements successfully read.

Gets the Mastercam color index for rubber band graphics.

Color index.

Gets the RGB color for rubber band graphics.

RGB color. Rubber line data

Rubber band gaf node visibility.

True to show, false to hide.

Initializes the rubber band data.

Rubberband mode. First point in world coordinates.

Global rubberband data.

Initializes object.

Destructor.

Default constructor.

Rubber band modes.

Rubber Band Information class.

If size > 0 then this utility will ensure that the index is in the range 0 to size-1.

If i is between 0 and size-1 then returns i, otherwise return size-1. A value representing the total number of elements. Not expected to be 0 so should check for empty before calling. If size > 0 then returns a valid index in the range 0 to size-1

Deletes any tVal modifiers associated with the given loop.

Zero-based index to NumberOfLoopChains of loop whos modifiers to be removed.

Deletes any tVal modifiers associated with the given edge.

Zero-based index to NumberOfTotalEdges of edge whos modifiers to be removed.

Fixes up modifier data after an edge is removed.

Zero-based index to NumberOfTotalEdges of edge whos modifiers to be adjusted. SLD_EDGE or SLD_LOOP.

Reverse the loop direction at the specified index.

Zero-based index of the loop to be reversed. True to erase arrows.

Use as a shortcut to index the last index in the relevant range.

Returns -1 which the member functions of this class recognize as meaning to use the last valid index.

Determines the element number given which edge chain and count or loop group and count.

SLD_LOOP, SLD_EDGE or SLD_FACE. Count since the first in the group. Zero-based index in NumberOfEdgeChains or NumberOfLoopGroups. Returns the zero-based index in NumberOfTotalElements; -1 on fail.

Determines the element number given the chain type and index in that type.

SLD_LOOP, SLD_EDGE or SLD_FACE. Zero-based index to the array associated with the chain type. Returns the zero-based index in NumberOfTotalElements; -1 on fail.

Finds info need to locate the specified element in the chains arrays.

Zero-based index to NumberOfTotalElements of element to get the info for. SLD_LOOP, SLD_EDGE or SLD_FACE. Zero-based index in array of the chain type for the element. Zero-based index in the group array for the element. true if element found and data set; false on fail.

Copies the information from the solid op to this data.

The solid tool operation. true for success; false if failed.

Copies this data to the given solid tool operation.

The solid tool operation. true for success; false if failed.

Adds all the edges in the given loop and removes the loop.

Zero-based index to NumberOfLoopChains. -1 for last defined. true if it successfully replaced the loop; false no change made.

Adds the given chains to this data, ignoring duplicates.

The solid chain data to be added.

Returns index into NumberOfTotalEdges for the first edge in the specified edge group.

Zero-based index to NumberOfEdgeChains; -1 for last edge chain. (Optional) 0 for first edge in chain (default); -1 for last edge in chain. Returns index into NumberOfTotalEdges for the first edge in the specified edge group.

Returns true if the edges are chained exactly as given.

The edge tags defining the chain. The edge dirs defining the chain. The index in NumberOfEdgeChains of the match or less than 0 if not found.

Returns true if the edge is chained.

The Parasolid tag. Returns true if tag is found in the data.

Returns true if an exact matching loop exists.

The information about the loop. Returns true if loop is found in the data.

Returns true if the face has been chained.

The Parasolid tag. Returns true if faceTag is used in the data.

Returns the information about the specific loop chain.

Zero-based index to NumberOfLoopChains. -1 for last defined. Returns the information about the specific loop chain.

Returns whether the loop is partial (not close) or not.

Returns true if the loop is not closed; false if it is closed.

Get info about the specified loop's start or end edge.

I: Zero-based index to NumberOfLoopChains. -1 for last defined. O: The tag for the start edge of the loop which isn't necessarily start_edge. O: True if the edge is in the same direction as the chain. I: True if start; false to get the endTag and dir for it. Returns true if successfully set edgeTag and dir. false if unable to determine the information.

The number of loop chains defined.

Returns the number of loop chains.

The number of edges in the specified edge chain.

Zero-based index to NumberOfEdgeChains. -1 for last defined. Returns the number of edges in the edge chain.

Returns the name of the ith edge chain.

Zero-based index to NumberOfEdgeChains. -1 for last defined. Returns name of the edge group chain.

Returns direction for the specified edge.

Zero-based index to NumberOfTotalEdges; -1 for last defined. true for reversed from Parasolid tag; false if same as Parasolid tag.

Returns Parasolid tag for the edge specified.

Zero-based index to NumberOfTotalEdges; -1 for last element. Returns the tag of the ith edge chained.

The number of edges that have been chained.

Returns the sum of all the edges in all the edge chains defined.

The number of edge chains defined.

Returns the number of edge chains.

Returns direction for the specificed face chain.

Zero-based index to NumberOfFaceChains; -1 for last defined. true for reversed from Parasolid tag; false if same as Parasolid tag.

Returns Parasolid tag for specified face chain.

Zero-based index to NumberOfFaceChains; -1 for last defined. Returns ps face tag.

Total count face chains.

The number of face chains defined.

Sets change at point data for specified element.

Zero-based index to NumberOfTotalElements; -1 for last defined. The data to set. Returns true if set successfully, false if failed.

Returns the change at point data of the ith element that was chained.

Zero-based index to NumberOfTotalElements; -1 for last defined. Returns change at point data corresponding to the ith element.

Returns the custom name of the ith element that was chained.

Zero-based index to NumberOfTotalElements; -1 for last defined. Returns SLD_EDGE/SLD_FACE/SLD_LOOP corresponding to the ith element.

Returns the type of the ith element that was chained.

Zero-based index to NumberOfTotalElements; -1 for last defined. Returns SLD_EDGE/SLD_FACE/SLD_LOOP corresponding to the ith element.

# loop chains + # face chains + # total edges.

Returns the total number of solid tags that are chained.

Removes the last chain that was defined.

true to remove last edge; false to remove last edge chain. The chain that was removed. True if a chain was removed, false if it fails.

Determines the chain index for the chain specified by type and index in type.

Type of the chain SLD_EDGE, SLD_LOOP, or SLD_FACE. Zero based index to the number of that kind of chain. Zero based index in ChainCount or -1 if failed to find a match..

Removes the specified chain and all its associated data.

Zero-based index in ChainCount. The data for the chain removed. True if the chain was successfully removed, false if it fails.

Determines which edge chain the specified edge is in and removes it, splitting chain into two if the edge was in the middle.

Zero-based index to NumberOfTotalEdges; -1 for last defined.. True if the edge was successfully removed, false if it fails.

Removes the last edge from the last edge chain. If only one edge in the chain then it removes the whole edge chain group.

The chain that was removed. True if a chain was removed, false if it fails.

Removes the last edge chain.

The chain that was removed. True if a chain was removed, false if it fails.

Removes the last face chain.

The chain that was removed. True if a chain was removed, false if it fails.

Removes the last loop chain.

The chain that was removed. True if a chain was removed, false if it fails.

Gets tVal modifier for start or end of the loop at the given index.

Zero-based index to NumberOfLoopChains. -1 for last defined. true for start modifier; false for end modifier. If found then returns the modifier values otherwise return -1.

Gets tVal modifier for start or end of the edge at the given index.

Zero-based index to NumberOfTotalEdges. -1 for last defined. true for start modifier; false for end modifier. If found then returns the modifier values otherwise return -1.

Gets tVal modifier for start or end of the edge at the given index.

Map of modifiers as if part of SolidChains. Zero-based index to NumberOfTotalEdges. -1 for last defined. true for start modifier; false for end modifier. SLD_LOOP or SLD_EDGE. If found then returns the modifier values otherwise return -1.

Sets start/end modifier for the edge at the given index.

Zero-based index to NumberOfTotalEdges; -1 for last defined. true to modify start; false to modify end. SLD_LOOP or SLD_EDGE. Value that indicates where on the edge the point should be.

Sets a end modification for the specified chain.

The modifier data for the chains. index in loop or edge chain data; -1 NOT supported. true to modify start; false to modify end. The type of chain to be modified (SLD_LOOP or SLD_EDGE). The modification value to set.

Updates the specified loop chain with the new info.

Zero-based index to NumerOfLoopChains. -1 for last defined. Loop data. true if successful; false if loop chain not updated.

Add chain for the given loop. Does not check to see if the edge is already chained.

Loop data for the chain. (Optional) Start edge modifier. (Optional) End edge modifier. (Optional) Change at point data. (Optional) Name for this chain. Index in NumberOfLoopsChains where added, smaller than 0 if it fails.

Updates the specified edge with a new tag id.

Zero-based index to NumberOfTotalEdges. -1 for last defined. The new Parasolid tag to use for the edge. true if successful; false if edge tag not updated.

Add edge to a chain group. Does not check to see if the edge is already chained.

Parasolid tag for edge to chain. false if chained in reversed edge direction. (Optional) Change at point data. (Optional) Name for this chain. The index in total edges where the edge was added. -1 if it failed.

Adds an empty edge chain. Use AddEdge ToLastEdgeChain to fill with edges.

Name for empty chain. Empty is fine.

Add chain for the given edge. Does not check to see if the edge is already chained.

Parasolid tag for edge to chain. false if chained in reversed edge direction. (Optional) Start edge modifier. (Optional) End edge modifier. (Optional) Change at point data. (Optional) Name for this chain. The index in total edges where the edge was added. -1 if it failed.

Updates the specified face chain with a new tag id.

Zero-based index to NumberOfFaceChains. -1 for last defined. The new Parasolid tag to use for the face. true if successful; false if face chain not updated.

Add chain for the given face.

Parasolid tag for face to chain. false if chained in reversed edge direction. (Optional) Change at point data. (Optional) Name for this chain. True if a chain is added, false if it fails.

Removes all chains.

Total count of the face, loop and edge chains.

The number of chains defined.

The destructor.

Evaluates if the chain data is internally consistent.

True if data is found to be consistent.

Copy operator.

The constructor.

---------------------------------- SOLIDCHAINS

Container for a sequence of solid face, loop and edge chains.

There are three types of solid chains: face, loop and edge chains. Edge chains are a sequence of edges. This class defines solid chains much as they are created in the chaining dialog. Say, for example, if the user clicked a face, a loop, three edges, pressed End, then another edge. In this example there would be 4 chains / 6 elements / 1 face chain / 1 loop chain / 2 edge chain groups. The class provides functions to extract information about the chains from zero-based indices. So the 5th element would correspond to the edge chain group at index 1 and the edge tag with index 3. For the time being, this is the base class for SolidTpChainSel, which is the class that handles the solid chain user interface with the chaining dialog. Many of the data arrays in this class are tied together, for example, if you delete a face tag you must also delete a face direction, order type, CAP and selection name. m_tVals is a map that keys the start and end modifiers to the index of the edge they modify. If there is no match to for the start/end then it at the end of the edge as determined by the chain direction.

Used to evaluate whether the given data can be used to determine a point on an edge.

Returns true if the given data has been set to a valid tVal.

Value used to indicate that no modifer has been set.

Returns the initial value to be used for variables that holds tVal data. ---------------------------------- tVal END MODIFIER UTLITIES

The types of chain ends that can be modified (shortened).

Initializes the solid lathe parameters with default turning tessellation tolerance.

The parameters to be initialized.

Specifies the profile algorithm to use.

A box with max and min in its own Local coord system

Two points defining the maximum and minimum points defined as points on a cuboid aligned along X, Y, Z where X is Left/Right, Y is Top/Bottom, Z is Front/Back looking along +ve Z axis

A full definition axis - with both ref direction

Constructor.

The point. The dir.

Defaulted constructor.

Constructor.

The point. The dir. The reference.

A line/plane definition axis - with a ref direction

A line definition axis - no ref direction

Build and return a set of all the solid operation indices in the solid.

The eptr for the solid. A set of all the solid operation indices in the solid.

Are reapply notifications currently suspended.

Pointer to solid or null_eptr to check all solids. True if currently suspended.

Destructor.

Constructor.

Bypass updating of solid by special undo when undo is being terminated.

Set the SldSkipTestAndModifyEntity flag to prevent special undo from dirtying solid.

The new value. Returns the original value.

Get the solid operation's tool bodies.

The solid. Zero-based index of the operation. The tool body eptrs.

Re-add solid to dialog.

The solid. (Optional) Handle of the group. (Optional) Handle of the after tree item.

Adds solid to dialog.

The solid. (Optional) The after solid. (Optional) Handle of the group. (Optional) Handle of the after tree item.

Returns the Mastercam Eptr for all of the solid's tool bodies.

The Mastercam Eptr for the solid. A vector of Eptrs to add the tool body eptrs to.

Get the geometry dependencies for the give solid.

The solid. The geometry eptrs.

Get the geometry dependencies for the give solid.

The solid. The geometry eptrs.

Deletes all solid operations as part of initializing the database.

(Optional) If true, we're doing a full initialization (e.g. File New, File Open).

Mc explode operation.

The solid. Zero-based index of the operation. True if it succeeds, false if it fails.

Sets the solid position information.

The solid.

Gets the solid position information.

The solid.

Place a rectangle on a flat triangulated surface.

The vector of 3 points representing the surface. The minimum box corner. The maximum box corner. [out] True if flipped. [out] The minimum placed box corner. [out] The maximum placed box corner. True if it succeeds, false if it fails.

Tessellate solid/face tags into triangles, and output the triangle vertices with their corresponding indices.

The meshTol parameter does not apply to pmesh entities. The tags of the solids/faces to be tessellated. [out] The set of triangle vertices that make up the tessellation. [out] The indices that correspond to the vertices. (Optional)[out] The colors for the triangles. (Optional) The tolerance used for tessellating solids and surfaces. Does not apply to pmesh entities. Returns true if the points and indices were obtained, and false otherwise.

Tessellate an entity (pmesh, solid, surface, etc.) into triangles, and output the triangle vertices with their corresponding indices, as well as any available normal data.

The meshTol parameter does not apply to pmesh entities. Normals are returned sorted and unique, and the indices are per-triangle vertex. The entity to tessellate. [out] The set of triangle vertices that make up the tessellation. [out] The indices that correspond to the vertices. [out] The normals. [out] The normal indices. (Optional)[out] The colors for the triangles. (Optional) The tolerance used for tessellating solids and surfaces. Does not apply to pmesh entities. (Optional) If true, transform the triangles if entity has a definition matrix specified. (Optional) If true, zero values are replaced with the entity color. Returns true if the points and indices were obtained, and false otherwise.

Tessellate an entity (pmesh, solid, surface, etc.) into triangles, and output the triangle vertices with their corresponding indices.

The meshTol parameter does not apply to pmesh entities. The entity to tessellate. [out] The set of triangle vertices that make up the tessellation. [out] The indices that correspond to the vertices. (Optional)[out] The colors for the triangles. (Optional) The tolerance used for tessellating solids and surfaces. Does not apply to pmesh entities. (Optional) If true, transform the triangles if entity has a definition matrix specified. (Optional) If true, zero values are replaced with the entity color. Returns true if the points and indices were obtained, and false otherwise.

Get the difference of two oriented signed distance fields.

Normals in mutually erased regions not guaranteed to face correct direction! Also, must be same dimensions. A field. Another field. A HermiteData.

Get the union of two oriented signed distance fields.

Must be same dimensions. A field. Another field. A HermiteData.

Get the intersection of two oriented signed distance fields.

Must be same dimensions. A field. Another field. A HermiteData.

Sparsely polulated volumetric Hermite samples, organized by octant.

An oriented sample.

Get the 3D steps to a flat index.

Flat index. The steps.

3D Index into the flat storage.

The x step. The y step. The z step. The index.

Gets the steps.

The steps.

Gets the range.

The total range.

Gets the dimensions.

The dimensions.

Initializes this object.

The x range. The y range. The z range.

Constructor.

The x range. The y range. The z range.

Destructor.

Assignment operator.

The first parameter. A shallow copy of this object.

Move constructor.

The object to consume.

Copy constructor.

The object to copy.

Defines an alias representing the step vector.

Default constructor.

An 3D to flat and back array indexing helper.

QOF child count.

Dimension (2 or 3). The appropriate number of children.

Builds a triangle mesh of the input octant addresses.

The internally shared faces of the octants are not output. The addresses. The domain span. The minimum corner. The truncation level. [out] The point cloud. [out] The triangle indices into the cloud.

Defines an alias representing the base class.

Defines an alias representing storage type for the relative path.

Defines an alias representing type returned in "bits" masking queries.

Locations relative to the parent node.

Headings relative to current node.

Get the minimum bits representing the final relative location in the path.

The path. BitsType representing the location.

Get the final relative location in the path.

The path. The relative location.

Get the minimum bits representing a relative location.

The location. BitsType representing the location.

Check if it is possible to move in the given direction without going up a level in the tree.

The location. The heading. True if cannot move in the given direction.

Move the current relative position to the position in the given direction.

The heading. [in, out] The path.

Defines an alias representing the base class.

Defines an alias representing storage type for the relative path.

Defines an alias representing type returned in "bits" masking queries.

Locations relative to the parent node.

Headings relative to current node.

Get the minimum bits representing the final relative location in the path.

The path. BitsType representing the location.

Get the final relative location in the path.

The path. The relative location.

Get the minimum bits representing a relative location.

The location. BitsType representing the location.

Check if it is possible to move in the given direction without going up a level in the tree.

The location. The heading. True if cannot move in the given direction.

Move the current relative position to the position in the given direction.

The heading. [in, out] The path.

Get a cell of 3D points in [0, 1] cube.

Morton code for the lower cell corner. The level of the cell. The cell points.

Get a cell of 2D points in [0, 1] square.

Morton code for the lower cell corner. The level of the cell. The cell points.

Get a cell of 3D points in [0, 1) cube.

The 3D coded cell. The cell points.

Get a cell of 2D points in [0, 1) square.

The 2D coded cell. The cell points.

Get the corners of a 3D cell where the input code is the minimum corner.

Morton code of the minimum corner. The level of the cell. [out] The cell. (Optional) True to snap the input to the level. True if it succeeds, false if the far corners exceed the max encoded value.

Get the corners of a 2D cell where the input code is the minimum corner.

Morton code of the minimum corner. The level of the cell. [out] The cell. (Optional) True to snap the input to the level. True if it succeeds, false if the far corners exceed the max encoded value.

Get the codes of a 3D grid at the desired depth.

The depth. A vector of codes in curve order.

Get the codes of a 2D grid at the desired depth.

The depth. A vector of codes in curve order.

Convert a 3D code to 2D.

The 2D coded value. [out](Optional) Get the unsigned form of the height. The 2D code.

Convert a 2D code to 3D.

3D codes have less detail than 2D, so some truncation will occur. The 2D coded value. (Optional) The unit space height, defaults to 0. The 3D code.

Get 3D points in [0, 1) cube.

Morton codes. (Optional) Truncation depth. The points.

Get a 3D point in [0, 1) cube.

Morton code. (Optional) Truncation depth. A CM::Vector3D.

Get 2D points in [0, 1) square.

Morton codes. (Optional) Truncation depth. The points.

Get a 2D point in [0, 1) square.

Morton code. (Optional) Truncation depth. A CM::Vector2D.

Morton codes for 3D points in [0, 1) cube.

The points. A vector of numbers representing the 3D vector.

Morton code for a 3D point in [0, 1) cube.

A point. A number representing the 3D vector.

Morton codes for 2D points in [0, 1) square.

The points. A vector of numbers representing the 2D vector.

Morton code for a 2D point in [0, 1) square.

A point. A number representing the 2D vector.

Morton code for a 2D point in [0, 1) square.

X coordinate. Y coordinate. Z coordinate. A number representing the 2D vector.

Morton code for a 2D point in [0, 1) square.

X coordinate. Y coordinate. A number representing the 2D vector.

Move the Morton code relative to the input.

[in,out] The code. The depth to take the steps at. The steps in the x direction. The steps in the y direction. The steps in the z direction. False if the steps leave the unit cube.

Move the Morton code relative to the input.

[in,out] The code. The depth to take the steps at. The steps in the x direction. The steps in the y direction. False if the steps leave the unit square.

Gets the size.

A std::size_t.

Array indexer operator.

The index of the triangle. The iith triangle .

Gets the end.

An iterator.

Gets the begin.

An iterator.

Constructor rrom indices.

The indices.

A triangle wrapper.

used to traverse triangle indices as triangles.

Inequality operator.

The first instance to compare. The second instance to compare. True if the parameters are not considered equivalent.

Equality operator.

The first instance to compare. The second instance to compare. True if the parameters are considered equivalent.

Subtraction operator.

used by std::distance and std::next. The first value. A value to subtract from it. The result of the operation.

Addition assignment operator.

The offset. The result of the operation.

Postfix increment.

The first parameter. The result of the operation.

Prefix increment.

The result of the operation.

Postfix increment.

The first parameter. The result of the operation.

Prefix increment.

The result of the operation.

Constructor.

The pointer.

Indirection operator.

The value of the current pointer.

A triangle constant iterator.

Useful to iterate through triangles and make the code readable.

Sets the unused/recycled state.

Initializes this object.

A decoration interface.

Report that the face does not carry decoration data.

False.

Verify that this face is recyclable.

true if ok to reuse.

Mark this face for recycling.

Face structure for half-edge meshes.

Knows only the index of an edge in it.

Report that the edge does not carry decoration data.

False.

Verify that this half-edge is recyclable.

true if ok to reuse.

Mark this half edge for recycling.

Half-edge structure for half-edge meshes.

Knows the node it is leaving, it's twin, who comes next, who it left, and the face it bounds.

Report that the node does not carry decoration data.

False.

Report that the node does not carry vertex data.

False.

Verify that this node is recyclable.

true if ok to reuse.

Mark this node for recycling.

Node structure for half-edge meshes.

Knows only the index of an edge leaving it. There may be many edges leaving this node.

Values that represent topological components in meshes.

Flag values for half-edge mesh components.

These are mostly for readability.

A polyline node descriptor.

A structure for reporting which input object is the current slot in the loop.

Check if the xy planes of two transforms are coplanar.

A transform. Another transform. Optional angle tolerance. Optional zero tolerance. true if same xy plane, false if not.

Check if the z-axis of two transforms are antiparallel.

A transform. Another transform. Optional angle tolerance. true if antiparallel, false if not.

Check if the z-axis of two transforms are parallel.

A transform. Another transform. Optional angle tolerance. true if parallel, false if not.

Check if the z-axis of two transforms are perpendicular.

A transform. Another transform. Optional angle tolerance. true if perpendicular, false if not.

Convert the given transform 2D to 3D.

The transform 2D. The transform 3D.

Builds a relative transform between two others.

Original transform. Goal transform. A Transform3D to apply to the original.

Builds a relative transform between two others.

Original transform. Goal transform. A Transform2D to apply to the original.

Builds a 3D mirror transform.

The normal of the reflecting plane. The origin. A Transform3D.

Builds a 2D mirror transform.

The line start. The line end. A Transform2D.

Builds rotation from axis angle.

The axis. The angle. A Transform3D.

Builds a 3D rotation around a point on given axis.

The point. The rotation axis. The angle. A Transform3D.

Builds a 2D rotation around a point in the plane.

The point. The angle. A Transform2D.

Builds rotation from axis index and angle.

1 for Y, 2 for Z, all others will be X. Zero-based index of the axis. The angle. A Transform3D.

Builds a 2D rotation from an angle.

The angle. A Transform2D.

Builds transform from an axis and an origin.

This uses the "AutoCAD Arbitrary Axis Algorithm", which provides consistent orientations (though arbitrary) for a given z axis. The new z axis. The origin. A Transform3D.

Builds a transform from many points.

A plane is fit to the points, the origin is the average point position, and the normal is the average orientation assuming a CCW input order. The points. A Transform3D.

Builds a transform from three points.

The three points form a triangle in a plane. Point aP forms the base of the triangle and bP and cP lead in the x and y directions, respectively. The z vector will be the plane normal. The base point. A point leading in the new x direction from the base. A point leading in the new y direction from the base. A Transform3D.

Builds a Transform3D object from a rotation and translation.

The 3x3 rotation matrix. The 3d translation. (Optional) A uniform scaling. A Transform3D.

Builds a Transform2D object from a rotation and translation.

The 2x2 rotation matrix. The 2d translation. (Optional) A uniform scaling. A Transform2D.

Builds a pure uniform scale object.

The amount of scaling. A scale only Transform3D.

Builds a pure uniform scale object.

The amount of scaling. A scale only Transform2D.

Builds a pure rotation object.

The 3x3 rotation amounts. A rotation only Transform3D.

Builds a pure rotation object.

The 2x2 rotation amounts. A rotation only Transform2D.

Builds a pure translation object.

The 2d translation amounts. A translation only Transform2D.

Builds a pure translation object.

The 3d translation amounts. A translation only Transform3D.

Matrix times transform operator.

A 4x4 matrix. A 3D transform object. A 4x4 matrix.

Transform matrix operator.

A 3D transform object. A 4x4 matrix. A 4x4 matrix.

Matrix times transform operator.

A 3x3 matrix. A 2D transform object. A 3x3 matrix.

Transform matrix operator.

A 2D transform object. A 3x3 matrix. A 3x3 matrix.

Transform assignment operator.

[in,out] The 6D float vector to transform. A Transform3D object. The transformed vector.

Transform assignment operator.

[in,out] The 6D double vector to transform. A Transform3D object. The transformed vector.

Transform assignment operator.

[in,out] The 3D float vector to transform. A Transform3D object. The transformed vector.

Transform assignment operator.

[in,out] The 3D double vector to transform. A Transform3D object. The transformed vector.

Transform assignment operator.

[in,out] The 2D float vector to transform. A Transform3D object. The transformed vector.

Transform assignment operator.

[in,out] The 2D double vector to transform. A Transform3D object. The transformed vector.

Transform assignment operator.

[in,out] The 2D float vector to transform. A Transform2D object. The transformed vector.

Transform assignment operator.

[in,out] The 2D double vector to transform. A Transform2D object. The transformed vector.

Transform vector operator.

A Transform3D object. A 6d double vector to transform. Transformed 6d vector.

Transform vector operator.

A Transform3D object. A 6d double vector to transform. Transformed 6d vector.

Transform vector operator.

A Transform3D object. A 3d float vector to transform. Transformed 3d vector.

Transform vector operator.

A Transform3D object. A 3d double vector to transform. Transformed 3d vector.

Transform vector operator.

A Transform2D object. A 2d float vector to transform. Transformed 2d float vector.

Transform vector operator.

A Transform2D object. A 2d double vector to transform. Transformed 2d double vector.

Constructs an instance of the GeometryManipulatorManager.

Finalizes an instance of the IGeometryManipulatorManager.

Place a rectangle on a flat surface.

The entity. The minimum box corner. The maximum box corner. [out] True if flipped. [out] The minimum placed box corner. [out] The maximum placed box corner. True if it succeeds, false if it fails.

Delete Assignment operator.

Delete move operator.

Delete copy constructor.

Delete move-copy constructor.

This class handles the manipulation of Mastercam Color settings.

Gets the Search Manager.

A pointer to the singleton instance of the Colors Manager.

Finalizes an instance of the IColorsManager.

Place a rectangle on a flat surface.

The entity. The minimum box corner. The maximum box corner. [out] True if flipped. [out] The minimum placed box corner. [out] The maximum placed box corner. True if it succeeds, false if it fails.

This class handles the manipulation of Mastercam Color settings.

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.

This is a static inequality operator overload for the purposes of comparing these 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. The first 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 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. The first Spline to compare. True if the two objects are considered equal.

This is a static equality method for the purposes of comparing these 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. The first Spline to compare. The second Spline to compare. True if the two objects are considered equal.

Gets the list of Node Points used to generate the Spline Curve.

The list of Node Points used to generate the Spline Curve.

Gets the second endpoint of the curve object.

The second endpoint of the curve object.

Gets the first endpoint of the curve object.

The first endpoint of the curve object.

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.

Initializes a new instance of the Spline class.

The Mastercam spline geometry data.

This class is used as a mathematical representation of a Spline.

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.

Computes the lower left and upper right corner and the clipping and select parameters.

The center. The height.

Sets the screen is in 'Print Preview' on/off state.

The state to be set.

Gets the screen is in 'Print Preview' on/off status.

True if in 'Print Preview' mode, false if not.

Sets the on/off state if the screen is in 'HardCopy' mode.

The state to be set.

Gets the screen is in 'HardCopy' on/of status.

True if in 'HardCopy' mode, false if not.

Sets the on/off state of the toolpath display on.

The state to be set.

Gets the toolpath display on/off status.

True if it is on, false of not.

Sets the WCS axes on/off status.

The on/off state to be set.

Gets the WCS axes on/off status.

True if it is on, false if not.

Sets the view axes on/off status.

The on/off state to be set.

Gets the view axes on/off status.

True if it is on, false if not.

Clears all Result color markings.

Clears all Group color markings.

Clears all Group and/or Result color markings.

This forces user input focus to the Mastercam graphics window.

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.

Repaints the screen using Mastercam's internal display list.

Performs an animated screen unzoom by the scale amount.

The scale factor.

This calls Mastercam's internal 'Fit then Unzoom' functionality.

The scale factor. This does Fit Screen followed an Unzoom (using the specified scale factor)

This calls Mastercam's internal 'Fit then Unzoom' functionality.

The does Fit Screen followed an Unzoom (using a scale factor of 0.8)

This calls Mastercam's internal 'UnZoom Previous' function.

This calls Mastercam's internal 'UnZoom' function.

Fits the screen dimensions make visible all of the chains passed in.

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.

Fits the screen dimensions to a set of specified coordinate values.

The point whose coordinate values will become the center of the viewport. The value to become the height of the viewport.

Fits the screen dimensions to a set of specified coordinate values.

The point whose 2D coordinate values will become the coordinates of the upper left-hand corner of the viewport. The point whose 2D coordinate values will become the coordinates of the lower right-hand corner of the viewport.

Fits the screen dimensions to a set of specified coordinate values.

The X value of the point to become the new upper left-hand corner of the viewport. The Y value of the point to become the new upper left-hand corner of the viewport. The X value of the point to become the new lower right-hand corner of the viewport. The Y value of the point to become the new lower right-hand corner of the viewport.

Initializes a new instance of the GraphicsManager class.

Finalizes an instance of the GraphicsManager class.

Fits the screen dimensions to make all of the geometry visible on-screen.

Delete assignment operator.

Delete move operator.

Delete copy constructor.

Delete move constructor.

This class is used to work with graphic settings within Mastercam.

Gets the Graphics Manager.

A pointer to the singleton instance of the File Manager.

Sets the screen is in 'Print Preview' on/off state.

The state to be set.

Gets the screen is in 'Print Preview' on/off status.

True if in 'Print Preview' mode, false if not.

Sets the on/off state if the screen is in 'HardCopy' mode.

The state to be set.

Gets the screen is in 'HardCopy' on/of status.

True if in 'HardCopy' mode, false if not.

Sets the on/off state of the toolpath display on.

The state to be set.

Gets the toolpath display on/off status.

True if it is on, false of not.

Sets the WCS axes on/off status.

The on/off state to be set.

Gets the WCS axes on/off status.

True if it is on, false if not.

Sets the view axes on/off status.

The on/off state to be set.

Gets the view axes on/off status.

True if it is on, false if not.

Clears all Result color markings.

Clears all Group color markings.

Clears all Group and/or Result color markings.

This forces user input focus to the Mastercam graphics window.

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,

Repaints the screen using Mastercam's internal display list.

Performs an animated screen unzoom by the scale amount.

The scale factor.

This calls Mastercam's internal 'Fit then Unzoom' functionality.

The scale factor. This does Fit Screen followed an Unzoom (using the specified scale factor)

This calls Mastercam's internal 'Fit then Unzoom' functionality.

The does Fit Screen followed an Unzoom (using a scale factor of 0.8)

This calls Mastercam's internal 'UnZoom Previous' function.

This calls Mastercam's internal 'UnZoom' function.

Fits the screen dimensions make visible all of the chains passed in.

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.

Fits the screen dimensions to a set of specified coordinate values.

The point whose coordinate values will become the center of the viewport. The value to become the height of the viewport.

Fits the screen dimensions to a set of specified coordinate values.

The point whose 2D coordinate values will become the coordinates of the upper left-hand corner of the viewport. The point whose 2D coordinate values will become the coordinates of the lower right-hand corner of the viewport.

Fits the screen dimensions to a set of specified coordinate values.

The X value of the point to become the new upper left-hand corner of the viewport. The Y value of the point to become the new upper left-hand corner of the viewport. The X value of the point to become the new lower right-hand corner of the viewport. The Y value of the point to become the new lower right-hand corner of the viewport.

Finalizes an instance of the IGraphicsManager.

Fits the screen dimensions to make all of the geometry visible on-screen.

This class is used to work with graphic settings within Mastercam.

Constructor an instance of the VectorManager.

Finalizes an instance of the ISelectionManager.

Gets the current system tolerance used within Mastercam.

Delete Assignment operator.

Delete move operator.

Delete copy constructor.

Move copy constructor.

This class is used to modify common settings within the Mastercam environment.

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.

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.

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 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 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.

This method is used to get objects for geometry with any combination of settings in the current 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 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.

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.

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.

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.

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.

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 view 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.

Constructs an instance of the SearchManager.

Finalizes an instance of the ISearchManager.

This method is used to get objects for all of the views found in the current part file

An array of Mastercam::Database::MCView objects representing all of the appropriate views found in the current Mastercam part file's database.

Delete Assignment operator.

Delete move operator.

Delete copy constructor.

Delete move-copy constructor.

This class is used for retrieving entities from the Mastercam database based on different combinations of settings.

Gets the Search Manager.

A pointer to the singleton instance of the Search Manager.

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.

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.

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 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 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.

This method is used to get objects for geometry with any combination of settings in the current 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 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.

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.

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.

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.

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.

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 view 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.

Finalizes an instance of the ISelectionManager.

This method is used to get objects for all of the views found in the current part file

An array of Mastercam::Database::MCView objects representing all of the appropriate views found in the current Mastercam part file's database.

This class is used for retrieving entities from the Mastercam database based on different combinations of settings.

Gets or sets the 'marked for chaining' (TEMP2_BIT) flag status.

Gets or sets the 'blanked' (BLANK_BIT) flag status.

Gets or sets the 'selected' (SELECT_BIT) flag. status

Gets or sets the 'alive' (ALIVE_BIT) flag. status

This equality method is 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.

Used to output the Mastercam bit value representing this object's internal data.

A value with the corresponding bits set to act as a geometry Selection Mask.

Sets the 'marked for chaining' (TEMP2_BIT) flag status.

The state of the 'chain' flag.

Gets the 'marked for chaining' (TEMP2_BIT) flag status.

Sets the 'blanked' (BLANK_BIT) flag status.

The state of the 'blanked' flag.

Gets the 'blanked' (BLANK_BIT) flag status.

Sets the 'selected' (SELECT_BIT) flag. status

The state of the 'selected' flag.

Gets the 'selected' (SELECT_BIT) flag. status

Sets the 'alive' (ALIVE_BIT) flag. status

The state of the 'alive' flag.

Gets the 'alive' (ALIVE_BIT) flag. status

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 Alive entities flag to. The value to set the Selected entities flag to. The value to set the Blanked entities flag to. The value to set the Chain entities flag to.

Initializes a new instance of the SelectionMask class.

Sets all of the selection type flags to the same boolean on/off value. The boolean value to set the on/off state of the geometry flags to.

A masking type used for indicating any combination of geometry types.

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 Drafting Dimension flag.

Gets or sets the Drafting Witness/Leader flag.

Gets or sets the Drafting Notes 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.

This is a 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.

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.

Sets the Polygonal Mesh geometry flag.

true to include meshes, else false to exclude them.

Gets the Polygonal Mesh geometry flag.

Sets the Solids geometry flag.

true to include solids, else false to exclude them.

Gets the Solids geometry flag.

Sets the Surfaces geometry flag.

true to include surfaces, else false to exclude them.

Gets the Surfaces geometry flag.

Sets the NURBS Splines geometry flag.

true to include NURB splines, else false to exclude them.

Gets the NURBS Splines geometry flag.

Sets the Drafting Dimension flag.

true to include dimensions, else false to exclude them.

Gets the Drafting Dimension flag.

Sets the Drafting Witness/Leader flag.

true to include witness lines, else false to exclude them.

Gets the Drafting Witness/Leader flag.

Sets the Drafting Notes flag.

true to include notes, else false to exclude them.

Gets the Drafting Notes flag.

Sets the Parametric Splines geometry flag.

true to include parametric splines, else false to exclude them.

Gets the Parametric Splines geometry flag.

Gets or sets the Arcs geometry flag.

true to include arcs, else false to exclude them.

Gets the Arcs geometry flag.

Sets the Lines geometry flag.

true to include lines, else false to exclude them.

Gets the Lines geometry flag.

Sets the Points geometry flag.

true to include points, else false to exclude them.

Gets 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 notes. true for witness. true for dimensions. true for nurbs type splines. true for surfaces. 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 on/off state of the geometry flags to.

A masking type used for indicating any combination of geometry types.

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. Provided and used for NET-Hook API wrapper. The ID of the view entity to look up in the Mastercam database. A regular pointer to a View object.

Default Constructor.

All members are given default values. Provided and used for NET-Hook API wrapper. A regular pointer to an View object.

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.

Initialize a view object from a database ID.

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.

Loads the default values for a given view object.

Gets 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. A value indicating if the view is "in use" by the system and thus cannot be deleted.

Gets a value indicating if the view object is a locked ("reserved") system view.

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.

The ID of the view object.

Sets the view number of the current view object.

The view number of the current view object.

Gets the view number of the current view object.

The view number of the current view object.

Sets the comment on the current view object.

the comment on the current view object.

Gets the comment on the current view object.

The comment on the current view object.

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. the work offset number of this view object.

Gets the name of the current view object.

The work offset number of this view object

Sets the work offset number of this view object.

the work offset number of this view object.

Gets the work offset number of this view object.

The work offset number of this view object

Sets the origin of this view object.

The view matrix of this view object.

Gets the origin of this view object.

The view matrix of this view object

Sets the view matrix of this view object.

The view matrix of this view object.

Gets the view matrix of this view object.

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.

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.

This class is used for modifying and creating view entities in Mastercam.

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 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.

Finalizes an instance of the ILevelsManager.

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.

Gets the Search Manager.

A pointer to the singleton instance of the Search Manager.

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 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.

Finalizes an instance of the ILevelsManager.

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.

A class containing various type casters.

The location of the ending point for drawing this torus.

The location of the starting point for drawing this torus.

The distance of the inner edge of the torus from this torus primitive solid's base point.

The distance of the outer edge of the torus from this torus primitive solid's base point.

Sets the location of the ending point for drawing this torus primitive solid as an angle, in degrees, from the base point.

The location of the ending point in degrees.

Gets the location of the ending point for drawing this torus primitive solid as an angle, in degrees, from the base point.

The location of the ending point.

Sets the location of the starting point for drawing this torus primitive solid as an angle, in degrees, from the base point.

The location of the starting point in degrees.

Gets the location of the starting point for drawing this torus primitive solid as an angle, in degrees, from the base point.

The location of the starting point.

Sets the distance of the inner edge of the torus from this torus primitive solid's base point.

The distance of the inner edge from this torus primitive solid's base point.

Gets the distance of the inner edge of the torus from this torus primitive solid's base point.

The distance of the inner edge from this torus primitive solid's base point.

Sets the distance of the outer edge of the torus from this torus primitive solid's base point.

The distance of the outer edge from this torus primitive solid's base point.

Gets the distance of the outer edge of the torus from this torus primitive solid's base point.

The distance of the outer edge from this torus primitive solid's base point.

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.

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.

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.

Finalizes an instance of the ITorusSolid class.

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 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.

Sets the location of the ending point for drawing this torus primitive solid as an angle, in degrees, from the base point.

The location of the ending point in degrees.

Gets the location of the ending point for drawing this torus primitive solid as an angle, in degrees, from the base point.

The location of the ending point.

Sets the location of the starting point for drawing this torus primitive solid as an angle, in degrees, from the base point.

The location of the starting point in degrees.

Gets the location of the starting point for drawing this torus primitive solid as an angle, in degrees, from the base point.

The location of the starting point.

Sets the distance of the inner edge of the torus from this torus primitive solid's base point.

The distance of the inner edge from this torus primitive solid's base point.

Gets the distance of the inner edge of the torus from this torus primitive solid's base point.

The distance of the inner edge from this torus primitive solid's base point.

Sets the distance of the outer edge of the torus from this torus primitive solid's base point.

The distance of the outer edge from this torus primitive solid's base point.

Finalizes an instance of the ITorusSolidGeometry class.

Gets the distance of the outer edge of the torus from this torus primitive solid's base point.

The distance of the outer edge from this torus primitive solid's base point.

This class is used for working with torus shaped primitive solids.

The location of the ending point for drawing this sphere.

The location of the starting point for drawing this sphere.

The distance of the outer edge of the sphere from this sphere's base point at the base of the cone.

Sets the location of the ending point for drawing this sphere primitive solid as an angle, in degrees, from the base point.

The location of the ending point in degrees.

Gets the location of the ending point for drawing this sphere primitive solid as an angle, in degrees, from the base point.

The location of the ending point.

Sets the location of the starting point for drawing this sphere primitive solid as an angle, in degrees, from the base point.

The location of the starting point in degrees.

Gets the location of the starting point for drawing this sphere primitive solid as an angle, in degrees, from the base point.

The location of the starting point.

Sets the distance of the outer edge of the sphere from this sphere primitive solid's base point.

The distance of the outer edge from this sphere primitive solid's base point.

Gets the distance of the outer edge of the sphere from this sphere primitive solid's base point.

The distance of the outer edge from this sphere primitive solid's base point.

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.

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.

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), with a radius of 0.5.

Finalizes an instance of the ISphereSolid class.

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 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.

Sets the location of the ending point for drawing this sphere primitive solid as an angle, in degrees, from the base point.

The location of the ending point in degrees.

Gets the location of the ending point for drawing this sphere primitive solid as an angle, in degrees, from the base point.

The location of the ending point.

Sets the location of the starting point for drawing this sphere primitive solid as an angle, in degrees, from the base point.

The location of the starting point in degrees.

Gets the location of the starting point for drawing this sphere primitive solid as an angle, in degrees, from the base point.

The location of the starting point.

Sets the distance of the outer edge of the sphere from this sphere primitive solid's base point.

The distance of the outer edge from this sphere primitive solid's base point.

Finalizes an instance of the ISphereSolidGeometry class.

Gets the distance of the outer edge of the sphere from this sphere primitive solid's base point.

The distance of the outer edge from this sphere primitive solid's base point.

This class is used for working with sphere shaped primitive solids.

The location of the ending point for drawing this cylinder.

The location of the starting point for drawing this cylinder.

The height of the cylinder, from the base point's Y value to the top of the cylinder.

The distance of the outer edge of the cylinder from this cylinder's base point at the base of the cone.

Sets the location of the ending point for drawing this cylinder primitive solid as an angle, in degrees, from the base point.

The location of the ending point in degrees.

Gets the location of the ending point for drawing this cylinder primitive solid as an angle, in degrees, from the base point.

The location of the ending point.

Sets the location of the starting point for drawing this cylinder primitive solid as an angle, in degrees, from the base point.

The location of the starting point in degrees.

Gets the location of the starting point for drawing this cylinder primitive solid as an angle, in degrees, from the base point.

The location of the starting point.

Sets the height of the cylinder, from the base point's Y value to the top of the cylinder.

The height of the cylinder.

Gets the height of the cylinder, from the base point's Y value to the top of the cylinder.

The height of the cylinder

Sets the distance of the outer edge of the cylinder from this cylinder primitive solid's base point.

The distance of the outer edge from this cylinder primitive solid's base point.

Gets the distance of the outer edge of the cylinder from this cylinder primitive solid's base point.

The distance of the outer edge from this cylinder primitive solid's base point.

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.

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.

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.

Finalizes an instance of the ICylinderSolid class.

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.

Sets the location of the ending point for drawing this cylinder primitive solid as an angle, in degrees, from the base point.

The location of the ending point in degrees.

Gets the location of the ending point for drawing this cylinder primitive solid as an angle, in degrees, from the base point.

The location of the ending point.

Sets the location of the starting point for drawing this cylinder primitive solid as an angle, in degrees, from the base point.

The location of the starting point in degrees.

Gets the location of the starting point for drawing this cylinder primitive solid as an angle, in degrees, from the base point.

The location of the starting point.

Sets the height of the cylinder, from the base point's Y value to the top of the cylinder.

The height of the cylinder.

Gets the height of the cylinder, from the base point's Y value to the top of the cylinder.

The height of the cylinder

Sets the distance of the outer edge of the cylinder from this cylinder primitive solid's base point.

The distance of the outer edge from this cylinder primitive solid's base point.

Finalizes an instance of the ICylinderSolidGeometry class.

Gets the distance of the outer edge of the cylinder from this cylinder primitive solid's base point.

The distance of the outer edge from this cylinder primitive solid's base point.

This class is used for working with cylinder shaped primitive solids.

The view of this arc geometry object stored in the database.

The internal view number of this arc geometry object stored in the database.

The 3D arc data associated with this ArcGeometry object.

Converts this object's data into a string representation.

(Optional) The maximum number of digits to the right of the decimal point. A text string that represents this object's data.

Sets the view number in this ArcGeomtry object.

Gets the view number in this ArcGeomtry object.

Sets the view number in this ArcGeomtry object.

Gets the view number in this ArcGeomtry object.

Set arc data.

The first point. The second point. The third point. (Optional) True to display warning on failure to calculate the arc.

Set arc data.

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.

Set arc data.

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.

Set arc data.

The arc source math object.

Gets the radius in this ArcGeomtry object.

Gets the end angle in this ArcGeomtry object.

Gets the start angle in this ArcGeomtry object.

Gets the second endpoint in this ArcGeomtry object.

Gets the first endpoint in this ArcGeomtry object.

Gets the center point in this ArcGeomtry object.

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.

Finalizes an instance of the ArcGeometry class.

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.

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.

This class provides methods for creating working with Arc geometry within Mastercam.

Smart pointers to arc geometry object objects

Sets the view number in this ArcGeometry object.

The view to set on the arc entity.

Gets the view number in this ArcGeometry object.

Sets the view number in this ArcGeometry object.

The view number to set on the entity.

Set arc data.

The first point. The second point. The third point. (Optional) True to display warning on failure to calculate the arc.

Set arc data.

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.

Set arc data.

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.

Set arc data.

The arc source math object.

Gets the view number in this ArcGeometry object.

Gets the radius in this ArcGeometry object.

Gets the end angle in this ArcGeometry object.

Gets the start angle in this ArcGeometry object.

Gets the second endpoint in this ArcGeometry object.

Gets the first endpoint in this ArcGeometry object.

Gets the center point in this ArcGeometry object.

LoadDefaults (Override). This handles the loading of defaults from a Mastercam entity.

[in,out] The entity to load the object's default values from.

Finalizes an instance of the ArcGeometry class.

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.

This class provides methods for creating working with Line geometry within Mastercam.

The location of the ending point of this arc, an angle, in degrees, from the (3 O'Clock) base point.

The location of the starting point of this arc, an angle, in degrees, from the (3 O'Clock) base point.

The radius of this arc.

The center point of this arc.

This is a static inequality operator overload for the purposes of comparing these 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. The arc to compare with the current one.. True if the two objects are considered not equal.

This is a static equality operator overload for the purposes of comparing these 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. The arc to compare with the current one.. True if the two objects are considered equal.

This is a static equality method for the purposes of comparing these 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. The first arc to compare. The second arc to compare. True if the two objects are considered equal.

Converts this object into a string representation.

(Optional) The maximum number of digits to the right of the decimal point. A text string that represents this object.

"Converts" this NET-Hook type to the corresponding Mastercam math type.

[out] The Mastercam math type.

Get the location of the ending point of the arc.

The location of the ending point of the arc.

Get the location of the starting point of the arc.

The location of the starting point of the arc.

Get the radius of the arc.

The radius of the arc.

Get the center point endpoint.

The center point of the arc.

Initializes a new instance of the Arc3D class.

The center point of the arc to be created. The radius of the arc to be created. The angle in degrees, from the 3 o'clock origin, from which the arc starts. The angle in degrees, from the o'clock origin, from which the arc ends

Initializes a new instance of the Arc3D class.

The Mastercam arc data used to initialize this Arc3D object.

Initializes a new instance of the Arc3D class.

Creates 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).

This class is used as a mathematical representation of a 3D Arc.

The 3D line data associated with this LineGeometry object.

Converts this object's data into a string representation.

(Optional) The maximum number of digits to the right of the decimal point. A text string that represents this object's data.

Gets the midpoint of this LineGeomtry object.

Sets the endpoints of the line.

The first endpoint of the line in 3D space. The second endpoint of the line in 3D space.

Sets the endpoints of the line..

The first endpoint of the line in 3D space. The second endpoint of the line in 3D space.

Sets the endpoints of the line..

The 3D line data to use for the endpoints of the line.

Gets the second endpoint in this LineGeomtry object.

Gets the first endpoint in this LineGeomtry object.

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.

Finalizes an instance of the LineGeometry class.

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.

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.

This class provides methods for creating working with Line geometry within Mastercam.

Smart pointers to LineGeometry objects.

Converts this object's data into a string representation.

(Optional) The maximum number of digits to the right of the decimal point. A text string that represents this object's data.

Gets the midpoint of this LineGeomtry object.

Sets the endpoint of the line.

The first endpoint of the line in 3D space. The second endpoint of the line in 3D space.

Sets the endpoint of the line.

The first endpoint of the line in 3D space. The second endpoint of the line in 3D space.

Sets the endpoint of the line.

The 3D line data to create the line geometry with.

Gets the second endpoint in this LineGeomtry object.

Gets the first endpoint in this LineGeomtry object.

LoadDefaults (Override). This handles the loading of defaults from a Mastercam entity.

[in,out] The entity to load the object's default values from.

Finalizes an instance of the LineGeometry class.

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.

This class provides methods for creating working with Line geometry within Mastercam.

The second endpoint of the line object.

The first endpoint of the line object.

This is a static inequality operator overload for the purposes of comparing these objects.

The line to compare with the current one. True if the two objects are considered not equal.

This is a static equality operator overload for the purposes of comparing these objects.

The line to compare with the current one. True if the two objects are considered equal.

This is a static equality method for the purposes of comparing these objects.

The first line to compare. The second line to compare. True if the two objects are considered equal.

Gets or set 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. The Line endpoint by reference.

Converts this object into a string representation.

(Optional) The maximum number of digits to the right of the decimal point. A text string that represents this object's data.

"Converts" this object' data to the corresponding Mastercam type.

[out] The Mastercam type.

Get the second endpoint.

The second endpoint.

Get the first endpoint.

The first endpoint.

Initializes a new instance of the Line3D class.

The point to become the first endpoint. The point to become the second endpoint.

Initializes a new instance of the Line3D class.

The point to become the first endpoint. The point to become the second endpoint.

Initializes a new instance of the Line3D class.

The Mastercam 3D line geometry data.

Initializes a new instance of the Line3D class.

This class is used as a mathematical representation of a 3D Line.

The 3D point data associated with this PointGeometry object.

Converts this object's data into a string representation.

(Optional) The maximum number of digits to the right of the decimal point. A text string that represents this object's data.

Sets the point in this PointGeometry object.

The X coordinate of the point. The Y coordinate of the point. The Z coordinate of the point.

Sets the point in this PointGeometry object.

The point to set in the geometry object.

Gets the point in this PointGeometry object.

The point in this PointGeometry object.

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 database. true if it succeeds, false if it fails.

Finalizes an instance of the PointGeometry class.

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.

Initializes a new instance of the PointGeometry class.

You must the PointGeometry object for it to be created in Mastercam's geometry database. Creates a new point geometry object with a default location of (0,0,0).

This class provides methods for creating working with Point geometry within Mastercam.

Smart pointers to Engine objects

Converts this object's data into a string representation.

(Optional) The maximum number of digits to the right of the decimal point. A text string that represents this object's data.

Sets the point in this PointGeometry object.

The X coordinate of the point. The Y coordinate of the point. The Z coordinate of the point.

Sets the point in this PointGeometry object.

The point to set in the geometry object.

Gets the point in this PointGeometry object.

The point in this PointGeometry object.

LoadDefaults (Override). This handles the loading of defaults from a Mastercam entity.

[in,out] The entity to load the object's default values from.

Finalizes an instance of the PointGeometry class.

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 database. true if it succeeds, false if it fails.

This class provides methods for creating working with Point geometry within Mastercam.

Get GeometryType from the class interface type.

Used internally in order to simplify factory methods available. The class interface type. The GeometryType to use for creating the object.

Makes a component.

Creates a geometry object.

You must the Geometry object for it to be created in Mastercam's geometry database. The type of the object to create. The database id to use. Null if it fails, else a shared_ptr .

Delete Assignment operator.

Delete move operator.

Default constructor.

Delete copy constructor.

Delete move-copy constructor.

Geometry entity factory.

Gets the single instance of the Geometry factory.

A pointer to the singleton instance of the Geometry Factory.

Get GeometryType from the class interface type.

Used internally in order to simplify factory methods available. The class interface type. The GeometryType to use for creating the object.

Destructor.

Creates a geometry object.

You must the Geometry object for it to be created in Mastercam's geometry database. The type of the object to create. The database id to use. Null if it fails, else a shared_ptr .

Geometry entity factory interface.

List of geometry type used in the factory to create concrete types.

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.

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.

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

A (mill) Facing milling operation.

A thread milling operation.

A circle milling operation.

An engraving operation.

A circle milling operation.

A helix bore operation.

An onion-skinning operation.

A nesting operation.

A block drilling operation.

A simple pocketing operation.

A simple drilling operation.

Standard Drill cycle.

A contour operation.

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

Don't use pre-selection at all.

Gradient background is off (use the background color only).

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.

The Right side plane, looking rightward from the right side of the WCS.

A graphics view looking rightward from the right side of the WCS.

Offset to the Left side.

The Left side plane, looking leftward from the left side of the WCS.

A graphics view looking leftward from the left side of the WCS.

The 'roll corner' modes available when offsetting a Chain.

Roll all corners.

Only roll sharp 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.

An undefined or unknown operation type.

The different user types that Mastercam can be running as.

Demo-HLE user.

Dealer user.

Educational user.

Industrial user.

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.

Indicates an error or bad user 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.

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.

Constructs an instance of the ColorsManager.

Finalizes an instance of the IColorsManager.

Gets the count of entries in the Color Table.

The count.

Delete Assignment operator.

Delete move operator.

Delete copy constructor.

Delete move-copy constructor.

This class handles the manipulation of Mastercam Color settings.

Gets the Search Manager.

A pointer to the singleton instance of the Colors Manager.

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 of 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.

Finalizes an instance of the IColorsManager.

Gets the count of entries in the Color Table.

The count.

This class handles the manipulation of Mastercam Color settings.

The location of the ending point for drawing this cone.

The location of the starting point for drawing this cone.

The height of the cone, from the base point's Y value to the top of the cone.

The distance of the outer edge of the cone from the center of the cone at the very top of the cone.

The distance of the outer edge of the cone from this cone's base point at the base of the cone.

Sets the location of the ending point for drawing this cone primitive solid as an angle, in degrees, from the base point.

The location of the ending point in degrees.

Gets the location of the ending point for drawing this cone primitive solid as an angle, in degrees, from the base point.

The location of the ending point.

Sets the location of the starting point for drawing this cone primitive solid as an angle, in degrees, from the base point.

The location of the starting point in degrees.

Gets the location of the starting point for drawing this cone primitive solid as an angle, in degrees, from the base point.

The location of the starting point.

Sets the height of the cone, from the base point's Y value to the top of the cone.

The height of the cone,

Gets the height of the cone, from the base point's Y value to the top of the cone.

The height of the cone.

Sets the distance of the outer edge of the cone from the center of the cone at the very top of the cone.

The distance of the outer edge of the cone from the center of the cone at the top of the cone.

Gets the distance of the outer edge of the cone from the center of the cone at the very top of the cone.

The distance of the outer edge from the center of the cone at the top of the cone.

Sets the distance of the outer edge of the cone from this cone's base point at the base of the cone.

The distance of the outer edge from this cone's base point at the base of the cone.

Gets the distance of the outer edge of the cone from this cone's base point at the base of the cone.

The distance of the outer edge from the base point at the base of the cone.

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.

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.

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.

Finalizes an instance of the ConeSolidGeometry class.

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 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.

Sets the location of the ending point for drawing this cone primitive solid as an angle, in degrees, from the base point.

The location of the ending point in degrees.

Gets the location of the ending point for drawing this cone primitive solid as an angle, in degrees, from the base point.

The location of the ending point.

Sets the location of the starting point for drawing this cone primitive solid as an angle, in degrees, from the base point.

The location of the starting point in degrees.

Gets the location of the starting point for drawing this cone primitive solid as an angle, in degrees, from the base point.

The location of the starting point.

Sets the height of the cone, from the base point's Y value to the top of the cone.

The height of the cone,

Gets the height of the cone, from the base point's Y value to the top of the cone.

The height of the cone.

Sets the distance of the outer edge of the cone from the center of the cone at the very top of the cone.

The distance of the outer edge of the cone from the center of the cone at the top of the cone.

Gets the distance of the outer edge of the cone from the center of the cone at the very top of the cone.

The distance of the outer edge from the center of the cone at the top of the cone.

Sets the distance of the outer edge of the cone from this cone's base point at the base of the cone.

The distance of the outer edge from this cone's base point at the base of the cone.

Finalizes an instance of the IConeSolidGeometry class.

Gets the distance of the outer edge of the cone from this cone's base point at the base of the cone.

The distance of the outer edge from the base point at the base of the cone.

This class is used for working with cone shaped primitive solids.

The width of the block primitive solid along it's Z axis.

The width of the block primitive solid along it's Y axis.

The width of the block primitive solid along it's X axis.

Sets the width of the block primitive solid along it's Z axis.

New width of the block primitive solid along it's Z axis.

Gets the width of the block primitive solid along it's Z axis.

The width of the block primitive solid along it's Z axis.

Sets the width of the block primitive solid along it's Y axis.

New width of the block primitive solid along it's Y axis.

Gets the width of the block primitive solid along it's Y axis.

The width of the block primitive solid along it's Y axis.

Sets the width of the block primitive solid along it's X axis.

New width of the block primitive solid along it's X axis.

Gets the width of the block primitive solid along it's X axis.

The width of the block primitive solid along it's X axis.

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.

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.

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).

Finalizes an instance of the IBlockSolid class.

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.

The name of the solid entity.

The vector representing the Z axis for the specified solid primitive object.

The vector representing the Y axis for the specified solid primitive object.

The vector representing the X axis for the specified solid primitive object.

The base point for the specified solid primitive object.

Get solid parameters from database entity list.

[in] The solid entity list. [out] The parameters fillet out from the db entity list. TRUE if information was filled out correctly, FALSE otherwise.

Create a solid and commit it into the database.

It requires a valid graphics view object. [in] solid information . [in/out] list of entities created [in] If true, entities created will be blanked. [in] If true remove solid creation history. TRUE if solid was created successfully and saved in the database, FALSE otherwise.

Sets the name of the solid entity.

New name of the solid entity.

Gets or sets the name of the solid entity.

Note that if the solid has the default "Solid" name, this Name will be empty!. The name of the solid entity.

Sets the vector representing the Z axis for the specified solid primitive object.

New vector representing the Z axis for the specified solid primitive object.

Gets or sets the vector representing the Z axis for the specified solid primitive object.

The vector representing the Z axis for the specified solid primitive object.

Sets the vector representing the Y axis for the specified solid primitive object.

New vector representing the Y axis for the specified solid primitive object.

Gets or sets the vector representing the Y axis for the specified solid primitive object.

The vector representing the Y axis for the specified solid primitive object.

Sets the base point for the specified solid primitive object.

New vector representing the X axis for the specified solid primitive object.

Gets or sets the vector representing the X axis for the specified solid primitive object.

The vector representing the X axis for the specified solid primitive object.

Sets the base point for the specified solid primitive object.

New based point for the specified solid primitive object.

Gets or sets the base point for the specified solid primitive object.

Base point for the specified solid primitive object.

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.

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.

Finalizes an instance of the LineGeometry class.

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. @TODO [mxs] : when we will factorize the NET-Hook API and / or implement typcaster, maybe this constructor will need to be accessible

Initializes a new instance of the SolidGeometry class.

All members are given default values. It shouldn't be called directly but only through child class creation.

This class provides methods for creating Solid geometry within Mastercam.

The point style attribute of the current geometry object.

The pen style value of the current geometry object.

The line style attribute of the current geometry object.

The line width value (1-5) of the current geometry object.

Even though this is floating point value, only the integer part is used.

The level the current geometry object is on.

The color value (0-255) of the geometry object.

True if the current geometry object has been marked as blanked, else false if not.

True if the current geometry object is selected, else false if not.

The type ID of this geometry entity.

Converts this object's data into a string representation.

(Optional) The maximum number of digits to the right of the decimal point. A text string that represents this object's data.

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. 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 .

Get IGeometry object from ent data considering making a copy or not.

ptr on the entity list. Entity of the current objet. Make a copy or modify the caller object. The newly scaled geometry object which is a shared_ptr on a copy or on the object itself.

In a geometry object from a database ID.

Gets the type (Point, Line, Arc, or?) of this geometry entity.

See SysTypes\interfaces\BaseDefines_CH.h for these 'type' values.

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.

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. 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.

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.

Loads the default values for a given 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.

Se the point style attribute of the current geometry object.

Sets the pen style value of the current geometry object.

Sets the line style attribute of the current geometry object.

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.

Sets the level the current geometry object is on.

Gets the color value (0-255) of the geometry object.

Sets the current geometry object 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.

Sets the current geometry object marked as selected, else false if not.

Gets the point style attribute of the current geometry object.

Gets the pen style value of the current geometry object.

Gets the line style attribute of the current geometry object.

Gets 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 the level the current geometry object is on.

Gets 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.

Destructor.

True if the current geometry object is marked as selected, else false if not.

Initializes a new instance of the abstract Geometry class.

All members are given default values.

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.

This class handles all of the interaction for Geometry objects within Mastercam.

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. (i.e. whether or not it's already 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.

[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 database eptr of this object if it happens to be a geometry object.

The database 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.

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 DateTime - (midnight), January 1, 0001.

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.

Set the view ID of this entity in the Mastercam database if it's a view object.

the view ID of this entity in the Mastercam database.

Get the view ID of this entity in the Mastercam database if it's a view object.

the view ID of this entity in the Mastercam database.

Set the operation ID of this entity in the Mastercam database if it's an operation object.

The operation ID of this entity in the Mastercam database.

Get the operation ID of this entity in the Mastercam database if it's an operation object.

The geometry ID of this entity in the Mastercam database.

Set the tool ID of this entity in the Mastercam database if it's a tool object.

The geometry ID of this entity in the Mastercam database.

Get the tool ID of this entity in the Mastercam database if it's a tool object.

The geometry ID of this entity in the Mastercam database.

Set the geometry ID of this entity in the Mastercam database if it's a geometry object.

the geometry ID of this entity in the Mastercam database.

Get the geometry ID of this entity in the Mastercam database if it's a geometry object.

The geometry ID of this entity in the Mastercam database.

Set whether this entity is considered 'valid' or not. (i.e. whether or not it's already in the Mastercam database).

Set whether or not it's already in the Mastercam database.

Return whether this entity is considered 'valid' or not. (i.e. whether or not it's already in the Mastercam database).

Whether this entity is considered 'valid' or not.

This flag specifies the entity type for the current entity object.

The entity type for the current entity object.

Destructor.

This flag specifies the entity type for the current entity object.

The entity type for the current entity object.

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.

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.

This is the base class for all database entities. It's methods provide generic access to database objects.

Sets the width of the block primitive solid along it's Z axis.

New width of the block primitive solid along it's Z axis.

Gets the width of the block primitive solid along it's Z axis.

The width of the block primitive solid along it's Z axis.

Sets the width of the block primitive solid along it's Y axis.

New width of the block primitive solid along it's Y axis.

Gets the width of the block primitive solid along it's Y axis.

The width of the block primitive solid along it's Y axis.

Sets the width of the block primitive solid along it's X axis.

New width of the block primitive solid along it's X axis.

Finalizes an instance of the IBlockSolid class.

Gets the width of the block primitive solid along it's X axis.

The width of the block primitive solid along it's X axis.

This class is used for working with block shaped primitive solids.

Sets the name of the solid entity.

New name of the solid entity.

Gets or sets the name of the solid entity.

Note that if the solid has the default "Solid" name, this Name will be empty!. The name of the solid entity.

Sets the vector representing the Z axis for the specified solid primitive object.

New vector representing the Z axis for the specified solid primitive object.

Gets or sets the vector representing the Z axis for the specified solid primitive object.

The vector representing the Z axis for the specified solid primitive object.

Sets the vector representing the Y axis for the specified solid primitive object.

New vector representing the Y axis for the specified solid primitive object.

Gets or sets the vector representing the Y axis for the specified solid primitive object.

The vector representing the Y axis for the specified solid primitive object.

Sets the vector representing the X axis for the specified solid primitive object.

New vector representing the X axis for the specified solid primitive object.

Gets the vector representing the X axis for the specified solid primitive object.

The vector representing the X axis for the specified solid primitive object.

Sets the base point for the specified solid primitive object.

New based point for the specified solid primitive object.

Gets the base point for the specified solid primitive object.

Base point for the specified solid primitive object.

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.

Finalizes an instance of the LineGeometry class.

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.

This class provides methods for creating Solid geometry within Mastercam.

Smart pointers to Engine objects

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.

Converts this object's data into a string representation.

(Optional) The maximum number of digits to the right of the decimal point. A text string that represents this object's data.

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.

Gets the unique database identifier for the entity.

The identifier.

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. > true to also delete any referenced items. True if the entity was successfully deleted from the Mastercam database, else false if not.

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, else 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, 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.

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.

Deletes the current entity object from the Mastercam database.

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, else false if not.

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.

Loads the default values for a given database entity object.

Commits a geometry entity to the Mastercam database.

The geometry entity to be committed. True if the commit was successful, else false if not.

Gets the type (Point, Line, Arc, or?) of this geometry entity.

See SysTypes\interfaces\BaseDefines_CH.h for these 'type' values.

Se the point style attribute of the current geometry object.

The point style to set on the geometry entity

Sets the pen style value of the current geometry object.

The pen style to set on the geometry entity

Sets the line style attribute of the current geometry object.

The line style to set on the geometry entity

Sets the line width value (1-5) of the current geometry object.

The line width (1-5) to set on the geometry entity Even though this is floating point value, only the integer part is used.

Sets the level the current geometry object is on.

The level number set on the geometry entity.

Gets the color value (0-255) of the geometry object.

The color number (0-255) to set on the geometry entity.

Sets the current geometry object 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. Set the blanked state of the geometry entity.

Sets the current geometry object marked as selected, else false if not.

Sets selected state of the geometry entity.

Gets the point style attribute of the current geometry object.

Gets the pen style value of the current geometry object.

Gets the line style attribute of the current geometry object.

Gets 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 the level the current geometry object is on.

Gets 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.

Destructor.

True if the current geometry object is marked as selected, else false if not.

This class handles all of the interaction for Geometry objects within Mastercam.

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 Mastercam Plane object for the view. A shared pointer to a View object.

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 Mastercam Plane object for the view. A native pointer to a View object.

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. A shared pointer to a View object.

Default Constructor.

All members are given default values. A shared pointer to a View object.

Smart pointer to a IView 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. A value indicating if the view is "in use" by the system and thus cannot be deleted.

Gets the a value indicating if the view object is a locked ("reserved") system view.

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.

The ID of the view object.

Sets the view number of the current view object.

The view number of the current view object.

Gets the view number of the current view object.

The view number of the current view object.

Sets the comment on the current view object.

the comment on the current view object.

Gets the comment on the current view object.

The comment on the current view object.

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. the work offset number of this view object.

Gets the name of the current view object.

The work offset number of this view object.

Sets the work offset number of this view object.

the work offset number of this view object.

Gets the work offset number of this view object.

The work offset number of this view object

Sets the origin of this view object.

the view matrix of this view object.

Gets the origin of this view object.

The view matrix of this view object.

Sets the view matrix of this view object.

the view matrix of this view object.

Gets the view matrix of this view object.

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.

Finalizes an instance of the PointGeometry class.

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.

This class is used for modifying and creating view entities in Mastercam.

Smart pointers to Engine objects

Loads the default values for a given database entity object.

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.

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.

[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 database eptr of this object if it happens to be a geometry object.

The database 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.

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 DateTime - (midnight), January 1, 0001.

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.

Set the view ID of this entity in the Mastercam database if it's a view object.

the view ID of this entity in the Mastercam database.

Get the view ID of this entity in the Mastercam database if it's a view object.

the view ID of this entity in the Mastercam database.

Set the operation ID of this entity in the Mastercam database if it's an operation object.

The operation ID of this entity in the Mastercam database.

Get the operation ID of this entity in the Mastercam database if it's an operation object.

The geometry ID of this entity in the Mastercam database.

Set the tool ID of this entity in the Mastercam database if it's a tool object.

The geometry ID of this entity in the Mastercam database.

Get the tool ID of this entity in the Mastercam database if it's a tool object.

The geometry ID of this entity in the Mastercam database.

Set the geometry ID of this entity in the Mastercam database if it's a geometry object.

the geometry ID of this entity in the Mastercam database.

Get the geometry ID of this entity in the Mastercam database if it's a geometry object.

The geometry ID of this entity in the Mastercam database.

Set whether this entity is considered 'valid' or not. (i.e. whether or not it's already in the Mastercam database).

Set whether or not it's already in the Mastercam database.

Return whether this entity is considered 'valid' or not. (i.e. whether or not it's already in the Mastercam database).

Whether this entity is considered 'valid' or not.

Destructor.

This flag specifies the entity type for the current entity object.

The entity type for the current entity object.

This is the base class for all database entities. It's methods provide generic access to database objects.

The 3D point object that represents the third row within the matrix.

The 3D point object that represents the second row within the matrix.

The 3D point object that represents the first row within the matrix.

This is a static inequality operator overload for the purposes of comparing these 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. The matrix to compare to the current one. True if the two objects are considered not equal.

This is a static equality operator overload for the purposes of comparing these 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. The matrix to compare to the current one. True if the two objects are considered equal.

This is a static equality method for the purposes of comparing these 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. The first matrix to compare. The second matrix to compare. True if the two objects are considered equal.

Gets the specified value at a row/column of this Matrix3D. This is the parentheses operator overload so that the values within this matrix be accessed via an array-like interface.

The row used within the parentheses must be either 0, 1 or 2 to access either the first, the second or the third row of the matrix. The column used within the parentheses must be either 0, 1 or 2 to access the desired column of the matrix. The value at the row, column of the matrix by reference.

Gets the specified row of this Matrix3D. This is the bracket operator overload so that the 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 desired row of the matrix. The matrix row endpoint by reference.

"Converts" this Matrix3D type to the corresponding Mastercam matrix type.

[out] The Mastercam style matrix.

Sets the third row within the matrix.

The data to set for the third row of the matrix..

Gets the third row within the matrix.

A point containing the data of the third row of the matrix..

Sets the second row within the matrix.

The data to set for the second row of the matrix..

Gets the second row within the matrix.

A point containing the data of the second row of the matrix..

Sets the first row within the matrix.

The data to set for the first row of the matrix..

Gets the first row within the matrix.

A point containing the data of the first row of the matrix..

Initializes a new instance of the Point3D class.

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.

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.

The second endpoint of the line object.

The first endpoint of the line object.

This is a static inequality operator overload for the purposes of comparing these objects.

The line to compare with the current one. True if the two objects are considered not equal.

This is a static equality operator overload for the purposes of comparing these objects.

The line to compare with the current one. True if the two objects are considered equal.

This is a static equality method for the purposes of comparing these objects.

The first line to compare. 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. The Line endpoint by reference.

Converts this object into a string representation.

(Optional) The maximum number of digits to the right of the decimal point. A text string that represents this object.

"Converts" this NET-Hook type to the corresponding Mastercam math type.

[out] The Mastercam math type.

Gets the second endpoint.

The second endpoint.

Gets the first endpoint.

The first endpoint.

Initializes a new instance of the Line2D class.

The point to become the first endpoint. The point to become the second endpoint.

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.

Compare case insensitive for std::wstring.

The first string. The second string. True if they match, else false if not.

Case insensitive compare of two characters.

The first character. The second character. True if they match, else false if not.

Format the coordinate data in a Point3D.

The point. (Optional) The number of digits to the right of the decimal. The formatted point data.

Format the coordinate data in a Point2D.

The point. (Optional) The number of digits to the right of the decimal. The formatted point data.

Format the coordinate data in a 3D point.

The point. (Optional) The number of digits to the right of the decimal. The formatted point data.

Format the coordinate data in a 2D point.

The point. (Optional) The number of digits to the right of the decimal. The formatted point data.

Formats a double value.

The value. (Optional) The number of digits to the right of the decimal. The formatted value.

The Z coordinate value of the 3D point.

The Y coordinate value of the 3D point.

The X coordinate value of the 3D point.

This is a static inequality operator overload for the purposes of comparing these 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. The first 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 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. The first point to compare. True if the two objects are considered equal.

This is a static equality method for the purposes of comparing these 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. The first point to compare. The second point to compare. True if the two objects are considered equal.

Array indexer operator.

Zero-based index of the point coordinate. The indexed value.

This method performs a scaling operation on the 3D point.

The value of the scale. The Point coordinate by reference.

This is the dot product method so that two points can have their dot products calculated.

The first point in the dot product operation. The second point in the dot product operation. The value of the dot 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 second point in the dot product operation. The cross product between the two input points.

This is a cross product method so that two points can have their cross product calculated.

The first point in the cross product operation. 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.

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.

The point that will be subtracted from. 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.

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.

The first point in the point addition operation. 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.

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.

(Optional) The maximum number of digits to the right of the decimal point. A text string that represents this object.

"Converts" this C-Hook type to the corresponding Mastercam type.

[in,out] The Mastercam math type.

"Converts" this C-Hook type to the corresponding Mastercam math type.

[in, out] The Mastercam type point data.

Sets the Z Coordinate value.

The Z Coordinate value.

Gets the Z Coordinate value.

The Z Coordinate value.

Sets the Y Coordinate value.

The Y Coordinate value.

Gets the Y Coordinate value.

The Y Coordinate value.

Sets the X Coordinate value.

The X Coordinate value.

Gets the X Coordinate value.

The X Coordinate value.

Initializes a new instance of the Point3D class.

This point's X value. This point's Y value. This point's Z value.

Initializes a new instance of the Point3D class.

The Mastercam 3D point data.

Initializes a new instance of the Point3D class.

Initializes a new instance of the Point3D class.

The point coordinate 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. To "emulate" the internal thing, we use public but not exported settings.

The Y coordinate value of the 2D point.

The X coordinate value of the 2D point.

This is a static inequality operator overload for the purposes of comparing these 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. The point to compare with the current one. True if the two objects are considered not equal.

This is a static equality operator overload for the purposes of comparing these 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. The point to compare with the current one. True if the two objects are considered equal.

This is a static equality method for the purposes of comparing these 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. The first point to compare. 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. The Point coordinate by reference.

This is the dot product method so that two points can have their dot product calculated.

The first point in the dot product operation. 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.

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.

The point that will be subtracted from. 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 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.

The first point in the point addition operation. 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.

The second point in the point addition operation. A new point representing the vector addition of the class object data and parameter.

Convert this object into a string representation.

(Optional) The maximum number of digits to the right of the decimal point. A text string that represents this object.

"Converts" this NET-Hook type to the corresponding Mastercam math type.

[out] The Mastercam math type.

Get the Y Coordinate value.

The Y Coordinate value.

Get the X Coordinate value.

The X Coordinate value.

Initializes a new instance of the Point2D class.

The value to become this point's X value. The value to become this point's Y value.

Initializes a new instance of the Point2D class.

The Mastercam 2D point data.

Initializes a default new instance of the Point2D class.

Initializes a new instance of the Point2D class.

The Mastercam 2D point 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. To "emulate" the internal thing, we use public but not exported settings.

Gets the Settings Manager.

A pointer to the singleton instance of the Settings Manager.

Finalizes an instance of the ISettingsManager.

Gets the current system tolerance used within Mastercam.

This class is used to modify common settings within the Mastercam environment.

Defines and Using declarations.

Declares the SolidGeometry interface.

Declares the Geometry interface. Base interface for all geometry objects.

Declares the IEntity public interface. Base interface for all database objects.

Defines and Using declarations.

Declares the GeometryFactory class.

Declares the GeometryFactory interface.

Declares the Geometry interface. Base interface for all geometry objects.

Declares the IEntity public interface. Base interface for all database objects.

Defines and Using declarations.

Declares the TypeCaster class.

Declares the TypeCaster class.

Declares the Geometry interface. Base interface for all geometry objects.

Declares the IEntity public interface. Base interface for all database objects.

Defines and Using declarations.

Declares the SearchManager interface.

Declares the SearchManager class.

Declares the Mastercam::Database::IView interface.

Declares the IEntity public interface. Base interface for all database objects.

Defines and Using declarations.

Declares the Geometry interface. Base interface for all geometry objects.

Declares the IEntity public interface. Base interface for all database objects.

Defines and Using declarations.

Declares the SolidGeometry interface.

Declares the abstract Geometry class. Base class for all geometry objects.

Declares the abstract Entity class. Base class for all database objects.

Declares the IEntity public interface. Base interface for all database objects.

Defines and Using declarations.

Declares the abstract Geometry class. Base class for all geometry objects.

Declares the abstract Entity class. Base class for all database objects.

Declares the IEntity public interface. Base interface for all database objects.

Defines and Using declarations.

Declares the SearchManager class.

Declares the Mastercam::Database::IView interface.

Declares the IEntity public interface. Base interface for all database objects.

Defines and Using declarations.

Declares the abstract Entity class. Base class for all database objects.

Declares the IEntity public interface. Base interface for all database objects.

Defines and Using declarations.

Declares the PointGeometry class.

Declares the PointGeometry interface.

Declares the Geometry interface. Base interface for all geometry objects.

Declares the IEntity public interface. Base interface for all database objects.

Defines and Using declarations.

Declares the Mastercam::Database::MCView class.

Declares the Mastercam::Database::IView interface.

Declares the IEntity public interface. Base interface for all database objects.

Defines and Using declarations.

Modified version of verify_2d_operation. This one reads toolpath motion data stored in a format different than binary nci (see CHST2DTpFileMgr).

WEB, 4/20/2017. The current operation idn. Use only entities at or below this depth. Increase the tool by this amount (decrease, if negative). [in,out] If non-null, the rough bitmap. The tool radius to use (useful if no tool included in path motion). Temporary toolpath header file. Temporary toolpath motion file (McTpBdyElement format). [in,out] (Optional) If non-null, (Optional) the pbmap memory block.

Maximum distance from one pock bound to another pock bound.

One pock bound. Another pock bound. The chordal deviation (burst arcs to lines). The maximum distance.

Pock bound to polyline.

If pock bound is closed this duplicates the point at the seam (last == first) This fills any gap in between pock bound entities except between the first and last A pock_bound to process. [in,out] The points. The chordal deviation (burst arcs to lines).

Are two pock_bounds disjoint?.

Test two bounding boxes for overlap. The first pock_bound. The second pock_bound. True if pock_bounds are truly disjoint, false if they overlap or abut (or are just too close to call).

Populate bounding box (.min_pt, .max_pt) for each pock_bound in a linked list.

This builds the true min/max box about all entities of each pock_bound. [in,out] If non-null, the bound.

Populate bounding box (.min_pt, .max_pt) for one pock_bound.

This builds the true min/max box about all entities of the pock_bound. [in,out] If non-null, the bound.

Is point in any machinable area?

Determine whether a point is inside an outer boundary or outside an island. Works with multiple pockets. [in,out] If non-null, the bounds defining the machinable area. The point to test. True if point is in machinable area, false if not.

Point in ctour. Test point to see if it lies inside, on or outside closed contour.

The closed pocket boundary. The point to test. (Optional) the tolerance A, historically nc_tol. (Optional) the tolerance B, historically tol. 1 if the given point lies INSIDE the contour. 0 if point is ON the contour. -1 if point is OUTSIDE the contour.

Find distance between a 2D point and a finite 2D line.

If the point projects outside the line, return the distance to the closest endpoint. The 2D point. The 2D line. The distance from the point to the line.

Searches for a path around an island.

Given two points that lie on a closed contour (boundary), find the direction to travel that will result in the shortest path or the path that goes along the bottom of the island. The closed boundary. The first intersection point. The second intersection point. True to search for minimum burial path, False to search for shortest path. [in,out] If non-null, the minimum distance between inters0 and inters1. [in,out] If non-null, the direction where 1 = forward, -1 = reverse and 0 indicates stay on same entity. POCK_OK or POCK_FN_ERR.

Get index of the next pock_bound entity, in the stepping direction (+1/-1).

The maximum number pock_bound entities. Zero-based index of the current pock_bound entity. The stepping direction +1/-1. The index of the next pock_bound entity in the stepping direction.

Calculate perimeter (length) of pock_bound.

[in,out] If non-null, a pock_bound to process. A double which is the perimeter (length).

Rotate 2D point.

[in,out] The point. The cosine of the rotation angle. The sine of the rotation angle.

Display a warning message if not in batch mode.

String ID of message to post. (Optional) Resource handle of the product calling this function.

Rotate 2D point (rotation angle specified by globals (cos_rough, sin_rough).

The input 2D point. [in,out] The rotated 2D point.

Draw a pseudo bit map.

bit map to draw GAF line set to fill. If null, old GrTemp objects are drawn view number. depth to draw at. true = show stock, false = show machined area. color @par Purpose: Fill in a bit map from a linked list of pocket boundaries @param[in] bounds pocket boundaries @param[in] r offset amount @param[in,out] m bit map @par Purpose: Free the memory allocated by init_pbmap @param[in,out] m the pseudo bit map @par Purpose: Initialize the pseudo bit map data structure (used to keep track of machined stock) @param[in] y_min minimum y value @param[in] y_max maximum y value @param[in] dy distance between scan lines @param[out] m the pseudo bit map @return error code Toolpath structure used with pbmap One record of a boundary Structure for tracking cut stock. There is one record for each y level

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)

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.

@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

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.

Query if 'pWnd' is window suspended.

If non-null, the window. True if window suspended, false if not.

Log messages (if active) and return if dialog should be displayed (based on global logging variables)

The text. The caption. (Optional) The message class for logging. True to skip message box, false to display message box.

Get a system error message.

The error number as defined in winerror.h.

Show a system error message.

The error number as defined in winerror.h. Optional title for the message box. Added on 22 May 2007 by RJW * @par Purpose: * This method displays a one line warning and operation * description, with optional silent messaging. * * @param[in] op_idn operation ID number. * @param[in] msg_id message resource id. * @param[in] ourParent parent dialog (or NULL) * @param[in] rsrc_handle Resource handle (optional) * @param[in] isSilent is the message logged silently, true or false * * @note In order for a component to use this method, it must have a * string resource named IDS_OPMGR defined. @par Purpose: This method displays a one line warning in an "OK" box @param[in] msg warning to display to the user @param[in] ourParent parent dialog (or NULL) par Purpose: This method displays a one line warning and operation description. param[in] op_idn operation ID number. param[in] msg_id message resource id. param[in] ourParent parent dialog (or NULL) param[in] rsrc_handle Resource handle (optional) note In order for a component to use this method, it must have a string resource named IDS_OPMGR defined. Added on 22 May 2007 by RJW * @par Purpose: * This method displays a one line warning in an "OK" box, * with optional silent messaging * * @param[in] msg warning to display to the user * @param[in] ourParent parent dialog (or NULL) * @param[in] isSilent is the message logged silently, true or false * Added on 22 May 2007 by RJW * @par Purpose: * This method posts a malloc error * * @param[in] ourParent parent dialog (or NULL) * @param[in] isSilent is the message logged silently, true or false Added on 22 May 2007 by RJW * @par Purpose: * This method posts an allocation error * * @param[in] ourParent parent dialog (or NULL) * @param[in] isSilent is the message logged silently, true or false @par Purpose: This method posts an error based on the given error number. @param[in] error_code the error code. @param[in] ourParent parent dialog (or NULL) @par Purpose: This method posts an allocation error @param[in] ourParent parent dialog (or NULL) @par Purpose: This method posts a malloc error @param[in] ourParent parent dialog (or NULL) Added on 22 May 2007 by RJW * @par Purpose: * This method posts an error based on the given error number. * * @param[in] error_code the error code. * @param[in] ourParent parent dialog (or NULL) * @param[in] isSilent is the message logged silently, true or false

Posts a corrupt file warning.

Filename of the file. (Optional) If non-null, (Optional) our parent window. (Optional) True if is silent, false if not. @par Purpose: to display a warning dialog to the user @note If a NULL rsrc_handle is passed in, then the function will attempt to match the msg_id's with matching ones in the Core string table. @param[in] msg_id message resource id @param[in] rsrc_handle (optional): resource handle of the product call this function @param[in] ourParent parent dialog (or NULL) Added on 22 May 2007 by RJW * @par Purpose: * to display a warning dialog to the user, with optional silent messaging * * @note If a NULL rsrc_handle is passed in, then the function will attempt to match the msg_id's * with matching ones in the Core string table. * * @param[in] msg_id message resource id * @param[in] rsrc_handle (optional): resource handle of the product call this function * @param[in] ourParent parent dialog (or NULL) * @param[in] isSilent is the message logged silently, true or false @par Purpose: Log a message to the current message log destination (None, Screen, File, or Both) @param[in] pCaption Message box caption @param[in] pMsg Message to log or display in a message box @param[in] mbStyles Any combination of Windows' message box types, icons, modality (ex. MB_YESNO | MB_ICONQUESTION) @param[in] pParent Message box parent window @param[in] helpId (Optional) help id @return The response from the message box (IDOK, IDCANCEL, IDYES, IDNO, etc.) @par Purpose: Displays a message box with: YES, NO, and CANCEL button combinations. @return 1 => YES, 2 => NO, 4 => CANCEL. @param[in] msg message string @param[in] title title string for message box @param[in] ync combination of YES, NO, CANCEL @param[in] icon_flag What Icon should be shown: 1=STOP,2=?,3=!,4=*,other=none @param[in] ourParent parent dialog (or NULL) @par Purpose: Displays a message box. @param[in] msg message string @param[in] title title string for message box @param[in] ourParent parent dialog (or NULL) @par Purpose: This method report whether there are any suspened windows. @return false = no suspended windows @par Purpose: This method resumes the current window processing by restoring the current stack of displayed windows. @param[in] cwndResume CWnd ptr of window to resume. @param[in] mode SW_RESTORE (default). @par Purpose: This method resumes the current window processing by restoring the current stack of displayed windows. @param[in] modeless true, if driven from a modeless window, else, false (default). @param[in] mode SW_RESTORE (default). @par Purpose: This method suspends the current window processing by minimizing (default) or hiding the currently displayed window. @param[in] cwndSuspend CWnd ptr of the target window. @param[in] modeless true, if driven from a modeless window, else, false (default). @param[in] mode SW_MINIMIZE (default) or SW_HIDE. @param[in] pResumeFocus CWnd ptr to force "resume" focus. @return true, if OK, else, false. @par Purpose: This method suspends the current window processing by minimizing (default) or hiding the current stack of displayed windows. @param[in] cwndSuspend CWnd ptr of the target window. @param[in] modeless true, if driven from a modeless window, else, false (default). @param[in] mode SW_MINIMIZE (default) or SW_HIDE. @param[in] pResumeFocus CWnd ptr to force "resume" focus. @return true, if OK, else, false. @} 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

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.

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.

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). 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.

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

Run the OnSelectionChangedCallback callback function if handled.

True if handled, false otherwise.

Set the OnSelectionChangedCallback callback function.

The OnSelectionChangedCallback callback. The previous OnSelectionChangedCallback function pointer. OnSelectionChangedCallback function definition

Clears the selection of MCO meshes.

The selection bit to check and clear. (Optional) True to check global setting. True if it succeeds, false if it fails.

Clears the selection of MCO mesh.

The entity. (Optional) True to check global setting. True if it succeeds, false if it fails.

Clears the selection of MCO mesh.

The entity. (Optional) True to check global setting. True if it succeeds, false if it fails.

Query if entity is MCO mesh.

The entity. True if MCO mesh, false if not.

Query if entity is MCO mesh.

The entity. True if MCO mesh, false if not.

Gets allow selection of MCO mesh setting.

Current setting.

Sets allow selection of MCO mesh setting.

True to allow selection of MCO mesh. Previous value.

Destructor.

Constructor.

Push allow MCO setting.

Sets color of button labels based on the current graphics background color(s).

True if it succeeds, false if it fails.

Get index of currently selected object.

Index.

Cursor is over a selection object.

The cursor position. True to change highlight. The SelObj identifer. Otherwise, 0.

Clears the previous mouse move point.

Selects all entities specified via an entity mask.

If all entities are currently selected, all entities will be unselected. Entity mask.

See how many entities are selected.

(Optional) flag to bypass FunctionLevel check. the count.

See how many entities are selected.

The mask of entity ids. the count.

Check if only wireframe types are selected.

Always false unless called from function level 0. true if only wireframe types are selected.

Check if any wireframe types are selected.

Always false unless called from function level 0. true if any wireframe types are selected.

Check if only drafting types are selected.

Always false unless called from function level 0. true if only drafting types are selected.

Check if any drafting types are selected.

Always false unless called from function level 0. true if any drafting types are selected.

Check if only surfaces are selected.

Always false unless called from function level 0. true if only surfaces are selected.

Check if any surfaces are selected.

Always false unless called from function level 0. true if any surfaces are selected.

Check if only solids are selected.

Always false unless called from function level 0. true if only solids are selected.

Check if any soilds are selected.

Always false unless called from function level 0. true if any solids are selected.

Check if only poly-meshes are selected.

Always false unless called from function level 0. true if only poly-meshes are selected.

Check if any poly-meshes are selected.

Always false unless called from function level 0. true if any poly-meshes are selected.

Get a mask of the currently selected entity type ids.

Only returns non-zero when called from function level 0, except when bypassFunctionLevelCheck is true. bypassFunctionLevelCheck should only be true when called extenally via CHook. (Optional) flag to bypass FunctionLevel check. A mask of the selected type ids.

Set the selected types mask state to dirty.

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. A preselection flag value, of the MC_PRESEL type. If non-null, the selected eptrs. Flag that indicates use of display list or database when searching for selected ents. Entity mask to use if enhanced face selection is available. The return code, of the MC_RETURN type, of the function.

Checks if poly selection (polygon or vector) is currently active.

True if poly selection is active, false otherwise.

Checks if window selection is currently active.

True if window selection is active, false otherwise.

Special revision of get_event for drafting.

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. The return code, of the MC_RETURN type, of the get_event function.

Wait for and then get some sort of user input event.

This version of get_event allows the caller to select types of solid edges that are different than specified wireframe curve types. Solid edge selection is enabled by including EDGE_MASK_ID in the entity mask and EM_SldEdge in the event mask. By default, the types of edges selected (line, arc, nurb) is determined by the specified wireframe entity mask types (L_ID, A_ID, and NB_ID, respectively). If the caller wishes to select edge types that are different than the wireframe curve types, specify the edge types in "edgeMask". 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). A combination of entity mask bit flag types for limiting edge selection (L_ID, A_ID, NB_ID. 0 for same as wireframe curve types). 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.

Wait for and then get some sort of user input event.

If justCursorPos is true, only the cursor position is returned for a Sketch event. If false, the cursor position is mapped to world space but only if the construction plane is not perpendicular to the graphics view. If the mapping is successful, normal processing continues including special handling of the Shift and Ctrl keys (e.g. relative position). Calling the version of get_event declared in MCInput_CH.h calls this function passing false for justCursorPos. 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. If true, returns only the cursor position for a Sketch event. The return code, of the MC_RETURN type, of the get_event function.

Select entities and solids.

Entity eptrs. Solid tags. Prompt. Entity Mask. (Optional) Solid Mask. (Optional) Solid Mask defaults. (Optional) Activate window selection of faces and edges. (Optional) PreSelection mode. (Optional) Use display list. The return code, of the MC_RETURN type, of the get_event function.

Gets the SelectEntsOrdered solid mask.

The solid mask.

Set the IsRubberBandLineEnabled callback function.

The IsRubberBandLineEnabled callback. The previous IsRubberBandLineEnabledCallback function pointer. IsRubberBandLineEnabledCallback function definition

Determines if key message is handled.

The message structure for the WM_KEYDOWN message. True if in edit mode, false otherwise.

Set the IsKeyMessageHandled callback function.

The IsKeyMessagHandled callback. The previous IsKeyMessageHandledCallback function pointer. IsKeyMessageHandledCallback function definition

Removes the selection arrow described by tag.

The tag.

Adds a selection arrow.

Arrow base point. Arrow direction. Tag to identify the arrow. (Optional) Color for arrow. (Optional) The primary (= default) arrow is displayed full length, others are shorter. (Optional) True if arrow to be used for drag - will move cursor pos to arrow base so drag from base.

Determines if we are in edit mode.

True if in edit mode, false otherwise.

Resets the state of a selection object if it's highlighted or is running a dynamic edit.

This function should be called if a selection object's visibility is being turned off. It will prevent events from being directed to the hidden selection object. Selection object. (Optional) Redraw graphics flag. True if the selection object's state was reset.

Cancels the current selection object dynamic edit.

This function provides an alternative to a Esc key which normally cancels a dynamic edit. When called, the selection object is returned to its position/orientation at the start of the edit. If requested, a redraw occurs only if there is an active dynamic edit. Redraw graphics flag. True if a dynamic edit was canceled, false otherwise.

Ends the current selection object dynamic edit.

This function provides an alternative to a left mouse button click which normally ends a dynamic edit. When called, the current drag position/orientation is applied to the selection object. If requested, a redraw occurs only if there is an active dynamic edit. Redraw graphics flag. True if a dynamic edit was ended, false otherwise.

Locks a selection object so it will no longer produce drag events.

If true, lock; if false, unlock.

Checks if a selection object is dynamically editing.

Optional pointer to returned selection item. True if active, false if inactive.

Sets the specified selection object to dynamically edit the specified item.

Any current dynamic edit is canceled. Selection object. Item to edit. True if successful, false if invalid selection object or item.

Gets the status of an edit event.

This function is valid only for EM_SelObjEdit. All other events will return SelObjEdit::CANCEL. Event object containing a selection object event. Edit status.

Gets the selection button info identified by the button event.

This function is valid only for EM_SelObjButton. The button state is that which is currently displayed on the button. The button index number is the value assigned to the button at its creation. Event object containing a selection object event. Optional pointer to returned button up/down (false/true) flag. Optional pointer to returned button index number. Button state or -1 if not a button event.

Gets the selection item identified by the specified event.

Selection object events that return an item are EM_SelObjSelect, EM_SelObjStart, EM_SelObjDrag, and EM_SelObjEnd. Event object containing a selection object event. Selection item or 0 for none.

Gets 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. Selection object (invalid if wrong type of event or selection object not found).

Gets the number of selection objects in the selection list.

Number of selection objects.

Removes all selection objects from the selection list.

Calling this function cancels any current dynamic edit. By default, the graphics are redrawn after the selection objects are removed. However, there is no redraw if the selection list is empty. Optional redraw graphics flag. True if any selection objects were removed, false if list is empty.

Removes a selection object from the selection list.

Calling this function cancels any current dynamic edit. Selection object to remove. True if the selection object was removed, false if not found.

Adds a selection object to the selection list.

Calling this function cancels any current dynamic edit. Selection object to add. (Optional) If true, add object to overlay display list. (Optional) If true, add object to start of list; if false, to end of list.

Calculates the center point of the current selected entities.

The point. true if successful.

Gets automatic cursor temporary center point status.

true if active.

Sets automatic cursor temporary center point status.

true to active.

Sets active event mode.

The mode.

Gets active event mode.

The active event mode.

Sets active event hover status.

The status.

Gets active event hover status.

The active event hover status.

Resets polygon or window selection if active.

Called from CMastercamApp::InitInstance to initialize the state of some static objects.

This function must not be called before the graphics view object is instantiated.

Shows the QuickMask dialog in modal mode.

done this way to be able to mock it. The selected page index. True to enable mask only mode, false to disable it. [in,out] If non-null, the selected mask. [in,out] If non-null, the current selected mask. [in,out] If non-null, the parent window. [out] The value returned by the dialog. [out] True to ces plane filter. [out] True to ces ignore depths. [in,out] True to maintain.

Page of the QuickMask dialog to open.

Entity masking mode.

Display the Select All dialog.

not used. A MC_RETURN status code (always MC_NOERROR).

Display the Select Only dialog.

not used. A MC_RETURN status code (always MC_NOERROR).

Sets the cursor at the selection object's home position.

View matrix. World-to-device scale.

Sets the edit flags based on the specified arguments.

Edit has started. Edit has completed. Edit has been canceled. Edit control has exited prematurely. Edit control has continued. Returned edit flags.

Gets the anchor point used to calculate the tangent line.

Anchor point.

Checks if tangent get_event processing is allowed.

True if allowed, false otherwise.

Process WM_KEYDOWN messages for the floating edit.

Current mode of the event manager. WPARAM for message. LPARAM for message. Returned edit flags. True if successful, false otherwise.

Converts a ParaSolid edge to a Mastercam curve entity.

This function will set the maximum curvature and the endpoints for NURB splines. ParaSolid edge tag. Curve entity. True if successful; false otherwise.

Called to "drag" the selection object on the specified mesh facet for the align axis edit mode.

If successful, wc.pnt1/wc.pnt2 will define a vector to which the selection object should be aligned. The vector is aligned as a normal. View rotation matrix. Cursor position (VC) projected to entity. Returned World positions. True if drag was successful; false otherwise.

Called to "drag" the selection object on the specified solid for the align axis edit mode.

If successful, wc.pnt1/wc.pnt2 will define a vector to which the selection object should be aligned. For edges, the vector is aligned tangent to the edge. For faces, the vector is aligned as a normal. Processing for faces additionally includes "snapping" to a vertex if it is close to the cursor position. Setting wc.pnt3 is optional and dependent on the selection object. View rotation matrix. Cursor position (VC) projected to entity. Returned World positions. True if drag was successful; false otherwise.

Called to "drag" the selection object on the specified entity for the align axis edit mode.

If successful, wc.pnt1/wc.pnt2 will define a vector to which the selection object should be aligned. For wireframe entities and solid edges, the vector is aligned tangent to the entity (or edge) except for an arc center, in which case it is normal. For solid faces and surfaces, the vector is aligned as a normal. Processing for solid faces additionally includes "snapping" to a vertex if it is close to the cursor position. Setting wc.pnt3 is optional and dependent on the selection object. View rotation matrix. Cursor position (VC) projected to entity. Pointer to tangent anchor or nullptr if none. Entity on which to do the projection. Curve parameters. Selection type (see "entry_codes" in OpmanDefs_CH.h). Returned World positions. True if drag was successful; false otherwise.

Allows a selection object to compute a normal (returned as WC point 2) based on an autocursor position (WC point 1) and the associated entity (or entities).

Returning WC point 3 is optional and dependent on the selection object. If a normal is not computed, no changes are made to "wc". Returned World positions.

Drags the selection object to a new orientation/position by applying the specified cursor or World position(s) as allowed by the current edit mode.

View rotation matrix. Construction plane matrix. World-to-device scale. Cursor position. World positions. Snap to 3D positions flag. Snap to horz/vert positions flag. (Optional) if true, we drag from an autocursor position. Action to take as a result of the drag.

Sets the selection object to the value returned by the UI edit control.

This function is called each time the user enters a value in the edit control. The "complete" flag must be false as long as the edit control remains open. When it's dismissed, via either the Esc or Enter key, the function must be called with the "complete" flag passed as true. Edit value. Edit complete flag. True if it succeeds, false if it fails.

Gets the initial value to load into the UI edit control when it "replaces" the selection object's graphic edit object.

Initial edit value.

Sets the selection object's edit field enabled flag.

Enable flag. True if edit field enabled value has changed.

Gets graphic edit object associated with the current edit mode.

Pointer to edit object or nullptr if none.

Called by UtSelect when this object has been removed from the selection list.

Called by UtSelect when this object has been added to the selection list.

If true, the object was added to the overlay display list.

Gets the world coordinate cursor point based on the edit mode.

This function is designed to be called immediately after setting an edit state active. It prevents this object from "jumping" to align itself to the cursor position. World-to-device scale. Cursor point in world coordinates. True if cursor point returned, otherwise false.

Gets T value.

the t value.

Reset the information relative to the event.

Update the information relative to the event.

Set the information relative to the event.

The selection event. If true, we save the event only if it is from a certain type.

Sets the cursor at the selection object's home position.

Gets the drag information for the current drag event.

View matrix. Cursor position (VC). Pointer to tangent anchor or nullptr if none. Returned world positions.

Called when editing a selection object, this function allows the selection object to override the get_event event mode and entity mask flags if warranted by the edit mode.

Event mode flags. Entity mask flags.

Updates the settings for this selection object's graphic object if the type matches.

Graphic object type affected by the settings.

Runs the settings dialog for this selection object.

Returned graphic object type affected by the settings. True if any settings have changed.

Gets the status of the edit field.

Edit flags.

Process the KEYDOWN message for potential edit.

WPARAM for message. LPARAM for message. Selection item or 0 if none.

Process the message.

Event mode mask. Entity mask. The message. WPARAM for message. LPARAM for message. Returned edit flags. True if it succeeds, false if it fails.

Checks if the selection object is currently displaying an edit field.

true if an edit field is displayed, false otherwise.

Applies the current drag values to the selection object.

Drags the selection object to a new orientation/position by applying the specified cursor or World position(s) as allowed by the current edit mode.

This base class function provides default drag processing. Overload this function if the selection object requires special processing. View rotation matrix. Construction plane matrix. World-to-device scale. Cursor position. WC position. (Optional) if true, we drag from an autocursor position. Action to take as a result of the drag.

Drags the selection object to a new orientation/position by applying the specified cursor or World position(s) as allowed by the current edit mode.

This base class function provides default drag processing. Overload this function if the selection object requires special processing. View rotation matrix. Construction plane matrix. World-to-device scale. Cursor position. Event mode mask. Entity mask. (Optional) if true, we drag from an autocursor position. Action to take as a result of the drag.

Gets the flag that controls whether or not GetCursorPos will return an updated cursor position.

If true, allow GetCursorPos to adjust the cursor position.

Sets the flag that controls whether or not GetCursorPos will return an updated cursor position.

If true, allow GetCursorPos to adjust the cursor position.

Gets the world coordinate cursor position based on the edit mode.

This function is designed to be called immediately after setting an edit state active. It prevents this object from "jumping" to align itself to the cursor position. This feature can be disabled by calling SetCursorPosAdjust. World-to-device scale. Cursor point in world coordinates. True if cursor position returned, otherwise false.

Gets this object's button info.

Button selection objects return their info. All other selection object types return -1. Optional pointer to storage for returned button state. Index number assigned to button or -1 if none.

Sets the selection object's edit mode.

Edit mode. Selected item used to determine edit mode. Event to generate on return from this function.

Gets whether or not the selection object is visible.

If true, the object is visible.

Sets whether or not the selection object is visible.

If true, make object visible. Previous visible state.

Checks if the specified item is valid.

An item value of zero is not considered valid. Item to validate. True if valid, false if invalid.

Sets a cursor associated with the specified selection item (if any).

Selection item.

Gets the currently highlighted selection item.

Highlighted item or 0 if none.

Highlights the specified selection item.

Item to highlight.

Checks if the specified cursor position selects an item on the selection object.

View matrix. World-to-device scale. Cursor position (VC). If true, do alternate selection. Returned selection hit data. Selection item or 0 if none.

Checks if this object is selectable.

True if selectable; false if not.

Sets whether or not the object is selectable.

This function works as a "master switch" to control whether an object is selectable or not. When set true, each selection object will include this switch in its criteria for determining if the object is selectable. If true, object is selectable. Previous selectable state.

Gets the graphic object associated with this selection object.

Graphic object.

Gets the flag that indicates this object is to enable the function panel if there is one.

If true, function panel is to be enabled if there is one.

Sets the flag that indicates this object is to enable the function panel if there is one.

When instantiated, "enable function panel" is false. If true, function panel is to be enabled if there is one.

Gets the flag that indicates this object is drawn on top of other graphic objects.

If true, object is drawn as an overlay.

Sets the flag that indicates this object is drawn on top of other graphic objects.

When instantiated, "overlay" is false. If true, object is drawn as an overlay.

Gets the custom edit message processing function for the floating double edit field.

null if it fails, else the edit function.

Gets the type of this object.

Selection object type.

Destructor.

Constructor.

Edit flags Edit message processing function return codes Event to generate on return from SetEditMode Edit mode

Selection object base class.

Selection object edit status

Right-handed permutations.

A simple index with a safety marker.

Possible orientations between two vectors.

Sets entity selection.

The entity. True to select. Otherwise, unselect.

Top level analyze mask.

Entity mask.

Top level analyze type.

The entity. True if entity type is supported.

Activates the top level analyze if entity exists at selection point.

The selection point. The entity. Entity or null_eptr.

Check for selected entity.

If a non-zero entity mask is supplied, selection is restricted to those types. The selection point. The entity. Selection t parameter. (Optional) Entity mask. True if it succeeds, false if it fails.

Process the message.

The message id. The wParam field of the message. The lParam field of the message. True if it succeeds, false if it fails.

Select entities by mask.

Selection mask.

Select entities by bit.

The selection bit. (Optional) Selection mask.

Gets the entities identified by the selection bits that match the selection mask criteria.

Entity selection bits (for search). Selection mask. If true, invert selection of matching entities. Returned eptrs for all entities except solids (none returned if "invert" is true). Returned solid face tags. The selection condition of the entities identified in "eptrs".

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.

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

Do not roll any corners.

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.

Unbend sld.

Identifier for the planar face. The body. True if it succeeds, false if it fails.

Gets solid vector.

The solid vector.

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.

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

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.

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

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 Selection Mask Type Selection Mask depth comparisons Selection Mask length and diameter comparisons @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 @{ @} @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.

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

Calculates the number of chains in the linked list.

The linked list. The total number 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 @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

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.

@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.

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 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 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 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). @defgroup assocvar_ch15 nci line types @{ @} List Return Code types @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.

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.

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.

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.

Declare the GeometryManipulatorManager class. This class provides utility functions to manipulate geometries.

Declares the GeometryManipulatorManager interface. This inteface provides utility functions to manipulate geometries.

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 TlMillingOpParams type and its shared_ptr/unique_ptr aliases.

Declares the TlOpParams 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 TlCoolant 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 TlToolGrade type and its shared_ptr/unique_ptr aliases.

Declares the TlWorkMaterial type and its shared_ptr/unique_ptr aliases.

Declares the TlToolMaterial type and its shared_ptr/unique_ptr aliases.

Declares the TlMaterial 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 TlHolder 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 TlToolMill 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 TlAssembly type and its shared_ptr/unique_ptr aliases.

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.

Includes all "common" header files used in the C-Hook API.

This file is used to include all the Mastercam headers that the API needs.

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.