"NETHook3_0"
Query if Mastercam is running under an evaluation license (software licenses only).
true if evaluation license, false if not.
This method returns the currently active "user" type.
The user type Mastercam is running in.
This method returns the currently active "product" type in Mastercam.
The product mode Mastercam is currently in.
Note that this does not return information regarding any active machines,
but rather information regarding the product itself and could include modes,
such as Drafting and Design.
Gets the serial number from the Mastercam license.
The Serial number.
Writes the active configuration to a configuration file.
The (full path) name of the Config file.
true if it succeeds, false if it fails.
Reads configuration file.
The (full path) name of the Config file.
true to repaint graphics.
true if it succeeds, false if it fails.
This method is used for changing Inch / Metric configuration in the system.
True and the system is changed to Metric,
else false and the system is changed to Inch.
How the settings are to be changed.
You can display the standard Units Changing dialog to ask the user, or...
Set the option you want "silently".
True regenerate any Solids with the new settings.
This method reloads the configuration file.
Gets the active Configuration filename.
Finalizes an instance of the Configuration class.
Initializes a new instance of the Configuration class.
This class is used for various Mastercam configuration items.
Resolve assemblies.
Handles the assembly resolve.
If non-null, the sender.
If non-null, the arguments.
nullptr if it fails, else an Assembly^.
Posts a DialogResult message to the event queue.
You can then capture this "command" message in your GetEvent loop,
allowing you to detect when the modeless dialog is closing,
so that you can (optionally) end the GetEvent loop.
The type of DialogResult to be sent.
true if it succeeds, false if it fails.
Posts a DialogResult.Cancel message to the event queue.
queue.
You can then capture this "command" message in your GetEvent loop,
allowing you to detect when the modeless dialog is closing,
so that you can (optionally) end the GetEvent loop.
true if it succeeds, false if it fails.
Posts a DialogResult.OK message to the event queue.
queue.
You can then capture this "command" message in your GetEvent loop,
allowing you to detect when the modeless dialog is closing,
so that you can (optionally) end the GetEvent loop.
true if it succeeds, false if it fails.
Initializes a new instance of the ModelessDialog class.
You can derive your Form from this to 'automatically' setup the TabHandler.
This class is used to manage the handling of Tab Keys in a Modeless Dialog.
The instance of the ModelessDialogTabs class.
ModelessDialogTabs is defined in the ModelessDialogTabHandler.dll
Initializes a new instance of the ModelessDialogTabsHandler class.
You pass your (Windows) Form to this constructor and
it will enable the proper handling of the tab key navigation for the dialog.
The Dialog (Form) to be have its tab navigation handled.
This class is used to manage the handling of Tab Keys in a Modeless Dialog.
Inserts a third party ribbon tab as described by ribbonXml.
The XML that defines the Tab and its contents.
True if it succeeds, false if it fails.
A class for the creation of a custom Tab in the Mastercam Ribbon.
Convert a Managed ViewSheetData package to the native format.
The managed representation of the ViewSheetData.
The resulting unmanaged representation of the ViewSheetData.
true if it succeeds, false if it fails.
Initializes a new instance of the ViewSheets class.
Private Constructor.
Sets the current state for all "Save to ViewSheets" settings.
The is equivalent to Enable/Disable All.
The desired on/off state for all settings.
A ViewSheetSettings with the requested state, else null if it fails.
Sets the current "Save to ViewSheets" settings.
The options for controlling the operation.
true if it succeeds, false if it fails.
Gets the current "Save to ViewSheets" settings.
[out] The options for controlling the save operation.
true if it succeeds, false if it fails.
Displays the ViewSheet settings dialog.
Query if 'name' is valid name (not already used).
The name to check.
true if the name is valid, false if not.
Creates a copy of the specified ViewSheet.
The (zero-based list) index of the ViewSheet to be copied.
The (zero-based list) index of the new ViewSheet, else -1 if failed.
Sets the bookmark data package for the specified ViewSheet.
The (zero-based list) index of the ViewSheet.
[out] The data package for the bookmark.
true if it succeeds, false if it fails.
Gets the data bookmark package for the specified ViewSheet.
The (zero-based list) index of the ViewSheet.
[out] The data package for the bookmark.
true if it succeeds, false if it fails.
Sets the data package for the specified ViewSheet.
The (zero-based list) index of the ViewSheet.
The data package.
true if it succeeds, false if it fails.
Gets the data package for the specified ViewSheet.
The (zero-based list) index of the ViewSheet.
[out] The data package.
true if it succeeds, false if it fails.
Rename a ViewSheet.
ViewSheet names must be unique!
The (zero-based list) index of the ViewSheet.
The new name for the specified ViewSheet.
true if it succeeds, false if it fails (invalid index or invalid name).
Deletes the bookmark on a ViewSheet.
The (zero-based list) index of the ViewSheet.
true if it succeeds, false if it fails (invalid index).
Query if a ViewSheet has bookmark.
The (zero-based list) index of the ViewSheet to be copied.
true if it does, false if it not.
Restore bookmark.
The (zero-based list) index of the ViewSheet to be copied.
true if it succeeds, false if it fails.
Saves a bookmark on a ViewSheet.
The (zero-based list) index of the ViewSheet.
true if it succeeds, false if it fails (invalid index).
Gets the name of a ViewSheet.
The (zero-based list) index of the ViewSheet.
The name is successful, else an empty string if not.
Gets the index of a ViewSheet.
The name to search for. (case sensitive!)
The (zero-based list) index of the ViewSheet if found, else -1
Sets the active ViewSheet.
The (zero-based list) index of the ViewSheet.
true if it succeeds, false if it fails.
Gets the index of the active ViewSheet.
The (zero-based list) index of the active ViewSheet.
Deletes a ViewSheet.
The (zero-based list) index of the ViewSheet.
true if it succeeds, false if it fails (invalid index).
Creates a new ViewSheet.
ViewSheet names must be unique!
The name for the ViewSheet.
true if it succeeds, false if it fails.
Creates a new ViewSheet.
true if it succeeds, false if it fails.
Gets the ViewSheets count.
The number of ViewSheets in the list.
Sets the enabled state of ViewSheets in the Mastercam session
The on/off state to set.
Get the enabled status of ViewSheets in the Mastercam session.
true if the are enabled, else false if not.
Gets a or sets value indicating whether the multiple view sheets are enabled.
Initializes a new instance of a ViewSheetSettings.
The native unmanaged data used to initialize the managed.
Initializes a new instance of a ViewSheetSettings.
When checked, save spaceball position
When checked, save display mode settings
When checked, save stock display settings
When checked, save advanced toolpath display settings
When checked, save selected planes
When checked, save section view settings
Auto restore bookmark settings?
Save the Surface Density setting?
Save the Line width?
Save the Point style?
Save the Line style?
Save the Active level?
Save the Color setting?
Save the WCS Plane?
Save the Construction Z Depth?
Save the Construction Planes?
Save the Tool Planes?
Save the section view planes?
Save the Graphic View?
Save the 2D/3D construction mode setting?
The "Save to ViewSheets" settings.
Each represents the on/off state of the checkbox options.
Initializes a new instance of a ViewSheetDataPackage.
The "native" data to convert into a managed package.
Initializes a new instance of a ViewSheetDataPackage.
True to omit internal edges
True to omit smooth edges
Angle in degrees of radial hatching on primitive
The color of edges when in outline mode
Alternative hidden color
Render color
Dim percent (0 - 100)
Combination of HIDDEN_NOSHOW, HIDDEN_DIMMED, HIDDEN_DASHED
1 = Course, 10 = Fine
RENDER_WIRE, RENDER_HIDDEN, RENDER_SHADE, RENDER_OUTLINED.
Holds viewsheet's copy of pCurrentGraphicsView->m_CurrentRenderMode.
Holds viewsheet's copy of global gl_fulltime_translucent flag.
keeps track of which stock display types get saved
True if stock display is enabled, otherwise false.
Keeps track of which section view types get saved in the viewsheet
True if section view is enabled, otherwise false.
Keeps track of which advanced toolpath display types get saved in the viewsheet
True if advanced toolpath display is enabled, otherwise false.
List of plane IDs for planes that are currently selected
Spaceball rotation point
List of plane IDs for planes that have section property set
WCS Plane ID#
Graphics (view) Plane ID#
Tool Plane ID#
Construction Plane ID#
The active level number
Surface Density setting
List of (visible) level numbers
Line width setting
Construction Z depth
Graphics viewport height
Graphics viewport center point
WCS matrix
Graphics Plane (view) matrix
Tool Plane matrix
Construction Plane matrix
Solids color
Surface color
Wireframe color
Construction Mode; true = 3D, false = 2D
A ViewSheet data package.
This class is used to work with and manage Mastercam ViewSheets.
Pointer to Mastercam's work (view) sheet tab control class.
Query if 'index' is a valid index.
Zero-based index of the list of ViewSheets to check.
true if valid index, false if not.
Creates a copy of a ViewSheetData class.
The data to be copied for the ViewSheet.
The resulting copy.
Initialized this object.
true if it succeeds, false if it fails.
Initializes a new instance of the ViewSheets class.
Private Constructor.
Displays the ViewSheet settings dialog.
Query if 'name' is name valid (not already used).
The name to check.
(Optional) true to do a case sensitive match.
true if the name is valid, false if not.
Query if a ViewSheet has bookmark.
The (zero-based list) index of the ViewSheet to be copied.
true if it does, false if it not.
Restore bookmark.
The (zero-based list) index of the ViewSheet to be copied.
true if it succeeds, false if it fails (invalid index).
Creates a copy of the specified ViewSheet.
The (zero-based list) index of the ViewSheet to be copied.
The (zero-based list) index of the new ViewSheet, else -1 if failed.
Sets the data package for the specific ViewSheet.
The (zero-based list) index of the ViewSheet.
[in] The data package.
(Optional) true to update the bookmark data.
true if it succeeds, false if it fails.
Gets the data package for the specific ViewSheet.
The (zero-based list) index of the ViewSheet.
[out] The data package.
(Optional) true to retrieve the bookmark data.
true if it succeeds, false if it fails.
Gets the name of a ViewSheet.
The (zero-based list) index of the ViewSheet.
The name is successful, else and empty string if not.
Rename a ViewSheet.
ViewSheet names must be unique!
The (zero-based list) index of the ViewSheet.
The new name for the specified ViewSheet.
true if it succeeds, false if it fails (invalid index or invalid name).
Gets the index of a ViewSheet.
The name to search for.
(Optional) true to do a case sensitive match.
The (zero-based list) index of the ViewSheet if found, else -1
Deletes the bookmark on a ViewSheet.
The (zero-based list) index of the ViewSheet.
true if it succeeds, false if it fails (invalid index).
Saves a bookmark on a ViewSheet.
The (zero-based list) index of the ViewSheet.
true if it succeeds, false if it fails (invalid index).
Sets the active ViewSheet.
The (zero-based list) index of the ViewSheet.
true if it succeeds, false if it fails.
Gets the index of the active ViewSheet.
The index of the active ViewSheet.
Deletes a ViewSheet.
The (zero-based list) index of the ViewSheet.
true if it succeeds, false if it fails (invalid index).
Creates a new ViewSheet.
The name for the ViewSheet.
true if it succeeds, false if it fails (name already used?).
Creates a new ViewSheet.
true if it succeeds, false if it fails.
Gets the number if ViewSheets.
The number sheets.
Sets the enabled state of ViewSheets.
true to enable, false to disable.
Query if ViewSheets are enabled.
true if it they are, false if not.
This class is an "unmanaged" wrapper around Mastercam's ViewSheets.
This method takes the ID of a nesting sheet, tries to find the operation in the
database matching that sheet ID, and returns a NestingOperation object representing
that operation in the database.
This is the ID of the sheet to look for in the database.
A NestingOperation object if the operation was found in the database,
else a null object if not.
This method makes a bitmap image file of the specified sheet within the currently
opened Mastercam part file.
The name and path of the bitmap file to create.
This needs to be the number of the sheet to create a bitmap image of.
True if the bitmap file was created successfully, else false if not.
This method returns the number of nested sheets in the currently opened Mastercam part
file.
The number of nested sheets in the current file.
Initializes a new instance of the NestingManager class.
Private Constructor.
Made private so as not to allow anyone to create an instance of it.
This class is used to manage nesting settings within the Mastercam environment.
Loads the default values for a given mesh geometry object from the geometry
entity passed in.
[in,out] The mesh geometry entity to use as defaults for this
mesh geometry object.
Commits a mesh geometry entity to the Mastercam database.
[in,out] The mesh geometry entity to be committed.
True if the commit was successful; false if not.
Initializes a new instance of the MeshGeometry class.
Attempts to retrieve a mesh geometry entity with the given ID from the Mastercam
database and use that to initialize this mesh geometry object.
If no matching geometry entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the mesh geometry entity to look up in the Mastercam database.
This class is used for working with Polygonal Mesh entities within Mastercam.
Takes the data from an unmanaged Mastercam 'tp_holder' structure and loads it
into the managed 'ToolHolder::Holder' object.
The Mastercam 'tp_holder' struct containing the holder data to transfer.
The managed ToolHolder::Holder to be filled in.
true if it succeeds, false if it fails.
Retrieve the (HST-style) Mill Tool Holder from the specified operation.
The ID of the operation to read from.
[out] The filled in Holder object.
true if a Holder was found in the Operation, else false.
Initializes a new instance of a Holder structure.
The maximum diameter of the holder.
Overall height of the holder.
Name of the holder library.
Name of the holder.
The list of holder segments.
The number of segments in the holder.
A (Mill) Holder.
The height of the segment.
The lower diameter of the segment.
The upper diameter of the segment.
A HolderSegment (a triplet of double values).
Private Constructor.
So as not to allow anyone to create an instance of this class.
This class handles (HST style) Tool Holder object interaction between
the NET-Hook operation objects and Mastercam operations.
Gets or sets the current post processor arguments in Mastercam.
Initializes a new instance of the PostingManager class.
Private Constructor.
Made private so as not to allow anyone to create an instance of it.
This class is used for working with Mastercam post processor settings.
It allows for passing (3) string variables from a Post Processor to a NET-Hook,
and also passing (3) values back from the NET-Hook to the Post.
Gets or sets the third post processor argument.
Gets or sets the second post processor argument.
Gets or sets the first post processor argument.
This is a static inequality operator overload for the purposes of comparing these
objects.
This is the first object to compare.
This is the second object to compare.
True if the two objects are considered not equal.
This is a static equality operator overload for the purposes of comparing these
objects.
This is the first object to compare.
This is the second object to compare.
True if the two objects are considered equal.
This is an equality method for the purposes of comparing this object to another one.
This is the object to compare against.
True if the two objects are considered equal.
This is a static equality method for the purposes of comparing two objects.
This is the first object to compare.
This is the second object to compare.
True if the two objects are considered equal.
This class represents the data needed to represent a polygon.
@par Purpose:
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
@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.
Offset Chains.
The chains to be processed.
Options for controlling the offset.
[out] A list of the resulting "new" geometry.
True if it succeeds, false if it fails.
Offset a single Chain.
The chain to be processed.
Options for controlling the offset.
[out] A list of the resulting "new" geometry.
True if it succeeds, false if it fails.
Break many pieces.
The geometry to be processed. This geometry must already have been committed to
Mastercam's database!
Options for controlling the break.
[out] A list of the resulting "new" geometry.
[out] A list of geometries where errors occurred (if any).
True if it succeeds, false if it fails.
Executes the "transform - move to origin" action.
The "from point" (world coordinates)..
True to move all entities, false move just the selected entities.
True if it succeeds, false if it fails.
Perform a "silent" Combine Views operation on the active database.
Move 'grouped' geometry to level.
The type(s) of selection groups to search for.
The target Level# (move "to").
This method resets the Level# of all current entities that match
the specified Group Type; Result and/or Group.
This only affects geometry that is already committed to Mastercam's database! It does NOT effect the state of any NET-Hook side geometry objects.
That is why it can be "fast".
The number of entities that were copied, or -1 if the specified level# was not valid.
Move all selected geometry to a level.
This method resets the Level# of all currently 'selected' entities to
the specified destination level.
This only affects geometry that is already committed to Mastercam's database!
It does NOT effect the state of any NET-Hook side geometry objects.
That is why it can be "fast".
The target Level# (move "to" level).
Clear the 'selection' on the entities when done?
The number of entities that were copied, or -1 if the specified level# was not valid.
Copy all selected geometry to a level.
This method does an "in-place" XForm translate on ALL selected entities
(regardless of their Level) which makes copies and then scans the
database for all RESULT GROUP entities and resets their Level# to the
specified destination level.
This only affects geometry that is already committed to Mastercam's database!
It does NOT effect the state of any NET-Hook side geometry objects.
That is why it can be "fast".
The target Level# (copy "to").
Clear the 'selection' on the entities when done?
The number of entities that were copied, or -1 if the specified level# was not valid.
XForm-Scale all of the 'selected' geometry entities.
NOTE!
Any Geometry objects that get altered will NOT be reflected in that entity's data
"on the NET-Hook side" if that entity's data is being held in a NET-Hook Geometry object! You can use to retrieve the result
of the XForm operation. If there was no 'selected' geometry found to be XForm'd,
the return result will be 'true'. Note that all 'selections' will be cleared by the XForm operation.
The scale origin point (in world coordinates).
The scaling factor.
true to copy, else false to move.
true if it succeeds, false if it fails.
XForm-Mirror all of the 'selected' geometry entities.
NOTE!
Any Geometry objects that get altered will NOT be reflected in that entity's data
"on the NET-Hook side" if that entity's data is being held in a NET-Hook Geometry object! You can use to retrieve the result of
the XForm operation. If the supplied view is null, the active Construction View will be used. If there was no 'selected' geometry found to be XForm'd, the return result will be 'true'. Note that all 'selections' will be cleared by the XForm operation.
The axis to mirror about.
The view.
true to copy, else false to move.
true if it succeeds, false if it fails.
XForm-Rotate all of the 'selected' geometry entities.
The rotation origin point (in world coordinates).
The rotation angle.
The view.
true to copy, else false to move.
NOTE!
Any Geometry objects that get altered will NOT be reflected in that entity's data
"on the NET-Hook side" if that entity's data is being held in a NET-Hook Geometry object! You can use to retrieve the result of the
XForm operation. If the View is null, the active Construction View will be used. If there was no 'selected' geometry found to be XForm'd, the return result will be 'true'. Note that all 'selections' will be cleared by the XForm operation.
true if it succeeds, false if it fails.
XForm-Translate all of the 'selected' geometry entities.
NOTE!
Any Geometry objects that get altered will NOT be reflected in that entity's data
"on the NET-Hook side" if that entity's data is being held in a NET-Hook Geometry object! You can use to retrieve the
result of the XForm operation. If a supplied view is null, the active Construction View will be used. If there was no 'selected' geometry found to be XForm'd, the return result will be 'true'. Note that all 'selections' will be cleared by the XForm operation.
The 'from' point (in world coordinates).
The 'to' point (in world coordinates).
The 'from' view.
The 'to' view.
true to copy, else false to move.
true if it succeeds, false if it fails.
Join entities.
[in,out] The lines to be joined.
The lines are passed 'by reference' as the lines in the array will be altered.
Some lines will be deleted and others will be altered by the join.
The number of joins that were made (or -1 on error).
Join arcs entities.
[in,out] The arcs to be joined.
The arcs are passed 'by reference' as the arcs in the array will be altered.
Some arcs will be deleted and others will be altered by the join.
The number of joins that were made (or -1 on error).
Break an Arc at its midpoint.
[in,out] The arc to break.
The 2nd half of the arc, else null if it fails.
Break a Line at its midpoint.
[in,out] The line to break.
The 2nd half of the line, else null if it fails.
Fillet a chain.
If you pass '-1' for Color and/or Level the active "main" Color and/or Level will be used.
The chain to be filleted.
The fillet radius.
The color# to be used for the fillet(s).
The level# to place the fillet(s) on.
An array of the fillet (arcs) that were created.
Fillet a chain.
The chain to be filleted.
The fillet radius.
true if it succeeds, false if it fails.
Create a Fillet between two entities.
GeomCurve1 and GeomCurve1 can be either lines and/or arcs.
If you pass '-1' for Color and/or Level the active "main" Color and/or Level will be used.
The first geometry entity.
The second geometry entity.
The fillet radius.
The color# to be used for the fillet.
The level# to place the fillet on.
true to trim the supplied geometry to the fillet.
The fillet (arc) that was created, else null if it fails.
Create a Fillet between two entities.
GeomCurve1 and GeomCurve1 can be either lines and/or arcs.
The first geometry entity.
The second geometry entity.
The radius of the fillet.
true to trim the supplied geometry to the fillet.
True fillet was successfully created, else false if it fails.
Break an 'curve' entity (line or arc) at its midpoint (worker method).
[in,out] The geometry entity to be broken.
The 2nd half of the entity, else null if it fails.
Fillet a chain (worker method).
The chain to be filleted.
The fillet radius.
The color# to be used for the fillet.
The level# to place the fillet on.
[out] The fillets that were created.
true if it succeeds, false if it fails.
Create a Fillet between two entities (worker method).
GeomCurve1 and GeomCurve1 can be either lines and/or arcs.
The first geometry entity.
The second geometry entity.
The radius of the fillet.
The color# to be used for the fillet.
The level# to place the fillet on.
true to trim the supplied geometry to the fillet.
[out] The fillet that was created.
true if fillet was successfully created, else false if it fails
Join entities (worker method).
[in,out] The geometry to be joined.
The array of entities must contains either all lines or all arcs!
The number of joins that were made (or -1 on error).
Private Manager Constructor.
Made private so as not to allow anyone to create an instance of it.
This class is used for performing graphics-related tasks and activities.
Refresh/reloads levels from OnIdle if necessary.
Load the Level Manager's image on a given button
pointer to the UIBitmapButton control
Do a fresh load of the level list after a file new/open.
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 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.
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 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.
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.
Resets the entity count of one or all levels.
(optional) Negative number for all levels, otherwise which level to reset the count of.
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.
This method replaces all draft entities with lines.
The level number of the level to process.
Gets the number of entities on all used levels.
True to include, false to exclude the blanked entities.
A dictionary collection were the Key is the level number and
the Value is the number of entities on that level.
Count the number of entities on a level.
If you are calling this method multiple times to get the number of entities for multiple levels,
you may want to use
The level number.
True to include, false to exclude the blanked entities.
The number of entities on the level.
Does the specified level have any entities?
This is a "quick" search, as it does not look to see "how many" entities the level has.
Once a single entity is found on this level, it returns 'true'.
The level number.
true if there are any entities on the level, false if not.
Deletes the levels described by levelSetName.
The level will deleted only...
If it contains no geometry entities and it is not the "main" level.
The name of the level set (multiple levels can have the same level set name).
The number of levels that were deleted. (-1 if an empty level set name was supplied)
Deletes the levels described by levelName.
The level will deleted only...
If it contains no geometry entities and it is not the "main" level.
The name of the level (multiple levels can have the same name).
The number of levels that were deleted. (-1 if an empty level name was supplied)
Deletes the level described by levelNumber.
The level will deleted only...
If it contains no geometry entities and it is not the "main" level.
The level number.
true if it succeeds, false if it fails.
This method returns an array of level numbers representing each level that has
a Level name associated with it.
An array containing the IDs of all of the levels that have level names.
This method gets the Level Number(s) that have the Level Name and/or LevelSet name.
Since there is no restriction on Level "names" and LevelSet "names" being
unique, there can be multiple matches. You supply which "name" (or names)
you wish to match on - Level "name", LevelSet "name" or both.
The Level name to match. (can be blank!)
The LevelSet name to match. (can be blank!)
An array containing the IDs of all of the matching levels.
This method gets the Level Number(s) that have the Level name.
Since there is no restriction on Level "names" unique,
there can be multiple matches.
The Level name to match.
An array containing the IDs of all of the matching levels.
This method gets the Level Set name of a given level.
The level number of the level whose level set name is to be retrieved.
The Level Set name of the specified level.
This method sets the LevelSet name of a given level.
The level number of the level whose level name is to be changed.
The new Level Set name of the specified level.
The name was successfully set. This will be false if the name was truncated.
The total combined length of the Level "name" AND the LevelSet "name"
cannot exceed 295 characters.
This method gets the Level name of a given level.
The level number of the level whose name is to be retrieved.
The name of the specified level.
This method sets the Level name of a given level.
The number of the level whose level name is to be changed.
The new name of the specified level.
The name was successfully set. This will be false if the name was truncated.
The total combined length of the Level "name" AND the LevelSet "name"
cannot exceed 295 characters.
This method returns an array of level numbers representing each level that has any
geometry on it.
An array containing the IDs of all of the levels that have geometry.
This method returns an array of level numbers representing each currently active
levels within Mastercam.
An array containing the IDs of all of the currently active levels.
This method returns an array of level numbers representing each currently visible
levels within Mastercam.
An array containing the IDs of all of the currently visible levels.
This method sets the visibility of a given level within Mastercam.
If the specified level number does not already exist, it will be created.
If the Level being turned OFF is the Main level, it will be set invisible
even if the "Make main level always visible" option is checked in the Level
Manager.
The number of the level to have it's visibility set.
Whether or not the specified level should be visible.
True if the level visibility was set successfully and false if not.
This method sets the visibility of level(s) within Mastercam.
The name of the LevelSet to have it's visibility set.
Whether or not the specified level should be visible.
The number of levels that were affected.
This method sets the visibility of level(s) within Mastercam.
Since there is no restriction on Level "names" being unique, there can be
multiple matches when selecting "by name"! If the Level being turned OFF is
the Main level, it will be set invisible even if the "Make main level
always visible" option is checked in the Level Manager.
The name of the Level to have it's visibility set.
Whether or not the specified level should be visible.
The number of levels that were affected.
This method checks to see if a given level is currently visible within Mastercam.
This is the number of the level to check for visibility.
True if the level if currently visible and false if not.
Sets the Main (active) level within Mastercam.
If the specified level number does not already exist, it will be created.
The number of the level to set as the active Main level.
true if is succeeds, false if it fails to set the level.
Sets the main (active) level within Mastercam.
There can be multiple levels with the specified "name".
*If that is the case, this function sets the first matching level found to
be the Main Level.*
If the specified level number does not already exist, it will be created.
The name of the level to set as the active Main level.
The number of the level that was set has the Main level, or -1 if no level with the
specified name was found.
Gets the level number of the current Main Level.
The number of the Main (active) level that is set in Mastercam.
Sets the on/off state of the 'Only Active level is visible' setting.
True to enable, or false to disable the setting.
Gets the on/off state of the 'Only Active level is visible' setting.
True if the option is enabled (checked) or false if not.
Sets the on/off state of the 'Active level is always visible' setting.
True to enable, or false to disable the setting.
Gets the on/off state of the 'Active level is always visible' setting.
True if the option is enabled (checked) or false if not.
Refreshes the Level Manager dialog data display.
Changes your NET-Hook makes to the levels data may not be reflected in the Level Manager pane
until you tell it to refresh itself.
Mastercam Level "name" and LevelSet "name" is stored internally in a single string as ->
LevelName~~~LevelSetName.
Initializes a new instance of the LevelsManager class.
Private Constructor.
Made private so as not to allow anyone to create an instance of it.
This class is used to work with entity levels within Mastercam.
Initializes a new instance of the StringUtilityFailedException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the StringUtilityFailedException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the StringUtilityFailedException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the StringUtilityFailedException class.
If non-null, the serailization information.
The context.
This exception class was created to be thrown if a string conversion utility failed.
Initializes a new instance of the LibraryFreeFailedException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the LibraryFreeFailedException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the LibraryFreeFailedException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the LibraryFreeFailedException class.
If non-null, the serialization information.
The context.
This exception class was created to be thrown if an attempt to free a library failed.
Initializes a new instance of the Contour3DSubtypeException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the Contour3DSubtypeException class.
If non-null, the message.
Initializes a new instance of the Contour3DSubtypeException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the Contour3DSubtypeException class.
If non-null, the serialization information.
The context.
This exception class was created to be thrown if an app attempts to use 2D chain geometry
in a 3D Contour operation.
Initializes a new instance of the Contour2DSubtypeException class.
Initializes the exception instance with a specified error message and the inner
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the Contour2DSubtypeException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the Contour2DSubtypeException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the Contour2DSubtypeException class.
If non-null, the serialization information.
The context.
This exception class was created to be thrown if an application attempts to use
3D chain geometry in a 2D Contour operation.
Initializes a new instance of the InvalidArrayIndexException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the InvalidArrayIndexException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the InvalidArrayIndexException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the InvalidArrayIndexException class.
If non-null, the serialization information.
The context.
This exception class was created to be thrown if an attempt was made to access an array
item with an invalid index.
Initializes a new instance of the NullParameterEditingDialogException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
The message.
The inner exception.
Initializes a new instance of the NullParameterEditingDialogException class.
Initializes the exception instance with a specified error message.
The message.
Initializes a new instance of the NullParameterEditingDialogException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the NullParameterEditingDialogException class.
If non-null, the serialization information.
The context.
This exception class was created to be thrown if an attempt was made to launch an
editing dialog with a null parameter object.
Initializes a new instance of the SolidsNotAllowedException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the SolidsNotAllowedException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the SolidsNotAllowedException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the SolidsNotAllowedException class.
If non-null, the information.
The context.
This exception class was created to be thrown if solids manipulation and creation is not
allowed on the current user's system.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
The message.
The inner exception.
Initializes the exception instance with a specified error message.
The message.
Initializes the exception instance with a default error message .
Initializes a new instance of the InvalidGroupException class.
The serialization information.
The context.
This exception class was created to be thrown if there is no Machine/Toolpath groups and one is required.
Initializes a new instance of the InvalidGroupIDException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
The message.
The inner exception.
Initializes a new instance of the InvalidGroupIDException class.
Initializes the exception instance with a specified error message.
The message.
Initializes a new instance of the InvalidGroupIDException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the InvalidGroupIDException class.
The serialization information.
The context.
This exception class was created to be thrown if an invalid group ID was referenced.
Initializes a new instance of the OutputFileNotSpecifiedException class.
Initializes the exception instance with a specified error message and the inner
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the OutputFileNotSpecifiedException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the OutputFileNotSpecifiedException class.
Initializes a new instance of the OutputFileNotSpecifiedException class.
If non-null, the serialization information.
The context.
This exception class was created to be thrown if an attempt was made to write to a nesting
file without first specifying a filename and path.
Initializes a new instance of the TypeMismatchException class.
Initializes the exception instance with a specified error message
and the inner exception that caused it.
[in,out] If non-null, the message.
[in,out] If non-null, the inner exception.
Initializes a new instance of the TypeMismatchException class.
Initializes the exception instance with a specified error message.
[in,out] If non-null, the message.
Initializes a new instance of the TypeMismatchException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the TypeMismatchException class.
If non-null, the serialization information.
The context.
This exception class was created to be thrown if there was a type mismatch between
a NET-Hook entity object and the entity in the Mastercam database.
Initializes a new instance of the EntityReadFailedException class.
Initializes the exception instance with a specified error message
and the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the EntityReadFailedException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the EntityReadFailedException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the EntityReadFailedException class.
If non-null, the serialization information.
The context.
This exception class was created to be thrown if an attempt to read an entity from the Mastercam database failed for some reason.
Initializes a new instance of the EntityWriteFailedException class.
Initializes the exception instance with a specified error message
and the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the EntityWriteFailedException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the EntityWriteFailedException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the EntityWriteFailedException class.
If non-null, the information.
The context.
This exception class was created to be thrown if an attempt to write an entity to the
Mastercam database failed for some reason.
Initializes a new instance of the EntityInvalidException class.
Initializes the exception instance with a specified error message
and the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the EntityInvalidException class.
Initializes the exception instance with a specified error message.
[in,out] If non-null, the message.
Initializes a new instance of the EntityInvalidException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the EntityInvalidException class.
If non-null, the serialization information.
The context.
This exception class was created to be thrown if an entity database operation is attempted
on an invalid entity that needs to be valid.
(ie. deleting an entity that is invalid to begin with for example).
Initializes a new instance of the IDNotFoundException class.
Initializes the exception instance with a specified error
message and the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the IDNotFoundException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the IDNotFoundException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the IDNotFoundException class.
If non-null, the information.
The context.
This exception class was created to be thrown if an entity is supposed to be valid
(ie. it exists in the Mastercam database) but the ID cannot be found.
Initializes a new instance of the MastercamSystemException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the MastercamSystemException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the MastercamSystemException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the MastercamSystemException class.
If non-null, the information.
The context.
This is the base Mastercam solids geometry exception class.
Initializes a new instance of the OperationException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the OperationException class.
If non-null, the message.
Initializes a new instance of the OperationException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the OperationException class.
If non-null, the information.
The context.
This is the base Mastercam solids geometry exception class.
Initializes a new instance of the MathException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the MathException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes the exception instance with a default error message.
Initializes a new instance of the MathException class.
If non-null, the information.
The context.
This is the base Mastercam Math exception class.
Initializes a new instance of the MastercamIOException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the MastercamIOException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the MastercamIOException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the MastercamIOException class.
If non-null, the information.
The context.
This is the base Mastercam I/O exception class.
Initializes a new instance of the SolidException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the SolidException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the SolidException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the SolidException class.
If non-null, the information.
The context.
This is the base Mastercam solids geometry exception class.
Initializes a new instance of the GroupException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the GroupException class.
. Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the GroupException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the GroupException class.
If non-null, the information.
The context.
This is the base Mastercam groups exception class.
Initializes a new instance of the NestingException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the NestingException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the NestingException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the NestingException class.
If non-null, the information.
The context.
This is the base Mastercam nesting exception class.
Initializes a new instance of the GeometryException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the GeometryException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the GeometryException class.
Initializes a new instance of the GeometryException class.
If non-null, the information.
The context.
This is the base Mastercam geometry exception class.
Initializes a new instance of the TypeCasterException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the TypeCasterException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the TypeCasterException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the TypeCasterException class.
If non-null, the information.
The context.
This is the base Mastercam type casting exception class.
This exception is generally thrown if the NET-Hook encounters a Mastercam database type that
it doesn't understand and it can't cast to a NET-Hook type.
Initializes a new instance of the DatabaseException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the DatabaseException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the DatabaseException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the DatabaseException class.
If non-null, the information.
The context.
This is the base Mastercam database exception class.
Gets or sets the name of the specified exception.
Initializes a new instance of the MastercamException class.
Initializes the exception instance with a specified error message and
the inner exception that caused it.
If non-null, the message.
If non-null, the inner exception.
Initializes a new instance of the MastercamException class.
Initializes the exception instance with a specified error message.
If non-null, the message.
Initializes a new instance of the MastercamException class.
Initializes the exception instance with a default error message.
Initializes a new instance of the MastercamException class.
If non-null, the information.
The context.
This is the base Mastercam exception class.
Gets a string from the managed resources.
The name of the resource to retrieve.
The string.
Gets or sets the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
Gets the cached ResourceManager instance used by this application.
The application strings class.
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.
Executes the update old from new operation.
The input.
The output.
Executes the update new from old operation.
The input.
The output.
Executes the update old from new operation.
The input.
The output.
Executes the update new from old operation.
The input.
The output.
Information describing the original.
Executes the update new from old operation.
The input.
The output.
Information describing the original.
Executes the update old from new operation.
The input.
The output.
Executes the update new from old operation.
The input.
The output.
Executes the update old from new operation.
The input.
The output.
Executes the update new from old operation.
The input.
The output.
Executes the update new from old operation.
The input.
The output.
Information describing the original.
Executes the update old from new operation.
The input.
The output.
Executes the update new from old operation.
The input.
The output.
Executes the update old from new operation.
The input.
The output.
Executes the update new from old operation.
The input.
The output.
Executes the update old from new operation.
The input.
The output.
Executes the update new from old operation.
The input.
The output.
Updates the old holemaking operation parameters from new.
The input.
The output.
Updates the new holemaking operation parameters from old.
The input.
The output.
Updates the old milling operation parameters from new.
The input.
The output.
Updates the new milling operation parameters from old.
The input.
The output.
Updates the old operation parameters from new.
The input.
The output.
Updates the new operation parameters from old.
The input.
The output.
Executes the update old from new operation.
The input.
The output.
Executes the update new from old operation.
The input.
The output.
Executes the update old from new operation.
The input.
The output.
Executes the update new from old operation.
The input.
The output.
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.
Static class providing functionality to create legacy tp_tools from tl class tools and update tl class data from
legacy tool data.
Initializes importer types for the tool profile importer system.
Gets a pointer to the internal tool system.
The internal tool system.
Finalizes the tool system.
Initializes the tool system services.
Defines an alias representing zero-based index of the internal tool system pointer.
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 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 lathe tool to the provided operation.
The 3D 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.
Edits the given tool within the tool designer .
The 3d tool assembly to edit.
True to update part.
True to from operation dialog.
True to hide the parent window (if not null) before launching the tool designer.
(Optional) If non-null, (Optional) the parent.
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.
true if it succeeds, false if it fails.
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.
(Optional) 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.
(Optional) If non-null, the parent.
true if it succeeds, false if it fails.
Launches the holder designer to allow users to edit the given holder. The result of the holder designer, if
successful, will be placed in the input parameter "holderToEdit".
The holder 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. 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 holders 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. 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 edit live center wizard to allow users to create their desired live centers. The result of
the edit live center 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 live center wizard to allow users to create their desired live centers. The
result of the create new live center 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 edit lathe tool dialog to edit the assembly provided at the input parameter "spResult". If the lathe
tool is successfully edited, and the input parameter "updatePart" is set to true, the lathe tool will be updated
in the Mastercam part tool list. This function can be used as a means to just commit changes to a tool and update
operations that use it. This is currently only used after "Setup Tool" has been called from outside the tool
definition dialog.
The result.
the original tool from before modifications were made. Sending a value in with
this parameter will commit the changes and update operations, but not provide an
interface to edit the tool.
true to update part, false to just edit the tool.
true if called from the operation dialog.
Identifier for the machine group.
(Optional) If non-null, the machine.
(Optional) If non-null, 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 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 if slot is mill.
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 if slot is mill.
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.
true if it succeeds, false if it fails.
Updates the tool assembly referenced by the slot information stored within the input LATHETOOL.
The input.
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.
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.
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.
true if it succeeds, false if it fails.
Retrieves a set of all 3D tool assembly IDs from the current Mastercam part list.
The 3D tool assembly IDs.
Retrieves a set of all lathe tool assembly IDs from the current Mastercam part list.
The lathe tool 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.
Constructs a list of all items of type TlConfiguredToolAssembly 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 TlConfiguredToolAssembly.
Searches for matching 3d tools in the tool manager. The predicate parameter will be executed on all 3d 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 3d 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 matching lathe tools in the tool manager. The predicate parameter will be executed on all 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 the first item for which predicate 'pred' returns true. If an item is found, it will be assigned to
the parameter 'spResult'.
The result.
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. If an item is found, it will be assigned to
the parameter 'spResult'.
The result.
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. If an item is found, it will be assigned to
the parameter 'spResult'.
The result.
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.
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 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.
Identifier for the machine group.
true to ignore tool number when checking to see if the tool exists.
The result tool.
true if it succeeds, false if it fails.
Attempts to locate a similar lathe tool assembly to the input parameter "similarTool". This version of
'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in
storage.
The similar tool.
Identifier for the machine group.
true to ignore tool number.
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.
True if the slot is a mill tool list slot.
The result.
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 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.
Identifier for the machine group.
true to ignore tool number when checking to see if the tool exists.
The result tool.
true if it succeeds, false if it fails.
Attempts to locate a similar lathe tool assembly to the input parameter "similarTool". This version of
'Find' returns (by reference parameter) a shared pointer to a const version of the actual item in
storage.
The similar tool.
Identifier for the machine group.
true to ignore tool number.
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 provided item to the current part's main tool list. Configured tool assemblies are not accessible via
slot number, and so no slot number will be assigned to the input parameter.
The item to add to the current part's main tool list.
True if it succeeds, false if it fails.
Adds the given 3D tool to the machine group at the given ID.
The tool to add.
The slot. Input value greater than 0 - slot requested, input value
equal to 0
- next open slot. Parameter is assigned the slot assigned to the tool.
The machine group idn used to search for duplicates or NULL_ID to
ignore groups.
(Optional) true to add to the TlMgr list only. BE WARNED - Only send
true in with this parameter if it is fully understood that this will NOT
add the tool to the Mastercam database.
(Optional) true to suppress tool number warning.
true if it succeeds, false if it fails.
Adds the given lathe tool to the machine group at the given ID.
The tool to add.
The slot. Input value greater than 0 - slot requested, input value
equal to 0
- next open slot. Parameter is assigned the slot assigned to the tool.
The machine group idn used to search for duplicates or NULL_ID to
ignore groups.
(Optional) true to add to the TlMgr list only. BE WARNED - Only send
true in with this parameter if it is fully understood that this will NOT
add the tool to the Mastercam database.
(Optional) 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 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 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 TlAssemblyConfiguration type and its shared_ptr/unique_ptr aliases.
Declares the TlAssemblyComponentTree type and its shared_ptr/unique_ptr aliases.
Declares the TlAssemblyComponent type and its shared_ptr/unique_ptr aliases.
Declares the TlConfiguredToolAssembly type and its shared_ptr/unique_ptr aliases.
Declares the TlConfiguredToolAssembly type and its shared_ptr/unique_ptr aliases.
Declares the TlToolAssembly type and its shared_ptr/unique_ptr aliases.
Gets tl manager.
The tl manager.
Gets a pointer to the tool data importer manager.
The tool data importer manager.
Gets a pointer to the assembly factory.
The tool assembly factory.
Gets a pointer to the assembly item factory.
The tool assembly item factory.
Gets a pointer to the global tool system.
The tool system.
Defines an alias representing zero-based index of the tool data importer manager pointer.
Import tool data using the importer at the specified identifier. All user interfaces will be suppressed
and the provided path will be given to the importer to allow for silent execution.
Identifier of the importer to use for this operation.
Manager that result data should be injected into.
Full pathname of the file to import from.
Full pathname of the file to log results to.
true if it succeeds, false if it fails.
Import tool data. Any user interface will be provided by the importer at the specified index should it
supply one. If it does not supply a user interface, a Mastercam interface will be used instead.
Identifier of the importer to use for this operation.
Manager that result data should be injected into.
(Optional) handle of the parent.
true if it succeeds, false if it fails.
Retrieves names of the current set of available importers.
The names and identifiers of the available importers.
Gets a count of the importers stored within this importer manager.
The importer count.
Removes the importer described by the indentifier from the current set of available importers.
The identifier.
Adds an importer identified by 'importerId' to the list of importers.
Identifier for the importer.
The importer.
true if the importer was added, false if it was not.
Adds an importer to the list of importers.
The importer.
The index of the newly added importer to be used for future access.
Manager for tool data importers.
Defines an alias representing a constant zero-based index of the tool data importer pointer.
Imports tool data into the provided TlMgr.
The storage container to put all imported data.
The logger service to log any result messages.
(Optional) Full pathname of the file.
(Optional) false to warn the user on warnings/errors during the import process.
(Optional) If non-null, the parent window.
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.
Retrieves the localized name of this tool data importer.
The name.
The IToolDataImporter interface.
Defines an alias representing zero-based index of the tool data import logger pointer.
Gets the messages.
The messages.
Saves the log to disk.
I/O Full pathname of the file.
True if the log was successfully saved to disk.
Logs a message.
The Resource Identifier of the message to log.
Handle of the resource.
(Optional) type of the message.
Logs a message.
The message.
(Optional) type of the message.
Clears all messages.
A tool data import logger.
Values that represent the type of message.
Creates a new new instance of the ITlAssemblyItemFactory interface.
The new ITlAssemblyItemFactory instance.
Defines an alias representing zero-based index of the tl assembly item factory pointer.
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.
Destructor.
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.
Defines an alias representing zero-based index of the tl assembly factory pointer.
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.
Destructor.
Factory service class providing functionality for creating instances of class TlAssembly.
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 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".
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.
(Optional) If non-null, the parent.
true if it succeeds, false if it fails.
Launches the edit assembly dialog to edit 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" from that dialog, the newly created assembly will be in parameter "spResult".
The result.
true to update part.
(Optional) If non-null, the parent.
true if it succeeds, false if it fails.
Launches the edit lathe tool dialog to edit the assembly provided at the input parameter "spResult". If
the lathe tool is successfully edited, and the input parameter "updatePart" is set to true, the lathe
tool will be updated in the Mastercam part tool list.
The result.
true to update part.
(Optional) If non-null, the parent.
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".
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.
(Optional) If non-null, the parent.
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 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.
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 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.
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.
true if it succeeds, false if it fails.
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 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.
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.
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.
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.
Make a workspace key for viewsheets.
The name of the workspace key.
Gets number of viewsheets.
The number viewsheets.
Gets a set of all currently used viewsheet names.
Set of all currently used viewsheet names.
Saves a current viewsheet values.
The viewsheet data to save.
(Optional) true if check for changed, false does not flag a database change.
Updates the graphics by levels.
The old levels.
The new levels.
Verify the list of Levels match.
The first level list.
The second level list.
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.
Restore active viewsheet for TempDB.
The sheet to make active.
Saves the active viewsheet for TempDB.
An the active viewsheet.
Calculate the window's tab height.
The tab height.
Is The View Sheet in renaming Mode.
True if renaming.
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 new tab to activate.
TRUE if it succeeds, FALSE if it fails.
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 newly activated tab.
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 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 index of the viewsheet to query.
True if the specified sheet has a bookmark saved for it, and false if it doesn't.
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 index of the viewsheet to restore a bookmark on.
(Optional) true to force view update.
Deletes the bookmark for the specified viewsheet.
The index of the viewsheet to delete a bookmark on.
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 index of the viewsheet to save 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.
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 index of the viewsheet to delete.
(Optional) True if deleting a temporary sheet.
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 index of the sheet to update.
(Optional) True to force view update.
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).
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.
Initializes the viewsheet control and internal array.
This is to be used when a new file is created or on startup, for example.
Calculates the tab's inplace rename rectangle.
The rectangle edit on the viewsheet tab.
Enables the in place edit for the viewsheet name.
true to enable, false to disable.
Gets a viewsheet.
The viewsheet name.
null if it fails, else the viewsheet of the name passed in.
Gets a viewsheet.
The viewsheet number.
null if it fails, else the viewsheet of the number passed in.
Gets number of viewsheets.
The number viewsheets.
Gets number of viewsheets.
The number viewsheets.
Gets sheet name.
The sheet number.
The sheet name for the sheet number.
Executes the rename tab action.
Zero-based index of the tab to rename.
The new name.
true if it succeeds, false if it fails.
Rename sheet.
The index of the sheet to rename.
Name of the new viewsheet.
Rename sheet.
The index of the sheet to rename.
Copies the current and names viewsheet.
The sheet to copy.
The new name.
The new copied sheet with the name.
Creates copy of a viewsheet.
The index of the sheet to copy.
The new copied sheet.
Creates new viewsheet.
The name for the new sheet.
(Optional) true to save bookmark on the new sheet.
true if it succeeds, false if it fails.
Creates a new viewsheet with basic graphic info and multiple levels.
The name.
Identifier for the plane.
The matrix.
Number of levels.
Array of levels.
Creates a new viewsheet.
The name.
Identifier for the plane.
The matrix.
The level number.
Creates new viewsheet based on the settings found in a database viewsheet entity.
Pointer to a viewsheet database entity to create a new viewsheet entry from.
the tab index of the sheet just created.
Creates a new viewsheet based off of the currently selected one.
(Optional) True to start the rename process.
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 index of the selected sheet.
Shows the viewsheet settings dialog.
Enables or disables the use of multiple viewsheets.
True to enable multiple viewsheets, and false to disable.
Gets a value indicating whether the use of multiple viewsheets is enabled.
True if viewsheets are currently enabled.
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.
Fill in viewsheet data from an ent.
The viewsheet data to populate (Data or Bookmark).
The database ent 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.
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.
If non-null, the 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 on this worksheet entry.
If non-null, the database entity.
Sets visible level information.
Saves visible levels to the worksheet data.
The visible levels list.
true if the visible levels have changed, false if not.
Destructor.
Constructor.
If non-null, the database entity.
Copy constructor.
If non-null, source work sheet entry.
Default constructor.
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.
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.
Optional pointer to edge tags to color map.
@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()
@par Purpose: Find the Parasolid Kernel Edge tags associated with a face, given the face tag
@return number of edges on face
@param[in] face Parasolid face tag
@param[in,out] edges pointer to memory to hold edge tags. This function will allocate that
memory. Use ps_solid_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 edges will be returned.
@par Purpose: Find the Parasolid Kernel Face tags associated with a solid body, given the body tag
@return number of faces on solid body
@param[in] body Parasolid body tag
@param[in,out] faces pointer to memory to hold face tags. This function will allocate that
memory. Use ps_solid_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 faces will be returned.
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
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.
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.
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.
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
Solid Hole styles
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
Enables or disables the Post debugger button.
new value for the setting
previous value of the setting
True if the Post debugger button is enabled, otherwise false.
current value of the setting
Sets config variable OnlyMainVisible.
new value for the setting
previous value of the setting
True if only the main level should be visible, otherwise false.
current value of the setting
@}
@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
MALLOC Definition
CALLOC Definition
REALLOC Definition
FREE Definition
@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
@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.
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.
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
@par Purpose: See if solid import are allowed
@return true = solid import functions are allowed (not DRAFT and not ENTRY)
@par Purpose: See if solid operations are allowed by the current SIM
@return true = solid functions are allowed
@param[in] warn_user true = Display a warning message if solids functions are not allowed
@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
@defgroup viewport_configurations Viewport Configurations
* @{
@}
@defgroup line_styles Line Styles
* @{
@}
@defgroup point_styles Point Styles
*@{
@}
@defgroup entry_codes Point Entry Code Characters
* @{
@}
@defgroup eevec Entry/Exit Vector Defines
* @{
@defgroup eevec_types Entry/Exit Vector Types
* @{
@}
@defgroup eevec_format Entry/Exit Vector Formats
* @{
@}
@}
@defgroup langauge language
*@{
@}
@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
@}
@}
@}
@defgroup propsht_9 Mastercam Help Methods
@{
*
* @par Purpose:
* This method launches a help dialog for the specified property sheet
*
* @param[in] CtrlId the resource id of the page making the call to the help dialogs
*
@defgroup propsht_7 Mastercam Help
@{
@defgroup propsht_8 Mastercam Help Variables
@{
@par Purpose:
This method initializes the automatic tool tips
@par Purpose:
Standard destructor
@par Purpose:
Standard string pointer constructor
@param[in] pszCaption the pointer of the string to use as the window caption
@param[in] pParent the CWnd pointer to the parent dialog that this dialog was called from
@param[in] iSelectPage specifies the initial page to be selected (default = 0)
@par Purpose:
Standard resource string constructor
@param[in] nIDCaption the resource id of the string to use as the window caption
@param[in] pParent the CWnd pointer to the parent dialog that this dialog was called from
@param[in] iSelectPage specifies the initial page to be selected (default = 0)
Destructor.
Constructor.
(Optional) pointer to Operation Manager, nullptr for global.
disable upon instantiation, enable upon destruction.
Query if 'ctrlId' is a default button.
Identifier for the control.
The control's tool tip.
True if default button, false if not.
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
Query if 'ctrlId' is a default button.
Identifier for the control.
The control's tool tip.
True if default button, false if not.
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.
Query if 'ctrlId' is a default button.
Identifier for the control.
The control's tool tip.
True if default button, false if not.
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 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.
@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
@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
@par Purpose:
return true if active turret is a top turret
@param[in] active_turret active turret to test
@par Purpose:
get associative ents only from db
@param[out] d_ptr database pointer
@param[out] e_ptr entity pointer
@param[out] e entity
@param[in] id NULL_ID, TP_ID, OP_ID, TL_ID or M_ID
@param[out] succf true = successful
@par Purpose:
* for v7.0 development only!
@par Purpose:
returns true if successful, false if duplicate entity #'s are found
@param[in] fname filepath for the dump file
@par Purpose:
* write ent id #, type and eptr to a file
@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
* @par Purpose:
* get an operation entity and all related toolpath entities
Note: the calling function must free the allocated list
* @param[in] op_idn operation number to get
* @param[out] op_ent operation entity
* @param[out] tp_ents ptr to alloced list of toolpath ents
* @param[out] n_tp_ents number of toolpath entities found
* @param[out] succf true = successful
* @param[in] update_op_ent_count true if toolpath entity count is mismatched, fix the op to match what was found
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.
@par Purpose:
Sets the LevelSet "name" of the specified level#
Does NOT affect or alter any Level "name"!
Note: If the level# does not exist, it will be created.
@param[in] levelSetName - the new LevelSet name
@return false if the name was truncated to fit
@par Purpose:
Sets the Level "name" of the specified level#
Does NOT affect or alter any LevelSet "name"!
Note: If the level# does not exist, it will be created.
@param[in] levelSetName - the new LevelSet name
@return false if the name was truncated to fit
@par Purpose:
Retrieve just the LevelSet "name" of a level
@param[in] levelNumber - the Level number
@return the LevelSet "name"
@par Purpose:
Retrieve just the Level "name" of a level (without any LevelSet name)
@param[in] levelNumber - the Level number
@return the Level "name"
@par Purpose:
Gets the number of the level with the specified name
Since there is no restriction on Level "names" and LevelSet "names"
being unique, there can be multiple matches!
@param[in] levelName - the Level "name" of the level to find (Can be "blank")
@param[in] levelName - the LevelSet "name" of the level to find (Can be "blank")
*If both are "blank" the return will be false!
@param[out] levelNumbers - the (std::vector) list of matching level#'s
@return True/False - Were there any matches?
@par Purpose:
Gets the number of the level with the specified name
Since there is no restriction on Level "names" and LevelSet "names"
being unique, there can be multiple matches!
"Old School" interaction using int*
If you need the list of matching Level#'s you'll need to call this function TWICE.
1st time with 'levelNumbers = NULL' to get the # of levels.
2nd time with 'levelNumbers' properly allocated to retrieve the list of Level#'s
*See the GetLevelNumbersByName overload that uses a std::vecotor for "New School". ;)
@param[in] levelName - the Level "name" of the level to find (Can be "blank")
@param[in] levelName - the LevelSet "name" of the level to find (Can be "blank")
*If both are "blank" the return will be false!
@param[out] nLevels - the # of matches found
@param[out] levelNumbers - the list of matching level#'s
*If the supplied levelNumbers is null,
we just load nLevels with the # of matches.
@return True/False - Where there any matches?
@par Purpose:
Gets the number of the level with the specified name
@param[in] levelName the name of the level
@return The number of the level. -1 if the specified name is not found
@par Purpose:
Finds out how many levels are currently active
@param[in] n_active the number of active levels
@param[in] active_list if a valid int[] is passed in, it will be loaded with the active level values
@par Purpose:
Finds out how many levels are currently visible
@param[in] n_visible the number of visible levels
@param[in] vis_list if a valid int[] is passed in, it will be loaded with the visible level values
@par Purpose:
Sets a given level's visibility
@param[in] level the level to set visibility for
@param[in] visible true to make the level visible; false to make in invisible
@}
@}
A macro that defines maximum level number allowed.
@par Purpose:
Determines whether a given level is currently visible
@return true if a the given level is visible; false if not
@param[in] level the level to check visibility against
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_grp3 Graphics Buffering Settings
@{
@}
@defgroup gr_grp1 Color Defines and Variables
@{
@defgroup gr_grp2 Color Defines
@{
@}
@defgroup gr_grp0 Graphics Variables
@{
@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.
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:
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:
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
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:
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:
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.
@par Purpose:
Sets as active (including rendering contex) the next graphics view, returning its
pointer. If NULL is passed, the first view is activated. If a view pointer is
passed, the next view is activated. If the view pointer is invalid, the active
view is not changed and NULL is returned.
@param[in] pView Iterative view pointer.
@par Purpose:
Returns the pointer to the next graphics view.
@param[in] view Iterative view pointer.
@par Purpose:
Sets the pointer to the current (active) graphics view and sets its rendering context.
@param[in] pView View pointer.
@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:
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
@}
@defgroup mask_types Message mask types
* @{
@}
@par Purpose:
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.
@return type of message being passed back
@param[in] mode specifies the mask applied to the messages which get returned
@param[out] ms fills the user-created UINT with the message to be returned
@param[out] wp fills the user-created WPARAM with the wparam of the message being returned
@param[out] lp fills the user-created LPARAM with the lparam of the message being returned
@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.
*
* @{
@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:
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?
@par Purpose:
Toggles OpenGL fulltime mode. If it's on, this method will turn it off and vice versa.
@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:
Remove lathe tool graphics from the display list.
@par Purpose:
Draws a tool in 5-axis orientation,
rotating about the normal vector axis
@param[in] t_ents array of tool entities to draw
@param[in] n_t_ents number of tool entities in the t_ents array
@param[in] spin_ang turn angle, in radians, for turning the tool
@param[in] draw_pt point to draw the tool center on
@param[in] off_pt point on a normal vector to determine tool orientation
@param[in] comp_to_tl_tip flag indicating whether to compensate for the tool tip or not
@param[in] corner_r tool corner radius
@param[in] animate flag indicating whether or not animation is on (true = draw in xor mode, false = replacement mode)
@param[in] save_it flag indicating whether to save the tool in the database or not
@par Purpose:
Draw a tool in tool plane axis orientation,
rotating about the tool plane axis - the tool only rotates
@param[in] t_ents array of tool entities to draw
@param[in] n_t_ents number of tool entities in the t_ents array
@param[in] spin_ang angle of rotation around the tool plane axis, in radians
@param[in] draw_pt point to draw the tool tip on
@param[in] view_n tool plane view number
@param[in] comp_to_tl_tip flag indicating whether to compensate for the tool tip or not
@param[in] corner_r tool corner radius
@param[in] animate flag indicating whether or not animation is on (true = draw in xor mode, false = replacement mode)
@param[in] save_it flag indicating whether to save the tool in the database or not
Chokepoint for gr_back_color.
A 3D point structure.
Character string of text to be drawn.
Chokepoint for gr_back_color.
The point at which to draw the text.
The text to be drawn.
@par Purpose:
Draws the specified characters to the screen.
@param[in] pt the point at which to draw the text
@param[in] textout the text to be drawn
@param[in] color the color the text is to be drawn in
@par Purpose:
Draws the specified characters to the screen.
@param[in] pt the point at which to draw the text
@param[in] textout the text to be drawn
@param[in] color the color the text is to be drawn in
@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
@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 OpenGL shading.
@param[in] initXform Optional flag to prevent the transform from being set.
Indicate if the plane specified in config has been set yet.
true to indicate the plane has been set, otherwise false.
Deletes an opengl display list.
Resets depth buffer writes to the default.
Restricts depth buffer writes such that objects drawn at the same depth appear "on top" of those already drawn.
Restricts depth buffer writes such that objects drawn at the same depth appear "behind" of those already drawn.
Sets the scale to be applied to the depth offsets.
The scale to be applied.
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.
@par Purpose:
This method sets the OpenGL light properties.
@par Purpose:
This method sets the entity position to the start of the display
list or database.
@param[in] sel_mask .sel mask (to define matching entities for get_dl_db_ent).
@param[in] ent_mask entity mask (to definematcing entities for get_dl_db_ent).
@param[out] pos position in the list
@param[in] force_db force function to use database, not display list.
@par Purpose:
This method gets the next entity from the display list or database
and updates the position marker.
@return true, if more, else false when done with display list.
@param[in] pos ptr to postion of current entity in display list or database
@param[out] e entity read from display list or database
@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 draws an entity in a "forced" color.
@param[in] entity the entity
@param[in] color the "forced" color.
@param[in] highlight optional flag to indicate highlight draw.
@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 nterations times.
@par Purpose:
This method sets the OpenGL wire frame.
@param[in] initXform Optional flag to prevent the transform from being set.
@par Purpose:
This method erases any and all drawn arrows.
@par Purpose:
This method displays an arrow in the arrow auto-color.
@param[in] arrow_base base point of arrow to be drawn
@param[in] arrow_dir directional point of arrow
@param[in] reverse specifies whether or not you want the direction of the arrow to be reversed from what was already specified
@param[in] ht_ratio ratio of the desired arrow length to the height of the view (arrow length = screen height * ht_ratio * projection)
@param[in] letter letter to be displayed near the arrowhead (' ' for none)
@par Purpose:
This method displays an arrow with a given color.
@param[in] arrow_base base point of arrow to be drawn
@param[in] arrow_dir directional point of arrow
@param[in] ht_ratio ratio of the desired arrow length to the height of the view (arrow length = screen height * ht_ratio * projection)
@param[in] color color of arrow to be drawn
@param[in] letter letter to be displayed near the arrowhead (' ' for none)
@par Purpose:
This method sets the flag controlling whether or not multiple arrows can be displayed at once
@param[in] on true: allow drawing of multiple arrows; false: allow drawing of only one arrow at a time
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
@par Purpose:
Marks an entity as unselected.
@param[in] eptr the eptr of the entity to mark as unselected
@par Purpose:
Marks an entity as unselected.
@param[in] eptr the eptr of the entity to mark as unselected
@par Purpose:
Repaints and cleans a given point.
@param[in] ch -- unused --
@param[in] pnt point to be cleaned
Chokepoint for gr_back_color.
Pointer to ent structure.
True for highlight.
True for in batch draw.
@par Purpose:
This method draws any entity in the database.
@param[in] entity pointer to the entity structure
@param[in] color drawing color
@param[in] highlight flag to indicate highlight draw.
@param[in] inBatchDraw true to prevent immediate flushing of OpenGL data.
Chokepoint for gr_back_color.
Pointer to ent structure.
(Optional) true to highlight.
@par Purpose:
This method draws any entity in the database.
@param[in] entity pointer to the entity structure
@param[in] color drawing color
@param[in] highlight optional flag to indicate highlight draw.
@par Purpose:
This method draws any entity in the selection color.
@param[in] entity the entity to draw
@par Purpose:
This method clears the graphics screen.
@par Purpose:
This method forces a repaint of the active graphics view by rebuilding the geometry entities
@par Purpose:
This method forces a repaint of all graphics views
@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
@par Purpose:
This method forces a flush of the GL pipeline
@par Purpose:
This method projects a 3d line onto x_iso and y_iso_axis and draws it
@param[in] line the 3d coordinates of the line.
@param[in] color the drawing color
@par Purpose:
This method draws an arc for an isometric view.
@param[in] arc pointer to the 3D arc
@param[in] color color to use when drawing the arc
@param[in] style style to use when drawing the arc
@par Purpose:
This method deletes the OpenGL text font display lists that are used to draw
text on the graphics screen. Use this if GL Lists get messed up
@par Purpose:
This method removes an OpenGL display list.
@param[in] idn id number of the list to remove
@par Purpose:
This method removes and frees the previous group of OpenGL display lists.
including the OpenGL text font display lists
@par Purpose:
This method flushes lines that have been buffered
Enqueue a future view setup.
Calls "update_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, 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
@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 method restores the cursor to what it was before the most recent
call to set_new_cursor
@par Purpose:
This method converts the cursor to an hourglass to let the user know
that processing is (however slowly) actually being done and that the
computer isn't locked up.
@par Purpose:
This method draws a 3d point with an isometric view given its data record
@param[in] pt a 3d point
@param[in] color the pt color
@par Purpose:
This method makes a global surface box that contains all the
surfaces. All light sources and the camera positions are located
relative to the box. The box is also used for calculating
the near and far z clipping plane.
@return true if creation was successful; false if not
@par Purpose:
This function initializes GL lighting
Edit the given group properties.
@param[in] not_used Not used
@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 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
Pointer to the Planes follow rules (Cplane follows WCS, etc).
The one and only all powerful Planes global.
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.
Return true if running mcam DLL.
Return true if running mcam DLL.
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.
PlanesFollowRules enforces the 'Cplane follows Gview' type rules.
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.
Class to select geometry for Plane construction and unselect geometry on destruction.
Defines an alias representing the plane by geometry pointer.
display the 8 options, select one and update the given plane's matrix and transform info.
the Plane to update.
true to add transform info to thePlane.m_Transform, false = don't.
The pre-selected matrix choice (0-7) other wise matrix chooser dialog will be presented.
Dialog's parent window.
return 0-7 for valid selection, -1 on cancel.
Call the rotate dynamic function.
the rotate dynamic data.
return true if successful.
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 Plane.
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.
return true if successful.
Select geometry to define a Plane.
the defined Plane if successful.
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.
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 Planes.
P3D in world coordinates used as the origin of the default 8 Planes.
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
restore all active system planes.
standard destructor - restore all active system planes.
Constructor - save current and restore all active system planes.
reference to Planes object.
SWActivePlaneSaveRestoreAll class used when temporarily changing all 4 system views and will restore it
on its destruction or when you call SWActivePlaneSaveRestoreAll.Restore ()
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.
Check plane, return true if running Solid Works if we should skip.
The plane to check.
True if we should ignore in search.
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.
Builds the quick find system matrix map m_QuickFindSystemMatrixMap.
(Optional) True to display warning.
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.
Display message that CGraphicsView.cpp::m_Gplane != the Gplane info in this.
The warning.
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.
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.
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.
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.
Disables the update of the plane manager when this goes out of scope.
Disables the restoration of the saved active planes.
Restores the active planes by type.
(Optional) Pointer to active plane types, null for all contained 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.
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.
Gets planes manager bar pointer.
Null if it fails, else the planes manager bar pointer.
Sets the internal planes manager bar pointer m_pPlanesMgrBar.
If non-null, the planes manager bar.
previous value of m_pPlanesMgrBar.
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.
Removes the matrix noise in m33.
[in,out] The plane containing the matrix to clean.
true if it changed, false if not.
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.
Return true if plane added.
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 as an INT_PTR.
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.
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.
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.
Collect all the planes in this and sort by m_CoordinateDisplay.
The coordinate display (MILL_COORD_X, LATHE_COORD_X, LATHE_COORD_D).
# of planes found and copied into planesArray.
Collect all the planes in this and sort by name.
true = sort ascending, false = descending.
# of planes found and copied into planesArray.
Collect all the planes in this that match the given IDs in planeIDs.
Array of plane ID's to match.
True to include, false to exclude the temporary planes.
# of planes found and copyied into planesArray.
Collect pointers to all the planes in this.
The plane class.
True to include, false to exclude the temporary planes.
# of planes found and copyied into planesArray.
Collect pointers to all the planes in this.
True to include, false to exclude the temporary planes.
vector of const Plane pointers.
Collect and return copies of all the named planes in this.
True to include temporary planes, false to exclude.
# 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.
Check and fix invalid matrix in this.
the plane to check.
true = set matrix to TOP if found invalid.
(Optional) true = debug warning.
return true if valid.
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.
Validate all 3 op_view's in all operations, create new Planes and assign as needed.
Plane ID or matrix/origin pair has priority.
[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)
return # 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.
[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)
return # of operations updated.
Validate an op_view, create new Plane and assign to op_view if needed.
Plane ID or matrix/origin pair has priority.
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.
(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 op_view.
Validate planes stored in groups, create new Planes and assign as needed.
Plane ID or matrix/origin pair has priority.
return # of groups updated.
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)
return Plane assigned to grpView.
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.
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's to recalculate.
return true if Plane recalculated successfully.
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.
Makes plane name for list control (may include parent plane name).
The plane to build a list control name for.
A CString of what to display in the list control.
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.
Identifier for the plane.
Previous value.
Makes one plane dependent on another.
Identifier for the parent plane.
Identifier for the dependent plane.
True if it succeeds, false if it fails.
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 use the given ID as a parent.
A valid plane ID.
vector of dependent plane IDs.
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.
Validate/regenerate all the Planes.
regeneration mode (REGEN_NATURAL, etc)
regenenerate just the dirty Planes.
(Optional) pointer to parent window to display report dialog, nullptr if you don't want to display report.
Return # of Planes that were not successful in regenerating.
Validate/regenerate all the Planes with ID's that are found in planeIDs.
regeneration mode (REGEN_NATURAL, etc)
array of Plane ID's to regenerate, empty array to regenenerate all Planes.
(Optional) pointer to parent window to display report dialog, nullptr if you don't want to display report.
Return # of Planes that were not successful in regenerating.
validate all the given Plane and the ID's data.
the Plane's to check.
regeneration mode (REGEN_NATURAL, etc)
True to do also validate any depdendent planes.
Pointer to geometry entities eptr/ID map, nullptr will create one if regenerate is
set to true.
return list of plane ID's validated (the requested one an any dependents).
validate all the given Plane's data.
true = check for valid ID.
[in,out] the Plane's to check.
regeneration mode (REGEN_NATURAL, etc)
True to do also validate any depdendent planes.
Pointer to geometry entities eptr/ID map, nullptr will create one if regenerate is set to true.
return list of plane ID's validated (the requested one an any dependents).
get the descriptions of all the active Planes.
Display accuracy for origin coordinates.
CString to populate with truncated plane descriptions.
return Plane descriptions.
get the descriptions of all the active Planes.
(Optional) display accuracy for origin coordinates.
return Plane descriptions.
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.
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)
matrix_33 to fill in.
(Optional) return in world coordinates relative to the active WCS.
return true if successful.
Get copy of the 3x3 matrix used in active plane.
the active origin you want (CPLANE, TPLANE, GPLANE, WCSPLANE)
return in world coordinates relative to the active WCS.
return copy of the 3x3 matrix used in active plane.
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.
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)
Check the active plane assignments. Create planes if necessary.
# of planes added.
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.
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)
the active view number per system plane type.
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.
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.
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.
return # of system planes set.
check if a plane is active.
the ID of the plane to check.
array to set plane types is active.
return # of planes plane is active in.
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.
return true if 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.
Init the global NciCache when the global Planes is initialized.
Gets ref to underlying cache of NCI.
reference to m_BnciCache.
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 ent.
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 Planes.
std::set of the named Plane IDs removed.
Builds m_MatrixMap.
Reference to a MastercamPlanes object.
True = just the used matrices, false = all matrices.
reference to m_Map.
Defines an alias representing the matrix 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).
Copy of reserved plane IDs from pSourceIDs that can be deleted.
(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.
(Optional) exclude this operation ID from processing.
(Optional) maximum # of ID's to collect, 0 to collect all IDs.
(Optional) current Mastercam file info.
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.
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.
Get plane usage masks.
ID of single Plane to report about.
(Optional) ignore this usage from results.
(Optional) snapshot of Mastercam file to limit to only 1 pass thru the db.
(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.
Full path of file name created if successfull, empty string if failure.
Extracts the operation or group IDs from the usage set.
Identifier for the plane.
Set of the PlaneUsageInfo.
Set of opereration or group IDs.
Defines an alias representing a std::set of PlaneUsageInfo types.
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.
Defines an alias representing the plane usage map.
Values that represent PLANE_USAGE_MESSAGE_BOX parameter in PlaneUsage ().
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.
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.
Regerate and return a Plane defined with associated geometry by its name.
Name of plane to regenerate and return.
(Optional) true - regenerate even if clean.
copy of regenerated Plane.
Regerate 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.
Regerate a Plane defined with associated geometry.
name of plane to regenerate.
(Optional) true - regenerate even if clean.
return true if successful and Plane is valid.
Regerate a Plane defined with associated geometry.
ID of plane to regenerate.
(Optional) true - regenerate even if clean.
return true if successful and Plane is valid.
Regerate a Plane defined with associated geometry.
the plane to regenerate.
true - update object.
(Optional) true - regenerate even if clean.
return true if successful and Plane is valid.
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.
Write this to given disk file as pre-X7 view_ent's.
pointer to open Mastercam file.
Return error code (0 = success)
Write this to given disk file.
pointer to open Mastercam file.
Return error code (0 = success)
collect all the Planes from an external Mastercam file.
The Mastercam file name.
return vector of Planes collected.
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.
Build an array of toolpath operations from the current file.
std::vector of operations.
Build an array of toolpath operations from an external Mastercam file.
set of plane IDs to exclude.
source Mastercam file name.
std::vector of operations.
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 the plane IDs in this.
(Optional) True to include temporary plane's IDs, false to exclude.
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.
set ID of last added Plane.
Identifier for the plane.
ID of previous last added Plane.
get ID of last added Plane.
ID of last added Plane.
Get # of Planes of type PlaneClass.
The plane class.
# of Planes.
create a Plane relative to an existing Plane.
ID of Plane to copy/rotate.
relative type (RelativeType::Front, etc)
(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 Planes.
Return planes update code PlanesUpdated::Updated or PlanesUpdated::NotUpdated.
remove a single Plane by its ID.
the Plane IDs to remove.
true = update the ent.vw_refs in geometry entities in the db.
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.
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.
return constant ptr to a named Plane by its name.
a valid Plane name.
true = ignore case.
True to include temporary planes, false to exclude.
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 and origin.
3x3 matrix to match.
origin in world coordinates.
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.
Return iterator to the first instance of a class of Plane (NamedPlane or SystemMatrix).
The plane class (NamedPlane or SystemMatrix).
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.
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.
return pointer to system matrix, nullptr if error.
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.
return pointer to system matrix, nullptr if error.
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.
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.
Appends the planes from another MastercamPlanes object.
The object containing planes to append.
true = check for existing planes with the same matrix and origin before adding new ones.
(Optional) The type of planes to append (PlaneClass::SystemMatrix, NamedPlane or Undefined for all).
(Optional) true to mark any added planes as temporary.
(Optional) Map of original plane IDs vs added planes and the method they were added.
Number of planes added.
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 desctrictor.
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 value of m_State.
the value of m_State.
Return true if the db is currently loading a file.
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.
Defines an alias representing the plane map pair.
Defines an alias representing the plane map.
Let our friends have their way with us.
Cache for certain NCI lines to speed up Mastercam.
Clears all of the operation bnci drawn flags.
Set true if operation's bnci has already been drawn in m_DrawnMap.
Identifier for the operation.
true if operation has been drawn in draw_bnci().
Previous value.
Returns a true if operation's bnci has already been drawn.
Identifier for the operation.
true if operation's bnci has already been drawn.
Dumps this object to a text file and displays in the default editor.
Compare cache contents to disk.
The operation ID's whose NCI does not match cache.
true to display warning.
Gets a pointer to the plane ID in a 1016 line.
The 1016 bnci line.
reference to the plane ID.
Fix a bad plane ID in a 1016 line.
The 1016 bnci line.
true to rewrite line to bnci file.
The old new plane i ds.
true if it succeeds, false if it fails.
Sets the gcode types in mask.
map of gcodes and true = must be included.
Clears the underlying maps.
Gets const reference to the set of operation IDs represented in the map of NCI lines.
The set of ID's to fill in.
const reference to m_OpIDsInCache.
Fills in gcodeMask with NCI_GCODE types as long types.
The array of gcodes to fill in.
Size of gcodeMask.
Gets const reference to the gcode mask.
const reference to m_GcodeMask.
Gets const reference to the underlying map.
const reference to m_Cache.
Add or replace the nci lines from the operation in m_BnciCache.
Identifier for the operation.
Number of nci lines updated in m_BnciCache for the operation.
Removes all nci lines from the cache belonging to the operation with the IDs within opIDs.
Identifiers for the operations.
Number of lines removed from m_CacheBnci.
Removes all nci lines from the cache belonging to the operation with the ID of opID.
Identifier for the operation.
Number of lines removed from m_CacheBnci.
Gets the gcodes from operation's cached NCI lines.
Identifier for the operation.
The gcodes.
Size of gcodes.
Return true if op's cache can be considered as containing all the NCI lines to be considered complete.
Identifier for the operation.
true if "complete", false if not.
Loads the nci cache from the current file for the given operation ID.
true = add just the ops that exist in the db whose nci is not yet cached, false = all ops.
Size of m_BnciCache.
Loads the nci cache from the current file for the given operation ID.
Identifier for the operation.
Number of NCI lines cached for the given operation.
Loads the nci cache from the current file.
true = add just the ops that exist in the db whose nci is not yet cached, false = all ops.
Size of m_BnciCache.
Copies nci lines into bnciRW from m_BnciCache that match gcodes.
The operation ID's to extract NCI from, 0 for all.
The gcode mask, empty for all.
NCI container.
(Optional) the maximum number of nci lines to collect, 0 = all.
Number of NCI lines added to bnciRW.
Builds array of const ptrs to 1016 lines in m_BnciCache whose plane ID's match the given plane ID.
Plane ID to match.
The array of const pointers to fill in.
Size of bnciPtrs.
Adds the nci line to m_BnciCache.
The nci line to cache.
true if added to cache, false if not.
returns the m_Enabled and m_Compare values as a pair.
The m_Enabled and m_Compare values as a pair.
Enables NCI caching.
true to enable.
true to set comparison option.
true to clear cache.
true to reload cache from bnci disk file.
(Optional) the gcode mask.
Values that represent toggling of m_Enabled and m_Compare values;
Destructor.
Constructor.
(Optional) true to enable, false to disable.
(Optional) true to compare with disk, false to ignore.
Defines an alias representing a map of operation ID's and a bool that keeps track of bnci that needs to
be redrawn.
Defines an alias representing a map of operation ID's and bnci lines.
Defines an alias representing a map of bnci file positions and bnci lines.
Mastercam Planes class.
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.v_idn 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.
collect an array of toolpath operations.
exclude operations with these ID's from collection.
valid Mastercam file name, 0 length for 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.
destructor.
Constructor.
(Optional) The MastercamPlanes reference.
Defines an alias representing the map type.
Defines an alias representing the pair to insert into the Map type.
work offset assignment modes in transform toolpath operation parameters.
Allow NCIToIOF to access a private function.
WorkOffsetUtil utility class to collect, calculate and assign work offset assignments from Planes,
operations and NCI.
You can never have too many friends.
Defines an alias representing array of work offset info nodes.
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.
Reads a file.
The bnci open file.
true if it succeeds, false if it fails.
Destructor.
Constructor.
[in,out] The bnci open file.
(Optional) If non-null, the operation IDs of the NCI to read.
(Optional) If non-null, the gcodes of the NCI to read.
Constructor.
Filename of the bnci file.
(Optional) If non-null, the operation IDs of the NCI to read.
(Optional) If non-null, the gcodes of the NCI to read.
Default constructor.
Read a entire binary NCI file into 2 maps, 1 by op ID and one by file position.
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.
Sort m_BnciLines by bnci file position.
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
Gets comment gcodes.
The comment gcodes.
Gets sub program gcodes.
The sub program gcodes.
Gets tool change gcodes.
The tool change gcodes.
Gets a Mastercam file name.
[in,out] Filename of the file.
true if it succeeds, false if it fails.
Builds a map of operation ID's and their sos and eos bnci lines found in the file.
The Mastercam file.
A pointer to a map.
Maps of sos/eos pairs.
Maps of info of start-of-section and end-of-section NCI lines for a file.
Check for invalid pairings of start-of-section and end-of-section NCI lines.
The bnci file.
True to display dialog the info dialog.
True if ok, false if error in pairings.
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.
(Optional) If non-null, set to feed rate field.
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.
Compare the array contents of comp to this.
The CBnciReadWrite class to compare this to.
-1 if this is less than comp, 1 if comp1 is greater than this, 0 if equal.
Empty contents of m_BnciLines array.
# of elements removed.
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.
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.
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.
@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)
@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
@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
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:
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
@defgroup PockBound_Error_Codes Pocket Boundary Error Code Types
@{
@}
@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
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.)
* @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
@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.
An int.
@par Purpose:
Wait for the user to select a series of entities.
@param[in] cs Prompt string to display while waiting for the event ("*" to not display the prompt window)
@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[out] succf Fills a provided bool with a true if the event was returned successfully; false if not
@param[in] preSel A preselection flag value, of the MC_PRESEL type
@param[out] eptrs A pointer to an array containing the eptrs of the selected entities (NULL if they won't need to be returned immediately)
@param[out] num_eptrs A pointer to the number of eptrs returned (NULL if the eptrs won't need to be returned immediately)
@param[in] bUseDL Flag that indicates use of display list or database when searching for selected ents.
@return The return code, of the MC_RETURN type, of the function
@}
@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 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
@}
@par Purpose:
Wait for and then get some sort of user input event.
@param[in] cs Prompt string to display while waiting for the event ("*" to not display the prompt window)
@param[out] event Event data passed back upon some sort of user input
@param[in] mode A combination of event mode bit flags for limiting input types (ie, EM_Select, EM_Point, etc.)
@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] smask A combination of selection bit flag types for limiting selection (ie, ALIVE_BIT, etc. 0 for default)
@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 get_event function
@defgroup pre_sel_grp1 Preselection Bit Flag Values
* @{
@par Purpose:
This will free and redraw any point if necessary
@param[in] pnt The point to clean
@par Purpose:
This will free and redraw any chains if necessary
@param[in] chains The chains 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
@par Purpose:
Gets fill drag results
@return fill drag results
@par Purpose:
Gets fill drag mask
@param[in] value Fill drag event mode (EM_Point/EM_Select/EM_SldBody/EM_SldFace/EM_SldEdge
@param[in] value Fill drag visibility mask (-1 = All Visible)
@param[in] value Fill drag entity mask (-1 = All Types)
@par Purpose:
Gets fill drag visibility mask
@return fill drag visibility mask
@par Purpose:
Gets fill drag entity mask
@return fill drag entity mask
@par Purpose:
Gets fill drag event mode
@return fill drag event mode
Get select entity not sketch point when control key is down.
True if selection overrides sketched point.
Sets select entity not sketch point when control key is down.
True to value.
@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
@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
@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
@par Purpose:
Sets up a double-click event
@param[in] cur_pos The initial cursor position
@par Purpose:
Sets up a drag event
@param[in] cur_pos The initial cursor position
@param[in] lbd The initial left-button-down state
@par Purpose:
Sets up a multiple-input event
@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
@par Purpose:
Sets up a vector event
@param[in] vertices The vertices of the polygon
@par Purpose:
Sets up a polygon event
@param[in] vertices The vertices of the polygon
@par Purpose:
Sets up a chain event
@param[in] chains The chains to set the event up for
@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
@par Purpose:
Sets up a solid event
@param[in] hit The initial parasolid hit structure
@param[in] cur_pos The initial cursor position
@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
@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
@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] tag Solid tag associated with the point (0 if none)
@par Purpose:
Sets up a point event
@param[in] ap An initial auto-cursor point
@param[in] cur_pos The initial cursor position
Sets the point members - does not set m_ap.
The world point.
@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
Solid Patern operation parameters
Solid Trim operation parameters
Solid Trim operation parameters for X6 - X7
Solid Trim operation parameters
Solid Draft Face operation parameters
Solid Sweep operation parameters (pre-v2018)
Solid Sweep operation parameters
Solid Shell operation parameters
Solid Thicken operation parameters
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
Solid Chamfer operation parameters
Solid Selection 'Hit' structure
Solid Revolve Parameters
Solid Extrude Parameters
Solid Thinwall Parameters - used in Solid Extrude, Revolve, etc.
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.
@}
@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
* @{
@}
Solid Fillet Parameters - used in Solid Fillet functionality
@}
@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
@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
@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
@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
@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
@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
@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
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.
Letters modes.
@defgroup draft_ch2 Arrow Defines
@{
@}
@defgroup draft_ch3 Drafting Types
@{
@defgroup draft_ch5 Linear Drafting Types
@{
@}
@defgroup draft_ch6 Circular Drafting Types
@{
@}
@defgroup draft_ch7 Ordinate Drafting Types
@{
@}
@}
Set drafting globals from a dimension.
The entity.
(Optional) True to set construction plane.
(Optional) Globals record containing construction plane origin in world coordinates.
Set drafting globals from a note.
The entity.
(Optional) True to set construction plane.
(Optional) Globals record containing construction plane origin in world coordinates.
Save drafting globals to this object.
Restore drafting globals from this object.
Save drafting globals to this object.
True to save plane.
Restore drafting globals from this object.
True to restore plane.
Set drafting globals from a dimension.
The entity.
Set drafting globals from a dimension.
The entity.
True to set construction plane.
Set drafting globals from a note.
The entity.
Set drafting globals from a note.
The entity.
True to set construction plane.
Save global text height to this object.
True for dimensions.
True for notes.
True for arrow items.
Gets attributes.
The color.
The level.
The line width.
Destructor.
Constructor.
(Optional) True to save/restore in constructor/destructor..
(Optional) True to save/restore plane information.
Save and restore draft globals.
Draft globals save/restore record.
@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 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:
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:
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:
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:
Starts a new Xform undo transaction. The transaction is completed by
calling UndoXformTransCommit() or UndoTransTerminate().
@return true if the Undo Transaction was started successfully.
@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
@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
@par Purpose:
Read an entity from disk (not from overflow section of database)
@param[in] f The file to read entity from
@param[out] entity The entity
@param[out] succf False if end of file reached
@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
@par Purpose
Adjust entity attributes to current global settings
@param[in,out] entity Attributes set to global attributes
@return true = entity changed
@par Purpose
* Initialize database
@par Purpose:
Write an entity to the disk
@param[in] f The file to write to
@param[in] entity The entity to write to the file
@param[out] error Returns an error code if there is one
@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.
@par Purpose:
Fetch entity using entity pointer
@return 0=>OK 1=>null ent *
@param[in] eptr entity pointer
@param[out] entity found entity
Get a visible, unmasked (not excluded by the level mask) entity according
to sel_mask and ent_mask, and optionally color, level or style. If
sel_method is 1, only sel_mask and ent_mask are used. If sel_methodis 2,
sel_mask, ent_mask and color are used. If sel_method is 3, sel_mask,
ent_mask and level are used. If sel_method is 4, sel_mask, ent_mask, and
style are used.
@param[in] s The selection mask
@param[in,out] ptr The current position in the database
@param[out] found_ptr The pointer to entity
@param[out] entity The entity
@param[in] sel_mask The selection mask
@param[out] succf true if entity found
Get the next visible unmasked entity from the database. If an entity is
found, found_ptr will point to the entity and ptr will point to
the next position in the database. If the end of the database is reached,
succf is returned as false.
@verbatim
The selection mask, sel_mask, is defined as any combination of the
following bits:
#define ALIVE_BIT 1 bit 0 - cleared when entity is deleted
...
The entity mask ent_mask is defined as any combination of the following
bits:
#define P_ID 1 Point (bit 0)
...
If entity->id is set to DB_ID, then entity->db_fn is defined as follows:
#define V_MATRIX_FN 0 View matrix
...
Surface types:
#define NB_SURF 0 NURBS surface
...
@endverbatim
@param[in,out] ptr Current position in the database
@param[in] sel_mask Mask for sel bits
@param[in] ent_mask Entity mask
@param[out] found_ptr Points to the next entity in the database
@param[out] entity Points to an entity with matching sel and id bits
(All the sel bits must match, but only one of the
id bits must match)
@param[out] succf True if entity found. False if end of database reached
@note ptr must be set to the beginning of database on the first call
@par Purpose:
Save the database to an opened file
@param[in] f opened file
@param[in] just_hdr just write the header info
@param[out] succf true = successful
@param[in] educ (optional) true = saving EMCX file, false = saving MCX file
@param[in] reset_db_changed (optional) true = allow db_changed to be reset. This should only be set to false when called from save_temp_db().
@par Purpose:
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
@param[in] f The file
@param[in] post_invis_ent_warn Post warning if file contains entities in graphics background color
@param useEntityAtts [0]=color, [1]=level, [2]=linestyle, [3]=pointstyle [4]=linewidth
@param[in] allow_interruption true = allow interruption with Esc
@param[out] interrupted true = user pressed Esc
@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 = merging EMCX file, false = merging MCX file
@param[in] suppressWarning (optional) true = suppress showing the "Associative entities will not be merged" warning
@param[in] pFileMergeOptions (optional) Pointer to FileMergeOptions structure to control unit dialog displayed when merging
@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] allow_interruption true = allow interruption with Esc
@param[out] interrupted true = user pressed Esc
@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
@par Purpose:
Clears both the message log and the message prompt
@par Purpose:
Clears any text in the message log
@par Purpose:
Clears the message prompt
@par Purpose:
Mastercam print. Emulate printf using write_str and write_nl.
@note This function should be used for debugging only
@param[in] fmt format
@param[in] ... parameters to write
@par Purpose:
Write a new line
@par Purpose:
Write a character to the text or graphics screen
@param[in] ch The character to write out
@par Purpose:
Write a real number to the text or graphics screen, assuming one places before the decimal point
@param[in] x The real value to write out
@param[in] n_places The number of decimal places to include
@par Purpose:
Write a string followed by a new line
@param[in] message The string to write out
@par Purpose:
Write an integer to the text or graphics screen
@param[in] i The integer value to write out
@param[in] n_places The number of decimal places to include
@par Purpose:
Write a long integer to the text or graphics screen
@param[in] i The long value to write out
@param[in] n_places The number of decimal places to write the value out to
Defines the file_exist as file_exists()
@par Purpose:
Write a string without carriage returns of line feeds at the end of the string
@param[in] message The string to write out
@par Purpose:
This method determines if the path is a file.
@param[in] fname the file path.
@param[in] warn
@return true, if the path is a file, else, false.
@par Purpose:
This method reads one line from an MBCS text file and replaces the new line with a null character.
@param[out] pLine null terminated string read from the file.
@param[in] maxChars maximum number of characters to read.
@param[in] pFile file pointer.
@return true, if OK, else false.
@par Purpose:
This method reads one line from a file and replaces
the new line with a null character.
@param[in] n maximum number of characters to read.
@param[in] f file pointer.
@param[out] lstr null terminated string read from the file.
@return true, if OK, else false.
@par Purpose:
This method calls fclose and then marks the file allocation record
as dead if the record is found in our array.
@param[in] module_name source module closing the file.
@param[in] line_n source line within the source module.
@param[in] fp file pointer to close.
@return return code.
@par Purpose:
Tries to open a file using the passed SysFile and dispalys error if unsuccessful
@param[in] fileClass reference to SysFile object.
@param[in] prefix prefix to insert
@param[in] name the file to open
@param[in] mode the file open mode
@return true if opened successfully.
@par Purpose:
This method inserts a file prefex then calls FOPEN
@param[in] module source module opening the file.
@param[in] line_n source line within the source module.
@param[in] prefix prefix to insert
@param[in] name the file to open
@param[in] mode the file open mode
@param[out] succf true if success, else false
@return return code.
@par Purpose:
This method lists a file on the screen.
@param[in] filename file to list.
@param[in] msg title string (can be NULL in which case the file name will be the title)
@param[in] pParent Parent window
@par Purpose:
This method calls the default editor to begin editing
the passed file.
@param[in] fname file to edit.
@param[in] wait
@par Purpose:
This method performs the file save operation. It is usually called
from the SaveFile() interface method. However, it can be called directly
to bypass the File/Save dialog.
@return return code (true, if OK, else, false).
@par Purpose:
This method performs the file save operation. It is usually called
from the SaveFile() interface method. However, it can be called directly
to bypass the File/Save dialog.
@return return code (true, if OK, else, false).
@par Purpose:
This method performs the file save operation, first displaying the File/Save dialog.
@param[in] filen MUST be complete path to file
@param[in] pParent pointer to the parent window
@param[in] bGetFilenameOnly true= get the filename but don't save the file
@return return code (true, if OK, else, false).
@par Purpose:
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.
@param[in] bOpen true to start OPEN, false to state SAVE
@param[out] merge merge flag
@param[in,out] ofn The OPENFILENAME structure which passes in and out many of the parameters from the open or save.
@param[in] folderPrompt Custom string to display in the static text control to the left of the folder browser combo box.
@return return code (1 if OK clicked, 2 if CANCEL clicked).
@par Purpose:
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.
@param[in] filen MUST be complete path to file
@param[in] merge merge flag
@param[in] astext open as flag. true= open as text, else, false
@param[in] checkUnits 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)
@param[in] makeLevelsVisible if 'merge' and !'astext' and a level is currently non-visible but it is visible in the incoming file, turn it on (default=true)
@param[out] escaped optional (may be null) if provided, will return true is used aborted file open due to current file state (default=NULL)
@param[in] pFileMergeOptions (optional) Pointer to FileMergeOptions structure to control unit dialog displayed when merging
@return return code (true, if OK, else, false).
File merge options.
@par Purpose:
This method performs the file open operation, first displaying the File/Open dialog.
@param[in] filen MUST be complete path to file
@param[in] pParent pointer to the parent window
@param[in] bGetFilenameOnly true= get the filename but don't open the file
@return return code (1 if OK, 0 if file could not be opened, -1 if cancel hit)
@par Purpose:
This method performs the file open operation, first displaying the File/Open dialog.
@param[in,out] pFileName MUST be complete path to file
@param[in] maxChars maximum number of characters pFileName can hold (including null)
@param[in] pParent pointer to the parent window
@param[in] getFilenameOnly true = get the filename but don't open the file
@return return code (1 if OK, 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 Mastercam file version.
Returned major version number.
Returned minor version number.
Returned file bit size: 0 = 32 bit; 1 = 64 bit.
true if successful, false if file not open.
Gets the current version header.
Current version header.
Default constructor.
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 Mastercam file version.
Returned major version number.
Returned minor version number.
Returned file bit size: 0 = 32 bit; 1 = 64 bit.
true if successful, false if file not open.
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.
Sets 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 this function.
Initialized at file open to MCFT_UNDEF.
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 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 minor version number of the currently open file.
Gets the major version number 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.
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.
@par Purpose:
Remove the given entity from the database by zeroing out the
alive bit
@return Returns false only if user aborts when warned about toolpath or solid references
@param[in] ptr eptr to the entity that is being deleted
@param[in] draw true = draw entity in the background color
@param[in] blank_ent true = blank entity, false = delete entity
@param[in] del_tp_refs true = delete toolpath references
@param[in,out] tp_ref_warn true = warn user about toolpath references.
Returned as false when warning output
@param[in] purge for deleting temporary entities.
@param[in] batchMode true if deleting many entities.
@par Purpose:
Remove the given entity from the database by zeroing out the
alive bit
@return Returns false only if user aborts when warned about toolpath or solid references
@param[in] ptr eptr to the entity that is being deleted
@param[in] draw true = draw entity in the background color
@param[in] blank_ent true = blank entity, false = delete entity
@param[in] del_tp_refs true = delete toolpath references
@param[in,out] tp_ref_warn true = warn user about toolpath references.
Returned as false when warning output
@param[in] purge for deleting temporary entities.
@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:
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:
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
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
@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 = chain is only a point
@param[in] chain 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:
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] chains linked list of chains
@par Purpose:
Draw an arrow in the direction of the last chain in the list
@param[in] chain a chain
@par Purpose:
Draw a linked list of chains and set the .sel field
@param[in] chain linked list of chains
@par Purpose:
Draw a chain and set the .sel field
@param[in] chain a chain
@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] chain chain
@param[out] z depth
@param[out] ok depth is valid
@par Purpose:
Get the endpoint of a chain by number
@param[in] chain 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.
@par Purpose:
Given a sorted list of points (sorted by x and y or y and x),
reverse runs of points to create a zig-zag effect
@param[in] n_wpts Number of window points to sort
@param[in,out] wpts Window points (wpts[0] is start point)
@param[in] sort_i1 sort criteria
@param[in,out] change_made Has a change been made
@}
@par Purpose:
Sort points by x+,x-,y+,y-, then by x+,x- or y+,y-
@param[in] n_wpts Number of window points to sort
@param[in,out] wpts Window points (wpts[0] is start point)
@param[in] sort1 first sorting criterion
@param[in] sort2 second sorting criterion
@param[in] option drill sorting option
@param[in,out] change_made Has a change been made
@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:
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
Sets local operation.
The new value.
Gets local operation.
The local operation.
@par Purpose:
Make a list of operations from an external file
@param[in] fname operations file name
@param[out] grps_out list of groups that operations belong to
@param[out] ops_out list of operations
@param[in] dumpEntAllocations dump entity allocations; default == true
@par Purpose:
open an external file, delete the operation by it's id number or file position
@param[in] slot >0-tool number to overwrite
@param[in] src source file to open
@param[in] fpos >0-file position of tool (disregard slot no)
@param[out] succf true = tool ent found
@par Purpose:
Open an external file, delete the operation by it's id number or file position
@param[in] slot >0-op number to overwrite
@param[in] src source file to open
@param[in] op operation info
@param[in] fpos >0-file position of tool (disregard slot no)
@param[out] succf true = tool ent found
@par Purpose:
Save an operation to the library
@param[in] op ptr to tool structure
@param[in] lib_name file name
@param[in] msg true = display success message
@param[in] add_list true = add to current tool list
@param[out] succf true = everything went aok
@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
@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
Check the operation's toolpath entity count.
the operation to check.
true to update database.
true for debug warning.
a pointer to a CInterrogateMastercamFile object.
true if op's entity count is diffent thatn the # of toolpath entities found in the db for that operation.
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.
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?".
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 is associative linking parameter point compatible.
WEB, 10/17/2016.
The operation code.
true if it is compatible, false if not.
@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
@par Purpose:
determines if the given op does not have/require tool info
@param[in] opcode operation opcode
@param[in] oldnci // I: true = include non-assoc toolpath operations in this evaluation
@return true if the op does not contain (use) a tool; false if it isn't
@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
@par Purpose:
determines if the given op is an xforrm'd toolpath
@param[in] opcode operation opcode
@return true if the op is an xform'd type toolpath; false if it isn't
@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
@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
@par Purpose:
determines if the given op is a holemaking toolpath.
@param[in] opcode operation opcode
@return true if the op is a drill, circle mill, thread mill or helix bore toolpath; false if it isn't
@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 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.
@par Purpose:
determines if the given op is a multi-axis toolpath
@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 multi-axis toolpath
@param[in] opcode operation opcode
@return true if the op is a multi-axis type 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 toolpath is multi-axis.
@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
@par Purpose:
return true if op is supported by mt
@param[in] opcode operation opcode
@return return true if op is supported by mt
@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
@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_ch15 nci line types
@{
@}
@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
@{
@}
@defgroup assocvar_ch41 material type constants
@{
@}
@defgroup assocvar_ch42 tool active head/turret and axis motion constants
@{
A deserialization implementation.
Pass through check that stickouts are safe and not putting tools in midair, throws debug only asserts.
stickout are safe?
Prepares objects for storing.
map of TlIds, TlObjects.
Similar to FixObjects but to only be called to setup assembly relationships from old TlMgr's.
true if it succeeds, false if it fails.
Fix Sliced Tools from old files.
Fix assemblies.
Fix objects.
A vector of all Assemblies that need to have their operations updated due to the
issue of multiple assemblies per tool bad bad relationship
The base map that stores the objects, indexed by the TlID of
the object.
A map which stores which slot number goes with which TlID
Used to support quick looked in the parts of Mastercam which
still depend on slot number
A map which stores which slot number goes with which TlID
Used to support quick looked in the parts of Mastercam which
still depend on slot number
A map that stores which TlID goes with which machine
group number. This map will only contain assemblies that belong
to a machine group
Gets the ent type.
The ent type.
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.
Removes all the items and deletes all the memory used by those items.
Gets lathe tools.
The lathe tools.
Gets the assemblies.
The assemblies.
Gets all tool class objects in this manager.
All objects.
Returns all the live center component IDs in the manager.
A list of IDs of all the live center components in the mgr.
Returns all the tool type IDs in the manager.
A list of IDs of all the tool type in the mgr.
Returns all the tool group IDs in the manager.
A list of IDs of all the tool group in the mgr.
Returns all the cut params IDs in the manager.
A list of IDs of all the cut params in the mgr.
Returns all the op type IDs in the manager.
A list of IDs of all the op types in the mgr.
Returns all the op group IDs in the manager.
A list of IDs of all the op groups in the mgr.
Returns all the work material IDs in the manager.
A list of IDs of all the work materials in the mgr.
Returns all the holder IDs in the manager.
A list of IDs of all the holders in the mgr.
Returns all the tool IDs in the manager.
A list of IDs of all the tools in the mgr.
Returns all the tool IDs in the manager.
A list of IDs of all the tools in the mgr.
Returns all the assembly IDs in the manager.
A list of IDs of all the assemblies in the mgr.
Returns all the IDs in the manager.
A list of IDs of all the objects in the mgr.
Returns true if the item is a lathe tool, false otherwise.
The id to check.
true if the id identifies a lathe tool, false otherwise.
Returns true if the item is a work material, false otherwise.
The id to check.
true if the id identifies a work material, false otherwise.
Returns true if the item is a holder, false otherwise.
The id to check.
true if the id identifies a holder, false otherwise.
Returns true if the item is a tool, false otherwise.
The id to check.
true if the id identifies a tool, false otherwise.
Returns true if the item is an assembly, false otherwise.
The id to check.
true if the id identifies and assembly, false otherwise.
Retrieves the corrupted assembly list.
List of corrupted TlIds.
Find the lathe tool slot corresponding to the ID in question.
The identifier.
Slot of the specified lathe tool.
Find the lathe tool ID corresponding to the slot in question.
The slot.
Tlid of the lathe tool.
Find the mill tool slot corresponding to the ID in question.
The identifier.
Slot of the specified mill tool.
Find the mill tool ID corresponding to the slot in question.
The slot.
the corresponding TlID.
Copies an object from the other manager into this one. IF that object is an assembly, also copies all
associated AssemblyItems.
Manager for other.
The id of the tool to look for.
true if it succeeds, false if it fails.
Maps slots for use by wrapper lists when trying to open a slot.
map of slots.
Retrieves the slot map.
map of slots.
Saves the current TlMgr as a tooldb file of the current .tooldb version.
The file name a path for the output .tooldb file.
true if the file is converted and saved correclty.
Attempts to locate a similar lathe tool assembly to the input parameter "similarTool".
The similar tool.
Identifier for the machine group.
true to ignore tool number.
true if it succeeds, false if it fails.
Attempts to locate a similar assembly to the input parameter "similarAssembly".
The similar assembly.
Identifier for the machine group.
true if it succeeds, false if it fails.
Attempts to locate a tool assembly matching the provided set of search parameters.
The search settings.
Options for controlling the search.
true if it succeeds, false if it fails.
Attempts to locate a tool assembly matching the provided set of search parameters.
Options for controlling the search.
Identifier for the machine group.
(Optional) True to display duplicate tool warning.
true if it succeeds, false if it fails.
Attempts to locate a tool assembly matching the provided set of search parameters.
Options for controlling the search.
true if it succeeds, false if it fails.
Searches for an item in the tool manager. If an item with the provided ID is found, and it castable to
the TYPE of the item parameter, the function copies the data from the tool manager into the provided
item reference. In addition, if a matching ID/TYPE is not found, the tool manager will search for an
assembly that matches the ID, and return the main tool if the item TYPE is castable into a TlTool, or
the main holder if the item TYPE is castable into a TlHolder.
The slot.
The tool.
true if the item is found, false otherwise.
Searches for an item in the tool manager. If an item with the provided ID is found, and it castable to
the TYPE of the item parameter, the function copies the data from the tool manager into the provided
item reference. In addition, if a matching ID/TYPE is not found, the tool manager will search for an
assembly that matches the ID, and return the main tool if the item TYPE is castable into a TlTool, or
the main holder if the item TYPE is castable into a TlHolder.
The slot.
[out] The assembly.
true if the item is found, false otherwise.
Updates an item in the tool manager. The item must be a TlObject. The ID of the item is used to
determine what item to update.
Type of the type.
The item to update. The updated item is assigned to the old item.
(Optional)
If this parameter is true, then the function will update an existing item if one exists, or
add if it does not. If the parameter is false, then this function returns false if the item
provided already exists in the manager.
true if the item is updated, false otherwise.
Updates an item in the tool manager. The item must be a TlObject. The ID of the item is used to
determine what item to update.
Type of the type.
The item to update. The updated item is assigned to the old item.
(Optional)
If this parameter is true, then the function will update an existing item if one exists, or
add if it does not. If the parameter is false, then this function returns false if the item
provided already exists in the manager.
true if the item is updated, false otherwise.
Adds an item to the tool manager. The item must be a TlObject. This is a templated function which
determines its type based on the type of the first parameter. This function will create a new object
copied from the item parameter and store that copy.
Type of the type.
The item to add to the list. A copy of the item will be created and added to the
list, not the parameter itself.
(Optional)
If this parameter is true, then the function will update an existing item if one
exists, or add if it does not. If the parameter is false, then this function
returns false if the item provided already exists in the manager.
true if the item is added, false otherwise.
Adds an item to the tool manager. The item must be a TlObject. This is a templated function which
determines its type based on the type of the first parameter. This function will create a new object
copied from the item parameter and store that copy.
Type of the type.
The item to add to the list. A copy of the item will be created and added to the
list, not the parameter itself.
(Optional)
If this parameter is true, then the function will update an existing item if one
exists, or add if it does not. If the parameter is false, then this function
returns false if the item provided already exists in the manager.
true if the item is added, false otherwise.
Deletes ALL tool records that contain the provided slot.
The id of the tool to look for.
Flag indicating whether to remove the Mill tool associated at the provided slot, or the Lathe
tool associated at the provided slot.
true if it succeeds, false if it fails.
Deletes the given ID.
The id of the tool to look for.
true if it succeeds, false if it fails.
Determines if the specified item exists in this tool manager.
The id of the tool to look for.
true if the item exists, false otherwise.
Query if this object is empty.
true if empty, false if not.
Returns the number of items stored in the manager.
The number of items stored in the tool manager.
Equality operator.
The right hand side.
true if the parameters are considered equivalent.
Move assignment operator.
The right hand side.
A shallow copy of this object.
Assignment operator.
The right hand side.
A shallow copy of this object.
Destructor.
Copies the given TlMgr.
The other tlMgr.
true if it succeeds, false if it fails.
Move constructor.
The other.
Copy Constructor. Creates a copy tool manager.
The other tlMgr.
A default slot validator.
Declaration of private deserialization implementation class.
Executes the get profile operation.
A TlProfileResult.
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.
The holder points array.
The insert points array.
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.
Default constructor. Creates an empty tool.
A deserialization implementation.
Gets an ANSI string position.
The TCHAR to process.
The ANSI string position.
Gets the ANSI string.
The ANSI string.
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.
A deserialization implementation.
Executes the get default cutting side operation.
A TlCuttingSide.
Executes the is cutting item operation.
True if it succeeds, false if it fails.
Gets an ANSI string position.
The TCHAR to process.
The ANSI string position.
Gets the ANSI string.
The ANSI string.
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 default cutting side.
The default cutting side.
Defines an alias representing the TP tool pointer.
Defines an alias representing the lathetool pointer.
A deserialization implementation.
Executes the set main holder action.
Executes the set main tool action.
Executes the slot changed action.
Resets all identifiers associated to this object.
The map of old IDs to new IDs.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Creates new assembly from operation.
The operation.
The new new from operation.
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 machine side connection type.
The machine side connection type.
Removes the assembly components.
true if it succeeds, false if it fails.
Sets the station per configuration.
true if it succeeds, false if it fails.
Sets the offsets per configuration.
true if it succeeds, false if it fails.
Sets as default assembly.
The value.
true if it succeeds, false if it fails.
Sets tool number.
The tool number.
Group the machine belongs to.
Gets the mill tool.
The mill tool.
Determines if the other tool assembly is similar enough to be considered a duplicate.
The other tool assembly.
(Optional) identifier for the machine group.
true if similar, false if not.
Determines if the other tool is different enough to warrant dirtying an operation.
The other tool.
True if the current operation has gouge checking support and it is enabled.
true if different enough to dirty operation, false if not.
Determines if the other tool is different enough to affect an operation.
The other tool.
True if the machine group tells operations to use the tool Peck/Step/Coolant values.
True if the control definition tells operations to use the tool Feed/Speed values.
True if the control definition tells operations to use the tool offsets.
True if the current operation has gouge checking support and it is
enabled.
true if different enough to affect operation, false if not.
Defines an alias representing the tl assembly entry.
Declaration of private deserialization implementation class.
Clean up tools that were created badly in older versions.
True if called from a pre-X8 serialization version
True if called from a pre-X9 serialization version
Query if 'otherTool' has different peck step coolant values.
The other tool.
true if different peck step coolant values, false if not.
Query if 'otherTool' has different feed speed values.
The other tool.
true if different feed speed values, false if not.
Executes the get profile operation.
A TlProfileResult.
Old Holder Attributes
Gets the profile parameters.
The profile parameters.
Executes the is similar operation.
The other tool.
Identifier for the machine group.
The compare mode.
true if it succeeds, false if it fails.
Determines if the other tool is different enough to warrant dirtying an operation.
The other tool.
True if the current operation has gouge checking support and it is enabled.
true if the other tool is different enough to affect an operation.
Determines if the other tool is different enough to affect an operation.
The other tool.
True if the machine group tells operations to use the tool Peck/Step/Coolant values.
True if the control definition tells operations to use the tool Feed/Speed values.
True if the control definition tells operations to use the tool offsets.
True if the current operation has gouge checking support and it is
enabled.
true if different enough to affect operation, false if not.
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.
Gets the data from legacy tool.
true if it succeeds, false if it fails.
Convenience only - No backing field on TlToolMill
The corner radius.
Convenience only - No backing field
The corner radius.
Sets fbm was metric.
true to value.
This is here to support a hack in FBM.
Adjust length for stickout.
The stickout.
Resets the projection values.
Sets a tool material code.
The code.
Name of the matl.
Gets the tool material code.
The tool material code.
Sets a canned text coolant.
The coolant.
Sets a pre x coordinate coolant.
The coolant.
Sets the legacy holder data.
The top.
The height.
Sets the mastercam type of this tool.
The value.
Sets mc tool type.
The value.
Returns the mastercam type of this tool.
The Mastercam type of this tool.
Returns a list of the IDs of the op type this tool
supports
The list of op type IDs support by this tool
Sets the TlToolMill properties located within op_tool_info
true of the setting was successful
Gets operation tool information.
The operation tool information.
Default constructor. Creates an empty tool.
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.
A TlOpParams deserialization implementation.
Resets all identifiers associated to this object.
The map of old IDs to new IDs.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Sets canned text coolant.
The value.
Sets pre x coordinate coolant.
The value.
Decrunches the values from the inputed coolant vector
[in] The initial coolant vector to decrunch.
Decrunched coolant vector.
Converts the inputted coolant value to a Time index (0, 1, 2).
The value to convert from.
Coolant Timing state (BEFORE, WITH, AFTER).
Converts the inputted coolant value to a State index (0, 1, 2).
The value to convert from.
Coolant State (ON, OFF, IGNORE).
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 from canned txt coolant escribed by coolant.
The coolant.
Converts this coolant object into the cannedtxtcoolant shorts
that Mastercam uses in machine definitions and posts.
Paramaterized Constructor.
The old style coolant flag to update from.
Paramaterized Constructor.
The coolant vector to update from.
Sets code from identifier.
Sets identifier from code.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
The old user 2 id.
The old user 2 id.
The old user 1 id.
The ceramic id.
The tin coated id.
The carbide id.
The high speed steel id.
Query if 'testID' is a valid material identifier.
Identifier for the test.
true if identifier a valid material identifier, false if not.
Query if this object is user 2.
true if user 2, false if not.
Query if this object is user 1.
true if user 1, false if not.
Query if this object is ceramic.
true if ceramic, false if not.
Query if this object is tin coated.
true if tin coated, false if not.
Query if this object is carbide.
true if carbide, false if not.
Query if this object is high speed steel.
true if high speed steel, false if not.
Query if this object is defined material.
true if defined material, false if not.
Query if this object is known material.
true if known material, false if not.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Sets an identifier.
The identifier.
true if it succeeds, false if it fails.
Sets an identifier.
The identifier.
true if it succeeds, false if it fails.
Paramiterized constructor.
Material ID to set the code based off of.Will only work for Mastercam known ids
Paramiterized constructor.
Material code to set the ID based off of
Default constructor.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Sets a commercial name.
The name.
true if it succeeds, false if it fails.
Gets the commercial name.
The commercial name.
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.
Determines if the other tool is different enough to warrant dirtying an operation.
The other tool.
True if the current operation has gouge checking support and it is enabled.
true if the other tool is different enough to affect an operation.
Determines if the other tool is different enough to affect an operation.
The other tool.
True if the machine group tells operations to use the tool Peck/Step/Coolant values.
True if the control definition tells operations to use the tool Feed/Speed values.
True if the control definition tells operations to use the tool offsets.
True if the current operation has gouge checking support and it is
enabled.
true if different enough to affect operation, false if not.
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 duplciate.
The other.
(Optional) identifier for the machine group to aid in the comparison.
(Optional) the compare mode.
true if similar, false if not.
Determines if the other tool is different enough to warrant dirtying an operation.
The other tool.
True if the current operation has gouge checking support and it is enabled.
Determines if the other tool is different enough to affect an operation.
The other tool.
True if the machine group tells operations to use the tool Peck/Step/Coolant values.
True if the control definition tells operations to use the tool Feed/Speed values.
True if the control definition tells operations to use the tool offsets.
True if the current operation has gouge checking support and it is
enabled.
true if different enough to affect operation, false if not.
Gets is legacy tool valid.
true if it succeeds, false if it fails.
Gets the legacy tool data. This is only used outside the class in TlToolMill
during legacy deserialization and conversion into legacy tools.
The legacy tool.
Gets legacy is aggregate.
true if is aggregate, false otherwise.
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
Default constructor. Creates an empty tool.
Gets the assoc_id representing the ClassEnt type (i.e. OP_ID).
The assoc_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
Writes/Serializes the entity from a given archive.
The archive to write to.
true if it succeeds, false if it fails.
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 ent idn.
true if it succeeds, false if it fails.
Detach from database.
The entity.
true if it succeeds, false if it fails.
Attach to database.
The entity.
A long.
Attach to database.
A long.
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.
Given two holders, returns two if they are identical,
false otherwise.
A reference to the first holder
A reference to the second holder
Given new data to store in the holder, attaches all the data
and setups up the holder correctly
The IDN of the holder to modify
Source for the holder data.
true if it succeeds, false if it fails.
Given new data to store in the holder, attaches all the data
and setups up the holder correctly
The IDN of the holder to modify
Pointer to the segment data for the holder
The total size of holderData.
Pointer to the library name.
The number of characters in the library name.
Pointer to the holder name.
The number of characters in the holder name.
Given new data to store in the holder, attaches all the data
and setups up the holder correctly
The holder to modify
Pointer to the segment data for the holder
The total size of holderData.
Pointer to the library name.
The number of characters in the library name.
Pointer to the holder name.
The number of characters in the holder name.
Given an ent_idn, returns true if the holder exists, false
otherwise
true is the holder exists, false otherwise
Given a ent_idn, retrieves the tp_holder for this holder
For more details on the holder profile (holder data), read information at the top of
TlHolder_CH.h (in particular about holderEntity.u.holder.holder_ptr_numsegs and
triplets at holderEntity.u.holder.holder_ptr)
true if a matching holder entity was found, false otherwise
Given a ent_idn, retrieves the entity for this holder
For more details on the holder profile (holder data), read information at the top of
TlHolder_CH.h (in particular about holderEntity.u.holder.holder_ptr_numsegs and
triplets at holderEntity.u.holder.holder_ptr)
true if a matching holder entity was found, false otherwise
Creates a new holder entity and stores it in the database.
Source for the holder data.
The ent_idn of the newly-created holder.
Creates a new holder entity and stores it in the database.
The ent_idn of the newly-created holder.
Creates a new holder entity and stores it in the database.
The library name to initialize this holder with.
The length of the holder_lib string.
The name of the holder.
The length of the holder_name string.
The ent_idn of the newly-created holder.
Loads the holder with the given ent_idn from a file.
This function clears out the currently allocated memory.
The ent_idn of the holder to retrieve.
The name of the file to get the holder from.
The updated ent_idn of the holder.
Sets the number of segements for the holder and creates the needed
memory to store the segments.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
The number of segments this holder has.
Sets the holder name for the holder.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
The new holder name as a CString.
Sets the holder name for the holder.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
A pointer to the buffer holding the new holder name
The number of characters in the holder name
Sets the holder name for the holder.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
The library name as a CString
Sets the library name for the holder.
This function clears out the currently allocated memory.
The ent_idn of the holder to modify.
A pointer to the buffer holding the new library
name
The number of characters in the library name
Creates a new holder with COPIES of the old holder data. Does not
place holder entity into the part file.
The destination holder.
The IDN of the holder to copy.
Creates a new holder with COPIES of the old holder data. Does not
place holder entity into the part file.
The destination holder.
The source holder.
Creates a new holder with COPIES of the old holder data.
The IDN of the holder to copy.
Creates a new holder with COPIES of the old holder data.
The holder to copy.
A deserialization implementation.
Executes the get profile operation.
A TlProfileResult.
Executes the on set stored profile operation.
Makes a segment.
The segment.
(Optional) height of the bottom.
(Optional) the color.
A TlProfileSegmentPtr.
Convert profile segment to holder segment.
The profile segment.
The holder segment.
Resets all identifiers associated to this object.
The map of old IDs to new IDs.
Executes the query to find out if 'other' is equal.
The other.
true if equal, false if not.
Serializes this class instance. If the referenced CArchive is writing data out, this class is written
out to the archive. If the referenced CArchive is reading data in, this class is read in from the
archive.
The archive.
Makes holder segments from profile.
The profile.
A vector of TlHolderSegment.
Makes profile from holder segments.
The holder segments.
A TlProfilePtr.
Determines if the other holder is different enough to warrant dirtying an operation.
The other holder.
True if the current operation has gouge checking support and it is enabled.
true if different enough to dirty operation, false if not.
Determines if the other holder is different enough to affect an operation.
The other holder.
True if the current operation has gouge checking support and it is enabled.
true if different enough to affect operation, false if not.
Gets the length of the holder (max y value - min y value).
The length.
Gets the total Height of the Holder (from y=0 to the holder's max y value).
The Height of the Holder.
Query if this object is default holder.
true if default holder, false if not.
Gets the segments
segments to define the holder
Gets the segments.
The segments.
Adds a segment.
Width of the top.
Width of the bottom.
The height.
true if it succeeds, false if it fails.
Deletes all segments.
true if it succeeds, false if it fails.
Copy operator.
The right hand side.
A deep copy of this object.
Copy constructor.
A deep copy of this object
Parameterized constructor.
true if this object is metric.
Default constructor.
comparison operator.
The other.
true if objects are the same
Class representing an old-style holder segment in the form of a top width, a bottom width, and a height.
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.
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.
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.
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.
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 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.
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.
The prime turn tool id.
The us union tool id.
The hpi id.
The mari tool id.
The lyndex nikken id.
The yg id.
The fraisa id.
The redline id.
The micro 100 id.
The harvey tool id.
The garr id.
The everede id.
The ma ford id.
The emuge id.
The osg id.
The mitsubishi id.
The Helical ID.
The Holex - Hoffman Group ID.
The Garant - Hoffman Group ID.
The Sumitomo ID.
The Onsrud ID.
The Harvey ID.
The Greenleaf ID.
The Vortex ID.
The Widia - Valenite ID.
The Widia-Hanita ID.
The Seco ID.
The Dapra ID.
The Duramill ID.
The Niagara ID.
The Dataflute ID.
The Millstar ID.
The Intersoll ID.
The Robbjack ID.
The Sandvik ID.
The Kennemetal ID.
The Command Tool ID.
The mastercam id.
The iscar id.
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.
Transforms the current profile by the given transformation.
The transformation.
Type of the transformation.
Scales the current profile.
The scale factor.
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.
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.
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.
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.
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.
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.
@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
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.
Checks if the working measurement system is NOT english.
True if the system is not english; false if it is.
@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).
Suspend operation manager refresh until this is destroyed.
An operation manager refresh object.
Destructor.
Constructor.
List of operations.
An operation manager refresh object.
Adds the operation to the map. Upon destruction these operations will be
compared to their current state in the oplist to determine which type of
refresh should be applied in the OpMgr
the operation to add.
Destructor.
Constructor.
List of operations.
A map of operations to queue up for refresh when m_spOpMgrRefreshMap is destroyed.
First operation index using the 3D tool specified by the given identifier.
Identifier for the tool.
(Optional) Identifier for an operation to exclude.
An INT_PTR to the first operation using the 3D tool.
First operation using the 3D tool specified by the given identifier.
Identifier for the tool.
(Optional) Identifier for an operation to exclude.
Null if it fails, else a pointer to the first operation using the 3D tool.
Sort ascending by operation.slot number.
True if it succeeds, false if it fails.
@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.
Replace characters in a legacy (MBCS) group name.
The MBCS group name.
The character to replace.
The replacement character.
Convert a structure with an embedded string.
Pointer to the destination structure.
Pointer to the source structure.
The offset of the string to convert to Unicode.
Size of the string to convert.
Size of the structures.
The old way of reading file groups.
Keeping this around for a release. It should be removed for Mastercam 2021.
The part file file.
If the current group list.
True if it succeeds, false if it fails.
Gets the child group hierarchy.
Identifier for the parent group.
The child hierarchy.
Gets the parent group hierarchy.
Identifier for the group.
The parent hierarchy.
Sort by type placing toolpath groups first.
True if it succeeds, false if it fails.
Sort ascending by slot op_group.slot.
True if it succeeds, false if it fails.
Return mask set to which products machine groups contains (AEB_MILL, AEB_LATHE, AEB_MT, etc.
The product mask.
Builds the reserved planes based on all machine group's coordinate display mode.
The reference planes.
Deletes all.
(Optional) true to delete all the machines.
(Optional) true to force delete deletion from the database.
A ListReturnCode.
@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).
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.
@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:
replace holder, if any, in HST operation with given one. Note-holder_data, holder_name,
and holder_library_name should be allocated memory input to this function and
the memory will be deleted by this function (as it is move into the operation entity)
@param[in] op_idn the operation to be modified
@param[in] num_segs the number of holder segments in the new holder
@param[in, out] holder_data the holder segments (triplets: Upper dia, Lower dia, Height)
@param[in, out] holder_name the holder name
@param[in, out] holder_library_name the holder library name
@par Purpose:
remove holder, if any, from HST operation
@param[in] op_idn the operation to be modified
@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
@defgroup lib_mgr_def Library Manager Modes
* @{
@}
@par Purpose:
function to add/get/delete/edit the operation, tools and material libraries
@param[in] lib_type library type (OP_ID, TL_ID or M_ID)
@param[in] lib_name library name or "" (null string) for default library
@param[in] lib_name_sz length of the allocation for lib_name
@param[in,out] lib_entity library entity (ptr to operation, tp_tool or material structure)
@param[in] lib_id OP_ID=op_idn, TL_ID=slot number, M_ID=material name
@param[in] mode LIBMGR_ADD, LIBMGR_GET, LIBMGR_DELETE, LIBMGR_REWRITE and LIBMGR_EDIT
@param[out] fpos file position of entity in the library, -1 if not applicable per mode
@param[out] succf library manager successful
@par Purpose:
function to gather/edit chains for an existing operation -
chain boundary entities are added/delete/edited to db
@param[in] cmi chain manager instructions
@param[in] chntype type of chains to use - 0 = all
@param[out] succf chain boundary operations successful
*@defgroup chn_mgr_def Chain Manager Modes
* @{
@}
Chain Manager Info
@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 tl_mgr_defs Tool Manager Modes
* @{
@}
@par Purpose:
function to add/get/delete/edit lathe tools in the current db
@param[in,out] tl pointer to operation - make sure tl->op.slot is set for read access
@param[in] mode TLMGR_ADD, TLMGR_EDIT, etc
@param[out] eptr db pointer to tool entity
@param[out] succf tool 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
@par Purpose:
* read thru all toolpath entities, check to make sure the referenced
* geometry still exists, mark operations for regeneration, update named views
*
* @param[out] succf true if toolpath was validated successfully; false if not
*
@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
@par Purpose:
deletes all the toolpath ents in an operation
@param[in] opIdn operation id to kill all it's entities
@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:
Find a view given a line or arc.
@param[in] entity Line or arc
@param[out] view An existing view number
@param[out] depth A depth relative to view
@param[out] succf True if view is valid. False if no existing
view was found, or if arcs were found in more
than one view
@param[in] favor_cplane If true and entity is a line, retrun CPlane if possible - default = false
@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 drill_types Drill Types
@{
@}
@defgroup Contour_Flags Contour flags
* @note reserved across all products
@{
@defgroup CFlag_Misc Misc Contour Flags
/** @{
@}
@defgroup CC_ON_OFF CC On/Off flags
/** @{
@}
@defgroup C_Wire_Specific_Flags Wire specific contour flags
@{
@}
@defgroup C_Tank_Flags Tank contour flags
@{
@}
@defgroup C_Lathe_Flags Lathe contour flags
@{
@}
@}
@defgroup Nested_Code_Case Nested Code Case (for subprograms)
@{
@}
@defgroup toolno_flags Tool Number Flags
@{
@}
@defgroup post_modes Post Modes
@{
@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
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.
A std::unique_ptr to a SaveRestoreFilePosition class.
Gets value of m_SetFposSuccess.
value of m_SetFposSuccess.
Sets value of m_SetFposSuccess.
true if SEEK_SET was successful if called to set the file position, false if it failed.
Previous value of m_SetFposSuccess.
Destructor.
Constructor.
The system file (this!)
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.
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
Obtains the current logical length of the file in bytes
This function is only reliable on files less 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.
Sets the file length to the current file pointer.
A flush is performed first to ensure the current file pointer is updated.
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.
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.
@}
selection variables
Selection Mask Type
Selection Mask depth comparisons
Selection Mask length and diameter comparisons
Macro for allocating an ent structure instead of having it on the stack.
@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
@{
@}
Create struct that matches the legacy ent_tp structure. We use a struct instead of using or
typedef in order to preserve the existing use of forward declarations.
Create struct that matches the legacy ent structure. We use a struct instead of using or
typedef in order to preserve the existing use of forward declarations.
A streamlined entity union used to store toolpath entity information only.
@note If a ent member is added between pad and u and the new member
* is not supposed to be part of the ent header, the define below
* must be changed to use the new member in place of u.
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".
setup and stock definition
mc7 associative file header definition
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
mill nci - end of sub program section
mill nci - start of sub program section
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
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
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
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.
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 - 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
operation parameters - database info
Defines an alias representing the plane pointer.
Calls DebugPlaneStr() with this plane's name.
The message.
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 a valid matrix option selection index.
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.
/ <summary>Create a geometry id/eptr map and regenerate the plane to its associated geometry. This
should only be called if in the current db.
A reference to a MastercamPlanes object to get the view #'s from.
The regen mode.
true if it succeeds, false if it fails.
/ <summary>Regenerate the plane to its associated geometry. This should only
be called if in the current db.
A reference to a MastercamPlanes object to get the view #'s from.
The geometry map.
The regen mode.
true if it succeeds, false if it fails.
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.
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.
set regeneration errors.
error mask to add.
return previous error values.
Call up dialog to define new origin point for this plane.
Erase plane icon on dialog startup, draw icon on dialog exit.
(Optional) CWnd to parent window of dialog.
return true if origin point has been redefined.
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).
clear the Plane's points and selected entity info used in it's creation.
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.
Removes the associated described by mask.
Remove geometry association for the origin, matrix or both.
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.
check the Plane's data.
A reference to a MastercamPlanes object to get the view #'s from.
check the assigned ID.
regeneration mode (REGEN_NATURAL, etc)
(Optional) pointer to geometry entities eptr/ID map, NULL will create one if regenerate is set to true.
returns true if all data is valid.
return true if Plane is asscoiated to geometry.
true if associated, false if not.
Check to see if Plane can be associated to geometry and if it actually is, set m_IsAssoc to true.
true if (m_IsAssoc == true), false if not.
check to see if Plane is referencing any geometry by it's ID.
returns who's assocaited to geometry, the origin and/or matrix
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.
(Optional) true to display warning.
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)
Transform this plane by the given transformation matrix.
valid transformation matrix.
transform plane origin too.
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.
Sets the values in m_Dependent.
Information describing the dependency.
Previous value of m_Dependent.
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.
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.
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.
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.
resource string table ID.
returns true if successful.
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.
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.
get the Plane's dependency info (RelativeType::Front, etc), transform data
The relative type.
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.
set of entity ID's.
returns # of 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.
array to stuff the Plane's points info into.
returns size of array.
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.
get the unique ID of the plane's parent plane.
returns the plane's parent plane's ID.
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.
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.
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.
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.
validation and regeneration modes.
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.
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.
Information about the active viewport.
Defines an alias representing the plane base class pointer.
Convert an MBCS string to a wide string.
The archive.
If non-null, the wide character buffer.
The number of characters converted.
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.
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.
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
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.
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.
(Optional) comparison mode, false = select files, true = compare NCI in pComp1 to pComp2.
(Optional) If non-null, the NCI to compare with pComp2.
(Optional) If non-null, the NCI to compare with pComp1.
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
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.
Collects pointers to DB_LIST_ENT_PTR types embedded in an operation or toolpath entity.
the entity to look in.
Size of vecEptrs.
Builds a vector of all the eptrs in this.
A shared ptr to a vector of eptrs in this.
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
Setter for NCI gcodes (NCI_RAPID, NCI_CCW, etc) mask to collect from the source file
IDArray of mask Ids
Getter for NCI gcodes (NCI_RAPID, NCI_CCW, etc) mask to collect from the source file
Returns IDArray
Setter for toolpath operation ID mask to exclude from the source file
IDArray of mask Ids
Getter for toolpath operation ID mask to exclude from the source file
Returns IDarray
Setter for toolpath operation ID mask to collect from the source file
IDArray of mask Ids
Getter for toolpath operation ID mask to collect from the source file
Returns IDArray
Setter for toolpath entity type (TP_CHN, TP_OPID, etc) mask to collect from the source file
VArray of TP_ENT_TYPEs
Getter for toolpath entity type (TP_CHN, TP_OPID, etc) mask to collect from the source file
Returns VArray of TP_ENT_TYPEs
Setter for toolpath operation's NCI mask. True to collect toolpath operation's NCI from the source file
True for 'on', False for 'off'.
Getter for toolpath operation's NCI mask. True to collect toolpath operation's NCI from the source file
Returns bool. True for 'on', False for 'off'.
Setter for toolpath entities. True to collect toolpath entities from the source file
True for 'on', False for 'off'.
Getter for toolpath entities. True to collect toolpath entities from the source file
Returns bool. True for 'on', False for 'off'.
Setter for operations mask. True to collect toolpath operations from the source file
True for 'on', False for 'off'.
Getter for operations mask. True to collect toolpath operations from the source file
Returns bool. True for 'on', False for 'off'.
Setter for groups mask. True to collect machine and toolpath groups from the source file
True for 'on', False for 'off'.
Getter for groups mask. True to collect machine and toolpath groups from the source file
Returns bool. True for 'on', False for 'off'.
Setter for tools mask. True to collect tools from the source file.
True for 'on', False for 'off'.
Getter for tools mask. True to collect tools from the source file.
Returns bool. True for 'on', False for 'off'.
Setter for planes mask. True to collect planes from the source file
True for 'on', False for 'off'.
Getter for planes mask. True to collect planes from the source file
Returns bool. True for 'on', False for 'off'.
Setter for true to collect geometry referenced by toolpath operations from source file
True for 'on', False for 'off'.
Getter for true to collect geometry referenced by toolpath operations from source file
Returns bool. True for 'on', False for 'off'.
Setter for Tool Manager
Pointer to the tool manager.
Getter for Tool Manager
Returns ptr to Tool Manager.
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.
Sets minor file version of the source file
The major version as an int
Gets minor file version of the source file
Returns int.
Sets major file version of the source file
The major version as an int
Gets major file version of the source file
Returns int.
Setter for pointer to copy of MastercamPlanes from the source file
void*, planes construct
Getter for pointer to copy of MastercamPlanes from the source file
Returns void*
Setter for array of toolpath entities that have no parent operation
The referenced array of toolpath entities with no parent operation
Getter for array of toolpath entities that have no parent operation
Returns CFposEntArray reference
Setter for array of tool copies from the source file
The referenced array of tool copies
Getter for array of tool copies from the source file
Returns CFposEntArray reference
Setter for array of geometry entity copies referenced by operations from the source file
The referenced array of geometry entities
Getter for array of geometry entity copies referenced by operations from the source file
Returns CFposEntArray reference
Setter for Map of operation copies from the source file
The reference to the OpMap
Getter for Map of operation copies from the source file
Returns OpMap
Setter for (Groups) vector of machine and toolpath group copies from the source file
The reference to VArray of groups
Getter for (Groups) vector of machine and toolpath group copies from the source file
Returns VArray of op_group pointers
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.
true if the test passes, false if the test fails.
Tests operation against masks before loading into m_Operations.
The entity.
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.
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.
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.
The file position in a external file, -1 for the current db.
The operation entity.
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 operation ptrs by operation manager order.
Array of operation map ptrs.
size of opArray.
Gets the root group of a subgroup.ge
Identifier for the group.
Iterator to the root group in m_Groups.
Defines an alias representing the operation map (operation ID, copy of operation).
Defines an alias representing the operation map pointer.
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 the dirty operation IDs.
The dirty operation IDs.
(Optional) the dirty flag to match.
The size of opIDs.
Sort operation IDs in opIDS by operation manager order.
The operation IDs to sort.
true if it succeeds, false if it fails.
Gets selected operation IDs.
The selected operation IDs.
(Optional) the select flag to match.
The size of opIDs.
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.
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 plane info from an external Mastercam file.
Mastercam file name.
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 and external Mastercam file.
Filename of the external Mastercam file.
List of NCI gcodes to include, empty gcodeMask = all NCI lines.
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 Planes.
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 operations and their NCI from an external Mastercam file.
Filename of the Mastercam file.
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 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.
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.
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 (no associated geometry or planes) from the current db.
The IDs of operations to load.
true if it succeeds, false if it fails.
Preset masks and loads this object with just the operations whose opcodes match ones
in the given opCodeMask parameter and their toolpath entities from the current db.
Only collect operations with these opcodes.
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 and associated geometry from the current db.
The IDs of operations to load.
true if it succeeds, false if it fails.
Preset masks and loads this object with just operations and toolpath entities from an external Mastercam
file.
Filename of the Mastercam file.
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.
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.
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.
true if it succeeds, false if it fails.
Initializes the masks.
Empty the m_pPlanes object.
Empties this object.
Destructor.
Default constructor.
Utility class to collect entities and info of the current db or an external Mastercam file.
Creates pointer to initialized InterrogateMCFile object.
Returns pointer to IInterrogateMastercamFile.
Destructor.
Default constructor.
Creates collection of entities and info of current db or external Mastercam files.
Builds a vector of all the eptrs in this.
A shared ptr to a map of eptrs and all their matching locations and entity ID #'s in this.
Defines an alias representing the map eptrs.
eptr, spVector->{ ptr to matching eptr, entity ID }
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
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
Setter for NCI gcodes (NCI_RAPID, NCI_CCW, etc) mask to collect from the source file
IDArray of mask Ids
Getter for NCI gcodes (NCI_RAPID, NCI_CCW, etc) mask to collect from the source file
Returns IDArray
Setter for toolpath operation ID mask to exclude from the source file
IDArray of mask Ids
Getter for toolpath operation ID mask to exclude from the source file
Returns IDarray
Setter for toolpath operation ID mask to collect from the source file
IDArray of mask Ids
Getter for toolpath operation ID mask to collect from the source file
Returns IDArray
Setter for toolpath entity type (TP_CHN, TP_OPID, etc) mask to collect from the source file
VArray of TP_ENT_TYPEs
Getter for toolpath entity type (TP_CHN, TP_OPID, etc) mask to collect from the source file
Returns VArray of TP_ENT_TYPEs
Setter for toolpath operation's NCI mask. True to collect toolpath operation's NCI from the source file
True for 'on', False for 'off'.
Getter for toolpath operation's NCI mask. True to collect toolpath operation's NCI from the source file
Returns bool. True for 'on', False for 'off'.
Setter for toolpath entities. True to collect toolpath entities from the source file
True for 'on', False for 'off'.
Getter for toolpath entities. True to collect toolpath entities from the source file
Returns bool. True for 'on', False for 'off'.
Setter for operations mask. True to collect toolpath operations from the source file
True for 'on', False for 'off'.
Getter for operations mask. True to collect toolpath operations from the source file
Returns bool. True for 'on', False for 'off'.
Setter for groups mask. True to collect machine and toolpath groups from the source file
True for 'on', False for 'off'.
Getter for groups mask. True to collect machine and toolpath groups from the source file
Returns bool. True for 'on', False for 'off'.
Setter for tools mask. True to collect tools from the source file.
True for 'on', False for 'off'.
Getter for tools mask. True to collect tools from the source file.
Returns bool. True for 'on', False for 'off'.
Setter for planes mask. True to collect planes from the source file
True for 'on', False for 'off'.
Getter for planes mask. True to collect planes from the source file
Returns bool. True for 'on', False for 'off'.
Setter for true to collect geometry referenced by toolpath operations from source file
True for 'on', False for 'off'.
Getter for true to collect geometry referenced by toolpath operations from source file
Returns bool. True for 'on', False for 'off'.
Setter for Tool Manager
Pointer to the tool manager.
Getter for Tool Manager
Returns ptr to Tool Manager.
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.
Sets minor file version of the source file
The major version as an int
Gets minor file version of the source file
Returns int.
Sets major file version of the source file
The major version as an int
Gets major file version of the source file
Returns int.
Setter for pointer to copy of MastercamPlanes from the source file
void*, planes construct
Getter for pointer to copy of MastercamPlanes from the source file
Returns void*
Setter for array of toolpath entities that have no parent operation
The referenced array of toolpath entities with no parent operation
Getter for array of entities without references from the source file
Returns CFposEntArray reference
Setter for array of tool copies from the source file
The referenced array of tool copies
Getter for array of tool copies from the source file
Returns CFposEntArray reference
Setter for array of geometry entity copies referenced by operations from the source file
The referenced array of geometry entities
Getter for array of geometry entity copies referenced by operations from the source file
Returns CFposEntArray reference
Setter for Map of operation copies from the source file
The reference to the OpMap
Getter for Map of operation copies from the source file
Returns OpMap
Setter for (Groups) vector of machine and toolpath group copies from the source file
The reference to VArray of groups
Getter for (Groups) vector of machine and toolpath group copies from the source file
Returns VArray of op_group pointers
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.
true if the test passes, false if the test fails.
Tests operation against masks before loading into m_Operations.
The entity.
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.
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.
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.
The file position in a external file, -1 for the current db.
The operation entity.
An OpMap::iterator where the operation was added.
Gets operation ptrs by operation manager order.
Array of operation map ptrs.
size of opArray.
Gets the root group of a subgroup.
Identifier for the group.
Iterator to the root group in m_Groups.
Defines an alias representing the operation map (operation ID, copy of operation).
Defines an alias representing the operation map pointer.
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 the dirty operation IDs.
The dirty operation IDs.
(Optional) the dirty flag to match.
The size of opIDs.
Sort operation IDs in opIDS by operation manager order.
The operation IDs to sort.
true if it succeeds, false if it fails.
Gets selected operation IDs.
The selected operation IDs.
(Optional) the select flag to match.
The size of opIDs.
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.
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 plane info from an external Mastercam file.
Mastercam file name.
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 and external Mastercam file.
Filename of the external Mastercam file.
List of NCI gcodes to include, empty gcodeMask = all NCI lines.
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 Planes.
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 operations and their NCI from an external Mastercam file.
Filename of the Mastercam file.
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 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.
Preset masks and loads this object with just the operations whose IDs match ones in the given opIDs
parameter and their toolpath entities (no associated geometry or planes) from the current db.
The IDs of operations to load.
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.
true if it succeeds, false if it fails.
Preset masks and loads this object with just the operations whose opcodes match ones
in the given opCodeMask parameter and their toolpath entities from the current db.
Only collect operations with these opcodes.
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.
true if it succeeds, false if it fails.
Preset masks and loads this object with just operations and toolpath entities from an external Mastercam
file.
Filename of the Mastercam file.
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.
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.
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.
true if it succeeds, false if it fails.
Initializes the masks.
Empty the m_pPlanes object.
Empties this object.
Destructor.
Utility class to collect entities and info of the current db or an external Mastercam file.
Initializes this object.
(Optional) If non-null, (Optional) the CInterrogateMastercamFile info object.
Gets operation IDs by a geometry reference.
The geometry ent to search for.
Identifier for the solid operation.
The operation IDs that reference the geometry.
Size of opIDs array.
Gets toolpath entities that reference the given geometry entity.
the geometry entity.
Identifier for the solid operation.
Array of toolpath entities that reference the geometry entity.
Size of tpEntArray.
Destructor.
Constructor.
(Optional) If non-null, (Optional) the CInterrogateMastercamFile info object.
Utility class that collects operations by their referenced geometry.
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 Planes.
(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.
Empties this object.
Gets a ptr to the operation.
null if it fails, else the operation pointer.
Destructor.
Constructor.
The file position, -1 for current file.
The operation entity.
Copy constructor.
The object.
Default constructor.
Values that represent the modification types needed or applied.
Constructor.
Type of the plane.
The matrix of the Tplane, Cplane or WCS.
The origin in world coords.
op's op_view's assigned plane ID.
Operation ID if a plane is required for this operation type, else a 0.
true = create a new plane if needed.
Information about the operation's op_view data mismatch with its NCI.
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.
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.
Default constructor.
Defines an alias representing type of the map.
Array of entity information.
Defines an alias representing type of the byte.
Copies the formulae file from m_FormulaeFile to theEnt.
the entity to copy to.
true to just zero out the ent.
true if it succeeds, false if it fails.
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 and frees memory of this object.
Initializes this object.
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.
The file position if it's from an external file, -1 for the current file.
The entity to attach.
Size of entity if successful, 0 or -1 on failure.
Destructor.
Default constructor.
Entity information.
Collect ptrs and sizes ofr variable length fields in a toolpath operation.
the operation to test.
the map to fill in.
The operation variable lengths.
Test to see if an entity contains variable length data.
the ent to test.
True if it does, false if it doesn't.
Copies critical depths from the source to the target.
List of depths of the sources.
List of depths of the targets.
true = first free target memory.
A CopyErrorFlag.
Copies critical depths from the source operation to the target operation.
Source operation.
Target operation.
true = first free target memory.
A CopyErrorFlag.
Free critical depths in the operation entity.
The operation entity.
true if it succeeds, false if it fails.
Gets a pointer to the critical depths parameter in operations that have them.
The operation to check in.
true = also check that the count > 0 before returning a ptr.
Check or don't check for supported operation types.
null if it fails, else the pointer.
Gets a pointer to the critical depths parameter in operations that have them.
The operation entity to look in.
true = also check that the count > 0 before returning a ptr.
Check or don't check for supported operation types.
null if it fails, else the pointer.
Copies formulae file from the source operation to the target operation.
Source operation.
Target operation.
true to free target memory.
true if it succeeds, false if it fails.
Free formulae file allocation in an operation entity.
The operation entity.
true if it succeeds, false if it fails.
Returns a CString with the formulae file from the op.
the operation.
The formulae file, empty CString if not found.
Gets formulae file size and pointer from the operation entity.
The operation entity.
true = also check that the count > 0 before returning a ptr.
Formulae file size and character ptr.
Full pathname of the formulae file with a null terminating character.
true if it succeeds, false if it fails.
Gets formulae file size and pointer from the operation entity.
The operation.
true = also check that the count > 0 before returning a ptr.
Formulae file size and character ptr.
Full pathname of the formulae file with a null terminating character.
true if it succeeds, false if it fails.
Default constructor.
Return values for CopyDepths ().
Check or don't check for supported operation types in GetPtr()
before return ptr to critical depths.
Values that represent whether to check the depth counts in operations.
Class to manage the variable length surface depths parameter.
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.
Copy constructor.
The object.
Defines an alias representing list of names of the lathe tplanes.
Defines an alias representing the reserved name pair.
Defines an alias representing list of names of the reserved planes.
Defines an alias representing the reserved plane pair.
Defines an alias representing the reserved plane map.
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.
return CString of m_RegenErrors.
The regen errors.
The regen error string.
return value of m_RegenErrors.
The regen errors.
Gets solid face information.
[out] Solid entity id number.
[out] Selection index.
true if it succeeds, false if it fails.
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.
get the point CAD entry method.
returns method if successful.
Return true if the creation method requires a recalculation to its geometry (like PEC_ENDPOINT)
true if it method required recalculation, false if doesn't (like PEC_VALUES).
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.
set up to two entity ID's that P3D is created with.
1 of 2 entity ID's.
2 of 2 entity ID's.
return up to two entity ID's that P3D was created with.
array to fill in with entity ID's.
return # of entity ID's found.
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.
.
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.
return true if successful.
recalculate the point position.
The third m 3.
return true if successful.
return the point entry method, 0 if not yet set.
The entry method.
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 plane point.
The origin.
The solid body entity id number.
Solid face selection index.
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
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.
Empties this object.
Merge old IDs from node to map element.
The set to merge into.
The set to merge from.
# of IDs added.
Dumps this object.
Adds marked system views to refPlanes global.
A reference to a MastercamPlanes object to add to.
Number of system views added to refPlanes.
Gets the old plane / view_ent IDs from the map nodes.
The set to fill in.
Size of set.
Gets the map.
The map.
Gets the size of the m_Map.
The size.
Gets the value of m_MaxEntID.
The value of m_MaxEntID.
Gets the new view no from the old.
The old view no.
The new view no.
get the DbViewMapNode that corrosponds with oldViewNo.
The old view number.
(Optional) The matrix to match.
iterator to match if found.
get the DbViewMapNode that corrosponds with m33.
the 3x3 matrix to match.
[in,out] set to true if matrix added, false if it already exists.
(Optional) DbViewMapNode::NodeType::Undefined to not make new if match not found.
iterator to match if found.
Adds a view node to the map.
The node.
pointer to newly added or matching node in m_Map, nullptr if it fails.
Populate the map directly from Planes global.
Return size of m_Map.
Build a view map from the given open Mastercam file.
[in,out] Already opened Mastercam file.
[in,out] reference to planes object to set .m_InGetDb.
Return size of m_Map.
Destructor.
Default constructor.
Defines an alias representing the pair.
Defines an alias representing the map.
DbViewMap class - used in get_db () to rebuild system views in the order they were saved.
Gets the description.
The description.
Return or create-and-return the new view # for this node.
true to create and add a new system matrix.
The new view no.
Less-than comparison operator.
The object.
true if the first parameter is less than the second.
Assignment operator.
The object.
A shallow copy of this object.
Constructor.
The old view ent or plane ID.
The matrix.
The old view no.
Type of the node.
Default constructor.
Values that represent plane info source.
DbViewMapNode class - used in DbViewMap.m_Map as an array element
Returns true if m_Map is empty.
true if m_Map is empty.
Gets multi map.
The multi map.
Gets the entity map.
The map.
Gets an eptr by entity ID.
entity ID to match.
The eptr.
Gets entity identifier ID be the eptr.
The eptr to find.
The entity ID.
return number of elements.
The size.
return value of entity mask.
The mask.
find the entity with the given ID.
entity ID (ent.ent_idn) to match.
the entity to copy into.
returns true if entity found and copied.
read thru the db and build the map.
entity type mask (GEOM_MASK, etc)
true to also load associative ents.
Return size of map.
Defines an alias representing the pair.
Defines an alias representing the map.
Default constructor.
(Optional) the ent's db pointer.
(Optional) the # of plane references.
(Optional) the # of toolpath references.
Information about the ent.
Destructor.
Constructor.
The entity type mask (GEOM_MASK, etc).
(Optional) true to load associated ents.
EntityEptrMap class - read thru the current db once, create map of eptrs and
entity ID's based on entity type mask
A MCFile forward declaration.
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.
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.
Constructs an XfmMatrix object to be used instead of Mastercam's x_matrix
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.
Set matrix values that are less than theTol to 0.0.
the tolerance.
[in,out] The number of components changed.
true if matrix valid.
correct bad matrix.
true = use MakeViewK() if all else fails.
return true if 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.
.
return tolerance.
The tolerance.
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.
Calculate angle between this and another parallel matrix.
The parallel matrix to measure against.
Angle in degrees.
true if parallel and calculation successful.
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.
return true if Matrix33 is parallel with given Matrix33.
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.
Return true if Matrix33 is equal within a tolerance.
another Matrix33 to compare this with.
(Optional) match tolerance.
Return true if equal.
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.
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.
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).
convert a P3D in world coordinates to world coordinates.
the P3D in world coordinates to convert.
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.
Set values that are less than theTol to 0.0.
the tolerance.
Number of values changed.
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.
Return true if P3D is equal within a tolerance.
another P3D to compare this with.
(Optional) 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.
Tool reference information.
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
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
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
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
@{
@}
@}
Tolerances
*
* Tolerance settings for posting, 'var' are MP variables
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
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
axis combo information in an MP friendly format
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
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
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.
@brief array for storing the number of each possible axis of motion for an operation
Entry 0 isn't used, entries 1->LAST_AXIS_TYPE correspond to axis definitions
The value identifies the number of each unique axis present
endcode
@brief 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
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]
transformation matrix to put component on machine @ initial position
position of reference point with component on machine @ initial position
in world coordinates
point on component which is actually positioned in the NC program
(world coordinates)
reference point on component in world coordinates,
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
default tool in the spindle
time to index between adjacent ATC pockets
tool change machine position - not used
max. number of tools in carousel
time to swap the tool in the spindle
NO_INDEXING, +IVE, -IVE, MINIMIZE_TIME
@}
@defgroup multi_tool_component_types Multi-tool component types
@{
@brief 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
TOOL_LOC_CENTER, TOOL_LOC_TOP_LEFT, TOOL_LOC_CENTER_LEFT,
TOOL_LOC_BOTTOM_LEFT, TOOL_LOC_TOP_CENTER, TOOL_LOC_TOP_RIGHT,
TOOL_LOC_CENTER_RIGHT, TOOL_LOC_BOTTOM_RIGHT, TOOL_LOC_BOTTOM_CENTER,
TOOL_LOC_USER,
method by which the user defined the tool transformation view
TOOL_XFORM_CROSS_UPPER, TOOL_XFORM_CROSS_LOWER,
TOOL_XFORM_FACE_LEFT, TOOL_XFORM_FACE_RIGHT,
TOOL_XFORM_NAMED_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
used to identify variables in the above enum
used for turrets and tool changers
used for tool location components
used for tool location components
used to identify variables in the above enum
used to identify variables in the above enum
used to identify variables in the above enum
used to identify variables in the above enum
Custom groups, up to 99999
These will be used in future versions to cover groups that don't fit
into the pre-defined definitions
Wire-specific miscellaneous tooling groups
Router-specific miscellaneous tooling groups
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
Part holding component groups
Mill-specific part holding groups
used to identify variables in the above enum
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
array of data stream names
@file MachiningMode_CH.h
machine/tool machining mode and axis combination information
@par Multi-tasking data stream parameters
@note MAX_DATA_STREAMS is defined in AssocTyp_ch.h
maximum length for a stream name
data stream name
@param[in] parent_name name of new group's parent group
@param[in] group_name name of new group
@param[in] n_eptr number of ents in eptr list, 0=use .sel ents
@param[in] eptr list of entity eptrs
@param[in] product PRODUCT_MILL, PRODUCT_LATHE, PRODUCT_ROUTER, PRODUCT_WIRE, or PRODUCT_MT
@param[out] succf true = group added
@par Purpose:
append ents to a group
@param[in] group_id group ID
@param[in] n_eptr number of ents in eptr list, 0=use .sel ents
@param[in] eptr list of entity eptrs
@param[out] succf true = group added
@par Purpose:
append ents to a group
@param[in] name group name
@param[in] n_eptr number of ents in eptr list, 0=use .sel ents
@param[in] eptr list of entity eptrs
@param[out] succf true = group added
@par Purpose:
add a new group to the list
@param[in] name new group name
@param[in] n_eptr number of ents in eptr list, 0=use .sel ents
@param[in] eptr list of entity eptrs
@param[in] type type of group
@param[out] succf true = group added
@par Purpose:
remove ents from a group
@param[in] name new group name
@param[in] n_eptr number of ents in eptr list, 0=use .sel ents
@param[in] eptr list of entity eptrs
@param[in] del_empty true = delete group from list if 0 ents are left
@param[out] succf true = group added
@par Purpose:
Find first occurence of "eptr" in "EPTRs"
@return array index if already exists in array, -1 if not found
@param[in] EPTRs array to search.
@param[in] eptr item to find.
@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
Sets the variable stock row number.
The new value.
Gets the variable stock row number.
The row number.
Sets the variable stock floor stock value.
The new value.
Sets the variable stock wall stock value.
The new value.
Gets the variable stock to leave group type.
0 for machining (drive), 1 for avoidance (check).
Sets the variable stock to leave toolpath operation id # parameter.
Gets the variable stock to leave toolpath operation id # parameter.
@}
@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
group view structure
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).
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.
cnc machine parameters
probe toolpath parameters
toolpath nesting parameters
solid drill toolpath parameters
V9 Solids drill detection parameters
Solid drill detection parameters
automatic drilling parameters
trimmed toolpath parameters
manual entry parameters
chook operation
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
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 overlap settings
multiaxis entry and exit
multiaxis entry or exit
operation parameters - surface hmm
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
operation parameters - V7 pocketing parameters
Facing
Pocket
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
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 multiple depth cut parameters
lathe groove shape parameters (not used with 2 boundary groove)
clearance cut
lathe cutoff toolpath parameters
lathe corner parameters
dwell parameters
retract parameters
peck parameters
lathe peck/dwell parameters
lathe pinch turn operation
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 feed from types.
Lathe feed rate types.
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
operation parameters - drilling specific parameters
Lathe chip break parameters.
lathe tool inspection parameters
Axis limit property page
@defgroup Contour_Types Contour types
@{
@}
@defgroup Pocket_Types Pocket types
@{
@}
multiaxis axis limit
operation parameters - contour specific parameters
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-translate (linear array) toolpath
operation parameters - xform-rotate toolpath
operation parameters - xform-mirror toolpath
operation parameters - xform-view info
wire new power set parameters
wire new power pass parameters
wire Agie parameters
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
* @note 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
group info
Group entity
Part operation id # entity
Part entity
@defgroup assoctyp_ch2412 Toolpath Nesting
@{
Sheet entity
toolpath entity - Router tab entity
CHook Toolpath Structure
group entity
surface entity - surface info
toolpath entity - arc from solid information
V8 SDetect Drill Geometry Structure
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
Wire change at point header
@}
@}
@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
@}
@defgroup wire_structures Wire Structures
@{
Wire power set pass settings
for linked lists of material entities
material definition
lathe specific material specs
@defgroup material_structures Material Structures
@{
mill specific material specs
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
event list header event
Defines an alias representing the gcode mask.
lathe component boundary
Lathe tool definition
Machine reference position type and method of positioning
Reference position source (how it was created)
For tool item id
For MT machine position data
Type of reference position
The next 2 members are used for axis combination reference POINTS and home position only.
View Entity Structure
WCS Information Structure
Named View Associative Geometry Selections
for tp_ent type
LATHE TOOL
LATHE TOOL
CUSTOM LATHE TOOL
GENERAL HOLDER MENU CONFIGURATION
GENERIC TOOL HOLDER (ALL UNITS ALWAYS IN INCHES!)
LATHE INSERT/DRILLING TOOL DEFINITION
DRILLING TOOL MENU CONFIGURATION
LATHE DRILLING TOOL DEFINITION
GROOVING/PARTING INSERT MENU CONFIGURATION
GROOVING/PARTING INSERT
THREADING INSERT MENU CONFIGURATION
THREADING INSERT
GENERAL TURNING / BORING INSERT MENU CONFIGURATION
GENERAL TURNING/BORING INSERT (ALL UNITS ALWAYS IN INCHES!)
LATHE TOOL TYPE MENU CONFIGURATION
CONFIGURATION FOR DIMENSIONED BITMAP
CONFIGURATION INFO FOR A LIST VIEW OR DROPDOWN
@defgroup ltooldef_ch2 LIMITS
@{
@}
@defgroup ltooldef_ch3 LATHE TOOL TYPES
@{
@}
@defgroup ltooldef_ch4 CUSTOM GEOMETRY TOOL TYPES
@{
@}
@defgroup ltooldef_ch5 THREAD INSERT TYPES
@{
@}
@defgroup ltooldef_ch6 THREAD TYPES
@{
@}
@defgroup ltooldef_ch7 DRILLING TYPES
@{
@}
@defgroup ltooldef_ch8 TAP TYPES
@{
@}
@defgroup ltooldef_ch9 TOOL COMPENSATION TYPES
@{
@}
FLOATING POINT EDIT BOX LIMITS, DEFAULTS
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 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 Lathe Live Center taper styles.
Values that represent the different Lathe Live Center point styles.
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.
Enumeration representing the Holder Upper 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.
@defgroup assocvar_ch26 tool radius types
@{
@}
@defgroup assocvar_ch27 canned cycle types
@{
@}
@defgroup assocvar_ch3 mill cutter capabilities
@{
@}
Enumeration for different material groups.
Declares the TlTurnHolder type and its shared_ptr/unique_ptr aliases.
Declares the TlBoundaryGenerationParams type and its shared_ptr/unique_ptr aliases.
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.
Class defining Milling Tool Operation Parameters.
Declares the TlOpParams type and its shared_ptr/unique_ptr aliases.
Class defining Tool Operation Parameters.
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.
Class to maintain a list of tool items. Can be added to the database to store a file tool item list, or
can be kept unattached to function as a "local" tool item list.
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.
Tl holder lathe class.
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.
Base class for insert representation
Declares the TlCoolant type and its shared_ptr/unique_ptr aliases.
Class representing a collection of tool coolant settings.
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.
Class representing a custom user-defined tool grade.
Declares the TlWorkMaterial type and its shared_ptr/unique_ptr aliases.
Declares the TlToolMaterial type and its shared_ptr/unique_ptr aliases.
Class representing a tool material.
Declares the TlMaterial type and its shared_ptr/unique_ptr aliases.
Class representing a basic material.
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.
Class representing a mill tool holder.
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.
The base lathe tool class. This class contains data and functions that are common to every tool.
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.
The base mill tool class. This class contains data and functions that are common to every mill tool.
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.
Class representing a mill tool assembly.
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.
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
lathe tool types
DATA PROTOTYPES
Tool station
Tool block component parameters
Tool heads
@defgroup block_types Block Types
@{
@}
@defgroup head_types Head Types
@{
@}
maximum length of a name TOOLHEAD
Tool head component parameters
safety zones
ent_list_idn memory pointer info
misc. list of entities by ent_idn
ent_idns for machine components and component groups in the database
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.
@defgroup assoctyp_ch1 some system limits
@{
@}
@defgroup assocvar_ch40 tool types
@{
@}
custom operation
MT work type
MT prototype version
Machine component unique identifier
Solid Detection - conical face structure
Solid Detection - cylindrical face structure
Solid Drill detection Data
AssocTyp_ch.h
@}
@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
structure for dimensions
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
@}
Database List Entity
A CHAIN is a single chain or the start of a linked list of chains
@defgroup dbvars_ch1 Sel bit constants
@{
@}
@defgroup dbvars_ch4 Surface IDs
* @note used in surface header f.type 0 - 15
@{
@}
@defgroup dbvars_ch5 file types (used with FILE_ID, PMESH_ID, and STOCK_ID entities)
@{
@}
@defgroup dbvars_ch6 Database FN IDs
* @note sub-types of DB_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
@{
@}
@}
@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.
@{
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
@{
Relief Information Type
Art Associative Entry
Art Bounding Box
profile entity type
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)
Data structure for font attributes.
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
Entity Attribute Type
EA Type
Bitmap type
Description type
The worksheets structure
The level structure
Structure to hold names of levels
Visible levels
File Lock History Type
File Lock History Structure
Fle Lock Type
History Type
History Structure
Version Header
@}
Relative density (used in NCS files only)
Screen Information Type
@}
@defgroup screen_types Screen Types
@{
View Matrix Type
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
Solid data header for storing .x_t in partfile
@defgroup solid_types Solid Types
@{
Operations file header for storing history file in partfile
Surface Type
Trimmed Surface
Offset Surface
Plane
Fillet
Draft Surface
Revolved Surface
Loft Surface
NURBS Surface
piecewise polynomial surface
@defgroup surface_types Surface Types
@{
composite curve
Curve ON Surface
NURBS pointer type
@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
@defgroup curve_types Curve Types
@{
Parametric spline
@}
Attribute structure
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.
Defines an alias representing a 2D transform object.
Defines an alias representing a 2D float or double vector.
Defines an alias representing a 3D float or double vector.
Defines an alias representing a 4D float or double vector.
Defines an alias representing a 2x2 float or double matrix.
Defines an alias representing a 3x3 float or double matrix.
Defines an alias representing a 4x4 float or double matrix.
Defines an alias representing a 3D transform object.
Defines an alias representing a 4D float vector.
Defines an alias representing a 3D float vector.
Defines an alias representing a 2D float vector.
Defines an alias representing a 4x4 double matrix.
Defines an alias representing a 3x3 double matrix.
Defines an alias representing a 2x2 double matrix.
Defines an alias representing a 4D double vector.
Defines an alias representing a 3D double vector.
Defines an alias representing a 2D double vector.
@}
@defgroup math_varuables math variables
*
* initialized in this module
@{
System Tolerance
Write formatted (CString::FormatMessage style) data to a CString.
String resource identifier that contains the format-control string.
The formatted string.
Write formatted (printf style) data to a CString.
String resource identifier that contains the format-control string.
The formatted string.
A pointer to an ID2D1BitmapRenderTarget object.
Retrieves the bitmap for this render target. The returned bitmap can be used for drawing operations.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
When this method returns, contains the valid bitmap for this render target. This bitmap can be used for drawing operations.
Returns ID2D1BitmapRenderTarget interface
Pointer to an ID2D1BitmapRenderTarget interface or NULL if object is not initialized yet.
Returns ID2D1BitmapRenderTarget interface
Pointer to an ID2D1BitmapRenderTarget interface or NULL if object is not initialized yet.
Detaches render target interface from the object
Pointer to detached render target interface.
Attaches existing render target interface to the object
Existing render target interface. Cannot be NULL
Constructs a CBitmapRenderTarget object.
A pointer to an ID2D1DCRenderTarget object.
Returns ID2D1DCRenderTarget interface
Pointer to an ID2D1DCRenderTarget interface or NULL if object is not initialized yet.
Returns ID2D1DCRenderTarget interface
Pointer to an ID2D1DCRenderTarget interface or NULL if object is not initialized yet.
Binds the render target to the device context to which it issues drawing commands
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The device context to which the render target issues drawing commands
The dimensions of the handle to a device context (HDC) to which the render target is bound
Creates a CDCRenderTarget.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The rendering mode, pixel format, remoting options, DPI information, and the minimum DirectX support required for hardware rendering.
Detaches render target interface from the object
Pointer to detached render target interface.
Attaches existing render target interface to the object
Existing render target interface. Cannot be NULL
Constructs a CDCRenderTarget object.
ID2D1DCRenderTarget wrapper.
A pointer to an ID2D1HwndRenderTarget object.
Changes the size of the render target to the specified pixel size
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The new size of the render target in device pixels
Indicates whether the HWND associated with this render target is occluded.
A value that indicates whether the HWND associated with this render target is occluded.
Returns the HWND associated with this render target.
The HWND associated with this render target.
Returns ID2D1HwndRenderTarget interface.
Pointer to an ID2D1HwndRenderTarget interface or NULL if object is not initialized yet.
Returns ID2D1HwndRenderTarget interface.
Pointer to an ID2D1HwndRenderTarget interface or NULL if object is not initialized yet.
Re-creates a render target associated with the window
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The HWND associated with this render target
Creates a render target associated with the window
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE
The HWND associated with this render target
Detaches render target interface from the object
Pointer to detached render target interface.
Attaches existing render target interface to the object
Existing render target interface. Cannot be NULL
Constructs a CHwndRenderTarget object from HWND.
The HWND associated with this render target
ID2D1HwndRenderTarget wrapper.
A pointer to CD2DTextFormat object that contains a default text format.
A list of pointers to CD2DResource objects.
A pointer to an ID2D1RenderTarget object.
Verifies CD2DResource object validity; creates the object if it didn't already exist.
Pointer to CD2DResource object.
TRUE is object if valid; otherwise FALSE.
Removes the last axis-aligned clip from the render target. After this method is called, the clip is no longer applied to subsequent drawing operations.
Removes the last axis-aligned clip from the render target. After this method is called, the clip is no longer applied to subsequent drawing operations.
The size and position of the clipping area, in device-independent pixels.
The antialiasing mode that is used to draw the edges of clip rects that have subpixel boundaries, and to blend the clip with the scene contents. The blending is performed once when the PopAxisAlignedClip method is called, and does not apply to each primitive within the layer.
Sets the render target's drawing state to that of the specified ID2D1DrawingStateBlock.
The new drawing state of the render target.
Saves the current drawing state to the specified ID2D1DrawingStateBlock.
When this method returns, contains the current drawing state of the render target. This parameter must be initialized before passing it to the method.
Executes all pending drawing commands.
Contains the tag for drawing operations that caused errors or 0 if there were no errors. This parameter is passed uninitialized.
Contains the tag for drawing operations that caused errors or 0 if there were no errors. This parameter is passed uninitialized.
Stops redirecting drawing operations to the layer that is specified by the last PushLayer call.
Adds the specified layer to the render target so that it receives all subsequent drawing operations until PopLayer is called.
The content bounds, geometric mask, opacity, opacity mask, and antialiasing options for the layer.
The layer that receives subsequent drawing operations.
Creates a new bitmap render target for use during intermediate offscreen drawing that is compatible with the current render target .
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
When this method returns, contains the address of a pointer to a new bitmap render target. This parameter is passed uninitialized.
The desired size of the new render target in device-independent pixels if it should be different from the original render target, or NULL. For more information, see the Remarks section.
The desired size of the new render target in pixels if it should be different from the original render target, or NULL. For more information, see the Remarks section.
The desired pixel format and alpha mode of the new render target, or NULL. If the pixel format is set to DXGI_FORMAT_UNKNOWN or if this parameter is null, the new render target uses the same pixel format as the original render target. If the alpha mode is D2D1_ALPHA_MODE_UNKNOWN or this parameter is NULL, the alpha mode of the new render target defaults to D2D1_ALPHA_MODE_PREMULTIPLIED. For information about supported pixel formats, see Supported Pixel Formats and Alpha Modes.
A value that specifies whether the new render target must be compatible with GDI.
Applies the specified transform to the render target, replacing the existing transformation. All subsequent drawing operations occur in the transformed space.
The transform to apply to the render target.
Applies the specified transform to the render target, replacing the existing transformation. All subsequent drawing operations occur in the transformed space.
The transform to apply to the render target.
Applies the specified transform to the render target, replacing the existing transformation. All subsequent drawing operations occur in the transformed space.
The transform to apply to the render target.
Retrieves the render target's current text rendering options.
When this method returns, textRenderingParamscontains the address of a pointer to the render target's current text rendering options.
Specifies text rendering options to be applied to all subsequent text and glyph drawing operations.
The text rendering options to be applied to all subsequent text and glyph drawing operations; NULL to clear current text rendering options.
Gets the current antialiasing mode for text and glyph drawing operations.
Current antialiasing mode for text and glyph drawing operations.
Specifies the antialiasing mode to use for subsequent text and glyph drawing operations.
The antialiasing mode to use for subsequent text and glyph drawing operations.
Retrieves the current antialiasing mode for nontext drawing operations.
Current antialiasing mode for nontext drawing operations.
Sets the antialiasing mode of the render target. The antialiasing mode applies to all subsequent drawing operations, excluding text and glyph drawing operations.
The antialiasing mode for future drawing operations.
Paints the interior of the specified mesh.
The mesh to paint.
The brush used to paint the mesh.
Draws the specified glyphs.
The origin, in device-independent pixels, of the glyphs' baseline.
The glyphs to render.
The brush used to paint the specified glyphs.
A value that indicates how glyph metrics are used to measure text when it is formatted. The default value is DWRITE_MEASURING_MODE_NATURAL.
Paints the interior of the specified geometry.
The geometry to paint.
The brush used to paint the geometry's interior.
The opacity mask to apply to the geometry;NULL for no opacity mask. If an opacity mask (the opacityBrush parameter) is specified, brush must be an ID2D1BitmapBrush that has its x- and y-extend modes set to D2D1_EXTEND_MODE_CLAMP. For more information, see the Remarks section.
Draws the outline of the specified geometry using the specified stroke style.
The geometry to draw.
The brush used to paint the geometry's stroke.
The thickness of the geometry's stroke. The stroke is centered on the geometry's outline.
The style of stroke to apply to the geometry's outline, or NULL to paint a solid stroke.
Draws the formatted text described by the specified IDWriteTextLayout object.
The bitmap to render.
The size and position, in device-independent pixels in the render target's coordinate space, of the area to which the bitmap is drawn. If the rectangle is not well-ordered, nothing is drawn, but the render target does not enter an error state.
A value between 0.0f and 1.0f, inclusive, that specifies an opacity value to apply to the bitmap; this value is multiplied against the alpha values of the bitmap's contents.
The interpolation mode to use if the bitmap is scaled or rotated by the drawing operation.
The size and position, in device-independent pixels in the bitmap's coordinate space, of the area within the bitmap to draw.
Draws the formatted text described by the specified IDWriteTextLayout object.
The point, described in device-independent pixels, at which the upper-left corner of the text described by textLayout is drawn.
The formatted text to draw. Any drawing effects that do not inherit from ID2D1Resource are ignored. If there are drawing effects that inherit from ID2D1Resource that are not brushes, this method fails and the render target is put in an error state.
The brush used to paint any text in textLayout that does not already have a brush associated with it as a drawing effect (specified by the IDWriteTextLayout::SetDrawingEffect method).
A value that indicates whether the text should be snapped to pixel boundaries and whether the text should be clipped to the layout rectangle. The default value is D2D1_DRAW_TEXT_OPTIONS_NONE, which indicates that text should be snapped to pixel boundaries and it should not be clipped to the layout rectangle.
Draws the specified text using the format information provided by an IDWriteTextFormat object.
A pointer to an array of Unicode characters to draw.
The size and position of the area in which the text is drawn.
The brush used to paint the text.
An object that describes formatting details of the text to draw, such as the font, the font size, and flow direction.
A value that indicates whether the text should be snapped to pixel boundaries and whether the text should be clipped to the layout rectangle. The default value is D2D1_DRAW_TEXT_OPTIONS_NONE, which indicates that text should be snapped to pixel boundaries and it should not be clipped to the layout rectangle.
A value that indicates how glyph metrics are used to measure text when it is formatted. The default value is DWRITE_MEASURING_MODE_NATURAL.
Applies the opacity mask described by the specified bitmap to a brush and uses that brush to paint a region of the render target.
The position and radius, in device-independent pixels, of the ellipse to paint.
The brush used to paint the region of the render target specified by destinationRectangle.
The type of content the opacity mask contains. The value is used to determine the color space in which the opacity mask is blended.
The region of the render target to paint, in device-independent pixels.
The region of the bitmap to use as the opacity mask, in device-independent pixels.
Draws a line between the specified points using the specified stroke style.
The start point of the line, in device-independent pixels.
The end point of the line, in device-independent pixels.
The brush used to paint the line's stroke.
A value greater than or equal to 0.0f that specifies the width of the stroke. If this parameter isn't specified, it defaults to 1.0f. The stroke is centered on the line.
The style of stroke to paint, or NULL to paint a solid line.
Paints the interior of the specified ellipse.
The position and radius, in device-independent pixels, of the ellipse to paint.
The brush used to paint the interior of the ellipse.
Draws the outline of the specified ellipse using the specified stroke style.
The position and radius of the ellipse to draw, in device-independent pixels.
The brush used to paint the ellipse's outline.
The thickness of the ellipse's stroke. The stroke is centered on the ellipse's outline.
The style of stroke to apply to the ellipse's outline, or NULL to paint a solid stroke.
Paints the interior of the specified rounded rectangle.
The dimensions of the rounded rectangle to paint, in device independent pixels.
The brush used to paint the interior of the rounded rectangle.
Draws the outline of the specified rounded rectangle using the specified stroke style.
The dimensions of the rounded rectangle to draw, in device-independent pixels.
The brush used to paint the rounded rectangle's outline.
The width of the rounded rectangle's stroke. The stroke is centered on the rounded rectangle's outline. The default value is 1.0f.
The style of the rounded rectangle's stroke, or NULL to paint a solid stroke. The default value is NULL.
Paints the interior of the specified rectangle.
The dimension of the rectangle to paint, in device-independent pixels.
The brush used to paint the rectangle's interior.
Draws the outline of a rectangle that has the specified dimensions and stroke style.
The dimensions of the rectangle to draw, in device-independent pixels
The brush used to paint the rectangle's stroke
A value greater than or equal to 0.0f that specifies the width of the rectangle's stroke. The stroke is centered on the rectangle's outline.
The style of stroke to paint, or NULL to paint a solid stroke.
Clears the drawing area to the specified color.
The color to which the drawing area is cleared.
Converts GDI color and alpha values to the D2D1_COLOR_F object.
RGB value.
Alpha value.
D2D1_COLOR_F value.
Ends drawing operations on the render target and indicates the current error state and associated tags.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Initiates drawing on this render target.
Detaches render target interface from the object
Pointer to detached render target interface.
Attaches existing render target interface to the object
Existing render target interface. Cannot be NULL
Gets the maximum size, in device-dependent units (pixels), of any one bitmap dimension supported by the render target
The maximum size, in pixels, of any one bitmap dimension supported by the render target
Indicates whether the render target supports the specified properties
TRUE if the specified render target properties are supported by this render target; otherwise, FALSE
The render target properties to test
Specifies a label for subsequent drawing operations.
A label to apply to subsequent drawing operations.
A label to apply to subsequent drawing operations.
Gets the label for subsequent drawing operations.
Contains the first label for subsequent drawing operations. This parameter is passed uninitialized. If NULL is specified, no value is retrieved for this parameter.
Contains the second label for subsequent drawing operations. This parameter is passed uninitialized. If NULL is specified, no value is retrieved for this parameter.
Returns the size of the render target in device pixels
The size of the render target in device pixels
Retrieves the pixel format and alpha mode of the render target
The pixel format and alpha mode of the render target
Returns the render target's dots per inch (DPI)
The render target's dots per inch (DPI).
Sets the dots per inch (DPI) of the render target.
A value greater than or equal to zero that specifies the horizontal/verticalDPI of the render target.
Returns the size of the render target in device-independent pixels
The current size of the render target in device-independent pixels
Returns ID2D1RenderTarget interface
Pointer to an ID2D1RenderTarget interface or NULL if object is not initialized yet.
Returns ID2D1RenderTarget interface
Pointer to an ID2D1RenderTarget interface or NULL if object is not initialized yet.
Checks resource validity
TRUE if resource is valid; otherwise FALSE.
Deletes one or more resources
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE
If bDeleteResources is TRUE, all resources located in m_lstResources will be automatically destroyed.
The destructor. Called when a render target object is being destroyed.
Constructs a CRenderTarget object.
ID2D1RenderTarget wrapper.
A pointer to an ID2D1Mesh.
Checks resource validity
TRUE if resource is valid; otherwise FALSE.
Destroys a CD2DMesh object.
Creates a CD2DMesh.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
Opens the mesh for population.
A pointer to an ID2D1TessellationSink that is used to populate the mesh.
Returns ID2D1Mesh interface
Pointer to an ID2D1Mesh interface or NULL if object is not initialized yet.
Returns ID2D1Mesh interface
Pointer to an ID2D1Mesh interface or NULL if object is not initialized yet.
Detaches resource interface from the object
Pointer to detached resource interface.
Attaches existing resource interface to the object
Existing resource interface. Cannot be NULL
The destructor. Called when a D2D mesh object is being destroyed.
Constructs a CD2DMesh object.
A pointer to the render target.
Indicates that the object will be destroyed by owner (pParentTarget).
ID2D1Mesh wrapper.
A pointer to an ID2D1GeometrySink.
Specifies stroke and join options to be applied to new segments added to the geometry sink.
Stroke and join options to be applied to new segments added to the geometry sink.
Specifies the method used to determine which points are inside the geometry described by this geometry sink and which points are outside.
The method used to determine whether a given point is part of the geometry.
Closes the geometry sink
Nonzero if successful; otherwise FALSE.
Creates a sequence of lines using the specified points and adds them to the geometry sink.
An array of one or more points that describe the lines to draw. A line is drawn from the geometry sink's current point (the end point of the last segment drawn or the location specified by BeginFigure) to the first point in the array. if the array contains additional points, a line is drawn from the first point to the second point in the array, from the second point to the third point, and so on. An array of a sequence of the end points of the lines to draw.
Creates a line segment between the current point and the specified end point and adds it to the geometry sink.
The end point of the line to draw.
Adds a sequence of quadratic Bezier segments as an array in a single call.
An array of a sequence of quadratic Bezier segments.
Creates a quadratic Bezier curve between the current point and the specified end point.
A structure that describes the control point and the end point of the quadratic Bezier curve to add.
Creates a sequence of cubic Bezier curves and adds them to the geometry sink.
An array of Bezier segments that describes the Bezier curves to create. A curve is drawn from the geometry sink's current point (the end point of the last segment drawn or the location specified by BeginFigure) to the end point of the first Bezier segment in the array. if the array contains additional Bezier segments, each subsequent Bezier segment uses the end point of the preceding Bezier segment as its start point.
Creates a cubic Bezier curve between the current point and the specified end point.
A structure that describes the control points and end point of the Bezier curve to add.
Adds a single arc to the path geometry
The arc segment to add to the figure
Ends the current figure; optionally, closes it.
A value that indicates whether the current figure is closed. If the figure is closed, a line is drawn between the current point and the start point specified by BeginFigure.
Starts a new figure at the specified point.
The point at which to begin the new figure.
Whether the new figure should be hollow or filled.
Returns ID2D1GeometrySink interface
Pointer to an ID2D1GeometrySink interface or NULL if object is not initialized yet.
Returns ID2D1GeometrySink interface
Pointer to an ID2D1GeometrySink interface or NULL if object is not initialized yet.
Checks geometry sink validity
TRUE if geometry sink is valid; otherwise FALSE.
The destructor. Called when a D2D geometry sink object is being destroyed.
Constructs a CD2DGeometrySink object from CD2DPathGeometry object.
An existing CD2DPathGeometry object.
ID2D1GeometrySink wrapper.
A pointer to an ID2D1PathGeometry.
Retrieves tthe number of figures in the path geometry.
Returns the number of figures in the path geometry.
Retrieves the number of segments in the path geometry.
Returns the number of segments in the path geometry.
Copies the contents of the path geometry to the specified ID2D1GeometrySink.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The sink to which the path geometry's contents are copied. Modifying this sink does not change the contents of this path geometry.
Retrieves the geometry sink that is used to populate the path geometry with figures and segments.
A pointer to the ID2D1GeometrySink that is used to populate the path geometry with figures and segments.
Detaches resource interface from the object
Pointer to detached resource interface.
Attaches existing resource interface to the object
Existing resource interface. Cannot be NULL
Destroys a CD2DPathGeometry object.
Creates a CD2DPathGeometry.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
Constructs a CD2DPathGeometry object.
A pointer to the render target.
Indicates that the object will be destroyed by owner (pParentTarget).
ID2D1PathGeometry wrapper.
A pointer to an ID2D1Geometry.
Widens the geometry by the specified stroke and writes the result to an ID2D1SimplifiedGeometrySink after it has been transformed by the specified matrix and flattened using the specified tolerance.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The amount by which to widen the geometry.
The style of stroke to apply to the geometry, or NULL.
The transform to apply to the geometry after widening it.
The ID2D1SimplifiedGeometrySink to which the widened geometry is appended.
The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.
Creates a set of clockwise-wound triangles that cover the geometry after it has been transformed using the specified matrix and flattened using the specified tolerance.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The transform to apply to this geometry, or NULL.
The ID2D1TessellationSink to which the tessellated is appended.
The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.
Creates a simplified version of the geometry that contains only lines and (optionally) cubic Bezier curves and writes the result to an ID2D1SimplifiedGeometrySink.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
A value that specifies whether the simplified geometry should contain curves.
The transform to apply to the simplified geometry.
The ID2D1SimplifiedGeometrySink to which the simplified geometry is appended.
The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.
Computes the outline of the geometry and writes the result to an ID2D1SimplifiedGeometrySink.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The transform to apply to the geometry outline.
The ID2D1SimplifiedGeometrySink to which the geometry transformed outline is appended.
The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.
Determines whether the geometry's stroke contains the specified point given the specified stroke thickness, style, and transform.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The point to test for containment.
The thickness of the stroke to apply.
The style of the stroke to apply.
The transform to apply to the stroked geometry.
When this method returns, contains a boolean value set to TRUE if the geometry's stroke contains the specified point; otherwise, FALSE. You must allocate storage for this parameter.
The numeric accuracy with which the precise geometric path and path intersection is calculated. Points missing the stroke by less than the tolerance are still considered inside. Smaller values produce more accurate results but cause slower execution.
Indicates whether the area filled by the geometry would contain the specified point given the specified flattening tolerance.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The point to test.
The transform to apply to the geometry prior to testing for containment.
When this method returns, contains a bool value that is TRUE if the area filled by the geometry contains point; otherwise, FALSE. You must allocate storage for this parameter.
The numeric accuracy with which the precise geometric path and path intersection is calculated. Points missing the fill by less than the tolerance are still considered inside. Smaller values produce more accurate results but cause slower execution.
Gets the bounds of the geometry after it has been widened by the specified stroke width and style and transformed by the specified matrix.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The amount by which to widen the geometry by stroking its outline.
The style of the stroke that widens the geometry.
A transform to apply to the geometry after the geometry is transformed and after the geometry has been stroked.
When this method returns, contains the bounds of the widened geometry. You must allocate storage for this parameter.
The maximum bounds on the distance between points in the polygonal approximation of the geometries. Smaller values produce more accurate results but cause slower execution.
Retrieves the bounds of the geometry.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The transform to apply to this geometry before calculating its bounds.
When this method returns, contains the bounds of this geometry. If the bounds are empty, this will be a rect where bounds.left is greater than bounds.right. You must allocate storage for this parameter.
Calculates the point and tangent vector at the specified distance along the geometry after it has been transformed by the specified matrix and flattened using the specified tolerance.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The distance along the geometry of the point and tangent to find. If this distance is less then 0, this method calculates the first point in the geometry. If this distance is greater than the length of the geometry, this method calculates the last point in the geometry.
The transform to apply to the geometry before calculating the specified point and tangent.
The location at the specified distance along the geometry. If the geometry is empty, this point contains NaN as its x and y values.
When this method returns, contains a pointer to the tangent vector at the specified distance along the geometry. If the geometry is empty, this vector contains NaN as its x and y values. You must allocate storage for this parameter.
The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.
Calculates the length of the geometry as though each segment were unrolled into a line.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The transform to apply to the geometry before calculating its length.
When this method returns, contains a pointer to the length of the geometry. For closed geometries, the length includes an implicit closing segment. You must allocate storage for this parameter.
The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.
Computes the area of the geometry after it has been transformed by the specified matrix and flattened using the specified tolerance.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The transform to apply to this geometry before computing its area.
When this method returns, contains a pointer to the area of the transformed, flattened version of this geometry. You must allocate storage for this parameter.
The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.
Describes the intersection between this geometry and the specified geometry. The comparison is performed using the specified flattening tolerance.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The geometry to test.
The transform to apply to inputGeometry.
The maximum bounds on the distance between points in the polygonal approximation of the geometries. Smaller values produce more accurate results but cause slower execution.
Combines this geometry with the specified geometry and stores the result in an ID2D1SimplifiedGeometrySink.
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE.
The geometry to combine with this instance.
The type of combine operation to perform.
The transform to apply to inputGeometry before combining.
The result of the combine operation.
The maximum bounds on the distance between points in the polygonal approximation of the geometries. Smaller values produce more accurate results but cause slower execution.
Checks resource validity
TRUE if resource is valid; otherwise FALSE.
Destroys a CD2DGeometry object.
Returns ID2D1Geometry interface
Pointer to an ID2D1Geometry interface or NULL if object is not initialized yet.
Returns ID2D1Geometry interface
Pointer to an ID2D1Geometry interface or NULL if object is not initialized yet.
Detaches resource interface from the object
Pointer to detached resource interface.
Attaches existing resource interface to the object
Existing resource interface. Cannot be NULL
The destructor. Called when a D2D geometry object is being destroyed.
Constructs a CD2DGeometry object.
A pointer to the render target.
Indicates that the object will be destroyed by owner (pParentTarget).
ID2D1Geometry wrapper.
A pointer to an IDWriteTextLayout.
Gets the locale name of the text at the specified position.
CString object that contains the current locale name.
The position of the text to inspect.
The range of text that has the same formatting as the text at the position specified by currentPosition. This means the run has the exact formatting as the position specified, including but not limited to the locale name.
Copies the font family name of the text at the specified position.
CString object that contains the current font family name.
The position of the text to examine.
The range of text that has the same formatting as the text at the position specified by currentPosition. This means the run has the exact formatting as the position specified, including but not limited to the font family name.
Sets the locale name for text within a specified text range
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE
A null-terminated locale name string
Text range to which this change applies
Sets null-terminated font family name for text within a specified text range
If the method succeeds, it returns TRUE. Otherwise, it returns FALSE
The font family name that applies to the entire text string within the range specified by textRange
Text range to which this change applies
Returns IDWriteTextLayout interface
Pointer to an IDWriteTextLayout interface or NULL if object is not initialized yet.
Returns IDWriteTextLayout interface
Pointer to an IDWriteTextLayout interface or NULL if object is not initialized yet.
Checks resource validity
TRUE if resource is valid; otherwise FALSE.
Destroys a CD2DTextLayout object.
Creates a CD2DTextLayout.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
Re-creates a CD2DTextLayout.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
The destructor. Called when a D2D text layout object is being destroyed.
Constructs a CD2DTextLayout object.
A pointer to the render target.
A CString object that contains the string to create a new CD2DTextLayout object from.
A CString object that contains the format to apply to the string.
The size of the layout box.
Indicates that the object will be destroyed by owner (pParentTarget).
IDWriteTextLayout wrapper.
A pointer to an IDWriteTextFormat.
Gets a copy of the locale name.
CString object that contains the current locale name.
Gets a copy of the font family name.
CString object that contains the current font family name.
Returns IDWriteTextFormat interface
Pointer to an IDWriteTextFormat interface or NULL if object is not initialized yet.
Returns IDWriteTextFormat interface
Pointer to an IDWriteTextFormat interface or NULL if object is not initialized yet.
Checks resource validity
TRUE if resource is valid; otherwise FALSE.
Destroys a CD2DTextFormat object.
Creates a CD2DTextFormat.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
Re-creates a CD2DTextFormat.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
The destructor. Called when a D2D text format object is being destroyed.
Constructs a CD2DTextFormat object.
A pointer to the render target.
A CString object that contains the name of the font family.
The logical size of the font in DIP ("device-independent pixel") units. A DIPequals 1/96 inch.
A value that indicates the font weight for the text object.
A value that indicates the font style for the text object.
A value that indicates the font stretch for the text object.
A CString object that contains the locale name.
A pointer to a font collection object. When this is NULL, indicates the system font collection.
Indicates that the object will be destroyed by owner (pParentTarget).
IDWriteTextFormat wrapper.
A pointer to an ID2D1RadialGradientBrush.
The center, gradient origin offset, and x-radius and y-radius of the brush's gradient.
Retrieves the y-radius of the gradient ellipse
The y-radius of the gradient ellipse. This value is expressed in the brush's coordinate space
Retrieves the x-radius of the gradient ellipse
The x-radius of the gradient ellipse. This value is expressed in the brush's coordinate space
Retrieves the offset of the gradient origin relative to the gradient ellipse's center
The offset of the gradient origin from the center of the gradient ellipse. This value is expressed in the brush's coordinate space
Retrieves the center of the gradient ellipse
The center of the gradient ellipse. This value is expressed in the brush's coordinate space
Specifies the y-radius of the gradient ellipse, in the brush's coordinate space
The y-radius of the gradient ellipse. This value is in the brush's coordinate space
Specifies the x-radius of the gradient ellipse, in the brush's coordinate space
The x-radius of the gradient ellipse. This value is in the brush's coordinate space
Specifies the offset of the gradient origin relative to the gradient ellipse's center
The offset of the gradient origin from the center of the gradient ellipse
Specifies the center of the gradient ellipse in the brush's coordinate space
The center of the gradient ellipse, in the brush's coordinate space
Returns ID2D1RadialGradientBrush interface
Pointer to an ID2D1RadialGradientBrush interface or NULL if object is not initialized yet.
Returns ID2D1RadialGradientBrush interface
Pointer to an ID2D1RadialGradientBrush interface or NULL if object is not initialized yet.
Detaches resource interface from the object
Pointer to detached resource interface.
Attaches existing resource interface to the object
Existing resource interface. Cannot be NULL
Destroys a CD2DRadialGradientBrush object.
Creates a CD2DRadialGradientBrush.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
The destructor. Called when a D2D radial gradient brush object is being destroyed.
Constructs a CD2DLinearGradientBrush object.
A pointer to the render target.
A pointer to an array of D2D1_GRADIENT_STOP structures.
A value greater than or equal to 1 that specifies the number of gradient stops in the gradientStops array.
The center, gradient origin offset, and x-radius and y-radius of the brush's gradient.
The space in which color interpolation between the gradient stops is performed.
The behavior of the gradient outside the [0,1] normalized range.
A pointer to the opacity and transformation of a brush.
Indicates that the object will be destroyed by owner (pParentTarget).
ID2D1RadialGradientBrush wrapper.
A pointer to an ID2D1LinearGradientBrush.
The start and end points of the gradient.
Retrieves the ending coordinates of the linear gradient
The ending two-dimensional coordinates of the linear gradient, in the brush's coordinate space
Retrieves the starting coordinates of the linear gradient
The starting two-dimensional coordinates of the linear gradient, in the brush's coordinate space
Sets the ending coordinates of the linear gradient in the brush's coordinate space
The ending two-dimensional coordinates of the linear gradient, in the brush's coordinate space
Sets the starting coordinates of the linear gradient in the brush's coordinate space
The starting two-dimensional coordinates of the linear gradient, in the brush's coordinate space
Returns ID2D1LinearGradientBrush interface
Pointer to an ID2D1LinearGradientBrush interface or NULL if object is not initialized yet.
Returns ID2D1LinearGradientBrush interface
Pointer to an ID2D1LinearGradientBrush interface or NULL if object is not initialized yet.
Detaches resource interface from the object
Pointer to detached resource interface.
Attaches existing resource interface to the object
Existing resource interface. Cannot be NULL
Destroys a CD2DLinearGradientBrush object.
Creates a CD2DLinearGradientBrush.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
The destructor. Called when a D2D linear gradient brush object is being destroyed.
Constructs a CD2DLinearGradientBrush object.
A pointer to the render target.
A pointer to an array of D2D1_GRADIENT_STOP structures.
A value greater than or equal to 1 that specifies the number of gradient stops in the gradientStops array.
The start and end points of the gradient.
The space in which color interpolation between the gradient stops is performed.
The behavior of the gradient outside the [0,1] normalized range.
A pointer to the opacity and transformation of a brush.
Indicates that the object will be destroyed by owner (pParentTarget).
ID2D1LinearGradientBrush wrapper.
A pointer to an array of D2D1_GRADIENT_STOP structures.
The behavior of the gradient outside the [0,1] normalized range.
The space in which color interpolation between the gradient stops is performed.
Array of the D2D1_GRADIENT_STOP structures.
Destroys a CD2DGradientBrush object.
The destructor. Called when a D2D gradient brush object is being destroyed.
Constructs a CD2DGradientBrush object.
A pointer to the render target.
A pointer to an array of D2D1_GRADIENT_STOP structures.
A value greater than or equal to 1 that specifies the number of gradient stops in the gradientStops array.
The space in which color interpolation between the gradient stops is performed.
The behavior of the gradient outside the [0,1] normalized range.
A pointer to the opacity and transformation of a brush.
Indicates that the object will be destroyed by owner (pParentTarget).
The base class of CD2DLinearGradientBrush and CD2DRadialGradientBrush classes.
Bitmap brush properties.
Stores a pointer to an ID2D1BitmapBrush object.
Stores a pointer to a CD2DBitmap object.
Initializes the object
A pointer to the bitmap brush properties.
Destroys a CD2DBitmapBrush object.
Creates a CD2DBitmapBrush.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
Gets the interpolation method used when the brush bitmap is scaled or rotated
The interpolation method used when the brush bitmap is scaled or rotated
Gets the method by which the brush vertically tiles those areas that extend past its bitmap
A value that specifies how the brush vertically tiles those areas that extend past its bitmap
Gets the method by which the brush horizontally tiles those areas that extend past its bitmap
A value that specifies how the brush horizontally tiles those areas that extend past its bitmap
Specifies the bitmap source that this brush uses to paint
The bitmap source used by the brush
Specifies the interpolation mode used when the brush bitmap is scaled or rotated
The interpolation mode used when the brush bitmap is scaled or rotated
Specifies how the brush vertically tiles those areas that extend past its bitmap
A value that specifies how the brush vertically tiles those areas that extend past its bitmap
Specifies how the brush horizontally tiles those areas that extend past its bitmap
A value that specifies how the brush horizontally tiles those areas that extend past its bitmap
Gets the bitmap source that this brush uses to paint
Pointer to an CD2DBitmap object or NULL if object is not initialized yet.
Returns ID2D1BitmapBrush interface
Pointer to an ID2D1BitmapBrush interface or NULL if object is not initialized yet.
Returns ID2D1BitmapBrush interface
Pointer to an ID2D1BitmapBrush interface or NULL if object is not initialized yet.
Detaches resource interface from the object
Pointer to detached resource interface.
Attaches existing resource interface to the object
Existing resource interface. Cannot be NULL
The destructor. Called when a D2D bitmap brush object is being destroyed.
Constructs a CD2DBitmapBrush object from file.
A pointer to the render target.
Pointer to a null-terminated string that contains the name of file.
Destination size of the bitmap.
A pointer to the extend modes and the interpolation mode of a bitmap brush.
A pointer to the opacity and transformation of a brush.
Indicates that the object will be destroyed by owner (pParentTarget).
Constructs a CD2DBitmapBrush object from resource.
A pointer to the render target.
The resource ID number of the resource.
Pointer to a null-terminated string that contains the resource type.
Destination size of the bitmap.
A pointer to the extend modes and the interpolation mode of a bitmap brush.
A pointer to the opacity and transformation of a brush.
Indicates that the object will be destroyed by owner (pParentTarget).
Constructs a CD2DBitmapBrush object.
A pointer to the render target.
A pointer to the extend modes and the interpolation mode of a bitmap brush.
A pointer to the opacity and transformation of a brush.
Indicates that the object will be destroyed by owner (pParentTarget).
ID2D1BitmapBrush wrapper.
Brush solid color.
Stores a pointer to an ID2D1SolidColorBrush object.
Destroys a CD2DSolidColorBrush object.
Creates a CD2DSolidColorBrush.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
Retrieves the color of the solid color brush
The color of this solid color brush
Specifies the color of this solid color brush
The color of this solid color brush
Returns ID2D1SolidColorBrush interface
Pointer to an ID2D1SolidColorBrush interface or NULL if object is not initialized yet.
Returns ID2D1SolidColorBrush interface
Pointer to an ID2D1SolidColorBrush interface or NULL if object is not initialized yet.
Detaches resource interface from the object
Pointer to detached resource interface.
Attaches existing resource interface to the object
Existing resource interface. Cannot be NULL
The destructor. Called when a D2D solid brush object is being destroyed.
Constructs a CD2DSolidColorBrush object.
A pointer to the render target.
The red, green, and blue values of the brush's color.
The opacity of the brush's color.
A pointer to the opacity and transformation of a brush.
Indicates that the object will be destroyed by owner (pParentTarget).
Constructs a CD2DSolidColorBrush object.
A pointer to the render target.
The red, green, blue, and alpha values of the brush's color.
A pointer to the opacity and transformation of a brush.
Indicates that the object will be destroyed by owner (pParentTarget).
ID2D1SolidColorBrush wrapper.
Brush properties.
Stores a pointer to an ID2D1Brush object.
Gets the current transform of the render target
When this returns, contains the current transform of the render target. This parameter is passed uninitialized
Applies the specified transform to the render target, replacing the existing transformation. All subsequent drawing operations occur in the transformed space
The transform to apply to the render target
Gets the degree of opacity of this brush
A value between zero and 1 that indicates the opacity of the brush. This value is a constant multiplier that linearly scales the alpha value of all pixels filled by the brush. The opacity values are clamped in the range 0 to 1 before they are multiplied together
Sets the degree of opacity of this brush
A value between zero and 1 that indicates the opacity of the brush. This value is a constant multiplier that linearly scales the alpha value of all pixels filled by the brush. The opacity values are clamped in the range 0 to 1 before they are multiplied together
Destroys a CD2DBrush object.
Returns ID2D1Brush interface
Pointer to an ID2D1Brush interface or NULL if object is not initialized yet.
Returns ID2D1Brush interface
Pointer to an ID2D1Brush interface or NULL if object is not initialized yet.
Checks resource validity
TRUE if resource is valid; otherwise FALSE.
Detaches resource interface from the object
Pointer to detached resource interface.
Attaches existing resource interface to the object
Existing resource interface. Cannot be NULL
The destructor. Called when a D2D brush object is being destroyed.
Constructs a CD2DBrush object.
A pointer to the render target.
A pointer to the opacity and transformation of a brush.
Indicates that the object will be destroyed by owner (pParentTarget).
ID2D1Brush wrapper.
Initializes the object
Creates a CD2D_BRUSH_PROPERTIES structure
The transformation to apply to the brush
The base opacity of the brush. The default value is 1.0.
Creates a CD2D_BRUSH_PROPERTIES structure
The base opacity of the brush. The default value is 1.0.
Creates a CD2D_BRUSH_PROPERTIES structure
D2D1_BRUSH_PROPERTIES wrapper.
TRUE if m_hBmpSrc should be destroyed; otherwise FALSE.
Source bitmap handle.
Bitmap destination size.
Botmap file path.
Resource type.
Bitmap resource ID.
Stores a pointer to an ID2D1Bitmap object.
Destroys a CD2DBitmap object.
Creates a CD2DBitmap.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
Initializes the object
Returns ID2D1Bitmap interface
Pointer to an ID2D1Bitmap interface or NULL if object is not initialized yet.
Returns ID2D1Bitmap interface
Pointer to an ID2D1Bitmap interface or NULL if object is not initialized yet.
Checks resource validity
TRUE if resource is valid; otherwise FALSE.
Copies the specified region from memory into the current bitmap
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
The data to copy
The stride, or pitch, of the source bitmap stored in srcData. The stride is the byte count of a scanline (one row of pixels in memory). The stride can be computed from the following formula: pixel width * bytes per pixel + memory padding
In the current bitmap, the upper-left corner of the area to which the region specified by srcRect is copied
Copies the specified region from the specified render target into the current bitmap
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
The render target that contains the region to copy
In the current bitmap, the upper-left corner of the area to which the region specified by srcRect is copied
The area of renderTarget to copy
Copies the specified region from the specified bitmap into the current bitmap
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
The bitmap to copy from
In the current bitmap, the upper-left corner of the area to which the region specified by srcRect is copied
The area of bitmap to copy
Return the dots per inch (DPI) of the bitmap
The horizontal and vertical DPI of the bitmap.
Retrieves the pixel format and alpha mode of the bitmap
The pixel format and alpha mode of the bitmap.
Returns the size, in device-dependent units (pixels), of the bitmap
The size, in pixels, of the bitmap..
Returns the size, in device-independent pixels (DIPs), of the bitmap
The size, in DIPs, of the bitmap.
Detaches resource interface from the object
Pointer to detached resource interface.
Attaches existing resource interface to the object
Existing resource interface. Cannot be NULL
The destructor. Called when a D2D bitmap object is being destroyed.
Constructs a CD2DBitmap object.
A pointer to the render target.
Indicates that the object will be destroyed by owner (pParentTarget).
Constructs a CD2DBitmap object from HBITMAP.
A pointer to the render target.
Handle to the bitmap.
Destination size of the bitmap.
Indicates that the object will be destroyed by owner (pParentTarget).
Constructs a CD2DBitmap object from file.
A pointer to the render target.
Pointer to a null-terminated string that contains the name of file.
Destination size of the bitmap.
Indicates that the object will be destroyed by owner (pParentTarget).
Constructs a CD2DBitmap object from resource.
A pointer to the render target.
The resource ID number of the resource.
Pointer to a null-terminated string that contains the resource type.
Destination size of the bitmap.
Indicates that the object will be destroyed by owner (pParentTarget).
ID2D1Bitmap wrapper.
Stores a pointer to an ID2D1Layer object.
Destroys a CD2DLayer object.
Creates a CD2DLayer.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
Detaches resource interface from the object
Pointer to detached resource interface.
Attaches existing resource interface to the object
Existing resource interface. Cannot be NULL
Returns ID2D1Layer interface
Pointer to an ID2D1Layer interface or NULL if object is not initialized yet.
Returns ID2D1Layer interface
Pointer to an ID2D1Layer interface or NULL if object is not initialized yet.
Checks resource validity
TRUE if resource is valid; otherwise FALSE.
Returns the size of the render target in device-independent pixels
The current size of the render target in device-independent pixels
The destructor. Called when a D2D layer object is being destroyed.
Constructs a CD2DLayer object.
A pointer to the render target.
Indicates that the object will be destroyed by owner (pParentTarget).
ID2D1Layer wrapper.
Pointer to the parent CRenderTarget)
Resource will be destoyed by owner (CRenderTarget)
Checks resource validity
TRUE if resource is valid; otherwise FALSE.
Destroys a CD2DResource object.
Creates a CD2DResource.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
Re-creates a CD2DResource.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to the render target.
Check auto destroy flag.
TRUE if the object will be destroyed by its owner; otherwise FALSE.
The destructor. Called when a D2D resource object is being destroyed.
Constructs a CD2DResource object.
A pointer to the render target.
Indicates that the object will be destroyed by owner (pParentTarget).
An abstract class, which provides a interface for creating and managing D2D resources such as brushes, layers and texts.
Constructs a CD2DEllipse from CD2DPointF and CD2DSizeF objects.
The center point of the ellipse.
The X-radius and Y-radius of the ellipse.
Constructs a CD2DEllipse object from D2D1_ELLIPSE object.
source ellipse
Constructs a CD2DEllipse object from D2D1_ELLIPSE object.
source ellipse
Constructs a CD2DEllipse object from CD2DRectF object.
source rectangle
D2D1_ELLIPSE wrapper
Constructs a CD2DRoundedRect object from D2D1_ROUNDED_RECT object.
source rectangle
Constructs a CD2DRoundedRect object from D2D1_ROUNDED_RECT object.
source rectangle
Constructs a CD2DRoundedRect object from CD2DRectF object.
source rectangle
radius size
D2D1_ROUNDED_RECT wrapper
Converts CD2DRectU to CRect object.
Current value of D2D rectangle.
Returns a Boolean value that indicates whether an expression contains no valid data (Null).
TRUE if rectangle's top, left, bottom, and right values are all equal to 0; otherwise FALSE.
Constructs a CD2DRectU object from four UINT32 values.
source left coordinate
source top coordinate
source right coordinate
source bottom coordinate
Constructs a CD2DRectU object from D2D1_RECT_U object.
source rectangle
Constructs a CD2DRectU object from D2D1_RECT_U object.
source rectangle
Constructs a CD2DRectU object from CRect object.
source rectangle
D2D1_RECT_U wrapper
Converts CD2DRectF to CRect object.
Current value of D2D rectangle.
Returns a Boolean value that indicates whether an expression contains no valid data (Null).
TRUE if rectangle's top, left, bottom, and right values are all equal to 0; otherwise FALSE.
Constructs a CD2DRectF object from four FLOAT values.
source left coordinate
source top coordinate
source right coordinate
source bottom coordinate
Constructs a CD2DRectF object from D2D1_RECT_F object.
source rectangle
Constructs a CD2DRectF object from D2D1_RECT_F object.
source rectangle
Constructs a CD2DRectF object from CRect object.
source rectangle
D2D1_RECT_F wrapper
Converts CD2DSizeU to CSize object.
Current value of D2D size.
Returns a Boolean value that indicates whether an expression contains no valid data (Null).
TRUE if width and height are empty; otherwise FALSE.
Constructs a CD2DSizeU object from two UINT32 values.
source width
source height
Constructs a CD2DSizeU object from D2D1_SIZE_U object.
source size
Constructs a CD2DSizeU object from D2D1_SIZE_U object.
source size
Constructs a CD2DSizeU object from CSize object.
source size
D2D1_SIZE_U wrapper
Converts CD2DSizeF to CSize object.
Current value of D2D size.
Returns a Boolean value that indicates whether an expression contains no valid data (Null).
TRUE if width and height are empty; otherwise FALSE.
Constructs a CD2DSizeF object from two FLOAT values.
source width
source height
Constructs a CD2DSizeF object from D2D1_SIZE_F object.
source size
Constructs a CD2DSizeF object from D2D1_SIZE_F object.
source size
Constructs a CD2DSizeF object from CSize object.
source size
D2D1_SIZE_F wrapper
Converts CD2DPointU to CPoint object.
Current value of D2D point.
Constructs a CD2DPointU object from two UINT32 values.
source X
source Y
Constructs a CD2DPointU from object D2D1_POINT_2U object.
source point
Constructs a CD2DPointU from object D2D1_POINT_2U object.
source point
Constructs a CD2DPointU object from CPoint object.
source point
D2D1_POINT_2U wrapper
Converts CD2DPointF to CPoint object.
Current value of D2D point.
Constructs a CD2DPointF object from two FLOAT values.
source X
source Y
Constructs a CD2DPointF object from D2D1_POINT_2F object.
source point
Constructs a CD2DPointF object from D2D1_POINT_2F object.
source point
Constructs a CD2DPointF object from CPoint object.
source point
D2D1_POINT_2F wrapper
Calls the transition library to create encapsulated transition COM object.
This method also can set initial value and initial velocity to be applied to an animation variable, which is
associated with this transition. For this purpose you have to call SetInitialValue and SetInitialVelocity before
the framework creates the encapsulated transition COM object (it happens when you call CAnimationController::AnimateGroup).
A pointer to transition library, which is responsible for creation of standard transitions.
A pointer to transition factory, which is responsible for creation of custom transitions.
Sets an initial velocity, which will be applied to an animation variable associated with this transition.
Sets an initial value, which will be applied to an animation variable associated with this transition.
Constructs a custom transition object.
A pointer to custom interpolator.
Stores the initial velocity.
Stores the initial value.
Specifies whether the initial velocity was specified with SetInitialVelocity.
Specifies whether the initial value was specified with SetInitialValue.
Stores a pointer to a custom interpolator.
Implements custom transition.
The CCustomTransitions class allows developers to implement custom transitions. It's created and used
as a standard transition, but its constructor accepts as parameter a pointer to a custom interpolator.
Perform the following steps to use custom transitions:
1. Derive a class from CCustomInterpolator and implement at least InterpolateValue method.
2. Ensure that the lifetime of custom interpolator object must be longer than duration of animation where it's used.
3. Instantiate (using operator new) a CCustomTransition object and pass a pointer to custom interpolator in the constructor.
4. Call CCustomTransition::SetInitialValue and CCustomTransition::SetInitialVelocity if these parameters are required for custom interpolation.
5. Pass the pointer to custom transition to AddTransition method of animation object, whose value should be animated with the custom algorithm.
6. When the value of animation object should change Windows Animation API will call InterpolateValue (and other relevant methods) in CCustomInterpolator.
Gets the interpolator's dependencies.
If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not
set, or custom implementation returns FALSE from the GetDependencies method.
Output. Aspects of the interpolator that depend on the initial value passed to SetInitialValueAndVelocity.
Output. Aspects of the interpolator that depend on the initial velocity passed to SetInitialValueAndVelocity.
Output. Aspects of the interpolator that depend on the duration passed to SetDuration.
Interpolates the velocity at a given offset
If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not
set, or custom implementation returns FALSE from the InterpolateVelocity method.
The offset from the start of the transition.
The offset is always greater than or equal to zero and less than or equal to the duration of the transition.
This method is not called if the duration of the transition is zero.
Output. The velocity of the variable at the offset.
Interpolates the value at a given offset
If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not
set, or custom implementation returns FALSE from the InterpolateValue method.
The offset from the start of the transition.
The offset is always greater than or equal to zero and less than the duration of the transition.
This method is not called if the duration of the transition is zero.
Output. The interpolated value.
Gets the final value to which the interpolator leads.
If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not
set, or custom implementation returns FALSE from the GetFinalValue method.
Output. The final value of a variable at the end of the transition.
Gets the interpolator's duration.
If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not
set, or custom implementation returns FALSE from the GetDuration method.
Output. The duration of the transition, in seconds.
Sets the interpolator's duration
If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not
set, or custom implementation returns FALSE from the SetDuration method.
The duration of the transition.
Sets the interpolator's initial value and velocity.
If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not
set, or custom implementation returns FALSE from the SetInitialValueAndVelocity method.
The value of the variable at the start of the transition.
The velocity of the variable at the start of the transition.
Creates an instance of CInterpolatorBase and stores a pointer to custom interpolator, which will be handling events.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to custom interpolator.Output. Contains a pointer to instance of CInterpolatorBase when the function returns.
Stores a pointer to custom interpolator, which will be handling events.
A pointer to custom interpolator.
Constructs the CInterpolatorBase object.
Implements a callback, which is called by Animation API when it needs to calculate a new value of animation variable.
This handler is created and passed to IUIAnimationTransitionFactory::CreateTransition when a CCustomTransition
object is being created as a part of animation initialization process (started by CAnimationController::AnimateGroup).
Usually you don't need to use this class directly, it just routs all events to a CCustomInterpolator-derived class, whose
pointer is passed to constructor of CCustomTransition.
Gets the interpolator's dependencies.
Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event.
Output. Aspects of the interpolator that depend on the initial value passed to SetInitialValueAndVelocity.
Output. Aspects of the interpolator that depend on the initial velocity passed to SetInitialValueAndVelocity.
Output. Aspects of the interpolator that depend on the duration passed to SetDuration.
Interpolates the velocity at a given offset
Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event.
The offset from the start of the transition.
The offset is always greater than or equal to zero and less than or equal to the duration of the transition.
This method is not called if the duration of the transition is zero.
Output. The velocity of the variable at the offset.
Interpolates the value at a given offset.
Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event.
The offset from the start of the transition.
The offset is always greater than or equal to zero and less than the duration of the transition.
This method is not called if the duration of the transition is zero.
Output. The interpolated value.
Gets the final value to which the interpolator leads.
Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event.
Output. The final value of a variable at the end of the transition.
Gets the interpolator's duration.
Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event.
Output. The duration of the transition, in seconds.
Sets the interpolator's duration.
Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event.
The duration of the transition.
Sets the interpolator's initial value and velocity.
The basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event.
The value of the variable at the start of the transition.
The velocity of the variable at the start of the transition.
Initializes duration and final value.
The duration of the transition.
The final value of a variable at the end of the transition.
Constructs a custom interpolator object and initializes duration and velocity to specified values.
The duration of the transition.
Constructs a custom interpolator object and sets all values to default 0.
Use CCustomInterpolator::Init to initialize duration and final value later in the code.
The interpolated velocity.
The interpolated value.
The velocity of the variable at the start of the transition.
The value of the variable at the start of the transition.
The final value of a variable at the end of the transition.
The duration of the transition.
Implements a basic interpolator.
Derive a class from CCustomInterpolator and override all necessary methods in order to implement a custom
interpolation algorithm. A pointer to this class should be passed as a parameter to CCustomTransition.
Calls the transition library to create encapsulated transition COM object.
TRUE if transition is created successfully; otherwise FALSE.
A pointer to transition library, which is responsible for creation of standard transitions.
A pointer to transition factory, which is responsible for creation of custom transitions.
The period of oscillation of the sinusoidal wave in seconds.
The duration of the transition.
Constructs a transition object.
The duration of the transition.
The period of oscillation of the sinusoidal wave in seconds.
Encapsulates a sinusoidal-velocity transition, with an amplitude determined by the animation variable's initial velocity..
The value of the animation variable oscillates around the initial value over the entire duration of a
sinusoidal-range transition. The amplitude of the oscillation is determined by the animation variable's velocity
when the transition begins.
Because all transitions are cleared automatically, it's recommended to allocated them using operator new.
The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then
it's NULL. Changing member variables after creation of this COM object has no effect.
Calls the transition library to create encapsulated transition COM object.
TRUE if transition is created successfully; otherwise FALSE.
A pointer to transition library, which is responsible for creation of standard transitions.
A pointer to transition factory, which is responsible for creation of custom transitions.
The slope at the start of the transition.
The period of oscillation of the sinusoidal wave in seconds.
The value of the animation variable at a peak of the sinusoidal wave.
The value of the animation variable at a trough of the sinusoidal wave.
The duration of the transition.
Constructs a transition object.
The duration of the transition.
The value of the animation variable at a trough of the sinusoidal wave.
The value of the animation variable at a peak of the sinusoidal wave.
The period of oscillation of the sinusoidal wave in seconds.
The slope at the start of the transition.
Encapsulates a sinusoidal-range transition, with a given range of oscillation.
The value of the animation variable fluctuates between the specified minimum and maximum values over the entire
duration of a sinusoidal-range transition. The slope parameter is used to disambiguate between the two possible
sine waves specified by the other parameters.
Because all transitions are cleared automatically, it's recommended to allocated them using operator new.
The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then
it's NULL. Changing member variables after creation of this COM object has no effect.
Calls the transition library to create encapsulated transition COM object.
TRUE if transition is created successfully; otherwise FALSE.
A pointer to transition library, which is responsible for creation of standard transitions.
A pointer to transition factory, which is responsible for creation of custom transitions.
The duration of the transition.
Constructs a reversal transition object and initializes its duration.
The duration of the transition.
Encapsulates a reversal transition.
A reversal transition smoothly changes direction over a given duration.
The final value will be the same as the initial value and the final velocity will be the negative of the initial velocity.
Because all transitions are cleared automatically, it's recommended to allocated them using operator new.
The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then
it's NULL. Changing member variables after creation of this COM object has no effect.
Calls the transition library to create encapsulated transition COM object.
TRUE if transition is created successfully; otherwise FALSE.
A pointer to transition library, which is responsible for creation of standard transitions.
A pointer to transition factory, which is responsible for creation of custom transitions.
The acceleration of the animation variable during the transition.
The velocity of the animation variable at the end of the transition.
The value of the animation variable at the end of the transition.
Constructs a parabolic-acceleration transition and initializes it with specified parameters.
The value of the animation variable at the end of the transition.
The velocity of the animation variable at the end of the transition.
The acceleration of the animation variable during the transition.
Encapsulates a parabolic-acceleration transition.
During a parabolic-acceleration transition, the value of the animation variable changes from the initial value
to the final value ending at a specified velocity. You can control how quickly the variable reaches the final
value by specifying the rate of acceleration.
Because all transitions are cleared automatically, it's recommended to allocated them using operator new.
The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then
it's NULL. Changing member variables after creation of this COM object has no effect.
Calls the transition library to create encapsulated transition COM object.
TRUE if transition is created successfully; otherwise FALSE.
A pointer to transition library, which is responsible for creation of standard transitions.
A pointer to transition factory, which is responsible for creation of custom transitions.
The value of the animation variable at the end of the transition.
The maximum duration of the transition.
Constructs a smooth-stop transition and initializes its maximum duration and final value.
The maximum duration of the transition.
The value of the animation variable at the end of the transition.
Encapsulates a smooth-stop transition.
A smooth-stop transition slows down as it approaches a given final value, and reaches it with a velocity of zero.
The duration of the transition is determined by the initial velocity, the difference between the initial and final values,
and the specified maximum duration. If there is no solution consisting of a single parabolic arc,
this method creates a cubic transition.
Because all transitions are cleared automatically, it's recommended to allocated them using operator new.
The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then
it's NULL. Changing member variables after creation of this COM object has no effect.
Calls the transition library to create encapsulated transition COM object.
TRUE if transition is created successfully; otherwise FALSE.
A pointer to transition library, which is responsible for creation of standard transitions.
A pointer to transition factory, which is responsible for creation of custom transitions.
The value of the animation variable at the end of the transition.
The absolute value of the variable's velocity.
Constructs a linear-speed transition object and initializes it with speed and final value.
The absolute value of the variable's velocity.
The value of the animation variable at the end of the transition.
Encapsulates a linear-speed transition.
During a linear-speed transition, the value of the animation variable changes at a specified rate.
The duration of the transition is determined by the difference between the initial value and the specified final value.
Because all transitions are cleared automatically, it's recommended to allocated them using operator new.
The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then
it's NULL. Changing member variables after creation of this COM object has no effect.
Calls the transition library to create encapsulated transition COM object.
TRUE if transition is created successfully; otherwise FALSE.
A pointer to transition library, which is responsible for creation of standard transitions.
A pointer to transition factory, which is responsible for creation of custom transitions.
The value of the animation variable at the end of the transition.
The duration of the transition.
Constructs a linear transition object and initializes it with duration and final value.
The duration of the transition.
The value of the animation variable at the end of the transition.
Encapsulates a linear transition.
During a linear transition, the value of the animation variable transitions linearly from its initial value to a specified final value.
Because all transitions are cleared automatically, it's recommended to allocated them using operator new.
The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then
it's NULL. Changing member variables after creation of this COM object has no effect.
Calls the transition library to create encapsulated transition COM object.
TRUE if transition is created successfully; otherwise FALSE.
A pointer to transition library, which is responsible for creation of standard transitions.
A pointer to transition factory, which is responsible for creation of custom transitions.
The value of the animation variable at the end of the transition.
Constructs a transition object and initializes its final value.
The value of the animation variable at the end of the transition.
Encapsulates an instantaneous transition.
During an instantaneous transition, the value of the animation variable changes instantly from its current
value to a specified final value. The duration of this transition is always zero.
Because all transitions are cleared automatically, it's recommended to allocated them using operator new.
The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then
it's NULL. Changing member variables after creation of this COM object has no effect.
Calls the transition library to create encapsulated transition COM object.
TRUE if transition is created successfully; otherwise FALSE.
A pointer to transition library, which is responsible for creation of standard transitions.
A pointer to transition factory, which is responsible for creation of custom transitions.
The amount of time by which to hold the variable at its final value.
The value of the animation variable at the end of the transition.
The amount of time by which to delay the instantaneous switch to the final value.
Constructs a discrete transition object and initializes its parameters.
The amount of time by which to delay the instantaneous switch to the final value.
The value of the animation variable at the end of the transition.
The amount of time by which to hold the variable at its final value.
Encapsulates a discrete transition.
During a discrete transition, the animation variable remains at the initial value for a specified delay time,
then switches instantaneously to a specified final value and remains at that value for a given hold time.
Because all transitions are cleared automatically, it's recommended to allocated them using operator new.
The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then
it's NULL. Changing member variables after creation of this COM object has no effect.
Calls the transition library to create encapsulated transition COM object.
TRUE if transition is created successfully; otherwise FALSE.
A pointer to transition library, which is responsible for creation of standard transitions.
A pointer to transition factory, which is responsible for creation of custom transitions.
The velocity of the variable at the end of the transition.
The value of the animation variable at the end of the transition.
The duration of the transition.
Constructs a transition object and initializes its parameters.
The duration of the transition.
The value of the animation variable at the end of the transition.
The velocity of the variable at the end of the transition.
Encapsulates a cubic transition.
During a cubic transition, the value of the animation variable changes from its initial value to a specified
final value over the duration of the transition, ending at a specified velocity.
Because all transitions are cleared automatically, it's recommended to allocated them using operator new.
The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then
it's NULL. Changing member variables after creation of this COM object has no effect.
Calls the transition library to create encapsulated transition COM object.
TRUE if transition is created successfully; otherwise FALSE.
A pointer to transition library, which is responsible for creation of standard transitions.
A pointer to transition factory, which is responsible for creation of custom transitions.
The duration of the transition.
Constructs a transition object and initializes its duration.
The duration of the transition.
Encapsulates a constant transition.
During a constant transition, the value of an animation variable remains at the initial value over the duration
of the transition.
Because all transitions are cleared automatically, it's recommended to allocated them using operator new.
The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then
it's NULL. Changing member variables after creation of this COM object has no effect.
Calls the transition library to create encapsulated transition COM object.
TRUE if transition is created successfully; otherwise FALSE.
A pointer to transition library, which is responsible for creation of standard transitions.
A pointer to transition factory, which is responsible for creation of custom transitions.
The ratio of the time spent decelerating to the duration.
The ratio of the time spent accelerating to the duration.
The value of the animation variable at the end of the transition.
The duration of the transition.
Constructs a transition object.
The duration of the transition.
The value of the animation variable at the end of the transition.
The ratio of the time spent accelerating to the duration.
The ratio of the time spent decelerating to the duration.
Implements an accelerate-decelerate transition.
During an accelerate-decelerate transition, the animation variable speeds up and then slows down over the
duration of the transition, ending at a specified value. You can control how quickly the variable accelerates and
decelerates independently, by specifying different acceleration and deceleration ratios.
When the initial velocity is zero, the acceleration ratio is the fraction of the duration that the variable will
spend accelerating; likewise with the deceleration ratio. If the initial velocity is non-zero, it is the
fraction of the time between the velocity reaching zero and the end of transition. The acceleration ratio and
the deceleration ratio should sum to a maximum of 1.0.
Because all transitions are cleared automatically, it's recommended to allocated them using operator new.
The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then
it's NULL. Changing member variables after creation of this COM object has no effect.
Handles events that occur when the rendering frame rate for an animation falls below the minimum desirable frame rate.
S_OK if the method succeeds; otherwise E_FAIL.
Handles events that occur after an animation update is finished.
S_OK if the method succeeds; otherwise E_FAIL.
Handles events that occur before an animation update begins.
S_OK if the method succeeds; otherwise E_FAIL.
Stores a pointer to animation controller to route events.
A pointer to animation controller, which will receive events.
Creates an instance of CAnimationTimerEventHandler callback.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to animation controller, which will receive events.
Output. If the method succeeds it contains a pointer to COM object that will handle
animation timer events.
Implements a call back, which is called by Animation API when timing events occur.
This event handler is created and passed to IUIAnimationTimer::SetTimerEventHandler when you call
CAnimationController::EnableAnimationTimerEventHandler.
Handles OnStoryboardUpdated events, which occur when a storyboard is updated
S_OK if the method succeeds; otherwise E_FAIL.
A pointer to storyboard, which was updated.
Handles OnStoryboardStatusChanged events, which occur when a storyboard's status changes
S_OK if the method succeeds; otherwise E_FAIL.
A pointer to storyboard whose status has changed.
Specifies new storyboard status.
Specifies previous storyboard status.
Stores a pointer to animation controller to route events.
A pointer to animation controller, which will receive events.
Creates an instance of CAnimationStoryboardEventHandler callback.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to animation controller, which will receive events.
Output. If the method succeeds it contains a pointer to COM object that will handle
storyboard events.
Constructs a CAnimationStoryboardEventHandler object.
Implements a callback, which is called by Animation API when storyboard's status is changed or storyboard is updated.
This event handler is created and passed to IUIAnimationStoryboard::SetStoryboardEventHandler method,
when you call CAnimationController::EnableStoryboardEventHandler.
Called when a value of an animation variable has changed.
S_OK if the method succeeds; otherwise E_FAIL.
The storyboard that is animating the variable.
The animation variable that was updated.
The new rounded value.
The previous rounded value.
Stores a pointer to animation controller to route events.
A pointer to animation controller, which will receive events.
Creates an instance of CAnimationVariableIntegerChangeHandler callback.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to animation controller, which will receive events.
Output. If the method succeeds it contains a pointer to COM object that will handle
variable integer change events.
Constructs a CAnimationVariableIntegerChangeHandler object.
Implements a call back, which is called by Animation API when the value of an animation variable changes.
This event handler is created and passed to IUIAnimationVariable::SetVariableIntegerChangeHandler method,
when you call CAnimationVariable::EnableIntegerValueChangedEvent or CAnimationBaseObject::EnableIntegerValueChangedEvent
(which enables this event for all animation variables encapsulated in an animation object).
Called when a value of an animation variable has changed.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
The storyboard that is animating the variable.
The animation variable that was updated.
The new value.
The previous value.
Stores a pointer to animation controller to route events.
A pointer to animation controller, which will receive events.
Creates an instance of CAnimationVariableChangeHandler object.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to animation controller, which will receive events.
Output. If the method succeeds it contains a pointer to COM object that will handle
variable change events.
Constructs a CAnimationVariableChangeHandler object.
Implements a call back, which is called by Animation API when the value of an animation variable changes.
This event handler is created and passed to IUIAnimationVariable::SetVariableChangeHandler method,
when you call CAnimationVariable::EnableValueChangedEvent or CAnimationBaseObject::EnableValueChangedEvent
(which enables this event for all animation variables encapsulated in an animation object).
Called when a status of animation manager has changed.
Current implementation always returns S_OK;
New status.
Previous status.
Stores a pointer to animation controller to route events.
A pointer to animation controller, which will receive events.
Creates an instance of CAnimationManagerEventHandler object.
If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
A pointer to animation controller, which will receive events.
Output. If the method succeeds it contains a pointer to COM object that will handle
status updates to an animation manager.
Constructs a CAnimationManagerEventHandler object.
Implements a callback, which is called by Animation API when a status of animation manager changed.
This event handler is created and passed to IUIAnimationManager::SetManagerEventHandler method,
when you call CAnimationController::EnableAnimationManagerEvent.
A helper that cleans up the group.
This method removes all transitions and keyframes from the specified group.
A pointer to animation group to clean.
Called by the framework when an animation for the specified group has just been scheduled.
The default implementation removes keyframes from the specified group and transitions from animation variables that
belong to the specified group. Can be overridden in a derived class to take any additional actions upon animation schedule.
A pointer to an animation group, which has been scheduled.
Called by the framework when the rendering frame rate for an animation falls below a minimum desirable frame rate.
This method is called if you enable timer event handlers using EnableAnimationTimerEventHandler.
It can be overridden in a derived class to take application-specific actions.
The minimum desirable frame rate is specified by calling IUIAnimationTimer::SetFrameRateThreshold.
The current frame rate in frames per second.
Called by the framework after an animation update is finished.
This method is called if you enable timer event handlers using EnableAnimationTimerEventHandler.
It can be overridden in a derived class to take application-specific actions.
Called by the framework before an animation update begins.
This method is called if you enable timer event handlers using EnableAnimationTimerEventHandler.
It can be overridden in a derived class to take application-specific actions.
Called by the framework to resolve scheduling conflicts.
Should return TRUE if storyboard owned by pGroupNew has priority. Should return FALSE if storyboard owned by
pGroupScheduled has priority.
This method is called if you enable priority comparison events using CAnimationController::EnablePriorityComparisonHandler
and specify UI_ANIMATION_PHT_COMPRESS.
It can be overridden in a derived class to take application-specific actions.
Read Windows Animation API documentation for more information about Conflict Management (http://msdn.microsoft.com/en-us/library/dd371759(VS.85).aspx).
The group that owns the currently scheduled storyboard.
The group that owns the new storyboard that is in scheduling conflict with the scheduled storyboard owned by pGroupScheduled.
The potential effect on pGroupNew if pGroupScheduled has a higher priority.
Called by the framework to resolve scheduling conflicts.
Should return TRUE if storyboard owned by pGroupNew has priority. Should return FALSE if storyboard owned by
pGroupScheduled has priority.
This method is called if you enable priority comparison events using CAnimationController::EnablePriorityComparisonHandler
and specify UI_ANIMATION_PHT_TRIM.
It can be overridden in a derived class to take application-specific actions.
Read Windows Animation API documentation for more information about Conflict Management (http://msdn.microsoft.com/en-us/library/dd371759(VS.85).aspx).
The group that owns the currently scheduled storyboard.
The group that owns the new storyboard that is in scheduling conflict with the scheduled storyboard owned by pGroupScheduled.
The potential effect on pGroupNew if pGroupScheduled has a higher priority.
Called by the framework to resolve scheduling conflicts.
Should return TRUE if storyboard owned by pGroupNew has priority. Should return FALSE if storyboard owned by
pGroupScheduled has priority.
This method is called if you enable priority comparison events using CAnimationController::EnablePriorityComparisonHandler
and specify UI_ANIMATION_PHT_CONCLUDE.
It can be overridden in a derived class to take application-specific actions.
Read Windows Animation API documentation for more information about Conflict Management (http://msdn.microsoft.com/en-us/library/dd371759(VS.85).aspx).
The group that owns the currently scheduled storyboard.
The group that owns the new storyboard that is in scheduling conflict with the scheduled storyboard owned by pGroupScheduled.
The potential effect on pGroupNew if pGroupScheduled has a higher priority.
Called by the framework to resolve scheduling conflicts.
Should return TRUE if storyboard owned by pGroupNew has priority. Should return FALSE if storyboard owned by
pGroupScheduled has priority.
This method is called if you enable priority comparison events using CAnimationController::EnablePriorityComparisonHandler
and specify UI_ANIMATION_PHT_CANCEL.
It can be overridden in a derived class to take application-specific actions.
Read Windows Animation API documentation for more information about Conflict Management (http://msdn.microsoft.com/en-us/library/dd371759(VS.85).aspx).
The group that owns the currently scheduled storyboard.
The group that owns the new storyboard that is in scheduling conflict with the scheduled storyboard owned by pGroupScheduled.
The potential effect on pGroupNew if pGroupScheduled has a higher priority.
Called by the framework when storyboard has been updated.
This method is called if you enable storyboard events using CAnimationController::EnableStoryboardEventHandler.
It can be overridden in a derived class to take application-specific actions.
A pointer to a group that owns the storyboard.
Called by the framework when storyboard status has changed.
This method is called if you enable storyboard events using CAnimationController::EnableStoryboardEventHandler.
It can be overridden in a derived class to take application-specific actions.
A pointer to an animation group that owns the storyboard whose status has changed.
Specifies the new status.
Specifies the previous status.
Called by the framework when integer value of animation variable has changed.
This method is called if you enable animation variable events with EnableIntegerValueChangedEvent called for a specific
animation variable or animation object.
It can be overridden in a derived class to take application-specific actions.
A pointer to an animation group that holds an animation object whose value has changed.
A pointer to an animation object that contains an animation variable whose value has changed.
A pointer to an animation variable.
Specifies new value.
Specifies previous value.
Called by the framework when value of animation variable has changed.
This method is called if you enable animation variable events with EnableValueChangedEvent called for a specific
animation variable or animation object.
It can be overridden in a derived class to take application-specific actions.
A pointer to an animation group that holds an animation object whose value has changed.
A pointer to an animation object that contains an animation variable whose value has changed.
A pointer to an animation variable.
Specifies new value.
Specifies previous value.
Called by the framework in response to StatusChanged event from animation manager.
This method is called if you enable animation manager events with EnableAnimationManagerEvent.
It can be overridden in a derived class to take application-specific actions. The default implementation
updates a related window if it has been set with SetRelatedWnd.
New animation manager status.
Previous animation manager status.
Called by the framework right before the animation is scheduled.
This call is routed to related CWnd and can be overridden in a derived class to perform any
additional actions before the animation starts for the specified group.
A pointer to an animation group whose animation is about to start.
Called by the framework to clean up the group when animation has been scheduled.
This method removes all transitions and keyframes from the specified group, because they are not relevant
after an animation has been scheduled.
Specifies GroupID.
Schedules an animation.
TRUE if animation was scheduled successfully. FALSE if storyboard has not been created, or other error occurs.
You must call AnimateGroup with parameter bScheduleNow set to FALSE prior ScheduleGroup. You can specify the
desired animation time obtained from IUIAnimationTimer::GetTime. If the time parameter is 0.0, the animation is scheduled for the
current time.
Specifies animation Group ID to schedule.
Specifies time to schedule.
Prepares a group to run animation and optionally schedules it.
TRUE if animation was successfully scheduled and run.
This method does the actual work creating storyboard, adding animation variables, applying transitions and setting keyframes.
It's possible to delay scheduling if you set bScheduleNow to FALSE. In this case the specified group
will hold a storyboard that has been set up for animation. At that point you can setup events for the storyboard and
animation variables. When you actually need to run the animation call CAnimationController::ScheduleGroup.
Specifies GroupID.
Specifies whether to run animation right away.
Finds animation object containing a specified animation variable.
TRUE if object was found; otherwise FALSE.
Called from event handlers when it's required to find an animation object from incoming animation variable.
A pointer to animation variable.
Output. Contains a pointer to animation object or NULL.
Output. Contains a pointer to animation group that holds the animation object, or NULL.
Finds an animation group by its storyboard.
A pointer to animation group if succeeds, or NULL if no group plays the specified storyboard.
This method is usually called from event handlers to find a group by pointer to storyboard that comes as a parameter to an event handler.
A pointer to a storyboard.
Finds an animation group by its Group ID.
A pointer to animation group or NULL if the group with specified ID is not found.
Use this method to find an animation group at runtime. A group is created and added to the internal list of animation groups
when a first animation object with particular GroupID is being added to animation controller.
Specifies a GroupID.
Adds a keyframe to group.
TRUE if the function succeeds; otherwise FALSE.
Usually you don't need to call this method, use CAnimationController::CreateKeyframe instead, which creates
and adds the created keyframe to a group automatically.
Specifies Group ID.
A pointer to a keyframe.
Creates a keyframe that depends on other keyframe with optional offset in seconds and adds it to the specified group.
A pointer to newly created keyframe if the function succeeds.
You can store the returned pointer and base other keyframes on the newly created keyframe (see the second overload).
It's possible to begin transitions at keyframes - see CBaseTransition::SetKeyframes.
You don't need to delete keyframes created in this way, because they are deleted automatically by animation groups.
Be careful when creating keyframes based on other keyframes and transitions and avoid circular references.
Specifies Group ID for which keyframe is created.
A pointer to base keyframe for this keyframe.
Offset in seconds from the base keyframe specified by pKeyframe.
Creates a keyframe that depends on transition and adds it to the specified group.
A pointer to newly created keyframe if the function succeeds.
You can store the returned pointer and base other keyframes on the newly created keyframe (see the second overload).
It's possible to begin transitions at keyframes - see CBaseTransition::SetKeyframes.
You don't need to delete keyframes created in this way, because they are deleted automatically by animation groups.
Be careful when creating keyframes based on other keyframes and transitions and avoid circular references.
Specifies Group ID for which keyframe is created.
A pointer to transition. Keyframe will be inserted to storyboard after this transition.
Removes transitions from animation objects that belong to the specified group.
The group loops over its animation objects and calls ClearTransitions(FALSE) for each animation object.
This method is called by the framework after animation has been scheduled.
Specifies Group ID.
Removes all animation groups from animation controller.
All groups will be deleted, their pointer, if stored at the application level, must be invalidated.
If CAnimationGroup::m_bAutodestroyAnimationObjects for a group being deleted is TRUE,
all animation objects that belong to that group will be deleted; otherwise their references to parent animation
controller will be set to NULL and they can be added to another controller.
Removes an animation group with specified ID from animation controller.
This method removes an animation group from the internal list of groups and deletes it, therefore if you stored
a pointer to that animation group, it must be invalidated. If CAnimationGroup::m_bAutodestroyAnimationObjects is TRUE,
all animation objects that belong to that group will be deleted; otherwise their references to parent animation
controller will be set to NULL and they can be added to another controller.
Specifies animation group ID.
Remove an animation object from animation controller.
Removes an animation object from animation controller and animation group. Call this function if
a particular object should not be animated anymore, or if you need to move the object to another animation controller.
In the last case bNoDelete must be TRUE.
A pointer to an animation object.
If this parameter is TRUE the object will not be deleted upon remove.
Adds an animation object to a group that belongs to the animation controller.
A pointer to existing or new animation group where pObject has been added if function succeeds; NULL if
pObject has already been added to a group that belongs to another animation controller.
Call this method to add an animation object to the animation controller. An object will be added to a group
according to object's GroupID (see CAnimationBaseObject::SetID). The animation controller will create a new
group if it's the first object being added with the specified GroupID. An animation object can be added to
one animation controller only. If you need to add an object to another controller, call RemoveAnimationObject first.
If you call SetID with new GroupID for an object that has been already added to a group, the object will be removed
from the old group and added to another group with specified ID.
A pointer to an animation object.
Establishes a relationship between animation controller and a window.
If a related CWnd object is set, the animation controller can automatically update it (send WM_PAINT message) when
the status of animation manager has changed or timer post update event has occurred.
A pointer to window object to set.
Tells whether at least one group is playing animation.
TRUE if there is an animation in progress for this animation controller; otherwise FALSE.
Checks status of animation manager and returns TRUE if the status is UI_ANIMATION_MANAGER_BUSY.
Directs the animation manager to update the values of all animation variables.
Calling this method advances the animation manager to current time, changing statuses of storyboards as necessary
and updating any animation variables to appropriate interpolated values. Internally this method calls
IUIAnimationTimer::GetTime(timeNow) and IUIAnimationManager::Update(timeNow). Override this method in a derived
class to customize this behavior.
Sets or releases a handler for timing events and handler for timing updates.
TRUE if handlers were successfully set or released; FALSE if this method is called for a second time without
releasing the handlers first, or if any other error occurs.
When the handlers are set (enabled) Windows Animation API calls OnAnimationTimerPreUpdate, OnAnimationTimerPostUpdate,
OnRenderingTooSlow methods.
You need to enable animation timers to allow Windows Animation API update storyboards. Otherwise you'll need to
call CAnimationController::UpdateAnimationManager in order to direct the animation manager to update the values
of all animation variables.
Specifies whether to set or release the handlers.
Specifies idle behavior for timer update handler.
Sets or releases a handler for storyboard status and update events.
TRUE if the handler was successfully set or released; FALSE if the specified animation group is now found or
animation for the specified group has not been initiated and its internal storyboard is NULL.
When a handler is set (enabled) Windows Animation API calls OnStoryboardStatusChanges and OnStoryboardUpdated virtual methods.
A handler must be set after CAnimationController::Animate has been called for the specified animation group, because
it creates encapsulated IUIAnimationStoryboard object.
Specifies Group ID.
Specifies whether to set or release a handler.
Sets or releases the priority comparison handler to call to determine whether a scheduled storyboard can be cancelled,
concluded, trimmed or compressed.
TRUE if the handler was successfully set or released.
When a handler is set (enabled) Windows Animation calls the following virtual methods depending on dwHandlerType:
OnHasPriorityCancel, OnHasPriorityConclude, OnHasPriorityTrim, OnHasPriorityCompress.
dwHandler can be a combination of the following flags:
UI_ANIMATION_PHT_NONE - release all handlers
UI_ANIMATION_PHT_CANCEL - set Cancel comparison handler
UI_ANIMATION_PHT_CONCLUDE - set Conclude comparison handler
UI_ANIMATION_PHT_COMPRESS - set Compress comparison handler
UI_ANIMATION_PHT_TRIM - set Trim comparison handler
UI_ANIMATION_PHT_CANCEL_REMOVE - remove Cancel comparison handler
UI_ANIMATION_PHT_CONCLUDE_REMOVE - remove Conclude comparison handler
UI_ANIMATION_PHT_COMPRESS_REMOVE - remove Compress comparison handler
UI_ANIMATION_PHT_TRIM_REMOVE - remove Trim comparison handler
A combination of UI_ANIMATION_PHT_ flags (see remarks), which specifies what handlers to set or release.
Sets or releases a handler to call when animation manager's status changes.
TRUE if the handler was successfully set or released.
When a handler is set (enabled) Windows Animation calls OnAnimationManagerStatusChanged when animation manager's status changes.
Specifies whether to set or release a handler.
Returns a keyframe that identifies start of storyboard.
A pointer to base keyframe, which identifies start of storyboard.
Obtain this keyframe to base any other keyframes or transitions on the moment in time when a storyboard starts.
Tells whether animation controller is valid.
TRUE if animation controller is valid; otherwise FALSE.
This method returns FALSE only if Windows Animation API is not supported on the current OS and creation of
animation manager failed because it's not registered. You need to call GetUIAnimationManager at least once after initialization of
COM libraries to cause setting of this flag.
A pointer to IUIAnimationTransitionFactory interface or NULL, if creation of transition library failed.
A pointer to IUIAnimationTransitionFactory or NULL, if creation of transition factory failed.
If current OS does not support Windows Animation API, this method returns NULL and after that all subsequent calls
on CAnimationController::IsValid return FALSE.
Provides access to encapsulated IUIAnimationTimer object.
A pointer to IUIAnimationTimer interface or NULL, if creation of animation timer failed.
If current OS does not support Windows Animation API, this method returns NULL and after that all subsequent calls
on CAnimationController::IsValid return FALSE.
Provides access to encapsulated IUIAnimationTransitionLibrary object.
A pointer to IUIAnimationTransitionLibrary interface or NULL, if creation of transition library failed.
If current OS does not support Windows Animation API, this method returns NULL and after that all subsequent calls
on CAnimationController::IsValid return FALSE.
Provides access to encapsulated IUIAnimationManager object.
A pointer to IUIAnimationManager interface or NULL, if creation of animation manager failed.
If current OS does not support Windows Animation API, this method returns NULL and after that all subsequent calls
on CAnimationController::IsValid return FALSE.
You may need to access IUIAnimationManager in order to call its interface methods, which are not wrapped by
animation controller.
The destructor. Called when animation controller object is being destroyed.
Constructs an animation controller.
A keyframe that represents start of storyboard.
A list of animation groups that belong to this animation controller.
A pointer to a related CWnd object, which can be automatically redrawn when
the status of animation manager has changed, or post update event has occurred. Can be NULL.
Stores a pointer to Transition Factory COM object.
Stores a pointer to Animation Timer COM object.
Stores a pointer to Transition Library COM object.
Stores a pointer to Animation Manager COM object.
Specifies whether an animation controller is valid or not.
This member is set to FALSE if current OS does not support Windows Animation API.
Implements the animation controller, which provides a central interface for creating and managing UI animations.
The CAnimationController class is the key class that manages animations.
You may create one or more instances of animation controller in an application and, optionally, connect an instance of
animation controller to a CWnd object using CAnimationController::SetRelatedWnd. This connection is required to send WM_PAINT messages
to the related window automatically when animation manager status has changed or animation timer has been updated.
If you do not enable this relation, you must redraw a window that displays an animation manually. For this purpose you can derive a class
from CAnimationController and override OnAnimationManagerStatusChanged and/or OnAnimationTimerPostUpdate and invalidate one or
more windows when necessary.
Specifies how to destroy animation objects. If this parameter is TRUE, animation objects will be destroyed automatically
when the group is destroyed. Otherwise animation objects must be destroyed manually. The default value is FALSE.
Set this value to TRUE only if all animation objects that belong to group are allocated dynamically with operator new.
Specifies how to clear transitions from animation objects that belong to group. If this member is TRUE,
transitions are removed automatically when an animation has been scheduled. Otherwise you need to remove
transitions manually.
Specifies how to destroy keyframes. If this value is TRUE, all keyframes are removed and destroyed;
otherwise they are removed from the list only. The default value is TRUE.
Points to animation storyboard. This pointer is valid only after call on Animate.
Contains a list of keyframes.
Contains a list of animation objects.
Directs all animation objects that belong to group automatically destroy transitions.
Set this value to FALSE only if you allocate transitions on the stack. The default value is TRUE, therefore
it's highly recommended to allocate transition objects using operator new.
Specifies how to destroy transitions.
Schedules an animation at the specified time.
TRUE if the method succeeds; FALSE if the method fails or if Animate has not been called with bScheduleNow set to FALSE.
Call this function to schedule an animation at the specified time. You must call Animate with bScheduleNow set to FALSE first.
A pointer to animation timer.
Specifies time to schedule the animation.
Animates a group.
TRUE if the method succeeds; otherwise FALSE.
This method creates an internal storyboard, creates and applies transitions and schedules an animation
if bScheduleNow is TRUE. If bScheduleNow is FALSE, you need to call Schedule to start animation at the
specified time.
Finds an animation object that contains the specified animation variable.
A pointer to animation object, or NULL if animation object is not found.
A pointer to animation variable.
Removes and optionally destroys all keyframes that belong to an animation group.
If m_bAutodestroyKeyframes member is TRUE then keyframes are removed and destroyed, otherwise keyframes are
just removed from the internal list of keyframes.
Removes transitions from animation objects that belong to an animation group.
If m_bAutoclearTransitions flag is set to TRUE, this method loops over all animation objects that belong to the group
and calls CAnimationObject::ClearTransitions(FALSE).
Applies transitions to animation objects.
This method ASSERTS in debug mode if storyboard has not been created.
It creates all transitions first, then adds "static" keyframes (keyframes that depend on offsets),
adds transitions that do not depend on keyframes, adds keyframes depending on transitions and other keyframes,
and at last adds transitions that depend on keyframes.
Returns GroupID.
A group identifier.
The destructor. Called when an animation group is being destroyed.
Constructs an animation group.
A pointer to animation controller that creates a group.
Specifies GroupID.
A helper that creates COM transition objects.
TRUE is the method succeeds, otherwise FALSE.
A helper that adds transitions to a storyboard.
A pointer to a storyboard COM object.
Specifies whether this method should add to the storyboard transitions that depend on other keyframes.
A helper that adds keyframes to a storyboard.
A pointer to a storyboard COM object.
Specifies whether this method should add to the storyboard keyframes that depend on other keyframes.
A pointer to animation controller this group belongs to.
A unique identifier of animation group.
Implements an animation group, which combines an animation storyboard, animation objects and transitions
to define an animation.
Animation groups are created automatically by animation controller (CAnimationController) when you add animation
objects using CAnimationController::AddAnimationObject.
An animation group is identified by GroupID, which is usually taken as a parameter to manipulate animation groups.
The GroupID is taken from the first animation object being added to a new animation group.
An encapsulated animation storyboard is created after you call CAnimationController::AnimateGroup and can be
accessed via public member m_pStoryboard.
Puts the encapsulated animation variables into a list.
When the function returns, it contains pointers to four CAnimationVariable objects
representing coordinates of rectangle.
Specifies whether the rectangle has fixed size.
If this member is true, then the size of rectangle is fixed and right and bottom values
are recalculated each time the top-left corner is moved according to the fixed size.
Set this value to TRUE to easily move the rectangle around the screen. In this case transitions applied to
right and bottom coordinates are ignored. The size is stored internally when you construct the object and/or
call SetDefaultValue. By default this member is set to FALSE.
Adds transitions for left, top, right and bottom coordinates.
Call this function to add the specified transitions to the internal list of transitions to be applied to animation variables for each rectangle sides.
When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied
(added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup.
If you don't need to apply a transition to one of the rectangle sides, you can pass NULL.
Specifies transition for the left side.
Specifies transition for the top side.
Specifies transition for the right side.
Specifies transition for the bottom side.
Converts a CAnimationRect to RECT.
Current value of animation rectangle as RECT.
This function internally calls GetValue. If GetValue for some reason fails, the returned RECT will contain default values for all rectangle coordinates.
Assigns rect to CAnimationRect.
It's recommended to do that before animation start, because this operator calls
SetDefaultValue, which recreates the underlying COM objects for color components if they have been created. If you
subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events.
The new value of animation rectangle.
Provides access to CAnimationVariable representing bottom coordinate.
A reference to encapsulated CAnimationVariable representing bottom coordinate.
You can call this method to get direct access to underlying CAnimationVariable representing the bottom coordinate.
Provides access to CAnimationVariable representing right coordinate.
A reference to encapsulated CAnimationVariable representing right coordinate.
You can call this method to get direct access to underlying CAnimationVariable representing the right coordinate.
Provides access to CAnimationVariable representing top coordinate.
A reference to encapsulated CAnimationVariable representing top coordinate.
You can call this method to get direct access to underlying CAnimationVariable representing the top coordinate.
Provides access to CAnimationVariable representing left coordinate.
A reference to encapsulated CAnimationVariable representing left coordinate.
You can call this method to get direct access to underlying CAnimationVariable representing the left coordinate.
Returns current value.
TRUE, if the current value was successfully retrieved; otherwise FALSE.
Call this function to retrieve the current value of animation rectangle. If this method fails or underlying COM objects for
left, top, right and bottom have not been initialized, rect contains default value, which was previously set in constructor or by SetDefaultValue.
Output. Contains the current value when this method returns.
Returns the default values for rectangle's bounds.
A CRect value containing defaults for left, right, top and bottom.
Call this function to retrieve default value, which was previously set by constructor or SetDefaultValue.
Sets default value.
Use this function to set a default value to animation object. This methods assigns default values to rectangle's bounds.
It also recreates underlying COM objects if they have been created. If you
subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events.
Specifies new default values for left, top, right and bottom.
Constructs an animation rect object.
The object is constructed with specified coordinates of each side, Object ID and Group ID. They can be changed
later at runtime using SetDefaultValue and SetID.
Specifies coordinate of left bound.
Specifies coordinate of top bound.
Specifies coordinate of right bound.
Specifies coordinate of bottom bound.
Specifies Group ID.
Specifies Object ID.
Specifies user-defined data.
Constructs an animation rect object.
The object is constructed with specified top-left corner coordinates and size of rectangle, Object ID and Group ID. They can be changed
later at runtime using SetDefaultValue and SetID.
Coordinate of top-left corner.
Size of rectangle.
Specifies Group ID.
Specifies Object ID.
Specifies user-defined data.
Constructs an animation rect object.
The object is constructed with specified rect coordinates, Object ID and Group ID. They can be changed
later at runtime using SetDefaultValue and SetID.
Specifies default rectangle.
Specifies Group ID.
Specifies Object ID.
Specifies user-defined data.
Constructs a CAnimationRect object.
The object is constructed with default values for left, top, right and bottom, Object ID and Group ID, which will be set to 0. They can be changed
later at runtime using SetDefaultValue and SetID.
Specifies initial size of animation rectangle.
The encapsulated animation variable that represents Bottom bound of animation rectangle.
The encapsulated animation variable that represents Right bound of animation rectangle.
The encapsulated animation variable that represents Top bound of animation rectangle.
The encapsulated animation variable that represents Left bound of animation rectangle.
Implements the functionality of a rectangle whose top, left, right and bottom sides can be animated.
The CAnimationRect class encapsulates four CAnimationVariable objects and can represent in applications
a rectangle.
To use this class in application, just instantiate an object of this class, add it to animation controller using
CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to left, right top and bottom coordinates.
Puts the encapsulated animation variables into a list.
When the function returns, it contains pointers to three CAnimationVariable objects
representing red, green and blue components.
Adds transitions for Red, Green and Blue components.
Call this function to add the specified transitions to the internal list of transitions to be applied to animation variables representing color components.
When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied
(added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup.
If you don't need to apply a transition to one of the color components, you can pass NULL.
Transition for Red component.
Transition for Green component.
Transition for Blue component.
Converts a CAnimationColor to COLORREF.
Current value of animation color object as COLORREF.
This function internally calls GetValue. If GetValue for some reason fails, the returned COLORREF will contain default values for all color components.
Assigns color to CAnimationColor.
It's recommended to do that before animation start, because this operator calls
SetDefaultValue, which recreates the underlying COM objects for color components if they have been created. If you
subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events.
Specifies new value Animation Color.
Provides access to CAnimationVariable representing Blue component.
A reference to encapsulated CAnimationVariable representing Blue component.
You can call this method to get direct access to underlying CAnimationVariable representing Blue component.
Provides access to CAnimationVariable representing Green component.
A reference to encapsulated CAnimationVariable representing Green component.
You can call this method to get direct access to underlying CAnimationVariable representing Green component.
Provides access to CAnimationVariable representing Red component.
A reference to encapsulated CAnimationVariable representing Red component.
You can call this method to get direct access to underlying CAnimationVariable representing Red component.
Returns current value.
TRUE, if the current value was successfully retrieved; otherwise FALSE.
Call this function to retrieve the current value of animation color. If this method fails or underlying COM objects for
color components have not been initialized, color contains default value, which was previously set in constructor or by SetDefaultValue.
Output. Contains the current value when this method returns.
Returns the default values for color components.
A COLORREF value containing defaults for RGB components.
Call this function to retrieve default value, which was previously set by constructor or SetDefaultValue.
Sets default value.
Use this function to set a default value to animation object. This methods assigns default values to color components
of animation color. It also recreates underlying COM objects if they have been created. If you
subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events.
Specifies new default values for red, green and blue components.
Constructs an animation color object.
The object is constructed with specified values for RGB components, Object ID and Group ID. They can be changed
later at runtime using SetDefaultValue and SetID.
Specifies default color.
Specifies Group ID.
Specifies Object ID.
Specifies user-defined data.
Constructs a CAnimationColor object.
The object is constructed with default values for red, green, blue, Object ID and Group ID, which will be set to 0. They can be changed
later at runtime using SetDefaultValue and SetID.
The encapsulated animation variable that represents Blue component of animation color.
The encapsulated animation variable that represents Green component of animation color.
The encapsulated animation variable that represents Red component of animation color.
Implements the functionality of a color whose red, green and blue components can be animated.
The CAnimationColor class encapsulates three CAnimationVariable objects and can represent in applications
a color. For example, you can use this class to animate colors of any object on the screen (like text color, background color etc).
To use this class in application, just instantiate an object of this class, add it to animation controller using
CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to Red, Green and Blue components.
Puts the encapsulated animation variables into a list.
When the function returns, it contains pointers to two CAnimationVariable objects
representing the width and height.
Adds transitions for Width and Height.
Call this function to add the specified transitions to the internal list of transitions to be applied to animation variables for Width and Height.
When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied
(added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup.
If you don't need to apply a transition to one of dimensions, you can pass NULL.
A pointer to transition for Width.
A pointer to transition for Height.
Converts a CAnimationSize to a CSize.
Current value of animation size as CSize.
This function internally calls GetValue. If GetValue for some reason fails, the returned size will contain default values for Width and Height.
Assigns szSrc to CAnimationSize.
Assigns szSrc to CAnimationSize. It's recommended to do that before animation start, because this operator calls
SetDefaultValue, which recreates the underlying COM objects for Width and Height if they have been created. If you
subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events.
Refers to CSize or SIZE.
Provides access to CAnimationVariable representing Height.
A reference to encapsulated CAnimationVariable representing Height.
You can call this method to get direct access to underlying CAnimationVariable representing Height.
Provides access to CAnimationVariable representing Width.
A reference to encapsulated CAnimationVariable representing Width.
You can call this method to get direct access to underlying CAnimationVariable representing Width.
Returns current value.
TRUE, if the current value was successfully retrieved; otherwise FALSE.
Call this function to retrieve the current value of animation size. If this method fails or underlying COM objects for
Width and Size have not been initialized, szValue contains default value, which was previously set in constructor or by SetDefaultValue.
Output. Contains the current value when this method returns.
Returns the default values for Width and Height.
A CSize object containing default values.
Call this function to retrieve default value, which was previously set by constructor or SetDefaultValue.
Sets default value.
Use this function to set a default value to animation object. This methods assigns default values to Width and Height
of animation size. It also recreates underlying COM objects if they have been created. If you
subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events.
Specifies new default size.
Constructs an animation size object.
The object is constructed with specified values for width, height, Object ID and Group ID. They can be changed
later at runtime using SetDefaultValue and SetID.
Specifies default size.
Specifies Group ID.
Specifies Object ID.
Specifies user-defined data.
Constructs an animation size object.
The object is constructed with default values for width, height, Object ID and Group ID, which will be set to 0. They can be changed
later at runtime using SetDefaultValue and SetID.
The encapsulated animation variable that represents height of animation size.
The encapsulated animation variable that represents width of animation size.
Implements the functionality of a size object whose dimensions can be animated.
The CAnimationSize class encapsulates two CAnimationVariable objects and can represent in applications
a size. For example, you can use this class to animate a size of any two dimensional object on the screen (like rectangle, control etc).
To use this class in application, just instantiate an object of this class, add it to animation controller using
CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to Width and/or Height.
Puts the encapsulated animation variables into a list.
When the function returns, it contains pointers to two CAnimationVariable objects
representing the X and Y coordinates.
Adds transitions for X and Y coordinates.
Call this function to add the specified transitions to the internal list of transitions to be applied to animation variables for X and Y coordinates.
When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied
(added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup.
If you don't need to apply a transition to one of coordinates, you can pass NULL.
A pointer to transition for X coordinates.
A pointer to transition for Y coordinate.
Provides access to CAnimationVariable for Y coordinate.
A reference to encapsulated CAnimationVariable representing Y coordinate.
You can call this method to get direct access to underlying CAnimationVariable representing Y coordinate.
Provides access to CAnimationVariable for X coordinate.
A reference to encapsulated CAnimationVariable representing X coordinate.
You can call this method to get direct access to underlying CAnimationVariable representing X coordinate.
Converts a CAnimationPoint to a CPoint.
Current value of CAnimationPoint as CPoint.
This function internally calls GetValue. If GetValue for some reason fails, the returned point will contain default values for X and Y coordinates.
Assigns ptSrc to CAnimationPoint.
Assigns ptSrc to CAnimationPoint. It's recommended to do that before animation start, because this operator calls
SetDefaultValue, which recreates the underlying COM objects for X and Y coordinates if they have been created. If you
subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events.
Refers to CPoint or POINT.
Returns current value.
TRUE, if the current value was successfully retrieved; otherwise FALSE.
Call this function to retrieve the current value of animation point. If this method fails or underlying COM objects for
X and Y coordinates have not been initialized, ptValue contains default
value, which was previously set in constructor or by SetDefaultValue.
Output. Contains the current value when this method returns.
Returns the default values for X and Y coordinates.
A point containing default value.
Call this function to retrieve default value, which was previously set by constructor or SetDefaultValue.
Sets default value.
Use this function to set a default value to animation object. This methods assigns default values to X and Y
coordinates of animation point. It also recreates underlying COM objects if they have been created. If you
subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events.
Specifies the default point value.
Constructs CAnimationPoint object.
Constructs CAnimationPoint object with specified properties.
Specifies default point coordinates.
Specifies Group ID.
Specifies Object ID.
Specifies user-defined data.
Constructs CAnimationPoint object.
Constructs CAnimationPoint object with default properties: default point coordinates, Group ID and Object ID are set to 0.
The encapsulated animation variable that represents Y coordinate of animation point.
The encapsulated animation variable that represents X coordinate of animation point.
Implements the functionality of a point whose coordinates can be animated.
The CAnimationPoint class encapsulates two CAnimationVariable objects and can represent in applications
a point. For example, you can use this class to animate a position of any object on the screen (like text string, circle, point etc).
To use this class in application, just instantiate an object of this class, add it to animation controller using
CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to X and/or Y coordinates.
Puts the encapsulated animation variable into a list.
When the function returns, it contains a pointer to CAnimationVariable representing the animated value.
Adds a transition to be applied to a value.
Call this function to add a transition to internal list of transitions to be applied to an animation variable.
When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied
(added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup.
A pointer to transition object.
Provides access to encapsulated animation variable.
A reference to encapsulated animation variable.
Use this method to access the encapsulated animation variable. From CAnimationVariable you get access
to underlying IUIAnimationVariable object, whose pointer can be NULL if animation variable has not been created.
Assigns an INT32 value to CAnimationValue.
Assigns an INT32 value to CAnimationValue. This value is set as a default value for encapsulated animation variable.
If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events.
Specifies the value to be assigned to Animation Value.
Assigns a DOUBLE value to CAnimationValue.
Assigns a DOUBLE value to CAnimationValue. This value is set as a default value for encapsulated animation variable.
If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events.
Specifies the value to be assigned to Animation Value.
Provides conversion between CAnimationValue and INT32.
Current value of Animation Value as integer.
Provides conversion between CAnimationValue and INT32. This method internally calls GetValue and doesn't check for
errors. If GetValue fails, the returned value will contain a default value previously set in constructor or with SetDefaultValue.
Provides conversion between CAnimationValue and DOUBLE.
Current value of Animation Value.
Provides conversion between CAnimationValue and DOUBLE. This method internally calls GetValue and doesn't check for
errors. If GetValue fails, the returned value will contain a default value previously set in constructor or with SetDefaultValue.
Retrieves the current value.
TRUE if the current value was retrieved successfully; otherwise FALSE.
Call this function to retrieve the current value. This implementation calls the encapsulated COM object, and if
the call fails, this method returns the default value that was previously set in constructor or with SetDefaultValue.
Output. When the function returns it contains a current value of animation variable.
Retrieves the current value.
TRUE if the current value was retrieved successfully; otherwise FALSE.
Call this function to retrieve the current value. This implementation calls the encapsulated COM object, and if
the call fails, this method returns the default value that was previously set in constructor or with SetDefaultValue.
Output. When the function returns it contains a current value of animation variable.
Sets default value.
Use this method to set a default value. A default value is returned to application when animation has not been started
and/or underlying COM object has not been created. If the underlying COM object encapsulated in CAnimationVarible
was already created, this method recreates it, therefore you might need to call EnableValueChanged/EnableIntegerValueChanged
methods again.
Specifies the default value.
Constructs a CAnimationValue object.
Constructs CAnimationValue object with specified properties.
Specifies default value.
Specifies Group ID.
Specifies Object ID.
specifies user-defined data.
Constructs a CAnimationValue object.
Constructs CAnimationValue object with default properties: default value, Group ID and Object ID are set to 0.
The encapsulated animation variable that represents animation value.
Implements the functionality of animation object with one value.
The CAnimationValue class encapsulates a single CAnimationVariable object and can represent in applications
a single animated value. For example, you can use this class for animated transparency (fade effect), angle (to rotate objects),
or for any other case when you need to create an animation depending on a single animated value.
To use this class in application, just instantiate an object of this class, add it to animation controller using
CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to the value.
Establishes relationship between animation variables, contained in an animation object, and their container.
This is a helper that can be used to establish relationship between animation variables, contained in an animation object,
and their container. It loops over animation variables and sets a back pointer to a parent animation object
to each animation variable.
In the current implementation the actual relationship is established in CAnimationBaseObject::ApplyTransitions, therefore
back pointers are not set until you call CAnimationGroup::Animate.
Knowing the relationship may be helpful when you processing events and need to get a parent animation object
from CAnimationVariable (use CAnimationVariable::GetParentAnimationObject).
Collects pointers to contained animation variables.
This is a pure virtual method that must be overridden in a derived class.
An animation object, depending on its type, contains one or more animation variables. For example, CAnimationPoint
contains two variables, for X and Y coordinates respectively. The base class CAnimationBaseObject implements
some generic methods, which act on a list of animation variables: ApplyTransitions, ClearTransitions,
EnableValueChangedEvent, EnableIntegerValueChangedEvent. These methods call GetAnimationVariableList, which is filled
in a derived class with actual animation variables contained in a particular animation object, then loop over the
list and perform necessary actions.
If you create a custom animation object, you must add to lst all animation variables contained in that object.
A list that must be filled with animation variables contained in an animation object.
Determines whether an animation object contains a particular animation variable.
TRUE if the animation variable is contained in the animation object; otherwise FALSE.
This method can be used to determine whether an animation variable specified by pVariable is contained
within an animation object. An animation object, depending on its type, may contain several animation variables.
For example, CAnimationColor contains three variables, one for each color component (red, green and blue). When a
value of animation variable has changed, Windows Animation API sends ValueChanged or IntegerValueChanged events (if enabled),
and the parameter of this event is a pointer to interface IUIAnimationVariable of animation variable.
This method helps to obtain a pointer to animation from a pointer to contained COM object.
A pointer to animation variable.
Sets up Integer Value Changed event handler.
If the Integer Value Changed event handler is enabled, you can handle this event in CAnimationController::OnAnimationIntegerValueChanged method,
which should be overridden in a CAnimationController-derived class. This method is called every time the animation integer value has changed.
A pointer to a parent controller.
Specifies whether to enable, or disable Integer Value Changed event.
Sets up Value Changed event handler.
If the Value Changed event handler is enabled, you can handle this event in CAnimationController::OnAnimationValueChanged method,
which should be overridden in a CAnimationController-derived class. This method is called every time the animation value has changed.
A pointer to a parent controller.
Specifies whether to enable, or disable Value Changed event.
Removes all related transitions.
Removes all related transitions and destroys them if bAutodestroy or m_bAutodestroyTransitions flag is TRUE.
Transitions should be destroyed automatically only if they are not allocated on the stack.
If the above flags are FALSE, transitions are just removed from the internal list of related transitions.
Specifies whether to destroy transition objects automatically, or just remove them from the related list.
Adds transitions to storyboard with encapsulated animation variable.
TRUE if transitions were added successfully.
Adds related transitions, that have been added with AddTransition (overloaded methods in derived classes), to storyboard.
A pointer to a storyboard.
With FALSE this method adds only those transitions that do not depend on keyframes.
Tells whether related transition are destroyed automatically.
If TRUE, related transitions are destroyed automatically; if FALSE, transition objects should be deallocated by calling application.
By default this flag is TRUE. Set this flag only if you allocated transition on the stack and/or transitions should be deallocated by
the calling application.
Sets a flag that orders to automatically destroy transitions.
Set this flag only if you allocated transition objects using operator new. If for some reason transition
objects are allocated on the stack, the auto destroy flag should be FALSE. By default this flag is TRUE.
Specifies the auto destroy flag.
Returns user defined data.
A value of custom data.
Call this method to retrieve the custom data at runtime. The returned value will be 0 if it was not explicitly initialized in constructor or with SetUserData.
Returns current Group ID.
Current Group ID.
Use this method to retrieve Group ID. It's 0 if Group ID has not been set explicitly in constructor or with SetID.
Returns current Object ID.
Current Object ID.
Use this method to retrieve Object ID. It's 0 if Object ID has not been set explicitly in constructor or with SetID.
Detaches an animation object from parent animation controller.
This method is used internally.
Sets user-defined data.
Use this method to associate a custom data with an animation object. This data may be retrieved later at runtime by GetUserData.
Specifies the custom data.
Sets new IDs.
Allows to change Object ID and Group ID. If the new Group ID differs from the current ID, an animation object
is moved to another group (a new group will be created, if necessary).
Specifies new Object ID.
Specifies new Group ID.
Creates transitions associated with an animation object.
TRUE if transitions were created successfully; otherwise FALSE.
Loops over list of animation variables encapsulated in a derived animation object and creates transitions
associated with each animation variable.
The destructor. Called when an animation object is being destroyed.
Constructs an animation object.
Constructs an animation object with specified Object ID and Group ID.
Specifies Group ID.
Specifies Object ID.
User-defined data, which can be associated with animation object and retrieved later at runtime.
Constructs an animation object.
Constructs an animation objects and assigns default Object ID (0) and Group ID (0).
A pointer to the parent animation controller.
Specifies whether related transitions should be automatically destroyed.
Stores user-defined data.
Specifes the Object ID of the animation object.
Specifies the Group ID of the animation object.
The base class for all animation objects.
This class implements basic methods for all animation objects. An animation object can represent a value, point,
size, rectangle or color in an application, as well as any custom entity. Animation objects are stored in animation groups
(see CAnimationGroup). Each group can be animated separately and can be treated as an analogue of storyboard.
An animation object encapsulates one or more animation variables (see CAnimationVariable), depending on its logical
representation. For example, CAnimationRect contains four animation variables - one variable for each side of rectangle.
Each animation object class exposes overloaded AddTransition method, which should be used to apply transitions to
encapsulated animation variables.
An animation object can be identified by Object ID (optionally) and by Group ID. A Group ID is necessary in order
to place an animation object to correct group, but if a Group ID is not specified, an object is placed in the default group with ID 0.
If you call SetID with different GroupID, an animation object will be moved to another group (a new group is created if necessary).
Specifies whether related transition objects should be deleted.
Set this value to TRUE to force deletion of transition objects when they are being removed from the internal list
of transitions. If this value is FALSE the transitions should be deleted by calling application.
The list of transitions is always cleared after an animation has been scheduled. The default value is FALSE.
Returns default value.
The default value.
Use this function to obtain default value of animation variable. The default value can be set in constructor or by
SetDefaultValue method.
Enables or disables the IntegerValueChanged event.
When ValueChanged event is enabled, the framework calls virtual method CAnimationController::OnAnimationIntegerValueChanged.
You need to override it in a class derived from CAnimationController in order to process this event. This method is called every time
the integer value of animation variable is changed.
A pointer to parent controller.
TRUE - enable event, FALSE - disable event.
Enables or disables the ValueChanged event.
When ValueChanged event is enabled, the framework calls virtual method CAnimationController::OnAnimationValueChanged.
You need to override it in a class derived from CAnimationController in order to process this event. This method is called every time
the value of animation variable is changed.
A pointer to parent controller.
TRUE - enable event, FALSE - disable event.
Adds transitions from the internal list to storyboard.
This method adds transitions from the internal list to storyboard. It's called from the
top level code several times to add transitions that do not depend on keyframes and add
transitions that depend on keyframes. If the underlying animation variable
COM object has not been created, this method creates it at this stage.
A pointer to parent animation controller.
A pointer to storyboard.
TRUE, if this method should add transitions that depend on keyframes.
Clears transitions.
This method removes all transitions from the internal list of transitions. If bAutodestroy is TRUE, or
m_bAutodestroyTransitions is TRUE, then transitions are deleted. Otherwise the caller should deallocate
the transition objects.
Specifies whether this method should delete transition objects.
Adds a transition.
This method is called to add a transition to the internal list of transitions to be applied to the animation variable.
This list should be cleared when an animation has been scheduled.
A pointer to a transition to add.
Returns the current value of animation variable.
S_OK if the value was obtained successfully, or underlying animation variable has not been created. Otherwise
HRESULT error code.
This method can be called to retrieve the current value of animation variable. If the underlying COM object
has not been created, dblValue will contain a default value, when the function returns.
The current value of the animation variable.
Returns the current value of animation variable.
S_OK if the value was obtained successfully, or underlying animation variable has not been created. Otherwise
HRESULT error code.
This method can be called to retrieve the current value of animation variable. If the underlying COM object
has not been created, dblValue will contain a default value, when the function returns.
The current value of the animation variable.
Creates all transitions to be applied to this animation variable.
TRUE if transitions were created successfully; otherwise FALSE.
This method is called by the framework when it needs to create transitions that have been added
to the variable's internal list of transitions.
A pointer to transition library.
A pointer to transition factory.
Creates the underlying animation variable COM object.
TRUE if the animation variable was successfully created; otherwise FALSE.
This method creates the underlying animation variable COM object and sets its default value.
A pointer to animation manager.
Sets default value and releases IUIAnimationVariable COM object.
Use this method to reset the default value. This method releases the internal IUIAnimationVariable COM object,
therefore when animation variable is recreated, the underlying COM object gets the new default value.
The default value is returned by GetValue if the COM object representing the animation variable is not created,
or if the variable has not been animated.
Specifies the new default value.
Returns a pointer to IUIAnimationVariable COM object.
A valid pointer to IUIAnimationVariable COM object, or NULL if animation variable was not created, or can't be created.
Use this function to access the underlying IUIAnimationVariable COM object and call its methods directly if needed.
Returns the parent animation object.
A pointer to parent animation object, if relationship was established, otherwise NULL.
This method can be called to retrieve a pointer to a parent animation object (a container).
The destructor. Called when a CAnimationVariable object is being destroyed.
Constructs an animation variable object.
Constructs an animation variable object and sets its default value. A default value is used when
a variable is not animated, or can't be animated.
Specifies the default value.
Sets the relationship between an animation variable and an animation object.
This method is called internally to establish one-to-one relationship between an animation variable and an animation object that encapsulates it.
A pointer to an animation object that contains this variable.
A pointer to an animation object that encapsulates this animation variable.
Contains a list of transitions that animate this animation variable.
Specifies the default value, which is propagated to IUIAnimationVariable.
Stores a pointer to IUIAnimationVariable COM object. NULL if the COM object has not been created yet, or if creation failed.
Represents an animation variable.
The CAnimationVariable class encapsulates IUIAnimationVariable COM object. It also holds a list of transitions
to be applied to the animation variable in a storyboard. CAnimationVariable objects are embedded to
animation objects, which can represent in an application an animated value, point, size, color and rectangle.
Adds a keyframe to storyboard at offset.
TRUE, if keyframe was added successfully.
This function is called by the framework to add a keyframe to storyboard at offset.
A pointer to a storyboard.
Specifies whether to add a keyframe this keyframe depend on recursively.
Adds a keyframe to storyboard after transition.
TRUE, if keyframe was added successfully.
This function is called by the framework to add a keyframe to storyboard after transition.
A pointer to a storyboard.
Specifies whether to add a transition recursively.
Adds a keyframe to a storyboard.
TRUE, if keyframe was added successfully.
This method adds a keyframe to storyboard. If it depends on other keyframe or transition and bDeepAdd is TRUE,
this method tries to add them recursively.
A pointer to a storyboard.
Specifies whether to add keyframe or transition recursively.
Returns an offset from other keyframe.
An offset in seconds from other keyframe.
This method should be called to determine an offset in seconds from other keyframe.
Returns a pointer to a keyframe this keyframe depends on.
A valid pointer to keyframe, or NULL if this keyframe does not depend on other keyframe.
This is an accessor to a keyframe this keyframe depends on.
Returns a pointer to a transition this keyframe depends on.
A valid pointer to transition, or NULL if this keyframe does not depend on transition.
This is an accessor to a transition this keyframe depends on.
Constructs a keyframe that depends on other keyframe.
The constructed keyframe will represent a moment in time within a storyboard, which has a specified offset from pKeyframe.
A pointer to keyframe.
Offset, in seconds, from keyframe specified by pKeyframe.
Constructs a keyframe that depends on a transition.
The constructed keyframe will represent a moment in time within a storyboard when the specified transition ends.
A pointer to a transition.
Stores a pointer to an existing keframe. This keyframe is added to storyboard with m_offset to the existing keyframe.
Specifies offset of this keyframe from a keyframe stored in m_pExistingKeyFrame.
Stores a pointer to transtion that begins at this keyframe.
Represents an animation keyframe.
This class implements an animation keyframe. A keyframe represents a moment in time within a
storyboard and can be used to specify the start and end times of transitions.
A keyframe may be based on other keyframe and have an offset (in seconds) from it, or may be based on a transition and
represent a moment in time when this transition ends.
Adds a keyframe to storyboard.
TRUE if keyframe was added to storyboard successfully; otherwise FALSE.
This method is called to add a keyframe to storyboard.
A pointer to a storyboard.
If this parameter is TRUE and the keyframe being added depends on some other keyframe or transition, this method tries
to add this keyframe or transition to storyboard first.
Specifies whether the keyframe should be added to storyboard at offset, or after transition.
TRUE if the keyframe should be added to storyboard at some specified offset.
FALSE if the keyframe should be added to storyboard after some transition.
Specifies whether the keyframe should be added to storyboard at offset.
The offset or transition must be specified in a derived class.
Tells whether a keyframe has been added to storyboard.
TRUE if a keyframe is added to a storyboard; otehrwise FALSE.
In the base class IsAdded always returns TRUE, but it's overridden in derived classes.
Returns the underlying keyframe value.
A current keyframe. The default value is UI_ANIMATION_KEYFRAME_STORYBOARD_START.
This is an accessor to the underlying keyframe value.
Constructs a keyframe object.
Specifies whether this keyframe should be added to storyboard at an offset from
another existing keyframe, or at the end of some transition.
Specifies whether this keyframe has been added to a storyboard.
Represents a Windows Animation API keyframe. When a keyframe is not initialized
it is set to the predefined value UI_ANIMATION_KEYFRAME_STORYBOARD_START.
Implements basic functionality of keyframe.
Encapsulates UI_ANIMATION_KEYFRAME variable. Serves as a base class for any keyframe implementation.
A keyframe represents a moment in time within a storyboard and can be used to specify the start and end times of transitions.
There are two types of keyframes - keyframes added to storyboard at the specified offset (in time), or keyframes added
after specified transition. Because durations of some transitions can't be known before animation starts, the actual values
of some keyframes are determined at runtime only.
Because keyframes may depend on transitions, which in their turn depend on keyframes, it's important to prevent
infinite recursions when building keyframe chains.
Specifies whether a transition has been added to a storyboard.
A pointer to an animation variable, which is animated with the transition stored in m_transition.
Stores a pointer to the keyframe that specifies the end of the transition.
Stores a pointer to the keyframe that specifies the beginning of the transition.
Stores a pointer to IUIAnimationTransition. NULL if a COM transition object has not been created.
Stores the transition type.
Adds a transition to a storyboard.
TRUE, if transition was successfully added to a storyboard.
Applies the transition to the related variable in the storyboard. If the start keyframe was specified, the transition
begins at that keyframe. If the end keyframe was specified, the transition begins at the start keyframe and
and stops at the end keyframe. If the transition was created with a duration parameter specified, that duration is
overwritten with the duration of time between the start and end keyframes.
If no keyframe was specified, the transition is appended to the transition added most recently to the variable.
A pointer to storyboard, which will animate the related variable.
Adds a transition to a storyboard.
TRUE, if transition was successfully added to a storyboard.
Applies the transition to the related variable in the storyboard. If this is the first transition
applied to this variable in this storyboard, the transition begins at the start of the storyboard.
Otherwise, the transition is appended to the transition added most recently to the variable.
A pointer to storyboard, which will animate the related variable.
Returns a pointer to related variable.
A valid pointer to animation variable, or NULL if an animation variable has not been set by SetRelatedVariable.
This is an accessor to related animation variable.
Establishes a relationship between animation variable and transition.
Establishes a relationship between animation variable and transition. A transition can be applied only to one variable.
A pointer to related animation variable.
Returns start keyframe.
A valid pointer to a keyframe, or NULL if a transition should not be inserted between keyframes.
This method can be used to access a keyframe object that was previously set by SetKeyframes.
It's called by top level code when transitions are being added to storyboard.
Returns start keyframe.
A valid pointer to a keyframe, or NULL if a transition should not start after a keyframe.
This method can be used to access a keyframe object that was previously set by SetKeyframes.
It's called by top level code when transitions are being added to storyboard.
Tells whether a transition has been added to a storyboard.
Returns TRUE if a transition has been added to a storyboard, otherwise FALSE.
This flag is set internally when the top level code adds transitions to storyboard.
Sets keyframes for a transition.
This method tells the transition to start after specified keyframe and, optionally, if pEnd is not NULL, end
before the specified keyframe.
If the transition was created with a duration parameter specified, that duration is overwritten with the duration of time between the start and end keyframes.
A keyframe that specifies the beginning of the transition.
A keyframe that specifies the end of the transition.
Returns a pointer to underlying COM transition object.
A valid pointer to IUIAnimationTransition or NULL if underlying transition can't be created.
It's an accessor method to underlying COM transition object. It doesn't instantiates the underlying IUIAnimationTransition COM
object if it wasn't created.
Returns a pointer to underlying COM transition object.
A valid pointer to IUIAnimationTransition or NULL if underlying transition can't be created.
This method returns a pointer to underlying COM transition object and creates it if necessary.
A pointer to transition library, which creates standard transitions. It can be NULL for custom transitions.
A pointer to transition factory, which creates custom transitions. It can be NULL for standard transitions.
Creates a COM transition.
TRUE if a transition COM object was created successfully; otherwise FALSE.
This is a pure virtual function that must be overridden in a derived class.
It's called by the framework to instantiate the underlying COM transition object.
A pointer to transition library, which creates standard transitions. It can be NULL for custom transitions.
A pointer to transition factory, which creates custom transitions. It can be NULL for standard transitions.
Returns transition type.
One of TRANSITION_TYPE enumerated values.
This method can be used to identify a transition object by its type.
The type is set in a constructor in a derived class.
Releases encapsulated IUIAnimationTransition COM object.
This method should be called from a derived class's Create method in order to prevent
IUITransition interface leak.
The destructor. Called when a transition object is being destroyed.
Constructs a base transtion object.
Defines the transition types currently supported by the MFC implementation of Windows Animation API.
A transition type is set in the constructor of specific transition.
For example, CSinusoidalTransitionFromRange sets its type to SINUSOIDAL_FROM_RANGE.
Represents a basic transition.
This class encapsulates IUIAnimationTransition interface and serves as a base class for all transitions.
This method reads information from a cell in the currently open Microsoft Excel
file.
The identifier for the cell to write information to.
The general Object to be read into from the specified cell.
True if the data was read and stored to the specified Value parameter correctly,
else false if not.
This method reads information from a cell in the currently open Microsoft Excel
file.
The identifier for the cell to write information to.
The double object to be read into from the specified cell.
True if the data was read and stored to the specified Value parameter correctly,
else false if not.
This method reads information from a cell in the currently open Microsoft Excel
file.
The identifier for the cell to write information to.
The integer object to be read into from the specified cell.
True if the data was read and stored to the specified Value parameter correctly,
else false if not.
This method reads information from a cell in the currently open Microsoft Excel
file.
The identifier for the cell to write information to.
The string object to be read into from the specified cell.
The maximum number of characters for the string object
True if the data was read and stored to the specified Value parameter correctly,
else false if not.
This method writes information to a cell in the currently open Microsoft Excel file.
The identifier for the cell to write information to.
The double value to be written into the specified cell.
This method writes information to a cell in the currently open Microsoft Excel file.
The identifier for the cell to write information to.
The integer value to be written into the specified cell.
This method writes information to a cell in the currently open Microsoft Excel file.
The identifier for the cell to write information to.
The String object to be written into the specified cell.
This method saves the currently open Microsoft Excel file.
The full name and path for the Microsoft Excel file to save.
This method closes the currently open Microsoft Excel file.
This method opens a Microsoft Excel file for editing.
The full name and path for the Microsoft Excel file to open.
True if the file was opened correctly, else false if not.
Initializes a new instance of the ExcelFileManager class.
Private Constructor.
Made private so as not to allow anyone to create an instance of it.
This class is provided as a utility for working with Microsoft Excel files.
This method adds a specified sheet object to the current file object.
The new nesting sheet object to add to the file.
This method adds a specified part object to the current file object.
The new nesting part object to add to the file.
Gets or sets the array of nesting part objects associated with this file.
An Array of parts.
Gets or sets the array of nesting sheet objects associated with this file.
An Array of sheets.
This saves the current nesting file to the path and name specified by the FilePath
member variable.
True if the file was created and written successfully, else false if not.
Thrown if this nesting file object
does not have a valid filename and
path when this commit attempt is made.
This takes a new file name and path and saves the current nesting file to a file at
that location and with that name.
The file name and path of the new file to output these
nesting settings to.
True if the file was created and written successfully, else false if not.
Initializes a new instance of the NestingFile class.
This initializes a default nesting file with no parts or sheets,
a null FilePath string, and a default set of nesting parameters.
Parameterized Constructor. Takes a path and file name of a nesting file and
attempts to construct a NestingFile object based on that file's settings.
The construction process will add any parts or sheets read in from the specified as
NestingPart and NestingSheet objects to their respective arrays.
The nesting file's full path and name with which to
construct this NestingFile object.
Thrown if an data value is found in the nesting
file that doesn't correspond to the appropriate
type in it's internal nesting data entry.
Gets or sets the path and name of the nesting file object.
So long as this is a null string or represents an invalid path, trying to
commit changes to the nesting file will result in exceptions.
Gets or sets this file's list of nesting parameters.
This method loads defaults for this object.
This method takes a file stream and reads in all of it's data, loading it into it's
sections data.
The stream to read nesting section data from.
True if the nesting file was read successfully, false if not.
The array holding all of the excess strings found out of either of those sections.
The array holding all of the part section objects.
The array holding all of the sheet section objects.
This class is used for working with Mastercam Nesting files.
Initializes a new instance of the NestingPart class.
This initializes all of the nesting item objects to their default values.
Commits.
The initialized stream to output to.
This class is used to work with part sections in a Mastercam nesting file.
Gets all groups in the active Operation Manager list.
[out] The list of groups.
true to only select Machine Groups.
The number of groups in the list (-1 = error).
Checks to see if the supplied name is valid for a Group.
All Machine and Toolpath groups must have a unique name.
The proposed name of the group.
true to display an on-screen warning to the user.
true = name is OK to be used, false = an invalid name (empty or is already used).
Gets the name of active group.
The active group contains the 'red arrow' insertion point marker.
empty string if it fails, else the name.
Searches for a Group "by ID".
The group ID number to search for.
The found group, else null if it fails to find a match.
Searches for a Group "by name".
The name of the to search for.
The found group, else null if it fails to find a match.
Make the given Group object the currently active group in Mastercam.
The Group object to make active in Mastercam.
True if the group was set as active successfully.
Retrieves the "name" of the Machine Definition referenced in a Machine Group.
The Machine Group to be queried.
If the Group is valid and is a Machine Group,
the "name" of the Machine Definition referenced in the Machine Group,
else an empty string.
Retrieves the "name" of the Machine Definition referenced in the 'active' Machine Group.
The "name" of the Machine Definition referenced in the Machine Group,
else an empty string.
Returns a group object representing the active, root machine group.
A group object for the active machine group, else null if one does not exists
Returns a group object representing the active group.
This could a a Machine or a Toolpath Group.
A group object for the active group, else null if one does not exists
Deletes a Mastercam group.
A reference to the group object being deleted.
It should get set to a null value if the deletion was successful.
true if it succeeds, false if it fails.
Sets the Machine to be used in a Machine Group.
The Machine Group to be altered.
The (full path) name of the machine definition to use.
true if it succeeds, false if it fails.
Sets the Machine to be used in the 'active' Machine Group.
The (full path) name of the machine definition to use.
true if it succeeds, false if it fails.
This method creates and returns a newly created Group object within the currently
active group in Mastercam.
This will create a Mill Machine Group using the default machine.
Just as if you selected - Machine Type -> Mill -> Default in Mastercam.
If NewGroupName is null or an empty string, Mastercam will auto generate a name for the group.
If you specify a name that is already used, the creation will fail.
The name of the new group being created.
The product type of the group to be created.
The (full path) name of the machine definition to use.
If NewGroupName is null or an empty string, Mastercam will auto generate a name for the group.
If you specify a name that is already used, the creation will fail.
If the specified Machine Definition file does not exist,
the return will be a failure (a null return).
The newly created group object, else null if failed.
This method creates and returns a newly created Group object within the currently
specified parent group.
If NewGroupName is null or an empty string, Mastercam will auto generate a name for the group.
If you specify a name that is already used, the creation will fail.
The parent group the new group belongs to.
The name of the new group being created.
The newly created group object, else null if failed.
This method creates and returns a newly created Group object within the currently
specified parent group.
The parent group the new group belongs to.
The newly created group object, else null if it failed.
This method creates and returns a newly created Group object within the currently
active group in Mastercam.
This will create a Mill Machine Group using the default machine.
Just as if you selected - Machine Type -> Mill -> Default in Mastercam.
If NewGroupName is null or an empty string, Mastercam will auto generate a name for the group.
If you specify a name that is already used, the creation will fail.
The name of the new group being created.
The product type of the group to be created.
The newly created group object, else null if failed.
This method creates and returns a newly created Group object within the currently
active group in Mastercam.
This will create a 'Product' Machine Group using the default machine.
Just as if you selected - Machine Type -> 'Product' -> Default in Mastercam.
The product type of the group to be created.
The newly created group object, else null if it failed.
This method creates and returns a newly created Group object within the currently
active group in Mastercam.
This will create a Mill Machine Group using the default machine.
Just as if you selected - Machine Type -> Mill -> Default in Mastercam.
If NewGroupName is null or an empty string, Mastercam will auto generate a name for the group.
If you specify a name that is already used, the creation will fail.
The name of the new group being created.
The newly created group object, else null if it failed.
This method creates and returns a newly created Group object within the currently
active group in Mastercam.
This will create a Mill Machine Group using the default machine.
Just as if in Mastercam you selected: Machine Type -> Mill -> Default.
The newly created group object, else null if it failed.
This method finds the group list pointer that corresponds to a given group name.
The group name to search for.
The corresponding group list pointer if it was found, else NULL if not.
This method finds the group list pointer that corresponds to a given group number ID.
The group number ID to search for.
The corresponding group list pointer if it was found, else NULL if not.
Initializes a new instance of the GroupManager class.
Private Constructor.
Made private so as not to allow anyone to create an instance of it.
Marshals the Event data package from native to managed format.
[in] The native event data.
[out] The managed event data.
A pointer to the native Mastercam MCEvent.
The (managed) event data.
Cleans (resets) the data int the event.
Gets an event.
Prompt string to display while waiting for the event.
Pass an empty string ("") to not display the prompt window.
[out] The Event data passed back to the caller upon some sort of user input.
A combination of event mode flags for limiting input types - (Select, Point, etc).
A combination of geometry mask flag types for limiting selection.
A combination of selection mask flag types for limiting selection.
An MCamReturn.NoErrors result if the event was successfully returned, else false...
Finalizes an instance of the McUIEvent class.
Initializes a new instance of the McUIEvent class.
This class is used to manage the get_event process from Mastercam.
Gets the window corner points (view coordinates).
Gets the window corner points (screen coordinates).
Gets the list of entity database pointers (DB_LIST_ENT_PTR) for the selected entities.
Gets the list of Chains.
Gets the solid selection data.
Gets the solid pick mask at time of the event.
Gets the command lParam.
Gets the command wParam.
Gets the command id of menu or button or 'other' type of command.
Gets a value indicating the is a shift key down (all events).
Gets a value indicating the is a control key down (all events).
Gets a value indicating if this is a right button down.
Gets a value indicating if this is a left button down (drag events).
Gets the state the event was executed in.
Gets the key code.
Gets the point projected into cplane (view coordinates).
Gets the point projected into cplane (world coordinates).
Gets the point (in view coordinates).
Gets the point (in world coordinates).
Gets the point selection method.
Gets the point (aPoint) data.
Gets the cursor position.
Gets the selected point position.
Gets a value indicating if the selection was previously selected.
Gets the selected entity's database pointer (DB_LIST_ENT_PTR).
Gets the 't' values of the selection point.
Gets the Event type (EM_Point, EM_Vector, etc).
Finalizes an instance of the UIEventData class.
Initializes a new instance of the UIEventData class.
UIEventData class.
A managed representation of Mastercam's 'MCEvent' data package.
The Mastercam entity pointer (DB_LIST_ENT_PTR)
The distance from selection point.
The selection point on entity.
The Parasolid tag of owning body if it exists.
The Parasolid tag of selected entity.
The type of entity; SLD_FACE, SLD_EDGE, SLD_BODY.
Initializes a new instance of the psHitData class.
Gets the type of the entity data (SLD_FACE=1, SLD_EDGE=2, SLD_BODY=4, SLD_LOOP=8).
The Parasolid tag of selected entity.
The Parasolid tag of owning body (if it exists)
The selection point (coordinates) on entity
The distance from selection point on entity.
The Mastercam entity pointer (DB_LIST_ENT_PTR) of the entity.
Gets the Mastercam entity pointer (DB_LIST_ENT_PTR) of the entity.
Gets the distance from selection point on entity.
Gets the selection point (coordinates) on entity.
Gets the Parasolid tag of owning body (if it exists).
Gets the Parasolid tag of selected entity.
Gets the type of the entity data (SLD_FACE, SLD_EDGE, SLD_BODY).
psHitData class
A managed representation of Mastercam's 'psHit' structure.
Rectangular vector (view coordinates)
Relative point (world coordinates)
Is it relative?
The second entity.
Selected entities (2 for intersection)
Point in world coordinates.
Values, Center, Endpoint, ...
Initializes a new instance of the aPointData class.
The identifier.
The point.
The first entity.
The second entity.
true if relative.
The reference point.
The xyz vector.
Gets a the Rectangular vector (view coordinates).
Gets the Relative point (world coordinates).
Gets a value indicating if the Point is relative to point.
Gets the selected entity #2 (2 for intersection).
Gets the selected entity #1 (2 for intersection).
Gets the Point (in world coordinates).
Gets the identifier - Values, Center, Endpoint ....
aPointData class.
A managed representation of Mastercam's 'aPoint' structure.
The selected entity's database pointer (DB_LIST_ENT_PTR).
Initializes a new instance of the entData class.
The selected entity's database pointer.
The first 't' value.
The second 't' value.
Gets or sets the selected entity's 't' values.
Gets selected entity's database pointer (DB_LIST_ENT_PTR).
entData class.
A managed representation of Mastercam's 'eSel' structure.
Initializes a new instance of the sPoint class.
The x coordinate.
The y coordinate.
Gets or sets the y-coordinate of the point.
Gets or sets the x-coordinate of the point.
sPoint class.
A managed representation of Mastercam's 'ip' structure.
Flags for specifying event options.
An enum constant representing the 'disallow use of auto-cursor bar' option.
An enum constant representing the 'allow key release (Shift and Ctrl only)' option.
An enum constant representing the 'Allow right mouse button down/up events' option.
An enum constant representing the 'allow left mouse button down/up events' option.
An enum constant representing the 'allow dragging with left button down' option.
An enum constant representing the 'allow notify events' option.
An enum constant representing the 'allow solid edge selection' option.
An enum constant representing the 'allow solid face selection' option.
An enum constant representing the 'allow solid body selection' option.
An enum constant representing the 'allow double click events' option.
An enum constant representing the 'allow chain events' option.
An enum constant representing the 'allow command events' option.
An enum constant representing the 'allow drag (mouse move)' option.
An enum constant representing the 'allow window vector selection' option.
An enum constant representing the 'allow window polygon selection' option.
An enum constant representing the 'allow window selection' option.
An enum constant representing the 'allow multiple entities' option.
An enum constant representing the 'allow keypress' option.
An enum constant representing the 'allow sketched entry' option.
An enum constant representing the 'allow entity selection' option.
An enum constant representing the 'allow point entity' option.
An enum constant representing the none option.
Initializes a new instance of the NestingParam class.
This initializes all of the nesting item objects to their default values.
This class is used to work with all of the settings within the parameters section of a
nesting file.
Query if the .NET Scripting is enabled in Mastercam.
For this to be true...
The required scripting support files must exist in the \apps folder.
true if a .NET Scripting is enabled, false if not.
Executes the .NET script file.
The (full path) script file.
true if it succeeds, false if it fails.
Query if a file is .NET script file.
This is a simple file extension check.
Is the file extension? .csx or .vbx
The script file name.
true if it is, false if not.
Run the setup sheet bypassing the usual dialog.
Strings to use instead of dialog items (Programmer, etc)
MUST be a list of 8 items!
[in/out] The list of rpx templates to be used. Count MUST equal the number
of Machine Groups in the file!
Generate automatic images (y/n).
Generate automatic operation images (anyImages must be true).
Generate color images (anyImages or opImages must be true).
0=WCS, 1=TPLANE, 2=Isometric relative to WCS, 3=Isometric (WORLD).
Display results in viewer (y/n).
Write PDF files? (useViewer must be false).
[out] List of XML files that were written.
True if successful, false if not.
This method executes a run_FT_command to the Mastercam application.
This allows for running many Mastercam commands via a Function Table command (string)
as if the user had selected it via the UI.
Execution of the NET-Hook Add-In is paused until the called function returns.See the Mastercam.FT file for available commands.
The command to be run.
This method executes a run_FT_command to the specified application.
This allows for running commands via a Function Table command (string)
as if the user had selected it via the UI.
Execution of the NET-Hook Add-In is paused until the called function returns.
The name of the application to receive the command.
The command to be run.
This method executes a post_FT_command to the Mastercam application.
This allows for running many Mastercam commands via a Function Table command (string)
as if the user had selected it via the UI.
This is a "fire and forget", which means that the NET-Hook Add-In does
not pause execution and wait for the called function to complete.See the Mastercam.FT file for available commands.Some example commands:- OnPlanesTop
- OnPlanesFront
- OnPlanesBack
- OnPlanesBottom
- OnPlanesEqualsWcs
- And many more...
The command to be run.
This method executes a post_FT_command to the specified application.
This allows for running commands via a Function Table command (string)
as if the user had selected it via the UI.
This is a "fire and forget", which means that the NET-Hook Add-In does
not pause execution and wait for the called function to complete.
The name of the application to receive the command.
The Function Table command to be run.
This method runs an external command prompt command string.
The command string to run in the command prompt.
Whether to wait for the command prompt to return before continuing.
Gets the full path of the VB Script path as configured in Mastercam.
This method runs a VB Script.
The full path and file name of the VB Script to run.
False if the script file could not be found or executed, True otherwise.
This method runs a .NET (.csx or .vbx) Script.
*NOTE* - This "preview" functionality is only available in Mastercam X8!
The additional required .NET Scripting support DLLs are must be available.
The full path and file name of the Script to run.
False if the script file could not be found or executed, True otherwise.
Initializes a new instance of the ExternalAppsManager class.
Private Constructor.
Made private so as not to allow anyone to create an instance of it.
This class is used to manage the running and execution of external apps.
Run the setup sheet bypassing the usual dialog.
Strings to use instead of dialog items (Programmer, etc)
MUST be a list of 8 items!
The list of rpx templates to be used. Count MUST equal the number of Machine
Groups in the file!
Generate automatic images (y/n).
Generate automatic operation images (anyImages must be true).
Generate color images (anyImages or opImages must be true).
0=WCS, 1=TPLANE, 2=Isometric relative to WCS, 3=Isometric (WORLD).
Display results in viewer (y/n).
Write PDF files? (useViewer must be false).
[out] List of XML files that were written.
True to write ALL the XML data.
True if successful, false if not.
Run the setup sheet bypassing the usual dialog.
Strings to use instead of dialog items (Programmer, etc)
MUST be a list of 8 items!
The list of rpx templates to be used. Count MUST equal the number of Machine
Groups in the file!
Generate automatic images (y/n).
Generate automatic operation images (anyImages must be true).
Generate color images (anyImages or opImages must be true).
0=WCS, 1=TPLANE, 2=Isometric relative to WCS, 3=Isometric (WORLD).
Display results in viewer (y/n).
Write PDF files? (useViewer must be false).
[out] List of XML files that were written.
True if successful, false if not.
Initializes a new instance of the ReportManager class.
Private Constructor.
Made private so as not to allow anyone to create an instance of it.
This class is used to manage the running and execution of external apps.
This is a static inequality operator overload for the purposes of comparing these
math objects.
Note that the comparison is done with respect to the internal Mastercam
value,
so small differences between two objects that are less than the tolerances
will still be considered equal.
This is the first line to compare.
This is the second line to compare.
True if the two objects are considered not equal.
This is a static equality operator overload for the purposes of comparing these
math objects.
Note that the comparison is done with respect to the internal Mastercam
value,
so small differences between two objects that are less than the tolerances
will still be considered equal.
This is the first line to compare.
This is the second line to compare.
True if the two objects are considered equal.
This is an equality method for the purposes of comparing this math object to
another one.
Note that the comparison is done with respect to the internal Mastercam
value,
so small differences between two objects that are less than the tolerances
will still be considered equal.
[in,out] This is the line to compare against.
True if the two objects are considered equal.
This is a static equality method for the purposes of comparing these math objects.
Note that the comparison is done with respect to the internal Mastercam
value,
so small differences between two objects that are less than the tolerances
will still be considered equal.
This is the first line to compare.
This is the second line to compare.
True if the two objects are considered equal.
Gets or set the specified endpoint of this Line2D.
This is the bracket operator overload so that the points within this line can be
accessed via an array-like interface.
The index used within the brackets must be either 0 or 1 to access either
the first or the second endpoint.
Thrown if an index is passed in that is out of the allowed range.
Converts this object into a string representation.
A text string that represents this object.
Gets or sets the second endpoint of the specified line object.
Gets or sets the first endpoint of the specified line object.
Initializes a new instance of the Line2D class.
This construction method takes two 2D points and constructs a line object from them.
The point to become the first endpoint.
The point to become the second endpoint.
"Converts" this NET-Hook type to the corresponding Mastercam math type.
[out] The Mastercam math type.
Initializes a new instance of the Line2D class.
The Mastercam 2D line geometry data.
This class is used as a mathematical representation of a 2D Line.
@par Purpose:
export operations with all their assoc geometry to an external file
@param[in] fname destination file to open
@param[in] op_ids op numbers to export
@param[in] grpname name of group to export it under
@param[in] just_op true = export just the operation - no geometry
@param[in] no_duptool_chk true do not check for similar tools in destination library
@param[out] succf true = operation added to current db
@par Purpose:
import operations with all their assoc geometry from an external file
@param[in] fname source file to open and search
@param[in] pOrigin_pt predefined origin pt, NULL to call point_proc()
@param[in,out] op_ids op numbers to import, list will be update to new id's
@param[in] n_ops # of operations in list
@param[in] just_op true = import just the operation - no geometry
@param[in] get_groups 0 = don't import op groups, 1=import op groups, -1=ask
@param[in] calc_fs true = recalc speed and feed to current material
@param[in] assign_views true = use system views, false=use views stored with op
@param[in] duptool_chk check for similar tools
@param[in] expand_ops true = expand new operation in operation manager
@param[out] succf true = operation found and added to current db
@param[in] display true = display debug progess messages
@par Purpose:
import all operations with all their assoc geometry from an external file
@param[in] fname source file to open and search
@param[in] pOrigin_pt predefined origin pt, NULL to call point_proc()
@param[out] op_ids op ids that were to imported
@param[in] just_op true = import just the operation - no geometry
@param[in] get_groups 0=don't import op groups, 1=import op groups, -1=ask
@param[in] calc_fs true = recalc speed and feed to current material
@param[in] assign_views true = use system views, false = use views stored with op
@param[in] duptool_chk check for similar tools
@param[in] expand_ops true = expand new operation in operation manager
@param[in] display true = display debug progess messages
@param[out] succf true = operation found and added to current db
operation parameters - common tool parameters for all operation types
This is a static inequality operator overload for the purposes of comparing these
math objects.
Note that the comparison is done with respect to the internal Mastercam
value,
so small differences between two objects that are less than the tolerances
will still be considered equal.
This is the first arc to compare.
This is the second arc to compare.
True if the two objects are considered not equal.
This is a static equality operator overload for the purposes of comparing these
math objects.
Note that the comparison is done with respect to the internal Mastercam
value,
so small differences between two objects that are less than the tolerances
will still be considered equal.
This is the first arc to compare.
This is the second arc to compare.
True if the two objects are considered equal.
This is an equality method for the purposes of comparing this math object to
another one.
Note that the comparison is done with respect to the internal Mastercam
value,
so small differences between two objects that are less than the tolerances
will still be considered equal.
[in,out] This is the arc to compare against.
True if the two objects are considered equal.
This is a static equality method for the purposes of comparing these math objects.
Note that the comparison is done with respect to the internal Mastercam
value,
so small differences between two objects that are less than the tolerances
will still be considered equal.
This is the first arc to compare.
This is the second arc to compare.
True if the two objects are considered equal.
Converts this object into a string representation.
A text string that represents this object.
Gets or sets the location of the ending point of this arc,
an angle, in degrees, from the (3 O'Clock) base point.
Gets or sets the location of the starting point of this arc,
an angle, in degrees, from the (3 O'Clock) base point.
Gets or sets the radius of this arc.
Gets or sets the center point of this arc.
Initializes a new instance of the Arc2D class.
This takes all of the necessary data to construct this arc object.
The center point of the arc to be created.
The radius (distance from the center point to the outer
edge of the arc) of the arc to be created.
The angle in degrees, from the origin, from which the arc
starts.
The angle in degrees, from the origin, from which the arc
ends.
"Converts" this NET-Hook type to the corresponding Mastercam math type.
[out] The Mastercam math type.
Initializes a new instance of the Arc2D class.
The Mastercam 2D arc geometry data.
This class is used as a mathematical representation of a 2D Arc.
The Window Handle.
Sends an Escape key press to Mastercam (if it has the focus).
Sets the input focus to Mastercam.
This is something you would normally do not need to do.
A situation when you would is...
Your add-in is running a modeless dialog.
You allow the user to select some entities via some action from your dialog.
You are not hiding your dialog during this process.
Now is when you will need this to set the focus to Mastercam.
True if it succeeds to send the set focus request, false if not.
Gets the handle to the window represented by the implementer.
Initializes a new instance of the WindowWrapper class.
The handle.
Gets the Mastercam window handle.
Wrapped as an IWin32Window for use with .NET forms.
The Mastercam main window handle, else nullptr if it fails.
This class implements the IWin32Window interface.
You can use this as the parent of a modeless dialog.
So when you hide/show your modeless dialog,
when you reshow it, it pops up on top of Mastercam.
Gets or sets the location of the ending point for drawing this sphere
primitive solid as an angle, in degrees, from the base point.
Gets or sets the location of the starting point for drawing this sphere
primitive solid as an angle, in degrees, from the base point.
Gets or sets the distance of the outer edge of the sphere from this sphere
primitive solid's base point.
Initializes a new instance of the SphereSolid class.
This constructs a new spherical solid object with default parameters.
The default parameters of a sphere solid are for a full (360 degree) sphere
with the center at the WCS origin, (0.0, 0.0, 0.0), and with a radius of 0.5.
Loads the default values for a given solid geometry object.
Loads the default values for a given solid geometry object from the
solid geometry entity passed in.
The geometry entity to use as defaults for this solid geometry object.
Commits a solid geometry entity to the Mastercam database.
The solid geometry entity to be committed.
The solid parameters to initialize the object with.
True if the commit was successful; false if not.
Initializes a new instance of the SphereSolid class.
Attempts to retrieve a solid geometry entity with the given ID from the Mastercam
database and use that to initialize this solid geometry object.
If no matching solid geometry entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the solid geometry entity to look up in the Mastercam database.
This class is used for working with sphere shaped primitive solids.
Gets or sets the location of the ending point for drawing this cone primitive
solid as an angle, in degrees, from the base point.
Gets or sets the location of the starting point for drawing this cone
primitive solid as an angle, in degrees, from the base point.
Gets or sets the height of the cone, from the base point
(specifically, the base point's Y value) to the top of the cone.
Gets or sets the distance of the outer edge of the cone from the center of
the cone at the very top of the cone, set by this cone's height value.
Gets or sets the distance of the outer edge of the cone from this cone's
base point at the base of the cone.
Initializes a new instance of the ConeSolid class.
This constructs a new conical solid object with default parameters.
The default parameters of a conical solid are for a full (360 degree) cone with the
center at the WCS origin, (0.0, 0.0, 0.0), with a radius at the base of 0.5 and
at the top of 0.0, and with a height of 1.0.
Loads the default values for a given solid geometry object.
Loads the default values for a given solid geometry object from the solid geometry
entity passed in.
[in,out] The geometry entity to use as defaults for this solid geometry
object.
Commits a solid geometry entity to the Mastercam database.
[in,out] The solid geometry entity to be committed.
[in,out] The solid parameters to initialize the object with.
True if the commit was successful; false if not.
Initializes a new instance of the ConeSolid class.
Attempts to retrieve a solid geometry entity with the given ID from the Mastercam
database and use that to initialize this solid geometry object.
If no matching solid geometry entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the solid geometry entity to look up in the Mastercam database.
This class is used for working with cone shaped primitive solids.
Gets or sets the location of the ending point for drawing this torus
primitive solid as an angle, in degrees, from the base point.
Gets or sets thee location of the starting point for drawing this torus
primitive solid as an angle, in degrees, from the base point.
Gets or sets the distance of the inner edge of the torus from this torus
primitive solid's base point.
Gets or sets the distance of the outer edge of the torus from this torus
primitive solid's base point.
Initializes a new instance of the TorusSolid class.
This constructs a new torus solid object with default parameters.
The default parameters of a torus solid are for a full (360 degree) torus with
the center at the WCS origin, (0.0, 0.0, 0.0), with a major radius of 0.5 and
a minor radius of 0.25.
Loads the default values for a given solid geometry object.
Loads the default values for a given solid geometry object from the solid geometry
entity passed in.
The geometry entity to use as defaults for this solid geometry object.
Commits a solid geometry entity to the Mastercam database.
The solid geometry entity to be committed.
The solid parameters to initialize the object with.
True if the commit was successful; false if not.
Initializes a new instance of the TorusSolid class.
Attempts to retrieve a solid geometry entity with the given ID from the Mastercam
database and use that to initialize this solid geometry object.
If no matching solid geometry entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the solid geometry entity to look up in the Mastercam database.
This class is used for working with torus shaped primitive solids.
Get or sets the width of the block primitive solid along it's Z axis.
Get or sets the width of the block primitive solid along it's Y axis.
Get or sets the width of the block primitive solid along it's X axis.
Initializes a new instance of the BlockSolid class.
This constructs a new block solid object with default parameters.
The default parameters of a block solid are for a 1" x 1" x 1" cube,
with the center at the WCS origin, (0.0, 0.0, 0.0).
Loads the default values for a given solid geometry object.
Loads the default values for a given solid geometry object from the solid geometry
entity passed in.
The geometry entity to use as defaults for this solid geometry
object.
Commits a solid geometry entity to the Mastercam database.
The solid geometry entity to be committed.
The solid parameters to initialize the object with.
True if the commit was successful; false if not.
Initializes a new instance of the BlockSolid class.
Attempts to retrieve a solid geometry entity with the given ID from the Mastercam
database and use that to initialize this solid geometry object.
If no matching solid geometry entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the solid geometry entity to look up in the Mastercam database.
This class is used for working with block shaped primitive solids.
Gets or sets the block ID number being used in the current block drilling operation.
Gets or sets the block drill library name used in the current block drilling operation.
Gets or sets the value of the break through depth to be used in the current block
drilling operation.
Gets or sets the value of the finishing amount to be used in the current block drilling
operation.
Gets or sets the value of the roughing amount to be used in the current block drilling
operation.
This method commits the current Block Drill operation to the Mastercam database.
true to update any points assigned to the operation.
If you know that you've not altered the points used by this operation,
you may wish to used this >.Commit(false).
True if the database commit was successful and false if not.
This method commits the current Block Drill operation to the Mastercam database.
This commit also updates any the points used by this operation.
If you know that do not want the points touched during the commit,
you may wish to use the .Commit(false) method overload.
True if the database commit was successful and false if not.
Initializes a new instance of the BlockDrillOperation class.
This creates a new block drill toolpath operation with default settings.
Loads the default values for a given operation object from the operation passed in.
The operation structure to use as defaults for this operation object.
Commits the operation.
true to include, false to exclude touching the points during the commit.
true if it succeeds, false if it fails.
Initializes a new instance of the BlockDrillOperation class.
Attempts to retrieve an operation entity with the given ID from the Mastercam
database and use that to initialize this operation object.
If no matching operation entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the operation entity to look up in the Mastercam database.
Loads the default values for a given operation object.
This method takes a block drill library name and gets a block drill.
The path and name of the block library file to get the tool from.
[out] The tool found, if one was found.
True if a block drill was found; else false if not.
This class is used for working with block drilling toolpath operations.
Gets or sets the values of the (10) additional 'custom' parameters.
Gets or sets or set a value indicating if the (10) additional 'custom' parameters
are to be used.
Gets or sets the additional Break Through distance.
Gets or sets the Bore Shift distance.
Gets or sets the Dwell time.
Gets or sets the Chip Break retraction distance.
Gets or sets the Peck Clearance.
Gets or sets the Subsequent Peck increment.
Gets or sets the First Peck increment.
This method commits the current Drill operation to the Mastercam database.
true to update any points assigned to the operation.
If you know that you've not altered the points used by this operation,
you may wish to used this >.Commit(false).
True if the database commit was successful and false if not.
This method commits the current Drill operation to the Mastercam database.
This commit also updates any the points used by this operation.
If you know that do not want the points touched during the commit,
you may wish to use the .Commit(false) method overload.
True if the database commit was successful and false if not.
Initializes a new instance of the DrillOperation class.
This creates a new drilling toolpath operation with default settings.
Loads the default values for a given operation object from the operation structure
passed in.
[in,out] The operation structure to use as defaults for this operation
object.
Commits the operation.
true to include, false to exclude touching the points during the commit.
true if it succeeds, false if it fails.
Initializes a new instance of the DrillOperation class.
Attempts to retrieve an operation entity with the given ID from the Mastercam
database and use that to initialize this operation object.
If no matching operation entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the operation entity to look up in the Mastercam database.
Loads the default values for a given operation object.
This class is used for working with drilling toolpath operations.
Gets or sets the individual custom parameter values.
There are 10 values in the array, accessed as usual - zero-based.
Initializes a new instance of the DrillCustomParameters class.
Drill Cycle operation custom parameter values.
Loads the default values for a given surface geometry object from the geometry
entity passed in.
[in,out] The surface geometry entity to use as defaults for this
surface geometry object.
Commits a surface geometry entity to the Mastercam database.
[in,out] The surface geometry entity to be committed.
True if the commit was successful; false if not.
Initializes a new instance of the TrimmedSurface class.
Attempts to retrieve a surface geometry entity with the given ID from the Mastercam
database and use that to initialize this surface geometry object.
If no matching geometry entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the surface geometry entity to look up in the Mastercam database.
This class is used for working with trimmed surfaces within Mastercam.
Due to the complex nature of working with trimmed surfaces, the internal data of a
trimmed surface is unavailable in this version of the NET-Hook API.
Gets or sets the geometry object representing the base curve geometry for this revolved surface.
Gets or sets the line object of the axis of revolution for this revolved surface.
Gets or sets the ending angle of the revolved surface's drawing in radians.
Gets or sets the starting angle of the revolved surface's drawing in radians.
Gets or sets the origin of the axis line.
Gets or sets the axis vector.
Loads the default values for a given surface geometry object from the geometry
entity passed in.
[in,out] The surface geometry entity to use as defaults for this
surface geometry object.
Commits a surface geometry entity to the Mastercam database.
[in,out] The surface geometry entity to be committed.
True if the commit was successful; false if not.
Initializes a new instance of the RevolvedSurface class.
Attempts to retrieve a surface geometry entity with the given ID from the Mastercam
database and use that to initialize this surface geometry object.
If no matching geometry entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the surface geometry entity to look up in the Mastercam database.
This class is used for working with revolved surface geometry in Mastercam.
Gets or sets this surface's base surface geometry.
Gets or sets the offset distance from this surface's base surface.
Gets or sets the vector representing the direction of this surface's normal vector.
Loads the default values for a given surface geometry object from the geometry
entity passed in.
[in,out] The surface geometry entity to use as defaults for this
surface geometry object.
Commits a surface geometry entity to the Mastercam database.
[in,out] The surface geometry entity to be committed.
True if the commit was successful; false if not.
Initializes a new instance of the OffsetSurface class.
Attempts to retrieve a surface geometry entity with the given ID from the Mastercam
database and use that to initialize this surface geometry object.
If no matching geometry entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the surface geometry entity to look up in the Mastercam database.
This class is used for working with offset surfaces within Mastercam.
Loads the default values for a given surface geometry object from the geometry
entity passed in.
[in,out] The surface geometry entity to use as defaults for this
surface geometry object.
Commits a surface geometry entity to the Mastercam database.
[in,out] The surface geometry entity to be committed.
True if the commit was successful; false if not.
Initializes a new instance of the LoftedSurface class.
Attempts to retrieve a surface geometry entity with the given ID from the Mastercam
database and use that to initialize this surface geometry object.
If no matching geometry entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the surface geometry entity to look up in the Mastercam database.
This class is used for working with lofted surfaces within Mastercam.
Due to the complex nature of working with lofted surfaces, the internal data of a
lofted surface is unavailable in this version of the NET-Hook API.
Gets or sets the object representation of the second tangency curve.
Gets or sets the object representation of the first tangency curve.
Gets or sets the center curve for this FilletSurface object.
Loads the default values for a given surface geometry object from the geometry
entity passed in.
[in,out] The surface geometry entity to use as defaults for this
surface geometry object.
Commits a surface geometry entity to the Mastercam database.
[in,out] The surface geometry entity to be committed.
True if the commit was successful; false if not.
Initializes a new instance of the FilletSurface class.
Attempts to retrieve a surface geometry entity with the given ID from the Mastercam
database and use that to initialize this surface geometry object.
If no matching geometry entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the surface geometry entity to look up in the Mastercam database.
This class is used for working with fillet surfaces within Mastercam.
Gets or sets the object representing this draft surface's generating curve geometry.
Gets or sets the sine of the drive line's angle.
Gets or sets the vector of the drive line for this draft surface.
Loads the default values for a given surface geometry object from the geometry
entity passed in.
[in,out] The surface geometry entity to use as defaults for this
surface geometry object.
Commits a surface geometry entity to the Mastercam database.
[in,out] The surface geometry entity to be committed.
True if the commit was successful; false if not.
Initializes a new instance of the DraftSurface class.
Attempts to retrieve a surface geometry entity with the given ID from the
Mastercam database and use that to initialize this surface geometry object.
If no matching geometry entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the surface geometry entity to look up in the Mastercam database.
This class is used for working with draft surface geometry in Mastercam.
Gets or sets the special rendering properties for this Mesh.
Gets a value indicating the "use type" of this mesh in an operation; (Comp, Drive, Check).
Gets a value indicating if the Min/Max Points are valid, or not.
Gets the maximum point of 3D extents (after any transformations).
Gets the minimum point of 3D extents (after any transformations).
Gets the index in the polygonal_mesh database map (-1 = not valid).
Gets the type of the Mesh geometry.
Loads the default values for a given Mesh geometry object from the geometry
entity passed in.
[in,out] The geometry entity to use as defaults for this Mesh
geometry object.
Commits a Mesh geometry entity to the Mastercam database.
The Mesh geometry entity to be committed.
True if the commit was successful, false if not.
Initializes a new instance of the MeshGeometry class.
ID Lookup Constructor. Attempts to retrieve a geometry entity with the given ID
from the Mastercam database and use that to initialize this Mesh geometry object.
If no matching geometry entity is found in the Mastercam database,
the object is initialized to default values.
The ID of the geometry entity to look up in the Mastercam database.
Loads the default values for a given Mesh geometry object.
This class handles the interaction between the NET-Hook and Mastercam for Mesh geometry objects.
Note that this type of entity is not user construct-able.
This is for interacting with Polygonal Mesh entities that already exist in Mastercam's database.
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.
Creates curves on all mesh edges.
The mesh eptr.
True to add undo capability, false otherwise.
True to fit arcs, false otherwise.
Returned array of curve eptrs.
The edge tolerance.
True if it succeeds, false if it fails.
Marker types
Get the next gl display list item.
null if it fails, else the next item.
Get the previous gl display list item.
null if it fails, else the previous item.
Default constructor.
Make GLDisplayListManager a friend, so the list pointers can be managed (only
this class can manipulate the list now).
OpenGL Display List Structure
OpenGL Surface Properties Structure
Selection Grid Structure
OpenGL Light Property Structure
Display List Database Position
@}
Element in the displaylist (a double linked list)
Polyline header
Surface point in polyline
Curve point in polyline
Line point in polyline
@defgroup display_list_types Display List Types
@{
This method adds a polygon to the database.
Structure storing desired parameters of the polygon.
Location of the desired center of the polygon in world coordinates.
A boolean indicating whether the polygon should be stored.
An array of pointers indicating the location of the created entities.
(Optional) the entities if not stored.
Returns a short indicating the number of entities created.
Structure used to store information relating to a polygon.
The number of the polygon's sides.
The length of the polygon's radius.
A boolean indicating whether or not the size of the polygon's radius is fixed.
A boolean indicating whether the polygon will have fillets.
The rotation of the polygon.
A boolean indicates that the radius is measured to the corners if true, to the midpoints if false.
Indicates whether a trimmed surface is added to the polygon.
A boolean indicating whether or not a point will be created at the center.
A boolean indicating whether or not all of the dialog options are being viewed.
Select some faces and save the surface entity data.
If enhanced face selection is used, the return value is a status: -1 = okay, 0 = error.
Prompt.
Enhanced face selection entity mask or zero for normal solids selection.
Number of faces saved as surfaces or enhanced face selection status.
Write solid faces to temporary file.
Bodies (all faces)
Faces.
Number in temp file.
@par Purpose: Select some faces and save the surface entity data
@return Number of surfs selected
@param[in] sld_eptr pointer to solid
@param[in] toolp_id toolpath id
@param[in] chkSurfFlag allow check surface selecton
@param[in] use_vis_test use visibility test
@param[out] n_chksrf number of check surfaces selected
@param[out] n_gougesrf number of gouge surfaces selected
@param[in] perf_toler prefered tolerance
@param[out] trim_failure true: one or more surfaces failed to trim
@param[in,out] active true/false
@param[out] wholeBodySelected true=the entire solid body was selected (body pick), false=individual faces were selected (face pick)
@param[in] addSurfs true: add surfs to tmp file; false don't add surfs to tmp file
Convert solid tag's edges to Mastercam wireframe entities.
The solid tag (body, face, or edge).
The Mastercam eptrs created.
Only include open edges (surfaces and sheet bodies).
(Optional) include outer, inner, or both types of loop edges (solid body or face).
Get the Solid Temp File Data Version.
The Solid Temp File Data Version.
Solid curve all edges - types of loops for which to generate wireframe.
*
* @par Purpose: Helper function used by surf_sel_bits_MM() and surf_sel_bits_c5_MM() (B-08741/B-09168)
*
* @return true if successful
*
* @param[in] sld_eptr pointer to solid
* @param[in] toolp_id toolpath id
* @param[in] use_vis_test use visibility test
* @param[out] *wholeBody, whole solid body selected
* @param[out] *bodyTag, solid body tag
*@param[out] *nChkSrf, number of check faces
*@param[out] *nGougeSrf, number of gouge faces
* @param[out] arr tp sld face info
*
@par Purpose: Make all faces in temporary solid surface file invisible
@retirm number of faces hidden
@par Purpose: Make faces in temporary solid surface file invisible
@retirm number of faces hidden
@param[in] driveSurfs hide T- drive surfaces F- check surfaces
@par Purpose: Remove set of surfaces from solid surfs temp file
@param[in] set_no set number
@par Purpose: Get file position in solid surfs temp file
@return file position
@par Purpose: Set file position in solid surfs temp file
@param[in] file_pos file position
@par Purpose: Find the extremes of ents in solid temp file
@return true if successful
@param[in] dir direction vector
@param[out] maxz Max Z in direction
@param[out] maxPt One pt (of possibly many) at max Z
@param[out] minz optional - may be NULL) Min Z in direction
@param[out] minPt optional - may be NULL) One pt at min Z
@par Purpose: Select some faces and save the surface entity data
@return Number of surfs selected
@param[in] sld_eptr pointer to solid
@param[in] toolp_id toolpath id
@param[in] chkSurfFlag allow check surface selecton
@param[in] use_vis_test use visibility test
@param[out] n_chksrf number of check surfaces selected
@param[out] n_gougesrf number of gouge surfaces selected
@param[in] perf_toler prefered tolerance
@param[out] trim_failure true: one or more surfaces failed to trim
@param[in,out] active true/false
@param[out] wholeBodySelected true=the entire solid body was selected (body pick), false=individual faces were selected (face pick)
@par Purpose: Select some faces and save the surface entity data
@return Number of surfs selected
@param[in] sld_eptr pointer to solid
@param[in] toolp_id toolpath id
@param[in] chkSurfFlag allow check surface selecton
@param[in] use_vis_test use visibility test
@param[out] n_chksrf number of check surfaces selected
@param[in] perf_toler prefered tolerance
@param[out] trim_failure true: one or more surfaces failed to trim
@param[in,out] active true/false
@par Purpose: Return count ents in solid surfs temp file
@return number of selected ents in temp file
@param[in] set_no selection set to count
@par Purpose: draw a chain temp file edge
@param[in] eptr pointer to entity to draw
@param[in] local_color color
@par Purpose: highlight the selected faces based on surface usage (drive, project,...)
@return number of surfaces highlighted
@param[in] set_on true = highlight, false = unhighlight
@param[in] srfType DRIVE_FLAG, PROJECT_FLAG, ..., CHECK_SURF_FLAG, or 0 for drive surfaces
@par Purpose: highlight the selected faces
@param[in] set_on true = highlight, false = unhighlight
@par Purpose: Select a face and save the surface entity data
@return true if successful
@par Purpose: Read the surface entity data for the next face without checking for selectability
@return true if successful
@param[out] entity entity to fill out
@par Purpose: Save the surface entity data for all visible solid faces
@param[in] visibleOnly true = visible solids only (default), false = all solids
@return Number of faces saved as surfaces
@par Purpose: Select some faces and save the surface entity data
@return Number of faces saved as surfaces
@param[in] msg Selection prompt
@par Purpose: Select some faces and save the surface entity data. A non-MFC alternative to the original function.
@return Number of faces saved as surfaces
@param[in] pCharMsg Selection prompt
@par Purpose: Read a certain entity from the file of selected faces or chains
@return true if successful
@param[in] input_ptr entity to fetch
@param[out] entity entity to fill out
@par Purpose: Read the surface entity data for the next faces
@return true if successful
@param[out] ret_header header
@par Purpose: Read the surface entity data for the next face without checking for selectability (and pointer to solid)
@return true if successful
@param[out] entity entity to fill out
@param[out] solid_eptr pointer to solid
@param[out] face_index face index
@par Purpose: Read the surface entity data for the next 'visible' selected face (and pointer to solid)
@return true if successful
@param[out] entity entity to fill out
@param[out] solid_eptr pointer to solid
@param[out] face_index face index
@par Purpose: Read the next surface entity from the file of selected faces
@return true if successful
@param[out] entity entity to fill out
@par Purpose: Close the file containing the selected chain entities
@par Purpose: Close the file containing the selected face surface entities
Solid allow highlight temporary file.
true to allow.
Old highlight temporary file state.
@par Purpose: Check if the file containing the selected face surface entities exists
@return true if file exists
@par Purpose: Check if any solid temp file exists
@return true if file exists
@}
@par Purpose: Rewind the file containing the selected face surface entities
@defgroup gr_grp8 Graphics View Settings
@{
Handles the common code for internally creating the bounding box.
The common data needed to construct this cylindrical
bounding box.
The cylindrical data needed to construct this cylindrical
bounding box.
Information describing the camera.
The new bounding box geometry.
Handles the common code for internally creating the bounding box.
The common data needed to construct this rectangular
bounding box.
The rectangular data needed to construct this rectangular
bounding box.
Information describing the camera.
The new bounding box geometry.
Creates all edge curves on the selected Surfaces and/or Solids and/or Polygonal Meshes.
It is OK if more than Surfaces are in the selection,
this method will ignore any non-Surface/Solid/PMesh entities.
The tolerance (Maximum allowable gap between open edges).
The break angle. (Not used on PMesh type entities).
The mesh edge angle. (Only used on PMesh type entities).
true to fit arcs and lines, false for splines
true to only do the open edges.
nullptr if it fails, else the new edge curves.
Creates all edge curves on the selected Surfaces and/or Solids and/or Polygonal Meshes.
It is OK if more than Surfaces or Solids are in the selection,
this method will ignore any non-Surface/Solid/PMesh entities.
This method used the current system tolerance.
The break angle. (Not used on PMesh type entities).
The mesh edge angle. (Only used on PMesh type entities).
true to fit arcs and lines, false for splines
true to only do the open edges.
nullptr if it fails, else the new edge curves.
Creates a cylindrical boundary box around the specified entities.
Because the bounding box mechanism makes use of the Mastercam selection
mechanism, any selected geometry may be marked as unselected upon
completion of the bounding process.
The common data needed to construct this cylindrical
bounding box.
The cylindrical data needed to construct this cylindrical
bounding box.
The entities that the bounding box will surround.
An array containing the newly created boundary geometry if successful,
else a null reference if not.
Creates a cylindrical boundary box.
Because the bounding box mechanism makes use of the Mastercam selection
mechanism, any selected geometry may be marked as unselected upon
completion of the bounding process.
The common data needed to construct this cylindrical
bounding box.
The cylindrical data needed to construct this cylindrical
bounding box.
An array containing the newly created boundary geometry if successful,
else a null reference if not.
Creates a rectangular boundary box around the specified entities.
Because the bounding box mechanism makes use of the Mastercam selection
mechanism, any selected geometry may be marked as unselected upon
completion of the bounding process.
The common data needed to construct this rectangular
bounding box.
The rectangular data needed to construct this rectangular
bounding box.
The entities that the bounding box will surround.
An array containing the newly created boundary geometry if successful, else a null
reference if not.
Creates a rectangular boundary box around all geometry in the part file.
Because the bounding box mechanism makes use of the Mastercam selection
mechanism, any selected geometry may be marked as unselected upon
completion of the bounding process.
The common data needed to construct this rectangular
bounding box.
The rectangular data needed to construct this rectangular
bounding box.
An array containing the newly created boundary geometry if successful,
else a null reference if not.
Creates Parametric Spline from a chain.
This is Mastercam's Create Spline - Curves Spline functionality.
The chain.
The maximum error deviation allowed.
The original curves disposition.
The original curves disposition level.
The Parametric Spline if it succeeds, else a null reference if it fails.
Creates NURBS Spline from a chain.
This is Mastercam's Create Spline - Curves Spline functionality.
The chain.
The maximum error deviation allowed.
The original curves disposition.
The original curves disposition level.
The NURBS Spline if it succeeds, else a null reference if it fails.
Creates a 3D helix in the current construction plane.
The data needed to construct the helix.
An array of NURBS curve geometry objects representing the helix if successful,
else a null array reference if not.
Creates a 3D spiral in the current construction plane.
The data needed to construct the spiral.
An array of NURBS curve geometry objects representing the spiral if successful,
else a null array reference if not.
Creates 2D ellipse geometry in the current construction plane.
The point representing the center of the 2D ellipse.
The distance from the center of the ellipse to the edge of the
ellipse along the X axis.
The distance from the center of the ellipse to the edge of the
ellipse along the Y axis.
The degree to which the ellipse is rotated around it's center
point.
An arc geometry object representing the new ellipse if successful,
else a null reference if not.
In the case of an unsuccessful geometry creation,
check the CreationReturnCode flag to see why the creation process failed.
Creates a polygon in the current construction plane.
The data needed to construct the polygon.
An array of line geometry objects representing the polygon if successful,
else a null reference if not.
In the case of an unsuccessful geometry creation,
check the CreationReturnCode flag to see why the creation process failed.
Creates a rectangle in the current construction plane.
The lower left corner of the rectangle.
The upper right corner of the rectangle.
An array of line geometry objects representing the rectangle if successful,
else a null reference if not.
In the case of an unsuccessful geometry creation,
check the CreationReturnCode flag to see why the creation process failed.
Initializes a new instance of the GeometryCreationManager class.
Private Constructor.
Made private so as not to allow anyone to create an instance of it.
This class is used for performing geometry related tasks.
Updates the plane manager dialog.
Gets or sets the current construction depth.
Gets or set the plane (view) coordinate display mode.
MILL_COORD, LATHE_COORD_X or LATHE_COORD_D.
If the setting value is not one of the these valid choices -
The setting will default to the MILL_COORD display. - 0 = MILL_COORD for Mill coordinates: XYZ
- 1 = LATHE_COORD_X for Lathe radial coordinates: XZY
- 2 = LATHE_COORD_D for Lathe diameter coordinates: DZY
Gets or sets a value indicating the setting of the
'Set Cplane follow WCS' rule'.
true to enable, false to disable.
Gets or sets a value indicating the setting of the
'Set Gplane follow WCS' rule'.
true to enable, false to disable.
Gets or sets a value indicating the setting of the
'Set Cplane to TOP when Gplane is set to ISO rule'.
true to enable, false to disable.
Gets or sets a value indicating the setting of the 'Cplane follow Gplane rule'.
true to enable, false to disable.
Gets or sets the current WCS view.
Gets or sets the current tool plane view.
Gets or sets the current construction plane view.
Gets or sets the current graphics view.
Gets all of the named planes (views) in the database.
True to exclude, false to include the system views.
A list of all views.
Sets the (other) planes equal to current WCS.
Equivalent to selecting 'Planes = WCS' from StatusBar Planes option.
This method converts a given set of 3D world coordinates to view coordinates.
The world coordinates to convert to view coordinates.
The view the input coordinates are being transformed to.
If the supplied View does not identify a "valid" defined view,
the view used will default to the active construction plane.
The converted view coordinates.
This method converts a given set of 3D world coordinates to view coordinates.
Use this method for transforming coordinates when you have a View 'Number'.
(e.g. An Arc Geometry's )
The world coordinates to convert to view coordinates.
The view number of the view the input coordinates are being
transformed to.
If the supplied View Number does not identify a "valid" defined view,
the view used will default to the active construction plane.
The converted view coordinates.
This method converts a given set of 3D world coordinates to view coordinates.
Converts the world coordinates assuming the point is to be converted to the current
construction plane view.
The world coordinates to convert to view coordinates.
The converted view coordinates.
This method converts a given set of 3D view coordinates to world coordinates.
The view coordinates to convert to world coordinates.
The view the input coordinates are being transformed from.
If the supplied View does not identify a "valid" defined view,
the view used will default to the active construction plane.
The converted world coordinates.
This method converts a given set of 3D view coordinates to world coordinates.
Use this method for transforming coordinates when you have a View 'Number'.
(e.g. An Arc Geometry's )
The view coordinates to convert to world coordinates.
The view number of the view the input coordinates are being
transformed from.
If the supplied View Number does not identify a "valid" defined view,
the view used will default to the active construction plane.
The converted world coordinates.
This method converts a given set of 3D view coordinates to world coordinates.
Converts the view coordinates assuming they're in the current construction plane view.
The view coordinates to convert to world coordinates.
The converted world coordinates.
Query if the origin of the specified ViewType is enabled. (a non-zero origin)
Even though GPlane is a ViewType, it does not have an origin.
If given ViewType.GPLANE, this will always return false.
The type of the view to query (CPLANE, TPLANE or WCSPLANE).
True if the origin is a non-zero origin point, false if not.
This method determines whether or not the current construction view is 3D or not.
True if the current construction view is 3D and false if not.
Private Manager Constructor.
Made private so as not to allow anyone to create an instance of it.
This class handles the interaction and manipulation of Mastercam view settings.
This method deletes all duplicates in the current drawing.
true for silent (no dialog) operation.
This method combines arcs in parallel views.
Initializes a new instance of the GeometryInteractionManager class.
Private Constructor.
Made private so as not to allow anyone to create an instance of it.
This class is used for performing graphics-related tasks and activities.
Select all entities matching the supplied type 'mask'.
These selections are additive, meaning this selection will be added to any
current selections.
The selection mask.
This method sets all of the geometry in the current file as unselected.
This method sets all of the geometry in the current file as selected.
Window selection using a program defined window.
The geometry mask to use during geometry selection.
The type of box selection to be performed.
The first corner of the window.
The second corner of the window.
True if it succeeds, false if it fails.
This method asks the user to box select some geometry.
This method might best be used with the SearchManager::GetGeometry method
when combined with selection flags that will return all of the geometry that
was box selected in this step by the user.
The text to display to the user as they're selecting the geometry.
The geometry mask to use during geometry selection.
The type of box selection to be performed.
True if the box selection was successful and false if not.
This method asks the user to select multiple geometry items.
The text to display to the user as they're selecting the geometry.
The geometry mask to use during geometry selection.
An array containing all of the geometry selected geometry items.
This method asks the user to select a geometry item.
The text to display to the user as they're selecting the geometry.
The geometry mask to use during geometry selection.
A handle to the selected geometry item if successful, or a null value if not.
Ask the user to select a point or point position on an entity.
The main purpose of this method is to allow user selection for the creation of Associative Points.
As some PointMasks are not usable for the creation of an AssociativePoint (Intersect, Sketch, etc.),
the PostMask returned will be PointMask::PointGeometry for those "invalid" cases.
In these cases'allowCreatePoint = true' must be set for a Point entity to be created and assigned to the Geometry out value.
The prompt text to display.
True to allow creating a point if needed.
True to allow selection on Solids.
[out] If non-null, the associated geometry entity that was selected.
[out] Type of the point pick (See remarks!).
[out] The point in world coordinates.
[out] The 'T' values of the pick location.
true if it succeeds, false if it fails.
Ask the user to select a point or point position on an entity.
The main purpose of this method is to allow user selection for the creation of Associative Points.
As some PointMasks are not usable for the creation of an AssociativePoint (Intersect, Sketch, etc.),
the PostMask returned will be PointMask::PointGeometry for those "invalid" cases.
In these cases'allowCreatePoint = true' must be set for a Point entity to be created and assigned to the Geometry out value.
The prompt text to display.
True to allow creating a point if needed.
True to allow selection on Solids.
[out] If non-null, the associated geometry entity that was selected.
[out] Type of the point pick (See remarks!).
[out] The point in world coordinates.
true if it succeeds, false if it fails.
This method asks the user to select or create a point.
The text to display to the user as they're selecting the point.
The point mask to use during point selection creation.
Use the PointMask Null value if no point masking is to be used.
This should be a valid point object which will be set
to the returned point coordinates if successful.
True if the point was selected or created successfully, else false if not.
This method sets the chaining flag in all visibly selected geometry.
This method clears the chaining flag in all of a part's geometry.
Sets the chaining flag in all matching geometry.
The entity mask to match on.
Sets the chaining flag in all of the part's geometry.
Initializes a new instance of the SelectionManager class.
Private Constructor.
Made private so as not to allow anyone to create an instance of it.
This class handles the interaction of geometry selection.
Allows the NET-Hook to shutdown Mastercam, if...
true if EnableSilentShutdownMode is enabled and it succeeds, else false.
Retrieves the flag for the most recent mouse click.
See
The last mouse click type; RightClick or LeftClick
// Test for this in the main 'Run' method of the NET-Hook.
bool rightClick = (NetHook3App.GetLastMouseClick() == MCamMouseClickType.RightClick);
if (rightClick) // Do something special if the user right-clicked on our toolbar icon...
{
System.Diagnostics.Debug.WriteLine("My NET-Hook: RIGHT Mouse Button Clicked!");
}
Overrideable.
This method should return the version of the NET-Hook library the app was targeted to.
The Mastercam version#.
A MCamReturn return type code.